fixup comment
[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  * Delete 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  */
118 void
119 olsr_delete_all_kernel_routes(void)
120
121   OLSR_PRINTF(1, "Deleting all routes...\n");
122
123   olsr_bump_routingtree_version();
124   olsr_update_rib_routes();
125   olsr_update_kernel_routes();
126 }
127
128 /**
129  * Enqueue a route on a kernel add/chg/del queue.
130  */
131 static void
132 olsr_enqueue_rt(struct list_node *head_node, struct rt_entry *rt)
133 {
134   const struct rt_nexthop *nh;
135
136   /* if this node is already on some changelist we are done */
137   if (list_node_on_list(&rt->rt_change_node)) {
138     return;
139   }
140
141   /*
142    * For easier route dependency tracking we enqueue nexthop routes
143    * at the head of the queue and non-nexthop routes at the tail of the queue.
144    */
145   nh = olsr_get_nh(rt);
146
147   if (ipequal(&rt->rt_dst.prefix, &nh->gateway)) {
148     list_add_after(head_node, &rt->rt_change_node);
149   } else {
150     list_add_before(head_node, &rt->rt_change_node);
151   }
152 }
153
154 /**
155  * Process a route from the kernel deletion list.
156  *
157  *@return nada
158  */
159 static void
160 olsr_delete_kernel_route(struct rt_entry *rt)
161 {
162   if(!olsr_cnf->host_emul) {
163     olsr_16_t error = olsr_cnf->ip_version == AF_INET ?
164       olsr_delroute_function(rt) : olsr_delroute6_function(rt);
165
166     if(error < 0) {
167       const char * const err_msg = strerror(errno);
168       const char * const routestr = olsr_rt_to_string(rt);
169       OLSR_PRINTF(1, "KERN: ERROR deleting %s: %s\n", routestr, err_msg);
170
171       olsr_syslog(OLSR_LOG_ERR, "Delete route %s: %s", routestr, err_msg);
172     }
173   }
174 }
175
176 /**
177  * Process a route from the kernel addition list.
178  *
179  *@return nada
180  */
181 static void
182 olsr_add_kernel_route(struct rt_entry *rt)
183 {
184
185   if(!olsr_cnf->host_emul) {
186     olsr_16_t error = olsr_cnf->ip_version == AF_INET ?
187       olsr_addroute_function(rt) : olsr_addroute6_function(rt);
188
189     if(error < 0) {
190       const char * const err_msg = strerror(errno);
191       const char * const routestr = olsr_rtp_to_string(rt->rt_best);
192       OLSR_PRINTF(1, "KERN: ERROR adding %s: %s\n", routestr, err_msg);
193
194       olsr_syslog(OLSR_LOG_ERR, "Add route %s: %s", routestr, err_msg);
195     } else {
196
197       /* route addition has suceeded */
198
199       /* save the nexthop and metric in the route entry */
200       rt->rt_nexthop = rt->rt_best->rtp_nexthop;
201       rt->rt_metric = rt->rt_best->rtp_metric;
202     }
203   }
204 }
205
206 /**
207  * process the kernel add list.
208  * the routes are already ordered such that nexthop routes
209  * are on the head of the queue.
210  * nexthop routes need to be added first and therefore
211  * the queue needs to be traversed from head to tail.
212  */
213 static void
214 olsr_add_kernel_routes(struct list_node *head_node)
215 {
216   struct rt_entry *rt;
217
218   while (!list_is_empty(head_node)) {
219     rt = changelist2rt(head_node->next);
220     olsr_add_kernel_route(rt);
221
222     list_remove(&rt->rt_change_node);
223   }
224 }
225
226 /**
227  * process the kernel change list.
228  * the routes are already ordered such that nexthop routes
229  * are on the head of the queue.
230  * non-nexthop routes need to be changed first and therefore
231  * the queue needs to be traversed from tail to head.
232  */
233 static void
234 olsr_chg_kernel_routes(struct list_node *head_node)
235 {
236   struct rt_entry *rt;
237   struct list_node *node;
238
239   if (list_is_empty(head_node)) {
240     return;
241   }
242
243   /*
244    * First pass.
245    * traverse from the end to the beginning of the list,
246    * such that nexthop routes are deleted last.
247    */
248   for (node = head_node->prev; head_node != node; node = node->prev) {
249     rt = changelist2rt(node);
250     olsr_delete_kernel_route(rt);
251   }
252
253   /*
254    * Second pass.
255    * Traverse from the beginning to the end of the list,
256    * such that nexthop routes are added first.
257    */
258   while (!list_is_empty(head_node)) {
259     rt = changelist2rt(head_node->next);
260     olsr_add_kernel_route(rt);
261
262     list_remove(&rt->rt_change_node);
263   }
264 }
265
266 /**
267  * process the kernel delete list.
268  * the routes are already ordered such that nexthop routes
269  * are on the head of the queue.
270  * non-nexthop routes need to be deleted first and therefore
271  * the queue needs to be traversed from tail to head.
272  */
273 static void
274 olsr_del_kernel_routes(struct list_node *head_node)
275 {
276   struct rt_entry *rt;
277
278   while (!list_is_empty(head_node)) {
279     rt = changelist2rt(head_node->prev);
280     olsr_delete_kernel_route(rt);
281
282     list_remove(&rt->rt_change_node);
283     free(rt);
284   }
285 }
286
287 /**
288  * Check the version number of all route paths hanging off a route entry.
289  * If a route does not match the current routing tree number, remove it
290  * from the global originator tree for that rt_entry.
291  * Reset the best route pointer.
292  */
293 static void
294 olsr_delete_outdated_routes(struct rt_entry *rt)
295 {
296   struct rt_path *rtp;
297   struct avl_node *rtp_tree_node, *next_rtp_tree_node;
298
299   for (rtp_tree_node = avl_walk_first(&rt->rt_path_tree);
300        rtp_tree_node != NULL;
301        rtp_tree_node = next_rtp_tree_node) {
302
303     /*
304      * pre-fetch the next node before loosing context.
305      */
306     next_rtp_tree_node = avl_walk_next(rtp_tree_node);
307
308     rtp = rtp_tree2rtp(rtp_tree_node);
309
310     /*
311      * check the version number which gets incremented on every SPF run.
312      * comparing for unequalness avoids handling version number wraps.
313      */
314     if (routingtree_version != rtp->rtp_version) {
315
316       /* remove from the originator tree */
317       avl_delete(&rt->rt_path_tree, rtp_tree_node);
318       rtp->rtp_rt = NULL;
319     }
320   }
321
322   /* safety measure against dangling pointers */
323   rt->rt_best = NULL;
324 }
325
326 /**
327  * Walk all the routes, remove outdated routes and run
328  * best path selection on the remaining set.
329  * Finally compare the nexthop of the route head and the best
330  * path and enqueue an add/chg operation.
331  */
332 void
333 olsr_update_rib_routes(void)
334 {
335   struct rt_entry *rt;
336
337   OLSR_PRINTF(3, "Updating kernel routes...\n");
338
339   /* walk all routes in the RIB. */
340
341   OLSR_FOR_ALL_RT_ENTRIES(rt) {
342
343     /* eliminate first unused routes */
344     olsr_delete_outdated_routes(rt);
345
346     if (!rt->rt_path_tree.count) {
347
348       /* oops, all routes are gone - flush the route head */
349       avl_delete(&routingtree, rt_tree_node);
350
351       olsr_enqueue_rt(&del_kernel_list, rt);
352       continue;
353     }
354
355     /* run best route election */
356     olsr_rt_best(rt);
357
358     /* nexthop or hopcount change ? */
359     if (olsr_nh_change(&rt->rt_best->rtp_nexthop, &rt->rt_nexthop) ||
360         (FIBM_CORRECT == olsr_cnf->fib_metric &&
361          olsr_hopcount_change(&rt->rt_best->rtp_metric, &rt->rt_metric))) {
362
363       if (0 > rt->rt_nexthop.iif_index) {
364
365         /* fresh routes do have an interface index of -1. */
366         olsr_enqueue_rt(&add_kernel_list, rt);
367       } else { 
368
369         /* this is a route change. */
370         olsr_enqueue_rt(&chg_kernel_list, rt);
371       }
372     }
373   } OLSR_FOR_ALL_RT_ENTRIES_END(rt);
374 }
375
376 /**
377  * Propagate the accumulated changes from the last rib update to the kernel.
378  */
379 void
380 olsr_update_kernel_routes(void)
381 {
382
383   /* delete unreachable routes */
384   olsr_del_kernel_routes(&del_kernel_list);
385
386   /* route changes */
387   olsr_chg_kernel_routes(&chg_kernel_list);
388
389   /* route additions */
390   olsr_add_kernel_routes(&add_kernel_list);
391
392 #if DEBUG
393   olsr_print_routing_table(&routingtree);
394 #endif
395 }
396
397 /*
398  * Local Variables:
399  * c-basic-offset: 2
400  * End:
401  */