kv_catalog_feature_tracker.h

Go to the documentation of this file.

#pragma once

#include <cstdint>
#include <memory>
#include <type_traits>

#include "mongo/db/storage/kv/kv_catalog.h"

namespace mongo {

class OperationContext;
class RecordId;
class RecordStore;

class KVCatalog::FeatureTracker {
public:
    enum class NonRepairableFeature : std::uint64_t {
        kCollation = 1 << 0,
        kNextFeatureBit = 1 << 1
    };

    using NonRepairableFeatureMask = std::underlying_type<NonRepairableFeature>::type;

    enum class RepairableFeature : std::uint64_t {
        kPathLevelMultikeyTracking = 1 << 0,
        kNextFeatureBit = 1 << 1
    };

    using RepairableFeatureMask = std::underlying_type<RepairableFeature>::type;

    static bool isFeatureDocument(BSONObj obj);

    static std::unique_ptr<FeatureTracker> get(OperationContext* opCtx,
                                               KVCatalog* catalog,
                                               RecordId rid);

    static std::unique_ptr<FeatureTracker> create(OperationContext* opCtx, KVCatalog* catalog);

    Status isCompatibleWithCurrentCode(OperationContext* opCtx) const;

    bool isNonRepairableFeatureInUse(OperationContext* opCtx, NonRepairableFeature feature) const;

    void markNonRepairableFeatureAsInUse(OperationContext* opCtx, NonRepairableFeature feature);

    void markNonRepairableFeatureAsNotInUse(OperationContext* opCtx, NonRepairableFeature feature);

    bool isRepairableFeatureInUse(OperationContext* opCtx, RepairableFeature feature) const;

    void markRepairableFeatureAsInUse(OperationContext* opCtx, RepairableFeature feature);

    void markRepairableFeatureAsNotInUse(OperationContext* opCtx, RepairableFeature feature);

    void setUsedNonRepairableFeaturesMaskForTestingOnly(NonRepairableFeatureMask mask) {
        _usedNonRepairableFeaturesMask = mask;
    }

    void setUsedRepairableFeaturesMaskForTestingOnly(RepairableFeatureMask mask) {
        _usedRepairableFeaturesMask = mask;
    }

    struct FeatureBits {
        NonRepairableFeatureMask nonRepairableFeatures;
        RepairableFeatureMask repairableFeatures;
    };

    FeatureBits getInfo(OperationContext* opCtx) const;

    void putInfo(OperationContext* opCtx, const FeatureBits& versionInfo);

private:
    // Must go through FeatureTracker::get() or FeatureTracker::create().
    FeatureTracker(KVCatalog* catalog, RecordId rid) : _catalog(catalog), _rid(rid) {}

    KVCatalog* _catalog;
    RecordId _rid;

    NonRepairableFeatureMask _usedNonRepairableFeaturesMask =
        static_cast<NonRepairableFeatureMask>(NonRepairableFeature::kNextFeatureBit) - 1;

    RepairableFeatureMask _usedRepairableFeaturesMask =
        static_cast<RepairableFeatureMask>(RepairableFeature::kNextFeatureBit) - 1;
};

}  // namespace mongo