record_store_v1_capped.h

Go to the documentation of this file.

// record_store_v1_capped.h

#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;

    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);

    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;
};
}