lib/libc/sys/aio_mlock.2

   1 .\" Copyright (c) 2013 Gleb Smirnoff <glebius@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd August 19, 2016
  28 .Dt AIO_MLOCK 2
  29 .Os
  30 .Sh NAME
  31 .Nm aio_mlock
  32 .Nd asynchronous
  33 .Xr mlock 2
  34 operation
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In aio.h
  39 .Ft int
  40 .Fn aio_mlock "struct aiocb *iocb"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn aio_mlock
  44 system call allows the calling process to lock into memory the
  45 physical pages associated with the virtual address range starting at
  46 .Fa iocb->aio_buf
  47 for
  48 .Fa iocb->aio_nbytes
  49 bytes.
  50 The call returns immediately after the locking request has
  51 been enqueued; the operation may or may not have completed at the time
  52 the call returns.
  53 .Pp
  54 The
  55 .Fa iocb
  56 pointer may be subsequently used as an argument to
  57 .Fn aio_return
  58 and
  59 .Fn aio_error
  60 in order to determine return or error status for the enqueued operation
  61 while it is in progress.
  62 .Pp
  63 If the request could not be enqueued (generally due to
  64 .Xr aio 4
  65 limits),
  66 then the call returns without having enqueued the request.
  67 .Pp
  68 The
  69 .Fa iocb->aio_sigevent
  70 structure can be used to request notification of the operation's
  71 completion as described in
  72 .Xr aio 4 .
  73 .Sh RESTRICTIONS
  74 The Asynchronous I/O Control Block structure pointed to by
  75 .Fa iocb
  76 and the buffer that the
  77 .Fa iocb->aio_buf
  78 member of that structure references must remain valid until the
  79 operation has completed.
  80 .Pp
  81 The asynchronous I/O control buffer
  82 .Fa iocb
  83 should be zeroed before the
  84 .Fn aio_mlock
  85 call to avoid passing bogus context information to the kernel.
  86 .Pp
  87 Modifications of the Asynchronous I/O Control Block structure or the
  88 memory mapping described by the virtual address range are not allowed
  89 while the request is queued.
  90 .Sh RETURN VALUES
  91 .Rv -std aio_mlock
  92 .Sh ERRORS
  93 The
  94 .Fn aio_mlock
  95 system call will fail if:
  96 .Bl -tag -width Er
  97 .It Bq Er EAGAIN
  98 The request was not queued because of system resource limitations.
  99 .It Bq Er EINVAL
 100 The asynchronous notification method in
 101 .Fa iocb->aio_sigevent.sigev_notify
 102 is invalid or not supported.
 103 .It Bq Er ENOSYS
 104 The
 105 .Fn aio_mlock
 106 system call is not supported.
 107 .El
 108 .Pp
 109 If the request is successfully enqueued, but subsequently cancelled
 110 or an error occurs, the value returned by the
 111 .Fn aio_return
 112 system call is per the
 113 .Xr mlock 2
 114 system call, and the value returned by the
 115 .Fn aio_error
 116 system call is one of the error returns from the
 117 .Xr mlock 2
 118 system call, or
 119 .Er ECANCELED
 120 if the request was explicitly cancelled via a call to
 121 .Fn aio_cancel .
 122 .Sh SEE ALSO
 123 .Xr aio_cancel 2 ,
 124 .Xr aio_error 2 ,
 125 .Xr aio_return 2 ,
 126 .Xr mlock 2 ,
 127 .Xr sigevent 3 ,
 128 .Xr aio 4
 129 .Sh PORTABILITY
 130 The
 131 .Fn aio_mlock
 132 system call is a
 133 .Fx
 134 extension, and should not be used in portable code.
 135 .Sh HISTORY
 136 The
 137 .Fn aio_mlock
 138 system call first appeared in
 139 .Fx 10.0 .
 140 .Sh AUTHORS
 141 The system call was introduced by
 142 .An Gleb Smirnoff Aq glebius@FreeBSD.org .