鸿蒙轻内核M核源码分析系列十一 信号量Semaphore

信号量（Semaphore）是一种实现任务间通信的机制，可以实现任务间同步或共享资源的互斥访问。一个信号量的数据结构中，通常有一个计数值，用于对有效资源数的计数，表示剩下的可被使用的共享资源数。以同步为目的的信号量和以互斥为目的的信号量在使用上存在差异。本文通过分析鸿蒙轻内核信号量模块的源码，掌握信号量使用上的差异。本文中所涉及的源码，以OpenHarmony LiteOS-M内核为例，均可以在开源站点https://gitee.com/openharmony/kernel_liteos_m 获取。

接下来，我们看下信号量的结构体，信号量初始化，信号量常用操作的源代码。

1、信号量结构体定义和常用宏定义

1.1 信号量结构体定义

在文件kernel\include\los_sem.h定义的信号量控制块结构体为LosSemCB，结构体源代码如下。信号量状态.semStat取值OS_SEM_UNUSED、OS_SEM_USED，其他成员变量的注释见注释部分。

typedef struct {
    UINT16 semStat;      /**< 信号量状态 */
    UINT16 semCount;     /**< 可用的信号量数量 */
    UINT16 maxSemCount;  /**< 可用的信号量最大数量 */
    UINT16 semID;        /**< 信号量Id */
    LOS_DL_LIST semList; /**< 阻塞在该信号量的任务链表 */
} LosSemCB;

1.2 信号量常用宏定义

系统支持创建多少信号量是根据开发板情况使用宏LOSCFG_BASE_IPC_SEM_LIMIT定义的，每一个信号量semId是UINT32类型的，取值为[0,LOSCFG_BASE_IPC_SEM_LIMIT)，表示信号量池中各个的信号量的编号。

⑴处的宏表示二值信号量的最大值为1，⑵处、⑶处的宏表示信号量未使用、使用状态值。⑷处根据信号量阻塞任务双向链表中的链表节点指针ptr获取信号量控制块结构体指针。⑸处从信号量池中获取指定信号量semId对应的信号量控制块。

⑴    #define OS_SEM_BINARY_MAX_COUNT     1

⑵    #define OS_SEM_UNUSED               0

⑶    #define OS_SEM_USED                 1

⑷    #define GET_SEM_LIST(ptr) LOS_DL_LIST_ENTRY(ptr, LosSemCB, semList)

⑸    #define GET_SEM(semid) (((LosSemCB *)g_allSem) + (semid))

2、信号量初始化

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

⑴初始化双向循环链表g_unusedSemList，维护未使用的信号量池。⑵为信号量池申请内存，如果申请失败，则返回错误。⑶循环每一个信号量进行初始化，为每一个信号量节点指定索引semID，把.semStat设置为未使用OS_SEM_UNUSED，并执行⑷把信号量节点插入未使用信号量双向链表g_unusedSemList。

LITE_OS_SEC_TEXT_INIT UINT32 OsSemInit(VOID)
{
    LosSemCB *semNode = NULL;
    UINT16 index;

⑴  LOS_ListInit(&g_unusedSemList);

    if (LOSCFG_BASE_IPC_SEM_LIMIT == 0) {
        return LOS_ERRNO_SEM_MAXNUM_ZERO;
    }

⑵  g_allSem = (LosSemCB *)LOS_MemAlloc(m_aucSysMem0, (LOSCFG_BASE_IPC_SEM_LIMIT * sizeof(LosSemCB)));
    if (g_allSem == NULL) {
        return LOS_ERRNO_SEM_NO_MEMORY;
    }

⑶  for (index = 0; index < LOSCFG_BASE_IPC_SEM_LIMIT; index++) {
        semNode = ((LosSemCB *)g_allSem) + index;
        semNode->semID = index;
        semNode->semStat = OS_SEM_UNUSED;
⑷      LOS_ListTailInsert(&g_unusedSemList, &semNode->semList);
    }
    return LOS_OK;
}

3、信号量常用操作

3.1 信号量创建

我们可以使用函数LOS_SemCreate(UINT16 count, UINT32 *semHandle)来创建计数信号量，使用UINT32 LOS_BinarySemCreate(UINT16 count, UINT32 *semHandle)创建二值信号量，下面通过分析源码看看如何创建信号量的。

2个函数的传入参数一样，需要传入信号量的数量count，和保存信号量编号的semHandle。计数信号量的最大数量为OS_SEM_COUNTING_MAX_COUNT，二值信号量的最大数量为OS_SEM_BINARY_MAX_COUNT。会进一步调用函数OsSemCreate()实现信号量的创建，下文继续分析。

LITE_OS_SEC_TEXT_INIT UINT32 LOS_SemCreate(UINT16 count, UINT32 *semHandle)
{
    return OsSemCreate(count, OS_SEM_COUNTING_MAX_COUNT, semHandle);
}

LITE_OS_SEC_TEXT_INIT UINT32 LOS_BinarySemCreate(UINT16 count, UINT32 *semHandle)
{
    return OsSemCreate(count, OS_SEM_BINARY_MAX_COUNT, semHandle);
}

我们看看创建信号量的函数OsSemCreate()，需要3个参数，创建的信号量的数量，最大数量，以及信号量编号。

⑴判断g_unusedSemList是否为空，还有可以使用的信号量资源？如果没有可以使用的信号量，调用函数OsSemInfoGetFullDataHook()做些调测相关的检测，这个函数需要开启调测开关，后续系列专门分析。
⑵处如果g_unusedSemList不为空，则获取第一个可用的信号量节点，接着从双向链表g_unusedSemList中删除，然后调用宏GET_SEM_LIST获取LosSemCB *semCreated
，初始化创建的信号量信息，包含信号量的状态、信号量数量，信号量最大数量等信息。⑶初始化双向链表&semCreated->semList，阻塞在这个信号量上的任务会挂在这个链表上。⑷赋值给输出参数*semHandle，后续程序使用这个信号量编号对信号量进行其他操作。

LITE_OS_SEC_TEXT_INIT UINT32 OsSemCreate(UINT16 count, UINT16 maxCount, UINT32 *semHandle)
{
    UINT32 intSave;
    LosSemCB *semCreated = NULL;
    LOS_DL_LIST *unusedSem = NULL;
    UINT32 errNo;
    UINT32 errLine;

    if (semHandle == NULL) {
        return LOS_ERRNO_SEM_PTR_NULL;
    }

    if (count > maxCount) {
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_SEM_OVERFLOW);
    }

    intSave = LOS_IntLock();

⑴  if (LOS_ListEmpty(&g_unusedSemList)) {
        LOS_IntRestore(intSave);
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_SEM_ALL_BUSY);
    }

⑵  unusedSem = LOS_DL_LIST_FIRST(&(g_unusedSemList));
    LOS_ListDelete(unusedSem);
    semCreated = (GET_SEM_LIST(unusedSem));
    semCreated->semCount = count;
    semCreated->semStat = OS_SEM_USED;
    semCreated->maxSemCount = maxCount;
⑶  LOS_ListInit(&semCreated->semList);
⑷  *semHandle = (UINT32)semCreated->semID;
    LOS_IntRestore(intSave);
    OsHookCall(LOS_HOOK_TYPE_SEM_CREATE, semCreated);
    return LOS_OK;

ERR_HANDLER:
    OS_RETURN_ERROR_P2(errLine, errNo);
}

3.2 信号量删除

我们可以使用函数LOS_semDelete(UINT32 semHandle)来删除信号量，下面通过分析源码看看如何删除信号量的。

⑴处判断信号量semHandle是否超过LOSCFG_BASE_IPC_SEM_LIMIT，如果超过则返回错误码。如果信号量编号没有问题，获取信号量控制块LosSemCB *semDeleted。⑵处判断要删除的信号量的状态，如果处于未使用状态，则跳转到错误标签ERR_HANDLER:进行处理。⑶如果信号量的阻塞任务列表不为空，不允许删除，跳转到错误标签进行处理。⑷处如果信号量可用删除，则会把.semStat设置为未使用OS_SEM_UNUSED，并把信号量节点插入未使用信号量双向链表g_unusedSemList。

LITE_OS_SEC_TEXT_INIT UINT32 LOS_SemDelete(UINT32 semHandle)
{
    UINT32 intSave;
    LosSemCB *semDeleted = NULL;
    UINT32 errNo;
    UINT32 errLine;

⑴  if (semHandle >= (UINT32)LOSCFG_BASE_IPC_SEM_LIMIT) {
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_SEM_INVALID);
    }

    semDeleted = GET_SEM(semHandle);
    intSave = LOS_IntLock();
⑵  if (semDeleted->semStat == OS_SEM_UNUSED) {
        LOS_IntRestore(intSave);
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_SEM_INVALID);
    }

⑶  if (!LOS_ListEmpty(&semDeleted->semList)) {
        LOS_IntRestore(intSave);
        OS_GOTO_ERR_HANDLER(LOS_ERRNO_SEM_PENDED);
    }

⑷  LOS_ListAdd(&g_unusedSemList, &semDeleted->semList);
    semDeleted->semStat = OS_SEM_UNUSED;
    LOS_IntRestore(intSave);
    OsHookCall(LOS_HOOK_TYPE_SEM_DELETE, semDeleted);
    return LOS_OK;
ERR_HANDLER:
    OS_RETURN_ERROR_P2(errLine, errNo);
}

3.3 信号量申请

我们可以使用函数UINT32 LOS_SemPend(UINT32 semHandle, UINT32 timeout)来请求信号量，需要的2个参数分别是信号量semHandle和等待时间timeout，取值范围为[0, LOS_WAIT_FOREVER]，单位为Tick。下面通过分析源码看看如何请求信号量的。

申请信号量时首先会进行信号量编号、参数的合法性校验。⑴处代码表示信号量如果大于配置的最大值，则返回错误码。⑵处获取要申请的信号量控制块semPended。⑶处调用函数对信号量控制块进行校验，如果信号量未创建，处于中断处理期间，处于锁任务调度期间，则返回错误码。⑷处如果校验不通过，跳转到ERROR_SEM_PEND:标签停止信号量的申请。

⑸如果信号量计数大于0，信号量计数减1，返回申请成功的结果。⑹如果信号量计数等于0，并且零等待时间timeout，则返回结果码LOS_ERRNO_SEM_UNAVAILABLE。⑺如果申请的信号量被全部占用，需要等待时，把当前任务阻塞的信号量.taskSem标记为申请的信号量，然后调用函数OsSchedTaskWait()，该函数详细代码上文已分析，把当前任务状态设置为阻塞状态，加入信号量的阻塞链表.semList。如果不是永久等待LOS_WAIT_FOREVER，还需要更改任务状态为OS_TASK_STATUS_PEND_TIME，并且设置waitTimes等待时间。⑻处触发任务调度进行任务切换，暂时不执行后续代码。

如果等待时间超时，信号量还不可用，本任务获取不到信号量时，继续执行⑼，更改任务状态，返回错误码。如果信号量可用，执行⑽，本任务获取到信号量，返回申请成功。

LITE_OS_SEC_TEXT UINT32 LOS_SemPend(UINT32 semHandle, UINT32 timeout)
{
    UINT32 intSave;
    LosSemCB *semPended = NULL;
    UINT32 retErr;
    LosTaskCB *runningTask = NULL;

⑴  if (semHandle >= (UINT32)LOSCFG_BASE_IPC_SEM_LIMIT) {
        OS_RETURN_ERROR(LOS_ERRNO_SEM_INVALID);
    }

⑵  semPended = GET_SEM(semHandle);
    intSave = LOS_IntLock();

⑶  retErr = OsSemValidCheck(semPended);
    if (retErr) {
⑷      goto ERROR_SEM_PEND;
    }

⑸  if (semPended->semCount > 0) {
        semPended->semCount--;
        LOS_IntRestore(intSave);
        OsHookCall(LOS_HOOK_TYPE_SEM_PEND, semPended, runningTask);
        return LOS_OK;
    }

⑹  if (!timeout) {
        retErr = LOS_ERRNO_SEM_UNAVAILABLE;
        goto ERROR_SEM_PEND;
    }

⑺  runningTask = (LosTaskCB *)g_losTask.runTask;
    runningTask->taskSem = (VOID *)semPended;
    OsSchedTaskWait(&semPended->semList, timeout);
    LOS_IntRestore(intSave);
    OsHookCall(LOS_HOOK_TYPE_SEM_PEND, semPended, runningTask);
⑻  LOS_Schedule();

    intSave = LOS_IntLock();
⑼  if (runningTask->taskStatus & OS_TASK_STATUS_TIMEOUT) {
        runningTask->taskStatus &= (~OS_TASK_STATUS_TIMEOUT);
        retErr = LOS_ERRNO_SEM_TIMEOUT;
        goto ERROR_SEM_PEND;
    }

    LOS_IntRestore(intSave);
⑽  return LOS_OK;

ERROR_SEM_PEND:
    LOS_IntRestore(intSave);
    OS_RETURN_ERROR(retErr);
}

3.4 信号量释放

我们可以使用函数UINT32 LOS_semPost(UINT32 semHandle)来释放信号量，下面通过分析源码看看如何释放信号量的。

释放信号量时首先会进行信号量编号、参数的合法性校验，这些比较简单，自行阅读即可。⑴处验判断是否信号量溢出。⑵如果信号量的任务阻塞链表不为空，执行⑶从阻塞链表中获取第一个任务，设置.taskSem为NULL，不再阻塞信号量。执行⑷把获取到信号量的任务调整其状态，并加入就行队列。⑸触发任务调度进行任务切换。⑹如果信号量的任务阻塞链表为空，则把信号量的计数加1。

LITE_OS_SEC_TEXT UINT32 LOS_SemPost(UINT32 semHandle)
{
    UINT32 intSave;
    LosSemCB *semPosted = GET_SEM(semHandle);
    LosTaskCB *resumedTask = NULL;

    if (semHandle >= LOSCFG_BASE_IPC_SEM_LIMIT) {
        return LOS_ERRNO_SEM_INVALID;
    }

    intSave = LOS_IntLock();

    if (semPosted->semStat == OS_SEM_UNUSED) {
        LOS_IntRestore(intSave);
        OS_RETURN_ERROR(LOS_ERRNO_SEM_INVALID);
    }

⑴  if (semPosted->maxSemCount == semPosted->semCount) {
        LOS_IntRestore(intSave);
        OS_RETURN_ERROR(LOS_ERRNO_SEM_OVERFLOW);
    }
⑵  if (!LOS_ListEmpty(&semPosted->semList)) {
⑶      resumedTask = OS_TCB_FROM_PENDLIST(LOS_DL_LIST_FIRST(&(semPosted->semList)));
        resumedTask->taskSem = NULL;
⑷      OsSchedTaskWake(resumedTask);

        LOS_IntRestore(intSave);
        OsHookCall(LOS_HOOK_TYPE_SEM_POST, semPosted, resumedTask);
⑸      LOS_Schedule();
    } else {
⑹      semPosted->semCount++;
        LOS_IntRestore(intSave);
        OsHookCall(LOS_HOOK_TYPE_SEM_POST, semPosted, resumedTask);
    }

    return LOS_OK;
}

4、信号量使用总结

4.1 计数信号量、二值信号量和互斥锁

计数信号量和二值信号量唯一的区别就是信号量的初始数量不一致，二值信号量初始数量只能为0和1，计数信号量的初始值可以为0和大于1的整数。

互斥锁可以理解为一种特性的二值信号量，在实现实现对临界资源的独占式处理、互斥场景时，没有本质的区别。比对下二值的结构体，互斥锁的成员变量.muxCount表示加锁的次数，信号量的成员变量.semCount表示信号量的计数，含义稍有不同。

4.2 信号量的互斥和同步

信号量可用用于互斥和同步两种场景，以同步为目的的信号量和以互斥为目的的信号量在使用上，有如下不同：

• 用于互斥的信号量

  初始信号量计数值不为0，表示可用的共享资源个数。在需要使用共享资源前，先获取信号量，然后使用一个共享资源，使用完毕后释放信号量。这样在共享资源被取完，即信号量计数减至0时，其他需要获取信号量的任务将被阻塞，从而保证了共享资源的互斥访问。对信号量的申请和释放，需要成对出现，在同一个任务里完成申请和释放。

• 用于同步的信号量

  多任务同时访问同一份共享资源时，会导致冲突，这时候就需要引入任务同步机制使得各个任务按业务需求一个一个的对共享资源进行有序访问操作。任务同步的实质就是任务按需进行排队。

  用于同步的信号量，初始信号量计数值为0。任务1申请信号量而阻塞，直到任务2或者某中断释放信号量，任务1才得以进入Ready或Running态，从而达到了任务间的同步。信号量的能不能申请成功，依赖其他任务是否释放信号量，申请和释放在不同的任务里完成。

小结

本文带领大家一起剖析了鸿蒙轻内核的信号量模块的源代码，包含信号量的结构体、信号量池初始化、信号量创建删除、申请释放等。感谢阅读，如有任何问题、建议，都可以留言给我们： https://gitee.com/openharmony/kernel_liteos_m/issues 。为了更容易找到鸿蒙轻内核代码仓，建议访问 https://gitee.com/openharmony/kernel_liteos_m ，关注Watch、点赞Star、并Fork到自己账户下，谢谢。