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