]> git.saurik.com Git - apple/xnu.git/blame - osfmk/ipc/ipc_hash.h
xnu-792.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
A
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
e5568f75
A
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
11 *
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b
A
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75
A
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
18 * under the License.
1c79356b
A
19 *
20 * @APPLE_LICENSE_HEADER_END@
21 */
22/*
23 * @OSF_COPYRIGHT@
24 */
25/*
26 * Mach Operating System
27 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
28 * All Rights Reserved.
29 *
30 * Permission to use, copy, modify and distribute this software and its
31 * documentation is hereby granted, provided that both the copyright
32 * notice and this permission notice appear in all copies of the
33 * software, derivative works or modified versions, and any portions
34 * thereof, and that both notices appear in supporting documentation.
35 *
36 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
37 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
38 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
39 *
40 * Carnegie Mellon requests users of this software to return to
41 *
42 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
43 * School of Computer Science
44 * Carnegie Mellon University
45 * Pittsburgh PA 15213-3890
46 *
47 * any improvements or extensions that they make and grant Carnegie Mellon
48 * the rights to redistribute these changes.
49 */
50/*
51 */
52/*
53 * File: ipc/ipc_hash.h
54 * Author: Rich Draves
55 * Date: 1989
56 *
57 * Declarations of entry hash table operations.
58 */
59
60#ifndef _IPC_IPC_HASH_H_
61#define _IPC_IPC_HASH_H_
62
91447636
A
63#include <mach/port.h>
64#include <mach/mach_types.h>
1c79356b
A
65#include <mach/boolean.h>
66#include <mach/kern_return.h>
91447636 67#include <ipc/ipc_types.h>
1c79356b
A
68/*
69 * Exported interfaces
70 */
71
72/* Lookup (space, obj) in the appropriate reverse hash table */
73extern boolean_t ipc_hash_lookup(
74 ipc_space_t space,
75 ipc_object_t obj,
76 mach_port_name_t *namep,
77 ipc_entry_t *entryp);
78
79/* Insert an entry into the appropriate reverse hash table */
80extern void ipc_hash_insert(
81 ipc_space_t space,
82 ipc_object_t obj,
83 mach_port_name_t name,
84 ipc_entry_t entry);
85
86/* Delete an entry from the appropriate reverse hash table */
87extern void ipc_hash_delete(
88 ipc_space_t space,
89 ipc_object_t obj,
90 mach_port_name_t name,
91 ipc_entry_t entry);
92
93/*
94 * For use by functions that know what they're doing:
95 * the global primitives, for splay tree entries,
96 * and the local primitives, for table entries.
97 */
98
99/* Delete an entry from the global reverse hash table */
100extern void ipc_hash_global_delete(
101 ipc_space_t space,
102 ipc_object_t obj,
103 mach_port_name_t name,
104 ipc_tree_entry_t entry);
105
106/* Lookup (space, obj) in local hash table */
107extern boolean_t ipc_hash_local_lookup(
108 ipc_space_t space,
109 ipc_object_t obj,
110 mach_port_name_t *namep,
111 ipc_entry_t *entryp);
112
113/* Inserts an entry into the local reverse hash table */
114extern void ipc_hash_local_insert(
115 ipc_space_t space,
116 ipc_object_t obj,
117 mach_port_index_t index,
118 ipc_entry_t entry);
119
120/* Initialize the reverse hash table implementation */
121extern void ipc_hash_init(void);
122
123#include <mach_ipc_debug.h>
124
125#if MACH_IPC_DEBUG
126
91447636
A
127#include <mach_debug/hash_info.h>
128
1c79356b
A
129extern natural_t ipc_hash_info(
130 hash_info_bucket_t *info,
131 mach_msg_type_number_t count);
132
133#endif /* MACH_IPC_DEBUG */
134
135#endif /* _IPC_IPC_HASH_H_ */