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
|
/**
* 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 <functional>
#include "mongo/base/status.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/client.h"
#include "mongo/db/service_context.h"
#include "mongo/stdx/utility.h"
#include "mongo/transport/service_entry_point.h"
#include "mongo/transport/session.h"
#include "mongo/util/duration.h"
#include "mongo/util/functional.h"
#include "mongo/util/out_of_line_executor.h"
namespace mongo::transport {
extern bool gInitialUseDedicatedThread;
/*
* This is the interface for all ServiceExecutors.
*/
class ServiceExecutor {
public:
using Task = OutOfLineExecutor::Task;
class TaskRunner : public OutOfLineExecutor {
public:
/**
* Awaits the availability of incoming data for the specified session. On success, it will
* schedule the callback on current executor. Otherwise, it will invoke the callback with a
* non-okay status on the caller thread.
*/
virtual void runOnDataAvailable(std::shared_ptr<Session> session, Task task) = 0;
};
static void shutdownAll(ServiceContext* serviceContext, Date_t deadline);
virtual ~ServiceExecutor() = default;
virtual std::unique_ptr<TaskRunner> makeTaskRunner() = 0;
/*
* Starts the ServiceExecutor. This may create threads even if no tasks are scheduled.
*/
virtual Status start() = 0;
/*
* Stops and joins the ServiceExecutor. Any outstanding tasks will not be executed, and any
* associated callbacks waiting on I/O may get called with an error code.
*
* This should only be called during server shutdown to gracefully destroy the ServiceExecutor
*/
virtual Status shutdown(Milliseconds timeout) = 0;
virtual size_t getRunningThreads() const = 0;
/** Appends statistics about task scheduling to a BSONObjBuilder for serverStatus output. */
virtual void appendStats(BSONObjBuilder* bob) const = 0;
/** Yield if this executor controls more threads than we have cores. */
void yieldIfAppropriate() const;
};
/**
* ServiceExecutorContext determines which ServiceExecutor is used for each Client.
*/
class ServiceExecutorContext {
public:
/**
* Get a pointer to the ServiceExecutorContext for a given client.
*
* This function is valid to invoke either on the Client thread or with the Client lock.
*/
static ServiceExecutorContext* get(Client* client) noexcept;
/**
* Set the ServiceExecutorContext for a given client.
*
* This function may only be invoked once and only while under the Client lock.
*/
static void set(Client* client, std::unique_ptr<ServiceExecutorContext> seCtx) noexcept;
/**
* Reset the ServiceExecutorContext for a given client.
*
* This function may only be invoked once and only while under the Client lock.
*/
static void reset(Client* client) noexcept;
ServiceExecutorContext() = default;
/** Test only */
explicit ServiceExecutorContext(std::function<ServiceExecutor*()> getServiceExecutorForTest)
: _getServiceExecutorForTest(getServiceExecutorForTest) {}
ServiceExecutorContext(const ServiceExecutorContext&) = delete;
ServiceExecutorContext& operator=(const ServiceExecutorContext&) = delete;
ServiceExecutorContext(ServiceExecutorContext&&) = delete;
ServiceExecutorContext& operator=(ServiceExecutorContext&&) = delete;
/**
* Set the threading model for the associated Client's service execution.
*
* This function is only valid to invoke with the Client lock or before the Client is set.
*/
void setUseDedicatedThread(bool dedicated) noexcept;
/**
* Set if reserved resources are available for the associated Client's service execution.
*
* This function is only valid to invoke with the Client lock or before the Client is set.
*/
void setCanUseReserved(bool canUseReserved) noexcept;
/**
* Get the ThreadingModel for the associated Client.
*
* This function is valid to invoke either on the Client thread or with the Client lock.
*/
bool useDedicatedThread() const noexcept {
return _useDedicatedThread;
}
/**
* Get an appropriate ServiceExecutor given the current parameters.
*
* This function is only valid to invoke from the associated Client thread. This function does
* not require the Client lock since all writes must also happen from that thread.
*/
ServiceExecutor* getServiceExecutor() noexcept;
private:
Client* _client = nullptr;
ServiceEntryPoint* _sep = nullptr;
bool _useDedicatedThread = true;
bool _canUseReserved = false;
bool _hasUsedSynchronous = false;
/** For tests to override the behavior of `getServiceExecutor()`. */
std::function<ServiceExecutor*()> _getServiceExecutorForTest;
};
/**
* A small statlet for tracking which executors may be in use.
*/
class ServiceExecutorStats {
public:
/**
* Get the current value of ServiceExecutorStats for the given ServiceContext.
*
* Note that this value is intended for statistics and logging. It is unsynchronized and
* unsuitable for informing decisions in runtime.
*/
static ServiceExecutorStats get(ServiceContext* ctx) noexcept;
// The number of Clients who use the dedicated executors.
size_t usesDedicated = 0;
// The number of Clients who use the borrowed executors.
size_t usesBorrowed = 0;
// The number of Clients that are allowed to ignore maxConns and use reserved resources.
size_t limitExempt = 0;
};
} // namespace mongo::transport
|
