Cleanup:
[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  * $Id: lq_route.c,v 1.56 2007/11/05 15:32:55 bernd67 Exp $
42  */
43
44 #include "defs.h"
45 #include "olsr.h"
46 #include "tc_set.h"
47 #include "neighbor_table.h"
48 #include "two_hop_neighbor_table.h"
49 #include "link_set.h"
50 #include "routing_table.h"
51 #include "mid_set.h"
52 #include "hna_set.h"
53 #include "lq_list.h"
54 #include "lq_avl.h"
55 #include "lq_route.h"
56
57 /*
58  * avl_comp_etx
59  *
60  * compare two etx metrics.
61  * return 0 if there is an exact match and
62  * -1 / +1 depending on being smaller or bigger.
63  * note that this results in the most optimal code
64  * after compiler optimization.
65  */
66 static int
67 avl_comp_etx (void *etx1, void *etx2)
68 {       
69   if (*(float *)etx1 < *(float *)etx2) {
70     return -1;
71   }
72
73   if (*(float *)etx1 > *(float *)etx2) {
74     return +1;
75   }
76
77   return 0;
78 }
79
80 /*
81  * olsr_spf_add_cand_tree
82  *
83  * Key an existing vertex to a candidate tree.
84  */
85 static void
86 olsr_spf_add_cand_tree (struct avl_tree *tree,
87                         struct tc_entry *vert)
88 {
89   vert->cand_tree_node.key = &vert->path_etx;
90   vert->cand_tree_node.data = vert;
91
92 #ifdef DEBUG
93   OLSR_PRINTF(1, "SPF: insert candidate %s, cost %f\n",
94               olsr_ip_to_string(&(vert->addr)),
95               vert->path_etx);
96 #endif
97
98   avl_insert(tree, &vert->cand_tree_node, AVL_DUP);
99 }
100
101 /*
102  * olsr_spf_del_cand_tree
103  *
104  * Unkey an existing vertex from a candidate tree.
105  */
106 static void
107 olsr_spf_del_cand_tree (struct avl_tree *tree,
108                         struct tc_entry *vert)
109 {
110
111 #ifdef DEBUG
112   OLSR_PRINTF(1, "SPF: delete candidate %s, cost %f\n",
113               olsr_ip_to_string(&(vert->addr)),
114               vert->path_etx);
115 #endif
116
117   avl_delete(tree, &vert->cand_tree_node);
118 }
119
120 /*
121  * olsr_spf_add_path_list
122  *
123  * Insert an SPF result at the end of the path list.
124  */
125 static void
126 olsr_spf_add_path_list (struct list_node *head,
127                         int *path_count,
128                         struct tc_entry *vert)
129 {
130   vert->path_list_node.data = vert;
131
132 #ifdef DEBUG
133   OLSR_PRINTF(1, "SPF: append path %s, cost %f, via %s\n",
134               olsr_ip_to_string(&(vert->addr)),
135               vert->path_etx,
136               vert->next_hop ? olsr_ip_to_string(&vert->next_hop->neighbor_iface_addr) : "-");
137 #endif
138
139   list_add_before(head, &vert->path_list_node);
140   *path_count = *path_count + 1;
141 }
142
143 /*
144  * olsr_spf_extract_best
145  *
146  * return the node with the minimum pathcost.
147  */
148 static struct tc_entry *
149 olsr_spf_extract_best (struct avl_tree *tree)
150 {
151   struct avl_node *node = avl_walk_first(tree);
152
153   return (node ? node->data :  NULL);
154 }
155
156
157 char *olsr_etx_to_string(float etx)
158 {
159   static char buff[20];
160
161   if (etx == INFINITE_ETX)
162     return "INF";
163
164   snprintf(buff, sizeof(buff), "%.6f", etx);
165   return buff;
166 }
167
168
169 /*
170  * olsr_spf_relax
171  *
172  * Explore all edges of a node and add the node
173  * to the candidate tree if the if the aggregate
174  * path cost is better.
175  */
176 static void
177 olsr_spf_relax (struct avl_tree *cand_tree, struct tc_entry *vert)
178 {
179   struct tc_entry *new_vert;
180   struct tc_edge_entry *tc_edge;
181   struct avl_node *edge_node;
182   float new_etx;
183
184 #ifdef DEBUG
185   OLSR_PRINTF(1, "SPF: exploring node %s, cost %f\n",
186               olsr_ip_to_string(&vert->addr),
187               vert->path_etx);
188 #endif
189
190   /*
191    * loop through all edges of this vertex.
192    */
193   for (edge_node = avl_walk_first(&vert->edge_tree);
194        edge_node;
195        edge_node = avl_walk_next(edge_node)) {
196
197     tc_edge = edge_node->data;
198
199     /*
200      * We are not interested in dead-end or dying edges.
201      */
202     if (!tc_edge->edge_inv || (tc_edge->flags & OLSR_TC_EDGE_DOWN)) {
203 #ifdef DEBUG
204       OLSR_PRINTF(1, "SPF:   ignoring edge %s\n",
205                   olsr_ip_to_string(&tc_edge->T_dest_addr));
206       if (tc_edge->flags & OLSR_TC_EDGE_DOWN) {
207         OLSR_PRINTF(1, "SPF:     edge down\n");
208       }
209       if (!tc_edge->edge_inv) {
210         OLSR_PRINTF(1, "SPF:     no inverse edge\n");
211       }
212 #endif
213       continue;
214     }
215
216     /*
217      * total quality of the path through this vertex
218      * to the destination of this edge
219      */
220     new_etx = vert->path_etx + tc_edge->etx;
221
222 #ifdef DEBUG
223       OLSR_PRINTF(1, "SPF:   exploring edge %s, cost %s\n",
224                   olsr_ip_to_string(&(tc_edge->T_dest_addr)),
225                   olsr_etx_to_string(new_etx));
226 #endif
227
228       /* 
229        * if it's better than the current path quality of this edge's
230        * destination node, then we've found a better path to this node.
231        */
232     new_vert = tc_edge->edge_inv->tc;
233     if (new_etx < new_vert->path_etx) {
234
235       /* if this node has been on the candidate tree delete it */
236       if (new_vert->path_etx != INFINITE_ETX) {
237         olsr_spf_del_cand_tree(cand_tree, new_vert);
238       }
239
240       /* re-insert on candidate tree with the better metric */
241       new_vert->path_etx = new_etx;
242       olsr_spf_add_cand_tree(cand_tree, new_vert);
243
244       /* pull-up the next-hop and bump the hop count */
245       if (vert->next_hop) {
246         new_vert->next_hop = vert->next_hop;
247       }
248       new_vert->hops = vert->hops + 1;
249
250 #ifdef DEBUG
251       OLSR_PRINTF(1, "SPF:   better path to %s, cost %s -> %s, via %s, hops %u\n",
252                   olsr_ip_to_string(&new_vert->addr),
253                   olsr_etx_to_string(new_vert->path_etx),
254                   olsr_etx_to_string(new_etx),
255                   olsr_ip_to_string(vert->next_hop ?
256                                     &vert->next_hop->neighbor_iface_addr : NULL),
257                   new_vert->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,
278                    int *path_count)
279 {
280   struct tc_entry *vert;
281
282   *path_count = 0;
283
284   while ((vert = olsr_spf_extract_best(cand_tree))) {
285
286     olsr_spf_relax(cand_tree, vert);
287
288     /*
289      * move the best path from the candidate tree
290      * to the path list.
291      */
292     olsr_spf_del_cand_tree(cand_tree, vert);
293     olsr_spf_add_path_list(path_list, path_count, vert);
294   }
295 }
296
297 void
298 olsr_calculate_routing_table (void)
299 {
300   struct avl_tree cand_tree;
301   struct list_node path_list;
302   int i, plen, path_count = 0;
303   struct tc_entry *tc;
304   struct tc_edge_entry *tc_edge;
305   struct tc_entry *vert;
306   struct neighbor_entry *neigh;
307   struct mid_address *mid_walker;
308   struct hna_entry *hna_gw;
309   struct hna_net *hna;
310   struct interface *inter;
311   struct link_entry *link;
312
313 #ifdef SPF_PROFILING
314   struct timeval t1, t2, t3, t4, t5, spf_init, spf_run, route, kernel, total;
315
316   gettimeofday(&t1, NULL);
317 #endif
318
319   /*
320    * Prepare the candidate tree and result list.
321    */
322   avl_init(&cand_tree, avl_comp_etx);
323   list_head_init(&path_list);
324   olsr_bump_routingtree_version();
325
326   /*
327    * Initialize vertices in the lsdb.
328    */
329   OLSR_FOR_ALL_TC_ENTRIES(tc) {
330     tc->next_hop = NULL;
331     tc->path_etx = INFINITE_ETX;
332     tc->hops = 0;
333   } OLSR_FOR_ALL_TC_ENTRIES_END(tc);
334
335   /*
336    * zero ourselves and add us to the candidate tree.
337    */
338   olsr_change_myself_tc();
339   tc_myself->path_etx = ZERO_ETX;
340   olsr_spf_add_cand_tree(&cand_tree, tc_myself);
341
342   /*
343    * add edges to and from our neighbours.
344    */
345   for (i = 0; i < HASHSIZE; i++)
346     for (neigh = neighbortable[i].next; neigh != &neighbortable[i];
347          neigh = neigh->next) {
348
349       if (neigh->status == SYM) {
350
351         tc_edge = olsr_lookup_tc_edge(tc_myself, &neigh->neighbor_main_addr);
352         link = get_best_link_to_neighbor(&neigh->neighbor_main_addr);
353         if (!link) {
354
355           /*
356            * If there is no best link to this neighbor
357            * and we had an edge before then flush the edge.
358            */
359           if (tc_edge) {
360             olsr_delete_tc_edge_entry(tc_edge);
361           }
362           continue;
363         }
364
365         /*
366          * Set the next-hops of our neighbors. 
367          */
368         if (!tc_edge) {
369           tc_edge = olsr_add_tc_edge_entry(tc_myself, &neigh->neighbor_main_addr,
370                                            0, link->last_htime,
371                                            link->loss_link_quality2,
372                                            link->neigh_link_quality2);
373         } else {
374           tc_edge->link_quality = link->loss_link_quality2;
375           tc_edge->inverse_link_quality = link->neigh_link_quality2;
376           olsr_calc_tc_edge_entry_etx(tc_edge);
377         }
378         if (tc_edge->edge_inv) {
379           tc_edge->edge_inv->tc->next_hop = link;
380         }
381       }
382     }
383
384 #ifdef SPF_PROFILING
385   gettimeofday(&t2, NULL);
386 #endif
387
388   /*
389    * Run the SPF calculation.
390    */
391   olsr_spf_run_full(&cand_tree, &path_list, &path_count);
392
393   OLSR_PRINTF(2, "\n--- %02d:%02d:%02d.%02d ------------------------------------------------- DIJKSTRA\n\n",
394               nowtm->tm_hour,
395               nowtm->tm_min,
396               nowtm->tm_sec,
397               (int)now.tv_usec/10000);
398
399 #ifdef SPF_PROFILING
400   gettimeofday(&t3, NULL);
401 #endif
402
403   /*
404    * In the path tree we have all the reachable nodes in our topology.
405    */
406   for (; !list_is_empty(&path_list); list_remove(path_list.next)) {
407
408     vert = path_list.next->data;
409     link = vert->next_hop;
410
411     if (!link) {
412       OLSR_PRINTF(2, "%s no next-hop\n", olsr_ip_to_string(&vert->addr));
413       continue;
414     }
415
416     /* find the interface for the found link */
417     inter = link->if_name ? if_ifwithname(link->if_name)
418       : if_ifwithaddr(&link->local_iface_addr);
419
420     /* interface is up ? */
421     if (inter) {
422
423       /* add a route to the main address of the destination node */
424       olsr_insert_routing_table(&vert->addr, olsr_cnf->maxplen, &vert->addr,
425                                 &link->neighbor_iface_addr, inter->if_index,
426                                 vert->hops, vert->path_etx);
427
428       /* add routes to the remaining interfaces of the destination node */
429       for (mid_walker = mid_lookup_aliases(&vert->addr);
430            mid_walker != NULL;
431            mid_walker = mid_walker->next_alias) {
432
433         olsr_insert_routing_table(&mid_walker->alias, olsr_cnf->maxplen, &vert->addr,
434                                   &link->neighbor_iface_addr, inter->if_index,
435                                   vert->hops, vert->path_etx);
436       }
437
438       /* find the node's HNAs */
439       hna_gw = olsr_lookup_hna_gw(&vert->addr);
440
441       /* node doesn't announce any HNAs */
442       if (!hna_gw) {
443         continue;
444       }
445
446       /* loop through the node's HNAs */
447       for (hna = hna_gw->networks.next;
448            hna != &hna_gw->networks;
449            hna = hna->next) {
450
451         plen = olsr_get_hna_prefix_len(hna);
452         if (vert->path_etx != INFINITE_ETX)
453         olsr_insert_routing_table(&hna->A_network_addr, plen, &vert->addr,
454                                   &link->neighbor_iface_addr, inter->if_index,
455                                   vert->hops, vert->path_etx);
456       }
457     }
458   }
459
460 #ifdef SPF_PROFILING
461   gettimeofday(&t4, NULL);
462 #endif
463
464   /* move the route changes into the kernel */
465
466   olsr_update_kernel_routes();
467
468 #ifdef SPF_PROFILING
469   gettimeofday(&t5, NULL);
470 #endif
471
472 #ifdef SPF_PROFILING
473   timersub(&t2, &t1, &spf_init);
474   timersub(&t3, &t2, &spf_run);
475   timersub(&t4, &t3, &route);
476   timersub(&t5, &t4, &kernel);
477   timersub(&t5, &t1, &total);
478   olsr_printf(1, "\n--- SPF-stats for %d nodes, %d routes (total/init/run/route/kern): "
479               "%d, %d, %d, %d, %d\n",
480               path_count, routingtree.count,
481               (int)total.tv_usec, (int)spf_init.tv_usec, (int)spf_run.tv_usec,
482               (int)route.tv_usec, (int)kernel.tv_usec);
483 #endif
484 }
485
486 /*
487  * Local Variables:
488  * c-basic-offset: 2
489  * End:
490  */