NOM¶
pthread_cancel - Envoyer une requête d'annulation à un thread
SYNOPSIS¶
#include <pthread.h>
int pthread_cancel(pthread_t thread);
Compilez et effectuez l'édition des liens avec l'option -pthread.
DESCRIPTION¶
La fonction
pthread_cancel() envoie une requête d'annulation au
thread
thread. Si et quand le thread ciblé réagit à la
requête d'annulation dépend de deux attributs qui sont sous le
contrôle de ce thread : son état d'annulation (
state)
et son mode d'annulation (
type).
L'état d'annulation d'un thread, déterminé par
pthread_setcancelstate(3), peut être activé (
enabled), c'est le défaut pour les nouveaux threads, ou
désactivé (
disabled). Si un thread désactive
l'annulation, alors une demande d'annulation restera dans la file d'attente
jusqu'à ce que le thread active l'annulation. Si un thread active
l'annulation, alors son mode d'annulation va déterminer le moment où
cette annulation est effectuée.
Le mode d'annulation d'un thread, déterminé par
pthread_setcanceltype(3), peut être asynchrone (
asynchronous) ou retardée (
deferred), qui est le mode par
défaut pour les nouveaux threads. Un mode d'annulation asynchrone
signifie que le thread peut être annulé à tout moment
(d'ordinaire immédiatement, mais ce n'est pas garanti). Un mode
d'annulation retardé signifie que l'annulation peut être
retardée jusqu'à ce que le thread appelle une fonction qui est un
point d'annulation (
cancellation point). Une liste des
fonctions qui sont ou peuvent être des points d'annulation est
donnée dans
pthreads(7).
Quand une requête d'annulation est traitée, les étapes suivantes
sont effectuées pour
thread (dans cet ordre) :
- 1.
- Les gestionnaires de nettoyage sont dépilés (dans
l'ordre inverse dans lequel ils ont été empilés) et
appelés (consultez pthread_cleanup_push(3)).
- 2.
- Les destructeurs de données spécifiques aux
threads sont appelés, dans un ordre non déterminé
(consultez pthread_key_create(3)).
- 3.
- Le thread s'est terminé (consultez
pthread_exit(3)).
Les étapes ci-dessus sont effectuées de manière asynchrone par
rapport à l'appel à
pthread_cancel(). La valeur de retour de
pthread_cancel() ne fait qu'informer l'appelant si une requête
d'annulation a été correctement mise en file d'attente.
Après qu'un thread annulé s'est terminé, une demande de jointure
par
pthread_join(3) renvoie
PTHREAD_CANCELED comme état de
sortie du thread. Il faut noter que joindre un thread est la seule
manière de savoir si une annulation a terminé.
VALEUR RENVOYÉE¶
En cas de réussite,
pthread_cancel() renvoie 0 ; en cas
d'erreur, elle renvoie un numéro d'erreur non nul.
ERREURS¶
- ESRCH
- Aucun thread avec pour identifiant thread n'a pu
être trouvé.
POSIX.1-2001.
NOTES¶
Sous Linux, l'annulation est implémentée par des signaux. Avec
l'implémentation NPTL, le premier signal temps-réel
(c'est-à-dire le signal 32) est utilisé dans ce but. Avec
LinuxThreads, le second signal temps-réel est utilisé, si les
signaux temps-réels sont disponibles, sinon
SIGUSR2 est
utilisé à la place.
EXEMPLE¶
Le programme ci-dessous crée un thread puis l'annule. Le thread principal
joint le thread annulé pour vérifier que son état de sortie
était bien
PTHREAD_CANCELED. La session suivante montre un exemple
d'exécution :
$ ./a.out
thread_func(): started; cancellation disabled
main(): sending cancellation request
thread_func(): about to enable cancellation
main(): thread was canceled
Source du programme¶
#include <pthread.h>
#include <stdio.h>
#include <errno.h>
#include <stdlib.h>
#include <unistd.h>
#define handle_error_en(en, msg) \
do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
static void *
thread_func(void *ignored_argument)
{
int s;
/* Disable cancellation for a while, so that we don't
immediately react to a cancellation request */
s = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
if (s != 0)
handle_error_en(s, "pthread_setcancelstate");
printf("thread_func(): started; cancellation disabled\n");
sleep(5);
printf("thread_func(): about to enable cancellation\n");
s = pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
if (s != 0)
handle_error_en(s, "pthread_setcancelstate");
/* sleep() is a cancellation point */
sleep(1000); /* Should get canceled while we sleep */
/* Should never get here */
printf("thread_func(): not canceled!\n");
return NULL;
}
int
main(void)
{
pthread_t thr;
void *res;
int s;
/* Start a thread and then send it a cancellation request */
s = pthread_create(&thr, NULL, &thread_func, NULL);
if (s != 0)
handle_error_en(s, "pthread_create");
sleep(2); /* Give thread a chance to get started */
printf("main(): sending cancellation request\n");
s = pthread_cancel(thr);
if (s != 0)
handle_error_en(s, "pthread_cancel");
/* Join with thread to see what its exit status was */
s = pthread_join(thr, &res);
if (s != 0)
handle_error_en(s, "pthread_join");
if (res == PTHREAD_CANCELED)
printf("main(): thread was canceled\n");
else
printf("main(): thread wasn't canceled (shouldn't happen!)\n");
exit(EXIT_SUCCESS);
}
VOIR AUSSI¶
pthread_cleanup_push(3),
pthread_create(3),
pthread_exit(3),
pthread_join(3),
pthread_key_create(3),
pthread_setcancelstate(3),
pthread_setcanceltype(3),
pthread_testcancel(3),
pthreads(7)
COLOPHON¶
Cette page fait partie de la publication 3.44 du projet
man-pages Linux.
Une description du projet et des instructions pour signaler des anomalies
peuvent être trouvées à l'adresse
<
http://www.kernel.org/doc/man-pages/>.
TRADUCTION¶
Depuis 2010, cette traduction est maintenue à l'aide de l'outil po4a
<
http://po4a.alioth.debian.org/> par l'équipe de traduction
francophone au sein du projet perkamon
<
http://perkamon.alioth.debian.org/>.
Denis Barbier (2010).
Veuillez signaler toute erreur de traduction en écrivant à
<debian-l10n-french@lists.debian.org> ou par un rapport de bogue sur le
paquet
manpages-fr.
Vous pouvez toujours avoir accès à la version anglaise de ce document
en utilisant la commande «
man -L C
<section> <page_de_man> ».