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