osfmk/mach/task_special_ports.h

   1 /*
   2  * Copyright (c) 2000-2002 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,1989,1988,1987 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/task_special_ports.h
  60  *
  61  *      Defines codes for special_purpose task ports.  These are NOT
  62  *      port identifiers - they are only used for the task_get_special_port
  63  *      and task_set_special_port routines.
  64  *
  65  */
  66
  67 #ifndef _MACH_TASK_SPECIAL_PORTS_H_
  68 #define _MACH_TASK_SPECIAL_PORTS_H_
  69
  70 typedef int     task_special_port_t;
  71
  72 #define TASK_KERNEL_PORT        1       /* Represents task to the outside
  73                                            world.*/
  74
  75 #define TASK_HOST_PORT          2       /* The host (priv) port for task.  */
  76
  77 #define TASK_NAME_PORT          3       /* the name (unpriv) port for task */
  78
  79 #define TASK_BOOTSTRAP_PORT     4       /* Bootstrap environment for task. */
  80
  81 /*
  82  * Evolving and likely to change.
  83  */
  84
  85 #define TASK_WIRED_LEDGER_PORT  5       /* Wired resource ledger for task. */
  86
  87 #define TASK_PAGED_LEDGER_PORT  6       /* Paged resource ledger for task. */
  88
  89 #define task_get_wired_ledger_port(task, port)  \
  90                 (task_get_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
  91
  92 #define task_set_wired_ledger_port(task, port)  \
  93                 (task_set_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
  94
  95 #define task_get_paged_ledger_port(task, port)  \
  96                 (task_get_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
  97
  98 #define task_set_paged_ledger_port(task, port)  \
  99                 (task_set_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
 100
 101 /*
 102  *      Definitions for ease of use
 103  */
 104
 105 #define task_get_kernel_port(task, port)        \
 106                 (task_get_special_port((task), TASK_KERNEL_PORT, (port)))
 107
 108 #define task_set_kernel_port(task, port)        \
 109                 (task_set_special_port((task), TASK_KERNEL_PORT, (port)))
 110
 111 #define task_get_host_port(task, port)          \
 112                 (task_get_special_port((task), TASK_HOST_PORT, (port)))
 113
 114 #define task_set_host_port(task, port)  \
 115                 (task_set_special_port((task), TASK_HOST_PORT, (port)))
 116
 117 #define task_get_bootstrap_port(task, port)     \
 118                 (task_get_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 119
 120 #define task_set_bootstrap_port(task, port)     \
 121                 (task_set_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 122
 123 #endif  /* _MACH_TASK_SPECIAL_PORTS_H_ */