summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage/mmap_v1/record_store_v1_capped.h
blob: d74fc7c65ea3ee08c322ac118b365bcc724b0441 (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
// record_store_v1_capped.h

/**
*    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/base/owned_pointer_vector.h"
#include "mongo/db/storage/capped_callback.h"
#include "mongo/db/storage/mmap_v1/diskloc.h"
#include "mongo/db/storage/mmap_v1/extent_manager.h"
#include "mongo/db/storage/mmap_v1/record_store_v1_base.h"

namespace mongo {

class CappedRecordStoreV1 final : public RecordStoreV1Base {
public:
    CappedRecordStoreV1(OperationContext* opCtx,
                        CappedCallback* collection,
                        StringData ns,
                        RecordStoreV1MetaData* details,
                        ExtentManager* em,
                        bool isSystemIndexes);

    ~CappedRecordStoreV1() final;

    const char* name() const final {
        return "CappedRecordStoreV1";
    }

    Status truncate(OperationContext* opCtx) final;

    /**
     * Truncate documents newer than the document at 'end' from the capped
     * collection.  The collection cannot be completely emptied using this
     * function.  An assertion will be thrown if that is attempted.
     * @param inclusive - Truncate 'end' as well iff true
     */
    void cappedTruncateAfter(OperationContext* opCtx, RecordId end, bool inclusive) final;

    std::unique_ptr<SeekableRecordCursor> getCursor(OperationContext* opCtx,
                                                    bool forward) const final;

    std::vector<std::unique_ptr<RecordCursor>> getManyCursors(OperationContext* opCtx) const final;

    // Start from firstExtent by default.
    DiskLoc firstRecord(OperationContext* opCtx, const DiskLoc& startExtent = DiskLoc()) const;
    // Start from lastExtent by default.
    DiskLoc lastRecord(OperationContext* opCtx, const DiskLoc& startExtent = DiskLoc()) const;

protected:
    bool isCapped() const final {
        return true;
    }
    bool shouldPadInserts() const final {
        return false;
    }

    void setCappedCallback(CappedCallback* cb) final {
        _cappedCallback = cb;
    }

    StatusWith<DiskLoc> allocRecord(OperationContext* opCtx,
                                    int lengthWithHeaders,
                                    bool enforceQuota) final;

    void addDeletedRec(OperationContext* opCtx, const DiskLoc& dloc) final;

private:
    // -- start copy from cap.cpp --
    void _compact(OperationContext* opCtx);
    DiskLoc cappedFirstDeletedInCurExtent() const;
    void setFirstDeletedInCurExtent(OperationContext* opCtx, const DiskLoc& loc);
    void cappedCheckMigrate(OperationContext* opCtx);
    DiskLoc __capAlloc(OperationContext* opCtx, int len);
    bool inCapExtent(const DiskLoc& dl) const;
    DiskLoc cappedListOfAllDeletedRecords() const;
    DiskLoc cappedLastDelRecLastExtent() const;
    void setListOfAllDeletedRecords(OperationContext* opCtx, const DiskLoc& loc);
    void setLastDelRecLastExtent(OperationContext* opCtx, const DiskLoc& loc);
    Extent* theCapExtent() const;
    bool nextIsInCapExtent(const DiskLoc& dl) const;
    void advanceCapExtent(OperationContext* opCtx, StringData ns);
    void cappedTruncateLastDelUpdate(OperationContext* opCtx);

    /**
     * Truncate documents newer than the document at 'end' from the capped
     * collection.  The collection cannot be completely emptied using this
     * function.  An assertion will be thrown if that is attempted.
     * @param inclusive - Truncate 'end' as well iff true
     */
    void cappedTruncateAfter(OperationContext* opCtx, const char* ns, DiskLoc end, bool inclusive);

    void _maybeComplain(OperationContext* opCtx, int len) const;

    // -- end copy from cap.cpp --

    CappedCallback* _cappedCallback;

    OwnedPointerVector<ExtentManager::CacheHint> _extentAdvice;

    friend class CappedRecordStoreV1Iterator;
};
}