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"
28 /* Simple bit mapping. */
31 #define SET_BITMAP(MAP, NUM) \
32 SET_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
34 #define CHECK_BITMAP(MAP, NUM) \
35 CHECK_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
37 #define BGP_MED_MAX UINT32_MAX
39 /* BGP Attribute type range. */
40 #define BGP_ATTR_TYPE_RANGE 256
41 #define BGP_ATTR_BITMAP_SIZE (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)
43 /* BGP Attribute flags. */
44 #define BGP_ATTR_FLAG_OPTIONAL 0x80 /* Attribute is optional. */
45 #define BGP_ATTR_FLAG_TRANS 0x40 /* Attribute is transitive. */
46 #define BGP_ATTR_FLAG_PARTIAL 0x20 /* Attribute is partial. */
47 #define BGP_ATTR_FLAG_EXTLEN 0x10 /* Extended length flag. */
49 /* BGP attribute header must bigger than 2. */
50 #define BGP_ATTR_MIN_LEN 3 /* Attribute flag, type length. */
51 #define BGP_ATTR_DEFAULT_WEIGHT 32768
53 /* Valid lengths for mp_nexthop_len */
54 #define BGP_ATTR_NHLEN_IPV4 IPV4_MAX_BYTELEN
55 #define BGP_ATTR_NHLEN_VPNV4 8+IPV4_MAX_BYTELEN
56 #define BGP_ATTR_NHLEN_IPV6_GLOBAL IPV6_MAX_BYTELEN
57 #define BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL (IPV6_MAX_BYTELEN * 2)
58 #define BGP_ATTR_NHLEN_VPNV6_GLOBAL 8+IPV6_MAX_BYTELEN
59 #define BGP_ATTR_NHLEN_VPNV6_GLOBAL_AND_LL ((8+IPV6_MAX_BYTELEN) * 2)
61 /* Prefix SID types */
62 #define BGP_PREFIX_SID_LABEL_INDEX 1
63 #define BGP_PREFIX_SID_IPV6 2
64 #define BGP_PREFIX_SID_ORIGINATOR_SRGB 3
66 #define BGP_PREFIX_SID_LABEL_INDEX_LENGTH 7
67 #define BGP_PREFIX_SID_IPV6_LENGTH 19
68 #define BGP_PREFIX_SID_ORIGINATOR_SRGB_LENGTH 6
70 /* PMSI tunnel types (RFC 6514) */
72 struct bgp_attr_encap_subtlv
{
73 struct bgp_attr_encap_subtlv
*next
; /* for chaining */
74 /* Reference count of this attribute. */
78 uint8_t value
[0]; /* will be extended */
83 * old rfp<->rfapi representation
85 struct bgp_tea_options
{
86 struct bgp_tea_options
*next
;
87 uint8_t options_count
;
88 uint16_t options_length
; /* each TLV may be 256 in length */
91 void *value
; /* pointer to data */
97 PMSI_TNLTYPE_NO_INFO
= 0,
98 PMSI_TNLTYPE_RSVP_TE_P2MP
,
99 PMSI_TNLTYPE_MLDP_P2MP
,
100 PMSI_TNLTYPE_PIM_SSM
,
102 PMSI_TNLTYPE_PIM_BIDIR
,
103 PMSI_TNLTYPE_INGR_REPL
,
104 PMSI_TNLTYPE_MLDP_MP2MP
,
105 PMSI_TNLTYPE_MAX
= PMSI_TNLTYPE_MLDP_MP2MP
108 /* BGP core attribute structure. */
110 /* AS Path structure */
111 struct aspath
*aspath
;
113 /* Community structure */
114 struct community
*community
;
116 /* Reference count of this attribute. */
117 unsigned long refcnt
;
119 /* Flag of attribute is set or not. */
122 /* Apart from in6_addr, the remaining static attributes */
123 struct in_addr nexthop
;
126 ifindex_t nh_ifindex
;
128 /* Path origin attribute */
131 /* PMSI tunnel type (RFC 6514). */
132 enum pta_type pmsi_tnl_type
;
134 /* has the route-map changed any attribute?
135 Used on the peer outbound side. */
136 uint32_t rmap_change_flags
;
138 /* Multi-Protocol Nexthop, AFI IPv6 */
139 struct in6_addr mp_nexthop_global
;
140 struct in6_addr mp_nexthop_local
;
142 /* ifIndex corresponding to mp_nexthop_local. */
143 ifindex_t nh_lla_ifindex
;
145 /* Extended Communities attribute. */
146 struct ecommunity
*ecommunity
;
148 /* Large Communities attribute. */
149 struct lcommunity
*lcommunity
;
151 /* Route-Reflector Cluster attribute */
152 struct cluster_list
*cluster
;
154 /* Unknown transitive attribute. */
155 struct transit
*transit
;
157 struct in_addr mp_nexthop_global_in
;
159 /* Aggregator Router ID attribute */
160 struct in_addr aggregator_addr
;
162 /* Route Reflector Originator attribute */
163 struct in_addr originator_id
;
165 /* Local weight, not actually an attribute */
171 /* MP Nexthop length */
172 uint8_t mp_nexthop_len
;
174 /* MP Nexthop preference */
175 uint8_t mp_nexthop_prefer_global
;
177 /* Static MAC for EVPN */
180 /* Flag for default gateway extended community in EVPN */
183 /* NA router flag (R-bit) support in EVPN */
190 uint32_t label_index
;
195 uint16_t encap_tunneltype
; /* grr */
196 struct bgp_attr_encap_subtlv
*encap_subtlvs
; /* rfc5512 */
199 struct bgp_attr_encap_subtlv
*vnc_subtlvs
; /* VNC-specific */
202 struct bgp_route_evpn evpn_overlay
;
204 /* EVPN MAC Mobility sequence number, if any. */
207 /* EVPN local router-mac */
211 /* rmap_change_flags definition */
212 #define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
213 #define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
214 #define BATTR_REFLECTED (1 << 2)
215 #define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
216 #define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
217 #define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
218 #define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)
220 /* Router Reflector related structure. */
221 struct cluster_list
{
222 unsigned long refcnt
;
224 struct in_addr
*list
;
227 /* Unknown transit attribute. */
229 unsigned long refcnt
;
234 /* "(void) 0" will generate a compiler error. this is a safety check to
235 * ensure we're not using a value that exceeds the bit size of attr->flag. */
236 #define ATTR_FLAG_BIT(X) \
237 __builtin_choose_expr((X) >= 1 && (X) <= 64, 1ULL << ((X)-1), (void)0)
239 #define BGP_CLUSTER_LIST_LENGTH(attr) \
240 (((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) \
241 ? (attr)->cluster->length \
245 BGP_ATTR_PARSE_PROCEED
= 0,
246 BGP_ATTR_PARSE_ERROR
= -1,
247 BGP_ATTR_PARSE_WITHDRAW
= -2,
249 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
251 BGP_ATTR_PARSE_ERROR_NOTIFYPLS
= -3,
252 BGP_ATTR_PARSE_EOR
= -4,
253 } bgp_attr_parse_ret_t
;
255 struct bpacket_attr_vec_arr
;
258 extern void bgp_attr_init(void);
259 extern void bgp_attr_finish(void);
260 extern bgp_attr_parse_ret_t
bgp_attr_parse(struct peer
*, struct attr
*,
261 bgp_size_t
, struct bgp_nlri
*,
263 extern void bgp_attr_dup(struct attr
*, struct attr
*);
264 extern void bgp_attr_undup(struct attr
*new, struct attr
*old
);
265 extern struct attr
*bgp_attr_intern(struct attr
*attr
);
266 extern void bgp_attr_unintern_sub(struct attr
*);
267 extern void bgp_attr_unintern(struct attr
**);
268 extern void bgp_attr_flush(struct attr
*);
269 extern struct attr
*bgp_attr_default_set(struct attr
*attr
, uint8_t);
270 extern struct attr
*bgp_attr_aggregate_intern(struct bgp
*bgp
, uint8_t origin
,
271 struct aspath
*aspath
,
272 struct community
*community
,
273 struct ecommunity
*ecommunity
,
274 struct lcommunity
*lcommunity
,
275 struct bgp_aggregate
*aggregate
,
276 uint8_t atomic_aggregate
,
278 extern bgp_size_t
bgp_packet_attribute(struct bgp
*bgp
, struct peer
*,
279 struct stream
*, struct attr
*,
280 struct bpacket_attr_vec_arr
*vecarr
,
281 struct prefix
*, afi_t
, safi_t
,
282 struct peer
*, struct prefix_rd
*,
283 mpls_label_t
*, uint32_t, int, uint32_t);
284 extern void bgp_dump_routes_attr(struct stream
*, struct attr
*,
286 extern bool attrhash_cmp(const void *arg1
, const void *arg2
);
287 extern unsigned int attrhash_key_make(const void *);
288 extern void attr_show_all(struct vty
*);
289 extern unsigned long int attr_count(void);
290 extern unsigned long int attr_unknown_count(void);
292 /* Cluster list prototypes. */
293 extern int cluster_loop_check(struct cluster_list
*, struct in_addr
);
294 extern void cluster_unintern(struct cluster_list
*);
296 /* Transit attribute prototypes. */
297 void transit_unintern(struct transit
*);
299 /* Below exported for unit-test purposes only */
300 struct bgp_attr_parser_args
{
302 bgp_size_t length
; /* attribute data length; */
303 bgp_size_t total
; /* total length, inc header */
309 extern int bgp_mp_reach_parse(struct bgp_attr_parser_args
*args
,
311 extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args
*args
,
313 extern bgp_attr_parse_ret_t
314 bgp_attr_prefix_sid(int32_t tlength
, struct bgp_attr_parser_args
*args
,
315 struct bgp_nlri
*mp_update
);
317 extern struct bgp_attr_encap_subtlv
*
318 encap_tlv_dup(struct bgp_attr_encap_subtlv
*orig
);
320 extern void bgp_attr_flush_encap(struct attr
*attr
);
322 extern void bgp_attr_extcom_tunnel_type(struct attr
*attr
,
323 bgp_encap_types
*tunnel_type
);
326 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
327 * Typical call sequence is to call _start(), followed by multiple _prefix(),
328 * one for each NLRI that needs to be encoded into the UPDATE message, and
329 * finally the _end() function.
331 extern size_t bgp_packet_mpattr_start(struct stream
*s
, struct peer
*peer
,
332 afi_t afi
, safi_t safi
,
333 struct bpacket_attr_vec_arr
*vecarr
,
335 extern void bgp_packet_mpattr_prefix(struct stream
*s
, afi_t afi
, safi_t safi
,
336 struct prefix
*p
, struct prefix_rd
*prd
,
337 mpls_label_t
*label
, uint32_t num_labels
,
338 int addpath_encode
, uint32_t addpath_tx_id
,
340 extern size_t bgp_packet_mpattr_prefix_size(afi_t afi
, safi_t safi
,
342 extern void bgp_packet_mpattr_end(struct stream
*s
, size_t sizep
);
344 extern size_t bgp_packet_mpunreach_start(struct stream
*s
, afi_t afi
,
346 extern void bgp_packet_mpunreach_prefix(struct stream
*s
, struct prefix
*p
,
347 afi_t afi
, safi_t safi
,
348 struct prefix_rd
*prd
, mpls_label_t
*,
349 uint32_t, int, uint32_t, struct attr
*);
350 extern void bgp_packet_mpunreach_end(struct stream
*s
, size_t attrlen_pnt
);
352 extern bgp_attr_parse_ret_t
bgp_attr_nexthop_valid(struct peer
*peer
,
355 static inline int bgp_rmap_nhop_changed(uint32_t out_rmap_flags
,
356 uint32_t in_rmap_flags
)
358 return ((CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_PEER_ADDRESS
)
359 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
)
360 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV4_NHOP_CHANGED
)
361 || CHECK_FLAG(out_rmap_flags
,
362 BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED
)
363 || CHECK_FLAG(out_rmap_flags
,
364 BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED
)
365 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV6_LL_NHOP_CHANGED
)
366 || CHECK_FLAG(in_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
))
371 static inline uint32_t mac_mobility_seqnum(struct attr
*attr
)
373 return (attr
) ? attr
->mm_seqnum
: 0;
376 #endif /* _QUAGGA_BGP_ATTR_H */