static/freebsd/man9/vm_map_inherit.9 4.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

<table class="head">
  <tr>
    <td class="head-ltitle">VM_MAP_INHERIT(9)</td>
    <td class="head-vol">Kernel Developer's Manual</td>
    <td class="head-rtitle">VM_MAP_INHERIT(9)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">vm_map_inherit</code> &#x2014;
    <span class="Nd">set fork inheritance flags for a range within a
  map</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">sys/param.h</a>&gt;</code>
  <br/>
  <code class="In">#include &lt;<a class="In">vm/vm.h</a>&gt;</code>
  <br/>
  <code class="In">#include &lt;<a class="In">vm/vm_map.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">vm_map_inherit</code>(<var class="Fa">vm_map_t map</var>,
    <var class="Fa">vm_offset_t start</var>, <var class="Fa">vm_offset_t
    end</var>, <var class="Fa">vm_inherit_t new_inheritance</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#vm_map_inherit"><code class="Fn" id="vm_map_inherit">vm_map_inherit</code></a>()
    function sets the inheritance flags for the range
    <var class="Fa">start</var> to <var class="Fa">end</var> within the target
    <var class="Fa">map</var> to the value
    <var class="Fa">new_inheritance</var>.</p>
<p class="Pp">The <var class="Fa">new_inheritance</var> flag must have one of
    the values <code class="Dv">VM_INHERIT_NONE</code>,
    <code class="Dv">VM_INHERIT_COPY</code>, or
    <code class="Dv">VM_INHERIT_SHARE</code>. This affects how the map will be
    shared with child maps when the associated process forks.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="IMPLEMENTATION_NOTES"><a class="permalink" href="#IMPLEMENTATION_NOTES">IMPLEMENTATION
  NOTES</a></h1>
<p class="Pp">The <code class="Fn">vm_map_inherit</code>() function obtains a
    lock on the <var class="Fa">map</var> using <a class="Xr">vm_map_lock(9)</a>
    for the duration of the function.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">The <code class="Fn">vm_map_inherit</code>() function returns
    <code class="Dv">KERN_SUCCESS</code> if the inheritance flags could be set.
    Otherwise, if the provided flags were invalid,
    <code class="Dv">KERN_INVALID_ARGUMENT</code> will be returned.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">fork(2)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">This manual page was written by <span class="An">Bruce M
    Simpson</span>
    &lt;<a class="Mt" href="mailto:bms@spc.org">bms@spc.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">July 19, 2003</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>