Formerly mach/hurd/fcntlbits.h.~6~
[kopensolaris-gnu/glibc.git] / sysdeps / mach / hurd / fcntlbits.h
1 /* O_*, F_*, FD_* bit values for GNU.
2 Copyright (C) 1993 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
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, 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_pathtrans', and are returned by `io_get_openmodes'.
27    Consequently they can be passed to `open', `hurd_path_lookup', and
28    `path_lookup'; and are returned by `fcntl' with the F_GETFL command.  */
29
30 /* In GNU, read and write are bits (unlike BSD).  */
31 #ifdef __USE_GNU
32 #define O_READ          O_RDONLY /* Open for reading.  */
33 #define O_WRITE         O_WRONLY /* Open for writing.  */
34 #define O_EXEC          0x0004  /* Open for execution.  */
35 #endif
36 #define O_RDONLY        0x0001  /* POSIX.1 name: Open read-only.  */
37 #define O_WRONLY        0x0002  /* POSIX.1 name: Open write-only.  */
38 #define O_RDWR          (O_RDONLY|O_WRONLY) /* Open for reading and writing. */
39 /* Mask for file access modes.  XXX Should this include O_EXEC??? */
40 #define O_ACCMODE       O_RDWR
41
42
43 /* File name translation flags.  These are understood by io servers;
44    they can be passed in `dir_pathtrans', and consequently to `open',
45    `hurd_path_lookup', and `path_lookup'.  */
46
47 #define O_CREAT         0x0010  /* Create file if it doesn't exist.  */
48 #define O_EXCL          0x0020  /* Fail if file already exists.  */
49 #ifdef __USE_GNU
50 #define O_NOLINK        0x0040  /* No name mappings on final component.  */
51 #define O_NOTRANS       0x0080  /* No translator on final component. */
52 #endif
53
54
55 /* File status flags.  These are understood by io servers; they can be
56    passed in `dir_pathtrans' and set or fetched with `io_*_openmodes'.
57    Consequently they can be passed to `open', `hurd_path_lookup',
58    `path_lookup', and `fcntl' with the F_SETFL command; and are returned
59    by `fcntl' with the F_GETFL command.  */
60
61 #define O_APPEND        0x0100  /* Writes always append to the file.  */
62 #define O_ASYNC         0x0200  /* Send SIGIO to owner when data is ready.  */
63 #define O_FSYNC         0x0400  /* Synchronous writes.  */
64 #define O_SYNC          O_FSYNC
65 #ifdef __USE_GNU
66 #define O_NOATIME       0x0800  /* Don't set access time on read by owner. */
67 #endif
68
69
70 /* The name O_NONBLOCK is unfortunately overloaded; it is both a file name
71    translation flag and a file status flag.  O_NDELAY is the deprecated BSD
72    name for the same flag, overloaded in the same way.
73
74    When used in `dir_pathtrans' (and consequently `open', `hurd_path_lookup',
75    or `path_lookup'), O_NONBLOCK says the open should fail with EAGAIN
76    instead of blocking for any significant length of time (e.g., to wait for
77    DTR on a serial line).
78
79    When used in `io_*_openmodes' (and consequently `fcntl' with the F_SETFL
80    command), the O_NONBLOCK flag means to do nonblocking i/o: any i/o
81    operation that would block for any significant length of time will instead
82    fail with EAGAIN.  */
83
84 #define O_NONBLOCK      0x0008  /* Non-blocking open or non-blocking I/O.  */
85 #ifdef __USE_BSD
86 #define O_NDELAY        O_NONBLOCK
87 #endif
88
89
90 #ifdef __USE_GNU
91 /* Mask of bits which are understood by io servers.  */
92 #define O_HURD          0xffff  /* XXX name? want this? */
93 #endif
94
95
96 /* Open-time action flags.  These are understood by `hurd_path_lookup'
97    and consequently by `open' and `path_lookup'.  They are not preserved
98    once the file has been opened.  */
99
100 #define O_TRUNC         0x00010000 /* Truncate file to zero length.  */
101 #ifdef  __USE_MISC
102 #define O_SHLOCK        0x00020000 /* Open with shared file lock.  */
103 #define O_EXLOCK        0x00040000 /* Open with shared exclusive lock.  */
104 #endif
105
106 /* Controlling terminal flags.  These are understood only by `open',
107    and are not preserved once the file has been opened.  */
108
109 #ifdef __USE_GNU
110 #define O_IGNORE_CTTY   0x00080000 /* Don't do any ctty magic at all.  */
111 #endif
112 /* `open' never assigns a controlling terminal in GNU.  */
113 #define O_NOCTTY        0       /* Don't assign a controlling terminal.  */
114
115
116 #ifdef __USE_BSD
117 /* Bits in the file status flags returned by F_GETFL.  */
118 #define FREAD           O_RDONLY
119 #define FWRITE          O_WRONLY
120
121 /* Traditional BSD names the O_* bits.  */
122 #define FASYNC          O_ASYNC
123 #define FCREAT          O_CREAT
124 #define FEXCL           O_EXCL
125 #define FTRUNC          O_TRUNC
126 #define FNOCTTY         O_NOCTTY
127 #define FFSYNC          O_FSYNC
128 #define FSYNC           O_SYNC
129 #define FAPPEND         O_APPEND
130 #define FNONBLOCK       O_NONBLOCK
131 #define FNDELAY         O_NDELAY
132 #endif
133
134 /* Values for the second argument to `fcntl'.  */
135 #define F_DUPFD         0       /* Duplicate file descriptor.  */
136 #define F_GETFD         1       /* Get file descriptor flags.  */
137 #define F_SETFD         2       /* Set file descriptor flags.  */
138 #define F_GETFL         3       /* Get file status flags.  */
139 #define F_SETFL         4       /* Set file status flags.  */
140 #ifdef __USE_BSD
141 #define F_GETOWN        5       /* Get owner (receiver of SIGIO).  */
142 #define F_SETOWN        6       /* Set owner (receiver of SIGIO).  */
143 #endif
144 #define F_GETLK         7       /* Get record locking info.  */
145 #define F_SETLK         8       /* Set record locking info (non-blocking).  */
146 #define F_SETLKW        9       /* Set record locking info (blocking).  */
147
148 /* File descriptor flags used with F_GETFD and F_SETFD.  */
149 #define FD_CLOEXEC      1       /* Close on exec.  */
150
151
152 #include <gnu/types.h>
153
154 /* The structure describing an advisory lock.  This is the type of the third
155    argument to `fcntl' for the F_GETLK, F_SETLK, and F_SETLKW requests.  */
156 struct flock
157   {
158     int l_type;         /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
159     int l_whence;       /* Where `l_start' is relative to (like `lseek').  */
160     __off_t l_start;    /* Offset where the lock begins.  */
161     __off_t l_len;      /* Size of the locked area; zero means until EOF.  */
162     __pid_t l_pid;      /* Process holding the lock.  */
163   };
164
165 /* Values for the `l_type' field of a `struct flock'.  */
166 #define F_RDLCK 1       /* Read lock.  */
167 #define F_WRLCK 2       /* Write lock.  */
168 #define F_UNLCK 3       /* Remove lock.  */
169
170
171 #endif  /* fcntlbits.h */