LiteOS内核源码分析系列七 互斥锁Mutex

本文为互斥锁系列的第一篇。第二篇请见 LiteOS内核源码分析系列七 互斥锁Mutex (2)

多任务环境下会存在多个任务访问同一公共资源的场景，而有些公共资源是非共享的临界资源，只能被独占使用。LiteOS使用互斥锁来避免这种冲突，互斥锁是一种特殊的二值性信号量，用于实现对临界资源的独占式处理。另外，互斥锁可以解决信号量存在的优先级翻转问题。用互斥锁处理临界资源的同步访问时，如果有任务访问该资源，则互斥锁为加锁状态。此时其他任务如果想访问这个临界资源则会被阻塞，直到互斥锁被持有该锁的任务释放后，其他任务才能重新访问该公共资源，此时互斥锁再次上锁，如此确保同一时刻只有一个任务正在访问这个临界资源，保证了临界资源操作的完整性。

本文我们来一起学习下LiteOS互斥锁模块的源代码，文中所涉及的源代码，均可以在LiteOS开源站点https://gitee.com/LiteOS/LiteOS 获取。互斥锁源代码、开发文档，示例程序代码如下：

• LiteOS内核互斥锁源代码包括互斥锁的私有头文件kernel\base\include\los_mux_pri.h、头文件kernel\include\los_mux.h、C源代码文件kernel\base\los_mux.c。
• 开发指南文档–互斥锁在线文档https://gitee.com/LiteOS/LiteOS/blob/master/doc/LiteOS_Kernel_Developer_Guide.md#%E4%BA%92%E6%96%A5%E9%94%81。

接下来，我们看下互斥锁的结构体，互斥锁初始化，互斥锁常用操作的源代码。

1、互斥锁结构体定义和常用宏定义

1.1 互斥锁结构体定义

在文件kernel\base\include\los_mux_pri.h定义的互斥锁控制块结构体有2个，MuxBaseCB和LosMuxCB，前者和后者的前三个成员一样，可以和pthread_mutex_t共享内核互斥锁机制。结构体源代码如下，结构体成员的解释见注释部分。

typedef struct {
    LOS_DL_LIST muxList; /**< 互斥锁双向链表 */
    LosTaskCB *owner; /**< 当前持有锁的任务 */
    UINT16 muxCount; /**< 锁被持有的次数*/
} MuxBaseCB;

typedef struct {
    LOS_DL_LIST muxList; /**< 互斥锁双向链表 */
    LosTaskCB *owner; /**< 当前持有锁的任务 */
    UINT16 muxCount; /**< 锁被持有的次数*/
    UINT8 muxStat; /**< 互斥锁状态： OS_MUX_UNUSED, OS_MUX_USED */
    UINT32 muxId; /**< 互斥锁Id */
} LosMuxCB;

1.2 互斥锁常用宏定义

系统支持创建多少互斥锁是根据开发板情况使用宏LOSCFG_BASE_IPC_MUX_LIMIT定义的，互斥锁Id是UINT32类型的，由2部分组成：count和muxId，分别处于高16位和低16位。创建互斥锁，使用后删除时，
互斥锁回收到互斥锁池时，互斥锁Id的高16位即count值会加1，这样可以用来表示该互斥锁被创建删除的次数。muxId取值为[0,LOSCFG_BASE_IPC_MUX_LIMIT)，表示互斥锁池中各个的互斥锁的编号。

⑴处的宏用来分割count和muxId的位数，⑵处互斥锁被删除时更新互斥锁Id，可以看出高16位为count和低16位为muxId。⑶处获取互斥锁Id的低16位。⑷根据互斥锁Id获取对应的互斥锁被创建删除的次数count。⑸处从互斥锁池中获取指定互斥锁Id对应的互斥锁控制块。

⑴    #define MUX_SPLIT_BIT 16

⑵    #define SET_MUX_ID(count, muxId)    (((count) << MUX_SPLIT_BIT) | (muxId))

⑶    #define GET_MUX_INDEX(muxId)        ((muxId) & ((1U << MUX_SPLIT_BIT) - 1))

⑷    #define GET_MUX_COUNT(muxId)        ((muxId) >> MUX_SPLIT_BIT)

⑸    #define GET_MUX(muxId)              (((LosMuxCB *)g_allMux) + GET_MUX_INDEX(muxId))

2、互斥锁初始化

互斥锁在内核中默认开启，用户可以通过宏LOSCFG_BASE_IPC_MUX进行关闭。开启互斥锁的情况下，在系统启动时，在kernel\init\los_init.c中调用OsMuxInit()进行互斥锁模块初始化。
下面，我们分析下互斥锁初始化的代码。

⑴初始化双向循环链表g_unusedMuxList，维护未使用的互斥锁。⑵为互斥锁申请内存，如果申请失败，则返回错误LOS_ERRNO_MUX_NO_MEMORY
⑶循环每一个互斥锁进行初始化，为每一个互斥锁节点指定索引muxId，owner为空，muxStat为未使用OS_MUX_UNUSED，并把互斥锁节点插入未使用互斥锁双向链表g_unusedMuxList。
⑷如果开启了互斥锁调测开关，则调用函数UINT32 OsMuxDbgInit(VOID)进行初始化。

LITE_OS_SEC_TEXT UINT32 OsMuxInit(VOID)
{
    LosMuxCB *muxNode = NULL;
    UINT32 index;

⑴  LOS_ListInit(&g_unusedMuxList);
⑵  g_allMux = (LosMuxCB *)LOS_MemAlloc(m_aucSysMem0, (LOSCFG_BASE_IPC_MUX_LIMIT * sizeof(LosMuxCB)));
    if (g_allMux == NULL) {
        return LOS_ERRNO_MUX_NO_MEMORY;
    }

⑶  for (index = 0; index < LOSCFG_BASE_IPC_MUX_LIMIT; index++) {
        muxNode = g_allMux + index;
        muxNode->muxId = index;
        muxNode->owner = NULL;
        muxNode->muxStat = OS_MUX_UNUSED;
        LOS_ListTailInsert(&g_unusedMuxList, &muxNode->muxList);
    }

⑷  if (OsMuxDbgInitHook() != LOS_OK) {
        return LOS_ERRNO_MUX_NO_MEMORY;
    }
    return LOS_OK;

3、互斥锁常用操作

3.1 互斥锁创建

我们可以使用函数UINT32 LOS_MuxCreate(UINT32 *muxHandle)来创建互斥锁，下面通过分析源码看看如何创建互斥锁的。

⑴判断g_unusedMuxList是否为空，还有可以使用的互斥锁资源？如果没有可以使用的互斥锁，调用函数OsMutexCheckHook()判断是否有互斥锁溢出等错误，这个函数需要开启调测开关。
⑵处如果g_unusedMuxList不为空，则获取第一个可用的互斥锁节点，接着从双向链表g_unusedMuxList中删除，然后调用LOS_DL_LIST_ENTRY(unusedMux, LosMuxCB, muxList)获取LosMuxCB *muxCreated
，初始化创建的互斥锁信息，包含持有锁的次数、状态、持有者等信息。⑶初始化双向链表&muxCreated->muxList，阻塞在这个互斥上的任务会挂在这个链表上。⑷赋值给输出参数*muxHandle，后续程序使用这个互斥锁Id对互斥锁进行其他操作。⑸开启调测时，会调用函数OsMuxDbgUpdateHook()更新互斥锁的使用情况。

LITE_OS_SEC_TEXT UINT32 LOS_MuxCreate(UINT32 *muxHandle)
{
    UINT32 intSave;
    LosMuxCB *muxCreated = NULL;
    LOS_DL_LIST *unusedMux = NULL;
    UINT32 errNo;
    UINT32 errLine;

    if (muxHandle == NULL) {
        return LOS_ERRNO_MUX_PTR_NULL;
    }

    SCHEDULER_LOCK(intSave);
⑴  if (LOS_ListEmpty(&g_unusedMuxList)) {
        SCHEDULER_UNLOCK(intSave);
        OsMutexCheckHook();
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_MUX_ALL_BUSY);
    }

⑵  unusedMux = LOS_DL_LIST_FIRST(&g_unusedMuxList);
    LOS_ListDelete(unusedMux);
    muxCreated = LOS_DL_LIST_ENTRY(unusedMux, LosMuxCB, muxList);
    muxCreated->muxCount = 0;
    muxCreated->muxStat = OS_MUX_USED;
    muxCreated->owner = NULL;
⑶  LOS_ListInit(&muxCreated->muxList);
    *muxHandle = muxCreated->muxId;

⑸  OsMuxDbgUpdateHook(muxCreated->muxId, OsCurrTaskGet()->taskEntry);

    SCHEDULER_UNLOCK(intSave);

    LOS_TRACE(MUX_CREATE, muxCreated->muxId);
    return LOS_OK;

ERR_HANDLER:
    OS_RETURN_ERROR_P2(errLine, errNo);
}

3.2 互斥锁删除

我们可以使用函数LOS_MuxDelete(UINT32 muxHandle)来删除互斥锁，下面通过分析源码看看如何删除互斥锁的。

⑴处判断互斥锁handleId是否超过LOSCFG_BASE_IPC_MUX_LIMIT，如果超过则返回错误码。⑵获取互斥锁控制块LosMuxCB *muxDeleted。⑶如果要删除的互斥锁Id有问题，或者要删除的互斥锁处于未使用状态，跳转到错误标签进行处理。⑷如果互斥锁的持有者数量不为空，不允许删除，跳转到错误标签进行处理。⑸把删除的互斥锁回收到未使用互斥锁双向链表g_unusedMuxList，然后更新为未使用状态，更新互斥锁Id。⑹开启调测时，会调用函数OsMuxDbgUpdateHook()更新互斥锁的使用情况。

LITE_OS_SEC_TEXT UINT32 LOS_MuxDelete(UINT32 muxHandle)
{
    UINT32 intSave;
    LosMuxCB *muxDeleted = NULL;
    UINT32 errNo;
    UINT32 errLine;

⑴  if (GET_MUX_INDEX(muxHandle) >= (UINT32)LOSCFG_BASE_IPC_MUX_LIMIT) {
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_MUX_INVALID);
    }

⑵  muxDeleted = GET_MUX(muxHandle);

    LOS_TRACE(MUX_DELETE, muxHandle, muxDeleted->muxStat, muxDeleted->muxCount,
        ((muxDeleted->owner == NULL) ? 0xFFFFFFFF : muxDeleted->owner->taskId));

    SCHEDULER_LOCK(intSave);
⑶  if ((muxDeleted->muxId != muxHandle) || (muxDeleted->muxStat == OS_MUX_UNUSED)) {
        SCHEDULER_UNLOCK(intSave);
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_MUX_INVALID);
    }

⑷  if (!LOS_ListEmpty(&muxDeleted->muxList) || muxDeleted->muxCount) {
        SCHEDULER_UNLOCK(intSave);
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_MUX_PENDED);
    }

⑸  LOS_ListTailInsert(&g_unusedMuxList, &muxDeleted->muxList);
    muxDeleted->muxStat = OS_MUX_UNUSED;
    muxDeleted->muxId = SET_MUX_ID(GET_MUX_COUNT(muxDeleted->muxId) + 1, GET_MUX_INDEX(muxDeleted->muxId));

⑹  OsMuxDbgUpdateHook(muxDeleted->muxId, NULL);

    SCHEDULER_UNLOCK(intSave);

    return LOS_OK;

ERR_HANDLER:
    OS_RETURN_ERROR_P2(errLine, errNo);
}