CANN/runtime共享Buffer管理

17-03 共享Buffer管理

【免费下载链接】runtime本项目提供CANN运行时组件和维测功能组件。项目地址: https://gitcode.com/cann/runtime

本章节描述共享 Buffer 管理接口，用于 Buffer 的分配、释放、数据操作及 Buffer 链管理。

• aclError acltdtAllocBuf(size_t size, uint32_t type, acltdtBuf *buf)：申请共享Buffer内存。
• aclError acltdtFreeBuf(acltdtBuf buf)：释放通过acltdtAllocBuf接口申请的mbuf。
• aclError acltdtGetBufData(const acltdtBuf buf, void **dataPtr, size_t *size)：获取共享Buffer的数据区指针和数据区长度，用户可以使用此指针填入数据。
• aclError acltdtSetBufUserData(acltdtBuf buf, const void *dataPtr, size_t size, size_t offset)：设置共享Buffer的私有数据区数据，从用户内存拷贝到共享内存的私有数据区的指定偏移位置，用于设置控制信息作为上下文传递。
• aclError acltdtGetBufUserData(const acltdtBuf buf, void *dataPtr, size_t size, size_t offset)：获取共享Buffer的私有数据区数据，偏移offset后，拷贝至用户申请的内存区域。
• aclError acltdtSetBufDataLen(acltdtBuf buf, size_t len)：设置共享Buffer中有效数据的长度。
• aclError acltdtGetBufDataLen(acltdtBuf buf, size_t *len)：获取共享Buffer中有效数据的长度。
• aclError acltdtCopyBufRef(const acltdtBuf buf, acltdtBuf *newBuf)：对共享Buffer数据区的引用拷贝，创建并返回一个新的Buffer管理结构指向相同的数据区。
• aclError acltdtAppendBufChain(acltdtBuf headBuf, acltdtBuf buf)：将某个共享Buffer内存添加到共享Buffer链表中。
• aclError acltdtGetBufChainNum(acltdtBuf headBuf, uint32_t *num)：获取共享Buffer链中的共享Buffer数量。
• aclError acltdtGetBufFromChain(acltdtBuf headBuf, uint32_t index, acltdtBuf *buf)：获取Mbuf链中第index个Mbuf。

acltdtAllocBuf

aclError acltdtAllocBuf(size_t size, uint32_t type, acltdtBuf *buf)

产品支持情况

功能说明

申请共享Buffer内存。

使用acltdtAllocBuf接口申请内存后，数据区的长度为size参数的大小，在用户还未填入有效数据前，该内存的有效数据长度初始值为0，可在用户向内存中填入有效数据后，再通过acltdtSetBufDataLen接口设置有效数据长度。

使用acltdtAllocBuf接口申请的内存，需要通过acltdtFreeBuf接口释放内存。

参数说明

返回值说明

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

acltdtFreeBuf

aclError acltdtFreeBuf(acltdtBuf buf)

产品支持情况

功能说明

释放通过acltdtAllocBuf接口申请的mbuf。

参数说明

返回值说明

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

acltdtGetBufData

aclError acltdtGetBufData(const acltdtBuf buf, void **dataPtr, size_t *size)

产品支持情况

功能说明

获取共享Buffer的数据区指针和数据区长度，用户可以使用此指针填入数据。

接口调用顺序：调用acltdtAllocBuf或acltdtCopyBufRef接口申请到共享Buffer后，因此需由用户调用acltdtGetBufData接口获取共享Buffer的内存指针及长度后，再自行向内存中填充有效数据，然后再调用acltdtSetBufDataLen接口设置共享Buffer中有效数据的长度，且长度必须小于acltdtGetBufData获取到的size大小。

参数说明

返回值说明

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

acltdtSetBufUserData

aclError acltdtSetBufUserData(acltdtBuf buf, const void *dataPtr, size_t size, size_t offset)

产品支持情况

功能说明

设置共享Buffer的私有数据区数据，从用户内存拷贝到共享内存的私有数据区的指定偏移位置，用于设置控制信息作为上下文传递。当前默认私有数据区大小是96Byte，offset+size必须小于或等于96Byte，否则返回报错。

参数说明

返回值说明

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

acltdtGetBufUserData

aclError acltdtGetBufUserData(const acltdtBuf buf, void *dataPtr, size_t size, size_t offset)

产品支持情况

功能说明

获取共享Buffer的私有数据区数据，偏移offset后，拷贝至用户申请的内存区域。当前默认私有数据区大小是96Byte，offset+size必须小于或等于96Byte，否则返回报错。

参数说明

返回值说明

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

acltdtSetBufDataLen

aclError acltdtSetBufDataLen(acltdtBuf buf, size_t len)

产品支持情况

功能说明

设置共享Buffer中有效数据的长度。

接口调用顺序：调用acltdtAllocBuf或acltdtCopyBufRef接口申请到共享Buffer后，因此需由用户调用acltdtGetBufData接口获取共享Buffer的内存指针及长度后，再自行向内存中填充有效数据，然后再调用acltdtSetBufDataLen接口设置共享Buffer中有效数据的长度，且长度必须小于acltdtGetBufData获取到的size大小。

参数说明

返回值说明

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

acltdtGetBufDataLen

aclError acltdtGetBufDataLen(acltdtBuf buf, size_t *len)

产品支持情况

功能说明

获取共享Buffer中有效数据的长度。

通过acltdtSetBufDataLen接口设置共享Buffer中有效数据的长度后，可调用本接口获取有效数据的长度，否则，通过本接口获取到的长度为0。

参数说明

返回值说明

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

acltdtCopyBufRef

aclError acltdtCopyBufRef(const acltdtBuf buf, acltdtBuf *newBuf)

产品支持情况

功能说明

对共享Buffer数据区的引用拷贝，创建并返回一个新的Buffer管理结构指向相同的数据区。

参数说明

返回值说明

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

acltdtAppendBufChain

aclError acltdtAppendBufChain(acltdtBuf headBuf, acltdtBuf buf)

产品支持情况

功能说明

将某个共享Buffer内存添加到共享Buffer链表中。共享Buffer链最大支持128个共享Buffer。共享Buffer可通过acltdtAllocBuf或acltdtCopyBufRef接口申请获得。

参数说明

返回值说明

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

acltdtGetBufChainNum

aclError acltdtGetBufChainNum(acltdtBuf headBuf, uint32_t *num)

产品支持情况

功能说明

获取共享Buffer链中的共享Buffer数量。

参数说明

返回值说明

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

acltdtGetBufFromChain

aclError acltdtGetBufFromChain(acltdtBuf headBuf, uint32_t index, acltdtBuf *buf)

产品支持情况

功能说明

获取Mbuf链中第index个Mbuf。

参数说明

返回值说明

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

【免费下载链接】runtime本项目提供CANN运行时组件和维测功能组件。项目地址: https://gitcode.com/cann/runtime