3 * Copyright (C) 2018 Cumulus Networks, Inc.
6 * This program 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 Free
8 * Software Foundation; either version 2 of the License, or (at your option)
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <lib/nexthop.h>
23 #include <lib/memory.h>
24 #include <lib/srcdest_table.h>
28 #include <lib/memory.h>
30 #include "static_vrf.h"
31 #include "static_routes.h"
32 #include "static_memory.h"
33 #include "static_zebra.h"
35 /* Install static route into rib. */
36 static void static_install_route(struct route_node
*rn
,
37 struct static_route
*si_changed
, safi_t safi
)
39 struct static_route
*si
;
41 for (si
= rn
->info
; si
; si
= si
->next
)
42 static_zebra_nht_register(si
, true);
46 static_zebra_route_add(rn
, si_changed
, si
->vrf_id
, safi
, true);
50 /* Uninstall static route from RIB. */
51 static void static_uninstall_route(vrf_id_t vrf_id
, safi_t safi
,
52 struct route_node
*rn
,
53 struct static_route
*si_changed
)
57 static_zebra_route_add(rn
, si_changed
, vrf_id
, safi
, true);
59 static_zebra_route_add(rn
, si_changed
, vrf_id
, safi
, false);
62 int static_add_route(afi_t afi
, safi_t safi
, uint8_t type
, struct prefix
*p
,
63 struct prefix_ipv6
*src_p
, union g_addr
*gate
,
64 const char *ifname
, enum static_blackhole_type bh_type
,
65 route_tag_t tag
, uint8_t distance
, struct static_vrf
*svrf
,
66 struct static_vrf
*nh_svrf
,
67 struct static_nh_label
*snh_label
, uint32_t table_id
,
70 struct route_node
*rn
;
71 struct static_route
*si
;
72 struct static_route
*pp
;
73 struct static_route
*cp
;
74 struct static_route
*update
= NULL
;
75 struct route_table
*stable
= svrf
->stable
[afi
][safi
];
80 if (!gate
&& (type
== STATIC_IPV4_GATEWAY
81 || type
== STATIC_IPV4_GATEWAY_IFNAME
82 || type
== STATIC_IPV6_GATEWAY
83 || type
== STATIC_IPV6_GATEWAY_IFNAME
))
87 && (type
== STATIC_IFNAME
|| type
== STATIC_IPV4_GATEWAY_IFNAME
88 || type
== STATIC_IPV6_GATEWAY_IFNAME
))
91 /* Lookup static route prefix. */
92 rn
= srcdest_rnode_get(stable
, p
, src_p
);
94 /* Do nothing if there is a same static route. */
95 for (si
= rn
->info
; si
; si
= si
->next
) {
99 && IPV4_ADDR_SAME(&gate
->ipv4
, &si
->addr
.ipv4
))
101 && IPV6_ADDR_SAME(gate
, &si
->addr
.ipv6
))))
102 && (!strcmp(ifname
? ifname
: "", si
->ifname
))) {
103 if ((distance
== si
->distance
) && (tag
== si
->tag
)
104 && (table_id
== si
->table_id
)
105 && !memcmp(&si
->snh_label
, snh_label
,
106 sizeof(struct static_nh_label
))
107 && si
->bh_type
== bh_type
&& si
->onlink
== onlink
) {
108 route_unlock_node(rn
);
115 /* Distance or tag or label changed, delete existing first. */
117 static_delete_route(afi
, safi
, type
, p
, src_p
, gate
, ifname
,
118 update
->tag
, update
->distance
, svrf
,
119 &update
->snh_label
, table_id
);
121 /* Make new static route structure. */
122 si
= XCALLOC(MTYPE_STATIC_ROUTE
, sizeof(struct static_route
));
125 si
->distance
= distance
;
126 si
->bh_type
= bh_type
;
128 si
->vrf_id
= svrf
->vrf
->vrf_id
;
129 si
->nh_vrf_id
= nh_svrf
->vrf
->vrf_id
;
130 strlcpy(si
->nh_vrfname
, nh_svrf
->vrf
->name
, sizeof(si
->nh_vrfname
));
131 si
->table_id
= table_id
;
135 strlcpy(si
->ifname
, ifname
, sizeof(si
->ifname
));
136 si
->ifindex
= IFINDEX_INTERNAL
;
139 case STATIC_IPV4_GATEWAY
:
140 case STATIC_IPV4_GATEWAY_IFNAME
:
141 si
->addr
.ipv4
= gate
->ipv4
;
143 case STATIC_IPV6_GATEWAY
:
144 case STATIC_IPV6_GATEWAY_IFNAME
:
145 si
->addr
.ipv6
= gate
->ipv6
;
151 /* Save labels, if any. */
152 memcpy(&si
->snh_label
, snh_label
, sizeof(struct static_nh_label
));
155 * Add new static route information to the tree with sort by
156 * distance value and gateway address.
158 for (pp
= NULL
, cp
= rn
->info
; cp
; pp
= cp
, cp
= cp
->next
) {
159 if (si
->distance
< cp
->distance
)
161 if (si
->distance
> cp
->distance
)
163 if (si
->type
== STATIC_IPV4_GATEWAY
164 && cp
->type
== STATIC_IPV4_GATEWAY
) {
165 if (ntohl(si
->addr
.ipv4
.s_addr
)
166 < ntohl(cp
->addr
.ipv4
.s_addr
))
168 if (ntohl(si
->addr
.ipv4
.s_addr
)
169 > ntohl(cp
->addr
.ipv4
.s_addr
))
174 /* Make linked list. */
184 /* check whether interface exists in system & install if it does */
186 static_install_route(rn
, si
, safi
);
188 struct interface
*ifp
;
190 ifp
= if_lookup_by_name(ifname
, nh_svrf
->vrf
->vrf_id
);
191 if (ifp
&& ifp
->ifindex
!= IFINDEX_INTERNAL
) {
192 si
->ifindex
= ifp
->ifindex
;
193 static_install_route(rn
, si
, safi
);
195 zlog_warn("Static Route using %s interface not installed because the interface does not exist in specified vrf",
202 int static_delete_route(afi_t afi
, safi_t safi
, uint8_t type
, struct prefix
*p
,
203 struct prefix_ipv6
*src_p
, union g_addr
*gate
,
204 const char *ifname
, route_tag_t tag
, uint8_t distance
,
205 struct static_vrf
*svrf
,
206 struct static_nh_label
*snh_label
,
209 struct route_node
*rn
;
210 struct static_route
*si
;
211 struct route_table
*stable
;
214 stable
= static_vrf_static_table(afi
, safi
, svrf
);
218 /* Lookup static route prefix. */
219 rn
= srcdest_rnode_lookup(stable
, p
, src_p
);
223 /* Find same static route is the tree */
224 for (si
= rn
->info
; si
; si
= si
->next
)
228 && IPV4_ADDR_SAME(&gate
->ipv4
, &si
->addr
.ipv4
))
230 && IPV6_ADDR_SAME(gate
, &si
->addr
.ipv6
))))
231 && (!strcmp(ifname
? ifname
: "", si
->ifname
))
232 && (!tag
|| (tag
== si
->tag
))
233 && (table_id
== si
->table_id
)
234 && (!snh_label
->num_labels
235 || !memcmp(&si
->snh_label
, snh_label
,
236 sizeof(struct static_nh_label
))))
239 /* Can't find static route. */
241 route_unlock_node(rn
);
245 static_zebra_nht_register(si
, false);
247 /* Unlink static route from linked list. */
249 si
->prev
->next
= si
->next
;
253 si
->next
->prev
= si
->prev
;
256 * If we have other si nodes then route replace
257 * else delete the route
259 static_uninstall_route(si
->vrf_id
, safi
, rn
, si
);
260 route_unlock_node(rn
);
262 /* Free static route configuration. */
263 XFREE(MTYPE_STATIC_ROUTE
, si
);
265 route_unlock_node(rn
);
270 static void static_ifindex_update_af(struct interface
*ifp
, bool up
, afi_t afi
,
273 struct route_table
*stable
;
274 struct route_node
*rn
;
275 struct static_route
*si
;
278 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
279 struct static_vrf
*svrf
;
283 stable
= static_vrf_static_table(afi
, safi
, svrf
);
287 for (rn
= route_top(stable
); rn
; rn
= srcdest_route_next(rn
)) {
288 for (si
= rn
->info
; si
; si
= si
->next
) {
292 if (strcmp(si
->ifname
, ifp
->name
))
294 si
->ifindex
= ifp
->ifindex
;
296 if (si
->ifindex
!= ifp
->ifindex
)
298 si
->ifindex
= IFINDEX_INTERNAL
;
301 static_install_route(rn
, si
, safi
);
308 * This function looks at a svrf's stable and notices if any of the
309 * nexthops we are using are part of the vrf coming up.
310 * If we are using them then cleanup the nexthop vrf id
311 * to be the new value and then re-installs them
314 * stable -> The table we are looking at.
315 * svrf -> The newly changed vrf.
316 * afi -> The afi to look at
317 * safi -> the safi to look at
319 static void static_fixup_vrf(struct static_vrf
*svrf
,
320 struct route_table
*stable
, afi_t afi
, safi_t safi
)
322 struct route_node
*rn
;
323 struct static_route
*si
;
324 struct interface
*ifp
;
326 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
327 for (si
= rn
->info
; si
; si
= si
->next
) {
328 if (strcmp(svrf
->vrf
->name
, si
->nh_vrfname
) != 0)
331 si
->nh_vrf_id
= svrf
->vrf
->vrf_id
;
332 si
->nh_registered
= false;
334 ifp
= if_lookup_by_name(si
->ifname
,
337 si
->ifindex
= ifp
->ifindex
;
342 static_install_route(rn
, si
, safi
);
348 * This function enables static routes in a svrf as it
349 * is coming up. It sets the new vrf_id as appropriate.
351 * svrf -> The svrf that is being brought up and enabled by the kernel
352 * stable -> The stable we are looking at.
353 * afi -> the afi in question
354 * safi -> the safi in question
356 static void static_enable_vrf(struct static_vrf
*svrf
,
357 struct route_table
*stable
,
358 afi_t afi
, safi_t safi
)
360 struct route_node
*rn
;
361 struct static_route
*si
;
362 struct interface
*ifp
;
363 struct vrf
*vrf
= svrf
->vrf
;
365 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
366 for (si
= rn
->info
; si
; si
= si
->next
) {
367 si
->vrf_id
= vrf
->vrf_id
;
369 ifp
= if_lookup_by_name(si
->ifname
,
372 si
->ifindex
= ifp
->ifindex
;
376 static_install_route(rn
, si
, safi
);
382 * When a vrf is being enabled by the kernel, go through all the
383 * static routes in the system that use this vrf (both nexthops vrfs
384 * and the routes vrf )
386 * enable_svrf -> the vrf being enabled
388 void static_fixup_vrf_ids(struct static_vrf
*enable_svrf
)
390 struct route_table
*stable
;
395 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
396 struct static_vrf
*svrf
;
399 /* Install any static routes configured for this VRF. */
400 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
401 for (safi
= SAFI_UNICAST
; safi
< SAFI_MAX
; safi
++) {
402 stable
= svrf
->stable
[afi
][safi
];
406 static_fixup_vrf(enable_svrf
, stable
,
409 if (enable_svrf
== svrf
)
410 static_enable_vrf(svrf
, stable
,
418 * Look at the specified stable and if any of the routes in
419 * this table are using the svrf as the nexthop, uninstall
422 * svrf -> the vrf being disabled
423 * stable -> the table we need to look at.
424 * afi -> the afi in question
425 * safi -> the safi in question
427 static void static_cleanup_vrf(struct static_vrf
*svrf
,
428 struct route_table
*stable
,
429 afi_t afi
, safi_t safi
)
431 struct route_node
*rn
;
432 struct static_route
*si
;
434 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
435 for (si
= rn
->info
; si
; si
= si
->next
) {
436 if (strcmp(svrf
->vrf
->name
, si
->nh_vrfname
) != 0)
439 static_uninstall_route(si
->vrf_id
, safi
, rn
, si
);
445 * Look at all static routes in this table and uninstall
448 * stable -> The table to uninstall from
449 * afi -> The afi in question
450 * safi -> the safi in question
452 static void static_disable_vrf(struct route_table
*stable
,
453 afi_t afi
, safi_t safi
)
455 struct route_node
*rn
;
456 struct static_route
*si
;
458 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
))
459 for (si
= rn
->info
; si
; si
= si
->next
)
460 static_uninstall_route(si
->vrf_id
, safi
, rn
, si
);
464 * When the disable_svrf is shutdown by the kernel, we call
465 * this function and it cleans up all static routes using
466 * this vrf as a nexthop as well as all static routes
469 * disable_svrf - The vrf being disabled
471 void static_cleanup_vrf_ids(struct static_vrf
*disable_svrf
)
477 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
478 struct static_vrf
*svrf
;
482 /* Uninstall any static routes configured for this VRF. */
483 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
484 for (safi
= SAFI_UNICAST
; safi
< SAFI_MAX
; safi
++) {
485 struct route_table
*stable
;
487 stable
= svrf
->stable
[afi
][safi
];
491 static_cleanup_vrf(disable_svrf
, stable
,
494 if (disable_svrf
== svrf
)
495 static_disable_vrf(stable
, afi
, safi
);
502 * This function enables static routes when an interface it relies
503 * on in a different vrf is coming up.
505 * stable -> The stable we are looking at.
506 * ifp -> interface coming up
507 * afi -> the afi in question
508 * safi -> the safi in question
510 static void static_fixup_intf_nh(struct route_table
*stable
,
511 struct interface
*ifp
,
512 afi_t afi
, safi_t safi
)
514 struct route_node
*rn
;
515 struct static_route
*si
;
517 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
518 for (si
= rn
->info
; si
; si
= si
->next
) {
519 if (si
->nh_vrf_id
!= ifp
->vrf_id
)
522 if (si
->ifindex
!= ifp
->ifindex
)
525 static_install_route(rn
, si
, safi
);
531 * This function enables static routes that rely on an interface in
532 * a different vrf when that interface comes up.
534 void static_install_intf_nh(struct interface
*ifp
)
536 struct route_table
*stable
;
541 RB_FOREACH(vrf
, vrf_name_head
, &vrfs_by_name
) {
542 struct static_vrf
*svrf
= vrf
->info
;
544 /* Not needed if same vrf since happens naturally */
545 if (vrf
->vrf_id
== ifp
->vrf_id
)
548 /* Install any static routes configured for this interface. */
549 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
550 for (safi
= SAFI_UNICAST
; safi
< SAFI_MAX
; safi
++) {
551 stable
= svrf
->stable
[afi
][safi
];
555 static_fixup_intf_nh(stable
, ifp
, afi
, safi
);
561 /* called from if_{add,delete}_update, i.e. when ifindex becomes [in]valid */
562 void static_ifindex_update(struct interface
*ifp
, bool up
)
564 static_ifindex_update_af(ifp
, up
, AFI_IP
, SAFI_UNICAST
);
565 static_ifindex_update_af(ifp
, up
, AFI_IP
, SAFI_MULTICAST
);
566 static_ifindex_update_af(ifp
, up
, AFI_IP6
, SAFI_UNICAST
);
567 static_ifindex_update_af(ifp
, up
, AFI_IP6
, SAFI_MULTICAST
);