1/*
2 * Copyright (c) 2000 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 */
58/*
59 *	File:	ipc/ipc_right.h
60 *	Author:	Rich Draves
61 *	Date:	1989
62 *
63 *	Declarations of functions to manipulate IPC capabilities.
64 */
65
66#ifndef	_IPC_IPC_RIGHT_H_
67#define	_IPC_IPC_RIGHT_H_
68
69#include <mach/boolean.h>
70#include <mach/kern_return.h>
71#include <ipc/ipc_port.h>
72#include <ipc/ipc_entry.h>
73
74#define	ipc_right_lookup_read		ipc_right_lookup_write
75#define ipc_right_lookup_two_read	ipc_right_lookup_two_write
76
77/* Find an entry in a space, given the name */
78extern kern_return_t ipc_right_lookup_write(
79	ipc_space_t		space,
80	mach_port_name_t	name,
81	ipc_entry_t		*entryp);
82
83/* Find two entries in a space, given two names */
84extern kern_return_t ipc_right_lookup_two_write(
85	ipc_space_t		space,
86	mach_port_name_t	name1,
87	ipc_entry_t		*entryp1,
88	mach_port_name_t	name2,
89	ipc_entry_t		*entryp2);
90
91/* Translate (space, object) -> (name, entry) */
92extern boolean_t ipc_right_reverse(
93	ipc_space_t		space,
94	ipc_object_t		object,
95	mach_port_name_t	*namep,
96	ipc_entry_t		*entryp);
97
98/* Make a dead-name request, returning the registered send-once right */
99extern kern_return_t ipc_right_dnrequest(
100	ipc_space_t		space,
101	mach_port_name_t	name,
102	boolean_t		immediate,
103	ipc_port_t		notify,
104	ipc_port_t		*previousp);
105
106/* Cancel a dead-name request and return the send-once right */
107extern ipc_port_t ipc_right_dncancel(
108	ipc_space_t		space,
109	ipc_port_t		port,
110	mach_port_name_t	name,
111	ipc_entry_t		entry);
112
113#define	ipc_right_dncancel_macro(space, port, name, entry)		\
114		 ((entry->ie_request == 0) ? IP_NULL :			\
115		 ipc_right_dncancel((space), (port), (name), (entry)))
116
117/* Check if an entry is being used */
118extern boolean_t ipc_right_inuse(
119	ipc_space_t		space,
120	mach_port_name_t	name,
121	ipc_entry_t		entry);
122
123/* Check if the port has died */
124extern boolean_t ipc_right_check(
125	ipc_space_t		space,
126	ipc_port_t		port,
127	mach_port_name_t	name,
128	ipc_entry_t		entry);
129
130/* Clean up an entry in a dead space */
131extern void ipc_right_clean(
132	ipc_space_t		space,
133	mach_port_name_t	name,
134	ipc_entry_t		entry);
135
136/* Destroy an entry in a space */
137extern kern_return_t ipc_right_destroy(
138	ipc_space_t		space,
139	mach_port_name_t	name,
140	ipc_entry_t		entry);
141
142/* Release a send/send-once/dead-name user reference */
143extern kern_return_t ipc_right_dealloc(
144	ipc_space_t		space,
145	mach_port_name_t	name,
146	ipc_entry_t		entry);
147
148/* Modify the user-reference count for a right */
149extern kern_return_t ipc_right_delta(
150	ipc_space_t		space,
151	mach_port_name_t	name,
152	ipc_entry_t		entry,
153	mach_port_right_t	right,
154	mach_port_delta_t	delta);
155
156/* Retrieve information about a right */
157extern kern_return_t ipc_right_info(
158	ipc_space_t		space,
159	mach_port_name_t	name,
160	ipc_entry_t		entry,
161	mach_port_type_t	*typep,
162	mach_port_urefs_t	*urefsp);
163
164/* Check if a subsequent ipc_right_copyin would succeed */
165extern boolean_t ipc_right_copyin_check(
166	ipc_space_t		space,
167	mach_port_name_t	name,
168	ipc_entry_t		entry,
169	mach_msg_type_name_t	msgt_name);
170
171/* Copyin a capability from a space */
172extern kern_return_t ipc_right_copyin(
173	ipc_space_t		space,
174	mach_port_name_t	name,
175	ipc_entry_t		entry,
176	mach_msg_type_name_t	msgt_name,
177	boolean_t		deadok,
178	ipc_object_t		*objectp,
179	ipc_port_t		*sorightp);
180
181/* Undo the effects of an ipc_right_copyin */
182extern void ipc_right_copyin_undo(
183	ipc_space_t		space,
184	mach_port_name_t	name,
185	ipc_entry_t		entry,
186	mach_msg_type_name_t	msgt_name,
187	ipc_object_t		object,
188	ipc_port_t		soright);
189
190/* Copyin two send rights from a space */
191extern kern_return_t ipc_right_copyin_two(
192	ipc_space_t		space,
193	mach_port_name_t	name,
194	ipc_entry_t		entry,
195	ipc_object_t		*objectp,
196	ipc_port_t		*sorightp);
197
198/* Copyout a capability to a space */
199extern kern_return_t ipc_right_copyout(
200	ipc_space_t		space,
201	mach_port_name_t	name,
202	ipc_entry_t		entry,
203	mach_msg_type_name_t	msgt_name,
204	boolean_t		overflow,
205	ipc_object_t		object);
206
207/* Reanme a capability */
208extern kern_return_t ipc_right_rename(
209	ipc_space_t		space,
210	mach_port_name_t	oname,
211	ipc_entry_t		oentry,
212	mach_port_name_t	nname,
213	ipc_entry_t		nentry);
214
215#endif	/* _IPC_IPC_RIGHT_H_ */
216