буфет
1.0.0
Комплексный буфер для C
Шведский стол — это тегированный союз с 4 режимами.
// Hard values show 64-bit
union Buffet {
struct ptr {
char * data
size_t len
size_t off : 62 , tag : 2 // tag = OWN|SSV|VUE
}
struct sso {
char data [ 22 ]
uint8_t refcnt
uint8_t len : 6 , tag : 2 // tag = SSO
}
}
sizeof ( Buffet ) == 24Тег устанавливает режим шведского стола:
OWN часть магазина в совместном владенииSSOSSV (представление небольшой строки) в SSOVUEЕсли OWN, Buffet.data указывает на выделенное хранилище кучи:
struct Store {
size_t cap // store capacity
size_t len // store length
uint32_t refcnt // number of views on store
uint32_t canary // invalidates store if modified
char data [] // buffer data, shared by owning views
}
#include "../buffet.h"
int main () {
// SHARED OWN =================
char large [] = "DATA STORE IS HEAP ALLOCATION." ;
Buffet own1 = bft_memcopy ( large , sizeof ( large ) - 1 );
// Now own1 owns a store housing a copy of `large`
bft_dbg ( & own1 );
//-> OWN 30 "DATA STORE ..."
// View "STORE" in own1 :
Buffet own2 = bft_view ( & own1 , 5 , 5 );
// Now own1 and own2 share the store, whose refcount is 2
bft_dbg ( & own2 );
//-> OWN 5 "STORE"
// SSO & SSV =================
char small [] = "SMALL STRING" ;
Buffet sso1 = bft_memcopy ( small , sizeof ( small ) - 1 );
bft_dbg ( & sso1 );
//-> SSO 12 "SMALL STRING"
// View "STRING" in sso1 :
Buffet ssv1 = bft_view ( & sso1 , 6 , 6 );
bft_dbg ( & ssv1 );
//-> SSV 6 "STRING"
// VUE =======================
char any [] = "SOME BYTES" ;
// View "BYTES" in `any` :
Buffet vue1 = bft_memview ( any + 5 , 5 );
bft_dbg ( & vue1 );
//-> VUE 5 "BYTES"
return 0 ;
} make && make check
Хотя модульные тесты обширны, они могут еще не охватить все случаи.
Целью Buffet является предотвращение сбоев памяти, в том числе со стороны пользователя.
(За исключением, конечно, потери масштаба и тому подобного.)
// (pseudo code)
// overflow
buf = new ( 8 )
append ( buf , large_str ) // Done
// invalid ref
buf = memcopy ( short_str ) // SSO
view = view ( buf )
append ( buf , large_str ) // would mutate SSO to OWN
// => abort & warn "Append would invalidate views on SSO"
// double-free
bft_free ( buf )
bft_free ( buf ) // OK
// use-after-free
bft_free ( buf )
append ( buf , "foo" ) // Done. Now buf is "foo".
// aliasing
alias = buf // should be `alias = bft_dup(buf)`
bft_free ( buf )
bft_free ( alias ) // OK. Possible warning "Bad canary. Double free ?"
// Etc... С этой целью такие операции, как view() или free(), могут проверять заголовок хранилища.
Если это не так, операция прерывается и возвращается пустой шведский стол.
Проверки включаются #define MEMCHECK или с помощью
MEMCHECK=1 make
Предупреждения включаются #define DEBUG или сборкой с помощью
DEBUG=1 make
NB: Даже при проверке некоторые псевдонимы могут оказаться фатальными.
own = memcopy ( large_str )
view = view ( own )
alias = view
bft_free ( view )
bft_free ( own ) // refcnt == 0, free(store) !
// alias now points into freed memory...См. вывод юнит-тестов и предупреждений src/check.c.
make && make bench (требуется libbenchmark-dev )
NB: Библиотека не очень оптимизирована, а скамейка может быть любительской.
На слабом Core i3:
MEMVIEW_cpp/8 0,609 нс MEMVIEW_buffet/8 6,36 нс MEMCOPY_c/8 16,7 нс MEMCOPY_buffet/8 11,9 нс MEMCOPY_c/32 15,3 нс MEMCOPY_buffet/32 26,3 нс MEMCOPY_c/128 16,8 нс MEMCOPY_buffet/128 29,8 нс MEMCOPY_c/512 24,9 нс MEMCOPY_buffet/512 39,3 нс MEMCOPY_c/2048 94,1 нс MEMCOPY_buffet/2048 109 нс MEMCOPY_c/8192 196 нс MEMCOPY_buffet/8192 282 нс APPEND_cpp/8/4 10,9 нс APPEND_buffet/8/4 16,3 нс APPEND_cpp/8/16 36,5 нс APPEND_buffet/8/16 30,2 нс APPEND_cpp/24/4 49,0 нс APPEND_buffet/24/4 30,1 нс APPEND_cpp/24/32 48,1 нс APPEND_buffet/24/32 28,8 нс SPLITJOIN_c 2782 нс SPLITJOIN_cpp 3317 нс SPLITJOIN_buffet 1397 нс
bft_new
bft_memcopy
bft_memview
bft_copy
bft_copyall
bft_view
bft_dup ( не используйте псевдоним «шведский стол» , используйте это)
bft_append
bft_split
bft_splitstr
bft_join
bft_free
bft_cmp
bft_cap
bft_len
bft_data
bft_cstr
bft_export
bft_print
bft_dbg
Buffet bft_new (size_t cap)
Создайте новый пустой буфет с минимальной вместимостью .
Buffet buf = bft_new ( 40 );
bft_dbg ( & buf );
// OWN 0 "" Buffet bft_memcopy (const char *src, size_t len)
Создайте новый Buffet, скопировав len байт из src .
Buffet copy = bft_memcopy ( "Bonjour" , 3 );
// SSO 3 "Bon" Buffet bft_memview (const char *src, size_t len)
Создайте новый Buffet для просмотра len байт из src .
Вы получаете окно в src без копирования или выделения.
Примечание. Не следует напрямую просматривать данные шведского стола. Используйте просмотр()
char src [] = "Eat Buffet!" ;
Buffet view = bft_memview ( src + 4 , 6 );
// VUE 6 "Buffet" Buffet bft_copy (const Buffet *src, ptrdiff_t off, size_t len)
Скопируйте len байтов со смещением из источника Buffet в новый Buffet.
Buffet src = bft_memcopy ( "Bonjour" , 7 );
Buffet cpy = bft_copy ( & src , 3 , 4 );
// SSO 4 "jour" Buffet bft_copyall (const Buffet *src)
Скопируйте все байты из источника Buffet в новый Buffet.
Buffet bft_view (Buffet *src, ptrdiff_t off, size_t len)
Просмотрите len байт Buffet src , начиная с off .
Вы получаете окно в src без копирования или выделения.
Внутренний тип возвращаемого значения зависит от типа src :
view(SSO) -> SSV (пересчитан)view(SSV) -> SSV на цели srcview(OWN) -> OWN (как совладелец пересчитанного магазина)view(VUE) -> VUE для цели srcЕсли возврат имеет значение OWN, целевой магазин не будет освобожден раньше.
#include "../buffet.h"
int main () {
char text [] = "Bonjour monsieur Buddy. Already speaks french!" ;
// view sso
Buffet sso = bft_memcopy ( text , 16 ); // "Bonjour monsieur"
Buffet ssv = bft_view ( & sso , 0 , 7 );
bft_dbg ( & ssv );
// view ssv
Buffet Bon = bft_view ( & ssv , 0 , 3 );
bft_dbg ( & Bon );
// view own
Buffet own = bft_memcopy ( text , sizeof ( text ));
Buffet ownview = bft_view ( & own , 0 , 7 );
bft_dbg ( & ownview );
// detach view
bft_append ( & ownview , "!" , 1 );
// bft_free(&ownview);
bft_free ( & own ); // Done
// view vue
Buffet vue = bft_memview ( text + 8 , 8 ); // "Good"
Buffet mon = bft_view ( & vue , 0 , 3 );
bft_dbg ( & mon );
return 0 ;
} $ cc view.c libbuffet.a -o view && ./view
SSV 7 data:"Bonjour"
SSV 3 data:"Bon"
OWN 7 data:"Bonjour"
VUE 3 data:"mon"
Buffet bft_dup (const Buffet *src)
Создайте неглубокую копию src .
Используйте это вместо псевдонима Buffet.
Buffet src = bft_memcopy ( "Hello" , 5 );
Buffet cpy = src ; // BAD
Buffet cpy = bft_dup ( & src ); // GOOD
bft_dbg ( & cpy );
// SSO 5 "Hello"Рем: псевдонимы в основном работают, но портят подсчет ссылок (без сбоев, если включена защита магазина):
Buffet alias = sso ; //ok if sso was not viewed
Buffet alias = own ; //not refcounted
Buffet alias = vue ; //ok void bft_free (Buffet *buf)
Сбрасывает buf .
Безопасность:
#include "../buffet.h"
int main () {
char text [] = "Le grand orchestre de Patato Valdez" ;
Buffet own = bft_memcopy ( text , sizeof ( text ));
Buffet ref = bft_view ( & own , 9 , 9 ); // "orchestre"
bft_free ( & own ); // A bit soon but ok, --refcnt
bft_dbg ( & own ); // SSO 0 ""
bft_free ( & ref ); // Was last co-owner, store is released
Buffet sso = bft_memcopy ( text , 8 ); // "Le grand"
Buffet ref2 = bft_view ( & sso , 3 , 5 ); // "grand"
bft_free ( & sso ); // WARN line:328 bft_free: SSO has views on it
bft_free ( & ref2 );
bft_free ( & sso ); // OK now
bft_dbg ( & sso ); // SSO 0 ""
return 0 ;
} $ valgrind --leak-check=full ./bin/ex/free
All heap blocks were freed -- no leaks are possible
size_t bft_cat (Buffet *dst, const Buffet *buf, const char *src, size_t len)
Объединяет buf и len байты src в результирующий dst .
Возвращает общую длину или 0 в случае ошибки.
Buffet buf = bft_memcopy ( "abc" , 3 );
Buffet dst ;
size_t totlen = bft_cat ( & dst , & buf , "def" , 3 );
bft_dbg ( & dst );
// SSO 6 "abcdef" size_t bft_append (Buffet *dst, const char *src, size_t len)
Добавляет len байт из src в dst .
Возвращает новую длину или 0 в случае ошибки.
Buffet buf = bft_memcopy ( "abc" , 3 );
size_t newlen = bft_append ( & buf , "def" , 3 );
bft_dbg ( & buf );
// SSO 6 "abcdef"NB: возвращает ошибку, если buf имеет представления и будет меняться с SSO на OWN для увеличения емкости, делая представления недействительными:
Buffet foo = bft_memcopy ( "short foo " , 10 );
Buffet view = bft_view ( & foo , 0 , 5 );
// would mutate to OWN :
size_t rc = bft_append ( & foo , "now too long for SSO" );
assert ( rc == 0 ); // meaning abortedЧтобы предотвратить это, освободите представления перед добавлением в небольшой шведский стол.
Buffet* bft_split (const char* src, size_t srclen, const char* sep, size_t seplen,
int *outcnt)
Разделяет src по разделителю sep на список Buffet Vue длиной *outcnt .
Поскольку вы состоите из представлений, вы можете free(list) без утечки при условии, что ни один элемент не был назначен владельцем, например, путем добавления к нему.
Buffet* bft_splitstr (const char *src, const char *sep, int *outcnt);
Удобное разделение с использованием strlen внутри.
int cnt ;
Buffet * parts = bft_splitstr ( "Split me" , " " , & cnt );
for ( int i = 0 ; i < cnt ; ++ i )
bft_print ( & parts [ i ]);
// VUE 5 "Split"
// VUE 2 "me"
free ( parts ); Buffet bft_join (Buffet *list, int cnt, const char* sep, size_t seplen);
Объединяет список по разделителю sep в новый шведский стол.
int cnt ;
Buffet * parts = bft_splitstr ( "Split me" , " " , & cnt );
Buffet back = bft_join ( parts , cnt , " " , 1 );
bft_dbg ( & back );
// SSO 8 'Split me' int bft_cmp (const Buffet *a, const Buffet *b)
Сравните данные двух шведских столов, используя memcmp .
size_t bft_cap (Buffet *buf)
Получить текущую мощность.
size_t bft_len (Buffet *buf)`
Получить текущую длину.
const char* bft_data (const Buffet *buf)`
Получить указатель текущих данных.
Чтобы обеспечить нулевое завершение в buf.len , используйте bft_cstr .
const char* bft_cstr (const Buffet *buf, bool *mustfree)
Получите текущие данные в виде строки C с нулевым завершением максимальной длины buf.len .
При необходимости (когда buf является представлением) данные копируются в новую строку C, которая должна быть освобождена, если установлено mustfree .
char* bft_export (const Buffet *buf)
Копирует данные до buf.len в новую строку C, которую необходимо освободить.
void bft_print (const Buffet *buf)`
Печатает данные до buf.len .
void bft_dbg (Buffet *buf)
Печатает состояние buf .
Buffet buf ;
bft_memcopy ( & buf , "foo" , 3 );
bft_dbg ( & buf );
// SSO 3 "foo" 
