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
229
230
231
232
233
234
235
236
237
238
239
|
/**
* 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 <string>
#include "mongo/base/string_data.h"
#include "mongo/db/catalog/database.h"
#include "mongo/db/concurrency/d_concurrency.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/operation_context.h"
#include "mongo/util/timer.h"
namespace mongo {
class Collection;
/**
* RAII-style class, which acquires a lock on the specified database in the requested mode and
* obtains a reference to the database. Used as a shortcut for calls to dbHolder().get().
*
* It is guaranteed that the lock will be released when this object goes out of scope, therefore
* the database reference returned by this class should not be retained.
*/
class AutoGetDb {
MONGO_DISALLOW_COPYING(AutoGetDb);
public:
AutoGetDb(OperationContext* txn, StringData ns, LockMode mode);
Database* getDb() const {
return _db;
}
private:
const Lock::DBLock _dbLock;
Database* const _db;
};
/**
* RAII-style class, which acquires a locks on the specified database and collection in the
* requested mode and obtains references to both.
*
* It is guaranteed that locks will be released when this object goes out of scope, therefore
* the database and the collection references returned by this class should not be retained.
*/
class AutoGetCollection {
MONGO_DISALLOW_COPYING(AutoGetCollection);
public:
AutoGetCollection(OperationContext* txn, const NamespaceString& nss, LockMode mode);
Database* getDb() const {
return _autoDb.getDb();
}
Collection* getCollection() const {
return _coll;
}
private:
const AutoGetDb _autoDb;
const Lock::CollectionLock _collLock;
Collection* const _coll;
};
/**
* RAII-style class, which acquires a lock on the specified database in the requested mode and
* obtains a reference to the database, creating it was non-existing. Used as a shortcut for
* calls to dbHolder().openDb(), taking care of locking details. The requested mode must be
* MODE_IX or MODE_X. If the database needs to be created, the lock will automatically be
* reacquired as MODE_X.
*
* It is guaranteed that locks will be released when this object goes out of scope, therefore
* the database reference returned by this class should not be retained.
*/
class AutoGetOrCreateDb {
MONGO_DISALLOW_COPYING(AutoGetOrCreateDb);
public:
AutoGetOrCreateDb(OperationContext* txn, StringData ns, LockMode mode);
Database* getDb() const {
return _db;
}
bool justCreated() const {
return _justCreated;
}
Lock::DBLock& lock() {
return _dbLock;
}
private:
ScopedTransaction _transaction;
Lock::DBLock _dbLock; // not const, as we may need to relock for implicit create
Database* _db;
bool _justCreated;
};
/**
* RAII-style class, which would acquire the appropritate hierarchy of locks for obtaining
* a particular collection and would retrieve a reference to the collection. In addition, this
* utility validates the shard version for the specified namespace and sets the current operation's
* namespace for the duration while this object is alive.
*
* It is guaranteed that locks will be released when this object goes out of scope, therefore
* database and collection references returned by this class should not be retained.
*/
class AutoGetCollectionForRead {
MONGO_DISALLOW_COPYING(AutoGetCollectionForRead);
public:
AutoGetCollectionForRead(OperationContext* txn, const std::string& ns);
AutoGetCollectionForRead(OperationContext* txn, const NamespaceString& nss);
~AutoGetCollectionForRead();
Database* getDb() const {
return _autoColl.getDb();
}
Collection* getCollection() const {
return _autoColl.getCollection();
}
private:
void _init(const std::string& ns, StringData coll);
const Timer _timer;
OperationContext* const _txn;
const ScopedTransaction _transaction;
const AutoGetCollection _autoColl;
};
/**
* Opens the database that we want to use and sets the appropriate namespace on the
* current operation.
*/
class OldClientContext {
MONGO_DISALLOW_COPYING(OldClientContext);
public:
/** this is probably what you want */
OldClientContext(OperationContext* txn, const std::string& ns, bool doVersion = true);
/**
* Below still calls _finishInit, but assumes database has already been acquired
* or just created.
*/
OldClientContext(OperationContext* txn, const std::string& ns, Database* db, bool justCreated);
/**
* note: this does not call _finishInit -- i.e., does not call
* ensureShardVersionOKOrThrow for example.
* see also: reset().
*/
OldClientContext(OperationContext* txn, const std::string& ns, Database* db);
~OldClientContext();
Database* db() const {
return _db;
}
const char* ns() const {
return _ns.c_str();
}
/** @return if the db was created by this OldClientContext */
bool justCreated() const {
return _justCreated;
}
private:
friend class CurOp;
void _finishInit();
void _checkNotStale() const;
bool _justCreated;
bool _doVersion;
const std::string _ns;
Database* _db;
OperationContext* _txn;
Timer _timer;
};
class OldClientWriteContext {
MONGO_DISALLOW_COPYING(OldClientWriteContext);
public:
OldClientWriteContext(OperationContext* opCtx, const std::string& ns);
Database* db() const {
return _c.db();
}
Collection* getCollection() const {
return _c.db()->getCollection(_nss.ns());
}
private:
OperationContext* const _txn;
const NamespaceString _nss;
AutoGetOrCreateDb _autodb;
Lock::CollectionLock _collk;
OldClientContext _c;
Collection* _collection;
};
} // namespace mongo
|
