sem_wait − Verrouiller un sémaphore.

#include <semaphore.h>

int sem_wait(sem_t *sem);
int sem_trywait(sem_t *sem);

#define _XOPEN_SOURCE 600
#include <semaphore.h>

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

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 pour 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(), exepté 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(), exepté 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) 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.

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.

EINTR

L’appel a été interrompu par un gestionnaire de signaux.

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 plus grande ou égale à 1000 millions.

ETIMEDOUT

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

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

POSIX.1-2001.

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 efectue un sem_post() pour incrémenter le sémaphore qui est attendu dans le main() en utilisant sem_timedwait(). Le second argument de la ligne de commandee 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_getvalue() from handler; value = 1
sem_timedwait() succeeded
$ ./a.out 2 1
About to call sem_timedwait()
sem_timedwait() timed out

Le code source du programme est le suivant :

#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <semaphore.h>
#include <time.h>
#include <assert.h>
#include <errno.h>
#include <signal.h>

#define die(msg) { perror(msg); exit(EXIT_FAILURE); }

sem_t sem;

static void
handler(int sig)
{
    int sval;

   printf("sem_post() from handler\n");
    if (sem_post(&sem) == -1) die("sem_post");

   if (sem_getvalue(&sem, &sval) == -1) die("sem_getvalue");
    printf("sem_getvalue() from handler; value = %d\n", sval);
} /* handler */

int
main(int argc, char *argv[])
{
    struct sigaction sa;
    struct timespec ts;
    int s;

   assert(argc == 3);  /* Usage: ./a.out alarm-secs wait-secs */

   if (sem_init(&sem, 0, 0) == -1) die("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) die("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)
        die("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 when interrupted by handler */

   /* Check what happened */

   if (s == -1) {
        if (errno == ETIMEDOUT)
            printf("sem_timedwait() timed out\n");
        else
            die("sem_timedwait");
    } else
        printf("sem_timedwait() succeeded\n");

   exit(EXIT_SUCCESS);
}

sem_getvalue(3), sem_post(3), sem_overview(7)

Ce document est une traduction réalisée par Alain Portal <aportal AT univ-montp2 DOT fr> le 29 juillet 2006.

L’équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=en man 3 sem_wait ». N’hésitez pas à signaler à l’auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.