[apple/xnu.git] / osfmk / mach / arm / vm_param.h

/*
 * Copyright (c) 2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * FILE_ID: vm_param.h
 */

/*
 *	ARM machine dependent virtual memory parameters.
 */

#ifndef	_MACH_ARM_VM_PARAM_H_
#define _MACH_ARM_VM_PARAM_H_

#if defined(KERNEL_PRIVATE) && __ARM_16K_PG__
#include <arm64/proc_reg.h>
#endif

#if !defined (KERNEL) && !defined (__ASSEMBLER__)
#include <mach/vm_page_size.h>
#endif

#define BYTE_SIZE	8	/* byte size in bits */

#if defined (KERNEL)

#ifndef __ASSEMBLER__

#ifdef	__arm__
#define	PAGE_SHIFT_CONST	12
#elif defined(__arm64__)
extern unsigned		PAGE_SHIFT_CONST;
#else
#error Unsupported arch
#endif

#if defined(KERNEL_PRIVATE) && __ARM_16K_PG__
#define PAGE_SHIFT		ARM_PGSHIFT
#else
#define PAGE_SHIFT		PAGE_SHIFT_CONST
#endif
#define PAGE_SIZE		(1 << PAGE_SHIFT)
#define PAGE_MASK		(PAGE_SIZE-1)

#define VM_PAGE_SIZE		PAGE_SIZE

#define	machine_ptob(x)		((x) << PAGE_SHIFT)

/*
 * Defined for the purpose of testing the pmap advertised page
 * size; this does not necessarily match the hardware page size.
 */
#define	TEST_PAGE_SIZE_16K	((PAGE_SHIFT_CONST == 14))
#define	TEST_PAGE_SIZE_4K	((PAGE_SHIFT_CONST == 12))

#endif	/* !__ASSEMBLER__ */

#else

#define PAGE_SHIFT			vm_page_shift
#define PAGE_SIZE			vm_page_size
#define PAGE_MASK			vm_page_mask

#define VM_PAGE_SIZE		vm_page_size

#define	machine_ptob(x)		((x) << PAGE_SHIFT)

#endif

#define PAGE_MAX_SHIFT		14
#define PAGE_MAX_SIZE		(1 << PAGE_MAX_SHIFT)
#define PAGE_MAX_MASK		(PAGE_MAX_SIZE-1)

#define PAGE_MIN_SHIFT		12
#define PAGE_MIN_SIZE		(1 << PAGE_MIN_SHIFT)
#define PAGE_MIN_MASK		(PAGE_MIN_SIZE-1)

#ifndef __ASSEMBLER__

#ifdef  MACH_KERNEL_PRIVATE

#define VM32_SUPPORT		1
#define VM32_MIN_ADDRESS	((vm32_offset_t) 0)
#define VM32_MAX_ADDRESS	((vm32_offset_t) (VM_MAX_PAGE_ADDRESS & 0xFFFFFFFF))
#define VM_MAX_PAGE_ADDRESS	VM_MAX_ADDRESS	/* ARM64_TODO: ?? */

/*
 * kalloc() parameters:
 *
 * Historically kalloc's underlying zones were power-of-2 sizes, with a
 * KALLOC_MINSIZE of 16 bytes.  Thus the allocator ensured that
 * (sizeof == alignof) >= 16 for all kalloc allocations.
 *
 * Today kalloc may use zones with intermediate (small) sizes, constrained by
 * KALLOC_MINSIZE and a minimum alignment, expressed by KALLOC_LOG2_MINALIGN.
 *
 * Note that most dynamically allocated data structures contain more than
 * one int/long/pointer member, so KALLOC_MINSIZE should probably start at 8.
 */

#if defined (__arm__)

#define	KALLOC_MINSIZE		8	/* minimum allocation size */
#define	KALLOC_LOG2_MINALIGN	3	/* log2 minimum alignment */

#elif defined(__arm64__)

#define	KALLOC_MINSIZE		16	/* minimum allocation size */
#define	KALLOC_LOG2_MINALIGN	4	/* log2 minimum alignment */

#else
#error Unsupported arch
#endif

#endif

#if defined (__arm__)

#define VM_MIN_ADDRESS		((vm_address_t) 0x00000000)
#define VM_MAX_ADDRESS		((vm_address_t) 0x80000000)

/* system-wide values */
#define MACH_VM_MIN_ADDRESS	((mach_vm_offset_t) 0)
#define MACH_VM_MAX_ADDRESS	((mach_vm_offset_t) VM_MAX_ADDRESS)

#elif defined (__arm64__)

#define VM_MIN_ADDRESS		((vm_address_t) 0x0000000000000000ULL)
#define VM_MAX_ADDRESS		((vm_address_t) 0x0000000080000000ULL)

/* system-wide values */
#define MACH_VM_MIN_ADDRESS	((mach_vm_offset_t) 0x0ULL)
#define MACH_VM_MAX_ADDRESS	((mach_vm_offset_t) 0x0000000FC0000000ULL)

#else
#error architecture not supported
#endif

#define VM_MAP_MIN_ADDRESS      VM_MIN_ADDRESS
#define VM_MAP_MAX_ADDRESS      VM_MAX_ADDRESS

#ifdef	KERNEL

#if defined (__arm__)
#define VM_KERNEL_POINTER_SIGNIFICANT_BITS  32
#define VM_MIN_KERNEL_ADDRESS	((vm_address_t) 0x80000000)
#define VM_MAX_KERNEL_ADDRESS	((vm_address_t) 0xFFFEFFFF)
#define VM_HIGH_KERNEL_WINDOW	((vm_address_t) 0xFFFE0000)
#elif defined (__arm64__)
/*
 * The minimum and maximum kernel address; some configurations may
 * constrain the address space further.
 */
#define VM_KERNEL_POINTER_SIGNIFICANT_BITS  37
#define VM_MIN_KERNEL_ADDRESS	((vm_address_t) 0xffffffe000000000ULL)
#define VM_MAX_KERNEL_ADDRESS	((vm_address_t) 0xfffffff3ffffffffULL)
#else
#error architecture not supported
#endif

#define VM_MIN_KERNEL_AND_KEXT_ADDRESS	\
				VM_MIN_KERNEL_ADDRESS

#define VM_KERNEL_STRIP_PTR(_v) (_v)

#define VM_KERNEL_ADDRESS(_va)	\
	((((vm_address_t)VM_KERNEL_STRIP_PTR(_va)) >= VM_MIN_KERNEL_ADDRESS) && \
	 (((vm_address_t)VM_KERNEL_STRIP_PTR(_va)) <= VM_MAX_KERNEL_ADDRESS))

#ifdef  MACH_KERNEL_PRIVATE
/*
 *	Physical memory is mapped linearly at an offset virtual memory.
 */
extern unsigned long		gVirtBase, gPhysBase, gPhysSize;

#define isphysmem(a)		(((vm_address_t)(a) - gPhysBase) < gPhysSize)

#if KASAN
/* Increase the stack sizes to account for the redzones that get added to every
 * stack object. */
# define KERNEL_STACK_SIZE	(4*4*4096)
#else
# define KERNEL_STACK_SIZE	(4*4096)
#endif

#define INTSTACK_SIZE		(4*4096)

#ifdef __arm64__
#define EXCEPSTACK_SIZE		(4*4096)
#else
#define FIQSTACK_SIZE		(4096)
#endif

#if defined (__arm__)
#define HIGH_EXC_VECTORS	((vm_address_t) 0xFFFF0000)
#endif

/*
 * TODO: We're hardcoding the expected virtual TEXT base here;
 * that gives us an ugly dependency on a linker argument in
 * the make files.  Clean this up, so we don't hardcode it
 * twice; this is nothing but trouble.
 */
#if defined (__arm__)
#define VM_KERNEL_LINK_ADDRESS  ((vm_address_t) 0x80000000)
#elif defined (__arm64__)
#define VM_KERNEL_LINK_ADDRESS  ((vm_address_t) 0xFFFFFFF007004000)
#else
#error architecture not supported
#endif

#endif	/* MACH_KERNEL_PRIVATE */
#endif	/* KERNEL */

#endif	/* !__ASSEMBLER__ */

#define SWI_SYSCALL	0x80

#endif	/* _MACH_ARM_VM_PARAM_H_ */
Commit	Line	Data
5ba3f43e A	1	/*
	2	* Copyright (c) 2007 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
	5	*
	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28	/*
	29	* FILE_ID: vm_param.h
	30	*/
	31
	32	/*
	33	* ARM machine dependent virtual memory parameters.
	34	*/
	35
	36	#ifndef _MACH_ARM_VM_PARAM_H_
	37	#define _MACH_ARM_VM_PARAM_H_
	38
	39	#if defined(KERNEL_PRIVATE) && __ARM_16K_PG__
	40	#include <arm64/proc_reg.h>
	41	#endif
	42
	43	#if !defined (KERNEL) && !defined (__ASSEMBLER__)
	44	#include <mach/vm_page_size.h>
	45	#endif
	46
	47	#define BYTE_SIZE 8 /* byte size in bits */
	48
	49	#if defined (KERNEL)
	50
	51	#ifndef __ASSEMBLER__
	52
	53	#ifdef __arm__
	54	#define PAGE_SHIFT_CONST 12
	55	#elif defined(__arm64__)
	56	extern unsigned PAGE_SHIFT_CONST;
	57	#else
	58	#error Unsupported arch
	59	#endif
	60
	61	#if defined(KERNEL_PRIVATE) && __ARM_16K_PG__
	62	#define PAGE_SHIFT ARM_PGSHIFT
	63	#else
	64	#define PAGE_SHIFT PAGE_SHIFT_CONST
65	#endif
66	#define PAGE_SIZE (1 << PAGE_SHIFT)
67	#define PAGE_MASK (PAGE_SIZE-1)
68
69	#define VM_PAGE_SIZE PAGE_SIZE
70
71	#define machine_ptob(x) ((x) << PAGE_SHIFT)
72
73	/*
74	* Defined for the purpose of testing the pmap advertised page
75	* size; this does not necessarily match the hardware page size.
76	*/
77	#define TEST_PAGE_SIZE_16K ((PAGE_SHIFT_CONST == 14))
78	#define TEST_PAGE_SIZE_4K ((PAGE_SHIFT_CONST == 12))
79
80	#endif /* !__ASSEMBLER__ */
81
82	#else
83
84	#define PAGE_SHIFT vm_page_shift
85	#define PAGE_SIZE vm_page_size
86	#define PAGE_MASK vm_page_mask
87
88	#define VM_PAGE_SIZE vm_page_size
89
90	#define machine_ptob(x) ((x) << PAGE_SHIFT)
91
92	#endif
93
94	#define PAGE_MAX_SHIFT 14
95	#define PAGE_MAX_SIZE (1 << PAGE_MAX_SHIFT)
96	#define PAGE_MAX_MASK (PAGE_MAX_SIZE-1)
97
98	#define PAGE_MIN_SHIFT 12
99	#define PAGE_MIN_SIZE (1 << PAGE_MIN_SHIFT)
100	#define PAGE_MIN_MASK (PAGE_MIN_SIZE-1)
101
102	#ifndef __ASSEMBLER__
103
104	#ifdef MACH_KERNEL_PRIVATE
105
106	#define VM32_SUPPORT 1
107	#define VM32_MIN_ADDRESS ((vm32_offset_t) 0)
108	#define VM32_MAX_ADDRESS ((vm32_offset_t) (VM_MAX_PAGE_ADDRESS & 0xFFFFFFFF))
109	#define VM_MAX_PAGE_ADDRESS VM_MAX_ADDRESS /* ARM64_TODO: ?? */
110
111	/*
112	* kalloc() parameters:
113	*
114	* Historically kalloc's underlying zones were power-of-2 sizes, with a
115	* KALLOC_MINSIZE of 16 bytes. Thus the allocator ensured that
116	* (sizeof == alignof) >= 16 for all kalloc allocations.
117	*
118	* Today kalloc may use zones with intermediate (small) sizes, constrained by
119	* KALLOC_MINSIZE and a minimum alignment, expressed by KALLOC_LOG2_MINALIGN.
120	*
121	* Note that most dynamically allocated data structures contain more than
122	* one int/long/pointer member, so KALLOC_MINSIZE should probably start at 8.
123	*/
124
125	#if defined (__arm__)
126
127	#define KALLOC_MINSIZE 8 /* minimum allocation size */
128	#define KALLOC_LOG2_MINALIGN 3 /* log2 minimum alignment */
129
130	#elif defined(__arm64__)
131
132	#define KALLOC_MINSIZE 16 /* minimum allocation size */
133	#define KALLOC_LOG2_MINALIGN 4 /* log2 minimum alignment */
134
135	#else
136	#error Unsupported arch
137	#endif
138
139	#endif
140
141	#if defined (__arm__)
142
143	#define VM_MIN_ADDRESS ((vm_address_t) 0x00000000)
144	#define VM_MAX_ADDRESS ((vm_address_t) 0x80000000)
145
146	/* system-wide values */
147	#define MACH_VM_MIN_ADDRESS ((mach_vm_offset_t) 0)
148	#define MACH_VM_MAX_ADDRESS ((mach_vm_offset_t) VM_MAX_ADDRESS)
149
150	#elif defined (__arm64__)
151
152	#define VM_MIN_ADDRESS ((vm_address_t) 0x0000000000000000ULL)
153	#define VM_MAX_ADDRESS ((vm_address_t) 0x0000000080000000ULL)
154
155	/* system-wide values */
156	#define MACH_VM_MIN_ADDRESS ((mach_vm_offset_t) 0x0ULL)
5c9f4661	157	#define MACH_VM_MAX_ADDRESS ((mach_vm_offset_t) 0x0000000FC0000000ULL)
5ba3f43e A	158
	159	#else
	160	#error architecture not supported
	161	#endif
	162
	163	#define VM_MAP_MIN_ADDRESS VM_MIN_ADDRESS
	164	#define VM_MAP_MAX_ADDRESS VM_MAX_ADDRESS
	165
	166	#ifdef KERNEL
	167
	168	#if defined (__arm__)
d9a64523	169	#define VM_KERNEL_POINTER_SIGNIFICANT_BITS 32
5ba3f43e A	170	#define VM_MIN_KERNEL_ADDRESS ((vm_address_t) 0x80000000)
	171	#define VM_MAX_KERNEL_ADDRESS ((vm_address_t) 0xFFFEFFFF)
	172	#define VM_HIGH_KERNEL_WINDOW ((vm_address_t) 0xFFFE0000)
	173	#elif defined (__arm64__)
	174	/*
	175	* The minimum and maximum kernel address; some configurations may
	176	* constrain the address space further.
	177	*/
d9a64523	178	#define VM_KERNEL_POINTER_SIGNIFICANT_BITS 37
5ba3f43e A	179	#define VM_MIN_KERNEL_ADDRESS ((vm_address_t) 0xffffffe000000000ULL)
	180	#define VM_MAX_KERNEL_ADDRESS ((vm_address_t) 0xfffffff3ffffffffULL)
	181	#else
	182	#error architecture not supported
	183	#endif
	184
	185	#define VM_MIN_KERNEL_AND_KEXT_ADDRESS \
	186	VM_MIN_KERNEL_ADDRESS
	187
d9a64523 A	188	#define VM_KERNEL_STRIP_PTR(_v) (_v)
	189
	190	#define VM_KERNEL_ADDRESS(_va) \
	191	((((vm_address_t)VM_KERNEL_STRIP_PTR(_va)) >= VM_MIN_KERNEL_ADDRESS) && \
	192	(((vm_address_t)VM_KERNEL_STRIP_PTR(_va)) <= VM_MAX_KERNEL_ADDRESS))
5ba3f43e A	193
	194	#ifdef MACH_KERNEL_PRIVATE
	195	/*
	196	* Physical memory is mapped linearly at an offset virtual memory.
	197	*/
	198	extern unsigned long gVirtBase, gPhysBase, gPhysSize;
	199
	200	#define isphysmem(a) (((vm_address_t)(a) - gPhysBase) < gPhysSize)
5ba3f43e A	201
	202	#if KASAN
	203	/* Increase the stack sizes to account for the redzones that get added to every
	204	* stack object. */
	205	# define KERNEL_STACK_SIZE (444096)
5ba3f43e A	206	#else
5ba3f43e A	207	# define KERNEL_STACK_SIZE (4*4096)
d9a64523 A	208	#endif
	209
	210	#define INTSTACK_SIZE (4*4096)
	211
	212	#ifdef __arm64__
	213	#define EXCEPSTACK_SIZE (4*4096)
	214	#else
	215	#define FIQSTACK_SIZE (4096)
5ba3f43e A	216	#endif
	217
	218	#if defined (__arm__)
	219	#define HIGH_EXC_VECTORS ((vm_address_t) 0xFFFF0000)
	220	#endif
	221
d9a64523 A	222	/*
	223	* TODO: We're hardcoding the expected virtual TEXT base here;
	224	* that gives us an ugly dependency on a linker argument in
	225	* the make files. Clean this up, so we don't hardcode it
	226	* twice; this is nothing but trouble.
	227	*/
	228	#if defined (__arm__)
	229	#define VM_KERNEL_LINK_ADDRESS ((vm_address_t) 0x80000000)
	230	#elif defined (__arm64__)
	231	#define VM_KERNEL_LINK_ADDRESS ((vm_address_t) 0xFFFFFFF007004000)
	232	#else
	233	#error architecture not supported
	234	#endif
	235
5ba3f43e A	236	#endif /* MACH_KERNEL_PRIVATE */
	237	#endif /* KERNEL */
	238
	239	#endif /* !__ASSEMBLER__ */
	240
	241	#define SWI_SYSCALL 0x80
	242
	243	#endif /* _MACH_ARM_VM_PARAM_H_ */