分享一個基于事件驅動的有限狀態(tài)機
[導讀]星標「嵌入式大雜燴」，一起進步！來源：https://gitee.com/simpost/EFSM/tree/master/一、介紹EFSM(eventfinitestatemachine，事件驅動型有限狀態(tài)機)，是一個基于事件驅動的有限狀態(tài)機，主要應用于嵌入式設備的軟件系統(tǒng)中。...
一、介紹
EFSM(event finite state machine，事件驅動型有限狀態(tài)機)，是一個基于事件驅動的有限狀態(tài)機，主要應用于嵌入式設備的軟件系統(tǒng)中。
- 當事件到來時，通過EFSM取得對應事件的處理方法；
- 當特定事件到來，或者條件滿足時，調用狀態(tài)切換方法進行狀態(tài)切換。
- EFSM核心：由uthash.h、efsm.h和efsm_conf.h三個文件組成；他們構成了事件驅動型狀態(tài)機的核心；使用的時候只需要包含efsm.h即可；
- EFSM擴展：在EFSM核心的基礎上，增加efsmt.h和efsmt.c兩個文件，這兩個文件會根據具體的狀態(tài)機創(chuàng)建狀態(tài)機線程，用于驅動狀態(tài)機運轉；使用的時候只需要包含efsmt.h即可；
二、接口總覽
EFSM總共提供了兩套接口，你只需要選擇其中套用法即可。全部接口概述如下：
2.1 使用狀態(tài)機工具集（EFSM核心）
若你想自己把控狀態(tài)機的整個運轉過程，可以直接使用EFSM核心，詳細接口如下。
1. 狀態(tài)操作接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSM_SETS | 用于創(chuàng)建某一狀態(tài)下不同時間的處理集合 | 類型，無參數(shù) |
| EFSM_CREATE(state) | 用于創(chuàng)建某一狀態(tài)名 | state是狀態(tài)名 |
| EFSM_DECLEAR(state) | 當在其它地方需要使用到某個狀態(tài)時，用于聲明 | state是狀態(tài)名 |
| EFSM_BIND(state, sets) | 用于將狀態(tài)state與處理集sets進行綁定 | state是狀態(tài)名，sets是處理集 |
2. 狀態(tài)指針操作接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSM_PTR_CREATE(name) | 用于創(chuàng)建一個狀態(tài)機指針 | name是狀態(tài)機指針名 |
| EFSM_PTR_DECLEAR(name) | 當在其它地方需要使用到某個狀態(tài)指針時，用于聲明 | name是狀態(tài)機指針名 |
| EFSM_PTR_BIND(name, state) | 用于為狀態(tài)機指針name綁定到初始狀態(tài)state，只調用一次 | name是狀態(tài)機指針名，state是狀態(tài)名 |
3. 狀態(tài)切換接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSM_TRANSFER(name, state) | 用于把狀態(tài)機name切換到state狀態(tài) | name是狀態(tài)機指針名，state是狀態(tài)名 |
| EFSM_TRANSFER_ENABLE(name) | 使能狀態(tài)切換功能，在EFSM_TRANSFER()前調用 | name是狀態(tài)機指針名 |
| EFSM_TRANSFER_DISABLE(name) | 除能狀態(tài)切換功能，在EFSM_TRANSFER()后調用 | name是狀態(tài)機指針名 |
4. 獲取處理函數(shù)接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSM_HANDLER(name, event) | 用與當某個事件到來時，通過該方法獲取到當前狀態(tài)下的對應處理方法 | name是狀態(tài)機指針名，event是事件 |
2.2 使用狀態(tài)機
若你不關心狀態(tài)機的內部細節(jié)實現(xiàn)，需要一個可直接運轉的狀態(tài)機，那么請使用efsmt.h頭文件，并將efsmt.c編譯進你的源碼。詳細接口如下。
1. 狀態(tài)操作接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSM_SETS | 用于創(chuàng)建某一狀態(tài)下不同時間的處理集合 | 類型，無參數(shù) |
| EFSM_CREATE(state) | 用于創(chuàng)建某一狀態(tài)名 | state是狀態(tài)名 |
| EFSM_DECLEAR(state) | 當在其它地方需要使用到某個狀態(tài)時，用于聲明 | state是狀態(tài)名 |
| EFSM_BIND(state, sets) | 用于將狀態(tài)state與處理集sets進行綁定 | state是狀態(tài)名，sets是處理集 |
2. 狀態(tài)機操作接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSMT_CREATE(name) | 創(chuàng)建一個狀態(tài)機 | name是狀態(tài)機名 |
| EFSMT_DESTROY(name) | 當不再使用狀態(tài)機時，用于銷毀 | name是狀態(tài)機名 |
| EFSMT_DECLEAR(name) | 當在其它地方需要使用到狀態(tài)機時，用于聲明 | name是狀態(tài)機名 |
| EFSMT_BIND(name, state) | 用于綁定狀態(tài)機的初始狀態(tài) | name是狀態(tài)機名，state是狀態(tài)名 |
3. 狀態(tài)切換接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSM_TRANSFER(name, state) | 用于把狀態(tài)機name切換到state狀態(tài) | name是狀態(tài)機指針名，state是狀態(tài)名 |
| EFSM_TRANSFER_ENABLE(name) | 使能狀態(tài)切換功能，在EFSM_TRANSFER()前調用 | name是狀態(tài)機指針名 |
| EFSM_TRANSFER_DISABLE(name) | 除能狀態(tài)切換功能，在EFSM_TRANSFER()后調用 | name是狀態(tài)機指針名 |
4. 觸發(fā)事件接口
| API | 說明 | 參數(shù) |
|---|---|---|
| EFSMT_INVOKE(name, event, arg) | 當事件到來時，觸發(fā)該事件，狀態(tài)機會自動尋找并調用對應的處理事件 | name是狀態(tài)機名，event是事件，arg是事件參數(shù) |
2.3 總結
從接口可以看出，創(chuàng)建處理集與狀態(tài)集，和狀態(tài)切換方法是完全一樣的；兩種方法的唯一差異就是：當事件來了之后，事件對應的處理是由你來控制，還是由狀態(tài)機內部進行控制。
三、使用說明
要使用EFSM，非常簡單，只需要如下三步：定義事件集、定義狀態(tài)集、使用狀態(tài)集。
3.1 定義事件集
在我們設計業(yè)務/功能時，首先對需要使用到的事件進行定義。具體實現(xiàn)方法是在efsm_event.h文件中，使用EFSM_EVENT()宏定義需要的事件。如果你需要定義多個狀態(tài)機，那請將不同狀態(tài)機的事件分塊保存，建議使用enum進行管理。比如：
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
};
3.2 定義狀態(tài)集
-
定義狀態(tài)：使用EFSM_CREATE(state)創(chuàng)建一個狀態(tài)state；在其它使用到它的地方用EFSM_DECLEAR(state)宏進行聲明；
-
定義處理集：使用EFSM_SETS state_sets定義一個狀態(tài)集合state_sets，其中每個事件可以對應一個處理函數(shù)，也可以對應多個函數(shù)，當然也可以為NULL；處理函數(shù)需滿足如下格式：
typedef void (*EFSM_EVENT_HANDLER)(EFSM_EVENT_TYPE event, void *arg);
-
綁定狀態(tài)與處理集：在模塊初始化函數(shù)中調用EFSM_BIND(state, sets)宏將狀態(tài)state與處理集sets進行綁定；
3.3 使用狀態(tài)集
當為模塊/產品實現(xiàn)了所有的狀態(tài)，那么編寫業(yè)務應用程序來實現(xiàn)調度，讓所有的狀態(tài)機完美的運作起來。具體使用方法如下：
-
定義狀態(tài)指針：使用EFSM_PTR_CREATE(name)定義一個狀態(tài)指針name；當然你也可以定義多個狀態(tài)指針，每個指針對應一個狀態(tài)機。在其它使用到該狀態(tài)指針的地方使用EFSM_PTR_DECLEAR(name)宏進行聲明；
-
綁定初始狀態(tài)：在整個狀態(tài)機運作之前，需要使用EFSM_PTR_BIND(name, state)宏將狀態(tài)指針name與狀態(tài)state進行綁定；
-
獲取處理函數(shù)指針：當接收到某個事件時，可以通過EFSM_HANDLER(name,event)宏從狀態(tài)指針name中獲取對該事件的處理方法，第一個參數(shù)是狀態(tài)指針，第二個參數(shù)為事件；
-
狀態(tài)切換：當遇到某個事件，或者在事件處理函數(shù)中條件滿足，需要進行狀態(tài)切換時，使用下面流程進行切換：
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)切換時，必須滿足ENABLE()->TRANSFER()->DISABLE()的流程。這么做的目的，是為了讓編程者思考：狀態(tài)設計與狀態(tài)的跳轉是否必要與合理。
四、常見問題
-
使用過程中若遇到如下錯誤，是因為在正式使用前，沒有把狀態(tài)指針綁定到具體的狀態(tài)：
EFSM: cur-state-ptr have't bind a state: %xxx!!!
-
使用過程中若遇到如下錯誤，是因為狀態(tài)切換動作不滿足ENABLE()->TRANSFER()->DISABLE()的流程：
EFSM: 'xxx' switch to 'xxx' failed!!!
-
使用過程中，若遇到了死鎖或卡死，是因為狀態(tài)切換動作不滿足ENABLE()->TRANSFER()->DISABLE()的流程：
-
命名定義了處理函數(shù)，為什么每次EFSM_HANDLER()得到的都是NULL？答：因為你沒有將狀態(tài)與事件集進行綁定。
-
對于某個狀態(tài)沒有使用到的事件，我是否可以不對其定義？答：完全可以，這樣還可以加快EFSM的處理速度。不過不建議直接刪除，而采用注釋的形式，比如：
EFSM_SETS online[] = { {EVENT_PLAY, online_play},
/*{EVENT_STOP, NULL}, */
{EVENT_NEXT, online_next},
/*{EVENT_PREV, NULL}, */
{EVENT_START, online_start},
};
往期推薦：
嵌入式 N 年經歷等于 1 年經驗？
如何使用 Rust 進行嵌入式開發(fā)？
在公眾號聊天界面回復1024，可獲取嵌入式資源；回復 m ，可查看文章匯總。
點擊閱讀原文，查看更多分享
下載文檔
