]> git.saurik.com Git - apple/xnu.git/blame - bsd/man/man2/mprotect.2
xnu-344.tar.gz
[apple/xnu.git] / bsd / man / man2 / mprotect.2
CommitLineData
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
43.Fd #include <sys/types.h>
44.Fd #include <sys/mman.h>
45.Ft int
46.Fn mprotect "caddr_t addr" "size_t len" "int prot"
47.Sh DESCRIPTION
48The
49.Fn mprotect
50system call
51changes the specified pages to have protection
52.Fa prot .
53Not all implementations will guarantee protection on a page basis;
54the granularity of protection changes may be as large as an entire region.
55.Sh RETURN VALUES
56Upon successful completion,
57a value of 0 is returned.
58Otherwise, a value of -1 is returned and
59.Va errno
60is set to indicate the error.
61.Sh SEE ALSO
62.Xr madvise 2 ,
63.Xr mincore 2 ,
64.Xr msync 2 ,
65.Xr munmap 2
66.Sh HISTORY
67The
68.Fn mprotect
69function first appeared in 4.4BSD.