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