2 * Copyright (C) 2016 CumulusNetworks
5 * This file is part of Quagga
7 * Quagga is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
12 * Quagga is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
30 #include "srcdest_table.h"
34 #include "zebra/zebra_router.h"
35 #include "zebra/rtadv.h"
36 #include "zebra/debug.h"
37 #include "zebra/zapi_msg.h"
38 #include "zebra/rib.h"
39 #include "zebra/zebra_vrf.h"
40 #include "zebra/zebra_rnh.h"
41 #include "zebra/router-id.h"
42 #include "zebra/interface.h"
43 #include "zebra/zebra_mpls.h"
44 #include "zebra/zebra_vxlan.h"
45 #include "zebra/zebra_netns_notify.h"
46 #include "zebra/zebra_routemap.h"
47 #ifndef VTYSH_EXTRACT_PL
48 #include "zebra/zebra_vrf_clippy.c"
50 #include "zebra/table_manager.h"
52 static void zebra_vrf_table_create(struct zebra_vrf
*zvrf
, afi_t afi
,
54 static void zebra_rnhtable_node_cleanup(struct route_table
*table
,
55 struct route_node
*node
);
57 DEFINE_MTYPE_STATIC(ZEBRA
, ZEBRA_VRF
, "ZEBRA VRF");
58 DEFINE_MTYPE_STATIC(ZEBRA
, OTHER_TABLE
, "Other Table");
60 /* VRF information update. */
61 static void zebra_vrf_add_update(struct zebra_vrf
*zvrf
)
63 struct listnode
*node
, *nnode
;
66 if (IS_ZEBRA_DEBUG_EVENT
)
67 zlog_debug("MESSAGE: ZEBRA_VRF_ADD %s", zvrf_name(zvrf
));
69 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, node
, nnode
, client
)) {
70 /* Do not send unsolicited messages to synchronous clients. */
71 if (client
->synchronous
)
74 zsend_vrf_add(client
, zvrf
);
78 static void zebra_vrf_delete_update(struct zebra_vrf
*zvrf
)
80 struct listnode
*node
, *nnode
;
83 if (IS_ZEBRA_DEBUG_EVENT
)
84 zlog_debug("MESSAGE: ZEBRA_VRF_DELETE %s", zvrf_name(zvrf
));
86 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, node
, nnode
, client
)) {
87 /* Do not send unsolicited messages to synchronous clients. */
88 if (client
->synchronous
)
91 zsend_vrf_delete(client
, zvrf
);
95 void zebra_vrf_update_all(struct zserv
*client
)
99 RB_FOREACH (vrf
, vrf_id_head
, &vrfs_by_id
) {
100 if (vrf
->vrf_id
!= VRF_UNKNOWN
)
101 zsend_vrf_add(client
, vrf_info_lookup(vrf
->vrf_id
));
105 /* Callback upon creating a new VRF. */
106 static int zebra_vrf_new(struct vrf
*vrf
)
108 struct zebra_vrf
*zvrf
;
110 if (IS_ZEBRA_DEBUG_EVENT
)
111 zlog_debug("VRF %s created, id %u", vrf
->name
, vrf
->vrf_id
);
113 zvrf
= zebra_vrf_alloc(vrf
);
114 if (!vrf_is_backend_netns())
115 zvrf
->zns
= zebra_ns_lookup(NS_DEFAULT
);
117 otable_init(&zvrf
->other_tables
);
119 router_id_init(zvrf
);
121 /* Initiate Table Manager per ZNS */
122 table_manager_enable(zvrf
);
127 /* Callback upon enabling a VRF. */
128 static int zebra_vrf_enable(struct vrf
*vrf
)
130 struct zebra_vrf
*zvrf
= vrf
->info
;
131 struct route_table
*table
;
136 if (IS_ZEBRA_DEBUG_EVENT
)
137 zlog_debug("VRF %s id %u is now active", zvrf_name(zvrf
),
140 if (vrf_is_backend_netns())
141 zvrf
->zns
= zebra_ns_lookup((ns_id_t
)vrf
->vrf_id
);
143 zvrf
->zns
= zebra_ns_lookup(NS_DEFAULT
);
145 rtadv_vrf_init(zvrf
);
147 /* Inform clients that the VRF is now active. This is an
148 * add for the clients.
151 zebra_vrf_add_update(zvrf
);
152 /* Allocate tables */
153 for (afi
= AFI_IP
; afi
<= AFI_IP6
; afi
++) {
154 for (safi
= SAFI_UNICAST
; safi
<= SAFI_MULTICAST
; safi
++)
155 zebra_vrf_table_create(zvrf
, afi
, safi
);
157 table
= route_table_init();
158 table
->cleanup
= zebra_rnhtable_node_cleanup
;
159 zvrf
->rnh_table
[afi
] = table
;
161 table
= route_table_init();
162 table
->cleanup
= zebra_rnhtable_node_cleanup
;
163 zvrf
->rnh_table_multicast
[afi
] = table
;
166 /* Kick off any VxLAN-EVPN processing. */
167 zebra_vxlan_vrf_enable(zvrf
);
172 /* Callback upon disabling a VRF. */
173 static int zebra_vrf_disable(struct vrf
*vrf
)
175 struct zebra_vrf
*zvrf
= vrf
->info
;
176 struct interface
*ifp
;
181 if (IS_ZEBRA_DEBUG_EVENT
)
182 zlog_debug("VRF %s id %u is now inactive", zvrf_name(zvrf
),
185 /* Stop any VxLAN-EVPN processing. */
186 zebra_vxlan_vrf_disable(zvrf
);
188 rtadv_vrf_terminate(zvrf
);
190 /* Inform clients that the VRF is now inactive. This is a
191 * delete for the clients.
193 zebra_vrf_delete_update(zvrf
);
195 /* If asked to retain routes, there's nothing more to do. */
196 if (CHECK_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
))
199 /* Remove all routes. */
200 for (afi
= AFI_IP
; afi
<= AFI_IP6
; afi
++) {
201 route_table_finish(zvrf
->rnh_table
[afi
]);
202 zvrf
->rnh_table
[afi
] = NULL
;
203 route_table_finish(zvrf
->rnh_table_multicast
[afi
]);
204 zvrf
->rnh_table_multicast
[afi
] = NULL
;
206 for (safi
= SAFI_UNICAST
; safi
<= SAFI_MULTICAST
; safi
++)
207 rib_close_table(zvrf
->table
[afi
][safi
]);
210 /* Cleanup Vxlan, MPLS and PW tables. */
211 zebra_vxlan_cleanup_tables(zvrf
);
212 zebra_mpls_cleanup_tables(zvrf
);
215 /* Remove link-local IPv4 addresses created for BGP unnumbered peering.
217 FOR_ALL_INTERFACES (vrf
, ifp
)
218 if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(ifp
);
220 /* clean-up work queues */
221 meta_queue_free(zrouter
.mq
, zvrf
);
223 /* Cleanup (free) routing tables and NHT tables. */
224 for (afi
= AFI_IP
; afi
<= AFI_IP6
; afi
++) {
226 * Set the table pointer to NULL as that
227 * we no-longer need a copy of it, nor do we
228 * own this data, the zebra_router structure
229 * owns these tables. Once we've cleaned up the
230 * table, see rib_close_table above
231 * we no-longer need this pointer.
233 for (safi
= SAFI_UNICAST
; safi
<= SAFI_MULTICAST
; safi
++) {
234 zebra_router_release_table(zvrf
, zvrf
->table_id
, afi
,
236 zvrf
->table
[afi
][safi
] = NULL
;
243 static int zebra_vrf_delete(struct vrf
*vrf
)
245 struct zebra_vrf
*zvrf
= vrf
->info
;
246 struct other_route_table
*otable
;
249 if (IS_ZEBRA_DEBUG_EVENT
)
250 zlog_debug("VRF %s id %u deleted", zvrf_name(zvrf
),
253 table_manager_disable(zvrf
);
255 /* clean-up work queues */
256 meta_queue_free(zrouter
.mq
, zvrf
);
258 /* Free Vxlan and MPLS. */
259 zebra_vxlan_close_tables(zvrf
);
260 zebra_mpls_close_tables(zvrf
);
262 otable
= otable_pop(&zvrf
->other_tables
);
264 zebra_router_release_table(zvrf
, otable
->table_id
,
265 otable
->afi
, otable
->safi
);
266 XFREE(MTYPE_OTHER_TABLE
, otable
);
268 otable
= otable_pop(&zvrf
->other_tables
);
271 /* Cleanup EVPN states for vrf */
272 zebra_vxlan_vrf_delete(zvrf
);
274 list_delete_all_node(zvrf
->rid_all_sorted_list
);
275 list_delete_all_node(zvrf
->rid_lo_sorted_list
);
277 list_delete_all_node(zvrf
->rid6_all_sorted_list
);
278 list_delete_all_node(zvrf
->rid6_lo_sorted_list
);
280 otable_fini(&zvrf
->other_tables
);
281 XFREE(MTYPE_ZEBRA_VRF
, zvrf
);
287 /* Lookup the routing table in a VRF based on both VRF-Id and table-id.
288 * NOTE: Table-id is relevant on two modes:
289 * - case VRF backend is default : on default VRF only
290 * - case VRF backend is netns : on all VRFs
292 struct route_table
*zebra_vrf_lookup_table_with_table_id(afi_t afi
, safi_t safi
,
296 struct zebra_vrf
*zvrf
= vrf_info_lookup(vrf_id
);
297 struct other_route_table ort
, *otable
;
302 if (afi
>= AFI_MAX
|| safi
>= SAFI_MAX
)
305 if (table_id
== zvrf
->table_id
)
306 return zebra_vrf_table(afi
, safi
, vrf_id
);
310 ort
.table_id
= table_id
;
311 otable
= otable_find(&zvrf
->other_tables
, &ort
);
314 return otable
->table
;
319 struct route_table
*zebra_vrf_get_table_with_table_id(afi_t afi
, safi_t safi
,
323 struct zebra_vrf
*zvrf
= vrf_info_lookup(vrf_id
);
324 struct other_route_table
*otable
;
325 struct route_table
*table
;
327 table
= zebra_vrf_lookup_table_with_table_id(afi
, safi
, vrf_id
,
333 /* Create it as an `other` table */
334 table
= zebra_router_get_table(zvrf
, table_id
, afi
, safi
);
336 otable
= XCALLOC(MTYPE_OTHER_TABLE
, sizeof(*otable
));
339 otable
->table_id
= table_id
;
340 otable
->table
= table
;
341 otable_add(&zvrf
->other_tables
, otable
);
347 static void zebra_rnhtable_node_cleanup(struct route_table
*table
,
348 struct route_node
*node
)
351 zebra_free_rnh(node
->info
);
355 * Create a routing table for the specific AFI/SAFI in the given VRF.
357 static void zebra_vrf_table_create(struct zebra_vrf
*zvrf
, afi_t afi
,
360 struct route_node
*rn
;
363 assert(!zvrf
->table
[afi
][safi
]);
365 zvrf
->table
[afi
][safi
] =
366 zebra_router_get_table(zvrf
, zvrf
->table_id
, afi
, safi
);
368 memset(&p
, 0, sizeof(p
));
369 p
.family
= afi2family(afi
);
371 rn
= srcdest_rnode_get(zvrf
->table
[afi
][safi
], &p
, NULL
);
372 zebra_rib_create_dest(rn
);
375 /* Allocate new zebra VRF. */
376 struct zebra_vrf
*zebra_vrf_alloc(struct vrf
*vrf
)
378 struct zebra_vrf
*zvrf
;
380 zvrf
= XCALLOC(MTYPE_ZEBRA_VRF
, sizeof(struct zebra_vrf
));
385 zebra_vxlan_init_tables(zvrf
);
386 zebra_mpls_init_tables(zvrf
);
388 zvrf
->table_id
= RT_TABLE_MAIN
;
389 /* by default table ID is default one */
393 /* Lookup VRF by identifier. */
394 struct zebra_vrf
*zebra_vrf_lookup_by_id(vrf_id_t vrf_id
)
396 return vrf_info_lookup(vrf_id
);
399 /* Lookup VRF by name. */
400 struct zebra_vrf
*zebra_vrf_lookup_by_name(const char *name
)
405 name
= VRF_DEFAULT_NAME
;
407 vrf
= vrf_lookup_by_name(name
);
409 return ((struct zebra_vrf
*)vrf
->info
);
414 /* Lookup the routing table in an enabled VRF. */
415 struct route_table
*zebra_vrf_table(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
)
417 struct zebra_vrf
*zvrf
= vrf_info_lookup(vrf_id
);
422 if (afi
>= AFI_MAX
|| safi
>= SAFI_MAX
)
425 return zvrf
->table
[afi
][safi
];
428 static int vrf_config_write(struct vty
*vty
)
431 struct zebra_vrf
*zvrf
;
433 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
439 if (zvrf_id(zvrf
) == VRF_DEFAULT
) {
441 vty_out(vty
, "vni %u%s\n", zvrf
->l3vni
,
442 is_l3vni_for_prefix_routes_only(
444 ? " prefix-routes-only"
446 if (zvrf
->zebra_rnh_ip_default_route
)
447 vty_out(vty
, "ip nht resolve-via-default\n");
449 if (zvrf
->zebra_rnh_ipv6_default_route
)
450 vty_out(vty
, "ipv6 nht resolve-via-default\n");
453 && (zvrf
->tbl_mgr
->start
|| zvrf
->tbl_mgr
->end
))
454 vty_out(vty
, "ip table range %u %u\n",
455 zvrf
->tbl_mgr
->start
,
458 vty_frame(vty
, "vrf %s\n", zvrf_name(zvrf
));
460 vty_out(vty
, " vni %u%s\n", zvrf
->l3vni
,
461 is_l3vni_for_prefix_routes_only(
463 ? " prefix-routes-only"
465 zebra_ns_config_write(vty
, (struct ns
*)vrf
->ns_ctxt
);
466 if (zvrf
->zebra_rnh_ip_default_route
)
467 vty_out(vty
, " ip nht resolve-via-default\n");
469 if (zvrf
->zebra_rnh_ipv6_default_route
)
470 vty_out(vty
, " ipv6 nht resolve-via-default\n");
472 if (zvrf
->tbl_mgr
&& vrf_is_backend_netns()
473 && (zvrf
->tbl_mgr
->start
|| zvrf
->tbl_mgr
->end
))
474 vty_out(vty
, " ip table range %u %u\n",
475 zvrf
->tbl_mgr
->start
,
480 zebra_routemap_config_write_protocol(vty
, zvrf
);
481 router_id_write(vty
, zvrf
);
483 if (zvrf_id(zvrf
) != VRF_DEFAULT
)
484 vty_endframe(vty
, "exit-vrf\n!\n");
493 "netns NAME$netns_name",
494 "Attach VRF to a Namespace\n"
495 "The file name in " NS_RUN_DIR
", or a full pathname\n")
497 char *pathname
= ns_netns_pathname(vty
, netns_name
);
500 VTY_DECLVAR_CONTEXT(vrf
, vrf
);
503 return CMD_WARNING_CONFIG_FAILED
;
505 frr_with_privs(&zserv_privs
) {
506 ret
= zebra_vrf_netns_handler_create(
507 vty
, vrf
, pathname
, NS_UNKNOWN
, NS_UNKNOWN
, NS_UNKNOWN
);
517 "Detach VRF from a Namespace\n"
518 "The file name in " NS_RUN_DIR
", or a full pathname\n")
520 struct ns
*ns
= NULL
;
522 VTY_DECLVAR_CONTEXT(vrf
, vrf
);
524 if (!vrf_is_backend_netns()) {
525 vty_out(vty
, "VRF backend is not Netns. Aborting\n");
526 return CMD_WARNING_CONFIG_FAILED
;
529 vty_out(vty
, "VRF %s(%u) is not configured with NetNS\n",
530 vrf
->name
, vrf
->vrf_id
);
531 return CMD_WARNING_CONFIG_FAILED
;
534 ns
= (struct ns
*)vrf
->ns_ctxt
;
538 /* vrf ID from VRF is necessary for Zebra
539 * so that propagate to other clients is done
546 /* if ns_id is different and not VRF_UNKNOWN,
547 * then update vrf identifier, and enable VRF
549 static void vrf_update_vrf_id(ns_id_t ns_id
, void *opaqueptr
)
551 ns_id_t vrf_id
= (vrf_id_t
)ns_id
;
553 struct vrf
*vrf
= (struct vrf
*)opaqueptr
;
557 old_vrf_id
= vrf
->vrf_id
;
558 if (vrf_id
== vrf
->vrf_id
)
560 if (vrf
->vrf_id
!= VRF_UNKNOWN
)
561 RB_REMOVE(vrf_id_head
, &vrfs_by_id
, vrf
);
562 vrf
->vrf_id
= vrf_id
;
563 RB_INSERT(vrf_id_head
, &vrfs_by_id
, vrf
);
564 if (old_vrf_id
== VRF_UNKNOWN
)
568 int zebra_vrf_netns_handler_create(struct vty
*vty
, struct vrf
*vrf
,
569 char *pathname
, ns_id_t ns_id
,
570 ns_id_t internal_ns_id
,
571 ns_id_t rel_def_ns_id
)
573 struct ns
*ns
= NULL
;
576 return CMD_WARNING_CONFIG_FAILED
;
577 if (vrf
->vrf_id
!= VRF_UNKNOWN
&& vrf
->ns_ctxt
== NULL
) {
580 "VRF %u is already configured with VRF %s\n",
581 vrf
->vrf_id
, vrf
->name
);
583 zlog_info("VRF %u is already configured with VRF %s",
584 vrf
->vrf_id
, vrf
->name
);
585 return CMD_WARNING_CONFIG_FAILED
;
587 if (vrf
->ns_ctxt
!= NULL
) {
588 ns
= (struct ns
*)vrf
->ns_ctxt
;
589 if (!strcmp(ns
->name
, pathname
)) {
592 "VRF %u already configured with NETNS %s\n",
593 vrf
->vrf_id
, ns
->name
);
596 "VRF %u already configured with NETNS %s",
597 vrf
->vrf_id
, ns
->name
);
601 ns
= ns_lookup_name(pathname
);
602 if (ns
&& ns
->vrf_ctxt
) {
603 struct vrf
*vrf2
= (struct vrf
*)ns
->vrf_ctxt
;
609 "NS %s is already configured with VRF %u(%s)\n",
610 ns
->name
, vrf2
->vrf_id
, vrf2
->name
);
612 zlog_info("NS %s is already configured with VRF %u(%s)",
613 ns
->name
, vrf2
->vrf_id
, vrf2
->name
);
614 return CMD_WARNING_CONFIG_FAILED
;
616 ns
= ns_get_created(ns
, pathname
, ns_id
);
617 ns
->internal_ns_id
= internal_ns_id
;
618 ns
->relative_default_ns
= rel_def_ns_id
;
619 ns
->vrf_ctxt
= (void *)vrf
;
620 vrf
->ns_ctxt
= (void *)ns
;
621 /* update VRF netns NAME */
622 strlcpy(vrf
->data
.l
.netns_name
, basename(pathname
), NS_NAMSIZ
);
624 if (!ns_enable(ns
, vrf_update_vrf_id
)) {
626 vty_out(vty
, "Can not associate NS %u with NETNS %s\n",
627 ns
->ns_id
, ns
->name
);
629 zlog_info("Can not associate NS %u with NETNS %s",
630 ns
->ns_id
, ns
->name
);
631 return CMD_WARNING_CONFIG_FAILED
;
637 /* Zebra VRF initialization. */
638 void zebra_vrf_init(void)
640 vrf_init(zebra_vrf_new
, zebra_vrf_enable
, zebra_vrf_disable
,
643 hook_register(zserv_client_close
, release_daemon_table_chunks
);
645 vrf_cmd_init(vrf_config_write
);
647 if (vrf_is_backend_netns() && ns_have_netns()) {
648 /* Install NS commands. */
649 install_element(VRF_NODE
, &vrf_netns_cmd
);
650 install_element(VRF_NODE
, &no_vrf_netns_cmd
);