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) 2018 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 <memory>
#include "mongo/base/disallow_copying.h"
#include "mongo/s/chunk_writes_tracker.h"
namespace mongo {
/**
* Drives state transitions and the status of a ChunkWritesTracker for a chunk
* while it is splitting. Supports cancelability so that we don't lose
* information from the writes tracker if the split errors. Should be created
* when it is decided that a split should be performed and then passed along to
* the ChunkSplitter which will drive these state changes.
*/
class ChunkSplitStateDriver {
MONGO_DISALLOW_COPYING(ChunkSplitStateDriver);
public:
/**
* Tries to lock the writesTracker for splitting, and if it succeeds,
* constructs and returns a ChunkSplitStateDriver object. If it fails due to the
* writesTracker already being locked, returns boost::none.
*/
static boost::optional<ChunkSplitStateDriver> tryInitiateSplit(
std::shared_ptr<ChunkWritesTracker> writesTracker);
/**
* Sets the other pointer back to default initialized state so that it
* doesn't try to cancel any ongoing split in its destructor. This
* constructor is required for boost::optional.
*/
ChunkSplitStateDriver(ChunkSplitStateDriver&& other);
/**
* Not needed.
*/
ChunkSplitStateDriver& operator=(ChunkSplitStateDriver&&) = delete;
/**
* If there's an ongoing split, cancels it. Otherwise does nothing.
*/
~ChunkSplitStateDriver();
/**
* Clears the current bytes written, but stashes them in a variable in case
* the split is later canceled.
*/
void prepareSplit();
/**
* Marks the split as committed, which means that shouldSplit will
* never again return true.
*/
void commitSplit();
/**
* Marks the split state of an in-progress split back to kNotSplitting.
* If a split has already been prepared, resets the byte counter to what it
* was prior to prepare plus any new bytes that have been written.
*/
void cancelSplit();
private:
/**
* Should only be used by tryInitiateSplit
*/
ChunkSplitStateDriver(std::shared_ptr<ChunkWritesTracker> writesTracker)
: _writesTracker(writesTracker), _splitState(SplitState::kSplitInProgress) {}
/**
* Pointer to the writes tracker object for which we're driving the split
*/
std::weak_ptr<ChunkWritesTracker> _writesTracker;
/**
* Carries over result from prepare into cancelSplit.
*/
uint64_t _stashedBytesWritten{0};
/**
* The current state of the chunk with respect to its progress being split.
*/
enum class SplitState {
kNotSplitting,
kSplitInProgress,
kSplitPrepared,
kSplitCommitted,
} _splitState{SplitState::kNotSplitting};
/**
* Returns the ChunkWritesTracker whose state this driver is controlling,
* checking to make sure it has not yet been destroyed.
*/
std::shared_ptr<ChunkWritesTracker> _getWritesTracker();
};
} // namespace mongo
|
