osfmk/mach/vm_param.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   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.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  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
  64 #ifndef KERNEL_PRIVATE
  65
  66 #error YOU HAVE MADE A MISTAKE BY INCLUDING THIS FILE;
  67 #error
  68 #error THIS FILE SHOULD NOT BE VISIBLE TO USER PROGRAMS.
  69 #error
  70 #error USE <mach/machine/vm_param.h> TO GET MACHINE-DEPENDENT ADDRESS
  71 #error SPACE AND PAGE SIZE ITEMS.
  72 #error
  73 #error USE <mach/machine/vm_types.h> TO GET TYPE DECLARATIONS USED IN
  74 #error THE MACH KERNEL INTERFACE.
  75 #error
  76 #error IN ALL PROBABILITY, YOU SHOULD GET ALL OF THE TYPES USED IN THE
  77 #error INTERFACE FROM <mach/mach_types.h>
  78
  79 #endif  /* KERNEL_PRIVATE */
  80
  81 #include <mach/machine/vm_param.h>
  82
  83 #include <mach/vm_types.h>
  84
  85 /*
  86  *      The machine independent pages are refered to as PAGES.  A page
  87  *      is some number of hardware pages, depending on the target machine.
  88  */
  89
  90 /*
  91  *      All references to the size of a page should be done with PAGE_SIZE
  92  *      or PAGE_SHIFT.  The fact they are variables is hidden here so that
  93  *      we can easily make them constant if we so desire.
  94  */
  95
  96 /*
  97  *      Regardless whether it is implemented with a constant or a variable,
  98  *      the PAGE_SIZE is assumed to be a power of two throughout the
  99  *      virtual memory system implementation.
 100  */
 101
 102 #ifndef PAGE_SIZE_FIXED
 103 extern vm_size_t        page_size;
 104 extern vm_size_t        page_mask;
 105 extern int              page_shift;
 106
 107 #define PAGE_SIZE       page_size       /* pagesize in addr units */
 108 #define PAGE_SHIFT      page_shift      /* number of bits to shift for pages */
 109 #define PAGE_MASK       page_mask       /* mask for off in page */
 110
 111 #define PAGE_SIZE_64 (unsigned long long)page_size /* pagesize in addr units */
 112 #define PAGE_MASK_64 (unsigned long long)page_mask /* mask for off in page */
 113 #else   /* PAGE_SIZE_FIXED */
 114 #define PAGE_SIZE       4096
 115 #define PAGE_SHIFT      12
 116 #define PAGE_MASK       (PAGE_SIZE-1)
 117 #define PAGE_SIZE_64    (unsigned long long)4096
 118 #define PAGE_MASK_64    (PAGE_SIZE_64-1)
 119 #endif  /* PAGE_SIZE_FIXED */
 120
 121 #ifndef ASSEMBLER
 122
 123 /*
 124  *      Convert addresses to pages and vice versa.  No rounding is used.
 125  *      The atop_32 and ptoa_32 macros should not be use on 64 bit types.
 126  *      The round_page_64 and trunc_page_64 macros should be used instead.
 127  */
 128
 129 #define atop_32(x) ((uint32_t)(x) >> PAGE_SHIFT)
 130 #define ptoa_32(x) ((uint32_t)(x) << PAGE_SHIFT)
 131 #define atop_64(x) ((uint64_t)(x) >> PAGE_SHIFT)
 132 #define ptoa_64(x) ((uint64_t)(x) << PAGE_SHIFT)
 133
 134 /*
 135  *      While the following block is enabled, the legacy atop and ptoa
 136  *      macros will behave correctly.  If not, they will generate
 137  *      invalid lvalue errors.
 138  */
 139
 140 #if 1
 141 #define atop(x) ((uint32_t)(x) >> PAGE_SHIFT)
 142 #define ptoa(x) ((uint32_t)(x) << PAGE_SHIFT)
 143 #else
 144 #define atop(x) (0UL = 0)
 145 #define ptoa(x) (0UL = 0)
 146 #endif
 147
 148
 149 /*
 150  *      Round off or truncate to the nearest page.  These will work
 151  *      for either addresses or counts.  (i.e. 1 byte rounds to 1 page
 152  *      bytes.  The round_page_32 and trunc_page_32 macros should not be
 153  *      use on 64 bit types.  The round_page_64 and trunc_page_64 macros
 154  *      should be used instead.
 155  */
 156
 157 #define round_page_32(x) (((uint32_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
 158 #define trunc_page_32(x) ((uint32_t)(x) & ~((signed)PAGE_MASK))
 159 #define round_page_64(x) (((uint64_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
 160 #define trunc_page_64(x) ((uint64_t)(x) & ~((signed)PAGE_MASK))
 161
 162
 163 /*
 164  *      While the following block is enabled, the legacy round_page
 165  *      and trunc_page macros will behave correctly.  If not, they will
 166  *      generate invalid lvalue errors.
 167  */
 168
 169 #if 1
 170 #define round_page(x) (((uint32_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
 171 #define trunc_page(x) ((uint32_t)(x) & ~((signed)PAGE_MASK))
 172 #else
 173 #define round_page(x) (0UL = 0)
 174 #define trunc_page(x) (0UL = 0)
 175 #endif
 176
 177 /*
 178  *      Enable the following block to find uses of xxx_32 macros that should
 179  *      be xxx_64.  These macros only work in C code, not C++.  The resulting
 180  *      binaries are not functional.  Look for invalid lvalue errors in
 181  *      the compiler output.
 182  *
 183  *      Enabling the following block will also find use of the xxx_64 macros
 184  *      that have been passed pointers.  The parameters should be case to an
 185  *      unsigned long type first.  Look for invalid operands to binary + error
 186  *      in the compiler output.
 187  */
 188
 189 #if 0
 190 #undef atop_32
 191 #undef ptoa_32
 192 #undef round_page_32
 193 #undef trunc_page_32
 194 #undef atop_64
 195 #undef ptoa_64
 196 #undef round_page_64
 197 #undef trunc_page_64
 198
 199 #ifndef __cplusplus
 200
 201 #define atop_32(x) \
 202     (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
 203         (*(long *)0), \
 204         (0UL)) = 0)
 205
 206 #define ptoa_32(x) \
 207     (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
 208         (*(long *)0), \
 209         (0UL)) = 0)
 210
 211 #define round_page_32(x) \
 212     (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
 213         (*(long *)0), \
 214         (0UL)) = 0)
 215
 216 #define trunc_page_32(x) \
 217     (__builtin_choose_expr (sizeof(x) != sizeof(uint64_t), \
 218         (*(long *)0), \
 219         (0UL)) = 0)
 220 #else
 221
 222 #define atop_32(x) (0)
 223 #define ptoa_32(x) (0)
 224 #define round_page_32(x) (0)
 225 #define trunc_page_32(x) (0)
 226
 227 #endif /* ! __cplusplus */
 228
 229 #define atop_64(x) ((uint64_t)((x) + (uint8_t *)0))
 230 #define ptoa_64(x) ((uint64_t)((x) + (uint8_t *)0))
 231 #define round_page_64(x) ((uint64_t)((x) + (uint8_t *)0))
 232 #define trunc_page_64(x) ((uint64_t)((x) + (uint8_t *)0))
 233
 234 #endif
 235
 236 /*
 237  *      Determine whether an address is page-aligned, or a count is
 238  *      an exact page multiple.
 239  */
 240
 241 #define page_aligned(x) ((((vm_object_offset_t) (x)) & PAGE_MASK) == 0)
 242
 243 extern vm_size_t        mem_size;       /* size of physical memory (bytes) */
 244
 245 #endif  /* ASSEMBLER */
 246 #endif  /* _MACH_VM_PARAM_H_ */