1 /*-
2  * Copyright (c) 1991 Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * the Systems Programming Group of the University of Utah Computer
7  * Science Department and William Jolitz of UUNET Technologies Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Derived from hp300 version by Mike Hibler, this version by William
34  * Jolitz uses a recursive map [a pde points to the page directory] to
35  * map the page tables using the pagetables themselves. This is done to
36  * reduce the impact on kernel virtual memory for lots of sparse address
37  * space, and to reduce the cost of memory to each process.
38  *
39  *	from: hp300: @(#)pmap.h 7.2 (Berkeley) 12/16/90
40  *	from: @(#)pmap.h	7.4 (Berkeley) 5/12/91
41  *	from: src/sys/i386/include/pmap.h,v 1.65.2.2 2000/11/30 01:54:42 peter
42  *	JNPR: pmap.h,v 1.7.2.1 2007/09/10 07:44:12 girish
43  *      $FreeBSD: stable/9/sys/mips/include/pmap.h 240760 2012-09-20 18:21:29Z alc $
44  */
45 
46 #ifndef _MACHINE_PMAP_H_
47 #define	_MACHINE_PMAP_H_
48 
49 #include <machine/vmparam.h>
50 #include <machine/pte.h>
51 
52 #if defined(__mips_n32) || defined(__mips_n64) /* PHYSADDR_64BIT */
53 #define	NKPT		256	/* mem > 4G, vm_page_startup needs more KPTs */
54 #else
55 #define	NKPT		120	/* actual number of kernel page tables */
56 #endif
57 
58 #ifndef LOCORE
59 
60 #include <sys/queue.h>
61 #include <sys/_cpuset.h>
62 #include <sys/_lock.h>
63 #include <sys/_mutex.h>
64 
65 /*
66  * Pmap stuff
67  */
68 struct pv_entry;
69 
70 struct md_page {
71 	int pv_list_count;
72 	int pv_flags;
73 	TAILQ_HEAD(, pv_entry) pv_list;
74 };
75 
76 #define	PV_TABLE_MOD		0x01	/* modified */
77 #define	PV_TABLE_REF		0x02	/* referenced */
78 
79 #define	ASID_BITS		8
80 #define	ASIDGEN_BITS		(32 - ASID_BITS)
81 #define	ASIDGEN_MASK		((1 << ASIDGEN_BITS) - 1)
82 
83 struct pmap {
84 	pd_entry_t *pm_segtab;	/* KVA of segment table */
85 	TAILQ_HEAD(, pv_entry) pm_pvlist;	/* list of mappings in
86 						 * pmap */
87 	cpuset_t	pm_active;		/* active on cpus */
88 	struct {
89 		u_int32_t asid:ASID_BITS;	/* TLB address space tag */
90 		u_int32_t gen:ASIDGEN_BITS;	/* its generation number */
91 	}      pm_asid[MAXSMPCPU];
92 	struct pmap_statistics pm_stats;	/* pmap statistics */
93 	struct vm_page *pm_ptphint;	/* pmap ptp hint */
94 	struct mtx pm_mtx;
95 };
96 
97 typedef struct pmap *pmap_t;
98 
99 #ifdef	_KERNEL
100 
101 pt_entry_t *pmap_pte(pmap_t, vm_offset_t);
102 vm_offset_t pmap_kextract(vm_offset_t va);
103 
104 #define	vtophys(va)	pmap_kextract(((vm_offset_t) (va)))
105 #define	pmap_asid(pmap)	(pmap)->pm_asid[PCPU_GET(cpuid)].asid
106 
107 extern struct pmap	kernel_pmap_store;
108 #define kernel_pmap	(&kernel_pmap_store)
109 
110 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
111 #define	PMAP_LOCK_ASSERT(pmap, type)	mtx_assert(&(pmap)->pm_mtx, (type))
112 #define	PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
113 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
114 				    NULL, MTX_DEF)
115 #define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
116 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
117 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
118 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
119 
120 /*
121  * For each vm_page_t, there is a list of all currently valid virtual
122  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
123  */
124 typedef struct pv_entry {
125 	pmap_t pv_pmap;		/* pmap where mapping lies */
126 	vm_offset_t pv_va;	/* virtual address for mapping */
127 	TAILQ_ENTRY(pv_entry) pv_list;
128 	TAILQ_ENTRY(pv_entry) pv_plist;
129 	vm_page_t pv_ptem;	/* VM page for pte */
130 }       *pv_entry_t;
131 
132 /*
133  * physmem_desc[] is a superset of phys_avail[] and describes all the
134  * memory present in the system.
135  *
136  * phys_avail[] is similar but does not include the memory stolen by
137  * pmap_steal_memory().
138  *
139  * Each memory region is described by a pair of elements in the array
140  * so we can describe up to (PHYS_AVAIL_ENTRIES / 2) distinct memory
141  * regions.
142  */
143 #define	PHYS_AVAIL_ENTRIES	10
144 extern vm_paddr_t phys_avail[PHYS_AVAIL_ENTRIES + 2];
145 extern vm_paddr_t physmem_desc[PHYS_AVAIL_ENTRIES + 2];
146 
147 extern vm_offset_t virtual_avail;
148 extern vm_offset_t virtual_end;
149 
150 extern vm_paddr_t dump_avail[PHYS_AVAIL_ENTRIES + 2];
151 
152 #define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
153 #define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
154 #define	pmap_page_is_write_mapped(m)	(((m)->aflags & PGA_WRITEABLE) != 0)
155 #define	pmap_page_set_memattr(m, ma)	(void)0
156 
157 void pmap_bootstrap(void);
158 void *pmap_mapdev(vm_paddr_t, vm_size_t);
159 void pmap_unmapdev(vm_offset_t, vm_size_t);
160 vm_offset_t pmap_steal_memory(vm_size_t size);
161 int page_is_managed(vm_paddr_t pa);
162 void pmap_kenter(vm_offset_t va, vm_paddr_t pa);
163 void pmap_kenter_attr(vm_offset_t va, vm_paddr_t pa, int attr);
164 void pmap_kremove(vm_offset_t va);
165 void *pmap_kenter_temporary(vm_paddr_t pa, int i);
166 void pmap_kenter_temporary_free(vm_paddr_t pa);
167 int pmap_compute_pages_to_dump(void);
168 void pmap_flush_pvcache(vm_page_t m);
169 int pmap_emulate_modified(pmap_t pmap, vm_offset_t va);
170 void pmap_grow_direct_page_cache(void);
171 vm_page_t pmap_alloc_direct_page(unsigned int index, int req);
172 
173 #endif				/* _KERNEL */
174 
175 #endif				/* !LOCORE */
176 
177 #endif				/* !_MACHINE_PMAP_H_ */
178