lib/libc/sys/flock.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)flock.2     8.2 (Berkeley) 12/11/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd November 9, 2011
  32 .Dt FLOCK 2
  33 .Os
  34 .Sh NAME
  35 .Nm flock
  36 .Nd "apply or remove an advisory lock on an open file"
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/file.h
  41 .Fd "#define   LOCK_SH        0x01      /* shared file lock */"
  42 .Fd "#define   LOCK_EX        0x02      /* exclusive file lock */"
  43 .Fd "#define   LOCK_NB        0x04      /* do not block when locking */"
  44 .Fd "#define   LOCK_UN        0x08      /* unlock file */"
  45 .Ft int
  46 .Fn flock "int fd" "int operation"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn flock
  50 system call applies or removes an
  51 .Em advisory
  52 lock on the file associated with the file descriptor
  53 .Fa fd .
  54 A lock is applied by specifying an
  55 .Fa operation
  56 argument that is one of
  57 .Dv LOCK_SH
  58 or
  59 .Dv LOCK_EX
  60 with the optional addition of
  61 .Dv LOCK_NB .
  62 To unlock
  63 an existing lock
  64 .Dv operation
  65 should be
  66 .Dv LOCK_UN .
  67 .Pp
  68 Advisory locks allow cooperating processes to perform
  69 consistent operations on files, but do not guarantee
  70 consistency (i.e., processes may still access files
  71 without using advisory locks possibly resulting in
  72 inconsistencies).
  73 .Pp
  74 The locking mechanism allows two types of locks:
  75 .Em shared
  76 locks and
  77 .Em exclusive
  78 locks.
  79 At any time multiple shared locks may be applied to a file,
  80 but at no time are multiple exclusive, or both shared and exclusive,
  81 locks allowed simultaneously on a file.
  82 .Pp
  83 A shared lock may be
  84 .Em upgraded
  85 to an exclusive lock, and vice versa, simply by specifying
  86 the appropriate lock type; this results in the previous
  87 lock being released and the new lock applied (possibly
  88 after other processes have gained and released the lock).
  89 .Pp
  90 Requesting a lock on an object that is already locked
  91 normally causes the caller to be blocked until the lock may be
  92 acquired.
  93 If
  94 .Dv LOCK_NB
  95 is included in
  96 .Fa operation ,
  97 then this will not happen; instead the call will fail and
  98 the error
  99 .Er EWOULDBLOCK
 100 will be returned.
 101 .Sh NOTES
 102 Locks are on files, not file descriptors.
 103 That is, file descriptors
 104 duplicated through
 105 .Xr dup 2
 106 or
 107 .Xr fork 2
 108 do not result in multiple instances of a lock, but rather multiple
 109 references to a single lock.
 110 If a process holding a lock on a file
 111 forks and the child explicitly unlocks the file, the parent will
 112 lose its lock.
 113 .Pp
 114 The
 115 .Fn flock ,
 116 .Xr fcntl 2 ,
 117 and
 118 .Xr lockf 3
 119 locks are compatible.
 120 Processes using different locking interfaces can cooperate
 121 over the same file safely.
 122 However, only one of such interfaces should be used within
 123 the same process.
 124 If a file is locked by a process through
 125 .Fn flock ,
 126 any record within the file will be seen as locked
 127 from the viewpoint of another process using
 128 .Xr fcntl 2
 129 or
 130 .Xr lockf 3 ,
 131 and vice versa.
 132 .Pp
 133 Processes blocked awaiting a lock may be awakened by signals.
 134 .Sh RETURN VALUES
 135 .Rv -std flock
 136 .Sh ERRORS
 137 The
 138 .Fn flock
 139 system call fails if:
 140 .Bl -tag -width Er
 141 .It Bq Er EWOULDBLOCK
 142 The file is locked and the
 143 .Dv LOCK_NB
 144 option was specified.
 145 .It Bq Er EBADF
 146 The argument
 147 .Fa fd
 148 is an invalid descriptor.
 149 .It Bq Er EINVAL
 150 The argument
 151 .Fa fd
 152 refers to an object other than a file.
 153 .It Bq Er EOPNOTSUPP
 154 The argument
 155 .Fa fd
 156 refers to an object that does not support file locking.
 157 .It Bq Er ENOLCK
 158 A lock was requested, but no locks are available.
 159 .El
 160 .Sh SEE ALSO
 161 .Xr close 2 ,
 162 .Xr dup 2 ,
 163 .Xr execve 2 ,
 164 .Xr fcntl 2 ,
 165 .Xr fork 2 ,
 166 .Xr open 2 ,
 167 .Xr flopen 3 ,
 168 .Xr lockf 3
 169 .Sh HISTORY
 170 The
 171 .Fn flock
 172 system call appeared in
 173 .Bx 4.2 .