2 * Copyright (C) 1996, 97, 98 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
6 * GNU Zebra is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
11 * GNU Zebra is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef _QUAGGA_BGP_ATTR_H
22 #define _QUAGGA_BGP_ATTR_H
25 #include "bgp_attr_evpn.h"
26 #include "bgpd/bgp_encap_types.h"
29 /* Simple bit mapping. */
32 #define SET_BITMAP(MAP, NUM) \
33 SET_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
35 #define CHECK_BITMAP(MAP, NUM) \
36 CHECK_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
38 #define BGP_MED_MAX UINT32_MAX
40 /* BGP Attribute type range. */
41 #define BGP_ATTR_TYPE_RANGE 256
42 #define BGP_ATTR_BITMAP_SIZE (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)
44 /* BGP Attribute flags. */
45 #define BGP_ATTR_FLAG_OPTIONAL 0x80 /* Attribute is optional. */
46 #define BGP_ATTR_FLAG_TRANS 0x40 /* Attribute is transitive. */
47 #define BGP_ATTR_FLAG_PARTIAL 0x20 /* Attribute is partial. */
48 #define BGP_ATTR_FLAG_EXTLEN 0x10 /* Extended length flag. */
50 /* BGP attribute header must bigger than 2. */
51 #define BGP_ATTR_MIN_LEN 3 /* Attribute flag, type length. */
52 #define BGP_ATTR_DEFAULT_WEIGHT 32768
54 /* Valid lengths for mp_nexthop_len */
55 #define BGP_ATTR_NHLEN_IPV4 IPV4_MAX_BYTELEN
56 #define BGP_ATTR_NHLEN_VPNV4 8+IPV4_MAX_BYTELEN
57 #define BGP_ATTR_NHLEN_IPV6_GLOBAL IPV6_MAX_BYTELEN
58 #define BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL (IPV6_MAX_BYTELEN * 2)
59 #define BGP_ATTR_NHLEN_VPNV6_GLOBAL 8+IPV6_MAX_BYTELEN
60 #define BGP_ATTR_NHLEN_VPNV6_GLOBAL_AND_LL ((8+IPV6_MAX_BYTELEN) * 2)
62 /* Prefix SID types */
63 #define BGP_PREFIX_SID_LABEL_INDEX 1
64 #define BGP_PREFIX_SID_IPV6 2
65 #define BGP_PREFIX_SID_ORIGINATOR_SRGB 3
66 #define BGP_PREFIX_SID_VPN_SID 4
67 #define BGP_PREFIX_SID_SRV6_L3_SERVICE 5
68 #define BGP_PREFIX_SID_SRV6_L2_SERVICE 6
70 #define BGP_PREFIX_SID_LABEL_INDEX_LENGTH 7
71 #define BGP_PREFIX_SID_IPV6_LENGTH 19
72 #define BGP_PREFIX_SID_ORIGINATOR_SRGB_LENGTH 6
73 #define BGP_PREFIX_SID_VPN_SID_LENGTH 19
75 /* SRv6 Service Sub-TLV types */
76 #define BGP_PREFIX_SID_SRV6_L3_SERVICE_SID_INFO 1
77 #define BGP_PREFIX_SID_SRV6_L3_SERVICE_SID_INFO_LENGTH 21
79 /* SRv6 Service Data Sub-Sub-TLV types */
80 #define BGP_PREFIX_SID_SRV6_L3_SERVICE_SID_STRUCTURE 1
81 #define BGP_PREFIX_SID_SRV6_L3_SERVICE_SID_STRUCTURE_LENGTH 6
83 /* SRv6 SID Structure default values */
84 #define BGP_PREFIX_SID_SRV6_LOCATOR_BLOCK_LENGTH 40
85 #define BGP_PREFIX_SID_SRV6_LOCATOR_NODE_LENGTH 24
86 #define BGP_PREFIX_SID_SRV6_FUNCTION_LENGTH 16
87 #define BGP_PREFIX_SID_SRV6_ARGUMENT_LENGTH 0
88 #define BGP_PREFIX_SID_SRV6_TRANSPOSITION_LENGTH 16
89 #define BGP_PREFIX_SID_SRV6_TRANSPOSITION_OFFSET 64
91 #define BGP_ATTR_NH_AFI(afi, attr) \
92 ((afi != AFI_L2VPN) ? afi : \
93 ((attr->mp_nexthop_len == BGP_ATTR_NHLEN_IPV4) ? AFI_IP : AFI_IP6))
95 /* PMSI tunnel types (RFC 6514) */
97 struct bgp_attr_encap_subtlv
{
98 struct bgp_attr_encap_subtlv
*next
; /* for chaining */
99 /* Reference count of this attribute. */
100 unsigned long refcnt
;
103 uint8_t value
[0]; /* will be extended */
106 #ifdef ENABLE_BGP_VNC
108 * old rfp<->rfapi representation
110 struct bgp_tea_options
{
111 struct bgp_tea_options
*next
;
112 uint8_t options_count
;
113 uint16_t options_length
; /* each TLV may be 256 in length */
116 void *value
; /* pointer to data */
122 PMSI_TNLTYPE_NO_INFO
= 0,
123 PMSI_TNLTYPE_RSVP_TE_P2MP
,
124 PMSI_TNLTYPE_MLDP_P2MP
,
125 PMSI_TNLTYPE_PIM_SSM
,
127 PMSI_TNLTYPE_PIM_BIDIR
,
128 PMSI_TNLTYPE_INGR_REPL
,
129 PMSI_TNLTYPE_MLDP_MP2MP
,
130 PMSI_TNLTYPE_MAX
= PMSI_TNLTYPE_MLDP_MP2MP
136 * draft-dawra-idr-srv6-vpn-04
138 struct bgp_attr_srv6_vpn
{
139 unsigned long refcnt
;
146 * SRv6-L3VPN-Service-TLV
147 * draft-dawra-idr-srv6-vpn-05
149 struct bgp_attr_srv6_l3vpn
{
150 unsigned long refcnt
;
152 uint16_t endpoint_behavior
;
154 uint8_t loc_block_len
;
155 uint8_t loc_node_len
;
158 uint8_t transposition_len
;
159 uint8_t transposition_offset
;
162 /* BGP core attribute structure. */
164 /* AS Path structure */
165 struct aspath
*aspath
;
167 /* Community structure */
168 struct community
*community
;
170 /* Reference count of this attribute. */
171 unsigned long refcnt
;
173 /* Flag of attribute is set or not. */
176 /* Apart from in6_addr, the remaining static attributes */
177 struct in_addr nexthop
;
180 ifindex_t nh_ifindex
;
182 /* Path origin attribute */
185 /* PMSI tunnel type (RFC 6514). */
186 enum pta_type pmsi_tnl_type
;
188 /* has the route-map changed any attribute?
189 Used on the peer outbound side. */
190 uint32_t rmap_change_flags
;
192 /* Multi-Protocol Nexthop, AFI IPv6 */
193 struct in6_addr mp_nexthop_global
;
194 struct in6_addr mp_nexthop_local
;
196 /* ifIndex corresponding to mp_nexthop_local. */
197 ifindex_t nh_lla_ifindex
;
199 /* Extended Communities attribute. */
200 struct ecommunity
*ecommunity
;
202 /* Extended Communities attribute. */
203 struct ecommunity
*ipv6_ecommunity
;
205 /* Large Communities attribute. */
206 struct lcommunity
*lcommunity
;
208 /* Route-Reflector Cluster attribute */
209 struct cluster_list
*cluster1
;
211 /* Unknown transitive attribute. */
212 struct transit
*transit
;
214 struct in_addr mp_nexthop_global_in
;
216 /* Aggregator Router ID attribute */
217 struct in_addr aggregator_addr
;
219 /* Route Reflector Originator attribute */
220 struct in_addr originator_id
;
222 /* Local weight, not actually an attribute */
228 /* MP Nexthop length */
229 uint8_t mp_nexthop_len
;
231 /* MP Nexthop preference */
232 uint8_t mp_nexthop_prefer_global
;
234 /* Static MAC for EVPN */
237 /* Flag for default gateway extended community in EVPN */
240 /* NA router flag (R-bit) support in EVPN */
245 /* Path is not "locally-active" on the advertising VTEP. This is
246 * translated into an ARP-ND ECOM.
248 #define ATTR_ES_PROXY_ADVERT (1 << 0)
249 /* Destination ES is present locally. This flag is set on local
250 * paths and sync paths
252 #define ATTR_ES_IS_LOCAL (1 << 1)
253 /* There are one or more non-best paths from ES peers. Note that
254 * this flag is only set on the local MAC-IP paths in the VNI
255 * route table (not set in the global routing table). And only
256 * non-proxy advertisements from an ES peer can result in this
259 #define ATTR_ES_PEER_ACTIVE (1 << 2)
260 /* There are one or more non-best proxy paths from ES peers */
261 #define ATTR_ES_PEER_PROXY (1 << 3)
262 /* An ES peer has router bit set - only applicable if
263 * ATTR_ES_PEER_ACTIVE is set
265 #define ATTR_ES_PEER_ROUTER (1 << 4)
267 /* These two flags are only set on L3 routes installed in a
268 * VRF as a result of EVPN MAC-IP route
269 * XXX - while splitting up per-family attrs these need to be
270 * classified as non-EVPN
272 #define ATTR_ES_L3_NHG_USE (1 << 5)
273 #define ATTR_ES_L3_NHG_ACTIVE (1 << 6)
274 #define ATTR_ES_L3_NHG (ATTR_ES_L3_NHG_USE | ATTR_ES_L3_NHG_ACTIVE)
280 uint32_t label_index
;
286 struct bgp_attr_srv6_vpn
*srv6_vpn
;
289 struct bgp_attr_srv6_l3vpn
*srv6_l3vpn
;
291 uint16_t encap_tunneltype
; /* grr */
292 struct bgp_attr_encap_subtlv
*encap_subtlvs
; /* rfc5512 */
294 #ifdef ENABLE_BGP_VNC
295 struct bgp_attr_encap_subtlv
*vnc_subtlvs
; /* VNC-specific */
298 struct bgp_route_evpn evpn_overlay
;
300 /* EVPN MAC Mobility sequence number, if any. */
302 /* highest MM sequence number rxed in a MAC-IP route from an
303 * ES peer (this includes both proxy and non-proxy MAC-IP
304 * advertisements from ES peers).
305 * This is only applicable to local paths in the VNI routing
306 * table and derived from other imported/non-best paths.
308 uint32_t mm_sync_seqnum
;
310 /* EVPN local router-mac */
313 /* Distance as applied by Route map */
317 uint32_t rmap_table_id
;
319 /* Link bandwidth value, if any. */
328 /* EVPN DF preference and algorithm for DF election on local ESs */
333 enum nexthop_types_t nh_type
;
335 /* If NEXTHOP_TYPE_BLACKHOLE, then blackhole type */
336 enum blackhole_type bh_type
;
338 /* OTC value if set */
342 /* rmap_change_flags definition */
343 #define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
344 #define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
345 #define BATTR_REFLECTED (1 << 2)
346 #define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
347 #define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
348 #define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
349 #define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)
350 #define BATTR_RMAP_LINK_BW_SET (1 << 7)
351 #define BATTR_RMAP_L3VPN_ACCEPT_GRE (1 << 8)
353 /* Router Reflector related structure. */
354 struct cluster_list
{
355 unsigned long refcnt
;
357 struct in_addr
*list
;
360 /* Unknown transit attribute. */
362 unsigned long refcnt
;
367 /* "(void) 0" will generate a compiler error. this is a safety check to
368 * ensure we're not using a value that exceeds the bit size of attr->flag. */
369 #define ATTR_FLAG_BIT(X) \
370 __builtin_choose_expr((X) >= 1 && (X) <= 64, 1ULL << ((X)-1), (void)0)
372 #define BGP_CLUSTER_LIST_LENGTH(attr) \
373 (((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) \
374 ? bgp_attr_get_cluster((attr))->length \
377 enum bgp_attr_parse_ret
{
378 BGP_ATTR_PARSE_PROCEED
= 0,
379 BGP_ATTR_PARSE_ERROR
= -1,
380 BGP_ATTR_PARSE_WITHDRAW
= -2,
382 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
384 BGP_ATTR_PARSE_ERROR_NOTIFYPLS
= -3,
385 BGP_ATTR_PARSE_EOR
= -4,
388 struct bpacket_attr_vec_arr
;
391 extern void bgp_attr_init(void);
392 extern void bgp_attr_finish(void);
393 extern enum bgp_attr_parse_ret
394 bgp_attr_parse(struct peer
*peer
, struct attr
*attr
, bgp_size_t size
,
395 struct bgp_nlri
*mp_update
, struct bgp_nlri
*mp_withdraw
);
396 extern struct attr
*bgp_attr_intern(struct attr
*attr
);
397 extern void bgp_attr_unintern_sub(struct attr
*attr
);
398 extern void bgp_attr_unintern(struct attr
**pattr
);
399 extern void bgp_attr_flush(struct attr
*attr
);
400 extern struct attr
*bgp_attr_default_set(struct attr
*attr
, struct bgp
*bgp
,
402 extern struct attr
*bgp_attr_aggregate_intern(
403 struct bgp
*bgp
, uint8_t origin
, struct aspath
*aspath
,
404 struct community
*community
, struct ecommunity
*ecommunity
,
405 struct lcommunity
*lcommunity
, struct bgp_aggregate
*aggregate
,
406 uint8_t atomic_aggregate
, const struct prefix
*p
);
407 extern bgp_size_t
bgp_packet_attribute(struct bgp
*bgp
, struct peer
*peer
,
408 struct stream
*s
, struct attr
*attr
,
409 struct bpacket_attr_vec_arr
*vecarr
,
410 struct prefix
*p
, afi_t afi
, safi_t safi
,
411 struct peer
*from
, struct prefix_rd
*prd
,
412 mpls_label_t
*label
, uint32_t num_labels
,
413 bool addpath_capable
,
414 uint32_t addpath_tx_id
);
415 extern void bgp_dump_routes_attr(struct stream
*s
, struct attr
*attr
,
416 const struct prefix
*p
);
417 extern bool attrhash_cmp(const void *arg1
, const void *arg2
);
418 extern unsigned int attrhash_key_make(const void *p
);
419 extern void attr_show_all(struct vty
*vty
);
420 extern unsigned long int attr_count(void);
421 extern unsigned long int attr_unknown_count(void);
423 /* Cluster list prototypes. */
424 extern bool cluster_loop_check(struct cluster_list
*cluster
,
425 struct in_addr originator
);
427 /* Below exported for unit-test purposes only */
428 struct bgp_attr_parser_args
{
430 bgp_size_t length
; /* attribute data length; */
431 bgp_size_t total
; /* total length, inc header */
437 extern int bgp_mp_reach_parse(struct bgp_attr_parser_args
*args
,
438 struct bgp_nlri
*mp_update
);
439 extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args
*args
,
440 struct bgp_nlri
*mp_withdraw
);
441 extern enum bgp_attr_parse_ret
442 bgp_attr_prefix_sid(struct bgp_attr_parser_args
*args
);
444 extern struct bgp_attr_encap_subtlv
*
445 encap_tlv_dup(struct bgp_attr_encap_subtlv
*orig
);
447 extern void bgp_attr_flush_encap(struct attr
*attr
);
449 extern void bgp_attr_extcom_tunnel_type(struct attr
*attr
,
450 bgp_encap_types
*tunnel_type
);
453 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
454 * Typical call sequence is to call _start(), followed by multiple _prefix(),
455 * one for each NLRI that needs to be encoded into the UPDATE message, and
456 * finally the _end() function.
458 extern size_t bgp_packet_mpattr_start(struct stream
*s
, struct peer
*peer
,
459 afi_t afi
, safi_t safi
,
460 struct bpacket_attr_vec_arr
*vecarr
,
462 extern void bgp_packet_mpattr_prefix(struct stream
*s
, afi_t afi
, safi_t safi
,
463 const struct prefix
*p
,
464 const struct prefix_rd
*prd
,
465 mpls_label_t
*label
, uint32_t num_labels
,
466 bool addpath_capable
,
467 uint32_t addpath_tx_id
, struct attr
*);
468 extern size_t bgp_packet_mpattr_prefix_size(afi_t afi
, safi_t safi
,
469 const struct prefix
*p
);
470 extern void bgp_packet_mpattr_end(struct stream
*s
, size_t sizep
);
472 extern size_t bgp_packet_mpunreach_start(struct stream
*s
, afi_t afi
,
474 extern void bgp_packet_mpunreach_prefix(
475 struct stream
*s
, const struct prefix
*p
, afi_t afi
, safi_t safi
,
476 const struct prefix_rd
*prd
, mpls_label_t
*label
, uint32_t num_labels
,
477 bool addpath_capable
, uint32_t addpath_tx_id
, struct attr
*attr
);
478 extern void bgp_packet_mpunreach_end(struct stream
*s
, size_t attrlen_pnt
);
480 extern enum bgp_attr_parse_ret
bgp_attr_nexthop_valid(struct peer
*peer
,
483 static inline int bgp_rmap_nhop_changed(uint32_t out_rmap_flags
,
484 uint32_t in_rmap_flags
)
486 return ((CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_PEER_ADDRESS
)
487 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
)
488 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV4_NHOP_CHANGED
)
489 || CHECK_FLAG(out_rmap_flags
,
490 BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED
)
491 || CHECK_FLAG(out_rmap_flags
,
492 BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED
)
493 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV6_LL_NHOP_CHANGED
)
494 || CHECK_FLAG(in_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
))
499 static inline uint32_t mac_mobility_seqnum(struct attr
*attr
)
501 return (attr
) ? attr
->mm_seqnum
: 0;
504 static inline enum pta_type
bgp_attr_get_pmsi_tnl_type(struct attr
*attr
)
506 return attr
->pmsi_tnl_type
;
509 static inline void bgp_attr_set_pmsi_tnl_type(struct attr
*attr
,
510 enum pta_type pmsi_tnl_type
)
512 attr
->pmsi_tnl_type
= pmsi_tnl_type
;
515 static inline struct ecommunity
*
516 bgp_attr_get_ecommunity(const struct attr
*attr
)
518 return attr
->ecommunity
;
521 static inline void bgp_attr_set_ecommunity(struct attr
*attr
,
522 struct ecommunity
*ecomm
)
524 attr
->ecommunity
= ecomm
;
527 SET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_EXT_COMMUNITIES
));
529 UNSET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_EXT_COMMUNITIES
));
532 static inline struct lcommunity
*
533 bgp_attr_get_lcommunity(const struct attr
*attr
)
535 return attr
->lcommunity
;
538 static inline void bgp_attr_set_lcommunity(struct attr
*attr
,
539 struct lcommunity
*lcomm
)
541 attr
->lcommunity
= lcomm
;
544 SET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_LARGE_COMMUNITIES
));
546 UNSET_FLAG(attr
->flag
,
547 ATTR_FLAG_BIT(BGP_ATTR_LARGE_COMMUNITIES
));
550 static inline struct community
*bgp_attr_get_community(const struct attr
*attr
)
552 return attr
->community
;
555 static inline void bgp_attr_set_community(struct attr
*attr
,
556 struct community
*comm
)
558 attr
->community
= comm
;
561 SET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_COMMUNITIES
));
563 UNSET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_COMMUNITIES
));
566 static inline struct ecommunity
*
567 bgp_attr_get_ipv6_ecommunity(const struct attr
*attr
)
569 return attr
->ipv6_ecommunity
;
572 static inline void bgp_attr_set_ipv6_ecommunity(struct attr
*attr
,
573 struct ecommunity
*ipv6_ecomm
)
575 attr
->ipv6_ecommunity
= ipv6_ecomm
;
579 ATTR_FLAG_BIT(BGP_ATTR_IPV6_EXT_COMMUNITIES
));
581 UNSET_FLAG(attr
->flag
,
582 ATTR_FLAG_BIT(BGP_ATTR_IPV6_EXT_COMMUNITIES
));
585 static inline struct transit
*bgp_attr_get_transit(const struct attr
*attr
)
587 return attr
->transit
;
590 static inline void bgp_attr_set_transit(struct attr
*attr
,
591 struct transit
*transit
)
593 attr
->transit
= transit
;
596 static inline struct cluster_list
*bgp_attr_get_cluster(const struct attr
*attr
)
598 return attr
->cluster1
;
601 static inline void bgp_attr_set_cluster(struct attr
*attr
,
602 struct cluster_list
*cl
)
607 static inline const struct bgp_route_evpn
*
608 bgp_attr_get_evpn_overlay(const struct attr
*attr
)
610 return &attr
->evpn_overlay
;
613 static inline void bgp_attr_set_evpn_overlay(struct attr
*attr
,
614 struct bgp_route_evpn
*eo
)
616 memcpy(&attr
->evpn_overlay
, eo
, sizeof(struct bgp_route_evpn
));
619 static inline struct bgp_attr_encap_subtlv
*
620 bgp_attr_get_vnc_subtlvs(const struct attr
*attr
)
622 #ifdef ENABLE_BGP_VNC
623 return attr
->vnc_subtlvs
;
630 bgp_attr_set_vnc_subtlvs(struct attr
*attr
,
631 struct bgp_attr_encap_subtlv
*vnc_subtlvs
)
633 #ifdef ENABLE_BGP_VNC
634 attr
->vnc_subtlvs
= vnc_subtlvs
;
638 #endif /* _QUAGGA_BGP_ATTR_H */