Seth Woolley's Man Viewer

lockf(3) - lockf, lockf - apply, test or remove a POSIX lock on an open file - man 3 lockf

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

LOCKF(3)                   Linux Programmer's Manual                  LOCKF(3)



NAME
       lockf - apply, test or remove a POSIX lock on an open(2,3,n) file(1,n)

SYNOPSIS
       #include <unistd.h>

       int lockf(int fd, int cmd, off_t len);

DESCRIPTION
       Apply,  test  or remove a POSIX lock on a section of an open(2,3,n) file.  The
       file(1,n) is specified by fd, a file(1,n) descriptor open(2,3,n) for writing, the action
       by  cmd,  and  the section consists of byte positions pos..pos+len-1 if(3,n)
       len is positive, and pos-len..pos-1 if(3,n) len is negative,  where  pos  is
       the current file(1,n) position, and if(3,n) len is zero, the section extends from
       the current file(1,n) position to infinity,  encompassing  the  present  and
       future  end-of-file  positions.   In  all cases, the section may extend
       past current end-of-file.

       On Linux, this call is just an interface for  fcntl(2).   (In  general,
       the relation between lockf and fcntl is unspecified.)

       Valid operations are given below:

       F_LOCK Set  an exclusive lock on the specified section of the file.  If
              (part of) this section is already locked, the call blocks  until
              the previous lock is released.  If this section overlaps an ear-
              lier locked section, both are merged.  File locks  are  released
              as  soon  as  the  process  holding  the  locks closes some file(1,n)
              descriptor for the file. A child process does not inherit  these
              locks.

       F_TLOCK
              Same  as  F_LOCK  but the call never blocks and returns an error(8,n)
              instead if(3,n) the file(1,n) is already locked.

       F_ULOCK
              Unlock the indicated section of the  file.   This  may  cause  a
              locked section to be split(1,n) into two locked sections.

       F_TEST Test  the lock: return 0 if(3,n) the specified section is unlocked or
              locked by this process; return  -1,  set(7,n,1 builtins)  errno  to  EACCES,  if(3,n)
              another process holds a lock.

RETURN VALUE
       On  success,  zero is returned.  On error(8,n), -1 is returned, and errno is
       set(7,n,1 builtins) appropriately.

ERRORS
       EAGAIN The file(1,n) is locked and F_TLOCK or F_TEST was specified,  or  the
              operation  is prohibited because the file(1,n) has been memory-mapped
              by another process.

       EBADF  fd is not an open(2,3,n) file(1,n) descriptor.

       EDEADLK
              The command was T_LOCK and this lock  operation  would  cause  a
              deadlock.

       EINVAL An invalid operation was specified in(1,8) fd.

       ENOLCK Too many segment locks open(2,3,n), lock table is full.

CONFORMING TO
       SYSV, POSIX 1003.1-2001

SEE ALSO
       fcntl(2), flock(1,2)(2)
       There are also locks.txt and mandatory.txt in(1,8) /usr/src/linux/Documenta-
       tion.



Linux 2.0                         2002-04-22                          LOCKF(3)

References for this manual (incoming links)