move avl and list library into src/common
[olsrd.git] / src / tc_set.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * LSDB rewrite (c) 2007, Hannes Gredler (hannes@gredler.at)
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 #ifndef _OLSR_TOP_SET
43 #define _OLSR_TOP_SET
44
45 #include "defs.h"
46 #include "packet.h"
47 #include "common/avl.h"
48 #include "common/list.h"
49 #include "scheduler.h"
50
51 /*
52  * This file holds the definitions for the link state database.
53  * The lsdb consists of nodes and edges.
54  * During input parsing all nodes and edges are extracted and syntesized.
55  * The SPF calculation operates on these datasets.
56  */
57
58 struct tc_edge_entry
59 {
60   struct avl_node    edge_node; /* edge_tree node in tc_entry */
61   union olsr_ip_addr T_dest_addr; /* edge_node key */
62   struct tc_edge_entry *edge_inv; /* shortcut, used during SPF calculation */
63   struct tc_entry    *tc; /* backpointer to owning tc entry */
64   struct timer_entry *edge_timer; /* expiration timer */
65   olsr_u16_t         T_seq; /* sequence number of the advertised neighbor set */
66   olsr_u16_t         flags; /* misc flags */
67   olsr_linkcost      cost; /* metric used for SPF calculation */
68   char               linkquality[0];
69 };
70
71 #define OLSR_TC_EDGE_DOWN (1 << 0) /* this edge is down */
72 #define OLSR_TC_EDGE_JITTER 5 /* percent */
73
74 /*
75  * Garbage collection time for downed edges
76  */
77 #define OLSR_TC_EDGE_GC_TIME (15*1000) /* milliseconds */
78
79 struct tc_entry
80 {
81   struct avl_node    vertex_node; /* node keyed by ip address */
82   struct avl_node    cand_tree_node; /* SPF candidate heap, node keyed by path_etx */
83   struct list_node   path_list_node; /* SPF result list */
84   union olsr_ip_addr addr; /* vertex_node key */
85   struct avl_tree    edge_tree; /* subtree for edges */
86   struct avl_tree    prefix_tree; /* subtree for prefixes */
87   struct link_entry  *next_hop; /* SPF calculated link to the 1st hop neighbor */
88   olsr_linkcost      path_cost; /* SPF calculated distance, cand_tree_node key */
89   olsr_u16_t         msg_seq; /* sequence number of the tc message */
90   olsr_u8_t          msg_hops; /* hopcount as per the tc message */
91   olsr_u8_t          hops; /* SPF calculated hopcount */
92   olsr_u16_t         ansn; /* ANSN number of the tc message */
93   olsr_u16_t         ignored; /* how many TC messages ignored in a sequence (kindof emergency brake) */
94   olsr_u16_t         err_seq; /* sequence number of an unplausible TC */
95   olsr_bool          err_seq_valid; /* do we have an error (unplauible seq/ansn) */
96 };
97
98 /*
99  * macros for traversing vertices, edges and prefixes in the link state database.
100  * it is recommended to use this because it hides all the internal
101  * datastructure from the callers.
102  *
103  * the loop prefetches the next node in order to not loose context if
104  * for example the caller wants to delete the current entry.
105  */
106 #define OLSR_FOR_ALL_TC_ENTRIES(tc) \
107 { \
108   struct avl_node *tc_tree_node, *next_tc_tree_node; \
109   for (tc_tree_node = avl_walk_first(&tc_tree); \
110     tc_tree_node; tc_tree_node = next_tc_tree_node) { \
111     next_tc_tree_node = avl_walk_next(tc_tree_node); \
112     tc = tc_tree_node->data;
113 #define OLSR_FOR_ALL_TC_ENTRIES_END(tc) }}
114
115 #define OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) \
116 { \
117   struct avl_node *tc_edge_node, *next_tc_edge_node; \
118   for (tc_edge_node = avl_walk_first(&tc->edge_tree); \
119     tc_edge_node; tc_edge_node = next_tc_edge_node) { \
120     next_tc_edge_node = avl_walk_next(tc_edge_node); \
121     tc_edge = tc_edge_node->data;
122 #define OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge) }}
123
124 extern struct avl_tree tc_tree;
125 extern struct tc_entry *tc_myself;
126
127 void olsr_init_tc(void);
128 void olsr_change_myself_tc(void);
129 void olsr_print_tc_table(void);
130 void olsr_time_out_tc_set(void);
131
132 /* tc msg input parser */
133 void olsr_input_tc(union olsr_message *, struct interface *,
134                    union olsr_ip_addr *from);
135
136 /* tc_entry manipulation */
137 struct tc_entry *olsr_lookup_tc_entry(union olsr_ip_addr *);
138 struct tc_entry *olsr_locate_tc_entry(union olsr_ip_addr *);
139
140 /* tc_edge_entry manipulation */
141 char *olsr_tc_edge_to_string(struct tc_edge_entry *);
142 struct tc_edge_entry *olsr_lookup_tc_edge(struct tc_entry *,
143                                           union olsr_ip_addr *);
144 struct tc_edge_entry *olsr_add_tc_edge_entry(struct tc_entry *,
145                                              union olsr_ip_addr *, olsr_u16_t,
146                                              unsigned int);
147 void olsr_delete_tc_entry(struct tc_entry *);
148 void olsr_delete_tc_edge_entry(struct tc_edge_entry *);
149 olsr_bool olsr_calc_tc_edge_entry_etx(struct tc_edge_entry *);
150 void olsr_set_tc_edge_timer(struct tc_edge_entry *, unsigned int);
151
152 #endif
153
154 /*
155  * Local Variables:
156  * c-basic-offset: 2
157  * End:
158  */