eliminate the data field from a list_node
[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 "common/list.h"
64 #include "common/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   struct lqtextbuffer lqbuffer;
106 #endif
107   tc->cand_tree_node.key = &tc->path_cost;
108   tc->cand_tree_node.data = tc;
109
110 #ifdef DEBUG
111   OLSR_PRINTF(2, "SPF: insert candidate %s, cost %s\n",
112               olsr_ip_to_string(&buf, &tc->addr),
113               get_linkcost_text(tc->path_cost, OLSR_FALSE, &lqbuffer));
114 #endif
115
116   avl_insert(tree, &tc->cand_tree_node, AVL_DUP);
117 }
118
119 /*
120  * olsr_spf_del_cand_tree
121  *
122  * Unkey an existing vertex from a candidate tree.
123  */
124 static void
125 olsr_spf_del_cand_tree (struct avl_tree *tree,
126                         struct tc_entry *tc)
127 {
128
129 #ifdef DEBUG
130 #ifndef NODEBUG
131   struct ipaddr_str buf;
132   struct lqtextbuffer lqbuffer;
133 #endif
134   OLSR_PRINTF(2, "SPF: delete candidate %s, cost %s\n",
135               olsr_ip_to_string(&buf, &tc->addr),
136               get_linkcost_text(tc->path_cost, OLSR_FALSE, &lqbuffer));
137 #endif
138
139   avl_delete(tree, &tc->cand_tree_node);
140 }
141
142 /*
143  * olsr_spf_add_path_list
144  *
145  * Insert an SPF result at the end of the path list.
146  */
147 static void
148 olsr_spf_add_path_list (struct list_node *head, int *path_count,
149                         struct tc_entry *tc)
150 {
151 #if !defined(NODEBUG) && defined(DEBUG)
152   struct ipaddr_str pathbuf, nbuf;
153   struct lqtextbuffer lqbuffer;
154 #endif
155
156 #ifdef DEBUG
157   OLSR_PRINTF(2, "SPF: append path %s, cost %s, via %s\n",
158               olsr_ip_to_string(&pathbuf, &tc->addr),
159               get_linkcost_text(tc->path_cost, OLSR_FALSE, &lqbuffer),
160               tc->next_hop ? olsr_ip_to_string(
161                 &nbuf, &tc->next_hop->neighbor_iface_addr) : "-");
162 #endif
163
164   list_add_before(head, &tc->path_list_node);
165   *path_count = *path_count + 1;
166 }
167
168 /*
169  * olsr_spf_extract_best
170  *
171  * return the node with the minimum pathcost.
172  */
173 static struct tc_entry *
174 olsr_spf_extract_best (struct avl_tree *tree)
175 {
176   struct avl_node *node = avl_walk_first(tree);
177
178   return (node ? node->data :  NULL);
179 }
180
181
182 /*
183  * olsr_spf_relax
184  *
185  * Explore all edges of a node and add the node
186  * to the candidate tree if the if the aggregate
187  * path cost is better.
188  */
189 static void
190 olsr_spf_relax (struct avl_tree *cand_tree, struct tc_entry *tc)
191 {
192   struct avl_node *edge_node;
193   olsr_linkcost new_cost;
194
195 #ifdef DEBUG
196 #ifndef NODEBUG
197   struct ipaddr_str buf, nbuf;
198   struct lqtextbuffer lqbuffer;
199 #endif
200   OLSR_PRINTF(2, "SPF: exploring node %s, cost %s\n",
201               olsr_ip_to_string(&buf, &tc->addr),
202               get_linkcost_text(tc->path_cost, OLSR_FALSE, &lqbuffer));
203 #endif
204
205   /*
206    * loop through all edges of this vertex.
207    */
208   for (edge_node = avl_walk_first(&tc->edge_tree);
209        edge_node;
210        edge_node = avl_walk_next(edge_node)) {
211
212     struct tc_entry *new_tc;
213     struct tc_edge_entry *tc_edge = edge_node->data;
214
215     /*
216      * We are not interested in dead-end or dying edges.
217      */
218     if (!tc_edge->edge_inv ||
219         ((tc_edge->flags | tc_edge->edge_inv->flags) & OLSR_TC_EDGE_DOWN)) {
220 #ifdef DEBUG
221       OLSR_PRINTF(2, "SPF:   ignoring edge %s\n",
222                   olsr_ip_to_string(&buf, &tc_edge->T_dest_addr));
223       if (tc_edge->flags & OLSR_TC_EDGE_DOWN) {
224         OLSR_PRINTF(2, "SPF:     edge down\n");
225       }
226       if (!tc_edge->edge_inv) {
227         OLSR_PRINTF(2, "SPF:     no inverse edge\n");
228       }  else if (tc_edge->edge_inv->flags & OLSR_TC_EDGE_DOWN){
229         OLSR_PRINTF(2, "SPF:     inverse edge down\n");
230       }
231 #endif
232       continue;
233     }
234
235     /*
236      * total quality of the path through this vertex
237      * to the destination of this edge
238      */
239     new_cost = tc->path_cost + tc_edge->cost;
240
241 #ifdef DEBUG
242       OLSR_PRINTF(2, "SPF:   exploring edge %s, cost %s\n",
243                   olsr_ip_to_string(&buf, &tc_edge->T_dest_addr),
244                   get_linkcost_text(new_cost, OLSR_TRUE, &lqbuffer));
245 #endif
246
247       /* 
248        * if it's better than the current path quality of this edge's
249        * destination node, then we've found a better path to this node.
250        */
251     new_tc = tc_edge->edge_inv->tc;
252
253     if (new_cost < new_tc->path_cost) {
254
255       /* if this node has been on the candidate tree delete it */
256       if (new_tc->path_cost < ROUTE_COST_BROKEN) {
257         olsr_spf_del_cand_tree(cand_tree, new_tc);
258       }
259
260       /* re-insert on candidate tree with the better metric */
261       new_tc->path_cost = new_cost;
262       olsr_spf_add_cand_tree(cand_tree, new_tc);
263
264       /* pull-up the next-hop and bump the hop count */
265       if (tc->next_hop) {
266         new_tc->next_hop = tc->next_hop;
267       }
268       new_tc->hops = tc->hops + 1;
269
270 #ifdef DEBUG
271       OLSR_PRINTF(2, "SPF:   better path to %s, cost %s, via %s, hops %u\n",
272                   olsr_ip_to_string(&buf, &new_tc->addr),
273                   get_linkcost_text(new_cost, OLSR_TRUE, &lqbuffer),
274                   tc->next_hop ? olsr_ip_to_string(
275                     &nbuf, &tc->next_hop->neighbor_iface_addr) : "<none>",
276                   new_tc->hops);
277 #endif
278
279     }
280   }
281 }
282
283 /*
284  * olsr_spf_run_full
285  *
286  * Run the Dijkstra algorithm.
287  * 
288  * A node gets added to the candidate tree when one of its edges has
289  * an overall better root path cost than the node itself.
290  * The node with the shortest metric gets moved from the candidate to
291  * the path list every pass.
292  * The SPF computation is completed when there are no more nodes
293  * on the candidate tree. 
294  */ 
295 static void
296 olsr_spf_run_full (struct avl_tree *cand_tree, struct list_node *path_list,
297                    int *path_count)
298 {
299   struct tc_entry *tc;
300
301   *path_count = 0;
302
303   while ((tc = olsr_spf_extract_best(cand_tree))) {
304
305     olsr_spf_relax(cand_tree, tc);
306
307     /*
308      * move the best path from the candidate tree
309      * to the path list.
310      */
311     olsr_spf_del_cand_tree(cand_tree, tc);
312     olsr_spf_add_path_list(path_list, path_count, tc);
313   }
314 }
315
316 /**
317  * Callback for the SPF backoff timer.
318  */
319 static void
320 olsr_expire_spf_backoff(void *context __attribute__((unused)))
321 {
322   spf_backoff_timer = NULL;
323 }
324
325 void
326 olsr_calculate_routing_table (void *context __attribute__((unused)))
327 {
328 #ifdef SPF_PROFILING
329   struct timeval t1, t2, t3, t4, t5, spf_init, spf_run, route, kernel, total;
330 #endif
331   struct avl_tree cand_tree;
332   struct avl_node *rtp_tree_node;
333   struct list_node path_list; /* head of the path_list */
334   struct tc_entry *tc;
335   struct rt_path *rtp;
336   struct tc_edge_entry *tc_edge;
337   struct neighbor_entry *neigh;
338   struct link_entry *link;
339   int path_count = 0;
340
341   /* We are done if our backoff timer is running */
342   if (!spf_backoff_timer) {
343     spf_backoff_timer = 
344       olsr_start_timer(1000, 5, OLSR_TIMER_ONESHOT, &olsr_expire_spf_backoff,
345                        NULL, 0);
346   } else {
347     return;
348   }
349
350 #ifdef SPF_PROFILING
351   gettimeofday(&t1, NULL);
352 #endif
353
354   /*
355    * Prepare the candidate tree and result list.
356    */
357   avl_init(&cand_tree, avl_comp_etx);
358   list_head_init(&path_list);
359   olsr_bump_routingtree_version();
360
361   /*
362    * Initialize vertices in the lsdb.
363    */
364   OLSR_FOR_ALL_TC_ENTRIES(tc) {
365     tc->next_hop = NULL;
366     tc->path_cost = ROUTE_COST_BROKEN;
367     tc->hops = 0;
368   } OLSR_FOR_ALL_TC_ENTRIES_END(tc);
369
370   /*
371    * zero ourselves and add us to the candidate tree.
372    */
373   olsr_change_myself_tc();
374   tc_myself->path_cost = ZERO_ROUTE_COST;
375   olsr_spf_add_cand_tree(&cand_tree, tc_myself);
376
377   /*
378    * add edges to and from our neighbours.
379    */
380   OLSR_FOR_ALL_NBR_ENTRIES(neigh) {
381
382     if (neigh->status == SYM) {
383
384       tc_edge = olsr_lookup_tc_edge(tc_myself, &neigh->neighbor_main_addr);
385       link = get_best_link_to_neighbor(&neigh->neighbor_main_addr);
386       if (!link) {
387
388         /*
389          * If there is no best link to this neighbor
390          * and we had an edge before then flush the edge.
391          */
392         if (tc_edge) {
393           olsr_delete_tc_edge_entry(tc_edge);
394         }
395         continue;
396       }
397
398       /* find the interface for the link */
399       if (link->if_name) {
400         link->inter = if_ifwithname(link->if_name);
401       } else {
402         link->inter = if_ifwithaddr(&link->local_iface_addr);
403       }
404
405       /*
406        * Set the next-hops of our neighbors. 
407        */
408       if (!tc_edge) {
409         tc_edge = olsr_add_tc_edge_entry(tc_myself, &neigh->neighbor_main_addr,
410                                          0, link->vtime);
411       } else {
412         /*
413          * Update LQ and timers, such that the edge does not get deleted.
414          */
415         olsr_copylq_link_entry_2_tc_edge_entry(tc_edge, link);
416         olsr_set_tc_edge_timer(tc_edge, link->vtime*1000);
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   } OLSR_FOR_ALL_NBR_ENTRIES_END(neigh);
424
425 #ifdef SPF_PROFILING
426   gettimeofday(&t2, NULL);
427 #endif
428
429   /*
430    * Run the SPF calculation.
431    */
432   olsr_spf_run_full(&cand_tree, &path_list, &path_count);
433
434   OLSR_PRINTF(2, "\n--- %s ------------------------------------------------- DIJKSTRA\n\n",
435               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 #ifndef NODEBUG
457         struct ipaddr_str buf;
458 #endif
459         OLSR_PRINTF(2, "SPF: %s no next-hop\n", olsr_ip_to_string(&buf, &tc->addr));
460       }
461 #endif
462       continue;
463     }
464
465     /*
466      * Now walk all prefixes advertised by that node.
467      * Since the node is reachable, insert the prefix into the global RIB.
468      * If the prefix is already in the RIB, refresh the entry such
469      * that olsr_delete_outdated_routes() does not purge it off.
470      */
471     for (rtp_tree_node = avl_walk_first(&tc->prefix_tree);
472          rtp_tree_node;
473          rtp_tree_node = avl_walk_next(rtp_tree_node)) {
474
475       rtp = rtp_tree_node->data;
476
477       if (rtp->rtp_rt) {
478
479         /*
480          * If there is a route entry, the prefix is already in the global RIB.
481          */
482         olsr_update_rt_path(rtp, tc, link);
483
484       } else {
485
486         /*
487          * The prefix is reachable and not yet in the global RIB.
488          * Build a rt_entry for it.
489          */
490         olsr_insert_rt_path(rtp, tc, link);
491       }
492     }
493   }
494
495   /* Update the RIB based on the new SPF results */
496
497   olsr_update_rib_routes();
498
499 #ifdef SPF_PROFILING
500   gettimeofday(&t4, NULL);
501 #endif
502
503   /* move the route changes into the kernel */
504
505   olsr_update_kernel_routes();
506
507 #ifdef SPF_PROFILING
508   gettimeofday(&t5, NULL);
509 #endif
510
511 #ifdef SPF_PROFILING
512   timersub(&t2, &t1, &spf_init);
513   timersub(&t3, &t2, &spf_run);
514   timersub(&t4, &t3, &route);
515   timersub(&t5, &t4, &kernel);
516   timersub(&t5, &t1, &total);
517   OLSR_PRINTF(1, "\n--- SPF-stats for %d nodes, %d routes (total/init/run/route/kern): "
518               "%d, %d, %d, %d, %d\n",
519               path_count, routingtree.count,
520               (int)total.tv_usec, (int)spf_init.tv_usec, (int)spf_run.tv_usec,
521               (int)route.tv_usec, (int)kernel.tv_usec);
522 #endif
523 }
524
525 /*
526  * Local Variables:
527  * c-basic-offset: 2
528  * End:
529  */