内存泄漏无处藏身 | GCC -fsanitize=leak 实战攻略

引言

内存泄漏是 C/C++ 语言编程中常见的内存管理问题之一。程序在动态分配内存后，未能及时释放会导致内存泄漏，进而造成程序占用大量内存，降低系统性能，甚至导致程序崩溃。GCC 提供了 -fsanitize=leak 选项，它通过集成 LeakSanitizer（内存泄漏检测器）帮助开发者自动检测并定位程序中的内存泄漏问题。本文将详细介绍 -fsanitize=leak 的工作原理，并结合具体的 C 代码演示来展示其强大的功能。

工作原理

-fsanitize=leak 是 LeakSanitizer(LSan) 的一部分，它通过在程序运行时监控内存分配和释放的情况，来检测未正确释放的内存泄漏问题。

LeakSanitizer 的工作原理如下：

1. 编译时插入检测代码：当使用 -fsanitize=leak 选项编译代码时，编译器会自动在程序内存分配和释放的位置插入检测代码。
2. 运行时跟踪：在程序运行时，LeakSanitizer 会监控所有内存分配操作，并在程序结束时检查是否有未释放的内存。
3. 报告泄漏：如果存在内存泄漏，LeakSanitizer 会生成一份详细的报告，包括泄漏的大小、位置以及未释放内存的分配点。

LeakSanitizer 在程序中的工作流程如下：

1. 内存分配跟踪：LeakSanitizer 追踪程序运行期间的每次内存分配操作（如 malloc()、calloc() 、new()等）。

2. 内存释放检测：当程序结束时，LeakSanitizer 检查是否有分配的内存未被释放（例如 free() 或 delete 未被正确调用）。

3. 报告泄漏：如果 LeakSanitizer 发现未释放的内存块，它会生成一份详细的报告，指示泄漏的内存块的大小、堆栈跟踪等信息，帮助开发者迅速定位问题。

安装集成 liblsan

liblsan 是 GCC 和 Clang 中 LeakSanitizer 的核心库，专门用于检测内存泄漏。通过使用 -fsanitize=leak 选项，开发者可以借助 liblsan 检测到程序中存在的内存泄漏问题。LeakSanitizer 在程序执行完毕后，会对程序的内存使用情况进行扫描，并报告所有未释放的内存块。

在大多数 Linux 发行版上，liblsan 是作为 GCC 或 Clang 的一部分进行分发的。对于 Fedora 或 CentOS 系统，可以通过以下命令来安装 liblsan

sudo dnf install liblsan

只要编译器支持 LSan 并且安装了相应的库，您就可以使用 -fsanitize=leak 选项了。

代码演示

下面是一段包含内存泄漏的 C 代码。程序分配了动态内存，但未能正确释放。

源文件 leak_example.c ：

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

void create_leak() {
    int* ptr = (int*)malloc(10 * sizeof(int));  // 动态分配内存
    if (ptr == NULL) {
        printf("Memory allocation failed!\n");
        return;
    }
    for (int i = 0; i < 10; i++) {
        ptr[i] = i * 10;  // 使用动态分配的内存
    }
    // 漏掉了 free(ptr); 导致内存泄漏
}

int main() {
    create_leak();
    printf("Program finished.\n");
    return 0;
}

首先，用 -fsanitize=leak 选项编译代码：

[root@localhost gcc_sanitize]# gcc -fsanitize=leak -g -o leak_example leak_example.c

运行生成的可执行文件：

[root@localhost gcc_sanitize]# ./leak_example

LeakSanitizer 将检测到内存泄漏并输出如下的信息：

Program finished.

=================================================================
==10743==ERROR: LeakSanitizer: detected memory leaks

Direct leak of 40 byte(s) in 1 object(s) allocated from:
    #0 0x7f49e17734df in __interceptor_malloc (/lib64/liblsan.so.0+0xf4df)
    #1 0x4006a7 in create_leak /home/example/gcc_sanitize/leak_example.c:5
    #2 0x400704 in main /home/example/gcc_sanitize/leak_example.c:17
    #3 0x7f49e13d9d84 in __libc_start_main (/lib64/libc.so.6+0x3ad84)

SUMMARY: LeakSanitizer: 40 byte(s) leaked in 1 allocation(s).

这段输出是 LeakSanitizer 运行时的内存泄漏报告。它提供了有关程序在运行过程中发生的内存泄漏的详细信息。以下是这段报告的逐行解析：

1. 开始报告

Program finished.
=================================================================
==10743==ERROR: LeakSanitizer: detected memory leaks

• Program finished 表示程序正常执行完毕。
• ==10743==ERROR: LeakSanitizer: detected memory leaks 表示 LeakSanitizer 发现了内存泄漏。这里的 10743 是当前程序的进程 ID。

2. 内存泄漏详情

Direct leak of 40 byte(s) in 1 object(s) allocated from:

• Direct leak：表示发生了直接内存泄漏。直接泄漏指的是程序通过某种方式分配了内存（如 malloc），但从未释放，导致内存被遗弃。
• 40 byte(s)：表示泄漏了 40 个字节的内存。
• in 1 object(s)：表示这一段泄漏只涉及到 1 个内存分配对象（如 1 次 malloc 调用）。

3. 内存分配的堆栈信息

LeakSanitizer 提供了内存分配时的堆栈跟踪信息，这可以帮助你精确地定位泄漏发生的位置。

#0 0x7f49e17734df in __interceptor_malloc (/lib64/liblsan.so.0+0xf4df)

• #0：堆栈的第一个调用点，通常表示最近的调用。
• __interceptor_malloc：表示这次内存分配是通过 malloc 函数完成的。LeakSanitizer 会使用拦截器（interceptors）来捕捉内存分配函数（如 malloc、calloc 等）调用，这里就是拦截了 malloc 的调用。
• /lib64/liblsan.so.0+0xf4df：指出内存分配是通过 LeakSanitizer 的运行时库 liblsan.so 拦截并监控的，具体地址为 0xf4df。

#1 0x4006a7 in create_leak /home/example/gcc_sanitize/leak_example.c:5

• #1：堆栈跟踪中的第二个调用点。
• create_leak：这是你的程序中的函数名，表示这个函数分配了导致内存泄漏的内存。
• /home/example/gcc_sanitize/leak_example.c:5：表示泄漏的内存是在 leak_example.c 文件的第 5 行分配的。这是代码中最关键的线索，你可以回到源代码的第 5 行查看分配内存的具体位置。

#2 0x400704 in main /home/example/gcc_sanitize/leak_example.c:17

• #2：堆栈跟踪中的第三个调用点，指向了 main 函数。
• main：表示从 main 函数调用了 create_leak 函数。
• /home/example/gcc_sanitize/leak_example.c:17：这是 main 函数中的第 17 行，调用了 create_leak 函数。

#3 0x7f49e13d9d84 in __libc_start_main (/lib64/libc.so.6+0x3ad84)

#3：这是标准 C 库的启动函数 __libc_start_main，它是应用程序的入口点。在 C 程序启动时，首先会调用该函数来初始化并启动用户的 main 函数。

4. 总结信息

SUMMARY: LeakSanitizer: 40 byte(s) leaked in 1 allocation(s).

这段总结提供了内存泄漏的概述：

• 40 byte(s)：总共有 40 个字节的内存泄漏。
• in 1 allocation(s)：总共有 1 次内存分配没有被释放，导致了内存泄漏。

通过 -fsanitize=leak 知晓了具体的内存泄露情况，我们就可以针对内存泄露进行修复：

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

void create_leak() {
    int* ptr = (int*)malloc(10 * sizeof(int));  // 动态分配内存
    if (ptr == NULL) {
        printf("Memory allocation failed!\n");
        return;
    }
    for (int i = 0; i < 10; i++) {
        ptr[i] = i * 10;
    }
    free(ptr);  // 修复内存泄漏
}

int main() {
    create_leak();
    printf("Program finished.\n");
    return 0;
}

现在，重新编译并运行程序后，LeakSanitizer 不会再报告内存泄漏：

[root@localhost gcc_sanitize]# gcc -fsanitize=leak -g -o leak_example leak_example.c
[root@localhost gcc_sanitize]# ./leak_example
Program finished.
[root@localhost gcc_sanitize]#

输出结果中将不会出现任何内存泄漏报告，表明内存管理问题已被修复。

总结

内存泄漏不仅会浪费系统资源，还可能影响程序的长期运行稳定性。通过 GCC 提供的 -fsanitize=leak 选项，开发者可以轻松检测程序中的内存泄漏问题，并获得详细的错误报告以快速定位和修复问题。结合 LeakSanitizer，C/C++ 程序的内存管理将变得更加高效和可靠。

LeakSanitizer 提供的自动检测功能对于调试复杂的内存管理代码非常有帮助，建议开发者在开发过程中启用 -fsanitize=leak 来确保程序的内存使用无误。