目录

ddk_api.h

概述

声明主机侧访问的Base DDK接口。提供共享内存的创建、映射、销毁等功能，支持开发者在驱动程序中高效管理共享内存资源，适用于需要与驱动侧共享数据的场景，有助于简化内存管理、提升数据传输效率。

引用文件： <ddk/ddk_api.h>

库： libddk_base.z.so

系统能力： SystemCapability.Driver.DDK.Extension

起始版本： 12

相关模块： Ddk

汇总

[h2]函数

名称 描述
DDK_RetCode OH_DDK_CreateAshmem(const uint8_t *name, uint32_t size, DDK_Ashmem **ashmem) 创建共享内存。为了防止资源泄漏，应通过调用OH_DDK_DestroyAshmem接口来销毁不再需要的共享内存。
DDK_RetCode OH_DDK_MapAshmem(DDK_Ashmem *ashmem, const uint8_t ashmemMapType) 映射创建的共享内存到用户空间。需先调用OH_DDK_CreateAshmem接口创建共享内存。通过调用OH_DDK_UnmapAshmem接口取消映射不需要的共享内存。
DDK_RetCode OH_DDK_UnmapAshmem(DDK_Ashmem *ashmem) 取消映射共享内存。需先调用OH_DDK_MapAshmem接口映射共享内存。不再访问共享内存时应取消映射，以节省地址空间。
DDK_RetCode OH_DDK_DestroyAshmem(DDK_Ashmem *ashmem) 销毁由OH_DDK_CreateAshmem创建的共享内存。建议先调用OH_DDK_UnmapAshmem接口取消映射。共享内存不再使用时应及时销毁以释放系统资源。

函数说明

[h2]OH_DDK_CreateAshmem()

DDK_RetCode OH_DDK_CreateAshmem(const uint8_t *name, uint32_t size, DDK_Ashmem **ashmem)

描述

创建共享内存。为了防止资源泄漏，应通过调用OH_DDK_DestroyAshmem接口来销毁不再需要的共享内存。

起始版本： 12

参数：

参数项 描述
const uint8_t *name 指向共享内存名称字符串的指针，该名称用于标识共享内存。name不能为NULL，建议使用具有唯一性的名称以避免冲突。
uint32_t size 共享内存对应的缓冲区大小（单位：字节），必须大于0，过大会导致内存占用过高，影响运行性能。
DDK_Ashmem **ashmem 用于输出创建的共享内存对象的指针。

返回：

类型 说明
DDK_RetCode

DDK_SUCCESS 调用接口成功。共享内存已成功创建并初始化完成。

DDK_INVALID_PARAMETER 入参name为空指针，size的大小为0或者入参ashmem是空指针。请检查传入的参数值。

DDK_FAILURE 创建共享内存失败或者创建结构体DDK_Ashmem失败。请检查申请的内存大小和权限。

[h2]OH_DDK_MapAshmem()

DDK_RetCode OH_DDK_MapAshmem(DDK_Ashmem *ashmem, const uint8_t ashmemMapType)

描述

映射创建的共享内存到用户空间。需先调用OH_DDK_CreateAshmem接口创建共享内存。通过调用OH_DDK_UnmapAshmem接口取消映射不需要的共享内存。

起始版本： 12

参数：

参数项 描述
DDK_Ashmem *ashmem 要映射的共享内存描述符指针。
const uint8_t ashmemMapType 共享内存的保护权限值，取值请参考Ashmem保护权限的通用定义范围。

返回：

类型 说明
DDK_RetCode

DDK_SUCCESS 调用接口成功。共享内存已映射到用户空间。

DDK_NULL_PTR 入参ashmem为空指针。请检查传入的参数值。

DDK_FAILURE 共享内存的文件描述符无效或未先创建共享内存。请检查共享内存是否已被创建、确保文件描述符未被关闭。

DDK_INVALID_OPERATION 调用接口映射共享内存失败。可能原因包括映射状态异常或权限不足，请检查共享内存的映射状态和权限后重试。

[h2]OH_DDK_UnmapAshmem()

DDK_RetCode OH_DDK_UnmapAshmem(DDK_Ashmem *ashmem)

描述

取消映射共享内存。需先调用OH_DDK_MapAshmem接口映射共享内存。不再访问共享内存时应取消映射，以节省地址空间。

起始版本： 12

参数：

参数项 描述
DDK_Ashmem *ashmem 要取消映射的共享内存描述符指针。

返回：

类型 说明
DDK_RetCode

DDK_SUCCESS 调用接口成功。共享内存已成功从用户空间取消映射。

DDK_NULL_PTR 入参ashmem为空指针。请检查传入的参数值。

DDK_FAILURE 共享内存的文件描述符无效或未先执行映射。

[h2]OH_DDK_DestroyAshmem()

DDK_RetCode OH_DDK_DestroyAshmem(DDK_Ashmem *ashmem)

描述

销毁由OH_DDK_CreateAshmem创建的共享内存。建议先调用OH_DDK_UnmapAshmem接口取消映射。共享内存不再使用时应及时销毁以释放系统资源。

起始版本： 12

参数：

参数项 描述
DDK_Ashmem *ashmem 要销毁的共享内存描述符指针。

返回：

类型 说明
DDK_RetCode

DDK_SUCCESS 调用接口成功。共享内存已成功销毁释放。

DDK_NULL_PTR 入参ashmem为空指针。请检查传入的参数值。

DDK_FAILURE 共享内存的文件描述符无效。可能原因包括共享内存已被释放或多次销毁，请检查其状态。