proto/ospf/ospf.h

   1 /*
   2  *      BIRD -- OSPF
   3  *
   4  *      (c) 1999--2005 Ondrej Filip <feela@network.cz>
   5  *
   6  *      Can be freely distributed and used under the terms of the GNU GPL.
   7  */
   8
   9 #ifndef _BIRD_OSPF_H_
  10 #define _BIRD_OSPF_H_
  11
  12 #define MAXNETS 10
  13 #define OSPF_MAX_PKT_SIZE 65535
  14 /*
  15  * RFC 2328 says, maximum packet size is 65535 (IP packet size
  16  * limit). Really a bit less for OSPF, because this contains also IP
  17  * header. This could be too much for small systems, so I normally
  18  * allocate 2*mtu (i found one cisco sending packets mtu+16). OSPF
  19  * packets are almost always sent small enough to not be fragmented.
  20  */
  21
  22 #ifdef LOCAL_DEBUG
  23 #define OSPF_FORCE_DEBUG 1
  24 #else
  25 #define OSPF_FORCE_DEBUG 0
  26 #endif
  27 #define OSPF_TRACE(flags, msg, args...) do { if ((p->debug & flags) || OSPF_FORCE_DEBUG) \
  28   log(L_TRACE "%s: " msg, p->name , ## args ); } while(0)
  29
  30 #define OSPF_PACKET(dumpfn, buffer, msg, args...) \
  31 do { if ((p->debug & D_PACKETS) || OSPF_FORCE_DEBUG) \
  32 { log(L_TRACE "%s: " msg, p->name, ## args ); dumpfn(p, buffer); } } while(0)
  33
  34
  35 #include "nest/bird.h"
  36
  37 #include "lib/checksum.h"
  38 #include "lib/ip.h"
  39 #include "lib/lists.h"
  40 #include "lib/slists.h"
  41 #include "lib/socket.h"
  42 #include "lib/timer.h"
  43 #include "lib/resource.h"
  44 #include "nest/protocol.h"
  45 #include "nest/iface.h"
  46 #include "nest/route.h"
  47 #include "nest/cli.h"
  48 #include "nest/locks.h"
  49 #include "nest/bfd.h"
  50 #include "conf/conf.h"
  51 #include "lib/string.h"
  52
  53 #define OSPF_PROTO 89
  54
  55 #ifndef IPV6
  56 #define OSPFv2 1
  57 #define OSPF_VERSION 2
  58 #define OSPF_VLINK_MTU 576                      /* RFC 2328 A.1 */
  59 #define AllSPFRouters ipa_from_u32(0xe0000005)  /* 224.0.0.5 */
  60 #define AllDRouters ipa_from_u32(0xe0000006)    /* 224.0.0.6 */
  61 #else
  62 #define OSPFv3 1
  63 #define OSPF_VERSION 3
  64 #define OSPF_VLINK_MTU 1280                     /* RFC 5340 A.1 */
  65 #define AllSPFRouters _MI(0xFF020000, 0, 0, 5)  /* FF02::5 */
  66 #define AllDRouters   _MI(0xFF020000, 0, 0, 6)  /* FF02::6 */
  67 #endif
  68
  69
  70 #define LSREFRESHTIME 1800      /* 30 minutes */
  71 #define MINLSINTERVAL 5
  72 #define MINLSARRIVAL 1
  73 #define LSINFINITY 0xffffff
  74
  75 #define DEFAULT_OSPFTICK 1
  76 #define DEFAULT_RFC1583 0       /* compatibility with rfc1583 */
  77 #define DEFAULT_STUB_COST 1000
  78 #define DEFAULT_ECMP_LIMIT 16
  79 #define DEFAULT_TRANSINT 40
  80
  81
  82 struct ospf_config
  83 {
  84   struct proto_config c;
  85   unsigned tick;
  86   byte rfc1583;
  87   byte stub_router;
  88   byte abr;
  89   int ecmp;
  90   list area_list;               /* list of struct ospf_area_config */
  91   list vlink_list;              /* list of struct ospf_iface_patt */
  92 };
  93
  94 struct nbma_node
  95 {
  96   node n;
  97   ip_addr ip;
  98   byte eligible;
  99   byte found;
 100 };
 101
 102 struct area_net_config
 103 {
 104   node n;
 105   struct prefix px;
 106   int hidden;
 107   u32 tag;
 108 };
 109
 110 struct area_net
 111 {
 112   struct fib_node fn;
 113   int hidden;
 114   int active;
 115   u32 metric;
 116   u32 tag;
 117 };
 118
 119 struct ospf_stubnet_config
 120 {
 121   node n;
 122   struct prefix px;
 123   int hidden, summary;
 124   u32 cost;
 125 };
 126
 127 struct ospf_area_config
 128 {
 129   node n;
 130   u32 areaid;
 131   u32 default_cost;             /* Cost of default route for stub areas */
 132   u8 type;                      /* Area type (standard, stub, NSSA), represented
 133                                    by option flags (OPT_E, OPT_N) */
 134   u8 summary;                   /* Import summaries to this stub/NSSA area, valid for ABR */
 135   u8 default_nssa;              /* Generate default NSSA route for NSSA+summary area */
 136   u8 translator;                /* Translator role, for NSSA ABR */
 137   u32 transint;                 /* Translator stability interval */
 138   list patt_list;
 139   list net_list;                /* List of aggregate networks for that area */
 140   list enet_list;               /* List of aggregate external (NSSA) networks */
 141   list stubnet_list;            /* List of stub networks added to Router LSA */
 142 };
 143
 144
 145 /* Option flags */
 146
 147 #define OPT_E   0x02
 148 #define OPT_N   0x08
 149 #define OPT_DC  0x20
 150
 151 #ifdef OSPFv2
 152 #define OPT_P   0x08            /* flags P and N share position, see NSSA RFC */
 153 #define OPT_EA  0x10
 154
 155 /* VEB flags are are stored independently in 'u16 options' */
 156 #define OPT_RT_B  (0x01 << 8)
 157 #define OPT_RT_E  (0x02 << 8)
 158 #define OPT_RT_V  (0x04 << 8)
 159 #define OPT_RT_NT (0x10 << 8)
 160 #endif
 161
 162 #ifdef OSPFv3
 163 #define OPT_V6  0x01
 164 #define OPT_R   0x10
 165
 166 /* VEB flags are are stored together with options in 'u32 options' */
 167 #define OPT_RT_B  (0x01 << 24)
 168 #define OPT_RT_E  (0x02 << 24)
 169 #define OPT_RT_V  (0x04 << 24)
 170 #define OPT_RT_NT (0x10 << 24)
 171
 172 #define OPT_PX_NU 0x01
 173 #define OPT_PX_LA 0x02
 174 #define OPT_PX_P  0x08
 175 #define OPT_PX_DN 0x10
 176 #endif
 177
 178
 179 struct ospf_iface
 180 {
 181   node n;
 182   struct iface *iface;          /* Nest's iface, non-NULL (unless type OSPF_IT_VLINK) */
 183   struct ifa *addr;             /* IP prefix associated with that OSPF iface */
 184   struct ospf_area *oa;
 185   struct ospf_iface_patt *cf;
 186   pool *pool;
 187   sock *sk;                     /* IP socket (for DD ...) */
 188   list neigh_list;              /* List of neigbours */
 189   u32 cost;                     /* Cost of iface */
 190   u32 waitint;                  /* number of sec before changing state from wait */
 191   u32 rxmtint;                  /* number of seconds between LSA retransmissions */
 192   u32 pollint;                  /* Poll interval */
 193   u32 deadint;                  /* after "deadint" missing hellos is router dead */
 194   u32 iface_id;                 /* Interface ID (iface->index or new value for vlinks) */
 195   u32 vid;                      /* ID of peer of virtual link */
 196   ip_addr vip;                  /* IP of peer of virtual link */
 197   struct ospf_iface *vifa;      /* OSPF iface which the vlink goes through */
 198   struct ospf_area *voa;        /* OSPF area which the vlink goes through */
 199   u16 inftransdelay;            /* The estimated number of seconds it takes to
 200                                    transmit a Link State Update Packet over this
 201                                    interface.  LSAs contained in the update */
 202   u16 helloint;                 /* number of seconds between hello sending */
 203
 204 #ifdef OSPFv2
 205   list *passwords;
 206   u16 autype;
 207   u32 csn;                      /* Last used crypt seq number */
 208   bird_clock_t csn_use;         /* Last time when packet with that CSN was sent */
 209 #endif
 210
 211   ip_addr all_routers;          /*  */
 212   ip_addr drip;                 /* Designated router */
 213   ip_addr bdrip;                /* Backup DR */
 214   u32 drid;
 215   u32 bdrid;
 216   s16 rt_pos_beg;               /* Position of iface in Router-LSA, begin, inclusive */
 217   s16 rt_pos_end;               /* Position of iface in Router-LSA, end, exclusive */
 218
 219 #ifdef OSPFv3
 220   s16 px_pos_beg;               /* Position of iface in Rt Prefix-LSA, begin, inclusive */
 221   s16 px_pos_end;               /* Position of iface in Rt Prefix-LSA, end, exclusive */
 222
 223   u32 dr_iface_id;              /* if drid is valid, this is iface_id of DR (for connecting network) */
 224   u8 instance_id;               /* Used to differentiate between more OSPF
 225                                    instances on one interface */
 226 #endif
 227
 228   u8 type;                      /* OSPF view of type */
 229 #define OSPF_IT_BCAST 0
 230 #define OSPF_IT_NBMA 1
 231 #define OSPF_IT_PTP 2
 232 #define OSPF_IT_PTMP 3
 233 #define OSPF_IT_VLINK 4
 234 #define OSPF_IT_UNDEF 5
 235   u8 strictnbma;                /* Can I talk with unknown neighbors? */
 236   u8 stub;                      /* Inactive interface */
 237   u8 state;                     /* Interface state machine */
 238 #define OSPF_IS_DOWN 0          /* Not working */
 239 #define OSPF_IS_LOOP 1          /* Iface with no link */
 240 #define OSPF_IS_WAITING 2       /* Waiting for Wait timer */
 241 #define OSPF_IS_PTP 3           /* PTP operational */
 242 #define OSPF_IS_DROTHER 4       /* I'm on BCAST or NBMA and I'm not DR */
 243 #define OSPF_IS_BACKUP 5        /* I'm BDR */
 244 #define OSPF_IS_DR 6            /* I'm DR */
 245   timer *wait_timer;            /* WAIT timer */
 246   timer *hello_timer;           /* HELLOINT timer */
 247   timer *poll_timer;            /* Poll Interval - for NBMA */
 248 /* Default values for interface parameters */
 249 #define COST_D 10
 250 #define RXMTINT_D 5
 251 #define INFTRANSDELAY_D 1
 252 #define PRIORITY_D 1
 253 #define HELLOINT_D 10
 254 #define POLLINT_D 20
 255 #define DEADC_D 4
 256 #define WAIT_DMH 4
 257   /* Value of Wait timer - not found it in RFC * - using 4*HELLO */
 258
 259   struct top_hash_entry *net_lsa;       /* Originated network LSA */
 260   int orignet;                          /* Schedule network LSA origination */
 261 #ifdef OSPFv3
 262   int origlink;                         /* Schedule link LSA origination */
 263   struct top_hash_entry *link_lsa;      /* Originated link LSA */
 264   struct top_hash_entry *pxn_lsa;       /* Originated prefix LSA */
 265 #endif
 266   int fadj;                             /* Number of full adjacent neigh */
 267   list nbma_list;
 268   u8 priority;                  /* A router priority for DR election */
 269   u8 ioprob;
 270 #define OSPF_I_OK 0             /* Everything OK */
 271 #define OSPF_I_SK 1             /* Socket open failed */
 272 #define OSPF_I_LL 2             /* Missing link-local address (OSPFv3) */
 273   u8 sk_dr;                     /* Socket is a member of DRouters group */
 274   u8 marked;                    /* Used in OSPF reconfigure */
 275   u16 rxbuf;                    /* Buffer size */
 276   u8 check_link;                /* Whether iface link change is used */
 277   u8 ecmp_weight;               /* Weight used for ECMP */
 278   u8 ptp_netmask;               /* Send real netmask for P2P */
 279   u8 check_ttl;                 /* Check incoming packets for TTL 255 */
 280   u8 bfd;                       /* Use BFD on iface */
 281 };
 282
 283 struct ospf_md5
 284 {
 285   u16 zero;
 286   u8 keyid;
 287   u8 len;
 288   u32 csn;
 289 };
 290
 291 union ospf_auth
 292 {
 293   u8 password[8];
 294   struct ospf_md5 md5;
 295 };
 296
 297
 298 /* Packet types */
 299 #define HELLO_P 1               /* Hello */
 300 #define DBDES_P 2               /* Database description */
 301 #define LSREQ_P 3               /* Link state request */
 302 #define LSUPD_P 4               /* Link state update */
 303 #define LSACK_P 5               /* Link state acknowledgement */
 304
 305 /* Area IDs */
 306 #define BACKBONE 0
 307
 308
 309 struct immsb
 310 {
 311 #ifdef CPU_BIG_ENDIAN
 312   u8 padding:5;
 313   u8 i:1;
 314   u8 m:1;
 315   u8 ms:1;
 316 #else
 317   u8 ms:1;
 318   u8 m:1;
 319   u8 i:1;
 320   u8 padding:5;
 321 #endif
 322 };
 323
 324 union imms
 325 {
 326   u8 byte;
 327   struct immsb bit;
 328 };
 329 #define DBDES_MS 1
 330 #define DBDES_M 2
 331 #define DBDES_I 4
 332
 333
 334 #ifdef OSPFv2
 335
 336 struct ospf_packet
 337 {
 338   u8 version;
 339   u8 type;
 340   u16 length;
 341   u32 routerid;
 342   u32 areaid;
 343   u16 checksum;
 344   u16 autype;
 345   union ospf_auth u;
 346 };
 347
 348
 349 #else /* OSPFv3 packet descriptions */
 350
 351 struct ospf_packet
 352 {
 353   u8 version;
 354   u8 type;
 355   u16 length;
 356   u32 routerid;
 357   u32 areaid;
 358   u16 checksum;
 359   u8 instance_id;
 360   u8 zero;
 361 };
 362
 363
 364 #endif
 365
 366
 367
 368
 369 struct ospf_lsa_header
 370 {
 371   u16 age;                      /* LS Age */
 372 #define LSA_MAXAGE 3600         /* 1 hour */
 373 #define LSA_CHECKAGE 300        /* 5 minutes */
 374 #define LSA_MAXAGEDIFF 900      /* 15 minutes */
 375
 376 #ifdef OSPFv2
 377   u8 options;
 378   u8 type;
 379
 380 #define LSA_T_RT        1
 381 #define LSA_T_NET       2
 382 #define LSA_T_SUM_NET   3
 383 #define LSA_T_SUM_RT    4
 384 #define LSA_T_EXT       5
 385 #define LSA_T_NSSA      7
 386
 387 #define LSA_SCOPE_AREA  0x2000
 388 #define LSA_SCOPE_AS    0x4000
 389
 390 #define LSA_SCOPE(lsa)  (((lsa)->type == LSA_T_EXT) ? LSA_SCOPE_AS : LSA_SCOPE_AREA)
 391
 392 #else /* OSPFv3 */
 393   u16 type;
 394
 395 #define LSA_T_RT        0x2001
 396 #define LSA_T_NET       0x2002
 397 #define LSA_T_SUM_NET   0x2003
 398 #define LSA_T_SUM_RT    0x2004
 399 #define LSA_T_EXT       0x4005
 400 #define LSA_T_NSSA      0x2007
 401 #define LSA_T_LINK      0x0008
 402 #define LSA_T_PREFIX    0x2009
 403
 404 #define LSA_UBIT        0x8000
 405
 406 #define LSA_SCOPE_LINK  0x0000
 407 #define LSA_SCOPE_AREA  0x2000
 408 #define LSA_SCOPE_AS    0x4000
 409 #define LSA_SCOPE_RES   0x6000
 410 #define LSA_SCOPE_MASK  0x6000
 411
 412 #define LSA_SCOPE(lsa)  ((lsa)->type & LSA_SCOPE_MASK)
 413 #endif
 414
 415   u32 id;
 416   u32 rt;                       /* Advertising router */
 417   s32 sn;                       /* LS Sequence number */
 418 #define LSA_INITSEQNO ((s32) 0x80000001)
 419 #define LSA_MAXSEQNO ((s32) 0x7fffffff)
 420   u16 checksum;
 421   u16 length;
 422 };
 423
 424
 425 #define LSART_PTP 1
 426 #define LSART_NET 2
 427 #define LSART_STUB 3
 428 #define LSART_VLNK 4
 429
 430
 431 #ifdef OSPFv2
 432
 433 struct ospf_lsa_rt
 434 {
 435 #ifdef CPU_BIG_ENDIAN
 436   u16 options;  /* VEB flags only */
 437   u16 links;
 438 #else
 439   u16 links;
 440   u16 options;  /* VEB flags only */
 441 #endif
 442 };
 443
 444 struct ospf_lsa_rt_link
 445 {
 446   u32 id;
 447   u32 data;
 448 #ifdef CPU_BIG_ENDIAN
 449   u8 type;
 450   u8 padding;
 451   u16 metric;
 452 #else
 453   u16 metric;
 454   u8 padding;
 455   u8 type;
 456 #endif
 457 };
 458
 459 struct ospf_lsa_net
 460 {
 461   ip_addr netmask;
 462   u32 routers[];
 463 };
 464
 465 struct ospf_lsa_sum
 466 {
 467   ip_addr netmask;
 468   u32 metric;
 469 };
 470
 471 struct ospf_lsa_ext
 472 {
 473   ip_addr netmask;
 474   u32 metric;
 475   ip_addr fwaddr;
 476   u32 tag;
 477 };
 478
 479 #define LSA_SUM_TOS  0xFF000000
 480 #define LSA_EXT_TOS  0x7F000000
 481 #define LSA_EXT_EBIT 0x80000000
 482
 483 /* Endianity swap for lsa->type */
 484 #define ntoht(x) x
 485 #define htont(x) x
 486
 487
 488 #else  /* OSPFv3 */
 489
 490 struct ospf_lsa_rt
 491 {
 492   u32 options;
 493 };
 494
 495 struct ospf_lsa_rt_link
 496 {
 497 #ifdef CPU_BIG_ENDIAN
 498   u8 type;
 499   u8 padding;
 500   u16 metric;
 501 #else
 502   u16 metric;
 503   u8 padding;
 504   u8 type;
 505 #endif
 506   u32 lif;      /* Local interface ID */
 507   u32 nif;      /* Neighbor interface ID */
 508   u32 id;       /* Neighbor router ID */
 509 };
 510
 511 struct ospf_lsa_net
 512 {
 513   u32 options;
 514   u32 routers[];
 515 };
 516
 517 struct ospf_lsa_sum_net
 518 {
 519   u32 metric;
 520   u32 prefix[];
 521 };
 522
 523 struct ospf_lsa_sum_rt
 524 {
 525   u32 options;
 526   u32 metric;
 527   u32 drid;
 528 };
 529
 530 struct ospf_lsa_ext
 531 {
 532   u32 metric;
 533   u32 rest[];
 534 };
 535
 536 struct ospf_lsa_link
 537 {
 538   u32 options;
 539   ip_addr lladdr;
 540   u32 pxcount;
 541   u32 rest[];
 542 };
 543
 544 struct ospf_lsa_prefix
 545 {
 546 #ifdef CPU_BIG_ENDIAN
 547   u16 pxcount;
 548   u16 ref_type;
 549 #else
 550   u16 ref_type;
 551   u16 pxcount;
 552 #endif
 553   u32 ref_id;
 554   u32 ref_rt;
 555   u32 rest[];
 556 };
 557
 558 #define LSA_EXT_EBIT 0x4000000
 559 #define LSA_EXT_FBIT 0x2000000
 560 #define LSA_EXT_TBIT 0x1000000
 561
 562 /* Endianity swap for lsa->type */
 563 #define ntoht(x) ntohs(x)
 564 #define htont(x) htons(x)
 565
 566 #endif
 567
 568 #define METRIC_MASK  0x00FFFFFF
 569 #define OPTIONS_MASK 0x00FFFFFF
 570
 571 static inline unsigned
 572 lsa_rt_count(struct ospf_lsa_header *lsa)
 573 {
 574   return (lsa->length - sizeof(struct ospf_lsa_header) - sizeof(struct ospf_lsa_rt))
 575     / sizeof(struct ospf_lsa_rt_link);
 576 }
 577
 578 static inline unsigned
 579 lsa_net_count(struct ospf_lsa_header *lsa)
 580 {
 581   return (lsa->length - sizeof(struct ospf_lsa_header) - sizeof(struct ospf_lsa_net))
 582     / sizeof(u32);
 583 }
 584
 585
 586 #ifdef OSPFv3
 587
 588 #define IPV6_PREFIX_SPACE(x) ((((x) + 63) / 32) * 4)
 589 #define IPV6_PREFIX_WORDS(x) (((x) + 63) / 32)
 590
 591 static inline u32 *
 592 lsa_get_ipv6_prefix(u32 *buf, ip_addr *addr, int *pxlen, u8 *pxopts, u16 *rest)
 593 {
 594   u8 pxl = (*buf >> 24);
 595   *pxopts = (*buf >> 16);
 596   *rest = *buf;
 597   *pxlen = pxl;
 598   buf++;
 599
 600   *addr = IPA_NONE;
 601
 602   if (pxl > 0)
 603     _I0(*addr) = *buf++;
 604   if (pxl > 32)
 605     _I1(*addr) = *buf++;
 606   if (pxl > 64)
 607     _I2(*addr) = *buf++;
 608   if (pxl > 96)
 609     _I3(*addr) = *buf++;
 610
 611   /* Clean up remaining bits */
 612   if (pxl < 128)
 613     addr->addr[pxl / 32] &= u32_mkmask(pxl % 32);
 614
 615   return buf;
 616 }
 617
 618 static inline u32 *
 619 lsa_get_ipv6_addr(u32 *buf, ip_addr *addr)
 620 {
 621   *addr = *(ip_addr *) buf;
 622   return buf + 4;
 623 }
 624
 625 static inline u32 *
 626 put_ipv6_prefix(u32 *buf, ip_addr addr, u8 pxlen, u8 pxopts, u16 lh)
 627 {
 628   *buf++ = ((pxlen << 24) | (pxopts << 16) | lh);
 629
 630   if (pxlen > 0)
 631     *buf++ = _I0(addr);
 632   if (pxlen > 32)
 633     *buf++ = _I1(addr);
 634   if (pxlen > 64)
 635     *buf++ = _I2(addr);
 636   if (pxlen > 96)
 637     *buf++ = _I3(addr);
 638   return buf;
 639 }
 640
 641 static inline u32 *
 642 put_ipv6_addr(u32 *buf, ip_addr addr)
 643 {
 644   *(ip_addr *) buf = addr;
 645   return buf + 4;
 646 }
 647
 648 #endif
 649
 650
 651
 652 struct ospf_lsreq_header
 653 {
 654   u32 type;
 655   u32 id;
 656   u32 rt;                       /* Advertising router */
 657 };
 658
 659 struct l_lsr_head
 660 {
 661   node n;
 662   struct ospf_lsreq_header lsh;
 663 };
 664
 665
 666 struct ospf_neighbor
 667 {
 668   node n;
 669   pool *pool;
 670   struct ospf_iface *ifa;
 671   u8 state;
 672 #define NEIGHBOR_DOWN 0
 673 #define NEIGHBOR_ATTEMPT 1
 674 #define NEIGHBOR_INIT 2
 675 #define NEIGHBOR_2WAY 3
 676 #define NEIGHBOR_EXSTART 4
 677 #define NEIGHBOR_EXCHANGE 5
 678 #define NEIGHBOR_LOADING 6
 679 #define NEIGHBOR_FULL 7
 680   timer *inactim;               /* Inactivity timer */
 681   union imms imms;              /* I, M, Master/slave received */
 682   u32 dds;                      /* DD Sequence number being sent */
 683   u32 ddr;                      /* last Dat Des packet received */
 684   union imms myimms;            /* I, M Master/slave */
 685   u32 rid;                      /* Router ID */
 686   ip_addr ip;                   /* IP of it's interface */
 687   u8 priority;                  /* Priority */
 688   u8 adj;                       /* built adjacency? */
 689   u32 options;                  /* Options received */
 690
 691   /* dr and bdr store IP address in OSPFv2 and router ID in OSPFv3,
 692      we use the same type to simplify handling */
 693   u32 dr;                       /* Neigbour's idea of DR */
 694   u32 bdr;                      /* Neigbour's idea of BDR */
 695
 696 #ifdef OSPFv3
 697   u32 iface_id;                 /* ID of Neighbour's iface connected to common network */
 698 #endif
 699
 700   siterator dbsi;               /* Database summary list iterator */
 701   slist lsrql;                  /* Link state request */
 702   struct top_graph *lsrqh;      /* LSA graph */
 703   siterator lsrqi;
 704   slist lsrtl;                  /* Link state retransmission list */
 705   siterator lsrti;
 706   struct top_graph *lsrth;
 707   void *ldbdes;                 /* Last database description packet */
 708   timer *rxmt_timer;            /* RXMT timer */
 709   list ackl[2];
 710 #define ACKL_DIRECT 0
 711 #define ACKL_DELAY 1
 712   timer *ackd_timer;            /* Delayed ack timer */
 713   struct bfd_request *bfd_req;  /* BFD request, if BFD is used */
 714   u32 csn;                      /* Last received crypt seq number (for MD5) */
 715 };
 716
 717 /* Definitions for interface state machine */
 718 #define ISM_UP 0                /* Interface Up */
 719 #define ISM_WAITF 1             /* Wait timer fired */
 720 #define ISM_BACKS 2             /* Backup seen */
 721 #define ISM_NEICH 3             /* Neighbor change */
 722 #define ISM_LOOP 4              /* Link down */
 723 #define ISM_UNLOOP 5            /* Link up */
 724 #define ISM_DOWN 6              /* Interface down */
 725
 726 /* Definitions for neighbor state machine */
 727 #define INM_HELLOREC 0          /* Hello Received */
 728 #define INM_START 1             /* Neighbor start - for NBMA */
 729 #define INM_2WAYREC 2           /* 2-Way received */
 730 #define INM_NEGDONE 3           /* Negotiation done */
 731 #define INM_EXDONE 4            /* Exchange done */
 732 #define INM_BADLSREQ 5          /* Bad LS Request */
 733 #define INM_LOADDONE 6          /* Load done */
 734 #define INM_ADJOK 7             /* AdjOK? */
 735 #define INM_SEQMIS 8            /* Sequence number mismatch */
 736 #define INM_1WAYREC 9           /* 1-Way */
 737 #define INM_KILLNBR 10          /* Kill Neighbor */
 738 #define INM_INACTTIM 11         /* Inactivity timer */
 739 #define INM_LLDOWN 12           /* Line down */
 740
 741 struct ospf_area
 742 {
 743   node n;
 744   u32 areaid;
 745   struct ospf_area_config *ac;  /* Related area config */
 746   struct top_hash_entry *rt;    /* My own router LSA */
 747   struct top_hash_entry *pxr_lsa; /* Originated prefix LSA */
 748   list cand;                    /* List of candidates for RT calc. */
 749   struct fib net_fib;           /* Networks to advertise or not */
 750   struct fib enet_fib;          /* External networks for NSSAs */
 751   u32 options;                  /* Optional features */
 752   byte origrt;                  /* Rt lsa origination scheduled? */
 753   byte trcap;                   /* Transit capability? */
 754   byte marked;                  /* Used in OSPF reconfigure */
 755   byte translate;               /* Translator state (TRANS_*), for NSSA ABR  */
 756   timer *translator_timer;      /* For NSSA translator switch */
 757   struct proto_ospf *po;
 758   struct fib rtr;               /* Routing tables for routers */
 759 };
 760
 761 #define TRANS_OFF       0
 762 #define TRANS_ON        1
 763 #define TRANS_WAIT      2       /* Waiting before the end of translation */
 764
 765 struct proto_ospf
 766 {
 767   struct proto proto;
 768   timer *disp_timer;            /* OSPF proto dispatcher */
 769   unsigned tick;
 770   struct top_graph *gr;         /* LSA graph */
 771   slist lsal;                   /* List of all LSA's */
 772   int calcrt;                   /* Routing table calculation scheduled?
 773                                    0=no, 1=normal, 2=forced reload */
 774   list iface_list;              /* Interfaces we really use */
 775   list area_list;
 776   int areano;                   /* Number of area I belong to */
 777   struct fib rtf;               /* Routing table */
 778   byte rfc1583;                 /* RFC1583 compatibility */
 779   byte stub_router;             /* Do not forward transit traffic */
 780   byte ebit;                    /* Did I originate any ext lsa? */
 781   byte ecmp;                    /* Maximal number of nexthops in ECMP route, or 0 */
 782   struct ospf_area *backbone;   /* If exists */
 783   void *lsab;                   /* LSA buffer used when originating router LSAs */
 784   int lsab_size, lsab_used;
 785   linpool *nhpool;              /* Linpool used for next hops computed in SPF */
 786   u32 router_id;
 787   u32 last_vlink_id;            /* Interface IDs for vlinks (starts at 0x80000000) */
 788 };
 789
 790 struct ospf_iface_patt
 791 {
 792   struct iface_patt i;
 793   u32 type;
 794   u32 stub;
 795   u32 cost;
 796   u32 helloint;
 797   u32 rxmtint;
 798   u32 pollint;
 799   u32 waitint;
 800   u32 deadc;
 801   u32 deadint;
 802   u32 inftransdelay;
 803   list nbma_list;
 804   u32 priority;
 805   u32 voa;
 806   u32 vid;
 807   int tx_tos;
 808   int tx_priority;
 809   u16 rxbuf;
 810 #define OSPF_RXBUF_NORMAL 0
 811 #define OSPF_RXBUF_LARGE 1
 812 #define OSPF_RXBUF_MINSIZE 256  /* Minimal allowed size */
 813   u16 autype;                   /* Not really used in OSPFv3 */
 814 #define OSPF_AUTH_NONE 0
 815 #define OSPF_AUTH_SIMPLE 1
 816 #define OSPF_AUTH_CRYPT 2
 817 #define OSPF_AUTH_CRYPT_SIZE 16
 818   u8 strictnbma;
 819   u8 check_link;
 820   u8 ecmp_weight;
 821   u8 real_bcast;                /* Not really used in OSPFv3 */
 822   u8 ptp_netmask;               /* bool + 2 for unspecified */
 823   u8 ttl_security;              /* bool + 2 for TX only */
 824   u8 bfd;
 825
 826 #ifdef OSPFv2
 827   list *passwords;
 828 #endif
 829
 830 #ifdef OSPFv3
 831   u8 instance_id;
 832 #endif
 833 };
 834
 835 int ospf_import_control(struct proto *p, rte **new, ea_list **attrs,
 836                         struct linpool *pool);
 837 struct ea_list *ospf_make_tmp_attrs(struct rte *rt, struct linpool *pool);
 838 void ospf_store_tmp_attrs(struct rte *rt, struct ea_list *attrs);
 839 void schedule_rt_lsa(struct ospf_area *oa);
 840 void schedule_rtcalc(struct proto_ospf *po);
 841 void schedule_net_lsa(struct ospf_iface *ifa);
 842
 843 struct ospf_area *ospf_find_area(struct proto_ospf *po, u32 aid);
 844 static inline struct ospf_area *ospf_main_area(struct proto_ospf *po)
 845 { return (po->areano == 1) ? HEAD(po->area_list) : po->backbone; }
 846
 847 static inline int oa_is_stub(struct ospf_area *oa)
 848 { return (oa->options & (OPT_E | OPT_N)) == 0; }
 849 static inline int oa_is_ext(struct ospf_area *oa)
 850 { return oa->options & OPT_E; }
 851 static inline int oa_is_nssa(struct ospf_area *oa)
 852 { return oa->options & OPT_N; }
 853
 854
 855 #ifdef OSPFv3
 856 void schedule_link_lsa(struct ospf_iface *ifa);
 857 #else
 858 static inline void schedule_link_lsa(struct ospf_iface *ifa UNUSED) {}
 859 #endif
 860
 861 void ospf_sh_neigh(struct proto *p, char *iff);
 862 void ospf_sh(struct proto *p);
 863 void ospf_sh_iface(struct proto *p, char *iff);
 864 void ospf_sh_state(struct proto *p, int verbose, int reachable);
 865
 866 #define SH_ROUTER_SELF 0xffffffff
 867
 868 struct lsadb_show_data {
 869   struct symbol *name;  /* Protocol to request data from */
 870   u16 type;             /* LSA Type, 0 -> all */
 871   u16 scope;            /* Scope, 0 -> all, hack to handle link scope as 1 */
 872   u32 area;             /* Specified for area scope */
 873   u32 lsid;             /* LSA ID, 0 -> all */
 874   u32 router;           /* Advertising router, 0 -> all */
 875 };
 876
 877 void ospf_sh_lsadb(struct lsadb_show_data *ld);
 878
 879
 880 #define EA_OSPF_METRIC1 EA_CODE(EAP_OSPF, 0)
 881 #define EA_OSPF_METRIC2 EA_CODE(EAP_OSPF, 1)
 882 #define EA_OSPF_TAG     EA_CODE(EAP_OSPF, 2)
 883 #define EA_OSPF_ROUTER_ID EA_CODE(EAP_OSPF, 3)
 884
 885 #include "proto/ospf/rt.h"
 886 #include "proto/ospf/hello.h"
 887 #include "proto/ospf/packet.h"
 888 #include "proto/ospf/iface.h"
 889 #include "proto/ospf/neighbor.h"
 890 #include "proto/ospf/topology.h"
 891 #include "proto/ospf/dbdes.h"
 892 #include "proto/ospf/lsreq.h"
 893 #include "proto/ospf/lsupd.h"
 894 #include "proto/ospf/lsack.h"
 895 #include "proto/ospf/lsalib.h"
 896
 897 #endif /* _BIRD_OSPF_H_ */