自助餐
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共同拥有一家商店的一部分SSO嵌入字符数组SSV （小字符串视图）视图VUE对任何数据的非拥有视图如果是 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
虽然单元测试很广泛，但可能尚未涵盖所有情况。
自助餐旨在防止内存错误，包括来自用户的内存错误。
（当然，失去范围等除外。）
// (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
注意：即使进行了检查，某些别名也可能是致命的。
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 )
注意：库没有太多优化，工作台可能很业余。
在较弱的 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_视图
bft_dup（不要给自助餐起别名，使用这个）
bft_追加
bft_split
bft_splitstr
bft_join
bft_free
bft_cmp
bft_cap
bft_len
bft_数据
bft_cstr
bft_导出
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)
通过从src复制len 个字节来创建一个新的自助餐。
Buffet copy = bft_memcopy ( "Bonjour" , 3 );
// SSO 3 "Bon" Buffet bft_memview (const char *src, size_t len)
创建一个新的Buffet，查看src中的len字节。
您将获得一个进入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)
将距离Buffet src偏移处的len 个字节复制到新的Buffet 中。
Buffet src = bft_memcopy ( "Bonjour" , 7 );
Buffet cpy = bft_copy ( & src , 3 , 4 );
// SSO 4 "jour" Buffet bft_copyall (const Buffet *src)
将Buffet src中的所有字节复制到新的Buffet 中。
Buffet bft_view (Buffet *src, ptrdiff_t off, size_t len)
查看Buffet src的len字节，从off开始。
您将获得一个进入src 的窗口，无需复制或分配。
返回的内部类型取决于src类型：
view(SSO) -> SSV （重新计数）view(SSV) -> SSV src目标上的 SSVview(OWN) -> OWN （作为引用计数的商店共同所有者）view(VUE) -> VUE src目标上的 VUE如果返回的是 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 src = bft_memcopy ( "Hello" , 5 );
Buffet cpy = src ; // BAD
Buffet cpy = bft_dup ( & src ); // GOOD
bft_dbg ( & cpy );
// SSO 5 "Hello"Rem：别名大部分都可以工作，但会扰乱引用计数（如果启用存储保护，则不会崩溃）：
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)
将src的buf和len字节连接到结果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"注意：如果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拆分为长度为*outcnt的自助餐 Vue 列表。
由于由视图组成，您可以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)
获取最大长度buf.len的以 null 结尾的 C 字符串形式的当前数据。
如果需要（当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" 
