1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2012-03-22 04:25+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=CHARSET\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man7/aio.7:24
26 #: build/C/man7/aio.7:24 build/C/man3/aio_fsync.3:23 build/C/man3/aio_suspend.3:24 build/C/man3/aio_write.3:23
32 #: build/C/man7/aio.7:24 build/C/man3/aio_init.3:24 build/C/man2/io_cancel.2:23 build/C/man2/io_destroy.2:23 build/C/man2/io_getevents.2:23 build/C/man2/io_setup.2:23 build/C/man2/io_submit.2:23
38 #: build/C/man7/aio.7:24 build/C/man3/aio_cancel.3:23 build/C/man3/aio_error.3:23 build/C/man3/aio_fsync.3:23 build/C/man3/aio_init.3:24 build/C/man3/aio_read.3:23 build/C/man3/aio_return.3:23 build/C/man3/aio_suspend.3:24 build/C/man3/aio_write.3:23 build/C/man2/io_cancel.2:23 build/C/man2/io_destroy.2:23 build/C/man2/io_getevents.2:23 build/C/man2/io_setup.2:23 build/C/man2/io_submit.2:23 build/C/man3/lio_listio.3:23
40 msgid "Linux Programmer's Manual"
44 #: build/C/man7/aio.7:25 build/C/man3/aio_cancel.3:24 build/C/man3/aio_error.3:24 build/C/man3/aio_fsync.3:24 build/C/man3/aio_init.3:25 build/C/man3/aio_read.3:24 build/C/man3/aio_return.3:24 build/C/man3/aio_suspend.3:25 build/C/man3/aio_write.3:24 build/C/man2/io_cancel.2:24 build/C/man2/io_destroy.2:24 build/C/man2/io_getevents.2:24 build/C/man2/io_setup.2:24 build/C/man2/io_submit.2:24 build/C/man3/lio_listio.3:24
50 #: build/C/man7/aio.7:27
51 msgid "aio - POSIX asynchronous I/O overview"
55 #: build/C/man7/aio.7:27 build/C/man3/aio_cancel.3:32 build/C/man3/aio_error.3:32 build/C/man3/aio_fsync.3:32 build/C/man3/aio_init.3:36 build/C/man3/aio_read.3:32 build/C/man3/aio_return.3:32 build/C/man3/aio_suspend.3:38 build/C/man3/aio_write.3:32 build/C/man2/io_cancel.2:42 build/C/man2/io_destroy.2:40 build/C/man2/io_getevents.2:43 build/C/man2/io_setup.2:40 build/C/man2/io_submit.2:41 build/C/man3/lio_listio.3:35
61 #: build/C/man7/aio.7:35
63 "The POSIX asynchronous I/O (AIO) interface allows applications to initiate "
64 "one or more I/O operations that are performed asynchronously (i.e., in the "
65 "background). The application can elect to be notified of completion of the "
66 "I/O operation in a variety of ways: by delivery of a signal, by "
67 "instantiation of a thread, or no notification at all."
71 #: build/C/man7/aio.7:37
72 msgid "The POSIX AIO interface consists of the following functions:"
76 #: build/C/man7/aio.7:37
78 msgid "B<aio_read>(3)"
82 #: build/C/man7/aio.7:42
83 msgid "Enqueue a read request. This is the asynchronous analog of B<read>(2)."
87 #: build/C/man7/aio.7:42
89 msgid "B<aio_write>(3)"
93 #: build/C/man7/aio.7:47
94 msgid "Enqueue a write request. This is the asynchronous analog of B<write>(2)."
98 #: build/C/man7/aio.7:47
100 msgid "B<aio_fsync>(3)"
104 #: build/C/man7/aio.7:54
106 "Enqueue a sync request for the I/O operations on a file descriptor. This is "
107 "the asynchronous analog of B<fsync>(2) and B<fdatasync>(2)."
111 #: build/C/man7/aio.7:54
113 msgid "B<aio_error>(3)"
117 #: build/C/man7/aio.7:57
118 msgid "Obtain the error status of an enqueued I/O request."
122 #: build/C/man7/aio.7:57
124 msgid "B<aio_return>(3)"
128 #: build/C/man7/aio.7:60
129 msgid "Obtain the return status of a completed I/O request."
133 #: build/C/man7/aio.7:60
135 msgid "B<aio_suspend>(3)"
139 #: build/C/man7/aio.7:64
141 "Suspend the caller until one or more of a specified set of I/O requests "
146 #: build/C/man7/aio.7:64
148 msgid "B<aio_cancel>(3)"
152 #: build/C/man7/aio.7:68
153 msgid "Attempt to cancel outstanding I/O requests on a specified file descriptor."
157 #: build/C/man7/aio.7:68
159 msgid "B<lio_listio>(3)"
163 #: build/C/man7/aio.7:71
164 msgid "Enqueue multiple I/O requests using a single function call."
168 #: build/C/man7/aio.7:78
170 "The I<aiocb> (\"asynchronous I/O control block\") structure defines "
171 "parameters that control an I/O operation. An argument of this type is "
172 "employed with all of the functions listed above. This structure has the "
177 #: build/C/man7/aio.7:82
179 msgid "#include E<lt>aiocb.hE<gt>\n"
183 #: build/C/man7/aio.7:85
187 " /* The order of these fields is implementation-dependent */\n"
191 #: build/C/man7/aio.7:94
194 " int aio_fildes; /* File descriptor */\n"
195 " off_t aio_offset; /* File offset */\n"
196 " volatile void *aio_buf; /* Location of buffer */\n"
197 " size_t aio_nbytes; /* Length of transfer */\n"
198 " int aio_reqprio; /* Request priority */\n"
199 " struct sigevent aio_sigevent; /* Notification method */\n"
200 " int aio_lio_opcode; /* Operation to be performed;\n"
201 " lio_listio() only */\n"
205 #: build/C/man7/aio.7:97
208 " /* Various implementation-internal fields not shown */\n"
213 #: build/C/man7/aio.7:99
215 msgid "/* Operation codes for \\(aqaio_lio_opcode\\(aq: */\n"
219 #: build/C/man7/aio.7:101
221 msgid "enum { LIO_READ, LIO_WRITE, LIO_NOP };\n"
225 #: build/C/man7/aio.7:105
226 msgid "The fields of this structure are as follows:"
230 #: build/C/man7/aio.7:105
232 msgid "I<aio_filedes>"
236 #: build/C/man7/aio.7:108
237 msgid "The file descriptor on which the I/O operation is to be performed."
241 #: build/C/man7/aio.7:108
243 msgid "I<aio_offset>"
247 #: build/C/man7/aio.7:111
248 msgid "This is the file offset at which the I/O operation is to be performed."
252 #: build/C/man7/aio.7:111
258 #: build/C/man7/aio.7:114
259 msgid "This is the buffer used to transfer data for a read or write operation."
263 #: build/C/man7/aio.7:114
265 msgid "I<aio_nbytes>"
269 #: build/C/man7/aio.7:118
270 msgid "This is the size of the buffer pointed to by I<aio_buf>."
274 #: build/C/man7/aio.7:118
276 msgid "I<aio_reqprio>"
280 #: build/C/man7/aio.7:127
282 "This field specifies a value that is subtracted from the calling thread's "
283 "real-time priority in order to determine the priority for execution of this "
284 "I/O request (see B<pthread_setschedparam>(3)). The specified value must be "
285 "between 0 and the value returned by I<sysconf(_SC_AIO_PRIO_DELTA_MAX)>. "
286 "This field is ignored for file synchronization operations."
290 #: build/C/man7/aio.7:127
292 msgid "I<aio_sigevent>"
296 #: build/C/man7/aio.7:141
298 "This field is a structure that specifies how the caller is to be notified "
299 "when the asynchronous I/O operation completes. Possible values for "
300 "I<aio_sigevent.sigev_notify> are B<SIGEV_NONE>, B<SIGEV_SIGNAL>, and "
301 "B<SIGEV_THREAD>. See B<sigevent>(7) for further details."
305 #: build/C/man7/aio.7:141
307 msgid "I<aio_lio_opcode>"
311 #: build/C/man7/aio.7:145
312 msgid "The type of operation to be performed; used only for B<lio_listio>(3)."
316 #: build/C/man7/aio.7:148
318 "In addition to the standard functions listed above, the GNU C library "
319 "provides the following extension to the POSIX AIO API:"
323 #: build/C/man7/aio.7:148
325 msgid "B<aio_init>(3)"
329 #: build/C/man7/aio.7:151
331 "Set parameters for tuning the behavior of the glibc POSIX AIO "
336 #: build/C/man7/aio.7:151 build/C/man3/aio_read.3:132 build/C/man3/aio_suspend.3:104 build/C/man3/aio_write.3:137 build/C/man2/io_cancel.2:78 build/C/man2/io_destroy.2:72 build/C/man2/io_getevents.2:85 build/C/man2/io_setup.2:81 build/C/man2/io_submit.2:83 build/C/man3/lio_listio.3:206
342 #: build/C/man7/aio.7:158
344 "It is a good idea to zero out the control block buffer before use (see "
345 "B<memset>(3)). The control block buffer and the buffer pointed to by "
346 "I<aio_buf> must not be changed while the I/O operation is in progress. "
347 "These buffers must remain valid until the I/O operation completes."
351 #: build/C/man7/aio.7:162
353 "Simultaneous asynchronous read or write operations using the same I<aiocb> "
354 "structure yield undefined results."
357 #. http://lse.sourceforge.net/io/aio.html
358 #. http://lse.sourceforge.net/io/aionotes.txt
359 #. http://lwn.net/Articles/148755/
361 #: build/C/man7/aio.7:180
363 "The current Linux POSIX AIO implementation is provided in userspace by "
364 "glibc. This has a number of limitations, most notably that maintaining "
365 "multiple threads to perform I/O operations is expensive and scales poorly. "
366 "Work has been in progress for some time on a kernel state-machine-based "
367 "implementation of asynchronous I/O (see B<io_submit>(2), B<io_setup>(2), "
368 "B<io_cancel>(2), B<io_destroy>(2), B<io_getevents>(2)), but this "
369 "implementation hasn't yet matured to the point where the POSIX AIO "
370 "implementation can be completely reimplemented using the kernel system "
375 #: build/C/man7/aio.7:180 build/C/man3/aio_cancel.3:87 build/C/man3/aio_error.3:65 build/C/man3/aio_fsync.3:78 build/C/man3/aio_read.3:102 build/C/man3/aio_return.3:62 build/C/man3/aio_suspend.3:87 build/C/man3/aio_write.3:109 build/C/man2/io_cancel.2:56 build/C/man2/io_destroy.2:53 build/C/man2/io_getevents.2:60 build/C/man2/io_setup.2:54 build/C/man2/io_submit.2:54 build/C/man3/lio_listio.3:145
381 #: build/C/man7/aio.7:181 build/C/man3/aio_error.3:66 build/C/man3/aio_fsync.3:86 build/C/man3/aio_read.3:110 build/C/man3/aio_return.3:63 build/C/man3/aio_write.3:121 build/C/man2/io_cancel.2:63 build/C/man2/io_destroy.2:57 build/C/man2/io_getevents.2:64 build/C/man2/io_setup.2:61 build/C/man2/io_submit.2:64 build/C/man3/lio_listio.3:160
387 #: build/C/man7/aio.7:190
389 "The I<aio_reqprio> field of the I<aiocb> structure was less than 0, or was "
390 "greater than the limit returned by the call "
391 "I<sysconf(_SC_AIO_PRIO_DELTA_MAX)>."
395 #: build/C/man7/aio.7:190 build/C/man3/aio_cancel.3:92 build/C/man3/aio_error.3:73 build/C/man3/aio_fsync.3:94 build/C/man3/aio_init.3:91 build/C/man3/aio_read.3:126 build/C/man3/aio_return.3:68 build/C/man3/aio_suspend.3:98 build/C/man3/aio_write.3:131 build/C/man2/io_cancel.2:70 build/C/man2/io_destroy.2:64 build/C/man2/io_getevents.2:77 build/C/man2/io_setup.2:73 build/C/man2/io_submit.2:75 build/C/man3/lio_listio.3:200
401 #: build/C/man7/aio.7:192
402 msgid "The POSIX AIO interfaces are provided by glibc since version 2.1."
406 #: build/C/man7/aio.7:192 build/C/man3/aio_cancel.3:96 build/C/man3/aio_error.3:77 build/C/man3/aio_fsync.3:98 build/C/man3/aio_init.3:95 build/C/man3/aio_read.3:130 build/C/man3/aio_return.3:72 build/C/man3/aio_suspend.3:102 build/C/man3/aio_write.3:135 build/C/man2/io_cancel.2:73 build/C/man2/io_destroy.2:67 build/C/man2/io_getevents.2:80 build/C/man2/io_setup.2:76 build/C/man2/io_submit.2:78 build/C/man3/lio_listio.3:204
408 msgid "CONFORMING TO"
412 #: build/C/man7/aio.7:194 build/C/man3/aio_cancel.3:98 build/C/man3/aio_error.3:79 build/C/man3/aio_fsync.3:100 build/C/man3/aio_read.3:132 build/C/man3/aio_return.3:74 build/C/man3/aio_suspend.3:104 build/C/man3/aio_write.3:137 build/C/man3/lio_listio.3:206
413 msgid "POSIX.1-2001, POSIX.1-2008."
417 #: build/C/man7/aio.7:194 build/C/man3/aio_cancel.3:98 build/C/man3/aio_error.3:79 build/C/man3/aio_read.3:144 build/C/man3/aio_return.3:74
423 #: build/C/man7/aio.7:207
425 "The program below opens each of the files named in its command-line "
426 "arguments and queues a request on the resulting file descriptor using "
427 "B<aio_read>(3). The program then loops, periodically monitoring each of the "
428 "I/O operations that is still in progress using B<aio_error>(3). Each of the "
429 "I/O requests is set up to provide notification by delivery of a signal. "
430 "After all I/O requests have completed, the program retrieves their status "
431 "using B<aio_return>(3)."
435 #: build/C/man7/aio.7:213
437 "The B<SIGQUIT> signal (generated by typing control-\\e) causes the program "
438 "to request cancellation of each of the outstanding requests using "
443 #: build/C/man7/aio.7:218
445 "Here is an example of what we might see when running this program. In this "
446 "example, the program queues two requests to standard input, and these are "
447 "satisfied by two lines of input containing \"abc\" and \"x\"."
451 #: build/C/man7/aio.7:242
454 "$ B<./a.out /dev/stdin /dev/stdin>\n"
455 "opened /dev/stdin on descriptor 3\n"
456 "opened /dev/stdin on descriptor 4\n"
458 " for request 0 (descriptor 3): In progress\n"
459 " for request 1 (descriptor 4): In progress\n"
461 "I/O completion signal received\n"
463 " for request 0 (descriptor 3): I/O succeeded\n"
464 " for request 1 (descriptor 4): In progress\n"
466 " for request 1 (descriptor 4): In progress\n"
468 "I/O completion signal received\n"
470 " for request 1 (descriptor 4): I/O succeeded\n"
471 "All I/O requests completed\n"
473 " for request 0 (descriptor 3): 4\n"
474 " for request 1 (descriptor 4): 2\n"
478 #: build/C/man7/aio.7:244
480 msgid "Program source"
484 #: build/C/man7/aio.7:253
487 "#include E<lt>stdlib.hE<gt>\n"
488 "#include E<lt>unistd.hE<gt>\n"
489 "#include E<lt>stdio.hE<gt>\n"
490 "#include E<lt>errno.hE<gt>\n"
491 "#include E<lt>aio.hE<gt>\n"
492 "#include E<lt>signal.hE<gt>\n"
496 #: build/C/man7/aio.7:255
498 msgid "#define BUF_SIZE 20 /* Size of buffers for read operations */\n"
502 #: build/C/man7/aio.7:257
504 msgid "#define errExit(msg) do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
508 #: build/C/man7/aio.7:259
510 msgid "#define errMsg(msg) do { perror(msg); } while (0)\n"
514 #: build/C/man7/aio.7:266
517 "struct ioRequest { /* Application-defined structure for tracking\n"
521 " struct aiocb *aiocbp;\n"
526 #: build/C/man7/aio.7:270
529 "static volatile sig_atomic_t gotSIGQUIT = 0;\n"
530 " /* On delivery of SIGQUIT, we attempt to\n"
531 " cancel all outstanding I/O requests */\n"
535 #: build/C/man7/aio.7:276
538 "static void /* Handler for SIGQUIT */\n"
539 "quitHandler(int sig)\n"
546 #: build/C/man7/aio.7:278
548 msgid "#define IO_SIGNAL SIGUSR1 /* Signal used to notify I/O completion */\n"
552 #: build/C/man7/aio.7:283
555 "static void /* Handler for I/O completion signal */\n"
556 "aioSigHandler(int sig, siginfo_t *si, void *ucontext)\n"
558 " write(STDOUT_FILENO, \"I/O completion signal received\\en\", 31);\n"
562 #: build/C/man7/aio.7:289
565 " /* The corresponding ioRequest structure would be available as\n"
566 " struct ioRequest *ioReq = si-E<gt>si_value.sival_ptr;\n"
567 " and the file descriptor would then be available via\n"
568 " ioReq-E<gt>aiocbp-E<gt>aio_fildes */\n"
573 #: build/C/man7/aio.7:299
577 "main(int argc, char *argv[])\n"
579 " struct ioRequest *ioList;\n"
580 " struct aiocb *aiocbList;\n"
581 " struct sigaction sa;\n"
583 " int numReqs; /* Total number of queued I/O requests */\n"
584 " int openReqs; /* Number of I/O requests still in progress */\n"
588 #: build/C/man7/aio.7:305
591 " if (argc E<lt> 2) {\n"
592 " fprintf(stderr, \"Usage: %s E<lt>pathnameE<gt> "
593 "E<lt>pathnameE<gt>...\\en\",\n"
595 " exit(EXIT_FAILURE);\n"
600 #: build/C/man7/aio.7:307
602 msgid " numReqs = argc - 1;\n"
606 #: build/C/man7/aio.7:309
608 msgid " /* Allocate our arrays */\n"
612 #: build/C/man7/aio.7:313
615 " ioList = calloc(numReqs, sizeof(struct ioRequest));\n"
616 " if (ioList == NULL)\n"
617 " errExit(\"calloc\");\n"
621 #: build/C/man7/aio.7:317
624 " aiocbList = calloc(numReqs, sizeof(struct aiocb));\n"
625 " if (aiocbList == NULL)\n"
626 " errExit(\"calloc\");\n"
630 #: build/C/man7/aio.7:319
632 msgid " /* Establish handlers for SIGQUIT and the I/O completion signal */\n"
636 #: build/C/man7/aio.7:322
639 " sa.sa_flags = SA_RESTART;\n"
640 " sigemptyset(&sa.sa_mask);\n"
644 #: build/C/man7/aio.7:326
647 " sa.sa_handler = quitHandler;\n"
648 " if (sigaction(SIGQUIT, &sa, NULL) == -1)\n"
649 " errExit(\"sigaction\");\n"
653 #: build/C/man7/aio.7:331
656 " sa.sa_flags = SA_RESTART | SA_SIGINFO;\n"
657 " sa.sa_sigaction = aioSigHandler;\n"
658 " if (sigaction(IO_SIGNAL, &sa, NULL) == -1)\n"
659 " errExit(\"sigaction\");\n"
663 #: build/C/man7/aio.7:334
666 " /* Open each file specified on the command line, and queue\n"
667 " a read request on the resulting file descriptor */\n"
671 #: build/C/man7/aio.7:339
674 " for (j = 0; j E<lt> numReqs; j++) {\n"
675 " ioList[j].reqNum = j;\n"
676 " ioList[j].status = EINPROGRESS;\n"
677 " ioList[j].aiocbp = &aiocbList[j];\n"
681 #: build/C/man7/aio.7:345
684 " ioList[j].aiocbp-E<gt>aio_fildes = open(argv[j + 1], O_RDONLY);\n"
685 " if (ioList[j].aiocbp-E<gt>aio_fildes == -1)\n"
686 " errExit(\"open\");\n"
687 " printf(\"opened %s on descriptor %d\\en\", argv[j + 1],\n"
688 " ioList[j].aiocbp-E<gt>aio_fildes);\n"
692 #: build/C/man7/aio.7:349
695 " ioList[j].aiocbp-E<gt>aio_buf = malloc(BUF_SIZE);\n"
696 " if (ioList[j].aiocbp-E<gt>aio_buf == NULL)\n"
697 " errExit(\"malloc\");\n"
701 #: build/C/man7/aio.7:357
704 " ioList[j].aiocbp-E<gt>aio_nbytes = BUF_SIZE;\n"
705 " ioList[j].aiocbp-E<gt>aio_reqprio = 0;\n"
706 " ioList[j].aiocbp-E<gt>aio_offset = 0;\n"
707 " ioList[j].aiocbp-E<gt>aio_sigevent.sigev_notify = SIGEV_SIGNAL;\n"
708 " ioList[j].aiocbp-E<gt>aio_sigevent.sigev_signo = IO_SIGNAL;\n"
709 " ioList[j].aiocbp-E<gt>aio_sigevent.sigev_value.sival_ptr =\n"
714 #: build/C/man7/aio.7:362
717 " s = aio_read(ioList[j].aiocbp);\n"
719 " errExit(\"aio_read\");\n"
724 #: build/C/man7/aio.7:364
726 msgid " openReqs = numReqs;\n"
730 #: build/C/man7/aio.7:366
732 msgid " /* Loop, monitoring status of I/O requests */\n"
736 #: build/C/man7/aio.7:369
739 " while (openReqs E<gt> 0) {\n"
740 " sleep(3); /* Delay between each monitoring step */\n"
744 #: build/C/man7/aio.7:371
746 msgid " if (gotSIGQUIT) {\n"
750 #: build/C/man7/aio.7:375
753 " /* On receipt of SIGQUIT, attempt to cancel each of the\n"
754 " outstanding I/O requests, and display status returned\n"
755 " from the cancellation requests */\n"
759 #: build/C/man7/aio.7:377
761 msgid " printf(\"got SIGQUIT; canceling I/O requests: \\en\");\n"
765 #: build/C/man7/aio.7:394
768 " for (j = 0; j E<lt> numReqs; j++) {\n"
769 " if (ioList[j].status == EINPROGRESS) {\n"
770 " printf(\" Request %d on descriptor %d:\", j,\n"
771 " ioList[j].aiocbp-E<gt>aio_fildes);\n"
772 " s = aio_cancel(ioList[j].aiocbp-E<gt>aio_fildes,\n"
773 " ioList[j].aiocbp);\n"
774 " if (s == AIO_CANCELED)\n"
775 " printf(\"I/O canceled\\en\");\n"
776 " else if (s == AIO_NOTCANCELED)\n"
777 " printf(\"I/O not canceled\\en\");\n"
778 " else if (s == AIO_ALLDONE)\n"
779 " printf(\"I/O all done\\en\");\n"
781 " errMsg(\"aio_cancel\");\n"
787 #: build/C/man7/aio.7:397
795 #: build/C/man7/aio.7:400
798 " /* Check the status of each I/O request that is still\n"
803 #: build/C/man7/aio.7:407
806 " printf(\"aio_error():\\en\");\n"
807 " for (j = 0; j E<lt> numReqs; j++) {\n"
808 " if (ioList[j].status == EINPROGRESS) {\n"
809 " printf(\" for request %d (descriptor %d): \",\n"
810 " j, ioList[j].aiocbp-E<gt>aio_fildes);\n"
811 " ioList[j].status = aio_error(ioList[j].aiocbp);\n"
815 #: build/C/man7/aio.7:422
818 " switch (ioList[j].status) {\n"
820 " printf(\"I/O succeeded\\en\");\n"
822 " case EINPROGRESS:\n"
823 " printf(\"In progress\\en\");\n"
826 " printf(\"Canceled\\en\");\n"
829 " errMsg(\"aio_error\");\n"
835 #: build/C/man7/aio.7:428
838 " if (ioList[j].status != EINPROGRESS)\n"
846 #: build/C/man7/aio.7:430
848 msgid " printf(\"All I/O requests completed\\en\");\n"
852 #: build/C/man7/aio.7:432
854 msgid " /* Check status return of all I/O requests */\n"
858 #: build/C/man7/aio.7:436
861 " printf(\"aio_return():\\en\");\n"
862 " for (j = 0; j E<lt> numReqs; j++) {\n"
867 #: build/C/man7/aio.7:441
870 " s = aio_return(ioList[j].aiocbp);\n"
871 " printf(\" for request %d (descriptor %d): %ld\\en\",\n"
872 " j, ioList[j].aiocbp-E<gt>aio_fildes, (long) s);\n"
877 #: build/C/man7/aio.7:444
880 " exit(EXIT_SUCCESS);\n"
885 #: build/C/man7/aio.7:445 build/C/man3/aio_cancel.3:101 build/C/man3/aio_error.3:82 build/C/man3/aio_fsync.3:100 build/C/man3/aio_init.3:97 build/C/man3/aio_read.3:147 build/C/man3/aio_return.3:77 build/C/man3/aio_suspend.3:124 build/C/man3/aio_write.3:149 build/C/man2/io_cancel.2:94 build/C/man2/io_destroy.2:88 build/C/man2/io_getevents.2:101 build/C/man2/io_setup.2:97 build/C/man2/io_submit.2:99 build/C/man3/lio_listio.3:218
891 #: build/C/man7/aio.7:460
893 "B<io_cancel>(2), B<io_destroy>(2), B<io_getevents>(2), B<io_setup>(2), "
894 "B<io_submit>(2), B<aio_cancel>(3), B<aio_error>(3), B<aio_init>(3), "
895 "B<aio_read>(3), B<aio_return>(3), B<aio_write>(3), B<lio_listio>(3), "
896 "http://www.squid-cache.org/~adrian/Reprint-Pulavarty-OLS2003.pdf"
900 #: build/C/man7/aio.7:460 build/C/man3/aio_cancel.3:110 build/C/man3/aio_error.3:91 build/C/man3/aio_fsync.3:110 build/C/man3/aio_init.3:99 build/C/man3/aio_read.3:156 build/C/man3/aio_return.3:86 build/C/man3/aio_suspend.3:134 build/C/man3/aio_write.3:158 build/C/man2/io_cancel.2:107 build/C/man2/io_destroy.2:101 build/C/man2/io_getevents.2:116 build/C/man2/io_setup.2:108 build/C/man2/io_submit.2:110 build/C/man3/lio_listio.3:226
906 #: build/C/man7/aio.7:467 build/C/man3/aio_cancel.3:117 build/C/man3/aio_error.3:98 build/C/man3/aio_fsync.3:117 build/C/man3/aio_init.3:106 build/C/man3/aio_read.3:163 build/C/man3/aio_return.3:93 build/C/man3/aio_suspend.3:141 build/C/man3/aio_write.3:165 build/C/man2/io_cancel.2:114 build/C/man2/io_destroy.2:108 build/C/man2/io_getevents.2:123 build/C/man2/io_setup.2:115 build/C/man2/io_submit.2:117 build/C/man3/lio_listio.3:233
908 "This page is part of release 3.37 of the Linux I<man-pages> project. A "
909 "description of the project, and information about reporting bugs, can be "
910 "found at http://www.kernel.org/doc/man-pages/."
914 #: build/C/man3/aio_cancel.3:23
920 #: build/C/man3/aio_cancel.3:23
926 #: build/C/man3/aio_cancel.3:26
927 msgid "aio_cancel - cancel an outstanding asynchronous I/O request"
931 #: build/C/man3/aio_cancel.3:26 build/C/man3/aio_error.3:26 build/C/man3/aio_fsync.3:26 build/C/man3/aio_init.3:27 build/C/man3/aio_read.3:26 build/C/man3/aio_return.3:26 build/C/man3/aio_suspend.3:27 build/C/man3/aio_write.3:26 build/C/man2/io_cancel.2:26 build/C/man2/io_destroy.2:26 build/C/man2/io_getevents.2:26 build/C/man2/io_setup.2:26 build/C/man2/io_submit.2:26 build/C/man3/lio_listio.3:26
937 #: build/C/man3/aio_cancel.3:28 build/C/man3/aio_error.3:28 build/C/man3/aio_fsync.3:28 build/C/man3/aio_read.3:28 build/C/man3/aio_return.3:28 build/C/man3/aio_write.3:28
938 msgid "B<#include E<lt>aio.hE<gt>>"
942 #: build/C/man3/aio_cancel.3:30
943 msgid "B<int aio_cancel(int >I<fd>B<, struct aiocb *>I<aiocbp>B<);>"
947 #: build/C/man3/aio_cancel.3:32 build/C/man3/aio_error.3:32 build/C/man3/aio_fsync.3:32 build/C/man3/aio_init.3:36 build/C/man3/aio_read.3:32 build/C/man3/aio_return.3:32 build/C/man3/aio_write.3:32
948 msgid "Link with I<-lrt>."
952 #: build/C/man3/aio_cancel.3:50
954 "The B<aio_cancel>() function attempts to cancel outstanding asynchronous "
955 "I/O requests for the file descriptor I<fd>. If I<aiocbp> is NULL, all such "
956 "requests are canceled. Otherwise, only the request described by the control "
957 "block pointed to by I<aiocbp> is canceled. (See B<aio>(7) for a "
958 "description of the I<aiocb> structure.)"
962 #: build/C/man3/aio_cancel.3:59
964 "Normal asynchronous notification occurs for canceled requests. The request "
965 "return status (B<aio_return>(3)) is set to -1, and the request error status "
966 "(B<aio_error>(3)) is set to B<ECANCELED>. The control block of requests "
967 "that cannot be canceled is not changed."
971 #: build/C/man3/aio_cancel.3:66
973 "If I<aiocbp> is not NULL, and I<fd> differs from the file descriptor with "
974 "which the asynchronous operation was initiated, unspecified results occur."
977 #. FreeBSD: not those on raw disk devices.
979 #: build/C/man3/aio_cancel.3:69
980 msgid "Which operations are cancelable is implementation-defined."
984 #: build/C/man3/aio_cancel.3:69 build/C/man3/aio_error.3:43 build/C/man3/aio_fsync.3:72 build/C/man3/aio_read.3:87 build/C/man3/aio_return.3:48 build/C/man3/aio_suspend.3:79 build/C/man3/aio_write.3:94 build/C/man2/io_cancel.2:51 build/C/man2/io_destroy.2:48 build/C/man2/io_getevents.2:54 build/C/man2/io_setup.2:49 build/C/man2/io_submit.2:48 build/C/man3/lio_listio.3:107
990 #: build/C/man3/aio_cancel.3:87
992 "This function returns B<AIO_CANCELED> if all requests were successfully "
993 "canceled. It returns B<AIO_NOTCANCELED> when at least one of the requests "
994 "specified was not canceled because it was in progress. In this case one may "
995 "check the status of individual requests using B<aio_error>(3). This "
996 "function returns B<AIO_ALLDONE> if all requests had already been completed "
997 "before this call. When some error occurs, -1 is returned, and I<errno> is "
1002 #: build/C/man3/aio_cancel.3:88 build/C/man3/aio_fsync.3:82 build/C/man3/aio_read.3:106 build/C/man3/aio_write.3:113 build/C/man2/io_submit.2:58
1008 #: build/C/man3/aio_cancel.3:92
1009 msgid "I<fd> is not a valid file descriptor."
1013 #: build/C/man3/aio_cancel.3:96
1014 msgid "The B<aio_cancel>() function is available since glibc 2.1."
1018 #: build/C/man3/aio_cancel.3:101 build/C/man3/aio_error.3:82 build/C/man3/aio_read.3:147 build/C/man3/aio_return.3:77
1019 msgid "See B<aio>(7)."
1023 #: build/C/man3/aio_cancel.3:110
1025 "B<aio_error>(3), B<aio_fsync>(3), B<aio_read>(3), B<aio_return>(3), "
1026 "B<aio_suspend>(3), B<aio_write>(3), B<lio_listio>(3), B<aio>(7)"
1030 #: build/C/man3/aio_error.3:23
1036 #: build/C/man3/aio_error.3:23 build/C/man3/aio_read.3:23 build/C/man3/aio_return.3:23
1042 #: build/C/man3/aio_error.3:26
1043 msgid "aio_error - get error status of asynchronous I/O operation"
1047 #: build/C/man3/aio_error.3:30
1048 msgid "B<int aio_error(const struct aiocb *>I<aiocbp>B<);>"
1052 #: build/C/man3/aio_error.3:43
1054 "The B<aio_error>() function returns the error status for the asynchronous "
1055 "I/O request with control block pointed to by I<aiocbp>. (See B<aio>(7) for "
1056 "a description of the I<aiocb> structure.)"
1060 #: build/C/man3/aio_error.3:45
1061 msgid "This function returns one of the following:"
1065 #: build/C/man3/aio_error.3:45 build/C/man3/aio_error.3:49 build/C/man3/aio_error.3:52 build/C/man3/aio_error.3:54 build/C/man3/aio_suspend.3:42 build/C/man3/aio_suspend.3:46 build/C/man3/aio_suspend.3:48
1071 #: build/C/man3/aio_error.3:49
1072 msgid "B<EINPROGRESS>, if the request has not been completed yet."
1076 #: build/C/man3/aio_error.3:52
1077 msgid "B<ECANCELED>, if the request was canceled."
1081 #: build/C/man3/aio_error.3:54
1082 msgid "0, if the request completed successfully."
1086 #: build/C/man3/aio_error.3:65
1088 "A positive error, if the asynchronous I/O operation failed. This is the "
1089 "same value that would have been stored in the I<errno> variable in the case "
1090 "of a synchronous B<read>(2), B<write>(2), B<fsync>(2), or B<fdatasync>(2) "
1095 #: build/C/man3/aio_error.3:73
1097 "I<aiocbp> does not point at a control block for an asynchronous I/O request "
1098 "of which the return status (see B<aio_return>(3)) has not been retrieved "
1103 #: build/C/man3/aio_error.3:77
1104 msgid "The B<aio_error>() function is available since glibc 2.1."
1108 #: build/C/man3/aio_error.3:91
1110 "B<aio_cancel>(3), B<aio_fsync>(3), B<aio_read>(3), B<aio_return>(3), "
1111 "B<aio_suspend>(3), B<aio_write>(3), B<lio_listio>(3), B<aio>(7)"
1115 #: build/C/man3/aio_fsync.3:23
1121 #: build/C/man3/aio_fsync.3:26
1122 msgid "aio_fsync - asynchronous file synchronization"
1126 #: build/C/man3/aio_fsync.3:30
1127 msgid "B<int aio_fsync(int >I<op>B<, struct aiocb *>I<aiocbp>B<);>"
1131 #: build/C/man3/aio_fsync.3:43
1133 "The B<aio_fsync>() function does a sync on all outstanding asynchronous I/O "
1134 "operations associated with I<aiocbp-E<gt>aio_fildes>. (See B<aio>(7) for a "
1135 "description of the I<aiocb> structure.)"
1139 #: build/C/man3/aio_fsync.3:57
1141 "More precisely, if I<op> is B<O_SYNC>, then all currently queued I/O "
1142 "operations shall be completed as if by a call of B<fsync>(2), and if I<op> "
1143 "is B<O_DSYNC>, this call is the asynchronous analog of B<fdatasync>(2)."
1147 #: build/C/man3/aio_fsync.3:59
1148 msgid "Note that this is a request only; it does not wait for I/O completion."
1152 #: build/C/man3/aio_fsync.3:72
1154 "Apart from I<aio_fildes>, the only field in the structure pointed to by "
1155 "I<aiocbp> that is used by this call is the I<aio_sigevent> field (a "
1156 "I<sigevent> structure, described in B<sigevent>(7)), which indicates the "
1157 "desired type of asynchronous notification at completion. All other fields "
1162 #: build/C/man3/aio_fsync.3:78
1164 "On success (the sync request was successfully queued) this function returns "
1165 "0. On error -1 is returned, and I<errno> is set appropriately."
1169 #: build/C/man3/aio_fsync.3:79 build/C/man3/aio_read.3:103 build/C/man3/aio_suspend.3:88 build/C/man3/aio_write.3:110 build/C/man2/io_cancel.2:57 build/C/man2/io_setup.2:55 build/C/man2/io_submit.2:55 build/C/man3/lio_listio.3:149 build/C/man3/lio_listio.3:152
1175 #: build/C/man3/aio_fsync.3:82 build/C/man3/aio_read.3:106 build/C/man3/aio_write.3:113 build/C/man3/lio_listio.3:152
1176 msgid "Out of resources."
1180 #: build/C/man3/aio_fsync.3:86 build/C/man3/aio_write.3:117
1181 msgid "I<aio_fildes> is not a valid file descriptor open for writing."
1185 #: build/C/man3/aio_fsync.3:94
1187 "Synchronized I/O is not supported for this file, or I<op> is not B<O_SYNC> "
1192 #: build/C/man3/aio_fsync.3:98
1193 msgid "The B<aio_fsync>() function is available since glibc 2.1."
1197 #: build/C/man3/aio_fsync.3:110
1199 "B<aio_cancel>(3), B<aio_error>(3), B<aio_read>(3), B<aio_return>(3), "
1200 "B<aio_suspend>(3), B<aio_write>(3), B<lio_listio>(3), B<aio>(7), "
1205 #: build/C/man3/aio_init.3:24
1211 #: build/C/man3/aio_init.3:24
1217 #: build/C/man3/aio_init.3:27
1218 msgid "aio_init - POSIX asynchronous I/O initialization"
1222 #: build/C/man3/aio_init.3:31
1225 "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
1226 "B<#include E<lt>aio.hE<gt>>\n"
1230 #: build/C/man3/aio_init.3:33
1232 msgid "B<void aio_init(const struct aioinit *>I<init>B<);>\n"
1236 #: build/C/man3/aio_init.3:43
1238 "The GNU-specific B<aio_init>() function allows the caller to provide tuning "
1239 "hints to the glibc POSIX AIO implementation. Use of this function is "
1240 "optional, but to be effective, it must be called before employing any other "
1241 "functions in the POSIX AIO API."
1245 #: build/C/man3/aio_init.3:47
1247 "The tuning information is provided in the buffer pointed to by the argument "
1248 "I<init>. This buffer is a structure of the following form:"
1252 #: build/C/man3/aio_init.3:62
1255 "struct aioinit {\n"
1256 " int aio_threads; /* Maximum number of threads */\n"
1257 " int aio_num; /* Number of expected simultaneous\n"
1259 " int aio_locks; /* Not used */\n"
1260 " int aio_usedba; /* Not used */\n"
1261 " int aio_debug; /* Not used */\n"
1262 " int aio_numusers; /* Not used */\n"
1263 " int aio_idle_time; /* Number of seconds before idle thread\n"
1264 " terminates (since glibc 2.2) */\n"
1265 " int aio_reserved;\n"
1270 #: build/C/man3/aio_init.3:68
1271 msgid "The following fields are used in the I<aioinit> structure:"
1275 #: build/C/man3/aio_init.3:68
1277 msgid "I<aio_threads>"
1281 #: build/C/man3/aio_init.3:76
1283 "This field specifies the maximum number of worker threads that may be used "
1284 "by the implementation. If the number of outstanding I/O operations exceeds "
1285 "this limit, then excess operations will be queued until a worker thread "
1286 "becomes free. If this field is specified with a value less than 1, the "
1287 "value 1 is used. The default value is 20."
1291 #: build/C/man3/aio_init.3:76
1296 #. FIXME But, if aio_num > 32, the behavior looks strange. See
1297 #. http://sourceware.org/bugzilla/show_bug.cgi?id=12083
1299 #: build/C/man3/aio_init.3:85
1301 "This field should specify the maximum number of simultaneous I/O requests "
1302 "that the caller expects to enqueue. If a value less than 32 is specified "
1303 "for this field, it is rounded up to 32. The default value is 64."
1307 #: build/C/man3/aio_init.3:85
1309 msgid "I<aio_idle_time>"
1313 #: build/C/man3/aio_init.3:91
1315 "This field specifies the amount of time in seconds that a worker thread "
1316 "should wait for further requests before terminating, after having completed "
1317 "a previous request. The default value is 1."
1321 #: build/C/man3/aio_init.3:95
1322 msgid "The B<aio_init>() function is available since glibc 2.1."
1326 #: build/C/man3/aio_init.3:97
1327 msgid "This function is a GNU extension."
1331 #: build/C/man3/aio_init.3:99
1336 #: build/C/man3/aio_read.3:23
1342 #: build/C/man3/aio_read.3:26
1343 msgid "aio_read - asynchronous read"
1347 #: build/C/man3/aio_read.3:30
1348 msgid "B<int aio_read(struct aiocb *>I<aiocbp>B<);>"
1352 #: build/C/man3/aio_read.3:40
1354 "The B<aio_read>() function queues the I/O request described by the buffer "
1355 "pointed to by I<aiocbp>. This function is the asynchronous analog of "
1356 "B<read>(2). The arguments of the call"
1360 #: build/C/man3/aio_read.3:42
1362 msgid " read(fd, buf, count)\n"
1366 #: build/C/man3/aio_read.3:55 build/C/man3/aio_write.3:55
1368 "correspond (in order) to the fields I<aio_fildes>, I<aio_buf>, and "
1369 "I<aio_nbytes> of the structure pointed to by I<aiocbp>. (See B<aio>(7) for "
1370 "a description of the I<aiocb> structure.)"
1374 #: build/C/man3/aio_read.3:61
1376 "The data is read starting at the absolute file offset "
1377 "I<aiocbp-E<gt>aio_offset>, regardless of the current file offset. After the "
1378 "call, the value of the current file offset is unspecified."
1382 #: build/C/man3/aio_read.3:74
1384 "The \"asynchronous\" means that this call returns as soon as the request has "
1385 "been enqueued; the read may or may not have completed when the call "
1386 "returns. One tests for completion using B<aio_error>(3). The return status "
1387 "of a completed I/O operation can be obtained B<aio_return>(3). Asynchronous "
1388 "notification of I/O completion can be obtained by setting "
1389 "I<aiocbp-E<gt>aio_sigevent> appropriately; see B<sigevent>(7) for details."
1393 #: build/C/man3/aio_read.3:81 build/C/man3/aio_write.3:88
1395 "If B<_POSIX_PRIORITIZED_IO> is defined, and this file supports it, then the "
1396 "asynchronous operation is submitted at a priority equal to that of the "
1397 "calling process minus I<aiocbp-E<gt>aio_reqprio>."
1401 #: build/C/man3/aio_read.3:85 build/C/man3/aio_write.3:92
1402 msgid "The field I<aiocbp-E<gt>aio_lio_opcode> is ignored."
1406 #: build/C/man3/aio_read.3:87
1407 msgid "No data is read from a regular file beyond its maximum offset."
1411 #: build/C/man3/aio_read.3:102 build/C/man3/aio_write.3:109
1413 "On success, 0 is returned. On error the request is not enqueued, -1 is "
1414 "returned, and I<errno> is set appropriately. If an error is only detected "
1415 "later, it will be reported via B<aio_return>(3) (returns status -1) and "
1416 "B<aio_error>(3) (error status\\(emwhatever one would have gotten in "
1417 "I<errno>, such as B<EBADF>)."
1421 #: build/C/man3/aio_read.3:110
1422 msgid "I<aio_fildes> is not a valid file descriptor open for reading."
1426 #: build/C/man3/aio_read.3:118
1427 msgid "One or more of I<aio_offset>, I<aio_reqprio>, or I<aio_nbytes> are invalid."
1431 #: build/C/man3/aio_read.3:118 build/C/man3/aio_write.3:128 build/C/man2/io_cancel.2:66 build/C/man2/io_destroy.2:60 build/C/man2/io_getevents.2:73 build/C/man2/io_setup.2:69 build/C/man2/io_submit.2:71
1437 #: build/C/man3/aio_read.3:121 build/C/man3/aio_write.3:131
1438 msgid "This function is not supported."
1442 #: build/C/man3/aio_read.3:121
1444 msgid "B<EOVERFLOW>"
1448 #: build/C/man3/aio_read.3:126
1450 "The file is a regular file, we start reading before end-of-file and want at "
1451 "least one byte, but the starting position is past the maximum offset for "
1456 #: build/C/man3/aio_read.3:130
1457 msgid "The B<aio_read>() function is available since glibc 2.1."
1460 #. or the control block of the operation
1462 #: build/C/man3/aio_read.3:140
1464 "It is a good idea to zero out the control block before use. The control "
1465 "block must not be changed while the read operation is in progress. The "
1466 "buffer area being read into must not be accessed during the operation or "
1467 "undefined results may occur. The memory areas involved must remain valid."
1471 #: build/C/man3/aio_read.3:144 build/C/man3/aio_write.3:149 build/C/man3/lio_listio.3:218
1473 "Simultaneous I/O operations specifying the same I<aiocb> structure produce "
1474 "undefined results."
1478 #: build/C/man3/aio_read.3:156
1480 "B<aio_cancel>(3), B<aio_error>(3), B<aio_fsync>(3), B<aio_return>(3), "
1481 "B<aio_suspend>(3), B<aio_write>(3), B<lio_listio>(3), B<aio>(7)"
1485 #: build/C/man3/aio_return.3:23
1491 #: build/C/man3/aio_return.3:26
1492 msgid "aio_return - get return status of asynchronous I/O operation"
1496 #: build/C/man3/aio_return.3:30
1497 msgid "B<ssize_t aio_return(struct aiocb *>I<aiocbp>B<);>"
1501 #: build/C/man3/aio_return.3:43
1503 "The B<aio_return>() function returns the final return status for the "
1504 "asynchronous I/O request with control block pointed to by I<aiocbp>. (See "
1505 "B<aio>(7) for a description of the I<aiocb> structure.)"
1509 #: build/C/man3/aio_return.3:48
1511 "This function should be called only once for any given request, after "
1512 "B<aio_error>(3) returns something other than B<EINPROGRESS>."
1516 #: build/C/man3/aio_return.3:57
1518 "If the asynchronous I/O operation has completed, this function returns the "
1519 "value that would have been returned in case of a synchronous B<read>(2), "
1520 "B<write>(2), B<fsync>(2) or B<fdatasync>(2), call."
1524 #: build/C/man3/aio_return.3:62
1526 "If the asynchronous I/O operation has not yet completed, the return value "
1527 "and effect of B<aio_return>() are undefined."
1531 #: build/C/man3/aio_return.3:68
1533 "I<aiocbp> does not point at a control block for an asynchronous I/O request "
1534 "of which the return status has not been retrieved yet."
1538 #: build/C/man3/aio_return.3:72
1539 msgid "The B<aio_return>() function is available since glibc 2.1."
1543 #: build/C/man3/aio_return.3:86
1545 "B<aio_cancel>(3), B<aio_error>(3), B<aio_fsync>(3), B<aio_read>(3), "
1546 "B<aio_suspend>(3), B<aio_write>(3), B<lio_listio>(3), B<aio>(7)"
1550 #: build/C/man3/aio_suspend.3:24
1556 #: build/C/man3/aio_suspend.3:27
1557 msgid "aio_suspend - wait for asynchronous I/O operation or timeout"
1561 #: build/C/man3/aio_suspend.3:31 build/C/man3/lio_listio.3:29
1563 msgid "B<#include E<lt>aio.hE<gt>>\n"
1567 #: build/C/man3/aio_suspend.3:33
1569 msgid "B<int aio_suspend(const struct aiocb * const >I<aiocb_list>B<[],>\n"
1573 #: build/C/man3/aio_suspend.3:35
1576 "B< int >I<nitems>B<, const struct timespec "
1577 "*>I<timeout>B<);>\n"
1581 #: build/C/man3/aio_suspend.3:37 build/C/man3/lio_listio.3:34
1583 msgid "Link with I<-lrt>.\n"
1587 #: build/C/man3/aio_suspend.3:42
1589 "The B<aio_suspend>() function suspends the calling thread until one of the "
1594 #: build/C/man3/aio_suspend.3:46
1596 "One or more of the asynchronous I/O requests in the list I<aiocb_list> has "
1601 #: build/C/man3/aio_suspend.3:48
1602 msgid "A signal is delivered."
1606 #: build/C/man3/aio_suspend.3:55
1608 "I<timeout> is not NULL and the specified time interval has passed. (For "
1609 "details of the I<timespec> structure, see B<nanosleep>(2).)"
1613 #: build/C/man3/aio_suspend.3:73
1615 "The I<nitems> argument specifies the number of items in I<aiocb_list>. Each "
1616 "item in the list pointed to by I<aiocb_list> must be either NULL (and then "
1617 "is ignored), or a pointer to a control block on which I/O was initiated "
1618 "using B<aio_read>(3), B<aio_write>(3), or B<lio_listio>(3). (See B<aio>(7) "
1619 "for a description of the I<aiocb> structure.)"
1623 #: build/C/man3/aio_suspend.3:79
1625 "If B<CLOCK_MONOTONIC> is supported, this clock is used to measure the "
1626 "timeout interval (see B<clock_gettime>(3))."
1630 #: build/C/man3/aio_suspend.3:87
1632 "If this function returns after completion of one of the I/O requests "
1633 "specified in I<aiocb_list>, 0 is returned. Otherwise, -1 is returned, and "
1634 "I<errno> is set to indicate the error."
1638 #: build/C/man3/aio_suspend.3:92
1639 msgid "The call timed out before any of the indicated operations had completed."
1643 #: build/C/man3/aio_suspend.3:92 build/C/man2/io_getevents.2:69 build/C/man3/lio_listio.3:168
1649 #: build/C/man3/aio_suspend.3:98
1651 "The call was ended by signal (possibly the completion signal of one of the "
1652 "operations we were waiting for); see B<signal>(7)."
1656 #: build/C/man3/aio_suspend.3:102
1657 msgid "The B<aio_suspend>() function is available since glibc 2.1."
1661 #: build/C/man3/aio_suspend.3:108
1663 "One can achieve polling by using a non-NULL I<timeout> that specifies a zero "
1668 #: build/C/man3/aio_suspend.3:114
1670 "If one or more of the asynchronous I/O operations specified in I<aiocb_list> "
1671 "has already completed at the time of the call to B<aio_suspend>(), then the "
1672 "call returns immediately."
1676 #: build/C/man3/aio_suspend.3:124
1678 "To determine which I/O operations have completed after a successful return "
1679 "from B<aio_suspend>(), use B<aio_error>(3) to scan the list of I<aiocb> "
1680 "structures pointed to by I<aiocb_list>."
1684 #: build/C/man3/aio_suspend.3:134
1686 "B<aio_cancel>(3), B<aio_error>(3), B<aio_fsync>(3), B<aio_read>(3), "
1687 "B<aio_return>(3), B<aio_write>(3), B<lio_listio>(3), B<aio>(7), B<time>(7)"
1691 #: build/C/man3/aio_write.3:23
1697 #: build/C/man3/aio_write.3:26
1698 msgid "aio_write - asynchronous write"
1702 #: build/C/man3/aio_write.3:30
1703 msgid "B<int aio_write(struct aiocb *>I<aiocbp>B<);>"
1707 #: build/C/man3/aio_write.3:40
1709 "The B<aio_write>() function queues the I/O request described by the buffer "
1710 "pointed to by I<aiocb>. This function is the asynchronous analog of "
1711 "B<write>(2). The arguments of the call"
1715 #: build/C/man3/aio_write.3:42
1717 msgid " write(fd, buf, count)\n"
1721 #: build/C/man3/aio_write.3:68
1723 "If B<O_APPEND> is not set, the data is written starting at the absolute file "
1724 "offset I<aiocbp-E<gt>aio_offset>, regardless of the current file offset. If "
1725 "B<O_APPEND> is set, data is written at the end of the file in the same order "
1726 "as B<aio_write>() calls are made. After the call, the value of the current "
1727 "file offset is unspecified."
1731 #: build/C/man3/aio_write.3:81
1733 "The \"asynchronous\" means that this call returns as soon as the request has "
1734 "been enqueued; the write may or may not have completed when the call "
1735 "returns. One tests for completion using B<aio_error>(3). The return status "
1736 "of a completed I/O operation can be obtained B<aio_return>(3). Asynchronous "
1737 "notification of I/O completion can be obtained by setting "
1738 "I<aiocbp-E<gt>aio_sigevent> appropriately; see B<sigevent>(7) for details."
1742 #: build/C/man3/aio_write.3:94
1743 msgid "No data is written to a regular file beyond its maximum offset."
1747 #: build/C/man3/aio_write.3:117
1753 #: build/C/man3/aio_write.3:121
1755 "The file is a regular file, we want to write at least one byte, but the "
1756 "starting position is at or beyond the maximum offset for this file."
1760 #: build/C/man3/aio_write.3:128
1761 msgid "One or more of I<aio_offset>, I<aio_reqprio>, I<aio_nbytes> are invalid."
1765 #: build/C/man3/aio_write.3:135
1766 msgid "The B<aio_write>() function is available since glibc 2.1."
1769 #. or the control block of the operation
1771 #: build/C/man3/aio_write.3:145
1773 "It is a good idea to zero out the control block before use. The control "
1774 "block must not be changed while the write operation is in progress. The "
1775 "buffer area being written out must not be accessed during the operation or "
1776 "undefined results may occur. The memory areas involved must remain valid."
1780 #: build/C/man3/aio_write.3:158
1782 "B<aio_cancel>(3), B<aio_error>(3), B<aio_fsync>(3), B<aio_read>(3), "
1783 "B<aio_return>(3), B<aio_suspend>(3), B<lio_listio>(3), B<aio>(7)"
1787 #: build/C/man2/io_cancel.2:23
1793 #: build/C/man2/io_cancel.2:23 build/C/man2/io_destroy.2:23 build/C/man2/io_setup.2:23 build/C/man2/io_submit.2:23
1799 #: build/C/man2/io_cancel.2:26
1800 msgid "io_cancel - cancel an outstanding asynchronous I/O operation"
1805 #. #include <linux/aio.h>
1807 #: build/C/man2/io_cancel.2:33 build/C/man2/io_destroy.2:32 build/C/man2/io_setup.2:32 build/C/man2/io_submit.2:32
1809 msgid "B<#include E<lt>libaio.hE<gt>>\n"
1816 #: build/C/man2/io_cancel.2:39
1819 "B<int io_cancel(aio_context_t >I<ctx_id>B<, struct iocb *>I<iocb>B<,>\n"
1820 "B< struct io_event *>I<result>B<);>\n"
1824 #: build/C/man2/io_cancel.2:41 build/C/man2/io_destroy.2:39 build/C/man2/io_getevents.2:42 build/C/man2/io_setup.2:39 build/C/man2/io_submit.2:40
1826 msgid "Link with I<-laio>.\n"
1830 #: build/C/man2/io_cancel.2:51
1832 "B<io_cancel>() attempts to cancel an asynchronous I/O operation previously "
1833 "submitted with B<io_submit>(2). I<ctx_id> is the AIO context ID of the "
1834 "operation to be canceled. If the AIO context is found, the event will be "
1835 "canceled and then copied into the memory pointed to by I<result> without "
1836 "being placed into the completion queue."
1840 #: build/C/man2/io_cancel.2:56
1841 msgid "On success, B<io_cancel>() returns 0. For the failure return, see NOTES."
1845 #: build/C/man2/io_cancel.2:60
1846 msgid "The I<iocb> specified was not canceled."
1850 #: build/C/man2/io_cancel.2:60 build/C/man2/io_destroy.2:54 build/C/man2/io_getevents.2:61 build/C/man2/io_setup.2:58 build/C/man2/io_submit.2:61
1856 #: build/C/man2/io_cancel.2:63 build/C/man2/io_submit.2:64
1857 msgid "One of the data structures points to invalid data."
1861 #: build/C/man2/io_cancel.2:66
1862 msgid "The AIO context specified by I<ctx_id> is invalid."
1866 #: build/C/man2/io_cancel.2:70
1867 msgid "B<io_cancel>() is not implemented on this architecture."
1871 #: build/C/man2/io_cancel.2:73 build/C/man2/io_destroy.2:67 build/C/man2/io_getevents.2:80 build/C/man2/io_setup.2:76 build/C/man2/io_submit.2:78
1872 msgid "The asynchronous I/O system calls first appeared in Linux 2.5, August 2002."
1876 #: build/C/man2/io_cancel.2:78
1878 "B<io_cancel>() is Linux-specific and should not be used in programs that "
1879 "are intended to be portable."
1883 #: build/C/man2/io_cancel.2:80 build/C/man2/io_destroy.2:74 build/C/man2/io_getevents.2:87 build/C/man2/io_setup.2:83 build/C/man2/io_submit.2:85
1884 msgid "Glibc does not provide a wrapper function for this system call."
1888 #: build/C/man2/io_cancel.2:94
1890 "The wrapper provided in I<libaio> for B<io_cancel>() does not follow the "
1891 "usual C library conventions for indicating error: on error it returns a "
1892 "negated error number (the negative of one of the values listed in ERRORS). "
1893 "If the system call is invoked via B<syscall>(2), then the return value "
1894 "follows the usual conventions for indicating an error: -1, with I<errno> set "
1895 "to a (positive) value that indicates the error."
1901 #. The asynchronous I/O system calls were written by Benjamin LaHaise.
1906 #: build/C/man2/io_cancel.2:107
1908 "B<io_destroy>(2), B<io_getevents>(2), B<io_setup>(2), B<io_submit>(2), "
1913 #: build/C/man2/io_destroy.2:23
1919 #: build/C/man2/io_destroy.2:26
1920 msgid "io_destroy - destroy an asynchronous I/O context"
1927 #: build/C/man2/io_destroy.2:37
1929 msgid "B<int io_destroy(aio_context_t >I<ctx>B<);>\n"
1933 #: build/C/man2/io_destroy.2:48
1935 "B<io_destroy>() removes the asynchronous I/O context from the list of I/O "
1936 "contexts and then destroys it. B<io_destroy>() can also cancel any "
1937 "outstanding asynchronous I/O actions on I<ctx> and block on completion."
1941 #: build/C/man2/io_destroy.2:53
1942 msgid "On success, B<io_destroy>() returns 0. For the failure return, see NOTES."
1946 #: build/C/man2/io_destroy.2:57
1947 msgid "The context pointed to is invalid."
1951 #: build/C/man2/io_destroy.2:60
1952 msgid "The AIO context specified by I<ctx> is invalid."
1956 #: build/C/man2/io_destroy.2:64
1957 msgid "B<io_destroy>() is not implemented on this architecture."
1961 #: build/C/man2/io_destroy.2:72
1963 "B<io_destroy>() is Linux-specific and should not be used in programs that "
1964 "are intended to be portable."
1968 #: build/C/man2/io_destroy.2:88
1970 "The wrapper provided in I<libaio> for B<io_destroy>() does not follow the "
1971 "usual C library conventions for indicating error: on error it returns a "
1972 "negated error number (the negative of one of the values listed in ERRORS). "
1973 "If the system call is invoked via B<syscall>(2), then the return value "
1974 "follows the usual conventions for indicating an error: -1, with I<errno> set "
1975 "to a (positive) value that indicates the error."
1981 #. The asynchronous I/O system calls were written by Benjamin LaHaise.
1986 #: build/C/man2/io_destroy.2:101
1988 "B<io_cancel>(2), B<io_getevents>(2), B<io_setup>(2), B<io_submit>(2), "
1993 #: build/C/man2/io_getevents.2:23
1995 msgid "IO_GETEVENTS"
1999 #: build/C/man2/io_getevents.2:23
2005 #: build/C/man2/io_getevents.2:26
2006 msgid "io_getevents - read asynchronous I/O events from the completion queue"
2011 #. #include <linux/aio.h>
2013 #: build/C/man2/io_getevents.2:33
2016 "B<#include E<lt>linux/time.hE<gt>>\n"
2017 "B<#include E<lt>libaio.hE<gt>>\n"
2024 #: build/C/man2/io_getevents.2:40
2027 "B<int io_getevents(aio_context_t >I<ctx_id>B<, long >I<min_nr>B<, long "
2029 "B< struct io_event *>I<events>B<, struct timespec "
2030 "*>I<timeout>B<);>\n"
2034 #: build/C/man2/io_getevents.2:54
2036 "B<io_getevents>() attempts to read at least I<min_nr> events and up to "
2037 "I<nr> events from the completion queue of the AIO context specified by "
2038 "I<ctx_id>. I<timeout> specifies the amount of time to wait for events, "
2039 "where a NULL timeout waits until at least I<min_nr> events have been seen. "
2040 "Note that I<timeout> is relative and will be updated if not NULL and the "
2045 #: build/C/man2/io_getevents.2:60
2047 "On success, B<io_getevents>() returns the number of events read: 0 if no "
2048 "events are available, or less than I<min_nr> if the I<timeout> has elapsed. "
2049 "For the failure return, see NOTES."
2053 #: build/C/man2/io_getevents.2:64
2054 msgid "Either I<events> or I<timeout> is an invalid pointer."
2058 #: build/C/man2/io_getevents.2:69
2059 msgid "I<ctx_id> is invalid. I<min_nr> is out of range or I<nr> is out of range."
2063 #: build/C/man2/io_getevents.2:73
2064 msgid "Interrupted by a signal handler; see B<signal>(7)."
2068 #: build/C/man2/io_getevents.2:77
2069 msgid "B<io_getevents>() is not implemented on this architecture."
2073 #: build/C/man2/io_getevents.2:85
2075 "B<io_getevents>() is Linux-specific and should not be used in programs that "
2076 "are intended to be portable."
2080 #: build/C/man2/io_getevents.2:101
2082 "The wrapper provided in I<libaio> for B<io_getevents>() does not follow the "
2083 "usual C library conventions for indicating error: on error it returns a "
2084 "negated error number (the negative of one of the values listed in ERRORS). "
2085 "If the system call is invoked via B<syscall>(2), then the return value "
2086 "follows the usual conventions for indicating an error: -1, with I<errno> set "
2087 "to a (positive) value that indicates the error."
2093 #. The asynchronous I/O system calls were written by Benjamin LaHaise.
2098 #: build/C/man2/io_getevents.2:116
2100 "B<io_cancel>(2), B<io_destroy>(2), B<io_setup>(2), B<io_submit>(2), "
2101 "B<aio>(7), B<time>(7)"
2105 #: build/C/man2/io_setup.2:23
2111 #: build/C/man2/io_setup.2:26
2112 msgid "io_setup - create an asynchronous I/O context"
2119 #: build/C/man2/io_setup.2:37
2121 msgid "B<int io_setup(unsigned >I<nr_events>B<, aio_context_t *>I<ctxp>B<);>\n"
2125 #: build/C/man2/io_setup.2:49
2127 "B<io_setup>() creates an asynchronous I/O context capable of receiving at "
2128 "least I<nr_events>. I<ctxp> must not point to an AIO context that already "
2129 "exists, and must be initialized to 0 prior to the call. On successful "
2130 "creation of the AIO context, I<*ctxp> is filled in with the resulting "
2135 #: build/C/man2/io_setup.2:54
2136 msgid "On success, B<io_setup>() returns 0. For the failure return, see NOTES."
2140 #: build/C/man2/io_setup.2:58
2141 msgid "The specified I<nr_events> exceeds the user's limit of available events."
2145 #: build/C/man2/io_setup.2:61
2146 msgid "An invalid pointer is passed for I<ctxp>."
2150 #: build/C/man2/io_setup.2:66
2152 "I<ctxp> is not initialized, or the specified I<nr_events> exceeds internal "
2153 "limits. I<nr_events> should be greater than 0."
2157 #: build/C/man2/io_setup.2:66
2163 #: build/C/man2/io_setup.2:69
2164 msgid "Insufficient kernel resources are available."
2168 #: build/C/man2/io_setup.2:73
2169 msgid "B<io_setup>() is not implemented on this architecture."
2173 #: build/C/man2/io_setup.2:81
2175 "B<io_setup>() is Linux-specific and should not be used in programs that are "
2176 "intended to be portable."
2180 #: build/C/man2/io_setup.2:97
2182 "The wrapper provided in I<libaio> for B<io_setup>() does not follow the "
2183 "usual C library conventions for indicating error: on error it returns a "
2184 "negated error number (the negative of one of the values listed in ERRORS). "
2185 "If the system call is invoked via B<syscall>(2), then the return value "
2186 "follows the usual conventions for indicating an error: -1, with I<errno> set "
2187 "to a (positive) value that indicates the error."
2192 #. The asynchronous I/O system calls were written by Benjamin LaHaise.
2196 #: build/C/man2/io_setup.2:108
2198 "B<io_cancel>(2), B<io_destroy>(2), B<io_getevents>(2), B<io_submit>(2), "
2203 #: build/C/man2/io_submit.2:23
2209 #: build/C/man2/io_submit.2:26
2210 msgid "io_submit - submit asynchronous I/O blocks for processing"
2217 #: build/C/man2/io_submit.2:38
2220 "B<int io_submit(aio_context_t >I<ctx_id>B<, long >I<nr>B<, struct iocb "
2221 "**>I<iocbpp>B<);>\n"
2225 #: build/C/man2/io_submit.2:48
2227 "B<io_submit>() queues I<nr> I/O request blocks for processing in the AIO "
2228 "context I<ctx_id>. I<iocbpp> should be an array of I<nr> AIO control "
2229 "blocks, which will be submitted to context I<ctx_id>."
2233 #: build/C/man2/io_submit.2:54
2235 "On success, B<io_submit>() returns the number of I<iocb>s submitted (which "
2236 "may be 0 if I<nr> is zero). For the failure return, see NOTES."
2240 #: build/C/man2/io_submit.2:58
2241 msgid "Insufficient resources are available to queue any I<iocb>s."
2245 #: build/C/man2/io_submit.2:61
2246 msgid "The file descriptor specified in the first I<iocb> is invalid."
2250 #: build/C/man2/io_submit.2:71
2252 "The I<aio_context> specified by I<ctx_id> is invalid. I<nr> is less than "
2253 "0. The I<iocb> at *iocbpp[0] is not properly initialized, or the operation "
2254 "specified is invalid for the file descriptor in the I<iocb>."
2258 #: build/C/man2/io_submit.2:75
2259 msgid "B<io_submit>() is not implemented on this architecture."
2263 #: build/C/man2/io_submit.2:83
2265 "B<io_submit>() is Linux-specific and should not be used in programs that "
2266 "are intended to be portable."
2270 #: build/C/man2/io_submit.2:99
2272 "The wrapper provided in I<libaio> for B<io_submit>() does not follow the "
2273 "usual C library conventions for indicating error: on error it returns a "
2274 "negated error number (the negative of one of the values listed in ERRORS). "
2275 "If the system call is invoked via B<syscall>(2), then the return value "
2276 "follows the usual conventions for indicating an error: -1, with I<errno> set "
2277 "to a (positive) value that indicates the error."
2282 #. The asynchronous I/O system calls were written by Benjamin LaHaise.
2286 #: build/C/man2/io_submit.2:110
2288 "B<io_cancel>(2), B<io_destroy>(2), B<io_getevents>(2), B<io_setup>(2), "
2293 #: build/C/man3/lio_listio.3:23
2299 #: build/C/man3/lio_listio.3:23
2305 #: build/C/man3/lio_listio.3:26
2306 msgid "lio_listio - initiate a list of I/O requests"
2310 #: build/C/man3/lio_listio.3:32
2313 "B<int lio_listio(int >I<mode>B<, struct aiocb *const >I<aiocb_list>B<[],>\n"
2314 "B< int >I<nitems>B<, struct sigevent *>I<sevp>B<);>\n"
2318 #: build/C/man3/lio_listio.3:40
2320 "The B<lio_listio>() function initiates the list of I/O operations described "
2321 "by the array I<aiocb_list>."
2325 #: build/C/man3/lio_listio.3:44
2326 msgid "The I<mode> operation has one of the following values:"
2330 #: build/C/man3/lio_listio.3:44
2336 #: build/C/man3/lio_listio.3:50
2338 "The call blocks until all operations are complete. The I<sevp> argument is "
2343 #: build/C/man3/lio_listio.3:50
2345 msgid "B<LIO_NOWAIT>"
2349 #: build/C/man3/lio_listio.3:62
2351 "The I/O operations are queued for processing and the call returns "
2352 "immediately. When the I/O operations complete, asynchronous notification "
2353 "occurs, as specified by the I<sevp> argument; see B<sigevent>(7) for "
2354 "details. If I<sevp> is NULL, no asynchronous notification occurs."
2358 #: build/C/man3/lio_listio.3:76
2360 "The I<aiocb_list> argument is an array of pointers to I<aiocb> structures "
2361 "that describe I/O operations. These operations are executed in an "
2362 "unspecified order. The I<nitems> argument specifies the size of the array "
2363 "I<aiocb_list>. NULL pointers in I<aiocb_list> are ignored."
2367 #: build/C/man3/lio_listio.3:82
2369 "In each control block in I<aiocb_list>, the I<aio_lio_opcode> field "
2370 "specifies the I/O operation to be initiated, as follows:"
2374 #: build/C/man3/lio_listio.3:82
2380 #: build/C/man3/lio_listio.3:88
2382 "Initiate a read operation. The operation is queued as for a call to "
2383 "B<aio_read>(3) specifying this control block."
2387 #: build/C/man3/lio_listio.3:88
2389 msgid "B<LIO_WRITE>"
2393 #: build/C/man3/lio_listio.3:94
2395 "Initiate a write operation. The operation is queued as for a call to "
2396 "B<aio_write>(3) specifying this control block."
2400 #: build/C/man3/lio_listio.3:94
2406 #: build/C/man3/lio_listio.3:97
2407 msgid "Ignore this control block."
2411 #: build/C/man3/lio_listio.3:107
2413 "The remaining fields in each control block have the same meanings as for "
2414 "B<aio_read>(3) and B<aio_write>(3). The I<aio_sigevent> fields of each "
2415 "control block can be used to specify notifications for the individual I/O "
2416 "operations (see B<sigevent>(7))."
2420 #: build/C/man3/lio_listio.3:117
2422 "If I<mode> is B<LIO_NOWAIT>, B<lio_listio>() returns 0 if all I/O "
2423 "operations are successfully queued. Otherwise, -1 is returned, and I<errno> "
2424 "is set to indicate the error."
2428 #: build/C/man3/lio_listio.3:127
2430 "If I<mode> is B<LIO_WAIT>, B<lio_listio>() returns 0 when all of the I/O "
2431 "operations have completed successfully. Otherwise, -1 is returned, and "
2432 "I<errno> is set to indicate the error."
2436 #: build/C/man3/lio_listio.3:145
2438 "The return status from B<lio_listio>() provides information only about the "
2439 "call itself, not about the individual I/O operations. One or more of the "
2440 "I/O operations may fail, but this does not prevent other operations "
2441 "completing. The status of individual I/O operations in I<aiocb_list> can be "
2442 "determined using B<aio_error>(3). When an operation has completed, its "
2443 "return status can be obtained using B<aio_return>(3). Individual I/O "
2444 "operations can fail for the reasons described in B<aio_read>(3) and "
2449 #: build/C/man3/lio_listio.3:149
2450 msgid "The B<lio_listio>() function may fail for the following reasons:"
2453 #. Doesn't happen in glibc(?)
2455 #: build/C/man3/lio_listio.3:160
2457 "The number of I/O operations specified by I<nitems> would cause the limit "
2458 "B<AIO_MAX> to be exceeded."
2461 #. Doesn't happen in glibc(?)
2463 #: build/C/man3/lio_listio.3:168
2464 msgid "I<mode> is invalid, or I<nitems> exceeds the limit B<AIO_LISTIO_MAX>."
2468 #: build/C/man3/lio_listio.3:177
2470 "I<mode> was B<LIO_WAIT> and a signal was caught before all I/O operations "
2471 "completed. (This may even be one of the signals used for asynchronous I/O "
2472 "completion notification.)"
2476 #: build/C/man3/lio_listio.3:177
2481 #. e.g., ioa_reqprio or aio_lio_opcode was invalid
2483 #: build/C/man3/lio_listio.3:185
2485 "One of more of the operations specified by I<aiocb_list> failed. The "
2486 "application can check the status of each operation using B<aio_return>(3)."
2490 #: build/C/man3/lio_listio.3:200
2492 "If B<lio_listio>() fails with the error B<EAGAIN>, B<EINTR>, or B<EIO>, "
2493 "then some of the operations in I<aiocb_list> may have been initiated. If "
2494 "B<lio_listio>() fails for any other reason, then none of the I/O operations "
2495 "has been initiated."
2499 #: build/C/man3/lio_listio.3:204
2500 msgid "The B<lio_listio>() function is available since glibc 2.1."
2503 #. or the control block of the operation
2505 #: build/C/man3/lio_listio.3:214
2507 "It is a good idea to zero out the control blocks before use. The control "
2508 "blocks must not be changed while the I/O operations are in progress. The "
2509 "buffer areas being read into or written from must not be accessed during the "
2510 "operations or undefined results may occur. The memory areas involved must "
2515 #: build/C/man3/lio_listio.3:226
2517 "B<aio_cancel>(3), B<aio_error>(3), B<aio_fsync>(3), B<aio_return>(3), "
2518 "B<aio_suspend>(3), B<aio_write>(3), B<aio>(7)"