osfmk/ipc/ipc_splay.h

   1 /*
   2  * Copyright (c) 2000 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_splay.h
  60  *      Author: Rich Draves
  61  *      Date:   1989
  62  *
  63  *      Declarations of primitive splay tree operations.
  64  */
  65
  66 #ifndef _IPC_IPC_SPLAY_H_
  67 #define _IPC_IPC_SPLAY_H_
  68
  69 #include <mach/port.h>
  70 #include <kern/assert.h>
  71 #include <kern/macro_help.h>
  72 #include <ipc/ipc_entry.h>
  73
  74 typedef struct ipc_splay_tree {
  75         mach_port_name_t ist_name;      /* name used in last lookup */
  76         ipc_tree_entry_t ist_root;      /* root of middle tree */
  77         ipc_tree_entry_t ist_ltree;     /* root of left tree */
  78         ipc_tree_entry_t *ist_ltreep;   /* pointer into left tree */
  79         ipc_tree_entry_t ist_rtree;     /* root of right tree */
  80         ipc_tree_entry_t *ist_rtreep;   /* pointer into right tree */
  81 } *ipc_splay_tree_t;
  82
  83 #define ist_lock(splay)         /* no locking */
  84 #define ist_unlock(splay)       /* no locking */
  85
  86 /* Initialize a raw splay tree */
  87 extern void ipc_splay_tree_init(
  88         ipc_splay_tree_t        splay);
  89
  90 /* Pick a random entry in a splay tree */
  91 extern boolean_t ipc_splay_tree_pick(
  92         ipc_splay_tree_t        splay,
  93         mach_port_name_t        *namep,
  94         ipc_tree_entry_t        *entryp);
  95
  96 /* Find an entry in a splay tree */
  97 extern ipc_tree_entry_t ipc_splay_tree_lookup(
  98         ipc_splay_tree_t        splay,
  99         mach_port_name_t        name);
 100
 101 /* Insert a new entry into a splay tree */
 102 extern void ipc_splay_tree_insert(
 103         ipc_splay_tree_t        splay,
 104         mach_port_name_t        name,
 105         ipc_tree_entry_t        entry);
 106
 107 /* Delete an entry from a splay tree */
 108 extern void ipc_splay_tree_delete(
 109         ipc_splay_tree_t        splay,
 110         mach_port_name_t        name,
 111         ipc_tree_entry_t        entry);
 112
 113 /* Split a splay tree */
 114 extern void ipc_splay_tree_split(
 115         ipc_splay_tree_t        splay,
 116         mach_port_name_t        name,
 117         ipc_splay_tree_t        entry);
 118
 119 /* Join two splay trees */
 120 extern void ipc_splay_tree_join(
 121         ipc_splay_tree_t        splay,
 122         ipc_splay_tree_t        small);
 123
 124 /* Do a bounded splay tree lookup */
 125 extern void ipc_splay_tree_bounds(
 126         ipc_splay_tree_t        splay,
 127         mach_port_name_t        name,
 128         mach_port_name_t        *lowerp,
 129         mach_port_name_t        *upperp);
 130
 131 /* Initialize a symmetric order traversal of a splay tree */
 132 extern ipc_tree_entry_t ipc_splay_traverse_start(
 133         ipc_splay_tree_t        splay);
 134
 135 /* Return the next entry in a symmetric order traversal of a splay tree */
 136 extern ipc_tree_entry_t ipc_splay_traverse_next(
 137         ipc_splay_tree_t        splay,
 138         boolean_t               delete);
 139
 140 /* Terminate a symmetric order traversal of a splay tree */
 141 extern void ipc_splay_traverse_finish(
 142         ipc_splay_tree_t        splay);
 143
 144 #endif  /* _IPC_IPC_SPLAY_H_ */