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
|
/**
* Copyright (C) 2017 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/optional.hpp>
#include <memory>
#include "mongo/base/disallow_copying.h"
#include "mongo/client/dbclientcursor.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/repl/optime.h"
#include "mongo/db/transaction_history_iterator.h"
#include "mongo/stdx/mutex.h"
#include "mongo/util/concurrency/with_lock.h"
namespace mongo {
class OperationContext;
class ScopedSession;
class ServiceContext;
/**
* Provides facilities for extracting oplog entries of writes in a particular namespace that needs
* to be migrated.
*/
class SessionCatalogMigrationSource {
MONGO_DISALLOW_COPYING(SessionCatalogMigrationSource);
public:
explicit SessionCatalogMigrationSource(NamespaceString ns);
/**
* Returns true if there are more oplog entries to fetch at this moment. Note that new writes
* can still continue to come in after this has returned false, so it can become true again.
* Once this has returned false, this means that it has depleted the existing buffer so it
* is a good time to enter the critical section.
*/
bool hasMoreOplog();
/**
* Attempts to fetch the next oplog entry. Returns true if it was able to fetch anything.
*/
bool fetchNextOplog(OperationContext* opCtx);
/**
* Returns the oplog document that was last fetched by the fetchNextOplog call.
* Returns an empty object if there are no oplog to fetch.
*/
boost::optional<repl::OplogEntry> getLastFetchedOplog();
/**
* Remembers the oplog timestamp of a new write that just occurred.
*/
void notifyNewWriteOpTime(repl::OpTime opTimestamp);
private:
///////////////////////////////////////////////////////////////////////////
// Methods for extracting the oplog entries from session information.
void _initIfNotYet(WithLock, OperationContext* opCtx);
/**
* If this returns false, it just means that there are no more oplog entry in the buffer that
* needs to be moved over. However, there can still be new incoming operations that can add
* new entries. Also see hasNewWrites.
*/
bool _hasMoreOplogFromSessionCatalog();
/**
* Attempts to extract the next oplog document by following the oplog chain from the sessions
* catalog. Returns true if a document was actually fetched.
*/
bool _fetchNextOplogFromSessionCatalog(OperationContext* opCtx);
/**
* Returns the document that was last fetched by fetchNextOplogFromSessionCatalog.
*/
repl::OplogEntry _getLastFetchedOplogFromSessionCatalog();
/**
* Extracts oplog information from the current writeHistoryIterator to _lastFetchedOplog. This
* handles insert/update/delete/findAndModify oplog entries.
*
* Returns true if current writeHistoryIterator has any oplog entry.
*/
bool _handleWriteHistory(WithLock, OperationContext* opCtx);
///////////////////////////////////////////////////////////////////////////
// Methods for capturing and extracting oplog entries for new writes.
/**
* Returns true if there are oplog generated by new writes that needs to be fetched.
*/
bool _hasNewWrites();
/**
* Attempts to fetch the next oplog entry from the new writes that was saved by saveNewWriteTS.
* Returns true if there were documents that were retrieved.
*/
bool _fetchNextNewWriteOplog(OperationContext* opCtx);
/**
* Returns the oplog that was last fetched by fetchNextNewWriteOplog.
*/
repl::OplogEntry _getLastFetchedNewWriteOplog();
const NamespaceString _ns;
// Protects _alreadyInitialized, _sessionCatalogCursor, _writeHistoryIterator
// _lastFetchedOplogBuffer, _lastFetchedOplog
stdx::mutex _sessionCloneMutex;
bool _alreadyInitialized = false;
std::set<repl::OpTime> _sessionLastWriteOpTimes;
// Iterator for oplog entries for a specific transaction.
std::unique_ptr<TransactionHistoryIterator> _writeHistoryIterator;
// Used for temporarily storing oplog entries for operations that has more than one entry.
// For example, findAndModify generates one for the actual operation and another for the
// pre/post image.
std::vector<repl::OplogEntry> _lastFetchedOplogBuffer;
// Used to store the last fetched oplog. This enables calling get multiple times.
boost::optional<repl::OplogEntry> _lastFetchedOplog;
// Protects _newWriteTsList, _lastFetchedNewWriteOplog
stdx::mutex _newOplogMutex;
// Stores oplog opTime of new writes that are coming in.
std::list<repl::OpTime> _newWriteOpTimeList;
// Used to store the last fetched oplog from _newWriteTsList.
boost::optional<repl::OplogEntry> _lastFetchedNewWriteOplog;
};
} // namespace mongo
|