Keep all HNAs stored (even if the collide with local HNAs), just don't add the routes
[olsrd.git] / src / olsr_spf.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.de)
5  * IPv4 performance optimization (c) 2006, sven-ola(gmx.de)
6  * SPF implementation (c) 2007, Hannes Gredler (hannes@gredler.at)
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * * Redistributions of source code must retain the above copyright
14  *   notice, this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above copyright
16  *   notice, this list of conditions and the following disclaimer in
17  *   the documentation and/or other materials provided with the
18  *   distribution.
19  * * Neither the name of olsr.org, olsrd nor the names of its
20  *   contributors may be used to endorse or promote products derived
21  *   from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  * Visit http://www.olsr.org for more information.
37  *
38  * If you find this software useful feel free to make a donation
39  * to the project. For more information see the website or contact
40  * the copyright holders.
41  *
42  * Implementation of Dijkstras algorithm. Initially all nodes
43  * are initialized to infinite cost. First we put ourselves
44  * on the heap of reachable nodes. Our heap implementation
45  * is based on an AVL tree which gives interesting performance
46  * characteristics for the frequent operations of minimum key
47  * extraction and re-keying. Next all neighbors of a node are
48  * explored and put on the heap if the cost of reaching them is
49  * better than reaching the current candidate node.
50  * The SPF calculation is terminated if there are no more nodes
51  * on the heap.
52  */
53
54 #include "ipcalc.h"
55 #include "defs.h"
56 #include "olsr.h"
57 #include "tc_set.h"
58 #include "neighbor_table.h"
59 #include "two_hop_neighbor_table.h"
60 #include "link_set.h"
61 #include "routing_table.h"
62 #include "mid_set.h"
63 #include "hna_set.h"
64 #include "common/list.h"
65 #include "common/avl.h"
66 #include "olsr_spf.h"
67 #include "net_olsr.h"
68 #include "lq_plugin.h"
69 #include "gateway.h"
70
71 struct timer_entry *spf_backoff_timer = NULL;
72
73 /*
74  * avl_comp_etx
75  *
76  * compare two etx metrics.
77  * return 0 if there is an exact match and
78  * -1 / +1 depending on being smaller or bigger.
79  * note that this results in the most optimal code
80  * after compiler optimization.
81  */
82 static int
83 avl_comp_etx(const void *etx1, const void *etx2)
84 {
85   if (*(const olsr_linkcost *)etx1 < *(const olsr_linkcost *)etx2) {
86     return -1;
87   }
88
89   if (*(const olsr_linkcost *)etx1 > *(const olsr_linkcost *)etx2) {
90     return +1;
91   }
92
93   return 0;
94 }
95
96 /*
97  * olsr_spf_add_cand_tree
98  *
99  * Key an existing vertex to a candidate tree.
100  */
101 static void
102 olsr_spf_add_cand_tree(struct avl_tree *tree, struct tc_entry *tc)
103 {
104 #if !defined(NODEBUG) && defined(DEBUG)
105   struct ipaddr_str buf;
106   struct lqtextbuffer lqbuffer;
107 #endif
108   tc->cand_tree_node.key = &tc->path_cost;
109
110 #ifdef DEBUG
111   OLSR_PRINTF(2, "SPF: insert candidate %s, cost %s\n", olsr_ip_to_string(&buf, &tc->addr),
112               get_linkcost_text(tc->path_cost, false, &lqbuffer));
113 #endif
114
115   avl_insert(tree, &tc->cand_tree_node, AVL_DUP);
116 }
117
118 /*
119  * olsr_spf_del_cand_tree
120  *
121  * Unkey an existing vertex from a candidate tree.
122  */
123 static void
124 olsr_spf_del_cand_tree(struct avl_tree *tree, struct tc_entry *tc)
125 {
126
127 #ifdef DEBUG
128 #ifndef NODEBUG
129   struct ipaddr_str buf;
130   struct lqtextbuffer lqbuffer;
131 #endif
132   OLSR_PRINTF(2, "SPF: delete candidate %s, cost %s\n", olsr_ip_to_string(&buf, &tc->addr),
133               get_linkcost_text(tc->path_cost, false, &lqbuffer));
134 #endif
135
136   avl_delete(tree, &tc->cand_tree_node);
137 }
138
139 /*
140  * olsr_spf_add_path_list
141  *
142  * Insert an SPF result at the end of the path list.
143  */
144 static void
145 olsr_spf_add_path_list(struct list_node *head, int *path_count, struct tc_entry *tc)
146 {
147 #if !defined(NODEBUG) && defined(DEBUG)
148   struct ipaddr_str pathbuf, nbuf;
149   struct lqtextbuffer lqbuffer;
150 #endif
151
152 #ifdef DEBUG
153   OLSR_PRINTF(2, "SPF: append path %s, cost %s, via %s\n", olsr_ip_to_string(&pathbuf, &tc->addr),
154               get_linkcost_text(tc->path_cost, false, &lqbuffer), tc->next_hop ? olsr_ip_to_string(&nbuf,
155                                                                                                    &tc->next_hop->
156                                                                                                    neighbor_iface_addr) : "-");
157 #endif
158
159   list_add_before(head, &tc->path_list_node);
160   *path_count = *path_count + 1;
161 }
162
163 /*
164  * olsr_spf_extract_best
165  *
166  * return the node with the minimum pathcost.
167  */
168 static struct tc_entry *
169 olsr_spf_extract_best(struct avl_tree *tree)
170 {
171   struct avl_node *node = avl_walk_first(tree);
172
173   return (node ? cand_tree2tc(node) : NULL);
174 }
175
176 /*
177  * olsr_spf_relax
178  *
179  * Explore all edges of a node and add the node
180  * to the candidate tree if the if the aggregate
181  * path cost is better.
182  */
183 static void
184 olsr_spf_relax(struct avl_tree *cand_tree, struct tc_entry *tc)
185 {
186   struct avl_node *edge_node;
187   olsr_linkcost new_cost;
188
189 #ifdef DEBUG
190 #ifndef NODEBUG
191   struct ipaddr_str buf, nbuf;
192   struct lqtextbuffer lqbuffer;
193 #endif
194   OLSR_PRINTF(2, "SPF: exploring node %s, cost %s\n", olsr_ip_to_string(&buf, &tc->addr),
195               get_linkcost_text(tc->path_cost, false, &lqbuffer));
196 #endif
197
198   /*
199    * loop through all edges of this vertex.
200    */
201   for (edge_node = avl_walk_first(&tc->edge_tree); edge_node; edge_node = avl_walk_next(edge_node)) {
202
203     struct tc_entry *new_tc;
204     struct tc_edge_entry *tc_edge = edge_tree2tc_edge(edge_node);
205
206     /*
207      * We are not interested in dead-end edges.
208      */
209     if (!tc_edge->edge_inv) {
210 #ifdef DEBUG
211       OLSR_PRINTF(2, "SPF:   ignoring edge %s\n", olsr_ip_to_string(&buf, &tc_edge->T_dest_addr));
212       if (!tc_edge->edge_inv) {
213         OLSR_PRINTF(2, "SPF:     no inverse edge\n");
214       }
215 #endif
216       continue;
217     }
218
219     /*
220      * total quality of the path through this vertex
221      * to the destination of this edge
222      */
223     new_cost = tc->path_cost + tc_edge->cost;
224
225 #ifdef DEBUG
226     OLSR_PRINTF(2, "SPF:   exploring edge %s, cost %s\n", olsr_ip_to_string(&buf, &tc_edge->T_dest_addr),
227                 get_linkcost_text(new_cost, true, &lqbuffer));
228 #endif
229
230     /*
231      * if it's better than the current path quality of this edge's
232      * destination node, then we've found a better path to this node.
233      */
234     new_tc = tc_edge->edge_inv->tc;
235
236     if (new_cost < new_tc->path_cost) {
237
238       /* if this node has been on the candidate tree delete it */
239       if (new_tc->path_cost < ROUTE_COST_BROKEN) {
240         olsr_spf_del_cand_tree(cand_tree, new_tc);
241       }
242
243       /* re-insert on candidate tree with the better metric */
244       new_tc->path_cost = new_cost;
245       olsr_spf_add_cand_tree(cand_tree, new_tc);
246
247       /* pull-up the next-hop and bump the hop count */
248       if (tc->next_hop) {
249         new_tc->next_hop = tc->next_hop;
250       }
251       new_tc->hops = tc->hops + 1;
252
253 #ifdef DEBUG
254       OLSR_PRINTF(2, "SPF:   better path to %s, cost %s, via %s, hops %u\n", olsr_ip_to_string(&buf, &new_tc->addr),
255                   get_linkcost_text(new_cost, true, &lqbuffer), tc->next_hop ? olsr_ip_to_string(&nbuf,
256                                                                                                  &tc->next_hop->neighbor_iface_addr)
257                   : "<none>", new_tc->hops);
258 #endif
259
260     }
261   }
262 }
263
264 /*
265  * olsr_spf_run_full
266  *
267  * Run the Dijkstra algorithm.
268  *
269  * A node gets added to the candidate tree when one of its edges has
270  * an overall better root path cost than the node itself.
271  * The node with the shortest metric gets moved from the candidate to
272  * the path list every pass.
273  * The SPF computation is completed when there are no more nodes
274  * on the candidate tree.
275  */
276 static void
277 olsr_spf_run_full(struct avl_tree *cand_tree, struct list_node *path_list, int *path_count)
278 {
279   struct tc_entry *tc;
280
281   *path_count = 0;
282
283   while ((tc = olsr_spf_extract_best(cand_tree))) {
284
285     olsr_spf_relax(cand_tree, tc);
286
287     /*
288      * move the best path from the candidate tree
289      * to the path list.
290      */
291     olsr_spf_del_cand_tree(cand_tree, tc);
292     olsr_spf_add_path_list(path_list, path_count, tc);
293   }
294 }
295
296 /**
297  * Callback for the SPF backoff timer.
298  */
299 static void
300 olsr_expire_spf_backoff(void *context __attribute__ ((unused)))
301 {
302   spf_backoff_timer = NULL;
303 }
304
305 void
306 olsr_calculate_routing_table(bool force)
307 {
308 #ifdef SPF_PROFILING
309   struct timeval t1, t2, t3, t4, t5, spf_init, spf_run, route, kernel, total;
310 #endif
311   struct avl_tree cand_tree;
312   struct avl_node *rtp_tree_node;
313   struct list_node path_list;          /* head of the path_list */
314   struct tc_entry *tc;
315   struct rt_path *rtp;
316   struct tc_edge_entry *tc_edge;
317   struct neighbor_entry *neigh;
318   struct link_entry *link;
319   int path_count = 0;
320
321   /* We are done if our backoff timer is running */
322   if (!force) {
323     if (spf_backoff_timer) {
324       return;
325     }
326
327     /* start new backoff timer */
328     spf_backoff_timer = olsr_start_timer(1000, 5, OLSR_TIMER_ONESHOT, &olsr_expire_spf_backoff, NULL, 0);
329   }
330
331 #ifdef SPF_PROFILING
332   gettimeofday(&t1, NULL);
333 #endif
334
335   /*
336    * Prepare the candidate tree and result list.
337    */
338   avl_init(&cand_tree, avl_comp_etx);
339   list_head_init(&path_list);
340   olsr_bump_routingtree_version();
341
342   /*
343    * Initialize vertices in the lsdb.
344    */
345   OLSR_FOR_ALL_TC_ENTRIES(tc) {
346     tc->next_hop = NULL;
347     tc->path_cost = ROUTE_COST_BROKEN;
348     tc->hops = 0;
349   }
350   OLSR_FOR_ALL_TC_ENTRIES_END(tc);
351
352   /*
353    * Check if there was a change in the main IP address.
354    * Bail if there is no main IP address.
355    */
356   olsr_change_myself_tc();
357   if (!tc_myself) {
358
359     /*
360      * All gone now. Flush all routes.
361      */
362     olsr_update_rib_routes();
363     olsr_update_kernel_routes();
364     return;
365   }
366
367   /*
368    * zero ourselves and add us to the candidate tree.
369    */
370   tc_myself->path_cost = ZERO_ROUTE_COST;
371   olsr_spf_add_cand_tree(&cand_tree, tc_myself);
372
373   /*
374    * add edges to and from our neighbours.
375    */
376   OLSR_FOR_ALL_NBR_ENTRIES(neigh) {
377
378     if (neigh->status != SYM) {
379       tc_edge = olsr_lookup_tc_edge(tc_myself, &neigh->neighbor_main_addr);
380       if (tc_edge) {
381         olsr_delete_tc_edge_entry(tc_edge);
382       }
383     }
384     else {
385       tc_edge = olsr_lookup_tc_edge(tc_myself, &neigh->neighbor_main_addr);
386       link = get_best_link_to_neighbor(&neigh->neighbor_main_addr);
387       if (!link || lookup_link_status(link) == LOST_LINK) {
388
389         /*
390          * If there is no best link to this neighbor
391          * and we had an edge before then flush the edge.
392          */
393         if (tc_edge) {
394           olsr_delete_tc_edge_entry(tc_edge);
395         }
396         continue;
397       }
398
399       /* find the interface for the link */
400       if (link->if_name) {
401         link->inter = if_ifwithname(link->if_name);
402       } else {
403         link->inter = if_ifwithaddr(&link->local_iface_addr);
404       }
405
406       /*
407        * Set the next-hops of our neighbors.
408        */
409       if (!tc_edge) {
410         tc_edge = olsr_add_tc_edge_entry(tc_myself, &neigh->neighbor_main_addr, 0);
411       } else {
412
413         /*
414          * Update LQ and timers, such that the edge does not get deleted.
415          */
416         olsr_copylq_link_entry_2_tc_edge_entry(tc_edge, link);
417         olsr_calc_tc_edge_entry_etx(tc_edge);
418       }
419       if (tc_edge->edge_inv) {
420         tc_edge->edge_inv->tc->next_hop = link;
421       }
422     }
423   }
424   OLSR_FOR_ALL_NBR_ENTRIES_END(neigh);
425
426 #ifdef SPF_PROFILING
427   gettimeofday(&t2, NULL);
428 #endif
429
430   /*
431    * Run the SPF calculation.
432    */
433   olsr_spf_run_full(&cand_tree, &path_list, &path_count);
434
435   OLSR_PRINTF(2, "\n--- %s ------------------------------------------------- DIJKSTRA\n\n", olsr_wallclock_string());
436
437 #ifdef SPF_PROFILING
438   gettimeofday(&t3, NULL);
439 #endif
440
441   /*
442    * In the path list we have all the reachable nodes in our topology.
443    */
444   for (; !list_is_empty(&path_list); list_remove(path_list.next)) {
445
446     tc = pathlist2tc(path_list.next);
447     link = tc->next_hop;
448
449     if (!link) {
450 #ifdef DEBUG
451       /*
452        * Supress the error msg when our own tc_entry
453        * does not contain a next-hop.
454        */
455       if (tc != tc_myself) {
456         struct ipaddr_str buf;
457         OLSR_PRINTF(2, "SPF: %s no next-hop\n", olsr_ip_to_string(&buf, &tc->addr));
458       }
459 #endif
460       continue;
461     }
462
463     /*
464      * Now walk all prefixes advertised by that node.
465      * Since the node is reachable, insert the prefix into the global RIB.
466      * If the prefix is already in the RIB, refresh the entry such
467      * that olsr_delete_outdated_routes() does not purge it off.
468      */
469     for (rtp_tree_node = avl_walk_first(&tc->prefix_tree); rtp_tree_node; rtp_tree_node = avl_walk_next(rtp_tree_node)) {
470
471       rtp = rtp_prefix_tree2rtp(rtp_tree_node);
472
473       if (ip_prefix_list_find(olsr_cnf->hna_entries, &rtp->rtp_dst.prefix, rtp->rtp_dst.prefix_len)) {
474         /* do not add HNAs that collide with local entries to global RIB */
475         continue;
476       }
477
478       if (rtp->rtp_rt) {
479
480         /*
481          * If there is a route entry, the prefix is already in the global RIB.
482          */
483         olsr_update_rt_path(rtp, tc, link);
484
485       } else {
486
487         /*
488          * The prefix is reachable and not yet in the global RIB.
489          * Build a rt_entry for it.
490          */
491         olsr_insert_rt_path(rtp, tc, link);
492       }
493     }
494   }
495 #if defined linux
496   /* check gateway tunnels */
497   olsr_trigger_gatewayloss_check();
498 #endif
499
500   /* Update the RIB based on the new SPF results */
501
502   olsr_update_rib_routes();
503
504 #ifdef SPF_PROFILING
505   gettimeofday(&t4, NULL);
506 #endif
507
508   /* move the route changes into the kernel */
509
510   olsr_update_kernel_routes();
511
512 #ifdef SPF_PROFILING
513   gettimeofday(&t5, NULL);
514 #endif
515
516 #ifdef SPF_PROFILING
517   timersub(&t2, &t1, &spf_init);
518   timersub(&t3, &t2, &spf_run);
519   timersub(&t4, &t3, &route);
520   timersub(&t5, &t4, &kernel);
521   timersub(&t5, &t1, &total);
522   OLSR_PRINTF(1, "\n--- SPF-stats for %d nodes, %d routes (total/init/run/route/kern): " "%d, %d, %d, %d, %d\n", path_count,
523               routingtree.count, (int)total.tv_usec, (int)spf_init.tv_usec, (int)spf_run.tv_usec, (int)route.tv_usec,
524               (int)kernel.tv_usec);
525 #endif
526 }
527
528 /*
529  * Local Variables:
530  * c-basic-offset: 2
531  * indent-tabs-mode: nil
532  * End:
533  */