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