lib/libc/sys/flock.2

   1 .\"     $NetBSD: flock.2,v 1.21 2009/10/29 01:52:01 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)flock.2     8.2 (Berkeley) 12/11/93
  31 .\"
  32 .Dd October 26, 2009
  33 .Dt FLOCK 2
  34 .Os
  35 .Sh NAME
  36 .Nm flock
  37 .Nd "apply or remove an advisory lock on an open file"
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In fcntl.h
  42 .Fd #define     LOCK_SH 1       /* shared lock */
  43 .Fd #define     LOCK_EX 2       /* exclusive lock */
  44 .Fd #define     LOCK_NB 4       /* don't block when locking */
  45 .Fd #define     LOCK_UN 8       /* unlock */
  46 .Ft int
  47 .Fn flock "int fd" "int operation"
  48 .Sh DESCRIPTION
  49 .Fn flock
  50 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 parameter 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 EAGAIN
 100 will be returned.
 101 .Sh NOTES
 102 Locks are on files, not file descriptors.
 103 That is, file descriptors duplicated through
 104 .Xr dup 2
 105 or
 106 .Xr fork 2
 107 do not result in multiple instances of a lock, but rather multiple
 108 references to a single lock.
 109 If a process holding a lock on a file
 110 forks and the child explicitly unlocks the file, the parent will
 111 lose its lock.
 112 .Pp
 113 Processes blocked awaiting a lock may be awakened by signals.
 114 .Sh RETURN VALUES
 115 Zero is returned if the operation was successful;
 116 on an error a \-1 is returned and an error code is left in
 117 the global location
 118 .Va errno .
 119 .Sh ERRORS
 120 The
 121 .Fn flock
 122 call fails if:
 123 .Bl -tag -width Er
 124 .It Bq Er EAGAIN
 125 The file is locked and the
 126 .Dv LOCK_NB
 127 option was specified.
 128 .It Bq Er EBADF
 129 The argument
 130 .Fa fd
 131 is an invalid descriptor.
 132 .It Bq Er EINVAL
 133 The argument
 134 .Fa operation
 135 does not include exactly one of
 136 .Dv LOCK_EX ,
 137 .Dv LOCK_SH ,
 138 or
 139 .Dv LOCK_UN .
 140 .It Bq Er EOPNOTSUPP
 141 The argument
 142 .Fa fd
 143 refers to an object other than a file.
 144 .El
 145 .Sh SEE ALSO
 146 .Xr close 2 ,
 147 .Xr dup 2 ,
 148 .Xr execve 2 ,
 149 .Xr fork 2 ,
 150 .Xr open 2
 151 .Sh HISTORY
 152 The
 153 .Fn flock
 154 function call appeared in
 155 .Bx 4.2 .