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
|
/**
* 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 <stdlib.h>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/db/storage/recovery_unit.h"
#include "mongo/db/concurrency/locker.h"
#include "mongo/db/concurrency/lock_mgr.h"
namespace mongo {
class Client;
class CurOp;
class ProgressMeter;
/**
* This class encompasses the state required by an operation.
*
* TODO(HK): clarify what this means. There's one OperationContext for one user operation...
* but is this true for getmore? Also what about things like fsyncunlock / internal
* users / etc.?
*/
class OperationContext {
MONGO_DISALLOW_COPYING(OperationContext);
public:
virtual ~OperationContext() { }
/**
* Interface for durability. Caller DOES NOT own pointer.
*/
virtual RecoveryUnit* recoveryUnit() const = 0;
/**
* Interface for locking. Caller DOES NOT own pointer.
*/
virtual Locker* lockState() const = 0;
// --- operation level info? ---
/**
* TODO: Get rid of this and just have one interrupt func?
* throws an exception if the operation is interrupted
* @param heedMutex if true and have a write lock, won't kill op since it might be unsafe
*/
virtual void checkForInterrupt(bool heedMutex = true) const = 0;
/**
* TODO: Where do I go
* @return Status::OK() if not interrupted
* otherwise returns reasons
*/
virtual Status checkForInterruptNoAssert() const = 0;
/**
* Delegates to CurOp, but is included here to break dependencies.
* Caller does not own the pointer.
*/
virtual ProgressMeter* setMessage(const char* msg,
const std::string& name = "Progress",
unsigned long long progressMeterTotal = 0,
int secondsBetween = 3) = 0;
/**
* Delegates to CurOp, but is included here to break dependencies.
*
* TODO: We return a string because of hopefully transient CurOp thread-unsafe insanity.
*/
virtual string getNS() const = 0;
/**
* Returns true if this operation is under a GodScope. Only used by DBDirectClient.
* TODO(spencer): SERVER-10228 Remove this
*/
virtual bool isGod() const = 0;
/**
* Returns the client under which this context runs.
*/
virtual Client* getClient() const = 0;
/**
* Returns CurOp. Caller does not own pointer
*/
virtual CurOp* getCurOp() const = 0;
/**
* Returns the operation ID associated with this operation.
* WARNING: Due to SERVER-14995, this OpID is not guaranteed to stay the same for the
* lifetime of this OperationContext.
*/
virtual unsigned int getOpID() const = 0;
/**
* @return true if this instance is primary for this namespace
*/
virtual bool isPrimaryFor( const StringData& ns ) = 0;
/**
* @return Transaction* for LockManager-ment. Caller does not own pointer
*/
virtual Transaction* getTransaction() = 0;
protected:
OperationContext() { }
};
class WriteUnitOfWork {
MONGO_DISALLOW_COPYING(WriteUnitOfWork);
public:
WriteUnitOfWork(OperationContext* txn)
: _txn(txn) {
_txn->recoveryUnit()->beginUnitOfWork();
}
~WriteUnitOfWork(){ _txn->recoveryUnit()->endUnitOfWork(); }
void commit() { _txn->recoveryUnit()->commitUnitOfWork(); }
OperationContext* const _txn;
};
} // namespace mongo
|
