1 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu) and
2 .\" and Copyright 2002 Michael Kerrisk
4 .\" %%%LICENSE_START(VERBATIM)
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date. The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein. The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
26 .\" Modified Fri Jan 31 16:26:07 1997 by Eric S. Raymond <esr@thyrsus.com>
27 .\" Modified Fri Dec 11 17:57:27 1998 by Jamie Lokier <jamie@imbolc.ucc.ie>
28 .\" Modified 24 Apr 2002 by Michael Kerrisk <mtk.manpages@gmail.com>
29 .\" Substantial rewrites and additions
30 .\" 2005-05-10 mtk, noted that lock conversions are not atomic.
32 .\" FIXME: Maybe document LOCK_MAND, LOCK_RW, LOCK_READ, LOCK_WRITE
33 .\" which only have effect for SAMBA.
35 .TH FLOCK 2 2013-02-11 "Linux" "Linux Programmer's Manual"
37 flock \- apply or remove an advisory lock on an open file
39 .B #include <sys/file.h>
41 .BI "int flock(int " fd ", int " operation );
43 Apply or remove an advisory lock on the open file specified by
47 is one of the following:
52 More than one process may hold a shared lock for a given file
56 Place an exclusive lock.
57 Only one process may hold an exclusive lock for a given
61 Remove an existing lock held by this process.
66 may block if an incompatible lock is held by another process.
67 To make a nonblocking request, include
70 with any of the above operations.
72 A single file may not simultaneously have both shared and exclusive locks.
76 are associated with an open file table entry.
77 This means that duplicate file descriptors (created by, for example,
81 refer to the same lock, and this lock may be modified
82 or released using any of these descriptors.
83 Furthermore, the lock is released either by an explicit
85 operation on any of these duplicate descriptors, or when all
86 such descriptors have been closed.
90 (or similar) to obtain more than one descriptor for the same file,
91 these descriptors are treated independently by
93 An attempt to lock the file using one of these file descriptors
94 may be denied by a lock that the calling process has
95 already placed via another descriptor.
97 A process may hold only one type of lock (shared or exclusive)
101 calls on an already locked file will convert an existing lock to the new
106 are preserved across an
109 A shared or exclusive lock can be placed on a file regardless of the
110 mode in which the file was opened.
112 On success, zero is returned.
113 On error, \-1 is returned, and
115 is set appropriately.
120 is not an open file descriptor.
123 While waiting to acquire a lock, the call was interrupted by
124 delivery of a signal caught by a handler; see
132 The kernel ran out of memory for allocating lock records.
135 The file is locked and the
141 call first appeared in 4.2BSD).
144 possibly implemented in terms of
146 appears on most UNIX systems.
149 does not lock files over NFS.
152 instead: that does work over NFS, given a sufficiently recent version of
153 Linux and a server which supports locking.
157 is implemented as a system call in its own right rather
158 than being emulated in the GNU C library as a call to
160 This yields true BSD semantics:
161 there is no interaction between the types of lock
168 does not detect deadlock.
171 places advisory locks only; given suitable permissions on a file,
172 a process is free to ignore the use of
174 and perform I/O on the file.
179 locks have different semantics with respect to forked processes and
181 On systems that implement
187 will be different from those described in this manual page.
190 (shared to exclusive, or vice versa) is not guaranteed to be atomic:
191 the existing lock is first removed, and then a new lock is established.
192 Between these two steps,
193 a pending lock request by another process may be granted,
194 with the result that the conversion either blocks, or fails if
197 (This is the original BSD behavior,
198 and occurs on many other implementations.)
199 .\" Kernel 2.5.21 changed things a little: during lock conversion
200 .\" it is now the highest priority process that will get the lock -- mtk
211 .I Documentation/filesystems/locks.txt
212 in the Linux kernel source tree
213 .RI ( Documentation/locks.txt
216 This page is part of release 3.65 of the Linux
219 A description of the project,
220 and information about reporting bugs,
222 \%http://www.kernel.org/doc/man\-pages/.