]>
git.ipfire.org Git - thirdparty/bird.git/blob - proto/ospf/ospf.h
4 * (c) 1999--2005 Ondrej Filip <feela@network.cz>
5 * (c) 2009--2014 Ondrej Zajicek <santiago@crfreenet.org>
6 * (c) 2009--2014 CZ.NIC z.s.p.o.
8 * Can be freely distributed and used under the terms of the GNU GPL.
14 #include "nest/bird.h"
16 #include "lib/checksum.h"
18 #include "lib/lists.h"
19 #include "lib/slists.h"
20 #include "lib/socket.h"
21 #include "lib/timer.h"
22 #include "lib/resource.h"
23 #include "nest/protocol.h"
24 #include "nest/iface.h"
25 #include "nest/route.h"
27 #include "nest/locks.h"
29 #include "conf/conf.h"
30 #include "lib/string.h"
34 #define OSPF_FORCE_DEBUG 1
36 #define OSPF_FORCE_DEBUG 0
40 #define OSPF_TRACE(flags, msg, args...) \
41 do { if ((p->p.debug & flags) || OSPF_FORCE_DEBUG) \
42 log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
44 #define OSPF_PACKET(dumpfn, buffer, msg, args...) \
45 do { if ((p->p.debug & D_PACKETS) || OSPF_FORCE_DEBUG) \
46 { log(L_TRACE "%s: " msg, p->p.name, ## args ); dumpfn(p, buffer); } } while(0)
48 #define LOG_PKT(msg, args...) \
49 log_rl(&p->log_pkt_tbf, L_REMOTE "%s: " msg, p->p.name, args)
51 #define LOG_PKT_AUTH(msg, args...) \
52 log_rl(&p->log_pkt_tbf, L_AUTH "%s: " msg, p->p.name, args)
54 #define LOG_PKT_WARN(msg, args...) \
55 log_rl(&p->log_pkt_tbf, L_WARN "%s: " msg, p->p.name, args)
57 #define LOG_LSA1(msg, args...) \
58 log_rl(&p->log_lsa_tbf, L_REMOTE "%s: " msg, p->p.name, args)
60 #define LOG_LSA2(msg, args...) \
61 do { if (! p->log_lsa_tbf.drop) \
62 log(L_REMOTE "%s: " msg, p->p.name, args); } while(0)
67 #define LSREFRESHTIME 1800 /* 30 minutes */
68 #define MINLSINTERVAL (5 S_)
69 #define MINLSARRIVAL (1 S_)
70 #define LSINFINITY 0xffffff
72 #define OSPF_PKT_TYPES 5 /* HELLO_P .. LSACK_P */
73 #define OSPF3_CRYPTO_ID 1 /* OSPFv3 Cryptographic Protocol ID */
75 #define OSPF_DEFAULT_TICK 1
76 #define OSPF_DEFAULT_STUB_COST 1000
77 #define OSPF_DEFAULT_ECMP_LIMIT 16
78 #define OSPF_DEFAULT_GR_TIME 120
79 #define OSPF_DEFAULT_TRANSINT 40
81 #define OSPF_MIN_PKT_SIZE 256
82 #define OSPF_MAX_PKT_SIZE 65535
84 #define OSPF_VLINK_ID_OFFSET 0x80000000
86 #define OSPF_GR_ABLE 1
87 #define OSPF_GR_AWARE 2
91 struct proto_config c
;
104 u8 gr_mode
; /* Graceful restart mode (OSPF_GR_*) */
105 uint gr_time
; /* Graceful restart interval */
107 list area_list
; /* list of area configs (struct ospf_area_config) */
108 list vlink_list
; /* list of configured vlinks (struct ospf_iface_patt) */
111 struct ospf_area_config
115 u32 default_cost
; /* Cost of default route for stub areas
116 (With possible LSA_EXT3_EBIT for NSSA areas) */
117 u8 type
; /* Area type (standard, stub, NSSA), represented
118 by option flags (OPT_E, OPT_N) */
119 u8 summary
; /* Import summaries to this stub/NSSA area, valid for ABR */
120 u8 default_nssa
; /* Generate default NSSA route for NSSA+summary area */
121 u8 translator
; /* Translator role, for NSSA ABR */
122 u32 transint
; /* Translator stability interval */
123 list patt_list
; /* List of iface configs (struct ospf_iface_patt) */
124 list net_list
; /* List of aggregate networks for that area */
125 list enet_list
; /* List of aggregate external (NSSA) networks */
126 list stubnet_list
; /* List of stub networks added to Router LSA */
129 struct area_net_config
139 u32 metric
; /* With possible LSA_EXT3_EBIT for NSSA area nets */
146 struct ospf_stubnet_config
163 struct ospf_iface_patt
184 #define OSPF_RXBUF_MINSIZE 256 /* Minimal allowed size */
187 u8 autype
; /* OSPF_AUTH_*, not really used in OSPFv3 */
191 u8 link_lsa_suppression
;
192 u8 real_bcast
; /* Not really used in OSPFv3 */
193 u8 ptp_netmask
; /* bool + 2 for unspecified */
194 u8 ptp_address
; /* bool + 2 for unspecified */
195 u8 ttl_security
; /* bool + 2 for TX only */
200 /* Default values for interface parameters */
203 #define INFTRANSDELAY_D 1
205 #define HELLOINT_D 10
209 /* Value of Wait timer - not found it in RFC * - using 4*HELLO */
216 timer
*disp_timer
; /* OSPF proto dispatcher */
218 struct top_graph
*gr
; /* LSA graph */
219 slist lsal
; /* List of all LSA's */
220 int calcrt
; /* Routing table calculation scheduled?
221 0=no, 1=normal, 2=forced reload */
222 list iface_list
; /* List of OSPF interfaces (struct ospf_iface) */
223 list area_list
; /* List of OSPF areas (struct ospf_area) */
224 int areano
; /* Number of area I belong to */
225 int padj
; /* Number of neighbors in Exchange or Loading state */
226 int gr_count
; /* Number of neighbors in graceful restart state */
227 u8 gr_recovery
; /* Graceful restart recovery is active */
228 u8 gr_cleanup
; /* GR cleanup scheduled */
229 btime gr_timeout
; /* The end time of grace restart recovery */
230 struct fib rtf
; /* Routing table */
231 struct idm idm
; /* OSPFv3 LSA ID map */
232 u8 ospf2
; /* OSPF v2 or v3 */
233 u8 af_ext
; /* OSPFv3-AF extension */
234 u8 af_mc
; /* OSPFv3-AF multicast */
235 u8 rfc1583
; /* RFC1583 compatibility */
236 u8 stub_router
; /* Do not forward transit traffic */
237 u8 merge_external
; /* Should i merge external routes? */
238 u8 instance_id
; /* Differentiate between more OSPF instances */
239 u8 asbr
; /* May i originate any ext/NSSA lsa? */
240 u8 vpn_pe
; /* Should we do VPN PE specific behavior (RFC 4577)? */
241 u8 ecmp
; /* Maximal number of nexthops in ECMP route, or 0 */
242 u8 gr_mode
; /* Graceful restart mode (OSPF_GR_*) */
243 uint gr_time
; /* Graceful restart interval */
244 u64 csn64
; /* Last used cryptographic sequence number */
245 struct ospf_area
*backbone
; /* If exists */
246 event
*flood_event
; /* Event for flooding LS updates */
247 void *lsab
; /* LSA buffer used when originating router LSAs */
248 int lsab_size
, lsab_used
;
249 linpool
*nhpool
; /* Linpool used for next hops computed in SPF */
250 sock
*vlink_sk
; /* IP socket used for vlink TX */
252 u32 last_vlink_id
; /* Interface IDs for vlinks (starts at 0x80000000) */
253 struct tbf log_pkt_tbf
; /* TBF for packet messages */
254 struct tbf log_lsa_tbf
; /* TBF for LSA messages */
255 ip_addr loopback_addr
; /* IP address used as common next hop (in OSPFv3-IPv4) */
262 struct ospf_area_config
*ac
; /* Related area config */
263 struct top_hash_entry
*rt
; /* My own router LSA */
264 struct top_hash_entry
*pxr_lsa
; /* Originated prefix LSA */
265 list cand
; /* List of candidates for RT calc. */
266 struct fib net_fib
; /* Networks to advertise or not */
267 struct fib enet_fib
; /* External networks for NSSAs */
268 u32 options
; /* Optional features */
269 u8 update_rt_lsa
; /* Rt lsa origination scheduled? */
270 u8 trcap
; /* Transit capability? */
271 u8 marked
; /* Used in OSPF reconfigure */
272 u8 translate
; /* Translator state (TRANS_*), for NSSA ABR */
273 timer
*translator_timer
; /* For NSSA translator switch */
274 struct ospf_proto
*po
;
275 struct fib rtr
; /* Routing tables for routers */
281 struct iface
*iface
; /* Nest's iface (NULL for vlinks) */
282 struct ifa
*addr
; /* IP prefix associated with that OSPF iface */
283 struct ospf_area
*oa
;
284 struct ospf_iface_patt
*cf
;
285 char *ifname
; /* Interface name (iface->name), new one for vlinks */
288 sock
*sk
; /* IP socket */
289 list neigh_list
; /* List of neighbors (struct ospf_neighbor) */
290 u32 cost
; /* Cost of iface */
291 u32 waitint
; /* Number of seconds before changing state from wait */
292 u32 rxmtint
; /* Number of seconds between LSA retransmissions */
293 u32 pollint
; /* Poll interval in seconds */
294 u32 deadint
; /* After deadint seconds without hellos is router dead */
295 u32 iface_id
; /* Interface ID (iface->index or new value for vlinks) */
296 u32 vid
; /* ID of peer of virtual link */
297 ip_addr vip
; /* IP of peer of virtual link */
298 struct ospf_iface
*vifa
; /* OSPF iface which the vlink goes through */
299 struct ospf_area
*voa
; /* OSPF area which the vlink goes through */
300 u16 inftransdelay
; /* The estimated number of seconds it takes to
301 transmit a Link State Update Packet over this
302 interface. LSAs contained in the update */
303 u16 helloint
; /* number of seconds between hello sending */
305 u32 csn
; /* Last used crypt seq number */
306 btime csn_use
; /* Last time when packet with that CSN was sent */
307 ip_addr all_routers
; /* Multicast (or broadcast) address for all routers */
308 ip_addr des_routers
; /* Multicast (or NULL) address for designated routers */
309 ip_addr drip
; /* Designated router IP */
310 ip_addr bdrip
; /* Backup DR IP */
311 u32 drid
; /* DR Router ID */
312 u32 bdrid
; /* BDR Router ID */
313 s16 rt_pos_beg
; /* Position of iface in Router-LSA, begin, inclusive */
314 s16 rt_pos_end
; /* Position of iface in Router-LSA, end, exclusive */
315 s16 px_pos_beg
; /* Position of iface in Rt Prefix-LSA, begin, inclusive */
316 s16 px_pos_end
; /* Position of iface in Rt Prefix-LSA, end, exclusive */
317 u32 dr_iface_id
; /* if drid is valid, this is iface_id of DR (for connecting network) */
318 u8 instance_id
; /* Used to differentiate between more OSPF
319 instances on one interface */
320 u8 autype
; /* Authentication type (OSPF_AUTH_*) */
321 u8 type
; /* OSPF view of type (OSPF_IT_*) */
322 u8 strictnbma
; /* Can I talk with unknown neighbors? */
323 u8 stub
; /* Inactive interface */
324 u8 state
; /* Interface state machine (OSPF_IS_*) */
325 timer
*wait_timer
; /* WAIT timer */
326 timer
*hello_timer
; /* HELLOINT timer */
327 timer
*poll_timer
; /* Poll Interval - for NBMA */
329 struct top_hash_entry
*link_lsa
; /* Originated link LSA */
330 struct top_hash_entry
*net_lsa
; /* Originated network LSA */
331 struct top_hash_entry
*pxn_lsa
; /* Originated prefix LSA */
332 struct top_hash_entry
**flood_queue
; /* LSAs queued for LSUPD */
335 u8 loopback_addr_used
; /* The Link-LSA depends on p->loopback_addr */
336 u16 flood_queue_used
; /* The current number of LSAs in flood_queue */
337 u16 flood_queue_size
; /* The maximum number of LSAs in flood_queue */
338 int fadj
; /* Number of fully adjacent neighbors */
340 u8 priority
; /* A router priority for DR election */
342 #define OSPF_I_OK 0 /* Everything OK */
343 #define OSPF_I_SK 1 /* Socket open failed */
344 #define OSPF_I_LL 2 /* Missing link-local address (OSPFv3) */
345 u8 sk_dr
; /* Socket is a member of designated routers group */
346 u8 marked
; /* Used in OSPF reconfigure, 2 for force restart */
347 u16 rxbuf
; /* Buffer size */
348 u16 tx_length
; /* Soft TX packet length limit, usually MTU */
349 u16 tx_hdrlen
; /* Expected packet header length, less than tx_length */
350 u8 check_link
; /* Whether iface link change is used */
351 u8 ecmp_weight
; /* Weight used for ECMP */
352 u8 link_lsa_suppression
; /* Suppression of Link-LSA origination */
353 u8 ptp_netmask
; /* Send real netmask for P2P */
354 u8 ptp_address
; /* Send IP address in data field for PtP */
355 u8 check_ttl
; /* Check incoming packets for TTL 255 */
356 u8 bfd
; /* Use BFD on iface */
363 struct ospf_iface
*ifa
;
365 u8 gr_active
; /* We act as GR helper for the neighbor */
366 u8 got_my_rt_lsa
; /* Received my Rt-LSA in DBDES exchanged */
367 timer
*inactim
; /* Inactivity timer */
368 u8 imms
; /* I, M, Master/slave received */
369 u8 myimms
; /* I, M Master/slave */
370 u32 dds
; /* DD Sequence number being sent */
371 u32 ddr
; /* last Dat Des packet received */
373 u32 rid
; /* Router ID */
374 ip_addr ip
; /* IP of it's interface */
375 u8 priority
; /* Priority */
376 u32 options
; /* Options received */
378 /* Entries dr and bdr store IP addresses in OSPFv2 and router IDs in
379 OSPFv3, we use the same type to simplify handling */
380 u32 dr
; /* Neighbor's idea of DR */
381 u32 bdr
; /* Neighbor's idea of BDR */
382 u32 iface_id
; /* ID of Neighbour's iface connected to common network */
384 /* Database summary list iterator, controls initial dbdes exchange.
385 * Advances in the LSA list as dbdes packets are sent.
387 siterator dbsi
; /* iterator of po->lsal */
389 /* Link state request list, controls initial LSA exchange.
390 * Entries added when received in dbdes packets, removed as sent in lsreq packets.
392 slist lsrql
; /* slist of struct top_hash_entry from n->lsrqh */
393 struct top_graph
*lsrqh
;
394 struct top_hash_entry
*lsrqi
; /* Pointer to the first unsent node in lsrql */
396 /* Link state retransmission list, controls LSA retransmission during flood.
397 * Entries added as sent in lsupd packets, removed when received in lsack packets.
398 * These entries hold ret_count in appropriate LSA entries.
400 slist lsrtl
; /* slist of struct top_hash_entry from n->lsrth */
401 struct top_graph
*lsrth
;
402 timer
*dbdes_timer
; /* DBDES exchange timer */
403 timer
*lsrq_timer
; /* LSA request timer */
404 timer
*lsrt_timer
; /* LSA retransmission timer */
406 #define ACKL_DIRECT 0
408 timer
*ackd_timer
; /* Delayed ack timer */
409 timer
*gr_timer
; /* Graceful restart timer, non-NULL only if gr_active */
410 struct bfd_request
*bfd_req
; /* BFD request, if BFD is used */
411 void *ldd_buffer
; /* Last database description packet */
412 u32 ldd_bsize
; /* Buffer size for ldd_buffer */
413 u32 csn
; /* OSPFv2: Last received crypt seq number */
414 u64 csn64
[OSPF_PKT_TYPES
]; /* OSPFv3: Last received CSN for each type of packet */
418 /* OSPF interface types */
419 #define OSPF_IT_BCAST 0
420 #define OSPF_IT_NBMA 1
421 #define OSPF_IT_PTP 2
422 #define OSPF_IT_PTMP 3
423 #define OSPF_IT_VLINK 4
424 #define OSPF_IT_UNDEF 5
426 /* OSPF interface states */
427 #define OSPF_IS_DOWN 0 /* Not active */
428 #define OSPF_IS_LOOP 1 /* Iface with no link */
429 #define OSPF_IS_WAITING 2 /* Waiting for Wait timer */
430 #define OSPF_IS_PTP 3 /* PTP operational */
431 #define OSPF_IS_DROTHER 4 /* I'm on BCAST or NBMA and I'm not DR */
432 #define OSPF_IS_BACKUP 5 /* I'm BDR */
433 #define OSPF_IS_DR 6 /* I'm DR */
435 /* Definitions for interface state machine */
436 #define ISM_UP 0 /* Interface Up */
437 #define ISM_WAITF 1 /* Wait timer fired */
438 #define ISM_BACKS 2 /* Backup seen */
439 #define ISM_NEICH 3 /* Neighbor change */
440 #define ISM_LOOP 4 /* Link down */
441 #define ISM_UNLOOP 5 /* Link up */
442 #define ISM_DOWN 6 /* Interface down */
444 /* OSPF authentication types */
445 #define OSPF_AUTH_NONE 0
446 #define OSPF_AUTH_SIMPLE 1
447 #define OSPF_AUTH_CRYPT 2
449 #define OSPF3_AUTH_HMAC 1 /* HMAC Cryptographic Authentication */
451 /* OSPF neighbor states */
452 #define NEIGHBOR_DOWN 0
453 #define NEIGHBOR_ATTEMPT 1
454 #define NEIGHBOR_INIT 2
455 #define NEIGHBOR_2WAY 3
456 #define NEIGHBOR_EXSTART 4
457 #define NEIGHBOR_EXCHANGE 5
458 #define NEIGHBOR_LOADING 6
459 #define NEIGHBOR_FULL 7
461 /* Definitions for neighbor state machine */
462 #define INM_HELLOREC 0 /* Hello Received */
463 #define INM_START 1 /* Neighbor start - for NBMA */
464 #define INM_2WAYREC 2 /* 2-Way received */
465 #define INM_NEGDONE 3 /* Negotiation done */
466 #define INM_EXDONE 4 /* Exchange done */
467 #define INM_BADLSREQ 5 /* Bad LS Request */
468 #define INM_LOADDONE 6 /* Load done */
469 #define INM_ADJOK 7 /* AdjOK? */
470 #define INM_SEQMIS 8 /* Sequence number mismatch */
471 #define INM_1WAYREC 9 /* 1-Way */
472 #define INM_KILLNBR 10 /* Kill Neighbor */
473 #define INM_INACTTIM 11 /* Inactivity timer */
474 #define INM_LLDOWN 12 /* Line down */
478 #define TRANS_WAIT 2 /* Waiting before the end of translation */
481 /* Generic option flags */
482 #define OPT_V6 0x0001 /* OSPFv3, LSA relevant for IPv6 routing calculation */
483 #define OPT_E 0x0002 /* Related to AS-external LSAs */
484 #define OPT_MC 0x0004 /* Related to MOSPF, not used and obsolete */
485 #define OPT_N 0x0008 /* Related to NSSA */
486 #define OPT_P 0x0008 /* OSPFv2, flags P and N share position, see NSSA RFC */
487 #define OPT_L_V2 0x0010 /* OSPFv2, link-local signaling, not used */
488 #define OPT_R 0x0010 /* OSPFv3, originator is active router */
489 #define OPT_DC 0x0020 /* Related to demand circuits, not used */
490 #define OPT_O 0x0040 /* OSPFv2 Opaque LSA (RFC 5250) */
491 #define OPT_DN 0x0080 /* OSPFv2 VPN loop prevention (RFC 4576) */
492 #define OPT_AF 0x0100 /* OSPFv3 Address Families (RFC 5838) */
493 #define OPT_L_V3 0x0200 /* OSPFv3, link-local signaling */
494 #define OPT_AT 0x0400 /* OSPFv3, authentication trailer */
496 #define HELLO2_OPT_MASK (OPT_E | OPT_N | OPT_L_V2)
497 #define DBDES2_OPT_MASK (OPT_E | OPT_L_V2 | OPT_O)
499 #define HELLO3_OPT_MASK (OPT_V6 | OPT_E | OPT_N | OPT_R | OPT_AF | OPT_L_V3 | OPT_AT )
500 #define DBDES3_OPT_MASK (OPT_V6 | OPT_E | OPT_R | OPT_AF | OPT_L_V3 | OPT_AT )
502 /* Router-LSA VEB flags are are stored together with links (OSPFv2) or options (OSPFv3) */
503 #define OPT_RT_B (0x01 << 24)
504 #define OPT_RT_E (0x02 << 24)
505 #define OPT_RT_V (0x04 << 24)
506 #define OPT_RT_NT (0x10 << 24)
508 /* Prefix flags, specific for OSPFv3 */
509 #define OPT_PX_NU 0x01
510 #define OPT_PX_LA 0x02
511 #define OPT_PX_P 0x08
512 #define OPT_PX_DN 0x10
523 u8 instance_id
; /* See RFC 6549 */
524 u8 autype
; /* Undefined for OSPFv3 */
534 struct ospf_auth_crypto
539 u32 csn
; /* Cryptographic sequence number (32-bit) */
545 struct ospf_auth_crypto c32
;
550 u16 type
; /* Authentication type (OSPF3_AUTH_*) */
551 u16 length
; /* Authentication trailer length (header + data) */
553 u16 sa_id
; /* Security association identifier (key_id) */
554 u64 csn
; /* Cryptographic sequence number (64-bit) */
555 byte data
[0]; /* Authentication data */
560 #define HELLO_P 1 /* Hello */
561 #define DBDES_P 2 /* Database description */
562 #define LSREQ_P 3 /* Link state request */
563 #define LSUPD_P 4 /* Link state update */
564 #define LSACK_P 5 /* Link state acknowledgement */
567 #define DBDES_I 4 /* Init bit */
568 #define DBDES_M 2 /* More bit */
569 #define DBDES_MS 1 /* Master/Slave bit */
570 #define DBDES_IMMS (DBDES_I | DBDES_M | DBDES_MS)
573 /* OSPFv3 LSA Types / LSA Function Codes */
574 /* https://www.iana.org/assignments/ospfv3-parameters/ospfv3-parameters.xhtml#ospfv3-parameters-3 */
575 #define LSA_T_RT 0x2001
576 #define LSA_T_NET 0x2002
577 #define LSA_T_SUM_NET 0x2003
578 #define LSA_T_SUM_RT 0x2004
579 #define LSA_T_EXT 0x4005
580 #define LSA_T_NSSA 0x2007
581 #define LSA_T_LINK 0x0008
582 #define LSA_T_PREFIX 0x2009
583 #define LSA_T_GR 0x000B
584 #define LSA_T_RI_ 0x000C
585 #define LSA_T_RI_LINK 0x800C
586 #define LSA_T_RI_AREA 0xA00C
587 #define LSA_T_RI_AS 0xC00C
588 #define LSA_T_OPAQUE_ 0x1FFF
589 #define LSA_T_OPAQUE_LINK 0x9FFF
590 #define LSA_T_OPAQUE_AREA 0xBFFF
591 #define LSA_T_OPAQUE_AS 0xDFFF
593 #define LSA_T_V2_OPAQUE_ 0x0009
594 #define LSA_T_V2_MASK 0x00ff
596 /* OSPFv2 Opaque LSA Types */
597 /* https://www.iana.org/assignments/ospf-opaque-types/ospf-opaque-types.xhtml#ospf-opaque-types-2 */
598 #define LSA_OT_GR 0x03
599 #define LSA_OT_RI 0x04
601 #define LSA_FUNCTION_MASK 0x1FFF
602 #define LSA_FUNCTION(type) ((type) & LSA_FUNCTION_MASK)
604 #define LSA_UBIT 0x8000
606 #define LSA_SCOPE_LINK 0x0000
607 #define LSA_SCOPE_AREA 0x2000
608 #define LSA_SCOPE_AS 0x4000
609 #define LSA_SCOPE_RES 0x6000
610 #define LSA_SCOPE_MASK 0x6000
611 #define LSA_SCOPE(type) ((type) & LSA_SCOPE_MASK)
612 #define LSA_SCOPE_ORDER(type) (((type) >> 13) & 0x3)
615 #define LSA_MAXAGE 3600 /* 1 hour */
616 #define LSA_CHECKAGE 300 /* 5 minutes */
617 #define LSA_MAXAGEDIFF 900 /* 15 minutes */
619 #define LSA_ZEROSEQNO ((s32) 0x80000000)
620 #define LSA_INITSEQNO ((s32) 0x80000001)
621 #define LSA_MAXSEQNO ((s32) 0x7fffffff)
623 #define LSA_METRIC_MASK 0x00FFFFFF
624 #define LSA_OPTIONS_MASK 0x00FFFFFF
632 #define LSA_RT2_LINKS 0x0000FFFF
634 #define LSA_SUM2_TOS 0xFF000000
636 #define LSA_EXT2_TOS 0x7F000000
637 #define LSA_EXT2_EBIT 0x80000000
639 #define LSA_EXT3_EBIT 0x04000000
640 #define LSA_EXT3_FBIT 0x02000000
641 #define LSA_EXT3_TBIT 0x01000000
643 /* OSPF Grace LSA (GR) TLVs */
644 /* https://www.iana.org/assignments/ospfv2-parameters/ospfv2-parameters.xhtml#ospfv2-parameters-13 */
645 #define LSA_GR_PERIOD 1
646 #define LSA_GR_REASON 2
647 #define LSA_GR_ADDRESS 3
649 /* OSPF Router Information (RI) TLVs */
650 /* https://www.iana.org/assignments/ospf-parameters/ospf-parameters.xhtml#ri-tlv */
654 /* OSPF Router Informational Capability Bits */
655 /* https://www.iana.org/assignments/ospf-parameters/ospf-parameters.xhtml#router-informational-capability */
656 #define LSA_RIC_GR_CAPABLE 0
657 #define LSA_RIC_GR_HELPER 1
658 #define LSA_RIC_STUB_ROUTER 2
661 struct ospf_lsa_header
663 u16 age
; /* LS Age */
664 u16 type_raw
; /* Type, mixed with options on OSPFv2 */
667 u32 rt
; /* Advertising router */
668 s32 sn
; /* LS Sequence number */
674 /* In OSPFv2, options are embedded in higher half of type_raw */
675 static inline u8
lsa_get_options(struct ospf_lsa_header
*lsa
)
676 { return lsa
->type_raw
>> 8; }
678 static inline void lsa_set_options(struct ospf_lsa_header
*lsa
, u16 options
)
679 { lsa
->type_raw
= (lsa
->type_raw
& 0xff) | (options
<< 8); }
684 u32 options
; /* VEB flags, mixed with link count for OSPFv2 and options for OSPFv3 */
687 struct ospf_lsa_rt2_link
691 #ifdef CPU_BIG_ENDIAN
702 struct ospf_lsa_rt2_tos
704 #ifdef CPU_BIG_ENDIAN
715 struct ospf_lsa_rt3_link
717 #ifdef CPU_BIG_ENDIAN
726 u32 lif
; /* Local interface ID */
727 u32 nif
; /* Neighbor interface ID */
728 u32 id
; /* Neighbor router ID */
734 u32 optx
; /* Netmask for OSPFv2, options for OSPFv3 */
744 struct ospf_lsa_sum3_net
750 struct ospf_lsa_sum3_rt
771 struct ospf_lsa_ext_local
775 u32 metric
, ebit
, fbit
, tag
, propagate
, downwards
;
787 struct ospf_lsa_prefix
789 #ifdef CPU_BIG_ENDIAN
803 #ifdef CPU_BIG_ENDIAN
815 lsa_net_count(struct ospf_lsa_header
*lsa
)
817 return (lsa
->length
- sizeof(struct ospf_lsa_header
) - sizeof(struct ospf_lsa_net
))
821 /* In ospf_area->rtr we store paths to routers, but we use RID (and not IP address)
822 as index, so we need to encapsulate RID to IP address */
824 #define net_from_rid(x) NET_ADDR_IP4(ip4_from_u32(x), IP4_MAX_PREFIX_LENGTH)
825 #define rid_from_net(x) ip4_to_u32(((net_addr_ip4 *) x)->prefix)
827 #define IPV6_PREFIX_SPACE(x) ((((x) + 63) / 32) * 4)
828 #define IPV6_PREFIX_WORDS(x) (((x) + 63) / 32)
832 ospf_valid_prefix(net_addr
*n
)
835 * In OSPFv2, prefix is stored as netmask; ip4_masklen() returns 255 for
836 * invalid one. But OSPFv3-AF may receive IPv4 net with 32 < pxlen < 128.
838 uint max
= (n
->type
== NET_IP4
) ? IP4_MAX_PREFIX_LENGTH
: IP6_MAX_PREFIX_LENGTH
;
839 return n
->pxlen
<= max
;
843 * In OSPFv3-AF (RFC 5835), IPv4 address is encoded by just placing it in the
844 * first 32 bits of IPv6 address and setting remaining bits to zero. Likewise
845 * for IPv4 prefix, where remaining bits do not matter. We use following
846 * functions to convert between IPv4 and IPv4-in-IPv6 representations:
849 static inline ip4_addr
ospf3_6to4(ip6_addr a
)
850 { return _MI4(_I0(a
)); }
852 static inline ip6_addr
ospf3_4to6(ip4_addr a
)
853 { return _MI6(_I(a
), 0, 0, 0); }
857 ospf3_get_prefix(u32
*buf
, int af
, net_addr
*n
, u8
*pxopts
, u16
*rest
)
859 ip6_addr px
= IP6_NONE
;
860 uint pxlen
= (*buf
>> 24);
861 *pxopts
= (*buf
>> 16) & 0xff;
862 if (rest
) *rest
= *buf
& 0xffff;
874 /* Clean up remaining bits */
876 px
.addr
[pxlen
/ 32] &= u32_mkmask(pxlen
% 32);
879 net_fill_ip4(n
, ospf3_6to4(px
), pxlen
);
881 net_fill_ip6(n
, px
, pxlen
);
887 ospf3_put_prefix(u32
*buf
, net_addr
*n
, u8 pxopts
, u16 rest
)
889 ip6_addr px
= (n
->type
== NET_IP4
) ? ospf3_4to6(net4_prefix(n
)) : net6_prefix(n
);
890 uint pxlen
= n
->pxlen
;
892 *buf
++ = ((pxlen
<< 24) | (pxopts
<< 16) | rest
);
907 ospf3_get_addr(u32
*buf
, int af
, ip_addr
*addr
)
911 *addr
= (af
== NET_IP4
) ? ipa_from_ip4(ospf3_6to4(a
)) : ipa_from_ip6(a
);
916 ospf3_put_addr(u32
*buf
, ip_addr addr
)
918 ip6_addr a
= ipa_is_ip4(addr
) ? ospf3_4to6(ipa_to_ip4(addr
)) : ipa_to_ip6(addr
);
924 struct ospf_lsreq_header
933 #define SH_ROUTER_SELF 0xffffffff
935 struct lsadb_show_data
{
936 struct ospf_proto
*proto
; /* Protocol to request data from */
937 u16 type
; /* LSA Type, 0 -> all */
938 u16 scope
; /* Scope, 0 -> all, hack to handle link scope as 1 */
939 u32 area
; /* Specified for area scope */
940 u32 lsid
; /* LSA ID, 0 -> all */
941 u32 router
; /* Advertising router, 0 -> all */
945 #define EA_OSPF_METRIC1 EA_CODE(PROTOCOL_OSPF, 0)
946 #define EA_OSPF_METRIC2 EA_CODE(PROTOCOL_OSPF, 1)
947 #define EA_OSPF_TAG EA_CODE(PROTOCOL_OSPF, 2)
948 #define EA_OSPF_ROUTER_ID EA_CODE(PROTOCOL_OSPF, 3)
952 * For regular networks, neighbor address must match network prefix.
953 * For unnumbered networks, we consider every address local.
955 static inline int ospf_ipa_local(ip_addr a
, const struct ifa
*addr
)
956 { return ipa_in_netX(a
, &addr
->prefix
) || (addr
->flags
& IA_HOST
); }
960 void ospf_schedule_rtcalc(struct ospf_proto
*p
);
962 static inline void ospf_notify_rt_lsa(struct ospf_area
*oa
)
963 { oa
->update_rt_lsa
= 1; }
965 static inline void ospf_notify_net_lsa(struct ospf_iface
*ifa
)
966 { ifa
->update_net_lsa
= 1; }
968 static inline void ospf_notify_link_lsa(struct ospf_iface
*ifa
)
969 { ifa
->update_link_lsa
= 1; }
971 static inline int ospf_is_v2(struct ospf_proto
*p
)
974 static inline int ospf_is_v3(struct ospf_proto
*p
)
975 { return ! p
->ospf2
; }
977 static inline int ospf_get_version(struct ospf_proto
*p
)
978 { return ospf_is_v2(p
) ? 2 : 3; }
980 static inline int ospf_is_ip4(struct ospf_proto
*p
)
981 { return p
->p
.net_type
== NET_IP4
; }
983 static inline int ospf_is_ip6(struct ospf_proto
*p
)
984 { return p
->p
.net_type
== NET_IP6
; }
986 static inline int ospf_get_af(struct ospf_proto
*p
)
987 { return p
->p
.net_type
; }
989 struct ospf_area
*ospf_find_area(struct ospf_proto
*p
, u32 aid
);
991 static inline struct ospf_area
*ospf_main_area(struct ospf_proto
*p
)
992 { return (p
->areano
== 1) ? HEAD(p
->area_list
) : p
->backbone
; }
994 static inline int oa_is_stub(struct ospf_area
*oa
)
995 { return (oa
->options
& (OPT_E
| OPT_N
)) == 0; }
997 static inline int oa_is_ext(struct ospf_area
*oa
)
998 { return oa
->options
& OPT_E
; }
1000 static inline int oa_is_nssa(struct ospf_area
*oa
)
1001 { return oa
->options
& OPT_N
; }
1003 void ospf_stop_gr_recovery(struct ospf_proto
*p
);
1005 void ospf_sh_neigh(struct proto
*P
, const char *iff
);
1006 void ospf_sh(struct proto
*P
);
1007 void ospf_sh_iface(struct proto
*P
, const char *iff
);
1008 void ospf_sh_state(struct proto
*P
, int verbose
, int reachable
);
1010 void ospf_sh_lsadb(struct lsadb_show_data
*ld
);
1013 void ospf_iface_chstate(struct ospf_iface
*ifa
, u8 state
);
1014 void ospf_iface_sm(struct ospf_iface
*ifa
, int event
);
1015 struct ospf_iface
*ospf_iface_find(struct ospf_proto
*p
, struct iface
*what
);
1016 void ospf_if_notify(struct proto
*P
, uint flags
, struct iface
*iface
);
1017 void ospf_ifa_notify2(struct proto
*P
, uint flags
, struct ifa
*a
);
1018 void ospf_ifa_notify3(struct proto
*P
, uint flags
, struct ifa
*a
);
1019 void ospf_iface_info(struct ospf_iface
*ifa
);
1020 void ospf_iface_new(struct ospf_area
*oa
, struct ifa
*addr
, struct ospf_iface_patt
*ip
);
1021 void ospf_iface_new_vlink(struct ospf_proto
*p
, struct ospf_iface_patt
*ip
);
1022 void ospf_iface_remove(struct ospf_iface
*ifa
);
1023 void ospf_iface_shutdown(struct ospf_iface
*ifa
);
1024 int ospf_iface_assure_bufsize(struct ospf_iface
*ifa
, uint plen
);
1025 int ospf_iface_reconfigure(struct ospf_iface
*ifa
, struct ospf_iface_patt
*new);
1026 void ospf_reconfigure_ifaces(struct ospf_proto
*p
);
1027 void ospf_open_vlink_sk(struct ospf_proto
*p
);
1028 struct nbma_node
*find_nbma_node_(list
*nnl
, ip_addr ip
);
1030 static inline struct nbma_node
* find_nbma_node(struct ospf_iface
*ifa
, ip_addr ip
)
1031 { return find_nbma_node_(&ifa
->nbma_list
, ip
); }
1033 static inline u32
ospf_iface_get_data(struct ospf_iface
*ifa
)
1036 * Return expected value of the link data field in Rt-LSA for given iface.
1037 * It should be ifa->iface_id for unnumbered PtP links, IP address otherwise
1038 * (see RFC 2328 12.4.1.1). It is controlled by ifa->ptp_address field so it
1039 * can be overriden for compatibility purposes.
1042 return ((ifa
->type
== OSPF_IT_PTP
) && !ifa
->ptp_address
) ?
1044 ipa_to_u32(ifa
->addr
->ip
);
1048 struct ospf_neighbor
*ospf_neighbor_new(struct ospf_iface
*ifa
);
1049 void ospf_neigh_sm(struct ospf_neighbor
*n
, int event
);
1050 void ospf_neigh_cancel_graceful_restart(struct ospf_neighbor
*n
);
1051 void ospf_neigh_notify_grace_lsa(struct ospf_neighbor
*n
, struct top_hash_entry
*en
);
1052 void ospf_neigh_lsadb_changed_(struct ospf_proto
*p
, struct top_hash_entry
*en
);
1053 void ospf_dr_election(struct ospf_iface
*ifa
);
1054 struct ospf_neighbor
*find_neigh(struct ospf_iface
*ifa
, u32 rid
);
1055 struct ospf_neighbor
*find_neigh_by_ip(struct ospf_iface
*ifa
, ip_addr ip
);
1056 void ospf_neigh_update_bfd(struct ospf_neighbor
*n
, int use_bfd
);
1057 void ospf_sh_neigh_info(struct ospf_neighbor
*n
);
1059 static inline void ospf_neigh_lsadb_changed(struct ospf_proto
*p
, struct top_hash_entry
*en
)
1060 { if (p
->gr_count
) ospf_neigh_lsadb_changed_(p
, en
); }
1063 void ospf_pkt_fill_hdr(struct ospf_iface
*ifa
, void *buf
, u8 h_type
);
1064 int ospf_rx_hook(sock
* sk
, uint size
);
1065 // void ospf_tx_hook(sock * sk);
1066 void ospf_err_hook(sock
* sk
, int err
);
1067 void ospf_verr_hook(sock
*sk
, int err
);
1068 void ospf_send_to(struct ospf_iface
*ifa
, ip_addr ip
);
1069 void ospf_send_to_iface(struct ospf_iface
*ifa
);
1071 static inline void ospf_send_to_nbr(struct ospf_iface
*ifa
, struct ospf_neighbor
*n
)
1072 { ospf_send_to(ifa
, (ifa
->type
== OSPF_IT_PTP
) ? ifa
->all_routers
: n
->ip
); }
1074 static inline void ospf_send_to_all(struct ospf_iface
*ifa
)
1075 { ospf_send_to(ifa
, ifa
->all_routers
); }
1077 static inline uint
ospf_pkt_maxsize(struct ospf_iface
*ifa
)
1078 { return ifa
->tx_length
- ifa
->tx_hdrlen
; }
1081 #define DROP(DSC,VAL) do { err_dsc = DSC; err_val = VAL; goto drop; } while(0)
1082 #define DROP1(DSC) do { err_dsc = DSC; goto drop; } while(0)
1083 #define SKIP(DSC) do { err_dsc = DSC; goto skip; } while(0)
1086 static inline uint
ospf_pkt_hdrlen(struct ospf_proto
*p
)
1087 { return ospf_is_v2(p
) ? (sizeof(struct ospf_packet
) + sizeof(union ospf_auth2
)) : sizeof(struct ospf_packet
); }
1089 static inline void * ospf_tx_buffer(struct ospf_iface
*ifa
)
1090 { return ifa
->sk
->tbuf
; }
1095 #define OHS_SHUTDOWN 2
1097 void ospf_send_hello(struct ospf_iface
*ifa
, int kind
, struct ospf_neighbor
*dirn
);
1098 void ospf_receive_hello(struct ospf_packet
*pkt
, struct ospf_iface
*ifa
, struct ospf_neighbor
*n
, ip_addr faddr
);
1099 uint
ospf_hello3_options(struct ospf_packet
*pkt
);
1102 void ospf_send_dbdes(struct ospf_proto
*p
, struct ospf_neighbor
*n
);
1103 void ospf_rxmt_dbdes(struct ospf_proto
*p
, struct ospf_neighbor
*n
);
1104 void ospf_reset_ldd(struct ospf_proto
*p
, struct ospf_neighbor
*n
);
1105 void ospf_receive_dbdes(struct ospf_packet
*pkt
, struct ospf_iface
*ifa
, struct ospf_neighbor
*n
);
1106 uint
ospf_dbdes3_options(struct ospf_packet
*pkt
);
1109 void ospf_send_lsreq(struct ospf_proto
*p
, struct ospf_neighbor
*n
);
1110 void ospf_receive_lsreq(struct ospf_packet
*pkt
, struct ospf_iface
*ifa
, struct ospf_neighbor
*n
);
1113 void ospf_dump_lsahdr(struct ospf_proto
*p
, struct ospf_lsa_header
*lsa_n
);
1114 void ospf_dump_common(struct ospf_proto
*p
, struct ospf_packet
*pkt
);
1115 void ospf_lsa_lsrt_down_(struct top_hash_entry
*en
, struct ospf_neighbor
*n
, struct top_hash_entry
*ret
);
1116 void ospf_add_flushed_to_lsrt(struct ospf_proto
*p
, struct ospf_neighbor
*n
);
1117 void ospf_flood_event(void *ptr
);
1118 int ospf_flood_lsa(struct ospf_proto
*p
, struct top_hash_entry
*en
, struct ospf_neighbor
*from
);
1119 int ospf_send_lsupd(struct ospf_proto
*p
, struct top_hash_entry
**lsa_list
, uint lsa_count
, struct ospf_neighbor
*n
);
1120 void ospf_rxmt_lsupd(struct ospf_proto
*p
, struct ospf_neighbor
*n
);
1121 void ospf_receive_lsupd(struct ospf_packet
*pkt
, struct ospf_iface
*ifa
, struct ospf_neighbor
*n
);
1124 void ospf_enqueue_lsack(struct ospf_neighbor
*n
, struct ospf_lsa_header
*h_n
, int queue
);
1125 void ospf_reset_lsack_queue(struct ospf_neighbor
*n
);
1126 void ospf_send_lsack(struct ospf_proto
*p
, struct ospf_neighbor
*n
, int queue
);
1127 void ospf_receive_lsack(struct ospf_packet
*pkt
, struct ospf_iface
*ifa
, struct ospf_neighbor
*n
);
1130 #include "proto/ospf/rt.h"
1131 #include "proto/ospf/topology.h"
1132 #include "proto/ospf/lsalib.h"
1134 #endif /* _BIRD_OSPF_H_ */