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

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 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_

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


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

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