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
|
/**
* 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/db/s/balancer/balancer_policy.h"
#include "mongo/s/catalog/type_collection.h"
namespace mongo {
/**
* Helper class that
* - stores the progress of the defragmentation algorithm on each collection
* - generates a single sequence of action descriptors to fairly execute the defragmentation
* algorithm across collections.
*/
class BalancerDefragmentationPolicy {
public:
virtual ~BalancerDefragmentationPolicy() {}
/**
* Checks if the collection should be running defragmentation. If a new defragmentation should
* be started, this will initialize the defragmentation.
*/
virtual void refreshCollectionDefragmentationStatus(OperationContext* opCtx,
const CollectionType& coll) = 0;
/**
* Checks if the collection is currently being defragmented, and signals the defragmentation
* to end if so.
*/
virtual void abortCollectionDefragmentation(OperationContext* opCtx,
const NamespaceString& nss) = 0;
/**
* Returns true if the specified collection is currently being defragmented.
*/
virtual bool isDefragmentingCollection(const UUID& uuid) = 0;
virtual BSONObj reportProgressOn(const UUID& uuid) = 0;
virtual MigrateInfoVector selectChunksToMove(OperationContext* opCtx,
stdx::unordered_set<ShardId>* usedShards) = 0;
/**
* Generates a descriptor detailing the next defragmentation action (and the targeted
* collection/chunk[s]) to be performed.
*
* The balancer is expected to execute a command matching the content of the descriptor and to
* invoke the related acknowledge() method on the defragmentation policy once the result is
* available (this will allow to update the progress of the algorithm).
*
* This call blocks when there is no action to be performed (no collection to be defragmented),
* or when there are too many outstanding actions (too many calls to getStreamingAction() that
* have not been acknowledged).
*/
virtual SemiFuture<DefragmentationAction> getNextStreamingAction(OperationContext* opCtx) = 0;
/**
* Stops the generation of new actions: any new call to (or currently blocked ones on)
* getNextStreamingAction() will receive an empty descriptor. Meant to be invoked as part of the
* balancer shutdown sequence.
*/
virtual void closeActionStream() = 0;
virtual void acknowledgeMergeResult(OperationContext* opCtx,
MergeInfo action,
const Status& result) = 0;
virtual void acknowledgeAutoSplitVectorResult(OperationContext* opCtx,
AutoSplitVectorInfo action,
const StatusWith<SplitPoints>& result) = 0;
virtual void acknowledgeSplitResult(OperationContext* opCtx,
SplitInfoWithKeyPattern action,
const Status& result) = 0;
virtual void acknowledgeDataSizeResult(OperationContext* opCtx,
DataSizeInfo action,
const StatusWith<DataSizeResponse>& result) = 0;
virtual void acknowledgeMoveResult(OperationContext* opCtx,
MigrateInfo action,
const Status& result) = 0;
};
} // namespace mongo
|
