Monday, December 5, 2011

嵌入式调试方法——printf和fprintf

除了人工的分析之外,最简单最直接的调试方法要算printf了。不过,我们这里推荐使用的并不是初学C语言时使用的函数int printf(const char *format, ...),而是稍微复杂一点的fprintf()函数,因为它更方便我们之后重定向错误输出信息到指定的设备。fprintf()函数的原型如下:
int fprintf(FILE *stream, const char *format, ...)
可以看到,它与printf()函数相比多出来了第一个参数FILE *stream,其意义是将打印的内容输出到文件流指针stream指向的流。所谓流,通常是指程序输入或输出的一个连续的字节序列,设备(例如鼠标、键盘、磁盘、屏幕、调制解调器和打印机)的输入和输出都是用流来处理的,在C语言中,所有的流均以文件的形式出现——不一定是物理磁盘文件,还可以是对应于某个输入/输出源的逻辑文件。C语言提供了5种标准的流,你的程序在任何时候都可以使用它们,并且不必打开或关闭它们。以下列出了这5种标准的流。
------------------------------------------------
名称 描 述 例 子
------------------------------------------------
stdin 标准输入 键盘
stdout 标准输出 屏幕
stderr 标准错误 屏幕
stdprn 标准打印机 LPT1端口
stdaux 标准串行设备 COM1端口
------------------------------------------------
其中,stdprn和stdaux并不总是预先定义好的,因为LPT1和COM1端口在某些操作系统中是没有意义的,而stdin,stdout 和stderr总是预先定义好的。此外,stdin并不一定来自键盘,stdout也并不一定显示在屏幕上,它们都可以重定向到磁盘文件或其它设备上。我们在头文件stdio.h中可以找到stdin,stdout 和stderr的定义如下:
/* Standard streams. */
extern struct _IO_FILE *stdin; /* Standard input stream. */
extern struct _IO_FILE *stdout; /* Standard output stream. */
extern struct _IO_FILE *stderr; /* Standard error output stream. */

在使用fprintf()函数时,通常我们可以将第一个参数设为stdout或者stderr,打印出错调试信息的时候则推荐使用stderr而不是stdout,这是一种惯例,同时也由于内核在处理stdout和stderr时的优先级不一样,后者的优先级要高一些,因此有时候如果程序异常退出时,stderr能得到输出,而stdout就不行。
printf(...) 实际上相当于fprintf(stdout, ...),这也是为什么我们不推荐使用它的原因。在输出调试信息的时候,我们推荐使用fprintf(stderr, …),或者使用某个指定的文件流fprintf(some_stream, …)。
那么具体如何在必要的时候重定向fprintf()中的调试信息呢?来看看下面的一些方法:
当调试信息的量比较大,需要一些时间或者其他辅助工具来搜索过滤时,仅仅利用显示屏幕来输出调试信息是不够的,这时我们经常将这些信息输出到所谓的日志文件(log)中,之后再仔细的分析log文件来发现问题。
Ø 利用Shell的I/O重定向
简单的写log方法可以通过shell的I/O重定向机制来实现,比如下面的代码:
1 #include
2
3 int main()
4 {
5 fprintf(stdout, "This is a standard output info!\n");
6 fprintf(stderr, "This is a standard error output info!\n");
7 return 0;
8 }

在默认条件下,编译运行的结果是打印信息都输出在屏幕上:
$ gcc fprint.c -o fprint
$ ./fprint
This is a standard output info!
This is a standard error output info!
这是因为默认情况下,shell所打开的stdout和stderr设备都是显示屏幕。不过我们可以通过shell的重定向功能来将打印信息写到文件中去。比如:
$ ./fprint >output.log
This is a standard error output info!
$ cat output.log
This is a standard output info!
这样,我们把stdout的输出写到了文件output.log中,不过stderr的输出还是在屏幕上。如何重定向stderr呢?这需要用到shell定义的文件描述符。在shell下stdin, stdout, 和stderr的文件描述符分别是0, 1和2,我们可以用下面的方法重定向:
$ ./fprint >output.log 2>error.log
$ cat output.log
This is a standard output info!
$ cat error.log
This is a standard error output info!
$
$ ./fprint >output.log 2>&1
$ cat output.log
This is a standard error output info!
This is a standard output info!
其中./fprint >output.log 2>error.log分别将stdout和stderr的输出写入到文件output.log和error.log中,而./fprint >output.log 2>&1则表示将stderr的输出追加到stdout的文件output.log中(结果是output.log中既有stdout输出也有stderr输出)。
一些常用的shell I/O语法如下:
cmd > file 把 stdout 重定向到 file 文件中
cmd >> file 把 stdout 重定向到 file 文件中(追加)
cmd 1> fiel 把 stdout 重定向到 file 文件中
cmd > file 2>&1 把 stdout 和 stderr 一起重定向到 file 文件中
cmd 2> file 把 stderr 重定向到 file 文件中
cmd 2>> file 把 stderr 重定向到 file 文件中(追加)
cmd >> file 2>&1 把 stderr 和 stderr 一起重定向到 file 文件中(追加)
在平时的简单调试中,我们可以灵活利用这些方法来快速得到log文件。

Ø 用freopen()进行重定向
有时候我们要求在程序中能够控制标准流的重定向,这时可以利用标准C库函数freopen()。freopen()的函数原型如下:
FILE *freopen(const char *filename, const char *mode, FILE *stream)

下面的代码用来测试用函数freopen()重定向stderr:
1 #include
2
3 int main()
4 {
5 if (freopen("err.log", "w", stderr)==NULL)
6 fprintf(stderr, "error redirecting stderr\n");
7 fprintf(stdout, "This is a standard output info!\n");
8 fprintf(stderr, "This is a standard error output info!\n");
9 fclose(stderr);
10 return 0;
11 }
在第5行我们用freopen()函数将stderr重定向到了”err.log”文件,这样得到的结果如下:
$ gcc print_log.c -o print_log
$ ./print_log
This is a standard output info!
$ cat err.log
This is a standard error output info!
可见第8行打印到stderr的信息被重定向到了err.log文件中,而第7行stdout的打印信息则还是输出到了屏幕上。

No comments:

Post a Comment