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