ctdb/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 #ifndef _RB_TREE_H
  21 #define _RB_TREE_H
  22
  23 #define TRBT_RED                0x00
  24 #define TRBT_BLACK              0x01
  25 typedef struct trbt_node {
  26         struct trbt_tree *tree;
  27         struct trbt_node *parent;
  28         struct trbt_node *left;
  29         struct trbt_node *right;
  30         uint32_t rb_color;
  31         uint32_t key32;
  32         void *data;
  33 } trbt_node_t;
  34
  35 typedef struct trbt_tree {
  36         trbt_node_t *root;
  37 /* automatically free the tree when the last node has been deleted */
  38 #define TRBT_AUTOFREE           0x00000001
  39         uint32_t flags;
  40 } trbt_tree_t;
  41
  42
  43
  44 /* Create a RB tree */
  45 trbt_tree_t *trbt_create(TALLOC_CTX *memctx, uint32_t flags);
  46
  47 /* Lookup a node in the tree and return a pointer to data or NULL */
  48 void *trbt_lookup32(trbt_tree_t *tree, uint32_t key);
  49
  50 /* Insert a new node into the tree. If there was already a node with this
  51    key the pointer to the previous data is returned.
  52    The tree will talloc_steal() the data inserted into the tree .
  53 */
  54 void *trbt_insert32(trbt_tree_t *tree, uint32_t key, void *data);
  55
  56 /* Insert a new node into the tree.
  57    If this is a new node:
  58      callback is called with data==NULL and param=param
  59      the returned value from the callback is talloc_stolen and inserted in the
  60      tree.
  61    If a node already exists for this key then:
  62      callback is called with data==existing data and param=param
  63      the returned calue is talloc_stolen and inserted in the tree
  64 */
  65 void trbt_insert32_callback(trbt_tree_t *tree, uint32_t key, void *(*callback)(void *param, void *data), void *param);
  66
  67 /* Delete a node from the tree and free all data associated with it */
  68 void trbt_delete32(trbt_tree_t *tree, uint32_t key);
  69
  70
  71 /* insert into the tree with a key based on an array of uint32 */
  72 void trbt_insertarray32_callback(trbt_tree_t *tree, uint32_t keylen, uint32_t *key, void *(*callback)(void *param, void *data), void *param);
  73
  74 /* Lookup a node in the tree with a key based on an array of uint32
  75    and return a pointer to data or NULL */
  76 void *trbt_lookuparray32(trbt_tree_t *tree, uint32_t keylen, uint32_t *key);
  77
  78 /* Traverse a tree with a key based on an array of uint32
  79    returns 0 if traverse completed
  80    !0 if the traverse was aborted
  81
  82    If the callback returns !0  the traverse will be aborted
  83 */
  84 int trbt_traversearray32(trbt_tree_t *tree, uint32_t keylen, int (*callback)(void *param, void *data), void *param);
  85
  86 /* Lookup the first node in the tree with a key based on an array of uint32
  87    and return a pointer to data or NULL */
  88 void *trbt_findfirstarray32(trbt_tree_t *tree, uint32_t keylen);
  89
  90 #endif /* _RB_TREE_H */