ospfd/ospf_interface.c

   1 /*
   2  * OSPF Interface functions.
   3  * Copyright (C) 1999, 2000 Toshiaki Takada
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2, or (at your
  10  * option) any later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Zebra; see the file COPYING.  If not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #include <zebra.h>
  24
  25 #include "thread.h"
  26 #include "linklist.h"
  27 #include "prefix.h"
  28 #include "if.h"
  29 #include "table.h"
  30 #include "memory.h"
  31 #include "command.h"
  32 #include "stream.h"
  33 #include "log.h"
  34
  35 #include "ospfd/ospfd.h"
  36 #include "ospfd/ospf_spf.h"
  37 #include "ospfd/ospf_interface.h"
  38 #include "ospfd/ospf_ism.h"
  39 #include "ospfd/ospf_asbr.h"
  40 #include "ospfd/ospf_lsa.h"
  41 #include "ospfd/ospf_lsdb.h"
  42 #include "ospfd/ospf_neighbor.h"
  43 #include "ospfd/ospf_nsm.h"
  44 #include "ospfd/ospf_packet.h"
  45 #include "ospfd/ospf_abr.h"
  46 #include "ospfd/ospf_network.h"
  47 #include "ospfd/ospf_dump.h"
  48 #ifdef HAVE_SNMP
  49 #include "ospfd/ospf_snmp.h"
  50 #endif /* HAVE_SNMP */
  51
  52 \f
  53 int
  54 ospf_if_get_output_cost (struct ospf_interface *oi)
  55 {
  56   /* If all else fails, use default OSPF cost */
  57   u_int32_t cost;
  58   u_int32_t bw, refbw;
  59
  60   bw = oi->ifp->bandwidth ? oi->ifp->bandwidth : OSPF_DEFAULT_BANDWIDTH;
  61   refbw = oi->ospf->ref_bandwidth;
  62
  63   /* A specifed ip ospf cost overrides a calculated one. */
  64   if (OSPF_IF_PARAM_CONFIGURED (IF_DEF_PARAMS (oi->ifp), output_cost_cmd) ||
  65       OSPF_IF_PARAM_CONFIGURED (oi->params, output_cost_cmd))
  66     cost = OSPF_IF_PARAM (oi, output_cost_cmd);
  67   /* See if a cost can be calculated from the zebra processes
  68      interface bandwidth field. */
  69   else
  70     {
  71       cost = (u_int32_t) ((double)refbw / (double)bw + (double)0.5);
  72       if (cost < 1)
  73         cost = 1;
  74       else if (cost > 65535)
  75         cost = 65535;
  76     }
  77
  78   return cost;
  79 }
  80
  81 void
  82 ospf_if_recalculate_output_cost (struct interface *ifp)
  83 {
  84   u_int32_t newcost;
  85   struct route_node *rn;
  86
  87   for (rn = route_top (IF_OIFS (ifp)); rn; rn = route_next (rn))
  88     {
  89       struct ospf_interface *oi;
  90
  91       if ( (oi = rn->info) == NULL)
  92         continue;
  93
  94       newcost = ospf_if_get_output_cost (oi);
  95
  96       /* Is actual output cost changed? */
  97       if (oi->output_cost != newcost)
  98         {
  99           oi->output_cost = newcost;
 100           ospf_router_lsa_timer_add (oi->area);
 101         }
 102     }
 103 }
 104
 105 /* Simulate down/up on the interface.  This is needed, for example, when
 106    the MTU changes. */
 107 void
 108 ospf_if_reset(struct interface *ifp)
 109 {
 110   struct route_node *rn;
 111
 112   for (rn = route_top (IF_OIFS (ifp)); rn; rn = route_next (rn))
 113     {
 114       struct ospf_interface *oi;
 115
 116       if ( (oi = rn->info) == NULL)
 117         continue;
 118
 119       ospf_if_down(oi);
 120       ospf_if_up(oi);
 121     }
 122 }
 123
 124 void
 125 ospf_if_reset_variables (struct ospf_interface *oi)
 126 {
 127   /* Set default values. */
 128   /* don't clear this flag.  oi->flag = OSPF_IF_DISABLE; */
 129
 130   if (oi->vl_data)
 131     oi->type = OSPF_IFTYPE_VIRTUALLINK;
 132   else
 133   /* preserve network-type */
 134   if (oi->type != OSPF_IFTYPE_NBMA)
 135     oi->type = OSPF_IFTYPE_BROADCAST;
 136
 137   oi->state = ISM_Down;
 138
 139   oi->crypt_seqnum = 0;
 140
 141   /* This must be short, (less than RxmtInterval)
 142      - RFC 2328 Section 13.5 para 3.  Set to 1 second to avoid Acks being
 143        held back for too long - MAG */
 144   oi->v_ls_ack = 1;
 145 }
 146
 147 /* lookup oi for specified prefix/ifp */
 148 static struct ospf_interface *
 149 ospf_if_table_lookup (struct interface *ifp, struct prefix *prefix)
 150 {
 151   struct prefix p;
 152   struct route_node *rn;
 153   struct ospf_interface *rninfo;
 154
 155   p = *prefix;
 156
 157   rn = route_node_get (IF_OIFS (ifp), &p);
 158   /* route_node_get implicitely locks */
 159   rninfo = (struct ospf_interface *) rn->info;
 160   route_unlock_node (rn);
 161   return rninfo;
 162 }
 163
 164 static void
 165 ospf_add_to_if (struct interface *ifp, struct ospf_interface *oi)
 166 {
 167   struct route_node *rn;
 168   struct prefix p;
 169
 170   p = *oi->address;
 171   p.prefixlen = IPV4_MAX_PREFIXLEN;
 172
 173   rn = route_node_get (IF_OIFS (ifp), &p);
 174   /* rn->info should either be NULL or equal to this oi
 175    * as route_node_get may return an existing node
 176    */
 177   assert (!rn->info || rn->info == oi);
 178   rn->info = oi;
 179 }
 180
 181 static void
 182 ospf_delete_from_if (struct interface *ifp, struct ospf_interface *oi)
 183 {
 184   struct route_node *rn;
 185   struct prefix p;
 186
 187   p = *oi->address;
 188   p.prefixlen = IPV4_MAX_PREFIXLEN;
 189
 190   rn = route_node_lookup (IF_OIFS (oi->ifp), &p);
 191   assert (rn);
 192   assert (rn->info);
 193   rn->info = NULL;
 194   route_unlock_node (rn);
 195   route_unlock_node (rn);
 196 }
 197
 198 struct ospf_interface *
 199 ospf_if_new (struct ospf *ospf, struct interface *ifp, struct prefix *p)
 200 {
 201   struct ospf_interface *oi;
 202
 203   if ((oi = ospf_if_table_lookup (ifp, p)) == NULL)
 204     {
 205       oi = XCALLOC (MTYPE_OSPF_IF, sizeof (struct ospf_interface));
 206       memset (oi, 0, sizeof (struct ospf_interface));
 207     }
 208   else
 209     return oi;
 210
 211   /* Set zebra interface pointer. */
 212   oi->ifp = ifp;
 213   oi->address = p;
 214
 215   ospf_add_to_if (ifp, oi);
 216   listnode_add (ospf->oiflist, oi);
 217
 218   /* Clear self-originated network-LSA. */
 219   oi->network_lsa_self = NULL;
 220
 221   /* Initialize neighbor list. */
 222   oi->nbrs = route_table_init ();
 223
 224   /* Initialize static neighbor list. */
 225   oi->nbr_nbma = list_new ();
 226
 227   /* Initialize Link State Acknowledgment list. */
 228   oi->ls_ack = list_new ();
 229   oi->ls_ack_direct.ls_ack = list_new ();
 230
 231   /* Set default values. */
 232   ospf_if_reset_variables (oi);
 233
 234   /* Add pseudo neighbor. */
 235   oi->nbr_self = ospf_nbr_new (oi);
 236   oi->nbr_self->state = NSM_TwoWay;
 237   oi->nbr_self->priority = OSPF_IF_PARAM (oi, priority);
 238   oi->nbr_self->options = OSPF_OPTION_E;
 239
 240   oi->ls_upd_queue = route_table_init ();
 241   oi->t_ls_upd_event = NULL;
 242   oi->t_ls_ack_direct = NULL;
 243
 244   oi->crypt_seqnum = time (NULL);
 245
 246 #ifdef HAVE_OPAQUE_LSA
 247   ospf_opaque_type9_lsa_init (oi);
 248 #endif /* HAVE_OPAQUE_LSA */
 249
 250   oi->ospf = ospf;
 251
 252   return oi;
 253 }
 254
 255 /* Restore an interface to its pre UP state
 256    Used from ism_interface_down only */
 257 void
 258 ospf_if_cleanup (struct ospf_interface *oi)
 259 {
 260   struct route_node *rn;
 261   struct listnode *node, *nnode;
 262   struct ospf_neighbor *nbr;
 263   struct ospf_nbr_nbma *nbr_nbma;
 264   struct ospf_lsa *lsa;
 265
 266   /* oi->nbrs and oi->nbr_nbma should be deletete on InterafceDown event */
 267   /* delete all static neighbors attached to this interface */
 268   for (ALL_LIST_ELEMENTS (oi->nbr_nbma, node, nnode, nbr_nbma))
 269     {
 270       OSPF_POLL_TIMER_OFF (nbr_nbma->t_poll);
 271
 272       if (nbr_nbma->nbr)
 273         {
 274           nbr_nbma->nbr->nbr_nbma = NULL;
 275           nbr_nbma->nbr = NULL;
 276         }
 277
 278       nbr_nbma->oi = NULL;
 279
 280       listnode_delete (oi->nbr_nbma, nbr_nbma);
 281     }
 282
 283   /* send Neighbor event KillNbr to all associated neighbors. */
 284   for (rn = route_top (oi->nbrs); rn; rn = route_next (rn))
 285     if ((nbr = rn->info) != NULL)
 286       if (nbr != oi->nbr_self)
 287         OSPF_NSM_EVENT_EXECUTE (nbr, NSM_KillNbr);
 288
 289   /* Cleanup Link State Acknowlegdment list. */
 290   for (ALL_LIST_ELEMENTS (oi->ls_ack, node, nnode, lsa))
 291     ospf_lsa_unlock (lsa);
 292   list_delete_all_node (oi->ls_ack);
 293
 294   oi->crypt_seqnum = 0;
 295
 296   /* Empty link state update queue */
 297   ospf_ls_upd_queue_empty (oi);
 298
 299  /* Handle pseudo neighbor. */
 300   ospf_nbr_delete (oi->nbr_self);
 301   oi->nbr_self = ospf_nbr_new (oi);
 302   oi->nbr_self->state = NSM_TwoWay;
 303   oi->nbr_self->priority = OSPF_IF_PARAM (oi, priority);
 304
 305   switch (oi->area->external_routing)
 306     {
 307     case OSPF_AREA_DEFAULT:
 308       SET_FLAG (oi->nbr_self->options, OSPF_OPTION_E);
 309       break;
 310     case OSPF_AREA_STUB:
 311       UNSET_FLAG (oi->nbr_self->options, OSPF_OPTION_E);
 312       break;
 313     case OSPF_AREA_NSSA:
 314       UNSET_FLAG (oi->nbr_self->options, OSPF_OPTION_E);
 315       SET_FLAG (oi->nbr_self->options, OSPF_OPTION_NP);
 316       break;
 317     }
 318
 319   ospf_lsa_unlock (oi->network_lsa_self);
 320   oi->network_lsa_self = NULL;
 321   OSPF_TIMER_OFF (oi->t_network_lsa_self);
 322 }
 323
 324 void
 325 ospf_if_free (struct ospf_interface *oi)
 326 {
 327   ospf_if_down (oi);
 328
 329   assert (oi->state == ISM_Down);
 330
 331 #ifdef HAVE_OPAQUE_LSA
 332   ospf_opaque_type9_lsa_term (oi);
 333 #endif /* HAVE_OPAQUE_LSA */
 334
 335   /* Free Pseudo Neighbour */
 336   ospf_nbr_delete (oi->nbr_self);
 337
 338   route_table_finish (oi->nbrs);
 339   route_table_finish (oi->ls_upd_queue);
 340
 341   /* Free any lists that should be freed */
 342   list_free (oi->nbr_nbma);
 343
 344   list_free (oi->ls_ack);
 345   list_free (oi->ls_ack_direct.ls_ack);
 346
 347   ospf_delete_from_if (oi->ifp, oi);
 348
 349   listnode_delete (oi->ospf->oiflist, oi);
 350   listnode_delete (oi->area->oiflist, oi);
 351
 352   memset (oi, 0, sizeof (*oi));
 353   XFREE (MTYPE_OSPF_IF, oi);
 354 }
 355
 356 \f
 357 /*
 358 *  check if interface with given address is configured and
 359 *  return it if yes.  special treatment for PtP networks.
 360 */
 361 struct ospf_interface *
 362 ospf_if_is_configured (struct ospf *ospf, struct in_addr *address)
 363 {
 364   struct listnode *node, *nnode;
 365   struct ospf_interface *oi;
 366   struct prefix_ipv4 addr;
 367
 368   addr.family = AF_INET;
 369   addr.prefix = *address;
 370   addr.prefixlen = IPV4_MAX_PREFIXLEN;
 371
 372   for (ALL_LIST_ELEMENTS (ospf->oiflist, node, nnode, oi))
 373     if (oi->type != OSPF_IFTYPE_VIRTUALLINK)
 374       {
 375         if (oi->type == OSPF_IFTYPE_POINTOPOINT)
 376           {
 377             if (CONNECTED_DEST_HOST(oi->connected))
 378               {
 379                 /* match only destination addr, since local addr is most likely
 380                  * not unique (borrowed from another interface) */
 381                 if (IPV4_ADDR_SAME (address,
 382                                     &oi->connected->destination->u.prefix4))
 383                 return oi;
 384               }
 385             else
 386               {
 387                 /* special leniency: match if addr is anywhere on PtP subnet */
 388                 if (prefix_match(oi->address,(struct prefix *)&addr))
 389                   return oi;
 390               }
 391           }
 392         else
 393           {
 394             if (IPV4_ADDR_SAME (address, &oi->address->u.prefix4))
 395               return oi;
 396           }
 397       }
 398   return NULL;
 399 }
 400
 401 int
 402 ospf_if_is_up (struct ospf_interface *oi)
 403 {
 404   return if_is_up (oi->ifp);
 405 }
 406
 407 struct ospf_interface *
 408 ospf_if_exists (struct ospf_interface *oic)
 409 {
 410   struct listnode *node;
 411   struct ospf *ospf;
 412   struct ospf_interface *oi;
 413
 414   ospf = ospf_lookup ();
 415
 416   for (ALL_LIST_ELEMENTS_RO (ospf->oiflist, node, oi))
 417     if (oi == oic)
 418       return oi;
 419
 420   return NULL;
 421 }
 422
 423 struct ospf_interface *
 424 ospf_if_lookup_by_local_addr (struct ospf *ospf,
 425                               struct interface *ifp, struct in_addr address)
 426 {
 427   struct listnode *node;
 428   struct ospf_interface *oi;
 429
 430   for (ALL_LIST_ELEMENTS_RO (ospf->oiflist, node, oi))
 431     if (oi->type != OSPF_IFTYPE_VIRTUALLINK)
 432       {
 433         if (ifp && oi->ifp != ifp)
 434           continue;
 435
 436         if (IPV4_ADDR_SAME (&address, &oi->address->u.prefix4))
 437           return oi;
 438       }
 439
 440   return NULL;
 441 }
 442
 443 struct ospf_interface *
 444 ospf_if_lookup_by_prefix (struct ospf *ospf, struct prefix_ipv4 *p)
 445 {
 446   struct listnode *node;
 447   struct ospf_interface *oi;
 448   struct prefix ptmp;
 449
 450   /* Check each Interface. */
 451   for (ALL_LIST_ELEMENTS_RO (ospf->oiflist, node, oi))
 452     {
 453       if (oi->type != OSPF_IFTYPE_VIRTUALLINK)
 454         {
 455           if ((oi->type == OSPF_IFTYPE_POINTOPOINT) &&
 456               CONNECTED_DEST_HOST(oi->connected))
 457             {
 458               prefix_copy (&ptmp, oi->connected->destination);
 459               ptmp.prefixlen = IPV4_MAX_BITLEN;
 460             }
 461           else
 462             prefix_copy (&ptmp, oi->address);
 463
 464           apply_mask (&ptmp);
 465           if (prefix_same (&ptmp, (struct prefix *) p))
 466             return oi;
 467         }
 468     }
 469   return NULL;
 470 }
 471
 472 /* determine receiving interface by source of packet */
 473 struct ospf_interface *
 474 ospf_if_lookup_recv_if (struct ospf *ospf, struct in_addr src)
 475 {
 476   struct listnode *node;
 477   struct prefix_ipv4 addr;
 478   struct ospf_interface *oi, *match;
 479
 480   addr.family = AF_INET;
 481   addr.prefix = src;
 482   addr.prefixlen = IPV4_MAX_BITLEN;
 483
 484   match = NULL;
 485
 486   for (ALL_LIST_ELEMENTS_RO (ospf->oiflist, node, oi))
 487     {
 488       if (oi->type == OSPF_IFTYPE_VIRTUALLINK)
 489         continue;
 490
 491       if ((oi->type == OSPF_IFTYPE_POINTOPOINT) &&
 492           CONNECTED_DEST_HOST(oi->connected))
 493         {
 494           if (IPV4_ADDR_SAME (&oi->connected->destination->u.prefix4, &src))
 495             return oi;
 496         }
 497       else
 498         {
 499           if (prefix_match (oi->address, (struct prefix *) &addr))
 500             {
 501               if ( (match == NULL) ||
 502                    (match->address->prefixlen < oi->address->prefixlen)
 503                  )
 504                 match = oi;
 505             }
 506         }
 507     }
 508
 509   return match;
 510 }
 511 \f
 512 void
 513 ospf_if_stream_set (struct ospf_interface *oi)
 514 {
 515   /* set output fifo queue. */
 516   if (oi->obuf == NULL)
 517     oi->obuf = ospf_fifo_new ();
 518 }
 519
 520 void
 521 ospf_if_stream_unset (struct ospf_interface *oi)
 522 {
 523   struct ospf *ospf = oi->ospf;
 524
 525   if (oi->obuf)
 526     {
 527      ospf_fifo_free (oi->obuf);
 528      oi->obuf = NULL;
 529
 530      if (oi->on_write_q)
 531        {
 532          listnode_delete (ospf->oi_write_q, oi);
 533          if (list_isempty(ospf->oi_write_q))
 534            OSPF_TIMER_OFF (ospf->t_write);
 535          oi->on_write_q = 0;
 536        }
 537     }
 538 }
 539
 540 \f
 541 static struct ospf_if_params *
 542 ospf_new_if_params (void)
 543 {
 544   struct ospf_if_params *oip;
 545
 546   oip = XMALLOC (MTYPE_OSPF_IF_PARAMS, sizeof (struct ospf_if_params));
 547
 548   if (!oip)
 549     return NULL;
 550
 551   memset (oip, 0, sizeof (struct ospf_if_params));
 552
 553   UNSET_IF_PARAM (oip, output_cost_cmd);
 554   UNSET_IF_PARAM (oip, transmit_delay);
 555   UNSET_IF_PARAM (oip, retransmit_interval);
 556   UNSET_IF_PARAM (oip, passive_interface);
 557   UNSET_IF_PARAM (oip, v_hello);
 558   UNSET_IF_PARAM (oip, v_wait);
 559   UNSET_IF_PARAM (oip, priority);
 560   UNSET_IF_PARAM (oip, type);
 561   UNSET_IF_PARAM (oip, auth_simple);
 562   UNSET_IF_PARAM (oip, auth_crypt);
 563   UNSET_IF_PARAM (oip, auth_type);
 564
 565   oip->auth_crypt = list_new ();
 566
 567   return oip;
 568 }
 569
 570 void
 571 ospf_del_if_params (struct ospf_if_params *oip)
 572 {
 573   list_delete (oip->auth_crypt);
 574   XFREE (MTYPE_OSPF_IF_PARAMS, oip);
 575 }
 576
 577 void
 578 ospf_free_if_params (struct interface *ifp, struct in_addr addr)
 579 {
 580   struct ospf_if_params *oip;
 581   struct prefix_ipv4 p;
 582   struct route_node *rn;
 583
 584   p.family = AF_INET;
 585   p.prefixlen = IPV4_MAX_PREFIXLEN;
 586   p.prefix = addr;
 587   rn = route_node_lookup (IF_OIFS_PARAMS (ifp), (struct prefix*)&p);
 588   if (!rn || !rn->info)
 589     return;
 590
 591   oip = rn->info;
 592   route_unlock_node (rn);
 593
 594   if (!OSPF_IF_PARAM_CONFIGURED (oip, output_cost_cmd) &&
 595       !OSPF_IF_PARAM_CONFIGURED (oip, transmit_delay) &&
 596       !OSPF_IF_PARAM_CONFIGURED (oip, retransmit_interval) &&
 597       !OSPF_IF_PARAM_CONFIGURED (oip, passive_interface) &&
 598       !OSPF_IF_PARAM_CONFIGURED (oip, v_hello) &&
 599       !OSPF_IF_PARAM_CONFIGURED (oip, v_wait) &&
 600       !OSPF_IF_PARAM_CONFIGURED (oip, priority) &&
 601       !OSPF_IF_PARAM_CONFIGURED (oip, type) &&
 602       !OSPF_IF_PARAM_CONFIGURED (oip, auth_simple) &&
 603       !OSPF_IF_PARAM_CONFIGURED (oip, auth_type) &&
 604       listcount (oip->auth_crypt) == 0)
 605     {
 606       ospf_del_if_params (oip);
 607       rn->info = NULL;
 608       route_unlock_node (rn);
 609     }
 610 }
 611
 612 struct ospf_if_params *
 613 ospf_lookup_if_params (struct interface *ifp, struct in_addr addr)
 614 {
 615   struct prefix_ipv4 p;
 616   struct route_node *rn;
 617
 618   p.family = AF_INET;
 619   p.prefixlen = IPV4_MAX_PREFIXLEN;
 620   p.prefix = addr;
 621
 622   rn = route_node_lookup (IF_OIFS_PARAMS (ifp), (struct prefix*)&p);
 623
 624   if (rn)
 625     {
 626       route_unlock_node (rn);
 627       return rn->info;
 628     }
 629
 630   return NULL;
 631 }
 632
 633 struct ospf_if_params *
 634 ospf_get_if_params (struct interface *ifp, struct in_addr addr)
 635 {
 636   struct prefix_ipv4 p;
 637   struct route_node *rn;
 638
 639   p.family = AF_INET;
 640   p.prefixlen = IPV4_MAX_PREFIXLEN;
 641   p.prefix = addr;
 642
 643   rn = route_node_get (IF_OIFS_PARAMS (ifp), (struct prefix*)&p);
 644
 645   if (rn->info == NULL)
 646     rn->info = ospf_new_if_params ();
 647   else
 648     route_unlock_node (rn);
 649
 650   return rn->info;
 651 }
 652
 653 void
 654 ospf_if_update_params (struct interface *ifp, struct in_addr addr)
 655 {
 656   struct route_node *rn;
 657   struct ospf_interface *oi;
 658
 659   for (rn = route_top (IF_OIFS (ifp)); rn; rn = route_next (rn))
 660     {
 661       if ((oi = rn->info) == NULL)
 662         continue;
 663
 664       if (IPV4_ADDR_SAME (&oi->address->u.prefix4, &addr))
 665         oi->params = ospf_lookup_if_params (ifp, oi->address->u.prefix4);
 666     }
 667 }
 668
 669 int
 670 ospf_if_new_hook (struct interface *ifp)
 671 {
 672   int rc = 0;
 673
 674   ifp->info = XMALLOC (MTYPE_OSPF_IF_INFO, sizeof (struct ospf_if_info));
 675   memset (ifp->info, 0, sizeof (struct ospf_if_info));
 676
 677   IF_OIFS (ifp) = route_table_init ();
 678   IF_OIFS_PARAMS (ifp) = route_table_init ();
 679
 680   IF_DEF_PARAMS (ifp) = ospf_new_if_params ();
 681
 682   SET_IF_PARAM (IF_DEF_PARAMS (ifp), transmit_delay);
 683   IF_DEF_PARAMS (ifp)->transmit_delay = OSPF_TRANSMIT_DELAY_DEFAULT;
 684
 685   SET_IF_PARAM (IF_DEF_PARAMS (ifp), retransmit_interval);
 686   IF_DEF_PARAMS (ifp)->retransmit_interval = OSPF_RETRANSMIT_INTERVAL_DEFAULT;
 687
 688   SET_IF_PARAM (IF_DEF_PARAMS (ifp), priority);
 689   IF_DEF_PARAMS (ifp)->priority = OSPF_ROUTER_PRIORITY_DEFAULT;
 690
 691   SET_IF_PARAM (IF_DEF_PARAMS (ifp), passive_interface);
 692   IF_DEF_PARAMS (ifp)->passive_interface = OSPF_IF_ACTIVE;
 693
 694   SET_IF_PARAM (IF_DEF_PARAMS (ifp), v_hello);
 695   IF_DEF_PARAMS (ifp)->v_hello = OSPF_HELLO_INTERVAL_DEFAULT;
 696
 697   SET_IF_PARAM (IF_DEF_PARAMS (ifp), v_wait);
 698   IF_DEF_PARAMS (ifp)->v_wait = OSPF_ROUTER_DEAD_INTERVAL_DEFAULT;
 699
 700   SET_IF_PARAM (IF_DEF_PARAMS (ifp), auth_simple);
 701   memset (IF_DEF_PARAMS (ifp)->auth_simple, 0, OSPF_AUTH_SIMPLE_SIZE);
 702
 703   SET_IF_PARAM (IF_DEF_PARAMS (ifp), auth_type);
 704   IF_DEF_PARAMS (ifp)->auth_type = OSPF_AUTH_NOTSET;
 705
 706 #ifdef HAVE_OPAQUE_LSA
 707   rc = ospf_opaque_new_if (ifp);
 708 #endif /* HAVE_OPAQUE_LSA */
 709   return rc;
 710 }
 711
 712 static int
 713 ospf_if_delete_hook (struct interface *ifp)
 714 {
 715   int rc = 0;
 716   struct route_node *rn;
 717 #ifdef HAVE_OPAQUE_LSA
 718   rc = ospf_opaque_del_if (ifp);
 719 #endif /* HAVE_OPAQUE_LSA */
 720
 721   route_table_finish (IF_OIFS (ifp));
 722
 723   for (rn = route_top (IF_OIFS_PARAMS (ifp)); rn; rn = route_next (rn))
 724     if (rn->info)
 725       ospf_del_if_params (rn->info);
 726   route_table_finish (IF_OIFS_PARAMS (ifp));
 727
 728   ospf_del_if_params ((struct ospf_if_params *) IF_DEF_PARAMS (ifp));
 729   XFREE (MTYPE_OSPF_IF_INFO, ifp->info);
 730   ifp->info = NULL;
 731
 732   return rc;
 733 }
 734
 735 int
 736 ospf_if_is_enable (struct ospf_interface *oi)
 737 {
 738   if (!if_is_loopback (oi->ifp))
 739     if (if_is_up (oi->ifp))
 740         return 1;
 741
 742   return 0;
 743 }
 744
 745 void
 746 ospf_if_set_multicast(struct ospf_interface *oi)
 747 {
 748   if ((oi->state > ISM_Loopback) &&
 749       (oi->type != OSPF_IFTYPE_LOOPBACK) &&
 750       (oi->type != OSPF_IFTYPE_VIRTUALLINK) &&
 751       (OSPF_IF_PARAM(oi, passive_interface) == OSPF_IF_ACTIVE))
 752     {
 753       /* The interface should belong to the OSPF-all-routers group. */
 754       if (!CHECK_FLAG(oi->multicast_memberships, MEMBER_ALLROUTERS) &&
 755           (ospf_if_add_allspfrouters(oi->ospf, oi->address,
 756                                      oi->ifp->ifindex) >= 0))
 757         /* Set the flag only if the system call to join succeeded. */
 758         SET_FLAG(oi->multicast_memberships, MEMBER_ALLROUTERS);
 759     }
 760   else
 761     {
 762       /* The interface should NOT belong to the OSPF-all-routers group. */
 763       if (CHECK_FLAG(oi->multicast_memberships, MEMBER_ALLROUTERS))
 764         {
 765           ospf_if_drop_allspfrouters (oi->ospf, oi->address, oi->ifp->ifindex);
 766           /* Unset the flag regardless of whether the system call to leave
 767              the group succeeded, since it's much safer to assume that
 768              we are not a member. */
 769           UNSET_FLAG(oi->multicast_memberships, MEMBER_ALLROUTERS);
 770         }
 771     }
 772
 773   if (((oi->type == OSPF_IFTYPE_BROADCAST) ||
 774        (oi->type == OSPF_IFTYPE_POINTOPOINT)) &&
 775       ((oi->state == ISM_DR) || (oi->state == ISM_Backup)) &&
 776       (OSPF_IF_PARAM(oi, passive_interface) == OSPF_IF_ACTIVE))
 777     {
 778       /* The interface should belong to the OSPF-designated-routers group. */
 779       if (!CHECK_FLAG(oi->multicast_memberships, MEMBER_DROUTERS) &&
 780           (ospf_if_add_alldrouters(oi->ospf, oi->address,
 781                                    oi->ifp->ifindex) >= 0))
 782         /* Set the flag only if the system call to join succeeded. */
 783         SET_FLAG(oi->multicast_memberships, MEMBER_DROUTERS);
 784     }
 785   else
 786     {
 787       /* The interface should NOT belong to the OSPF-designated-routers group */
 788       if (CHECK_FLAG(oi->multicast_memberships, MEMBER_DROUTERS))
 789         {
 790           ospf_if_drop_alldrouters(oi->ospf, oi->address, oi->ifp->ifindex);
 791           /* Unset the flag regardless of whether the system call to leave
 792              the group succeeded, since it's much safer to assume that
 793              we are not a member. */
 794           UNSET_FLAG(oi->multicast_memberships, MEMBER_DROUTERS);
 795         }
 796     }
 797 }
 798
 799 int
 800 ospf_if_up (struct ospf_interface *oi)
 801 {
 802   if (oi == NULL)
 803     return 0;
 804
 805   if (oi->type == OSPF_IFTYPE_LOOPBACK)
 806     OSPF_ISM_EVENT_SCHEDULE (oi, ISM_LoopInd);
 807   else
 808     {
 809       ospf_if_stream_set (oi);
 810       OSPF_ISM_EVENT_SCHEDULE (oi, ISM_InterfaceUp);
 811     }
 812
 813   return 1;
 814 }
 815
 816 int
 817 ospf_if_down (struct ospf_interface *oi)
 818 {
 819   if (oi == NULL)
 820     return 0;
 821
 822   OSPF_ISM_EVENT_EXECUTE (oi, ISM_InterfaceDown);
 823   /* Shutdown packet reception and sending */
 824   ospf_if_stream_unset (oi);
 825
 826   return 1;
 827 }
 828
 829 \f
 830 /* Virtual Link related functions. */
 831
 832 struct ospf_vl_data *
 833 ospf_vl_data_new (struct ospf_area *area, struct in_addr vl_peer)
 834 {
 835   struct ospf_vl_data *vl_data;
 836
 837   vl_data = XMALLOC (MTYPE_OSPF_VL_DATA, sizeof (struct ospf_vl_data));
 838   memset (vl_data, 0, sizeof (struct ospf_vl_data));
 839
 840   vl_data->vl_peer.s_addr = vl_peer.s_addr;
 841   vl_data->vl_area_id = area->area_id;
 842   vl_data->format = area->format;
 843
 844   return vl_data;
 845 }
 846
 847 void
 848 ospf_vl_data_free (struct ospf_vl_data *vl_data)
 849 {
 850   XFREE (MTYPE_OSPF_VL_DATA, vl_data);
 851 }
 852
 853 u_int vlink_count = 0;
 854
 855 struct ospf_interface *
 856 ospf_vl_new (struct ospf *ospf, struct ospf_vl_data *vl_data)
 857 {
 858   struct ospf_interface * voi;
 859   struct interface * vi;
 860   char   ifname[INTERFACE_NAMSIZ + 1];
 861   struct ospf_area *area;
 862   struct in_addr area_id;
 863   struct connected *co;
 864   struct prefix_ipv4 *p;
 865
 866   if (IS_DEBUG_OSPF_EVENT)
 867     zlog_debug ("ospf_vl_new(): Start");
 868   if (vlink_count == OSPF_VL_MAX_COUNT)
 869     {
 870       if (IS_DEBUG_OSPF_EVENT)
 871         zlog_debug ("ospf_vl_new(): Alarm: "
 872                    "cannot create more than OSPF_MAX_VL_COUNT virtual links");
 873       return NULL;
 874     }
 875
 876   if (IS_DEBUG_OSPF_EVENT)
 877     zlog_debug ("ospf_vl_new(): creating pseudo zebra interface");
 878
 879   snprintf (ifname, sizeof(ifname), "VLINK%d", vlink_count);
 880   vi = if_create (ifname, strnlen(ifname, sizeof(ifname)));
 881   co = connected_new ();
 882   co->ifp = vi;
 883   listnode_add (vi->connected, co);
 884
 885   p = prefix_ipv4_new ();
 886   p->family = AF_INET;
 887   p->prefix.s_addr = 0;
 888   p->prefixlen = 0;
 889
 890   co->address = (struct prefix *)p;
 891
 892   voi = ospf_if_new (ospf, vi, co->address);
 893   if (voi == NULL)
 894     {
 895       if (IS_DEBUG_OSPF_EVENT)
 896         zlog_debug ("ospf_vl_new(): Alarm: OSPF int structure is not created");
 897       return NULL;
 898     }
 899   voi->connected = co;
 900   voi->vl_data = vl_data;
 901   voi->ifp->mtu = OSPF_VL_MTU;
 902   voi->type = OSPF_IFTYPE_VIRTUALLINK;
 903
 904   vlink_count++;
 905   if (IS_DEBUG_OSPF_EVENT)
 906     zlog_debug ("ospf_vl_new(): Created name: %s", ifname);
 907   if (IS_DEBUG_OSPF_EVENT)
 908     zlog_debug ("ospf_vl_new(): set if->name to %s", vi->name);
 909
 910   area_id.s_addr = 0;
 911   area = ospf_area_get (ospf, area_id, OSPF_AREA_ID_FORMAT_ADDRESS);
 912   voi->area = area;
 913
 914   if (IS_DEBUG_OSPF_EVENT)
 915     zlog_debug ("ospf_vl_new(): set associated area to the backbone");
 916
 917   ospf_area_add_if (voi->area, voi);
 918
 919   ospf_if_stream_set (voi);
 920
 921   if (IS_DEBUG_OSPF_EVENT)
 922     zlog_debug ("ospf_vl_new(): Stop");
 923   return voi;
 924 }
 925
 926 static void
 927 ospf_vl_if_delete (struct ospf_vl_data *vl_data)
 928 {
 929   struct interface *ifp = vl_data->vl_oi->ifp;
 930   vl_data->vl_oi->address->u.prefix4.s_addr = 0;
 931   vl_data->vl_oi->address->prefixlen = 0;
 932   ospf_if_free (vl_data->vl_oi);
 933   if_delete (ifp);
 934   vlink_count--;
 935 }
 936
 937 struct ospf_vl_data *
 938 ospf_vl_lookup (struct ospf_area *area, struct in_addr vl_peer)
 939 {
 940   struct ospf_vl_data *vl_data;
 941   struct listnode *node;
 942
 943   for (ALL_LIST_ELEMENTS_RO (area->ospf->vlinks, node, vl_data))
 944     if (vl_data->vl_peer.s_addr == vl_peer.s_addr &&
 945         IPV4_ADDR_SAME (&vl_data->vl_area_id, &area->area_id))
 946       return vl_data;
 947
 948   return NULL;
 949 }
 950
 951 static void
 952 ospf_vl_shutdown (struct ospf_vl_data *vl_data)
 953 {
 954   struct ospf_interface *oi;
 955
 956   if ((oi = vl_data->vl_oi) == NULL)
 957     return;
 958
 959   oi->address->u.prefix4.s_addr = 0;
 960   oi->address->prefixlen = 0;
 961
 962   UNSET_FLAG (oi->ifp->flags, IFF_UP);
 963   /* OSPF_ISM_EVENT_SCHEDULE (oi, ISM_InterfaceDown); */
 964   OSPF_ISM_EVENT_EXECUTE (oi, ISM_InterfaceDown);
 965 }
 966
 967 void
 968 ospf_vl_add (struct ospf *ospf, struct ospf_vl_data *vl_data)
 969 {
 970   listnode_add (ospf->vlinks, vl_data);
 971 #ifdef HAVE_SNMP
 972   ospf_snmp_vl_add (vl_data);
 973 #endif /* HAVE_SNMP */
 974 }
 975
 976 void
 977 ospf_vl_delete (struct ospf *ospf, struct ospf_vl_data *vl_data)
 978 {
 979   ospf_vl_shutdown (vl_data);
 980   ospf_vl_if_delete (vl_data);
 981
 982 #ifdef HAVE_SNMP
 983   ospf_snmp_vl_delete (vl_data);
 984 #endif /* HAVE_SNMP */
 985   listnode_delete (ospf->vlinks, vl_data);
 986
 987   ospf_vl_data_free (vl_data);
 988 }
 989
 990 static int
 991 ospf_vl_set_params (struct ospf_vl_data *vl_data, struct vertex *v)
 992 {
 993   int changed = 0;
 994   struct ospf_interface *voi;
 995   struct listnode *node;
 996   struct vertex_nexthop *nh;
 997   int i;
 998   struct router_lsa *rl;
 999
1000   voi = vl_data->vl_oi;
1001
1002   if (voi->output_cost != v->distance)
1003     {
1004
1005       voi->output_cost = v->distance;
1006       changed = 1;
1007     }
1008
1009   for (ALL_LIST_ELEMENTS_RO (v->nexthop, node, nh))
1010     {
1011       vl_data->out_oi = (struct ospf_interface *) nh->oi;
1012
1013       if (!IPV4_ADDR_SAME(&voi->address->u.prefix4,
1014                           &vl_data->out_oi->address->u.prefix4))
1015         changed = 1;
1016
1017       voi->address->u.prefix4 = vl_data->out_oi->address->u.prefix4;
1018       voi->address->prefixlen = vl_data->out_oi->address->prefixlen;
1019
1020       break; /* We take the first interface. */
1021     }
1022
1023   rl = (struct router_lsa *)v->lsa;
1024
1025   /* use SPF determined backlink index in struct vertex
1026    * for virtual link destination address
1027    */
1028   if (v->backlink >= 0)
1029     {
1030       if (!IPV4_ADDR_SAME (&vl_data->peer_addr,
1031                            &rl->link[v->backlink].link_data))
1032         changed = 1;
1033       vl_data->peer_addr = rl->link[v->backlink].link_data;
1034     }
1035   else
1036     {
1037       /* This is highly odd, there is no backlink index
1038        * there should be due to the ospf_spf_has_link() check
1039        * in SPF. Lets warn and try pick a link anyway.
1040        */
1041       zlog_warn ("ospf_vl_set_params: No backlink for %s!",
1042                  vl_data->vl_oi->ifp->name);
1043       for (i = 0; i < ntohs (rl->links); i++)
1044         {
1045           switch (rl->link[i].type)
1046             {
1047               case LSA_LINK_TYPE_VIRTUALLINK:
1048                 if (IS_DEBUG_OSPF_EVENT)
1049                   zlog_debug ("found back link through VL");
1050               case LSA_LINK_TYPE_TRANSIT:
1051               case LSA_LINK_TYPE_POINTOPOINT:
1052                 if (!IPV4_ADDR_SAME (&vl_data->peer_addr,
1053                                      &rl->link[i].link_data))
1054                   changed = 1;
1055                 vl_data->peer_addr = rl->link[i].link_data;
1056               if (IS_DEBUG_OSPF_EVENT)
1057                 zlog_debug ("ospf_vl_set_params: %s peer address is %s\n",
1058                                vl_data->vl_oi->ifp->name,
1059                                inet_ntoa(vl_data->peer_addr));
1060               return changed;
1061             }
1062         }
1063     }
1064
1065   if (IS_DEBUG_OSPF_EVENT)
1066     zlog_debug ("ospf_vl_set_params: %s peer address is %s\n",
1067                vl_data->vl_oi->ifp->name,
1068                inet_ntoa(vl_data->peer_addr));
1069
1070   return changed;
1071 }
1072
1073
1074 void
1075 ospf_vl_up_check (struct ospf_area *area, struct in_addr rid,
1076                   struct vertex *v)
1077 {
1078   struct ospf *ospf = area->ospf;
1079   struct listnode *node;
1080   struct ospf_vl_data *vl_data;
1081   struct ospf_interface *oi;
1082
1083   if (IS_DEBUG_OSPF_EVENT)
1084     {
1085       zlog_debug ("ospf_vl_up_check(): Start");
1086       zlog_debug ("ospf_vl_up_check(): Router ID is %s", inet_ntoa (rid));
1087       zlog_debug ("ospf_vl_up_check(): Area is %s", inet_ntoa (area->area_id));
1088     }
1089
1090   for (ALL_LIST_ELEMENTS_RO (ospf->vlinks, node, vl_data))
1091     {
1092       if (IS_DEBUG_OSPF_EVENT)
1093         {
1094           zlog_debug ("ospf_vl_up_check(): considering VL, name: %s",
1095                      vl_data->vl_oi->ifp->name);
1096           zlog_debug ("ospf_vl_up_check(): VL area: %s, peer ID: %s",
1097                      inet_ntoa (vl_data->vl_area_id),
1098                      inet_ntoa (vl_data->vl_peer));
1099         }
1100
1101       if (IPV4_ADDR_SAME (&vl_data->vl_peer, &rid) &&
1102           IPV4_ADDR_SAME (&vl_data->vl_area_id, &area->area_id))
1103         {
1104           oi = vl_data->vl_oi;
1105           SET_FLAG (vl_data->flags, OSPF_VL_FLAG_APPROVED);
1106
1107           if (IS_DEBUG_OSPF_EVENT)
1108             zlog_debug ("ospf_vl_up_check(): this VL matched");
1109
1110           if (oi->state == ISM_Down)
1111             {
1112               if (IS_DEBUG_OSPF_EVENT)
1113                 zlog_debug ("ospf_vl_up_check(): VL is down, waking it up");
1114               SET_FLAG (oi->ifp->flags, IFF_UP);
1115               OSPF_ISM_EVENT_EXECUTE(oi,ISM_InterfaceUp);
1116             }
1117
1118          if (ospf_vl_set_params (vl_data, v))
1119            {
1120              if (IS_DEBUG_OSPF (ism, ISM_EVENTS))
1121                zlog_debug ("ospf_vl_up_check: VL cost change,"
1122                           " scheduling router lsa refresh");
1123              if(ospf->backbone)
1124                ospf_router_lsa_timer_add (ospf->backbone);
1125              else if (IS_DEBUG_OSPF (ism, ISM_EVENTS))
1126                zlog_debug ("ospf_vl_up_check: VL cost change, no backbone!");
1127            }
1128         }
1129     }
1130 }
1131
1132 void
1133 ospf_vl_unapprove (struct ospf *ospf)
1134 {
1135   struct listnode *node;
1136   struct ospf_vl_data *vl_data;
1137
1138   for (ALL_LIST_ELEMENTS_RO (ospf->vlinks, node, vl_data))
1139     UNSET_FLAG (vl_data->flags, OSPF_VL_FLAG_APPROVED);
1140 }
1141
1142 void
1143 ospf_vl_shut_unapproved (struct ospf *ospf)
1144 {
1145   struct listnode *node, *nnode;
1146   struct ospf_vl_data *vl_data;
1147
1148   for (ALL_LIST_ELEMENTS (ospf->vlinks, node, nnode, vl_data))
1149     if (!CHECK_FLAG (vl_data->flags, OSPF_VL_FLAG_APPROVED))
1150       ospf_vl_shutdown (vl_data);
1151 }
1152
1153 int
1154 ospf_full_virtual_nbrs (struct ospf_area *area)
1155 {
1156   if (IS_DEBUG_OSPF_EVENT)
1157     {
1158       zlog_debug ("counting fully adjacent virtual neighbors in area %s",
1159                  inet_ntoa (area->area_id));
1160       zlog_debug ("there are %d of them", area->full_vls);
1161     }
1162
1163   return area->full_vls;
1164 }
1165
1166 int
1167 ospf_vls_in_area (struct ospf_area *area)
1168 {
1169   struct listnode *node;
1170   struct ospf_vl_data *vl_data;
1171   int c = 0;
1172
1173   for (ALL_LIST_ELEMENTS_RO (area->ospf->vlinks, node, vl_data))
1174     if (IPV4_ADDR_SAME (&vl_data->vl_area_id, &area->area_id))
1175       c++;
1176
1177   return c;
1178 }
1179
1180 \f
1181 struct crypt_key *
1182 ospf_crypt_key_new ()
1183 {
1184   struct crypt_key *ck;
1185
1186   ck = XMALLOC (MTYPE_OSPF_CRYPT_KEY, sizeof (struct crypt_key));
1187   memset (ck, 0, sizeof (struct crypt_key));
1188
1189   return ck;
1190 }
1191
1192 void
1193 ospf_crypt_key_add (struct list *crypt, struct crypt_key *ck)
1194 {
1195   listnode_add (crypt, ck);
1196 }
1197
1198 struct crypt_key *
1199 ospf_crypt_key_lookup (struct list *auth_crypt, u_char key_id)
1200 {
1201   struct listnode *node;
1202   struct crypt_key *ck;
1203
1204   for (ALL_LIST_ELEMENTS_RO (auth_crypt, node, ck))
1205     if (ck->key_id == key_id)
1206       return ck;
1207
1208   return NULL;
1209 }
1210
1211 int
1212 ospf_crypt_key_delete (struct list *auth_crypt, u_char key_id)
1213 {
1214   struct listnode *node, *nnode;
1215   struct crypt_key *ck;
1216
1217   for (ALL_LIST_ELEMENTS (auth_crypt, node, nnode, ck))
1218     {
1219       if (ck->key_id == key_id)
1220         {
1221           listnode_delete (auth_crypt, ck);
1222           return 1;
1223         }
1224     }
1225
1226   return 0;
1227 }
1228
1229 u_char
1230 ospf_default_iftype(struct interface *ifp)
1231 {
1232   if (if_is_pointopoint (ifp))
1233     return OSPF_IFTYPE_POINTOPOINT;
1234   else if (if_is_loopback (ifp))
1235     return OSPF_IFTYPE_LOOPBACK;
1236   else
1237     return OSPF_IFTYPE_BROADCAST;
1238 }
1239
1240 void
1241 ospf_if_init ()
1242 {
1243   /* Initialize Zebra interface data structure. */
1244   if_init ();
1245   om->iflist = iflist;
1246   if_add_hook (IF_NEW_HOOK, ospf_if_new_hook);
1247   if_add_hook (IF_DELETE_HOOK, ospf_if_delete_hook);
1248 }