Star521
640
代码
代码
Issues25
Pull Requests122
Actions
项目讨论
Wiki
分析
Star521
640
cann-robotcann-robot【docs】: 修改拼写错误
e1bc2bb7创建于 4 小时前历史提交

Operations

包含 create、set、get、destroy 等操作接口的数据类型。



aclDataBuffer


aclCreateDataBuffer

aclDataBuffer *aclCreateDataBuffer(void *data, size_t size)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：支持

功能说明

创建aclDataBuffer类型的数据，该数据类型用于描述内存地址、大小等内存信息。

如需销毁aclDataBuffer类型的数据，请参见aclDestroyDataBuffer。

参数说明

参数名 输入/输出 说明
data 输入 存放数据内存地址的指针。data参数支持传入nullptr，表示创建一个空的数据类型，此时size参数值必须设置为0。
该内存需由用户自行管理，调用aclrtMalloc接口/aclrtFree接口申请/释放内存，或调用aclrtMallocHost接口/aclrtFreeHost接口申请/释放内存。
size 输入 内存大小，单位Byte。
如果用户需要使用空tensor，则在申请内存时，内存大小最小为1Byte，以保障后续业务正常运行。

返回值说明

返回aclDataBuffer类型的指针。


aclDestroyDataBuffer

aclError aclDestroyDataBuffer(const aclDataBuffer *dataBuffer)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：支持

功能说明

销毁通过aclCreateDataBuffer接口创建的aclDataBuffer类型的数据。

此处仅销毁aclDataBuffer类型的数据，调用aclCreateDataBuffer接口创建aclDataBuffer类型数据时传入的data的内存需由用户自行释放。

参数说明

参数名 输入/输出 说明
dataBuffer 输入 待销毁的aclDataBuffer类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclGetDataBufferAddr

void *aclGetDataBufferAddr(const aclDataBuffer *dataBuffer)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：支持

功能说明

获取aclDataBuffer类型中的数据的内存地址。

参数说明

参数名 输入/输出 说明
dataBuffer 输入 aclDataBuffer类型的指针。
需提前调用aclCreateDataBuffer接口创建aclDataBuffer类型的数据。

返回值说明

返回aclDataBuffer类型中的数据的内存地址。


aclGetDataBufferSize（废弃）

uint32 aclGetDataBufferSize(const aclDataBuffer *dataBuffer)

须知：此接口后续版本会废弃，请使用aclGetDataBufferSizeV2接口。

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：支持

功能说明

获取aclDataBuffer类型中数据的内存大小，单位Byte。

参数说明

参数名 输入/输出 说明
dataBuffer 输入 aclDataBuffer类型的指针。
需提前调用aclCreateDataBuffer接口创建aclDataBuffer类型的数据。

返回值说明

aclDataBuffer类型中数据的内存大小。


aclGetDataBufferSizeV2

size_t aclGetDataBufferSizeV2(const aclDataBuffer *dataBuffer)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：支持

功能说明

获取aclDataBuffer类型中数据的内存大小，单位Byte。

参数说明

参数名 输入/输出 说明
dataBuffer 输入 aclDataBuffer类型的指针。
需提前调用aclCreateDataBuffer接口创建aclDataBuffer类型的数据。

返回值说明

aclDataBuffer类型中数据的内存大小。


aclUpdateDataBuffer

aclError aclUpdateDataBuffer(aclDataBuffer *dataBuffer, void *data, size_t size)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

更新aclDataBuffer中数据的内存及大小。

更新aclDataBuffer后，之前aclDataBuffer中存放数据的内存如果不使用，需及时释放，否则可能会导致内存泄漏。

参数说明

参数名 输入/输出 说明
dataBuffer 输入 aclDataBuffer类型的指针。
需提前调用aclCreateDataBuffer接口创建aclDataBuffer类型的数据。
该内存需由用户自行管理，调用aclrtMalloc接口/aclrtFree接口申请/释放内存，或调用aclrtMallocHost接口/aclrtFreeHost接口申请/释放内存。
data 输入 存放数据内存地址的指针。
size 输入 内存大小，单位Byte。
如果用户需要使用空tensor，则在申请内存时，内存大小最小为1Byte，以保障后续业务正常运行。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclprofConfig


aclprofCreateConfig

aclprofConfig *aclprofCreateConfig(uint32_t *deviceIdList, uint32_t deviceNums, aclprofAicoreMetrics aicoreMetrics, const aclprofAicoreEvents *aicoreEvents, uint64_t dataTypeConfig)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建aclprofConfig类型的数据，表示创建Profiling配置数据。

aclprofConfig类型数据可以只创建一次、多处使用，用户需要保证数据的一致性和准确性。

如需销毁aclprofConfig类型的数据，请参见aclprofDestroyConfig。

约束说明

  • 使用aclprofDestroyConfig接口销毁aclprofConfig类型的数据，如不销毁会导致内存未被释放。

  • 与aclprofDestroyConfig接口配对使用，先调用aclprofCreateConfig接口再调用aclprofDestroyConfig接口。

参数说明

参数名 输入/输出 说明
deviceIdList 输入 Device ID列表。须根据实际环境的Device ID配置。
类型定义请参见aclprofConfig和aclprofAicoreMetrics。
deviceNums 输入 Device的个数。需由用户保证deviceIdList中的Device个数与deviceNums参数值一致，否则可能会导致后续业务异常。
aicoreMetrics 输入 表示AI Core性能指标采集项。请参见aclprofAicoreMetrics。
aicoreEvents 输入 表示AI Core事件，目前配置为NULL。
dataTypeConfig 输入 用户选择如下多个宏进行逻辑或（例如：ACL_PROF_ACL_API | ACL_PROF_AICORE_METRICS），作为dataTypeConfig参数值。每个宏表示某一类性能数据，详细说明如下：

- ACL_PROF_ACL_API：表示采集接口的性能数据，包括Host与Device之间、Device间的同步异步内存复制时延等。
- ACL_PROF_TASK_TIME：采集算子下发耗时、算子执行耗时数据以及算子基本信息数据，提供更全面的性能分析数据。
- ACL_PROF_TASK_TIME_L0：采集算子下发耗时、算子执行耗时数据。与ACL_PROF_TASK_TIME和ACL_PROF_TASK_TIME_L2相比，由于不采集算子基本信息数据，采集时性能开销较小，可更精准统计相关耗时数据。
- ACL_PROF_TASK_TIME_L2：采集算子下发耗时、算子执行耗时数据、算子基本信息数据（包括attr），提供更全面的性能分析数据。
- ACL_PROF_GE_API_L0：采集动态Shape算子在Host调度主要阶段的耗时数据，可更精准统计相关耗时数据。
- ACL_PROF_GE_API_L1：采集动态Shape算子在Host调度阶段更细粒度的耗时数据，提供更全面的性能分析数据。
- ACL_PROF_OP_ATTR：控制采集算子的属性信息，当前仅支持aclnn算子。
- ACL_PROF_AICORE_METRICS：表示采集AI Core性能指标数据，逻辑或时必须包括该宏，aicoreMetrics入参处配置的性能指标采集项才有效。
- ACL_PROF_TASK_MEMORY：控制CANN算子的内存占用情况采集开关，用于优化内存使用。单算子场景下，按照GE组件维度和算子维度采集算子内存大小及生命周期信息（单算子API执行方式不采集GE组件内存）；静态图和静态子图场景下，在算子编译阶段按照算子维度采集算子内存大小及生命周期信息。
- ACL_PROF_AICPU：表示采集AI CPU任务的开始、结束数据。
- ACL_PROF_L2CACHE：表示采集L2 Cache数据和TLB页表缓存命中率。
- ACL_PROF_HCCL_TRACE：控制通信数据采集开关。
- ACL_PROF_MSPROFTX：获取用户和上层框架程序输出的性能数据。可在采集进程内（aclprofStart接口、aclprofStop接口之间）调用msproftx扩展接口或mstx接口开启记录应用程序执行期间特定事件发生的时间跨度，并写入性能数据文件，再使用msprof工具解析该文件，并导出展示性能分析数据。
- ACL_PROF_TRAINING_TRACE：控制迭代轨迹数据采集开关；打开ACL_PROF_TASK_TIME*开关时工具默认同时打开该开关。
- ACL_PROF_RUNTIME_API：控制runtime api性能数据采集开关。
- ACL_PROF_API_STATS：控制acl api的统计开关，打开此开关后，profiling会启用在线分析模式，统计acl api的性能数据。该模式下，其他开关无效。

返回值说明

  • 返回aclprofConfig类型的指针，表示成功。
  • 返回nullptr，表示失败。

aclprofDestroyConfig

aclError aclprofDestroyConfig(const aclprofConfig *profilerConfig)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过aclprofCreateConfig接口创建的aclprofConfig类型的数据。

约束说明

  • 与aclprofCreateConfig接口配对使用，先调用aclprofCreateConfig接口再调用aclprofDestroyConfig接口。
  • 同一aclprofConfig指针重复调用aclprofDestroyConfig接口，会出现重复释放内存的报错。

参数说明

参数名 输入/输出 说明
profilerConfig 输入 待销毁的aclprofConfig类型的指针。类型定义请参见aclprofConfig。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclprofStepInfo


aclprofCreateStepInfo

aclprofStepInfo* aclprofCreateStepInfo()

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建aclprofStepInfo对象，用于描述迭代信息。

约束说明

  • 使用aclprofDestroyStepInfo接口销毁aclprofStepInfo类型的数据，如不销毁会导致内存未被释放。
  • 与aclprofDestroyStepInfo接口配对使用，先调用aclprofCreateStepInfo接口再调用aclprofDestroyStepInfo接口。

返回值

  • 返回aclprofStepInfo类型的指针，表示成功。
  • 返回nullptr，表示失败。

说明： 同一个aclprofStepInfo对象、同一个tag只能设置一次，否则Profiling解析会出错。


aclprofDestroyStepInfo

void aclprofDestroyStepInfo(aclprofStepInfo* stepinfo)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过aclprofCreateStepInfo接口创建的aclprofStepInfo类型的数据。

约束说明

  • 与aclprofCreateStepInfo接口配对使用，先调用aclprofCreateStepInfo接口再调用aclprofDestroyStepInfo接口。
  • 同一aclprofStepInfo数据重复调用aclprofDestroyStepInfo接口，会出现重复释放内存的报错。

参数说明

参数名 输入/输出 说明
stepinfo 输入 指定迭代信息。需提前调用aclprofCreateStepInfo接口创建aclprofStepInfo类型的数据。

aclprofSubscribeConfig


aclprofCreateSubscribeConfig

aclprofSubscribeConfig *aclprofCreateSubscribeConfig(int8_t timeInfoSwitch, aclprofAicoreMetrics aicoreMetrics, void *fd)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建aclprofSubscribeConfig类型的数据，表示创建订阅配置信息。

如需销毁aclprofSubscribeConfig类型的数据，请参见aclprofDestroySubscribeConfig。

约束说明

  • 使用aclprofDestroySubscribeConfig接口销毁aclprofSubscribeConfig类型的数据，如不销毁会导致内存未被释放。

  • 与aclprofDestroySubscribeConfig接口配对使用，先调用aclprofCreateSubscribeConfig接口再调用aclprofDestroySubscribeConfig接口。

参数说明

参数名 输入/输出 说明
timeInfoSwitch 输入 是否采集网络模型中算子的性能数据：

- 1：采集
- 0：不采集

类型定义请参见aclprofSubscribeConfig和aclprofAicoreMetrics。
aicoreMetrics 输入 表示AI Core性能指标采集项。
说明： 订阅接口目前仅提供算子耗时统计的功能，暂时不支持AicoreMetrics采集功能。
取值详见aclprofAicoreMetrics。
fd 输入 用户创建的管道写指针。
用户在调用aclprofModelUnSubscribe接口后，系统内部会在数据发送结束后，关闭该模型的管道写指针。

返回值说明

  • 返回aclprofSubscribeConfig类型的指针，表示成功。
  • 返回nullptr，表示失败。

aclprofDestroySubscribeConfig

aclError aclprofDestroySubscribeConfig(const aclprofSubscribeConfig *profSubscribeConfig)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过aclprofCreateSubscribeConfig接口创建的aclprofSubscribeConfig类型的数据。

约束说明

  • 与aclprofCreateSubscribeConfig接口配对使用，先调用aclprofCreateSubscribeConfig接口再调用aclprofDestroySubscribeConfig接口。
  • 同一aclprofSubscribeConfig指针重复调用aclprofDestroySubscribeConfig接口，会出现重复释放内存的报错。

参数说明

参数名 输入/输出 说明
profSubscribeConfig 输入 待销毁的aclprofSubscribeConfig类型的指针。类型定义请参见aclprofSubscribeConfig。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclrtAllocatorDesc


aclrtAllocatorCreateDesc

aclrtAllocatorDesc aclrtAllocatorCreateDesc()

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建aclrtAllocatorDesc类型的数据，表示Allocator描述信息，主要用于注册回调函数。

返回值说明

  • 返回aclrtAllocatorDesc类型的指针，表示成功。
  • 返回NULL，表示失败。

aclrtAllocatorDestroyDesc

aclError aclrtAllocatorDestroyDesc(aclrtAllocatorDesc allocatorDesc)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过aclrtAllocatorCreateDesc接口创建的aclrtAllocatorDesc类型的数据。

参数说明

参数名 输入/输出 说明
allocatorDesc 输入 待销毁的aclrtAllocatorDesc类型的数据。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclrtAllocatorSetObjToDesc

aclError aclrtAllocatorSetObjToDesc(aclrtAllocatorDesc allocatorDesc,  aclrtAllocator allocator)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

使用用户提供的Allocator场景下，向Allocator描述信息中设置Allocator对象。

参数说明

参数名 输入/输出 说明
allocatorDesc 输入 Allocator描述符指针。
需提前调用aclrtAllocatorCreateDesc接口设置Allocator描述信息。
取值详见aclrtAllocatorDesc。
allocator 输入 用户提供的Allocator对象指针。类型定义请参见aclrtAllocator。

返回值说明

返回0表示成功，返回其他值表示失败。


aclrtAllocatorSetAllocFuncToDesc

aclError aclrtAllocatorSetAllocFuncToDesc(aclrtAllocatorDesc allocatorDesc, aclrtAllocatorAllocFunc func)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

使用用户提供的Allocator场景下，设置“申请内存block”的回调函数。

参数说明

参数名 输入/输出 说明
allocatorDesc 输入 Allocator描述符指针。
需提前调用aclrtAllocatorCreateDesc接口设置Allocator描述信息。
取值详见aclrtAllocatorDesc。
func 输入 申请内存block的回调函数。
回调函数定义如下：
typedef void *(*aclrtAllocatorAllocFunc)(aclrtAllocator allocator, size_t size);

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclrtAllocatorSetAllocAdviseFuncToDesc

aclError aclrtAllocatorSetAllocAdviseFuncToDesc(aclrtAllocatorDesc allocatorDesc, aclrtAllocatorAllocAdviseFunc func)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

使用用户提供的Allocator场景下，设置"根据建议地址申请内存block"的回调函数，一般用于内存复用场景。

参数说明

参数名 输入/输出 说明
allocatorDesc 输入 Allocator描述符指针。
需提前调用aclrtAllocatorCreateDesc接口设置Allocator描述信息。
取值详见aclrtAllocatorDesc。
func 输入 根据建议地址申请内存block的回调函数。
回调函数定义如下：
typedef void *(*aclrtAllocatorAllocAdviseFunc)(aclrtAllocator allocator, size_t size, aclrtAllocatorAddr addr);

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclrtAllocatorSetFreeFuncToDesc

aclError aclrtAllocatorSetFreeFuncToDesc(aclrtAllocatorDesc allocatorDesc, aclrtAllocatorFreeFunc func)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

使用用户提供的Allocator场景下，设置“释放内存block”的回调函数。

参数说明

参数名 输入/输出 说明
allocatorDesc 输入 Allocator描述符指针。
需提前调用aclrtAllocatorCreateDesc接口设置Allocator描述信息。
取值详见aclrtAllocatorDesc。
func 输入 释放内存block的回调函数。
回调函数定义如下：
typedef void (*aclrtAllocatorFreeFunc)(aclrtAllocator allocator, aclrtAllocatorBlock block);

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclrtAllocatorSetGetAddrFromBlockFuncToDesc

aclError aclrtAllocatorSetGetAddrFromBlockFuncToDesc(aclrtAllocatorDesc allocatorDesc, aclrtAllocatorGetAddrFromBlockFunc func)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

使用用户提供的Allocator场景下，设置“根据申请来的block获取device内存地址”的回调函数。

参数说明

参数名 输入/输出 说明
allocatorDesc 输入 Allocator描述符指针。
需提前调用aclrtAllocatorCreateDesc接口设置Allocator描述信息。
取值详见aclrtAllocatorDesc。
func 输入 根据申请来的block获取device内存地址的回调函数。
回调函数定义如下：
typedef void *(*aclrtAllocatorGetAddrFromBlockFunc)(aclrtAllocatorBlock block);

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


aclrtStreamConfigHandle


aclrtCreateStreamConfigHandle

aclrtStreamConfigHandle *aclrtCreateStreamConfigHandle(void)

产品支持情况

  • Ascend 950PR/Ascend 950DT：不支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：不支持
  • IPV350：支持

功能说明

创建aclrtStreamConfigHandle类型的数据，表示一个Stream的配置对象。

如需销毁aclrtStreamConfigHandle类型的数据，请参见aclrtDestroyStreamConfigHandle。

参数说明

无

返回值说明

  • 返回aclrtStreamConfigHandle类型的指针，表示成功。
  • 返回NULL，表示失败。

aclrtDestroyStreamConfigHandle

aclError aclrtDestroyStreamConfigHandle(aclrtStreamConfigHandle *handle)

产品支持情况

  • Ascend 950PR/Ascend 950DT：不支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：不支持
  • IPV350：支持

功能说明

销毁通过aclrtCreateStreamConfigHandle接口创建的aclrtStreamConfigHandle类型的数据。

参数说明

参数名 输入/输出 说明
handle 输入 待销毁的aclrtStreamConfigHandle类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtDataItem


acltdtCreateDataItem

acltdtDataItem *acltdtCreateDataItem(acltdtTensorType tdtType,
const int64_t *dims,
size_t dimNum,
aclDataType dataType,
void *data,
size_t size)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建acltdtDataItem类型的数据，代表一个业务上的Tensor。

如需销毁acltdtDataItem类型的数据，请参见acltdtDestroyDataItem。

参数说明

参数名 输入/输出 说明
tdtType 输入 tensor类型。类型定义请参见acltdtTensorType。
dims 输入 tensor的Shape。
dimNum 输入 tensor的Shape中的维度个数。
dataType 输入 正常数据里的数据类型。类型定义请参见aclDataType。
data 输入 数据地址指针。
size 输入 数据长度。

返回值说明

  • 返回acltdtDataItem类型的指针，表示成功。
  • 返回nullptr，表示失败。

acltdtDestroyDataItem

aclError acltdtDestroyDataItem(acltdtDataItem *dataItem)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过acltdtCreateDataItem接口创建的acltdtDataItem类型的数据。

参数说明

参数名 输入/输出 说明
dataItem 输入 待销毁的acltdtDataItem类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtGetTensorTypeFromItem

acltdtTensorType acltdtGetTensorTypeFromItem(const acltdtDataItem *dataItem)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

收到dataItem数据之后，从数据描述里首先check这个数据是个正常数据，还是一个end数据，还是一个异常数据。

参数说明

参数名 输入/输出 说明
dataItem 输入 acltdtDataItem类型的指针。
需提前调用acltdtCreateDataItem接口创建acltdtDataItem类型的数据。

返回值说明

请参见acltdtTensorType。


acltdtGetDataTypeFromItem

aclDataType acltdtGetDataTypeFromItem(const acltdtDataItem *dataItem)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

获取正常数据的数据类型。

参数说明

参数名 输入/输出 说明
dataItem 输入 acltdtDataItem类型的指针。
需提前调用acltdtCreateDataItem接口创建acltdtDataItem类型的数据。

返回值说明

获取到的数据类型，类型定义请参见aclDataType。


acltdtGetDataAddrFromItem

void *acltdtGetDataAddrFromItem(const acltdtDataItem *dataItem)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

得到正常数据的数据地址。

参数说明

参数名 输入/输出 说明
dataItem 输入 acltdtDataItem类型的指针。
需提前调用acltdtCreateDataItem接口创建acltdtDataItem类型的数据。

返回值说明

返回正常数据的数据地址。


acltdtGetDataSizeFromItem

size_t acltdtGetDataSizeFromItem(const acltdtDataItem *dataItem)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

得到正常数据的数据长度。

参数说明

参数名 输入/输出 说明
dataItem 输入 acltdtDataItem类型的指针。
需提前调用acltdtCreateDataItem接口创建acltdtDataItem类型的数据。

返回值说明

获取到的数据长度。


acltdtGetDimNumFromItem

size_t acltdtGetDimNumFromItem(const acltdtDataItem *dataItem)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

得到正常tensor数据的数据Shape中的维度个数。

参数说明

参数名 输入/输出 说明
dataItem 输入 acltdtDataItem类型的指针。
需提前调用acltdtCreateDataItem接口创建acltdtDataItem类型的数据。

返回值说明

获取到的维度个数。


acltdtGetDimsFromItem

aclError acltdtGetDimsFromItem(const acltdtDataItem *dataItem, int64_t *dims, size_t dimNum)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

得到正常tensor数据的数据Shape。

参数说明

参数名 输入/输出 说明
dataItem 输入 acltdtDataItem类型的指针。
需提前调用acltdtCreateDataItem接口创建acltdtDataItem类型的数据。
dims 输入&输出 维度信息数组。
dimNum 输入 维度个数。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtDataset


acltdtCreateDataset

acltdtDataset *acltdtCreateDataset()

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建acltdtDataset类型的数据，对等一个Vector<tensor>。

如需销毁acltdtDataset类型的数据，请参见acltdtDestroyDataset。

参数说明

无

返回值说明

  • 返回acltdtDataset类型的指针，表示成功。
  • 返回nullptr，表示失败。

acltdtDestroyDataset

aclError acltdtDestroyDataset(acltdtDataset *dataset)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过acltdtCreateDataset接口创建的acltdtDataset类型的数据。

参数说明

参数名 输入/输出 说明
dataset 输入 待销毁的acltdtDataset类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtGetDataItem

acltdtDataItem *acltdtGetDataItem(const acltdtDataset *dataset, size_t index)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

获取acltdtDataset中的第n个acltdtDataItem。

参数说明

参数名 输入/输出 说明
dataset 输入 acltdtDataset类型的指针。
需提前调用acltdtCreateDataset接口创建acltdtDataset类型的数据，再调用acltdtAddDataItem接口添加acltdtDataItem。
index 输入 表明获取的是第几个acltdtDataItem。

返回值说明

  • 获取成功，返回acltdtDataItem的地址。
  • 获取失败返回空地址。

acltdtAddDataItem

aclError acltdtAddDataItem(acltdtDataset *dataset, acltdtDataItem *dataItem)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

向acltdtDataset中增加acltdtDataItem。

参数说明

参数名 输入/输出 说明
dataset 输出 待增加acltdtDataItem的acltdtDataset地址指针。
需提前调用acltdtCreateDataset接口创建acltdtDataset类型的数据。
dataItem 输入 待增加的acltdtDataItem地址指针。
需提前调用acltdtCreateDataItem接口创建acltdtDataItem类型的数据。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtGetDatasetSize

size_t acltdtGetDatasetSize(const acltdtDataset *dataset)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

获取acltdtDataset中acltdtDataItem的个数。

参数说明

参数名 输入/输出 说明
dataset 输入 acltdtDataset类型的指针。
需提前调用acltdtCreateDataset接口创建acltdtDataset类型的数据。

返回值说明

acltdtDataItem的个数。


acltdtGetDatasetName

const char *acltdtGetDatasetName(const acltdtDataset *dataset)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：不支持
  • Atlas 推理系列产品：不支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

获取标识acltdtDataset（对等一个Vector<tensor>）的描述符。

参数说明

参数名 输入/输出 说明
dataset 输入 acltdtDataset类型的指针。
需提前调用acltdtCreateDataset接口创建acltdtDataset类型的数据。

返回值说明

标识acltdtDataset（对等一个Vector<tensor>）的描述符的指针。


acltdtQueueAttr


acltdtCreateQueueAttr

acltdtQueueAttr *acltdtCreateQueueAttr()

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建acltdtQueueAttr类型的数据，表示队列属性配置信息。

参数说明

无

返回值说明

  • 返回acltdtQueueAttr类型的指针，表示成功。
  • 返回nullptr，表示失败。

acltdtDestroyQueueAttr

aclError acltdtDestroyQueueAttr(const acltdtQueueAttr *attr)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过acltdtCreateQueueAttr接口创建的acltdtQueueAttr类型的数据。

参数说明

参数名 输入/输出 说明
attr 输入 待销毁的acltdtQueueAttr类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtSetQueueAttr

aclError acltdtSetQueueAttr(acltdtQueueAttr *attr, acltdtQueueAttrType type, size_t len, const void *param)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

设置队列属性值。

参数说明

参数名 输入/输出 说明
attr 输入&输出 队列属性配置信息的指针。
需提前调用acltdtCreateQueueAttr接口创建acltdtQueueAttr类型的数据。
type 输入 属性类型。类型定义请参见acltdtQueueAttrType。
len 输入 属性值的字节数。

- type取值的枚举名以_UINT64结尾时，此处配置为8；
- type取值的枚举名以_UINT32结尾时，此处配置为4；
- type取值的枚举名以_PTR结尾时，若操作系统是32位，则此处配置为4；若操作系统是64位，则配置为8。
param 输入 指向属性值的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtGetQueueAttr

aclError acltdtGetQueueAttr(const acltdtQueueAttr *attr, acltdtQueueAttrType type, size_t len, size_t *paramRetSize, void *param)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

获取队列属性值。

参数说明

参数名 输入/输出 说明
attr 输入 队列属性配置信息的指针。
需提前调用acltdtCreateQueueAttr接口创建acltdtQueueAttr类型的数据。
type 输入 属性类型。类型定义请参见acltdtQueueAttrType.
len 输入 属性值的字节数。

- type取值的枚举名以_UINT64结尾时，此处配置为8；
- type取值的枚举名以_UINT32结尾时，此处配置为4；
- type取值的枚举名以_PTR结尾时，若操作系统是32位，则此处配置为4；若操作系统是64位，则配置为8。
paramRetSize 输出 实际返回的属性值字节数的指针。
param 输出 指向属性值的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtQueueRoute


acltdtCreateQueueRoute

acltdtQueueRoute* acltdtCreateQueueRoute(uint32_t srcId, uint32_t dstId)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建acltdtQueueRoute类型的数据，表示创建队列路由配置。

参数说明

参数名 输入/输出 说明
srcId 输入 源队列ID。
dstId 输入 目的队列ID。

返回值说明

  • 返回acltdtQueueRoute类型的指针，表示成功。
  • 返回nullptr，表示失败。

acltdtDestroyQueueRoute

aclError acltdtDestroyQueueRoute(const acltdtQueueRoute *route)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过acltdtCreateQueueRoute接口创建的acltdtQueueRoute类型的数据。

参数说明

参数名 输入/输出 说明
route 输入 待销毁的acltdtQueueRoute类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtGetQueueRouteParam

aclError acltdtGetQueueRouteParam(const acltdtQueueRoute *route, acltdtQueueRouteParamType type, size_t len, size_t *paramRetSize, void *param)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

获取队列路由配置的相关信息，例如源队列ID、目标队列ID等。

参数说明

参数名 输入/输出 说明
route 输入 队列路由配置信息的指针。
需提前调用acltdtCreateQueueRoute接口创建acltdtQueueRoute类型的数据。
type 输入 路由参数类型。类型定义请参见acltdtQueueRouteParamType。
len 输入 参数值的字节数。
type取值的枚举名以_UINT32或_INT32结尾，此处固定配置为4。
paramRetSize 输出 实际返回的参数值字节数的指针。
param 输出 指向参数值的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtQueueRouteList


acltdtCreateQueueRouteList

acltdtQueueRouteList* acltdtCreateQueueRouteList()

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建acltdtQueueRouteList类型的数据，表示队列路由配置数组。

参数说明

无

返回值说明

  • 返回acltdtQueueRouteList类型的指针，表示成功。
  • 返回nullptr，表示失败。

acltdtDestroyQueueRouteList

aclError acltdtDestroyQueueRouteList(const acltdtQueueRouteList *routeList)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过acltdtCreateQueueRouteList接口创建的acltdtQueueRouteList类型的数据。

参数说明

参数名 输入/输出 说明
routeList 输入 待销毁的acltdtQueueRouteList类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtAddQueueRoute

aclError acltdtAddQueueRoute(acltdtQueueRouteList *routeList, const acltdtQueueRoute *route)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

向队列路由配置数组中添加队列路由配置信息。

参数说明

参数名 输入/输出 说明
routeList 输入&输出 队列路由配置数组。
需提前调用acltdtCreateQueueRouteList接口创建acltdtQueueRouteList类型的数据。
route 输入 需添加的队列路由配置信息的指针。
需提前调用acltdtCreateQueueRoute接口创建acltdtQueueRoute类型的数据。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtGetQueueRoute

aclError acltdtGetQueueRoute(const acltdtQueueRouteList *routeList, size_t index, acltdtQueueRoute *route)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

从队列路由配置数组中获取指定的队列路由配置信息。

参数说明

参数名 输入/输出 说明
routeList 输入 队列路由配置数组。
需提前调用acltdtCreateQueueRouteList接口创建acltdtQueueRouteList类型的数据。
index 输入 指定获取哪一个队列路由配置信息，index编号从0开始。
route 输入&输出 需添加的队列路由配置信息的指针。类型定义请参见acltdtQueueRoute。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtGetQueueRouteNum

size_t acltdtGetQueueRouteNum(const acltdtQueueRouteList *routeList)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

从队列路由配置数组中获取路由数量。

参数说明

参数名 输入/输出 说明
routeList 输入 队列路由配置数组。
需提前调用acltdtCreateQueueRouteList接口创建acltdtQueueRouteList类型的数据。

返回值说明

返回路由数量。


acltdtQueueRouteQueryInfo


acltdtCreateQueueRouteQueryInfo

acltdtQueueRouteQueryInfo* acltdtCreateQueueRouteQueryInfo()

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

创建acltdtQueueRouteQueryInfo类型的数据，表示队列路由关系查询条件。

参数说明

无

返回值说明

  • 返回acltdtQueueRouteQueryInfo类型的指针，表示成功。
  • 返回nullptr，表示失败。

acltdtDestroyQueueRouteQueryInfo

aclError acltdtDestroyQueueRouteQueryInfo(const acltdtQueueRouteQueryInfo *info)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

销毁通过acltdtCreateQueueRouteQueryInfo接口创建的acltdtQueueRouteQueryInfo类型的数据。

参数说明

参数名 输入/输出 说明
info 输入 待销毁的acltdtQueueRouteQueryInfo类型的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。


acltdtSetQueueRouteQueryInfo

aclError acltdtSetQueueRouteQueryInfo(acltdtQueueRouteQueryInfo *param, acltdtQueueRouteQueryInfoParamType type, size_t len, const void *value)

产品支持情况

  • Ascend 950PR/Ascend 950DT：支持
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
  • Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
  • Atlas 200I/500 A2 推理产品：支持
  • Atlas 推理系列产品：支持
  • Atlas 训练系列产品：支持
  • IPV350：不支持

功能说明

设置路由关系查询条件。

参数说明

参数名 输入/输出 说明
param 输入&输出 队列路由关系查询条件的指针。
需提前调用acltdtCreateQueueRouteQueryInfo创建acltdtQueueRouteQueryInfo类型的数据。
type 输入 参数类型。类型定义请参见acltdtQueueRouteQueryInfoParamType。
len 输入 参数值的字节数。

- type取值的枚举名以_UINT64结尾时，此处配置为8；
- type取值的枚举名以_UINT32结尾时，此处配置为4；
- type取值的枚举名以_PTR结尾时，若操作系统是32位，则此处配置为4；若操作系统是64位，则配置为8。
value 输入 参数值的指针。

返回值说明

返回0表示成功，返回其他值表示失败，请参见aclError。