[apple/xnu.git] / bsd / man / man2 / munmap.2

.\"	$NetBSD: munmap.2,v 1.5 1995/02/27 12:35:03 cgd 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.2 (Berkeley) 4/15/94
.\"
.Dd April 15, 1994
.Dt MUNMAP 2
.Os
.Sh NAME
.Nm munmap
.Nd remove a mapping
.Sh SYNOPSIS
.Fd #include <sys/mman.h>
.Ft int
.Fo munmap
.Fa "void *addr"
.Fa "size_t len"
.Fc
.Sh DESCRIPTION
The
.Fn munmap
system call
deletes the mappings for the specified address range,
causing 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 (i.e., a multiple of the page size).
.\" ===========
.It Bq Er EINVAL
The
.Fa len
parameter was negative or zero.
.\" ===========
.It Bq Er EINVAL
Some part of the region being unmapped is not part of the currently
valid address space.
.El
.Sh LEGACY SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/mman.h>
.Pp
The include file
.In sys/types.h
is necessary.
.Pp
.Ft int
.br
.Fo munmap
.Fa "caddr_t addr"
.Fa "size_t len"
.Fc ;
.Pp
The type of
.Fa addr
has changed.
.Sh "SEE ALSO"
.Xr getpagesize 3 ,
.Xr msync 2 ,
.Xr munmap 2 ,
.Xr mprotect 2 ,
.Xr madvise 2 ,
.Xr mincore 2 ,
.Xr compat 5
.Sh HISTORY
The
.Fn munmap
function first appeared in 4.4BSD.
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: munmap.2,v 1.5 1995/02/27 12:35:03 cgd 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.2 (Berkeley) 4/15/94
	35	.\"
	36	.Dd April 15, 1994
	37	.Dt MUNMAP 2
	38	.Os
	39	.Sh NAME
	40	.Nm munmap
	41	.Nd remove a mapping
	42	.Sh SYNOPSIS
9bccf70c A	43	.Fd #include <sys/mman.h>
9bccf70c A	44	.Ft int
2d21ac55 A	45	.Fo munmap
	46	.Fa "void *addr"
	47	.Fa "size_t len"
	48	.Fc
9bccf70c A	49	.Sh DESCRIPTION
	50	The
	51	.Fn munmap
	52	system call
	53	deletes the mappings for the specified address range,
2d21ac55	54	causing further references to addresses within the range
9bccf70c A	55	to generate invalid memory references.
	56	.Sh RETURN VALUES
	57	Upon successful completion,
	58	.Nm munmap
	59	returns zero.
	60	Otherwise, a value of -1 is returned and
	61	.Va errno
	62	is set to indicate the error.
	63	.Sh ERRORS
	64	.Fn Munmap
	65	will fail if:
	66	.Bl -tag -width Er
2d21ac55	67	.\" ===========
9bccf70c A	68	.It Bq Er EINVAL
	69	The
	70	.Fa addr
2d21ac55 A	71	parameter was not page aligned (i.e., a multiple of the page size).
	72	.\" ===========
	73	.It Bq Er EINVAL
	74	The
9bccf70c	75	.Fa len
2d21ac55 A	76	parameter was negative or zero.
	77	.\" ===========
	78	.It Bq Er EINVAL
	79	Some part of the region being unmapped is not part of the currently
9bccf70c	80	valid address space.
55e303ae	81	.El
2d21ac55 A	82	.Sh LEGACY SYNOPSIS
	83	.Fd #include <sys/types.h>
	84	.Fd #include <sys/mman.h>
	85	.Pp
	86	The include file
	87	.In sys/types.h
	88	is necessary.
	89	.Pp
	90	.Ft int
	91	.br
	92	.Fo munmap
	93	.Fa "caddr_t addr"
	94	.Fa "size_t len"
	95	.Fc ;
	96	.Pp
	97	The type of
	98	.Fa addr
	99	has changed.
9bccf70c A	100	.Sh "SEE ALSO"
	101	.Xr getpagesize 3 ,
	102	.Xr msync 2 ,
	103	.Xr munmap 2 ,
	104	.Xr mprotect 2 ,
	105	.Xr madvise 2 ,
2d21ac55 A	106	.Xr mincore 2 ,
2d21ac55 A	107	.Xr compat 5
9bccf70c A	108	.Sh HISTORY
	109	The
	110	.Fn munmap
	111	function first appeared in 4.4BSD.