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
197
|
/**
* 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 <iosfwd>
#include <string>
#include "mongo/base/error_codes.h"
#include "mongo/db/auth/validated_tenancy_scope.h"
#include "mongo/db/jsobj.h"
#include "mongo/rpc/metadata.h"
#include "mongo/transport/transport_layer.h"
#include "mongo/util/concepts.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/time_support.h"
namespace mongo {
namespace executor {
struct RemoteCommandRequestBase {
struct Options {
void resetHedgeOptions();
size_t hedgeCount = 0;
int maxTimeMSForHedgedReads = 0;
bool isHedgeEnabled = false;
bool fireAndForget = false;
};
// Indicates that there is no timeout for the request to complete
static constexpr Milliseconds kNoTimeout{-1};
// Type to represent the internal id of this request
typedef uint64_t RequestId;
RemoteCommandRequestBase();
RemoteCommandRequestBase(RequestId requestId,
const std::string& theDbName,
const BSONObj& theCmdObj,
const BSONObj& metadataObj,
OperationContext* opCtx,
Milliseconds timeoutMillis,
Options options);
// Internal id of this request. Not interpreted and used for tracing purposes only.
RequestId id;
std::string dbname;
BSONObj metadata{rpc::makeEmptyMetadata()};
BSONObj cmdObj;
boost::optional<auth::ValidatedTenancyScope> validatedTenancyScope;
// OperationContext is added to each request to allow OP_Command metadata attachment access to
// the Client object. The OperationContext is only accessed on the thread that calls
// NetworkInterface::startCommand. It is not safe to access from a thread that does not own the
// OperationContext in the general case. OperationContext should be non-null on
// NetworkInterfaces that do user work (i.e. reads, and writes) so that audit and client
// metadata is propagated. It is allowed to be null if used on NetworkInterfaces without
// metadata attachment (i.e., replication).
OperationContext* opCtx{nullptr};
Options options;
boost::optional<UUID> operationKey;
// When false, the network interface will refrain from enforcing the 'timeout' for this request,
// but will still pass the timeout on as maxTimeMSOpOnly.
bool enforceLocalTimeout = true;
Milliseconds timeout = kNoTimeout;
ErrorCodes::Error timeoutCode = ErrorCodes::NetworkInterfaceExceededTimeLimit;
// Time when the request was scheduled.
boost::optional<Date_t> dateScheduled;
transport::ConnectSSLMode sslMode = transport::kGlobalSSLMode;
protected:
~RemoteCommandRequestBase() = default;
private:
/**
* Sets 'timeout' to the min of the current 'timeout' value and the remaining time on the OpCtx.
* If the remaining time is less than the provided 'timeout', remembers the timeout error code
* from the opCtx to use later if the timeout is indeed triggered. This is important so that
* timeouts that are a direct result of a user-provided maxTimeMS return MaxTimeMSExpired rather
* than NetworkInterfaceExceededTimeLimit.
*/
void _updateTimeoutFromOpCtxDeadline(const OperationContext* opCtx);
};
/**
* Type of object describing a command to execute against a remote MongoDB node.
*/
template <typename Target>
struct RemoteCommandRequestImpl : RemoteCommandRequestBase {
RemoteCommandRequestImpl();
// Allow implicit conversion from RemoteCommandRequest to RemoteCommandRequestOnAny
REQUIRES_FOR_NON_TEMPLATE(std::is_same_v<Target, std::vector<HostAndPort>>)
RemoteCommandRequestImpl(const RemoteCommandRequestImpl<HostAndPort>& other)
: RemoteCommandRequestBase(other), target({other.target}) {}
// Allow conversion from RemoteCommandRequestOnAny to RemoteCommandRequest with the index of a
// particular host
REQUIRES_FOR_NON_TEMPLATE(std::is_same_v<Target, HostAndPort>)
RemoteCommandRequestImpl(const RemoteCommandRequestImpl<std::vector<HostAndPort>>& other,
size_t idx)
: RemoteCommandRequestBase(other), target(other.target[idx]) {}
RemoteCommandRequestImpl(RequestId requestId,
const Target& theTarget,
const std::string& theDbName,
const BSONObj& theCmdObj,
const BSONObj& metadataObj,
OperationContext* opCtx,
Milliseconds timeoutMillis = kNoTimeout,
Options options = {});
RemoteCommandRequestImpl(const Target& theTarget,
const std::string& theDbName,
const BSONObj& theCmdObj,
const BSONObj& metadataObj,
OperationContext* opCtx,
Milliseconds timeoutMillis = kNoTimeout,
Options options = {});
RemoteCommandRequestImpl(const Target& theTarget,
const std::string& theDbName,
const BSONObj& theCmdObj,
const BSONObj& metadataObj,
OperationContext* opCtx,
Options options)
: RemoteCommandRequestImpl(
theTarget, theDbName, theCmdObj, metadataObj, opCtx, kNoTimeout, options) {}
RemoteCommandRequestImpl(const Target& theTarget,
const std::string& theDbName,
const BSONObj& theCmdObj,
OperationContext* opCtx,
Milliseconds timeoutMillis = kNoTimeout,
Options options = {})
: RemoteCommandRequestImpl(theTarget,
theDbName,
theCmdObj,
rpc::makeEmptyMetadata(),
opCtx,
timeoutMillis,
options) {}
std::string toString() const;
bool operator==(const RemoteCommandRequestImpl& rhs) const;
bool operator!=(const RemoteCommandRequestImpl& rhs) const;
friend std::ostream& operator<<(std::ostream& os, const RemoteCommandRequestImpl& response) {
return (os << response.toString());
}
Target target;
};
extern template struct RemoteCommandRequestImpl<HostAndPort>;
extern template struct RemoteCommandRequestImpl<std::vector<HostAndPort>>;
using RemoteCommandRequest = RemoteCommandRequestImpl<HostAndPort>;
using RemoteCommandRequestOnAny = RemoteCommandRequestImpl<std::vector<HostAndPort>>;
} // namespace executor
} // namespace mongo
|
