1/*
2 * Copyright (c) 2000-2007 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 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#ifndef _KERN_IPC_HOST_H_
60#define _KERN_IPC_HOST_H_
61
62#include <mach/port.h>
63#include <kern/kern_types.h>
64
65/* Initialize IPC host services */
66extern void ipc_host_init(void);
67
68/* Initialize ipc access to processor by allocating a port */
69extern void ipc_processor_init(
70 processor_t processor);
71
72/* Initialize ipc control of a processor set */
73extern void ipc_pset_init(
74 processor_set_t pset);
75
76/* Initialize ipc control of a clock */
77extern void ipc_clock_init(
78 clock_t clock);
79
80/* Convert from a port to a clock */
81extern clock_t convert_port_to_clock(
82 ipc_port_t port);
83
84/* Convert from a clock to a port */
85extern ipc_port_t convert_clock_to_port(
86 clock_t clock);
87
88/* Convert from a clock name to a clock pointer */
89extern clock_t port_name_to_clock(
90 mach_port_name_t clock_name);
91
92extern ipc_port_t host_port_copy_send(
93 ipc_port_t port);
94
95/* Convert from a port to a host */
96extern host_t convert_port_to_host(
97 ipc_port_t port);
98
99/* Convert from a port to a host privilege port */
100extern host_t convert_port_to_host_priv(
101 ipc_port_t port);
102
103/* Convert from a host to a port */
104extern ipc_port_t convert_host_to_port(
105 host_t host);
106
107/* Convert from a port to a processor */
108extern processor_t convert_port_to_processor(
109 ipc_port_t port);
110
111/* Convert from a processor to a port */
112extern ipc_port_t convert_processor_to_port(
113 processor_t processor);
114
115/* Convert from a port to a processor set */
116extern processor_set_t convert_port_to_pset(
117 ipc_port_t port);
118
119/* Convert from a port to a processor set name */
120extern processor_set_t convert_port_to_pset_name(
121 ipc_port_t port);
122
123/* Convert from a processor set to a port */
124extern ipc_port_t convert_pset_to_port(
125 processor_set_t processor);
126
127/* Convert from a processor set name to a port */
128extern ipc_port_t convert_pset_name_to_port(
129 processor_set_t processor);
130
131#endif /* _KERN_IPC_HOST_H_ */
132