1/* $NetBSD: pmap.h,v 1.61 2016/11/08 03:05:36 christos Exp $ */
2
3/*
4 * Copyright (c) 1997 Charles D. Cranor and Washington University.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28/*
29 * Copyright (c) 2001 Wasabi Systems, Inc.
30 * All rights reserved.
31 *
32 * Written by Frank van der Linden for Wasabi Systems, Inc.
33 *
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
36 * are met:
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. All advertising materials mentioning features or use of this software
43 * must display the following acknowledgement:
44 * This product includes software developed for the NetBSD Project by
45 * Wasabi Systems, Inc.
46 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
47 * or promote products derived from this software without specific prior
48 * written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
52 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
53 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
54 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
55 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
56 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
57 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
58 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
59 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
60 * POSSIBILITY OF SUCH DAMAGE.
61 */
62
63/*
64 * pmap.h: see pmap.c for the history of this pmap module.
65 */
66
67#ifndef _X86_PMAP_H_
68#define _X86_PMAP_H_
69
70/*
71 * pl*_pi: index in the ptp page for a pde mapping a VA.
72 * (pl*_i below is the index in the virtual array of all pdes per level)
73 */
74#define pl1_pi(VA) (((VA_SIGN_POS(VA)) & L1_MASK) >> L1_SHIFT)
75#define pl2_pi(VA) (((VA_SIGN_POS(VA)) & L2_MASK) >> L2_SHIFT)
76#define pl3_pi(VA) (((VA_SIGN_POS(VA)) & L3_MASK) >> L3_SHIFT)
77#define pl4_pi(VA) (((VA_SIGN_POS(VA)) & L4_MASK) >> L4_SHIFT)
78
79/*
80 * pl*_i: generate index into pde/pte arrays in virtual space
81 *
82 * pl_i(va, X) == plX_i(va) <= pl_i_roundup(va, X)
83 */
84#define pl1_i(VA) (((VA_SIGN_POS(VA)) & L1_FRAME) >> L1_SHIFT)
85#define pl2_i(VA) (((VA_SIGN_POS(VA)) & L2_FRAME) >> L2_SHIFT)
86#define pl3_i(VA) (((VA_SIGN_POS(VA)) & L3_FRAME) >> L3_SHIFT)
87#define pl4_i(VA) (((VA_SIGN_POS(VA)) & L4_FRAME) >> L4_SHIFT)
88#define pl_i(va, lvl) \
89 (((VA_SIGN_POS(va)) & ptp_masks[(lvl)-1]) >> ptp_shifts[(lvl)-1])
90
91#define pl_i_roundup(va, lvl) pl_i((va)+ ~ptp_masks[(lvl)-1], (lvl))
92
93/*
94 * PTP macros:
95 * a PTP's index is the PD index of the PDE that points to it
96 * a PTP's offset is the byte-offset in the PTE space that this PTP is at
97 * a PTP's VA is the first VA mapped by that PTP
98 */
99
100#define ptp_va2o(va, lvl) (pl_i(va, (lvl)+1) * PAGE_SIZE)
101
102/* size of a PDP: usually one page, except for PAE */
103#ifdef PAE
104#define PDP_SIZE 4
105#else
106#define PDP_SIZE 1
107#endif
108
109
110#if defined(_KERNEL)
111#include <sys/kcpuset.h>
112#include <uvm/pmap/pmap_pvt.h>
113
114/*
115 * pmap data structures: see pmap.c for details of locking.
116 */
117
118/*
119 * we maintain a list of all non-kernel pmaps
120 */
121
122LIST_HEAD(pmap_head, pmap); /* struct pmap_head: head of a pmap list */
123
124/*
125 * linked list of all non-kernel pmaps
126 */
127extern struct pmap_head pmaps;
128extern kmutex_t pmaps_lock; /* protects pmaps */
129
130/*
131 * pool_cache(9) that PDPs are allocated from
132 */
133extern struct pool_cache pmap_pdp_cache;
134
135/*
136 * the pmap structure
137 *
138 * note that the pm_obj contains the lock pointer, the reference count,
139 * page list, and number of PTPs within the pmap.
140 *
141 * pm_lock is the same as the lock for vm object 0. Changes to
142 * the other objects may only be made if that lock has been taken
143 * (the other object locks are only used when uvm_pagealloc is called)
144 */
145
146struct pmap {
147 struct uvm_object pm_obj[PTP_LEVELS-1]; /* objects for lvl >= 1) */
148#define pm_lock pm_obj[0].vmobjlock
149 kmutex_t pm_obj_lock[PTP_LEVELS-1]; /* locks for pm_objs */
150 LIST_ENTRY(pmap) pm_list; /* list (lck by pm_list lock) */
151 pd_entry_t *pm_pdir; /* VA of PD (lck by object lock) */
152 paddr_t pm_pdirpa[PDP_SIZE]; /* PA of PDs (read-only after create) */
153 struct vm_page *pm_ptphint[PTP_LEVELS-1];
154 /* pointer to a PTP in our pmap */
155 struct pmap_statistics pm_stats; /* pmap stats (lck by object lock) */
156
157#if !defined(__x86_64__)
158 vaddr_t pm_hiexec; /* highest executable mapping */
159#endif /* !defined(__x86_64__) */
160 int pm_flags; /* see below */
161
162 union descriptor *pm_ldt; /* user-set LDT */
163 size_t pm_ldt_len; /* size of LDT in bytes */
164 int pm_ldt_sel; /* LDT selector */
165 kcpuset_t *pm_cpus; /* mask of CPUs using pmap */
166 kcpuset_t *pm_kernel_cpus; /* mask of CPUs using kernel part
167 of pmap */
168 kcpuset_t *pm_xen_ptp_cpus; /* mask of CPUs which have this pmap's
169 ptp mapped */
170 uint64_t pm_ncsw; /* for assertions */
171 struct vm_page *pm_gc_ptp; /* pages from pmap g/c */
172};
173
174/* macro to access pm_pdirpa slots */
175#ifdef PAE
176#define pmap_pdirpa(pmap, index) \
177 ((pmap)->pm_pdirpa[l2tol3(index)] + l2tol2(index) * sizeof(pd_entry_t))
178#else
179#define pmap_pdirpa(pmap, index) \
180 ((pmap)->pm_pdirpa[0] + (index) * sizeof(pd_entry_t))
181#endif
182
183/*
184 * flag to be used for kernel mappings: PG_u on Xen/amd64,
185 * 0 otherwise.
186 */
187#if defined(XEN) && defined(__x86_64__)
188#define PG_k PG_u
189#else
190#define PG_k 0
191#endif
192
193/*
194 * MD flags that we use for pmap_enter and pmap_kenter_pa:
195 */
196
197/*
198 * global kernel variables
199 */
200
201/*
202 * PDPpaddr is the physical address of the kernel's PDP.
203 * - i386 non-PAE and amd64: PDPpaddr corresponds directly to the %cr3
204 * value associated to the kernel process, proc0.
205 * - i386 PAE: it still represents the PA of the kernel's PDP (L2). Due to
206 * the L3 PD, it cannot be considered as the equivalent of a %cr3 any more.
207 * - Xen: it corresponds to the PFN of the kernel's PDP.
208 */
209extern u_long PDPpaddr;
210
211extern pd_entry_t pmap_pg_g; /* do we support PG_G? */
212extern pd_entry_t pmap_pg_nx; /* do we support PG_NX? */
213extern long nkptp[PTP_LEVELS];
214
215/*
216 * macros
217 */
218
219#define pmap_resident_count(pmap) ((pmap)->pm_stats.resident_count)
220#define pmap_wired_count(pmap) ((pmap)->pm_stats.wired_count)
221
222#define pmap_clear_modify(pg) pmap_clear_attrs(pg, PG_M)
223#define pmap_clear_reference(pg) pmap_clear_attrs(pg, PG_U)
224#define pmap_copy(DP,SP,D,L,S) __USE(L)
225#define pmap_is_modified(pg) pmap_test_attrs(pg, PG_M)
226#define pmap_is_referenced(pg) pmap_test_attrs(pg, PG_U)
227#define pmap_move(DP,SP,D,L,S)
228#define pmap_phys_address(ppn) (x86_ptob(ppn) & ~X86_MMAP_FLAG_MASK)
229#define pmap_mmap_flags(ppn) x86_mmap_flags(ppn)
230#define pmap_valid_entry(E) ((E) & PG_V) /* is PDE or PTE valid? */
231
232#if defined(__x86_64__) || defined(PAE)
233#define X86_MMAP_FLAG_SHIFT (64 - PGSHIFT)
234#else
235#define X86_MMAP_FLAG_SHIFT (32 - PGSHIFT)
236#endif
237
238#define X86_MMAP_FLAG_MASK 0xf
239#define X86_MMAP_FLAG_PREFETCH 0x1
240
241/*
242 * prototypes
243 */
244
245void pmap_activate(struct lwp *);
246void pmap_bootstrap(vaddr_t);
247bool pmap_clear_attrs(struct vm_page *, unsigned);
248bool pmap_pv_clear_attrs(paddr_t, unsigned);
249void pmap_deactivate(struct lwp *);
250void pmap_page_remove(struct vm_page *);
251void pmap_pv_remove(paddr_t);
252void pmap_remove(struct pmap *, vaddr_t, vaddr_t);
253bool pmap_test_attrs(struct vm_page *, unsigned);
254void pmap_write_protect(struct pmap *, vaddr_t, vaddr_t, vm_prot_t);
255void pmap_load(void);
256paddr_t pmap_init_tmp_pgtbl(paddr_t);
257void pmap_remove_all(struct pmap *);
258void pmap_ldt_cleanup(struct lwp *);
259void pmap_ldt_sync(struct pmap *);
260void pmap_kremove_local(vaddr_t, vsize_t);
261
262void pmap_emap_enter(vaddr_t, paddr_t, vm_prot_t);
263void pmap_emap_remove(vaddr_t, vsize_t);
264void pmap_emap_sync(bool);
265
266#define __HAVE_PMAP_PV_TRACK 1
267void pmap_pv_init(void);
268void pmap_pv_track(paddr_t, psize_t);
269void pmap_pv_untrack(paddr_t, psize_t);
270
271void pmap_map_ptes(struct pmap *, struct pmap **, pd_entry_t **,
272 pd_entry_t * const **);
273void pmap_unmap_ptes(struct pmap *, struct pmap *);
274
275int pmap_pdes_invalid(vaddr_t, pd_entry_t * const *, pd_entry_t *);
276
277u_int x86_mmap_flags(paddr_t);
278
279bool pmap_is_curpmap(struct pmap *);
280
281vaddr_t reserve_dumppages(vaddr_t); /* XXX: not a pmap fn */
282
283typedef enum tlbwhy {
284 TLBSHOOT_APTE,
285 TLBSHOOT_KENTER,
286 TLBSHOOT_KREMOVE,
287 TLBSHOOT_FREE_PTP1,
288 TLBSHOOT_FREE_PTP2,
289 TLBSHOOT_REMOVE_PTE,
290 TLBSHOOT_REMOVE_PTES,
291 TLBSHOOT_SYNC_PV1,
292 TLBSHOOT_SYNC_PV2,
293 TLBSHOOT_WRITE_PROTECT,
294 TLBSHOOT_ENTER,
295 TLBSHOOT_UPDATE,
296 TLBSHOOT_BUS_DMA,
297 TLBSHOOT_BUS_SPACE,
298 TLBSHOOT__MAX,
299} tlbwhy_t;
300
301void pmap_tlb_init(void);
302void pmap_tlb_cpu_init(struct cpu_info *);
303void pmap_tlb_shootdown(pmap_t, vaddr_t, pt_entry_t, tlbwhy_t);
304void pmap_tlb_shootnow(void);
305void pmap_tlb_intr(void);
306
307#define __HAVE_PMAP_EMAP
308
309#define PMAP_GROWKERNEL /* turn on pmap_growkernel interface */
310#define PMAP_FORK /* turn on pmap_fork interface */
311
312/*
313 * Do idle page zero'ing uncached to avoid polluting the cache.
314 */
315bool pmap_pageidlezero(paddr_t);
316#define PMAP_PAGEIDLEZERO(pa) pmap_pageidlezero((pa))
317
318/*
319 * inline functions
320 */
321
322__inline static bool __unused
323pmap_pdes_valid(vaddr_t va, pd_entry_t * const *pdes, pd_entry_t *lastpde)
324{
325 return pmap_pdes_invalid(va, pdes, lastpde) == 0;
326}
327
328/*
329 * pmap_update_pg: flush one page from the TLB (or flush the whole thing
330 * if hardware doesn't support one-page flushing)
331 */
332
333__inline static void __unused
334pmap_update_pg(vaddr_t va)
335{
336 invlpg(va);
337}
338
339/*
340 * pmap_update_2pg: flush two pages from the TLB
341 */
342
343__inline static void __unused
344pmap_update_2pg(vaddr_t va, vaddr_t vb)
345{
346 invlpg(va);
347 invlpg(vb);
348}
349
350/*
351 * pmap_page_protect: change the protection of all recorded mappings
352 * of a managed page
353 *
354 * => this function is a frontend for pmap_page_remove/pmap_clear_attrs
355 * => we only have to worry about making the page more protected.
356 * unprotecting a page is done on-demand at fault time.
357 */
358
359__inline static void __unused
360pmap_page_protect(struct vm_page *pg, vm_prot_t prot)
361{
362 if ((prot & VM_PROT_WRITE) == 0) {
363 if (prot & (VM_PROT_READ|VM_PROT_EXECUTE)) {
364 (void) pmap_clear_attrs(pg, PG_RW);
365 } else {
366 pmap_page_remove(pg);
367 }
368 }
369}
370
371/*
372 * pmap_pv_protect: change the protection of all recorded mappings
373 * of an unmanaged page
374 */
375
376__inline static void __unused
377pmap_pv_protect(paddr_t pa, vm_prot_t prot)
378{
379 if ((prot & VM_PROT_WRITE) == 0) {
380 if (prot & (VM_PROT_READ|VM_PROT_EXECUTE)) {
381 (void) pmap_pv_clear_attrs(pa, PG_RW);
382 } else {
383 pmap_pv_remove(pa);
384 }
385 }
386}
387
388/*
389 * pmap_protect: change the protection of pages in a pmap
390 *
391 * => this function is a frontend for pmap_remove/pmap_write_protect
392 * => we only have to worry about making the page more protected.
393 * unprotecting a page is done on-demand at fault time.
394 */
395
396__inline static void __unused
397pmap_protect(struct pmap *pmap, vaddr_t sva, vaddr_t eva, vm_prot_t prot)
398{
399 if ((prot & VM_PROT_WRITE) == 0) {
400 if (prot & (VM_PROT_READ|VM_PROT_EXECUTE)) {
401 pmap_write_protect(pmap, sva, eva, prot);
402 } else {
403 pmap_remove(pmap, sva, eva);
404 }
405 }
406}
407
408/*
409 * various address inlines
410 *
411 * vtopte: return a pointer to the PTE mapping a VA, works only for
412 * user and PT addresses
413 *
414 * kvtopte: return a pointer to the PTE mapping a kernel VA
415 */
416
417#include <lib/libkern/libkern.h>
418
419static __inline pt_entry_t * __unused
420vtopte(vaddr_t va)
421{
422
423 KASSERT(va < VM_MIN_KERNEL_ADDRESS);
424
425 return (PTE_BASE + pl1_i(va));
426}
427
428static __inline pt_entry_t * __unused
429kvtopte(vaddr_t va)
430{
431 pd_entry_t *pde;
432
433 KASSERT(va >= VM_MIN_KERNEL_ADDRESS);
434
435 pde = L2_BASE + pl2_i(va);
436 if (*pde & PG_PS)
437 return ((pt_entry_t *)pde);
438
439 return (PTE_BASE + pl1_i(va));
440}
441
442paddr_t vtophys(vaddr_t);
443vaddr_t pmap_map(vaddr_t, paddr_t, paddr_t, vm_prot_t);
444void pmap_cpu_init_late(struct cpu_info *);
445bool sse2_idlezero_page(void *);
446
447#ifdef XEN
448#include <sys/bitops.h>
449
450#define XPTE_MASK L1_FRAME
451/* Selects the index of a PTE in (A)PTE_BASE */
452#define XPTE_SHIFT (L1_SHIFT - ilog2(sizeof(pt_entry_t)))
453
454/* PTE access inline fuctions */
455
456/*
457 * Get the machine address of the pointed pte
458 * We use hardware MMU to get value so works only for levels 1-3
459 */
460
461static __inline paddr_t
462xpmap_ptetomach(pt_entry_t *pte)
463{
464 pt_entry_t *up_pte;
465 vaddr_t va = (vaddr_t) pte;
466
467 va = ((va & XPTE_MASK) >> XPTE_SHIFT) | (vaddr_t) PTE_BASE;
468 up_pte = (pt_entry_t *) va;
469
470 return (paddr_t) (((*up_pte) & PG_FRAME) + (((vaddr_t) pte) & (~PG_FRAME & ~VA_SIGN_MASK)));
471}
472
473/* Xen helpers to change bits of a pte */
474#define XPMAP_UPDATE_DIRECT 1 /* Update direct map entry flags too */
475
476paddr_t vtomach(vaddr_t);
477#define vtomfn(va) (vtomach(va) >> PAGE_SHIFT)
478#endif /* XEN */
479
480/* pmap functions with machine addresses */
481void pmap_kenter_ma(vaddr_t, paddr_t, vm_prot_t, u_int);
482int pmap_enter_ma(struct pmap *, vaddr_t, paddr_t, paddr_t,
483 vm_prot_t, u_int, int);
484bool pmap_extract_ma(pmap_t, vaddr_t, paddr_t *);
485void pmap_free_ptps(struct vm_page *);
486
487/*
488 * Hooks for the pool allocator.
489 */
490#define POOL_VTOPHYS(va) vtophys((vaddr_t) (va))
491
492#ifdef __HAVE_DIRECT_MAP
493
494#define L4_SLOT_DIRECT 509
495#define PDIR_SLOT_DIRECT L4_SLOT_DIRECT
496
497#define PMAP_DIRECT_BASE (VA_SIGN_NEG((L4_SLOT_DIRECT * NBPD_L4)))
498#define PMAP_DIRECT_END (VA_SIGN_NEG(((L4_SLOT_DIRECT + 1) * NBPD_L4)))
499
500#define PMAP_DIRECT_MAP(pa) ((vaddr_t)PMAP_DIRECT_BASE + (pa))
501#define PMAP_DIRECT_UNMAP(va) ((paddr_t)(va) - PMAP_DIRECT_BASE)
502
503/*
504 * Alternate mapping hooks for pool pages.
505 */
506#define PMAP_MAP_POOLPAGE(pa) PMAP_DIRECT_MAP((pa))
507#define PMAP_UNMAP_POOLPAGE(va) PMAP_DIRECT_UNMAP((va))
508
509void pagezero(vaddr_t);
510
511#endif /* __HAVE_DIRECT_MAP */
512
513#endif /* _KERNEL */
514
515#endif /* _X86_PMAP_H_ */
516