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
|
/* @file db/client.h
"Client" represents a connection to the database (the server-side) and corresponds
to an open socket (or logical connection if pooling on sockets) from a client.
todo: switch to asio...this will fit nicely with that.
*/
/**
* Copyright (C) 2008 10gen 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/db/client_basic.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/service_context.h"
#include "mongo/platform/random.h"
#include "mongo/platform/unordered_set.h"
#include "mongo/stdx/thread.h"
#include "mongo/util/concurrency/spin_lock.h"
#include "mongo/util/concurrency/threadlocal.h"
namespace mongo {
class AbstractMessagingPort;
class Collection;
class OperationContext;
namespace transport {
class Session;
} // namespace transport
typedef long long ConnectionId;
/** the database's concept of an outside "client" */
class Client : public ClientBasic {
public:
/**
* Creates a Client object and stores it in TLS for the current thread.
*
* An unowned pointer to a transport::Session may optionally be provided. If 'session'
* is non-null, then it will be used to augment the thread name, and for reporting purposes.
*
* If provided, 'session' must outlive the newly-created Client object. Client::destroy() may
* be used to help enforce that the Client does not outlive 'session.'
*/
static void initThread(const char* desc, transport::Session* session = nullptr);
static void initThread(const char* desc,
ServiceContext* serviceContext,
transport::Session* session);
/**
* Inits a thread if that thread has not already been init'd, setting the thread name to
* "desc".
*/
static void initThreadIfNotAlready(const char* desc);
/**
* Inits a thread if that thread has not already been init'd, using the existing thread name
*/
static void initThreadIfNotAlready();
/**
* Destroys the Client object stored in TLS for the current thread. The current thread must have
* a Client.
*
* If destroy() is not called explicitly, then the Client stored in TLS will be destroyed upon
* exit of the current thread.
*/
static void destroy();
std::string clientAddress(bool includePort = false) const;
const std::string& desc() const {
return _desc;
}
void reportState(BSONObjBuilder& builder);
// Ensures stability of the client's OperationContext. When the client is locked,
// the OperationContext will not disappear.
void lock() {
_lock.lock();
}
void unlock() {
_lock.unlock();
}
/**
* Makes a new operation context representing an operation on this client. At most
* one operation context may be in scope on a client at a time.
*/
ServiceContext::UniqueOperationContext makeOperationContext();
/**
* Sets the active operation context on this client to "txn", which must be non-NULL.
*
* It is an error to call this method if there is already an operation context on Client.
* It is an error to call this on an unlocked client.
*/
void setOperationContext(OperationContext* txn);
/**
* Clears the active operation context on this client.
*
* There must already be such a context set on this client.
* It is an error to call this on an unlocked client.
*/
void resetOperationContext();
/**
* Gets the operation context active on this client, or nullptr if there is no such context.
*
* It is an error to call this method on an unlocked client, or to use the value returned
* by this method while the client is not locked.
*/
OperationContext* getOperationContext() {
return _txn;
}
// TODO(spencer): SERVER-10228 SERVER-14779 Remove this/move it fully into OperationContext.
bool isInDirectClient() const {
return _inDirectClient;
}
void setInDirectClient(bool newVal) {
_inDirectClient = newVal;
}
ConnectionId getConnectionId() const {
return _connectionId;
}
bool isFromUserConnection() const {
return _connectionId > 0;
}
PseudoRandom& getPrng() {
return _prng;
}
private:
friend class ServiceContext;
Client(std::string desc, ServiceContext* serviceContext, transport::Session* session = nullptr);
// Description for the client (e.g. conn8)
const std::string _desc;
// OS id of the thread, which owns this client
const stdx::thread::id _threadId;
// > 0 for things "conn", 0 otherwise
const ConnectionId _connectionId;
// Protects the contents of the Client (such as changing the OperationContext, etc)
mutable SpinLock _lock;
// Whether this client is running as DBDirectClient
bool _inDirectClient = false;
// If != NULL, then contains the currently active OperationContext
OperationContext* _txn = nullptr;
PseudoRandom _prng;
};
/** get the Client object for this thread. */
Client& cc();
bool haveClient();
};
|
