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