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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
// record_store.h
/**
* 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 "mongo/base/owned_pointer_vector.h"
#include "mongo/db/diskloc.h"
#include "mongo/db/exec/collection_scan_common.h"
namespace mongo {
class Collection;
struct CompactOptions;
struct CompactStats;
class DeletedRecord;
class DocWriter;
class ExtentManager;
class MAdvise;
class NamespaceDetails;
class Record;
class OperationContext;
class RecordStoreCompactAdaptor;
class RecordStore;
struct ValidateResults;
class ValidateAdaptor;
/**
* Allows inserting a Record "in-place" without creating a copy ahead of time.
*/
class DocWriter {
public:
virtual ~DocWriter() {}
virtual void writeDocument( char* buf ) const = 0;
virtual size_t documentSize() const = 0;
virtual bool addPadding() const { return true; }
};
/**
* A RecordIterator provides an interface for walking over a RecordStore.
* The details of navigating the collection's structure are below this interface.
*/
class RecordIterator {
public:
virtual ~RecordIterator() { }
// True if getNext will produce no more data, false otherwise.
virtual bool isEOF() = 0;
// Return the DiskLoc that the iterator points at. Returns DiskLoc() if isEOF.
virtual DiskLoc curr() = 0;
// Return the DiskLoc that the iterator points at and move the iterator to the next item
// from the collection. Returns DiskLoc() if isEOF.
virtual DiskLoc getNext() = 0;
// Can only be called after prepareToYield and before recoverFromYield.
virtual void invalidate(const DiskLoc& dl) = 0;
// Save any state required to resume operation (without crashing) after DiskLoc deletion or
// a collection drop.
virtual void prepareToYield() = 0;
// Returns true if collection still exists, false otherwise.
virtual bool recoverFromYield() = 0;
// normally this will just go back to the RecordStore and convert
// but this gives the iterator an oppurtnity to optimize
virtual const Record* recordFor( const DiskLoc& loc ) const = 0;
};
class RecordStore {
MONGO_DISALLOW_COPYING(RecordStore);
public:
RecordStore( const StringData& ns );
virtual ~RecordStore();
// META
// name of the RecordStore implementation
virtual const char* name() const = 0;
virtual long long dataSize() const = 0;
virtual long long numRecords() const = 0;
/**
* @param extraInfo - optional more debug info
* @param level - optional, level of debug info to put in (higher is more)
*/
virtual int64_t storageSize( BSONObjBuilder* extraInfo = NULL, int infoLevel = 0 ) const = 0;
// CRUD related
virtual Record* recordFor( const DiskLoc& loc ) const = 0;
virtual void deleteRecord( OperationContext* txn, const DiskLoc& dl ) = 0;
virtual StatusWith<DiskLoc> insertRecord( OperationContext* txn,
const char* data,
int len,
int quotaMax ) = 0;
virtual StatusWith<DiskLoc> insertRecord( OperationContext* txn,
const DocWriter* doc,
int quotaMax ) = 0;
/**
* returned iterator owned by caller
* canonical to get all would be
* getIterator( DiskLoc(), false, CollectionScanParams::FORWARD )
*/
virtual RecordIterator* getIterator( const DiskLoc& start, bool tailable,
const CollectionScanParams::Direction& dir) const = 0;
/**
* Constructs an iterator over a potentially corrupted store, which can be used to salvage
* damaged records. The iterator might return every record in the store if all of them
* are reachable and not corrupted.
*/
virtual RecordIterator* getIteratorForRepair() const = 0;
/**
* Returns many iterators that partition the RecordStore into many disjoint sets. Iterating
* all returned iterators is equivalent to Iterating the full store.
*/
virtual std::vector<RecordIterator*> getManyIterators() const = 0;
// higher level
/**
* removes all Records
*/
virtual Status truncate( OperationContext* txn ) = 0;
// does this RecordStore support the compact operation
virtual bool compactSupported() const = 0;
virtual Status compact( OperationContext* txn,
RecordStoreCompactAdaptor* adaptor,
const CompactOptions* options,
CompactStats* stats ) = 0;
/**
* @param full - does more checks
* @param scanData - scans each document
* @return OK if the validate run successfully
* OK will be returned even if corruption is found
* deatils will be in result
*/
virtual Status validate( OperationContext* txn,
bool full, bool scanData,
ValidateAdaptor* adaptor,
ValidateResults* results, BSONObjBuilder* output ) const = 0;
/**
* Load all data into cache.
* What cache depends on implementation.
* @param output (optional) - where to put detailed stats
*/
virtual Status touch( OperationContext* txn, BSONObjBuilder* output ) const = 0;
// TODO: this makes me sad, it shouldn't be in the interface
// do not use this anymore
virtual void increaseStorageSize( OperationContext* txn, int size, int quotaMax ) = 0;
protected:
std::string _ns;
};
class RecordStoreCompactAdaptor {
public:
virtual ~RecordStoreCompactAdaptor(){}
virtual bool isDataValid( Record* rec ) = 0;
virtual size_t dataSize( Record* rec ) = 0;
virtual void inserted( Record* rec, const DiskLoc& newLocation ) = 0;
};
struct ValidateResults {
ValidateResults() {
valid = true;
}
bool valid;
std::vector<std::string> errors;
};
/**
* This is so when a RecordStore is validating all records
* it can call back to someone to check if a record is valid.
* The actual data contained in a Record is totally opaque to the implementation.
*/
class ValidateAdaptor {
public:
virtual ~ValidateAdaptor(){}
virtual Status validate( Record* record, size_t* dataSize ) = 0;
};
}
|
