筆記：把編譯時間加入到目標文件

1. 問題背景：如何保證發布出去的bin文件是最終測試通過的版本？

    一般的來講，代碼到了測試后期，master分支就不會頻繁的提交了，並且提交也會更加謹慎。

    但是人為操作總會出現紕漏，希望只要代碼被重新編譯過，那么bin文件就包含新的時間信息，而這個信息是可以從外部通信或printf來查看的。

    在嵌入式開發中，版本號一般的都是一個int變量或字符串變量。但是若修改了代碼而沒有改version變量或宏定義，那么從version上就看不出來文件的變化。

    那么最終編譯的版本到底是哪個版本，是否與測試的版本完全一致，這個問題尤為突出。

    目標文件中帶有編譯時間可以防止代碼被改動過，只要代碼被重新編譯，那么就生成新的時間信息。

    git能夠記錄文件修改信息，但是調試信息或工程配置等，很多文件都是ignore的，這些信息代表着最終的bin文件的運行環境。

    某些復雜bug情況下，只有運行環境一致，仿真器才能attach到目標文件。

 

2. 如何獲取時間：__DATA__, __TIME__

     這兩個宏是日期和時間，格式如下。如果把這兩個宏加入到代碼，那么就得到了時間的字符串信息。

// Example of __DATE__ string: "Dec 27 2017"
// Example of __TIME__ string: "15:06:19"

const char *BuildInfo = "Version: " VERSION " " __DATE__ " " __TIME__;

代碼實現獲取日期和時間的方法很多，比如：

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:\t%04u-%02u-%02us %02u:%02u:%02u\n", 
                year, month, day,
                hour, minute,seconds);
    
    #else        
        printf("[null]  ** Build at:\t%04u-%02u-%02u %02u:%02u:%02u\n", 
                year, month, day,
                hour, minute,seconds);
    #endif
    
    DEBUG("buildDate: %s %s\n", __DATE__, __TIME__);          
    
    return 0;
}

 

把上面的函數加入到代碼中，就能獲取工程編譯的時間。

但是如果該代碼所在的文件沒有被修改，在非build-all情況下，編譯器不會再次編譯此文件，所以時間信息也就不會被更新。

如果每次都使用re-build all，一來繁瑣，二來也不能保證每次都會記得點擊build all按鈕，靠技術手段來保證每次build都更新時間信息才是正道。

 

3. 如何保證時間每次編譯都更新：使用預編譯指令，每次更新包含時間宏的文件或對應的鏈接文件。

在IAR環境下，官方已經給出了解決的方法（Using pre-build actions for time stamping）。

Technical Note 99436

https://www.iar.com/support/tech-notes/ide/build-actions-pre-build-and-post-build/

方法1：修改文件的時間，引起編譯器對文件進行重新編譯。

cmd /c "touch /cygdrive/d/test.c"

    方法雖好，可惜IAR用戶大多數是Windows用戶，包括我在內，touch是linux命令，必須Cywin環境。如果安裝過這個環境的話，那就大功告成了。

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：修改文件對應的鏈接文件，觸發編譯器重新編譯該文件，生成新的鏈接文件，那么就會生成新的帶有時間信息的目標文件。

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$\test.o""

在pre-build中加入上面的命令，就會在編譯前刪除test.o文件。

在這種模式下，工程代碼只要任何位置發生變化，代碼重新編譯，就會觸發刪除test.o，然后鏈接過程發現沒有test.o文件，那么就會重新編譯一次test.c，那么新的時間信息就會記錄下來了。

雖有些曲線救國的味道，但還是很順利的實現了目標。

只要工程的任何地方有改動，生成新的目標文件，那么目標文件中就會帶有最新的編譯時間。

 

方法3：直接告訴編譯器每次重新編譯某個文件更直接，MDK支持此功能。

時隔一年半再次來這里，發現當時自己簡直是小白，還洋洋得意曲線救國，實際上舍近求遠罷了。

如果對工具多一些了解，萬萬是不會用上面的方法的，當然上面的方法也是通用想法，是通用型知識點，容易想到，也能達到目標。

新的方法，不需要寫任何腳本，如果想讓代碼每次都編譯更新DATA 和 TIME兩個宏，那么讓這個文件每次都編譯一次就可以了，不需要刪除它的obj文件然后讓編譯器找不到文件而觸發重新編一次，其實直接告訴編譯器每次重新編譯更直接，MDK支持此功能。

 

下面是測試的效果：

 

 

其他：How to use __DATE__ and __TIME__ predefined macros in as two integers, then stringify?

https://stackoverflow.com/questions/11697820/how-to-use-date-and-time-predefined-macros-in-as-two-integers-then-stri