pthread_cleanup_push()/pthread_cleanup_pop()

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


int main(int , char **);
void my_print(void *);
void* fn(void *);


void my_print(void *arg)
{
        printf("cleanup: %s\n", (char *)arg);
        return;
}




int main(int argc, char *argv[])
{
        int a;
        pthread_t ntid;
        int t;


        a = pthread_create(&ntid, NULL, (void* (*)(void *))fn, NULL);
        if(a!=0)
                printf("create pthread error.\n");


        if(pthread_join(ntid, (void **)&t) != 0)
                printf("pthread_join error.\n");
        else
                printf("return value=%d\n", (int)t);


        return 0;
}
void* fn(void *p){
        printf("pthread start\n");
        pthread_cleanup_push(my_print, (void *)"thread first handler");
        pthread_cleanup_push(my_print, (void *)"thread second handler");
        printf("pthread complete\n");
        return (void *)100;
}

编译结果：

[yk_peng@pengyangkang work]$ gcc test.c -pthread
test.c: 在函数‘fn’中:
test.c:38:1: 错误：expected ‘while’ at end of input
test.c:38:1: 错误：expected declaration or statement at end of input
test.c:38:1: 错误：expected declaration or statement at end of input
test.c:38:1: 错误：expected declaration or statement at end of input
test.c:38:1: 错误：expected declaration or statement at end of input

怎么查都没发现问题，后来想起了，pthread_cleanup_push和pthread_cleanup_pop是用宏实现的。故此使用-E选项编译，查看预编译后的文件。

尼玛，最后面居然多了两个{ 没有与其配对的， 怪不得要必须和pthread_cleanup_pop成对使用。

pthread_cleanup_push():

 do { __pthread_unwind_buf_t __cancel_buf; void (*__cancel_routine) (void *) = (my_print); void *__cancel_arg = ((void *)"thread second handler"); int __not_first_call = __sigsetjmp ((struct __jmp_buf_tag *) (void *) __cancel_buf.__cancel_jmp_buf, 0); if (__builtin_expect (__not_first_call, 0)) { __cancel_routine (__cancel_arg); __pthread_unwind_next (&__cancel_buf); } __pthread_register_cancel (&__cancel_buf);do {

pthread_cleanup_pop():

do { } while (0); } while (0); __pthread_unregister_cancel (&__cancel_buf); if (0) __cancel_routine (__cancel_arg); }while (0)

总结，1。宏定义不作语法检测，只是替换，所以容易出现奇怪的问题，因为编译不过的时候，我们大部分时候在按语法规则去查错，所以问题出现在宏的时候，会感觉问题奇怪 2。必要时查看预处理文件，这才是最终编译器要编译的文件

再转载一下别人的，学习学习

一般来说，Posix的线程终止有两种情况：正常终止和非正常终止。线程主动调用pthread_exit()或者从线程函数中return都将使线程正常退出，这是可预见的退出方式；非正常终止是线程在其他线程的干预下，或者由于自身运行出错（比如访问非法地址）而退出，这种退出方式是不可预见的。

不论是可预见的线程终止还是异常终止，都会存在资源释放的问题，在不考虑因运行出错而退出的前提下，如何保证线程终止时能顺利的释放掉自己所占用的资源，特别是锁资源，就是一个必须考虑解决的问题。

最经常出现的情形是资源独占锁的使用：线程为了访问临界资源而为其加上锁，但在访问过程中被外界取消，如果线程处于响应取消状态，且采用异步方式响应，或者在打开独占锁以前的运行路径上存在取消点，则该临界资源将永远处于锁定状态得不到释放。外界取消操作是不可预见的，因此的确需要一个机制来简化用于资源释放的编程。

在POSIX线程API中提供了一个pthread_cleanup_push()/pthread_cleanup_pop()函数对用于自动释放资源 --从pthread_cleanup_push()的调用点到pthread_cleanup_pop()之间的程序段中的终止动作（包括调用 pthread_exit()和取消点终止）都将执行pthread_cleanup_push()所指定的清理函数。API定义如下：

void pthread_cleanup_push(void (*routine) (void  *),  void *arg)
void pthread_cleanup_pop(int execute)

pthread_cleanup_push()/pthread_cleanup_pop()采用先入后出的栈结构管理，void routine(void *arg)函数在调用pthread_cleanup_push()时压入清理函数栈，多次对pthread_cleanup_push()的调用将在清理函数栈中形成一个函数链，在执行该函数链时按照压栈的相反顺序弹出。execute参数表示执行到pthread_cleanup_pop()时是否在弹出清理函数的同时执行该函数，为0表示不执行，非0为执行；这个参数并不影响异常终止时清理函数的执行。

pthread_cleanup_push()/pthread_cleanup_pop()是以宏方式实现的，这是pthread.h中的宏定义：

#define pthread_cleanup_push(routine,arg)                                     
  { struct _pthread_cleanup_buffer _buffer;                                   
    _pthread_cleanup_push (&_buffer, (routine), (arg));
#define pthread_cleanup_pop(execute)                                          
    _pthread_cleanup_pop (&_buffer, (execute)); }
可见,pthread_cleanup_push()带有一个"{"，而pthread_cleanup_pop()带有一个"}"，因此这两个函数必须成对出现，且必须位于程序的同一级别的代码段中才能通过编译。在下面的例子里，当线程在"do some work"中终止时，将主动调用pthread_mutex_unlock(mut)，以完成解锁动作。
work"中终止时，将主动调用pthread_mutex_unlock(mut)，以完成解锁动作。
pthread_cleanup_push(pthread_mutex_unlock, (void *) &mut);
pthread_mutex_lock(&mut);
/* do some work */
pthread_mutex_unlock(&mut);
pthread_cleanup_pop(0);
必须要注意的是，如果线程处于PTHREAD_CANCEL_ASYNCHRONOUS状态，上述代码段就有可能出错，因为CANCEL事件有可能在
pthread_cleanup_push()和pthread_mutex_lock()之间发生，或者在pthread_mutex_unlock()和pthread_cleanup_pop()之间发生，从而导致清理函数unlock一个并没有加锁的
mutex变量，造成错误。因此，在使用清理函数的时候，都应该暂时设置成PTHREAD_CANCEL_DEFERRED模式。为此，POSIX的
Linux实现中还提供了一对不保证可移植的pthread_cleanup_push_defer_np()/pthread_cleanup_pop_defer_np()扩展函数，功能与以下
代码段相当：
{ int oldtype;
 pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldtype);
 pthread_cleanup_push(routine, arg);
 ...
 pthread_cleanup_pop(execute);
 pthread_setcanceltype(oldtype, NULL);
 }

---

上面我用红色标记的部分是这两个函数的关键作用,我的理解就是:
pthread_cleanup_push(pthread_mutex_unlock, (void *) &mut);
pthread_mutex_lock(&mut);
/* do some work */
pthread_mutex_unlock(&mut);
pthread_cleanup_pop(0);
本来do some work之后是有pthread_mutex_unlock(&mut);这句,也就是有解锁操作,但是在do some work时会出现非正常终止,那样的话,系统会根据pthread_cleanup_push中提供的函数,和参数进行解锁操作或者其他操作,以免造成死锁!

---

补充:
在线程宿主函数中主动调用return，如果return语句包含在pthread_cleanup_push()/pthread_cleanup_pop()对中，则不会引起清理函数的执行，反而会导致segment fault。