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  * 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  * Mach Operating System
  27  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie Mellon
  48  * the rights to redistribute these changes.
  49  */
  50 /*
  51  */
  52 /*
  53  *      File:   mach/task_special_ports.h
  54  *
  55  *      Defines codes for special_purpose task ports.  These are NOT
  56  *      port identifiers - they are only used for the task_get_special_port
  57  *      and task_set_special_port routines.
  58  *
  59  */
  60
  61 #ifndef _MACH_TASK_SPECIAL_PORTS_H_
  62 #define _MACH_TASK_SPECIAL_PORTS_H_
  63
  64 typedef int     task_special_port_t;
  65
  66 #define TASK_KERNEL_PORT        1       /* Represents task to the outside
  67                                            world.*/
  68
  69 #define TASK_HOST_PORT          2       /* The host (priv) port for task.  */
  70
  71 #define TASK_BOOTSTRAP_PORT     4       /* Bootstrap environment for task. */
  72
  73 /*
  74  * Evolving and likely to change.
  75  */
  76
  77 #define TASK_WIRED_LEDGER_PORT  5       /* Wired resource ledger for task. */
  78
  79 #define TASK_PAGED_LEDGER_PORT  6       /* Paged resource ledger for task. */
  80
  81 #define task_get_wired_ledger_port(task, port)  \
  82                 (task_get_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
  83
  84 #define task_set_wired_ledger_port(task, port)  \
  85                 (task_set_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
  86
  87 #define task_get_paged_ledger_port(task, port)  \
  88                 (task_get_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
  89
  90 #define task_set_paged_ledger_port(task, port)  \
  91                 (task_set_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
  92
  93 /*
  94  *      Definitions for ease of use
  95  */
  96
  97 #define task_get_kernel_port(task, port)        \
  98                 (task_get_special_port((task), TASK_KERNEL_PORT, (port)))
  99
 100 #define task_set_kernel_port(task, port)        \
 101                 (task_set_special_port((task), TASK_KERNEL_PORT, (port)))
 102
 103 #define task_get_host_port(task, port)          \
 104                 (task_get_special_port((task), TASK_HOST_PORT, (port)))
 105
 106 #define task_set_host_port(task, port)  \
 107                 (task_set_special_port((task), TASK_HOST_PORT, (port)))
 108
 109 #define task_get_bootstrap_port(task, port)     \
 110                 (task_get_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 111
 112 #define task_set_bootstrap_port(task, port)     \
 113                 (task_set_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
 114
 115 #endif  /* _MACH_TASK_SPECIAL_PORTS_H_ */