]> git.proxmox.com Git - mirror_frr.git/blob - bgpd/bgp_evpn_private.h
*: remove the configuration lock from all daemons
[mirror_frr.git] / bgpd / bgp_evpn_private.h
1 /* BGP EVPN internal definitions
2 * Copyright (C) 2017 Cumulus Networks, Inc.
3 *
4 * This file is part of FRR.
5 *
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
9 * later version.
10 *
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.
15 *
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
19 * 02111-1307, USA.
20 */
21
22 #ifndef _BGP_EVPN_PRIVATE_H
23 #define _BGP_EVPN_PRIVATE_H
24
25 #include "vxlan.h"
26 #include "zebra.h"
27
28 #include "bgpd/bgpd.h"
29 #include "bgpd/bgp_ecommunity.h"
30
31 #define RT_ADDRSTRLEN 28
32
33 /* EVPN prefix lengths. This reprsent the sizeof struct prefix_evpn */
34 #define EVPN_ROUTE_PREFIXLEN 224
35
36 /* EVPN route types. */
37 typedef enum {
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;
44
45 /*
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").
52 */
53 struct bgpevpn {
54 vni_t vni;
55 vrf_id_t tenant_vrf_id;
56 uint32_t flags;
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 */
64
65 struct bgp *bgp_vrf; /* back pointer to the vrf instance */
66
67 /* Flag to indicate if we are
68 * advertising the g/w mac ip for
69 * this VNI*/
70 uint8_t advertise_gw_macip;
71
72 /* Flag to indicate if we are
73 * advertising subnet for this VNI */
74 uint8_t advertise_subnet;
75
76 /* Id for deriving the RD
77 * automatically for this VNI */
78 uint16_t rd_id;
79
80 /* RD for this VNI. */
81 struct prefix_rd prd;
82
83 /* Route type 3 field */
84 struct in_addr originator_ip;
85
86 /* Import and Export RTs. */
87 struct list *import_rtl;
88 struct list *export_rtl;
89
90 /* Route table for EVPN routes for
91 * this VNI. */
92 struct bgp_table *route_table;
93
94 QOBJ_FIELDS
95 };
96
97 DECLARE_QOBJ_TYPE(bgpevpn)
98
99 struct evpnes {
100
101 /* Ethernet Segment Identifier */
102 esi_t esi;
103
104 /* es flags */
105 uint16_t flags;
106 #define EVPNES_LOCAL 0x01
107 #define EVPNES_REMOTE 0x02
108
109 /*
110 * Id for deriving the RD
111 * automatically for this ESI
112 */
113 uint16_t rd_id;
114
115 /* RD for this VNI. */
116 struct prefix_rd prd;
117
118 /* originator ip address */
119 struct ipaddr originator_ip;
120
121 /* list of VTEPs in the same site */
122 struct list *vtep_list;
123
124 /*
125 * Route table for EVPN routes for
126 * this ESI. - type4 routes
127 */
128 struct bgp_table *route_table;
129
130 QOBJ_FIELDS
131 };
132
133 DECLARE_QOBJ_TYPE(evpnes)
134
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.
138 */
139 struct irt_node {
140 /* RT */
141 struct ecommunity_val rt;
142
143 /* List of VNIs importing routes matching this RT. */
144 struct list *vnis;
145 };
146
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.
150 */
151 struct vrf_irt_node {
152 /* RT */
153 struct ecommunity_val rt;
154
155 /* List of VNIs importing routes matching this RT. */
156 struct list *vrfs;
157 };
158
159
160 #define RT_TYPE_IMPORT 1
161 #define RT_TYPE_EXPORT 2
162 #define RT_TYPE_BOTH 3
163
164 #define EVPN_DAD_DEFAULT_TIME 180 /* secs */
165 #define EVPN_DAD_DEFAULT_MAX_MOVES 5 /* default from RFC 7432 */
166 #define EVPN_DAD_DEFAULT_AUTO_RECOVERY_TIME 1800 /* secs */
167
168 struct bgp_evpn_info {
169 /* enable disable dup detect */
170 bool dup_addr_detect;
171
172 /* Detection time(M) */
173 int dad_time;
174 /* Detection max moves(N) */
175 uint32_t dad_max_moves;
176 /* Permanent freeze */
177 bool dad_freeze;
178 /* Recovery time */
179 uint32_t dad_freeze_time;
180 };
181
182 static inline int is_vrf_rd_configured(struct bgp *bgp_vrf)
183 {
184 return (CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_RD_CFGD));
185 }
186
187 static inline int bgp_evpn_vrf_rd_matches_existing(struct bgp *bgp_vrf,
188 struct prefix_rd *prd)
189 {
190 return (memcmp(&bgp_vrf->vrf_prd.val, prd->val, ECOMMUNITY_SIZE) == 0);
191 }
192
193 static inline vni_t bgpevpn_get_l3vni(struct bgpevpn *vpn)
194 {
195 return vpn->bgp_vrf ? vpn->bgp_vrf->l3vni : 0;
196 }
197
198 static inline void bgpevpn_get_rmac(struct bgpevpn *vpn, struct ethaddr *rmac)
199 {
200 memset(rmac, 0, sizeof(struct ethaddr));
201 if (!vpn->bgp_vrf)
202 return;
203 memcpy(rmac, &vpn->bgp_vrf->rmac, sizeof(struct ethaddr));
204 }
205
206 static inline struct list *bgpevpn_get_vrf_export_rtl(struct bgpevpn *vpn)
207 {
208 if (!vpn->bgp_vrf)
209 return NULL;
210
211 return vpn->bgp_vrf->vrf_export_rtl;
212 }
213
214 static inline struct list *bgpevpn_get_vrf_import_rtl(struct bgpevpn *vpn)
215 {
216 if (!vpn->bgp_vrf)
217 return NULL;
218
219 return vpn->bgp_vrf->vrf_import_rtl;
220 }
221
222 static inline void bgpevpn_unlink_from_l3vni(struct bgpevpn *vpn)
223 {
224 /* bail if vpn is not associated to bgp_vrf */
225 if (!vpn->bgp_vrf)
226 return;
227
228 UNSET_FLAG(vpn->flags, VNI_FLAG_USE_TWO_LABELS);
229 listnode_delete(vpn->bgp_vrf->l2vnis, vpn);
230
231 /* remove the backpointer to the vrf instance */
232 vpn->bgp_vrf = NULL;
233 }
234
235 static inline void bgpevpn_link_to_l3vni(struct bgpevpn *vpn)
236 {
237 struct bgp *bgp_vrf = NULL;
238
239 /* bail if vpn is already associated to vrf */
240 if (vpn->bgp_vrf)
241 return;
242
243 bgp_vrf = bgp_lookup_by_vrf_id(vpn->tenant_vrf_id);
244 if (!bgp_vrf)
245 return;
246
247 /* associate the vpn to the bgp_vrf instance */
248 vpn->bgp_vrf = bgp_vrf;
249 listnode_add_sort(bgp_vrf->l2vnis, vpn);
250
251 /* check if we are advertising two labels for this vpn */
252 if (!CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY))
253 SET_FLAG(vpn->flags, VNI_FLAG_USE_TWO_LABELS);
254 }
255
256 static inline int is_vni_configured(struct bgpevpn *vpn)
257 {
258 return (CHECK_FLAG(vpn->flags, VNI_FLAG_CFGD));
259 }
260
261 static inline int is_vni_live(struct bgpevpn *vpn)
262 {
263 return (CHECK_FLAG(vpn->flags, VNI_FLAG_LIVE));
264 }
265
266 static inline int is_rd_configured(struct bgpevpn *vpn)
267 {
268 return (CHECK_FLAG(vpn->flags, VNI_FLAG_RD_CFGD));
269 }
270
271 static inline int bgp_evpn_rd_matches_existing(struct bgpevpn *vpn,
272 struct prefix_rd *prd)
273 {
274 return (memcmp(&vpn->prd.val, prd->val, ECOMMUNITY_SIZE) == 0);
275 }
276
277 static inline int is_import_rt_configured(struct bgpevpn *vpn)
278 {
279 return (CHECK_FLAG(vpn->flags, VNI_FLAG_IMPRT_CFGD));
280 }
281
282 static inline int is_export_rt_configured(struct bgpevpn *vpn)
283 {
284 return (CHECK_FLAG(vpn->flags, VNI_FLAG_EXPRT_CFGD));
285 }
286
287 static inline int is_vni_param_configured(struct bgpevpn *vpn)
288 {
289 return (is_rd_configured(vpn) || is_import_rt_configured(vpn)
290 || is_export_rt_configured(vpn));
291 }
292
293 static inline void encode_es_rt_extcomm(struct ecommunity_val *eval,
294 struct ethaddr *mac)
295 {
296 memset(eval, 0, sizeof(struct ecommunity_val));
297 eval->val[0] = ECOMMUNITY_ENCODE_EVPN;
298 eval->val[1] = ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT;
299 memcpy(&eval->val[2], mac, ETH_ALEN);
300 }
301
302 static inline void encode_rmac_extcomm(struct ecommunity_val *eval,
303 struct ethaddr *rmac)
304 {
305 memset(eval, 0, sizeof(*eval));
306 eval->val[0] = ECOMMUNITY_ENCODE_EVPN;
307 eval->val[1] = ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC;
308 memcpy(&eval->val[2], rmac, ETH_ALEN);
309 }
310
311 static inline void encode_default_gw_extcomm(struct ecommunity_val *eval)
312 {
313 memset(eval, 0, sizeof(*eval));
314 eval->val[0] = ECOMMUNITY_ENCODE_OPAQUE;
315 eval->val[1] = ECOMMUNITY_EVPN_SUBTYPE_DEF_GW;
316 }
317
318 static inline void encode_mac_mobility_extcomm(int static_mac, uint32_t seq,
319 struct ecommunity_val *eval)
320 {
321 memset(eval, 0, sizeof(*eval));
322 eval->val[0] = ECOMMUNITY_ENCODE_EVPN;
323 eval->val[1] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY;
324 if (static_mac)
325 eval->val[2] = ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY_FLAG_STICKY;
326 eval->val[4] = (seq >> 24) & 0xff;
327 eval->val[5] = (seq >> 16) & 0xff;
328 eval->val[6] = (seq >> 8) & 0xff;
329 eval->val[7] = seq & 0xff;
330 }
331
332 static inline void encode_na_flag_extcomm(struct ecommunity_val *eval,
333 uint8_t na_flag)
334 {
335 memset(eval, 0, sizeof(*eval));
336 eval->val[0] = ECOMMUNITY_ENCODE_EVPN;
337 eval->val[1] = ECOMMUNITY_EVPN_SUBTYPE_ND;
338 if (na_flag)
339 eval->val[2] |= ECOMMUNITY_EVPN_SUBTYPE_ND_ROUTER_FLAG;
340 }
341
342 static inline void ip_prefix_from_type5_prefix(struct prefix_evpn *evp,
343 struct prefix *ip)
344 {
345 memset(ip, 0, sizeof(struct prefix));
346 if (is_evpn_prefix_ipaddr_v4(evp)) {
347 ip->family = AF_INET;
348 ip->prefixlen = evp->prefix.prefix_addr.ip_prefix_length;
349 memcpy(&(ip->u.prefix4), &(evp->prefix.prefix_addr.ip.ip),
350 IPV4_MAX_BYTELEN);
351 } else if (is_evpn_prefix_ipaddr_v6(evp)) {
352 ip->family = AF_INET6;
353 ip->prefixlen = evp->prefix.prefix_addr.ip_prefix_length;
354 memcpy(&(ip->u.prefix6), &(evp->prefix.prefix_addr.ip.ip),
355 IPV6_MAX_BYTELEN);
356 }
357 }
358
359 static inline int is_evpn_prefix_default(const struct prefix *evp)
360 {
361 if (evp->family != AF_EVPN)
362 return 0;
363
364 return ((evp->u.prefix_evpn.prefix_addr.ip_prefix_length == 0) ?
365 1 : 0);
366 }
367
368 static inline void ip_prefix_from_type2_prefix(struct prefix_evpn *evp,
369 struct prefix *ip)
370 {
371 memset(ip, 0, sizeof(struct prefix));
372 if (is_evpn_prefix_ipaddr_v4(evp)) {
373 ip->family = AF_INET;
374 ip->prefixlen = IPV4_MAX_BITLEN;
375 memcpy(&(ip->u.prefix4), &(evp->prefix.macip_addr.ip.ip),
376 IPV4_MAX_BYTELEN);
377 } else if (is_evpn_prefix_ipaddr_v6(evp)) {
378 ip->family = AF_INET6;
379 ip->prefixlen = IPV6_MAX_BITLEN;
380 memcpy(&(ip->u.prefix6), &(evp->prefix.macip_addr.ip.ip),
381 IPV6_MAX_BYTELEN);
382 }
383 }
384
385 static inline void ip_prefix_from_evpn_prefix(struct prefix_evpn *evp,
386 struct prefix *ip)
387 {
388 if (evp->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE)
389 ip_prefix_from_type2_prefix(evp, ip);
390 else if (evp->prefix.route_type == BGP_EVPN_IP_PREFIX_ROUTE)
391 ip_prefix_from_type5_prefix(evp, ip);
392 }
393
394 static inline void build_evpn_type2_prefix(struct prefix_evpn *p,
395 struct ethaddr *mac,
396 struct ipaddr *ip)
397 {
398 memset(p, 0, sizeof(struct prefix_evpn));
399 p->family = AF_EVPN;
400 p->prefixlen = EVPN_ROUTE_PREFIXLEN;
401 p->prefix.route_type = BGP_EVPN_MAC_IP_ROUTE;
402 memcpy(&p->prefix.macip_addr.mac.octet, mac->octet, ETH_ALEN);
403 p->prefix.macip_addr.ip.ipa_type = IPADDR_NONE;
404 if (ip)
405 memcpy(&p->prefix.macip_addr.ip, ip, sizeof(*ip));
406 }
407
408 static inline void build_type5_prefix_from_ip_prefix(struct prefix_evpn *evp,
409 struct prefix *ip_prefix)
410 {
411 struct ipaddr ip;
412
413 memset(&ip, 0, sizeof(struct ipaddr));
414 if (ip_prefix->family == AF_INET) {
415 ip.ipa_type = IPADDR_V4;
416 memcpy(&ip.ipaddr_v4, &ip_prefix->u.prefix4,
417 sizeof(struct in_addr));
418 } else {
419 ip.ipa_type = IPADDR_V6;
420 memcpy(&ip.ipaddr_v6, &ip_prefix->u.prefix6,
421 sizeof(struct in6_addr));
422 }
423
424 memset(evp, 0, sizeof(struct prefix_evpn));
425 evp->family = AF_EVPN;
426 evp->prefixlen = EVPN_ROUTE_PREFIXLEN;
427 evp->prefix.route_type = BGP_EVPN_IP_PREFIX_ROUTE;
428 evp->prefix.prefix_addr.ip_prefix_length = ip_prefix->prefixlen;
429 evp->prefix.prefix_addr.ip.ipa_type = ip.ipa_type;
430 memcpy(&evp->prefix.prefix_addr.ip, &ip, sizeof(struct ipaddr));
431 }
432
433 static inline void build_evpn_type3_prefix(struct prefix_evpn *p,
434 struct in_addr originator_ip)
435 {
436 memset(p, 0, sizeof(struct prefix_evpn));
437 p->family = AF_EVPN;
438 p->prefixlen = EVPN_ROUTE_PREFIXLEN;
439 p->prefix.route_type = BGP_EVPN_IMET_ROUTE;
440 p->prefix.imet_addr.ip.ipa_type = IPADDR_V4;
441 p->prefix.imet_addr.ip.ipaddr_v4 = originator_ip;
442 }
443
444 static inline void build_evpn_type4_prefix(struct prefix_evpn *p,
445 esi_t *esi,
446 struct in_addr originator_ip)
447 {
448 memset(p, 0, sizeof(struct prefix_evpn));
449 p->family = AF_EVPN;
450 p->prefixlen = EVPN_ROUTE_PREFIXLEN;
451 p->prefix.route_type = BGP_EVPN_ES_ROUTE;
452 p->prefix.es_addr.ip_prefix_length = IPV4_MAX_BITLEN;
453 p->prefix.es_addr.ip.ipa_type = IPADDR_V4;
454 p->prefix.es_addr.ip.ipaddr_v4 = originator_ip;
455 memcpy(&p->prefix.es_addr.esi, esi, sizeof(esi_t));
456 }
457
458 static inline int evpn_default_originate_set(struct bgp *bgp, afi_t afi,
459 safi_t safi)
460 {
461 if (afi == AFI_IP &&
462 CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN],
463 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4))
464 return 1;
465 else if (afi == AFI_IP6 &&
466 CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN],
467 BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6))
468 return 1;
469 return 0;
470 }
471
472 static inline void es_get_system_mac(esi_t *esi,
473 struct ethaddr *mac)
474 {
475 /*
476 * for type-1 and type-3 ESIs,
477 * the system mac starts at val[1]
478 */
479 memcpy(mac, &esi->val[1], ETH_ALEN);
480 }
481
482 static inline int is_es_local(struct evpnes *es)
483 {
484 return CHECK_FLAG(es->flags, EVPNES_LOCAL) ? 1 : 0;
485 }
486
487 extern void evpn_rt_delete_auto(struct bgp *, vni_t, struct list *);
488 extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp *bgp_vrf,
489 struct ecommunity *ecomadd);
490 extern void bgp_evpn_unconfigure_export_rt_for_vrf(struct bgp *bgp_vrf,
491 struct ecommunity *ecomdel);
492 extern void bgp_evpn_configure_import_rt_for_vrf(struct bgp *bgp_vrf,
493 struct ecommunity *ecomadd);
494 extern void bgp_evpn_unconfigure_import_rt_for_vrf(struct bgp *bgp_vrf,
495 struct ecommunity *ecomdel);
496 extern int bgp_evpn_handle_export_rt_change(struct bgp *bgp,
497 struct bgpevpn *vpn);
498 extern void bgp_evpn_handle_autort_change(struct bgp *bgp);
499 extern void bgp_evpn_handle_vrf_rd_change(struct bgp *bgp_vrf, int withdraw);
500 extern void bgp_evpn_handle_rd_change(struct bgp *bgp, struct bgpevpn *vpn,
501 int withdraw);
502 extern int bgp_evpn_install_routes(struct bgp *bgp, struct bgpevpn *vpn);
503 extern int bgp_evpn_uninstall_routes(struct bgp *bgp, struct bgpevpn *vpn);
504 extern void bgp_evpn_map_vrf_to_its_rts(struct bgp *bgp_vrf);
505 extern void bgp_evpn_unmap_vrf_from_its_rts(struct bgp *bgp_vrf);
506 extern void bgp_evpn_map_vni_to_its_rts(struct bgp *bgp, struct bgpevpn *vpn);
507 extern void bgp_evpn_unmap_vni_from_its_rts(struct bgp *bgp,
508 struct bgpevpn *vpn);
509 extern void bgp_evpn_derive_auto_rt_import(struct bgp *bgp,
510 struct bgpevpn *vpn);
511 extern void bgp_evpn_derive_auto_rt_export(struct bgp *bgp,
512 struct bgpevpn *vpn);
513 extern void bgp_evpn_derive_auto_rd(struct bgp *bgp, struct bgpevpn *vpn);
514 extern void bgp_evpn_derive_auto_rd_for_vrf(struct bgp *bgp);
515 extern struct bgpevpn *bgp_evpn_lookup_vni(struct bgp *bgp, vni_t vni);
516 extern struct bgpevpn *bgp_evpn_new(struct bgp *bgp, vni_t vni,
517 struct in_addr originator_ip,
518 vrf_id_t tenant_vrf_id);
519 extern void bgp_evpn_free(struct bgp *bgp, struct bgpevpn *vpn);
520 extern struct evpnes *bgp_evpn_lookup_es(struct bgp *bgp, esi_t *esi);
521 extern struct evpnes *bgp_evpn_es_new(struct bgp *bgp, esi_t *esi,
522 struct ipaddr *originator_ip);
523 extern void bgp_evpn_es_free(struct bgp *bgp, struct evpnes *es);
524 extern bool bgp_evpn_lookup_l3vni_l2vni_table(vni_t vni);
525 #endif /* _BGP_EVPN_PRIVATE_H */