osfmk/mach/task_special_ports.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * @OSF_COPYRIGHT@
  25  */
  26 /*
  27  * Mach Operating System
  28  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  29  * All Rights Reserved.
  30  *
  31  * Permission to use, copy, modify and distribute this software and its
  32  * documentation is hereby granted, provided that both the copyright
  33  * notice and this permission notice appear in all copies of the
  34  * software, derivative works or modified versions, and any portions
  35  * thereof, and that both notices appear in supporting documentation.
  36  *
  37  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  38  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  39  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  40  *
  41  * Carnegie Mellon requests users of this software to return to
  42  *
  43  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  44  *  School of Computer Science
  45  *  Carnegie Mellon University
  46  *  Pittsburgh PA 15213-3890
  47  *
  48  * any improvements or extensions that they make and grant Carnegie Mellon
  49  * the rights to redistribute these changes.
  50  */
  51 /*
  52  */
  53 /*
  54  *      File:   mach/task_special_ports.h
  55  *
  56  *      Defines codes for special_purpose task ports.  These are NOT
  57  *      port identifiers - they are only used for the task_get_special_port
  58  *      and task_set_special_port routines.
  59  *
  60  */
  61
  62 #ifndef _MACH_TASK_SPECIAL_PORTS_H_
  63 #define _MACH_TASK_SPECIAL_PORTS_H_
  64
  65 typedef int     task_special_port_t;
  66
  67 #define TASK_KERNEL_PORT        1       /* Represents task to the outside
  68                                            world.*/
  69
  70 #define TASK_HOST_PORT          2       /* The host (priv) port for task.  */
  71
  72 #define TASK_BOOTSTRAP_PORT     4       /* Bootstrap environment for task. */
  73
  74 /*
  75  * Evolving and likely to change.
  76  */
  77
  78 #define TASK_WIRED_LEDGER_PORT  5       /* Wired resource ledger for task. */
  79
  80 #define TASK_PAGED_LEDGER_PORT  6       /* Paged resource ledger for task. */
  81
  82 #define task_get_wired_ledger_port(task, port)  \
  83                 (task_get_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
  84
  85 #define task_set_wired_ledger_port(task, port)  \
  86                 (task_set_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
  87
  88 #define task_get_paged_ledger_port(task, port)  \
  89                 (task_get_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
  90
  91 #define task_set_paged_ledger_port(task, port)  \
  92                 (task_set_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
  93
  94 /*
  95  *      Definitions for ease of use
  96  */
  97
  98 #define task_get_kernel_port(task, port)        \
  99                 (task_get_special_port((task), TASK_KERNEL_PORT, (port)))
 100
 101 #define task_set_kernel_port(task, port)        \
 102                 (task_set_special_port((task), TASK_KERNEL_PORT, (port)))
 103
 104 #define task_get_host_port(task, port)          \
 105                 (task_get_special_port((task), TASK_HOST_PORT, (port)))
 106
 107 #define task_set_host_port(task, port)  \
 108                 (task_set_special_port((task), TASK_HOST_PORT, (port)))
 109
 110 #define task_get_bootstrap_port(task, port)     \
 111                 (task_get_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 112
 113 #define task_set_bootstrap_port(task, port)     \
 114                 (task_set_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 115
 116 #endif  /* _MACH_TASK_SPECIAL_PORTS_H_ */