2 * Zebra dataplane layer api interfaces.
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
20 #ifndef _ZEBRA_DPLANE_H
21 #define _ZEBRA_DPLANE_H 1
23 #include "lib/zebra.h"
24 #include "lib/prefix.h"
25 #include "lib/nexthop.h"
26 #include "lib/nexthop_group.h"
27 #include "lib/queue.h"
29 #include "zebra/zebra_ns.h"
30 #include "zebra/rib.h"
31 #include "zebra/zserv.h"
32 #include "zebra/zebra_mpls.h"
33 #include "zebra/zebra_nhg.h"
39 /* Key netlink info from zebra ns */
40 struct zebra_dplane_info
{
43 #if defined(HAVE_NETLINK)
50 /* Utility to fill in zns info from main zns struct */
52 zebra_dplane_info_from_zns(struct zebra_dplane_info
*zns_info
,
53 const struct zebra_ns
*zns
, bool is_cmd
)
55 zns_info
->ns_id
= zns
->ns_id
;
57 #if defined(HAVE_NETLINK)
58 zns_info
->is_cmd
= is_cmd
;
60 zns_info
->sock
= zns
->netlink_cmd
.sock
;
61 zns_info
->seq
= zns
->netlink_cmd
.seq
;
63 zns_info
->sock
= zns
->netlink
.sock
;
64 zns_info
->seq
= zns
->netlink
.seq
;
70 * Notify dplane when namespaces are enabled and disabled. The dplane
71 * needs to start and stop reading incoming events from the ns.
73 void zebra_dplane_ns_enable(struct zebra_ns
*zns
, bool enabled
);
76 * Result codes used when returning status back to the main zebra context.
82 * Flags being SET/UNSET do not belong in the South Bound
83 * Interface. This Setting belongs at the calling level
84 * because we can and will have multiple different interfaces
85 * and we will have potentially multiple different
86 * modules/filters to call. As such Setting/Unsetting
87 * success failure should be handled by the caller.
89 enum zebra_dplane_status
{
90 ZEBRA_DPLANE_STATUS_NONE
= 0,
91 ZEBRA_DPLANE_INSTALL_SUCCESS
,
92 ZEBRA_DPLANE_INSTALL_FAILURE
,
93 ZEBRA_DPLANE_DELETE_SUCCESS
,
94 ZEBRA_DPLANE_DELETE_FAILURE
,
98 enum zebra_dplane_result
{
99 ZEBRA_DPLANE_REQUEST_QUEUED
,
100 ZEBRA_DPLANE_REQUEST_SUCCESS
,
101 ZEBRA_DPLANE_REQUEST_FAILURE
,
105 * API between the zebra dataplane system and the main zebra processing
110 * Operations that the dataplane can process.
116 DPLANE_OP_ROUTE_INSTALL
,
117 DPLANE_OP_ROUTE_UPDATE
,
118 DPLANE_OP_ROUTE_DELETE
,
119 DPLANE_OP_ROUTE_NOTIFY
,
122 DPLANE_OP_NH_INSTALL
,
127 DPLANE_OP_LSP_INSTALL
,
128 DPLANE_OP_LSP_UPDATE
,
129 DPLANE_OP_LSP_DELETE
,
130 DPLANE_OP_LSP_NOTIFY
,
132 /* Pseudowire update */
133 DPLANE_OP_PW_INSTALL
,
134 DPLANE_OP_PW_UNINSTALL
,
136 /* System route notification */
137 DPLANE_OP_SYS_ROUTE_ADD
,
138 DPLANE_OP_SYS_ROUTE_DELETE
,
140 /* Interface address update */
141 DPLANE_OP_ADDR_INSTALL
,
142 DPLANE_OP_ADDR_UNINSTALL
,
144 /* MAC address update */
145 DPLANE_OP_MAC_INSTALL
,
146 DPLANE_OP_MAC_DELETE
,
148 /* EVPN neighbor updates */
149 DPLANE_OP_NEIGH_INSTALL
,
150 DPLANE_OP_NEIGH_UPDATE
,
151 DPLANE_OP_NEIGH_DELETE
,
153 /* EVPN VTEP updates */
155 DPLANE_OP_VTEP_DELETE
,
157 /* Policy based routing rule update */
159 DPLANE_OP_RULE_DELETE
,
160 DPLANE_OP_RULE_UPDATE
,
162 /* Link layer address discovery */
163 DPLANE_OP_NEIGH_DISCOVER
,
165 /* bridge port update */
166 DPLANE_OP_BR_PORT_UPDATE
,
168 /* Policy based routing iptable update */
169 DPLANE_OP_IPTABLE_ADD
,
170 DPLANE_OP_IPTABLE_DELETE
,
172 /* Policy based routing ipset update */
174 DPLANE_OP_IPSET_DELETE
,
175 DPLANE_OP_IPSET_ENTRY_ADD
,
176 DPLANE_OP_IPSET_ENTRY_DELETE
,
178 /* LINK LAYER IP address update */
179 DPLANE_OP_NEIGH_IP_INSTALL
,
180 DPLANE_OP_NEIGH_IP_DELETE
,
182 DPLANE_OP_NEIGH_TABLE_UPDATE
,
185 /* Incoming interface address events */
186 DPLANE_OP_INTF_ADDR_ADD
,
187 DPLANE_OP_INTF_ADDR_DEL
,
189 /* Incoming interface config events */
190 DPLANE_OP_INTF_NETCONFIG
,
192 /* Interface update */
193 DPLANE_OP_INTF_INSTALL
,
194 DPLANE_OP_INTF_UPDATE
,
195 DPLANE_OP_INTF_DELETE
,
197 /* Traffic control */
198 DPLANE_OP_TC_QDISC_INSTALL
,
199 DPLANE_OP_TC_QDISC_UNINSTALL
,
200 DPLANE_OP_TC_CLASS_ADD
,
201 DPLANE_OP_TC_CLASS_DELETE
,
202 DPLANE_OP_TC_CLASS_UPDATE
,
203 DPLANE_OP_TC_FILTER_ADD
,
204 DPLANE_OP_TC_FILTER_DELETE
,
205 DPLANE_OP_TC_FILTER_UPDATE
209 * The vxlan/evpn neighbor management code needs some values to use
210 * when programming neighbor changes. Offer some platform-neutral values
211 * here for use within the dplane apis and plugins.
214 /* Neighbor cache flags */
215 #define DPLANE_NTF_EXT_LEARNED 0x01
216 #define DPLANE_NTF_ROUTER 0x02
217 #define DPLANE_NTF_USE 0x04
219 /* Neighbor cache states */
220 #define DPLANE_NUD_REACHABLE 0x01
221 #define DPLANE_NUD_STALE 0x02
222 #define DPLANE_NUD_NOARP 0x04
223 #define DPLANE_NUD_PROBE 0x08
224 #define DPLANE_NUD_INCOMPLETE 0x10
225 #define DPLANE_NUD_PERMANENT 0x20
226 #define DPLANE_NUD_FAILED 0x40
228 /* MAC update flags - dplane_mac_info.update_flags */
229 #define DPLANE_MAC_REMOTE (1 << 0)
230 #define DPLANE_MAC_WAS_STATIC (1 << 1)
231 #define DPLANE_MAC_SET_STATIC (1 << 2)
232 #define DPLANE_MAC_SET_INACTIVE (1 << 3)
234 /* Neigh update flags - dplane_neigh_info.update_flags */
235 #define DPLANE_NEIGH_REMOTE (1 << 0)
236 #define DPLANE_NEIGH_WAS_STATIC (1 << 1)
237 #define DPLANE_NEIGH_SET_STATIC (1 << 2)
238 #define DPLANE_NEIGH_SET_INACTIVE (1 << 3)
239 #define DPLANE_NEIGH_NO_EXTENSION (1 << 4)
241 #define DPLANE_BR_PORT_NON_DF (1 << 0)
243 /* Definitions for the dplane 'netconf' apis, corresponding to the netlink
245 * Sadly, netlink sends incremental updates, so its messages may contain
246 * just a single changed attribute, and not necessarily
247 * a complete snapshot of the attributes.
249 enum dplane_netconf_status_e
{
250 DPLANE_NETCONF_STATUS_UNKNOWN
= 0,
251 DPLANE_NETCONF_STATUS_ENABLED
,
252 DPLANE_NETCONF_STATUS_DISABLED
255 /* Some special ifindex values that may be part of the dplane netconf api. */
256 #define DPLANE_NETCONF_IFINDEX_ALL -1
257 #define DPLANE_NETCONF_IFINDEX_DEFAULT -2
259 /* Enable system route notifications */
260 void dplane_enable_sys_route_notifs(void);
263 * The dataplane context struct is used to exchange info between the main zebra
264 * context and the dataplane module(s). If these are two independent pthreads,
265 * they cannot share existing global data structures safely.
268 /* Define a tailq list type for context blocks. The list is exposed/public,
269 * but the internal linkage in the context struct is private, so there
270 * are accessor apis that support enqueue and dequeue.
272 TAILQ_HEAD(dplane_ctx_q
, zebra_dplane_ctx
);
274 /* Declare a type for (optional) extended interface info objects. */
275 TAILQ_HEAD(dplane_intf_extra_q
, dplane_intf_extra
);
277 /* Allocate a context object */
278 struct zebra_dplane_ctx
*dplane_ctx_alloc(void);
281 * Reset an allocated context object for re-use. All internal allocations are
284 void dplane_ctx_reset(struct zebra_dplane_ctx
*ctx
);
287 * Allow zebra code to walk the queue of pending contexts, evaluate each one
288 * using a callback function. The caller can supply an optional void* arg also.
289 * If the function returns 'true', the context will be dequeued and freed
290 * without being processed.
292 int dplane_clean_ctx_queue(bool (*context_cb
)(struct zebra_dplane_ctx
*ctx
,
293 void *arg
), void *val
);
295 /* Return a dataplane results context block after use; the caller's pointer will
298 void dplane_ctx_fini(struct zebra_dplane_ctx
**pctx
);
300 /* Enqueue a context block to caller's tailq. This exists so that the
301 * context struct can remain opaque.
303 void dplane_ctx_enqueue_tail(struct dplane_ctx_q
*q
,
304 const struct zebra_dplane_ctx
*ctx
);
306 /* Append a list of context blocks to another list - again, just keeping
307 * the context struct opaque.
309 void dplane_ctx_list_append(struct dplane_ctx_q
*to_list
,
310 struct dplane_ctx_q
*from_list
);
312 /* Dequeue a context block from the head of caller's tailq */
313 struct zebra_dplane_ctx
*dplane_ctx_dequeue(struct dplane_ctx_q
*q
);
314 struct zebra_dplane_ctx
*dplane_ctx_get_head(struct dplane_ctx_q
*q
);
317 * Accessors for information from the context object
319 enum zebra_dplane_result
dplane_ctx_get_status(
320 const struct zebra_dplane_ctx
*ctx
);
321 void dplane_ctx_set_status(struct zebra_dplane_ctx
*ctx
,
322 enum zebra_dplane_result status
);
323 const char *dplane_res2str(enum zebra_dplane_result res
);
325 enum dplane_op_e
dplane_ctx_get_op(const struct zebra_dplane_ctx
*ctx
);
326 void dplane_ctx_set_op(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
);
327 const char *dplane_op2str(enum dplane_op_e op
);
329 const struct prefix
*dplane_ctx_get_dest(const struct zebra_dplane_ctx
*ctx
);
330 void dplane_ctx_set_dest(struct zebra_dplane_ctx
*ctx
,
331 const struct prefix
*dest
);
332 const char *dplane_ctx_get_ifname(const struct zebra_dplane_ctx
*ctx
);
333 void dplane_ctx_set_ifname(struct zebra_dplane_ctx
*ctx
, const char *ifname
);
334 ifindex_t
dplane_ctx_get_ifindex(const struct zebra_dplane_ctx
*ctx
);
335 void dplane_ctx_set_ifindex(struct zebra_dplane_ctx
*ctx
, ifindex_t ifindex
);
337 /* Retrieve last/current provider id */
338 uint32_t dplane_ctx_get_provider(const struct zebra_dplane_ctx
*ctx
);
340 /* Providers running before the kernel can control whether a kernel
341 * update should be done.
343 void dplane_ctx_set_skip_kernel(struct zebra_dplane_ctx
*ctx
);
344 bool dplane_ctx_is_skip_kernel(const struct zebra_dplane_ctx
*ctx
);
346 /* Source prefix is a little special - use convention to return NULL
347 * to mean "no src prefix"
349 const struct prefix
*dplane_ctx_get_src(const struct zebra_dplane_ctx
*ctx
);
350 void dplane_ctx_set_src(struct zebra_dplane_ctx
*ctx
, const struct prefix
*src
);
352 bool dplane_ctx_is_update(const struct zebra_dplane_ctx
*ctx
);
353 uint32_t dplane_ctx_get_seq(const struct zebra_dplane_ctx
*ctx
);
354 uint32_t dplane_ctx_get_old_seq(const struct zebra_dplane_ctx
*ctx
);
355 void dplane_ctx_set_vrf(struct zebra_dplane_ctx
*ctx
, vrf_id_t vrf
);
356 vrf_id_t
dplane_ctx_get_vrf(const struct zebra_dplane_ctx
*ctx
);
358 /* In some paths we have only a namespace id */
359 void dplane_ctx_set_ns_id(struct zebra_dplane_ctx
*ctx
, ns_id_t nsid
);
360 ns_id_t
dplane_ctx_get_ns_id(const struct zebra_dplane_ctx
*ctx
);
362 bool dplane_ctx_is_from_notif(const struct zebra_dplane_ctx
*ctx
);
363 void dplane_ctx_set_notif_provider(struct zebra_dplane_ctx
*ctx
,
365 uint32_t dplane_ctx_get_notif_provider(const struct zebra_dplane_ctx
*ctx
);
367 /* Accessors for route update information */
368 void dplane_ctx_set_type(struct zebra_dplane_ctx
*ctx
, int type
);
369 int dplane_ctx_get_type(const struct zebra_dplane_ctx
*ctx
);
370 int dplane_ctx_get_old_type(const struct zebra_dplane_ctx
*ctx
);
371 void dplane_ctx_set_afi(struct zebra_dplane_ctx
*ctx
, afi_t afi
);
372 afi_t
dplane_ctx_get_afi(const struct zebra_dplane_ctx
*ctx
);
373 void dplane_ctx_set_safi(struct zebra_dplane_ctx
*ctx
, safi_t safi
);
374 safi_t
dplane_ctx_get_safi(const struct zebra_dplane_ctx
*ctx
);
375 void dplane_ctx_set_table(struct zebra_dplane_ctx
*ctx
, uint32_t table
);
376 uint32_t dplane_ctx_get_table(const struct zebra_dplane_ctx
*ctx
);
377 route_tag_t
dplane_ctx_get_tag(const struct zebra_dplane_ctx
*ctx
);
378 void dplane_ctx_set_tag(struct zebra_dplane_ctx
*ctx
, route_tag_t tag
);
379 route_tag_t
dplane_ctx_get_old_tag(const struct zebra_dplane_ctx
*ctx
);
380 uint16_t dplane_ctx_get_instance(const struct zebra_dplane_ctx
*ctx
);
381 void dplane_ctx_set_instance(struct zebra_dplane_ctx
*ctx
, uint16_t instance
);
382 uint16_t dplane_ctx_get_old_instance(const struct zebra_dplane_ctx
*ctx
);
383 uint32_t dplane_ctx_get_metric(const struct zebra_dplane_ctx
*ctx
);
384 uint32_t dplane_ctx_get_old_metric(const struct zebra_dplane_ctx
*ctx
);
385 uint32_t dplane_ctx_get_mtu(const struct zebra_dplane_ctx
*ctx
);
386 uint32_t dplane_ctx_get_nh_mtu(const struct zebra_dplane_ctx
*ctx
);
387 uint8_t dplane_ctx_get_distance(const struct zebra_dplane_ctx
*ctx
);
388 void dplane_ctx_set_distance(struct zebra_dplane_ctx
*ctx
, uint8_t distance
);
389 uint8_t dplane_ctx_get_old_distance(const struct zebra_dplane_ctx
*ctx
);
391 /* Accessors for traffic control context */
392 int dplane_ctx_tc_qdisc_get_kind(const struct zebra_dplane_ctx
*ctx
);
394 dplane_ctx_tc_qdisc_get_kind_str(const struct zebra_dplane_ctx
*ctx
);
396 uint32_t dplane_ctx_tc_class_get_handle(const struct zebra_dplane_ctx
*ctx
);
397 int dplane_ctx_tc_class_get_kind(const struct zebra_dplane_ctx
*ctx
);
399 dplane_ctx_tc_class_get_kind_str(const struct zebra_dplane_ctx
*ctx
);
400 uint64_t dplane_ctx_tc_class_get_rate(const struct zebra_dplane_ctx
*ctx
);
401 uint64_t dplane_ctx_tc_class_get_ceil(const struct zebra_dplane_ctx
*ctx
);
403 int dplane_ctx_tc_filter_get_kind(const struct zebra_dplane_ctx
*ctx
);
405 dplane_ctx_tc_filter_get_kind_str(const struct zebra_dplane_ctx
*ctx
);
406 uint32_t dplane_ctx_tc_filter_get_priority(const struct zebra_dplane_ctx
*ctx
);
407 uint32_t dplane_ctx_tc_filter_get_handle(const struct zebra_dplane_ctx
*ctx
);
408 uint16_t dplane_ctx_tc_filter_get_minor(const struct zebra_dplane_ctx
*ctx
);
409 uint16_t dplane_ctx_tc_filter_get_eth_proto(const struct zebra_dplane_ctx
*ctx
);
410 uint32_t dplane_ctx_tc_filter_get_filter_bm(const struct zebra_dplane_ctx
*ctx
);
411 const struct prefix
*
412 dplane_ctx_tc_filter_get_src_ip(const struct zebra_dplane_ctx
*ctx
);
414 dplane_ctx_tc_filter_get_src_port_min(const struct zebra_dplane_ctx
*ctx
);
416 dplane_ctx_tc_filter_get_src_port_max(const struct zebra_dplane_ctx
*ctx
);
417 const struct prefix
*
418 dplane_ctx_tc_filter_get_dst_ip(const struct zebra_dplane_ctx
*ctx
);
420 dplane_ctx_tc_filter_get_dst_port_min(const struct zebra_dplane_ctx
*ctx
);
422 dplane_ctx_tc_filter_get_dst_port_max(const struct zebra_dplane_ctx
*ctx
);
423 uint8_t dplane_ctx_tc_filter_get_ip_proto(const struct zebra_dplane_ctx
*ctx
);
424 uint8_t dplane_ctx_tc_filter_get_dsfield(const struct zebra_dplane_ctx
*ctx
);
426 dplane_ctx_tc_filter_get_dsfield_mask(const struct zebra_dplane_ctx
*ctx
);
427 uint32_t dplane_ctx_tc_filter_get_classid(const struct zebra_dplane_ctx
*ctx
);
429 void dplane_ctx_set_nexthops(struct zebra_dplane_ctx
*ctx
, struct nexthop
*nh
);
430 void dplane_ctx_set_backup_nhg(struct zebra_dplane_ctx
*ctx
,
431 const struct nexthop_group
*nhg
);
433 uint32_t dplane_ctx_get_nhg_id(const struct zebra_dplane_ctx
*ctx
);
434 const struct nexthop_group
*dplane_ctx_get_ng(
435 const struct zebra_dplane_ctx
*ctx
);
436 const struct nexthop_group
*dplane_ctx_get_old_ng(
437 const struct zebra_dplane_ctx
*ctx
);
439 /* Optional extra info about interfaces in nexthops - a plugin must enable
442 const struct dplane_intf_extra
*
443 dplane_ctx_get_intf_extra(const struct zebra_dplane_ctx
*ctx
);
445 const struct dplane_intf_extra
*
446 dplane_ctx_intf_extra_next(const struct zebra_dplane_ctx
*ctx
,
447 const struct dplane_intf_extra
*ptr
);
449 vrf_id_t
dplane_intf_extra_get_vrfid(const struct dplane_intf_extra
*ptr
);
450 uint32_t dplane_intf_extra_get_ifindex(const struct dplane_intf_extra
*ptr
);
451 uint32_t dplane_intf_extra_get_flags(const struct dplane_intf_extra
*ptr
);
452 uint32_t dplane_intf_extra_get_status(const struct dplane_intf_extra
*ptr
);
454 /* Backup nexthop information (list of nexthops) if present. */
455 const struct nexthop_group
*
456 dplane_ctx_get_backup_ng(const struct zebra_dplane_ctx
*ctx
);
457 const struct nexthop_group
*
458 dplane_ctx_get_old_backup_ng(const struct zebra_dplane_ctx
*ctx
);
460 /* Accessors for nexthop information */
461 uint32_t dplane_ctx_get_nhe_id(const struct zebra_dplane_ctx
*ctx
);
462 uint32_t dplane_ctx_get_old_nhe_id(const struct zebra_dplane_ctx
*ctx
);
463 afi_t
dplane_ctx_get_nhe_afi(const struct zebra_dplane_ctx
*ctx
);
464 vrf_id_t
dplane_ctx_get_nhe_vrf_id(const struct zebra_dplane_ctx
*ctx
);
465 int dplane_ctx_get_nhe_type(const struct zebra_dplane_ctx
*ctx
);
466 const struct nexthop_group
*
467 dplane_ctx_get_nhe_ng(const struct zebra_dplane_ctx
*ctx
);
468 const struct nh_grp
*
469 dplane_ctx_get_nhe_nh_grp(const struct zebra_dplane_ctx
*ctx
);
470 uint8_t dplane_ctx_get_nhe_nh_grp_count(const struct zebra_dplane_ctx
*ctx
);
472 /* Accessors for LSP information */
474 /* Init the internal LSP data struct - necessary before adding to it.
475 * If 'lsp' is non-NULL, info will be copied from it to the internal
478 int dplane_ctx_lsp_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
479 struct zebra_lsp
*lsp
);
481 mpls_label_t
dplane_ctx_get_in_label(const struct zebra_dplane_ctx
*ctx
);
482 void dplane_ctx_set_in_label(struct zebra_dplane_ctx
*ctx
,
484 uint8_t dplane_ctx_get_addr_family(const struct zebra_dplane_ctx
*ctx
);
485 void dplane_ctx_set_addr_family(struct zebra_dplane_ctx
*ctx
,
487 uint32_t dplane_ctx_get_lsp_flags(const struct zebra_dplane_ctx
*ctx
);
488 void dplane_ctx_set_lsp_flags(struct zebra_dplane_ctx
*ctx
,
490 const struct nhlfe_list_head
*dplane_ctx_get_nhlfe_list(
491 const struct zebra_dplane_ctx
*ctx
);
492 const struct nhlfe_list_head
*dplane_ctx_get_backup_nhlfe_list(
493 const struct zebra_dplane_ctx
*ctx
);
495 struct zebra_nhlfe
*dplane_ctx_add_nhlfe(struct zebra_dplane_ctx
*ctx
,
496 enum lsp_types_t lsp_type
,
497 enum nexthop_types_t nh_type
,
498 const union g_addr
*gate
,
499 ifindex_t ifindex
, uint8_t num_labels
,
500 mpls_label_t
*out_labels
);
502 struct zebra_nhlfe
*dplane_ctx_add_backup_nhlfe(
503 struct zebra_dplane_ctx
*ctx
, enum lsp_types_t lsp_type
,
504 enum nexthop_types_t nh_type
, const union g_addr
*gate
,
505 ifindex_t ifindex
, uint8_t num_labels
, mpls_label_t
*out_labels
);
507 const struct zebra_nhlfe
*
508 dplane_ctx_get_best_nhlfe(const struct zebra_dplane_ctx
*ctx
);
509 const struct zebra_nhlfe
*
510 dplane_ctx_set_best_nhlfe(struct zebra_dplane_ctx
*ctx
,
511 struct zebra_nhlfe
*nhlfe
);
512 uint32_t dplane_ctx_get_lsp_num_ecmp(const struct zebra_dplane_ctx
*ctx
);
514 /* Accessors for pseudowire information */
515 mpls_label_t
dplane_ctx_get_pw_local_label(const struct zebra_dplane_ctx
*ctx
);
516 mpls_label_t
dplane_ctx_get_pw_remote_label(const struct zebra_dplane_ctx
*ctx
);
517 int dplane_ctx_get_pw_type(const struct zebra_dplane_ctx
*ctx
);
518 int dplane_ctx_get_pw_af(const struct zebra_dplane_ctx
*ctx
);
519 uint32_t dplane_ctx_get_pw_flags(const struct zebra_dplane_ctx
*ctx
);
520 int dplane_ctx_get_pw_status(const struct zebra_dplane_ctx
*ctx
);
521 void dplane_ctx_set_pw_status(struct zebra_dplane_ctx
*ctx
, int status
);
522 const union g_addr
*dplane_ctx_get_pw_dest(
523 const struct zebra_dplane_ctx
*ctx
);
524 const union pw_protocol_fields
*dplane_ctx_get_pw_proto(
525 const struct zebra_dplane_ctx
*ctx
);
526 const struct nexthop_group
*dplane_ctx_get_pw_nhg(
527 const struct zebra_dplane_ctx
*ctx
);
528 const struct nexthop_group
*
529 dplane_ctx_get_pw_primary_nhg(const struct zebra_dplane_ctx
*ctx
);
530 const struct nexthop_group
*
531 dplane_ctx_get_pw_backup_nhg(const struct zebra_dplane_ctx
*ctx
);
533 /* Accessors for interface information */
534 uint32_t dplane_ctx_get_intf_metric(const struct zebra_dplane_ctx
*ctx
);
535 void dplane_ctx_set_intf_metric(struct zebra_dplane_ctx
*ctx
, uint32_t metric
);
536 uint32_t dplane_ctx_get_intf_pd_reason_val(const struct zebra_dplane_ctx
*ctx
);
537 void dplane_ctx_set_intf_pd_reason_val(struct zebra_dplane_ctx
*ctx
, bool val
);
538 bool dplane_ctx_intf_is_protodown(const struct zebra_dplane_ctx
*ctx
);
539 /* Is interface addr p2p? */
540 bool dplane_ctx_intf_is_connected(const struct zebra_dplane_ctx
*ctx
);
541 void dplane_ctx_intf_set_connected(struct zebra_dplane_ctx
*ctx
);
542 bool dplane_ctx_intf_is_secondary(const struct zebra_dplane_ctx
*ctx
);
543 void dplane_ctx_intf_set_secondary(struct zebra_dplane_ctx
*ctx
);
544 bool dplane_ctx_intf_is_broadcast(const struct zebra_dplane_ctx
*ctx
);
545 void dplane_ctx_intf_set_broadcast(struct zebra_dplane_ctx
*ctx
);
546 const struct prefix
*dplane_ctx_get_intf_addr(
547 const struct zebra_dplane_ctx
*ctx
);
548 void dplane_ctx_set_intf_addr(struct zebra_dplane_ctx
*ctx
,
549 const struct prefix
*p
);
550 bool dplane_ctx_intf_has_dest(const struct zebra_dplane_ctx
*ctx
);
551 const struct prefix
*dplane_ctx_get_intf_dest(
552 const struct zebra_dplane_ctx
*ctx
);
553 void dplane_ctx_set_intf_dest(struct zebra_dplane_ctx
*ctx
,
554 const struct prefix
*p
);
555 bool dplane_ctx_intf_has_label(const struct zebra_dplane_ctx
*ctx
);
556 const char *dplane_ctx_get_intf_label(const struct zebra_dplane_ctx
*ctx
);
557 void dplane_ctx_set_intf_label(struct zebra_dplane_ctx
*ctx
, const char *label
);
559 /* Accessors for MAC information */
560 vlanid_t
dplane_ctx_mac_get_vlan(const struct zebra_dplane_ctx
*ctx
);
561 bool dplane_ctx_mac_is_sticky(const struct zebra_dplane_ctx
*ctx
);
562 uint32_t dplane_ctx_mac_get_update_flags(const struct zebra_dplane_ctx
*ctx
);
563 uint32_t dplane_ctx_mac_get_nhg_id(const struct zebra_dplane_ctx
*ctx
);
564 const struct ethaddr
*dplane_ctx_mac_get_addr(
565 const struct zebra_dplane_ctx
*ctx
);
566 const struct in_addr
*dplane_ctx_mac_get_vtep_ip(
567 const struct zebra_dplane_ctx
*ctx
);
568 ifindex_t
dplane_ctx_mac_get_br_ifindex(const struct zebra_dplane_ctx
*ctx
);
570 /* Accessors for neighbor information */
571 const struct ipaddr
*dplane_ctx_neigh_get_ipaddr(
572 const struct zebra_dplane_ctx
*ctx
);
573 const struct ethaddr
*dplane_ctx_neigh_get_mac(
574 const struct zebra_dplane_ctx
*ctx
);
575 const struct ipaddr
*
576 dplane_ctx_neigh_get_link_ip(const struct zebra_dplane_ctx
*ctx
);
577 uint32_t dplane_ctx_neigh_get_flags(const struct zebra_dplane_ctx
*ctx
);
578 uint16_t dplane_ctx_neigh_get_state(const struct zebra_dplane_ctx
*ctx
);
579 uint32_t dplane_ctx_neigh_get_update_flags(const struct zebra_dplane_ctx
*ctx
);
581 /* Accessors for policy based routing rule information */
582 int dplane_ctx_rule_get_sock(const struct zebra_dplane_ctx
*ctx
);
583 int dplane_ctx_rule_get_unique(const struct zebra_dplane_ctx
*ctx
);
584 int dplane_ctx_rule_get_seq(const struct zebra_dplane_ctx
*ctx
);
585 const char *dplane_ctx_rule_get_ifname(const struct zebra_dplane_ctx
*ctx
);
586 uint32_t dplane_ctx_rule_get_priority(const struct zebra_dplane_ctx
*ctx
);
587 uint32_t dplane_ctx_rule_get_old_priority(const struct zebra_dplane_ctx
*ctx
);
588 uint32_t dplane_ctx_rule_get_table(const struct zebra_dplane_ctx
*ctx
);
589 uint32_t dplane_ctx_rule_get_old_table(const struct zebra_dplane_ctx
*ctx
);
590 uint32_t dplane_ctx_rule_get_filter_bm(const struct zebra_dplane_ctx
*ctx
);
591 uint32_t dplane_ctx_rule_get_old_filter_bm(const struct zebra_dplane_ctx
*ctx
);
592 uint32_t dplane_ctx_rule_get_fwmark(const struct zebra_dplane_ctx
*ctx
);
593 uint32_t dplane_ctx_rule_get_old_fwmark(const struct zebra_dplane_ctx
*ctx
);
594 uint8_t dplane_ctx_rule_get_dsfield(const struct zebra_dplane_ctx
*ctx
);
595 uint8_t dplane_ctx_rule_get_old_dsfield(const struct zebra_dplane_ctx
*ctx
);
596 uint8_t dplane_ctx_rule_get_ipproto(const struct zebra_dplane_ctx
*ctx
);
597 uint8_t dplane_ctx_rule_get_old_ipproto(const struct zebra_dplane_ctx
*ctx
);
598 uint16_t dplane_ctx_rule_get_src_port(const struct zebra_dplane_ctx
*ctx
);
599 uint16_t dplane_ctx_rule_get_old_src_port(const struct zebra_dplane_ctx
*ctx
);
600 uint16_t dplane_ctx_rule_get_dst_port(const struct zebra_dplane_ctx
*ctx
);
601 uint16_t dplane_ctx_rule_get_old_dst_port(const struct zebra_dplane_ctx
*ctx
);
602 const struct prefix
*
603 dplane_ctx_rule_get_src_ip(const struct zebra_dplane_ctx
*ctx
);
604 const struct prefix
*
605 dplane_ctx_rule_get_old_src_ip(const struct zebra_dplane_ctx
*ctx
);
606 const struct prefix
*
607 dplane_ctx_rule_get_dst_ip(const struct zebra_dplane_ctx
*ctx
);
608 const struct prefix
*
609 dplane_ctx_rule_get_old_dst_ip(const struct zebra_dplane_ctx
*ctx
);
610 const struct ethaddr
*
611 dplane_ctx_rule_get_smac(const struct zebra_dplane_ctx
*ctx
);
612 const struct ethaddr
*
613 dplane_ctx_rule_get_dmac(const struct zebra_dplane_ctx
*ctx
);
614 int dplane_ctx_rule_get_out_ifindex(const struct zebra_dplane_ctx
*ctx
);
615 intptr_t dplane_ctx_rule_get_dp_flow_ptr(const struct zebra_dplane_ctx
*ctx
);
617 dplane_ctx_rule_get_old_dp_flow_ptr(const struct zebra_dplane_ctx
*ctx
);
618 void dplane_ctx_rule_set_dp_flow_ptr(struct zebra_dplane_ctx
*ctx
,
619 intptr_t dp_flow_ptr
);
620 /* Accessors for policy based routing iptable information */
621 struct zebra_pbr_iptable
;
622 void dplane_ctx_get_pbr_iptable(const struct zebra_dplane_ctx
*ctx
,
623 struct zebra_pbr_iptable
*table
);
624 struct zebra_pbr_ipset
;
625 void dplane_ctx_get_pbr_ipset(const struct zebra_dplane_ctx
*ctx
,
626 struct zebra_pbr_ipset
*ipset
);
627 struct zebra_pbr_ipset_entry
;
628 void dplane_ctx_get_pbr_ipset_entry(const struct zebra_dplane_ctx
*ctx
,
629 struct zebra_pbr_ipset_entry
*entry
);
630 /* Accessors for bridge port information */
631 uint32_t dplane_ctx_get_br_port_flags(const struct zebra_dplane_ctx
*ctx
);
633 dplane_ctx_get_br_port_sph_filter_cnt(const struct zebra_dplane_ctx
*ctx
);
634 const struct in_addr
*
635 dplane_ctx_get_br_port_sph_filters(const struct zebra_dplane_ctx
*ctx
);
637 dplane_ctx_get_br_port_backup_nhg_id(const struct zebra_dplane_ctx
*ctx
);
639 /* Accessors for neighbor table information */
640 uint8_t dplane_ctx_neightable_get_family(const struct zebra_dplane_ctx
*ctx
);
642 dplane_ctx_neightable_get_app_probes(const struct zebra_dplane_ctx
*ctx
);
644 dplane_ctx_neightable_get_mcast_probes(const struct zebra_dplane_ctx
*ctx
);
646 dplane_ctx_neightable_get_ucast_probes(const struct zebra_dplane_ctx
*ctx
);
648 /* Accessor for GRE set */
650 dplane_ctx_gre_get_link_ifindex(const struct zebra_dplane_ctx
*ctx
);
652 dplane_ctx_gre_get_mtu(const struct zebra_dplane_ctx
*ctx
);
653 const struct zebra_l2info_gre
*
654 dplane_ctx_gre_get_info(const struct zebra_dplane_ctx
*ctx
);
656 /* Interface netconf info */
657 enum dplane_netconf_status_e
658 dplane_ctx_get_netconf_mpls(const struct zebra_dplane_ctx
*ctx
);
659 enum dplane_netconf_status_e
660 dplane_ctx_get_netconf_mcast(const struct zebra_dplane_ctx
*ctx
);
661 enum dplane_netconf_status_e
662 dplane_ctx_get_netconf_linkdown(const struct zebra_dplane_ctx
*ctx
);
664 void dplane_ctx_set_netconf_mpls(struct zebra_dplane_ctx
*ctx
,
665 enum dplane_netconf_status_e val
);
666 void dplane_ctx_set_netconf_mcast(struct zebra_dplane_ctx
*ctx
,
667 enum dplane_netconf_status_e val
);
668 void dplane_ctx_set_netconf_linkdown(struct zebra_dplane_ctx
*ctx
,
669 enum dplane_netconf_status_e val
);
671 /* Namespace fd info - esp. for netlink communication */
672 const struct zebra_dplane_info
*dplane_ctx_get_ns(
673 const struct zebra_dplane_ctx
*ctx
);
674 int dplane_ctx_get_ns_sock(const struct zebra_dplane_ctx
*ctx
);
676 /* Indicates zebra shutdown/exit is in progress. Some operations may be
677 * simplified or skipped during shutdown processing.
679 bool dplane_is_in_shutdown(void);
682 * Enqueue route change operations for the dataplane.
684 enum zebra_dplane_result
dplane_route_add(struct route_node
*rn
,
685 struct route_entry
*re
);
687 enum zebra_dplane_result
dplane_route_update(struct route_node
*rn
,
688 struct route_entry
*re
,
689 struct route_entry
*old_re
);
691 enum zebra_dplane_result
dplane_route_delete(struct route_node
*rn
,
692 struct route_entry
*re
);
694 /* Notify the dplane when system/connected routes change */
695 enum zebra_dplane_result
dplane_sys_route_add(struct route_node
*rn
,
696 struct route_entry
*re
);
697 enum zebra_dplane_result
dplane_sys_route_del(struct route_node
*rn
,
698 struct route_entry
*re
);
700 /* Update from an async notification, to bring other fibs up-to-date */
701 enum zebra_dplane_result
dplane_route_notif_update(
702 struct route_node
*rn
,
703 struct route_entry
*re
,
705 struct zebra_dplane_ctx
*ctx
);
708 * Enqueue bridge port changes for the dataplane.
710 enum zebra_dplane_result
dplane_br_port_update(
711 const struct interface
*ifp
, bool non_df
, uint32_t sph_filter_cnt
,
712 const struct in_addr
*sph_filters
, uint32_t backup_nhg_id
);
714 /* Forward ref of nhg_hash_entry */
715 struct nhg_hash_entry
;
717 * Enqueue a nexthop change operation for the dataplane.
719 enum zebra_dplane_result
dplane_nexthop_add(struct nhg_hash_entry
*nhe
);
720 enum zebra_dplane_result
dplane_nexthop_update(struct nhg_hash_entry
*nhe
);
721 enum zebra_dplane_result
dplane_nexthop_delete(struct nhg_hash_entry
*nhe
);
724 * Enqueue LSP change operations for the dataplane.
726 enum zebra_dplane_result
dplane_lsp_add(struct zebra_lsp
*lsp
);
727 enum zebra_dplane_result
dplane_lsp_update(struct zebra_lsp
*lsp
);
728 enum zebra_dplane_result
dplane_lsp_delete(struct zebra_lsp
*lsp
);
730 /* Update or un-install resulting from an async notification */
731 enum zebra_dplane_result
dplane_lsp_notif_update(struct zebra_lsp
*lsp
,
733 struct zebra_dplane_ctx
*ctx
);
736 * Enqueue pseudowire operations for the dataplane.
738 enum zebra_dplane_result
dplane_pw_install(struct zebra_pw
*pw
);
739 enum zebra_dplane_result
dplane_pw_uninstall(struct zebra_pw
*pw
);
741 enum zebra_dplane_result
742 dplane_intf_mpls_modify_state(const struct interface
*ifp
, const bool set
);
744 * Enqueue interface address changes for the dataplane.
746 enum zebra_dplane_result
dplane_intf_addr_set(const struct interface
*ifp
,
747 const struct connected
*ifc
);
748 enum zebra_dplane_result
dplane_intf_addr_unset(const struct interface
*ifp
,
749 const struct connected
*ifc
);
752 * Enqueue interface link changes for the dataplane.
754 enum zebra_dplane_result
dplane_intf_add(const struct interface
*ifp
);
755 enum zebra_dplane_result
dplane_intf_update(const struct interface
*ifp
);
756 enum zebra_dplane_result
dplane_intf_delete(const struct interface
*ifp
);
759 * Enqueue tc link changes for the dataplane.
762 struct zebra_tc_qdisc
;
763 struct zebra_tc_class
;
764 struct zebra_tc_filter
;
765 enum zebra_dplane_result
dplane_tc_qdisc_install(struct zebra_tc_qdisc
*qdisc
);
766 enum zebra_dplane_result
767 dplane_tc_qdisc_uninstall(struct zebra_tc_qdisc
*qdisc
);
768 enum zebra_dplane_result
dplane_tc_class_add(struct zebra_tc_class
*class);
769 enum zebra_dplane_result
dplane_tc_class_delete(struct zebra_tc_class
*class);
770 enum zebra_dplane_result
dplane_tc_class_update(struct zebra_tc_class
*class);
771 enum zebra_dplane_result
dplane_tc_filter_add(struct zebra_tc_filter
*filter
);
772 enum zebra_dplane_result
773 dplane_tc_filter_delete(struct zebra_tc_filter
*filter
);
774 enum zebra_dplane_result
775 dplane_tc_filter_update(struct zebra_tc_filter
*filter
);
778 * Link layer operations for the dataplane.
780 enum zebra_dplane_result
dplane_neigh_ip_update(enum dplane_op_e op
,
781 const struct interface
*ifp
,
782 struct ipaddr
*link_ip
,
788 * Enqueue evpn mac operations for the dataplane.
790 enum zebra_dplane_result
dplane_rem_mac_add(const struct interface
*ifp
,
791 const struct interface
*bridge_ifp
,
793 const struct ethaddr
*mac
,
794 struct in_addr vtep_ip
,
799 enum zebra_dplane_result
dplane_local_mac_add(const struct interface
*ifp
,
800 const struct interface
*bridge_ifp
,
802 const struct ethaddr
*mac
,
805 uint32_t set_inactive
);
807 enum zebra_dplane_result
808 dplane_local_mac_del(const struct interface
*ifp
,
809 const struct interface
*bridge_ifp
, vlanid_t vid
,
810 const struct ethaddr
*mac
);
812 enum zebra_dplane_result
dplane_rem_mac_del(const struct interface
*ifp
,
813 const struct interface
*bridge_ifp
,
815 const struct ethaddr
*mac
,
816 struct in_addr vtep_ip
);
818 /* Helper api to init an empty or new context for a MAC update */
819 void dplane_mac_init(struct zebra_dplane_ctx
*ctx
,
820 const struct interface
*ifp
,
821 const struct interface
*br_ifp
,
823 const struct ethaddr
*mac
,
824 struct in_addr vtep_ip
,
826 uint32_t nhg_id
, uint32_t update_flags
);
829 * Enqueue evpn neighbor updates for the dataplane.
831 enum zebra_dplane_result
dplane_rem_neigh_add(const struct interface
*ifp
,
832 const struct ipaddr
*ip
,
833 const struct ethaddr
*mac
,
834 uint32_t flags
, bool was_static
);
835 enum zebra_dplane_result
dplane_local_neigh_add(const struct interface
*ifp
,
836 const struct ipaddr
*ip
,
837 const struct ethaddr
*mac
,
838 bool set_router
, bool set_static
,
840 enum zebra_dplane_result
dplane_rem_neigh_delete(const struct interface
*ifp
,
841 const struct ipaddr
*ip
);
844 * Enqueue evpn VTEP updates for the dataplane.
846 enum zebra_dplane_result
dplane_vtep_add(const struct interface
*ifp
,
847 const struct in_addr
*ip
,
849 enum zebra_dplane_result
dplane_vtep_delete(const struct interface
*ifp
,
850 const struct in_addr
*ip
,
854 * Enqueue a neighbour discovery request for the dataplane.
856 enum zebra_dplane_result
dplane_neigh_discover(const struct interface
*ifp
,
857 const struct ipaddr
*ip
);
860 * Enqueue a neighbor table parameter set
862 enum zebra_dplane_result
dplane_neigh_table_update(const struct interface
*ifp
,
863 const uint8_t family
,
864 const uint32_t app_probes
,
865 const uint32_t ucast_probes
,
866 const uint32_t mcast_probes
);
871 enum zebra_dplane_result
872 dplane_gre_set(struct interface
*ifp
, struct interface
*ifp_link
,
873 unsigned int mtu
, const struct zebra_l2info_gre
*gre_info
);
875 /* Forward ref of zebra_pbr_rule */
876 struct zebra_pbr_rule
;
879 * Enqueue policy based routing rule for the dataplane.
880 * It is possible that the user-defined sequence number and the one in the
881 * forwarding plane may not coincide, hence the API requires a separate
882 * rule priority - maps to preference/FRA_PRIORITY on Linux.
884 enum zebra_dplane_result
dplane_pbr_rule_add(struct zebra_pbr_rule
*rule
);
885 enum zebra_dplane_result
dplane_pbr_rule_delete(struct zebra_pbr_rule
*rule
);
886 enum zebra_dplane_result
887 dplane_pbr_rule_update(struct zebra_pbr_rule
*old_rule
,
888 struct zebra_pbr_rule
*new_rule
);
890 enum zebra_dplane_result
891 dplane_pbr_iptable_add(struct zebra_pbr_iptable
*iptable
);
892 enum zebra_dplane_result
893 dplane_pbr_iptable_delete(struct zebra_pbr_iptable
*iptable
);
896 struct zebra_pbr_ipset
;
897 enum zebra_dplane_result
dplane_pbr_ipset_add(struct zebra_pbr_ipset
*ipset
);
898 enum zebra_dplane_result
dplane_pbr_ipset_delete(struct zebra_pbr_ipset
*ipset
);
901 struct zebra_pbr_ipset_entry
;
902 enum zebra_dplane_result
903 dplane_pbr_ipset_entry_add(struct zebra_pbr_ipset_entry
*ipset
);
904 enum zebra_dplane_result
905 dplane_pbr_ipset_entry_delete(struct zebra_pbr_ipset_entry
*ipset
);
907 /* Encode route information into data plane context. */
908 int dplane_ctx_route_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
909 struct route_node
*rn
, struct route_entry
*re
);
911 /* Encode next hop information into data plane context. */
912 int dplane_ctx_nexthop_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
913 struct nhg_hash_entry
*nhe
);
915 /* Encode interface information into data plane context. */
916 int dplane_ctx_intf_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
917 const struct interface
*ifp
);
919 /* Encode traffic control information into data plane context. */
920 int dplane_ctx_tc_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
);
922 /* Retrieve the limit on the number of pending, unprocessed updates. */
923 uint32_t dplane_get_in_queue_limit(void);
925 /* Configure limit on the number of pending, queued updates. If 'unset', reset
928 void dplane_set_in_queue_limit(uint32_t limit
, bool set
);
930 /* Retrieve the current queue depth of incoming, unprocessed updates */
931 uint32_t dplane_get_in_queue_len(void);
936 int dplane_show_helper(struct vty
*vty
, bool detailed
);
937 int dplane_show_provs_helper(struct vty
*vty
, bool detailed
);
938 int dplane_config_write_helper(struct vty
*vty
);
941 * Dataplane providers: modules that process or consume dataplane events.
944 struct zebra_dplane_provider
;
946 /* Support string name for a dataplane provider */
947 #define DPLANE_PROVIDER_NAMELEN 64
949 /* Priority or ordering values for providers. The idea is that there may be
950 * some pre-processing, followed by an external or remote dataplane,
951 * followed by the kernel, followed by some post-processing step (such as
952 * the fpm output stream.)
954 enum dplane_provider_prio
{
955 DPLANE_PRIO_NONE
= 0,
956 DPLANE_PRIO_PREPROCESS
,
957 DPLANE_PRIO_PRE_KERNEL
,
959 DPLANE_PRIO_POSTPROCESS
,
963 /* Flags values used during provider registration. */
964 #define DPLANE_PROV_FLAGS_DEFAULT 0x0
966 /* Provider will be spawning its own worker thread */
967 #define DPLANE_PROV_FLAG_THREADED 0x1
969 /* Provider registration: ordering or priority value, callbacks, and optional
970 * opaque data value. If 'prov_p', return the newly-allocated provider object
974 /* Providers offer an entry-point for incoming work, called in the context of
975 * the dataplane pthread. The dataplane pthread enqueues any new work to the
976 * provider's 'inbound' queue, then calls the callback. The dataplane
977 * then checks the provider's outbound queue for completed work.
981 * Providers can offer a 'start' callback; if present, the dataplane will
982 * call it when it is starting - when its pthread and event-scheduling
983 * thread_master are available.
986 /* Providers can offer an entry-point for shutdown and cleanup. This is called
987 * with 'early' during shutdown, to indicate that the dataplane subsystem
988 * is allowing work to move through the providers and finish.
989 * When called without 'early', the provider should release
990 * all resources (if it has any allocated).
992 int dplane_provider_register(const char *name
,
993 enum dplane_provider_prio prio
,
995 int (*start_fp
)(struct zebra_dplane_provider
*),
996 int (*fp
)(struct zebra_dplane_provider
*),
997 int (*fini_fp
)(struct zebra_dplane_provider
*,
1000 struct zebra_dplane_provider
**prov_p
);
1002 /* Accessors for provider attributes */
1003 const char *dplane_provider_get_name(const struct zebra_dplane_provider
*prov
);
1004 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider
*prov
);
1005 void *dplane_provider_get_data(const struct zebra_dplane_provider
*prov
);
1006 bool dplane_provider_is_threaded(const struct zebra_dplane_provider
*prov
);
1008 /* Lock/unlock a provider's mutex - iff the provider was registered with
1009 * the THREADED flag.
1011 void dplane_provider_lock(struct zebra_dplane_provider
*prov
);
1012 void dplane_provider_unlock(struct zebra_dplane_provider
*prov
);
1014 /* Obtain thread_master for dataplane thread */
1015 struct thread_master
*dplane_get_thread_master(void);
1017 /* Providers should (generally) limit number of updates per work cycle */
1018 int dplane_provider_get_work_limit(const struct zebra_dplane_provider
*prov
);
1020 /* Provider api to signal that work/events are available
1021 * for the dataplane pthread.
1023 int dplane_provider_work_ready(void);
1025 /* Dequeue, maintain associated counter and locking */
1026 struct zebra_dplane_ctx
*dplane_provider_dequeue_in_ctx(
1027 struct zebra_dplane_provider
*prov
);
1029 /* Dequeue work to a list, maintain counter and locking, return count */
1030 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider
*prov
,
1031 struct dplane_ctx_q
*listp
);
1033 /* Current completed work queue length */
1034 uint32_t dplane_provider_out_ctx_queue_len(struct zebra_dplane_provider
*prov
);
1036 /* Enqueue completed work, maintain associated counter and locking */
1037 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider
*prov
,
1038 struct zebra_dplane_ctx
*ctx
);
1040 /* Enqueue a context directly to zebra main. */
1041 void dplane_provider_enqueue_to_zebra(struct zebra_dplane_ctx
*ctx
);
1043 /* Enable collection of extra info about interfaces in route updates;
1044 * this allows a provider/plugin to see some extra info in route update
1047 void dplane_enable_intf_extra_info(void);
1050 * Initialize the dataplane modules at zebra startup. This is currently called
1051 * by the rib module. Zebra registers a results callback with the dataplane.
1052 * The callback is called in the dataplane pthread context,
1053 * so the expectation is that the contexts are queued for the zebra
1056 void zebra_dplane_init(int (*) (struct dplane_ctx_q
*));
1059 * Start the dataplane pthread. This step needs to be run later than the
1060 * 'init' step, in case zebra has fork-ed.
1062 void zebra_dplane_start(void);
1064 /* Finalize/cleanup apis, one called early as shutdown is starting,
1065 * one called late at the end of zebra shutdown, and then one called
1066 * from the zebra main pthread to stop the dplane pthread and
1067 * free all resources.
1069 * Zebra expects to try to clean up all vrfs and all routes during
1070 * shutdown, so the dplane must be available until very late.
1072 void zebra_dplane_pre_finish(void);
1073 void zebra_dplane_finish(void);
1074 void zebra_dplane_shutdown(void);
1080 #endif /* _ZEBRA_DPLANE_H */