lib/libc/sys/mmap.2

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mmap.2      8.4 (Berkeley) 5/11/95
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd May 11, 1995
  36 .Dt MMAP 2
  37 .Os BSD 4
  38 .Sh NAME
  39 .Nm mmap
  40 .Nd allocate memory, or map files or devices into memory
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .Fd #include <sys/types.h>
  45 .Fd #include <sys/mman.h>
  46 .Ft void *
  47 .Fn mmap "void *addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn mmap
  51 function causes the pages starting at
  52 .Fa addr
  53 and continuing for at most
  54 .Fa len
  55 bytes to be mapped from the object described by
  56 .Fa fd ,
  57 starting at byte offset
  58 .Fa offset .
  59 If
  60 .Fa len
  61 is not a multiple of the pagesize, the mapped region may extend past the
  62 specified range.
  63 Any such extension beyond the end of the mapped object will be zero-filled.
  64 .Pp
  65 If
  66 .Fa addr
  67 is non-zero, it is used as a hint to the system.
  68 (As a convenience to the system, the actual address of the region may differ
  69 from the address supplied.)
  70 If
  71 .Fa addr
  72 is zero, an address will be selected by the system.
  73 The actual starting address of the region is returned.
  74 A successful
  75 .Fa mmap
  76 deletes any previous mapping in the allocated address range.
  77 .Pp
  78 The protections (region accessibility) are specified in the
  79 .Fa prot
  80 argument by
  81 .Em or Ns 'ing
  82 the following values:
  83 .Pp
  84 .Bl -tag -width PROT_WRITE -compact
  85 .It Dv PROT_NONE
  86 Pages may not be accessed.
  87 .It Dv PROT_READ
  88 Pages may be read.
  89 .It Dv PROT_WRITE
  90 Pages may be written.
  91 .It Dv PROT_EXEC
  92 Pages may be executed.
  93 .El
  94 .Pp
  95 The
  96 .Fa flags
  97 parameter specifies the type of the mapped object, mapping options and
  98 whether modifications made to the mapped copy of the page are private
  99 to the process or are to be shared with other references.
 100 Sharing, mapping type and options are specified in the
 101 .Fa flags
 102 argument by
 103 .Em or Ns 'ing
 104 the following values:
 105 .Bl -tag -width MAP_HASSEMAPHORE
 106 .It Dv MAP_ANON
 107 Map anonymous memory not associated with any specific file.
 108 The file descriptor used for creating
 109 .Dv MAP_ANON
 110 must be \-1.
 111 The
 112 .Fa offset
 113 parameter is ignored.
 114 .\".It Dv MAP_FILE
 115 .\"Mapped from a regular file or character-special device memory.
 116 .It Dv MAP_FIXED
 117 Do not permit the system to select a different address than the one
 118 specified.
 119 If the specified address cannot be used,
 120 .Fn mmap
 121 will fail.
 122 If
 123 .Dv MAP_FIXED
 124 is specified,
 125 .Fa addr
 126 must be a multiple of the pagesize.
 127 Use of this option is discouraged.
 128 .It Dv MAP_HASSEMAPHORE
 129 Notify the kernel that the region may contain semaphores and that special
 130 handling may be necessary.
 131 .It Dv MAP_INHERIT
 132 Permit regions to be inherited across
 133 .Xr execve 2
 134 system calls.
 135 .It Dv MAP_NOCORE
 136 Region is not included in a core file.
 137 .It Dv MAP_NOSYNC
 138 Causes data dirtied via this VM map to be flushed to physical media
 139 only when necessary (usually by the pager) rather then gratuitously.
 140 Typically this prevents the update daemons from flushing pages dirtied
 141 through such maps and thus allows efficient sharing of memory across
 142 unassociated processes using a file-backed shared memory map.  Without
 143 this option any VM pages you dirty may be flushed to disk every so often
 144 (every 30-60 seconds usually) which can create performance problems if you
 145 do not need that to occur (such as when you are using shared file-backed
 146 mmap regions for IPC purposes).  Note that VM/filesystem coherency is
 147 maintained whether you use
 148 .Dv MAP_NOSYNC
 149 or not.  This option is not portable
 150 across
 151 .Ux
 152 platforms (yet), though some may implement the same behavior
 153 by default.
 154 .Pp
 155 .Em WARNING !
 156 Extending a file with
 157 .Xr ftruncate 2 ,
 158 thus creating a big hole, and then filling the hole by modifying a shared
 159 .Fn mmap
 160 can lead to severe file fragmentation.
 161 In order to avoid such fragmentation you should always pre-allocate the
 162 file's backing store by
 163 .Fn write Ns ing
 164 zero's into the newly extended area prior to modifying the area via your
 165 .Fn mmap .
 166 The fragmentation problem is especially sensitive to
 167 .Dv MAP_NOSYNC
 168 pages, because pages may be flushed to disk in a totally random order.
 169 .Pp
 170 The same applies when using
 171 .Dv MAP_NOSYNC
 172 to implement a file-based shared memory store.
 173 It is recommended that you create the backing store by
 174 .Fn write Ns ing
 175 zero's to the backing file rather then
 176 .Fn ftruncate Ns ing
 177 it.
 178 You can test file fragmentation by observing the KB/t (kilobytes per
 179 transfer) results from an
 180 .Dq Li iostat 1
 181 while reading a large file sequentially, e.g. using
 182 .Dq Li dd if=filename of=/dev/null bs=32k .
 183 .Pp
 184 The
 185 .Xr fsync 2
 186 function will flush all dirty data and metadata associated with a file,
 187 including dirty NOSYNC VM data, to physical media.  The
 188 .Xr sync 8
 189 command and
 190 .Xr sync 2
 191 system call generally do not flush dirty NOSYNC VM data.
 192 The
 193 .Xr msync 2
 194 system call is obsolete since
 195 .Bx
 196 implements a coherent filesystem buffer cache.  However, it may be
 197 used to associate dirty VM pages with filesystem buffers and thus cause
 198 them to be flushed to physical media sooner rather then later.
 199 .It Dv MAP_PRIVATE
 200 Modifications are private.
 201 .It Dv MAP_SHARED
 202 Modifications are shared.
 203 .It Dv MAP_STACK
 204 This option is only available if your system has been compiled with
 205 .Dv VM_STACK
 206 defined when compiling the kernel.
 207 This is the default for
 208 i386 only.
 209 Consider adding
 210 .Li -DVM_STACK
 211 to
 212 .Va COPTFLAGS
 213 in your
 214 .Pa /etc/make.conf
 215 to enable this option for other architechures.
 216 .Dv MAP_STACK
 217 implies
 218 .Dv MAP_ANON ,
 219 and
 220 .Fa offset
 221 of 0.
 222 .Fa fd
 223 must be -1 and
 224 .Fa prot
 225 must include at least
 226 .Dv PROT_READ
 227 and
 228 .Dv PROT_WRITE .
 229 This option creates
 230 a memory region that grows to at most
 231 .Fa len
 232 bytes in size, starting from the stack top and growing down.  The
 233 stack top is the starting address returned by the call, plus
 234 .Fa len
 235 bytes.  The bottom of the stack at maximum growth is the starting
 236 address returned by the call.
 237 .El
 238 .Pp
 239 The
 240 .Xr close 2
 241 function does not unmap pages, see
 242 .Xr munmap 2
 243 for further information.
 244 .Pp
 245 The current design does not allow a process to specify the location of
 246 swap space.
 247 In the future we may define an additional mapping type,
 248 .Dv MAP_SWAP ,
 249 in which
 250 the file descriptor argument specifies a file or device to which swapping
 251 should be done.
 252 .Sh RETURN VALUES
 253 Upon successful completion,
 254 .Fn mmap
 255 returns a pointer to the mapped region.
 256 Otherwise, a value of
 257 .Dv MAP_FAILED
 258 is returned and
 259 .Va errno
 260 is set to indicate the error.
 261 .Sh ERRORS
 262 .Fn Mmap
 263 will fail if:
 264 .Bl -tag -width Er
 265 .It Bq Er EACCES
 266 The flag
 267 .Dv PROT_READ
 268 was specified as part of the
 269 .Fa prot
 270 parameter and
 271 .Fa fd
 272 was not open for reading.
 273 The flags
 274 .Dv MAP_SHARED
 275 and
 276 .Dv PROT_WRITE
 277 were specified as part of the
 278 .Fa flags
 279 and
 280 .Fa prot
 281 parameters and
 282 .Fa fd
 283 was not open for writing.
 284 .It Bq Er EBADF
 285 .Fa fd
 286 is not a valid open file descriptor.
 287 .It Bq Er EINVAL
 288 .Dv MAP_FIXED
 289 was specified and the
 290 .Fa addr
 291 parameter was not page aligned, or part of the desired address space
 292 resides out of the valid address space for a user process.
 293 .It Bq Er EINVAL
 294 .Fa Len
 295 was negative.
 296 .It Bq Er EINVAL
 297 .Dv MAP_ANON
 298 was specified and the
 299 .Fa fd
 300 parameter was not -1.
 301 .It Bq Er EINVAL
 302 .Dv MAP_ANON
 303 has not been specified and
 304 .Fa fd
 305 did not reference a regular or character special file.
 306 .It Bq Er EINVAL
 307 .Fa Offset
 308 was not page-aligned.
 309 (See
 310 .Sx BUGS
 311 below.)
 312 .It Bq Er ENOMEM
 313 .Dv MAP_FIXED
 314 was specified and the
 315 .Fa addr
 316 parameter wasn't available, or the system has reached the per-process mmap
 317 limit specified in the
 318 .Va vm.max_proc_mmap
 319 sysctl.
 320 .Dv MAP_ANON
 321 was specified and insufficient memory was available.
 322 .El
 323 .Sh SEE ALSO
 324 .Xr madvise 2 ,
 325 .Xr mincore 2 ,
 326 .Xr mlock 2 ,
 327 .Xr mprotect 2 ,
 328 .Xr msync 2 ,
 329 .Xr munlock 2 ,
 330 .Xr munmap 2 ,
 331 .Xr getpagesize 3
 332 .Sh BUGS
 333 .Fa len
 334 is limited to 2GB.  Mmapping slightly more than 2GB doesn't work, but
 335 it is possible to map a window of size (filesize % 2GB) for file sizes
 336 of slightly less than 2G, 4GB, 6GB and 8GB.
 337 .Pp
 338 The limit is imposed for a variety of reasons.
 339 Most of them have to do
 340 with
 341 .Fx
 342 not wanting to use 64 bit offsets in the VM system due to
 343 the extreme performance penalty.
 344 So
 345 .Fx
 346 uses 32bit page indexes and
 347 this gives
 348 .Fx
 349 a maximum of 8TB filesizes.
 350 It's actually bugs in
 351 the filesystem code that causes the limit to be further restricted to
 352 1TB (loss of precision when doing blockno calculations).
 353 .Pp
 354 Another reason for the 2GB limit is that filesystem metadata can
 355 reside at negative offsets.
 356 .Pp
 357 We currently can only deal with page aligned file offsets.