在调试程序时&＃xff0c;输出调试信息是一种普遍、有效的方法。输出调试信息一般有以下五种方法&＃xff1a;
方法一&＃xff1a;直接使用屏幕打印函数printf。
该方法直接在需要输出调试信息的位置使用函数printf输出相应的调试信息&＃xff0c;以及某些关键变量的值。我们通过以下求阶层的函数fact来看看该方法的调试程序过程。#include int fact(int n){int i,f&＃61;1;for( i&＃61;1; i<&＃61;n; i&＃43;&＃43;){f &＃43;&＃61; i;}return f;}int main(){printf( "4!&＃61;%d/n", fact(4) );return 0;}程序1: 有bug的求阶层函数
程序1编译运行的结果如下&＃xff1a;4!&＃61;11
结果错误。为了找到结果错误的原因&＃xff0c;我们在语句"f &＃43;&＃61; i;"之后插入函数printf输出调试信息&＃xff0c;如程序2。#include int fact(int n){int i,f&＃61;1;for( i&＃61;1; i<&＃61;n; i&＃43;&＃43;){f &＃43;&＃61; i;printf("i&＃61;%d ; f&＃61;%d/n", i, f);}return f;}int main(){printf( "4!&＃61;%d/n", fact(4) );return 0;}程序2: 加入函数printf输出调试信息的求阶层函数
再编译运行该程序&＃xff0c;屏幕输出如下&＃xff1a;i&＃61;1 ; f&＃61;2 i&＃61;2 ; f&＃61;4 i&＃61;3 ; f&＃61;7 i&＃61;4 ; f&＃61;11 4!&＃61;11
原来语句"f &＃43;&＃61; i"错了&＃xff0c;应该为"f *&＃61;i"。修改过来(见程序3)&＃xff0c;再编译运行&＃xff0c;结果如下&＃xff1a;i&＃61;1 ; f&＃61;1 i&＃61;2 ; f&＃61;2 i&＃61;3 ; f&＃61;6 i&＃61;4 ; f&＃61;24 4!&＃61;24#include
int fact(int n)
{
int i,f&＃61;1;
for( i&＃61;1; i<&＃61;n; i&＃43;&＃43;)
{
f *&＃61; i;
printf("i&＃61;%d ; f&＃61;%d/n", i, f);
}
return f;
}
int main()
{
printf( "4!&＃61;%d/n", fact(4) );
return 0;
}
程序3: 修改正确的求阶层函数
调试完成&＃xff0c;bug找到&＃xff0c;并修改正确。然后将加入的调试的函数printf 删除或注释掉。
该方法的缺点是(1)在正式发布的程序中需要去除或注释掉这些调试语句&＃xff1b;(2)若程序又出现bug&＃xff0c;则又需要重新插入函数printf输出调试信息&＃xff0c;造成工作的重复。
方法二&＃xff1a;自定义调试函数debug。
为 了避免方法一的缺点&＃xff0c;可以利用条件编译技术&＃xff0c;如程序4自定义调试函数debug。当程序正式发布的编译时取消宏定义__DEBUG__&＃xff0c;在正式发布的程序 中就不会输出调试信息。若又出现bug&＃xff0c;只要重新在编译程序时定义宏__DEBUG__即可恢复原来的调试信息输出。可以在编写程序时就有目的事先插入些 调试语句&＃xff0c;这将有益于调试程序。另外&＃xff0c;可以根据需要编写函数debug&＃xff0c;将调试信息输出到除屏幕以外的其它地方&＃xff0c;如文件或syslog服务器等。#include #ifdef __DEBUG__#include void debug(const char *fmt, ...){va_list ap;va_start(ap, fmt);vprintf(fmt, ap);va_end(ap);}#elsevoid debug(const char *fmt, ...){}#endifint fact(int n){int i, f &＃61; 1;for( i&＃61;1; i<&＃61;n; i&＃43;&＃43;){f *&＃61; i;debug("i&＃61;%d ; f&＃61;%d/n", i, f);}return f;}int main(){printf( "4!&＃61;%d/n", fact(4) );return 0;}程序4: 自定义调试函数debug
该方法的缺点是(1)调试信息要么全部输出&＃xff0c;要么全不输出&＃xff1b;(2)要重新输出调试信息时需要重新编译程序。
方法三&＃xff1a;含调试等级的自定义调试函数debug。
可 以继续改进方法&＃xff0c;避免方法二中的缺点。我们可以根据调试信息的细节程度&＃xff0c;将调试信息分成不同的等级。调试信息的等级必须大于0&＃xff0c;若调试信息细节程度越高&＃xff0c; 则等级越高。在输出调试信息时&＃xff0c;若调试等级高于调试信息等级才输出调试信息&＃xff0c;否则忽略该调试信息&＃xff0c;如程序5。当调试等级为0时&＃xff0c;则不输出任何调试信息。#include #include /* atoi() */#include int debug_level;void debug(int level, const char *fmt, ...){if( level <&＃61; debug_level ){va_list ap;va_start(ap, fmt);vprintf(fmt, ap);va_end(ap);}}int fact(int n){int i, f &＃61; 1;for( i&＃61;1; i<&＃61;n; i&＃43;&＃43;){f *&＃61; i;debug(250, "i&＃61;%d ; f&＃61;%d/n", i, f);}return f;}int main(int argc, char *argv[]){if ( argc <2 ){debug_level &＃61; 0;}else{debug_level &＃61; atoi(argv[1]);}printf( "4!&＃61;%d/n", fact(4) );return 0;}程序5: 含调试等级的自定义调试函数debug
用命令"gcc -Wall -o fact fact.c"编译程序5&＃xff0c;得到可执行文件 fact。若需要输出调试信息&＃xff0c;只需要指定调试等级不低于250即可&＃xff0c;如运行命令"./fact 250"&＃xff0c;否则将不会输出调试信息。
这样&＃xff0c;在正式发布版中包含调试信息也无伤大雅了&＃xff0c;因为只需将调试等级配置为0&＃xff0c;将不会出现任何调试信息。
该方法的缺点是效率不太高&＃xff0c;因为不管调试信息是否需要输出&＃xff0c;都会进行一次函数调用。若不需要输出调试信息&＃xff0c;这次函数调用就多余了。
方法四&＃xff1a;调试等级的判断放在自定义调试函数debug之外。
为了减少不必要的函数调用&＃xff0c;可以用宏定义将调试等级的判断放在函数debug之外&＃xff0c;如程序6。#include #include /* atoi() */#include int debug_level;#define debug(level, fmt, arg...) /if( level <&＃61; debug_level ) __debug(fmt, ##arg)void __debug(const char *fmt, ...){va_list ap;va_start(ap, fmt);vprintf(fmt, ap);va_end(ap);}int fact(int n)
{
int i, f &＃61; 1;
for( i&＃61;1; i<&＃61;n; i&＃43;&＃43;)
{
f *&＃61; i;
debug(250, "i&＃61;%d ; f&＃61;%d/n", i, f);
}
return f;
}
int main(int argc, char *argv[])
{
if ( argc <2 )
{
debug_level &＃61; 0;
}
else
{
debug_level &＃61; atoi(argv[1]);
}
printf( "4!&＃61;%d/n", fact(4) );
return 0;
}
程序6: 调试等级的判断放在自定义调试函数debug之外
这种方法对于不需要输出的高等级的调试信息操作来说&＃xff0c;仅仅多了个两个整数之间的大小判断。在正式的程序运行时&＃xff0c;效率是有所提高的。
但 这种调试信息输出的方法依然不够完美。对于一个大项目&＃xff0c;一般分为若干个模块&＃xff0c;bug将会定位到某个或某几个模块。若整个项目的调试信息都输出&＃xff0c;信息量将会 非常大&＃xff0c;也容易干扰调试人员的思维。这时&＃xff0c;我们需要的是只输出我们关心的那些模块的调试信息&＃xff0c;但该方法并不能达到我们的要求。它只能根据调试等级输出信 息&＃xff0c;对于同一调试等级的信息要么全输出&＃xff0c;要么全不输出。
方法五&＃xff1a;根据不同的功能模块分别定义不同的调试等级。
在squid[1]中&＃xff0c;定义了以下的功能模块调试等级变量和调试函数&＃xff1a;int debugLevels[MAX_DEBUG_SECTIONS];#define debug(SECTION, LEVEL) /((_db_level &＃61; (LEVEL)) > debugLevels[SECTION]) ? (void) 0 : _db_print
然后在程序中如下使用它&＃xff1a;debug(17, 3) ("fwdStateFree: %p/n", fwdState);
上述调试函数很灵活&＃xff0c;可以在不同的模块中定义有不同的调试等级&＃xff0c;当需要调试某功能时&＃xff0c;只需将该模块的调试等级定义为相应的等级&＃xff0c;就可输出需要的调试信息。
根据方法五的思想&＃xff0c;本人编写了my_debug.h(见程序7)和my_debug.c 文件(见程序8)。该文件可以应用于C语言程序中&＃xff0c;支持根据不同的功能模块分别定义不同的调试等级。
#ifndef MY_DEBUG_H
#define MY_DEBUG_H
#include
// 模块功能号
enum {
MY_SECTION_FACT &＃61; 0,
MY_SECTION_nnn1,
MY_SECTION_nnn2,
MY_SECTION_nnnn,
MY_SECTION_END,
};
// 非my_debug.c文件的外部变量声明
#ifndef MY_DEBUG_C
extern int __my_allow_debug_levels[MY_SECTION_END];
#endif
// (内部使用) 判断"SECTION"模块功能号是否允许"DEBUG_LEVEL"等级的调试信息输出
#define __my_unallow_debug(SECTION, DEBUG_LEVEL) /
( DEBUG_LEVEL > __my_allow_debug_levels[SECTION] )
// (内部使用) 调试信息输出函数
#define __my_debug(FORMAT, ARG...) /
printf("%s:%d %s: " FORMAT, __FILE__, __LINE__, __FUNCTION__, ##ARG)
// 初始化"SECTION"模块功能号的调试等级
#define my_init_debug_levels(SECTION, ALLOW_DEBUG_LEVEL) /
( __my_allow_debug_levels[SECTION] &＃61; ALLOW_DEBUG_LEVEL )
// 调试信息输出函数&＃xff0c;该信息为"SECTION"模块功能号"DEBUG_LEVEL"等级的调试信息
#define my_debug(SECTION, DEBUG_LEVEL) /
( __my_unallow_debug(SECTION, DEBUG_LEVEL) ) ? (void) 0 : __my_debug
#endif //MY_DEBUG_H
程序7: my_debug.h
#define MY_DEBUG_C
#include "my_debug.h"
int __my_allow_debug_levels[MY_SECTION_END];
程序8: my_debug.c
要使用上述文件&＃xff0c;先得根据功能模块的数目扩展my_debug.h中的“模块功能号”枚举类型&＃xff0c;然后在程序相应位置中调用宏定义my_init_debug_levels 初始化相应模块的调试等级&＃xff0c;在所有需要输出调试信息的位置如下编写即可。my_debug(MY_SECTION_FACT, 250)("i&＃61;%d ; f&＃61;%d/n", i, f);
下面我们来看看如何在fact.c中使用它们(见程序9)。#include #include #include "my_debug.h"int fact(int n){int i, f &＃61; 1;for( i&＃61;1; i<&＃61;n; i&＃43;&＃43;){f *&＃61; i;my_debug(MY_SECTION_FACT, 250)("i&＃61;%d ; f&＃61;%d/n", i, f);}return f;}int main(int argc, char *argv[]){if ( argc <2 ){my_init_debug_levels(MY_SECTION_FACT, 0);}else{my_init_debug_levels(MY_SECTION_FACT, atoi(argv[1]));}printf( "4!&＃61;%d/n", fact(4) );return 0;}程序9: fact.c
参考文献&＃xff1a;
京公网安备 11010802041100号