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
));
1528 if (re
->nhe_id
&& zns
->supports_nh
)
1529 ctx
->u
.rinfo
.nhe
.id
= re
->nhe_id
;
1531 /* Trying out the sequence number idea, so we can try to detect
1532 * when a result is stale.
1534 re
->dplane_sequence
= zebra_router_get_next_sequence();
1535 ctx
->zd_seq
= re
->dplane_sequence
;
1544 * dplane_ctx_nexthop_init() - Initialize a context block for a nexthop update
1546 * @ctx: Dataplane context to init
1547 * @op: Operation being performed
1548 * @nhe: Nexthop group hash entry
1550 * Return: Result status
1552 static int dplane_ctx_nexthop_init(struct zebra_dplane_ctx
*ctx
,
1553 enum dplane_op_e op
,
1554 struct nhg_hash_entry
*nhe
)
1556 struct zebra_ns
*zns
= NULL
;
1564 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1566 /* Copy over nhe info */
1567 ctx
->u
.rinfo
.nhe
.id
= nhe
->id
;
1568 ctx
->u
.rinfo
.nhe
.afi
= nhe
->afi
;
1569 ctx
->u
.rinfo
.nhe
.vrf_id
= nhe
->vrf_id
;
1570 ctx
->u
.rinfo
.nhe
.is_kernel_nh
= nhe
->is_kernel_nh
;
1572 nexthop_group_copy(&(ctx
->u
.rinfo
.nhe
.ng
), nhe
->nhg
);
1574 if (!zebra_nhg_depends_is_empty(nhe
)) {
1575 struct nhg_connected
*rb_node_dep
= NULL
;
1578 // TODO: This doesn't work with depends being recursive
1579 // resolved nh's as well. Yea, good luck future stephen
1582 RB_FOREACH (rb_node_dep
, nhg_connected_head
,
1583 &nhe
->nhg_depends
) {
1584 ctx
->u
.rinfo
.nhe
.nh_grp
[i
].id
= rb_node_dep
->nhe
->id
;
1585 /* We aren't using weights for anything right now */
1586 ctx
->u
.rinfo
.nhe
.nh_grp
[i
].weight
= 0;
1589 ctx
->u
.rinfo
.nhe
.nh_grp_count
= i
;
1592 /* Extract ns info - can't use pointers to 'core'
1594 zns
= ((struct zebra_vrf
*)vrf_info_lookup(nhe
->vrf_id
))->zns
;
1596 // TODO: Might not need to mark this as an update, since
1597 // it probably won't require two messages
1598 dplane_ctx_ns_init(ctx
, zns
, (op
== DPLANE_OP_NH_UPDATE
));
1607 * Capture information for an LSP update in a dplane context.
1609 static int dplane_ctx_lsp_init(struct zebra_dplane_ctx
*ctx
,
1610 enum dplane_op_e op
,
1614 zebra_nhlfe_t
*nhlfe
, *new_nhlfe
;
1616 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1617 zlog_debug("init dplane ctx %s: in-label %u ecmp# %d",
1618 dplane_op2str(op
), lsp
->ile
.in_label
,
1622 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1624 /* Capture namespace info */
1625 dplane_ctx_ns_init(ctx
, zebra_ns_lookup(NS_DEFAULT
),
1626 (op
== DPLANE_OP_LSP_UPDATE
));
1628 memset(&ctx
->u
.lsp
, 0, sizeof(ctx
->u
.lsp
));
1630 ctx
->u
.lsp
.ile
= lsp
->ile
;
1631 ctx
->u
.lsp
.addr_family
= lsp
->addr_family
;
1632 ctx
->u
.lsp
.num_ecmp
= lsp
->num_ecmp
;
1633 ctx
->u
.lsp
.flags
= lsp
->flags
;
1635 /* Copy source LSP's nhlfes, and capture 'best' nhlfe */
1636 for (nhlfe
= lsp
->nhlfe_list
; nhlfe
; nhlfe
= nhlfe
->next
) {
1637 /* Not sure if this is meaningful... */
1638 if (nhlfe
->nexthop
== NULL
)
1642 zebra_mpls_lsp_add_nhlfe(
1645 nhlfe
->nexthop
->type
,
1646 &(nhlfe
->nexthop
->gate
),
1647 nhlfe
->nexthop
->ifindex
,
1648 nhlfe
->nexthop
->nh_label
->label
[0]);
1650 if (new_nhlfe
== NULL
|| new_nhlfe
->nexthop
== NULL
) {
1655 /* Need to copy flags too */
1656 new_nhlfe
->flags
= nhlfe
->flags
;
1657 new_nhlfe
->nexthop
->flags
= nhlfe
->nexthop
->flags
;
1659 if (nhlfe
== lsp
->best_nhlfe
)
1660 ctx
->u
.lsp
.best_nhlfe
= new_nhlfe
;
1663 /* On error the ctx will be cleaned-up, so we don't need to
1664 * deal with any allocated nhlfe or nexthop structs here.
1671 * Capture information for an LSP update in a dplane context.
1673 static int dplane_ctx_pw_init(struct zebra_dplane_ctx
*ctx
,
1674 enum dplane_op_e op
,
1675 struct zebra_pw
*pw
)
1679 struct route_table
*table
;
1680 struct route_node
*rn
;
1681 struct route_entry
*re
;
1683 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1684 zlog_debug("init dplane ctx %s: pw '%s', loc %u, rem %u",
1685 dplane_op2str(op
), pw
->ifname
, pw
->local_label
,
1689 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1691 /* Capture namespace info: no netlink support as of 12/18,
1692 * but just in case...
1694 dplane_ctx_ns_init(ctx
, zebra_ns_lookup(NS_DEFAULT
), false);
1696 memset(&ctx
->u
.pw
, 0, sizeof(ctx
->u
.pw
));
1698 /* This name appears to be c-string, so we use string copy. */
1699 strlcpy(ctx
->zd_ifname
, pw
->ifname
, sizeof(ctx
->zd_ifname
));
1701 ctx
->zd_vrf_id
= pw
->vrf_id
;
1702 ctx
->zd_ifindex
= pw
->ifindex
;
1703 ctx
->u
.pw
.type
= pw
->type
;
1704 ctx
->u
.pw
.af
= pw
->af
;
1705 ctx
->u
.pw
.local_label
= pw
->local_label
;
1706 ctx
->u
.pw
.remote_label
= pw
->remote_label
;
1707 ctx
->u
.pw
.flags
= pw
->flags
;
1709 ctx
->u
.pw
.dest
= pw
->nexthop
;
1711 ctx
->u
.pw
.fields
= pw
->data
;
1713 /* Capture nexthop info for the pw destination. We need to look
1714 * up and use zebra datastructs, but we're running in the zebra
1715 * pthread here so that should be ok.
1717 memcpy(&p
.u
, &pw
->nexthop
, sizeof(pw
->nexthop
));
1719 p
.prefixlen
= ((pw
->af
== AF_INET
) ?
1720 IPV4_MAX_PREFIXLEN
: IPV6_MAX_PREFIXLEN
);
1722 afi
= (pw
->af
== AF_INET
) ? AFI_IP
: AFI_IP6
;
1723 table
= zebra_vrf_table(afi
, SAFI_UNICAST
, pw
->vrf_id
);
1725 rn
= route_node_match(table
, &p
);
1727 RNODE_FOREACH_RE(rn
, re
) {
1728 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
))
1733 copy_nexthops(&(ctx
->u
.pw
.nhg
.nexthop
),
1734 re
->ng
->nexthop
, NULL
);
1736 route_unlock_node(rn
);
1744 * Enqueue a new update,
1745 * and ensure an event is active for the dataplane pthread.
1747 static int dplane_update_enqueue(struct zebra_dplane_ctx
*ctx
)
1750 uint32_t high
, curr
;
1752 /* Enqueue for processing by the dataplane pthread */
1755 TAILQ_INSERT_TAIL(&zdplane_info
.dg_update_ctx_q
, ctx
,
1760 curr
= atomic_add_fetch_explicit(
1762 /* TODO -- issue with the clang atomic/intrinsics currently;
1763 * casting away the 'Atomic'-ness of the variable works.
1765 (uint32_t *)&(zdplane_info
.dg_routes_queued
),
1767 &(zdplane_info
.dg_routes_queued
),
1769 1, memory_order_seq_cst
);
1771 /* Maybe update high-water counter also */
1772 high
= atomic_load_explicit(&zdplane_info
.dg_routes_queued_max
,
1773 memory_order_seq_cst
);
1774 while (high
< curr
) {
1775 if (atomic_compare_exchange_weak_explicit(
1776 &zdplane_info
.dg_routes_queued_max
,
1778 memory_order_seq_cst
,
1779 memory_order_seq_cst
))
1783 /* Ensure that an event for the dataplane thread is active */
1784 ret
= dplane_provider_work_ready();
1790 * Utility that prepares a route update and enqueues it for processing
1792 static enum zebra_dplane_result
1793 dplane_route_update_internal(struct route_node
*rn
,
1794 struct route_entry
*re
,
1795 struct route_entry
*old_re
,
1796 enum dplane_op_e op
)
1798 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1800 struct zebra_dplane_ctx
*ctx
= NULL
;
1802 /* Obtain context block */
1803 ctx
= dplane_ctx_alloc();
1805 /* Init context with info from zebra data structs */
1806 ret
= dplane_ctx_route_init(ctx
, op
, rn
, re
);
1808 /* Capture some extra info for update case
1809 * where there's a different 'old' route.
1811 if ((op
== DPLANE_OP_ROUTE_UPDATE
) &&
1812 old_re
&& (old_re
!= re
)) {
1813 ctx
->zd_is_update
= true;
1815 old_re
->dplane_sequence
=
1816 zebra_router_get_next_sequence();
1817 ctx
->zd_old_seq
= old_re
->dplane_sequence
;
1819 ctx
->u
.rinfo
.zd_old_tag
= old_re
->tag
;
1820 ctx
->u
.rinfo
.zd_old_type
= old_re
->type
;
1821 ctx
->u
.rinfo
.zd_old_instance
= old_re
->instance
;
1822 ctx
->u
.rinfo
.zd_old_distance
= old_re
->distance
;
1823 ctx
->u
.rinfo
.zd_old_metric
= old_re
->metric
;
1825 #ifndef HAVE_NETLINK
1826 /* For bsd, capture previous re's nexthops too, sigh.
1827 * We'll need these to do per-nexthop deletes.
1829 copy_nexthops(&(ctx
->u
.rinfo
.zd_old_ng
.nexthop
),
1830 old_re
->ng
.nexthop
, NULL
);
1831 #endif /* !HAVE_NETLINK */
1834 /* Enqueue context for processing */
1835 ret
= dplane_update_enqueue(ctx
);
1838 /* Update counter */
1839 atomic_fetch_add_explicit(&zdplane_info
.dg_routes_in
, 1,
1840 memory_order_relaxed
);
1843 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
1845 atomic_fetch_add_explicit(&zdplane_info
.dg_route_errors
, 1,
1846 memory_order_relaxed
);
1848 dplane_ctx_free(&ctx
);
1855 * dplane_nexthop_update_internal() - Helper for enqueuing nexthop changes
1857 * @nhe: Nexthop group hash entry where the change occured
1858 * @op: The operation to be enqued
1860 * Return: Result of the change
1862 static enum zebra_dplane_result
1863 dplane_nexthop_update_internal(struct nhg_hash_entry
*nhe
, enum dplane_op_e op
)
1865 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1867 struct zebra_dplane_ctx
*ctx
= NULL
;
1869 /* Obtain context block */
1870 ctx
= dplane_ctx_alloc();
1876 ret
= dplane_ctx_nexthop_init(ctx
, op
, nhe
);
1878 ret
= dplane_update_enqueue(ctx
);
1881 /* Update counter */
1882 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthops_in
, 1,
1883 memory_order_relaxed
);
1886 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
1888 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthop_errors
, 1,
1889 memory_order_relaxed
);
1891 dplane_ctx_free(&ctx
);
1898 * Enqueue a route 'add' for the dataplane.
1900 enum zebra_dplane_result
dplane_route_add(struct route_node
*rn
,
1901 struct route_entry
*re
)
1903 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1905 if (rn
== NULL
|| re
== NULL
)
1908 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1909 DPLANE_OP_ROUTE_INSTALL
);
1916 * Enqueue a route update for the dataplane.
1918 enum zebra_dplane_result
dplane_route_update(struct route_node
*rn
,
1919 struct route_entry
*re
,
1920 struct route_entry
*old_re
)
1922 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1924 if (rn
== NULL
|| re
== NULL
)
1927 ret
= dplane_route_update_internal(rn
, re
, old_re
,
1928 DPLANE_OP_ROUTE_UPDATE
);
1934 * Enqueue a route removal for the dataplane.
1936 enum zebra_dplane_result
dplane_route_delete(struct route_node
*rn
,
1937 struct route_entry
*re
)
1939 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1941 if (rn
== NULL
|| re
== NULL
)
1944 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1945 DPLANE_OP_ROUTE_DELETE
);
1952 * Notify the dplane when system/connected routes change.
1954 enum zebra_dplane_result
dplane_sys_route_add(struct route_node
*rn
,
1955 struct route_entry
*re
)
1957 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1959 /* Ignore this event unless a provider plugin has requested it. */
1960 if (!zdplane_info
.dg_sys_route_notifs
) {
1961 ret
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1965 if (rn
== NULL
|| re
== NULL
)
1968 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1969 DPLANE_OP_SYS_ROUTE_ADD
);
1976 * Notify the dplane when system/connected routes are deleted.
1978 enum zebra_dplane_result
dplane_sys_route_del(struct route_node
*rn
,
1979 struct route_entry
*re
)
1981 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1983 /* Ignore this event unless a provider plugin has requested it. */
1984 if (!zdplane_info
.dg_sys_route_notifs
) {
1985 ret
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1989 if (rn
== NULL
|| re
== NULL
)
1992 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1993 DPLANE_OP_SYS_ROUTE_DELETE
);
2000 * Update from an async notification, to bring other fibs up-to-date.
2002 enum zebra_dplane_result
2003 dplane_route_notif_update(struct route_node
*rn
,
2004 struct route_entry
*re
,
2005 enum dplane_op_e op
,
2006 struct zebra_dplane_ctx
*ctx
)
2008 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2009 struct zebra_dplane_ctx
*new_ctx
= NULL
;
2010 struct nexthop
*nexthop
;
2012 if (rn
== NULL
|| re
== NULL
)
2015 new_ctx
= dplane_ctx_alloc();
2016 if (new_ctx
== NULL
)
2019 /* Init context with info from zebra data structs */
2020 dplane_ctx_route_init(new_ctx
, op
, rn
, re
);
2022 /* For add/update, need to adjust the nexthops so that we match
2023 * the notification state, which may not be the route-entry/RIB
2026 if (op
== DPLANE_OP_ROUTE_UPDATE
||
2027 op
== DPLANE_OP_ROUTE_INSTALL
) {
2029 nexthops_free(new_ctx
->u
.rinfo
.zd_ng
.nexthop
);
2030 new_ctx
->u
.rinfo
.zd_ng
.nexthop
= NULL
;
2032 copy_nexthops(&(new_ctx
->u
.rinfo
.zd_ng
.nexthop
),
2033 (rib_active_nhg(re
))->nexthop
, NULL
);
2035 for (ALL_NEXTHOPS(new_ctx
->u
.rinfo
.zd_ng
, nexthop
))
2036 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
2040 /* Capture info about the source of the notification, in 'ctx' */
2041 dplane_ctx_set_notif_provider(new_ctx
,
2042 dplane_ctx_get_notif_provider(ctx
));
2044 dplane_update_enqueue(new_ctx
);
2046 ret
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2053 * Enqueue a nexthop add for the dataplane.
2055 enum zebra_dplane_result
dplane_nexthop_add(struct nhg_hash_entry
*nhe
)
2057 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2060 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_INSTALL
);
2065 * Enqueue a nexthop update for the dataplane.
2067 enum zebra_dplane_result
dplane_nexthop_update(struct nhg_hash_entry
*nhe
)
2069 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2072 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_UPDATE
);
2077 * Enqueue a nexthop removal for the dataplane.
2079 enum zebra_dplane_result
dplane_nexthop_delete(struct nhg_hash_entry
*nhe
)
2081 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2084 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_DELETE
);
2090 * Enqueue LSP add for the dataplane.
2092 enum zebra_dplane_result
dplane_lsp_add(zebra_lsp_t
*lsp
)
2094 enum zebra_dplane_result ret
=
2095 lsp_update_internal(lsp
, DPLANE_OP_LSP_INSTALL
);
2101 * Enqueue LSP update for the dataplane.
2103 enum zebra_dplane_result
dplane_lsp_update(zebra_lsp_t
*lsp
)
2105 enum zebra_dplane_result ret
=
2106 lsp_update_internal(lsp
, DPLANE_OP_LSP_UPDATE
);
2112 * Enqueue LSP delete for the dataplane.
2114 enum zebra_dplane_result
dplane_lsp_delete(zebra_lsp_t
*lsp
)
2116 enum zebra_dplane_result ret
=
2117 lsp_update_internal(lsp
, DPLANE_OP_LSP_DELETE
);
2122 /* Update or un-install resulting from an async notification */
2123 enum zebra_dplane_result
2124 dplane_lsp_notif_update(zebra_lsp_t
*lsp
,
2125 enum dplane_op_e op
,
2126 struct zebra_dplane_ctx
*notif_ctx
)
2128 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2130 struct zebra_dplane_ctx
*ctx
= NULL
;
2132 /* Obtain context block */
2133 ctx
= dplane_ctx_alloc();
2139 ret
= dplane_ctx_lsp_init(ctx
, op
, lsp
);
2143 /* Capture info about the source of the notification */
2144 dplane_ctx_set_notif_provider(
2146 dplane_ctx_get_notif_provider(notif_ctx
));
2148 ret
= dplane_update_enqueue(ctx
);
2151 /* Update counter */
2152 atomic_fetch_add_explicit(&zdplane_info
.dg_lsps_in
, 1,
2153 memory_order_relaxed
);
2156 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2158 atomic_fetch_add_explicit(&zdplane_info
.dg_lsp_errors
, 1,
2159 memory_order_relaxed
);
2161 dplane_ctx_free(&ctx
);
2167 * Enqueue pseudowire install for the dataplane.
2169 enum zebra_dplane_result
dplane_pw_install(struct zebra_pw
*pw
)
2171 return pw_update_internal(pw
, DPLANE_OP_PW_INSTALL
);
2175 * Enqueue pseudowire un-install for the dataplane.
2177 enum zebra_dplane_result
dplane_pw_uninstall(struct zebra_pw
*pw
)
2179 return pw_update_internal(pw
, DPLANE_OP_PW_UNINSTALL
);
2183 * Common internal LSP update utility
2185 static enum zebra_dplane_result
lsp_update_internal(zebra_lsp_t
*lsp
,
2186 enum dplane_op_e op
)
2188 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2190 struct zebra_dplane_ctx
*ctx
= NULL
;
2192 /* Obtain context block */
2193 ctx
= dplane_ctx_alloc();
2195 ret
= dplane_ctx_lsp_init(ctx
, op
, lsp
);
2199 ret
= dplane_update_enqueue(ctx
);
2202 /* Update counter */
2203 atomic_fetch_add_explicit(&zdplane_info
.dg_lsps_in
, 1,
2204 memory_order_relaxed
);
2207 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2209 atomic_fetch_add_explicit(&zdplane_info
.dg_lsp_errors
, 1,
2210 memory_order_relaxed
);
2211 dplane_ctx_free(&ctx
);
2218 * Internal, common handler for pseudowire updates.
2220 static enum zebra_dplane_result
pw_update_internal(struct zebra_pw
*pw
,
2221 enum dplane_op_e op
)
2223 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2225 struct zebra_dplane_ctx
*ctx
= NULL
;
2227 ctx
= dplane_ctx_alloc();
2229 ret
= dplane_ctx_pw_init(ctx
, op
, pw
);
2233 ret
= dplane_update_enqueue(ctx
);
2236 /* Update counter */
2237 atomic_fetch_add_explicit(&zdplane_info
.dg_pws_in
, 1,
2238 memory_order_relaxed
);
2241 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2243 atomic_fetch_add_explicit(&zdplane_info
.dg_pw_errors
, 1,
2244 memory_order_relaxed
);
2245 dplane_ctx_free(&ctx
);
2252 * Enqueue interface address add for the dataplane.
2254 enum zebra_dplane_result
dplane_intf_addr_set(const struct interface
*ifp
,
2255 const struct connected
*ifc
)
2257 #if !defined(HAVE_NETLINK) && defined(HAVE_STRUCT_IFALIASREQ)
2258 /* Extra checks for this OS path. */
2260 /* Don't configure PtP addresses on broadcast ifs or reverse */
2261 if (!(ifp
->flags
& IFF_POINTOPOINT
) != !CONNECTED_PEER(ifc
)) {
2262 if (IS_ZEBRA_DEBUG_KERNEL
|| IS_ZEBRA_DEBUG_DPLANE
)
2263 zlog_debug("Failed to set intf addr: mismatch p2p and connected");
2265 return ZEBRA_DPLANE_REQUEST_FAILURE
;
2268 /* Ensure that no existing installed v4 route conflicts with
2269 * the new interface prefix. This check must be done in the
2270 * zebra pthread context, and any route delete (if needed)
2271 * is enqueued before the interface address programming attempt.
2273 if (ifc
->address
->family
== AF_INET
) {
2274 struct prefix_ipv4
*p
;
2276 p
= (struct prefix_ipv4
*)ifc
->address
;
2277 rib_lookup_and_pushup(p
, ifp
->vrf_id
);
2281 return intf_addr_update_internal(ifp
, ifc
, DPLANE_OP_ADDR_INSTALL
);
2285 * Enqueue interface address remove/uninstall for the dataplane.
2287 enum zebra_dplane_result
dplane_intf_addr_unset(const struct interface
*ifp
,
2288 const struct connected
*ifc
)
2290 return intf_addr_update_internal(ifp
, ifc
, DPLANE_OP_ADDR_UNINSTALL
);
2293 static enum zebra_dplane_result
intf_addr_update_internal(
2294 const struct interface
*ifp
, const struct connected
*ifc
,
2295 enum dplane_op_e op
)
2297 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2299 struct zebra_dplane_ctx
*ctx
= NULL
;
2300 struct zebra_ns
*zns
;
2302 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2303 char addr_str
[PREFIX_STRLEN
];
2305 prefix2str(ifc
->address
, addr_str
, sizeof(addr_str
));
2307 zlog_debug("init intf ctx %s: idx %d, addr %u:%s",
2308 dplane_op2str(op
), ifp
->ifindex
, ifp
->vrf_id
,
2312 ctx
= dplane_ctx_alloc();
2315 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2316 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2318 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2319 dplane_ctx_ns_init(ctx
, zns
, false);
2321 /* Init the interface-addr-specific area */
2322 memset(&ctx
->u
.intf
, 0, sizeof(ctx
->u
.intf
));
2324 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2325 ctx
->zd_ifindex
= ifp
->ifindex
;
2326 ctx
->u
.intf
.prefix
= *(ifc
->address
);
2328 if (if_is_broadcast(ifp
))
2329 ctx
->u
.intf
.flags
|= DPLANE_INTF_BROADCAST
;
2331 if (CONNECTED_PEER(ifc
)) {
2332 ctx
->u
.intf
.dest_prefix
= *(ifc
->destination
);
2333 ctx
->u
.intf
.flags
|=
2334 (DPLANE_INTF_CONNECTED
| DPLANE_INTF_HAS_DEST
);
2337 if (CHECK_FLAG(ifc
->flags
, ZEBRA_IFA_SECONDARY
))
2338 ctx
->u
.intf
.flags
|= DPLANE_INTF_SECONDARY
;
2343 ctx
->u
.intf
.flags
|= DPLANE_INTF_HAS_LABEL
;
2345 /* Use embedded buffer if it's adequate; else allocate. */
2346 len
= strlen(ifc
->label
);
2348 if (len
< sizeof(ctx
->u
.intf
.label_buf
)) {
2349 strlcpy(ctx
->u
.intf
.label_buf
, ifc
->label
,
2350 sizeof(ctx
->u
.intf
.label_buf
));
2351 ctx
->u
.intf
.label
= ctx
->u
.intf
.label_buf
;
2353 ctx
->u
.intf
.label
= strdup(ifc
->label
);
2357 ret
= dplane_update_enqueue(ctx
);
2359 /* Increment counter */
2360 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addrs_in
, 1,
2361 memory_order_relaxed
);
2364 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2367 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addr_errors
,
2368 1, memory_order_relaxed
);
2369 dplane_ctx_free(&ctx
);
2376 * Enqueue vxlan/evpn mac add (or update).
2378 enum zebra_dplane_result
dplane_mac_add(const struct interface
*ifp
,
2379 const struct interface
*bridge_ifp
,
2381 const struct ethaddr
*mac
,
2382 struct in_addr vtep_ip
,
2385 enum zebra_dplane_result result
;
2387 /* Use common helper api */
2388 result
= mac_update_internal(DPLANE_OP_MAC_INSTALL
, ifp
, bridge_ifp
,
2389 vid
, mac
, vtep_ip
, sticky
);
2394 * Enqueue vxlan/evpn mac delete.
2396 enum zebra_dplane_result
dplane_mac_del(const struct interface
*ifp
,
2397 const struct interface
*bridge_ifp
,
2399 const struct ethaddr
*mac
,
2400 struct in_addr vtep_ip
)
2402 enum zebra_dplane_result result
;
2404 /* Use common helper api */
2405 result
= mac_update_internal(DPLANE_OP_MAC_DELETE
, ifp
, bridge_ifp
,
2406 vid
, mac
, vtep_ip
, false);
2411 * Common helper api for MAC address/vxlan updates
2413 static enum zebra_dplane_result
2414 mac_update_internal(enum dplane_op_e op
,
2415 const struct interface
*ifp
,
2416 const struct interface
*br_ifp
,
2418 const struct ethaddr
*mac
,
2419 struct in_addr vtep_ip
,
2422 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2424 struct zebra_dplane_ctx
*ctx
= NULL
;
2425 struct zebra_ns
*zns
;
2427 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2428 char buf1
[ETHER_ADDR_STRLEN
], buf2
[PREFIX_STRLEN
];
2430 zlog_debug("init mac ctx %s: mac %s, ifp %s, vtep %s",
2432 prefix_mac2str(mac
, buf1
, sizeof(buf1
)),
2434 inet_ntop(AF_INET
, &vtep_ip
, buf2
, sizeof(buf2
)));
2437 ctx
= dplane_ctx_alloc();
2440 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2441 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2443 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2444 dplane_ctx_ns_init(ctx
, zns
, false);
2446 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2447 ctx
->zd_ifindex
= ifp
->ifindex
;
2449 /* Init the mac-specific data area */
2450 memset(&ctx
->u
.macinfo
, 0, sizeof(ctx
->u
.macinfo
));
2452 ctx
->u
.macinfo
.br_ifindex
= br_ifp
->ifindex
;
2453 ctx
->u
.macinfo
.vtep_ip
= vtep_ip
;
2454 ctx
->u
.macinfo
.mac
= *mac
;
2455 ctx
->u
.macinfo
.vid
= vid
;
2456 ctx
->u
.macinfo
.is_sticky
= sticky
;
2458 /* Enqueue for processing on the dplane pthread */
2459 ret
= dplane_update_enqueue(ctx
);
2461 /* Increment counter */
2462 atomic_fetch_add_explicit(&zdplane_info
.dg_macs_in
, 1,
2463 memory_order_relaxed
);
2466 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2469 atomic_fetch_add_explicit(&zdplane_info
.dg_mac_errors
, 1,
2470 memory_order_relaxed
);
2471 dplane_ctx_free(&ctx
);
2478 * Enqueue evpn neighbor add for the dataplane.
2480 enum zebra_dplane_result
dplane_neigh_add(const struct interface
*ifp
,
2481 const struct ipaddr
*ip
,
2482 const struct ethaddr
*mac
,
2485 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2487 result
= neigh_update_internal(DPLANE_OP_NEIGH_INSTALL
,
2488 ifp
, mac
, ip
, flags
, 0);
2494 * Enqueue evpn neighbor update for the dataplane.
2496 enum zebra_dplane_result
dplane_neigh_update(const struct interface
*ifp
,
2497 const struct ipaddr
*ip
,
2498 const struct ethaddr
*mac
)
2500 enum zebra_dplane_result result
;
2502 result
= neigh_update_internal(DPLANE_OP_NEIGH_UPDATE
,
2503 ifp
, mac
, ip
, 0, DPLANE_NUD_PROBE
);
2509 * Enqueue evpn neighbor delete for the dataplane.
2511 enum zebra_dplane_result
dplane_neigh_delete(const struct interface
*ifp
,
2512 const struct ipaddr
*ip
)
2514 enum zebra_dplane_result result
;
2516 result
= neigh_update_internal(DPLANE_OP_NEIGH_DELETE
,
2517 ifp
, NULL
, ip
, 0, 0);
2523 * Enqueue evpn VTEP add for the dataplane.
2525 enum zebra_dplane_result
dplane_vtep_add(const struct interface
*ifp
,
2526 const struct in_addr
*ip
,
2529 enum zebra_dplane_result result
;
2530 struct ethaddr mac
= { {0, 0, 0, 0, 0, 0} };
2533 if (IS_ZEBRA_DEBUG_VXLAN
)
2534 zlog_debug("Install %s into flood list for VNI %u intf %s(%u)",
2535 inet_ntoa(*ip
), vni
, ifp
->name
, ifp
->ifindex
);
2537 SET_IPADDR_V4(&addr
);
2538 addr
.ipaddr_v4
= *ip
;
2540 result
= neigh_update_internal(DPLANE_OP_VTEP_ADD
,
2541 ifp
, &mac
, &addr
, 0, 0);
2547 * Enqueue evpn VTEP add for the dataplane.
2549 enum zebra_dplane_result
dplane_vtep_delete(const struct interface
*ifp
,
2550 const struct in_addr
*ip
,
2553 enum zebra_dplane_result result
;
2554 struct ethaddr mac
= { {0, 0, 0, 0, 0, 0} };
2557 if (IS_ZEBRA_DEBUG_VXLAN
)
2559 "Uninstall %s from flood list for VNI %u intf %s(%u)",
2560 inet_ntoa(*ip
), vni
, ifp
->name
, ifp
->ifindex
);
2562 SET_IPADDR_V4(&addr
);
2563 addr
.ipaddr_v4
= *ip
;
2565 result
= neigh_update_internal(DPLANE_OP_VTEP_DELETE
,
2566 ifp
, &mac
, &addr
, 0, 0);
2572 * Common helper api for evpn neighbor updates
2574 static enum zebra_dplane_result
2575 neigh_update_internal(enum dplane_op_e op
,
2576 const struct interface
*ifp
,
2577 const struct ethaddr
*mac
,
2578 const struct ipaddr
*ip
,
2579 uint32_t flags
, uint16_t state
)
2581 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2583 struct zebra_dplane_ctx
*ctx
= NULL
;
2584 struct zebra_ns
*zns
;
2586 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2587 char buf1
[ETHER_ADDR_STRLEN
], buf2
[PREFIX_STRLEN
];
2589 zlog_debug("init neigh ctx %s: ifp %s, mac %s, ip %s",
2591 prefix_mac2str(mac
, buf1
, sizeof(buf1
)),
2593 ipaddr2str(ip
, buf2
, sizeof(buf2
)));
2596 ctx
= dplane_ctx_alloc();
2599 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2600 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2602 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2603 dplane_ctx_ns_init(ctx
, zns
, false);
2605 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2606 ctx
->zd_ifindex
= ifp
->ifindex
;
2608 /* Init the neighbor-specific data area */
2609 memset(&ctx
->u
.neigh
, 0, sizeof(ctx
->u
.neigh
));
2611 ctx
->u
.neigh
.ip_addr
= *ip
;
2613 ctx
->u
.neigh
.mac
= *mac
;
2614 ctx
->u
.neigh
.flags
= flags
;
2615 ctx
->u
.neigh
.state
= state
;
2617 /* Enqueue for processing on the dplane pthread */
2618 ret
= dplane_update_enqueue(ctx
);
2620 /* Increment counter */
2621 atomic_fetch_add_explicit(&zdplane_info
.dg_neighs_in
, 1,
2622 memory_order_relaxed
);
2625 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2628 atomic_fetch_add_explicit(&zdplane_info
.dg_neigh_errors
, 1,
2629 memory_order_relaxed
);
2630 dplane_ctx_free(&ctx
);
2637 * Handler for 'show dplane'
2639 int dplane_show_helper(struct vty
*vty
, bool detailed
)
2641 uint64_t queued
, queue_max
, limit
, errs
, incoming
, yields
,
2644 /* Using atomics because counters are being changed in different
2647 incoming
= atomic_load_explicit(&zdplane_info
.dg_routes_in
,
2648 memory_order_relaxed
);
2649 limit
= atomic_load_explicit(&zdplane_info
.dg_max_queued_updates
,
2650 memory_order_relaxed
);
2651 queued
= atomic_load_explicit(&zdplane_info
.dg_routes_queued
,
2652 memory_order_relaxed
);
2653 queue_max
= atomic_load_explicit(&zdplane_info
.dg_routes_queued_max
,
2654 memory_order_relaxed
);
2655 errs
= atomic_load_explicit(&zdplane_info
.dg_route_errors
,
2656 memory_order_relaxed
);
2657 yields
= atomic_load_explicit(&zdplane_info
.dg_update_yields
,
2658 memory_order_relaxed
);
2659 other_errs
= atomic_load_explicit(&zdplane_info
.dg_other_errors
,
2660 memory_order_relaxed
);
2662 vty_out(vty
, "Zebra dataplane:\nRoute updates: %"PRIu64
"\n",
2664 vty_out(vty
, "Route update errors: %"PRIu64
"\n", errs
);
2665 vty_out(vty
, "Other errors : %"PRIu64
"\n", other_errs
);
2666 vty_out(vty
, "Route update queue limit: %"PRIu64
"\n", limit
);
2667 vty_out(vty
, "Route update queue depth: %"PRIu64
"\n", queued
);
2668 vty_out(vty
, "Route update queue max: %"PRIu64
"\n", queue_max
);
2669 vty_out(vty
, "Dplane update yields: %"PRIu64
"\n", yields
);
2671 incoming
= atomic_load_explicit(&zdplane_info
.dg_lsps_in
,
2672 memory_order_relaxed
);
2673 errs
= atomic_load_explicit(&zdplane_info
.dg_lsp_errors
,
2674 memory_order_relaxed
);
2675 vty_out(vty
, "LSP updates: %"PRIu64
"\n", incoming
);
2676 vty_out(vty
, "LSP update errors: %"PRIu64
"\n", errs
);
2678 incoming
= atomic_load_explicit(&zdplane_info
.dg_pws_in
,
2679 memory_order_relaxed
);
2680 errs
= atomic_load_explicit(&zdplane_info
.dg_pw_errors
,
2681 memory_order_relaxed
);
2682 vty_out(vty
, "PW updates: %"PRIu64
"\n", incoming
);
2683 vty_out(vty
, "PW update errors: %"PRIu64
"\n", errs
);
2685 incoming
= atomic_load_explicit(&zdplane_info
.dg_intf_addrs_in
,
2686 memory_order_relaxed
);
2687 errs
= atomic_load_explicit(&zdplane_info
.dg_intf_addr_errors
,
2688 memory_order_relaxed
);
2689 vty_out(vty
, "Intf addr updates: %"PRIu64
"\n", incoming
);
2690 vty_out(vty
, "Intf addr errors: %"PRIu64
"\n", errs
);
2692 incoming
= atomic_load_explicit(&zdplane_info
.dg_macs_in
,
2693 memory_order_relaxed
);
2694 errs
= atomic_load_explicit(&zdplane_info
.dg_mac_errors
,
2695 memory_order_relaxed
);
2696 vty_out(vty
, "EVPN MAC updates: %"PRIu64
"\n", incoming
);
2697 vty_out(vty
, "EVPN MAC errors: %"PRIu64
"\n", errs
);
2699 incoming
= atomic_load_explicit(&zdplane_info
.dg_neighs_in
,
2700 memory_order_relaxed
);
2701 errs
= atomic_load_explicit(&zdplane_info
.dg_neigh_errors
,
2702 memory_order_relaxed
);
2703 vty_out(vty
, "EVPN neigh updates: %"PRIu64
"\n", incoming
);
2704 vty_out(vty
, "EVPN neigh errors: %"PRIu64
"\n", errs
);
2710 * Handler for 'show dplane providers'
2712 int dplane_show_provs_helper(struct vty
*vty
, bool detailed
)
2714 struct zebra_dplane_provider
*prov
;
2715 uint64_t in
, in_max
, out
, out_max
;
2717 vty_out(vty
, "Zebra dataplane providers:\n");
2720 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
2723 /* Show counters, useful info from each registered provider */
2726 in
= atomic_load_explicit(&prov
->dp_in_counter
,
2727 memory_order_relaxed
);
2728 in_max
= atomic_load_explicit(&prov
->dp_in_max
,
2729 memory_order_relaxed
);
2730 out
= atomic_load_explicit(&prov
->dp_out_counter
,
2731 memory_order_relaxed
);
2732 out_max
= atomic_load_explicit(&prov
->dp_out_max
,
2733 memory_order_relaxed
);
2735 vty_out(vty
, "%s (%u): in: %"PRIu64
", q_max: %"PRIu64
", "
2736 "out: %"PRIu64
", q_max: %"PRIu64
"\n",
2737 prov
->dp_name
, prov
->dp_id
, in
, in_max
, out
, out_max
);
2740 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
2748 * Helper for 'show run' etc.
2750 int dplane_config_write_helper(struct vty
*vty
)
2752 if (zdplane_info
.dg_max_queued_updates
!= DPLANE_DEFAULT_MAX_QUEUED
)
2753 vty_out(vty
, "zebra dplane limit %u\n",
2754 zdplane_info
.dg_max_queued_updates
);
2760 * Provider registration
2762 int dplane_provider_register(const char *name
,
2763 enum dplane_provider_prio prio
,
2765 int (*start_fp
)(struct zebra_dplane_provider
*),
2766 int (*fp
)(struct zebra_dplane_provider
*),
2767 int (*fini_fp
)(struct zebra_dplane_provider
*,
2770 struct zebra_dplane_provider
**prov_p
)
2773 struct zebra_dplane_provider
*p
= NULL
, *last
;
2781 if (prio
<= DPLANE_PRIO_NONE
||
2782 prio
> DPLANE_PRIO_LAST
) {
2787 /* Allocate and init new provider struct */
2788 p
= XCALLOC(MTYPE_DP_PROV
, sizeof(struct zebra_dplane_provider
));
2790 pthread_mutex_init(&(p
->dp_mutex
), NULL
);
2791 TAILQ_INIT(&(p
->dp_ctx_in_q
));
2792 TAILQ_INIT(&(p
->dp_ctx_out_q
));
2794 p
->dp_priority
= prio
;
2796 p
->dp_start
= start_fp
;
2797 p
->dp_fini
= fini_fp
;
2800 /* Lock - the dplane pthread may be running */
2803 p
->dp_id
= ++zdplane_info
.dg_provider_id
;
2806 strlcpy(p
->dp_name
, name
, DPLANE_PROVIDER_NAMELEN
);
2808 snprintf(p
->dp_name
, DPLANE_PROVIDER_NAMELEN
,
2809 "provider-%u", p
->dp_id
);
2811 /* Insert into list ordered by priority */
2812 TAILQ_FOREACH(last
, &zdplane_info
.dg_providers_q
, dp_prov_link
) {
2813 if (last
->dp_priority
> p
->dp_priority
)
2818 TAILQ_INSERT_BEFORE(last
, p
, dp_prov_link
);
2820 TAILQ_INSERT_TAIL(&zdplane_info
.dg_providers_q
, p
,
2826 if (IS_ZEBRA_DEBUG_DPLANE
)
2827 zlog_debug("dplane: registered new provider '%s' (%u), prio %d",
2828 p
->dp_name
, p
->dp_id
, p
->dp_priority
);
2837 /* Accessors for provider attributes */
2838 const char *dplane_provider_get_name(const struct zebra_dplane_provider
*prov
)
2840 return prov
->dp_name
;
2843 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider
*prov
)
2848 void *dplane_provider_get_data(const struct zebra_dplane_provider
*prov
)
2850 return prov
->dp_data
;
2853 int dplane_provider_get_work_limit(const struct zebra_dplane_provider
*prov
)
2855 return zdplane_info
.dg_updates_per_cycle
;
2858 /* Lock/unlock a provider's mutex - iff the provider was registered with
2859 * the THREADED flag.
2861 void dplane_provider_lock(struct zebra_dplane_provider
*prov
)
2863 if (dplane_provider_is_threaded(prov
))
2864 DPLANE_PROV_LOCK(prov
);
2867 void dplane_provider_unlock(struct zebra_dplane_provider
*prov
)
2869 if (dplane_provider_is_threaded(prov
))
2870 DPLANE_PROV_UNLOCK(prov
);
2874 * Dequeue and maintain associated counter
2876 struct zebra_dplane_ctx
*dplane_provider_dequeue_in_ctx(
2877 struct zebra_dplane_provider
*prov
)
2879 struct zebra_dplane_ctx
*ctx
= NULL
;
2881 dplane_provider_lock(prov
);
2883 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
2885 TAILQ_REMOVE(&(prov
->dp_ctx_in_q
), ctx
, zd_q_entries
);
2887 atomic_fetch_sub_explicit(&prov
->dp_in_queued
, 1,
2888 memory_order_relaxed
);
2891 dplane_provider_unlock(prov
);
2897 * Dequeue work to a list, return count
2899 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider
*prov
,
2900 struct dplane_ctx_q
*listp
)
2903 struct zebra_dplane_ctx
*ctx
;
2905 limit
= zdplane_info
.dg_updates_per_cycle
;
2907 dplane_provider_lock(prov
);
2909 for (ret
= 0; ret
< limit
; ret
++) {
2910 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
2912 TAILQ_REMOVE(&(prov
->dp_ctx_in_q
), ctx
, zd_q_entries
);
2914 TAILQ_INSERT_TAIL(listp
, ctx
, zd_q_entries
);
2921 atomic_fetch_sub_explicit(&prov
->dp_in_queued
, ret
,
2922 memory_order_relaxed
);
2924 dplane_provider_unlock(prov
);
2930 * Enqueue and maintain associated counter
2932 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider
*prov
,
2933 struct zebra_dplane_ctx
*ctx
)
2935 dplane_provider_lock(prov
);
2937 TAILQ_INSERT_TAIL(&(prov
->dp_ctx_out_q
), ctx
,
2940 dplane_provider_unlock(prov
);
2942 atomic_fetch_add_explicit(&(prov
->dp_out_counter
), 1,
2943 memory_order_relaxed
);
2947 * Accessor for provider object
2949 bool dplane_provider_is_threaded(const struct zebra_dplane_provider
*prov
)
2951 return (prov
->dp_flags
& DPLANE_PROV_FLAG_THREADED
);
2955 * Internal helper that copies information from a zebra ns object; this is
2956 * called in the zebra main pthread context as part of dplane ctx init.
2958 static void dplane_info_from_zns(struct zebra_dplane_info
*ns_info
,
2959 struct zebra_ns
*zns
)
2961 ns_info
->ns_id
= zns
->ns_id
;
2963 #if defined(HAVE_NETLINK)
2964 ns_info
->is_cmd
= true;
2965 ns_info
->nls
= zns
->netlink_dplane
;
2966 #endif /* NETLINK */
2970 * Provider api to signal that work/events are available
2971 * for the dataplane pthread.
2973 int dplane_provider_work_ready(void)
2975 /* Note that during zebra startup, we may be offered work before
2976 * the dataplane pthread (and thread-master) are ready. We want to
2977 * enqueue the work, but the event-scheduling machinery may not be
2980 if (zdplane_info
.dg_run
) {
2981 thread_add_event(zdplane_info
.dg_master
,
2982 dplane_thread_loop
, NULL
, 0,
2983 &zdplane_info
.dg_t_update
);
2990 * Enqueue a context directly to zebra main.
2992 void dplane_provider_enqueue_to_zebra(struct zebra_dplane_ctx
*ctx
)
2994 struct dplane_ctx_q temp_list
;
2996 /* Zebra's api takes a list, so we need to use a temporary list */
2997 TAILQ_INIT(&temp_list
);
2999 TAILQ_INSERT_TAIL(&temp_list
, ctx
, zd_q_entries
);
3000 (zdplane_info
.dg_results_cb
)(&temp_list
);
3004 * Kernel dataplane provider
3008 * Handler for kernel LSP updates
3010 static enum zebra_dplane_result
3011 kernel_dplane_lsp_update(struct zebra_dplane_ctx
*ctx
)
3013 enum zebra_dplane_result res
;
3015 /* Call into the synchronous kernel-facing code here */
3016 res
= kernel_lsp_update(ctx
);
3018 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3019 atomic_fetch_add_explicit(
3020 &zdplane_info
.dg_lsp_errors
, 1,
3021 memory_order_relaxed
);
3027 * Handler for kernel pseudowire updates
3029 static enum zebra_dplane_result
3030 kernel_dplane_pw_update(struct zebra_dplane_ctx
*ctx
)
3032 enum zebra_dplane_result res
;
3034 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3035 zlog_debug("Dplane pw %s: op %s af %d loc: %u rem: %u",
3036 dplane_ctx_get_ifname(ctx
),
3037 dplane_op2str(ctx
->zd_op
),
3038 dplane_ctx_get_pw_af(ctx
),
3039 dplane_ctx_get_pw_local_label(ctx
),
3040 dplane_ctx_get_pw_remote_label(ctx
));
3042 res
= kernel_pw_update(ctx
);
3044 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3045 atomic_fetch_add_explicit(
3046 &zdplane_info
.dg_pw_errors
, 1,
3047 memory_order_relaxed
);
3053 * Handler for kernel route updates
3055 static enum zebra_dplane_result
3056 kernel_dplane_route_update(struct zebra_dplane_ctx
*ctx
)
3058 enum zebra_dplane_result res
;
3060 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3061 char dest_str
[PREFIX_STRLEN
];
3063 prefix2str(dplane_ctx_get_dest(ctx
),
3064 dest_str
, sizeof(dest_str
));
3066 zlog_debug("%u:%s Dplane route update ctx %p op %s",
3067 dplane_ctx_get_vrf(ctx
), dest_str
,
3068 ctx
, dplane_op2str(dplane_ctx_get_op(ctx
)));
3071 /* Call into the synchronous kernel-facing code here */
3072 res
= kernel_route_update(ctx
);
3074 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3075 atomic_fetch_add_explicit(
3076 &zdplane_info
.dg_route_errors
, 1,
3077 memory_order_relaxed
);
3083 * Handler for kernel-facing interface address updates
3085 static enum zebra_dplane_result
3086 kernel_dplane_address_update(struct zebra_dplane_ctx
*ctx
)
3088 enum zebra_dplane_result res
;
3090 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3091 char dest_str
[PREFIX_STRLEN
];
3093 prefix2str(dplane_ctx_get_intf_addr(ctx
), dest_str
,
3096 zlog_debug("Dplane intf %s, idx %u, addr %s",
3097 dplane_op2str(dplane_ctx_get_op(ctx
)),
3098 dplane_ctx_get_ifindex(ctx
), dest_str
);
3101 res
= kernel_address_update_ctx(ctx
);
3103 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3104 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addr_errors
,
3105 1, memory_order_relaxed
);
3111 * kernel_dplane_nexthop_update() - Handler for kernel nexthop updates
3113 * @ctx: Dataplane context
3115 * Return: Dataplane result flag
3117 static enum zebra_dplane_result
3118 kernel_dplane_nexthop_update(struct zebra_dplane_ctx
*ctx
)
3120 enum zebra_dplane_result res
;
3122 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3123 zlog_debug("ID (%u) Dplane nexthop update ctx %p op %s",
3124 dplane_ctx_get_nhe_id(ctx
), ctx
,
3125 dplane_op2str(dplane_ctx_get_op(ctx
)));
3128 res
= kernel_nexthop_update(ctx
);
3130 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3131 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthop_errors
, 1,
3132 memory_order_relaxed
);
3138 * Handler for kernel-facing EVPN MAC address updates
3140 static enum zebra_dplane_result
3141 kernel_dplane_mac_update(struct zebra_dplane_ctx
*ctx
)
3143 enum zebra_dplane_result res
;
3145 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3146 char buf
[ETHER_ADDR_STRLEN
];
3148 prefix_mac2str(dplane_ctx_mac_get_addr(ctx
), buf
,
3151 zlog_debug("Dplane %s, mac %s, ifindex %u",
3152 dplane_op2str(dplane_ctx_get_op(ctx
)),
3153 buf
, dplane_ctx_get_ifindex(ctx
));
3156 res
= kernel_mac_update_ctx(ctx
);
3158 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3159 atomic_fetch_add_explicit(&zdplane_info
.dg_mac_errors
,
3160 1, memory_order_relaxed
);
3166 * Handler for kernel-facing EVPN neighbor updates
3168 static enum zebra_dplane_result
3169 kernel_dplane_neigh_update(struct zebra_dplane_ctx
*ctx
)
3171 enum zebra_dplane_result res
;
3173 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3174 char buf
[PREFIX_STRLEN
];
3176 ipaddr2str(dplane_ctx_neigh_get_ipaddr(ctx
), buf
,
3179 zlog_debug("Dplane %s, ip %s, ifindex %u",
3180 dplane_op2str(dplane_ctx_get_op(ctx
)),
3181 buf
, dplane_ctx_get_ifindex(ctx
));
3184 res
= kernel_neigh_update_ctx(ctx
);
3186 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3187 atomic_fetch_add_explicit(&zdplane_info
.dg_neigh_errors
,
3188 1, memory_order_relaxed
);
3194 * Kernel provider callback
3196 static int kernel_dplane_process_func(struct zebra_dplane_provider
*prov
)
3198 enum zebra_dplane_result res
;
3199 struct zebra_dplane_ctx
*ctx
;
3202 limit
= dplane_provider_get_work_limit(prov
);
3204 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3205 zlog_debug("dplane provider '%s': processing",
3206 dplane_provider_get_name(prov
));
3208 for (counter
= 0; counter
< limit
; counter
++) {
3210 ctx
= dplane_provider_dequeue_in_ctx(prov
);
3214 /* A previous provider plugin may have asked to skip the
3217 if (dplane_ctx_is_skip_kernel(ctx
)) {
3218 res
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
3222 /* Dispatch to appropriate kernel-facing apis */
3223 switch (dplane_ctx_get_op(ctx
)) {
3225 case DPLANE_OP_ROUTE_INSTALL
:
3226 case DPLANE_OP_ROUTE_UPDATE
:
3227 case DPLANE_OP_ROUTE_DELETE
:
3228 res
= kernel_dplane_route_update(ctx
);
3231 case DPLANE_OP_NH_INSTALL
:
3232 case DPLANE_OP_NH_UPDATE
:
3233 case DPLANE_OP_NH_DELETE
:
3234 res
= kernel_dplane_nexthop_update(ctx
);
3237 case DPLANE_OP_LSP_INSTALL
:
3238 case DPLANE_OP_LSP_UPDATE
:
3239 case DPLANE_OP_LSP_DELETE
:
3240 res
= kernel_dplane_lsp_update(ctx
);
3243 case DPLANE_OP_PW_INSTALL
:
3244 case DPLANE_OP_PW_UNINSTALL
:
3245 res
= kernel_dplane_pw_update(ctx
);
3248 case DPLANE_OP_ADDR_INSTALL
:
3249 case DPLANE_OP_ADDR_UNINSTALL
:
3250 res
= kernel_dplane_address_update(ctx
);
3253 case DPLANE_OP_MAC_INSTALL
:
3254 case DPLANE_OP_MAC_DELETE
:
3255 res
= kernel_dplane_mac_update(ctx
);
3258 case DPLANE_OP_NEIGH_INSTALL
:
3259 case DPLANE_OP_NEIGH_UPDATE
:
3260 case DPLANE_OP_NEIGH_DELETE
:
3261 case DPLANE_OP_VTEP_ADD
:
3262 case DPLANE_OP_VTEP_DELETE
:
3263 res
= kernel_dplane_neigh_update(ctx
);
3266 /* Ignore 'notifications' - no-op */
3267 case DPLANE_OP_SYS_ROUTE_ADD
:
3268 case DPLANE_OP_SYS_ROUTE_DELETE
:
3269 case DPLANE_OP_ROUTE_NOTIFY
:
3270 case DPLANE_OP_LSP_NOTIFY
:
3271 res
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
3275 atomic_fetch_add_explicit(
3276 &zdplane_info
.dg_other_errors
, 1,
3277 memory_order_relaxed
);
3279 res
= ZEBRA_DPLANE_REQUEST_FAILURE
;
3284 dplane_ctx_set_status(ctx
, res
);
3286 dplane_provider_enqueue_out_ctx(prov
, ctx
);
3289 /* Ensure that we'll run the work loop again if there's still
3292 if (counter
>= limit
) {
3293 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3294 zlog_debug("dplane provider '%s' reached max updates %d",
3295 dplane_provider_get_name(prov
), counter
);
3297 atomic_fetch_add_explicit(&zdplane_info
.dg_update_yields
,
3298 1, memory_order_relaxed
);
3300 dplane_provider_work_ready();
3306 #if DPLANE_TEST_PROVIDER
3309 * Test dataplane provider plugin
3313 * Test provider process callback
3315 static int test_dplane_process_func(struct zebra_dplane_provider
*prov
)
3317 struct zebra_dplane_ctx
*ctx
;
3320 /* Just moving from 'in' queue to 'out' queue */
3322 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3323 zlog_debug("dplane provider '%s': processing",
3324 dplane_provider_get_name(prov
));
3326 limit
= dplane_provider_get_work_limit(prov
);
3328 for (counter
= 0; counter
< limit
; counter
++) {
3330 ctx
= dplane_provider_dequeue_in_ctx(prov
);
3334 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3335 zlog_debug("dplane provider '%s': op %s",
3336 dplane_provider_get_name(prov
),
3337 dplane_op2str(dplane_ctx_get_op(ctx
)));
3339 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_SUCCESS
);
3341 dplane_provider_enqueue_out_ctx(prov
, ctx
);
3344 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3345 zlog_debug("dplane provider '%s': processed %d",
3346 dplane_provider_get_name(prov
), counter
);
3348 /* Ensure that we'll run the work loop again if there's still
3351 if (counter
>= limit
)
3352 dplane_provider_work_ready();
3358 * Test provider shutdown/fini callback
3360 static int test_dplane_shutdown_func(struct zebra_dplane_provider
*prov
,
3363 if (IS_ZEBRA_DEBUG_DPLANE
)
3364 zlog_debug("dplane provider '%s': %sshutdown",
3365 dplane_provider_get_name(prov
),
3366 early
? "early " : "");
3370 #endif /* DPLANE_TEST_PROVIDER */
3373 * Register default kernel provider
3375 static void dplane_provider_init(void)
3379 ret
= dplane_provider_register("Kernel",
3381 DPLANE_PROV_FLAGS_DEFAULT
, NULL
,
3382 kernel_dplane_process_func
,
3387 zlog_err("Unable to register kernel dplane provider: %d",
3390 #if DPLANE_TEST_PROVIDER
3391 /* Optional test provider ... */
3392 ret
= dplane_provider_register("Test",
3393 DPLANE_PRIO_PRE_KERNEL
,
3394 DPLANE_PROV_FLAGS_DEFAULT
, NULL
,
3395 test_dplane_process_func
,
3396 test_dplane_shutdown_func
,
3397 NULL
/* data */, NULL
);
3400 zlog_err("Unable to register test dplane provider: %d",
3402 #endif /* DPLANE_TEST_PROVIDER */
3405 /* Indicates zebra shutdown/exit is in progress. Some operations may be
3406 * simplified or skipped during shutdown processing.
3408 bool dplane_is_in_shutdown(void)
3410 return zdplane_info
.dg_is_shutdown
;
3414 * Early or pre-shutdown, de-init notification api. This runs pretty
3415 * early during zebra shutdown, as a signal to stop new work and prepare
3416 * for updates generated by shutdown/cleanup activity, as zebra tries to
3417 * remove everything it's responsible for.
3418 * NB: This runs in the main zebra pthread context.
3420 void zebra_dplane_pre_finish(void)
3422 if (IS_ZEBRA_DEBUG_DPLANE
)
3423 zlog_debug("Zebra dataplane pre-fini called");
3425 zdplane_info
.dg_is_shutdown
= true;
3427 /* TODO -- Notify provider(s) of pending shutdown */
3431 * Utility to determine whether work remains enqueued within the dplane;
3432 * used during system shutdown processing.
3434 static bool dplane_work_pending(void)
3437 struct zebra_dplane_ctx
*ctx
;
3438 struct zebra_dplane_provider
*prov
;
3440 /* TODO -- just checking incoming/pending work for now, must check
3445 ctx
= TAILQ_FIRST(&zdplane_info
.dg_update_ctx_q
);
3446 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3457 dplane_provider_lock(prov
);
3459 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
3461 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_out_q
));
3463 dplane_provider_unlock(prov
);
3469 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3481 * Shutdown-time intermediate callback, used to determine when all pending
3482 * in-flight updates are done. If there's still work to do, reschedules itself.
3483 * If all work is done, schedules an event to the main zebra thread for
3484 * final zebra shutdown.
3485 * This runs in the dplane pthread context.
3487 static int dplane_check_shutdown_status(struct thread
*event
)
3489 if (IS_ZEBRA_DEBUG_DPLANE
)
3490 zlog_debug("Zebra dataplane shutdown status check called");
3492 if (dplane_work_pending()) {
3493 /* Reschedule dplane check on a short timer */
3494 thread_add_timer_msec(zdplane_info
.dg_master
,
3495 dplane_check_shutdown_status
,
3497 &zdplane_info
.dg_t_shutdown_check
);
3499 /* TODO - give up and stop waiting after a short time? */
3502 /* We appear to be done - schedule a final callback event
3503 * for the zebra main pthread.
3505 thread_add_event(zrouter
.master
, zebra_finalize
, NULL
, 0, NULL
);
3512 * Shutdown, de-init api. This runs pretty late during shutdown,
3513 * after zebra has tried to free/remove/uninstall all routes during shutdown.
3514 * At this point, dplane work may still remain to be done, so we can't just
3515 * blindly terminate. If there's still work to do, we'll periodically check
3516 * and when done, we'll enqueue a task to the zebra main thread for final
3517 * termination processing.
3519 * NB: This runs in the main zebra thread context.
3521 void zebra_dplane_finish(void)
3523 if (IS_ZEBRA_DEBUG_DPLANE
)
3524 zlog_debug("Zebra dataplane fini called");
3526 thread_add_event(zdplane_info
.dg_master
,
3527 dplane_check_shutdown_status
, NULL
, 0,
3528 &zdplane_info
.dg_t_shutdown_check
);
3532 * Main dataplane pthread event loop. The thread takes new incoming work
3533 * and offers it to the first provider. It then iterates through the
3534 * providers, taking complete work from each one and offering it
3535 * to the next in order. At each step, a limited number of updates are
3536 * processed during a cycle in order to provide some fairness.
3538 * This loop through the providers is only run once, so that the dataplane
3539 * pthread can look for other pending work - such as i/o work on behalf of
3542 static int dplane_thread_loop(struct thread
*event
)
3544 struct dplane_ctx_q work_list
;
3545 struct dplane_ctx_q error_list
;
3546 struct zebra_dplane_provider
*prov
;
3547 struct zebra_dplane_ctx
*ctx
, *tctx
;
3548 int limit
, counter
, error_counter
;
3549 uint64_t curr
, high
;
3551 /* Capture work limit per cycle */
3552 limit
= zdplane_info
.dg_updates_per_cycle
;
3554 /* Init temporary lists used to move contexts among providers */
3555 TAILQ_INIT(&work_list
);
3556 TAILQ_INIT(&error_list
);
3559 /* Check for zebra shutdown */
3560 if (!zdplane_info
.dg_run
)
3563 /* Dequeue some incoming work from zebra (if any) onto the temporary
3568 /* Locate initial registered provider */
3569 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3571 /* Move new work from incoming list to temp list */
3572 for (counter
= 0; counter
< limit
; counter
++) {
3573 ctx
= TAILQ_FIRST(&zdplane_info
.dg_update_ctx_q
);
3575 TAILQ_REMOVE(&zdplane_info
.dg_update_ctx_q
, ctx
,
3578 ctx
->zd_provider
= prov
->dp_id
;
3580 TAILQ_INSERT_TAIL(&work_list
, ctx
, zd_q_entries
);
3588 atomic_fetch_sub_explicit(&zdplane_info
.dg_routes_queued
, counter
,
3589 memory_order_relaxed
);
3591 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3592 zlog_debug("dplane: incoming new work counter: %d", counter
);
3594 /* Iterate through the registered providers, offering new incoming
3595 * work. If the provider has outgoing work in its queue, take that
3596 * work for the next provider
3600 /* At each iteration, the temporary work list has 'counter'
3603 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3604 zlog_debug("dplane enqueues %d new work to provider '%s'",
3605 counter
, dplane_provider_get_name(prov
));
3607 /* Capture current provider id in each context; check for
3610 TAILQ_FOREACH_SAFE(ctx
, &work_list
, zd_q_entries
, tctx
) {
3611 if (dplane_ctx_get_status(ctx
) ==
3612 ZEBRA_DPLANE_REQUEST_SUCCESS
) {
3613 ctx
->zd_provider
= prov
->dp_id
;
3616 * TODO -- improve error-handling: recirc
3617 * errors backwards so that providers can
3618 * 'undo' their work (if they want to)
3621 /* Move to error list; will be returned
3624 TAILQ_REMOVE(&work_list
, ctx
, zd_q_entries
);
3625 TAILQ_INSERT_TAIL(&error_list
,
3631 /* Enqueue new work to the provider */
3632 dplane_provider_lock(prov
);
3634 if (TAILQ_FIRST(&work_list
))
3635 TAILQ_CONCAT(&(prov
->dp_ctx_in_q
), &work_list
,
3638 atomic_fetch_add_explicit(&prov
->dp_in_counter
, counter
,
3639 memory_order_relaxed
);
3640 atomic_fetch_add_explicit(&prov
->dp_in_queued
, counter
,
3641 memory_order_relaxed
);
3642 curr
= atomic_load_explicit(&prov
->dp_in_queued
,
3643 memory_order_relaxed
);
3644 high
= atomic_load_explicit(&prov
->dp_in_max
,
3645 memory_order_relaxed
);
3647 atomic_store_explicit(&prov
->dp_in_max
, curr
,
3648 memory_order_relaxed
);
3650 dplane_provider_unlock(prov
);
3652 /* Reset the temp list (though the 'concat' may have done this
3653 * already), and the counter
3655 TAILQ_INIT(&work_list
);
3658 /* Call into the provider code. Note that this is
3659 * unconditional: we offer to do work even if we don't enqueue
3662 (*prov
->dp_fp
)(prov
);
3664 /* Check for zebra shutdown */
3665 if (!zdplane_info
.dg_run
)
3668 /* Dequeue completed work from the provider */
3669 dplane_provider_lock(prov
);
3671 while (counter
< limit
) {
3672 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_out_q
));
3674 TAILQ_REMOVE(&(prov
->dp_ctx_out_q
), ctx
,
3677 TAILQ_INSERT_TAIL(&work_list
,
3684 dplane_provider_unlock(prov
);
3686 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3687 zlog_debug("dplane dequeues %d completed work from provider %s",
3688 counter
, dplane_provider_get_name(prov
));
3690 /* Locate next provider */
3692 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3696 /* After all providers have been serviced, enqueue any completed
3697 * work and any errors back to zebra so it can process the results.
3699 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3700 zlog_debug("dplane has %d completed, %d errors, for zebra main",
3701 counter
, error_counter
);
3704 * Hand lists through the api to zebra main,
3705 * to reduce the number of lock/unlock cycles
3708 /* Call through to zebra main */
3709 (zdplane_info
.dg_results_cb
)(&error_list
);
3711 TAILQ_INIT(&error_list
);
3713 /* Call through to zebra main */
3714 (zdplane_info
.dg_results_cb
)(&work_list
);
3716 TAILQ_INIT(&work_list
);
3723 * Final phase of shutdown, after all work enqueued to dplane has been
3724 * processed. This is called from the zebra main pthread context.
3726 void zebra_dplane_shutdown(void)
3728 if (IS_ZEBRA_DEBUG_DPLANE
)
3729 zlog_debug("Zebra dataplane shutdown called");
3731 /* Stop dplane thread, if it's running */
3733 zdplane_info
.dg_run
= false;
3735 THREAD_OFF(zdplane_info
.dg_t_update
);
3737 frr_pthread_stop(zdplane_info
.dg_pthread
, NULL
);
3739 /* Destroy pthread */
3740 frr_pthread_destroy(zdplane_info
.dg_pthread
);
3741 zdplane_info
.dg_pthread
= NULL
;
3742 zdplane_info
.dg_master
= NULL
;
3744 /* TODO -- Notify provider(s) of final shutdown */
3746 /* TODO -- Clean-up provider objects */
3748 /* TODO -- Clean queue(s), free memory */
3752 * Initialize the dataplane module during startup, internal/private version
3754 static void zebra_dplane_init_internal(void)
3756 memset(&zdplane_info
, 0, sizeof(zdplane_info
));
3758 pthread_mutex_init(&zdplane_info
.dg_mutex
, NULL
);
3760 TAILQ_INIT(&zdplane_info
.dg_update_ctx_q
);
3761 TAILQ_INIT(&zdplane_info
.dg_providers_q
);
3763 zdplane_info
.dg_updates_per_cycle
= DPLANE_DEFAULT_NEW_WORK
;
3765 zdplane_info
.dg_max_queued_updates
= DPLANE_DEFAULT_MAX_QUEUED
;
3767 /* Register default kernel 'provider' during init */
3768 dplane_provider_init();
3772 * Start the dataplane pthread. This step needs to be run later than the
3773 * 'init' step, in case zebra has fork-ed.
3775 void zebra_dplane_start(void)
3777 struct zebra_dplane_provider
*prov
;
3778 struct frr_pthread_attr pattr
= {
3779 .start
= frr_pthread_attr_default
.start
,
3780 .stop
= frr_pthread_attr_default
.stop
3783 /* Start dataplane pthread */
3785 zdplane_info
.dg_pthread
= frr_pthread_new(&pattr
, "Zebra dplane thread",
3788 zdplane_info
.dg_master
= zdplane_info
.dg_pthread
->master
;
3790 zdplane_info
.dg_run
= true;
3792 /* Enqueue an initial event for the dataplane pthread */
3793 thread_add_event(zdplane_info
.dg_master
, dplane_thread_loop
, NULL
, 0,
3794 &zdplane_info
.dg_t_update
);
3796 /* Call start callbacks for registered providers */
3799 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3805 (prov
->dp_start
)(prov
);
3807 /* Locate next provider */
3809 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3813 frr_pthread_run(zdplane_info
.dg_pthread
, NULL
);
3817 * Initialize the dataplane module at startup; called by zebra rib_init()
3819 void zebra_dplane_init(int (*results_fp
)(struct dplane_ctx_q
*))
3821 zebra_dplane_init_internal();
3822 zdplane_info
.dg_results_cb
= results_fp
;