flock − Placer ou enlever un verrou coopératif sur un fichier ouvert.

#include <sys/file.h>

int flock(int fd, int operation);

Place ou enlève un verrou consultatif sur un fichier ouvert dont le descripteur est fd. Le paramètre operation est l’un des suivants :

LOCK_SH

Verrouillage partagé. Plusieurs processus peuvent disposer d’un verrouillage partagé simultanément sur un même fichier.

LOCK_EX

Verrouillage exclusif. Un seul processus dispose d’un verrouillage exclusif sur un fichier, à un moment donné.

LOCK_UN

Déverrouillage d’un verrou tenu par le processus.

Un appel flock() peut bloquer si un verrou incompatible est tenu par un autre processus. Pour que la requête soit non-bloquante, il faut inclure LOCK_NB (par un OU binaire « | » ) avec la constante précisant l’opération.

Un même fichier ne peut pas avoir simultanément des verrous partagés et exclusifs.

Les verrous créés avec flock() sont associés à une entrée de la table des fichiers ouverts. Ainsi, les descripteurs de fichiers dupliqués (par exemple avec fork(2) ou dup(2)) se réfèrent au même verrou, et celui-ci peut être relâché ou modifié à travers n’importe lequel des descripteurs. De plus, un verrou est relâché par une opération explicite LOCK_UN sur l’un quelconque des descripteurs, ou lorsqu’ils ont tous été fermés.

Si un processus utilise open(2) (ou une fonction similaire) pour obtenir plus d’un descripteur pour le même fichier, ces descripteurs sont traités de manière indépendante par flock(). Une tentative de verrouillage du fichier en utilisant un de ces descripteurs de fichiers peut être refusée par un verrou qui aurait déjà été posé par le processus appelant via un autre descripteur.

Un processus ne peut avoir qu’un seul type de verrou (partagé ou exclusif) sur un fichier. En conséquence, un appel flock() sur un fichier déjà verrouillé modifiera le type de verrouillage.

Les verrous créés par flock() sont conservé lors d’un appel execve().

Un verrou partagé ou exclusif peut être placé sur un fichier quelque soit le mode d’ouverture du fichier.

flock() renvoie 0 s’il réussit, ou −1 en cas d’échec, auquel cas errno contient le code d’erreur.

EBADF

fd n’est pas un descripteur de fichier ouvert.

EINTR

Durant l’attente pour acquérir le verrou, l’appel a été interrompu par un signal capturé par un gestionnaire.

EINVAL

operation est invalide.

ENOLCK

Le noyau n’a pas assez de mémoire pour les allocations de verrou.

EWOULDBLOCK

Le fichier est verrouillé et l’attribut LOCK_NB a été précisé.

4.4BSD (l’appel système flock(2) est apparu pour la première fois dans 4.2BSD). Une version de flock(2) parfois implémenté à partir de fcntl(2), est apparue sur la plupart des Unix.

flock(2) ne verrouille par les fichiers à travers NFS. Utilisez fcntl(2) à la place : il fonctionne avec NFS si la version de Linux est suffisamment récente et si le serveur accepte les verrouillages.

Depuis le noyau 2.0, flock(2) est implémenté par un appel système plutôt que d’être émulé par une routine de la bibliothèque C invoquant fcntl(2). Ceci correspond à la véritable sémantique BSD : il n’y a pas d’interaction entre les verrous placés flock(2) et fcntl(2), et flock(2) ne détecte pas les cas de blocage (deadlock).

flock(2) place uniquement des verrous coopératifs : suivant les permissions du fichier un processus peut ignorer l’utilisation de flock(2) et faire des entrées-sorties sur le fichier.

flock(2) et fcntl(2) ont des sémantiques différents par rapport aux processus « forkés » et dup(2). Sur les systèmes qui implémentent flock() en utilisant fcntl(), la sémantique de flock() peut être différente que celle décrite dans cette page de manuel.

Il n’est pas garanti que la conversion d’un verrou (de partagé à exclusif ou vice versa) soit atomique : le verrou existant est d’abord retiré, puis un nouveau verrou est établi. Entre ces deux étapes, une demande en suspend de verrouillage par un autre processus peut être accordée, avec pour résultat que la conversion soit bloque, soit échoue si LOCK_NB a été spécifié. (C’est le comportement original BSD que l’on retrouve sur beaucoup d’autres implémentations.)

close(2), dup(2), execve(2), fcntl(2), fork(2), open(2), lockf(3)

On peut également se reporter aux fichiers locks.txt et mandatory.txt dans le répertoire /usr/src/linux/Documentation.

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 21 janvier 1997 et révisée le 9 août 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 2 flock ». N’hésitez pas à signaler à l’auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.