share/man/man4/aio.4

   1 .\"-
   2 .\" Copyright (c) 2002 Dag-Erling Coïdan Smørgrav
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd June 22, 2017
  31 .Dt AIO 4
  32 .Os
  33 .Sh NAME
  34 .Nm aio
  35 .Nd asynchronous I/O
  36 .Sh SYNOPSIS
  37 To link into the kernel:
  38 .Cd "options VFS_AIO"
  39 .Pp
  40 To load as a kernel loadable module:
  41 .Dl kldload aio
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 facility provides system calls for asynchronous I/O.
  46 It is available both as a kernel option for static inclusion and as a
  47 dynamic kernel module.
  48 .Pp
  49 Asynchronous I/O control buffers should be zeroed before initializing
  50 individual fields.
  51 This ensures all fields are initialized.
  52 .Pp
  53 All asynchronous I/O control buffers contain a
  54 .Vt sigevent
  55 structure in the
  56 .Va aio_sigevent
  57 field which can be used to request notification when an operation completes.
  58 .Pp
  59 For
  60 .Dv SIGEV_KEVENT
  61 notifications,
  62 the
  63 .Va sigevent
  64 .Ap
  65 s
  66 .Va sigev_notify_kqueue
  67 field should contain the descriptor of the kqueue that the event should be attached
  68 to, its
  69 .Va sigev_notify_kevent_flags
  70 field may contain
  71 .Dv EV_ONESHOT ,
  72 .Dv EV_CLEAR , and/or
  73 .Dv EV_DISPATCH , and its
  74 .Va sigev_notify
  75 field should be set to
  76 .Dv SIGEV_KEVENT .
  77 The posted kevent will contain:
  78 .Bl -column ".Va filter"
  79 .It Sy Member Ta Sy Value
  80 .It Va ident Ta asynchronous I/O control buffer pointer
  81 .It Va filter Ta Dv EVFILT_AIO
  82 .It Va flags Ta Dv EV_EOF
  83 .It Va udata Ta
  84 value stored in
  85 .Va aio_sigevent.sigev_value
  86 .El
  87 .Pp
  88 For
  89 .Dv SIGEV_SIGNO
  90 and
  91 .Dv SIGEV_THREAD_ID
  92 notifications,
  93 the information for the queued signal will include
  94 .Dv SI_ASYNCIO
  95 in the
  96 .Va si_code
  97 field and the value stored in
  98 .Va sigevent.sigev_value
  99 in the
 100 .Va si_value
 101 field.
 102 .Pp
 103 For
 104 .Dv SIGEV_THREAD
 105 notifications,
 106 the value stored in
 107 .Va aio_sigevent.sigev_value
 108 is passed to the
 109 .Va aio_sigevent.sigev_notify_function
 110 as described in
 111 .Xr sigevent 3 .
 112 .Sh SEE ALSO
 113 .Xr aio_cancel 2 ,
 114 .Xr aio_error 2 ,
 115 .Xr aio_read 2 ,
 116 .Xr aio_return 2 ,
 117 .Xr aio_suspend 2 ,
 118 .Xr aio_waitcomplete 2 ,
 119 .Xr aio_write 2 ,
 120 .Xr lio_listio 2 ,
 121 .Xr sigevent 3 ,
 122 .Xr config 8 ,
 123 .Xr kldload 8 ,
 124 .Xr kldunload 8
 125 .Sh HISTORY
 126 The
 127 .Nm
 128 facility appeared as a kernel option in
 129 .Fx 3.0 .
 130 The
 131 .Nm
 132 kernel module appeared in
 133 .Fx 5.0 .