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.64 2007/12/12 23:38:52 bernd67 Exp $
  42  */
  43
  44 #define SPF_PROFILING 0
  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 *tc)
  92 {
  93 #if !defined(NODEBUG) && defined(DEBUG)
  94   struct ipaddr_str buf;
  95 #endif
  96   tc->cand_tree_node.key = &tc->path_etx;
  97   tc->cand_tree_node.data = tc;
  98
  99 #ifdef DEBUG
 100   OLSR_PRINTF(1, "SPF: insert candidate %s, cost %f\n",
 101               olsr_ip_to_string(&buf, &tc->addr),
 102               tc->path_etx);
 103 #endif
 104
 105   avl_insert(tree, &tc->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 *tc)
 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, &tc->addr),
 124               tc->path_etx);
 125 #endif
 126
 127   avl_delete(tree, &tc->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, int *path_count,
 137                         struct tc_entry *tc)
 138 {
 139 #if !defined(NODEBUG) && defined(DEBUG)
 140   struct ipaddr_str pathbuf, nbuf;
 141 #endif
 142   tc->path_list_node.data = tc;
 143
 144 #ifdef DEBUG
 145   OLSR_PRINTF(1, "SPF: append path %s, cost %f, via %s\n",
 146               olsr_ip_to_string(&pathbuf, &tc->addr),
 147               tc->path_etx,
 148               tc->next_hop ? olsr_ip_to_string(&nbuf, &tc->next_hop->neighbor_iface_addr) : "-");
 149 #endif
 150
 151   list_add_before(head, &tc->path_list_node);
 152   *path_count = *path_count + 1;
 153 }
 154
 155 /*
 156  * olsr_spf_extract_best
 157  *
 158  * return the node with the minimum pathcost.
 159  */
 160 static struct tc_entry *
 161 olsr_spf_extract_best (struct avl_tree *tree)
 162 {
 163   struct avl_node *node = avl_walk_first(tree);
 164
 165   return (node ? node->data :  NULL);
 166 }
 167
 168
 169 const char *olsr_etx_to_string(float etx)
 170 {
 171   static char buff[20];
 172
 173   if (etx == INFINITE_ETX) {
 174     return "INF";
 175   }
 176   snprintf(buff, sizeof(buff), "%.6f", etx);
 177   return buff;
 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   float new_etx;
 193
 194 #ifdef DEBUG
 195 #ifndef NODEBUG
 196   struct ipaddr_str buf, nbuf;
 197 #endif
 198   OLSR_PRINTF(1, "SPF: exploring node %s, cost %f\n",
 199               olsr_ip_to_string(&buf, &tc->addr),
 200               tc->path_etx);
 201 #endif
 202
 203   /*
 204    * loop through all edges of this vertex.
 205    */
 206   for (edge_node = avl_walk_first(&tc->edge_tree);
 207        edge_node;
 208        edge_node = avl_walk_next(edge_node)) {
 209
 210     struct tc_entry *new_tc;
 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 = tc->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_tc = tc_edge->edge_inv->tc;
 247
 248     if (new_etx < new_tc->path_etx) {
 249
 250       /* if this node has been on the candidate tree delete it */
 251       if (new_tc->path_etx != INFINITE_ETX) {
 252         olsr_spf_del_cand_tree(cand_tree, new_tc);
 253       }
 254
 255       /* re-insert on candidate tree with the better metric */
 256       new_tc->path_etx = new_etx;
 257       olsr_spf_add_cand_tree(cand_tree, new_tc);
 258
 259       /* pull-up the next-hop and bump the hop count */
 260       if (tc->next_hop) {
 261         new_tc->next_hop = tc->next_hop;
 262       }
 263       new_tc->hops = tc->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_tc->addr),
 268                   olsr_etx_to_string(new_tc->path_etx),
 269                   olsr_etx_to_string(new_etx),
 270                   tc->next_hop ? olsr_ip_to_string(&nbuf, &tc->next_hop->neighbor_iface_addr) : "<none>",
 271                   new_tc->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 *tc;
 295
 296   *path_count = 0;
 297
 298   while ((tc = olsr_spf_extract_best(cand_tree))) {
 299
 300     olsr_spf_relax(cand_tree, tc);
 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, tc);
 307     olsr_spf_add_path_list(path_list, path_count, tc);
 308   }
 309 }
 310
 311 void
 312 olsr_calculate_routing_table (void)
 313 {
 314 #if !defined(NODEBUG) && defined(DEBUG)
 315   struct ipaddr_str buf;
 316 #endif
 317
 318   struct avl_tree cand_tree;
 319   struct avl_node *rtp_tree_node;
 320   struct list_node path_list; /* head of the path_list */
 321   int i, path_count = 0;
 322   struct tc_entry *tc;
 323   struct rt_path *rtp;
 324   struct tc_edge_entry *tc_edge;
 325   struct neighbor_entry *neigh;
 326   struct link_entry *link;
 327
 328 #ifdef SPF_PROFILING
 329   struct timeval t1, t2, t3, t4, t5, spf_init, spf_run, route, kernel, total;
 330
 331   gettimeofday(&t1, NULL);
 332 #endif
 333
 334   /*
 335    * Prepare the candidate tree and result list.
 336    */
 337   avl_init(&cand_tree, avl_comp_etx);
 338   list_head_init(&path_list);
 339   olsr_bump_routingtree_version();
 340
 341   /*
 342    * Initialize vertices in the lsdb.
 343    */
 344   OLSR_FOR_ALL_TC_ENTRIES(tc) {
 345     tc->next_hop = NULL;
 346     tc->path_etx = INFINITE_ETX;
 347     tc->hops = 0;
 348   } OLSR_FOR_ALL_TC_ENTRIES_END(tc);
 349
 350   /*
 351    * zero ourselves and add us to the candidate tree.
 352    */
 353   olsr_change_myself_tc();
 354   tc_myself->path_etx = ZERO_ETX;
 355   olsr_spf_add_cand_tree(&cand_tree, tc_myself);
 356
 357   /*
 358    * add edges to and from our neighbours.
 359    */
 360   for (i = 0; i < HASHSIZE; i++)
 361     for (neigh = neighbortable[i].next; neigh != &neighbortable[i];
 362          neigh = neigh->next) {
 363
 364       if (neigh->status == SYM) {
 365
 366         tc_edge = olsr_lookup_tc_edge(tc_myself, &neigh->neighbor_main_addr);
 367         link = get_best_link_to_neighbor(&neigh->neighbor_main_addr);
 368         if (!link) {
 369
 370           /*
 371            * If there is no best link to this neighbor
 372            * and we had an edge before then flush the edge.
 373            */
 374           if (tc_edge) {
 375             olsr_delete_tc_edge_entry(tc_edge);
 376           }
 377           continue;
 378         }
 379
 380         /* find the interface for the link */
 381         if (link->if_name) {
 382           link->inter = if_ifwithname(link->if_name);
 383         } else {
 384           link->inter = if_ifwithaddr(&link->local_iface_addr);
 385         }
 386
 387         /*
 388          * Set the next-hops of our neighbors.
 389          */
 390         if (!tc_edge) {
 391           tc_edge = olsr_add_tc_edge_entry(tc_myself, &neigh->neighbor_main_addr,
 392                                            0, link->vtime,
 393                                            link->loss_link_quality2,
 394                                            link->neigh_link_quality2);
 395         } else {
 396
 397           /*
 398            * Update LQ and timers, such that the edge does not get deleted.
 399            */
 400           tc_edge->link_quality = link->loss_link_quality2;
 401           tc_edge->inverse_link_quality = link->neigh_link_quality2;
 402           olsr_set_tc_edge_timer(tc_edge, link->vtime*1000);
 403           olsr_calc_tc_edge_entry_etx(tc_edge);
 404         }
 405         if (tc_edge->edge_inv) {
 406           tc_edge->edge_inv->tc->next_hop = link;
 407         }
 408       }
 409     }
 410
 411 #ifdef SPF_PROFILING
 412   gettimeofday(&t2, NULL);
 413 #endif
 414
 415   /*
 416    * Run the SPF calculation.
 417    */
 418   olsr_spf_run_full(&cand_tree, &path_list, &path_count);
 419
 420   OLSR_PRINTF(2, "\n--- %02d:%02d:%02d.%02d ------------------------------------------------- DIJKSTRA\n\n",
 421               nowtm->tm_hour,
 422               nowtm->tm_min,
 423               nowtm->tm_sec,
 424               (int)now.tv_usec/10000);
 425
 426 #ifdef SPF_PROFILING
 427   gettimeofday(&t3, NULL);
 428 #endif
 429
 430   /*
 431    * In the path list we have all the reachable nodes in our topology.
 432    */
 433   for (; !list_is_empty(&path_list); list_remove(path_list.next)) {
 434
 435     tc = path_list.next->data;
 436     link = tc->next_hop;
 437
 438     if (!link) {
 439
 440       /*
 441        * Supress the error msg when our own tc_entry
 442        * does not contain a next-hop.
 443        */
 444       if (tc != tc_myself) {
 445 #if !defined(NODEBUG)
 446         struct ipaddr_str buf;
 447 #endif
 448         OLSR_PRINTF(1, "SPF: %s no next-hop\n", olsr_ip_to_string(&buf, &tc->addr));
 449       }
 450       continue;
 451     }
 452
 453     /*
 454      * Now walk all prefixes advertised by that node.
 455      * Since the node is reachable, insert the prefix into the global RIB.
 456      * If the prefix is already in the RIB, refresh the entry such
 457      * that olsr_delete_outdated_routes() does not purge it off.
 458      */
 459     for (rtp_tree_node = avl_walk_first(&tc->prefix_tree);
 460          rtp_tree_node;
 461          rtp_tree_node = avl_walk_next(rtp_tree_node)) {
 462
 463       rtp = rtp_tree_node->data;
 464
 465       if (rtp->rtp_rt) {
 466
 467         /*
 468          * If there is a route entry, the prefix is already in the global RIB.
 469          */
 470         olsr_update_rt_path(rtp, tc, link);
 471
 472       } else {
 473
 474         /*
 475          * The prefix is reachable and not yet in the global RIB.
 476          * Build a rt_entry for it.
 477          */
 478         olsr_insert_rt_path(rtp, tc, link);
 479       }
 480     }
 481   }
 482
 483   /* Update the RIB based on the new SPF results */
 484
 485   olsr_update_rib_routes();
 486
 487 #ifdef SPF_PROFILING
 488   gettimeofday(&t4, NULL);
 489 #endif
 490
 491   /* move the route changes into the kernel */
 492
 493   olsr_update_kernel_routes();
 494
 495 #ifdef SPF_PROFILING
 496   gettimeofday(&t5, NULL);
 497 #endif
 498
 499 #ifdef SPF_PROFILING
 500   timersub(&t2, &t1, &spf_init);
 501   timersub(&t3, &t2, &spf_run);
 502   timersub(&t4, &t3, &route);
 503   timersub(&t5, &t4, &kernel);
 504   timersub(&t5, &t1, &total);
 505   OLSR_PRINTF(1, "\n--- SPF-stats for %d nodes, %d routes (total/init/run/route/kern): "
 506               "%d, %d, %d, %d, %d\n",
 507               path_count, routingtree.count,
 508               (int)total.tv_usec, (int)spf_init.tv_usec, (int)spf_run.tv_usec,
 509               (int)route.tv_usec, (int)kernel.tv_usec);
 510 #endif
 511 }
 512
 513 /*
 514  * Local Variables:
 515  * c-basic-offset: 2
 516  * End:
 517  */