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
|
/**
* 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 "mongo/base/disallow_copying.h"
#include "mongo/bson/util/atomic_int.h"
namespace mongo {
class OperationContext;
class StorageEngine;
class GlobalEnvironmentExperiment {
MONGO_DISALLOW_COPYING(GlobalEnvironmentExperiment);
public:
virtual ~GlobalEnvironmentExperiment() { }
/**
* Return the storage engine instance we're using.
*/
virtual StorageEngine* getGlobalStorageEngine() = 0;
//
// Global operation management. This may not belong here and there may be too many methods
// here.
//
/**
* Signal all OperationContext(s) that they have been killed.
*/
virtual void setKillAllOperations() = 0;
/**
* Reset the operation kill state after a killAllOperations.
* Used for testing.
*/
virtual void unsetKillAllOperations() = 0;
/**
* Get the state for killing all operations.
*/
virtual bool getKillAllOperations() = 0;
/**
* @param i opid of operation to kill
* @return if operation was found
**/
virtual bool killOperation(AtomicUInt opId) = 0;
/**
* Registers the specified operation context on the global environment, so it is
* discoverable by diagnostics tools.
*
* This function must be thread-safe.
*/
virtual void registerOperationContext(OperationContext* txn) = 0;
/**
* Unregisters a previously-registered operation context. It is an error to unregister the
* same context twice or to unregister a context, which has not previously been registered.
*
* This function must be thread-safe.
*/
virtual void unregisterOperationContext(OperationContext* txn) = 0;
/**
* Notification object to be passed to forEachOperationContext so that certain processing
* can be done on all registered contexts.
*/
class ProcessOperationContext {
public:
/**
* Invoked for each registered OperationContext. The pointer is guaranteed to be stable
* until the call returns.
*
* Implementations of this method should not acquire locks or do any operations, which
* might block and should generally do as little work as possible in order to not block
* the iteration or the release of the OperationContext.
*/
virtual void processOpContext(OperationContext* txn) = 0;
virtual ~ProcessOperationContext() { }
};
/**
* Iterates over all registered operation contexts and invokes
* ProcessOperationContext::processOpContext for each.
*/
virtual void forEachOperationContext(ProcessOperationContext* procOpCtx) = 0;
//
// Factories for storage interfaces
//
/**
* Returns a new OperationContext. Caller owns pointer.
*/
virtual OperationContext* newOpCtx() = 0;
protected:
GlobalEnvironmentExperiment() { }
};
/**
* Returns the singleton GlobalEnvironmentExperiment for this server process.
*
* Caller does not own pointer.
*/
GlobalEnvironmentExperiment* getGlobalEnvironment();
/**
* Sets the GlobalEnvironmentExperiment. If 'globalEnvironment' is NULL, un-sets and deletes
* the current GlobalEnvironmentExperiment.
*
* Takes ownership of 'globalEnvironment'.
*/
void setGlobalEnvironment(GlobalEnvironmentExperiment* globalEnvironment);
} // namespace mongo
|
