PTHREAD_SETNAME_NP(3)

NOM
pthread_setname_np, pthread_getname_np - Définir ou obtenir le nom d'un thread

SYNOPSIS
#define _GNU_SOURCE             /* Consultez feature_test_macros(7) */
#include <pthread.h>
int pthread_setname_np(pthread_t thread, const char *name);
int pthread_getname_np(pthread_t thread,
                       char *name, size_t len);

Compilez et effectuez l'édition des liens avec l'option -pthread.

DESCRIPTION
Par défaut, tous les threads créés par pthread_create() héritent du nom de programme. La fonction pthread_setname_np() permet d'affecter un nom propre à un thread, ce qui peut être utile pour déboguer une application multithread. Le nom du thread est une chaîne de langage C significative, dont la longueur ne peut dépasser 16 caractères, caractère nul final ('\0') inclus. L'argument thread indique le thread dont le nom doit être changé ; le nouveau nom est précisé dans name. La fonction pthread_getname_np() permet de récupérer le nom du thread. L'argument thread indique le thread dont le nom doit être récupéré. Le tampon name est utilisé pour renvoyer le nom du thread ; len indique le nombre d'octets disponibles dans name. La longueur du tampon indiqué dans name doit être d'au moins 16 caractères. Le nom du thread renvoyé dans le tampon de retour est terminé par caractère nul.

VALEUR RENVOYÉE
En cas de réussite, ces fonctions renvoient 0 ; en cas d'erreur elles renvoient un numéro d'erreur non nul.

ERREURS
La fonction pthread_setname_np() peut échouer avec l'erreur suivante :

ERANGE
    La longueur de la chaîne vers laquelle pointe name dépasse la limite autorisée.

La fonction pthread_getname_np() peut échouer avec l'erreur suivante :

ERANGE
    Le tampon indiqué par name et len a une taille insuffisante pour contenir le nom du thread.

Si l'une de ces fonctions ne parvient pas à ouvrir /proc/self/task/[tid]/comm, alors l'appel peut échouer en retournant l'une des erreurs décrites dans open(2)

VERSIONS
Ces fonctions ont été introduites dans la glibc dans sa version 2.12.

CONFORMITÉ
Ces fonctions sont des extension GNU non standard.

NOTES
pthread_setname_np() écrit en interne dans le fichier comm du thread (dans le système de fichiers /proc) : /proc/self/task/[tid]/comm. pthread_getname_np() récupère le nom du thread à ce même endroit.

EXEMPLE

Le programme ci-dessous illustre l'utilisation de pthread_setname_np() et de pthread_getname_np(). La session d'interpréteur de commande ci-dessous montre l'exécution du programme :
$ ./a.out
Thread créé. Le nom par défaut est : a.out
Le nom du thread après nommage est THREADFOO.
^Z                           # Suspendre l'exécution du programme
[1]+  Stoppé            ./a.out
$ ps H -C a.out -o 'pid tid cmd comm'
  PID   TID CMD                         COMMAND
 5990  5990 ./a.out                     a.out
 5990  5991 ./a.out                     THREADFOO
$ cat /proc/5990/task/5990/comm
a.out
$ cat /proc/5990/task/5991/comm
THREADFOO

  Source du programme
#define _GNU_SOURCE
#include <pthread.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <stdlib.h>
#define NAMELEN 16
#define errExitEN(en, msg) \
            do { errno = en; perror(msg); exit(EXIT_FAILURE); \
        } while (0)
static void *
threadfunc(void *parm)
{
    sleep(5);          // permet au programme principal de définir
                       // le nom du thread
    return NULL;
}
int
main(int argc, char **argv)
{
    pthread_t thread;
    int rc;
    char thread_name[NAMELEN];
    rc = pthread_create(&thread, NULL, threadfunc, NULL);
    if (rc != 0)
        errExitEN(rc, "pthread_create");
    rc = pthread_getname_np(thread, thread_name, NAMELEN);
    if (rc != 0)
        errExitEN(rc, "pthread_getname_np");
    printf("Thread créé. Le nom par défaut est : %s\n", thread_name);
    rc = pthread_setname_np(thread, (argc > 1) ? argv[1] : "THREADFOO");
    if (rc != 0)
        errExitEN(rc, "pthread_setname_np");
    sleep(2);
    rc = pthread_getname_np(thread, thread_name,
                            (argc > 2) ? atoi(argv[1]) : NAMELEN);
    if (rc != 0)
        errExitEN(rc, "pthread_getname_np");
    printf("Le nom du thread après nommage est %s.\n", thread_name);
    rc = pthread_join(thread, NULL);
    if (rc != 0)
        errExitEN(rc, "pthread_join");
    printf("Terminé\n");
    exit(EXIT_SUCCESS);
}

VOIR AUSSI
prctl(2), pthread_create(3), pthreads(7)

COLOPHON
Cette page fait partie de la publication 3.70 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/>.

Veuillez signaler toute erreur de traduction en écrivant à <perkamon-fr@traduc.org>.

Vous pouvez toujours avoir accès à la version anglaise de ce document en utilisant la commande « LC_ALL=C man <section> <page_de_man> ».