Remove the olsr-specific duplicated types
[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 #include "../defs.h"
47
48 #include <stddef.h>
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   signed char balance;
58   unsigned char leader;
59 };
60
61 typedef int (*avl_tree_comp) (const void *, const void *);
62
63 struct avl_tree {
64   struct avl_node *root;
65   struct avl_node *first;
66   struct avl_node *last;
67   unsigned int count;
68   avl_tree_comp comp;
69 };
70
71 #define AVL_DUP    1
72 #define AVL_DUP_NO 0
73
74 void avl_init(struct avl_tree *, avl_tree_comp);
75 struct avl_node *avl_find(struct avl_tree *, const void *);
76 int avl_insert(struct avl_tree *, struct avl_node *, int);
77 void avl_delete(struct avl_tree *, struct avl_node *);
78
79 static INLINE struct avl_node *
80 avl_walk_first(struct avl_tree *tree)
81 {
82   return tree->first;
83 }
84 static INLINE struct avl_node *
85 avl_walk_last(struct avl_tree *tree)
86 {
87   return tree->last;
88 }
89 static INLINE struct avl_node *
90 avl_walk_next(struct avl_node *node)
91 {
92   return node->next;
93 }
94 static INLINE struct avl_node *
95 avl_walk_prev(struct avl_node *node)
96 {
97   return node->prev;
98 }
99
100 /* and const versions*/
101 static INLINE const struct avl_node *
102 avl_walk_first_c(const struct avl_tree *tree)
103 {
104   return tree->first;
105 }
106 static INLINE const struct avl_node *
107 avl_walk_last_c(const struct avl_tree *tree)
108 {
109   return tree->last;
110 }
111 static INLINE const struct avl_node *
112 avl_walk_next_c(const struct avl_node *node)
113 {
114   return node->next;
115 }
116 static INLINE const struct avl_node *
117 avl_walk_prev_c(const struct avl_node *node)
118 {
119   return node->prev;
120 }
121
122 extern avl_tree_comp avl_comp_default;
123 extern avl_tree_comp avl_comp_prefix_default;
124 extern int avl_comp_ipv4(const void *, const void *);
125 extern int avl_comp_ipv6(const void *, const void *);
126 extern int avl_comp_mac(const void *, const void *);
127
128 /*
129  * Macro to define an inline function to map from a list_node offset back to the
130  * base of the datastructure. That way you save an extra data pointer.
131  */
132 #define AVLNODE2STRUCT(funcname, structname, avlnodename) \
133 static inline structname * funcname (struct avl_node *ptr)\
134 {\
135   return( \
136     ptr ? \
137       (structname *) (((uint8_t *) ptr) - offsetof(structname, avlnodename)) : \
138       NULL); \
139 }
140
141 #endif /* _AVL_H */
142
143 /*
144  * Local Variables:
145  * c-basic-offset: 2
146  * indent-tabs-mode: nil
147  * End:
148  */