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