sysdeps/unix/common/bits/fcntl.h

   1 /* O_*, F_*, FD_* bit values for general Unix system.
   2    Copyright (C) 1991, 1992, 1995, 1997, 2000, 2004
   3    Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 #ifndef _FCNTL_H
  22 # error "Never use <bits/fcntl.h> directly; include <fcntl.h> instead."
  23 #endif
  24
  25
  26 /* File access modes for `open' and `fcntl'.  */
  27 #define O_RDONLY        0       /* Open read-only.  */
  28 #define O_WRONLY        1       /* Open write-only.  */
  29 #define O_RDWR          2       /* Open read/write.  */
  30
  31
  32 /* Bits OR'd into the second argument to open.  */
  33 #define O_CREAT         0x0100  /* Create file if it doesn't exist.  */
  34 #define O_EXCL          0x0400  /* Fail if file already exists.  */
  35 #define O_TRUNC         0x0200  /* Truncate file to zero length.  */
  36 #define O_NOCTTY        0x0800  /* Don't assign a controlling terminal.  */
  37 #ifdef  __USE_MISC
  38 # define O_ASYNC        0x0040  /* Send SIGIO to owner when data is ready.  */
  39 # define O_FSYNC        0x0010  /* Synchronous writes.  */
  40 # define O_SYNC         O_FSYNC
  41 #endif
  42
  43 /* File status flags for `open' and `fcntl'.  */
  44 #define O_APPEND        0x0008  /* Writes append to the file.  */
  45 #define O_NONBLOCK      0x0080  /* Non-blocking I/O.  */
  46
  47 #ifdef __USE_MISC
  48 # define O_NDELAY       0x0004
  49 #endif
  50
  51 #ifdef __USE_MISC
  52 /* Bits in the file status flags returned by F_GETFL.
  53    These are all the O_* flags, plus FREAD and FWRITE, which are
  54    independent bits set by which of O_RDONLY, O_WRONLY, and O_RDWR, was
  55    given to `open'.  */
  56 # define FREAD          1
  57 # define FWRITE         2
  58
  59 /* Traditional Unix names the O_* bits.  */
  60 # define FASYNC         O_ASYNC
  61 # define FCREAT         O_CREAT
  62 # define FEXCL          O_EXCL
  63 # define FTRUNC         O_TRUNC
  64 # define FNOCTTY        O_NOCTTY
  65 # define FFSYNC         O_FSYNC
  66 # define FSYNC          O_SYNC
  67 # define FAPPEND        O_APPEND
  68 # define FNONBLOCK      O_NONBLOCK
  69 # define FNONBIO        O_NONBLOCK
  70 # define FNDELAY        O_NDELAY
  71 #endif
  72
  73 /* Mask for file access modes.  This is system-dependent in case
  74    some system ever wants to define some other flavor of access.  */
  75 #define O_ACCMODE       (O_RDONLY|O_WRONLY|O_RDWR)
  76
  77 /* Values for the second argument to `fcntl'.  */
  78 #define F_DUPFD         0       /* Duplicate file descriptor.  */
  79 #define F_GETFD         1       /* Get file descriptor flags.  */
  80 #define F_SETFD         2       /* Set file descriptor flags.  */
  81 #define F_GETFL         3       /* Get file status flags.  */
  82 #define F_SETFL         4       /* Set file status flags.  */
  83 #if defined __USE_BSD || defined __USE_UNIX98
  84 # define F_GETOWN       23      /* Get owner (receiver of SIGIO).  */
  85 # define F_SETOWN       24      /* Set owner (receiver of SIGIO).  */
  86 #endif
  87 #define F_GETLK         14      /* Get record locking info.  */
  88 #define F_SETLK         6       /* Set record locking info (non-blocking).  */
  89 #define F_SETLKW        7       /* Set record locking info (blocking).  */
  90 #ifdef  __USE_SVID
  91 # define F_ALLOCSP      10      /* Allocate space in the file.  */
  92 # define F_FREESP       11      /* Free space in the file.  */
  93 # define F_RGETLK       20      /* Get remote record locking info.  */
  94 # define F_RSETLK       21      /* Set remote locking info (non-blocking).  */
  95 # define F_RSETLKW      22      /* Set remote locking info (blocking).  */
  96 #endif
  97
  98 /* File descriptor flags used with F_GETFD and F_SETFD.  */
  99 #define FD_CLOEXEC      1       /* Close on exec.  */
 100
 101
 102 #include <bits/types.h>
 103
 104 /* The structure describing an advisory lock.  This is the type of the third
 105    argument to `fcntl' for the F_GETLK, F_SETLK, and F_SETLKW requests.  */
 106 struct flock
 107   {
 108     short int l_type;   /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
 109     short int l_whence; /* Where `l_start' is relative to (like `lseek').  */
 110     __off_t l_start;    /* Offset where the lock begins.  */
 111     __off_t l_len;      /* Size of the locked area; zero means until EOF.  */
 112     long int l_sysid;   /* System ID where locking process resides.  */
 113     __pid_t l_pid;      /* Process holding the lock.  */
 114     long int pad[4];    /* Reserved for future use.  */
 115   };
 116
 117 /* Values for the `l_type' field of a `struct flock'.  */
 118 #define F_RDLCK 1       /* Read lock.  */
 119 #define F_WRLCK 2       /* Write lock.  */
 120 #define F_UNLCK 3       /* Remove lock.  */