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