common/rb_tree.h

   1 /*
   2    a talloc based red-black tree
   3
   4    Copyright (C) Ronnie Sahlberg  2007
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20
  21
  22 #define TRBT_RED                0x00
  23 #define TRBT_BLACK              0x01
  24 typedef struct trbt_node {
  25         struct trbt_tree *tree;
  26         struct trbt_node *parent;
  27         struct trbt_node *left;
  28         struct trbt_node *right;
  29         uint32_t rb_color;
  30         uint32_t key32;
  31         void *data;
  32 } trbt_node_t;
  33
  34 typedef struct trbt_tree {
  35         trbt_node_t *root;
  36 /* automatically free the tree when the last node has been deleted */
  37 #define TRBT_AUTOFREE           0x00000001
  38         uint32_t flags;
  39 } trbt_tree_t;
  40
  41
  42
  43 /* Create a RB tree */
  44 trbt_tree_t *trbt_create(TALLOC_CTX *memctx, uint32_t flags);
  45
  46 /* Lookup a node in the tree and return a pointer to data or NULL */
  47 void *trbt_lookup32(trbt_tree_t *tree, uint32_t key);
  48
  49 /* Insert a new node into the tree. If there was already a node with this
  50    key the pointer to the previous data is returned.
  51    The tree will talloc_steal() the data inserted into the tree .
  52 */
  53 void *trbt_insert32(trbt_tree_t *tree, uint32_t key, void *data);
  54
  55 /* Insert a new node into the tree.
  56    If this is a new node:
  57      callback is called with data==NULL and param=param
  58      the returned value from the callback is talloc_stolen and inserted in the
  59      tree.
  60    If a node already exists for this key then:
  61      callback is called with data==existing data and param=param
  62      the returned calue is talloc_stolen and inserted in the tree
  63 */
  64 void trbt_insert32_callback(trbt_tree_t *tree, uint32_t key, void *(*callback)(void *param, void *data), void *param);
  65
  66 /* Delete a node from the tree and free all data associated with it */
  67 void trbt_delete32(trbt_tree_t *tree, uint32_t key);
  68
  69
  70 /* insert into the tree with a key based on an array of uint32 */
  71 void trbt_insertarray32_callback(trbt_tree_t *tree, uint32_t keylen, uint32_t *key, void *(*callback)(void *param, void *data), void *param);
  72
  73 /* Lookup a node in the tree with a key based on an array of uint32
  74    and return a pointer to data or NULL */
  75 void *trbt_lookuparray32(trbt_tree_t *tree, uint32_t keylen, uint32_t *key);
  76
  77 /* Traverse a tree with a key based on an array of uint32
  78    returns 0 if traverse completed
  79    !0 if the traverse was aborted
  80
  81    If the callback returns !0  the traverse will be aborted
  82 */
  83 int trbt_traversearray32(trbt_tree_t *tree, uint32_t keylen, int (*callback)(void *param, void *data), void *param);
  84
  85 /* Lookup the first node in the tree with a key based on an array of uint32
  86    and return a pointer to data or NULL */
  87 void *trbt_findfirstarray32(trbt_tree_t *tree, uint32_t keylen);