osfmk/mach/i386/vm_param.h

   1 /*
   2  * Copyright (c) 2000-2006 Apple Computer, 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 #define BYTE_SIZE               8               /* byte size in bits */
  94
  95 #define I386_PGBYTES            4096            /* bytes per 80386 page */
  96 #define I386_PGSHIFT            12              /* bitshift for pages */
  97
  98 #define PAGE_SIZE               I386_PGBYTES
  99 #define PAGE_SHIFT              I386_PGSHIFT
 100 #define PAGE_MASK               (PAGE_SIZE - 1)
 101
 102 #define I386_LPGBYTES           2*1024*1024     /* bytes per large page */
 103 #define I386_LPGSHIFT           21              /* bitshift for large pages */
 104 #define I386_LPGMASK            (I386_LPGBYTES-1)
 105
 106 /*
 107  *      Convert bytes to pages and convert pages to bytes.
 108  *      No rounding is used.
 109  */
 110
 111 #define i386_btop(x)            ((ppnum_t)((x) >> I386_PGSHIFT))
 112 #define machine_btop(x)         i386_btop(x)
 113 #define i386_ptob(x)            (((pmap_paddr_t)(x)) << I386_PGSHIFT)
 114
 115 /*
 116  *      Round off or truncate to the nearest page.  These will work
 117  *      for either addresses or counts.  (i.e. 1 byte rounds to 1 page
 118  *      bytes.
 119  */
 120
 121 #define i386_round_page(x)      ((((pmap_paddr_t)(x)) + I386_PGBYTES - 1) & \
 122                                         ~(I386_PGBYTES-1))
 123 #define i386_trunc_page(x)      (((pmap_paddr_t)(x)) & ~(I386_PGBYTES-1))
 124
 125
 126
 127 #define VM_MIN_ADDRESS64        ((user_addr_t) 0x0000000000000000ULL)
 128 /*
 129  * default top of user stack... it grows down from here
 130  */
 131 #define VM_USRSTACK64           ((user_addr_t) 0x00007FFF5FC00000ULL)
 132 #define VM_DYLD64               ((user_addr_t) 0x00007FFF5FC00000ULL)
 133 #define VM_LIB64_SHR_DATA       ((user_addr_t) 0x00007FFF60000000ULL)
 134 #define VM_LIB64_SHR_TEXT       ((user_addr_t) 0x00007FFF80000000ULL)
 135 /*
 136  * the end of the usable user address space , for now about 47 bits.
 137  * the 64 bit commpage is past the end of this
 138  */
 139 #define VM_MAX_PAGE_ADDRESS     ((user_addr_t) 0x00007FFFFFE00000ULL)
 140 /*
 141  * canonical end of user address space for limits checking
 142  */
 143 #define VM_MAX_USER_PAGE_ADDRESS ((user_addr_t)0x00007FFFFFFFF000ULL)
 144
 145
 146 /* system-wide values */
 147 #define MACH_VM_MIN_ADDRESS             ((mach_vm_offset_t) 0)
 148 #define MACH_VM_MAX_ADDRESS             ((mach_vm_offset_t) VM_MAX_PAGE_ADDRESS)
 149
 150 /* process-relative values (all 32-bit legacy only for now) */
 151 #define VM_MIN_ADDRESS          ((vm_offset_t) 0)
 152 #define VM_USRSTACK32           ((vm_offset_t) 0xC0000000)
 153 #define VM_MAX_ADDRESS          ((vm_offset_t) 0xFFE00000)
 154
 155
 156 #ifdef  KERNEL_PRIVATE
 157
 158 /* Kernel-wide values */
 159
 160 #define KB              (1024ULL)
 161 #define MB              (1024*KB)
 162 #define GB              (1024*MB)
 163
 164 /*
 165  * Maximum physical memory supported.
 166  */
 167 #define K32_MAXMEM      (32*GB)
 168 #define K64_MAXMEM      (96*GB)
 169 #if defined(__i386__)
 170 #define KERNEL_MAXMEM   K32_MAXMEM
 171 #else
 172 #define KERNEL_MAXMEM   K64_MAXMEM
 173 #endif
 174
 175 /*
 176  * XXX
 177  * The kernel max VM address is limited to 0xFF3FFFFF for now because
 178  * some data structures are explicitly allocated at 0xFF400000 without
 179  * VM's knowledge (see osfmk/i386/locore.s for the allocation of PTmap and co.).
 180  * We can't let VM allocate memory from there.
 181  */
 182
 183 #if defined(__i386__)
 184
 185 #define KERNEL_IMAGE_TO_PHYS(x) (x)
 186 #define VM_MIN_KERNEL_ADDRESS           ((vm_offset_t) 0x00001000U)
 187 #define VM_MIN_KERNEL_AND_KEXT_ADDRESS  VM_MIN_KERNEL_ADDRESS
 188 #define VM_MAX_KERNEL_ADDRESS           ((vm_offset_t) 0xFE7FFFFFU)
 189
 190 #elif defined(__x86_64__)
 191
 192 #define KERNEL_IMAGE_TO_PHYS(x) (x)
 193 #define VM_MIN_KERNEL_ADDRESS           ((vm_offset_t) 0xFFFFFF8000000000UL)
 194 #define VM_MIN_KERNEL_PAGE              ((ppnum_t)0)
 195 #define VM_MIN_KERNEL_AND_KEXT_ADDRESS  (VM_MIN_KERNEL_ADDRESS - 0x80000000ULL)
 196 #define VM_MAX_KERNEL_ADDRESS           ((vm_offset_t) 0xFFFFFFFFFFFFEFFFUL)
 197 #define VM_MAX_KERNEL_ADDRESS_EFI32     ((vm_offset_t) 0xFFFFFF80FFFFEFFFUL)
 198 #define KEXT_ALLOC_MAX_OFFSET (2 * 1024 * 1024 * 1024UL)
 199 #define KEXT_ALLOC_BASE(x)  ((x) - KEXT_ALLOC_MAX_OFFSET)
 200 #define KEXT_ALLOC_SIZE(x)  (KEXT_ALLOC_MAX_OFFSET - (x))
 201
 202 #else
 203 #error unsupported architecture
 204 #endif
 205
 206 #define KERNEL_STACK_SIZE       (I386_PGBYTES*4)
 207
 208 #define VM_MAP_MIN_ADDRESS      MACH_VM_MIN_ADDRESS
 209 #define VM_MAP_MAX_ADDRESS      MACH_VM_MAX_ADDRESS
 210
 211 /* FIXME  - always leave like this? */
 212 #define INTSTACK_SIZE   (I386_PGBYTES*4)
 213
 214 #ifdef  MACH_KERNEL_PRIVATE
 215
 216 /* For implementing legacy 32-bit interfaces */
 217 #define VM32_SUPPORT                    1
 218 #define VM32_MIN_ADDRESS                ((vm32_offset_t) 0)
 219 #define VM32_MAX_ADDRESS                ((vm32_offset_t) (VM_MAX_PAGE_ADDRESS & 0xFFFFFFFF))
 220
 221 #if defined(__i386__)
 222
 223 #define LINEAR_KERNEL_ADDRESS   ((vm_offset_t) 0x00000000)
 224
 225 #define VM_MIN_KERNEL_LOADED_ADDRESS    ((vm_offset_t) 0x00000000U)
 226 #define VM_MAX_KERNEL_LOADED_ADDRESS    ((vm_offset_t) 0x1FFFFFFFU)
 227
 228 #define NCOPY_WINDOWS 4
 229
 230 #elif defined(__x86_64__)
 231
 232 #define LINEAR_KERNEL_ADDRESS   ((vm_offset_t) 0x00000000)
 233
 234 #define VM_MIN_KERNEL_LOADED_ADDRESS    ((vm_offset_t) 0xFFFFFF8000000000UL)
 235 #define VM_MAX_KERNEL_LOADED_ADDRESS    ((vm_offset_t) 0xFFFFFF801FFFFFFFUL)
 236
 237 #define NCOPY_WINDOWS 0
 238
 239 #else
 240 #error unsupported architecture
 241 #endif
 242
 243 /*
 244  *      Conversion between 80386 pages and VM pages
 245  */
 246
 247 #define trunc_i386_to_vm(p)     (atop(trunc_page(i386_ptob(p))))
 248 #define round_i386_to_vm(p)     (atop(round_page(i386_ptob(p))))
 249 #define vm_to_i386(p)           (i386_btop(ptoa(p)))
 250
 251 #define PMAP_ENTER(pmap, virtual_address, page, protection, flags, wired) \
 252         MACRO_BEGIN                                     \
 253         pmap_t __pmap = (pmap);                         \
 254         vm_page_t __page = (page);                      \
 255         vm_prot_t __prot__ =  (protection);             \
 256                                                         \
 257         if (__pmap == kernel_pmap) {                    \
 258                 __prot__ |= VM_PROT_WRITE;              \
 259         } else {                                        \
 260                 assert(!__page->encrypted);             \
 261         }                                               \
 262                                                         \
 263         pmap_enter(                                     \
 264                 __pmap,                                 \
 265                 (virtual_address),                      \
 266                 __page->phys_page,                      \
 267                 __prot__,                               \
 268                 flags,                                  \
 269                 (wired)                                 \
 270          );                                             \
 271         MACRO_END
 272
 273 #define PMAP_ENTER_OPTIONS(pmap, virtual_address, page, protection,     \
 274                                 flags, wired, options, result)          \
 275         MACRO_BEGIN                                                     \
 276                 result=KERN_SUCCESS;                                    \
 277                 PMAP_ENTER(pmap, virtual_address, page, protection,     \
 278                                 flags, wired);                          \
 279         MACRO_END
 280
 281 #define IS_USERADDR64_CANONICAL(addr)                   \
 282         ((addr) < (VM_MAX_USER_PAGE_ADDRESS + PAGE_SIZE))
 283
 284 #endif  /* MACH_KERNEL_PRIVATE */
 285
 286 #endif  /* KERNEL_PRIVATE */
 287
 288 #endif  /* _MACH_I386_VM_PARAM_H_ */