/* * 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 */ #endif /* ASSEMBLER */ #endif /* _MACH_VM_PARAM_H_ */