品赏Apache源码中的apr_dbg_log函数
前言:
对于调试所给予的期望就是想知道:错误出现在我的源代码什么位置.用WinDbg,NTSD之类的调试工具需要知道一些预备知识,所以说不利于推广.前段时间在看Apace的源代码的时候发现Apace中用到了一些有意思的方便定位的方式方法,当然Apache主要是用这个方法来采集一些运行数据,与大家共勉…..先说最简单的一个….写log文件.
详细内容:
在Apache中她重定义了所有的Win32 API,其中一些关键的API比如sock类API ,Apache希望能跟踪它们在任何时候任何场合的调用以方便确定这方面的错误的位置(在源代码中的位置).所以对于这些API Apache是这样重定义它们的:
/******************************************************************************
socket是一个Win32 API函数,在此它将被重定义
‘\’ 代表源代码中的换行符
spr_dbg_log 是一个函数,用来记录该次调用的socket函数在源代码中位置
__FILE__,__LINE___是Windows环境下的预定义宏.分别表示当前的原文件,行号.
******************************************************************************/
#define socket(i1,i2,i3)
((SOCKET)apr_dbg_log("socket",
(HANDLE)(socket)(i1,i2,i3),
__FILE__,__LINE__,0))
最重要的就是apr_dbg_log函数了,这个函数着实体现了高手的水平:里面考虑了多线程调用该函数的时候应该怎么办…. ,大家需要注意的是:”因为该函数需要用在宏中所以里面的每一个函数要用括号括起来”.至于原因任何C的书籍在说宏的时候都会提到这一点的对吧.”
HANDLE apr_dbg_log(char* fn, // 被跟踪的函数的函数名描述
HANDLE ha, // 被跟踪的函数返回值
char* fl, // __FILE__
int ln, // __LINE__
int nh, // Apache针对事件,信号函数定义的一个指示变量,我查了一下源代码,发
// 现在2.0.45版本中很好用到这个参数,大部分都是用0作为传入参数
...)
{
static DWORD tlsid = 0xFFFFFFFF;
static HANDLE fh = NULL;
static long ctr = 0;
static CRITICAL_SECTION cs;
long seq;
DWORD wrote;
char *sbuf;
//
// seq记录了ha所指示的函数(在这个例子中指的是socket函数)被调用的次数.
// 相当于是一个计数器,为了保证在多线程环境下计数依然正确需要用到原子操作API:InterlockedIncrement
// 当然,现在该函数有了新的替代函数: InterlockedExchangeAdd(详情请参看”Windows核心编程”第八章)
//
seq = (InterlockedIncrement)(&ctr);
if (tlsid == 0xFFFFFFFF) {
tlsid = (TlsAlloc)();
}
// 防止buffer在多个线程调用间被不正确地改写用TLS机制(线程本地存储)使得
// buffer和特定的线程相关…
sbuf = (char *)(TlsGetValue)(tlsid);
if (!fh || !sbuf) {
sbuf = (char *)(malloc)(1024);
(TlsSetValue)(tlsid, sbuf);
sbuf[1023] = '\0';
if (!fh) {
(GetModuleFileName)(NULL, sbuf, 250);
sprintf(strchr(sbuf, '\0'), ".%d",(GetCurrentProcessId)());
// 创建log文件,该文件名前缀是可执行文件的文件名,后缀是Thread ID,以保证唯一性.
fh = (CreateFile)(sbuf, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, NULL);
(InitializeCriticalSection)(&cs);
}
}
if (!nh) // nh == 0的时候
{
(sprintf)(sbuf, "%08x %08x %08x %s() %s:%d\n",(DWORD)ha, seq, GetCurrentThreadId(), fn, fl, ln);
// 和上面的seq的处理一样:为了达到多线程中的同步问题使用”关键代码段”机制来向文件中写log
(EnterCriticalSection)(&cs);
(WriteFile)(fh, sbuf, strlen(sbuf), &wrote, NULL);
(LeaveCriticalSection)(&cs);
} // nh != 0的时候,这种情况很少,至少我在2.0.45版本中只找到了WaitForSingleObject之类的少数几
// 个用到了…也具体不是很清楚它的含义,动机…:-(
else {
...// 不知道为什么这段代码始终无法上传到CSDN上来，FT!
}
return ha;
}
下面就是该函数输出的log纪录的样子
返回地址 被调用次数 ThreadID 函数名 该函数被调的位置(在源代码中的位置)
ffffffff 00000001 0000024c socket() E:\MyCode\Analyze Apache\apr_dbg_log\apr_dbg_log.cpp:89
ffffffff 00000002 00000510 socket() E:\MyCode\Analyze Apache\apr_dbg_log\apr_dbg_log.cpp:89
ffffffff 00000003 00000760 socket() E:\MyCode\Analyze Apache\apr_dbg_log\apr_dbg_log.cpp:89
总结:
牺牲一点效率来换得跟踪问题的简便性.