X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/90556fb8d47e7b68fd301dde9dbb3ae7495cf323..0a7de7458d150b5d4dffc935ba399be265ef0a1a:/osfmk/mach/vm_param.h?ds=sidebyside diff --git a/osfmk/mach/vm_param.h b/osfmk/mach/vm_param.h index 7ec383ca2..2bb038e21 100644 --- a/osfmk/mach/vm_param.h +++ b/osfmk/mach/vm_param.h @@ -1,49 +1,55 @@ /* - * Copyright (c) 2000 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 + * 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 OR NON-INFRINGEMENT. Please see the - * License for the specific language governing rights and limitations - * under the License. - * - * @APPLE_LICENSE_HEADER_END@ + * 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. */ @@ -58,67 +64,29 @@ * */ -#ifndef _MACH_VM_PARAM_H_ +#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 TO GET MACHINE-DEPENDENT ADDRESS -#error SPACE AND PAGE SIZE ITEMS. -#error -#error USE 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 - -#endif /* KERNEL_PRIVATE */ - #include +#ifdef KERNEL + +#ifndef ASSEMBLER #include +#endif /* ASSEMBLER */ + +#include +#include /* * 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. - */ - -#ifndef PAGE_SIZE_FIXED -extern vm_size_t page_size; -extern vm_size_t page_mask; -extern int page_shift; - -#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 */ +#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 */ -#else /* PAGE_SIZE_FIXED */ -#define PAGE_SIZE 4096 -#define PAGE_SHIFT 12 -#define PAGE_MASK (PAGE_SIZE-1) -#define PAGE_SIZE_64 (unsigned long long)4096 -#define PAGE_MASK_64 (PAGE_SIZE_64-1) -#endif /* PAGE_SIZE_FIXED */ - -#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. @@ -131,6 +99,9 @@ extern int page_shift; #define atop_64(x) ((uint64_t)(x) >> PAGE_SHIFT) #define ptoa_64(x) ((uint64_t)(x) << PAGE_SHIFT) +#define atop_kernel(x) ((vm_address_t)(x) >> PAGE_SHIFT) +#define ptoa_kernel(x) ((vm_address_t)(x) << PAGE_SHIFT) + /* * While the following block is enabled, the legacy atop and ptoa * macros will behave correctly. If not, they will generate @@ -138,13 +109,41 @@ extern int page_shift; */ #if 1 -#define atop(x) ((uint32_t)(x) >> PAGE_SHIFT) -#define ptoa(x) ((uint32_t)(x) << PAGE_SHIFT) +#define atop(x) ((vm_address_t)(x) >> PAGE_SHIFT) +#define ptoa(x) ((vm_address_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 round_page_overflow(in, out) __os_warn_unused(({ \ + bool __ovr = os_add_overflow(in, (__typeof__(*out))PAGE_MASK, out); \ + *out &= ~((__typeof__(*out))PAGE_MASK); \ + __ovr; \ + })) + +static inline int OS_WARN_RESULT +mach_vm_round_page_overflow(mach_vm_offset_t in, mach_vm_offset_t *out) +{ + return round_page_overflow(in, out); +} + +#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) & ~((vm_offset_t)PAGE_MASK)) +#define trunc_page(x) ((vm_offset_t)(x) & ~((vm_offset_t)PAGE_MASK)) /* * Round off or truncate to the nearest page. These will work @@ -152,27 +151,16 @@ extern int page_shift; * 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)) - - -/* - * 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 +#define round_page_32(x) (((uint32_t)(x) + PAGE_MASK) & ~((uint32_t)PAGE_MASK)) +#define trunc_page_32(x) ((uint32_t)(x) & ~((uint32_t)PAGE_MASK)) +#define round_page_64(x) (((uint64_t)(x) + PAGE_MASK_64) & ~((uint64_t)PAGE_MASK_64)) +#define trunc_page_64(x) ((uint64_t)(x) & ~((uint64_t)PAGE_MASK_64)) /* * Enable the following block to find uses of xxx_32 macros that should @@ -200,23 +188,23 @@ extern int page_shift; #define atop_32(x) \ (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \ - (*(long *)0), \ - (0UL)) = 0) + (*(long *)0), \ + (0UL)) = 0) #define ptoa_32(x) \ (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \ - (*(long *)0), \ - (0UL)) = 0) + (*(long *)0), \ + (0UL)) = 0) #define round_page_32(x) \ (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \ - (*(long *)0), \ - (0UL)) = 0) + (*(long *)0), \ + (0UL)) = 0) #define trunc_page_32(x) \ (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \ - (*(long *)0), \ - (0UL)) = 0) + (*(long *)0), \ + (0UL)) = 0) #else #define atop_32(x) (0) @@ -238,9 +226,197 @@ extern int page_shift; * an exact page multiple. */ -#define page_aligned(x) ((((vm_object_offset_t) (x)) & PAGE_MASK) == 0) +#define page_aligned(x) (((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 */ + +/* + * The default pager does not handle 64-bit offsets inside its objects, + * so this limits the size of anonymous memory objects to 4GB minus 1 page. + * When we need to allocate a chunk of anonymous memory over that size, + * we have to allocate more than one chunk. + */ +#define ANON_MAX_SIZE 0xFFFFF000ULL +/* + * Work-around for + * Break large anonymous memory areas into 128MB chunks to alleviate + * the cost of copying when copy-on-write is not possible because a small + * portion of it being wired. + */ +#define ANON_CHUNK_SIZE (128ULL * 1024 * 1024) /* 128MB */ + +/* + * The 'medium' malloc allocator would like its regions + * to be chunked up into MALLOC_MEDIUM_CHUNK_SIZE chunks + * and backed by different objects. This avoids contention + * on a single large object and showed solid improvements on high + * core machines with workloads involving video and graphics processing. + */ +#define MALLOC_MEDIUM_CHUNK_SIZE (8ULL * 1024 * 1024) /* 8 MB */ + +#ifdef XNU_KERNEL_PRIVATE + +#include + +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; + +extern vm_offset_t vm_kernel_stext; +extern vm_offset_t vm_kernel_etext; +extern vm_offset_t vm_kernel_slid_base; +extern vm_offset_t vm_kernel_slid_top; +extern vm_offset_t vm_kernel_slide; +extern vm_offset_t vm_kernel_addrperm; +extern vm_offset_t vm_kext_base; +extern vm_offset_t vm_kext_top; +extern vm_offset_t vm_kernel_base; +extern vm_offset_t vm_kernel_top; +extern vm_offset_t vm_hib_base; + +extern vm_offset_t vm_kernel_builtinkmod_text; +extern vm_offset_t vm_kernel_builtinkmod_text_end; + +#define VM_KERNEL_IS_SLID(_o) \ + (((vm_offset_t)VM_KERNEL_STRIP_PTR(_o) >= vm_kernel_slid_base) && \ + ((vm_offset_t)VM_KERNEL_STRIP_PTR(_o) < vm_kernel_slid_top)) + +#define VM_KERNEL_SLIDE(_u) ((vm_offset_t)(_u) + vm_kernel_slide) + +/* + * The following macros are to be used when exposing kernel addresses to + * userspace via any of the various debug or info facilities that might exist + * (e.g. stackshot, proc_info syscall, etc.). It is important to understand + * the goal of each macro and choose the right one depending on what you are + * trying to do. Misuse of these macros can result in critical data leaks + * which in turn lead to all sorts of system vulnerabilities. It is invalid to + * call these macros on a non-kernel address (NULL is allowed). + * + * VM_KERNEL_UNSLIDE: + * Use this macro when you are exposing an address to userspace which is + * *guaranteed* to be a "static" kernel or kext address (i.e. coming from text + * or data sections). These are the addresses which get "slid" via ASLR on + * kernel or kext load, and it's precisely the slide value we are trying to + * protect from userspace. + * + * VM_KERNEL_ADDRHIDE: + * Use when exposing an address for internal purposes: debugging, tracing, + * etc. The address will be unslid if necessary. Other addresses will be + * hidden on customer builds, and unmodified on internal builds. + * + * VM_KERNEL_ADDRHASH: + * Use this macro when exposing a kernel address to userspace on customer + * builds. The address can be from the static kernel or kext regions, or the + * kernel heap. The address will be unslid or hashed as appropriate. + * + * + * ** SECURITY WARNING: The following macros can leak kernel secrets. + * Use *only* in performance *critical* code. + * + * VM_KERNEL_ADDRPERM: + * VM_KERNEL_UNSLIDE_OR_PERM: + * Use these macros when exposing a kernel address to userspace on customer + * builds. The address can be from the static kernel or kext regions, or the + * kernel heap. The address will be unslid or permuted as appropriate. + * + * Nesting of these macros should be considered invalid. + */ + +__BEGIN_DECLS +extern vm_offset_t vm_kernel_addrhash(vm_offset_t addr); +__END_DECLS + +#define __DO_UNSLIDE(_v) ((vm_offset_t)VM_KERNEL_STRIP_PTR(_v) - vm_kernel_slide) + +#if DEBUG || DEVELOPMENT +#define VM_KERNEL_ADDRHIDE(_v) (VM_KERNEL_IS_SLID(_v) ? __DO_UNSLIDE(_v) : (vm_address_t)VM_KERNEL_STRIP_PTR(_v)) +#else +#define VM_KERNEL_ADDRHIDE(_v) (VM_KERNEL_IS_SLID(_v) ? __DO_UNSLIDE(_v) : (vm_address_t)0) +#endif /* DEBUG || DEVELOPMENT */ + +#define VM_KERNEL_ADDRHASH(_v) vm_kernel_addrhash((vm_offset_t)(_v)) -extern vm_size_t mem_size; /* size of physical memory (bytes) */ +#define VM_KERNEL_UNSLIDE_OR_PERM(_v) ({ \ + VM_KERNEL_IS_SLID(_v) ? __DO_UNSLIDE(_v) : \ + VM_KERNEL_ADDRESS(_v) ? ((vm_offset_t)VM_KERNEL_STRIP_PTR(_v) + vm_kernel_addrperm) : \ + (vm_offset_t)VM_KERNEL_STRIP_PTR(_v); \ + }) + +#define VM_KERNEL_UNSLIDE(_v) ({ \ + VM_KERNEL_IS_SLID(_v) ? __DO_UNSLIDE(_v) : (vm_offset_t)0; \ + }) + +#define VM_KERNEL_ADDRPERM(_v) VM_KERNEL_UNSLIDE_OR_PERM(_v) + +#undef mach_vm_round_page +#undef round_page +#undef round_page_32 +#undef round_page_64 -#endif /* ASSEMBLER */ -#endif /* _MACH_VM_PARAM_H_ */ +static inline mach_vm_offset_t +mach_vm_round_page(mach_vm_offset_t x) +{ + if (round_page_overflow(x, &x)) { + panic("overflow detected"); + } + return x; +} + +static inline vm_offset_t +round_page(vm_offset_t x) +{ + if (round_page_overflow(x, &x)) { + panic("overflow detected"); + } + return x; +} + +static inline mach_vm_offset_t +round_page_64(mach_vm_offset_t x) +{ + if (round_page_overflow(x, &x)) { + panic("overflow detected"); + } + return x; +} + +static inline uint32_t +round_page_32(uint32_t x) +{ + if (round_page_overflow(x, &x)) { + panic("overflow detected"); + } + return x; +} + +#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 (which may be 32 bits or 64-bits). */ +/* An intptr_t is used convert the value to the right precision, and */ +/* then to an address. This macro is also used to convert addresses */ +/* to 32-bit integers, which is a hard failure for a 64-bit kernel */ +#include +#ifndef __CAST_DOWN_CHECK +#define __CAST_DOWN_CHECK + +#define CAST_DOWN( type, addr ) \ + ( ((type)((uintptr_t) (addr)/(sizeof(type) < sizeof(uintptr_t) ? 0 : 1))) ) + +#define CAST_DOWN_EXPLICIT( type, addr ) ( ((type)((uintptr_t) (addr))) ) + +#endif /* __CAST_DOWN_CHECK */ + +#endif /* ASSEMBLER */ + +#endif /* KERNEL */ + +#endif /* _MACH_VM_PARAM_H_ */