]> git.saurik.com Git - apple/xnu.git/blame - osfmk/ipc/ipc_hash.h
xnu-2782.10.72.tar.gz
[apple/xnu.git] / osfmk / ipc / ipc_hash.h
CommitLineData
1c79356b 1/*
91447636 2 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6601e61a 5 *
2d21ac55
A
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.
6601e61a 14 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
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_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
91447636
A
69#include <mach/port.h>
70#include <mach/mach_types.h>
1c79356b
A
71#include <mach/boolean.h>
72#include <mach/kern_return.h>
91447636 73#include <ipc/ipc_types.h>
1c79356b
A
74/*
75 * Exported interfaces
76 */
77
78/* Lookup (space, obj) in the appropriate reverse hash table */
79extern boolean_t ipc_hash_lookup(
80 ipc_space_t space,
81 ipc_object_t obj,
82 mach_port_name_t *namep,
83 ipc_entry_t *entryp);
84
85/* Insert an entry into the appropriate reverse hash table */
86extern void ipc_hash_insert(
87 ipc_space_t space,
88 ipc_object_t obj,
89 mach_port_name_t name,
90 ipc_entry_t entry);
91
92/* Delete an entry from the appropriate reverse hash table */
93extern void ipc_hash_delete(
94 ipc_space_t space,
95 ipc_object_t obj,
96 mach_port_name_t name,
97 ipc_entry_t entry);
98
99/*
100 * For use by functions that know what they're doing:
316670eb 101 * local primitives are for table entries.
1c79356b
A
102 */
103
1c79356b 104/* Lookup (space, obj) in local hash table */
316670eb
A
105extern boolean_t ipc_hash_table_lookup(
106 ipc_entry_t table,
107 ipc_entry_num_t size,
1c79356b
A
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 */
316670eb
A
113extern void ipc_hash_table_insert(
114 ipc_entry_t table,
115 ipc_entry_num_t size,
1c79356b
A
116 ipc_object_t obj,
117 mach_port_index_t index,
118 ipc_entry_t entry);
119
316670eb
A
120/* Delete an entry from the appropriate reverse hash table */
121extern void ipc_hash_table_delete(
122 ipc_entry_t table,
123 ipc_entry_num_t size,
124 ipc_object_t obj,
125 mach_port_name_t name,
126 ipc_entry_t entry);
1c79356b
A
127
128#include <mach_ipc_debug.h>
129
130#if MACH_IPC_DEBUG
131
91447636 132#include <mach_debug/hash_info.h>
316670eb 133
1c79356b
A
134extern natural_t ipc_hash_info(
135 hash_info_bucket_t *info,
2d21ac55 136 natural_t count);
1c79356b
A
137
138#endif /* MACH_IPC_DEBUG */
139
140#endif /* _IPC_IPC_HASH_H_ */