fcntl − Manipuler un descripteur de fichier.

#include <unistd.h>
#include <fcntl.h>

int fcntl(int fd, int cmd);
int fcntl(int fd, int cmd, long arg);
int fcntl(int fd, int cmd, struct flock *lock);

fcntl() permet de se livrer à l’une des opérations décrites plus loin sur le descripteur de fichier fd. L’opération est déterminée par la valeur de l’argument cmd.

Dupliquer un descripteur de fichier

F_DUPFD

Trouve le plus petit numéro de descripteur libre supérieur ou égal à arg et le transforme en copie de fd. Ceci est différent de dup(2) qui utilise exactement le descripteur transmis.

En cas de réussite, le nouveau descripteur est renvoyé.

Voir dup(2) pour plus de détails

Attributs du descripteur de fichier

Les commandes suivantes manipulent les attributs associés au descripteur de fichier. Actuellement, un seul attribut est défini : FD_CLOEXEC, l’attribut close-on-exec. Si le bit FD_CLOEXEC est 0, le descripteur de fichier restera ouvert même au travers d’un exec(2), autrement il sera fermé.

F_GETFD

Lire les attributs du descripteur de fichier.

F_SETFD

Positionner les attributs du descripteur de fichier avec la valeur spécifiée par arg.

Attribut d’état du fichier

Chaque description de fichier ouvert dispose de certains attributs d’état, initialisés par open(2) et eventuellement modifiés par fcnt(2). Les descripteurs de fichiers dupliqués (obtenus avec dup(), fcntl(F_DUPFD), fork(), etc.) font référence à la même description de fichier et partagent ainsi les mêmes attributs d’état de fichier.

Les attributs d’état de fichier et leurs sémantiques sont décrits dans la page open(2).

F_GETFL

Renvoie les attributs d’état du fichier.

F_SETFL

Positionne les nouveaux attributs d’état pour le fichier à la valeur indiquée par arg. Les modes d’accès au fichier (O_RDONLY, O_WRONLY, O_RDWR) et les attributs de création du fichier (c’est-à -dire O_CREAT, O_EXCL, O_NOCTTY, O_TRUNC) dans arg sont ignorés. Sous Linux, cette commande ne peut changer que les attributs O_APPEND, O_NONBLOCK, O_ASYNC et O_DIRECT.

Verrouillages coopératifs

F_GETLK, F_SETLK et F_SETLKW servent à gérer les verrouillages d’enregistrements (de segments ou de régions de fichiers). Le troisième argument lock est un pointeur sur une structure qui a au moins les champs suivants (dans un ordre non spécifié).

struct flock {
    ...
    short l_type;    /* Type de verrouillage : F_RDLCK,
                        F_WRLCK, F_UNLCK */
    short l_whence;  /* Interprétation de l_start:
                        SEEK_SET, SEEK_CUR, SEEK_END */
    off_t l_start;   /* Décalage de début du verrouillage */
    off_t l_len;     /* Nombre d’octets du verrouillage */
    pid_t l_pid;     /* PID du processus bloquant notre verrou
                        (F_GETLK seulement) */
    ...
};

Les champs l_whence, l_start, et l_len de cette structure indiquent l’intervalle à verrouiller. l_start est le décalage de début du verrouillage et s’interprète par rapport : au début du fichier (si l_whence vaut SEEK_SET) ; à la position actuelle dans le fichier (si l_whence vaut SEEK_CUR) ; ou la fin du fichier (si l_whence vaut SEEK_END). Dans les deux derniers cas, l_start peut être un nombe négatif, à condition de ne pas indiquer une position avant le début du fichier. l_len est un entier non-négatif (mais voir les NOTES plus bas) indiquant le nombre d’octets à verrouiller. On peut verrouiller des octets après la fin du fichier, mais pas avant son début. Fournir un 0 dans l_len a un sens particulier : verrouiller tous les octets de la position indiquée par l_whence et l_start jusqu’à la fin du fichier, quelque soit sa taille.

Le champ l_type peut servir à placer un verrou en lecture (F_RDLCK) ou en écriture (F_WRLCK) sur un fichier. Un nombre quelconque de processus peuvent tenir un verrou en lecture (partagé), sur une région d’un fichier, mais un seul peut avoir un verrou en écriture (exclusif). Un verrou en écriture exclut tous les autres verrous, aussi bien en lecture qu’en écriture. Un processus donné ne peut tenir qu’un seul verrou sur une région d’un fichier, si un nouveau verrou y est appliqué, alors le verrou précédent est converti suivant le nouveau type. Ceci peut entraîner le découpage, la réduction ou l’extension du verrou existant si le nombre d’octets du nouveau verrou ne coïncide pas exactement avec celui de l’ancien.

F_SETLK

Acquérir (si l_type vaut F_RDLCK ou F_WRLCK) ou libérer (si l_type vaut F_UNLCK) le verrou sur les octets indiqués par les champs l_whence, l_start, et l_len de lock. Si un conflit avec un verrou tenu par un autre processus existe, cet appel renvoie −1 et positionne errno aux valeurs EACCES ou EAGAIN.

F_SETLKW

Comme F_SETLK, mais attend la libération du verrou au lieu de retourner une erreur. Si un signal à intercepter est reçu pendant l’attente, l’appel est interrompu et renverra immédiatement (après retour du gestionnaire de signaux) la valeur −1. errno sera remplie avec la valeur EINTR.

F_GETLK

En entrée dans cette routine, lock décrit un verrou que nous aimerions placer sur le fichier. Si le verrouillage est possible, fcntl() ne le fait pas, mais renvoie F_UNLCK dans le champ l_type de lock et laisse les autres champs de la structure inchangés. Si un ou plusieurs verrouillages incompatibles empêchaient l’action, alors fcntl() renvoie des informations sur l’un de ces verrous dans les champs l_type, l_whence, l_start, et l_len de lock et remplit l_pid avec le PID du processus tenant le verrou.

Pour pouvoir placer un verrou en lecture, fd doit être ouvert au moins en lecture. Pour placer un verrou en écriture, fd doit être ouvert en écriture. Pour placer les deux types de verrous, il faut une ouverture en lecture-écriture.

Outre la suppression par un F_UNLCK explicite, les verrous sont automatiquement libérés lorsque le processus se termine, ou s’il ferme l’un des descripteurs se référant au fichier sur lequel le verrou est placé. C’est dangereux : cela signifie qu’un processus peut perdre un verrou sur un fichier comme /etc/passwd ou /etc/mtab si, pour une raison quelconque, une fonction de bibliothèque décide de l’ouvrir puis de le refermer.

Les verrouillages d’enregistrements ne sont pas hérités par les enfants lors d’un fork(2), mais sont préservés au cours d’un execve(2).

à cause des tampons gérés par la bibliothèque stdio(3), l’utilisation des verrous d’enregistrements avec les routines de celle-ci est déconseillé. Utilisez plutôt read(2) et write(2).

Verrouillage obligatoire

(NON-POSIX) Les verrouillages d’enregistrements ci-dessus peuvent être coopératifs ou impératifs (coopératifs par défaut).

Les verrouillages coopératifs ne fonctionnent qu’entre processus qui les utilisent.

Les verrouillages impératifs fonctionnent avec tous les processus.

Si un processus essaie d’effectuer un accès incompatible (par exemple, read(2) ou write(2)) sur la région d’un fichier qui a un verrouillage impératif incompatible, le résultat dépendra de si l’attribut O_NONBLOCK est activé pour cette description de fichier ouvert. Si l’attribut O_NONBLOCK n’est pas activé, l’appell système bloquera jusqu’à ce que le verrou soit supprimé ou converti dans un mode compatible avec l’accès. Si l’attribut O_NONBLOCK est activé, l’appel système échouera avec l’erreur EAGAIN ou EWOULDBLOCK.

Pour utiliser des verrous impératifs, ce type de verrouillage doit être activé sur le système de fichiers contenant le fichier à verrouiller et sur le fichier lui-même. Le verrouillage impératif est activé sur un système de fichiers en utilisant l’option « −o mand » de mount(8) ou l’attribut MS_MANDLOCK de mount(2). Le verrouillage impératif est activé sur un fichier en désactivant la permission d’exécution du groupe et en activant le bit de permission Set−GID (voir chmod(1) et chmod(2)).

Gestion des signaux

F_GETOWN, F_SETOWN, F_GETSIG et F_SETSIG servent à gérer les signaux de disponibilité d’entrée-sortie :

F_GETOWN

obtient le PID ou l’ID du groupe de processus qui reçoit les signaux SIGIO et SIGURG pour les événements concernant le descripteur de fichier fd. Les PID sont renvoyés sous forme de valeurs positives ; les groupes de processus sont renvoyés sous forme de valeurs négatives (mais voir la section BOGUES plus bas).

F_SETOWN

fixe le PID ou l’ID du groupe de processus qui recevront les signaux SIGIO et SIGURG pour les événements concernant le descripteur fd. Un PID est formulé en tant que valeur positive ; les ID de groupes de processus sont formulés en tant que valeurs négatives. (F_SETSIG peut servir à indiquer un autre signal que SIGIO). Plus communément, le processus appelant se spécifie lui-même comme le propriétaire (c’est-à -dire que arg vaut getpid()).

Si vous fixez l’attribut O_ASYNC sur un descripteur de fichier (soit en utilisant ce drapeau lors de l’appel à open(2), soit en utilisant la commande F_SETFL de fcntl(2)), un signal SIGIO est envoyé dès que l’entrée ou la sortie sont possibles sur ce descripteur. F_SETSIG peut être utilisé pour obtenir la délivrance d’un signal autre que SIGIO. Si cette vérification de permission échoue, le signal est silencieusement abandonné.

L’envoi d’un signal au processus (groupe) propriétaire spécifié par F_SETOWN est sujet aux mêmes vérifications de permissions comme cela est décrit pour kill(2), où le processus envoyant est celui qui utilise F_SETOWN (mais voir BOGUES plus loin).

Si le descripteur de fichier fd fait référence à une socket, F_SETOWN permet également la réception de signaux SIGURG lorsque des données hors-bande arrivent sur la socket. (SIGURG est émis dans toutes les situations où l’appel select(2) aurait indiqué que la socket est dans une « situation exceptionnelle »).

Si une valeur non nulle est fournie à F_SETSIG dans un processus multi-thread en cours d’exécution avec un bibliothèque de threads qui supportent les groupes de threads (par exemple NPTL), alors une valeur positive fournie à F_SETOWN à une signification différente : plutôt que d’être un PID indentifiant un processus entier, c’est un ID de thread identifiant un thread spécifique à l’intérieur d’un processus. Par conséquent, il peut être nécessaire de passer à F_SETOWN le résultat de gettid() plutôt que celui de getpid() pour rendre les résultats sensibles lorsque F_SETSIG est utilisé. (Dans les actuelles implémentations de threads Linux, le TID d’un thread principal est le même que son PID. Cela signifie qu’un programme simple thread peut indifféremment utiliser gettid() ou getpid() dans ce scenario.) Notez toutefois que les instructions dans ce paragraphe ne s’appliquent pas au signal SIGURG généré pour des données hors-bande sur une socket : ce signal est toujours envoyé soit à un processus, soit à un groupe de processus, suivant la valeur donnée à F_SETOWN. Notez également que Linux impose une limite sur le nombre de signaux temps réel qui peuvent être mis en file d’attente dans un processus (voir getrlimit(2) et signal(7)). Si cette limite est atteinte, le noyau revient à la délivrance de SIGIO et ce signal est délivré au processus entier plutôt qu’à un thread spécifique.

F_GETSIG

Renvoie le numéro du signal émis lorsque l’entrée ou la sortie deviennent possibles. Une valeur nulle signifie l’émission de SIGIO. Toute autre valeur (y compris SIGIO) précise le signal émis, et des informations supplémentaires seront disponibles pour le gestionnaire s’il est installé avec SA_SIGINFO.

F_SETSIG

Indique le signal à émettre lorsque l’entrée ou la sortie deviennent possibles. Une valeur nulle signifie l’émission de SIGIO. Toute autre valeur (y compris SIGIO) précise le signal à émettre, et des informations supplémentaires seront disponibles pour le gestionnaire s’il est installé avec SA_SIGINFO.

De plus, passer une valeur non nulle à F_SETSIG modifie la réception du signal d’un processus entier à un thread spécifique du processus. Voir la desciption de F_SETOWN pour plus de détails.

En utilisant F_SETDIG avec une valeur non-nulle, et en configurant SA_SIGINFO pour le gestionnaire (voir sigaction(2)), des informations supplémentaires sur les événements d’entrées-sorties sont fournies au gestionnaire à travers une structure siginfo_t. Si le champ si_code indique que la source est SI_SIGIO, le champ si_fd fournit le descripteur du fichier concerné par l’événement. Sinon il n’y a pas d’indication du descripteur en attente, et il faut utiliser le mécanisme habituel (select(2), poll(2), read(2) avec O_NONBLOCK configuré etc.) pour déterminer quels descripteurs sont disponibles pour les entrées-sorties.

En sélectionnant un signal temps réel (valeur >= SIGRTMIN), de multiples événements d’entrées-sorties peuvent être mémorisés avec le même numéro. Des informations supplémentaires sont disponibles, comme ci-dessus, si SA_SIGINFO est configuré pour le gestionnaire.

En utilisant ces mécanismes, un programme peut implémenter des entrées-sorties totalement asynchrones, la plupart du temps sans avoir besoin d’invoquer select(2) ou poll(2).

L’utilisation de O_ASYNC, F_GETOWN, est spécifique BSD et Linux. F_GETSIG et F_SETSIG sont spécifiques à Linux. POSIX disposent d’entrées-sorties asynchrones et de la structure aio_sigevent pour effectuer la même chose. Ceci est également disponible sous Linux dans la bibliothèque GNU C (Glibc).

Baux

F_SETLEASE et F_GETLEASE (depuis Linux 2.4) servent respectivement à établir et consulter le paramétrage du bail dont le processus appelant dispose sur le fichier indiqué par fd. (Ndt : je traduis « lease » par « bail », faute de terme plus technique.) Le bail sur un fichier fournit un mécanisme par lequel un processus détenteur du bail est averti (par délivrance d’un signal) lorsqu’un processus (le « casseur de bail ») essaye d’appeler open(2) ou truncate(2) sur ce fichier.

F_SETLEASE

Fixe ou supprime un bail de fichier en fonction de la valeur fournie dans l’entier arg :

F_RDLCK

Prendre un bail en lecture. Le processus appelant sera prévenu lorsque le fichier sera ouvert en écriture ou tronqué. Un bail en lecture ne peut être placé sur un descripteur de fichier que s’il est ouvert en lecture seule.

F_WRLCK

Prendre un bail en écriture. Le processus appelant sera prévenu lorsque le fichier sera ouvert en écriture ou tronqué. Un bail en écriture ne peut être pris sur le fichier que si aucun autre processus ne l’a actuellement ouvert.

F_UNLCK

Supprimer le bail sur un fichier.

Un processus ne peut prendre qu’un seul type de bail sur un fichier.

Les baux ne peuvent être pris que sur des fichiers normaux. Un processus non-privilégié ne peut prendre un bail que sur un fichier dont l’UID correspond au FS-UID du processus. Un processus possédant la capacité CAP_LEASE peut prendre un bail sur n’importe quel fichier.

F_GETLEASE

Indique le type de bail possédé sur le fichier indiqué par fd en renvoyant F_RDLCK, F_WRLCK, ou F_UNLCK, pour signifiquer respectivement que le processus appelant a un bail en lecture, écriture, ou pas de bail sur le fichier. (Le troisième argument de fcntl(2) est omis).

Lorsqu’un processus (le « casseur de bail » appelle open(2) ou truncate(2) en conflit avec un bail établi par F_SETLEASE, l’appel système est bloqué par le noyau et le noyau avertit le processus tenant le bail par l’envoi d’un signal (SIGIO par défaut). Le tenant du bail doit répondre à ce signal en effectuant tout le nettoyage nécessaire pour que le fichier soit accessible par un autre processus (p.ex. en vidant des tampons internes) et en supprimant ou déclassant son bail. Un bail est supprimé en appelant la commande F_SETLEASE avec arg valant F_UNLCK. Si on tient un bail en écriture sur le fichier et que le casseur de bail ouvre le fichier en lecture, cela est suffisant pour déclasser le bail en un bail en lecture. Cela est effectué en appelant la commande F_SETLEASE avec arg valant F_RDLCK.

Si le détenteur du bail n’arrive pas à le déclasser ou le supprimer avant le nombre de secondes indiqué dans /proc/sys/fs/lease-break-time alors le noyau supprimera ou déclassera de force le bail du processus qui le tient.

Dès que le bail a été, de gré ou de force, résilié ou déclassé et en supposant que le casseur de bail n’a pas débloqué son appel système, le noyau permet à ce dernier de se dérouler.

Si un appel open() ou truncate() bloqué, effectué par le casseur de bail, est interrompu par un gestionnaire de signal, l’appel système échoue avec l’erreur EINTR, mais les autres étapes se dérouleront comme décrit plus haut. Si le casseur de bail est tué par un signal alors qu’il est bloqué dans open() ou truncate(), les autres étapes se dérouleront comme décrit plus haut. Si le casseur de bail spécifie l’attribut O_NONBLOCK lorsqu’il appelle open(), l’appel échouera immédiatemment avec l’erreur EWOULDBLOCK, mais les autres étapes se dérouleront comme décrit plus haut.

Le signal de notification par défaut pour le tenant du bail est SIGIO, mais on peut le modifier avec la commande F_SETSIG de la fonction fcntl (). Si une commande F_SETSIG est réalisée (même pour SIGIO), et si le gestionnaire de signal est installé avec SA_SIGINFO, alors il recevra une structure siginfo_t en second argument, et le champ si_fd contiendra le descripteur de fichier du bail où il y a eu une tentative d’accès par un autre processus. (Ceci sert si le processus tient des bails sur plusieurs fichiers.)

Notification de modification de fichier et de répertoire (dnotify)

F_NOTIFY

(Nouveauté Linux 2.4) Fournit un avertissement lorsque le répertoire correspondant à fd ou l’un des fichiers qu’il contient est modifié. Les événements à notifier sont précisés dans arg, sous forme de masque regroupant par un OU binaire zéro, une ou plusieurs des constantes suivantes :

ERREURS

NOTES

BOGUES

CONFORMITÃ

VOIR AUSSI

TRADUCTION

fcntl(2)