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
|
/**
* 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 "mongo/db/client.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/service_context.h"
#include "mongo/platform/mutex.h"
namespace mongo {
/**
* OperationContextGroup maintains a collection of operation contexts so that they may all be killed
* on a common event (typically stepdown). Its public member functions serialize access to private
* data members.
*/
class OperationContextGroup {
OperationContextGroup(OperationContextGroup const&) = delete;
OperationContextGroup(OperationContextGroup&&) = delete;
void operator=(OperationContextGroup const&) = delete;
void operator=(OperationContextGroup&&) = delete;
public:
using UniqueOperationContext = ServiceContext::UniqueOperationContext;
class Context;
OperationContextGroup() = default;
~OperationContextGroup() {
invariant(isEmpty());
}
/**
* Makes an OperationContext on `client` and returns a Context object to track it. On
* destruction of the returned Context, the OperationContext is destroyed and its corresponding
* entry in *this is erased. If *this has been interrupted already, the new context will be
* interrupted immediately.
*/
Context makeOperationContext(Client& client);
/**
* Takes ownership of the OperationContext from `ctx`, and returns a Context object to track it.
* On destruction of the Context, its entry in *this is erased and its corresponding
* OperationContext is destroyed. If *this has been interrupted already, `ctx` will be
* interrupted immediately.
*/
Context adopt(UniqueOperationContext ctx);
/**
* Moves the OperationContext of `ctx` from its current OperationContextGroup into *this.
* Do this to protect an OperationContext from being interrupted along with the rest of its
* group, or to expose `ctx` to this->interrupt(). Taking from a Context already in *this is
* equivalent to moving from `ctx`. Taking a moved-from Context yields another moved-from
* Context.
*/
Context take(Context ctx);
/*
* Interrupts all the OperationContexts maintained in *this.
*/
void interrupt(ErrorCodes::Error);
/**
* Reports whether the group has any OperationContexts. This must be true before the destructor
* is called. Its usefulness is typically limited to invariants.
*/
bool isEmpty();
private:
friend class Context;
Mutex _lock = MONGO_MAKE_LATCH("OperationContextGroup::_lock");
std::vector<UniqueOperationContext> _contexts;
}; // class OperationContextGroup
/**
* Context tracks one OperationContext*, and on destruction unregisters and destroys the associated
* OperationContext. May be used as if it were an OperationContext*.
*
* The lifetime of an OperationContextGroup::Context object must not exceed that of its
* OperationContextGroup, unless it has been moved from, taken from (see
* OperationContextGroup::take), or discarded.
*/
class OperationContextGroup::Context {
Context() = delete;
Context(Context const&) = delete;
void operator=(Context const&) = delete;
void operator=(Context&&) = delete;
public:
Context(Context&& ctx) : _opCtx(ctx._opCtx), _ctxGroup(ctx._ctxGroup) {
ctx._movedFrom = true;
}
~Context() {
discard();
}
/**
* Returns a pointer to the tracked OperationContext, or nullptr if *this has been moved from.
*/
OperationContext* opCtx() const {
return _movedFrom ? nullptr : &_opCtx;
}
/**
* These enable treating a Context as if it were an OperationContext*.
*/
operator OperationContext*() const {
dassert(!_movedFrom);
return &_opCtx;
}
OperationContext* operator->() const { // because op-> will not use the conversion
dassert(!_movedFrom);
return &_opCtx;
}
/**
* Destroys and unregisters the corresponding OperationContext. After this operation, *this is
* an xvalue, and can only be destroyed.
*/
void discard();
private:
friend class OperationContextGroup;
Context(OperationContext& ctx, OperationContextGroup& group);
bool _movedFrom = false;
OperationContext& _opCtx;
OperationContextGroup& _ctxGroup;
}; // class OperationContextGroup::Context
} // namespace mongo
|
