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
)
87 /* Install any static reliant on this interface coming up */
88 static_install_intf_nh(ifp
);
89 static_ifindex_update(ifp
, true);
94 static int static_ifp_down(struct interface
*ifp
)
96 static_ifindex_update(ifp
, false);
101 static int route_notify_owner(ZAPI_CALLBACK_ARGS
)
104 enum zapi_route_notify_owner note
;
107 if (!zapi_route_notify_decode(zclient
->ibuf
, &p
, &table_id
, ¬e
,
112 case ZAPI_ROUTE_FAIL_INSTALL
:
113 static_nht_mark_state(&p
, vrf_id
, STATIC_NOT_INSTALLED
);
114 zlog_warn("%s: Route %pFX failed to install for table: %u",
115 __func__
, &p
, table_id
);
117 case ZAPI_ROUTE_BETTER_ADMIN_WON
:
118 static_nht_mark_state(&p
, vrf_id
, STATIC_NOT_INSTALLED
);
120 "%s: Route %pFX over-ridden by better route for table: %u",
121 __func__
, &p
, table_id
);
123 case ZAPI_ROUTE_INSTALLED
:
124 static_nht_mark_state(&p
, vrf_id
, STATIC_INSTALLED
);
126 case ZAPI_ROUTE_REMOVED
:
127 static_nht_mark_state(&p
, vrf_id
, STATIC_NOT_INSTALLED
);
129 case ZAPI_ROUTE_REMOVE_FAIL
:
130 static_nht_mark_state(&p
, vrf_id
, STATIC_INSTALLED
);
131 zlog_warn("%s: Route %pFX failure to remove for table: %u",
132 __func__
, &p
, table_id
);
138 static void zebra_connected(struct zclient
*zclient
)
140 zclient_send_reg_requests(zclient
, VRF_DEFAULT
);
143 struct static_nht_data
{
152 /* API to check whether the configured nexthop address is
153 * one of its local connected address or not.
156 static_nexthop_is_local(vrf_id_t vrfid
, struct prefix
*addr
, int family
)
158 if (family
== AF_INET
) {
159 if (if_address_is_local(&addr
->u
.prefix4
, AF_INET
, vrfid
))
161 } else if (family
== AF_INET6
) {
162 if (if_address_is_local(&addr
->u
.prefix6
, AF_INET6
, vrfid
))
167 static int static_zebra_nexthop_update(ZAPI_CALLBACK_ARGS
)
169 struct static_nht_data
*nhtd
, lookup
;
170 struct zapi_route nhr
;
173 if (!zapi_nexthop_update_decode(zclient
->ibuf
, &nhr
)) {
174 zlog_err("Failure to decode nexthop update message");
178 if (nhr
.prefix
.family
== AF_INET6
)
181 if (nhr
.type
== ZEBRA_ROUTE_CONNECT
) {
182 if (static_nexthop_is_local(vrf_id
, &nhr
.prefix
,
187 memset(&lookup
, 0, sizeof(lookup
));
188 lookup
.nh
= &nhr
.prefix
;
189 lookup
.nh_vrf_id
= vrf_id
;
191 nhtd
= hash_lookup(static_nht_hash
, &lookup
);
194 nhtd
->nh_num
= nhr
.nexthop_num
;
196 static_nht_reset_start(&nhr
.prefix
, afi
, nhtd
->nh_vrf_id
);
197 static_nht_update(NULL
, &nhr
.prefix
, nhr
.nexthop_num
, afi
,
200 zlog_err("No nhtd?");
205 static void static_zebra_capabilities(struct zclient_capabilities
*cap
)
207 mpls_enabled
= cap
->mpls_enabled
;
210 static unsigned int static_nht_hash_key(const void *data
)
212 const struct static_nht_data
*nhtd
= data
;
213 unsigned int key
= 0;
215 key
= prefix_hash_key(nhtd
->nh
);
216 return jhash_1word(nhtd
->nh_vrf_id
, key
);
219 static bool static_nht_hash_cmp(const void *d1
, const void *d2
)
221 const struct static_nht_data
*nhtd1
= d1
;
222 const struct static_nht_data
*nhtd2
= d2
;
224 if (nhtd1
->nh_vrf_id
!= nhtd2
->nh_vrf_id
)
227 return prefix_same(nhtd1
->nh
, nhtd2
->nh
);
230 static void *static_nht_hash_alloc(void *data
)
232 struct static_nht_data
*copy
= data
;
233 struct static_nht_data
*new;
235 new = XMALLOC(MTYPE_TMP
, sizeof(*new));
237 new->nh
= prefix_new();
238 prefix_copy(new->nh
, copy
->nh
);
241 new->nh_vrf_id
= copy
->nh_vrf_id
;
246 static void static_nht_hash_free(void *data
)
248 struct static_nht_data
*nhtd
= data
;
250 prefix_free(&nhtd
->nh
);
251 XFREE(MTYPE_TMP
, nhtd
);
254 void static_zebra_nht_register(struct static_nexthop
*nh
, bool reg
)
256 struct static_path
*pn
= nh
->pn
;
257 struct route_node
*rn
= pn
->rn
;
258 struct static_nht_data
*nhtd
, lookup
;
264 ZEBRA_NEXTHOP_REGISTER
: ZEBRA_NEXTHOP_UNREGISTER
;
266 if (nh
->nh_registered
&& reg
)
269 if (!nh
->nh_registered
&& !reg
)
272 memset(&p
, 0, sizeof(p
));
275 case STATIC_BLACKHOLE
:
277 case STATIC_IPV4_GATEWAY
:
278 case STATIC_IPV4_GATEWAY_IFNAME
:
280 p
.prefixlen
= IPV4_MAX_BITLEN
;
281 p
.u
.prefix4
= nh
->addr
.ipv4
;
284 case STATIC_IPV6_GATEWAY
:
285 case STATIC_IPV6_GATEWAY_IFNAME
:
287 p
.prefixlen
= IPV6_MAX_BITLEN
;
288 p
.u
.prefix6
= nh
->addr
.ipv6
;
293 memset(&lookup
, 0, sizeof(lookup
));
295 lookup
.nh_vrf_id
= nh
->nh_vrf_id
;
297 nh
->nh_registered
= reg
;
300 nhtd
= hash_get(static_nht_hash
, &lookup
,
301 static_nht_hash_alloc
);
304 DEBUGD(&static_dbg_route
,
305 "Registered nexthop(%pFX) for %pRN %d", &p
, rn
,
307 if (nhtd
->refcount
> 1 && nhtd
->nh_num
) {
308 static_nht_update(&rn
->p
, nhtd
->nh
, nhtd
->nh_num
, afi
,
313 nhtd
= hash_lookup(static_nht_hash
, &lookup
);
318 if (nhtd
->refcount
>= 1)
321 hash_release(static_nht_hash
, nhtd
);
322 static_nht_hash_free(nhtd
);
325 if (zclient_send_rnh(zclient
, cmd
, &p
, false, false, nh
->nh_vrf_id
)
326 == ZCLIENT_SEND_FAILURE
)
327 zlog_warn("%s: Failure to send nexthop to zebra", __func__
);
330 * When nexthop gets updated via configuration then use the
331 * already registered NH and resend the route to zebra
333 int static_zebra_nh_update(struct static_nexthop
*nh
)
335 struct static_path
*pn
= nh
->pn
;
336 struct route_node
*rn
= pn
->rn
;
337 struct static_nht_data
*nhtd
, lookup
= {};
338 struct prefix p
= {};
341 if (!nh
->nh_registered
)
346 case STATIC_BLACKHOLE
:
348 case STATIC_IPV4_GATEWAY
:
349 case STATIC_IPV4_GATEWAY_IFNAME
:
351 p
.prefixlen
= IPV4_MAX_BITLEN
;
352 p
.u
.prefix4
= nh
->addr
.ipv4
;
355 case STATIC_IPV6_GATEWAY
:
356 case STATIC_IPV6_GATEWAY_IFNAME
:
358 p
.prefixlen
= IPV6_MAX_BITLEN
;
359 p
.u
.prefix6
= nh
->addr
.ipv6
;
365 lookup
.nh_vrf_id
= nh
->nh_vrf_id
;
367 nhtd
= hash_lookup(static_nht_hash
, &lookup
);
368 if (nhtd
&& nhtd
->nh_num
) {
369 nh
->state
= STATIC_START
;
370 static_nht_update(&rn
->p
, nhtd
->nh
, nhtd
->nh_num
, afi
,
377 extern void static_zebra_route_add(struct static_path
*pn
, bool install
)
379 struct route_node
*rn
= pn
->rn
;
380 struct static_route_info
*si
= rn
->info
;
381 struct static_nexthop
*nh
;
382 const struct prefix
*p
, *src_pp
;
383 struct zapi_nexthop
*api_nh
;
384 struct zapi_route api
;
388 srcdest_rnode_prefixes(rn
, &p
, &src_pp
);
390 memset(&api
, 0, sizeof(api
));
391 api
.vrf_id
= si
->svrf
->vrf
->vrf_id
;
392 api
.type
= ZEBRA_ROUTE_STATIC
;
394 memcpy(&api
.prefix
, p
, sizeof(api
.prefix
));
397 SET_FLAG(api
.message
, ZAPI_MESSAGE_SRCPFX
);
398 memcpy(&api
.src_prefix
, src_pp
, sizeof(api
.src_prefix
));
400 SET_FLAG(api
.flags
, ZEBRA_FLAG_RR_USE_DISTANCE
);
401 SET_FLAG(api
.flags
, ZEBRA_FLAG_ALLOW_RECURSION
);
402 SET_FLAG(api
.message
, ZAPI_MESSAGE_NEXTHOP
);
404 SET_FLAG(api
.message
, ZAPI_MESSAGE_DISTANCE
);
405 api
.distance
= pn
->distance
;
408 SET_FLAG(api
.message
, ZAPI_MESSAGE_TAG
);
411 if (pn
->table_id
!= 0) {
412 SET_FLAG(api
.message
, ZAPI_MESSAGE_TABLEID
);
413 api
.tableid
= pn
->table_id
;
415 frr_each(static_nexthop_list
, &pn
->nexthop_list
, nh
) {
416 api_nh
= &api
.nexthops
[nh_num
];
417 if (nh
->nh_vrf_id
== VRF_UNKNOWN
)
420 api_nh
->vrf_id
= nh
->nh_vrf_id
;
422 SET_FLAG(api_nh
->flags
, ZAPI_NEXTHOP_FLAG_ONLINK
);
423 if (nh
->color
!= 0) {
424 SET_FLAG(api
.message
, ZAPI_MESSAGE_SRTE
);
425 api_nh
->srte_color
= nh
->color
;
428 nh
->state
= STATIC_SENT_TO_ZEBRA
;
432 if (nh
->ifindex
== IFINDEX_INTERNAL
)
434 api_nh
->ifindex
= nh
->ifindex
;
435 api_nh
->type
= NEXTHOP_TYPE_IFINDEX
;
437 case STATIC_IPV4_GATEWAY
:
440 api_nh
->type
= NEXTHOP_TYPE_IPV4
;
441 api_nh
->gate
= nh
->addr
;
443 case STATIC_IPV4_GATEWAY_IFNAME
:
444 if (nh
->ifindex
== IFINDEX_INTERNAL
)
446 api_nh
->ifindex
= nh
->ifindex
;
447 api_nh
->type
= NEXTHOP_TYPE_IPV4_IFINDEX
;
448 api_nh
->gate
= nh
->addr
;
450 case STATIC_IPV6_GATEWAY
:
453 api_nh
->type
= NEXTHOP_TYPE_IPV6
;
454 api_nh
->gate
= nh
->addr
;
456 case STATIC_IPV6_GATEWAY_IFNAME
:
457 if (nh
->ifindex
== IFINDEX_INTERNAL
)
459 api_nh
->type
= NEXTHOP_TYPE_IPV6_IFINDEX
;
460 api_nh
->ifindex
= nh
->ifindex
;
461 api_nh
->gate
= nh
->addr
;
463 case STATIC_BLACKHOLE
:
464 api_nh
->type
= NEXTHOP_TYPE_BLACKHOLE
;
465 switch (nh
->bh_type
) {
466 case STATIC_BLACKHOLE_DROP
:
467 case STATIC_BLACKHOLE_NULL
:
468 api_nh
->bh_type
= BLACKHOLE_NULL
;
470 case STATIC_BLACKHOLE_REJECT
:
471 api_nh
->bh_type
= BLACKHOLE_REJECT
;
476 if (nh
->snh_label
.num_labels
) {
479 SET_FLAG(api_nh
->flags
, ZAPI_NEXTHOP_FLAG_LABEL
);
480 api_nh
->label_num
= nh
->snh_label
.num_labels
;
481 for (i
= 0; i
< api_nh
->label_num
; i
++)
482 api_nh
->labels
[i
] = nh
->snh_label
.label
[i
];
487 api
.nexthop_num
= nh_num
;
490 * If we have been given an install but nothing is valid
491 * go ahead and delete the route for double plus fun
493 if (!nh_num
&& install
)
496 zclient_route_send(install
?
497 ZEBRA_ROUTE_ADD
: ZEBRA_ROUTE_DELETE
,
501 static zclient_handler
*const static_handlers
[] = {
502 [ZEBRA_INTERFACE_ADDRESS_ADD
] = interface_address_add
,
503 [ZEBRA_INTERFACE_ADDRESS_DELETE
] = interface_address_delete
,
504 [ZEBRA_ROUTE_NOTIFY_OWNER
] = route_notify_owner
,
505 [ZEBRA_NEXTHOP_UPDATE
] = static_zebra_nexthop_update
,
508 void static_zebra_init(void)
510 struct zclient_options opt
= { .receive_notify
= true };
512 if_zapi_callbacks(static_ifp_create
, static_ifp_up
,
513 static_ifp_down
, static_ifp_destroy
);
515 zclient
= zclient_new(master
, &opt
, static_handlers
,
516 array_size(static_handlers
));
518 zclient_init(zclient
, ZEBRA_ROUTE_STATIC
, 0, &static_privs
);
519 zclient
->zebra_capabilities
= static_zebra_capabilities
;
520 zclient
->zebra_connected
= zebra_connected
;
522 static_nht_hash
= hash_create(static_nht_hash_key
,
524 "Static Nexthop Tracking hash");
527 /* static_zebra_stop used by tests/lib/test_grpc.cpp */
528 void static_zebra_stop(void)
532 zclient_stop(zclient
);
533 zclient_free(zclient
);
537 void static_zebra_vrf_register(struct vrf
*vrf
)
539 if (vrf
->vrf_id
== VRF_DEFAULT
)
541 zclient_send_reg_requests(zclient
, vrf
->vrf_id
);
544 void static_zebra_vrf_unregister(struct vrf
*vrf
)
546 if (vrf
->vrf_id
== VRF_DEFAULT
)
548 zclient_send_dereg_requests(zclient
, vrf
->vrf_id
);