1/*
2 * Copyright (c) 2000-2006 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 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 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
58 * support for mandatory and extensible security protections. This notice
59 * is included in support of clause 2.2 (b) of the Apple Public License,
60 * Version 2.0.
61 */
62/*
63 */
64/*
65 * File: kern/ipc_kobject.h
66 * Author: Rich Draves
67 * Date: 1989
68 *
69 * Declarations for letting a port represent a kernel object.
70 */
71
72#ifdef MACH_KERNEL_PRIVATE
73#include <ipc/ipc_kmsg.h>
74#include <ipc/ipc_port.h>
75#endif /* MACH_KERNEL_PRIVATE */
76
77#ifndef _KERN_IPC_KOBJECT_H_
78#define _KERN_IPC_KOBJECT_H_
79
80#ifdef KERNEL_PRIVATE
81/*
82 * This is the legacy in-kernel ipc-object mechanism. Over the next
83 * several months, this will be phased out in favor of a mechanism that
84 * is less Mach IPC specific, and common across in-mach, in-kernel-component,
85 * and user-level-component (Plugin) models.
86 */
87#include <mach/machine/vm_types.h>
88#include <mach/mach_types.h>
89
90typedef natural_t ipc_kobject_type_t;
91
92#define IKOT_NONE 0
93#define IKOT_THREAD 1
94#define IKOT_TASK 2
95#define IKOT_HOST 3
96#define IKOT_HOST_PRIV 4
97#define IKOT_PROCESSOR 5
98#define IKOT_PSET 6
99#define IKOT_PSET_NAME 7
100#define IKOT_TIMER 8
101#define IKOT_PAGING_REQUEST 9
102#define IKOT_MIG 10
103#define IKOT_MEMORY_OBJECT 11
104#define IKOT_XMM_PAGER 12
105#define IKOT_XMM_KERNEL 13
106#define IKOT_XMM_REPLY 14
107#define IKOT_UND_REPLY 15
108#define IKOT_HOST_NOTIFY 16
109#define IKOT_HOST_SECURITY 17
110#define IKOT_LEDGER 18
111#define IKOT_MASTER_DEVICE 19
112#define IKOT_TASK_NAME 20
113#define IKOT_SUBSYSTEM 21
114#define IKOT_IO_DONE_QUEUE 22
115#define IKOT_SEMAPHORE 23
116#define IKOT_LOCK_SET 24
117#define IKOT_CLOCK 25
118#define IKOT_CLOCK_CTRL 26
119#define IKOT_IOKIT_IDENT 27
120#define IKOT_NAMED_ENTRY 28
121#define IKOT_IOKIT_CONNECT 29
122#define IKOT_IOKIT_OBJECT 30
123#define IKOT_UPL 31
124#define IKOT_MEM_OBJ_CONTROL 32
125#define IKOT_AU_SESSIONPORT 33
126#define IKOT_FILEPORT 34
127#define IKOT_LABELH 35
128#define IKOT_TASK_RESUME 36
129#define IKOT_VOUCHER 37
130#define IKOT_VOUCHER_ATTR_CONTROL 38
131#define IKOT_WORK_INTERVAL 39
132#define IKOT_UX_HANDLER 40
133
134/*
135 * Add new entries here and adjust IKOT_UNKNOWN.
136 * Please keep ipc/ipc_object.c:ikot_print_array up to date.
137 */
138#define IKOT_UNKNOWN 41 /* magic catchall */
139#define IKOT_MAX_TYPE (IKOT_UNKNOWN+1) /* # of IKOT_ types */
140
141
142#define is_ipc_kobject(ikot) ((ikot) != IKOT_NONE)
143
144#ifdef MACH_KERNEL_PRIVATE
145
146/*
147 * Define types of kernel objects that use page lists instead
148 * of entry lists for copyin of out of line memory.
149 */
150
151/* Dispatch a kernel server function */
152extern ipc_kmsg_t ipc_kobject_server(
153 ipc_kmsg_t request,
154 mach_msg_option_t option);
155
156/* Make a port represent a kernel object of the given type */
157extern void ipc_kobject_set(
158 ipc_port_t port,
159 ipc_kobject_t kobject,
160 ipc_kobject_type_t type);
161
162extern void ipc_kobject_set_atomically(
163 ipc_port_t port,
164 ipc_kobject_t kobject,
165 ipc_kobject_type_t type);
166
167/* Release any kernel object resources associated with a port */
168extern void ipc_kobject_destroy(
169 ipc_port_t port);
170
171#define null_conversion(port) (port)
172
173#endif /* MACH_KERNEL_PRIVATE */
174
175#endif /* KERNEL_PRIVATE */
176
177#endif /* _KERN_IPC_KOBJECT_H_ */
178
179