ospf.h 28.8 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
#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 23 24
#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
#ifdef LOCAL_DEBUG
#define OSPF_FORCE_DEBUG 1
#else
#define OSPF_FORCE_DEBUG 0
#endif


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

#define OSPF_PACKET(dumpfn, buffer, msg, args...) \
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
  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)
63 64 65


#define OSPF_PROTO 89
66

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

72 73 74 75 76 77 78
#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
79

80 81
#define OSPF_VLINK_ID_OFFSET 0x80000000

Ondřej Filip's avatar
Ondřej Filip committed
82 83
struct ospf_config
{
84
  struct proto_config c;
85
  uint tick;
86
  u8 ospf2;
87 88
  u8 af_ext;
  u8 af_mc;
89 90 91 92
  u8 rfc1583;
  u8 stub_router;
  u8 merge_external;
  u8 instance_id;
93
  u8 instance_id_set;
94 95
  u8 abr;
  u8 asbr;
96
  int ecmp;
97 98
  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
99 100
};

101
struct ospf_area_config
Ondřej Filip's avatar
Ondřej Filip committed
102
{
103
  node n;
104 105 106 107 108 109 110 111 112 113
  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) */
114 115
  list net_list;		/* List of aggregate networks for that area */
  list enet_list;		/* List of aggregate external (NSSA) networks */
116
  list stubnet_list;		/* List of stub networks added to Router LSA */
117 118
};

Ondřej Filip's avatar
Ondřej Filip committed
119
struct area_net_config
Ondřej Filip's avatar
Ondřej Filip committed
120
{
121
  node n;
122
  net_addr prefix;
123
  u32 tag;
124
  u8 hidden;
Ondřej Filip's avatar
Ondřej Filip committed
125 126 127 128
};

struct area_net
{
129
  u32 metric;			/* With possible LSA_EXT3_EBIT for NSSA area nets */
130
  u32 tag;
131 132
  u8 hidden;
  u8 active;
133
  struct fib_node fn;
134 135
};

136 137 138
struct ospf_stubnet_config
{
  node n;
139
  net_addr prefix;
140
  u32 cost;
141 142
  u8 hidden;
  u8 summary;
143 144
};

145
struct nbma_node
Ondřej Filip's avatar
Ondřej Filip committed
146
{
Ondřej Filip's avatar
Ondřej Filip committed
147
  node n;
148 149
  ip_addr ip;
  byte eligible;
150
  byte found;
151 152
};

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
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;
#define OSPF_RXBUF_MINSIZE 256	/* Minimal allowed size */
  u8 instance_id;
176
  u8 instance_id_set;
177
  u8 autype;			/* OSPF_AUTH_*, not really used in OSPFv3 */
178 179 180 181 182 183 184 185 186 187
  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;
  list *passwords;
};
188 189 190 191 192 193 194 195 196

/* 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
197
#define WAIT_DMH 4
198
  /* Value of Wait timer - not found it in RFC * - using 4*HELLO */
199 200


201 202 203 204 205 206 207 208 209 210 211 212 213 214 215

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 */
216
  struct idm idm;		/* OSPFv3 LSA ID map */
217 218 219 220 221 222 223 224
  u8 ospf2;			/* OSPF v2 or v3 */
  u8 af_ext;			/* OSPFv3-AF extension */
  u8 af_mc;			/* OSPFv3-AF multicast */
  u8 rfc1583;			/* RFC1583 compatibility */
  u8 stub_router;		/* Do not forward transit traffic */
  u8 merge_external;		/* Should i merge external routes? */
  u8 asbr;			/* May i originate any ext/NSSA lsa? */
  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 228 229 230 231 232
  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) */
233 234
  struct tbf log_pkt_tbf;	/* TBF for packet messages */
  struct tbf log_lsa_tbf;	/* TBF for LSA messages */
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
};

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
259 260
struct ospf_iface
{
261
  node n;
262
  struct iface *iface;		/* Nest's iface (NULL for vlinks) */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
263
  struct ifa *addr;		/* IP prefix associated with that OSPF iface */
264
  struct ospf_area *oa;
265
  struct ospf_iface_patt *cf;
266 267
  char *ifname;			/* Interface name (iface->name), new one for vlinks */

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 273 274
  u32 waitint;			/* number of sec before changing state from wait */
  u32 rxmtint;			/* number of seconds between LSA retransmissions */
  u32 pollint;			/* Poll interval */
275
  u32 deadint;			/* after "deadint" missing hellos is router dead */
276 277
  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
278
  ip_addr vip;			/* IP of peer of virtual link */
279 280
  struct ospf_iface *vifa;	/* OSPF iface which the vlink goes through */
  struct ospf_area *voa;	/* OSPF area which the vlink goes through */
281 282 283
  u16 inftransdelay;		/* The estimated number of seconds it takes to
				   transmit a Link State Update Packet over this
				   interface.  LSAs contained in the update */
284
  u16 helloint;			/* number of seconds between hello sending */
285
  list *passwords;
286 287
  u32 csn;                      /* Last used crypt seq number */
  bird_clock_t csn_use;         /* Last time when packet with that CSN was sent */
288 289 290 291 292 293
  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 */
294 295 296 297
  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 */
298 299 300
  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 */
301 302
  u8 autype;			/* Authentication type (OSPF_AUTH_*) */
  u8 type;			/* OSPF view of type (OSPF_IT_*) */
Ondřej Filip's avatar
Ondřej Filip committed
303 304
  u8 strictnbma;		/* Can I talk with unknown neighbors? */
  u8 stub;			/* Inactive interface */
305
  u8 state;			/* Interface state machine (OSPF_IS_*) */
306 307
  timer *wait_timer;		/* WAIT timer */
  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 315
  u8 update_link_lsa;
  u8 update_net_lsa;
316 317
  u16 flood_queue_used;		/* The current number of LSAs in flood_queue */
  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 323 324
#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) */
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 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
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 */
358 359
  u32 dr;			/* Neighbor's idea of DR */
  u32 bdr;			/* Neighbor's idea of BDR */
360 361 362 363 364 365 366 367 368 369 370 371
  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;
372
  struct top_hash_entry *lsrqi;	/* Pointer to the first unsent node in lsrql */
373 374 375 376 377 378 379

  /* 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;
380 381 382
  timer *dbdes_timer;		/* DBDES exchange timer */
  timer *lsrq_timer;		/* LSA request timer */
  timer *lsrt_timer;		/* LSA retransmission timer */
383 384 385 386 387 388 389 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
  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 */

420 421 422 423 424
/* OSPF authentication types */
#define OSPF_AUTH_NONE	0
#define OSPF_AUTH_SIMPLE 1
#define OSPF_AUTH_CRYPT	2

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

/* 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 */
457 458 459 460 461 462 463 464 465
#define OPT_V6		0x0001	/* OSPFv3, LSA relevant for IPv6 routing calculation */
#define OPT_E		0x0002	/* Related to AS-external LSAs */
#define OPT_MC		0x0004	/* Related to MOSPF, not used and obsolete */
#define OPT_N		0x0008	/* Related to NSSA */
#define OPT_P		0x0008	/* OSPFv2, flags P and N share position, see NSSA RFC */
#define OPT_EA		0x0010	/* OSPFv2, external attributes, not used and obsolete */
#define OPT_R		0x0010	/* OSPFv3, originator is active router */
#define OPT_DC		0x0020	/* Related to demand circuits, not used */
#define OPT_AF		0x0100	/* OSPFv3 Address Families (RFC 5838) */
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

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

492
struct ospf_auth_crypto
493 494 495 496 497 498 499 500 501 502
{
  u16 zero;
  u8 keyid;
  u8 len;
  u32 csn;
};

union ospf_auth
{
  u8 password[8];
503
  struct ospf_auth_crypto c32;
504 505
};

506
/* Packet types */
507 508 509 510 511
#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 */
512 513


514 515 516 517
#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)
518 519 520 521 522 523 524


#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
525
#define LSA_T_NSSA	0x2007
526 527 528
#define LSA_T_LINK	0x0008
#define LSA_T_PREFIX	0x2009

529 530
#define LSA_T_V2_MASK	0x00ff

531 532 533 534 535 536 537
#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
538
#define LSA_SCOPE(type)	((type) & LSA_SCOPE_MASK)
539

540 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

#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 */
574

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

582

583 584 585
/* 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; }
586

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

590

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

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

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

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

640

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

647 648 649 650 651 652 653
struct ospf_lsa_sum2
{
  u32 netmask;
  u32 metric;
};

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

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

666 667 668 669 670 671 672 673 674
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
675
{
676 677 678 679
  u32 metric;
  u32 rest[];
};

680 681
struct ospf_lsa_ext_local
{
682 683
  net_addr net;
  ip_addr fwaddr;
684 685 686 687
  u32 metric, ebit, fbit, tag, propagate;
  u8 pxopts;
};

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

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

710

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

718 719 720
/* 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 */

721 722
#define net_from_rid(x) NET_ADDR_IP4(ip4_from_u32(x), IP4_MAX_PREFIX_LENGTH)
#define rid_from_net(x) ip4_to_u32(((net_addr_ip4 *) x)->prefix)
723

724 725 726
#define IPV6_PREFIX_SPACE(x) ((((x) + 63) / 32) * 4)
#define IPV6_PREFIX_WORDS(x) (((x) + 63) / 32)

727

728 729 730
static inline int
ospf_valid_prefix(net_addr *n)
{
731 732 733 734 735 736
  /*
   * In OSPFv2, prefix is stored as netmask; ip4_masklen() returns 255 for
   * invalid one. But OSPFv3-AF may receive IPv4 net with 32 < pxlen < 128.
   */
  uint max = (n->type == NET_IP4) ? IP4_MAX_PREFIX_LENGTH : IP6_MAX_PREFIX_LENGTH;
  return n->pxlen <= max;
737 738
}

739 740 741 742 743 744 745 746 747 748 749 750 751 752
/*
 * In OSPFv3-AF (RFC 5835), IPv4 address is encoded by just placing it in the
 * first 32 bits of IPv6 address and setting remaining bits to zero. Likewise
 * for IPv4 prefix, where remaining bits do not matter. We use following
 * functions to convert between IPv4 and IPv4-in-IPv6 representations:
 */

static inline ip4_addr ospf3_6to4(ip6_addr a)
{ return _MI4(_I0(a)); }

static inline ip6_addr ospf3_4to6(ip4_addr a)
{ return _MI6(_I(a), 0, 0, 0); }


753
static inline u32 *
754
ospf3_get_prefix(u32 *buf, int af, net_addr *n, u8 *pxopts, u16 *rest)
755
{
756 757
  ip6_addr px = IP6_NONE;
  uint pxlen = (*buf >> 24);
758 759
  *pxopts = (*buf >> 16) & 0xff;
  if (rest) *rest = *buf & 0xffff;
760 761
  buf++;

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 776 777 778
  if (af == NET_IP4)
    net_fill_ip4(n, ospf3_6to4(px), pxlen);
  else
    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 787
  ip6_addr px = (n->type == NET_IP4) ? ospf3_4to6(net4_prefix(n)) : net6_prefix(n);
  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 801 802 803
  return buf;
}

static inline u32 *
804
ospf3_get_addr(u32 *buf, int af, ip_addr *addr)
805
{
806 807 808 809 810 811 812 813 814 815 816
  ip6_addr a;
  memcpy(&a, buf, 16);
  *addr = (af == NET_IP4) ? ipa_from_ip4(ospf3_6to4(a)) : ipa_from_ip6(a);
  return buf + 4;
}

static inline u32 *
ospf3_put_addr(u32 *buf, ip_addr addr)
{
  ip6_addr a = ipa_is_ip4(addr) ? ospf3_4to6(ipa_to_ip4(addr)) : ipa_to_ip6(addr);
  memcpy(buf, &a, 16);
817 818 819
  return buf + 4;
}

820

Ondřej Filip's avatar
Ondřej Filip committed
821 822
struct ospf_lsreq_header
{
823
  u32 type;
Ondřej Filip's avatar
Ondřej Filip committed
824
  u32 id;
825
  u32 rt;
826 827
};

828

829 830 831 832 833 834 835 836 837 838 839 840

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

841

842 843 844
#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)
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 852 853 854 855 856 857 858 859 860 861 862 863 864

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; }

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; }
865

866 867 868
static inline int ospf_get_version(struct ospf_proto *p)
{ return ospf_is_v2(p) ? 2 : 3; }

869 870 871 872 873 874 875 876 877
static inline int ospf_is_ip4(struct ospf_proto *p)
{ return p->p.net_type == NET_IP4; }

static inline int ospf_is_ip6(struct ospf_proto *p)
{ return p->p.net_type == NET_IP6; }

static inline int ospf_get_af(struct ospf_proto *p)
{ return p->p.net_type; }

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 919 920 921 922 923 924 925 926 927 928 929 930
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);
931
int ospf_rx_hook(sock * sk, uint size);
932 933 934 935 936 937 938
// 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);

939 940 941
static inline uint ospf_pkt_maxsize(struct ospf_iface *ifa)
{ return ifa->tx_length - ifa->tx_hdrlen; }

942 943 944 945 946 947 948 949 950 951 952
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
953
#ifndef PARSER
954 955 956
#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
957
#endif
958

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
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 */
974 975
void ospf_send_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
void ospf_rxmt_dbdes(struct ospf_proto *p, struct ospf_neighbor *n);
976 977 978 979 980 981 982 983 984
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);
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 990 991 992 993 994 995
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);
996
void ospf_send_lsack(struct ospf_proto *p, struct ospf_neighbor *n, int queue);
997 998 999
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
1000
#include "proto/ospf/rt.h"
1001
#include "proto/ospf/topology.h"
1002
#include "proto/ospf/lsalib.h"
1003

1004
#endif /* _BIRD_OSPF_H_ */