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

/*
 * Copyright (c) 2000-2006 Apple Computer, 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@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	File:	mach/vm_param.h
 *	Author:	Avadis Tevanian, Jr., Michael Wayne Young
 *	Date:	1985
 *
 *	Machine independent virtual memory parameters.
 *
 */

#ifndef	_MACH_VM_PARAM_H_
#define _MACH_VM_PARAM_H_

#include <mach/machine/vm_param.h>

#ifdef	KERNEL

#ifndef	ASSEMBLER
#include <mach/vm_types.h>
#endif	/* ASSEMBLER */

/*
 *	The machine independent pages are refered to as PAGES.  A page
 *	is some number of hardware pages, depending on the target machine.
 */

#ifndef	ASSEMBLER

#define PAGE_SIZE_64 (unsigned long long)PAGE_SIZE		/* pagesize in addr units */
#define PAGE_MASK_64 (unsigned long long)PAGE_MASK		/* mask for off in page */

/*
 *	Convert addresses to pages and vice versa.  No rounding is used.
 *      The atop_32 and ptoa_32 macros should not be use on 64 bit types.
 *      The round_page_64 and trunc_page_64 macros should be used instead.
 */

#define atop_32(x) ((uint32_t)(x) >> PAGE_SHIFT)
#define ptoa_32(x) ((uint32_t)(x) << PAGE_SHIFT)
#define atop_64(x) ((uint64_t)(x) >> PAGE_SHIFT)
#define ptoa_64(x) ((uint64_t)(x) << PAGE_SHIFT)

/*
 *      While the following block is enabled, the legacy atop and ptoa
 *      macros will behave correctly.  If not, they will generate
 *      invalid lvalue errors.
 */

#if 1
#define atop(x)	((uint32_t)(x) >> PAGE_SHIFT)
#define ptoa(x)	((uint32_t)(x) << PAGE_SHIFT)
#else
#define atop(x) (0UL = 0)
#define ptoa(x) (0UL = 0)
#endif

/*
 *	Page-size rounding macros for the Public fixed-width VM types.
 */
#define mach_vm_round_page(x) (((mach_vm_offset_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
#define mach_vm_trunc_page(x) ((mach_vm_offset_t)(x) & ~((signed)PAGE_MASK))

#define memory_object_round_page(x) (((memory_object_offset_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
#define memory_object_trunc_page(x) ((memory_object_offset_t)(x) & ~((signed)PAGE_MASK))

/*
 *	Rounding macros for the legacy (scalable with the current task's
 *	address space size) VM types.
 */

#define round_page(x) (((vm_offset_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
#define trunc_page(x) ((vm_offset_t)(x) & ~((signed)PAGE_MASK))

/*
 *	Round off or truncate to the nearest page.  These will work
 *	for either addresses or counts.  (i.e. 1 byte rounds to 1 page
 *	bytes.  The round_page_32 and trunc_page_32 macros should not be
 *      use on 64 bit types.  The round_page_64 and trunc_page_64 macros
 *      should be used instead.
 *
 *	These should only be used in the rare case the size of the address
 *	or length is hard-coded as 32 or 64 bit.  Otherwise, the macros
 *	associated with the specific VM type should be used.
 */

#define round_page_32(x) (((uint32_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
#define trunc_page_32(x) ((uint32_t)(x) & ~((signed)PAGE_MASK))
#define round_page_64(x) (((uint64_t)(x) + PAGE_MASK_64) & ~((signed)PAGE_MASK_64))
#define trunc_page_64(x) ((uint64_t)(x) & ~((signed)PAGE_MASK_64))


/*
 *      Enable the following block to find uses of xxx_32 macros that should
 *      be xxx_64.  These macros only work in C code, not C++.  The resulting
 *      binaries are not functional.  Look for invalid lvalue errors in
 *      the compiler output.
 *
 *      Enabling the following block will also find use of the xxx_64 macros
 *      that have been passed pointers.  The parameters should be case to an
 *      unsigned long type first.  Look for invalid operands to binary + error
 *      in the compiler output.
 */

#if 0
#undef atop_32
#undef ptoa_32
#undef round_page_32
#undef trunc_page_32
#undef atop_64
#undef ptoa_64
#undef round_page_64
#undef trunc_page_64

#ifndef __cplusplus

#define atop_32(x) \
    (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
        (*(long *)0), \
        (0UL)) = 0)

#define ptoa_32(x) \
    (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
        (*(long *)0), \
        (0UL)) = 0)

#define round_page_32(x) \
    (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
        (*(long *)0), \
        (0UL)) = 0)

#define trunc_page_32(x) \
    (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
        (*(long *)0), \
        (0UL)) = 0)
#else

#define atop_32(x) (0)
#define ptoa_32(x) (0)
#define round_page_32(x) (0)
#define trunc_page_32(x) (0)

#endif /* ! __cplusplus */

#define atop_64(x) ((uint64_t)((x) + (uint8_t *)0))
#define ptoa_64(x) ((uint64_t)((x) + (uint8_t *)0))
#define round_page_64(x) ((uint64_t)((x) + (uint8_t *)0))
#define trunc_page_64(x) ((uint64_t)((x) + (uint8_t *)0))

#endif

/*
 *	Determine whether an address is page-aligned, or a count is
 *	an exact page multiple.
 */

#define	page_aligned(x)	((((vm_object_offset_t) (x)) & PAGE_MASK) == 0)

extern vm_size_t	mem_size;		/* 32-bit size of memory - limited by maxmem - deprecated */
extern uint64_t		max_mem;		/* 64-bit size of memory - limited by maxmem */

#ifdef	XNU_KERNEL_PRIVATE

extern uint64_t		mem_actual;		/* 64-bit size of memory - not limited by maxmem */
extern uint64_t		sane_size;		/* Memory size to use for defaults calculations */
extern addr64_t 	vm_last_addr;	/* Highest kernel virtual address known to the VM system */

extern const vm_offset_t	vm_min_kernel_address;
extern const vm_offset_t	vm_max_kernel_address;

#endif	/* XNU_KERNEL_PRIVATE */

extern vm_size_t	page_size;
extern vm_size_t	page_mask;
extern int			page_shift;

/* We need a way to get rid of compiler warnings when we cast from   */
/* a 64 bit value to an address that is 32 bits.                     */
/* We know at this point the cast is harmless but sometime in        */
/* the future it may not be.                                         */
/* When size of an int is no longer equal to size of uintptr_t then  */
/* the compile will fail and we know we need to fix our cast.		 */
#include <stdint.h>
#ifndef __CAST_DOWN_CHECK
#define __CAST_DOWN_CHECK
typedef char __NEED_TO_CHANGE_CAST_DOWN[ sizeof(uintptr_t) == sizeof(int) ? 0 : -1 ];
#define CAST_DOWN( type, addr )  ( ((type)((uintptr_t) (addr))) ) 
#endif /* __CAST_DOWN_CHECK */

#endif	/* ASSEMBLER */

#endif	/* KERNEL */

#endif	/* _MACH_VM_PARAM_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	34	* All Rights Reserved.
	35	*
	36	* Permission to use, copy, modify and distribute this software and its
	37	* documentation is hereby granted, provided that both the copyright
	38	* notice and this permission notice appear in all copies of the
	39	* software, derivative works or modified versions, and any portions
	40	* thereof, and that both notices appear in supporting documentation.
	41	*
	42	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	43	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	44	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	45	*
	46	* Carnegie Mellon requests users of this software to return to
	47	*
	48	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	49	* School of Computer Science
	50	* Carnegie Mellon University
	51	* Pittsburgh PA 15213-3890
	52	*
	53	* any improvements or extensions that they make and grant Carnegie Mellon
	54	* the rights to redistribute these changes.
	55	*/
	56	/*
	57	*/
	58	/*
	59	* File: mach/vm_param.h
	60	* Author: Avadis Tevanian, Jr., Michael Wayne Young
	61	* Date: 1985
	62	*
	63	* Machine independent virtual memory parameters.
	64	*
	65	*/
	66
	67	#ifndef _MACH_VM_PARAM_H_
	68	#define _MACH_VM_PARAM_H_
	69
1c79356b	70	#include <mach/machine/vm_param.h>
90556fb8	71
91447636 A	72	#ifdef KERNEL
91447636 A	73
55e303ae	74	#ifndef ASSEMBLER
90556fb8	75	#include <mach/vm_types.h>
55e303ae	76	#endif /* ASSEMBLER */
1c79356b A	77
	78	/*
	79	* The machine independent pages are refered to as PAGES. A page
	80	* is some number of hardware pages, depending on the target machine.
	81	*/
	82
55e303ae A	83	#ifndef ASSEMBLER
55e303ae A	84
91447636 A	85	#define PAGE_SIZE_64 (unsigned long long)PAGE_SIZE /* pagesize in addr units */
91447636 A	86	#define PAGE_MASK_64 (unsigned long long)PAGE_MASK /* mask for off in page */
1c79356b	87
90556fb8 A	88	/*
	89	* Convert addresses to pages and vice versa. No rounding is used.
	90	* The atop_32 and ptoa_32 macros should not be use on 64 bit types.
	91	* The round_page_64 and trunc_page_64 macros should be used instead.
	92	*/
	93
	94	#define atop_32(x) ((uint32_t)(x) >> PAGE_SHIFT)
	95	#define ptoa_32(x) ((uint32_t)(x) << PAGE_SHIFT)
	96	#define atop_64(x) ((uint64_t)(x) >> PAGE_SHIFT)
	97	#define ptoa_64(x) ((uint64_t)(x) << PAGE_SHIFT)
	98
1c79356b	99	/*
90556fb8 A	100	* While the following block is enabled, the legacy atop and ptoa
	101	* macros will behave correctly. If not, they will generate
	102	* invalid lvalue errors.
d7e50217 A	103	*/
d7e50217 A	104
90556fb8 A	105	#if 1
	106	#define atop(x) ((uint32_t)(x) >> PAGE_SHIFT)
	107	#define ptoa(x) ((uint32_t)(x) << PAGE_SHIFT)
	108	#else
	109	#define atop(x) (0UL = 0)
	110	#define ptoa(x) (0UL = 0)
	111	#endif
	112
91447636 A	113	/*
	114	* Page-size rounding macros for the Public fixed-width VM types.
	115	*/
	116	#define mach_vm_round_page(x) (((mach_vm_offset_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
	117	#define mach_vm_trunc_page(x) ((mach_vm_offset_t)(x) & ~((signed)PAGE_MASK))
	118
	119	#define memory_object_round_page(x) (((memory_object_offset_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
	120	#define memory_object_trunc_page(x) ((memory_object_offset_t)(x) & ~((signed)PAGE_MASK))
	121
	122	/*
	123	* Rounding macros for the legacy (scalable with the current task's
	124	* address space size) VM types.
	125	*/
	126
	127	#define round_page(x) (((vm_offset_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
	128	#define trunc_page(x) ((vm_offset_t)(x) & ~((signed)PAGE_MASK))
1c79356b A	129
	130	/*
	131	* Round off or truncate to the nearest page. These will work
	132	* for either addresses or counts. (i.e. 1 byte rounds to 1 page
90556fb8 A	133	* bytes. The round_page_32 and trunc_page_32 macros should not be
	134	* use on 64 bit types. The round_page_64 and trunc_page_64 macros
	135	* should be used instead.
91447636 A	136	*
	137	* These should only be used in the rare case the size of the address
	138	* or length is hard-coded as 32 or 64 bit. Otherwise, the macros
	139	* associated with the specific VM type should be used.
90556fb8 A	140	*/
	141
	142	#define round_page_32(x) (((uint32_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
	143	#define trunc_page_32(x) ((uint32_t)(x) & ~((signed)PAGE_MASK))
2d21ac55 A	144	#define round_page_64(x) (((uint64_t)(x) + PAGE_MASK_64) & ~((signed)PAGE_MASK_64))
2d21ac55 A	145	#define trunc_page_64(x) ((uint64_t)(x) & ~((signed)PAGE_MASK_64))
90556fb8 A	146
90556fb8 A	147
90556fb8 A	148	/*
	149	* Enable the following block to find uses of xxx_32 macros that should
	150	* be xxx_64. These macros only work in C code, not C++. The resulting
	151	* binaries are not functional. Look for invalid lvalue errors in
	152	* the compiler output.
	153	*
	154	* Enabling the following block will also find use of the xxx_64 macros
	155	* that have been passed pointers. The parameters should be case to an
	156	* unsigned long type first. Look for invalid operands to binary + error
	157	* in the compiler output.
	158	*/
1c79356b	159
90556fb8 A	160	#if 0
	161	#undef atop_32
	162	#undef ptoa_32
	163	#undef round_page_32
	164	#undef trunc_page_32
	165	#undef atop_64
	166	#undef ptoa_64
	167	#undef round_page_64
	168	#undef trunc_page_64
	169
	170	#ifndef __cplusplus
	171
	172	#define atop_32(x) \
	173	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	174	((long )0), \
	175	(0UL)) = 0)
	176
	177	#define ptoa_32(x) \
	178	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	179	((long )0), \
	180	(0UL)) = 0)
	181
	182	#define round_page_32(x) \
	183	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	184	((long )0), \
	185	(0UL)) = 0)
	186
	187	#define trunc_page_32(x) \
	188	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	189	((long )0), \
	190	(0UL)) = 0)
	191	#else
	192
	193	#define atop_32(x) (0)
	194	#define ptoa_32(x) (0)
	195	#define round_page_32(x) (0)
	196	#define trunc_page_32(x) (0)
	197
	198	#endif /* ! __cplusplus */
	199
	200	#define atop_64(x) ((uint64_t)((x) + (uint8_t *)0))
	201	#define ptoa_64(x) ((uint64_t)((x) + (uint8_t *)0))
	202	#define round_page_64(x) ((uint64_t)((x) + (uint8_t *)0))
	203	#define trunc_page_64(x) ((uint64_t)((x) + (uint8_t *)0))
	204
	205	#endif
1c79356b A	206
	207	/*
	208	* Determine whether an address is page-aligned, or a count is
	209	* an exact page multiple.
	210	*/
	211
	212	#define page_aligned(x) ((((vm_object_offset_t) (x)) & PAGE_MASK) == 0)
	213
55e303ae	214	extern vm_size_t mem_size; /* 32-bit size of memory - limited by maxmem - deprecated */
91447636 A	215	extern uint64_t max_mem; /* 64-bit size of memory - limited by maxmem */
	216
	217	#ifdef XNU_KERNEL_PRIVATE
	218
	219	extern uint64_t mem_actual; /* 64-bit size of memory - not limited by maxmem */
	220	extern uint64_t sane_size; /* Memory size to use for defaults calculations */
55e303ae A	221	extern addr64_t vm_last_addr; /* Highest kernel virtual address known to the VM system */
55e303ae A	222
0c530ab8 A	223	extern const vm_offset_t vm_min_kernel_address;
	224	extern const vm_offset_t vm_max_kernel_address;
	225
91447636 A	226	#endif /* XNU_KERNEL_PRIVATE */
	227
	228	extern vm_size_t page_size;
	229	extern vm_size_t page_mask;
	230	extern int page_shift;
	231
55e303ae A	232	/* We need a way to get rid of compiler warnings when we cast from */
	233	/* a 64 bit value to an address that is 32 bits. */
	234	/* We know at this point the cast is harmless but sometime in */
	235	/* the future it may not be. */
	236	/* When size of an int is no longer equal to size of uintptr_t then */
	237	/* the compile will fail and we know we need to fix our cast. */
	238	#include <stdint.h>
	239	#ifndef __CAST_DOWN_CHECK
	240	#define __CAST_DOWN_CHECK
	241	typedef char __NEED_TO_CHANGE_CAST_DOWN[ sizeof(uintptr_t) == sizeof(int) ? 0 : -1 ];
	242	#define CAST_DOWN( type, addr ) ( ((type)((uintptr_t) (addr))) )
	243	#endif /* __CAST_DOWN_CHECK */
1c79356b A	244
1c79356b A	245	#endif /* ASSEMBLER */
91447636 A	246
	247	#endif /* KERNEL */
	248
1c79356b	249	#endif /* _MACH_VM_PARAM_H_ */