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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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 <queue>
#include <tuple>
#include "mongo/db/namespace_string.h"
#include "mongo/db/repl/oplog_buffer.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/queue.h"
namespace mongo {
namespace repl {
class StorageInterface;
/**
* Oplog buffer backed by an optionally temporary collection. This collection is optionally created
* in startup() and removed in shutdown(). The documents will be popped and peeked in timestamp
* order.
*/
class OplogBufferCollection : public RandomAccessOplogBuffer {
public:
/**
* Structure used to configure an instance of OplogBufferCollection.
*/
struct Options {
// If equal to 0, the cache size will be set to 1.
std::size_t peekCacheSize = 0;
bool dropCollectionAtStartup = true;
bool dropCollectionAtShutdown = true;
bool useTemporaryCollection = true;
Options() {}
};
/**
* Returns default namespace for collection used to hold data in oplog buffer.
*/
static NamespaceString getDefaultNamespace();
/**
* Returns the embedded document in the 'entry' field.
*/
static BSONObj extractEmbeddedOplogDocument(const BSONObj& orig);
/**
* Creates and returns a document suitable for storing in the collection together with the
* associated timestamp that determines the position of this document in the _id index.
*
* The '_id' field of the returned BSONObj will be:
* {
* ts: 'ts' field of the provided document,
* }
*
* The oplog entry itself will be stored in the 'entry' field of the returned BSONObj.
*/
static std::tuple<BSONObj, Timestamp> addIdToDocument(const BSONObj& orig);
explicit OplogBufferCollection(StorageInterface* storageInterface, Options options = Options());
OplogBufferCollection(StorageInterface* storageInterface,
const NamespaceString& nss,
Options options = Options());
/**
* Returns the namespace string of the collection used by this oplog buffer.
*/
NamespaceString getNamespace() const;
/**
* Returns the options used to configure this OplogBufferCollection
*/
Options getOptions() const;
void startup(OperationContext* opCtx) override;
void shutdown(OperationContext* opCtx) override;
void push(OperationContext* opCtx,
Batch::const_iterator begin,
Batch::const_iterator end) override;
void waitForSpace(OperationContext* opCtx, std::size_t size) override;
bool isEmpty() const override;
std::size_t getMaxSize() const override;
std::size_t getSize() const override;
std::size_t getCount() const override;
void clear(OperationContext* opCtx) override;
bool tryPop(OperationContext* opCtx, Value* value) override;
bool waitForData(Seconds waitDuration) override;
bool peek(OperationContext* opCtx, Value* value) override;
boost::optional<Value> lastObjectPushed(OperationContext* opCtx) const override;
// ---- Random access API ----
StatusWith<Value> findByTimestamp(OperationContext* opCtx, const Timestamp& ts) final;
// Note: once you use seekToTimestamp, calling getSize() is no longer legal.
Status seekToTimestamp(OperationContext* opCtx,
const Timestamp& ts,
SeekStrategy exact = SeekStrategy::kExact) final;
// Only currently used by the TenantMigrationRecipientService, so not part of a parent API.
Timestamp getLastPushedTimestamp() const;
/**
* Like push(), but allows the operations in the batch to be out of order with
* respect to themselves and to the buffer. Legal to be called only before reading anything,
* or immediately after a clear().
*/
void preload(OperationContext* opCtx, Batch::const_iterator begin, Batch::const_iterator end);
// ---- Testing API ----
Timestamp getLastPoppedTimestamp_forTest() const;
std::queue<BSONObj> getPeekCache_forTest() const;
private:
/*
* Creates an (optionally temporary) collection with the _nss namespace.
*/
void _createCollection(OperationContext* opCtx);
/*
* Drops the collection with the _nss namespace.
*/
void _dropCollection(OperationContext* opCtx);
enum class PeekMode { kExtractEmbeddedDocument, kReturnUnmodifiedDocumentFromCollection };
/**
* Returns the oldest oplog entry in the buffer.
* Assumes the buffer is not empty.
*/
BSONObj _peek_inlock(OperationContext* opCtx, PeekMode peekMode);
// Storage interface used to perform storage engine level functions on the collection.
StorageInterface* _storageInterface;
/**
* Pops an entry off the buffer in a lock.
*/
bool _pop_inlock(OperationContext* opCtx, Value* value);
/**
* Puts documents in collection without checking for order and without updating
* _lastPushedTimestamp.
*/
void _push(WithLock,
OperationContext* opCtx,
Batch::const_iterator begin,
Batch::const_iterator end);
/**
* Returns the last document pushed onto the collection. This does not remove the `_id` field
* of the document. If the collection is empty, this returns boost::none.
*/
boost::optional<Value> _lastDocumentPushed_inlock(OperationContext* opCtx) const;
/**
* Updates '_lastPushedTimestamp' based on the last document in the collection.
*/
void _updateLastPushedTimestampFromCollection(WithLock, OperationContext* opCtx);
/**
* Returns the document with the given timestamp, or ErrorCodes::NoSuchKey if not found.
*/
StatusWith<BSONObj> _getDocumentWithTimestamp(OperationContext* opCtx, const Timestamp& ts);
/**
* Returns the key for the document with the given timestamp.
*/
static BSONObj _keyForTimestamp(const Timestamp& ts);
// The namespace for the oplog buffer collection.
const NamespaceString _nss;
// These are the options with which the oplog buffer was configured at construction time.
const Options _options;
// Allows functions to wait until the queue has data. This condition variable is used with
// _mutex below.
stdx::condition_variable _cvNoLongerEmpty;
// Protects member data below and synchronizes it with the underlying collection.
mutable Mutex _mutex = MONGO_MAKE_LATCH("OplogBufferCollection::_mutex");
// Number of documents in buffer.
std::size_t _count = 0;
// Size of documents in buffer.
std::size_t _size = 0;
Timestamp _lastPushedTimestamp;
BSONObj _lastPoppedKey;
// Used by _peek_inlock() to hold results of the read ahead query that will be used for pop/peek
// results.
std::queue<BSONObj> _peekCache;
// Whether or not the size() method can be called. This is set to false on seek, because
// we do not know how much we skipped when seeking.
bool _sizeIsValid = true;
};
} // namespace repl
} // namespace mongo
|
