info: java: update workspace
[olsrd.git] / src / tc_set.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #ifndef _OLSR_TOP_SET
47 #define _OLSR_TOP_SET
48
49 #include "defs.h"
50 #include "packet.h"
51 #include "common/avl.h"
52 #include "common/list.h"
53 #include "scheduler.h"
54
55 /*
56  * This file holds the definitions for the link state database.
57  * The lsdb consists of nodes and edges.
58  * During input parsing all nodes and edges are extracted and synthesized.
59  * The SPF calculation operates on these datasets.
60  */
61
62 struct tc_edge_entry {
63   struct avl_node edge_node;           /* edge_tree node in tc_entry */
64   union olsr_ip_addr T_dest_addr;      /* edge_node key */
65   struct tc_edge_entry *edge_inv;      /* shortcut, used during SPF calculation */
66   struct tc_entry *tc;                 /* backpointer to owning tc entry */
67   olsr_linkcost cost;                  /* metric used for SPF calculation */
68   uint16_t ansn;                       /* ansn of this edge, used for multipart msgs */
69   uint32_t linkquality[0];
70 };
71
72 AVLNODE2STRUCT(edge_tree2tc_edge, struct tc_edge_entry, edge_node);
73
74 struct tc_entry {
75   struct avl_node vertex_node;         /* node keyed by ip address */
76   union olsr_ip_addr addr;             /* vertex_node key */
77   struct avl_node cand_tree_node;      /* SPF candidate heap, node keyed by path_etx */
78   olsr_linkcost path_cost;             /* SPF calculated distance, cand_tree_node key */
79   struct list_node path_list_node;     /* SPF result list */
80   struct avl_tree edge_tree;           /* subtree for edges */
81   struct avl_tree prefix_tree;         /* subtree for prefixes */
82   struct link_entry *next_hop;         /* SPF calculated link to the 1st hop neighbor */
83   struct timer_entry *edge_gc_timer;   /* used for edge garbage collection */
84   struct timer_entry *validity_timer;  /* tc validity time */
85   uint32_t refcount;                   /* reference counter */
86   uint16_t msg_seq;                    /* sequence number of the tc message */
87   uint8_t msg_hops;                    /* hopcount as per the tc message */
88   uint8_t hops;                        /* SPF calculated hopcount */
89   uint16_t ansn;                       /* ANSN number of the tc message */
90   uint16_t ignored;                    /* how many TC messages ignored in a sequence
91                                           (kindof emergency brake) */
92   uint16_t err_seq;                    /* sequence number of an unplausible TC */
93   bool err_seq_valid;                  /* do we have an error (unplauible seq/ansn) */
94 };
95
96 /*
97  * Garbage collection time for edges.
98  * This is used for multipart messages.
99  */
100 #define OLSR_TC_EDGE_GC_TIME (2*1000)   /* milliseconds */
101 #define OLSR_TC_EDGE_GC_JITTER 5        /* percent */
102
103 #define OLSR_TC_VTIME_JITTER 5          /* percent */
104
105 AVLNODE2STRUCT(vertex_tree2tc, struct tc_entry, vertex_node);
106 AVLNODE2STRUCT(cand_tree2tc, struct tc_entry, cand_tree_node);
107 LISTNODE2STRUCT(pathlist2tc, struct tc_entry, path_list_node);
108
109 /*
110  * macros for traversing vertices, edges and prefixes in the link state database.
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_TC_ENTRIES(tc) \
118 { \
119   struct avl_node *tc_tree_node, *next_tc_tree_node; \
120   for (tc_tree_node = avl_walk_first(&tc_tree); \
121     tc_tree_node; tc_tree_node = next_tc_tree_node) { \
122     next_tc_tree_node = avl_walk_next(tc_tree_node); \
123     tc = vertex_tree2tc(tc_tree_node);
124 #define OLSR_FOR_ALL_TC_ENTRIES_END(tc) }}
125
126 #define OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) \
127 { \
128   struct avl_node *tc_edge_node, *next_tc_edge_node; \
129   for (tc_edge_node = avl_walk_first(&tc->edge_tree); \
130     tc_edge_node; tc_edge_node = next_tc_edge_node) { \
131     next_tc_edge_node = avl_walk_next(tc_edge_node); \
132     tc_edge = edge_tree2tc_edge(tc_edge_node);
133 #define OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge) }}
134
135 #define OLSR_FOR_ALL_PREFIX_ENTRIES(tc, rtp) \
136 { \
137   struct avl_node *rtp_node, *next_rtp_node; \
138   for (rtp_node = avl_walk_first(&tc->prefix_tree); \
139     rtp_node; rtp_node = next_rtp_node) { \
140     next_rtp_node = avl_walk_next(rtp_node); \
141     rtp = rtp_prefix_tree2rtp(rtp_node);
142 #define OLSR_FOR_ALL_PREFIX_ENTRIES_END(tc, rtp) }}
143
144 extern struct avl_tree tc_tree;
145 extern struct tc_entry *tc_myself;
146
147 void olsr_init_tc(void);
148 void olsr_delete_all_tc_entries(void);
149 void olsr_change_myself_tc(void);
150 #ifndef NODEBUG
151 void olsr_print_tc_table(void);
152 #else
153 #define olsr_print_tc_table() do { } while(0)
154 #endif
155 void olsr_time_out_tc_set(void);
156
157 /* tc msg input parser */
158 bool olsr_input_tc(union olsr_message *, struct interface_olsr *, union olsr_ip_addr *from);
159
160 /* tc_entry manipulation */
161 struct tc_entry *olsr_lookup_tc_entry(union olsr_ip_addr *);
162 struct tc_entry *olsr_locate_tc_entry(union olsr_ip_addr *);
163 void olsr_lock_tc_entry(struct tc_entry *);
164 void olsr_unlock_tc_entry(struct tc_entry *);
165
166 /* tc_edge_entry manipulation */
167 bool olsr_delete_outdated_tc_edges(struct tc_entry *);
168 char *olsr_tc_edge_to_string(struct tc_edge_entry *);
169 struct tc_edge_entry *olsr_lookup_tc_edge(struct tc_entry *, union olsr_ip_addr *);
170 struct tc_edge_entry *olsr_add_tc_edge_entry(struct tc_entry *, union olsr_ip_addr *, uint16_t);
171 void olsr_delete_tc_entry(struct tc_entry *);
172 void olsr_delete_tc_edge_entry(struct tc_edge_entry *);
173 bool olsr_calc_tc_edge_entry_etx(struct tc_edge_entry *);
174 void olsr_set_tc_edge_timer(struct tc_edge_entry *, unsigned int);
175 // static bool olsr_etx_significant_change(float, float);
176
177 #endif /* _OLSR_TOP_SET */
178
179 /*
180  * Local Variables:
181  * c-basic-offset: 2
182  * indent-tabs-mode: nil
183  * End:
184  */