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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_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_

#ifndef	KERNEL_PRIVATE

#error YOU HAVE MADE A MISTAKE BY INCLUDING THIS FILE;
#error
#error THIS FILE SHOULD NOT BE VISIBLE TO USER PROGRAMS.
#error
#error USE <mach/machine/vm_param.h> TO GET MACHINE-DEPENDENT ADDRESS
#error SPACE AND PAGE SIZE ITEMS.
#error
#error USE <mach/machine/vm_types.h> TO GET TYPE DECLARATIONS USED IN
#error THE MACH KERNEL INTERFACE.
#error
#error IN ALL PROBABILITY, YOU SHOULD GET ALL OF THE TYPES USED IN THE
#error INTERFACE FROM <mach/mach_types.h>

#endif	/* KERNEL_PRIVATE */

#include <mach/machine/vm_param.h>

#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.
 */

/*
 *	All references to the size of a page should be done with PAGE_SIZE
 *	or PAGE_SHIFT.  The fact they are variables is hidden here so that
 *	we can easily make them constant if we so desire.
 */

/*
 *	Regardless whether it is implemented with a constant or a variable,
 *	the PAGE_SIZE is assumed to be a power of two throughout the
 *	virtual memory system implementation.
 */

#ifdef	PAGE_SIZE_FIXED
#define PAGE_SIZE	4096
#define PAGE_SHIFT	12
#define	PAGE_MASK	(PAGE_SIZE-1)
#endif	/* PAGE_SIZE_FIXED */

#ifndef	ASSEMBLER

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

#ifndef	PAGE_SIZE_FIXED
#define PAGE_SIZE	page_size 	/* pagesize in addr units */
#define PAGE_SHIFT	page_shift	/* number of bits to shift for pages */
#define PAGE_MASK	page_mask	/* mask for off in page */

#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 */
#else	/* PAGE_SIZE_FIXED */

#define PAGE_SIZE_64	(unsigned long long)4096
#define PAGE_MASK_64	(PAGE_SIZE_64-1)
#endif	/* PAGE_SIZE_FIXED */

/*
 *	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


/*
 *	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.
 */

#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) & ~((signed)PAGE_MASK))
#define trunc_page_64(x) ((uint64_t)(x) & ~((signed)PAGE_MASK))


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

#if 1
#define round_page(x) (((uint32_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
#define trunc_page(x) ((uint32_t)(x) & ~((signed)PAGE_MASK))
#else
#define round_page(x) (0UL = 0)
#define trunc_page(x) (0UL = 0)
#endif

/*
 *      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 */
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 */

/* 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	/* _MACH_VM_PARAM_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* @OSF_COPYRIGHT@
	27	*/
	28	/*
	29	* Mach Operating System
	30	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	31	* All Rights Reserved.
	32	*
	33	* Permission to use, copy, modify and distribute this software and its
	34	* documentation is hereby granted, provided that both the copyright
	35	* notice and this permission notice appear in all copies of the
	36	* software, derivative works or modified versions, and any portions
	37	* thereof, and that both notices appear in supporting documentation.
	38	*
	39	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	40	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	41	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	42	*
	43	* Carnegie Mellon requests users of this software to return to
	44	*
	45	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	46	* School of Computer Science
	47	* Carnegie Mellon University
	48	* Pittsburgh PA 15213-3890
	49	*
	50	* any improvements or extensions that they make and grant Carnegie Mellon
	51	* the rights to redistribute these changes.
	52	*/
	53	/*
	54	*/
	55	/*
	56	* File: mach/vm_param.h
	57	* Author: Avadis Tevanian, Jr., Michael Wayne Young
	58	* Date: 1985
	59	*
	60	* Machine independent virtual memory parameters.
	61	*
	62	*/
	63
	64	#ifndef _MACH_VM_PARAM_H_
	65	#define _MACH_VM_PARAM_H_
	66
	67	#ifndef KERNEL_PRIVATE
	68
	69	#error YOU HAVE MADE A MISTAKE BY INCLUDING THIS FILE;
	70	#error
	71	#error THIS FILE SHOULD NOT BE VISIBLE TO USER PROGRAMS.
	72	#error
	73	#error USE <mach/machine/vm_param.h> TO GET MACHINE-DEPENDENT ADDRESS
	74	#error SPACE AND PAGE SIZE ITEMS.
	75	#error
	76	#error USE <mach/machine/vm_types.h> TO GET TYPE DECLARATIONS USED IN
	77	#error THE MACH KERNEL INTERFACE.
	78	#error
	79	#error IN ALL PROBABILITY, YOU SHOULD GET ALL OF THE TYPES USED IN THE
	80	#error INTERFACE FROM <mach/mach_types.h>
	81
	82	#endif /* KERNEL_PRIVATE */
	83
	84	#include <mach/machine/vm_param.h>
90556fb8	85
55e303ae	86	#ifndef ASSEMBLER
90556fb8	87	#include <mach/vm_types.h>
55e303ae	88	#endif /* ASSEMBLER */
1c79356b A	89
	90	/*
	91	* The machine independent pages are refered to as PAGES. A page
	92	* is some number of hardware pages, depending on the target machine.
	93	*/
	94
	95	/*
	96	* All references to the size of a page should be done with PAGE_SIZE
	97	* or PAGE_SHIFT. The fact they are variables is hidden here so that
	98	* we can easily make them constant if we so desire.
	99	*/
	100
	101	/*
	102	* Regardless whether it is implemented with a constant or a variable,
	103	* the PAGE_SIZE is assumed to be a power of two throughout the
	104	* virtual memory system implementation.
	105	*/
	106
55e303ae A	107	#ifdef PAGE_SIZE_FIXED
	108	#define PAGE_SIZE 4096
	109	#define PAGE_SHIFT 12
	110	#define PAGE_MASK (PAGE_SIZE-1)
	111	#endif /* PAGE_SIZE_FIXED */
	112
	113	#ifndef ASSEMBLER
	114
1c79356b A	115	extern vm_size_t page_size;
	116	extern vm_size_t page_mask;
	117	extern int page_shift;
	118
55e303ae	119	#ifndef PAGE_SIZE_FIXED
1c79356b A	120	#define PAGE_SIZE page_size /* pagesize in addr units */
	121	#define PAGE_SHIFT page_shift /* number of bits to shift for pages */
	122	#define PAGE_MASK page_mask /* mask for off in page */
	123
	124	#define PAGE_SIZE_64 (unsigned long long)page_size /* pagesize in addr units */
	125	#define PAGE_MASK_64 (unsigned long long)page_mask /* mask for off in page */
	126	#else /* PAGE_SIZE_FIXED */
55e303ae	127
1c79356b A	128	#define PAGE_SIZE_64 (unsigned long long)4096
	129	#define PAGE_MASK_64 (PAGE_SIZE_64-1)
	130	#endif /* PAGE_SIZE_FIXED */
	131
90556fb8 A	132	/*
	133	* Convert addresses to pages and vice versa. No rounding is used.
	134	* The atop_32 and ptoa_32 macros should not be use on 64 bit types.
	135	* The round_page_64 and trunc_page_64 macros should be used instead.
	136	*/
	137
	138	#define atop_32(x) ((uint32_t)(x) >> PAGE_SHIFT)
	139	#define ptoa_32(x) ((uint32_t)(x) << PAGE_SHIFT)
	140	#define atop_64(x) ((uint64_t)(x) >> PAGE_SHIFT)
	141	#define ptoa_64(x) ((uint64_t)(x) << PAGE_SHIFT)
	142
1c79356b	143	/*
90556fb8 A	144	* While the following block is enabled, the legacy atop and ptoa
	145	* macros will behave correctly. If not, they will generate
	146	* invalid lvalue errors.
d7e50217 A	147	*/
d7e50217 A	148
90556fb8 A	149	#if 1
	150	#define atop(x) ((uint32_t)(x) >> PAGE_SHIFT)
	151	#define ptoa(x) ((uint32_t)(x) << PAGE_SHIFT)
	152	#else
	153	#define atop(x) (0UL = 0)
	154	#define ptoa(x) (0UL = 0)
	155	#endif
	156
1c79356b A	157
	158	/*
	159	* Round off or truncate to the nearest page. These will work
	160	* for either addresses or counts. (i.e. 1 byte rounds to 1 page
90556fb8 A	161	* bytes. The round_page_32 and trunc_page_32 macros should not be
	162	* use on 64 bit types. The round_page_64 and trunc_page_64 macros
	163	* should be used instead.
	164	*/
	165
	166	#define round_page_32(x) (((uint32_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
	167	#define trunc_page_32(x) ((uint32_t)(x) & ~((signed)PAGE_MASK))
	168	#define round_page_64(x) (((uint64_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
	169	#define trunc_page_64(x) ((uint64_t)(x) & ~((signed)PAGE_MASK))
	170
	171
	172	/*
	173	* While the following block is enabled, the legacy round_page
	174	* and trunc_page macros will behave correctly. If not, they will
	175	* generate invalid lvalue errors.
1c79356b A	176	*/
1c79356b A	177
90556fb8 A	178	#if 1
	179	#define round_page(x) (((uint32_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
	180	#define trunc_page(x) ((uint32_t)(x) & ~((signed)PAGE_MASK))
	181	#else
	182	#define round_page(x) (0UL = 0)
	183	#define trunc_page(x) (0UL = 0)
	184	#endif
	185
	186	/*
	187	* Enable the following block to find uses of xxx_32 macros that should
	188	* be xxx_64. These macros only work in C code, not C++. The resulting
	189	* binaries are not functional. Look for invalid lvalue errors in
	190	* the compiler output.
	191	*
	192	* Enabling the following block will also find use of the xxx_64 macros
	193	* that have been passed pointers. The parameters should be case to an
	194	* unsigned long type first. Look for invalid operands to binary + error
	195	* in the compiler output.
	196	*/
1c79356b	197
90556fb8 A	198	#if 0
	199	#undef atop_32
	200	#undef ptoa_32
	201	#undef round_page_32
	202	#undef trunc_page_32
	203	#undef atop_64
	204	#undef ptoa_64
	205	#undef round_page_64
	206	#undef trunc_page_64
	207
	208	#ifndef __cplusplus
	209
	210	#define atop_32(x) \
	211	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	212	((long )0), \
	213	(0UL)) = 0)
	214
	215	#define ptoa_32(x) \
	216	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	217	((long )0), \
	218	(0UL)) = 0)
	219
	220	#define round_page_32(x) \
	221	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	222	((long )0), \
	223	(0UL)) = 0)
	224
	225	#define trunc_page_32(x) \
	226	(__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
	227	((long )0), \
	228	(0UL)) = 0)
	229	#else
	230
	231	#define atop_32(x) (0)
	232	#define ptoa_32(x) (0)
	233	#define round_page_32(x) (0)
	234	#define trunc_page_32(x) (0)
	235
	236	#endif /* ! __cplusplus */
	237
	238	#define atop_64(x) ((uint64_t)((x) + (uint8_t *)0))
	239	#define ptoa_64(x) ((uint64_t)((x) + (uint8_t *)0))
	240	#define round_page_64(x) ((uint64_t)((x) + (uint8_t *)0))
	241	#define trunc_page_64(x) ((uint64_t)((x) + (uint8_t *)0))
	242
	243	#endif
1c79356b A	244
	245	/*
	246	* Determine whether an address is page-aligned, or a count is
	247	* an exact page multiple.
	248	*/
	249
	250	#define page_aligned(x) ((((vm_object_offset_t) (x)) & PAGE_MASK) == 0)
	251
55e303ae	252	extern vm_size_t mem_size; /* 32-bit size of memory - limited by maxmem - deprecated */
43866e37	253	extern uint64_t max_mem; /* 64-bit size of memory - limited by maxmem */
55e303ae A	254	extern uint64_t mem_actual; /* 64-bit size of memory - not limited by maxmem */
	255	extern uint64_t sane_size; /* Memory size to use for defaults calculations */
	256	extern addr64_t vm_last_addr; /* Highest kernel virtual address known to the VM system */
	257
	258	/* We need a way to get rid of compiler warnings when we cast from */
	259	/* a 64 bit value to an address that is 32 bits. */
	260	/* We know at this point the cast is harmless but sometime in */
	261	/* the future it may not be. */
	262	/* When size of an int is no longer equal to size of uintptr_t then */
	263	/* the compile will fail and we know we need to fix our cast. */
	264	#include <stdint.h>
	265	#ifndef __CAST_DOWN_CHECK
	266	#define __CAST_DOWN_CHECK
	267	typedef char __NEED_TO_CHANGE_CAST_DOWN[ sizeof(uintptr_t) == sizeof(int) ? 0 : -1 ];
	268	#define CAST_DOWN( type, addr ) ( ((type)((uintptr_t) (addr))) )
	269	#endif /* __CAST_DOWN_CHECK */
1c79356b A	270
	271	#endif /* ASSEMBLER */
	272	#endif /* _MACH_VM_PARAM_H_ */