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 int dplane_ctx_get_nhe_type(const struct zebra_dplane_ctx
*ctx
)
1082 DPLANE_CTX_VALID(ctx
);
1083 return ctx
->u
.rinfo
.nhe
.type
;
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
));
1530 struct nhg_hash_entry
*nhe
=
1531 zebra_nhg_resolve(zebra_nhg_lookup_id(re
->nhe_id
));
1533 ctx
->u
.rinfo
.nhe
.id
= nhe
->id
;
1535 * Check if the nhe is installed/queued before doing anything
1538 * If its a delete we only use the prefix anyway, so this only
1539 * matters for INSTALL/UPDATE.
1541 if (((op
== DPLANE_OP_ROUTE_INSTALL
)
1542 || (op
== DPLANE_OP_ROUTE_UPDATE
))
1543 && !CHECK_FLAG(nhe
->flags
, NEXTHOP_GROUP_INSTALLED
)
1544 && !CHECK_FLAG(nhe
->flags
, NEXTHOP_GROUP_QUEUED
)) {
1549 #endif /* HAVE_NETLINK */
1551 /* Trying out the sequence number idea, so we can try to detect
1552 * when a result is stale.
1554 re
->dplane_sequence
= zebra_router_get_next_sequence();
1555 ctx
->zd_seq
= re
->dplane_sequence
;
1564 * dplane_ctx_nexthop_init() - Initialize a context block for a nexthop update
1566 * @ctx: Dataplane context to init
1567 * @op: Operation being performed
1568 * @nhe: Nexthop group hash entry
1570 * Return: Result status
1572 static int dplane_ctx_nexthop_init(struct zebra_dplane_ctx
*ctx
,
1573 enum dplane_op_e op
,
1574 struct nhg_hash_entry
*nhe
)
1576 struct zebra_vrf
*zvrf
= NULL
;
1577 struct zebra_ns
*zns
= NULL
;
1585 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1587 /* Copy over nhe info */
1588 ctx
->u
.rinfo
.nhe
.id
= nhe
->id
;
1589 ctx
->u
.rinfo
.nhe
.afi
= nhe
->afi
;
1590 ctx
->u
.rinfo
.nhe
.vrf_id
= nhe
->vrf_id
;
1591 ctx
->u
.rinfo
.nhe
.type
= nhe
->type
;
1593 nexthop_group_copy(&(ctx
->u
.rinfo
.nhe
.ng
), nhe
->nhg
);
1595 /* If its a group, convert it to a grp array of ids */
1596 if (!zebra_nhg_depends_is_empty(nhe
)
1597 && !CHECK_FLAG(nhe
->flags
, NEXTHOP_GROUP_RECURSIVE
))
1598 ctx
->u
.rinfo
.nhe
.nh_grp_count
= zebra_nhg_nhe2grp(
1599 ctx
->u
.rinfo
.nhe
.nh_grp
, nhe
, MULTIPATH_NUM
);
1601 zvrf
= vrf_info_lookup(nhe
->vrf_id
);
1604 * Fallback to default namespace if the vrf got ripped out from under
1607 zns
= zvrf
? zvrf
->zns
: zebra_ns_lookup(NS_DEFAULT
);
1610 * TODO: Might not need to mark this as an update, since
1611 * it probably won't require two messages
1613 dplane_ctx_ns_init(ctx
, zns
, (op
== DPLANE_OP_NH_UPDATE
));
1622 * Capture information for an LSP update in a dplane context.
1624 static int dplane_ctx_lsp_init(struct zebra_dplane_ctx
*ctx
,
1625 enum dplane_op_e op
,
1629 zebra_nhlfe_t
*nhlfe
, *new_nhlfe
;
1631 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1632 zlog_debug("init dplane ctx %s: in-label %u ecmp# %d",
1633 dplane_op2str(op
), lsp
->ile
.in_label
,
1637 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1639 /* Capture namespace info */
1640 dplane_ctx_ns_init(ctx
, zebra_ns_lookup(NS_DEFAULT
),
1641 (op
== DPLANE_OP_LSP_UPDATE
));
1643 memset(&ctx
->u
.lsp
, 0, sizeof(ctx
->u
.lsp
));
1645 ctx
->u
.lsp
.ile
= lsp
->ile
;
1646 ctx
->u
.lsp
.addr_family
= lsp
->addr_family
;
1647 ctx
->u
.lsp
.num_ecmp
= lsp
->num_ecmp
;
1648 ctx
->u
.lsp
.flags
= lsp
->flags
;
1650 /* Copy source LSP's nhlfes, and capture 'best' nhlfe */
1651 for (nhlfe
= lsp
->nhlfe_list
; nhlfe
; nhlfe
= nhlfe
->next
) {
1652 /* Not sure if this is meaningful... */
1653 if (nhlfe
->nexthop
== NULL
)
1657 zebra_mpls_lsp_add_nhlfe(
1660 nhlfe
->nexthop
->type
,
1661 &(nhlfe
->nexthop
->gate
),
1662 nhlfe
->nexthop
->ifindex
,
1663 nhlfe
->nexthop
->nh_label
->label
[0]);
1665 if (new_nhlfe
== NULL
|| new_nhlfe
->nexthop
== NULL
) {
1670 /* Need to copy flags too */
1671 new_nhlfe
->flags
= nhlfe
->flags
;
1672 new_nhlfe
->nexthop
->flags
= nhlfe
->nexthop
->flags
;
1674 if (nhlfe
== lsp
->best_nhlfe
)
1675 ctx
->u
.lsp
.best_nhlfe
= new_nhlfe
;
1678 /* On error the ctx will be cleaned-up, so we don't need to
1679 * deal with any allocated nhlfe or nexthop structs here.
1686 * Capture information for an LSP update in a dplane context.
1688 static int dplane_ctx_pw_init(struct zebra_dplane_ctx
*ctx
,
1689 enum dplane_op_e op
,
1690 struct zebra_pw
*pw
)
1694 struct route_table
*table
;
1695 struct route_node
*rn
;
1696 struct route_entry
*re
;
1698 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1699 zlog_debug("init dplane ctx %s: pw '%s', loc %u, rem %u",
1700 dplane_op2str(op
), pw
->ifname
, pw
->local_label
,
1704 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1706 /* Capture namespace info: no netlink support as of 12/18,
1707 * but just in case...
1709 dplane_ctx_ns_init(ctx
, zebra_ns_lookup(NS_DEFAULT
), false);
1711 memset(&ctx
->u
.pw
, 0, sizeof(ctx
->u
.pw
));
1713 /* This name appears to be c-string, so we use string copy. */
1714 strlcpy(ctx
->zd_ifname
, pw
->ifname
, sizeof(ctx
->zd_ifname
));
1716 ctx
->zd_vrf_id
= pw
->vrf_id
;
1717 ctx
->zd_ifindex
= pw
->ifindex
;
1718 ctx
->u
.pw
.type
= pw
->type
;
1719 ctx
->u
.pw
.af
= pw
->af
;
1720 ctx
->u
.pw
.local_label
= pw
->local_label
;
1721 ctx
->u
.pw
.remote_label
= pw
->remote_label
;
1722 ctx
->u
.pw
.flags
= pw
->flags
;
1724 ctx
->u
.pw
.dest
= pw
->nexthop
;
1726 ctx
->u
.pw
.fields
= pw
->data
;
1728 /* Capture nexthop info for the pw destination. We need to look
1729 * up and use zebra datastructs, but we're running in the zebra
1730 * pthread here so that should be ok.
1732 memcpy(&p
.u
, &pw
->nexthop
, sizeof(pw
->nexthop
));
1734 p
.prefixlen
= ((pw
->af
== AF_INET
) ?
1735 IPV4_MAX_PREFIXLEN
: IPV6_MAX_PREFIXLEN
);
1737 afi
= (pw
->af
== AF_INET
) ? AFI_IP
: AFI_IP6
;
1738 table
= zebra_vrf_table(afi
, SAFI_UNICAST
, pw
->vrf_id
);
1740 rn
= route_node_match(table
, &p
);
1742 RNODE_FOREACH_RE(rn
, re
) {
1743 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
))
1748 copy_nexthops(&(ctx
->u
.pw
.nhg
.nexthop
),
1749 re
->ng
->nexthop
, NULL
);
1751 route_unlock_node(rn
);
1759 * Enqueue a new update,
1760 * and ensure an event is active for the dataplane pthread.
1762 static int dplane_update_enqueue(struct zebra_dplane_ctx
*ctx
)
1765 uint32_t high
, curr
;
1767 /* Enqueue for processing by the dataplane pthread */
1770 TAILQ_INSERT_TAIL(&zdplane_info
.dg_update_ctx_q
, ctx
,
1775 curr
= atomic_add_fetch_explicit(
1777 /* TODO -- issue with the clang atomic/intrinsics currently;
1778 * casting away the 'Atomic'-ness of the variable works.
1780 (uint32_t *)&(zdplane_info
.dg_routes_queued
),
1782 &(zdplane_info
.dg_routes_queued
),
1784 1, memory_order_seq_cst
);
1786 /* Maybe update high-water counter also */
1787 high
= atomic_load_explicit(&zdplane_info
.dg_routes_queued_max
,
1788 memory_order_seq_cst
);
1789 while (high
< curr
) {
1790 if (atomic_compare_exchange_weak_explicit(
1791 &zdplane_info
.dg_routes_queued_max
,
1793 memory_order_seq_cst
,
1794 memory_order_seq_cst
))
1798 /* Ensure that an event for the dataplane thread is active */
1799 ret
= dplane_provider_work_ready();
1805 * Utility that prepares a route update and enqueues it for processing
1807 static enum zebra_dplane_result
1808 dplane_route_update_internal(struct route_node
*rn
,
1809 struct route_entry
*re
,
1810 struct route_entry
*old_re
,
1811 enum dplane_op_e op
)
1813 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1815 struct zebra_dplane_ctx
*ctx
= NULL
;
1817 /* Obtain context block */
1818 ctx
= dplane_ctx_alloc();
1820 /* Init context with info from zebra data structs */
1821 ret
= dplane_ctx_route_init(ctx
, op
, rn
, re
);
1823 /* Capture some extra info for update case
1824 * where there's a different 'old' route.
1826 if ((op
== DPLANE_OP_ROUTE_UPDATE
) &&
1827 old_re
&& (old_re
!= re
)) {
1828 ctx
->zd_is_update
= true;
1830 old_re
->dplane_sequence
=
1831 zebra_router_get_next_sequence();
1832 ctx
->zd_old_seq
= old_re
->dplane_sequence
;
1834 ctx
->u
.rinfo
.zd_old_tag
= old_re
->tag
;
1835 ctx
->u
.rinfo
.zd_old_type
= old_re
->type
;
1836 ctx
->u
.rinfo
.zd_old_instance
= old_re
->instance
;
1837 ctx
->u
.rinfo
.zd_old_distance
= old_re
->distance
;
1838 ctx
->u
.rinfo
.zd_old_metric
= old_re
->metric
;
1840 #ifndef HAVE_NETLINK
1841 /* For bsd, capture previous re's nexthops too, sigh.
1842 * We'll need these to do per-nexthop deletes.
1844 copy_nexthops(&(ctx
->u
.rinfo
.zd_old_ng
.nexthop
),
1845 old_re
->ng
->nexthop
, NULL
);
1846 #endif /* !HAVE_NETLINK */
1849 /* Enqueue context for processing */
1850 ret
= dplane_update_enqueue(ctx
);
1853 /* Update counter */
1854 atomic_fetch_add_explicit(&zdplane_info
.dg_routes_in
, 1,
1855 memory_order_relaxed
);
1858 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
1861 result
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1863 atomic_fetch_add_explicit(&zdplane_info
.dg_route_errors
,
1864 1, memory_order_relaxed
);
1866 dplane_ctx_free(&ctx
);
1873 * dplane_nexthop_update_internal() - Helper for enqueuing nexthop changes
1875 * @nhe: Nexthop group hash entry where the change occured
1876 * @op: The operation to be enqued
1878 * Return: Result of the change
1880 static enum zebra_dplane_result
1881 dplane_nexthop_update_internal(struct nhg_hash_entry
*nhe
, enum dplane_op_e op
)
1883 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1885 struct zebra_dplane_ctx
*ctx
= NULL
;
1887 /* Obtain context block */
1888 ctx
= dplane_ctx_alloc();
1894 ret
= dplane_ctx_nexthop_init(ctx
, op
, nhe
);
1896 ret
= dplane_update_enqueue(ctx
);
1899 /* Update counter */
1900 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthops_in
, 1,
1901 memory_order_relaxed
);
1904 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
1906 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthop_errors
, 1,
1907 memory_order_relaxed
);
1909 dplane_ctx_free(&ctx
);
1916 * Enqueue a route 'add' for the dataplane.
1918 enum zebra_dplane_result
dplane_route_add(struct route_node
*rn
,
1919 struct route_entry
*re
)
1921 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1923 if (rn
== NULL
|| re
== NULL
)
1926 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1927 DPLANE_OP_ROUTE_INSTALL
);
1934 * Enqueue a route update for the dataplane.
1936 enum zebra_dplane_result
dplane_route_update(struct route_node
*rn
,
1937 struct route_entry
*re
,
1938 struct route_entry
*old_re
)
1940 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1942 if (rn
== NULL
|| re
== NULL
)
1945 ret
= dplane_route_update_internal(rn
, re
, old_re
,
1946 DPLANE_OP_ROUTE_UPDATE
);
1952 * Enqueue a route removal for the dataplane.
1954 enum zebra_dplane_result
dplane_route_delete(struct route_node
*rn
,
1955 struct route_entry
*re
)
1957 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1959 if (rn
== NULL
|| re
== NULL
)
1962 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1963 DPLANE_OP_ROUTE_DELETE
);
1970 * Notify the dplane when system/connected routes change.
1972 enum zebra_dplane_result
dplane_sys_route_add(struct route_node
*rn
,
1973 struct route_entry
*re
)
1975 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
1977 /* Ignore this event unless a provider plugin has requested it. */
1978 if (!zdplane_info
.dg_sys_route_notifs
) {
1979 ret
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
1983 if (rn
== NULL
|| re
== NULL
)
1986 ret
= dplane_route_update_internal(rn
, re
, NULL
,
1987 DPLANE_OP_SYS_ROUTE_ADD
);
1994 * Notify the dplane when system/connected routes are deleted.
1996 enum zebra_dplane_result
dplane_sys_route_del(struct route_node
*rn
,
1997 struct route_entry
*re
)
1999 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2001 /* Ignore this event unless a provider plugin has requested it. */
2002 if (!zdplane_info
.dg_sys_route_notifs
) {
2003 ret
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2007 if (rn
== NULL
|| re
== NULL
)
2010 ret
= dplane_route_update_internal(rn
, re
, NULL
,
2011 DPLANE_OP_SYS_ROUTE_DELETE
);
2018 * Update from an async notification, to bring other fibs up-to-date.
2020 enum zebra_dplane_result
2021 dplane_route_notif_update(struct route_node
*rn
,
2022 struct route_entry
*re
,
2023 enum dplane_op_e op
,
2024 struct zebra_dplane_ctx
*ctx
)
2026 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2027 struct zebra_dplane_ctx
*new_ctx
= NULL
;
2028 struct nexthop
*nexthop
;
2030 if (rn
== NULL
|| re
== NULL
)
2033 new_ctx
= dplane_ctx_alloc();
2034 if (new_ctx
== NULL
)
2037 /* Init context with info from zebra data structs */
2038 dplane_ctx_route_init(new_ctx
, op
, rn
, re
);
2040 /* For add/update, need to adjust the nexthops so that we match
2041 * the notification state, which may not be the route-entry/RIB
2044 if (op
== DPLANE_OP_ROUTE_UPDATE
||
2045 op
== DPLANE_OP_ROUTE_INSTALL
) {
2047 nexthops_free(new_ctx
->u
.rinfo
.zd_ng
.nexthop
);
2048 new_ctx
->u
.rinfo
.zd_ng
.nexthop
= NULL
;
2050 copy_nexthops(&(new_ctx
->u
.rinfo
.zd_ng
.nexthop
),
2051 (rib_active_nhg(re
))->nexthop
, NULL
);
2053 for (ALL_NEXTHOPS(new_ctx
->u
.rinfo
.zd_ng
, nexthop
))
2054 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
2058 /* Capture info about the source of the notification, in 'ctx' */
2059 dplane_ctx_set_notif_provider(new_ctx
,
2060 dplane_ctx_get_notif_provider(ctx
));
2062 dplane_update_enqueue(new_ctx
);
2064 ret
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2071 * Enqueue a nexthop add for the dataplane.
2073 enum zebra_dplane_result
dplane_nexthop_add(struct nhg_hash_entry
*nhe
)
2075 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2078 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_INSTALL
);
2083 * Enqueue a nexthop update for the dataplane.
2085 * Might not need this func since zebra's nexthop objects should be immutable?
2087 enum zebra_dplane_result
dplane_nexthop_update(struct nhg_hash_entry
*nhe
)
2089 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2092 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_UPDATE
);
2097 * Enqueue a nexthop removal for the dataplane.
2099 enum zebra_dplane_result
dplane_nexthop_delete(struct nhg_hash_entry
*nhe
)
2101 enum zebra_dplane_result ret
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2104 ret
= dplane_nexthop_update_internal(nhe
, DPLANE_OP_NH_DELETE
);
2110 * Enqueue LSP add for the dataplane.
2112 enum zebra_dplane_result
dplane_lsp_add(zebra_lsp_t
*lsp
)
2114 enum zebra_dplane_result ret
=
2115 lsp_update_internal(lsp
, DPLANE_OP_LSP_INSTALL
);
2121 * Enqueue LSP update for the dataplane.
2123 enum zebra_dplane_result
dplane_lsp_update(zebra_lsp_t
*lsp
)
2125 enum zebra_dplane_result ret
=
2126 lsp_update_internal(lsp
, DPLANE_OP_LSP_UPDATE
);
2132 * Enqueue LSP delete for the dataplane.
2134 enum zebra_dplane_result
dplane_lsp_delete(zebra_lsp_t
*lsp
)
2136 enum zebra_dplane_result ret
=
2137 lsp_update_internal(lsp
, DPLANE_OP_LSP_DELETE
);
2142 /* Update or un-install resulting from an async notification */
2143 enum zebra_dplane_result
2144 dplane_lsp_notif_update(zebra_lsp_t
*lsp
,
2145 enum dplane_op_e op
,
2146 struct zebra_dplane_ctx
*notif_ctx
)
2148 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2150 struct zebra_dplane_ctx
*ctx
= NULL
;
2152 /* Obtain context block */
2153 ctx
= dplane_ctx_alloc();
2159 ret
= dplane_ctx_lsp_init(ctx
, op
, lsp
);
2163 /* Capture info about the source of the notification */
2164 dplane_ctx_set_notif_provider(
2166 dplane_ctx_get_notif_provider(notif_ctx
));
2168 ret
= dplane_update_enqueue(ctx
);
2171 /* Update counter */
2172 atomic_fetch_add_explicit(&zdplane_info
.dg_lsps_in
, 1,
2173 memory_order_relaxed
);
2176 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2178 atomic_fetch_add_explicit(&zdplane_info
.dg_lsp_errors
, 1,
2179 memory_order_relaxed
);
2181 dplane_ctx_free(&ctx
);
2187 * Enqueue pseudowire install for the dataplane.
2189 enum zebra_dplane_result
dplane_pw_install(struct zebra_pw
*pw
)
2191 return pw_update_internal(pw
, DPLANE_OP_PW_INSTALL
);
2195 * Enqueue pseudowire un-install for the dataplane.
2197 enum zebra_dplane_result
dplane_pw_uninstall(struct zebra_pw
*pw
)
2199 return pw_update_internal(pw
, DPLANE_OP_PW_UNINSTALL
);
2203 * Common internal LSP update utility
2205 static enum zebra_dplane_result
lsp_update_internal(zebra_lsp_t
*lsp
,
2206 enum dplane_op_e op
)
2208 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2210 struct zebra_dplane_ctx
*ctx
= NULL
;
2212 /* Obtain context block */
2213 ctx
= dplane_ctx_alloc();
2215 ret
= dplane_ctx_lsp_init(ctx
, op
, lsp
);
2219 ret
= dplane_update_enqueue(ctx
);
2222 /* Update counter */
2223 atomic_fetch_add_explicit(&zdplane_info
.dg_lsps_in
, 1,
2224 memory_order_relaxed
);
2227 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2229 atomic_fetch_add_explicit(&zdplane_info
.dg_lsp_errors
, 1,
2230 memory_order_relaxed
);
2231 dplane_ctx_free(&ctx
);
2238 * Internal, common handler for pseudowire updates.
2240 static enum zebra_dplane_result
pw_update_internal(struct zebra_pw
*pw
,
2241 enum dplane_op_e op
)
2243 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2245 struct zebra_dplane_ctx
*ctx
= NULL
;
2247 ctx
= dplane_ctx_alloc();
2249 ret
= dplane_ctx_pw_init(ctx
, op
, pw
);
2253 ret
= dplane_update_enqueue(ctx
);
2256 /* Update counter */
2257 atomic_fetch_add_explicit(&zdplane_info
.dg_pws_in
, 1,
2258 memory_order_relaxed
);
2261 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2263 atomic_fetch_add_explicit(&zdplane_info
.dg_pw_errors
, 1,
2264 memory_order_relaxed
);
2265 dplane_ctx_free(&ctx
);
2272 * Enqueue interface address add for the dataplane.
2274 enum zebra_dplane_result
dplane_intf_addr_set(const struct interface
*ifp
,
2275 const struct connected
*ifc
)
2277 #if !defined(HAVE_NETLINK) && defined(HAVE_STRUCT_IFALIASREQ)
2278 /* Extra checks for this OS path. */
2280 /* Don't configure PtP addresses on broadcast ifs or reverse */
2281 if (!(ifp
->flags
& IFF_POINTOPOINT
) != !CONNECTED_PEER(ifc
)) {
2282 if (IS_ZEBRA_DEBUG_KERNEL
|| IS_ZEBRA_DEBUG_DPLANE
)
2283 zlog_debug("Failed to set intf addr: mismatch p2p and connected");
2285 return ZEBRA_DPLANE_REQUEST_FAILURE
;
2288 /* Ensure that no existing installed v4 route conflicts with
2289 * the new interface prefix. This check must be done in the
2290 * zebra pthread context, and any route delete (if needed)
2291 * is enqueued before the interface address programming attempt.
2293 if (ifc
->address
->family
== AF_INET
) {
2294 struct prefix_ipv4
*p
;
2296 p
= (struct prefix_ipv4
*)ifc
->address
;
2297 rib_lookup_and_pushup(p
, ifp
->vrf_id
);
2301 return intf_addr_update_internal(ifp
, ifc
, DPLANE_OP_ADDR_INSTALL
);
2305 * Enqueue interface address remove/uninstall for the dataplane.
2307 enum zebra_dplane_result
dplane_intf_addr_unset(const struct interface
*ifp
,
2308 const struct connected
*ifc
)
2310 return intf_addr_update_internal(ifp
, ifc
, DPLANE_OP_ADDR_UNINSTALL
);
2313 static enum zebra_dplane_result
intf_addr_update_internal(
2314 const struct interface
*ifp
, const struct connected
*ifc
,
2315 enum dplane_op_e op
)
2317 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2319 struct zebra_dplane_ctx
*ctx
= NULL
;
2320 struct zebra_ns
*zns
;
2322 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2323 char addr_str
[PREFIX_STRLEN
];
2325 prefix2str(ifc
->address
, addr_str
, sizeof(addr_str
));
2327 zlog_debug("init intf ctx %s: idx %d, addr %u:%s",
2328 dplane_op2str(op
), ifp
->ifindex
, ifp
->vrf_id
,
2332 ctx
= dplane_ctx_alloc();
2335 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2336 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2338 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2339 dplane_ctx_ns_init(ctx
, zns
, false);
2341 /* Init the interface-addr-specific area */
2342 memset(&ctx
->u
.intf
, 0, sizeof(ctx
->u
.intf
));
2344 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2345 ctx
->zd_ifindex
= ifp
->ifindex
;
2346 ctx
->u
.intf
.prefix
= *(ifc
->address
);
2348 if (if_is_broadcast(ifp
))
2349 ctx
->u
.intf
.flags
|= DPLANE_INTF_BROADCAST
;
2351 if (CONNECTED_PEER(ifc
)) {
2352 ctx
->u
.intf
.dest_prefix
= *(ifc
->destination
);
2353 ctx
->u
.intf
.flags
|=
2354 (DPLANE_INTF_CONNECTED
| DPLANE_INTF_HAS_DEST
);
2357 if (CHECK_FLAG(ifc
->flags
, ZEBRA_IFA_SECONDARY
))
2358 ctx
->u
.intf
.flags
|= DPLANE_INTF_SECONDARY
;
2363 ctx
->u
.intf
.flags
|= DPLANE_INTF_HAS_LABEL
;
2365 /* Use embedded buffer if it's adequate; else allocate. */
2366 len
= strlen(ifc
->label
);
2368 if (len
< sizeof(ctx
->u
.intf
.label_buf
)) {
2369 strlcpy(ctx
->u
.intf
.label_buf
, ifc
->label
,
2370 sizeof(ctx
->u
.intf
.label_buf
));
2371 ctx
->u
.intf
.label
= ctx
->u
.intf
.label_buf
;
2373 ctx
->u
.intf
.label
= strdup(ifc
->label
);
2377 ret
= dplane_update_enqueue(ctx
);
2379 /* Increment counter */
2380 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addrs_in
, 1,
2381 memory_order_relaxed
);
2384 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2387 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addr_errors
,
2388 1, memory_order_relaxed
);
2389 dplane_ctx_free(&ctx
);
2396 * Enqueue vxlan/evpn mac add (or update).
2398 enum zebra_dplane_result
dplane_mac_add(const struct interface
*ifp
,
2399 const struct interface
*bridge_ifp
,
2401 const struct ethaddr
*mac
,
2402 struct in_addr vtep_ip
,
2405 enum zebra_dplane_result result
;
2407 /* Use common helper api */
2408 result
= mac_update_internal(DPLANE_OP_MAC_INSTALL
, ifp
, bridge_ifp
,
2409 vid
, mac
, vtep_ip
, sticky
);
2414 * Enqueue vxlan/evpn mac delete.
2416 enum zebra_dplane_result
dplane_mac_del(const struct interface
*ifp
,
2417 const struct interface
*bridge_ifp
,
2419 const struct ethaddr
*mac
,
2420 struct in_addr vtep_ip
)
2422 enum zebra_dplane_result result
;
2424 /* Use common helper api */
2425 result
= mac_update_internal(DPLANE_OP_MAC_DELETE
, ifp
, bridge_ifp
,
2426 vid
, mac
, vtep_ip
, false);
2431 * Common helper api for MAC address/vxlan updates
2433 static enum zebra_dplane_result
2434 mac_update_internal(enum dplane_op_e op
,
2435 const struct interface
*ifp
,
2436 const struct interface
*br_ifp
,
2438 const struct ethaddr
*mac
,
2439 struct in_addr vtep_ip
,
2442 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2444 struct zebra_dplane_ctx
*ctx
= NULL
;
2445 struct zebra_ns
*zns
;
2447 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2448 char buf1
[ETHER_ADDR_STRLEN
], buf2
[PREFIX_STRLEN
];
2450 zlog_debug("init mac ctx %s: mac %s, ifp %s, vtep %s",
2452 prefix_mac2str(mac
, buf1
, sizeof(buf1
)),
2454 inet_ntop(AF_INET
, &vtep_ip
, buf2
, sizeof(buf2
)));
2457 ctx
= dplane_ctx_alloc();
2460 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2461 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2463 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2464 dplane_ctx_ns_init(ctx
, zns
, false);
2466 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2467 ctx
->zd_ifindex
= ifp
->ifindex
;
2469 /* Init the mac-specific data area */
2470 memset(&ctx
->u
.macinfo
, 0, sizeof(ctx
->u
.macinfo
));
2472 ctx
->u
.macinfo
.br_ifindex
= br_ifp
->ifindex
;
2473 ctx
->u
.macinfo
.vtep_ip
= vtep_ip
;
2474 ctx
->u
.macinfo
.mac
= *mac
;
2475 ctx
->u
.macinfo
.vid
= vid
;
2476 ctx
->u
.macinfo
.is_sticky
= sticky
;
2478 /* Enqueue for processing on the dplane pthread */
2479 ret
= dplane_update_enqueue(ctx
);
2481 /* Increment counter */
2482 atomic_fetch_add_explicit(&zdplane_info
.dg_macs_in
, 1,
2483 memory_order_relaxed
);
2486 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2489 atomic_fetch_add_explicit(&zdplane_info
.dg_mac_errors
, 1,
2490 memory_order_relaxed
);
2491 dplane_ctx_free(&ctx
);
2498 * Enqueue evpn neighbor add for the dataplane.
2500 enum zebra_dplane_result
dplane_neigh_add(const struct interface
*ifp
,
2501 const struct ipaddr
*ip
,
2502 const struct ethaddr
*mac
,
2505 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2507 result
= neigh_update_internal(DPLANE_OP_NEIGH_INSTALL
,
2508 ifp
, mac
, ip
, flags
, 0);
2514 * Enqueue evpn neighbor update for the dataplane.
2516 enum zebra_dplane_result
dplane_neigh_update(const struct interface
*ifp
,
2517 const struct ipaddr
*ip
,
2518 const struct ethaddr
*mac
)
2520 enum zebra_dplane_result result
;
2522 result
= neigh_update_internal(DPLANE_OP_NEIGH_UPDATE
,
2523 ifp
, mac
, ip
, 0, DPLANE_NUD_PROBE
);
2529 * Enqueue evpn neighbor delete for the dataplane.
2531 enum zebra_dplane_result
dplane_neigh_delete(const struct interface
*ifp
,
2532 const struct ipaddr
*ip
)
2534 enum zebra_dplane_result result
;
2536 result
= neigh_update_internal(DPLANE_OP_NEIGH_DELETE
,
2537 ifp
, NULL
, ip
, 0, 0);
2543 * Enqueue evpn VTEP add for the dataplane.
2545 enum zebra_dplane_result
dplane_vtep_add(const struct interface
*ifp
,
2546 const struct in_addr
*ip
,
2549 enum zebra_dplane_result result
;
2550 struct ethaddr mac
= { {0, 0, 0, 0, 0, 0} };
2553 if (IS_ZEBRA_DEBUG_VXLAN
)
2554 zlog_debug("Install %s into flood list for VNI %u intf %s(%u)",
2555 inet_ntoa(*ip
), vni
, ifp
->name
, ifp
->ifindex
);
2557 SET_IPADDR_V4(&addr
);
2558 addr
.ipaddr_v4
= *ip
;
2560 result
= neigh_update_internal(DPLANE_OP_VTEP_ADD
,
2561 ifp
, &mac
, &addr
, 0, 0);
2567 * Enqueue evpn VTEP add for the dataplane.
2569 enum zebra_dplane_result
dplane_vtep_delete(const struct interface
*ifp
,
2570 const struct in_addr
*ip
,
2573 enum zebra_dplane_result result
;
2574 struct ethaddr mac
= { {0, 0, 0, 0, 0, 0} };
2577 if (IS_ZEBRA_DEBUG_VXLAN
)
2579 "Uninstall %s from flood list for VNI %u intf %s(%u)",
2580 inet_ntoa(*ip
), vni
, ifp
->name
, ifp
->ifindex
);
2582 SET_IPADDR_V4(&addr
);
2583 addr
.ipaddr_v4
= *ip
;
2585 result
= neigh_update_internal(DPLANE_OP_VTEP_DELETE
,
2586 ifp
, &mac
, &addr
, 0, 0);
2592 * Common helper api for evpn neighbor updates
2594 static enum zebra_dplane_result
2595 neigh_update_internal(enum dplane_op_e op
,
2596 const struct interface
*ifp
,
2597 const struct ethaddr
*mac
,
2598 const struct ipaddr
*ip
,
2599 uint32_t flags
, uint16_t state
)
2601 enum zebra_dplane_result result
= ZEBRA_DPLANE_REQUEST_FAILURE
;
2603 struct zebra_dplane_ctx
*ctx
= NULL
;
2604 struct zebra_ns
*zns
;
2606 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
2607 char buf1
[ETHER_ADDR_STRLEN
], buf2
[PREFIX_STRLEN
];
2609 zlog_debug("init neigh ctx %s: ifp %s, mac %s, ip %s",
2611 prefix_mac2str(mac
, buf1
, sizeof(buf1
)),
2613 ipaddr2str(ip
, buf2
, sizeof(buf2
)));
2616 ctx
= dplane_ctx_alloc();
2619 ctx
->zd_status
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
2620 ctx
->zd_vrf_id
= ifp
->vrf_id
;
2622 zns
= zebra_ns_lookup(ifp
->vrf_id
);
2623 dplane_ctx_ns_init(ctx
, zns
, false);
2625 strlcpy(ctx
->zd_ifname
, ifp
->name
, sizeof(ctx
->zd_ifname
));
2626 ctx
->zd_ifindex
= ifp
->ifindex
;
2628 /* Init the neighbor-specific data area */
2629 memset(&ctx
->u
.neigh
, 0, sizeof(ctx
->u
.neigh
));
2631 ctx
->u
.neigh
.ip_addr
= *ip
;
2633 ctx
->u
.neigh
.mac
= *mac
;
2634 ctx
->u
.neigh
.flags
= flags
;
2635 ctx
->u
.neigh
.state
= state
;
2637 /* Enqueue for processing on the dplane pthread */
2638 ret
= dplane_update_enqueue(ctx
);
2640 /* Increment counter */
2641 atomic_fetch_add_explicit(&zdplane_info
.dg_neighs_in
, 1,
2642 memory_order_relaxed
);
2645 result
= ZEBRA_DPLANE_REQUEST_QUEUED
;
2648 atomic_fetch_add_explicit(&zdplane_info
.dg_neigh_errors
, 1,
2649 memory_order_relaxed
);
2650 dplane_ctx_free(&ctx
);
2657 * Handler for 'show dplane'
2659 int dplane_show_helper(struct vty
*vty
, bool detailed
)
2661 uint64_t queued
, queue_max
, limit
, errs
, incoming
, yields
,
2664 /* Using atomics because counters are being changed in different
2667 incoming
= atomic_load_explicit(&zdplane_info
.dg_routes_in
,
2668 memory_order_relaxed
);
2669 limit
= atomic_load_explicit(&zdplane_info
.dg_max_queued_updates
,
2670 memory_order_relaxed
);
2671 queued
= atomic_load_explicit(&zdplane_info
.dg_routes_queued
,
2672 memory_order_relaxed
);
2673 queue_max
= atomic_load_explicit(&zdplane_info
.dg_routes_queued_max
,
2674 memory_order_relaxed
);
2675 errs
= atomic_load_explicit(&zdplane_info
.dg_route_errors
,
2676 memory_order_relaxed
);
2677 yields
= atomic_load_explicit(&zdplane_info
.dg_update_yields
,
2678 memory_order_relaxed
);
2679 other_errs
= atomic_load_explicit(&zdplane_info
.dg_other_errors
,
2680 memory_order_relaxed
);
2682 vty_out(vty
, "Zebra dataplane:\nRoute updates: %"PRIu64
"\n",
2684 vty_out(vty
, "Route update errors: %"PRIu64
"\n", errs
);
2685 vty_out(vty
, "Other errors : %"PRIu64
"\n", other_errs
);
2686 vty_out(vty
, "Route update queue limit: %"PRIu64
"\n", limit
);
2687 vty_out(vty
, "Route update queue depth: %"PRIu64
"\n", queued
);
2688 vty_out(vty
, "Route update queue max: %"PRIu64
"\n", queue_max
);
2689 vty_out(vty
, "Dplane update yields: %"PRIu64
"\n", yields
);
2691 incoming
= atomic_load_explicit(&zdplane_info
.dg_lsps_in
,
2692 memory_order_relaxed
);
2693 errs
= atomic_load_explicit(&zdplane_info
.dg_lsp_errors
,
2694 memory_order_relaxed
);
2695 vty_out(vty
, "LSP updates: %"PRIu64
"\n", incoming
);
2696 vty_out(vty
, "LSP update errors: %"PRIu64
"\n", errs
);
2698 incoming
= atomic_load_explicit(&zdplane_info
.dg_pws_in
,
2699 memory_order_relaxed
);
2700 errs
= atomic_load_explicit(&zdplane_info
.dg_pw_errors
,
2701 memory_order_relaxed
);
2702 vty_out(vty
, "PW updates: %"PRIu64
"\n", incoming
);
2703 vty_out(vty
, "PW update errors: %"PRIu64
"\n", errs
);
2705 incoming
= atomic_load_explicit(&zdplane_info
.dg_intf_addrs_in
,
2706 memory_order_relaxed
);
2707 errs
= atomic_load_explicit(&zdplane_info
.dg_intf_addr_errors
,
2708 memory_order_relaxed
);
2709 vty_out(vty
, "Intf addr updates: %"PRIu64
"\n", incoming
);
2710 vty_out(vty
, "Intf addr errors: %"PRIu64
"\n", errs
);
2712 incoming
= atomic_load_explicit(&zdplane_info
.dg_macs_in
,
2713 memory_order_relaxed
);
2714 errs
= atomic_load_explicit(&zdplane_info
.dg_mac_errors
,
2715 memory_order_relaxed
);
2716 vty_out(vty
, "EVPN MAC updates: %"PRIu64
"\n", incoming
);
2717 vty_out(vty
, "EVPN MAC errors: %"PRIu64
"\n", errs
);
2719 incoming
= atomic_load_explicit(&zdplane_info
.dg_neighs_in
,
2720 memory_order_relaxed
);
2721 errs
= atomic_load_explicit(&zdplane_info
.dg_neigh_errors
,
2722 memory_order_relaxed
);
2723 vty_out(vty
, "EVPN neigh updates: %"PRIu64
"\n", incoming
);
2724 vty_out(vty
, "EVPN neigh errors: %"PRIu64
"\n", errs
);
2730 * Handler for 'show dplane providers'
2732 int dplane_show_provs_helper(struct vty
*vty
, bool detailed
)
2734 struct zebra_dplane_provider
*prov
;
2735 uint64_t in
, in_max
, out
, out_max
;
2737 vty_out(vty
, "Zebra dataplane providers:\n");
2740 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
2743 /* Show counters, useful info from each registered provider */
2746 in
= atomic_load_explicit(&prov
->dp_in_counter
,
2747 memory_order_relaxed
);
2748 in_max
= atomic_load_explicit(&prov
->dp_in_max
,
2749 memory_order_relaxed
);
2750 out
= atomic_load_explicit(&prov
->dp_out_counter
,
2751 memory_order_relaxed
);
2752 out_max
= atomic_load_explicit(&prov
->dp_out_max
,
2753 memory_order_relaxed
);
2755 vty_out(vty
, "%s (%u): in: %"PRIu64
", q_max: %"PRIu64
", "
2756 "out: %"PRIu64
", q_max: %"PRIu64
"\n",
2757 prov
->dp_name
, prov
->dp_id
, in
, in_max
, out
, out_max
);
2760 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
2768 * Helper for 'show run' etc.
2770 int dplane_config_write_helper(struct vty
*vty
)
2772 if (zdplane_info
.dg_max_queued_updates
!= DPLANE_DEFAULT_MAX_QUEUED
)
2773 vty_out(vty
, "zebra dplane limit %u\n",
2774 zdplane_info
.dg_max_queued_updates
);
2780 * Provider registration
2782 int dplane_provider_register(const char *name
,
2783 enum dplane_provider_prio prio
,
2785 int (*start_fp
)(struct zebra_dplane_provider
*),
2786 int (*fp
)(struct zebra_dplane_provider
*),
2787 int (*fini_fp
)(struct zebra_dplane_provider
*,
2790 struct zebra_dplane_provider
**prov_p
)
2793 struct zebra_dplane_provider
*p
= NULL
, *last
;
2801 if (prio
<= DPLANE_PRIO_NONE
||
2802 prio
> DPLANE_PRIO_LAST
) {
2807 /* Allocate and init new provider struct */
2808 p
= XCALLOC(MTYPE_DP_PROV
, sizeof(struct zebra_dplane_provider
));
2810 pthread_mutex_init(&(p
->dp_mutex
), NULL
);
2811 TAILQ_INIT(&(p
->dp_ctx_in_q
));
2812 TAILQ_INIT(&(p
->dp_ctx_out_q
));
2814 p
->dp_priority
= prio
;
2816 p
->dp_start
= start_fp
;
2817 p
->dp_fini
= fini_fp
;
2820 /* Lock - the dplane pthread may be running */
2823 p
->dp_id
= ++zdplane_info
.dg_provider_id
;
2826 strlcpy(p
->dp_name
, name
, DPLANE_PROVIDER_NAMELEN
);
2828 snprintf(p
->dp_name
, DPLANE_PROVIDER_NAMELEN
,
2829 "provider-%u", p
->dp_id
);
2831 /* Insert into list ordered by priority */
2832 TAILQ_FOREACH(last
, &zdplane_info
.dg_providers_q
, dp_prov_link
) {
2833 if (last
->dp_priority
> p
->dp_priority
)
2838 TAILQ_INSERT_BEFORE(last
, p
, dp_prov_link
);
2840 TAILQ_INSERT_TAIL(&zdplane_info
.dg_providers_q
, p
,
2846 if (IS_ZEBRA_DEBUG_DPLANE
)
2847 zlog_debug("dplane: registered new provider '%s' (%u), prio %d",
2848 p
->dp_name
, p
->dp_id
, p
->dp_priority
);
2857 /* Accessors for provider attributes */
2858 const char *dplane_provider_get_name(const struct zebra_dplane_provider
*prov
)
2860 return prov
->dp_name
;
2863 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider
*prov
)
2868 void *dplane_provider_get_data(const struct zebra_dplane_provider
*prov
)
2870 return prov
->dp_data
;
2873 int dplane_provider_get_work_limit(const struct zebra_dplane_provider
*prov
)
2875 return zdplane_info
.dg_updates_per_cycle
;
2878 /* Lock/unlock a provider's mutex - iff the provider was registered with
2879 * the THREADED flag.
2881 void dplane_provider_lock(struct zebra_dplane_provider
*prov
)
2883 if (dplane_provider_is_threaded(prov
))
2884 DPLANE_PROV_LOCK(prov
);
2887 void dplane_provider_unlock(struct zebra_dplane_provider
*prov
)
2889 if (dplane_provider_is_threaded(prov
))
2890 DPLANE_PROV_UNLOCK(prov
);
2894 * Dequeue and maintain associated counter
2896 struct zebra_dplane_ctx
*dplane_provider_dequeue_in_ctx(
2897 struct zebra_dplane_provider
*prov
)
2899 struct zebra_dplane_ctx
*ctx
= NULL
;
2901 dplane_provider_lock(prov
);
2903 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
2905 TAILQ_REMOVE(&(prov
->dp_ctx_in_q
), ctx
, zd_q_entries
);
2907 atomic_fetch_sub_explicit(&prov
->dp_in_queued
, 1,
2908 memory_order_relaxed
);
2911 dplane_provider_unlock(prov
);
2917 * Dequeue work to a list, return count
2919 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider
*prov
,
2920 struct dplane_ctx_q
*listp
)
2923 struct zebra_dplane_ctx
*ctx
;
2925 limit
= zdplane_info
.dg_updates_per_cycle
;
2927 dplane_provider_lock(prov
);
2929 for (ret
= 0; ret
< limit
; ret
++) {
2930 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
2932 TAILQ_REMOVE(&(prov
->dp_ctx_in_q
), ctx
, zd_q_entries
);
2934 TAILQ_INSERT_TAIL(listp
, ctx
, zd_q_entries
);
2941 atomic_fetch_sub_explicit(&prov
->dp_in_queued
, ret
,
2942 memory_order_relaxed
);
2944 dplane_provider_unlock(prov
);
2950 * Enqueue and maintain associated counter
2952 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider
*prov
,
2953 struct zebra_dplane_ctx
*ctx
)
2955 dplane_provider_lock(prov
);
2957 TAILQ_INSERT_TAIL(&(prov
->dp_ctx_out_q
), ctx
,
2960 dplane_provider_unlock(prov
);
2962 atomic_fetch_add_explicit(&(prov
->dp_out_counter
), 1,
2963 memory_order_relaxed
);
2967 * Accessor for provider object
2969 bool dplane_provider_is_threaded(const struct zebra_dplane_provider
*prov
)
2971 return (prov
->dp_flags
& DPLANE_PROV_FLAG_THREADED
);
2975 * Internal helper that copies information from a zebra ns object; this is
2976 * called in the zebra main pthread context as part of dplane ctx init.
2978 static void dplane_info_from_zns(struct zebra_dplane_info
*ns_info
,
2979 struct zebra_ns
*zns
)
2981 ns_info
->ns_id
= zns
->ns_id
;
2983 #if defined(HAVE_NETLINK)
2984 ns_info
->is_cmd
= true;
2985 ns_info
->nls
= zns
->netlink_dplane
;
2986 #endif /* NETLINK */
2990 * Provider api to signal that work/events are available
2991 * for the dataplane pthread.
2993 int dplane_provider_work_ready(void)
2995 /* Note that during zebra startup, we may be offered work before
2996 * the dataplane pthread (and thread-master) are ready. We want to
2997 * enqueue the work, but the event-scheduling machinery may not be
3000 if (zdplane_info
.dg_run
) {
3001 thread_add_event(zdplane_info
.dg_master
,
3002 dplane_thread_loop
, NULL
, 0,
3003 &zdplane_info
.dg_t_update
);
3010 * Enqueue a context directly to zebra main.
3012 void dplane_provider_enqueue_to_zebra(struct zebra_dplane_ctx
*ctx
)
3014 struct dplane_ctx_q temp_list
;
3016 /* Zebra's api takes a list, so we need to use a temporary list */
3017 TAILQ_INIT(&temp_list
);
3019 TAILQ_INSERT_TAIL(&temp_list
, ctx
, zd_q_entries
);
3020 (zdplane_info
.dg_results_cb
)(&temp_list
);
3024 * Kernel dataplane provider
3028 * Handler for kernel LSP updates
3030 static enum zebra_dplane_result
3031 kernel_dplane_lsp_update(struct zebra_dplane_ctx
*ctx
)
3033 enum zebra_dplane_result res
;
3035 /* Call into the synchronous kernel-facing code here */
3036 res
= kernel_lsp_update(ctx
);
3038 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3039 atomic_fetch_add_explicit(
3040 &zdplane_info
.dg_lsp_errors
, 1,
3041 memory_order_relaxed
);
3047 * Handler for kernel pseudowire updates
3049 static enum zebra_dplane_result
3050 kernel_dplane_pw_update(struct zebra_dplane_ctx
*ctx
)
3052 enum zebra_dplane_result res
;
3054 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3055 zlog_debug("Dplane pw %s: op %s af %d loc: %u rem: %u",
3056 dplane_ctx_get_ifname(ctx
),
3057 dplane_op2str(ctx
->zd_op
),
3058 dplane_ctx_get_pw_af(ctx
),
3059 dplane_ctx_get_pw_local_label(ctx
),
3060 dplane_ctx_get_pw_remote_label(ctx
));
3062 res
= kernel_pw_update(ctx
);
3064 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3065 atomic_fetch_add_explicit(
3066 &zdplane_info
.dg_pw_errors
, 1,
3067 memory_order_relaxed
);
3073 * Handler for kernel route updates
3075 static enum zebra_dplane_result
3076 kernel_dplane_route_update(struct zebra_dplane_ctx
*ctx
)
3078 enum zebra_dplane_result res
;
3080 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3081 char dest_str
[PREFIX_STRLEN
];
3083 prefix2str(dplane_ctx_get_dest(ctx
),
3084 dest_str
, sizeof(dest_str
));
3086 zlog_debug("%u:%s Dplane route update ctx %p op %s",
3087 dplane_ctx_get_vrf(ctx
), dest_str
,
3088 ctx
, dplane_op2str(dplane_ctx_get_op(ctx
)));
3091 /* Call into the synchronous kernel-facing code here */
3092 res
= kernel_route_update(ctx
);
3094 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3095 atomic_fetch_add_explicit(
3096 &zdplane_info
.dg_route_errors
, 1,
3097 memory_order_relaxed
);
3103 * Handler for kernel-facing interface address updates
3105 static enum zebra_dplane_result
3106 kernel_dplane_address_update(struct zebra_dplane_ctx
*ctx
)
3108 enum zebra_dplane_result res
;
3110 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3111 char dest_str
[PREFIX_STRLEN
];
3113 prefix2str(dplane_ctx_get_intf_addr(ctx
), dest_str
,
3116 zlog_debug("Dplane intf %s, idx %u, addr %s",
3117 dplane_op2str(dplane_ctx_get_op(ctx
)),
3118 dplane_ctx_get_ifindex(ctx
), dest_str
);
3121 res
= kernel_address_update_ctx(ctx
);
3123 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3124 atomic_fetch_add_explicit(&zdplane_info
.dg_intf_addr_errors
,
3125 1, memory_order_relaxed
);
3131 * kernel_dplane_nexthop_update() - Handler for kernel nexthop updates
3133 * @ctx: Dataplane context
3135 * Return: Dataplane result flag
3137 static enum zebra_dplane_result
3138 kernel_dplane_nexthop_update(struct zebra_dplane_ctx
*ctx
)
3140 enum zebra_dplane_result res
;
3142 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3143 zlog_debug("ID (%u) Dplane nexthop update ctx %p op %s",
3144 dplane_ctx_get_nhe_id(ctx
), ctx
,
3145 dplane_op2str(dplane_ctx_get_op(ctx
)));
3148 res
= kernel_nexthop_update(ctx
);
3150 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3151 atomic_fetch_add_explicit(&zdplane_info
.dg_nexthop_errors
, 1,
3152 memory_order_relaxed
);
3158 * Handler for kernel-facing EVPN MAC address updates
3160 static enum zebra_dplane_result
3161 kernel_dplane_mac_update(struct zebra_dplane_ctx
*ctx
)
3163 enum zebra_dplane_result res
;
3165 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3166 char buf
[ETHER_ADDR_STRLEN
];
3168 prefix_mac2str(dplane_ctx_mac_get_addr(ctx
), buf
,
3171 zlog_debug("Dplane %s, mac %s, ifindex %u",
3172 dplane_op2str(dplane_ctx_get_op(ctx
)),
3173 buf
, dplane_ctx_get_ifindex(ctx
));
3176 res
= kernel_mac_update_ctx(ctx
);
3178 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3179 atomic_fetch_add_explicit(&zdplane_info
.dg_mac_errors
,
3180 1, memory_order_relaxed
);
3186 * Handler for kernel-facing EVPN neighbor updates
3188 static enum zebra_dplane_result
3189 kernel_dplane_neigh_update(struct zebra_dplane_ctx
*ctx
)
3191 enum zebra_dplane_result res
;
3193 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
) {
3194 char buf
[PREFIX_STRLEN
];
3196 ipaddr2str(dplane_ctx_neigh_get_ipaddr(ctx
), buf
,
3199 zlog_debug("Dplane %s, ip %s, ifindex %u",
3200 dplane_op2str(dplane_ctx_get_op(ctx
)),
3201 buf
, dplane_ctx_get_ifindex(ctx
));
3204 res
= kernel_neigh_update_ctx(ctx
);
3206 if (res
!= ZEBRA_DPLANE_REQUEST_SUCCESS
)
3207 atomic_fetch_add_explicit(&zdplane_info
.dg_neigh_errors
,
3208 1, memory_order_relaxed
);
3214 * Kernel provider callback
3216 static int kernel_dplane_process_func(struct zebra_dplane_provider
*prov
)
3218 enum zebra_dplane_result res
;
3219 struct zebra_dplane_ctx
*ctx
;
3222 limit
= dplane_provider_get_work_limit(prov
);
3224 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3225 zlog_debug("dplane provider '%s': processing",
3226 dplane_provider_get_name(prov
));
3228 for (counter
= 0; counter
< limit
; counter
++) {
3230 ctx
= dplane_provider_dequeue_in_ctx(prov
);
3234 /* A previous provider plugin may have asked to skip the
3237 if (dplane_ctx_is_skip_kernel(ctx
)) {
3238 res
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
3242 /* Dispatch to appropriate kernel-facing apis */
3243 switch (dplane_ctx_get_op(ctx
)) {
3245 case DPLANE_OP_ROUTE_INSTALL
:
3246 case DPLANE_OP_ROUTE_UPDATE
:
3247 case DPLANE_OP_ROUTE_DELETE
:
3248 res
= kernel_dplane_route_update(ctx
);
3251 case DPLANE_OP_NH_INSTALL
:
3252 case DPLANE_OP_NH_UPDATE
:
3253 case DPLANE_OP_NH_DELETE
:
3254 res
= kernel_dplane_nexthop_update(ctx
);
3257 case DPLANE_OP_LSP_INSTALL
:
3258 case DPLANE_OP_LSP_UPDATE
:
3259 case DPLANE_OP_LSP_DELETE
:
3260 res
= kernel_dplane_lsp_update(ctx
);
3263 case DPLANE_OP_PW_INSTALL
:
3264 case DPLANE_OP_PW_UNINSTALL
:
3265 res
= kernel_dplane_pw_update(ctx
);
3268 case DPLANE_OP_ADDR_INSTALL
:
3269 case DPLANE_OP_ADDR_UNINSTALL
:
3270 res
= kernel_dplane_address_update(ctx
);
3273 case DPLANE_OP_MAC_INSTALL
:
3274 case DPLANE_OP_MAC_DELETE
:
3275 res
= kernel_dplane_mac_update(ctx
);
3278 case DPLANE_OP_NEIGH_INSTALL
:
3279 case DPLANE_OP_NEIGH_UPDATE
:
3280 case DPLANE_OP_NEIGH_DELETE
:
3281 case DPLANE_OP_VTEP_ADD
:
3282 case DPLANE_OP_VTEP_DELETE
:
3283 res
= kernel_dplane_neigh_update(ctx
);
3286 /* Ignore 'notifications' - no-op */
3287 case DPLANE_OP_SYS_ROUTE_ADD
:
3288 case DPLANE_OP_SYS_ROUTE_DELETE
:
3289 case DPLANE_OP_ROUTE_NOTIFY
:
3290 case DPLANE_OP_LSP_NOTIFY
:
3291 res
= ZEBRA_DPLANE_REQUEST_SUCCESS
;
3295 atomic_fetch_add_explicit(
3296 &zdplane_info
.dg_other_errors
, 1,
3297 memory_order_relaxed
);
3299 res
= ZEBRA_DPLANE_REQUEST_FAILURE
;
3304 dplane_ctx_set_status(ctx
, res
);
3306 dplane_provider_enqueue_out_ctx(prov
, ctx
);
3309 /* Ensure that we'll run the work loop again if there's still
3312 if (counter
>= limit
) {
3313 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3314 zlog_debug("dplane provider '%s' reached max updates %d",
3315 dplane_provider_get_name(prov
), counter
);
3317 atomic_fetch_add_explicit(&zdplane_info
.dg_update_yields
,
3318 1, memory_order_relaxed
);
3320 dplane_provider_work_ready();
3326 #if DPLANE_TEST_PROVIDER
3329 * Test dataplane provider plugin
3333 * Test provider process callback
3335 static int test_dplane_process_func(struct zebra_dplane_provider
*prov
)
3337 struct zebra_dplane_ctx
*ctx
;
3340 /* Just moving from 'in' queue to 'out' queue */
3342 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3343 zlog_debug("dplane provider '%s': processing",
3344 dplane_provider_get_name(prov
));
3346 limit
= dplane_provider_get_work_limit(prov
);
3348 for (counter
= 0; counter
< limit
; counter
++) {
3350 ctx
= dplane_provider_dequeue_in_ctx(prov
);
3354 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3355 zlog_debug("dplane provider '%s': op %s",
3356 dplane_provider_get_name(prov
),
3357 dplane_op2str(dplane_ctx_get_op(ctx
)));
3359 dplane_ctx_set_status(ctx
, ZEBRA_DPLANE_REQUEST_SUCCESS
);
3361 dplane_provider_enqueue_out_ctx(prov
, ctx
);
3364 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3365 zlog_debug("dplane provider '%s': processed %d",
3366 dplane_provider_get_name(prov
), counter
);
3368 /* Ensure that we'll run the work loop again if there's still
3371 if (counter
>= limit
)
3372 dplane_provider_work_ready();
3378 * Test provider shutdown/fini callback
3380 static int test_dplane_shutdown_func(struct zebra_dplane_provider
*prov
,
3383 if (IS_ZEBRA_DEBUG_DPLANE
)
3384 zlog_debug("dplane provider '%s': %sshutdown",
3385 dplane_provider_get_name(prov
),
3386 early
? "early " : "");
3390 #endif /* DPLANE_TEST_PROVIDER */
3393 * Register default kernel provider
3395 static void dplane_provider_init(void)
3399 ret
= dplane_provider_register("Kernel",
3401 DPLANE_PROV_FLAGS_DEFAULT
, NULL
,
3402 kernel_dplane_process_func
,
3407 zlog_err("Unable to register kernel dplane provider: %d",
3410 #if DPLANE_TEST_PROVIDER
3411 /* Optional test provider ... */
3412 ret
= dplane_provider_register("Test",
3413 DPLANE_PRIO_PRE_KERNEL
,
3414 DPLANE_PROV_FLAGS_DEFAULT
, NULL
,
3415 test_dplane_process_func
,
3416 test_dplane_shutdown_func
,
3417 NULL
/* data */, NULL
);
3420 zlog_err("Unable to register test dplane provider: %d",
3422 #endif /* DPLANE_TEST_PROVIDER */
3425 /* Indicates zebra shutdown/exit is in progress. Some operations may be
3426 * simplified or skipped during shutdown processing.
3428 bool dplane_is_in_shutdown(void)
3430 return zdplane_info
.dg_is_shutdown
;
3434 * Early or pre-shutdown, de-init notification api. This runs pretty
3435 * early during zebra shutdown, as a signal to stop new work and prepare
3436 * for updates generated by shutdown/cleanup activity, as zebra tries to
3437 * remove everything it's responsible for.
3438 * NB: This runs in the main zebra pthread context.
3440 void zebra_dplane_pre_finish(void)
3442 if (IS_ZEBRA_DEBUG_DPLANE
)
3443 zlog_debug("Zebra dataplane pre-fini called");
3445 zdplane_info
.dg_is_shutdown
= true;
3447 /* TODO -- Notify provider(s) of pending shutdown */
3451 * Utility to determine whether work remains enqueued within the dplane;
3452 * used during system shutdown processing.
3454 static bool dplane_work_pending(void)
3457 struct zebra_dplane_ctx
*ctx
;
3458 struct zebra_dplane_provider
*prov
;
3460 /* TODO -- just checking incoming/pending work for now, must check
3465 ctx
= TAILQ_FIRST(&zdplane_info
.dg_update_ctx_q
);
3466 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3477 dplane_provider_lock(prov
);
3479 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_in_q
));
3481 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_out_q
));
3483 dplane_provider_unlock(prov
);
3489 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3501 * Shutdown-time intermediate callback, used to determine when all pending
3502 * in-flight updates are done. If there's still work to do, reschedules itself.
3503 * If all work is done, schedules an event to the main zebra thread for
3504 * final zebra shutdown.
3505 * This runs in the dplane pthread context.
3507 static int dplane_check_shutdown_status(struct thread
*event
)
3509 if (IS_ZEBRA_DEBUG_DPLANE
)
3510 zlog_debug("Zebra dataplane shutdown status check called");
3512 if (dplane_work_pending()) {
3513 /* Reschedule dplane check on a short timer */
3514 thread_add_timer_msec(zdplane_info
.dg_master
,
3515 dplane_check_shutdown_status
,
3517 &zdplane_info
.dg_t_shutdown_check
);
3519 /* TODO - give up and stop waiting after a short time? */
3522 /* We appear to be done - schedule a final callback event
3523 * for the zebra main pthread.
3525 thread_add_event(zrouter
.master
, zebra_finalize
, NULL
, 0, NULL
);
3532 * Shutdown, de-init api. This runs pretty late during shutdown,
3533 * after zebra has tried to free/remove/uninstall all routes during shutdown.
3534 * At this point, dplane work may still remain to be done, so we can't just
3535 * blindly terminate. If there's still work to do, we'll periodically check
3536 * and when done, we'll enqueue a task to the zebra main thread for final
3537 * termination processing.
3539 * NB: This runs in the main zebra thread context.
3541 void zebra_dplane_finish(void)
3543 if (IS_ZEBRA_DEBUG_DPLANE
)
3544 zlog_debug("Zebra dataplane fini called");
3546 thread_add_event(zdplane_info
.dg_master
,
3547 dplane_check_shutdown_status
, NULL
, 0,
3548 &zdplane_info
.dg_t_shutdown_check
);
3552 * Main dataplane pthread event loop. The thread takes new incoming work
3553 * and offers it to the first provider. It then iterates through the
3554 * providers, taking complete work from each one and offering it
3555 * to the next in order. At each step, a limited number of updates are
3556 * processed during a cycle in order to provide some fairness.
3558 * This loop through the providers is only run once, so that the dataplane
3559 * pthread can look for other pending work - such as i/o work on behalf of
3562 static int dplane_thread_loop(struct thread
*event
)
3564 struct dplane_ctx_q work_list
;
3565 struct dplane_ctx_q error_list
;
3566 struct zebra_dplane_provider
*prov
;
3567 struct zebra_dplane_ctx
*ctx
, *tctx
;
3568 int limit
, counter
, error_counter
;
3569 uint64_t curr
, high
;
3571 /* Capture work limit per cycle */
3572 limit
= zdplane_info
.dg_updates_per_cycle
;
3574 /* Init temporary lists used to move contexts among providers */
3575 TAILQ_INIT(&work_list
);
3576 TAILQ_INIT(&error_list
);
3579 /* Check for zebra shutdown */
3580 if (!zdplane_info
.dg_run
)
3583 /* Dequeue some incoming work from zebra (if any) onto the temporary
3588 /* Locate initial registered provider */
3589 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3591 /* Move new work from incoming list to temp list */
3592 for (counter
= 0; counter
< limit
; counter
++) {
3593 ctx
= TAILQ_FIRST(&zdplane_info
.dg_update_ctx_q
);
3595 TAILQ_REMOVE(&zdplane_info
.dg_update_ctx_q
, ctx
,
3598 ctx
->zd_provider
= prov
->dp_id
;
3600 TAILQ_INSERT_TAIL(&work_list
, ctx
, zd_q_entries
);
3608 atomic_fetch_sub_explicit(&zdplane_info
.dg_routes_queued
, counter
,
3609 memory_order_relaxed
);
3611 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3612 zlog_debug("dplane: incoming new work counter: %d", counter
);
3614 /* Iterate through the registered providers, offering new incoming
3615 * work. If the provider has outgoing work in its queue, take that
3616 * work for the next provider
3620 /* At each iteration, the temporary work list has 'counter'
3623 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3624 zlog_debug("dplane enqueues %d new work to provider '%s'",
3625 counter
, dplane_provider_get_name(prov
));
3627 /* Capture current provider id in each context; check for
3630 TAILQ_FOREACH_SAFE(ctx
, &work_list
, zd_q_entries
, tctx
) {
3631 if (dplane_ctx_get_status(ctx
) ==
3632 ZEBRA_DPLANE_REQUEST_SUCCESS
) {
3633 ctx
->zd_provider
= prov
->dp_id
;
3636 * TODO -- improve error-handling: recirc
3637 * errors backwards so that providers can
3638 * 'undo' their work (if they want to)
3641 /* Move to error list; will be returned
3644 TAILQ_REMOVE(&work_list
, ctx
, zd_q_entries
);
3645 TAILQ_INSERT_TAIL(&error_list
,
3651 /* Enqueue new work to the provider */
3652 dplane_provider_lock(prov
);
3654 if (TAILQ_FIRST(&work_list
))
3655 TAILQ_CONCAT(&(prov
->dp_ctx_in_q
), &work_list
,
3658 atomic_fetch_add_explicit(&prov
->dp_in_counter
, counter
,
3659 memory_order_relaxed
);
3660 atomic_fetch_add_explicit(&prov
->dp_in_queued
, counter
,
3661 memory_order_relaxed
);
3662 curr
= atomic_load_explicit(&prov
->dp_in_queued
,
3663 memory_order_relaxed
);
3664 high
= atomic_load_explicit(&prov
->dp_in_max
,
3665 memory_order_relaxed
);
3667 atomic_store_explicit(&prov
->dp_in_max
, curr
,
3668 memory_order_relaxed
);
3670 dplane_provider_unlock(prov
);
3672 /* Reset the temp list (though the 'concat' may have done this
3673 * already), and the counter
3675 TAILQ_INIT(&work_list
);
3678 /* Call into the provider code. Note that this is
3679 * unconditional: we offer to do work even if we don't enqueue
3682 (*prov
->dp_fp
)(prov
);
3684 /* Check for zebra shutdown */
3685 if (!zdplane_info
.dg_run
)
3688 /* Dequeue completed work from the provider */
3689 dplane_provider_lock(prov
);
3691 while (counter
< limit
) {
3692 ctx
= TAILQ_FIRST(&(prov
->dp_ctx_out_q
));
3694 TAILQ_REMOVE(&(prov
->dp_ctx_out_q
), ctx
,
3697 TAILQ_INSERT_TAIL(&work_list
,
3704 dplane_provider_unlock(prov
);
3706 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3707 zlog_debug("dplane dequeues %d completed work from provider %s",
3708 counter
, dplane_provider_get_name(prov
));
3710 /* Locate next provider */
3712 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3716 /* After all providers have been serviced, enqueue any completed
3717 * work and any errors back to zebra so it can process the results.
3719 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
3720 zlog_debug("dplane has %d completed, %d errors, for zebra main",
3721 counter
, error_counter
);
3724 * Hand lists through the api to zebra main,
3725 * to reduce the number of lock/unlock cycles
3728 /* Call through to zebra main */
3729 (zdplane_info
.dg_results_cb
)(&error_list
);
3731 TAILQ_INIT(&error_list
);
3733 /* Call through to zebra main */
3734 (zdplane_info
.dg_results_cb
)(&work_list
);
3736 TAILQ_INIT(&work_list
);
3743 * Final phase of shutdown, after all work enqueued to dplane has been
3744 * processed. This is called from the zebra main pthread context.
3746 void zebra_dplane_shutdown(void)
3748 if (IS_ZEBRA_DEBUG_DPLANE
)
3749 zlog_debug("Zebra dataplane shutdown called");
3751 /* Stop dplane thread, if it's running */
3753 zdplane_info
.dg_run
= false;
3755 THREAD_OFF(zdplane_info
.dg_t_update
);
3757 frr_pthread_stop(zdplane_info
.dg_pthread
, NULL
);
3759 /* Destroy pthread */
3760 frr_pthread_destroy(zdplane_info
.dg_pthread
);
3761 zdplane_info
.dg_pthread
= NULL
;
3762 zdplane_info
.dg_master
= NULL
;
3764 /* TODO -- Notify provider(s) of final shutdown */
3766 /* TODO -- Clean-up provider objects */
3768 /* TODO -- Clean queue(s), free memory */
3772 * Initialize the dataplane module during startup, internal/private version
3774 static void zebra_dplane_init_internal(void)
3776 memset(&zdplane_info
, 0, sizeof(zdplane_info
));
3778 pthread_mutex_init(&zdplane_info
.dg_mutex
, NULL
);
3780 TAILQ_INIT(&zdplane_info
.dg_update_ctx_q
);
3781 TAILQ_INIT(&zdplane_info
.dg_providers_q
);
3783 zdplane_info
.dg_updates_per_cycle
= DPLANE_DEFAULT_NEW_WORK
;
3785 zdplane_info
.dg_max_queued_updates
= DPLANE_DEFAULT_MAX_QUEUED
;
3787 /* Register default kernel 'provider' during init */
3788 dplane_provider_init();
3792 * Start the dataplane pthread. This step needs to be run later than the
3793 * 'init' step, in case zebra has fork-ed.
3795 void zebra_dplane_start(void)
3797 struct zebra_dplane_provider
*prov
;
3798 struct frr_pthread_attr pattr
= {
3799 .start
= frr_pthread_attr_default
.start
,
3800 .stop
= frr_pthread_attr_default
.stop
3803 /* Start dataplane pthread */
3805 zdplane_info
.dg_pthread
= frr_pthread_new(&pattr
, "Zebra dplane thread",
3808 zdplane_info
.dg_master
= zdplane_info
.dg_pthread
->master
;
3810 zdplane_info
.dg_run
= true;
3812 /* Enqueue an initial event for the dataplane pthread */
3813 thread_add_event(zdplane_info
.dg_master
, dplane_thread_loop
, NULL
, 0,
3814 &zdplane_info
.dg_t_update
);
3816 /* Call start callbacks for registered providers */
3819 prov
= TAILQ_FIRST(&zdplane_info
.dg_providers_q
);
3825 (prov
->dp_start
)(prov
);
3827 /* Locate next provider */
3829 prov
= TAILQ_NEXT(prov
, dp_prov_link
);
3833 frr_pthread_run(zdplane_info
.dg_pthread
, NULL
);
3837 * Initialize the dataplane module at startup; called by zebra rib_init()
3839 void zebra_dplane_init(int (*results_fp
)(struct dplane_ctx_q
*))
3841 zebra_dplane_init_internal();
3842 zdplane_info
.dg_results_cb
= results_fp
;