osfmk/mach/vm_types.h

   1 /*
   2  * Copyright (c) 2000-2004 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 #ifndef _MACH_VM_TYPES_H_
  33 #define _MACH_VM_TYPES_H_
  34
  35 #include <mach/port.h>
  36 #include <mach/machine/vm_types.h>
  37
  38 #include <stdint.h>
  39
  40 typedef vm_offset_t             pointer_t;
  41 typedef vm_offset_t             vm_address_t;
  42
  43 /*
  44  * We use addr64_t for 64-bit addresses that are used on both
  45  * 32 and 64-bit machines.  On PPC, they are passed and returned as
  46  * two adjacent 32-bit GPRs.  We use addr64_t in places where
  47  * common code must be useable both on 32 and 64-bit machines.
  48  */
  49 typedef uint64_t addr64_t;              /* Basic effective address */
  50
  51 /*
  52  * We use reg64_t for addresses that are 32 bits on a 32-bit
  53  * machine, and 64 bits on a 64-bit machine, but are always
  54  * passed and returned in a single GPR on PPC.  This type
  55  * cannot be used in generic 32-bit c, since on a 64-bit
  56  * machine the upper half of the register will be ignored
  57  * by the c compiler in 32-bit mode.  In c, we can only use the
  58  * type in prototypes of functions that are written in and called
  59  * from assembly language.  This type is basically a comment.
  60  */
  61 typedef uint32_t        reg64_t;
  62
  63 /*
  64  * To minimize the use of 64-bit fields, we keep some physical
  65  * addresses (that are page aligned) as 32-bit page numbers.
  66  * This limits the physical address space to 16TB of RAM.
  67  */
  68 typedef uint32_t ppnum_t;               /* Physical page number */
  69 #define PPNUM_MAX UINT32_MAX
  70
  71
  72 #ifdef  KERNEL_PRIVATE
  73
  74 #include <sys/cdefs.h>
  75
  76 #ifndef MACH_KERNEL_PRIVATE
  77 /*
  78  * Use specifically typed null structures for these in
  79  * other parts of the kernel to enable compiler warnings
  80  * about type mismatches, etc...  Otherwise, these would
  81  * be void*.
  82  */
  83 __BEGIN_DECLS
  84
  85 struct pmap ;
  86 struct _vm_map ;
  87 struct vm_object ;
  88
  89 __END_DECLS
  90
  91 #endif  /* MACH_KERNEL_PRIVATE */
  92
  93 typedef struct pmap             *pmap_t;
  94 typedef struct _vm_map          *vm_map_t;
  95 typedef struct vm_object        *vm_object_t;
  96 typedef struct vm_object_fault_info     *vm_object_fault_info_t;
  97
  98 #define PMAP_NULL               ((pmap_t) 0)
  99 #define VM_OBJECT_NULL  ((vm_object_t) 0)
 100
 101 #else   /* KERNEL_PRIVATE */
 102
 103 typedef mach_port_t             vm_map_t;
 104
 105 #endif  /* KERNEL_PRIVATE */
 106
 107 #define VM_MAP_NULL             ((vm_map_t) 0)
 108
 109 /*
 110  * Evolving definitions, likely to change.
 111  */
 112
 113 typedef uint64_t                vm_object_offset_t;
 114 typedef uint64_t                vm_object_size_t;
 115
 116
 117 #ifdef XNU_KERNEL_PRIVATE
 118
 119 typedef uint8_t vm_tag_t;
 120
 121 #define VM_TAG_BT       0x00000001
 122 #define VM_TAG_KMOD     0x00000002
 123 #define VM_TAG_UNLOAD   0x00000004
 124
 125 struct vm_allocation_site
 126 {
 127     vm_tag_t tag;
 128     uint8_t  flags;
 129 };
 130 typedef struct vm_allocation_site vm_allocation_site_t;
 131
 132 #endif /* XNU_KERNEL_PRIVATE */
 133
 134 #ifdef  KERNEL_PRIVATE
 135
 136 #ifndef MACH_KERNEL_PRIVATE
 137
 138 __BEGIN_DECLS
 139
 140 struct upl ;
 141 struct vm_map_copy ;
 142 struct vm_named_entry ;
 143
 144 __END_DECLS
 145
 146 #endif  /* MACH_KERNEL_PRIVATE */
 147
 148 typedef struct upl              *upl_t;
 149 typedef struct vm_map_copy      *vm_map_copy_t;
 150 typedef struct vm_named_entry   *vm_named_entry_t;
 151
 152 #define VM_MAP_COPY_NULL        ((vm_map_copy_t) 0)
 153
 154 #else   /* KERNEL_PRIVATE */
 155
 156 typedef mach_port_t             upl_t;
 157 typedef mach_port_t             vm_named_entry_t;
 158
 159 #endif  /* KERNEL_PRIVATE */
 160
 161 #define UPL_NULL                ((upl_t) 0)
 162 #define VM_NAMED_ENTRY_NULL     ((vm_named_entry_t) 0)
 163
 164 #endif  /* _MACH_VM_TYPES_H_ */