SEM_WAIT(3)

NOM
sem_wait, sem_timedwait, sem_trywait - Verrouiller un sémaphore

SYNOPSIS
#include <semaphore.h>

int sem_wait(sem_t *sem);

int sem_trywait(sem_t *sem);

int sem_timedwait(sem_t *sem, const struct timespec *abs_timeout);

Effectuez l'édition des liens avec l'option -pthread.

Exigences de macros de test de fonctionnalités pour la glibc (consultez feature_test_macros(7)) :

sem_timedwait() : _POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600

DESCRIPTION
sem_wait() décrémente (verrouille) le sémaphore pointé par sem. Si la valeur du sémaphore est plus grande que 0, la décrémentation s'effectue et la fonction revient immédiatement. Si le sémaphore vaut zéro, l'appel bloquera jusqu'à ce que soit il devienne disponible d'effectuer la décrémentation (c'est-à-dire la valeur du sémaphore n'est plus nulle), soit un gestionnaire de signaux interrompe l'appel. sem_trywait() est pareil que sem_wait(), excepté que si la décrémentation ne peut pas être effectuée immédiatement, l'appel renvoie une erreur (errno vaut EAGAIN) plutôt que bloquer. sem_timedwait() est pareil que sem_wait(), excepté que abs_timeout spécifie une limite sur le temps pendant lequel l'appel bloquera si la décrémentation ne peut pas être effectuée immédiatement. L'argument abs_timeout pointe sur une structure qui spécifie un temps absolu en secondes et nanosecondes depuis l'époque, 1er janvier 1970 à 00:00:00 (UTC). Cette structure est définie de la manière suivante :
struct timespec {
    time_t tv_sec;      /* Secondes */
    long   tv_nsec;     /* Nanosecondes [0 .. 999999999] */
};

Si le délai est déjà expiré à l'heure de l'appel et si le sémaphore ne peut pas être verrouillé immédiatement, sem_timedwait() échoue avec l'erreur d'expiration de délai (errno vaut ETIMEDOUT). Si l'opération peut être effectuée immédiatement, sem_timedwait() n'échoue jamais avec une valeur d'expiration de délai, quelque soit la valeur de abs_timeout. De plus, la validité de abs_timeout n'est pas vérifiée dans ce cas.

VALEUR RENVOYÉE
Toutes ces fonctions renvoient 0 si elles réussissent. Si elles échouent, la valeur du sémaphore n'est pas modifiée, elles renvoient -1 et écrivent errno en conséquence.

ERREURS

EINTR
    L'appel a été interrompu par un gestionnaire de signal ; consultez signal(7).

EINVAL
    sem n'est pas un sémaphore valide.

L'erreur supplémentaire suivante peut survenir pour sem_trywait() :

EAGAIN
    L'opération ne peut pas être effectuée sans bloquer (c'est-à-dire, le sémaphore a une valeur nulle).

Les erreurs supplémentaires suivantes peuvent survenir pour sem_timedwait() :

EINVAL
    La valeur de abs_timeout.tv_nsecs est plus petite que 0 ou supérieure ou égale à 1 milliard.

ETIMEDOUT
    Le délai a expiré avant que le sémaphore ait pu être verrouillé.

ATTRIBUTS

  Multithreading (voir pthreads(7))
Les fonctions sem_wait(), sem_trywait() et sem_timedwait() sont sûres dans un contexte multithread.

CONFORMITÉ
POSIX.1-2001.

NOTES
Un gestionnaire de signaux interrompra toujours un appel bloqué à l'une de ces fonctions, quelque soit l'utilisation de l'attribut SA_RESTART de sigaction(2).

EXEMPLE

Le (quelque peu trivial) programme suivant opère sur un sémaphore non nommé. Il attend deux arguments sur la ligne de commande. Le premier argument spécifie une valeur en secondes qui est utilisée pour configurer une alarme pour générer un signal SIGALRM. Ce gestionnaire effectue un sem_post(3) pour incrémenter le sémaphore qui est attendu dans le main() en utilisant sem_timedwait(). Le second argument de la ligne de commande spécifie la durée, en secondes, du délai d'attente pour sem_timedwait(). Ci-dessous, le résultat de deux exécutions différentes du programme :
$ ./a.out 2 3
About to call sem_timedwait()
sem_post() from handler
sem_timedwait() succeeded
$ ./a.out 2 1
About to call sem_timedwait()
sem_timedwait() timed out

  Source du programme
#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <semaphore.h>
#include <time.h>
#include <assert.h>
#include <errno.h>
#include <signal.h>
sem_t sem;
#define handle_error(msg) \
    do { perror(msg); exit(EXIT_FAILURE); } while (0)
static void
handler(int sig)
{
    write(STDOUT_FILENO, "sem_post() from handler\n", 24);
    if (sem_post(&sem) == -1) {
        write(STDERR_FILENO, "sem_post() failed\n", 18);
        _exit(EXIT_FAILURE);
    }
}
int
main(int argc, char *argv[])
{
    struct sigaction sa;
    struct timespec ts;
    int s;
    if (argc != 3) {
        fprintf(stderr, "Usage: %s <alarm-secs> <wait-secs>\n",
                argv[0]);
        exit(EXIT_FAILURE);
    }
    if (sem_init(&sem, 0, 0) == -1)
        handle_error("sem_init");
    /* Establish SIGALRM handler; set alarm timer using argv[1] */
    sa.sa_handler = handler;
    sigemptyset(&sa.sa_mask);
    sa.sa_flags = 0;
    if (sigaction(SIGALRM, &sa, NULL) == -1)
        handle_error("sigaction");
    alarm(atoi(argv[1]));
    /* Calculate relative interval as current time plus
       number of seconds given argv[2] */
    if (clock_gettime(CLOCK_REALTIME, &ts) == -1)
        handle_error("clock_gettime");
    ts.tv_sec += atoi(argv[2]);
    printf("main() about to call sem_timedwait()\n");
    while ((s = sem_timedwait(&sem, &ts)) == -1 && errno == EINTR)
        continue;       /* Restart if interrupted by handler */
    /* Check what happened */
    if (s == -1) {
        if (errno == ETIMEDOUT)
            printf("sem_timedwait() timed out\n");
        else
            perror("sem_timedwait");
    } else
        printf("sem_timedwait() succeeded\n");
    exit((s == 0) ? EXIT_SUCCESS : EXIT_FAILURE);
}

VOIR AUSSI
clock_gettime(2), sem_getvalue(3), sem_post(3), sem_overview(7), time(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/>.

Alain Portal <http://manpagesfr.free.fr/> (2006). Nicolas François et l'équipe francophone de traduction de Debian (2006-2009).

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> ».