df30bff41d9f3751836d0266996efafb855be240
[olsrd.git] / src / neighbor_table.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42
43 #ifndef _OLSR_NEIGH_TBL
44 #define _OLSR_NEIGH_TBL
45
46 #include "defs.h"
47 #include "olsr_time.h"
48 #include "olsr_types.h"
49 #include "common/avl.h"
50
51 #define NB2S_COVERED  0x1     /* node has been covered by a MPR */
52
53 /*
54  * This is a connector between a neighbor and a two-hop neighbor
55  */
56 struct nbr_con {
57   struct avl_node nbr_tree_node;
58   struct avl_node nbr2_tree_node;
59
60   struct nbr_entry *nbr;
61   struct nbr2_entry *nbr2;
62
63   struct timer_entry *nbr2_con_timer;
64
65   olsr_linkcost second_hop_linkcost;
66   olsr_linkcost path_linkcost;
67   olsr_linkcost saved_path_linkcost;
68 };
69
70 AVLNODE2STRUCT(nbr_con_node_to_connector, struct nbr_con, nbr_tree_node);
71 AVLNODE2STRUCT(nbr2_con_node_to_connector, struct nbr_con, nbr2_tree_node);
72
73 #define OLSR_NBR2_LIST_JITTER 5 /* percent */
74
75 struct nbr_entry {
76   struct avl_node nbr_node;            /* nbr keyed by ip address */
77   union olsr_ip_addr nbr_addr;
78   unsigned int willingness:3;
79   unsigned int is_sym:1;
80   unsigned int is_mpr:1;
81   unsigned int was_mpr:1;              /* Used to detect changes in MPR */
82   unsigned int skip:1; 
83   unsigned int mprs_count:16;          /* >0 if we are choosen as an MPR by this neighbor */
84   unsigned int linkcount;
85   struct avl_tree con_tree;            /* subtree for connectors to nbr2 */
86 };
87
88 AVLNODE2STRUCT(nbr_node_to_nbr, struct nbr_entry, nbr_node);
89
90 struct nbr2_entry {
91   struct avl_node nbr2_node;
92   union olsr_ip_addr nbr2_addr;
93   unsigned int mpr_covered_count;      /* Used in mpr calculation */
94   unsigned int processed:1;            /* Used in mpr calculation */
95   struct avl_tree con_tree;            /* subtree for connectors to nbr */
96 };
97
98 AVLNODE2STRUCT(nbr2_node_to_nbr2, struct nbr2_entry, nbr2_node);
99
100 /*
101  * macros for traversing neighbors, neighbor2 and connectors.
102  * it is recommended to use this because it hides all the internal
103  * datastructure from the callers.
104  *
105  * the loop prefetches the next node in order to not loose context if
106  * for example the caller wants to delete the current entry.
107  */
108 #define OLSR_FOR_ALL_NBR_ENTRIES(nbr) \
109 { \
110   struct avl_node *nbr_tree_node, *next_nbr_tree_node; \
111   for (nbr_tree_node = avl_walk_first(&nbr_tree); \
112     nbr_tree_node; nbr_tree_node = next_nbr_tree_node) { \
113     next_nbr_tree_node = avl_walk_next(nbr_tree_node); \
114     nbr = nbr_node_to_nbr(nbr_tree_node);
115 #define OLSR_FOR_ALL_NBR_ENTRIES_END(nbr) }}
116
117 #define OLSR_FOR_ALL_NBR_CON_ENTRIES(nbr, nbr_con) \
118 { \
119   struct avl_node *nbr_con_node, *next_nbr_con_node; \
120   for (nbr_con_node = avl_walk_first(&nbr->con_tree); \
121     nbr_con_node; nbr_con_node = next_nbr_con_node) { \
122     next_nbr_con_node = avl_walk_next(nbr_con_node); \
123     nbr_con = nbr_con_node_to_connector(nbr_con_node);
124 #define OLSR_FOR_ALL_NBR_CON_ENTRIES_END(nbr, nbr_con) }}
125
126 /*
127  * macros for traversing two-hop neighbors and neighbor ref lists.
128  * it is recommended to use this because it hides all the internal
129  * datastructure from the callers.
130  *
131  * the loop prefetches the next node in order to not loose context if
132  * for example the caller wants to delete the current entry.
133  */
134 #define OLSR_FOR_ALL_NBR2_ENTRIES(nbr2) \
135 { \
136   struct avl_node *nbr2_tree_node, *next_nbr2_tree_node; \
137   for (nbr2_tree_node = avl_walk_first(&nbr2_tree); \
138     nbr2_tree_node; nbr2_tree_node = next_nbr2_tree_node) { \
139     next_nbr2_tree_node = avl_walk_next(nbr2_tree_node); \
140     nbr2 = nbr2_node_to_nbr2(nbr2_tree_node);
141 #define OLSR_FOR_ALL_NBR2_ENTRIES_END(nbr2) }}
142
143 #define OLSR_FOR_ALL_NBR2_CON_ENTRIES(nbr2, nbr_con) \
144 { \
145   struct avl_node *nbr_con_node, *next_nbr_con_node; \
146   for (nbr_con_node = avl_walk_first(&nbr2->con_tree); \
147     nbr_con_node; nbr_con_node = next_nbr_con_node) { \
148     next_nbr_con_node = avl_walk_next(nbr_con_node); \
149     nbr_con = nbr2_con_node_to_connector(nbr_con_node);
150 #define OLSR_FOR_ALL_NBR2_CON_ENTRIES_END(nbr2, nbr_con) }}
151
152 /*
153  * The one hop neighbor and two hop neighbor trees.
154  */
155 extern struct avl_tree EXPORT(nbr_tree);
156 extern struct avl_tree EXPORT(nbr2_tree);
157 extern struct olsr_cookie_info *nbr2_list_timer_cookie;
158
159 void olsr_init_neighbor_table(void);
160
161 /* work with 1-hop neighbors */
162 struct nbr_entry *olsr_add_nbr_entry(const union olsr_ip_addr *);
163 void olsr_delete_nbr_entry(struct nbr_entry *);
164 struct nbr_entry *EXPORT(olsr_lookup_nbr_entry) (const union olsr_ip_addr *, bool aliaslookup);
165
166 int olsr_update_nbr_status(struct nbr_entry *, bool);
167
168 /* work with 2-hop neighbors */
169 struct nbr2_entry *olsr_add_nbr2_entry(const union olsr_ip_addr *);
170 void olsr_delete_nbr2_entry(struct nbr2_entry *);
171 struct nbr2_entry *EXPORT(olsr_lookup_nbr2_entry)(const union olsr_ip_addr *, bool aliaslookup);
172
173 /* work with connectors */
174 struct nbr_con *olsr_link_nbr_nbr2(struct nbr_entry *, const union olsr_ip_addr *, olsr_reltime);
175 void olsr_delete_nbr_con(struct nbr_con *);
176 struct nbr_con *EXPORT(olsr_lookup_nbr_con_entry)(struct nbr_entry *, const union olsr_ip_addr *);
177 struct nbr_con *EXPORT(olsr_lookup_nbr2_con_entry)(struct nbr2_entry *, const union olsr_ip_addr *);
178
179 void olsr_print_neighbor_table(void);
180
181 #endif /* OLSR_NEIGH_TBL */
182
183 /*
184  * Local Variables:
185  * c-basic-offset: 2
186  * indent-tabs-mode: nil
187  * End:
188  */