xref: /openbmc/linux/arch/arm64/include/asm/memory.h (revision 2fa49589)
1 /*
2  * Based on arch/arm/include/asm/memory.h
3  *
4  * Copyright (C) 2000-2002 Russell King
5  * Copyright (C) 2012 ARM Ltd.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  *
19  * Note: this file should not be included by non-asm/.h files
20  */
21 #ifndef __ASM_MEMORY_H
22 #define __ASM_MEMORY_H
23 
24 #include <linux/compiler.h>
25 #include <linux/const.h>
26 #include <linux/types.h>
27 #include <asm/bug.h>
28 #include <asm/page-def.h>
29 #include <asm/sizes.h>
30 
31 /*
32  * Size of the PCI I/O space. This must remain a power of two so that
33  * IO_SPACE_LIMIT acts as a mask for the low bits of I/O addresses.
34  */
35 #define PCI_IO_SIZE		SZ_16M
36 
37 /*
38  * VMEMMAP_SIZE - allows the whole linear region to be covered by
39  *                a struct page array
40  */
41 #define VMEMMAP_SIZE (UL(1) << (VA_BITS - PAGE_SHIFT - 1 + STRUCT_PAGE_MAX_SHIFT))
42 
43 /*
44  * PAGE_OFFSET - the virtual address of the start of the linear map (top
45  *		 (VA_BITS - 1))
46  * KIMAGE_VADDR - the virtual address of the start of the kernel image
47  * VA_BITS - the maximum number of bits for virtual addresses.
48  * VA_START - the first kernel virtual address.
49  */
50 #define VA_BITS			(CONFIG_ARM64_VA_BITS)
51 #define VA_START		(UL(0xffffffffffffffff) - \
52 	(UL(1) << VA_BITS) + 1)
53 #define PAGE_OFFSET		(UL(0xffffffffffffffff) - \
54 	(UL(1) << (VA_BITS - 1)) + 1)
55 #define KIMAGE_VADDR		(MODULES_END)
56 #define BPF_JIT_REGION_START	(VA_START + KASAN_SHADOW_SIZE)
57 #define BPF_JIT_REGION_SIZE	(SZ_128M)
58 #define BPF_JIT_REGION_END	(BPF_JIT_REGION_START + BPF_JIT_REGION_SIZE)
59 #define MODULES_END		(MODULES_VADDR + MODULES_VSIZE)
60 #define MODULES_VADDR		(BPF_JIT_REGION_END)
61 #define MODULES_VSIZE		(SZ_128M)
62 #define VMEMMAP_START		(PAGE_OFFSET - VMEMMAP_SIZE)
63 #define PCI_IO_END		(VMEMMAP_START - SZ_2M)
64 #define PCI_IO_START		(PCI_IO_END - PCI_IO_SIZE)
65 #define FIXADDR_TOP		(PCI_IO_START - SZ_2M)
66 
67 #define KERNEL_START      _text
68 #define KERNEL_END        _end
69 
70 #ifdef CONFIG_ARM64_USER_VA_BITS_52
71 #define MAX_USER_VA_BITS	52
72 #else
73 #define MAX_USER_VA_BITS	VA_BITS
74 #endif
75 
76 /*
77  * Generic and tag-based KASAN require 1/8th and 1/16th of the kernel virtual
78  * address space for the shadow region respectively. They can bloat the stack
79  * significantly, so double the (minimum) stack size when they are in use.
80  */
81 #ifdef CONFIG_KASAN
82 #define KASAN_SHADOW_SIZE	(UL(1) << (VA_BITS - KASAN_SHADOW_SCALE_SHIFT))
83 #ifdef CONFIG_KASAN_EXTRA
84 #define KASAN_THREAD_SHIFT	2
85 #else
86 #define KASAN_THREAD_SHIFT	1
87 #endif /* CONFIG_KASAN_EXTRA */
88 #else
89 #define KASAN_SHADOW_SIZE	(0)
90 #define KASAN_THREAD_SHIFT	0
91 #endif
92 
93 #define MIN_THREAD_SHIFT	(14 + KASAN_THREAD_SHIFT)
94 
95 /*
96  * VMAP'd stacks are allocated at page granularity, so we must ensure that such
97  * stacks are a multiple of page size.
98  */
99 #if defined(CONFIG_VMAP_STACK) && (MIN_THREAD_SHIFT < PAGE_SHIFT)
100 #define THREAD_SHIFT		PAGE_SHIFT
101 #else
102 #define THREAD_SHIFT		MIN_THREAD_SHIFT
103 #endif
104 
105 #if THREAD_SHIFT >= PAGE_SHIFT
106 #define THREAD_SIZE_ORDER	(THREAD_SHIFT - PAGE_SHIFT)
107 #endif
108 
109 #define THREAD_SIZE		(UL(1) << THREAD_SHIFT)
110 
111 /*
112  * By aligning VMAP'd stacks to 2 * THREAD_SIZE, we can detect overflow by
113  * checking sp & (1 << THREAD_SHIFT), which we can do cheaply in the entry
114  * assembly.
115  */
116 #ifdef CONFIG_VMAP_STACK
117 #define THREAD_ALIGN		(2 * THREAD_SIZE)
118 #else
119 #define THREAD_ALIGN		THREAD_SIZE
120 #endif
121 
122 #define IRQ_STACK_SIZE		THREAD_SIZE
123 
124 #define OVERFLOW_STACK_SIZE	SZ_4K
125 
126 /*
127  * Alignment of kernel segments (e.g. .text, .data).
128  */
129 #if defined(CONFIG_DEBUG_ALIGN_RODATA)
130 /*
131  *  4 KB granule:   1 level 2 entry
132  * 16 KB granule: 128 level 3 entries, with contiguous bit
133  * 64 KB granule:  32 level 3 entries, with contiguous bit
134  */
135 #define SEGMENT_ALIGN			SZ_2M
136 #else
137 /*
138  *  4 KB granule:  16 level 3 entries, with contiguous bit
139  * 16 KB granule:   4 level 3 entries, without contiguous bit
140  * 64 KB granule:   1 level 3 entry
141  */
142 #define SEGMENT_ALIGN			SZ_64K
143 #endif
144 
145 /*
146  * Memory types available.
147  */
148 #define MT_DEVICE_nGnRnE	0
149 #define MT_DEVICE_nGnRE		1
150 #define MT_DEVICE_GRE		2
151 #define MT_NORMAL_NC		3
152 #define MT_NORMAL		4
153 #define MT_NORMAL_WT		5
154 
155 /*
156  * Memory types for Stage-2 translation
157  */
158 #define MT_S2_NORMAL		0xf
159 #define MT_S2_DEVICE_nGnRE	0x1
160 
161 /*
162  * Memory types for Stage-2 translation when ID_AA64MMFR2_EL1.FWB is 0001
163  * Stage-2 enforces Normal-WB and Device-nGnRE
164  */
165 #define MT_S2_FWB_NORMAL	6
166 #define MT_S2_FWB_DEVICE_nGnRE	1
167 
168 #ifdef CONFIG_ARM64_4K_PAGES
169 #define IOREMAP_MAX_ORDER	(PUD_SHIFT)
170 #else
171 #define IOREMAP_MAX_ORDER	(PMD_SHIFT)
172 #endif
173 
174 #ifndef __ASSEMBLY__
175 
176 #include <linux/bitops.h>
177 #include <linux/mmdebug.h>
178 
179 extern s64			memstart_addr;
180 /* PHYS_OFFSET - the physical address of the start of memory. */
181 #define PHYS_OFFSET		({ VM_BUG_ON(memstart_addr & 1); memstart_addr; })
182 
183 /* the virtual base of the kernel image (minus TEXT_OFFSET) */
184 extern u64			kimage_vaddr;
185 
186 /* the offset between the kernel virtual and physical mappings */
187 extern u64			kimage_voffset;
188 
189 static inline unsigned long kaslr_offset(void)
190 {
191 	return kimage_vaddr - KIMAGE_VADDR;
192 }
193 
194 /* the actual size of a user virtual address */
195 extern u64			vabits_user;
196 
197 /*
198  * Allow all memory at the discovery stage. We will clip it later.
199  */
200 #define MIN_MEMBLOCK_ADDR	0
201 #define MAX_MEMBLOCK_ADDR	U64_MAX
202 
203 /*
204  * PFNs are used to describe any physical page; this means
205  * PFN 0 == physical address 0.
206  *
207  * This is the PFN of the first RAM page in the kernel
208  * direct-mapped view.  We assume this is the first page
209  * of RAM in the mem_map as well.
210  */
211 #define PHYS_PFN_OFFSET	(PHYS_OFFSET >> PAGE_SHIFT)
212 
213 /*
214  * When dealing with data aborts, watchpoints, or instruction traps we may end
215  * up with a tagged userland pointer. Clear the tag to get a sane pointer to
216  * pass on to access_ok(), for instance.
217  */
218 #define untagged_addr(addr)	\
219 	((__typeof__(addr))sign_extend64((u64)(addr), 55))
220 
221 #ifdef CONFIG_KASAN_SW_TAGS
222 #define __tag_shifted(tag)	((u64)(tag) << 56)
223 #define __tag_set(addr, tag)	(__typeof__(addr))( \
224 		((u64)(addr) & ~__tag_shifted(0xff)) | __tag_shifted(tag))
225 #define __tag_reset(addr)	untagged_addr(addr)
226 #define __tag_get(addr)		(__u8)((u64)(addr) >> 56)
227 #else
228 #define __tag_set(addr, tag)	(addr)
229 #define __tag_reset(addr)	(addr)
230 #define __tag_get(addr)		0
231 #endif
232 
233 /*
234  * Physical vs virtual RAM address space conversion.  These are
235  * private definitions which should NOT be used outside memory.h
236  * files.  Use virt_to_phys/phys_to_virt/__pa/__va instead.
237  */
238 
239 
240 /*
241  * The linear kernel range starts in the middle of the virtual adddress
242  * space. Testing the top bit for the start of the region is a
243  * sufficient check.
244  */
245 #define __is_lm_address(addr)	(!!((addr) & BIT(VA_BITS - 1)))
246 
247 #define __lm_to_phys(addr)	(((addr) & ~PAGE_OFFSET) + PHYS_OFFSET)
248 #define __kimg_to_phys(addr)	((addr) - kimage_voffset)
249 
250 #define __virt_to_phys_nodebug(x) ({					\
251 	phys_addr_t __x = (phys_addr_t)(x);				\
252 	__is_lm_address(__x) ? __lm_to_phys(__x) :			\
253 			       __kimg_to_phys(__x);			\
254 })
255 
256 #define __pa_symbol_nodebug(x)	__kimg_to_phys((phys_addr_t)(x))
257 
258 #ifdef CONFIG_DEBUG_VIRTUAL
259 extern phys_addr_t __virt_to_phys(unsigned long x);
260 extern phys_addr_t __phys_addr_symbol(unsigned long x);
261 #else
262 #define __virt_to_phys(x)	__virt_to_phys_nodebug(x)
263 #define __phys_addr_symbol(x)	__pa_symbol_nodebug(x)
264 #endif
265 
266 #define __phys_to_virt(x)	((unsigned long)((x) - PHYS_OFFSET) | PAGE_OFFSET)
267 #define __phys_to_kimg(x)	((unsigned long)((x) + kimage_voffset))
268 
269 /*
270  * Convert a page to/from a physical address
271  */
272 #define page_to_phys(page)	(__pfn_to_phys(page_to_pfn(page)))
273 #define phys_to_page(phys)	(pfn_to_page(__phys_to_pfn(phys)))
274 
275 /*
276  * Note: Drivers should NOT use these.  They are the wrong
277  * translation for translating DMA addresses.  Use the driver
278  * DMA support - see dma-mapping.h.
279  */
280 #define virt_to_phys virt_to_phys
281 static inline phys_addr_t virt_to_phys(const volatile void *x)
282 {
283 	return __virt_to_phys((unsigned long)(x));
284 }
285 
286 #define phys_to_virt phys_to_virt
287 static inline void *phys_to_virt(phys_addr_t x)
288 {
289 	return (void *)(__phys_to_virt(x));
290 }
291 
292 /*
293  * Drivers should NOT use these either.
294  */
295 #define __pa(x)			__virt_to_phys((unsigned long)(x))
296 #define __pa_symbol(x)		__phys_addr_symbol(RELOC_HIDE((unsigned long)(x), 0))
297 #define __pa_nodebug(x)		__virt_to_phys_nodebug((unsigned long)(x))
298 #define __va(x)			((void *)__phys_to_virt((phys_addr_t)(x)))
299 #define pfn_to_kaddr(pfn)	__va((pfn) << PAGE_SHIFT)
300 #define virt_to_pfn(x)      __phys_to_pfn(__virt_to_phys((unsigned long)(x)))
301 #define sym_to_pfn(x)	    __phys_to_pfn(__pa_symbol(x))
302 
303 /*
304  *  virt_to_page(k)	convert a _valid_ virtual address to struct page *
305  *  virt_addr_valid(k)	indicates whether a virtual address is valid
306  */
307 #define ARCH_PFN_OFFSET		((unsigned long)PHYS_PFN_OFFSET)
308 
309 #ifndef CONFIG_SPARSEMEM_VMEMMAP
310 #define virt_to_page(kaddr)	pfn_to_page(__pa(kaddr) >> PAGE_SHIFT)
311 #define _virt_addr_valid(kaddr)	pfn_valid(__pa(kaddr) >> PAGE_SHIFT)
312 #else
313 #define __virt_to_pgoff(kaddr)	(((u64)(kaddr) & ~PAGE_OFFSET) / PAGE_SIZE * sizeof(struct page))
314 #define __page_to_voff(kaddr)	(((u64)(kaddr) & ~VMEMMAP_START) * PAGE_SIZE / sizeof(struct page))
315 
316 #define page_to_virt(page)	({					\
317 	unsigned long __addr =						\
318 		((__page_to_voff(page)) | PAGE_OFFSET);			\
319 	__addr = __tag_set(__addr, page_kasan_tag(page));		\
320 	((void *)__addr);						\
321 })
322 
323 #define virt_to_page(vaddr)	((struct page *)((__virt_to_pgoff(vaddr)) | VMEMMAP_START))
324 
325 #define _virt_addr_valid(kaddr)	pfn_valid((((u64)(kaddr) & ~PAGE_OFFSET) \
326 					   + PHYS_OFFSET) >> PAGE_SHIFT)
327 #endif
328 #endif
329 
330 #define _virt_addr_is_linear(kaddr)	\
331 	(__tag_reset((u64)(kaddr)) >= PAGE_OFFSET)
332 #define virt_addr_valid(kaddr)		\
333 	(_virt_addr_is_linear(kaddr) && _virt_addr_valid(kaddr))
334 
335 #include <asm-generic/memory_model.h>
336 
337 #endif
338