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 #define BGP_ATTR_NH_AFI(afi, attr) \
84 ((afi != AFI_L2VPN) ? afi : \
85 ((attr->mp_nexthop_len == BGP_ATTR_NHLEN_IPV4) ? AFI_IP : AFI_IP6))
87 /* PMSI tunnel types (RFC 6514) */
89 struct bgp_attr_encap_subtlv
{
90 struct bgp_attr_encap_subtlv
*next
; /* for chaining */
91 /* Reference count of this attribute. */
95 uint8_t value
[0]; /* will be extended */
100 * old rfp<->rfapi representation
102 struct bgp_tea_options
{
103 struct bgp_tea_options
*next
;
104 uint8_t options_count
;
105 uint16_t options_length
; /* each TLV may be 256 in length */
108 void *value
; /* pointer to data */
114 PMSI_TNLTYPE_NO_INFO
= 0,
115 PMSI_TNLTYPE_RSVP_TE_P2MP
,
116 PMSI_TNLTYPE_MLDP_P2MP
,
117 PMSI_TNLTYPE_PIM_SSM
,
119 PMSI_TNLTYPE_PIM_BIDIR
,
120 PMSI_TNLTYPE_INGR_REPL
,
121 PMSI_TNLTYPE_MLDP_MP2MP
,
122 PMSI_TNLTYPE_MAX
= PMSI_TNLTYPE_MLDP_MP2MP
128 * draft-dawra-idr-srv6-vpn-04
130 struct bgp_attr_srv6_vpn
{
131 unsigned long refcnt
;
138 * SRv6-L3VPN-Service-TLV
139 * draft-dawra-idr-srv6-vpn-05
141 struct bgp_attr_srv6_l3vpn
{
142 unsigned long refcnt
;
144 uint16_t endpoint_behavior
;
146 uint8_t loc_block_len
;
147 uint8_t loc_node_len
;
150 uint8_t transposition_len
;
151 uint8_t transposition_offset
;
154 /* BGP core attribute structure. */
156 /* AS Path structure */
157 struct aspath
*aspath
;
159 /* Community structure */
160 struct community
*community
;
162 /* Reference count of this attribute. */
163 unsigned long refcnt
;
165 /* Flag of attribute is set or not. */
168 /* Apart from in6_addr, the remaining static attributes */
169 struct in_addr nexthop
;
172 ifindex_t nh_ifindex
;
174 /* Path origin attribute */
177 /* PMSI tunnel type (RFC 6514). */
178 enum pta_type pmsi_tnl_type
;
180 /* has the route-map changed any attribute?
181 Used on the peer outbound side. */
182 uint32_t rmap_change_flags
;
184 /* Multi-Protocol Nexthop, AFI IPv6 */
185 struct in6_addr mp_nexthop_global
;
186 struct in6_addr mp_nexthop_local
;
188 /* ifIndex corresponding to mp_nexthop_local. */
189 ifindex_t nh_lla_ifindex
;
191 /* Extended Communities attribute. */
192 struct ecommunity
*ecommunity
;
194 /* Extended Communities attribute. */
195 struct ecommunity
*ipv6_ecommunity
;
197 /* Large Communities attribute. */
198 struct lcommunity
*lcommunity
;
200 /* Route-Reflector Cluster attribute */
201 struct cluster_list
*cluster1
;
203 /* Unknown transitive attribute. */
204 struct transit
*transit
;
206 struct in_addr mp_nexthop_global_in
;
208 /* Aggregator Router ID attribute */
209 struct in_addr aggregator_addr
;
211 /* Route Reflector Originator attribute */
212 struct in_addr originator_id
;
214 /* Local weight, not actually an attribute */
220 /* MP Nexthop length */
221 uint8_t mp_nexthop_len
;
223 /* MP Nexthop preference */
224 uint8_t mp_nexthop_prefer_global
;
226 /* Static MAC for EVPN */
229 /* Flag for default gateway extended community in EVPN */
232 /* NA router flag (R-bit) support in EVPN */
237 /* Path is not "locally-active" on the advertising VTEP. This is
238 * translated into an ARP-ND ECOM.
240 #define ATTR_ES_PROXY_ADVERT (1 << 0)
241 /* Destination ES is present locally. This flag is set on local
242 * paths and sync paths
244 #define ATTR_ES_IS_LOCAL (1 << 1)
245 /* There are one or more non-best paths from ES peers. Note that
246 * this flag is only set on the local MAC-IP paths in the VNI
247 * route table (not set in the global routing table). And only
248 * non-proxy advertisements from an ES peer can result in this
251 #define ATTR_ES_PEER_ACTIVE (1 << 2)
252 /* There are one or more non-best proxy paths from ES peers */
253 #define ATTR_ES_PEER_PROXY (1 << 3)
254 /* An ES peer has router bit set - only applicable if
255 * ATTR_ES_PEER_ACTIVE is set
257 #define ATTR_ES_PEER_ROUTER (1 << 4)
259 /* These two flags are only set on L3 routes installed in a
260 * VRF as a result of EVPN MAC-IP route
261 * XXX - while splitting up per-family attrs these need to be
262 * classified as non-EVPN
264 #define ATTR_ES_L3_NHG_USE (1 << 5)
265 #define ATTR_ES_L3_NHG_ACTIVE (1 << 6)
266 #define ATTR_ES_L3_NHG (ATTR_ES_L3_NHG_USE | ATTR_ES_L3_NHG_ACTIVE)
272 uint32_t label_index
;
278 struct bgp_attr_srv6_vpn
*srv6_vpn
;
281 struct bgp_attr_srv6_l3vpn
*srv6_l3vpn
;
283 uint16_t encap_tunneltype
; /* grr */
284 struct bgp_attr_encap_subtlv
*encap_subtlvs
; /* rfc5512 */
286 #ifdef ENABLE_BGP_VNC
287 struct bgp_attr_encap_subtlv
*vnc_subtlvs
; /* VNC-specific */
290 struct bgp_route_evpn evpn_overlay
;
292 /* EVPN MAC Mobility sequence number, if any. */
294 /* highest MM sequence number rxed in a MAC-IP route from an
295 * ES peer (this includes both proxy and non-proxy MAC-IP
296 * advertisements from ES peers).
297 * This is only applicable to local paths in the VNI routing
298 * table and derived from other imported/non-best paths.
300 uint32_t mm_sync_seqnum
;
302 /* EVPN local router-mac */
305 /* Distance as applied by Route map */
309 uint32_t rmap_table_id
;
311 /* Link bandwidth value, if any. */
320 /* EVPN DF preference and algorithm for DF election on local ESs */
325 enum nexthop_types_t nh_type
;
327 /* If NEXTHOP_TYPE_BLACKHOLE, then blackhole type */
328 enum blackhole_type bh_type
;
330 /* OTC value if set */
334 /* rmap_change_flags definition */
335 #define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
336 #define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
337 #define BATTR_REFLECTED (1 << 2)
338 #define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
339 #define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
340 #define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
341 #define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)
342 #define BATTR_RMAP_LINK_BW_SET (1 << 7)
343 #define BATTR_RMAP_L3VPN_ACCEPT_GRE (1 << 8)
345 /* Router Reflector related structure. */
346 struct cluster_list
{
347 unsigned long refcnt
;
349 struct in_addr
*list
;
352 /* Unknown transit attribute. */
354 unsigned long refcnt
;
359 /* "(void) 0" will generate a compiler error. this is a safety check to
360 * ensure we're not using a value that exceeds the bit size of attr->flag. */
361 #define ATTR_FLAG_BIT(X) \
362 __builtin_choose_expr((X) >= 1 && (X) <= 64, 1ULL << ((X)-1), (void)0)
364 #define BGP_CLUSTER_LIST_LENGTH(attr) \
365 (((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) \
366 ? bgp_attr_get_cluster((attr))->length \
369 enum bgp_attr_parse_ret
{
370 BGP_ATTR_PARSE_PROCEED
= 0,
371 BGP_ATTR_PARSE_ERROR
= -1,
372 BGP_ATTR_PARSE_WITHDRAW
= -2,
374 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
376 BGP_ATTR_PARSE_ERROR_NOTIFYPLS
= -3,
377 BGP_ATTR_PARSE_EOR
= -4,
380 struct bpacket_attr_vec_arr
;
383 extern void bgp_attr_init(void);
384 extern void bgp_attr_finish(void);
385 extern enum bgp_attr_parse_ret
386 bgp_attr_parse(struct peer
*peer
, struct attr
*attr
, bgp_size_t size
,
387 struct bgp_nlri
*mp_update
, struct bgp_nlri
*mp_withdraw
);
388 extern struct attr
*bgp_attr_intern(struct attr
*attr
);
389 extern void bgp_attr_unintern_sub(struct attr
*attr
);
390 extern void bgp_attr_unintern(struct attr
**pattr
);
391 extern void bgp_attr_flush(struct attr
*attr
);
392 extern struct attr
*bgp_attr_default_set(struct attr
*attr
, struct bgp
*bgp
,
394 extern struct attr
*bgp_attr_aggregate_intern(
395 struct bgp
*bgp
, uint8_t origin
, struct aspath
*aspath
,
396 struct community
*community
, struct ecommunity
*ecommunity
,
397 struct lcommunity
*lcommunity
, struct bgp_aggregate
*aggregate
,
398 uint8_t atomic_aggregate
, const struct prefix
*p
);
399 extern bgp_size_t
bgp_packet_attribute(struct bgp
*bgp
, struct peer
*peer
,
400 struct stream
*s
, struct attr
*attr
,
401 struct bpacket_attr_vec_arr
*vecarr
,
402 struct prefix
*p
, afi_t afi
, safi_t safi
,
403 struct peer
*from
, struct prefix_rd
*prd
,
404 mpls_label_t
*label
, uint32_t num_labels
,
405 bool addpath_capable
,
406 uint32_t addpath_tx_id
);
407 extern void bgp_dump_routes_attr(struct stream
*s
, struct attr
*attr
,
408 const struct prefix
*p
);
409 extern bool attrhash_cmp(const void *arg1
, const void *arg2
);
410 extern unsigned int attrhash_key_make(const void *p
);
411 extern void attr_show_all(struct vty
*vty
);
412 extern unsigned long int attr_count(void);
413 extern unsigned long int attr_unknown_count(void);
415 /* Cluster list prototypes. */
416 extern bool cluster_loop_check(struct cluster_list
*cluster
,
417 struct in_addr originator
);
419 /* Below exported for unit-test purposes only */
420 struct bgp_attr_parser_args
{
422 bgp_size_t length
; /* attribute data length; */
423 bgp_size_t total
; /* total length, inc header */
429 extern int bgp_mp_reach_parse(struct bgp_attr_parser_args
*args
,
430 struct bgp_nlri
*mp_update
);
431 extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args
*args
,
432 struct bgp_nlri
*mp_withdraw
);
433 extern enum bgp_attr_parse_ret
434 bgp_attr_prefix_sid(struct bgp_attr_parser_args
*args
);
436 extern struct bgp_attr_encap_subtlv
*
437 encap_tlv_dup(struct bgp_attr_encap_subtlv
*orig
);
439 extern void bgp_attr_flush_encap(struct attr
*attr
);
441 extern void bgp_attr_extcom_tunnel_type(struct attr
*attr
,
442 bgp_encap_types
*tunnel_type
);
445 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
446 * Typical call sequence is to call _start(), followed by multiple _prefix(),
447 * one for each NLRI that needs to be encoded into the UPDATE message, and
448 * finally the _end() function.
450 extern size_t bgp_packet_mpattr_start(struct stream
*s
, struct peer
*peer
,
451 afi_t afi
, safi_t safi
,
452 struct bpacket_attr_vec_arr
*vecarr
,
454 extern void bgp_packet_mpattr_prefix(struct stream
*s
, afi_t afi
, safi_t safi
,
455 const struct prefix
*p
,
456 const struct prefix_rd
*prd
,
457 mpls_label_t
*label
, uint32_t num_labels
,
458 bool addpath_capable
,
459 uint32_t addpath_tx_id
, struct attr
*);
460 extern size_t bgp_packet_mpattr_prefix_size(afi_t afi
, safi_t safi
,
461 const struct prefix
*p
);
462 extern void bgp_packet_mpattr_end(struct stream
*s
, size_t sizep
);
464 extern size_t bgp_packet_mpunreach_start(struct stream
*s
, afi_t afi
,
466 extern void bgp_packet_mpunreach_prefix(
467 struct stream
*s
, const struct prefix
*p
, afi_t afi
, safi_t safi
,
468 const struct prefix_rd
*prd
, mpls_label_t
*label
, uint32_t num_labels
,
469 bool addpath_capable
, uint32_t addpath_tx_id
, struct attr
*attr
);
470 extern void bgp_packet_mpunreach_end(struct stream
*s
, size_t attrlen_pnt
);
472 extern enum bgp_attr_parse_ret
bgp_attr_nexthop_valid(struct peer
*peer
,
475 static inline int bgp_rmap_nhop_changed(uint32_t out_rmap_flags
,
476 uint32_t in_rmap_flags
)
478 return ((CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_PEER_ADDRESS
)
479 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
)
480 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV4_NHOP_CHANGED
)
481 || CHECK_FLAG(out_rmap_flags
,
482 BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED
)
483 || CHECK_FLAG(out_rmap_flags
,
484 BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED
)
485 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV6_LL_NHOP_CHANGED
)
486 || CHECK_FLAG(in_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
))
491 static inline uint32_t mac_mobility_seqnum(struct attr
*attr
)
493 return (attr
) ? attr
->mm_seqnum
: 0;
496 static inline enum pta_type
bgp_attr_get_pmsi_tnl_type(struct attr
*attr
)
498 return attr
->pmsi_tnl_type
;
501 static inline void bgp_attr_set_pmsi_tnl_type(struct attr
*attr
,
502 enum pta_type pmsi_tnl_type
)
504 attr
->pmsi_tnl_type
= pmsi_tnl_type
;
507 static inline struct ecommunity
*
508 bgp_attr_get_ecommunity(const struct attr
*attr
)
510 return attr
->ecommunity
;
513 static inline void bgp_attr_set_ecommunity(struct attr
*attr
,
514 struct ecommunity
*ecomm
)
516 attr
->ecommunity
= ecomm
;
519 SET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_EXT_COMMUNITIES
));
521 UNSET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_EXT_COMMUNITIES
));
524 static inline struct lcommunity
*
525 bgp_attr_get_lcommunity(const struct attr
*attr
)
527 return attr
->lcommunity
;
530 static inline void bgp_attr_set_lcommunity(struct attr
*attr
,
531 struct lcommunity
*lcomm
)
533 attr
->lcommunity
= lcomm
;
536 SET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_LARGE_COMMUNITIES
));
538 UNSET_FLAG(attr
->flag
,
539 ATTR_FLAG_BIT(BGP_ATTR_LARGE_COMMUNITIES
));
542 static inline struct community
*bgp_attr_get_community(const struct attr
*attr
)
544 return attr
->community
;
547 static inline void bgp_attr_set_community(struct attr
*attr
,
548 struct community
*comm
)
550 attr
->community
= comm
;
553 SET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_COMMUNITIES
));
555 UNSET_FLAG(attr
->flag
, ATTR_FLAG_BIT(BGP_ATTR_COMMUNITIES
));
558 static inline struct ecommunity
*
559 bgp_attr_get_ipv6_ecommunity(const struct attr
*attr
)
561 return attr
->ipv6_ecommunity
;
564 static inline void bgp_attr_set_ipv6_ecommunity(struct attr
*attr
,
565 struct ecommunity
*ipv6_ecomm
)
567 attr
->ipv6_ecommunity
= ipv6_ecomm
;
571 ATTR_FLAG_BIT(BGP_ATTR_IPV6_EXT_COMMUNITIES
));
573 UNSET_FLAG(attr
->flag
,
574 ATTR_FLAG_BIT(BGP_ATTR_IPV6_EXT_COMMUNITIES
));
577 static inline struct transit
*bgp_attr_get_transit(const struct attr
*attr
)
579 return attr
->transit
;
582 static inline void bgp_attr_set_transit(struct attr
*attr
,
583 struct transit
*transit
)
585 attr
->transit
= transit
;
588 static inline struct cluster_list
*bgp_attr_get_cluster(const struct attr
*attr
)
590 return attr
->cluster1
;
593 static inline void bgp_attr_set_cluster(struct attr
*attr
,
594 struct cluster_list
*cl
)
599 static inline const struct bgp_route_evpn
*
600 bgp_attr_get_evpn_overlay(const struct attr
*attr
)
602 return &attr
->evpn_overlay
;
605 static inline void bgp_attr_set_evpn_overlay(struct attr
*attr
,
606 struct bgp_route_evpn
*eo
)
608 memcpy(&attr
->evpn_overlay
, eo
, sizeof(struct bgp_route_evpn
));
611 static inline struct bgp_attr_encap_subtlv
*
612 bgp_attr_get_vnc_subtlvs(const struct attr
*attr
)
614 #ifdef ENABLE_BGP_VNC
615 return attr
->vnc_subtlvs
;
622 bgp_attr_set_vnc_subtlvs(struct attr
*attr
,
623 struct bgp_attr_encap_subtlv
*vnc_subtlvs
)
625 #ifdef ENABLE_BGP_VNC
626 attr
->vnc_subtlvs
= vnc_subtlvs
;
630 #endif /* _QUAGGA_BGP_ATTR_H */