C 语言实现智能指针

参考 https://snai.pe/c/c-smart-pointers/

在 C 语言中，手动管理内存是开发者的基本职责。每次使用 malloc 分配内存后，都需要确保在合适的地方调用 free 释放内存。如果忘记释放内存，就会导致内存泄漏，这是许多 C 语言程序中的常见问题。为了减少这种风险，GNU C 编译器（GCC）提供了一个非常有用的扩展：attribute ((cleanup(f))。

什么是 attribute ((cleanup(f))

attribute ((cleanup(f)) 是 GCC 提供的一个特性，用于修饰一个变量，使得在该变量的作用域结束时，自动调用一个指定的函数 f。这个特性可以显著简化内存管理和资源释放的工作，尤其是在处理动态分配的对象时。

作用域结束的定义

在 C 语言中，变量的作用域结束意味着以下几种情况：

1. 大括号 } 结束，例如函数、循环或条件语句的结束。
2. return 语句的执行。
3. goto 语句的跳转。
4. break 语句的执行。
5. 异常的发生（在某些具有异常机制的环境中）。

如何使用 attribute ((cleanup(f))？

要使用 attribute ((cleanup(f))，需要定义一个清理函数 f，然后在变量声明时使用这个属性。下面是一个简单的例子，演示了如何在变量的作用域结束时自动释放内存。

示例代码

#define autofree __attribute__((cleanup(clean)))

__attribute__ ((always_inline))
inline void clean(void *ptr) {
    free(*(void **) ptr);
}

int main(void) {
    autofree int *i = malloc(sizeof (int));
    *i = 1;
    return *i;
}

解释

1. 定义清理函数：void clean(void *ptr) 是清理函数，用于释放传入的指针指向的内存。
2. 修饰变量：attribute ((cleanup(clean))) int *i 使用 cleanup 函数修饰变量 i，确保在 i 的作用域结束时自动调用 clean 函数。
3. 内存分配：使用 malloc 动态分配内存，并将其地址赋值给 i。
4. 作用域结束：在 return 语句执行后，变量 i 的作用域结束，clean 函数自动调用，释放 i 指向的内存。

attribute ((cleanup(f)) 的应用场景

动态内存管理

在需要频繁进行动态内存分配和释放的程序中，attribute ((cleanup(f)) 可以减少忘记调用 free 函数的风险，避免内存泄漏。

文件资源管理

在文件操作中，使用 fopen 打开文件后，需要确保在合适的地方调用 fclose 关闭文件。使用 attribute ((cleanup(f)) 可以确保文件在作用域结束时自动关闭。

#include <stdio.h>

// 清理函数，负责关闭文件
void cleanup_file(FILE **fp) {
    if (*fp) {
        printf("Closing file\n");
        fclose(*fp);
        *fp = NULL;
    }
}

int main() {
    // 使用 __attribute__ ((cleanup(cleanup_file))) 修饰文件指针变量
    __attribute__ ((cleanup(cleanup_file))) FILE *file = fopen("example.txt", "w");
    if (!file) {
        perror("Failed to open file");
        return EXIT_FAILURE;
    }
    fprintf(file, "Hello, world!\n");

    // file 指针的作用域将在这里结束，cleanup_file 函数将自动调用，关闭文件
    return EXIT_SUCCESS;
}

互斥锁管理

在多线程编程中，使用互斥锁保护共享资源是常见的做法。通过 attribute ((cleanup(f)) 可以确保在锁的作用域结束时自动释放锁。

#include <pthread.h>
#include <stdio.h>

// 清理函数，负责解锁
void cleanup_mutex(pthread_mutex_t *mutex) {
    pthread_mutex_unlock(mutex);
}

int main() {
    pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;

    // 使用 __attribute__ ((cleanup(cleanup_mutex))) 修饰互斥锁变量
    pthread_mutex_lock(&mutex);
    __attribute__ ((cleanup(cleanup_mutex))) pthread_mutex_t *lock = &mutex;

    // 保护的临界区代码
    printf("Critical section\n");

    // lock 的作用域将在这里结束，cleanup_mutex 函数将自动调用，解锁互斥锁
    return EXIT_SUCCESS;
}

总结

attribute ((cleanup(f)) 是 GCC 提供的一个强大特性，可以显著简化 C 语言中的资源管理工作。通过定义清理函数并修饰变量，我们可以确保在变量的作用域结束时自动执行清理操作，减少资源泄漏的风险。这一特性在内存管理、文件操作和多线程编程等场景中都具有广泛的应用价值。

希望本文能帮助您更好地理解和应用 attribute ((cleanup(f))，从而提高代码的健壮性和可维护性。如果您有任何问题或建议，欢迎在评论区留言讨论。