บัฟเฟอร์แบบรวมทุกอย่างสำหรับ 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
แท็ก ตั้งค่าโหมดของ Buffet :
OWN
เจ้าของร่วมของร้านค้าSSO
SSV
(มุมมองสตริงขนาดเล็ก) บน SSOVUE
ในข้อมูลใด ๆหากเป็นเจ้าของ 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
หมายเหตุ: แม้ว่าจะมีการตรวจสอบ นามแฝงบางอย่างก็อาจถึงแก่ชีวิตได้
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 )
หมายเหตุ: lib ไม่ได้รับการปรับให้เหมาะสมมากนัก และม้านั่งสำรองอาจไม่ชำนาญ
บน Core i3 ที่อ่อนแอ:
MEMVIEW_cpp/8 0.609 นาโนวินาที MEMVIEW_buffet/8 6.36 น MEMCOPY_c/8 16.7ns MEMCOPY_buffet/8 11.9 น MEMCOPY_c/32 15.3ns MEMCOPY_buffet/32 26.3 น MEMCOPY_c/128 16.8ns MEMCOPY_buffet/128 29.8 น MEMCOPY_c/512 24.9ns MEMCOPY_buffet/512 39.3 น MEMCOPY_c/2048 94.1 ns MEMCOPY_buffet/2048 109 น MEMCOPY_c/8192 196ns MEMCOPY_buffet/8192 282ns APPEND_cpp/8/4 10.9 น APPEND_บุฟเฟ่ต์/8/4 16.3 น APPEND_cpp/8/16 36.5 นส APPEND_บุฟเฟ่ต์/8/59 30.2 น APPEND_cpp/24/4 49.0 น APPEND_buffet/24/4 30.1 น APPEND_cpp/24/32 48.1 น APPEND_บุฟเฟ่ต์/24/32 28.8น SPLITJOIN_c 2782 ns SPLITJOIN_cpp 3317 ns SPLITJOIN_บุฟเฟ่ต์ 1,397 น
bft_new
bft_memcopy
bft_memview
bft_copy
bft_copyall
bft_view
bft_dup ( อย่าใช้นามแฝง Buffets ใช้สิ่งนี้)
bft_ผนวก
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)
สร้างบุฟเฟ่ต์ใหม่โดยการคัดลอก len bytes จาก src
Buffet copy = bft_memcopy ( "Bonjour" , 3 );
// SSO 3 "Bon"
Buffet bft_memview (const char *src, size_t len)
สร้าง ไบต์ การดูบุฟเฟ่ต์ใหม่จาก src
คุณได้รับหน้าต่างเข้าสู่ src โดยไม่ต้องคัดลอกหรือจัดสรร
หมายเหตุ: คุณไม่ควร ดู ข้อมูลของ Buffet โดยตรง ใช้ มุมมอง()
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 bytes ที่ ชดเชย จาก Buffet src ไปยัง 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)
ดู len bytes ของ Buffet src เริ่มต้นที่ off
คุณได้รับหน้าต่างเข้าสู่ src โดยไม่ต้องคัดลอกหรือจัดสรร
ประเภทภายในที่ส่งคืนขึ้นอยู่กับประเภท src :
view(SSO) -> SSV
(หักล้าง)view(SSV) -> SSV
บนเป้าหมายของ srcview(OWN) -> OWN
(ในฐานะเจ้าของร่วมร้านค้าที่นับใหม่)view(VUE) -> VUE
บนเป้าหมายของ srcหากการคืนสินค้าเป็นของตัวเอง ร้านค้าเป้าหมายจะไม่ถูกปล่อยออกมาก่อนเช่นกัน
#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)
เชื่อมต่อ 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 bytes จาก 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 ลงในรายการ 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 เข้ากับ Buffet ใหม่
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)`
รับตัวชี้ข้อมูลปัจจุบัน
เพื่อให้แน่ใจว่ามีการสิ้นสุดด้วยค่า null ที่ buf.len
ให้ใช้ bft_cstr
const char* bft_cstr (const Buffet *buf, bool *mustfree)
รับข้อมูลปัจจุบันเป็นสตริง C ที่สิ้นสุดด้วย null ที่มีความยาวสูงสุด 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"