osfmk/ipc/ipc_hash.h

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