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

.\"	$NetBSD: mprotect.2,v 1.6 1995/10/12 15:41:08 jtc 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.
.\"
.\"	@(#)mprotect.2	8.1 (Berkeley) 6/9/93
.\"
.Dd June 9, 1993
.Dt MPROTECT 2
.Os
.Sh NAME
.Nm mprotect
.Nd control the protection of pages
.Sh SYNOPSIS
.Fd #include <sys/mman.h>
.Ft int
.Fo mprotect
.Fa "void *addr"
.Fa "size_t len"
.Fa "int prot"
.Fc
.Sh DESCRIPTION
The
.Fn mprotect
system call
changes the specified pages to have protection
.Fa prot .
Not all implementations will guarantee protection on a page basis;
the granularity of protection changes may be as large as an entire region.
.Sh RETURN VALUES
Upon successful completion,
a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn mprotect
will fail if:
.Bl -tag -width Er
.\" ===========
.It Bq Er EACCES
The requested protection conflicts with
the access permissions of the process
on the specified address range.
.\" ===========
.\" .It Bq Er EAGAIN
.\" Insufficient memory resources exist to allow locking a private page
.\" under PROT_WRITE.
.\" ===========
.It Bq Er EINVAL
.Fa addr
is not a multiple of the page size.
.\" ===========
.\" .It Bq Er ENOMEM
.\" The specified address range is outside of the address range
.\" of the process or includes an unmapped page.
.\" ===========
.It Bq Er ENOTSUP
The combination of accesses requested in
.Fa prot
is not supported.
.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 mprotect
.Fa "caddr_t addr"
.Fa "size_t len"
.Fa "int prot"
.Fc ;
.Pp
The type of
.Fa addr
has changed.
.Sh SEE ALSO
.Xr madvise 2 , 
.Xr mincore 2 , 
.Xr msync 2 ,
.Xr munmap 2 ,
.Xr compat 5
.Sh HISTORY
The
.Fn mprotect
function first appeared in 4.4BSD.
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: mprotect.2,v 1.6 1995/10/12 15:41:08 jtc 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	.\" @(#)mprotect.2 8.1 (Berkeley) 6/9/93
	35	.\"
	36	.Dd June 9, 1993
	37	.Dt MPROTECT 2
	38	.Os
	39	.Sh NAME
	40	.Nm mprotect
	41	.Nd control the protection of pages
	42	.Sh SYNOPSIS
9bccf70c A	43	.Fd #include <sys/mman.h>
9bccf70c A	44	.Ft int
2d21ac55 A	45	.Fo mprotect
	46	.Fa "void *addr"
	47	.Fa "size_t len"
	48	.Fa "int prot"
	49	.Fc
9bccf70c A	50	.Sh DESCRIPTION
	51	The
	52	.Fn mprotect
	53	system call
	54	changes the specified pages to have protection
	55	.Fa prot .
	56	Not all implementations will guarantee protection on a page basis;
	57	the granularity of protection changes may be as large as an entire region.
	58	.Sh RETURN VALUES
	59	Upon successful completion,
	60	a value of 0 is returned.
	61	Otherwise, a value of -1 is returned and
	62	.Va errno
	63	is set to indicate the error.
2d21ac55 A	64	.Sh ERRORS
	65	.Fn mprotect
	66	will fail if:
	67	.Bl -tag -width Er
	68	.\" ===========
	69	.It Bq Er EACCES
	70	The requested protection conflicts with
	71	the access permissions of the process
	72	on the specified address range.
	73	.\" ===========
	74	.\" .It Bq Er EAGAIN
	75	.\" Insufficient memory resources exist to allow locking a private page
	76	.\" under PROT_WRITE.
	77	.\" ===========
	78	.It Bq Er EINVAL
	79	.Fa addr
	80	is not a multiple of the page size.
	81	.\" ===========
	82	.\" .It Bq Er ENOMEM
	83	.\" The specified address range is outside of the address range
	84	.\" of the process or includes an unmapped page.
	85	.\" ===========
	86	.It Bq Er ENOTSUP
	87	The combination of accesses requested in
	88	.Fa prot
	89	is not supported.
	90	.El
	91	.Sh LEGACY SYNOPSIS
	92	.Fd #include <sys/types.h>
	93	.Fd #include <sys/mman.h>
	94	.Pp
	95	The include file
	96	.In sys/types.h
	97	is necessary.
	98	.Pp
	99	.Ft int
	100	.br
	101	.Fo mprotect
	102	.Fa "caddr_t addr"
	103	.Fa "size_t len"
	104	.Fa "int prot"
	105	.Fc ;
	106	.Pp
	107	The type of
	108	.Fa addr
	109	has changed.
9bccf70c A	110	.Sh SEE ALSO
	111	.Xr madvise 2 ,
	112	.Xr mincore 2 ,
	113	.Xr msync 2 ,
2d21ac55 A	114	.Xr munmap 2 ,
2d21ac55 A	115	.Xr compat 5
9bccf70c A	116	.Sh HISTORY
	117	The
	118	.Fn mprotect
	119	function first appeared in 4.4BSD.