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 reprsent the sizeof struct prefix_evpn */
34 #define EVPN_ROUTE_PREFIXLEN 224
36 /* EVPN route types. */
38 BGP_EVPN_AD_ROUTE
= 1, /* Ethernet Auto-Discovery (A-D) route */
39 BGP_EVPN_MAC_IP_ROUTE
, /* MAC/IP Advertisement route */
40 BGP_EVPN_IMET_ROUTE
, /* Inclusive Multicast Ethernet Tag route */
41 BGP_EVPN_ES_ROUTE
, /* Ethernet Segment route */
42 BGP_EVPN_IP_PREFIX_ROUTE
, /* IP Prefix route */
43 } bgp_evpn_route_type
;
46 * Hash table of EVIs. Right now, the only type of EVI supported is with
47 * VxLAN encapsulation, hence each EVI corresponds to a L2 VNI.
48 * The VNIs are not "created" through BGP but through some other interface
49 * on the system. This table stores VNIs that BGP comes to know as present
50 * on the system (through interaction with zebra) as well as pre-configured
51 * VNIs (which need to be defined in the system to become "live").
55 vrf_id_t tenant_vrf_id
;
57 #define VNI_FLAG_CFGD 0x1 /* VNI is user configured */
58 #define VNI_FLAG_LIVE 0x2 /* VNI is "live" */
59 #define VNI_FLAG_RD_CFGD 0x4 /* RD is user configured. */
60 #define VNI_FLAG_IMPRT_CFGD 0x8 /* Import RT is user configured */
61 #define VNI_FLAG_EXPRT_CFGD 0x10 /* Export RT is user configured */
62 #define VNI_FLAG_USE_TWO_LABELS 0x20 /* Attach both L2-VNI and L3-VNI if
63 needed for this VPN */
65 struct bgp
*bgp_vrf
; /* back pointer to the vrf instance */
67 /* Flag to indicate if we are
68 * advertising the g/w mac ip for
70 uint8_t advertise_gw_macip
;
72 /* Flag to indicate if we are
73 * advertising subnet for this VNI */
74 uint8_t advertise_subnet
;
76 /* Id for deriving the RD
77 * automatically for this VNI */
80 /* RD for this VNI. */
83 /* Route type 3 field */
84 struct in_addr originator_ip
;
86 /* Import and Export RTs. */
87 struct list
*import_rtl
;
88 struct list
*export_rtl
;
90 /* Route table for EVPN routes for
92 struct bgp_table
*route_table
;
97 DECLARE_QOBJ_TYPE(bgpevpn
)
101 /* Ethernet Segment Identifier */
106 #define EVPNES_LOCAL 0x01
107 #define EVPNES_REMOTE 0x02
110 * Id for deriving the RD
111 * automatically for this ESI
115 /* RD for this VNI. */
116 struct prefix_rd prd
;
118 /* originator ip address */
119 struct ipaddr originator_ip
;
121 /* list of VTEPs in the same site */
122 struct list
*vtep_list
;
125 * Route table for EVPN routes for
126 * this ESI. - type4 routes
128 struct bgp_table
*route_table
;
133 DECLARE_QOBJ_TYPE(evpnes
)
135 /* Mapping of Import RT to VNIs.
136 * The Import RTs of all VNIs are maintained in a hash table with each
137 * RT linking to all VNIs that will import routes matching this RT.
141 struct ecommunity_val rt
;
143 /* List of VNIs importing routes matching this RT. */
147 /* Mapping of Import RT to VRFs.
148 * The Import RTs of all VRFss are maintained in a hash table with each
149 * RT linking to all VRFs that will import routes matching this RT.
151 struct vrf_irt_node
{
153 struct ecommunity_val rt
;
155 /* List of VNIs importing routes matching this RT. */
160 #define RT_TYPE_IMPORT 1
161 #define RT_TYPE_EXPORT 2
162 #define RT_TYPE_BOTH 3
164 static inline int is_vrf_rd_configured(struct bgp
*bgp_vrf
)
166 return (CHECK_FLAG(bgp_vrf
->vrf_flags
, BGP_VRF_RD_CFGD
));
169 static inline int bgp_evpn_vrf_rd_matches_existing(struct bgp
*bgp_vrf
,
170 struct prefix_rd
*prd
)
172 return (memcmp(&bgp_vrf
->vrf_prd
.val
, prd
->val
, ECOMMUNITY_SIZE
) == 0);
175 static inline vni_t
bgpevpn_get_l3vni(struct bgpevpn
*vpn
)
177 return vpn
->bgp_vrf
? vpn
->bgp_vrf
->l3vni
: 0;
180 static inline void bgpevpn_get_rmac(struct bgpevpn
*vpn
, struct ethaddr
*rmac
)
182 memset(rmac
, 0, sizeof(struct ethaddr
));
185 memcpy(rmac
, &vpn
->bgp_vrf
->rmac
, sizeof(struct ethaddr
));
188 static inline struct list
*bgpevpn_get_vrf_export_rtl(struct bgpevpn
*vpn
)
193 return vpn
->bgp_vrf
->vrf_export_rtl
;
196 static inline struct list
*bgpevpn_get_vrf_import_rtl(struct bgpevpn
*vpn
)
201 return vpn
->bgp_vrf
->vrf_import_rtl
;
204 static inline void bgpevpn_unlink_from_l3vni(struct bgpevpn
*vpn
)
206 /* bail if vpn is not associated to bgp_vrf */
210 UNSET_FLAG(vpn
->flags
, VNI_FLAG_USE_TWO_LABELS
);
211 listnode_delete(vpn
->bgp_vrf
->l2vnis
, vpn
);
213 /* remove the backpointer to the vrf instance */
217 static inline void bgpevpn_link_to_l3vni(struct bgpevpn
*vpn
)
219 struct bgp
*bgp_vrf
= NULL
;
221 /* bail if vpn is already associated to vrf */
225 bgp_vrf
= bgp_lookup_by_vrf_id(vpn
->tenant_vrf_id
);
229 /* associate the vpn to the bgp_vrf instance */
230 vpn
->bgp_vrf
= bgp_vrf
;
231 listnode_add_sort(bgp_vrf
->l2vnis
, vpn
);
233 /* check if we are advertising two labels for this vpn */
234 if (!CHECK_FLAG(bgp_vrf
->vrf_flags
, BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY
))
235 SET_FLAG(vpn
->flags
, VNI_FLAG_USE_TWO_LABELS
);
238 static inline int is_vni_configured(struct bgpevpn
*vpn
)
240 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_CFGD
));
243 static inline int is_vni_live(struct bgpevpn
*vpn
)
245 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_LIVE
));
248 static inline int is_rd_configured(struct bgpevpn
*vpn
)
250 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_RD_CFGD
));
253 static inline int bgp_evpn_rd_matches_existing(struct bgpevpn
*vpn
,
254 struct prefix_rd
*prd
)
256 return (memcmp(&vpn
->prd
.val
, prd
->val
, ECOMMUNITY_SIZE
) == 0);
259 static inline int is_import_rt_configured(struct bgpevpn
*vpn
)
261 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_IMPRT_CFGD
));
264 static inline int is_export_rt_configured(struct bgpevpn
*vpn
)
266 return (CHECK_FLAG(vpn
->flags
, VNI_FLAG_EXPRT_CFGD
));
269 static inline int is_vni_param_configured(struct bgpevpn
*vpn
)
271 return (is_rd_configured(vpn
) || is_import_rt_configured(vpn
)
272 || is_export_rt_configured(vpn
));
275 static inline void encode_es_rt_extcomm(struct ecommunity_val
*eval
,
278 memset(eval
, 0, sizeof(struct ecommunity_val
));
279 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
280 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT
;
281 memcpy(&eval
->val
[2], mac
, ETH_ALEN
);
284 static inline void encode_rmac_extcomm(struct ecommunity_val
*eval
,
285 struct ethaddr
*rmac
)
287 memset(eval
, 0, sizeof(*eval
));
288 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
289 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC
;
290 memcpy(&eval
->val
[2], rmac
, ETH_ALEN
);
293 static inline void encode_default_gw_extcomm(struct ecommunity_val
*eval
)
295 memset(eval
, 0, sizeof(*eval
));
296 eval
->val
[0] = ECOMMUNITY_ENCODE_OPAQUE
;
297 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_DEF_GW
;
300 static inline void encode_mac_mobility_extcomm(int static_mac
, uint32_t seq
,
301 struct ecommunity_val
*eval
)
303 memset(eval
, 0, sizeof(*eval
));
304 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
305 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY
;
307 eval
->val
[2] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY_FLAG_STICKY
;
308 eval
->val
[4] = (seq
>> 24) & 0xff;
309 eval
->val
[5] = (seq
>> 16) & 0xff;
310 eval
->val
[6] = (seq
>> 8) & 0xff;
311 eval
->val
[7] = seq
& 0xff;
314 static inline void encode_na_flag_extcomm(struct ecommunity_val
*eval
,
317 memset(eval
, 0, sizeof(*eval
));
318 eval
->val
[0] = ECOMMUNITY_ENCODE_EVPN
;
319 eval
->val
[1] = ECOMMUNITY_EVPN_SUBTYPE_ND
;
321 eval
->val
[2] |= ECOMMUNITY_EVPN_SUBTYPE_ND_ROUTER_FLAG
;
324 static inline void ip_prefix_from_type5_prefix(struct prefix_evpn
*evp
,
327 memset(ip
, 0, sizeof(struct prefix
));
328 if (is_evpn_prefix_ipaddr_v4(evp
)) {
329 ip
->family
= AF_INET
;
330 ip
->prefixlen
= evp
->prefix
.prefix_addr
.ip_prefix_length
;
331 memcpy(&(ip
->u
.prefix4
), &(evp
->prefix
.prefix_addr
.ip
.ip
),
333 } else if (is_evpn_prefix_ipaddr_v6(evp
)) {
334 ip
->family
= AF_INET6
;
335 ip
->prefixlen
= evp
->prefix
.prefix_addr
.ip_prefix_length
;
336 memcpy(&(ip
->u
.prefix6
), &(evp
->prefix
.prefix_addr
.ip
.ip
),
341 static inline int is_evpn_prefix_default(const struct prefix
*evp
)
343 if (evp
->family
!= AF_EVPN
)
346 return ((evp
->u
.prefix_evpn
.prefix_addr
.ip_prefix_length
== 0) ?
350 static inline void ip_prefix_from_type2_prefix(struct prefix_evpn
*evp
,
353 memset(ip
, 0, sizeof(struct prefix
));
354 if (is_evpn_prefix_ipaddr_v4(evp
)) {
355 ip
->family
= AF_INET
;
356 ip
->prefixlen
= IPV4_MAX_BITLEN
;
357 memcpy(&(ip
->u
.prefix4
), &(evp
->prefix
.macip_addr
.ip
.ip
),
359 } else if (is_evpn_prefix_ipaddr_v6(evp
)) {
360 ip
->family
= AF_INET6
;
361 ip
->prefixlen
= IPV6_MAX_BITLEN
;
362 memcpy(&(ip
->u
.prefix6
), &(evp
->prefix
.macip_addr
.ip
.ip
),
367 static inline void ip_prefix_from_evpn_prefix(struct prefix_evpn
*evp
,
370 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
371 ip_prefix_from_type2_prefix(evp
, ip
);
372 else if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
373 ip_prefix_from_type5_prefix(evp
, ip
);
376 static inline void build_evpn_type2_prefix(struct prefix_evpn
*p
,
380 memset(p
, 0, sizeof(struct prefix_evpn
));
382 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
383 p
->prefix
.route_type
= BGP_EVPN_MAC_IP_ROUTE
;
384 memcpy(&p
->prefix
.macip_addr
.mac
.octet
, mac
->octet
, ETH_ALEN
);
385 p
->prefix
.macip_addr
.ip
.ipa_type
= IPADDR_NONE
;
387 memcpy(&p
->prefix
.macip_addr
.ip
, ip
, sizeof(*ip
));
390 static inline void build_type5_prefix_from_ip_prefix(struct prefix_evpn
*evp
,
391 struct prefix
*ip_prefix
)
395 memset(&ip
, 0, sizeof(struct ipaddr
));
396 if (ip_prefix
->family
== AF_INET
) {
397 ip
.ipa_type
= IPADDR_V4
;
398 memcpy(&ip
.ipaddr_v4
, &ip_prefix
->u
.prefix4
,
399 sizeof(struct in_addr
));
401 ip
.ipa_type
= IPADDR_V6
;
402 memcpy(&ip
.ipaddr_v6
, &ip_prefix
->u
.prefix6
,
403 sizeof(struct in6_addr
));
406 memset(evp
, 0, sizeof(struct prefix_evpn
));
407 evp
->family
= AF_EVPN
;
408 evp
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
409 evp
->prefix
.route_type
= BGP_EVPN_IP_PREFIX_ROUTE
;
410 evp
->prefix
.prefix_addr
.ip_prefix_length
= ip_prefix
->prefixlen
;
411 evp
->prefix
.prefix_addr
.ip
.ipa_type
= ip
.ipa_type
;
412 memcpy(&evp
->prefix
.prefix_addr
.ip
, &ip
, sizeof(struct ipaddr
));
415 static inline void build_evpn_type3_prefix(struct prefix_evpn
*p
,
416 struct in_addr originator_ip
)
418 memset(p
, 0, sizeof(struct prefix_evpn
));
420 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
421 p
->prefix
.route_type
= BGP_EVPN_IMET_ROUTE
;
422 p
->prefix
.imet_addr
.ip
.ipa_type
= IPADDR_V4
;
423 p
->prefix
.imet_addr
.ip
.ipaddr_v4
= originator_ip
;
426 static inline void build_evpn_type4_prefix(struct prefix_evpn
*p
,
428 struct in_addr originator_ip
)
430 memset(p
, 0, sizeof(struct prefix_evpn
));
432 p
->prefixlen
= EVPN_ROUTE_PREFIXLEN
;
433 p
->prefix
.route_type
= BGP_EVPN_ES_ROUTE
;
434 p
->prefix
.es_addr
.ip_prefix_length
= IPV4_MAX_BITLEN
;
435 p
->prefix
.es_addr
.ip
.ipa_type
= IPADDR_V4
;
436 p
->prefix
.es_addr
.ip
.ipaddr_v4
= originator_ip
;
437 memcpy(&p
->prefix
.es_addr
.esi
, esi
, sizeof(esi_t
));
440 static inline int evpn_default_originate_set(struct bgp
*bgp
, afi_t afi
,
444 CHECK_FLAG(bgp
->af_flags
[AFI_L2VPN
][SAFI_EVPN
],
445 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4
))
447 else if (afi
== AFI_IP6
&&
448 CHECK_FLAG(bgp
->af_flags
[AFI_L2VPN
][SAFI_EVPN
],
449 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6
))
454 static inline void es_get_system_mac(esi_t
*esi
,
458 * for type-1 and type-3 ESIs,
459 * the system mac starts at val[1]
461 memcpy(mac
, &esi
->val
[1], ETH_ALEN
);
464 static inline int is_es_local(struct evpnes
*es
)
466 return CHECK_FLAG(es
->flags
, EVPNES_LOCAL
) ? 1 : 0;
469 extern void evpn_rt_delete_auto(struct bgp
*, vni_t
, struct list
*);
470 extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp
*bgp_vrf
,
471 struct ecommunity
*ecomadd
);
472 extern void bgp_evpn_unconfigure_export_rt_for_vrf(struct bgp
*bgp_vrf
,
473 struct ecommunity
*ecomdel
);
474 extern void bgp_evpn_configure_import_rt_for_vrf(struct bgp
*bgp_vrf
,
475 struct ecommunity
*ecomadd
);
476 extern void bgp_evpn_unconfigure_import_rt_for_vrf(struct bgp
*bgp_vrf
,
477 struct ecommunity
*ecomdel
);
478 extern int bgp_evpn_handle_export_rt_change(struct bgp
*bgp
,
479 struct bgpevpn
*vpn
);
480 extern void bgp_evpn_handle_autort_change(struct bgp
*bgp
);
481 extern void bgp_evpn_handle_vrf_rd_change(struct bgp
*bgp_vrf
, int withdraw
);
482 extern void bgp_evpn_handle_rd_change(struct bgp
*bgp
, struct bgpevpn
*vpn
,
484 extern int bgp_evpn_install_routes(struct bgp
*bgp
, struct bgpevpn
*vpn
);
485 extern int bgp_evpn_uninstall_routes(struct bgp
*bgp
, struct bgpevpn
*vpn
);
486 extern void bgp_evpn_map_vrf_to_its_rts(struct bgp
*bgp_vrf
);
487 extern void bgp_evpn_unmap_vrf_from_its_rts(struct bgp
*bgp_vrf
);
488 extern void bgp_evpn_map_vni_to_its_rts(struct bgp
*bgp
, struct bgpevpn
*vpn
);
489 extern void bgp_evpn_unmap_vni_from_its_rts(struct bgp
*bgp
,
490 struct bgpevpn
*vpn
);
491 extern void bgp_evpn_derive_auto_rt_import(struct bgp
*bgp
,
492 struct bgpevpn
*vpn
);
493 extern void bgp_evpn_derive_auto_rt_export(struct bgp
*bgp
,
494 struct bgpevpn
*vpn
);
495 extern void bgp_evpn_derive_auto_rd(struct bgp
*bgp
, struct bgpevpn
*vpn
);
496 extern void bgp_evpn_derive_auto_rd_for_vrf(struct bgp
*bgp
);
497 extern struct bgpevpn
*bgp_evpn_lookup_vni(struct bgp
*bgp
, vni_t vni
);
498 extern struct bgpevpn
*bgp_evpn_new(struct bgp
*bgp
, vni_t vni
,
499 struct in_addr originator_ip
,
500 vrf_id_t tenant_vrf_id
);
501 extern void bgp_evpn_free(struct bgp
*bgp
, struct bgpevpn
*vpn
);
502 extern struct evpnes
*bgp_evpn_lookup_es(struct bgp
*bgp
, esi_t
*esi
);
503 extern struct evpnes
*bgp_evpn_es_new(struct bgp
*bgp
, esi_t
*esi
,
504 struct ipaddr
*originator_ip
);
505 extern void bgp_evpn_es_free(struct bgp
*bgp
, struct evpnes
*es
);
506 extern bool bgp_evpn_lookup_l3vni_l2vni_table(vni_t vni
);
507 #endif /* _BGP_EVPN_PRIVATE_H */