hm_liteipc.h 文件参考

浏览源代码.

结构体
struct	HandleInfo
struct	IpcPool
	LiteIPC的核心思想就是在内核态为每个Service任务维护一个IPC消息队列，该消息队列通过LiteIPC设备文件向上层 用户态程序分别提供代表收取IPC消息的读操作和代表发送IPC消息的写操作。 更多...
struct	ProcIpcInfo
	进程IPC信息,见于进程结构体: LosProcessCB.ipcInfo 更多...
struct	IpcTaskInfo
struct	BuffPtr
struct	SvcIdentity
	SVC(service)服务身份证 更多...
union	ObjContent
	对象内容体,注意是个联合体 更多...
struct	SpecialObj
	指定对象 更多...
struct	IpcVersion
struct	CmsCmdContent
struct	IpcMsg
struct	IpcListNode
struct	IpcContent
	IPC消息内容结构体,记录消息周期 更多...

枚举
enum	HandleStatus { HANDLE_NOT_USED , HANDLE_REGISTING , HANDLE_REGISTED }
	句柄状态 更多...
enum	ObjType { OBJ_FD , OBJ_PTR , OBJ_SVC }
enum	MsgType {   MT_REQUEST , MT_REPLY , MT_FAILED_REPLY , MT_DEATH_NOTIFY ,   MT_NUM }
	消息的类型 更多...
enum	CmsCmd { CMS_GEN_HANDLE , CMS_REMOVE_HANDLE , CMS_ADD_ACCESS }
enum	IpcFlag { LITEIPC_FLAG_DEFAULT = 0 , LITEIPC_FLAG_ONEWAY }

函数
UINT32	OsLiteIpcInit (VOID)
	OsLiteIpcInit 初始化LiteIPC模块 更多...
ProcIpcInfo *	LiteIpcPoolReInit (const ProcIpcInfo *parentIpcInfo)
	LiteIpcPoolReInit 重新初始化进程的IPC消息内存池 更多...
VOID	LiteIpcRemoveServiceHandle (UINT32 taskID)
	删除指定的Service 更多...
UINT32	LiteIpcPoolDestroy (UINT32 processID)
	销毁指定进程的IPC池 更多...

枚举类型说明

CmsCmd

enum CmsCmd

枚举值
CMS_GEN_HANDLE	创建/注册服务
CMS_REMOVE_HANDLE	删除服务
CMS_ADD_ACCESS	为服务添加权限

在文件 hm_liteipc.h 第 154 行定义.

             {//CMS 命令类型
    CMS_GEN_HANDLE, ///< 创建/注册服务
    CMS_REMOVE_HANDLE, ///< 删除服务
    CMS_ADD_ACCESS ///< 为服务添加权限
} CmsCmd;

HandleStatus

enum HandleStatus

句柄状态

枚举值
HANDLE_NOT_USED	未使用
HANDLE_REGISTING	注册中
HANDLE_REGISTED	已注册

在文件 hm_liteipc.h 第 61 行定义.

             {
    HANDLE_NOT_USED,    ///< 未使用
    HANDLE_REGISTING,   ///< 注册中
    HANDLE_REGISTED     ///< 已注册
} HandleStatus;

IpcFlag

enum IpcFlag

枚举值
LITEIPC_FLAG_DEFAULT
LITEIPC_FLAG_ONEWAY

在文件 hm_liteipc.h 第 166 行定义.

             {
    LITEIPC_FLAG_DEFAULT = 0, // send and reply | 发送并回复
    LITEIPC_FLAG_ONEWAY,      // send message only | 仅发送信息
} IpcFlag;

MsgType

enum MsgType

消息的类型

枚举值
MT_REQUEST	请求
MT_REPLY	回复
MT_FAILED_REPLY	回复失败
MT_DEATH_NOTIFY	死亡通知
MT_NUM

在文件 hm_liteipc.h 第 135 行定义.

             {  
    MT_REQUEST, ///< 请求
    MT_REPLY,   ///< 回复
    MT_FAILED_REPLY,///< 回复失败
    MT_DEATH_NOTIFY,///< 死亡通知
    MT_NUM
} MsgType;

ObjType

enum ObjType

枚举值
OBJ_FD	文件句柄
OBJ_PTR	指针
OBJ_SVC	服务

在文件 hm_liteipc.h 第 104 行定义.

             {
    OBJ_FD,     ///< 文件句柄
    OBJ_PTR,    ///< 指针
    OBJ_SVC     ///< 服务
} ObjType;

函数说明

LiteIpcPoolDestroy()

UINT32 LiteIpcPoolDestroy

(

UINT32

processID

)

销毁指定进程的IPC池

在文件 hm_liteipc.c 第 386 行定义.

{
    LosProcessCB *pcb = OS_PCB_FROM_PID(processID);
 
    if (pcb->ipcInfo == NULL) {
        return LOS_NOK;
    }
 
    LiteIpcPoolDelete(pcb->ipcInfo, pcb->processID);
    LOS_MemFree(m_aucSysMem1, pcb->ipcInfo);
    pcb->ipcInfo = NULL;
    return LOS_OK;
}

函数调用图:

这是这个函数的调用关系图:

LiteIpcPoolReInit()

ProcIpcInfo * LiteIpcPoolReInit

(

const ProcIpcInfo *

parent

)

LiteIpcPoolReInit 重新初始化进程的IPC消息内存池

参数

parent

返回

参见

在文件 hm_liteipc.c 第 346 行定义.

{
    ProcIpcInfo *ipcInfo = LiteIpcPoolCreate();
    if (ipcInfo == NULL) {
        return NULL;
    }
 
    ipcInfo->pool.uvaddr = parent->pool.uvaddr;//用户空间地址继续沿用
    ipcInfo->pool.kvaddr = NULL;
    ipcInfo->pool.poolSize = 0;
    ipcInfo->ipcTaskID = INVAILD_ID;
    return ipcInfo;
}

函数调用图:

这是这个函数的调用关系图:

LiteIpcRemoveServiceHandle()

VOID LiteIpcRemoveServiceHandle

(

UINT32

taskID

)

删除指定的Service

在文件 hm_liteipc.c 第 661 行定义.

{
    UINT32 j;
    LosTaskCB *taskCB = OS_TCB_FROM_TID(taskID);
    IpcTaskInfo *ipcTaskInfo = taskCB->ipcTaskInfo;
    if (ipcTaskInfo == NULL) {
        return;
    }
 
#if (USE_TASKID_AS_HANDLE == 1) // 任务ID当做句柄使用
 
    UINT32 intSave;
    LOS_DL_LIST *listHead = NULL;
    LOS_DL_LIST *listNode = NULL;
    IpcListNode *node = NULL;
    UINT32 processID = taskCB->processID;
 
    listHead = &(ipcTaskInfo->msgListHead);// ipc 节点链表
    do {// 循环删除 任务IPC上挂的各个节点
        SCHEDULER_LOCK(intSave);
        if (LOS_ListEmpty(listHead)) {//空判
            SCHEDULER_UNLOCK(intSave);
            break;
        } else {
            listNode = LOS_DL_LIST_FIRST(listHead); //拿到首个节点
            LOS_ListDelete(listNode); //删除节点
            node = LOS_DL_LIST_ENTRY(listNode, IpcListNode, listNode);//获取节点所在结构体 IpcListNode
            SCHEDULER_UNLOCK(intSave);
            (VOID)HandleSpecialObjects(taskCB->taskID, node, TRUE);//处理节点
            (VOID)LiteIpcNodeFree(processID, (VOID *)node);//释放节点占用的进程空间
        }
    } while (1);
 
    ipcTaskInfo->accessMap[processID] = FALSE;
    for (j = 0; j < MAX_SERVICE_NUM; j++) {
        if (ipcTaskInfo->accessMap[j] == TRUE) {
            ipcTaskInfo->accessMap[j] = FALSE;
            (VOID)SendDeathMsg(j, taskCB->taskID); //给进程发送taskCB死亡的消息
        }
    }
#else 
    (VOID)LOS_MuxLock(&g_serviceHandleMapMux, LOS_WAIT_FOREVER);
    for (UINT32 i = 1; i < MAX_SERVICE_NUM; i++) {
        if ((g_serviceHandleMap[i].status != HANDLE_NOT_USED) && (g_serviceHandleMap[i].taskID == taskCB->taskID)) {
            g_serviceHandleMap[i].status = HANDLE_NOT_USED;
            g_serviceHandleMap[i].taskID = INVAILD_ID;
            break;
        }
    }
    (VOID)LOS_MuxUnlock(&g_serviceHandleMapMux);
    /* run deathHandler */
    if (i < MAX_SERVICE_NUM) {
        for (j = 0; j < MAX_SERVICE_NUM; j++) {
            if (ipcTaskInfo->accessMap[j] == TRUE) {
                (VOID)SendDeathMsg(j, i);
            }
        }
    }
#endif
 
    (VOID)LOS_MemFree(m_aucSysMem1, ipcTaskInfo);
    taskCB->ipcTaskInfo = NULL;
}

函数调用图:

这是这个函数的调用关系图:

OsLiteIpcInit()

UINT32 OsLiteIpcInit

(

VOID

)

OsLiteIpcInit 初始化LiteIPC模块

返回

参见

在文件 hm_liteipc.c 第 147 行定义.

{
    UINT32 ret;
#if (USE_TASKID_AS_HANDLE == 1) //两种管理方式,一种是 任务ID == service ID 
    g_cmsTask.status = HANDLE_NOT_USED;//默认未使用
#else
    (void)memset_s(g_serviceHandleMap, sizeof(g_serviceHandleMap), 0, sizeof(g_serviceHandleMap));
#endif
    ret = LOS_MuxInit(&g_serviceHandleMapMux, NULL);
    if (ret != LOS_OK) {
        return ret;
    }
    ret = (UINT32)register_driver(LITEIPC_DRIVER, &g_liteIpcFops, LITEIPC_DRIVER_MODE, NULL);//注册字符驱动程序,从此支持文件访问LiteIpc
    if (ret != LOS_OK) {
        PRINT_ERR("register lite_ipc driver failed:%d\n", ret);
    }
    LOS_ListInit(&(g_ipcPendlist));
 
    return ret;
}

函数调用图: