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