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
|
/**
* 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/btree.h"
#include "mongo/db/diskloc.h"
#include "mongo/db/jsobj.h"
namespace mongo {
/**
* We have two Btree on-disk formats which support identical operations. We hide this as much
* as possible by having one implementation of this interface per format.
*
* For documentation on all of the methods here, look at mongo/db/btree.h
*/
class BtreeInterface {
public:
virtual ~BtreeInterface() { }
static BtreeInterface *interfaces[];
// This is the # of the exception that is thrown if we're trying to access a bucket that
// was deleted. Calling code needs to be able to recognize this and possibly ignore it.
static const int deletedBucketCode = 16738;
virtual int bt_insert(const DiskLoc thisLoc,
const DiskLoc recordLoc,
const BSONObj& key,
const Ordering &order,
bool dupsAllowed,
IndexDetails& idx,
bool toplevel = true) const = 0;
virtual bool unindex(const DiskLoc thisLoc,
IndexDetails& id,
const BSONObj& key,
const DiskLoc recordLoc) const = 0;
virtual DiskLoc locate(const IndexDetails& idx,
const DiskLoc& thisLoc,
const BSONObj& key,
const Ordering& order,
int& pos,
bool& found,
const DiskLoc& recordLoc,
int direction = 1) const = 0;
virtual bool wouldCreateDup(const IndexDetails& idx,
const DiskLoc& thisLoc,
const BSONObj& key,
const Ordering& order,
const DiskLoc& self) const = 0;
virtual void customLocate(DiskLoc& locInOut,
int& keyOfs,
const BSONObj& keyBegin,
int keyBeginLen, bool afterKey,
const vector<const BSONElement*>& keyEnd,
const vector<bool>& keyEndInclusive,
const Ordering& order,
int direction,
pair<DiskLoc, int>& bestParent) = 0 ;
virtual void advanceTo(DiskLoc &thisLoc,
int &keyOfs,
const BSONObj &keyBegin,
int keyBeginLen,
bool afterKey,
const vector<const BSONElement*>& keyEnd,
const vector<bool>& keyEndInclusive,
const Ordering& order, int direction) const = 0;
virtual string dupKeyError(DiskLoc bucket,
const IndexDetails &idx,
const BSONObj& keyObj) const =0;
virtual DiskLoc advance(const DiskLoc& thisLoc,
int& keyOfs,
int direction,
const char* caller) const = 0;
virtual long long fullValidate(const DiskLoc& thisLoc, const BSONObj& keyPattern) = 0;
/**
* These methods are here so that the BtreeCursor doesn't need to do any templating for the
* two on-disk formats.
*/
/**
* Is the key at (bucket, keyOffset) being used or not?
* Some keys are marked as not used and skipped.
*/
virtual bool keyIsUsed(DiskLoc bucket, int keyOffset) const = 0;
/**
* Get the BSON representation of the key at (bucket, keyOffset).
*/
virtual BSONObj keyAt(DiskLoc bucket, int keyOffset) const = 0;
/**
* Get the DiskLoc that the key at (bucket, keyOffset) points at.
*/
virtual DiskLoc recordAt(DiskLoc bucket, int keyOffset) const = 0;
/**
* keyAt and recordAt at the same time.
*/
virtual void keyAndRecordAt(DiskLoc bucket, int keyOffset, BSONObj* keyOut,
DiskLoc* recordOut) const = 0;
};
} // namespace mongo
|
