share/man/man9/vm_fault_prefault.9

   1 .\"
   2 .\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd July 21, 2003
  29 .Dt VM_FAULT_PREFAULT 9
  30 .Os
  31 .Sh NAME
  32 .Nm vm_fault_prefault
  33 .Nd cluster page faults into a process's address space
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/pmap.h
  38 .Ft void
  39 .Fn vm_fault_prefault "pmap_t pmap" "vm_offset_t addra" "vm_map_entry_t entry"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vm_fault_prefault
  43 function provides a means of clustering pagefaults into a process's
  44 address space.
  45 It operates upon the physical map
  46 .Fa pmap .
  47 The
  48 .Fa entry
  49 argument specifies the entry to be prefaulted; the
  50 .Fa addra
  51 argument specifies the beginning of the mapping in the process's virtual
  52 address space.
  53 .Pp
  54 It is typically called by
  55 .Fn vm_fault
  56 after the first page fault.
  57 It benefits the
  58 .Xr execve 2
  59 system call by eliminating repetitive calls to
  60 .Fn vm_fault ,
  61 which would otherwise be made to bring the process's executable pages
  62 into physical memory.
  63 .Sh IMPLEMENTATION NOTES
  64 This is a machine-independent function which calls the machine-dependent
  65 .Xr pmap_is_prefaultable 9
  66 helper function to determine if a page may be prefaulted into physical memory.
  67 .Sh SEE ALSO
  68 .Xr execve 2 ,
  69 .Xr pmap_is_prefaultable 9
  70 .Sh AUTHORS
  71 This manual page was written by
  72 .An Bruce M Simpson Aq bms@spc.org .