xref: /xnu-8792.81.2/osfmk/ipc/ipc_hash.h (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
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_hash.h
60  *	Author:	Rich Draves
61  *	Date:	1989
62  *
63  *	Declarations of entry hash table operations.
64  */
65 
66 #ifndef _IPC_IPC_HASH_H_
67 #define _IPC_IPC_HASH_H_
68 
69 #include <mach/port.h>
70 #include <mach/mach_types.h>
71 #include <mach/boolean.h>
72 #include <mach/kern_return.h>
73 #include <ipc/ipc_entry.h>
74 
75 /*
76  * Exported interfaces
77  */
78 
79 /* Lookup (space, obj) in the appropriate reverse hash table */
80 extern boolean_t ipc_hash_lookup(
81 	ipc_space_t             space,
82 	ipc_object_t            obj,
83 	mach_port_name_t        *namep,
84 	ipc_entry_t             *entryp);
85 
86 /* Insert an entry into the appropriate reverse hash table */
87 extern void ipc_hash_insert(
88 	ipc_space_t             space,
89 	ipc_object_t            obj,
90 	mach_port_name_t        name,
91 	ipc_entry_t             entry);
92 
93 /* Delete an entry from the appropriate reverse hash table */
94 extern void ipc_hash_delete(
95 	ipc_space_t             space,
96 	ipc_object_t            obj,
97 	mach_port_name_t        name,
98 	ipc_entry_t             entry);
99 
100 /*
101  *	For use by functions that know what they're doing:
102  *	local primitives are for table entries.
103  */
104 
105 /* Lookup (space, obj) in local hash table */
106 extern boolean_t ipc_hash_table_lookup(
107 	ipc_entry_table_t       table,
108 	ipc_object_t            obj,
109 	mach_port_name_t        *namep,
110 	ipc_entry_t             *entryp);
111 
112 /* Inserts an entry into the local reverse hash table */
113 extern void ipc_hash_table_insert(
114 	ipc_entry_table_t       table,
115 	ipc_object_t            obj,
116 	mach_port_index_t       index,
117 	ipc_entry_t             entry);
118 
119 /* Delete an entry from the appropriate reverse hash table */
120 extern void ipc_hash_table_delete(
121 	ipc_entry_table_t       table,
122 	ipc_object_t            obj,
123 	mach_port_name_t        name,
124 	ipc_entry_t             entry);
125 
126 #include <mach_debug/hash_info.h>
127 
128 extern natural_t ipc_hash_info(
129 	hash_info_bucket_t      *info,
130 	natural_t count);
131 
132 #endif  /* _IPC_IPC_HASH_H_ */
133