1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)mmap.2 8.4 (Berkeley) 5/11/95
29 .\" $FreeBSD: src/lib/libc/sys/mmap.2,v 1.22.2.12 2002/02/27 03:40:13 dd Exp $
36 .Nd allocate memory, or map files or devices into memory
43 .Fn mmap "void *addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
47 function causes the pages starting at
49 and continuing for at most
51 bytes to be mapped from the object described by
53 starting at byte offset
57 is not a multiple of the pagesize, the mapped region may extend past the
59 Any such extension beyond the end of the mapped object will be zero-filled.
63 is non-zero, it is used as a hint to the system.
64 (As a convenience to the system, the actual address of the region may differ
65 from the address supplied.)
68 is zero, an address will be selected by the system.
69 The actual starting address of the region is returned.
72 deletes any previous mapping in the allocated address range.
74 The protections (region accessibility) are specified in the
80 .Bl -tag -width PROT_WRITE -compact
82 Pages may not be accessed.
88 Pages may be executed.
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
100 the following values:
101 .Bl -tag -width MAP_HASSEMAPHORE
103 Map anonymous memory not associated with any specific file.
104 The file descriptor used for creating
109 parameter is ignored.
111 This flag is an alias for
113 and is provided for compatibility.
115 .\"Mapped from a regular file or character-special device memory.
117 Do not permit the system to select a different address than the one
119 If the specified address contains other mappings those mappings will
121 If the specified address cannot otherwise be used,
128 must be a multiple of the pagesize.
130 Try to do a fixed mapping but fail if another mapping already exists in
131 the space instead of overwriting the mapping.
133 When used with MAP_STACK this flag allows one MAP_STACK mapping to be
134 made within another (typically the master user stack), as long as
135 no pages have been faulted in the area requested.
136 .It Dv MAP_HASSEMAPHORE
137 Notify the kernel that the region may contain semaphores and that special
138 handling may be necessary.
140 Region is not included in a core file.
142 Causes data dirtied via this VM map to be flushed to physical media
143 only when necessary (usually by the pager) rather than gratuitously.
144 Typically this prevents the update daemons from flushing pages dirtied
145 through such maps and thus allows efficient sharing of memory across
146 unassociated processes using a file-backed shared memory map. Without
147 this option any VM pages you dirty may be flushed to disk every so often
148 (every 30-60 seconds usually) which can create performance problems if you
149 do not need that to occur (such as when you are using shared file-backed
150 mmap regions for IPC purposes). Note that VM/filesystem coherency is
151 maintained whether you use
153 or not. This option is not portable
156 platforms (yet), though some may implement the same behavior
160 Extending a file with
162 thus creating a big hole, and then filling the hole by modifying a shared
164 can lead to severe file fragmentation.
165 In order to avoid such fragmentation you should always pre-allocate the
166 file's backing store by
168 zero's into the newly extended area prior to modifying the area via your
170 The fragmentation problem is especially sensitive to
172 pages, because pages may be flushed to disk in a totally random order.
174 The same applies when using
176 to implement a file-based shared memory store.
177 It is recommended that you create the backing store by
179 zero's to the backing file rather than
182 You can test file fragmentation by observing the KB/t (kilobytes per
183 transfer) results from an
185 while reading a large file sequentially, e.g. using
186 .Dq Li dd if=filename of=/dev/null bs=32k .
190 function will flush all dirty data and metadata associated with a file,
191 including dirty NOSYNC VM data, to physical media. The
195 system call generally do not flush dirty NOSYNC VM data.
198 system call is obsolete since
200 implements a coherent filesystem buffer cache. However, it may be
201 used to associate dirty VM pages with filesystem buffers and thus cause
202 them to be flushed to physical media sooner rather than later.
204 Modifications are private.
206 Modifications are shared.
208 Map the area as a stack.
216 should include at least
221 a memory region that grows to at most
223 bytes in size, starting from the stack top and growing down. The
224 stack top is the starting address returned by the call, plus
227 The bottom of the stack at maximum growth is the starting
228 address returned by the call.
230 The entire area is reserved from the point of view of other
232 calls, even if not faulted in yet.
234 WARNING. We currently allow
236 mappings to provide a hint that points within an existing
238 mapping's space, and this will succeed as long as no page have been
239 faulted in the area specified, but this behavior is no longer supported
240 unless you also specify the
248 is used, you cannot count on the returned address matching the hint
250 .It Dv MAP_VPAGETABLE
251 Memory accessed via this map is not linearly mapped and will be governed
252 by a virtual page table. The base address of the virtual page table may
257 Virtual page tables work with anonymous memory but there
258 is no way to populate the page table so for all intents and purposes
260 can only be used when mapping file descriptors. Since the kernel will
261 update the VPTE_M bit in the virtual page table, the mapping must R+W
262 even though actual access to the memory will be properly governed by
263 the virtual page table.
265 Addressable backing store is limited by the range supported in the virtual
266 page table entries. The kernel may implement a page table abstraction capable
267 of addressing a larger range within the backing store then could otherwise
268 be mapped into memory.
273 function does not unmap pages, see
275 for further information.
277 The current design does not allow a process to specify the location of
279 In the future we may define an additional mapping type,
282 the file descriptor argument specifies a file or device to which swapping
285 Upon successful completion,
287 returns a pointer to the mapped region.
288 Otherwise, a value of
292 is set to indicate the error.
300 was specified as part of the
304 was not open for reading.
309 were specified as part of the
315 was not open for writing.
318 is not a valid open file descriptor.
321 was specified and the
323 parameter was not page aligned, or part of the desired address space
324 resides out of the valid address space for a user process.
330 was specified and the
332 parameter was not -1.
335 has not been specified and
337 did not reference a regular or character special file.
340 was not page-aligned.
346 was specified and the
348 parameter wasn't available.
350 was specified and insufficient memory was available.
351 The system has reached the per-process mmap limit specified in the