FreeRTOS優化與錯誤排查方法
寫在前面
主要是為剛接觸 FreeRTOS 的使用者指出那些新手通常容易遇到的問題。這裡把最主要的篇幅放在棧溢位以及棧溢位j檢測上,因為棧相關的問題是初學者遇到最多的問題。
printf-stdarg.c
當呼叫 C 標準庫 的函式時,棧空間使用量可能會急劇上升,特別是 IO 與字串處理函式,比如 sprintf()、printf()等。在 FreeRTOS 原始碼包中有一個名為 printf-stdarg.c 的檔案。這個檔案實現了一個棧效率優化版的小型 sprintf()、printf(),可以用來代替標準 C 庫函式版本。在大多數情況下,這樣做可以使得呼叫 sprintf()及相關函式的任務對棧空間的需求量小很多。
可能很多人都不知道freertos中有這樣子的一個檔案,它放在第三方資料中,路徑為“FreeRTOSv9.0.0\FreeRTOS-Plus\Demo\FreeRTOS_Plus_UDP_and_CLI_LPC1830_GCC”,我們釋出工程的時候就無需依賴 C 標準庫,這樣子就能減少棧的使用,能優化不少空間。
該檔案原始碼(部分):
static int print( char **out, const char *format, va_list args ) { register int width, pad; register int pc = 0; char scr[2]; for (; *format != 0; ++format) { if (*format == '%') { ++format; width = pad = 0; if (*format == '\0') break; if (*format == '%') goto out; if (*format == '-') { ++format; pad = PAD_RIGHT; } while (*format == '0') { ++format; pad |= PAD_ZERO; } for ( ; *format >= '0' && *format <= '9'; ++format) { width *= 10; width += *format - '0'; } if( *format == 's' ) { register char *s = (char *)va_arg( args, int ); pc += prints (out, s?s:"(null)", width, pad); continue; } if( *format == 'd' || *format == 'i' ) { pc += printi (out, va_arg( args, int ), 10, 1, width, pad, 'a'); continue; } if( *format == 'x' ) { pc += printi (out, va_arg( args, int ), 16, 0, width, pad, 'a'); continue; } if( *format == 'X' ) { pc += printi (out, va_arg( args, int ), 16, 0, width, pad, 'A'); continue; } if( *format == 'u' ) { pc += printi (out, va_arg( args, int ), 10, 0, width, pad, 'a'); continue; } if( *format == 'c' ) { /* char are converted to int then pushed on the stack */ scr[0] = (char)va_arg( args, int ); scr[1] = '\0'; pc += prints (out, scr, width, pad); continue; } } else { out: printchar (out, *format); ++pc; } } if (out) **out = '\0'; va_end( args ); return pc; } int printf(const char *format, ...) { va_list args; va_start( args, format ); return print( 0, format, args ); } int sprintf(char *out, const char *format, ...) { va_list args; va_start( args, format ); return print( &out, format, args ); } int snprintf( char *buf, unsigned int count, const char *format, ... ) { va_list args; ( void ) count; va_start( args, format ); return print( &buf, format, args ); }
使用的例子與 C 標準庫基本一樣:
int main(void) { char *ptr = "Hello world!"; char *np = 0; int i = 5; unsigned int bs = sizeof(int)*8; int mi; char buf[80]; mi = (1 << (bs-1)) + 1; printf("%s\n", ptr); printf("printf test\n"); printf("%s is null pointer\n", np); printf("%d = 5\n", i); printf("%d = - max int\n", mi); printf("char %c = 'a'\n", 'a'); printf("hex %x = ff\n", 0xff); printf("hex %02x = 00\n", 0); printf("signed %d = unsigned %u = hex %x\n", -3, -3, -3); printf("%d %s(s)%", 0, "message"); printf("\n"); printf("%d %s(s) with %%\n", 0, "message"); sprintf(buf, "justif: \"%-10s\"\n", "left"); printf("%s", buf); sprintf(buf, "justif: \"%10s\"\n", "right"); printf("%s", buf); sprintf(buf, " 3: %04d zero padded\n", 3); printf("%s", buf); sprintf(buf, " 3: %-4d left justif.\n", 3); printf("%s", buf); sprintf(buf, " 3: %4d right justif.\n", 3); printf("%s", buf); sprintf(buf, "-3: %04d zero padded\n", -3); printf("%s", buf); sprintf(buf, "-3: %-4d left justif.\n", -3); printf("%s", buf); sprintf(buf, "-3: %4d right justif.\n", -3); printf("%s", buf); return 0; }
棧計算
每個任務都獨立維護自己的棧空間, 任務棧空間總量在任務建立時進行設定。uxTaskGetStackHighWaterMark()
主要用來查詢指定任務的執行歷史中, 其棧空間還差多少就要溢位。這個值被稱為棧空間的High Water Mark。
函式原型:
UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )
想要使用它,需要將對應的巨集定義開啟:INCLUDE_uxTaskGetStackHighWaterMark
函式描述:
|引數|說明|
|--|--|
| xTask | 被查詢任務的控制代碼如果傳入 NULL 控制代碼,則任務查詢的是自身棧空間的高水線 |
| 返回值| 任務棧空間的實際使用量會隨著任務執行和中斷處理過程上下浮動。uxTaskGetStackHighWaterMark()返回從任務啟動執行開始的執行歷史中,棧空間具有的最小剩餘量。這個值即是棧空間使用達到最深時的剩下的未使用的棧空間。這個值越是接近 0,則這個任務就越是離棧溢位不遠。|
如果不知道怎麼計算任務棧大小,就使用這個函式進行統計一下,然後將任務執行時最大的棧空間作為任務棧空間的80%大小即可。即假設統計得到的任務棧大小為常量 A ,那麼在建立執行緒的時候需要 X 大小的空間,那麼 X * 80% = A,算到的 X 作為任務棧大小就差不多了。
執行時棧檢測
FreeRTOS 包含兩種執行時棧j檢測機制,由 FreeRTOSConfig.h 中的配置常量configCHECK_FOR_STACK_OVERFLOW 進行控制。這兩種方式都會增加上下切換開銷。
棧溢位鉤子函式(或稱回撥函式)由核心在j檢測到棧溢位時呼叫。要使用棧溢位鉤子函式,需要進行以下配置:
- 在 FreeRTOSConfig.h 中把 configCHECK_FOR_STACK_OVERFLOW 設為 1 或者 2 。
- 提供鉤子函式的具體實現,採用下面所示的函式名和函式原型。
void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );
補充說明:
- 棧溢位鉤子函式只是為了使跟蹤除錯棧空間錯誤更容易,而無法在棧溢位時對其進行恢復。函式的入口引數傳入了任務控制代碼和任務名,但任務名很可能在溢位時已經遭到破壞。
- 棧溢位鉤子函式還可以在中斷的上下文中進行呼叫
- 某些微控制器在檢測到記憶體訪問錯誤時會產生錯誤異常,很可能在核心呼叫棧溢位鉤子函式之前就觸發了錯誤異常中斷。
方法1
當 configCHECK_FOR_STACK_OVERFLOW
設定為 1 時選用方法 1。
任務被交換出去的時候,該任務的整個上下文被儲存到它自己的棧空間中。這時任務棧的使用應當達到了一個峰值。當 configCHECK_FOR_STACK_OVERFLOW
設為1 時,核心會在任務上下文儲存後檢查棧指標是否還指向有效棧空間。一旦檢測到棧指標的指向已經超出任務棧的有效範圍,棧溢位鉤子函式就會被呼叫。
方法 1 具有較快的執行速度,但棧溢位有可能發生在兩次上下文儲存之間,這種情況不會被檢測到,因為這種檢測方式僅在任務切換中檢測。
方法2
將 configCHECK_FOR_STACK_OVERFLOW
設為 2 就可以選用方法 2。方法 2在方法 1 的基礎上進行了一些補充。
當建立任務時,任務棧空間中就預置了一個標記。方法 2 會檢查任務棧的最後 20個位元組的資料,檢視預置在這裡的標記資料是否被覆蓋。如果最後 20 個位元組的標記資料與預設值不同,則棧溢位鉤子函式就會被呼叫。
方法 2 沒有方法 1 的執行速度快,但測試僅僅 20 個位元組相對來說也是很快的。這種方法應該可以j檢測到任何時候發生的棧溢位,雖然理論上還是有可能漏掉一些情況,但這些情況幾乎是不可能發生的。
其它常見錯誤
在一個 Demo 應用程式中增加了一個簡單的任務,導致應用程式崩潰
可能的情況:
- 任務建立時需要在記憶體堆中分配空間。許多 Demo 應用程式定義的堆空間大小隻夠用於建立 Demo 任務——所以當任務建立完成後,就沒有足夠的剩餘空間來增加其它的任務,佇列或訊號量。
- 空閒任務是在
vTaskStartScheduler()
呼叫中自動建立的。如果由於記憶體不足而無法建立空閒任務,vTaskStartScheduler()
會直接返回。所以一般在呼叫vTaskStartScheduler()
後加上一條空迴圈for(;;) / while(1)
可以使這種錯誤更加容易除錯。
如果要新增更多的任務,可以增加記憶體堆空間大小(修改配置檔案),或是刪掉一些已存在的 Demo任務。
在中斷中呼叫一個 API 函式,導致應用程式崩潰
需要做的第一件事是檢查中斷是否導致了棧溢位。
然後檢查API介面是否正確,除了具有後綴為FromISR
函式名的 API 函式,千萬不要在中斷服務程式中呼叫其它 API 函式。
除此之外,還需要注意中斷的優先順序:
FreeRTOSConfig.h
檔案中可以配置系統可管理的最高中斷優先順序數值,巨集定義configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY
是用於配置basepri暫存器的,當basepri設定為某個值的時候,會讓系統不響應比該優先順序低的中斷,而優先順序比之更高的中斷則不受影響。就是說當這個巨集定義配置為5的時候,中斷優先順序數值在0、1、2、3、4的這些中斷是不受FreeRTOS管理的,不可被遮蔽,同時也不能呼叫FreeRTOS中的API函式介面,而中斷優先順序在5到15的這些中斷是受到系統管理,可以被遮蔽的,也可以呼叫FreeRTOS中的API函式介面。
臨界區無法正確巢狀
除了 taskENTER_CRITICA()和 taskEXIT_CRITICAL(),千萬不要在其它地方修改控制器的中斷使能位或優先順序標誌。這兩個巨集維護了一個巢狀深度計數,所以只有當所有的巢狀呼叫都退出後計數值才會為 0,也才會使能中斷。
在排程器啟動前應用程式就崩潰了
這個問題我也會遇到,如果一箇中斷會產生上下文切換,則這個中斷不能在排程器啟動之前使能。這同樣適用於那些需要讀寫佇列或訊號量的中斷。在排程器啟動之前,不能進行上下文切換。
還有一些 API 函式不能在排程器啟動之前呼叫。在呼叫 vTaskStartScheduler()之前,最好是限定只使用建立任務,佇列和訊號量的 API 函式。
比如有一些初始化需要中斷的,或者在初始化完成的時候回產生一箇中斷,這些驅動的初始化最好放在一個任務中進行,我是這樣子處理的,在main
函式中建立一個任務,在任務中進行bsp初始化,然後再建立訊息佇列、訊號量、互斥量、事件以及任務等操作。
在排程器掛起時呼叫 API 函式,導致應用程式崩潰
呼叫 vTaskSuspendAll()使得排程器掛起,而喚醒排程器呼叫 xTaskResumeAll()。千萬不要在排程器掛起時呼叫其它 API 函式。
關注我
更多資料歡迎關注“物聯網IoT開發”公眾號