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