osfmk/mach/vm_types.h

   1 /*
   2  * Copyright (c) 2002,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 #ifndef MACH_VM_TYPES_H_
  27 #define MACH_VM_TYPES_H_
  28
  29 #include <stdint.h>
  30 #include <sys/appleapiopts.h>
  31
  32 #include <mach/port.h>
  33 #include <mach/machine/vm_types.h>
  34
  35 typedef vm_offset_t             pointer_t;
  36 typedef vm_offset_t             vm_address_t;
  37 typedef uint64_t                vm_object_offset_t;
  38
  39 /*
  40  * We use addr64_t for 64-bit addresses that are used on both
  41  * 32 and 64-bit machines.  On PPC, they are passed and returned as
  42  * two adjacent 32-bit GPRs.  We use addr64_t in places where
  43  * common code must be useable both on 32 and 64-bit machines.
  44  */
  45 typedef uint64_t addr64_t;              /* Basic effective address */
  46
  47 /*
  48  * We use reg64_t for addresses that are 32 bits on a 32-bit
  49  * machine, and 64 bits on a 64-bit machine, but are always
  50  * passed and returned in a single GPR on PPC.  This type
  51  * cannot be used in generic 32-bit c, since on a 64-bit
  52  * machine the upper half of the register will be ignored
  53  * by the c compiler in 32-bit mode.  In c, we can only use the
  54  * type in prototypes of functions that are written in and called
  55  * from assembly language.  This type is basically a comment.
  56  */
  57 typedef uint32_t        reg64_t;
  58
  59 /*
  60  * To minimize the use of 64-bit fields, we keep some physical
  61  * addresses (that are page aligned) as 32-bit page numbers.
  62  * This limits the physical address space to 16TB of RAM.
  63  */
  64 typedef uint32_t ppnum_t;               /* Physical page number */
  65 #define PPNUM_MAX UINT32_MAX
  66
  67 #ifdef KERNEL_PRIVATE
  68
  69 #if !defined(__APPLE_API_PRIVATE) || !defined(MACH_KERNEL_PRIVATE)
  70
  71 /*
  72  * Use specifically typed null structures for these in
  73  * other parts of the kernel to enable compiler warnings
  74  * about type mismatches, etc...  Otherwise, these would
  75  * be void*.
  76  */
  77 struct vm_map ;
  78 struct vm_object ;
  79
  80 #endif /* !__APPLE_API_PRIVATE || !MACH_KERNEL_PRIVATE */
  81
  82 typedef struct vm_map           *vm_map_t;
  83 typedef struct vm_object        *vm_object_t;
  84 #define VM_OBJECT_NULL          ((vm_object_t) 0)
  85
  86 #else   /* KERNEL_PRIVATE */
  87
  88 typedef mach_port_t             vm_map_t;
  89
  90 #endif  /* KERNEL_PRIVATE */
  91
  92 #define VM_MAP_NULL             ((vm_map_t) 0)
  93
  94
  95 #ifdef  __APPLE_API_EVOLVING
  96
  97 #ifdef  KERNEL_PRIVATE
  98
  99 #ifndef MACH_KERNEL_PRIVATE
 100 struct upl ;
 101 struct vm_map_copy ;
 102 struct vm_named_entry ;
 103 #endif /* !MACH_KERNEL_PRIVATE */
 104
 105 typedef struct upl              *upl_t;
 106 typedef struct vm_map_copy      *vm_map_copy_t;
 107 typedef struct vm_named_entry   *vm_named_entry_t;
 108
 109 #define VM_MAP_COPY_NULL        ((vm_map_copy_t) 0)
 110
 111 #else  /* !KERNEL_PRIVATE */
 112
 113 typedef mach_port_t             upl_t;
 114 typedef mach_port_t             vm_named_entry_t;
 115
 116 #endif /* !KERNEL_PRIVATE */
 117
 118 #define UPL_NULL                ((upl_t) 0)
 119 #define VM_NAMED_ENTRY_NULL     ((vm_named_entry_t) 0)
 120
 121 #endif  /* __APPLE_API_EVOLVING */
 122
 123 #endif  /* MACH_VM_TYPES_H_ */
 124
 125