Update.
[glibc.git] / manual / llio.texi
blobcf3e1a7c895cb625ce8bc3a2cab1de205ee48828
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 * Truncating Files::                    Change the size of a file.
37 * I/O Primitives::                      Reading and writing data.
38 * File Position Primitive::             Setting a descriptor's file
39                                          position.
40 * Descriptors and Streams::             Converting descriptor to stream
41                                          or vice-versa.
42 * Stream/Descriptor Precautions::       Precautions needed if you use both
43                                          descriptors and streams.
44 * Scatter-Gather::                      Fast I/O to discontinous buffers.
45 * Memory-mapped I/O::                   Using files like memory.
46 * Waiting for I/O::                     How to check for input or output
47                                          on multiple file descriptors.
48 * Synchronizing I/O::                   Making sure all I/O actions completed.
49 * Asynchronous I/O::                    Perform I/O in parallel.
50 * Control Operations::                  Various other operations on file
51                                          descriptors.
52 * Duplicating Descriptors::             Fcntl commands for duplicating
53                                          file descriptors.
54 * Descriptor Flags::                    Fcntl commands for manipulating
55                                          flags associated with file
56                                          descriptors.
57 * File Status Flags::                   Fcntl commands for manipulating
58                                          flags associated with open files.
59 * File Locks::                          Fcntl commands for implementing
60                                          file locking.
61 * Interrupt Input::                     Getting an asynchronous signal when
62                                          input arrives.
63 * IOCTLs::                              Generic I/O Control operations.
64 @end menu
67 @node Opening and Closing Files
68 @section Opening and Closing Files
70 @cindex opening a file descriptor
71 @cindex closing a file descriptor
72 This section describes the primitives for opening and closing files
73 using file descriptors.  The @code{open} and @code{creat} functions are
74 declared in the header file @file{fcntl.h}, while @code{close} is
75 declared in @file{unistd.h}.
76 @pindex unistd.h
77 @pindex fcntl.h
79 @comment fcntl.h
80 @comment POSIX.1
81 @deftypefun int open (const char *@var{filename}, int @var{flags}[, mode_t @var{mode}])
82 The @code{open} function creates and returns a new file descriptor
83 for the file named by @var{filename}.  Initially, the file position
84 indicator for the file is at the beginning of the file.  The argument
85 @var{mode} is used only when a file is created, but it doesn't hurt
86 to supply the argument in any case.
88 The @var{flags} argument controls how the file is to be opened.  This is
89 a bit mask; you create the value by the bitwise OR of the appropriate
90 parameters (using the @samp{|} operator in C).
91 @xref{File Status Flags}, for the parameters available.
93 The normal return value from @code{open} is a non-negative integer file
94 descriptor.  In the case of an error, a value of @math{-1} is returned
95 instead.  In addition to the usual file name errors (@pxref{File
96 Name Errors}), the following @code{errno} error conditions are defined
97 for this function:
99 @table @code
100 @item EACCES
101 The file exists but is not readable/writable as requested by the @var{flags}
102 argument, the file does not exist and the directory is unwritable so
103 it cannot be created.
105 @item EEXIST
106 Both @code{O_CREAT} and @code{O_EXCL} are set, and the named file already
107 exists.
109 @item EINTR
110 The @code{open} operation was interrupted by a signal.
111 @xref{Interrupted Primitives}.
113 @item EISDIR
114 The @var{flags} argument specified write access, and the file is a directory.
116 @item EMFILE
117 The process has too many files open.
118 The maximum number of file descriptors is controlled by the
119 @code{RLIMIT_NOFILE} resource limit; @pxref{Limits on Resources}.
121 @item ENFILE
122 The entire system, or perhaps the file system which contains the
123 directory, cannot support any additional open files at the moment.
124 (This problem cannot happen on the GNU system.)
126 @item ENOENT
127 The named file does not exist, and @code{O_CREAT} is not specified.
129 @item ENOSPC
130 The directory or file system that would contain the new file cannot be
131 extended, because there is no disk space left.
133 @item ENXIO
134 @code{O_NONBLOCK} and @code{O_WRONLY} are both set in the @var{flags}
135 argument, the file named by @var{filename} is a FIFO (@pxref{Pipes and
136 FIFOs}), and no process has the file open for reading.
138 @item EROFS
139 The file resides on a read-only file system and any of @w{@code{O_WRONLY}},
140 @code{O_RDWR}, and @code{O_TRUNC} are set in the @var{flags} argument,
141 or @code{O_CREAT} is set and the file does not already exist.
142 @end table
144 @c !!! umask
146 If on a 32 bits machine the sources are translated with
147 @code{_FILE_OFFSET_BITS == 64} the function @code{open} returns a file
148 descriptor opened in the large file mode which enables the file handling
149 functions to use files up to @math{2^63} bytes in size and offset from
150 @math{-2^63} to @math{2^63}.  This happens transparently for the user
151 since all of the lowlevel file handling functions are equally replaced.
153 This function is a cancelation point in multi-threaded programs.  This
154 is a problem if the thread allocates some resources (like memory, file
155 descriptors, semaphores or whatever) at the time @code{open} is
156 called.  If the thread gets canceled these resources stay allocated
157 until the program ends.  To avoid this calls to @code{open} should be
158 protected using cancelation handlers.
159 @c ref pthread_cleanup_push / pthread_cleanup_pop
161 The @code{open} function is the underlying primitive for the @code{fopen}
162 and @code{freopen} functions, that create streams.
163 @end deftypefun
165 @comment fcntl.h
166 @comment Unix98
167 @deftypefun int open64 (const char *@var{filename}, int @var{flags}[, mode_t @var{mode}])
168 This function is similar to @code{open}.  It returns a file descriptor
169 which can be used to access the file named by @var{filename}.  The only
170 the difference is that on 32 bits systems the file is opened in the
171 large file mode.  I.e., file length and file offsets can exceed 31 bits.
173 When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this
174 function is actually available under the name @code{open}.  I.e., the
175 new, extended API using 64 bit file sizes and offsets transparently
176 replaces the old API.
177 @end deftypefun
179 @comment fcntl.h
180 @comment POSIX.1
181 @deftypefn {Obsolete function} int creat (const char *@var{filename}, mode_t @var{mode})
182 This function is obsolete.  The call:
184 @smallexample
185 creat (@var{filename}, @var{mode})
186 @end smallexample
188 @noindent
189 is equivalent to:
191 @smallexample
192 open (@var{filename}, O_WRONLY | O_CREAT | O_TRUNC, @var{mode})
193 @end smallexample
195 If on a 32 bits machine the sources are translated with
196 @code{_FILE_OFFSET_BITS == 64} the function @code{creat} returns a file
197 descriptor opened in the large file mode which enables the file handling
198 functions to use files up to @math{2^63} in size and offset from
199 @math{-2^63} to @math{2^63}.  This happens transparently for the user
200 since all of the lowlevel file handling functions are equally replaced.
201 @end deftypefn
203 @comment fcntl.h
204 @comment Unix98
205 @deftypefn {Obsolete function} int creat64 (const char *@var{filename}, mode_t @var{mode})
206 This function is similar to @code{creat}.  It returns a file descriptor
207 which can be used to access the file named by @var{filename}.  The only
208 the difference is that on 32 bits systems the file is opened in the
209 large file mode.  I.e., file length and file offsets can exceed 31 bits.
211 To use this file descriptor one must not use the normal operations but
212 instead the counterparts named @code{*64}, e.g., @code{read64}.
214 When the sources are translated with @code{_FILE_OFFSET_BITS == 64} this
215 function is actually available under the name @code{open}.  I.e., the
216 new, extended API using 64 bit file sizes and offsets transparently
217 replaces the old API.
218 @end deftypefn
220 @comment unistd.h
221 @comment POSIX.1
222 @deftypefun int close (int @var{filedes})
223 The function @code{close} closes the file descriptor @var{filedes}.
224 Closing a file has the following consequences:
226 @itemize @bullet
227 @item
228 The file descriptor is deallocated.
230 @item
231 Any record locks owned by the process on the file are unlocked.
233 @item
234 When all file descriptors associated with a pipe or FIFO have been closed,
235 any unread data is discarded.
236 @end itemize
238 This function is a cancelation point in multi-threaded programs.  This
239 is a problem if the thread allocates some resources (like memory, file
240 descriptors, semaphores or whatever) at the time @code{close} is
241 called.  If the thread gets canceled these resources stay allocated
242 until the program ends.  To avoid this calls to @code{close} should be
243 protected using cancelation handlers.
244 @c ref pthread_cleanup_push / pthread_cleanup_pop
246 The normal return value from @code{close} is @math{0}; a value of @math{-1}
247 is returned in case of failure.  The following @code{errno} error
248 conditions are defined for this function:
250 @table @code
251 @item EBADF
252 The @var{filedes} argument is not a valid file descriptor.
254 @item EINTR
255 The @code{close} call was interrupted by a signal.
256 @xref{Interrupted Primitives}.
257 Here is an example of how to handle @code{EINTR} properly:
259 @smallexample
260 TEMP_FAILURE_RETRY (close (desc));
261 @end smallexample
263 @item ENOSPC
264 @itemx EIO
265 @itemx EDQUOT
266 When the file is accessed by NFS, these errors from @code{write} can sometimes
267 not be detected until @code{close}.  @xref{I/O Primitives}, for details
268 on their meaning.
269 @end table
271 Please note that there is @emph{no} separate @code{close64} function.
272 This is not necessary since this function does not determine nor depend
273 on the mode of the file.  The kernel which performs the @code{close}
274 operation knows for which mode the descriptor is used and can handle
275 this situation.
276 @end deftypefun
278 To close a stream, call @code{fclose} (@pxref{Closing Streams}) instead
279 of trying to close its underlying file descriptor with @code{close}.
280 This flushes any buffered output and updates the stream object to
281 indicate that it is closed.
284 @node Truncating Files
285 @section Change the size of a file
287 In some situations it is useful to explicitly determine the size of a
288 file.  Since the 4.2BSD days there is a function to truncate a file to
289 at most a given number of bytes and POSIX defines one additional
290 function.  The prototypes for these functions are in @file{unistd.h}.
292 @comment unistd.h
293 @comment X/Open
294 @deftypefun int truncate (const char *@var{name}, off_t @var{length})
295 The @code{truncation} function truncates the file named by @var{name} to
296 at most @var{length} bytes.  I.e., if the file was larger before the
297 extra bytes are stripped of.  If the file was small or equal to
298 @var{length} in size before nothing is done.  The file must be writable
299 by the user to perform this operation.
301 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
302 @code{truncate} function is in fact @code{truncate64} and the type
303 @code{off_t} has 64 bits which makes it possible to handle files up to
304 @math{2^63} bytes in length.
306 The return value is zero is everything went ok.  Otherwise the return
307 value is @math{-1} and the global variable @var{errno} is set to:
308 @table @code
309 @item EACCES
310 The file is not accessible to the user.
311 @item EINVAL
312 The @var{length} value is illegal.
313 @item EISDIR
314 The object named by @var{name} is a directory.
315 @item ENOENT
316 The file named by @var{name} does not exist.
317 @item ENOTDIR
318 One part of the @var{name} is not a directory.
319 @end table
321 This function was introduced in 4.2BSD but also was available in later
322 @w{System V} systems.  It is not added to POSIX since the authors felt
323 it is only of marginally additional utility.  See below.
324 @end deftypefun
326 @comment unistd.h
327 @comment Unix98
328 @deftypefun int truncate64 (const char *@var{name}, off64_t @var{length})
329 This function is similar to the @code{truncate} function.  The
330 difference is that the @var{length} argument is 64 bits wide even on 32
331 bits machines which allows to handle file with a size up to @math{2^63}
332 bytes.
334 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a
335 32 bits machine this function is actually available under the name
336 @code{truncate} and so transparently replaces the 32 bits interface.
337 @end deftypefun
339 @comment unistd.h
340 @comment POSIX
341 @deftypefun int ftruncate (int @var{fd}, off_t @var{length})
342 The @code{ftruncate} function is similar to the @code{truncate}
343 function.  The main difference is that it takes a descriptor for an
344 opened file instead of a file name to identify the object.  The file
345 must be opened for writing to successfully carry out the operation.
347 The POSIX standard leaves it implementation defined what happens if the
348 specified new @var{length} of the file is bigger than the original size.
349 The @code{ftruncate} function might simply leave the file alone and do
350 nothing or it can increase the size to the desired size.  In this later
351 case the extended area should be zero-filled.  So using @code{ftruncate}
352 is no reliable way to increase the file size but if it is possible it is
353 probably the fastest way.  The function also operates on POSIX shared
354 memory segments if these are implemented by the system.
356 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
357 @code{ftruncate} function is in fact @code{ftruncate64} and the type
358 @code{off_t} has 64 bits which makes it possible to handle files up to
359 @math{2^63} bytes in length.
361 On success the function returns zero.  Otherwise it returns @math{-1}
362 and set @var{errno} to one of these values:
363 @table @code
364 @item EBADF
365 @var{fd} is no valid file descriptor or is not opened for writing.
366 @item EINVAL
367 The object referred to by @var{fd} does not permit this operation.
368 @item EROFS
369 The file is on a read-only file system.
370 @end table
371 @end deftypefun
373 @comment unistd.h
374 @comment Unix98
375 @deftypefun int ftruncate64 (int @var{id}, off64_t @var{length})
376 This function is similar to the @code{ftruncate} function.  The
377 difference is that the @var{length} argument is 64 bits wide even on 32
378 bits machines which allows to handle file with a size up to @math{2^63}
379 bytes.
381 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a
382 32 bits machine this function is actually available under the name
383 @code{ftruncate} and so transparently replaces the 32 bits interface.
384 @end deftypefun
386 @node I/O Primitives
387 @section Input and Output Primitives
389 This section describes the functions for performing primitive input and
390 output operations on file descriptors: @code{read}, @code{write}, and
391 @code{lseek}.  These functions are declared in the header file
392 @file{unistd.h}.
393 @pindex unistd.h
395 @comment unistd.h
396 @comment POSIX.1
397 @deftp {Data Type} ssize_t
398 This data type is used to represent the sizes of blocks that can be
399 read or written in a single operation.  It is similar to @code{size_t},
400 but must be a signed type.
401 @end deftp
403 @cindex reading from a file descriptor
404 @comment unistd.h
405 @comment POSIX.1
406 @deftypefun ssize_t read (int @var{filedes}, void *@var{buffer}, size_t @var{size})
407 The @code{read} function reads up to @var{size} bytes from the file
408 with descriptor @var{filedes}, storing the results in the @var{buffer}.
409 (This is not necessarily a character string and there is no terminating
410 null character added.)
412 @cindex end-of-file, on a file descriptor
413 The return value is the number of bytes actually read.  This might be
414 less than @var{size}; for example, if there aren't that many bytes left
415 in the file or if there aren't that many bytes immediately available.
416 The exact behavior depends on what kind of file it is.  Note that
417 reading less than @var{size} bytes is not an error.
419 A value of zero indicates end-of-file (except if the value of the
420 @var{size} argument is also zero).  This is not considered an error.
421 If you keep calling @code{read} while at end-of-file, it will keep
422 returning zero and doing nothing else.
424 If @code{read} returns at least one character, there is no way you can
425 tell whether end-of-file was reached.  But if you did reach the end, the
426 next read will return zero.
428 In case of an error, @code{read} returns @math{-1}.  The following
429 @code{errno} error conditions are defined for this function:
431 @table @code
432 @item EAGAIN
433 Normally, when no input is immediately available, @code{read} waits for
434 some input.  But if the @code{O_NONBLOCK} flag is set for the file
435 (@pxref{File Status Flags}), @code{read} returns immediately without
436 reading any data, and reports this error.
438 @strong{Compatibility Note:} Most versions of BSD Unix use a different
439 error code for this: @code{EWOULDBLOCK}.  In the GNU library,
440 @code{EWOULDBLOCK} is an alias for @code{EAGAIN}, so it doesn't matter
441 which name you use.
443 On some systems, reading a large amount of data from a character special
444 file can also fail with @code{EAGAIN} if the kernel cannot find enough
445 physical memory to lock down the user's pages.  This is limited to
446 devices that transfer with direct memory access into the user's memory,
447 which means it does not include terminals, since they always use
448 separate buffers inside the kernel.  This problem never happens in the
449 GNU system.
451 Any condition that could result in @code{EAGAIN} can instead result in a
452 successful @code{read} which returns fewer bytes than requested.
453 Calling @code{read} again immediately would result in @code{EAGAIN}.
455 @item EBADF
456 The @var{filedes} argument is not a valid file descriptor,
457 or is not open for reading.
459 @item EINTR
460 @code{read} was interrupted by a signal while it was waiting for input.
461 @xref{Interrupted Primitives}.  A signal will not necessary cause
462 @code{read} to return @code{EINTR}; it may instead result in a
463 successful @code{read} which returns fewer bytes than requested.
465 @item EIO
466 For many devices, and for disk files, this error code indicates
467 a hardware error.
469 @code{EIO} also occurs when a background process tries to read from the
470 controlling terminal, and the normal action of stopping the process by
471 sending it a @code{SIGTTIN} signal isn't working.  This might happen if
472 signal is being blocked or ignored, or because the process group is
473 orphaned.  @xref{Job Control}, for more information about job control,
474 and @ref{Signal Handling}, for information about signals.
475 @end table
477 Please note that there is no function named @code{read64}.  This is not
478 necessary since this function does not directly modify or handle the
479 possibly wide file offset.  Since the kernel handles this state
480 internally the @code{read} function can be used for all cases.
482 This function is a cancelation point in multi-threaded programs.  This
483 is a problem if the thread allocates some resources (like memory, file
484 descriptors, semaphores or whatever) at the time @code{read} is
485 called.  If the thread gets canceled these resources stay allocated
486 until the program ends.  To avoid this calls to @code{read} should be
487 protected using cancelation handlers.
488 @c ref pthread_cleanup_push / pthread_cleanup_pop
490 The @code{read} function is the underlying primitive for all of the
491 functions that read from streams, such as @code{fgetc}.
492 @end deftypefun
494 @comment unistd.h
495 @comment Unix98
496 @deftypefun ssize_t pread (int @var{filedes}, void *@var{buffer}, size_t @var{size}, off_t @var{offset})
497 The @code{pread} function is similar to the @code{read} function.  The
498 first three arguments are identical and also the return values and error
499 codes correspond.
501 The difference is the fourth argument and its handling.  The data block
502 is not read from the current position of the file descriptor
503 @code{filedes}.  Instead the data is read from the file starting at
504 position @var{offset}.  The position of the file descriptor itself is
505 not effected by the operation.  The value is the same as before the call.
507 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
508 @code{pread} function is in fact @code{pread64} and the type
509 @code{off_t} has 64 bits which makes it possible to handle files up to
510 @math{2^63} bytes in length.
512 The return value of @code{pread} describes the number of bytes read.
513 In the error case it returns @math{-1} like @code{read} does and the
514 error codes are also the same.  Only there are a few more error codes:
515 @table @code
516 @item EINVAL
517 The value given for @var{offset} is negative and therefore illegal.
519 @item ESPIPE
520 The file descriptor @var{filedes} is associate with a pipe or a FIFO and
521 this device does not allow positioning of the file pointer.
522 @end table
524 The function is an extension defined in the Unix Single Specification
525 version 2.
526 @end deftypefun
528 @comment unistd.h
529 @comment Unix98
530 @deftypefun ssize_t pread64 (int @var{filedes}, void *@var{buffer}, size_t @var{size}, off64_t @var{offset})
531 This function is similar to the @code{pread} function.  The difference
532 is that the @var{offset} parameter is of type @code{off64_t} instead of
533 @code{off_t} which makes it possible on 32 bits machines to address
534 files larger than @math{2^31} bytes and up to @math{2^63} bytes.  The
535 file descriptor @code{filedes} must be opened using @code{open64} since
536 otherwise the large offsets possible with @code{off64_t} will lead to
537 errors with a descriptor in small file mode.
539 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a
540 32 bits machine this function is actually available under the name
541 @code{pread} and so transparently replaces the 32 bits interface.
542 @end deftypefun
544 @cindex writing to a file descriptor
545 @comment unistd.h
546 @comment POSIX.1
547 @deftypefun ssize_t write (int @var{filedes}, const void *@var{buffer}, size_t @var{size})
548 The @code{write} function writes up to @var{size} bytes from
549 @var{buffer} to the file with descriptor @var{filedes}.  The data in
550 @var{buffer} is not necessarily a character string and a null character is
551 output like any other character.
553 The return value is the number of bytes actually written.  This may be
554 @var{size}, but can always be smaller.  Your program should always call
555 @code{write} in a loop, iterating until all the data is written.
557 Once @code{write} returns, the data is enqueued to be written and can be
558 read back right away, but it is not necessarily written out to permanent
559 storage immediately.  You can use @code{fsync} when you need to be sure
560 your data has been permanently stored before continuing.  (It is more
561 efficient for the system to batch up consecutive writes and do them all
562 at once when convenient.  Normally they will always be written to disk
563 within a minute or less.)  Modern systems provide another function
564 @code{fdatasync} which guarantees integrity only for the file data and
565 is therefore faster.
566 @c !!! xref fsync, fdatasync
567 You can use the @code{O_FSYNC} open mode to make @code{write} always
568 store the data to disk before returning; @pxref{Operating Modes}.
570 In the case of an error, @code{write} returns @math{-1}.  The following
571 @code{errno} error conditions are defined for this function:
573 @table @code
574 @item EAGAIN
575 Normally, @code{write} blocks until the write operation is complete.
576 But if the @code{O_NONBLOCK} flag is set for the file (@pxref{Control
577 Operations}), it returns immediately without writing any data, and
578 reports this error.  An example of a situation that might cause the
579 process to block on output is writing to a terminal device that supports
580 flow control, where output has been suspended by receipt of a STOP
581 character.
583 @strong{Compatibility Note:} Most versions of BSD Unix use a different
584 error code for this: @code{EWOULDBLOCK}.  In the GNU library,
585 @code{EWOULDBLOCK} is an alias for @code{EAGAIN}, so it doesn't matter
586 which name you use.
588 On some systems, writing a large amount of data from a character special
589 file can also fail with @code{EAGAIN} if the kernel cannot find enough
590 physical memory to lock down the user's pages.  This is limited to
591 devices that transfer with direct memory access into the user's memory,
592 which means it does not include terminals, since they always use
593 separate buffers inside the kernel.  This problem does not arise in the
594 GNU system.
596 @item EBADF
597 The @var{filedes} argument is not a valid file descriptor,
598 or is not open for writing.
600 @item EFBIG
601 The size of the file would become larger than the implementation can support.
603 @item EINTR
604 The @code{write} operation was interrupted by a signal while it was
605 blocked waiting for completion.  A signal will not necessary cause
606 @code{write} to return @code{EINTR}; it may instead result in a
607 successful @code{write} which writes fewer bytes than requested.
608 @xref{Interrupted Primitives}.
610 @item EIO
611 For many devices, and for disk files, this error code indicates
612 a hardware error.
614 @item ENOSPC
615 The device containing the file is full.
617 @item EPIPE
618 This error is returned when you try to write to a pipe or FIFO that
619 isn't open for reading by any process.  When this happens, a @code{SIGPIPE}
620 signal is also sent to the process; see @ref{Signal Handling}.
621 @end table
623 Unless you have arranged to prevent @code{EINTR} failures, you should
624 check @code{errno} after each failing call to @code{write}, and if the
625 error was @code{EINTR}, you should simply repeat the call.
626 @xref{Interrupted Primitives}.  The easy way to do this is with the
627 macro @code{TEMP_FAILURE_RETRY}, as follows:
629 @smallexample
630 nbytes = TEMP_FAILURE_RETRY (write (desc, buffer, count));
631 @end smallexample
633 Please note that there is no function named @code{write64}.  This is not
634 necessary since this function does not directly modify or handle the
635 possibly wide file offset.  Since the kernel handles this state
636 internally the @code{write} function can be used for all cases.
638 This function is a cancelation point in multi-threaded programs.  This
639 is a problem if the thread allocates some resources (like memory, file
640 descriptors, semaphores or whatever) at the time @code{write} is
641 called.  If the thread gets canceled these resources stay allocated
642 until the program ends.  To avoid this calls to @code{write} should be
643 protected using cancelation handlers.
644 @c ref pthread_cleanup_push / pthread_cleanup_pop
646 The @code{write} function is the underlying primitive for all of the
647 functions that write to streams, such as @code{fputc}.
648 @end deftypefun
650 @comment unistd.h
651 @comment Unix98
652 @deftypefun ssize_t pwrite (int @var{filedes}, const void *@var{buffer}, size_t @var{size}, off_t @var{offset})
653 The @code{pwrite} function is similar to the @code{write} function.  The
654 first three arguments are identical and also the return values and error
655 codes correspond.
657 The difference is the fourth argument and its handling.  The data block
658 is not written to the current position of the file descriptor
659 @code{filedes}.  Instead the data is written to the file starting at
660 position @var{offset}.  The position of the file descriptor itself is
661 not effected by the operation.  The value is the same as before the call.
663 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
664 @code{pwrite} function is in fact @code{pwrite64} and the type
665 @code{off_t} has 64 bits which makes it possible to handle files up to
666 @math{2^63} bytes in length.
668 The return value of @code{pwrite} describes the number of written bytes.
669 In the error case it returns @math{-1} like @code{write} does and the
670 error codes are also the same.  Only there are a few more error codes:
671 @table @code
672 @item EINVAL
673 The value given for @var{offset} is negative and therefore illegal.
675 @item ESPIPE
676 The file descriptor @var{filedes} is associate with a pipe or a FIFO and
677 this device does not allow positioning of the file pointer.
678 @end table
680 The function is an extension defined in the Unix Single Specification
681 version 2.
682 @end deftypefun
684 @comment unistd.h
685 @comment Unix98
686 @deftypefun ssize_t pwrite64 (int @var{filedes}, const void *@var{buffer}, size_t @var{size}, off64_t @var{offset})
687 This function is similar to the @code{pwrite} function.  The difference
688 is that the @var{offset} parameter is of type @code{off64_t} instead of
689 @code{off_t} which makes it possible on 32 bits machines to address
690 files larger than @math{2^31} bytes and up to @math{2^63} bytes.  The
691 file descriptor @code{filedes} must be opened using @code{open64} since
692 otherwise the large offsets possible with @code{off64_t} will lead to
693 errors with a descriptor in small file mode.
695 When the source file is compiled using @code{_FILE_OFFSET_BITS == 64} on a
696 32 bits machine this function is actually available under the name
697 @code{pwrite} and so transparently replaces the 32 bits interface.
698 @end deftypefun
701 @node File Position Primitive
702 @section Setting the File Position of a Descriptor
704 Just as you can set the file position of a stream with @code{fseek}, you
705 can set the file position of a descriptor with @code{lseek}.  This
706 specifies the position in the file for the next @code{read} or
707 @code{write} operation.  @xref{File Positioning}, for more information
708 on the file position and what it means.
710 To read the current file position value from a descriptor, use
711 @code{lseek (@var{desc}, 0, SEEK_CUR)}.
713 @cindex file positioning on a file descriptor
714 @cindex positioning a file descriptor
715 @cindex seeking on a file descriptor
716 @comment unistd.h
717 @comment POSIX.1
718 @deftypefun off_t lseek (int @var{filedes}, off_t @var{offset}, int @var{whence})
719 The @code{lseek} function is used to change the file position of the
720 file with descriptor @var{filedes}.
722 The @var{whence} argument specifies how the @var{offset} should be
723 interpreted in the same way as for the @code{fseek} function, and must be
724 one of the symbolic constants @code{SEEK_SET}, @code{SEEK_CUR}, or
725 @code{SEEK_END}.
727 @table @code
728 @item SEEK_SET
729 Specifies that @var{whence} is a count of characters from the beginning
730 of the file.
732 @item SEEK_CUR
733 Specifies that @var{whence} is a count of characters from the current
734 file position.  This count may be positive or negative.
736 @item SEEK_END
737 Specifies that @var{whence} is a count of characters from the end of
738 the file.  A negative count specifies a position within the current
739 extent of the file; a positive count specifies a position past the
740 current end.  If you set the position past the current end, and
741 actually write data, you will extend the file with zeros up to that
742 position.@end table
744 The return value from @code{lseek} is normally the resulting file
745 position, measured in bytes from the beginning of the file.
746 You can use this feature together with @code{SEEK_CUR} to read the
747 current file position.
749 If you want to append to the file, setting the file position to the
750 current end of file with @code{SEEK_END} is not sufficient.  Another
751 process may write more data after you seek but before you write,
752 extending the file so the position you write onto clobbers their data.
753 Instead, use the @code{O_APPEND} operating mode; @pxref{Operating Modes}.
755 You can set the file position past the current end of the file.  This
756 does not by itself make the file longer; @code{lseek} never changes the
757 file.  But subsequent output at that position will extend the file.
758 Characters between the previous end of file and the new position are
759 filled with zeros.  Extending the file in this way can create a
760 ``hole'': the blocks of zeros are not actually allocated on disk, so the
761 file takes up less space than it appears so; it is then called a
762 ``sparse file''.
763 @cindex sparse files
764 @cindex holes in files
766 If the file position cannot be changed, or the operation is in some way
767 invalid, @code{lseek} returns a value of @math{-1}.  The following
768 @code{errno} error conditions are defined for this function:
770 @table @code
771 @item EBADF
772 The @var{filedes} is not a valid file descriptor.
774 @item EINVAL
775 The @var{whence} argument value is not valid, or the resulting
776 file offset is not valid.  A file offset is invalid.
778 @item ESPIPE
779 The @var{filedes} corresponds to an object that cannot be positioned,
780 such as a pipe, FIFO or terminal device.  (POSIX.1 specifies this error
781 only for pipes and FIFOs, but in the GNU system, you always get
782 @code{ESPIPE} if the object is not seekable.)
783 @end table
785 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} the
786 @code{lseek} function is in fact @code{lseek64} and the type
787 @code{off_t} has 64 bits which makes it possible to handle files up to
788 @math{2^63} bytes in length.
790 This function is a cancelation point in multi-threaded programs.  This
791 is a problem if the thread allocates some resources (like memory, file
792 descriptors, semaphores or whatever) at the time @code{lseek} is
793 called.  If the thread gets canceled these resources stay allocated
794 until the program ends.  To avoid this calls to @code{lseek} should be
795 protected using cancelation handlers.
796 @c ref pthread_cleanup_push / pthread_cleanup_pop
798 The @code{lseek} function is the underlying primitive for the
799 @code{fseek}, @code{fseeko}, @code{ftell}, @code{ftello} and
800 @code{rewind} functions, which operate on streams instead of file
801 descriptors.
802 @end deftypefun
804 @comment unistd.h
805 @comment Unix98
806 @deftypefun off64_t lseek64 (int @var{filedes}, off64_t @var{offset}, int @var{whence})
807 This function is similar to the @code{lseek} function.  The difference
808 is that the @var{offset} parameter is of type @code{off64_t} instead of
809 @code{off_t} which makes it possible on 32 bits machines to address
810 files larger than @math{2^31} bytes and up to @math{2^63} bytes.  The
811 file descriptor @code{filedes} must be opened using @code{open64} since
812 otherwise the large offsets possible with @code{off64_t} will lead to
813 errors with a descriptor in small file mode.
815 When the source file is compiled with @code{_FILE_OFFSET_BITS == 64} on a
816 32 bits machine this function is actually available under the name
817 @code{lseek} and so transparently replaces the 32 bits interface.
818 @end deftypefun
820 You can have multiple descriptors for the same file if you open the file
821 more than once, or if you duplicate a descriptor with @code{dup}.
822 Descriptors that come from separate calls to @code{open} have independent
823 file positions; using @code{lseek} on one descriptor has no effect on the
824 other.  For example,
826 @smallexample
827 @group
829   int d1, d2;
830   char buf[4];
831   d1 = open ("foo", O_RDONLY);
832   d2 = open ("foo", O_RDONLY);
833   lseek (d1, 1024, SEEK_SET);
834   read (d2, buf, 4);
836 @end group
837 @end smallexample
839 @noindent
840 will read the first four characters of the file @file{foo}.  (The
841 error-checking code necessary for a real program has been omitted here
842 for brevity.)
844 By contrast, descriptors made by duplication share a common file
845 position with the original descriptor that was duplicated.  Anything
846 which alters the file position of one of the duplicates, including
847 reading or writing data, affects all of them alike.  Thus, for example,
849 @smallexample
851   int d1, d2, d3;
852   char buf1[4], buf2[4];
853   d1 = open ("foo", O_RDONLY);
854   d2 = dup (d1);
855   d3 = dup (d2);
856   lseek (d3, 1024, SEEK_SET);
857   read (d1, buf1, 4);
858   read (d2, buf2, 4);
860 @end smallexample
862 @noindent
863 will read four characters starting with the 1024'th character of
864 @file{foo}, and then four more characters starting with the 1028'th
865 character.
867 @comment sys/types.h
868 @comment POSIX.1
869 @deftp {Data Type} off_t
870 This is an arithmetic data type used to represent file sizes.
871 In the GNU system, this is equivalent to @code{fpos_t} or @code{long int}.
873 If the source is compiled with @code{_FILE_OFFSET_BITS == 64} this type
874 is transparently replaced by @code{off64_t}.
875 @end deftp
877 @comment sys/types.h
878 @comment Unix98
879 @deftp {Data Type} off64_t
880 This type is used similar to @code{off_t}.  The difference is that even
881 on 32 bits machines, where the @code{off_t} type would have 32 bits,
882 @code{off64_t} has 64 bits and so is able to address files up to
883 @math{2^63} bytes in length.
885 When compiling with @code{_FILE_OFFSET_BITS == 64} this type is
886 available under the name @code{off_t}.
887 @end deftp
889 These aliases for the @samp{SEEK_@dots{}} constants exist for the sake
890 of compatibility with older BSD systems.  They are defined in two
891 different header files: @file{fcntl.h} and @file{sys/file.h}.
893 @table @code
894 @item L_SET
895 An alias for @code{SEEK_SET}.
897 @item L_INCR
898 An alias for @code{SEEK_CUR}.
900 @item L_XTND
901 An alias for @code{SEEK_END}.
902 @end table
904 @node Descriptors and Streams
905 @section Descriptors and Streams
906 @cindex streams, and file descriptors
907 @cindex converting file descriptor to stream
908 @cindex extracting file descriptor from stream
910 Given an open file descriptor, you can create a stream for it with the
911 @code{fdopen} function.  You can get the underlying file descriptor for
912 an existing stream with the @code{fileno} function.  These functions are
913 declared in the header file @file{stdio.h}.
914 @pindex stdio.h
916 @comment stdio.h
917 @comment POSIX.1
918 @deftypefun {FILE *} fdopen (int @var{filedes}, const char *@var{opentype})
919 The @code{fdopen} function returns a new stream for the file descriptor
920 @var{filedes}.
922 The @var{opentype} argument is interpreted in the same way as for the
923 @code{fopen} function (@pxref{Opening Streams}), except that
924 the @samp{b} option is not permitted; this is because GNU makes no
925 distinction between text and binary files.  Also, @code{"w"} and
926 @code{"w+"} do not cause truncation of the file; these have affect only
927 when opening a file, and in this case the file has already been opened.
928 You must make sure that the @var{opentype} argument matches the actual
929 mode of the open file descriptor.
931 The return value is the new stream.  If the stream cannot be created
932 (for example, if the modes for the file indicated by the file descriptor
933 do not permit the access specified by the @var{opentype} argument), a
934 null pointer is returned instead.
936 In some other systems, @code{fdopen} may fail to detect that the modes
937 for file descriptor do not permit the access specified by
938 @code{opentype}.  The GNU C library always checks for this.
939 @end deftypefun
941 For an example showing the use of the @code{fdopen} function,
942 see @ref{Creating a Pipe}.
944 @comment stdio.h
945 @comment POSIX.1
946 @deftypefun int fileno (FILE *@var{stream})
947 This function returns the file descriptor associated with the stream
948 @var{stream}.  If an error is detected (for example, if the @var{stream}
949 is not valid) or if @var{stream} does not do I/O to a file,
950 @code{fileno} returns @math{-1}.
951 @end deftypefun
953 @cindex standard file descriptors
954 @cindex file descriptors, standard
955 There are also symbolic constants defined in @file{unistd.h} for the
956 file descriptors belonging to the standard streams @code{stdin},
957 @code{stdout}, and @code{stderr}; see @ref{Standard Streams}.
958 @pindex unistd.h
960 @comment unistd.h
961 @comment POSIX.1
962 @table @code
963 @item STDIN_FILENO
964 @vindex STDIN_FILENO
965 This macro has value @code{0}, which is the file descriptor for
966 standard input.
967 @cindex standard input file descriptor
969 @comment unistd.h
970 @comment POSIX.1
971 @item STDOUT_FILENO
972 @vindex STDOUT_FILENO
973 This macro has value @code{1}, which is the file descriptor for
974 standard output.
975 @cindex standard output file descriptor
977 @comment unistd.h
978 @comment POSIX.1
979 @item STDERR_FILENO
980 @vindex STDERR_FILENO
981 This macro has value @code{2}, which is the file descriptor for
982 standard error output.
983 @end table
984 @cindex standard error file descriptor
986 @node Stream/Descriptor Precautions
987 @section Dangers of Mixing Streams and Descriptors
988 @cindex channels
989 @cindex streams and descriptors
990 @cindex descriptors and streams
991 @cindex mixing descriptors and streams
993 You can have multiple file descriptors and streams (let's call both
994 streams and descriptors ``channels'' for short) connected to the same
995 file, but you must take care to avoid confusion between channels.  There
996 are two cases to consider: @dfn{linked} channels that share a single
997 file position value, and @dfn{independent} channels that have their own
998 file positions.
1000 It's best to use just one channel in your program for actual data
1001 transfer to any given file, except when all the access is for input.
1002 For example, if you open a pipe (something you can only do at the file
1003 descriptor level), either do all I/O with the descriptor, or construct a
1004 stream from the descriptor with @code{fdopen} and then do all I/O with
1005 the stream.
1007 @menu
1008 * Linked Channels::        Dealing with channels sharing a file position.
1009 * Independent Channels::   Dealing with separately opened, unlinked channels.
1010 * Cleaning Streams::       Cleaning a stream makes it safe to use
1011                             another channel.
1012 @end menu
1014 @node Linked Channels
1015 @subsection Linked Channels
1016 @cindex linked channels
1018 Channels that come from a single opening share the same file position;
1019 we call them @dfn{linked} channels.  Linked channels result when you
1020 make a stream from a descriptor using @code{fdopen}, when you get a
1021 descriptor from a stream with @code{fileno}, when you copy a descriptor
1022 with @code{dup} or @code{dup2}, and when descriptors are inherited
1023 during @code{fork}.  For files that don't support random access, such as
1024 terminals and pipes, @emph{all} channels are effectively linked.  On
1025 random-access files, all append-type output streams are effectively
1026 linked to each other.
1028 @cindex cleaning up a stream
1029 If you have been using a stream for I/O, and you want to do I/O using
1030 another channel (either a stream or a descriptor) that is linked to it,
1031 you must first @dfn{clean up} the stream that you have been using.
1032 @xref{Cleaning Streams}.
1034 Terminating a process, or executing a new program in the process,
1035 destroys all the streams in the process.  If descriptors linked to these
1036 streams persist in other processes, their file positions become
1037 undefined as a result.  To prevent this, you must clean up the streams
1038 before destroying them.
1040 @node Independent Channels
1041 @subsection Independent Channels
1042 @cindex independent channels
1044 When you open channels (streams or descriptors) separately on a seekable
1045 file, each channel has its own file position.  These are called
1046 @dfn{independent channels}.
1048 The system handles each channel independently.  Most of the time, this
1049 is quite predictable and natural (especially for input): each channel
1050 can read or write sequentially at its own place in the file.  However,
1051 if some of the channels are streams, you must take these precautions:
1053 @itemize @bullet
1054 @item
1055 You should clean an output stream after use, before doing anything else
1056 that might read or write from the same part of the file.
1058 @item
1059 You should clean an input stream before reading data that may have been
1060 modified using an independent channel.  Otherwise, you might read
1061 obsolete data that had been in the stream's buffer.
1062 @end itemize
1064 If you do output to one channel at the end of the file, this will
1065 certainly leave the other independent channels positioned somewhere
1066 before the new end.  You cannot reliably set their file positions to the
1067 new end of file before writing, because the file can always be extended
1068 by another process between when you set the file position and when you
1069 write the data.  Instead, use an append-type descriptor or stream; they
1070 always output at the current end of the file.  In order to make the
1071 end-of-file position accurate, you must clean the output channel you
1072 were using, if it is a stream.
1074 It's impossible for two channels to have separate file pointers for a
1075 file that doesn't support random access.  Thus, channels for reading or
1076 writing such files are always linked, never independent.  Append-type
1077 channels are also always linked.  For these channels, follow the rules
1078 for linked channels; see @ref{Linked Channels}.
1080 @node Cleaning Streams
1081 @subsection Cleaning Streams
1083 On the GNU system, you can clean up any stream with @code{fclean}:
1085 @comment stdio.h
1086 @comment GNU
1087 @deftypefun int fclean (FILE *@var{stream})
1088 Clean up the stream @var{stream} so that its buffer is empty.  If
1089 @var{stream} is doing output, force it out.  If @var{stream} is doing
1090 input, give the data in the buffer back to the system, arranging to
1091 reread it.
1092 @end deftypefun
1094 On other systems, you can use @code{fflush} to clean a stream in most
1095 cases.
1097 You can skip the @code{fclean} or @code{fflush} if you know the stream
1098 is already clean.  A stream is clean whenever its buffer is empty.  For
1099 example, an unbuffered stream is always clean.  An input stream that is
1100 at end-of-file is clean.  A line-buffered stream is clean when the last
1101 character output was a newline.
1103 There is one case in which cleaning a stream is impossible on most
1104 systems.  This is when the stream is doing input from a file that is not
1105 random-access.  Such streams typically read ahead, and when the file is
1106 not random access, there is no way to give back the excess data already
1107 read.  When an input stream reads from a random-access file,
1108 @code{fflush} does clean the stream, but leaves the file pointer at an
1109 unpredictable place; you must set the file pointer before doing any
1110 further I/O.  On the GNU system, using @code{fclean} avoids both of
1111 these problems.
1113 Closing an output-only stream also does @code{fflush}, so this is a
1114 valid way of cleaning an output stream.  On the GNU system, closing an
1115 input stream does @code{fclean}.
1117 You need not clean a stream before using its descriptor for control
1118 operations such as setting terminal modes; these operations don't affect
1119 the file position and are not affected by it.  You can use any
1120 descriptor for these operations, and all channels are affected
1121 simultaneously.  However, text already ``output'' to a stream but still
1122 buffered by the stream will be subject to the new terminal modes when
1123 subsequently flushed.  To make sure ``past'' output is covered by the
1124 terminal settings that were in effect at the time, flush the output
1125 streams for that terminal before setting the modes.  @xref{Terminal
1126 Modes}.
1128 @node Scatter-Gather
1129 @section Fast Scatter-Gather I/O
1130 @cindex scatter-gather
1132 Some applications may need to read or write data to multiple buffers,
1133 which are seperated in memory.  Although this can be done easily enough
1134 with multiple calls to @code{read} and @code{write}, it is inefficent
1135 because there is overhead associated with each kernel call.
1137 Instead, many platforms provide special high-speed primitives to perform
1138 these @dfn{scatter-gather} operations in a single kernel call.  The GNU C
1139 library will provide an emulation on any system that lacks these
1140 primitives, so they are not a portability threat.  They are defined in
1141 @code{sys/uio.h}.
1143 These functions are controlled with arrays of @code{iovec} structures,
1144 which describe the location and size of each buffer.
1146 @deftp {Data Type} {struct iovec}
1148 The @code{iovec} structure describes a buffer. It contains two fields:
1150 @table @code
1152 @item void *iov_base
1153 Contains the address of a buffer.
1155 @item size_t iov_len
1156 Contains the length of the buffer.
1158 @end table
1159 @end deftp
1161 @deftypefun ssize_t readv (int @var{filedes}, const struct iovec *@var{vector}, int @var{count})
1163 The @code{readv} function reads data from @var{filedes} and scatters it
1164 into the buffers described in @var{vector}, which is taken to be
1165 @var{count} structures long.  As each buffer is filled, data is sent to the
1166 next.
1168 Note that @code{readv} is not guaranteed to fill all the buffers.
1169 It may stop at any point, for the same reasons @code{read} would.
1171 The return value is a count of bytes (@emph{not} buffers) read, @math{0}
1172 indicating end-of-file, or @math{-1} indicating an error.  The possible
1173 errors are the same as in @code{read}.
1175 @end deftypefun
1177 @deftypefun ssize_t writev (int @var{filedes}, const struct iovec *@var{vector}, int @var{count})
1179 The @code{writev} function gathers data from the buffers described in
1180 @var{vector}, which is taken to be @var{count} structures long, and writes
1181 them to @code{filedes}.  As each buffer is written, it moves on to the
1182 next.
1184 Like @code{readv}, @code{writev} may stop midstream under the same
1185 conditions @code{write} would.
1187 The return value is a count of bytes written, or @math{-1} indicating an
1188 error.  The possible errors are the same as in @code{write}.
1190 @end deftypefun
1192 @c Note - I haven't read this anywhere. I surmised it from my knowledge
1193 @c of computer science. Thus, there could be subtleties I'm missing.
1195 Note that if the buffers are small (under about 1kB), high-level streams
1196 may be easier to use than these functions.  However, @code{readv} and
1197 @code{writev} are more efficient when the individual buffers themselves
1198 (as opposed to the total output), are large.  In that case, a high-level
1199 stream would not be able to cache the data effectively.
1201 @node Memory-mapped I/O
1202 @section Memory-mapped I/O
1204 On modern operating systems, it is possible to @dfn{mmap} (pronounced
1205 ``em-map'') a file to a region of memory.  When this is done, the file can
1206 be accessed just like an array in the program.
1208 This is more efficent than @code{read} or @code{write}, as only regions
1209 of the file a program actually accesses are loaded.  Accesses to
1210 not-yet-loaded parts of the mmapped region are handled in the same way as
1211 swapped out pages.
1213 Since mmapped pages can be stored back to their file when physical memory
1214 is low, it is possible to mmap files orders of magnitude larger than both
1215 the physical memory @emph{and} swap space.  The only limit is address
1216 space.  The theoretical limit is 4GB on a 32-bit machine - however, the
1217 actual limit will be smaller since some areas will be reserved for other
1218 purposes.
1220 Memory mapping only works on entire pages of memory.  Thus, addresses
1221 for mapping must be page-aligned, and length values will be rounded up.
1222 To determine the size of a page the machine uses one should use
1224 @smallexample
1225 size_t page_size = (size_t) sysconf (_SC_PAGESIZE);
1226 @end smallexample
1228 These functions are declared in @file{sys/mman.h}.
1230 @deftypefun {void *} mmap (void *@var{address}, size_t @var{length},int @var{protect}, int @var{flags}, int @var{filedes}, off_t @var{offset})
1232 The @code{mmap} function creates a new mapping, connected to bytes
1233 (@var{offset}) to (@var{offset} + @var{length}) in the file open on
1234 @var{filedes}.
1236 @var{address} gives a preferred starting address for the mapping.
1237 @code{NULL} expresses no preference. Any previous mapping at that
1238 address is automatically removed. The address you give may still be
1239 changed, unless you use the @code{MAP_FIXED} flag.
1241 @vindex PROT_READ
1242 @vindex PROT_WRITE
1243 @vindex PROT_EXEC
1244 @var{protect} contains flags that control what kind of access is
1245 permitted.  They include @code{PROT_READ}, @code{PROT_WRITE}, and
1246 @code{PROT_EXEC}, which permit reading, writing, and execution,
1247 respectively.  Inappropriate access will cause a segfault (@pxref{Program
1248 Error Signals}).
1250 Note that most hardware designs cannot support write permission without
1251 read permission, and many do not distinguish read and execute permission.
1252 Thus, you may recieve wider permissions than you ask for, and mappings of
1253 write-only files may be denied even if you do not use @code{PROT_READ}.
1255 @var{flags} contains flags that control the nature of the map.
1256 One of @code{MAP_SHARED} or @code{MAP_PRIVATE} must be specified.
1258 They include:
1260 @vtable @code
1261 @item MAP_PRIVATE
1262 This specifies that writes to the region should never be written back
1263 to the attached file.  Instead, a copy is made for the process, and the
1264 region will be swapped normally if memory runs low.  No other process will
1265 see the changes.
1267 Since private mappings effectively revert to ordinary memory
1268 when written to, you must have enough virtual memory for a copy of
1269 the entire mmapped region if you use this mode with @code{PROT_WRITE}.
1271 @item MAP_SHARED
1272 This specifies that writes to the region will be written back to the
1273 file.  Changes made will be shared immediately with other processes
1274 mmaping the same file.
1276 Note that actual writing may take place at any time.  You need to use
1277 @code{msync}, described below, if it is important that other processes
1278 using conventional I/O get a consistent view of the file.
1280 @item MAP_FIXED
1281 This forces the system to use the exact mapping address specified in
1282 @var{address} and fail if it can't.
1284 @c One of these is official - the other is obviously an obsolete synonym
1285 @c Which is which?
1286 @item MAP_ANONYMOUS
1287 @itemx MAP_ANON
1288 This flag tells the system to create an anonymous mapping, not connected
1289 to a file.  @var{filedes} and @var{off} are ignored, and the region is
1290 initialized with zeros.
1292 Anonymous maps are used as the basic primitive to extend the heap on some
1293 systems.  They are also useful to share data between multiple tasks
1294 without creating a file.
1296 On some systems using private anonymous mmaps is more efficent than using
1297 @code{malloc} for large blocks.  This is not an issue with the GNU C library,
1298 as the included @code{malloc} automatically uses @code{mmap} where appropriate.
1300 @c Linux has some other MAP_ options, which I have not discussed here.
1301 @c MAP_DENYWRITE, MAP_EXECUTABLE and MAP_GROWSDOWN don't seem applicable to
1302 @c user programs (and I don't understand the last two). MAP_LOCKED does
1303 @c not appear to be implemented.
1305 @end vtable
1307 @code{mmap} returns the address of the new mapping, or @math{-1} for an
1308 error.
1310 Possible errors include:
1312 @table @code
1314 @item EINVAL
1316 Either @var{address} was unusable, or inconsistent @var{flags} were
1317 given.
1319 @item EACCES
1321 @var{filedes} was not open for the type of access specified in @var{protect}.
1323 @item ENOMEM
1325 Either there is not enough memory for the operation, or the process is
1326 out of address space.
1328 @item ENODEV
1330 This file is of a type that doesn't support mapping.
1332 @item ENOEXEC
1334 The file is on a filesystem that doesn't support mapping.
1336 @c On Linux, EAGAIN will appear if the file has a conflicting mandatory lock.
1337 @c However mandatory locks are not discussed in this manual.
1339 @c Similarly, ETXTBSY will occur if the MAP_DENYWRITE flag (not documented
1340 @c here) is used and the file is already open for writing.
1342 @end table
1344 @end deftypefun
1346 @deftypefun int munmap (void *@var{addr}, size_t @var{length})
1348 @code{munmap} removes any memory maps from (@var{addr}) to (@var{addr} +
1349 @var{length}).  @var{length} should be the length of the mapping.
1351 It is safe to un-map multiple mappings in one command, or include unmapped
1352 space in the range.  It is also possible to unmap only part of an existing
1353 mapping, however only entire pages can be removed.  If @var{length} is not
1354 an even number of pages, it will be rounded up.
1356 It returns @math{0} for success and @math{-1} for an error.
1358 One error is possible:
1360 @table @code
1362 @item EINVAL
1363 The memory range given was outside the user mmap range, or wasn't page
1364 aligned.
1366 @end table
1368 @end deftypefun
1370 @deftypefun int msync (void *@var{address}, size_t @var{length}, int @var{flags})
1372 When using shared mappings, the kernel can write the file at any time
1373 before the mapping is removed.  To be certain data has actually been
1374 written to the file and will be accessable to non-memory-mapped I/O, it
1375 is neccessary to use this function.
1377 It operates on the region @var{address} to (@var{address} + @var{length}).
1378 It may be used on part of a mapping or multiple mappings, however the
1379 region given should not contain any unmapped space.
1381 @var{flags} can contain some options:
1383 @vtable @code
1385 @item MS_SYNC
1387 This flag makes sure the data is actually written @emph{to disk}.
1388 Normally @code{msync} only makes sure that accesses to a file with
1389 conventional I/O reflect the recent changes.
1391 @item MS_ASYNC
1393 This tells @code{msync} to begin the synchronization, but not to wait for
1394 it to complete.
1396 @c Linux also has MS_INVALIDATE, which I don't understand.
1398 @end vtable
1400 @code{msync} returns @math{0} for success and @math{-1} for
1401 error.  Errors include:
1403 @table @code
1405 @item EINVAL
1406 An invalid region was given, or the @var{flags} were invalid.
1408 @item EFAULT
1409 There is no existing mapping in at least part of the given region.
1411 @end table
1413 @end deftypefun
1415 @deftypefun {void *} mremap (void *@var{address}, size_t @var{length}, size_t @var{new_length}, int @var{flag})
1417 This function can be used to change the size of an existing memory
1418 area. @var{address} and @var{length} must cover a region entirely mapped
1419 in the same @code{mmap} statement. A new mapping with the same
1420 characteristics will be returned, but a with the length @var{new_length}
1421 instead.
1423 One option is possible, @code{MREMAP_MAYMOVE}. If it is given in
1424 @var{flags}, the system may remove the existing mapping and create a new
1425 one of the desired length in another location.
1427 The address of the resulting mapping is returned, or @math{-1}. Possible
1428 error codes include:
1430 This function is only available on a few systems.  Except for performing
1431 optional optimizations one should not rely on this function.
1432 @table @code
1434 @item EFAULT
1435 There is no existing mapping in at least part of the original region, or
1436 the region covers two or more distinct mappings.
1438 @item EINVAL
1439 The address given is misaligned or inappropriate.
1441 @item EAGAIN
1442 The region has pages locked, and if extended it would exceed the
1443 process's resource limit for locked pages.  @xref{Limits on Resources}.
1445 @item ENOMEM
1446 The region is private writable, and insufficent virtual memory is
1447 available to extend it.  Also, this error will occur if
1448 @code{MREMAP_MAYMOVE} is not given and the extension would collide with
1449 another mapped region.
1451 @end table
1452 @end deftypefun
1454 Not all file descriptors may be mapped.  Sockets, pipes, and most devices
1455 only allow sequential access and do not fit into the mapping abstraction.
1456 In addition, some regular files may not be mmapable, and older kernels may
1457 not support mapping at all.  Thus, programs using @code{mmap} should
1458 have a fallback method to use should it fail. @xref{Mmap,,,standards,GNU
1459 Coding Standards}.
1461 @c XXX madvice documentation missing
1463 @node Waiting for I/O
1464 @section Waiting for Input or Output
1465 @cindex waiting for input or output
1466 @cindex multiplexing input
1467 @cindex input from multiple files
1469 Sometimes a program needs to accept input on multiple input channels
1470 whenever input arrives.  For example, some workstations may have devices
1471 such as a digitizing tablet, function button box, or dial box that are
1472 connected via normal asynchronous serial interfaces; good user interface
1473 style requires responding immediately to input on any device.  Another
1474 example is a program that acts as a server to several other processes
1475 via pipes or sockets.
1477 You cannot normally use @code{read} for this purpose, because this
1478 blocks the program until input is available on one particular file
1479 descriptor; input on other channels won't wake it up.  You could set
1480 nonblocking mode and poll each file descriptor in turn, but this is very
1481 inefficient.
1483 A better solution is to use the @code{select} function.  This blocks the
1484 program until input or output is ready on a specified set of file
1485 descriptors, or until a timer expires, whichever comes first.  This
1486 facility is declared in the header file @file{sys/types.h}.
1487 @pindex sys/types.h
1489 In the case of a server socket (@pxref{Listening}), we say that
1490 ``input'' is available when there are pending connections that could be
1491 accepted (@pxref{Accepting Connections}).  @code{accept} for server
1492 sockets blocks and interacts with @code{select} just as @code{read} does
1493 for normal input.
1495 @cindex file descriptor sets, for @code{select}
1496 The file descriptor sets for the @code{select} function are specified
1497 as @code{fd_set} objects.  Here is the description of the data type
1498 and some macros for manipulating these objects.
1500 @comment sys/types.h
1501 @comment BSD
1502 @deftp {Data Type} fd_set
1503 The @code{fd_set} data type represents file descriptor sets for the
1504 @code{select} function.  It is actually a bit array.
1505 @end deftp
1507 @comment sys/types.h
1508 @comment BSD
1509 @deftypevr Macro int FD_SETSIZE
1510 The value of this macro is the maximum number of file descriptors that a
1511 @code{fd_set} object can hold information about.  On systems with a
1512 fixed maximum number, @code{FD_SETSIZE} is at least that number.  On
1513 some systems, including GNU, there is no absolute limit on the number of
1514 descriptors open, but this macro still has a constant value which
1515 controls the number of bits in an @code{fd_set}; if you get a file
1516 descriptor with a value as high as @code{FD_SETSIZE}, you cannot put
1517 that descriptor into an @code{fd_set}.
1518 @end deftypevr
1520 @comment sys/types.h
1521 @comment BSD
1522 @deftypefn Macro void FD_ZERO (fd_set *@var{set})
1523 This macro initializes the file descriptor set @var{set} to be the
1524 empty set.
1525 @end deftypefn
1527 @comment sys/types.h
1528 @comment BSD
1529 @deftypefn Macro void FD_SET (int @var{filedes}, fd_set *@var{set})
1530 This macro adds @var{filedes} to the file descriptor set @var{set}.
1531 @end deftypefn
1533 @comment sys/types.h
1534 @comment BSD
1535 @deftypefn Macro void FD_CLR (int @var{filedes}, fd_set *@var{set})
1536 This macro removes @var{filedes} from the file descriptor set @var{set}.
1537 @end deftypefn
1539 @comment sys/types.h
1540 @comment BSD
1541 @deftypefn Macro int FD_ISSET (int @var{filedes}, fd_set *@var{set})
1542 This macro returns a nonzero value (true) if @var{filedes} is a member
1543 of the file descriptor set @var{set}, and zero (false) otherwise.
1544 @end deftypefn
1546 Next, here is the description of the @code{select} function itself.
1548 @comment sys/types.h
1549 @comment BSD
1550 @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})
1551 The @code{select} function blocks the calling process until there is
1552 activity on any of the specified sets of file descriptors, or until the
1553 timeout period has expired.
1555 The file descriptors specified by the @var{read-fds} argument are
1556 checked to see if they are ready for reading; the @var{write-fds} file
1557 descriptors are checked to see if they are ready for writing; and the
1558 @var{except-fds} file descriptors are checked for exceptional
1559 conditions.  You can pass a null pointer for any of these arguments if
1560 you are not interested in checking for that kind of condition.
1562 A file descriptor is considered ready for reading if it is at end of
1563 file.  A server socket is considered ready for reading if there is a
1564 pending connection which can be accepted with @code{accept};
1565 @pxref{Accepting Connections}.  A client socket is ready for writing when
1566 its connection is fully established; @pxref{Connecting}.
1568 ``Exceptional conditions'' does not mean errors---errors are reported
1569 immediately when an erroneous system call is executed, and do not
1570 constitute a state of the descriptor.  Rather, they include conditions
1571 such as the presence of an urgent message on a socket.  (@xref{Sockets},
1572 for information on urgent messages.)
1574 The @code{select} function checks only the first @var{nfds} file
1575 descriptors.  The usual thing is to pass @code{FD_SETSIZE} as the value
1576 of this argument.
1578 The @var{timeout} specifies the maximum time to wait.  If you pass a
1579 null pointer for this argument, it means to block indefinitely until one
1580 of the file descriptors is ready.  Otherwise, you should provide the
1581 time in @code{struct timeval} format; see @ref{High-Resolution
1582 Calendar}.  Specify zero as the time (a @code{struct timeval} containing
1583 all zeros) if you want to find out which descriptors are ready without
1584 waiting if none are ready.
1586 The normal return value from @code{select} is the total number of ready file
1587 descriptors in all of the sets.  Each of the argument sets is overwritten
1588 with information about the descriptors that are ready for the corresponding
1589 operation.  Thus, to see if a particular descriptor @var{desc} has input,
1590 use @code{FD_ISSET (@var{desc}, @var{read-fds})} after @code{select} returns.
1592 If @code{select} returns because the timeout period expires, it returns
1593 a value of zero.
1595 Any signal will cause @code{select} to return immediately.  So if your
1596 program uses signals, you can't rely on @code{select} to keep waiting
1597 for the full time specified.  If you want to be sure of waiting for a
1598 particular amount of time, you must check for @code{EINTR} and repeat
1599 the @code{select} with a newly calculated timeout based on the current
1600 time.  See the example below.  See also @ref{Interrupted Primitives}.
1602 If an error occurs, @code{select} returns @code{-1} and does not modify
1603 the argument file descriptor sets.  The following @code{errno} error
1604 conditions are defined for this function:
1606 @table @code
1607 @item EBADF
1608 One of the file descriptor sets specified an invalid file descriptor.
1610 @item EINTR
1611 The operation was interrupted by a signal.  @xref{Interrupted Primitives}.
1613 @item EINVAL
1614 The @var{timeout} argument is invalid; one of the components is negative
1615 or too large.
1616 @end table
1617 @end deftypefun
1619 @strong{Portability Note:}  The @code{select} function is a BSD Unix
1620 feature.
1622 Here is an example showing how you can use @code{select} to establish a
1623 timeout period for reading from a file descriptor.  The @code{input_timeout}
1624 function blocks the calling process until input is available on the
1625 file descriptor, or until the timeout period expires.
1627 @smallexample
1628 @include select.c.texi
1629 @end smallexample
1631 There is another example showing the use of @code{select} to multiplex
1632 input from multiple sockets in @ref{Server Example}.
1635 @node Synchronizing I/O
1636 @section Synchronizing I/O operations
1638 @cindex synchronizing
1639 In most modern operation systems the normal I/O operations are not
1640 executed synchronously.  I.e., even if a @code{write} system call
1641 returns this does not mean the data is actually written to the media,
1642 e.g., the disk.
1644 In situations where synchronization points are necessary the user can
1645 use special functions which ensure that all operations finished before
1646 they return.
1648 @comment unistd.h
1649 @comment X/Open
1650 @deftypefun int sync (void)
1651 A call to this function will not return as long as there is data which
1652 that is not written to the device.  All dirty buffers in the kernel will
1653 be written and so an overall consistent system can be achieved (if no
1654 other process in parallel writes data).
1656 A prototype for @code{sync} can be found in @file{unistd.h}.
1658 The return value is zero to indicate no error.
1659 @end deftypefun
1661 More often it is wanted that not all data in the system is committed.
1662 Programs want to ensure that data written to a given file are all
1663 committed and in this situation @code{sync} is overkill.
1665 @comment unistd.h
1666 @comment POSIX
1667 @deftypefun int fsync (int @var{fildes})
1668 The @code{fsync} can be used to make sure all data associated with the
1669 open file @var{fildes} is written to the device associated with the
1670 descriptor.  The function call does not return unless all actions have
1671 finished.
1673 A prototype for @code{fsync} can be found in @file{unistd.h}.
1675 This function is a cancelation point in multi-threaded programs.  This
1676 is a problem if the thread allocates some resources (like memory, file
1677 descriptors, semaphores or whatever) at the time @code{fsync} is
1678 called.  If the thread gets canceled these resources stay allocated
1679 until the program ends.  To avoid this calls to @code{fsync} should be
1680 protected using cancelation handlers.
1681 @c ref pthread_cleanup_push / pthread_cleanup_pop
1683 The return value of the function is zero if no error occured.  Otherwise
1684 it is @math{-1} and the global variable @var{errno} is set to the
1685 following values:
1686 @table @code
1687 @item EBADF
1688 The descriptor @var{fildes} is not valid.
1690 @item EINVAL
1691 No synchronization is possible since the system does not implement this.
1692 @end table
1693 @end deftypefun
1695 Sometimes it is not even necessary to write all data associated with a
1696 file descriptor.  E.g., in database files which do not change in size it
1697 is enough to write all the file content data to the device.
1698 Meta-information like the modification time etc. are not that important
1699 and leaving such information uncommitted does not prevent a successful
1700 recovering of the file in case of a problem.
1702 @comment unistd.h
1703 @comment POSIX
1704 @deftypefun int fdatasync (int @var{fildes})
1705 When a call to the @code{fdatasync} function returns it is made sure
1706 that all of the file data is written to the device.  For all pending I/O
1707 operations the parts guaranteeing data integrity finished.
1709 Not all systems implement the @code{fdatasync} operation.  On systems
1710 missing this functionality @code{fdatasync} is emulated by a call to
1711 @code{fsync} since the performed actions are a superset of those
1712 required by @code{fdatasyn}.
1714 The prototype for @code{fdatasync} is in @file{unistd.h}.
1716 The return value of the function is zero if no error occured.  Otherwise
1717 it is @math{-1} and the global variable @var{errno} is set to the
1718 following values:
1719 @table @code
1720 @item EBADF
1721 The descriptor @var{fildes} is not valid.
1723 @item EINVAL
1724 No synchronization is possible since the system does not implement this.
1725 @end table
1726 @end deftypefun
1729 @node Asynchronous I/O
1730 @section Perform I/O Operations in Parallel
1732 The POSIX.1b standard defines a new set of I/O operations which can
1733 reduce the time an application spends waiting at I/O significantly.  The
1734 new functions allow a program to initiate one or more I/O operations and
1735 then immediately resume the normal work while the I/O operations are
1736 executed in parallel.  The functionality is available if the
1737 @file{unistd.h} file defines the symbol @code{_POSIX_ASYNCHRONOUS_IO}.
1739 These functions are part of the library with realtime functions named
1740 @file{librt}.  They are not actually part of the @file{libc} binary.
1741 The implementation of these functions can be done using support in the
1742 kernel (if available) or using an implementation based on threads at
1743 userlevel.  In the latter case it might be necessary to link applications
1744 with the thread library @file{libpthread} in addition to @file{librt}.
1746 All AIO operations operate on files which were opened previously.  There
1747 might be arbitrary many operations for one file running.  The
1748 asynchronous I/O operations are controlled using a data structure named
1749 @code{struct aiocb} (@dfn{AIO control block}).  It is defined in
1750 @file{aio.h} as follows.
1752 @comment aio.h
1753 @comment POSIX.1b
1754 @deftp {Data Type} {struct aiocb}
1755 The POSIX.1b standard mandates that the @code{struct aiocb} structure
1756 contains at least the members described in the following table.  There
1757 might be more elements which are used by the implementation but
1758 depending on these elements is not portable and is highly deprecated.
1760 @table @code
1761 @item int aio_fildes
1762 This element specifies the file descriptor which is used for the
1763 operation.  It must be a legal descriptor since otherwise the operation
1764 fails for obvious reasons.
1766 The device on which the file is opened must allow the seek operation.
1767 I.e., it is not possible to use any of the AIO operations on devices
1768 like terminals where an @code{lseek} call would lead to an error.
1770 @item off_t aio_offset
1771 This element specifies at which offset in the file the operation (input
1772 or output) is performed.  Since the operations are carried out in arbitrary
1773 order and more than one operation for one file descriptor can be
1774 started, one cannot expect a current read/write position of the file
1775 descriptor.
1777 @item volatile void *aio_buf
1778 This is a pointer to the buffer with the data to be written or the place
1779 where the read data is stored.
1781 @item size_t aio_nbytes
1782 This element specifies the length of the buffer pointed to by @code{aio_buf}.
1784 @item int aio_reqprio
1785 If the platform has defined @code{_POSIX_PRIORITIZED_IO} and
1786 @code{_POSIX_PRIORITY_SCHEDULING} the AIO requests are
1787 processed based on the current scheduling priority.  The
1788 @code{aio_reqprio} element can then be used to lower the priority of the
1789 AIO operation.
1791 @item struct sigevent aio_sigevent
1792 This element specifies how the calling process is notified once the
1793 operation terminates.  If the @code{sigev_notify} element is
1794 @code{SIGEV_NONE} no notification is send.  If it is @code{SIGEV_SIGNAL}
1795 the signal determined by @code{sigev_signo} is send.  Otherwise
1796 @code{sigev_notify} must be @code{SIGEV_THREAD}.  In this case a thread
1797 is created which starts executing the function pointed to by
1798 @code{sigev_notify_function}.
1800 @item int aio_lio_opcode
1801 This element is only used by the @code{lio_listio} and
1802 @code{lio_listio64} functions.  Since these functions allow to start an
1803 arbitrary number of operations at once and since each operation can be
1804 input or output (or nothing) the information must be stored in the
1805 control block.  The possible values are:
1807 @vtable @code
1808 @item LIO_READ
1809 Start a read operation.  Read from the file at position
1810 @code{aio_offset} and store the next @code{aio_nbytes} bytes in the
1811 buffer pointed to by @code{aio_buf}.
1813 @item LIO_WRITE
1814 Start a write operation.  Write @code{aio_nbytes} bytes starting at
1815 @code{aio_buf} into the file starting at position @code{aio_offset}.
1817 @item LIO_NOP
1818 Do nothing for this control block.  This value is useful sometimes when
1819 an array of @code{struct aiocb} values contains holes, i.e., some of the
1820 values must not be handled although the whole array is presented to the
1821 @code{lio_listio} function.
1822 @end vtable
1823 @end table
1825 When the sources are compiled using @code{_FILE_OFFSET_BITS == 64} on a
1826 32 bits machine this type is in fact @code{struct aiocb64} since the LFS
1827 interface transparently replaces the @code{struct aiocb} definition.
1828 @end deftp
1830 For use with the AIO functions defined in the LFS there is a similar type
1831 defined which replaces the types of the appropriate members with larger
1832 types but otherwise is equivalent to @code{struct aiocb}.  Especially
1833 all member names are the same.
1835 @comment aio.h
1836 @comment POSIX.1b
1837 @deftp {Data Type} {struct aiocb64}
1838 @table @code
1839 @item int aio_fildes
1840 This element specifies the file descriptor which is used for the
1841 operation.  It must be a legal descriptor since otherwise the operation
1842 fails for obvious reasons.
1844 The device on which the file is opened must allow the seek operation.
1845 I.e., it is not possible to use any of the AIO operations on devices
1846 like terminals where an @code{lseek} call would lead to an error.
1848 @item off64_t aio_offset
1849 This element specified at which offset in the file the operation (input
1850 or output) is performed.  Since the operation are carried in arbitrary
1851 order and more than one operation for one file descriptor can be
1852 started, one cannot expect a current read/write position of the file
1853 descriptor.
1855 @item volatile void *aio_buf
1856 This is a pointer to the buffer with the data to be written or the place
1857 where the ead data is stored.
1859 @item size_t aio_nbytes
1860 This element specifies the length of the buffer pointed to by @code{aio_buf}.
1862 @item int aio_reqprio
1863 If for the platform @code{_POSIX_PRIORITIZED_IO} and
1864 @code{_POSIX_PRIORITY_SCHEDULING} is defined the AIO requests are
1865 processed based on the current scheduling priority.  The
1866 @code{aio_reqprio} element can then be used to lower the priority of the
1867 AIO operation.
1869 @item struct sigevent aio_sigevent
1870 This element specifies how the calling process is notified once the
1871 operation terminates.  If the @code{sigev_notify} element is
1872 @code{SIGEV_NONE} no notification is send.  If it is @code{SIGEV_SIGNAL}
1873 the signal determined by @code{sigev_signo} is send.  Otherwise
1874 @code{sigev_notify} must be @code{SIGEV_THREAD} in which case a thread
1875 which starts executing the function pointeed to by
1876 @code{sigev_notify_function}.
1878 @item int aio_lio_opcode
1879 This element is only used by the @code{lio_listio} and
1880 @code{[lio_listio64} functions.  Since these functions allow to start an
1881 arbitrary number of operations at once and since each operation can be
1882 input or output (or nothing) the information must be stored in the
1883 control block.  See the description of @code{struct aiocb} for a description
1884 of the possible values.
1885 @end table
1887 When the sources are compiled using @code{_FILE_OFFSET_BITS == 64} on a
1888 32 bits machine this type is available under the name @code{struct
1889 aiocb64} since the LFS replaces transparently the old interface.
1890 @end deftp
1892 @menu
1893 * Asynchronous Reads/Writes::    Asynchronous Read and Write Operations.
1894 * Status of AIO Operations::     Getting the Status of AIO Operations.
1895 * Synchronizing AIO Operations:: Getting into a consistent state.
1896 * Cancel AIO Operations::        Cancelation of AIO Operations.
1897 * Configuration of AIO::         How to optimize the AIO implementation.
1898 @end menu
1900 @node Asynchronous Reads/Writes
1901 @subsection Asynchronous Read and Write Operations
1903 @comment aio.h
1904 @comment POSIX.1b
1905 @deftypefun int aio_read (struct aiocb *@var{aiocbp})
1906 This function initiates an asynchronous read operation.  The function
1907 call immediately returns after the operation was enqueued or when an
1908 error was encountered.
1910 The first @code{aiocbp->aio_nbytes} bytes of the file for which
1911 @code{aiocbp->aio_fildes} is a descriptor are written to the buffer
1912 starting at @code{aiocbp->aio_buf}.  Reading starts at the absolute
1913 position @code{aiocbp->aio_offset} in the file.
1915 If prioritized I/O is supported by the platform the
1916 @code{aiocbp->aio_reqprio} value is used to adjust the priority before
1917 the request is actually enqueued.
1919 The calling process is notified about the termination of the read
1920 request according to the @code{aiocbp->aio_sigevent} value.
1922 When @code{aio_read} returns the return value is zero if no error
1923 occurred that can be found before the process is enqueued.  If such an
1924 early error is found the function returns @math{-1} and sets
1925 @code{errno} to one of the following values.
1927 @table @code
1928 @item EAGAIN
1929 The request was not enqueued due to (temporarily) exceeded resource
1930 limitations.
1931 @item ENOSYS
1932 The @code{aio_read} function is not implemented.
1933 @item EBADF
1934 The @code{aiocbp->aio_fildes} descriptor is not valid.  This condition
1935 needs not be recognized before enqueueing the request and so this error
1936 might also be signaled asynchronously.
1937 @item EINVAL
1938 The @code{aiocbp->aio_offset} or @code{aiocbp->aio_reqpiro} value is
1939 invalid.  This condition need not be recognized before enqueueing the
1940 request and so this error might also be signaled asynchrously.
1941 @end table
1943 In the case @code{aio_read} returns zero the current status of the
1944 request can be queried using @code{aio_error} and @code{aio_return}
1945 functions.  As long as the value returned by @code{aio_error} is
1946 @code{EINPROGRESS} the operation has not yet completed.  If
1947 @code{aio_error} returns zero the operation successfully terminated,
1948 otherwise the value is to be interpreted as an error code.  If the
1949 function terminated the result of the operation can be get using a call
1950 to @code{aio_return}.  The returned value is the same as an equivalent
1951 call to @code{read} would have returned.  Possible error codes returned
1952 by @code{aio_error} are:
1954 @table @code
1955 @item EBADF
1956 The @code{aiocbp->aio_fildes} descriptor is not valid.
1957 @item ECANCELED
1958 The operation was canceled before the operation was finished
1959 (@pxref{Cancel AIO Operations})
1960 @item EINVAL
1961 The @code{aiocbp->aio_offset} value is invalid.
1962 @end table
1964 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
1965 function is in fact @code{aio_read64} since the LFS interface transparently
1966 replaces the normal implementation.
1967 @end deftypefun
1969 @comment aio.h
1970 @comment Unix98
1971 @deftypefun int aio_read64 (struct aiocb *@var{aiocbp})
1972 This function is similar to the @code{aio_read} function.  The only
1973 difference is that on @w{32 bits} machines the file descriptor should
1974 be opened in the large file mode.  Internally @code{aio_read64} uses
1975 functionality equivalent to @code{lseek64} (@pxref{File Position
1976 Primitive}) to position the file descriptor correctly for the reading,
1977 as opposed to @code{lseek} functionality used in @code{aio_read}.
1979 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
1980 function is available under the name @code{aio_read} and so transparently
1981 replaces the interface for small files on 32 bits machines.
1982 @end deftypefun
1984 To write data asynchronously to a file there exists an equivalent pair
1985 of functions with a very similar interface.
1987 @comment aio.h
1988 @comment POSIX.1b
1989 @deftypefun int aio_write (struct aiocb *@var{aiocbp})
1990 This function initiates an asynchronous write operation.  The function
1991 call immediately returns after the operation was enqueued or if before
1992 this happens an error was encountered.
1994 The first @code{aiocbp->aio_nbytes} bytes from the buffer starting at
1995 @code{aiocbp->aio_buf} are written to the file for which
1996 @code{aiocbp->aio_fildes} is an descriptor, starting at the absolute
1997 position @code{aiocbp->aio_offset} in the file.
1999 If prioritized I/O is supported by the platform the
2000 @code{aiocbp->aio_reqprio} value is used to adjust the priority before
2001 the request is actually enqueued.
2003 The calling process is notified about the termination of the read
2004 request according to the @code{aiocbp->aio_sigevent} value.
2006 When @code{aio_write} returns the return value is zero if no error
2007 occurred that can be found before the process is enqueued.  If such an
2008 early error is found the function returns @math{-1} and sets
2009 @code{errno} to one of the following values.
2011 @table @code
2012 @item EAGAIN
2013 The request was not enqueued due to (temporarily) exceeded resource
2014 limitations.
2015 @item ENOSYS
2016 The @code{aio_write} function is not implemented.
2017 @item EBADF
2018 The @code{aiocbp->aio_fildes} descriptor is not valid.  This condition
2019 needs not be recognized before enqueueing the request and so this error
2020 might also be signaled asynchronously.
2021 @item EINVAL
2022 The @code{aiocbp->aio_offset} or @code{aiocbp->aio_reqpiro} value is
2023 invalid.  This condition needs not be recognized before enqueueing the
2024 request and so this error might also be signaled asynchronously.
2025 @end table
2027 In the case @code{aio_write} returns zero the current status of the
2028 request can be queried using @code{aio_error} and @code{aio_return}
2029 functions.  As long as the value returned by @code{aio_error} is
2030 @code{EINPROGRESS} the operation has not yet completed.  If
2031 @code{aio_error} returns zero the operation successfully terminated,
2032 otherwise the value is to be interpreted as an error code.  If the
2033 function terminated the result of the operation can be get using a call
2034 to @code{aio_return}.  The returned value is the same as an equivalent
2035 call to @code{read} would have returned.  Possible error code returned
2036 by @code{aio_error} are:
2038 @table @code
2039 @item EBADF
2040 The @code{aiocbp->aio_fildes} descriptor is not valid.
2041 @item ECANCELED
2042 The operation was canceled before the operation was finished
2043 (@pxref{Cancel AIO Operations})
2044 @item EINVAL
2045 The @code{aiocbp->aio_offset} value is invalid.
2046 @end table
2048 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2049 function is in fact @code{aio_write64} since the LFS interface transparently
2050 replaces the normal implementation.
2051 @end deftypefun
2053 @comment aio.h
2054 @comment Unix98
2055 @deftypefun int aio_write64 (struct aiocb *@var{aiocbp})
2056 This function is similar to the @code{aio_write} function.  The only
2057 difference is that on @w{32 bits} machines the file descriptor should
2058 be opened in the large file mode.  Internally @code{aio_write64} uses
2059 functionality equivalent to @code{lseek64} (@pxref{File Position
2060 Primitive}) to position the file descriptor correctly for the writing,
2061 as opposed to @code{lseek} functionality used in @code{aio_write}.
2063 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2064 function is available under the name @code{aio_write} and so transparently
2065 replaces the interface for small files on 32 bits machines.
2066 @end deftypefun
2068 Beside these functions with the more or less traditional interface
2069 POSIX.1b also defines a function with can initiate more than one
2070 operation at once and which can handled freely mixed read and write
2071 operation.  It is therefore similar to a combination of @code{readv} and
2072 @code{writev}.
2074 @comment aio.h
2075 @comment POSIX.1b
2076 @deftypefun int lio_listio (int @var{mode}, struct aiocb *const @var{list}[], int @var{nent}, struct sigevent *@var{sig})
2077 The @code{lio_listio} function can be used to enqueue an arbitrary
2078 number of read and write requests at one time.  The requests can all be
2079 meant for the same file, all for different files or every solution in
2080 between.
2082 @code{lio_listio} gets the @var{nent} requests from the array pointed to
2083 by @var{list}.  What operation has to be performed is determined by the
2084 @code{aio_lio_opcode} member in each element of @var{list}.  If this
2085 field is @code{LIO_READ} an read operation is queued, similar to a call
2086 of @code{aio_read} for this element of the array (except that the way
2087 the termination is signalled is different, as we will see below).  If
2088 the @code{aio_lio_opcode} member is @code{LIO_WRITE} an write operation
2089 is enqueued.  Otherwise the @code{aio_lio_opcode} must be @code{LIO_NOP}
2090 in which case this element of @var{list} is simply ignored.  This
2091 ``operation'' is useful in situations where one has a fixed array of
2092 @code{struct aiocb} elements from which only a few need to be handled at
2093 a time.  Another situation is where the @code{lio_listio} call was
2094 cancelled before all requests are processed (@pxref{Cancel AIO
2095 Operations}) and the remaining requests have to be reissued.
2097 The other members of each element of the array pointed to by
2098 @code{list} must have values suitable for the operation as described in
2099 the documentation for @code{aio_read} and @code{aio_write} above.
2101 The @var{mode} argument determines how @code{lio_listio} behaves after
2102 having enqueued all the requests.  If @var{mode} is @code{LIO_WAIT} it
2103 waits until all requests terminated.  Otherwise @var{mode} must be
2104 @code{LIO_NOWAIT} and in this case the function returns immediately after
2105 having enqueued all the requests.  In this case the caller gets a
2106 notification of the termination of all requests according to the
2107 @var{sig} parameter.  If @var{sig} is @code{NULL} no notification is
2108 send.  Otherwise a signal is sent or a thread is started, just as
2109 described in the description for @code{aio_read} or @code{aio_write}.
2111 If @var{mode} is @code{LIO_WAIT} the return value of @code{lio_listio}
2112 is @math{0} when all requests completed successfully.  Otherwise the
2113 function return @math{-1} and @code{errno} is set accordingly.  To find
2114 out which request or requests failed one has to use the @code{aio_error}
2115 function on all the elements of the array @var{list}.
2117 In case @var{mode} is @code{LIO_NOWAIT} the function return @math{0} if
2118 all requests were enqueued correctly.  The current state of the requests
2119 can be found using @code{aio_error} and @code{aio_return} as described
2120 above.  In case @code{lio_listio} returns @math{-1} in this mode the
2121 global variable @code{errno} is set accordingly.  If a request did not
2122 yet terminate a call to @code{aio_error} returns @code{EINPROGRESS}.  If
2123 the value is different the request is finished and the error value (or
2124 @math{0}) is returned and the result of the operation can be retrieved
2125 using @code{aio_return}.
2127 Possible values for @code{errno} are:
2129 @table @code
2130 @item EAGAIN
2131 The resources necessary to queue all the requests are not available in
2132 the moment.  The error status for each element of @var{list} must be
2133 checked which request failed.
2135 Another reason could be that the system wide limit of AIO requests is
2136 exceeded.  This cannot be the case for the implementation on GNU systems
2137 since no arbitrary limits exist.
2138 @item EINVAL
2139 The @var{mode} parameter is invalid or @var{nent} is larger than
2140 @code{AIO_LISTIO_MAX}.
2141 @item EIO
2142 One or more of the request's I/O operations failed.  The error status of
2143 each request should be checked for which one failed.
2144 @item ENOSYS
2145 The @code{lio_listio} function is not supported.
2146 @end table
2148 If the @var{mode} parameter is @code{LIO_NOWAIT} and the caller cancels
2149 an request the error status for this request returned by
2150 @code{aio_error} is @code{ECANCELED}.
2152 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2153 function is in fact @code{lio_listio64} since the LFS interface
2154 transparently replaces the normal implementation.
2155 @end deftypefun
2157 @comment aio.h
2158 @comment Unix98
2159 @deftypefun int lio_listio64 (int @var{mode}, struct aiocb *const @var{list}, int @var{nent}, struct sigevent *@var{sig})
2160 This function is similar to the @code{aio_listio} function.  The only
2161 difference is that only @w{32 bits} machines the file descriptor should
2162 be opened in the large file mode.  Internally @code{lio_listio64} uses
2163 functionality equivalent to @code{lseek64} (@pxref{File Position
2164 Primitive}) to position the file descriptor correctly for the reading or
2165 writing, as opposed to @code{lseek} functionality used in
2166 @code{lio_listio}.
2168 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2169 function is available under the name @code{lio_listio} and so
2170 transparently replaces the interface for small files on 32 bits
2171 machines.
2172 @end deftypefun
2174 @node Status of AIO Operations
2175 @subsection Getting the Status of AIO Operations
2177 As already described in the documentation of the functions in the last
2178 section it must be possible to get information about the status of a I/O
2179 request.  When the operation is performed really asynchronous (as with
2180 @code{aio_read} and @code{aio_write} and with @code{aio_listio} when the
2181 mode is @code{LIO_NOWAIT}) one sometimes needs to know whether a
2182 specific request already terminated and if yes, what the result was..
2183 The following two function allow to get this kind of information.
2185 @comment aio.h
2186 @comment POSIX.1b
2187 @deftypefun int aio_error (const struct aiocb *@var{aiocbp})
2188 This function determines the error state of the request described by the
2189 @code{struct aiocb} variable pointed to by @var{aiocbp}.  If the
2190 request has not yet terminated the value returned is always
2191 @code{EINPROGRESS}.  Once the request has terminated the value
2192 @code{aio_error} returns is either @math{0} if the request completed
2193 successfully or it returns the value which would be stored in the
2194 @code{errno} variable if the request would have been done using
2195 @code{read}, @code{write}, or @code{fsync}.
2197 The function can return @code{ENOSYS} if it is not implemented.  It
2198 could also return @code{EINVAL} if the @var{aiocbp} parameter does not
2199 refer to an asynchronous operation whose return status is not yet known.
2201 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2202 function is in fact @code{aio_error64} since the LFS interface
2203 transparently replaces the normal implementation.
2204 @end deftypefun
2206 @comment aio.h
2207 @comment Unix98
2208 @deftypefun int aio_error64 (const struct aiocb64 *@var{aiocbp})
2209 This function is similar to @code{aio_error} with the only difference
2210 that the argument is a reference to a variable of type @code{struct
2211 aiocb64}.
2213 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2214 function is available under the name @code{aio_error} and so
2215 transparently replaces the interface for small files on 32 bits
2216 machines.
2217 @end deftypefun
2219 @comment aio.h
2220 @comment POSIX.1b
2221 @deftypefun ssize_t aio_return (const struct aiocb *@var{aiocbp})
2222 This function can be used to retrieve the return status of the operation
2223 carried out by the request described in the variable pointed to by
2224 @var{aiocbp}.  As long as the error status of this request as returned
2225 by @code{aio_error} is @code{EINPROGRESS} the return of this function is
2226 undefined.
2228 Once the request is finished this function can be used exactly once to
2229 retrieve the return value.  Following calls might lead to undefined
2230 behaviour.  The return value itself is the value which would have been
2231 returned by the @code{read}, @code{write}, or @code{fsync} call.
2233 The function can return @code{ENOSYS} if it is not implemented.  It
2234 could also return @code{EINVAL} if the @var{aiocbp} parameter does not
2235 refer to an asynchronous operation whose return status is not yet known.
2237 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2238 function is in fact @code{aio_return64} since the LFS interface
2239 transparently replaces the normal implementation.
2240 @end deftypefun
2242 @comment aio.h
2243 @comment Unix98
2244 @deftypefun int aio_return64 (const struct aiocb64 *@var{aiocbp})
2245 This function is similar to @code{aio_return} with the only difference
2246 that the argument is a reference to a variable of type @code{struct
2247 aiocb64}.
2249 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2250 function is available under the name @code{aio_return} and so
2251 transparently replaces the interface for small files on 32 bits
2252 machines.
2253 @end deftypefun
2255 @node Synchronizing AIO Operations
2256 @subsection Getting into a Consistent State
2258 When dealing with asynchronous operations it is sometimes necessary to
2259 get into a consistent state.  This would mean for AIO that one wants to
2260 know whether a certain request or a group of request were processed.
2261 This could be done by waiting for the notification sent by the system
2262 after the operation terminated but this sometimes would mean wasting
2263 resources (mainly computation time).  Instead POSIX.1b defines two
2264 functions which will help with most kinds of consistency.
2266 The @code{aio_fsync} and @code{aio_fsync64} functions are only available
2267 if in @file{unistd.h} the symbol @code{_POSIX_SYNCHRONIZED_IO} is
2268 defined.
2270 @cindex synchronizing
2271 @comment aio.h
2272 @comment POSIX.1b
2273 @deftypefun int aio_fsync (int @var{op}, struct aiocb *@var{aiocbp})
2274 Calling this function forces all I/O operations operating queued at the
2275 time of the function call operating on the file descriptor
2276 @code{aiocbp->aio_fildes} into the synchronized I/O completion state
2277 (@pxref{Synchronizing I/O}).  The @code{aio_fsync} function return
2278 immediately but the notification through the method described in
2279 @code{aiocbp->aio_sigevent} will happen only after all requests for this
2280 file descriptor terminated and the file is synchronized.  This also
2281 means that requests for this very same file descriptor which are queued
2282 after the synchronization request are not effected.
2284 If @var{op} is @code{O_DSYNC} the synchronization happens as with a call
2285 to @code{fdatasync}.  Otherwise @var{op} should be @code{O_SYNC} and
2286 the synchronization happens as with @code{fsync}.
2288 As long as the synchronization has not happened a call to
2289 @code{aio_error} with the reference to the object pointed to by
2290 @var{aiocbp} returns @code{EINPROGRESS}.  Once the synchronization is
2291 done @code{aio_error} return @math{0} if the synchronization was not
2292 successful.  Otherwise the value returned is the value to which the
2293 @code{fsync} or @code{fdatasync} function would have set the
2294 @code{errno} variable.  In this case nothing can be assumed about the
2295 consistency for the data written to this file descriptor.
2297 The return value of this function is @math{0} if the request was
2298 successfully filed.  Otherwise the return value is @math{-1} and
2299 @code{errno} is set to one of the following values:
2301 @table @code
2302 @item EAGAIN
2303 The request could not be enqueued due to temporary lack of resources.
2304 @item EBADF
2305 The file descriptor @code{aiocbp->aio_fildes} is not valid or not open
2306 for writing.
2307 @item EINVAL
2308 The implementation does not support I/O synchronization or the @var{op}
2309 parameter is other than @code{O_DSYNC} and @code{O_SYNC}.
2310 @item ENOSYS
2311 This function is not implemented.
2312 @end table
2314 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2315 function is in fact @code{aio_return64} since the LFS interface
2316 transparently replaces the normal implementation.
2317 @end deftypefun
2319 @comment aio.h
2320 @comment Unix98
2321 @deftypefun int aio_fsync64 (int @var{op}, struct aiocb64 *@var{aiocbp})
2322 This function is similar to @code{aio_fsync} with the only difference
2323 that the argument is a reference to a variable of type @code{struct
2324 aiocb64}.
2326 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2327 function is available under the name @code{aio_fsync} and so
2328 transparently replaces the interface for small files on 32 bits
2329 machines.
2330 @end deftypefun
2332 Another method of synchronization is to wait until one or more requests of a
2333 specific set terminated.  This could be achieved by the @code{aio_*}
2334 functions to notify the initiating process about the termination but in
2335 some situations this is not the ideal solution.  In a program which
2336 constantly updates clients somehow connected to the server it is not
2337 always the best solution to go round robin since some connections might
2338 be slow.  On the other hand letting the @code{aio_*} function notify the
2339 caller might also be not the best solution since whenever the process
2340 works on preparing data for on client it makes no sense to be
2341 interrupted by a notification since the new client will not be handled
2342 before the current client is served.  For situations like this
2343 @code{aio_suspend} should be used.
2345 @comment aio.h
2346 @comment POSIX.1b
2347 @deftypefun int aio_suspend (const struct aiocb *const @var{list}[], int @var{nent}, const struct timespec *@var{timeout})
2348 When calling this function the calling thread is suspended until at
2349 least one of the requests pointed to by the @var{nent} elements of the
2350 array @var{list} has completed.  If any of the requests already has
2351 completed at the time @code{aio_suspend} is called the function returns
2352 immediately.  Whether a request has terminated or not is done by
2353 comparing the error status of the request with @code{EINPROGRESS}.  If
2354 an element of @var{list} is @code{NULL} the entry is simply ignored.
2356 If no request has finished the calling process is suspended.  If
2357 @var{timeout} is @code{NULL} the process is not waked until a request
2358 finished.  If @var{timeout} is not @code{NULL} the process remains
2359 suspended at as long as specified in @var{timeout}.  In this case
2360 @code{aio_suspend} returns with an error.
2362 The return value of the function is @math{0} if one or more requests
2363 from the @var{list} have terminated.  Otherwise the function returns
2364 @math{-1} and @code{errno} is set to one of the following values:
2366 @table @code
2367 @item EAGAIN
2368 None of the requests from the @var{list} completed in the time specified
2369 by @var{timeout}.
2370 @item EINTR
2371 A signal interrupted the @code{aio_suspend} function.  This signal might
2372 also be sent by the AIO implementation while signalling the termination
2373 of one of the requests.
2374 @item ENOSYS
2375 The @code{aio_suspend} function is not implemented.
2376 @end table
2378 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2379 function is in fact @code{aio_suspend64} since the LFS interface
2380 transparently replaces the normal implementation.
2381 @end deftypefun
2383 @comment aio.h
2384 @comment Unix98
2385 @deftypefun int aio_suspend64 (const struct aiocb64 *const @var{list}[], int @var{nent}, const struct timespec *@var{timeout})
2386 This function is similar to @code{aio_suspend} with the only difference
2387 that the argument is a reference to a variable of type @code{struct
2388 aiocb64}.
2390 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2391 function is available under the name @code{aio_suspend} and so
2392 transparently replaces the interface for small files on 32 bits
2393 machines.
2394 @end deftypefun
2396 @node Cancel AIO Operations
2397 @subsection Cancelation of AIO Operations
2399 When one or more requests are asynchronously processed it might be
2400 useful in some situations to cancel a selected operation, e.g., if it
2401 becomes obvious that the written data is not anymore accurate and would
2402 have to be overwritten soon.  As an example assume an application, which
2403 writes data in files in a situation where new incoming data would have
2404 to be written in a file which will be updated by an enqueued request.
2405 The POSIX AIO implementation provides such a function but this function
2406 is not capable to force the cancelation of the request.  It is up to the
2407 implementation to decide whether it is possible to cancel the operation
2408 or not.  Therefore using this function is merely a hint.
2410 @comment aio.h
2411 @comment POSIX.1b
2412 @deftypefun int aio_cancel (int @var{fildes}, struct aiocb *@var{aiocbp})
2413 The @code{aio_cancel} function can be used to cancel one or more
2414 outstanding requests.  If the @var{aiocbp} parameter is @code{NULL} the
2415 function tries to cancel all outstanding requests which would process
2416 the file descriptor @var{fildes} (i.e.,, whose @code{aio_fildes} member
2417 is @var{fildes}).  If @var{aiocbp} is not @code{NULL} the very specific
2418 request pointed to by @var{aiocbp} is tried to be canceled.
2420 For requests which were successfully canceled the normal notification
2421 about the termination of the request should take place.  I.e., depending
2422 on the @code{struct sigevent} object which controls this, nothing
2423 happens, a signal is sent or a thread is started.  If the request cannot
2424 be canceled it terminates the usual way after performing te operation.
2426 After a request is successfully canceled a call to @code{aio_error} with
2427 a reference to this request as the parameter will return
2428 @code{ECANCELED} and a call to @code{aio_return} will return @math{-1}.
2429 If the request wasn't canceled and is still running the error status is
2430 still @code{EINPROGRESS}.
2432 The return value of the function is @code{AIO_CANCELED} if there were
2433 requests which haven't terminated and which successfully were canceled.
2434 If there is one or more request left which couldn't be canceled the
2435 return value is @code{AIO_NOTCANCELED}.  In this case @code{aio_error}
2436 must be used to find out which of the perhaps multiple requests (in
2437 @var{aiocbp} is @code{NULL}) wasn't successfully canceled.  If all
2438 requests already terminated at the time @code{aio_cancel} is called the
2439 return value is @code{AIO_ALLDONE}.
2441 If an error occurred during the execution of @code{aio_cancel} the
2442 function returns @math{-1} and sets @code{errno} to one of the following
2443 values.
2445 @table @code
2446 @item EBADF
2447 The file descriptor @var{fildes} is not valid.
2448 @item ENOSYS
2449 @code{aio_cancel} is not implemented.
2450 @end table
2452 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2453 function is in fact @code{aio_cancel64} since the LFS interface
2454 transparently replaces the normal implementation.
2455 @end deftypefun
2457 @comment aio.h
2458 @comment Unix98
2459 @deftypefun int aio_cancel64 (int @var{fildes}, struct aiocb *@var{aiocbp})
2460 This function is similar to @code{aio_cancel} with the only difference
2461 that the argument is a reference to a variable of type @code{struct
2462 aiocb64}.
2464 When the sources are compiled with @code{_FILE_OFFSET_BITS == 64} this
2465 function is available under the name @code{aio_cancel} and so
2466 transparently replaces the interface for small files on 32 bits
2467 machines.
2468 @end deftypefun
2470 @node Configuration of AIO
2471 @subsection How to optimize the AIO implementation
2473 The POSIX standard does not specify how the AIO functions are
2474 implemented.  They could be system calls but it is also possible to
2475 emulate them at userlevel.
2477 At least the available implementation at the point of this writing is a
2478 userlevel implementation which uses threads for handling the enqueued
2479 requests.  This implementation requires to make some decisions about
2480 limitations but hard limitations are something which better should be
2481 avoided the GNU C library implementation provides a mean to tune the AIO
2482 implementation individually for each use.
2484 @comment aio.h
2485 @comment GNU
2486 @deftp {Data Type} {struct aioinit}
2487 This data type is used to pass the configuration or tunable parameters
2488 to the implementation.  The program has to initialize the members of
2489 this struct and pass it to the implementation using the @code{aio_init}
2490 function.
2492 @table @code
2493 @item int aio_threads
2494 This member specifies the maximal number of threads which must be used
2495 at any one time.
2496 @item int aio_num
2497 This number provides an estimate on the maximal number of simultaneously
2498 enqueued requests.
2499 @item int aio_locks
2500 @c What?
2501 @item int aio_usedba
2502 @c What?
2503 @item int aio_debug
2504 @c What?
2505 @item int aio_numusers
2506 @c What?
2507 @item int aio_reserved[2]
2508 @c What?
2509 @end table
2510 @end deftp
2512 @comment aio.h
2513 @comment GNU
2514 @deftypefun void aio_init (const struct aioinit *@var{init})
2515 This function must be called before any other AIO function.  Calling it
2516 is completely voluntarily since it only is meant to help the AIO
2517 implementation to perform better.
2519 Before calling the @code{aio_init} function the members of a variable of
2520 type @code{struct aioinit} must be initialized.  Then a reference to
2521 this variable is passed as the parameter to @code{aio_init} which itself
2522 may or may not pay attention to the hints.
2524 The function has no return value and no error cases are defined.  It is
2525 a extension which follows a proposal from the SGI implementation in
2526 @w{Irix 6}.  It is not covered by POSIX.1b or Unix98.
2527 @end deftypefun
2529 @node Control Operations
2530 @section Control Operations on Files
2532 @cindex control operations on files
2533 @cindex @code{fcntl} function
2534 This section describes how you can perform various other operations on
2535 file descriptors, such as inquiring about or setting flags describing
2536 the status of the file descriptor, manipulating record locks, and the
2537 like.  All of these operations are performed by the function @code{fcntl}.
2539 The second argument to the @code{fcntl} function is a command that
2540 specifies which operation to perform.  The function and macros that name
2541 various flags that are used with it are declared in the header file
2542 @file{fcntl.h}.  Many of these flags are also used by the @code{open}
2543 function; see @ref{Opening and Closing Files}.
2544 @pindex fcntl.h
2546 @comment fcntl.h
2547 @comment POSIX.1
2548 @deftypefun int fcntl (int @var{filedes}, int @var{command}, @dots{})
2549 The @code{fcntl} function performs the operation specified by
2550 @var{command} on the file descriptor @var{filedes}.  Some commands
2551 require additional arguments to be supplied.  These additional arguments
2552 and the return value and error conditions are given in the detailed
2553 descriptions of the individual commands.
2555 Briefly, here is a list of what the various commands are.
2557 @table @code
2558 @item F_DUPFD
2559 Duplicate the file descriptor (return another file descriptor pointing
2560 to the same open file).  @xref{Duplicating Descriptors}.
2562 @item F_GETFD
2563 Get flags associated with the file descriptor.  @xref{Descriptor Flags}.
2565 @item F_SETFD
2566 Set flags associated with the file descriptor.  @xref{Descriptor Flags}.
2568 @item F_GETFL
2569 Get flags associated with the open file.  @xref{File Status Flags}.
2571 @item F_SETFL
2572 Set flags associated with the open file.  @xref{File Status Flags}.
2574 @item F_GETLK
2575 Get a file lock.  @xref{File Locks}.
2577 @item F_SETLK
2578 Set or clear a file lock.  @xref{File Locks}.
2580 @item F_SETLKW
2581 Like @code{F_SETLK}, but wait for completion.  @xref{File Locks}.
2583 @item F_GETOWN
2584 Get process or process group ID to receive @code{SIGIO} signals.
2585 @xref{Interrupt Input}.
2587 @item F_SETOWN
2588 Set process or process group ID to receive @code{SIGIO} signals.
2589 @xref{Interrupt Input}.
2590 @end table
2592 This function is a cancelation point in multi-threaded programs.  This
2593 is a problem if the thread allocates some resources (like memory, file
2594 descriptors, semaphores or whatever) at the time @code{fcntl} is
2595 called.  If the thread gets canceled these resources stay allocated
2596 until the program ends.  To avoid this calls to @code{fcntl} should be
2597 protected using cancelation handlers.
2598 @c ref pthread_cleanup_push / pthread_cleanup_pop
2599 @end deftypefun
2602 @node Duplicating Descriptors
2603 @section Duplicating Descriptors
2605 @cindex duplicating file descriptors
2606 @cindex redirecting input and output
2608 You can @dfn{duplicate} a file descriptor, or allocate another file
2609 descriptor that refers to the same open file as the original.  Duplicate
2610 descriptors share one file position and one set of file status flags
2611 (@pxref{File Status Flags}), but each has its own set of file descriptor
2612 flags (@pxref{Descriptor Flags}).
2614 The major use of duplicating a file descriptor is to implement
2615 @dfn{redirection} of input or output:  that is, to change the
2616 file or pipe that a particular file descriptor corresponds to.
2618 You can perform this operation using the @code{fcntl} function with the
2619 @code{F_DUPFD} command, but there are also convenient functions
2620 @code{dup} and @code{dup2} for duplicating descriptors.
2622 @pindex unistd.h
2623 @pindex fcntl.h
2624 The @code{fcntl} function and flags are declared in @file{fcntl.h},
2625 while prototypes for @code{dup} and @code{dup2} are in the header file
2626 @file{unistd.h}.
2628 @comment unistd.h
2629 @comment POSIX.1
2630 @deftypefun int dup (int @var{old})
2631 This function copies descriptor @var{old} to the first available
2632 descriptor number (the first number not currently open).  It is
2633 equivalent to @code{fcntl (@var{old}, F_DUPFD, 0)}.
2634 @end deftypefun
2636 @comment unistd.h
2637 @comment POSIX.1
2638 @deftypefun int dup2 (int @var{old}, int @var{new})
2639 This function copies the descriptor @var{old} to descriptor number
2640 @var{new}.
2642 If @var{old} is an invalid descriptor, then @code{dup2} does nothing; it
2643 does not close @var{new}.  Otherwise, the new duplicate of @var{old}
2644 replaces any previous meaning of descriptor @var{new}, as if @var{new}
2645 were closed first.
2647 If @var{old} and @var{new} are different numbers, and @var{old} is a
2648 valid descriptor number, then @code{dup2} is equivalent to:
2650 @smallexample
2651 close (@var{new});
2652 fcntl (@var{old}, F_DUPFD, @var{new})
2653 @end smallexample
2655 However, @code{dup2} does this atomically; there is no instant in the
2656 middle of calling @code{dup2} at which @var{new} is closed and not yet a
2657 duplicate of @var{old}.
2658 @end deftypefun
2660 @comment fcntl.h
2661 @comment POSIX.1
2662 @deftypevr Macro int F_DUPFD
2663 This macro is used as the @var{command} argument to @code{fcntl}, to
2664 copy the file descriptor given as the first argument.
2666 The form of the call in this case is:
2668 @smallexample
2669 fcntl (@var{old}, F_DUPFD, @var{next-filedes})
2670 @end smallexample
2672 The @var{next-filedes} argument is of type @code{int} and specifies that
2673 the file descriptor returned should be the next available one greater
2674 than or equal to this value.
2676 The return value from @code{fcntl} with this command is normally the value
2677 of the new file descriptor.  A return value of @math{-1} indicates an
2678 error.  The following @code{errno} error conditions are defined for
2679 this command:
2681 @table @code
2682 @item EBADF
2683 The @var{old} argument is invalid.
2685 @item EINVAL
2686 The @var{next-filedes} argument is invalid.
2688 @item EMFILE
2689 There are no more file descriptors available---your program is already
2690 using the maximum.  In BSD and GNU, the maximum is controlled by a
2691 resource limit that can be changed; @pxref{Limits on Resources}, for
2692 more information about the @code{RLIMIT_NOFILE} limit.
2693 @end table
2695 @code{ENFILE} is not a possible error code for @code{dup2} because
2696 @code{dup2} does not create a new opening of a file; duplicate
2697 descriptors do not count toward the limit which @code{ENFILE}
2698 indicates.  @code{EMFILE} is possible because it refers to the limit on
2699 distinct descriptor numbers in use in one process.
2700 @end deftypevr
2702 Here is an example showing how to use @code{dup2} to do redirection.
2703 Typically, redirection of the standard streams (like @code{stdin}) is
2704 done by a shell or shell-like program before calling one of the
2705 @code{exec} functions (@pxref{Executing a File}) to execute a new
2706 program in a child process.  When the new program is executed, it
2707 creates and initializes the standard streams to point to the
2708 corresponding file descriptors, before its @code{main} function is
2709 invoked.
2711 So, to redirect standard input to a file, the shell could do something
2712 like:
2714 @smallexample
2715 pid = fork ();
2716 if (pid == 0)
2717   @{
2718     char *filename;
2719     char *program;
2720     int file;
2721     @dots{}
2722     file = TEMP_FAILURE_RETRY (open (filename, O_RDONLY));
2723     dup2 (file, STDIN_FILENO);
2724     TEMP_FAILURE_RETRY (close (file));
2725     execv (program, NULL);
2726   @}
2727 @end smallexample
2729 There is also a more detailed example showing how to implement redirection
2730 in the context of a pipeline of processes in @ref{Launching Jobs}.
2733 @node Descriptor Flags
2734 @section File Descriptor Flags
2735 @cindex file descriptor flags
2737 @dfn{File descriptor flags} are miscellaneous attributes of a file
2738 descriptor.  These flags are associated with particular file
2739 descriptors, so that if you have created duplicate file descriptors
2740 from a single opening of a file, each descriptor has its own set of flags.
2742 Currently there is just one file descriptor flag: @code{FD_CLOEXEC},
2743 which causes the descriptor to be closed if you use any of the
2744 @code{exec@dots{}} functions (@pxref{Executing a File}).
2746 The symbols in this section are defined in the header file
2747 @file{fcntl.h}.
2748 @pindex fcntl.h
2750 @comment fcntl.h
2751 @comment POSIX.1
2752 @deftypevr Macro int F_GETFD
2753 This macro is used as the @var{command} argument to @code{fcntl}, to
2754 specify that it should return the file descriptor flags associated
2755 with the @var{filedes} argument.
2757 The normal return value from @code{fcntl} with this command is a
2758 nonnegative number which can be interpreted as the bitwise OR of the
2759 individual flags (except that currently there is only one flag to use).
2761 In case of an error, @code{fcntl} returns @math{-1}.  The following
2762 @code{errno} error conditions are defined for this command:
2764 @table @code
2765 @item EBADF
2766 The @var{filedes} argument is invalid.
2767 @end table
2768 @end deftypevr
2771 @comment fcntl.h
2772 @comment POSIX.1
2773 @deftypevr Macro int F_SETFD
2774 This macro is used as the @var{command} argument to @code{fcntl}, to
2775 specify that it should set the file descriptor flags associated with the
2776 @var{filedes} argument.  This requires a third @code{int} argument to
2777 specify the new flags, so the form of the call is:
2779 @smallexample
2780 fcntl (@var{filedes}, F_SETFD, @var{new-flags})
2781 @end smallexample
2783 The normal return value from @code{fcntl} with this command is an
2784 unspecified value other than @math{-1}, which indicates an error.
2785 The flags and error conditions are the same as for the @code{F_GETFD}
2786 command.
2787 @end deftypevr
2789 The following macro is defined for use as a file descriptor flag with
2790 the @code{fcntl} function.  The value is an integer constant usable
2791 as a bit mask value.
2793 @comment fcntl.h
2794 @comment POSIX.1
2795 @deftypevr Macro int FD_CLOEXEC
2796 @cindex close-on-exec (file descriptor flag)
2797 This flag specifies that the file descriptor should be closed when
2798 an @code{exec} function is invoked; see @ref{Executing a File}.  When
2799 a file descriptor is allocated (as with @code{open} or @code{dup}),
2800 this bit is initially cleared on the new file descriptor, meaning that
2801 descriptor will survive into the new program after @code{exec}.
2802 @end deftypevr
2804 If you want to modify the file descriptor flags, you should get the
2805 current flags with @code{F_GETFD} and modify the value.  Don't assume
2806 that the flags listed here are the only ones that are implemented; your
2807 program may be run years from now and more flags may exist then.  For
2808 example, here is a function to set or clear the flag @code{FD_CLOEXEC}
2809 without altering any other flags:
2811 @smallexample
2812 /* @r{Set the @code{FD_CLOEXEC} flag of @var{desc} if @var{value} is nonzero,}
2813    @r{or clear the flag if @var{value} is 0.}
2814    @r{Return 0 on success, or -1 on error with @code{errno} set.} */
2817 set_cloexec_flag (int desc, int value)
2819   int oldflags = fcntl (desc, F_GETFD, 0);
2820   /* @r{If reading the flags failed, return error indication now.}
2821   if (oldflags < 0)
2822     return oldflags;
2823   /* @r{Set just the flag we want to set.} */
2824   if (value != 0)
2825     oldflags |= FD_CLOEXEC;
2826   else
2827     oldflags &= ~FD_CLOEXEC;
2828   /* @r{Store modified flag word in the descriptor.} */
2829   return fcntl (desc, F_SETFD, oldflags);
2831 @end smallexample
2833 @node File Status Flags
2834 @section File Status Flags
2835 @cindex file status flags
2837 @dfn{File status flags} are used to specify attributes of the opening of a
2838 file.  Unlike the file descriptor flags discussed in @ref{Descriptor
2839 Flags}, the file status flags are shared by duplicated file descriptors
2840 resulting from a single opening of the file.  The file status flags are
2841 specified with the @var{flags} argument to @code{open};
2842 @pxref{Opening and Closing Files}.
2844 File status flags fall into three categories, which are described in the
2845 following sections.
2847 @itemize @bullet
2848 @item
2849 @ref{Access Modes}, specify what type of access is allowed to the
2850 file: reading, writing, or both.  They are set by @code{open} and are
2851 returned by @code{fcntl}, but cannot be changed.
2853 @item
2854 @ref{Open-time Flags}, control details of what @code{open} will do.
2855 These flags are not preserved after the @code{open} call.
2857 @item
2858 @ref{Operating Modes}, affect how operations such as @code{read} and
2859 @code{write} are done.  They are set by @code{open}, and can be fetched or
2860 changed with @code{fcntl}.
2861 @end itemize
2863 The symbols in this section are defined in the header file
2864 @file{fcntl.h}.
2865 @pindex fcntl.h
2867 @menu
2868 * Access Modes::                Whether the descriptor can read or write.
2869 * Open-time Flags::             Details of @code{open}.
2870 * Operating Modes::             Special modes to control I/O operations.
2871 * Getting File Status Flags::   Fetching and changing these flags.
2872 @end menu
2874 @node Access Modes
2875 @subsection File Access Modes
2877 The file access modes allow a file descriptor to be used for reading,
2878 writing, or both.  (In the GNU system, they can also allow none of these,
2879 and allow execution of the file as a program.)  The access modes are chosen
2880 when the file is opened, and never change.
2882 @comment fcntl.h
2883 @comment POSIX.1
2884 @deftypevr Macro int O_RDONLY
2885 Open the file for read access.
2886 @end deftypevr
2888 @comment fcntl.h
2889 @comment POSIX.1
2890 @deftypevr Macro int O_WRONLY
2891 Open the file for write access.
2892 @end deftypevr
2894 @comment fcntl.h
2895 @comment POSIX.1
2896 @deftypevr Macro int O_RDWR
2897 Open the file for both reading and writing.
2898 @end deftypevr
2900 In the GNU system (and not in other systems), @code{O_RDONLY} and
2901 @code{O_WRONLY} are independent bits that can be bitwise-ORed together,
2902 and it is valid for either bit to be set or clear.  This means that
2903 @code{O_RDWR} is the same as @code{O_RDONLY|O_WRONLY}.  A file access
2904 mode of zero is permissible; it allows no operations that do input or
2905 output to the file, but does allow other operations such as
2906 @code{fchmod}.  On the GNU system, since ``read-only'' or ``write-only''
2907 is a misnomer, @file{fcntl.h} defines additional names for the file
2908 access modes.  These names are preferred when writing GNU-specific code.
2909 But most programs will want to be portable to other POSIX.1 systems and
2910 should use the POSIX.1 names above instead.
2912 @comment fcntl.h
2913 @comment GNU
2914 @deftypevr Macro int O_READ
2915 Open the file for reading.  Same as @code{O_RDWR}; only defined on GNU.
2916 @end deftypevr
2918 @comment fcntl.h
2919 @comment GNU
2920 @deftypevr Macro int O_WRITE
2921 Open the file for reading.  Same as @code{O_WRONLY}; only defined on GNU.
2922 @end deftypevr
2924 @comment fcntl.h
2925 @comment GNU
2926 @deftypevr Macro int O_EXEC
2927 Open the file for executing.  Only defined on GNU.
2928 @end deftypevr
2930 To determine the file access mode with @code{fcntl}, you must extract
2931 the access mode bits from the retrieved file status flags.  In the GNU
2932 system, you can just test the @code{O_READ} and @code{O_WRITE} bits in
2933 the flags word.  But in other POSIX.1 systems, reading and writing
2934 access modes are not stored as distinct bit flags.  The portable way to
2935 extract the file access mode bits is with @code{O_ACCMODE}.
2937 @comment fcntl.h
2938 @comment POSIX.1
2939 @deftypevr Macro int O_ACCMODE
2940 This macro stands for a mask that can be bitwise-ANDed with the file
2941 status flag value to produce a value representing the file access mode.
2942 The mode will be @code{O_RDONLY}, @code{O_WRONLY}, or @code{O_RDWR}.
2943 (In the GNU system it could also be zero, and it never includes the
2944 @code{O_EXEC} bit.)
2945 @end deftypevr
2947 @node Open-time Flags
2948 @subsection Open-time Flags
2950 The open-time flags specify options affecting how @code{open} will behave.
2951 These options are not preserved once the file is open.  The exception to
2952 this is @code{O_NONBLOCK}, which is also an I/O operating mode and so it
2953 @emph{is} saved.  @xref{Opening and Closing Files}, for how to call
2954 @code{open}.
2956 There are two sorts of options specified by open-time flags.
2958 @itemize @bullet
2959 @item
2960 @dfn{File name translation flags} affect how @code{open} looks up the
2961 file name to locate the file, and whether the file can be created.
2962 @cindex file name translation flags
2963 @cindex flags, file name translation
2965 @item
2966 @dfn{Open-time action flags} specify extra operations that @code{open} will
2967 perform on the file once it is open.
2968 @cindex open-time action flags
2969 @cindex flags, open-time action
2970 @end itemize
2972 Here are the file name translation flags.
2974 @comment fcntl.h
2975 @comment POSIX.1
2976 @deftypevr Macro int O_CREAT
2977 If set, the file will be created if it doesn't already exist.
2978 @c !!! mode arg, umask
2979 @cindex create on open (file status flag)
2980 @end deftypevr
2982 @comment fcntl.h
2983 @comment POSIX.1
2984 @deftypevr Macro int O_EXCL
2985 If both @code{O_CREAT} and @code{O_EXCL} are set, then @code{open} fails
2986 if the specified file already exists.  This is guaranteed to never
2987 clobber an existing file.
2988 @end deftypevr
2990 @comment fcntl.h
2991 @comment POSIX.1
2992 @deftypevr Macro int O_NONBLOCK
2993 @cindex non-blocking open
2994 This prevents @code{open} from blocking for a ``long time'' to open the
2995 file.  This is only meaningful for some kinds of files, usually devices
2996 such as serial ports; when it is not meaningful, it is harmless and
2997 ignored.  Often opening a port to a modem blocks until the modem reports
2998 carrier detection; if @code{O_NONBLOCK} is specified, @code{open} will
2999 return immediately without a carrier.
3001 Note that the @code{O_NONBLOCK} flag is overloaded as both an I/O operating
3002 mode and a file name translation flag.  This means that specifying
3003 @code{O_NONBLOCK} in @code{open} also sets nonblocking I/O mode;
3004 @pxref{Operating Modes}.  To open the file without blocking but do normal
3005 I/O that blocks, you must call @code{open} with @code{O_NONBLOCK} set and
3006 then call @code{fcntl} to turn the bit off.
3007 @end deftypevr
3009 @comment fcntl.h
3010 @comment POSIX.1
3011 @deftypevr Macro int O_NOCTTY
3012 If the named file is a terminal device, don't make it the controlling
3013 terminal for the process.  @xref{Job Control}, for information about
3014 what it means to be the controlling terminal.
3016 In the GNU system and 4.4 BSD, opening a file never makes it the
3017 controlling terminal and @code{O_NOCTTY} is zero.  However, other
3018 systems may use a nonzero value for @code{O_NOCTTY} and set the
3019 controlling terminal when you open a file that is a terminal device; so
3020 to be portable, use @code{O_NOCTTY} when it is important to avoid this.
3021 @cindex controlling terminal, setting
3022 @end deftypevr
3024 The following three file name translation flags exist only in the GNU system.
3026 @comment fcntl.h
3027 @comment GNU
3028 @deftypevr Macro int O_IGNORE_CTTY
3029 Do not recognize the named file as the controlling terminal, even if it
3030 refers to the process's existing controlling terminal device.  Operations
3031 on the new file descriptor will never induce job control signals.
3032 @xref{Job Control}.
3033 @end deftypevr
3035 @comment fcntl.h
3036 @comment GNU
3037 @deftypevr Macro int O_NOLINK
3038 If the named file is a symbolic link, open the link itself instead of
3039 the file it refers to.  (@code{fstat} on the new file descriptor will
3040 return the information returned by @code{lstat} on the link's name.)
3041 @cindex symbolic link, opening
3042 @end deftypevr
3044 @comment fcntl.h
3045 @comment GNU
3046 @deftypevr Macro int O_NOTRANS
3047 If the named file is specially translated, do not invoke the translator.
3048 Open the bare file the translator itself sees.
3049 @end deftypevr
3052 The open-time action flags tell @code{open} to do additional operations
3053 which are not really related to opening the file.  The reason to do them
3054 as part of @code{open} instead of in separate calls is that @code{open}
3055 can do them @i{atomically}.
3057 @comment fcntl.h
3058 @comment POSIX.1
3059 @deftypevr Macro int O_TRUNC
3060 Truncate the file to zero length.  This option is only useful for
3061 regular files, not special files such as directories or FIFOs.  POSIX.1
3062 requires that you open the file for writing to use @code{O_TRUNC}.  In
3063 BSD and GNU you must have permission to write the file to truncate it,
3064 but you need not open for write access.
3066 This is the only open-time action flag specified by POSIX.1.  There is
3067 no good reason for truncation to be done by @code{open}, instead of by
3068 calling @code{ftruncate} afterwards.  The @code{O_TRUNC} flag existed in
3069 Unix before @code{ftruncate} was invented, and is retained for backward
3070 compatibility.
3071 @end deftypevr
3073 @comment fcntl.h
3074 @comment BSD
3075 @deftypevr Macro int O_SHLOCK
3076 Acquire a shared lock on the file, as with @code{flock}.
3077 @xref{File Locks}.
3079 If @code{O_CREAT} is specified, the locking is done atomically when
3080 creating the file.  You are guaranteed that no other process will get
3081 the lock on the new file first.
3082 @end deftypevr
3084 @comment fcntl.h
3085 @comment BSD
3086 @deftypevr Macro int O_EXLOCK
3087 Acquire an exclusive lock on the file, as with @code{flock}.
3088 @xref{File Locks}.  This is atomic like @code{O_SHLOCK}.
3089 @end deftypevr
3091 @node Operating Modes
3092 @subsection I/O Operating Modes
3094 The operating modes affect how input and output operations using a file
3095 descriptor work.  These flags are set by @code{open} and can be fetched
3096 and changed with @code{fcntl}.
3098 @comment fcntl.h
3099 @comment POSIX.1
3100 @deftypevr Macro int O_APPEND
3101 The bit that enables append mode for the file.  If set, then all
3102 @code{write} operations write the data at the end of the file, extending
3103 it, regardless of the current file position.  This is the only reliable
3104 way to append to a file.  In append mode, you are guaranteed that the
3105 data you write will always go to the current end of the file, regardless
3106 of other processes writing to the file.  Conversely, if you simply set
3107 the file position to the end of file and write, then another process can
3108 extend the file after you set the file position but before you write,
3109 resulting in your data appearing someplace before the real end of file.
3110 @end deftypevr
3112 @comment fcntl.h
3113 @comment POSIX.1
3114 @deftypevr Macro int O_NONBLOCK
3115 The bit that enables nonblocking mode for the file.  If this bit is set,
3116 @code{read} requests on the file can return immediately with a failure
3117 status if there is no input immediately available, instead of blocking.
3118 Likewise, @code{write} requests can also return immediately with a
3119 failure status if the output can't be written immediately.
3121 Note that the @code{O_NONBLOCK} flag is overloaded as both an I/O
3122 operating mode and a file name translation flag; @pxref{Open-time Flags}.
3123 @end deftypevr
3125 @comment fcntl.h
3126 @comment BSD
3127 @deftypevr Macro int O_NDELAY
3128 This is an obsolete name for @code{O_NONBLOCK}, provided for
3129 compatibility with BSD.  It is not defined by the POSIX.1 standard.
3130 @end deftypevr
3132 The remaining operating modes are BSD and GNU extensions.  They exist only
3133 on some systems.  On other systems, these macros are not defined.
3135 @comment fcntl.h
3136 @comment BSD
3137 @deftypevr Macro int O_ASYNC
3138 The bit that enables asynchronous input mode.  If set, then @code{SIGIO}
3139 signals will be generated when input is available.  @xref{Interrupt Input}.
3141 Asynchronous input mode is a BSD feature.
3142 @end deftypevr
3144 @comment fcntl.h
3145 @comment BSD
3146 @deftypevr Macro int O_FSYNC
3147 The bit that enables synchronous writing for the file.  If set, each
3148 @code{write} call will make sure the data is reliably stored on disk before
3149 returning. @c !!! xref fsync
3151 Synchronous writing is a BSD feature.
3152 @end deftypevr
3154 @comment fcntl.h
3155 @comment BSD
3156 @deftypevr Macro int O_SYNC
3157 This is another name for @code{O_FSYNC}.  They have the same value.
3158 @end deftypevr
3160 @comment fcntl.h
3161 @comment GNU
3162 @deftypevr Macro int O_NOATIME
3163 If this bit is set, @code{read} will not update the access time of the
3164 file.  @xref{File Times}.  This is used by programs that do backups, so
3165 that backing a file up does not count as reading it.
3166 Only the owner of the file or the superuser may use this bit.
3168 This is a GNU extension.
3169 @end deftypevr
3171 @node Getting File Status Flags
3172 @subsection Getting and Setting File Status Flags
3174 The @code{fcntl} function can fetch or change file status flags.
3176 @comment fcntl.h
3177 @comment POSIX.1
3178 @deftypevr Macro int F_GETFL
3179 This macro is used as the @var{command} argument to @code{fcntl}, to
3180 read the file status flags for the open file with descriptor
3181 @var{filedes}.
3183 The normal return value from @code{fcntl} with this command is a
3184 nonnegative number which can be interpreted as the bitwise OR of the
3185 individual flags.  Since the file access modes are not single-bit values,
3186 you can mask off other bits in the returned flags with @code{O_ACCMODE}
3187 to compare them.
3189 In case of an error, @code{fcntl} returns @math{-1}.  The following
3190 @code{errno} error conditions are defined for this command:
3192 @table @code
3193 @item EBADF
3194 The @var{filedes} argument is invalid.
3195 @end table
3196 @end deftypevr
3198 @comment fcntl.h
3199 @comment POSIX.1
3200 @deftypevr Macro int F_SETFL
3201 This macro is used as the @var{command} argument to @code{fcntl}, to set
3202 the file status flags for the open file corresponding to the
3203 @var{filedes} argument.  This command requires a third @code{int}
3204 argument to specify the new flags, so the call looks like this:
3206 @smallexample
3207 fcntl (@var{filedes}, F_SETFL, @var{new-flags})
3208 @end smallexample
3210 You can't change the access mode for the file in this way; that is,
3211 whether the file descriptor was opened for reading or writing.
3213 The normal return value from @code{fcntl} with this command is an
3214 unspecified value other than @math{-1}, which indicates an error.  The
3215 error conditions are the same as for the @code{F_GETFL} command.
3216 @end deftypevr
3218 If you want to modify the file status flags, you should get the current
3219 flags with @code{F_GETFL} and modify the value.  Don't assume that the
3220 flags listed here are the only ones that are implemented; your program
3221 may be run years from now and more flags may exist then.  For example,
3222 here is a function to set or clear the flag @code{O_NONBLOCK} without
3223 altering any other flags:
3225 @smallexample
3226 @group
3227 /* @r{Set the @code{O_NONBLOCK} flag of @var{desc} if @var{value} is nonzero,}
3228    @r{or clear the flag if @var{value} is 0.}
3229    @r{Return 0 on success, or -1 on error with @code{errno} set.} */
3232 set_nonblock_flag (int desc, int value)
3234   int oldflags = fcntl (desc, F_GETFL, 0);
3235   /* @r{If reading the flags failed, return error indication now.} */
3236   if (oldflags == -1)
3237     return -1;
3238   /* @r{Set just the flag we want to set.} */
3239   if (value != 0)
3240     oldflags |= O_NONBLOCK;
3241   else
3242     oldflags &= ~O_NONBLOCK;
3243   /* @r{Store modified flag word in the descriptor.} */
3244   return fcntl (desc, F_SETFL, oldflags);
3246 @end group
3247 @end smallexample
3249 @node File Locks
3250 @section File Locks
3252 @cindex file locks
3253 @cindex record locking
3254 The remaining @code{fcntl} commands are used to support @dfn{record
3255 locking}, which permits multiple cooperating programs to prevent each
3256 other from simultaneously accessing parts of a file in error-prone
3257 ways.
3259 @cindex exclusive lock
3260 @cindex write lock
3261 An @dfn{exclusive} or @dfn{write} lock gives a process exclusive access
3262 for writing to the specified part of the file.  While a write lock is in
3263 place, no other process can lock that part of the file.
3265 @cindex shared lock
3266 @cindex read lock
3267 A @dfn{shared} or @dfn{read} lock prohibits any other process from
3268 requesting a write lock on the specified part of the file.  However,
3269 other processes can request read locks.
3271 The @code{read} and @code{write} functions do not actually check to see
3272 whether there are any locks in place.  If you want to implement a
3273 locking protocol for a file shared by multiple processes, your application
3274 must do explicit @code{fcntl} calls to request and clear locks at the
3275 appropriate points.
3277 Locks are associated with processes.  A process can only have one kind
3278 of lock set for each byte of a given file.  When any file descriptor for
3279 that file is closed by the process, all of the locks that process holds
3280 on that file are released, even if the locks were made using other
3281 descriptors that remain open.  Likewise, locks are released when a
3282 process exits, and are not inherited by child processes created using
3283 @code{fork} (@pxref{Creating a Process}).
3285 When making a lock, use a @code{struct flock} to specify what kind of
3286 lock and where.  This data type and the associated macros for the
3287 @code{fcntl} function are declared in the header file @file{fcntl.h}.
3288 @pindex fcntl.h
3290 @comment fcntl.h
3291 @comment POSIX.1
3292 @deftp {Data Type} {struct flock}
3293 This structure is used with the @code{fcntl} function to describe a file
3294 lock.  It has these members:
3296 @table @code
3297 @item short int l_type
3298 Specifies the type of the lock; one of @code{F_RDLCK}, @code{F_WRLCK}, or
3299 @code{F_UNLCK}.
3301 @item short int l_whence
3302 This corresponds to the @var{whence} argument to @code{fseek} or
3303 @code{lseek}, and specifies what the offset is relative to.  Its value
3304 can be one of @code{SEEK_SET}, @code{SEEK_CUR}, or @code{SEEK_END}.
3306 @item off_t l_start
3307 This specifies the offset of the start of the region to which the lock
3308 applies, and is given in bytes relative to the point specified by
3309 @code{l_whence} member.
3311 @item off_t l_len
3312 This specifies the length of the region to be locked.  A value of
3313 @code{0} is treated specially; it means the region extends to the end of
3314 the file.
3316 @item pid_t l_pid
3317 This field is the process ID (@pxref{Process Creation Concepts}) of the
3318 process holding the lock.  It is filled in by calling @code{fcntl} with
3319 the @code{F_GETLK} command, but is ignored when making a lock.
3320 @end table
3321 @end deftp
3323 @comment fcntl.h
3324 @comment POSIX.1
3325 @deftypevr Macro int F_GETLK
3326 This macro is used as the @var{command} argument to @code{fcntl}, to
3327 specify that it should get information about a lock.  This command
3328 requires a third argument of type @w{@code{struct flock *}} to be passed
3329 to @code{fcntl}, so that the form of the call is:
3331 @smallexample
3332 fcntl (@var{filedes}, F_GETLK, @var{lockp})
3333 @end smallexample
3335 If there is a lock already in place that would block the lock described
3336 by the @var{lockp} argument, information about that lock overwrites
3337 @code{*@var{lockp}}.  Existing locks are not reported if they are
3338 compatible with making a new lock as specified.  Thus, you should
3339 specify a lock type of @code{F_WRLCK} if you want to find out about both
3340 read and write locks, or @code{F_RDLCK} if you want to find out about
3341 write locks only.
3343 There might be more than one lock affecting the region specified by the
3344 @var{lockp} argument, but @code{fcntl} only returns information about
3345 one of them.  The @code{l_whence} member of the @var{lockp} structure is
3346 set to @code{SEEK_SET} and the @code{l_start} and @code{l_len} fields
3347 set to identify the locked region.
3349 If no lock applies, the only change to the @var{lockp} structure is to
3350 update the @code{l_type} to a value of @code{F_UNLCK}.
3352 The normal return value from @code{fcntl} with this command is an
3353 unspecified value other than @math{-1}, which is reserved to indicate an
3354 error.  The following @code{errno} error conditions are defined for
3355 this command:
3357 @table @code
3358 @item EBADF
3359 The @var{filedes} argument is invalid.
3361 @item EINVAL
3362 Either the @var{lockp} argument doesn't specify valid lock information,
3363 or the file associated with @var{filedes} doesn't support locks.
3364 @end table
3365 @end deftypevr
3367 @comment fcntl.h
3368 @comment POSIX.1
3369 @deftypevr Macro int F_SETLK
3370 This macro is used as the @var{command} argument to @code{fcntl}, to
3371 specify that it should set or clear a lock.  This command requires a
3372 third argument of type @w{@code{struct flock *}} to be passed to
3373 @code{fcntl}, so that the form of the call is:
3375 @smallexample
3376 fcntl (@var{filedes}, F_SETLK, @var{lockp})
3377 @end smallexample
3379 If the process already has a lock on any part of the region, the old lock
3380 on that part is replaced with the new lock.  You can remove a lock
3381 by specifying a lock type of @code{F_UNLCK}.
3383 If the lock cannot be set, @code{fcntl} returns immediately with a value
3384 of @math{-1}.  This function does not block waiting for other processes
3385 to release locks.  If @code{fcntl} succeeds, it return a value other
3386 than @math{-1}.
3388 The following @code{errno} error conditions are defined for this
3389 function:
3391 @table @code
3392 @item EAGAIN
3393 @itemx EACCES
3394 The lock cannot be set because it is blocked by an existing lock on the
3395 file.  Some systems use @code{EAGAIN} in this case, and other systems
3396 use @code{EACCES}; your program should treat them alike, after
3397 @code{F_SETLK}.  (The GNU system always uses @code{EAGAIN}.)
3399 @item EBADF
3400 Either: the @var{filedes} argument is invalid; you requested a read lock
3401 but the @var{filedes} is not open for read access; or, you requested a
3402 write lock but the @var{filedes} is not open for write access.
3404 @item EINVAL
3405 Either the @var{lockp} argument doesn't specify valid lock information,
3406 or the file associated with @var{filedes} doesn't support locks.
3408 @item ENOLCK
3409 The system has run out of file lock resources; there are already too
3410 many file locks in place.
3412 Well-designed file systems never report this error, because they have no
3413 limitation on the number of locks.  However, you must still take account
3414 of the possibility of this error, as it could result from network access
3415 to a file system on another machine.
3416 @end table
3417 @end deftypevr
3419 @comment fcntl.h
3420 @comment POSIX.1
3421 @deftypevr Macro int F_SETLKW
3422 This macro is used as the @var{command} argument to @code{fcntl}, to
3423 specify that it should set or clear a lock.  It is just like the
3424 @code{F_SETLK} command, but causes the process to block (or wait)
3425 until the request can be specified.
3427 This command requires a third argument of type @code{struct flock *}, as
3428 for the @code{F_SETLK} command.
3430 The @code{fcntl} return values and errors are the same as for the
3431 @code{F_SETLK} command, but these additional @code{errno} error conditions
3432 are defined for this command:
3434 @table @code
3435 @item EINTR
3436 The function was interrupted by a signal while it was waiting.
3437 @xref{Interrupted Primitives}.
3439 @item EDEADLK
3440 The specified region is being locked by another process.  But that
3441 process is waiting to lock a region which the current process has
3442 locked, so waiting for the lock would result in deadlock.  The system
3443 does not guarantee that it will detect all such conditions, but it lets
3444 you know if it notices one.
3445 @end table
3446 @end deftypevr
3449 The following macros are defined for use as values for the @code{l_type}
3450 member of the @code{flock} structure.  The values are integer constants.
3452 @table @code
3453 @comment fcntl.h
3454 @comment POSIX.1
3455 @vindex F_RDLCK
3456 @item F_RDLCK
3457 This macro is used to specify a read (or shared) lock.
3459 @comment fcntl.h
3460 @comment POSIX.1
3461 @vindex F_WRLCK
3462 @item F_WRLCK
3463 This macro is used to specify a write (or exclusive) lock.
3465 @comment fcntl.h
3466 @comment POSIX.1
3467 @vindex F_UNLCK
3468 @item F_UNLCK
3469 This macro is used to specify that the region is unlocked.
3470 @end table
3472 As an example of a situation where file locking is useful, consider a
3473 program that can be run simultaneously by several different users, that
3474 logs status information to a common file.  One example of such a program
3475 might be a game that uses a file to keep track of high scores.  Another
3476 example might be a program that records usage or accounting information
3477 for billing purposes.
3479 Having multiple copies of the program simultaneously writing to the
3480 file could cause the contents of the file to become mixed up.  But
3481 you can prevent this kind of problem by setting a write lock on the
3482 file before actually writing to the file.
3484 If the program also needs to read the file and wants to make sure that
3485 the contents of the file are in a consistent state, then it can also use
3486 a read lock.  While the read lock is set, no other process can lock
3487 that part of the file for writing.
3489 @c ??? This section could use an example program.
3491 Remember that file locks are only a @emph{voluntary} protocol for
3492 controlling access to a file.  There is still potential for access to
3493 the file by programs that don't use the lock protocol.
3495 @node Interrupt Input
3496 @section Interrupt-Driven Input
3498 @cindex interrupt-driven input
3499 If you set the @code{O_ASYNC} status flag on a file descriptor
3500 (@pxref{File Status Flags}), a @code{SIGIO} signal is sent whenever
3501 input or output becomes possible on that file descriptor.  The process
3502 or process group to receive the signal can be selected by using the
3503 @code{F_SETOWN} command to the @code{fcntl} function.  If the file
3504 descriptor is a socket, this also selects the recipient of @code{SIGURG}
3505 signals that are delivered when out-of-band data arrives on that socket;
3506 see @ref{Out-of-Band Data}.  (@code{SIGURG} is sent in any situation
3507 where @code{select} would report the socket as having an ``exceptional
3508 condition''.  @xref{Waiting for I/O}.)
3510 If the file descriptor corresponds to a terminal device, then @code{SIGIO}
3511 signals are sent to the foreground process group of the terminal.
3512 @xref{Job Control}.
3514 @pindex fcntl.h
3515 The symbols in this section are defined in the header file
3516 @file{fcntl.h}.
3518 @comment fcntl.h
3519 @comment BSD
3520 @deftypevr Macro int F_GETOWN
3521 This macro is used as the @var{command} argument to @code{fcntl}, to
3522 specify that it should get information about the process or process
3523 group to which @code{SIGIO} signals are sent.  (For a terminal, this is
3524 actually the foreground process group ID, which you can get using
3525 @code{tcgetpgrp}; see @ref{Terminal Access Functions}.)
3527 The return value is interpreted as a process ID; if negative, its
3528 absolute value is the process group ID.
3530 The following @code{errno} error condition is defined for this command:
3532 @table @code
3533 @item EBADF
3534 The @var{filedes} argument is invalid.
3535 @end table
3536 @end deftypevr
3538 @comment fcntl.h
3539 @comment BSD
3540 @deftypevr Macro int F_SETOWN
3541 This macro is used as the @var{command} argument to @code{fcntl}, to
3542 specify that it should set the process or process group to which
3543 @code{SIGIO} signals are sent.  This command requires a third argument
3544 of type @code{pid_t} to be passed to @code{fcntl}, so that the form of
3545 the call is:
3547 @smallexample
3548 fcntl (@var{filedes}, F_SETOWN, @var{pid})
3549 @end smallexample
3551 The @var{pid} argument should be a process ID.  You can also pass a
3552 negative number whose absolute value is a process group ID.
3554 The return value from @code{fcntl} with this command is @math{-1}
3555 in case of error and some other value if successful.  The following
3556 @code{errno} error conditions are defined for this command:
3558 @table @code
3559 @item EBADF
3560 The @var{filedes} argument is invalid.
3562 @item ESRCH
3563 There is no process or process group corresponding to @var{pid}.
3564 @end table
3565 @end deftypevr
3567 @c ??? This section could use an example program.
3569 @node IOCTLs
3570 @section Generic I/O Control operations
3571 @cindex generic i/o control operations
3572 @cindex IOCTLs
3574 The GNU system can handle most input/output operations on many different
3575 devices and objects in terms of a few file primitives - @code{read},
3576 @code{write} and @code{lseek}.  However, most devices also have a few
3577 peculiar operations which do not fit into this model. Such as:
3579 @itemize @bullet
3581 @item
3582 Changing the character font used on a terminal.
3584 @item
3585 Telling a magnetic tape system to rewind or fast forward.  (Since they
3586 cannot move in byte increments, @code{lseek} is inapplicable).
3588 @item
3589 Ejecting a disk from a drive.
3591 @item
3592 Playing an audio track from a CD-ROM drive.
3594 @item
3595 Maintaining routing tables for a network.
3597 @end itemize
3599 Although some such objects such as sockets and terminals
3600 @footnote{Actually, the terminal-specific functions are implemented with
3601 IOCTLs on many platforms.} have special functions of their own, it would
3602 not be practical to create functions for all these cases.
3604 Instead these minor operations, known as @dfn{IOCTL}s, are assigned code
3605 numbers and multiplexed through the @code{ioctl} function, defined in
3606 @code{sys/ioctl.h}.  The code numbers themselves are defined in many
3607 different headers.
3609 @deftypefun int ioctl (int @var{filedes}, int @var{command}, @dots{})
3611 The @code{ioctl} function performs the generic I/O operation
3612 @var{command} on @var{filedes}.
3614 A third argument is usually present, either a single number or a pointer
3615 to a structure.  The meaning of this argument, the returned value, and
3616 any error codes depends upon the command used.  Often @math{-1} is
3617 returned for a failure.
3619 @end deftypefun
3621 On some systems, IOCTLs used by different devices share the same numbers.
3622 Thus, although use of an inappropriate IOCTL @emph{usually} only produces
3623 an error, you should not attempt to use device-specific IOCTLs on an
3624 unknown device.
3626 Most IOCTLs are OS-specific and/or only used in special system utilities,
3627 and are thus beyond the scope of this document.  For an example of the use
3628 of an IOCTL, @xref{Out-of-Band Data}.