嵌入式軟件，如何把編譯時(shí)間加入到bin文件，進(jìn)行版本管理？

工程師進(jìn)階筆記 · 發(fā)表于 2024-11-27 17:50:00

我是老溫，一名熱愛(ài)學(xué)習(xí)的嵌入式工程師
關(guān)注我，一起變得更加優(yōu)秀！
嵌入式軟件工程師在發(fā)布固件之前，通常都需要先進(jìn)行提測(cè)，提測(cè)過(guò)程中會(huì)不斷發(fā)現(xiàn)和修復(fù)bug，期間會(huì)涉及到不斷地編譯固件和更新固件版本，那么問(wèn)題來(lái)了：

如何保證發(fā)布出去的bin文件是最終測(cè)試通過(guò)的版本？

一般的來(lái)講，代碼到了測(cè)試后期，master分支就不會(huì)頻繁的提交了，并且提交也會(huì)更加謹(jǐn)慎。
但是人為操作總會(huì)出現(xiàn)紕漏，希望只要代碼被重新編譯過(guò)，那么bin文件就包含新的時(shí)間信息，而這個(gè)信息是可以從外部通信或printf來(lái)查看的。
在嵌入式開(kāi)發(fā)中，版本號(hào)一般的都是一個(gè)int變量或字符串變量。但是若修改了代碼而沒(méi)有改version變量或宏定義，那么從version上就看不出來(lái)文件的變化。
那么最終編譯的版本到底是哪個(gè)版本，是否與測(cè)試的版本完全一致，這個(gè)問(wèn)題尤為突出。
目標(biāo)文件中帶有編譯時(shí)間可以防止代碼被改動(dòng)過(guò)，只要代碼被重新編譯，那么就生成新的時(shí)間信息。
git能夠記錄文件修改信息，但是調(diào)試信息或工程配置等，很多文件都是ignore的，這些信息代表著最終的bin文件的運(yùn)行環(huán)境。
某些復(fù)雜bug情況下，只有運(yùn)行環(huán)境一致，仿真器才能attach到目標(biāo)文件。

如何獲取時(shí)間？
: \0 V1 T" i4 C/ W$ u9 d9 K

這兩個(gè)宏是日期和時(shí)間，格式如下。如果把這兩個(gè)宏加入到代碼，那么就得到了時(shí)間的字符串信息。
// Example of __DATE__ string: "Dec 27 2017"
// Example of __TIME__ string: "15:06:19"
const char *BuildInfo = "Version: " VERSION " " __DATE__ " " __TIME__;
代碼實(shí)現(xiàn)獲取日期和時(shí)間的方法很多，比如：
unsigned int mk_Build_Date(void)
{
int year = 0, month = 0, day = 0;
int hour = 0, minute = 0, seconds = 0;
char m[4] = {0};
sscanf(__DATE__, "%3s %2d %4d", m, &day, &year);
for (month = 0; month 12; month++)
{
      if (strcmp(m, short_char_months[month]) == 0)
      {
         break;
      }
}
sscanf(__TIME__, "%2d:%2d:%2d", &hour, &minute, &seconds);
#ifdef SHORT_DATA_CHAR__
      printf("[null]  ** Build at: %04u-%02u-%02us %02u:%02u:%02u
",
            year, month, day,
            hour, minute,seconds);
#else
      printf("[null]  ** Build at: %04u-%02u-%02u %02u:%02u:%02u
",
            year, month, day,
            hour, minute,seconds);
#endif
DEBUG("buildDate: %s %s
", __DATE__, __TIME__);
return 0;
}
把上面的函數(shù)加入到代碼中，就能獲取工程編譯的時(shí)間。
但是如果該代碼所在的文件沒(méi)有被修改，在非build-all情況下，編譯器不會(huì)再次編譯此文件，所以時(shí)間信息也就不會(huì)被更新。
如果每次都使用re-build all，一來(lái)繁瑣，二來(lái)也不能保證每次都會(huì)記得點(diǎn)擊build all按鈕，靠技術(shù)手段來(lái)保證每次build都更新時(shí)間信息才是正道。
如何保證時(shí)間每次編譯都更新？

: ~- ~1 H; \! r4 w, u
使用預(yù)編譯指令，每次更新包含時(shí)間宏的文件或?qū)?yīng)的鏈接文件。
在IAR環(huán)境下，官方已經(jīng)給出了解決的方法（Using pre-build actions for time stamping）。
https://www.iar.com/support/tech-notes/ide/build-actions-pre-build-and-post-build/
' X7 B7 t" i/ z% @+ p  n6 m( a方法1：修改文件的時(shí)間，引起編譯器對(duì)文件進(jìn)行重新編譯。
cmd /c "touch /cygdrive/d/test.c"
方法雖好，可惜IAR用戶(hù)大多數(shù)是Windows用戶(hù)，包括我在內(nèi)，touch是linux命令，必須Cywin環(huán)境。如果安裝過(guò)這個(gè)環(huán)境的話，那就大功告成了。
Cygwin touch command
You can enter "cygwin-application.exe" on the pre- and post-build command lines, if the environment variable PATH includes the directory where the "cygwin-application.exe" is located.
You can run the Cygwin command "touch" on the pre-build command line, but if you add a file path, for example "touch d:/test.c", the file path is not accepted by Cygwin.
Cygwin expects the POSIX path /cygdrive/d/test.c so the resulting command line would be "touch /cygdrive/d/test.c", however this command cannot be executed directly on the pre- and post-build command. Instead you have to run indirectly using:
cmd /c "touch /cygdrive/d/test.c"
The .bat file (located in project directory) alternative would look like:
Pre-build command line:
$PROJ_DIR$\pre-build.bat
File pre-build.bat:
touch /cygdrive/d/test.c
方法2：修改文件對(duì)應(yīng)的鏈接文件，觸發(fā)編譯器重新編譯該文件，生成新的鏈接文件，那么就會(huì)生成新的帶有時(shí)間信息的目標(biāo)文件。
An alternative to the "touch" command is to have a pre-build action that deletes the object file, for example the Pre-build command line:
cmd /c "del "$OBJ_DIR$ est.o""
在pre-build中加入上面的命令，就會(huì)在編譯前刪除test.o文件。
在這種模式下，工程代碼只要任何位置發(fā)生變化，代碼重新編譯，就會(huì)觸發(fā)刪除test.o，然后鏈接過(guò)程發(fā)現(xiàn)沒(méi)有test.o文件，那么就會(huì)重新編譯一次test.c，那么新的時(shí)間信息就會(huì)記錄下來(lái)了。
雖有些曲線救國(guó)的味道，但還是很順利的實(shí)現(xiàn)了目標(biāo)。
只要工程的任何地方有改動(dòng)，生成新的目標(biāo)文件，那么目標(biāo)文件中就會(huì)帶有最新的編譯時(shí)間。
方法3：直接告訴編譯器每次重新編譯某個(gè)文件更直接，MDK支持此功能。
時(shí)隔一年半再次來(lái)這里，發(fā)現(xiàn)當(dāng)時(shí)自己簡(jiǎn)直是小白，還洋洋得意曲線救國(guó)，實(shí)際上舍近求遠(yuǎn)罷了。
如果對(duì)工具多一些了解，萬(wàn)萬(wàn)是不會(huì)用上面的方法的，當(dāng)然上面的方法也是通用想法，是通用型知識(shí)點(diǎn)，容易想到，也能達(dá)到目標(biāo)。
新的方法，不需要寫(xiě)任何腳本，如果想讓代碼每次都編譯更新DATA 和 TIME兩個(gè)宏，那么讓這個(gè)文件每次都編譯一次就可以了，不需要?jiǎng)h除它的obj文件然后讓編譯器找不到文件而觸發(fā)重新編一次，其實(shí)直接告訴編譯器每次重新編譯更直接，MDK支持此功能。

下面是測(cè)試的效果：

其它資料：
https://stackoverflow.com/questions/11697820/how-to-use-date-and-time-predefined-macros-in-as-two-integers-then-stri
! g6 M: Q4 P0 q1 @來(lái)源：Internet。
-END-
往期推薦：點(diǎn)擊圖片即可跳轉(zhuǎn)閱讀