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