summaryrefslogtreecommitdiff
path: root/static/freebsd/man9/vm_fault_prefault.9 4.html
blob: 5f73900c9670f5e76fd57a6e1da5642e32e21345 (plain)
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
<table class="head">
  <tr>
    <td class="head-ltitle">VM_FAULT_PREFAULT(9)</td>
    <td class="head-vol">Kernel Developer's Manual</td>
    <td class="head-rtitle">VM_FAULT_PREFAULT(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_fault_prefault</code> &#x2014;
    <span class="Nd">cluster page faults into a process's address
  space</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/pmap.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">void</var>
  <br/>
  <code class="Fn">vm_fault_prefault</code>(<var class="Fa" style="white-space: nowrap;">pmap_t
    pmap</var>, <var class="Fa" style="white-space: nowrap;">vm_offset_t
    addra</var>, <var class="Fa" style="white-space: nowrap;">vm_map_entry_t
    entry</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_fault_prefault"><code class="Fn" id="vm_fault_prefault">vm_fault_prefault</code></a>()
    function provides a means of clustering pagefaults into a process's address
    space. It operates upon the physical map <var class="Fa">pmap</var>. The
    <var class="Fa">entry</var> argument specifies the entry to be prefaulted;
    the <var class="Fa">addra</var> argument specifies the beginning of the
    mapping in the process's virtual address space.</p>
<p class="Pp" id="vm_fault">It is typically called by
    <a class="permalink" href="#vm_fault"><code class="Fn">vm_fault</code></a>()
    after the first page fault. It benefits the <a class="Xr">execve(2)</a>
    system call by eliminating repetitive calls to
    <code class="Fn">vm_fault</code>(), which would otherwise be made to bring
    the process's executable pages into physical memory.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="IMPLEMENTATION_NOTES"><a class="permalink" href="#IMPLEMENTATION_NOTES">IMPLEMENTATION
  NOTES</a></h1>
<p class="Pp">This is a machine-independent function which calls the
    machine-dependent <a class="Xr">pmap_is_prefaultable(9)</a> helper function
    to determine if a page may be prefaulted into physical memory.</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">execve(2)</a>,
    <a class="Xr">pmap_is_prefaultable(9)</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 21, 2003</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>