From Sven-Ola Tuecke <sven-ola@gmx.de>: add support for fixedpoint math
[olsrd.git] / src / routing_table.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * RIB implementation (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_ROUTING_TABLE
43 #define _OLSR_ROUTING_TABLE
44
45 #include <sys/types.h>
46 #include <sys/time.h>
47 #include <sys/socket.h>
48 #include <net/if.h>
49 #include <net/route.h>
50 #include "hna_set.h"
51 #include "link_set.h"
52 #include "lq_avl.h"
53 #include "lq_list.h"
54
55 #define NETMASK_HOST 0xffffffff
56 #define NETMASK_DEFAULT 0x0
57
58 /*
59  * the kernel FIB does not need to know the metric of a route.
60  * this saves us from enqueuing/dequeueing hopcount only changes.
61  */
62 #define RT_METRIC_DEFAULT 2
63
64 /* a composite metric is used for path selection */
65 struct rt_metric
66 {
67 #ifdef USE_FPM
68   fpm                   etx;
69 #else
70   float                 etx;
71 #endif
72   olsr_u32_t            hops;
73 };
74
75 /* a nexthop is a pointer to a gateway router plus an interface */
76 struct rt_nexthop
77 {
78   union olsr_ip_addr    gateway; /* gateway router */
79   int                   iif_index; /* outgoing interface index */
80 };
81
82 /*
83  * Every prefix in our RIB needs a route entry that contains
84  * the nexthop of the best path as installed in the kernel FIB.
85  * The route entry is the root of a rt_path tree of equal prefixes
86  * originated by different routers. It also contains a shortcut
87  * for accessing the best route among all contributing routes.
88  */
89 struct rt_entry
90 {
91   struct olsr_ip_prefix rt_dst;
92   struct avl_node       rt_tree_node; 
93   struct rt_path        *rt_best; /* shortcut to the best path */
94   struct rt_nexthop     rt_nexthop; /* nexthop of FIB route */
95   struct rt_metric      rt_metric; /* metric of FIB route */
96   struct avl_tree       rt_path_tree;
97   struct list_node      rt_change_node; /* queue for kernel FIB add/chg/del */
98 };
99
100 /*
101  * For every received route a rt_path is added to the RIB.
102  * Depending on the results of the SPF calculation we perform a
103  * best_path calculation and pick the one with the lowest etx/metric.
104  * The rt_path gets first inserted into the per tc_entry prefix tree.
105  * If during the SPF calculation the tc_entry becomes reachable via
106  * a local nexthop it is inserted into the global RIB tree.
107  */
108 struct rt_path
109 {
110   struct rt_entry       *rtp_rt; /* backpointer to owning route head */
111   struct tc_entry       *rtp_tc; /* backpointer to owning tc entry */
112   struct rt_nexthop     rtp_nexthop;
113   struct rt_metric      rtp_metric;
114   struct avl_node       rtp_tree_node; /* global rtp node */
115   union olsr_ip_addr    rtp_originator; /* originator of the route */
116   struct avl_node       rtp_prefix_tree_node; /* tc entry rtp node */
117   struct olsr_ip_prefix rtp_dst; /* the prefix */
118   olsr_u32_t            rtp_version; /* for detection of outdated rt_paths */
119   olsr_u8_t             rtp_origin; /* internal, MID or HNA */
120 };
121
122 /*
123  * In olsrd we have three different route types.
124  * Internal routes are generated by simple reachability
125  * of a node (by means of a tc message reception).
126  * MID routes result from MID messages and HNA routes
127  * from a gw routers HNA anncouncements.
128  */
129 enum olsr_rt_origin {
130   OLSR_RT_ORIGIN_MIN,
131   OLSR_RT_ORIGIN_INT,
132   OLSR_RT_ORIGIN_MID,
133   OLSR_RT_ORIGIN_HNA,
134   OLSR_RT_ORIGIN_MAX
135 };
136
137 /*
138  * OLSR_FOR_ALL_RT_ENTRIES
139  *
140  * macro for traversing the entire routing table.
141  * it is recommended to use this because it hides all the internal
142  * datastructure from the callers.
143  *
144  * the loop prefetches the next node in order to not loose context if
145  * for example the caller wants to delete the current rt_entry.
146  */
147 #define OLSR_FOR_ALL_RT_ENTRIES(rt) \
148 { \
149   struct avl_node *rt_tree_node, *next_rt_tree_node; \
150   for (rt_tree_node = avl_walk_first(&routingtree); \
151     rt_tree_node; rt_tree_node = next_rt_tree_node) { \
152     next_rt_tree_node = avl_walk_next(rt_tree_node); \
153     rt = rt_tree_node->data;
154 #define OLSR_FOR_ALL_RT_ENTRIES_END(rt) }}
155
156 /*
157  * OLSR_FOR_ALL_HNA_RT_ENTRIES
158  *
159  * macro for traversing the entire routing table and pick only
160  * HNA routes. This is not optimal - however, If the RIBs become
161  * too big one day then we keep an additional per origin tree
162  * in order to speed up traversal.
163  * In the meantime it is recommended to use this macro because
164  * it hides all the internal datastructure from the callers
165  * and the core maintainers do not have to update all the plugins
166  * once we decide to change the datastructures.
167  */
168 #define OLSR_FOR_ALL_HNA_RT_ENTRIES(rt) \
169 { \
170   struct avl_node *rt_tree_node, *next_rt_tree_node; \
171   for (rt_tree_node = avl_walk_first(&routingtree); \
172     rt_tree_node; rt_tree_node = next_rt_tree_node) { \
173     next_rt_tree_node = avl_walk_next(rt_tree_node); \
174     rt = rt_tree_node->data; \
175     if (rt->rt_best->rtp_origin != OLSR_RT_ORIGIN_HNA) \
176       continue; 
177 #define OLSR_FOR_ALL_HNA_RT_ENTRIES_END(rt) }}
178
179
180 /**
181  * IPv4 <-> IPv6 wrapper
182  */
183 union olsr_kernel_route
184 {
185   struct
186   {
187     struct sockaddr rt_dst;
188     struct sockaddr rt_gateway;
189     olsr_u32_t metric;
190   } v4;
191
192   struct
193   {
194     struct in6_addr rtmsg_dst;
195     struct in6_addr rtmsg_gateway;
196     olsr_u32_t rtmsg_metric;
197   } v6;
198 };
199
200
201 extern struct avl_tree routingtree;
202 extern unsigned int routingtree_version;
203
204 void
205 olsr_init_routing_table(void);
206
207 unsigned int olsr_bump_routingtree_version(void);
208
209 int avl_comp_ipv4_prefix (const void *, const void *);
210 int avl_comp_ipv6_prefix (const void *, const void *);
211
212 void olsr_rt_best(struct rt_entry *);
213 olsr_bool olsr_nh_change(const struct rt_nexthop *, const struct rt_nexthop *);
214 olsr_bool olsr_hopcount_change(const struct rt_metric *, const struct rt_metric *);
215 olsr_bool olsr_cmp_rt(const struct rt_entry *, const struct rt_entry *);
216 olsr_u8_t olsr_fib_metric(const struct rt_metric *);
217
218 char *olsr_rt_to_string(const struct rt_entry *);
219 char *olsr_rtp_to_string(const struct rt_path *);
220 void olsr_print_routing_table(const struct avl_tree *);
221
222 const struct rt_nexthop * olsr_get_nh(const struct rt_entry *);
223
224 /* rt_path manipulation */
225 struct rt_path *olsr_insert_routing_table(union olsr_ip_addr *, int, union olsr_ip_addr *, int);
226 void olsr_delete_routing_table(union olsr_ip_addr *, int, union olsr_ip_addr *);
227 void olsr_insert_rt_path(struct rt_path *, struct tc_entry *, struct link_entry *);
228 void olsr_update_rt_path(struct rt_path *, struct tc_entry *, struct link_entry *);
229
230 struct rt_entry *
231 olsr_lookup_routing_table(const union olsr_ip_addr *);
232
233
234 #endif
235
236 /*
237  * Local Variables:
238  * c-basic-offset: 2
239  * End:
240  */