Home | History | Annotate | Line # | Download | only in uvm
      1 /*	$NetBSD: uvm_pmap.h,v 1.43 2022/08/20 23:08:53 riastradh Exp $	*/
      2 
      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  *	@(#)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 (at) 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 
     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 #include <sys/types.h>
     72 
     73 #include <uvm/uvm_prot.h>
     74 
     75 struct lwp;		/* for pmap_activate()/pmap_deactivate() proto */
     76 struct vm_page;
     77 
     78 struct pmap;
     79 typedef struct pmap *pmap_t;
     80 
     81 /*
     82  * Each machine dependent implementation is expected to
     83  * keep certain statistics.  They may do this anyway they
     84  * so choose, but are expected to return the statistics
     85  * in the following structure.
     86  */
     87 struct pmap_statistics {
     88 	long		resident_count;	/* # of pages mapped (total)*/
     89 	long		wired_count;	/* # of pages wired */
     90 };
     91 typedef struct pmap_statistics	*pmap_statistics_t;
     92 
     93 #ifdef _KERNEL
     94 
     95 extern struct pmap	*const kernel_pmap_ptr;
     96 #define pmap_kernel()	kernel_pmap_ptr
     97 
     98 #endif
     99 
    100 /*
    101  * Cache Type Encodings
    102  */
    103 #define PMAP_CACHE_MASK		0x00000f00
    104 
    105 /* All accesses are uncacheable. No speculative accesses. */
    106 #define PMAP_NOCACHE		0x00000100	/* [BOTH] */
    107 
    108 /* All accesses are uncacheable. No speculative accesses.
    109  * Writes are combined. */
    110 #define PMAP_WRITE_COMBINE	0x00000200	/* [BOTH] */
    111 
    112 /* On reads, cachelines become shared or exclusive if allocated on cache miss.
    113  * On writes, cachelines become modified on a cache miss.  */
    114 #define PMAP_WRITE_BACK		0x00000300	/* [BOTH] */
    115 
    116 /* = PMAP_NOCACHE but overrideable (e.g. on x86 by MTRRs) */
    117 #define PMAP_NOCACHE_OVR	0x00000400	/* [BOTH] */
    118 
    119 #ifdef _KERNEL
    120 #include <machine/pmap.h>
    121 #endif
    122 
    123 /*
    124  * Flags passed to pmap_enter().  Note the bottom 3 bits are VM_PROT_*
    125  * bits, used to indicate the access type that was made (to seed modified
    126  * and referenced information).
    127  *
    128  * Flags marked [PA] are for pmap_kenter_pa() only.  Flags marked [BOTH]
    129  * apply to pmap_kenter_pa() and pmap_enter().  All other flags are valid
    130  * for pmap_enter() only.
    131  */
    132 #define	PMAP_WIRED	0x00000010	/* wired mapping */
    133 #define	PMAP_CANFAIL	0x00000020	/* can fail if resource shortage */
    134 #if defined(PMAP_ENABLE_PMAP_KMPAGE)
    135 #define	PMAP_KMPAGE	0x00000040	/* [PA] page used for kernel memory */
    136 #else
    137 #define	PMAP_KMPAGE	0x00000000
    138 #endif /* PMAP_ENABLE_PMAP_KMPAGE */
    139 
    140 #define	PMAP_MD_MASK	0xff000000	/* [BOTH] Machine-dependent bits */
    141 #define PMAP_PROT_MASK	0x0000000f	/* [BOTH] VM_PROT_* bit mask */
    142 
    143 #ifndef PMAP_EXCLUDE_DECLS	/* Used in Sparc port to virtualize pmap mod */
    144 #ifdef _KERNEL
    145 void		pmap_activate(struct lwp *);
    146 void		pmap_deactivate(struct lwp *);
    147 void		pmap_unwire(pmap_t, vaddr_t);
    148 
    149 #if !defined(pmap_clear_modify)
    150 bool		pmap_clear_modify(struct vm_page *);
    151 #endif
    152 #if !defined(pmap_clear_reference)
    153 bool		pmap_clear_reference(struct vm_page *);
    154 #endif
    155 
    156 #if !defined(pmap_copy)
    157 void		pmap_copy(pmap_t, pmap_t, vaddr_t, vsize_t, vaddr_t);
    158 #endif
    159 #if !defined(pmap_copy_page)
    160 void		pmap_copy_page(paddr_t, paddr_t);
    161 #endif
    162 struct pmap	*pmap_create(void);
    163 void		pmap_destroy(pmap_t);
    164 int		pmap_enter(pmap_t, vaddr_t, paddr_t, vm_prot_t, u_int);
    165 bool		pmap_extract(pmap_t, vaddr_t, paddr_t *);
    166 #if defined(PMAP_GROWKERNEL)
    167 vaddr_t		pmap_growkernel(vaddr_t);
    168 #endif
    169 
    170 void		pmap_init(void);
    171 
    172 #if !defined(pmap_kenter_pa)
    173 void		pmap_kenter_pa(vaddr_t, paddr_t, vm_prot_t, u_int);
    174 #endif
    175 void		pmap_kremove(vaddr_t, vsize_t);
    176 #if !defined(pmap_is_modified)
    177 bool		pmap_is_modified(struct vm_page *);
    178 #endif
    179 #if !defined(pmap_is_referenced)
    180 bool		pmap_is_referenced(struct vm_page *);
    181 #endif
    182 
    183 void		pmap_page_protect(struct vm_page *, vm_prot_t);
    184 void		pmap_pv_protect(paddr_t, vm_prot_t);
    185 
    186 #if !defined(pmap_phys_address)
    187 paddr_t		pmap_phys_address(paddr_t);
    188 #endif
    189 #if !defined(pmap_mmap_flags)
    190 #define		pmap_mmap_flags(x)	0
    191 #endif
    192 void		pmap_protect(pmap_t, vaddr_t, vaddr_t, vm_prot_t);
    193 #if !defined(pmap_reference)
    194 void		pmap_reference(pmap_t);
    195 #endif
    196 #if !defined(pmap_remove)
    197 void		pmap_remove(pmap_t, vaddr_t, vaddr_t);
    198 #endif
    199 bool		pmap_remove_all(struct pmap *);
    200 #if !defined(pmap_update)
    201 void		pmap_update(pmap_t);
    202 #endif
    203 #if !defined(pmap_resident_count)
    204 long		pmap_resident_count(pmap_t);
    205 #endif
    206 #if !defined(pmap_wired_count)
    207 long		pmap_wired_count(pmap_t);
    208 #endif
    209 #if !defined(pmap_zero_page)
    210 void		pmap_zero_page(paddr_t);
    211 #endif
    212 
    213 void		pmap_virtual_space(vaddr_t *, vaddr_t *);
    214 #if defined(PMAP_STEAL_MEMORY)
    215 vaddr_t		pmap_steal_memory(vsize_t, vaddr_t *, vaddr_t *);
    216 #endif
    217 
    218 #if defined(PMAP_FORK)
    219 void		pmap_fork(pmap_t, pmap_t);
    220 #endif
    221 
    222 #if defined(PMAP_DIRECT)
    223 int		pmap_direct_process(paddr_t, voff_t, size_t,
    224 		    int (*)(void *, size_t, void *),
    225 		    void *);
    226 #endif
    227 
    228 #endif	/* kernel*/
    229 #endif  /* PMAP_EXCLUDE_DECLS */
    230 
    231 #endif /* _PMAP_VM_ */
    232