eliminate the data field from an avl_node
[olsrd.git] / src / process_routes.c
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  * export_route_entry interface added by Immo 'FaUl Wehrenberg 
8  * <immo@chaostreff-dortmund.de> and reworked by sven-ola 2007
9  *
10  * Redistribution and use in source and binary forms, with or without 
11  * modification, are permitted provided that the following conditions 
12  * are met:
13  *
14  * * Redistributions of source code must retain the above copyright 
15  *   notice, this list of conditions and the following disclaimer.
16  * * Redistributions in binary form must reproduce the above copyright 
17  *   notice, this list of conditions and the following disclaimer in 
18  *   the documentation and/or other materials provided with the 
19  *   distribution.
20  * * Neither the name of olsr.org, olsrd nor the names of its 
21  *   contributors may be used to endorse or promote products derived 
22  *   from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
35  * POSSIBILITY OF SUCH DAMAGE.
36  *
37  * Visit http://www.olsr.org for more information.
38  *
39  * If you find this software useful feel free to make a donation
40  * to the project. For more information see the website or contact
41  * the copyright holders.
42  *
43  */
44
45 #include "ipcalc.h"
46 #include "defs.h"
47 #include "olsr.h"
48 #include "log.h"
49 #include "kernel_routes.h"
50 #include "common/avl.h"
51 #include "net_olsr.h"
52 #include "tc_set.h"
53
54 #ifdef WIN32
55 #undef strerror
56 #define strerror(x) StrError(x)
57 #endif
58
59 static struct list_node add_kernel_list;
60 static struct list_node chg_kernel_list;
61 static struct list_node del_kernel_list;
62
63
64 /**
65  *
66  * Calculate the kernel route flags.
67  * Called before enqueuing a change/delete operation
68  *
69  */
70 olsr_u8_t
71 olsr_rt_flags(const struct rt_entry *rt)
72 {
73   const struct rt_nexthop *nh;
74   olsr_u8_t flags = RTF_UP;
75
76   if (rt->rt_dst.prefix_len == olsr_cnf->maxplen) {
77     flags |= RTF_HOST;
78   }
79
80   nh = olsr_get_nh(rt);
81
82   if(!ipequal(&rt->rt_dst.prefix, &nh->gateway)) {
83     flags |= RTF_GATEWAY;
84   }
85
86   return flags;
87 }
88
89
90 export_route_function olsr_addroute_function;
91 export_route_function olsr_addroute6_function;
92 export_route_function olsr_delroute_function;
93 export_route_function olsr_delroute6_function;
94
95
96 void 
97 olsr_init_export_route(void)
98 {
99   /* the add/chg/del kernel queues */
100   list_head_init(&add_kernel_list);
101   list_head_init(&chg_kernel_list);
102   list_head_init(&del_kernel_list);
103
104   olsr_addroute_function = olsr_ioctl_add_route;
105   olsr_addroute6_function = olsr_ioctl_add_route6;
106   olsr_delroute_function = olsr_ioctl_del_route;
107   olsr_delroute6_function = olsr_ioctl_del_route6;
108 }
109
110 /**
111  *Deletes all OLSR routes
112  *
113  * This is extremely simple - Just increment the version of the
114  * tree and then olsr_update_rib_routes() will see all routes in the tree
115  * as outdated and olsr_update_kernel_routes() will finally flush it.
116  *
117  *@return 1
118  */
119 void
120 olsr_delete_all_kernel_routes(void)
121
122   OLSR_PRINTF(1, "Deleting all routes...\n");
123
124   olsr_bump_routingtree_version();
125   olsr_update_rib_routes();
126   olsr_update_kernel_routes();
127 }
128
129 /**
130  * Enqueue a route on a kernel add/chg/del queue.
131  */
132 static void
133 olsr_enqueue_rt(struct list_node *head_node, struct rt_entry *rt)
134 {
135   const struct rt_nexthop *nh;
136
137   /* if this node is already on some changelist we are done */
138   if (list_node_on_list(&rt->rt_change_node)) {
139     return;
140   }
141
142   /*
143    * For easier route dependency tracking we enqueue nexthop routes
144    * at the head of the queue and non-nexthop routes at the tail of the queue.
145    */
146   nh = olsr_get_nh(rt);
147
148   if (ipequal(&rt->rt_dst.prefix, &nh->gateway)) {
149     list_add_after(head_node, &rt->rt_change_node);
150   } else {
151     list_add_before(head_node, &rt->rt_change_node);
152   }
153 }
154
155 /**
156  * Process a route from the kernel deletion list.
157  *
158  *@return nada
159  */
160 static void
161 olsr_delete_kernel_route(struct rt_entry *rt)
162 {
163   if(!olsr_cnf->host_emul) {
164     olsr_16_t error = olsr_cnf->ip_version == AF_INET ?
165       olsr_delroute_function(rt) : olsr_delroute6_function(rt);
166
167     if(error < 0) {
168       const char * const err_msg = strerror(errno);
169       const char * const routestr = olsr_rt_to_string(rt);
170       OLSR_PRINTF(1, "KERN: ERROR deleting %s: %s\n", routestr, err_msg);
171
172       olsr_syslog(OLSR_LOG_ERR, "Delete route %s: %s", routestr, err_msg);
173     }
174   }
175 }
176
177 /**
178  * Process a route from the kernel addition list.
179  *
180  *@return nada
181  */
182 static void
183 olsr_add_kernel_route(struct rt_entry *rt)
184 {
185
186   if(!olsr_cnf->host_emul) {
187     olsr_16_t error = olsr_cnf->ip_version == AF_INET ?
188       olsr_addroute_function(rt) : olsr_addroute6_function(rt);
189
190     if(error < 0) {
191       const char * const err_msg = strerror(errno);
192       const char * const routestr = olsr_rtp_to_string(rt->rt_best);
193       OLSR_PRINTF(1, "KERN: ERROR adding %s: %s\n", routestr, err_msg);
194
195       olsr_syslog(OLSR_LOG_ERR, "Add route %s: %s", routestr, err_msg);
196     } else {
197
198       /* route addition has suceeded */
199
200       /* save the nexthop and metric in the route entry */
201       rt->rt_nexthop = rt->rt_best->rtp_nexthop;
202       rt->rt_metric = rt->rt_best->rtp_metric;
203     }
204   }
205 }
206
207 /**
208  * process the kernel add list.
209  * the routes are already ordered such that nexthop routes
210  * are on the head of the queue.
211  * nexthop routes need to be added first and therefore
212  * the queue needs to be traversed from head to tail.
213  */
214 static void
215 olsr_add_kernel_routes(struct list_node *head_node)
216 {
217   struct rt_entry *rt;
218
219   while (!list_is_empty(head_node)) {
220     rt = changelist2rt(head_node->next);
221     olsr_add_kernel_route(rt);
222
223     list_remove(&rt->rt_change_node);
224   }
225 }
226
227 /**
228  * process the kernel change list.
229  * the routes are already ordered such that nexthop routes
230  * are on the head of the queue.
231  * non-nexthop routes need to be changed first and therefore
232  * the queue needs to be traversed from tail to head.
233  */
234 static void
235 olsr_chg_kernel_routes(struct list_node *head_node)
236 {
237   struct rt_entry *rt;
238   struct list_node *node;
239
240   if (list_is_empty(head_node)) {
241     return;
242   }
243
244   /*
245    * First pass.
246    * traverse from the end to the beginning of the list,
247    * such that nexthop routes are deleted last.
248    */
249   for (node = head_node->prev; head_node != node; node = node->prev) {
250     rt = changelist2rt(node);
251     olsr_delete_kernel_route(rt);
252   }
253
254   /*
255    * Second pass.
256    * Traverse from the beginning to the end of the list,
257    * such that nexthop routes are added first.
258    */
259   while (!list_is_empty(head_node)) {
260     rt = changelist2rt(head_node->next);
261     olsr_add_kernel_route(rt);
262
263     list_remove(&rt->rt_change_node);
264   }
265 }
266
267 /**
268  * process the kernel delete list.
269  * the routes are already ordered such that nexthop routes
270  * are on the head of the queue.
271  * non-nexthop routes need to be deleted first and therefore
272  * the queue needs to be traversed from tail to head.
273  */
274 static void
275 olsr_del_kernel_routes(struct list_node *head_node)
276 {
277   struct rt_entry *rt;
278
279   while (!list_is_empty(head_node)) {
280     rt = changelist2rt(head_node->prev);
281     olsr_delete_kernel_route(rt);
282
283     list_remove(&rt->rt_change_node);
284     free(rt);
285   }
286 }
287
288 /**
289  * Check the version number of all route paths hanging off a route entry.
290  * If a route does not match the current routing tree number, remove it
291  * from the global originator tree for that rt_entry.
292  * Reset the best route pointer.
293  */
294 static void
295 olsr_delete_outdated_routes(struct rt_entry *rt)
296 {
297   struct rt_path *rtp;
298   struct avl_node *rtp_tree_node, *next_rtp_tree_node;
299
300   for (rtp_tree_node = avl_walk_first(&rt->rt_path_tree);
301        rtp_tree_node != NULL;
302        rtp_tree_node = next_rtp_tree_node) {
303
304     /*
305      * pre-fetch the next node before loosing context.
306      */
307     next_rtp_tree_node = avl_walk_next(rtp_tree_node);
308
309     rtp = rtp_tree2rtp(rtp_tree_node);
310
311     /*
312      * check the version number which gets incremented on every SPF run.
313      * comparing for unequalness avoids handling version number wraps.
314      */
315     if (routingtree_version != rtp->rtp_version) {
316
317       /* remove from the originator tree */
318       avl_delete(&rt->rt_path_tree, rtp_tree_node);
319       rtp->rtp_rt = NULL;
320     }
321   }
322
323   /* safety measure against dangling pointers */
324   rt->rt_best = NULL;
325 }
326
327 /**
328  * Walk all the routes, remove outdated routes and run
329  * best path selection on the remaining set.
330  * Finally compare the nexthop of the route head and the best
331  * path and enqueue an add/chg operation.
332  */
333 void
334 olsr_update_rib_routes(void)
335 {
336   struct rt_entry *rt;
337
338   OLSR_PRINTF(3, "Updating kernel routes...\n");
339
340   /* walk all routes in the RIB. */
341
342   OLSR_FOR_ALL_RT_ENTRIES(rt) {
343
344     /* eliminate first unused routes */
345     olsr_delete_outdated_routes(rt);
346
347     if (!rt->rt_path_tree.count) {
348
349       /* oops, all routes are gone - flush the route head */
350       avl_delete(&routingtree, rt_tree_node);
351
352       olsr_enqueue_rt(&del_kernel_list, rt);
353       continue;
354     }
355
356     /* run best route election */
357     olsr_rt_best(rt);
358
359     /* nexthop or hopcount change ? */
360     if (olsr_nh_change(&rt->rt_best->rtp_nexthop, &rt->rt_nexthop) ||
361         (FIBM_CORRECT == olsr_cnf->fib_metric &&
362          olsr_hopcount_change(&rt->rt_best->rtp_metric, &rt->rt_metric))) {
363
364       if (0 > rt->rt_nexthop.iif_index) {
365
366         /* fresh routes do have an interface index of -1. */
367         olsr_enqueue_rt(&add_kernel_list, rt);
368       } else { 
369
370         /* this is a route change. */
371         olsr_enqueue_rt(&chg_kernel_list, rt);
372       }
373     }
374   } OLSR_FOR_ALL_RT_ENTRIES_END(rt);
375 }
376
377 /**
378  * Propagate the accumulated changes from the last rib update to the kernel.
379  */
380 void
381 olsr_update_kernel_routes(void)
382 {
383
384   /* delete unreachable routes */
385   olsr_del_kernel_routes(&del_kernel_list);
386
387   /* route changes */
388   olsr_chg_kernel_routes(&chg_kernel_list);
389
390   /* route additions */
391   olsr_add_kernel_routes(&add_kernel_list);
392
393 #if DEBUG
394   olsr_print_routing_table(&routingtree);
395 #endif
396 }
397
398 /*
399  * Local Variables:
400  * c-basic-offset: 2
401  * End:
402  */