1 /* BGP EVPN internal definitions
2 * Copyright (C) 2017 Cumulus Networks, Inc.
4 * This file is part of FRR.
6 * FRR 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 * FRR 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
17 * along with FRR; see the file COPYING. If not, write to the Free
18 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
22 #ifndef _BGP_EVPN_PRIVATE_H
23 #define _BGP_EVPN_PRIVATE_H
28 #include "bgpd/bgpd.h"
29 #include "bgpd/bgp_ecommunity.h"
31 #define RT_ADDRSTRLEN 28
33 /* EVPN prefix lengths. This represents the sizeof struct evpn_addr
35 #define EVPN_ROUTE_PREFIXLEN (sizeof(struct evpn_addr) * 8)
37 /* EVPN route types. */
39 BGP_EVPN_AD_ROUTE
= 1, /* Ethernet Auto-Discovery (A-D) route */
40 BGP_EVPN_MAC_IP_ROUTE
, /* MAC/IP Advertisement route */
41 BGP_EVPN_IMET_ROUTE
, /* Inclusive Multicast Ethernet Tag route */
42 BGP_EVPN_ES_ROUTE
, /* Ethernet Segment route */
43 BGP_EVPN_IP_PREFIX_ROUTE
, /* IP Prefix route */
44 } bgp_evpn_route_type
;
47 * Hash table of EVIs. Right now, the only type of EVI supported is with
48 * VxLAN encapsulation, hence each EVI corresponds to a L2 VNI.
49 * The VNIs are not "created" through BGP but through some other interface
50 * on the system. This table stores VNIs that BGP comes to know as present
51 * on the system (through interaction with zebra) as well as pre-configured
52 * VNIs (which need to be defined in the system to become "live").
56 vrf_id_t tenant_vrf_id
;
58 #define VNI_FLAG_CFGD 0x1 /* VNI is user configured */
59 #define VNI_FLAG_LIVE 0x2 /* VNI is "live" */
60 #define VNI_FLAG_RD_CFGD 0x4 /* RD is user configured. */
61 #define VNI_FLAG_IMPRT_CFGD 0x8 /* Import RT is user configured */
62 #define VNI_FLAG_EXPRT_CFGD 0x10 /* Export RT is user configured */
63 #define VNI_FLAG_USE_TWO_LABELS 0x20 /* Attach both L2-VNI and L3-VNI if
64 needed for this VPN */
66 struct bgp
*bgp_vrf
; /* back pointer to the vrf instance */
68 /* Flag to indicate if we are
69 * advertising the g/w mac ip for
71 uint8_t advertise_gw_macip
;
73 /* Flag to indicate if we are
74 * advertising subnet for this VNI */
75 uint8_t advertise_subnet
;
77 /* Flag to indicate if we are advertising the svi mac ip for this VNI*/
78 uint8_t advertise_svi_macip
;
80 /* Id for deriving the RD
81 * automatically for this VNI */
84 /* RD for this VNI. */
87 /* Route type 3 field */
88 struct in_addr originator_ip
;
90 /* PIM-SM MDT group for BUM flooding */
91 struct in_addr mcast_grp
;
93 /* Import and Export RTs. */
94 struct list
*import_rtl
;
95 struct list
*export_rtl
;
97 /* Route table for EVPN routes for
99 struct bgp_table
*route_table
;
104 DECLARE_QOBJ_TYPE(bgpevpn
)
108 /* Ethernet Segment Identifier */
113 #define EVPNES_LOCAL 0x01
114 #define EVPNES_REMOTE 0x02
117 * Id for deriving the RD
118 * automatically for this ESI
122 /* RD for this VNI. */
123 struct prefix_rd prd
;
125 /* originator ip address */
126 struct ipaddr originator_ip
;
128 /* list of VTEPs in the same site */
129 struct list
*vtep_list
;
132 * Route table for EVPN routes for
133 * this ESI. - type4 routes
135 struct bgp_table
*route_table
;
140 DECLARE_QOBJ_TYPE(evpnes
)
142 /* Mapping of Import RT to VNIs.
143 * The Import RTs of all VNIs are maintained in a hash table with each
144 * RT linking to all VNIs that will import routes matching this RT.
148 struct ecommunity_val rt
;
150 /* List of VNIs importing routes matching this RT. */
154 /* Mapping of Import RT to VRFs.
155 * The Import RTs of all VRFss are maintained in a hash table with each
156 * RT linking to all VRFs that will import routes matching this RT.
158 struct vrf_irt_node
{
160 struct ecommunity_val rt
;
162 /* List of VNIs importing routes matching this RT. */
167 #define RT_TYPE_IMPORT 1
168 #define RT_TYPE_EXPORT 2
169 #define RT_TYPE_BOTH 3
171 #define EVPN_DAD_DEFAULT_TIME 180 /* secs */
172 #define EVPN_DAD_DEFAULT_MAX_MOVES 5 /* default from RFC 7432 */
173 #define EVPN_DAD_DEFAULT_AUTO_RECOVERY_TIME 1800 /* secs */
175 struct bgp_evpn_info
{
176 /* enable disable dup detect */
177 bool dup_addr_detect
;
179 /* Detection time(M) */
181 /* Detection max moves(N) */
182 uint32_t dad_max_moves
;
183 /* Permanent freeze */
186 uint32_t dad_freeze_time
;
188 /* EVPN enable - advertise svi macip routes */
189 int advertise_svi_macip
;
193 static inline int is_vrf_rd_configured(struct bgp
*bgp_vrf
)
195 return (CHECK_FLAG(bgp_vrf
->vrf_flags
, BGP_VRF_RD_CFGD
));
198 static inline int bgp_evpn_vrf_rd_matches_existing(struct bgp
*bgp_vrf
,
199 struct prefix_rd
*prd
)
201 return (memcmp(&bgp_vrf
->vrf_prd
.val
, prd
->val
, ECOMMUNITY_SIZE
) == 0);
204 static inline vni_t
bgpevpn_get_l3vni(struct bgpevpn
*vpn
)
206 return vpn
->bgp_vrf
? vpn
->bgp_vrf
->l3vni
: 0;
209 static inline void bgpevpn_get_rmac(struct bgpevpn
*vpn
, struct ethaddr
*rmac
)
211 memset(rmac
, 0, sizeof(struct ethaddr
));
214 memcpy(rmac
, &vpn
->bgp_vrf
->rmac
, sizeof(struct ethaddr
));
217 static inline struct list
*bgpevpn_get_vrf_export_rtl(struct bgpevpn
*vpn
)
222 return vpn
->bgp_vrf
->vrf_export_rtl
;
225 static inline struct list
*bgpevpn_get_vrf_import_rtl(struct bgpevpn
*vpn
)
230 return vpn
->bgp_vrf
->vrf_import_rtl
;
233 static inline void bgpevpn_unlink_from_l3vni(struct bgpevpn
*vpn
)
235 /* bail if vpn is not associated to bgp_vrf */
239 UNSET_FLAG(vpn
->flags
, VNI_FLAG_USE_TWO_LABELS
);
240 listnode_delete(vpn
->bgp_vrf
->l2vnis
, vpn
);
242 /* remove the backpointer to the vrf instance */
243 bgp_unlock(vpn
->bgp_vrf
);
247 static inline void bgpevpn_link_to_l3vni(struct bgpevpn
*vpn
)
249 struct bgp
*bgp_vrf
= NULL
;
251 /* bail if vpn is already associated to vrf */
255 bgp_vrf
= bgp_lookup_by_vrf_id(vpn
->tenant_vrf_id
);
259 /* associate the vpn to the bgp_vrf instance */
260 vpn
->bgp_vrf
= bgp_lock(bgp_vrf
);
261 listnode_add_sort(bgp_vrf
->l2vnis
, vpn
);
263 /* check if we are advertising two labels for this vpn */
264 if (!CHECK_FLAG(bgp_vrf
->vrf_flags
, BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY
))
265 SET_FLAG(vpn
->flags
, VNI_FLAG_USE_TWO_LABELS
);
268 static inline int is_vni_configured(struct bgpevpn
*vpn
)
270 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_CFGD
));
273 static inline int is_vni_live(struct bgpevpn
*vpn
)
275 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_LIVE
));
278 static inline int is_l3vni_live(struct bgp
*bgp_vrf
)
280 return (bgp_vrf
->l3vni
&& bgp_vrf
->l3vni_svi_ifindex
);
283 static inline int is_rd_configured(struct bgpevpn
*vpn
)
285 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_RD_CFGD
));
288 static inline int bgp_evpn_rd_matches_existing(struct bgpevpn
*vpn
,
289 struct prefix_rd
*prd
)
291 return (memcmp(&vpn
->prd
.val
, prd
->val
, ECOMMUNITY_SIZE
) == 0);
294 static inline int is_import_rt_configured(struct bgpevpn
*vpn
)
296 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_IMPRT_CFGD
));
299 static inline int is_export_rt_configured(struct bgpevpn
*vpn
)
301 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_EXPRT_CFGD
));
304 static inline int is_vni_param_configured(struct bgpevpn
*vpn
)
306 return (is_rd_configured(vpn
) || is_import_rt_configured(vpn
)
307 || is_export_rt_configured(vpn
));
310 static inline void encode_es_rt_extcomm(struct ecommunity_val
*eval
,
313 memset(eval
, 0, sizeof(struct ecommunity_val
));
314 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
315 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT
;
316 memcpy(&eval
->val
[2], mac
, ETH_ALEN
);
319 static inline void encode_rmac_extcomm(struct ecommunity_val
*eval
,
320 struct ethaddr
*rmac
)
322 memset(eval
, 0, sizeof(*eval
));
323 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
324 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC
;
325 memcpy(&eval
->val
[2], rmac
, ETH_ALEN
);
328 static inline void encode_default_gw_extcomm(struct ecommunity_val
*eval
)
330 memset(eval
, 0, sizeof(*eval
));
331 eval
->val
[0] = ECOMMUNITY_ENCODE_OPAQUE
;
332 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_DEF_GW
;
335 static inline void encode_mac_mobility_extcomm(int static_mac
, uint32_t seq
,
336 struct ecommunity_val
*eval
)
338 memset(eval
, 0, sizeof(*eval
));
339 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
340 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY
;
342 eval
->val
[2] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY_FLAG_STICKY
;
343 eval
->val
[4] = (seq
>> 24) & 0xff;
344 eval
->val
[5] = (seq
>> 16) & 0xff;
345 eval
->val
[6] = (seq
>> 8) & 0xff;
346 eval
->val
[7] = seq
& 0xff;
349 static inline void encode_na_flag_extcomm(struct ecommunity_val
*eval
,
352 memset(eval
, 0, sizeof(*eval
));
353 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
354 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ND
;
356 eval
->val
[2] |= ECOMMUNITY_EVPN_SUBTYPE_ND_ROUTER_FLAG
;
359 static inline void ip_prefix_from_type5_prefix(struct prefix_evpn
*evp
,
362 memset(ip
, 0, sizeof(struct prefix
));
363 if (is_evpn_prefix_ipaddr_v4(evp
)) {
364 ip
->family
= AF_INET
;
365 ip
->prefixlen
= evp
->prefix
.prefix_addr
.ip_prefix_length
;
366 memcpy(&(ip
->u
.prefix4
), &(evp
->prefix
.prefix_addr
.ip
.ip
),
368 } else if (is_evpn_prefix_ipaddr_v6(evp
)) {
369 ip
->family
= AF_INET6
;
370 ip
->prefixlen
= evp
->prefix
.prefix_addr
.ip_prefix_length
;
371 memcpy(&(ip
->u
.prefix6
), &(evp
->prefix
.prefix_addr
.ip
.ip
),
376 static inline int is_evpn_prefix_default(const struct prefix
*evp
)
378 if (evp
->family
!= AF_EVPN
)
381 return ((evp
->u
.prefix_evpn
.prefix_addr
.ip_prefix_length
== 0) ?
385 static inline void ip_prefix_from_type2_prefix(struct prefix_evpn
*evp
,
388 memset(ip
, 0, sizeof(struct prefix
));
389 if (is_evpn_prefix_ipaddr_v4(evp
)) {
390 ip
->family
= AF_INET
;
391 ip
->prefixlen
= IPV4_MAX_BITLEN
;
392 memcpy(&(ip
->u
.prefix4
), &(evp
->prefix
.macip_addr
.ip
.ip
),
394 } else if (is_evpn_prefix_ipaddr_v6(evp
)) {
395 ip
->family
= AF_INET6
;
396 ip
->prefixlen
= IPV6_MAX_BITLEN
;
397 memcpy(&(ip
->u
.prefix6
), &(evp
->prefix
.macip_addr
.ip
.ip
),
402 static inline void ip_prefix_from_evpn_prefix(struct prefix_evpn
*evp
,
405 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
406 ip_prefix_from_type2_prefix(evp
, ip
);
407 else if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
408 ip_prefix_from_type5_prefix(evp
, ip
);
411 static inline void build_evpn_type2_prefix(struct prefix_evpn
*p
,
415 memset(p
, 0, sizeof(struct prefix_evpn
));
417 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
418 p
->prefix
.route_type
= BGP_EVPN_MAC_IP_ROUTE
;
419 memcpy(&p
->prefix
.macip_addr
.mac
.octet
, mac
->octet
, ETH_ALEN
);
420 p
->prefix
.macip_addr
.ip
.ipa_type
= IPADDR_NONE
;
422 memcpy(&p
->prefix
.macip_addr
.ip
, ip
, sizeof(*ip
));
425 static inline void build_type5_prefix_from_ip_prefix(struct prefix_evpn
*evp
,
426 struct prefix
*ip_prefix
)
430 memset(&ip
, 0, sizeof(struct ipaddr
));
431 if (ip_prefix
->family
== AF_INET
) {
432 ip
.ipa_type
= IPADDR_V4
;
433 memcpy(&ip
.ipaddr_v4
, &ip_prefix
->u
.prefix4
,
434 sizeof(struct in_addr
));
436 ip
.ipa_type
= IPADDR_V6
;
437 memcpy(&ip
.ipaddr_v6
, &ip_prefix
->u
.prefix6
,
438 sizeof(struct in6_addr
));
441 memset(evp
, 0, sizeof(struct prefix_evpn
));
442 evp
->family
= AF_EVPN
;
443 evp
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
444 evp
->prefix
.route_type
= BGP_EVPN_IP_PREFIX_ROUTE
;
445 evp
->prefix
.prefix_addr
.ip_prefix_length
= ip_prefix
->prefixlen
;
446 evp
->prefix
.prefix_addr
.ip
.ipa_type
= ip
.ipa_type
;
447 memcpy(&evp
->prefix
.prefix_addr
.ip
, &ip
, sizeof(struct ipaddr
));
450 static inline void build_evpn_type3_prefix(struct prefix_evpn
*p
,
451 struct in_addr originator_ip
)
453 memset(p
, 0, sizeof(struct prefix_evpn
));
455 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
456 p
->prefix
.route_type
= BGP_EVPN_IMET_ROUTE
;
457 p
->prefix
.imet_addr
.ip
.ipa_type
= IPADDR_V4
;
458 p
->prefix
.imet_addr
.ip
.ipaddr_v4
= originator_ip
;
461 static inline void build_evpn_type4_prefix(struct prefix_evpn
*p
,
463 struct in_addr originator_ip
)
465 memset(p
, 0, sizeof(struct prefix_evpn
));
467 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
468 p
->prefix
.route_type
= BGP_EVPN_ES_ROUTE
;
469 p
->prefix
.es_addr
.ip_prefix_length
= IPV4_MAX_BITLEN
;
470 p
->prefix
.es_addr
.ip
.ipa_type
= IPADDR_V4
;
471 p
->prefix
.es_addr
.ip
.ipaddr_v4
= originator_ip
;
472 memcpy(&p
->prefix
.es_addr
.esi
, esi
, sizeof(esi_t
));
475 static inline int evpn_default_originate_set(struct bgp
*bgp
, afi_t afi
,
479 CHECK_FLAG(bgp
->af_flags
[AFI_L2VPN
][SAFI_EVPN
],
480 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4
))
482 else if (afi
== AFI_IP6
&&
483 CHECK_FLAG(bgp
->af_flags
[AFI_L2VPN
][SAFI_EVPN
],
484 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6
))
489 static inline void es_get_system_mac(esi_t
*esi
,
493 * for type-1 and type-3 ESIs,
494 * the system mac starts at val[1]
496 memcpy(mac
, &esi
->val
[1], ETH_ALEN
);
499 static inline int is_es_local(struct evpnes
*es
)
501 return CHECK_FLAG(es
->flags
, EVPNES_LOCAL
) ? 1 : 0;
504 extern void bgp_evpn_install_uninstall_default_route(struct bgp
*bgp_vrf
,
505 afi_t afi
, safi_t safi
,
507 extern void evpn_rt_delete_auto(struct bgp
*, vni_t
, struct list
*);
508 extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp
*bgp_vrf
,
509 struct ecommunity
*ecomadd
);
510 extern void bgp_evpn_unconfigure_export_rt_for_vrf(struct bgp
*bgp_vrf
,
511 struct ecommunity
*ecomdel
);
512 extern void bgp_evpn_configure_import_rt_for_vrf(struct bgp
*bgp_vrf
,
513 struct ecommunity
*ecomadd
);
514 extern void bgp_evpn_unconfigure_import_rt_for_vrf(struct bgp
*bgp_vrf
,
515 struct ecommunity
*ecomdel
);
516 extern int bgp_evpn_handle_export_rt_change(struct bgp
*bgp
,
517 struct bgpevpn
*vpn
);
518 extern void bgp_evpn_handle_autort_change(struct bgp
*bgp
);
519 extern void bgp_evpn_handle_vrf_rd_change(struct bgp
*bgp_vrf
, int withdraw
);
520 extern void bgp_evpn_handle_rd_change(struct bgp
*bgp
, struct bgpevpn
*vpn
,
522 extern int bgp_evpn_install_routes(struct bgp
*bgp
, struct bgpevpn
*vpn
);
523 extern int bgp_evpn_uninstall_routes(struct bgp
*bgp
, struct bgpevpn
*vpn
);
524 extern void bgp_evpn_map_vrf_to_its_rts(struct bgp
*bgp_vrf
);
525 extern void bgp_evpn_unmap_vrf_from_its_rts(struct bgp
*bgp_vrf
);
526 extern void bgp_evpn_map_vni_to_its_rts(struct bgp
*bgp
, struct bgpevpn
*vpn
);
527 extern void bgp_evpn_unmap_vni_from_its_rts(struct bgp
*bgp
,
528 struct bgpevpn
*vpn
);
529 extern void bgp_evpn_derive_auto_rt_import(struct bgp
*bgp
,
530 struct bgpevpn
*vpn
);
531 extern void bgp_evpn_derive_auto_rt_export(struct bgp
*bgp
,
532 struct bgpevpn
*vpn
);
533 extern void bgp_evpn_derive_auto_rd(struct bgp
*bgp
, struct bgpevpn
*vpn
);
534 extern void bgp_evpn_derive_auto_rd_for_vrf(struct bgp
*bgp
);
535 extern struct bgpevpn
*bgp_evpn_lookup_vni(struct bgp
*bgp
, vni_t vni
);
536 extern struct bgpevpn
*bgp_evpn_new(struct bgp
*bgp
, vni_t vni
,
537 struct in_addr originator_ip
,
538 vrf_id_t tenant_vrf_id
,
539 struct in_addr mcast_grp
);
540 extern void bgp_evpn_free(struct bgp
*bgp
, struct bgpevpn
*vpn
);
541 extern struct evpnes
*bgp_evpn_lookup_es(struct bgp
*bgp
, esi_t
*esi
);
542 extern struct evpnes
*bgp_evpn_es_new(struct bgp
*bgp
, esi_t
*esi
,
543 struct ipaddr
*originator_ip
);
544 extern void bgp_evpn_es_free(struct bgp
*bgp
, struct evpnes
*es
);
545 extern bool bgp_evpn_lookup_l3vni_l2vni_table(vni_t vni
);
546 #endif /* _BGP_EVPN_PRIVATE_H */