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
|
/**
* 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/db/exec/collection_scan_common.h"
namespace mongo {
class Collection;
class DiskLoc;
class ExtentManager;
class NamespaceDetails;
/**
* A CollectionIterator provides an interface for walking over a collection.
* The details of navigating the collection's structure are below this interface.
*/
class CollectionIterator {
public:
virtual ~CollectionIterator() { }
// 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;
};
/**
* This class iterates over a non-capped collection identified by 'ns'.
* The collection must exist when the constructor is called.
*
* If start is not DiskLoc(), the iteration begins at that DiskLoc.
*/
class FlatIterator : public CollectionIterator {
public:
FlatIterator(const Collection* collection, const DiskLoc& start,
const CollectionScanParams::Direction& dir);
virtual ~FlatIterator() { }
virtual bool isEOF();
virtual DiskLoc getNext();
virtual DiskLoc curr();
virtual void invalidate(const DiskLoc& dl);
virtual void prepareToYield();
virtual bool recoverFromYield();
private:
// The result returned on the next call to getNext().
DiskLoc _curr;
const Collection* _collection;
CollectionScanParams::Direction _direction;
};
/**
* This class iterates over a capped collection identified by 'ns'.
* The collection must exist when the constructor is called.
*
* If start is not DiskLoc(), the iteration begins at that DiskLoc.
*
* If tailable is true, getNext() can be called after isEOF. It will use the last valid
* returned DiskLoc and try to find the next record from that.
*/
class CappedIterator : public CollectionIterator {
public:
CappedIterator(const Collection* collection, const DiskLoc& start, bool tailable,
const CollectionScanParams::Direction& dir);
virtual ~CappedIterator() { }
// If this is a tailable cursor, isEOF could change its mind after a call to getNext().
virtual bool isEOF();
virtual DiskLoc getNext();
virtual DiskLoc curr();
virtual void invalidate(const DiskLoc& dl);
virtual void prepareToYield();
virtual bool recoverFromYield();
private:
/**
* Internal collection navigation helper methods.
*/
static DiskLoc getNextCapped(const NamespaceDetails* nsd, const ExtentManager* em,
const DiskLoc& dl, CollectionScanParams::Direction direction );
static DiskLoc prevLoop(const NamespaceDetails* nsd, const ExtentManager* em,
const DiskLoc& curr);
static DiskLoc nextLoop(const NamespaceDetails* nsd, const ExtentManager* em,
const DiskLoc& prev);
// The collection we're iterating over.
const Collection* _collection;
// The result returned on the next call to getNext().
DiskLoc _curr;
// If we're tailable, we try to progress from the last valid result when we hit the end.
DiskLoc _prev;
bool _tailable;
CollectionScanParams::Direction _direction;
// If invalidate kills the DiskLoc we need to move forward, we kill the iterator. See the
// comment in the body of invalidate(...).
bool _killedByInvalidate;
};
} // namespace mongo
|
