summaryrefslogtreecommitdiff
path: root/src/mongo/db/structure/record_store_heap.h
blob: f9d752cbe84fb54ad32d56fd0dff3f2bf8cb8169 (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
// record_store_heap.h

/**
*    Copyright (C) 2014 MongoDB 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 <boost/shared_array.hpp>
#include <map>

#include "mongo/db/structure/capped_callback.h"
#include "mongo/db/structure/record_store.h"

namespace mongo {
    class HeapRecordIterator;

    /**
     * A RecordStore that stores all data on the heap.
     *
     * @param cappedMaxSize - required if isCapped. limit uses dataSize() in this impl.
     */
    class HeapRecordStore : public RecordStore {
    public:
        explicit HeapRecordStore(const StringData& ns,
                                 bool isCapped = false,
                                 int64_t cappedMaxSize = -1,
                                 int64_t cappedMaxDocs = -1,
                                 CappedDocumentDeleteCallback* cappedDeleteCallback = NULL);

        virtual const char* name() const;

        virtual Record* recordFor( const DiskLoc& loc ) const;

        virtual void deleteRecord( TransactionExperiment* txn, const DiskLoc& dl );

        virtual StatusWith<DiskLoc> insertRecord( TransactionExperiment* txn,
                                                  const char* data,
                                                  int len,
                                                  int quotaMax );

        virtual StatusWith<DiskLoc> insertRecord( TransactionExperiment* txn,
                                                  const DocWriter* doc,
                                                  int quotaMax );

        virtual RecordIterator* getIterator( const DiskLoc& start, bool tailable,
                                             const CollectionScanParams::Direction& dir) const;

        virtual RecordIterator* getIteratorForRepair() const;

        virtual std::vector<RecordIterator*> getManyIterators() const;

        virtual Status truncate( TransactionExperiment* txn );

        virtual bool compactSupported() const;
        virtual Status compact( TransactionExperiment* txn,
                                RecordStoreCompactAdaptor* adaptor,
                                const CompactOptions* options,
                                CompactStats* stats );

        virtual Status validate( TransactionExperiment* txn,
                                 bool full,
                                 bool scanData,
                                 ValidateAdaptor* adaptor,
                                 ValidateResults* results, BSONObjBuilder* output ) const;

        virtual Status touch( TransactionExperiment* txn, BSONObjBuilder* output ) const;

        virtual void increaseStorageSize( TransactionExperiment* txn,  int size, int quotaMax );

        virtual int64_t storageSize(BSONObjBuilder* extraInfo = NULL, int infoLevel = 0) const;

        virtual long long dataSize() const { return _dataSize; }

        virtual long long numRecords() const { return _records.size(); }

        //
        // Not in RecordStore interface
        //

        typedef std::map<DiskLoc, boost::shared_array<char> > Records;

        bool isCapped() const { return _isCapped; }
        bool cappedMaxDocs() const { invariant(_isCapped); return _cappedMaxDocs; }
        bool cappedMaxSize() const { invariant(_isCapped); return _cappedMaxSize; }

    private:
        DiskLoc allocateLoc();
        bool cappedAndNeedDelete() const;
        void cappedDeleteAsNeeded(TransactionExperiment* txn);

        // TODO figure out a proper solution to metadata
        const bool _isCapped;
        const int64_t _cappedMaxSize;
        const int64_t _cappedMaxDocs;
        CappedDocumentDeleteCallback* const _cappedDeleteCallback;
        int64_t _dataSize;

        Records _records;
        int64_t _nextId;
    };

    class HeapRecordIterator : public RecordIterator {
    public:
        HeapRecordIterator(const HeapRecordStore::Records& records,
                           const HeapRecordStore& rs,
                           DiskLoc start = DiskLoc(),
                           bool tailable = false);

        virtual bool isEOF();

        virtual DiskLoc curr();

        virtual DiskLoc getNext();

        virtual void invalidate(const DiskLoc& dl);

        virtual void prepareToYield();

        virtual bool recoverFromYield();

        virtual const Record* recordFor( const DiskLoc& loc ) const;

    private:
        HeapRecordStore::Records::const_iterator _it;
        bool _tailable;
        DiskLoc _lastLoc; // only for restarting tailable
        bool _killedByInvalidate;

        const HeapRecordStore::Records& _records;
        const HeapRecordStore& _rs;
    };

    class HeapRecordReverseIterator : public RecordIterator {
    public:
        HeapRecordReverseIterator(const HeapRecordStore::Records& records,
                                  const HeapRecordStore& rs,
                                  DiskLoc start = DiskLoc());

        virtual bool isEOF();

        virtual DiskLoc curr();

        virtual DiskLoc getNext();

        virtual void invalidate(const DiskLoc& dl);

        virtual void prepareToYield();

        virtual bool recoverFromYield();

        virtual const Record* recordFor( const DiskLoc& loc ) const;

    private:
        HeapRecordStore::Records::const_reverse_iterator _it;
        bool _killedByInvalidate;

        const HeapRecordStore::Records& _records;
        const HeapRecordStore& _rs;
    };

} // namespace mongo