flock(2)

NAZWA
flock - zakłada lub zdejmuje doradczą blokadę na otwartym pliku.

BIBLIOTEKA
Standardowa biblioteka C (libc, -lc)

SKŁADNIA
#include <sys/file.h>

int flock(int fd, int op);

OPIS
Zakłada lub zdejmuje doradczą blokadę na otwartym pliku, określonym przez fd. Parametr op jest jednym z poniższych:

    LOCK_SH
        Zakłada blokadę współdzieloną. W danej chwili, na danym pliku, może ją utrzymywać więcej niż jeden proces.

    LOCK_EX
        Zakłada blokadę wyłączną. Tylko jeden proces może ją utrzymywać na danym pliku w danej chwili.

    LOCK_UN
        Usuwa istniejącą blokadę, założoną przez bieżący proces.

Wywołanie flock() może się zblokować, gdy inny proces utrzymuje blokadę niezgodnego typu. Aby uzyskać wywołanie nieblokujące, należy dodać LOCK_NB (za pomocą sumy — OR) do dowolnej z powyższych operacji.

Pojedynczy plik nie może mieć jednocześnie założonej blokady współdzielonej i wyłącznej.

Blokady utworzone za pomocą flock() są skojarzone z plikiem lub - dokładniej - z wpisem w tablicy otwartych plików. Oznacza to, że powielone deskryptory plików (utworzone na przykład za pomocą fork(2) lub dup(2)) odnoszą się do tej samej blokady i ta blokada może być zmieniana lub zwalniana za pomocą dowolnego ze wspomnianych deskryptorów. Ponadto, blokada zostaje zwolniona albo w wyniku jawnego wykonania operacji LOCK_UN na dowolnym z tych powielonych deskryptorów, albo po zamknięciu wszystkich tych deskryptorów.

Jeśli proces używa open(2) (lub podobnego) do pozyskania więcej niż jednego deskryptora dla samego pliku, to flock() potraktuje te deskryptory niezależnie. Jakakolwiek próba zablokowania pliku używającego jednego z tych deskryptorów może być odrzucona przez blokadę założoną na innym z tych deskryptorów przez proces wywołujący.

Proces może trzymać tylko jeden typ blokady (współdzieloną lub wyłączną) na danym pliku. Kolejne wywołania flock() na już zablokowanym pliku skonwertują istniejącą blokadę na inny typ.

Blokady utworzone przez flock() są zachowywane przez wywołania execve(2).

Blokada współdzielona lub wyłączna może zostać założona na pliku niezależnie od trybu otwarcia tego pliku.

WARTOŚĆ ZWRACANA
Po pomyślnym zakończeniu zwracane jest zero. Po błędzie zwracane jest -1 i ustawiane errno, wskazując błąd.

BŁĘDY

EBADF
    fd nie jest deskryptorem otwartego pliku.

EINTR
    Wywołanie zostało przerwane, podczas oczekiwania na założenie blokady, w wyniku doręczenia i przechwycenia sygnału przez procedurę jego obsługi; patrz signal(7).

EINVAL
    op jest niepoprawne.

ENOLCK
    Zabrakło pamięci dla jądra na przydzielenie rekordów dla blokad.

EWOULDBLOCK
    Plik jest zablokowany, a był ustawiony znacznik LOCK_NB.

WERSJE
Począwszy od Linuksa 2.0, flock() jest zaimplementowane jako samodzielna funkcja systemowa, a nie jako emulacja w bibliotece GNU C za pomocą wywołania fcntl(2). Daje to prawdziwą semantykę BSD: nie ma interakcji pomiędzy blokadami różnych typów, tworzonymi za pomocą flock() oraz tworzonymi za pomocą fcntl(2), ponadto flock() nie wykrywa zakleszczenia blokad. (Należy jednak zauważyć, że na niektórych systemach, takich jak nowoczesne BSD, blokady flock() i fcntl(2) wchodzą z sobą w interakcje).

  Detale CIFS
Do Linuksa 5.4, flock() nie działało poprzez SMB. Plik z tego typu blokadami nie wyglądał na zablokowany dla klientów zdalnych.

Od Linuksa 5.5, blokady flock() są emulowane za pomocą blokad zakresu bajtów SMB na całym pliku. Podobnie jak w NFS oznacza to, że blokady fcntl(2) i flock() wchodzą ze sobą w interakcję. Kolejnym ważnym skutkiem ubocznym jest to, że blokady nie są wówczas doradcze, każde wejście/wyjście na zablokowanym pliku zawsze zawiedzie z błędem EACCES, gdy zostanie dokonane z oddzielnego deskryptora pliku. Ta różnica wynika z projektu blokad w protokole SMB, który udostępnia semantykę obowiązkowego blokowania.

Semantyka zdalnego i obowiązkowego blokowania może różnić się w zależności od protokołu SMB, opcji montowania i typu serwera. Więcej informacji zawiera podręcznik mount.cifs(8).

STANDARDY
BSD.

HISTORIA
4.4BSD (funkcja flock() pojawiła się pierwotnie w 4.2BSD). Pewna wersja flock(), prawdopodobnie zaimplementowana na podstawie fcntl(2), pojawia się w większości systemów UNIX.

  Detale NFS
Do Linuksa 2.6.11, flock() nie blokowało plików poprzez NFS (tj. zakres blokad był ograniczony do systemu lokalnego). W zamian można było użyć blokowania zakresu bajtów fcntl(2), które działało poprzez NFS, przy założeniu, że występowała odpowiednio nowa wersja Linuksa oraz serwer obsługujący blokowanie.

Od Linuksa 2.6.12, klienty NFS obsługują blokady flock() emulując je jako blokady zakresu bajtów fcntl(2) na całym pliku. Oznacza to, że blokady fcntl(2) i flock() wchodzą ze sobą w interakcję poprzez NFS. Oznacza to również, że aby umieścić wyłączną blokadę, plik musi być otwarty do zapisu.

Od Linuksa 2.6.37, jądro obsługuje również tryb kompatybilności, pozwalający traktować blokady flock() (oraz blokady regionu bajtów fcntl(2)) jak lokalne: więcej informacji w opisie opcji local_lock w podręczniku nfs(5).

UWAGI
flock() tworzy jedynie blokady doradcze; proces mający odpowiednie uprawnienia do pliku, może swobodnie zignorować fakt użycia flock() i wykonywać operacje wejścia/wyjścia na tym pliku.

Blokady flock() i fcntl(2) różną się semantycznie, jeśli chodzi o procesy potomne i dup(2). W systemach implementujących flock() za pomocą fcntl(2), semantyka flock() będzie inna niż ta opisana w tym podręczniku.

Nie jest gwarantowane, że konwersja blokady (z dzielonej na wyłączną lub na odwrót) będzie atomowa: istniejąca blokada może być najpierw usunięta, a następnie może być założona nowa blokada. Pomiędzy tymi dwoma krokami blokadę może uzyskać inny proces oczekujący na nią, co spowoduje, że konwersja blokady albo będzie oczekiwała, albo się nie powiedzie, jeśli podano LOCK_NB. (Jest to oryginalne zachowanie z BSD, występujące również w wielu innych implementacjach).

Zwolnienie blokady, gdy zamykany jest deskryptor pliku, nie następuje po wystąpieniu wszystkich widocznych następstw działania close(2). Na przykład, gdy jeden proces zapisuje do pliku, utrzymując blokadę na wyłączność, a następnie zamknie ten plik, natomiast inny proces blokuje, zakładając blokadę współdzieloną na tym pliku, czekając do momentu zamknięcia go, może zaobserwować, że kolejne execve(2) na tym pliku zawiedzie z błędem ETXTBSY, a umount(2) na przedmiotowym systemie plików zawiedzie z błędem EBUSY tak, jak gdyby pliki były wciąż otwarte przez pierwszy proces.

ZOBACZ TAKŻE
flock(1), close(2), dup(2), execve(2), fcntl(2), fork(2), open(2), lockf(3), lslocks(8)

Documentation/filesystems/locks.rst w kodzie źródłowym jądra Linux

TŁUMACZENIE
Tłumaczenie niniejszej strony podręcznika: Przemek Borys <pborys@dione.ids.pl>, Andrzej Krzysztofowicz <ankry@green.mf.pg.gda.pl>, Robert Luberda <robert@debian.org> i Michał Kułach <michal.kulach@gmail.com>

Niniejsze tłumaczenie jest wolną dokumentacją. Bliższe informacje o warunkach licencji można uzyskać zapoznając się z GNU General Public License w wersji 3 (https://www.gnu.org/licenses/gpl-3.0.html) lub nowszej. Nie przyjmuje się ŻADNEJ ODPOWIEDZIALNOŚCI.

Błędy w tłumaczeniu strony podręcznika prosimy zgłaszać na adres listy dyskusyjnej manpages-pl-list@lists.sourceforge.net.