ospf.h 27.3 KB
Newer Older
1 2 3
/*
 *	BIRD -- OSPF
 *
4
 *	(c) 1999--2005 Ondrej Filip <feela@network.cz>
5 6
 *	(c) 2009--2014 Ondrej Zajicek <santiago@crfreenet.org>
 *	(c) 2009--2014 CZ.NIC z.s.p.o.
7 8 9 10 11 12 13
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_OSPF_H_
#define _BIRD_OSPF_H_

14 15 16
#include "nest/bird.h"

#include "lib/checksum.h"
17 18
#include "lib/ip.h"
#include "lib/lists.h"
19
#include "lib/slists.h"
20 21 22 23 24
#include "lib/socket.h"
#include "lib/timer.h"
#include "lib/resource.h"
#include "nest/protocol.h"
#include "nest/iface.h"
25
#include "nest/route.h"
26
#include "nest/cli.h"
Ondřej Filip's avatar
Ondřej Filip committed
27
#include "nest/locks.h"
28
#include "nest/bfd.h"
29
#include "conf/conf.h"
30
#include "lib/string.h"
31

32

33 34 35 36 37 38 39 40 41
#ifdef LOCAL_DEBUG
#define OSPF_FORCE_DEBUG 1
#else
#define OSPF_FORCE_DEBUG 0
#endif


#ifdef IPV6
#define OSPF_IS_V2 0
Ondřej Filip's avatar
Ondřej Filip committed
42
#else
43
#define OSPF_IS_V2 1
Ondřej Filip's avatar
Ondřej Filip committed
44 45
#endif

46 47 48
// FIXME: MAX_PREFIX_LENGTH

#define OSPF_TRACE(flags, msg, args...) \
49 50
  do { if ((p->p.debug & flags) || OSPF_FORCE_DEBUG) \
    log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
51 52

#define OSPF_PACKET(dumpfn, buffer, msg, args...) \
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
  do { if ((p->p.debug & D_PACKETS) || OSPF_FORCE_DEBUG)		\
    { log(L_TRACE "%s: " msg, p->p.name, ## args ); dumpfn(p, buffer); } } while(0)

#define LOG_PKT(msg, args...) \
  log_rl(&p->log_pkt_tbf, L_REMOTE "%s: " msg, p->p.name, args)

#define LOG_PKT_AUTH(msg, args...) \
  log_rl(&p->log_pkt_tbf, L_AUTH "%s: " msg, p->p.name, args)

#define LOG_PKT_WARN(msg, args...) \
  log_rl(&p->log_pkt_tbf, L_WARN "%s: " msg, p->p.name, args)

#define LOG_LSA1(msg, args...) \
  log_rl(&p->log_lsa_tbf, L_REMOTE "%s: " msg, p->p.name, args)

#define LOG_LSA2(msg, args...) \
  do { if (! p->log_lsa_tbf.mark) \
    log(L_REMOTE "%s: " msg, p->p.name, args); } while(0)
71 72 73


#define OSPF_PROTO 89
74

Ondřej Filip's avatar
Ondřej Filip committed
75
#define LSREFRESHTIME 1800	/* 30 minutes */
76 77
#define MINLSINTERVAL 5
#define MINLSARRIVAL 1
Ondřej Filip's avatar
Ondřej Filip committed
78
#define LSINFINITY 0xffffff
Ondřej Filip's avatar
Ondřej Filip committed
79

80 81 82 83 84 85 86
#define OSPF_DEFAULT_TICK 1
#define OSPF_DEFAULT_STUB_COST 1000
#define OSPF_DEFAULT_ECMP_LIMIT 16
#define OSPF_DEFAULT_TRANSINT 40

#define OSPF_MIN_PKT_SIZE 256
#define OSPF_MAX_PKT_SIZE 65535
Ondřej Filip's avatar
Ondřej Filip committed
87

88 89
#define OSPF_VLINK_ID_OFFSET 0x80000000

90

Ondřej Filip's avatar
Ondřej Filip committed
91 92
struct ospf_config
{
93
  struct proto_config c;
94
  uint tick;
95 96 97 98 99 100 101
  u8 ospf2;
  u8 rfc1583;
  u8 stub_router;
  u8 merge_external;
  u8 instance_id;
  u8 abr;
  u8 asbr;
102
  int ecmp;
103 104
  list area_list;		/* list of area configs (struct ospf_area_config) */
  list vlink_list;		/* list of configured vlinks (struct ospf_iface_patt) */
Ondřej Filip's avatar
Ondřej Filip committed
105 106
};

107
struct ospf_area_config
Ondřej Filip's avatar
Ondřej Filip committed
108
{
109
  node n;
110 111 112 113 114 115 116 117 118 119
  u32 areaid;
  u32 default_cost;		/* Cost of default route for stub areas
				   (With possible LSA_EXT3_EBIT for NSSA areas) */
  u8 type;			/* Area type (standard, stub, NSSA), represented
				   by option flags (OPT_E, OPT_N) */
  u8 summary;			/* Import summaries to this stub/NSSA area, valid for ABR */
  u8 default_nssa;		/* Generate default NSSA route for NSSA+summary area */
  u8 translator;		/* Translator role, for NSSA ABR */
  u32 transint;			/* Translator stability interval */
  list patt_list;		/* List of iface configs (struct ospf_iface_patt) */
120 121
  list net_list;		/* List of aggregate networks for that area */
  list enet_list;		/* List of aggregate external (NSSA) networks */
122
  list stubnet_list;		/* List of stub networks added to Router LSA */
123 124
};

Ondřej Filip's avatar
Ondřej Filip committed
125
struct area_net_config
Ondřej Filip's avatar
Ondřej Filip committed
126
{
127
  node n;
Ondřej Filip's avatar
Ondřej Filip committed
128
  struct prefix px;
129
  u32 tag;
130
  u8 hidden;
Ondřej Filip's avatar
Ondřej Filip committed
131 132 133 134 135
};

struct area_net
{
  struct fib_node fn;
136
  u32 metric;			/* With possible LSA_EXT3_EBIT for NSSA area nets */
137
  u32 tag;
138 139
  u8 hidden;
  u8 active;
140 141
};

142 143 144 145 146
struct ospf_stubnet_config
{
  node n;
  struct prefix px;
  u32 cost;
147 148
  u8 hidden;
  u8 summary;
149 150
};

151
struct nbma_node
Ondřej Filip's avatar
Ondřej Filip committed
152
{
Ondřej Filip's avatar
Ondřej Filip committed
153
  node n;
154 155
  ip_addr ip;
  byte eligible;
156
  byte found;
157 158
};

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
struct ospf_iface_patt
{
  struct iface_patt i;
  u32 type;
  u32 stub;
  u32 cost;
  u32 helloint;
  u32 rxmtint;
  u32 pollint;
  u32 waitint;
  u32 deadc;
  u32 deadint;
  u32 inftransdelay;
  list nbma_list;
  u32 priority;
  u32 voa;
  u32 vid;
  int tx_tos;
  int tx_priority;
  u16 tx_length;
  u16 rx_buffer;
180

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
#define OSPF_RXBUF_MINSIZE 256	/* Minimal allowed size */
  u8 instance_id;
  u8 autype;			/* Not really used in OSPFv3 */
#define OSPF_AUTH_NONE 0
#define OSPF_AUTH_SIMPLE 1
#define OSPF_AUTH_CRYPT 2
#define OSPF_AUTH_CRYPT_SIZE 16
  u8 strictnbma;
  u8 check_link;
  u8 ecmp_weight;
  u8 link_lsa_suppression;
  u8 real_bcast;		/* Not really used in OSPFv3 */
  u8 ptp_netmask;		/* bool + 2 for unspecified */
  u8 ttl_security;		/* bool + 2 for TX only */
  u8 bfd;
  u8 bsd_secondary;
  list *passwords;
};
199 200 201 202 203 204 205 206 207

/* Default values for interface parameters */
#define COST_D 10
#define RXMTINT_D 5
#define INFTRANSDELAY_D 1
#define PRIORITY_D 1
#define HELLOINT_D 10
#define POLLINT_D 20
#define DEADC_D 4
208
#define WAIT_DMH 4
209
  /* Value of Wait timer - not found it in RFC * - using 4*HELLO */
210 211


212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233

struct ospf_proto
{
  struct proto p;
  timer *disp_timer;		/* OSPF proto dispatcher */
  uint tick;
  struct top_graph *gr;		/* LSA graph */
  slist lsal;			/* List of all LSA's */
  int calcrt;			/* Routing table calculation scheduled?
				   0=no, 1=normal, 2=forced reload */
  list iface_list;		/* List of OSPF interfaces (struct ospf_iface) */
  list area_list;		/* List of OSPF areas (struct ospf_area) */
  int areano;			/* Number of area I belong to */
  int padj;			/* Number of neighbors in Exchange or Loading state */
  struct fib rtf;		/* Routing table */
  byte ospf2;			/* OSPF v2 or v3 */
  byte rfc1583;			/* RFC1583 compatibility */
  byte stub_router;		/* Do not forward transit traffic */
  byte merge_external;		/* Should i merge external routes? */
  byte asbr;			/* May i originate any ext/NSSA lsa? */
  byte ecmp;			/* Maximal number of nexthops in ECMP route, or 0 */
  struct ospf_area *backbone;	/* If exists */
234
  event *flood_event;		/* Event for flooding LS updates */
235 236 237 238 239 240
  void *lsab;			/* LSA buffer used when originating router LSAs */
  int lsab_size, lsab_used;
  linpool *nhpool;		/* Linpool used for next hops computed in SPF */
  sock *vlink_sk;		/* IP socket used for vlink TX */
  u32 router_id;
  u32 last_vlink_id;		/* Interface IDs for vlinks (starts at 0x80000000) */
241 242
  struct tbf log_pkt_tbf;	/* TBF for packet messages */
  struct tbf log_lsa_tbf;	/* TBF for LSA messages */
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
};

struct ospf_area
{
  node n;
  u32 areaid;
  struct ospf_area_config *ac;	/* Related area config */
  struct top_hash_entry *rt;	/* My own router LSA */
  struct top_hash_entry *pxr_lsa; /* Originated prefix LSA */
  list cand;			/* List of candidates for RT calc. */
  struct fib net_fib;		/* Networks to advertise or not */
  struct fib enet_fib;		/* External networks for NSSAs */
  u32 options;			/* Optional features */
  u8 update_rt_lsa;		/* Rt lsa origination scheduled? */
  u8 trcap;			/* Transit capability? */
  u8 marked;			/* Used in OSPF reconfigure */
  u8 translate;			/* Translator state (TRANS_*), for NSSA ABR  */
  timer *translator_timer;	/* For NSSA translator switch */
  struct ospf_proto *po;
  struct fib rtr;		/* Routing tables for routers */
};



Ondřej Filip's avatar
Ondřej Filip committed
267 268
struct ospf_iface
{
269
  node n;
270
  struct iface *iface;		/* Nest's iface (NULL for vlinks) */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
271
  struct ifa *addr;		/* IP prefix associated with that OSPF iface */
272
  struct ospf_area *oa;
273
  struct ospf_iface_patt *cf;
274 275
  char *ifname;			/* Interface name (iface->name), new one for vlinks */

276
  pool *pool;
277
  sock *sk;			/* IP socket */
278
  list neigh_list;		/* List of neighbors (struct ospf_neighbor) */
279
  u32 cost;			/* Cost of iface */
280 281 282
  u32 waitint;			/* number of sec before changing state from wait */
  u32 rxmtint;			/* number of seconds between LSA retransmissions */
  u32 pollint;			/* Poll interval */
283
  u32 deadint;			/* after "deadint" missing hellos is router dead */
284 285
  u32 iface_id;			/* Interface ID (iface->index or new value for vlinks) */
  u32 vid;			/* ID of peer of virtual link */
Ondřej Filip's avatar
Ondřej Filip committed
286
  ip_addr vip;			/* IP of peer of virtual link */
287 288
  struct ospf_iface *vifa;	/* OSPF iface which the vlink goes through */
  struct ospf_area *voa;	/* OSPF area which the vlink goes through */
289 290 291
  u16 inftransdelay;		/* The estimated number of seconds it takes to
				   transmit a Link State Update Packet over this
				   interface.  LSAs contained in the update */
292
  u16 helloint;			/* number of seconds between hello sending */
293
  list *passwords;
294 295
  u32 csn;                      /* Last used crypt seq number */
  bird_clock_t csn_use;         /* Last time when packet with that CSN was sent */
296 297 298 299 300 301
  ip_addr all_routers;		/* Multicast (or broadcast) address for all routers */
  ip_addr des_routers;		/* Multicast (or NULL) address for designated routers */
  ip_addr drip;			/* Designated router IP */
  ip_addr bdrip;		/* Backup DR IP */
  u32 drid;			/* DR Router ID */
  u32 bdrid;			/* BDR Router ID */
302 303 304 305
  s16 rt_pos_beg;		/* Position of iface in Router-LSA, begin, inclusive */
  s16 rt_pos_end;		/* Position of iface in Router-LSA, end, exclusive */
  s16 px_pos_beg;		/* Position of iface in Rt Prefix-LSA, begin, inclusive */
  s16 px_pos_end;		/* Position of iface in Rt Prefix-LSA, end, exclusive */
306 307 308
  u32 dr_iface_id;		/* if drid is valid, this is iface_id of DR (for connecting network) */
  u8 instance_id;		/* Used to differentiate between more OSPF
				   instances on one interface */
309 310
  u8 autype;			/* Authentication type (OSPF_AUTH_*) */
  u8 type;			/* OSPF view of type (OSPF_IT_*) */
Ondřej Filip's avatar
Ondřej Filip committed
311 312
  u8 strictnbma;		/* Can I talk with unknown neighbors? */
  u8 stub;			/* Inactive interface */
313
  u8 state;			/* Interface state machine (OSPF_IS_*) */
314 315
  timer *wait_timer;		/* WAIT timer */
  timer *hello_timer;		/* HELLOINT timer */
316
  timer *poll_timer;		/* Poll Interval - for NBMA */
317

318
  struct top_hash_entry *link_lsa;	/* Originated link LSA */
319
  struct top_hash_entry *net_lsa;	/* Originated network LSA */
320
  struct top_hash_entry *pxn_lsa;	/* Originated prefix LSA */
321
  struct top_hash_entry **flood_queue;	/* LSAs queued for LSUPD */
322 323
  u8 update_link_lsa;
  u8 update_net_lsa;
324 325
  u16 flood_queue_used;		/* The current number of LSAs in flood_queue */
  u16 flood_queue_size;		/* The maximum number of LSAs in flood_queue */
326
  int fadj;			/* Number of fully adjacent neighbors */
327
  list nbma_list;
328
  u8 priority;			/* A router priority for DR election */
329
  u8 ioprob;
330 331 332
#define OSPF_I_OK 0		/* Everything OK */
#define OSPF_I_SK 1		/* Socket open failed */
#define OSPF_I_LL 2		/* Missing link-local address (OSPFv3) */
333
  u8 sk_dr;			/* Socket is a member of designated routers group */
334
  u8 marked;			/* Used in OSPF reconfigure, 2 for force restart */
335
  u16 rxbuf;			/* Buffer size */
336
  u16 tx_length;		/* Soft TX packet length limit, usually MTU */
337
  u8 check_link;		/* Whether iface link change is used */
338
  u8 ecmp_weight;		/* Weight used for ECMP */
339
  u8 link_lsa_suppression;	/* Suppression of Link-LSA origination */
340
  u8 ptp_netmask;		/* Send real netmask for P2P */
341
  u8 check_ttl;			/* Check incoming packets for TTL 255 */
342
  u8 bfd;			/* Use BFD on iface */
343 344
};

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
struct ospf_neighbor
{
  node n;
  pool *pool;
  struct ospf_iface *ifa;
  u8 state;
  timer *inactim;		/* Inactivity timer */
  u8 imms;			/* I, M, Master/slave received */
  u8 myimms;			/* I, M Master/slave */
  u32 dds;			/* DD Sequence number being sent */
  u32 ddr;			/* last Dat Des packet received */

  u32 rid;			/* Router ID */
  ip_addr ip;			/* IP of it's interface */
  u8 priority;			/* Priority */
  u8 adj;			/* built adjacency? */
  u32 options;			/* Options received */

  /* Entries dr and bdr store IP addresses in OSPFv2 and router IDs in
     OSPFv3, we use the same type to simplify handling */
365 366
  u32 dr;			/* Neighbor's idea of DR */
  u32 bdr;			/* Neighbor's idea of BDR */
367 368 369 370 371 372 373 374 375 376 377 378
  u32 iface_id;			/* ID of Neighbour's iface connected to common network */

  /* Database summary list iterator, controls initial dbdes exchange.
   * Advances in the LSA list as dbdes packets are sent.
   */
  siterator dbsi;		/* iterator of po->lsal */

  /* Link state request list, controls initial LSA exchange.
   * Entries added when received in dbdes packets, removed as sent in lsreq packets.
   */
  slist lsrql;			/* slist of struct top_hash_entry from n->lsrqh */
  struct top_graph *lsrqh;
379
  struct top_hash_entry *lsrqi;	/* Pointer to the first unsent node in lsrql */
380 381 382 383 384 385 386

  /* Link state retransmission list, controls LSA retransmission during flood.
   * Entries added as sent in lsupd packets, removed when received in lsack packets.
   * These entries hold ret_count in appropriate LSA entries.
   */
  slist lsrtl;			/* slist of struct top_hash_entry from n->lsrth */
  struct top_graph *lsrth;
387 388 389
  timer *dbdes_timer;		/* DBDES exchange timer */
  timer *lsrq_timer;		/* LSA request timer */
  timer *lsrt_timer;		/* LSA retransmission timer */
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
  list ackl[2];
#define ACKL_DIRECT 0
#define ACKL_DELAY 1
  timer *ackd_timer;		/* Delayed ack timer */
  struct bfd_request *bfd_req;	/* BFD request, if BFD is used */
  void *ldd_buffer;		/* Last database description packet */
  u32 ldd_bsize;		/* Buffer size for ldd_buffer */
  u32 csn;                      /* Last received crypt seq number (for MD5) */
};


/* OSPF interface types */
#define OSPF_IT_BCAST	0
#define OSPF_IT_NBMA	1
#define OSPF_IT_PTP	2
#define OSPF_IT_PTMP	3
#define OSPF_IT_VLINK	4
#define OSPF_IT_UNDEF	5

/* OSPF interface states */
#define OSPF_IS_DOWN	0	/* Not active */
#define OSPF_IS_LOOP	1	/* Iface with no link */
#define OSPF_IS_WAITING	2	/* Waiting for Wait timer */
#define OSPF_IS_PTP	3	/* PTP operational */
#define OSPF_IS_DROTHER	4	/* I'm on BCAST or NBMA and I'm not DR */
#define OSPF_IS_BACKUP	5	/* I'm BDR */
#define OSPF_IS_DR	6	/* I'm DR */

/* Definitions for interface state machine */
#define ISM_UP		0	/* Interface Up */
#define ISM_WAITF	1	/* Wait timer fired */
#define ISM_BACKS	2	/* Backup seen */
#define ISM_NEICH	3	/* Neighbor change */
#define ISM_LOOP	4	/* Link down */
#define ISM_UNLOOP	5	/* Link up */
#define ISM_DOWN	6	/* Interface down */


/* OSPF neighbor states */
#define NEIGHBOR_DOWN	0
#define NEIGHBOR_ATTEMPT 1
#define NEIGHBOR_INIT	2
#define NEIGHBOR_2WAY	3
#define NEIGHBOR_EXSTART 4
#define NEIGHBOR_EXCHANGE 5
#define NEIGHBOR_LOADING 6
#define NEIGHBOR_FULL	7

/* Definitions for neighbor state machine */
#define INM_HELLOREC	0	/* Hello Received */
#define INM_START	1	/* Neighbor start - for NBMA */
#define INM_2WAYREC	2	/* 2-Way received */
#define INM_NEGDONE	3	/* Negotiation done */
#define INM_EXDONE	4	/* Exchange done */
#define INM_BADLSREQ	5	/* Bad LS Request */
#define INM_LOADDONE	6	/* Load done */
#define INM_ADJOK	7	/* AdjOK? */
#define INM_SEQMIS	8	/* Sequence number mismatch */
#define INM_1WAYREC	9	/* 1-Way */
#define INM_KILLNBR	10	/* Kill Neighbor */
#define INM_INACTTIM	11	/* Inactivity timer */
#define INM_LLDOWN	12	/* Line down */

#define TRANS_OFF	0
#define TRANS_ON	1
#define TRANS_WAIT	2	/* Waiting before the end of translation */



/* Generic option flags */
#define OPT_V6		0x01	/* OSPFv3, LSA relevant for IPv6 routing calculation */
#define OPT_E		0x02	/* Related to AS-external LSAs */
#define OPT_MC		0x04	/* Related to MOSPF, not used and obsolete */
#define OPT_N		0x08	/* Related to NSSA */
#define OPT_P		0x08	/* OSPFv2, flags P and N share position, see NSSA RFC */
#define OPT_EA		0x10	/* OSPFv2, external attributes, not used and obsolete */
#define OPT_R		0x10	/* OSPFv3, originator is active router */
#define OPT_DC		0x20	/* Related to demand circuits, not used */

/* Router-LSA VEB flags are are stored together with links (OSPFv2) or options (OSPFv3) */
#define OPT_RT_B	(0x01 << 24)
#define OPT_RT_E	(0x02 << 24)
#define OPT_RT_V	(0x04 << 24)
#define OPT_RT_NT	(0x10 << 24)

/* Prefix flags, specific for OSPFv3 */
#define OPT_PX_NU	0x01
#define OPT_PX_LA	0x02
#define OPT_PX_P	0x08
#define OPT_PX_DN	0x10


struct ospf_packet
{
  u8 version;
  u8 type;
  u16 length;
  u32 routerid;
  u32 areaid;
  u16 checksum;
  u8 instance_id;		/* See RFC 6549 */
  u8 autype;			/* Undefined for OSPFv3 */
};

494 495 496 497 498 499 500 501 502 503 504 505 506 507
struct ospf_md5
{
  u16 zero;
  u8 keyid;
  u8 len;
  u32 csn;
};

union ospf_auth
{
  u8 password[8];
  struct ospf_md5 md5;
};

508
/* Packet types */
509 510 511 512 513
#define HELLO_P		1	/* Hello */
#define DBDES_P		2	/* Database description */
#define LSREQ_P		3	/* Link state request */
#define LSUPD_P		4	/* Link state update */
#define LSACK_P		5	/* Link state acknowledgement */
514 515


516 517 518 519
#define DBDES_I		4	/* Init bit */
#define DBDES_M		2	/* More bit */
#define DBDES_MS	1	/* Master/Slave bit */
#define DBDES_IMMS	(DBDES_I | DBDES_M | DBDES_MS)
520 521 522 523 524 525 526


#define LSA_T_RT	0x2001
#define LSA_T_NET	0x2002
#define LSA_T_SUM_NET	0x2003
#define LSA_T_SUM_RT	0x2004
#define LSA_T_EXT	0x4005
527
#define LSA_T_NSSA	0x2007
528 529 530
#define LSA_T_LINK	0x0008
#define LSA_T_PREFIX	0x2009

531 532
#define LSA_T_V2_MASK	0x00ff

533 534 535 536 537 538 539
#define LSA_UBIT	0x8000

#define LSA_SCOPE_LINK	0x0000
#define LSA_SCOPE_AREA	0x2000
#define LSA_SCOPE_AS	0x4000
#define LSA_SCOPE_RES	0x6000
#define LSA_SCOPE_MASK	0x6000
540
#define LSA_SCOPE(type)	((type) & LSA_SCOPE_MASK)
541

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575

#define LSA_MAXAGE	3600	/* 1 hour */
#define LSA_CHECKAGE	300	/* 5 minutes */
#define LSA_MAXAGEDIFF	900	/* 15 minutes */

#define LSA_ZEROSEQNO	((s32) 0x80000000)
#define LSA_INITSEQNO	((s32) 0x80000001)
#define LSA_MAXSEQNO	((s32) 0x7fffffff)

#define LSA_METRIC_MASK  0x00FFFFFF
#define LSA_OPTIONS_MASK 0x00FFFFFF


#define LSART_PTP	1
#define LSART_NET	2
#define LSART_STUB	3
#define LSART_VLNK	4

#define LSA_RT2_LINKS	0x0000FFFF

#define LSA_SUM2_TOS	0xFF000000

#define LSA_EXT2_TOS	0x7F000000
#define LSA_EXT2_EBIT	0x80000000

#define LSA_EXT3_EBIT	0x4000000
#define LSA_EXT3_FBIT	0x2000000
#define LSA_EXT3_TBIT	0x1000000


struct ospf_lsa_header
{
  u16 age;			/* LS Age */
  u16 type_raw;			/* Type, mixed with options on OSPFv2 */
576

577
  u32 id;
Ondřej Filip's avatar
Ondřej Filip committed
578 579
  u32 rt;			/* Advertising router */
  s32 sn;			/* LS Sequence number */
580
  u16 checksum;
Ondřej Filip's avatar
Ondřej Filip committed
581
  u16 length;
582 583
};

584

585 586 587
/* In OSPFv2, options are embedded in higher half of type_raw */
static inline u8 lsa_get_options(struct ospf_lsa_header *lsa)
{ return lsa->type_raw >> 8; }
588

589 590
static inline void lsa_set_options(struct ospf_lsa_header *lsa, u16 options)
{ lsa->type_raw = (lsa->type_raw & 0xff) | (options << 8); }
591

592

Ondřej Filip's avatar
Ondřej Filip committed
593 594
struct ospf_lsa_rt
{
595
  u32 options;	/* VEB flags, mixed with link count for OSPFv2 and options for OSPFv3 */
596 597
};

598
struct ospf_lsa_rt2_link
Ondřej Filip's avatar
Ondřej Filip committed
599
{
600 601
  u32 id;
  u32 data;
602
#ifdef CPU_BIG_ENDIAN
603
  u8 type;
604
  u8 no_tos;
605
  u16 metric;
606 607
#else
  u16 metric;
608
  u8 no_tos;
609 610
  u8 type;
#endif
611 612
};

613
struct ospf_lsa_rt2_tos
614
{
615 616 617 618 619 620 621 622 623
#ifdef CPU_BIG_ENDIAN
  u8 tos;
  u8 padding;
  u16 metric;
#else
  u16 metric;
  u8 padding;
  u8 tos;
#endif
624 625
};

626
struct ospf_lsa_rt3_link
627
{
628
#ifdef CPU_BIG_ENDIAN
629
  u8 type;
630 631
  u8 padding;
  u16 metric;
632 633 634 635 636
#else
  u16 metric;
  u8 padding;
  u8 type;
#endif
637 638 639
  u32 lif;	/* Local interface ID */
  u32 nif;	/* Neighbor interface ID */
  u32 id;	/* Neighbor router ID */
640 641
};

642

Ondřej Filip's avatar
Ondřej Filip committed
643 644
struct ospf_lsa_net
{
645
  u32 optx;	/* Netmask for OSPFv2, options for OSPFv3 */
646
  u32 routers[];
647 648
};

649 650 651 652 653 654 655
struct ospf_lsa_sum2
{
  u32 netmask;
  u32 metric;
};

struct ospf_lsa_sum3_net
Ondřej Filip's avatar
Ondřej Filip committed
656
{
657 658
  u32 metric;
  u32 prefix[];
659 660
};

661
struct ospf_lsa_sum3_rt
662 663 664 665 666
{
  u32 options;
  u32 metric;
  u32 drid;
};
Ondřej Filip's avatar
Ondřej Filip committed
667

668 669 670 671 672 673 674 675 676
struct ospf_lsa_ext2
{
  u32 netmask;
  u32 metric;
  u32 fwaddr;
  u32 tag;
};

struct ospf_lsa_ext3
Ondřej Filip's avatar
Ondřej Filip committed
677
{
678 679 680 681
  u32 metric;
  u32 rest[];
};

682 683 684 685 686 687 688 689
struct ospf_lsa_ext_local
{
  ip_addr ip, fwaddr;
  int pxlen;
  u32 metric, ebit, fbit, tag, propagate;
  u8 pxopts;
};

690 691 692
struct ospf_lsa_link
{
  u32 options;
693
  ip6_addr lladdr;
694 695 696 697 698 699
  u32 pxcount;
  u32 rest[];
};

struct ospf_lsa_prefix
{
700
#ifdef CPU_BIG_ENDIAN
701 702
  u16 pxcount;
  u16 ref_type;
703 704 705 706
#else
  u16 ref_type;
  u16 pxcount;
#endif
707 708 709
  u32 ref_id;
  u32 ref_rt;
  u32 rest[];
Ondřej Filip's avatar
Ondřej Filip committed
710 711
};

712

713
static inline uint
714
lsa_net_count(struct ospf_lsa_header *lsa)
715 716 717 718 719
{
  return (lsa->length - sizeof(struct ospf_lsa_header) - sizeof(struct ospf_lsa_net))
    / sizeof(u32);
}

720 721 722 723 724
/* In ospf_area->rtr we store paths to routers, but we use RID (and not IP address)
   as index, so we need to encapsulate RID to IP address */

#define ipa_from_rid(x) ipa_from_u32(x)
#define ipa_to_rid(x) ipa_to_u32(x)
725

726 727 728
#define IPV6_PREFIX_SPACE(x) ((((x) + 63) / 32) * 4)
#define IPV6_PREFIX_WORDS(x) (((x) + 63) / 32)

729 730 731
/* FIXME: these four functions should be significantly redesigned w.r.t. integration,
   also should be named as ospf3_* instead of *_ipv6_* */

732 733 734 735 736 737 738 739 740 741 742
static inline u32 *
lsa_get_ipv6_prefix(u32 *buf, ip_addr *addr, int *pxlen, u8 *pxopts, u16 *rest)
{
  u8 pxl = (*buf >> 24);
  *pxopts = (*buf >> 16);
  *rest = *buf;
  *pxlen = pxl;
  buf++;

  *addr = IPA_NONE;

743
#ifdef IPV6
744 745 746 747 748 749 750 751 752
  if (pxl > 0)
    _I0(*addr) = *buf++;
  if (pxl > 32)
    _I1(*addr) = *buf++;
  if (pxl > 64)
    _I2(*addr) = *buf++;
  if (pxl > 96)
    _I3(*addr) = *buf++;

753 754 755
  /* Clean up remaining bits */
  if (pxl < 128)
    addr->addr[pxl / 32] &= u32_mkmask(pxl % 32);
756
#endif
757

758 759 760 761 762 763 764 765 766 767
  return buf;
}

static inline u32 *
lsa_get_ipv6_addr(u32 *buf, ip_addr *addr)
{
  *addr = *(ip_addr *) buf;
  return buf + 4;
}

768 769 770
static inline u32 *
put_ipv6_prefix(u32 *buf, ip_addr addr, u8 pxlen, u8 pxopts, u16 lh)
{
771
#ifdef IPV6
772 773 774 775 776 777 778 779 780 781
  *buf++ = ((pxlen << 24) | (pxopts << 16) | lh);

  if (pxlen > 0)
    *buf++ = _I0(addr);
  if (pxlen > 32)
    *buf++ = _I1(addr);
  if (pxlen > 64)
    *buf++ = _I2(addr);
  if (pxlen > 96)
    *buf++ = _I3(addr);
782
#endif
783 784 785 786 787 788 789 790 791 792
  return buf;
}

static inline u32 *
put_ipv6_addr(u32 *buf, ip_addr addr)
{
  *(ip_addr *) buf = addr;
  return buf + 4;
}

793

Ondřej Filip's avatar
Ondřej Filip committed
794 795
struct ospf_lsreq_header
{
796
  u32 type;
Ondřej Filip's avatar
Ondřej Filip committed
797
  u32 id;
798
  u32 rt;
799 800
};

801

802 803 804 805 806 807 808 809 810 811 812 813

#define SH_ROUTER_SELF 0xffffffff

struct lsadb_show_data {
  struct symbol *name;	/* Protocol to request data from */
  u16 type;		/* LSA Type, 0 -> all */
  u16 scope;		/* Scope, 0 -> all, hack to handle link scope as 1 */
  u32 area;		/* Specified for area scope */
  u32 lsid;		/* LSA ID, 0 -> all */
  u32 router;		/* Advertising router, 0 -> all */
};

814

815 816 817
#define EA_OSPF_METRIC1	EA_CODE(EAP_OSPF, 0)
#define EA_OSPF_METRIC2	EA_CODE(EAP_OSPF, 1)
#define EA_OSPF_TAG	EA_CODE(EAP_OSPF, 2)
818
#define EA_OSPF_ROUTER_ID EA_CODE(EAP_OSPF, 3)
819

820 821

/* ospf.c */
822
void ospf_schedule_rtcalc(struct ospf_proto *p);
823 824 825 826 827 828 829 830 831 832 833

static inline void ospf_notify_rt_lsa(struct ospf_area *oa)
{ oa->update_rt_lsa = 1; }

static inline void ospf_notify_net_lsa(struct ospf_iface *ifa)
{ ifa->update_net_lsa = 1; }

static inline void ospf_notify_link_lsa(struct ospf_iface *ifa)
{ ifa->update_link_lsa = 1; }


834 835 836
#define ospf_is_v2(X) OSPF_IS_V2
#define ospf_is_v3(X) (!OSPF_IS_V2)
/*
837 838 839 840 841
static inline int ospf_is_v2(struct ospf_proto *p)
{ return p->ospf2; }

static inline int ospf_is_v3(struct ospf_proto *p)
{ return ! p->ospf2; }
842
*/
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
static inline int ospf_get_version(struct ospf_proto *p)
{ return ospf_is_v2(p) ? 2 : 3; }

struct ospf_area *ospf_find_area(struct ospf_proto *p, u32 aid);

static inline struct ospf_area *ospf_main_area(struct ospf_proto *p)
{ return (p->areano == 1) ? HEAD(p->area_list) : p->backbone; }

static inline int oa_is_stub(struct ospf_area *oa)
{ return (oa->options & (OPT_E | OPT_N)) == 0; }

static inline int oa_is_ext(struct ospf_area *oa)
{ return oa->options & OPT_E; }

static inline int oa_is_nssa(struct ospf_area *oa)
{ return oa->options & OPT_N; }

void ospf_sh_neigh(struct proto *P, char *iff);
void ospf_sh(struct proto *P);
void ospf_sh_iface(struct proto *P, char *iff);
void ospf_sh_state(struct proto *P, int verbose, int reachable);

void ospf_sh_lsadb(struct lsadb_show_data *ld);

/* iface.c */
void ospf_iface_chstate(struct ospf_iface *ifa, u8 state);
void ospf_iface_sm(struct ospf_iface *ifa, int event);
struct ospf_iface *ospf_iface_find(struct ospf_proto *p, struct iface *what);
void ospf_if_notify(struct proto *P, uint flags, struct iface *iface);
void ospf_ifa_notify2(struct proto *P, uint flags, struct ifa *a);
void ospf_ifa_notify3(struct proto *P, uint flags, struct ifa *a);
void ospf_iface_info(struct ospf_iface *ifa);
void ospf_iface_new(struct ospf_area *oa, struct ifa *addr, struct ospf_iface_patt *ip);
void ospf_iface_new_vlink(struct ospf_proto *p, struct ospf_iface_patt *ip);
void ospf_iface_remove(struct ospf_iface *ifa);
void ospf_iface_shutdown(struct ospf_iface *ifa);
int ospf_iface_assure_bufsize(struct ospf_iface *ifa, uint plen);
int ospf_iface_reconfigure(struct ospf_iface *ifa, struct ospf_iface_patt *new);
void ospf_reconfigure_ifaces(struct ospf_proto *p);
void ospf_open_vlink_sk(struct ospf_proto *p);
struct nbma_node *find_nbma_node_(list *nnl, ip_addr ip);

static inline struct nbma_node * find_nbma_node(struct ospf_iface *ifa, ip_addr ip)
{ return find_nbma_node_(&ifa->nbma_list, ip); }

/* neighbor.c */
struct ospf_neighbor *ospf_neighbor_new(struct ospf_iface *ifa);
void ospf_neigh_sm(struct ospf_neighbor *n, int event);
void ospf_dr_election(struct ospf_iface *ifa);
struct ospf_neighbor *find_neigh(struct ospf_iface *ifa, u32 rid);
struct ospf_neighbor *find_neigh_by_ip(struct ospf_iface *ifa, ip_addr ip);
void ospf_neigh_update_bfd(struct ospf_neighbor *n, int use_bfd);
void ospf_sh_neigh_info(struct ospf_neighbor *n);

/* packet.c */
void ospf_pkt_fill_hdr(struct ospf_iface *ifa, void *buf, u8 h_type);
uint ospf_pkt_maxsize(struct ospf_iface *ifa);
int ospf_rx_hook(sock * sk, int size);
// void ospf_tx_hook(sock * sk);
void ospf_err_hook(sock * sk, int err);
void ospf_verr_hook(sock *sk, int err);
void ospf_send_to(struct ospf_iface *ifa, ip_addr ip);
void ospf_send_to_agt(struct ospf_iface *ifa, u8 state);
void ospf_send_to_bdr(struct ospf_iface *ifa);

static inline void ospf_send_to_all(struct ospf_iface *ifa)
{ ospf_send_to(ifa, ifa->all_routers); }

static inline void ospf_send_to_des(struct ospf_iface *ifa)
{
  if (ipa_nonzero(ifa->des_routers))
    ospf_send_to(ifa, ifa->des_routers);
  else
    ospf_send_to_bdr(ifa);
}

Ondřej Zajíček's avatar
Ondřej Zajíček committed
919
#ifndef PARSER
920 921 922
#define DROP(DSC,VAL) do { err_dsc = DSC; err_val = VAL; goto drop; } while(0)
#define DROP1(DSC) do { err_dsc = DSC; goto drop; } while(0)
#define SKIP(DSC) do { err_dsc = DSC; goto skip; } while(0)
Ondřej Zajíček's avatar
Ondřej Zajíček committed
923
#endif
924

925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
static inline uint ospf_pkt_hdrlen(struct ospf_proto *p)
{ return ospf_is_v2(p) ? (sizeof(struct ospf_packet) + sizeof(union ospf_auth)) : sizeof(struct ospf_packet); }

static inline void * ospf_tx_buffer(struct ospf_iface *ifa)
{ return ifa->sk->tbuf; }

/* hello.c */
#define OHS_HELLO    0
#define OHS_POLL     1
#define OHS_SHUTDOWN 2

void ospf_send_hello(struct ospf_iface *ifa, int kind, struct ospf_neighbor *dirn);
void ospf_receive_hello(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n, ip_addr faddr);

/* dbdes.c */
940 941
void ospf_send_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
void ospf_rxmt_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
942 943 944 945 946 947 948 949 950
void ospf_receive_dbdes(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);

/* lsreq.c */
void ospf_send_lsreq(struct ospf_proto *p, struct ospf_neighbor *n);
void ospf_receive_lsreq(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);

/* lsupd.c */
void ospf_dump_lsahdr(struct ospf_proto *p, struct ospf_lsa_header *lsa_n);
void ospf_dump_common(struct ospf_proto *p, struct ospf_packet *pkt);
951
void ospf_lsa_lsrt_down_(struct top_hash_entry *en, struct ospf_neighbor *n, struct top_hash_entry *ret);
952
void ospf_add_flushed_to_lsrt(struct ospf_proto *p, struct ospf_neighbor *n);
953
void ospf_flood_event(void *ptr);
954
int ospf_flood_lsa(struct ospf_proto *p, struct top_hash_entry *en, struct ospf_neighbor *from);
955 956 957 958 959 960 961
int ospf_send_lsupd(struct ospf_proto *p, struct top_hash_entry **lsa_list, uint lsa_count, struct ospf_neighbor *n);
void ospf_rxmt_lsupd(struct ospf_proto *p, struct ospf_neighbor *n);
void ospf_receive_lsupd(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);

/* lsack.c */
void ospf_enqueue_lsack(struct ospf_neighbor *n, struct ospf_lsa_header *h_n, int queue);
void ospf_reset_lsack_queue(struct ospf_neighbor *n);
962
void ospf_send_lsack(struct ospf_proto *p, struct ospf_neighbor *n, int queue);
963 964 965
void ospf_receive_lsack(struct ospf_packet *pkt, struct ospf_iface *ifa, struct ospf_neighbor *n);


Ondřej Filip's avatar
Ondřej Filip committed
966
#include "proto/ospf/rt.h"
967
#include "proto/ospf/topology.h"
968
#include "proto/ospf/lsalib.h"
969

970
#endif /* _BIRD_OSPF_H_ */