Rename olsr_time.[ch] to olsr_clock.[ch]
[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_clock.h"
48 #include "olsr_types.h"
49 #include "common/avl.h"
50 #include "tc_set.h"
51
52 #define NB2S_COVERED  0x1     /* node has been covered by a MPR */
53
54 /*
55  * This is a connector between a neighbor and a two-hop neighbor
56  */
57 struct nbr_con {
58   struct avl_node nbr_tree_node;
59   struct avl_node nbr2_tree_node;
60
61   struct nbr_entry *nbr;
62   struct nbr2_entry *nbr2;
63
64   struct olsr_timer_entry *nbr2_con_timer;
65
66   olsr_linkcost second_hop_linkcost;
67   olsr_linkcost path_linkcost;
68 };
69
70
71 #define OLSR_NBR2_LIST_JITTER 5 /* percent */
72
73 struct nbr_entry {
74   struct avl_node nbr_node;            /* nbr keyed by ip address */
75   union olsr_ip_addr nbr_addr;
76   struct tc_edge_entry *tc_edge;
77   unsigned int willingness:3;
78   unsigned int is_sym:1;
79   unsigned int is_mpr:1;
80   unsigned int was_mpr:1;              /* Used to detect changes in MPR */
81   unsigned int skip:1; 
82   unsigned int mprs_count:16;          /* >0 if we are choosen as an MPR by this neighbor */
83   unsigned int linkcount;
84   struct avl_tree con_tree;            /* subtree for connectors to nbr2 */
85 };
86
87
88 struct nbr2_entry {
89   struct avl_node nbr2_node;
90   union olsr_ip_addr nbr2_addr;
91   unsigned int mpr_covered_count;      /* Used in mpr calculation */
92   unsigned int processed:1;            /* Used in mpr calculation */
93   struct avl_tree con_tree;            /* subtree for connectors to nbr */
94 };
95
96
97 /*
98  * macros for traversing neighbors, neighbor2 and connectors.
99  * it is recommended to use this because it hides all the internal
100  * datastructure from the callers.
101  *
102  * the loop prefetches the next node in order to not loose context if
103  * for example the caller wants to delete the current entry.
104  */
105 #define OLSR_FOR_ALL_NBR_ENTRIES(nbr, iterator) avl_for_each_element_safe(&nbr_tree, nbr, nbr_node, iterator)
106
107 #define OLSR_FOR_ALL_NBR_CON_ENTRIES(nbr, con, iterator) avl_for_each_element_safe(&nbr->con_tree, con, nbr_tree_node, iterator)
108
109 /*
110  * macros for traversing two-hop neighbors and neighbor ref lists.
111  * it is recommended to use this because it hides all the internal
112  * datastructure from the callers.
113  *
114  * the loop prefetches the next node in order to not loose context if
115  * for example the caller wants to delete the current entry.
116  */
117 #define OLSR_FOR_ALL_NBR2_ENTRIES(nbr2, iterator) avl_for_each_element_safe(&nbr2_tree, nbr2, nbr2_node, iterator)
118
119 #define OLSR_FOR_ALL_NBR2_CON_ENTRIES(nbr2, con, iterator) avl_for_each_element_safe(&nbr2->con_tree, con, nbr2_tree_node, iterator)
120
121 /*
122  * The one hop neighbor and two hop neighbor trees.
123  */
124 extern struct avl_tree EXPORT(nbr_tree);
125 extern struct avl_tree EXPORT(nbr2_tree);
126
127 void olsr_init_neighbor_table(void);
128
129 /* work with 1-hop neighbors */
130 struct nbr_entry *olsr_add_nbr_entry(const union olsr_ip_addr *);
131 void olsr_delete_nbr_entry(struct nbr_entry *);
132 struct nbr_entry *EXPORT(olsr_lookup_nbr_entry) (const union olsr_ip_addr *, bool aliaslookup);
133
134 void olsr_update_nbr_status(struct nbr_entry *);
135
136 /* work with 2-hop neighbors */
137 struct nbr2_entry *olsr_add_nbr2_entry(const union olsr_ip_addr *);
138 void olsr_delete_nbr2_entry(struct nbr2_entry *);
139 struct nbr2_entry *EXPORT(olsr_lookup_nbr2_entry)(const union olsr_ip_addr *, bool aliaslookup);
140
141 /* work with connectors */
142 struct nbr_con *olsr_link_nbr_nbr2(struct nbr_entry *, const union olsr_ip_addr *, uint32_t);
143 void olsr_delete_nbr_con(struct nbr_con *);
144 struct nbr_con *EXPORT(olsr_lookup_nbr_con_entry)(struct nbr_entry *, const union olsr_ip_addr *);
145 struct nbr_con *EXPORT(olsr_lookup_nbr2_con_entry)(struct nbr2_entry *, const union olsr_ip_addr *);
146
147 void olsr_print_neighbor_table(void);
148
149 #endif /* OLSR_NEIGH_TBL */
150
151 /*
152  * Local Variables:
153  * c-basic-offset: 2
154  * indent-tabs-mode: nil
155  * End:
156  */