]> git.saurik.com Git - apple/xnu.git/blame_incremental - osfmk/ipc/ipc_pset.h
xnu-344.21.74.tar.gz
[apple/xnu.git] / osfmk / ipc / ipc_pset.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
7 *
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * file.
14 *
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
22 *
23 * @APPLE_LICENSE_HEADER_END@
24 */
25/*
26 * @OSF_COPYRIGHT@
27 */
28/*
29 * Mach Operating System
30 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
31 * All Rights Reserved.
32 *
33 * Permission to use, copy, modify and distribute this software and its
34 * documentation is hereby granted, provided that both the copyright
35 * notice and this permission notice appear in all copies of the
36 * software, derivative works or modified versions, and any portions
37 * thereof, and that both notices appear in supporting documentation.
38 *
39 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
40 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
41 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
42 *
43 * Carnegie Mellon requests users of this software to return to
44 *
45 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
46 * School of Computer Science
47 * Carnegie Mellon University
48 * Pittsburgh PA 15213-3890
49 *
50 * any improvements or extensions that they make and grant Carnegie Mellon
51 * the rights to redistribute these changes.
52 */
53/*
54 */
55/*
56 * File: ipc/ipc_pset.h
57 * Author: Rich Draves
58 * Date: 1989
59 *
60 * Definitions for port sets.
61 */
62
63#ifndef _IPC_IPC_PSET_H_
64#define _IPC_IPC_PSET_H_
65
66#include <mach/port.h>
67#include <mach/kern_return.h>
68#include <kern/ipc_kobject.h>
69#include <ipc/ipc_object.h>
70#include <ipc/ipc_mqueue.h>
71
72#include <mach_kdb.h>
73
74typedef struct ipc_pset {
75
76 /*
77 * Initial sub-structure in common with all ipc_objects.
78 */
79 struct ipc_object ips_object;
80 struct ipc_mqueue ips_messages;
81} *ipc_pset_t;
82
83#define ips_references ips_object.io_references
84#define ips_local_name ips_object.io_receiver_name
85
86#define IPS_NULL ((ipc_pset_t) IO_NULL)
87
88#define ips_active(pset) io_active(&(pset)->ips_object)
89#define ips_lock(pset) io_lock(&(pset)->ips_object)
90#define ips_lock_try(pset) io_lock_try(&(pset)->ips_object)
91#define ips_unlock(pset) io_unlock(&(pset)->ips_object)
92#define ips_check_unlock(pset) io_check_unlock(&(pset)->ips_object)
93#define ips_reference(pset) io_reference(&(pset)->ips_object)
94#define ips_release(pset) io_release(&(pset)->ips_object)
95
96/* Allocate a port set */
97extern kern_return_t ipc_pset_alloc(
98 ipc_space_t space,
99 mach_port_name_t *namep,
100 ipc_pset_t *psetp);
101
102/* Allocate a port set, with a specific name */
103extern kern_return_t ipc_pset_alloc_name(
104 ipc_space_t space,
105 mach_port_name_t name,
106 ipc_pset_t *psetp);
107
108/* Add a port to a port set */
109extern kern_return_t ipc_pset_add(
110 ipc_pset_t pset,
111 ipc_port_t port);
112
113/* Remove a port from a port set */
114extern kern_return_t ipc_pset_remove(
115 ipc_pset_t pset,
116 ipc_port_t port);
117
118/* Remove a port from all its current port sets */
119extern kern_return_t ipc_pset_remove_from_all(
120 ipc_port_t port);
121
122/* Destroy a port_set */
123extern void ipc_pset_destroy(
124 ipc_pset_t pset);
125
126#define ipc_pset_reference(pset) \
127 ipc_object_reference(&(pset)->ips_object)
128
129#define ipc_pset_release(pset) \
130 ipc_object_release(&(pset)->ips_object)
131
132
133#if MACH_KDB
134int ipc_list_count(struct ipc_kmsg *base);
135#endif /* MACH_KDB */
136
137#endif /* _IPC_IPC_PSET_H_ */