proto/ospf/ospf.h

   1 /*
   2  *      BIRD -- OSPF
   3  *
   4  *      (c) 1999--2005 Ondrej Filip <feela@network.cz>
   5  *      (c) 2009--2014 Ondrej Zajicek <santiago@crfreenet.org>
   6  *      (c) 2009--2014 CZ.NIC z.s.p.o.
   7  *
   8  *      Can be freely distributed and used under the terms of the GNU GPL.
   9  */
  10
  11 #ifndef _BIRD_OSPF_H_
  12 #define _BIRD_OSPF_H_
  13
  14 #include "nest/bird.h"
  15
  16 #include "lib/checksum.h"
  17 #include "lib/idm.h"
  18 #include "lib/lists.h"
  19 #include "lib/slists.h"
  20 #include "lib/socket.h"
  21 #include "sysdep/unix/timer.h"
  22 #include "lib/resource.h"
  23 #include "nest/protocol.h"
  24 #include "nest/iface.h"
  25 #include "nest/route.h"
  26 #include "nest/cli.h"
  27 #include "nest/locks.h"
  28 #include "nest/bfd.h"
  29 #include "conf/conf.h"
  30 #include "lib/string.h"
  31
  32
  33 #ifdef LOCAL_DEBUG
  34 #define OSPF_FORCE_DEBUG 1
  35 #else
  36 #define OSPF_FORCE_DEBUG 0
  37 #endif
  38
  39
  40 #define OSPF_TRACE(flags, msg, args...) \
  41   do { if ((p->p.debug & flags) || OSPF_FORCE_DEBUG) \
  42     log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
  43
  44 #define OSPF_PACKET(dumpfn, buffer, msg, args...) \
  45   do { if ((p->p.debug & D_PACKETS) || OSPF_FORCE_DEBUG)                \
  46     { log(L_TRACE "%s: " msg, p->p.name, ## args ); dumpfn(p, buffer); } } while(0)
  47
  48 #define LOG_PKT(msg, args...) \
  49   log_rl(&p->log_pkt_tbf, L_REMOTE "%s: " msg, p->p.name, args)
  50
  51 #define LOG_PKT_AUTH(msg, args...) \
  52   log_rl(&p->log_pkt_tbf, L_AUTH "%s: " msg, p->p.name, args)
  53
  54 #define LOG_PKT_WARN(msg, args...) \
  55   log_rl(&p->log_pkt_tbf, L_WARN "%s: " msg, p->p.name, args)
  56
  57 #define LOG_LSA1(msg, args...) \
  58   log_rl(&p->log_lsa_tbf, L_REMOTE "%s: " msg, p->p.name, args)
  59
  60 #define LOG_LSA2(msg, args...) \
  61   do { if (! p->log_lsa_tbf.mark) \
  62     log(L_REMOTE "%s: " msg, p->p.name, args); } while(0)
  63
  64
  65 #define OSPF_PROTO 89
  66
  67 #define LSREFRESHTIME 1800      /* 30 minutes */
  68 #define MINLSINTERVAL 5
  69 #define MINLSARRIVAL 1
  70 #define LSINFINITY 0xffffff
  71
  72 #define OSPF_DEFAULT_TICK 1
  73 #define OSPF_DEFAULT_STUB_COST 1000
  74 #define OSPF_DEFAULT_ECMP_LIMIT 16
  75 #define OSPF_DEFAULT_TRANSINT 40
  76
  77 #define OSPF_MIN_PKT_SIZE 256
  78 #define OSPF_MAX_PKT_SIZE 65535
  79
  80 #define OSPF_VLINK_ID_OFFSET 0x80000000
  81
  82 struct ospf_config
  83 {
  84   struct proto_config c;
  85   uint tick;
  86   u8 ospf2;
  87   u8 rfc1583;
  88   u8 stub_router;
  89   u8 merge_external;
  90   u8 instance_id;
  91   u8 abr;
  92   u8 asbr;
  93   int ecmp;
  94   list area_list;               /* list of area configs (struct ospf_area_config) */
  95   list vlink_list;              /* list of configured vlinks (struct ospf_iface_patt) */
  96 };
  97
  98 struct ospf_area_config
  99 {
 100   node n;
 101   u32 areaid;
 102   u32 default_cost;             /* Cost of default route for stub areas
 103                                    (With possible LSA_EXT3_EBIT for NSSA areas) */
 104   u8 type;                      /* Area type (standard, stub, NSSA), represented
 105                                    by option flags (OPT_E, OPT_N) */
 106   u8 summary;                   /* Import summaries to this stub/NSSA area, valid for ABR */
 107   u8 default_nssa;              /* Generate default NSSA route for NSSA+summary area */
 108   u8 translator;                /* Translator role, for NSSA ABR */
 109   u32 transint;                 /* Translator stability interval */
 110   list patt_list;               /* List of iface configs (struct ospf_iface_patt) */
 111   list net_list;                /* List of aggregate networks for that area */
 112   list enet_list;               /* List of aggregate external (NSSA) networks */
 113   list stubnet_list;            /* List of stub networks added to Router LSA */
 114 };
 115
 116 struct area_net_config
 117 {
 118   node n;
 119   net_addr prefix;
 120   u32 tag;
 121   u8 hidden;
 122 };
 123
 124 struct area_net
 125 {
 126   u32 metric;                   /* With possible LSA_EXT3_EBIT for NSSA area nets */
 127   u32 tag;
 128   u8 hidden;
 129   u8 active;
 130   struct fib_node fn;
 131 };
 132
 133 struct ospf_stubnet_config
 134 {
 135   node n;
 136   net_addr prefix;
 137   u32 cost;
 138   u8 hidden;
 139   u8 summary;
 140 };
 141
 142 struct nbma_node
 143 {
 144   node n;
 145   ip_addr ip;
 146   byte eligible;
 147   byte found;
 148 };
 149
 150 struct ospf_iface_patt
 151 {
 152   struct iface_patt i;
 153   u32 type;
 154   u32 stub;
 155   u32 cost;
 156   u32 helloint;
 157   u32 rxmtint;
 158   u32 pollint;
 159   u32 waitint;
 160   u32 deadc;
 161   u32 deadint;
 162   u32 inftransdelay;
 163   list nbma_list;
 164   u32 priority;
 165   u32 voa;
 166   u32 vid;
 167   int tx_tos;
 168   int tx_priority;
 169   u16 tx_length;
 170   u16 rx_buffer;
 171
 172 #define OSPF_RXBUF_MINSIZE 256  /* Minimal allowed size */
 173   u8 instance_id;
 174   u8 autype;                    /* OSPF_AUTH_*, not really used in OSPFv3 */
 175   u8 strictnbma;
 176   u8 check_link;
 177   u8 ecmp_weight;
 178   u8 link_lsa_suppression;
 179   u8 real_bcast;                /* Not really used in OSPFv3 */
 180   u8 ptp_netmask;               /* bool + 2 for unspecified */
 181   u8 ttl_security;              /* bool + 2 for TX only */
 182   u8 bfd;
 183   list *passwords;
 184 };
 185
 186 /* Default values for interface parameters */
 187 #define COST_D 10
 188 #define RXMTINT_D 5
 189 #define INFTRANSDELAY_D 1
 190 #define PRIORITY_D 1
 191 #define HELLOINT_D 10
 192 #define POLLINT_D 20
 193 #define DEADC_D 4
 194 #define WAIT_DMH 4
 195   /* Value of Wait timer - not found it in RFC * - using 4*HELLO */
 196
 197
 198
 199 struct ospf_proto
 200 {
 201   struct proto p;
 202   timer *disp_timer;            /* OSPF proto dispatcher */
 203   uint tick;
 204   struct top_graph *gr;         /* LSA graph */
 205   slist lsal;                   /* List of all LSA's */
 206   int calcrt;                   /* Routing table calculation scheduled?
 207                                    0=no, 1=normal, 2=forced reload */
 208   list iface_list;              /* List of OSPF interfaces (struct ospf_iface) */
 209   list area_list;               /* List of OSPF areas (struct ospf_area) */
 210   int areano;                   /* Number of area I belong to */
 211   int padj;                     /* Number of neighbors in Exchange or Loading state */
 212   struct fib rtf;               /* Routing table */
 213   struct idm idm;               /* OSPFv3 LSA ID map */
 214   byte ospf2;                   /* OSPF v2 or v3 */
 215   byte rfc1583;                 /* RFC1583 compatibility */
 216   byte stub_router;             /* Do not forward transit traffic */
 217   byte merge_external;          /* Should i merge external routes? */
 218   byte asbr;                    /* May i originate any ext/NSSA lsa? */
 219   byte ecmp;                    /* Maximal number of nexthops in ECMP route, or 0 */
 220   struct ospf_area *backbone;   /* If exists */
 221   event *flood_event;           /* Event for flooding LS updates */
 222   void *lsab;                   /* LSA buffer used when originating router LSAs */
 223   int lsab_size, lsab_used;
 224   linpool *nhpool;              /* Linpool used for next hops computed in SPF */
 225   sock *vlink_sk;               /* IP socket used for vlink TX */
 226   u32 router_id;
 227   u32 last_vlink_id;            /* Interface IDs for vlinks (starts at 0x80000000) */
 228   struct tbf log_pkt_tbf;       /* TBF for packet messages */
 229   struct tbf log_lsa_tbf;       /* TBF for LSA messages */
 230 };
 231
 232 struct ospf_area
 233 {
 234   node n;
 235   u32 areaid;
 236   struct ospf_area_config *ac;  /* Related area config */
 237   struct top_hash_entry *rt;    /* My own router LSA */
 238   struct top_hash_entry *pxr_lsa; /* Originated prefix LSA */
 239   list cand;                    /* List of candidates for RT calc. */
 240   struct fib net_fib;           /* Networks to advertise or not */
 241   struct fib enet_fib;          /* External networks for NSSAs */
 242   u32 options;                  /* Optional features */
 243   u8 update_rt_lsa;             /* Rt lsa origination scheduled? */
 244   u8 trcap;                     /* Transit capability? */
 245   u8 marked;                    /* Used in OSPF reconfigure */
 246   u8 translate;                 /* Translator state (TRANS_*), for NSSA ABR  */
 247   timer *translator_timer;      /* For NSSA translator switch */
 248   struct ospf_proto *po;
 249   struct fib rtr;               /* Routing tables for routers */
 250 };
 251
 252
 253
 254 struct ospf_iface
 255 {
 256   node n;
 257   struct iface *iface;          /* Nest's iface (NULL for vlinks) */
 258   struct ifa *addr;             /* IP prefix associated with that OSPF iface */
 259   struct ospf_area *oa;
 260   struct ospf_iface_patt *cf;
 261   char *ifname;                 /* Interface name (iface->name), new one for vlinks */
 262
 263   pool *pool;
 264   sock *sk;                     /* IP socket */
 265   list neigh_list;              /* List of neighbors (struct ospf_neighbor) */
 266   u32 cost;                     /* Cost of iface */
 267   u32 waitint;                  /* number of sec before changing state from wait */
 268   u32 rxmtint;                  /* number of seconds between LSA retransmissions */
 269   u32 pollint;                  /* Poll interval */
 270   u32 deadint;                  /* after "deadint" missing hellos is router dead */
 271   u32 iface_id;                 /* Interface ID (iface->index or new value for vlinks) */
 272   u32 vid;                      /* ID of peer of virtual link */
 273   ip_addr vip;                  /* IP of peer of virtual link */
 274   struct ospf_iface *vifa;      /* OSPF iface which the vlink goes through */
 275   struct ospf_area *voa;        /* OSPF area which the vlink goes through */
 276   u16 inftransdelay;            /* The estimated number of seconds it takes to
 277                                    transmit a Link State Update Packet over this
 278                                    interface.  LSAs contained in the update */
 279   u16 helloint;                 /* number of seconds between hello sending */
 280   list *passwords;
 281   u32 csn;                      /* Last used crypt seq number */
 282   bird_clock_t csn_use;         /* Last time when packet with that CSN was sent */
 283   ip_addr all_routers;          /* Multicast (or broadcast) address for all routers */
 284   ip_addr des_routers;          /* Multicast (or NULL) address for designated routers */
 285   ip_addr drip;                 /* Designated router IP */
 286   ip_addr bdrip;                /* Backup DR IP */
 287   u32 drid;                     /* DR Router ID */
 288   u32 bdrid;                    /* BDR Router ID */
 289   s16 rt_pos_beg;               /* Position of iface in Router-LSA, begin, inclusive */
 290   s16 rt_pos_end;               /* Position of iface in Router-LSA, end, exclusive */
 291   s16 px_pos_beg;               /* Position of iface in Rt Prefix-LSA, begin, inclusive */
 292   s16 px_pos_end;               /* Position of iface in Rt Prefix-LSA, end, exclusive */
 293   u32 dr_iface_id;              /* if drid is valid, this is iface_id of DR (for connecting network) */
 294   u8 instance_id;               /* Used to differentiate between more OSPF
 295                                    instances on one interface */
 296   u8 autype;                    /* Authentication type (OSPF_AUTH_*) */
 297   u8 type;                      /* OSPF view of type (OSPF_IT_*) */
 298   u8 strictnbma;                /* Can I talk with unknown neighbors? */
 299   u8 stub;                      /* Inactive interface */
 300   u8 state;                     /* Interface state machine (OSPF_IS_*) */
 301   timer *wait_timer;            /* WAIT timer */
 302   timer *hello_timer;           /* HELLOINT timer */
 303   timer *poll_timer;            /* Poll Interval - for NBMA */
 304
 305   struct top_hash_entry *link_lsa;      /* Originated link LSA */
 306   struct top_hash_entry *net_lsa;       /* Originated network LSA */
 307   struct top_hash_entry *pxn_lsa;       /* Originated prefix LSA */
 308   struct top_hash_entry **flood_queue;  /* LSAs queued for LSUPD */
 309   u8 update_link_lsa;
 310   u8 update_net_lsa;
 311   u16 flood_queue_used;         /* The current number of LSAs in flood_queue */
 312   u16 flood_queue_size;         /* The maximum number of LSAs in flood_queue */
 313   int fadj;                     /* Number of fully adjacent neighbors */
 314   list nbma_list;
 315   u8 priority;                  /* A router priority for DR election */
 316   u8 ioprob;
 317 #define OSPF_I_OK 0             /* Everything OK */
 318 #define OSPF_I_SK 1             /* Socket open failed */
 319 #define OSPF_I_LL 2             /* Missing link-local address (OSPFv3) */
 320   u8 sk_dr;                     /* Socket is a member of designated routers group */
 321   u8 marked;                    /* Used in OSPF reconfigure, 2 for force restart */
 322   u16 rxbuf;                    /* Buffer size */
 323   u16 tx_length;                /* Soft TX packet length limit, usually MTU */
 324   u16 tx_hdrlen;                /* Expected packet header length, less than tx_length */
 325   u8 check_link;                /* Whether iface link change is used */
 326   u8 ecmp_weight;               /* Weight used for ECMP */
 327   u8 link_lsa_suppression;      /* Suppression of Link-LSA origination */
 328   u8 ptp_netmask;               /* Send real netmask for P2P */
 329   u8 check_ttl;                 /* Check incoming packets for TTL 255 */
 330   u8 bfd;                       /* Use BFD on iface */
 331 };
 332
 333 struct ospf_neighbor
 334 {
 335   node n;
 336   pool *pool;
 337   struct ospf_iface *ifa;
 338   u8 state;
 339   timer *inactim;               /* Inactivity timer */
 340   u8 imms;                      /* I, M, Master/slave received */
 341   u8 myimms;                    /* I, M Master/slave */
 342   u32 dds;                      /* DD Sequence number being sent */
 343   u32 ddr;                      /* last Dat Des packet received */
 344
 345   u32 rid;                      /* Router ID */
 346   ip_addr ip;                   /* IP of it's interface */
 347   u8 priority;                  /* Priority */
 348   u8 adj;                       /* built adjacency? */
 349   u32 options;                  /* Options received */
 350
 351   /* Entries dr and bdr store IP addresses in OSPFv2 and router IDs in
 352      OSPFv3, we use the same type to simplify handling */
 353   u32 dr;                       /* Neighbor's idea of DR */
 354   u32 bdr;                      /* Neighbor's idea of BDR */
 355   u32 iface_id;                 /* ID of Neighbour's iface connected to common network */
 356
 357   /* Database summary list iterator, controls initial dbdes exchange.
 358    * Advances in the LSA list as dbdes packets are sent.
 359    */
 360   siterator dbsi;               /* iterator of po->lsal */
 361
 362   /* Link state request list, controls initial LSA exchange.
 363    * Entries added when received in dbdes packets, removed as sent in lsreq packets.
 364    */
 365   slist lsrql;                  /* slist of struct top_hash_entry from n->lsrqh */
 366   struct top_graph *lsrqh;
 367   struct top_hash_entry *lsrqi; /* Pointer to the first unsent node in lsrql */
 368
 369   /* Link state retransmission list, controls LSA retransmission during flood.
 370    * Entries added as sent in lsupd packets, removed when received in lsack packets.
 371    * These entries hold ret_count in appropriate LSA entries.
 372    */
 373   slist lsrtl;                  /* slist of struct top_hash_entry from n->lsrth */
 374   struct top_graph *lsrth;
 375   timer *dbdes_timer;           /* DBDES exchange timer */
 376   timer *lsrq_timer;            /* LSA request timer */
 377   timer *lsrt_timer;            /* LSA retransmission timer */
 378   list ackl[2];
 379 #define ACKL_DIRECT 0
 380 #define ACKL_DELAY 1
 381   timer *ackd_timer;            /* Delayed ack timer */
 382   struct bfd_request *bfd_req;  /* BFD request, if BFD is used */
 383   void *ldd_buffer;             /* Last database description packet */
 384   u32 ldd_bsize;                /* Buffer size for ldd_buffer */
 385   u32 csn;                      /* Last received crypt seq number (for MD5) */
 386 };
 387
 388
 389 /* OSPF interface types */
 390 #define OSPF_IT_BCAST   0
 391 #define OSPF_IT_NBMA    1
 392 #define OSPF_IT_PTP     2
 393 #define OSPF_IT_PTMP    3
 394 #define OSPF_IT_VLINK   4
 395 #define OSPF_IT_UNDEF   5
 396
 397 /* OSPF interface states */
 398 #define OSPF_IS_DOWN    0       /* Not active */
 399 #define OSPF_IS_LOOP    1       /* Iface with no link */
 400 #define OSPF_IS_WAITING 2       /* Waiting for Wait timer */
 401 #define OSPF_IS_PTP     3       /* PTP operational */
 402 #define OSPF_IS_DROTHER 4       /* I'm on BCAST or NBMA and I'm not DR */
 403 #define OSPF_IS_BACKUP  5       /* I'm BDR */
 404 #define OSPF_IS_DR      6       /* I'm DR */
 405
 406 /* Definitions for interface state machine */
 407 #define ISM_UP          0       /* Interface Up */
 408 #define ISM_WAITF       1       /* Wait timer fired */
 409 #define ISM_BACKS       2       /* Backup seen */
 410 #define ISM_NEICH       3       /* Neighbor change */
 411 #define ISM_LOOP        4       /* Link down */
 412 #define ISM_UNLOOP      5       /* Link up */
 413 #define ISM_DOWN        6       /* Interface down */
 414
 415 /* OSPF authentication types */
 416 #define OSPF_AUTH_NONE  0
 417 #define OSPF_AUTH_SIMPLE 1
 418 #define OSPF_AUTH_CRYPT 2
 419
 420
 421 /* OSPF neighbor states */
 422 #define NEIGHBOR_DOWN   0
 423 #define NEIGHBOR_ATTEMPT 1
 424 #define NEIGHBOR_INIT   2
 425 #define NEIGHBOR_2WAY   3
 426 #define NEIGHBOR_EXSTART 4
 427 #define NEIGHBOR_EXCHANGE 5
 428 #define NEIGHBOR_LOADING 6
 429 #define NEIGHBOR_FULL   7
 430
 431 /* Definitions for neighbor state machine */
 432 #define INM_HELLOREC    0       /* Hello Received */
 433 #define INM_START       1       /* Neighbor start - for NBMA */
 434 #define INM_2WAYREC     2       /* 2-Way received */
 435 #define INM_NEGDONE     3       /* Negotiation done */
 436 #define INM_EXDONE      4       /* Exchange done */
 437 #define INM_BADLSREQ    5       /* Bad LS Request */
 438 #define INM_LOADDONE    6       /* Load done */
 439 #define INM_ADJOK       7       /* AdjOK? */
 440 #define INM_SEQMIS      8       /* Sequence number mismatch */
 441 #define INM_1WAYREC     9       /* 1-Way */
 442 #define INM_KILLNBR     10      /* Kill Neighbor */
 443 #define INM_INACTTIM    11      /* Inactivity timer */
 444 #define INM_LLDOWN      12      /* Line down */
 445
 446 #define TRANS_OFF       0
 447 #define TRANS_ON        1
 448 #define TRANS_WAIT      2       /* Waiting before the end of translation */
 449
 450
 451 /* Generic option flags */
 452 #define OPT_V6          0x01    /* OSPFv3, LSA relevant for IPv6 routing calculation */
 453 #define OPT_E           0x02    /* Related to AS-external LSAs */
 454 #define OPT_MC          0x04    /* Related to MOSPF, not used and obsolete */
 455 #define OPT_N           0x08    /* Related to NSSA */
 456 #define OPT_P           0x08    /* OSPFv2, flags P and N share position, see NSSA RFC */
 457 #define OPT_EA          0x10    /* OSPFv2, external attributes, not used and obsolete */
 458 #define OPT_R           0x10    /* OSPFv3, originator is active router */
 459 #define OPT_DC          0x20    /* Related to demand circuits, not used */
 460
 461 /* Router-LSA VEB flags are are stored together with links (OSPFv2) or options (OSPFv3) */
 462 #define OPT_RT_B        (0x01 << 24)
 463 #define OPT_RT_E        (0x02 << 24)
 464 #define OPT_RT_V        (0x04 << 24)
 465 #define OPT_RT_NT       (0x10 << 24)
 466
 467 /* Prefix flags, specific for OSPFv3 */
 468 #define OPT_PX_NU       0x01
 469 #define OPT_PX_LA       0x02
 470 #define OPT_PX_P        0x08
 471 #define OPT_PX_DN       0x10
 472
 473
 474 struct ospf_packet
 475 {
 476   u8 version;
 477   u8 type;
 478   u16 length;
 479   u32 routerid;
 480   u32 areaid;
 481   u16 checksum;
 482   u8 instance_id;               /* See RFC 6549 */
 483   u8 autype;                    /* Undefined for OSPFv3 */
 484 };
 485
 486 struct ospf_auth_crypto
 487 {
 488   u16 zero;
 489   u8 keyid;
 490   u8 len;
 491   u32 csn;
 492 };
 493
 494 union ospf_auth
 495 {
 496   u8 password[8];
 497   struct ospf_auth_crypto c32;
 498 };
 499
 500 /* Packet types */
 501 #define HELLO_P         1       /* Hello */
 502 #define DBDES_P         2       /* Database description */
 503 #define LSREQ_P         3       /* Link state request */
 504 #define LSUPD_P         4       /* Link state update */
 505 #define LSACK_P         5       /* Link state acknowledgement */
 506
 507
 508 #define DBDES_I         4       /* Init bit */
 509 #define DBDES_M         2       /* More bit */
 510 #define DBDES_MS        1       /* Master/Slave bit */
 511 #define DBDES_IMMS      (DBDES_I | DBDES_M | DBDES_MS)
 512
 513
 514 #define LSA_T_RT        0x2001
 515 #define LSA_T_NET       0x2002
 516 #define LSA_T_SUM_NET   0x2003
 517 #define LSA_T_SUM_RT    0x2004
 518 #define LSA_T_EXT       0x4005
 519 #define LSA_T_NSSA      0x2007
 520 #define LSA_T_LINK      0x0008
 521 #define LSA_T_PREFIX    0x2009
 522
 523 #define LSA_T_V2_MASK   0x00ff
 524
 525 #define LSA_UBIT        0x8000
 526
 527 #define LSA_SCOPE_LINK  0x0000
 528 #define LSA_SCOPE_AREA  0x2000
 529 #define LSA_SCOPE_AS    0x4000
 530 #define LSA_SCOPE_RES   0x6000
 531 #define LSA_SCOPE_MASK  0x6000
 532 #define LSA_SCOPE(type) ((type) & LSA_SCOPE_MASK)
 533
 534
 535 #define LSA_MAXAGE      3600    /* 1 hour */
 536 #define LSA_CHECKAGE    300     /* 5 minutes */
 537 #define LSA_MAXAGEDIFF  900     /* 15 minutes */
 538
 539 #define LSA_ZEROSEQNO   ((s32) 0x80000000)
 540 #define LSA_INITSEQNO   ((s32) 0x80000001)
 541 #define LSA_MAXSEQNO    ((s32) 0x7fffffff)
 542
 543 #define LSA_METRIC_MASK  0x00FFFFFF
 544 #define LSA_OPTIONS_MASK 0x00FFFFFF
 545
 546
 547 #define LSART_PTP       1
 548 #define LSART_NET       2
 549 #define LSART_STUB      3
 550 #define LSART_VLNK      4
 551
 552 #define LSA_RT2_LINKS   0x0000FFFF
 553
 554 #define LSA_SUM2_TOS    0xFF000000
 555
 556 #define LSA_EXT2_TOS    0x7F000000
 557 #define LSA_EXT2_EBIT   0x80000000
 558
 559 #define LSA_EXT3_EBIT   0x4000000
 560 #define LSA_EXT3_FBIT   0x2000000
 561 #define LSA_EXT3_TBIT   0x1000000
 562
 563
 564 struct ospf_lsa_header
 565 {
 566   u16 age;                      /* LS Age */
 567   u16 type_raw;                 /* Type, mixed with options on OSPFv2 */
 568
 569   u32 id;
 570   u32 rt;                       /* Advertising router */
 571   s32 sn;                       /* LS Sequence number */
 572   u16 checksum;
 573   u16 length;
 574 };
 575
 576
 577 /* In OSPFv2, options are embedded in higher half of type_raw */
 578 static inline u8 lsa_get_options(struct ospf_lsa_header *lsa)
 579 { return lsa->type_raw >> 8; }
 580
 581 static inline void lsa_set_options(struct ospf_lsa_header *lsa, u16 options)
 582 { lsa->type_raw = (lsa->type_raw & 0xff) | (options << 8); }
 583
 584
 585 struct ospf_lsa_rt
 586 {
 587   u32 options;  /* VEB flags, mixed with link count for OSPFv2 and options for OSPFv3 */
 588 };
 589
 590 struct ospf_lsa_rt2_link
 591 {
 592   u32 id;
 593   u32 data;
 594 #ifdef CPU_BIG_ENDIAN
 595   u8 type;
 596   u8 no_tos;
 597   u16 metric;
 598 #else
 599   u16 metric;
 600   u8 no_tos;
 601   u8 type;
 602 #endif
 603 };
 604
 605 struct ospf_lsa_rt2_tos
 606 {
 607 #ifdef CPU_BIG_ENDIAN
 608   u8 tos;
 609   u8 padding;
 610   u16 metric;
 611 #else
 612   u16 metric;
 613   u8 padding;
 614   u8 tos;
 615 #endif
 616 };
 617
 618 struct ospf_lsa_rt3_link
 619 {
 620 #ifdef CPU_BIG_ENDIAN
 621   u8 type;
 622   u8 padding;
 623   u16 metric;
 624 #else
 625   u16 metric;
 626   u8 padding;
 627   u8 type;
 628 #endif
 629   u32 lif;      /* Local interface ID */
 630   u32 nif;      /* Neighbor interface ID */
 631   u32 id;       /* Neighbor router ID */
 632 };
 633
 634
 635 struct ospf_lsa_net
 636 {
 637   u32 optx;     /* Netmask for OSPFv2, options for OSPFv3 */
 638   u32 routers[];
 639 };
 640
 641 struct ospf_lsa_sum2
 642 {
 643   u32 netmask;
 644   u32 metric;
 645 };
 646
 647 struct ospf_lsa_sum3_net
 648 {
 649   u32 metric;
 650   u32 prefix[];
 651 };
 652
 653 struct ospf_lsa_sum3_rt
 654 {
 655   u32 options;
 656   u32 metric;
 657   u32 drid;
 658 };
 659
 660 struct ospf_lsa_ext2
 661 {
 662   u32 netmask;
 663   u32 metric;
 664   u32 fwaddr;
 665   u32 tag;
 666 };
 667
 668 struct ospf_lsa_ext3
 669 {
 670   u32 metric;
 671   u32 rest[];
 672 };
 673
 674 struct ospf_lsa_ext_local
 675 {
 676   net_addr net;
 677   ip_addr fwaddr;
 678   u32 metric, ebit, fbit, tag, propagate;
 679   u8 pxopts;
 680 };
 681
 682 struct ospf_lsa_link
 683 {
 684   u32 options;
 685   ip6_addr lladdr;
 686   u32 pxcount;
 687   u32 rest[];
 688 };
 689
 690 struct ospf_lsa_prefix
 691 {
 692 #ifdef CPU_BIG_ENDIAN
 693   u16 pxcount;
 694   u16 ref_type;
 695 #else
 696   u16 ref_type;
 697   u16 pxcount;
 698 #endif
 699   u32 ref_id;
 700   u32 ref_rt;
 701   u32 rest[];
 702 };
 703
 704
 705 static inline uint
 706 lsa_net_count(struct ospf_lsa_header *lsa)
 707 {
 708   return (lsa->length - sizeof(struct ospf_lsa_header) - sizeof(struct ospf_lsa_net))
 709     / sizeof(u32);
 710 }
 711
 712 /* In ospf_area->rtr we store paths to routers, but we use RID (and not IP address)
 713    as index, so we need to encapsulate RID to IP address */
 714
 715 #define net_from_rid(x) NET_ADDR_IP4(ip4_from_u32(x), IP4_MAX_PREFIX_LENGTH)
 716 #define rid_from_net(x) ip4_to_u32(((net_addr_ip4 *) x)->prefix)
 717
 718 #define IPV6_PREFIX_SPACE(x) ((((x) + 63) / 32) * 4)
 719 #define IPV6_PREFIX_WORDS(x) (((x) + 63) / 32)
 720
 721 /* FIXME: these functions should be significantly redesigned w.r.t. integration,
 722    also should be named as ospf3_* instead of *_ipv6_* */
 723
 724 static inline int
 725 ospf_valid_prefix(net_addr *n)
 726 {
 727   /* In OSPFv2, prefix is stored as netmask; ip4_masklen() returns 255 for invalid one */
 728   return n->pxlen <= IP6_MAX_PREFIX_LENGTH;
 729 }
 730
 731 static inline u32 *
 732 ospf_get_ipv6_prefix(u32 *buf, net_addr *N, u8 *pxopts, u16 *rest)
 733 {
 734   net_addr_ip6 *net = (void *) N;
 735   u8 pxlen = (*buf >> 24);
 736   *pxopts = (*buf >> 16) & 0xff;
 737   if (rest) *rest = *buf & 0xffff;
 738   buf++;
 739
 740   *net = NET_ADDR_IP6(IP6_NONE, pxlen);
 741
 742   if (pxlen > 0)
 743     _I0(net->prefix) = *buf++;
 744   if (pxlen > 32)
 745     _I1(net->prefix) = *buf++;
 746   if (pxlen > 64)
 747     _I2(net->prefix) = *buf++;
 748   if (pxlen > 96)
 749     _I3(net->prefix) = *buf++;
 750
 751   /* Clean up remaining bits */
 752   if (pxlen < 128)
 753     net->prefix.addr[pxlen / 32] &= u32_mkmask(pxlen % 32);
 754
 755   return buf;
 756 }
 757
 758 static inline u32 *
 759 ospf_get_ipv6_addr(u32 *buf, ip_addr *addr)
 760 {
 761   *addr = ipa_from_ip6(*(ip6_addr *) buf);
 762   return buf + 4;
 763 }
 764
 765 static inline u32 *
 766 ospf_put_ipv6_prefix(u32 *buf, net_addr *N, u8 pxopts, u16 rest)
 767 {
 768   net_addr_ip6 *net = (void *) N;
 769   u32 pxlen = net->pxlen;
 770
 771   *buf++ = ((pxlen << 24) | (pxopts << 16) | rest);
 772
 773   if (pxlen > 0)
 774     *buf++ = _I0(net->prefix);
 775   if (pxlen > 32)
 776     *buf++ = _I1(net->prefix);
 777   if (pxlen > 64)
 778     *buf++ = _I2(net->prefix);
 779   if (pxlen > 96)
 780     *buf++ = _I3(net->prefix);
 781
 782   return buf;
 783 }
 784
 785 static inline u32 *
 786 ospf_put_ipv6_addr(u32 *buf, ip_addr addr)
 787 {
 788   *(ip6_addr *) buf = ipa_to_ip6(addr);
 789   return buf + 4;
 790 }
 791
 792
 793 struct ospf_lsreq_header
 794 {
 795   u32 type;
 796   u32 id;
 797   u32 rt;
 798 };
 799
 800
 801
 802 #define SH_ROUTER_SELF 0xffffffff
 803
 804 struct lsadb_show_data {
 805   struct symbol *name;  /* Protocol to request data from */
 806   u16 type;             /* LSA Type, 0 -> all */
 807   u16 scope;            /* Scope, 0 -> all, hack to handle link scope as 1 */
 808   u32 area;             /* Specified for area scope */
 809   u32 lsid;             /* LSA ID, 0 -> all */
 810   u32 router;           /* Advertising router, 0 -> all */
 811 };
 812
 813
 814 #define EA_OSPF_METRIC1 EA_CODE(EAP_OSPF, 0)
 815 #define EA_OSPF_METRIC2 EA_CODE(EAP_OSPF, 1)
 816 #define EA_OSPF_TAG     EA_CODE(EAP_OSPF, 2)
 817 #define EA_OSPF_ROUTER_ID EA_CODE(EAP_OSPF, 3)
 818
 819
 820 /* ospf.c */
 821 void ospf_schedule_rtcalc(struct ospf_proto *p);
 822
 823 static inline void ospf_notify_rt_lsa(struct ospf_area *oa)
 824 { oa->update_rt_lsa = 1; }
 825
 826 static inline void ospf_notify_net_lsa(struct ospf_iface *ifa)
 827 { ifa->update_net_lsa = 1; }
 828
 829 static inline void ospf_notify_link_lsa(struct ospf_iface *ifa)
 830 { ifa->update_link_lsa = 1; }
 831
 832 static inline int ospf_is_v2(struct ospf_proto *p)
 833 { return p->ospf2; }
 834
 835 static inline int ospf_is_v3(struct ospf_proto *p)
 836 { return ! p->ospf2; }
 837
 838 static inline int ospf_get_version(struct ospf_proto *p)
 839 { return ospf_is_v2(p) ? 2 : 3; }
 840
 841 struct ospf_area *ospf_find_area(struct ospf_proto *p, u32 aid);
 842
 843 static inline struct ospf_area *ospf_main_area(struct ospf_proto *p)
 844 { return (p->areano == 1) ? HEAD(p->area_list) : p->backbone; }
 845
 846 static inline int oa_is_stub(struct ospf_area *oa)
 847 { return (oa->options & (OPT_E | OPT_N)) == 0; }
 848
 849 static inline int oa_is_ext(struct ospf_area *oa)
 850 { return oa->options & OPT_E; }
 851
 852 static inline int oa_is_nssa(struct ospf_area *oa)
 853 { return oa->options & OPT_N; }
 854
 855 void ospf_sh_neigh(struct proto *P, char *iff);
 856 void ospf_sh(struct proto *P);
 857 void ospf_sh_iface(struct proto *P, char *iff);
 858 void ospf_sh_state(struct proto *P, int verbose, int reachable);
 859
 860 void ospf_sh_lsadb(struct lsadb_show_data *ld);
 861
 862 /* iface.c */
 863 void ospf_iface_chstate(struct ospf_iface *ifa, u8 state);
 864 void ospf_iface_sm(struct ospf_iface *ifa, int event);
 865 struct ospf_iface *ospf_iface_find(struct ospf_proto *p, struct iface *what);
 866 void ospf_if_notify(struct proto *P, uint flags, struct iface *iface);
 867 void ospf_ifa_notify2(struct proto *P, uint flags, struct ifa *a);
 868 void ospf_ifa_notify3(struct proto *P, uint flags, struct ifa *a);
 869 void ospf_iface_info(struct ospf_iface *ifa);
 870 void ospf_iface_new(struct ospf_area *oa, struct ifa *addr, struct ospf_iface_patt *ip);
 871 void ospf_iface_new_vlink(struct ospf_proto *p, struct ospf_iface_patt *ip);
 872 void ospf_iface_remove(struct ospf_iface *ifa);
 873 void ospf_iface_shutdown(struct ospf_iface *ifa);
 874 int ospf_iface_assure_bufsize(struct ospf_iface *ifa, uint plen);
 875 int ospf_iface_reconfigure(struct ospf_iface *ifa, struct ospf_iface_patt *new);
 876 void ospf_reconfigure_ifaces(struct ospf_proto *p);
 877 void ospf_open_vlink_sk(struct ospf_proto *p);
 878 struct nbma_node *find_nbma_node_(list *nnl, ip_addr ip);
 879
 880 static inline struct nbma_node * find_nbma_node(struct ospf_iface *ifa, ip_addr ip)
 881 { return find_nbma_node_(&ifa->nbma_list, ip); }
 882
 883 /* neighbor.c */
 884 struct ospf_neighbor *ospf_neighbor_new(struct ospf_iface *ifa);
 885 void ospf_neigh_sm(struct ospf_neighbor *n, int event);
 886 void ospf_dr_election(struct ospf_iface *ifa);
 887 struct ospf_neighbor *find_neigh(struct ospf_iface *ifa, u32 rid);
 888 struct ospf_neighbor *find_neigh_by_ip(struct ospf_iface *ifa, ip_addr ip);
 889 void ospf_neigh_update_bfd(struct ospf_neighbor *n, int use_bfd);
 890 void ospf_sh_neigh_info(struct ospf_neighbor *n);
 891
 892 /* packet.c */
 893 void ospf_pkt_fill_hdr(struct ospf_iface *ifa, void *buf, u8 h_type);
 894 int ospf_rx_hook(sock * sk, uint size);
 895 // void ospf_tx_hook(sock * sk);
 896 void ospf_err_hook(sock * sk, int err);
 897 void ospf_verr_hook(sock *sk, int err);
 898 void ospf_send_to(struct ospf_iface *ifa, ip_addr ip);
 899 void ospf_send_to_agt(struct ospf_iface *ifa, u8 state);
 900 void ospf_send_to_bdr(struct ospf_iface *ifa);
 901
 902 static inline uint ospf_pkt_maxsize(struct ospf_iface *ifa)
 903 { return ifa->tx_length - ifa->tx_hdrlen; }
 904
 905 static inline void ospf_send_to_all(struct ospf_iface *ifa)
 906 { ospf_send_to(ifa, ifa->all_routers); }
 907
 908 static inline void ospf_send_to_des(struct ospf_iface *ifa)
 909 {
 910   if (ipa_nonzero(ifa->des_routers))
 911     ospf_send_to(ifa, ifa->des_routers);
 912   else
 913     ospf_send_to_bdr(ifa);
 914 }
 915
 916 #ifndef PARSER
 917 #define DROP(DSC,VAL) do { err_dsc = DSC; err_val = VAL; goto drop; } while(0)
 918 #define DROP1(DSC) do { err_dsc = DSC; goto drop; } while(0)
 919 #define SKIP(DSC) do { err_dsc = DSC; goto skip; } while(0)
 920 #endif
 921
 922 static inline uint ospf_pkt_hdrlen(struct ospf_proto *p)
 923 { return ospf_is_v2(p) ? (sizeof(struct ospf_packet) + sizeof(union ospf_auth)) : sizeof(struct ospf_packet); }
 924
 925 static inline void * ospf_tx_buffer(struct ospf_iface *ifa)
 926 { return ifa->sk->tbuf; }
 927
 928 /* hello.c */
 929 #define OHS_HELLO    0
 930 #define OHS_POLL     1
 931 #define OHS_SHUTDOWN 2
 932
 933 void ospf_send_hello(struct ospf_iface *ifa, int kind, struct ospf_neighbor *dirn);
 934 void ospf_receive_hello(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n, ip_addr faddr);
 935
 936 /* dbdes.c */
 937 void ospf_send_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
 938 void ospf_rxmt_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
 939 void ospf_receive_dbdes(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
 940
 941 /* lsreq.c */
 942 void ospf_send_lsreq(struct ospf_proto *p, struct ospf_neighbor *n);
 943 void ospf_receive_lsreq(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
 944
 945 /* lsupd.c */
 946 void ospf_dump_lsahdr(struct ospf_proto *p, struct ospf_lsa_header *lsa_n);
 947 void ospf_dump_common(struct ospf_proto *p, struct ospf_packet *pkt);
 948 void ospf_lsa_lsrt_down_(struct top_hash_entry *en, struct ospf_neighbor *n, struct top_hash_entry *ret);
 949 void ospf_add_flushed_to_lsrt(struct ospf_proto *p, struct ospf_neighbor *n);
 950 void ospf_flood_event(void *ptr);
 951 int ospf_flood_lsa(struct ospf_proto *p, struct top_hash_entry *en, struct ospf_neighbor *from);
 952 int ospf_send_lsupd(struct ospf_proto *p, struct top_hash_entry **lsa_list, uint lsa_count, struct ospf_neighbor *n);
 953 void ospf_rxmt_lsupd(struct ospf_proto *p, struct ospf_neighbor *n);
 954 void ospf_receive_lsupd(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
 955
 956 /* lsack.c */
 957 void ospf_enqueue_lsack(struct ospf_neighbor *n, struct ospf_lsa_header *h_n, int queue);
 958 void ospf_reset_lsack_queue(struct ospf_neighbor *n);
 959 void ospf_send_lsack(struct ospf_proto *p, struct ospf_neighbor *n, int queue);
 960 void ospf_receive_lsack(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);
 961
 962
 963 #include "proto/ospf/rt.h"
 964 #include "proto/ospf/topology.h"
 965 #include "proto/ospf/lsalib.h"
 966
 967 #endif /* _BIRD_OSPF_H_ */