pthread_cancel(3) Library Functions Manual pthread_cancel(3) NOM pthread_cancel -- Envoyer une requete d'annulation a un thread BIBLIOTHEQUE Bibliotheque de threads POSIX (libpthread, -lpthread) SYNOPSIS #include int pthread_cancel(pthread_t thread); DESCRIPTION La fonction pthread_cancel() envoie une requete d'annulation au thread thread. Si et quand le thread cible reagit a la requete d'annulation depend de deux attributs qui sont sous le controle de ce thread : son etat d'annulation (state) et son mode d'annulation (type). L'etat d'annulation d'un thread, determine par pthread_setcancelstate(3), peut etre active (enabled), c'est le defaut pour les nouveaux threads, ou desactive (disabled). Si un thread desactive l'annulation, alors une demande d'annulation restera dans la file d'attente jusqu'a ce que le thread active l'annulation. Si un thread active l'annulation, alors son mode d'annulation va determiner le moment ou cette annulation est effectuee. Le mode d'annulation d'un thread, determine par pthread_setcanceltype(3), peut etre asynchrone (asynchronous) ou retardee (deferred), qui est le mode par defaut pour les nouveaux threads. Un mode d'annulation asynchrone signifie que le thread peut etre annule a tout moment (d'ordinaire immediatement, mais ce n'est pas garanti). Un mode d'annulation retarde signifie que l'annulation peut etre retardee jusqu'a ce que le thread appelle une fonction qui est un point d'annulation (cancellation point). Une liste des fonctions qui sont ou peuvent etre des points d'annulation est donnee dans pthreads(7). Quand une requete d'annulation est traitee, les etapes suivantes sont effectuees pour thread (dans cet ordre) : (1) Les gestionnaires de nettoyage sont depiles (dans l'ordre inverse dans lequel ils ont ete empiles) et appeles (consultez pthread_cleanup_push(3)). (2) Les destructeurs de donnees specifiques aux threads sont appeles, dans un ordre non determine (consultez pthread_key_create(3)). (3) Le thread s'est termine (consultez pthread_exit(3)). Les etapes ci-dessus sont effectuees de maniere asynchrone par rapport a l'appel a pthread_cancel(). La valeur de retour de pthread_cancel() ne fait qu'informer l'appelant si une requete d'annulation a ete correctement mise en file d'attente. Apres qu'un thread annule s'est termine, une demande de jointure par pthread_join(3) renvoie PTHREAD_CANCELED comme etat de sortie du thread. Il faut noter que joindre un thread est la seule maniere de savoir si une annulation a termine. VALEUR RENVOYEE En cas de reussite, pthread_cancel() renvoie 0 ; en cas d'erreur, elle renvoie un numero d'erreur non nul. ERREURS ESRCH Aucun fil d'execution avec pour identifiant thread n'a pu etre trouve. ATTRIBUTS Pour une explication des termes utilises dans cette section, consulter attributes(7). +---------------------------------+--------------------------+---------+ |Interface | Attribut | Valeur | +---------------------------------+--------------------------+---------+ |pthread_cancel() | Securite des threads | MT-Safe | +---------------------------------+--------------------------+---------+ VERSIONS Sous Linux, l'annulation est implementee par des signaux. Avec l'implementation NPTL, le premier signal temps-reel (c'est-a-dire le signal 32) est utilise dans ce but. Avec LinuxThreads, le second signal temps-reel est utilise, si les signaux temps-reels sont disponibles, sinon SIGUSR2 est utilise a la place. STANDARDS POSIX.1-2008. HISTORIQUE glibc 2.0 POSIX.1-2001. EXEMPLES Le programme ci-dessous cree un thread puis l'annule. Le thread principal joint le thread annule pour verifier que son etat de sortie etait bien PTHREAD_CANCELED. La session suivante montre un exemple d'execution : $ ./a.out thread_func(): demarre ; annulation desactivee main(): envoi d'une requete d'annulation thread_func(): sur le point d'activer l'annulation main(): le thread a ete annule Source du programme #include #include #include #include #include #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; /* Desactiver l'annulation pendant un certain temps, pour eviter une reaction immediate a une requete d'annulation. */ s = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL); if (s != 0) handle_error_en(s, "pthread_setcancelstate"); printf("%s() : demarre ; annulation desactivee\n", __func__); sleep(5); printf("%s() : sur le point d'activer l'annulation\n", __func__); s = pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL); if (s != 0) handle_error_en(s, "pthread_setcancelstate"); /* sleep() est un point d'annulation. */ sleep(1000); /* Devrait etre annule pendant la periode de sommeil */ /* Cela ne devrait jamais se produire. */ printf("%s() : pas annule !\n", __func__); return NULL; } int main(void) { pthread_t thr; void *res; int s; /* Demarrer un thread et lui envoyer une requete d'annulation. */ s = pthread_create(&thr, NULL, &thread_func, NULL); if (s != 0) handle_error_en(s, "pthread_create"); sleep(2); /* Donner au thread l'occasion de demarrer */ printf("%s() : envoi d'une requete d'annulation\n", __func__); s = pthread_cancel(thr); if (s != 0) handle_error_en(s, "pthread_cancel"); /* Joindre le thread pour verifier son etat de sortie. */ s = pthread_join(thr, &res); if (s != 0) handle_error_en(s, "pthread_join"); if (res == PTHREAD_CANCELED) printf("%s() : le thread a ete annule\n", __func__); else printf("%s() : le thread n'a pas ete annule (cela ne devrait pas arriver !)\n", __func__); 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) TRADUCTION La traduction francaise de cette page de manuel a ete creee par Christophe Blaess , Stephan Rafin , Thierry Vignaud , Francois Micaux, Alain Portal , Jean-Philippe Guerard , Jean-Luc Coulon (f5ibh) , Julien Cristau , Thomas Huriaux , Nicolas Francois , Florentin Duneau , Simon Paillard , Denis Barbier , David Prevot , Frederic Hantrais et Jean- Pierre Giraud Cette traduction est une documentation libre ; veuillez vous reporter a la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITE LEGALE. Si vous decouvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message a . Pages du manuel de Linux 6.06 31 octobre 2023 pthread_cancel(3)