pmap.h revision 1.19 1 /* $NetBSD: pmap.h,v 1.19 2020/12/21 08:41:38 skrll Exp $ */
2
3 /*
4 * Copyright (c) 1992, 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 * Ralph Campbell.
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/10/93
35 */
36
37 /*
38 * Copyright (c) 1987 Carnegie-Mellon University
39 *
40 * This code is derived from software contributed to Berkeley by
41 * Ralph Campbell.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by the University of
54 * California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
58 *
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 *
71 * @(#)pmap.h 8.1 (Berkeley) 6/10/93
72 */
73
74 #ifndef _UVM_PMAP_PMAP_H_
75 #define _UVM_PMAP_PMAP_H_
76
77 #include <uvm/uvm_stat.h>
78 #ifdef UVMHIST
79 UVMHIST_DECL(pmapexechist);
80 UVMHIST_DECL(pmaphist);
81 UVMHIST_DECL(pmapsegtabhist);
82 #endif
83
84 /*
85 * The user address space is mapped using a two level structure where
86 * virtual address bits 31..22 are used to index into a segment table which
87 * points to a page worth of PTEs (4096 page can hold 1024 PTEs).
88 * Bits 21..12 are then used to index a PTE which describes a page within
89 * a segment.
90 */
91
92 #define pmap_trunc_seg(x) ((vaddr_t)(x) & ~SEGOFSET)
93 #define pmap_round_seg(x) (((vaddr_t)(x) + SEGOFSET) & ~SEGOFSET)
94
95 /*
96 * Each seg_tab point an array of pt_entry [NPTEPG]
97 */
98 typedef union pmap_segtab {
99 union pmap_segtab * seg_seg[PMAP_SEGTABSIZE];
100 pt_entry_t * seg_tab[PMAP_SEGTABSIZE];
101 } pmap_segtab_t;
102
103 #ifdef _KERNEL
104 struct pmap;
105 typedef bool (*pte_callback_t)(struct pmap *, vaddr_t, vaddr_t,
106 pt_entry_t *, uintptr_t);
107
108 /*
109 * Common part of the bootstraping the system enough to run with
110 * virtual memory.
111 */
112 void pmap_bootstrap_common(void);
113 pt_entry_t *pmap_pte_lookup(struct pmap *, vaddr_t);
114 pt_entry_t *pmap_pte_reserve(struct pmap *, vaddr_t, int);
115 void pmap_pte_process(struct pmap *, vaddr_t, vaddr_t, pte_callback_t,
116 uintptr_t);
117 void pmap_segtab_activate(struct pmap *, struct lwp *);
118 void pmap_segtab_deactivate(struct pmap *);
119 void pmap_segtab_init(struct pmap *);
120 void pmap_segtab_destroy(struct pmap *, pte_callback_t, uintptr_t);
121 extern kmutex_t pmap_segtab_lock;
122 #endif /* _KERNEL */
123
124 #ifdef MULTIPROCESSOR
125 #include <sys/kcpuset.h>
126 #endif
127 #include <uvm/pmap/pmap_tlb.h>
128
129 /*
130 * Machine dependent pmap structure.
131 */
132 struct pmap {
133 #ifdef MULTIPROCESSOR
134 kcpuset_t *pm_active; /* pmap was active on ... */
135 kcpuset_t *pm_onproc; /* pmap is active on ... */
136 volatile u_int pm_shootdown_pending;
137 #endif
138 pmap_segtab_t * pm_segtab; /* pointers to pages of PTEs */
139 u_int pm_count; /* pmap reference count */
140 u_int pm_flags;
141 #define PMAP_DEFERRED_ACTIVATE __BIT(0)
142 struct pmap_statistics pm_stats; /* pmap statistics */
143 vaddr_t pm_minaddr;
144 vaddr_t pm_maxaddr;
145 #ifdef __HAVE_PMAP_MD
146 struct pmap_md pm_md;
147 #endif
148 struct pmap_asid_info pm_pai[1];
149 };
150
151 #ifdef _KERNEL
152 struct pmap_kernel {
153 struct pmap kernel_pmap;
154 #if defined(MULTIPROCESSOR) && PMAP_TLB_MAX > 1
155 struct pmap_asid_info kernel_pai[PMAP_TLB_MAX-1];
156 #endif
157 };
158
159 struct pmap_limits {
160 paddr_t avail_start;
161 paddr_t avail_end;
162 vaddr_t virtual_start;
163 vaddr_t virtual_end;
164 };
165
166 /*
167 * Initialize the kernel pmap.
168 */
169 #ifdef MULTIPROCESSOR
170 #define PMAP_SIZE offsetof(struct pmap, pm_pai[PMAP_TLB_MAX])
171 #else
172 #define PMAP_SIZE sizeof(struct pmap)
173 #endif
174
175 /*
176 * The pools from which pmap structures and sub-structures are allocated.
177 */
178 extern struct pool pmap_pmap_pool;
179 extern struct pool pmap_pv_pool;
180 extern struct pool_allocator pmap_pv_page_allocator;
181
182 extern struct pmap_kernel kernel_pmap_store;
183 extern struct pmap_limits pmap_limits;
184
185 extern u_int pmap_page_colormask;
186
187 extern pmap_segtab_t pmap_kern_segtab;
188
189 #define pmap_wired_count(pmap) ((pmap)->pm_stats.wired_count)
190 #define pmap_resident_count(pmap) ((pmap)->pm_stats.resident_count)
191
192 bool pmap_remove_all(pmap_t);
193 void pmap_set_modified(paddr_t);
194 bool pmap_page_clear_attributes(struct vm_page_md *, u_int);
195 void pmap_page_set_attributes(struct vm_page_md *, u_int);
196 void pmap_pvlist_lock_init(size_t);
197 #ifdef PMAP_VIRTUAL_CACHE_ALIASES
198 void pmap_page_cache(struct vm_page_md *, bool);
199 #endif
200
201 #ifdef __HAVE_PMAP_PV_TRACK
202 void pmap_pv_protect(paddr_t, vm_prot_t);
203 #endif
204
205 #define PMAP_WB 0
206 #define PMAP_WBINV 1
207 #define PMAP_INV 2
208
209 //uint16_t pmap_pvlist_lock(struct vm_page_md *, bool);
210 kmutex_t *pmap_pvlist_lock_addr(struct vm_page_md *);
211
212 #define PMAP_STEAL_MEMORY /* enable pmap_steal_memory() */
213 #define PMAP_GROWKERNEL /* enable pmap_growkernel() */
214
215 /*
216 * Alternate mapping hooks for pool pages. Avoids thrashing the TLB.
217 */
218 vaddr_t pmap_map_poolpage(paddr_t);
219 paddr_t pmap_unmap_poolpage(vaddr_t);
220 struct vm_page *pmap_md_alloc_poolpage(int);
221 #define PMAP_ALLOC_POOLPAGE(flags) pmap_md_alloc_poolpage(flags)
222 #define PMAP_MAP_POOLPAGE(pa) pmap_map_poolpage(pa)
223 #define PMAP_UNMAP_POOLPAGE(va) pmap_unmap_poolpage(va)
224
225 #define PMAP_COUNT(name) (pmap_evcnt_##name.ev_count++ + 0)
226 #define PMAP_COUNTER(name, desc) \
227 struct evcnt pmap_evcnt_##name = \
228 EVCNT_INITIALIZER(EVCNT_TYPE_MISC, NULL, "pmap", desc); \
229 EVCNT_ATTACH_STATIC(pmap_evcnt_##name)
230
231 #endif /* _KERNEL */
232 #endif /* _UVM_PMAP_PMAP_H_ */
233