usr/src/man/man3head/mman.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH MMAN.H 3HEAD "Feb 5, 2008"
  12 .SH NAME
  13 mman.h, mman \- memory management declarations
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <\fBsys/mman.h\fR>
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The <\fBsys/mman.h\fR> header supports the following options:
  24 .RS +4
  25 .TP
  26 .ie t \(bu
  27 .el o
  28 the Memory Mapped Files option
  29 .RE
  30 .RS +4
  31 .TP
  32 .ie t \(bu
  33 .el o
  34 the Shared Memory Objects option
  35 .RE
  36 .RS +4
  37 .TP
  38 .ie t \(bu
  39 .el o
  40 the Process Memory Locking option
  41 .RE
  42 .RS +4
  43 .TP
  44 .ie t \(bu
  45 .el o
  46 the Memory Protection option
  47 .RE
  48 .RS +4
  49 .TP
  50 .ie t \(bu
  51 .el o
  52 the Synchronized Input and Output option
  53 .RE
  54 .sp
  55 .LP
  56 For Memory Mapped Files and Shared Memory Objects options, the following
  57 protection options are defined:
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBPROT_READ\fR\fR
  62 .ad
  63 .RS 14n
  64 Page can be read.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBPROT_WRITE\fR\fR
  71 .ad
  72 .RS 14n
  73 Page can be written.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBPROT_EXEC\fR\fR
  80 .ad
  81 .RS 14n
  82 Page can be executed.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBPROT_NONE\fR\fR
  89 .ad
  90 .RS 14n
  91 Page cannot be accessed.
  92 .RE
  93
  94 .sp
  95 .LP
  96 The following \fIflag\fR options are defined:
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBMAP_SHARED\fR\fR
 101 .ad
 102 .RS 15n
 103 Share changes.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBMAP_PRIVATE\fR\fR
 110 .ad
 111 .RS 15n
 112 Changes are private.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBMAP_FIXED\fR\fR
 119 .ad
 120 .RS 15n
 121 Interpret \fBaddr\fR exactly.
 122 .RE
 123
 124 .sp
 125 .LP
 126 The flags immediately following are defined for \fBmsync()\fR. See
 127 \fBmsync\fR(3C).
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBMS_ASYNC\fR\fR
 132 .ad
 133 .RS 17n
 134 Perform asynchronous writes.
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBMS_SYNC\fR\fR
 141 .ad
 142 .RS 17n
 143 Perform synchronous writes.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBMS_INVALIDATE\fR\fR
 150 .ad
 151 .RS 17n
 152 Invalidate mappings.
 153 .RE
 154
 155 .sp
 156 .LP
 157 The symbolic constants immediately following are defined for the
 158 \fBmlockall()\fR function. See \fBmlockall\fR(3C).
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBMCL_CURRENT\fR\fR
 163 .ad
 164 .RS 15n
 165 Lock currently mapped pages.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fBMCL_FUTURE\fR\fR
 172 .ad
 173 .RS 15n
 174 Lock pages that become mapped.
 175 .RE
 176
 177 .sp
 178 .LP
 179 The symbolic constant \fBMAP_FAILED\fR is defined to indicate a failure from
 180 the \fBmmap()\fR function. See \fBmmap\fR(2).
 181 .sp
 182 .LP
 183 The \fBmode_t\fR, \fBoff_t\fR, and \fBsize_t\fR types are be defined as
 184 described in <\fBsys/types.h\fR>. See \fBtypes\fR(3HEAD).
 185 .SH ATTRIBUTES
 186 .sp
 187 .LP
 188 See \fBattributes\fR(5) for descriptions of the following attributes:
 189 .sp
 190
 191 .sp
 192 .TS
 193 box;
 194 c | c
 195 l | l .
 196 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 197 _
 198 Interface Stability     Committed
 199 _
 200 Standard        See \fBstandards\fR(5).
 201 .TE
 202
 203 .SH SEE ALSO
 204 .sp
 205 .LP
 206 \fBmmap\fR(2), \fBmprotect\fR(2), \fBmunmap\fR(2), \fBmadvise\fR(3C),
 207 \fBmlock\fR(3C), \fBmlockall\fR(3C), \fBmsync\fR(3C), \fBshm_open\fR(3C),
 208 \fBshm_unlink\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)