Debug Tips

前一段时间看一个BIOS的bug，当时已经可以确定system hang有时会hang在一个driver里面，为了能够narrow down到具体的某个函数的某一行 所以就需要加入一些debug message。一开始我就在每个函数里面DEBUG这个函数的名称，或者当前在做什么之类的字符串，可是加了几个函数就烦了，实在是太多了，就算是copy一下改个字符串也是相当费劲后来就想到了下面的做法：


DEBUG ((EFI_D_ERROR, "File : %a,Function : %a,Line : %d.\n", __FILE__,__FUNCTION__,__LINE__));


__FILE__ 和 __LINE__是编译器预定义的宏，其中__FILE__ 表示当前源文件的名称。 __FILE__ 扩展到双引号括起来的字符串。 若要确保显示文件的完整路径，需要用 /FC（所诊断源代码文件的完整路径）。__LINE__表示当前源文件中的行号。 行号是一个十进制整数常数。 它可以随 #line 指令改变。


__FUNCTION__ 有点不一样，它仅在函数中有效，它是函数的名称的字符串表示。如果你使用的是 /EP 或 /P 编译器选项，__FUNCTION__ 的宏定义就无效了。


所以基于以上的解释，DEBUG ((EFI_D_ERROR, "File : %a,Function : %a,Line : %d.\n", __FILE__,__FUNCTION__,__LINE__));将会显示目前所在文件，函数名，以及具体的哪一行。这样我就一劳永逸了，我只需要在想抛debug message的地方copy一行就可以了，配合神器Sublime Text连copy都省了，一步搞定。


输出的log会是这样：


File : *\*\Chipset\IntelMch\SystemAgent\MemoryInit\Pei\MemoryInit.c,Function : GetMemoryMap,Line : 2775.


Refer：
http://msdn.microsoft.com/zh-cn/library/b0084kay.aspx
http://stackoverflow.com/questions/597078/file-line-and-function-usage-in-c