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