Update.
[glibc.git] / manual / llio.texi
blobea72e955e35546a4ecee8bed4136cbdaf44e3eb0
1 @node Low-Level I/O, File System Interface, I/O on Streams, Top
2 @c %MENU% Low-level, less portable I/O
3 @chapter Low-Level Input/Output
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.
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:
15 @itemize @bullet
16 @item
17 For reading binary files in large chunks.
19 @item
20 For reading an entire file into core before parsing it.
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.)
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
33 @menu
34 * Opening and Closing Files::           How to open and close file
35                                          descriptors.
36 * I/O Primitives::                      Reading and writing data.
37 * File Position Primitive::             Setting a descriptor's file
38                                          position.
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.
43 * Scatter-Gather::                      Fast I/O to discontinuous buffers.
44 * Memory-mapped I/O::                   Using files like memory.
45 * Waiting for I/O::                     How to check for input or output
46                                          on multiple file descriptors.
47 * Synchronizing I/O::                   Making sure all I/O actions completed.
48 * Asynchronous I/O::                    Perform I/O in parallel.
49 * Control Operations::                  Various other operations on file
50                                          descriptors.
51 * Duplicating Descriptors::             Fcntl commands for duplicating
52                                          file descriptors.
53 * Descriptor Flags::                    Fcntl commands for manipulating
54                                          flags associated with file
55                                          descriptors.
56 * File Status Flags::                   Fcntl commands for manipulating
57                                          flags associated with open files.
58 * File Locks::                          Fcntl commands for implementing
59                                          file locking.
60 * Interrupt Input::                     Getting an asynchronous signal when
61                                          input arrives.
62 * IOCTLs::                              Generic I/O Control operations.
63 @end menu
66 @node Opening and Closing Files
67 @section Opening and Closing Files
69 @cindex opening a file descriptor
70 @cindex closing a file descriptor
71 This section describes the primitives for opening and closing files
72 using file descriptors.  The @code{open} and @code{creat} functions are
73 declared in the header file @file{fcntl.h}, while @code{close} is
74 declared in @file{unistd.h}.
75 @pindex unistd.h
76 @pindex fcntl.h
78 @comment fcntl.h
79 @comment POSIX.1
80 @deftypefun int open (const char *@var{filename}, int @var{flags}[, mode_t @var{mode}])
81 The @code{open} function creates and returns a new file descriptor
82 for the file named by @var{filename}.  Initially, the file position
83 indicator for the file is at the beginning of the file.  The argument
84 @var{mode} is used only when a file is created, but it doesn't hurt
85 to supply the argument in any case.
87 The @var{flags} argument controls how the file is to be opened.  This is
88 a bit mask; you create the value by the bitwise OR of the appropriate
89 parameters (using the @samp{|} operator in C).
90 @xref{File Status Flags}, for the parameters available.
92 The normal return value from @code{open} is a non-negative integer file
93 descriptor.  In the case of an error, a value of @math{-1} is returned
94 instead.  In addition to the usual file name errors (@pxref{File
95 Name Errors}), the following @code{errno} error conditions are defined
96 for this function:
98 @table @code
99 @item EACCES
100 The file exists but is not readable/writable as requested by the @var{flags}
101 argument, the file does not exist and the directory is unwritable so
102 it cannot be created.
104 @item EEXIST
105 Both @code{O_CREAT} and @code{O_EXCL} are set, and the named file already
106 exists.
108 @item EINTR
109 The @code{open} operation was interrupted by a signal.
110 @xref{Interrupted Primitives}.
112 @item EISDIR
113 The @var{flags} argument specified write access, and the file is a directory.
115 @item EMFILE
116 The process has too many files open.
117 The maximum number of file descriptors is controlled by the
118 @code{RLIMIT_NOFILE} resource limit; @pxref{Limits on Resources}.
120 @item ENFILE
121 The entire system, or perhaps the file system which contains the
122 directory, cannot support any additional open files at the moment.
123 (This problem cannot happen on the GNU system.)
125 @item ENOENT
126 The named file does not exist, and @code{O_CREAT} is not specified.
128 @item ENOSPC
129 The directory or file system that would contain the new file cannot be
130 extended, because there is no disk space left.
132 @item ENXIO
133 @code{O_NONBLOCK} and @code{O_WRONLY} are both set in the @var{flags}
134 argument, the file named by @var{filename} is a FIFO (@pxref{Pipes and
135 FIFOs}), and no process has the file open for reading.
137 @item EROFS
138 The file resides on a read-only file system and any of @w{@code{O_WRONLY}},
139 @code{O_RDWR}, and @code{O_TRUNC} are set in the @var{flags} argument,
140 or @code{O_CREAT} is set and the file does not already exist.
141 @end table
143 @c !!! umask
145 If on a 32 bit machine the sources are translated with
146 @code{_FILE_OFFSET_BITS == 64} the function @code{open} returns a file
147 descriptor opened in the large file mode which enables the file handling
148 functions to use files up to @math{2^63} bytes in size and offset from
149 @math{-2^63} to @math{2^63}.  This happens transparently for the user
150 since all of the lowlevel file handling functions are equally replaced.
152 This function is a cancellation point in multi-threaded programs.  This
153 is a problem if the thread allocates some resources (like memory, file
154 descriptors, semaphores or whatever) at the time @code{open} is
155 called.  If the thread gets canceled these resources stay allocated
156 until the program ends.  To avoid this calls to @code{open} should be
157 protected using cancellation handlers.
158 @c ref pthread_cleanup_push / pthread_cleanup_pop
160 The @code{open} function is the underlying primitive for the @code{fopen}
161 and @code{freopen} functions, that create streams.
162 @end deftypefun
164 @comment fcntl.h
165 @comment Unix98
166 @deftypefun int open64 (const char *@var{filename}, int @var{flags}[, mode_t @var{mode}])
167 This function is similar to @code{open}.  It returns a file descriptor
168 which can be used to access the file named by @var{filename}.  The only
169 difference is that on 32 bit systems the file is opened in the
170 large file mode.  I.e., file length and file offsets can exceed 31 bits.
172 When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this
173 function is actually available under the name @code{open}.  I.e., the
174 new, extended API using 64 bit file sizes and offsets transparently
175 replaces the old API.
176 @end deftypefun
178 @comment fcntl.h
179 @comment POSIX.1
180 @deftypefn {Obsolete function} int creat (const char *@var{filename}, mode_t @var{mode})
181 This function is obsolete.  The call:
183 @smallexample
184 creat (@var{filename}, @var{mode})
185 @end smallexample
187 @noindent
188 is equivalent to:
190 @smallexample
191 open (@var{filename}, O_WRONLY | O_CREAT | O_TRUNC, @var{mode})
192 @end smallexample
194 If on a 32 bit machine the sources are translated with
195 @code{_FILE_OFFSET_BITS == 64} the function @code{creat} returns a file
196 descriptor opened in the large file mode which enables the file handling
197 functions to use files up to @math{2^63} in size and offset from
198 @math{-2^63} to @math{2^63}.  This happens transparently for the user
199 since all of the lowlevel file handling functions are equally replaced.
200 @end deftypefn
202 @comment fcntl.h
203 @comment Unix98
204 @deftypefn {Obsolete function} int creat64 (const char *@var{filename}, mode_t @var{mode})
205 This function is similar to @code{creat}.  It returns a file descriptor
206 which can be used to access the file named by @var{filename}.  The only
207 the difference is that on 32 bit systems the file is opened in the
208 large file mode.  I.e., file length and file offsets can exceed 31 bits.
210 To use this file descriptor one must not use the normal operations but
211 instead the counterparts named @code{*64}, e.g., @code{read64}.
213 When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this
214 function is actually available under the name @code{open}.  I.e., the
215 new, extended API using 64 bit file sizes and offsets transparently
216 replaces the old API.
217 @end deftypefn
219 @comment unistd.h
220 @comment POSIX.1
221 @deftypefun int close (int @var{filedes})
222 The function @code{close} closes the file descriptor @var{filedes}.
223 Closing a file has the following consequences:
225 @itemize @bullet
226 @item
227 The file descriptor is deallocated.
229 @item
230 Any record locks owned by the process on the file are unlocked.
232 @item
233 When all file descriptors associated with a pipe or FIFO have been closed,
234 any unread data is discarded.
235 @end itemize
237 This function is a cancellation point in multi-threaded programs.  This
238 is a problem if the thread allocates some resources (like memory, file
239 descriptors, semaphores or whatever) at the time @code{close} is
240 called.  If the thread gets canceled these resources stay allocated
241 until the program ends.  To avoid this, calls to @code{close} should be
242 protected using cancellation handlers.
243 @c ref pthread_cleanup_push / pthread_cleanup_pop
245 The normal return value from @code{close} is @math{0}; a value of @math{-1}
246 is returned in case of failure.  The following @code{errno} error
247 conditions are defined for this function:
249 @table @code
250 @item EBADF
251 The @var{filedes} argument is not a valid file descriptor.
253 @item EINTR
254 The @code{close} call was interrupted by a signal.
255 @xref{Interrupted Primitives}.
256 Here is an example of how to handle @code{EINTR} properly:
258 @smallexample
259 TEMP_FAILURE_RETRY (close (desc));
260 @end smallexample
262 @item ENOSPC
263 @itemx EIO
264 @itemx EDQUOT
265 When the file is accessed by NFS, these errors from @code{write} can sometimes
266 not be detected until @code{close}.  @xref{I/O Primitives}, for details
267 on their meaning.
268 @end table
270 Please note that there is @emph{no} separate @code{close64} function.
271 This is not necessary since this function does not determine nor depend
272 on the mode of the file.  The kernel which performs the @code{close}
273 operation knows which mode the descriptor is used for and can handle
274 this situation.
275 @end deftypefun
277 To close a stream, call @code{fclose} (@pxref{Closing Streams}) instead
278 of trying to close its underlying file descriptor with @code{close}.
279 This flushes any buffered output and updates the stream object to
280 indicate that it is closed.
282 @node I/O Primitives
283 @section Input and Output Primitives
285 This section describes the functions for performing primitive input and
286 output operations on file descriptors: @code{read}, @code{write}, and
287 @code{lseek}.  These functions are declared in the header file
288 @file{unistd.h}.
289 @pindex unistd.h
291 @comment unistd.h
292 @comment POSIX.1
293 @deftp {Data Type} ssize_t
294 This data type is used to represent the sizes of blocks that can be
295 read or written in a single operation.  It is similar to @code{size_t},
296 but must be a signed type.
297 @end deftp
299 @cindex reading from a file descriptor
300 @comment unistd.h
301 @comment POSIX.1
302 @deftypefun ssize_t read (int @var{filedes}, void *@var{buffer}, size_t @var{size})
303 The @code{read} function reads up to @var{size} bytes from the file
304 with descriptor @var{filedes}, storing the results in the @var{buffer}.
305 (This is not necessarily a character string, and no terminating null
306 character is added.)
308 @cindex end-of-file, on a file descriptor
309 The return value is the number of bytes actually read.  This might be
310 less than @var{size}; for example, if there aren't that many bytes left
311 in the file or if there aren't that many bytes immediately available.
312 The exact behavior depends on what kind of file it is.  Note that
313 reading less than @var{size} bytes is not an error.
315 A value of zero indicates end-of-file (except if the value of the
316 @var{size} argument is also zero).  This is not considered an error.
317 If you keep calling @code{read} while at end-of-file, it will keep
318 returning zero and doing nothing else.
320 If @code{read} returns at least one character, there is no way you can
321 tell whether end-of-file was reached.  But if you did reach the end, the
322 next read will return zero.
324 In case of an error, @code{read} returns @math{-1}.  The following
325 @code{errno} error conditions are defined for this function:
327 @table @code
328 @item EAGAIN
329 Normally, when no input is immediately available, @code{read} waits for
330 some input.  But if the @code{O_NONBLOCK} flag is set for the file
331 (@pxref{File Status Flags}), @code{read} returns immediately without
332 reading any data, and reports this error.
334 @strong{Compatibility Note:} Most versions of BSD Unix use a different
335 error code for this: @code{EWOULDBLOCK}.  In the GNU library,
336 @code{EWOULDBLOCK} is an alias for @code{EAGAIN}, so it doesn't matter
337 which name you use.
339 On some systems, reading a large amount of data from a character special
340 file can also fail with @code{EAGAIN} if the kernel cannot find enough
341 physical memory to lock down the user's pages.  This is limited to
342 devices that transfer with direct memory access into the user's memory,
343 which means it does not include terminals, since they always use
344 separate buffers inside the kernel.  This problem never happens in the
345 GNU system.
347 Any condition that could result in @code{EAGAIN} can instead result in a
348 successful @code{read} which returns fewer bytes than requested.
349 Calling @code{read} again immediately would result in @code{EAGAIN}.
351 @item EBADF
352 The @var{filedes} argument is not a valid file descriptor,
353 or is not open for reading.
355 @item EINTR
356 @code{read} was interrupted by a signal while it was waiting for input.
357 @xref{Interrupted Primitives}.  A signal will not necessary cause
358 @code{read} to return @code{EINTR}; it may instead result in a
359 successful @code{read} which returns fewer bytes than requested.
361 @item EIO
362 For many devices, and for disk files, this error code indicates
363 a hardware error.
365 @code{EIO} also occurs when a background process tries to read from the
366 controlling terminal, and the normal action of stopping the process by
367 sending it a @code{SIGTTIN} signal isn't working.  This might happen if
368 the signal is being blocked or ignored, or because the process group is
369 orphaned.  @xref{Job Control}, for more information about job control,
370 and @ref{Signal Handling}, for information about signals.
371 @end table
373 Please note that there is no function named @code{read64}.  This is not
374 necessary since this function does not directly modify or handle the
375 possibly wide file offset.  Since the kernel handles this state
376 internally, the @code{read} function can be used for all cases.
378 This function is a cancellation point in multi-threaded programs.  This
379 is a problem if the thread allocates some resources (like memory, file
380 descriptors, semaphores or whatever) at the time @code{read} is
381 called.  If the thread gets canceled these resources stay allocated
382 until the program ends.  To avoid this, calls to @code{read} should be
383 protected using cancellation handlers.
384 @c ref pthread_cleanup_push / pthread_cleanup_pop
386 The @code{read} function is the underlying primitive for all of the
387 functions that read from streams, such as @code{fgetc}.
388 @end deftypefun
390 @comment unistd.h
391 @comment Unix98
392 @deftypefun ssize_t pread (int @var{filedes}, void *@var{buffer}, size_t @var{size}, off_t @var{offset})
393 The @code{pread} function is similar to the @code{read} function.  The
394 first three arguments are identical, and the return values and error
395 codes also correspond.
397 The difference is the fourth argument and its handling.  The data block
398 is not read from the current position of the file descriptor
399 @code{filedes}.  Instead the data is read from the file starting at
400 position @var{offset}.  The position of the file descriptor itself is
401 not affected by the operation.  The value is the same as before the call.
403 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
404 @code{pread} function is in fact @code{pread64} and the type
405 @code{off_t} has 64 bits, which makes it possible to handle files up to
406 @math{2^63} bytes in length.
408 The return value of @code{pread} describes the number of bytes read.
409 In the error case it returns @math{-1} like @code{read} does and the
410 error codes are also the same, with these additions:
412 @table @code
413 @item EINVAL
414 The value given for @var{offset} is negative and therefore illegal.
416 @item ESPIPE
417 The file descriptor @var{filedes} is associate with a pipe or a FIFO and
418 this device does not allow positioning of the file pointer.
419 @end table
421 The function is an extension defined in the Unix Single Specification
422 version 2.
423 @end deftypefun
425 @comment unistd.h
426 @comment Unix98
427 @deftypefun ssize_t pread64 (int @var{filedes}, void *@var{buffer}, size_t @var{size}, off64_t @var{offset})
428 This function is similar to the @code{pread} function.  The difference
429 is that the @var{offset} parameter is of type @code{off64_t} instead of
430 @code{off_t} which makes it possible on 32 bit machines to address
431 files larger than @math{2^31} bytes and up to @math{2^63} bytes.  The
432 file descriptor @code{filedes} must be opened using @code{open64} since
433 otherwise the large offsets possible with @code{off64_t} will lead to
434 errors with a descriptor in small file mode.
436 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a
437 32 bit machine this function is actually available under the name
438 @code{pread} and so transparently replaces the 32 bit interface.
439 @end deftypefun
441 @cindex writing to a file descriptor
442 @comment unistd.h
443 @comment POSIX.1
444 @deftypefun ssize_t write (int @var{filedes}, const void *@var{buffer}, size_t @var{size})
445 The @code{write} function writes up to @var{size} bytes from
446 @var{buffer} to the file with descriptor @var{filedes}.  The data in
447 @var{buffer} is not necessarily a character string and a null character is
448 output like any other character.
450 The return value is the number of bytes actually written.  This may be
451 @var{size}, but can always be smaller.  Your program should always call
452 @code{write} in a loop, iterating until all the data is written.
454 Once @code{write} returns, the data is enqueued to be written and can be
455 read back right away, but it is not necessarily written out to permanent
456 storage immediately.  You can use @code{fsync} when you need to be sure
457 your data has been permanently stored before continuing.  (It is more
458 efficient for the system to batch up consecutive writes and do them all
459 at once when convenient.  Normally they will always be written to disk
460 within a minute or less.)  Modern systems provide another function
461 @code{fdatasync} which guarantees integrity only for the file data and
462 is therefore faster.
463 @c !!! xref fsync, fdatasync
464 You can use the @code{O_FSYNC} open mode to make @code{write} always
465 store the data to disk before returning; @pxref{Operating Modes}.
467 In the case of an error, @code{write} returns @math{-1}.  The following
468 @code{errno} error conditions are defined for this function:
470 @table @code
471 @item EAGAIN
472 Normally, @code{write} blocks until the write operation is complete.
473 But if the @code{O_NONBLOCK} flag is set for the file (@pxref{Control
474 Operations}), it returns immediately without writing any data and
475 reports this error.  An example of a situation that might cause the
476 process to block on output is writing to a terminal device that supports
477 flow control, where output has been suspended by receipt of a STOP
478 character.
480 @strong{Compatibility Note:} Most versions of BSD Unix use a different
481 error code for this: @code{EWOULDBLOCK}.  In the GNU library,
482 @code{EWOULDBLOCK} is an alias for @code{EAGAIN}, so it doesn't matter
483 which name you use.
485 On some systems, writing a large amount of data from a character special
486 file can also fail with @code{EAGAIN} if the kernel cannot find enough
487 physical memory to lock down the user's pages.  This is limited to
488 devices that transfer with direct memory access into the user's memory,
489 which means it does not include terminals, since they always use
490 separate buffers inside the kernel.  This problem does not arise in the
491 GNU system.
493 @item EBADF
494 The @var{filedes} argument is not a valid file descriptor,
495 or is not open for writing.
497 @item EFBIG
498 The size of the file would become larger than the implementation can support.
500 @item EINTR
501 The @code{write} operation was interrupted by a signal while it was
502 blocked waiting for completion.  A signal will not necessarily cause
503 @code{write} to return @code{EINTR}; it may instead result in a
504 successful @code{write} which writes fewer bytes than requested.
505 @xref{Interrupted Primitives}.
507 @item EIO
508 For many devices, and for disk files, this error code indicates
509 a hardware error.
511 @item ENOSPC
512 The device containing the file is full.
514 @item EPIPE
515 This error is returned when you try to write to a pipe or FIFO that
516 isn't open for reading by any process.  When this happens, a @code{SIGPIPE}
517 signal is also sent to the process; see @ref{Signal Handling}.
518 @end table
520 Unless you have arranged to prevent @code{EINTR} failures, you should
521 check @code{errno} after each failing call to @code{write}, and if the
522 error was @code{EINTR}, you should simply repeat the call.
523 @xref{Interrupted Primitives}.  The easy way to do this is with the
524 macro @code{TEMP_FAILURE_RETRY}, as follows:
526 @smallexample
527 nbytes = TEMP_FAILURE_RETRY (write (desc, buffer, count));
528 @end smallexample
530 Please note that there is no function named @code{write64}.  This is not
531 necessary since this function does not directly modify or handle the
532 possibly wide file offset.  Since the kernel handles this state
533 internally the @code{write} function can be used for all cases.
535 This function is a cancellation point in multi-threaded programs.  This
536 is a problem if the thread allocates some resources (like memory, file
537 descriptors, semaphores or whatever) at the time @code{write} is
538 called.  If the thread gets canceled these resources stay allocated
539 until the program ends.  To avoid this, calls to @code{write} should be
540 protected using cancellation handlers.
541 @c ref pthread_cleanup_push / pthread_cleanup_pop
543 The @code{write} function is the underlying primitive for all of the
544 functions that write to streams, such as @code{fputc}.
545 @end deftypefun
547 @comment unistd.h
548 @comment Unix98
549 @deftypefun ssize_t pwrite (int @var{filedes}, const void *@var{buffer}, size_t @var{size}, off_t @var{offset})
550 The @code{pwrite} function is similar to the @code{write} function.  The
551 first three arguments are identical, and the return values and error codes
552 also correspond.
554 The difference is the fourth argument and its handling.  The data block
555 is not written to the current position of the file descriptor
556 @code{filedes}.  Instead the data is written to the file starting at
557 position @var{offset}.  The position of the file descriptor itself is
558 not affected by the operation.  The value is the same as before the call.
560 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
561 @code{pwrite} function is in fact @code{pwrite64} and the type
562 @code{off_t} has 64 bits, which makes it possible to handle files up to
563 @math{2^63} bytes in length.
565 The return value of @code{pwrite} describes the number of written bytes.
566 In the error case it returns @math{-1} like @code{write} does and the
567 error codes are also the same, with these additions:
569 @table @code
570 @item EINVAL
571 The value given for @var{offset} is negative and therefore illegal.
573 @item ESPIPE
574 The file descriptor @var{filedes} is associated with a pipe or a FIFO and
575 this device does not allow positioning of the file pointer.
576 @end table
578 The function is an extension defined in the Unix Single Specification
579 version 2.
580 @end deftypefun
582 @comment unistd.h
583 @comment Unix98
584 @deftypefun ssize_t pwrite64 (int @var{filedes}, const void *@var{buffer}, size_t @var{size}, off64_t @var{offset})
585 This function is similar to the @code{pwrite} function.  The difference
586 is that the @var{offset} parameter is of type @code{off64_t} instead of
587 @code{off_t} which makes it possible on 32 bit machines to address
588 files larger than @math{2^31} bytes and up to @math{2^63} bytes.  The
589 file descriptor @code{filedes} must be opened using @code{open64} since
590 otherwise the large offsets possible with @code{off64_t} will lead to
591 errors with a descriptor in small file mode.
593 When the source file is compiled using @code{_FILE_OFFSET_BITS == 64} on a
594 32 bit machine this function is actually available under the name
595 @code{pwrite} and so transparently replaces the 32 bit interface.
596 @end deftypefun
599 @node File Position Primitive
600 @section Setting the File Position of a Descriptor
602 Just as you can set the file position of a stream with @code{fseek}, you
603 can set the file position of a descriptor with @code{lseek}.  This
604 specifies the position in the file for the next @code{read} or
605 @code{write} operation.  @xref{File Positioning}, for more information
606 on the file position and what it means.
608 To read the current file position value from a descriptor, use
609 @code{lseek (@var{desc}, 0, SEEK_CUR)}.
611 @cindex file positioning on a file descriptor
612 @cindex positioning a file descriptor
613 @cindex seeking on a file descriptor
614 @comment unistd.h
615 @comment POSIX.1
616 @deftypefun off_t lseek (int @var{filedes}, off_t @var{offset}, int @var{whence})
617 The @code{lseek} function is used to change the file position of the
618 file with descriptor @var{filedes}.
620 The @var{whence} argument specifies how the @var{offset} should be
621 interpreted, in the same way as for the @code{fseek} function, and it must
622 be one of the symbolic constants @code{SEEK_SET}, @code{SEEK_CUR}, or
623 @code{SEEK_END}.
625 @table @code
626 @item SEEK_SET
627 Specifies that @var{whence} is a count of characters from the beginning
628 of the file.
630 @item SEEK_CUR
631 Specifies that @var{whence} is a count of characters from the current
632 file position.  This count may be positive or negative.
634 @item SEEK_END
635 Specifies that @var{whence} is a count of characters from the end of
636 the file.  A negative count specifies a position within the current
637 extent of the file; a positive count specifies a position past the
638 current end.  If you set the position past the current end, and
639 actually write data, you will extend the file with zeros up to that
640 position.
641 @end table
643 The return value from @code{lseek} is normally the resulting file
644 position, measured in bytes from the beginning of the file.
645 You can use this feature together with @code{SEEK_CUR} to read the
646 current file position.
648 If you want to append to the file, setting the file position to the
649 current end of file with @code{SEEK_END} is not sufficient.  Another
650 process may write more data after you seek but before you write,
651 extending the file so the position you write onto clobbers their data.
652 Instead, use the @code{O_APPEND} operating mode; @pxref{Operating Modes}.
654 You can set the file position past the current end of the file.  This
655 does not by itself make the file longer; @code{lseek} never changes the
656 file.  But subsequent output at that position will extend the file.
657 Characters between the previous end of file and the new position are
658 filled with zeros.  Extending the file in this way can create a
659 ``hole'': the blocks of zeros are not actually allocated on disk, so the
660 file takes up less space than it appears to; it is then called a
661 ``sparse file''.
662 @cindex sparse files
663 @cindex holes in files
665 If the file position cannot be changed, or the operation is in some way
666 invalid, @code{lseek} returns a value of @math{-1}.  The following
667 @code{errno} error conditions are defined for this function:
669 @table @code
670 @item EBADF
671 The @var{filedes} is not a valid file descriptor.
673 @item EINVAL
674 The @var{whence} argument value is not valid, or the resulting
675 file offset is not valid.  A file offset is invalid.
677 @item ESPIPE
678 The @var{filedes} corresponds to an object that cannot be positioned,
679 such as a pipe, FIFO or terminal device.  (POSIX.1 specifies this error
680 only for pipes and FIFOs, but in the GNU system, you always get
681 @code{ESPIPE} if the object is not seekable.)
682 @end table
684 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
685 @code{lseek} function is in fact @code{lseek64} and the type
686 @code{off_t} has 64 bits which makes it possible to handle files up to
687 @math{2^63} bytes in length.
689 This function is a cancellation point in multi-threaded programs.  This
690 is a problem if the thread allocates some resources (like memory, file
691 descriptors, semaphores or whatever) at the time @code{lseek} is
692 called.  If the thread gets canceled these resources stay allocated
693 until the program ends.  To avoid this calls to @code{lseek} should be
694 protected using cancellation handlers.
695 @c ref pthread_cleanup_push / pthread_cleanup_pop
697 The @code{lseek} function is the underlying primitive for the
698 @code{fseek}, @code{fseeko}, @code{ftell}, @code{ftello} and
699 @code{rewind} functions, which operate on streams instead of file
700 descriptors.
701 @end deftypefun
703 @comment unistd.h
704 @comment Unix98
705 @deftypefun off64_t lseek64 (int @var{filedes}, off64_t @var{offset}, int @var{whence})
706 This function is similar to the @code{lseek} function.  The difference
707 is that the @var{offset} parameter is of type @code{off64_t} instead of
708 @code{off_t} which makes it possible on 32 bit machines to address
709 files larger than @math{2^31} bytes and up to @math{2^63} bytes.  The
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.
714 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a
715 32 bits machine this function is actually available under the name
716 @code{lseek} and so transparently replaces the 32 bit interface.
717 @end deftypefun
719 You can have multiple descriptors for the same file if you open the file
720 more than once, or if you duplicate a descriptor with @code{dup}.
721 Descriptors that come from separate calls to @code{open} have independent
722 file positions; using @code{lseek} on one descriptor has no effect on the
723 other.  For example,
725 @smallexample
726 @group
728   int d1, d2;
729   char buf[4];
730   d1 = open ("foo", O_RDONLY);
731   d2 = open ("foo", O_RDONLY);
732   lseek (d1, 1024, SEEK_SET);
733   read (d2, buf, 4);
735 @end group
736 @end smallexample
738 @noindent
739 will read the first four characters of the file @file{foo}.  (The
740 error-checking code necessary for a real program has been omitted here
741 for brevity.)
743 By contrast, descriptors made by duplication share a common file
744 position with the original descriptor that was duplicated.  Anything
745 which alters the file position of one of the duplicates, including
746 reading or writing data, affects all of them alike.  Thus, for example,
748 @smallexample
750   int d1, d2, d3;
751   char buf1[4], buf2[4];
752   d1 = open ("foo", O_RDONLY);
753   d2 = dup (d1);
754   d3 = dup (d2);
755   lseek (d3, 1024, SEEK_SET);
756   read (d1, buf1, 4);
757   read (d2, buf2, 4);
759 @end smallexample
761 @noindent
762 will read four characters starting with the 1024'th character of
763 @file{foo}, and then four more characters starting with the 1028'th
764 character.
766 @comment sys/types.h
767 @comment POSIX.1
768 @deftp {Data Type} off_t
769 This is an arithmetic data type used to represent file sizes.
770 In the GNU system, this is equivalent to @code{fpos_t} or @code{long int}.
772 If the source is compiled with @code{_FILE_OFFSET_BITS == 64} this type
773 is transparently replaced by @code{off64_t}.
774 @end deftp
776 @comment sys/types.h
777 @comment Unix98
778 @deftp {Data Type} off64_t
779 This type is used similar to @code{off_t}.  The difference is that even
780 on 32 bit machines, where the @code{off_t} type would have 32 bits,
781 @code{off64_t} has 64 bits and so is able to address files up to
782 @math{2^63} bytes in length.
784 When compiling with @code{_FILE_OFFSET_BITS == 64} this type is
785 available under the name @code{off_t}.
786 @end deftp
788 These aliases for the @samp{SEEK_@dots{}} constants exist for the sake
789 of compatibility with older BSD systems.  They are defined in two
790 different header files: @file{fcntl.h} and @file{sys/file.h}.
792 @table @code
793 @item L_SET
794 An alias for @code{SEEK_SET}.
796 @item L_INCR
797 An alias for @code{SEEK_CUR}.
799 @item L_XTND
800 An alias for @code{SEEK_END}.
801 @end table
803 @node Descriptors and Streams
804 @section Descriptors and Streams
805 @cindex streams, and file descriptors
806 @cindex converting file descriptor to stream
807 @cindex extracting file descriptor from stream
809 Given an open file descriptor, you can create a stream for it with the
810 @code{fdopen} function.  You can get the underlying file descriptor for
811 an existing stream with the @code{fileno} function.  These functions are
812 declared in the header file @file{stdio.h}.
813 @pindex stdio.h
815 @comment stdio.h
816 @comment POSIX.1
817 @deftypefun {FILE *} fdopen (int @var{filedes}, const char *@var{opentype})
818 The @code{fdopen} function returns a new stream for the file descriptor
819 @var{filedes}.
821 The @var{opentype} argument is interpreted in the same way as for the
822 @code{fopen} function (@pxref{Opening Streams}), except that
823 the @samp{b} option is not permitted; this is because GNU makes no
824 distinction between text and binary files.  Also, @code{"w"} and
825 @code{"w+"} do not cause truncation of the file; these have an effect only
826 when opening a file, and in this case the file has already been opened.
827 You must make sure that the @var{opentype} argument matches the actual
828 mode of the open file descriptor.
830 The return value is the new stream.  If the stream cannot be created
831 (for example, if the modes for the file indicated by the file descriptor
832 do not permit the access specified by the @var{opentype} argument), a
833 null pointer is returned instead.
835 In some other systems, @code{fdopen} may fail to detect that the modes
836 for file descriptor do not permit the access specified by
837 @code{opentype}.  The GNU C library always checks for this.
838 @end deftypefun
840 For an example showing the use of the @code{fdopen} function,
841 see @ref{Creating a Pipe}.
843 @comment stdio.h
844 @comment POSIX.1
845 @deftypefun int fileno (FILE *@var{stream})
846 This function returns the file descriptor associated with the stream
847 @var{stream}.  If an error is detected (for example, if the @var{stream}
848 is not valid) or if @var{stream} does not do I/O to a file,
849 @code{fileno} returns @math{-1}.
850 @end deftypefun
852 @comment stdio.h
853 @comment GNU
854 @deftypefun int fileno_unlocked (FILE *@var{stream})
855 The @code{fileno_unlocked} function is equivalent to the @code{fileno}
856 function except that it does not implicitly lock the stream if the state
857 is @code{FSETLOCKING_INTERNAL}.
859 This function is a GNU extension.
860 @end deftypefun
862 @cindex standard file descriptors
863 @cindex file descriptors, standard
864 There are also symbolic constants defined in @file{unistd.h} for the
865 file descriptors belonging to the standard streams @code{stdin},
866 @code{stdout}, and @code{stderr}; see @ref{Standard Streams}.
867 @pindex unistd.h
869 @comment unistd.h
870 @comment POSIX.1
871 @table @code
872 @item STDIN_FILENO
873 @vindex STDIN_FILENO
874 This macro has value @code{0}, which is the file descriptor for
875 standard input.
876 @cindex standard input file descriptor
878 @comment unistd.h
879 @comment POSIX.1
880 @item STDOUT_FILENO
881 @vindex STDOUT_FILENO
882 This macro has value @code{1}, which is the file descriptor for
883 standard output.
884 @cindex standard output file descriptor
886 @comment unistd.h
887 @comment POSIX.1
888 @item STDERR_FILENO
889 @vindex STDERR_FILENO
890 This macro has value @code{2}, which is the file descriptor for
891 standard error output.
892 @end table
893 @cindex standard error file descriptor
895 @node Stream/Descriptor Precautions
896 @section Dangers of Mixing Streams and Descriptors
897 @cindex channels
898 @cindex streams and descriptors
899 @cindex descriptors and streams
900 @cindex mixing descriptors and streams
902 You can have multiple file descriptors and streams (let's call both
903 streams and descriptors ``channels'' for short) connected to the same
904 file, but you must take care to avoid confusion between channels.  There
905 are two cases to consider: @dfn{linked} channels that share a single
906 file position value, and @dfn{independent} channels that have their own
907 file positions.
909 It's best to use just one channel in your program for actual data
910 transfer to any given file, except when all the access is for input.
911 For example, if you open a pipe (something you can only do at the file
912 descriptor level), either do all I/O with the descriptor, or construct a
913 stream from the descriptor with @code{fdopen} and then do all I/O with
914 the stream.
916 @menu
917 * Linked Channels::        Dealing with channels sharing a file position.
918 * Independent Channels::   Dealing with separately opened, unlinked channels.
919 * Cleaning Streams::       Cleaning a stream makes it safe to use
920                             another channel.
921 @end menu
923 @node Linked Channels
924 @subsection Linked Channels
925 @cindex linked channels
927 Channels that come from a single opening share the same file position;
928 we call them @dfn{linked} channels.  Linked channels result when you
929 make a stream from a descriptor using @code{fdopen}, when you get a
930 descriptor from a stream with @code{fileno}, when you copy a descriptor
931 with @code{dup} or @code{dup2}, and when descriptors are inherited
932 during @code{fork}.  For files that don't support random access, such as
933 terminals and pipes, @emph{all} channels are effectively linked.  On
934 random-access files, all append-type output streams are effectively
935 linked to each other.
937 @cindex cleaning up a stream
938 If you have been using a stream for I/O, and you want to do I/O using
939 another channel (either a stream or a descriptor) that is linked to it,
940 you must first @dfn{clean up} the stream that you have been using.
941 @xref{Cleaning Streams}.
943 Terminating a process, or executing a new program in the process,
944 destroys all the streams in the process.  If descriptors linked to these
945 streams persist in other processes, their file positions become
946 undefined as a result.  To prevent this, you must clean up the streams
947 before destroying them.
949 @node Independent Channels
950 @subsection Independent Channels
951 @cindex independent channels
953 When you open channels (streams or descriptors) separately on a seekable
954 file, each channel has its own file position.  These are called
955 @dfn{independent channels}.
957 The system handles each channel independently.  Most of the time, this
958 is quite predictable and natural (especially for input): each channel
959 can read or write sequentially at its own place in the file.  However,
960 if some of the channels are streams, you must take these precautions:
962 @itemize @bullet
963 @item
964 You should clean an output stream after use, before doing anything else
965 that might read or write from the same part of the file.
967 @item
968 You should clean an input stream before reading data that may have been
969 modified using an independent channel.  Otherwise, you might read
970 obsolete data that had been in the stream's buffer.
971 @end itemize
973 If you do output to one channel at the end of the file, this will
974 certainly leave the other independent channels positioned somewhere
975 before the new end.  You cannot reliably set their file positions to the
976 new end of file before writing, because the file can always be extended
977 by another process between when you set the file position and when you
978 write the data.  Instead, use an append-type descriptor or stream; they
979 always output at the current end of the file.  In order to make the
980 end-of-file position accurate, you must clean the output channel you
981 were using, if it is a stream.
983 It's impossible for two channels to have separate file pointers for a
984 file that doesn't support random access.  Thus, channels for reading or
985 writing such files are always linked, never independent.  Append-type
986 channels are also always linked.  For these channels, follow the rules
987 for linked channels; see @ref{Linked Channels}.
989 @node Cleaning Streams
990 @subsection Cleaning Streams
992 On the GNU system, you can clean up any stream with @code{fclean}:
994 @comment stdio.h
995 @comment GNU
996 @deftypefun int fclean (FILE *@var{stream})
997 Clean up the stream @var{stream} so that its buffer is empty.  If
998 @var{stream} is doing output, force it out.  If @var{stream} is doing
999 input, give the data in the buffer back to the system, arranging to
1000 reread it.
1001 @end deftypefun
1003 On other systems, you can use @code{fflush} to clean a stream in most
1004 cases.
1006 You can skip the @code{fclean} or @code{fflush} if you know the stream
1007 is already clean.  A stream is clean whenever its buffer is empty.  For
1008 example, an unbuffered stream is always clean.  An input stream that is
1009 at end-of-file is clean.  A line-buffered stream is clean when the last
1010 character output was a newline.
1012 There is one case in which cleaning a stream is impossible on most
1013 systems.  This is when the stream is doing input from a file that is not
1014 random-access.  Such streams typically read ahead, and when the file is
1015 not random access, there is no way to give back the excess data already
1016 read.  When an input stream reads from a random-access file,
1017 @code{fflush} does clean the stream, but leaves the file pointer at an
1018 unpredictable place; you must set the file pointer before doing any
1019 further I/O.  On the GNU system, using @code{fclean} avoids both of
1020 these problems.
1022 Closing an output-only stream also does @code{fflush}, so this is a
1023 valid way of cleaning an output stream.  On the GNU system, closing an
1024 input stream does @code{fclean}.
1026 You need not clean a stream before using its descriptor for control
1027 operations such as setting terminal modes; these operations don't affect
1028 the file position and are not affected by it.  You can use any
1029 descriptor for these operations, and all channels are affected
1030 simultaneously.  However, text already ``output'' to a stream but still
1031 buffered by the stream will be subject to the new terminal modes when
1032 subsequently flushed.  To make sure ``past'' output is covered by the
1033 terminal settings that were in effect at the time, flush the output
1034 streams for that terminal before setting the modes.  @xref{Terminal
1035 Modes}.
1037 @node Scatter-Gather
1038 @section Fast Scatter-Gather I/O
1039 @cindex scatter-gather
1041 Some applications may need to read or write data to multiple buffers,
1042 which are separated in memory.  Although this can be done easily enough
1043 with multiple calls to @code{read} and @code{write}, it is inefficient
1044 because there is overhead associated with each kernel call.
1046 Instead, many platforms provide special high-speed primitives to perform
1047 these @dfn{scatter-gather} operations in a single kernel call.  The GNU C
1048 library will provide an emulation on any system that lacks these
1049 primitives, so they are not a portability threat.  They are defined in
1050 @code{sys/uio.h}.
1052 These functions are controlled with arrays of @code{iovec} structures,
1053 which describe the location and size of each buffer.
1055 @comment sys/uio.h
1056 @comment BSD
1057 @deftp {Data Type} {struct iovec}
1059 The @code{iovec} structure describes a buffer. It contains two fields:
1061 @table @code
1063 @item void *iov_base
1064 Contains the address of a buffer.
1066 @item size_t iov_len
1067 Contains the length of the buffer.
1069 @end table
1070 @end deftp
1072 @comment sys/uio.h
1073 @comment BSD
1074 @deftypefun ssize_t readv (int @var{filedes}, const struct iovec *@var{vector}, int @var{count})
1076 The @code{readv} function reads data from @var{filedes} and scatters it
1077 into the buffers described in @var{vector}, which is taken to be
1078 @var{count} structures long.  As each buffer is filled, data is sent to the
1079 next.
1081 Note that @code{readv} is not guaranteed to fill all the buffers.
1082 It may stop at any point, for the same reasons @code{read} would.
1084 The return value is a count of bytes (@emph{not} buffers) read, @math{0}
1085 indicating end-of-file, or @math{-1} indicating an error.  The possible
1086 errors are the same as in @code{read}.
1088 @end deftypefun
1090 @comment sys/uio.h
1091 @comment BSD
1092 @deftypefun ssize_t writev (int @var{filedes}, const struct iovec *@var{vector}, int @var{count})
1094 The @code{writev} function gathers data from the buffers described in
1095 @var{vector}, which is taken to be @var{count} structures long, and writes
1096 them to @code{filedes}.  As each buffer is written, it moves on to the
1097 next.
1099 Like @code{readv}, @code{writev} may stop midstream under the same
1100 conditions @code{write} would.
1102 The return value is a count of bytes written, or @math{-1} indicating an
1103 error.  The possible errors are the same as in @code{write}.
1105 @end deftypefun
1107 @c Note - I haven't read this anywhere. I surmised it from my knowledge
1108 @c of computer science. Thus, there could be subtleties I'm missing.
1110 Note that if the buffers are small (under about 1kB), high-level streams
1111 may be easier to use than these functions.  However, @code{readv} and
1112 @code{writev} are more efficient when the individual buffers themselves
1113 (as opposed to the total output), are large.  In that case, a high-level
1114 stream would not be able to cache the data effectively.
1116 @node Memory-mapped I/O
1117 @section Memory-mapped I/O
1119 On modern operating systems, it is possible to @dfn{mmap} (pronounced
1120 ``em-map'') a file to a region of memory.  When this is done, the file can
1121 be accessed just like an array in the program.
1123 This is more efficient than @code{read} or @code{write}, as only the regions
1124 of the file that a program actually accesses are loaded.  Accesses to
1125 not-yet-loaded parts of the mmapped region are handled in the same way as
1126 swapped out pages.
1128 Since mmapped pages can be stored back to their file when physical
1129 memory is low, it is possible to mmap files orders of magnitude larger
1130 than both the physical memory @emph{and} swap space.  The only limit is
1131 address space.  The theoretical limit is 4GB on a 32-bit machine -
1132 however, the actual limit will be smaller since some areas will be
1133 reserved for other purposes.  If the LFS interface is used the file size
1134 on 32-bit systems is not limited to 2GB (offsets are signed which
1135 reduces the addressable area of 4GB by half); the full 64-bit are
1136 available.
1138 Memory mapping only works on entire pages of memory.  Thus, addresses
1139 for mapping must be page-aligned, and length values will be rounded up.
1140 To determine the size of a page the machine uses one should use
1142 @vindex _SC_PAGESIZE
1143 @smallexample
1144 size_t page_size = (size_t) sysconf (_SC_PAGESIZE);
1145 @end smallexample
1147 @noindent
1148 These functions are declared in @file{sys/mman.h}.
1150 @comment sys/mman.h
1151 @comment POSIX
1152 @deftypefun {void *} mmap (void *@var{address}, size_t @var{length},int @var{protect}, int @var{flags}, int @var{filedes}, off_t @var{offset})
1154 The @code{mmap} function creates a new mapping, connected to bytes
1155 (@var{offset}) to (@var{offset} + @var{length} - 1) in the file open on
1156 @var{filedes}.
1158 @var{address} gives a preferred starting address for the mapping.
1159 @code{NULL} expresses no preference. Any previous mapping at that
1160 address is automatically removed. The address you give may still be
1161 changed, unless you use the @code{MAP_FIXED} flag.
1163 @vindex PROT_READ
1164 @vindex PROT_WRITE
1165 @vindex PROT_EXEC
1166 @var{protect} contains flags that control what kind of access is
1167 permitted.  They include @code{PROT_READ}, @code{PROT_WRITE}, and
1168 @code{PROT_EXEC}, which permit reading, writing, and execution,
1169 respectively.  Inappropriate access will cause a segfault (@pxref{Program
1170 Error Signals}).
1172 Note that most hardware designs cannot support write permission without
1173 read permission, and many do not distinguish read and execute permission.
1174 Thus, you may receive wider permissions than you ask for, and mappings of
1175 write-only files may be denied even if you do not use @code{PROT_READ}.
1177 @var{flags} contains flags that control the nature of the map.
1178 One of @code{MAP_SHARED} or @code{MAP_PRIVATE} must be specified.
1180 They include:
1182 @vtable @code
1183 @item MAP_PRIVATE
1184 This specifies that writes to the region should never be written back
1185 to the attached file.  Instead, a copy is made for the process, and the
1186 region will be swapped normally if memory runs low.  No other process will
1187 see the changes.
1189 Since private mappings effectively revert to ordinary memory
1190 when written to, you must have enough virtual memory for a copy of
1191 the entire mmapped region if you use this mode with @code{PROT_WRITE}.
1193 @item MAP_SHARED
1194 This specifies that writes to the region will be written back to the
1195 file.  Changes made will be shared immediately with other processes
1196 mmaping the same file.
1198 Note that actual writing may take place at any time.  You need to use
1199 @code{msync}, described below, if it is important that other processes
1200 using conventional I/O get a consistent view of the file.
1202 @item MAP_FIXED
1203 This forces the system to use the exact mapping address specified in
1204 @var{address} and fail if it can't.
1206 @c One of these is official - the other is obviously an obsolete synonym
1207 @c Which is which?
1208 @item MAP_ANONYMOUS
1209 @itemx MAP_ANON
1210 This flag tells the system to create an anonymous mapping, not connected
1211 to a file.  @var{filedes} and @var{off} are ignored, and the region is
1212 initialized with zeros.
1214 Anonymous maps are used as the basic primitive to extend the heap on some
1215 systems.  They are also useful to share data between multiple tasks
1216 without creating a file.
1218 On some systems using private anonymous mmaps is more efficient than using
1219 @code{malloc} for large blocks.  This is not an issue with the GNU C library,
1220 as the included @code{malloc} automatically uses @code{mmap} where appropriate.
1222 @c Linux has some other MAP_ options, which I have not discussed here.
1223 @c MAP_DENYWRITE, MAP_EXECUTABLE and MAP_GROWSDOWN don't seem applicable to
1224 @c user programs (and I don't understand the last two). MAP_LOCKED does
1225 @c not appear to be implemented.
1227 @end vtable
1229 @code{mmap} returns the address of the new mapping, or @math{-1} for an
1230 error.
1232 Possible errors include:
1234 @table @code
1236 @item EINVAL
1238 Either @var{address} was unusable, or inconsistent @var{flags} were
1239 given.
1241 @item EACCES
1243 @var{filedes} was not open for the type of access specified in @var{protect}.
1245 @item ENOMEM
1247 Either there is not enough memory for the operation, or the process is
1248 out of address space.
1250 @item ENODEV
1252 This file is of a type that doesn't support mapping.
1254 @item ENOEXEC
1256 The file is on a filesystem that doesn't support mapping.
1258 @c On Linux, EAGAIN will appear if the file has a conflicting mandatory lock.
1259 @c However mandatory locks are not discussed in this manual.
1261 @c Similarly, ETXTBSY will occur if the MAP_DENYWRITE flag (not documented
1262 @c here) is used and the file is already open for writing.
1264 @end table
1266 @end deftypefun
1268 @comment sys/mman.h
1269 @comment LFS
1270 @deftypefun {void *} mmap64 (void *@var{address}, size_t @var{length},int @var{protect}, int @var{flags}, int @var{filedes}, off64_t @var{offset})
1271 The @code{mmap64} function is equivalent to the @code{mmap} function but
1272 the @var{offset} parameter is of type @code{off64_t}.  On 32-bit systems
1273 this allows the file associated with the @var{filedes} descriptor to be
1274 larger than 2GB.  @var{filedes} must be a descriptor returned from a
1275 call to @code{open64} or @code{fopen64} and @code{freopen64} where the
1276 descriptor is retrieved with @code{fileno}.
1278 When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this
1279 function is actually available under the name @code{mmap}.  I.e., the
1280 new, extended API using 64 bit file sizes and offsets transparently
1281 replaces the old API.
1282 @end deftypefun
1284 @comment sys/mman.h
1285 @comment POSIX
1286 @deftypefun int munmap (void *@var{addr}, size_t @var{length})
1288 @code{munmap} removes any memory maps from (@var{addr}) to (@var{addr} +
1289 @var{length}).  @var{length} should be the length of the mapping.
1291 It is safe to unmap multiple mappings in one command, or include unmapped
1292 space in the range.  It is also possible to unmap only part of an existing
1293 mapping.  However, only entire pages can be removed.  If @var{length} is not
1294 an even number of pages, it will be rounded up.
1296 It returns @math{0} for success and @math{-1} for an error.
1298 One error is possible:
1300 @table @code
1302 @item EINVAL
1303 The memory range given was outside the user mmap range or wasn't page
1304 aligned.
1306 @end table
1308 @end deftypefun
1310 @comment sys/mman.h
1311 @comment POSIX
1312 @deftypefun int msync (void *@var{address}, size_t @var{length}, int @var{flags})
1314 When using shared mappings, the kernel can write the file at any time
1315 before the mapping is removed.  To be certain data has actually been
1316 written to the file and will be accessible to non-memory-mapped I/O, it
1317 is necessary to use this function.
1319 It operates on the region @var{address} to (@var{address} + @var{length}).
1320 It may be used on part of a mapping or multiple mappings, however the
1321 region given should not contain any unmapped space.
1323 @var{flags} can contain some options:
1325 @vtable @code
1327 @item MS_SYNC
1329 This flag makes sure the data is actually written @emph{to disk}.
1330 Normally @code{msync} only makes sure that accesses to a file with
1331 conventional I/O reflect the recent changes.
1333 @item MS_ASYNC
1335 This tells @code{msync} to begin the synchronization, but not to wait for
1336 it to complete.
1338 @c Linux also has MS_INVALIDATE, which I don't understand.
1340 @end vtable
1342 @code{msync} returns @math{0} for success and @math{-1} for
1343 error.  Errors include:
1345 @table @code
1347 @item EINVAL
1348 An invalid region was given, or the @var{flags} were invalid.
1350 @item EFAULT
1351 There is no existing mapping in at least part of the given region.
1353 @end table
1355 @end deftypefun
1357 @comment sys/mman.h
1358 @comment GNU
1359 @deftypefun {void *} mremap (void *@var{address}, size_t @var{length}, size_t @var{new_length}, int @var{flag})
1361 This function can be used to change the size of an existing memory
1362 area. @var{address} and @var{length} must cover a region entirely mapped
1363 in the same @code{mmap} statement. A new mapping with the same
1364 characteristics will be returned with the length @var{new_length}.
1366 One option is possible, @code{MREMAP_MAYMOVE}. If it is given in
1367 @var{flags}, the system may remove the existing mapping and create a new
1368 one of the desired length in another location.
1370 The address of the resulting mapping is returned, or @math{-1}. Possible
1371 error codes include:
1373 @table @code
1375 @item EFAULT
1376 There is no existing mapping in at least part of the original region, or
1377 the region covers two or more distinct mappings.
1379 @item EINVAL
1380 The address given is misaligned or inappropriate.
1382 @item EAGAIN
1383 The region has pages locked, and if extended it would exceed the
1384 process's resource limit for locked pages.  @xref{Limits on Resources}.
1386 @item ENOMEM
1387 The region is private writable, and insufficient virtual memory is
1388 available to extend it.  Also, this error will occur if
1389 @code{MREMAP_MAYMOVE} is not given and the extension would collide with
1390 another mapped region.
1392 @end table
1393 @end deftypefun
1395 This function is only available on a few systems.  Except for performing
1396 optional optimizations one should not rely on this function.
1398 Not all file descriptors may be mapped.  Sockets, pipes, and most devices
1399 only allow sequential access and do not fit into the mapping abstraction.
1400 In addition, some regular files may not be mmapable, and older kernels may
1401 not support mapping at all.  Thus, programs using @code{mmap} should
1402 have a fallback method to use should it fail. @xref{Mmap,,,standards,GNU
1403 Coding Standards}.
1405 @comment sys/mman.h
1406 @comment POSIX
1407 @deftypefun int madvise (void *@var{addr}, size_t @var{length}, int @var{advice})
1409 This function can be used to provide the system with @var{advice} about
1410 the intended usage patterns of the memory region starting at @var{addr}
1411 and extending @var{length} bytes.
1413 The valid BSD values for @var{advice} are:
1415 @table @code
1417 @item MADV_NORMAL
1418 The region should receive no further special treatment.
1420 @item MADV_RANDOM
1421 The region will be accessed via random page references. The kernel
1422 should page-in the minimal number of pages for each page fault.
1424 @item MADV_SEQUENTIAL
1425 The region will be accessed via sequential page references. This
1426 may cause the kernel to aggressively read-ahead, expecting further
1427 sequential references after any page fault within this region.
1429 @item MADV_WILLNEED
1430 The region will be needed.  The pages within this region may
1431 be pre-faulted in by the kernel.
1433 @item MADV_DONTNEED
1434 The region is no longer needed.  The kernel may free these pages,
1435 causing any changes to the pages to be lost, as well as swapped
1436 out pages to be discarded.
1438 @end table
1440 The POSIX names are slightly different, but with the same meanings:
1442 @table @code
1444 @item POSIX_MADV_NORMAL
1445 This corresponds with BSD's @code{MADV_NORMAL}.
1447 @item POSIX_MADV_RANDOM
1448 This corresponds with BSD's @code{MADV_RANDOM}.
1450 @item POSIX_MADV_SEQUENTIAL
1451 This corresponds with BSD's @code{MADV_SEQUENTIAL}.
1453 @item POSIX_MADV_WILLNEED
1454 This corresponds with BSD's @code{MADV_WILLNEED}.
1456 @item POSIX_MADV_DONTNEED
1457 This corresponds with BSD's @code{MADV_DONTNEED}.
1459 @end table
1461 @code{msync} returns @math{0} for success and @math{-1} for
1462 error.  Errors include:
1463 @table @code
1465 @item EINVAL
1466 An invalid region was given, or the @var{advice} was invalid.
1468 @item EFAULT
1469 There is no existing mapping in at least part of the given region.
1471 @end table
1472 @end deftypefun
1474 @node Waiting for I/O
1475 @section Waiting for Input or Output
1476 @cindex waiting for input or output
1477 @cindex multiplexing input
1478 @cindex input from multiple files
1480 Sometimes a program needs to accept input on multiple input channels
1481 whenever input arrives.  For example, some workstations may have devices
1482 such as a digitizing tablet, function button box, or dial box that are
1483 connected via normal asynchronous serial interfaces; good user interface
1484 style requires responding immediately to input on any device.  Another
1485 example is a program that acts as a server to several other processes
1486 via pipes or sockets.
1488 You cannot normally use @code{read} for this purpose, because this
1489 blocks the program until input is available on one particular file
1490 descriptor; input on other channels won't wake it up.  You could set
1491 nonblocking mode and poll each file descriptor in turn, but this is very
1492 inefficient.
1494 A better solution is to use the @code{select} function.  This blocks the
1495 program until input or output is ready on a specified set of file
1496 descriptors, or until a timer expires, whichever comes first.  This
1497 facility is declared in the header file @file{sys/types.h}.
1498 @pindex sys/types.h
1500 In the case of a server socket (@pxref{Listening}), we say that
1501 ``input'' is available when there are pending connections that could be
1502 accepted (@pxref{Accepting Connections}).  @code{accept} for server
1503 sockets blocks and interacts with @code{select} just as @code{read} does
1504 for normal input.
1506 @cindex file descriptor sets, for @code{select}
1507 The file descriptor sets for the @code{select} function are specified
1508 as @code{fd_set} objects.  Here is the description of the data type
1509 and some macros for manipulating these objects.
1511 @comment sys/types.h
1512 @comment BSD
1513 @deftp {Data Type} fd_set
1514 The @code{fd_set} data type represents file descriptor sets for the
1515 @code{select} function.  It is actually a bit array.
1516 @end deftp
1518 @comment sys/types.h
1519 @comment BSD
1520 @deftypevr Macro int FD_SETSIZE
1521 The value of this macro is the maximum number of file descriptors that a
1522 @code{fd_set} object can hold information about.  On systems with a
1523 fixed maximum number, @code{FD_SETSIZE} is at least that number.  On
1524 some systems, including GNU, there is no absolute limit on the number of
1525 descriptors open, but this macro still has a constant value which
1526 controls the number of bits in an @code{fd_set}; if you get a file
1527 descriptor with a value as high as @code{FD_SETSIZE}, you cannot put
1528 that descriptor into an @code{fd_set}.
1529 @end deftypevr
1531 @comment sys/types.h
1532 @comment BSD
1533 @deftypefn Macro void FD_ZERO (fd_set *@var{set})
1534 This macro initializes the file descriptor set @var{set} to be the
1535 empty set.
1536 @end deftypefn
1538 @comment sys/types.h
1539 @comment BSD
1540 @deftypefn Macro void FD_SET (int @var{filedes}, fd_set *@var{set})
1541 This macro adds @var{filedes} to the file descriptor set @var{set}.
1542 @end deftypefn
1544 @comment sys/types.h
1545 @comment BSD
1546 @deftypefn Macro void FD_CLR (int @var{filedes}, fd_set *@var{set})
1547 This macro removes @var{filedes} from the file descriptor set @var{set}.
1548 @end deftypefn
1550 @comment sys/types.h
1551 @comment BSD
1552 @deftypefn Macro int FD_ISSET (int @var{filedes}, fd_set *@var{set})
1553 This macro returns a nonzero value (true) if @var{filedes} is a member
1554 of the file descriptor set @var{set}, and zero (false) otherwise.
1555 @end deftypefn
1557 Next, here is the description of the @code{select} function itself.
1559 @comment sys/types.h
1560 @comment BSD
1561 @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})
1562 The @code{select} function blocks the calling process until there is
1563 activity on any of the specified sets of file descriptors, or until the
1564 timeout period has expired.
1566 The file descriptors specified by the @var{read-fds} argument are
1567 checked to see if they are ready for reading; the @var{write-fds} file
1568 descriptors are checked to see if they are ready for writing; and the
1569 @var{except-fds} file descriptors are checked for exceptional
1570 conditions.  You can pass a null pointer for any of these arguments if
1571 you are not interested in checking for that kind of condition.
1573 A file descriptor is considered ready for reading if it is not at end of
1574 file.  A server socket is considered ready for reading if there is a
1575 pending connection which can be accepted with @code{accept};
1576 @pxref{Accepting Connections}.  A client socket is ready for writing when
1577 its connection is fully established; @pxref{Connecting}.
1579 ``Exceptional conditions'' does not mean errors---errors are reported
1580 immediately when an erroneous system call is executed, and do not
1581 constitute a state of the descriptor.  Rather, they include conditions
1582 such as the presence of an urgent message on a socket.  (@xref{Sockets},
1583 for information on urgent messages.)
1585 The @code{select} function checks only the first @var{nfds} file
1586 descriptors.  The usual thing is to pass @code{FD_SETSIZE} as the value
1587 of this argument.
1589 The @var{timeout} specifies the maximum time to wait.  If you pass a
1590 null pointer for this argument, it means to block indefinitely until one
1591 of the file descriptors is ready.  Otherwise, you should provide the
1592 time in @code{struct timeval} format; see @ref{High-Resolution
1593 Calendar}.  Specify zero as the time (a @code{struct timeval} containing
1594 all zeros) if you want to find out which descriptors are ready without
1595 waiting if none are ready.
1597 The normal return value from @code{select} is the total number of ready file
1598 descriptors in all of the sets.  Each of the argument sets is overwritten
1599 with information about the descriptors that are ready for the corresponding
1600 operation.  Thus, to see if a particular descriptor @var{desc} has input,
1601 use @code{FD_ISSET (@var{desc}, @var{read-fds})} after @code{select} returns.
1603 If @code{select} returns because the timeout period expires, it returns
1604 a value of zero.
1606 Any signal will cause @code{select} to return immediately.  So if your
1607 program uses signals, you can't rely on @code{select} to keep waiting
1608 for the full time specified.  If you want to be sure of waiting for a
1609 particular amount of time, you must check for @code{EINTR} and repeat
1610 the @code{select} with a newly calculated timeout based on the current
1611 time.  See the example below.  See also @ref{Interrupted Primitives}.
1613 If an error occurs, @code{select} returns @code{-1} and does not modify
1614 the argument file descriptor sets.  The following @code{errno} error
1615 conditions are defined for this function:
1617 @table @code
1618 @item EBADF
1619 One of the file descriptor sets specified an invalid file descriptor.
1621 @item EINTR
1622 The operation was interrupted by a signal.  @xref{Interrupted Primitives}.
1624 @item EINVAL
1625 The @var{timeout} argument is invalid; one of the components is negative
1626 or too large.
1627 @end table
1628 @end deftypefun
1630 @strong{Portability Note:}  The @code{select} function is a BSD Unix
1631 feature.
1633 Here is an example showing how you can use @code{select} to establish a
1634 timeout period for reading from a file descriptor.  The @code{input_timeout}
1635 function blocks the calling process until input is available on the
1636 file descriptor, or until the timeout period expires.
1638 @smallexample
1639 @include select.c.texi
1640 @end smallexample
1642 There is another example showing the use of @code{select} to multiplex
1643 input from multiple sockets in @ref{Server Example}.
1646 @node Synchronizing I/O
1647 @section Synchronizing I/O operations
1649 @cindex synchronizing
1650 In most modern operating systems, the normal I/O operations are not
1651 executed synchronously.  I.e., even if a @code{write} system call
1652 returns, this does not mean the data is actually written to the media,
1653 e.g., the disk.
1655 In situations where synchronization points are necessary, you can use
1656 special functions which ensure that all operations finish before
1657 they return.
1659 @comment unistd.h
1660 @comment X/Open
1661 @deftypefun int sync (void)
1662 A call to this function will not return as long as there is data which
1663 has not been written to the device.  All dirty buffers in the kernel will
1664 be written and so an overall consistent system can be achieved (if no
1665 other process in parallel writes data).
1667 A prototype for @code{sync} can be found in @file{unistd.h}.
1669 The return value is zero to indicate no error.
1670 @end deftypefun
1672 Programs more often want to ensure that data written to a given file is
1673 committed, rather than all data in the system.  For this, @code{sync} is overkill.
1676 @comment unistd.h
1677 @comment POSIX
1678 @deftypefun int fsync (int @var{fildes})
1679 The @code{fsync} function can be used to make sure all data associated with
1680 the open file @var{fildes} is written to the device associated with the
1681 descriptor.  The function call does not return unless all actions have
1682 finished.
1684 A prototype for @code{fsync} can be found in @file{unistd.h}.
1686 This function is a cancellation point in multi-threaded programs.  This
1687 is a problem if the thread allocates some resources (like memory, file
1688 descriptors, semaphores or whatever) at the time @code{fsync} is
1689 called.  If the thread gets canceled these resources stay allocated
1690 until the program ends.  To avoid this, calls to @code{fsync} should be
1691 protected using cancellation handlers.
1692 @c ref pthread_cleanup_push / pthread_cleanup_pop
1694 The return value of the function is zero if no error occurred.  Otherwise
1695 it is @math{-1} and the global variable @var{errno} is set to the
1696 following values:
1697 @table @code
1698 @item EBADF
1699 The descriptor @var{fildes} is not valid.
1701 @item EINVAL
1702 No synchronization is possible since the system does not implement this.
1703 @end table
1704 @end deftypefun
1706 Sometimes it is not even necessary to write all data associated with a
1707 file descriptor.  E.g., in database files which do not change in size it
1708 is enough to write all the file content data to the device.
1709 Meta-information, like the modification time etc., are not that important
1710 and leaving such information uncommitted does not prevent a successful
1711 recovering of the file in case of a problem.
1713 @comment unistd.h
1714 @comment POSIX
1715 @deftypefun int fdatasync (int @var{fildes})
1716 When a call to the @code{fdatasync} function returns, it is ensured
1717 that all of the file data is written to the device.  For all pending I/O
1718 operations, the parts guaranteeing data integrity finished.
1720 Not all systems implement the @code{fdatasync} operation.  On systems
1721 missing this functionality @code{fdatasync} is emulated by a call to
1722 @code{fsync} since the performed actions are a superset of those
1723 required by @code{fdatasync}.
1725 The prototype for @code{fdatasync} is in @file{unistd.h}.
1727 The return value of the function is zero if no error occurred.  Otherwise
1728 it is @math{-1} and the global variable @var{errno} is set to the
1729 following values:
1730 @table @code
1731 @item EBADF
1732 The descriptor @var{fildes} is not valid.
1734 @item EINVAL
1735 No synchronization is possible since the system does not implement this.
1736 @end table
1737 @end deftypefun
1740 @node Asynchronous I/O
1741 @section Perform I/O Operations in Parallel
1743 The POSIX.1b standard defines a new set of I/O operations which can
1744 significantly reduce the time an application spends waiting at I/O.  The
1745 new functions allow a program to initiate one or more I/O operations and
1746 then immediately resume normal work while the I/O operations are
1747 executed in parallel.  This functionality is available if the
1748 @file{unistd.h} file defines the symbol @code{_POSIX_ASYNCHRONOUS_IO}.
1750 These functions are part of the library with realtime functions named
1751 @file{librt}.  They are not actually part of the @file{libc} binary.
1752 The implementation of these functions can be done using support in the
1753 kernel (if available) or using an implementation based on threads at
1754 userlevel.  In the latter case it might be necessary to link applications
1755 with the thread library @file{libpthread} in addition to @file{librt}.
1757 All AIO operations operate on files which were opened previously.  There
1758 might be arbitrarily many operations running for one file.  The
1759 asynchronous I/O operations are controlled using a data structure named
1760 @code{struct aiocb} (@dfn{AIO control block}).  It is defined in
1761 @file{aio.h} as follows.
1763 @comment aio.h
1764 @comment POSIX.1b
1765 @deftp {Data Type} {struct aiocb}
1766 The POSIX.1b standard mandates that the @code{struct aiocb} structure
1767 contains at least the members described in the following table.  There
1768 might be more elements which are used by the implementation, but
1769 depending upon these elements is not portable and is highly deprecated.
1771 @table @code
1772 @item int aio_fildes
1773 This element specifies the file descriptor to be used for the
1774 operation.  It must be a legal descriptor, otherwise the operation will
1775 fail.
1777 The device on which the file is opened must allow the seek operation.
1778 I.e., it is not possible to use any of the AIO operations on devices
1779 like terminals where an @code{lseek} call would lead to an error.
1781 @item off_t aio_offset
1782 This element specifies the offset in the file at which the operation (input
1783 or output) is performed.  Since the operations are carried out in arbitrary
1784 order and more than one operation for one file descriptor can be
1785 started, one cannot expect a current read/write position of the file
1786 descriptor.
1788 @item volatile void *aio_buf
1789 This is a pointer to the buffer with the data to be written or the place
1790 where the read data is stored.
1792 @item size_t aio_nbytes
1793 This element specifies the length of the buffer pointed to by @code{aio_buf}.
1795 @item int aio_reqprio
1796 If the platform has defined @code{_POSIX_PRIORITIZED_IO} and
1797 @code{_POSIX_PRIORITY_SCHEDULING}, the AIO requests are
1798 processed based on the current scheduling priority.  The
1799 @code{aio_reqprio} element can then be used to lower the priority of the
1800 AIO operation.
1802 @item struct sigevent aio_sigevent
1803 This element specifies how the calling process is notified once the
1804 operation terminates.  If the @code{sigev_notify} element is
1805 @code{SIGEV_NONE}, no notification is sent.  If it is @code{SIGEV_SIGNAL},
1806 the signal determined by @code{sigev_signo} is sent.  Otherwise,
1807 @code{sigev_notify} must be @code{SIGEV_THREAD}.  In this case, a thread
1808 is created which starts executing the function pointed to by
1809 @code{sigev_notify_function}.
1811 @item int aio_lio_opcode
1812 This element is only used by the @code{lio_listio} and
1813 @code{lio_listio64} functions.  Since these functions allow an
1814 arbitrary number of operations to start at once, and each operation can be
1815 input or output (or nothing), the information must be stored in the
1816 control block.  The possible values are:
1818 @vtable @code
1819 @item LIO_READ
1820 Start a read operation.  Read from the file at position
1821 @code{aio_offset} and store the next @code{aio_nbytes} bytes in the
1822 buffer pointed to by @code{aio_buf}.
1824 @item LIO_WRITE
1825 Start a write operation.  Write @code{aio_nbytes} bytes starting at
1826 @code{aio_buf} into the file starting at position @code{aio_offset}.
1828 @item LIO_NOP
1829 Do nothing for this control block.  This value is useful sometimes when
1830 an array of @code{struct aiocb} values contains holes, i.e., some of the
1831 values must not be handled although the whole array is presented to the
1832 @code{lio_listio} function.
1833 @end vtable
1834 @end table
1836 When the sources are compiled using @code{_FILE_OFFSET_BITS == 64} on a
1837 32 bit machine, this type is in fact @code{struct aiocb64}, since the LFS
1838 interface transparently replaces the @code{struct aiocb} definition.
1839 @end deftp
1841 For use with the AIO functions defined in the LFS, there is a similar type
1842 defined which replaces the types of the appropriate members with larger
1843 types but otherwise is equivalent to @code{struct aiocb}.  Particularly,
1844 all member names are the same.
1846 @comment aio.h
1847 @comment POSIX.1b
1848 @deftp {Data Type} {struct aiocb64}
1849 @table @code
1850 @item int aio_fildes
1851 This element specifies the file descriptor which is used for the
1852 operation.  It must be a legal descriptor since otherwise the operation
1853 fails for obvious reasons.
1855 The device on which the file is opened must allow the seek operation.
1856 I.e., it is not possible to use any of the AIO operations on devices
1857 like terminals where an @code{lseek} call would lead to an error.
1859 @item off64_t aio_offset
1860 This element specifies at which offset in the file the operation (input
1861 or output) is performed.  Since the operation are carried in arbitrary
1862 order and more than one operation for one file descriptor can be
1863 started, one cannot expect a current read/write position of the file
1864 descriptor.
1866 @item volatile void *aio_buf
1867 This is a pointer to the buffer with the data to be written or the place
1868 where the read data is stored.
1870 @item size_t aio_nbytes
1871 This element specifies the length of the buffer pointed to by @code{aio_buf}.
1873 @item int aio_reqprio
1874 If for the platform @code{_POSIX_PRIORITIZED_IO} and
1875 @code{_POSIX_PRIORITY_SCHEDULING} are defined the AIO requests are
1876 processed based on the current scheduling priority.  The
1877 @code{aio_reqprio} element can then be used to lower the priority of the
1878 AIO operation.
1880 @item struct sigevent aio_sigevent
1881 This element specifies how the calling process is notified once the
1882 operation terminates.  If the @code{sigev_notify}, element is
1883 @code{SIGEV_NONE} no notification is sent.  If it is @code{SIGEV_SIGNAL},
1884 the signal determined by @code{sigev_signo} is sent.  Otherwise,
1885 @code{sigev_notify} must be @code{SIGEV_THREAD} in which case a thread
1886 which starts executing the function pointed to by
1887 @code{sigev_notify_function}.
1889 @item int aio_lio_opcode
1890 This element is only used by the @code{lio_listio} and
1891 @code{[lio_listio64} functions.  Since these functions allow an
1892 arbitrary number of operations to start at once, and since each operation can be
1893 input or output (or nothing), the information must be stored in the
1894 control block.  See the description of @code{struct aiocb} for a description
1895 of the possible values.
1896 @end table
1898 When the sources are compiled using @code{_FILE_OFFSET_BITS == 64} on a
1899 32 bit machine, this type is available under the name @code{struct
1900 aiocb64}, since the LFS transparently replaces the old interface.
1901 @end deftp
1903 @menu
1904 * Asynchronous Reads/Writes::    Asynchronous Read and Write Operations.
1905 * Status of AIO Operations::     Getting the Status of AIO Operations.
1906 * Synchronizing AIO Operations:: Getting into a consistent state.
1907 * Cancel AIO Operations::        Cancellation of AIO Operations.
1908 * Configuration of AIO::         How to optimize the AIO implementation.
1909 @end menu
1911 @node Asynchronous Reads/Writes
1912 @subsection Asynchronous Read and Write Operations
1914 @comment aio.h
1915 @comment POSIX.1b
1916 @deftypefun int aio_read (struct aiocb *@var{aiocbp})
1917 This function initiates an asynchronous read operation.  It
1918 immediately returns after the operation was enqueued or when an
1919 error was encountered.
1921 The first @code{aiocbp->aio_nbytes} bytes of the file for which
1922 @code{aiocbp->aio_fildes} is a descriptor are written to the buffer
1923 starting at @code{aiocbp->aio_buf}.  Reading starts at the absolute
1924 position @code{aiocbp->aio_offset} in the file.
1926 If prioritized I/O is supported by the platform the
1927 @code{aiocbp->aio_reqprio} value is used to adjust the priority before
1928 the request is actually enqueued.
1930 The calling process is notified about the termination of the read
1931 request according to the @code{aiocbp->aio_sigevent} value.
1933 When @code{aio_read} returns, the return value is zero if no error
1934 occurred that can be found before the process is enqueued.  If such an
1935 early error is found, the function returns @math{-1} and sets
1936 @code{errno} to one of the following values:
1938 @table @code
1939 @item EAGAIN
1940 The request was not enqueued due to (temporarily) exceeded resource
1941 limitations.
1942 @item ENOSYS
1943 The @code{aio_read} function is not implemented.
1944 @item EBADF
1945 The @code{aiocbp->aio_fildes} descriptor is not valid.  This condition
1946 need not be recognized before enqueueing the request and so this error
1947 might also be signaled asynchronously.
1948 @item EINVAL
1949 The @code{aiocbp->aio_offset} or @code{aiocbp->aio_reqpiro} value is
1950 invalid.  This condition need not be recognized before enqueueing the
1951 request and so this error might also be signaled asynchronously.
1952 @end table
1954 If @code{aio_read} returns zero, the current status of the request
1955 can be queried using @code{aio_error} and @code{aio_return} functions.
1956 As long as the value returned by @code{aio_error} is @code{EINPROGRESS}
1957 the operation has not yet completed.  If @code{aio_error} returns zero,
1958 the operation successfully terminated, otherwise the value is to be
1959 interpreted as an error code.  If the function terminated, the result of
1960 the operation can be obtained using a call to @code{aio_return}.  The
1961 returned value is the same as an equivalent call to @code{read} would
1962 have returned.  Possible error codes returned by @code{aio_error} are:
1964 @table @code
1965 @item EBADF
1966 The @code{aiocbp->aio_fildes} descriptor is not valid.
1967 @item ECANCELED
1968 The operation was canceled before the operation was finished
1969 (@pxref{Cancel AIO Operations})
1970 @item EINVAL
1971 The @code{aiocbp->aio_offset} value is invalid.
1972 @end table
1974 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
1975 function is in fact @code{aio_read64} since the LFS interface transparently
1976 replaces the normal implementation.
1977 @end deftypefun
1979 @comment aio.h
1980 @comment Unix98
1981 @deftypefun int aio_read64 (struct aiocb *@var{aiocbp})
1982 This function is similar to the @code{aio_read} function.  The only
1983 difference is that on @w{32 bit} machines, the file descriptor should
1984 be opened in the large file mode.  Internally, @code{aio_read64} uses
1985 functionality equivalent to @code{lseek64} (@pxref{File Position
1986 Primitive}) to position the file descriptor correctly for the reading,
1987 as opposed to @code{lseek} functionality used in @code{aio_read}.
1989 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this
1990 function is available under the name @code{aio_read} and so transparently
1991 replaces the interface for small files on 32 bit machines.
1992 @end deftypefun
1994 To write data asynchronously to a file, there exists an equivalent pair
1995 of functions with a very similar interface.
1997 @comment aio.h
1998 @comment POSIX.1b
1999 @deftypefun int aio_write (struct aiocb *@var{aiocbp})
2000 This function initiates an asynchronous write operation.  The function
2001 call immediately returns after the operation was enqueued or if before
2002 this happens an error was encountered.
2004 The first @code{aiocbp->aio_nbytes} bytes from the buffer starting at
2005 @code{aiocbp->aio_buf} are written to the file for which
2006 @code{aiocbp->aio_fildes} is an descriptor, starting at the absolute
2007 position @code{aiocbp->aio_offset} in the file.
2009 If prioritized I/O is supported by the platform, the
2010 @code{aiocbp->aio_reqprio} value is used to adjust the priority before
2011 the request is actually enqueued.
2013 The calling process is notified about the termination of the read
2014 request according to the @code{aiocbp->aio_sigevent} value.
2016 When @code{aio_write} returns, the return value is zero if no error
2017 occurred that can be found before the process is enqueued.  If such an
2018 early error is found the function returns @math{-1} and sets
2019 @code{errno} to one of the following values.
2021 @table @code
2022 @item EAGAIN
2023 The request was not enqueued due to (temporarily) exceeded resource
2024 limitations.
2025 @item ENOSYS
2026 The @code{aio_write} function is not implemented.
2027 @item EBADF
2028 The @code{aiocbp->aio_fildes} descriptor is not valid.  This condition
2029 may not be recognized before enqueueing the request, and so this error
2030 might also be signaled asynchronously.
2031 @item EINVAL
2032 The @code{aiocbp->aio_offset} or @code{aiocbp->aio_reqprio} value is
2033 invalid.  This condition may not be recognized before enqueueing the
2034 request and so this error might also be signaled asynchronously.
2035 @end table
2037 In the case @code{aio_write} returns zero, the current status of the
2038 request can be queried using @code{aio_error} and @code{aio_return}
2039 functions.  As long as the value returned by @code{aio_error} is
2040 @code{EINPROGRESS} the operation has not yet completed.  If
2041 @code{aio_error} returns zero, the operation successfully terminated,
2042 otherwise the value is to be interpreted as an error code.  If the
2043 function terminated, the result of the operation can be get using a call
2044 to @code{aio_return}.  The returned value is the same as an equivalent
2045 call to @code{read} would have returned.  Possible error codes returned
2046 by @code{aio_error} are:
2048 @table @code
2049 @item EBADF
2050 The @code{aiocbp->aio_fildes} descriptor is not valid.
2051 @item ECANCELED
2052 The operation was canceled before the operation was finished.
2053 (@pxref{Cancel AIO Operations})
2054 @item EINVAL
2055 The @code{aiocbp->aio_offset} value is invalid.
2056 @end table
2058 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this
2059 function is in fact @code{aio_write64} since the LFS interface transparently
2060 replaces the normal implementation.
2061 @end deftypefun
2063 @comment aio.h
2064 @comment Unix98
2065 @deftypefun int aio_write64 (struct aiocb *@var{aiocbp})
2066 This function is similar to the @code{aio_write} function.  The only
2067 difference is that on @w{32 bit} machines the file descriptor should
2068 be opened in the large file mode.  Internally @code{aio_write64} uses
2069 functionality equivalent to @code{lseek64} (@pxref{File Position
2070 Primitive}) to position the file descriptor correctly for the writing,
2071 as opposed to @code{lseek} functionality used in @code{aio_write}.
2073 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this
2074 function is available under the name @code{aio_write} and so transparently
2075 replaces the interface for small files on 32 bit machines.
2076 @end deftypefun
2078 Besides these functions with the more or less traditional interface,
2079 POSIX.1b also defines a function which can initiate more than one
2080 operation at a time, and which can handle freely mixed read and write
2081 operations.  It is therefore similar to a combination of @code{readv} and
2082 @code{writev}.
2084 @comment aio.h
2085 @comment POSIX.1b
2086 @deftypefun int lio_listio (int @var{mode}, struct aiocb *const @var{list}[], int @var{nent}, struct sigevent *@var{sig})
2087 The @code{lio_listio} function can be used to enqueue an arbitrary
2088 number of read and write requests at one time.  The requests can all be
2089 meant for the same file, all for different files or every solution in
2090 between.
2092 @code{lio_listio} gets the @var{nent} requests from the array pointed to
2093 by @var{list}.  The operation to be performed is determined by the
2094 @code{aio_lio_opcode} member in each element of @var{list}.  If this
2095 field is @code{LIO_READ} a read operation is enqueued, similar to a call
2096 of @code{aio_read} for this element of the array (except that the way
2097 the termination is signalled is different, as we will see below).  If
2098 the @code{aio_lio_opcode} member is @code{LIO_WRITE} a write operation
2099 is enqueued.  Otherwise the @code{aio_lio_opcode} must be @code{LIO_NOP}
2100 in which case this element of @var{list} is simply ignored.  This
2101 ``operation'' is useful in situations where one has a fixed array of
2102 @code{struct aiocb} elements from which only a few need to be handled at
2103 a time.  Another situation is where the @code{lio_listio} call was
2104 canceled before all requests are processed (@pxref{Cancel AIO
2105 Operations}) and the remaining requests have to be reissued.
2107 The other members of each element of the array pointed to by
2108 @code{list} must have values suitable for the operation as described in
2109 the documentation for @code{aio_read} and @code{aio_write} above.
2111 The @var{mode} argument determines how @code{lio_listio} behaves after
2112 having enqueued all the requests.  If @var{mode} is @code{LIO_WAIT} it
2113 waits until all requests terminated.  Otherwise @var{mode} must be
2114 @code{LIO_NOWAIT} and in this case the function returns immediately after
2115 having enqueued all the requests.  In this case the caller gets a
2116 notification of the termination of all requests according to the
2117 @var{sig} parameter.  If @var{sig} is @code{NULL} no notification is
2118 send.  Otherwise a signal is sent or a thread is started, just as
2119 described in the description for @code{aio_read} or @code{aio_write}.
2121 If @var{mode} is @code{LIO_WAIT}, the return value of @code{lio_listio}
2122 is @math{0} when all requests completed successfully.  Otherwise the
2123 function return @math{-1} and @code{errno} is set accordingly.  To find
2124 out which request or requests failed one has to use the @code{aio_error}
2125 function on all the elements of the array @var{list}.
2127 In case @var{mode} is @code{LIO_NOWAIT}, the function returns @math{0} if
2128 all requests were enqueued correctly.  The current state of the requests
2129 can be found using @code{aio_error} and @code{aio_return} as described
2130 above.  If @code{lio_listio} returns @math{-1} in this mode, the
2131 global variable @code{errno} is set accordingly.  If a request did not
2132 yet terminate, a call to @code{aio_error} returns @code{EINPROGRESS}.  If
2133 the value is different, the request is finished and the error value (or
2134 @math{0}) is returned and the result of the operation can be retrieved
2135 using @code{aio_return}.
2137 Possible values for @code{errno} are:
2139 @table @code
2140 @item EAGAIN
2141 The resources necessary to queue all the requests are not available at
2142 the moment.  The error status for each element of @var{list} must be
2143 checked to determine which request failed.
2145 Another reason could be that the system wide limit of AIO requests is
2146 exceeded.  This cannot be the case for the implementation on GNU systems
2147 since no arbitrary limits exist.
2148 @item EINVAL
2149 The @var{mode} parameter is invalid or @var{nent} is larger than
2150 @code{AIO_LISTIO_MAX}.
2151 @item EIO
2152 One or more of the request's I/O operations failed.  The error status of
2153 each request should be checked to determine which one failed.
2154 @item ENOSYS
2155 The @code{lio_listio} function is not supported.
2156 @end table
2158 If the @var{mode} parameter is @code{LIO_NOWAIT} and the caller cancels
2159 a request, the error status for this request returned by
2160 @code{aio_error} is @code{ECANCELED}.
2162 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this
2163 function is in fact @code{lio_listio64} since the LFS interface
2164 transparently replaces the normal implementation.
2165 @end deftypefun
2167 @comment aio.h
2168 @comment Unix98
2169 @deftypefun int lio_listio64 (int @var{mode}, struct aiocb *const @var{list}, int @var{nent}, struct sigevent *@var{sig})
2170 This function is similar to the @code{lio_listio} function.  The only
2171 difference is that on @w{32 bit} machines, the file descriptor should
2172 be opened in the large file mode.  Internally, @code{lio_listio64} uses
2173 functionality equivalent to @code{lseek64} (@pxref{File Position
2174 Primitive}) to position the file descriptor correctly for the reading or
2175 writing, as opposed to @code{lseek} functionality used in
2176 @code{lio_listio}.
2178 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this
2179 function is available under the name @code{lio_listio} and so
2180 transparently replaces the interface for small files on 32 bit
2181 machines.
2182 @end deftypefun
2184 @node Status of AIO Operations
2185 @subsection Getting the Status of AIO Operations
2187 As already described in the documentation of the functions in the last
2188 section, it must be possible to get information about the status of an I/O
2189 request.  When the operation is performed truly asynchronously (as with
2190 @code{aio_read} and @code{aio_write} and with @code{lio_listio} when the
2191 mode is @code{LIO_NOWAIT}), one sometimes needs to know whether a
2192 specific request already terminated and if so, what the result was.
2193 The following two functions allow you to get this kind of information.
2195 @comment aio.h
2196 @comment POSIX.1b
2197 @deftypefun int aio_error (const struct aiocb *@var{aiocbp})
2198 This function determines the error state of the request described by the
2199 @code{struct aiocb} variable pointed to by @var{aiocbp}.  If the
2200 request has not yet terminated the value returned is always
2201 @code{EINPROGRESS}.  Once the request has terminated the value
2202 @code{aio_error} returns is either @math{0} if the request completed
2203 successfully or it returns the value which would be stored in the
2204 @code{errno} variable if the request would have been done using
2205 @code{read}, @code{write}, or @code{fsync}.
2207 The function can return @code{ENOSYS} if it is not implemented.  It
2208 could also return @code{EINVAL} if the @var{aiocbp} parameter does not
2209 refer to an asynchronous operation whose return status is not yet known.
2211 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2212 function is in fact @code{aio_error64} since the LFS interface
2213 transparently replaces the normal implementation.
2214 @end deftypefun
2216 @comment aio.h
2217 @comment Unix98
2218 @deftypefun int aio_error64 (const struct aiocb64 *@var{aiocbp})
2219 This function is similar to @code{aio_error} with the only difference
2220 that the argument is a reference to a variable of type @code{struct
2221 aiocb64}.
2223 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2224 function is available under the name @code{aio_error} and so
2225 transparently replaces the interface for small files on 32 bit
2226 machines.
2227 @end deftypefun
2229 @comment aio.h
2230 @comment POSIX.1b
2231 @deftypefun ssize_t aio_return (const struct aiocb *@var{aiocbp})
2232 This function can be used to retrieve the return status of the operation
2233 carried out by the request described in the variable pointed to by
2234 @var{aiocbp}.  As long as the error status of this request as returned
2235 by @code{aio_error} is @code{EINPROGRESS} the return of this function is
2236 undefined.
2238 Once the request is finished this function can be used exactly once to
2239 retrieve the return value.  Following calls might lead to undefined
2240 behavior.  The return value itself is the value which would have been
2241 returned by the @code{read}, @code{write}, or @code{fsync} call.
2243 The function can return @code{ENOSYS} if it is not implemented.  It
2244 could also return @code{EINVAL} if the @var{aiocbp} parameter does not
2245 refer to an asynchronous operation whose return status is not yet known.
2247 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2248 function is in fact @code{aio_return64} since the LFS interface
2249 transparently replaces the normal implementation.
2250 @end deftypefun
2252 @comment aio.h
2253 @comment Unix98
2254 @deftypefun int aio_return64 (const struct aiocb64 *@var{aiocbp})
2255 This function is similar to @code{aio_return} with the only difference
2256 that the argument is a reference to a variable of type @code{struct
2257 aiocb64}.
2259 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2260 function is available under the name @code{aio_return} and so
2261 transparently replaces the interface for small files on 32 bit
2262 machines.
2263 @end deftypefun
2265 @node Synchronizing AIO Operations
2266 @subsection Getting into a Consistent State
2268 When dealing with asynchronous operations it is sometimes necessary to
2269 get into a consistent state.  This would mean for AIO that one wants to
2270 know whether a certain request or a group of request were processed.
2271 This could be done by waiting for the notification sent by the system
2272 after the operation terminated, but this sometimes would mean wasting
2273 resources (mainly computation time).  Instead POSIX.1b defines two
2274 functions which will help with most kinds of consistency.
2276 The @code{aio_fsync} and @code{aio_fsync64} functions are only available
2277 if the symbol @code{_POSIX_SYNCHRONIZED_IO} is defined in @file{unistd.h}.
2279 @cindex synchronizing
2280 @comment aio.h
2281 @comment POSIX.1b
2282 @deftypefun int aio_fsync (int @var{op}, struct aiocb *@var{aiocbp})
2283 Calling this function forces all I/O operations operating queued at the
2284 time of the function call operating on the file descriptor
2285 @code{aiocbp->aio_fildes} into the synchronized I/O completion state
2286 (@pxref{Synchronizing I/O}).  The @code{aio_fsync} function returns
2287 immediately but the notification through the method described in
2288 @code{aiocbp->aio_sigevent} will happen only after all requests for this
2289 file descriptor have terminated and the file is synchronized.  This also
2290 means that requests for this very same file descriptor which are queued
2291 after the synchronization request are not affected.
2293 If @var{op} is @code{O_DSYNC} the synchronization happens as with a call
2294 to @code{fdatasync}.  Otherwise @var{op} should be @code{O_SYNC} and
2295 the synchronization happens as with @code{fsync}.
2297 As long as the synchronization has not happened, a call to
2298 @code{aio_error} with the reference to the object pointed to by
2299 @var{aiocbp} returns @code{EINPROGRESS}.  Once the synchronization is
2300 done @code{aio_error} return @math{0} if the synchronization was not
2301 successful.  Otherwise the value returned is the value to which the
2302 @code{fsync} or @code{fdatasync} function would have set the
2303 @code{errno} variable.  In this case nothing can be assumed about the
2304 consistency for the data written to this file descriptor.
2306 The return value of this function is @math{0} if the request was
2307 successfully enqueued.  Otherwise the return value is @math{-1} and
2308 @code{errno} is set to one of the following values:
2310 @table @code
2311 @item EAGAIN
2312 The request could not be enqueued due to temporary lack of resources.
2313 @item EBADF
2314 The file descriptor @code{aiocbp->aio_fildes} is not valid or not open
2315 for writing.
2316 @item EINVAL
2317 The implementation does not support I/O synchronization or the @var{op}
2318 parameter is other than @code{O_DSYNC} and @code{O_SYNC}.
2319 @item ENOSYS
2320 This function is not implemented.
2321 @end table
2323 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2324 function is in fact @code{aio_return64} since the LFS interface
2325 transparently replaces the normal implementation.
2326 @end deftypefun
2328 @comment aio.h
2329 @comment Unix98
2330 @deftypefun int aio_fsync64 (int @var{op}, struct aiocb64 *@var{aiocbp})
2331 This function is similar to @code{aio_fsync} with the only difference
2332 that the argument is a reference to a variable of type @code{struct
2333 aiocb64}.
2335 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2336 function is available under the name @code{aio_fsync} and so
2337 transparently replaces the interface for small files on 32 bit
2338 machines.
2339 @end deftypefun
2341 Another method of synchronization is to wait until one or more requests of a
2342 specific set terminated.  This could be achieved by the @code{aio_*}
2343 functions to notify the initiating process about the termination but in
2344 some situations this is not the ideal solution.  In a program which
2345 constantly updates clients somehow connected to the server it is not
2346 always the best solution to go round robin since some connections might
2347 be slow.  On the other hand letting the @code{aio_*} function notify the
2348 caller might also be not the best solution since whenever the process
2349 works on preparing data for on client it makes no sense to be
2350 interrupted by a notification since the new client will not be handled
2351 before the current client is served.  For situations like this
2352 @code{aio_suspend} should be used.
2354 @comment aio.h
2355 @comment POSIX.1b
2356 @deftypefun int aio_suspend (const struct aiocb *const @var{list}[], int @var{nent}, const struct timespec *@var{timeout})
2357 When calling this function, the calling thread is suspended until at
2358 least one of the requests pointed to by the @var{nent} elements of the
2359 array @var{list} has completed.  If any of the requests has already
2360 completed at the time @code{aio_suspend} is called, the function returns
2361 immediately.  Whether a request has terminated or not is determined by
2362 comparing the error status of the request with @code{EINPROGRESS}.  If
2363 an element of @var{list} is @code{NULL}, the entry is simply ignored.
2365 If no request has finished, the calling process is suspended.  If
2366 @var{timeout} is @code{NULL}, the process is not woken until a request
2367 has finished.  If @var{timeout} is not @code{NULL}, the process remains
2368 suspended at least as long as specified in @var{timeout}.  In this case,
2369 @code{aio_suspend} returns with an error.
2371 The return value of the function is @math{0} if one or more requests
2372 from the @var{list} have terminated.  Otherwise the function returns
2373 @math{-1} and @code{errno} is set to one of the following values:
2375 @table @code
2376 @item EAGAIN
2377 None of the requests from the @var{list} completed in the time specified
2378 by @var{timeout}.
2379 @item EINTR
2380 A signal interrupted the @code{aio_suspend} function.  This signal might
2381 also be sent by the AIO implementation while signalling the termination
2382 of one of the requests.
2383 @item ENOSYS
2384 The @code{aio_suspend} function is not implemented.
2385 @end table
2387 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2388 function is in fact @code{aio_suspend64} since the LFS interface
2389 transparently replaces the normal implementation.
2390 @end deftypefun
2392 @comment aio.h
2393 @comment Unix98
2394 @deftypefun int aio_suspend64 (const struct aiocb64 *const @var{list}[], int @var{nent}, const struct timespec *@var{timeout})
2395 This function is similar to @code{aio_suspend} with the only difference
2396 that the argument is a reference to a variable of type @code{struct
2397 aiocb64}.
2399 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2400 function is available under the name @code{aio_suspend} and so
2401 transparently replaces the interface for small files on 32 bit
2402 machines.
2403 @end deftypefun
2405 @node Cancel AIO Operations
2406 @subsection Cancellation of AIO Operations
2408 When one or more requests are asynchronously processed, it might be
2409 useful in some situations to cancel a selected operation, e.g., if it
2410 becomes obvious that the written data is no longer accurate and would
2411 have to be overwritten soon.  As an example, assume an application, which
2412 writes data in files in a situation where new incoming data would have
2413 to be written in a file which will be updated by an enqueued request.
2414 The POSIX AIO implementation provides such a function, but this function
2415 is not capable of forcing the cancellation of the request.  It is up to the
2416 implementation to decide whether it is possible to cancel the operation
2417 or not.  Therefore using this function is merely a hint.
2419 @comment aio.h
2420 @comment POSIX.1b
2421 @deftypefun int aio_cancel (int @var{fildes}, struct aiocb *@var{aiocbp})
2422 The @code{aio_cancel} function can be used to cancel one or more
2423 outstanding requests.  If the @var{aiocbp} parameter is @code{NULL}, the
2424 function tries to cancel all of the outstanding requests which would process
2425 the file descriptor @var{fildes} (i.e., whose @code{aio_fildes} member
2426 is @var{fildes}).  If @var{aiocbp} is not @code{NULL}, @code{aio_cancel}
2427 attempts to cancel the specific request pointed to by @var{aiocbp}.
2429 For requests which were successfully canceled, the normal notification
2430 about the termination of the request should take place.  I.e., depending
2431 on the @code{struct sigevent} object which controls this, nothing
2432 happens, a signal is sent or a thread is started.  If the request cannot
2433 be canceled, it terminates the usual way after performing the operation.
2435 After a request is successfully canceled, a call to @code{aio_error} with
2436 a reference to this request as the parameter will return
2437 @code{ECANCELED} and a call to @code{aio_return} will return @math{-1}.
2438 If the request wasn't canceled and is still running the error status is
2439 still @code{EINPROGRESS}.
2441 The return value of the function is @code{AIO_CANCELED} if there were
2442 requests which haven't terminated and which were successfully canceled.
2443 If there is one or more requests left which couldn't be canceled, the
2444 return value is @code{AIO_NOTCANCELED}.  In this case @code{aio_error}
2445 must be used to find out which of the, perhaps multiple, requests (in
2446 @var{aiocbp} is @code{NULL}) weren't successfully canceled.  If all
2447 requests already terminated at the time @code{aio_cancel} is called the
2448 return value is @code{AIO_ALLDONE}.
2450 If an error occurred during the execution of @code{aio_cancel} the
2451 function returns @math{-1} and sets @code{errno} to one of the following
2452 values.
2454 @table @code
2455 @item EBADF
2456 The file descriptor @var{fildes} is not valid.
2457 @item ENOSYS
2458 @code{aio_cancel} is not implemented.
2459 @end table
2461 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this
2462 function is in fact @code{aio_cancel64} since the LFS interface
2463 transparently replaces the normal implementation.
2464 @end deftypefun
2466 @comment aio.h
2467 @comment Unix98
2468 @deftypefun int aio_cancel64 (int @var{fildes}, struct aiocb64 *@var{aiocbp})
2469 This function is similar to @code{aio_cancel} with the only difference
2470 that the argument is a reference to a variable of type @code{struct
2471 aiocb64}.
2473 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64}, this
2474 function is available under the name @code{aio_cancel} and so
2475 transparently replaces the interface for small files on 32 bit
2476 machines.
2477 @end deftypefun
2479 @node Configuration of AIO
2480 @subsection How to optimize the AIO implementation
2482 The POSIX standard does not specify how the AIO functions are
2483 implemented.  They could be system calls, but it is also possible to
2484 emulate them at userlevel.
2486 At the point of this writing, the available implementation is a userlevel
2487 implementation which uses threads for handling the enqueued requests.
2488 While this implementation requires making some decisions about
2489 limitations, hard limitations are something which is best avoided
2490 in the GNU C library.  Therefore, the GNU C library provides a means
2491 for tuning the AIO implementation according to the individual use.
2493 @comment aio.h
2494 @comment GNU
2495 @deftp {Data Type} {struct aioinit}
2496 This data type is used to pass the configuration or tunable parameters
2497 to the implementation.  The program has to initialize the members of
2498 this struct and pass it to the implementation using the @code{aio_init}
2499 function.
2501 @table @code
2502 @item int aio_threads
2503 This member specifies the maximal number of threads which may be used
2504 at any one time.
2505 @item int aio_num
2506 This number provides an estimate on the maximal number of simultaneously
2507 enqueued requests.
2508 @item int aio_locks
2509 Unused.
2510 @item int aio_usedba
2511 Unused.
2512 @item int aio_debug
2513 Unused.
2514 @item int aio_numusers
2515 Unused.
2516 @item int aio_reserved[2]
2517 Unused.
2518 @end table
2519 @end deftp
2521 @comment aio.h
2522 @comment GNU
2523 @deftypefun void aio_init (const struct aioinit *@var{init})
2524 This function must be called before any other AIO function.  Calling it
2525 is completely voluntary, as it is only meant to help the AIO
2526 implementation perform better.
2528 Before calling the @code{aio_init}, function the members of a variable of
2529 type @code{struct aioinit} must be initialized.  Then a reference to
2530 this variable is passed as the parameter to @code{aio_init} which itself
2531 may or may not pay attention to the hints.
2533 The function has no return value and no error cases are defined.  It is
2534 a extension which follows a proposal from the SGI implementation in
2535 @w{Irix 6}.  It is not covered by POSIX.1b or Unix98.
2536 @end deftypefun
2538 @node Control Operations
2539 @section Control Operations on Files
2541 @cindex control operations on files
2542 @cindex @code{fcntl} function
2543 This section describes how you can perform various other operations on
2544 file descriptors, such as inquiring about or setting flags describing
2545 the status of the file descriptor, manipulating record locks, and the
2546 like.  All of these operations are performed by the function @code{fcntl}.
2548 The second argument to the @code{fcntl} function is a command that
2549 specifies which operation to perform.  The function and macros that name
2550 various flags that are used with it are declared in the header file
2551 @file{fcntl.h}.  Many of these flags are also used by the @code{open}
2552 function; see @ref{Opening and Closing Files}.
2553 @pindex fcntl.h
2555 @comment fcntl.h
2556 @comment POSIX.1
2557 @deftypefun int fcntl (int @var{filedes}, int @var{command}, @dots{})
2558 The @code{fcntl} function performs the operation specified by
2559 @var{command} on the file descriptor @var{filedes}.  Some commands
2560 require additional arguments to be supplied.  These additional arguments
2561 and the return value and error conditions are given in the detailed
2562 descriptions of the individual commands.
2564 Briefly, here is a list of what the various commands are.
2566 @table @code
2567 @item F_DUPFD
2568 Duplicate the file descriptor (return another file descriptor pointing
2569 to the same open file).  @xref{Duplicating Descriptors}.
2571 @item F_GETFD
2572 Get flags associated with the file descriptor.  @xref{Descriptor Flags}.
2574 @item F_SETFD
2575 Set flags associated with the file descriptor.  @xref{Descriptor Flags}.
2577 @item F_GETFL
2578 Get flags associated with the open file.  @xref{File Status Flags}.
2580 @item F_SETFL
2581 Set flags associated with the open file.  @xref{File Status Flags}.
2583 @item F_GETLK
2584 Get a file lock.  @xref{File Locks}.
2586 @item F_SETLK
2587 Set or clear a file lock.  @xref{File Locks}.
2589 @item F_SETLKW
2590 Like @code{F_SETLK}, but wait for completion.  @xref{File Locks}.
2592 @item F_GETOWN
2593 Get process or process group ID to receive @code{SIGIO} signals.
2594 @xref{Interrupt Input}.
2596 @item F_SETOWN
2597 Set process or process group ID to receive @code{SIGIO} signals.
2598 @xref{Interrupt Input}.
2599 @end table
2601 This function is a cancellation point in multi-threaded programs.  This
2602 is a problem if the thread allocates some resources (like memory, file
2603 descriptors, semaphores or whatever) at the time @code{fcntl} is
2604 called.  If the thread gets canceled these resources stay allocated
2605 until the program ends.  To avoid this calls to @code{fcntl} should be
2606 protected using cancellation handlers.
2607 @c ref pthread_cleanup_push / pthread_cleanup_pop
2608 @end deftypefun
2611 @node Duplicating Descriptors
2612 @section Duplicating Descriptors
2614 @cindex duplicating file descriptors
2615 @cindex redirecting input and output
2617 You can @dfn{duplicate} a file descriptor, or allocate another file
2618 descriptor that refers to the same open file as the original.  Duplicate
2619 descriptors share one file position and one set of file status flags
2620 (@pxref{File Status Flags}), but each has its own set of file descriptor
2621 flags (@pxref{Descriptor Flags}).
2623 The major use of duplicating a file descriptor is to implement
2624 @dfn{redirection} of input or output:  that is, to change the
2625 file or pipe that a particular file descriptor corresponds to.
2627 You can perform this operation using the @code{fcntl} function with the
2628 @code{F_DUPFD} command, but there are also convenient functions
2629 @code{dup} and @code{dup2} for duplicating descriptors.
2631 @pindex unistd.h
2632 @pindex fcntl.h
2633 The @code{fcntl} function and flags are declared in @file{fcntl.h},
2634 while prototypes for @code{dup} and @code{dup2} are in the header file
2635 @file{unistd.h}.
2637 @comment unistd.h
2638 @comment POSIX.1
2639 @deftypefun int dup (int @var{old})
2640 This function copies descriptor @var{old} to the first available
2641 descriptor number (the first number not currently open).  It is
2642 equivalent to @code{fcntl (@var{old}, F_DUPFD, 0)}.
2643 @end deftypefun
2645 @comment unistd.h
2646 @comment POSIX.1
2647 @deftypefun int dup2 (int @var{old}, int @var{new})
2648 This function copies the descriptor @var{old} to descriptor number
2649 @var{new}.
2651 If @var{old} is an invalid descriptor, then @code{dup2} does nothing; it
2652 does not close @var{new}.  Otherwise, the new duplicate of @var{old}
2653 replaces any previous meaning of descriptor @var{new}, as if @var{new}
2654 were closed first.
2656 If @var{old} and @var{new} are different numbers, and @var{old} is a
2657 valid descriptor number, then @code{dup2} is equivalent to:
2659 @smallexample
2660 close (@var{new});
2661 fcntl (@var{old}, F_DUPFD, @var{new})
2662 @end smallexample
2664 However, @code{dup2} does this atomically; there is no instant in the
2665 middle of calling @code{dup2} at which @var{new} is closed and not yet a
2666 duplicate of @var{old}.
2667 @end deftypefun
2669 @comment fcntl.h
2670 @comment POSIX.1
2671 @deftypevr Macro int F_DUPFD
2672 This macro is used as the @var{command} argument to @code{fcntl}, to
2673 copy the file descriptor given as the first argument.
2675 The form of the call in this case is:
2677 @smallexample
2678 fcntl (@var{old}, F_DUPFD, @var{next-filedes})
2679 @end smallexample
2681 The @var{next-filedes} argument is of type @code{int} and specifies that
2682 the file descriptor returned should be the next available one greater
2683 than or equal to this value.
2685 The return value from @code{fcntl} with this command is normally the value
2686 of the new file descriptor.  A return value of @math{-1} indicates an
2687 error.  The following @code{errno} error conditions are defined for
2688 this command:
2690 @table @code
2691 @item EBADF
2692 The @var{old} argument is invalid.
2694 @item EINVAL
2695 The @var{next-filedes} argument is invalid.
2697 @item EMFILE
2698 There are no more file descriptors available---your program is already
2699 using the maximum.  In BSD and GNU, the maximum is controlled by a
2700 resource limit that can be changed; @pxref{Limits on Resources}, for
2701 more information about the @code{RLIMIT_NOFILE} limit.
2702 @end table
2704 @code{ENFILE} is not a possible error code for @code{dup2} because
2705 @code{dup2} does not create a new opening of a file; duplicate
2706 descriptors do not count toward the limit which @code{ENFILE}
2707 indicates.  @code{EMFILE} is possible because it refers to the limit on
2708 distinct descriptor numbers in use in one process.
2709 @end deftypevr
2711 Here is an example showing how to use @code{dup2} to do redirection.
2712 Typically, redirection of the standard streams (like @code{stdin}) is
2713 done by a shell or shell-like program before calling one of the
2714 @code{exec} functions (@pxref{Executing a File}) to execute a new
2715 program in a child process.  When the new program is executed, it
2716 creates and initializes the standard streams to point to the
2717 corresponding file descriptors, before its @code{main} function is
2718 invoked.
2720 So, to redirect standard input to a file, the shell could do something
2721 like:
2723 @smallexample
2724 pid = fork ();
2725 if (pid == 0)
2726   @{
2727     char *filename;
2728     char *program;
2729     int file;
2730     @dots{}
2731     file = TEMP_FAILURE_RETRY (open (filename, O_RDONLY));
2732     dup2 (file, STDIN_FILENO);
2733     TEMP_FAILURE_RETRY (close (file));
2734     execv (program, NULL);
2735   @}
2736 @end smallexample
2738 There is also a more detailed example showing how to implement redirection
2739 in the context of a pipeline of processes in @ref{Launching Jobs}.
2742 @node Descriptor Flags
2743 @section File Descriptor Flags
2744 @cindex file descriptor flags
2746 @dfn{File descriptor flags} are miscellaneous attributes of a file
2747 descriptor.  These flags are associated with particular file
2748 descriptors, so that if you have created duplicate file descriptors
2749 from a single opening of a file, each descriptor has its own set of flags.
2751 Currently there is just one file descriptor flag: @code{FD_CLOEXEC},
2752 which causes the descriptor to be closed if you use any of the
2753 @code{exec@dots{}} functions (@pxref{Executing a File}).
2755 The symbols in this section are defined in the header file
2756 @file{fcntl.h}.
2757 @pindex fcntl.h
2759 @comment fcntl.h
2760 @comment POSIX.1
2761 @deftypevr Macro int F_GETFD
2762 This macro is used as the @var{command} argument to @code{fcntl}, to
2763 specify that it should return the file descriptor flags associated
2764 with the @var{filedes} argument.
2766 The normal return value from @code{fcntl} with this command is a
2767 nonnegative number which can be interpreted as the bitwise OR of the
2768 individual flags (except that currently there is only one flag to use).
2770 In case of an error, @code{fcntl} returns @math{-1}.  The following
2771 @code{errno} error conditions are defined for this command:
2773 @table @code
2774 @item EBADF
2775 The @var{filedes} argument is invalid.
2776 @end table
2777 @end deftypevr
2780 @comment fcntl.h
2781 @comment POSIX.1
2782 @deftypevr Macro int F_SETFD
2783 This macro is used as the @var{command} argument to @code{fcntl}, to
2784 specify that it should set the file descriptor flags associated with the
2785 @var{filedes} argument.  This requires a third @code{int} argument to
2786 specify the new flags, so the form of the call is:
2788 @smallexample
2789 fcntl (@var{filedes}, F_SETFD, @var{new-flags})
2790 @end smallexample
2792 The normal return value from @code{fcntl} with this command is an
2793 unspecified value other than @math{-1}, which indicates an error.
2794 The flags and error conditions are the same as for the @code{F_GETFD}
2795 command.
2796 @end deftypevr
2798 The following macro is defined for use as a file descriptor flag with
2799 the @code{fcntl} function.  The value is an integer constant usable
2800 as a bit mask value.
2802 @comment fcntl.h
2803 @comment POSIX.1
2804 @deftypevr Macro int FD_CLOEXEC
2805 @cindex close-on-exec (file descriptor flag)
2806 This flag specifies that the file descriptor should be closed when
2807 an @code{exec} function is invoked; see @ref{Executing a File}.  When
2808 a file descriptor is allocated (as with @code{open} or @code{dup}),
2809 this bit is initially cleared on the new file descriptor, meaning that
2810 descriptor will survive into the new program after @code{exec}.
2811 @end deftypevr
2813 If you want to modify the file descriptor flags, you should get the
2814 current flags with @code{F_GETFD} and modify the value.  Don't assume
2815 that the flags listed here are the only ones that are implemented; your
2816 program may be run years from now and more flags may exist then.  For
2817 example, here is a function to set or clear the flag @code{FD_CLOEXEC}
2818 without altering any other flags:
2820 @smallexample
2821 /* @r{Set the @code{FD_CLOEXEC} flag of @var{desc} if @var{value} is nonzero,}
2822    @r{or clear the flag if @var{value} is 0.}
2823    @r{Return 0 on success, or -1 on error with @code{errno} set.} */
2826 set_cloexec_flag (int desc, int value)
2828   int oldflags = fcntl (desc, F_GETFD, 0);
2829   /* @r{If reading the flags failed, return error indication now.}
2830   if (oldflags < 0)
2831     return oldflags;
2832   /* @r{Set just the flag we want to set.} */
2833   if (value != 0)
2834     oldflags |= FD_CLOEXEC;
2835   else
2836     oldflags &= ~FD_CLOEXEC;
2837   /* @r{Store modified flag word in the descriptor.} */
2838   return fcntl (desc, F_SETFD, oldflags);
2840 @end smallexample
2842 @node File Status Flags
2843 @section File Status Flags
2844 @cindex file status flags
2846 @dfn{File status flags} are used to specify attributes of the opening of a
2847 file.  Unlike the file descriptor flags discussed in @ref{Descriptor
2848 Flags}, the file status flags are shared by duplicated file descriptors
2849 resulting from a single opening of the file.  The file status flags are
2850 specified with the @var{flags} argument to @code{open};
2851 @pxref{Opening and Closing Files}.
2853 File status flags fall into three categories, which are described in the
2854 following sections.
2856 @itemize @bullet
2857 @item
2858 @ref{Access Modes}, specify what type of access is allowed to the
2859 file: reading, writing, or both.  They are set by @code{open} and are
2860 returned by @code{fcntl}, but cannot be changed.
2862 @item
2863 @ref{Open-time Flags}, control details of what @code{open} will do.
2864 These flags are not preserved after the @code{open} call.
2866 @item
2867 @ref{Operating Modes}, affect how operations such as @code{read} and
2868 @code{write} are done.  They are set by @code{open}, and can be fetched or
2869 changed with @code{fcntl}.
2870 @end itemize
2872 The symbols in this section are defined in the header file
2873 @file{fcntl.h}.
2874 @pindex fcntl.h
2876 @menu
2877 * Access Modes::                Whether the descriptor can read or write.
2878 * Open-time Flags::             Details of @code{open}.
2879 * Operating Modes::             Special modes to control I/O operations.
2880 * Getting File Status Flags::   Fetching and changing these flags.
2881 @end menu
2883 @node Access Modes
2884 @subsection File Access Modes
2886 The file access modes allow a file descriptor to be used for reading,
2887 writing, or both.  (In the GNU system, they can also allow none of these,
2888 and allow execution of the file as a program.)  The access modes are chosen
2889 when the file is opened, and never change.
2891 @comment fcntl.h
2892 @comment POSIX.1
2893 @deftypevr Macro int O_RDONLY
2894 Open the file for read access.
2895 @end deftypevr
2897 @comment fcntl.h
2898 @comment POSIX.1
2899 @deftypevr Macro int O_WRONLY
2900 Open the file for write access.
2901 @end deftypevr
2903 @comment fcntl.h
2904 @comment POSIX.1
2905 @deftypevr Macro int O_RDWR
2906 Open the file for both reading and writing.
2907 @end deftypevr
2909 In the GNU system (and not in other systems), @code{O_RDONLY} and
2910 @code{O_WRONLY} are independent bits that can be bitwise-ORed together,
2911 and it is valid for either bit to be set or clear.  This means that
2912 @code{O_RDWR} is the same as @code{O_RDONLY|O_WRONLY}.  A file access
2913 mode of zero is permissible; it allows no operations that do input or
2914 output to the file, but does allow other operations such as
2915 @code{fchmod}.  On the GNU system, since ``read-only'' or ``write-only''
2916 is a misnomer, @file{fcntl.h} defines additional names for the file
2917 access modes.  These names are preferred when writing GNU-specific code.
2918 But most programs will want to be portable to other POSIX.1 systems and
2919 should use the POSIX.1 names above instead.
2921 @comment fcntl.h
2922 @comment GNU
2923 @deftypevr Macro int O_READ
2924 Open the file for reading.  Same as @code{O_RDWR}; only defined on GNU.
2925 @end deftypevr
2927 @comment fcntl.h
2928 @comment GNU
2929 @deftypevr Macro int O_WRITE
2930 Open the file for reading.  Same as @code{O_WRONLY}; only defined on GNU.
2931 @end deftypevr
2933 @comment fcntl.h
2934 @comment GNU
2935 @deftypevr Macro int O_EXEC
2936 Open the file for executing.  Only defined on GNU.
2937 @end deftypevr
2939 To determine the file access mode with @code{fcntl}, you must extract
2940 the access mode bits from the retrieved file status flags.  In the GNU
2941 system, you can just test the @code{O_READ} and @code{O_WRITE} bits in
2942 the flags word.  But in other POSIX.1 systems, reading and writing
2943 access modes are not stored as distinct bit flags.  The portable way to
2944 extract the file access mode bits is with @code{O_ACCMODE}.
2946 @comment fcntl.h
2947 @comment POSIX.1
2948 @deftypevr Macro int O_ACCMODE
2949 This macro stands for a mask that can be bitwise-ANDed with the file
2950 status flag value to produce a value representing the file access mode.
2951 The mode will be @code{O_RDONLY}, @code{O_WRONLY}, or @code{O_RDWR}.
2952 (In the GNU system it could also be zero, and it never includes the
2953 @code{O_EXEC} bit.)
2954 @end deftypevr
2956 @node Open-time Flags
2957 @subsection Open-time Flags
2959 The open-time flags specify options affecting how @code{open} will behave.
2960 These options are not preserved once the file is open.  The exception to
2961 this is @code{O_NONBLOCK}, which is also an I/O operating mode and so it
2962 @emph{is} saved.  @xref{Opening and Closing Files}, for how to call
2963 @code{open}.
2965 There are two sorts of options specified by open-time flags.
2967 @itemize @bullet
2968 @item
2969 @dfn{File name translation flags} affect how @code{open} looks up the
2970 file name to locate the file, and whether the file can be created.
2971 @cindex file name translation flags
2972 @cindex flags, file name translation
2974 @item
2975 @dfn{Open-time action flags} specify extra operations that @code{open} will
2976 perform on the file once it is open.
2977 @cindex open-time action flags
2978 @cindex flags, open-time action
2979 @end itemize
2981 Here are the file name translation flags.
2983 @comment fcntl.h
2984 @comment POSIX.1
2985 @deftypevr Macro int O_CREAT
2986 If set, the file will be created if it doesn't already exist.
2987 @c !!! mode arg, umask
2988 @cindex create on open (file status flag)
2989 @end deftypevr
2991 @comment fcntl.h
2992 @comment POSIX.1
2993 @deftypevr Macro int O_EXCL
2994 If both @code{O_CREAT} and @code{O_EXCL} are set, then @code{open} fails
2995 if the specified file already exists.  This is guaranteed to never
2996 clobber an existing file.
2997 @end deftypevr
2999 @comment fcntl.h
3000 @comment POSIX.1
3001 @deftypevr Macro int O_NONBLOCK
3002 @cindex non-blocking open
3003 This prevents @code{open} from blocking for a ``long time'' to open the
3004 file.  This is only meaningful for some kinds of files, usually devices
3005 such as serial ports; when it is not meaningful, it is harmless and
3006 ignored.  Often opening a port to a modem blocks until the modem reports
3007 carrier detection; if @code{O_NONBLOCK} is specified, @code{open} will
3008 return immediately without a carrier.
3010 Note that the @code{O_NONBLOCK} flag is overloaded as both an I/O operating
3011 mode and a file name translation flag.  This means that specifying
3012 @code{O_NONBLOCK} in @code{open} also sets nonblocking I/O mode;
3013 @pxref{Operating Modes}.  To open the file without blocking but do normal
3014 I/O that blocks, you must call @code{open} with @code{O_NONBLOCK} set and
3015 then call @code{fcntl} to turn the bit off.
3016 @end deftypevr
3018 @comment fcntl.h
3019 @comment POSIX.1
3020 @deftypevr Macro int O_NOCTTY
3021 If the named file is a terminal device, don't make it the controlling
3022 terminal for the process.  @xref{Job Control}, for information about
3023 what it means to be the controlling terminal.
3025 In the GNU system and 4.4 BSD, opening a file never makes it the
3026 controlling terminal and @code{O_NOCTTY} is zero.  However, other
3027 systems may use a nonzero value for @code{O_NOCTTY} and set the
3028 controlling terminal when you open a file that is a terminal device; so
3029 to be portable, use @code{O_NOCTTY} when it is important to avoid this.
3030 @cindex controlling terminal, setting
3031 @end deftypevr
3033 The following three file name translation flags exist only in the GNU system.
3035 @comment fcntl.h
3036 @comment GNU
3037 @deftypevr Macro int O_IGNORE_CTTY
3038 Do not recognize the named file as the controlling terminal, even if it
3039 refers to the process's existing controlling terminal device.  Operations
3040 on the new file descriptor will never induce job control signals.
3041 @xref{Job Control}.
3042 @end deftypevr
3044 @comment fcntl.h
3045 @comment GNU
3046 @deftypevr Macro int O_NOLINK
3047 If the named file is a symbolic link, open the link itself instead of
3048 the file it refers to.  (@code{fstat} on the new file descriptor will
3049 return the information returned by @code{lstat} on the link's name.)
3050 @cindex symbolic link, opening
3051 @end deftypevr
3053 @comment fcntl.h
3054 @comment GNU
3055 @deftypevr Macro int O_NOTRANS
3056 If the named file is specially translated, do not invoke the translator.
3057 Open the bare file the translator itself sees.
3058 @end deftypevr
3061 The open-time action flags tell @code{open} to do additional operations
3062 which are not really related to opening the file.  The reason to do them
3063 as part of @code{open} instead of in separate calls is that @code{open}
3064 can do them @i{atomically}.
3066 @comment fcntl.h
3067 @comment POSIX.1
3068 @deftypevr Macro int O_TRUNC
3069 Truncate the file to zero length.  This option is only useful for
3070 regular files, not special files such as directories or FIFOs.  POSIX.1
3071 requires that you open the file for writing to use @code{O_TRUNC}.  In
3072 BSD and GNU you must have permission to write the file to truncate it,
3073 but you need not open for write access.
3075 This is the only open-time action flag specified by POSIX.1.  There is
3076 no good reason for truncation to be done by @code{open}, instead of by
3077 calling @code{ftruncate} afterwards.  The @code{O_TRUNC} flag existed in
3078 Unix before @code{ftruncate} was invented, and is retained for backward
3079 compatibility.
3080 @end deftypevr
3082 The remaining operating modes are BSD extensions.  They exist only
3083 on some systems.  On other systems, these macros are not defined.
3085 @comment fcntl.h
3086 @comment BSD
3087 @deftypevr Macro int O_SHLOCK
3088 Acquire a shared lock on the file, as with @code{flock}.
3089 @xref{File Locks}.
3091 If @code{O_CREAT} is specified, the locking is done atomically when
3092 creating the file.  You are guaranteed that no other process will get
3093 the lock on the new file first.
3094 @end deftypevr
3096 @comment fcntl.h
3097 @comment BSD
3098 @deftypevr Macro int O_EXLOCK
3099 Acquire an exclusive lock on the file, as with @code{flock}.
3100 @xref{File Locks}.  This is atomic like @code{O_SHLOCK}.
3101 @end deftypevr
3103 @node Operating Modes
3104 @subsection I/O Operating Modes
3106 The operating modes affect how input and output operations using a file
3107 descriptor work.  These flags are set by @code{open} and can be fetched
3108 and changed with @code{fcntl}.
3110 @comment fcntl.h
3111 @comment POSIX.1
3112 @deftypevr Macro int O_APPEND
3113 The bit that enables append mode for the file.  If set, then all
3114 @code{write} operations write the data at the end of the file, extending
3115 it, regardless of the current file position.  This is the only reliable
3116 way to append to a file.  In append mode, you are guaranteed that the
3117 data you write will always go to the current end of the file, regardless
3118 of other processes writing to the file.  Conversely, if you simply set
3119 the file position to the end of file and write, then another process can
3120 extend the file after you set the file position but before you write,
3121 resulting in your data appearing someplace before the real end of file.
3122 @end deftypevr
3124 @comment fcntl.h
3125 @comment POSIX.1
3126 @deftypevr Macro int O_NONBLOCK
3127 The bit that enables nonblocking mode for the file.  If this bit is set,
3128 @code{read} requests on the file can return immediately with a failure
3129 status if there is no input immediately available, instead of blocking.
3130 Likewise, @code{write} requests can also return immediately with a
3131 failure status if the output can't be written immediately.
3133 Note that the @code{O_NONBLOCK} flag is overloaded as both an I/O
3134 operating mode and a file name translation flag; @pxref{Open-time Flags}.
3135 @end deftypevr
3137 @comment fcntl.h
3138 @comment BSD
3139 @deftypevr Macro int O_NDELAY
3140 This is an obsolete name for @code{O_NONBLOCK}, provided for
3141 compatibility with BSD.  It is not defined by the POSIX.1 standard.
3142 @end deftypevr
3144 The remaining operating modes are BSD and GNU extensions.  They exist only
3145 on some systems.  On other systems, these macros are not defined.
3147 @comment fcntl.h
3148 @comment BSD
3149 @deftypevr Macro int O_ASYNC
3150 The bit that enables asynchronous input mode.  If set, then @code{SIGIO}
3151 signals will be generated when input is available.  @xref{Interrupt Input}.
3153 Asynchronous input mode is a BSD feature.
3154 @end deftypevr
3156 @comment fcntl.h
3157 @comment BSD
3158 @deftypevr Macro int O_FSYNC
3159 The bit that enables synchronous writing for the file.  If set, each
3160 @code{write} call will make sure the data is reliably stored on disk before
3161 returning. @c !!! xref fsync
3163 Synchronous writing is a BSD feature.
3164 @end deftypevr
3166 @comment fcntl.h
3167 @comment BSD
3168 @deftypevr Macro int O_SYNC
3169 This is another name for @code{O_FSYNC}.  They have the same value.
3170 @end deftypevr
3172 @comment fcntl.h
3173 @comment GNU
3174 @deftypevr Macro int O_NOATIME
3175 If this bit is set, @code{read} will not update the access time of the
3176 file.  @xref{File Times}.  This is used by programs that do backups, so
3177 that backing a file up does not count as reading it.
3178 Only the owner of the file or the superuser may use this bit.
3180 This is a GNU extension.
3181 @end deftypevr
3183 @node Getting File Status Flags
3184 @subsection Getting and Setting File Status Flags
3186 The @code{fcntl} function can fetch or change file status flags.
3188 @comment fcntl.h
3189 @comment POSIX.1
3190 @deftypevr Macro int F_GETFL
3191 This macro is used as the @var{command} argument to @code{fcntl}, to
3192 read the file status flags for the open file with descriptor
3193 @var{filedes}.
3195 The normal return value from @code{fcntl} with this command is a
3196 nonnegative number which can be interpreted as the bitwise OR of the
3197 individual flags.  Since the file access modes are not single-bit values,
3198 you can mask off other bits in the returned flags with @code{O_ACCMODE}
3199 to compare them.
3201 In case of an error, @code{fcntl} returns @math{-1}.  The following
3202 @code{errno} error conditions are defined for this command:
3204 @table @code
3205 @item EBADF
3206 The @var{filedes} argument is invalid.
3207 @end table
3208 @end deftypevr
3210 @comment fcntl.h
3211 @comment POSIX.1
3212 @deftypevr Macro int F_SETFL
3213 This macro is used as the @var{command} argument to @code{fcntl}, to set
3214 the file status flags for the open file corresponding to the
3215 @var{filedes} argument.  This command requires a third @code{int}
3216 argument to specify the new flags, so the call looks like this:
3218 @smallexample
3219 fcntl (@var{filedes}, F_SETFL, @var{new-flags})
3220 @end smallexample
3222 You can't change the access mode for the file in this way; that is,
3223 whether the file descriptor was opened for reading or writing.
3225 The normal return value from @code{fcntl} with this command is an
3226 unspecified value other than @math{-1}, which indicates an error.  The
3227 error conditions are the same as for the @code{F_GETFL} command.
3228 @end deftypevr
3230 If you want to modify the file status flags, you should get the current
3231 flags with @code{F_GETFL} and modify the value.  Don't assume that the
3232 flags listed here are the only ones that are implemented; your program
3233 may be run years from now and more flags may exist then.  For example,
3234 here is a function to set or clear the flag @code{O_NONBLOCK} without
3235 altering any other flags:
3237 @smallexample
3238 @group
3239 /* @r{Set the @code{O_NONBLOCK} flag of @var{desc} if @var{value} is nonzero,}
3240    @r{or clear the flag if @var{value} is 0.}
3241    @r{Return 0 on success, or -1 on error with @code{errno} set.} */
3244 set_nonblock_flag (int desc, int value)
3246   int oldflags = fcntl (desc, F_GETFL, 0);
3247   /* @r{If reading the flags failed, return error indication now.} */
3248   if (oldflags == -1)
3249     return -1;
3250   /* @r{Set just the flag we want to set.} */
3251   if (value != 0)
3252     oldflags |= O_NONBLOCK;
3253   else
3254     oldflags &= ~O_NONBLOCK;
3255   /* @r{Store modified flag word in the descriptor.} */
3256   return fcntl (desc, F_SETFL, oldflags);
3258 @end group
3259 @end smallexample
3261 @node File Locks
3262 @section File Locks
3264 @cindex file locks
3265 @cindex record locking
3266 The remaining @code{fcntl} commands are used to support @dfn{record
3267 locking}, which permits multiple cooperating programs to prevent each
3268 other from simultaneously accessing parts of a file in error-prone
3269 ways.
3271 @cindex exclusive lock
3272 @cindex write lock
3273 An @dfn{exclusive} or @dfn{write} lock gives a process exclusive access
3274 for writing to the specified part of the file.  While a write lock is in
3275 place, no other process can lock that part of the file.
3277 @cindex shared lock
3278 @cindex read lock
3279 A @dfn{shared} or @dfn{read} lock prohibits any other process from
3280 requesting a write lock on the specified part of the file.  However,
3281 other processes can request read locks.
3283 The @code{read} and @code{write} functions do not actually check to see
3284 whether there are any locks in place.  If you want to implement a
3285 locking protocol for a file shared by multiple processes, your application
3286 must do explicit @code{fcntl} calls to request and clear locks at the
3287 appropriate points.
3289 Locks are associated with processes.  A process can only have one kind
3290 of lock set for each byte of a given file.  When any file descriptor for
3291 that file is closed by the process, all of the locks that process holds
3292 on that file are released, even if the locks were made using other
3293 descriptors that remain open.  Likewise, locks are released when a
3294 process exits, and are not inherited by child processes created using
3295 @code{fork} (@pxref{Creating a Process}).
3297 When making a lock, use a @code{struct flock} to specify what kind of
3298 lock and where.  This data type and the associated macros for the
3299 @code{fcntl} function are declared in the header file @file{fcntl.h}.
3300 @pindex fcntl.h
3302 @comment fcntl.h
3303 @comment POSIX.1
3304 @deftp {Data Type} {struct flock}
3305 This structure is used with the @code{fcntl} function to describe a file
3306 lock.  It has these members:
3308 @table @code
3309 @item short int l_type
3310 Specifies the type of the lock; one of @code{F_RDLCK}, @code{F_WRLCK}, or
3311 @code{F_UNLCK}.
3313 @item short int l_whence
3314 This corresponds to the @var{whence} argument to @code{fseek} or
3315 @code{lseek}, and specifies what the offset is relative to.  Its value
3316 can be one of @code{SEEK_SET}, @code{SEEK_CUR}, or @code{SEEK_END}.
3318 @item off_t l_start
3319 This specifies the offset of the start of the region to which the lock
3320 applies, and is given in bytes relative to the point specified by
3321 @code{l_whence} member.
3323 @item off_t l_len
3324 This specifies the length of the region to be locked.  A value of
3325 @code{0} is treated specially; it means the region extends to the end of
3326 the file.
3328 @item pid_t l_pid
3329 This field is the process ID (@pxref{Process Creation Concepts}) of the
3330 process holding the lock.  It is filled in by calling @code{fcntl} with
3331 the @code{F_GETLK} command, but is ignored when making a lock.
3332 @end table
3333 @end deftp
3335 @comment fcntl.h
3336 @comment POSIX.1
3337 @deftypevr Macro int F_GETLK
3338 This macro is used as the @var{command} argument to @code{fcntl}, to
3339 specify that it should get information about a lock.  This command
3340 requires a third argument of type @w{@code{struct flock *}} to be passed
3341 to @code{fcntl}, so that the form of the call is:
3343 @smallexample
3344 fcntl (@var{filedes}, F_GETLK, @var{lockp})
3345 @end smallexample
3347 If there is a lock already in place that would block the lock described
3348 by the @var{lockp} argument, information about that lock overwrites
3349 @code{*@var{lockp}}.  Existing locks are not reported if they are
3350 compatible with making a new lock as specified.  Thus, you should
3351 specify a lock type of @code{F_WRLCK} if you want to find out about both
3352 read and write locks, or @code{F_RDLCK} if you want to find out about
3353 write locks only.
3355 There might be more than one lock affecting the region specified by the
3356 @var{lockp} argument, but @code{fcntl} only returns information about
3357 one of them.  The @code{l_whence} member of the @var{lockp} structure is
3358 set to @code{SEEK_SET} and the @code{l_start} and @code{l_len} fields
3359 set to identify the locked region.
3361 If no lock applies, the only change to the @var{lockp} structure is to
3362 update the @code{l_type} to a value of @code{F_UNLCK}.
3364 The normal return value from @code{fcntl} with this command is an
3365 unspecified value other than @math{-1}, which is reserved to indicate an
3366 error.  The following @code{errno} error conditions are defined for
3367 this command:
3369 @table @code
3370 @item EBADF
3371 The @var{filedes} argument is invalid.
3373 @item EINVAL
3374 Either the @var{lockp} argument doesn't specify valid lock information,
3375 or the file associated with @var{filedes} doesn't support locks.
3376 @end table
3377 @end deftypevr
3379 @comment fcntl.h
3380 @comment POSIX.1
3381 @deftypevr Macro int F_SETLK
3382 This macro is used as the @var{command} argument to @code{fcntl}, to
3383 specify that it should set or clear a lock.  This command requires a
3384 third argument of type @w{@code{struct flock *}} to be passed to
3385 @code{fcntl}, so that the form of the call is:
3387 @smallexample
3388 fcntl (@var{filedes}, F_SETLK, @var{lockp})
3389 @end smallexample
3391 If the process already has a lock on any part of the region, the old lock
3392 on that part is replaced with the new lock.  You can remove a lock
3393 by specifying a lock type of @code{F_UNLCK}.
3395 If the lock cannot be set, @code{fcntl} returns immediately with a value
3396 of @math{-1}.  This function does not block waiting for other processes
3397 to release locks.  If @code{fcntl} succeeds, it return a value other
3398 than @math{-1}.
3400 The following @code{errno} error conditions are defined for this
3401 function:
3403 @table @code
3404 @item EAGAIN
3405 @itemx EACCES
3406 The lock cannot be set because it is blocked by an existing lock on the
3407 file.  Some systems use @code{EAGAIN} in this case, and other systems
3408 use @code{EACCES}; your program should treat them alike, after
3409 @code{F_SETLK}.  (The GNU system always uses @code{EAGAIN}.)
3411 @item EBADF
3412 Either: the @var{filedes} argument is invalid; you requested a read lock
3413 but the @var{filedes} is not open for read access; or, you requested a
3414 write lock but the @var{filedes} is not open for write access.
3416 @item EINVAL
3417 Either the @var{lockp} argument doesn't specify valid lock information,
3418 or the file associated with @var{filedes} doesn't support locks.
3420 @item ENOLCK
3421 The system has run out of file lock resources; there are already too
3422 many file locks in place.
3424 Well-designed file systems never report this error, because they have no
3425 limitation on the number of locks.  However, you must still take account
3426 of the possibility of this error, as it could result from network access
3427 to a file system on another machine.
3428 @end table
3429 @end deftypevr
3431 @comment fcntl.h
3432 @comment POSIX.1
3433 @deftypevr Macro int F_SETLKW
3434 This macro is used as the @var{command} argument to @code{fcntl}, to
3435 specify that it should set or clear a lock.  It is just like the
3436 @code{F_SETLK} command, but causes the process to block (or wait)
3437 until the request can be specified.
3439 This command requires a third argument of type @code{struct flock *}, as
3440 for the @code{F_SETLK} command.
3442 The @code{fcntl} return values and errors are the same as for the
3443 @code{F_SETLK} command, but these additional @code{errno} error conditions
3444 are defined for this command:
3446 @table @code
3447 @item EINTR
3448 The function was interrupted by a signal while it was waiting.
3449 @xref{Interrupted Primitives}.
3451 @item EDEADLK
3452 The specified region is being locked by another process.  But that
3453 process is waiting to lock a region which the current process has
3454 locked, so waiting for the lock would result in deadlock.  The system
3455 does not guarantee that it will detect all such conditions, but it lets
3456 you know if it notices one.
3457 @end table
3458 @end deftypevr
3461 The following macros are defined for use as values for the @code{l_type}
3462 member of the @code{flock} structure.  The values are integer constants.
3464 @table @code
3465 @comment fcntl.h
3466 @comment POSIX.1
3467 @vindex F_RDLCK
3468 @item F_RDLCK
3469 This macro is used to specify a read (or shared) lock.
3471 @comment fcntl.h
3472 @comment POSIX.1
3473 @vindex F_WRLCK
3474 @item F_WRLCK
3475 This macro is used to specify a write (or exclusive) lock.
3477 @comment fcntl.h
3478 @comment POSIX.1
3479 @vindex F_UNLCK
3480 @item F_UNLCK
3481 This macro is used to specify that the region is unlocked.
3482 @end table
3484 As an example of a situation where file locking is useful, consider a
3485 program that can be run simultaneously by several different users, that
3486 logs status information to a common file.  One example of such a program
3487 might be a game that uses a file to keep track of high scores.  Another
3488 example might be a program that records usage or accounting information
3489 for billing purposes.
3491 Having multiple copies of the program simultaneously writing to the
3492 file could cause the contents of the file to become mixed up.  But
3493 you can prevent this kind of problem by setting a write lock on the
3494 file before actually writing to the file.
3496 If the program also needs to read the file and wants to make sure that
3497 the contents of the file are in a consistent state, then it can also use
3498 a read lock.  While the read lock is set, no other process can lock
3499 that part of the file for writing.
3501 @c ??? This section could use an example program.
3503 Remember that file locks are only a @emph{voluntary} protocol for
3504 controlling access to a file.  There is still potential for access to
3505 the file by programs that don't use the lock protocol.
3507 @node Interrupt Input
3508 @section Interrupt-Driven Input
3510 @cindex interrupt-driven input
3511 If you set the @code{O_ASYNC} status flag on a file descriptor
3512 (@pxref{File Status Flags}), a @code{SIGIO} signal is sent whenever
3513 input or output becomes possible on that file descriptor.  The process
3514 or process group to receive the signal can be selected by using the
3515 @code{F_SETOWN} command to the @code{fcntl} function.  If the file
3516 descriptor is a socket, this also selects the recipient of @code{SIGURG}
3517 signals that are delivered when out-of-band data arrives on that socket;
3518 see @ref{Out-of-Band Data}.  (@code{SIGURG} is sent in any situation
3519 where @code{select} would report the socket as having an ``exceptional
3520 condition''.  @xref{Waiting for I/O}.)
3522 If the file descriptor corresponds to a terminal device, then @code{SIGIO}
3523 signals are sent to the foreground process group of the terminal.
3524 @xref{Job Control}.
3526 @pindex fcntl.h
3527 The symbols in this section are defined in the header file
3528 @file{fcntl.h}.
3530 @comment fcntl.h
3531 @comment BSD
3532 @deftypevr Macro int F_GETOWN
3533 This macro is used as the @var{command} argument to @code{fcntl}, to
3534 specify that it should get information about the process or process
3535 group to which @code{SIGIO} signals are sent.  (For a terminal, this is
3536 actually the foreground process group ID, which you can get using
3537 @code{tcgetpgrp}; see @ref{Terminal Access Functions}.)
3539 The return value is interpreted as a process ID; if negative, its
3540 absolute value is the process group ID.
3542 The following @code{errno} error condition is defined for this command:
3544 @table @code
3545 @item EBADF
3546 The @var{filedes} argument is invalid.
3547 @end table
3548 @end deftypevr
3550 @comment fcntl.h
3551 @comment BSD
3552 @deftypevr Macro int F_SETOWN
3553 This macro is used as the @var{command} argument to @code{fcntl}, to
3554 specify that it should set the process or process group to which
3555 @code{SIGIO} signals are sent.  This command requires a third argument
3556 of type @code{pid_t} to be passed to @code{fcntl}, so that the form of
3557 the call is:
3559 @smallexample
3560 fcntl (@var{filedes}, F_SETOWN, @var{pid})
3561 @end smallexample
3563 The @var{pid} argument should be a process ID.  You can also pass a
3564 negative number whose absolute value is a process group ID.
3566 The return value from @code{fcntl} with this command is @math{-1}
3567 in case of error and some other value if successful.  The following
3568 @code{errno} error conditions are defined for this command:
3570 @table @code
3571 @item EBADF
3572 The @var{filedes} argument is invalid.
3574 @item ESRCH
3575 There is no process or process group corresponding to @var{pid}.
3576 @end table
3577 @end deftypevr
3579 @c ??? This section could use an example program.
3581 @node IOCTLs
3582 @section Generic I/O Control operations
3583 @cindex generic i/o control operations
3584 @cindex IOCTLs
3586 The GNU system can handle most input/output operations on many different
3587 devices and objects in terms of a few file primitives - @code{read},
3588 @code{write} and @code{lseek}.  However, most devices also have a few
3589 peculiar operations which do not fit into this model. Such as:
3591 @itemize @bullet
3593 @item
3594 Changing the character font used on a terminal.
3596 @item
3597 Telling a magnetic tape system to rewind or fast forward.  (Since they
3598 cannot move in byte increments, @code{lseek} is inapplicable).
3600 @item
3601 Ejecting a disk from a drive.
3603 @item
3604 Playing an audio track from a CD-ROM drive.
3606 @item
3607 Maintaining routing tables for a network.
3609 @end itemize
3611 Although some such objects such as sockets and terminals
3612 @footnote{Actually, the terminal-specific functions are implemented with
3613 IOCTLs on many platforms.} have special functions of their own, it would
3614 not be practical to create functions for all these cases.
3616 Instead these minor operations, known as @dfn{IOCTL}s, are assigned code
3617 numbers and multiplexed through the @code{ioctl} function, defined in
3618 @code{sys/ioctl.h}.  The code numbers themselves are defined in many
3619 different headers.
3621 @deftypefun int ioctl (int @var{filedes}, int @var{command}, @dots{})
3623 The @code{ioctl} function performs the generic I/O operation
3624 @var{command} on @var{filedes}.
3626 A third argument is usually present, either a single number or a pointer
3627 to a structure.  The meaning of this argument, the returned value, and
3628 any error codes depends upon the command used.  Often @math{-1} is
3629 returned for a failure.
3631 @end deftypefun
3633 On some systems, IOCTLs used by different devices share the same numbers.
3634 Thus, although use of an inappropriate IOCTL @emph{usually} only produces
3635 an error, you should not attempt to use device-specific IOCTLs on an
3636 unknown device.
3638 Most IOCTLs are OS-specific and/or only used in special system utilities,
3639 and are thus beyond the scope of this document.  For an example of the use
3640 of an IOCTL, see @ref{Out-of-Band Data}.