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