函数:mem_export_to_shareable_handle

C函数原型

aclError aclrtMemExportToShareableHandle(aclrtDrvMemHandle handle, aclrtMemHandleType handleType, uint64_t flags, uint64_t *shareableHandle)

Python函数

shareable_handle, ret = acl.rt.mem_export_to_shareable_handle(handle, handle_type, flags)

函数功能

将本进程通过acl.rt.malloc_physical接口获取到的物理内存handle导出,以便后续将物理内存共享给其它进程。

本接口需与以下其它接口配合使用,以便实现内存共享的目的(此处以A、B进程为例,说明两个进程间的物理内存共享接口调用流程):

  1. 在A进程中:
    1. 调用acl.rt.malloc_physical接口,申请物理内存。

      先调用acl.rt.mem_get_allocation_granularity接口获取内存申请粒度,然后在调用acl.rt.malloc_physical接口申请物理内存时size按获取到的内存申请粒度对齐,以便节约内存。

      若需申请地址连续的虚拟内存、最大化利用物理内存地址的目的,此处可配合acl.rt.reserve_mem_addressacl.rt.map_mem等接口申请虚拟内存、建立虚拟内存与物理内存之间的映射,请参见对应接口的说明。

    2. 调用acl.rt.mem_export_to_shareable_handle接口,导出物理内存handle,输出shareable_handle。
    3. 获取B进程的进程ID,并调用acl.rt.mem_set_pid_to_shareable_handle接口,将B进程的进程ID设置为白名单。
    4. 调用acl.rt.free_physical接口,释放物理内存。

      涉及共享内存的进程都需要释放物理内存,所有涉及内存共享的进程都完成释放操作,物理内存才真正释放。释放物理内存后,引用的分配内存将释放回操作系统,之后使用handle将导致未定义的行为。

  2. 在B进程中:
    1. 调用acl.rt.device_get_bare_tgid接口,获取B进程的进程ID。

      本接口内部在获取进程ID时已适配物理机、虚拟机场景,用户只需调用本接口获取进程ID,再配置其它接口使用,达到物理内存共享的目的。若用户不调用本接口、自行获取进程ID,可能会导致后续使用进程ID异常。

    2. 调用acl.rt.mem_import_from_shareable_handle,获取shareable_handle里的信息,并返回本进程中的handle。(在调用acl.rt.mem_import_from_shareable_handle接口前,需确保待共享的物理内存存在,不能提前释放。)

      若需申请地址连续的虚拟内存、最大化利用物理内存地址的目的,此处可配合acl.rt.reserve_mem_addressacl.rt.map_mem等接口申请虚拟内存、建立虚拟内存与物理内存之间的映射,请参见对应接口的说明。

    3. 调用acl.rt.free_physical接口,释放物理内存。

输入说明

handle:int,存放物理内存信息的handle。

需先在本进程调用acl.rt.malloc_physical接口申请物理内存,该接口调用成功,会返回一个handle。

handle_type:int,预留参数,当前固定输入ACL_MEM_HANDLE_TYPE_NONE = 0。

flags:int,预留参数,当前固定填0。

返回值说明

shareable_handle:int,标识共享给其它进程的shareable_handle。

ret:int,错误码。

  • 返回0表示成功。
  • 返回其它值表示失败。

约束说明

  • Ascend RC形态不支持调用本接口。
  • 只支持Device侧的物理内存共享。
  • 通过acl.rt.free_physical接口释放物理内存,实现销毁shareable_handle。若有进程还在使用shareable_handle,则等待shareable_handle使用完成后再执行销毁任务。
  • handle与shareable_handle是一一对应的关系,在同一个进程中,不允许一对多、或多对一,否则报错,例如重复调用本接口导出时则会返回报错。
  • 不支持算力切分和算力分组场景。