osfmk/ipc/ipc_hash.h

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