osfmk/mach/i386/vm_param.h

   1 /*
   2  * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   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.
  14  *
  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
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989,1988 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  * Copyright (c) 1994 The University of Utah and
  59  * the Computer Systems Laboratory at the University of Utah (CSL).
  60  * All rights reserved.
  61  *
  62  * Permission to use, copy, modify and distribute this software is hereby
  63  * granted provided that (1) source code retains these copyright, permission,
  64  * and disclaimer notices, and (2) redistributions including binaries
  65  * reproduce the notices in supporting documentation, and (3) all advertising
  66  * materials mentioning features or use of this software display the following
  67  * acknowledgement: ``This product includes software developed by the
  68  * Computer Systems Laboratory at the University of Utah.''
  69  *
  70  * THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS
  71  * IS" CONDITION.  THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF
  72  * ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  73  *
  74  * CSL requests users of this software to return to csl-dist@cs.utah.edu any
  75  * improvements that they make and grant CSL redistribution rights.
  76  *
  77  */
  78
  79 /*
  80  *      File:   vm_param.h
  81  *      Author: Avadis Tevanian, Jr.
  82  *      Date:   1985
  83  *
  84  *      I386 machine dependent virtual memory parameters.
  85  *      Most of the declarations are preceeded by I386_ (or i386_)
  86  *      which is OK because only I386 specific code will be using
  87  *      them.
  88  */
  89
  90 #ifndef _MACH_I386_VM_PARAM_H_
  91 #define _MACH_I386_VM_PARAM_H_
  92
  93 #if !defined(KERNEL) && !defined(__ASSEMBLER__)
  94
  95 #include <mach/vm_page_size.h>
  96 #endif
  97
  98 #define BYTE_SIZE               8               /* byte size in bits */
  99
 100 #define I386_PGBYTES            4096            /* bytes per 80386 page */
 101 #define I386_PGSHIFT            12              /* bitshift for pages */
 102
 103 #if defined(KERNEL)
 104
 105 #define PAGE_SIZE               I386_PGBYTES
 106 #define PAGE_SHIFT              I386_PGSHIFT
 107 #define PAGE_MASK               (PAGE_SIZE - 1)
 108
 109 #define PAGE_MAX_SHIFT          PAGE_SHIFT
 110 #define PAGE_MAX_SIZE           PAGE_SIZE
 111 #define PAGE_MAX_MASK           PAGE_MASK
 112
 113 #define PAGE_MIN_SHIFT          PAGE_SHIFT
 114 #define PAGE_MIN_SIZE           PAGE_SIZE
 115 #define PAGE_MIN_MASK           PAGE_MASK
 116
 117 #define I386_LPGBYTES           2*1024*1024     /* bytes per large page */
 118 #define I386_LPGSHIFT           21              /* bitshift for large pages */
 119 #define I386_LPGMASK            (I386_LPGBYTES-1)
 120
 121 /*
 122  *      Convert bytes to pages and convert pages to bytes.
 123  *      No rounding is used.
 124  */
 125
 126 #define i386_btop(x)            ((ppnum_t)((x) >> I386_PGSHIFT))
 127 #define machine_btop(x)         i386_btop(x)
 128 #define i386_ptob(x)            (((pmap_paddr_t)(x)) << I386_PGSHIFT)
 129 #define machine_ptob(x)         i386_ptob(x)
 130
 131 /*
 132  *      Round off or truncate to the nearest page.  These will work
 133  *      for either addresses or counts.  (i.e. 1 byte rounds to 1 page
 134  *      bytes.
 135  */
 136
 137 #define i386_round_page(x)      ((((pmap_paddr_t)(x)) + I386_PGBYTES - 1) & \
 138                                         ~(I386_PGBYTES-1))
 139 #define i386_trunc_page(x)      (((pmap_paddr_t)(x)) & ~(I386_PGBYTES-1))
 140
 141 #else /* KERNEL */
 142
 143 #if !defined(__MAC_OS_X_VERSION_MIN_REQUIRED) || (__MAC_OS_X_VERSION_MIN_REQUIRED < 101600)
 144 #define PAGE_SHIFT              I386_PGSHIFT
 145 #define PAGE_SIZE               I386_PGBYTES
 146 #define PAGE_MASK               (PAGE_SIZE-1)
 147 #else /* !defined(__MAC_OS_X_VERSION_MIN_REQUIRED) || (__MAC_OS_X_VERSION_MIN_REQUIRED < 101600) */
 148 #define PAGE_SHIFT              vm_page_shift
 149 #define PAGE_SIZE               vm_page_size
 150 #define PAGE_MASK               vm_page_mask
 151 #endif /* !defined(__MAC_OS_X_VERSION_MIN_REQUIRED) || (__MAC_OS_X_VERSION_MIN_REQUIRED < 101600) */
 152
 153 #define PAGE_MAX_SHIFT          14
 154 #define PAGE_MAX_SIZE           (1 << PAGE_MAX_SHIFT)
 155 #define PAGE_MAX_MASK           (PAGE_MAX_SIZE-1)
 156
 157 #define PAGE_MIN_SHIFT          12
 158 #define PAGE_MIN_SIZE           (1 << PAGE_MIN_SHIFT)
 159 #define PAGE_MIN_MASK           (PAGE_MIN_SIZE-1)
 160
 161 #endif /* KERNEL */
 162
 163 #define VM_MIN_ADDRESS64        ((user_addr_t) 0x0000000000000000ULL)
 164 /*
 165  * default top of user stack... it grows down from here
 166  */
 167 #define VM_USRSTACK64           ((user_addr_t) 0x00007FFEEFC00000ULL)
 168
 169 /*
 170  * XXX TODO: Obsolete?
 171  */
 172 #define VM_DYLD64               ((user_addr_t) 0x00007FFF5FC00000ULL)
 173 #define VM_LIB64_SHR_DATA       ((user_addr_t) 0x00007FFF60000000ULL)
 174 #define VM_LIB64_SHR_TEXT       ((user_addr_t) 0x00007FFF80000000ULL)
 175 /*
 176  * the end of the usable user address space , for now about 47 bits.
 177  * the 64 bit commpage is past the end of this
 178  */
 179 #define VM_MAX_PAGE_ADDRESS     ((user_addr_t) 0x00007FFFFFE00000ULL)
 180 /*
 181  * canonical end of user address space for limits checking
 182  */
 183 #define VM_MAX_USER_PAGE_ADDRESS ((user_addr_t)0x00007FFFFFFFF000ULL)
 184
 185
 186 /* system-wide values */
 187 #define MACH_VM_MIN_ADDRESS             ((mach_vm_offset_t) 0)
 188 #define MACH_VM_MAX_ADDRESS             ((mach_vm_offset_t) VM_MAX_PAGE_ADDRESS)
 189
 190 /* process-relative values (all 32-bit legacy only for now) */
 191 #define VM_MIN_ADDRESS          ((vm_offset_t) 0)
 192 #define VM_USRSTACK32           ((vm_offset_t) 0xC0000000)      /* ASLR slides stack down by up to 1 MB */
 193 #define VM_MAX_ADDRESS          ((vm_offset_t) 0xFFE00000)
 194
 195
 196 #ifdef  KERNEL_PRIVATE
 197
 198 #define TEST_PAGE_SIZE_16K      FALSE
 199 #define TEST_PAGE_SIZE_4K       TRUE
 200
 201 /* Kernel-wide values */
 202 #define KB              (1024ULL)
 203 #define MB              (1024*KB)
 204 #define GB              (1024*MB)
 205
 206 /*
 207  * Maximum physical memory supported.
 208  */
 209 #define K32_MAXMEM      (32*GB)
 210 #define K64_MAXMEM      (1536*GB)
 211 #define KERNEL_MAXMEM   K64_MAXMEM
 212
 213 /*
 214  * XXX
 215  * The kernel max VM address is limited to 0xFF3FFFFF for now because
 216  * some data structures are explicitly allocated at 0xFF400000 without
 217  * VM's knowledge (see osfmk/i386/locore.s for the allocation of PTmap and co.).
 218  * We can't let VM allocate memory from there.
 219  */
 220
 221 /*
 222  * +-----------------------+--------+--------+------------------------+
 223  * | 0xffff_ffff_ffff_efff |  -4096 | ~512GB | VM_MAX_KERNEL_ADDRESS  |
 224  * +-----------------------+--------+--------+------------------------+
 225  * | 0xffff_ff80_0000_0000 | -512GB |    0GB | VM_MIN_KERNEL_ADDRESS  |
 226  * |                       |        |        | PMAP_HEAP_RANGE_START  |
 227  * +-----------------------+--------+--------+------------------------+
 228  */
 229
 230 #define KERNEL_IMAGE_TO_PHYS(x) (x)
 231 #define VM_KERNEL_POINTER_SIGNIFICANT_BITS 39
 232 #define VM_MIN_KERNEL_ADDRESS           ((vm_offset_t) 0xFFFFFF8000000000UL)
 233 #define VM_MIN_KERNEL_PAGE              ((ppnum_t)0)
 234 #define VM_MIN_KERNEL_AND_KEXT_ADDRESS  (VM_MIN_KERNEL_ADDRESS - 0x80000000ULL)
 235 #define VM_MAX_KERNEL_ADDRESS           ((vm_offset_t) 0xFFFFFFFFFFFFEFFFUL)
 236 #define VM_MAX_KERNEL_ADDRESS_EFI32     ((vm_offset_t) 0xFFFFFF80FFFFEFFFUL)
 237 #define KEXT_ALLOC_MAX_OFFSET           (2 * 1024 * 1024 * 1024UL)
 238 #define KEXT_ALLOC_BASE(x)              ((x) - KEXT_ALLOC_MAX_OFFSET)
 239 #define KEXT_ALLOC_SIZE(x)              (KEXT_ALLOC_MAX_OFFSET - (x))
 240
 241 #define VM_KERNEL_STRIP_PTR(_v) (_v)
 242
 243 #define VM_KERNEL_ADDRESS(va) \
 244         (((vm_address_t)(va) >= VM_MIN_KERNEL_AND_KEXT_ADDRESS) && \
 245         ((vm_address_t)(va)  <= VM_MAX_KERNEL_ADDRESS))
 246
 247 #define VM_MAP_MIN_ADDRESS      MACH_VM_MIN_ADDRESS
 248 #define VM_MAP_MAX_ADDRESS      MACH_VM_MAX_ADDRESS
 249
 250 /* FIXME  - always leave like this? */
 251 #if KASAN
 252 /* Increase the stack sizes to account for the redzones that get added to every
 253  * stack object. */
 254 # define INTSTACK_SIZE (I386_PGBYTES*4*4)
 255 # define KERNEL_STACK_SIZE (I386_PGBYTES*4*4)
 256 #elif DEBUG
 257 # define INTSTACK_SIZE (I386_PGBYTES*4)
 258 # define KERNEL_STACK_SIZE (I386_PGBYTES*6)
 259 #else
 260 /*
 261  * KERNEL_STACK_MULTIPLIER can be defined externally to get a larger
 262  * kernel stack size. For example, adding "-DKERNEL_STACK_MULTIPLIER=2"
 263  * helps avoid kernel stack overflows when compiling with "-O0".
 264  */
 265 #ifndef KERNEL_STACK_MULTIPLIER
 266 #define KERNEL_STACK_MULTIPLIER (1)
 267 #endif /* KERNEL_STACK_MULTIPLIER */
 268 # define INTSTACK_SIZE (I386_PGBYTES*4)
 269 # define KERNEL_STACK_SIZE (I386_PGBYTES*4*KERNEL_STACK_MULTIPLIER)
 270 #endif
 271
 272 #ifdef  MACH_KERNEL_PRIVATE
 273
 274 /* For implementing legacy 32-bit interfaces */
 275 #define VM32_SUPPORT                    1
 276 #define VM32_MIN_ADDRESS                ((vm32_offset_t) 0)
 277 #define VM32_MAX_ADDRESS                ((vm32_offset_t) (VM_MAX_PAGE_ADDRESS & 0xFFFFFFFF))
 278
 279 /*
 280  * kalloc() parameters:
 281  *
 282  * Historically kalloc's underlying zones were power-of-2 sizes, with a
 283  * KALLOC_MINSIZE of 16 bytes.  The allocator ensured that
 284  * (sizeof == alignof) >= 16 for all kalloc allocations.
 285  *
 286  * Today kalloc may use zones with intermediate sizes, constrained by
 287  * KALLOC_MINSIZE and a minimum alignment, expressed by KALLOC_LOG2_MINALIGN.
 288  *
 289  * The common alignment for LP64 is for longs and pointers i.e. 8 bytes.
 290  */
 291
 292
 293 #define KALLOC_MINSIZE          16      /* minimum allocation size */
 294 #define KALLOC_LOG2_MINALIGN    4       /* log2 minimum alignment */
 295
 296 #define LINEAR_KERNEL_ADDRESS   ((vm_offset_t) 0x00000000)
 297
 298 #define VM_MIN_KERNEL_LOADED_ADDRESS    ((vm_offset_t) 0xFFFFFF8000000000UL)
 299 #define VM_MAX_KERNEL_LOADED_ADDRESS    ((vm_offset_t) 0xFFFFFF801FFFFFFFUL)
 300
 301
 302 /*
 303  *      Conversion between 80386 pages and VM pages
 304  */
 305
 306 #define trunc_i386_to_vm(p)     (atop(trunc_page(i386_ptob(p))))
 307 #define round_i386_to_vm(p)     (atop(round_page(i386_ptob(p))))
 308 #define vm_to_i386(p)           (i386_btop(ptoa(p)))
 309
 310
 311 #define PMAP_SET_CACHE_ATTR(mem, object, cache_attr, batch_pmap_op)     \
 312         MACRO_BEGIN                                                     \
 313                 pmap_set_cache_attributes(VM_PAGE_GET_PHYS_PAGE(mem), (cache_attr));    \
 314                 (object)->set_cache_attr = TRUE;                                \
 315                 (void) batch_pmap_op;                                   \
 316         MACRO_END
 317
 318 #define PMAP_BATCH_SET_CACHE_ATTR(object, user_page_list, cache_attr, num_pages, batch_pmap_op) \
 319         MACRO_BEGIN                                                     \
 320         (void) user_page_list;                                          \
 321         (void) num_pages;                                               \
 322         (void) batch_pmap_op;                                           \
 323         MACRO_END
 324
 325 #define IS_USERADDR64_CANONICAL(addr)                   \
 326         ((addr) < (VM_MAX_USER_PAGE_ADDRESS))
 327
 328 /*
 329  * This now limits the physical pages in the zone map
 330  */
 331 #define ZONE_MAP_MAX (64ULL << 30) /* 64GB */
 332
 333 #endif  /* MACH_KERNEL_PRIVATE */
 334
 335 #endif  /* KERNEL_PRIVATE */
 336
 337 #endif  /* _MACH_I386_VM_PARAM_H_ */