2 * Zebra dataplane layer.
3 * Copyright (c) 2018 Volta Networks, Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "lib/libfrr.h"
25 #include "lib/debug.h"
26 #include "lib/frratomic.h"
27 #include "lib/frr_pthread.h"
28 #include "lib/memory.h"
29 #include "lib/queue.h"
30 #include "lib/zebra.h"
31 #include "zebra/zebra_router.h"
32 #include "zebra/zebra_memory.h"
33 #include "zebra/zebra_router.h"
34 #include "zebra/zebra_dplane.h"
36 #include "zebra/debug.h"
38 /* Memory type for context blocks */
39 DEFINE_MTYPE_STATIC(ZEBRA
, DP_CTX
, "Zebra DPlane Ctx")
40 DEFINE_MTYPE_STATIC(ZEBRA
, DP_PROV
, "Zebra DPlane Provider")
46 /* Enable test dataplane provider */
47 /*#define DPLANE_TEST_PROVIDER 1 */
49 /* Default value for max queued incoming updates */
50 const uint32_t DPLANE_DEFAULT_MAX_QUEUED
= 200;
52 /* Default value for new work per cycle */
53 const uint32_t DPLANE_DEFAULT_NEW_WORK
= 100;
55 /* Validation check macro for context blocks */
56 /* #define DPLANE_DEBUG 1 */
60 # define DPLANE_CTX_VALID(p) \
65 # define DPLANE_CTX_VALID(p)
67 #endif /* DPLANE_DEBUG */
70 * Nexthop information captured for nexthop/nexthop group updates
72 struct dplane_nexthop_info
{
78 struct nexthop_group ng
;
79 struct nh_grp nh_grp
[MULTIPATH_NUM
];
84 * Route information captured for route updates.
86 struct dplane_route_info
{
88 /* Dest and (optional) source prefixes */
89 struct prefix zd_dest
;
99 route_tag_t zd_old_tag
;
101 uint32_t zd_old_metric
;
103 uint16_t zd_instance
;
104 uint16_t zd_old_instance
;
107 uint8_t zd_old_distance
;
110 uint32_t zd_nexthop_mtu
;
112 /* Nexthop hash entry info */
113 struct dplane_nexthop_info nhe
;
116 struct nexthop_group zd_ng
;
118 /* "Previous" nexthops, used only in route updates without netlink */
119 struct nexthop_group zd_old_ng
;
121 /* TODO -- use fixed array of nexthops, to avoid mallocs? */
126 * Pseudowire info for the dataplane
128 struct dplane_pw_info
{
134 mpls_label_t local_label
;
135 mpls_label_t remote_label
;
138 struct nexthop_group nhg
;
140 union pw_protocol_fields fields
;
144 * Interface/prefix info for the dataplane
146 struct dplane_intf_info
{
151 #define DPLANE_INTF_CONNECTED (1 << 0) /* Connected peer, p2p */
152 #define DPLANE_INTF_SECONDARY (1 << 1)
153 #define DPLANE_INTF_BROADCAST (1 << 2)
154 #define DPLANE_INTF_HAS_DEST DPLANE_INTF_CONNECTED
155 #define DPLANE_INTF_HAS_LABEL (1 << 4)
157 /* Interface address/prefix */
158 struct prefix prefix
;
160 /* Dest address, for p2p, or broadcast prefix */
161 struct prefix dest_prefix
;
168 * EVPN MAC address info for the dataplane.
170 struct dplane_mac_info
{
172 ifindex_t br_ifindex
;
174 struct in_addr vtep_ip
;
180 * EVPN neighbor info for the dataplane
182 struct dplane_neigh_info
{
183 struct ipaddr ip_addr
;
190 * The context block used to exchange info about route updates across
191 * the boundary between the zebra main context (and pthread) and the
192 * dataplane layer (and pthread).
194 struct zebra_dplane_ctx
{
197 enum dplane_op_e zd_op
;
199 /* Status on return */
200 enum zebra_dplane_result zd_status
;
202 /* Dplane provider id */
203 uint32_t zd_provider
;
205 /* Flags - used by providers, e.g. */
213 /* Some updates may be generated by notifications: allow the
214 * plugin to notice and ignore results from its own notifications.
216 uint32_t zd_notif_provider
;
218 /* TODO -- internal/sub-operation status? */
219 enum zebra_dplane_result zd_remote_status
;
220 enum zebra_dplane_result zd_kernel_status
;
223 uint32_t zd_table_id
;
225 char zd_ifname
[INTERFACE_NAMSIZ
];
226 ifindex_t zd_ifindex
;
228 /* Support info for different kinds of updates */
230 struct dplane_route_info rinfo
;
232 struct dplane_pw_info pw
;
233 struct dplane_intf_info intf
;
234 struct dplane_mac_info macinfo
;
235 struct dplane_neigh_info neigh
;
238 /* Namespace info, used especially for netlink kernel communication */
239 struct zebra_dplane_info zd_ns_info
;
241 /* Embedded list linkage */
242 TAILQ_ENTRY(zebra_dplane_ctx
) zd_q_entries
;
245 /* Flag that can be set by a pre-kernel provider as a signal that an update
246 * should bypass the kernel.
248 #define DPLANE_CTX_FLAG_NO_KERNEL 0x01
252 * Registration block for one dataplane provider.
254 struct zebra_dplane_provider
{
256 char dp_name
[DPLANE_PROVIDER_NAMELEN
+ 1];
258 /* Priority, for ordering among providers */
265 pthread_mutex_t dp_mutex
;
267 /* Plugin-provided extra data */
273 int (*dp_start
)(struct zebra_dplane_provider
*prov
);
275 int (*dp_fp
)(struct zebra_dplane_provider
*prov
);
277 int (*dp_fini
)(struct zebra_dplane_provider
*prov
, bool early_p
);
279 _Atomic
uint32_t dp_in_counter
;
280 _Atomic
uint32_t dp_in_queued
;
281 _Atomic
uint32_t dp_in_max
;
282 _Atomic
uint32_t dp_out_counter
;
283 _Atomic
uint32_t dp_out_queued
;
284 _Atomic
uint32_t dp_out_max
;
285 _Atomic
uint32_t dp_error_counter
;
287 /* Queue of contexts inbound to the provider */
288 struct dplane_ctx_q dp_ctx_in_q
;
290 /* Queue of completed contexts outbound from the provider back
291 * towards the dataplane module.
293 struct dplane_ctx_q dp_ctx_out_q
;
295 /* Embedded list linkage for provider objects */
296 TAILQ_ENTRY(zebra_dplane_provider
) dp_prov_link
;
302 static struct zebra_dplane_globals
{
303 /* Mutex to control access to dataplane components */
304 pthread_mutex_t dg_mutex
;
306 /* Results callback registered by zebra 'core' */
307 int (*dg_results_cb
)(struct dplane_ctx_q
*ctxlist
);
309 /* Sentinel for beginning of shutdown */
310 volatile bool dg_is_shutdown
;
312 /* Sentinel for end of shutdown */
313 volatile bool dg_run
;
315 /* Update context queue inbound to the dataplane */
316 TAILQ_HEAD(zdg_ctx_q
, zebra_dplane_ctx
) dg_update_ctx_q
;
318 /* Ordered list of providers */
319 TAILQ_HEAD(zdg_prov_q
, zebra_dplane_provider
) dg_providers_q
;
321 /* Counter used to assign internal ids to providers */
322 uint32_t dg_provider_id
;
324 /* Limit number of pending, unprocessed updates */
325 _Atomic
uint32_t dg_max_queued_updates
;
327 /* Control whether system route notifications should be produced. */
328 bool dg_sys_route_notifs
;
330 /* Limit number of new updates dequeued at once, to pace an
333 uint32_t dg_updates_per_cycle
;
335 _Atomic
uint32_t dg_routes_in
;
336 _Atomic
uint32_t dg_routes_queued
;
337 _Atomic
uint32_t dg_routes_queued_max
;
338 _Atomic
uint32_t dg_route_errors
;
339 _Atomic
uint32_t dg_other_errors
;
341 _Atomic
uint32_t dg_nexthops_in
;
342 _Atomic
uint32_t dg_nexthop_errors
;
344 _Atomic
uint32_t dg_lsps_in
;
345 _Atomic
uint32_t dg_lsp_errors
;
347 _Atomic
uint32_t dg_pws_in
;
348 _Atomic
uint32_t dg_pw_errors
;
350 _Atomic
uint32_t dg_intf_addrs_in
;
351 _Atomic
uint32_t dg_intf_addr_errors
;
353 _Atomic
uint32_t dg_macs_in
;
354 _Atomic
uint32_t dg_mac_errors
;
356 _Atomic
uint32_t dg_neighs_in
;
357 _Atomic
uint32_t dg_neigh_errors
;
359 _Atomic
uint32_t dg_update_yields
;
361 /* Dataplane pthread */
362 struct frr_pthread
*dg_pthread
;
364 /* Event-delivery context 'master' for the dplane */
365 struct thread_master
*dg_master
;
367 /* Event/'thread' pointer for queued updates */
368 struct thread
*dg_t_update
;
370 /* Event pointer for pending shutdown check loop */
371 struct thread
*dg_t_shutdown_check
;
376 * Lock and unlock for interactions with the zebra 'core' pthread
378 #define DPLANE_LOCK() pthread_mutex_lock(&zdplane_info.dg_mutex)
379 #define DPLANE_UNLOCK() pthread_mutex_unlock(&zdplane_info.dg_mutex)
383 * Lock and unlock for individual providers
385 #define DPLANE_PROV_LOCK(p) pthread_mutex_lock(&((p)->dp_mutex))
386 #define DPLANE_PROV_UNLOCK(p) pthread_mutex_unlock(&((p)->dp_mutex))
389 static int dplane_thread_loop(struct thread
*event
);
390 static void dplane_info_from_zns(struct zebra_dplane_info
*ns_info
,
391 struct zebra_ns
*zns
);
392 static enum zebra_dplane_result
lsp_update_internal(zebra_lsp_t
*lsp
,
393 enum dplane_op_e op
);
394 static enum zebra_dplane_result
pw_update_internal(struct zebra_pw
*pw
,
395 enum dplane_op_e op
);
396 static enum zebra_dplane_result
intf_addr_update_internal(
397 const struct interface
*ifp
, const struct connected
*ifc
,
398 enum dplane_op_e op
);
399 static enum zebra_dplane_result
mac_update_internal(
400 enum dplane_op_e op
, const struct interface
*ifp
,
401 const struct interface
*br_ifp
,
402 vlanid_t vid
, const struct ethaddr
*mac
,
403 struct in_addr vtep_ip
, bool sticky
);
404 static enum zebra_dplane_result
neigh_update_internal(
406 const struct interface
*ifp
,
407 const struct ethaddr
*mac
,
408 const struct ipaddr
*ip
,
409 uint32_t flags
, uint16_t state
);
415 /* Obtain thread_master for dataplane thread */
416 struct thread_master
*dplane_get_thread_master(void)
418 return zdplane_info
.dg_master
;
422 * Allocate a dataplane update context
424 struct zebra_dplane_ctx
*dplane_ctx_alloc(void)
426 struct zebra_dplane_ctx
*p
;
428 /* TODO -- just alloc'ing memory, but would like to maintain
431 p
= XCALLOC(MTYPE_DP_CTX
, sizeof(struct zebra_dplane_ctx
));
436 /* Enable system route notifications */
437 void dplane_enable_sys_route_notifs(void)
439 zdplane_info
.dg_sys_route_notifs
= true;
443 * Free a dataplane results context.
445 static void dplane_ctx_free(struct zebra_dplane_ctx
**pctx
)
450 DPLANE_CTX_VALID(*pctx
);
452 /* TODO -- just freeing memory, but would like to maintain
456 /* Some internal allocations may need to be freed, depending on
457 * the type of info captured in the ctx.
459 switch ((*pctx
)->zd_op
) {
460 case DPLANE_OP_ROUTE_INSTALL
:
461 case DPLANE_OP_ROUTE_UPDATE
:
462 case DPLANE_OP_ROUTE_DELETE
:
463 case DPLANE_OP_SYS_ROUTE_ADD
:
464 case DPLANE_OP_SYS_ROUTE_DELETE
:
465 case DPLANE_OP_ROUTE_NOTIFY
:
467 /* Free allocated nexthops */
468 if ((*pctx
)->u
.rinfo
.zd_ng
.nexthop
) {
469 /* This deals with recursive nexthops too */
470 nexthops_free((*pctx
)->u
.rinfo
.zd_ng
.nexthop
);
472 (*pctx
)->u
.rinfo
.zd_ng
.nexthop
= NULL
;
475 if ((*pctx
)->u
.rinfo
.zd_old_ng
.nexthop
) {
476 /* This deals with recursive nexthops too */
477 nexthops_free((*pctx
)->u
.rinfo
.zd_old_ng
.nexthop
);
479 (*pctx
)->u
.rinfo
.zd_old_ng
.nexthop
= NULL
;
484 case DPLANE_OP_NH_INSTALL
:
485 case DPLANE_OP_NH_UPDATE
:
486 case DPLANE_OP_NH_DELETE
: {
487 if ((*pctx
)->u
.rinfo
.nhe
.ng
.nexthop
) {
488 /* This deals with recursive nexthops too */
489 nexthops_free((*pctx
)->u
.rinfo
.nhe
.ng
.nexthop
);
491 (*pctx
)->u
.rinfo
.nhe
.ng
.nexthop
= NULL
;
496 case DPLANE_OP_LSP_INSTALL
:
497 case DPLANE_OP_LSP_UPDATE
:
498 case DPLANE_OP_LSP_DELETE
:
499 case DPLANE_OP_LSP_NOTIFY
:
501 zebra_nhlfe_t
*nhlfe
, *next
;
503 /* Free allocated NHLFEs */
504 for (nhlfe
= (*pctx
)->u
.lsp
.nhlfe_list
; nhlfe
; nhlfe
= next
) {
507 zebra_mpls_nhlfe_del(nhlfe
);
510 /* Clear pointers in lsp struct, in case we're cacheing
511 * free context structs.
513 (*pctx
)->u
.lsp
.nhlfe_list
= NULL
;
514 (*pctx
)->u
.lsp
.best_nhlfe
= NULL
;
519 case DPLANE_OP_PW_INSTALL
:
520 case DPLANE_OP_PW_UNINSTALL
:
521 /* Free allocated nexthops */
522 if ((*pctx
)->u
.pw
.nhg
.nexthop
) {
523 /* This deals with recursive nexthops too */
524 nexthops_free((*pctx
)->u
.pw
.nhg
.nexthop
);
526 (*pctx
)->u
.pw
.nhg
.nexthop
= NULL
;
530 case DPLANE_OP_ADDR_INSTALL
:
531 case DPLANE_OP_ADDR_UNINSTALL
:
532 /* Maybe free label string, if allocated */
533 if ((*pctx
)->u
.intf
.label
!= NULL
&&
534 (*pctx
)->u
.intf
.label
!= (*pctx
)->u
.intf
.label_buf
) {
535 free((*pctx
)->u
.intf
.label
);
536 (*pctx
)->u
.intf
.label
= NULL
;
540 case DPLANE_OP_MAC_INSTALL
:
541 case DPLANE_OP_MAC_DELETE
:
542 case DPLANE_OP_NEIGH_INSTALL
:
543 case DPLANE_OP_NEIGH_UPDATE
:
544 case DPLANE_OP_NEIGH_DELETE
:
545 case DPLANE_OP_VTEP_ADD
:
546 case DPLANE_OP_VTEP_DELETE
:
551 XFREE(MTYPE_DP_CTX
, *pctx
);
556 * Return a context block to the dplane module after processing
558 void dplane_ctx_fini(struct zebra_dplane_ctx
**pctx
)
560 /* TODO -- maintain pool; for now, just free */
561 dplane_ctx_free(pctx
);
564 /* Enqueue a context block */
565 void dplane_ctx_enqueue_tail(struct dplane_ctx_q
*q
,
566 const struct zebra_dplane_ctx
*ctx
)
568 TAILQ_INSERT_TAIL(q
, (struct zebra_dplane_ctx
*)ctx
, zd_q_entries
);
571 /* Append a list of context blocks to another list */
572 void dplane_ctx_list_append(struct dplane_ctx_q
*to_list
,
573 struct dplane_ctx_q
*from_list
)
575 if (TAILQ_FIRST(from_list
)) {
576 TAILQ_CONCAT(to_list
, from_list
, zd_q_entries
);
578 /* And clear 'from' list */
579 TAILQ_INIT(from_list
);
583 /* Dequeue a context block from the head of a list */
584 struct zebra_dplane_ctx
*dplane_ctx_dequeue(struct dplane_ctx_q
*q
)
586 struct zebra_dplane_ctx
*ctx
= TAILQ_FIRST(q
);
589 TAILQ_REMOVE(q
, ctx
, zd_q_entries
);
595 * Accessors for information from the context object
597 enum zebra_dplane_result
dplane_ctx_get_status(
598 const struct zebra_dplane_ctx
*ctx
)
600 DPLANE_CTX_VALID(ctx
);
602 return ctx
->zd_status
;
605 void dplane_ctx_set_status(struct zebra_dplane_ctx
*ctx
,
606 enum zebra_dplane_result status
)
608 DPLANE_CTX_VALID(ctx
);
610 ctx
->zd_status
= status
;
613 /* Retrieve last/current provider id */
614 uint32_t dplane_ctx_get_provider(const struct zebra_dplane_ctx
*ctx
)
616 DPLANE_CTX_VALID(ctx
);
617 return ctx
->zd_provider
;
620 /* Providers run before the kernel can control whether a kernel
621 * update should be done.
623 void dplane_ctx_set_skip_kernel(struct zebra_dplane_ctx
*ctx
)
625 DPLANE_CTX_VALID(ctx
);
627 SET_FLAG(ctx
->zd_flags
, DPLANE_CTX_FLAG_NO_KERNEL
);
630 bool dplane_ctx_is_skip_kernel(const struct zebra_dplane_ctx
*ctx
)
632 DPLANE_CTX_VALID(ctx
);
634 return CHECK_FLAG(ctx
->zd_flags
, DPLANE_CTX_FLAG_NO_KERNEL
);
637 void dplane_ctx_set_op(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
)
639 DPLANE_CTX_VALID(ctx
);
643 enum dplane_op_e
dplane_ctx_get_op(const struct zebra_dplane_ctx
*ctx
)
645 DPLANE_CTX_VALID(ctx
);
650 const char *dplane_op2str(enum dplane_op_e op
)
652 const char *ret
= "UNKNOWN";
660 case DPLANE_OP_ROUTE_INSTALL
:
661 ret
= "ROUTE_INSTALL";
663 case DPLANE_OP_ROUTE_UPDATE
:
664 ret
= "ROUTE_UPDATE";
666 case DPLANE_OP_ROUTE_DELETE
:
667 ret
= "ROUTE_DELETE";
669 case DPLANE_OP_ROUTE_NOTIFY
:
670 ret
= "ROUTE_NOTIFY";
674 case DPLANE_OP_NH_INSTALL
:
677 case DPLANE_OP_NH_UPDATE
:
680 case DPLANE_OP_NH_DELETE
:
684 case DPLANE_OP_LSP_INSTALL
:
687 case DPLANE_OP_LSP_UPDATE
:
690 case DPLANE_OP_LSP_DELETE
:
693 case DPLANE_OP_LSP_NOTIFY
:
697 case DPLANE_OP_PW_INSTALL
:
700 case DPLANE_OP_PW_UNINSTALL
:
701 ret
= "PW_UNINSTALL";
704 case DPLANE_OP_SYS_ROUTE_ADD
:
705 ret
= "SYS_ROUTE_ADD";
707 case DPLANE_OP_SYS_ROUTE_DELETE
:
708 ret
= "SYS_ROUTE_DEL";
711 case DPLANE_OP_ADDR_INSTALL
:
712 ret
= "ADDR_INSTALL";
714 case DPLANE_OP_ADDR_UNINSTALL
:
715 ret
= "ADDR_UNINSTALL";
718 case DPLANE_OP_MAC_INSTALL
:
721 case DPLANE_OP_MAC_DELETE
:
725 case DPLANE_OP_NEIGH_INSTALL
:
726 ret
= "NEIGH_INSTALL";
728 case DPLANE_OP_NEIGH_UPDATE
:
729 ret
= "NEIGH_UPDATE";
731 case DPLANE_OP_NEIGH_DELETE
:
732 ret
= "NEIGH_DELETE";
734 case DPLANE_OP_VTEP_ADD
:
737 case DPLANE_OP_VTEP_DELETE
:
745 const char *dplane_res2str(enum zebra_dplane_result res
)
747 const char *ret
= "<Unknown>";
750 case ZEBRA_DPLANE_REQUEST_FAILURE
:
753 case ZEBRA_DPLANE_REQUEST_QUEUED
:
756 case ZEBRA_DPLANE_REQUEST_SUCCESS
:
764 void dplane_ctx_set_dest(struct zebra_dplane_ctx
*ctx
,
765 const struct prefix
*dest
)
767 DPLANE_CTX_VALID(ctx
);
769 prefix_copy(&(ctx
->u
.rinfo
.zd_dest
), dest
);
772 const struct prefix
*dplane_ctx_get_dest(const struct zebra_dplane_ctx
*ctx
)
774 DPLANE_CTX_VALID(ctx
);
776 return &(ctx
->u
.rinfo
.zd_dest
);
779 void dplane_ctx_set_src(struct zebra_dplane_ctx
*ctx
, const struct prefix
*src
)
781 DPLANE_CTX_VALID(ctx
);
784 prefix_copy(&(ctx
->u
.rinfo
.zd_src
), src
);
786 memset(&(ctx
->u
.rinfo
.zd_src
), 0, sizeof(struct prefix
));
789 /* Source prefix is a little special - return NULL for "no src prefix" */
790 const struct prefix
*dplane_ctx_get_src(const struct zebra_dplane_ctx
*ctx
)
792 DPLANE_CTX_VALID(ctx
);
794 if (ctx
->u
.rinfo
.zd_src
.prefixlen
== 0 &&
795 IN6_IS_ADDR_UNSPECIFIED(&(ctx
->u
.rinfo
.zd_src
.u
.prefix6
))) {
798 return &(ctx
->u
.rinfo
.zd_src
);
802 bool dplane_ctx_is_update(const struct zebra_dplane_ctx
*ctx
)
804 DPLANE_CTX_VALID(ctx
);
806 return ctx
->zd_is_update
;
809 uint32_t dplane_ctx_get_seq(const struct zebra_dplane_ctx
*ctx
)
811 DPLANE_CTX_VALID(ctx
);
816 uint32_t dplane_ctx_get_old_seq(const struct zebra_dplane_ctx
*ctx
)
818 DPLANE_CTX_VALID(ctx
);
820 return ctx
->zd_old_seq
;
823 void dplane_ctx_set_vrf(struct zebra_dplane_ctx
*ctx
, vrf_id_t vrf
)
825 DPLANE_CTX_VALID(ctx
);
827 ctx
->zd_vrf_id
= vrf
;
830 vrf_id_t
dplane_ctx_get_vrf(const struct zebra_dplane_ctx
*ctx
)
832 DPLANE_CTX_VALID(ctx
);
834 return ctx
->zd_vrf_id
;
837 bool dplane_ctx_is_from_notif(const struct zebra_dplane_ctx
*ctx
)
839 DPLANE_CTX_VALID(ctx
);
841 return (ctx
->zd_notif_provider
!= 0);
844 uint32_t dplane_ctx_get_notif_provider(const struct zebra_dplane_ctx
*ctx
)
846 DPLANE_CTX_VALID(ctx
);
848 return ctx
->zd_notif_provider
;
851 void dplane_ctx_set_notif_provider(struct zebra_dplane_ctx
*ctx
,
854 DPLANE_CTX_VALID(ctx
);
856 ctx
->zd_notif_provider
= id
;
858 const char *dplane_ctx_get_ifname(const struct zebra_dplane_ctx
*ctx
)
860 DPLANE_CTX_VALID(ctx
);
862 return ctx
->zd_ifname
;
865 ifindex_t
dplane_ctx_get_ifindex(const struct zebra_dplane_ctx
*ctx
)
867 DPLANE_CTX_VALID(ctx
);
869 return ctx
->zd_ifindex
;
872 void dplane_ctx_set_type(struct zebra_dplane_ctx
*ctx
, int type
)
874 DPLANE_CTX_VALID(ctx
);
876 ctx
->u
.rinfo
.zd_type
= type
;
879 int dplane_ctx_get_type(const struct zebra_dplane_ctx
*ctx
)
881 DPLANE_CTX_VALID(ctx
);
883 return ctx
->u
.rinfo
.zd_type
;
886 int dplane_ctx_get_old_type(const struct zebra_dplane_ctx
*ctx
)
888 DPLANE_CTX_VALID(ctx
);
890 return ctx
->u
.rinfo
.zd_old_type
;
893 void dplane_ctx_set_afi(struct zebra_dplane_ctx
*ctx
, afi_t afi
)
895 DPLANE_CTX_VALID(ctx
);
897 ctx
->u
.rinfo
.zd_afi
= afi
;
900 afi_t
dplane_ctx_get_afi(const struct zebra_dplane_ctx
*ctx
)
902 DPLANE_CTX_VALID(ctx
);
904 return ctx
->u
.rinfo
.zd_afi
;
907 void dplane_ctx_set_safi(struct zebra_dplane_ctx
*ctx
, safi_t safi
)
909 DPLANE_CTX_VALID(ctx
);
911 ctx
->u
.rinfo
.zd_safi
= safi
;
914 safi_t
dplane_ctx_get_safi(const struct zebra_dplane_ctx
*ctx
)
916 DPLANE_CTX_VALID(ctx
);
918 return ctx
->u
.rinfo
.zd_safi
;
921 void dplane_ctx_set_table(struct zebra_dplane_ctx
*ctx
, uint32_t table
)
923 DPLANE_CTX_VALID(ctx
);
925 ctx
->zd_table_id
= table
;
928 uint32_t dplane_ctx_get_table(const struct zebra_dplane_ctx
*ctx
)
930 DPLANE_CTX_VALID(ctx
);
932 return ctx
->zd_table_id
;
935 route_tag_t
dplane_ctx_get_tag(const struct zebra_dplane_ctx
*ctx
)
937 DPLANE_CTX_VALID(ctx
);
939 return ctx
->u
.rinfo
.zd_tag
;
942 void dplane_ctx_set_tag(struct zebra_dplane_ctx
*ctx
, route_tag_t tag
)
944 DPLANE_CTX_VALID(ctx
);
946 ctx
->u
.rinfo
.zd_tag
= tag
;
949 route_tag_t
dplane_ctx_get_old_tag(const struct zebra_dplane_ctx
*ctx
)
951 DPLANE_CTX_VALID(ctx
);
953 return ctx
->u
.rinfo
.zd_old_tag
;
956 uint16_t dplane_ctx_get_instance(const struct zebra_dplane_ctx
*ctx
)
958 DPLANE_CTX_VALID(ctx
);
960 return ctx
->u
.rinfo
.zd_instance
;
963 void dplane_ctx_set_instance(struct zebra_dplane_ctx
*ctx
, uint16_t instance
)
965 DPLANE_CTX_VALID(ctx
);
967 ctx
->u
.rinfo
.zd_instance
= instance
;
970 uint16_t dplane_ctx_get_old_instance(const struct zebra_dplane_ctx
*ctx
)
972 DPLANE_CTX_VALID(ctx
);
974 return ctx
->u
.rinfo
.zd_old_instance
;
977 uint32_t dplane_ctx_get_metric(const struct zebra_dplane_ctx
*ctx
)
979 DPLANE_CTX_VALID(ctx
);
981 return ctx
->u
.rinfo
.zd_metric
;
984 uint32_t dplane_ctx_get_old_metric(const struct zebra_dplane_ctx
*ctx
)
986 DPLANE_CTX_VALID(ctx
);
988 return ctx
->u
.rinfo
.zd_old_metric
;
991 uint32_t dplane_ctx_get_mtu(const struct zebra_dplane_ctx
*ctx
)
993 DPLANE_CTX_VALID(ctx
);
995 return ctx
->u
.rinfo
.zd_mtu
;
998 uint32_t dplane_ctx_get_nh_mtu(const struct zebra_dplane_ctx
*ctx
)
1000 DPLANE_CTX_VALID(ctx
);
1002 return ctx
->u
.rinfo
.zd_nexthop_mtu
;
1005 uint8_t dplane_ctx_get_distance(const struct zebra_dplane_ctx
*ctx
)
1007 DPLANE_CTX_VALID(ctx
);
1009 return ctx
->u
.rinfo
.zd_distance
;
1012 void dplane_ctx_set_distance(struct zebra_dplane_ctx
*ctx
, uint8_t distance
)
1014 DPLANE_CTX_VALID(ctx
);
1016 ctx
->u
.rinfo
.zd_distance
= distance
;
1019 uint8_t dplane_ctx_get_old_distance(const struct zebra_dplane_ctx
*ctx
)
1021 DPLANE_CTX_VALID(ctx
);
1023 return ctx
->u
.rinfo
.zd_old_distance
;
1026 void dplane_ctx_set_nexthops(struct zebra_dplane_ctx
*ctx
, struct nexthop
*nh
)
1028 DPLANE_CTX_VALID(ctx
);
1030 if (ctx
->u
.rinfo
.zd_ng
.nexthop
) {
1031 nexthops_free(ctx
->u
.rinfo
.zd_ng
.nexthop
);
1032 ctx
->u
.rinfo
.zd_ng
.nexthop
= NULL
;
1034 copy_nexthops(&(ctx
->u
.rinfo
.zd_ng
.nexthop
), nh
, NULL
);
1037 const struct nexthop_group
*dplane_ctx_get_ng(
1038 const struct zebra_dplane_ctx
*ctx
)
1040 DPLANE_CTX_VALID(ctx
);
1042 return &(ctx
->u
.rinfo
.zd_ng
);
1045 const struct nexthop_group
*dplane_ctx_get_old_ng(
1046 const struct zebra_dplane_ctx
*ctx
)
1048 DPLANE_CTX_VALID(ctx
);
1050 return &(ctx
->u
.rinfo
.zd_old_ng
);
1053 const struct zebra_dplane_info
*dplane_ctx_get_ns(
1054 const struct zebra_dplane_ctx
*ctx
)
1056 DPLANE_CTX_VALID(ctx
);
1058 return &(ctx
->zd_ns_info
);
1061 /* Accessors for nexthop information */
1062 uint32_t dplane_ctx_get_nhe_id(const struct zebra_dplane_ctx
*ctx
)
1064 DPLANE_CTX_VALID(ctx
);
1065 return ctx
->u
.rinfo
.nhe
.id
;
1068 afi_t
dplane_ctx_get_nhe_afi(const struct zebra_dplane_ctx
*ctx
)
1070 DPLANE_CTX_VALID(ctx
);
1071 return ctx
->u
.rinfo
.nhe
.afi
;
1074 vrf_id_t
dplane_ctx_get_nhe_vrf_id(const struct zebra_dplane_ctx
*ctx
)
1076 DPLANE_CTX_VALID(ctx
);
1077 return ctx
->u
.rinfo
.nhe
.vrf_id
;
1080 bool dplane_ctx_get_nhe_is_kernel_nh(const struct zebra_dplane_ctx
*ctx
)
1082 DPLANE_CTX_VALID(ctx
);
1083 return ctx
->u
.rinfo
.nhe
.is_kernel_nh
;
1086 const struct nexthop_group
*
1087 dplane_ctx_get_nhe_ng(const struct zebra_dplane_ctx
*ctx
)
1089 DPLANE_CTX_VALID(ctx
);
1090 return &(ctx
->u
.rinfo
.nhe
.ng
);
1093 const struct nh_grp
*
1094 dplane_ctx_get_nhe_nh_grp(const struct zebra_dplane_ctx
*ctx
)
1096 DPLANE_CTX_VALID(ctx
);
1097 return ctx
->u
.rinfo
.nhe
.nh_grp
;
1100 uint8_t dplane_ctx_get_nhe_nh_grp_count(const struct zebra_dplane_ctx
*ctx
)
1102 DPLANE_CTX_VALID(ctx
);
1103 return ctx
->u
.rinfo
.nhe
.nh_grp_count
;
1106 /* Accessors for LSP information */
1108 mpls_label_t
dplane_ctx_get_in_label(const struct zebra_dplane_ctx
*ctx
)
1110 DPLANE_CTX_VALID(ctx
);
1112 return ctx
->u
.lsp
.ile
.in_label
;
1115 void dplane_ctx_set_in_label(struct zebra_dplane_ctx
*ctx
, mpls_label_t label
)
1117 DPLANE_CTX_VALID(ctx
);
1119 ctx
->u
.lsp
.ile
.in_label
= label
;
1122 uint8_t dplane_ctx_get_addr_family(const struct zebra_dplane_ctx
*ctx
)
1124 DPLANE_CTX_VALID(ctx
);
1126 return ctx
->u
.lsp
.addr_family
;
1129 void dplane_ctx_set_addr_family(struct zebra_dplane_ctx
*ctx
,
1132 DPLANE_CTX_VALID(ctx
);
1134 ctx
->u
.lsp
.addr_family
= family
;
1137 uint32_t dplane_ctx_get_lsp_flags(const struct zebra_dplane_ctx
*ctx
)
1139 DPLANE_CTX_VALID(ctx
);
1141 return ctx
->u
.lsp
.flags
;
1144 void dplane_ctx_set_lsp_flags(struct zebra_dplane_ctx
*ctx
,
1147 DPLANE_CTX_VALID(ctx
);
1149 ctx
->u
.lsp
.flags
= flags
;
1152 const zebra_nhlfe_t
*dplane_ctx_get_nhlfe(const struct zebra_dplane_ctx
*ctx
)
1154 DPLANE_CTX_VALID(ctx
);
1156 return ctx
->u
.lsp
.nhlfe_list
;
1159 zebra_nhlfe_t
*dplane_ctx_add_nhlfe(struct zebra_dplane_ctx
*ctx
,
1160 enum lsp_types_t lsp_type
,
1161 enum nexthop_types_t nh_type
,
1164 mpls_label_t out_label
)
1166 zebra_nhlfe_t
*nhlfe
;
1168 DPLANE_CTX_VALID(ctx
);
1170 nhlfe
= zebra_mpls_lsp_add_nhlfe(&(ctx
->u
.lsp
),
1171 lsp_type
, nh_type
, gate
,
1172 ifindex
, out_label
);
1177 const zebra_nhlfe_t
*
1178 dplane_ctx_get_best_nhlfe(const struct zebra_dplane_ctx
*ctx
)
1180 DPLANE_CTX_VALID(ctx
);
1182 return ctx
->u
.lsp
.best_nhlfe
;
1185 const zebra_nhlfe_t
*
1186 dplane_ctx_set_best_nhlfe(struct zebra_dplane_ctx
*ctx
,
1187 zebra_nhlfe_t
*nhlfe
)
1189 DPLANE_CTX_VALID(ctx
);
1191 ctx
->u
.lsp
.best_nhlfe
= nhlfe
;
1192 return ctx
->u
.lsp
.best_nhlfe
;
1195 uint32_t dplane_ctx_get_lsp_num_ecmp(const struct zebra_dplane_ctx
*ctx
)
1197 DPLANE_CTX_VALID(ctx
);
1199 return ctx
->u
.lsp
.num_ecmp
;
1202 mpls_label_t
dplane_ctx_get_pw_local_label(const struct zebra_dplane_ctx
*ctx
)
1204 DPLANE_CTX_VALID(ctx
);
1206 return ctx
->u
.pw
.local_label
;
1209 mpls_label_t
dplane_ctx_get_pw_remote_label(const struct zebra_dplane_ctx
*ctx
)
1211 DPLANE_CTX_VALID(ctx
);
1213 return ctx
->u
.pw
.remote_label
;
1216 int dplane_ctx_get_pw_type(const struct zebra_dplane_ctx
*ctx
)
1218 DPLANE_CTX_VALID(ctx
);
1220 return ctx
->u
.pw
.type
;
1223 int dplane_ctx_get_pw_af(const struct zebra_dplane_ctx
*ctx
)
1225 DPLANE_CTX_VALID(ctx
);
1227 return ctx
->u
.pw
.af
;
1230 uint32_t dplane_ctx_get_pw_flags(const struct zebra_dplane_ctx
*ctx
)
1232 DPLANE_CTX_VALID(ctx
);
1234 return ctx
->u
.pw
.flags
;
1237 int dplane_ctx_get_pw_status(const struct zebra_dplane_ctx
*ctx
)
1239 DPLANE_CTX_VALID(ctx
);
1241 return ctx
->u
.pw
.status
;
1244 const union g_addr
*dplane_ctx_get_pw_dest(
1245 const struct zebra_dplane_ctx
*ctx
)
1247 DPLANE_CTX_VALID(ctx
);
1249 return &(ctx
->u
.pw
.dest
);
1252 const union pw_protocol_fields
*dplane_ctx_get_pw_proto(
1253 const struct zebra_dplane_ctx
*ctx
)
1255 DPLANE_CTX_VALID(ctx
);
1257 return &(ctx
->u
.pw
.fields
);
1260 const struct nexthop_group
*
1261 dplane_ctx_get_pw_nhg(const struct zebra_dplane_ctx
*ctx
)
1263 DPLANE_CTX_VALID(ctx
);
1265 return &(ctx
->u
.pw
.nhg
);
1268 /* Accessors for interface information */
1269 uint32_t dplane_ctx_get_intf_metric(const struct zebra_dplane_ctx
*ctx
)
1271 DPLANE_CTX_VALID(ctx
);
1273 return ctx
->u
.intf
.metric
;
1276 /* Is interface addr p2p? */
1277 bool dplane_ctx_intf_is_connected(const struct zebra_dplane_ctx
*ctx
)
1279 DPLANE_CTX_VALID(ctx
);
1281 return (ctx
->u
.intf
.flags
& DPLANE_INTF_CONNECTED
);
1284 bool dplane_ctx_intf_is_secondary(const struct zebra_dplane_ctx
*ctx
)
1286 DPLANE_CTX_VALID(ctx
);
1288 return (ctx
->u
.intf
.flags
& DPLANE_INTF_SECONDARY
);
1291 bool dplane_ctx_intf_is_broadcast(const struct zebra_dplane_ctx
*ctx
)
1293 DPLANE_CTX_VALID(ctx
);
1295 return (ctx
->u
.intf
.flags
& DPLANE_INTF_BROADCAST
);
1298 const struct prefix
*dplane_ctx_get_intf_addr(
1299 const struct zebra_dplane_ctx
*ctx
)
1301 DPLANE_CTX_VALID(ctx
);
1303 return &(ctx
->u
.intf
.prefix
);
1306 bool dplane_ctx_intf_has_dest(const struct zebra_dplane_ctx
*ctx
)
1308 DPLANE_CTX_VALID(ctx
);
1310 return (ctx
->u
.intf
.flags
& DPLANE_INTF_HAS_DEST
);
1313 const struct prefix
*dplane_ctx_get_intf_dest(
1314 const struct zebra_dplane_ctx
*ctx
)
1316 DPLANE_CTX_VALID(ctx
);
1318 if (ctx
->u
.intf
.flags
& DPLANE_INTF_HAS_DEST
)
1319 return &(ctx
->u
.intf
.dest_prefix
);
1324 bool dplane_ctx_intf_has_label(const struct zebra_dplane_ctx
*ctx
)
1326 DPLANE_CTX_VALID(ctx
);
1328 return (ctx
->u
.intf
.flags
& DPLANE_INTF_HAS_LABEL
);
1331 const char *dplane_ctx_get_intf_label(const struct zebra_dplane_ctx
*ctx
)
1333 DPLANE_CTX_VALID(ctx
);
1335 return ctx
->u
.intf
.label
;
1338 /* Accessors for MAC information */
1339 vlanid_t
dplane_ctx_mac_get_vlan(const struct zebra_dplane_ctx
*ctx
)
1341 DPLANE_CTX_VALID(ctx
);
1342 return ctx
->u
.macinfo
.vid
;
1345 bool dplane_ctx_mac_is_sticky(const struct zebra_dplane_ctx
*ctx
)
1347 DPLANE_CTX_VALID(ctx
);
1348 return ctx
->u
.macinfo
.is_sticky
;
1351 const struct ethaddr
*dplane_ctx_mac_get_addr(
1352 const struct zebra_dplane_ctx
*ctx
)
1354 DPLANE_CTX_VALID(ctx
);
1355 return &(ctx
->u
.macinfo
.mac
);
1358 const struct in_addr
*dplane_ctx_mac_get_vtep_ip(
1359 const struct zebra_dplane_ctx
*ctx
)
1361 DPLANE_CTX_VALID(ctx
);
1362 return &(ctx
->u
.macinfo
.vtep_ip
);
1365 ifindex_t
dplane_ctx_mac_get_br_ifindex(const struct zebra_dplane_ctx
*ctx
)
1367 DPLANE_CTX_VALID(ctx
);
1368 return ctx
->u
.macinfo
.br_ifindex
;
1371 /* Accessors for neighbor information */
1372 const struct ipaddr
*dplane_ctx_neigh_get_ipaddr(
1373 const struct zebra_dplane_ctx
*ctx
)
1375 DPLANE_CTX_VALID(ctx
);
1376 return &(ctx
->u
.neigh
.ip_addr
);
1379 const struct ethaddr
*dplane_ctx_neigh_get_mac(
1380 const struct zebra_dplane_ctx
*ctx
)
1382 DPLANE_CTX_VALID(ctx
);
1383 return &(ctx
->u
.neigh
.mac
);
1386 uint32_t dplane_ctx_neigh_get_flags(const struct zebra_dplane_ctx
*ctx
)
1388 DPLANE_CTX_VALID(ctx
);
1389 return ctx
->u
.neigh
.flags
;
1392 uint16_t dplane_ctx_neigh_get_state(const struct zebra_dplane_ctx
*ctx
)
1394 DPLANE_CTX_VALID(ctx
);
1395 return ctx
->u
.neigh
.state
;
1399 * End of dplane context accessors
1404 * Retrieve the limit on the number of pending, unprocessed updates.
1406 uint32_t dplane_get_in_queue_limit(void)
1408 return atomic_load_explicit(&zdplane_info
.dg_max_queued_updates
,
1409 memory_order_relaxed
);
1413 * Configure limit on the number of pending, queued updates.
1415 void dplane_set_in_queue_limit(uint32_t limit
, bool set
)
1417 /* Reset to default on 'unset' */
1419 limit
= DPLANE_DEFAULT_MAX_QUEUED
;
1421 atomic_store_explicit(&zdplane_info
.dg_max_queued_updates
, limit
,
1422 memory_order_relaxed
);
1426 * Retrieve the current queue depth of incoming, unprocessed updates
1428 uint32_t dplane_get_in_queue_len(void)
1430 return atomic_load_explicit(&zdplane_info
.dg_routes_queued
,
1431 memory_order_seq_cst
);
1435 * Common dataplane context init with zebra namespace info.
1437 static int dplane_ctx_ns_init(struct zebra_dplane_ctx
*ctx
,
1438 struct zebra_ns
*zns
,
1441 dplane_info_from_zns(&(ctx
->zd_ns_info
), zns
);
1443 #if defined(HAVE_NETLINK)
1444 /* Increment message counter after copying to context struct - may need
1445 * two messages in some 'update' cases.
1448 zns
->netlink_dplane
.seq
+= 2;
1450 zns
->netlink_dplane
.seq
++;
1451 #endif /* HAVE_NETLINK */
1457 * Initialize a context block for a route update from zebra data structs.
1459 static int dplane_ctx_route_init(struct zebra_dplane_ctx
*ctx
,
1460 enum dplane_op_e op
,
1461 struct route_node
*rn
,
1462 struct route_entry
*re
)
1465 const struct route_table
*table
= NULL
;
1466 const rib_table_info_t
*info
;
1467 const struct prefix
*p
, *src_p
;
1468 struct zebra_ns
*zns
;
1469 struct zebra_vrf
*zvrf
;
1470 struct nexthop
*nexthop
;
1472 if (!ctx
|| !rn
|| !re
)
1476 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1478 ctx
->u
.rinfo
.zd_type
= re
->type
;
1479 ctx
->u
.rinfo
.zd_old_type
= re
->type
;
1481 /* Prefixes: dest, and optional source */
1482 srcdest_rnode_prefixes(rn
, &p
, &src_p
);
1484 prefix_copy(&(ctx
->u
.rinfo
.zd_dest
), p
);
1487 prefix_copy(&(ctx
->u
.rinfo
.zd_src
), src_p
);
1489 memset(&(ctx
->u
.rinfo
.zd_src
), 0, sizeof(ctx
->u
.rinfo
.zd_src
));
1491 ctx
->zd_table_id
= re
->table
;
1493 ctx
->u
.rinfo
.zd_metric
= re
->metric
;
1494 ctx
->u
.rinfo
.zd_old_metric
= re
->metric
;
1495 ctx
->zd_vrf_id
= re
->vrf_id
;
1496 ctx
->u
.rinfo
.zd_mtu
= re
->mtu
;
1497 ctx
->u
.rinfo
.zd_nexthop_mtu
= re
->nexthop_mtu
;
1498 ctx
->u
.rinfo
.zd_instance
= re
->instance
;
1499 ctx
->u
.rinfo
.zd_tag
= re
->tag
;
1500 ctx
->u
.rinfo
.zd_old_tag
= re
->tag
;
1501 ctx
->u
.rinfo
.zd_distance
= re
->distance
;
1503 table
= srcdest_rnode_table(rn
);
1506 ctx
->u
.rinfo
.zd_afi
= info
->afi
;
1507 ctx
->u
.rinfo
.zd_safi
= info
->safi
;
1509 /* Copy nexthops; recursive info is included too */
1510 copy_nexthops(&(ctx
->u
.rinfo
.zd_ng
.nexthop
), re
->ng
->nexthop
, NULL
);
1512 /* Ensure that the dplane's nexthops flags are clear. */
1513 for (ALL_NEXTHOPS(ctx
->u
.rinfo
.zd_ng
, nexthop
))
1514 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
1516 /* Don't need some info when capturing a system notification */
1517 if (op
== DPLANE_OP_SYS_ROUTE_ADD
||
1518 op
== DPLANE_OP_SYS_ROUTE_DELETE
) {
1523 /* Extract ns info - can't use pointers to 'core' structs */
1524 zvrf
= vrf_info_lookup(re
->vrf_id
);
1526 dplane_ctx_ns_init(ctx
, zns
, (op
== DPLANE_OP_ROUTE_UPDATE
));
1529 if (re
->nhe_id
&& zns
->supports_nh
) {
1530 ctx
->u
.rinfo
.nhe
.id
= zebra_nhg_get_resolved_id(re
->nhe_id
);
1533 * It checks if the nhe is even installed
1534 * before trying to uninstall it. If the
1535 * nexthop is uninstalled and the kernel
1536 * is using nexthop objects, this route
1537 * has already been uninstalled.
1539 if (!CHECK_FLAG(zebra_nhg_lookup_id(ctx
->u
.rinfo
.nhe
.id
)->flags
,
1540 NEXTHOP_GROUP_INSTALLED
)) {
1545 #endif /* HAVE_NETLINK */
1547 /* Trying out the sequence number idea, so we can try to detect
1548 * when a result is stale.
1550 re
->dplane_sequence
= zebra_router_get_next_sequence();
1551 ctx
->zd_seq
= re
->dplane_sequence
;
1560 * dplane_ctx_nexthop_init() - Initialize a context block for a nexthop update
1562 * @ctx: Dataplane context to init
1563 * @op: Operation being performed
1564 * @nhe: Nexthop group hash entry
1566 * Return: Result status
1568 static int dplane_ctx_nexthop_init(struct zebra_dplane_ctx
*ctx
,
1569 enum dplane_op_e op
,
1570 struct nhg_hash_entry
*nhe
)
1572 struct zebra_ns
*zns
= NULL
;
1580 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1582 /* Copy over nhe info */
1583 ctx
->u
.rinfo
.nhe
.id
= nhe
->id
;
1584 ctx
->u
.rinfo
.nhe
.afi
= nhe
->afi
;
1585 ctx
->u
.rinfo
.nhe
.vrf_id
= nhe
->vrf_id
;
1586 ctx
->u
.rinfo
.nhe
.is_kernel_nh
= nhe
->is_kernel_nh
;
1588 nexthop_group_copy(&(ctx
->u
.rinfo
.nhe
.ng
), nhe
->nhg
);
1590 /* If its a group, convert it to a grp array of ids */
1591 if (!zebra_nhg_depends_is_empty(nhe
)
1592 && !CHECK_FLAG(nhe
->flags
, NEXTHOP_GROUP_RECURSIVE
))
1593 ctx
->u
.rinfo
.nhe
.nh_grp_count
=
1594 zebra_nhg_nhe2grp(ctx
->u
.rinfo
.nhe
.nh_grp
, nhe
);
1596 /* Extract ns info - can't use pointers to 'core'
1598 zns
= ((struct zebra_vrf
*)vrf_info_lookup(nhe
->vrf_id
))->zns
;
1600 if (!zns
->supports_nh
) {
1605 // TODO: Might not need to mark this as an update, since
1606 // it probably won't require two messages
1607 dplane_ctx_ns_init(ctx
, zns
, (op
== DPLANE_OP_NH_UPDATE
));
1616 * Capture information for an LSP update in a dplane context.
1618 static int dplane_ctx_lsp_init(struct zebra_dplane_ctx
*ctx
,
1619 enum dplane_op_e op
,
1623 zebra_nhlfe_t
*nhlfe
, *new_nhlfe
;
1625 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1626 zlog_debug("init dplane ctx %s: in-label %u ecmp# %d",
1627 dplane_op2str(op
), lsp
->ile
.in_label
,
1631 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1633 /* Capture namespace info */
1634 dplane_ctx_ns_init(ctx
, zebra_ns_lookup(NS_DEFAULT
),
1635 (op
== DPLANE_OP_LSP_UPDATE
));
1637 memset(&ctx
->u
.lsp
, 0, sizeof(ctx
->u
.lsp
));
1639 ctx
->u
.lsp
.ile
= lsp
->ile
;
1640 ctx
->u
.lsp
.addr_family
= lsp
->addr_family
;
1641 ctx
->u
.lsp
.num_ecmp
= lsp
->num_ecmp
;
1642 ctx
->u
.lsp
.flags
= lsp
->flags
;
1644 /* Copy source LSP's nhlfes, and capture 'best' nhlfe */
1645 for (nhlfe
= lsp
->nhlfe_list
; nhlfe
; nhlfe
= nhlfe
->next
) {
1646 /* Not sure if this is meaningful... */
1647 if (nhlfe
->nexthop
== NULL
)
1651 zebra_mpls_lsp_add_nhlfe(
1654 nhlfe
->nexthop
->type
,
1655 &(nhlfe
->nexthop
->gate
),
1656 nhlfe
->nexthop
->ifindex
,
1657 nhlfe
->nexthop
->nh_label
->label
[0]);
1659 if (new_nhlfe
== NULL
|| new_nhlfe
->nexthop
== NULL
) {
1664 /* Need to copy flags too */
1665 new_nhlfe
->flags
= nhlfe
->flags
;
1666 new_nhlfe
->nexthop
->flags
= nhlfe
->nexthop
->flags
;
1668 if (nhlfe
== lsp
->best_nhlfe
)
1669 ctx
->u
.lsp
.best_nhlfe
= new_nhlfe
;
1672 /* On error the ctx will be cleaned-up, so we don't need to
1673 * deal with any allocated nhlfe or nexthop structs here.
1680 * Capture information for an LSP update in a dplane context.
1682 static int dplane_ctx_pw_init(struct zebra_dplane_ctx
*ctx
,
1683 enum dplane_op_e op
,
1684 struct zebra_pw
*pw
)
1688 struct route_table
*table
;
1689 struct route_node
*rn
;
1690 struct route_entry
*re
;
1692 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1693 zlog_debug("init dplane ctx %s: pw '%s', loc %u, rem %u",
1694 dplane_op2str(op
), pw
->ifname
, pw
->local_label
,
1698 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1700 /* Capture namespace info: no netlink support as of 12/18,
1701 * but just in case...
1703 dplane_ctx_ns_init(ctx
, zebra_ns_lookup(NS_DEFAULT
), false);
1705 memset(&ctx
->u
.pw
, 0, sizeof(ctx
->u
.pw
));
1707 /* This name appears to be c-string, so we use string copy. */
1708 strlcpy(ctx
->zd_ifname
, pw
->ifname
, sizeof(ctx
->zd_ifname
));
1710 ctx
->zd_vrf_id
= pw
->vrf_id
;
1711 ctx
->zd_ifindex
= pw
->ifindex
;
1712 ctx
->u
.pw
.type
= pw
->type
;
1713 ctx
->u
.pw
.af
= pw
->af
;
1714 ctx
->u
.pw
.local_label
= pw
->local_label
;
1715 ctx
->u
.pw
.remote_label
= pw
->remote_label
;
1716 ctx
->u
.pw
.flags
= pw
->flags
;
1718 ctx
->u
.pw
.dest
= pw
->nexthop
;
1720 ctx
->u
.pw
.fields
= pw
->data
;
1722 /* Capture nexthop info for the pw destination. We need to look
1723 * up and use zebra datastructs, but we're running in the zebra
1724 * pthread here so that should be ok.
1726 memcpy(&p
.u
, &pw
->nexthop
, sizeof(pw
->nexthop
));
1728 p
.prefixlen
= ((pw
->af
== AF_INET
) ?
1729 IPV4_MAX_PREFIXLEN
: IPV6_MAX_PREFIXLEN
);
1731 afi
= (pw
->af
== AF_INET
) ? AFI_IP
: AFI_IP6
;
1732 table
= zebra_vrf_table(afi
, SAFI_UNICAST
, pw
->vrf_id
);
1734 rn
= route_node_match(table
, &p
);
1736 RNODE_FOREACH_RE(rn
, re
) {
1737 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
))
1742 copy_nexthops(&(ctx
->u
.pw
.nhg
.nexthop
),
1743 re
->ng
->nexthop
, NULL
);
1745 route_unlock_node(rn
);
1753 * Enqueue a new update,
1754 * and ensure an event is active for the dataplane pthread.
1756 static int dplane_update_enqueue(struct zebra_dplane_ctx
*ctx
)
1759 uint32_t high
, curr
;
1761 /* Enqueue for processing by the dataplane pthread */
1764 TAILQ_INSERT_TAIL(&zdplane_info
.dg_update_ctx_q
, ctx
,
1769 curr
= atomic_add_fetch_explicit(
1771 /* TODO -- issue with the clang atomic/intrinsics currently;
1772 * casting away the 'Atomic'-ness of the variable works.
1774 (uint32_t *)&(zdplane_info
.dg_routes_queued
),
1776 &(zdplane_info
.dg_routes_queued
),
1778 1, memory_order_seq_cst
);
1780 /* Maybe update high-water counter also */
1781 high
= atomic_load_explicit(&zdplane_info
.dg_routes_queued_max
,
1782 memory_order_seq_cst
);
1783 while (high
< curr
) {
1784 if (atomic_compare_exchange_weak_explicit(
1785 &zdplane_info
.dg_routes_queued_max
,
1787 memory_order_seq_cst
,
1788 memory_order_seq_cst
))
1792 /* Ensure that an event for the dataplane thread is active */
1793 ret
= dplane_provider_work_ready();
1799 * Utility that prepares a route update and enqueues it for processing
1801 static enum zebra_dplane_result
1802 dplane_route_update_internal(struct route_node
*rn
,
1803 struct route_entry
*re
,
1804 struct route_entry
*old_re
,
1805 enum dplane_op_e op
)
1807 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1809 struct zebra_dplane_ctx
*ctx
= NULL
;
1811 /* Obtain context block */
1812 ctx
= dplane_ctx_alloc();
1814 /* Init context with info from zebra data structs */
1815 ret
= dplane_ctx_route_init(ctx
, op
, rn
, re
);
1817 /* Capture some extra info for update case
1818 * where there's a different 'old' route.
1820 if ((op
== DPLANE_OP_ROUTE_UPDATE
) &&
1821 old_re
&& (old_re
!= re
)) {
1822 ctx
->zd_is_update
= true;
1824 old_re
->dplane_sequence
=
1825 zebra_router_get_next_sequence();
1826 ctx
->zd_old_seq
= old_re
->dplane_sequence
;
1828 ctx
->u
.rinfo
.zd_old_tag
= old_re
->tag
;
1829 ctx
->u
.rinfo
.zd_old_type
= old_re
->type
;
1830 ctx
->u
.rinfo
.zd_old_instance
= old_re
->instance
;
1831 ctx
->u
.rinfo
.zd_old_distance
= old_re
->distance
;
1832 ctx
->u
.rinfo
.zd_old_metric
= old_re
->metric
;
1834 #ifndef HAVE_NETLINK
1835 /* For bsd, capture previous re's nexthops too, sigh.
1836 * We'll need these to do per-nexthop deletes.
1838 copy_nexthops(&(ctx
->u
.rinfo
.zd_old_ng
.nexthop
),
1839 old_re
->ng
.nexthop
, NULL
);
1840 #endif /* !HAVE_NETLINK */
1843 /* Enqueue context for processing */
1844 ret
= dplane_update_enqueue(ctx
);
1847 /* Update counter */
1848 atomic_fetch_add_explicit(&zdplane_info
.dg_routes_in
, 1,
1849 memory_order_relaxed
);
1852 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
1855 result
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1857 atomic_fetch_add_explicit(&zdplane_info
.dg_route_errors
,
1858 1, memory_order_relaxed
);
1860 dplane_ctx_free(&ctx
);
1867 * dplane_nexthop_update_internal() - Helper for enqueuing nexthop changes
1869 * @nhe: Nexthop group hash entry where the change occured
1870 * @op: The operation to be enqued
1872 * Return: Result of the change
1874 static enum zebra_dplane_result
1875 dplane_nexthop_update_internal(struct nhg_hash_entry
*nhe
, enum dplane_op_e op
)
1877 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1879 struct zebra_dplane_ctx
*ctx
= NULL
;
1881 /* Obtain context block */
1882 ctx
= dplane_ctx_alloc();
1888 ret
= dplane_ctx_nexthop_init(ctx
, op
, nhe
);
1890 ret
= dplane_update_enqueue(ctx
);
1893 /* Update counter */
1894 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthops_in
, 1,
1895 memory_order_relaxed
);
1898 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
1900 if (ret
== EOPNOTSUPP
)
1901 result
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1903 atomic_fetch_add_explicit(
1904 &zdplane_info
.dg_nexthop_errors
, 1,
1905 memory_order_relaxed
);
1907 dplane_ctx_free(&ctx
);
1914 * Enqueue a route 'add' for the dataplane.
1916 enum zebra_dplane_result
dplane_route_add(struct route_node
*rn
,
1917 struct route_entry
*re
)
1919 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1921 if (rn
== NULL
|| re
== NULL
)
1924 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1925 DPLANE_OP_ROUTE_INSTALL
);
1932 * Enqueue a route update for the dataplane.
1934 enum zebra_dplane_result
dplane_route_update(struct route_node
*rn
,
1935 struct route_entry
*re
,
1936 struct route_entry
*old_re
)
1938 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1940 if (rn
== NULL
|| re
== NULL
)
1943 ret
= dplane_route_update_internal(rn
, re
, old_re
,
1944 DPLANE_OP_ROUTE_UPDATE
);
1950 * Enqueue a route removal for the dataplane.
1952 enum zebra_dplane_result
dplane_route_delete(struct route_node
*rn
,
1953 struct route_entry
*re
)
1955 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1957 if (rn
== NULL
|| re
== NULL
)
1960 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1961 DPLANE_OP_ROUTE_DELETE
);
1968 * Notify the dplane when system/connected routes change.
1970 enum zebra_dplane_result
dplane_sys_route_add(struct route_node
*rn
,
1971 struct route_entry
*re
)
1973 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1975 /* Ignore this event unless a provider plugin has requested it. */
1976 if (!zdplane_info
.dg_sys_route_notifs
) {
1977 ret
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1981 if (rn
== NULL
|| re
== NULL
)
1984 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1985 DPLANE_OP_SYS_ROUTE_ADD
);
1992 * Notify the dplane when system/connected routes are deleted.
1994 enum zebra_dplane_result
dplane_sys_route_del(struct route_node
*rn
,
1995 struct route_entry
*re
)
1997 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1999 /* Ignore this event unless a provider plugin has requested it. */
2000 if (!zdplane_info
.dg_sys_route_notifs
) {
2001 ret
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2005 if (rn
== NULL
|| re
== NULL
)
2008 ret
= dplane_route_update_internal(rn
, re
, NULL
,
2009 DPLANE_OP_SYS_ROUTE_DELETE
);
2016 * Update from an async notification, to bring other fibs up-to-date.
2018 enum zebra_dplane_result
2019 dplane_route_notif_update(struct route_node
*rn
,
2020 struct route_entry
*re
,
2021 enum dplane_op_e op
,
2022 struct zebra_dplane_ctx
*ctx
)
2024 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2025 struct zebra_dplane_ctx
*new_ctx
= NULL
;
2026 struct nexthop
*nexthop
;
2028 if (rn
== NULL
|| re
== NULL
)
2031 new_ctx
= dplane_ctx_alloc();
2032 if (new_ctx
== NULL
)
2035 /* Init context with info from zebra data structs */
2036 dplane_ctx_route_init(new_ctx
, op
, rn
, re
);
2038 /* For add/update, need to adjust the nexthops so that we match
2039 * the notification state, which may not be the route-entry/RIB
2042 if (op
== DPLANE_OP_ROUTE_UPDATE
||
2043 op
== DPLANE_OP_ROUTE_INSTALL
) {
2045 nexthops_free(new_ctx
->u
.rinfo
.zd_ng
.nexthop
);
2046 new_ctx
->u
.rinfo
.zd_ng
.nexthop
= NULL
;
2048 copy_nexthops(&(new_ctx
->u
.rinfo
.zd_ng
.nexthop
),
2049 (rib_active_nhg(re
))->nexthop
, NULL
);
2051 for (ALL_NEXTHOPS(new_ctx
->u
.rinfo
.zd_ng
, nexthop
))
2052 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
2056 /* Capture info about the source of the notification, in 'ctx' */
2057 dplane_ctx_set_notif_provider(new_ctx
,
2058 dplane_ctx_get_notif_provider(ctx
));
2060 dplane_update_enqueue(new_ctx
);
2062 ret
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2069 * Enqueue a nexthop add for the dataplane.
2071 enum zebra_dplane_result
dplane_nexthop_add(struct nhg_hash_entry
*nhe
)
2073 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2076 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_INSTALL
);
2081 * Enqueue a nexthop update for the dataplane.
2083 enum zebra_dplane_result
dplane_nexthop_update(struct nhg_hash_entry
*nhe
)
2085 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2088 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_UPDATE
);
2093 * Enqueue a nexthop removal for the dataplane.
2095 enum zebra_dplane_result
dplane_nexthop_delete(struct nhg_hash_entry
*nhe
)
2097 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2100 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_DELETE
);
2106 * Enqueue LSP add for the dataplane.
2108 enum zebra_dplane_result
dplane_lsp_add(zebra_lsp_t
*lsp
)
2110 enum zebra_dplane_result ret
=
2111 lsp_update_internal(lsp
, DPLANE_OP_LSP_INSTALL
);
2117 * Enqueue LSP update for the dataplane.
2119 enum zebra_dplane_result
dplane_lsp_update(zebra_lsp_t
*lsp
)
2121 enum zebra_dplane_result ret
=
2122 lsp_update_internal(lsp
, DPLANE_OP_LSP_UPDATE
);
2128 * Enqueue LSP delete for the dataplane.
2130 enum zebra_dplane_result
dplane_lsp_delete(zebra_lsp_t
*lsp
)
2132 enum zebra_dplane_result ret
=
2133 lsp_update_internal(lsp
, DPLANE_OP_LSP_DELETE
);
2138 /* Update or un-install resulting from an async notification */
2139 enum zebra_dplane_result
2140 dplane_lsp_notif_update(zebra_lsp_t
*lsp
,
2141 enum dplane_op_e op
,
2142 struct zebra_dplane_ctx
*notif_ctx
)
2144 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2146 struct zebra_dplane_ctx
*ctx
= NULL
;
2148 /* Obtain context block */
2149 ctx
= dplane_ctx_alloc();
2155 ret
= dplane_ctx_lsp_init(ctx
, op
, lsp
);
2159 /* Capture info about the source of the notification */
2160 dplane_ctx_set_notif_provider(
2162 dplane_ctx_get_notif_provider(notif_ctx
));
2164 ret
= dplane_update_enqueue(ctx
);
2167 /* Update counter */
2168 atomic_fetch_add_explicit(&zdplane_info
.dg_lsps_in
, 1,
2169 memory_order_relaxed
);
2172 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2174 atomic_fetch_add_explicit(&zdplane_info
.dg_lsp_errors
, 1,
2175 memory_order_relaxed
);
2177 dplane_ctx_free(&ctx
);
2183 * Enqueue pseudowire install for the dataplane.
2185 enum zebra_dplane_result
dplane_pw_install(struct zebra_pw
*pw
)
2187 return pw_update_internal(pw
, DPLANE_OP_PW_INSTALL
);
2191 * Enqueue pseudowire un-install for the dataplane.
2193 enum zebra_dplane_result
dplane_pw_uninstall(struct zebra_pw
*pw
)
2195 return pw_update_internal(pw
, DPLANE_OP_PW_UNINSTALL
);
2199 * Common internal LSP update utility
2201 static enum zebra_dplane_result
lsp_update_internal(zebra_lsp_t
*lsp
,
2202 enum dplane_op_e op
)
2204 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2206 struct zebra_dplane_ctx
*ctx
= NULL
;
2208 /* Obtain context block */
2209 ctx
= dplane_ctx_alloc();
2211 ret
= dplane_ctx_lsp_init(ctx
, op
, lsp
);
2215 ret
= dplane_update_enqueue(ctx
);
2218 /* Update counter */
2219 atomic_fetch_add_explicit(&zdplane_info
.dg_lsps_in
, 1,
2220 memory_order_relaxed
);
2223 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2225 atomic_fetch_add_explicit(&zdplane_info
.dg_lsp_errors
, 1,
2226 memory_order_relaxed
);
2227 dplane_ctx_free(&ctx
);
2234 * Internal, common handler for pseudowire updates.
2236 static enum zebra_dplane_result
pw_update_internal(struct zebra_pw
*pw
,
2237 enum dplane_op_e op
)
2239 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2241 struct zebra_dplane_ctx
*ctx
= NULL
;
2243 ctx
= dplane_ctx_alloc();
2245 ret
= dplane_ctx_pw_init(ctx
, op
, pw
);
2249 ret
= dplane_update_enqueue(ctx
);
2252 /* Update counter */
2253 atomic_fetch_add_explicit(&zdplane_info
.dg_pws_in
, 1,
2254 memory_order_relaxed
);
2257 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2259 atomic_fetch_add_explicit(&zdplane_info
.dg_pw_errors
, 1,
2260 memory_order_relaxed
);
2261 dplane_ctx_free(&ctx
);
2268 * Enqueue interface address add for the dataplane.
2270 enum zebra_dplane_result
dplane_intf_addr_set(const struct interface
*ifp
,
2271 const struct connected
*ifc
)
2273 #if !defined(HAVE_NETLINK) && defined(HAVE_STRUCT_IFALIASREQ)
2274 /* Extra checks for this OS path. */
2276 /* Don't configure PtP addresses on broadcast ifs or reverse */
2277 if (!(ifp
->flags
& IFF_POINTOPOINT
) != !CONNECTED_PEER(ifc
)) {
2278 if (IS_ZEBRA_DEBUG_KERNEL
|| IS_ZEBRA_DEBUG_DPLANE
)
2279 zlog_debug("Failed to set intf addr: mismatch p2p and connected");
2281 return ZEBRA_DPLANE_REQUEST_FAILURE
;
2284 /* Ensure that no existing installed v4 route conflicts with
2285 * the new interface prefix. This check must be done in the
2286 * zebra pthread context, and any route delete (if needed)
2287 * is enqueued before the interface address programming attempt.
2289 if (ifc
->address
->family
== AF_INET
) {
2290 struct prefix_ipv4
*p
;
2292 p
= (struct prefix_ipv4
*)ifc
->address
;
2293 rib_lookup_and_pushup(p
, ifp
->vrf_id
);
2297 return intf_addr_update_internal(ifp
, ifc
, DPLANE_OP_ADDR_INSTALL
);
2301 * Enqueue interface address remove/uninstall for the dataplane.
2303 enum zebra_dplane_result
dplane_intf_addr_unset(const struct interface
*ifp
,
2304 const struct connected
*ifc
)
2306 return intf_addr_update_internal(ifp
, ifc
, DPLANE_OP_ADDR_UNINSTALL
);
2309 static enum zebra_dplane_result
intf_addr_update_internal(
2310 const struct interface
*ifp
, const struct connected
*ifc
,
2311 enum dplane_op_e op
)
2313 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2315 struct zebra_dplane_ctx
*ctx
= NULL
;
2316 struct zebra_ns
*zns
;
2318 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2319 char addr_str
[PREFIX_STRLEN
];
2321 prefix2str(ifc
->address
, addr_str
, sizeof(addr_str
));
2323 zlog_debug("init intf ctx %s: idx %d, addr %u:%s",
2324 dplane_op2str(op
), ifp
->ifindex
, ifp
->vrf_id
,
2328 ctx
= dplane_ctx_alloc();
2331 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2332 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2334 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2335 dplane_ctx_ns_init(ctx
, zns
, false);
2337 /* Init the interface-addr-specific area */
2338 memset(&ctx
->u
.intf
, 0, sizeof(ctx
->u
.intf
));
2340 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2341 ctx
->zd_ifindex
= ifp
->ifindex
;
2342 ctx
->u
.intf
.prefix
= *(ifc
->address
);
2344 if (if_is_broadcast(ifp
))
2345 ctx
->u
.intf
.flags
|= DPLANE_INTF_BROADCAST
;
2347 if (CONNECTED_PEER(ifc
)) {
2348 ctx
->u
.intf
.dest_prefix
= *(ifc
->destination
);
2349 ctx
->u
.intf
.flags
|=
2350 (DPLANE_INTF_CONNECTED
| DPLANE_INTF_HAS_DEST
);
2353 if (CHECK_FLAG(ifc
->flags
, ZEBRA_IFA_SECONDARY
))
2354 ctx
->u
.intf
.flags
|= DPLANE_INTF_SECONDARY
;
2359 ctx
->u
.intf
.flags
|= DPLANE_INTF_HAS_LABEL
;
2361 /* Use embedded buffer if it's adequate; else allocate. */
2362 len
= strlen(ifc
->label
);
2364 if (len
< sizeof(ctx
->u
.intf
.label_buf
)) {
2365 strlcpy(ctx
->u
.intf
.label_buf
, ifc
->label
,
2366 sizeof(ctx
->u
.intf
.label_buf
));
2367 ctx
->u
.intf
.label
= ctx
->u
.intf
.label_buf
;
2369 ctx
->u
.intf
.label
= strdup(ifc
->label
);
2373 ret
= dplane_update_enqueue(ctx
);
2375 /* Increment counter */
2376 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addrs_in
, 1,
2377 memory_order_relaxed
);
2380 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2383 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addr_errors
,
2384 1, memory_order_relaxed
);
2385 dplane_ctx_free(&ctx
);
2392 * Enqueue vxlan/evpn mac add (or update).
2394 enum zebra_dplane_result
dplane_mac_add(const struct interface
*ifp
,
2395 const struct interface
*bridge_ifp
,
2397 const struct ethaddr
*mac
,
2398 struct in_addr vtep_ip
,
2401 enum zebra_dplane_result result
;
2403 /* Use common helper api */
2404 result
= mac_update_internal(DPLANE_OP_MAC_INSTALL
, ifp
, bridge_ifp
,
2405 vid
, mac
, vtep_ip
, sticky
);
2410 * Enqueue vxlan/evpn mac delete.
2412 enum zebra_dplane_result
dplane_mac_del(const struct interface
*ifp
,
2413 const struct interface
*bridge_ifp
,
2415 const struct ethaddr
*mac
,
2416 struct in_addr vtep_ip
)
2418 enum zebra_dplane_result result
;
2420 /* Use common helper api */
2421 result
= mac_update_internal(DPLANE_OP_MAC_DELETE
, ifp
, bridge_ifp
,
2422 vid
, mac
, vtep_ip
, false);
2427 * Common helper api for MAC address/vxlan updates
2429 static enum zebra_dplane_result
2430 mac_update_internal(enum dplane_op_e op
,
2431 const struct interface
*ifp
,
2432 const struct interface
*br_ifp
,
2434 const struct ethaddr
*mac
,
2435 struct in_addr vtep_ip
,
2438 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2440 struct zebra_dplane_ctx
*ctx
= NULL
;
2441 struct zebra_ns
*zns
;
2443 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2444 char buf1
[ETHER_ADDR_STRLEN
], buf2
[PREFIX_STRLEN
];
2446 zlog_debug("init mac ctx %s: mac %s, ifp %s, vtep %s",
2448 prefix_mac2str(mac
, buf1
, sizeof(buf1
)),
2450 inet_ntop(AF_INET
, &vtep_ip
, buf2
, sizeof(buf2
)));
2453 ctx
= dplane_ctx_alloc();
2456 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2457 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2459 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2460 dplane_ctx_ns_init(ctx
, zns
, false);
2462 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2463 ctx
->zd_ifindex
= ifp
->ifindex
;
2465 /* Init the mac-specific data area */
2466 memset(&ctx
->u
.macinfo
, 0, sizeof(ctx
->u
.macinfo
));
2468 ctx
->u
.macinfo
.br_ifindex
= br_ifp
->ifindex
;
2469 ctx
->u
.macinfo
.vtep_ip
= vtep_ip
;
2470 ctx
->u
.macinfo
.mac
= *mac
;
2471 ctx
->u
.macinfo
.vid
= vid
;
2472 ctx
->u
.macinfo
.is_sticky
= sticky
;
2474 /* Enqueue for processing on the dplane pthread */
2475 ret
= dplane_update_enqueue(ctx
);
2477 /* Increment counter */
2478 atomic_fetch_add_explicit(&zdplane_info
.dg_macs_in
, 1,
2479 memory_order_relaxed
);
2482 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2485 atomic_fetch_add_explicit(&zdplane_info
.dg_mac_errors
, 1,
2486 memory_order_relaxed
);
2487 dplane_ctx_free(&ctx
);
2494 * Enqueue evpn neighbor add for the dataplane.
2496 enum zebra_dplane_result
dplane_neigh_add(const struct interface
*ifp
,
2497 const struct ipaddr
*ip
,
2498 const struct ethaddr
*mac
,
2501 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2503 result
= neigh_update_internal(DPLANE_OP_NEIGH_INSTALL
,
2504 ifp
, mac
, ip
, flags
, 0);
2510 * Enqueue evpn neighbor update for the dataplane.
2512 enum zebra_dplane_result
dplane_neigh_update(const struct interface
*ifp
,
2513 const struct ipaddr
*ip
,
2514 const struct ethaddr
*mac
)
2516 enum zebra_dplane_result result
;
2518 result
= neigh_update_internal(DPLANE_OP_NEIGH_UPDATE
,
2519 ifp
, mac
, ip
, 0, DPLANE_NUD_PROBE
);
2525 * Enqueue evpn neighbor delete for the dataplane.
2527 enum zebra_dplane_result
dplane_neigh_delete(const struct interface
*ifp
,
2528 const struct ipaddr
*ip
)
2530 enum zebra_dplane_result result
;
2532 result
= neigh_update_internal(DPLANE_OP_NEIGH_DELETE
,
2533 ifp
, NULL
, ip
, 0, 0);
2539 * Enqueue evpn VTEP add for the dataplane.
2541 enum zebra_dplane_result
dplane_vtep_add(const struct interface
*ifp
,
2542 const struct in_addr
*ip
,
2545 enum zebra_dplane_result result
;
2546 struct ethaddr mac
= { {0, 0, 0, 0, 0, 0} };
2549 if (IS_ZEBRA_DEBUG_VXLAN
)
2550 zlog_debug("Install %s into flood list for VNI %u intf %s(%u)",
2551 inet_ntoa(*ip
), vni
, ifp
->name
, ifp
->ifindex
);
2553 SET_IPADDR_V4(&addr
);
2554 addr
.ipaddr_v4
= *ip
;
2556 result
= neigh_update_internal(DPLANE_OP_VTEP_ADD
,
2557 ifp
, &mac
, &addr
, 0, 0);
2563 * Enqueue evpn VTEP add for the dataplane.
2565 enum zebra_dplane_result
dplane_vtep_delete(const struct interface
*ifp
,
2566 const struct in_addr
*ip
,
2569 enum zebra_dplane_result result
;
2570 struct ethaddr mac
= { {0, 0, 0, 0, 0, 0} };
2573 if (IS_ZEBRA_DEBUG_VXLAN
)
2575 "Uninstall %s from flood list for VNI %u intf %s(%u)",
2576 inet_ntoa(*ip
), vni
, ifp
->name
, ifp
->ifindex
);
2578 SET_IPADDR_V4(&addr
);
2579 addr
.ipaddr_v4
= *ip
;
2581 result
= neigh_update_internal(DPLANE_OP_VTEP_DELETE
,
2582 ifp
, &mac
, &addr
, 0, 0);
2588 * Common helper api for evpn neighbor updates
2590 static enum zebra_dplane_result
2591 neigh_update_internal(enum dplane_op_e op
,
2592 const struct interface
*ifp
,
2593 const struct ethaddr
*mac
,
2594 const struct ipaddr
*ip
,
2595 uint32_t flags
, uint16_t state
)
2597 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2599 struct zebra_dplane_ctx
*ctx
= NULL
;
2600 struct zebra_ns
*zns
;
2602 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2603 char buf1
[ETHER_ADDR_STRLEN
], buf2
[PREFIX_STRLEN
];
2605 zlog_debug("init neigh ctx %s: ifp %s, mac %s, ip %s",
2607 prefix_mac2str(mac
, buf1
, sizeof(buf1
)),
2609 ipaddr2str(ip
, buf2
, sizeof(buf2
)));
2612 ctx
= dplane_ctx_alloc();
2615 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2616 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2618 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2619 dplane_ctx_ns_init(ctx
, zns
, false);
2621 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2622 ctx
->zd_ifindex
= ifp
->ifindex
;
2624 /* Init the neighbor-specific data area */
2625 memset(&ctx
->u
.neigh
, 0, sizeof(ctx
->u
.neigh
));
2627 ctx
->u
.neigh
.ip_addr
= *ip
;
2629 ctx
->u
.neigh
.mac
= *mac
;
2630 ctx
->u
.neigh
.flags
= flags
;
2631 ctx
->u
.neigh
.state
= state
;
2633 /* Enqueue for processing on the dplane pthread */
2634 ret
= dplane_update_enqueue(ctx
);
2636 /* Increment counter */
2637 atomic_fetch_add_explicit(&zdplane_info
.dg_neighs_in
, 1,
2638 memory_order_relaxed
);
2641 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2644 atomic_fetch_add_explicit(&zdplane_info
.dg_neigh_errors
, 1,
2645 memory_order_relaxed
);
2646 dplane_ctx_free(&ctx
);
2653 * Handler for 'show dplane'
2655 int dplane_show_helper(struct vty
*vty
, bool detailed
)
2657 uint64_t queued
, queue_max
, limit
, errs
, incoming
, yields
,
2660 /* Using atomics because counters are being changed in different
2663 incoming
= atomic_load_explicit(&zdplane_info
.dg_routes_in
,
2664 memory_order_relaxed
);
2665 limit
= atomic_load_explicit(&zdplane_info
.dg_max_queued_updates
,
2666 memory_order_relaxed
);
2667 queued
= atomic_load_explicit(&zdplane_info
.dg_routes_queued
,
2668 memory_order_relaxed
);
2669 queue_max
= atomic_load_explicit(&zdplane_info
.dg_routes_queued_max
,
2670 memory_order_relaxed
);
2671 errs
= atomic_load_explicit(&zdplane_info
.dg_route_errors
,
2672 memory_order_relaxed
);
2673 yields
= atomic_load_explicit(&zdplane_info
.dg_update_yields
,
2674 memory_order_relaxed
);
2675 other_errs
= atomic_load_explicit(&zdplane_info
.dg_other_errors
,
2676 memory_order_relaxed
);
2678 vty_out(vty
, "Zebra dataplane:\nRoute updates: %"PRIu64
"\n",
2680 vty_out(vty
, "Route update errors: %"PRIu64
"\n", errs
);
2681 vty_out(vty
, "Other errors : %"PRIu64
"\n", other_errs
);
2682 vty_out(vty
, "Route update queue limit: %"PRIu64
"\n", limit
);
2683 vty_out(vty
, "Route update queue depth: %"PRIu64
"\n", queued
);
2684 vty_out(vty
, "Route update queue max: %"PRIu64
"\n", queue_max
);
2685 vty_out(vty
, "Dplane update yields: %"PRIu64
"\n", yields
);
2687 incoming
= atomic_load_explicit(&zdplane_info
.dg_lsps_in
,
2688 memory_order_relaxed
);
2689 errs
= atomic_load_explicit(&zdplane_info
.dg_lsp_errors
,
2690 memory_order_relaxed
);
2691 vty_out(vty
, "LSP updates: %"PRIu64
"\n", incoming
);
2692 vty_out(vty
, "LSP update errors: %"PRIu64
"\n", errs
);
2694 incoming
= atomic_load_explicit(&zdplane_info
.dg_pws_in
,
2695 memory_order_relaxed
);
2696 errs
= atomic_load_explicit(&zdplane_info
.dg_pw_errors
,
2697 memory_order_relaxed
);
2698 vty_out(vty
, "PW updates: %"PRIu64
"\n", incoming
);
2699 vty_out(vty
, "PW update errors: %"PRIu64
"\n", errs
);
2701 incoming
= atomic_load_explicit(&zdplane_info
.dg_intf_addrs_in
,
2702 memory_order_relaxed
);
2703 errs
= atomic_load_explicit(&zdplane_info
.dg_intf_addr_errors
,
2704 memory_order_relaxed
);
2705 vty_out(vty
, "Intf addr updates: %"PRIu64
"\n", incoming
);
2706 vty_out(vty
, "Intf addr errors: %"PRIu64
"\n", errs
);
2708 incoming
= atomic_load_explicit(&zdplane_info
.dg_macs_in
,
2709 memory_order_relaxed
);
2710 errs
= atomic_load_explicit(&zdplane_info
.dg_mac_errors
,
2711 memory_order_relaxed
);
2712 vty_out(vty
, "EVPN MAC updates: %"PRIu64
"\n", incoming
);
2713 vty_out(vty
, "EVPN MAC errors: %"PRIu64
"\n", errs
);
2715 incoming
= atomic_load_explicit(&zdplane_info
.dg_neighs_in
,
2716 memory_order_relaxed
);
2717 errs
= atomic_load_explicit(&zdplane_info
.dg_neigh_errors
,
2718 memory_order_relaxed
);
2719 vty_out(vty
, "EVPN neigh updates: %"PRIu64
"\n", incoming
);
2720 vty_out(vty
, "EVPN neigh errors: %"PRIu64
"\n", errs
);
2726 * Handler for 'show dplane providers'
2728 int dplane_show_provs_helper(struct vty
*vty
, bool detailed
)
2730 struct zebra_dplane_provider
*prov
;
2731 uint64_t in
, in_max
, out
, out_max
;
2733 vty_out(vty
, "Zebra dataplane providers:\n");
2736 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
2739 /* Show counters, useful info from each registered provider */
2742 in
= atomic_load_explicit(&prov
->dp_in_counter
,
2743 memory_order_relaxed
);
2744 in_max
= atomic_load_explicit(&prov
->dp_in_max
,
2745 memory_order_relaxed
);
2746 out
= atomic_load_explicit(&prov
->dp_out_counter
,
2747 memory_order_relaxed
);
2748 out_max
= atomic_load_explicit(&prov
->dp_out_max
,
2749 memory_order_relaxed
);
2751 vty_out(vty
, "%s (%u): in: %"PRIu64
", q_max: %"PRIu64
", "
2752 "out: %"PRIu64
", q_max: %"PRIu64
"\n",
2753 prov
->dp_name
, prov
->dp_id
, in
, in_max
, out
, out_max
);
2756 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
2764 * Helper for 'show run' etc.
2766 int dplane_config_write_helper(struct vty
*vty
)
2768 if (zdplane_info
.dg_max_queued_updates
!= DPLANE_DEFAULT_MAX_QUEUED
)
2769 vty_out(vty
, "zebra dplane limit %u\n",
2770 zdplane_info
.dg_max_queued_updates
);
2776 * Provider registration
2778 int dplane_provider_register(const char *name
,
2779 enum dplane_provider_prio prio
,
2781 int (*start_fp
)(struct zebra_dplane_provider
*),
2782 int (*fp
)(struct zebra_dplane_provider
*),
2783 int (*fini_fp
)(struct zebra_dplane_provider
*,
2786 struct zebra_dplane_provider
**prov_p
)
2789 struct zebra_dplane_provider
*p
= NULL
, *last
;
2797 if (prio
<= DPLANE_PRIO_NONE
||
2798 prio
> DPLANE_PRIO_LAST
) {
2803 /* Allocate and init new provider struct */
2804 p
= XCALLOC(MTYPE_DP_PROV
, sizeof(struct zebra_dplane_provider
));
2806 pthread_mutex_init(&(p
->dp_mutex
), NULL
);
2807 TAILQ_INIT(&(p
->dp_ctx_in_q
));
2808 TAILQ_INIT(&(p
->dp_ctx_out_q
));
2810 p
->dp_priority
= prio
;
2812 p
->dp_start
= start_fp
;
2813 p
->dp_fini
= fini_fp
;
2816 /* Lock - the dplane pthread may be running */
2819 p
->dp_id
= ++zdplane_info
.dg_provider_id
;
2822 strlcpy(p
->dp_name
, name
, DPLANE_PROVIDER_NAMELEN
);
2824 snprintf(p
->dp_name
, DPLANE_PROVIDER_NAMELEN
,
2825 "provider-%u", p
->dp_id
);
2827 /* Insert into list ordered by priority */
2828 TAILQ_FOREACH(last
, &zdplane_info
.dg_providers_q
, dp_prov_link
) {
2829 if (last
->dp_priority
> p
->dp_priority
)
2834 TAILQ_INSERT_BEFORE(last
, p
, dp_prov_link
);
2836 TAILQ_INSERT_TAIL(&zdplane_info
.dg_providers_q
, p
,
2842 if (IS_ZEBRA_DEBUG_DPLANE
)
2843 zlog_debug("dplane: registered new provider '%s' (%u), prio %d",
2844 p
->dp_name
, p
->dp_id
, p
->dp_priority
);
2853 /* Accessors for provider attributes */
2854 const char *dplane_provider_get_name(const struct zebra_dplane_provider
*prov
)
2856 return prov
->dp_name
;
2859 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider
*prov
)
2864 void *dplane_provider_get_data(const struct zebra_dplane_provider
*prov
)
2866 return prov
->dp_data
;
2869 int dplane_provider_get_work_limit(const struct zebra_dplane_provider
*prov
)
2871 return zdplane_info
.dg_updates_per_cycle
;
2874 /* Lock/unlock a provider's mutex - iff the provider was registered with
2875 * the THREADED flag.
2877 void dplane_provider_lock(struct zebra_dplane_provider
*prov
)
2879 if (dplane_provider_is_threaded(prov
))
2880 DPLANE_PROV_LOCK(prov
);
2883 void dplane_provider_unlock(struct zebra_dplane_provider
*prov
)
2885 if (dplane_provider_is_threaded(prov
))
2886 DPLANE_PROV_UNLOCK(prov
);
2890 * Dequeue and maintain associated counter
2892 struct zebra_dplane_ctx
*dplane_provider_dequeue_in_ctx(
2893 struct zebra_dplane_provider
*prov
)
2895 struct zebra_dplane_ctx
*ctx
= NULL
;
2897 dplane_provider_lock(prov
);
2899 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
2901 TAILQ_REMOVE(&(prov
->dp_ctx_in_q
), ctx
, zd_q_entries
);
2903 atomic_fetch_sub_explicit(&prov
->dp_in_queued
, 1,
2904 memory_order_relaxed
);
2907 dplane_provider_unlock(prov
);
2913 * Dequeue work to a list, return count
2915 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider
*prov
,
2916 struct dplane_ctx_q
*listp
)
2919 struct zebra_dplane_ctx
*ctx
;
2921 limit
= zdplane_info
.dg_updates_per_cycle
;
2923 dplane_provider_lock(prov
);
2925 for (ret
= 0; ret
< limit
; ret
++) {
2926 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
2928 TAILQ_REMOVE(&(prov
->dp_ctx_in_q
), ctx
, zd_q_entries
);
2930 TAILQ_INSERT_TAIL(listp
, ctx
, zd_q_entries
);
2937 atomic_fetch_sub_explicit(&prov
->dp_in_queued
, ret
,
2938 memory_order_relaxed
);
2940 dplane_provider_unlock(prov
);
2946 * Enqueue and maintain associated counter
2948 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider
*prov
,
2949 struct zebra_dplane_ctx
*ctx
)
2951 dplane_provider_lock(prov
);
2953 TAILQ_INSERT_TAIL(&(prov
->dp_ctx_out_q
), ctx
,
2956 dplane_provider_unlock(prov
);
2958 atomic_fetch_add_explicit(&(prov
->dp_out_counter
), 1,
2959 memory_order_relaxed
);
2963 * Accessor for provider object
2965 bool dplane_provider_is_threaded(const struct zebra_dplane_provider
*prov
)
2967 return (prov
->dp_flags
& DPLANE_PROV_FLAG_THREADED
);
2971 * Internal helper that copies information from a zebra ns object; this is
2972 * called in the zebra main pthread context as part of dplane ctx init.
2974 static void dplane_info_from_zns(struct zebra_dplane_info
*ns_info
,
2975 struct zebra_ns
*zns
)
2977 ns_info
->ns_id
= zns
->ns_id
;
2979 #if defined(HAVE_NETLINK)
2980 ns_info
->is_cmd
= true;
2981 ns_info
->nls
= zns
->netlink_dplane
;
2982 #endif /* NETLINK */
2986 * Provider api to signal that work/events are available
2987 * for the dataplane pthread.
2989 int dplane_provider_work_ready(void)
2991 /* Note that during zebra startup, we may be offered work before
2992 * the dataplane pthread (and thread-master) are ready. We want to
2993 * enqueue the work, but the event-scheduling machinery may not be
2996 if (zdplane_info
.dg_run
) {
2997 thread_add_event(zdplane_info
.dg_master
,
2998 dplane_thread_loop
, NULL
, 0,
2999 &zdplane_info
.dg_t_update
);
3006 * Enqueue a context directly to zebra main.
3008 void dplane_provider_enqueue_to_zebra(struct zebra_dplane_ctx
*ctx
)
3010 struct dplane_ctx_q temp_list
;
3012 /* Zebra's api takes a list, so we need to use a temporary list */
3013 TAILQ_INIT(&temp_list
);
3015 TAILQ_INSERT_TAIL(&temp_list
, ctx
, zd_q_entries
);
3016 (zdplane_info
.dg_results_cb
)(&temp_list
);
3020 * Kernel dataplane provider
3024 * Handler for kernel LSP updates
3026 static enum zebra_dplane_result
3027 kernel_dplane_lsp_update(struct zebra_dplane_ctx
*ctx
)
3029 enum zebra_dplane_result res
;
3031 /* Call into the synchronous kernel-facing code here */
3032 res
= kernel_lsp_update(ctx
);
3034 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3035 atomic_fetch_add_explicit(
3036 &zdplane_info
.dg_lsp_errors
, 1,
3037 memory_order_relaxed
);
3043 * Handler for kernel pseudowire updates
3045 static enum zebra_dplane_result
3046 kernel_dplane_pw_update(struct zebra_dplane_ctx
*ctx
)
3048 enum zebra_dplane_result res
;
3050 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3051 zlog_debug("Dplane pw %s: op %s af %d loc: %u rem: %u",
3052 dplane_ctx_get_ifname(ctx
),
3053 dplane_op2str(ctx
->zd_op
),
3054 dplane_ctx_get_pw_af(ctx
),
3055 dplane_ctx_get_pw_local_label(ctx
),
3056 dplane_ctx_get_pw_remote_label(ctx
));
3058 res
= kernel_pw_update(ctx
);
3060 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3061 atomic_fetch_add_explicit(
3062 &zdplane_info
.dg_pw_errors
, 1,
3063 memory_order_relaxed
);
3069 * Handler for kernel route updates
3071 static enum zebra_dplane_result
3072 kernel_dplane_route_update(struct zebra_dplane_ctx
*ctx
)
3074 enum zebra_dplane_result res
;
3076 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3077 char dest_str
[PREFIX_STRLEN
];
3079 prefix2str(dplane_ctx_get_dest(ctx
),
3080 dest_str
, sizeof(dest_str
));
3082 zlog_debug("%u:%s Dplane route update ctx %p op %s",
3083 dplane_ctx_get_vrf(ctx
), dest_str
,
3084 ctx
, dplane_op2str(dplane_ctx_get_op(ctx
)));
3087 /* Call into the synchronous kernel-facing code here */
3088 res
= kernel_route_update(ctx
);
3090 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3091 atomic_fetch_add_explicit(
3092 &zdplane_info
.dg_route_errors
, 1,
3093 memory_order_relaxed
);
3099 * Handler for kernel-facing interface address updates
3101 static enum zebra_dplane_result
3102 kernel_dplane_address_update(struct zebra_dplane_ctx
*ctx
)
3104 enum zebra_dplane_result res
;
3106 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3107 char dest_str
[PREFIX_STRLEN
];
3109 prefix2str(dplane_ctx_get_intf_addr(ctx
), dest_str
,
3112 zlog_debug("Dplane intf %s, idx %u, addr %s",
3113 dplane_op2str(dplane_ctx_get_op(ctx
)),
3114 dplane_ctx_get_ifindex(ctx
), dest_str
);
3117 res
= kernel_address_update_ctx(ctx
);
3119 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3120 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addr_errors
,
3121 1, memory_order_relaxed
);
3127 * kernel_dplane_nexthop_update() - Handler for kernel nexthop updates
3129 * @ctx: Dataplane context
3131 * Return: Dataplane result flag
3133 static enum zebra_dplane_result
3134 kernel_dplane_nexthop_update(struct zebra_dplane_ctx
*ctx
)
3136 enum zebra_dplane_result res
;
3138 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3139 zlog_debug("ID (%u) Dplane nexthop update ctx %p op %s",
3140 dplane_ctx_get_nhe_id(ctx
), ctx
,
3141 dplane_op2str(dplane_ctx_get_op(ctx
)));
3144 res
= kernel_nexthop_update(ctx
);
3146 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3147 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthop_errors
, 1,
3148 memory_order_relaxed
);
3154 * Handler for kernel-facing EVPN MAC address updates
3156 static enum zebra_dplane_result
3157 kernel_dplane_mac_update(struct zebra_dplane_ctx
*ctx
)
3159 enum zebra_dplane_result res
;
3161 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3162 char buf
[ETHER_ADDR_STRLEN
];
3164 prefix_mac2str(dplane_ctx_mac_get_addr(ctx
), buf
,
3167 zlog_debug("Dplane %s, mac %s, ifindex %u",
3168 dplane_op2str(dplane_ctx_get_op(ctx
)),
3169 buf
, dplane_ctx_get_ifindex(ctx
));
3172 res
= kernel_mac_update_ctx(ctx
);
3174 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3175 atomic_fetch_add_explicit(&zdplane_info
.dg_mac_errors
,
3176 1, memory_order_relaxed
);
3182 * Handler for kernel-facing EVPN neighbor updates
3184 static enum zebra_dplane_result
3185 kernel_dplane_neigh_update(struct zebra_dplane_ctx
*ctx
)
3187 enum zebra_dplane_result res
;
3189 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3190 char buf
[PREFIX_STRLEN
];
3192 ipaddr2str(dplane_ctx_neigh_get_ipaddr(ctx
), buf
,
3195 zlog_debug("Dplane %s, ip %s, ifindex %u",
3196 dplane_op2str(dplane_ctx_get_op(ctx
)),
3197 buf
, dplane_ctx_get_ifindex(ctx
));
3200 res
= kernel_neigh_update_ctx(ctx
);
3202 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3203 atomic_fetch_add_explicit(&zdplane_info
.dg_neigh_errors
,
3204 1, memory_order_relaxed
);
3210 * Kernel provider callback
3212 static int kernel_dplane_process_func(struct zebra_dplane_provider
*prov
)
3214 enum zebra_dplane_result res
;
3215 struct zebra_dplane_ctx
*ctx
;
3218 limit
= dplane_provider_get_work_limit(prov
);
3220 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3221 zlog_debug("dplane provider '%s': processing",
3222 dplane_provider_get_name(prov
));
3224 for (counter
= 0; counter
< limit
; counter
++) {
3226 ctx
= dplane_provider_dequeue_in_ctx(prov
);
3230 /* A previous provider plugin may have asked to skip the
3233 if (dplane_ctx_is_skip_kernel(ctx
)) {
3234 res
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
3238 /* Dispatch to appropriate kernel-facing apis */
3239 switch (dplane_ctx_get_op(ctx
)) {
3241 case DPLANE_OP_ROUTE_INSTALL
:
3242 case DPLANE_OP_ROUTE_UPDATE
:
3243 case DPLANE_OP_ROUTE_DELETE
:
3244 res
= kernel_dplane_route_update(ctx
);
3247 case DPLANE_OP_NH_INSTALL
:
3248 case DPLANE_OP_NH_UPDATE
:
3249 case DPLANE_OP_NH_DELETE
:
3250 res
= kernel_dplane_nexthop_update(ctx
);
3253 case DPLANE_OP_LSP_INSTALL
:
3254 case DPLANE_OP_LSP_UPDATE
:
3255 case DPLANE_OP_LSP_DELETE
:
3256 res
= kernel_dplane_lsp_update(ctx
);
3259 case DPLANE_OP_PW_INSTALL
:
3260 case DPLANE_OP_PW_UNINSTALL
:
3261 res
= kernel_dplane_pw_update(ctx
);
3264 case DPLANE_OP_ADDR_INSTALL
:
3265 case DPLANE_OP_ADDR_UNINSTALL
:
3266 res
= kernel_dplane_address_update(ctx
);
3269 case DPLANE_OP_MAC_INSTALL
:
3270 case DPLANE_OP_MAC_DELETE
:
3271 res
= kernel_dplane_mac_update(ctx
);
3274 case DPLANE_OP_NEIGH_INSTALL
:
3275 case DPLANE_OP_NEIGH_UPDATE
:
3276 case DPLANE_OP_NEIGH_DELETE
:
3277 case DPLANE_OP_VTEP_ADD
:
3278 case DPLANE_OP_VTEP_DELETE
:
3279 res
= kernel_dplane_neigh_update(ctx
);
3282 /* Ignore 'notifications' - no-op */
3283 case DPLANE_OP_SYS_ROUTE_ADD
:
3284 case DPLANE_OP_SYS_ROUTE_DELETE
:
3285 case DPLANE_OP_ROUTE_NOTIFY
:
3286 case DPLANE_OP_LSP_NOTIFY
:
3287 res
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
3291 atomic_fetch_add_explicit(
3292 &zdplane_info
.dg_other_errors
, 1,
3293 memory_order_relaxed
);
3295 res
= ZEBRA_DPLANE_REQUEST_FAILURE
;
3300 dplane_ctx_set_status(ctx
, res
);
3302 dplane_provider_enqueue_out_ctx(prov
, ctx
);
3305 /* Ensure that we'll run the work loop again if there's still
3308 if (counter
>= limit
) {
3309 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3310 zlog_debug("dplane provider '%s' reached max updates %d",
3311 dplane_provider_get_name(prov
), counter
);
3313 atomic_fetch_add_explicit(&zdplane_info
.dg_update_yields
,
3314 1, memory_order_relaxed
);
3316 dplane_provider_work_ready();
3322 #if DPLANE_TEST_PROVIDER
3325 * Test dataplane provider plugin
3329 * Test provider process callback
3331 static int test_dplane_process_func(struct zebra_dplane_provider
*prov
)
3333 struct zebra_dplane_ctx
*ctx
;
3336 /* Just moving from 'in' queue to 'out' queue */
3338 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3339 zlog_debug("dplane provider '%s': processing",
3340 dplane_provider_get_name(prov
));
3342 limit
= dplane_provider_get_work_limit(prov
);
3344 for (counter
= 0; counter
< limit
; counter
++) {
3346 ctx
= dplane_provider_dequeue_in_ctx(prov
);
3350 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3351 zlog_debug("dplane provider '%s': op %s",
3352 dplane_provider_get_name(prov
),
3353 dplane_op2str(dplane_ctx_get_op(ctx
)));
3355 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_SUCCESS
);
3357 dplane_provider_enqueue_out_ctx(prov
, ctx
);
3360 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3361 zlog_debug("dplane provider '%s': processed %d",
3362 dplane_provider_get_name(prov
), counter
);
3364 /* Ensure that we'll run the work loop again if there's still
3367 if (counter
>= limit
)
3368 dplane_provider_work_ready();
3374 * Test provider shutdown/fini callback
3376 static int test_dplane_shutdown_func(struct zebra_dplane_provider
*prov
,
3379 if (IS_ZEBRA_DEBUG_DPLANE
)
3380 zlog_debug("dplane provider '%s': %sshutdown",
3381 dplane_provider_get_name(prov
),
3382 early
? "early " : "");
3386 #endif /* DPLANE_TEST_PROVIDER */
3389 * Register default kernel provider
3391 static void dplane_provider_init(void)
3395 ret
= dplane_provider_register("Kernel",
3397 DPLANE_PROV_FLAGS_DEFAULT
, NULL
,
3398 kernel_dplane_process_func
,
3403 zlog_err("Unable to register kernel dplane provider: %d",
3406 #if DPLANE_TEST_PROVIDER
3407 /* Optional test provider ... */
3408 ret
= dplane_provider_register("Test",
3409 DPLANE_PRIO_PRE_KERNEL
,
3410 DPLANE_PROV_FLAGS_DEFAULT
, NULL
,
3411 test_dplane_process_func
,
3412 test_dplane_shutdown_func
,
3413 NULL
/* data */, NULL
);
3416 zlog_err("Unable to register test dplane provider: %d",
3418 #endif /* DPLANE_TEST_PROVIDER */
3421 /* Indicates zebra shutdown/exit is in progress. Some operations may be
3422 * simplified or skipped during shutdown processing.
3424 bool dplane_is_in_shutdown(void)
3426 return zdplane_info
.dg_is_shutdown
;
3430 * Early or pre-shutdown, de-init notification api. This runs pretty
3431 * early during zebra shutdown, as a signal to stop new work and prepare
3432 * for updates generated by shutdown/cleanup activity, as zebra tries to
3433 * remove everything it's responsible for.
3434 * NB: This runs in the main zebra pthread context.
3436 void zebra_dplane_pre_finish(void)
3438 if (IS_ZEBRA_DEBUG_DPLANE
)
3439 zlog_debug("Zebra dataplane pre-fini called");
3441 zdplane_info
.dg_is_shutdown
= true;
3443 /* TODO -- Notify provider(s) of pending shutdown */
3447 * Utility to determine whether work remains enqueued within the dplane;
3448 * used during system shutdown processing.
3450 static bool dplane_work_pending(void)
3453 struct zebra_dplane_ctx
*ctx
;
3454 struct zebra_dplane_provider
*prov
;
3456 /* TODO -- just checking incoming/pending work for now, must check
3461 ctx
= TAILQ_FIRST(&zdplane_info
.dg_update_ctx_q
);
3462 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3473 dplane_provider_lock(prov
);
3475 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
3477 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_out_q
));
3479 dplane_provider_unlock(prov
);
3485 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3497 * Shutdown-time intermediate callback, used to determine when all pending
3498 * in-flight updates are done. If there's still work to do, reschedules itself.
3499 * If all work is done, schedules an event to the main zebra thread for
3500 * final zebra shutdown.
3501 * This runs in the dplane pthread context.
3503 static int dplane_check_shutdown_status(struct thread
*event
)
3505 if (IS_ZEBRA_DEBUG_DPLANE
)
3506 zlog_debug("Zebra dataplane shutdown status check called");
3508 if (dplane_work_pending()) {
3509 /* Reschedule dplane check on a short timer */
3510 thread_add_timer_msec(zdplane_info
.dg_master
,
3511 dplane_check_shutdown_status
,
3513 &zdplane_info
.dg_t_shutdown_check
);
3515 /* TODO - give up and stop waiting after a short time? */
3518 /* We appear to be done - schedule a final callback event
3519 * for the zebra main pthread.
3521 thread_add_event(zrouter
.master
, zebra_finalize
, NULL
, 0, NULL
);
3528 * Shutdown, de-init api. This runs pretty late during shutdown,
3529 * after zebra has tried to free/remove/uninstall all routes during shutdown.
3530 * At this point, dplane work may still remain to be done, so we can't just
3531 * blindly terminate. If there's still work to do, we'll periodically check
3532 * and when done, we'll enqueue a task to the zebra main thread for final
3533 * termination processing.
3535 * NB: This runs in the main zebra thread context.
3537 void zebra_dplane_finish(void)
3539 if (IS_ZEBRA_DEBUG_DPLANE
)
3540 zlog_debug("Zebra dataplane fini called");
3542 thread_add_event(zdplane_info
.dg_master
,
3543 dplane_check_shutdown_status
, NULL
, 0,
3544 &zdplane_info
.dg_t_shutdown_check
);
3548 * Main dataplane pthread event loop. The thread takes new incoming work
3549 * and offers it to the first provider. It then iterates through the
3550 * providers, taking complete work from each one and offering it
3551 * to the next in order. At each step, a limited number of updates are
3552 * processed during a cycle in order to provide some fairness.
3554 * This loop through the providers is only run once, so that the dataplane
3555 * pthread can look for other pending work - such as i/o work on behalf of
3558 static int dplane_thread_loop(struct thread
*event
)
3560 struct dplane_ctx_q work_list
;
3561 struct dplane_ctx_q error_list
;
3562 struct zebra_dplane_provider
*prov
;
3563 struct zebra_dplane_ctx
*ctx
, *tctx
;
3564 int limit
, counter
, error_counter
;
3565 uint64_t curr
, high
;
3567 /* Capture work limit per cycle */
3568 limit
= zdplane_info
.dg_updates_per_cycle
;
3570 /* Init temporary lists used to move contexts among providers */
3571 TAILQ_INIT(&work_list
);
3572 TAILQ_INIT(&error_list
);
3575 /* Check for zebra shutdown */
3576 if (!zdplane_info
.dg_run
)
3579 /* Dequeue some incoming work from zebra (if any) onto the temporary
3584 /* Locate initial registered provider */
3585 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3587 /* Move new work from incoming list to temp list */
3588 for (counter
= 0; counter
< limit
; counter
++) {
3589 ctx
= TAILQ_FIRST(&zdplane_info
.dg_update_ctx_q
);
3591 TAILQ_REMOVE(&zdplane_info
.dg_update_ctx_q
, ctx
,
3594 ctx
->zd_provider
= prov
->dp_id
;
3596 TAILQ_INSERT_TAIL(&work_list
, ctx
, zd_q_entries
);
3604 atomic_fetch_sub_explicit(&zdplane_info
.dg_routes_queued
, counter
,
3605 memory_order_relaxed
);
3607 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3608 zlog_debug("dplane: incoming new work counter: %d", counter
);
3610 /* Iterate through the registered providers, offering new incoming
3611 * work. If the provider has outgoing work in its queue, take that
3612 * work for the next provider
3616 /* At each iteration, the temporary work list has 'counter'
3619 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3620 zlog_debug("dplane enqueues %d new work to provider '%s'",
3621 counter
, dplane_provider_get_name(prov
));
3623 /* Capture current provider id in each context; check for
3626 TAILQ_FOREACH_SAFE(ctx
, &work_list
, zd_q_entries
, tctx
) {
3627 if (dplane_ctx_get_status(ctx
) ==
3628 ZEBRA_DPLANE_REQUEST_SUCCESS
) {
3629 ctx
->zd_provider
= prov
->dp_id
;
3632 * TODO -- improve error-handling: recirc
3633 * errors backwards so that providers can
3634 * 'undo' their work (if they want to)
3637 /* Move to error list; will be returned
3640 TAILQ_REMOVE(&work_list
, ctx
, zd_q_entries
);
3641 TAILQ_INSERT_TAIL(&error_list
,
3647 /* Enqueue new work to the provider */
3648 dplane_provider_lock(prov
);
3650 if (TAILQ_FIRST(&work_list
))
3651 TAILQ_CONCAT(&(prov
->dp_ctx_in_q
), &work_list
,
3654 atomic_fetch_add_explicit(&prov
->dp_in_counter
, counter
,
3655 memory_order_relaxed
);
3656 atomic_fetch_add_explicit(&prov
->dp_in_queued
, counter
,
3657 memory_order_relaxed
);
3658 curr
= atomic_load_explicit(&prov
->dp_in_queued
,
3659 memory_order_relaxed
);
3660 high
= atomic_load_explicit(&prov
->dp_in_max
,
3661 memory_order_relaxed
);
3663 atomic_store_explicit(&prov
->dp_in_max
, curr
,
3664 memory_order_relaxed
);
3666 dplane_provider_unlock(prov
);
3668 /* Reset the temp list (though the 'concat' may have done this
3669 * already), and the counter
3671 TAILQ_INIT(&work_list
);
3674 /* Call into the provider code. Note that this is
3675 * unconditional: we offer to do work even if we don't enqueue
3678 (*prov
->dp_fp
)(prov
);
3680 /* Check for zebra shutdown */
3681 if (!zdplane_info
.dg_run
)
3684 /* Dequeue completed work from the provider */
3685 dplane_provider_lock(prov
);
3687 while (counter
< limit
) {
3688 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_out_q
));
3690 TAILQ_REMOVE(&(prov
->dp_ctx_out_q
), ctx
,
3693 TAILQ_INSERT_TAIL(&work_list
,
3700 dplane_provider_unlock(prov
);
3702 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3703 zlog_debug("dplane dequeues %d completed work from provider %s",
3704 counter
, dplane_provider_get_name(prov
));
3706 /* Locate next provider */
3708 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3712 /* After all providers have been serviced, enqueue any completed
3713 * work and any errors back to zebra so it can process the results.
3715 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3716 zlog_debug("dplane has %d completed, %d errors, for zebra main",
3717 counter
, error_counter
);
3720 * Hand lists through the api to zebra main,
3721 * to reduce the number of lock/unlock cycles
3724 /* Call through to zebra main */
3725 (zdplane_info
.dg_results_cb
)(&error_list
);
3727 TAILQ_INIT(&error_list
);
3729 /* Call through to zebra main */
3730 (zdplane_info
.dg_results_cb
)(&work_list
);
3732 TAILQ_INIT(&work_list
);
3739 * Final phase of shutdown, after all work enqueued to dplane has been
3740 * processed. This is called from the zebra main pthread context.
3742 void zebra_dplane_shutdown(void)
3744 if (IS_ZEBRA_DEBUG_DPLANE
)
3745 zlog_debug("Zebra dataplane shutdown called");
3747 /* Stop dplane thread, if it's running */
3749 zdplane_info
.dg_run
= false;
3751 THREAD_OFF(zdplane_info
.dg_t_update
);
3753 frr_pthread_stop(zdplane_info
.dg_pthread
, NULL
);
3755 /* Destroy pthread */
3756 frr_pthread_destroy(zdplane_info
.dg_pthread
);
3757 zdplane_info
.dg_pthread
= NULL
;
3758 zdplane_info
.dg_master
= NULL
;
3760 /* TODO -- Notify provider(s) of final shutdown */
3762 /* TODO -- Clean-up provider objects */
3764 /* TODO -- Clean queue(s), free memory */
3768 * Initialize the dataplane module during startup, internal/private version
3770 static void zebra_dplane_init_internal(void)
3772 memset(&zdplane_info
, 0, sizeof(zdplane_info
));
3774 pthread_mutex_init(&zdplane_info
.dg_mutex
, NULL
);
3776 TAILQ_INIT(&zdplane_info
.dg_update_ctx_q
);
3777 TAILQ_INIT(&zdplane_info
.dg_providers_q
);
3779 zdplane_info
.dg_updates_per_cycle
= DPLANE_DEFAULT_NEW_WORK
;
3781 zdplane_info
.dg_max_queued_updates
= DPLANE_DEFAULT_MAX_QUEUED
;
3783 /* Register default kernel 'provider' during init */
3784 dplane_provider_init();
3788 * Start the dataplane pthread. This step needs to be run later than the
3789 * 'init' step, in case zebra has fork-ed.
3791 void zebra_dplane_start(void)
3793 struct zebra_dplane_provider
*prov
;
3794 struct frr_pthread_attr pattr
= {
3795 .start
= frr_pthread_attr_default
.start
,
3796 .stop
= frr_pthread_attr_default
.stop
3799 /* Start dataplane pthread */
3801 zdplane_info
.dg_pthread
= frr_pthread_new(&pattr
, "Zebra dplane thread",
3804 zdplane_info
.dg_master
= zdplane_info
.dg_pthread
->master
;
3806 zdplane_info
.dg_run
= true;
3808 /* Enqueue an initial event for the dataplane pthread */
3809 thread_add_event(zdplane_info
.dg_master
, dplane_thread_loop
, NULL
, 0,
3810 &zdplane_info
.dg_t_update
);
3812 /* Call start callbacks for registered providers */
3815 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3821 (prov
->dp_start
)(prov
);
3823 /* Locate next provider */
3825 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3829 frr_pthread_run(zdplane_info
.dg_pthread
, NULL
);
3833 * Initialize the dataplane module at startup; called by zebra rib_init()
3835 void zebra_dplane_init(int (*results_fp
)(struct dplane_ctx_q
*))
3837 zebra_dplane_init_internal();
3838 zdplane_info
.dg_results_cb
= results_fp
;