osfmk/mach/task_special_ports.h

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