osfmk/ipc/ipc_hash.h

   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  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
  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_types.h>
  74 /*
  75  * Exported interfaces
  76  */
  77
  78 /* Lookup (space, obj) in the appropriate reverse hash table */
  79 extern 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 */
  86 extern 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 */
  93 extern 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:
 101  *      the global primitives, for splay tree entries,
 102  *      and the local primitives, for table entries.
 103  */
 104
 105 /* Delete an entry from the global reverse hash table */
 106 extern void ipc_hash_global_delete(
 107         ipc_space_t             space,
 108         ipc_object_t            obj,
 109         mach_port_name_t        name,
 110         ipc_tree_entry_t        entry);
 111
 112 /* Lookup (space, obj) in local hash table */
 113 extern boolean_t ipc_hash_local_lookup(
 114         ipc_space_t             space,
 115         ipc_object_t            obj,
 116         mach_port_name_t        *namep,
 117         ipc_entry_t             *entryp);
 118
 119 /* Inserts an entry into the local reverse hash table */
 120 extern void ipc_hash_local_insert(
 121         ipc_space_t             space,
 122         ipc_object_t            obj,
 123         mach_port_index_t       index,
 124         ipc_entry_t             entry);
 125
 126 /* Initialize the reverse hash table implementation */
 127 extern void ipc_hash_init(void) __attribute__((section("__TEXT, initcode")));
 128
 129 #include <mach_ipc_debug.h>
 130
 131 #if     MACH_IPC_DEBUG
 132
 133 #include <mach_debug/hash_info.h>
 134 extern natural_t ipc_hash_size(void);
 135 extern natural_t ipc_hash_info(
 136         hash_info_bucket_t      *info,
 137         natural_t count);
 138
 139 #endif  /* MACH_IPC_DEBUG */
 140
 141 #endif  /* _IPC_IPC_HASH_H_ */