osfmk/mach/mach_types.h

   1 /*
   2  * Copyright (c) 2000-2004 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 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/mach_types.h
  54  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  55  *      Date:   1986
  56  *
  57  *      Mach external interface definitions.
  58  *
  59  */
  60
  61 #ifndef _MACH_MACH_TYPES_H_
  62 #define _MACH_MACH_TYPES_H_
  63
  64 #include <stdint.h>
  65
  66 #include <sys/cdefs.h>
  67
  68 #include <mach/host_info.h>
  69 #include <mach/host_notify.h>
  70 #include <mach/host_special_ports.h>
  71 #include <mach/machine.h>
  72 #include <mach/machine/vm_types.h>
  73 #include <mach/memory_object_types.h>
  74 #include <mach/message.h>
  75 #include <mach/exception_types.h>
  76 #include <mach/port.h>
  77 #include <mach/processor_info.h>
  78 #include <mach/task_info.h>
  79 #include <mach/task_policy.h>
  80 #include <mach/task_special_ports.h>
  81 #include <mach/thread_info.h>
  82 #include <mach/thread_policy.h>
  83 #include <mach/thread_special_ports.h>
  84 #include <mach/thread_status.h>
  85 #include <mach/time_value.h>
  86 #include <mach/clock_types.h>
  87 #include <mach/vm_attributes.h>
  88 #include <mach/vm_inherit.h>
  89 #include <mach/vm_purgable.h>
  90 #include <mach/vm_behavior.h>
  91 #include <mach/vm_prot.h>
  92 #include <mach/vm_statistics.h>
  93 #include <mach/vm_sync.h>
  94 #include <mach/vm_types.h>
  95 #include <mach/vm_region.h>
  96 #include <mach/kmod.h>
  97
  98 #ifdef  KERNEL
  99
 100 #include <mach/vm_param.h>
 101
 102 /*
 103  * If we are in the kernel, then pick up the kernel definitions for
 104  * the basic mach types.
 105  */
 106 typedef struct task                     *task_t, *task_name_t;
 107 typedef struct thread           *thread_t, *thread_act_t;
 108 typedef struct ipc_space                *ipc_space_t;
 109 typedef struct host                     *host_t;
 110 typedef struct host                     *host_priv_t;
 111 typedef struct host                     *host_security_t;
 112 typedef struct processor                *processor_t;
 113 typedef struct processor_set            *processor_set_t;
 114 typedef struct processor_set            *processor_set_control_t;
 115 typedef struct semaphore                *semaphore_t;
 116 typedef struct lock_set                 *lock_set_t;
 117 typedef struct ledger                   *ledger_t;
 118 typedef struct alarm                    *alarm_t;
 119 typedef struct clock                    *clock_serv_t;
 120 typedef struct clock                    *clock_ctrl_t;
 121
 122 #ifndef MACH_KERNEL_PRIVATE
 123
 124 __BEGIN_DECLS
 125
 126 struct task ;
 127 struct thread ;
 128 struct host ;
 129 struct processor ;
 130 struct processor_set ;
 131 struct semaphore ;
 132 struct lock_set ;
 133 struct ledger ;
 134 struct alarm ;
 135 struct clock ;
 136
 137 __END_DECLS
 138
 139 #endif  /* MACH_KERNEL_PRIVATE */
 140
 141 #else   /* KERNEL */
 142
 143 /*
 144  * If we are not in the kernel, then these will all be represented by
 145  * ports at user-space.
 146  */
 147 typedef mach_port_t             task_t;
 148 typedef mach_port_t             task_name_t;
 149 typedef mach_port_t             thread_t;
 150 typedef mach_port_t             thread_act_t;
 151 typedef mach_port_t             ipc_space_t;
 152 typedef mach_port_t             host_t;
 153 typedef mach_port_t             host_priv_t;
 154 typedef mach_port_t             host_security_t;
 155 typedef mach_port_t             processor_t;
 156 typedef mach_port_t             processor_set_t;
 157 typedef mach_port_t             processor_set_control_t;
 158 typedef mach_port_t             semaphore_t;
 159 typedef mach_port_t             lock_set_t;
 160 typedef mach_port_t             ledger_t;
 161 typedef mach_port_t             alarm_t;
 162 typedef mach_port_t             clock_serv_t;
 163 typedef mach_port_t             clock_ctrl_t;
 164
 165 #endif  /* KERNEL */
 166
 167 /*
 168  * These aren't really unique types.  They are just called
 169  * out as unique types at one point in history.  So we list
 170  * them here for compatibility.
 171  */
 172 typedef processor_set_t         processor_set_name_t;
 173
 174 /*
 175  * These types are just hard-coded as ports
 176  */
 177 typedef mach_port_t             clock_reply_t;
 178 typedef mach_port_t             bootstrap_t;
 179 typedef mach_port_t             mem_entry_name_port_t;
 180 typedef mach_port_t             exception_handler_t;
 181 typedef exception_handler_t     *exception_handler_array_t;
 182 typedef mach_port_t             vm_task_entry_t;
 183 typedef mach_port_t             io_master_t;
 184 typedef mach_port_t             UNDServerRef;
 185
 186 /*
 187  * Mig doesn't translate the components of an array.
 188  * For example, Mig won't use the thread_t translations
 189  * to translate a thread_array_t argument.  So, these definitions
 190  * are not completely accurate at the moment for other kernel
 191  * components.
 192  */
 193 typedef task_t                  *task_array_t;
 194 typedef thread_t                *thread_array_t;
 195 typedef processor_set_t         *processor_set_array_t;
 196 typedef processor_set_t         *processor_set_name_array_t;
 197 typedef processor_t             *processor_array_t;
 198 typedef thread_act_t            *thread_act_array_t;
 199 typedef ledger_t                *ledger_array_t;
 200
 201 /*
 202  * However the real mach_types got declared, we also have to declare
 203  * types with "port" in the name for compatability with the way OSF
 204  * had declared the user interfaces at one point.  Someday these should
 205  * go away.
 206  */
 207 typedef task_t                  task_port_t;
 208 typedef task_array_t            task_port_array_t;
 209 typedef thread_t                thread_port_t;
 210 typedef thread_array_t          thread_port_array_t;
 211 typedef ipc_space_t             ipc_space_port_t;
 212 typedef host_t                  host_name_t;
 213 typedef host_t                  host_name_port_t;
 214 typedef processor_set_t         processor_set_port_t;
 215 typedef processor_set_t         processor_set_name_port_t;
 216 typedef processor_set_array_t   processor_set_name_port_array_t;
 217 typedef processor_set_t         processor_set_control_port_t;
 218 typedef processor_t             processor_port_t;
 219 typedef processor_array_t       processor_port_array_t;
 220 typedef thread_act_t            thread_act_port_t;
 221 typedef thread_act_array_t      thread_act_port_array_t;
 222 typedef semaphore_t             semaphore_port_t;
 223 typedef lock_set_t              lock_set_port_t;
 224 typedef ledger_t                ledger_port_t;
 225 typedef ledger_array_t          ledger_port_array_t;
 226 typedef alarm_t                 alarm_port_t;
 227 typedef clock_serv_t            clock_serv_port_t;
 228 typedef clock_ctrl_t            clock_ctrl_port_t;
 229 typedef exception_handler_t     exception_port_t;
 230 typedef exception_handler_array_t exception_port_arrary_t;
 231
 232
 233 #define TASK_NULL               ((task_t) 0)
 234 #define TASK_NAME_NULL          ((task_name_t) 0)
 235 #define THREAD_NULL             ((thread_t) 0)
 236 #define THR_ACT_NULL            ((thread_act_t) 0)
 237 #define IPC_SPACE_NULL          ((ipc_space_t) 0)
 238 #define HOST_NULL               ((host_t) 0)
 239 #define HOST_PRIV_NULL          ((host_priv_t)0)
 240 #define HOST_SECURITY_NULL      ((host_security_t)0)
 241 #define PROCESSOR_SET_NULL      ((processor_set_t) 0)
 242 #define PROCESSOR_NULL          ((processor_t) 0)
 243 #define SEMAPHORE_NULL          ((semaphore_t) 0)
 244 #define LOCK_SET_NULL           ((lock_set_t) 0)
 245 #define LEDGER_NULL             ((ledger_t) 0)
 246 #define ALARM_NULL              ((alarm_t) 0)
 247 #define CLOCK_NULL              ((clock_t) 0)
 248 #define UND_SERVER_NULL         ((UNDServerRef) 0)
 249
 250 typedef natural_t               ledger_item_t;
 251 #define LEDGER_ITEM_INFINITY ((ledger_item_t) (~0))
 252
 253 typedef mach_vm_offset_t        *emulation_vector_t;
 254 typedef char                    *user_subsystem_t;
 255
 256 /*
 257  *      Backwards compatibility, for those programs written
 258  *      before mach/{std,mach}_types.{defs,h} were set up.
 259  */
 260 #include <mach/std_types.h>
 261
 262 #endif  /* _MACH_MACH_TYPES_H_ */