osfmk/mach/task_special_ports.h

   1 /*
   2  * Copyright (c) 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  * HISTORY
  27  *
  28  * Revision 1.1.1.1  1998/09/22 21:05:30  wsanchez
  29  * Import of Mac OS X kernel (~semeria)
  30  *
  31  * Revision 1.1.1.1  1998/03/07 02:25:46  wsanchez
  32  * Import of OSF Mach kernel (~mburg)
  33  *
  34  * Revision 1.2.7.2  1995/01/06  19:51:58  devrcs
  35  *      mk6 CR668 - 1.3b26 merge
  36  *      [1994/10/14  03:43:15  dwm]
  37  *
  38  * Revision 1.2.7.1  1994/09/23  02:43:04  ezf
  39  *      change marker to not FREE
  40  *      [1994/09/22  21:43:04  ezf]
  41  *
  42  * Revision 1.2.2.5  1993/09/03  15:53:54  jeffc
  43  *      CR9255 - Remove MACH_EXC_COMPAT
  44  *      [1993/08/26  15:10:56  jeffc]
  45  *
  46  * Revision 1.2.2.4  1993/08/05  19:09:45  jeffc
  47  *      CR9508 - Delete dead code. Remove MACH_IPC_COMPAT
  48  *      [1993/08/03  17:09:30  jeffc]
  49  *
  50  * Revision 1.2.2.3  1993/08/03  19:05:13  gm
  51  *      CR9596: Change KERNEL to MACH_KERNEL.
  52  *      CR9600: Add task_special_port_t typedef.
  53  *      [1993/08/02  18:34:37  gm]
  54  *
  55  * Revision 1.2.2.2  1993/06/09  02:43:37  gm
  56  *      Added to OSF/1 R1.3 from NMK15.0.
  57  *      [1993/06/02  21:18:21  jeffc]
  58  *
  59  * Revision 1.2  1993/04/19  16:39:36  devrcs
  60  *      ansi C conformance changes
  61  *      [1993/02/02  18:55:14  david]
  62  *
  63  * Revision 1.1  1992/09/30  02:32:11  robert
  64  *      Initial revision
  65  *
  66  * $EndLog$
  67  */
  68 /* CMU_HIST */
  69 /*
  70  * Revision 2.4.2.1  92/03/03  16:22:36  jeffreyh
  71  *      Changes from TRUNK
  72  *      [92/02/26  12:20:27  jeffreyh]
  73  *
  74  * Revision 2.5  92/01/15  13:44:54  rpd
  75  *      Changed MACH_IPC_COMPAT conditionals to default to not present.
  76  *
  77  * Revision 2.4  91/05/14  17:00:57  mrt
  78  *      Correcting copyright
  79  *
  80  * Revision 2.3  91/02/05  17:36:29  mrt
  81  *      Changed to new Mach copyright
  82  *      [91/02/01  17:21:29  mrt]
  83  *
  84  * Revision 2.2  90/06/02  15:00:03  rpd
  85  *      Converted to new IPC.
  86  *      [90/03/26  22:40:08  rpd]
  87  *
  88  * Revision 2.1  89/08/03  16:06:01  rwd
  89  * Created.
  90  *
  91  * Revision 2.3  89/02/25  18:41:12  gm0w
  92  *      Changes for cleanup.
  93  *
  94  * 17-Jan-88  David Golub (dbg) at Carnegie-Mellon University
  95  *      Created.
  96  *
  97  */
  98 /* CMU_ENDHIST */
  99 /*
 100  * Mach Operating System
 101  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 102  * All Rights Reserved.
 103  *
 104  * Permission to use, copy, modify and distribute this software and its
 105  * documentation is hereby granted, provided that both the copyright
 106  * notice and this permission notice appear in all copies of the
 107  * software, derivative works or modified versions, and any portions
 108  * thereof, and that both notices appear in supporting documentation.
 109  *
 110  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 111  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 112  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 113  *
 114  * Carnegie Mellon requests users of this software to return to
 115  *
 116  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 117  *  School of Computer Science
 118  *  Carnegie Mellon University
 119  *  Pittsburgh PA 15213-3890
 120  *
 121  * any improvements or extensions that they make and grant Carnegie Mellon
 122  * the rights to redistribute these changes.
 123  */
 124 /*
 125  */
 126 /*
 127  *      File:   mach/task_special_ports.h
 128  *
 129  *      Defines codes for special_purpose task ports.  These are NOT
 130  *      port identifiers - they are only used for the task_get_special_port
 131  *      and task_set_special_port routines.
 132  *
 133  */
 134
 135 #ifndef _MACH_TASK_SPECIAL_PORTS_H_
 136 #define _MACH_TASK_SPECIAL_PORTS_H_
 137
 138 typedef int     task_special_port_t;
 139
 140 #define TASK_KERNEL_PORT        1       /* Represents task to the outside
 141                                            world.*/
 142
 143 #define TASK_HOST_PORT          2       /* The host (priv) port for task.  */
 144
 145 #define TASK_BOOTSTRAP_PORT     4       /* Bootstrap environment for task. */
 146
 147 #define TASK_WIRED_LEDGER_PORT  5       /* Wired resource ledger for task. */
 148
 149 #define TASK_PAGED_LEDGER_PORT  6       /* Paged resource ledger for task. */
 150
 151 /*
 152  *      Definitions for ease of use
 153  */
 154
 155 #define task_get_kernel_port(task, port)        \
 156                 (task_get_special_port((task), TASK_KERNEL_PORT, (port)))
 157
 158 #define task_set_kernel_port(task, port)        \
 159                 (task_set_special_port((task), TASK_KERNEL_PORT, (port)))
 160
 161 #define task_get_host_port(task, port)          \
 162                 (task_get_special_port((task), TASK_HOST_PORT, (port)))
 163
 164 #define task_set_host_port(task, port)  \
 165                 (task_set_special_port((task), TASK_HOST_PORT, (port)))
 166
 167 #define task_get_bootstrap_port(task, port)     \
 168                 (task_get_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 169
 170 #define task_set_bootstrap_port(task, port)     \
 171                 (task_set_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 172
 173 #define task_get_wired_ledger_port(task, port)  \
 174                 (task_get_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
 175
 176 #define task_set_wired_ledger_port(task, port)  \
 177                 (task_set_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
 178
 179 #define task_get_paged_ledger_port(task, port)  \
 180                 (task_get_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
 181
 182 #define task_set_paged_ledger_port(task, port)  \
 183                 (task_set_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
 184
 185 #endif  /* _MACH_TASK_SPECIAL_PORTS_H_ */