ospf.h 20.9 KB
Newer Older
1 2 3
/*
 *	BIRD -- OSPF
 *
4
 *	(c) 1999--2005 Ondrej Filip <feela@network.cz>
5 6 7 8 9 10 11
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_OSPF_H_
#define _BIRD_OSPF_H_

12
#define MAXNETS 10
13
#define OSPF_MIN_PKT_SIZE 256
14 15
#define OSPF_MAX_PKT_SIZE 65535

Ondřej Filip's avatar
Ondřej Filip committed
16 17 18 19 20 21 22
#ifdef LOCAL_DEBUG
#define OSPF_FORCE_DEBUG 1
#else
#define OSPF_FORCE_DEBUG 0
#endif
#define OSPF_TRACE(flags, msg, args...) do { if ((p->debug & flags) || OSPF_FORCE_DEBUG) \
  log(L_TRACE "%s: " msg, p->name , ## args ); } while(0)
Ondřej Filip's avatar
Ondřej Filip committed
23

24 25 26 27 28
#define OSPF_PACKET(dumpfn, buffer, msg, args...) \
do { if ((p->debug & D_PACKETS) || OSPF_FORCE_DEBUG) \
{ log(L_TRACE "%s: " msg, p->name, ## args ); dumpfn(p, buffer); } } while(0)


29 30 31
#include "nest/bird.h"

#include "lib/checksum.h"
32 33
#include "lib/ip.h"
#include "lib/lists.h"
34
#include "lib/slists.h"
35 36 37 38 39
#include "lib/socket.h"
#include "lib/timer.h"
#include "lib/resource.h"
#include "nest/protocol.h"
#include "nest/iface.h"
40
#include "nest/route.h"
41
#include "nest/cli.h"
Ondřej Filip's avatar
Ondřej Filip committed
42
#include "nest/locks.h"
43
#include "nest/bfd.h"
44
#include "conf/conf.h"
45
#include "lib/string.h"
46

47
#define OSPF_PROTO 89
48

Ondřej Filip's avatar
Ondřej Filip committed
49
#ifndef IPV6
50
#define OSPFv2 1
51
#define OSPF_VERSION 2
52
#define OSPF_VLINK_MTU 576			/* RFC 2328 A.1 */
53 54
#define AllSPFRouters ipa_from_u32(0xe0000005)	/* 224.0.0.5 */
#define AllDRouters ipa_from_u32(0xe0000006)	/* 224.0.0.6 */
Ondřej Filip's avatar
Ondřej Filip committed
55
#else
56 57
#define OSPFv3 1
#define OSPF_VERSION 3
58
#define OSPF_VLINK_MTU 1280			/* RFC 5340 A.1 */
59 60
#define AllSPFRouters _MI(0xFF020000, 0, 0, 5)	/* FF02::5 */
#define AllDRouters   _MI(0xFF020000, 0, 0, 6)	/* FF02::6 */
Ondřej Filip's avatar
Ondřej Filip committed
61 62
#endif

63

Ondřej Filip's avatar
Ondřej Filip committed
64
#define LSREFRESHTIME 1800	/* 30 minutes */
65 66
#define MINLSINTERVAL 5
#define MINLSARRIVAL 1
Ondřej Filip's avatar
Ondřej Filip committed
67
#define LSINFINITY 0xffffff
Ondřej Filip's avatar
Ondřej Filip committed
68

69
#define DEFAULT_OSPFTICK 1
70
#define DEFAULT_RFC1583 0	/* compatibility with rfc1583 */
71
#define DEFAULT_STUB_COST 1000
72
#define DEFAULT_ECMP_LIMIT 16
73
#define DEFAULT_TRANSINT 40
Ondřej Filip's avatar
Ondřej Filip committed
74

75 76
#define OSPF_VLINK_ID_OFFSET 0x80000000

77

Ondřej Filip's avatar
Ondřej Filip committed
78 79
struct ospf_config
{
80
  struct proto_config c;
81
  unsigned tick;
82
  byte rfc1583;
83
  byte stub_router;
84
  byte abr;
85
  int ecmp;
86 87
  list area_list;		/* list of struct ospf_area_config */
  list vlink_list;		/* list of struct ospf_iface_patt */
Ondřej Filip's avatar
Ondřej Filip committed
88 89
};

Ondřej Filip's avatar
Ondřej Filip committed
90 91
struct nbma_node
{
92 93
  node n;
  ip_addr ip;
94 95
  byte eligible;
  byte found; 
96 97
};

Ondřej Filip's avatar
Ondřej Filip committed
98
struct area_net_config
Ondřej Filip's avatar
Ondřej Filip committed
99
{
100
  node n;
Ondřej Filip's avatar
Ondřej Filip committed
101
  struct prefix px;
102
  int hidden;
103
  u32 tag;
Ondřej Filip's avatar
Ondřej Filip committed
104 105 106 107 108 109
};

struct area_net
{
  struct fib_node fn;
  int hidden;
Ondřej Filip's avatar
Ondřej Filip committed
110
  int active;
111
  u32 metric;
112
  u32 tag;
113 114
};

115 116 117 118 119 120 121 122
struct ospf_stubnet_config
{
  node n;
  struct prefix px;
  int hidden, summary;
  u32 cost;
};

Ondřej Filip's avatar
Ondřej Filip committed
123 124
struct ospf_area_config
{
Ondřej Filip's avatar
Ondřej Filip committed
125 126
  node n;
  u32 areaid;
127
  u32 default_cost;		/* Cost of default route for stub areas */
128 129 130
  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 */
131
  u8 default_nssa;		/* Generate default NSSA route for NSSA+summary area */
132 133
  u8 translator;		/* Translator role, for NSSA ABR */
  u32 transint;			/* Translator stability interval */
Ondřej Filip's avatar
Ondřej Filip committed
134
  list patt_list;
135
  list net_list;	      	/* List of aggregate networks for that area */
136
  list enet_list;	      	/* List of aggregate external (NSSA) networks */
137
  list stubnet_list;		/* List of stub networks added to Router LSA */
138 139
};

140 141 142 143 144 145 146 147

/* Option flags */

#define OPT_E	0x02
#define OPT_N	0x08
#define OPT_DC	0x20

#ifdef OSPFv2
148
#define OPT_P	0x08		/* flags P and N share position, see NSSA RFC */
149 150 151 152 153 154
#define OPT_EA	0x10

/* VEB flags are are stored independently in 'u16 options' */
#define OPT_RT_B  (0x01 << 8)
#define OPT_RT_E  (0x02 << 8)
#define OPT_RT_V  (0x04 << 8)
155
#define OPT_RT_NT (0x10 << 8)
156 157
#endif

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
#ifdef OSPFv3
#define OPT_V6	0x01
#define OPT_R	0x10

/* VEB flags are are stored together with options in 'u32 options' */
#define OPT_RT_B  (0x01 << 24)
#define OPT_RT_E  (0x02 << 24)
#define OPT_RT_V  (0x04 << 24)
#define OPT_RT_NT (0x10 << 24)

#define OPT_PX_NU 0x01
#define OPT_PX_LA 0x02
#define OPT_PX_P  0x08
#define OPT_PX_DN 0x10
#endif
173 174


Ondřej Filip's avatar
Ondřej Filip committed
175 176
struct ospf_iface
{
177
  node n;
178
  struct iface *iface;		/* Nest's iface (NULL for vlinks) */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
179
  struct ifa *addr;		/* IP prefix associated with that OSPF iface */
180
  struct ospf_area *oa;
181
  struct ospf_iface_patt *cf;
182 183
  char *ifname;			/* Interface name (iface->name), new one for vlinks */

184
  pool *pool;
185
  sock *sk;			/* IP socket */
Ondřej Filip's avatar
Ondřej Filip committed
186
  list neigh_list;		/* List of neigbours */
187
  u32 cost;			/* Cost of iface */
188 189 190
  u32 waitint;			/* number of sec before changing state from wait */
  u32 rxmtint;			/* number of seconds between LSA retransmissions */
  u32 pollint;			/* Poll interval */
191
  u32 deadint;			/* after "deadint" missing hellos is router dead */
192 193
  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
194
  ip_addr vip;			/* IP of peer of virtual link */
195 196
  struct ospf_iface *vifa;	/* OSPF iface which the vlink goes through */
  struct ospf_area *voa;	/* OSPF area which the vlink goes through */
197 198 199
  u16 inftransdelay;		/* The estimated number of seconds it takes to
				   transmit a Link State Update Packet over this
				   interface.  LSAs contained in the update */
200
  u16 helloint;			/* number of seconds between hello sending */
201 202

#ifdef OSPFv2
203
  list *passwords;
204
  u16 autype;
205 206
  u32 csn;                      /* Last used crypt seq number */
  bird_clock_t csn_use;         /* Last time when packet with that CSN was sent */
207 208
#endif

209
  ip_addr all_routers;		/*  */
Ondřej Filip's avatar
Ondřej Filip committed
210 211
  ip_addr drip;			/* Designated router */
  ip_addr bdrip;		/* Backup DR */
212
  u32 drid;
Ondřej Filip's avatar
Ondřej Filip committed
213
  u32 bdrid;
214 215
  s16 rt_pos_beg;		/* Position of iface in Router-LSA, begin, inclusive */
  s16 rt_pos_end;		/* Position of iface in Router-LSA, end, exclusive */
216 217

#ifdef OSPFv3
218 219 220
  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 */

221 222 223 224 225
  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 */
#endif

Ondřej Filip's avatar
Ondřej Filip committed
226
  u8 type;			/* OSPF view of type */
227
#define OSPF_IT_BCAST 0
228 229
#define OSPF_IT_NBMA 1
#define OSPF_IT_PTP 2
230 231 232
#define OSPF_IT_PTMP 3
#define OSPF_IT_VLINK 4
#define OSPF_IT_UNDEF 5
Ondřej Filip's avatar
Ondřej Filip committed
233 234 235
  u8 strictnbma;		/* Can I talk with unknown neighbors? */
  u8 stub;			/* Inactive interface */
  u8 state;			/* Interface state machine */
236
#define OSPF_IS_DOWN 0		/* Not working */
237
#define OSPF_IS_LOOP 1		/* Iface with no link */
238 239 240 241 242
#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 */
243 244
  timer *wait_timer;		/* WAIT timer */
  timer *hello_timer;		/* HELLOINT timer */
245
  timer *poll_timer;		/* Poll Interval - for NBMA */
246 247 248
/* Default values for interface parameters */
#define COST_D 10
#define RXMTINT_D 5
249
#define INFTRANSDELAY_D 1
250
#define PRIORITY_D 1
251
#define HELLOINT_D 10
252
#define POLLINT_D 20
253
#define DEADC_D 4
254 255 256 257 258 259 260
#define WAIT_DMH 4		
  /* Value of Wait timer - not found it in RFC * - using 4*HELLO */

  struct top_hash_entry *net_lsa;	/* Originated network LSA */
  int orignet;				/* Schedule network LSA origination */
#ifdef OSPFv3
  int origlink;				/* Schedule link LSA origination */
261
  struct top_hash_entry *link_lsa;	/* Originated link LSA */
262 263 264
  struct top_hash_entry *pxn_lsa;	/* Originated prefix LSA */
#endif
  int fadj;				/* Number of full adjacent neigh */
265
  list nbma_list;
266
  u8 priority;			/* A router priority for DR election */
267
  u8 ioprob;
268 269 270
#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) */
271
  u8 sk_dr; 			/* Socket is a member of DRouters group */
272
  u8 marked;			/* Used in OSPF reconfigure */
273
  u16 rxbuf;			/* Buffer size */
274
  u16 tx_length;		/* Soft TX packet length limit, usually MTU */
275
  u8 check_link;		/* Whether iface link change is used */
276
  u8 ecmp_weight;		/* Weight used for ECMP */
277
  u8 ptp_netmask;		/* Send real netmask for P2P */
278
  u8 check_ttl;			/* Check incoming packets for TTL 255 */
279
  u8 bfd;			/* Use BFD on iface */
280 281
};

282 283 284 285 286 287 288 289 290 291 292 293 294 295
struct ospf_md5
{
  u16 zero;
  u8 keyid;
  u8 len;
  u32 csn;
};

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

296 297

/* Packet types */
Ondřej Filip's avatar
Ondřej Filip committed
298 299 300 301 302
#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 */
303 304

/* Area IDs */
Ondřej Filip's avatar
Ondřej Filip committed
305
#define BACKBONE 0
306 307


Ondřej Filip's avatar
Ondřej Filip committed
308 309
struct immsb
{
310
#ifdef CPU_BIG_ENDIAN
311 312 313 314 315
  u8 padding:5;
  u8 i:1;
  u8 m:1;
  u8 ms:1;
#else
316 317 318 319
  u8 ms:1;
  u8 m:1;
  u8 i:1;
  u8 padding:5;
320
#endif
321 322
};

Ondřej Filip's avatar
Ondřej Filip committed
323 324
union imms
{
325 326 327
  u8 byte;
  struct immsb bit;
};
328 329 330
#define DBDES_MS 1
#define DBDES_M 2
#define DBDES_I 4
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359


#ifdef OSPFv2

struct ospf_packet
{
  u8 version;
  u8 type;
  u16 length;
  u32 routerid;
  u32 areaid;
  u16 checksum;
  u16 autype;
  union ospf_auth u;
};


#else /* OSPFv3 packet descriptions */

struct ospf_packet
{
  u8 version;
  u8 type;
  u16 length;
  u32 routerid;
  u32 areaid;
  u16 checksum;
  u8 instance_id;
  u8 zero;
360 361
};

362

363 364 365 366 367
#endif




Ondřej Filip's avatar
Ondřej Filip committed
368 369 370 371 372 373
struct ospf_lsa_header
{
  u16 age;			/* LS Age */
#define LSA_MAXAGE 3600		/* 1 hour */
#define LSA_CHECKAGE 300	/* 5 minutes */
#define LSA_MAXAGEDIFF 900	/* 15 minutes */
374 375

#ifdef OSPFv2
376
  u8 options;
377
  u8 type;
378 379 380 381 382 383

#define LSA_T_RT	1
#define LSA_T_NET	2
#define LSA_T_SUM_NET	3
#define LSA_T_SUM_RT	4
#define LSA_T_EXT	5
384
#define LSA_T_NSSA	7
385

386 387 388 389 390
#define LSA_SCOPE_AREA	0x2000
#define LSA_SCOPE_AS	0x4000

#define LSA_SCOPE(lsa)	(((lsa)->type == LSA_T_EXT) ? LSA_SCOPE_AS : LSA_SCOPE_AREA)

391 392 393 394 395 396 397 398
#else /* OSPFv3 */
  u16 type;

#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
399
#define LSA_T_NSSA	0x2007
400 401 402 403 404 405 406 407 408 409 410 411 412 413
#define LSA_T_LINK	0x0008
#define LSA_T_PREFIX	0x2009

#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

#define LSA_SCOPE(lsa)	((lsa)->type & LSA_SCOPE_MASK)
#endif

414
  u32 id;
Ondřej Filip's avatar
Ondřej Filip committed
415 416
  u32 rt;			/* Advertising router */
  s32 sn;			/* LS Sequence number */
417 418
#define LSA_INITSEQNO ((s32) 0x80000001)
#define LSA_MAXSEQNO ((s32) 0x7fffffff)
419
  u16 checksum;
Ondřej Filip's avatar
Ondřej Filip committed
420
  u16 length;
421 422
};

423

424 425 426 427 428 429 430
#define LSART_PTP 1
#define LSART_NET 2
#define LSART_STUB 3
#define LSART_VLNK 4


#ifdef OSPFv2
431

Ondřej Filip's avatar
Ondřej Filip committed
432 433
struct ospf_lsa_rt
{
434
#ifdef CPU_BIG_ENDIAN
435
  u16 options;	/* VEB flags only */
436
  u16 links;
437 438 439 440
#else
  u16 links;
  u16 options;	/* VEB flags only */
#endif
441 442
};

Ondřej Filip's avatar
Ondřej Filip committed
443 444
struct ospf_lsa_rt_link
{
445 446
  u32 id;
  u32 data;
447
#ifdef CPU_BIG_ENDIAN
448
  u8 type;
449
  u8 padding;
450
  u16 metric;
451 452 453 454 455
#else
  u16 metric;
  u8 padding;
  u8 type;
#endif
456 457
};

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
struct ospf_lsa_net
{
  ip_addr netmask;
  u32 routers[];
};

struct ospf_lsa_sum
{
  ip_addr netmask;
  u32 metric;
};

struct ospf_lsa_ext
{
  ip_addr netmask;
  u32 metric;
  ip_addr fwaddr;
  u32 tag;
};

478 479
#define LSA_SUM_TOS  0xFF000000
#define LSA_EXT_TOS  0x7F000000
480 481
#define LSA_EXT_EBIT 0x80000000

482 483 484 485
/* Endianity swap for lsa->type */
#define ntoht(x) x
#define htont(x) x

486 487 488 489 490 491 492 493 494 495

#else  /* OSPFv3 */

struct ospf_lsa_rt
{
  u32 options;
};

struct ospf_lsa_rt_link
{
496
#ifdef CPU_BIG_ENDIAN
497
  u8 type;
498 499
  u8 padding;
  u16 metric;
500 501 502 503 504
#else
  u16 metric;
  u8 padding;
  u8 type;
#endif
505 506 507
  u32 lif;	/* Local interface ID */
  u32 nif;	/* Neighbor interface ID */
  u32 id;	/* Neighbor router ID */
508 509
};

Ondřej Filip's avatar
Ondřej Filip committed
510 511
struct ospf_lsa_net
{
512 513
  u32 options;
  u32 routers[];
514 515
};

516
struct ospf_lsa_sum_net
Ondřej Filip's avatar
Ondřej Filip committed
517
{
518 519
  u32 metric;
  u32 prefix[];
520 521
};

522 523 524 525 526 527
struct ospf_lsa_sum_rt
{
  u32 options;
  u32 metric;
  u32 drid;
};
Ondřej Filip's avatar
Ondřej Filip committed
528 529

struct ospf_lsa_ext
Ondřej Filip's avatar
Ondřej Filip committed
530
{
531 532 533 534 535 536 537 538 539 540 541 542 543 544
  u32 metric;
  u32 rest[];
};

struct ospf_lsa_link
{
  u32 options;
  ip_addr lladdr;
  u32 pxcount;
  u32 rest[];
};

struct ospf_lsa_prefix
{
545
#ifdef CPU_BIG_ENDIAN
546 547
  u16 pxcount;
  u16 ref_type;
548 549 550 551
#else
  u16 ref_type;
  u16 pxcount;
#endif
552 553 554
  u32 ref_id;
  u32 ref_rt;
  u32 rest[];
Ondřej Filip's avatar
Ondřej Filip committed
555 556
};

557 558 559 560
#define LSA_EXT_EBIT 0x4000000
#define LSA_EXT_FBIT 0x2000000
#define LSA_EXT_TBIT 0x1000000

561 562 563 564
/* Endianity swap for lsa->type */
#define ntoht(x) ntohs(x)
#define htont(x) htons(x)

565 566 567 568 569
#endif

#define METRIC_MASK  0x00FFFFFF
#define OPTIONS_MASK 0x00FFFFFF

570 571
static inline unsigned
lsa_rt_count(struct ospf_lsa_header *lsa)
572 573 574 575 576
{
  return (lsa->length - sizeof(struct ospf_lsa_header) - sizeof(struct ospf_lsa_rt))
    / sizeof(struct ospf_lsa_rt_link);
}

577 578
static inline unsigned
lsa_net_count(struct ospf_lsa_header *lsa)
579 580 581 582 583 584
{
  return (lsa->length - sizeof(struct ospf_lsa_header) - sizeof(struct ospf_lsa_net))
    / sizeof(u32);
}


585 586
#ifdef OSPFv3

587 588 589
#define IPV6_PREFIX_SPACE(x) ((((x) + 63) / 32) * 4)
#define IPV6_PREFIX_WORDS(x) (((x) + 63) / 32)

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
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;

  if (pxl > 0)
    _I0(*addr) = *buf++;
  if (pxl > 32)
    _I1(*addr) = *buf++;
  if (pxl > 64)
    _I2(*addr) = *buf++;
  if (pxl > 96)
    _I3(*addr) = *buf++;

610 611 612 613
  /* Clean up remaining bits */
  if (pxl < 128)
    addr->addr[pxl / 32] &= u32_mkmask(pxl % 32);

614 615 616 617 618 619 620 621 622 623
  return buf;
}

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

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
static inline u32 *
put_ipv6_prefix(u32 *buf, ip_addr addr, u8 pxlen, u8 pxopts, u16 lh)
{
  *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);
  return buf;
}

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

647 648 649 650
#endif



Ondřej Filip's avatar
Ondřej Filip committed
651 652
struct ospf_lsreq_header
{
653
  u32 type;
Ondřej Filip's avatar
Ondřej Filip committed
654
  u32 id;
Ondřej Filip's avatar
Ondřej Filip committed
655
  u32 rt;			/* Advertising router */
Ondřej Filip's avatar
Ondřej Filip committed
656 657
};

Ondřej Filip's avatar
Ondřej Filip committed
658 659
struct l_lsr_head
{
660 661 662 663
  node n;
  struct ospf_lsreq_header lsh;
};

664

665 666
struct ospf_neighbor
{
667
  node n;
668
  pool *pool;
669
  struct ospf_iface *ifa;
670
  u8 state;
671
#define NEIGHBOR_DOWN 0
672 673 674
#define NEIGHBOR_ATTEMPT 1
#define NEIGHBOR_INIT 2
#define NEIGHBOR_2WAY 3
675
#define NEIGHBOR_EXSTART 4
676 677 678
#define NEIGHBOR_EXCHANGE 5
#define NEIGHBOR_LOADING 6
#define NEIGHBOR_FULL 7
Ondřej Filip's avatar
Ondřej Filip committed
679
  timer *inactim;		/* Inactivity timer */
680
  union imms imms;		/* I, M, Master/slave received */
Ondřej Filip's avatar
Ondřej Filip committed
681 682
  u32 dds;			/* DD Sequence number being sent */
  u32 ddr;			/* last Dat Des packet received */
683
  union imms myimms;		/* I, M Master/slave */
Ondřej Filip's avatar
Ondřej Filip committed
684 685 686 687
  u32 rid;			/* Router ID */
  ip_addr ip;			/* IP of it's interface */
  u8 priority;			/* Priority */
  u8 adj;			/* built adjacency? */
688 689 690 691 692 693 694 695 696 697 698
  u32 options;			/* Options received */

  /* dr and bdr store IP address in OSPFv2 and router ID in OSPFv3,
     we use the same type to simplify handling */
  u32 dr;			/* Neigbour's idea of DR */
  u32 bdr;			/* Neigbour's idea of BDR */

#ifdef OSPFv3
  u32 iface_id;			/* ID of Neighbour's iface connected to common network */
#endif

Ondřej Filip's avatar
Ondřej Filip committed
699 700 701
  siterator dbsi;		/* Database summary list iterator */
  slist lsrql;			/* Link state request */
  struct top_graph *lsrqh;	/* LSA graph */
702
  siterator lsrqi;
Ondřej Filip's avatar
Ondřej Filip committed
703
  slist lsrtl;			/* Link state retransmission list */
704
  siterator lsrti;
Ondřej Filip's avatar
Ondřej Filip committed
705
  struct top_graph *lsrth;
Ondřej Filip's avatar
Ondřej Filip committed
706
  timer *rxmt_timer;		/* RXMT timer */
707 708 709
  list ackl[2];
#define ACKL_DIRECT 0
#define ACKL_DELAY 1
Ondřej Filip's avatar
Ondřej Filip committed
710
  timer *ackd_timer;		/* Delayed ack timer */
711
  struct bfd_request *bfd_req;	/* BFD request, if BFD is used */
712 713
  void *ldd_buffer;		/* Last database description packet */
  u32 ldd_bsize;		/* Buffer size for ldd_buffer */
714
  u32 csn;                      /* Last received crypt seq number (for MD5) */
715 716
};

717
/* Definitions for interface state machine */
Ondřej Filip's avatar
Ondřej Filip committed
718 719 720 721
#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 */
722 723
#define ISM_LOOP 4		/* Link down */
#define ISM_UNLOOP 5		/* Link up */
Ondřej Filip's avatar
Ondřej Filip committed
724
#define ISM_DOWN 6		/* Interface down */
725 726

/* Definitions for neighbor state machine */
Ondřej Filip's avatar
Ondřej Filip committed
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
#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 */

struct ospf_area
{
743
  node n;
744
  u32 areaid;
745
  struct ospf_area_config *ac;	/* Related area config */
746
  struct top_hash_entry *rt;	/* My own router LSA */
747
  struct top_hash_entry *pxr_lsa; /* Originated prefix LSA */
748
  list cand;			/* List of candidates for RT calc. */
Ondřej Filip's avatar
Ondřej Filip committed
749
  struct fib net_fib;		/* Networks to advertise or not */
750
  struct fib enet_fib;		/* External networks for NSSAs */
751
  u32 options;			/* Optional features */
752 753 754
  byte origrt;			/* Rt lsa origination scheduled? */
  byte trcap;			/* Transit capability? */
  byte marked;			/* Used in OSPF reconfigure */
755 756
  byte translate;		/* Translator state (TRANS_*), for NSSA ABR  */
  timer *translator_timer;	/* For NSSA translator switch */
757
  struct proto_ospf *po;
Ondřej Filip's avatar
Ondřej Filip committed
758
  struct fib rtr;		/* Routing tables for routers */
759 760
};

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

Ondřej Filip's avatar
Ondřej Filip committed
765 766
struct proto_ospf
{
767
  struct proto proto;
768 769
  timer *disp_timer;		/* OSPF proto dispatcher */
  unsigned tick;
770 771
  struct top_graph *gr;		/* LSA graph */
  slist lsal;			/* List of all LSA's */
772 773
  int calcrt;			/* Routing table calculation scheduled?
				   0=no, 1=normal, 2=forced reload */
774
  list iface_list;		/* Interfaces we really use */
775
  list area_list;
776
  int areano;			/* Number of area I belong to */
Ondřej Filip's avatar
Ondřej Filip committed
777
  struct fib rtf;		/* Routing table */
778
  byte rfc1583;			/* RFC1583 compatibility */
779
  byte stub_router;		/* Do not forward transit traffic */
780 781
  byte ebit;			/* Did I originate any ext lsa? */
  byte ecmp;			/* Maximal number of nexthops in ECMP route, or 0 */
Ondřej Filip's avatar
Ondřej Filip committed
782
  struct ospf_area *backbone;	/* If exists */
783 784
  void *lsab;			/* LSA buffer used when originating router LSAs */
  int lsab_size, lsab_used;
785
  linpool *nhpool;		/* Linpool used for next hops computed in SPF */
786
  sock *vlink_sk;		/* IP socket used for vlink TX */
787
  u32 router_id;
788
  u32 last_vlink_id;		/* Interface IDs for vlinks (starts at 0x80000000) */
789 790
};

Ondřej Filip's avatar
Ondřej Filip committed
791 792
struct ospf_iface_patt
{
Ondřej Filip's avatar
Ondřej Filip committed
793
  struct iface_patt i;
794 795
  u32 type;
  u32 stub;
796 797 798 799 800 801
  u32 cost;
  u32 helloint;
  u32 rxmtint;
  u32 pollint;
  u32 waitint;
  u32 deadc;
802 803 804
  u32 deadint;
  u32 inftransdelay;
  list nbma_list;
805
  u32 priority;
806
  u32 voa;
Ondřej Filip's avatar
Ondřej Filip committed
807
  u32 vid;
808 809
  int tx_tos;
  int tx_priority;
810 811 812
  u16 tx_length;
  u16 rx_buffer;

813
#define OSPF_RXBUF_MINSIZE 256	/* Minimal allowed size */
814
  u16 autype;			/* Not really used in OSPFv3 */
815 816 817 818
#define OSPF_AUTH_NONE 0
#define OSPF_AUTH_SIMPLE 1
#define OSPF_AUTH_CRYPT 2
#define OSPF_AUTH_CRYPT_SIZE 16
819 820 821 822
  u8 strictnbma;
  u8 check_link;
  u8 ecmp_weight;
  u8 real_bcast;		/* Not really used in OSPFv3 */
823 824
  u8 ptp_netmask;		/* bool + 2 for unspecified */
  u8 ttl_security;		/* bool + 2 for TX only */
825
  u8 bfd;
826
  u8 bsd_secondary;
827 828 829 830 831 832 833 834

#ifdef OSPFv2
  list *passwords;
#endif

#ifdef OSPFv3
  u8 instance_id;
#endif
Ondřej Filip's avatar
Ondřej Filip committed
835 836
};

837
int ospf_import_control(struct proto *p, rte **new, ea_list **attrs,
Ondřej Filip's avatar
Ondřej Filip committed
838
			struct linpool *pool);
839 840
struct ea_list *ospf_make_tmp_attrs(struct rte *rt, struct linpool *pool);
void ospf_store_tmp_attrs(struct rte *rt, struct ea_list *attrs);
841
void schedule_rt_lsa(struct ospf_area *oa);
842
void schedule_rtcalc(struct proto_ospf *po);
Ondřej Filip's avatar
Ondřej Filip committed
843
void schedule_net_lsa(struct ospf_iface *ifa);
844

845
struct ospf_area *ospf_find_area(struct proto_ospf *po, u32 aid);
846 847 848 849 850 851 852 853 854 855
static inline struct ospf_area *ospf_main_area(struct proto_ospf *po)
{ return (po->areano == 1) ? HEAD(po->area_list) : po->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; }

856

857 858 859
#ifdef OSPFv3
void schedule_link_lsa(struct ospf_iface *ifa);
#else
860
static inline void schedule_link_lsa(struct ospf_iface *ifa UNUSED) {}
861 862
#endif

863
void ospf_sh_neigh(struct proto *p, char *iff);
Ondřej Filip's avatar
Ondřej Filip committed
864
void ospf_sh(struct proto *p);
865
void ospf_sh_iface(struct proto *p, char *iff);
866
void ospf_sh_state(struct proto *p, int verbose, int reachable);
867 868 869 870 871 872 873 874 875 876 877 878 879

#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 */
};

void ospf_sh_lsadb(struct lsadb_show_data *ld);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
880

881

882 883 884
#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)
885
#define EA_OSPF_ROUTER_ID EA_CODE(EAP_OSPF, 3)
886

Ondřej Filip's avatar
Ondřej Filip committed
887
#include "proto/ospf/rt.h"
888 889 890 891 892 893
#include "proto/ospf/hello.h"
#include "proto/ospf/packet.h"
#include "proto/ospf/iface.h"
#include "proto/ospf/neighbor.h"
#include "proto/ospf/topology.h"
#include "proto/ospf/dbdes.h"
Ondřej Filip's avatar
Ondřej Filip committed
894
#include "proto/ospf/lsreq.h"
895 896 897
#include "proto/ospf/lsupd.h"
#include "proto/ospf/lsack.h"
#include "proto/ospf/lsalib.h"
898

899
#endif /* _BIRD_OSPF_H_ */