1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/**
* Copyright (C) 2014 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <boost/intrusive_ptr.hpp>
#include "mongo/platform/atomic_word.h"
#include "mongo/util/allocator.h"
#include "mongo/util/assert_util.h"
namespace mongo {
/**
* A mutable, ref-counted buffer.
*/
class SharedBuffer {
public:
SharedBuffer() = default;
void swap(SharedBuffer& other) {
_holder.swap(other._holder);
}
static SharedBuffer allocate(size_t bytes) {
return takeOwnership(mongoMalloc(sizeof(Holder) + 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);
_holder.detach();
_holder = std::move(tmp._holder);
}
char* get() const {
return _holder ? _holder->data() : NULL;
}
explicit operator bool() const {
return bool(_holder);
}
private:
class Holder {
public:
explicit Holder(AtomicUInt32::WordType initial = AtomicUInt32::WordType())
: _refCount(initial) {}
// 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);
}
}
char* data() {
return reinterpret_cast<char*>(this + 1);
}
const char* data() const {
return reinterpret_cast<const char*>(this + 1);
}
bool isShared() const {
return _refCount.load() > 1;
}
AtomicUInt32 _refCount;
};
explicit SharedBuffer(Holder* holder) : _holder(holder, /*add_ref=*/false) {
// NOTE: The 'false' above is because we have already initialized the Holder with a
// refcount of '1' in takeOwnership below. This avoids an atomic increment.
}
/**
* Given a pointer to a region of un-owned data, prefixed by sufficient space for a
* SharedBuffer::Holder object, return an SharedBuffer that owns the memory.
*
* This class will call free(holderPrefixedData), so it must have been allocated in a way
* that makes that valid.
*/
static SharedBuffer takeOwnership(void* holderPrefixedData) {
// 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));
}
boost::intrusive_ptr<Holder> _holder;
};
inline void swap(SharedBuffer& one, SharedBuffer& two) {
one.swap(two);
}
/**
* A constant view into a ref-counted buffer.
*
* Use SharedBuffer to allocate since allocating a const buffer is useless.
*/
class ConstSharedBuffer {
public:
ConstSharedBuffer() = default;
/*implicit*/ ConstSharedBuffer(SharedBuffer source) : _buffer(std::move(source)) {}
void swap(ConstSharedBuffer& other) {
_buffer.swap(other._buffer);
}
const char* get() const {
return _buffer.get();
}
explicit operator bool() const {
return bool(_buffer);
}
private:
SharedBuffer _buffer;
};
inline void swap(ConstSharedBuffer& one, ConstSharedBuffer& two) {
one.swap(two);
}
}
|
