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_notify.h
60 * Author: Rich Draves
61 * Date: 1989
62 *
63 * Declarations of notification-sending functions.
64 */
65
66#ifndef _IPC_IPC_NOTIFY_H_
67#define _IPC_IPC_NOTIFY_H_
68
69#include <mach/port.h>
70
71#pragma GCC visibility push(hidden)
72
73typedef struct ipc_notify_nsenders {
74 ipc_port_t ns_notify;
75 mach_port_mscount_t ns_mscount;
76 boolean_t ns_is_kobject;
77} ipc_notify_nsenders_t;
78
79/*
80 * Exported interfaces
81 */
82
83/* Send a port-deleted notification */
84extern void ipc_notify_port_deleted(
85 ipc_port_t port,
86 mach_port_name_t name);
87
88/* Send a send-possible notification */
89extern void ipc_notify_send_possible(
90 ipc_port_t port,
91 mach_port_name_t name);
92
93/* Send a port-destroyed notification */
94extern void ipc_notify_port_destroyed(
95 ipc_port_t port,
96 ipc_port_t right);
97
98/* Send a no-senders notification */
99extern void ipc_notify_no_senders(
100 ipc_port_t notify,
101 mach_port_mscount_t mscount,
102 boolean_t kobject);
103
104extern ipc_notify_nsenders_t ipc_notify_no_senders_prepare(
105 ipc_port_t port);
106
107static inline void
108ipc_notify_no_senders_emit(ipc_notify_nsenders_t nsrequest)
109{
110 if (nsrequest.ns_notify) {
111 ipc_notify_no_senders(notify: nsrequest.ns_notify,
112 mscount: nsrequest.ns_mscount, kobject: nsrequest.ns_is_kobject);
113 }
114}
115
116extern void ipc_notify_no_senders_consume(
117 ipc_notify_nsenders_t nsrequest);
118
119/* Send a send-once notification */
120extern void ipc_notify_send_once_and_unlock(
121 ipc_port_t port);
122
123/* Send a dead-name notification */
124extern void ipc_notify_dead_name(
125 ipc_port_t port,
126 mach_port_name_t name);
127
128#pragma GCC visibility pop
129
130#endif /* _IPC_IPC_NOTIFY_H_ */
131