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
28 #include "srcdest_table.h"
36 #include "nexthop_group.h"
40 #include "static_vrf.h"
41 #include "static_routes.h"
42 #include "static_zebra.h"
43 #include "static_nht.h"
44 #include "static_vty.h"
45 #include "static_debug.h"
47 /* Zebra structure to hold current status. */
48 struct zclient
*zclient
;
49 static struct hash
*static_nht_hash
;
51 /* Inteface addition message from zebra. */
52 static int static_ifp_create(struct interface
*ifp
)
54 static_ifindex_update(ifp
, true);
59 static int static_ifp_destroy(struct interface
*ifp
)
61 static_ifindex_update(ifp
, false);
65 static int interface_address_add(ZAPI_CALLBACK_ARGS
)
67 zebra_interface_address_read(cmd
, zclient
->ibuf
, vrf_id
);
72 static int interface_address_delete(ZAPI_CALLBACK_ARGS
)
76 c
= zebra_interface_address_read(cmd
, zclient
->ibuf
, vrf_id
);
85 static int static_ifp_up(struct interface
*ifp
)
88 struct static_vrf
*svrf
= static_vrf_lookup_by_id(ifp
->vrf_id
);
90 static_fixup_vrf_ids(svrf
);
93 /* Install any static reliant on this interface coming up */
94 static_install_intf_nh(ifp
);
95 static_ifindex_update(ifp
, true);
100 static int static_ifp_down(struct interface
*ifp
)
102 static_ifindex_update(ifp
, false);
107 static int route_notify_owner(ZAPI_CALLBACK_ARGS
)
110 enum zapi_route_notify_owner note
;
113 if (!zapi_route_notify_decode(zclient
->ibuf
, &p
, &table_id
, ¬e
,
118 case ZAPI_ROUTE_FAIL_INSTALL
:
119 static_nht_mark_state(&p
, vrf_id
, STATIC_NOT_INSTALLED
);
120 zlog_warn("%s: Route %pFX failed to install for table: %u",
121 __func__
, &p
, table_id
);
123 case ZAPI_ROUTE_BETTER_ADMIN_WON
:
124 static_nht_mark_state(&p
, vrf_id
, STATIC_NOT_INSTALLED
);
126 "%s: Route %pFX over-ridden by better route for table: %u",
127 __func__
, &p
, table_id
);
129 case ZAPI_ROUTE_INSTALLED
:
130 static_nht_mark_state(&p
, vrf_id
, STATIC_INSTALLED
);
132 case ZAPI_ROUTE_REMOVED
:
133 static_nht_mark_state(&p
, vrf_id
, STATIC_NOT_INSTALLED
);
135 case ZAPI_ROUTE_REMOVE_FAIL
:
136 static_nht_mark_state(&p
, vrf_id
, STATIC_INSTALLED
);
137 zlog_warn("%s: Route %pFX failure to remove for table: %u",
138 __func__
, &p
, table_id
);
144 static void zebra_connected(struct zclient
*zclient
)
146 zclient_send_reg_requests(zclient
, VRF_DEFAULT
);
149 struct static_nht_data
{
158 /* API to check whether the configured nexthop address is
159 * one of its local connected address or not.
162 static_nexthop_is_local(vrf_id_t vrfid
, struct prefix
*addr
, int family
)
164 if (family
== AF_INET
) {
165 if (if_lookup_exact_address(&addr
->u
.prefix4
,
169 } else if (family
== AF_INET6
) {
170 if (if_lookup_exact_address(&addr
->u
.prefix6
,
177 static int static_zebra_nexthop_update(ZAPI_CALLBACK_ARGS
)
179 struct static_nht_data
*nhtd
, lookup
;
180 struct zapi_route nhr
;
183 if (!zapi_nexthop_update_decode(zclient
->ibuf
, &nhr
)) {
184 zlog_err("Failure to decode nexthop update message");
188 if (nhr
.prefix
.family
== AF_INET6
)
191 if (nhr
.type
== ZEBRA_ROUTE_CONNECT
) {
192 if (static_nexthop_is_local(vrf_id
, &nhr
.prefix
,
197 memset(&lookup
, 0, sizeof(lookup
));
198 lookup
.nh
= &nhr
.prefix
;
199 lookup
.nh_vrf_id
= vrf_id
;
201 nhtd
= hash_lookup(static_nht_hash
, &lookup
);
204 nhtd
->nh_num
= nhr
.nexthop_num
;
206 static_nht_reset_start(&nhr
.prefix
, afi
, nhtd
->nh_vrf_id
);
207 static_nht_update(NULL
, &nhr
.prefix
, nhr
.nexthop_num
, afi
,
210 zlog_err("No nhtd?");
215 static void static_zebra_capabilities(struct zclient_capabilities
*cap
)
217 mpls_enabled
= cap
->mpls_enabled
;
220 static unsigned int static_nht_hash_key(const void *data
)
222 const struct static_nht_data
*nhtd
= data
;
223 unsigned int key
= 0;
225 key
= prefix_hash_key(nhtd
->nh
);
226 return jhash_1word(nhtd
->nh_vrf_id
, key
);
229 static bool static_nht_hash_cmp(const void *d1
, const void *d2
)
231 const struct static_nht_data
*nhtd1
= d1
;
232 const struct static_nht_data
*nhtd2
= d2
;
234 if (nhtd1
->nh_vrf_id
!= nhtd2
->nh_vrf_id
)
237 return prefix_same(nhtd1
->nh
, nhtd2
->nh
);
240 static void *static_nht_hash_alloc(void *data
)
242 struct static_nht_data
*copy
= data
;
243 struct static_nht_data
*new;
245 new = XMALLOC(MTYPE_TMP
, sizeof(*new));
247 new->nh
= prefix_new();
248 prefix_copy(new->nh
, copy
->nh
);
251 new->nh_vrf_id
= copy
->nh_vrf_id
;
256 static void static_nht_hash_free(void *data
)
258 struct static_nht_data
*nhtd
= data
;
260 prefix_free(&nhtd
->nh
);
261 XFREE(MTYPE_TMP
, nhtd
);
264 void static_zebra_nht_register(struct static_nexthop
*nh
, bool reg
)
266 struct static_path
*pn
= nh
->pn
;
267 struct route_node
*rn
= pn
->rn
;
268 struct static_nht_data
*nhtd
, lookup
;
274 ZEBRA_NEXTHOP_REGISTER
: ZEBRA_NEXTHOP_UNREGISTER
;
276 if (nh
->nh_registered
&& reg
)
279 if (!nh
->nh_registered
&& !reg
)
282 memset(&p
, 0, sizeof(p
));
285 case STATIC_BLACKHOLE
:
287 case STATIC_IPV4_GATEWAY
:
288 case STATIC_IPV4_GATEWAY_IFNAME
:
290 p
.prefixlen
= IPV4_MAX_BITLEN
;
291 p
.u
.prefix4
= nh
->addr
.ipv4
;
294 case STATIC_IPV6_GATEWAY
:
295 case STATIC_IPV6_GATEWAY_IFNAME
:
297 p
.prefixlen
= IPV6_MAX_BITLEN
;
298 p
.u
.prefix6
= nh
->addr
.ipv6
;
303 memset(&lookup
, 0, sizeof(lookup
));
305 lookup
.nh_vrf_id
= nh
->nh_vrf_id
;
307 nh
->nh_registered
= reg
;
310 nhtd
= hash_get(static_nht_hash
, &lookup
,
311 static_nht_hash_alloc
);
314 DEBUGD(&static_dbg_route
,
315 "Registered nexthop(%pFX) for %pRN %d", &p
, rn
,
317 if (nhtd
->refcount
> 1 && nhtd
->nh_num
) {
318 static_nht_update(&rn
->p
, nhtd
->nh
, nhtd
->nh_num
, afi
,
323 nhtd
= hash_lookup(static_nht_hash
, &lookup
);
328 if (nhtd
->refcount
>= 1)
331 hash_release(static_nht_hash
, nhtd
);
332 static_nht_hash_free(nhtd
);
335 if (zclient_send_rnh(zclient
, cmd
, &p
, false, nh
->nh_vrf_id
)
336 == ZCLIENT_SEND_FAILURE
)
337 zlog_warn("%s: Failure to send nexthop to zebra", __func__
);
340 * When nexthop gets updated via configuration then use the
341 * already registered NH and resend the route to zebra
343 int static_zebra_nh_update(struct static_nexthop
*nh
)
345 struct static_path
*pn
= nh
->pn
;
346 struct route_node
*rn
= pn
->rn
;
347 struct static_nht_data
*nhtd
, lookup
= {};
348 struct prefix p
= {};
351 if (!nh
->nh_registered
)
356 case STATIC_BLACKHOLE
:
358 case STATIC_IPV4_GATEWAY
:
359 case STATIC_IPV4_GATEWAY_IFNAME
:
361 p
.prefixlen
= IPV4_MAX_BITLEN
;
362 p
.u
.prefix4
= nh
->addr
.ipv4
;
365 case STATIC_IPV6_GATEWAY
:
366 case STATIC_IPV6_GATEWAY_IFNAME
:
368 p
.prefixlen
= IPV6_MAX_BITLEN
;
369 p
.u
.prefix6
= nh
->addr
.ipv6
;
375 lookup
.nh_vrf_id
= nh
->nh_vrf_id
;
377 nhtd
= hash_lookup(static_nht_hash
, &lookup
);
378 if (nhtd
&& nhtd
->nh_num
) {
379 nh
->state
= STATIC_START
;
380 static_nht_update(&rn
->p
, nhtd
->nh
, nhtd
->nh_num
, afi
,
387 extern void static_zebra_route_add(struct static_path
*pn
, bool install
)
389 struct route_node
*rn
= pn
->rn
;
390 struct static_route_info
*si
= rn
->info
;
391 struct static_nexthop
*nh
;
392 const struct prefix
*p
, *src_pp
;
393 struct zapi_nexthop
*api_nh
;
394 struct zapi_route api
;
398 srcdest_rnode_prefixes(rn
, &p
, &src_pp
);
400 memset(&api
, 0, sizeof(api
));
401 api
.vrf_id
= si
->svrf
->vrf
->vrf_id
;
402 api
.type
= ZEBRA_ROUTE_STATIC
;
404 memcpy(&api
.prefix
, p
, sizeof(api
.prefix
));
407 SET_FLAG(api
.message
, ZAPI_MESSAGE_SRCPFX
);
408 memcpy(&api
.src_prefix
, src_pp
, sizeof(api
.src_prefix
));
410 SET_FLAG(api
.flags
, ZEBRA_FLAG_RR_USE_DISTANCE
);
411 SET_FLAG(api
.flags
, ZEBRA_FLAG_ALLOW_RECURSION
);
412 SET_FLAG(api
.message
, ZAPI_MESSAGE_NEXTHOP
);
414 SET_FLAG(api
.message
, ZAPI_MESSAGE_DISTANCE
);
415 api
.distance
= pn
->distance
;
418 SET_FLAG(api
.message
, ZAPI_MESSAGE_TAG
);
421 if (pn
->table_id
!= 0) {
422 SET_FLAG(api
.message
, ZAPI_MESSAGE_TABLEID
);
423 api
.tableid
= pn
->table_id
;
425 frr_each(static_nexthop_list
, &pn
->nexthop_list
, nh
) {
426 api_nh
= &api
.nexthops
[nh_num
];
427 if (nh
->nh_vrf_id
== VRF_UNKNOWN
)
430 api_nh
->vrf_id
= nh
->nh_vrf_id
;
432 SET_FLAG(api_nh
->flags
, ZAPI_NEXTHOP_FLAG_ONLINK
);
433 if (nh
->color
!= 0) {
434 SET_FLAG(api
.message
, ZAPI_MESSAGE_SRTE
);
435 api_nh
->srte_color
= nh
->color
;
438 nh
->state
= STATIC_SENT_TO_ZEBRA
;
442 if (nh
->ifindex
== IFINDEX_INTERNAL
)
444 api_nh
->ifindex
= nh
->ifindex
;
445 api_nh
->type
= NEXTHOP_TYPE_IFINDEX
;
447 case STATIC_IPV4_GATEWAY
:
450 api_nh
->type
= NEXTHOP_TYPE_IPV4
;
451 api_nh
->gate
= nh
->addr
;
453 case STATIC_IPV4_GATEWAY_IFNAME
:
454 if (nh
->ifindex
== IFINDEX_INTERNAL
)
456 api_nh
->ifindex
= nh
->ifindex
;
457 api_nh
->type
= NEXTHOP_TYPE_IPV4_IFINDEX
;
458 api_nh
->gate
= nh
->addr
;
460 case STATIC_IPV6_GATEWAY
:
463 api_nh
->type
= NEXTHOP_TYPE_IPV6
;
464 api_nh
->gate
= nh
->addr
;
466 case STATIC_IPV6_GATEWAY_IFNAME
:
467 if (nh
->ifindex
== IFINDEX_INTERNAL
)
469 api_nh
->type
= NEXTHOP_TYPE_IPV6_IFINDEX
;
470 api_nh
->ifindex
= nh
->ifindex
;
471 api_nh
->gate
= nh
->addr
;
473 case STATIC_BLACKHOLE
:
474 api_nh
->type
= NEXTHOP_TYPE_BLACKHOLE
;
475 switch (nh
->bh_type
) {
476 case STATIC_BLACKHOLE_DROP
:
477 case STATIC_BLACKHOLE_NULL
:
478 api_nh
->bh_type
= BLACKHOLE_NULL
;
480 case STATIC_BLACKHOLE_REJECT
:
481 api_nh
->bh_type
= BLACKHOLE_REJECT
;
486 if (nh
->snh_label
.num_labels
) {
489 SET_FLAG(api_nh
->flags
, ZAPI_NEXTHOP_FLAG_LABEL
);
490 api_nh
->label_num
= nh
->snh_label
.num_labels
;
491 for (i
= 0; i
< api_nh
->label_num
; i
++)
492 api_nh
->labels
[i
] = nh
->snh_label
.label
[i
];
497 api
.nexthop_num
= nh_num
;
500 * If we have been given an install but nothing is valid
501 * go ahead and delete the route for double plus fun
503 if (!nh_num
&& install
)
506 zclient_route_send(install
?
507 ZEBRA_ROUTE_ADD
: ZEBRA_ROUTE_DELETE
,
511 void static_zebra_init(void)
513 struct zclient_options opt
= { .receive_notify
= true };
515 if_zapi_callbacks(static_ifp_create
, static_ifp_up
,
516 static_ifp_down
, static_ifp_destroy
);
518 zclient
= zclient_new(master
, &opt
);
520 zclient_init(zclient
, ZEBRA_ROUTE_STATIC
, 0, &static_privs
);
521 zclient
->zebra_capabilities
= static_zebra_capabilities
;
522 zclient
->zebra_connected
= zebra_connected
;
523 zclient
->interface_address_add
= interface_address_add
;
524 zclient
->interface_address_delete
= interface_address_delete
;
525 zclient
->route_notify_owner
= route_notify_owner
;
526 zclient
->nexthop_update
= static_zebra_nexthop_update
;
528 static_nht_hash
= hash_create(static_nht_hash_key
,
530 "Static Nexthop Tracking hash");
533 /* static_zebra_stop used by tests/lib/test_grpc.cpp */
534 void static_zebra_stop(void)
538 zclient_stop(zclient
);
539 zclient_free(zclient
);
543 void static_zebra_vrf_register(struct vrf
*vrf
)
545 if (vrf
->vrf_id
== VRF_DEFAULT
)
547 zclient_send_reg_requests(zclient
, vrf
->vrf_id
);
550 void static_zebra_vrf_unregister(struct vrf
*vrf
)
552 if (vrf
->vrf_id
== VRF_DEFAULT
)
554 zclient_send_dereg_requests(zclient
, vrf
->vrf_id
);