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
|
/**
* 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 <vector>
#include "mongo/base/status.h"
#include "mongo/bson/timestamp.h"
#include "mongo/db/s/resharding/coordinator_document_gen.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/concurrency/with_lock.h"
#include "mongo/util/future.h"
#include "mongo/util/string_map.h"
namespace mongo {
class ChunkType;
class NamespaceString;
class OperationContext;
class ServiceContext;
class ShardId;
/**
* Observes writes that indicate state changes for a resharding operation. Holds promises that
* the ReshardingCoordinator waits on in order to transition to a new state.
*
* An instance of this object is specific to one resharding operation.
*/
class ReshardingCoordinatorObserver {
public:
ReshardingCoordinatorObserver();
~ReshardingCoordinatorObserver();
/**
* Called when a donor or recipient writes to its 'state' field. The updatedStateDoc is the
* post-image of the ReshardingCoordinatorDocument after the update.
*/
void onReshardingParticipantTransition(const ReshardingCoordinatorDocument& updatedStateDoc);
/**
* When the last donor reports its 'minFetchTimestamp', selects the highest 'minFetchTimestamp'
* of all donors to be the 'fetchTimestamp'. Fulfills the '_allDonorsReportedMinFetchTimestamp'
* promise with this 'fetchTimestamp'.
*/
SharedSemiFuture<ReshardingCoordinatorDocument> awaitAllDonorsReadyToDonate();
/**
* Fulfills the '_allRecipientsFinishedCloning' promise when the last recipient writes that it
* has finished cloning the collection and is ready to start applying oplog entries missed
* during collection cloning.
*/
SharedSemiFuture<ReshardingCoordinatorDocument> awaitAllRecipientsFinishedCloning();
/**
* Fulfills the '_allRecipientsFinishedApplying' promise when the last recipient writes that it
* is in 'steady-state'.
*/
SharedSemiFuture<ReshardingCoordinatorDocument> awaitAllRecipientsFinishedApplying();
/**
* Fulfills the '_allRecipientsReportedStrictConsistencyTimestamp' promise when the last
* recipient writes that it is in 'strict-consistency' state as well as its
* 'strictConsistencyTimestamp'.
*/
SharedSemiFuture<ReshardingCoordinatorDocument> awaitAllRecipientsInStrictConsistency();
/**
* Fulfills the '_allRecipientsRenamedCollection' promise when the last recipient writes
* that it is in 'done' state.
*/
SharedSemiFuture<ReshardingCoordinatorDocument> awaitAllRecipientsRenamedCollection();
/**
* Fulfills the '_allDonorsDroppedOriginalCollection' promise when the last donor writes that it
* is in 'done' state.
*/
SharedSemiFuture<ReshardingCoordinatorDocument> awaitAllDonorsDroppedOriginalCollection();
/**
* Fulfills the '_allParticipantsDoneAborting' promise when the last recipient or donor writes
* that it is in 'kDone' with an abortReason.
*/
SharedSemiFuture<void> awaitAllParticipantsDoneAborting();
/**
* Checks if all recipients are in steady state. Otherwise, sets an error state so that
* resharding is aborted.
*/
void onCriticalSectionTimeout();
/**
* Sets errors on any promises that have not yet been fulfilled.
*/
void interrupt(Status status);
private:
/**
* Does work necessary for both recoverable errors (failover/stepdown) and unrecoverable errors
* (abort resharding).
*/
void _onAbortOrStepdown(WithLock, Status status);
// Protects the state below
Mutex _mutex = MONGO_MAKE_LATCH("ReshardingCoordinatorObserver::_mutex");
/**
* Promises indicating that either all donors or all recipients have entered a specific state.
* The ReshardingCoordinator waits on these in order to transition states. Promises must be
* fulfilled in descending order.
*
* Below are the relationships between promise and expected state in
* format: {promiseToFulfill, expectedState}
*
* {_allDonorsReportedMinFetchTimestamp, DonorStateEnum::kDonatingInitialData}
* {_allRecipientsFinishedCloning, RecipientStateEnum::kApplying}
* {_allRecipientsFinishedApplying, RecipientStateEnum::kSteadyState}
* {_allRecipientsReportedStrictConsistencyTimestamp, RecipientStateEnum::kStrictConsistency}
* {_allRecipientsRenamedCollection, RecipientStateEnum::kDone}
* {_allDonorsDroppedOriginalCollection, DonorStateEnum::kDone}
* {_allParticipantsDoneAborting,
* DonorStateEnum::kDone with abortReason AND
* RecipientStateEnum::kDone with abortReason}
*/
SharedPromise<ReshardingCoordinatorDocument> _allDonorsReportedMinFetchTimestamp;
SharedPromise<ReshardingCoordinatorDocument> _allRecipientsFinishedCloning;
SharedPromise<ReshardingCoordinatorDocument> _allRecipientsFinishedApplying;
SharedPromise<ReshardingCoordinatorDocument> _allRecipientsReportedStrictConsistencyTimestamp;
SharedPromise<ReshardingCoordinatorDocument> _allRecipientsRenamedCollection;
SharedPromise<ReshardingCoordinatorDocument> _allDonorsDroppedOriginalCollection;
SharedPromise<void> _allParticipantsDoneAborting;
};
} // namespace mongo
|