osfmk/mach/mach_types.h

   1 /*
   2  * Copyright (c) 2000-2018 Apple 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  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
  60  * support for mandatory and extensible security protections.  This notice
  61  * is included in support of clause 2.2 (b) of the Apple Public License,
  62  * Version 2.0.
  63  */
  64 /*
  65  *      File:   mach/mach_types.h
  66  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  67  *      Date:   1986
  68  *
  69  *      Mach external interface definitions.
  70  *
  71  */
  72
  73 #ifndef _MACH_MACH_TYPES_H_
  74 #define _MACH_MACH_TYPES_H_
  75
  76 #include <stdint.h>
  77
  78 #include <sys/cdefs.h>
  79
  80 #include <mach/host_info.h>
  81 #include <mach/host_notify.h>
  82 #include <mach/host_special_ports.h>
  83 #include <mach/machine.h>
  84 #include <mach/machine/vm_types.h>
  85 #include <mach/memory_object_types.h>
  86 #include <mach/message.h>
  87 #include <mach/exception_types.h>
  88 #include <mach/port.h>
  89 #include <mach/mach_voucher_types.h>
  90 #include <mach/processor_info.h>
  91 #include <mach/task_info.h>
  92 #include <mach/task_inspect.h>
  93 #include <mach/task_policy.h>
  94 #include <mach/task_special_ports.h>
  95 #include <mach/thread_info.h>
  96 #include <mach/thread_policy.h>
  97 #include <mach/thread_special_ports.h>
  98 #include <mach/thread_status.h>
  99 #include <mach/time_value.h>
 100 #include <mach/clock_types.h>
 101 #include <mach/vm_attributes.h>
 102 #include <mach/vm_inherit.h>
 103 #include <mach/vm_purgable.h>
 104 #include <mach/vm_behavior.h>
 105 #include <mach/vm_prot.h>
 106 #include <mach/vm_statistics.h>
 107 #include <mach/vm_sync.h>
 108 #include <mach/vm_types.h>
 109 #include <mach/vm_region.h>
 110 #include <mach/kmod.h>
 111 #include <mach/dyld_kernel.h>
 112
 113 #ifdef  KERNEL
 114
 115 #include <mach/vm_param.h>
 116
 117 /*
 118  * If we are in the kernel, then pick up the kernel definitions for
 119  * the basic mach types.
 120  */
 121 typedef struct task                     *task_t, *task_name_t, *task_inspect_t, *task_suspension_token_t;
 122 typedef struct thread           *thread_t, *thread_act_t, *thread_inspect_t;
 123 typedef struct ipc_space                *ipc_space_t, *ipc_space_inspect_t;
 124 typedef struct coalition                *coalition_t;
 125 typedef struct host                     *host_t;
 126 typedef struct host                     *host_priv_t;
 127 typedef struct host                     *host_security_t;
 128 typedef struct processor                *processor_t;
 129 typedef struct processor_set            *processor_set_t;
 130 typedef struct processor_set            *processor_set_control_t;
 131 typedef struct semaphore                *semaphore_t;
 132 typedef struct ledger                   *ledger_t;
 133 typedef struct alarm                    *alarm_t;
 134 typedef struct clock                    *clock_serv_t;
 135 typedef struct clock                    *clock_ctrl_t;
 136 typedef struct arcade_register          *arcade_register_t;
 137 typedef struct suid_cred               *suid_cred_t;
 138
 139 /*
 140  * OBSOLETE: lock_set interfaces are obsolete.
 141  */
 142 typedef struct lock_set                 *lock_set_t;
 143 struct lock_set;
 144
 145 #ifndef MACH_KERNEL_PRIVATE
 146
 147 __BEGIN_DECLS
 148
 149 struct task;
 150 struct thread;
 151 struct host;
 152 struct processor;
 153 struct processor_set;
 154 struct semaphore;
 155 struct ledger;
 156 struct alarm;
 157 struct clock;
 158 struct arcade_register;
 159 struct suid_cred;
 160
 161 __END_DECLS
 162
 163 #endif  /* MACH_KERNEL_PRIVATE */
 164
 165 #else   /* KERNEL */
 166
 167 /*
 168  * If we are not in the kernel, then these will all be represented by
 169  * ports at user-space.
 170  */
 171 typedef mach_port_t             task_t;
 172 typedef mach_port_t             task_name_t;
 173 typedef mach_port_t             task_inspect_t;
 174 typedef mach_port_t             task_suspension_token_t;
 175 typedef mach_port_t             thread_t;
 176 typedef mach_port_t             thread_act_t;
 177 typedef mach_port_t             thread_inspect_t;
 178 typedef mach_port_t             ipc_space_t;
 179 typedef mach_port_t             ipc_space_inspect_t;
 180 typedef mach_port_t             coalition_t;
 181 typedef mach_port_t             host_t;
 182 typedef mach_port_t             host_priv_t;
 183 typedef mach_port_t             host_security_t;
 184 typedef mach_port_t             processor_t;
 185 typedef mach_port_t             processor_set_t;
 186 typedef mach_port_t             processor_set_control_t;
 187 typedef mach_port_t             semaphore_t;
 188 typedef mach_port_t             lock_set_t;
 189 typedef mach_port_t             ledger_t;
 190 typedef mach_port_t             alarm_t;
 191 typedef mach_port_t             clock_serv_t;
 192 typedef mach_port_t             clock_ctrl_t;
 193 typedef mach_port_t             arcade_register_t;
 194 typedef mach_port_t             suid_cred_t;
 195
 196 #endif  /* KERNEL */
 197
 198 /*
 199  * These aren't really unique types.  They are just called
 200  * out as unique types at one point in history.  So we list
 201  * them here for compatibility.
 202  */
 203 typedef processor_set_t         processor_set_name_t;
 204
 205 /*
 206  * These types are just hard-coded as ports
 207  */
 208 typedef mach_port_t             clock_reply_t;
 209 typedef mach_port_t             bootstrap_t;
 210 typedef mach_port_t             mem_entry_name_port_t;
 211 typedef mach_port_t             exception_handler_t;
 212 typedef exception_handler_t     *exception_handler_array_t;
 213 typedef mach_port_t             vm_task_entry_t;
 214 typedef mach_port_t             io_master_t;
 215 typedef mach_port_t             UNDServerRef;
 216
 217 /*
 218  * Mig doesn't translate the components of an array.
 219  * For example, Mig won't use the thread_t translations
 220  * to translate a thread_array_t argument.  So, these definitions
 221  * are not completely accurate at the moment for other kernel
 222  * components.
 223  */
 224 typedef task_t                  *task_array_t;
 225 typedef thread_t                *thread_array_t;
 226 typedef processor_set_t         *processor_set_array_t;
 227 typedef processor_set_t         *processor_set_name_array_t;
 228 typedef processor_t             *processor_array_t;
 229 typedef thread_act_t            *thread_act_array_t;
 230 typedef ledger_t                *ledger_array_t;
 231
 232 /*
 233  * However the real mach_types got declared, we also have to declare
 234  * types with "port" in the name for compatability with the way OSF
 235  * had declared the user interfaces at one point.  Someday these should
 236  * go away.
 237  */
 238 typedef task_t                  task_port_t;
 239 typedef task_array_t            task_port_array_t;
 240 typedef thread_t                thread_port_t;
 241 typedef thread_array_t          thread_port_array_t;
 242 typedef ipc_space_t             ipc_space_port_t;
 243 typedef host_t                  host_name_t;
 244 typedef host_t                  host_name_port_t;
 245 typedef processor_set_t         processor_set_port_t;
 246 typedef processor_set_t         processor_set_name_port_t;
 247 typedef processor_set_array_t   processor_set_name_port_array_t;
 248 typedef processor_set_t         processor_set_control_port_t;
 249 typedef processor_t             processor_port_t;
 250 typedef processor_array_t       processor_port_array_t;
 251 typedef thread_act_t            thread_act_port_t;
 252 typedef thread_act_array_t      thread_act_port_array_t;
 253 typedef semaphore_t             semaphore_port_t;
 254 typedef lock_set_t              lock_set_port_t;
 255 typedef ledger_t                ledger_port_t;
 256 typedef ledger_array_t          ledger_port_array_t;
 257 typedef alarm_t                 alarm_port_t;
 258 typedef clock_serv_t            clock_serv_port_t;
 259 typedef clock_ctrl_t            clock_ctrl_port_t;
 260 typedef exception_handler_t     exception_port_t;
 261 typedef exception_handler_array_t exception_port_arrary_t;
 262 typedef char vfs_path_t[4096];
 263 typedef char nspace_path_t[1024]; /* 1024 == PATH_MAX */
 264 typedef char suid_cred_path_t[1024];
 265 typedef uint32_t suid_cred_uid_t;
 266
 267 #ifdef KERNEL
 268 #define TASK_NULL               ((task_t) NULL)
 269 #define TASK_NAME_NULL          ((task_name_t) NULL)
 270 #define TASK_INSPECT_NULL               ((task_inspect_t) NULL)
 271 #define THREAD_NULL             ((thread_t) NULL)
 272 #define THREAD_INSPECT_NULL     ((thread_inspect_t)NULL)
 273 #define TID_NULL                ((uint64_t) NULL)
 274 #define THR_ACT_NULL            ((thread_act_t) NULL)
 275 #define IPC_SPACE_NULL          ((ipc_space_t) NULL)
 276 #define IPC_SPACE_INSPECT_NULL  ((ipc_space_inspect_t) NULL)
 277 #define COALITION_NULL          ((coalition_t) NULL)
 278 #define HOST_NULL               ((host_t) NULL)
 279 #define HOST_PRIV_NULL          ((host_priv_t)NULL)
 280 #define HOST_SECURITY_NULL      ((host_security_t)NULL)
 281 #define PROCESSOR_SET_NULL      ((processor_set_t) NULL)
 282 #define PROCESSOR_NULL          ((processor_t) NULL)
 283 #define SEMAPHORE_NULL          ((semaphore_t) NULL)
 284 #define LOCK_SET_NULL           ((lock_set_t) NULL)
 285 #define LEDGER_NULL             ((ledger_t) NULL)
 286 #define ALARM_NULL              ((alarm_t) NULL)
 287 #define CLOCK_NULL              ((clock_t) NULL)
 288 #define UND_SERVER_NULL         ((UNDServerRef) NULL)
 289 #define ARCADE_REG_NULL         ((arcade_register_t) NULL)
 290 #define SUID_CRED_NULL         ((suid_cred_t) NULL)
 291 #else
 292 #define TASK_NULL               ((task_t) 0)
 293 #define TASK_NAME_NULL          ((task_name_t) 0)
 294 #define TASK_INSPECT_NULL               ((task_inspect_t) 0)
 295 #define THREAD_NULL             ((thread_t) 0)
 296 #define THREAD_INSPECT_NULL     ((thread_inspect_t) 0)
 297 #define TID_NULL                ((uint64_t) 0)
 298 #define THR_ACT_NULL            ((thread_act_t) 0)
 299 #define IPC_SPACE_NULL          ((ipc_space_t) 0)
 300 #define IPC_SPACE_INSPECT_NULL  ((ipc_space_inspect_t) 0)
 301 #define COALITION_NULL          ((coalition_t) 0)
 302 #define HOST_NULL               ((host_t) 0)
 303 #define HOST_PRIV_NULL          ((host_priv_t) 0)
 304 #define HOST_SECURITY_NULL      ((host_security_t) 0)
 305 #define PROCESSOR_SET_NULL      ((processor_set_t) 0)
 306 #define PROCESSOR_NULL          ((processor_t) 0)
 307 #define SEMAPHORE_NULL          ((semaphore_t) 0)
 308 #define LOCK_SET_NULL           ((lock_set_t) 0)
 309 #define LEDGER_NULL             ((ledger_t) 0)
 310 #define ALARM_NULL              ((alarm_t) 0)
 311 #define CLOCK_NULL              ((clock_t) 0)
 312 #define UND_SERVER_NULL         ((UNDServerRef) 0)
 313 #define ARCADE_REG_NULL         ((arcade_register_t) 0)
 314 #define SUID_CRED_NULL         ((suid_cred_t) 0)
 315 #endif
 316
 317 /* DEPRECATED */
 318 typedef natural_t       ledger_item_t;
 319 #define LEDGER_ITEM_INFINITY    ((ledger_item_t) (~0))
 320
 321 typedef int64_t                 ledger_amount_t;
 322 #define LEDGER_LIMIT_INFINITY   ((ledger_amount_t)((1ULL << 63) - 1))
 323
 324 typedef mach_vm_offset_t        *emulation_vector_t;
 325 typedef char                    *user_subsystem_t;
 326
 327 typedef char                    *labelstr_t;
 328 /*
 329  *      Backwards compatibility, for those programs written
 330  *      before mach/{std,mach}_types.{defs,h} were set up.
 331  */
 332 #include <mach/std_types.h>
 333
 334 #endif  /* _MACH_MACH_TYPES_H_ */