【内存泄漏】使用memwatch高效排查代码的内存泄漏问题

大家好，又见面了，我是你们的朋友全栈君。

本文将给大家介绍，如何使用一个小的开源组件【memwatch】排查有可能出现【内存泄漏】的代码。

先上一段测试代码，里面是包括一些内存操作错误的代码：

//main.c

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <signal.h>

#include "memwatch.h" //包含memwatch提供的头文件

static void signal_handler(int sign_no)
{
    printf("Capture signal no: %d\n", sign_no); 
	
	exit(-1);
}

int memory_leak_test(void)
{
	char *p, *p1, *p2=NULL;
	
	p = malloc(100); //申请空间
	if (p) {
		strcpy(p, "123456");
	}
	
	p1 = malloc(5); //申请空间
	if (p1) {
		strcpy(p1, "123456");
	}
	
	//free(p); //使用完故意不释放
	//free(p1); //使用完故意不释放
	
	*p2 = '5'; //访问空指针，导致segment default (core dump)，memwatch并不能坚持出来
	
	return 0;
}

int main(int arc, const char *argv[])
{
	signal(SIGSEGV, signal_handler); 
	
	printf("This is a sample for memwatch to detect memory leak !!!\n");
	
	memory_leak_test();
	
	return 0;
}

然后将memwatch的源码memwatch.c和memwatch.h放到main.c的目录下，一同参与编译，如下图：

通过makefile或其他编译方式，将上述文件编译成可执行文件，再运行，观察运行结果，如下：

从图中我们可以知道，memwatch检测出了main.c中内存操作错误的地方。另外，除运行输出错误信息外，还会生成一个memwatch.log文件，从中可以详细地知道内存错误的类型和具体位置。如下图：

//memwatch.log

============= MEMWATCH 2.71 Copyright (C) 1992-1999 Johan Lindh =============

Started at Thu Mar  7 09:05:35 2019

Modes: __STDC__ 64-bit mwDWORD==(unsigned int)
mwROUNDALLOC==8 sizeof(mwData)==56 mwDataSize==56


Stopped at Thu Mar  7 09:05:35 2019

unfreed: <2> src/main.c(25), 5 bytes at 0xe667e0 [overflowed]  	{31 32 33 34 35 .. .. .. .. .. .. .. .. .. .. .. 12345}
unfreed: <1> src/main.c(20), 100 bytes at 0xe66720  	{31 32 33 34 35 36 00 FE FE FE FE FE FE FE FE FE 123456..........}

Memory usage statistics (global):
 N)umber of allocations made: 2
 L)argest memory usage      : 105
 T)otal of all alloc() calls: 105
 U)nfreed bytes totals      : 105

这样我们就可以很清晰地根据反馈问题点修改对应的内存操作bug了，是不是很方便实用呢？

当然，这个范例仅仅是做了比较简单的示范，在实际项目工程中，可能会遇到更多更隐蔽的内存操作问题，灵活运用memwatch排查内存问题，定会事半功倍。

最后附上，整个测试工程的文件，包括源码和makefile，以供参考，如有发现问题，可在留言区评论，我会及时跟进回复。谢谢。

demo工程下载链接： memwatch_for_memory_leak_detect.tar.gz