1/*
2 * Copyright (c) 2000-2004 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_pset.h
60 *	Author:	Rich Draves
61 *	Date:	1989
62 *
63 *	Definitions for port sets.
64 */
65
66#ifndef	_IPC_IPC_PSET_H_
67#define _IPC_IPC_PSET_H_
68
69#include <mach/mach_types.h>
70#include <mach/port.h>
71#include <mach/kern_return.h>
72#include <kern/kern_types.h>
73#include <ipc/ipc_types.h>
74#include <ipc/ipc_object.h>
75#include <ipc/ipc_mqueue.h>
76
77struct ipc_pset {
78
79	/*
80	 * Initial sub-structure in common with all ipc_objects.
81	 */
82	struct ipc_object	ips_object;
83	struct ipc_mqueue	ips_messages;
84};
85
86#define	ips_references		ips_object.io_references
87#define ips_local_name		ips_messages.imq_local_name
88
89
90#define	ips_active(pset)	io_active(&(pset)->ips_object)
91#define	ips_lock(pset)		io_lock(&(pset)->ips_object)
92#define	ips_lock_try(pset)	io_lock_try(&(pset)->ips_object)
93#define	ips_unlock(pset)	io_unlock(&(pset)->ips_object)
94#define	ips_reference(pset)	io_reference(&(pset)->ips_object)
95#define	ips_release(pset)	io_release(&(pset)->ips_object)
96
97/* Allocate a port set */
98extern kern_return_t ipc_pset_alloc(
99	ipc_space_t		space,
100	mach_port_name_t	*namep,
101	ipc_pset_t		*psetp);
102
103/* Allocate a port set, with a specific name */
104extern kern_return_t ipc_pset_alloc_name(
105	ipc_space_t		space,
106	mach_port_name_t	name,
107	ipc_pset_t		*psetp);
108
109/* Add a port to a port set */
110extern kern_return_t ipc_pset_add(
111	ipc_pset_t	pset,
112	ipc_port_t	port,
113	wait_queue_link_t wql);
114
115/* determine if port is a member of set */
116extern boolean_t ipc_pset_member(
117	ipc_pset_t	pset,
118	ipc_port_t	port);
119
120/* Remove a port from a port set */
121extern kern_return_t ipc_pset_remove(
122	ipc_pset_t	pset,
123	ipc_port_t	port,
124	wait_queue_link_t *wqlp);
125
126/* Remove a port from all its current port sets */
127extern kern_return_t ipc_pset_remove_from_all(
128	ipc_port_t	port,
129	queue_t		links);
130
131/* Destroy a port_set */
132extern void ipc_pset_destroy(
133	ipc_pset_t	pset);
134
135#endif	/* _IPC_IPC_PSET_H_ */
136