summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage/mmap_v1/record_store_v1_test_help.h
blob: 352c91efd16528ef0f0994e78a89cd5130d55efb (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
// record_store_v1_test_help.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 <vector>

#include "mongo/db/storage/mmap_v1/extent_manager.h"
#include "mongo/db/storage/mmap_v1/record_store_v1_base.h"

namespace mongo {

    class DummyRecordStoreV1MetaData : public RecordStoreV1MetaData {
    public:
        DummyRecordStoreV1MetaData( bool capped, int userFlags );
        virtual ~DummyRecordStoreV1MetaData(){}

        virtual const DiskLoc& capExtent() const;
        virtual void setCapExtent( OperationContext* txn, const DiskLoc& loc );

        virtual const DiskLoc& capFirstNewRecord() const;
        virtual void setCapFirstNewRecord( OperationContext* txn, const DiskLoc& loc );

        virtual long long dataSize() const;
        virtual long long numRecords() const;

        virtual void incrementStats( OperationContext* txn,
                                     long long dataSizeIncrement,
                                     long long numRecordsIncrement );

        virtual void setStats( OperationContext* txn,
                               long long dataSize,
                               long long numRecords );

        virtual const DiskLoc& deletedListEntry( int bucket ) const;
        virtual void setDeletedListEntry( OperationContext* txn,
                                          int bucket,
                                          const DiskLoc& loc );
        virtual void orphanDeletedList(OperationContext* txn);

        virtual const DiskLoc& firstExtent( OperationContext* txn ) const;
        virtual void setFirstExtent( OperationContext* txn, const DiskLoc& loc );

        virtual const DiskLoc& lastExtent( OperationContext* txn ) const;
        virtual void setLastExtent( OperationContext* txn, const DiskLoc& loc );

        virtual bool isCapped() const;

        virtual bool isUserFlagSet( int flag ) const;
        virtual int userFlags() const { return _userFlags; }
        virtual bool setUserFlag( OperationContext* txn, int flag );
        virtual bool clearUserFlag( OperationContext* txn, int flag );
        virtual bool replaceUserFlags( OperationContext* txn, int flags );


        virtual int lastExtentSize( OperationContext* txn ) const;
        virtual void setLastExtentSize( OperationContext* txn, int newMax );

        virtual long long maxCappedDocs() const;

    protected:

        DiskLoc _capExtent;
        DiskLoc _capFirstNewRecord;

        long long _dataSize;
        long long _numRecords;

        DiskLoc _firstExtent;
        DiskLoc _lastExtent;

        bool _capped;
        int _userFlags;
        long long _maxCappedDocs;

        int _lastExtentSize;
        double _paddingFactor;

        std::vector<DiskLoc> _deletedLists;
    };

    class DummyExtentManager : public ExtentManager {
    public:
        virtual ~DummyExtentManager();

        virtual Status init(OperationContext* txn);

        virtual int numFiles() const;
        virtual long long fileSize() const;

        virtual DiskLoc allocateExtent( OperationContext* txn,
                                        bool capped,
                                        int size,
                                        bool enforceQuota );

        virtual void freeExtents( OperationContext* txn,
                                  DiskLoc firstExt, DiskLoc lastExt );

        virtual void freeExtent( OperationContext* txn, DiskLoc extent );

        virtual void freeListStats(OperationContext* txn,
                                   int* numExtents,
                                   int64_t* totalFreeSizeBytes) const;

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

        virtual Extent* extentForV1( const DiskLoc& loc ) const;

        virtual DiskLoc extentLocForV1( const DiskLoc& loc ) const;

        virtual Extent* getExtent( const DiskLoc& loc, bool doSanityCheck = true ) const;

        virtual int maxSize() const;

        virtual CacheHint* cacheHint( const DiskLoc& extentLoc, const HintType& hint );

    protected:
        struct ExtentInfo {
            char* data;
            size_t length;
        };

        std::vector<ExtentInfo> _extents;
    };
    
    struct LocAndSize {
        DiskLoc loc;
        int size; // with headers
    };

    /**
     * Creates a V1 storage/mmap_v1 with the passed in records and DeletedRecords (drecs).
     *
     * List of LocAndSize are terminated by a Null DiskLoc. Passing a NULL pointer is shorthand for
     * an empty list. Each extent gets it's own DiskLoc file number. DiskLoc Offsets must be > 1000.
     *
     * records must be sorted by extent/file. offsets within an extent can be in any order.
     *
     * In a simple RS, drecs must be grouped into size-buckets, but the ordering within the size
     * buckets is up to you.
     *
     * In a capped collection, all drecs form a single list and must be grouped by extent, with each
     * extent having at least one drec. capFirstNewRecord() and capExtent() *must* be correctly set
     * on md before calling.
     *
     * You are responsible for ensuring the records and drecs don't overlap.
     *
     * ExtentManager and MetaData must both be empty.
     */
    void initializeV1RS(OperationContext* txn,
                        const LocAndSize* records,
                        const LocAndSize* drecs,
                        DummyExtentManager* em,
                        DummyRecordStoreV1MetaData* md);

    /**
     * Asserts that the V1RecordStore defined by md has the passed in records and drecs in the
     * correct order.
     *
     * List of LocAndSize are terminated by a Null DiskLoc. Passing a NULL pointer means don't check
     * that list.
     */
    void assertStateV1RS(OperationContext* txn,
                         const LocAndSize* records,
                         const LocAndSize* drecs,
                         const ExtentManager* em,
                         const DummyRecordStoreV1MetaData* md);

}  // namespace mongo