bufferlist是ceph的底層組件旭从，用于存儲二進制數(shù)據(jù)，其存儲的數(shù)據(jù)可以直接寫入磁盤场仲，在代碼中有很廣泛的使用和悦。
bufflist對應(yīng)的類為buffer::list(using bufferlist = buffer::list;)，而buffer::list又基于buffer::ptr和buffer::raw實現(xiàn)渠缕，探討buffer::list的實現(xiàn)鸽素，不能跳過它們。
buffer::raw
raw的數(shù)據(jù)成員部分代碼如下：
class buffer::raw
{
public:
char *data;
unsigned len;
std::atomic<unsigned> nref{0};
int mempool;
mutable ceph::spinlock crc_spinlock;
map<pair<size_t, size_t>, pair<uint32_t, uint32_t>> crc_map;
......
};
最基本的成員：data是指向具體數(shù)據(jù)的指針亦鳞，len是數(shù)據(jù)的長度馍忽，nref是引用計數(shù)。而mempool是其對應(yīng)的內(nèi)存池的index燕差，這個和data空間的分配有關(guān)遭笋，暫時不去管它。
data指向的數(shù)據(jù)有很多來源谁不，直接通過malloc從內(nèi)存分配只是最基礎(chǔ)的一種坐梯，可能還來自mmap內(nèi)存映射的空間等等。對于每一種數(shù)據(jù)來源刹帕，需要不同邏輯的數(shù)據(jù)分配和釋放函數(shù)吵血，所以raw對應(yīng)了很多子類谎替，分別表示不同的數(shù)據(jù)。
舉個例子蹋辅，對應(yīng)于malloc的raw子類為buffer::raw_malloc钱贯，構(gòu)造和析構(gòu)函數(shù)中實現(xiàn)了使用malloc進行數(shù)據(jù)分配和釋放的邏輯：
class buffer::raw_malloc : public buffer::raw
{
public:
MEMPOOL_CLASS_HELPERS();
explicit raw_malloc(unsigned l) : raw(l)
{
if (len)
{
data = (char *)malloc(len);
if (!data)
throw bad_alloc();
}
else
{
data = 0;
}
inc_total_alloc(len);
inc_history_alloc(len);
bdout << "raw_malloc " << this << " alloc " << (void *)data << " " << l << " " << buffer::get_total_alloc() << bendl;
}
raw_malloc(unsigned l, char *b) : raw(b, l)
{
inc_total_alloc(len);
bdout << "raw_malloc " << this << " alloc " << (void *)data << " " << l << " " << buffer::get_total_alloc() << bendl;
}
~raw_malloc() override
{
free(data);
dec_total_alloc(len);
bdout << "raw_malloc " << this << " free " << (void *)data << " " << buffer::get_total_alloc() << bendl;
}
raw *clone_empty() override
{
return new raw_malloc(len);
}
};
buffer::ptr
ptr是基于raw的，成員部分如下：
class CEPH_BUFFER_API ptr
{
raw *_raw;
unsigned _off, _len;
......
};
ptr和raw的關(guān)系和golang中splice和array的關(guān)系有點像侦另。raw是真正存儲數(shù)據(jù)的地方秩命，而ptr只是指向某個raw中的一段的指針。其數(shù)據(jù)成員 _raw為指向raw的指針褒傅，_off表示數(shù)據(jù)起始偏移弃锐，_len表示數(shù)據(jù)長度。
這邊還有提一下ptr的append函數(shù)殿托，直觀上ptr不應(yīng)該提供append函數(shù)霹菊，事實上ptr的append確實很局限，只有當(dāng)ptr對應(yīng)的raw區(qū)域后方有空閑空間的時候支竹，才能append成功旋廷，至于空間不夠的情況，應(yīng)該是交給list等高層類來處理礼搁。代碼如下：
unsigned buffer::ptr::append(const char *p, unsigned l)
{
assert(_raw);
assert(l <= unused_tail_length());
char *c = _raw->data + _off + _len;
maybe_inline_memcpy(c, p, l, 32);
_len += l;
return _len + _off;
}
buffer::list
簡單來說饶碘，list就是一個ptr組成的鏈表：
class CEPH_BUFFER_API list
{
// my private bits
std::list<ptr> _buffers;
unsigned _len;
unsigned _memcopy_count; //the total of memcopy using rebuild().
ptr append_buffer; // where i put small appends.
......
};
_buffers是一個ptr的鏈表，_len是整個_buffers中所有的ptr的數(shù)據(jù)的總長度馒吴，_memcopy_count用于統(tǒng)計memcopy的字節(jié)數(shù)扎运，append_buffer是用于優(yōu)化append操作的緩沖區(qū)，可以看出bufferlist將數(shù)據(jù)以不連續(xù)鏈表的方式存儲饮戳。
在說具體函數(shù)之前绪囱，先說一下bufferlist的迭代器：
template <bool is_const>
class CEPH_BUFFER_API iterator_impl
: public std::iterator<std::forward_iterator_tag, char>
{
protected:
bl_t *bl;
list_t *ls; // meh.. just here to avoid an extra pointer dereference..
unsigned off; // in bl
list_iter_t p;
unsigned p_off; // in *p
......
};
其數(shù)據(jù)成員的含義如下：
- bl：指針，指向bufferlist
- ls：指針莹捡，指向bufferlist的成員 _buffers
- p: 類型是std::list::iterator，用來迭代遍歷bufferlist中的bufferptr
- p_off：當(dāng)前位置在對應(yīng)的bufferptr中的偏移量
- off：當(dāng)前位置在整個bufferlist中的偏移量
迭代器中提供的seek(unsigned o)和advance(int o)等函數(shù)中的o都是指bufferlist的偏移扣甲，而不是單個ptr內(nèi)的偏移篮赢。
下面對bufferlist中我遇到的一些函數(shù)進行分析，其他函數(shù)遇到再說琉挖。
clear()
清空bufferlist中的內(nèi)容
push_front(raw* / ptr &)
push_back(raw* / ptr &)
在_buffers的前面或后面增加新的ptr
rebuild()
rebuild(ptr &nb)
將bufferlist中buffers鏈表中所有的ptr中的數(shù)據(jù)存到一個ptr中启泣，并將_buffers原有數(shù)據(jù)clear，然后將新的單個ptr push到_buffers中示辈。
帶參數(shù)時使用參數(shù)傳入的ptr作為目標ptr寥茫，不帶參數(shù)時自己創(chuàng)建一個ptr。
claim(list &bl, unsigned int flags = CLAIM_DEFAULT);
將bl的數(shù)據(jù)拿過來矾麻，替換原有的數(shù)據(jù)纱耻。調(diào)用后bl數(shù)據(jù)被清空芭梯。
claim_append(list &bl, unsigned int flags = CLAIM_DEFAULT);
claim_prepend(list &bl, unsigned int flags = CLAIM_DEFAULT);
將bl的數(shù)據(jù)拿過來，splice到_buffers的尾部/頭部弄喘。
append(...)
將數(shù)據(jù)追加到_buffers尾部玖喘，已有ptr空間不夠時，會自動分配新的ptr蘑志。
splice(unsigned off, unsigned len, list *claim_by = 0)
將_buffers中總偏移off處長度為len的數(shù)據(jù)累奈，move到claim_by對應(yīng)的bufferlist的尾部。注意是move不是copy急但。
write(int off, int len, std::ostream &out)
將_buffers中總偏移量off處長度為len的數(shù)據(jù)澎媒，寫入到ostream。注意是copy波桩，不是move戒努。
