1 .\" Copyright (c) 2013 Gleb Smirnoff <glebius@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
40 .Fn aio_mlock "struct aiocb *iocb"
44 system call allows the calling process to lock into memory the
45 physical pages associated with the virtual address range starting at
50 The call returns immediately after the locking request has
51 been enqueued; the operation may or may not have completed at the time
56 pointer may be subsequently used as an argument to
60 in order to determine return or error status for the enqueued operation
61 while it is in progress.
63 If the request could not be enqueued (generally due to
66 then the call returns without having enqueued the request.
68 The Asynchronous I/O Control Block structure pointed to by
70 and the buffer that the
72 member of that structure references must remain valid until the
73 operation has completed.
74 For this reason, use of auto (stack) variables
75 for these objects is discouraged.
77 The asynchronous I/O control buffer
79 should be zeroed before the
81 call to avoid passing bogus context information to the kernel.
83 Modifications of the Asynchronous I/O Control Block structure or the
84 buffer contents after the request has been enqueued, but before the
85 request has completed, are not allowed.
91 system call will fail if:
94 The request was not queued because of system resource limitations.
98 system call is not supported.
101 If the request is successfully enqueued, but subsequently cancelled
102 or an error occurs, the value returned by the
104 system call is per the
106 system call, and the value returned by the
108 system call is one of the error returns from the
112 if the request was explicitly cancelled via a call to
125 extension, and should not be used in portable code.
129 system call first appeared in
132 The system call was introduced by
133 .An Gleb Smirnoff Aq glebius@FreeBSD.org .