summaryrefslogtreecommitdiff
path: root/src/mongo/db/intervalbtreecursor.cpp
blob: b995e1ad3a32f223c85eb7546e8caf790404fd0c (plain)
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
/**
 *    Copyright (C) 2012 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/>.
 */

#include "mongo/db/intervalbtreecursor.h"

#include "mongo/db/btree.h"
#include "mongo/db/kill_current_op.h"
#include "mongo/db/namespace_details-inl.h"
#include "mongo/db/pdfile.h"

namespace mongo {

    /**
     * Advance 'loc' until it does not reference an unused key, or the end of the btree is reached.
     */
    static void skipUnused( BtreeKeyLocation* loc ) {

        // While loc points to an unused key ...
        while( !loc->bucket.isNull() &&
               loc->bucket.btree<V1>()->k( loc->pos ).isUnused() ) {

            // ... advance loc to the next key in the btree.
            loc->bucket = loc->bucket.btree<V1>()->advance( loc->bucket,
                                                            loc->pos,
                                                            1,
                                                            __FUNCTION__ );
        }
    }

    IntervalBtreeCursor* IntervalBtreeCursor::make( NamespaceDetails* namespaceDetails,
                                                    const IndexDetails& indexDetails,
                                                    const BSONObj& lowerBound,
                                                    bool lowerBoundInclusive,
                                                    const BSONObj& upperBound,
                                                    bool upperBoundInclusive ) {
        if ( indexDetails.version() != 1 ) {
            // Only v1 indexes are supported.
            return NULL;
        }
        auto_ptr<IntervalBtreeCursor> ret( new IntervalBtreeCursor( namespaceDetails,
                                                                    indexDetails,
                                                                    lowerBound,
                                                                    lowerBoundInclusive,
                                                                    upperBound,
                                                                    upperBoundInclusive ) );
        ret->init();
        return ret.release();
    }

    IntervalBtreeCursor::IntervalBtreeCursor( NamespaceDetails* namespaceDetails,
                                              const IndexDetails& indexDetails,
                                              const BSONObj& lowerBound,
                                              bool lowerBoundInclusive,
                                              const BSONObj& upperBound,
                                              bool upperBoundInclusive ) :
        _namespaceDetails( *namespaceDetails ),
        _indexNo( namespaceDetails->idxNo( indexDetails ) ),
        _indexDetails( indexDetails ),
        _ordering( Ordering::make( _indexDetails.keyPattern() ) ),
        _lowerBound( lowerBound ),
        _lowerBoundInclusive( lowerBoundInclusive ),
        _upperBound( upperBound ),
        _upperBoundInclusive( upperBoundInclusive ),
        _currRecoverable( _indexDetails, _ordering, _curr ),
        _nscanned(),
        _multikeyFlag() {
    }

    void IntervalBtreeCursor::init() {
        _multikeyFlag = _namespaceDetails.isMultikey( _indexNo );
        _curr = locateKey( _lowerBound, !_lowerBoundInclusive );
        skipUnused( &_curr );
        relocateEnd();
        if ( ok() ) {
            _nscanned = 1;
        }
    }

    bool IntervalBtreeCursor::ok() {
        return !_curr.bucket.isNull();
    }

    DiskLoc IntervalBtreeCursor::currLoc() {
        if ( eof() ) {
            return DiskLoc();
        }
        return _curr.bucket.btree<V1>()->keyNode( _curr.pos ).recordLoc;
    }

    bool IntervalBtreeCursor::advance() {
        RARELY killCurrentOp.checkForInterrupt();
        if ( eof() ) {
            return false;
        }
        // Advance _curr to the next key in the btree.
        _curr.bucket = _curr.bucket.btree<V1>()->advance( _curr.bucket,
                                                          _curr.pos,
                                                          1,
                                                          __FUNCTION__ );
        skipUnused( &_curr );
        if ( _curr == _end ) {
            // _curr has reached _end, so iteration is complete.
            _curr.bucket.Null();
        }
        else {
            ++_nscanned;
        }
        return ok();
    }

    BSONObj IntervalBtreeCursor::currKey() const {
        if ( _curr.bucket.isNull() ) {
            return BSONObj();
        }
        return _curr.bucket.btree<V1>()->keyNode( _curr.pos ).key.toBson();
    }

    void IntervalBtreeCursor::aboutToDeleteBucket( const DiskLoc& b ) {
        if ( b == _curr.bucket ) {
            _currRecoverable.invalidateInitialLocation();
        }
    }

    void IntervalBtreeCursor::noteLocation() {
        _currRecoverable = LogicalBtreePosition( _indexDetails, _ordering, _curr );
        _currRecoverable.init();
    }

    void IntervalBtreeCursor::checkLocation() {
        _multikeyFlag = _namespaceDetails.isMultikey( _indexNo );
        _curr = _currRecoverable.currentLocation();
        skipUnused( &_curr );
        relocateEnd();
    }

    bool IntervalBtreeCursor::getsetdup( DiskLoc loc ) {
        // TODO _multikeyFlag may be set part way through an iteration by checkLocation().  In this
        // case results returned earlier, when _multikeyFlag was false, will not be deduped.  This
        // is an old issue with all mongo btree cursor implementations.
        return _multikeyFlag && !_dups.insert( loc.asUint64() ).second;
    }

    BSONObj IntervalBtreeCursor::prettyIndexBounds() const {
        return BSON( "lower" << _lowerBound.replaceFieldNames( _indexDetails.keyPattern() ) <<
                     "upper" << _upperBound.replaceFieldNames( _indexDetails.keyPattern() ) );
    }

    BtreeKeyLocation IntervalBtreeCursor::locateKey( const BSONObj& key, bool afterKey ) {
        bool found;
        BtreeKeyLocation ret;

        // To find the first btree location equal to the specified key, specify a record location of
        // minDiskLoc, which is below any actual Record location.  To find the first btree location
        // greater than the specified key, specify a record location of maxDiskLoc, which is above
        // any actual Record location.
        DiskLoc targetRecord = afterKey ? maxDiskLoc : minDiskLoc;

        // Find the requested location in the btree.
        ret.bucket = _indexDetails.head.btree<V1>()->locate( _indexDetails,
                                                             _indexDetails.head,
                                                             key,
                                                             _ordering,
                                                             ret.pos,
                                                             found,
                                                             targetRecord,
                                                             1 );
        return ret;
    }

    void IntervalBtreeCursor::relocateEnd() {
        if ( eof() ) {
            return;
        }

        // If the current key is above the upper bound ...
        int32_t cmp = currKey().woCompare( _upperBound, _ordering, false );
        if ( cmp > 0 || ( cmp == 0 && !_upperBoundInclusive ) ) {

            // ... then iteration is complete.
            _curr.bucket.Null();
            return;
        }

        // Otherwise, relocate _end.
        _end = locateKey( _upperBound, _upperBoundInclusive );
        skipUnused( &_end );
    }

} // namespace mongo