usr/src/man/man2/mprotect.2

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH MPROTECT 2 "Jan 12, 1998"
  11 .SH NAME
  12 mprotect \- set protection of memory mapping
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <sys/mman.h>
  17
  18 \fBint\fR \fBmprotect\fR(\fBvoid *\fR\fIaddr\fR, \fBsize_t\fR \fIlen\fR, \fBint\fR \fIprot\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The  \fBmprotect()\fR function changes the access protections on the mappings
  25 specified by the range [\fIaddr, addr + len\fR\|), rounding \fIlen\fR up to the
  26 next multiple of the page size as returned by \fBsysconf\fR(3C), to be that
  27 specified by \fIprot\fR. Legitimate values for \fIprot\fR are the same as those
  28 permitted for \fBmmap\fR(2) and are defined in <\fBsys/mman.h\fR> as:
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fBPROT_READ\fR\fR
  33 .ad
  34 .RS 14n
  35 \fB/* page can be read */\fR
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBPROT_WRITE\fR\fR
  42 .ad
  43 .RS 14n
  44 \fB/* page can be written */\fR
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBPROT_EXEC\fR\fR
  51 .ad
  52 .RS 14n
  53 \fB/* page can be executed */\fR
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBPROT_NONE\fR\fR
  60 .ad
  61 .RS 14n
  62 \fB/* page can not be accessed */\fR
  63 .RE
  64
  65 .sp
  66 .LP
  67 When \fBmprotect()\fR fails for reasons other than \fBEINVAL\fR, the
  68 protections on some of the pages in the range [\fIaddr, addr + len\fR) may have
  69 been changed. If the error occurs on some page at \fIaddr2\fR, then the
  70 protections of all whole pages in the range [\fIaddr, addr2\fR] will have been
  71 modified.
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 Upon successful completion, \fBmprotect()\fR returns \fB0\fR. Otherwise, it
  76 returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  77 .SH ERRORS
  78 .sp
  79 .LP
  80 The \fBmprotect()\fR function will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEACCES\fR\fR
  85 .ad
  86 .RS 10n
  87 The \fIprot\fR argument specifies a protection that violates the access
  88 permission the process has to the underlying memory object.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBEINVAL\fR\fR
  95 .ad
  96 .RS 10n
  97 The \fIlen\fR argument has a value equal to 0, or \fIaddr\fR is not a multiple
  98 of the page size as returned by \fBsysconf\fR(3C).
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBENOMEM\fR\fR
 105 .ad
 106 .RS 10n
 107 Addresses in the range [\fIaddr, addr + len\fR) are invalid for the address
 108 space of a process, or specify one or more pages which are not mapped.
 109 .RE
 110
 111 .sp
 112 .LP
 113 The \fBmprotect()\fR function may fail if:
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEAGAIN\fR\fR
 118 .ad
 119 .RS 10n
 120 The address range [\fIaddr, addr + len\fR) includes one or more pages that have
 121 been locked in memory and that were mapped \fB\fR\fBMAP_PRIVATE\fR\fB;\fR
 122 \fIprot\fR includes \fB\fR\fBPROT_WRITE\fR\fB;\fR and the system has
 123 insufficient resources to reserve memory for the private pages that may be
 124 created. These private pages may be created by store operations in the
 125 now-writable address range.
 126 .RE
 127
 128 .SH ATTRIBUTES
 129 .sp
 130 .LP
 131 See \fBattributes\fR(5) for descriptions of the following attributes:
 132 .sp
 133
 134 .sp
 135 .TS
 136 box;
 137 c | c
 138 l | l .
 139 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 140 _
 141 Interface Stability     Standard
 142 .TE
 143
 144 .SH SEE ALSO
 145 .sp
 146 .LP
 147 \fBmmap\fR(2), \fBplock\fR(3C), \fBmlock\fR(3C), \fBmlockall\fR(3C),
 148 \fBsysconf\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)