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 /* Import and Export RTs. */
91 struct list
*import_rtl
;
92 struct list
*export_rtl
;
94 /* Route table for EVPN routes for
96 struct bgp_table
*route_table
;
101 DECLARE_QOBJ_TYPE(bgpevpn
)
105 /* Ethernet Segment Identifier */
110 #define EVPNES_LOCAL 0x01
111 #define EVPNES_REMOTE 0x02
114 * Id for deriving the RD
115 * automatically for this ESI
119 /* RD for this VNI. */
120 struct prefix_rd prd
;
122 /* originator ip address */
123 struct ipaddr originator_ip
;
125 /* list of VTEPs in the same site */
126 struct list
*vtep_list
;
129 * Route table for EVPN routes for
130 * this ESI. - type4 routes
132 struct bgp_table
*route_table
;
137 DECLARE_QOBJ_TYPE(evpnes
)
139 /* Mapping of Import RT to VNIs.
140 * The Import RTs of all VNIs are maintained in a hash table with each
141 * RT linking to all VNIs that will import routes matching this RT.
145 struct ecommunity_val rt
;
147 /* List of VNIs importing routes matching this RT. */
151 /* Mapping of Import RT to VRFs.
152 * The Import RTs of all VRFss are maintained in a hash table with each
153 * RT linking to all VRFs that will import routes matching this RT.
155 struct vrf_irt_node
{
157 struct ecommunity_val rt
;
159 /* List of VNIs importing routes matching this RT. */
164 #define RT_TYPE_IMPORT 1
165 #define RT_TYPE_EXPORT 2
166 #define RT_TYPE_BOTH 3
168 #define EVPN_DAD_DEFAULT_TIME 180 /* secs */
169 #define EVPN_DAD_DEFAULT_MAX_MOVES 5 /* default from RFC 7432 */
170 #define EVPN_DAD_DEFAULT_AUTO_RECOVERY_TIME 1800 /* secs */
172 struct bgp_evpn_info
{
173 /* enable disable dup detect */
174 bool dup_addr_detect
;
176 /* Detection time(M) */
178 /* Detection max moves(N) */
179 uint32_t dad_max_moves
;
180 /* Permanent freeze */
183 uint32_t dad_freeze_time
;
185 /* EVPN enable - advertise svi macip routes */
186 int advertise_svi_macip
;
190 static inline int is_vrf_rd_configured(struct bgp
*bgp_vrf
)
192 return (CHECK_FLAG(bgp_vrf
->vrf_flags
, BGP_VRF_RD_CFGD
));
195 static inline int bgp_evpn_vrf_rd_matches_existing(struct bgp
*bgp_vrf
,
196 struct prefix_rd
*prd
)
198 return (memcmp(&bgp_vrf
->vrf_prd
.val
, prd
->val
, ECOMMUNITY_SIZE
) == 0);
201 static inline vni_t
bgpevpn_get_l3vni(struct bgpevpn
*vpn
)
203 return vpn
->bgp_vrf
? vpn
->bgp_vrf
->l3vni
: 0;
206 static inline void bgpevpn_get_rmac(struct bgpevpn
*vpn
, struct ethaddr
*rmac
)
208 memset(rmac
, 0, sizeof(struct ethaddr
));
211 memcpy(rmac
, &vpn
->bgp_vrf
->rmac
, sizeof(struct ethaddr
));
214 static inline struct list
*bgpevpn_get_vrf_export_rtl(struct bgpevpn
*vpn
)
219 return vpn
->bgp_vrf
->vrf_export_rtl
;
222 static inline struct list
*bgpevpn_get_vrf_import_rtl(struct bgpevpn
*vpn
)
227 return vpn
->bgp_vrf
->vrf_import_rtl
;
230 static inline void bgpevpn_unlink_from_l3vni(struct bgpevpn
*vpn
)
232 /* bail if vpn is not associated to bgp_vrf */
236 UNSET_FLAG(vpn
->flags
, VNI_FLAG_USE_TWO_LABELS
);
237 listnode_delete(vpn
->bgp_vrf
->l2vnis
, vpn
);
239 /* remove the backpointer to the vrf instance */
240 bgp_unlock(vpn
->bgp_vrf
);
244 static inline void bgpevpn_link_to_l3vni(struct bgpevpn
*vpn
)
246 struct bgp
*bgp_vrf
= NULL
;
248 /* bail if vpn is already associated to vrf */
252 bgp_vrf
= bgp_lookup_by_vrf_id(vpn
->tenant_vrf_id
);
256 /* associate the vpn to the bgp_vrf instance */
257 vpn
->bgp_vrf
= bgp_lock(bgp_vrf
);
258 listnode_add_sort(bgp_vrf
->l2vnis
, vpn
);
260 /* check if we are advertising two labels for this vpn */
261 if (!CHECK_FLAG(bgp_vrf
->vrf_flags
, BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY
))
262 SET_FLAG(vpn
->flags
, VNI_FLAG_USE_TWO_LABELS
);
265 static inline int is_vni_configured(struct bgpevpn
*vpn
)
267 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_CFGD
));
270 static inline int is_vni_live(struct bgpevpn
*vpn
)
272 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_LIVE
));
275 static inline int is_rd_configured(struct bgpevpn
*vpn
)
277 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_RD_CFGD
));
280 static inline int bgp_evpn_rd_matches_existing(struct bgpevpn
*vpn
,
281 struct prefix_rd
*prd
)
283 return (memcmp(&vpn
->prd
.val
, prd
->val
, ECOMMUNITY_SIZE
) == 0);
286 static inline int is_import_rt_configured(struct bgpevpn
*vpn
)
288 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_IMPRT_CFGD
));
291 static inline int is_export_rt_configured(struct bgpevpn
*vpn
)
293 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_EXPRT_CFGD
));
296 static inline int is_vni_param_configured(struct bgpevpn
*vpn
)
298 return (is_rd_configured(vpn
) || is_import_rt_configured(vpn
)
299 || is_export_rt_configured(vpn
));
302 static inline void encode_es_rt_extcomm(struct ecommunity_val
*eval
,
305 memset(eval
, 0, sizeof(struct ecommunity_val
));
306 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
307 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT
;
308 memcpy(&eval
->val
[2], mac
, ETH_ALEN
);
311 static inline void encode_rmac_extcomm(struct ecommunity_val
*eval
,
312 struct ethaddr
*rmac
)
314 memset(eval
, 0, sizeof(*eval
));
315 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
316 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC
;
317 memcpy(&eval
->val
[2], rmac
, ETH_ALEN
);
320 static inline void encode_default_gw_extcomm(struct ecommunity_val
*eval
)
322 memset(eval
, 0, sizeof(*eval
));
323 eval
->val
[0] = ECOMMUNITY_ENCODE_OPAQUE
;
324 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_DEF_GW
;
327 static inline void encode_mac_mobility_extcomm(int static_mac
, uint32_t seq
,
328 struct ecommunity_val
*eval
)
330 memset(eval
, 0, sizeof(*eval
));
331 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
332 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY
;
334 eval
->val
[2] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY_FLAG_STICKY
;
335 eval
->val
[4] = (seq
>> 24) & 0xff;
336 eval
->val
[5] = (seq
>> 16) & 0xff;
337 eval
->val
[6] = (seq
>> 8) & 0xff;
338 eval
->val
[7] = seq
& 0xff;
341 static inline void encode_na_flag_extcomm(struct ecommunity_val
*eval
,
344 memset(eval
, 0, sizeof(*eval
));
345 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
346 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ND
;
348 eval
->val
[2] |= ECOMMUNITY_EVPN_SUBTYPE_ND_ROUTER_FLAG
;
351 static inline void ip_prefix_from_type5_prefix(struct prefix_evpn
*evp
,
354 memset(ip
, 0, sizeof(struct prefix
));
355 if (is_evpn_prefix_ipaddr_v4(evp
)) {
356 ip
->family
= AF_INET
;
357 ip
->prefixlen
= evp
->prefix
.prefix_addr
.ip_prefix_length
;
358 memcpy(&(ip
->u
.prefix4
), &(evp
->prefix
.prefix_addr
.ip
.ip
),
360 } else if (is_evpn_prefix_ipaddr_v6(evp
)) {
361 ip
->family
= AF_INET6
;
362 ip
->prefixlen
= evp
->prefix
.prefix_addr
.ip_prefix_length
;
363 memcpy(&(ip
->u
.prefix6
), &(evp
->prefix
.prefix_addr
.ip
.ip
),
368 static inline int is_evpn_prefix_default(const struct prefix
*evp
)
370 if (evp
->family
!= AF_EVPN
)
373 return ((evp
->u
.prefix_evpn
.prefix_addr
.ip_prefix_length
== 0) ?
377 static inline void ip_prefix_from_type2_prefix(struct prefix_evpn
*evp
,
380 memset(ip
, 0, sizeof(struct prefix
));
381 if (is_evpn_prefix_ipaddr_v4(evp
)) {
382 ip
->family
= AF_INET
;
383 ip
->prefixlen
= IPV4_MAX_BITLEN
;
384 memcpy(&(ip
->u
.prefix4
), &(evp
->prefix
.macip_addr
.ip
.ip
),
386 } else if (is_evpn_prefix_ipaddr_v6(evp
)) {
387 ip
->family
= AF_INET6
;
388 ip
->prefixlen
= IPV6_MAX_BITLEN
;
389 memcpy(&(ip
->u
.prefix6
), &(evp
->prefix
.macip_addr
.ip
.ip
),
394 static inline void ip_prefix_from_evpn_prefix(struct prefix_evpn
*evp
,
397 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
398 ip_prefix_from_type2_prefix(evp
, ip
);
399 else if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
400 ip_prefix_from_type5_prefix(evp
, ip
);
403 static inline void build_evpn_type2_prefix(struct prefix_evpn
*p
,
407 memset(p
, 0, sizeof(struct prefix_evpn
));
409 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
410 p
->prefix
.route_type
= BGP_EVPN_MAC_IP_ROUTE
;
411 memcpy(&p
->prefix
.macip_addr
.mac
.octet
, mac
->octet
, ETH_ALEN
);
412 p
->prefix
.macip_addr
.ip
.ipa_type
= IPADDR_NONE
;
414 memcpy(&p
->prefix
.macip_addr
.ip
, ip
, sizeof(*ip
));
417 static inline void build_type5_prefix_from_ip_prefix(struct prefix_evpn
*evp
,
418 struct prefix
*ip_prefix
)
422 memset(&ip
, 0, sizeof(struct ipaddr
));
423 if (ip_prefix
->family
== AF_INET
) {
424 ip
.ipa_type
= IPADDR_V4
;
425 memcpy(&ip
.ipaddr_v4
, &ip_prefix
->u
.prefix4
,
426 sizeof(struct in_addr
));
428 ip
.ipa_type
= IPADDR_V6
;
429 memcpy(&ip
.ipaddr_v6
, &ip_prefix
->u
.prefix6
,
430 sizeof(struct in6_addr
));
433 memset(evp
, 0, sizeof(struct prefix_evpn
));
434 evp
->family
= AF_EVPN
;
435 evp
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
436 evp
->prefix
.route_type
= BGP_EVPN_IP_PREFIX_ROUTE
;
437 evp
->prefix
.prefix_addr
.ip_prefix_length
= ip_prefix
->prefixlen
;
438 evp
->prefix
.prefix_addr
.ip
.ipa_type
= ip
.ipa_type
;
439 memcpy(&evp
->prefix
.prefix_addr
.ip
, &ip
, sizeof(struct ipaddr
));
442 static inline void build_evpn_type3_prefix(struct prefix_evpn
*p
,
443 struct in_addr originator_ip
)
445 memset(p
, 0, sizeof(struct prefix_evpn
));
447 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
448 p
->prefix
.route_type
= BGP_EVPN_IMET_ROUTE
;
449 p
->prefix
.imet_addr
.ip
.ipa_type
= IPADDR_V4
;
450 p
->prefix
.imet_addr
.ip
.ipaddr_v4
= originator_ip
;
453 static inline void build_evpn_type4_prefix(struct prefix_evpn
*p
,
455 struct in_addr originator_ip
)
457 memset(p
, 0, sizeof(struct prefix_evpn
));
459 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
460 p
->prefix
.route_type
= BGP_EVPN_ES_ROUTE
;
461 p
->prefix
.es_addr
.ip_prefix_length
= IPV4_MAX_BITLEN
;
462 p
->prefix
.es_addr
.ip
.ipa_type
= IPADDR_V4
;
463 p
->prefix
.es_addr
.ip
.ipaddr_v4
= originator_ip
;
464 memcpy(&p
->prefix
.es_addr
.esi
, esi
, sizeof(esi_t
));
467 static inline int evpn_default_originate_set(struct bgp
*bgp
, afi_t afi
,
471 CHECK_FLAG(bgp
->af_flags
[AFI_L2VPN
][SAFI_EVPN
],
472 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4
))
474 else if (afi
== AFI_IP6
&&
475 CHECK_FLAG(bgp
->af_flags
[AFI_L2VPN
][SAFI_EVPN
],
476 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6
))
481 static inline void es_get_system_mac(esi_t
*esi
,
485 * for type-1 and type-3 ESIs,
486 * the system mac starts at val[1]
488 memcpy(mac
, &esi
->val
[1], ETH_ALEN
);
491 static inline int is_es_local(struct evpnes
*es
)
493 return CHECK_FLAG(es
->flags
, EVPNES_LOCAL
) ? 1 : 0;
496 extern void bgp_evpn_install_uninstall_default_route(struct bgp
*bgp_vrf
,
497 afi_t afi
, safi_t safi
,
499 extern void evpn_rt_delete_auto(struct bgp
*, vni_t
, struct list
*);
500 extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp
*bgp_vrf
,
501 struct ecommunity
*ecomadd
);
502 extern void bgp_evpn_unconfigure_export_rt_for_vrf(struct bgp
*bgp_vrf
,
503 struct ecommunity
*ecomdel
);
504 extern void bgp_evpn_configure_import_rt_for_vrf(struct bgp
*bgp_vrf
,
505 struct ecommunity
*ecomadd
);
506 extern void bgp_evpn_unconfigure_import_rt_for_vrf(struct bgp
*bgp_vrf
,
507 struct ecommunity
*ecomdel
);
508 extern int bgp_evpn_handle_export_rt_change(struct bgp
*bgp
,
509 struct bgpevpn
*vpn
);
510 extern void bgp_evpn_handle_autort_change(struct bgp
*bgp
);
511 extern void bgp_evpn_handle_vrf_rd_change(struct bgp
*bgp_vrf
, int withdraw
);
512 extern void bgp_evpn_handle_rd_change(struct bgp
*bgp
, struct bgpevpn
*vpn
,
514 extern int bgp_evpn_install_routes(struct bgp
*bgp
, struct bgpevpn
*vpn
);
515 extern int bgp_evpn_uninstall_routes(struct bgp
*bgp
, struct bgpevpn
*vpn
);
516 extern void bgp_evpn_map_vrf_to_its_rts(struct bgp
*bgp_vrf
);
517 extern void bgp_evpn_unmap_vrf_from_its_rts(struct bgp
*bgp_vrf
);
518 extern void bgp_evpn_map_vni_to_its_rts(struct bgp
*bgp
, struct bgpevpn
*vpn
);
519 extern void bgp_evpn_unmap_vni_from_its_rts(struct bgp
*bgp
,
520 struct bgpevpn
*vpn
);
521 extern void bgp_evpn_derive_auto_rt_import(struct bgp
*bgp
,
522 struct bgpevpn
*vpn
);
523 extern void bgp_evpn_derive_auto_rt_export(struct bgp
*bgp
,
524 struct bgpevpn
*vpn
);
525 extern void bgp_evpn_derive_auto_rd(struct bgp
*bgp
, struct bgpevpn
*vpn
);
526 extern void bgp_evpn_derive_auto_rd_for_vrf(struct bgp
*bgp
);
527 extern struct bgpevpn
*bgp_evpn_lookup_vni(struct bgp
*bgp
, vni_t vni
);
528 extern struct bgpevpn
*bgp_evpn_new(struct bgp
*bgp
, vni_t vni
,
529 struct in_addr originator_ip
,
530 vrf_id_t tenant_vrf_id
);
531 extern void bgp_evpn_free(struct bgp
*bgp
, struct bgpevpn
*vpn
);
532 extern struct evpnes
*bgp_evpn_lookup_es(struct bgp
*bgp
, esi_t
*esi
);
533 extern struct evpnes
*bgp_evpn_es_new(struct bgp
*bgp
, esi_t
*esi
,
534 struct ipaddr
*originator_ip
);
535 extern void bgp_evpn_es_free(struct bgp
*bgp
, struct evpnes
*es
);
536 extern bool bgp_evpn_lookup_l3vni_l2vni_table(vni_t vni
);
537 #endif /* _BGP_EVPN_PRIVATE_H */