sysdeps/mach/hurd/fcntlbits.h

   1 /* O_*, F_*, FD_* bit values for GNU.
   2    Copyright (C) 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #ifndef _FCNTLBITS_H
  21
  22 #define _FCNTLBITS_H    1
  23
  24
  25 /* File access modes.  These are understood by io servers; they can be
  26    passed in `dir_lookup', and are returned by `io_get_openmodes'.
  27    Consequently they can be passed to `open', `hurd_file_name_lookup', and
  28    `file_name_lookup'; and are returned by `fcntl' with the F_GETFL
  29    command.  */
  30
  31 /* In GNU, read and write are bits (unlike BSD).  */
  32 #ifdef __USE_GNU
  33 #define O_READ          O_RDONLY /* Open for reading.  */
  34 #define O_WRITE         O_WRONLY /* Open for writing.  */
  35 #define O_EXEC          0x0004  /* Open for execution.  */
  36 #define O_NORW          0       /* Open without R/W access.  */
  37 #endif
  38 /* POSIX.1 standard names.  */
  39 #define O_RDONLY        0x0001  /* Open read-only.  */
  40 #define O_WRONLY        0x0002  /* Open write-only.  */
  41 #define O_RDWR          (O_RDONLY|O_WRONLY) /* Open for reading and writing. */
  42 #define O_ACCMODE       O_RDWR  /* Mask for file access modes.  */
  43
  44
  45
  46 /* File name translation flags.  These are understood by io servers;
  47    they can be passed in `dir_lookup', and consequently to `open',
  48    `hurd_file_name_lookup', and `file_name_lookup'.  */
  49
  50 #define O_CREAT         0x0010  /* Create file if it doesn't exist.  */
  51 #define O_EXCL          0x0020  /* Fail if file already exists.  */
  52 #ifdef __USE_GNU
  53 #define O_NOLINK        0x0040  /* No name mappings on final component.  */
  54 #define O_NOTRANS       0x0080  /* No translator on final component. */
  55 #endif
  56
  57
  58 /* I/O operating modes.  These are understood by io servers; they can be
  59    passed in `dir_lookup' and set or fetched with `io_*_openmodes'.
  60    Consequently they can be passed to `open', `hurd_file_name_lookup',
  61    `file_name_lookup', and `fcntl' with the F_SETFL command; and are
  62    returned by `fcntl' with the F_GETFL command.  */
  63
  64 #define O_APPEND        0x0100  /* Writes always append to the file.  */
  65 #ifdef __USE_BSD
  66 #define O_ASYNC         0x0200  /* Send SIGIO to owner when data is ready.  */
  67 #define O_FSYNC         0x0400  /* Synchronous writes.  */
  68 #define O_SYNC          O_FSYNC
  69 #endif
  70 #ifdef __USE_GNU
  71 #define O_NOATIME       0x0800  /* Don't set access time on read (owner).  */
  72 #endif
  73 #ifdef  __USE_MISC
  74 #define O_SHLOCK        0x00020000 /* Open with shared file lock.  */
  75 #define O_EXLOCK        0x00040000 /* Open with exclusive file lock.  */
  76 #endif
  77
  78
  79 /* The name O_NONBLOCK is unfortunately overloaded; it is both a file name
  80    translation flag and an I/O operating mode.  O_NDELAY is the deprecated
  81    BSD name for the same flag, overloaded in the same way.
  82
  83    When used in `dir_lookup' (and consequently `open', `hurd_file_name_lookup',
  84    or `file_name_lookup'), O_NONBLOCK says the open should return immediately
  85    instead of blocking for any significant length of time (e.g., to wait
  86    for carrier detect on a serial line).  It is also saved as an I/O
  87    operating mode, and after open has the following meaning.
  88
  89    When used in `io_*_openmodes' (and consequently `fcntl' with the F_SETFL
  90    command), the O_NONBLOCK flag means to do nonblocking i/o: any i/o
  91    operation that would block for any significant length of time will instead
  92    fail with EAGAIN.  */
  93
  94 #define O_NONBLOCK      0x0008  /* Non-blocking open or non-blocking I/O.  */
  95 #ifdef __USE_BSD
  96 #define O_NDELAY        O_NONBLOCK /* Deprecated.  */
  97 #endif
  98
  99
 100 #ifdef __USE_GNU
 101 /* Mask of bits which are understood by io servers.  */
 102 #define O_HURD          (0xffff | O_EXLOCK | O_SHLOCK)
 103 #endif
 104
 105
 106 /* Open-time action flags.  These are understood by `hurd_file_name_lookup'
 107    and consequently by `open' and `file_name_lookup'.  They are not preserved
 108    once the file has been opened.  */
 109
 110 #define O_TRUNC         0x00010000 /* Truncate file to zero length.  */
 111
 112
 113 /* Controlling terminal flags.  These are understood only by `open',
 114    and are not preserved once the file has been opened.  */
 115
 116 #ifdef __USE_GNU
 117 #define O_IGNORE_CTTY   0x00080000 /* Don't do any ctty magic at all.  */
 118 #endif
 119 /* `open' never assigns a controlling terminal in GNU.  */
 120 #define O_NOCTTY        0       /* Don't assign a controlling terminal.  */
 121
 122
 123 #ifdef __USE_BSD
 124 /* Bits in the file status flags returned by F_GETFL.  */
 125 #define FREAD           O_RDONLY
 126 #define FWRITE          O_WRONLY
 127
 128 /* Traditional BSD names the O_* bits.  */
 129 #define FASYNC          O_ASYNC
 130 #define FCREAT          O_CREAT
 131 #define FEXCL           O_EXCL
 132 #define FTRUNC          O_TRUNC
 133 #define FNOCTTY         O_NOCTTY
 134 #define FFSYNC          O_FSYNC
 135 #define FSYNC           O_SYNC
 136 #define FAPPEND         O_APPEND
 137 #define FNONBLOCK       O_NONBLOCK
 138 #define FNDELAY         O_NDELAY
 139 #endif
 140
 141
 142 /* Values for the second argument to `fcntl'.  */
 143 #define F_DUPFD         0       /* Duplicate file descriptor.  */
 144 #define F_GETFD         1       /* Get file descriptor flags.  */
 145 #define F_SETFD         2       /* Set file descriptor flags.  */
 146 #define F_GETFL         3       /* Get file status flags.  */
 147 #define F_SETFL         4       /* Set file status flags.  */
 148 #ifdef __USE_BSD
 149 #define F_GETOWN        5       /* Get owner (receiver of SIGIO).  */
 150 #define F_SETOWN        6       /* Set owner (receiver of SIGIO).  */
 151 #endif
 152 #define F_GETLK         7       /* Get record locking info.  */
 153 #define F_SETLK         8       /* Set record locking info (non-blocking).  */
 154 #define F_SETLKW        9       /* Set record locking info (blocking).  */
 155
 156 /* File descriptor flags used with F_GETFD and F_SETFD.  */
 157 #define FD_CLOEXEC      1       /* Close on exec.  */
 158
 159
 160 #include <gnu/types.h>
 161
 162 /* The structure describing an advisory lock.  This is the type of the third
 163    argument to `fcntl' for the F_GETLK, F_SETLK, and F_SETLKW requests.  */
 164 struct flock
 165   {
 166     int l_type;         /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
 167     int l_whence;       /* Where `l_start' is relative to (like `lseek').  */
 168     __off_t l_start;    /* Offset where the lock begins.  */
 169     __off_t l_len;      /* Size of the locked area; zero means until EOF.  */
 170     __pid_t l_pid;      /* Process holding the lock.  */
 171   };
 172
 173 /* Values for the `l_type' field of a `struct flock'.  */
 174 #define F_RDLCK 1       /* Read lock.  */
 175 #define F_WRLCK 2       /* Write lock.  */
 176 #define F_UNLCK 3       /* Remove lock.  */
 177
 178
 179 #endif  /* fcntlbits.h */