NOM¶
pthread_cleanup_push, pthread_cleanup_pop - Empiler et dépiler des
gestionnaires de nettoyage de threads
SYNOPSIS¶
#include <pthread.h>
void pthread_cleanup_push(void (*routine)(void *),
void *arg);
void pthread_cleanup_pop(int execute);
Compilez et effectuez l'édition des liens avec l'option -pthread.
DESCRIPTION¶
Ces fonctions manipulent la pile de gestionnaires de nettoyage du thread
appelant. Un gestionnaire de nettoyage est une fonction qui est
automatiquement exécutée quand un thread est annulé (ou dans
d'autres circonstances, décrites ci-dessous). Il peut, par exemple,
déverrouiller un mutex pour le rendre disponible aux autres threads du
processus.
La fonction
pthread_cleanup_push() empile
routine au sommet de la
pile des gestionnaires de nettoyage. Quand
routine sera appelée
ultérieurement,
arg sera passé en argument.
La fonction
pthread_cleanup_pop() dépile la routine au sommet de la
pile des gestionnaires de nettoyage, et éventuellement l'exécute si
l'argumeent
execute est non nul.
Un gestionnaire de nettoyage est dépilé et exécuté dans les
circonstances suivantes :
- 1.
- Quand un thread est annulé, tous les gestionnaires de
nettoyage empilés sont dépilés et exécutés dans
l'ordre inverse dans lequel ils ont été empilés.
- 2.
- Quand un thread se termine en appelant
pthread_exit(3), tous les gestionnaires de nettoyage sont
exécutés comme décrit dans le point précédent. Il
faut noter que les gestionnaires de nettoyage ne sont pas
appelés si le thread se termine par un return depuis la
fonction de démarrage du thread.
- 3.
- Quand un thread appelle pthread_cleanup_pop() avec
un argument execute non nul, le gestionnaire de nettoyage au sommet
de la pile est dépilé et exécuté.
POSIX.1 autorise
pthread_cleanup_push() et
pthread_cleanup_pop()
à être implémentées comme des macros qui sont
développées en du texte contenant «
{ »
et «
} » respectivement. Pour cette raison,
l'appelant doit s'assurer que les appels à ces fonctions sont
appariés à l'intérieur d'une même fonction, et au
même niveau d'imbriquement lexical. En d'autres termes, un gestionnaire
de nettoyage n'est établi que pendant l'exécution d'une partie
spécifique de code.
Un appel à
longjmp(3) (resp.
siglongjmp(3)) produit des
résultats indéfinis si un appel à
pthread_cleanup_push()
ou
pthread_cleanup_pop() a été réalisé sans l'appel
correspondant de la paire si le tampon de saut a été rempli par
setjmp(3) (resp.
sigsetjmp(3)). De la même manière, un
appel à
longjmp(3) (resp.
siglongjmp(3)) depuis un
gestionnaire de nettoyage entraine des résultats indéfinis, sauf si
le tampon de saut a lui aussi été rempli dans
setjmp(3)
(resp.
sigsetjmp(3)) à l'intérieur du gestionnaire.
VALEUR RENVOYÉE¶
Ces fonctions ne renvoient pas de valeur.
ERREURS¶
Il n'y a pas d'erreur.
POSIX.1-2001.
NOTES¶
Sous Linux, les fonctions
pthread_cleanup_push() et
pthread_cleanup_pop()
sont implémentées comme des
macros qui sont développées en du texte contenant «
{ » et «
} » respectivement. Cela
signifie que les variables déclarées entre les appels appariés
à ces fonctions ne seront visible qu'à l'intérieur de cet
intervalle.
POSIX.1 indique qu'utiliser
return,
break,
continue, ou
goto pour quitter prématurément un bloc compris entre
pthread_cleanup_push() et
pthread_cleanup_pop() entraine un
comportement indéfini. Les applications portables doivent l'éviter.
EXEMPLE¶
Le programme ci-dessous fournit un exemple simple de l'utilisation des fonctions
décrites dans cette page. Le programme crée un thread qui
exécute une boucle comprise entre des appels à
pthread_cleanup_push() et
pthread_cleanup_pop(). Cette boucle
incrémente une variable globale,
cnt, à chaque seconde. En
fonction des arguments fournis sur la ligne de commande,, le thread principal
envoie une requête d'annulation à l'autre thread, ou définit
une variable globale qui fait que l'autre thread quitte sa boucle et se
termine normalement (avec un
return).
Dans la session d'interpréteur de commande ci-dessous, le thread principal
envoie une requête d'annulation à l'autre thread :
$ ./a.out
New thread started
cnt = 0
cnt = 1
Canceling thread
Called clean-up handler
Thread was canceled; cnt = 0
Dans la sortie, nous voyons que le thread a été annulé, et que le
gestionnaire de nettoyage a été appelé et a remis la valeur de
la variable globale
cnt à 0.
Lors de l'exécution suivante, le programme principal définit une
variable globale qui fait que l'autre thread se termine normalement :
$ ./a.out x
New thread started
cnt = 0
cnt = 1
Thread terminated normally; cnt = 2
Dans la sortie, nous voyons que le gestionnaire de nettoyage n'a pas
été appelé (car
cleanup_pop_arg vaut 0), et la variable
cnt n'a pas été réinitialisée.
Lors de l'exécution suivante, le programme principal définit une
variable globale qui fait que l'autre thread se termine normalement, et
fournit une valeur non-nulle à
cleanup_pop_arg :
$ ./a.out x 1
New thread started
cnt = 0
cnt = 1
Called clean-up handler
Thread terminated normally; cnt = 0
Dans la sortie, nous voyons que bien que le thread n'ait pas été
annulé, le gestionnaire de nettoyage a été appelé, car
l'argument fourni à
pthread_cleanup_pop n'était pas nul.
Source du programme¶
#include <pthread.h>
#include <sys/types.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <errno.h>
#define handle_error_en(en, msg) \
do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
static int done = 0;
static int cleanup_pop_arg = 0;
static int cnt = 0;
static void
cleanup_handler(void *arg)
{
printf("Called clean-up handler\n");
cnt = 0;
}
static void *
thread_start(void *arg)
{
time_t start, curr;
printf("New thread started\n");
pthread_cleanup_push(cleanup_handler, NULL);
curr = start = time(NULL);
while (!done) {
pthread_testcancel(); /* A cancellation point */
if (curr < time(NULL)) {
curr = time(NULL);
printf("cnt = %d\n", cnt); /* A cancellation point */
cnt++;
}
}
pthread_cleanup_pop(cleanup_pop_arg);
return NULL;
}
int
main(int argc, char *argv[])
{
pthread_t thr;
int s;
void *res;
s = pthread_create(&thread, NULL, thread_start, NULL);
if (s != 0)
handle_error_en(s, "pthread_create");
sleep(2); /* Allow new thread to run a while */
if (argc > 1) {
if (argc > 2)
cleanup_pop_arg = atoi(argv[2]);
done = 1;
} else {
printf("Canceling thread\n");
s = pthread_cancel(thr);
if (s != 0)
handle_error_en(s, "pthread_cancel");
}
s = pthread_join(thr, &res);
if (s != 0)
handle_error_en(s, "pthread_join");
if (res == PTHREAD_CANCELED)
printf("Thread was canceled; cnt = %d\n", cnt);
else
printf("Thread terminated normally; cnt = %d\n", cnt);
exit(EXIT_SUCCESS);
}
VOIR AUSSI¶
pthread_cancel(3),
pthread_cleanup_push_defer_np(3),
pthread_setcancelstate(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> ».