一個(gè)基于事件驅(qū)動(dòng)的有限狀態(tài)機(jī)

來(lái)源：https://gitee.com/simpost/EFSM/tree/master/

介紹

EFSM(event finite state machine，事件驅(qū)動(dòng)型有限狀態(tài)機(jī))，是一個(gè)基于事件驅(qū)動(dòng)的有限狀態(tài)機(jī)，主要應(yīng)用于嵌入式設(shè)備的軟件系統(tǒng)中。

EFSM的設(shè)計(jì)原則是：簡(jiǎn)單！EFSM的使用者只需要關(guān)心：

當(dāng)事件到來(lái)時(shí)，通過EFSM取得對(duì)應(yīng)事件的處理方法；

當(dāng)特定事件到來(lái)，或者條件滿足時(shí)，調(diào)用狀態(tài)切換方法進(jìn)行狀態(tài)切換。

由于EFSM的巧妙設(shè)計(jì)，避免了命名沖突的問題，你可以在一個(gè)程序中定義多個(gè)狀態(tài)機(jī)；要是能對(duì)不同狀態(tài)進(jìn)行組織，還可以做出層次狀態(tài)機(jī)的結(jié)構(gòu)。

EFSM總共分為兩個(gè)部分：

EFSM核心：由uthash.h、efsm.h和efsm_conf.h三個(gè)文件組成；他們構(gòu)成了事件驅(qū)動(dòng)型狀態(tài)機(jī)的核心；使用的時(shí)候只需要包含efsm.h即可；

EFSM擴(kuò)展：在EFSM核心的基礎(chǔ)上，增加efsmt.h和efsmt.c兩個(gè)文件，這兩個(gè)文件會(huì)根據(jù)具體的狀態(tài)機(jī)創(chuàng)建狀態(tài)機(jī)線程，用于驅(qū)動(dòng)狀態(tài)機(jī)運(yùn)轉(zhuǎn)；使用的時(shí)候只需要包含efsmt.h即可；

接口總覽

EFSM總共提供了兩套接口，你只需要選擇其中套用法即可。全部接口概述如下：

使用狀態(tài)機(jī)工具集（EFSM核心）

若你想自己把控狀態(tài)機(jī)的整個(gè)運(yùn)轉(zhuǎn)過程，可以直接使用EFSM核心，詳細(xì)接口如下。

1. 狀態(tài)操作接口

2. 狀態(tài)指針操作接口

3. 狀態(tài)切換接口

4. 獲取處理函數(shù)接口

使用狀態(tài)機(jī)

若你不關(guān)心狀態(tài)機(jī)的內(nèi)部細(xì)節(jié)實(shí)現(xiàn)，需要一個(gè)可直接運(yùn)轉(zhuǎn)的狀態(tài)機(jī)，那么請(qǐng)使用efsmt.h頭文件，并將efsmt.c編譯進(jìn)你的源碼。詳細(xì)接口如下。

1. 狀態(tài)操作接口

2. 狀態(tài)機(jī)操作接口

3. 狀態(tài)切換接口

4. 觸發(fā)事件接口

總結(jié)

從接口可以看出，創(chuàng)建處理集與狀態(tài)集，和狀態(tài)切換方法是完全一樣的；兩種方法的唯一差異就是：當(dāng)事件來(lái)了之后，事件對(duì)應(yīng)的處理是由你來(lái)控制，還是由狀態(tài)機(jī)內(nèi)部進(jìn)行控制。

使用說明

要使用EFSM，非常簡(jiǎn)單，只需要如下三步：定義事件集、定義狀態(tài)集、使用狀態(tài)集。

定義事件集

在我們?cè)O(shè)計(jì)業(yè)務(wù)/功能時(shí)，首先對(duì)需要使用到的事件進(jìn)行定義。具體實(shí)現(xiàn)方法是在efsm_event.h文件中，使用EFSM_EVENT()宏定義需要的事件。如果你需要定義多個(gè)狀態(tài)機(jī)，那請(qǐng)將不同狀態(tài)機(jī)的事件分塊保存，建議使用enum進(jìn)行管理。比如：

enum {
  EVENT_PLAY  = EFSM_EVENT(1),
  EVENT_STOP  = EFSM_EVENT(2),
  EVENT_NEXT  = EFSM_EVENT(3),
  EVENT_PREV  = EFSM_EVENT(4),
  EVENT_START = EFSM_EVENT(7),    //not require continuous
 };

定義狀態(tài)集

定義狀態(tài)：使用EFSM_CREATE(state)創(chuàng)建一個(gè)狀態(tài)state；在其它使用到它的地方用EFSM_DECLEAR(state)宏進(jìn)行聲明；

定義處理集：使用EFSM_SETS state_sets定義一個(gè)狀態(tài)集合state_sets，其中每個(gè)事件可以對(duì)應(yīng)一個(gè)處理函數(shù)，也可以對(duì)應(yīng)多個(gè)函數(shù)，當(dāng)然也可以為NULL；處理函數(shù)需滿足如下格式：

typedefvoid(*EFSM_EVENT_HANDLER)(EFSM_EVENT_TYPEevent,void*arg);

綁定狀態(tài)與處理集：在模塊初始化函數(shù)中調(diào)用EFSM_BIND(state, sets)宏將狀態(tài)state與處理集sets進(jìn)行綁定；

使用狀態(tài)集

當(dāng)為模塊/產(chǎn)品實(shí)現(xiàn)了所有的狀態(tài)，那么編寫業(yè)務(wù)應(yīng)用程序來(lái)實(shí)現(xiàn)調(diào)度，讓所有的狀態(tài)機(jī)完美的運(yùn)作起來(lái)。具體使用方法如下：

定義狀態(tài)指針：使用EFSM_PTR_CREATE(name)定義一個(gè)狀態(tài)指針name；當(dāng)然你也可以定義多個(gè)狀態(tài)指針，每個(gè)指針對(duì)應(yīng)一個(gè)狀態(tài)機(jī)。在其它使用到該狀態(tài)指針的地方使用EFSM_PTR_DECLEAR(name)宏進(jìn)行聲明；

綁定初始狀態(tài)：在整個(gè)狀態(tài)機(jī)運(yùn)作之前，需要使用EFSM_PTR_BIND(name, state)宏將狀態(tài)指針name與狀態(tài)state進(jìn)行綁定；

獲取處理函數(shù)指針：當(dāng)接收到某個(gè)事件時(shí)，可以通過EFSM_HANDLER(name,event)宏從狀態(tài)指針name中獲取對(duì)該事件的處理方法，第一個(gè)參數(shù)是狀態(tài)指針，第二個(gè)參數(shù)為事件；

狀態(tài)切換：當(dāng)遇到某個(gè)事件，或者在事件處理函數(shù)中條件滿足，需要進(jìn)行狀態(tài)切換時(shí)，使用下面流程進(jìn)行切換：

EFSM_TRANSFER_ENABLE(name);
EFSM_TRANSFER(name, state);
EFSM_TRANSFER_DISABLE(name);

EFSM_TRANSFER_ENABLE(name)宏使能狀態(tài)指針name的切換能力；

EFSM_TRANSFER_DISABLE(name)宏除能狀態(tài)指針name的切換能力；

EFSM_TRANSFER(name, state)宏執(zhí)行狀態(tài)指針name切換到state；

注意：做狀態(tài)切換時(shí)，必須滿足ENABLE()->TRANSFER()->DISABLE()的流程。這么做的目的，是為了讓編程者思考：狀態(tài)設(shè)計(jì)與狀態(tài)的跳轉(zhuǎn)是否必要與合理。

常見問題

使用過程中若遇到如下錯(cuò)誤，是因?yàn)樵谡绞褂们埃瑳]有把狀態(tài)指針綁定到具體的狀態(tài)：

EFSM: cur-state-ptr have't bind a state: %xxx!!!

使用過程中若遇到如下錯(cuò)誤，是因?yàn)闋顟B(tài)切換動(dòng)作不滿足ENABLE()->TRANSFER()->DISABLE()的流程：

EFSM:'xxx'switchto'xxx'failed!!!

使用過程中，若遇到了死鎖或卡死，是因?yàn)闋顟B(tài)切換動(dòng)作不滿足ENABLE()->TRANSFER()->DISABLE()的流程。 命名定義了處理函數(shù)，為什么每次EFSM_HANDLER()得到的都是NULL？答：因?yàn)槟銢]有將狀態(tài)與事件集進(jìn)行綁定。 對(duì)于某個(gè)狀態(tài)沒有使用到的事件，我是否可以不對(duì)其定義？ 答：完全可以，這樣還可以加快EFSM的處理速度。不過不建議直接刪除，而采用注釋的形式，比如：

EFSM_SETS online[] = { {EVENT_PLAY, online_play},
                        /*{EVENT_STOP, NULL}, */
                        {EVENT_NEXT, online_next},
                        /*{EVENT_PREV, NULL}, */
                        {EVENT_START, online_start},
                      };

審核編輯：湯梓紅