osfmk/mach_debug/ipc_info.h

   1 /*
   2  * Copyright (c) 2000-2005 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  * Mach Operating System
  33  * Copyright (c) 1991,1990 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  *      File:   mach_debug/ipc_info.h
  60  *      Author: Rich Draves
  61  *      Date:   March, 1990
  62  *
  63  *      Definitions for the IPC debugging interface.
  64  */
  65
  66 #ifndef _MACH_DEBUG_IPC_INFO_H_
  67 #define _MACH_DEBUG_IPC_INFO_H_
  68
  69 #include <mach/boolean.h>
  70 #include <mach/port.h>
  71 #include <mach/machine/vm_types.h>
  72
  73 /*
  74  *      Remember to update the mig type definitions
  75  *      in mach_debug_types.defs when adding/removing fields.
  76  */
  77
  78 typedef struct ipc_info_space {
  79         natural_t iis_genno_mask;       /* generation number mask */
  80         natural_t iis_table_size;       /* size of table */
  81         natural_t iis_table_next;       /* next possible size of table */
  82         natural_t iis_tree_size;        /* size of tree (UNUSED) */
  83         natural_t iis_tree_small;       /* # of small entries in tree (UNUSED) */
  84         natural_t iis_tree_hash;        /* # of hashed entries in tree (UNUSED) */
  85 } ipc_info_space_t;
  86
  87 typedef struct ipc_info_space_basic {
  88         natural_t iisb_genno_mask;      /* generation number mask */
  89         natural_t iisb_table_size;      /* size of table */
  90         natural_t iisb_table_next;      /* next possible size of table */
  91         natural_t iisb_table_inuse;     /* number of entries in use */
  92         natural_t iisb_reserved[2];     /* future expansion */
  93 } ipc_info_space_basic_t;
  94
  95 typedef struct ipc_info_name {
  96         mach_port_name_t iin_name;              /* port name, including gen number */
  97 /*boolean_t*/ integer_t iin_collision;   /* collision at this entry? */
  98         mach_port_type_t iin_type;      /* straight port type */
  99         mach_port_urefs_t iin_urefs;    /* user-references */
 100         natural_t iin_object;           /* object pointer/identifier */
 101         natural_t iin_next;             /* marequest/next in free list */
 102         natural_t iin_hash;             /* hash index */
 103 } ipc_info_name_t;
 104
 105 typedef ipc_info_name_t *ipc_info_name_array_t;
 106
 107 /* UNUSED */
 108 typedef struct ipc_info_tree_name {
 109         ipc_info_name_t iitn_name;
 110         mach_port_name_t iitn_lchild;   /* name of left child */
 111         mach_port_name_t iitn_rchild;   /* name of right child */
 112 } ipc_info_tree_name_t;
 113
 114 typedef ipc_info_tree_name_t *ipc_info_tree_name_array_t;
 115
 116 #endif  /* _MACH_DEBUG_IPC_INFO_H_ */