xref: /xnu-8796.101.5/osfmk/mach/notify.h (revision aca3beaa3dfbd42498b42c5e5ce20a938e6554e5)
1 /*
2  * Copyright (c) 2000-2003 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,1987 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  [email protected]
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:	mach/notify.h
60  *
61  *	Kernel notification message definitions.
62  */
63 
64 #ifndef _MACH_NOTIFY_H_
65 #define _MACH_NOTIFY_H_
66 
67 #include <mach/port.h>
68 #include <mach/message.h>
69 #include <mach/ndr.h>
70 
71 /*
72  *  An alternative specification of the notification interface
73  *  may be found in mach/notify.defs.
74  */
75 
76 #define MACH_NOTIFY_FIRST               0100
77 #define MACH_NOTIFY_PORT_DELETED        (MACH_NOTIFY_FIRST + 001)
78 /* A send or send-once right was deleted. */
79 #define MACH_NOTIFY_SEND_POSSIBLE       (MACH_NOTIFY_FIRST + 002)
80 /* Now possible to send using specified right */
81 #define MACH_NOTIFY_PORT_DESTROYED      (MACH_NOTIFY_FIRST + 005)
82 /* A receive right was (would have been) deallocated */
83 #define MACH_NOTIFY_NO_SENDERS          (MACH_NOTIFY_FIRST + 006)
84 /* Receive right has no extant send rights */
85 #define MACH_NOTIFY_SEND_ONCE           (MACH_NOTIFY_FIRST + 007)
86 /* An extant send-once right died */
87 #define MACH_NOTIFY_DEAD_NAME           (MACH_NOTIFY_FIRST + 010)
88 /* Send or send-once right died, leaving a dead-name */
89 #define MACH_NOTIFY_LAST                (MACH_NOTIFY_FIRST + 015)
90 
91 typedef mach_port_t notify_port_t;
92 
93 /*
94  * Hard-coded message structures for receiving Mach port notification
95  * messages.  However, they are not actual large enough to receive
96  * the largest trailers current exported by Mach IPC (so they cannot
97  * be used for space allocations in situations using these new larger
98  * trailers).  Instead, the MIG-generated server routines (and
99  * related prototypes should be used).
100  */
101 typedef struct {
102 	mach_msg_header_t   not_header;
103 	NDR_record_t        NDR;
104 	mach_port_name_t not_port;/* MACH_MSG_TYPE_PORT_NAME */
105 	mach_msg_format_0_trailer_t trailer;
106 } mach_port_deleted_notification_t;
107 
108 typedef struct {
109 	mach_msg_header_t   not_header;
110 	NDR_record_t        NDR;
111 	mach_port_name_t not_port;/* MACH_MSG_TYPE_PORT_NAME */
112 	mach_msg_format_0_trailer_t trailer;
113 } mach_send_possible_notification_t;
114 
115 typedef struct {
116 	mach_msg_header_t   not_header;
117 	mach_msg_body_t     not_body;
118 	mach_msg_port_descriptor_t not_port;/* MACH_MSG_TYPE_PORT_RECEIVE */
119 	mach_msg_format_0_trailer_t trailer;
120 } mach_port_destroyed_notification_t;
121 
122 typedef struct {
123 	mach_msg_header_t   not_header;
124 	NDR_record_t        NDR;
125 	mach_msg_type_number_t not_count;
126 	mach_msg_format_0_trailer_t trailer;
127 } mach_no_senders_notification_t;
128 
129 typedef struct {
130 	mach_msg_header_t   not_header;
131 	mach_msg_format_0_trailer_t trailer;
132 } mach_send_once_notification_t;
133 
134 typedef struct {
135 	mach_msg_header_t   not_header;
136 	NDR_record_t        NDR;
137 	mach_port_name_t not_port;/* MACH_MSG_TYPE_PORT_NAME */
138 	mach_msg_format_0_trailer_t trailer;
139 } mach_dead_name_notification_t;
140 
141 #endif  /* _MACH_NOTIFY_H_ */
142