src/link_set.c

   1
   2 /*
   3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
   4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * * Redistributions of source code must retain the above copyright
  12  *   notice, this list of conditions and the following disclaimer.
  13  * * Redistributions in binary form must reproduce the above copyright
  14  *   notice, this list of conditions and the following disclaimer in
  15  *   the documentation and/or other materials provided with the
  16  *   distribution.
  17  * * Neither the name of olsr.org, olsrd nor the names of its
  18  *   contributors may be used to endorse or promote products derived
  19  *   from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * Visit http://www.olsr.org for more information.
  35  *
  36  * If you find this software useful feel free to make a donation
  37  * to the project. For more information see the website or contact
  38  * the copyright holders.
  39  *
  40  */
  41
  42 /*
  43  * Link sensing database for the OLSR routing daemon
  44  */
  45 #include <assert.h>
  46
  47 #include "defs.h"
  48 #include "link_set.h"
  49 #include "hysteresis.h"
  50 #include "mid_set.h"
  51 #include "mpr.h"
  52 #include "neighbor_table.h"
  53 #include "olsr.h"
  54 #include "log.h"
  55 #include "scheduler.h"
  56 #include "olsr_spf.h"
  57 #include "net_olsr.h"
  58 #include "ipcalc.h"
  59 #include "lq_plugin.h"
  60
  61 /* head node for all link sets */
  62 struct list_node link_entry_head;
  63
  64 bool link_changes = false; /* is set if changes occur in MPRS set */
  65
  66 void
  67 signal_link_changes(bool val)
  68 {                               /* XXX ugly */
  69   link_changes = val;
  70 }
  71
  72 /* Prototypes. */
  73 static int check_link_status(const struct hello_message *message, const struct interface_olsr *in_if);
  74 static struct link_entry *add_link_entry(const union olsr_ip_addr *, const union olsr_ip_addr *, const union olsr_ip_addr *,
  75                                          olsr_reltime, olsr_reltime, const struct interface_olsr *);
  76 static int get_neighbor_status(const union olsr_ip_addr *);
  77 static void olsr_expire_link_sym_timer(void *context);
  78
  79 void
  80 olsr_init_link_set(void)
  81 {
  82
  83   /* Init list head */
  84   list_head_init(&link_entry_head);
  85 }
  86
  87 /**
  88  * This function resets all links to lost, so that
  89  * a final "lost all links" hello can be generated to
  90  * tell your neighbors that you are gone now.
  91  */
  92 void olsr_reset_all_links(void) {
  93   struct link_entry *link;
  94
  95   OLSR_FOR_ALL_LINK_ENTRIES(link) {
  96     link->ASYM_time = now_times-1;
  97
  98     olsr_stop_timer(link->link_sym_timer);
  99     link->link_sym_timer = NULL;
 100
 101     link->neighbor->is_mpr = false;
 102     link->neighbor->status = NOT_SYM;
 103   } OLSR_FOR_ALL_LINK_ENTRIES_END(link)
 104
 105
 106   OLSR_FOR_ALL_LINK_ENTRIES(link) {
 107     olsr_expire_link_sym_timer(link);
 108     olsr_clear_hello_lq(link);
 109   } OLSR_FOR_ALL_LINK_ENTRIES_END(link)
 110 }
 111
 112 /**
 113  * Get the status of a link. The status is based upon different
 114  * timeouts in the link entry.
 115  *
 116  * @param entry link entry
 117  * @return the link status of the link
 118  */
 119 int
 120 lookup_link_status(const struct link_entry *entry)
 121 {
 122
 123   if (entry == NULL || list_is_empty(&link_entry_head)) {
 124     return UNSPEC_LINK;
 125   }
 126
 127   /*
 128    * Hysteresis
 129    */
 130   if (olsr_cnf->use_hysteresis) {
 131
 132     /*
 133      * if L_LOST_LINK_time is not expired, the link is advertised
 134      * with a link type of LOST_LINK.
 135      */
 136
 137     if (!TIMED_OUT(entry->L_LOST_LINK_time)) {
 138       return LOST_LINK;
 139     }
 140
 141     /*
 142      * otherwise, if L_LOST_LINK_time is expired and L_link_pending
 143      * is set to "true", the link SHOULD NOT be advertised at all;
 144      */
 145     if (entry->L_link_pending == 1) {
 146 #ifndef NODEBUG
 147       struct ipaddr_str buf;
 148       OLSR_PRINTF(3, "HYST[%s]: Setting to HIDE\n", olsr_ip_to_string(&buf, &entry->neighbor_iface_addr));
 149 #endif /* NODEBUG */
 150       return HIDE_LINK;
 151     }
 152
 153     /*
 154      * otherwise, if L_LOST_LINK_time is expired and L_link_pending
 155      * is set to "false", the link is advertised as described
 156      * previously in section 6.
 157      */
 158   }
 159
 160   if (entry->link_sym_timer) {
 161     return SYM_LINK;
 162   }
 163
 164   if (!TIMED_OUT(entry->ASYM_time)) {
 165     return ASYM_LINK;
 166   }
 167
 168   return LOST_LINK;
 169 }
 170
 171 /**
 172  * Find the "best" link status to a neighbor
 173  *
 174  * @param address the address to check for
 175  * @return SYM_LINK if a symmetric link exists 0 if not
 176  */
 177 static int
 178 get_neighbor_status(const union olsr_ip_addr *address)
 179 {
 180   const union olsr_ip_addr *main_addr;
 181   struct interface_olsr *ifs;
 182
 183   /* Find main address */
 184   if (!(main_addr = mid_lookup_main_addr(address)))
 185     main_addr = address;
 186
 187   /* Loop trough local interfaces to check all possebilities */
 188   for (ifs = ifnet; ifs != NULL; ifs = ifs->int_next) {
 189     struct mid_address *aliases;
 190     struct link_entry *lnk = lookup_link_entry(main_addr, NULL, ifs);
 191
 192     if (lnk != NULL) {
 193       if (lookup_link_status(lnk) == SYM_LINK)
 194         return SYM_LINK;
 195     }
 196
 197     /* Get aliases */
 198     for (aliases = mid_lookup_aliases(main_addr); aliases != NULL; aliases = aliases->next_alias) {
 199
 200       lnk = lookup_link_entry(&aliases->alias, NULL, ifs);
 201       if (lnk && (lookup_link_status(lnk) == SYM_LINK)) {
 202         return SYM_LINK;
 203       }
 204     }
 205   }
 206
 207   return 0;
 208 }
 209
 210 /**
 211  * Find best link to a neighbor
 212  */
 213 struct link_entry *
 214 get_best_link_to_neighbor(const union olsr_ip_addr *remote)
 215 {
 216   const union olsr_ip_addr *main_addr;
 217   struct link_entry *walker, *good_link, *backup_link;
 218   struct interface_olsr *tmp_if;
 219   int curr_metric = MAX_IF_METRIC;
 220   olsr_linkcost curr_lcost = LINK_COST_BROKEN;
 221   olsr_linkcost tmp_lc;
 222
 223   /* main address lookup */
 224   main_addr = mid_lookup_main_addr(remote);
 225
 226   /* "remote" *already is* the main address */
 227   if (!main_addr) {
 228     main_addr = remote;
 229   }
 230
 231   /* we haven't selected any links, yet */
 232   good_link = NULL;
 233   backup_link = NULL;
 234
 235   /* loop through all links that we have */
 236   OLSR_FOR_ALL_LINK_ENTRIES(walker) {
 237
 238     /* if this is not a link to the neighour in question, skip */
 239     if (!ipequal(&walker->neighbor->neighbor_main_addr, main_addr))
 240       continue;
 241
 242     if (olsr_cnf->lq_level == 0) {
 243
 244       /*
 245        * handle the non-LQ, RFC-compliant case
 246        */
 247
 248       /*
 249        * find the interface for the link.
 250        * we select the link with the best local interface metric.
 251        */
 252       tmp_if = walker->if_name ? if_ifwithname(walker->if_name) : if_ifwithaddr(&walker->local_iface_addr);
 253
 254       if (!tmp_if) {
 255         continue;
 256       }
 257
 258       /*
 259        * is this interface better than anything we had before ?
 260        * use the requested remote interface address as a tie-breaker
 261        */
 262       if ((tmp_if->int_metric < curr_metric) || ((tmp_if->int_metric == curr_metric) && ipequal(&walker->local_iface_addr, remote))) {
 263
 264         /* memorize the interface's metric */
 265         curr_metric = tmp_if->int_metric;
 266
 267         /* prefer symmetric links over asymmetric links */
 268         if (lookup_link_status(walker) == SYM_LINK) {
 269           good_link = walker;
 270         } else {
 271           backup_link = walker;
 272         }
 273       }
 274     } else {
 275
 276       /*
 277        * handle the LQ, non-RFC compliant case.
 278        */
 279
 280       /* get the link cost */
 281       tmp_lc = walker->linkcost;
 282
 283       /*
 284        * is this link better than anything we had before ?
 285        * use the requested remote interface address as a tie-breaker.
 286        */
 287       if ((tmp_lc < curr_lcost) || ((tmp_lc == curr_lcost) && ipequal(&walker->local_iface_addr, remote))) {
 288
 289         /* memorize the link quality */
 290         curr_lcost = tmp_lc;
 291
 292         /* prefer symmetric links over asymmetric links */
 293         if (lookup_link_status(walker) == SYM_LINK) {
 294           good_link = walker;
 295         } else {
 296           backup_link = walker;
 297         }
 298       }
 299     }
 300   }
 301   OLSR_FOR_ALL_LINK_ENTRIES_END(walker);
 302
 303   /*
 304    * if we haven't found any symmetric links, try to return an asymmetric link.
 305    */
 306   return good_link ? good_link : backup_link;
 307 }
 308
 309 static void
 310 set_loss_link_multiplier(struct link_entry *entry)
 311 {
 312   struct interface_olsr *inter;
 313   struct olsr_if *cfg_inter;
 314   struct olsr_lq_mult *mult;
 315   uint32_t val = 0;
 316   union olsr_ip_addr null_addr;
 317   struct ipaddr_str buf;
 318
 319   /* find the interface for the link */
 320   assert(entry->if_name);
 321   inter = if_ifwithname(entry->if_name);
 322
 323   /* find the interface configuration for the interface */
 324   for (cfg_inter = olsr_cnf->interfaces; cfg_inter; cfg_inter = cfg_inter->next) {
 325     if (cfg_inter->interf == inter) {
 326       break;
 327     }
 328   }
 329   assert(cfg_inter);
 330
 331   /* create a null address for comparison */
 332   memset(&null_addr, 0, sizeof(union olsr_ip_addr));
 333
 334   /* loop through the multiplier entries */
 335   for (mult = cfg_inter->cnf->lq_mult; mult != NULL; mult = mult->next) {
 336
 337     /*
 338      * use the default multiplier only if there isn't any entry that
 339      * has a matching IP address.
 340      */
 341     if ((ipequal(&mult->addr, &null_addr) && val == 0) || ipequal(&mult->addr, &entry->neighbor_iface_addr)) {
 342       val = mult->value;
 343     }
 344   }
 345
 346   /* if we have not found an entry, then use the default multiplier */
 347   if (val == 0) {
 348     val = LINK_LOSS_MULTIPLIER;
 349   }
 350
 351   /* store the multiplier */
 352   entry->loss_link_multiplier = val;
 353
 354   OLSR_PRINTF(1, "Set linkloss multiplier for %s on %s to %d\n",
 355       olsr_ip_to_string(&buf, &entry->neighbor_iface_addr), cfg_inter->name, val);
 356 }
 357
 358 /*
 359  * Delete, unlink and free a link entry.
 360  */
 361 static void
 362 olsr_delete_link_entry(struct link_entry *link)
 363 {
 364   struct tc_edge_entry *tc_edge;
 365
 366   /* delete tc edges we made for SPF */
 367   tc_edge = olsr_lookup_tc_edge(tc_myself, &link->neighbor_iface_addr);
 368   if (tc_edge != NULL) {
 369     olsr_delete_tc_edge_entry(tc_edge);
 370   }
 371
 372
 373   /* Delete neighbor entry */
 374   if (link->neighbor->linkcount == 1) {
 375     olsr_delete_neighbor_table(&link->neighbor->neighbor_main_addr);
 376   } else {
 377     link->neighbor->linkcount--;
 378   }
 379
 380   /* Kill running timers */
 381   olsr_stop_timer(link->link_timer);
 382   link->link_timer = NULL;
 383   olsr_stop_timer(link->link_sym_timer);
 384   link->link_sym_timer = NULL;
 385   olsr_stop_timer(link->link_hello_timer);
 386   link->link_hello_timer = NULL;
 387   olsr_stop_timer(link->link_loss_timer);
 388   link->link_loss_timer = NULL;
 389   list_remove(&link->link_list);
 390
 391   free(link->if_name);
 392   free(link);
 393
 394   changes_neighborhood = true;
 395 }
 396
 397 /**
 398  * Delete all link entries matching a given interface address.
 399  */
 400 void
 401 olsr_delete_link_entry_by_ip(const union olsr_ip_addr *int_addr)
 402 {
 403   struct link_entry *link;
 404
 405   if (list_is_empty(&link_entry_head)) {
 406     return;
 407   }
 408
 409   OLSR_FOR_ALL_LINK_ENTRIES(link) {
 410     if (ipequal(int_addr, &link->local_iface_addr)) {
 411       olsr_delete_link_entry(link);
 412     }
 413   }
 414   OLSR_FOR_ALL_LINK_ENTRIES_END(link);
 415 }
 416
 417
 418 /**
 419  * Callback for the link loss timer.
 420  */
 421 static void
 422 olsr_expire_link_loss_timer(void *context)
 423 {
 424   struct link_entry *link;
 425
 426   link = (struct link_entry *)context;
 427
 428   /* count the lost packet */
 429   olsr_update_packet_loss_worker(link, true);
 430
 431   /* next timeout in 1.0 x htime */
 432   olsr_change_timer(link->link_loss_timer, link->loss_helloint, OLSR_LINK_LOSS_JITTER, OLSR_TIMER_PERIODIC);
 433 }
 434
 435
 436 /**
 437  * Callback for the link SYM timer.
 438  */
 439 static void
 440 olsr_expire_link_sym_timer(void *context)
 441 {
 442   struct link_entry *link;
 443
 444   link = (struct link_entry *)context;
 445   link->link_sym_timer = NULL;  /* be pedandic */
 446
 447   if (link->prev_status != SYM_LINK) {
 448     return;
 449   }
 450
 451   link->prev_status = lookup_link_status(link);
 452   update_neighbor_status(link->neighbor, get_neighbor_status(&link->neighbor_iface_addr));
 453   changes_neighborhood = true;
 454 }
 455
 456 /**
 457  * Callback for the link_hello timer.
 458  */
 459 void
 460 olsr_expire_link_hello_timer(void *context)
 461 {
 462   struct ipaddr_str buf;
 463   struct link_entry *link;
 464
 465   link = (struct link_entry *)context;
 466
 467   link->L_link_quality = olsr_hyst_calc_instability(link->L_link_quality);
 468
 469   OLSR_PRINTF(1, "HYST[%s] HELLO timeout %f\n", olsr_ip_to_string(&buf, &link->neighbor_iface_addr), (double)link->L_link_quality);
 470
 471   /* Update hello_timeout - NO SLACK THIS TIME */
 472   olsr_change_timer(link->link_hello_timer, link->last_htime, OLSR_LINK_JITTER, OLSR_TIMER_PERIODIC);
 473
 474   /* Update hysteresis values */
 475   olsr_process_hysteresis(link);
 476
 477   /* update neighbor status */
 478   update_neighbor_status(link->neighbor, get_neighbor_status(&link->neighbor_iface_addr));
 479
 480   /* Update seqno - not mentioned in the RFC... kind of a hack.. */
 481   link->olsr_seqno++;
 482 }
 483
 484 /**
 485  * Callback for the link timer.
 486  */
 487 static void
 488 olsr_expire_link_entry(void *context)
 489 {
 490   struct link_entry *link;
 491
 492   link = (struct link_entry *)context;
 493   link->link_timer = NULL;      /* be pedandic */
 494
 495   olsr_delete_link_entry(link);
 496 }
 497
 498 /**
 499  * Set the link expiration timer.
 500  */
 501 void
 502 olsr_set_link_timer(struct link_entry *link, unsigned int rel_timer)
 503 {
 504   struct ipaddr_str buf;
 505
 506   OLSR_PRINTF(3, "reset link timer: %s = %u\n",
 507     olsr_ip_to_string(&buf, &link->neighbor_iface_addr),
 508     (unsigned int)(now_times + rel_timer/1000));
 509   olsr_set_timer(&link->link_timer, rel_timer, OLSR_LINK_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_link_entry, link, 0);
 510 }
 511
 512 /**
 513  * Nothing mysterious here.
 514  * Adding a new link entry to the link set.
 515  *
 516  * @param local the local IP address
 517  * @param remote the remote IP address
 518  * @param remote_main the remote nodes main address
 519  * @param vtime the validity time of the entry
 520  * @param htime the HELLO interval of the remote node
 521  * @param local_if the local interface
 522  * @return the new link_entry
 523  */
 524 static struct link_entry *
 525 add_link_entry(const union olsr_ip_addr *local, const union olsr_ip_addr *remote, const union olsr_ip_addr *remote_main,
 526                olsr_reltime vtime, olsr_reltime htime, const struct interface_olsr *local_if)
 527 {
 528   struct link_entry *new_link;
 529   struct neighbor_entry *neighbor;
 530   struct link_entry *tmp_link_set;
 531
 532   tmp_link_set = lookup_link_entry(remote, remote_main, local_if);
 533   if (tmp_link_set) {
 534     return tmp_link_set;
 535   }
 536
 537   /*
 538    * if there exists no link tuple with
 539    * L_neighbor_iface_addr == Source Address
 540    */
 541
 542 #ifdef DEBUG
 543   {
 544     struct ipaddr_str localbuf, rembuf;
 545     OLSR_PRINTF(1, "Adding %s=>%s to link set\n", olsr_ip_to_string(&localbuf, local), olsr_ip_to_string(&rembuf, remote));
 546   }
 547 #endif /* DEBUG */
 548
 549   /* a new tuple is created with... */
 550   new_link = olsr_malloc_link_entry("new link entry");
 551
 552   /* copy if_name, if it is defined */
 553   if (local_if->int_name) {
 554     size_t name_size = strlen(local_if->int_name) + 1;
 555     new_link->if_name = olsr_malloc(name_size, "target of if_name in new link entry");
 556     strscpy(new_link->if_name, local_if->int_name, name_size);
 557   } else
 558     new_link->if_name = NULL;
 559
 560   /* shortcut to interface. XXX refcount */
 561   new_link->inter = local_if;
 562
 563   /*
 564    * L_local_iface_addr = Address of the interface
 565    * which received the HELLO message
 566    */
 567   new_link->local_iface_addr = *local;
 568
 569   /* L_neighbor_iface_addr = Source Address */
 570   new_link->neighbor_iface_addr = *remote;
 571
 572   /* L_time = current time + validity time */
 573   olsr_set_link_timer(new_link, vtime);
 574
 575   new_link->prev_status = ASYM_LINK;
 576
 577   /* HYSTERESIS */
 578   if (olsr_cnf->use_hysteresis) {
 579     new_link->L_link_pending = 1;
 580     new_link->L_LOST_LINK_time = GET_TIMESTAMP(vtime);
 581     olsr_update_hysteresis_hello(new_link, htime);
 582     new_link->last_htime = htime;
 583     new_link->olsr_seqno = 0;
 584     new_link->olsr_seqno_valid = false;
 585   }
 586
 587   new_link->L_link_quality = 0.0;
 588
 589   if (olsr_cnf->lq_level > 0) {
 590     new_link->loss_helloint = htime;
 591
 592     olsr_set_timer(&new_link->link_loss_timer, htime + htime / 2, OLSR_LINK_LOSS_JITTER, OLSR_TIMER_PERIODIC,
 593                    &olsr_expire_link_loss_timer, new_link, 0);
 594
 595     set_loss_link_multiplier(new_link);
 596   }
 597
 598   new_link->linkcost = LINK_COST_BROKEN;
 599
 600   /* Add to queue */
 601   list_add_before(&link_entry_head, &new_link->link_list);
 602
 603   /*
 604    * Create the neighbor entry
 605    */
 606
 607   /* Neighbor MUST exist! */
 608   neighbor = olsr_lookup_neighbor_table(remote_main);
 609   if (!neighbor) {
 610 #ifdef DEBUG
 611     struct ipaddr_str buf;
 612     OLSR_PRINTF(3, "ADDING NEW NEIGHBOR ENTRY %s FROM LINK SET\n", olsr_ip_to_string(&buf, remote_main));
 613 #endif /* DEBUG */
 614     neighbor = olsr_insert_neighbor_table(remote_main);
 615   }
 616
 617   neighbor->linkcount++;
 618   new_link->neighbor = neighbor;
 619
 620   return new_link;
 621 }
 622
 623 /**
 624  * Lookup the status of a link.
 625  *
 626  * @param int_addr address of the remote interface
 627  * @return 1 of the link is symmertic 0 if not
 628  */
 629 int
 630 check_neighbor_link(const union olsr_ip_addr *int_addr)
 631 {
 632   struct link_entry *link;
 633
 634   OLSR_FOR_ALL_LINK_ENTRIES(link) {
 635     if (ipequal(int_addr, &link->neighbor_iface_addr)) {
 636       return lookup_link_status(link);
 637     }
 638   }
 639   OLSR_FOR_ALL_LINK_ENTRIES_END(link);
 640
 641   return UNSPEC_LINK;
 642 }
 643
 644 /**
 645  * Lookup a link entry
 646  *
 647  * @param remote the remote interface address
 648  * @param remote_main the remote nodes main address
 649  * @param local the local interface address
 650  * @return the link entry if found, NULL if not
 651  */
 652 struct link_entry *
 653 lookup_link_entry(const union olsr_ip_addr *remote, const union olsr_ip_addr *remote_main, const struct interface_olsr *local)
 654 {
 655   struct link_entry *link;
 656
 657   OLSR_FOR_ALL_LINK_ENTRIES(link) {
 658     if (ipequal(remote, &link->neighbor_iface_addr)
 659         && (link->if_name ? !strcmp(link->if_name, local->int_name) : ipequal(&local->ip_addr, &link->local_iface_addr))) {
 660       /* check the remote-main address only if there is one given */
 661       if (NULL != remote_main && !ipequal(remote_main, &link->neighbor->neighbor_main_addr)) {
 662         /* Neighbor has changed it's main_addr, update */
 663         struct ipaddr_str oldbuf, newbuf;
 664
 665         OLSR_PRINTF(1, "Neighbor changed main_ip, updating %s -> %s\n",
 666                     olsr_ip_to_string(&oldbuf, &link->neighbor->neighbor_main_addr), olsr_ip_to_string(&newbuf, remote_main));
 667         olsr_update_neighbor_main_addr(link->neighbor, remote_main);
 668       }
 669       return link;
 670     }
 671   }
 672   OLSR_FOR_ALL_LINK_ENTRIES_END(link);
 673
 674   return NULL;
 675 }
 676
 677 /**
 678  * Update a link entry. This is the "main entrypoint" in
 679  * the link-sensing. This function is called from the HELLO
 680  * parser function. It makes sure a entry is updated or created.
 681  *
 682  * @param local the local IP address
 683  * @param remote the remote IP address
 684  * @param message the HELLO message
 685  * @param in_if the interface on which this HELLO was received
 686  * @return the link_entry struct describing this link entry
 687  */
 688 struct link_entry *
 689 update_link_entry(const union olsr_ip_addr *local, const union olsr_ip_addr *remote, const struct hello_message *message,
 690                   const struct interface_olsr *in_if)
 691 {
 692   struct link_entry *entry;
 693
 694   /* Add if not registered */
 695   entry = add_link_entry(local, remote, &message->source_addr, message->vtime, message->htime, in_if);
 696
 697   /* Update ASYM_time */
 698   entry->vtime = message->vtime;
 699   entry->ASYM_time = GET_TIMESTAMP(message->vtime);
 700
 701   entry->prev_status = check_link_status(message, in_if);
 702
 703   switch (entry->prev_status) {
 704   case (LOST_LINK):
 705     olsr_stop_timer(entry->link_sym_timer);
 706     entry->link_sym_timer = NULL;
 707     break;
 708   case (SYM_LINK):
 709   case (ASYM_LINK):
 710
 711     /* L_SYM_time = current time + validity time */
 712     olsr_set_timer(&entry->link_sym_timer, message->vtime, OLSR_LINK_SYM_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_link_sym_timer,
 713                    entry, 0);
 714
 715     /* L_time = L_SYM_time + NEIGHB_HOLD_TIME */
 716     olsr_set_link_timer(entry, message->vtime + NEIGHB_HOLD_TIME * MSEC_PER_SEC);
 717     break;
 718   default:
 719     break;
 720   }
 721
 722   /* L_time = max(L_time, L_ASYM_time) */
 723   if (entry->link_timer == NULL || (entry->link_timer->timer_clock < entry->ASYM_time)) {
 724     olsr_set_link_timer(entry, TIME_DUE(entry->ASYM_time));
 725   }
 726
 727   /* Update hysteresis values */
 728   if (olsr_cnf->use_hysteresis)
 729     olsr_process_hysteresis(entry);
 730
 731   /* Update neighbor */
 732   update_neighbor_status(entry->neighbor, get_neighbor_status(remote));
 733
 734   return entry;
 735 }
 736
 737 /**
 738  * Function that updates all registered pointers to
 739  * one neighbor entry with another pointer
 740  * Used by MID updates.
 741  *
 742  * @param old the pointer to replace
 743  * @param new the pointer to use instead of "old"
 744  * @return the number of entries updated
 745  */
 746 int
 747 replace_neighbor_link_set(const struct neighbor_entry *old, struct neighbor_entry *new)
 748 {
 749   struct link_entry *link;
 750   int retval = 0;
 751
 752   if (list_is_empty(&link_entry_head)) {
 753     return retval;
 754   }
 755
 756   OLSR_FOR_ALL_LINK_ENTRIES(link) {
 757
 758     if (link->neighbor == old) {
 759       link->neighbor = new;
 760       retval++;
 761     }
 762   }
 763   OLSR_FOR_ALL_LINK_ENTRIES_END(link);
 764
 765   return retval;
 766 }
 767
 768 /**
 769  *Checks the link status to a neighbor by
 770  *looking in a received HELLO message.
 771  *
 772  *@param message the HELLO message to check
 773  *@param in_if the incoming interface
 774  *
 775  *@return the link status
 776  */
 777 static int
 778 check_link_status(const struct hello_message *message, const struct interface_olsr *in_if)
 779 {
 780   int ret = UNSPEC_LINK;
 781   struct hello_neighbor *neighbors;
 782
 783   neighbors = message->neighbors;
 784   while (neighbors) {
 785
 786     /*
 787      * Note: If a neigh has 2 cards we can reach, the neigh
 788      * will send a Hello with the same IP mentined twice
 789      */
 790     if (ipequal(&neighbors->address, &in_if->ip_addr) &&
 791         neighbors->link != UNSPEC_LINK) {
 792       ret = neighbors->link;
 793       if (SYM_LINK == ret) {
 794         break;
 795       }
 796     }
 797     neighbors = neighbors->next;
 798   }
 799
 800   return ret;
 801 }
 802
 803 #ifndef NODEBUG
 804 void
 805 olsr_print_link_set(void)
 806 {
 807   /* The whole function makes no sense without it. */
 808   struct link_entry *walker;
 809   const int addrsize = olsr_cnf->ip_version == AF_INET ? (INET_ADDRSTRLEN - 1) : (INET6_ADDRSTRLEN - 1);
 810
 811   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- LINKS\n\n", olsr_wallclock_string());
 812   OLSR_PRINTF(1, "%-*s  %-6s %-14s %s\n", addrsize, "IP address", "hyst", "      LQ      ", "ETX");
 813
 814   OLSR_FOR_ALL_LINK_ENTRIES(walker) {
 815
 816     struct ipaddr_str buf;
 817     struct lqtextbuffer lqbuffer1, lqbuffer2;
 818     OLSR_PRINTF(1, "%-*s  %5.3f  %-14s %s\n", addrsize, olsr_ip_to_string(&buf, &walker->neighbor_iface_addr),
 819         (double)walker->L_link_quality,
 820         get_link_entry_text(walker, '/', &lqbuffer1),
 821         get_linkcost_text(walker->linkcost,false, &lqbuffer2));
 822   } OLSR_FOR_ALL_LINK_ENTRIES_END(walker);
 823 }
 824 #endif /* NODEBUG */
 825
 826 /*
 827  * called for every LQ HELLO message.
 828  * update the timeout with the htime value from the message
 829  */
 830 void
 831 olsr_update_packet_loss_hello_int(struct link_entry *entry, olsr_reltime loss_hello_int)
 832 {
 833   entry->loss_helloint = loss_hello_int;
 834 }
 835
 836 void
 837 olsr_received_hello_handler(struct link_entry *entry)
 838 {
 839   olsr_update_packet_loss_worker(entry, false);
 840
 841   /* timeout for the first lost packet is 1.5 x htime */
 842   olsr_set_timer(&entry->link_loss_timer, entry->loss_helloint + entry->loss_helloint / 2, OLSR_LINK_LOSS_JITTER,
 843                  OLSR_TIMER_PERIODIC, &olsr_expire_link_loss_timer, entry, 0);
 844 }
 845
 846 /*
 847  * Local Variables:
 848  * c-basic-offset: 2
 849  * indent-tabs-mode: nil
 850  * End:
 851  */