线程取消(pthread_cancel)

基本概念
pthread_cancel调用并不等待线程终止，它只提出请求。线程在取消请求(pthread_cancel)发出后会继续运行，
直到到达某个取消点(CancellationPoint)。取消点是线程检查是否被取消并按照请求进行动作的一个位置.

        线程取消的方法是向目标线程发Cancel信号，但如何处理Cancel信号则由目标线程自己决定，或者忽略、或者立即终止、或者继续运行至Cancelation-point（取消点），由不同的Cancelation状态决定。

与线程取消相关的pthread函数
int pthread_cancel(pthread_t thread)
发送终止信号给thread线程，如果成功则返回0，否则为非0值。发送成功并不意味着thread会终止。

       一个线程可以通过此机制向另外一个线程发送结束请求，值得一提的是，接收此请求的线程可以通过本线程的两个属性来决定是否取消以及时同步（延时）取消还是异步（立即）取消。函数成功返回，并不代表那线程就结束了。

int pthread_setcancelstate(int state,   int *oldstate)   
设置本线程对Cancel信号的反应，state有两种值：PTHREAD_CANCEL_ENABLE（缺省）和PTHREAD_CANCEL_DISABLE，
分别表示收到信号后设为CANCLED状态和忽略CANCEL信号继续运行；old_state如果不为NULL则存入原来的Cancel状态以便恢复。  

PTHREAD_CANCEL_ENABLE：

      表明此线程是可取消的，也就是说，在接收一个取消请求到来之后，它注定是要取消的，只不过它有两种取消方式，一种是同步取消，另外一种是异步取消，下面会详说的。

PTHREAD_CANCEL_DISABLE：

         表明此线程是不可取消的，那么接收取消请求之后，它依然自我的执行。

int pthread_setcanceltype(int type, int *oldtype)   
设置本线程取消动作的执行时机，type由两种取值：PTHREAD_CANCEL_DEFFERED和PTHREAD_CANCEL_ASYCHRONOUS，仅当Cancel状态为Enable时有效，分别表示收到信号后继续运行至下一个取消点再退出和立即执行取消动作（退出）；oldtype如果不为NULL则存入运来的取消动作类型值。  

     PTHREAD_CANCEL_DEFERRED：  

     表明在线程是可取消的情况下，它是同步（延时）取消的。所谓同步取消的意思就是说，在收到一个取消请求之后，它会继续执行下去，直到找到下一个取消点进行退出。

那么什么是取消点呢？：

取消点是在程序在运行的时候检测是否收到取消请求，是否允许允许操作执行的点。下面的POSIX线程函数就是取消点：
pthread_join()
 pthread_cond_wait()
pthread_cond_timedwait()
 pthread_testcancel()
sem_wait()
sigwait()

还有很多，可以参考man 7 threads

             创建一个取消点:  void pthread_testcancel(void)

PTHREAD_CANCEL_ASYNCHRONOUS：

       表明是异步取消方式，也就是说线程在收到取消请求之后，立即取消退出。

在默认的情况下，一个线程是可取消的并且是同步取消的。

这里，我们要考虑到一个线程退出后它后续处理的问题，比如说，如果一个线程正执行到一个锁内时，已经获得锁了，这时，它因为异常退出了，那么此时就是一个死锁的问题。这时我们可使用下面的两个函数：

在POSIX线程API中提供了一个pthread_cleanup_push()/ pthread_cleanup_pop()函数,

就是说在一个线程结束的时候，会自动执行一个clean-up函数柄，这个函数柄里有一个stack（栈），我们之前就通过pthread_cleanup_push往这个栈里压入了一个函数，我们压入很多个，然后退出的时候，clean-up函数柄会自动的从这些栈里拿出函数进行执行。

如果此函数没有异常退出，那这些栈的函数怎么办呢？我们可以通过phread_cleanup_pop弹出这些栈里的函数，注意，此时的参数要为0，如果非0的话，弹出的同时也会执行这些函数的。

那之前讲到的死锁问题我们可以这样解决：

pthread_cleanup_push(pthread_mutex_unlock, (void *) &mutex);

pthread_mutex_lock(&mutex);

/* do some work */

pthread_mutex_unlock(&mutex);

pthread_cleanup_pop(0);

---

线程终止的清理工作

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() 的调用将在清理函数栈中形成一个函数链；
从pthread_cleanup_push的调用点到pthread_cleanup_pop之间的程序段中的终止动作（包括调用pthread_exit()和异常终止，不包括return）
都将执行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)，以完成解锁动作

pthread_cleanup_push(pthread_mutex_unlock, (void*) &mut);
pthread_mutex_lock(&mut);
/* do some work */
pthread_mutex_unlock(&mut);
pthread_cleanup_pop(0);

或者

void cleanup(void *arg)
{    
    pthread_mutex_unlock(&mutex);
}

void* thread0(void* arg)
{    
    pthread_cleanup_push(cleanup, NULL); // thread cleanup handler    p
    thread_mutex_lock(&mutex);    
    pthread_cond_wait(&cond, &mutex);    
    pthread_mutex_unlock(&mutex);    
    pthread_cleanup_pop(0);    
    pthread_exit(NULL);
}
复制代码

void pthread_testcancel(void)

是说pthread_testcancel在不包含取消点，但是又需要取消点的地方创建一个取消点，以便在一个没有包含取消点的执行代码线程中响应取消请求.
线程取消功能处于启用状态且取消状态设置为延迟状态时，pthread_testcancel()函数有效。
如果在取消功能处处于禁用状态下调用pthread_testcancel()，则该函数不起作用。
请务必仅在线程取消线程操作安全的序列中插入pthread_testcancel()。除通过pthread_testcancel()调用以编程方式建立的取消点意外，pthread标准还指定了几个取消点。测试退出点,就是测试cancel信号.

取消点:
线程取消的方法是向目标线程发Cancel信号，但如何处理Cancel信号则由目标线程自己决定，或者忽略、或者立即终止、或者继续运行至Cancelation-point（取消点），由不同的Cancelation状态决定。

线程接收到CANCEL信号的缺省处理（即pthread_create()创建线程的缺省状态）是继续运行至取消点，也就是说设置一个CANCELED状态，线程继续运行，只有运行至Cancelation-point的时候才会退出。

pthreads标准指定了几个取消点，其中包括：
(1)通过pthread_testcancel调用以编程方式建立线程取消点。 
(2)线程等待pthread_cond_wait或pthread_cond_timewait()中的特定条件。 
(3)被sigwait(2)阻塞的函数 
(4)一些标准的库调用。通常，这些调用包括线程可基于阻塞的函数。 
  
缺省情况下，将启用取消功能。有时，您可能希望应用程序禁用取消功能。如果禁用取消功能，则会导致延迟所有的取消请求，
直到再次启用取消请求。  
根据POSIX标准，pthread_join()、pthread_testcancel()、pthread_cond_wait()、pthread_cond_timedwait()、sem_wait()、sigwait()等函数以及
read()、write()等会引起阻塞的系统调用都是Cancelation-point，而其他pthread函数都不会引起Cancelation动作。
但是pthread_cancel的手册页声称，由于LinuxThread库与C库结合得不好，因而目前C库函数都不是Cancelation-point；但CANCEL信号会使线程从阻塞的系统调用中退出，并置EINTR错误码，因此可以在需要作为Cancelation-point的系统调用前后调用pthread_testcancel()，从而达到POSIX标准所要求的目标.
即如下代码段：
pthread_testcancel();
retcode = read(fd, buffer, length);
pthread_testcancel();

注意：
程序设计方面的考虑,如果线程处于无限循环中，且循环体内没有执行至取消点的必然路径，则线程无法由外部其他线程的取消请求而终止。因此在这样的循环体的必经路径上应该加入pthread_testcancel()调用.

 

---

 

描述一下取消一个线程的过程：
1) 其他线程通过调用pthread_cancel()函数，向目标线程发送取消请求（cancellation request）。
2) 取消请求发出后，根据目标线程的cancel state来决定取消请求是否会到达目标线程：
　　a. 如果目标线程的cancel state是PTHREAD_CANCEL_ENABLE（默认），取消请求会到达目标线程。
　　b. 如果目标线程的cancel state是PTHREAD_CANCEL_DISABLE，取消请求会被放入队列。直到目标线程的cancel state变为PTHREAD_CANCEL_ENABLE，取消请求才会从队列里取出，发到目标线程。
3) 取消请求到达目标线程后，根据目标线程的cancel type来决定线程何时取消：
　　a. 如果目标线程的cancel type是PTHREAD_CANCEL_DEFERRED（默认），目标线程并不会马上取消，而是在执行下一条cancellation point的时候才会取消。有很多系统函数都是cancellation point，、
　　详细的列表可以在Linux上用man 7 pthreads查看。除了列出来的cancellation point，pthread_testcancel()也是一个cancellation point。就是说目标线程执行到pthread_testcancel()函数的时候，
　　如果该线程收到过取消请求，而且它的cancel type是PTHREAD_CANCEL_DEFERRED，那么这个线程就会在这个函数里取消（退出），这个函数就不再返回了，目标线程也没有了。
　　b. 如果目标线程的cancel type是PTHREAD_CANCEL_ASYNCHRONOUS（也就是异步取消），目标线程会立即取消（这里的“立即”只是说目标线程不用等执行到属于cancellation point的函数的时候才会取消，
　　它会在获得调度之后立即取消，
　　因为内核调度会有延时，所以并不能保证时间上的“立即”）。

举个例子，说明一下这些与线程取消相关的函数的用法：

void thread_function(void *arg)
{
/**
* 线程准备执行一些关键工作，在这个过程中不希望被取消。
* 所以先通过pthread_setcancelstate()将本线程的cancel state
* 设为disabled。
*/
pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
/* 执行关键工作 */
...
/**
* 关键工作执行完成，可以被取消。
* 通过pthread_setcancelstate()将本线程的cancel state
* 设为enabled。
*/
pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
/**
* 调用pthread_testcancel()函数，检查一下在cancel state
* 为disabled状态的时候，是否有取消请求发送给本线程。
* 如果有的话就取消（退出）。
*/
pthread_testcancel();
/**
* pthread_testcancel()返回了，表明之前没有取消请求发送给本线程，
* 继续其余的工作。
* 这时候如果有取消请求发送给本线程，会在下一次执行到
* cancellation point的时候（例如sleep(), read(), write(), ...）时取消。
*/
...
/**
* 从这里开始，函数里不再包含cancellation point了。
* 如果收到取消请求，将无法取消。所以先把本线程的cancel type
* 设为asynchronous，收到取消请求将立即取消。
*/
pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, NULL);
/* 不包含cancellation point的代码 */
...
}

---

pthread_testcancel()函数一方面可以用来使LinuxThread与POSIX一致；另一方面就是如果线程函数里没有作为取消点的函数，就可以用pthread_testcancel()人为地创建取消点，使得该线程一旦收到取消请求就可以被取消。