C/C++ 内存泄漏检测

最近学习了 C/C++ 内存泄漏检测的相关知识，写博客记录一下。

内存泄漏的两个问题

• 是否有内存泄漏？
• 内存泄漏是在代码的哪一行？

检测内存泄漏主要从上面两个问题入手。

使用宏定义覆盖 malloc 和 free 函数

在单个文件中，可以使用这种方法检测是否有内存泄漏。

#include 
#include 

int main() {

    void *p1 = malloc(10);
    void *p2 = malloc(20);

    free(p1);

}

上面的代码存在内存泄漏的问题，但是直接运行看不出问题。我们可以使用宏定义覆盖覆盖系统的 malloc 和 free 函数。
我们定义两个函数，分别是 my_malloc 和 my_free ，使用宏定义覆盖原来的 malloc 和 free 。

#include 
#include 

void *my_malloc(size_t size, const char *file, int line) {

    void *p = malloc(size);
    printf("malloc[+]: addr: %p , size: %ld , file: %s , line: %d \n", p, size, file, line);
    return p;

}

void my_free(void *p, const char *file, int line) {

    free(p);
    printf("free[-]: addr: %p\n", p);


}

#define malloc(size)    my_malloc(size, __FILE__, __LINE__)
#define free(p)         my_free(p, __FILE__, __LINE__)

int main() {

    void *p1 = malloc(10);
    void *p2 = malloc(20);

    free(p1);

}

运行结果如上图，我们可以看到哪一行代码调用了 malloc 以及对应的内存有没有 free 。
还可以把上面的代码改进一下，把信息写入到文件中，方面查看。

#include 
#include 
#include 

#if 1

void *my_malloc(size_t size, const char *file, int line) {

    void *p = malloc(size);
    
    char buff[128] = { 0 };
    sprintf(buff, "./mem/%p.mem", p); // 需要事前创建 mem 文件夹

    FILE *fp = fopen(buff, "w");
    fprintf(fp, "malloc[+%s:%d] --> addr:%p, size: %ld\n", file, line, p, size);
    fflush(fp);
    fclose(fp);

    return p;

}

void my_free(void *p, const char *file, int line) {

    char buff[128] = { 0 };
    sprintf(buff, "./mem/%p.mem", p); // 需要事前创建 mem 文件夹

    if (unlink(buff) < 0) {
        printf("double free addr:%p\n", p);
        return;
    }

    free(p);

}

#define malloc(size)    my_malloc(size, __FILE__, __LINE__)
#define free(p)         my_free(p, __FILE__, __LINE__)

#endif

int main() {

    void *p1 = malloc(10);
    void *p2 = malloc(20);

    free(p1);

}

运行后，结果如下，会在 mem 文件夹下存在一个文件，点开可以看到没有被 free 的内存的信息。

注意：

• 这种方法局限性比较大，需要在每个文件开头展开这一段代码才可以。
• 使用的第三方库无法覆盖
• 同理可以覆盖 calloc 以及 realloc
• #define malloc(size) my_malloc(size,__FILE__, __LINE__)
• #define free§ my_free(p, __FILE__, __LINE__)
• 这两行代码必须放在 my_malloc 和 my_free 的下面，否则会造成递归

使用 hook 钩子

dlsym 函数可以自己实现系统调用

#include 
#include 
#include 


#if 1

// 定义回调函数类型
typedef void *(*malloc_t)(size_t size);

// 定义回调函数变量
malloc_t malloc_f = NULL;

// 同理
typedef void (*free_t)(void *p);
free_t free_f = NULL;

void *malloc(size_t size) {

    printf("malloc [+%s:%d]\n", __FILE__, __LINE__);

}

void free(void *p) {

    printf("malloc [+%s:%d]\n", __FILE__, __LINE__);

}

void init_hook(void) {
    
    if (malloc_f == NULL)
        malloc_f = dlsym(RTLD_NEXT, "malloc"); // dlsym 需要加上编译条件 -ldl

    if (free_f == NULL)
        free_f = dlsym(RTLD_NEXT, "free");

}


#define DEBUG_MEM_LEAK init_hook();

#endif

int main() {

    DEBUG_MEM_LEAK

    void *p1 = malloc(10);
    void *p2 = malloc(20);

    free(p1);

}

上面这一份代码，在自己实现的 malloc 和 free 内部使用了 printf 函数，会出现错误。
是因为在 printf 函数内部也是用了 malloc 来开辟缓冲区，就会造成递归调用。

我们需要定义一个 flag 来防止递归的出现。

#define _GNU_SOURCE
#include 

#include 
#include 
#include 


#if 1

// 定义回调函数类型
typedef void *(*malloc_t)(size_t size);

// 定义回调函数变量
malloc_t malloc_f = NULL;

// 同理
typedef void (*free_t)(void *p);
free_t free_f = NULL;

// flag 防止递归
int enable_malloc_hook = 1;
int enable_free_hook = 1;

void *malloc(size_t size) {

    if (enable_malloc_hook == 1) {
        enable_malloc_hook = 0;
        printf("malloc [+%s:%d]\n", __FILE__, __LINE__);
        enable_malloc_hook = 1;
    }

}

void free(void *p) {

    if (enable_malloc_hook == 1) {
        enable_malloc_hook = 0;
        printf("free [+%s:%d]\n", __FILE__, __LINE__);
        enable_malloc_hook = 1;
    }



}

void init_hook(void) {
    
    if (malloc_f == NULL)
        malloc_f = dlsym(RTLD_NEXT, "malloc"); // dlsym 需要加上编译条件 -ldl

    if (free_f == NULL)
        free_f = dlsym(RTLD_NEXT, "free");

}


#define DEBUG_MEM_LEAK init_hook();

#endif

int main() {

    DEBUG_MEM_LEAK

    void *p1 = malloc(10);
    void *p2 = malloc(20);

    free(p1);

}

这是改进的代码的运行结果，但是又出现了一个问题，申请内存的函数是在哪一行调用的，出现了问题，全是在同一行调用的，这显然是有问题的。
我们可以使用 __builtin_return_address() 这个函数来解决，传入 0 就返回上一层函数的信息，传入 1 就返回上两层函数的信息，以及类推。

#define _GNU_SOURCE
#include 

#include 
#include 
#include 


#if 1

// 定义回调函数类型
typedef void *(*malloc_t)(size_t size);

// 定义回调函数变量
malloc_t malloc_f = NULL;

// 同理
typedef void (*free_t)(void *p);
free_t free_f = NULL;

// flag 防止递归
int enable_malloc_hook = 1;
int enable_free_hook = 1;

void *malloc(size_t size) {

    if (enable_malloc_hook == 1) {
        enable_malloc_hook = 0;

        void *caller = __builtin_return_address(0); // 返回上一层调用函数的信息
        printf("malloc [+]: %p\n", caller);

        enable_malloc_hook = 1;
    }

}

void free(void *p) {

    if (enable_malloc_hook == 1) {
        enable_malloc_hook = 0;

        void *caller = __builtin_return_address(0); // 返回上一层调用函数的信息
        printf("free [-]: %p\n", caller);

        enable_malloc_hook = 1;
    }



}

void init_hook(void) {
    
    if (malloc_f == NULL)
        malloc_f = dlsym(RTLD_NEXT, "malloc"); // dlsym 需要加上编译条件 -ldl

    if (free_f == NULL)
        free_f = dlsym(RTLD_NEXT, "free");

}


#define DEBUG_MEM_LEAK init_hook();

#endif

int main() {

    DEBUG_MEM_LEAK

    void *p1 = malloc(10);
    void *p2 = malloc(20);

    free(p1);

}

运行结果如图，得到了一串地址，可以使用 addr2line 来查看具体信息。

下面改成文件版本

#define _GNU_SOURCE
#include 

#include 
#include 
#include 


#if 1

// 定义回调函数类型
typedef void *(*malloc_t)(size_t size);

// 定义回调函数变量
malloc_t malloc_f = NULL;

// 同理
typedef void (*free_t)(void *p);
free_t free_f = NULL;

// flag 防止递归
int enable_malloc_hook = 1;
int enable_free_hook = 1;

void *malloc(size_t size) {

    if (enable_malloc_hook == 1) {
        enable_malloc_hook = 0;

        void *p = malloc_f(size);

        void *caller = __builtin_return_address(0); // 返回上一层调用函数的信息

        char buff[128] = { 0 };
        sprintf(buff, "./mem/%p.mem", p); // 需要事前创建 mem 文件夹

        FILE *fp = fopen(buff, "w");
        fprintf(fp, "malloc[+%p] --> addr:%p, size: %ld\n", caller, p, size);
        fflush(fp);
        fclose(fp);

        enable_malloc_hook = 1;
        return p;
    } else {
        return malloc_f(size);
    }

}

void free(void *p) {

    if (enable_malloc_hook == 1) {
        enable_malloc_hook = 0;

        // void *caller = __builtin_return_address(0); // 返回上一层调用函数的信息
        
        char buff[128] = { 0 };
        sprintf(buff, "./mem/%p.mem", p); // 需要事前创建 mem 文件夹

        if (unlink(buff) < 0) {
            printf("double free addr:%p\n", p);
            return;
        }

        free_f(p);

        enable_malloc_hook = 1;
    } else {
        free_f(p);
    }



}

void init_hook(void) {
    
    if (malloc_f == NULL)
        malloc_f = dlsym(RTLD_NEXT, "malloc"); // dlsym 需要加上编译条件 -ldl

    if (free_f == NULL)
        free_f = dlsym(RTLD_NEXT, "free");

}


#define DEBUG_MEM_LEAK init_hook();

#endif

int main() {

    DEBUG_MEM_LEAK

    void *p1 = malloc(10);
    void *p2 = malloc(20);

    free(p1);

}

参考连接：
https://www.jianshu.com/p/d9e12b66096a
https://zhuanlan.zhihu.com/p/554448993
https://zhuanlan.zhihu.com/p/490911617