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 July 15, 2016
  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 posted kevent will contain:
  63 .Bl -column ".Va filter"
  64 .It Sy Member Ta Sy Value
  65 .It Va ident Ta asynchronous I/O control buffer pointer
  66 .It Va filter Ta Dv EVFILT_AIO
  67 .It Va udata Ta
  68 value stored in
  69 .Va aio_sigevent.sigev_value
  70 .El
  71 .Pp
  72 For
  73 .Dv SIGEV_SIGNO
  74 and
  75 .Dv SIGEV_THREAD_ID
  76 notifications,
  77 the information for the queued signal will include
  78 .Dv SI_ASYNCIO
  79 in the
  80 .Va si_code
  81 field and the value stored in
  82 .Va sigevent.sigev_value
  83 in the
  84 .Va si_value
  85 field.
  86 .Pp
  87 For
  88 .Dv SIGEV_THREAD
  89 notifications,
  90 the value stored in
  91 .Va aio_sigevent.sigev_value
  92 is passed to the
  93 .Va aio_sigevent.sigev_notify_function
  94 as described in
  95 .Xr sigevent 3 .
  96 .Sh SEE ALSO
  97 .Xr aio_cancel 2 ,
  98 .Xr aio_error 2 ,
  99 .Xr aio_read 2 ,
 100 .Xr aio_return 2 ,
 101 .Xr aio_suspend 2 ,
 102 .Xr aio_waitcomplete 2 ,
 103 .Xr aio_write 2 ,
 104 .Xr lio_listio 2 ,
 105 .Xr sigevent 3 ,
 106 .Xr config 8 ,
 107 .Xr kldload 8 ,
 108 .Xr kldunload 8
 109 .Sh HISTORY
 110 The
 111 .Nm
 112 facility appeared as a kernel option in
 113 .Fx 3.0 .
 114 The
 115 .Nm
 116 kernel module appeared in
 117 .Fx 5.0 .