Correct return value type __THROW marker of splice, vmsplice, and tee.
[platform/upstream/glibc.git] / sysdeps / unix / sysv / linux / powerpc / bits / fcntl.h
1 /* O_*, F_*, FD_* bit values for Linux/PowerPC.
2    Copyright (C) 1995, 1996, 1997, 1998, 2000, 2003, 2004, 2006, 2007
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 #include <sys/types.h>
26 #ifdef __USE_GNU
27 # include <bits/uio.h>
28 #endif
29
30
31 /* open/fcntl - O_SYNC is only implemented on blocks devices and on files
32    located on an ext2 file system */
33 #define O_ACCMODE         0003
34 #define O_RDONLY            00
35 #define O_WRONLY            01
36 #define O_RDWR              02
37 #define O_CREAT           0100  /* not fcntl */
38 #define O_EXCL            0200  /* not fcntl */
39 #define O_NOCTTY          0400  /* not fcntl */
40 #define O_TRUNC          01000  /* not fcntl */
41 #define O_APPEND         02000
42 #define O_NONBLOCK       04000
43 #define O_NDELAY        O_NONBLOCK
44 #define O_SYNC          010000
45 #define O_FSYNC         O_SYNC
46 #define O_ASYNC         020000
47
48 #ifdef __USE_GNU
49 # define O_DIRECT       0400000 /* Direct disk access.  */
50 # define O_DIRECTORY     040000 /* Must be a directory.  */
51 # define O_NOFOLLOW     0100000 /* Do not follow links.  */
52 # define O_NOATIME      01000000 /* Do not set atime.  */
53 # define O_CLOEXEC      02000000 /* Set close_on_exec.  */
54 #endif
55
56 #ifdef __USE_LARGEFILE64
57 # define O_LARGEFILE    0200000
58 #endif
59
60 /* For now Linux has synchronisity options for data and read operations.
61    We define the symbols here but let them do the same as O_SYNC since
62    this is a superset.  */
63 #if defined __USE_POSIX199309 || defined __USE_UNIX98
64 # define O_DSYNC        O_SYNC  /* Synchronize data.  */
65 # define O_RSYNC        O_SYNC  /* Synchronize read operations.  */
66 #endif
67
68 /* Values for the second argument to `fcntl'.  */
69 #define F_DUPFD         0       /* Duplicate file descriptor.  */
70 #define F_GETFD         1       /* Get file descriptor flags.  */
71 #define F_SETFD         2       /* Set file descriptor flags.  */
72 #define F_GETFL         3       /* Get file status flags.  */
73 #define F_SETFL         4       /* Set file status flags.  */
74 #ifndef __USE_FILE_OFFSET64
75 # define F_GETLK        5       /* Get record locking info.  */
76 # define F_SETLK        6       /* Set record locking info (non-blocking).  */
77 # define F_SETLKW       7       /* Set record locking info (blocking).  */
78 #else
79 # define F_GETLK        F_GETLK64  /* Get record locking info.  */
80 # define F_SETLK        F_SETLK64  /* Set record locking info (non-blocking).*/
81 # define F_SETLKW       F_SETLKW64 /* Set record locking info (blocking).  */
82 #endif
83 #define F_GETLK64       12      /* Get record locking info.  */
84 #define F_SETLK64       13      /* Set record locking info (non-blocking).  */
85 #define F_SETLKW64      14      /* Set record locking info (blocking).  */
86
87 #if defined __USE_BSD || defined __USE_UNIX98
88 # define F_SETOWN       8       /* Get owner of socket (receiver of SIGIO).  */
89 # define F_GETOWN       9       /* Set owner of socket (receiver of SIGIO).  */
90 #endif
91
92 #ifdef __USE_GNU
93 # define F_SETSIG       10      /* Set number of signal to be sent.  */
94 # define F_GETSIG       11      /* Get number of signal to be sent.  */
95 #endif
96
97 #ifdef __USE_GNU
98 # define F_SETLEASE     1024    /* Set a lease.  */
99 # define F_GETLEASE     1025    /* Enquire what lease is active.  */
100 # define F_NOTIFY       1026    /* Request notfications on a directory.  */
101 #endif
102
103 /* For F_[GET|SET]FD.  */
104 #define FD_CLOEXEC      1       /* actually anything with low bit set goes */
105
106 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf().  */
107 #define F_RDLCK         0       /* Read lock.  */
108 #define F_WRLCK         1       /* Write lock.  */
109 #define F_UNLCK         2       /* Remove lock.  */
110
111 /* For old implementation of bsd flock().  */
112 #define F_EXLCK         4       /* or 3 */
113 #define F_SHLCK         8       /* or 4 */
114
115 #ifdef __USE_BSD
116 /* Operations for bsd flock(), also used by the kernel implementation.  */
117 # define LOCK_SH        1       /* shared lock */
118 # define LOCK_EX        2       /* exclusive lock */
119 # define LOCK_NB        4       /* or'd with one of the above to prevent
120                                    blocking */
121 # define LOCK_UN        8       /* remove lock */
122 #endif
123
124 #ifdef __USE_GNU
125 # define LOCK_MAND      32      /* This is a mandatory flock:   */
126 # define LOCK_READ      64      /* ... which allows concurrent read operations.  */
127 # define LOCK_WRITE     128     /* ... which allows concurrent write operations.  */
128 # define LOCK_RW        192     /* ... Which allows concurrent read & write operations.  */
129 #endif
130
131 #ifdef __USE_GNU
132 /* Types of directory notifications that may be requested with F_NOTIFY.  */
133 # define DN_ACCESS      0x00000001      /* File accessed.  */
134 # define DN_MODIFY      0x00000002      /* File modified.  */
135 # define DN_CREATE      0x00000004      /* File created.  */
136 # define DN_DELETE      0x00000008      /* File removed.  */
137 # define DN_RENAME      0x00000010      /* File renamed.  */
138 # define DN_ATTRIB      0x00000020      /* File changed attibutes.  */
139 # define DN_MULTISHOT   0x80000000      /* Don't remove notifier.  */
140 #endif
141
142 struct flock
143   {
144     short int l_type;   /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
145     short int l_whence; /* Where `l_start' is relative to (like `lseek').  */
146 #ifndef __USE_FILE_OFFSET64
147     __off_t l_start;    /* Offset where the lock begins.  */
148     __off_t l_len;      /* Size of the locked area; zero means until EOF.  */
149 #else
150     __off64_t l_start;  /* Offset where the lock begins.  */
151     __off64_t l_len;    /* Size of the locked area; zero means until EOF.  */
152 #endif
153     __pid_t l_pid;      /* Process holding the lock.  */
154   };
155
156 #ifdef __USE_LARGEFILE64
157 struct flock64
158   {
159     short int l_type;   /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
160     short int l_whence; /* Where `l_start' is relative to (like `lseek').  */
161     __off64_t l_start;  /* Offset where the lock begins.  */
162     __off64_t l_len;    /* Size of the locked area; zero means until EOF.  */
163     __pid_t l_pid;      /* Process holding the lock.  */
164   };
165 #endif
166
167 /* Define some more compatibility macros to be backward compatible with
168    BSD systems which did not managed to hide these kernel macros.  */
169 #ifdef  __USE_BSD
170 # define FAPPEND        O_APPEND
171 # define FFSYNC         O_FSYNC
172 # define FASYNC         O_ASYNC
173 # define FNONBLOCK      O_NONBLOCK
174 # define FNDELAY        O_NDELAY
175 #endif /* Use BSD.  */
176
177 /* Advise to `posix_fadvise'.  */
178 #ifdef __USE_XOPEN2K
179 # define POSIX_FADV_NORMAL      0 /* No further special treatment.  */
180 # define POSIX_FADV_RANDOM      1 /* Expect random page references.  */
181 # define POSIX_FADV_SEQUENTIAL  2 /* Expect sequential page references.  */
182 # define POSIX_FADV_WILLNEED    3 /* Will need these pages.  */
183 # define POSIX_FADV_DONTNEED    4 /* Don't need these pages.  */
184 # define POSIX_FADV_NOREUSE     5 /* Data will be accessed once.  */
185 #endif
186
187
188 #ifdef __USE_GNU
189 /* Flags for SYNC_FILE_RANGE.  */
190 # define SYNC_FILE_RANGE_WAIT_BEFORE    1 /* Wait upon writeout of all pages
191                                              in the range before performing the
192                                              write.  */
193 # define SYNC_FILE_RANGE_WRITE          2 /* Initiate writeout of all those
194                                              dirty pages in the range which are
195                                              not presently under writeback.  */
196 # define SYNC_FILE_RANGE_WAIT_AFTER     4 /* Wait upon writeout of all pages in
197                                              the range after performing the
198                                              write.  */
199
200 /* Flags for SPLICE and VMSPLICE.  */
201 # define SPLICE_F_MOVE          1       /* Move pages instead of copying.  */
202 # define SPLICE_F_NONBLOCK      2       /* Don't block on the pipe splicing
203                                            (but we may still block on the fd
204                                            we splice from/to).  */
205 # define SPLICE_F_MORE          4       /* Expect more data.  */
206 # define SPLICE_F_GIFT          8       /* Pages passed in are a gift.  */
207 #endif
208
209 __BEGIN_DECLS
210
211 #ifdef __USE_GNU
212
213 /* Provide kernel hint to read ahead.  */
214 extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
215     __THROW;
216
217
218 /* Selective file content synch'ing.  */
219 extern int sync_file_range (int __fd, __off64_t __from, __off64_t __to,
220                             unsigned int __flags);
221
222
223 /* Splice address range into a pipe.  */
224 extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
225                          size_t __count, unsigned int __flags);
226
227 /* Splice two files together.  */
228 extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
229                        __off64_t *__offout, size_t __len,
230                        unsigned int __flags);
231
232 /* In-kernel implementation of tee for pipe buffers.  */
233 extern ssize_t tee (int __fdin, int __fdout, size_t __len,
234                     unsigned int __flags);
235
236 #endif
237
238 __END_DECLS