share/man/man9/pmap.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 PMAP 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap
  33 .Nd machine-dependent portion of virtual memory subsystem
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/pmap.h
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 module is the machine-dependent portion of the
  42 .Fx
  43 VM (Virtual Memory) sub-system.
  44 Each function documented herein must have its own
  45 architecture-dependent implementation.
  46 .Pp
  47 The
  48 .Nm
  49 module
  50 is responsible for managing hardware-dependent objects such as page tables,
  51 address maps, TLBs, etc.
  52 .Pp
  53 Machine-dependent code must provide the header file
  54 .In machine/pmap.h .
  55 This file contains the definition of the
  56 .Vt pmap
  57 structure:
  58 .Bd -literal -offset indent
  59 struct pmap {
  60         /* Contents defined by pmap implementation. */
  61 };
  62 typedef struct pmap *pmap_t;
  63 .Ed
  64 .Pp
  65 This header file may also define other data structures used by the
  66 .Nm
  67 implementation.
  68 .Pp
  69 The header file
  70 .In vm/pmap.h
  71 defines a structure for tracking
  72 .Nm
  73 statistics (see below).
  74 This structure is defined as:
  75 .Bd -literal -offset indent
  76 struct pmap_statistics {
  77         long        resident_count; /* number of mapped pages */
  78         long        wired_count;    /* number of wired pages */
  79 };
  80 .Ed
  81 .Pp
  82 The implementation's
  83 .Vt "struct pmap"
  84 must contain an instance of this structure having the name
  85 .Va pm_stats ,
  86 and it must be updated by the implementation after each relevant
  87 .Nm
  88 operation.
  89 .Sh SEE ALSO
  90 .Xr pmap 9 ,
  91 .Xr pmap_activate 9 ,
  92 .Xr pmap_change_wiring 9 ,
  93 .Xr pmap_clear_modify 9 ,
  94 .Xr pmap_clear_reference 9 ,
  95 .Xr pmap_copy 9 ,
  96 .Xr pmap_copy_page 9 ,
  97 .Xr pmap_enter 9 ,
  98 .Xr pmap_extract 9 ,
  99 .Xr pmap_extract_and_hold 9 ,
 100 .Xr pmap_growkernel 9 ,
 101 .Xr pmap_init 9 ,
 102 .Xr pmap_init2 9 ,
 103 .Xr pmap_is_modified 9 ,
 104 .Xr pmap_is_prefaultable 9 ,
 105 .Xr pmap_map 9 ,
 106 .Xr pmap_mincore 9 ,
 107 .Xr pmap_object_init_pt 9 ,
 108 .Xr pmap_page_exists_quick 9 ,
 109 .Xr pmap_page_init 9 ,
 110 .Xr pmap_page_protect 9 ,
 111 .Xr pmap_pinit 9 ,
 112 .Xr pmap_pinit0 9 ,
 113 .Xr pmap_pinit2 9 ,
 114 .Xr pmap_protect 9 ,
 115 .Xr pmap_qenter 9 ,
 116 .Xr pmap_qremove 9 ,
 117 .Xr pmap_release 9 ,
 118 .Xr pmap_remove 9 ,
 119 .Xr pmap_remove_all 9 ,
 120 .Xr pmap_remove_pages 9 ,
 121 .Xr pmap_resident_count 9 ,
 122 .Xr pmap_ts_modified 9 ,
 123 .Xr pmap_wired_count 9 ,
 124 .Xr pmap_zero_area 9 ,
 125 .Xr pmap_zero_idle 9 ,
 126 .Xr pmap_zero_page 9 ,
 127 .Xr vm_map 9
 128 .Sh AUTHORS
 129 This manual page was written by
 130 .An Bruce M Simpson Aq bms@spc.org .