pmap.h revision 324400
1/*- 2 * Copyright (c) 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * The Mach Operating System project at Carnegie-Mellon University. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 4. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * from: @(#)pmap.h 8.1 (Berkeley) 6/11/93 33 * 34 * 35 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 36 * All rights reserved. 37 * 38 * Author: Avadis Tevanian, Jr. 39 * 40 * Permission to use, copy, modify and distribute this software and 41 * its documentation is hereby granted, provided that both the copyright 42 * notice and this permission notice appear in all copies of the 43 * software, derivative works or modified versions, and any portions 44 * thereof, and that both notices appear in supporting documentation. 45 * 46 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 47 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 48 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 49 * 50 * Carnegie Mellon requests users of this software to return to 51 * 52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 53 * School of Computer Science 54 * Carnegie Mellon University 55 * Pittsburgh PA 15213-3890 56 * 57 * any improvements or extensions that they make and grant Carnegie the 58 * rights to redistribute these changes. 59 * 60 * $FreeBSD: stable/11/sys/vm/pmap.h 324400 2017-10-07 21:13:54Z alc $ 61 */ 62 63/* 64 * Machine address mapping definitions -- machine-independent 65 * section. [For machine-dependent section, see "machine/pmap.h".] 66 */ 67 68#ifndef _PMAP_VM_ 69#define _PMAP_VM_ 70/* 71 * Each machine dependent implementation is expected to 72 * keep certain statistics. They may do this anyway they 73 * so choose, but are expected to return the statistics 74 * in the following structure. 75 */ 76struct pmap_statistics { 77 long resident_count; /* # of pages mapped (total) */ 78 long wired_count; /* # of pages wired */ 79}; 80typedef struct pmap_statistics *pmap_statistics_t; 81 82/* 83 * Each machine-dependent implementation is required to provide: 84 * 85 * vm_memattr_t pmap_page_get_memattr(vm_page_t); 86 * boolean_t pmap_page_is_mapped(vm_page_t); 87 * boolean_t pmap_page_is_write_mapped(vm_page_t); 88 * void pmap_page_set_memattr(vm_page_t, vm_memattr_t); 89 */ 90#include <machine/pmap.h> 91 92#ifdef _KERNEL 93struct thread; 94 95/* 96 * Updates to kernel_vm_end are synchronized by the kernel_map's system mutex. 97 */ 98extern vm_offset_t kernel_vm_end; 99 100/* 101 * Flags for pmap_enter(). The bits in the low-order byte are reserved 102 * for the protection code (vm_prot_t) that describes the fault type. 103 * Bits 24 through 31 are reserved for the pmap's internal use. 104 */ 105#define PMAP_ENTER_NOSLEEP 0x00000100 106#define PMAP_ENTER_WIRED 0x00000200 107#define PMAP_ENTER_RESERVED 0xFF000000 108 109/* 110 * Define the maximum number of machine-dependent reference bits that are 111 * cleared by a call to pmap_ts_referenced(). This limit serves two purposes. 112 * First, it bounds the cost of reference bit maintenance on widely shared 113 * pages. Second, it prevents numeric overflow during maintenance of a 114 * widely shared page's "act_count" field. An overflow could result in the 115 * premature deactivation of the page. 116 */ 117#define PMAP_TS_REFERENCED_MAX 5 118 119void pmap_activate(struct thread *td); 120void pmap_advise(pmap_t pmap, vm_offset_t sva, vm_offset_t eva, 121 int advice); 122void pmap_align_superpage(vm_object_t, vm_ooffset_t, vm_offset_t *, 123 vm_size_t); 124void pmap_clear_modify(vm_page_t m); 125void pmap_copy(pmap_t, pmap_t, vm_offset_t, vm_size_t, vm_offset_t); 126void pmap_copy_page(vm_page_t, vm_page_t); 127void pmap_copy_pages(vm_page_t ma[], vm_offset_t a_offset, 128 vm_page_t mb[], vm_offset_t b_offset, int xfersize); 129int pmap_enter(pmap_t pmap, vm_offset_t va, vm_page_t m, 130 vm_prot_t prot, u_int flags, int8_t psind); 131void pmap_enter_object(pmap_t pmap, vm_offset_t start, 132 vm_offset_t end, vm_page_t m_start, vm_prot_t prot); 133void pmap_enter_quick(pmap_t pmap, vm_offset_t va, vm_page_t m, 134 vm_prot_t prot); 135vm_paddr_t pmap_extract(pmap_t pmap, vm_offset_t va); 136vm_page_t pmap_extract_and_hold(pmap_t pmap, vm_offset_t va, 137 vm_prot_t prot); 138void pmap_growkernel(vm_offset_t); 139void pmap_init(void); 140boolean_t pmap_is_modified(vm_page_t m); 141boolean_t pmap_is_prefaultable(pmap_t pmap, vm_offset_t va); 142boolean_t pmap_is_referenced(vm_page_t m); 143vm_offset_t pmap_map(vm_offset_t *, vm_paddr_t, vm_paddr_t, int); 144int pmap_mincore(pmap_t pmap, vm_offset_t addr, 145 vm_paddr_t *locked_pa); 146void pmap_object_init_pt(pmap_t pmap, vm_offset_t addr, 147 vm_object_t object, vm_pindex_t pindex, vm_size_t size); 148boolean_t pmap_page_exists_quick(pmap_t pmap, vm_page_t m); 149void pmap_page_init(vm_page_t m); 150int pmap_page_wired_mappings(vm_page_t m); 151int pmap_pinit(pmap_t); 152void pmap_pinit0(pmap_t); 153void pmap_protect(pmap_t, vm_offset_t, vm_offset_t, vm_prot_t); 154void pmap_qenter(vm_offset_t, vm_page_t *, int); 155void pmap_qremove(vm_offset_t, int); 156vm_offset_t pmap_quick_enter_page(vm_page_t); 157void pmap_quick_remove_page(vm_offset_t); 158void pmap_release(pmap_t); 159void pmap_remove(pmap_t, vm_offset_t, vm_offset_t); 160void pmap_remove_all(vm_page_t m); 161void pmap_remove_pages(pmap_t); 162void pmap_remove_write(vm_page_t m); 163void pmap_sync_icache(pmap_t, vm_offset_t, vm_size_t); 164boolean_t pmap_ts_referenced(vm_page_t m); 165void pmap_unwire(pmap_t pmap, vm_offset_t start, vm_offset_t end); 166void pmap_zero_page(vm_page_t); 167void pmap_zero_page_area(vm_page_t, int off, int size); 168void pmap_zero_page_idle(vm_page_t); 169 170#define pmap_resident_count(pm) ((pm)->pm_stats.resident_count) 171#define pmap_wired_count(pm) ((pm)->pm_stats.wired_count) 172 173#endif /* _KERNEL */ 174#endif /* _PMAP_VM_ */ 175