ldns documentation

- Main Page
- Related Pages
- Data Structures
- Files

- File List
- Globals

rbtree.h
Go to the documentation of this file.
1 /*
2 * rbtree.h -- generic red-black tree
3 *
4 * Copyright (c) 2001-2008, NLnet Labs. All rights reserved.
5 *
6 * This software is open source.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 *
35 */
36
43 #ifndef LDNS_RBTREE_H_
44 #define LDNS_RBTREE_H_
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
56 typedef struct ldns_rbnode_t ldns_rbnode_t;
60 struct ldns_rbnode_t {
62 ldns_rbnode_t *parent;
64 ldns_rbnode_t *left;
66 ldns_rbnode_t *right;
68 const void *key;
70 const void *data;
72 uint8_t color;
73 };
74
76 #define LDNS_RBTREE_NULL &ldns_rbtree_null_node
77
78 extern ldns_rbnode_t ldns_rbtree_null_node;
79
81 typedef struct ldns_rbtree_t ldns_rbtree_t;
83 struct ldns_rbtree_t {
85 ldns_rbnode_t *root;
86
88 size_t count;
89
94 int (*cmp) (const void *, const void *);
95 };
96
102 ldns_rbtree_t *ldns_rbtree_create(int (*cmpf)(const void *, const void *));
103
108 void ldns_rbtree_free(ldns_rbtree_t *rbtree);
109
115 void ldns_rbtree_init(ldns_rbtree_t *rbtree, int (*cmpf)(const void *, const void *));
116
123 ldns_rbnode_t *ldns_rbtree_insert(ldns_rbtree_t *rbtree, ldns_rbnode_t *data);
124
131 void ldns_rbtree_insert_vref(ldns_rbnode_t *data, void *rbtree);
132
140 ldns_rbnode_t *ldns_rbtree_delete(ldns_rbtree_t *rbtree, const void *key);
141
148 ldns_rbnode_t *ldns_rbtree_search(ldns_rbtree_t *rbtree, const void *key);
149
159 int ldns_rbtree_find_less_equal(ldns_rbtree_t *rbtree, const void *key,
160 ldns_rbnode_t **result);
161
167 ldns_rbnode_t *ldns_rbtree_first(ldns_rbtree_t *rbtree);
168
174 ldns_rbnode_t *ldns_rbtree_last(ldns_rbtree_t *rbtree);
175
181 ldns_rbnode_t *ldns_rbtree_next(ldns_rbnode_t *rbtree);
182
188 ldns_rbnode_t *ldns_rbtree_previous(ldns_rbnode_t *rbtree);
189
195 ldns_rbtree_t *ldns_rbtree_split(ldns_rbtree_t *tree, size_t elements);
196
201 void ldns_rbtree_join(ldns_rbtree_t *tree1, ldns_rbtree_t *tree2);
202
207 #define LDNS_RBTREE_FOR(node, type, rbtree) \
208 for(node=(type)ldns_rbtree_first(rbtree); \
209 (ldns_rbnode_t*)node != LDNS_RBTREE_NULL; \
210 node = (type)ldns_rbtree_next((ldns_rbnode_t*)node))
211
223 void ldns_traverse_postorder(ldns_rbtree_t* tree,
224 void (*func)(ldns_rbnode_t*, void*), void* arg);
225
226 #ifdef __cplusplus
227 }
228 #endif
229
230 #endif /* UTIL_RBTREE_H_ */
ldns_rbtree_search
ldns_rbnode_t * ldns_rbtree_search(ldns_rbtree_t *rbtree, const void *key)
Find key in tree.
Definition: rbtree.c:294
ldns_rbtree_find_less_equal
int ldns_rbtree_find_less_equal(ldns_rbtree_t *rbtree, const void *key, ldns_rbnode_t **result)
Find, but match does not have to be exact.
Definition: rbtree.c:514
ldns_rbnode_t::right
ldns_rbnode_t * right
right node (larger items)
Definition: rbtree.h:66
ldns_rbtree_t::count
size_t count
The number of the nodes in the tree.
Definition: rbtree.h:88
ldns_rbtree_last
ldns_rbnode_t * ldns_rbtree_last(ldns_rbtree_t *rbtree)
Returns last (largest) node in the tree.
Definition: rbtree.c:559
ldns_traverse_postorder
void ldns_traverse_postorder(ldns_rbtree_t *tree, void(*func)(ldns_rbnode_t *, void *), void *arg)
Call function for all elements in the redblack tree, such that leaf elements are called before parent...
Definition: rbtree.c:666
ldns_rbtree_previous
ldns_rbnode_t * ldns_rbtree_previous(ldns_rbnode_t *rbtree)
Returns previous smaller node in the tree.
Definition: rbtree.c:595
ldns_rbtree_t::root
ldns_rbnode_t * root
The root of the red-black tree.
Definition: rbtree.h:85
ldns_rbnode_t::data
const void * data
pointer to data
Definition: rbtree.h:70
ldns_rbnode_t::left
ldns_rbnode_t * left
left node (smaller items)
Definition: rbtree.h:64
ldns_rbtree_init
void ldns_rbtree_init(ldns_rbtree_t *rbtree, int(*cmpf)(const void *, const void *))
Init a new tree (malloced by caller) with given key compare function.
Definition: rbtree.c:97
ldns_rbnode_t
The rbnode_t struct definition.
Definition: rbtree.h:60
ldns_rbtree_first
ldns_rbnode_t * ldns_rbtree_first(ldns_rbtree_t *rbtree)
Returns first (smallest) node in the tree.
Definition: rbtree.c:548
ldns_rbnode_t::parent
ldns_rbnode_t * parent
parent in rbtree, RBTREE_NULL for root
Definition: rbtree.h:62
ldns_rbtree_next
ldns_rbnode_t * ldns_rbtree_next(ldns_rbnode_t *rbtree)
Returns next larger node in the tree.
Definition: rbtree.c:574
ldns_rbtree_t
definition for tree struct
Definition: rbtree.h:83
ldns_rbtree_free
void ldns_rbtree_free(ldns_rbtree_t *rbtree)
Free the complete tree (but not its keys)
Definition: rbtree.c:106
ldns_rbtree_null_node
ldns_rbnode_t ldns_rbtree_null_node
the global empty node
Definition: rbtree.c:55
ldns_rbtree_split
ldns_rbtree_t * ldns_rbtree_split(ldns_rbtree_t *tree, size_t elements)
split off &#39;elements&#39; number of elements from the start of the name tree and return a new tree contain...
Definition: rbtree.c:620
ldns_rbnode_t::key
const void * key
pointer to sorting key
Definition: rbtree.h:68
ldns_rbtree_insert_vref
void ldns_rbtree_insert_vref(ldns_rbnode_t *data, void *rbtree)
Insert data into the tree (reversed arguments, for use as callback)
Definition: rbtree.c:229
ldns_rbnode_t::color
uint8_t color
colour of this node
Definition: rbtree.h:72
ldns_rbtree_delete
ldns_rbnode_t * ldns_rbtree_delete(ldns_rbtree_t *rbtree, const void *key)
Delete element from tree.
Definition: rbtree.c:336
ldns_rbtree_create
ldns_rbtree_t * ldns_rbtree_create(int(*cmpf)(const void *, const void *))
Create new tree (malloced) with given key compare function.
Definition: rbtree.c:80
ldns_rbtree_insert
ldns_rbnode_t * ldns_rbtree_insert(ldns_rbtree_t *rbtree, ldns_rbnode_t *data)
Insert data into the tree.
Definition: rbtree.c:242
ldns_rbtree_join
void ldns_rbtree_join(ldns_rbtree_t *tree1, ldns_rbtree_t *tree2)
add all node from the second tree to the first (removing them from the second), and fix up nsec(3)s i...
Definition: rbtree.c:646