docs: Added All OpenBSD Manuals

1 files changed, 133 insertions, 0 deletions

diff --git a/static/openbsd/man2/mquery.2 b/static/openbsd/man2/mquery.2
new file mode 100644
index 00000000..7da8cda2
--- /dev/null
+++ b/static/openbsd/man2/mquery.2
@@ -0,0 +1,133 @@
+.\"	$OpenBSD: mquery.2,v 1.13 2022/03/31 17:27:16 naddy Exp $
+.\"
+.\" Copyright (c) 2003 Artur Grabowski <art@openbsd.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+.\" EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: March 31 2022 $
+.Dt MQUERY 2
+.Os
+.Sh NAME
+.Nm mquery
+.Nd provide mapping hints to applications
+.Sh SYNOPSIS
+.In sys/mman.h
+.Ft void *
+.Fn mquery "void *addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
+.Sh DESCRIPTION
+The
+.Fn mquery
+system call checks the existing memory mappings of a process and returns
+hints to the caller about where to put a memory mapping.
+This hint can be later used when performing memory mappings with the
+.Xr mmap 2
+system call with
+.Dv MAP_FIXED
+in the flags.
+The
+.Fa addr
+argument should be a memory location that which the caller specifies the
+preferred address.
+The
+.Fa size
+argument specifies the requested size of the memory area the caller
+is looking for.
+The
+.Fa fd
+and
+.Fa off
+arguments specify the file that will be mapped and the offset in it,
+this is the same as the corresponding arguments to
+.Xr mmap 2 .
+.Pp
+The behavior of the function depends on the
+.Fa flags
+argument.
+If set to
+.Dv MAP_FIXED ,
+the pointer
+.Fa addr
+is used as a fixed hint and
+.Fn mquery
+will return
+.Dv MAP_FAILED
+and set
+.Va errno
+to
+.Er ENOMEM
+if there is not
+.Fa size
+bytes free after that address.
+Otherwise it will return the hint addr.
+If no flags are set,
+.Fn mquery
+will use
+.Fa addr
+as a starting point in memory and will search forward to find
+a memory area with
+.Fa size
+bytes free and that will be suitable for creating a mapping for the
+file and offset specified in the
+.Fa fd
+and
+.Fa off
+arguments.
+When no such area can be found,
+.Fn mquery
+will return
+.Dv MAP_FAILED
+and set
+.Va errno
+to indicate the error.
+.Sh RETURN VALUES
+When a memory range satisfying the request is found,
+.Fn mquery
+returns the available address.
+Otherwise,
+.Dv MAP_FAILED
+is returned and
+.Va errno
+is set to indicate the error.
+.Sh ERRORS
+.Fn mquery
+will fail if:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+.Dv MAP_FIXED
+was specified and the requested memory area is unavailable.
+.It Bq Er ENOMEM
+There was not enough memory left after the hint specified.
+.It Bq Er EBADF
+.Fa fd
+is not a valid open file descriptor.
+.El
+.Sh SEE ALSO
+.Xr mmap 2
+.Sh STANDARDS
+The
+.Fn mquery
+function should not be used in portable applications.
+.Sh HISTORY
+The
+.Fn mquery
+function first appeared in
+.Ox 3.4 .