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"
27 /* Simple bit mapping. */
30 #define SET_BITMAP(MAP, NUM) \
31 SET_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
33 #define CHECK_BITMAP(MAP, NUM) \
34 CHECK_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
36 #define BGP_MED_MAX UINT32_MAX
38 /* BGP Attribute type range. */
39 #define BGP_ATTR_TYPE_RANGE 256
40 #define BGP_ATTR_BITMAP_SIZE (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)
42 /* BGP Attribute flags. */
43 #define BGP_ATTR_FLAG_OPTIONAL 0x80 /* Attribute is optional. */
44 #define BGP_ATTR_FLAG_TRANS 0x40 /* Attribute is transitive. */
45 #define BGP_ATTR_FLAG_PARTIAL 0x20 /* Attribute is partial. */
46 #define BGP_ATTR_FLAG_EXTLEN 0x10 /* Extended length flag. */
48 /* BGP attribute header must bigger than 2. */
49 #define BGP_ATTR_MIN_LEN 3 /* Attribute flag, type length. */
50 #define BGP_ATTR_DEFAULT_WEIGHT 32768
52 /* Valid lengths for mp_nexthop_len */
53 #define BGP_ATTR_NHLEN_IPV4 IPV4_MAX_BYTELEN
54 #define BGP_ATTR_NHLEN_VPNV4 8+IPV4_MAX_BYTELEN
55 #define BGP_ATTR_NHLEN_IPV6_GLOBAL IPV6_MAX_BYTELEN
56 #define BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL (IPV6_MAX_BYTELEN * 2)
57 #define BGP_ATTR_NHLEN_VPNV6_GLOBAL 8+IPV6_MAX_BYTELEN
58 #define BGP_ATTR_NHLEN_VPNV6_GLOBAL_AND_LL ((8+IPV6_MAX_BYTELEN) * 2)
60 /* Prefix SID types */
61 #define BGP_PREFIX_SID_LABEL_INDEX 1
62 #define BGP_PREFIX_SID_IPV6 2
63 #define BGP_PREFIX_SID_ORIGINATOR_SRGB 3
65 #define BGP_PREFIX_SID_LABEL_INDEX_LENGTH 7
66 #define BGP_PREFIX_SID_IPV6_LENGTH 19
67 #define BGP_PREFIX_SID_ORIGINATOR_SRGB_LENGTH 6
69 /* PMSI tunnel types (RFC 6514) */
71 struct bgp_attr_encap_subtlv
{
72 struct bgp_attr_encap_subtlv
*next
; /* for chaining */
73 /* Reference count of this attribute. */
77 uint8_t value
[0]; /* will be extended */
82 * old rfp<->rfapi representation
84 struct bgp_tea_options
{
85 struct bgp_tea_options
*next
;
86 uint8_t options_count
;
87 uint16_t options_length
; /* each TLV may be 256 in length */
90 void *value
; /* pointer to data */
95 /* Overlay Index Info */
96 struct overlay_index
{
97 struct eth_segment_id eth_s_id
;
102 PMSI_TNLTYPE_NO_INFO
= 0,
103 PMSI_TNLTYPE_RSVP_TE_P2MP
,
104 PMSI_TNLTYPE_MLDP_P2MP
,
105 PMSI_TNLTYPE_PIM_SSM
,
107 PMSI_TNLTYPE_PIM_BIDIR
,
108 PMSI_TNLTYPE_INGR_REPL
,
109 PMSI_TNLTYPE_MLDP_MP2MP
,
110 PMSI_TNLTYPE_MAX
= PMSI_TNLTYPE_MLDP_MP2MP
113 /* BGP core attribute structure. */
115 /* AS Path structure */
116 struct aspath
*aspath
;
118 /* Community structure */
119 struct community
*community
;
121 /* Reference count of this attribute. */
122 unsigned long refcnt
;
124 /* Flag of attribute is set or not. */
127 /* Apart from in6_addr, the remaining static attributes */
128 struct in_addr nexthop
;
131 ifindex_t nh_ifindex
;
133 /* Path origin attribute */
136 /* PMSI tunnel type (RFC 6514). */
137 enum pta_type pmsi_tnl_type
;
139 /* has the route-map changed any attribute?
140 Used on the peer outbound side. */
141 uint32_t rmap_change_flags
;
143 /* Multi-Protocol Nexthop, AFI IPv6 */
144 struct in6_addr mp_nexthop_global
;
145 struct in6_addr mp_nexthop_local
;
147 /* ifIndex corresponding to mp_nexthop_local. */
148 ifindex_t nh_lla_ifindex
;
150 /* Extended Communities attribute. */
151 struct ecommunity
*ecommunity
;
153 /* Large Communities attribute. */
154 struct lcommunity
*lcommunity
;
156 /* Route-Reflector Cluster attribute */
157 struct cluster_list
*cluster
;
159 /* Unknown transitive attribute. */
160 struct transit
*transit
;
162 struct in_addr mp_nexthop_global_in
;
164 /* Aggregator Router ID attribute */
165 struct in_addr aggregator_addr
;
167 /* Route Reflector Originator attribute */
168 struct in_addr originator_id
;
170 /* Local weight, not actually an attribute */
176 /* MP Nexthop length */
177 uint8_t mp_nexthop_len
;
179 /* MP Nexthop preference */
180 uint8_t mp_nexthop_prefer_global
;
182 /* Static MAC for EVPN */
185 /* Flag for default gateway extended community in EVPN */
192 uint32_t label_index
;
197 uint16_t encap_tunneltype
; /* grr */
198 struct bgp_attr_encap_subtlv
*encap_subtlvs
; /* rfc5512 */
201 struct bgp_attr_encap_subtlv
*vnc_subtlvs
; /* VNC-specific */
204 struct overlay_index evpn_overlay
;
206 /* EVPN MAC Mobility sequence number, if any. */
209 /* EVPN local router-mac */
213 /* rmap_change_flags definition */
214 #define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
215 #define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
216 #define BATTR_REFLECTED (1 << 2)
217 #define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
218 #define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
219 #define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
220 #define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)
222 /* Router Reflector related structure. */
223 struct cluster_list
{
224 unsigned long refcnt
;
226 struct in_addr
*list
;
229 /* Unknown transit attribute. */
231 unsigned long refcnt
;
236 /* "(void) 0" will generate a compiler error. this is a safety check to
237 * ensure we're not using a value that exceeds the bit size of attr->flag. */
238 #define ATTR_FLAG_BIT(X) \
239 __builtin_choose_expr((X) >= 1 && (X) <= 64, 1ULL << ((X)-1), (void)0)
241 #define BGP_CLUSTER_LIST_LENGTH(attr) \
242 (((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) \
243 ? (attr)->cluster->length \
247 BGP_ATTR_PARSE_PROCEED
= 0,
248 BGP_ATTR_PARSE_ERROR
= -1,
249 BGP_ATTR_PARSE_WITHDRAW
= -2,
251 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
253 BGP_ATTR_PARSE_ERROR_NOTIFYPLS
= -3,
254 BGP_ATTR_PARSE_EOR
= -4,
255 } bgp_attr_parse_ret_t
;
257 struct bpacket_attr_vec_arr
;
260 extern void bgp_attr_init(void);
261 extern void bgp_attr_finish(void);
262 extern bgp_attr_parse_ret_t
bgp_attr_parse(struct peer
*, struct attr
*,
263 bgp_size_t
, struct bgp_nlri
*,
265 extern void bgp_attr_dup(struct attr
*, struct attr
*);
266 extern void bgp_attr_undup(struct attr
*new, struct attr
*old
);
267 extern struct attr
*bgp_attr_intern(struct attr
*attr
);
268 extern void bgp_attr_unintern_sub(struct attr
*);
269 extern void bgp_attr_unintern(struct attr
**);
270 extern void bgp_attr_flush(struct attr
*);
271 extern struct attr
*bgp_attr_default_set(struct attr
*attr
, uint8_t);
272 extern struct attr
*bgp_attr_aggregate_intern(struct bgp
*, uint8_t,
274 struct community
*, int as_set
,
276 extern bgp_size_t
bgp_packet_attribute(struct bgp
*bgp
, struct peer
*,
277 struct stream
*, struct attr
*,
278 struct bpacket_attr_vec_arr
*vecarr
,
279 struct prefix
*, afi_t
, safi_t
,
280 struct peer
*, struct prefix_rd
*,
281 mpls_label_t
*, uint32_t, int, uint32_t);
282 extern void bgp_dump_routes_attr(struct stream
*, struct attr
*,
284 extern int attrhash_cmp(const void *, const void *);
285 extern unsigned int attrhash_key_make(void *);
286 extern void attr_show_all(struct vty
*);
287 extern unsigned long int attr_count(void);
288 extern unsigned long int attr_unknown_count(void);
290 /* Cluster list prototypes. */
291 extern int cluster_loop_check(struct cluster_list
*, struct in_addr
);
292 extern void cluster_unintern(struct cluster_list
*);
294 /* Transit attribute prototypes. */
295 void transit_unintern(struct transit
*);
297 /* Below exported for unit-test purposes only */
298 struct bgp_attr_parser_args
{
300 bgp_size_t length
; /* attribute data length; */
301 bgp_size_t total
; /* total length, inc header */
307 extern int bgp_mp_reach_parse(struct bgp_attr_parser_args
*args
,
309 extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args
*args
,
311 extern bgp_attr_parse_ret_t
312 bgp_attr_prefix_sid(int32_t tlength
, struct bgp_attr_parser_args
*args
,
313 struct bgp_nlri
*mp_update
);
315 extern struct bgp_attr_encap_subtlv
*
316 encap_tlv_dup(struct bgp_attr_encap_subtlv
*orig
);
318 extern void bgp_attr_flush_encap(struct attr
*attr
);
321 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
322 * Typical call sequence is to call _start(), followed by multiple _prefix(),
323 * one for each NLRI that needs to be encoded into the UPDATE message, and
324 * finally the _end() function.
326 extern size_t bgp_packet_mpattr_start(struct stream
*s
, struct peer
*peer
,
327 afi_t afi
, safi_t safi
,
328 struct bpacket_attr_vec_arr
*vecarr
,
330 extern void bgp_packet_mpattr_prefix(struct stream
*s
, afi_t afi
, safi_t safi
,
331 struct prefix
*p
, struct prefix_rd
*prd
,
332 mpls_label_t
*label
, uint32_t num_labels
,
333 int addpath_encode
, uint32_t addpath_tx_id
,
335 extern size_t bgp_packet_mpattr_prefix_size(afi_t afi
, safi_t safi
,
337 extern void bgp_packet_mpattr_end(struct stream
*s
, size_t sizep
);
339 extern size_t bgp_packet_mpunreach_start(struct stream
*s
, afi_t afi
,
341 extern void bgp_packet_mpunreach_prefix(struct stream
*s
, struct prefix
*p
,
342 afi_t afi
, safi_t safi
,
343 struct prefix_rd
*prd
, mpls_label_t
*,
344 uint32_t, int, uint32_t, struct attr
*);
345 extern void bgp_packet_mpunreach_end(struct stream
*s
, size_t attrlen_pnt
);
347 static inline int bgp_rmap_nhop_changed(uint32_t out_rmap_flags
,
348 uint32_t in_rmap_flags
)
350 return ((CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_PEER_ADDRESS
)
351 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
)
352 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV4_NHOP_CHANGED
)
353 || CHECK_FLAG(out_rmap_flags
,
354 BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED
)
355 || CHECK_FLAG(out_rmap_flags
,
356 BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED
)
357 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV6_LL_NHOP_CHANGED
)
358 || CHECK_FLAG(in_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
))
363 static inline uint32_t mac_mobility_seqnum(struct attr
*attr
)
365 return (attr
) ? attr
->mm_seqnum
: 0;
368 #endif /* _QUAGGA_BGP_ATTR_H */