從零開始漫談 | 多實例的狀態(tài)機
比如下面這個狀態(tài)圖就是一個典型:
通過圖示,我們能清晰的看出該狀態(tài)機實現(xiàn)的是“通用字符串輸出”的功能。其實,這里我算是埋下了一個小小的“彩蛋”——當然,它的真實身份是一個陷阱。如果你已經(jīng)熟悉了我前面介紹的翻譯規(guī)則,很容易就會發(fā)現(xiàn)這里存在的巨大問題:是的,這個狀態(tài)圖按照switch翻譯法無腦翻譯的后果,將是一個根本無法正常工作的狀態(tài)機:
typedef enum { fsm_rt_err = -1, fsm_rt_on_going = 0, fsm_rt_cpl = 1,} fsm_rt_t;
extern bool serial_out(uint8_t chByte);
#define PRINT_STR_RESET_FSM() \ do { s_tState = START; } while(0)
fsm_rt_t print_str(const char *pchStr){ static enum { START = 0, IS_END_OF_STRING, SEND_CHAR, } s_tState = START;
switch (s_tState) { case START: s_tState = IS_END_OF_STRING; break; case IS_END_OF_STRING: if (*pchStr == '\0') { PRINT_STR_RESET_FSM(); return fsm_rt_cpl; } s_tState = SEND_CHAR; break; case SEND_CHAR: if (serial_out(*pchStr)) { pchStr ; s_tState = IS_END_OF_STRING; } break; }
return fsm_rt_on_going;} 不仔細看的小伙伴也許會撓撓后腦勺,說:“代碼很漂亮……但我也沒看出有啥問題啊”?
不打緊,我們來看看這個狀態(tài)機時如何使用的:
print_str(c_tDemoStr); }} 還沒看出問題么?
-
pchStr是一個局部變量,它保存了狀態(tài)機函數(shù) print_str 被調(diào)用時用戶所傳遞的字符串首地址;
-
該狀態(tài)機在執(zhí)行的過程中,不可避免的要多次出讓(Yield)處理器時間,以達到“非阻塞”的目的;
-
由于pchStr是一個局部變量,它的生命周期在退出print_str函數(shù)后就結(jié)束了;而每次重新進入print_str函數(shù),它的值都會被復位成“hello world\r\n”的起始地址。
既然問題清楚了,修改方式也迎刃而解,如下圖所示:
也就是說,我們可以通過引入一個靜態(tài)變量 s_pchStr的方式來保存狀態(tài)機的關(guān)鍵上下文信息。對比圖片,可以注意到:修改后的圖在復位后的初始化階段(也就是start的行為部分)對靜態(tài)變量 s_pchStr做了一個初始化——用pchStr為其賦值。此后,圖中所有針對字符串的操作也都是使用 s_pchStr 來完成了。
重新翻譯后的代碼如下:
switch (s_tState) { case START: s_pchStr = pchStr; s_tState = IS_END_OF_STRING; //break; //!< fall-through case IS_END_OF_STRING: if (*s_pchStr == '\0') { PRINT_STR_RESET_FSM(); return fsm_rt_cpl; } s_tState = SEND_CHAR; //break; //!< fall-through case SEND_CHAR: if (serial_out(*s_pchStr)) { pchStr ; s_tState = IS_END_OF_STRING; } break; }
return fsm_rt_on_going;}
【一系列似是而非的問題……】
-
狀態(tài)機print_str 使用了靜態(tài)變量來保存狀態(tài)(s_tState)和關(guān)鍵的上下文(s_pchStr),因此幾乎肯定是不可重入的;
-
狀態(tài)機print_str使用了共享函數(shù)serial_out(),即便該函數(shù)本身可以保證原子性,但它仍然是一個臨界資源——換句話說,即便拋開 print_str 的可重入性問題不談,當有該狀態(tài)機存在多個實例時,你能保證每個字符串的打印都是完整的么?比如:
此時,我們可以說,print_str 也不是線程安全(thread-safe)的。
根據(jù)維基百科的描述:
In computing, ... a reentrant procedure can be interrupted in the middle of its execution and then safely be called again ("re-entered") before its previous invocations complete execution.大體翻譯成中文就是:https://en.wikipedia.org/wiki/Reentrancy_(computing)
這里,我們需要注意一個細節(jié),就是“可重入”關(guān)注的是,在任意時刻,無論以什么樣的方式,該函數(shù)被多次調(diào)用時是否“安全”。換句話說,它并不是“非常在意”可重入本身對功能的影響,它在意的是這樣調(diào)用是否“安全”。
以我們的print_str為例,由于狀態(tài)機的中使用了靜態(tài)變量,尤其是狀態(tài)變量s_tState——這意味著同時執(zhí)行的多個實例,彼此共享同一個狀態(tài)變量……換句話說,當多個print_str同時執(zhí)行時,它們是彼此干擾的。這意味著同時執(zhí)行多個print_str是“不安全”的,是會出問題的(比如字符串長度不一致時很可能會出現(xiàn)buffer-overflow的問題),因此可以說 print_str 是不可重入的。
但換一個角度,假設我們已經(jīng)解決了print_str的不可重入問題,比如:妥善的解決了狀態(tài)變量和上下文的存儲問題,那么就滿足了“可重入”關(guān)于“安全”的要求——因為當存在多個實例的時候,這樣執(zhí)行并不會導致系統(tǒng)崩潰,或是buffer-overflow——只不過打印出來的字符串并不完整而已。這就是為什么人們常說的:
可重入的函數(shù)不一定線程安全;
本質(zhì)上,我們要解決的并不單純是狀態(tài)機的“可重入”問題——只把眼光放在可重入上就“格局小了”。
【多實例的狀態(tài)機】
通過前面的分析,我們已經(jīng)注意到了問題所在,即:以現(xiàn)有的實現(xiàn)方式,如果存在多個 print_str 調(diào)用(實例),那么它們其實是在“競爭”關(guān)鍵的狀態(tài)變量 s_tState和上下文 s_pchStr。
聰明的你一定看出來了,解決狀態(tài)機多實例的方式就是“給每個實例都發(fā)一個球”。具體來說,就是:
-
為狀態(tài)機定義一個控制塊;
-
在控制塊里存放狀態(tài)變量;
-
在控制塊里存放狀態(tài)機的上下文;
-
建立狀態(tài)機實例時,首先要建立一個控制塊,并對其進行必要的初始化;
-
在隨后調(diào)用狀態(tài)機時,應該首先傳遞狀態(tài)機的控制塊給狀態(tài)機函數(shù)。
對應到圖例上,我們一般會在狀態(tài)圖的某個角落(比如左下角或右下角)通過一個矩形框列舉狀態(tài)機上下文的所有內(nèi)容。如下圖所示:
觀察修改后的狀態(tài)圖,我們應該注意以下的一些變化:
-
在圖的右下角,出現(xiàn)了一個帶標題的矩形框。這里標題print_str_t是狀態(tài)機控制塊的類型名稱;下面的列表中列舉了上下文的內(nèi)容,在本例中就是 pchStr,注意,它已經(jīng)去掉了"s_"前綴。
-
狀態(tài)圖中通過 "this.xxxx" 的方式來訪問狀態(tài)機上下文中的內(nèi)容。
【基本的翻譯方法】
int <狀態(tài)機名稱>_init(<狀態(tài)機類型名稱> *ptThis[, <形參列表>]){ ... this.chState = 0; //!< 復位狀態(tài)變量,這里固定用0 /*! \note 這里根據(jù)需要可以初始化那些只需要初始化一次的上下文 */ /*! \note 這里也可以對輸入的參數(shù)進行有效性檢測,如果發(fā)現(xiàn)錯誤, *! 就返回負數(shù)值。這里既可以自定義一套枚舉,也可以簡單 *! 返回 -1 了事。 */ return 0; //!< 如果一切順利返回0,表示正常} 以 print_str為例:
接下來,我們就需要對狀態(tài)機函數(shù)進行小小的改造,其格式為:
fsm_rt_t <狀態(tài)機名稱>(<狀態(tài)機類型名> *ptThis[, <形參列表>]){ //!< 這種事情就不適合在release版本的運行時刻檢查 assert(NULL != ptThis); enum { START = 0, <狀態(tài)列表> }; ... switch (this.chState) { ... } return fsm_rt_on_going;}
#define PRINT_STR_RESET_FSM() \ do { this.State = START; } while(0)
fsm_rt_t print_str(print_str_t *ptThis, const char *pchStr){ enum { START = 0, IS_END_OF_STRING, SEND_CHAR, };
switch (this.chState) { case START: this.pchStr = pchStr; this.chState = IS_END_OF_STRING; //break; //!< fall-through case IS_END_OF_STRING: if (*(this.pchStr) == '\0') { PRINT_STR_RESET_FSM(); return fsm_rt_cpl; } this.chState = SEND_CHAR; //break; //!< fall-through case SEND_CHAR: if (serial_out(*(this.pchStr))) { this.pchStr ; this.chState = IS_END_OF_STRING; } break; }
return fsm_rt_on_going;} 此時,我們就可以“安全”的進行多實例調(diào)用了:
int main(void){ ... print_str_init(