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