Linux 下子线程的 pthread_cleanup_push() 和 pthread_cleanup_pop() 研究

线程退出前可能有一些清理工作，但是这部分代码又不会放到线程主体部分，就需要挂接一个或者几个线程“清洁工”来做这部分事情。需要这对兄弟：

#include<pthread.h>

void pthread_cleanup_push(void (*rtn)(void *), void *arg);
void pthread_cleanup_pop(int execute);

显然pthread_cleanup_push() 是挂接 清理函数的，它的返回值类型为 void，有两个入口参数，第一个参数是清理函数函数指针，第二个参数是传给清理函数的 typeless pointer 。

另一个兄弟 pthread_cleanup_pop() 是来触发清理函数的，是按照相反的顺序来触发清理函数的。而如果它的入口参数 execute 为0值，则对应的清理函数并没有真正的执行。

例如下面这个例子：

/****************************************************************
#     File Name: thread_cleanup3.c
#     Author   : lintex9527
#     E-Mail   : lintex9527@yeah.net
#  Created Time: Sat 22 Aug 2015 03:25:09 PM HKT
#  Purpose     : 测试清理函数的触发顺序，以及执行与否。
#  Outline     : 
#  Usage       : 
#               --------------------------------------------------
#  Result      : 
#               --------------------------------------------------
*****************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <pthread.h>

/* 线程传递给 清理函数 的参数结构体 */
struct argtype{
    int a,b;
    int result;
};

void print_argtype(const char *str, struct argtype *p)
{
    printf("%s\n", str);
    printf("    a = %d, b = %d\n", p->a, p->b);
    printf("    result = %d\n", p->result);
}

/* for thread 1 */
struct argtype entity1 = {
    .a = 50,
    .b = 5,
    .result = 11
};

/* 以下是3个清理函数 */
void cleanup_add(void *arg)
{
    struct argtype *p = (struct argtype *)arg;
    p->result = p->a + p->b;
    print_argtype("cleanup [add]", p);
    //pthread_exit((void *)p->result);
}

void cleanup_minus(void *arg)
{
    struct argtype *p = (struct argtype *)arg;
    p->result = p->a - p->b;
    print_argtype("cleanup [minus]", p);
    //pthread_exit((void *)p->result);
}


void cleanup_times(void *arg)
{
    struct argtype *p = (struct argtype *)arg;
    p->result = p->a * p->b;
    print_argtype("cleanup [times]", p);
    //pthread_exit((void *)p->result);
}

/* 子线程1函数，临时地改变了entity1结构体中成员值，检查清理函数执行点 */
void* thr1_fun(void *arg)
{ 
    printf("Now thread1 [%lu] start:\n", pthread_self());

    pthread_cleanup_push(cleanup_times, (void *)&entity1);　　// cleanup_times
    entity1.a = 20;
    entity1.b = 2;
    pthread_cleanup_push(cleanup_minus, (void *)&entity1);　　// cleanup_minus
    pthread_cleanup_push(cleanup_add, (void *)&entity1);　　　// cleanup_add
    pthread_cleanup_pop(3);　　// cleanup_add

    entity1.a = 30;
    entity1.b = 3;
    pthread_cleanup_pop(1);　　// cleanup_minus

    entity1.a = 40;
    entity1.b = 4;
    pthread_cleanup_pop(1);　　// cleanup_times

    entity1.a = 80;
    entity1.b = 8;
    pthread_exit((void *)entity1.result);
}


int main(void)
{
    int err;
    pthread_t tid1;
    void *tret;

    err = pthread_create(&tid1, NULL, thr1_fun, NULL);
    err = pthread_join(tid1, &tret);
    if (err != 0)
    {
        perror("pthread_join");
        return -1;
    }

    printf("In main get result [%d] from thread %lu\n", tret, tid1);
    print_argtype("main:", &entity1);

    return 0;
}

执行结果：

$ ./thread_cleanup3.exe 
Now thread1 [140090204903168] start:
cleanup [add]
    a = 20, b = 2
    result = 22
cleanup [minus]
    a = 30, b = 3
    result = 27
cleanup [times]
    a = 40, b = 4
    result = 160
In main get result [160] from thread 140090204903168
main:
    a = 80, b = 8
    result = 160

顺序测试

在这个例子中，我把 pthread_cleanup_pop(int execute) 中的 execute 都设定为非零值，测试3个清理函数的调用顺序，

注册的顺序是： cleanup_times --> cleanup_minus --> cleanup_add

调用的顺序是： cleanup_add   --> cleanup_minus --> cleanup_times

的的确确是按照相反的顺序调用的。

执行点测试

为了测试每一个清理函数的执行点，我在每一个pthread_cleanup_pop() 之前都修改了 结构体 entity1 的域 a,b。经过比对发现每一个 pthread_cleanup_push() 和 pthread_cleanup_pop() 形成一个 pairs，因为它们是基于宏实现的，pthread_cleanup_push() 中包含了一个“{”，而 pthread_cleanup_pop() 中包含了一个“}” 和前面的对应，因此它们必须成对的出现，否则代码通不过编译。经过检查和对比，发现每一个 pairs 虽然在代码形式上互相嵌套，但是它们的执行没有互相嵌套。即在执行最外面的 cleanup_times() 并没有递归调用 cleanup_minus() 继而递归调用 cleanup_times()。

因此在处理最外面的 cleanup_times() 时屏蔽了从 pthread_cleanup_push(cleanup_minus, xxx) 到 pthread_cleanupo_pop(yyy) （与 cleanup_minus 对应的） 部分的代码。

而在处理 cleanup_minus() 时屏蔽了从 pthread_cleanup_push(cleanup_add, xxx) 到 pthread_cleanup_pop(yyy) (与 cleanup_add 对应的) 部分的代码。

因为 pop 顺序和 push 顺序是相反的，那么从第一个 pop 的顺序开始执行: cleanup_add --> cleanup_minus --> cleanup_times.

但是每一次执行 cleanup_xxx 的参数为什么会不一样的呢？是从哪里开始变化的呢？

是从线程函数入口上到下，一直到 pthread_cleanup_pop() 部分的参数对当前的 cleanup_xxx() 函数有效。在当前 pthread_cleanup_pop() 下面的语句是对后面一个 pop() 函数起作用的。

如下面这张图：

左边的指示线条表征的是每一个 push 入栈的清理函数可访问的资源区；

右边的双箭头线表征的是 push / pop 对子，虽然在代码形式上有嵌套，但是在函数执行上并不会嵌套执行。

根据分析，

entity1.a , entity1.b 传递给 cleanup_add(） 函数的值是 20 , 2;

entity1.a , entity1.b 传递给 cleanup_minus(） 函数的值是 30, 3;

entity1.a , entity1.b 传递给 cleanup_times(） 函数的值是 40, 4;

而最终在 main thread 中可以访问到的 entity1.a, entity1.b 的值是 80 , 8 。那个时候已经没有 清理函数 cleanup_xxx() 去访问 entity1 结构体了。

另外，我原本在清理函数内部添加了 pthread_exit() 函数，这会出现什么情况呢？比如取消 cleanup_times() 函数里 pthread_exit() 之前的注释，编译运行结果如下：

$ ./thread_cleanup3.exe 
Now thread1 [140415830189824] start:
now cleanup_add.
cleanup [add]
    a = 20, b = 2
    result = 22
now cleanup_minus.
cleanup [minus]
    a = 30, b = 3
    result = 27
now cleanup_times.
cleanup [times]
    a = 40, b = 4
    result = 160
In main get result [160] from thread 140415830189824
main:
    a = 40, b = 4
    result = 160

对比之前，发现在 main thread 中的 a,b 值是40， 4 ，这和子线程退出点有关，子线程没有走到下面这一步：

    entity1.a = 40;
    entity1.b = 4;
    printf("now cleanup_times.\n");
    pthread_cleanup_pop(1); // cleanup_times

-------------------------------------------------------------------// 下面没有执行

    entity1.a = 80;
    entity1.b = 8;
    printf("thread 1 is exit...\n");
    pthread_exit((void *)entity1.result);

说明提前使用 pthread_exit() 那么各个函数访问的资源就更受限。

但是在2个及以上的清理函数中添加 pthread_exit() ，会导致线程不断地调用 清理函数，进入死机状态。

总结就是不要在清理函数中添加 pthread_exit() 。