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
168
169
170
171
|
/**
* Copyright (C) 2014 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 <stdlib.h>
#include <string>
#include "mongo/base/disallow_copying.h"
#include "mongo/db/storage/snapshot.h"
#include "mongo/platform/cstdint.h"
namespace mongo {
class BSONObjBuilder;
class OperationContext;
/**
* A RecoveryUnit is responsible for ensuring that data is persisted.
* All on-disk information must be mutated through this interface.
*/
class RecoveryUnit {
MONGO_DISALLOW_COPYING(RecoveryUnit);
public:
virtual ~RecoveryUnit() {}
virtual void reportState(BSONObjBuilder* b) const {}
virtual void beingReleasedFromOperationContext() {}
virtual void beingSetOnOperationContext() {}
/**
* These should be called through WriteUnitOfWork rather than directly.
*
* A call to 'beginUnitOfWork' marks the beginning of a unit of work. Each call to
* 'beginUnitOfWork' must be matched with exactly one call to either 'commitUnitOfWork' or
* 'abortUnitOfWork'. When 'abortUnitOfWork' is called, all changes made since the begin
* of the unit of work will be rolled back.
*/
virtual void beginUnitOfWork(OperationContext* opCtx) = 0;
virtual void commitUnitOfWork() = 0;
virtual void abortUnitOfWork() = 0;
/**
* Waits until all writes prior to this call are durable. Returns true, unless the storage
* engine cannot guarantee durability, which should never happen when isDurable() returned
* true.
*/
virtual bool waitUntilDurable() = 0;
/**
* This is a hint to the engine that this transaction is going to call waitUntilDurable at
* the end. This should be called before any work is done so that transactions can be
* configured correctly.
*/
virtual void goingToWaitUntilDurable() {}
/**
* When this is called, if there is an open transaction, it is closed. On return no
* transaction is active. This cannot be called inside of a WriteUnitOfWork, and should
* fail if it is.
*/
virtual void abandonSnapshot() = 0;
virtual SnapshotId getSnapshotId() const = 0;
/**
* A Change is an action that is registerChange()'d while a WriteUnitOfWork exists. The
* change is either rollback()'d or commit()'d when the WriteUnitOfWork goes out of scope.
*
* Neither rollback() nor commit() may fail or throw exceptions.
*
* Change implementors are responsible for handling their own locking, and must be aware
* that rollback() and commit() may be called after resources with a shorter lifetime than
* the WriteUnitOfWork have been freed. Each registered change will be committed or rolled
* back once.
*/
class Change {
public:
virtual ~Change() {}
virtual void rollback() = 0;
virtual void commit() = 0;
};
/**
* The RecoveryUnit takes ownership of the change. The commitUnitOfWork() method calls the
* commit() method of each registered change in order of registration. The endUnitOfWork()
* method calls the rollback() method of each registered Change in reverse order of
* registration. Either will unregister and delete the changes.
*
* The registerChange() method may only be called when a WriteUnitOfWork is active, and
* may not be called during commit or rollback.
*/
virtual void registerChange(Change* change) = 0;
//
// The remaining methods probably belong on DurRecoveryUnit rather than on the interface.
//
/**
* Declare that the data at [x, x + len) is being written.
*/
virtual void* writingPtr(void* data, size_t len) = 0;
//
// Syntactic sugar
//
/**
* Declare write intent for an int
*/
inline int& writingInt(int& d) {
return *writing(&d);
}
/**
* A templated helper for writingPtr.
*/
template <typename T>
inline T* writing(T* x) {
writingPtr(x, sizeof(T));
return x;
}
/**
* Sets a flag that declares this RecoveryUnit will skip rolling back writes, for the
* duration of the current outermost WriteUnitOfWork. This function can only be called
* between a pair of unnested beginUnitOfWork() / endUnitOfWork() calls.
* The flag is cleared when endUnitOfWork() is called.
* While the flag is set, rollback will skip rolling back writes, but custom rollback
* change functions are still called. Clearly, this functionality should only be used when
* writing to temporary collections that can be cleaned up externally. For example,
* foreground index builds write to a temporary collection; if something goes wrong that
* normally requires a rollback, we can instead clean up the index by dropping the entire
* index.
* Setting the flag may permit increased performance.
*/
virtual void setRollbackWritesDisabled() = 0;
protected:
RecoveryUnit() {}
};
} // namespace mongo
|
