FLOCKFILE(3)

NOM
flockfile, ftrylockfile, funlockfile - Verrouiller un flux FILE pour stdio

SYNOPSIS
#include <stdio.h>

void flockfile(FILE *filehandle);
int ftrylockfile(FILE *filehandle);
void funlockfile(FILE *filehandle);

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

Pour toutes les fonctions décrites ci-dessus : _POSIX_C_SOURCE || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE

DESCRIPTION
Les fonctions stdio peuvent être utilisées dans un contexte multithreads. Ceci est réalisé en affectant à chaque objet de type FILE un « compteur de verrouillage » et (si le « compteur de verrouillage » est non nul) un thread propriétaire. Lors de chaque appel à la bibliothèque stdio, ces fonctions attendent jusqu'à ce que l'objet FILE ne soit plus verrouillé par un thread différent, puis elles le verrouillent, réalisent les entrées-sorties demandées, et libèrent l'objet.

(Remarque : ce verrouillage n'a rien à voir avec le verrouillage de fichier réalisé par des fonctions comme flock(2) et lockf(3).)

Tout ceci est invisible au programmeur en C, mais il existe deux raisons de souhaiter un contrôle plus fin. D'une part, un thread peut réaliser une série d'entrées-sorties interdépendantes, ces opérations ne devant pas être interrompues par les entrées-sorties d'autres threads. D'autre part, on peut désirer supprimer la surcharge induite par ce verrouillage afin d'obtenir de meilleures performances.

À cette fin, un thread peut verrouiller explicitement un objet de type FILE, puis réaliser sa série d'entrées-sorties, et enfin, relâcher le verrou. Cela empêche les autres threads d'intervenir sur le flux entre-temps. Si la motivation du verrouillage est la recherche de meilleures performances, on peut réaliser l'entrée-sortie à l'aide des versions non bloquantes des fonctions stdio : avec getc_unlocked(3) et putc_unlocked(3) au lieu de getc(3) et putc(3).

La fonction flockfile() attend jusqu'à ce que *filehandle ne soit plus verrouillé par un autre thread, puis affecte *filehandle au thread actuel, et incrémente le compteur.

La fonction funlockfile() décrémente le « compteur de verrouillage ».

La fonction ftrylockfile() est une version non bloquante de flockfile(). Elle ne fait rien lorsqu'un autre thread détient *filehandle, sinon, elle se l'approprie et incrémente le « compteur de verrouillage ».

VALEUR RENVOYÉE
La fonction ftrylockfile() renvoie zéro en cas de succès (le verrou a été obtenu), et une valeur non nulle en cas d'échec.

ERREURS
Aucune.

CONFORMITÉ
POSIX.1-2001.

DISPONIBILITÉ
Ces fonctions sont disponibles lorsque _POSIX_THREAD_SAFE_FUNCTIONS est définie. Elles sont présentes dans la libc depuis la version 5.1.1 et dans la glibc depuis la version 2.0.

VOIR AUSSI
unlocked_stdio(3)

TRADUCTION

Ce document est une traduction réalisée par Stéphan Rafin <stephan DOT rafin AT laposte DOT net> le 22 avril 2002 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 3 flockfile ». N'hésitez pas à signaler à l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.