]> git.proxmox.com Git - mirror_frr.git/blame - bgpd/bgp_attr.h
*: conform with COMMUNITY.md formatting rules, via 'make indent'
[mirror_frr.git] / bgpd / bgp_attr.h
CommitLineData
d62a17ae 1/* BGP attributes.
896014f4
DL
2 * Copyright (C) 1996, 97, 98 Kunihiro Ishiguro
3 *
4 * This file is part of GNU Zebra.
5 *
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
9 * later version.
10 *
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.
15 *
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
19 */
718e3744 20
00d252cb 21#ifndef _QUAGGA_BGP_ATTR_H
22#define _QUAGGA_BGP_ATTR_H
23
9bedbb1e 24#include "mpls.h"
684a7227
PG
25#include "bgp_attr_evpn.h"
26
718e3744 27/* Simple bit mapping. */
28#define BITMAP_NBBY 8
29
d62a17ae 30#define SET_BITMAP(MAP, NUM) \
31 SET_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
718e3744 32
d62a17ae 33#define CHECK_BITMAP(MAP, NUM) \
34 CHECK_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
718e3744 35
3b424979 36#define BGP_MED_MAX UINT32_MAX
37
718e3744 38/* BGP Attribute type range. */
39#define BGP_ATTR_TYPE_RANGE 256
40#define BGP_ATTR_BITMAP_SIZE (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)
41
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. */
47
48/* BGP attribute header must bigger than 2. */
370b64a2 49#define BGP_ATTR_MIN_LEN 3 /* Attribute flag, type length. */
03e214c8
PJ
50#define BGP_ATTR_DEFAULT_WEIGHT 32768
51
801a9bcc
DS
52/* Valid lengths for mp_nexthop_len */
53#define BGP_ATTR_NHLEN_IPV4 IPV4_MAX_BYTELEN
945c8fe9 54#define BGP_ATTR_NHLEN_VPNV4 8+IPV4_MAX_BYTELEN
801a9bcc
DS
55#define BGP_ATTR_NHLEN_IPV6_GLOBAL IPV6_MAX_BYTELEN
56#define BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL (IPV6_MAX_BYTELEN * 2)
945c8fe9
LB
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)
801a9bcc 59
c5a543b4
DW
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
64
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
f4c89855
LB
68
69struct bgp_attr_encap_subtlv {
d62a17ae 70 struct bgp_attr_encap_subtlv *next; /* for chaining */
71 /* Reference count of this attribute. */
72 unsigned long refcnt;
73 uint16_t type;
74 uint16_t length;
8c9cc7bb 75 uint8_t value[0]; /* will be extended */
f4c89855
LB
76};
77
65efcfce
LB
78#if ENABLE_BGP_VNC
79/*
80 * old rfp<->rfapi representation
81 */
82struct bgp_tea_options {
d62a17ae 83 struct bgp_tea_options *next;
84 uint8_t options_count;
85 uint16_t options_length; /* each TLV may be 256 in length */
86 uint8_t type;
87 uint8_t length;
88 void *value; /* pointer to data */
65efcfce
LB
89};
90
91#endif
92
684a7227 93/* Overlay Index Info */
d62a17ae 94struct overlay_index {
95 struct eth_segment_id eth_s_id;
96 union gw_addr gw_ip;
684a7227
PG
97};
98
aadc0905 99/* BGP core attribute structure. */
d62a17ae 100struct attr {
101 /* AS Path structure */
102 struct aspath *aspath;
103
104 /* Community structure */
105 struct community *community;
106
107 /* Reference count of this attribute. */
108 unsigned long refcnt;
109
110 /* Flag of attribute is set or not. */
111 uint64_t flag;
112
113 /* Apart from in6_addr, the remaining static attributes */
114 struct in_addr nexthop;
115 u_int32_t med;
116 u_int32_t local_pref;
117 ifindex_t nh_ifindex;
118
119 /* Path origin attribute */
120 u_char origin;
121
122 /* has the route-map changed any attribute?
123 Used on the peer outbound side. */
124 u_int32_t rmap_change_flags;
125
126 /* Multi-Protocol Nexthop, AFI IPv6 */
127 struct in6_addr mp_nexthop_global;
128 struct in6_addr mp_nexthop_local;
129
130 /* Extended Communities attribute. */
131 struct ecommunity *ecommunity;
132
133 /* Large Communities attribute. */
134 struct lcommunity *lcommunity;
135
136 /* Route-Reflector Cluster attribute */
137 struct cluster_list *cluster;
138
139 /* Unknown transitive attribute. */
140 struct transit *transit;
141
142 struct in_addr mp_nexthop_global_in;
143
144 /* Aggregator Router ID attribute */
145 struct in_addr aggregator_addr;
146
147 /* Route Reflector Originator attribute */
148 struct in_addr originator_id;
149
150 /* Local weight, not actually an attribute */
151 u_int32_t weight;
152
153 /* Aggregator ASN */
154 as_t aggregator_as;
155
156 /* MP Nexthop length */
157 u_char mp_nexthop_len;
158
159 /* MP Nexthop preference */
160 u_char mp_nexthop_prefer_global;
161
162 /* Static MAC for EVPN */
163 u_char sticky;
164
ead40654
MK
165 /* Flag for default gateway extended community in EVPN */
166 u_char default_gw;
167
d62a17ae 168 /* route tag */
169 route_tag_t tag;
170
171 /* Label index */
172 u_int32_t label_index;
173
174 /* MPLS label */
175 mpls_label_t label;
176
177 uint16_t encap_tunneltype; /* grr */
178 struct bgp_attr_encap_subtlv *encap_subtlvs; /* rfc5512 */
65efcfce
LB
179
180#if ENABLE_BGP_VNC
d62a17ae 181 struct bgp_attr_encap_subtlv *vnc_subtlvs; /* VNC-specific */
65efcfce 182#endif
d62a17ae 183 /* EVPN */
184 struct overlay_index evpn_overlay;
128ea8ab 185
d62a17ae 186 /* EVPN MAC Mobility sequence number, if any. */
187 u_int32_t mm_seqnum;
bc59a672
MK
188
189 /* EVPN local router-mac */
190 struct ethaddr rmac;
fb982c25
PJ
191};
192
3f9c7369 193/* rmap_change_flags definition */
3811f1e2 194#define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
3f9c7369
DS
195#define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
196#define BATTR_REFLECTED (1 << 2)
316e074d 197#define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
3811f1e2
DS
198#define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
199#define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
b2e03f7a 200#define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)
3f9c7369 201
718e3744 202/* Router Reflector related structure. */
d62a17ae 203struct cluster_list {
204 unsigned long refcnt;
205 int length;
206 struct in_addr *list;
718e3744 207};
208
209/* Unknown transit attribute. */
d62a17ae 210struct transit {
211 unsigned long refcnt;
212 int length;
213 u_char *val;
718e3744 214};
215
96099b40
DL
216/* "(void) 0" will generate a compiler error. this is a safety check to
217 * ensure we're not using a value that exceeds the bit size of attr->flag. */
996c9314
LB
218#define ATTR_FLAG_BIT(X) \
219 __builtin_choose_expr((X) >= 1 && (X) <= 64, 1ULL << ((X)-1), (void)0)
718e3744 220
d62a17ae 221#define BGP_CLUSTER_LIST_LENGTH(attr) \
222 (((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) \
223 ? (attr)->cluster->length \
224 : 0)
5e242b0d 225
b881c707 226typedef enum {
d62a17ae 227 BGP_ATTR_PARSE_PROCEED = 0,
228 BGP_ATTR_PARSE_ERROR = -1,
229 BGP_ATTR_PARSE_WITHDRAW = -2,
f57000c0 230
d62a17ae 231 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
9d303b37 232 */
d62a17ae 233 BGP_ATTR_PARSE_ERROR_NOTIFYPLS = -3,
9b9df989 234 BGP_ATTR_PARSE_EOR = -4,
b881c707
PJ
235} bgp_attr_parse_ret_t;
236
3f9c7369
DS
237struct bpacket_attr_vec_arr;
238
718e3744 239/* Prototypes. */
d62a17ae 240extern void bgp_attr_init(void);
241extern void bgp_attr_finish(void);
242extern bgp_attr_parse_ret_t bgp_attr_parse(struct peer *, struct attr *,
243 bgp_size_t, struct bgp_nlri *,
244 struct bgp_nlri *);
245extern void bgp_attr_dup(struct attr *, struct attr *);
f46d8e1e 246extern void bgp_attr_undup(struct attr *new, struct attr *old);
d62a17ae 247extern struct attr *bgp_attr_intern(struct attr *attr);
d62a17ae 248extern void bgp_attr_unintern_sub(struct attr *);
249extern void bgp_attr_unintern(struct attr **);
250extern void bgp_attr_flush(struct attr *);
251extern struct attr *bgp_attr_default_set(struct attr *attr, u_char);
252extern struct attr *bgp_attr_aggregate_intern(struct bgp *, u_char,
253 struct aspath *,
254 struct community *, int as_set,
255 u_char);
256extern bgp_size_t bgp_packet_attribute(struct bgp *bgp, struct peer *,
257 struct stream *, struct attr *,
258 struct bpacket_attr_vec_arr *vecarr,
259 struct prefix *, afi_t, safi_t,
260 struct peer *, struct prefix_rd *,
996c9314
LB
261 mpls_label_t *, u_int32_t, int,
262 u_int32_t);
d62a17ae 263extern void bgp_dump_routes_attr(struct stream *, struct attr *,
264 struct prefix *);
265extern int attrhash_cmp(const void *, const void *);
266extern unsigned int attrhash_key_make(void *);
267extern void attr_show_all(struct vty *);
268extern unsigned long int attr_count(void);
269extern unsigned long int attr_unknown_count(void);
718e3744 270
271/* Cluster list prototypes. */
d62a17ae 272extern int cluster_loop_check(struct cluster_list *, struct in_addr);
273extern void cluster_unintern(struct cluster_list *);
718e3744 274
275/* Transit attribute prototypes. */
d62a17ae 276void transit_unintern(struct transit *);
00d252cb 277
835315bf
PJ
278/* Below exported for unit-test purposes only */
279struct bgp_attr_parser_args {
d62a17ae 280 struct peer *peer;
281 bgp_size_t length; /* attribute data length; */
282 bgp_size_t total; /* total length, inc header */
283 struct attr *attr;
284 u_int8_t type;
285 u_int8_t flags;
286 u_char *startp;
835315bf 287};
d62a17ae 288extern int bgp_mp_reach_parse(struct bgp_attr_parser_args *args,
289 struct bgp_nlri *);
290extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args *args,
291 struct bgp_nlri *);
03292809 292
f4c89855
LB
293extern struct bgp_attr_encap_subtlv *
294encap_tlv_dup(struct bgp_attr_encap_subtlv *orig);
295
d62a17ae 296extern void bgp_attr_flush_encap(struct attr *attr);
f4c89855 297
8c71e481
PM
298/**
299 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
300 * Typical call sequence is to call _start(), followed by multiple _prefix(),
301 * one for each NLRI that needs to be encoded into the UPDATE message, and
302 * finally the _end() function.
303 */
2b26882d 304extern size_t bgp_packet_mpattr_start(struct stream *s, struct peer *peer,
d62a17ae 305 afi_t afi, safi_t safi,
306 struct bpacket_attr_vec_arr *vecarr,
8c71e481
PM
307 struct attr *attr);
308extern void bgp_packet_mpattr_prefix(struct stream *s, afi_t afi, safi_t safi,
309 struct prefix *p, struct prefix_rd *prd,
b57ba6d2
MK
310 mpls_label_t *label, u_int32_t num_labels,
311 int addpath_encode,
d62a17ae 312 u_int32_t addpath_tx_id, struct attr *);
93b73dfa 313extern size_t bgp_packet_mpattr_prefix_size(afi_t afi, safi_t safi,
d62a17ae 314 struct prefix *p);
8c71e481
PM
315extern void bgp_packet_mpattr_end(struct stream *s, size_t sizep);
316
d62a17ae 317extern size_t bgp_packet_mpunreach_start(struct stream *s, afi_t afi,
318 safi_t safi);
319extern void bgp_packet_mpunreach_prefix(struct stream *s, struct prefix *p,
320 afi_t afi, safi_t safi,
996c9314
LB
321 struct prefix_rd *prd, mpls_label_t *,
322 u_int32_t, int, u_int32_t,
323 struct attr *);
d62a17ae 324extern void bgp_packet_mpunreach_end(struct stream *s, size_t attrlen_pnt);
8c71e481 325
d62a17ae 326static inline int bgp_rmap_nhop_changed(u_int32_t out_rmap_flags,
327 u_int32_t in_rmap_flags)
3811f1e2 328{
d62a17ae 329 return ((CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_PEER_ADDRESS)
330 || CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED)
331 || CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV4_NHOP_CHANGED)
332 || CHECK_FLAG(out_rmap_flags,
333 BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED)
334 || CHECK_FLAG(out_rmap_flags,
335 BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED)
336 || CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV6_LL_NHOP_CHANGED)
337 || CHECK_FLAG(in_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED))
338 ? 1
339 : 0);
3811f1e2
DS
340}
341
d62a17ae 342static inline u_int32_t mac_mobility_seqnum(struct attr *attr)
128ea8ab 343{
d62a17ae 344 return (attr) ? attr->mm_seqnum : 0;
128ea8ab 345}
346
00d252cb 347#endif /* _QUAGGA_BGP_ATTR_H */