1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * IS-IS TLV Serializer/Deserializer
5 * Copyright (C) 2015,2017 Christian Franke
7 * Copyright (C) 2019 Olivier Dugeon - Orange Labs (for TE and SR)
12 #include "openbsd-tree.h"
15 DECLARE_MTYPE(ISIS_SUBTLV
);
20 struct isis_area_address
{
21 struct isis_area_address
*next
;
27 #define ISIS_WIDE_METRIC_INFINITY 0xFFFFFE
28 #define ISIS_NARROW_METRIC_INFINITY 62
30 struct isis_oldstyle_reach
{
31 struct isis_oldstyle_reach
*next
;
37 struct isis_oldstyle_ip_reach
{
38 struct isis_oldstyle_ip_reach
*next
;
41 struct prefix_ipv4 prefix
;
44 struct isis_lsp_entry
{
45 struct isis_lsp_entry
*next
;
47 uint16_t rem_lifetime
;
55 struct isis_extended_reach
{
56 struct isis_extended_reach
*next
;
61 struct isis_ext_subtlvs
*subtlvs
;
64 struct isis_extended_ip_reach
{
65 struct isis_extended_ip_reach
*next
;
69 struct prefix_ipv4 prefix
;
71 struct isis_subtlvs
*subtlvs
;
74 struct isis_ipv6_reach
{
75 struct isis_ipv6_reach
*next
;
81 struct prefix_ipv6 prefix
;
83 struct isis_subtlvs
*subtlvs
;
86 struct isis_protocols_supported
{
91 #define ISIS_TIER_UNDEFINED 15
93 struct isis_spine_leaf
{
102 enum isis_threeway_state
{
103 ISIS_THREEWAY_DOWN
= 2,
104 ISIS_THREEWAY_INITIALIZING
= 1,
108 struct isis_threeway_adj
{
109 enum isis_threeway_state state
;
110 uint32_t local_circuit_id
;
112 uint8_t neighbor_id
[6];
113 uint32_t neighbor_circuit_id
;
116 /* Segment Routing subTLV's as per RFC8667 */
117 #define ISIS_SUBTLV_SRGB_FLAG_I 0x80
118 #define ISIS_SUBTLV_SRGB_FLAG_V 0x40
119 #define IS_SR_IPV4(srgb) ((srgb)->flags & ISIS_SUBTLV_SRGB_FLAG_I)
120 #define IS_SR_IPV6(srgb) ((srgb)->flags & ISIS_SUBTLV_SRGB_FLAG_V)
121 #define SUBTLV_SR_BLOCK_SIZE 6
122 #define SUBTLV_RANGE_INDEX_SIZE 10
123 #define SUBTLV_RANGE_LABEL_SIZE 9
125 /* Structure aggregating SR Global (SRGB) or Local (SRLB) Block info */
126 struct isis_sr_block
{
129 uint32_t lower_bound
;
132 /* Prefix-SID sub-TLVs flags */
133 #define ISIS_PREFIX_SID_READVERTISED 0x80
134 #define ISIS_PREFIX_SID_NODE 0x40
135 #define ISIS_PREFIX_SID_NO_PHP 0x20
136 #define ISIS_PREFIX_SID_EXPLICIT_NULL 0x10
137 #define ISIS_PREFIX_SID_VALUE 0x08
138 #define ISIS_PREFIX_SID_LOCAL 0x04
140 struct isis_prefix_sid
{
141 struct isis_prefix_sid
*next
;
148 /* Adj-SID and LAN-Ajd-SID sub-TLVs flags */
149 #define EXT_SUBTLV_LINK_ADJ_SID_FFLG 0x80
150 #define EXT_SUBTLV_LINK_ADJ_SID_BFLG 0x40
151 #define EXT_SUBTLV_LINK_ADJ_SID_VFLG 0x20
152 #define EXT_SUBTLV_LINK_ADJ_SID_LFLG 0x10
153 #define EXT_SUBTLV_LINK_ADJ_SID_SFLG 0x08
154 #define EXT_SUBTLV_LINK_ADJ_SID_PFLG 0x04
156 struct isis_adj_sid
{
157 struct isis_adj_sid
*next
;
165 struct isis_lan_adj_sid
{
166 struct isis_lan_adj_sid
*next
;
171 uint8_t neighbor_id
[ISIS_SYS_ID_LEN
];
175 /* RFC 4971 & RFC 7981 */
176 #define ISIS_ROUTER_CAP_FLAG_S 0x01
177 #define ISIS_ROUTER_CAP_FLAG_D 0x02
178 #define ISIS_ROUTER_CAP_SIZE 5
180 /* Number of supported algorithm for Segment Routing.
181 * Right now only 2 have been standardized:
185 #define SR_ALGORITHM_COUNT 2
186 #define SR_ALGORITHM_SPF 0
187 #define SR_ALGORITHM_STRICT_SPF 1
188 #define SR_ALGORITHM_UNSET 255
190 #define MSD_TYPE_BASE_MPLS_IMPOSITION 0x01
191 #define MSD_TLV_SIZE 2
193 struct isis_router_cap
{
194 struct in_addr router_id
;
197 /* RFC 8667 section #3 */
198 struct isis_sr_block srgb
;
199 struct isis_sr_block srlb
;
200 uint8_t algo
[SR_ALGORITHM_COUNT
];
206 struct isis_item
*next
;
209 struct isis_lan_neighbor
{
210 struct isis_lan_neighbor
*next
;
215 struct isis_ipv4_address
{
216 struct isis_ipv4_address
*next
;
221 struct isis_ipv6_address
{
222 struct isis_ipv6_address
*next
;
224 struct in6_addr addr
;
227 struct isis_mt_router_info
{
228 struct isis_mt_router_info
*next
;
236 struct isis_auth
*next
;
245 size_t offset
; /* Only valid after packing */
248 struct isis_item_list
{
249 struct isis_item
*head
;
250 struct isis_item
**tail
;
252 RB_ENTRY(isis_item_list
) mt_tree
;
257 struct isis_purge_originator
{
260 uint8_t generator
[6];
264 enum isis_auth_result
{
266 ISIS_AUTH_TYPE_FAILURE
,
268 ISIS_AUTH_NO_VALIDATOR
,
271 RB_HEAD(isis_mt_item_list
, isis_item_list
);
273 struct isis_item_list
*isis_get_mt_items(struct isis_mt_item_list
*m
,
275 struct isis_item_list
*isis_lookup_mt_items(struct isis_mt_item_list
*m
,
279 struct isis_item_list isis_auth
;
280 struct isis_purge_originator
*purge_originator
;
281 struct isis_item_list area_addresses
;
282 struct isis_item_list oldstyle_reach
;
283 struct isis_item_list lan_neighbor
;
284 struct isis_item_list lsp_entries
;
285 struct isis_item_list extended_reach
;
286 struct isis_mt_item_list mt_reach
;
287 struct isis_item_list oldstyle_ip_reach
;
288 struct isis_protocols_supported protocols_supported
;
289 struct isis_item_list oldstyle_ip_reach_ext
;
290 struct isis_item_list ipv4_address
;
291 struct isis_item_list ipv6_address
;
292 struct isis_item_list global_ipv6_address
;
293 struct isis_item_list mt_router_info
;
294 bool mt_router_info_empty
;
295 struct in_addr
*te_router_id
;
296 struct in6_addr
*te_router_id_ipv6
;
297 struct isis_item_list extended_ip_reach
;
298 struct isis_mt_item_list mt_ip_reach
;
300 struct isis_item_list ipv6_reach
;
301 struct isis_mt_item_list mt_ipv6_reach
;
302 struct isis_threeway_adj
*threeway_adj
;
303 struct isis_router_cap
*router_cap
;
304 struct isis_spine_leaf
*spine_leaf
;
307 enum isis_tlv_context
{
309 ISIS_CONTEXT_SUBTLV_NE_REACH
,
310 ISIS_CONTEXT_SUBTLV_IP_REACH
,
311 ISIS_CONTEXT_SUBTLV_IPV6_REACH
,
315 struct isis_subtlvs
{
316 enum isis_tlv_context context
;
318 /* draft-baker-ipv6-isis-dst-src-routing-06 */
319 struct prefix_ipv6
*source_prefix
;
320 /* RFC 8667 section #2.4 */
321 struct isis_item_list prefix_sids
;
325 /* TLVs code point */
326 ISIS_TLV_AREA_ADDRESSES
= 1,
327 ISIS_TLV_OLDSTYLE_REACH
= 2,
328 ISIS_TLV_LAN_NEIGHBORS
= 6,
329 ISIS_TLV_PADDING
= 8,
330 ISIS_TLV_LSP_ENTRY
= 9,
332 ISIS_TLV_PURGE_ORIGINATOR
= 13,
333 ISIS_TLV_EXTENDED_REACH
= 22,
335 ISIS_TLV_OLDSTYLE_IP_REACH
= 128,
336 ISIS_TLV_PROTOCOLS_SUPPORTED
= 129,
337 ISIS_TLV_OLDSTYLE_IP_REACH_EXT
= 130,
338 ISIS_TLV_IPV4_ADDRESS
= 132,
339 ISIS_TLV_TE_ROUTER_ID
= 134,
340 ISIS_TLV_EXTENDED_IP_REACH
= 135,
341 ISIS_TLV_DYNAMIC_HOSTNAME
= 137,
342 ISIS_TLV_TE_ROUTER_ID_IPV6
= 140,
343 ISIS_TLV_SPINE_LEAF_EXT
= 150,
344 ISIS_TLV_MT_REACH
= 222,
345 ISIS_TLV_MT_ROUTER_INFO
= 229,
346 ISIS_TLV_IPV6_ADDRESS
= 232,
347 ISIS_TLV_GLOBAL_IPV6_ADDRESS
= 233,
348 ISIS_TLV_MT_IP_REACH
= 235,
349 ISIS_TLV_IPV6_REACH
= 236,
350 ISIS_TLV_MT_IPV6_REACH
= 237,
351 ISIS_TLV_THREE_WAY_ADJ
= 240,
352 ISIS_TLV_ROUTER_CAPABILITY
= 242,
355 /* subTLVs code point */
356 ISIS_SUBTLV_IPV6_SOURCE_PREFIX
= 22,
358 /* RFC 5305 & RFC 6119 */
359 ISIS_SUBTLV_ADMIN_GRP
= 3,
360 ISIS_SUBTLV_LOCAL_IPADDR
= 6,
361 ISIS_SUBTLV_RMT_IPADDR
= 8,
362 ISIS_SUBTLV_MAX_BW
= 9,
363 ISIS_SUBTLV_MAX_RSV_BW
= 10,
364 ISIS_SUBTLV_UNRSV_BW
= 11,
365 ISIS_SUBTLV_LOCAL_IPADDR6
= 12,
366 ISIS_SUBTLV_RMT_IPADDR6
= 13,
367 ISIS_SUBTLV_TE_METRIC
= 18,
370 ISIS_SUBTLV_LLRI
= 4,
373 ISIS_SUBTLV_NODE_MSD
= 23,
376 ISIS_SUBTLV_RAS
= 24,
377 ISIS_SUBTLV_RIP
= 25,
379 /* RFC 8667 section #4 IANA allocation */
380 ISIS_SUBTLV_SID_LABEL
= 1,
381 ISIS_SUBTLV_SID_LABEL_RANGE
= 2,
382 ISIS_SUBTLV_ALGORITHM
= 19,
383 ISIS_SUBTLV_SRLB
= 22,
384 ISIS_SUBTLV_PREFIX_SID
= 3,
385 ISIS_SUBTLV_ADJ_SID
= 31,
386 ISIS_SUBTLV_LAN_ADJ_SID
= 32,
389 ISIS_SUBTLV_AV_DELAY
= 33,
390 ISIS_SUBTLV_MM_DELAY
= 34,
391 ISIS_SUBTLV_DELAY_VAR
= 35,
392 ISIS_SUBTLV_PKT_LOSS
= 36,
393 ISIS_SUBTLV_RES_BW
= 37,
394 ISIS_SUBTLV_AVA_BW
= 38,
395 ISIS_SUBTLV_USE_BW
= 39,
400 /* subTLVs size for TE and SR */
401 enum ext_subtlv_size
{
403 ISIS_SUBTLV_LLRI_SIZE
= 8,
405 /* RFC 5305 & RFC 6119 */
406 ISIS_SUBTLV_UNRSV_BW_SIZE
= 32,
407 ISIS_SUBTLV_TE_METRIC_SIZE
= 3,
408 ISIS_SUBTLV_IPV6_ADDR_SIZE
= 16,
411 ISIS_SUBTLV_NODE_MSD_SIZE
= 2,
413 /* RFC 8667 sections #2 & #3 */
414 ISIS_SUBTLV_SID_LABEL_SIZE
= 3,
415 ISIS_SUBTLV_SID_INDEX_SIZE
= 4,
416 ISIS_SUBTLV_SID_LABEL_RANGE_SIZE
= 9,
417 ISIS_SUBTLV_ALGORITHM_SIZE
= 4,
418 ISIS_SUBTLV_ADJ_SID_SIZE
= 5,
419 ISIS_SUBTLV_LAN_ADJ_SID_SIZE
= 11,
420 ISIS_SUBTLV_PREFIX_SID_SIZE
= 5,
423 ISIS_SUBTLV_MM_DELAY_SIZE
= 8,
425 ISIS_SUBTLV_HDR_SIZE
= 2,
426 ISIS_SUBTLV_DEF_SIZE
= 4,
429 ISIS_SUBTLV_EXT_ADMIN_GRP
= 14,
431 ISIS_SUBTLV_MAX_SIZE
= 180
434 /* Macros to manage the optional presence of EXT subTLVs */
435 #define SET_SUBTLV(s, t) ((s->status) |= (t))
436 #define UNSET_SUBTLV(s, t) ((s->status) &= ~(t))
437 #define IS_SUBTLV(s, t) (s->status & t)
439 #define EXT_DISABLE 0x000000
440 #define EXT_ADM_GRP 0x000001
441 #define EXT_LLRI 0x000002
442 #define EXT_LOCAL_ADDR 0x000004
443 #define EXT_NEIGH_ADDR 0x000008
444 #define EXT_LOCAL_ADDR6 0x000010
445 #define EXT_NEIGH_ADDR6 0x000020
446 #define EXT_MAX_BW 0x000040
447 #define EXT_MAX_RSV_BW 0x000080
448 #define EXT_UNRSV_BW 0x000100
449 #define EXT_TE_METRIC 0x000200
450 #define EXT_RMT_AS 0x000400
451 #define EXT_RMT_IP 0x000800
452 #define EXT_ADJ_SID 0x001000
453 #define EXT_LAN_ADJ_SID 0x002000
454 #define EXT_DELAY 0x004000
455 #define EXT_MM_DELAY 0x008000
456 #define EXT_DELAY_VAR 0x010000
457 #define EXT_PKT_LOSS 0x020000
458 #define EXT_RES_BW 0x040000
459 #define EXT_AVA_BW 0x080000
460 #define EXT_USE_BW 0x100000
461 #define EXT_EXTEND_ADM_GRP 0x200000
464 * This structure groups all Extended IS Reachability subTLVs.
466 * Each bit of the status field indicates if a subTLVs is valid or not.
467 * SubTLVs values use following units:
468 * - Bandwidth in bytes/sec following IEEE format,
469 * - Delay in micro-seconds with only 24 bits significant
470 * - Packet Loss in percentage of total traffic with only 24 bits (2^24 - 2)
472 * For Delay and packet Loss, upper bit (A) indicates if the value is
473 * normal (0) or anomalous (1).
475 #define IS_ANORMAL(v) (v & TE_EXT_ANORMAL)
477 struct isis_ext_subtlvs
{
481 uint32_t adm_group
; /* Resource Class/Color - RFC 5305 */
482 struct admin_group ext_admin_group
; /* Res. Class/Color - RFC 7308 */
483 /* Link Local/Remote Identifiers - RFC 5307 */
485 uint32_t remote_llri
;
486 struct in_addr local_addr
; /* Local IP Address - RFC 5305 */
487 struct in_addr neigh_addr
; /* Neighbor IP Address - RFC 5305 */
488 struct in6_addr local_addr6
; /* Local IPv6 Address - RFC 6119 */
489 struct in6_addr neigh_addr6
; /* Neighbor IPv6 Address - RFC 6119 */
490 float max_bw
; /* Maximum Bandwidth - RFC 5305 */
491 float max_rsv_bw
; /* Maximum Reservable Bandwidth - RFC 5305 */
492 float unrsv_bw
[8]; /* Unreserved Bandwidth - RFC 5305 */
493 uint32_t te_metric
; /* Traffic Engineering Metric - RFC 5305 */
494 uint32_t remote_as
; /* Remote AS Number sub-TLV - RFC5316 */
495 struct in_addr remote_ip
; /* IPv4 Remote ASBR ID Sub-TLV - RFC5316 */
497 uint32_t delay
; /* Average Link Delay - RFC 8570 */
498 uint32_t min_delay
; /* Low Link Delay - RFC 8570 */
499 uint32_t max_delay
; /* High Link Delay - RFC 8570 */
500 uint32_t delay_var
; /* Link Delay Variation i.e. Jitter - RFC 8570 */
501 uint32_t pkt_loss
; /* Unidirectional Link Packet Loss - RFC 8570 */
502 float res_bw
; /* Unidirectional Residual Bandwidth - RFC 8570 */
503 float ava_bw
; /* Unidirectional Available Bandwidth - RFC 8570 */
504 float use_bw
; /* Unidirectional Utilized Bandwidth - RFC 8570 */
506 /* Segment Routing Adjacency & LAN Adjacency Segment ID */
507 struct isis_item_list adj_sid
;
508 struct isis_item_list lan_sid
;
511 #define IS_COMPAT_MT_TLV(tlv_type) \
512 ((tlv_type == ISIS_TLV_MT_REACH) || (tlv_type == ISIS_TLV_MT_IP_REACH) \
513 || (tlv_type == ISIS_TLV_MT_IPV6_REACH))
516 int isis_pack_tlvs(struct isis_tlvs
*tlvs
, struct stream
*stream
,
517 size_t len_pointer
, bool pad
, bool is_lsp
);
518 void isis_free_tlvs(struct isis_tlvs
*tlvs
);
519 struct isis_tlvs
*isis_alloc_tlvs(void);
520 int isis_unpack_tlvs(size_t avail_len
, struct stream
*stream
,
521 struct isis_tlvs
**dest
, const char **error_log
);
522 const char *isis_format_tlvs(struct isis_tlvs
*tlvs
, struct json_object
*json
);
523 struct isis_tlvs
*isis_copy_tlvs(struct isis_tlvs
*tlvs
);
524 struct list
*isis_fragment_tlvs(struct isis_tlvs
*tlvs
, size_t size
);
526 #define ISIS_EXTENDED_IP_REACH_DOWN 0x80
527 #define ISIS_EXTENDED_IP_REACH_SUBTLV 0x40
529 #define ISIS_IPV6_REACH_DOWN 0x80
530 #define ISIS_IPV6_REACH_EXTERNAL 0x40
531 #define ISIS_IPV6_REACH_SUBTLV 0x20
534 #define ISIS_MT_MASK 0x0fff
535 #define ISIS_MT_OL_MASK 0x8000
536 #define ISIS_MT_AT_MASK 0x4000
539 void isis_tlvs_add_auth(struct isis_tlvs
*tlvs
, struct isis_passwd
*passwd
);
540 void isis_tlvs_add_area_addresses(struct isis_tlvs
*tlvs
,
541 struct list
*addresses
);
542 void isis_tlvs_add_lan_neighbors(struct isis_tlvs
*tlvs
,
543 struct list
*neighbors
);
544 void isis_tlvs_set_protocols_supported(struct isis_tlvs
*tlvs
,
545 struct nlpids
*nlpids
);
546 void isis_tlvs_add_mt_router_info(struct isis_tlvs
*tlvs
, uint16_t mtid
,
547 bool overload
, bool attached
);
548 void isis_tlvs_add_ipv4_address(struct isis_tlvs
*tlvs
, struct in_addr
*addr
);
549 void isis_tlvs_add_ipv4_addresses(struct isis_tlvs
*tlvs
,
550 struct list
*addresses
);
551 void isis_tlvs_add_ipv6_addresses(struct isis_tlvs
*tlvs
,
552 struct list
*addresses
);
553 void isis_tlvs_add_global_ipv6_addresses(struct isis_tlvs
*tlvs
,
554 struct list
*addresses
);
555 int isis_tlvs_auth_is_valid(struct isis_tlvs
*tlvs
, struct isis_passwd
*passwd
,
556 struct stream
*stream
, bool is_lsp
);
557 bool isis_tlvs_area_addresses_match(struct isis_tlvs
*tlvs
,
558 struct list
*addresses
);
559 struct isis_adjacency
;
560 void isis_tlvs_to_adj(struct isis_tlvs
*tlvs
, struct isis_adjacency
*adj
,
562 bool isis_tlvs_own_snpa_found(struct isis_tlvs
*tlvs
, uint8_t *snpa
);
563 void isis_tlvs_add_lsp_entry(struct isis_tlvs
*tlvs
, struct isis_lsp
*lsp
);
564 void isis_tlvs_add_csnp_entries(struct isis_tlvs
*tlvs
, uint8_t *start_id
,
565 uint8_t *stop_id
, uint16_t num_lsps
,
566 struct lspdb_head
*lspdb
,
567 struct isis_lsp
**last_lsp
);
568 void isis_tlvs_set_dynamic_hostname(struct isis_tlvs
*tlvs
,
569 const char *hostname
);
570 void isis_tlvs_set_router_capability(struct isis_tlvs
*tlvs
,
571 const struct isis_router_cap
*cap
);
572 void isis_tlvs_set_te_router_id(struct isis_tlvs
*tlvs
,
573 const struct in_addr
*id
);
574 void isis_tlvs_set_te_router_id_ipv6(struct isis_tlvs
*tlvs
,
575 const struct in6_addr
*id
);
576 void isis_tlvs_add_oldstyle_ip_reach(struct isis_tlvs
*tlvs
,
577 struct prefix_ipv4
*dest
, uint8_t metric
);
578 void isis_tlvs_add_extended_ip_reach(struct isis_tlvs
*tlvs
,
579 struct prefix_ipv4
*dest
, uint32_t metric
,
580 bool external
, struct sr_prefix_cfg
*pcfg
);
581 void isis_tlvs_add_ipv6_reach(struct isis_tlvs
*tlvs
, uint16_t mtid
,
582 struct prefix_ipv6
*dest
, uint32_t metric
,
583 bool external
, struct sr_prefix_cfg
*pcfg
);
584 void isis_tlvs_add_ipv6_dstsrc_reach(struct isis_tlvs
*tlvs
, uint16_t mtid
,
585 struct prefix_ipv6
*dest
,
586 struct prefix_ipv6
*src
,
588 struct isis_ext_subtlvs
*isis_alloc_ext_subtlvs(void);
589 void isis_del_ext_subtlvs(struct isis_ext_subtlvs
*ext
);
590 void isis_tlvs_add_adj_sid(struct isis_ext_subtlvs
*exts
,
591 struct isis_adj_sid
*adj
);
592 void isis_tlvs_del_adj_sid(struct isis_ext_subtlvs
*exts
,
593 struct isis_adj_sid
*adj
);
594 void isis_tlvs_add_lan_adj_sid(struct isis_ext_subtlvs
*exts
,
595 struct isis_lan_adj_sid
*lan
);
596 void isis_tlvs_del_lan_adj_sid(struct isis_ext_subtlvs
*exts
,
597 struct isis_lan_adj_sid
*lan
);
599 void isis_tlvs_add_oldstyle_reach(struct isis_tlvs
*tlvs
, uint8_t *id
,
601 void isis_tlvs_add_extended_reach(struct isis_tlvs
*tlvs
, uint16_t mtid
,
602 uint8_t *id
, uint32_t metric
,
603 struct isis_ext_subtlvs
*subtlvs
);
605 const char *isis_threeway_state_name(enum isis_threeway_state state
);
607 void isis_tlvs_add_threeway_adj(struct isis_tlvs
*tlvs
,
608 enum isis_threeway_state state
,
609 uint32_t local_circuit_id
,
610 const uint8_t *neighbor_id
,
611 uint32_t neighbor_circuit_id
);
613 void isis_tlvs_add_spine_leaf(struct isis_tlvs
*tlvs
, uint8_t tier
,
614 bool has_tier
, bool is_leaf
, bool is_spine
,
617 struct isis_mt_router_info
*
618 isis_tlvs_lookup_mt_router_info(struct isis_tlvs
*tlvs
, uint16_t mtid
);
620 void isis_tlvs_set_purge_originator(struct isis_tlvs
*tlvs
,
621 const uint8_t *generator
,
622 const uint8_t *sender
);