浅谈pthread退出方式以及清理问题

       资源的销毁远比创建来得困难，例如线程。线程终止有很多种方式，如自然退出，显式调用pthread_exit。但是执行退出的时机，线程可能阻塞在如read, write，pthread_cond_wait等接口, 无法自然退出。那么就只好发送cancel信号强行终止了，但是这种强行终止是有代价的，我们需要考虑好线程终止时资源的清理问题。

        线程的接收cancel信号的处理受两个因素影响。首先是取消状态，通过pthread_setcancelstate设置，使能或者不使能。如果处于不使能状态时，那么取消线程状态请求将排队等待直到使能线程取消状态。如果处于使能状态，那么接下来的动作决定于取消类型。

        线程取消类型通过pthread_setcanceltype设置，存在同步退出，取消点退出两种选择。同步退出意味着线程可以在任意时刻退出。默认行为是PTHREAD_CANCEL_DEFERRED，也就是接收到cancel信号后执行直到遇到取消点退出，像是pthread_cond_wait，read等阻塞型函数都是取消点，当然也可以通过pthread_testcancel手动防止取消点。关于属于取消点的函数可以通过man pthreads(7)获取列表。

        示例代码如下所示，我们创建了线程threadproc；在线程开始new了char [1024]的数组，获取mutex，然后在线程里故意调用pthread_cond_wait使得线程阻塞。主线程创建线程小睡一会，保证创建的线程已经执行；然后对刚创建的子线程发送cancel信号，并等待其结束。

#include 
#include 
#include 
#include 
#include 
#include 
#include 

#define trace(fmt, ...) printf("%s:%s:%d " fmt, __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
#define errsys(fmt, ...) printf("%s:%s:%d: %s, " fmt, __FILE__, __FUNCTION__, __LINE__, strerror(errno), ##__VA_ARGS__)

static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;

static void *threadproc(void *arg)
{
	char *str = new char[1024];
	trace("create array: %p\n", str);
		
	pthread_cond_t cond = PTHREAD_COND_INITIALIZER;

	pthread_mutex_lock(&mutex);
	trace("lock mutex: %p\n", &mutex);
	
	pthread_cond_wait(&cond, &mutex);

	pthread_mutex_unlock(&mutex);
	trace("unlock mutex: %p\n", &mutex);
	
	delete [] str;
	trace("delete array: %p\n", str);
	
	pthread_exit(NULL);
}
int main(int argc, char **argv)
{
	pthread_t tid = 0;
	pthread_create(&tid, NULL, &threadproc, NULL);

	sleep(2);
	pthread_cancel(tid);

	void *retarg = NULL;
	pthread_join(tid, &retarg);
	
	exit(EXIT_SUCCESS);
}

      编译后执行如下所示，可以看到str没有释放，mutex也没有unlock。那么首先对str的释放进行改进，我们使用pthread_cleanup_push/pthread_cleanup_pop调整调用线程stack在执行取消线程时的清理；清理函数会在线程退出时自动执行。

        pthread_cleanup_push push routine指向的函数指针进入清理函数的栈顶，当routine获得执行时，arg指向的参数将会传入。线程取消时，所有push的清理函数将会按照push先后相反的顺序执行。

        pthread_cleanup_pop 移除清理函数栈顶的routine，当excute参数不为零时还会执行一次routine。

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

$ ./run 
main.cpp:threadproc:17 create array: 0x7f57ec0008c0
main.cpp:threadproc:22 lock mutex: 0x6010c0
$

        改进代码如下，我们使用pthread_cleanup_push添加清理函数。值得注意一点是pthread_cleanup_push与pthread_cleanup_pop实现是宏，必须在同一调用函数中成对出现，并且处于同一嵌套级别；否则编译无法通过。执行结果如下所示，我们正确对heap申请的内存进行了释放，mutex也执行了unlock。

#include 
#include 
#include 
#include 
#include 
#include 
#include 

#define trace(fmt, ...) printf("%s:%s:%d " fmt, __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
#define errsys(fmt, ...) printf("%s:%s:%d: %s, " fmt, __FILE__, __FUNCTION__, __LINE__, strerror(errno), ##__VA_ARGS__)

static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;

static void array_cleanup(void *arg)
{
	char *array = (char *)arg;
	delete [] array;
	trace("delete array: %p\n", array);
}
static void mutex_unlock(void *arg)
{
	pthread_mutex_t *mtx = (pthread_mutex_t *)arg;
	pthread_mutex_unlock(mtx);
	trace("unlock mutex: %p\n", mtx);
}
static void *threadproc(void *arg)
{
	char *arr = new char[1024];
	trace("create array: %p\n", arr);
	pthread_cleanup_push(array_cleanup, arr);
		
	pthread_cond_t cond = PTHREAD_COND_INITIALIZER;

	pthread_mutex_lock(&mutex);
	trace("lock mutex: %p\n", &mutex);
	pthread_cleanup_push(mutex_unlock, &mutex);
	
	pthread_cond_wait(&cond, &mutex);

	pthread_cleanup_pop(1);
	pthread_cleanup_pop(1);
	pthread_exit(NULL);
}
int main(int argc, char **argv)
{
	pthread_t tid = 0;
	pthread_create(&tid, NULL, &threadproc, NULL);

	sleep(2);
	pthread_cancel(tid);

	void *retarg = NULL;
	pthread_join(tid, &retarg);
	
	exit(EXIT_SUCCESS);
}

$ ./run 
main.cpp:threadproc:29 create array: 0x7fa2980008c0
main.cpp:threadproc:35 lock mutex: 0x6020e0
main.cpp:mutex_unlock:24 unlock mutex: 0x6020e0
main.cpp:array_cleanup:18 delete array: 0x7fa2980008c0
$