0
代码
代码
Issues
Pull Requests
讨论
Wiki
分析
0
Yyrewzjsxupdate installation doc
c9b9bd4d创建于 22 天前历史提交

MemCache API

C++接口列表

C++语言接口功能齐全，基于面向对象设计，提供统一的 ObjectStore 抽象基类，封装了实例管理、缓冲区注册、数据操作、批量处理及分层张量等功能。

1. 实例创建与生命周期管理接口

local_config

local_config 是 Setup 接口使用的本地配置类型，定义位于 src/memcache/include/mmc.h。

说明:

  • 建议先通过 create_default_local_config() 获取带默认值的配置对象，再按需覆盖字段

常用字段:

  • meta_service_url: 元服务地址
  • config_store_url: 配置存储服务地址
  • log_level: 日志级别，如 debug、info、warn、error
  • world_size: 最大 rank 数
  • protocol: 数据传输协议，如 host_rdma、host_urma、host_tcp、device_rdma、device_sdma
  • hcom_url: HCOM 服务地址
  • dram_size / hbm_size: 本地服务 DRAM / HBM 容量
  • max_dram_size / max_hbm_size: 所有本地进程可使用的 DRAM / HBM 总上限。

create_default_local_config

local_config create_default_local_config();

功能: 创建一个带内置默认值的 local_config 对象，便于用户只覆盖必要配置项。

返回值:

  • 返回默认初始化后的 local_config

ObjectStore::CreateObjectStore

static std::shared_ptr<ObjectStore> CreateObjectStore();

功能: 创建一个分布式内存缓存存储实例。

返回值:

  • 返回 std::shared_ptr 管理的智能指针，确保资源自动释放，非空 shared_ptr 表示成功。

Setup

virtual int Setup(const local_config &config) = 0;

功能: 初始化并校验本地配置，供后续 Init 使用。

参数:

  • config: 本地配置（local_config）

返回值:

  • 0：成功
  • 其他：失败

推荐调用顺序:

auto store = ock::mmc::ObjectStore::CreateObjectStore();
local_config config = create_default_local_config();

// 可按需覆盖默认配置，或仅设置 config_path 指向配置文件
int ret = store->Setup(config);
if (ret != 0) {
    return ret;
}

ret = store->Init(0, true);
if (ret != 0) {
    return ret;
}

Init

virtual int Init(const uint32_t deviceId, bool initBm = true) = 0;

功能: 初始化当前存储实例，绑定到指定设备。

参数:

  • deviceId: 目标设备ID
  • initBm: 是否初始化BM提供内存，默认值为 true。设 false 时将启动纯client模式，不支持数据读写操作

返回值:

  • 0：成功
  • 其他：失败

TearDown

virtual int TearDown() = 0;

功能: 释放当前实例占用的所有资源，断开与元服务和本地服务的连接。

返回值:

  • 0：成功
  • 其他：失败

2. 缓冲区注册接口

RegisterBuffer

virtual int RegisterBuffer(void *buffer, size_t size) = 0;

功能: 将用户分配的内存区域注册到系统中，以启用 RDMA 或零拷贝传输。

参数:

  • buffer: 内存起始地址
  • size: 缓冲区字节大小

返回值:

  • 0：成功
  • 其他：失败

UnRegisterBuffer

virtual int UnRegisterBuffer(void *buffer, size_t size) = 0;

功能: 注销已注册的内存区域。

参数:

  • buffer: 内存起始地址
  • size: 缓冲区字节大小

返回值:

  • 0: 成功
  • 其他: 失败

3. 数据操作接口

GetInto

virtual int GetInto(const std::string &key, void *buffer, size_t size, const int32_t direct = 2) = 0;

功能: 将指定键的数据读入预分配的 buffer 中。

参数:

  • key: 数据键（长度 < 256字节）
  • buffer: 目标内存地址
  • size: 缓冲区容量
  • direct: 数据流向

返回值:

  • 0: 成功
  • 其他: 失败

PutFrom

virtual int PutFrom(const std::string &key, void *buffer, size_t size, const int32_t direct = 3,
                        const ReplicateConfig &replicateConfig = {}) = 0;

功能: 将 buffer 中的数据写入缓存并关联到 key。

参数:

  • replicateConfig: 副本策略配置
  • key: 数据键（长度 < 256字节）
  • buffer: 目标内存地址
  • size: 缓冲区容量
  • direct: 数据流向

返回值:

  • 0: 成功
  • 其他: 失败

Remove

virtual int Remove(const std::string &key) = 0;

功能: 删除指定键的数据对象。

参数:

  • key: 数据键（长度 < 256字节）

返回值:

  • 0: 成功
  • 其他: 失败

IsExist

virtual int IsExist(const std::string &key) = 0;

功能: 检查键是否存在。

参数:

  • key: 数据键（长度 < 256字节）

返回值:

  • 1: 存在
  • 0: 不存在
  • 其他: 失败

GetKeyInfo

virtual KeyInfo GetKeyInfo(const std::string &key) = 0;

功能: 获取键的元信息。

参数:

  • key: 数据的键，长度小于256个字节

返回值: 返回 KeyInfo，包含：

  • size_: 数据字节数
  • blobNum_: 数据副本数
  • loc_: 数据副本所在位置列表
  • type_: 数据副本所在介质类型列表

4. 批量操作接口

BatchGetInto

virtual std::vector<int> BatchGetInto(const std::vector<std::string> &keys, const std::vector<void *> &buffers,
                                          const std::vector<size_t> &sizes, const int32_t direct = 2) = 0;

功能: 批量读取多个键到各自缓冲区。

参数:

  • keys: 数据键列表（每个键长度 < 256字节）
  • buffers: 目标内存地址列表，必须与keys一一对应
  • sizes: 缓冲区容量列表，必须与buffers长度一致
  • direct: 数据流向

返回值:

  • 0: 成功
  • 其他: 失败

BatchPutFrom

virtual std::vector<int> BatchPutFrom(const std::vector<std::string> &keys, const std::vector<void *> &buffers,
                                          const std::vector<size_t> &sizes, const int32_t direct = 3,
                                          const ReplicateConfig &replicateConfig = {}) = 0;

功能: 批量写入多个键。

参数:

  • ReplicateConfig: 副本策略配置
  • keys: 数据键列表（每个键长度 < 256字节）
  • buffers: 目标内存地址列表，必须与keys一一对应
  • sizes: 缓冲区容量列表，必须与buffers长度一致
  • direct: 数据流向

返回值:

  • 0: 成功
  • 其他: 失败

BatchRemove

virtual std::vector<int> BatchRemove(const std::vector<std::string> &keys) = 0;

功能: 批量删除。

参数:

  • keys: 数据键列表（每个键长度 < 256字节）

返回值:

  • 0: 成功
  • 其他: 失败

BatchIsExist

virtual std::vector<int> BatchIsExist(const std::vector<std::string> &keys) = 0;

功能: 批量存在性检查。

参数:

  • keys: 数据键列表（每个键长度 < 256字节）

返回值:

  • 1: 存在
  • 0: 不存在
  • 其他: 失败

BatchGetKeyInfo

virtual std::vector<KeyInfo> BatchGetKeyInfo(const std::vector<std::string> &keys) = 0;

功能: 批量查询元信息。

参数:

  • keys: 数据键列表（每个键长度 < 256字节）

返回值: 返回KeyInfo列表，每个KeyInfo包含：

  • size_: 数据字节数
  • blobNum_: 数据副本数
  • loc_: 数据副本所在位置列表
  • type_: 数据副本所在介质类型列表

5. 分层张量操作

PutFromLayers

virtual int PutFromLayers(const std::string &key, const std::vector<void *> &buffers,
                              const std::vector<size_t> &sizes, const int32_t direct = 3,
                              const ReplicateConfig &replicateConfig = {}) = 0;

功能: 将多个内存块（layers）拼接后作为一个逻辑对象写入缓存，并关联到指定键。

参数:

  • key: 数据键（长度 < 256字节）
  • buffers: 多层内存地址列表
  • sizes: 每层缓冲区容量大小列表，必须与buffers长度一致
  • direct: 数据流向
  • replicateConfig: 副本策略配置

返回值:

  • 0: 成功
  • 其他: 失败

GetIntoLayers

virtual int GetIntoLayers(const std::string &key, const std::vector<void *> &buffers,
                              const std::vector<size_t> &sizes, const int32_t direct = 2) = 0;

功能: 从缓存中读取指定键的逻辑对象，并按预定义大小分发到多个目标缓冲区。

参数:

  • key: 数据键（长度 < 256字节）
  • buffers: 多层内存地址列表
  • sizes: 每层缓冲区容量大小列表，必须与buffers长度一致
  • direct: 数据流向

返回值:

  • 0: 成功
  • 其他: 失败

BatchPutFromLayers

virtual std::vector<int> BatchPutFromLayers(const std::vector<std::string> &keys,
                                                const std::vector<std::vector<void *>> &buffers,
                                                const std::vector<std::vector<size_t>> &sizes, const int32_t direct = 3,
                                                const ReplicateConfig &replicateConfig = {}) = 0;

功能: 批量将多个逻辑对象（每个由多层内存块组成）写入缓存。

参数:

  • keys: 数据键列表（每个键长度 < 256字节）
  • buffers: 多层内存地址列表，必须与keys一一对应
  • sizes: 每层缓冲区容量大小列表，必须与buffers长度一致
  • direct: 数据流向
  • replicateConfig: 副本策略配置

返回值: 返回每个key对应的处理结果列表

  • 0: 成功
  • 其他: 失败

BatchGetIntoLayers

virtual std::vector<int> BatchGetIntoLayers(const std::vector<std::string> &keys,
                                                const std::vector<std::vector<void *>> &buffers,
                                                const std::vector<std::vector<size_t>> &sizes,
                                                const int32_t direct = 2) = 0;

功能: 批量从缓存中读取多个逻辑对象，并分别分发到各自的多层缓冲区。

参数:

  • keys: 数据键列表（每个键长度 < 256字节）
  • buffers: 多层内存地址列表，必须与keys一一对应
  • sizes: 每层缓冲区容量大小列表，必须与buffers长度一致
  • direct: 数据流向

返回值: 返回每个key对应的处理结果列表

  • 0: 成功
  • 其他: 失败

6. 辅助接口

GetLocalServiceId

virtual int GetLocalServiceId(uint32_t &localServiceId) = 0;

功能: 获取当前实例关联的本地服务 ID（用于调试或日志追踪）。

参数:

  • localServiceId: 输出参数

返回值:

  • 0: 成功
  • 其他: 失败

数据结构

ReplicateConfig

副本策略配置，包含以下字段：

  • replicaNum: 副本数，默认1，最大8
  • preferredLocalServiceIDs: 优先分配的本地服务 ID 列表，列表大小必须小于或等于replicaNum

KeyInfo

客户端配置结构体，包含以下字段：

  • size_: 数据字节数
  • blobNum_: 数据副本数
  • loc_: 数据副本所在位置列表
  • type_: 数据副本所在介质类型列表

smem_bm_copy_type 枚举类型

类型 值 说明
SMEMB_COPY_L2G 0 从卡上内存复制到全局内存
SMEMB_COPY_G2L 1 从全局内存复制到卡上内存
SMEMB_COPY_G2H 2 从全局内存复制到主机内存
SMEMB_COPY_H2G 3 从主机内存复制到全局内存
SMEMB_COPY_G2G 4 从全局内存复制到全局内存

错误码

值 说明
0 操作成功
-1 一般错误
-3000 参数无效
-3001 内存分配失败
-3002 对象创建失败
-3003 服务未启动
-3004 操作超时
-3005 重复调用
-3006 对象已存在
-3007 对象不存在
-3008 未初始化
-3009 网络序列号重复
-3010 网络序列号未找到
-3011 已通知
-3013 超出容量限制
-3014 连接未找到
-3015 网络请求句柄未找到
-3016 内存不足
-3017 未连接到元数据服务
-3018 未连接到本地服务
-3019 客户端未初始化
-3101 状态不匹配
-3102 键不匹配
-3103 返回值不匹配
-3104 租约未到期
-3105 元数据备份失败

注意事项

  • 所有键的长度必须小于256个字节
  • 支持同步和异步两种操作模式
  • 批量操作可以提高处理效率