pthread_cleanup_push()/pthread_cleanup_pop()详解

自己总结：

1.push和pop必须成对出现，因为他不是函数是宏，push有一个｛ pop有一个｝

2.pop的参数要设置为0，这样正常运行到pop处时不执行push中的函数，异常运行时执行push中的函数。

来源：http://blog.csdn.net/caianye/article/details/5912172

一般来说，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。

来源：http://blog.csdn.net/hdutigerkin/article/details/7186727

oid pthread_cleanup_push(void (*routine)(void*), void *arg);

void pthread_cleanup_pop(int execute);//这里的int参数，0是不执行push的内容，非0是执行。

原型很简单，功能跟atexit(）差不多，只不过一个是线程一个是进程。
用来设置在push/pop内线程退出时要做的事情。

需要注意的问题有几点：
1，push与pop一定是成对出现的，其实push中包含"{"而pop中包含"}"，少一个不行。
2，push可以有多个，同样的pop也要对应的数量，遵循"先进后出原则"。

push进去的函数可能在以下三个时机执行：
1，显示的调用pthread_exit();
或
2，在cancel点线程被cancel。
或
3，pthread_cleanup_pop()的参数不为0时。

以上动作都限定在push/pop涵盖的代码内。

前面的2个比较好理解，关键是pthread_cleanup_pop参数问题，其实int那是因为c没有bool，这里的参数只有0与非0的区别，对pthread_cleanup_pop，参数是5和10都是一样的，都是非0。

我们经常会看到这样的代码：
void child(void *t)
{
pthread_cleanup_push(pthread_mutex_unlock,&mutex);
pthread_mutex_lock(&mutex);
..............
pthread_mutex_unlock(&mutex);
pthread_cleanup_pop(0);
}

为啥pthread_cleanup_pop是0呢，他根本就不会执行push进来的函数指针指向的函数，没错，是不执行，真要执行了就麻烦了。

那为啥还得写这句呢？

那是因为push和pop是必须成对出现的，不写就是语法错误。

这么写的目的主要是为了保证mutex一定可以被unlock，因为，在pthread_mutex_lock和 pthread_mutex_unlock之间可能发生任何事情，比如，存在N个cancel点导致线程被main或者其他线程给cancel，而 cancel动作是不会释放互斥锁的，这样就锁死啦。

通过pthread_cleanup_push加入一个函数pthread_mutex_unlock，参照上面执行时机的说明，在线程被cancel的时候，就可以作释放锁的清理动作。如果线程正常执行，知道运行到pthread_cleanup_pop，那么锁已经被中间代码里的 pthread_mutex_unlock给释放了，这时候如果pthread_cleanup_pop的参数不为0，则会再次释放，错就错在这里了，释放了两次。

所以，pthread_cleanup_pop(0)是必须的，因为，首先要成对出现，其次，我们不希望他真的执行到这里释放两次。

同样道理：
void *exit1(void *t)
{
printf("exit1\n");
}
void *child(void *t)
{
pthread_cleanup_push(exit1,NULL);
.....
pthread_exit(NULL);
pthread_cleanup_pop(0);
}


exit1函数是在pthread_exit(NULL)的时候执行的，pthread_cleanup_pop的参数是不是0没有关系，因为根本执行不到这里。

而换成这样：
pthread_cleanup_push(exit1,NULL);
......
pthread_cleanup_pop(0);
pthread_exit(NULL);

则exit1不会执行，因为pop的参数是0，如果把pop的参数修改为1则会执行exit1，那会执行两次吗？NO，因为pthread_exit在push/pop block的外面，他不会触发exit1.



pthread_cleanup_push(exit1,NULL);
pthread_cleanup_push(exit2,NULL);
........
pthread_cleanup_pop(0);
pthread_cleanup_pop(1);

那0和1分别控制的是谁？配对原则，从外到里一对一对的拔掉就可以了，显然，0控制的是exit2. 

pthread_cleanup_push(void(*fun)(void* arg),void* arg);

pthread_cleanup_pop(int);

注意pthread_cleanup_pop(int)用法

如果pthread_cleanup_push 和pthread_cleanup_pop 包含的代码正常执行了,那么在遇到

pthread_cleanup_pop这句时，如果参数为0,将不会执行push进的函数，否则执行