5759b51f0af6c2f71a5646f1559e9562359ee19c
[olsrd.git] / src / common / avl.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.de)
5  * IPv4 performance optimization (c) 2006, sven-ola(gmx.de)
6  * All rights reserved.
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 
13  *   notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright 
15  *   notice, this list of conditions and the following disclaimer in 
16  *   the documentation and/or other materials provided with the 
17  *   distribution.
18  * * Neither the name of olsr.org, olsrd nor the names of its 
19  *   contributors may be used to endorse or promote products derived 
20  *   from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  * Visit http://www.olsr.org for more information.
36  *
37  * If you find this software useful feel free to make a donation
38  * to the project. For more information see the website or contact
39  * the copyright holders.
40  *
41  */
42
43 #ifndef _AVL_H
44 #define _AVL_H
45
46 /* must be declared here because of circular dependency through "defs.h" */
47
48 #define INLINE inline __attribute__((always_inline))
49
50 struct avl_node {
51   struct avl_node *parent;
52   struct avl_node *left;
53   struct avl_node *right;
54   struct avl_node *next;
55   struct avl_node *prev;
56   void *key;
57   void *data;
58   signed char balance;
59   unsigned char leader;
60 };
61
62 typedef int (*avl_tree_comp) (const void *, const void *);
63
64 struct avl_tree {
65   struct avl_node *root;
66   struct avl_node *first;
67   struct avl_node *last;
68   unsigned int count;
69   avl_tree_comp comp;
70 };
71
72 #define AVL_DUP    1
73 #define AVL_DUP_NO 0
74
75 void avl_init(struct avl_tree *, avl_tree_comp);
76 struct avl_node *avl_find(struct avl_tree *, const void *);
77 int avl_insert(struct avl_tree *, struct avl_node *, int);
78 void avl_delete(struct avl_tree *, struct avl_node *);
79
80 static INLINE struct avl_node *
81 avl_walk_first(struct avl_tree *tree)
82 {
83   return tree->first;
84 }
85 static INLINE struct avl_node *
86 avl_walk_last(struct avl_tree *tree)
87 {
88   return tree->last;
89 }
90 static INLINE struct avl_node *
91 avl_walk_next(struct avl_node *node)
92 {
93   return node->next;
94 }
95 static INLINE struct avl_node *
96 avl_walk_prev(struct avl_node *node)
97 {
98   return node->prev;
99 }
100
101 /* and const versions*/
102 static INLINE const struct avl_node *
103 avl_walk_first_c(const struct avl_tree *tree)
104 {
105   return tree->first;
106 }
107 static INLINE const struct avl_node *
108 avl_walk_last_c(const struct avl_tree *tree)
109 {
110   return tree->last;
111 }
112 static INLINE const struct avl_node *
113 avl_walk_next_c(const struct avl_node *node)
114 {
115   return node->next;
116 }
117 static INLINE const struct avl_node *
118 avl_walk_prev_c(const struct avl_node *node)
119 {
120   return node->prev;
121 }
122
123 extern avl_tree_comp avl_comp_default;
124 extern avl_tree_comp avl_comp_prefix_default;
125 extern int avl_comp_ipv4(const void *, const void *);
126 extern int avl_comp_ipv6(const void *, const void *);
127 extern int avl_comp_mac(const void *, const void *);
128
129 #endif /* _AVL_H */
130
131 /*
132  * Local Variables:
133  * c-basic-offset: 2
134  * End:
135  */