valgrind基本功能介绍、基础使用方法说明

1、Valgrind概述

Valgrind是一套Linux下，开放源代码（GPL V2）的仿真调试工具的集合。
Valgrind由内核（core）以及基于内核的其他调试工具组成。内核类似于一个框架（framework），它模拟了一个CPU环境，并提供服务给其他工具；而其他工具则类似于插件 (plug-in)，利用内核提供的服务完成各种特定的内存调试任务。

2、工具下载安装

参考地址：https://www.valgrind.org/downloads/
安装：

1、tar –xf valgrind-3.17.0.tar.bz2
2、cd valgrind-3.17.0
3、./configure         // 运行配置脚本生成makefile文件，可以--help查看配置项，自行按需配置，比如修改编译工具、修改安装路径等
4、make
5、make install        //安装生成可执行文件，可执行文件的路径有参数--prefix指定，需要在PATH中添加环境变量；若不加参数--prefix指定，仅使用默认配置，则会自动关联

安装完后可以使用：
valgrind --help查看使用方法

3、使用基本选项

3.1 基本工具介绍

（1）Memcheck。这是valgrind应用最广泛的工具，一个重量级的内存检查器，能够发现开发中绝大多数内存错误使用情况，比如：使用未初始化的内存，使用已经释放了的内存，内存访问越界等。这也是本文将重点介绍的部分。
（2）Callgrind。它主要用来检查程序中函数调用过程中出现的问题。
（3）Cachegrind。它主要用来检查程序中缓存使用出现的问题。
（4）Helgrind。它主要用来检查多线程程序中出现的竞争问题。
（5）Massif。它主要用来检查程序中堆栈使用中出现的问题。
（6）Extension。可以利用core提供的功能，自己编写特定的内存调试工具

3.2 常用选项

（1）适用于所有Valgrind工具
–tool=< name > 最常用的选项。运行 valgrind中名为toolname的工具。默认memcheck。
-h --help 显示帮助信息。
–version 显示valgrind内核的版本，每个工具都有各自的版本。
-q --quiet 安静地运行，只打印错误信息。
-v --verbose 更详细的信息, 增加错误数统计。
–trace-children=no|yes 跟踪子线程? [no]
–track-fds=no|yes 跟踪打开的文件描述？[no]
–time-stamp=no|yes 增加时间戳到LOG信息? [no]
–log-fd=< number > 输出LOG到描述符文件 [2=stderr]
–log-file=< file > 将输出的信息写入到filename.PID的文件里，PID是运行程序的进行ID
–log-file-exactly=< file > 输出LOG信息到 file
–log-file-qualifier=< VAR > 取得环境变量的值来做为输出信息的文件名。 [none]
–log-socket=ipaddr:port 输出LOG到socket ，ipaddr:port

（2）LOG信息输出
–xml=yes 将信息以xml格式输出，只有memcheck可用
–num-callers=< number > show < numbe r> callers in stack traces [12]
–error-limit=no|yes 如果太多错误，则停止显示新错误? [yes]
–error-exitcode=< number > 如果发现错误则返回错误代码 [0=disable]
–db-attach=no|yes 当出现错误，valgrind会自动启动调试器gdb。[no]
–db-command=< command > 启动调试器的命令行选项[gdb -nw %f %p]

（3）适用于Memcheck工具的相关选项：
–leak-check=no|summary|full 要求对leak给出详细信息? [summary]
–leak-resolution=low|med|high how much bt merging in leak check [low]
–show-reachable=no|yes show reachable blocks in leak check? [no]
更详细的使用信息详见帮助文件、man手册或官网：http://valgrind.org/docs/manual/manual-core.html

（4）注意：
① valgrind不会自动的检查程序的每一行代码，只会检查运行到的代码分支，所以单元测试或功能测试用例很重要；
② 可以把valgrind看成是一个sandbox，通过valgrind运行的程序实际上是运行在valgrind的sandbox中的，所以，不要测试性能，会让你失望的，建议只做功能测试
③ 编译代码时，建议增加-g -o0选项，不要使用-o1、-o2选项

3.3 常用选项示例

–tool=< name > : use the Valgrind tool named < name > [memcheck]
–log-file=< file > : log messages to < file >

示例：

valgrind --tool=memcheck --log-file=log.txt --leak-check=yes  ./test

说明：使用memcheck工具对test程序进行包含内存泄漏的检查，并将日志保存到log.txt

4、Memcheck工具介绍

Memcheck是valgrind应用最广泛的工具，能够发现开发中绝大多数内存错误使用情况。此工具主要可检查以下错误
（1） 使用未初始化的内存(Use of uninitialised memory)
（2） 使用已经释放了的内存(Reading/writing memory after it has been free’d)
（3） 使用超过malloc分配的内存空间(Reading/writing off the end of malloc’d blocks)
（4） 对堆栈的非法访问(Reading/writing inappropriate areas on the stack)
（5） 申请的空间是否有释放(Memory leaks – where pointers to malloc’d blocks are lost forever)
（6） malloc/free/new/delete申请和释放内存的匹配(Mismatched use of malloc/new/new [] vs free/delete/delete [])
（7） src和dst的重叠(Overlapping src and dst pointers in memcpy() and related functions)

#include
int main()
{
	int *pInt;
	std::cout<<"使用未初始化的内存";
	int a=*pInt;    //使用未初始化的内存
}

#include
int main()
{
	int *pArray=(int *)malloc(sizeof(int) *5);
	std::cout<<"使用已经释放了的内存";
	free(pArray);
	pArray[0]=0;    //使用已经释放了的内存
}

#include
int main()
{
	int *pArray=(int *)malloc(sizeof(int) *5);
	std::cout<<"使用超过malloc分配的内存空间";
	pArray[5]=5;    //使用超过malloc分配的内存空间
	free(pArray);
}

#include
int main()
{
	int *pArray=(int *)malloc(sizeof(int) *5);
	std::cout<<"malloc缺少free";
}

#include
int main()
{
	char a[10];
	for (char c=0; c < sizeof(a); c++)
	{
		a[c]=c;
	}
	std::cout<<"拷贝的src和dst存在重叠";
	memcpy(&a[4],&a[0],6);
}

注：程序有时会申请很多常驻节点，这些未释放的节点不应视为问题；
一般随着程序的运行，导致节点单向增加的malloc或new操作，视为内存泄漏

4.1 示例1：

源码：

#include
int main()
{
	int *pArray=(int *)malloc(sizeof(int) *5);
	std::cout<<"使用超过malloc分配的内存空间";
	pArray[5]=5;    //使用超过malloc分配的内存空间
	free(pArray);
}

编译：

g++ test1.cpp -g -o test1_g   //-g：让 memcheck 工具可以取到出错的具体行号

调试：

valgrind --leak-check=yes --log-file=1_g ./test1_g

生成日志文件1_g：

（1）当前程序（./test1_g）的进程号
（2）valgrind memcheck工具的license说明
（3）加载程序的运行方式
（4）父进程号，当前终端的进程
（5）检测到的错误信息
（6）堆栈摘要、小结，该例子中总共两次alloc、两次free，没有内存泄漏
（7）检测到的错误数量，这里提示1个

4.2 示例2

#include
int main()
{
	int *pArray=(int *)malloc(sizeof(int) *5);
	std::cout<<"使用已经释放了的内存";
	free(pArray);
	pArray[0]=0;    //使用已经释放了的内存
}

编译：

g++ test7.cpp -g -o test7_g   //-g：让 memcheck 工具可以取到出错的具体行号

调试：

valgrind --leak-check=yes --log-file=7_g ./test7_g

生成日志文件7_g：

（1）因为还是使用同一个终端，所以父进程还是8248
（2）有两个非法的读、写错误

编译：

g++ test7.cpp -g -o test2_g_O2 -O2 

调试：

valgrind --leak-check=yes --log-file=7_g_O2 ./test7_g_O2

生成日志文件7_g_O2：

可以看到同样的程序，在加上-O2之后，pArray[0]=0;语句被优化掉了，所以没有被检测出来。
为了做到更严格的检测，编译时需要保证编译器没有做优化，即优化等级为-O0，gcc、g++默认就是采用-O0的，但是大部分实际设计都会在Makefile中添加-O1或者-O2参数，所以最好还是检查下。

4.3 Memcheck 报告输出文档整体格式总结

copyright 版权声明
异常读写报告
（1）主线程异常读写
线程A异常读写报告
线程B异常读写报告
（2） 其他线程
（3）堆内存泄露报告
堆内存使用情况概述(HEAP SUMMARY)
确信的内存泄露报告(definitely lost)
可疑内存操作报告 (show-reachable=no关闭，打开：–show-reachable=yes)
泄露情况概述(LEAK SUMMARY)

4.4 Memcheck 日志报告的基本格式

{问题描述}
at {地址、函数名、模块或代码行}
by {地址、函数名、代码行}
by …{逐层依次显示调用堆栈}
Address 0x??? {描述地址的相对关系}

4.5 memcheck包含的7类错误

（1）illegal read/illegal write errors
提示信息：[invalid read of size 4]
（2）use of uninitialised values
提示信息：[Conditional jump or move depends on uninitialised value]
（3）use of uninitialised or unaddressable values in system calls
提示信息：[syscall param write(buf) points to uninitilaised bytes]
（4）illegal frees
提示信息：[invalid free()]
（5）when a heap block is freed with an inappropriate deallocation function
提示信息：[Mismatched free()/delete/delete[]]
（6）overlapping source and destination blocks
提示信息：[source and destination overlap in memcpy(,)]
（7）memory leak detection
① still reachable
内存指针还在还有机会使用或释放，指针指向的动态内存还没有被释放就退出了
② definitely lost
确定的内存泄露，已经不能访问这块内存
③ indirectly lost
指向该内存的指针都位于内存泄露处
④ possibly lost
可能的内存泄露，仍然存在某个指针能够快速访问某块内存，但该指针指向的已经不是内存首位置

4.6 memcheck工具原理

Memcheck实现了一个仿真的CPU，被监控的程序被这个仿真CPU解释执行，该仿真CPU可以在所有的内存读写指令发生时，检测地址的合法性和读操作的合法性。

Memcheck 能够检测出内存问题，关键在于其建立了两个全局表。
（1）Valid-Value 表：
对于进程的整个地址空间中的每一个字节(byte)，都有与之对应的8 个bits；对于CPU 的每个寄存器，也有一个与之对应的bit 向量。这些bits 负责记录该字节或者寄存器值是否具有有效的、已初始化的值。
（2）Valid-Address 表
对于进程整个地址空间中的每一个字节(byte)，还有与之对应的1 个bit，负责记录该地址是否能够被读写。
检测原理：
当要读写内存中某个字节时，首先检查这个字节对应的A bit。如果该A bit显示该位置是无效位置，memcheck 则报告读写错误。
内核（core）类似于一个虚拟的CPU 环境，这样当内存中的某个字节被加载到真实的CPU 中时，该字节对应的V bit 也被加载到虚拟的CPU 环境中。一旦寄存器中的值，被用来产生内存地址，或者该值能够影响程序输出，则memcheck 会检查对应的V bits，如果该值尚未初始化，则会报告使用未初始化内存错误。

简单来说：

（1）如何知道那些地址是合法的（内存已分配）？
维护一张合法地址表（Valid-address (A) bits），当前所有可以合法读写（已分配）的地址在其中有对应的表项。该表通过以下措施维护：
① 全局数据(data, bss section)–在程序启动的时候标记为合法地址
② 局部变量–监控sp(stack pointer)的变化，动态维护
③动态分配的内存–截获 分配/释放 内存的调用：malloc, calloc, realloc, valloc, memalign, free, new, new[], delete and delete[]
④ 系统调用–截获mmap映射的地址
⑤ 其他–可以显示知会memcheck某地字段是合法的
（2）如何知道某内存是否已经被赋值？
① 维护一张合法值表（Valid-value (V) bits），指示对应的bit是否已经被赋值。因为虚拟CPU可以捕获所有对内存的写指令，所以这张表很容易维护。

5、Callgrind工具介绍

Callgrind性能分析工具，它不需要在编译源码时附加特殊选项。Callgrind使用cachegrind的统计信息Ir（I cache reads，即一条指令执行的次数）来统计程序中函数的调用情况，建立函数调用关系图，还可以有选择地进行cache模拟。在运行结束时，它会把分析数据写入一个文件，callgrind_annotate可以把这个文件的内容转化成可读的形式。

5.1 Callgrind文本分析基本操作

示例：
（1）cd linux/bin
（2）valgrind --tool=callgrind ./Devtest
生成一个文件：callgrind.out.27439
或者
valgrind --tool=callgrind --separate-threads=yes ./Devtest
生成三个文件：callgrind.out.1234（为空），callgrind.out.1234-01（线程1），callgrind.out.1234-02（线程2）
（3）callgrind_annotate callgrind.out.27439 > log
callgrind_annotate是可以将callgrind.out.pid文件的内容转化为可读的形式，并重定向到log文件，分别打开callgrind.out.pid、log文件，你会发现它们的不同（callgrind.out.pid是人类不便于直接理解的格式，callgrind_annotate相当于一个翻译，将callgrind.out.pid按照我们喜欢的方式展现出来
）。
callgrind_annotate解析callgrind.out.pid而生成的log文件，打开后内容如下：

可以看到每个函数所属的动态库，该函数调用所耗费的指令数，默认是从大到小排序的。
callgrind_annotate 还有几个可选参数：
① --inclusive=yes：不但分别统计每个语句的执行次数，还把调用关系计算进入，比如函数foo调用了bar，那么foo的代价中会加入bar的代价。
② --tree=both：显示调用关系。
③ --auto=yes：会自动将统计信息和源码关联。就是会显示每个函数的源码，并且在前面显示每条语句的运行代价
（4）可以对单独的文件进行关联：
callgrind_annotate callgrind.out.9441 main.c | grep -v “???”
注：“???”前缀的调用，都是系统库底层调用，不重要，可用grep -v过滤掉

5.2 Callgrind流程图分析基本操作

以工程右图“官网提供的示例代码”为例，会比较直观：
（1）gcc –g test.c -o test
（2）valgrind --tool=callgrind ./test
生成一个文件：callgrind.out.pid
（3）python gprof2dot.py -f callgrind -n10 -s callgrind.out.[pid] > valgrind.dot
（4）dot -Tpng valgrind.dot -o valgrind.png
（5）打开图片打开，据说能一目了然的知道运行时间消耗的分布

6、Cachegrind工具介绍

6.1 基本介绍

（1）Cachegrind基于Valgrind的剖析器（profiler）计算机系统变得越来越复杂，剖析存储系统往往是系统瓶颈，需要剖析Cache
（2）功能
① 模拟L1、L2 Cache
② 剖析Cache行为，执行次数、失效率等
③ 按照文件、函数、代码行、汇编指令剖析
（3）作用
① 详细Cache剖析，发现程序瓶颈
② 指令改进程序，提高执行效率
③ Trace驱动的Cache模拟器
（4）优点
① 容易使用，不需要重新编译
② 剖析所有执行的代码，包括库
③ 不限定语言
④ 速度相对较快
⑤ 灵活，模拟不同配置的Cache

6.2 使用步骤

（1）valgrind --tool=cachegrind ./test

同时生成文件cachegrind.out.pid
（2）callgrind_annotate cachegrind.out.4599 | grep -v “???”

和callgrind一样，也可以通过callgrind_annotate翻译为可读信息。从中可以看到
I1 cache（指令缓存）、D1 cache（数据缓存）、LL cache（公共的二级缓存）的命中情况。

7、Massif工具介绍

Massif是一个内存剖析工具。通过不断的取程序堆的快照来达到监视程序内存分配的目的。

7.1 示例

（1）g++ test.cc -o test
（2）valgrind --tool=massif ./test 就得到一个massif文件：massif.out.pid
（3）使用ms_print来解析这个输出文件：ms_print massif.out.pid
（4）通过图形快照看出堆栈的内存变化情况：

8、Helgrind工具介绍

Helgrind是Valgrind的一个重点功能 本节主要针对与多线程基本安全问题进行检测。
① 资源不安全访问
② 死锁问题
③ POSIX pthreads API的错误使用
④ 在前面几个基础上都能安全无误的情况下 多于多线程程序就是要能够能好将同步块尽量缩到最小

8.1 Helgrind 资源不安全访问

解决问题：
​问题1: 调用Helgrind能够很好的解决掉，以右边基本程序为例

#include 

int var = 0;
void* child_fn (void* arg)
{
   var++;
   return NULL;
}
int main (void)
{
    pthread_t child;
    pthread_t child2;
 
    pthread_create(&child,NULL, child_fn, NULL);
    pthread_create(&child2,NULL,child_fn,NULL);
 
    pthread_join(child,NULL);
    pthread_join(child2,NULL);
 
    return 0;
}

明显var是共享的 不安全访问，调用Helgrind看看怎么能够检测出来：
gcc -g test.c -o test –lpthread
valgrind --tool=helgrind ./test
运行helgrind之后会生成如下结果，从信息提示中可以看到有两个错误，对val全局变量的抢占使用


问题2:
​死锁问题是尽量避免，helgrind可以检测出加锁解锁顺序出现问题导致的死锁问题，这个问题我们可以好好看下：https://blog.csdn.net/sfwtoms11/article/details/38438253
再看下连续加2次锁的情况

#include 

pthread_mutex_t mut_thread;
int var = 0;
void* child_fn ( void* arg )
{
	pthread_mutex_lock(&mut_thread);
	var++;
	pthread_mutex_lock(&mut_thread);
    return NULL;
}

int main ( void )
{
	pthread_t child;
	pthread_t child2;
	pthread_mutex_init(&mut_thread,NULL);
	pthread_create(&child,NULL, child_fn, NULL);
	pthread_create(&child2,NULL,child_fn,NULL);
	pthread_join(child,NULL);
	pthread_join(child2,NULL);
	return 0;
}

mutex加解锁顺序导致的问题：

#include 

pthread_mutex_t mut_thread;
pthread_mutex_t mut_thread1;
int var = 0;
void* child_fn ( void* arg ) {
	pthread_mutex_lock(&mut_thread);
	pthread_mutex_lock(&mut_thread1);
	var++;
	pthread_mutex_unlock(&mut_thread);
	pthread_mutex_unlock(&mut_thread1);
	return NULL;
}
void* child_fn1(void *arg)
{
	pthread_mutex_lock(&mut_thread1);
	pthread_mutex_lock(&mut_thread);
	var++;
	pthread_mutex_unlock(&mut_thread1);
	pthread_mutex_unlock(&mut_thread);
	return NULL;
}

int main ( void ) {
	pthread_t child;
	pthread_t child2;
	pthread_mutex_init(&mut_thread,NULL);
	pthread_mutex_init(&mut_thread1,NULL);
	pthread_create(&child,NULL, child_fn, NULL);
	pthread_create(&child2,NULL,child_fn1,NULL);
	pthread_join(child,NULL);
	pthread_join(child2,NULL);
	return 0;
}