FUTEX(2)

NOM
futex - Mécanisme de verrouillage rapide en mode utilisateur

SYNOPSIS

#include <linux/futex.h>
#include <sys/time.h>

int futex(int *uaddr, int op, int val, const struct timespec *timeout,
          int *uaddr2, int val3);

DESCRIPTION

L'appel système futex() donne à un programme la possibilité d'attendre qu'une valeur à une adresse donnée change, ou de réveiller tous ceux qui sont en attente sur cette adresse. Bien que les adresses soient différentes dans des processus séparés, le noyau fera la correspondance lors de l'appel système. Ceci est typiquement employé pour implémenter les verrous en mémoire partagée, tels qu'ils sont décrits dans futex(7).

Quand une opération futex(7) ne se termine pas de manière satisfaisante dans l'espace utilisateur, un appel au noyau est nécessaire pour l'arbitrage. Ceci signifie soit endormir le processus appelant, soit réveiller le processus en attente.

Les appelants de cette fonction doivent accepter les sémantiques décrites dans futex(7). Comme celles-ci impliquent l'écriture d'instructions non portables en assembleur, leurs utilisateurs sont des auteurs de bibliothèques plus que des développeurs applicatifs.

L'argument uaddr doit pointer sur un entier aligné qui stocke le compteur. L'opération à exécuter est transmise dans le paramètre op, avec la valeur val.

Cinq opérations sont définies pour le moment :

FUTEX_WAIT
    Cette opération vérifie que l'adresse du futex uaddr contient toujours la valeur val indiquée et s'endort en attendant un FUTEX_WAKE à cette adresse. Les deux étapes sont liées atomiquement. Si l'argument timeout est non nul, il contient la durée maximale de sommeil. Sinon elle est infinie. Les arguments uaddr2 et val3 sont ignorés. D'après futex(7), cet appel est exécuté si la décrémentation du compteur donne une valeur négative (indiquant un conflit) et le sommeil durera jusqu'à ce qu'un autre processus relâche le futex et exécute FUTEX_WAKE.

FUTEX_WAKE
    Cette opération réveille au plus val processus en attente sur l'adresse du futex (endormis dans FUTEX_WAIT). Les arguments timeout, uaddr2 et val3 sont ignorés. D'après futex(7), ceci est exécuté si l'incrémentation du compteur montre qu'il y a des processus en attente, une fois que la valeur du futex a été mise à 1 (indiquant qu'il est disponible).

FUTEX_FD (Présent depuis Linux 2.6.25)
    Pour permettre des réveils asynchrones, cette opération associe un descripteur de fichier avec un futex. Si un autre processus exécute un FUTEX_WAKE, l'appelant recevra le signal dont le numéro a été indiqué dans val. L'appelant doit refermer le descripteur de fichier après utilisation. Les arguments timeout, uaddr2 et val3 sont ignorés. Pour éviter les situations de concurrence, l'appelant doit tester si le futex a été libéré après le retour de FUTEX_FD. Parce que cette situation de concurrence était héritée, FUTEX_FD a été supprimé dans Linux 2.6.26. les applications qui l'utilisent doivent à présent être corrigées.

FUTEX_REQUEUE (depuis Linux 2.5.70)
    Cette opération a été introduite dans le but d'éviter que trop de processus nécessitant un autre futex ne soient activés lors de l'utilisation de FUTEX_WAKE. Cet appel réactive val processus, et remet en file d'attente tous les autres qui attendaient le futex à l'adresse uaddr2. Les arguments timeout et val3 sont ignorés.

FUTEX_CMP_REQUEUE (depuis Linux 2.6.7)
    Il y a eu un problème de concurrence dans l'utilisation de FUTEX_REQUEUE, aussi FUTEX_CMP_REQUEUE a été introduit. Cette opération est similaire à FUTEX_REQUEUE, sauf qu'elle vérifie si l'adresse uaddr contient encore la valeur val3. Si non, l'opération échoue avec l'erreur EAGAIN. L'argument timeout est ignoré.

VALEUR RENVOYÉE

Suivant l'opération exécutée, la valeur renvoyée pour un appel réussi peut avoir différentes significations.

FUTEX_WAIT
    Renvoie 0 si le processus a été réveillé par un FUTEX_WAKE. En cas de dépassement de délai, l'opération échoue avec l'erreur ETIMEDOUT. Si le futex n'avait pas la valeur attendue, l'appel échoue avec l'erreur EWOULDBLOCK. L'arrivée d'un signal (voir signal(7))ouautresfauxréveils fait échouer FUTEX_WAIT avec l'erreur EINTR.

FUTEX_WAKE
    Renvoie le nombre de processus réveillés.

FUTEX_FD
    Renvoie le nouveau descripteur associé au futex.

FUTEX_REQUEUE
    Renvoie le nombre de processus réveillés.

FUTEX_CMP_REQUEUE
    Renvoie le nombre de processus réveillés.

En cas d'erreur, toutes les opérations renvoient -1 et renseignent errno en conséquence.

ERREURS

EACCES
    Pas d'accès en lecture à la mémoire futex.

EAGAIN
    FUTEX_CMP_REQUEUE a trouvé une valeur futex inattendue. (Cela indique probablement une condition de concurrence ; utilisez maintenant FUTEX_WAKE.)

EFAULT
    Erreur lors de la récupération de l'information timeout à partir de l'espace utilisateur.

EINVAL
    Une opération n'a pas été définie ou il y a une erreur d'alignement de page.

ENFILE
    La limite du nombre total de fichiers ouverts sur le système a été atteinte.

ENOSYS
    Une opération invalide était spécifiée dans op.

VERSIONS

Le support initial des futex a été ajouté dans Linux 2.5.7 mais avec une sémantique différente de celle décrite ci-dessus. Un appel système à 4 paramètres avec la sémantique décrite ici est disponible depuis Linux 2.5.40. Un paramètre supplémentaire a été ajouté dans Linux 2.5.70. Dans Linux 2.6.7, un sixième paramètre a été ajouté — déguelasse, particulièrement pour l'architecture s390.

CONFORMITÉ
Cet appel système est spécifique à Linux.

NOTES

Répétons-le, les futex de base ne sont pas conçus comme une abstraction facile à employer pour les utilisateurs. Les implémenteurs doivent maîtriser l'assembleur et avoir lu les sources de la bibliothèque en espace utilisateur décrite plus bas.

VOIR AUSSI
futex(7)

« Fuss, Futexes and Furwocks: Fast Userlevel Locking in Linux » (proceedings of the Ottawa Linux Symposium 2002), bibliothèque d'exemple de futex futex-*.tar.bz2 <URL:ftp://ftp.nl.kernel.org/pub/linux/kernel/people/rusty/>.

TRADUCTION

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 18 juillet 2003 et révisée le 17 juillet 2008.

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=C man 2 futex ». N'hésitez pas à signaler à l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.