Home | History | Annotate | Line # | Download | only in include
pmap.h revision 1.26 
      1 /* $NetBSD: pmap.h,v 1.26 2019/10/29 20:01:22 maya Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2014 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Matt Thomas of 3am Software Foundry.
      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  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _AARCH64_PMAP_H_
     33 #define _AARCH64_PMAP_H_
     34 
     35 #ifdef __aarch64__
     36 
     37 #ifdef _KERNEL
     38 #ifdef _KERNEL_OPT
     39 #include "opt_kasan.h"
     40 #endif
     41 
     42 #include <sys/types.h>
     43 #include <sys/pool.h>
     44 #include <sys/queue.h>
     45 #include <uvm/uvm_pglist.h>
     46 
     47 #include <aarch64/pte.h>
     48 
     49 #define PMAP_NEED_PROCWR
     50 #define PMAP_GROWKERNEL
     51 #define PMAP_STEAL_MEMORY
     52 
     53 #define __HAVE_VM_PAGE_MD
     54 
     55 #ifndef KASAN
     56 #define PMAP_MAP_POOLPAGE(pa)		AARCH64_PA_TO_KVA(pa)
     57 #define PMAP_UNMAP_POOLPAGE(va)		AARCH64_KVA_TO_PA(va)
     58 
     59 #define PMAP_DIRECT
     60 static __inline int
     61 pmap_direct_process(paddr_t pa, voff_t pgoff, size_t len,
     62     int (*process)(void *, size_t, void *), void *arg)
     63 {
     64 	vaddr_t va = AARCH64_PA_TO_KVA(pa);
     65 
     66 	return process((void *)(va + pgoff), len, arg);
     67 }
     68 #endif
     69 
     70 struct pmap {
     71 	kmutex_t pm_lock;
     72 	struct pool *pm_pvpool;
     73 	pd_entry_t *pm_l0table;			/* L0 table: 512G*512 */
     74 	paddr_t pm_l0table_pa;
     75 
     76 	TAILQ_HEAD(, vm_page) pm_vmlist;	/* for L[0123] tables */
     77 
     78 	struct pmap_statistics pm_stats;
     79 	unsigned int pm_refcnt;
     80 	unsigned int pm_idlepdp;
     81 	int pm_asid;
     82 	bool pm_activated;
     83 };
     84 
     85 struct pv_entry;
     86 struct vm_page_md {
     87 	kmutex_t mdpg_pvlock;
     88 	TAILQ_ENTRY(vm_page) mdpg_vmlist;	/* L[0123] table vm_page list */
     89 	TAILQ_HEAD(, pv_entry) mdpg_pvhead;
     90 
     91 	pd_entry_t *mdpg_ptep_parent;	/* for page descriptor page only */
     92 
     93 	/* VM_PROT_READ means referenced, VM_PROT_WRITE means modified */
     94 	uint32_t mdpg_flags;
     95 };
     96 
     97 /* each mdpg_pvlock will be initialized in pmap_init() */
     98 #define VM_MDPAGE_INIT(pg)				\
     99 	do {						\
    100 		TAILQ_INIT(&(pg)->mdpage.mdpg_pvhead);	\
    101 		(pg)->mdpage.mdpg_flags = 0;		\
    102 	} while (/*CONSTCOND*/ 0)
    103 
    104 
    105 /* saved permission bit for referenced/modified emulation */
    106 #define LX_BLKPAG_OS_READ		LX_BLKPAG_OS_0
    107 #define LX_BLKPAG_OS_WRITE		LX_BLKPAG_OS_1
    108 #define LX_BLKPAG_OS_WIRED		LX_BLKPAG_OS_2
    109 #define LX_BLKPAG_OS_BOOT		LX_BLKPAG_OS_3
    110 #define LX_BLKPAG_OS_RWMASK		(LX_BLKPAG_OS_WRITE|LX_BLKPAG_OS_READ)
    111 
    112 /* memory attributes are configured MAIR_EL1 in locore */
    113 #define LX_BLKPAG_ATTR_NORMAL_WB	__SHIFTIN(0, LX_BLKPAG_ATTR_INDX)
    114 #define LX_BLKPAG_ATTR_NORMAL_NC	__SHIFTIN(1, LX_BLKPAG_ATTR_INDX)
    115 #define LX_BLKPAG_ATTR_NORMAL_WT	__SHIFTIN(2, LX_BLKPAG_ATTR_INDX)
    116 #define LX_BLKPAG_ATTR_DEVICE_MEM	__SHIFTIN(3, LX_BLKPAG_ATTR_INDX)
    117 #define LX_BLKPAG_ATTR_MASK		LX_BLKPAG_ATTR_INDX
    118 
    119 #define lxpde_pa(pde)		((paddr_t)((pde) & LX_TBL_PA))
    120 #define lxpde_valid(pde)	(((pde) & LX_VALID) == LX_VALID)
    121 #define l0pde_pa(pde)		lxpde_pa(pde)
    122 #define l0pde_index(v)		(((vaddr_t)(v) & L0_ADDR_BITS) >> L0_SHIFT)
    123 #define l0pde_valid(pde)	lxpde_valid(pde)
    124 /* l0pte always contains table entries */
    125 
    126 #define l1pde_pa(pde)		lxpde_pa(pde)
    127 #define l1pde_index(v)		(((vaddr_t)(v) & L1_ADDR_BITS) >> L1_SHIFT)
    128 #define l1pde_valid(pde)	lxpde_valid(pde)
    129 #define l1pde_is_block(pde)	(((pde) & LX_TYPE) == LX_TYPE_BLK)
    130 #define l1pde_is_table(pde)	(((pde) & LX_TYPE) == LX_TYPE_TBL)
    131 
    132 #define l2pde_pa(pde)		lxpde_pa(pde)
    133 #define l2pde_index(v)		(((vaddr_t)(v) & L2_ADDR_BITS) >> L2_SHIFT)
    134 #define l2pde_valid(pde)	lxpde_valid(pde)
    135 #define l2pde_is_block(pde)	(((pde) & LX_TYPE) == LX_TYPE_BLK)
    136 #define l2pde_is_table(pde)	(((pde) & LX_TYPE) == LX_TYPE_TBL)
    137 
    138 #define l3pte_pa(pde)		lxpde_pa(pde)
    139 #define l3pte_executable(pde,user)	\
    140     (((pde) & ((user) ? LX_BLKPAG_UXN : LX_BLKPAG_PXN)) == 0)
    141 #define l3pte_readable(pde)	((pde) & LX_BLKPAG_AF)
    142 #define l3pte_writable(pde)	\
    143     (((pde) & (LX_BLKPAG_AF|LX_BLKPAG_AP)) == (LX_BLKPAG_AF|LX_BLKPAG_AP_RW))
    144 #define l3pte_index(v)		(((vaddr_t)(v) & L3_ADDR_BITS) >> L3_SHIFT)
    145 #define l3pte_valid(pde)	lxpde_valid(pde)
    146 #define l3pte_is_page(pde)	(((pde) & LX_TYPE) == L3_TYPE_PAG)
    147 /* l3pte contains always page entries */
    148 
    149 void pmap_bootstrap(vaddr_t, vaddr_t);
    150 bool pmap_fault_fixup(struct pmap *, vaddr_t, vm_prot_t, bool user);
    151 
    152 /* for ddb */
    153 void pmap_db_pteinfo(vaddr_t, void (*)(const char *, ...) __printflike(1, 2));
    154 void pmap_db_ttbrdump(bool, vaddr_t, void (*)(const char *, ...)
    155     __printflike(1, 2));
    156 pt_entry_t *kvtopte(vaddr_t);
    157 pt_entry_t pmap_kvattr(vaddr_t, vm_prot_t);
    158 
    159 /* locore.S */
    160 pd_entry_t *bootpage_alloc(void);
    161 
    162 /* pmap_locore.c */
    163 int pmapboot_enter(vaddr_t, paddr_t, psize_t, psize_t,
    164     pt_entry_t, uint64_t, pd_entry_t *(*)(void),
    165     void (*pr)(const char *, ...) __printflike(1, 2));
    166 #define PMAPBOOT_ENTER_NOBLOCK		0x00000001
    167 #define PMAPBOOT_ENTER_NOOVERWRITE	0x00000002
    168 int pmapboot_protect(vaddr_t, vaddr_t, vm_prot_t);
    169 void pmap_db_pte_print(pt_entry_t, int,
    170     void (*pr)(const char *, ...) __printflike(1, 2));
    171 
    172 /* Hooks for the pool allocator */
    173 paddr_t vtophys(vaddr_t);
    174 #define VTOPHYS_FAILED		((paddr_t)-1L)	/* POOL_PADDR_INVALID */
    175 #define POOL_VTOPHYS(va)	vtophys((vaddr_t) (va))
    176 
    177 
    178 /* devmap */
    179 struct pmap_devmap {
    180 	vaddr_t pd_va;		/* virtual address */
    181 	paddr_t pd_pa;		/* physical address */
    182 	psize_t pd_size;	/* size of region */
    183 	vm_prot_t pd_prot;	/* protection code */
    184 	u_int pd_flags;		/* flags for pmap_kenter_pa() */
    185 };
    186 
    187 void pmap_devmap_register(const struct pmap_devmap *);
    188 void pmap_devmap_bootstrap(vaddr_t, const struct pmap_devmap *);
    189 const struct pmap_devmap *pmap_devmap_find_pa(paddr_t, psize_t);
    190 const struct pmap_devmap *pmap_devmap_find_va(vaddr_t, vsize_t);
    191 vaddr_t pmap_devmap_phystov(paddr_t);
    192 paddr_t pmap_devmap_vtophys(paddr_t);
    193 
    194 paddr_t pmap_alloc_pdp(struct pmap *, struct vm_page **, int, bool);
    195 
    196 #define L1_TRUNC_BLOCK(x)	((x) & L1_FRAME)
    197 #define L1_ROUND_BLOCK(x)	L1_TRUNC_BLOCK((x) + L1_SIZE - 1)
    198 #define L2_TRUNC_BLOCK(x)	((x) & L2_FRAME)
    199 #define L2_ROUND_BLOCK(x)	L2_TRUNC_BLOCK((x) + L2_SIZE - 1)
    200 
    201 /* devmap use L2 blocks. (2Mbyte) */
    202 #define DEVMAP_TRUNC_ADDR(x)	L2_TRUNC_BLOCK((x))
    203 #define DEVMAP_ROUND_SIZE(x)	L2_ROUND_BLOCK((x))
    204 
    205 #define	DEVMAP_ENTRY(va, pa, sz)			\
    206 	{						\
    207 		.pd_va = DEVMAP_TRUNC_ADDR(va),		\
    208 		.pd_pa = DEVMAP_TRUNC_ADDR(pa),		\
    209 		.pd_size = DEVMAP_ROUND_SIZE(sz),	\
    210 		.pd_prot = VM_PROT_READ|VM_PROT_WRITE,	\
    211 		.pd_flags = PMAP_DEV			\
    212 	}
    213 #define	DEVMAP_ENTRY_END	{ 0 }
    214 
    215 /* mmap cookie and flags */
    216 #define AARCH64_MMAP_FLAG_SHIFT		(64 - PGSHIFT)
    217 #define AARCH64_MMAP_FLAG_MASK		0xf
    218 #define AARCH64_MMAP_WRITEBACK		0UL
    219 #define AARCH64_MMAP_NOCACHE		1UL
    220 #define AARCH64_MMAP_WRITECOMBINE	2UL
    221 #define AARCH64_MMAP_DEVICE		3UL
    222 
    223 #define ARM_MMAP_MASK			__BITS(63, AARCH64_MMAP_FLAG_SHIFT)
    224 #define ARM_MMAP_WRITECOMBINE		__SHIFTIN(AARCH64_MMAP_WRITECOMBINE, ARM_MMAP_MASK)
    225 #define ARM_MMAP_WRITEBACK		__SHIFTIN(AARCH64_MMAP_WRITEBACK, ARM_MMAP_MASK)
    226 #define ARM_MMAP_NOCACHE		__SHIFTIN(AARCH64_MMAP_NOCACHE, ARM_MMAP_MASK)
    227 #define ARM_MMAP_DEVICE			__SHIFTIN(AARCH64_MMAP_DEVICE, ARM_MMAP_MASK)
    228 
    229 #define	PMAP_PTE			0x10000000 /* kenter_pa */
    230 #define	PMAP_DEV			0x20000000 /* kenter_pa */
    231 
    232 static inline u_int
    233 aarch64_mmap_flags(paddr_t mdpgno)
    234 {
    235 	u_int nflag, pflag;
    236 
    237 	/*
    238 	 * aarch64 arch has 4 memory attribute:
    239 	 *
    240 	 *  WriteBack      - write back cache
    241 	 *  WriteThru      - wite through cache
    242 	 *  NoCache        - no cache
    243 	 *  Device(nGnRnE) - no Gathering, no Reordering, no Early write ack
    244 	 *
    245 	 * but pmap has PMAP_{NOCACHE,WRITE_COMBINE,WRITE_BACK} flags.
    246 	 */
    247 
    248 	nflag = (mdpgno >> AARCH64_MMAP_FLAG_SHIFT) & AARCH64_MMAP_FLAG_MASK;
    249 	switch (nflag) {
    250 	case AARCH64_MMAP_DEVICE:
    251 		pflag = PMAP_DEV;
    252 		break;
    253 	case AARCH64_MMAP_WRITECOMBINE:
    254 		pflag = PMAP_WRITE_COMBINE;
    255 		break;
    256 	case AARCH64_MMAP_WRITEBACK:
    257 		pflag = PMAP_WRITE_BACK;
    258 		break;
    259 	case AARCH64_MMAP_NOCACHE:
    260 	default:
    261 		pflag = PMAP_NOCACHE;
    262 		break;
    263 	}
    264 	return pflag;
    265 }
    266 
    267 
    268 #define pmap_phys_address(pa)		aarch64_ptob((pa))
    269 #define pmap_mmap_flags(ppn)		aarch64_mmap_flags((ppn))
    270 
    271 #define pmap_update(pmap)		((void)0)
    272 #define pmap_copy(dp,sp,d,l,s)		((void)0)
    273 #define pmap_wired_count(pmap)		((pmap)->pm_stats.wired_count)
    274 #define pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
    275 
    276 void	pmap_procwr(struct proc *, vaddr_t, int);
    277 bool	pmap_extract_coherency(pmap_t, vaddr_t, paddr_t *, bool *);
    278 void	pmap_icache_sync_range(pmap_t, vaddr_t, vaddr_t);
    279 
    280 #define	PMAP_MAPSIZE1	L2_SIZE
    281 
    282 #endif /* _KERNEL */
    283 
    284 #elif defined(__arm__)
    285 
    286 #include <arm/pmap.h>
    287 
    288 #endif /* __arm__/__aarch64__ */
    289 
    290 #endif /* !_AARCH64_PMAP_ */
    291