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(rn
, 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
];
76 struct interface
*ifp
;
81 if (!gate
&& (type
== STATIC_IPV4_GATEWAY
82 || type
== STATIC_IPV4_GATEWAY_IFNAME
83 || type
== STATIC_IPV6_GATEWAY
84 || type
== STATIC_IPV6_GATEWAY_IFNAME
))
88 && (type
== STATIC_IFNAME
|| type
== STATIC_IPV4_GATEWAY_IFNAME
89 || type
== STATIC_IPV6_GATEWAY_IFNAME
))
92 /* Lookup static route prefix. */
93 rn
= srcdest_rnode_get(stable
, p
, src_p
);
95 /* Do nothing if there is a same static route. */
96 for (si
= rn
->info
; si
; si
= si
->next
) {
100 && IPV4_ADDR_SAME(&gate
->ipv4
, &si
->addr
.ipv4
))
102 && IPV6_ADDR_SAME(gate
, &si
->addr
.ipv6
))))
103 && (!strcmp(ifname
? ifname
: "", si
->ifname
))) {
104 if ((distance
== si
->distance
) && (tag
== si
->tag
)
105 && (table_id
== si
->table_id
)
106 && !memcmp(&si
->snh_label
, snh_label
,
107 sizeof(struct static_nh_label
))
108 && si
->bh_type
== bh_type
&& si
->onlink
== onlink
) {
109 route_unlock_node(rn
);
116 /* Distance or tag or label changed, delete existing first. */
118 static_delete_route(afi
, safi
, type
, p
, src_p
, gate
, ifname
,
119 update
->tag
, update
->distance
, svrf
,
120 &update
->snh_label
, table_id
);
122 /* Make new static route structure. */
123 si
= XCALLOC(MTYPE_STATIC_ROUTE
, sizeof(struct static_route
));
126 si
->distance
= distance
;
127 si
->bh_type
= bh_type
;
129 si
->vrf_id
= svrf
->vrf
->vrf_id
;
130 si
->nh_vrf_id
= nh_svrf
->vrf
->vrf_id
;
131 strlcpy(si
->nh_vrfname
, nh_svrf
->vrf
->name
, sizeof(si
->nh_vrfname
));
132 si
->table_id
= table_id
;
136 strlcpy(si
->ifname
, ifname
, sizeof(si
->ifname
));
137 si
->ifindex
= IFINDEX_INTERNAL
;
140 case STATIC_IPV4_GATEWAY
:
141 case STATIC_IPV4_GATEWAY_IFNAME
:
142 si
->addr
.ipv4
= gate
->ipv4
;
144 case STATIC_IPV6_GATEWAY
:
145 case STATIC_IPV6_GATEWAY_IFNAME
:
146 si
->addr
.ipv6
= gate
->ipv6
;
152 /* Save labels, if any. */
153 memcpy(&si
->snh_label
, snh_label
, sizeof(struct static_nh_label
));
156 * Add new static route information to the tree with sort by
157 * distance value and gateway address.
159 for (pp
= NULL
, cp
= rn
->info
; cp
; pp
= cp
, cp
= cp
->next
) {
160 if (si
->distance
< cp
->distance
)
162 if (si
->distance
> cp
->distance
)
164 if (si
->type
== STATIC_IPV4_GATEWAY
165 && cp
->type
== STATIC_IPV4_GATEWAY
) {
166 if (ntohl(si
->addr
.ipv4
.s_addr
)
167 < ntohl(cp
->addr
.ipv4
.s_addr
))
169 if (ntohl(si
->addr
.ipv4
.s_addr
)
170 > ntohl(cp
->addr
.ipv4
.s_addr
))
175 /* Make linked list. */
185 /* check whether interface exists in system & install if it does */
187 case STATIC_IPV4_GATEWAY
:
188 case STATIC_IPV6_GATEWAY
:
189 static_zebra_nht_register(rn
, si
, true);
191 case STATIC_IPV4_GATEWAY_IFNAME
:
192 case STATIC_IPV6_GATEWAY_IFNAME
:
193 ifp
= if_lookup_by_name(ifname
, nh_svrf
->vrf
->vrf_id
);
194 if (ifp
&& ifp
->ifindex
!= IFINDEX_INTERNAL
)
195 si
->ifindex
= ifp
->ifindex
;
197 zlog_warn("Static Route using %s interface not installed because the interface does not exist in specified vrf",
200 static_zebra_nht_register(rn
, si
, true);
202 case STATIC_BLACKHOLE
:
203 static_install_route(rn
, si
, safi
);
206 ifp
= if_lookup_by_name(ifname
, nh_svrf
->vrf
->vrf_id
);
207 if (ifp
&& ifp
->ifindex
!= IFINDEX_INTERNAL
) {
208 si
->ifindex
= ifp
->ifindex
;
209 static_install_route(rn
, si
, safi
);
211 zlog_warn("Static Route using %s interface not installed because the interface does not exist in specified vrf",
220 int static_delete_route(afi_t afi
, safi_t safi
, uint8_t type
, struct prefix
*p
,
221 struct prefix_ipv6
*src_p
, union g_addr
*gate
,
222 const char *ifname
, route_tag_t tag
, uint8_t distance
,
223 struct static_vrf
*svrf
,
224 struct static_nh_label
*snh_label
,
227 struct route_node
*rn
;
228 struct static_route
*si
;
229 struct route_table
*stable
;
232 stable
= static_vrf_static_table(afi
, safi
, svrf
);
236 /* Lookup static route prefix. */
237 rn
= srcdest_rnode_lookup(stable
, p
, src_p
);
241 /* Find same static route is the tree */
242 for (si
= rn
->info
; si
; si
= si
->next
)
246 && IPV4_ADDR_SAME(&gate
->ipv4
, &si
->addr
.ipv4
))
248 && IPV6_ADDR_SAME(gate
, &si
->addr
.ipv6
))))
249 && (!strcmp(ifname
? ifname
: "", si
->ifname
))
250 && (!tag
|| (tag
== si
->tag
))
251 && (table_id
== si
->table_id
)
252 && (!snh_label
->num_labels
253 || !memcmp(&si
->snh_label
, snh_label
,
254 sizeof(struct static_nh_label
))))
257 /* Can't find static route. */
259 route_unlock_node(rn
);
263 static_zebra_nht_register(rn
, si
, false);
265 /* Unlink static route from linked list. */
267 si
->prev
->next
= si
->next
;
271 si
->next
->prev
= si
->prev
;
274 * If we have other si nodes then route replace
275 * else delete the route
277 static_uninstall_route(si
->vrf_id
, safi
, rn
, si
);
278 route_unlock_node(rn
);
280 /* Free static route configuration. */
281 XFREE(MTYPE_STATIC_ROUTE
, si
);
283 route_unlock_node(rn
);
288 static void static_ifindex_update_af(struct interface
*ifp
, bool up
, afi_t afi
,
291 struct route_table
*stable
;
292 struct route_node
*rn
;
293 struct static_route
*si
;
296 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
297 struct static_vrf
*svrf
;
301 stable
= static_vrf_static_table(afi
, safi
, svrf
);
305 for (rn
= route_top(stable
); rn
; rn
= srcdest_route_next(rn
)) {
306 for (si
= rn
->info
; si
; si
= si
->next
) {
310 if (strcmp(si
->ifname
, ifp
->name
))
312 si
->ifindex
= ifp
->ifindex
;
314 if (si
->ifindex
!= ifp
->ifindex
)
316 si
->ifindex
= IFINDEX_INTERNAL
;
319 static_install_route(rn
, si
, safi
);
326 * This function looks at a svrf's stable and notices if any of the
327 * nexthops we are using are part of the vrf coming up.
328 * If we are using them then cleanup the nexthop vrf id
329 * to be the new value and then re-installs them
332 * stable -> The table we are looking at.
333 * svrf -> The newly changed vrf.
334 * afi -> The afi to look at
335 * safi -> the safi to look at
337 static void static_fixup_vrf(struct static_vrf
*svrf
,
338 struct route_table
*stable
, afi_t afi
, safi_t safi
)
340 struct route_node
*rn
;
341 struct static_route
*si
;
342 struct interface
*ifp
;
344 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
345 for (si
= rn
->info
; si
; si
= si
->next
) {
346 if (strcmp(svrf
->vrf
->name
, si
->nh_vrfname
) != 0)
349 si
->nh_vrf_id
= svrf
->vrf
->vrf_id
;
350 si
->nh_registered
= false;
352 ifp
= if_lookup_by_name(si
->ifname
,
355 si
->ifindex
= ifp
->ifindex
;
360 static_install_route(rn
, si
, safi
);
366 * This function enables static routes in a svrf as it
367 * is coming up. It sets the new vrf_id as appropriate.
369 * svrf -> The svrf that is being brought up and enabled by the kernel
370 * stable -> The stable we are looking at.
371 * afi -> the afi in question
372 * safi -> the safi in question
374 static void static_enable_vrf(struct static_vrf
*svrf
,
375 struct route_table
*stable
,
376 afi_t afi
, safi_t safi
)
378 struct route_node
*rn
;
379 struct static_route
*si
;
380 struct interface
*ifp
;
381 struct vrf
*vrf
= svrf
->vrf
;
383 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
384 for (si
= rn
->info
; si
; si
= si
->next
) {
385 si
->vrf_id
= vrf
->vrf_id
;
387 ifp
= if_lookup_by_name(si
->ifname
,
390 si
->ifindex
= ifp
->ifindex
;
394 static_install_route(rn
, si
, safi
);
400 * When a vrf is being enabled by the kernel, go through all the
401 * static routes in the system that use this vrf (both nexthops vrfs
402 * and the routes vrf )
404 * enable_svrf -> the vrf being enabled
406 void static_fixup_vrf_ids(struct static_vrf
*enable_svrf
)
408 struct route_table
*stable
;
413 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
414 struct static_vrf
*svrf
;
417 /* Install any static routes configured for this VRF. */
418 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
419 for (safi
= SAFI_UNICAST
; safi
< SAFI_MAX
; safi
++) {
420 stable
= svrf
->stable
[afi
][safi
];
424 static_fixup_vrf(enable_svrf
, stable
,
427 if (enable_svrf
== svrf
)
428 static_enable_vrf(svrf
, stable
,
436 * Look at the specified stable and if any of the routes in
437 * this table are using the svrf as the nexthop, uninstall
440 * svrf -> the vrf being disabled
441 * stable -> the table we need to look at.
442 * afi -> the afi in question
443 * safi -> the safi in question
445 static void static_cleanup_vrf(struct static_vrf
*svrf
,
446 struct route_table
*stable
,
447 afi_t afi
, safi_t safi
)
449 struct route_node
*rn
;
450 struct static_route
*si
;
452 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
453 for (si
= rn
->info
; si
; si
= si
->next
) {
454 if (strcmp(svrf
->vrf
->name
, si
->nh_vrfname
) != 0)
457 static_uninstall_route(si
->vrf_id
, safi
, rn
, si
);
463 * Look at all static routes in this table and uninstall
466 * stable -> The table to uninstall from
467 * afi -> The afi in question
468 * safi -> the safi in question
470 static void static_disable_vrf(struct route_table
*stable
,
471 afi_t afi
, safi_t safi
)
473 struct route_node
*rn
;
474 struct static_route
*si
;
476 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
))
477 for (si
= rn
->info
; si
; si
= si
->next
)
478 static_uninstall_route(si
->vrf_id
, safi
, rn
, si
);
482 * When the disable_svrf is shutdown by the kernel, we call
483 * this function and it cleans up all static routes using
484 * this vrf as a nexthop as well as all static routes
487 * disable_svrf - The vrf being disabled
489 void static_cleanup_vrf_ids(struct static_vrf
*disable_svrf
)
495 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
496 struct static_vrf
*svrf
;
500 /* Uninstall any static routes configured for this VRF. */
501 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
502 for (safi
= SAFI_UNICAST
; safi
< SAFI_MAX
; safi
++) {
503 struct route_table
*stable
;
505 stable
= svrf
->stable
[afi
][safi
];
509 static_cleanup_vrf(disable_svrf
, stable
,
512 if (disable_svrf
== svrf
)
513 static_disable_vrf(stable
, afi
, safi
);
520 * This function enables static routes when an interface it relies
521 * on in a different vrf is coming up.
523 * stable -> The stable we are looking at.
524 * ifp -> interface coming up
525 * afi -> the afi in question
526 * safi -> the safi in question
528 static void static_fixup_intf_nh(struct route_table
*stable
,
529 struct interface
*ifp
,
530 afi_t afi
, safi_t safi
)
532 struct route_node
*rn
;
533 struct static_route
*si
;
535 for (rn
= route_top(stable
); rn
; rn
= route_next(rn
)) {
536 for (si
= rn
->info
; si
; si
= si
->next
) {
537 if (si
->nh_vrf_id
!= ifp
->vrf_id
)
540 if (si
->ifindex
!= ifp
->ifindex
)
543 static_install_route(rn
, si
, safi
);
549 * This function enables static routes that rely on an interface in
550 * a different vrf when that interface comes up.
552 void static_install_intf_nh(struct interface
*ifp
)
554 struct route_table
*stable
;
559 RB_FOREACH(vrf
, vrf_name_head
, &vrfs_by_name
) {
560 struct static_vrf
*svrf
= vrf
->info
;
562 /* Not needed if same vrf since happens naturally */
563 if (vrf
->vrf_id
== ifp
->vrf_id
)
566 /* Install any static routes configured for this interface. */
567 for (afi
= AFI_IP
; afi
< AFI_MAX
; afi
++) {
568 for (safi
= SAFI_UNICAST
; safi
< SAFI_MAX
; safi
++) {
569 stable
= svrf
->stable
[afi
][safi
];
573 static_fixup_intf_nh(stable
, ifp
, afi
, safi
);
579 /* called from if_{add,delete}_update, i.e. when ifindex becomes [in]valid */
580 void static_ifindex_update(struct interface
*ifp
, bool up
)
582 static_ifindex_update_af(ifp
, up
, AFI_IP
, SAFI_UNICAST
);
583 static_ifindex_update_af(ifp
, up
, AFI_IP
, SAFI_MULTICAST
);
584 static_ifindex_update_af(ifp
, up
, AFI_IP6
, SAFI_UNICAST
);
585 static_ifindex_update_af(ifp
, up
, AFI_IP6
, SAFI_MULTICAST
);