cloud/blockstore/libs/storage/api/volume.h - main - githubmirror/nbs

cloud/blockstore/libs/storage/api/volume.h
485 строк15 KB
yegorskii
new private api call to query blob index for ydb based volumes (#6162)
16 июн 2026, 18:23
16 июн 2026, 18:23f87d4f6
#pragma once

#include "public.h"

#include <cloud/blockstore/libs/common/block_range.h>
#include <cloud/blockstore/libs/kikimr/components.h>
#include <cloud/blockstore/libs/kikimr/events.h>
#include <cloud/blockstore/libs/storage/core/disk_counters.h>
#include <cloud/blockstore/libs/storage/protos/volume.pb.h>
#include <cloud/blockstore/libs/storage/protos_ydb/volume.pb.h>
#include <cloud/blockstore/public/api/protos/volume.pb.h>

namespace NCloud::NBlockStore::NStorage {

////////////////////////////////////////////////////////////////////////////////

// clang-format off

#define BLOCKSTORE_VOLUME_REQUESTS(xxx, ...)                                   \
    xxx(AddClient,                                                 __VA_ARGS__)\
    xxx(RemoveClient,                                              __VA_ARGS__)\
    xxx(WaitReady,                                                 __VA_ARGS__)\
    xxx(DescribeBlocks,                                            __VA_ARGS__)\
    xxx(DescribeBlob,                                              __VA_ARGS__)\
    xxx(GetPartitionInfo,                                          __VA_ARGS__)\
    xxx(CompactRange,                                              __VA_ARGS__)\
    xxx(GetCompactionStatus,                                       __VA_ARGS__)\
    xxx(ReallocateDisk,                                            __VA_ARGS__)\
    xxx(GetVolumeLoadInfo,                                         __VA_ARGS__)\
    xxx(GetUsedBlocks,                                             __VA_ARGS__)\
    xxx(DeleteCheckpointData,                                      __VA_ARGS__)\
    xxx(UpdateUsedBlocks,                                          __VA_ARGS__)\
    xxx(RebuildMetadata,                                           __VA_ARGS__)\
    xxx(GetRebuildMetadataStatus,                                  __VA_ARGS__)\
    xxx(ScanDisk,                                                  __VA_ARGS__)\
    xxx(GetScanDiskStatus,                                         __VA_ARGS__)\
    xxx(GetVolumeInfo,                                             __VA_ARGS__)\
    xxx(UpdateVolumeParams,                                        __VA_ARGS__)\
    xxx(ChangeStorageConfig,                                       __VA_ARGS__)\
    xxx(GetStorageConfig,                                          __VA_ARGS__)\
    xxx(GracefulShutdown,                                          __VA_ARGS__)\
    xxx(LinkLeaderVolumeToFollower,                                __VA_ARGS__)\
    xxx(UnlinkLeaderVolumeFromFollower,                            __VA_ARGS__)\
    xxx(UpdateLinkOnFollower,                                      __VA_ARGS__)\
    xxx(GetLinkStatus,                                             __VA_ARGS__)\
    xxx(CheckRange,                                                __VA_ARGS__)\

// BLOCKSTORE_VOLUME_REQUESTS

// requests forwarded from service to volume
#define BLOCKSTORE_VOLUME_REQUESTS_FWD_SERVICE(xxx, ...)                       \
    xxx(ReadBlocks,           __VA_ARGS__)                                     \
    xxx(WriteBlocks,          __VA_ARGS__)                                     \
    xxx(ZeroBlocks,           __VA_ARGS__)                                     \
    xxx(StatVolume,           __VA_ARGS__)                                     \
    xxx(CreateCheckpoint,     __VA_ARGS__)                                     \
    xxx(DeleteCheckpoint,     __VA_ARGS__)                                     \
    xxx(GetChangedBlocks,     __VA_ARGS__)                                     \
    xxx(GetCheckpointStatus,  __VA_ARGS__)                                     \
    xxx(ReadBlocksLocal,      __VA_ARGS__)                                     \
    xxx(WriteBlocksLocal,     __VA_ARGS__)                                     \
// BLOCKSTORE_VOLUME_REQUESTS_FWD_SERVICE

// responses which are forwarded back via volume (volume has handlers for these)
#define BLOCKSTORE_VOLUME_HANDLED_RESPONSES(xxx, ...)                          \
    xxx(DescribeBlocks,           __VA_ARGS__)                                 \
    xxx(DescribeBlob,             __VA_ARGS__)                                 \
    xxx(GetPartitionInfo,         __VA_ARGS__)                                 \
    xxx(CompactRange,             __VA_ARGS__)                                 \
    xxx(GetCompactionStatus,      __VA_ARGS__)                                 \
    xxx(GetUsedBlocks,            __VA_ARGS__)                                 \
    xxx(DeleteCheckpointData,     __VA_ARGS__)                                 \
    xxx(RebuildMetadata,          __VA_ARGS__)                                 \
    xxx(GetRebuildMetadataStatus, __VA_ARGS__)                                 \
    xxx(ScanDisk,                 __VA_ARGS__)                                 \
    xxx(GetScanDiskStatus,        __VA_ARGS__)                                 \
    xxx(CheckRange,               __VA_ARGS__)                                 \
// BLOCKSTORE_VOLUME_HANDLED_RESPONSES

// responses for the requests forwarded from service which are forwarded back
// via volume (volume has handlers for these)
#define BLOCKSTORE_VOLUME_HANDLED_RESPONSES_FWD_SERVICE(xxx, ...)              \
    xxx(ReadBlocks,           __VA_ARGS__)                                     \
    xxx(WriteBlocks,          __VA_ARGS__)                                     \
    xxx(ZeroBlocks,           __VA_ARGS__)                                     \
    xxx(CreateCheckpoint,     __VA_ARGS__)                                     \
    xxx(DeleteCheckpoint,     __VA_ARGS__)                                     \
    xxx(GetChangedBlocks,     __VA_ARGS__)                                     \
    xxx(GetCheckpointStatus,  __VA_ARGS__)                                     \
    xxx(ReadBlocksLocal,      __VA_ARGS__)                                     \
    xxx(WriteBlocksLocal,     __VA_ARGS__)                                     \
// BLOCKSTORE_VOLUME_HANDLED_RESPONSES_FWD_SERVICE

// clang-format on

////////////////////////////////////////////////////////////////////////////////

struct TEvVolume
{
    //
    // ReacquireDisk
    //

    struct TReacquireDisk
    {
    };

    //
    // UpdateMigrationState
    //

    struct TUpdateMigrationState
    {
        ui64 MigrationIndex;
        ui64 BlockCountToMigrate;

        TUpdateMigrationState(
                ui64 migrationIndex,
                ui64 blockCountToMigrate)
            : MigrationIndex(migrationIndex)
            , BlockCountToMigrate(blockCountToMigrate)
        {}
    };

    //
    // MigrationStateUpdated
    //

    struct TMigrationStateUpdated
    {
    };

    //
    // RWClientIdChanged
    //

    struct TRWClientIdChanged
    {
        TString RWClientId;

        TRWClientIdChanged(TString rwClientId)
            : RWClientId(std::move(rwClientId))
        {
        }
    };

    //
    // DiskRegistryBasedPartitionCounters
    //

    struct TDiskRegistryBasedPartitionCounters
    {
        TString DiskId;
        TPartNonreplCountersData CountersData;

        TDiskRegistryBasedPartitionCounters(
                TString diskId,
                TPartNonreplCountersData countersData)
            : DiskId(std::move(diskId))
            , CountersData(std::move(countersData))
        {}
    };

    //
    // RdmaUnavailable
    //

    struct TRdmaUnavailable
    {
    };

    //
    // UpdateResyncState
    //

    struct TUpdateResyncState
    {
        ui64 ResyncIndex;

        TUpdateResyncState(ui64 resyncIndex)
            : ResyncIndex(resyncIndex)
        {
        }
    };

    //
    // ResyncStateUpdated
    //

    struct TResyncStateUpdated
    {
    };

    //
    // ResyncFinished
    //

    struct TResyncFinished
    {
    };

    //
    // MapBaseDiskIdToTabletId
    //
    struct TMapBaseDiskIdToTabletId
    {
        const TString BaseDiskId;
        const ui64 BaseTabletId;

        TMapBaseDiskIdToTabletId(TString baseDiskId, ui64 baseTabletId)
            : BaseDiskId(std::move(baseDiskId))
            , BaseTabletId(baseTabletId)
        {}
    };

    //
    // ClearBaseDiskIdToTabletIdMapping
    //
    struct TClearBaseDiskIdToTabletIdMapping
    {
        const TString BaseDiskId;

        explicit TClearBaseDiskIdToTabletIdMapping(TString baseDiskId)
            : BaseDiskId(std::move(baseDiskId))
        {}
    };

    //
    // PreparePartitionMigrationRequest
    //
    struct TPreparePartitionMigrationRequest
    {
    };

    //
    // PreparePartitionMigrationResponse
    //
    struct TPreparePartitionMigrationResponse
    {
        bool IsMigrationAllowed;

        explicit TPreparePartitionMigrationResponse(bool isMigrationAllowed)
            : IsMigrationAllowed(isMigrationAllowed)
        {}
    };

    //
    // DiskRegistryBasedPartitionCounters
    //

    struct TScrubberCounters
    {
        bool Running = false;
        TBlockRange64 CurrentRange;
        TBlockRangeSet64 Minors;
        TBlockRangeSet64 Majors;
        TBlockRangeSet64 Fixed;
        TBlockRangeSet64 FixedPartial;

        TScrubberCounters(
                bool running,
                TBlockRange64 currentRange,
                TBlockRangeSet64 minors,
                TBlockRangeSet64 majors,
                TBlockRangeSet64 fixed,
                TBlockRangeSet64 fixedPartial)
            : Running(running)
            , CurrentRange(currentRange)
            , Minors(std::move(minors))
            , Majors(std::move(majors))
            , Fixed(std::move(fixed))
            , FixedPartial(std::move(fixedPartial))
        {}
    };

    //
    // RetryAcquireReleaseDisk
    //

    struct TRetryAcquireReleaseDisk
    {
    };

    //
    // Events declaration
    //

    enum EEvents
    {
        EvBegin = TBlockStoreEvents::VOLUME_START,

        EvAddClientRequest = EvBegin + 5,
        EvAddClientResponse = EvBegin + 6,

        EvRemoveClientRequest = EvBegin + 7,
        EvRemoveClientResponse = EvBegin + 8,

        EvWaitReadyRequest = EvBegin + 9,
        EvWaitReadyResponse = EvBegin + 10,

        EvDescribeBlocksRequest = EvBegin + 11,
        EvDescribeBlocksResponse = EvBegin + 12,

        EvGetPartitionInfoRequest = EvBegin + 13,
        EvGetPartitionInfoResponse = EvBegin + 14,

        EvCompactRangeRequest = EvBegin + 15,
        EvCompactRangeResponse = EvBegin + 16,

        EvGetCompactionStatusRequest = EvBegin + 17,
        EvGetCompactionStatusResponse = EvBegin + 18,

        EvReacquireDisk = EvBegin + 19,

        EvReallocateDiskRequest = EvBegin + 20,
        EvReallocateDiskResponse = EvBegin + 21,

        EvGetVolumeLoadInfoRequest = EvBegin + 22,
        EvGetVolumeLoadInfoResponse = EvBegin + 23,

        EvGetUsedBlocksRequest = EvBegin + 24,
        EvGetUsedBlocksResponse = EvBegin + 25,

        EvDeleteCheckpointDataRequest = EvBegin + 26,
        EvDeleteCheckpointDataResponse = EvBegin + 27,

        EvUpdateUsedBlocksRequest = EvBegin + 28,
        EvUpdateUsedBlocksResponse = EvBegin + 29,

        EvUpdateMigrationState = EvBegin + 30,
        EvMigrationStateUpdated = EvBegin + 31,

        EvRWClientIdChanged = EvBegin + 32,

        EvDiskRegistryBasedPartitionCounters = EvBegin + 33,

        EvRebuildMetadataRequest = EvBegin + 34,
        EvRebuildMetadataResponse = EvBegin + 35,

        EvGetRebuildMetadataStatusRequest = EvBegin + 36,
        EvGetRebuildMetadataStatusResponse = EvBegin + 37,

        EvRdmaUnavailable = EvBegin + 38,

        EvUpdateResyncState = EvBegin + 39,
        EvResyncStateUpdated = EvBegin + 40,

        EvScanDiskRequest = EvBegin + 41,
        EvScanDiskResponse = EvBegin + 42,

        EvGetScanDiskStatusRequest = EvBegin + 43,
        EvGetScanDiskStatusResponse = EvBegin + 44,

        EvResyncFinished = EvBegin + 45,

        EvGetVolumeInfoRequest = EvBegin + 46,
        EvGetVolumeInfoResponse = EvBegin + 47,

        EvMapBaseDiskIdToTabletId = EvBegin + 48,

        EvSetupChannelsRequest = EvBegin + 49,
        EvSetupChannelsResponse = EvBegin + 50,

        EvClearBaseDiskIdToTabletIdMapping = EvBegin + 51,

        EvUpdateVolumeParamsRequest = EvBegin + 52,
        EvUpdateVolumeParamsResponse = EvBegin + 53,

        EvChangeStorageConfigRequest = EvBegin + 54,
        EvChangeStorageConfigResponse = EvBegin + 55,

        EvPreparePartitionMigrationRequest = EvBegin + 56,
        EvPreparePartitionMigrationResponse = EvBegin + 57,

        EvGetStorageConfigRequest = EvBegin + 58,
        EvGetStorageConfigResponse = EvBegin + 59,

        EvGracefulShutdownRequest = EvBegin + 60,
        EvGracefulShutdownResponse = EvBegin + 61,

        EvCheckRangeRequest = EvBegin + 62,
        EvCheckRangeResponse = EvBegin + 63,

        EvLinkLeaderVolumeToFollowerRequest = EvBegin + 64,
        EvLinkLeaderVolumeToFollowerResponse = EvBegin + 65,

        EvUnlinkLeaderVolumeFromFollowerRequest = EvBegin + 66,
        EvUnlinkLeaderVolumeFromFollowerResponse = EvBegin + 67,

        EvScrubberCounters = EvBegin + 68,

        EvUpdateLinkOnFollowerRequest = EvBegin + 69,
        EvUpdateLinkOnFollowerResponse = EvBegin + 70,

        EvRetryAcquireReleaseDisk = EvBegin + 71,

        EvGetLinkStatusRequest = EvBegin + 72,
        EvGetLinkStatusResponse = EvBegin + 73,

        EvDescribeBlobRequest = EvBegin + 74,
        EvDescribeBlobResponse = EvBegin + 75,

        EvEnd
    };

    static_assert(EvEnd < (int)TBlockStoreEvents::VOLUME_END,
        "EvEnd expected to be < TBlockStoreEvents::VOLUME_END");

    BLOCKSTORE_VOLUME_REQUESTS(BLOCKSTORE_DECLARE_PROTO_EVENTS)

    using TEvReacquireDisk = TRequestEvent<
        TReacquireDisk,
        EvReacquireDisk
    >;

    using TEvUpdateMigrationState = TRequestEvent<
        TUpdateMigrationState,
        EvUpdateMigrationState
    >;

    using TEvMigrationStateUpdated = TRequestEvent<
        TMigrationStateUpdated,
        EvMigrationStateUpdated
    >;

    using TEvRWClientIdChanged = TRequestEvent<
        TRWClientIdChanged,
        EvRWClientIdChanged
    >;

    using TEvDiskRegistryBasedPartitionCounters = TRequestEvent<
        TDiskRegistryBasedPartitionCounters,
        EvDiskRegistryBasedPartitionCounters
    >;

    using TEvRdmaUnavailable = TRequestEvent<
        TRdmaUnavailable,
        EvRdmaUnavailable
    >;

    using TEvUpdateResyncState = TRequestEvent<
        TUpdateResyncState,
        EvUpdateResyncState
    >;

    using TEvResyncStateUpdated = TRequestEvent<
        TResyncStateUpdated,
        EvResyncStateUpdated
    >;

    using TEvResyncFinished = TRequestEvent<
        TResyncFinished,
        EvResyncFinished
    >;

    using TEvMapBaseDiskIdToTabletId = TRequestEvent<
        TMapBaseDiskIdToTabletId,
        EvMapBaseDiskIdToTabletId
    >;

    using TEvClearBaseDiskIdToTabletIdMapping = TRequestEvent<
        TClearBaseDiskIdToTabletIdMapping,
        EvClearBaseDiskIdToTabletIdMapping
    >;

    using TEvPreparePartitionMigrationRequest = TRequestEvent<
        TPreparePartitionMigrationRequest,
        EvPreparePartitionMigrationRequest
    >;

    using TEvPreparePartitionMigrationResponse = TRequestEvent<
        TPreparePartitionMigrationResponse,
        EvPreparePartitionMigrationResponse
    >;

    using TEvScrubberCounters =
        TRequestEvent<TScrubberCounters,
        EvScrubberCounters
    >;

    using TEvRetryAcquireReleaseDisk =
        TRequestEvent<TRetryAcquireReleaseDisk, EvRetryAcquireReleaseDisk>;
};

}   // namespace NCloud::NBlockStore::NStorage