*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->NetBSD man pages -> flock (2)              



NAME    [Toc]    [Back]

     flock - apply or remove an advisory lock on an open file

LIBRARY    [Toc]    [Back]

     Standard C Library (libc, -lc)

SYNOPSIS    [Toc]    [Back]

     #include <fcntl.h>
     #define   LOCK_SH   1    /* shared lock */
     #define   LOCK_EX   2    /* exclusive lock */
     #define   LOCK_NB   4    /* don't block when locking */
     #define   LOCK_UN   8    /* unlock */

     flock(int fd, int operation);

DESCRIPTION    [Toc]    [Back]

     flock() applies or removes an advisory lock on the file associated with
     the file descriptor fd.  A lock is applied by specifying an operation
     parameter that is one of LOCK_SH or LOCK_EX with the optional addition of
     LOCK_NB.  To unlock an existing lock operation should be LOCK_UN.

     Advisory locks allow cooperating processes to perform consistent operations
 on files, but do not guarantee consistency (i.e., processes may
     still access files without using advisory locks possibly resulting in

     The locking mechanism allows two types of locks: shared locks and
     exclusive locks.  At any time multiple shared locks may be applied to a
     file, but at no time are multiple exclusive, or both shared and exclusive,
 locks allowed simultaneously on a file.

     A shared lock may be upgraded to an exclusive lock, and vice versa, simply
 by specifying the appropriate lock type; this results in the previous
     lock being released and the new lock applied (possibly after other processes
 have gained and released the lock).

     Requesting a lock on an object that is already locked normally causes the
     caller to be blocked until the lock may be acquired.  If LOCK_NB is
     included in operation, then this will not happen; instead the call will
     fail and the error EAGAIN will be returned.

NOTES    [Toc]    [Back]

     Locks are on files, not file descriptors.  That is, file descriptors
     duplicated through dup(2) or fork(2) do not result in multiple instances
     of a lock, but rather multiple references to a single lock.  If a process
     holding a lock on a file forks and the child explicitly unlocks the file,
     the parent will lose its lock.

     Processes blocked awaiting a lock may be awakened by signals.

RETURN VALUES    [Toc]    [Back]

     Zero is returned if the operation was successful; on an error a -1 is
     returned and an error code is left in the global location errno.

ERRORS    [Toc]    [Back]

     The flock() call fails if:

     [EAGAIN]           The file is locked and the LOCK_NB option was specified.

     [EBADF]            The argument fd is an invalid descriptor.

     [EOPNOTSUPP]       The argument fd refers to an object other than a file.

     [EINVAL]           The argument operation does not include one of
                        LOCK_EX, LOCK_SH or LOCK_UN.

SEE ALSO    [Toc]    [Back]

     close(2), dup(2), execve(2), fork(2), open(2)

HISTORY    [Toc]    [Back]

     The flock() function call appeared in 4.2BSD.

BSD                            December 11, 1993                           BSD
[ Back ]
 Similar pages
Name OS Title
lockf Linux apply, test or remove a POSIX lock on an open file
lockf Tru64 Lock and unlocks regions of open file descriptors
patch Linux apply a diff file to an original
patch IRIX apply a diff file to an original
patch FreeBSD apply a diff file to an original
patch OpenBSD apply a diff file to an original
VOP_ADVLOCK FreeBSD advisory record locking
noderun IRIX Run process on specific node (advisory specification)
AFidentifyfd IRIX retrieve the audio file format of a file descriptor / open AFfilehandle
IvToRib IRIX convert an Open Inventor 2.0 file to a Renderman .rib file
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service