ビュッフェ
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タグはビュッフェのモードを設定します。
OWNSSO埋め込み文字配列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 ns MEMVIEW_buffet/8 6.36 ns MEMCOPY_c/8 16.7 ns MEMCOPY_buffet/8 11.9 ns MEMCOPY_c/32 15.3 ns MEMCOPY_buffet/32 26.3 ns MEMCOPY_c/128 16.8 ns MEMCOPY_buffet/128 29.8 ns MEMCOPY_c/512 24.9 ns MEMCOPY_buffet/512 39.3 ns MEMCOPY_c/2048 94.1 ns MEMCOPY_buffet/2048 109 ns MEMCOPY_c/8192 196 ns MEMCOPY_buffet/8192 282 ns APPEND_cpp/8/4 10.9 ns APPEND_buffet/8/4 16.3 ns APPEND_cpp/8/16 36.5 ns APPEND_buffet/8/16 30.2 ns APPEND_cpp/24/4 49.0 ns APPEND_buffet/24/4 30.1 ns APPEND_cpp/24/32 48.1 ns APPEND_buffet/24/32 28.8 ns SPLITJOIN_c 2782 ns SPLITJOIN_cpp 3317 ns SPLITJOIN_buffet 1397 ns
bft_new
bft_memcopy
bft_memview
bft_コピー
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)
srcからlenバイトをコピーして、新しいビュッフェを作成します。
Buffet copy = bft_memcopy ( "Bonjour" , 3 );
// SSO 3 "Bon" Buffet bft_memview (const char *src, size_t len)
srcからlenバイトを表示する新しいビュッフェを作成します。
コピーや割り当てを行わずにsrcにウィンドウを取得します。
注意: ビュッフェのデータを直接表示しないでください。 view() を使用する
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バイトを、ビュッフェsrcから新しいビュッフェにコピーします。
Buffet src = bft_memcopy ( "Bonjour" , 7 );
Buffet cpy = bft_copy ( & src , 3 , 4 );
// SSO 4 "jour" Buffet bft_copyall (const Buffet *src)
ビュッフェsrcからすべてのバイトを新しいビュッフェにコピーします。
Buffet bft_view (Buffet *src, ptrdiff_t off, size_t len)
Offから始まる、ビュッフェsrcのlenバイトを表示します。
コピーや割り当てを行わずに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 のエイリアスの代わりに使用します。
Buffet src = bft_memcopy ( "Hello" , 5 );
Buffet cpy = src ; // BAD
Buffet cpy = bft_dup ( & src ); // GOOD
bft_dbg ( & cpy );
// SSO 5 "Hello"Rem: エイリアシングはほとんど機能しますが、refcounting が台無しになります (ストア保護が有効になっている場合はクラッシュしません)。
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使用して 2 つのビュッフェのデータを比較します。
size_t bft_cap (Buffet *buf)
現在の容量を取得します。
size_t bft_len (Buffet *buf)`
現在の長さを取得します。
const char* bft_data (const Buffet *buf)`
現在のデータ ポインタを取得します。
buf.lenで null 終了を保証するには、 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" 
