osfmk/mach/mach_types.defs

   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  *      Mach kernel interface type declarations
  54  */
  55
  56 #ifndef _MACH_MACH_TYPES_DEFS_
  57 #define _MACH_MACH_TYPES_DEFS_
  58
  59
  60 #include <mach/std_types.defs>
  61
  62 type memory_object_offset_t     = uint64_t;
  63 type memory_object_size_t       = uint64_t;
  64 type memory_object_cluster_size_t = uint32_t;
  65
  66 #ifdef KERNEL_PRIVATE
  67
  68 /* Universal Page Lists - restricted to (in-kernel) pagers for now */
  69 type upl_size_t                 = uint32_t;
  70 type upl_offset_t                       = uint32_t;
  71 type upl_page_info_t            = struct[2] of integer_t;
  72 type upl_page_info_array_t      = array[*:256] of upl_page_info_t;
  73
  74 type upl_t = mach_port_t
  75                 intran: upl_t convert_port_to_upl(mach_port_t)
  76                 outtran: mach_port_t convert_upl_to_port(upl_t)
  77                 destructor: upl_deallocate(upl_t)
  78                 ;
  79
  80 #endif /* KERNEL_PRIVATE */
  81
  82 type mach_port_status_t = struct[10] of integer_t;      /* obsolete */
  83
  84                 /* mach_port_info_t: can hold either a
  85                  * mach_port_status_t (9 ints) or a
  86                  * mach_port_limits_t (1 int). If new flavors of
  87                  * mach_port_{get,set}_attributes are added, the size of
  88                  * this array may have to be increased. (See mach/port.h)
  89                  */
  90 type mach_port_flavor_t         = int;
  91 type mach_port_info_t           = array[*:10] of integer_t;
  92
  93 type task_t = mach_port_t
  94 #if     KERNEL_SERVER
  95                 intran: task_t convert_port_to_task(mach_port_t)
  96                 outtran: mach_port_t convert_task_to_port(task_t)
  97                 destructor: task_deallocate(task_t)
  98 #endif  /* KERNEL_SERVER */
  99                 ;
 100
 101 type task_name_t = mach_port_t
 102 #if     KERNEL_SERVER
 103                 intran: task_name_t convert_port_to_task_name(mach_port_t)
 104                 outtran: mach_port_t convert_task_name_to_port(task_name_t)
 105                 destructor: task_name_deallocate(task_name_t)
 106 #endif  /* KERNEL_SERVER */
 107                 ;
 108
 109 type thread_t = mach_port_t
 110 #if     KERNEL_SERVER
 111                 intran: thread_t convert_port_to_thread(mach_port_t)
 112                 outtran: mach_port_t convert_thread_to_port(thread_t)
 113                 destructor: thread_deallocate(thread_t)
 114 #endif  /* KERNEL_SERVER */
 115                 ;
 116
 117 type thread_act_t = mach_port_t
 118 #if     KERNEL_SERVER
 119                 intran: thread_act_t convert_port_to_thread(mach_port_t)
 120                 outtran: mach_port_t convert_thread_to_port(thread_act_t)
 121                 destructor: thread_deallocate(thread_act_t)
 122 #endif  /* KERNEL_SERVER */
 123                 ;
 124
 125 type thread_act_consume_ref_t = mach_port_move_send_t
 126                 cusertype: thread_act_t
 127 #if     KERNEL_SERVER
 128                 intran: thread_act_t convert_port_to_thread(mach_port_t)
 129                 destructor: thread_deallocate(thread_act_t)
 130 #endif  /* KERNEL_SERVER */
 131                 ;
 132
 133                 /* thread_state_t: This inline array can hold
 134                  * a machine-dependent amount of data, defined in
 135                  * mach/machine/???? (currently THREAD_STATE_MAX,
 136                  * in mach/thread_state.h)
 137                  */
 138 #include <mach/machine/thread_state.h>
 139 type thread_state_flavor_t      = int;
 140 type thread_state_t             = array[*:THREAD_STATE_MAX] of natural_t;
 141
 142 type task_array_t = ^array[] of task_t;
 143 type thread_array_t = ^array[] of thread_t;
 144 type thread_act_array_t = ^array[] of thread_act_t;
 145 type act_params_t = array[6] of int;
 146
 147 type vm_map_t = mach_port_t
 148 #if     KERNEL_SERVER
 149                 intran: vm_map_t convert_port_to_map(mach_port_t)
 150                 destructor: vm_map_deallocate(vm_map_t)
 151 #endif  /* KERNEL_SERVER */
 152                 ;
 153
 154 type vm_task_entry_t = mach_port_t
 155                 cusertype: vm_map_t
 156 #if     KERNEL_SERVER
 157                 intran: vm_map_t convert_port_entry_to_map(mach_port_t)
 158                 destructor: vm_map_deallocate(vm_map_t)
 159 #endif  /* KERNEL_SERVER */
 160                 ;
 161
 162 type ipc_space_t = mach_port_t
 163 #if     KERNEL_SERVER
 164                 intran: ipc_space_t convert_port_to_space(mach_port_t)
 165                 destructor: space_deallocate(ipc_space_t)
 166 #endif  /* KERNEL_SERVER */
 167                 ;
 168
 169 type vm_prot_t = int;
 170 type vm_inherit_t = int;
 171 type vm_purgable_t = int;
 172 type xxx_vm_statistics_data_t = struct[13] of integer_t;
 173 type vm_behavior_t = int;
 174 type vm_statistics_data_t = struct[14] of integer_t;
 175 type vm_machine_attribute_t = int;
 176 type vm_machine_attribute_val_t = int;
 177 type vm_sync_t = int;
 178
 179                 /* thread_info_t: this inline array can hold any of:
 180                  * thread_basic_info_t (10 ints)
 181                  * policy_timeshare_info_t (5 ints)
 182                  * policy_fifo_info_t (4 ints)
 183                  * policy_rr_info_t (5 ints)
 184                  * if other thread_info flavors are added, this
 185                  * definition may need to be changed. (See
 186                  * mach/thread_info.h and mach/policy.h) */
 187 type thread_flavor_t            = int;
 188 type thread_info_t              = array[*:12] of integer_t;
 189
 190 type thread_policy_flavor_t     = natural_t;
 191 type thread_policy_t            = array[*:16] of integer_t;
 192
 193                 /* task_info_t: this inline array can hold any of:
 194                  * task_basic_info_32_t (8 ints)
 195                  * task_basic_info_64_t (10 ints)
 196                  * task_events_info_t (8 ints)
 197                  * task_thread_times_info_t (4 ints)
 198                  * policy_timeshare_info_t (5 ints)
 199                  * policy_fifo_info_t (4 ints)
 200                  * policy_rr_info_t (5 ints)
 201                  * task security token (2 ints)
 202                  * task audit token (8 ints)
 203                  * If other task_info flavors are added, this
 204                  * definition may need to be changed. (See
 205                  * mach/task_info.h and mach/policy.h) */
 206 type task_flavor_t              = int;
 207 type task_info_t                = array[*:10] of integer_t;
 208
 209 type task_policy_flavor_t       = natural_t;
 210 type task_policy_t              = array[*:16] of integer_t;
 211
 212 type mem_entry_name_port_t = mach_port_t
 213 #if     KERNEL_SERVER
 214                 intran: mem_entry_name_port_t null_conversion(mach_port_t)
 215                 outtran: mach_port_t null_conversion(mem_entry_name_port_t)
 216 #endif  /* KERNEL_SERVER */
 217                 ;
 218
 219 type mem_entry_name_port_move_send_t = mach_port_move_send_t
 220         cusertype: mem_entry_name_port_t
 221 #if     KERNEL_SERVER
 222                 intran: mem_entry_name_port_t null_conversion(mach_port_t)
 223                 outtran: mach_port_t null_conversion(mem_entry_name_port_t)
 224 #endif  /* KERNEL_SERVER */
 225                 ;
 226
 227 type memory_object_default_t = mach_port_t
 228 #if     KERNEL_PRIVATE
 229                 intran: memory_object_default_t null_conversion(mach_port_t)
 230                 outtran: mach_port_t null_conversion(memory_object_default_t)
 231 #endif  /* KERNEL_PRIVATE */
 232                 ;
 233
 234 type memory_object_t = mach_port_t
 235 #if     KERNEL_PRIVATE
 236                 intran: memory_object_t convert_port_to_memory_object(mach_port_t)
 237                 outtran: mach_port_t convert_memory_object_to_port(memory_object_t)
 238 #endif  /* KERNEL_PRIVATE */
 239                 ;
 240
 241
 242 type memory_object_control_t = mach_port_t
 243 #if     KERNEL_PRIVATE
 244                 intran: memory_object_control_t convert_port_to_mo_control(mach_port_t)
 245                 outtran: mach_port_t convert_mo_control_to_port(memory_object_control_t)
 246                 destructor: memory_object_control_deallocate(memory_object_control_t)
 247 #endif  /* KERNEL_PRIVATE */
 248                 ;
 249
 250 type memory_object_name_t = mach_port_t
 251                 ctype: mach_port_t
 252                 ;
 253
 254
 255 type memory_object_copy_strategy_t = int;
 256 type memory_object_return_t = int;
 257
 258 type machine_info_data_t = struct[5] of integer_t;
 259 type machine_slot_data_t = struct[8] of integer_t;
 260
 261 type host_t = mach_port_t
 262 #if     KERNEL_SERVER
 263                 intran: host_t convert_port_to_host(mach_port_t)
 264                 outtran: mach_port_t convert_host_to_port(host_t)
 265 #endif  /* KERNEL_SERVER */
 266                 ;
 267
 268 type host_priv_t = mach_port_t
 269 #if     KERNEL_SERVER
 270                 intran: host_priv_t convert_port_to_host_priv(mach_port_t)
 271 #endif  /* KERNEL_SERVER */
 272                 ;
 273
 274 type host_security_t = mach_port_t
 275 #if     KERNEL_SERVER
 276                 intran: host_security_t convert_port_to_host_security(mach_port_t)
 277 #endif  /* KERNEL_SERVER */
 278                 ;
 279
 280                 /* host_info_t: variable-sized inline array that can contain:
 281                  * host_basic_info_old_t (5 ints)
 282                  * host_basic_info_t (12 ints)
 283                  * host_sched_info_t (2 ints)
 284                  * kernel_resource_sizes_t (5 ints)
 285                  * host_load_info_t (6 ints)
 286                  * vm_statistics_t (14 ints)
 287                  * If other host_info flavors are added, this definition may
 288                  * need to be changed. (See mach/{host_info,vm_statistics}.h)
 289                  */
 290 type host_flavor_t              = int;
 291 type host_info_t                = array[*:14] of integer_t;
 292
 293 type processor_t = mach_port_t
 294 #if     KERNEL_SERVER
 295                 intran: processor_t convert_port_to_processor(mach_port_t)
 296                 outtran: mach_port_t convert_processor_to_port(processor_t)
 297 #endif  /* KERNEL_SERVER */
 298                 ;
 299
 300 type processor_array_t  = ^array[] of processor_t;
 301
 302                 /* processor_info_t: variable-sized inline array that can
 303                  * contain:
 304                  * processor_basic_info_t:   (5 ints)
 305                  * processor_cpu_load_info_t:(4 ints)
 306                  * processor_machine_info_t :(12 ints)
 307                  * If other processor_info flavors are added, this definition
 308                  * may need to be changed. (See mach/processor_info.h) */
 309 type processor_flavor_t         = int;
 310 type processor_info_t           = array[*:12] of integer_t;
 311 type processor_info_array_t     = ^array[] of integer_t;
 312
 313 type processor_set_t = mach_port_t
 314 #if     KERNEL_SERVER
 315                 intran: processor_set_t convert_port_to_pset(mach_port_t)
 316                 outtran: mach_port_t convert_pset_to_port(processor_set_t)
 317                 destructor: pset_deallocate(processor_set_t)
 318 #endif  /* KERNEL_SERVER */
 319                 ;
 320
 321 type processor_set_array_t = ^array[] of processor_set_t;
 322
 323 type processor_set_name_t = mach_port_t
 324 #if     KERNEL_SERVER
 325                 intran: processor_set_name_t convert_port_to_pset_name(mach_port_t)
 326                 outtran: mach_port_t convert_pset_name_to_port(processor_set_name_t)
 327                 destructor: pset_deallocate(processor_set_name_t)
 328 #endif  /* KERNEL_SERVER */
 329                 ;
 330
 331 type processor_set_name_array_t = ^array[] of processor_set_name_t;
 332
 333                 /* processor_set_info_t: variable-size inline array
 334                  * that can hold:
 335                  * processor_set_basic_info (5 ints)
 336                  * processor_set_load_info (4 ints)
 337                  * policy_timeshare_base_t (1 int)
 338                  * policy_fifo_base_t (1 int)
 339                  * policy_rr_base_t (1 int)
 340                  * policy_timeshare_base_t (1 int)
 341                  * policy_fifo_base_t (1 int)
 342                  * policy_rr_base_t (1 int)
 343                  * policy_t (1 int)
 344                  * If other flavors are added, this definition may
 345                  * need to be changed. (see mach/processor.h) */
 346 type processor_set_flavor_t     = int;
 347 type processor_set_info_t       = array[*:5] of integer_t;
 348
 349 type bootstrap_t = mach_port_t;
 350
 351 type kernel_version_t           = c_string[*:512];
 352 type kernel_boot_info_t         = c_string[*:4096];
 353
 354 type time_value_t = struct[2] of integer_t;
 355
 356 type mach_port_qos_t = struct[2] of integer_t;
 357
 358 type emulation_vector_t         = ^array[] of vm_offset_t;
 359
 360 type inline_existence_map_t     = array[*:512] of char;
 361
 362 type policy_t                   = int;
 363                 /* policy_info_t: variable-size inline array. Can hold:
 364                  * policy_timeshare_info_t (5 ints)
 365                  * policy_fifo_info_t (4 ints)
 366                  * policy_rr_info_t (5 ints) */
 367 type policy_base_t              = array[*:5] of integer_t;
 368 type policy_info_t              = array[*:2] of integer_t;
 369 type policy_limit_t             = array[*:1] of integer_t;
 370
 371 type ledger_t = mach_port_t
 372 #if     KERNEL_SERVER
 373                 intran: ledger_t convert_port_to_ledger(mach_port_t)
 374                 outtran: mach_port_t convert_ledger_to_port(ledger_t)
 375 #endif  /* KERNEL_SERVER */
 376                 ;
 377
 378 type ledger_array_t             = ^array[] of ledger_t;
 379 type ledger_item_t              = integer_t;
 380
 381 type security_token_t           = struct[2] of uint32_t;
 382 type audit_token_t              = struct[8] of uint32_t;
 383
 384                 /* memory_object_info_t: variable-size inline array:
 385                  * memory_object_attr_info_t (5 ints)
 386                  * XXX actually it's 6 ints temporarily (object_ready!)
 387                  * memory_object_behave_info_t (4 ints)
 388                  * memory_object_perf_info_t (2 ints)
 389                  * old_memory_object_attr_info_t (3 ints)
 390                  * memory_object_norma_info_t (5 ints)
 391                  * If other flavors are added, this definition may
 392                  * need to be changed. (see mach/memory_object.h) */
 393 type memory_object_flavor_t     = int;
 394 type memory_object_info_t       = array[*:6] of int;
 395
 396                 /* vm_region_info_t: variable-size inline array that can hold:
 397                  * vm_region_basic_info_t (8 ints)
 398                  * If other flavors are added, this definition may
 399                  * need to be changed. (see mach/vm_region.h) */
 400 type vm_region_flavor_t         = int;
 401 type vm_region_info_t           = array[*:10] of int;
 402 type vm_region_recurse_info_t   = array[*:19] of int;
 403
 404 type mach_vm_read_entry_t = array[512] of mach_vm_offset_t;
 405 type vm_read_entry_t = array[512] of vm_offset_t;
 406
 407 type exception_mask_t           = int;
 408 type exception_behavior_t       = int;
 409
 410 type    exception_handler_t = mach_port_t;
 411
 412 type    exception_handler_array_t       =
 413                         array[*:32] of exception_handler_t;
 414
 415 type    exception_behavior_array_t      =
 416                         array[*:32] of exception_behavior_t;
 417
 418 type    exception_flavor_array_t        =
 419                         array[*:32] of thread_state_flavor_t;
 420
 421 type    exception_mask_array_t  =
 422                         array[*:32] of exception_mask_t;
 423
 424 type semaphore_t = mach_port_t
 425 #if     KERNEL_SERVER
 426                 intran: semaphore_t convert_port_to_semaphore(mach_port_t)
 427                 outtran: mach_port_t convert_semaphore_to_port(semaphore_t)
 428                 destructor: semaphore_dereference(semaphore_t)
 429 #endif  /* KERNEL_SERVER */
 430                 ;
 431
 432 type semaphore_consume_ref_t = mach_port_move_send_t
 433                 cusertype: semaphore_t
 434 #if     KERNEL_SERVER
 435                 intran: semaphore_t convert_port_to_semaphore(mach_port_t)
 436                 outtran: mach_port_t convert_semaphore_to_port(semaphore_t)
 437                 destructor: semaphore_dereference(semaphore_t)
 438 #endif  /* KERNEL_SERVER */
 439                 ;
 440
 441 type lock_set_t = mach_port_t
 442 #if     KERNEL_SERVER
 443                 intran: lock_set_t convert_port_to_lock_set(mach_port_t)
 444                 outtran: mach_port_t convert_lock_set_to_port(lock_set_t)
 445                 destructor: lock_set_dereference(lock_set_t)
 446 #endif  /* KERNEL_SERVER */
 447                 ;
 448
 449 /* kernel module loader */
 450 type kmod_t = int;
 451 type kmod_control_flavor_t = int;
 452
 453 type kmod_args_t = ^array[] of MACH_MSG_TYPE_BYTE
 454         ctype: kmod_args_t;
 455
 456 type io_master_t = mach_port_t;
 457 type UNDServerRef = mach_port_t;
 458
 459 #if KERNEL_SERVER
 460 #ifdef  MACH_KERNEL_PRIVATE
 461 simport <kern/ipc_kobject.h>;   /* for null conversion */
 462 simport <kern/ipc_tt.h>;        /* for task/thread conversion */
 463 simport <kern/ipc_host.h>;      /* for host/processor/pset conversions */
 464 simport <kern/ipc_sync.h>;      /* for lock_set and semaphore conversions */
 465 simport <kern/ledger.h>;        /* for ledger conversions */
 466 simport <kern/processor.h>;     /* for processor conversions */
 467 simport <kern/sync_lock.h>;     /* for lock-set conversions */
 468 simport <kern/sync_sema.h>;     /* for semaphore conversions */
 469 simport <vm/memory_object.h>;   /* for memory object type conversions */
 470 simport <vm/vm_map.h>;          /* for vm_map conversions */
 471 #endif  /* MACH_KERNEL_PRIVATE */
 472
 473 simport <kern/ipc_mig.h>;       /* pick up kernel-specific MIG things */
 474
 475 #endif /* KERNEL_SERVER */
 476
 477 import <mach/mig.h>;
 478 import <mach/mach_types.h>;
 479
 480 #endif  /* _MACH_MACH_TYPES_DEFS_ */