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 map files or devices into memory
  41 .Sh SYNOPSIS
  42 .Fd #include <sys/types.h>
  43 .Fd #include <sys/mman.h>
  44 .Ft void *
  45 .Fn mmap "void * addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn mmap
  49 function causes the pages starting at
  50 .Fa addr
  51 and continuing for at most
  52 .Fa len
  53 bytes to be mapped from the object described by
  54 .Fa fd ,
  55 starting at byte offset
  56 .Fa offset .
  57 If
  58 .Fa len
  59 is not a multiple of the pagesize, the mapped region may extend past the
  60 specified range.
  61 Any such extension beyond the end of the mapped object will be zero-filled.
  62 .Pp
  63 If
  64 .Fa addr
  65 is non-zero, it is used as a hint to the system.
  66 (As a convenience to the system, the actual address of the region may differ
  67 from the address supplied.)
  68 If
  69 .Fa addr
  70 is zero, an address will be selected by the system.
  71 The actual starting address of the region is returned.
  72 A successful
  73 .Fa mmap
  74 deletes any previous mapping in the allocated address range.
  75 .Pp
  76 The protections (region accessibility) are specified in the
  77 .Fa prot
  78 argument by
  79 .Em or Ns 'ing
  80 the following values:
  81 .Pp
  82 .Bl -tag -width MAP_FIXEDX
  83 .It Dv PROT_EXEC
  84 Pages may be executed.
  85 .It Dv PROT_READ
  86 Pages may be read.
  87 .It Dv PROT_WRITE
  88 Pages may be written.
  89 .El
  90 .Pp
  91 The
  92 .Fa flags
  93 parameter specifies the type of the mapped object, mapping options and
  94 whether modifications made to the mapped copy of the page are private
  95 to the process or are to be shared with other references.
  96 Sharing, mapping type and options are specified in the
  97 .Fa flags
  98 argument by
  99 .Em or Ns 'ing
 100 the following values:
 101 .Pp
 102 .Bl -tag -width MAP_FIXEDX
 103 .It Dv MAP_ANON
 104 Map anonymous memory not associated with any specific file.
 105 The file descriptor used for creating
 106 .Dv MAP_ANON
 107 must be \-1.
 108 The
 109 .Fa offset
 110 parameter is ignored.
 111 .\".It Dv MAP_FILE
 112 .\"Mapped from a regular file or character-special device memory.
 113 .It Dv MAP_FIXED
 114 Do not permit the system to select a different address than the one
 115 specified.
 116 If the specified address cannot be used,
 117 .Fn mmap
 118 will fail.
 119 If MAP_FIXED is specified,
 120 .Fa addr
 121 must be a multiple of the pagesize.
 122 Use of this option is discouraged.
 123 .It Dv MAP_HASSEMAPHORE
 124 Notify the kernel that the region may contain semaphores and that special
 125 handling may be necessary.
 126 .It Dv MAP_INHERIT
 127 Permit regions to be inherited across
 128 .Xr execve 2
 129 system calls.
 130 .It Dv MAP_PRIVATE
 131 Modifications are private.
 132 .It Dv MAP_SHARED
 133 Modifications are shared.
 134 .It Dv MAP_STACK
 135 This option is only available if your system has been compiled with
 136 VM_STACK defined when compiling the kernel. This is the default for
 137 i386 only. Consider adding -DVM_STACK to COPTFLAGS in your /etc/make.conf
 138 to enable this option for other architechures. MAP_STACK implies
 139 MAP_ANON, and
 140 .Fa offset
 141 of 0.
 142 .Fa fd
 143 must be -1 and
 144 .Fa prot
 145 must include at least PROT_READ and PROT_WRITE.  This option creates
 146 a memory region that grows to at most
 147 .Fa len
 148 bytes in size, starting from the stack top and growing down.  The
 149 stack top is the starting address returned by the call, plus
 150 .Fa len
 151 bytes.  The bottom of the stack at maximum growth is the starting
 152 address returned by the call.
 153 .El
 154 .Pp
 155 The
 156 .Xr close 2
 157 function does not unmap pages, see
 158 .Xr munmap 2
 159 for further information.
 160 .Pp
 161 The current design does not allow a process to specify the location of
 162 swap space.
 163 In the future we may define an additional mapping type,
 164 .Dv MAP_SWAP ,
 165 in which
 166 the file descriptor argument specifies a file or device to which swapping
 167 should be done.
 168 .Sh RETURN VALUES
 169 Upon successful completion,
 170 .Fn mmap
 171 returns a pointer to the mapped region.
 172 Otherwise, a value of MAP_FAILED is returned and
 173 .Va errno
 174 is set to indicate the error.
 175 .Sh ERRORS
 176 .Fn Mmap
 177 will fail if:
 178 .Bl -tag -width Er
 179 .It Bq Er EACCES
 180 The flag
 181 .Dv PROT_READ
 182 was specified as part of the
 183 .Fa prot
 184 parameter and
 185 .Fa fd
 186 was not open for reading.
 187 The flags
 188 .Dv MAP_SHARED
 189 and
 190 .Dv PROT_WRITE
 191 were specified as part of the
 192 .Fa flags
 193 and
 194 .Fa prot
 195 parameters and
 196 .Fa fd
 197 was not open for writing.
 198 .It Bq Er EBADF
 199 .Fa Fd
 200 is not a valid open file descriptor.
 201 .It Bq Er EINVAL
 202 .Dv MAP_FIXED
 203 was specified and the
 204 .Fa addr
 205 parameter was not page aligned, or part of the desired address space
 206 resides out of the valid address space for a user process.
 207 .It Bq Er EINVAL
 208 .Fa Len
 209 was negative.
 210 .It Bq Er EINVAL
 211 .Dv MAP_ANON
 212 was specified and the
 213 .Fa fd
 214 parameter was not -1.
 215 .It Bq Er EINVAL
 216 .Dv MAP_ANON
 217 has not been specified and
 218 .Fa fd
 219 did not reference a regular or character special file.
 220 .It Bq Er EINVAL
 221 .Fa Offset
 222 was not page-aligned.  (See BUGS below.)
 223 .It Bq Er ENOMEM
 224 .Dv MAP_FIXED
 225 was specified and the
 226 .Fa addr
 227 parameter wasn't available.
 228 .Dv MAP_ANON
 229 was specified and insufficient memory was available.
 230 .Sh "SEE ALSO"
 231 .Xr madvise 2 ,
 232 .Xr mincore 2 ,
 233 .Xr mlock 2 ,
 234 .Xr mprotect 2 ,
 235 .Xr msync 2 ,
 236 .Xr munlock 2 ,
 237 .Xr munmap 2 ,
 238 .Xr getpagesize 3
 239 .Sh BUGS
 240 .Ar len
 241 is limited to 2GB.  Mmapping slightly more than 2GB doesn't work, but
 242 it is possible to map a window of size (filesize % 2GB) for file sizes
 243 of slightly less than 2G, 4GB, 6GB and 8GB.
 244 .Pp
 245 The limit is imposed for a variety of reasons. Most of them have to do
 246 with
 247 .Tn FreeBSD
 248 not wanting to use 64 bit offsets in the VM system due to
 249 the extreme performance penalty. So
 250 .Tn FreeBSD
 251 uses 32bit page indexes and
 252 this gives
 253 .Tn FreeBSD
 254 a maximum of 8TB filesizes. It's actually bugs in
 255 the filesystem code that causes the limit to be further restricted to
 256 1TB (loss of precision when doing blockno calculations).
 257 .Pp
 258 Another reason for the 2GB limit is that filesystem metadata can
 259 reside at negative offsets.
 260 .Pp
 261 We currently can only deal with page aligned file offsets.