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 struct bgp_attr_encap_subtlv
{
70 struct bgp_attr_encap_subtlv
*next
; /* for chaining */
71 /* Reference count of this attribute. */
75 uint8_t value
[0]; /* will be extended */
80 * old rfp<->rfapi representation
82 struct bgp_tea_options
{
83 struct bgp_tea_options
*next
;
84 uint8_t options_count
;
85 uint16_t options_length
; /* each TLV may be 256 in length */
88 void *value
; /* pointer to data */
93 /* Overlay Index Info */
94 struct overlay_index
{
95 struct eth_segment_id eth_s_id
;
99 /* BGP core attribute structure. */
101 /* AS Path structure */
102 struct aspath
*aspath
;
104 /* Community structure */
105 struct community
*community
;
107 /* Reference count of this attribute. */
108 unsigned long refcnt
;
110 /* Flag of attribute is set or not. */
113 /* Apart from in6_addr, the remaining static attributes */
114 struct in_addr nexthop
;
116 u_int32_t local_pref
;
117 ifindex_t nh_ifindex
;
119 /* Path origin attribute */
122 /* has the route-map changed any attribute?
123 Used on the peer outbound side. */
124 u_int32_t rmap_change_flags
;
126 /* Multi-Protocol Nexthop, AFI IPv6 */
127 struct in6_addr mp_nexthop_global
;
128 struct in6_addr mp_nexthop_local
;
130 /* Extended Communities attribute. */
131 struct ecommunity
*ecommunity
;
133 /* Large Communities attribute. */
134 struct lcommunity
*lcommunity
;
136 /* Route-Reflector Cluster attribute */
137 struct cluster_list
*cluster
;
139 /* Unknown transitive attribute. */
140 struct transit
*transit
;
142 struct in_addr mp_nexthop_global_in
;
144 /* Aggregator Router ID attribute */
145 struct in_addr aggregator_addr
;
147 /* Route Reflector Originator attribute */
148 struct in_addr originator_id
;
150 /* Local weight, not actually an attribute */
156 /* MP Nexthop length */
157 u_char mp_nexthop_len
;
159 /* MP Nexthop preference */
160 u_char mp_nexthop_prefer_global
;
162 /* Static MAC for EVPN */
169 u_int32_t label_index
;
174 uint16_t encap_tunneltype
; /* grr */
175 struct bgp_attr_encap_subtlv
*encap_subtlvs
; /* rfc5512 */
178 struct bgp_attr_encap_subtlv
*vnc_subtlvs
; /* VNC-specific */
181 struct overlay_index evpn_overlay
;
183 /* EVPN MAC Mobility sequence number, if any. */
187 /* rmap_change_flags definition */
188 #define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
189 #define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
190 #define BATTR_REFLECTED (1 << 2)
191 #define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
192 #define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
193 #define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
194 #define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)
196 /* Router Reflector related structure. */
197 struct cluster_list
{
198 unsigned long refcnt
;
200 struct in_addr
*list
;
203 /* Unknown transit attribute. */
205 unsigned long refcnt
;
210 /* "(void) 0" will generate a compiler error. this is a safety check to
211 * ensure we're not using a value that exceeds the bit size of attr->flag. */
212 #define ATTR_FLAG_BIT(X) \
213 __builtin_choose_expr((X) >= 1 && (X) <= 64, \
217 #define BGP_CLUSTER_LIST_LENGTH(attr) \
218 (((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) \
219 ? (attr)->cluster->length \
223 BGP_ATTR_PARSE_PROCEED
= 0,
224 BGP_ATTR_PARSE_ERROR
= -1,
225 BGP_ATTR_PARSE_WITHDRAW
= -2,
227 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
229 BGP_ATTR_PARSE_ERROR_NOTIFYPLS
= -3,
230 BGP_ATTR_PARSE_EOR
= -4,
231 } bgp_attr_parse_ret_t
;
233 struct bpacket_attr_vec_arr
;
236 extern void bgp_attr_init(void);
237 extern void bgp_attr_finish(void);
238 extern bgp_attr_parse_ret_t
bgp_attr_parse(struct peer
*, struct attr
*,
239 bgp_size_t
, struct bgp_nlri
*,
241 extern void bgp_attr_dup(struct attr
*, struct attr
*);
242 extern void bgp_attr_undup(struct attr
*new, struct attr
*old
);
243 extern struct attr
*bgp_attr_intern(struct attr
*attr
);
244 extern void bgp_attr_unintern_sub(struct attr
*);
245 extern void bgp_attr_unintern(struct attr
**);
246 extern void bgp_attr_flush(struct attr
*);
247 extern struct attr
*bgp_attr_default_set(struct attr
*attr
, u_char
);
248 extern struct attr
*bgp_attr_aggregate_intern(struct bgp
*, u_char
,
250 struct community
*, int as_set
,
252 extern bgp_size_t
bgp_packet_attribute(struct bgp
*bgp
, struct peer
*,
253 struct stream
*, struct attr
*,
254 struct bpacket_attr_vec_arr
*vecarr
,
255 struct prefix
*, afi_t
, safi_t
,
256 struct peer
*, struct prefix_rd
*,
257 mpls_label_t
*, int, u_int32_t
);
258 extern void bgp_dump_routes_attr(struct stream
*, struct attr
*,
260 extern int attrhash_cmp(const void *, const void *);
261 extern unsigned int attrhash_key_make(void *);
262 extern void attr_show_all(struct vty
*);
263 extern unsigned long int attr_count(void);
264 extern unsigned long int attr_unknown_count(void);
266 /* Cluster list prototypes. */
267 extern int cluster_loop_check(struct cluster_list
*, struct in_addr
);
268 extern void cluster_unintern(struct cluster_list
*);
270 /* Transit attribute prototypes. */
271 void transit_unintern(struct transit
*);
273 /* Below exported for unit-test purposes only */
274 struct bgp_attr_parser_args
{
276 bgp_size_t length
; /* attribute data length; */
277 bgp_size_t total
; /* total length, inc header */
283 extern int bgp_mp_reach_parse(struct bgp_attr_parser_args
*args
,
285 extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args
*args
,
288 extern struct bgp_attr_encap_subtlv
*
289 encap_tlv_dup(struct bgp_attr_encap_subtlv
*orig
);
291 extern void bgp_attr_flush_encap(struct attr
*attr
);
294 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
295 * Typical call sequence is to call _start(), followed by multiple _prefix(),
296 * one for each NLRI that needs to be encoded into the UPDATE message, and
297 * finally the _end() function.
299 extern size_t bgp_packet_mpattr_start(struct stream
*s
, struct peer
*peer
,
300 afi_t afi
, safi_t safi
,
301 struct bpacket_attr_vec_arr
*vecarr
,
303 extern void bgp_packet_mpattr_prefix(struct stream
*s
, afi_t afi
, safi_t safi
,
304 struct prefix
*p
, struct prefix_rd
*prd
,
305 mpls_label_t
*label
, int addpath_encode
,
306 u_int32_t addpath_tx_id
, struct attr
*);
307 extern size_t bgp_packet_mpattr_prefix_size(afi_t afi
, safi_t safi
,
309 extern void bgp_packet_mpattr_end(struct stream
*s
, size_t sizep
);
311 extern size_t bgp_packet_mpunreach_start(struct stream
*s
, afi_t afi
,
313 extern void bgp_packet_mpunreach_prefix(struct stream
*s
, struct prefix
*p
,
314 afi_t afi
, safi_t safi
,
315 struct prefix_rd
*prd
, mpls_label_t
*,
316 int, u_int32_t
, struct attr
*);
317 extern void bgp_packet_mpunreach_end(struct stream
*s
, size_t attrlen_pnt
);
319 static inline int bgp_rmap_nhop_changed(u_int32_t out_rmap_flags
,
320 u_int32_t in_rmap_flags
)
322 return ((CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_PEER_ADDRESS
)
323 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
)
324 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV4_NHOP_CHANGED
)
325 || CHECK_FLAG(out_rmap_flags
,
326 BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED
)
327 || CHECK_FLAG(out_rmap_flags
,
328 BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED
)
329 || CHECK_FLAG(out_rmap_flags
, BATTR_RMAP_IPV6_LL_NHOP_CHANGED
)
330 || CHECK_FLAG(in_rmap_flags
, BATTR_RMAP_NEXTHOP_UNCHANGED
))
335 static inline u_int32_t
mac_mobility_seqnum(struct attr
*attr
)
337 return (attr
) ? attr
->mm_seqnum
: 0;
340 #endif /* _QUAGGA_BGP_ATTR_H */