C：时间函数 localtime localtime_r

C：时间函数 localtime localtime_r

localtime 和 localtime_r 的函数功能： converts the calendar time timep to broken-time representation

在调用 localtime 和 localtime_t 函数时，需特别注意：

localtime 是不可重入函数，非线程安全

localtime_r 是可重入函数，线程安全

使用 localtime 时不可重入示范：

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

int main()
{
    time_t curTime = time(NULL);
    time_t aftTime = curTime + 3600*3;

    struct tm *pTm1 = localtime(&curTime);
    struct tm *pTm2 = localtime(&aftTime);

    fprintf(stdout, "%04d%02d%02d%02d%02d%02d\n",
            pTm1->tm_year + 1900,
            pTm1->tm_mon + 1,
            pTm1->tm_mday,
            pTm1->tm_hour,
            pTm1->tm_min,
            pTm1->tm_sec);

    fprintf(stdout, "%04d%02d%02d%02d%02d%02d\n",
            pTm2->tm_year + 1900,
            pTm2->tm_mon + 1,
            pTm2->tm_mday,
            pTm2->tm_hour,
            pTm2->tm_min,
            pTm2->tm_sec);

    return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

编译 & 运行：

$ gcc -o main main.c
$ ./main
20180704225205
20180704225205
1
2
3
4

调用 localtime 函数并获取其返回值（一个指向 struct tm 结构类型数据的指针）后，我们并未对返回值进行显式地释放。

这并没有什么问题（不会导致内存泄漏）。

因为 localtime 函数返回值是一个指针，指向一个静态变量，这个静态变量是库中的一个 static struct tm 类型数据。

man localtime：

The return value points to a statically allocated struct which might be overwritten by subsequent calls to any of the date and time functions.

这将引出新的问题，同一进程多个线程中同时调用（极短时间内连续调用） localtime 函数，返回值（tm）可能被覆盖。

举个栗子：

两个线程A和B同时调用 localtime 函数：

时刻1：线程A调用 localtime 函数，得到一个指针，指向 static struct tm 类型变量；（tm中存储的值更新为 value-a）

时刻2：线程B调用 localtime 函数，得到一个指针，指向 static struct tm 类型变量；（tm中存储的值更新为 value-b）

时刻3：线程A对 localtime 返回的指针进行相关引用操作（例如 printf 输出某字段），此时 static struct tm 中的值实际是 value-b，并非预期的 value-a

时刻4：线程B对 localtime 返回的指针进行相关引用操作，此时 static struct tm 中的值实际是 value-b

上面的示范代码虽然是在同一线程中，但是已经可以简单模拟这样的多线程执行调用流程。

如何解决？

localtime_r 是 localtime 的可重入版本（线程安全版本）。

localtime 不可重入是由于 static struct tm 是库中的一个静态变量，如果我们在调用 localtime 时传入一个 struct tm 类型变量（指针）用于存放结果，岂不是实现可重入？

Bingo！

struct tm *localtime(const time_t *timep);
struct tm *localtime_r(const time_t *timep, struct tm *result);
1
2

调用 localtime 只需要传入指向 time_t 的一个常量指针；

调用 localtime_t 不仅需要传入指向 time_t 的一个常量指针，还需要传入指向 struct tm 的一个指针，结果将存储在 result 指向的 struct tm 对象中；

The return value points to a statically allocated struct which might be overwritten by subsequent calls to any of the date and time functions.

The localtime_r() function does the same, but stores the data in a user-supplied struct.

使用 localtime_r 时可重入示范：

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

int main()
{
    time_t curTime = time(NULL);
    time_t aftTime = curTime + 3600*3;

    struct tm tm1;
    struct tm tm2;
    localtime_r(&curTime, &tm1);
    localtime_r(&aftTime, &tm2);

    fprintf(stdout, "%04d%02d%02d%02d%02d%02d\n",
            tm1.tm_year + 1900,
            tm1.tm_mon + 1,
            tm1.tm_mday,
            tm1.tm_hour,
            tm1.tm_min,
            tm1.tm_sec);

    fprintf(stdout, "%04d%02d%02d%02d%02d%02d\n",
            tm2.tm_year + 1900,
            tm2.tm_mon + 1,
            tm2.tm_mday,
            tm2.tm_hour,
            tm2.tm_min,
            tm2.tm_sec);

    return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

编译 & 运行：

$ gcc -o main main.c
$ ./main
20180704200531
20180704230531
1
2
3
4