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) 2013 10gen 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 <map>
#include <set>
#include <string>
#include "mongo/db/range_deleter.h"
#include "mongo/stdx/mutex.h"
namespace mongo {
struct DeletedRange {
std::string ns;
BSONObj min;
BSONObj max;
BSONObj shardKeyPattern;
};
/**
* Comparator function object compatible with set.
*/
struct DeletedRangeCmp {
bool operator()(const DeletedRange& lhs, const DeletedRange& rhs) const;
};
/**
* Mock environment for RangeDeleter with knobs for pausing/resuming
* deletes, setting open cursors IDs per namespace and the ability to
* record the history of deletes performed through this environment.
*/
class RangeDeleterMockEnv : public mongo::RangeDeleterEnv {
public:
RangeDeleterMockEnv();
//
// Environment modification methods.
//
/**
* Adds an id to the current set of cursors in the given namespace.
*/
void addCursorId(StringData ns, CursorId id);
/**
* Removes the id from the set of open cursors in the given namespace.
*/
void removeCursorId(StringData ns, CursorId id);
//
// Environment synchronization methods.
//
/**
* Blocks all new deletes from proceeding.
*/
void pauseDeletes();
/**
* Unblocks one paused delete.
*/
void resumeOneDelete();
/**
* Blocks until the getCursor method was called and terminated at least the
* specified number of times for the entire lifetime of this deleter.
*/
void waitForNthGetCursor(uint64_t nthCall);
/**
* Blocks until the deleteRange method was called and at the same time paused
* at least the specified number of times for the entire lifetime of this deleter.
*/
void waitForNthPausedDelete(uint64_t nthPause);
//
// Environment introspection methods.
//
/**
* Returns true if deleteRange was called at least once.
*/
bool deleteOccured() const;
/**
* Returns the last delete. Undefined if deleteOccured is false.
*/
DeletedRange getLastDelete() const;
//
// Environment methods.
//
/**
* Basic implementation of delete that matches the signature for
* RangeDeleterEnv::deleteRange. This does not actually perform the delete
* but simply keeps a record of it. Can also be paused by pauseDeletes and
* resumed with resumeDeletes.
*/
bool deleteRange(OperationContext* txn,
const RangeDeleteEntry& taskDetails,
long long int* deletedDocs,
std::string* errMsg);
/**
* Basic implementation of gathering open cursors that matches the signature for
* RangeDeleterEnv::getCursorIds. The cursors returned can be modified with
* the setCursorId and clearCursorMap methods.
*/
void getCursorIds(OperationContext* txn, StringData ns, std::set<CursorId>* in);
private:
// mutex acquisition ordering:
// _envStatMutex -> _pauseDeleteMutex -> _deleteListMutex -> _cursorMapMutex
mutable stdx::mutex _deleteListMutex;
std::vector<DeletedRange> _deleteList;
stdx::mutex _cursorMapMutex;
std::map<std::string, std::set<CursorId>> _cursorMap;
// Protects _pauseDelete & _pausedCount
stdx::mutex _pauseDeleteMutex;
stdx::condition_variable _pausedCV;
bool _pauseDelete;
// Number of times a delete gets paused.
uint64_t _pausedCount;
// _pausedCount < nthPause (used by waitForNthPausedDelete)
stdx::condition_variable _pausedDeleteChangeCV;
// Protects all variables below this line.
stdx::mutex _envStatMutex;
// Keeps track of the number of times getCursorIds was called.
uint64_t _getCursorsCallCount;
// _getCursorsCallCount < nthCall (used by waitForNthGetCursor)
stdx::condition_variable _cursorsCallCountUpdatedCV;
};
}
|
