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
|
/**
* 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 <boost/optional.hpp>
#include <vector>
#include "mongo/base/disallow_copying.h"
#include "mongo/db/s/balancer/balancer_policy.h"
#include "mongo/s/catalog/type_chunk.h"
#include "mongo/s/chunk_version.h"
namespace mongo {
class ChunkType;
class NamespaceString;
class OperationContext;
template <typename T>
class StatusWith;
/**
* Interface used by the balancer for selecting chunks, which need to be moved around in order for
* the sharded cluster to be balanced. It is up to the implementation to decide what exactly
* 'balanced' means.
*/
class BalancerChunkSelectionPolicy {
MONGO_DISALLOW_COPYING(BalancerChunkSelectionPolicy);
public:
/**
* Describes a chunk which needs to be split, because it violates the balancer policy.
*/
struct SplitInfo {
SplitInfo(ShardId shardId,
NamespaceString nss,
ChunkVersion collectionVersion,
ChunkVersion chunkVersion,
const BSONObj& minKey,
const BSONObj& maxKey,
std::vector<BSONObj> splitKeys);
std::string toString() const;
ShardId shardId;
NamespaceString nss;
ChunkVersion collectionVersion;
ChunkVersion chunkVersion;
BSONObj minKey;
BSONObj maxKey;
std::vector<BSONObj> splitKeys;
};
typedef std::vector<SplitInfo> SplitInfoVector;
typedef std::vector<MigrateInfo> MigrateInfoVector;
virtual ~BalancerChunkSelectionPolicy();
/**
* Potentially blocking method, which gives out a set of chunks, which need to be split because
* they violate the policy for some reason. The reason is decided by the policy and may include
* chunk is too big or chunk straddles a tag range.
*/
virtual StatusWith<SplitInfoVector> selectChunksToSplit(OperationContext* opCtx) = 0;
/**
* Potentially blocking method, which gives out a set of chunks to be moved.
*/
virtual StatusWith<MigrateInfoVector> selectChunksToMove(OperationContext* opCtx) = 0;
/**
* Requests a single chunk to be relocated to a different shard, if possible. If some error
* occurs while trying to determine the best location for the chunk, a failed status is
* returned. If the chunk is already at the best shard that it can be, returns boost::none.
* Otherwise returns migration information for where the chunk should be moved.
*/
virtual StatusWith<boost::optional<MigrateInfo>> selectSpecificChunkToMove(
OperationContext* opCtx, const ChunkType& chunk) = 0;
/**
* Asks the chunk selection policy to validate that the specified chunk migration is allowed
* given the current rules. Returns OK if the migration won't violate any rules or any other
* failed status otherwise.
*/
virtual Status checkMoveAllowed(OperationContext* opCtx,
const ChunkType& chunk,
const ShardId& newShardId) = 0;
protected:
BalancerChunkSelectionPolicy();
};
} // namespace mongo
|
