手写C语言的内存泄漏检测组件

CC++语言中，栈空间有大小限制，所以程序员可以使用堆空间的内存。堆空间的内存是程序员自己申请的，需要程序员自己去调用释放的操作。内存管理是CC++程序员必须要注意的问题，其中包括了内存泄漏，内存泄漏的原因是程序中申请的内存没有进行释放，来看下面的例子：

{
    int *p1 = (int *)malloc(sizeof(int));
    int *p2 = (int *)malloc(sizeof(int));

    free(p1);
}

上面的代码段，申请了两块内存p1，p2，只释放了p1，没有释放p2，从而产生了内存泄漏。

内存泄漏会对程序造成严重后果，随着程序运行时间越来越久，内存有分配没有释放，会使得进程堆中的内存会越来越少，直到耗尽。会造成后面的运行时代码不能成功分配内存。

对于CC++这种没有实现垃圾回收的编程语言来说，怎么发现和定位可能造成内存泄漏的代码片段呢？

我们的需求有两个：

• 能够检测出内存泄漏

• 能够指出是由代码的哪个文件、哪个函数、哪一行引起的内存泄漏

内存泄漏检测实现的核心思想就是对系统的malloc/free进行hook，用我们自己的malloc/free代替系统调用，将free的地址和malloc的地址进行匹配，查看最后又哪些malloc没有进行free，并将没有free的malloc操作的代码段地址进行记录，通过代码段定位所在的文件、函数、代码行。

方案一

采用 __libc_malloc, libc_free与 __builtin_return_address。它们是gcc提供的函数。

__libc_malloc, libc_free用来代替malloc/free。可以用来实现hook。需要注意的是，我们实现的malloc/free函数，内部会有一些函数如printf，fopen，需要防止它们会嵌套调用malloc/free。

__builtin_return_address，能够返回调用所在函数的代码段的地址。能够定位内存泄漏的具体位置。

malloc的时候，创建一个文件，文件名使用申请内存的地址，并记录申请该内存的代码段的地址；free的时候，删除对应的文件。

#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
 
 
int enable_malloc_hook = 1;
extern void *__libc_malloc(size_t size);
 
int enable_free_hook = 1;
extern void *__libc_free(void *p);
 
void *malloc(size_t size) {
 
    if (enable_malloc_hook) {
        enable_malloc_hook = 0;
 
        void *p = __libc_malloc(size);
 
        void *caller = __builtin_return_address(0);
 
        char buff[128] = {0};
        sprintf(buff, "./mem/%p.mem", p);
 
        FILE *fp = fopen(buff, "w");
        fprintf(fp, "[+%p]malloc --> addr:%p size:%lu
", caller, p, size);
        fflush(fp);
 
        enable_malloc_hook = 1;
        return p;
    } else {
 
        return __libc_malloc(size);
 
    }
    return NULL;
}
 
void free(void *p) {
 
    if (enable_free_hook) {
        enable_free_hook = 0;
        char buff[128] = {0};
        sprintf(buff, "./mem/%p.mem", p);
 
        if (unlink(buff) < 0) {
            printf("double free: %p
", p);
        }
 
        __libc_free(p);
 
 
        enable_free_hook = 1;
    } else {
        __libc_free(p);
    }
 
}
 
// gcc -o memleak_0 memleak_0.c -g
// addr2line -f -e  memleak_0  -a 0x4006d8
int main() {
 
 
    void *p1 = malloc(10);
    void *p2 = malloc(20);
 
    free(p1);
 
    void *p3 = malloc(30);
    void *p4 = malloc(40);
 
    free(p2);
    free(p4);
 
    return 0;
 
}

方案二

使用宏定义, 开启宏定义使用我们的版本，不开启就使用系统的。可以方便debug。

内存泄漏检测使用malloc_hook/free_hook, 定位内存泄漏位置，使用 __FILE__ , __LINE__.

#define malloc(size) malloc_hook(size, __FILE__, __LINE__)

#define free(p) free_hook(p, __FILE__, __LINE__)

可以使用fclose，没有double free的问题了

#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
 
void *malloc_hook(size_t size, const char *file, int line) {
 
    void *p = malloc(size);
 
    char buff[128] = {0};
    sprintf(buff, "./mem/%p.mem", p);
 
    FILE *fp = fopen(buff, "w");
    fprintf(fp, "[+%s:%d]malloc --> addr:%p size:%lu
", file, line, p, size);
    fflush(fp);
 
    fclose(fp);
 
    return p;
 
}
 
void free_hook(void *p,  const char *file, int line) {
 
    char buff[128] = {0};
    sprintf(buff, "./mem/%p.mem", p);
 
    if (unlink(buff) < 0) {
        printf("double free: %p
", p);
        return;
    }
 
    free(p);
 
}
 
#define malloc(size)   malloc_hook(size, __FILE__, __LINE__)
 
#define free(p)    free_hook(p, __FILE__, __LINE__)
 
 
// gcc -o memleak_0 memleak_0.c -g
// addr2line -f -e  memleak_0  -a 0x4006d8
int main() {
 
 
    void *p1 = malloc(10);
    void *p2 = malloc(20);
 
    free(p1);
 
    void *p3 = malloc(30);   // memory leak
    void *p4 = malloc(40);
 
    free(p2);
    free(p4);
    free(p4); // double free
 
    return 0;
 
}

检测出两个问题，一次内存泄漏 p3，一次double free p4。结果OK。

该文章会更新，欢迎大家批评指正。

推荐一个零声学院免费公开课程，个人觉得老师讲得不错，
分享给大家：[Linux，Nginx，ZeroMQ，MySQL，Redis，
fastdfs，MongoDB，ZK，流媒体，CDN，P2P，K8S，Docker，
TCP/IP，协程，DPDK等技术内容，点击立即学习:
服务器课程：C++服务器