LinuxC库函数的可重入与不可重入版本说明

原创美男子玩编程 2024-12-28 08:01

年终搞个特价示波器奖励员工？ 泰克精选产品限时双重优惠

点击上方蓝色字体，关注我们

在多线程编程中，线程安全（Thread-Safety）是一个非常重要的概念，而可重入性（Reentrancy）是确保线程安全的一个关键因素。

C标准库中的很多函数都存在可重入（Reentrant）和不可重入版本。

在这些函数的命名上，不可重入的函数名称通常是简单的函数名，而可重入版本的函数名称后面通常带有 _r，表示该函数是设计为可重入的版本。

不可重入函数：不可重入的函数通常依赖于共享的全局状态，或使用静态变量来存储中间结果。这使得当多个线程并发调用这些函数时，可能会发生数据竞争或资源争用，导致不安全的行为。
可重入函数：可重入函数在设计上避免了共享状态的问题，它们通常只使用局部变量，或者通过传递上下文指针来存储状态，这样每个线程都拥有自己的副本，避免了竞争条件。

我们在 C 库中经常会遇到一些不可重入的函数，这些函数在多线程环境中可能会出现问题。

例如：

asctime() 与 asctime_r()
ctime() 与 ctime_r()
localtime() 与 localtime_r()

这些函数的 _r 版本是可重入的，并且能够在多线程环境下安全使用。

通过 man 手册，我们可以查询每个库函数的详细信息，其中包括其线程安全性标注。

例如，执行 man 3 ctime 可以查看 ctime() 和 ctime_r() 函数的详细信息。在这个手册页面的 "ATTRIBUTES" 部分，会显示每个函数是否是线程安全的。

函数的线程安全性通常会以 MT-Safe 或 MT-Unsafe 标记：

MT-Safe（线程安全）：表示该函数是多线程安全的，在多线程环境中可以同时被多个线程调用，而不会产生竞态条件或数据竞争。
MT-Unsafe（线程不安全）：表示该函数不是线程安全的，如果多个线程同时调用该函数，可能会导致数据不一致或其他不安全行为。

值得注意的是，即使某些函数被标记为 MT-Safe，它们可能还带有一些附加条件（如 env 或 locale 标签）。

这些条件表示在某些情况下，即使是可重入版本的函数，也可能会失去线程安全性。

这种情况经常出现在依赖环境变量或区域设置（locale）的函数中。

例如，asctime_r()、ctime_r()、localtime_r() 等函数通常被标记为 MT-Safe env locale，这意味着这些函数在满足环境变量和区域设置相关条件时是线程安全的，但如果这些条件不满足（例如环境变量发生变化），它们可能仍然会出现线程不安全的情况。

在 man 手册的 ATTRIBUTES 部分，经常可以看到 env 和 locale 等标签。

通过 man 7 attributes 可以进一步查询这些标签的含义。虽然这个手册可能内容较为抽象，但通过理解这些标签，可以更好地判断函数的线程安全性。

env 标签表示该函数依赖于进程的环境变量。环境变量是全局的，多个线程共享同一个进程的环境变量，因此如果一个线程修改了环境变量，其他线程的读取行为可能会产生不可预知的结果。

举例：getenv() 函数会读取环境变量，由于环境变量是全局的，多个线程同时调用 getenv() 并不会产生冲突，但如果其中一个线程修改了环境变量（如调用 setenv() 或 putenv()），其他线程的 getenv() 结果就可能变得不确定，因此这类函数是条件性线程安全的。

locale 标签表示该函数依赖于区域设置。区域设置（Locale）是一个进程级别的设置，控制着程序如何处理与语言和文化相关的信息，比如日期格式、货币符号、字符编码等。

如果多个线程同时更改进程的区域设置，这些更改会影响所有线程。因此依赖区域设置的函数，虽然在某些条件下是线程安全的，但如果区域设置发生变化，可能会导致不安全的情况。

举例：setlocale() 函数用于设置或查询程序的当前区域设置。如果某个线程更改了区域设置，其他依赖区域设置的函数（如 strcoll()）可能会受到影响，导致线程不安全。

有些函数是绝对线程安全的，意味着它们不依赖于任何共享资源，或者完全不会受到环境变量和区域设置的影响。

例如数学库中的 sqrt() 函数。我们可以通过 man 手册查询到：

这里没有任何附加标签，比如 env 或 locale，表示该函数在任何情况下都是线程安全的。

需要强调的是，可重入函数并不一定就是线程安全的，虽然它们之间有很大的重叠。

例如，函数如果只使用局部变量而不依赖全局状态，它通常是可重入的，但并不一定是线程安全的，特别是在函数内部涉及到系统调用时。

可重入函数：可重入函数在每次调用时不会依赖外部状态（如全局变量、静态变量），即便是在中断上下文中或多个线程并发执行时，它也能安全执行。
线程安全函数：线程安全函数意味着多个线程可以同时调用该函数而不会发生数据竞争或冲突，线程安全函数通常通过使用同步机制（如锁）来确保多个线程的正确执行。

让我们通过 ctime() 和 ctime_r() 函数来具体说明不可重入函数和可重入函数的区别。

ctime()：不可重入，它返回的字符串是存储在静态缓冲区中的，所有线程共享同一个缓冲区。如果多个线程同时调用 ctime()，会导致缓冲区数据被覆盖，结果不可靠。

void* unsafe_function(void* arg) {    time_t now = time(NULL);    printf("ctime: %s\n", ctime(&now));  // 使用静态缓冲区，线程不安全    return NULL;}

ctime_r()：可重入版本，允许用户传递一个缓冲区，线程之间不共享任何状态，因此是线程安全的。

void* safe_function(void* arg) {    time_t now = time(NULL);    char buffer[26];  // 用户传入的缓冲区    printf("ctime_r: %s\n", ctime_r(&now, buffer));  // 线程安全    return NULL;}