pmap.h revision 336711 
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 * 3. 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 * $FreeBSD: stable/11/sys/arm64/include/pmap.h 336711 2018-07-25 15:40:27Z markj $
34 */
35
36#ifndef _MACHINE_PMAP_H_
37#define	_MACHINE_PMAP_H_
38
39#include <machine/pte.h>
40
41#ifndef LOCORE
42
43#include <sys/queue.h>
44#include <sys/_lock.h>
45#include <sys/_mutex.h>
46
47#include <vm/_vm_radix.h>
48
49#ifdef _KERNEL
50
51#define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
52
53#endif
54
55#define	pmap_page_get_memattr(m)	((m)->md.pv_memattr)
56#define	pmap_page_is_write_mapped(m)	(((m)->aflags & PGA_WRITEABLE) != 0)
57void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
58
59/*
60 * Pmap stuff
61 */
62
63struct md_page {
64	TAILQ_HEAD(,pv_entry)	pv_list;
65	int			pv_gen;
66	vm_memattr_t		pv_memattr;
67};
68
69/*
70 * This structure is used to hold a virtual<->physical address
71 * association and is used mostly by bootstrap code
72 */
73struct pv_addr {
74	SLIST_ENTRY(pv_addr) pv_list;
75	vm_offset_t	pv_va;
76	vm_paddr_t	pv_pa;
77};
78
79
80struct pmap {
81	struct mtx		pm_mtx;
82	struct pmap_statistics	pm_stats;	/* pmap statictics */
83	pd_entry_t		*pm_l0;
84	TAILQ_HEAD(,pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
85	struct vm_radix		pm_root;	/* spare page table pages */
86};
87typedef struct pmap *pmap_t;
88
89typedef struct pv_entry {
90	vm_offset_t		pv_va;	/* virtual address for mapping */
91	TAILQ_ENTRY(pv_entry)	pv_next;
92} *pv_entry_t;
93
94/*
95 * pv_entries are allocated in chunks per-process.  This avoids the
96 * need to track per-pmap assignments.
97 */
98#define	_NPCM	3
99#define	_NPCPV	168
100#define	PV_CHUNK_HEADER							\
101	pmap_t			pc_pmap;				\
102	TAILQ_ENTRY(pv_chunk)	pc_list;				\
103	uint64_t		pc_map[_NPCM];	/* bitmap; 1 = free */	\
104	TAILQ_ENTRY(pv_chunk)	pc_lru;
105
106struct pv_chunk_header {
107	PV_CHUNK_HEADER
108};
109
110struct pv_chunk {
111	PV_CHUNK_HEADER
112	struct pv_entry		pc_pventry[_NPCPV];
113};
114
115#ifdef _KERNEL
116extern struct pmap	kernel_pmap_store;
117#define	kernel_pmap	(&kernel_pmap_store)
118#define	pmap_kernel()	kernel_pmap
119
120#define	PMAP_ASSERT_LOCKED(pmap) \
121				mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
122#define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
123#define	PMAP_LOCK_ASSERT(pmap, type) \
124				mtx_assert(&(pmap)->pm_mtx, (type))
125#define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
126#define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
127				    NULL, MTX_DEF | MTX_DUPOK)
128#define	PMAP_OWNED(pmap)	mtx_owned(&(pmap)->pm_mtx)
129#define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
130#define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
131#define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
132
133#define	PHYS_AVAIL_SIZE	32
134extern vm_paddr_t phys_avail[];
135extern vm_paddr_t dump_avail[];
136extern vm_offset_t virtual_avail;
137extern vm_offset_t virtual_end;
138
139/*
140 * Macros to test if a mapping is mappable with an L1 Section mapping
141 * or an L2 Large Page mapping.
142 */
143#define	L1_MAPPABLE_P(va, pa, size)					\
144	((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
145
146void	pmap_bootstrap(vm_offset_t, vm_offset_t, vm_paddr_t, vm_size_t);
147void	pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
148vm_paddr_t pmap_kextract(vm_offset_t va);
149void	pmap_kremove(vm_offset_t);
150void	pmap_kremove_device(vm_offset_t, vm_size_t);
151
152void	*pmap_mapdev(vm_offset_t, vm_size_t);
153void	*pmap_mapbios(vm_paddr_t, vm_size_t);
154void	pmap_unmapdev(vm_offset_t, vm_size_t);
155void	pmap_unmapbios(vm_offset_t, vm_size_t);
156
157boolean_t pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
158void	pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
159
160bool	pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
161    pd_entry_t **, pt_entry_t **);
162
163int	pmap_fault(pmap_t, uint64_t, uint64_t);
164
165#define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
166
167#endif	/* _KERNEL */
168
169#endif	/* !LOCORE */
170
171#endif	/* !_MACHINE_PMAP_H_ */
172