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