RMRS API参考 ​

UBSRMRSUpdateAntiNode ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSUpdateAntiNode(const std::map<std::string, std::vector<std::string>> &nodeAntiMap);

描述 DESCRIPTION

更新反亲和性配置。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：更新反亲和性成功。
• 返回1：更新反亲和性失败。

约束 CONSTRAINTS

• 本节点调用。
• key和value——nodeId：必须是集群内真实存在的节点。
• 一次调用必须设置集群中所有节点的反亲和性。
• 支持将反亲和性节点设置为本节点。
• 更新反亲和性配置输入{key:[value]}，其中key代表节点且不能重复，value代表与其反亲和的节点。key和value不能设置一样。
• 需要输入不重复的rack内全部节点的反亲和性节点列表。

附注 NOTES

暂无。

UBSRMRSMemBorrowStrategy ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMemBorrowStrategy(const SrcMemoryBorrowParam &outSrcParam, const uint64_t &borrowSize,
                                  MemBorrowStrategyResult &outBorrowStrategyResult);

描述 DESCRIPTION

内存借用策略，决策从哪些节点借用内存以及借用内存大小，返回决策结果。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：借用策略执行成功。

• 返回1：借用策略执行失败。

约束 CONSTRAINTS

• 本节点调用。

• 所有节点的ubse配置项须保持一致。

附注 NOTES

暂无。

UBSRMRSMemBorrowExecute ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMemBorrowExecute(const SrcMemoryBorrowParam &outSrcParam,
                                 const std::vector<DestMemoryBorrowParam> &outDestParam,
                                 MemBorrowExecuteResult &outBorrowExecuteResult);

描述 DESCRIPTION

执行内存借用动作，返回执行结果。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：代表借用执行动作集执行成功。
• 返回1：代表借用执行动作集执行失败。

约束 CONSTRAINTS

• 本节点调用。

• memSize需要是obmm.memory.block.size的整数倍。

• memSize在碎片场景下不大于4GB，否则执行失败；在大虚机场景下无此约束。

• 所有节点的ubse配置项须保持一致。

附注 NOTES

暂无。

UBSRMRSMigrateStrategy ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMigrateStrategy(const std::string &borrowInNode, const std::vector<VMPresetParam> &outVmInfoList,const uint64_t &borrowSize, MigrateStrategyResult &outMigrateStrategyResult)

描述 DESCRIPTION

本接口为封装第三层匀一匀（内存迁移）接口。内存借用之后，第三层策略决策哪些虚拟机迁出多少比例内存到哪些远端NUMA，返回决策结果和评估时间。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示迁出策略决策成功。

• 返回1：表示迁出策略决策失败。

约束 CONSTRAINTS

• 本节点调用，即borrowInNode为本节点。
• borrowInNode的nodeId必须为真实存在的节点。

附注 NOTES

暂无。

UBSRMRSMigrateExecute ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMigrateExecute(const std::string &borrowInNode, const std::vector<VMMigrateOutParam> &outVmInfoList,const std::uint64_t &waitingTime, const std::vector<std::string> &borrowIds);

描述 DESCRIPTION

执行内存迁出动作集，在规定时间内完成返回成功，否则超出等待时间，表示失败，执行回退。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示借用迁出动作集执行成功。
• 返回1：代表借用迁出动作集执行失败。

约束 CONSTRAINTS

• 本节点调用，即borrowInNode为本节点。
• borrowInNode的nodeId必须为真实存在的节点。
• borrowIds必须是ubse借用账本中真实存在的name借用标识符。
• waitingTime：10s-3min。

附注 NOTES

暂无。

UBSRMRSMemFree ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMemFree(const std::string &nodeId);

描述 DESCRIPTION

调用第三层内存归还策略，第三层决策并执行哪些虚拟机可以迁回内存，腾出远端NUMA内存，返回给第一层可以归还的远端NUMA节点，第一层执行节点间内存归还（整NUMA归还）。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：成功。
• 返回1：失败通用错误码。
• 返回2：迁移失败-迁移过程中虚机被删除。
• 返回3：迁移失败通用错误码。
• 返回4：内存资源删除失败。

约束 CONSTRAINTS

• 本节点调用。
• nodeId必须是集群内真实存在的节点。

附注 NOTES

暂无。

UBSRMRSMemBorrowRollback ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMemBorrowRollback(const std::string &borrowInNode, const std::vector<std::string> &borrowIds);

描述 DESCRIPTION

覆盖场景为借用成功的前提下，迁出失败以及迁出成功但创建虚拟机失败，回滚逻辑为虚拟机远端占用全部迁回，对应borrowIds全部归还。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示回滚成功。
• 返回1：表示回滚失败。

约束 CONSTRAINTS

• 本节点调用。
• 两个入参不能为空。
• 覆盖场景为借用成功前提。
• borrowInNode的nodeId必须是集群内真实存在的节点。
• borrowIds必须是ubse借用账本中真实存在的name借用标识符。

附注 NOTES

暂无。

UBSRMRSGetVmInfoListOnNode ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSGetVmInfoListOnNode(std::vector<VmDomainInfo> &outVmDomainInfos);

描述 DESCRIPTION

内存调度插件提供接口获取本节点所有虚拟机信息。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：查询成功。
• 返回1：查询失败。

约束 CONSTRAINTS

• 本节点调用，返回本节点虚机信息。
• 仅支持查询绑定单个本地numa的虚机。
• 仅采集状态为RUNNING和PAUSED状态的虚拟机。

附注 NOTES

暂无。

UBSRMRSGetNumaInfoListOnNode ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSGetNumaInfoListOnNode(std::vector<NumaInfo> &outNumaInfos);

描述 DESCRIPTION

内存调度插件提供接口获取本节点NUMA信息。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示成功。

• 返回1：表示失败。

约束 CONSTRAINTS

本节点调用，返回本节点NUMA信息。

附注 NOTES

暂无。

UBSRMRSMemBorrow ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMemBorrow(const SrcMemoryBorrowParam &srcParam, const std::vector<uint64_t> &borrowSizes,
                          const WaterMark &waterMark, MemBorrowExecuteResult &result);

描述 DESCRIPTION

超分场景，水线告警触发内存借用，返回内存描述符。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0，表示内存借用成功。
• 返回1，表示借用内存失败。

约束 CONSTRAINTS

• 本节点调用。
• 场景为超分场景
• 该接口由virt进行调用，然后将参数透传给ubse。
• 入参borrowSizes数量需为[1,256]。
• 能借入大小的总上限和环境、芯片规格有关系。

附注 NOTES

暂无。

UBSRMRSMemMigrate ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMemMigrate(const SrcMemoryBorrowParam &srcParam, const std::vector<VMPresetParam> &vmPresetParams,
                           const MemBorrowExecuteResult &result);

描述 DESCRIPTION

超分场景，内存借用成功后，决策并迁移虚拟机内存到远端内存。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示内存迁移成功。

• 返回1：表示内存迁移失败。

约束 CONSTRAINTS

• 本节点调用。
• 超分场景调用。

附注 NOTES

暂无。

UBSRMRSMemReturn ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSMemReturn(const SrcMemoryBorrowParam &srcParam, const std::vector<std::string> &borrowIds,
                          const std::vector<pid_t> &pids);

描述 DESCRIPTION

超分场景，分配内存失败后回滚或归还内存。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示内存归还成功。

• 返回1：表示内存归还失败。

约束 CONSTRAINTS

• 本节点调用。
• 超分场景调用。

UBSRMRSPidNumaInfoCollect ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSPidNumaInfoCollect(const SrcMemoryBorrowParam &srcParam, const std::vector<pid_t> &pids,
                                   std::vector<PidInfo> &pidInfos);

描述 DESCRIPTION

超分场景，容器进程信息查询。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示成功。

• 返回1：表示传入PIDs为空，或传入的PIDs全都不存在，或查询失败。

约束 CONSTRAINTS

• 本节点调用。
• 超分容器场景调用。

附注 NOTES

暂无。

UBSRMRSSetWaterMark ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSSetWaterMark(const WaterMark &waterMark);

描述 DESCRIPTION

超分场景，容器进程信息查询。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示成功。

• 返回1：表示失败。

约束 CONSTRAINTS

• 本节点调用。
• 每个节点都需设置注入水线。
• 超分场景使用。

附注 NOTES

暂无。

UBSRMRSSetRunMode ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

uint32_t UBSRMRSSetRunMode(const int &runMode);

描述 DESCRIPTION

设置超分/碎片场景

参数 PARAMETERS

返回值 RETURN VALUE

• 返回0：表示成功。

• 返回1：表示失败。

约束 CONSTRAINTS

• runMode取值范围：有效值只有0和1。

  • 0：超分场景。
  • 1：内存碎片场景。

• master节点调用。

附注 NOTES

暂无。

UBSRMRSSmapAddProcessTracking ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

int UBSRMRSSmapAddProcessTracking(const std::vector<pid_t> &pidVec, const std::vector<uint32_t> &scanTimeVec,
                                  int scanType, const std::optional<std::vector<uint32_t>> &durationVec = std::nullopt);

描述 DESCRIPTION

通知SMAP添加进程扫描，并设置扫描周期参数。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回值0：成功返回0。

• 返回值-1：SMAP未初始化返回-1。

• 返回值-22：参数错误返回-22。

• 返回值-9：内核态内存申请失败返回-9。

• 返回值-12：用户态内存申请失败返回-12。

约束 CONSTRAINTS

• 本节点调用。
• 当进程未被SMAP纳管时，可以调用该接口，此时scanType只能传0或者2。
• 当进程已经被SMAP纳管时，须先停止冷热迁移，然后才可以调用该接口，scanType可以传0或1。
• scanType传1的情况为进程已被SMAP纳管，需要从只扫描状态恢复到冷热扫描加迁移状态。

附注 NOTES

暂无。

UBSRMRSSmapQueryFreq ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

int UBSRMRSSmapQueryFreq(const pid_t &pid, std::vector<uint16_t> &dataVec, const uint32_t &lengthIn,
                         uint32_t &lengthOut, const int &dataSource);

描述 DESCRIPTION

通知SMAP添加进程扫描，并设置扫描周期参数。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回值0：成功返回0。

• 返回值-1：SMAP未初始化返回-1。

• 返回值-22：参数错误返回-22。

约束 CONSTRAINTS

• 本节点调用。
• 当进程未被SMAP纳管时，或未被SMAP添加进程扫描时，不可以调用该接口。
• 当进程已经被SMAP纳管时，可以调用该接口，dataSource可以传0。
• 当进程已经被SMAP添加进程扫描时，可以调用该接口，dataSource可以传1。

附注 NOTES

暂无。

UBSRMRSSmapRemoveProcessTracking ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

int UBSRMRSSmapRemoveProcessTracking(const std::vector<pid_t> &pidVec, int flags = 0);

描述 DESCRIPTION

通知SMAP移除进程扫描。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回值0：成功返回0。

• 返回值-1：SMAP未初始化返回-1。

• 返回值-22：参数错误返回-22。

• 返回值-9：内核态内存申请失败返回-9。

约束 CONSTRAINTS

• 本节点调用。
• 只有通过OutSmapAddProcessTracking接口设置的scanType为0的PID才能被这个接口移除。
• 只支持虚拟机场景。

附注 NOTES

暂无。

UBSRMRSSmapEnableProcessMigrate ​

摘要 SYNOPSIS

#include "mempooling_interface.h"

int UBSRMRSSmapEnableProcessMigrate(std::vector<pid_t> pidVec, int enable, int flags = 0);

描述 DESCRIPTION

启用/禁用PID对应虚拟机的冷热迁移和迁回。

参数 PARAMETERS

返回值 RETURN VALUE

• 返回值0：成功返回0。

• 返回值-1：SMAP未初始化返回-1。

• 返回值-22：参数错误返回-22。

• 返回值-110：超时返回-110。

约束 CONSTRAINTS

• 本节点调用。

• flags为保留字段，暂未使用。

• pidVec的size需为[1,100]。

附注 NOTES

暂无。