鸿蒙轻内核M核源码分析系列十二事件Event

开发 前端
本文带领大家一起剖析鸿蒙轻内核的事件模块的源代码,包含事件的结构体、事件初始化、事件创建删除、申请释放等。

[[403496]]

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com

事件(Event)是一种任务间通信的机制,可用于任务间的同步。多任务环境下,任务之间往往需要同步操作,一个等待即是一个同步。事件可以提供一对多、多对多的同步操作。本文通过分析鸿蒙轻内核事件模块的源码,深入掌握事件的使用。

接下来,我们看下事件的结构体,事件初始化,事件常用操作的源代码。

1、事件结构体定义和常用宏定义

1.1 事件结构体定义

在文件kernel\include\los_event.h定义的事件控制块结构体为EVENT_CB_S,结构体源代码如下,结构体成员的解释见注释部分。

  1. typedef struct tagEvent { 
  2.     UINT32 uwEventID;        /**< 事件ID,每一位标识一种事件类型 */ 
  3.     LOS_DL_LIST stEventList; /**< 读取事件的任务链表 */ 
  4. } EVENT_CB_S, *PEVENT_CB_S; 

 1.2 事件常用宏定义

在读事件时,可以选择读取模式。读取模式由如下几个宏定义:

所有事件(LOS_WAITMODE_AND):

逻辑与,基于接口传入的事件类型掩码eventMask,只有这些事件都已经发生才能读取成功,否则该任务将阻塞等待或者返回错误码。

任一事件(LOS_WAITMODE_OR):

逻辑或,基于接口传入的事件类型掩码eventMask,只要这些事件中有任一种事件发生就可以读取成功,否则该任务将阻塞等待或者返回错误码。

清除事件(LOS_WAITMODE_CLR):

这是一种附加读取模式,需要与所有事件模式或任一事件模式结合使用(LOS_WAITMODE_AND | LOS_WAITMODE_CLR或 LOS_WAITMODE_OR | LOS_WAITMODE_CLR)。在这种模式下,当设置的所有事件模式或任一事件模式读取成功后,会自动清除事件控制块中对应的事件类型位。

  1. #define LOS_WAITMODE_AND                   (4) 
  2.  
  3.   #define LOS_WAITMODE_OR                    (2) 
  4.  
  5.   #define LOS_WAITMODE_CLR                   (1) 

 2、事件常用操作

2.1 初始化事件

在使用事件前,必须使用函数UINT32 LOS_EventInit(PEVENT_CB_S eventCB)来初始化事件,需要的参数是结构体指针变量PEVENT_CB_S eventCB。分析下代码,⑴处表示传入的参数不能为空,否则返回错误码。⑵处把事件编码.uwEventID初始化为0,然后初始化双向循环链表.stEventList,用于挂载读取事件的任务。

  1. LITE_OS_SEC_TEXT_INIT UINT32 LOS_EventInit(PEVENT_CB_S eventCB) 
  2. ⑴  if (eventCB == NULL) { 
  3.         return LOS_ERRNO_EVENT_PTR_NULL; 
  4.     } 
  5. ⑵  eventCB->uwEventID = 0; 
  6.     LOS_ListInit(&eventCB->stEventList); 
  7.     OsHookCall(LOS_HOOK_TYPE_EVENT_INIT); 
  8.     return LOS_OK; 

 2.2 校验事件掩码

我们可以使用函数UINT32 LOS_EventPoll(UINT32 *eventId, UINT32 eventMask, UINT32 mode)来校验事件掩码,需要的参数为事件结构体的事件编码eventId、用户传入的待校验的事件掩码eventMask及读取模式mode,返回用户传入的事件是否发生: 返回值为0时,表示用户预期的事件没有发生,否则表示用户期望的事件发生。

我们看下源码,⑴处先检查传入参数的合法性,事件编码不能为空。然后执行⑵处的代码进行校验。如果是任一事件读取模式,接下来的判断不等于表示至少有一个事件发生了,返回值ret就表示哪些事件发生了。⑶如果是所有事情读取模式,当逻辑与运算*eventId & eventMask还等于eventMask时,表示期望的事件全部发生了,返回值ret就表示哪些事件发生了。⑷处当ret不为0,期望的事件发生,并且是清除事件读取模式时,需要把已经发生的事情进行清除。看来,这个函数不仅仅是查询事件有没有发生,还会有更新事件编码的动作。

  1. LITE_OS_SEC_TEXT UINT32 LOS_EventPoll(UINT32 *eventID, UINT32 eventMask, UINT32 mode) 
  2.     UINT32 ret = 0; 
  3.     UINT32 intSave; 
  4.  
  5. ⑴  if (eventID == NULL) { 
  6.         return LOS_ERRNO_EVENT_PTR_NULL; 
  7.     } 
  8.     intSave = LOS_IntLock(); 
  9. ⑵  if (mode & LOS_WAITMODE_OR) { 
  10.         if ((*eventID & eventMask) != 0) { 
  11.             ret = *eventID & eventMask; 
  12.         } 
  13.     } else { 
  14. ⑶      if ((eventMask != 0) && (eventMask == (*eventID & eventMask))) { 
  15.             ret = *eventID & eventMask; 
  16.         } 
  17.     } 
  18. ⑷  if (ret && (mode & LOS_WAITMODE_CLR)) { 
  19.         *eventID = *eventID & ~(ret); 
  20.     } 
  21.     LOS_IntRestore(intSave); 
  22.     return ret; 

2.3 读/写事件

2.3.1 读取指定事件类型

我们可以使用函数LOS_EventRead()来读取事件,需要4个参数。eventCB是初始化好的事件结构体,eventMask表示需要读取的事件掩码,mode是上文说明过的读取模式,timeout是读取超时,单位是Tick。函数返回0时,表示期望的事件没有发生,读取事件失败,进入阻塞。返回非0时表示期望的事件发生了,成功读取事件。下面我们分析下函数的源码来看看如何读取事件的。

⑴处调用函数OsEventReadParamCheck()进行基础的校验,比如第25位保留不能使用,事件掩码eventMask不能为零,读取模式组合是否合法。⑵处表示不能中断中读取事件。⑶处调用校验函数OsEventPoll()检查事件eventMask是否发生。如果事件发生ret不为0,成功读取直接返回。ret为0,事件没有发生时,执行⑷,如果超时时间timeout为0,调用者不能等待时,直接返回。⑸如果锁任务调度时,不能读取事件,返回错误码。

⑹更新当前任务的阻塞的事件掩码.eventMask和事件读取模式.eventMode。执行⑺调用函数OsSchedTaskWait更改当前任务的状态为阻塞状态,挂载到事件的任务阻塞链表上。如果timeout不是永久等待,还会把任务设置为OS_TASK_STATUS_PEND_TIME状态并设置等待时间。⑻处触发任务调度,后续程序需要等到读取到事件才会继续执行。

⑼如果等待时间超时,事件还不可读,本任务读取不到指定的事件时,返回错误码。如果可以读取到指定的事件时,执行⑽,检查事件eventMask是否发生,然后返回结果值。

  1. LITE_OS_SEC_TEXT UINT32 LOS_EventRead(PEVENT_CB_S eventCB, UINT32 eventMask, UINT32 mode, UINT32 timeOut) 
  2.     UINT32 ret; 
  3.     UINT32 intSave; 
  4.     LosTaskCB *runTsk = NULL
  5.  
  6. ⑴  ret = OsEventReadParamCheck(eventCB, eventMask, mode); 
  7.     if (ret != LOS_OK) { 
  8.         return ret; 
  9.     } 
  10.  
  11. ⑵  if (OS_INT_ACTIVE) { 
  12.         return LOS_ERRNO_EVENT_READ_IN_INTERRUPT; 
  13.     } 
  14.     intSave = LOS_IntLock(); 
  15. ⑶  ret = LOS_EventPoll(&(eventCB->uwEventID), eventMask, mode); 
  16.     OsHookCall(LOS_HOOK_TYPE_EVENT_READ, eventCB, eventMask, mode); 
  17.     if (ret == 0) { 
  18. ⑷      if (timeOut == 0) { 
  19.             LOS_IntRestore(intSave); 
  20.             return ret; 
  21.         } 
  22.  
  23. ⑸      if (g_losTaskLock) { 
  24.             LOS_IntRestore(intSave); 
  25.             return LOS_ERRNO_EVENT_READ_IN_LOCK; 
  26.         } 
  27.         runTsk = g_losTask.runTask; 
  28. ⑹      runTsk->eventMask = eventMask; 
  29.         runTsk->eventMode = mode; 
  30. ⑺      OsSchedTaskWait(&eventCB->stEventList, timeOut); 
  31.         LOS_IntRestore(intSave); 
  32. ⑻      LOS_Schedule(); 
  33.  
  34. ⑼      intSave = LOS_IntLock(); 
  35.         if (runTsk->taskStatus & OS_TASK_STATUS_TIMEOUT) { 
  36.             runTsk->taskStatus &= ~OS_TASK_STATUS_TIMEOUT; 
  37.             LOS_IntRestore(intSave); 
  38.             return LOS_ERRNO_EVENT_READ_TIMEOUT; 
  39.         } 
  40.  
  41. ⑽      ret = LOS_EventPoll(&eventCB->uwEventID, eventMask, mode); 
  42.     } 
  43.  
  44.     LOS_IntRestore(intSave); 
  45.     return ret; 

 2.3.2 写入指定的事件类型

我们可以使用函数UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events)来写入指定的事件类型。代码如下所示:

下面通过分析源码来看看如何写入事件类型的。⑴处代码把事件结构体的事件掩码和要写入的事件类型events进行逻辑或计算,来完成事件的写入。⑵如果等待事件的任务链表不为空,需要处理写入事件后是否有任务能读取到相应的事件。⑶处for循环依次遍历事件阻塞链表上的任务,⑷获取下一个任务nextTask。⑸处

分不同的读取模式判断事件是否符合任务resumedTask读取事件的要求,如果满足读取事件,执行⑹设置退出标记exitFlag,然后调用函数OsSchedTaskWake()把读取事件的任务更改状态并放入就绪队列,继续执行⑺,遍历事件的阻塞任务链表中的每一个任务。⑻如果有任务读取到事件,需要触发任务调度。

  1. LITE_OS_SEC_TEXT UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events) 
  2.     LosTaskCB *resumedTask = NULL
  3.     LosTaskCB *nextTask = (LosTaskCB *)NULL
  4.     UINT32 intSave; 
  5.     UINT8 exitFlag = 0; 
  6.     if (eventCB == NULL) { 
  7.         return LOS_ERRNO_EVENT_PTR_NULL; 
  8.     } 
  9.     if ((eventCB->stEventList.pstNext == NULL) || (eventCB->stEventList.pstPrev == NULL)) { 
  10.         return LOS_ERRNO_EVENT_NOT_INITIALIZED; 
  11.     } 
  12.     if (events & LOS_ERRTYPE_ERROR) { 
  13.         return LOS_ERRNO_EVENT_SETBIT_INVALID; 
  14.     } 
  15.     intSave = LOS_IntLock(); 
  16. ⑴  eventCB->uwEventID |= events; 
  17.     OsHookCall(LOS_HOOK_TYPE_EVENT_WRITE, eventCB); 
  18. ⑵  if (!LOS_ListEmpty(&eventCB->stEventList)) { 
  19. ⑶      for (resumedTask = LOS_DL_LIST_ENTRY((&eventCB->stEventList)->pstNext, LosTaskCB, pendList); 
  20.              &resumedTask->pendList != (&eventCB->stEventList);) { 
  21. ⑷          nextTask = LOS_DL_LIST_ENTRY(resumedTask->pendList.pstNext, LosTaskCB, pendList); 
  22.  
  23. ⑸          if (((resumedTask->eventMode & LOS_WAITMODE_OR) && (resumedTask->eventMask & events) != 0) || 
  24.                 ((resumedTask->eventMode & LOS_WAITMODE_AND) && 
  25.                  ((resumedTask->eventMask & eventCB->uwEventID) == resumedTask->eventMask))) { 
  26. ⑹              exitFlag = 1; 
  27.  
  28.                 OsSchedTaskWake(resumedTask); 
  29.             } 
  30. ⑺          resumedTask = nextTask; 
  31.         } 
  32.  
  33.         if (exitFlag == 1) { 
  34.             LOS_IntRestore(intSave); 
  35. ⑻          LOS_Schedule(); 
  36.             return LOS_OK; 
  37.         } 
  38.     } 
  39.  
  40.     LOS_IntRestore(intSave); 
  41.     return LOS_OK; 

2.4 清除事件

我们可以使用函数UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 eventMask)来清除指定的事件类型,下面通过分析源码看看如何清除事件类型的。

函数参数为事件结构体eventCB和要清除的事件类型eventMask。清除事件时首先会进行结构体参数是否为空的校验,这些比较简单。⑴处把事件结构体的事件掩码和要清除的事件类型eventMask进行逻辑与计算,来完成事件的清理。

  1. LITE_OS_SEC_TEXT_MINOR UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 eventMask) 
  2.     UINT32 intSave; 
  3.     if (eventCB == NULL) { 
  4.         return LOS_ERRNO_EVENT_PTR_NULL; 
  5.     } 
  6.     intSave = LOS_IntLock(); 
  7. ⑴  eventCB->uwEventID &= eventMask; 
  8.     LOS_IntRestore(intSave); 
  9.     OsHookCall(LOS_HOOK_TYPE_EVENT_CLEAR, eventCB); 
  10.     return LOS_OK; 

 2.5 销毁事件

我们可以使用函数UINT32 LOS_EventDestroy(PEVENT_CB_S eventCB)来销毁指定的事件控制块,下面通过分析源码看看如何销毁事件的。

函数参数为事件结构体,销毁事件时首先会进行结构体参数是否为空的校验,这些比较简单。⑴处如果事件的任务阻塞链表不为空,则不能销毁事件。⑵把事件结构体的读取事件的任务链表stEventList设置为空,完成事件的销毁。

  1. LITE_OS_SEC_TEXT_INIT UINT32 LOS_EventDestroy(PEVENT_CB_S eventCB) 
  2.     UINT32 intSave; 
  3.     if (eventCB == NULL) { 
  4.         return LOS_ERRNO_EVENT_PTR_NULL; 
  5.     } 
  6.     intSave = LOS_IntLock(); 
  7.  
  8. ⑴  if (!LOS_ListEmpty(&eventCB->stEventList)) { 
  9.         LOS_IntRestore(intSave); 
  10.         return LOS_ERRNO_EVENT_SHOULD_NOT_DESTORY; 
  11.     } 
  12. ⑵  eventCB->stEventList.pstNext = (LOS_DL_LIST *)NULL
  13.     eventCB->stEventList.pstPrev = (LOS_DL_LIST *)NULL
  14.     LOS_IntRestore(intSave); 
  15.     OsHookCall(LOS_HOOK_TYPE_EVENT_DESTROY); 
  16.     return LOS_OK; 

 小结

本文带领大家一起剖析了鸿蒙轻内核的事件模块的源代码,包含事件的结构体、事件初始化、事件创建删除、申请释放等。

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com

 

责任编辑:jianghua 来源: 鸿蒙社区
相关推荐

2022-04-13 11:02:12

鸿蒙事件模块事件Event

2022-01-10 15:31:44

鸿蒙HarmonyOS应用

2022-01-12 10:50:23

鸿蒙HarmonyOS应用

2021-06-04 14:15:10

鸿蒙HarmonyOS应用

2021-05-17 09:28:59

鸿蒙HarmonyOS应用

2021-05-08 15:14:50

鸿蒙HarmonyOS应用

2021-05-25 09:28:34

鸿蒙HarmonyOS应用

2021-10-20 16:08:57

鸿蒙HarmonyOS应用

2021-05-31 20:30:55

鸿蒙HarmonyOS应用

2022-03-11 20:23:14

鸿蒙源码分析进程管理

2021-09-22 14:36:32

鸿蒙HarmonyOS应用

2021-07-06 09:45:03

鸿蒙HarmonyOS应用

2022-03-03 18:28:28

Harmony进程任务管理模块

2021-06-09 09:48:01

鸿蒙HarmonyOS应用

2021-05-11 09:54:55

鸿蒙HarmonyOS应用

2021-05-27 09:43:56

鸿蒙HarmonyOS应用

2021-05-21 09:25:11

鸿蒙HarmonyOS应用

2021-05-10 15:05:56

鸿蒙HarmonyOS应用

2021-04-30 15:06:34

鸿蒙HarmonyOS应用

2022-01-14 08:39:47

鸿蒙HarmonyOS应用
点赞
收藏

51CTO技术栈公众号