xref: /netbsd/lib/libc/sys/munmap.2 (revision bf9ec67e)
1.\"	$NetBSD: munmap.2,v 1.15 2002/02/08 01:28:19 ross Exp $
2.\"
3.\" Copyright (c) 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)munmap.2	8.3 (Berkeley) 5/27/94
35.\"
36.Dd May 27, 1994
37.Dt MUNMAP 2
38.Os
39.Sh NAME
40.Nm munmap
41.Nd remove a mapping
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include \*[Lt]sys/mman.h\*[Gt]
46.Ft int
47.Fn munmap "void *addr" "size_t len"
48.Sh DESCRIPTION
49The
50.Fn munmap
51system call
52deletes the mappings for the specified address range,
53and causes further references to addresses within the range
54to generate invalid memory references.
55.Sh RETURN VALUES
56Upon successful completion,
57.Nm munmap
58returns zero.
59Otherwise, a value of -1 is returned and
60.Va errno
61is set to indicate the error.
62.Sh ERRORS
63.Fn munmap
64will fail if:
65.Bl -tag -width Er
66.It Bq Er EINVAL
67The
68.Fa addr
69parameter was not page aligned, the
70.Fa len
71parameter was negative, or
72some part of the region being unmapped is outside the
73valid address range for a process.
74.El
75.Sh SEE ALSO
76.Xr madvise 2 ,
77.Xr mincore 2 ,
78.Xr mlock 2 ,
79.Xr mmap 2 ,
80.Xr mprotect 2 ,
81.Xr msync 2 ,
82.Xr getpagesize 3
83.Sh HISTORY
84The
85.Fn munmap
86function first appeared in
87.Bx 4.4 .
88