]> git.saurik.com Git - apple/xnu.git/blame - osfmk/mach/task_special_ports.h
xnu-792.10.96.tar.gz
[apple/xnu.git] / osfmk / mach / task_special_ports.h
CommitLineData
1c79356b 1/*
9bccf70c 2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
1c79356b
A
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
37839358
A
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.
1c79356b 11 *
37839358
A
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
1c79356b
A
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
37839358
A
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.
1c79356b
A
19 *
20 * @APPLE_LICENSE_HEADER_END@
21 */
22/*
23 * @OSF_COPYRIGHT@
24 */
1c79356b
A
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
64typedef 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
c0fea474
A
71#define TASK_NAME_PORT 3 /* the name (unpriv) port for task */
72
1c79356b
A
73#define TASK_BOOTSTRAP_PORT 4 /* Bootstrap environment for task. */
74
91447636
A
75/*
76 * Evolving and likely to change.
77 */
9bccf70c 78
1c79356b
A
79#define TASK_WIRED_LEDGER_PORT 5 /* Wired resource ledger for task. */
80
81#define TASK_PAGED_LEDGER_PORT 6 /* Paged resource ledger for task. */
82
9bccf70c
A
83#define task_get_wired_ledger_port(task, port) \
84 (task_get_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
85
86#define task_set_wired_ledger_port(task, port) \
87 (task_set_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
88
89#define task_get_paged_ledger_port(task, port) \
90 (task_get_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
91
92#define task_set_paged_ledger_port(task, port) \
93 (task_set_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
94
1c79356b
A
95/*
96 * Definitions for ease of use
97 */
98
99#define task_get_kernel_port(task, port) \
100 (task_get_special_port((task), TASK_KERNEL_PORT, (port)))
101
102#define task_set_kernel_port(task, port) \
103 (task_set_special_port((task), TASK_KERNEL_PORT, (port)))
104
105#define task_get_host_port(task, port) \
106 (task_get_special_port((task), TASK_HOST_PORT, (port)))
107
108#define task_set_host_port(task, port) \
109 (task_set_special_port((task), TASK_HOST_PORT, (port)))
110
111#define task_get_bootstrap_port(task, port) \
112 (task_get_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
113
114#define task_set_bootstrap_port(task, port) \
115 (task_set_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
116
1c79356b 117#endif /* _MACH_TASK_SPECIAL_PORTS_H_ */