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
|
/**
* Copyright (C) 2020-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 <list>
#include <boost/optional.hpp>
#include "mongo/db/concurrency/d_concurrency.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/s/range_deletion_task_gen.h"
#include "mongo/executor/task_executor.h"
#include "mongo/s/catalog/type_chunk.h"
namespace mongo {
class BSONObj;
// The maximum number of documents to delete in a single batch during range deletion.
// secondaryThrottle and rangeDeleterBatchDelayMS apply between each batch.
// Must be positive or 0 (the default), which means to use the value of
// internalQueryExecYieldIterations (or 1 if that's negative or zero).
extern AtomicWord<int> rangeDeleterBatchSize;
// After completing a batch of document deletions, the time in millis to wait before commencing the
// next batch of deletions.
extern AtomicWord<int> rangeDeleterBatchDelayMS;
/**
* Acquires the config db lock in IX mode and the collection lock for config.rangeDeletions in X
* mode.
*/
class ScopedRangeDeleterLock {
public:
ScopedRangeDeleterLock(OperationContext* opCtx);
private:
Lock::DBLock _configLock;
Lock::CollectionLock _rangeDeletionLock;
};
/**
* Deletes a range of orphaned documents for the given namespace and collection UUID. Returns a
* future which will be resolved when the range has finished being deleted. The resulting future
* will contain an error in cases where the range could not be deleted successfully.
*
* The overall algorithm is as follows:
* 1. Wait for the all active queries which could be using the range to resolve by waiting
* for the waitForActiveQueriesToComplete future to resolve.
* 2. Waits for delayForActiveQueriesOnSecondariesToComplete seconds before deleting any documents,
* to give queries running on secondaries a chance to finish.
* 3. Delete documents in a series of batches with up to numDocsToRemovePerBatch documents per
* batch, with a delay of delayBetweenBatches milliseconds in between batches.
*/
SharedSemiFuture<void> removeDocumentsInRange(
const std::shared_ptr<executor::TaskExecutor>& executor,
SemiFuture<void> waitForActiveQueriesToComplete,
const NamespaceString& nss,
const UUID& collectionUuid,
const BSONObj& keyPattern,
const ChunkRange& range,
const UUID& migrationId,
int numDocsToRemovePerBatch,
Seconds delayForActiveQueriesOnSecondariesToComplete);
/**
* - Retrieves source collection's persistent range deletion tasks from `config.rangeDeletions`
* - Associates tasks to the target collection
* - Stores tasks in `config.rangeDeletionsForRename`
*/
void snapshotRangeDeletionsForRename(OperationContext* opCtx,
const NamespaceString& fromNss,
const NamespaceString& toNss);
/**
* Copies `config.rangeDeletionsForRename` tasks for the specified namespace to
* `config.rangeDeletions`.
*/
void restoreRangeDeletionTasksForRename(OperationContext* opCtx, const NamespaceString& nss);
/**
* - Deletes range deletion tasks for the FROM namespace from `config.rangeDeletions`.
* - Deletes range deletion tasks for the TO namespace from `config.rangeDeletionsForRename`
*/
void deleteRangeDeletionTasksForRename(OperationContext* opCtx,
const NamespaceString& fromNss,
const NamespaceString& toNss);
/**
* Sets the processing field on the range deletion document for the given migration id.
*/
void markAsProcessingRangeDeletionTask(OperationContext* opCtx, const UUID& migrationId);
/**
* Computes and sets the numOrphanDocs field for each document in `config.rangeDeletions` (skips
* documents referring to older incarnations of a collection)
*/
void setOrphanCountersOnRangeDeletionTasks(OperationContext* opCtx);
/**
* Unsets the numOrphanDocs field from each document in `config.rangeDeletions`
*/
void clearOrphanCountersFromRangeDeletionTasks(OperationContext* opCtx);
} // namespace mongo
|
