NetBSD/lib/libc/sys/munmap.2

.\"	$NetBSD: munmap.2,v 1.10 1998/08/29 08:32:40 lukem Exp $
.\"
.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  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. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
.\"
.\"	@(#)munmap.2	8.3 (Berkeley) 5/27/94
.\"
.Dd May 27, 1994
.Dt MUNMAP 2
.Os
.Sh NAME
.Nm munmap
.Nd remove a mapping
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/mman.h>
.Ft int
.Fn munmap "void *addr" "size_t len"
.Sh DESCRIPTION
The
.Fn munmap
system call
deletes the mappings for the specified address range,
and causes further references to addresses within the range
to generate invalid memory references.
.Sh RETURN VALUES
Upon successful completion,
.Nm munmap
returns zero.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn munmap
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The
.Fa addr
parameter was not page aligned, the
.Fa len
parameter was negative, or
some part of the region being unmapped is outside the
valid address range for a process.
.Sh "SEE ALSO"
.Xr madvise 2 ,
.Xr mincore 2 ,
.Xr mlock 2 ,
.Xr mmap 2 ,
.Xr mprotect 2 ,
.Xr msync 2 ,
.Xr getpagesize 3
.Sh HISTORY
The
.Fn munmap
function first appeared in
.Bx 4.4 .
first pass at fixing up capitalization of function names and arguments; ensure that each is correct with respect to the implementation, rather than being correct as per english. 1998-08-29 12:32:32 +04:00			`.\" $NetBSD: munmap.2,v 1.10 1998/08/29 08:32:40 lukem Exp $`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`.\"`
			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" 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. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.`
			`.\"`
merge lite-2 1998-02-02 08:20:24 +03:00			`.\" @(#)munmap.2 8.3 (Berkeley) 5/27/94`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
merge lite-2 1998-02-02 08:20:24 +03:00			`.Dd May 27, 1994`
update manpage to -mandoc macros 1993-08-06 01:31:41 +04:00			`.Dt MUNMAP 2`
			`.Os`
			`.Sh NAME`
			`.Nm munmap`
			`.Nd remove a mapping`
			`.Sh SYNOPSIS`
Add explicit return types and needed header files to SYNOPSIS section. 1993-12-15 21:08:12 +03:00			`.Fd #include <sys/types.h>`
			`.Fd #include <sys/mman.h>`
			`.Ft int`
caddr_t -> void * PR/4269: Chris Demetriou: Add MS_* to msync() 1997-10-17 03:21:47 +04:00			`.Fn munmap "void *addr" "size_t len"`
update manpage to -mandoc macros 1993-08-06 01:31:41 +04:00			`.Sh DESCRIPTION`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`The`
update manpage to -mandoc macros 1993-08-06 01:31:41 +04:00			`.Fn munmap`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`system call`
			`deletes the mappings for the specified address range,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`and causes further references to addresses within the range`
			`to generate invalid memory references.`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`.Sh RETURN VALUES`
			`Upon successful completion,`
			`.Nm munmap`
			`returns zero.`
			`Otherwise, a value of -1 is returned and`
			`.Va errno`
			`is set to indicate the error.`
			`.Sh ERRORS`
first pass at fixing up capitalization of function names and arguments; ensure that each is correct with respect to the implementation, rather than being correct as per english. 1998-08-29 12:32:32 +04:00			`.Fn munmap`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`will fail if:`
			`.Bl -tag -width Er`
			`.It Bq Er EINVAL`
			`The`
			`.Fa addr`
			`parameter was not page aligned, the`
			`.Fa len`
			`parameter was negative, or`
merge lite-2 1998-02-02 08:20:24 +03:00			`some part of the region being unmapped is outside the`
			`valid address range for a process.`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`.Sh "SEE ALSO"`
			`.Xr madvise 2 ,`
xref mmap(2), not self; xref mlock(2); sort xrefs 1997-07-15 10:52:43 +04:00			`.Xr mincore 2 ,`
			`.Xr mlock 2 ,`
			`.Xr mmap 2 ,`
			`.Xr mprotect 2 ,`
			`.Xr msync 2 ,`
			`.Xr getpagesize 3`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`.Sh HISTORY`
			`The`
			`.Fn munmap`
.Bx'ize/.Nx'ize 1998-02-04 00:12:45 +03:00			`function first appeared in`
			`.Bx 4.4 .`