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
|
/**
* Copyright (C) 2021-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/bson/bsonobj.h"
#include "mongo/executor/task_executor.h"
#include "mongo/s/request_types/move_chunk_request.h"
#include "mongo/s/shard_id.h"
namespace mongo {
class ChunkType;
class ShardKeyPattern;
class MigrationSecondaryThrottleOptions;
/**
* Set of command-specific aggregations of submission settings
*/
struct MoveChunkSettings {
MoveChunkSettings(int64_t maxChunkSizeBytes,
const MigrationSecondaryThrottleOptions& secondaryThrottle,
bool waitForDelete,
MoveChunkRequest::ForceJumbo forceJumbo)
: maxChunkSizeBytes(maxChunkSizeBytes),
secondaryThrottle(secondaryThrottle),
waitForDelete(waitForDelete),
forceJumbo(forceJumbo) {}
int64_t maxChunkSizeBytes;
const MigrationSecondaryThrottleOptions secondaryThrottle;
bool waitForDelete;
MoveChunkRequest::ForceJumbo forceJumbo;
};
struct SplitVectorSettings {
SplitVectorSettings()
: force(false),
maxSplitPoints(boost::none),
maxChunkObjects(boost::none),
maxChunkSizeBytes(boost::none) {}
SplitVectorSettings(boost::optional<long long> maxSplitPoints,
boost::optional<long long> maxChunkObjects,
boost::optional<long long> maxChunkSizeBytes,
bool force)
: force(force),
maxSplitPoints(maxSplitPoints),
maxChunkObjects(maxChunkObjects),
maxChunkSizeBytes(maxChunkSizeBytes) {}
bool force;
boost::optional<long long> maxSplitPoints;
boost::optional<long long> maxChunkObjects;
boost::optional<long long> maxChunkSizeBytes;
};
/**
* Common interface for any response generated from a command issued through the
* BalancerCommandsScheduler.
*/
class DeferredResponse {
public:
virtual ~DeferredResponse() = default;
virtual UUID getRequestId() const = 0;
virtual bool hasFinalised() const = 0;
/**
* Blocking as long as hasFinalised() is false.
*/
virtual Status getOutcome() = 0;
};
/**
* Set of command-specific subclasses of DeferredResponse,
* adding helper functions to deserialise the response payload (where this applies).
*/
class MoveChunkResponse : public DeferredResponse {};
class MergeChunksResponse : public DeferredResponse {};
class SplitVectorResponse : public DeferredResponse {
public:
virtual StatusWith<std::vector<BSONObj>> getSplitKeys() = 0;
};
class SplitChunkResponse : public DeferredResponse {};
class ChunkDataSizeResponse : public DeferredResponse {
public:
virtual StatusWith<long long> getSize() = 0;
virtual StatusWith<long long> getNumObjects() = 0;
};
/**
* Interface for the asynchronous submission of chunk-related commands.
* Every method assumes that the ChunkType input parameter is filled up with information about
* version and location (shard ID).
**/
class BalancerCommandsScheduler {
public:
virtual ~BalancerCommandsScheduler() = default;
/**
* Triggers an asynchronous self-initialisation of the component,
* which will start accepting request<Command>() invocations.
*/
virtual void start(OperationContext* opCtx) = 0;
/**
* Stops the scheduler and the processing of any outstanding and incoming request
* (which will be resolved as cancelled).
*/
virtual void stop() = 0;
virtual std::unique_ptr<MoveChunkResponse> requestMoveChunk(
OperationContext* opCtx,
const NamespaceString& nss,
const ChunkType& chunk,
const ShardId& recipient,
const MoveChunkSettings& commandSettings) = 0;
virtual std::unique_ptr<MergeChunksResponse> requestMergeChunks(
OperationContext* opCtx,
const NamespaceString& nss,
const ChunkType& lowerBound,
const ChunkType& upperBound) = 0;
virtual std::unique_ptr<SplitVectorResponse> requestSplitVector(
OperationContext* opCtx,
const NamespaceString& nss,
const ChunkType& chunk,
const ShardKeyPattern& shardKeyPattern,
const SplitVectorSettings& commandSettings) = 0;
virtual std::unique_ptr<SplitChunkResponse> requestSplitChunk(
OperationContext* opCtx,
const NamespaceString& nss,
const ChunkType& chunk,
const ShardKeyPattern& shardKeyPattern,
const std::vector<BSONObj>& splitPoints) = 0;
virtual std::unique_ptr<ChunkDataSizeResponse> requestChunkDataSize(
OperationContext* opCtx,
const NamespaceString& nss,
const ChunkType& chunk,
const ShardKeyPattern& shardKeyPattern,
bool estimatedValue) = 0;
};
} // namespace mongo
|
