xnu-1456.1.26.tar.gz

[apple/xnu.git] / osfmk / mach / vm_param.h

diff --git a/osfmk/mach/vm_param.h b/osfmk/mach/vm_param.h
index aba1ed3efe80f3f457de9b88d71c01fb60d01f7d..468920caaaef13bbd2c7cfa825fceb3adb81184f 100644 (file)
--- a/osfmk/mach/vm_param.h
+++ b/osfmk/mach/vm_param.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_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 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * 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.
+ * 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@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * @OSF_COPYRIGHT@
  */
 /*
  * @OSF_COPYRIGHT@


@@ -61,91 +67,203 @@
 #ifndef        _MACH_VM_PARAM_H_
 #define _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 <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>
+#include <mach/machine/vm_param.h>

 
 

-#endif /* KERNEL_PRIVATE */
+#ifdef KERNEL

 
 

-#include <mach/machine/vm_param.h>
-#include <mach/machine/vm_types.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.
  */
 
 
 /*
  *     The machine independent pages are refered to as PAGES.  A page
  *     is some number of hardware pages, depending on the target machine.
  */
 

+#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 */
+

 /*
 /*

- *     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.
+ *     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)
+
+#define atop_kernel(x) ((vm_address_t)(x) >> PAGE_SHIFT)
+#define ptoa_kernel(x) ((vm_address_t)(x) << PAGE_SHIFT)
+

 /*
 /*

- *     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.
+ *      While the following block is enabled, the legacy atop and ptoa
+ *      macros will behave correctly.  If not, they will generate
+ *      invalid lvalue errors.

  */
 
  */
 

-#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 */
-
-#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 */
+#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
+
+/*
+ *     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 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))

 
 

-#ifndef        ASSEMBLER

 /*
 /*

- *     Convert addresses to pages and vice versa.
- *     No rounding is used.
+ *     Rounding macros for the legacy (scalable with the current task's
+ *     address space size) VM types.

  */
 
  */
 

-#define atop(x)                (((natural_t)(x)) >> PAGE_SHIFT)
-#define ptoa(x)                ((vm_offset_t)((x) << PAGE_SHIFT))
+#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
  *     for either addresses or counts.  (i.e. 1 byte rounds to 1 page
 
 /*
  *     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.
+ *     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(x)  ((vm_offset_t)((((vm_offset_t)(x)) + PAGE_MASK) & ~PAGE_MASK))
-#define trunc_page(x)  ((vm_offset_t)(((vm_offset_t)(x)) & ~PAGE_MASK))
+#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
+ *      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 round_page_64(x)       ((unsigned long long)((((unsigned long long)(x)) + PAGE_MASK_64) & ~PAGE_MASK_64))
-#define trunc_page_64(x)       ((unsigned long long)(((unsigned long long)(x)) & ~PAGE_MASK_64))
+#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.
  */
 
 
 /*
  *     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)
+#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 <rdar://problem/6626493>
+ * 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 */

 
 

-extern vm_size_t       mem_size;       /* size of physical memory (bytes) */
+#ifdef XNU_KERNEL_PRIVATE
+
+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;
+
+#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 <stdint.h>
+#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 /* ASSEMBLER */

+
+#endif /* KERNEL */
+

 #endif /* _MACH_VM_PARAM_H_ */
 #endif /* _MACH_VM_PARAM_H_ */