sys/vm/pmap.h

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