man3/aio_suspend.3

   1 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\" and Copyright (C) 2010 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, see
  22 .\" <http://www.gnu.org/licenses/>.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH AIO_SUSPEND 3 2021-03-22  "" "Linux Programmer's Manual"
  26 .SH NAME
  27 aio_suspend \- wait for asynchronous I/O operation or timeout
  28 .SH SYNOPSIS
  29 .nf
  30 .PP
  31 .B "#include <aio.h>"
  32 .PP
  33 .BI "int aio_suspend(const struct aiocb *const " aiocb_list "[], int " nitems ,
  34 .BI "                const struct timespec *restrict " timeout );
  35 .PP
  36 Link with \fI\-lrt\fP.
  37 .fi
  38 .SH DESCRIPTION
  39 The
  40 .BR aio_suspend ()
  41 function suspends the calling thread until one of the following occurs:
  42 .IP * 3
  43 One or more of the asynchronous I/O requests in the list
  44 .I aiocb_list
  45 has completed.
  46 .IP *
  47 A signal is delivered.
  48 .IP *
  49 .I timeout
  50 is not NULL and the specified time interval has passed.
  51 (For details of the
  52 .I timespec
  53 structure, see
  54 .BR nanosleep (2).)
  55 .PP
  56 The
  57 .I nitems
  58 argument specifies the number of items in
  59 .IR aiocb_list .
  60 Each item in the list pointed to by
  61 .I aiocb_list
  62 must be either NULL (and then is ignored),
  63 or a pointer to a control block on which I/O was initiated using
  64 .BR aio_read (3),
  65 .BR aio_write (3),
  66 or
  67 .BR lio_listio (3).
  68 (See
  69 .BR aio (7)
  70 for a description of the
  71 .I aiocb
  72 structure.)
  73 .PP
  74 If
  75 .B CLOCK_MONOTONIC
  76 is supported, this clock is used to measure
  77 the timeout interval (see
  78 .BR clock_gettime (2)).
  79 .SH RETURN VALUE
  80 If this function returns after completion of one of the I/O
  81 requests specified in
  82 .IR aiocb_list ,
  83 0 is returned.
  84 Otherwise, \-1 is returned, and
  85 .I errno
  86 is set to indicate the error.
  87 .SH ERRORS
  88 .TP
  89 .B EAGAIN
  90 The call timed out before any of the indicated operations
  91 had completed.
  92 .TP
  93 .B EINTR
  94 The call was ended by signal
  95 (possibly the completion signal of one of the operations we were
  96 waiting for); see
  97 .BR signal (7).
  98 .TP
  99 .B ENOSYS
 100 .BR aio_suspend ()
 101 is not implemented.
 102 .SH VERSIONS
 103 The
 104 .BR aio_suspend ()
 105 function is available since glibc 2.1.
 106 .SH ATTRIBUTES
 107 For an explanation of the terms used in this section, see
 108 .BR attributes (7).
 109 .ad l
 110 .nh
 111 .TS
 112 allbox;
 113 lbx lb lb
 114 l l l.
 115 Interface       Attribute       Value
 116 T{
 117 .BR aio_suspend ()
 118 T}      Thread safety   MT-Safe
 119 .TE
 120 .hy
 121 .ad
 122 .sp 1
 123 .SH CONFORMING TO
 124 POSIX.1-2001, POSIX.1-2008.
 125 .PP
 126 POSIX doesn't specify the parameters to be
 127 .IR restrict ;
 128 that is specific to glibc.
 129 .SH NOTES
 130 One can achieve polling by using a non-NULL
 131 .I timeout
 132 that specifies a zero time interval.
 133 .PP
 134 If one or more of the asynchronous I/O operations specified in
 135 .IR aiocb_list
 136 has already completed at the time of the call to
 137 .BR aio_suspend (),
 138 then the call returns immediately.
 139 .PP
 140 To determine which I/O operations have completed
 141 after a successful return from
 142 .BR aio_suspend (),
 143 use
 144 .BR aio_error (3)
 145 to scan the list of
 146 .I aiocb
 147 structures pointed to by
 148 .IR aiocb_list .
 149 .SH BUGS
 150 The glibc implementation of
 151 .BR aio_suspend ()
 152 is not async-signal-safe,
 153 .\" FIXME . https://sourceware.org/bugzilla/show_bug.cgi?id=13172
 154 in violation of the requirements of POSIX.1.
 155 .SH SEE ALSO
 156 .BR aio_cancel (3),
 157 .BR aio_error (3),
 158 .BR aio_fsync (3),
 159 .BR aio_read (3),
 160 .BR aio_return (3),
 161 .BR aio_write (3),
 162 .BR lio_listio (3),
 163 .BR aio (7),
 164 .BR time (7)