名字:
valgrind是一个调试和剖析的程序工具集。
概要用法:
valgrind [[valgrind] [options]] [your-program] [[your-program-options]]
概述:
Valgrind是一个Linux下灵活的调试和剖析可执行工具。它由在软件层提供综合的
CPU内核,和一系列调试、剖析的工具组成。架构是模块化的,所以可以在不破坏现
有的结构的基础上很容易的创建出新的工具来。
这本手册包括了基本的用法和选项。更多帮助理解的信息,请查看您系统的HTML
文档:
/usr/share/doc/valgrind/html/index.html
或者在线文档:
http://www.valgrind.org/docs/manual/index.html.
用法:
一般像下面这样调用Valgrind:
valgrind program args
这样将在Valgrind使用Memcheck运行程序program(带有参数args)。内存检查
执行一系列的内存检查功能,包括检测访问未初始化的内存,已经分配内存的错误
使用(两次释放,释放后再访问,等等)并检查内存泄漏。
可用--tool指定使用其它工具:
valgrind --tool=toolname program args
可使用的工具如下:
o cachegrind是一个缓冲模拟器。它可以用来标出你的程序每一行执行的指令
数和导致的缓冲不命中数。
o callgrind在cachegrind基础上添加调用追踪。它可以用来得到调用的次数
以及每次函数调用的开销。作为对cachegrind的补充,callgrind可以分别
标注各个线程,以及程序反汇编输出的每条指令的执行次数以及缓存未命中
数。
o helgrind能够发现程序中潜在的条件竞争。
o lackey是一个示例程序,以其为模版可以创建你自己的工具。在程序结束后,
它打印出一些基本的关于程序执行统计数据。
o massif是一个堆剖析器,它测量你的程序使用了多少堆内存。
o memcheck是一个细粒度的的内存检查器。
o none没有任何功能。它它一般用于Valgrind的调试和基准测试。
基本选项:
这些选项对所有工具都有效。
-h --help
显示所有选项的帮助,包括内核和选定的工具两者。
--help-debug
和--help相同,并且还能显示通常只有Valgrind的开发人员使用的调试
选项。
--version
显示Valgrind内核的版本号。工具可以有他们自已的版本号。这是一种
保证工具只在它们可以运行的内核上工作的一种设置。这样可以减少在
工具和内核之间版本兼容性导致奇怪问题的概率。
-q --quiet
安静的运行,只打印错误信息。在进行回归测试或者有其它的自动化测
试机制时会非常有用。
-v --verbose
显示详细信息。在各个方面显示你的程序的额外信息,例如:共享对象
加载,使用的重置,执行引擎和工具的进程,异常行为的警告信息。重
复这个标记可以增加详细的级别。
-d 调试Valgrind自身发出的信息。通常只有Valgrind开发人员对此感兴趣。
重复这个标记可以产生更详细的输出。如果你希望发送一个bug报告,通
过-v -v -d -d生成的输出会使你的报告更加有效。
--tool=<toolname> [default: memcheck]
运行toolname指定的Valgrind,例如,Memcheck, Addrcheck, Cachegrind,
等等。
--trace-children=<yes|no> [default: no]
当这个选项打开时,Valgrind会跟踪到子进程中。这经常会导致困惑,而
且通常不是你所期望的,所以默认这个选项是关闭的。
--track-fds=<yes|no> [default: no]
当这个选项打开时,Valgrind会在退出时打印一个打开文件描述符的列表。
每个文件描述符都会打印出一个文件是在哪里打开的栈回溯,和任何与此
文件描述符相关的详细信息比如文件名或socket信息。
--time-stamp=<yes|no> [default: no]
当这个选项打开时,每条信息之前都有一个从程序开始消逝的时间,用天,
小时,分钟,秒和毫秒表示。
--log-fd=<number> [default: 2, stderr]
指定Valgrind把它所有的消息都输出到一个指定的文件描述符中去。默认值
2, 是标准错误输出(stderr)。注意这可能会干扰到客户端自身对stderr
的使用, Valgrind的输出与客户程序的输出将穿插在一起输出到stderr。
--log-file=<filename>
指定Valgrind把它所有的信息输出到指定的文件中。实际上,被创建文件的
文件名是由filename、'.'和进程号连接起来的(即<filename>.<pid>),
从而每个进程创建不同的文件。
--log-file-exactly=<filename>
类似于--log-file,但是后缀".pid"不会被添加。如果设置了这个选项,
使用Valgrind跟踪多个进程,可能会得到一个乱七八糟的文件。
--log-file-qualifier=<VAR>
当和--log-file一起使用时,日志文件名将通过环境变量$VAR来筛选。这
对于MPI程序是有益的。更多的细节,查看手册2.3节 "注解"。
--log-socket=<ip-address:port-number>
指定Valgrind输出所有的消息到指定的IP,指定的端口。当使用1500端口
时,端口有可能被忽略。如果不能建立一个到指定端口的连接,Valgrind
将输出写到标准错误(stderr)。这个选项经常和一个Valgrind监听程序一
起使用。更多的细节,查看手册2.3节 "注解"。
错误相关选项:
这些选项适用于所有产生错误的工具,比如Memcheck, 但是Cachegrind不行。
--xml=<yes|no> [default: no]
当这个选项打开时,输出将是XML格式。这是为了使用Valgrind的输出做为
输入的工具,例如GUI前端更加容易些。目前这个选项只在Memcheck时生效。
--xml-user-comment=<string>
在XML开头 附加用户注释,仅在指定了--xml=yes时生效,否则忽略。
--demangle=<yes|no> [default: yes]
打开/关闭C++的名字自动解码。默认打开。当打开时,Valgrind将尝试着把
编码过的C++名字自动转回初始状态。这个解码器可以处理g++版本为2.X,
3.X或4.X生成的符号。
一个关于名字编码解码重要的事实是,禁止文件中的解码函数名仍然使用
他们未解码的形式。Valgrind在搜寻可用的禁止条目时不对函数名解码,
因为这将使禁止文件内容依赖于Valgrind的名字解码机制状态, 会使速度
变慢,且无意义。
--num-callers=<number> [default: 12]
默认情况下,Valgrind显示12层函数调用的函数名有助于确定程序的位置。
可以通过这个选项来改变这个数字。这样有助在嵌套调用的层次很深时确定
程序的位置。注意错误信息通常只回溯到最顶上的4个函数。(当前函数,和
它的3个调用者的位置)。所以这并不影响报告的错误总数。
这个值的最大值是50。注意高的设置会使Valgrind运行得慢,并且使用更多
的内存,但是在嵌套调用层次比较高的程序中非常实用。
--error-limit=<yes|no> [default: yes]
当这个选项打开时,在总量达到10,000,000,或者1,000个不同的错误,
Valgrind停止报告错误。这是为了避免错误跟踪机制在错误很多的程序
下变成一个巨大的性能负担。
--error-exitcode=<number> [default: 0]
指定如果Valgrind在运行过程中报告任何错误时的退出返回值,有两种情
况;当设置为默认值(零)时,Valgrind返回的值将是它模拟运行的程序的
返回值。当设置为非零值时,如果Valgrind发现任何错误时则返回这个值。
在Valgrind做为一个测试工具套件的部分使用时这将非常有用,因为使测
试工具套件只检查Valgrind返回值就可以知道哪些测试用例Valgrind报告
了错误。
--show-below-main=<yes|no> [default: no]
默认地,错误时的栈回溯不显示main()之下的任何函数(或者类似的函数像
glibc的__libc_start_main(),如果main()没有出现在栈回溯中);这些大
部分都是令人厌倦的C库函数。如果打开这个选项,在main()之下的函数也
将会显示。
--suppressions=<filename> [default: $PREFIX/lib/valgrind/default.supp]
指定一个额外的文件读取不需要理会的错误;你可以根据需要使用任意多
的额外文件。
--gen-suppressions=<yes|no|all> [default: no]
当设置为yes时,Valgrind将会在每个错误显示之后自动暂停并且打印下
面这一行:
---- Print suppression ? --- [Return/N/n/Y/y/C/c] ----
这个提示的行为和--db-attach选项(见下面)相同。
如果选择是,Valgrind会打印出一个错误的禁止条目,你可以把它剪切然后
粘帖到一个文件,如果不希望在将来再看到这个错误信息。
当设置为all时,Valgrind会对每一个错误打印一条禁止条目,而不向用户
询问。
这个选项对C++程序非常有用,它打印出编译器调整过的名字。
注意打印出来的禁止条目是尽可能的特定的。如果需要把类似的条目归纳
起来,比如在函数名中添加通配符。并且,有些时候两个不同的错误也会
产生同样的禁止条目,这时Valgrind就会输出禁止条目不止一次,但是在
禁止条目的文件中只需要一份拷贝(但是如果多于一份也不会引起什么问
题)。并且,禁止条目的名字像<在这儿输入一个禁止条目的名字>;名字并
不是很重要,它只是和-v选项一起使用打印出所有使用的禁止条目记录。
--db-attach=<yes|no> [default: no]
当这个选项打开时,Valgrind将会在每次打印错误时暂停并打出如下
一行:
---- Attach to debugger ? --- [Return/N/n/Y/y/C/c] ----
按下回车,或者N、回车,n、回车,Valgrind不会对这个错误启动调试器。
按下Y、回车,或者y、回车,Valgrind会启动调试器并设定在程序运行的
这个点。当调试结束时,退出,程序会继续运行。在调试器内部尝试继续
运行程序,将不会生效。
按下C、回车,或者c、回车,Valgrind不会启动一个调试器,并且不会再
次询问。
注意:--db-attach=yes与--trace-children=yes有冲突。你不能同时使用
它们。Valgrind在这种情况下不能启动。
2002.05: 这是一个历史的遗留物,如果这个问题影响到你,请发送邮件并
投诉这个问题。
2002.11:如果你发送输出到日志文件或者到网络端口,我猜这不会让你有
任何感觉。不须理会。
--db-command=<command> [default: gdb -nw %f %p]
通过--db-attach指定如何使用调试器。默认的调试器是gdb.默认的选项
是一个运行时扩展Valgrind的模板。 %f会用可执行文件的文件名替换,
%p会被可执行文件的进程ID替换。
这指定了Valgrind将怎样调用调试器。默认选项不会因为在构造时是否检
测到了GDB而改变,通常是/usr/bin/gdb.使用这个命令,你可以指定一些
调用其它的调试器来替换。
给出的这个命令字串可以包括一个或多个%p %f扩展。每一个%p实例都被
解释成将调试的进程的PID,每一个%f实例都被解释成要调试的进程的可
执行文件路径。
--input-fd=<number> [default: 0, stdin]
使用--db-attach=yes和--gen-suppressions=yes选项,在发现错误时,
Valgrind会停下来去读取键盘输入。默认地,从标准输入读取,所以关闭
了标准输入的程序会有问题。这个选项允许你指定一个文件描述符来替代
标准输入读取。
--max-stackframe=<number> [default: 2000000]
栈的最大值。如果栈指针的偏移超过这个数量,Valgrind则会认为程序是
切换到了另外一个栈执行。
如果在程序中有大量的栈分配的数组,你可能需要使用这个选项。
valgrind保持对程序栈指针的追踪。如果栈指针的偏移超过了这个数量,
Valgrind假定你的程序切换到了另外一个栈,并且Memcheck行为与栈指
针的偏移没有超出这个数量将会不同。通常这种机制运转得很好。然而,
如果你的程序在栈上申请了大的结构,这种机制将会表现得愚蠢,并且
Memcheck将会报告大量的非法栈内存访问。这个选项允许把这个阀值设置
为其它值。
应该只在Valgrind的调试输出中显示需要这么做时才使用这个选项。在这
种情况下,它会告诉你应该指定的新的阀值。
普遍地,在栈中分配大块的内存是一个坏的主意。因为这很容易用光你的
栈空间,尤其是在内存受限的系统或者支持大量小堆栈的线程的系统上,
因为Memcheck执行的错误检查,对于堆上的数据比对栈上的数据要高效
很多。如果你使用这个选项,你可能希望考虑重写代码在堆上分配内存
而不是在栈上分配。