xref: /xnu-11215.1.10/osfmk/ipc/port.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
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  [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:	ipc/ipc_port.h
60  *	Author:	Rich Draves
61  *	Date:	1989
62  *
63  *	Implementation specific complement to mach/port.h.
64  */
65 
66 #ifndef _IPC_PORT_H_
67 #define _IPC_PORT_H_
68 
69 #include <mach/port.h>
70 #include <ipc/ipc_space.h>
71 
72 #define MACH_PORT_NGEN(name)            MACH_PORT_MAKE(0, MACH_PORT_GEN(name))
73 
74 /*
75  *	Typedefs for code cleanliness.  These must all have
76  *	the same (unsigned) type as mach_port_name_t.
77  */
78 
79 
80 #define MACH_PORT_UREFS_MAX     ((mach_port_urefs_t) ((1 << 16) - 1))
81 
82 #define MACH_PORT_UREFS_OVERFLOW(urefs, delta)                          \
83 	        (((delta) > 0) &&                                       \
84 	         ((((urefs) + (delta)) <= (urefs)) ||                   \
85 	          (((urefs) + (delta)) >= MACH_PORT_UREFS_MAX)))
86 
87 #define MACH_PORT_UREFS_UNDERFLOW(urefs, delta)                         \
88 	        (((delta) < 0) && (((mach_port_urefs_t)-(delta)) > (urefs)))
89 
90 __BEGIN_DECLS
91 
92 __cold
93 extern void mach_port_guard_exception(
94 	mach_port_name_t        name,
95 	uint64_t                inguard,
96 	uint64_t                portguard,
97 	unsigned                reason);
98 
99 __cold
100 extern void mach_port_guard_exception_immovable(
101 	ipc_space_t             space,
102 	mach_port_name_t        name,
103 	mach_port_t             port,
104 	uint64_t                portguard);
105 
106 __cold
107 extern void mach_port_guard_exception_pinned(
108 	ipc_space_t             space,
109 	mach_port_name_t        name,
110 	__unused mach_port_t    port,
111 	uint64_t                portguard);
112 
113 __END_DECLS
114 
115 #endif  /* _IPC_PORT_H_ */
116