MongoDB源码:SharedBuffer

相关的类:

  • BSONObjectBuilder
  • BufBuilder
  • SharedBufferAllocator

SharedBufferAllocator 基于 SharedBuffer 提供 Allocator的功能,那么SharedBuffer是如何实现的呢?
首先,我们先看一下SharedBuffer的成员变量:

class SharedBuffer {
    // ...
private:
    boost::intrusive_ptr<Holder> _holder;
};

能够发现 SharedBuffer 使用了一个指向 Holder 的 boost::intrusive_ptr ,Holder 顾名思义用途是存储,因此我们先看一下Holder 是怎么实现。

Holder 的成员变量如下:

class Holder {
public:
    explicit Holder(unsigned initial, size_t capacity)
        : _refCount(initial), _capacity(capacity) {
            invariant(capacity == _capacity);
        }

    AtomicWord<unsigned> _refCount;
    uint32_t _capacity;
};

Holder 使用AtomicWord<unsigned> _refCount 实现引用计数,使用 uint32_t _capacity 存储空间的长度,此外,指向 Holder 的指针是 boost::intrusive_ptr,因此 Holder 需要实现 intrusive_ptr_add_ref 和 intrusive_ptr_release 两个函数如下:

// these are called automatically by boost::intrusive_ptr
friend void intrusive_ptr_add_ref(Holder* h) {
    h->_refCount.fetchAndAdd(1);
}

friend void intrusive_ptr_release(Holder* h) {
    if (h->_refCount.subtractAndFetch(1) == 0) {
        // We placement new'ed a Holder in takeOwnership above,
        // so we must destroy the object here.
        h->~Holder();
        free(h);
    }
}

但是,Holder不是存储一段空间吗,那么存储的空间在哪里呢?Holder 与存储空间相关的函数如下:

char* data() {
    return reinterpret_cast<char*>(this + 1);
}

const char* data() const {
    return reinterpret_cast<const char*>(this + 1);
}

data() 返回数据使用 this+1 的指针类型转换,为什么可以这样实现?观察到 Holder 的构造方法如下:

static SharedBuffer takeOwnership(void* holderPrefixedData, size_t capacity) {
    // Initialize the refcount to 1 so we don't need to increment it in the constructor
    // (see private Holder* constructor above).
    //
    // TODO: Should dassert alignment of holderPrefixedData here if possible.
    return SharedBuffer(new (holderPrefixedData) Holder(1U, capacity));
}

可以发现,holderPrefixedData 指向的内存空间除了为Holder实例分配的空间外,还有 capacity 大小的bytes空间。而 this 类型为 Holder,因此 this + 1 会使得指针偏移 sizeof(Holder),从而指向未使用的空间,这样Holder就达到了存储一段空间的目的。
基于Holder,SharedBuffer对外提供创建一个固定大小的Buffer,类似CopyOnWrite的CopyOnRealloc的功能的接口,具体实现如下:

static SharedBuffer allocate(size_t bytes) {
    return takeOwnership(mongoMalloc(sizeof(Holder) + bytes), bytes);
}

/**
* Resizes the buffer, copying the current contents.
*
* Like ::realloc() this can be called on a null SharedBuffer.
*
* This method is illegal to call if any other SharedBuffer instances share this buffer since
* they wouldn't be updated and would still try to delete the original buffer.
*/
void realloc(size_t size) {
    invariant(!_holder || !_holder->isShared());

    const size_t realSize = size + sizeof(Holder);
    void* newPtr = mongoRealloc(_holder.get(), realSize);

    // Get newPtr into _holder with a ref-count of 1 without touching the current pointee of
    // _holder which is now invalid.
    auto tmp = SharedBuffer::takeOwnership(newPtr, size);
    _holder.detach();
    _holder = std::move(tmp._holder);
}

/**
* Resizes the buffer, copying the current contents. If shared, an exclusive copy is made.
*/
void reallocOrCopy(size_t size) {
    if (isShared()) {
        auto tmp = SharedBuffer::allocate(size);
        memcpy(tmp._holder->data(),
               _holder->data(),
               std::min(size, static_cast<size_t>(_holder->_capacity)));
        swap(tmp);
    } else if (_holder) {
        realloc(size);
    } else {
        *this = SharedBuffer::allocate(size);
    }
}

char* get() const {
    return _holder ? _holder->data() : nullptr;
}

总的来说,SharedBuffer提供如下特性:

  • 创建一个固定大小的SharedBuffer;
  • 修改一个SharedBuffer的大小,如果该SharedBuffer的数据是共享的,则复制一份已有数据到新分配的内存空间上,并指向新分配的内存空间
  • 使用Holder和boost::intrusive_ptr确保不会发生内存泄漏
  • 复制 SharedBuffer 会使得分配的内存空间的引用计数增加
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,816评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,729评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,300评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,780评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,890评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,084评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,151评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,912评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,355评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,666评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,809评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,504评论 4 334
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,150评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,882评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,121评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,628评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,724评论 2 351

推荐阅读更多精彩内容