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