]>
Commit | Line | Data |
---|---|---|
28f540f4 | 1 | @node Low-Level I/O, File System Interface, I/O on Streams, Top |
7a68c94a | 2 | @c %MENU% Low-level, less portable I/O |
28f540f4 RM |
3 | @chapter Low-Level Input/Output |
4 | ||
5 | This chapter describes functions for performing low-level input/output | |
6 | operations on file descriptors. These functions include the primitives | |
7 | for the higher-level I/O functions described in @ref{I/O on Streams}, as | |
8 | well as functions for performing low-level control operations for which | |
9 | there are no equivalents on streams. | |
10 | ||
11 | Stream-level I/O is more flexible and usually more convenient; | |
12 | therefore, programmers generally use the descriptor-level functions only | |
13 | when necessary. These are some of the usual reasons: | |
14 | ||
15 | @itemize @bullet | |
16 | @item | |
17 | For reading binary files in large chunks. | |
18 | ||
19 | @item | |
20 | For reading an entire file into core before parsing it. | |
21 | ||
22 | @item | |
23 | To perform operations other than data transfer, which can only be done | |
24 | with a descriptor. (You can use @code{fileno} to get the descriptor | |
25 | corresponding to a stream.) | |
26 | ||
27 | @item | |
28 | To pass descriptors to a child process. (The child can create its own | |
29 | stream to use a descriptor that it inherits, but cannot inherit a stream | |
30 | directly.) | |
31 | @end itemize | |
32 | ||
33 | @menu | |
34 | * Opening and Closing Files:: How to open and close file | |
2c6fe0bd | 35 | descriptors. |
28f540f4 RM |
36 | * I/O Primitives:: Reading and writing data. |
37 | * File Position Primitive:: Setting a descriptor's file | |
2c6fe0bd | 38 | position. |
28f540f4 RM |
39 | * Descriptors and Streams:: Converting descriptor to stream |
40 | or vice-versa. | |
41 | * Stream/Descriptor Precautions:: Precautions needed if you use both | |
42 | descriptors and streams. | |
49c091e5 | 43 | * Scatter-Gather:: Fast I/O to discontinuous buffers. |
bad7a0c8 | 44 | * Copying File Data:: Copying data between files. |
07435eb4 | 45 | * Memory-mapped I/O:: Using files like memory. |
28f540f4 RM |
46 | * Waiting for I/O:: How to check for input or output |
47 | on multiple file descriptors. | |
dfd2257a | 48 | * Synchronizing I/O:: Making sure all I/O actions completed. |
b07d03e0 | 49 | * Asynchronous I/O:: Perform I/O in parallel. |
28f540f4 RM |
50 | * Control Operations:: Various other operations on file |
51 | descriptors. | |
52 | * Duplicating Descriptors:: Fcntl commands for duplicating | |
53 | file descriptors. | |
54 | * Descriptor Flags:: Fcntl commands for manipulating | |
55 | flags associated with file | |
2c6fe0bd | 56 | descriptors. |
28f540f4 RM |
57 | * File Status Flags:: Fcntl commands for manipulating |
58 | flags associated with open files. | |
59 | * File Locks:: Fcntl commands for implementing | |
60 | file locking. | |
0961f7e1 JL |
61 | * Open File Description Locks:: Fcntl commands for implementing |
62 | open file description locking. | |
63 | * Open File Description Locks Example:: An example of open file description lock | |
64 | usage | |
28f540f4 RM |
65 | * Interrupt Input:: Getting an asynchronous signal when |
66 | input arrives. | |
07435eb4 | 67 | * IOCTLs:: Generic I/O Control operations. |
28f540f4 RM |
68 | @end menu |
69 | ||
70 | ||
71 | @node Opening and Closing Files | |
72 | @section Opening and Closing Files | |
73 | ||
74 | @cindex opening a file descriptor | |
75 | @cindex closing a file descriptor | |
76 | This section describes the primitives for opening and closing files | |
77 | using file descriptors. The @code{open} and @code{creat} functions are | |
78 | declared in the header file @file{fcntl.h}, while @code{close} is | |
79 | declared in @file{unistd.h}. | |
80 | @pindex unistd.h | |
81 | @pindex fcntl.h | |
82 | ||
28f540f4 | 83 | @deftypefun int open (const char *@var{filename}, int @var{flags}[, mode_t @var{mode}]) |
d08a7e4c | 84 | @standards{POSIX.1, fcntl.h} |
2cc3615c | 85 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} |
624254b1 SC |
86 | The @code{open} function creates and returns a new file descriptor for |
87 | the file named by @var{filename}. Initially, the file position | |
28f540f4 | 88 | indicator for the file is at the beginning of the file. The argument |
624254b1 SC |
89 | @var{mode} (@pxref{Permission Bits}) is used only when a file is |
90 | created, but it doesn't hurt to supply the argument in any case. | |
28f540f4 RM |
91 | |
92 | The @var{flags} argument controls how the file is to be opened. This is | |
93 | a bit mask; you create the value by the bitwise OR of the appropriate | |
94 | parameters (using the @samp{|} operator in C). | |
95 | @xref{File Status Flags}, for the parameters available. | |
96 | ||
97 | The normal return value from @code{open} is a non-negative integer file | |
07435eb4 | 98 | descriptor. In the case of an error, a value of @math{-1} is returned |
28f540f4 RM |
99 | instead. In addition to the usual file name errors (@pxref{File |
100 | Name Errors}), the following @code{errno} error conditions are defined | |
101 | for this function: | |
102 | ||
103 | @table @code | |
104 | @item EACCES | |
19e4c7dd | 105 | The file exists but is not readable/writable as requested by the @var{flags} |
9739d2d5 | 106 | argument, or the file does not exist and the directory is unwritable so |
28f540f4 RM |
107 | it cannot be created. |
108 | ||
109 | @item EEXIST | |
110 | Both @code{O_CREAT} and @code{O_EXCL} are set, and the named file already | |
111 | exists. | |
112 | ||
113 | @item EINTR | |
114 | The @code{open} operation was interrupted by a signal. | |
115 | @xref{Interrupted Primitives}. | |
116 | ||
117 | @item EISDIR | |
118 | The @var{flags} argument specified write access, and the file is a directory. | |
119 | ||
120 | @item EMFILE | |
121 | The process has too many files open. | |
122 | The maximum number of file descriptors is controlled by the | |
123 | @code{RLIMIT_NOFILE} resource limit; @pxref{Limits on Resources}. | |
124 | ||
125 | @item ENFILE | |
126 | The entire system, or perhaps the file system which contains the | |
127 | directory, cannot support any additional open files at the moment. | |
a7a93d50 | 128 | (This problem cannot happen on @gnuhurdsystems{}.) |
28f540f4 RM |
129 | |
130 | @item ENOENT | |
131 | The named file does not exist, and @code{O_CREAT} is not specified. | |
132 | ||
133 | @item ENOSPC | |
134 | The directory or file system that would contain the new file cannot be | |
135 | extended, because there is no disk space left. | |
136 | ||
137 | @item ENXIO | |
138 | @code{O_NONBLOCK} and @code{O_WRONLY} are both set in the @var{flags} | |
139 | argument, the file named by @var{filename} is a FIFO (@pxref{Pipes and | |
140 | FIFOs}), and no process has the file open for reading. | |
141 | ||
142 | @item EROFS | |
143 | The file resides on a read-only file system and any of @w{@code{O_WRONLY}}, | |
144 | @code{O_RDWR}, and @code{O_TRUNC} are set in the @var{flags} argument, | |
145 | or @code{O_CREAT} is set and the file does not already exist. | |
146 | @end table | |
147 | ||
148 | @c !!! umask | |
149 | ||
04b9968b | 150 | If on a 32 bit machine the sources are translated with |
b07d03e0 UD |
151 | @code{_FILE_OFFSET_BITS == 64} the function @code{open} returns a file |
152 | descriptor opened in the large file mode which enables the file handling | |
9ceeb279 OB |
153 | functions to use files up to @twoexp{63} bytes in size and offset from |
154 | @minus{}@twoexp{63} to @twoexp{63}. This happens transparently for the user | |
9739d2d5 | 155 | since all of the low-level file handling functions are equally replaced. |
b07d03e0 | 156 | |
04b9968b | 157 | This function is a cancellation point in multi-threaded programs. This |
dfd2257a UD |
158 | is a problem if the thread allocates some resources (like memory, file |
159 | descriptors, semaphores or whatever) at the time @code{open} is | |
19e4c7dd | 160 | called. If the thread gets canceled these resources stay allocated |
dfd2257a | 161 | until the program ends. To avoid this calls to @code{open} should be |
04b9968b | 162 | protected using cancellation handlers. |
dfd2257a UD |
163 | @c ref pthread_cleanup_push / pthread_cleanup_pop |
164 | ||
28f540f4 RM |
165 | The @code{open} function is the underlying primitive for the @code{fopen} |
166 | and @code{freopen} functions, that create streams. | |
167 | @end deftypefun | |
168 | ||
b07d03e0 | 169 | @deftypefun int open64 (const char *@var{filename}, int @var{flags}[, mode_t @var{mode}]) |
d08a7e4c | 170 | @standards{Unix98, fcntl.h} |
2cc3615c | 171 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} |
b07d03e0 UD |
172 | This function is similar to @code{open}. It returns a file descriptor |
173 | which can be used to access the file named by @var{filename}. The only | |
04b9968b | 174 | difference is that on 32 bit systems the file is opened in the |
b07d03e0 UD |
175 | large file mode. I.e., file length and file offsets can exceed 31 bits. |
176 | ||
b07d03e0 UD |
177 | When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this |
178 | function is actually available under the name @code{open}. I.e., the | |
179 | new, extended API using 64 bit file sizes and offsets transparently | |
180 | replaces the old API. | |
181 | @end deftypefun | |
182 | ||
28f540f4 | 183 | @deftypefn {Obsolete function} int creat (const char *@var{filename}, mode_t @var{mode}) |
d08a7e4c | 184 | @standards{POSIX.1, fcntl.h} |
2cc3615c | 185 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} |
28f540f4 RM |
186 | This function is obsolete. The call: |
187 | ||
188 | @smallexample | |
189 | creat (@var{filename}, @var{mode}) | |
190 | @end smallexample | |
191 | ||
192 | @noindent | |
193 | is equivalent to: | |
194 | ||
195 | @smallexample | |
196 | open (@var{filename}, O_WRONLY | O_CREAT | O_TRUNC, @var{mode}) | |
197 | @end smallexample | |
b07d03e0 | 198 | |
04b9968b | 199 | If on a 32 bit machine the sources are translated with |
b07d03e0 UD |
200 | @code{_FILE_OFFSET_BITS == 64} the function @code{creat} returns a file |
201 | descriptor opened in the large file mode which enables the file handling | |
9ceeb279 OB |
202 | functions to use files up to @twoexp{63} in size and offset from |
203 | @minus{}@twoexp{63} to @twoexp{63}. This happens transparently for the user | |
9739d2d5 | 204 | since all of the low-level file handling functions are equally replaced. |
b07d03e0 UD |
205 | @end deftypefn |
206 | ||
b07d03e0 | 207 | @deftypefn {Obsolete function} int creat64 (const char *@var{filename}, mode_t @var{mode}) |
d08a7e4c | 208 | @standards{Unix98, fcntl.h} |
2cc3615c | 209 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} |
b07d03e0 UD |
210 | This function is similar to @code{creat}. It returns a file descriptor |
211 | which can be used to access the file named by @var{filename}. The only | |
9739d2d5 | 212 | difference is that on 32 bit systems the file is opened in the |
b07d03e0 UD |
213 | large file mode. I.e., file length and file offsets can exceed 31 bits. |
214 | ||
215 | To use this file descriptor one must not use the normal operations but | |
216 | instead the counterparts named @code{*64}, e.g., @code{read64}. | |
217 | ||
218 | When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this | |
219 | function is actually available under the name @code{open}. I.e., the | |
220 | new, extended API using 64 bit file sizes and offsets transparently | |
221 | replaces the old API. | |
28f540f4 RM |
222 | @end deftypefn |
223 | ||
28f540f4 | 224 | @deftypefun int close (int @var{filedes}) |
d08a7e4c | 225 | @standards{POSIX.1, unistd.h} |
2cc3615c | 226 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} |
28f540f4 RM |
227 | The function @code{close} closes the file descriptor @var{filedes}. |
228 | Closing a file has the following consequences: | |
229 | ||
230 | @itemize @bullet | |
2c6fe0bd | 231 | @item |
28f540f4 RM |
232 | The file descriptor is deallocated. |
233 | ||
234 | @item | |
235 | Any record locks owned by the process on the file are unlocked. | |
236 | ||
237 | @item | |
238 | When all file descriptors associated with a pipe or FIFO have been closed, | |
239 | any unread data is discarded. | |
240 | @end itemize | |
241 | ||
04b9968b | 242 | This function is a cancellation point in multi-threaded programs. This |
dfd2257a UD |
243 | is a problem if the thread allocates some resources (like memory, file |
244 | descriptors, semaphores or whatever) at the time @code{close} is | |
19e4c7dd | 245 | called. If the thread gets canceled these resources stay allocated |
04b9968b UD |
246 | until the program ends. To avoid this, calls to @code{close} should be |
247 | protected using cancellation handlers. | |
dfd2257a UD |
248 | @c ref pthread_cleanup_push / pthread_cleanup_pop |
249 | ||
07435eb4 | 250 | The normal return value from @code{close} is @math{0}; a value of @math{-1} |
28f540f4 RM |
251 | is returned in case of failure. The following @code{errno} error |
252 | conditions are defined for this function: | |
253 | ||
254 | @table @code | |
255 | @item EBADF | |
256 | The @var{filedes} argument is not a valid file descriptor. | |
257 | ||
258 | @item EINTR | |
259 | The @code{close} call was interrupted by a signal. | |
260 | @xref{Interrupted Primitives}. | |
261 | Here is an example of how to handle @code{EINTR} properly: | |
262 | ||
263 | @smallexample | |
264 | TEMP_FAILURE_RETRY (close (desc)); | |
265 | @end smallexample | |
266 | ||
267 | @item ENOSPC | |
268 | @itemx EIO | |
269 | @itemx EDQUOT | |
2c6fe0bd | 270 | When the file is accessed by NFS, these errors from @code{write} can sometimes |
28f540f4 RM |
271 | not be detected until @code{close}. @xref{I/O Primitives}, for details |
272 | on their meaning. | |
273 | @end table | |
b07d03e0 UD |
274 | |
275 | Please note that there is @emph{no} separate @code{close64} function. | |
276 | This is not necessary since this function does not determine nor depend | |
fed8f7f7 | 277 | on the mode of the file. The kernel which performs the @code{close} |
04b9968b | 278 | operation knows which mode the descriptor is used for and can handle |
b07d03e0 | 279 | this situation. |
28f540f4 RM |
280 | @end deftypefun |
281 | ||
282 | To close a stream, call @code{fclose} (@pxref{Closing Streams}) instead | |
283 | of trying to close its underlying file descriptor with @code{close}. | |
284 | This flushes any buffered output and updates the stream object to | |
285 | indicate that it is closed. | |
286 | ||
28628628 AZ |
287 | @deftypefun int close_range (unsigned int @var{lowfd}, unsigned int @var{maxfd}, int @var{flags}) |
288 | @standards{Linux, unistd.h} | |
289 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} | |
290 | @c This is a syscall for Linux v5.9. There is no fallback emulation for | |
291 | @c older kernels. | |
292 | ||
293 | The function @code{close_range} closes the file descriptor from @var{lowfd} | |
294 | to @var{maxfd} (inclusive). This function is similar to call @code{close} in | |
295 | specified file descriptor range depending on the @var{flags}. | |
296 | ||
297 | This is function is only supported on recent Linux versions and @theglibc{} | |
298 | does not provide any fallback (the application will need to handle possible | |
299 | @code{ENOSYS}). | |
300 | ||
301 | The @var{flags} add options on how the files are closes. Linux currently | |
302 | supports: | |
303 | ||
304 | @vtable @code | |
305 | @item CLOSE_RANGE_UNSHARE | |
306 | Unshare the file descriptor table before closing file descriptors. | |
307 | ||
308 | @item CLOSE_RANGE_CLOEXEC | |
309 | Set the @code{FD_CLOEXEC} bit instead of closing the file descriptor. | |
310 | @end vtable | |
311 | ||
312 | The normal return value from @code{close_range} is @math{0}; a value | |
313 | of @math{-1} is returned in case of failure. The following @code{errno} error | |
314 | conditions are defined for this function: | |
315 | ||
316 | @table @code | |
317 | @item EINVAL | |
318 | The @var{lowfd} value is larger than @var{maxfd} or an unsupported @var{flags} | |
319 | is used. | |
320 | ||
321 | @item ENOMEM | |
322 | Either there is not enough memory for the operation, or the process is | |
64d9ebae | 323 | out of address space. It can only happen when @code{CLOSE_RANGE_UNSHARED} |
28628628 AZ |
324 | flag is used. |
325 | ||
326 | @item EMFILE | |
327 | The process has too many files open and it can only happens when | |
328 | @code{CLOSE_RANGE_UNSHARED} flag is used. | |
329 | The maximum number of file descriptors is controlled by the | |
330 | @code{RLIMIT_NOFILE} resource limit; @pxref{Limits on Resources}. | |
331 | ||
332 | @item ENOSYS | |
333 | The kernel does not implement the required functionality. | |
334 | @end table | |
335 | @end deftypefun | |
336 | ||
60744950 AZ |
337 | @deftypefun void closefrom (int @var{lowfd}) |
338 | @standards{GNU, unistd.h} | |
339 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} | |
340 | ||
5aa359d3 MK |
341 | The function @code{closefrom} closes all file descriptors greater than or equal |
342 | to @var{lowfd}. This function is similar to calling | |
60744950 AZ |
343 | @code{close} for all open file descriptors not less than @var{lowfd}. |
344 | ||
345 | Already closed file descriptors are ignored. | |
346 | @end deftypefun | |
28628628 | 347 | |
28f540f4 RM |
348 | @node I/O Primitives |
349 | @section Input and Output Primitives | |
350 | ||
351 | This section describes the functions for performing primitive input and | |
352 | output operations on file descriptors: @code{read}, @code{write}, and | |
353 | @code{lseek}. These functions are declared in the header file | |
354 | @file{unistd.h}. | |
355 | @pindex unistd.h | |
356 | ||
28f540f4 | 357 | @deftp {Data Type} ssize_t |
d08a7e4c | 358 | @standards{POSIX.1, unistd.h} |
28f540f4 RM |
359 | This data type is used to represent the sizes of blocks that can be |
360 | read or written in a single operation. It is similar to @code{size_t}, | |
361 | but must be a signed type. | |
362 | @end deftp | |
363 | ||
364 | @cindex reading from a file descriptor | |
28f540f4 | 365 | @deftypefun ssize_t read (int @var{filedes}, void *@var{buffer}, size_t @var{size}) |
d08a7e4c | 366 | @standards{POSIX.1, unistd.h} |
2cc3615c | 367 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
28f540f4 RM |
368 | The @code{read} function reads up to @var{size} bytes from the file |
369 | with descriptor @var{filedes}, storing the results in the @var{buffer}. | |
04b9968b UD |
370 | (This is not necessarily a character string, and no terminating null |
371 | character is added.) | |
28f540f4 RM |
372 | |
373 | @cindex end-of-file, on a file descriptor | |
374 | The return value is the number of bytes actually read. This might be | |
375 | less than @var{size}; for example, if there aren't that many bytes left | |
376 | in the file or if there aren't that many bytes immediately available. | |
377 | The exact behavior depends on what kind of file it is. Note that | |
378 | reading less than @var{size} bytes is not an error. | |
379 | ||
380 | A value of zero indicates end-of-file (except if the value of the | |
381 | @var{size} argument is also zero). This is not considered an error. | |
382 | If you keep calling @code{read} while at end-of-file, it will keep | |
383 | returning zero and doing nothing else. | |
384 | ||
385 | If @code{read} returns at least one character, there is no way you can | |
386 | tell whether end-of-file was reached. But if you did reach the end, the | |
387 | next read will return zero. | |
388 | ||
07435eb4 | 389 | In case of an error, @code{read} returns @math{-1}. The following |
28f540f4 RM |
390 | @code{errno} error conditions are defined for this function: |
391 | ||
392 | @table @code | |
393 | @item EAGAIN | |
394 | Normally, when no input is immediately available, @code{read} waits for | |
395 | some input. But if the @code{O_NONBLOCK} flag is set for the file | |
396 | (@pxref{File Status Flags}), @code{read} returns immediately without | |
397 | reading any data, and reports this error. | |
398 | ||
399 | @strong{Compatibility Note:} Most versions of BSD Unix use a different | |
1f77f049 | 400 | error code for this: @code{EWOULDBLOCK}. In @theglibc{}, |
28f540f4 RM |
401 | @code{EWOULDBLOCK} is an alias for @code{EAGAIN}, so it doesn't matter |
402 | which name you use. | |
403 | ||
404 | On some systems, reading a large amount of data from a character special | |
405 | file can also fail with @code{EAGAIN} if the kernel cannot find enough | |
406 | physical memory to lock down the user's pages. This is limited to | |
407 | devices that transfer with direct memory access into the user's memory, | |
408 | which means it does not include terminals, since they always use | |
a7a93d50 JM |
409 | separate buffers inside the kernel. This problem never happens on |
410 | @gnuhurdsystems{}. | |
28f540f4 RM |
411 | |
412 | Any condition that could result in @code{EAGAIN} can instead result in a | |
413 | successful @code{read} which returns fewer bytes than requested. | |
414 | Calling @code{read} again immediately would result in @code{EAGAIN}. | |
415 | ||
416 | @item EBADF | |
417 | The @var{filedes} argument is not a valid file descriptor, | |
418 | or is not open for reading. | |
419 | ||
420 | @item EINTR | |
421 | @code{read} was interrupted by a signal while it was waiting for input. | |
9739d2d5 | 422 | @xref{Interrupted Primitives}. A signal will not necessarily cause |
28f540f4 RM |
423 | @code{read} to return @code{EINTR}; it may instead result in a |
424 | successful @code{read} which returns fewer bytes than requested. | |
425 | ||
426 | @item EIO | |
427 | For many devices, and for disk files, this error code indicates | |
428 | a hardware error. | |
429 | ||
430 | @code{EIO} also occurs when a background process tries to read from the | |
431 | controlling terminal, and the normal action of stopping the process by | |
432 | sending it a @code{SIGTTIN} signal isn't working. This might happen if | |
04b9968b | 433 | the signal is being blocked or ignored, or because the process group is |
28f540f4 RM |
434 | orphaned. @xref{Job Control}, for more information about job control, |
435 | and @ref{Signal Handling}, for information about signals. | |
7e583a52 RM |
436 | |
437 | @item EINVAL | |
438 | In some systems, when reading from a character or block device, position | |
439 | and size offsets must be aligned to a particular block size. This error | |
440 | indicates that the offsets were not properly aligned. | |
28f540f4 RM |
441 | @end table |
442 | ||
b07d03e0 UD |
443 | Please note that there is no function named @code{read64}. This is not |
444 | necessary since this function does not directly modify or handle the | |
445 | possibly wide file offset. Since the kernel handles this state | |
04b9968b | 446 | internally, the @code{read} function can be used for all cases. |
b07d03e0 | 447 | |
04b9968b | 448 | This function is a cancellation point in multi-threaded programs. This |
dfd2257a UD |
449 | is a problem if the thread allocates some resources (like memory, file |
450 | descriptors, semaphores or whatever) at the time @code{read} is | |
19e4c7dd | 451 | called. If the thread gets canceled these resources stay allocated |
04b9968b UD |
452 | until the program ends. To avoid this, calls to @code{read} should be |
453 | protected using cancellation handlers. | |
dfd2257a UD |
454 | @c ref pthread_cleanup_push / pthread_cleanup_pop |
455 | ||
28f540f4 RM |
456 | The @code{read} function is the underlying primitive for all of the |
457 | functions that read from streams, such as @code{fgetc}. | |
458 | @end deftypefun | |
459 | ||
a5a0310d | 460 | @deftypefun ssize_t pread (int @var{filedes}, void *@var{buffer}, size_t @var{size}, off_t @var{offset}) |
d08a7e4c | 461 | @standards{Unix98, unistd.h} |
2cc3615c AO |
462 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
463 | @c This is usually a safe syscall. The sysdeps/posix fallback emulation | |
464 | @c is not MT-Safe because it uses lseek, read and lseek back, but is it | |
465 | @c used anywhere? | |
a5a0310d | 466 | The @code{pread} function is similar to the @code{read} function. The |
04b9968b UD |
467 | first three arguments are identical, and the return values and error |
468 | codes also correspond. | |
a5a0310d UD |
469 | |
470 | The difference is the fourth argument and its handling. The data block | |
471 | is not read from the current position of the file descriptor | |
472 | @code{filedes}. Instead the data is read from the file starting at | |
473 | position @var{offset}. The position of the file descriptor itself is | |
04b9968b | 474 | not affected by the operation. The value is the same as before the call. |
a5a0310d | 475 | |
b07d03e0 UD |
476 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the |
477 | @code{pread} function is in fact @code{pread64} and the type | |
04b9968b | 478 | @code{off_t} has 64 bits, which makes it possible to handle files up to |
9ceeb279 | 479 | @twoexp{63} bytes in length. |
b07d03e0 | 480 | |
a5a0310d UD |
481 | The return value of @code{pread} describes the number of bytes read. |
482 | In the error case it returns @math{-1} like @code{read} does and the | |
04b9968b UD |
483 | error codes are also the same, with these additions: |
484 | ||
a5a0310d UD |
485 | @table @code |
486 | @item EINVAL | |
487 | The value given for @var{offset} is negative and therefore illegal. | |
488 | ||
489 | @item ESPIPE | |
9739d2d5 | 490 | The file descriptor @var{filedes} is associated with a pipe or a FIFO and |
a5a0310d UD |
491 | this device does not allow positioning of the file pointer. |
492 | @end table | |
493 | ||
494 | The function is an extension defined in the Unix Single Specification | |
495 | version 2. | |
496 | @end deftypefun | |
497 | ||
b07d03e0 | 498 | @deftypefun ssize_t pread64 (int @var{filedes}, void *@var{buffer}, size_t @var{size}, off64_t @var{offset}) |
d08a7e4c | 499 | @standards{Unix98, unistd.h} |
2cc3615c AO |
500 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
501 | @c This is usually a safe syscall. The sysdeps/posix fallback emulation | |
502 | @c is not MT-Safe because it uses lseek64, read and lseek64 back, but is | |
503 | @c it used anywhere? | |
b07d03e0 UD |
504 | This function is similar to the @code{pread} function. The difference |
505 | is that the @var{offset} parameter is of type @code{off64_t} instead of | |
04b9968b | 506 | @code{off_t} which makes it possible on 32 bit machines to address |
9ceeb279 | 507 | files larger than @twoexp{31} bytes and up to @twoexp{63} bytes. The |
b07d03e0 UD |
508 | file descriptor @code{filedes} must be opened using @code{open64} since |
509 | otherwise the large offsets possible with @code{off64_t} will lead to | |
510 | errors with a descriptor in small file mode. | |
511 | ||
c756c71c | 512 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a |
04b9968b UD |
513 | 32 bit machine this function is actually available under the name |
514 | @code{pread} and so transparently replaces the 32 bit interface. | |
b07d03e0 UD |
515 | @end deftypefun |
516 | ||
28f540f4 | 517 | @cindex writing to a file descriptor |
28f540f4 | 518 | @deftypefun ssize_t write (int @var{filedes}, const void *@var{buffer}, size_t @var{size}) |
d08a7e4c | 519 | @standards{POSIX.1, unistd.h} |
2cc3615c | 520 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
0c6891a0 CD |
521 | @c Some say write is thread-unsafe on Linux without O_APPEND. In the VFS layer |
522 | @c the vfs_write() does no locking around the acquisition of a file offset and | |
523 | @c therefore multiple threads / kernel tasks may race and get the same offset | |
524 | @c resulting in data loss. | |
525 | @c | |
526 | @c See: | |
527 | @c http://thread.gmane.org/gmane.linux.kernel/397980 | |
528 | @c http://lwn.net/Articles/180387/ | |
529 | @c | |
530 | @c The counter argument is that POSIX only says that the write starts at the | |
531 | @c file position and that the file position is updated *before* the function | |
532 | @c returns. What that really means is that any expectation of atomic writes is | |
533 | @c strictly an invention of the interpretation of the reader. Data loss could | |
534 | @c happen if two threads start the write at the same time. Only writes that | |
535 | @c come after the return of another write are guaranteed to follow the other | |
536 | @c write. | |
537 | @c | |
538 | @c The other side of the coin is that POSIX goes on further to say in | |
539 | @c "2.9.7 Thread Interactions with Regular File Operations" that threads | |
540 | @c should never see interleaving sets of file operations, but it is insane | |
541 | @c to do anything like that because it kills performance, so you don't get | |
542 | @c those guarantees in Linux. | |
543 | @c | |
544 | @c So we mark it thread safe, it doesn't blow up, but you might loose | |
545 | @c data, and we don't strictly meet the POSIX requirements. | |
a2887bdb CD |
546 | @c |
547 | @c The fix for file offsets racing was merged in 3.14, the commits were: | |
548 | @c 9c225f2655e36a470c4f58dbbc99244c5fc7f2d4, and | |
549 | @c d7a15f8d0777955986a2ab00ab181795cab14b01. Therefore after Linux 3.14 you | |
550 | @c should get mostly MT-safe writes. | |
28f540f4 RM |
551 | The @code{write} function writes up to @var{size} bytes from |
552 | @var{buffer} to the file with descriptor @var{filedes}. The data in | |
553 | @var{buffer} is not necessarily a character string and a null character is | |
554 | output like any other character. | |
555 | ||
556 | The return value is the number of bytes actually written. This may be | |
557 | @var{size}, but can always be smaller. Your program should always call | |
558 | @code{write} in a loop, iterating until all the data is written. | |
559 | ||
560 | Once @code{write} returns, the data is enqueued to be written and can be | |
561 | read back right away, but it is not necessarily written out to permanent | |
562 | storage immediately. You can use @code{fsync} when you need to be sure | |
563 | your data has been permanently stored before continuing. (It is more | |
564 | efficient for the system to batch up consecutive writes and do them all | |
565 | at once when convenient. Normally they will always be written to disk | |
a5a0310d UD |
566 | within a minute or less.) Modern systems provide another function |
567 | @code{fdatasync} which guarantees integrity only for the file data and | |
568 | is therefore faster. | |
569 | @c !!! xref fsync, fdatasync | |
2c6fe0bd | 570 | You can use the @code{O_FSYNC} open mode to make @code{write} always |
28f540f4 RM |
571 | store the data to disk before returning; @pxref{Operating Modes}. |
572 | ||
07435eb4 | 573 | In the case of an error, @code{write} returns @math{-1}. The following |
28f540f4 RM |
574 | @code{errno} error conditions are defined for this function: |
575 | ||
576 | @table @code | |
577 | @item EAGAIN | |
578 | Normally, @code{write} blocks until the write operation is complete. | |
579 | But if the @code{O_NONBLOCK} flag is set for the file (@pxref{Control | |
04b9968b | 580 | Operations}), it returns immediately without writing any data and |
28f540f4 RM |
581 | reports this error. An example of a situation that might cause the |
582 | process to block on output is writing to a terminal device that supports | |
583 | flow control, where output has been suspended by receipt of a STOP | |
584 | character. | |
585 | ||
586 | @strong{Compatibility Note:} Most versions of BSD Unix use a different | |
1f77f049 | 587 | error code for this: @code{EWOULDBLOCK}. In @theglibc{}, |
28f540f4 RM |
588 | @code{EWOULDBLOCK} is an alias for @code{EAGAIN}, so it doesn't matter |
589 | which name you use. | |
590 | ||
591 | On some systems, writing a large amount of data from a character special | |
592 | file can also fail with @code{EAGAIN} if the kernel cannot find enough | |
593 | physical memory to lock down the user's pages. This is limited to | |
594 | devices that transfer with direct memory access into the user's memory, | |
595 | which means it does not include terminals, since they always use | |
a7a93d50 JM |
596 | separate buffers inside the kernel. This problem does not arise on |
597 | @gnuhurdsystems{}. | |
28f540f4 RM |
598 | |
599 | @item EBADF | |
600 | The @var{filedes} argument is not a valid file descriptor, | |
601 | or is not open for writing. | |
602 | ||
603 | @item EFBIG | |
604 | The size of the file would become larger than the implementation can support. | |
605 | ||
606 | @item EINTR | |
607 | The @code{write} operation was interrupted by a signal while it was | |
04b9968b | 608 | blocked waiting for completion. A signal will not necessarily cause |
28f540f4 RM |
609 | @code{write} to return @code{EINTR}; it may instead result in a |
610 | successful @code{write} which writes fewer bytes than requested. | |
611 | @xref{Interrupted Primitives}. | |
612 | ||
613 | @item EIO | |
614 | For many devices, and for disk files, this error code indicates | |
615 | a hardware error. | |
616 | ||
617 | @item ENOSPC | |
618 | The device containing the file is full. | |
619 | ||
620 | @item EPIPE | |
621 | This error is returned when you try to write to a pipe or FIFO that | |
622 | isn't open for reading by any process. When this happens, a @code{SIGPIPE} | |
623 | signal is also sent to the process; see @ref{Signal Handling}. | |
7e583a52 RM |
624 | |
625 | @item EINVAL | |
626 | In some systems, when writing to a character or block device, position | |
627 | and size offsets must be aligned to a particular block size. This error | |
628 | indicates that the offsets were not properly aligned. | |
28f540f4 RM |
629 | @end table |
630 | ||
631 | Unless you have arranged to prevent @code{EINTR} failures, you should | |
632 | check @code{errno} after each failing call to @code{write}, and if the | |
633 | error was @code{EINTR}, you should simply repeat the call. | |
634 | @xref{Interrupted Primitives}. The easy way to do this is with the | |
635 | macro @code{TEMP_FAILURE_RETRY}, as follows: | |
636 | ||
637 | @smallexample | |
638 | nbytes = TEMP_FAILURE_RETRY (write (desc, buffer, count)); | |
639 | @end smallexample | |
640 | ||
b07d03e0 UD |
641 | Please note that there is no function named @code{write64}. This is not |
642 | necessary since this function does not directly modify or handle the | |
643 | possibly wide file offset. Since the kernel handles this state | |
644 | internally the @code{write} function can be used for all cases. | |
645 | ||
04b9968b | 646 | This function is a cancellation point in multi-threaded programs. This |
dfd2257a UD |
647 | is a problem if the thread allocates some resources (like memory, file |
648 | descriptors, semaphores or whatever) at the time @code{write} is | |
19e4c7dd | 649 | called. If the thread gets canceled these resources stay allocated |
04b9968b UD |
650 | until the program ends. To avoid this, calls to @code{write} should be |
651 | protected using cancellation handlers. | |
dfd2257a UD |
652 | @c ref pthread_cleanup_push / pthread_cleanup_pop |
653 | ||
28f540f4 RM |
654 | The @code{write} function is the underlying primitive for all of the |
655 | functions that write to streams, such as @code{fputc}. | |
656 | @end deftypefun | |
657 | ||
a5a0310d | 658 | @deftypefun ssize_t pwrite (int @var{filedes}, const void *@var{buffer}, size_t @var{size}, off_t @var{offset}) |
d08a7e4c | 659 | @standards{Unix98, unistd.h} |
2cc3615c AO |
660 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
661 | @c This is usually a safe syscall. The sysdeps/posix fallback emulation | |
662 | @c is not MT-Safe because it uses lseek, write and lseek back, but is it | |
663 | @c used anywhere? | |
a5a0310d | 664 | The @code{pwrite} function is similar to the @code{write} function. The |
04b9968b UD |
665 | first three arguments are identical, and the return values and error codes |
666 | also correspond. | |
a5a0310d UD |
667 | |
668 | The difference is the fourth argument and its handling. The data block | |
669 | is not written to the current position of the file descriptor | |
670 | @code{filedes}. Instead the data is written to the file starting at | |
671 | position @var{offset}. The position of the file descriptor itself is | |
04b9968b | 672 | not affected by the operation. The value is the same as before the call. |
a5a0310d | 673 | |
717da4b3 AZ |
674 | However, on Linux, if a file is opened with @code{O_APPEND}, @code{pwrite} |
675 | appends data to the end of the file, regardless of the value of | |
676 | @code{offset}. | |
677 | ||
b07d03e0 UD |
678 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the |
679 | @code{pwrite} function is in fact @code{pwrite64} and the type | |
04b9968b | 680 | @code{off_t} has 64 bits, which makes it possible to handle files up to |
9ceeb279 | 681 | @twoexp{63} bytes in length. |
b07d03e0 | 682 | |
a5a0310d UD |
683 | The return value of @code{pwrite} describes the number of written bytes. |
684 | In the error case it returns @math{-1} like @code{write} does and the | |
04b9968b UD |
685 | error codes are also the same, with these additions: |
686 | ||
a5a0310d UD |
687 | @table @code |
688 | @item EINVAL | |
689 | The value given for @var{offset} is negative and therefore illegal. | |
690 | ||
691 | @item ESPIPE | |
04b9968b | 692 | The file descriptor @var{filedes} is associated with a pipe or a FIFO and |
a5a0310d UD |
693 | this device does not allow positioning of the file pointer. |
694 | @end table | |
695 | ||
696 | The function is an extension defined in the Unix Single Specification | |
697 | version 2. | |
698 | @end deftypefun | |
699 | ||
b07d03e0 | 700 | @deftypefun ssize_t pwrite64 (int @var{filedes}, const void *@var{buffer}, size_t @var{size}, off64_t @var{offset}) |
d08a7e4c | 701 | @standards{Unix98, unistd.h} |
2cc3615c AO |
702 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
703 | @c This is usually a safe syscall. The sysdeps/posix fallback emulation | |
704 | @c is not MT-Safe because it uses lseek64, write and lseek64 back, but | |
705 | @c is it used anywhere? | |
b07d03e0 UD |
706 | This function is similar to the @code{pwrite} function. The difference |
707 | is that the @var{offset} parameter is of type @code{off64_t} instead of | |
04b9968b | 708 | @code{off_t} which makes it possible on 32 bit machines to address |
9ceeb279 | 709 | files larger than @twoexp{31} bytes and up to @twoexp{63} bytes. The |
b07d03e0 UD |
710 | file descriptor @code{filedes} must be opened using @code{open64} since |
711 | otherwise the large offsets possible with @code{off64_t} will lead to | |
712 | errors with a descriptor in small file mode. | |
713 | ||
c756c71c | 714 | When the source file is compiled using @code{_FILE_OFFSET_BITS == 64} on a |
04b9968b UD |
715 | 32 bit machine this function is actually available under the name |
716 | @code{pwrite} and so transparently replaces the 32 bit interface. | |
b07d03e0 | 717 | @end deftypefun |
717da4b3 | 718 | |
28f540f4 RM |
719 | @node File Position Primitive |
720 | @section Setting the File Position of a Descriptor | |
721 | ||
722 | Just as you can set the file position of a stream with @code{fseek}, you | |
723 | can set the file position of a descriptor with @code{lseek}. This | |
724 | specifies the position in the file for the next @code{read} or | |
725 | @code{write} operation. @xref{File Positioning}, for more information | |
726 | on the file position and what it means. | |
727 | ||
728 | To read the current file position value from a descriptor, use | |
729 | @code{lseek (@var{desc}, 0, SEEK_CUR)}. | |
730 | ||
731 | @cindex file positioning on a file descriptor | |
732 | @cindex positioning a file descriptor | |
733 | @cindex seeking on a file descriptor | |
28f540f4 | 734 | @deftypefun off_t lseek (int @var{filedes}, off_t @var{offset}, int @var{whence}) |
d08a7e4c | 735 | @standards{POSIX.1, unistd.h} |
2cc3615c | 736 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
28f540f4 RM |
737 | The @code{lseek} function is used to change the file position of the |
738 | file with descriptor @var{filedes}. | |
739 | ||
740 | The @var{whence} argument specifies how the @var{offset} should be | |
04b9968b UD |
741 | interpreted, in the same way as for the @code{fseek} function, and it must |
742 | be one of the symbolic constants @code{SEEK_SET}, @code{SEEK_CUR}, or | |
28f540f4 RM |
743 | @code{SEEK_END}. |
744 | ||
2fe82ca6 | 745 | @vtable @code |
28f540f4 | 746 | @item SEEK_SET |
4dad7bab | 747 | Specifies that @var{offset} is a count of characters from the beginning |
28f540f4 RM |
748 | of the file. |
749 | ||
750 | @item SEEK_CUR | |
4dad7bab | 751 | Specifies that @var{offset} is a count of characters from the current |
28f540f4 RM |
752 | file position. This count may be positive or negative. |
753 | ||
754 | @item SEEK_END | |
4dad7bab | 755 | Specifies that @var{offset} is a count of characters from the end of |
28f540f4 RM |
756 | the file. A negative count specifies a position within the current |
757 | extent of the file; a positive count specifies a position past the | |
2c6fe0bd | 758 | current end. If you set the position past the current end, and |
28f540f4 | 759 | actually write data, you will extend the file with zeros up to that |
336dfb2d | 760 | position. |
2fe82ca6 | 761 | @end vtable |
28f540f4 RM |
762 | |
763 | The return value from @code{lseek} is normally the resulting file | |
764 | position, measured in bytes from the beginning of the file. | |
765 | You can use this feature together with @code{SEEK_CUR} to read the | |
766 | current file position. | |
767 | ||
768 | If you want to append to the file, setting the file position to the | |
769 | current end of file with @code{SEEK_END} is not sufficient. Another | |
770 | process may write more data after you seek but before you write, | |
771 | extending the file so the position you write onto clobbers their data. | |
772 | Instead, use the @code{O_APPEND} operating mode; @pxref{Operating Modes}. | |
773 | ||
774 | You can set the file position past the current end of the file. This | |
775 | does not by itself make the file longer; @code{lseek} never changes the | |
776 | file. But subsequent output at that position will extend the file. | |
777 | Characters between the previous end of file and the new position are | |
778 | filled with zeros. Extending the file in this way can create a | |
779 | ``hole'': the blocks of zeros are not actually allocated on disk, so the | |
78759725 | 780 | file takes up less space than it appears to; it is then called a |
28f540f4 RM |
781 | ``sparse file''. |
782 | @cindex sparse files | |
783 | @cindex holes in files | |
784 | ||
785 | If the file position cannot be changed, or the operation is in some way | |
07435eb4 | 786 | invalid, @code{lseek} returns a value of @math{-1}. The following |
28f540f4 RM |
787 | @code{errno} error conditions are defined for this function: |
788 | ||
789 | @table @code | |
790 | @item EBADF | |
791 | The @var{filedes} is not a valid file descriptor. | |
792 | ||
793 | @item EINVAL | |
794 | The @var{whence} argument value is not valid, or the resulting | |
795 | file offset is not valid. A file offset is invalid. | |
796 | ||
797 | @item ESPIPE | |
798 | The @var{filedes} corresponds to an object that cannot be positioned, | |
799 | such as a pipe, FIFO or terminal device. (POSIX.1 specifies this error | |
a7a93d50 | 800 | only for pipes and FIFOs, but on @gnusystems{}, you always get |
28f540f4 RM |
801 | @code{ESPIPE} if the object is not seekable.) |
802 | @end table | |
803 | ||
b07d03e0 UD |
804 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the |
805 | @code{lseek} function is in fact @code{lseek64} and the type | |
806 | @code{off_t} has 64 bits which makes it possible to handle files up to | |
9ceeb279 | 807 | @twoexp{63} bytes in length. |
b07d03e0 | 808 | |
04b9968b | 809 | This function is a cancellation point in multi-threaded programs. This |
dfd2257a UD |
810 | is a problem if the thread allocates some resources (like memory, file |
811 | descriptors, semaphores or whatever) at the time @code{lseek} is | |
19e4c7dd | 812 | called. If the thread gets canceled these resources stay allocated |
dfd2257a | 813 | until the program ends. To avoid this calls to @code{lseek} should be |
04b9968b | 814 | protected using cancellation handlers. |
dfd2257a UD |
815 | @c ref pthread_cleanup_push / pthread_cleanup_pop |
816 | ||
28f540f4 | 817 | The @code{lseek} function is the underlying primitive for the |
dfd2257a UD |
818 | @code{fseek}, @code{fseeko}, @code{ftell}, @code{ftello} and |
819 | @code{rewind} functions, which operate on streams instead of file | |
820 | descriptors. | |
28f540f4 RM |
821 | @end deftypefun |
822 | ||
b07d03e0 | 823 | @deftypefun off64_t lseek64 (int @var{filedes}, off64_t @var{offset}, int @var{whence}) |
d08a7e4c | 824 | @standards{Unix98, unistd.h} |
2cc3615c | 825 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
b07d03e0 UD |
826 | This function is similar to the @code{lseek} function. The difference |
827 | is that the @var{offset} parameter is of type @code{off64_t} instead of | |
04b9968b | 828 | @code{off_t} which makes it possible on 32 bit machines to address |
9ceeb279 | 829 | files larger than @twoexp{31} bytes and up to @twoexp{63} bytes. The |
b07d03e0 UD |
830 | file descriptor @code{filedes} must be opened using @code{open64} since |
831 | otherwise the large offsets possible with @code{off64_t} will lead to | |
832 | errors with a descriptor in small file mode. | |
833 | ||
c756c71c | 834 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a |
b07d03e0 | 835 | 32 bits machine this function is actually available under the name |
04b9968b | 836 | @code{lseek} and so transparently replaces the 32 bit interface. |
b07d03e0 UD |
837 | @end deftypefun |
838 | ||
28f540f4 | 839 | You can have multiple descriptors for the same file if you open the file |
2c6fe0bd | 840 | more than once, or if you duplicate a descriptor with @code{dup}. |
28f540f4 RM |
841 | Descriptors that come from separate calls to @code{open} have independent |
842 | file positions; using @code{lseek} on one descriptor has no effect on the | |
2c6fe0bd | 843 | other. For example, |
28f540f4 RM |
844 | |
845 | @smallexample | |
846 | @group | |
847 | @{ | |
848 | int d1, d2; | |
849 | char buf[4]; | |
850 | d1 = open ("foo", O_RDONLY); | |
851 | d2 = open ("foo", O_RDONLY); | |
852 | lseek (d1, 1024, SEEK_SET); | |
853 | read (d2, buf, 4); | |
854 | @} | |
855 | @end group | |
856 | @end smallexample | |
857 | ||
858 | @noindent | |
859 | will read the first four characters of the file @file{foo}. (The | |
860 | error-checking code necessary for a real program has been omitted here | |
861 | for brevity.) | |
862 | ||
863 | By contrast, descriptors made by duplication share a common file | |
864 | position with the original descriptor that was duplicated. Anything | |
865 | which alters the file position of one of the duplicates, including | |
866 | reading or writing data, affects all of them alike. Thus, for example, | |
867 | ||
868 | @smallexample | |
869 | @{ | |
870 | int d1, d2, d3; | |
871 | char buf1[4], buf2[4]; | |
872 | d1 = open ("foo", O_RDONLY); | |
873 | d2 = dup (d1); | |
874 | d3 = dup (d2); | |
875 | lseek (d3, 1024, SEEK_SET); | |
876 | read (d1, buf1, 4); | |
877 | read (d2, buf2, 4); | |
878 | @} | |
879 | @end smallexample | |
880 | ||
881 | @noindent | |
882 | will read four characters starting with the 1024'th character of | |
883 | @file{foo}, and then four more characters starting with the 1028'th | |
884 | character. | |
885 | ||
28f540f4 | 886 | @deftp {Data Type} off_t |
d08a7e4c | 887 | @standards{POSIX.1, sys/types.h} |
07e12bb3 JM |
888 | This is a signed integer type used to represent file sizes. In |
889 | @theglibc{}, this type is no narrower than @code{int}. | |
a3a4a74e UD |
890 | |
891 | If the source is compiled with @code{_FILE_OFFSET_BITS == 64} this type | |
892 | is transparently replaced by @code{off64_t}. | |
28f540f4 RM |
893 | @end deftp |
894 | ||
b07d03e0 | 895 | @deftp {Data Type} off64_t |
d08a7e4c | 896 | @standards{Unix98, sys/types.h} |
b07d03e0 | 897 | This type is used similar to @code{off_t}. The difference is that even |
04b9968b | 898 | on 32 bit machines, where the @code{off_t} type would have 32 bits, |
b07d03e0 | 899 | @code{off64_t} has 64 bits and so is able to address files up to |
9ceeb279 | 900 | @twoexp{63} bytes in length. |
a3a4a74e UD |
901 | |
902 | When compiling with @code{_FILE_OFFSET_BITS == 64} this type is | |
903 | available under the name @code{off_t}. | |
b07d03e0 UD |
904 | @end deftp |
905 | ||
28f540f4 RM |
906 | These aliases for the @samp{SEEK_@dots{}} constants exist for the sake |
907 | of compatibility with older BSD systems. They are defined in two | |
908 | different header files: @file{fcntl.h} and @file{sys/file.h}. | |
909 | ||
2fe82ca6 | 910 | @vtable @code |
28f540f4 RM |
911 | @item L_SET |
912 | An alias for @code{SEEK_SET}. | |
913 | ||
914 | @item L_INCR | |
915 | An alias for @code{SEEK_CUR}. | |
916 | ||
917 | @item L_XTND | |
918 | An alias for @code{SEEK_END}. | |
2fe82ca6 | 919 | @end vtable |
28f540f4 RM |
920 | |
921 | @node Descriptors and Streams | |
922 | @section Descriptors and Streams | |
923 | @cindex streams, and file descriptors | |
924 | @cindex converting file descriptor to stream | |
925 | @cindex extracting file descriptor from stream | |
926 | ||
927 | Given an open file descriptor, you can create a stream for it with the | |
928 | @code{fdopen} function. You can get the underlying file descriptor for | |
929 | an existing stream with the @code{fileno} function. These functions are | |
930 | declared in the header file @file{stdio.h}. | |
931 | @pindex stdio.h | |
932 | ||
28f540f4 | 933 | @deftypefun {FILE *} fdopen (int @var{filedes}, const char *@var{opentype}) |
d08a7e4c | 934 | @standards{POSIX.1, stdio.h} |
2cc3615c | 935 | @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{} @asulock{}}@acunsafe{@acsmem{} @aculock{}}} |
28f540f4 RM |
936 | The @code{fdopen} function returns a new stream for the file descriptor |
937 | @var{filedes}. | |
938 | ||
939 | The @var{opentype} argument is interpreted in the same way as for the | |
940 | @code{fopen} function (@pxref{Opening Streams}), except that | |
a7a93d50 | 941 | the @samp{b} option is not permitted; this is because @gnusystems{} make no |
28f540f4 | 942 | distinction between text and binary files. Also, @code{"w"} and |
04b9968b | 943 | @code{"w+"} do not cause truncation of the file; these have an effect only |
28f540f4 RM |
944 | when opening a file, and in this case the file has already been opened. |
945 | You must make sure that the @var{opentype} argument matches the actual | |
946 | mode of the open file descriptor. | |
947 | ||
948 | The return value is the new stream. If the stream cannot be created | |
949 | (for example, if the modes for the file indicated by the file descriptor | |
950 | do not permit the access specified by the @var{opentype} argument), a | |
951 | null pointer is returned instead. | |
952 | ||
953 | In some other systems, @code{fdopen} may fail to detect that the modes | |
9739d2d5 | 954 | for file descriptors do not permit the access specified by |
1f77f049 | 955 | @code{opentype}. @Theglibc{} always checks for this. |
28f540f4 RM |
956 | @end deftypefun |
957 | ||
958 | For an example showing the use of the @code{fdopen} function, | |
959 | see @ref{Creating a Pipe}. | |
960 | ||
28f540f4 | 961 | @deftypefun int fileno (FILE *@var{stream}) |
d08a7e4c | 962 | @standards{POSIX.1, stdio.h} |
2cc3615c | 963 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
28f540f4 RM |
964 | This function returns the file descriptor associated with the stream |
965 | @var{stream}. If an error is detected (for example, if the @var{stream} | |
966 | is not valid) or if @var{stream} does not do I/O to a file, | |
07435eb4 | 967 | @code{fileno} returns @math{-1}. |
28f540f4 RM |
968 | @end deftypefun |
969 | ||
7b4161bb | 970 | @deftypefun int fileno_unlocked (FILE *@var{stream}) |
d08a7e4c | 971 | @standards{GNU, stdio.h} |
2cc3615c | 972 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
7b4161bb UD |
973 | The @code{fileno_unlocked} function is equivalent to the @code{fileno} |
974 | function except that it does not implicitly lock the stream if the state | |
975 | is @code{FSETLOCKING_INTERNAL}. | |
976 | ||
977 | This function is a GNU extension. | |
978 | @end deftypefun | |
979 | ||
28f540f4 RM |
980 | @cindex standard file descriptors |
981 | @cindex file descriptors, standard | |
982 | There are also symbolic constants defined in @file{unistd.h} for the | |
983 | file descriptors belonging to the standard streams @code{stdin}, | |
984 | @code{stdout}, and @code{stderr}; see @ref{Standard Streams}. | |
985 | @pindex unistd.h | |
986 | ||
2fe82ca6 | 987 | @vtable @code |
28f540f4 | 988 | @item STDIN_FILENO |
d08a7e4c | 989 | @standards{POSIX.1, unistd.h} |
28f540f4 RM |
990 | This macro has value @code{0}, which is the file descriptor for |
991 | standard input. | |
992 | @cindex standard input file descriptor | |
993 | ||
28f540f4 | 994 | @item STDOUT_FILENO |
d08a7e4c | 995 | @standards{POSIX.1, unistd.h} |
28f540f4 RM |
996 | This macro has value @code{1}, which is the file descriptor for |
997 | standard output. | |
998 | @cindex standard output file descriptor | |
999 | ||
28f540f4 | 1000 | @item STDERR_FILENO |
d08a7e4c | 1001 | @standards{POSIX.1, unistd.h} |
28f540f4 RM |
1002 | This macro has value @code{2}, which is the file descriptor for |
1003 | standard error output. | |
2fe82ca6 | 1004 | @end vtable |
28f540f4 RM |
1005 | @cindex standard error file descriptor |
1006 | ||
1007 | @node Stream/Descriptor Precautions | |
1008 | @section Dangers of Mixing Streams and Descriptors | |
1009 | @cindex channels | |
1010 | @cindex streams and descriptors | |
1011 | @cindex descriptors and streams | |
1012 | @cindex mixing descriptors and streams | |
1013 | ||
1014 | You can have multiple file descriptors and streams (let's call both | |
1015 | streams and descriptors ``channels'' for short) connected to the same | |
1016 | file, but you must take care to avoid confusion between channels. There | |
1017 | are two cases to consider: @dfn{linked} channels that share a single | |
1018 | file position value, and @dfn{independent} channels that have their own | |
1019 | file positions. | |
1020 | ||
1021 | It's best to use just one channel in your program for actual data | |
1022 | transfer to any given file, except when all the access is for input. | |
1023 | For example, if you open a pipe (something you can only do at the file | |
1024 | descriptor level), either do all I/O with the descriptor, or construct a | |
1025 | stream from the descriptor with @code{fdopen} and then do all I/O with | |
1026 | the stream. | |
1027 | ||
1028 | @menu | |
1029 | * Linked Channels:: Dealing with channels sharing a file position. | |
1030 | * Independent Channels:: Dealing with separately opened, unlinked channels. | |
2c6fe0bd | 1031 | * Cleaning Streams:: Cleaning a stream makes it safe to use |
28f540f4 RM |
1032 | another channel. |
1033 | @end menu | |
1034 | ||
1035 | @node Linked Channels | |
1036 | @subsection Linked Channels | |
1037 | @cindex linked channels | |
1038 | ||
1039 | Channels that come from a single opening share the same file position; | |
1040 | we call them @dfn{linked} channels. Linked channels result when you | |
1041 | make a stream from a descriptor using @code{fdopen}, when you get a | |
1042 | descriptor from a stream with @code{fileno}, when you copy a descriptor | |
1043 | with @code{dup} or @code{dup2}, and when descriptors are inherited | |
1044 | during @code{fork}. For files that don't support random access, such as | |
1045 | terminals and pipes, @emph{all} channels are effectively linked. On | |
1046 | random-access files, all append-type output streams are effectively | |
1047 | linked to each other. | |
1048 | ||
1049 | @cindex cleaning up a stream | |
0295d266 UD |
1050 | If you have been using a stream for I/O (or have just opened the stream), |
1051 | and you want to do I/O using | |
28f540f4 RM |
1052 | another channel (either a stream or a descriptor) that is linked to it, |
1053 | you must first @dfn{clean up} the stream that you have been using. | |
1054 | @xref{Cleaning Streams}. | |
1055 | ||
1056 | Terminating a process, or executing a new program in the process, | |
1057 | destroys all the streams in the process. If descriptors linked to these | |
1058 | streams persist in other processes, their file positions become | |
1059 | undefined as a result. To prevent this, you must clean up the streams | |
1060 | before destroying them. | |
1061 | ||
1062 | @node Independent Channels | |
1063 | @subsection Independent Channels | |
1064 | @cindex independent channels | |
1065 | ||
1066 | When you open channels (streams or descriptors) separately on a seekable | |
1067 | file, each channel has its own file position. These are called | |
1068 | @dfn{independent channels}. | |
1069 | ||
1070 | The system handles each channel independently. Most of the time, this | |
1071 | is quite predictable and natural (especially for input): each channel | |
1072 | can read or write sequentially at its own place in the file. However, | |
1073 | if some of the channels are streams, you must take these precautions: | |
1074 | ||
1075 | @itemize @bullet | |
1076 | @item | |
1077 | You should clean an output stream after use, before doing anything else | |
1078 | that might read or write from the same part of the file. | |
1079 | ||
1080 | @item | |
1081 | You should clean an input stream before reading data that may have been | |
1082 | modified using an independent channel. Otherwise, you might read | |
1083 | obsolete data that had been in the stream's buffer. | |
1084 | @end itemize | |
1085 | ||
1086 | If you do output to one channel at the end of the file, this will | |
1087 | certainly leave the other independent channels positioned somewhere | |
1088 | before the new end. You cannot reliably set their file positions to the | |
1089 | new end of file before writing, because the file can always be extended | |
1090 | by another process between when you set the file position and when you | |
1091 | write the data. Instead, use an append-type descriptor or stream; they | |
1092 | always output at the current end of the file. In order to make the | |
1093 | end-of-file position accurate, you must clean the output channel you | |
1094 | were using, if it is a stream. | |
1095 | ||
1096 | It's impossible for two channels to have separate file pointers for a | |
1097 | file that doesn't support random access. Thus, channels for reading or | |
1098 | writing such files are always linked, never independent. Append-type | |
1099 | channels are also always linked. For these channels, follow the rules | |
1100 | for linked channels; see @ref{Linked Channels}. | |
1101 | ||
1102 | @node Cleaning Streams | |
1103 | @subsection Cleaning Streams | |
1104 | ||
6664049b | 1105 | You can use @code{fflush} to clean a stream in most |
28f540f4 RM |
1106 | cases. |
1107 | ||
6664049b | 1108 | You can skip the @code{fflush} if you know the stream |
28f540f4 RM |
1109 | is already clean. A stream is clean whenever its buffer is empty. For |
1110 | example, an unbuffered stream is always clean. An input stream that is | |
1111 | at end-of-file is clean. A line-buffered stream is clean when the last | |
0295d266 UD |
1112 | character output was a newline. However, a just-opened input stream |
1113 | might not be clean, as its input buffer might not be empty. | |
28f540f4 RM |
1114 | |
1115 | There is one case in which cleaning a stream is impossible on most | |
1116 | systems. This is when the stream is doing input from a file that is not | |
1117 | random-access. Such streams typically read ahead, and when the file is | |
1118 | not random access, there is no way to give back the excess data already | |
1119 | read. When an input stream reads from a random-access file, | |
1120 | @code{fflush} does clean the stream, but leaves the file pointer at an | |
1121 | unpredictable place; you must set the file pointer before doing any | |
6664049b | 1122 | further I/O. |
28f540f4 RM |
1123 | |
1124 | Closing an output-only stream also does @code{fflush}, so this is a | |
6664049b | 1125 | valid way of cleaning an output stream. |
28f540f4 RM |
1126 | |
1127 | You need not clean a stream before using its descriptor for control | |
1128 | operations such as setting terminal modes; these operations don't affect | |
1129 | the file position and are not affected by it. You can use any | |
1130 | descriptor for these operations, and all channels are affected | |
1131 | simultaneously. However, text already ``output'' to a stream but still | |
1132 | buffered by the stream will be subject to the new terminal modes when | |
1133 | subsequently flushed. To make sure ``past'' output is covered by the | |
1134 | terminal settings that were in effect at the time, flush the output | |
1135 | streams for that terminal before setting the modes. @xref{Terminal | |
1136 | Modes}. | |
1137 | ||
07435eb4 UD |
1138 | @node Scatter-Gather |
1139 | @section Fast Scatter-Gather I/O | |
1140 | @cindex scatter-gather | |
1141 | ||
1142 | Some applications may need to read or write data to multiple buffers, | |
04b9968b | 1143 | which are separated in memory. Although this can be done easily enough |
19e4c7dd | 1144 | with multiple calls to @code{read} and @code{write}, it is inefficient |
07435eb4 UD |
1145 | because there is overhead associated with each kernel call. |
1146 | ||
1147 | Instead, many platforms provide special high-speed primitives to perform | |
1f77f049 JM |
1148 | these @dfn{scatter-gather} operations in a single kernel call. @Theglibc{} |
1149 | will provide an emulation on any system that lacks these | |
07435eb4 UD |
1150 | primitives, so they are not a portability threat. They are defined in |
1151 | @code{sys/uio.h}. | |
1152 | ||
1153 | These functions are controlled with arrays of @code{iovec} structures, | |
1154 | which describe the location and size of each buffer. | |
1155 | ||
1156 | @deftp {Data Type} {struct iovec} | |
d08a7e4c | 1157 | @standards{BSD, sys/uio.h} |
07435eb4 | 1158 | |
cf822e3c | 1159 | The @code{iovec} structure describes a buffer. It contains two fields: |
07435eb4 UD |
1160 | |
1161 | @table @code | |
1162 | ||
1163 | @item void *iov_base | |
1164 | Contains the address of a buffer. | |
1165 | ||
1166 | @item size_t iov_len | |
1167 | Contains the length of the buffer. | |
1168 | ||
1169 | @end table | |
1170 | @end deftp | |
1171 | ||
1172 | @deftypefun ssize_t readv (int @var{filedes}, const struct iovec *@var{vector}, int @var{count}) | |
d08a7e4c | 1173 | @standards{BSD, sys/uio.h} |
2cc3615c AO |
1174 | @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}} |
1175 | @c The fallback sysdeps/posix implementation, used even on GNU/Linux | |
1176 | @c with old kernels that lack a full readv/writev implementation, may | |
1177 | @c malloc the buffer into which data is read, if the total read size is | |
1178 | @c too large for alloca. | |
07435eb4 UD |
1179 | |
1180 | The @code{readv} function reads data from @var{filedes} and scatters it | |
1181 | into the buffers described in @var{vector}, which is taken to be | |
1182 | @var{count} structures long. As each buffer is filled, data is sent to the | |
1183 | next. | |
1184 | ||
1185 | Note that @code{readv} is not guaranteed to fill all the buffers. | |
1186 | It may stop at any point, for the same reasons @code{read} would. | |
1187 | ||
1188 | The return value is a count of bytes (@emph{not} buffers) read, @math{0} | |
1189 | indicating end-of-file, or @math{-1} indicating an error. The possible | |
1190 | errors are the same as in @code{read}. | |
1191 | ||
1192 | @end deftypefun | |
1193 | ||
1194 | @deftypefun ssize_t writev (int @var{filedes}, const struct iovec *@var{vector}, int @var{count}) | |
d08a7e4c | 1195 | @standards{BSD, sys/uio.h} |
2cc3615c AO |
1196 | @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}} |
1197 | @c The fallback sysdeps/posix implementation, used even on GNU/Linux | |
1198 | @c with old kernels that lack a full readv/writev implementation, may | |
1199 | @c malloc the buffer from which data is written, if the total write size | |
1200 | @c is too large for alloca. | |
07435eb4 UD |
1201 | |
1202 | The @code{writev} function gathers data from the buffers described in | |
1203 | @var{vector}, which is taken to be @var{count} structures long, and writes | |
1204 | them to @code{filedes}. As each buffer is written, it moves on to the | |
1205 | next. | |
1206 | ||
1207 | Like @code{readv}, @code{writev} may stop midstream under the same | |
1208 | conditions @code{write} would. | |
1209 | ||
1210 | The return value is a count of bytes written, or @math{-1} indicating an | |
1211 | error. The possible errors are the same as in @code{write}. | |
1212 | ||
1213 | @end deftypefun | |
1214 | ||
f6e965ee FW |
1215 | @deftypefun ssize_t preadv (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off_t @var{offset}) |
1216 | @standards{BSD, sys/uio.h} | |
1217 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1218 | @c This is a syscall for Linux 3.2 for all architectures but microblaze | |
1219 | @c (which was added on 3.15). The sysdeps/posix fallback emulation | |
1220 | @c is also MT-Safe since it calls pread, and it is now a syscall on all | |
1221 | @c targets. | |
1222 | ||
1223 | This function is similar to the @code{readv} function, with the difference | |
1224 | it adds an extra @var{offset} parameter of type @code{off_t} similar to | |
b156c5f0 | 1225 | @code{pread}. The data is read from the file starting at position |
f6e965ee FW |
1226 | @var{offset}. The position of the file descriptor itself is not affected |
1227 | by the operation. The value is the same as before the call. | |
1228 | ||
1229 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the | |
1230 | @code{preadv} function is in fact @code{preadv64} and the type | |
1231 | @code{off_t} has 64 bits, which makes it possible to handle files up to | |
1232 | @twoexp{63} bytes in length. | |
1233 | ||
1234 | The return value is a count of bytes (@emph{not} buffers) read, @math{0} | |
1235 | indicating end-of-file, or @math{-1} indicating an error. The possible | |
1236 | errors are the same as in @code{readv} and @code{pread}. | |
1237 | @end deftypefun | |
1238 | ||
1239 | @deftypefun ssize_t preadv64 (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off64_t @var{offset}) | |
1240 | @standards{BSD, unistd.h} | |
1241 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1242 | @c This is a syscall for Linux 3.2 for all architectures but microblaze | |
1243 | @c (which was added on 3.15). The sysdeps/posix fallback emulation | |
1244 | @c is also MT-Safe since it calls pread64, and it is now a syscall on all | |
1245 | @c targets. | |
1246 | ||
1247 | This function is similar to the @code{preadv} function with the difference | |
1248 | is that the @var{offset} parameter is of type @code{off64_t} instead of | |
1249 | @code{off_t}. It makes it possible on 32 bit machines to address | |
1250 | files larger than @twoexp{31} bytes and up to @twoexp{63} bytes. The | |
1251 | file descriptor @code{filedes} must be opened using @code{open64} since | |
1252 | otherwise the large offsets possible with @code{off64_t} will lead to | |
1253 | errors with a descriptor in small file mode. | |
1254 | ||
1255 | When the source file is compiled using @code{_FILE_OFFSET_BITS == 64} on a | |
1256 | 32 bit machine this function is actually available under the name | |
1257 | @code{preadv} and so transparently replaces the 32 bit interface. | |
1258 | @end deftypefun | |
1259 | ||
1260 | @deftypefun ssize_t pwritev (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off_t @var{offset}) | |
1261 | @standards{BSD, sys/uio.h} | |
1262 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1263 | @c This is a syscall for Linux 3.2 for all architectures but microblaze | |
1264 | @c (which was added on 3.15). The sysdeps/posix fallback emulation | |
1265 | @c is also MT-Safe since it calls pwrite, and it is now a syscall on all | |
1266 | @c targets. | |
1267 | ||
1268 | This function is similar to the @code{writev} function, with the difference | |
1269 | it adds an extra @var{offset} parameter of type @code{off_t} similar to | |
1270 | @code{pwrite}. The data is written to the file starting at position | |
1271 | @var{offset}. The position of the file descriptor itself is not affected | |
1272 | by the operation. The value is the same as before the call. | |
1273 | ||
1274 | However, on Linux, if a file is opened with @code{O_APPEND}, @code{pwrite} | |
1275 | appends data to the end of the file, regardless of the value of | |
1276 | @code{offset}. | |
1277 | ||
1278 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the | |
1279 | @code{pwritev} function is in fact @code{pwritev64} and the type | |
1280 | @code{off_t} has 64 bits, which makes it possible to handle files up to | |
1281 | @twoexp{63} bytes in length. | |
1282 | ||
1283 | The return value is a count of bytes (@emph{not} buffers) written, @math{0} | |
1284 | indicating end-of-file, or @math{-1} indicating an error. The possible | |
1285 | errors are the same as in @code{writev} and @code{pwrite}. | |
1286 | @end deftypefun | |
1287 | ||
1288 | @deftypefun ssize_t pwritev64 (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off64_t @var{offset}) | |
1289 | @standards{BSD, unistd.h} | |
1290 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1291 | @c This is a syscall for Linux 3.2 for all architectures but microblaze | |
1292 | @c (which was added on 3.15). The sysdeps/posix fallback emulation | |
1293 | @c is also MT-Safe since it calls pwrite64, and it is now a syscall on all | |
1294 | @c targets. | |
1295 | ||
1296 | This function is similar to the @code{pwritev} function with the difference | |
1297 | is that the @var{offset} parameter is of type @code{off64_t} instead of | |
1298 | @code{off_t}. It makes it possible on 32 bit machines to address | |
1299 | files larger than @twoexp{31} bytes and up to @twoexp{63} bytes. The | |
1300 | file descriptor @code{filedes} must be opened using @code{open64} since | |
1301 | otherwise the large offsets possible with @code{off64_t} will lead to | |
1302 | errors with a descriptor in small file mode. | |
1303 | ||
1304 | When the source file is compiled using @code{_FILE_OFFSET_BITS == 64} on a | |
1305 | 32 bit machine this function is actually available under the name | |
1306 | @code{pwritev} and so transparently replaces the 32 bit interface. | |
1307 | @end deftypefun | |
1308 | ||
1309 | @deftypefun ssize_t preadv2 (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off_t @var{offset}, int @var{flags}) | |
1310 | @standards{GNU, sys/uio.h} | |
1311 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1312 | @c This is a syscall for Linux v4.6. The sysdeps/posix fallback emulation | |
1313 | @c is also MT-Safe since it calls preadv. | |
1314 | ||
d4b4a00a FW |
1315 | This function is similar to the @code{preadv} function, with the |
1316 | difference it adds an extra @var{flags} parameter of type @code{int}. | |
1317 | Additionally, if @var{offset} is @math{-1}, the current file position | |
1318 | is used and updated (like the @code{readv} function). | |
1319 | ||
1320 | The supported @var{flags} are dependent of the underlying system. For | |
1321 | Linux it supports: | |
f6e965ee FW |
1322 | |
1323 | @vtable @code | |
1324 | @item RWF_HIPRI | |
1325 | High priority request. This adds a flag that tells the file system that | |
1326 | this is a high priority request for which it is worth to poll the hardware. | |
1327 | The flag is purely advisory and can be ignored if not supported. The | |
1328 | @var{fd} must be opened using @code{O_DIRECT}. | |
1329 | ||
1330 | @item RWF_DSYNC | |
1331 | Per-IO synchronization as if the file was opened with @code{O_DSYNC} flag. | |
1332 | ||
1333 | @item RWF_SYNC | |
1334 | Per-IO synchronization as if the file was opened with @code{O_SYNC} flag. | |
1335 | ||
1336 | @item RWF_NOWAIT | |
1337 | Use nonblocking mode for this operation; that is, this call to @code{preadv2} | |
1338 | will fail and set @code{errno} to @code{EAGAIN} if the operation would block. | |
f2652643 L |
1339 | |
1340 | @item RWF_APPEND | |
1341 | Per-IO synchronization as if the file was opened with @code{O_APPEND} flag. | |
3db9d208 SH |
1342 | |
1343 | @item RWF_NOAPPEND | |
1344 | This flag allows an offset to be honored, even if the file was opened with | |
1345 | @code{O_APPEND} flag. | |
f6e965ee FW |
1346 | @end vtable |
1347 | ||
1348 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the | |
1349 | @code{preadv2} function is in fact @code{preadv64v2} and the type | |
1350 | @code{off_t} has 64 bits, which makes it possible to handle files up to | |
1351 | @twoexp{63} bytes in length. | |
1352 | ||
1353 | The return value is a count of bytes (@emph{not} buffers) read, @math{0} | |
1354 | indicating end-of-file, or @math{-1} indicating an error. The possible | |
1355 | errors are the same as in @code{preadv} with the addition of: | |
1356 | ||
1357 | @table @code | |
1358 | ||
1359 | @item EOPNOTSUPP | |
1360 | ||
1361 | @c The default sysdeps/posix code will return it for any flags value | |
1362 | @c different than 0. | |
1363 | An unsupported @var{flags} was used. | |
1364 | ||
1365 | @end table | |
1366 | ||
1367 | @end deftypefun | |
1368 | ||
1369 | @deftypefun ssize_t preadv64v2 (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off64_t @var{offset}, int @var{flags}) | |
1370 | @standards{GNU, unistd.h} | |
1371 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1372 | @c This is a syscall for Linux v4.6. The sysdeps/posix fallback emulation | |
1373 | @c is also MT-Safe since it calls preadv. | |
07435eb4 | 1374 | |
f6e965ee FW |
1375 | This function is similar to the @code{preadv2} function with the difference |
1376 | is that the @var{offset} parameter is of type @code{off64_t} instead of | |
1377 | @code{off_t}. It makes it possible on 32 bit machines to address | |
1378 | files larger than @twoexp{31} bytes and up to @twoexp{63} bytes. The | |
1379 | file descriptor @code{filedes} must be opened using @code{open64} since | |
1380 | otherwise the large offsets possible with @code{off64_t} will lead to | |
1381 | errors with a descriptor in small file mode. | |
1382 | ||
1383 | When the source file is compiled using @code{_FILE_OFFSET_BITS == 64} on a | |
1384 | 32 bit machine this function is actually available under the name | |
1385 | @code{preadv2} and so transparently replaces the 32 bit interface. | |
1386 | @end deftypefun | |
1387 | ||
1388 | ||
1389 | @deftypefun ssize_t pwritev2 (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off_t @var{offset}, int @var{flags}) | |
1390 | @standards{GNU, sys/uio.h} | |
1391 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1392 | @c This is a syscall for Linux v4.6. The sysdeps/posix fallback emulation | |
1393 | @c is also MT-Safe since it calls pwritev. | |
1394 | ||
d4b4a00a FW |
1395 | This function is similar to the @code{pwritev} function, with the |
1396 | difference it adds an extra @var{flags} parameter of type @code{int}. | |
1397 | Additionally, if @var{offset} is @math{-1}, the current file position | |
1398 | should is used and updated (like the @code{writev} function). | |
1399 | ||
1400 | The supported @var{flags} are dependent of the underlying system. For | |
1401 | Linux, the supported flags are the same as those for @code{preadv2}. | |
f6e965ee FW |
1402 | |
1403 | When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the | |
1404 | @code{pwritev2} function is in fact @code{pwritev64v2} and the type | |
1405 | @code{off_t} has 64 bits, which makes it possible to handle files up to | |
1406 | @twoexp{63} bytes in length. | |
1407 | ||
1408 | The return value is a count of bytes (@emph{not} buffers) write, @math{0} | |
1409 | indicating end-of-file, or @math{-1} indicating an error. The possible | |
1410 | errors are the same as in @code{preadv2}. | |
1411 | @end deftypefun | |
1412 | ||
1413 | @deftypefun ssize_t pwritev64v2 (int @var{fd}, const struct iovec *@var{iov}, int @var{iovcnt}, off64_t @var{offset}, int @var{flags}) | |
1414 | @standards{GNU, unistd.h} | |
1415 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1416 | @c This is a syscall for Linux v4.6. The sysdeps/posix fallback emulation | |
1417 | @c is also MT-Safe since it calls pwritev. | |
1418 | ||
1419 | This function is similar to the @code{pwritev2} function with the difference | |
1420 | is that the @var{offset} parameter is of type @code{off64_t} instead of | |
1421 | @code{off_t}. It makes it possible on 32 bit machines to address | |
1422 | files larger than @twoexp{31} bytes and up to @twoexp{63} bytes. The | |
1423 | file descriptor @code{filedes} must be opened using @code{open64} since | |
1424 | otherwise the large offsets possible with @code{off64_t} will lead to | |
1425 | errors with a descriptor in small file mode. | |
1426 | ||
1427 | When the source file is compiled using @code{_FILE_OFFSET_BITS == 64} on a | |
1428 | 32 bit machine this function is actually available under the name | |
1429 | @code{pwritev2} and so transparently replaces the 32 bit interface. | |
1430 | @end deftypefun | |
07435eb4 | 1431 | |
bad7a0c8 FW |
1432 | @node Copying File Data |
1433 | @section Copying data between two files | |
1434 | @cindex copying files | |
1435 | @cindex file copy | |
1436 | ||
1437 | A special function is provided to copy data between two files on the | |
1438 | same file system. The system can optimize such copy operations. This | |
1439 | is particularly important on network file systems, where the data would | |
1440 | otherwise have to be transferred twice over the network. | |
1441 | ||
1442 | Note that this function only copies file data, but not metadata such as | |
1443 | file permissions or extended attributes. | |
1444 | ||
1445 | @deftypefun ssize_t copy_file_range (int @var{inputfd}, off64_t *@var{inputpos}, int @var{outputfd}, off64_t *@var{outputpos}, ssize_t @var{length}, unsigned int @var{flags}) | |
1446 | @standards{GNU, unistd.h} | |
1447 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
1448 | ||
1449 | This function copies up to @var{length} bytes from the file descriptor | |
1450 | @var{inputfd} to the file descriptor @var{outputfd}. | |
1451 | ||
1452 | The function can operate on both the current file position (like | |
1453 | @code{read} and @code{write}) and an explicit offset (like @code{pread} | |
1454 | and @code{pwrite}). If the @var{inputpos} pointer is null, the file | |
1455 | position of @var{inputfd} is used as the starting point of the copy | |
1456 | operation, and the file position is advanced during it. If | |
1457 | @var{inputpos} is not null, then @code{*@var{inputpos}} is used as the | |
1458 | starting point of the copy operation, and @code{*@var{inputpos}} is | |
1459 | incremented by the number of copied bytes, but the file position remains | |
1460 | unchanged. Similar rules apply to @var{outputfd} and @var{outputpos} | |
1461 | for the output file position. | |
1462 | ||
1463 | The @var{flags} argument is currently reserved and must be zero. | |
1464 | ||
1465 | The @code{copy_file_range} function returns the number of bytes copied. | |
1466 | This can be less than the specified @var{length} in case the input file | |
1467 | contains fewer remaining bytes than @var{length}, or if a read or write | |
1468 | failure occurs. The return value is zero if the end of the input file | |
1469 | is encountered immediately. | |
1470 | ||
1471 | If no bytes can be copied, to report an error, @code{copy_file_range} | |
5a659ccc FW |
1472 | returns the value @math{-1} and sets @code{errno}. The table below |
1473 | lists some of the error conditions for this function. | |
bad7a0c8 FW |
1474 | |
1475 | @table @code | |
5a659ccc FW |
1476 | @item ENOSYS |
1477 | The kernel does not implement the required functionality. | |
1478 | ||
bad7a0c8 FW |
1479 | @item EISDIR |
1480 | At least one of the descriptors @var{inputfd} or @var{outputfd} refers | |
1481 | to a directory. | |
1482 | ||
1483 | @item EINVAL | |
1484 | At least one of the descriptors @var{inputfd} or @var{outputfd} refers | |
1485 | to a non-regular, non-directory file (such as a socket or a FIFO). | |
1486 | ||
1487 | The input or output positions before are after the copy operations are | |
1488 | outside of an implementation-defined limit. | |
1489 | ||
1490 | The @var{flags} argument is not zero. | |
1491 | ||
1492 | @item EFBIG | |
1493 | The new file size would exceed the process file size limit. | |
1494 | @xref{Limits on Resources}. | |
1495 | ||
1496 | The input or output positions before are after the copy operations are | |
1497 | outside of an implementation-defined limit. This can happen if the file | |
1498 | was not opened with large file support (LFS) on 32-bit machines, and the | |
1499 | copy operation would create a file which is larger than what | |
1500 | @code{off_t} could represent. | |
1501 | ||
1502 | @item EBADF | |
1503 | The argument @var{inputfd} is not a valid file descriptor open for | |
1504 | reading. | |
1505 | ||
1506 | The argument @var{outputfd} is not a valid file descriptor open for | |
1507 | writing, or @var{outputfd} has been opened with @code{O_APPEND}. | |
bad7a0c8 FW |
1508 | @end table |
1509 | ||
1510 | In addition, @code{copy_file_range} can fail with the error codes | |
1511 | which are used by @code{read}, @code{pread}, @code{write}, and | |
1512 | @code{pwrite}. | |
1513 | ||
1514 | The @code{copy_file_range} function is a cancellation point. In case of | |
1515 | cancellation, the input location (the file position or the value at | |
1516 | @code{*@var{inputpos}}) is indeterminate. | |
1517 | @end deftypefun | |
1518 | ||
07435eb4 UD |
1519 | @node Memory-mapped I/O |
1520 | @section Memory-mapped I/O | |
1521 | ||
1522 | On modern operating systems, it is possible to @dfn{mmap} (pronounced | |
1523 | ``em-map'') a file to a region of memory. When this is done, the file can | |
1524 | be accessed just like an array in the program. | |
1525 | ||
19e4c7dd | 1526 | This is more efficient than @code{read} or @code{write}, as only the regions |
04b9968b | 1527 | of the file that a program actually accesses are loaded. Accesses to |
07435eb4 UD |
1528 | not-yet-loaded parts of the mmapped region are handled in the same way as |
1529 | swapped out pages. | |
1530 | ||
b642f101 UD |
1531 | Since mmapped pages can be stored back to their file when physical |
1532 | memory is low, it is possible to mmap files orders of magnitude larger | |
1533 | than both the physical memory @emph{and} swap space. The only limit is | |
1534 | address space. The theoretical limit is 4GB on a 32-bit machine - | |
1535 | however, the actual limit will be smaller since some areas will be | |
1536 | reserved for other purposes. If the LFS interface is used the file size | |
1537 | on 32-bit systems is not limited to 2GB (offsets are signed which | |
1538 | reduces the addressable area of 4GB by half); the full 64-bit are | |
1539 | available. | |
07435eb4 UD |
1540 | |
1541 | Memory mapping only works on entire pages of memory. Thus, addresses | |
1542 | for mapping must be page-aligned, and length values will be rounded up. | |
a465b89e | 1543 | To determine the default size of a page the machine uses one should use: |
07435eb4 | 1544 | |
b642f101 | 1545 | @vindex _SC_PAGESIZE |
07435eb4 UD |
1546 | @smallexample |
1547 | size_t page_size = (size_t) sysconf (_SC_PAGESIZE); | |
1548 | @end smallexample | |
1549 | ||
a465b89e FW |
1550 | On some systems, mappings can use larger page sizes |
1551 | for certain files, and applications can request larger page sizes for | |
1552 | anonymous mappings as well (see the @code{MAP_HUGETLB} flag below). | |
1553 | ||
1554 | The following functions are declared in @file{sys/mman.h}: | |
07435eb4 | 1555 | |
cc6e48bc | 1556 | @deftypefun {void *} mmap (void *@var{address}, size_t @var{length}, int @var{protect}, int @var{flags}, int @var{filedes}, off_t @var{offset}) |
d08a7e4c | 1557 | @standards{POSIX, sys/mman.h} |
2cc3615c | 1558 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
07435eb4 UD |
1559 | |
1560 | The @code{mmap} function creates a new mapping, connected to bytes | |
b73147d0 | 1561 | (@var{offset}) to (@var{offset} + @var{length} - 1) in the file open on |
b61345a1 UD |
1562 | @var{filedes}. A new reference for the file specified by @var{filedes} |
1563 | is created, which is not removed by closing the file. | |
07435eb4 UD |
1564 | |
1565 | @var{address} gives a preferred starting address for the mapping. | |
cf822e3c OB |
1566 | @code{NULL} expresses no preference. Any previous mapping at that |
1567 | address is automatically removed. The address you give may still be | |
07435eb4 UD |
1568 | changed, unless you use the @code{MAP_FIXED} flag. |
1569 | ||
07435eb4 UD |
1570 | @var{protect} contains flags that control what kind of access is |
1571 | permitted. They include @code{PROT_READ}, @code{PROT_WRITE}, and | |
0f74bbf5 FW |
1572 | @code{PROT_EXEC}. The special flag @code{PROT_NONE} reserves a region |
1573 | of address space for future use. The @code{mprotect} function can be | |
1574 | used to change the protection flags. @xref{Memory Protection}. | |
07435eb4 UD |
1575 | |
1576 | @var{flags} contains flags that control the nature of the map. | |
1577 | One of @code{MAP_SHARED} or @code{MAP_PRIVATE} must be specified. | |
1578 | ||
1579 | They include: | |
1580 | ||
1581 | @vtable @code | |
1582 | @item MAP_PRIVATE | |
1583 | This specifies that writes to the region should never be written back | |
1584 | to the attached file. Instead, a copy is made for the process, and the | |
1585 | region will be swapped normally if memory runs low. No other process will | |
1586 | see the changes. | |
1587 | ||
1588 | Since private mappings effectively revert to ordinary memory | |
1589 | when written to, you must have enough virtual memory for a copy of | |
1590 | the entire mmapped region if you use this mode with @code{PROT_WRITE}. | |
1591 | ||
1592 | @item MAP_SHARED | |
1593 | This specifies that writes to the region will be written back to the | |
1594 | file. Changes made will be shared immediately with other processes | |
1595 | mmaping the same file. | |
1596 | ||
1597 | Note that actual writing may take place at any time. You need to use | |
1598 | @code{msync}, described below, if it is important that other processes | |
1599 | using conventional I/O get a consistent view of the file. | |
1600 | ||
1601 | @item MAP_FIXED | |
1602 | This forces the system to use the exact mapping address specified in | |
1603 | @var{address} and fail if it can't. | |
1604 | ||
1605 | @c One of these is official - the other is obviously an obsolete synonym | |
1606 | @c Which is which? | |
1607 | @item MAP_ANONYMOUS | |
1608 | @itemx MAP_ANON | |
1609 | This flag tells the system to create an anonymous mapping, not connected | |
9739d2d5 | 1610 | to a file. @var{filedes} and @var{offset} are ignored, and the region is |
07435eb4 UD |
1611 | initialized with zeros. |
1612 | ||
1613 | Anonymous maps are used as the basic primitive to extend the heap on some | |
1614 | systems. They are also useful to share data between multiple tasks | |
1615 | without creating a file. | |
1616 | ||
49c091e5 | 1617 | On some systems using private anonymous mmaps is more efficient than using |
1f77f049 | 1618 | @code{malloc} for large blocks. This is not an issue with @theglibc{}, |
07435eb4 UD |
1619 | as the included @code{malloc} automatically uses @code{mmap} where appropriate. |
1620 | ||
a465b89e FW |
1621 | @item MAP_HUGETLB |
1622 | @standards{Linux, sys/mman.h} | |
1623 | This requests that the system uses an alternative page size which is | |
1624 | larger than the default page size for the mapping. For some workloads, | |
1625 | increasing the page size for large mappings improves performance because | |
1626 | the system needs to handle far fewer pages. For other workloads which | |
1627 | require frequent transfer of pages between storage or different nodes, | |
1628 | the decreased page granularity may cause performance problems due to the | |
1629 | increased page size and larger transfers. | |
1630 | ||
1631 | In order to create the mapping, the system needs physically contiguous | |
1632 | memory of the size of the increased page size. As a result, | |
1633 | @code{MAP_HUGETLB} mappings are affected by memory fragmentation, and | |
1634 | their creation can fail even if plenty of memory is available in the | |
1635 | system. | |
1636 | ||
1637 | Not all file systems support mappings with an increased page size. | |
1638 | ||
1639 | The @code{MAP_HUGETLB} flag is specific to Linux. | |
1640 | ||
1641 | @c There is a mechanism to select different hugepage sizes; see | |
1642 | @c include/uapi/asm-generic/hugetlb_encode.h in the kernel sources. | |
1643 | ||
07435eb4 UD |
1644 | @c Linux has some other MAP_ options, which I have not discussed here. |
1645 | @c MAP_DENYWRITE, MAP_EXECUTABLE and MAP_GROWSDOWN don't seem applicable to | |
cf822e3c | 1646 | @c user programs (and I don't understand the last two). MAP_LOCKED does |
07435eb4 UD |
1647 | @c not appear to be implemented. |
1648 | ||
1649 | @end vtable | |
1650 | ||
52e6d801 FB |
1651 | @code{mmap} returns the address of the new mapping, or |
1652 | @code{MAP_FAILED} for an error. | |
07435eb4 UD |
1653 | |
1654 | Possible errors include: | |
1655 | ||
1656 | @table @code | |
1657 | ||
1658 | @item EINVAL | |
1659 | ||
a465b89e FW |
1660 | Either @var{address} was unusable (because it is not a multiple of the |
1661 | applicable page size), or inconsistent @var{flags} were given. | |
1662 | ||
1663 | If @code{MAP_HUGETLB} was specified, the file or system does not support | |
1664 | large page sizes. | |
07435eb4 UD |
1665 | |
1666 | @item EACCES | |
1667 | ||
1668 | @var{filedes} was not open for the type of access specified in @var{protect}. | |
1669 | ||
1670 | @item ENOMEM | |
1671 | ||
1672 | Either there is not enough memory for the operation, or the process is | |
1673 | out of address space. | |
1674 | ||
1675 | @item ENODEV | |
1676 | ||
1677 | This file is of a type that doesn't support mapping. | |
1678 | ||
1679 | @item ENOEXEC | |
1680 | ||
1681 | The file is on a filesystem that doesn't support mapping. | |
1682 | ||
1683 | @c On Linux, EAGAIN will appear if the file has a conflicting mandatory lock. | |
1684 | @c However mandatory locks are not discussed in this manual. | |
1685 | @c | |
1686 | @c Similarly, ETXTBSY will occur if the MAP_DENYWRITE flag (not documented | |
1687 | @c here) is used and the file is already open for writing. | |
1688 | ||
1689 | @end table | |
1690 | ||
1691 | @end deftypefun | |
1692 | ||
cc6e48bc | 1693 | @deftypefun {void *} mmap64 (void *@var{address}, size_t @var{length}, int @var{protect}, int @var{flags}, int @var{filedes}, off64_t @var{offset}) |
d08a7e4c | 1694 | @standards{LFS, sys/mman.h} |
2cc3615c AO |
1695 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
1696 | @c The page_shift auto detection when MMAP2_PAGE_SHIFT is -1 (it never | |
1697 | @c is) would be thread-unsafe. | |
b642f101 UD |
1698 | The @code{mmap64} function is equivalent to the @code{mmap} function but |
1699 | the @var{offset} parameter is of type @code{off64_t}. On 32-bit systems | |
1700 | this allows the file associated with the @var{filedes} descriptor to be | |
1701 | larger than 2GB. @var{filedes} must be a descriptor returned from a | |
1702 | call to @code{open64} or @code{fopen64} and @code{freopen64} where the | |
1703 | descriptor is retrieved with @code{fileno}. | |
1704 | ||
1705 | When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this | |
1706 | function is actually available under the name @code{mmap}. I.e., the | |
1707 | new, extended API using 64 bit file sizes and offsets transparently | |
1708 | replaces the old API. | |
1709 | @end deftypefun | |
1710 | ||
07435eb4 | 1711 | @deftypefun int munmap (void *@var{addr}, size_t @var{length}) |
d08a7e4c | 1712 | @standards{POSIX, sys/mman.h} |
2cc3615c | 1713 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
07435eb4 UD |
1714 | |
1715 | @code{munmap} removes any memory maps from (@var{addr}) to (@var{addr} + | |
1716 | @var{length}). @var{length} should be the length of the mapping. | |
1717 | ||
04b9968b | 1718 | It is safe to unmap multiple mappings in one command, or include unmapped |
07435eb4 | 1719 | space in the range. It is also possible to unmap only part of an existing |
04b9968b | 1720 | mapping. However, only entire pages can be removed. If @var{length} is not |
07435eb4 UD |
1721 | an even number of pages, it will be rounded up. |
1722 | ||
1723 | It returns @math{0} for success and @math{-1} for an error. | |
1724 | ||
1725 | One error is possible: | |
1726 | ||
1727 | @table @code | |
1728 | ||
1729 | @item EINVAL | |
04b9968b | 1730 | The memory range given was outside the user mmap range or wasn't page |
07435eb4 UD |
1731 | aligned. |
1732 | ||
1733 | @end table | |
1734 | ||
1735 | @end deftypefun | |
1736 | ||
1737 | @deftypefun int msync (void *@var{address}, size_t @var{length}, int @var{flags}) | |
d08a7e4c | 1738 | @standards{POSIX, sys/mman.h} |
2cc3615c | 1739 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
07435eb4 UD |
1740 | |
1741 | When using shared mappings, the kernel can write the file at any time | |
1742 | before the mapping is removed. To be certain data has actually been | |
49c091e5 UD |
1743 | written to the file and will be accessible to non-memory-mapped I/O, it |
1744 | is necessary to use this function. | |
07435eb4 UD |
1745 | |
1746 | It operates on the region @var{address} to (@var{address} + @var{length}). | |
1747 | It may be used on part of a mapping or multiple mappings, however the | |
1748 | region given should not contain any unmapped space. | |
1749 | ||
1750 | @var{flags} can contain some options: | |
1751 | ||
1752 | @vtable @code | |
1753 | ||
1754 | @item MS_SYNC | |
1755 | ||
1756 | This flag makes sure the data is actually written @emph{to disk}. | |
1757 | Normally @code{msync} only makes sure that accesses to a file with | |
1758 | conventional I/O reflect the recent changes. | |
1759 | ||
1760 | @item MS_ASYNC | |
1761 | ||
1762 | This tells @code{msync} to begin the synchronization, but not to wait for | |
1763 | it to complete. | |
1764 | ||
1765 | @c Linux also has MS_INVALIDATE, which I don't understand. | |
1766 | ||
1767 | @end vtable | |
1768 | ||
1769 | @code{msync} returns @math{0} for success and @math{-1} for | |
1770 | error. Errors include: | |
1771 | ||
1772 | @table @code | |
1773 | ||
1774 | @item EINVAL | |
1775 | An invalid region was given, or the @var{flags} were invalid. | |
1776 | ||
1777 | @item EFAULT | |
1778 | There is no existing mapping in at least part of the given region. | |
1779 | ||
1780 | @end table | |
1781 | ||
1782 | @end deftypefun | |
1783 | ||
1784 | @deftypefun {void *} mremap (void *@var{address}, size_t @var{length}, size_t @var{new_length}, int @var{flag}) | |
d08a7e4c | 1785 | @standards{GNU, sys/mman.h} |
2cc3615c | 1786 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
07435eb4 UD |
1787 | |
1788 | This function can be used to change the size of an existing memory | |
1789 | area. @var{address} and @var{length} must cover a region entirely mapped | |
cf822e3c | 1790 | in the same @code{mmap} statement. A new mapping with the same |
04b9968b | 1791 | characteristics will be returned with the length @var{new_length}. |
07435eb4 | 1792 | |
cf822e3c | 1793 | One option is possible, @code{MREMAP_MAYMOVE}. If it is given in |
07435eb4 UD |
1794 | @var{flags}, the system may remove the existing mapping and create a new |
1795 | one of the desired length in another location. | |
1796 | ||
cf822e3c | 1797 | The address of the resulting mapping is returned, or @math{-1}. Possible |
07435eb4 UD |
1798 | error codes include: |
1799 | ||
07435eb4 UD |
1800 | @table @code |
1801 | ||
1802 | @item EFAULT | |
1803 | There is no existing mapping in at least part of the original region, or | |
1804 | the region covers two or more distinct mappings. | |
1805 | ||
1806 | @item EINVAL | |
1807 | The address given is misaligned or inappropriate. | |
1808 | ||
1809 | @item EAGAIN | |
1810 | The region has pages locked, and if extended it would exceed the | |
1811 | process's resource limit for locked pages. @xref{Limits on Resources}. | |
1812 | ||
1813 | @item ENOMEM | |
19e4c7dd | 1814 | The region is private writable, and insufficient virtual memory is |
07435eb4 UD |
1815 | available to extend it. Also, this error will occur if |
1816 | @code{MREMAP_MAYMOVE} is not given and the extension would collide with | |
1817 | another mapped region. | |
1818 | ||
1819 | @end table | |
1820 | @end deftypefun | |
1821 | ||
04b9968b UD |
1822 | This function is only available on a few systems. Except for performing |
1823 | optional optimizations one should not rely on this function. | |
1824 | ||
07435eb4 UD |
1825 | Not all file descriptors may be mapped. Sockets, pipes, and most devices |
1826 | only allow sequential access and do not fit into the mapping abstraction. | |
1827 | In addition, some regular files may not be mmapable, and older kernels may | |
1828 | not support mapping at all. Thus, programs using @code{mmap} should | |
1829 | have a fallback method to use should it fail. @xref{Mmap,,,standards,GNU | |
1830 | Coding Standards}. | |
1831 | ||
0bc93a2f | 1832 | @deftypefun int madvise (void *@var{addr}, size_t @var{length}, int @var{advice}) |
d08a7e4c | 1833 | @standards{POSIX, sys/mman.h} |
2cc3615c | 1834 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
0bc93a2f AJ |
1835 | |
1836 | This function can be used to provide the system with @var{advice} about | |
1837 | the intended usage patterns of the memory region starting at @var{addr} | |
1838 | and extending @var{length} bytes. | |
1839 | ||
1840 | The valid BSD values for @var{advice} are: | |
1841 | ||
2fe82ca6 | 1842 | @vtable @code |
0bc93a2f AJ |
1843 | |
1844 | @item MADV_NORMAL | |
1845 | The region should receive no further special treatment. | |
1846 | ||
1847 | @item MADV_RANDOM | |
cf822e3c | 1848 | The region will be accessed via random page references. The kernel |
0bc93a2f AJ |
1849 | should page-in the minimal number of pages for each page fault. |
1850 | ||
1851 | @item MADV_SEQUENTIAL | |
cf822e3c | 1852 | The region will be accessed via sequential page references. This |
0bc93a2f AJ |
1853 | may cause the kernel to aggressively read-ahead, expecting further |
1854 | sequential references after any page fault within this region. | |
1855 | ||
1856 | @item MADV_WILLNEED | |
1857 | The region will be needed. The pages within this region may | |
1858 | be pre-faulted in by the kernel. | |
1859 | ||
1860 | @item MADV_DONTNEED | |
1861 | The region is no longer needed. The kernel may free these pages, | |
1862 | causing any changes to the pages to be lost, as well as swapped | |
1863 | out pages to be discarded. | |
1864 | ||
a465b89e FW |
1865 | @item MADV_HUGEPAGE |
1866 | @standards{Linux, sys/mman.h} | |
1867 | Indicate that it is beneficial to increase the page size for this | |
1868 | mapping. This can improve performance for larger mappings because the | |
1869 | system needs to handle far fewer pages. However, if parts of the | |
1870 | mapping are frequently transferred between storage or different nodes, | |
1871 | performance may suffer because individual transfers can become | |
1872 | substantially larger due to the increased page size. | |
1873 | ||
1874 | This flag is specific to Linux. | |
1875 | ||
1876 | @item MADV_NOHUGEPAGE | |
1877 | Undo the effect of a previous @code{MADV_HUGEPAGE} advice. This flag | |
1878 | is specific to Linux. | |
1879 | ||
2fe82ca6 | 1880 | @end vtable |
0bc93a2f AJ |
1881 | |
1882 | The POSIX names are slightly different, but with the same meanings: | |
1883 | ||
2fe82ca6 | 1884 | @vtable @code |
0bc93a2f AJ |
1885 | |
1886 | @item POSIX_MADV_NORMAL | |
1887 | This corresponds with BSD's @code{MADV_NORMAL}. | |
1888 | ||
1889 | @item POSIX_MADV_RANDOM | |
1890 | This corresponds with BSD's @code{MADV_RANDOM}. | |
1891 | ||
1892 | @item POSIX_MADV_SEQUENTIAL | |
1893 | This corresponds with BSD's @code{MADV_SEQUENTIAL}. | |
1894 | ||
1895 | @item POSIX_MADV_WILLNEED | |
1896 | This corresponds with BSD's @code{MADV_WILLNEED}. | |
1897 | ||
1898 | @item POSIX_MADV_DONTNEED | |
1899 | This corresponds with BSD's @code{MADV_DONTNEED}. | |
1900 | ||
2fe82ca6 | 1901 | @end vtable |
0bc93a2f | 1902 | |
bb4e6db2 | 1903 | @code{madvise} returns @math{0} for success and @math{-1} for |
0bc93a2f AJ |
1904 | error. Errors include: |
1905 | @table @code | |
1906 | ||
1907 | @item EINVAL | |
1908 | An invalid region was given, or the @var{advice} was invalid. | |
1909 | ||
1910 | @item EFAULT | |
1911 | There is no existing mapping in at least part of the given region. | |
1912 | ||
1913 | @end table | |
1914 | @end deftypefun | |
07435eb4 | 1915 | |
416e0145 | 1916 | @deftypefn Function int shm_open (const char *@var{name}, int @var{oflag}, mode_t @var{mode}) |
d08a7e4c | 1917 | @standards{POSIX, sys/mman.h} |
2cc3615c AO |
1918 | @safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@asuinit{} @ascuheap{} @asulock{}}@acunsafe{@aculock{} @acsmem{} @acsfd{}}} |
1919 | @c shm_open @mtslocale @asuinit @ascuheap @asulock @aculock @acsmem @acsfd | |
1920 | @c libc_once(where_is_shmfs) @mtslocale @asuinit @ascuheap @asulock @aculock @acsmem @acsfd | |
1921 | @c where_is_shmfs @mtslocale @ascuheap @asulock @aculock @acsmem @acsfd | |
1922 | @c statfs dup ok | |
1923 | @c setmntent dup @ascuheap @asulock @acsmem @acsfd @aculock | |
1924 | @c getmntent_r dup @mtslocale @ascuheap @aculock @acsmem [no @asucorrupt @acucorrupt; exclusive stream] | |
1925 | @c strcmp dup ok | |
1926 | @c strlen dup ok | |
1927 | @c malloc dup @ascuheap @acsmem | |
1928 | @c mempcpy dup ok | |
1929 | @c endmntent dup @ascuheap @asulock @aculock @acsmem @acsfd | |
1930 | @c strlen dup ok | |
1931 | @c strchr dup ok | |
1932 | @c mempcpy dup ok | |
1933 | @c open dup @acsfd | |
1934 | @c fcntl dup ok | |
1935 | @c close dup @acsfd | |
416e0145 OB |
1936 | |
1937 | This function returns a file descriptor that can be used to allocate shared | |
cf822e3c | 1938 | memory via mmap. Unrelated processes can use same @var{name} to create or |
416e0145 OB |
1939 | open existing shared memory objects. |
1940 | ||
1941 | A @var{name} argument specifies the shared memory object to be opened. | |
1942 | In @theglibc{} it must be a string smaller than @code{NAME_MAX} bytes starting | |
1943 | with an optional slash but containing no other slashes. | |
1944 | ||
1945 | The semantics of @var{oflag} and @var{mode} arguments is same as in @code{open}. | |
1946 | ||
1947 | @code{shm_open} returns the file descriptor on success or @math{-1} on error. | |
1948 | On failure @code{errno} is set. | |
1949 | @end deftypefn | |
1950 | ||
1951 | @deftypefn Function int shm_unlink (const char *@var{name}) | |
2cc3615c AO |
1952 | @safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@asuinit{} @ascuheap{} @asulock{}}@acunsafe{@aculock{} @acsmem{} @acsfd{}}} |
1953 | @c shm_unlink @mtslocale @asuinit @ascuheap @asulock @aculock @acsmem @acsfd | |
1954 | @c libc_once(where_is_shmfs) dup @mtslocale @asuinit @ascuheap @asulock @aculock @acsmem @acsfd | |
1955 | @c strlen dup ok | |
1956 | @c strchr dup ok | |
1957 | @c mempcpy dup ok | |
1958 | @c unlink dup ok | |
416e0145 | 1959 | |
9739d2d5 | 1960 | This function is the inverse of @code{shm_open} and removes the object with |
416e0145 OB |
1961 | the given @var{name} previously created by @code{shm_open}. |
1962 | ||
1963 | @code{shm_unlink} returns @math{0} on success or @math{-1} on error. | |
1964 | On failure @code{errno} is set. | |
1965 | @end deftypefn | |
1966 | ||
59d2cbb1 FW |
1967 | @deftypefun int memfd_create (const char *@var{name}, unsigned int @var{flags}) |
1968 | @standards{Linux, sys/mman.h} | |
1969 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{@acsfd{}}} | |
1970 | The @code{memfd_create} function returns a file descriptor which can be | |
1971 | used to create memory mappings using the @code{mmap} function. It is | |
1972 | similar to the @code{shm_open} function in the sense that these mappings | |
1973 | are not backed by actual files. However, the descriptor returned by | |
1974 | @code{memfd_create} does not correspond to a named object; the | |
1975 | @var{name} argument is used for debugging purposes only (e.g., will | |
1976 | appear in @file{/proc}), and separate invocations of @code{memfd_create} | |
1977 | with the same @var{name} will not return descriptors for the same region | |
1978 | of memory. The descriptor can also be used to create alias mappings | |
1979 | within the same process. | |
1980 | ||
1981 | The descriptor initially refers to a zero-length file. Before mappings | |
1982 | can be created which are backed by memory, the file size needs to be | |
1983 | increased with the @code{ftruncate} function. @xref{File Size}. | |
1984 | ||
1985 | The @var{flags} argument can be a combination of the following flags: | |
1986 | ||
1987 | @vtable @code | |
1988 | @item MFD_CLOEXEC | |
1989 | @standards{Linux, sys/mman.h} | |
1990 | The descriptor is created with the @code{O_CLOEXEC} flag. | |
1991 | ||
1992 | @item MFD_ALLOW_SEALING | |
1993 | @standards{Linux, sys/mman.h} | |
1994 | The descriptor supports the addition of seals using the @code{fcntl} | |
1995 | function. | |
1996 | ||
1997 | @item MFD_HUGETLB | |
1998 | @standards{Linux, sys/mman.h} | |
1999 | This requests that mappings created using the returned file descriptor | |
2000 | use a larger page size. See @code{MAP_HUGETLB} above for details. | |
2001 | ||
2002 | This flag is incompatible with @code{MFD_ALLOW_SEALING}. | |
2003 | @end vtable | |
2004 | ||
2005 | @code{memfd_create} returns a file descriptor on success, and @math{-1} | |
2006 | on failure. | |
2007 | ||
2008 | The following @code{errno} error conditions are defined for this | |
2009 | function: | |
2010 | ||
2011 | @table @code | |
2012 | @item EINVAL | |
2013 | An invalid combination is specified in @var{flags}, or @var{name} is | |
2014 | too long. | |
2015 | ||
2016 | @item EFAULT | |
2017 | The @var{name} argument does not point to a string. | |
2018 | ||
2019 | @item EMFILE | |
2020 | The operation would exceed the file descriptor limit for this process. | |
2021 | ||
2022 | @item ENFILE | |
2023 | The operation would exceed the system-wide file descriptor limit. | |
2024 | ||
2025 | @item ENOMEM | |
2026 | There is not enough memory for the operation. | |
2027 | @end table | |
2028 | @end deftypefun | |
2029 | ||
28f540f4 RM |
2030 | @node Waiting for I/O |
2031 | @section Waiting for Input or Output | |
2032 | @cindex waiting for input or output | |
2033 | @cindex multiplexing input | |
2034 | @cindex input from multiple files | |
2035 | ||
2036 | Sometimes a program needs to accept input on multiple input channels | |
2037 | whenever input arrives. For example, some workstations may have devices | |
2038 | such as a digitizing tablet, function button box, or dial box that are | |
2039 | connected via normal asynchronous serial interfaces; good user interface | |
2040 | style requires responding immediately to input on any device. Another | |
2041 | example is a program that acts as a server to several other processes | |
2042 | via pipes or sockets. | |
2043 | ||
2044 | You cannot normally use @code{read} for this purpose, because this | |
2045 | blocks the program until input is available on one particular file | |
2046 | descriptor; input on other channels won't wake it up. You could set | |
2047 | nonblocking mode and poll each file descriptor in turn, but this is very | |
2048 | inefficient. | |
2049 | ||
2050 | A better solution is to use the @code{select} function. This blocks the | |
2051 | program until input or output is ready on a specified set of file | |
2052 | descriptors, or until a timer expires, whichever comes first. This | |
2053 | facility is declared in the header file @file{sys/types.h}. | |
2054 | @pindex sys/types.h | |
2055 | ||
2056 | In the case of a server socket (@pxref{Listening}), we say that | |
2057 | ``input'' is available when there are pending connections that could be | |
2058 | accepted (@pxref{Accepting Connections}). @code{accept} for server | |
2059 | sockets blocks and interacts with @code{select} just as @code{read} does | |
2060 | for normal input. | |
2061 | ||
2062 | @cindex file descriptor sets, for @code{select} | |
2063 | The file descriptor sets for the @code{select} function are specified | |
2064 | as @code{fd_set} objects. Here is the description of the data type | |
2065 | and some macros for manipulating these objects. | |
2066 | ||
28f540f4 | 2067 | @deftp {Data Type} fd_set |
d08a7e4c | 2068 | @standards{BSD, sys/types.h} |
28f540f4 RM |
2069 | The @code{fd_set} data type represents file descriptor sets for the |
2070 | @code{select} function. It is actually a bit array. | |
2071 | @end deftp | |
2072 | ||
28f540f4 | 2073 | @deftypevr Macro int FD_SETSIZE |
d08a7e4c | 2074 | @standards{BSD, sys/types.h} |
28f540f4 RM |
2075 | The value of this macro is the maximum number of file descriptors that a |
2076 | @code{fd_set} object can hold information about. On systems with a | |
2077 | fixed maximum number, @code{FD_SETSIZE} is at least that number. On | |
2078 | some systems, including GNU, there is no absolute limit on the number of | |
2079 | descriptors open, but this macro still has a constant value which | |
2080 | controls the number of bits in an @code{fd_set}; if you get a file | |
2081 | descriptor with a value as high as @code{FD_SETSIZE}, you cannot put | |
2082 | that descriptor into an @code{fd_set}. | |
2083 | @end deftypevr | |
2084 | ||
28f540f4 | 2085 | @deftypefn Macro void FD_ZERO (fd_set *@var{set}) |
d08a7e4c | 2086 | @standards{BSD, sys/types.h} |
2cc3615c | 2087 | @safety{@prelim{}@mtsafe{@mtsrace{:set}}@assafe{}@acsafe{}} |
28f540f4 RM |
2088 | This macro initializes the file descriptor set @var{set} to be the |
2089 | empty set. | |
2090 | @end deftypefn | |
2091 | ||
28f540f4 | 2092 | @deftypefn Macro void FD_SET (int @var{filedes}, fd_set *@var{set}) |
d08a7e4c | 2093 | @standards{BSD, sys/types.h} |
2cc3615c AO |
2094 | @safety{@prelim{}@mtsafe{@mtsrace{:set}}@assafe{}@acsafe{}} |
2095 | @c Setting a bit isn't necessarily atomic, so there's a potential race | |
2096 | @c here if set is not used exclusively. | |
28f540f4 | 2097 | This macro adds @var{filedes} to the file descriptor set @var{set}. |
d9997a45 UD |
2098 | |
2099 | The @var{filedes} parameter must not have side effects since it is | |
2100 | evaluated more than once. | |
28f540f4 RM |
2101 | @end deftypefn |
2102 | ||
28f540f4 | 2103 | @deftypefn Macro void FD_CLR (int @var{filedes}, fd_set *@var{set}) |
d08a7e4c | 2104 | @standards{BSD, sys/types.h} |
2cc3615c AO |
2105 | @safety{@prelim{}@mtsafe{@mtsrace{:set}}@assafe{}@acsafe{}} |
2106 | @c Setting a bit isn't necessarily atomic, so there's a potential race | |
2107 | @c here if set is not used exclusively. | |
28f540f4 | 2108 | This macro removes @var{filedes} from the file descriptor set @var{set}. |
d9997a45 UD |
2109 | |
2110 | The @var{filedes} parameter must not have side effects since it is | |
2111 | evaluated more than once. | |
28f540f4 RM |
2112 | @end deftypefn |
2113 | ||
d9997a45 | 2114 | @deftypefn Macro int FD_ISSET (int @var{filedes}, const fd_set *@var{set}) |
d08a7e4c | 2115 | @standards{BSD, sys/types.h} |
2cc3615c | 2116 | @safety{@prelim{}@mtsafe{@mtsrace{:set}}@assafe{}@acsafe{}} |
28f540f4 | 2117 | This macro returns a nonzero value (true) if @var{filedes} is a member |
3081378b | 2118 | of the file descriptor set @var{set}, and zero (false) otherwise. |
d9997a45 UD |
2119 | |
2120 | The @var{filedes} parameter must not have side effects since it is | |
2121 | evaluated more than once. | |
28f540f4 RM |
2122 | @end deftypefn |
2123 | ||
2124 | Next, here is the description of the @code{select} function itself. | |
2125 | ||
28f540f4 | 2126 | @deftypefun int select (int @var{nfds}, fd_set *@var{read-fds}, fd_set *@var{write-fds}, fd_set *@var{except-fds}, struct timeval *@var{timeout}) |
d08a7e4c | 2127 | @standards{BSD, sys/types.h} |
2cc3615c AO |
2128 | @safety{@prelim{}@mtsafe{@mtsrace{:read-fds} @mtsrace{:write-fds} @mtsrace{:except-fds}}@assafe{}@acsafe{}} |
2129 | @c The select syscall is preferred, but pselect6 may be used instead, | |
2130 | @c which requires converting timeout to a timespec and back. The | |
2131 | @c conversions are not atomic. | |
28f540f4 RM |
2132 | The @code{select} function blocks the calling process until there is |
2133 | activity on any of the specified sets of file descriptors, or until the | |
2134 | timeout period has expired. | |
2135 | ||
2136 | The file descriptors specified by the @var{read-fds} argument are | |
2137 | checked to see if they are ready for reading; the @var{write-fds} file | |
2138 | descriptors are checked to see if they are ready for writing; and the | |
2139 | @var{except-fds} file descriptors are checked for exceptional | |
2140 | conditions. You can pass a null pointer for any of these arguments if | |
2141 | you are not interested in checking for that kind of condition. | |
2142 | ||
76de2021 UD |
2143 | A file descriptor is considered ready for reading if a @code{read} |
2144 | call will not block. This usually includes the read offset being at | |
2145 | the end of the file or there is an error to report. A server socket | |
2146 | is considered ready for reading if there is a pending connection which | |
2147 | can be accepted with @code{accept}; @pxref{Accepting Connections}. A | |
2148 | client socket is ready for writing when its connection is fully | |
2149 | established; @pxref{Connecting}. | |
28f540f4 RM |
2150 | |
2151 | ``Exceptional conditions'' does not mean errors---errors are reported | |
2152 | immediately when an erroneous system call is executed, and do not | |
2153 | constitute a state of the descriptor. Rather, they include conditions | |
2154 | such as the presence of an urgent message on a socket. (@xref{Sockets}, | |
2155 | for information on urgent messages.) | |
2156 | ||
2157 | The @code{select} function checks only the first @var{nfds} file | |
2158 | descriptors. The usual thing is to pass @code{FD_SETSIZE} as the value | |
2159 | of this argument. | |
2160 | ||
2161 | The @var{timeout} specifies the maximum time to wait. If you pass a | |
62193c4a ZW |
2162 | null pointer for this argument, it means to block indefinitely until |
2163 | one of the file descriptors is ready. Otherwise, you should provide | |
2164 | the time in @code{struct timeval} format; see @ref{Time Types}. | |
2165 | Specify zero as the time (a @code{struct timeval} containing all | |
2166 | zeros) if you want to find out which descriptors are ready without | |
28f540f4 RM |
2167 | waiting if none are ready. |
2168 | ||
2169 | The normal return value from @code{select} is the total number of ready file | |
2170 | descriptors in all of the sets. Each of the argument sets is overwritten | |
2171 | with information about the descriptors that are ready for the corresponding | |
2172 | operation. Thus, to see if a particular descriptor @var{desc} has input, | |
2173 | use @code{FD_ISSET (@var{desc}, @var{read-fds})} after @code{select} returns. | |
2174 | ||
2175 | If @code{select} returns because the timeout period expires, it returns | |
2176 | a value of zero. | |
2177 | ||
2178 | Any signal will cause @code{select} to return immediately. So if your | |
2179 | program uses signals, you can't rely on @code{select} to keep waiting | |
2180 | for the full time specified. If you want to be sure of waiting for a | |
2181 | particular amount of time, you must check for @code{EINTR} and repeat | |
2182 | the @code{select} with a newly calculated timeout based on the current | |
2183 | time. See the example below. See also @ref{Interrupted Primitives}. | |
2184 | ||
2185 | If an error occurs, @code{select} returns @code{-1} and does not modify | |
2c6fe0bd | 2186 | the argument file descriptor sets. The following @code{errno} error |
28f540f4 RM |
2187 | conditions are defined for this function: |
2188 | ||
2189 | @table @code | |
2190 | @item EBADF | |
2191 | One of the file descriptor sets specified an invalid file descriptor. | |
2192 | ||
2193 | @item EINTR | |
2194 | The operation was interrupted by a signal. @xref{Interrupted Primitives}. | |
2195 | ||
2196 | @item EINVAL | |
2197 | The @var{timeout} argument is invalid; one of the components is negative | |
2198 | or too large. | |
2199 | @end table | |
2200 | @end deftypefun | |
2201 | ||
2202 | @strong{Portability Note:} The @code{select} function is a BSD Unix | |
2203 | feature. | |
2204 | ||
2205 | Here is an example showing how you can use @code{select} to establish a | |
2206 | timeout period for reading from a file descriptor. The @code{input_timeout} | |
2207 | function blocks the calling process until input is available on the | |
2208 | file descriptor, or until the timeout period expires. | |
2209 | ||
2210 | @smallexample | |
2211 | @include select.c.texi | |
2212 | @end smallexample | |
2213 | ||
2214 | There is another example showing the use of @code{select} to multiplex | |
2215 | input from multiple sockets in @ref{Server Example}. | |
2216 | ||
2217 | ||
dfd2257a UD |
2218 | @node Synchronizing I/O |
2219 | @section Synchronizing I/O operations | |
2220 | ||
2221 | @cindex synchronizing | |
19e4c7dd | 2222 | In most modern operating systems, the normal I/O operations are not |
dfd2257a | 2223 | executed synchronously. I.e., even if a @code{write} system call |
19e4c7dd | 2224 | returns, this does not mean the data is actually written to the media, |
dfd2257a UD |
2225 | e.g., the disk. |
2226 | ||
19e4c7dd | 2227 | In situations where synchronization points are necessary, you can use |
04b9968b | 2228 | special functions which ensure that all operations finish before |
dfd2257a UD |
2229 | they return. |
2230 | ||
8ded91fb | 2231 | @deftypefun void sync (void) |
d08a7e4c | 2232 | @standards{X/Open, unistd.h} |
2cc3615c | 2233 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
dfd2257a | 2234 | A call to this function will not return as long as there is data which |
04b9968b | 2235 | has not been written to the device. All dirty buffers in the kernel will |
dfd2257a UD |
2236 | be written and so an overall consistent system can be achieved (if no |
2237 | other process in parallel writes data). | |
2238 | ||
2239 | A prototype for @code{sync} can be found in @file{unistd.h}. | |
dfd2257a UD |
2240 | @end deftypefun |
2241 | ||
04b9968b UD |
2242 | Programs more often want to ensure that data written to a given file is |
2243 | committed, rather than all data in the system. For this, @code{sync} is overkill. | |
2244 | ||
dfd2257a | 2245 | |
dfd2257a | 2246 | @deftypefun int fsync (int @var{fildes}) |
d08a7e4c | 2247 | @standards{POSIX, unistd.h} |
2cc3615c | 2248 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
19e4c7dd AJ |
2249 | The @code{fsync} function can be used to make sure all data associated with |
2250 | the open file @var{fildes} is written to the device associated with the | |
dfd2257a UD |
2251 | descriptor. The function call does not return unless all actions have |
2252 | finished. | |
2253 | ||
2254 | A prototype for @code{fsync} can be found in @file{unistd.h}. | |
2255 | ||
04b9968b | 2256 | This function is a cancellation point in multi-threaded programs. This |
dfd2257a UD |
2257 | is a problem if the thread allocates some resources (like memory, file |
2258 | descriptors, semaphores or whatever) at the time @code{fsync} is | |
19e4c7dd | 2259 | called. If the thread gets canceled these resources stay allocated |
04b9968b UD |
2260 | until the program ends. To avoid this, calls to @code{fsync} should be |
2261 | protected using cancellation handlers. | |
dfd2257a UD |
2262 | @c ref pthread_cleanup_push / pthread_cleanup_pop |
2263 | ||
49c091e5 | 2264 | The return value of the function is zero if no error occurred. Otherwise |
010fe231 | 2265 | it is @math{-1} and the global variable @code{errno} is set to the |
dfd2257a UD |
2266 | following values: |
2267 | @table @code | |
2268 | @item EBADF | |
2269 | The descriptor @var{fildes} is not valid. | |
2270 | ||
2271 | @item EINVAL | |
2272 | No synchronization is possible since the system does not implement this. | |
2273 | @end table | |
2274 | @end deftypefun | |
2275 | ||
2276 | Sometimes it is not even necessary to write all data associated with a | |
2277 | file descriptor. E.g., in database files which do not change in size it | |
2278 | is enough to write all the file content data to the device. | |
19e4c7dd | 2279 | Meta-information, like the modification time etc., are not that important |
dfd2257a | 2280 | and leaving such information uncommitted does not prevent a successful |
9739d2d5 | 2281 | recovery of the file in case of a problem. |
dfd2257a | 2282 | |
dfd2257a | 2283 | @deftypefun int fdatasync (int @var{fildes}) |
d08a7e4c | 2284 | @standards{POSIX, unistd.h} |
2cc3615c | 2285 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
04b9968b | 2286 | When a call to the @code{fdatasync} function returns, it is ensured |
dfd2257a | 2287 | that all of the file data is written to the device. For all pending I/O |
04b9968b | 2288 | operations, the parts guaranteeing data integrity finished. |
dfd2257a UD |
2289 | |
2290 | Not all systems implement the @code{fdatasync} operation. On systems | |
2291 | missing this functionality @code{fdatasync} is emulated by a call to | |
2292 | @code{fsync} since the performed actions are a superset of those | |
19e4c7dd | 2293 | required by @code{fdatasync}. |
dfd2257a UD |
2294 | |
2295 | The prototype for @code{fdatasync} is in @file{unistd.h}. | |
2296 | ||
49c091e5 | 2297 | The return value of the function is zero if no error occurred. Otherwise |
010fe231 | 2298 | it is @math{-1} and the global variable @code{errno} is set to the |
dfd2257a UD |
2299 | following values: |
2300 | @table @code | |
2301 | @item EBADF | |
2302 | The descriptor @var{fildes} is not valid. | |
2303 | ||
2304 | @item EINVAL | |
2305 | No synchronization is possible since the system does not implement this. | |
2306 | @end table | |
2307 | @end deftypefun | |
2308 | ||
2309 | ||
b07d03e0 UD |
2310 | @node Asynchronous I/O |
2311 | @section Perform I/O Operations in Parallel | |
2312 | ||
2313 | The POSIX.1b standard defines a new set of I/O operations which can | |
9739d2d5 | 2314 | significantly reduce the time an application spends waiting for I/O. The |
b07d03e0 | 2315 | new functions allow a program to initiate one or more I/O operations and |
04b9968b UD |
2316 | then immediately resume normal work while the I/O operations are |
2317 | executed in parallel. This functionality is available if the | |
a3a4a74e | 2318 | @file{unistd.h} file defines the symbol @code{_POSIX_ASYNCHRONOUS_IO}. |
b07d03e0 UD |
2319 | |
2320 | These functions are part of the library with realtime functions named | |
2321 | @file{librt}. They are not actually part of the @file{libc} binary. | |
2322 | The implementation of these functions can be done using support in the | |
c756c71c UD |
2323 | kernel (if available) or using an implementation based on threads at |
2324 | userlevel. In the latter case it might be necessary to link applications | |
fed8f7f7 | 2325 | with the thread library @file{libpthread} in addition to @file{librt}. |
b07d03e0 | 2326 | |
c756c71c | 2327 | All AIO operations operate on files which were opened previously. There |
04b9968b | 2328 | might be arbitrarily many operations running for one file. The |
b07d03e0 UD |
2329 | asynchronous I/O operations are controlled using a data structure named |
2330 | @code{struct aiocb} (@dfn{AIO control block}). It is defined in | |
2331 | @file{aio.h} as follows. | |
2332 | ||
b07d03e0 | 2333 | @deftp {Data Type} {struct aiocb} |
d08a7e4c | 2334 | @standards{POSIX.1b, aio.h} |
b07d03e0 UD |
2335 | The POSIX.1b standard mandates that the @code{struct aiocb} structure |
2336 | contains at least the members described in the following table. There | |
04b9968b | 2337 | might be more elements which are used by the implementation, but |
19e4c7dd | 2338 | depending upon these elements is not portable and is highly deprecated. |
b07d03e0 UD |
2339 | |
2340 | @table @code | |
2341 | @item int aio_fildes | |
19e4c7dd AJ |
2342 | This element specifies the file descriptor to be used for the |
2343 | operation. It must be a legal descriptor, otherwise the operation will | |
2344 | fail. | |
b07d03e0 UD |
2345 | |
2346 | The device on which the file is opened must allow the seek operation. | |
2347 | I.e., it is not possible to use any of the AIO operations on devices | |
2348 | like terminals where an @code{lseek} call would lead to an error. | |
2349 | ||
2350 | @item off_t aio_offset | |
19e4c7dd | 2351 | This element specifies the offset in the file at which the operation (input |
fed8f7f7 | 2352 | or output) is performed. Since the operations are carried out in arbitrary |
b07d03e0 UD |
2353 | order and more than one operation for one file descriptor can be |
2354 | started, one cannot expect a current read/write position of the file | |
2355 | descriptor. | |
2356 | ||
2357 | @item volatile void *aio_buf | |
2358 | This is a pointer to the buffer with the data to be written or the place | |
c756c71c | 2359 | where the read data is stored. |
b07d03e0 UD |
2360 | |
2361 | @item size_t aio_nbytes | |
2362 | This element specifies the length of the buffer pointed to by @code{aio_buf}. | |
2363 | ||
2364 | @item int aio_reqprio | |
c756c71c | 2365 | If the platform has defined @code{_POSIX_PRIORITIZED_IO} and |
19e4c7dd | 2366 | @code{_POSIX_PRIORITY_SCHEDULING}, the AIO requests are |
b07d03e0 UD |
2367 | processed based on the current scheduling priority. The |
2368 | @code{aio_reqprio} element can then be used to lower the priority of the | |
2369 | AIO operation. | |
2370 | ||
2371 | @item struct sigevent aio_sigevent | |
2372 | This element specifies how the calling process is notified once the | |
fed8f7f7 | 2373 | operation terminates. If the @code{sigev_notify} element is |
19e4c7dd AJ |
2374 | @code{SIGEV_NONE}, no notification is sent. If it is @code{SIGEV_SIGNAL}, |
2375 | the signal determined by @code{sigev_signo} is sent. Otherwise, | |
2376 | @code{sigev_notify} must be @code{SIGEV_THREAD}. In this case, a thread | |
c756c71c | 2377 | is created which starts executing the function pointed to by |
b07d03e0 UD |
2378 | @code{sigev_notify_function}. |
2379 | ||
2380 | @item int aio_lio_opcode | |
2381 | This element is only used by the @code{lio_listio} and | |
04b9968b UD |
2382 | @code{lio_listio64} functions. Since these functions allow an |
2383 | arbitrary number of operations to start at once, and each operation can be | |
2384 | input or output (or nothing), the information must be stored in the | |
b07d03e0 UD |
2385 | control block. The possible values are: |
2386 | ||
2387 | @vtable @code | |
2388 | @item LIO_READ | |
2389 | Start a read operation. Read from the file at position | |
2390 | @code{aio_offset} and store the next @code{aio_nbytes} bytes in the | |
2391 | buffer pointed to by @code{aio_buf}. | |
2392 | ||
2393 | @item LIO_WRITE | |
2394 | Start a write operation. Write @code{aio_nbytes} bytes starting at | |
2395 | @code{aio_buf} into the file starting at position @code{aio_offset}. | |
2396 | ||
2397 | @item LIO_NOP | |
2398 | Do nothing for this control block. This value is useful sometimes when | |
2399 | an array of @code{struct aiocb} values contains holes, i.e., some of the | |
fed8f7f7 | 2400 | values must not be handled although the whole array is presented to the |
b07d03e0 UD |
2401 | @code{lio_listio} function. |
2402 | @end vtable | |
2403 | @end table | |
a3a4a74e | 2404 | |
fed8f7f7 | 2405 | When the sources are compiled using @code{_FILE_OFFSET_BITS == 64} on a |
19e4c7dd | 2406 | 32 bit machine, this type is in fact @code{struct aiocb64}, since the LFS |
a3a4a74e UD |
2407 | interface transparently replaces the @code{struct aiocb} definition. |
2408 | @end deftp | |
2409 | ||
19e4c7dd | 2410 | For use with the AIO functions defined in the LFS, there is a similar type |
a3a4a74e | 2411 | defined which replaces the types of the appropriate members with larger |
04b9968b | 2412 | types but otherwise is equivalent to @code{struct aiocb}. Particularly, |
a3a4a74e UD |
2413 | all member names are the same. |
2414 | ||
a3a4a74e | 2415 | @deftp {Data Type} {struct aiocb64} |
d08a7e4c | 2416 | @standards{POSIX.1b, aio.h} |
a3a4a74e UD |
2417 | @table @code |
2418 | @item int aio_fildes | |
2419 | This element specifies the file descriptor which is used for the | |
2420 | operation. It must be a legal descriptor since otherwise the operation | |
2421 | fails for obvious reasons. | |
2422 | ||
2423 | The device on which the file is opened must allow the seek operation. | |
2424 | I.e., it is not possible to use any of the AIO operations on devices | |
2425 | like terminals where an @code{lseek} call would lead to an error. | |
2426 | ||
2427 | @item off64_t aio_offset | |
04b9968b | 2428 | This element specifies at which offset in the file the operation (input |
a3a4a74e UD |
2429 | or output) is performed. Since the operation are carried in arbitrary |
2430 | order and more than one operation for one file descriptor can be | |
2431 | started, one cannot expect a current read/write position of the file | |
2432 | descriptor. | |
2433 | ||
2434 | @item volatile void *aio_buf | |
2435 | This is a pointer to the buffer with the data to be written or the place | |
19e4c7dd | 2436 | where the read data is stored. |
a3a4a74e UD |
2437 | |
2438 | @item size_t aio_nbytes | |
2439 | This element specifies the length of the buffer pointed to by @code{aio_buf}. | |
2440 | ||
2441 | @item int aio_reqprio | |
2442 | If for the platform @code{_POSIX_PRIORITIZED_IO} and | |
04b9968b | 2443 | @code{_POSIX_PRIORITY_SCHEDULING} are defined the AIO requests are |
a3a4a74e UD |
2444 | processed based on the current scheduling priority. The |
2445 | @code{aio_reqprio} element can then be used to lower the priority of the | |
2446 | AIO operation. | |
2447 | ||
2448 | @item struct sigevent aio_sigevent | |
2449 | This element specifies how the calling process is notified once the | |
9739d2d5 | 2450 | operation terminates. If the @code{sigev_notify} element is |
19e4c7dd AJ |
2451 | @code{SIGEV_NONE} no notification is sent. If it is @code{SIGEV_SIGNAL}, |
2452 | the signal determined by @code{sigev_signo} is sent. Otherwise, | |
a3a4a74e | 2453 | @code{sigev_notify} must be @code{SIGEV_THREAD} in which case a thread |
9739d2d5 | 2454 | is created which starts executing the function pointed to by |
a3a4a74e UD |
2455 | @code{sigev_notify_function}. |
2456 | ||
2457 | @item int aio_lio_opcode | |
2458 | This element is only used by the @code{lio_listio} and | |
9739d2d5 | 2459 | @code{lio_listio64} functions. Since these functions allow an |
04b9968b UD |
2460 | arbitrary number of operations to start at once, and since each operation can be |
2461 | input or output (or nothing), the information must be stored in the | |
a3a4a74e UD |
2462 | control block. See the description of @code{struct aiocb} for a description |
2463 | of the possible values. | |
2464 | @end table | |
2465 | ||
2466 | When the sources are compiled using @code{_FILE_OFFSET_BITS == 64} on a | |
19e4c7dd AJ |
2467 | 32 bit machine, this type is available under the name @code{struct |
2468 | aiocb64}, since the LFS transparently replaces the old interface. | |
b07d03e0 UD |
2469 | @end deftp |
2470 | ||
2471 | @menu | |
a3a4a74e UD |
2472 | * Asynchronous Reads/Writes:: Asynchronous Read and Write Operations. |
2473 | * Status of AIO Operations:: Getting the Status of AIO Operations. | |
2474 | * Synchronizing AIO Operations:: Getting into a consistent state. | |
04b9968b | 2475 | * Cancel AIO Operations:: Cancellation of AIO Operations. |
a3a4a74e | 2476 | * Configuration of AIO:: How to optimize the AIO implementation. |
b07d03e0 UD |
2477 | @end menu |
2478 | ||
a3a4a74e UD |
2479 | @node Asynchronous Reads/Writes |
2480 | @subsection Asynchronous Read and Write Operations | |
b07d03e0 | 2481 | |
b07d03e0 | 2482 | @deftypefun int aio_read (struct aiocb *@var{aiocbp}) |
d08a7e4c | 2483 | @standards{POSIX.1b, aio.h} |
2cc3615c AO |
2484 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
2485 | @c Calls aio_enqueue_request. | |
2486 | @c aio_enqueue_request @asulock @ascuheap @aculock @acsmem | |
2487 | @c pthread_self ok | |
2488 | @c pthread_getschedparam @asulock @aculock | |
2489 | @c lll_lock (pthread descriptor's lock) @asulock @aculock | |
2490 | @c sched_getparam ok | |
2491 | @c sched_getscheduler ok | |
2492 | @c lll_unlock @aculock | |
2493 | @c pthread_mutex_lock (aio_requests_mutex) @asulock @aculock | |
2494 | @c get_elem @ascuheap @acsmem [@asucorrupt @acucorrupt] | |
2495 | @c realloc @ascuheap @acsmem | |
2496 | @c calloc @ascuheap @acsmem | |
2497 | @c aio_create_helper_thread @asulock @ascuheap @aculock @acsmem | |
2498 | @c pthread_attr_init ok | |
2499 | @c pthread_attr_setdetachstate ok | |
2500 | @c pthread_get_minstack ok | |
2501 | @c pthread_attr_setstacksize ok | |
2502 | @c sigfillset ok | |
2503 | @c memset ok | |
2504 | @c sigdelset ok | |
2505 | @c SYSCALL rt_sigprocmask ok | |
2506 | @c pthread_create @asulock @ascuheap @aculock @acsmem | |
2507 | @c lll_lock (default_pthread_attr_lock) @asulock @aculock | |
2508 | @c alloca/malloc @ascuheap @acsmem | |
2509 | @c lll_unlock @aculock | |
2510 | @c allocate_stack @asulock @ascuheap @aculock @acsmem | |
2511 | @c getpagesize dup | |
2512 | @c lll_lock (default_pthread_attr_lock) @asulock @aculock | |
2513 | @c lll_unlock @aculock | |
2514 | @c _dl_allocate_tls @ascuheap @acsmem | |
2515 | @c _dl_allocate_tls_storage @ascuheap @acsmem | |
2516 | @c memalign @ascuheap @acsmem | |
2517 | @c memset ok | |
2518 | @c allocate_dtv dup | |
2519 | @c free @ascuheap @acsmem | |
2520 | @c allocate_dtv @ascuheap @acsmem | |
2521 | @c calloc @ascuheap @acsmem | |
2522 | @c INSTALL_DTV ok | |
2523 | @c list_add dup | |
2524 | @c get_cached_stack | |
2525 | @c lll_lock (stack_cache_lock) @asulock @aculock | |
2526 | @c list_for_each ok | |
2527 | @c list_entry dup | |
2528 | @c FREE_P dup | |
2529 | @c stack_list_del dup | |
2530 | @c stack_list_add dup | |
2531 | @c lll_unlock @aculock | |
2532 | @c _dl_allocate_tls_init ok | |
2533 | @c GET_DTV ok | |
2534 | @c mmap ok | |
d1babeb3 | 2535 | @c atomic_fetch_add_relaxed ok |
2cc3615c AO |
2536 | @c munmap ok |
2537 | @c change_stack_perm ok | |
2538 | @c mprotect ok | |
2539 | @c mprotect ok | |
2540 | @c stack_list_del dup | |
2541 | @c _dl_deallocate_tls dup | |
2542 | @c munmap ok | |
2543 | @c THREAD_COPY_STACK_GUARD ok | |
2544 | @c THREAD_COPY_POINTER_GUARD ok | |
22f4ab2d | 2545 | @c atomic_exchange_acquire ok |
2cc3615c AO |
2546 | @c lll_futex_wake ok |
2547 | @c deallocate_stack @asulock @ascuheap @aculock @acsmem | |
2548 | @c lll_lock (state_cache_lock) @asulock @aculock | |
2549 | @c stack_list_del ok | |
2550 | @c atomic_write_barrier ok | |
2551 | @c list_del ok | |
2552 | @c atomic_write_barrier ok | |
2553 | @c queue_stack @ascuheap @acsmem | |
2554 | @c stack_list_add ok | |
2555 | @c atomic_write_barrier ok | |
2556 | @c list_add ok | |
2557 | @c atomic_write_barrier ok | |
2558 | @c free_stacks @ascuheap @acsmem | |
2559 | @c list_for_each_prev_safe ok | |
2560 | @c list_entry ok | |
2561 | @c FREE_P ok | |
2562 | @c stack_list_del dup | |
2563 | @c _dl_deallocate_tls dup | |
2564 | @c munmap ok | |
2565 | @c _dl_deallocate_tls @ascuheap @acsmem | |
2566 | @c free @ascuheap @acsmem | |
2567 | @c lll_unlock @aculock | |
2568 | @c create_thread @asulock @ascuheap @aculock @acsmem | |
2569 | @c td_eventword | |
2570 | @c td_eventmask | |
2571 | @c do_clone @asulock @ascuheap @aculock @acsmem | |
2572 | @c PREPARE_CREATE ok | |
2573 | @c lll_lock (pd->lock) @asulock @aculock | |
d1babeb3 | 2574 | @c atomic_fetch_add_relaxed ok |
2cc3615c | 2575 | @c clone ok |
a364a3a7 | 2576 | @c atomic_fetch_add_relaxed ok |
22f4ab2d | 2577 | @c atomic_exchange_acquire ok |
2cc3615c AO |
2578 | @c lll_futex_wake ok |
2579 | @c deallocate_stack dup | |
2580 | @c sched_setaffinity ok | |
2581 | @c tgkill ok | |
2582 | @c sched_setscheduler ok | |
2583 | @c atomic_compare_and_exchange_bool_acq ok | |
2584 | @c nptl_create_event ok | |
2585 | @c lll_unlock (pd->lock) @aculock | |
2586 | @c free @ascuheap @acsmem | |
2587 | @c pthread_attr_destroy ok (cpuset won't be set, so free isn't called) | |
2588 | @c add_request_to_runlist ok | |
2589 | @c pthread_cond_signal ok | |
2590 | @c aio_free_request ok | |
2591 | @c pthread_mutex_unlock @aculock | |
2592 | ||
2593 | @c (in the new thread, initiated with clone) | |
2594 | @c start_thread ok | |
2595 | @c HP_TIMING_NOW ok | |
2596 | @c ctype_init @mtslocale | |
22f4ab2d | 2597 | @c atomic_exchange_acquire ok |
2cc3615c AO |
2598 | @c lll_futex_wake ok |
2599 | @c sigemptyset ok | |
2600 | @c sigaddset ok | |
2601 | @c setjmp ok | |
ce0b7961 | 2602 | @c LIBC_CANCEL_ASYNC -> __pthread_enable_asynccancel ok |
2cc3615c AO |
2603 | @c do_cancel ok |
2604 | @c pthread_unwind ok | |
2605 | @c Unwind_ForcedUnwind or longjmp ok [@ascuheap @acsmem?] | |
2606 | @c lll_lock @asulock @aculock | |
2607 | @c lll_unlock @asulock @aculock | |
ce0b7961 | 2608 | @c LIBC_CANCEL_RESET -> __pthread_disable_asynccancel ok |
2cc3615c AO |
2609 | @c lll_futex_wait ok |
2610 | @c ->start_routine ok ----- | |
2611 | @c call_tls_dtors @asulock @ascuheap @aculock @acsmem | |
2612 | @c user-supplied dtor | |
2613 | @c rtld_lock_lock_recursive (dl_load_lock) @asulock @aculock | |
2614 | @c rtld_lock_unlock_recursive @aculock | |
2615 | @c free @ascuheap @acsmem | |
2616 | @c nptl_deallocate_tsd @ascuheap @acsmem | |
2617 | @c tsd user-supplied dtors ok | |
2618 | @c free @ascuheap @acsmem | |
2619 | @c libc_thread_freeres | |
2620 | @c libc_thread_subfreeres ok | |
4a07fbb6 | 2621 | @c atomic_fetch_add_relaxed ok |
2cc3615c AO |
2622 | @c td_eventword ok |
2623 | @c td_eventmask ok | |
2624 | @c atomic_compare_exchange_bool_acq ok | |
2625 | @c nptl_death_event ok | |
2626 | @c lll_robust_dead ok | |
2627 | @c getpagesize ok | |
2628 | @c madvise ok | |
2629 | @c free_tcb @asulock @ascuheap @aculock @acsmem | |
2630 | @c free @ascuheap @acsmem | |
2631 | @c deallocate_stack @asulock @ascuheap @aculock @acsmem | |
2632 | @c lll_futex_wait ok | |
2633 | @c exit_thread_inline ok | |
2634 | @c syscall(exit) ok | |
2635 | ||
04b9968b UD |
2636 | This function initiates an asynchronous read operation. It |
2637 | immediately returns after the operation was enqueued or when an | |
fed8f7f7 | 2638 | error was encountered. |
b07d03e0 | 2639 | |
a3a4a74e | 2640 | The first @code{aiocbp->aio_nbytes} bytes of the file for which |
c756c71c UD |
2641 | @code{aiocbp->aio_fildes} is a descriptor are written to the buffer |
2642 | starting at @code{aiocbp->aio_buf}. Reading starts at the absolute | |
2643 | position @code{aiocbp->aio_offset} in the file. | |
b07d03e0 UD |
2644 | |
2645 | If prioritized I/O is supported by the platform the | |
2646 | @code{aiocbp->aio_reqprio} value is used to adjust the priority before | |
2647 | the request is actually enqueued. | |
2648 | ||
2649 | The calling process is notified about the termination of the read | |
2650 | request according to the @code{aiocbp->aio_sigevent} value. | |
2651 | ||
04b9968b | 2652 | When @code{aio_read} returns, the return value is zero if no error |
b07d03e0 | 2653 | occurred that can be found before the process is enqueued. If such an |
04b9968b UD |
2654 | early error is found, the function returns @math{-1} and sets |
2655 | @code{errno} to one of the following values: | |
b07d03e0 UD |
2656 | |
2657 | @table @code | |
2658 | @item EAGAIN | |
2659 | The request was not enqueued due to (temporarily) exceeded resource | |
2660 | limitations. | |
2661 | @item ENOSYS | |
2662 | The @code{aio_read} function is not implemented. | |
2663 | @item EBADF | |
2664 | The @code{aiocbp->aio_fildes} descriptor is not valid. This condition | |
04b9968b | 2665 | need not be recognized before enqueueing the request and so this error |
fed8f7f7 | 2666 | might also be signaled asynchronously. |
b07d03e0 UD |
2667 | @item EINVAL |
2668 | The @code{aiocbp->aio_offset} or @code{aiocbp->aio_reqpiro} value is | |
2669 | invalid. This condition need not be recognized before enqueueing the | |
49c091e5 | 2670 | request and so this error might also be signaled asynchronously. |
b07d03e0 UD |
2671 | @end table |
2672 | ||
04b9968b UD |
2673 | If @code{aio_read} returns zero, the current status of the request |
2674 | can be queried using @code{aio_error} and @code{aio_return} functions. | |
2675 | As long as the value returned by @code{aio_error} is @code{EINPROGRESS} | |
2676 | the operation has not yet completed. If @code{aio_error} returns zero, | |
78759725 UD |
2677 | the operation successfully terminated, otherwise the value is to be |
2678 | interpreted as an error code. If the function terminated, the result of | |
2679 | the operation can be obtained using a call to @code{aio_return}. The | |
2680 | returned value is the same as an equivalent call to @code{read} would | |
04b9968b | 2681 | have returned. Possible error codes returned by @code{aio_error} are: |
b07d03e0 UD |
2682 | |
2683 | @table @code | |
2684 | @item EBADF | |
2685 | The @code{aiocbp->aio_fildes} descriptor is not valid. | |
2686 | @item ECANCELED | |
19e4c7dd | 2687 | The operation was canceled before the operation was finished |
b07d03e0 UD |
2688 | (@pxref{Cancel AIO Operations}) |
2689 | @item EINVAL | |
2690 | The @code{aiocbp->aio_offset} value is invalid. | |
2691 | @end table | |
a3a4a74e UD |
2692 | |
2693 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
2694 | function is in fact @code{aio_read64} since the LFS interface transparently | |
2695 | replaces the normal implementation. | |
b07d03e0 UD |
2696 | @end deftypefun |
2697 | ||
8ded91fb | 2698 | @deftypefun int aio_read64 (struct aiocb64 *@var{aiocbp}) |
d08a7e4c | 2699 | @standards{Unix98, aio.h} |
2cc3615c | 2700 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
b07d03e0 | 2701 | This function is similar to the @code{aio_read} function. The only |
19e4c7dd AJ |
2702 | difference is that on @w{32 bit} machines, the file descriptor should |
2703 | be opened in the large file mode. Internally, @code{aio_read64} uses | |
a3a4a74e UD |
2704 | functionality equivalent to @code{lseek64} (@pxref{File Position |
2705 | Primitive}) to position the file descriptor correctly for the reading, | |
9739d2d5 | 2706 | as opposed to the @code{lseek} functionality used in @code{aio_read}. |
a3a4a74e | 2707 | |
19e4c7dd | 2708 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this |
a3a4a74e | 2709 | function is available under the name @code{aio_read} and so transparently |
04b9968b | 2710 | replaces the interface for small files on 32 bit machines. |
b07d03e0 UD |
2711 | @end deftypefun |
2712 | ||
19e4c7dd | 2713 | To write data asynchronously to a file, there exists an equivalent pair |
a3a4a74e UD |
2714 | of functions with a very similar interface. |
2715 | ||
a3a4a74e | 2716 | @deftypefun int aio_write (struct aiocb *@var{aiocbp}) |
d08a7e4c | 2717 | @standards{POSIX.1b, aio.h} |
2cc3615c | 2718 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
a3a4a74e UD |
2719 | This function initiates an asynchronous write operation. The function |
2720 | call immediately returns after the operation was enqueued or if before | |
fed8f7f7 | 2721 | this happens an error was encountered. |
a3a4a74e UD |
2722 | |
2723 | The first @code{aiocbp->aio_nbytes} bytes from the buffer starting at | |
2724 | @code{aiocbp->aio_buf} are written to the file for which | |
9dcc8f11 | 2725 | @code{aiocbp->aio_fildes} is a descriptor, starting at the absolute |
a3a4a74e UD |
2726 | position @code{aiocbp->aio_offset} in the file. |
2727 | ||
19e4c7dd | 2728 | If prioritized I/O is supported by the platform, the |
a3a4a74e UD |
2729 | @code{aiocbp->aio_reqprio} value is used to adjust the priority before |
2730 | the request is actually enqueued. | |
2731 | ||
2732 | The calling process is notified about the termination of the read | |
2733 | request according to the @code{aiocbp->aio_sigevent} value. | |
2734 | ||
19e4c7dd | 2735 | When @code{aio_write} returns, the return value is zero if no error |
a3a4a74e UD |
2736 | occurred that can be found before the process is enqueued. If such an |
2737 | early error is found the function returns @math{-1} and sets | |
2738 | @code{errno} to one of the following values. | |
2739 | ||
2740 | @table @code | |
2741 | @item EAGAIN | |
2742 | The request was not enqueued due to (temporarily) exceeded resource | |
2743 | limitations. | |
2744 | @item ENOSYS | |
2745 | The @code{aio_write} function is not implemented. | |
2746 | @item EBADF | |
2747 | The @code{aiocbp->aio_fildes} descriptor is not valid. This condition | |
19e4c7dd | 2748 | may not be recognized before enqueueing the request, and so this error |
fed8f7f7 | 2749 | might also be signaled asynchronously. |
a3a4a74e | 2750 | @item EINVAL |
19e4c7dd AJ |
2751 | The @code{aiocbp->aio_offset} or @code{aiocbp->aio_reqprio} value is |
2752 | invalid. This condition may not be recognized before enqueueing the | |
fed8f7f7 | 2753 | request and so this error might also be signaled asynchronously. |
a3a4a74e UD |
2754 | @end table |
2755 | ||
19e4c7dd | 2756 | In the case @code{aio_write} returns zero, the current status of the |
9739d2d5 | 2757 | request can be queried using the @code{aio_error} and @code{aio_return} |
c756c71c | 2758 | functions. As long as the value returned by @code{aio_error} is |
a3a4a74e | 2759 | @code{EINPROGRESS} the operation has not yet completed. If |
19e4c7dd | 2760 | @code{aio_error} returns zero, the operation successfully terminated, |
a3a4a74e | 2761 | otherwise the value is to be interpreted as an error code. If the |
9739d2d5 | 2762 | function terminated, the result of the operation can be obtained using a call |
a3a4a74e | 2763 | to @code{aio_return}. The returned value is the same as an equivalent |
19e4c7dd | 2764 | call to @code{read} would have returned. Possible error codes returned |
a3a4a74e UD |
2765 | by @code{aio_error} are: |
2766 | ||
2767 | @table @code | |
2768 | @item EBADF | |
2769 | The @code{aiocbp->aio_fildes} descriptor is not valid. | |
2770 | @item ECANCELED | |
19e4c7dd | 2771 | The operation was canceled before the operation was finished. |
a3a4a74e UD |
2772 | (@pxref{Cancel AIO Operations}) |
2773 | @item EINVAL | |
2774 | The @code{aiocbp->aio_offset} value is invalid. | |
2775 | @end table | |
2776 | ||
19e4c7dd | 2777 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this |
a3a4a74e UD |
2778 | function is in fact @code{aio_write64} since the LFS interface transparently |
2779 | replaces the normal implementation. | |
2780 | @end deftypefun | |
2781 | ||
8ded91fb | 2782 | @deftypefun int aio_write64 (struct aiocb64 *@var{aiocbp}) |
d08a7e4c | 2783 | @standards{Unix98, aio.h} |
2cc3615c | 2784 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
a3a4a74e | 2785 | This function is similar to the @code{aio_write} function. The only |
04b9968b | 2786 | difference is that on @w{32 bit} machines the file descriptor should |
a3a4a74e UD |
2787 | be opened in the large file mode. Internally @code{aio_write64} uses |
2788 | functionality equivalent to @code{lseek64} (@pxref{File Position | |
2789 | Primitive}) to position the file descriptor correctly for the writing, | |
9739d2d5 | 2790 | as opposed to the @code{lseek} functionality used in @code{aio_write}. |
a3a4a74e | 2791 | |
19e4c7dd | 2792 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this |
a3a4a74e | 2793 | function is available under the name @code{aio_write} and so transparently |
04b9968b | 2794 | replaces the interface for small files on 32 bit machines. |
a3a4a74e UD |
2795 | @end deftypefun |
2796 | ||
19e4c7dd AJ |
2797 | Besides these functions with the more or less traditional interface, |
2798 | POSIX.1b also defines a function which can initiate more than one | |
2799 | operation at a time, and which can handle freely mixed read and write | |
2800 | operations. It is therefore similar to a combination of @code{readv} and | |
a3a4a74e UD |
2801 | @code{writev}. |
2802 | ||
a3a4a74e | 2803 | @deftypefun int lio_listio (int @var{mode}, struct aiocb *const @var{list}[], int @var{nent}, struct sigevent *@var{sig}) |
d08a7e4c | 2804 | @standards{POSIX.1b, aio.h} |
2cc3615c AO |
2805 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
2806 | @c Call lio_listio_internal, that takes the aio_requests_mutex lock and | |
2807 | @c enqueues each request. Then, it waits for notification or prepares | |
2808 | @c for it before releasing the lock. Even though it performs memory | |
2809 | @c allocation and locking of its own, it doesn't add any classes of | |
2810 | @c safety issues that aren't already covered by aio_enqueue_request. | |
a3a4a74e UD |
2811 | The @code{lio_listio} function can be used to enqueue an arbitrary |
2812 | number of read and write requests at one time. The requests can all be | |
2813 | meant for the same file, all for different files or every solution in | |
2814 | between. | |
2815 | ||
2816 | @code{lio_listio} gets the @var{nent} requests from the array pointed to | |
19e4c7dd | 2817 | by @var{list}. The operation to be performed is determined by the |
a3a4a74e | 2818 | @code{aio_lio_opcode} member in each element of @var{list}. If this |
19e4c7dd | 2819 | field is @code{LIO_READ} a read operation is enqueued, similar to a call |
a3a4a74e UD |
2820 | of @code{aio_read} for this element of the array (except that the way |
2821 | the termination is signalled is different, as we will see below). If | |
19e4c7dd | 2822 | the @code{aio_lio_opcode} member is @code{LIO_WRITE} a write operation |
a3a4a74e UD |
2823 | is enqueued. Otherwise the @code{aio_lio_opcode} must be @code{LIO_NOP} |
2824 | in which case this element of @var{list} is simply ignored. This | |
2825 | ``operation'' is useful in situations where one has a fixed array of | |
2826 | @code{struct aiocb} elements from which only a few need to be handled at | |
2827 | a time. Another situation is where the @code{lio_listio} call was | |
19e4c7dd | 2828 | canceled before all requests are processed (@pxref{Cancel AIO |
a3a4a74e UD |
2829 | Operations}) and the remaining requests have to be reissued. |
2830 | ||
fed8f7f7 | 2831 | The other members of each element of the array pointed to by |
a3a4a74e UD |
2832 | @code{list} must have values suitable for the operation as described in |
2833 | the documentation for @code{aio_read} and @code{aio_write} above. | |
2834 | ||
2835 | The @var{mode} argument determines how @code{lio_listio} behaves after | |
2836 | having enqueued all the requests. If @var{mode} is @code{LIO_WAIT} it | |
2837 | waits until all requests terminated. Otherwise @var{mode} must be | |
fed8f7f7 | 2838 | @code{LIO_NOWAIT} and in this case the function returns immediately after |
a3a4a74e UD |
2839 | having enqueued all the requests. In this case the caller gets a |
2840 | notification of the termination of all requests according to the | |
2841 | @var{sig} parameter. If @var{sig} is @code{NULL} no notification is | |
9739d2d5 | 2842 | sent. Otherwise a signal is sent or a thread is started, just as |
a3a4a74e UD |
2843 | described in the description for @code{aio_read} or @code{aio_write}. |
2844 | ||
19e4c7dd | 2845 | If @var{mode} is @code{LIO_WAIT}, the return value of @code{lio_listio} |
a3a4a74e | 2846 | is @math{0} when all requests completed successfully. Otherwise the |
9739d2d5 | 2847 | function returns @math{-1} and @code{errno} is set accordingly. To find |
a3a4a74e UD |
2848 | out which request or requests failed one has to use the @code{aio_error} |
2849 | function on all the elements of the array @var{list}. | |
2850 | ||
19e4c7dd | 2851 | In case @var{mode} is @code{LIO_NOWAIT}, the function returns @math{0} if |
a3a4a74e UD |
2852 | all requests were enqueued correctly. The current state of the requests |
2853 | can be found using @code{aio_error} and @code{aio_return} as described | |
19e4c7dd | 2854 | above. If @code{lio_listio} returns @math{-1} in this mode, the |
a3a4a74e | 2855 | global variable @code{errno} is set accordingly. If a request did not |
19e4c7dd AJ |
2856 | yet terminate, a call to @code{aio_error} returns @code{EINPROGRESS}. If |
2857 | the value is different, the request is finished and the error value (or | |
a3a4a74e UD |
2858 | @math{0}) is returned and the result of the operation can be retrieved |
2859 | using @code{aio_return}. | |
2860 | ||
2861 | Possible values for @code{errno} are: | |
2862 | ||
2863 | @table @code | |
2864 | @item EAGAIN | |
19e4c7dd | 2865 | The resources necessary to queue all the requests are not available at |
a3a4a74e | 2866 | the moment. The error status for each element of @var{list} must be |
19e4c7dd | 2867 | checked to determine which request failed. |
a3a4a74e | 2868 | |
fed8f7f7 | 2869 | Another reason could be that the system wide limit of AIO requests is |
a7a93d50 | 2870 | exceeded. This cannot be the case for the implementation on @gnusystems{} |
a3a4a74e UD |
2871 | since no arbitrary limits exist. |
2872 | @item EINVAL | |
2873 | The @var{mode} parameter is invalid or @var{nent} is larger than | |
2874 | @code{AIO_LISTIO_MAX}. | |
2875 | @item EIO | |
2876 | One or more of the request's I/O operations failed. The error status of | |
19e4c7dd | 2877 | each request should be checked to determine which one failed. |
a3a4a74e UD |
2878 | @item ENOSYS |
2879 | The @code{lio_listio} function is not supported. | |
2880 | @end table | |
2881 | ||
2882 | If the @var{mode} parameter is @code{LIO_NOWAIT} and the caller cancels | |
19e4c7dd | 2883 | a request, the error status for this request returned by |
a3a4a74e UD |
2884 | @code{aio_error} is @code{ECANCELED}. |
2885 | ||
19e4c7dd | 2886 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this |
a3a4a74e UD |
2887 | function is in fact @code{lio_listio64} since the LFS interface |
2888 | transparently replaces the normal implementation. | |
2889 | @end deftypefun | |
2890 | ||
8ded91fb | 2891 | @deftypefun int lio_listio64 (int @var{mode}, struct aiocb64 *const @var{list}[], int @var{nent}, struct sigevent *@var{sig}) |
d08a7e4c | 2892 | @standards{Unix98, aio.h} |
2cc3615c | 2893 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
19e4c7dd AJ |
2894 | This function is similar to the @code{lio_listio} function. The only |
2895 | difference is that on @w{32 bit} machines, the file descriptor should | |
2896 | be opened in the large file mode. Internally, @code{lio_listio64} uses | |
a3a4a74e UD |
2897 | functionality equivalent to @code{lseek64} (@pxref{File Position |
2898 | Primitive}) to position the file descriptor correctly for the reading or | |
9739d2d5 | 2899 | writing, as opposed to the @code{lseek} functionality used in |
a3a4a74e UD |
2900 | @code{lio_listio}. |
2901 | ||
19e4c7dd | 2902 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this |
a3a4a74e | 2903 | function is available under the name @code{lio_listio} and so |
04b9968b | 2904 | transparently replaces the interface for small files on 32 bit |
a3a4a74e UD |
2905 | machines. |
2906 | @end deftypefun | |
2907 | ||
2908 | @node Status of AIO Operations | |
2909 | @subsection Getting the Status of AIO Operations | |
2910 | ||
fed8f7f7 | 2911 | As already described in the documentation of the functions in the last |
04b9968b UD |
2912 | section, it must be possible to get information about the status of an I/O |
2913 | request. When the operation is performed truly asynchronously (as with | |
19e4c7dd AJ |
2914 | @code{aio_read} and @code{aio_write} and with @code{lio_listio} when the |
2915 | mode is @code{LIO_NOWAIT}), one sometimes needs to know whether a | |
2916 | specific request already terminated and if so, what the result was. | |
04b9968b | 2917 | The following two functions allow you to get this kind of information. |
a3a4a74e | 2918 | |
a3a4a74e | 2919 | @deftypefun int aio_error (const struct aiocb *@var{aiocbp}) |
d08a7e4c | 2920 | @standards{POSIX.1b, aio.h} |
2cc3615c | 2921 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
a3a4a74e | 2922 | This function determines the error state of the request described by the |
fed8f7f7 | 2923 | @code{struct aiocb} variable pointed to by @var{aiocbp}. If the |
a3a4a74e UD |
2924 | request has not yet terminated the value returned is always |
2925 | @code{EINPROGRESS}. Once the request has terminated the value | |
2926 | @code{aio_error} returns is either @math{0} if the request completed | |
fed8f7f7 | 2927 | successfully or it returns the value which would be stored in the |
a3a4a74e UD |
2928 | @code{errno} variable if the request would have been done using |
2929 | @code{read}, @code{write}, or @code{fsync}. | |
2930 | ||
2931 | The function can return @code{ENOSYS} if it is not implemented. It | |
2932 | could also return @code{EINVAL} if the @var{aiocbp} parameter does not | |
2933 | refer to an asynchronous operation whose return status is not yet known. | |
2934 | ||
2935 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
2936 | function is in fact @code{aio_error64} since the LFS interface | |
2937 | transparently replaces the normal implementation. | |
2938 | @end deftypefun | |
2939 | ||
a3a4a74e | 2940 | @deftypefun int aio_error64 (const struct aiocb64 *@var{aiocbp}) |
d08a7e4c | 2941 | @standards{Unix98, aio.h} |
2cc3615c | 2942 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
a3a4a74e UD |
2943 | This function is similar to @code{aio_error} with the only difference |
2944 | that the argument is a reference to a variable of type @code{struct | |
2945 | aiocb64}. | |
2946 | ||
2947 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
2948 | function is available under the name @code{aio_error} and so | |
04b9968b | 2949 | transparently replaces the interface for small files on 32 bit |
a3a4a74e UD |
2950 | machines. |
2951 | @end deftypefun | |
2952 | ||
8ded91fb | 2953 | @deftypefun ssize_t aio_return (struct aiocb *@var{aiocbp}) |
d08a7e4c | 2954 | @standards{POSIX.1b, aio.h} |
2cc3615c | 2955 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
a3a4a74e UD |
2956 | This function can be used to retrieve the return status of the operation |
2957 | carried out by the request described in the variable pointed to by | |
2958 | @var{aiocbp}. As long as the error status of this request as returned | |
9739d2d5 | 2959 | by @code{aio_error} is @code{EINPROGRESS} the return value of this function is |
a3a4a74e UD |
2960 | undefined. |
2961 | ||
fed8f7f7 UD |
2962 | Once the request is finished this function can be used exactly once to |
2963 | retrieve the return value. Following calls might lead to undefined | |
19e4c7dd | 2964 | behavior. The return value itself is the value which would have been |
a3a4a74e UD |
2965 | returned by the @code{read}, @code{write}, or @code{fsync} call. |
2966 | ||
2967 | The function can return @code{ENOSYS} if it is not implemented. It | |
2968 | could also return @code{EINVAL} if the @var{aiocbp} parameter does not | |
2969 | refer to an asynchronous operation whose return status is not yet known. | |
2970 | ||
2971 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
2972 | function is in fact @code{aio_return64} since the LFS interface | |
2973 | transparently replaces the normal implementation. | |
2974 | @end deftypefun | |
2975 | ||
8ded91fb | 2976 | @deftypefun ssize_t aio_return64 (struct aiocb64 *@var{aiocbp}) |
d08a7e4c | 2977 | @standards{Unix98, aio.h} |
2cc3615c | 2978 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
a3a4a74e UD |
2979 | This function is similar to @code{aio_return} with the only difference |
2980 | that the argument is a reference to a variable of type @code{struct | |
2981 | aiocb64}. | |
2982 | ||
2983 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
2984 | function is available under the name @code{aio_return} and so | |
04b9968b | 2985 | transparently replaces the interface for small files on 32 bit |
a3a4a74e UD |
2986 | machines. |
2987 | @end deftypefun | |
2988 | ||
2989 | @node Synchronizing AIO Operations | |
2990 | @subsection Getting into a Consistent State | |
2991 | ||
2992 | When dealing with asynchronous operations it is sometimes necessary to | |
fed8f7f7 | 2993 | get into a consistent state. This would mean for AIO that one wants to |
9739d2d5 | 2994 | know whether a certain request or a group of requests were processed. |
a3a4a74e | 2995 | This could be done by waiting for the notification sent by the system |
04b9968b | 2996 | after the operation terminated, but this sometimes would mean wasting |
a3a4a74e UD |
2997 | resources (mainly computation time). Instead POSIX.1b defines two |
2998 | functions which will help with most kinds of consistency. | |
2999 | ||
3000 | The @code{aio_fsync} and @code{aio_fsync64} functions are only available | |
19e4c7dd | 3001 | if the symbol @code{_POSIX_SYNCHRONIZED_IO} is defined in @file{unistd.h}. |
a3a4a74e UD |
3002 | |
3003 | @cindex synchronizing | |
a3a4a74e | 3004 | @deftypefun int aio_fsync (int @var{op}, struct aiocb *@var{aiocbp}) |
d08a7e4c | 3005 | @standards{POSIX.1b, aio.h} |
2cc3615c AO |
3006 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
3007 | @c After fcntl to check that the FD is open, it calls | |
3008 | @c aio_enqueue_request. | |
9739d2d5 | 3009 | Calling this function forces all I/O operations queued at the |
fed8f7f7 | 3010 | time of the function call operating on the file descriptor |
a3a4a74e | 3011 | @code{aiocbp->aio_fildes} into the synchronized I/O completion state |
04b9968b | 3012 | (@pxref{Synchronizing I/O}). The @code{aio_fsync} function returns |
a3a4a74e UD |
3013 | immediately but the notification through the method described in |
3014 | @code{aiocbp->aio_sigevent} will happen only after all requests for this | |
04b9968b | 3015 | file descriptor have terminated and the file is synchronized. This also |
a3a4a74e | 3016 | means that requests for this very same file descriptor which are queued |
04b9968b | 3017 | after the synchronization request are not affected. |
a3a4a74e UD |
3018 | |
3019 | If @var{op} is @code{O_DSYNC} the synchronization happens as with a call | |
3020 | to @code{fdatasync}. Otherwise @var{op} should be @code{O_SYNC} and | |
fed8f7f7 | 3021 | the synchronization happens as with @code{fsync}. |
a3a4a74e | 3022 | |
19e4c7dd | 3023 | As long as the synchronization has not happened, a call to |
a3a4a74e | 3024 | @code{aio_error} with the reference to the object pointed to by |
fed8f7f7 UD |
3025 | @var{aiocbp} returns @code{EINPROGRESS}. Once the synchronization is |
3026 | done @code{aio_error} return @math{0} if the synchronization was not | |
a3a4a74e UD |
3027 | successful. Otherwise the value returned is the value to which the |
3028 | @code{fsync} or @code{fdatasync} function would have set the | |
3029 | @code{errno} variable. In this case nothing can be assumed about the | |
9739d2d5 | 3030 | consistency of the data written to this file descriptor. |
a3a4a74e UD |
3031 | |
3032 | The return value of this function is @math{0} if the request was | |
19e4c7dd | 3033 | successfully enqueued. Otherwise the return value is @math{-1} and |
a3a4a74e UD |
3034 | @code{errno} is set to one of the following values: |
3035 | ||
3036 | @table @code | |
3037 | @item EAGAIN | |
fed8f7f7 | 3038 | The request could not be enqueued due to temporary lack of resources. |
a3a4a74e | 3039 | @item EBADF |
47792506 | 3040 | The file descriptor @code{@var{aiocbp}->aio_fildes} is not valid. |
a3a4a74e UD |
3041 | @item EINVAL |
3042 | The implementation does not support I/O synchronization or the @var{op} | |
3043 | parameter is other than @code{O_DSYNC} and @code{O_SYNC}. | |
3044 | @item ENOSYS | |
3045 | This function is not implemented. | |
3046 | @end table | |
3047 | ||
3048 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
37de3d55 | 3049 | function is in fact @code{aio_fsync64} since the LFS interface |
a3a4a74e UD |
3050 | transparently replaces the normal implementation. |
3051 | @end deftypefun | |
3052 | ||
a3a4a74e | 3053 | @deftypefun int aio_fsync64 (int @var{op}, struct aiocb64 *@var{aiocbp}) |
d08a7e4c | 3054 | @standards{Unix98, aio.h} |
2cc3615c | 3055 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
a3a4a74e UD |
3056 | This function is similar to @code{aio_fsync} with the only difference |
3057 | that the argument is a reference to a variable of type @code{struct | |
3058 | aiocb64}. | |
3059 | ||
3060 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
3061 | function is available under the name @code{aio_fsync} and so | |
04b9968b | 3062 | transparently replaces the interface for small files on 32 bit |
a3a4a74e UD |
3063 | machines. |
3064 | @end deftypefun | |
3065 | ||
fed8f7f7 | 3066 | Another method of synchronization is to wait until one or more requests of a |
a3a4a74e UD |
3067 | specific set terminated. This could be achieved by the @code{aio_*} |
3068 | functions to notify the initiating process about the termination but in | |
3069 | some situations this is not the ideal solution. In a program which | |
3070 | constantly updates clients somehow connected to the server it is not | |
3071 | always the best solution to go round robin since some connections might | |
9739d2d5 | 3072 | be slow. On the other hand letting the @code{aio_*} functions notify the |
a3a4a74e | 3073 | caller might also be not the best solution since whenever the process |
9739d2d5 | 3074 | works on preparing data for a client it makes no sense to be |
a3a4a74e UD |
3075 | interrupted by a notification since the new client will not be handled |
3076 | before the current client is served. For situations like this | |
3077 | @code{aio_suspend} should be used. | |
3078 | ||
a3a4a74e | 3079 | @deftypefun int aio_suspend (const struct aiocb *const @var{list}[], int @var{nent}, const struct timespec *@var{timeout}) |
d08a7e4c | 3080 | @standards{POSIX.1b, aio.h} |
2cc3615c AO |
3081 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}} |
3082 | @c Take aio_requests_mutex, set up waitlist and requestlist, wait | |
3083 | @c for completion or timeout, and release the mutex. | |
19e4c7dd | 3084 | When calling this function, the calling thread is suspended until at |
a3a4a74e | 3085 | least one of the requests pointed to by the @var{nent} elements of the |
19e4c7dd AJ |
3086 | array @var{list} has completed. If any of the requests has already |
3087 | completed at the time @code{aio_suspend} is called, the function returns | |
3088 | immediately. Whether a request has terminated or not is determined by | |
a3a4a74e | 3089 | comparing the error status of the request with @code{EINPROGRESS}. If |
19e4c7dd | 3090 | an element of @var{list} is @code{NULL}, the entry is simply ignored. |
a3a4a74e | 3091 | |
19e4c7dd AJ |
3092 | If no request has finished, the calling process is suspended. If |
3093 | @var{timeout} is @code{NULL}, the process is not woken until a request | |
3094 | has finished. If @var{timeout} is not @code{NULL}, the process remains | |
3095 | suspended at least as long as specified in @var{timeout}. In this case, | |
a3a4a74e UD |
3096 | @code{aio_suspend} returns with an error. |
3097 | ||
fed8f7f7 | 3098 | The return value of the function is @math{0} if one or more requests |
a3a4a74e UD |
3099 | from the @var{list} have terminated. Otherwise the function returns |
3100 | @math{-1} and @code{errno} is set to one of the following values: | |
3101 | ||
3102 | @table @code | |
3103 | @item EAGAIN | |
3104 | None of the requests from the @var{list} completed in the time specified | |
3105 | by @var{timeout}. | |
3106 | @item EINTR | |
3107 | A signal interrupted the @code{aio_suspend} function. This signal might | |
3108 | also be sent by the AIO implementation while signalling the termination | |
3109 | of one of the requests. | |
3110 | @item ENOSYS | |
3111 | The @code{aio_suspend} function is not implemented. | |
3112 | @end table | |
3113 | ||
3114 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
3115 | function is in fact @code{aio_suspend64} since the LFS interface | |
3116 | transparently replaces the normal implementation. | |
3117 | @end deftypefun | |
3118 | ||
a3a4a74e | 3119 | @deftypefun int aio_suspend64 (const struct aiocb64 *const @var{list}[], int @var{nent}, const struct timespec *@var{timeout}) |
d08a7e4c | 3120 | @standards{Unix98, aio.h} |
2cc3615c | 3121 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}} |
a3a4a74e UD |
3122 | This function is similar to @code{aio_suspend} with the only difference |
3123 | that the argument is a reference to a variable of type @code{struct | |
3124 | aiocb64}. | |
3125 | ||
3126 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this | |
3127 | function is available under the name @code{aio_suspend} and so | |
04b9968b | 3128 | transparently replaces the interface for small files on 32 bit |
a3a4a74e UD |
3129 | machines. |
3130 | @end deftypefun | |
b07d03e0 UD |
3131 | |
3132 | @node Cancel AIO Operations | |
04b9968b | 3133 | @subsection Cancellation of AIO Operations |
b07d03e0 | 3134 | |
19e4c7dd | 3135 | When one or more requests are asynchronously processed, it might be |
a3a4a74e | 3136 | useful in some situations to cancel a selected operation, e.g., if it |
19e4c7dd AJ |
3137 | becomes obvious that the written data is no longer accurate and would |
3138 | have to be overwritten soon. As an example, assume an application, which | |
a3a4a74e UD |
3139 | writes data in files in a situation where new incoming data would have |
3140 | to be written in a file which will be updated by an enqueued request. | |
19e4c7dd AJ |
3141 | The POSIX AIO implementation provides such a function, but this function |
3142 | is not capable of forcing the cancellation of the request. It is up to the | |
a3a4a74e UD |
3143 | implementation to decide whether it is possible to cancel the operation |
3144 | or not. Therefore using this function is merely a hint. | |
3145 | ||
a3a4a74e | 3146 | @deftypefun int aio_cancel (int @var{fildes}, struct aiocb *@var{aiocbp}) |
d08a7e4c | 3147 | @standards{POSIX.1b, aio.h} |
2cc3615c AO |
3148 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
3149 | @c After fcntl to check the fd is open, hold aio_requests_mutex, call | |
3150 | @c aio_find_req_fd, aio_remove_request, then aio_notify and | |
3151 | @c aio_free_request each request before releasing the lock. | |
3152 | @c aio_notify calls aio_notify_only and free, besides cond signal or | |
3153 | @c similar. aio_notify_only calls pthread_attr_init, | |
3154 | @c pthread_attr_setdetachstate, malloc, pthread_create, | |
3155 | @c notify_func_wrapper, aio_sigqueue, getpid, raise. | |
3156 | @c notify_func_wraper calls aio_start_notify_thread, free and then the | |
3157 | @c notifier function. | |
a3a4a74e | 3158 | The @code{aio_cancel} function can be used to cancel one or more |
19e4c7dd AJ |
3159 | outstanding requests. If the @var{aiocbp} parameter is @code{NULL}, the |
3160 | function tries to cancel all of the outstanding requests which would process | |
3161 | the file descriptor @var{fildes} (i.e., whose @code{aio_fildes} member | |
3162 | is @var{fildes}). If @var{aiocbp} is not @code{NULL}, @code{aio_cancel} | |
3163 | attempts to cancel the specific request pointed to by @var{aiocbp}. | |
a3a4a74e | 3164 | |
19e4c7dd | 3165 | For requests which were successfully canceled, the normal notification |
a3a4a74e UD |
3166 | about the termination of the request should take place. I.e., depending |
3167 | on the @code{struct sigevent} object which controls this, nothing | |
3168 | happens, a signal is sent or a thread is started. If the request cannot | |
19e4c7dd | 3169 | be canceled, it terminates the usual way after performing the operation. |
a3a4a74e | 3170 | |
19e4c7dd | 3171 | After a request is successfully canceled, a call to @code{aio_error} with |
a3a4a74e UD |
3172 | a reference to this request as the parameter will return |
3173 | @code{ECANCELED} and a call to @code{aio_return} will return @math{-1}. | |
19e4c7dd | 3174 | If the request wasn't canceled and is still running the error status is |
a3a4a74e UD |
3175 | still @code{EINPROGRESS}. |
3176 | ||
3177 | The return value of the function is @code{AIO_CANCELED} if there were | |
19e4c7dd AJ |
3178 | requests which haven't terminated and which were successfully canceled. |
3179 | If there is one or more requests left which couldn't be canceled, the | |
a3a4a74e | 3180 | return value is @code{AIO_NOTCANCELED}. In this case @code{aio_error} |
9739d2d5 | 3181 | must be used to find out which of the, perhaps multiple, requests (if |
19e4c7dd | 3182 | @var{aiocbp} is @code{NULL}) weren't successfully canceled. If all |
a3a4a74e UD |
3183 | requests already terminated at the time @code{aio_cancel} is called the |
3184 | return value is @code{AIO_ALLDONE}. | |
3185 | ||
3186 | If an error occurred during the execution of @code{aio_cancel} the | |
3187 | function returns @math{-1} and sets @code{errno} to one of the following | |
3188 | values. | |
3189 | ||
3190 | @table @code | |
3191 | @item EBADF | |
3192 | The file descriptor @var{fildes} is not valid. | |
3193 | @item ENOSYS | |
3194 | @code{aio_cancel} is not implemented. | |
3195 | @end table | |
3196 | ||
19e4c7dd | 3197 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this |
a3a4a74e UD |
3198 | function is in fact @code{aio_cancel64} since the LFS interface |
3199 | transparently replaces the normal implementation. | |
3200 | @end deftypefun | |
3201 | ||
19e4c7dd | 3202 | @deftypefun int aio_cancel64 (int @var{fildes}, struct aiocb64 *@var{aiocbp}) |
d08a7e4c | 3203 | @standards{Unix98, aio.h} |
2cc3615c | 3204 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{} @ascuheap{}}@acunsafe{@aculock{} @acsmem{}}} |
a3a4a74e UD |
3205 | This function is similar to @code{aio_cancel} with the only difference |
3206 | that the argument is a reference to a variable of type @code{struct | |
3207 | aiocb64}. | |
3208 | ||
19e4c7dd | 3209 | When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this |
a3a4a74e | 3210 | function is available under the name @code{aio_cancel} and so |
04b9968b | 3211 | transparently replaces the interface for small files on 32 bit |
a3a4a74e UD |
3212 | machines. |
3213 | @end deftypefun | |
3214 | ||
3215 | @node Configuration of AIO | |
3216 | @subsection How to optimize the AIO implementation | |
3217 | ||
3218 | The POSIX standard does not specify how the AIO functions are | |
19e4c7dd | 3219 | implemented. They could be system calls, but it is also possible to |
a3a4a74e UD |
3220 | emulate them at userlevel. |
3221 | ||
9739d2d5 | 3222 | At the time of writing, the available implementation is a user-level |
19e4c7dd AJ |
3223 | implementation which uses threads for handling the enqueued requests. |
3224 | While this implementation requires making some decisions about | |
9739d2d5 | 3225 | limitations, hard limitations are something best avoided |
1f77f049 | 3226 | in @theglibc{}. Therefore, @theglibc{} provides a means |
19e4c7dd | 3227 | for tuning the AIO implementation according to the individual use. |
a3a4a74e | 3228 | |
a3a4a74e | 3229 | @deftp {Data Type} {struct aioinit} |
d08a7e4c | 3230 | @standards{GNU, aio.h} |
a3a4a74e UD |
3231 | This data type is used to pass the configuration or tunable parameters |
3232 | to the implementation. The program has to initialize the members of | |
3233 | this struct and pass it to the implementation using the @code{aio_init} | |
3234 | function. | |
3235 | ||
3236 | @table @code | |
3237 | @item int aio_threads | |
19e4c7dd | 3238 | This member specifies the maximal number of threads which may be used |
a3a4a74e UD |
3239 | at any one time. |
3240 | @item int aio_num | |
c756c71c | 3241 | This number provides an estimate on the maximal number of simultaneously |
a3a4a74e UD |
3242 | enqueued requests. |
3243 | @item int aio_locks | |
19e4c7dd | 3244 | Unused. |
a3a4a74e | 3245 | @item int aio_usedba |
19e4c7dd | 3246 | Unused. |
a3a4a74e | 3247 | @item int aio_debug |
19e4c7dd | 3248 | Unused. |
a3a4a74e | 3249 | @item int aio_numusers |
19e4c7dd | 3250 | Unused. |
a3a4a74e | 3251 | @item int aio_reserved[2] |
19e4c7dd | 3252 | Unused. |
a3a4a74e UD |
3253 | @end table |
3254 | @end deftp | |
3255 | ||
a3a4a74e | 3256 | @deftypefun void aio_init (const struct aioinit *@var{init}) |
d08a7e4c | 3257 | @standards{GNU, aio.h} |
2cc3615c AO |
3258 | @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}} |
3259 | @c All changes to global objects are guarded by aio_requests_mutex. | |
a3a4a74e | 3260 | This function must be called before any other AIO function. Calling it |
19e4c7dd AJ |
3261 | is completely voluntary, as it is only meant to help the AIO |
3262 | implementation perform better. | |
a3a4a74e | 3263 | |
9739d2d5 | 3264 | Before calling @code{aio_init}, the members of a variable of |
a3a4a74e UD |
3265 | type @code{struct aioinit} must be initialized. Then a reference to |
3266 | this variable is passed as the parameter to @code{aio_init} which itself | |
3267 | may or may not pay attention to the hints. | |
3268 | ||
c756c71c | 3269 | The function has no return value and no error cases are defined. It is |
9739d2d5 | 3270 | an extension which follows a proposal from the SGI implementation in |
c756c71c | 3271 | @w{Irix 6}. It is not covered by POSIX.1b or Unix98. |
a3a4a74e | 3272 | @end deftypefun |
b07d03e0 | 3273 | |
28f540f4 RM |
3274 | @node Control Operations |
3275 | @section Control Operations on Files | |
3276 | ||
3277 | @cindex control operations on files | |
3278 | @cindex @code{fcntl} function | |
3279 | This section describes how you can perform various other operations on | |
3280 | file descriptors, such as inquiring about or setting flags describing | |
3281 | the status of the file descriptor, manipulating record locks, and the | |
3282 | like. All of these operations are performed by the function @code{fcntl}. | |
3283 | ||
3284 | The second argument to the @code{fcntl} function is a command that | |
3285 | specifies which operation to perform. The function and macros that name | |
3286 | various flags that are used with it are declared in the header file | |
3287 | @file{fcntl.h}. Many of these flags are also used by the @code{open} | |
3288 | function; see @ref{Opening and Closing Files}. | |
3289 | @pindex fcntl.h | |
3290 | ||
28f540f4 | 3291 | @deftypefun int fcntl (int @var{filedes}, int @var{command}, @dots{}) |
d08a7e4c | 3292 | @standards{POSIX.1, fcntl.h} |
2cc3615c | 3293 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
28f540f4 RM |
3294 | The @code{fcntl} function performs the operation specified by |
3295 | @var{command} on the file descriptor @var{filedes}. Some commands | |
3296 | require additional arguments to be supplied. These additional arguments | |
3297 | and the return value and error conditions are given in the detailed | |
3298 | descriptions of the individual commands. | |
3299 | ||
3300 | Briefly, here is a list of what the various commands are. | |
3301 | ||
2fe82ca6 | 3302 | @vtable @code |
28f540f4 RM |
3303 | @item F_DUPFD |
3304 | Duplicate the file descriptor (return another file descriptor pointing | |
3305 | to the same open file). @xref{Duplicating Descriptors}. | |
3306 | ||
3307 | @item F_GETFD | |
3308 | Get flags associated with the file descriptor. @xref{Descriptor Flags}. | |
3309 | ||
3310 | @item F_SETFD | |
3311 | Set flags associated with the file descriptor. @xref{Descriptor Flags}. | |
3312 | ||
3313 | @item F_GETFL | |
3314 | Get flags associated with the open file. @xref{File Status Flags}. | |
3315 | ||
3316 | @item F_SETFL | |
3317 | Set flags associated with the open file. @xref{File Status Flags}. | |
3318 | ||
3319 | @item F_GETLK | |
0961f7e1 | 3320 | Test a file lock. @xref{File Locks}. |
28f540f4 RM |
3321 | |
3322 | @item F_SETLK | |
3323 | Set or clear a file lock. @xref{File Locks}. | |
3324 | ||
3325 | @item F_SETLKW | |
3326 | Like @code{F_SETLK}, but wait for completion. @xref{File Locks}. | |
3327 | ||
0961f7e1 JL |
3328 | @item F_OFD_GETLK |
3329 | Test an open file description lock. @xref{Open File Description Locks}. | |
3330 | Specific to Linux. | |
3331 | ||
3332 | @item F_OFD_SETLK | |
3333 | Set or clear an open file description lock. @xref{Open File Description Locks}. | |
3334 | Specific to Linux. | |
3335 | ||
3336 | @item F_OFD_SETLKW | |
3337 | Like @code{F_OFD_SETLK}, but block until lock is acquired. | |
3338 | @xref{Open File Description Locks}. Specific to Linux. | |
3339 | ||
28f540f4 RM |
3340 | @item F_GETOWN |
3341 | Get process or process group ID to receive @code{SIGIO} signals. | |
3342 | @xref{Interrupt Input}. | |
3343 | ||
3344 | @item F_SETOWN | |
3345 | Set process or process group ID to receive @code{SIGIO} signals. | |
3346 | @xref{Interrupt Input}. | |
2fe82ca6 | 3347 | @end vtable |
dfd2257a | 3348 | |
06ab719d AZ |
3349 | This function is a cancellation point in multi-threaded programs for the |
3350 | commands @code{F_SETLKW} (and the LFS analogous @code{F_SETLKW64}) and | |
0b11b649 | 3351 | @code{F_OFD_SETLKW}. This is a problem if the thread allocates some |
06ab719d AZ |
3352 | resources (like memory, file descriptors, semaphores or whatever) at the time |
3353 | @code{fcntl} is called. If the thread gets canceled these resources stay | |
3354 | allocated until the program ends. To avoid this calls to @code{fcntl} should | |
3355 | be protected using cancellation handlers. | |
dfd2257a | 3356 | @c ref pthread_cleanup_push / pthread_cleanup_pop |
28f540f4 RM |
3357 | @end deftypefun |
3358 | ||
3359 | ||
3360 | @node Duplicating Descriptors | |
3361 | @section Duplicating Descriptors | |
3362 | ||
3363 | @cindex duplicating file descriptors | |
3364 | @cindex redirecting input and output | |
3365 | ||
3366 | You can @dfn{duplicate} a file descriptor, or allocate another file | |
3367 | descriptor that refers to the same open file as the original. Duplicate | |
3368 | descriptors share one file position and one set of file status flags | |
3369 | (@pxref{File Status Flags}), but each has its own set of file descriptor | |
3370 | flags (@pxref{Descriptor Flags}). | |
3371 | ||
3372 | The major use of duplicating a file descriptor is to implement | |
3373 | @dfn{redirection} of input or output: that is, to change the | |
3374 | file or pipe that a particular file descriptor corresponds to. | |
3375 | ||
3376 | You can perform this operation using the @code{fcntl} function with the | |
3377 | @code{F_DUPFD} command, but there are also convenient functions | |
3378 | @code{dup} and @code{dup2} for duplicating descriptors. | |
3379 | ||
3380 | @pindex unistd.h | |
3381 | @pindex fcntl.h | |
3382 | The @code{fcntl} function and flags are declared in @file{fcntl.h}, | |
3383 | while prototypes for @code{dup} and @code{dup2} are in the header file | |
3384 | @file{unistd.h}. | |
3385 | ||
28f540f4 | 3386 | @deftypefun int dup (int @var{old}) |
d08a7e4c | 3387 | @standards{POSIX.1, unistd.h} |
2cc3615c | 3388 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
28f540f4 RM |
3389 | This function copies descriptor @var{old} to the first available |
3390 | descriptor number (the first number not currently open). It is | |
3391 | equivalent to @code{fcntl (@var{old}, F_DUPFD, 0)}. | |
3392 | @end deftypefun | |
3393 | ||
28f540f4 | 3394 | @deftypefun int dup2 (int @var{old}, int @var{new}) |
d08a7e4c | 3395 | @standards{POSIX.1, unistd.h} |
2cc3615c | 3396 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
28f540f4 RM |
3397 | This function copies the descriptor @var{old} to descriptor number |
3398 | @var{new}. | |
3399 | ||
3400 | If @var{old} is an invalid descriptor, then @code{dup2} does nothing; it | |
3401 | does not close @var{new}. Otherwise, the new duplicate of @var{old} | |
3402 | replaces any previous meaning of descriptor @var{new}, as if @var{new} | |
3403 | were closed first. | |
3404 | ||
3405 | If @var{old} and @var{new} are different numbers, and @var{old} is a | |
3406 | valid descriptor number, then @code{dup2} is equivalent to: | |
3407 | ||
3408 | @smallexample | |
3409 | close (@var{new}); | |
3410 | fcntl (@var{old}, F_DUPFD, @var{new}) | |
3411 | @end smallexample | |
3412 | ||
3413 | However, @code{dup2} does this atomically; there is no instant in the | |
3414 | middle of calling @code{dup2} at which @var{new} is closed and not yet a | |
3415 | duplicate of @var{old}. | |
3416 | @end deftypefun | |
3417 | ||
a07e000e DD |
3418 | @deftypefun int dup3 (int @var{old}, int @var{new}, int @var{flags}) |
3419 | @standards{Linux, unistd.h} | |
3420 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} | |
3421 | This function is the same as @code{dup2} but creates the new | |
3422 | descriptor as if it had been opened with flags @var{flags}. The only | |
3423 | allowed flag is @code{O_CLOEXEC}. | |
3424 | @end deftypefun | |
3425 | ||
28f540f4 | 3426 | @deftypevr Macro int F_DUPFD |
d08a7e4c | 3427 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3428 | This macro is used as the @var{command} argument to @code{fcntl}, to |
3429 | copy the file descriptor given as the first argument. | |
3430 | ||
3431 | The form of the call in this case is: | |
3432 | ||
3433 | @smallexample | |
3434 | fcntl (@var{old}, F_DUPFD, @var{next-filedes}) | |
3435 | @end smallexample | |
3436 | ||
3437 | The @var{next-filedes} argument is of type @code{int} and specifies that | |
3438 | the file descriptor returned should be the next available one greater | |
3439 | than or equal to this value. | |
3440 | ||
3441 | The return value from @code{fcntl} with this command is normally the value | |
07435eb4 | 3442 | of the new file descriptor. A return value of @math{-1} indicates an |
28f540f4 RM |
3443 | error. The following @code{errno} error conditions are defined for |
3444 | this command: | |
3445 | ||
3446 | @table @code | |
3447 | @item EBADF | |
3448 | The @var{old} argument is invalid. | |
3449 | ||
3450 | @item EINVAL | |
3451 | The @var{next-filedes} argument is invalid. | |
3452 | ||
3453 | @item EMFILE | |
3454 | There are no more file descriptors available---your program is already | |
3455 | using the maximum. In BSD and GNU, the maximum is controlled by a | |
3456 | resource limit that can be changed; @pxref{Limits on Resources}, for | |
3457 | more information about the @code{RLIMIT_NOFILE} limit. | |
3458 | @end table | |
3459 | ||
3460 | @code{ENFILE} is not a possible error code for @code{dup2} because | |
3461 | @code{dup2} does not create a new opening of a file; duplicate | |
3462 | descriptors do not count toward the limit which @code{ENFILE} | |
3463 | indicates. @code{EMFILE} is possible because it refers to the limit on | |
3464 | distinct descriptor numbers in use in one process. | |
3465 | @end deftypevr | |
3466 | ||
3467 | Here is an example showing how to use @code{dup2} to do redirection. | |
3468 | Typically, redirection of the standard streams (like @code{stdin}) is | |
3469 | done by a shell or shell-like program before calling one of the | |
3470 | @code{exec} functions (@pxref{Executing a File}) to execute a new | |
3471 | program in a child process. When the new program is executed, it | |
3472 | creates and initializes the standard streams to point to the | |
3473 | corresponding file descriptors, before its @code{main} function is | |
3474 | invoked. | |
3475 | ||
3476 | So, to redirect standard input to a file, the shell could do something | |
3477 | like: | |
3478 | ||
3479 | @smallexample | |
3480 | pid = fork (); | |
3481 | if (pid == 0) | |
3482 | @{ | |
3483 | char *filename; | |
3484 | char *program; | |
3485 | int file; | |
3486 | @dots{} | |
3487 | file = TEMP_FAILURE_RETRY (open (filename, O_RDONLY)); | |
3488 | dup2 (file, STDIN_FILENO); | |
3489 | TEMP_FAILURE_RETRY (close (file)); | |
3490 | execv (program, NULL); | |
3491 | @} | |
3492 | @end smallexample | |
3493 | ||
3494 | There is also a more detailed example showing how to implement redirection | |
3495 | in the context of a pipeline of processes in @ref{Launching Jobs}. | |
3496 | ||
3497 | ||
3498 | @node Descriptor Flags | |
3499 | @section File Descriptor Flags | |
3500 | @cindex file descriptor flags | |
3501 | ||
3502 | @dfn{File descriptor flags} are miscellaneous attributes of a file | |
3503 | descriptor. These flags are associated with particular file | |
3504 | descriptors, so that if you have created duplicate file descriptors | |
3505 | from a single opening of a file, each descriptor has its own set of flags. | |
3506 | ||
3507 | Currently there is just one file descriptor flag: @code{FD_CLOEXEC}, | |
3508 | which causes the descriptor to be closed if you use any of the | |
3509 | @code{exec@dots{}} functions (@pxref{Executing a File}). | |
3510 | ||
3511 | The symbols in this section are defined in the header file | |
3512 | @file{fcntl.h}. | |
3513 | @pindex fcntl.h | |
3514 | ||
28f540f4 | 3515 | @deftypevr Macro int F_GETFD |
d08a7e4c | 3516 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3517 | This macro is used as the @var{command} argument to @code{fcntl}, to |
3518 | specify that it should return the file descriptor flags associated | |
2c6fe0bd | 3519 | with the @var{filedes} argument. |
28f540f4 RM |
3520 | |
3521 | The normal return value from @code{fcntl} with this command is a | |
3522 | nonnegative number which can be interpreted as the bitwise OR of the | |
3523 | individual flags (except that currently there is only one flag to use). | |
3524 | ||
07435eb4 | 3525 | In case of an error, @code{fcntl} returns @math{-1}. The following |
28f540f4 RM |
3526 | @code{errno} error conditions are defined for this command: |
3527 | ||
3528 | @table @code | |
3529 | @item EBADF | |
3530 | The @var{filedes} argument is invalid. | |
3531 | @end table | |
3532 | @end deftypevr | |
3533 | ||
3534 | ||
28f540f4 | 3535 | @deftypevr Macro int F_SETFD |
d08a7e4c | 3536 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3537 | This macro is used as the @var{command} argument to @code{fcntl}, to |
3538 | specify that it should set the file descriptor flags associated with the | |
3539 | @var{filedes} argument. This requires a third @code{int} argument to | |
3540 | specify the new flags, so the form of the call is: | |
3541 | ||
3542 | @smallexample | |
3543 | fcntl (@var{filedes}, F_SETFD, @var{new-flags}) | |
3544 | @end smallexample | |
3545 | ||
3546 | The normal return value from @code{fcntl} with this command is an | |
07435eb4 | 3547 | unspecified value other than @math{-1}, which indicates an error. |
28f540f4 RM |
3548 | The flags and error conditions are the same as for the @code{F_GETFD} |
3549 | command. | |
3550 | @end deftypevr | |
3551 | ||
3552 | The following macro is defined for use as a file descriptor flag with | |
3553 | the @code{fcntl} function. The value is an integer constant usable | |
3554 | as a bit mask value. | |
3555 | ||
28f540f4 | 3556 | @deftypevr Macro int FD_CLOEXEC |
d08a7e4c | 3557 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3558 | @cindex close-on-exec (file descriptor flag) |
3559 | This flag specifies that the file descriptor should be closed when | |
3560 | an @code{exec} function is invoked; see @ref{Executing a File}. When | |
3561 | a file descriptor is allocated (as with @code{open} or @code{dup}), | |
3562 | this bit is initially cleared on the new file descriptor, meaning that | |
3563 | descriptor will survive into the new program after @code{exec}. | |
3564 | @end deftypevr | |
3565 | ||
3566 | If you want to modify the file descriptor flags, you should get the | |
3567 | current flags with @code{F_GETFD} and modify the value. Don't assume | |
3568 | that the flags listed here are the only ones that are implemented; your | |
3569 | program may be run years from now and more flags may exist then. For | |
3570 | example, here is a function to set or clear the flag @code{FD_CLOEXEC} | |
3571 | without altering any other flags: | |
3572 | ||
3573 | @smallexample | |
3574 | /* @r{Set the @code{FD_CLOEXEC} flag of @var{desc} if @var{value} is nonzero,} | |
3575 | @r{or clear the flag if @var{value} is 0.} | |
2c6fe0bd | 3576 | @r{Return 0 on success, or -1 on error with @code{errno} set.} */ |
28f540f4 RM |
3577 | |
3578 | int | |
3579 | set_cloexec_flag (int desc, int value) | |
3580 | @{ | |
3581 | int oldflags = fcntl (desc, F_GETFD, 0); | |
8e96ae1a | 3582 | /* @r{If reading the flags failed, return error indication now.} */ |
28f540f4 RM |
3583 | if (oldflags < 0) |
3584 | return oldflags; | |
3585 | /* @r{Set just the flag we want to set.} */ | |
3586 | if (value != 0) | |
3587 | oldflags |= FD_CLOEXEC; | |
3588 | else | |
3589 | oldflags &= ~FD_CLOEXEC; | |
3590 | /* @r{Store modified flag word in the descriptor.} */ | |
3591 | return fcntl (desc, F_SETFD, oldflags); | |
3592 | @} | |
3593 | @end smallexample | |
3594 | ||
3595 | @node File Status Flags | |
3596 | @section File Status Flags | |
3597 | @cindex file status flags | |
3598 | ||
3599 | @dfn{File status flags} are used to specify attributes of the opening of a | |
3600 | file. Unlike the file descriptor flags discussed in @ref{Descriptor | |
3601 | Flags}, the file status flags are shared by duplicated file descriptors | |
3602 | resulting from a single opening of the file. The file status flags are | |
3603 | specified with the @var{flags} argument to @code{open}; | |
3604 | @pxref{Opening and Closing Files}. | |
3605 | ||
3606 | File status flags fall into three categories, which are described in the | |
3607 | following sections. | |
3608 | ||
3609 | @itemize @bullet | |
3610 | @item | |
3611 | @ref{Access Modes}, specify what type of access is allowed to the | |
3612 | file: reading, writing, or both. They are set by @code{open} and are | |
3613 | returned by @code{fcntl}, but cannot be changed. | |
3614 | ||
3615 | @item | |
3616 | @ref{Open-time Flags}, control details of what @code{open} will do. | |
3617 | These flags are not preserved after the @code{open} call. | |
3618 | ||
3619 | @item | |
3620 | @ref{Operating Modes}, affect how operations such as @code{read} and | |
3621 | @code{write} are done. They are set by @code{open}, and can be fetched or | |
3622 | changed with @code{fcntl}. | |
3623 | @end itemize | |
3624 | ||
3625 | The symbols in this section are defined in the header file | |
3626 | @file{fcntl.h}. | |
3627 | @pindex fcntl.h | |
3628 | ||
3629 | @menu | |
3630 | * Access Modes:: Whether the descriptor can read or write. | |
3631 | * Open-time Flags:: Details of @code{open}. | |
3632 | * Operating Modes:: Special modes to control I/O operations. | |
3633 | * Getting File Status Flags:: Fetching and changing these flags. | |
3634 | @end menu | |
3635 | ||
3636 | @node Access Modes | |
3637 | @subsection File Access Modes | |
3638 | ||
e960d831 FW |
3639 | The file access mode allows a file descriptor to be used for reading, |
3640 | writing, both, or neither. The access mode is determined when the file | |
3641 | is opened, and never change. | |
28f540f4 | 3642 | |
28f540f4 | 3643 | @deftypevr Macro int O_RDONLY |
d08a7e4c | 3644 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3645 | Open the file for read access. |
3646 | @end deftypevr | |
3647 | ||
28f540f4 | 3648 | @deftypevr Macro int O_WRONLY |
d08a7e4c | 3649 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3650 | Open the file for write access. |
3651 | @end deftypevr | |
3652 | ||
28f540f4 | 3653 | @deftypevr Macro int O_RDWR |
d08a7e4c | 3654 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3655 | Open the file for both reading and writing. |
3656 | @end deftypevr | |
3657 | ||
e960d831 FW |
3658 | @deftypevr Macro int O_PATH |
3659 | @standards{Linux, fcntl.h} | |
3660 | Obtain a file descriptor for the file, but do not open the file for | |
3661 | reading or writing. Permission checks for the file itself are skipped | |
3662 | when the file is opened (but permission to access the directory that | |
3663 | contains it is still needed), and permissions are checked when the | |
3664 | descriptor is used later on. | |
3665 | ||
3666 | For example, such descriptors can be used with the @code{fexecve} | |
3667 | function (@pxref{Executing a File}). | |
3668 | ||
3669 | This access mode is specific to Linux. On @gnuhurdsystems{}, it is | |
3670 | possible to use @code{O_EXEC} explicitly, or specify no access modes | |
3671 | at all (see below). | |
3672 | @end deftypevr | |
3673 | ||
3674 | The portable file access modes @code{O_RDONLY}, @code{O_WRONLY}, and | |
3675 | @code{O_RDWR} may not correspond to individual bits. To determine the | |
3676 | file access mode with @code{fcntl}, you must extract the access mode | |
3677 | bits from the retrieved file status flags, using the @code{O_ACCMODE} | |
3678 | mask. | |
3679 | ||
3680 | @deftypevr Macro int O_ACCMODE | |
3681 | @standards{POSIX.1, fcntl.h} | |
3682 | ||
3683 | This macro is a mask that can be bitwise-ANDed with the file status flag | |
3684 | value to recover the file access mode, assuming that a standard file | |
3685 | access mode is in use. | |
3686 | @end deftypevr | |
3687 | ||
3688 | If a non-standard file access mode is used (such as @code{O_PATH} or | |
3689 | @code{O_EXEC}), masking with @code{O_ACCMODE} may give incorrect | |
3690 | results. These non-standard access modes are identified by individual | |
3691 | bits and have to be checked directly (without masking with | |
3692 | @code{O_ACCMODE} first). | |
3693 | ||
3694 | On @gnuhurdsystems{} (but not on other systems), @code{O_RDONLY} and | |
28f540f4 RM |
3695 | @code{O_WRONLY} are independent bits that can be bitwise-ORed together, |
3696 | and it is valid for either bit to be set or clear. This means that | |
3697 | @code{O_RDWR} is the same as @code{O_RDONLY|O_WRONLY}. A file access | |
3698 | mode of zero is permissible; it allows no operations that do input or | |
3699 | output to the file, but does allow other operations such as | |
a7a93d50 | 3700 | @code{fchmod}. On @gnuhurdsystems{}, since ``read-only'' or ``write-only'' |
28f540f4 | 3701 | is a misnomer, @file{fcntl.h} defines additional names for the file |
e960d831 | 3702 | access modes. |
28f540f4 | 3703 | |
28f540f4 | 3704 | @deftypevr Macro int O_READ |
d08a7e4c | 3705 | @standards{GNU, fcntl.h (optional)} |
e960d831 | 3706 | Open the file for reading. Same as @code{O_RDONLY}; only defined on GNU/Hurd. |
28f540f4 RM |
3707 | @end deftypevr |
3708 | ||
28f540f4 | 3709 | @deftypevr Macro int O_WRITE |
d08a7e4c | 3710 | @standards{GNU, fcntl.h (optional)} |
e960d831 | 3711 | Open the file for writing. Same as @code{O_WRONLY}; only defined on GNU/Hurd. |
28f540f4 RM |
3712 | @end deftypevr |
3713 | ||
28f540f4 | 3714 | @deftypevr Macro int O_EXEC |
d08a7e4c | 3715 | @standards{GNU, fcntl.h (optional)} |
e960d831 | 3716 | Open the file for executing. Only defined on GNU/Hurd. |
28f540f4 RM |
3717 | @end deftypevr |
3718 | ||
3719 | @node Open-time Flags | |
3720 | @subsection Open-time Flags | |
3721 | ||
3722 | The open-time flags specify options affecting how @code{open} will behave. | |
3723 | These options are not preserved once the file is open. The exception to | |
3724 | this is @code{O_NONBLOCK}, which is also an I/O operating mode and so it | |
3725 | @emph{is} saved. @xref{Opening and Closing Files}, for how to call | |
3726 | @code{open}. | |
3727 | ||
3728 | There are two sorts of options specified by open-time flags. | |
3729 | ||
3730 | @itemize @bullet | |
3731 | @item | |
3732 | @dfn{File name translation flags} affect how @code{open} looks up the | |
3733 | file name to locate the file, and whether the file can be created. | |
3734 | @cindex file name translation flags | |
3735 | @cindex flags, file name translation | |
3736 | ||
3737 | @item | |
3738 | @dfn{Open-time action flags} specify extra operations that @code{open} will | |
3739 | perform on the file once it is open. | |
3740 | @cindex open-time action flags | |
3741 | @cindex flags, open-time action | |
3742 | @end itemize | |
3743 | ||
3744 | Here are the file name translation flags. | |
3745 | ||
28f540f4 | 3746 | @deftypevr Macro int O_CREAT |
d08a7e4c | 3747 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3748 | If set, the file will be created if it doesn't already exist. |
3749 | @c !!! mode arg, umask | |
3750 | @cindex create on open (file status flag) | |
3751 | @end deftypevr | |
3752 | ||
28f540f4 | 3753 | @deftypevr Macro int O_EXCL |
d08a7e4c | 3754 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3755 | If both @code{O_CREAT} and @code{O_EXCL} are set, then @code{open} fails |
3756 | if the specified file already exists. This is guaranteed to never | |
3757 | clobber an existing file. | |
b9af29c0 FW |
3758 | |
3759 | The @code{O_EXCL} flag has a special meaning in combination with | |
3760 | @code{O_TMPFILE}; see below. | |
3761 | @end deftypevr | |
3762 | ||
fef7c63c FW |
3763 | @deftypevr Macro int O_DIRECTORY |
3764 | @standards{POSIX.1, fcntl.h} | |
3765 | If set, the open operation fails if the given name is not the name of | |
3766 | a directory. The @code{errno} variable is set to @code{ENOTDIR} for | |
3767 | this error condition. | |
3768 | @end deftypevr | |
3769 | ||
ad14f4f8 FW |
3770 | @deftypevr Macro int O_NOFOLLOW |
3771 | @standards{POSIX.1, fcntl.h} | |
3772 | If set, the open operation fails if the final component of the file name | |
3773 | refers to a symbolic link. The @code{errno} variable is set to | |
3774 | @code{ELOOP} for this error condition. | |
3775 | @end deftypevr | |
3776 | ||
b9af29c0 FW |
3777 | @deftypevr Macro int O_TMPFILE |
3778 | @standards{GNU, fcntl.h} | |
3779 | If this flag is specified, functions in the @code{open} family create an | |
3780 | unnamed temporary file. In this case, the pathname argument to the | |
3781 | @code{open} family of functions (@pxref{Opening and Closing Files}) is | |
3782 | interpreted as the directory in which the temporary file is created | |
3783 | (thus determining the file system which provides the storage for the | |
3784 | file). The @code{O_TMPFILE} flag must be combined with @code{O_WRONLY} | |
3785 | or @code{O_RDWR}, and the @var{mode} argument is required. | |
3786 | ||
3787 | The temporary file can later be given a name using @code{linkat}, | |
3788 | turning it into a regular file. This allows the atomic creation of a | |
3789 | file with the specific file attributes (mode and extended attributes) | |
3790 | and file contents. If, for security reasons, it is not desirable that a | |
3791 | name can be given to the file, the @code{O_EXCL} flag can be specified | |
3792 | along with @code{O_TMPFILE}. | |
3793 | ||
3794 | Not all kernels support this open flag. If this flag is unsupported, an | |
3795 | attempt to create an unnamed temporary file fails with an error of | |
3796 | @code{EINVAL}. If the underlying file system does not support the | |
3797 | @code{O_TMPFILE} flag, an @code{EOPNOTSUPP} error is the result. | |
3798 | ||
3799 | The @code{O_TMPFILE} flag is a GNU extension. | |
28f540f4 RM |
3800 | @end deftypevr |
3801 | ||
28f540f4 | 3802 | @deftypevr Macro int O_NONBLOCK |
d08a7e4c | 3803 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3804 | @cindex non-blocking open |
3805 | This prevents @code{open} from blocking for a ``long time'' to open the | |
3806 | file. This is only meaningful for some kinds of files, usually devices | |
3807 | such as serial ports; when it is not meaningful, it is harmless and | |
9739d2d5 | 3808 | ignored. Often, opening a port to a modem blocks until the modem reports |
28f540f4 RM |
3809 | carrier detection; if @code{O_NONBLOCK} is specified, @code{open} will |
3810 | return immediately without a carrier. | |
3811 | ||
3812 | Note that the @code{O_NONBLOCK} flag is overloaded as both an I/O operating | |
3813 | mode and a file name translation flag. This means that specifying | |
3814 | @code{O_NONBLOCK} in @code{open} also sets nonblocking I/O mode; | |
3815 | @pxref{Operating Modes}. To open the file without blocking but do normal | |
3816 | I/O that blocks, you must call @code{open} with @code{O_NONBLOCK} set and | |
3817 | then call @code{fcntl} to turn the bit off. | |
3818 | @end deftypevr | |
3819 | ||
28f540f4 | 3820 | @deftypevr Macro int O_NOCTTY |
d08a7e4c | 3821 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3822 | If the named file is a terminal device, don't make it the controlling |
3823 | terminal for the process. @xref{Job Control}, for information about | |
3824 | what it means to be the controlling terminal. | |
3825 | ||
a7a93d50 JM |
3826 | On @gnuhurdsystems{} and 4.4 BSD, opening a file never makes it the |
3827 | controlling terminal and @code{O_NOCTTY} is zero. However, @gnulinuxsystems{} | |
3828 | and some other systems use a nonzero value for @code{O_NOCTTY} and set the | |
28f540f4 RM |
3829 | controlling terminal when you open a file that is a terminal device; so |
3830 | to be portable, use @code{O_NOCTTY} when it is important to avoid this. | |
3831 | @cindex controlling terminal, setting | |
3832 | @end deftypevr | |
3833 | ||
a7a93d50 JM |
3834 | The following three file name translation flags exist only on |
3835 | @gnuhurdsystems{}. | |
28f540f4 | 3836 | |
28f540f4 | 3837 | @deftypevr Macro int O_IGNORE_CTTY |
d08a7e4c | 3838 | @standards{GNU, fcntl.h (optional)} |
28f540f4 RM |
3839 | Do not recognize the named file as the controlling terminal, even if it |
3840 | refers to the process's existing controlling terminal device. Operations | |
3841 | on the new file descriptor will never induce job control signals. | |
3842 | @xref{Job Control}. | |
3843 | @end deftypevr | |
3844 | ||
28f540f4 | 3845 | @deftypevr Macro int O_NOLINK |
d08a7e4c | 3846 | @standards{GNU, fcntl.h (optional)} |
28f540f4 RM |
3847 | If the named file is a symbolic link, open the link itself instead of |
3848 | the file it refers to. (@code{fstat} on the new file descriptor will | |
3849 | return the information returned by @code{lstat} on the link's name.) | |
3850 | @cindex symbolic link, opening | |
3851 | @end deftypevr | |
3852 | ||
28f540f4 | 3853 | @deftypevr Macro int O_NOTRANS |
d08a7e4c | 3854 | @standards{GNU, fcntl.h (optional)} |
28f540f4 RM |
3855 | If the named file is specially translated, do not invoke the translator. |
3856 | Open the bare file the translator itself sees. | |
3857 | @end deftypevr | |
3858 | ||
3859 | ||
3860 | The open-time action flags tell @code{open} to do additional operations | |
3861 | which are not really related to opening the file. The reason to do them | |
3862 | as part of @code{open} instead of in separate calls is that @code{open} | |
3863 | can do them @i{atomically}. | |
3864 | ||
28f540f4 | 3865 | @deftypevr Macro int O_TRUNC |
d08a7e4c | 3866 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3867 | Truncate the file to zero length. This option is only useful for |
3868 | regular files, not special files such as directories or FIFOs. POSIX.1 | |
3869 | requires that you open the file for writing to use @code{O_TRUNC}. In | |
3870 | BSD and GNU you must have permission to write the file to truncate it, | |
3871 | but you need not open for write access. | |
3872 | ||
3873 | This is the only open-time action flag specified by POSIX.1. There is | |
3874 | no good reason for truncation to be done by @code{open}, instead of by | |
3875 | calling @code{ftruncate} afterwards. The @code{O_TRUNC} flag existed in | |
3876 | Unix before @code{ftruncate} was invented, and is retained for backward | |
3877 | compatibility. | |
3878 | @end deftypevr | |
3879 | ||
27e309c1 UD |
3880 | The remaining operating modes are BSD extensions. They exist only |
3881 | on some systems. On other systems, these macros are not defined. | |
3882 | ||
28f540f4 | 3883 | @deftypevr Macro int O_SHLOCK |
d08a7e4c | 3884 | @standards{BSD, fcntl.h (optional)} |
28f540f4 RM |
3885 | Acquire a shared lock on the file, as with @code{flock}. |
3886 | @xref{File Locks}. | |
3887 | ||
3888 | If @code{O_CREAT} is specified, the locking is done atomically when | |
3889 | creating the file. You are guaranteed that no other process will get | |
3890 | the lock on the new file first. | |
3891 | @end deftypevr | |
3892 | ||
28f540f4 | 3893 | @deftypevr Macro int O_EXLOCK |
d08a7e4c | 3894 | @standards{BSD, fcntl.h (optional)} |
28f540f4 RM |
3895 | Acquire an exclusive lock on the file, as with @code{flock}. |
3896 | @xref{File Locks}. This is atomic like @code{O_SHLOCK}. | |
3897 | @end deftypevr | |
3898 | ||
3899 | @node Operating Modes | |
3900 | @subsection I/O Operating Modes | |
3901 | ||
3902 | The operating modes affect how input and output operations using a file | |
3903 | descriptor work. These flags are set by @code{open} and can be fetched | |
3904 | and changed with @code{fcntl}. | |
3905 | ||
28f540f4 | 3906 | @deftypevr Macro int O_APPEND |
d08a7e4c | 3907 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3908 | The bit that enables append mode for the file. If set, then all |
3909 | @code{write} operations write the data at the end of the file, extending | |
3910 | it, regardless of the current file position. This is the only reliable | |
3911 | way to append to a file. In append mode, you are guaranteed that the | |
3912 | data you write will always go to the current end of the file, regardless | |
3913 | of other processes writing to the file. Conversely, if you simply set | |
3914 | the file position to the end of file and write, then another process can | |
3915 | extend the file after you set the file position but before you write, | |
3916 | resulting in your data appearing someplace before the real end of file. | |
3917 | @end deftypevr | |
3918 | ||
2c6fe0bd | 3919 | @deftypevr Macro int O_NONBLOCK |
d08a7e4c | 3920 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3921 | The bit that enables nonblocking mode for the file. If this bit is set, |
3922 | @code{read} requests on the file can return immediately with a failure | |
3923 | status if there is no input immediately available, instead of blocking. | |
3924 | Likewise, @code{write} requests can also return immediately with a | |
3925 | failure status if the output can't be written immediately. | |
3926 | ||
3927 | Note that the @code{O_NONBLOCK} flag is overloaded as both an I/O | |
3928 | operating mode and a file name translation flag; @pxref{Open-time Flags}. | |
3929 | @end deftypevr | |
3930 | ||
28f540f4 | 3931 | @deftypevr Macro int O_NDELAY |
d08a7e4c | 3932 | @standards{BSD, fcntl.h} |
28f540f4 RM |
3933 | This is an obsolete name for @code{O_NONBLOCK}, provided for |
3934 | compatibility with BSD. It is not defined by the POSIX.1 standard. | |
3935 | @end deftypevr | |
3936 | ||
3937 | The remaining operating modes are BSD and GNU extensions. They exist only | |
3938 | on some systems. On other systems, these macros are not defined. | |
3939 | ||
28f540f4 | 3940 | @deftypevr Macro int O_ASYNC |
d08a7e4c | 3941 | @standards{BSD, fcntl.h} |
28f540f4 RM |
3942 | The bit that enables asynchronous input mode. If set, then @code{SIGIO} |
3943 | signals will be generated when input is available. @xref{Interrupt Input}. | |
3944 | ||
3945 | Asynchronous input mode is a BSD feature. | |
3946 | @end deftypevr | |
3947 | ||
28f540f4 | 3948 | @deftypevr Macro int O_FSYNC |
d08a7e4c | 3949 | @standards{BSD, fcntl.h} |
28f540f4 RM |
3950 | The bit that enables synchronous writing for the file. If set, each |
3951 | @code{write} call will make sure the data is reliably stored on disk before | |
3952 | returning. @c !!! xref fsync | |
3953 | ||
3954 | Synchronous writing is a BSD feature. | |
3955 | @end deftypevr | |
3956 | ||
28f540f4 | 3957 | @deftypevr Macro int O_SYNC |
d08a7e4c | 3958 | @standards{BSD, fcntl.h} |
28f540f4 RM |
3959 | This is another name for @code{O_FSYNC}. They have the same value. |
3960 | @end deftypevr | |
3961 | ||
28f540f4 | 3962 | @deftypevr Macro int O_NOATIME |
d08a7e4c | 3963 | @standards{GNU, fcntl.h} |
28f540f4 RM |
3964 | If this bit is set, @code{read} will not update the access time of the |
3965 | file. @xref{File Times}. This is used by programs that do backups, so | |
3966 | that backing a file up does not count as reading it. | |
3967 | Only the owner of the file or the superuser may use this bit. | |
3968 | ||
3969 | This is a GNU extension. | |
3970 | @end deftypevr | |
3971 | ||
3972 | @node Getting File Status Flags | |
3973 | @subsection Getting and Setting File Status Flags | |
3974 | ||
3975 | The @code{fcntl} function can fetch or change file status flags. | |
3976 | ||
28f540f4 | 3977 | @deftypevr Macro int F_GETFL |
d08a7e4c | 3978 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
3979 | This macro is used as the @var{command} argument to @code{fcntl}, to |
3980 | read the file status flags for the open file with descriptor | |
3981 | @var{filedes}. | |
3982 | ||
3983 | The normal return value from @code{fcntl} with this command is a | |
3984 | nonnegative number which can be interpreted as the bitwise OR of the | |
3985 | individual flags. Since the file access modes are not single-bit values, | |
3986 | you can mask off other bits in the returned flags with @code{O_ACCMODE} | |
3987 | to compare them. | |
3988 | ||
07435eb4 | 3989 | In case of an error, @code{fcntl} returns @math{-1}. The following |
28f540f4 RM |
3990 | @code{errno} error conditions are defined for this command: |
3991 | ||
3992 | @table @code | |
3993 | @item EBADF | |
3994 | The @var{filedes} argument is invalid. | |
3995 | @end table | |
3996 | @end deftypevr | |
3997 | ||
28f540f4 | 3998 | @deftypevr Macro int F_SETFL |
d08a7e4c | 3999 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
4000 | This macro is used as the @var{command} argument to @code{fcntl}, to set |
4001 | the file status flags for the open file corresponding to the | |
4002 | @var{filedes} argument. This command requires a third @code{int} | |
4003 | argument to specify the new flags, so the call looks like this: | |
4004 | ||
4005 | @smallexample | |
4006 | fcntl (@var{filedes}, F_SETFL, @var{new-flags}) | |
4007 | @end smallexample | |
4008 | ||
4009 | You can't change the access mode for the file in this way; that is, | |
4010 | whether the file descriptor was opened for reading or writing. | |
4011 | ||
4012 | The normal return value from @code{fcntl} with this command is an | |
07435eb4 | 4013 | unspecified value other than @math{-1}, which indicates an error. The |
28f540f4 RM |
4014 | error conditions are the same as for the @code{F_GETFL} command. |
4015 | @end deftypevr | |
4016 | ||
4017 | If you want to modify the file status flags, you should get the current | |
4018 | flags with @code{F_GETFL} and modify the value. Don't assume that the | |
4019 | flags listed here are the only ones that are implemented; your program | |
4020 | may be run years from now and more flags may exist then. For example, | |
4021 | here is a function to set or clear the flag @code{O_NONBLOCK} without | |
4022 | altering any other flags: | |
4023 | ||
4024 | @smallexample | |
4025 | @group | |
4026 | /* @r{Set the @code{O_NONBLOCK} flag of @var{desc} if @var{value} is nonzero,} | |
4027 | @r{or clear the flag if @var{value} is 0.} | |
2c6fe0bd | 4028 | @r{Return 0 on success, or -1 on error with @code{errno} set.} */ |
28f540f4 RM |
4029 | |
4030 | int | |
4031 | set_nonblock_flag (int desc, int value) | |
4032 | @{ | |
4033 | int oldflags = fcntl (desc, F_GETFL, 0); | |
4034 | /* @r{If reading the flags failed, return error indication now.} */ | |
4035 | if (oldflags == -1) | |
4036 | return -1; | |
4037 | /* @r{Set just the flag we want to set.} */ | |
4038 | if (value != 0) | |
4039 | oldflags |= O_NONBLOCK; | |
4040 | else | |
4041 | oldflags &= ~O_NONBLOCK; | |
4042 | /* @r{Store modified flag word in the descriptor.} */ | |
4043 | return fcntl (desc, F_SETFL, oldflags); | |
4044 | @} | |
4045 | @end group | |
4046 | @end smallexample | |
4047 | ||
4048 | @node File Locks | |
4049 | @section File Locks | |
4050 | ||
4051 | @cindex file locks | |
4052 | @cindex record locking | |
0961f7e1 JL |
4053 | This section describes record locks that are associated with the process. |
4054 | There is also a different type of record lock that is associated with the | |
4055 | open file description instead of the process. @xref{Open File Description Locks}. | |
4056 | ||
28f540f4 RM |
4057 | The remaining @code{fcntl} commands are used to support @dfn{record |
4058 | locking}, which permits multiple cooperating programs to prevent each | |
4059 | other from simultaneously accessing parts of a file in error-prone | |
4060 | ways. | |
4061 | ||
4062 | @cindex exclusive lock | |
4063 | @cindex write lock | |
4064 | An @dfn{exclusive} or @dfn{write} lock gives a process exclusive access | |
4065 | for writing to the specified part of the file. While a write lock is in | |
4066 | place, no other process can lock that part of the file. | |
4067 | ||
4068 | @cindex shared lock | |
4069 | @cindex read lock | |
4070 | A @dfn{shared} or @dfn{read} lock prohibits any other process from | |
4071 | requesting a write lock on the specified part of the file. However, | |
4072 | other processes can request read locks. | |
4073 | ||
4074 | The @code{read} and @code{write} functions do not actually check to see | |
4075 | whether there are any locks in place. If you want to implement a | |
4076 | locking protocol for a file shared by multiple processes, your application | |
4077 | must do explicit @code{fcntl} calls to request and clear locks at the | |
4078 | appropriate points. | |
4079 | ||
4080 | Locks are associated with processes. A process can only have one kind | |
4081 | of lock set for each byte of a given file. When any file descriptor for | |
4082 | that file is closed by the process, all of the locks that process holds | |
4083 | on that file are released, even if the locks were made using other | |
4084 | descriptors that remain open. Likewise, locks are released when a | |
4085 | process exits, and are not inherited by child processes created using | |
4086 | @code{fork} (@pxref{Creating a Process}). | |
4087 | ||
4088 | When making a lock, use a @code{struct flock} to specify what kind of | |
4089 | lock and where. This data type and the associated macros for the | |
4090 | @code{fcntl} function are declared in the header file @file{fcntl.h}. | |
4091 | @pindex fcntl.h | |
4092 | ||
28f540f4 | 4093 | @deftp {Data Type} {struct flock} |
d08a7e4c | 4094 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
4095 | This structure is used with the @code{fcntl} function to describe a file |
4096 | lock. It has these members: | |
4097 | ||
4098 | @table @code | |
4099 | @item short int l_type | |
4100 | Specifies the type of the lock; one of @code{F_RDLCK}, @code{F_WRLCK}, or | |
4101 | @code{F_UNLCK}. | |
4102 | ||
4103 | @item short int l_whence | |
4104 | This corresponds to the @var{whence} argument to @code{fseek} or | |
4105 | @code{lseek}, and specifies what the offset is relative to. Its value | |
4106 | can be one of @code{SEEK_SET}, @code{SEEK_CUR}, or @code{SEEK_END}. | |
4107 | ||
4108 | @item off_t l_start | |
4109 | This specifies the offset of the start of the region to which the lock | |
9739d2d5 | 4110 | applies, and is given in bytes relative to the point specified by the |
28f540f4 RM |
4111 | @code{l_whence} member. |
4112 | ||
4113 | @item off_t l_len | |
4114 | This specifies the length of the region to be locked. A value of | |
4115 | @code{0} is treated specially; it means the region extends to the end of | |
4116 | the file. | |
4117 | ||
4118 | @item pid_t l_pid | |
4119 | This field is the process ID (@pxref{Process Creation Concepts}) of the | |
4120 | process holding the lock. It is filled in by calling @code{fcntl} with | |
0961f7e1 JL |
4121 | the @code{F_GETLK} command, but is ignored when making a lock. If the |
4122 | conflicting lock is an open file description lock | |
4123 | (@pxref{Open File Description Locks}), then this field will be set to | |
4124 | @math{-1}. | |
28f540f4 RM |
4125 | @end table |
4126 | @end deftp | |
4127 | ||
28f540f4 | 4128 | @deftypevr Macro int F_GETLK |
d08a7e4c | 4129 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
4130 | This macro is used as the @var{command} argument to @code{fcntl}, to |
4131 | specify that it should get information about a lock. This command | |
4132 | requires a third argument of type @w{@code{struct flock *}} to be passed | |
4133 | to @code{fcntl}, so that the form of the call is: | |
4134 | ||
4135 | @smallexample | |
4136 | fcntl (@var{filedes}, F_GETLK, @var{lockp}) | |
4137 | @end smallexample | |
4138 | ||
4139 | If there is a lock already in place that would block the lock described | |
4140 | by the @var{lockp} argument, information about that lock overwrites | |
4141 | @code{*@var{lockp}}. Existing locks are not reported if they are | |
4142 | compatible with making a new lock as specified. Thus, you should | |
4143 | specify a lock type of @code{F_WRLCK} if you want to find out about both | |
4144 | read and write locks, or @code{F_RDLCK} if you want to find out about | |
4145 | write locks only. | |
4146 | ||
4147 | There might be more than one lock affecting the region specified by the | |
4148 | @var{lockp} argument, but @code{fcntl} only returns information about | |
4149 | one of them. The @code{l_whence} member of the @var{lockp} structure is | |
4150 | set to @code{SEEK_SET} and the @code{l_start} and @code{l_len} fields | |
4151 | set to identify the locked region. | |
4152 | ||
4153 | If no lock applies, the only change to the @var{lockp} structure is to | |
4154 | update the @code{l_type} to a value of @code{F_UNLCK}. | |
4155 | ||
4156 | The normal return value from @code{fcntl} with this command is an | |
07435eb4 | 4157 | unspecified value other than @math{-1}, which is reserved to indicate an |
28f540f4 RM |
4158 | error. The following @code{errno} error conditions are defined for |
4159 | this command: | |
4160 | ||
4161 | @table @code | |
4162 | @item EBADF | |
4163 | The @var{filedes} argument is invalid. | |
4164 | ||
4165 | @item EINVAL | |
4166 | Either the @var{lockp} argument doesn't specify valid lock information, | |
4167 | or the file associated with @var{filedes} doesn't support locks. | |
4168 | @end table | |
4169 | @end deftypevr | |
4170 | ||
28f540f4 | 4171 | @deftypevr Macro int F_SETLK |
d08a7e4c | 4172 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
4173 | This macro is used as the @var{command} argument to @code{fcntl}, to |
4174 | specify that it should set or clear a lock. This command requires a | |
4175 | third argument of type @w{@code{struct flock *}} to be passed to | |
4176 | @code{fcntl}, so that the form of the call is: | |
4177 | ||
4178 | @smallexample | |
4179 | fcntl (@var{filedes}, F_SETLK, @var{lockp}) | |
4180 | @end smallexample | |
4181 | ||
4182 | If the process already has a lock on any part of the region, the old lock | |
4183 | on that part is replaced with the new lock. You can remove a lock | |
4184 | by specifying a lock type of @code{F_UNLCK}. | |
4185 | ||
4186 | If the lock cannot be set, @code{fcntl} returns immediately with a value | |
9739d2d5 RJ |
4187 | of @math{-1}. This function does not block while waiting for other processes |
4188 | to release locks. If @code{fcntl} succeeds, it returns a value other | |
07435eb4 | 4189 | than @math{-1}. |
28f540f4 RM |
4190 | |
4191 | The following @code{errno} error conditions are defined for this | |
4192 | function: | |
4193 | ||
4194 | @table @code | |
4195 | @item EAGAIN | |
4196 | @itemx EACCES | |
4197 | The lock cannot be set because it is blocked by an existing lock on the | |
4198 | file. Some systems use @code{EAGAIN} in this case, and other systems | |
4199 | use @code{EACCES}; your program should treat them alike, after | |
a7a93d50 | 4200 | @code{F_SETLK}. (@gnulinuxhurdsystems{} always use @code{EAGAIN}.) |
28f540f4 RM |
4201 | |
4202 | @item EBADF | |
4203 | Either: the @var{filedes} argument is invalid; you requested a read lock | |
4204 | but the @var{filedes} is not open for read access; or, you requested a | |
4205 | write lock but the @var{filedes} is not open for write access. | |
4206 | ||
4207 | @item EINVAL | |
4208 | Either the @var{lockp} argument doesn't specify valid lock information, | |
4209 | or the file associated with @var{filedes} doesn't support locks. | |
4210 | ||
4211 | @item ENOLCK | |
4212 | The system has run out of file lock resources; there are already too | |
4213 | many file locks in place. | |
4214 | ||
4215 | Well-designed file systems never report this error, because they have no | |
4216 | limitation on the number of locks. However, you must still take account | |
4217 | of the possibility of this error, as it could result from network access | |
4218 | to a file system on another machine. | |
4219 | @end table | |
4220 | @end deftypevr | |
4221 | ||
28f540f4 | 4222 | @deftypevr Macro int F_SETLKW |
d08a7e4c | 4223 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
4224 | This macro is used as the @var{command} argument to @code{fcntl}, to |
4225 | specify that it should set or clear a lock. It is just like the | |
4226 | @code{F_SETLK} command, but causes the process to block (or wait) | |
4227 | until the request can be specified. | |
4228 | ||
4229 | This command requires a third argument of type @code{struct flock *}, as | |
4230 | for the @code{F_SETLK} command. | |
4231 | ||
4232 | The @code{fcntl} return values and errors are the same as for the | |
4233 | @code{F_SETLK} command, but these additional @code{errno} error conditions | |
4234 | are defined for this command: | |
4235 | ||
4236 | @table @code | |
4237 | @item EINTR | |
4238 | The function was interrupted by a signal while it was waiting. | |
4239 | @xref{Interrupted Primitives}. | |
4240 | ||
4241 | @item EDEADLK | |
4242 | The specified region is being locked by another process. But that | |
4243 | process is waiting to lock a region which the current process has | |
4244 | locked, so waiting for the lock would result in deadlock. The system | |
4245 | does not guarantee that it will detect all such conditions, but it lets | |
4246 | you know if it notices one. | |
4247 | @end table | |
4248 | @end deftypevr | |
4249 | ||
4250 | ||
4251 | The following macros are defined for use as values for the @code{l_type} | |
4252 | member of the @code{flock} structure. The values are integer constants. | |
4253 | ||
2fe82ca6 | 4254 | @vtable @code |
28f540f4 | 4255 | @item F_RDLCK |
d08a7e4c | 4256 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
4257 | This macro is used to specify a read (or shared) lock. |
4258 | ||
28f540f4 | 4259 | @item F_WRLCK |
d08a7e4c | 4260 | @standards{POSIX.1, fcntl.h} |
28f540f4 RM |
4261 | This macro is used to specify a write (or exclusive) lock. |
4262 | ||
28f540f4 | 4263 | @item F_UNLCK |
d08a7e4c | 4264 | @standards{POSIX.1, fcntl.h} |
28f540f4 | 4265 | This macro is used to specify that the region is unlocked. |
2fe82ca6 | 4266 | @end vtable |
28f540f4 RM |
4267 | |
4268 | As an example of a situation where file locking is useful, consider a | |
4269 | program that can be run simultaneously by several different users, that | |
4270 | logs status information to a common file. One example of such a program | |
4271 | might be a game that uses a file to keep track of high scores. Another | |
4272 | example might be a program that records usage or accounting information | |
4273 | for billing purposes. | |
4274 | ||
4275 | Having multiple copies of the program simultaneously writing to the | |
4276 | file could cause the contents of the file to become mixed up. But | |
4277 | you can prevent this kind of problem by setting a write lock on the | |
2c6fe0bd | 4278 | file before actually writing to the file. |
28f540f4 RM |
4279 | |
4280 | If the program also needs to read the file and wants to make sure that | |
4281 | the contents of the file are in a consistent state, then it can also use | |
4282 | a read lock. While the read lock is set, no other process can lock | |
4283 | that part of the file for writing. | |
4284 | ||
4285 | @c ??? This section could use an example program. | |
4286 | ||
0961f7e1 | 4287 | Remember that file locks are only an @emph{advisory} protocol for |
28f540f4 RM |
4288 | controlling access to a file. There is still potential for access to |
4289 | the file by programs that don't use the lock protocol. | |
4290 | ||
0961f7e1 JL |
4291 | @node Open File Description Locks |
4292 | @section Open File Description Locks | |
4293 | ||
4294 | In contrast to process-associated record locks (@pxref{File Locks}), | |
4295 | open file description record locks are associated with an open file | |
4296 | description rather than a process. | |
4297 | ||
4298 | Using @code{fcntl} to apply an open file description lock on a region that | |
4299 | already has an existing open file description lock that was created via the | |
4300 | same file descriptor will never cause a lock conflict. | |
4301 | ||
4302 | Open file description locks are also inherited by child processes across | |
4303 | @code{fork}, or @code{clone} with @code{CLONE_FILES} set | |
4304 | (@pxref{Creating a Process}), along with the file descriptor. | |
4305 | ||
4306 | It is important to distinguish between the open file @emph{description} (an | |
4307 | instance of an open file, usually created by a call to @code{open}) and | |
4308 | an open file @emph{descriptor}, which is a numeric value that refers to the | |
4309 | open file description. The locks described here are associated with the | |
4310 | open file @emph{description} and not the open file @emph{descriptor}. | |
4311 | ||
4312 | Using @code{dup} (@pxref{Duplicating Descriptors}) to copy a file | |
4313 | descriptor does not give you a new open file description, but rather copies a | |
4314 | reference to an existing open file description and assigns it to a new | |
4315 | file descriptor. Thus, open file description locks set on a file | |
4316 | descriptor cloned by @code{dup} will never conflict with open file | |
4317 | description locks set on the original descriptor since they refer to the | |
4318 | same open file description. Depending on the range and type of lock | |
4319 | involved, the original lock may be modified by a @code{F_OFD_SETLK} or | |
4320 | @code{F_OFD_SETLKW} command in this situation however. | |
4321 | ||
4322 | Open file description locks always conflict with process-associated locks, | |
4323 | even if acquired by the same process or on the same open file | |
4324 | descriptor. | |
4325 | ||
4326 | Open file description locks use the same @code{struct flock} as | |
4327 | process-associated locks as an argument (@pxref{File Locks}) and the | |
4328 | macros for the @code{command} values are also declared in the header file | |
4329 | @file{fcntl.h}. To use them, the macro @code{_GNU_SOURCE} must be | |
4330 | defined prior to including any header file. | |
4331 | ||
4332 | In contrast to process-associated locks, any @code{struct flock} used as | |
4333 | an argument to open file description lock commands must have the @code{l_pid} | |
4334 | value set to @math{0}. Also, when returning information about an | |
4335 | open file description lock in a @code{F_GETLK} or @code{F_OFD_GETLK} request, | |
4336 | the @code{l_pid} field in @code{struct flock} will be set to @math{-1} | |
4337 | to indicate that the lock is not associated with a process. | |
4338 | ||
4339 | When the same @code{struct flock} is reused as an argument to a | |
4340 | @code{F_OFD_SETLK} or @code{F_OFD_SETLKW} request after being used for an | |
4341 | @code{F_OFD_GETLK} request, it is necessary to inspect and reset the | |
4342 | @code{l_pid} field to @math{0}. | |
4343 | ||
4344 | @pindex fcntl.h. | |
4345 | ||
4346 | @deftypevr Macro int F_OFD_GETLK | |
4347 | This macro is used as the @var{command} argument to @code{fcntl}, to | |
4348 | specify that it should get information about a lock. This command | |
4349 | requires a third argument of type @w{@code{struct flock *}} to be passed | |
4350 | to @code{fcntl}, so that the form of the call is: | |
4351 | ||
4352 | @smallexample | |
4353 | fcntl (@var{filedes}, F_OFD_GETLK, @var{lockp}) | |
4354 | @end smallexample | |
4355 | ||
4356 | If there is a lock already in place that would block the lock described | |
4357 | by the @var{lockp} argument, information about that lock is written to | |
4358 | @code{*@var{lockp}}. Existing locks are not reported if they are | |
4359 | compatible with making a new lock as specified. Thus, you should | |
4360 | specify a lock type of @code{F_WRLCK} if you want to find out about both | |
4361 | read and write locks, or @code{F_RDLCK} if you want to find out about | |
4362 | write locks only. | |
4363 | ||
4364 | There might be more than one lock affecting the region specified by the | |
4365 | @var{lockp} argument, but @code{fcntl} only returns information about | |
4366 | one of them. Which lock is returned in this situation is undefined. | |
4367 | ||
4368 | The @code{l_whence} member of the @var{lockp} structure are set to | |
4369 | @code{SEEK_SET} and the @code{l_start} and @code{l_len} fields are set | |
4370 | to identify the locked region. | |
4371 | ||
4372 | If no conflicting lock exists, the only change to the @var{lockp} structure | |
4373 | is to update the @code{l_type} field to the value @code{F_UNLCK}. | |
4374 | ||
4375 | The normal return value from @code{fcntl} with this command is either @math{0} | |
4376 | on success or @math{-1}, which indicates an error. The following @code{errno} | |
4377 | error conditions are defined for this command: | |
4378 | ||
4379 | @table @code | |
4380 | @item EBADF | |
4381 | The @var{filedes} argument is invalid. | |
4382 | ||
4383 | @item EINVAL | |
4384 | Either the @var{lockp} argument doesn't specify valid lock information, | |
4385 | the operating system kernel doesn't support open file description locks, or the file | |
4386 | associated with @var{filedes} doesn't support locks. | |
4387 | @end table | |
4388 | @end deftypevr | |
4389 | ||
0961f7e1 | 4390 | @deftypevr Macro int F_OFD_SETLK |
d08a7e4c | 4391 | @standards{POSIX.1, fcntl.h} |
0961f7e1 JL |
4392 | This macro is used as the @var{command} argument to @code{fcntl}, to |
4393 | specify that it should set or clear a lock. This command requires a | |
4394 | third argument of type @w{@code{struct flock *}} to be passed to | |
4395 | @code{fcntl}, so that the form of the call is: | |
4396 | ||
4397 | @smallexample | |
4398 | fcntl (@var{filedes}, F_OFD_SETLK, @var{lockp}) | |
4399 | @end smallexample | |
4400 | ||
4401 | If the open file already has a lock on any part of the | |
4402 | region, the old lock on that part is replaced with the new lock. You | |
4403 | can remove a lock by specifying a lock type of @code{F_UNLCK}. | |
4404 | ||
4405 | If the lock cannot be set, @code{fcntl} returns immediately with a value | |
4406 | of @math{-1}. This command does not wait for other tasks | |
4407 | to release locks. If @code{fcntl} succeeds, it returns @math{0}. | |
4408 | ||
4409 | The following @code{errno} error conditions are defined for this | |
4410 | command: | |
4411 | ||
4412 | @table @code | |
4413 | @item EAGAIN | |
4414 | The lock cannot be set because it is blocked by an existing lock on the | |
4415 | file. | |
4416 | ||
4417 | @item EBADF | |
4418 | Either: the @var{filedes} argument is invalid; you requested a read lock | |
4419 | but the @var{filedes} is not open for read access; or, you requested a | |
4420 | write lock but the @var{filedes} is not open for write access. | |
4421 | ||
4422 | @item EINVAL | |
4423 | Either the @var{lockp} argument doesn't specify valid lock information, | |
4424 | the operating system kernel doesn't support open file description locks, or the | |
4425 | file associated with @var{filedes} doesn't support locks. | |
4426 | ||
4427 | @item ENOLCK | |
4428 | The system has run out of file lock resources; there are already too | |
4429 | many file locks in place. | |
4430 | ||
4431 | Well-designed file systems never report this error, because they have no | |
4432 | limitation on the number of locks. However, you must still take account | |
4433 | of the possibility of this error, as it could result from network access | |
4434 | to a file system on another machine. | |
4435 | @end table | |
4436 | @end deftypevr | |
4437 | ||
0961f7e1 | 4438 | @deftypevr Macro int F_OFD_SETLKW |
d08a7e4c | 4439 | @standards{POSIX.1, fcntl.h} |
0961f7e1 JL |
4440 | This macro is used as the @var{command} argument to @code{fcntl}, to |
4441 | specify that it should set or clear a lock. It is just like the | |
4442 | @code{F_OFD_SETLK} command, but causes the process to wait until the request | |
4443 | can be completed. | |
4444 | ||
4445 | This command requires a third argument of type @code{struct flock *}, as | |
4446 | for the @code{F_OFD_SETLK} command. | |
4447 | ||
4448 | The @code{fcntl} return values and errors are the same as for the | |
4449 | @code{F_OFD_SETLK} command, but these additional @code{errno} error conditions | |
4450 | are defined for this command: | |
4451 | ||
4452 | @table @code | |
4453 | @item EINTR | |
4454 | The function was interrupted by a signal while it was waiting. | |
4455 | @xref{Interrupted Primitives}. | |
4456 | ||
4457 | @end table | |
4458 | @end deftypevr | |
4459 | ||
4460 | Open file description locks are useful in the same sorts of situations as | |
4461 | process-associated locks. They can also be used to synchronize file | |
4462 | access between threads within the same process by having each thread perform | |
4463 | its own @code{open} of the file, to obtain its own open file description. | |
4464 | ||
4465 | Because open file description locks are automatically freed only upon | |
4466 | closing the last file descriptor that refers to the open file | |
4467 | description, this locking mechanism avoids the possibility that locks | |
4468 | are inadvertently released due to a library routine opening and closing | |
4469 | a file without the application being aware. | |
4470 | ||
4471 | As with process-associated locks, open file description locks are advisory. | |
4472 | ||
4473 | @node Open File Description Locks Example | |
4474 | @section Open File Description Locks Example | |
4475 | ||
4476 | Here is an example of using open file description locks in a threaded | |
4477 | program. If this program used process-associated locks, then it would be | |
4478 | subject to data corruption because process-associated locks are shared | |
4479 | by the threads inside a process, and thus cannot be used by one thread | |
4480 | to lock out another thread in the same process. | |
4481 | ||
4482 | Proper error handling has been omitted in the following program for | |
4483 | brevity. | |
4484 | ||
4485 | @smallexample | |
4486 | @include ofdlocks.c.texi | |
4487 | @end smallexample | |
4488 | ||
4489 | This example creates three threads each of which loops five times, | |
4490 | appending to the file. Access to the file is serialized via open file | |
4491 | description locks. If we compile and run the above program, we'll end up | |
4492 | with /tmp/foo that has 15 lines in it. | |
4493 | ||
4494 | If we, however, were to replace the @code{F_OFD_SETLK} and | |
4495 | @code{F_OFD_SETLKW} commands with their process-associated lock | |
4496 | equivalents, the locking essentially becomes a noop since it is all done | |
4497 | within the context of the same process. That leads to data corruption | |
4498 | (typically manifested as missing lines) as some threads race in and | |
4499 | overwrite the data written by others. | |
4500 | ||
28f540f4 RM |
4501 | @node Interrupt Input |
4502 | @section Interrupt-Driven Input | |
4503 | ||
4504 | @cindex interrupt-driven input | |
4505 | If you set the @code{O_ASYNC} status flag on a file descriptor | |
4506 | (@pxref{File Status Flags}), a @code{SIGIO} signal is sent whenever | |
4507 | input or output becomes possible on that file descriptor. The process | |
4508 | or process group to receive the signal can be selected by using the | |
4509 | @code{F_SETOWN} command to the @code{fcntl} function. If the file | |
4510 | descriptor is a socket, this also selects the recipient of @code{SIGURG} | |
4511 | signals that are delivered when out-of-band data arrives on that socket; | |
4512 | see @ref{Out-of-Band Data}. (@code{SIGURG} is sent in any situation | |
4513 | where @code{select} would report the socket as having an ``exceptional | |
4514 | condition''. @xref{Waiting for I/O}.) | |
4515 | ||
4516 | If the file descriptor corresponds to a terminal device, then @code{SIGIO} | |
2c6fe0bd | 4517 | signals are sent to the foreground process group of the terminal. |
28f540f4 RM |
4518 | @xref{Job Control}. |
4519 | ||
4520 | @pindex fcntl.h | |
4521 | The symbols in this section are defined in the header file | |
4522 | @file{fcntl.h}. | |
4523 | ||
28f540f4 | 4524 | @deftypevr Macro int F_GETOWN |
d08a7e4c | 4525 | @standards{BSD, fcntl.h} |
28f540f4 RM |
4526 | This macro is used as the @var{command} argument to @code{fcntl}, to |
4527 | specify that it should get information about the process or process | |
4528 | group to which @code{SIGIO} signals are sent. (For a terminal, this is | |
4529 | actually the foreground process group ID, which you can get using | |
4530 | @code{tcgetpgrp}; see @ref{Terminal Access Functions}.) | |
4531 | ||
4532 | The return value is interpreted as a process ID; if negative, its | |
4533 | absolute value is the process group ID. | |
4534 | ||
4535 | The following @code{errno} error condition is defined for this command: | |
4536 | ||
4537 | @table @code | |
4538 | @item EBADF | |
4539 | The @var{filedes} argument is invalid. | |
4540 | @end table | |
4541 | @end deftypevr | |
4542 | ||
28f540f4 | 4543 | @deftypevr Macro int F_SETOWN |
d08a7e4c | 4544 | @standards{BSD, fcntl.h} |
28f540f4 RM |
4545 | This macro is used as the @var{command} argument to @code{fcntl}, to |
4546 | specify that it should set the process or process group to which | |
4547 | @code{SIGIO} signals are sent. This command requires a third argument | |
4548 | of type @code{pid_t} to be passed to @code{fcntl}, so that the form of | |
4549 | the call is: | |
4550 | ||
4551 | @smallexample | |
4552 | fcntl (@var{filedes}, F_SETOWN, @var{pid}) | |
4553 | @end smallexample | |
4554 | ||
4555 | The @var{pid} argument should be a process ID. You can also pass a | |
4556 | negative number whose absolute value is a process group ID. | |
4557 | ||
07435eb4 | 4558 | The return value from @code{fcntl} with this command is @math{-1} |
28f540f4 RM |
4559 | in case of error and some other value if successful. The following |
4560 | @code{errno} error conditions are defined for this command: | |
4561 | ||
4562 | @table @code | |
4563 | @item EBADF | |
4564 | The @var{filedes} argument is invalid. | |
4565 | ||
4566 | @item ESRCH | |
4567 | There is no process or process group corresponding to @var{pid}. | |
4568 | @end table | |
4569 | @end deftypevr | |
4570 | ||
4571 | @c ??? This section could use an example program. | |
07435eb4 UD |
4572 | |
4573 | @node IOCTLs | |
4574 | @section Generic I/O Control operations | |
4575 | @cindex generic i/o control operations | |
4576 | @cindex IOCTLs | |
4577 | ||
a7a93d50 | 4578 | @gnusystems{} can handle most input/output operations on many different |
07435eb4 UD |
4579 | devices and objects in terms of a few file primitives - @code{read}, |
4580 | @code{write} and @code{lseek}. However, most devices also have a few | |
cf822e3c | 4581 | peculiar operations which do not fit into this model. Such as: |
07435eb4 UD |
4582 | |
4583 | @itemize @bullet | |
4584 | ||
4585 | @item | |
4586 | Changing the character font used on a terminal. | |
4587 | ||
4588 | @item | |
4589 | Telling a magnetic tape system to rewind or fast forward. (Since they | |
4590 | cannot move in byte increments, @code{lseek} is inapplicable). | |
4591 | ||
4592 | @item | |
4593 | Ejecting a disk from a drive. | |
4594 | ||
4595 | @item | |
4596 | Playing an audio track from a CD-ROM drive. | |
4597 | ||
4598 | @item | |
4599 | Maintaining routing tables for a network. | |
4600 | ||
4601 | @end itemize | |
4602 | ||
4603 | Although some such objects such as sockets and terminals | |
4604 | @footnote{Actually, the terminal-specific functions are implemented with | |
4605 | IOCTLs on many platforms.} have special functions of their own, it would | |
4606 | not be practical to create functions for all these cases. | |
4607 | ||
4608 | Instead these minor operations, known as @dfn{IOCTL}s, are assigned code | |
4609 | numbers and multiplexed through the @code{ioctl} function, defined in | |
4610 | @code{sys/ioctl.h}. The code numbers themselves are defined in many | |
4611 | different headers. | |
4612 | ||
4613 | @deftypefun int ioctl (int @var{filedes}, int @var{command}, @dots{}) | |
d08a7e4c | 4614 | @standards{BSD, sys/ioctl.h} |
2cc3615c | 4615 | @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} |
07435eb4 UD |
4616 | |
4617 | The @code{ioctl} function performs the generic I/O operation | |
4618 | @var{command} on @var{filedes}. | |
4619 | ||
4620 | A third argument is usually present, either a single number or a pointer | |
4621 | to a structure. The meaning of this argument, the returned value, and | |
4622 | any error codes depends upon the command used. Often @math{-1} is | |
4623 | returned for a failure. | |
4624 | ||
4625 | @end deftypefun | |
4626 | ||
4627 | On some systems, IOCTLs used by different devices share the same numbers. | |
4628 | Thus, although use of an inappropriate IOCTL @emph{usually} only produces | |
4629 | an error, you should not attempt to use device-specific IOCTLs on an | |
4630 | unknown device. | |
4631 | ||
4632 | Most IOCTLs are OS-specific and/or only used in special system utilities, | |
4633 | and are thus beyond the scope of this document. For an example of the use | |
8b7fb588 | 4634 | of an IOCTL, see @ref{Out-of-Band Data}. |
2cc3615c AO |
4635 | |
4636 | @c FIXME this is undocumented: | |
4637 | @c dup3 |