pthread_cancel

PTHREAD_CANCEL(3)          Manuel du programmeur Linux         PTHREAD_CANCEL(3)



NOM
       pthread_cancel - Envoyer une requête d'annulation à un thread

SYNOPSIS
       #include <pthread.h>

       int pthread_cancel(pthread_t thread);

       Compiler et éditer les liens avec -pthreads.

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 fil d’exécution avec pour identifiant thread n'a pu être
              trouvé.

ATTRIBUTS
       Pour une explication des termes utilisés dans cette section, consulter
       attributes(7).

       ┌─────────────────┬──────────────────────┬─────────┐
       │Interface        Attribut             Valeur  │
       ├─────────────────┼──────────────────────┼─────────┤
       │pthread_cancel() │ Sécurité des threads │ MT-Safe │
       └─────────────────┴──────────────────────┴─────────┘

CONFORMITÉ
       POSIX.1-2001, POSIX.1-2008.

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.

EXEMPLES
       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 5.10 du projet man-pages Linux.
       Une description du projet et des instructions pour signaler des anomalies
       et la dernière version de cette page peuvent être trouvées à l'adresse
       https://www.kernel.org/doc/man-pages/.


TRADUCTION
       La traduction française de cette page de manuel a été créée par
       Christophe Blaess <https://www.blaess.fr/christophe/>, Stéphan Rafin
       <stephan.rafin@laposte.net>, Thierry Vignaud <tvignaud@mandriva.com>,
       François Micaux, Alain Portal <aportal@univ-montp2.fr>, Jean-Philippe
       Guérard <fevrier@tigreraye.org>, Jean-Luc Coulon (f5ibh) <jean-
       luc.coulon@wanadoo.fr>, Julien Cristau <jcristau@debian.org>, Thomas
       Huriaux <thomas.huriaux@gmail.com>, Nicolas François
       <nicolas.francois@centraliens.net>, Florentin Duneau <fduneau@gmail.com>,
       Simon Paillard <simon.paillard@resel.enst-bretagne.fr>, Denis Barbier
       <barbier@debian.org>, David Prévot <david@tilapin.org> et Frédéric
       Hantrais <fhantrais@gmail.com>

       Cette traduction est une documentation libre ; veuillez vous reporter à
       la GNU General Public License version 3
       ⟨https://www.gnu.org/licenses/gpl-3.0.html⟩ concernant les conditions de
       copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE.

       Si vous découvrez un bogue dans la traduction de cette page de manuel,
       veuillez envoyer un message à debian-l10n-french@lists.debian.org ⟨⟩.




Linux                              9 juin 2020                 PTHREAD_CANCEL(3)