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"
28 #include "zebra/zebra_ns.h"
29 #include "zebra/rib.h"
30 #include "zebra/zserv.h"
31 #include "zebra/zebra_mpls.h"
32 #include "zebra/zebra_nhg.h"
38 /* Key netlink info from zebra ns */
39 struct zebra_dplane_info
{
42 #if defined(HAVE_NETLINK)
49 /* Utility to fill in zns info from main zns struct */
51 zebra_dplane_info_from_zns(struct zebra_dplane_info
*zns_info
,
52 const struct zebra_ns
*zns
, bool is_cmd
)
54 zns_info
->ns_id
= zns
->ns_id
;
56 #if defined(HAVE_NETLINK)
57 zns_info
->is_cmd
= is_cmd
;
59 zns_info
->sock
= zns
->netlink_cmd
.sock
;
60 zns_info
->seq
= zns
->netlink_cmd
.seq
;
62 zns_info
->sock
= zns
->netlink
.sock
;
63 zns_info
->seq
= zns
->netlink
.seq
;
69 * Notify dplane when namespaces are enabled and disabled. The dplane
70 * needs to start and stop reading incoming events from the ns.
72 void zebra_dplane_ns_enable(struct zebra_ns
*zns
, bool enabled
);
75 * Result codes used when returning status back to the main zebra context.
81 * Flags being SET/UNSET do not belong in the South Bound
82 * Interface. This Setting belongs at the calling level
83 * because we can and will have multiple different interfaces
84 * and we will have potentially multiple different
85 * modules/filters to call. As such Setting/Unsetting
86 * success failure should be handled by the caller.
88 enum zebra_dplane_status
{
89 ZEBRA_DPLANE_STATUS_NONE
= 0,
90 ZEBRA_DPLANE_INSTALL_SUCCESS
,
91 ZEBRA_DPLANE_INSTALL_FAILURE
,
92 ZEBRA_DPLANE_DELETE_SUCCESS
,
93 ZEBRA_DPLANE_DELETE_FAILURE
,
97 enum zebra_dplane_result
{
98 ZEBRA_DPLANE_REQUEST_QUEUED
,
99 ZEBRA_DPLANE_REQUEST_SUCCESS
,
100 ZEBRA_DPLANE_REQUEST_FAILURE
,
104 * API between the zebra dataplane system and the main zebra processing
109 * Operations that the dataplane can process.
115 DPLANE_OP_ROUTE_INSTALL
,
116 DPLANE_OP_ROUTE_UPDATE
,
117 DPLANE_OP_ROUTE_DELETE
,
118 DPLANE_OP_ROUTE_NOTIFY
,
121 DPLANE_OP_NH_INSTALL
,
126 DPLANE_OP_LSP_INSTALL
,
127 DPLANE_OP_LSP_UPDATE
,
128 DPLANE_OP_LSP_DELETE
,
129 DPLANE_OP_LSP_NOTIFY
,
131 /* Pseudowire update */
132 DPLANE_OP_PW_INSTALL
,
133 DPLANE_OP_PW_UNINSTALL
,
135 /* System route notification */
136 DPLANE_OP_SYS_ROUTE_ADD
,
137 DPLANE_OP_SYS_ROUTE_DELETE
,
139 /* Interface address update */
140 DPLANE_OP_ADDR_INSTALL
,
141 DPLANE_OP_ADDR_UNINSTALL
,
143 /* MAC address update */
144 DPLANE_OP_MAC_INSTALL
,
145 DPLANE_OP_MAC_DELETE
,
147 /* EVPN neighbor updates */
148 DPLANE_OP_NEIGH_INSTALL
,
149 DPLANE_OP_NEIGH_UPDATE
,
150 DPLANE_OP_NEIGH_DELETE
,
152 /* EVPN VTEP updates */
154 DPLANE_OP_VTEP_DELETE
,
156 /* Policy based routing rule update */
158 DPLANE_OP_RULE_DELETE
,
159 DPLANE_OP_RULE_UPDATE
,
161 /* Link layer address discovery */
162 DPLANE_OP_NEIGH_DISCOVER
,
164 /* bridge port update */
165 DPLANE_OP_BR_PORT_UPDATE
,
167 /* Policy based routing iptable update */
168 DPLANE_OP_IPTABLE_ADD
,
169 DPLANE_OP_IPTABLE_DELETE
,
171 /* Policy based routing ipset update */
173 DPLANE_OP_IPSET_DELETE
,
174 DPLANE_OP_IPSET_ENTRY_ADD
,
175 DPLANE_OP_IPSET_ENTRY_DELETE
,
177 /* LINK LAYER IP address update */
178 DPLANE_OP_NEIGH_IP_INSTALL
,
179 DPLANE_OP_NEIGH_IP_DELETE
,
181 DPLANE_OP_NEIGH_TABLE_UPDATE
,
184 /* Incoming interface address events */
185 DPLANE_OP_INTF_ADDR_ADD
,
186 DPLANE_OP_INTF_ADDR_DEL
,
188 /* Incoming interface config events */
189 DPLANE_OP_INTF_NETCONFIG
,
191 /* Interface update */
192 DPLANE_OP_INTF_INSTALL
,
193 DPLANE_OP_INTF_UPDATE
,
194 DPLANE_OP_INTF_DELETE
,
196 /* Traffic control */
197 DPLANE_OP_TC_QDISC_INSTALL
,
198 DPLANE_OP_TC_QDISC_UNINSTALL
,
199 DPLANE_OP_TC_CLASS_ADD
,
200 DPLANE_OP_TC_CLASS_DELETE
,
201 DPLANE_OP_TC_CLASS_UPDATE
,
202 DPLANE_OP_TC_FILTER_ADD
,
203 DPLANE_OP_TC_FILTER_DELETE
,
204 DPLANE_OP_TC_FILTER_UPDATE
208 * The vxlan/evpn neighbor management code needs some values to use
209 * when programming neighbor changes. Offer some platform-neutral values
210 * here for use within the dplane apis and plugins.
213 /* Neighbor cache flags */
214 #define DPLANE_NTF_EXT_LEARNED 0x01
215 #define DPLANE_NTF_ROUTER 0x02
216 #define DPLANE_NTF_USE 0x04
218 /* Neighbor cache states */
219 #define DPLANE_NUD_REACHABLE 0x01
220 #define DPLANE_NUD_STALE 0x02
221 #define DPLANE_NUD_NOARP 0x04
222 #define DPLANE_NUD_PROBE 0x08
223 #define DPLANE_NUD_INCOMPLETE 0x10
224 #define DPLANE_NUD_PERMANENT 0x20
225 #define DPLANE_NUD_FAILED 0x40
227 /* MAC update flags - dplane_mac_info.update_flags */
228 #define DPLANE_MAC_REMOTE (1 << 0)
229 #define DPLANE_MAC_WAS_STATIC (1 << 1)
230 #define DPLANE_MAC_SET_STATIC (1 << 2)
231 #define DPLANE_MAC_SET_INACTIVE (1 << 3)
233 /* Neigh update flags - dplane_neigh_info.update_flags */
234 #define DPLANE_NEIGH_REMOTE (1 << 0)
235 #define DPLANE_NEIGH_WAS_STATIC (1 << 1)
236 #define DPLANE_NEIGH_SET_STATIC (1 << 2)
237 #define DPLANE_NEIGH_SET_INACTIVE (1 << 3)
238 #define DPLANE_NEIGH_NO_EXTENSION (1 << 4)
240 #define DPLANE_BR_PORT_NON_DF (1 << 0)
242 /* Definitions for the dplane 'netconf' apis, corresponding to the netlink
244 * Sadly, netlink sends incremental updates, so its messages may contain
245 * just a single changed attribute, and not necessarily
246 * a complete snapshot of the attributes.
248 enum dplane_netconf_status_e
{
249 DPLANE_NETCONF_STATUS_UNKNOWN
= 0,
250 DPLANE_NETCONF_STATUS_ENABLED
,
251 DPLANE_NETCONF_STATUS_DISABLED
254 /* Some special ifindex values that may be part of the dplane netconf api. */
255 #define DPLANE_NETCONF_IFINDEX_ALL -1
256 #define DPLANE_NETCONF_IFINDEX_DEFAULT -2
258 /* Enable system route notifications */
259 void dplane_enable_sys_route_notifs(void);
262 * The dataplane context struct is used to exchange info between the main zebra
263 * context and the dataplane module(s). If these are two independent pthreads,
264 * they cannot share existing global data structures safely.
267 /* Define a list type for context blocks. The list is exposed/public,
268 * but the internal linkage in the context struct is private, so there
269 * are accessor apis that support enqueue and dequeue.
272 PREDECL_DLIST(dplane_ctx_list
);
274 /* Declare a type for (optional) extended interface info objects. */
275 PREDECL_DLIST(dplane_intf_extra_list
);
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_list_head
*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_list_head
*to_list
,
310 struct dplane_ctx_list_head
*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_list_head
*q
);
314 struct zebra_dplane_ctx
*dplane_ctx_get_head(struct dplane_ctx_list_head
*q
);
316 /* Init a list of contexts */
317 void dplane_ctx_q_init(struct dplane_ctx_list_head
*q
);
320 * Accessors for information from the context object
322 enum zebra_dplane_result
dplane_ctx_get_status(
323 const struct zebra_dplane_ctx
*ctx
);
324 void dplane_ctx_set_status(struct zebra_dplane_ctx
*ctx
,
325 enum zebra_dplane_result status
);
326 const char *dplane_res2str(enum zebra_dplane_result res
);
328 enum dplane_op_e
dplane_ctx_get_op(const struct zebra_dplane_ctx
*ctx
);
329 void dplane_ctx_set_op(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
);
330 const char *dplane_op2str(enum dplane_op_e op
);
332 const struct prefix
*dplane_ctx_get_dest(const struct zebra_dplane_ctx
*ctx
);
333 void dplane_ctx_set_dest(struct zebra_dplane_ctx
*ctx
,
334 const struct prefix
*dest
);
335 const char *dplane_ctx_get_ifname(const struct zebra_dplane_ctx
*ctx
);
336 void dplane_ctx_set_ifname(struct zebra_dplane_ctx
*ctx
, const char *ifname
);
337 ifindex_t
dplane_ctx_get_ifindex(const struct zebra_dplane_ctx
*ctx
);
338 void dplane_ctx_set_ifindex(struct zebra_dplane_ctx
*ctx
, ifindex_t ifindex
);
340 /* Retrieve last/current provider id */
341 uint32_t dplane_ctx_get_provider(const struct zebra_dplane_ctx
*ctx
);
343 /* Providers running before the kernel can control whether a kernel
344 * update should be done.
346 void dplane_ctx_set_skip_kernel(struct zebra_dplane_ctx
*ctx
);
347 bool dplane_ctx_is_skip_kernel(const struct zebra_dplane_ctx
*ctx
);
349 /* Source prefix is a little special - use convention to return NULL
350 * to mean "no src prefix"
352 const struct prefix
*dplane_ctx_get_src(const struct zebra_dplane_ctx
*ctx
);
353 void dplane_ctx_set_src(struct zebra_dplane_ctx
*ctx
, const struct prefix
*src
);
355 bool dplane_ctx_is_update(const struct zebra_dplane_ctx
*ctx
);
356 uint32_t dplane_ctx_get_seq(const struct zebra_dplane_ctx
*ctx
);
357 uint32_t dplane_ctx_get_old_seq(const struct zebra_dplane_ctx
*ctx
);
358 void dplane_ctx_set_vrf(struct zebra_dplane_ctx
*ctx
, vrf_id_t vrf
);
359 vrf_id_t
dplane_ctx_get_vrf(const struct zebra_dplane_ctx
*ctx
);
361 /* In some paths we have only a namespace id */
362 void dplane_ctx_set_ns_id(struct zebra_dplane_ctx
*ctx
, ns_id_t nsid
);
363 ns_id_t
dplane_ctx_get_ns_id(const struct zebra_dplane_ctx
*ctx
);
365 bool dplane_ctx_is_from_notif(const struct zebra_dplane_ctx
*ctx
);
366 void dplane_ctx_set_notif_provider(struct zebra_dplane_ctx
*ctx
,
368 uint32_t dplane_ctx_get_notif_provider(const struct zebra_dplane_ctx
*ctx
);
370 /* Accessors for route update information */
371 void dplane_ctx_set_type(struct zebra_dplane_ctx
*ctx
, int type
);
372 int dplane_ctx_get_type(const struct zebra_dplane_ctx
*ctx
);
373 int dplane_ctx_get_old_type(const struct zebra_dplane_ctx
*ctx
);
374 void dplane_ctx_set_afi(struct zebra_dplane_ctx
*ctx
, afi_t afi
);
375 afi_t
dplane_ctx_get_afi(const struct zebra_dplane_ctx
*ctx
);
376 void dplane_ctx_set_safi(struct zebra_dplane_ctx
*ctx
, safi_t safi
);
377 safi_t
dplane_ctx_get_safi(const struct zebra_dplane_ctx
*ctx
);
378 void dplane_ctx_set_table(struct zebra_dplane_ctx
*ctx
, uint32_t table
);
379 uint32_t dplane_ctx_get_table(const struct zebra_dplane_ctx
*ctx
);
380 route_tag_t
dplane_ctx_get_tag(const struct zebra_dplane_ctx
*ctx
);
381 void dplane_ctx_set_tag(struct zebra_dplane_ctx
*ctx
, route_tag_t tag
);
382 route_tag_t
dplane_ctx_get_old_tag(const struct zebra_dplane_ctx
*ctx
);
383 uint16_t dplane_ctx_get_instance(const struct zebra_dplane_ctx
*ctx
);
384 void dplane_ctx_set_instance(struct zebra_dplane_ctx
*ctx
, uint16_t instance
);
385 uint16_t dplane_ctx_get_old_instance(const struct zebra_dplane_ctx
*ctx
);
386 uint32_t dplane_ctx_get_flags(const struct zebra_dplane_ctx
*ctx
);
387 void dplane_ctx_set_flags(struct zebra_dplane_ctx
*ctx
, uint32_t flags
);
388 uint32_t dplane_ctx_get_metric(const struct zebra_dplane_ctx
*ctx
);
389 uint32_t dplane_ctx_get_old_metric(const struct zebra_dplane_ctx
*ctx
);
390 uint32_t dplane_ctx_get_mtu(const struct zebra_dplane_ctx
*ctx
);
391 uint32_t dplane_ctx_get_nh_mtu(const struct zebra_dplane_ctx
*ctx
);
392 uint8_t dplane_ctx_get_distance(const struct zebra_dplane_ctx
*ctx
);
393 void dplane_ctx_set_distance(struct zebra_dplane_ctx
*ctx
, uint8_t distance
);
394 uint8_t dplane_ctx_get_old_distance(const struct zebra_dplane_ctx
*ctx
);
396 /* Accessors for traffic control context */
397 int dplane_ctx_tc_qdisc_get_kind(const struct zebra_dplane_ctx
*ctx
);
399 dplane_ctx_tc_qdisc_get_kind_str(const struct zebra_dplane_ctx
*ctx
);
401 uint32_t dplane_ctx_tc_class_get_handle(const struct zebra_dplane_ctx
*ctx
);
402 int dplane_ctx_tc_class_get_kind(const struct zebra_dplane_ctx
*ctx
);
404 dplane_ctx_tc_class_get_kind_str(const struct zebra_dplane_ctx
*ctx
);
405 uint64_t dplane_ctx_tc_class_get_rate(const struct zebra_dplane_ctx
*ctx
);
406 uint64_t dplane_ctx_tc_class_get_ceil(const struct zebra_dplane_ctx
*ctx
);
408 int dplane_ctx_tc_filter_get_kind(const struct zebra_dplane_ctx
*ctx
);
410 dplane_ctx_tc_filter_get_kind_str(const struct zebra_dplane_ctx
*ctx
);
411 uint32_t dplane_ctx_tc_filter_get_priority(const struct zebra_dplane_ctx
*ctx
);
412 uint32_t dplane_ctx_tc_filter_get_handle(const struct zebra_dplane_ctx
*ctx
);
413 uint16_t dplane_ctx_tc_filter_get_minor(const struct zebra_dplane_ctx
*ctx
);
414 uint16_t dplane_ctx_tc_filter_get_eth_proto(const struct zebra_dplane_ctx
*ctx
);
415 uint32_t dplane_ctx_tc_filter_get_filter_bm(const struct zebra_dplane_ctx
*ctx
);
416 const struct prefix
*
417 dplane_ctx_tc_filter_get_src_ip(const struct zebra_dplane_ctx
*ctx
);
419 dplane_ctx_tc_filter_get_src_port_min(const struct zebra_dplane_ctx
*ctx
);
421 dplane_ctx_tc_filter_get_src_port_max(const struct zebra_dplane_ctx
*ctx
);
422 const struct prefix
*
423 dplane_ctx_tc_filter_get_dst_ip(const struct zebra_dplane_ctx
*ctx
);
425 dplane_ctx_tc_filter_get_dst_port_min(const struct zebra_dplane_ctx
*ctx
);
427 dplane_ctx_tc_filter_get_dst_port_max(const struct zebra_dplane_ctx
*ctx
);
428 uint8_t dplane_ctx_tc_filter_get_ip_proto(const struct zebra_dplane_ctx
*ctx
);
429 uint8_t dplane_ctx_tc_filter_get_dsfield(const struct zebra_dplane_ctx
*ctx
);
431 dplane_ctx_tc_filter_get_dsfield_mask(const struct zebra_dplane_ctx
*ctx
);
432 uint32_t dplane_ctx_tc_filter_get_classid(const struct zebra_dplane_ctx
*ctx
);
434 void dplane_ctx_set_nexthops(struct zebra_dplane_ctx
*ctx
, struct nexthop
*nh
);
435 void dplane_ctx_set_backup_nhg(struct zebra_dplane_ctx
*ctx
,
436 const struct nexthop_group
*nhg
);
438 uint32_t dplane_ctx_get_nhg_id(const struct zebra_dplane_ctx
*ctx
);
439 const struct nexthop_group
*dplane_ctx_get_ng(
440 const struct zebra_dplane_ctx
*ctx
);
441 const struct nexthop_group
*dplane_ctx_get_old_ng(
442 const struct zebra_dplane_ctx
*ctx
);
444 /* Optional extra info about interfaces in nexthops - a plugin must enable
447 const struct dplane_intf_extra
*
448 dplane_ctx_get_intf_extra(const struct zebra_dplane_ctx
*ctx
);
450 const struct dplane_intf_extra
*
451 dplane_ctx_intf_extra_next(const struct zebra_dplane_ctx
*ctx
,
452 const struct dplane_intf_extra
*ptr
);
454 vrf_id_t
dplane_intf_extra_get_vrfid(const struct dplane_intf_extra
*ptr
);
455 uint32_t dplane_intf_extra_get_ifindex(const struct dplane_intf_extra
*ptr
);
456 uint32_t dplane_intf_extra_get_flags(const struct dplane_intf_extra
*ptr
);
457 uint32_t dplane_intf_extra_get_status(const struct dplane_intf_extra
*ptr
);
459 /* Backup nexthop information (list of nexthops) if present. */
460 const struct nexthop_group
*
461 dplane_ctx_get_backup_ng(const struct zebra_dplane_ctx
*ctx
);
462 const struct nexthop_group
*
463 dplane_ctx_get_old_backup_ng(const struct zebra_dplane_ctx
*ctx
);
465 /* Accessors for nexthop information */
466 uint32_t dplane_ctx_get_nhe_id(const struct zebra_dplane_ctx
*ctx
);
467 uint32_t dplane_ctx_get_old_nhe_id(const struct zebra_dplane_ctx
*ctx
);
468 afi_t
dplane_ctx_get_nhe_afi(const struct zebra_dplane_ctx
*ctx
);
469 vrf_id_t
dplane_ctx_get_nhe_vrf_id(const struct zebra_dplane_ctx
*ctx
);
470 int dplane_ctx_get_nhe_type(const struct zebra_dplane_ctx
*ctx
);
471 const struct nexthop_group
*
472 dplane_ctx_get_nhe_ng(const struct zebra_dplane_ctx
*ctx
);
473 const struct nh_grp
*
474 dplane_ctx_get_nhe_nh_grp(const struct zebra_dplane_ctx
*ctx
);
475 uint8_t dplane_ctx_get_nhe_nh_grp_count(const struct zebra_dplane_ctx
*ctx
);
477 /* Accessors for LSP information */
479 /* Init the internal LSP data struct - necessary before adding to it.
480 * If 'lsp' is non-NULL, info will be copied from it to the internal
483 int dplane_ctx_lsp_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
484 struct zebra_lsp
*lsp
);
486 mpls_label_t
dplane_ctx_get_in_label(const struct zebra_dplane_ctx
*ctx
);
487 void dplane_ctx_set_in_label(struct zebra_dplane_ctx
*ctx
,
489 uint8_t dplane_ctx_get_addr_family(const struct zebra_dplane_ctx
*ctx
);
490 void dplane_ctx_set_addr_family(struct zebra_dplane_ctx
*ctx
,
492 uint32_t dplane_ctx_get_lsp_flags(const struct zebra_dplane_ctx
*ctx
);
493 void dplane_ctx_set_lsp_flags(struct zebra_dplane_ctx
*ctx
,
495 const struct nhlfe_list_head
*dplane_ctx_get_nhlfe_list(
496 const struct zebra_dplane_ctx
*ctx
);
497 const struct nhlfe_list_head
*dplane_ctx_get_backup_nhlfe_list(
498 const struct zebra_dplane_ctx
*ctx
);
500 struct zebra_nhlfe
*dplane_ctx_add_nhlfe(struct zebra_dplane_ctx
*ctx
,
501 enum lsp_types_t lsp_type
,
502 enum nexthop_types_t nh_type
,
503 const union g_addr
*gate
,
504 ifindex_t ifindex
, uint8_t num_labels
,
505 mpls_label_t
*out_labels
);
507 struct zebra_nhlfe
*dplane_ctx_add_backup_nhlfe(
508 struct zebra_dplane_ctx
*ctx
, enum lsp_types_t lsp_type
,
509 enum nexthop_types_t nh_type
, const union g_addr
*gate
,
510 ifindex_t ifindex
, uint8_t num_labels
, mpls_label_t
*out_labels
);
512 const struct zebra_nhlfe
*
513 dplane_ctx_get_best_nhlfe(const struct zebra_dplane_ctx
*ctx
);
514 const struct zebra_nhlfe
*
515 dplane_ctx_set_best_nhlfe(struct zebra_dplane_ctx
*ctx
,
516 struct zebra_nhlfe
*nhlfe
);
517 uint32_t dplane_ctx_get_lsp_num_ecmp(const struct zebra_dplane_ctx
*ctx
);
519 /* Accessors for pseudowire information */
520 mpls_label_t
dplane_ctx_get_pw_local_label(const struct zebra_dplane_ctx
*ctx
);
521 mpls_label_t
dplane_ctx_get_pw_remote_label(const struct zebra_dplane_ctx
*ctx
);
522 int dplane_ctx_get_pw_type(const struct zebra_dplane_ctx
*ctx
);
523 int dplane_ctx_get_pw_af(const struct zebra_dplane_ctx
*ctx
);
524 uint32_t dplane_ctx_get_pw_flags(const struct zebra_dplane_ctx
*ctx
);
525 int dplane_ctx_get_pw_status(const struct zebra_dplane_ctx
*ctx
);
526 void dplane_ctx_set_pw_status(struct zebra_dplane_ctx
*ctx
, int status
);
527 const union g_addr
*dplane_ctx_get_pw_dest(
528 const struct zebra_dplane_ctx
*ctx
);
529 const union pw_protocol_fields
*dplane_ctx_get_pw_proto(
530 const struct zebra_dplane_ctx
*ctx
);
531 const struct nexthop_group
*dplane_ctx_get_pw_nhg(
532 const struct zebra_dplane_ctx
*ctx
);
533 const struct nexthop_group
*
534 dplane_ctx_get_pw_primary_nhg(const struct zebra_dplane_ctx
*ctx
);
535 const struct nexthop_group
*
536 dplane_ctx_get_pw_backup_nhg(const struct zebra_dplane_ctx
*ctx
);
538 /* Accessors for interface information */
539 uint32_t dplane_ctx_get_intf_metric(const struct zebra_dplane_ctx
*ctx
);
540 void dplane_ctx_set_intf_metric(struct zebra_dplane_ctx
*ctx
, uint32_t metric
);
541 uint32_t dplane_ctx_get_intf_pd_reason_val(const struct zebra_dplane_ctx
*ctx
);
542 void dplane_ctx_set_intf_pd_reason_val(struct zebra_dplane_ctx
*ctx
, bool val
);
543 bool dplane_ctx_intf_is_protodown(const struct zebra_dplane_ctx
*ctx
);
544 /* Is interface addr p2p? */
545 bool dplane_ctx_intf_is_connected(const struct zebra_dplane_ctx
*ctx
);
546 void dplane_ctx_intf_set_connected(struct zebra_dplane_ctx
*ctx
);
547 bool dplane_ctx_intf_is_secondary(const struct zebra_dplane_ctx
*ctx
);
548 void dplane_ctx_intf_set_secondary(struct zebra_dplane_ctx
*ctx
);
549 bool dplane_ctx_intf_is_broadcast(const struct zebra_dplane_ctx
*ctx
);
550 void dplane_ctx_intf_set_broadcast(struct zebra_dplane_ctx
*ctx
);
551 const struct prefix
*dplane_ctx_get_intf_addr(
552 const struct zebra_dplane_ctx
*ctx
);
553 void dplane_ctx_set_intf_addr(struct zebra_dplane_ctx
*ctx
,
554 const struct prefix
*p
);
555 bool dplane_ctx_intf_has_dest(const struct zebra_dplane_ctx
*ctx
);
556 const struct prefix
*dplane_ctx_get_intf_dest(
557 const struct zebra_dplane_ctx
*ctx
);
558 void dplane_ctx_set_intf_dest(struct zebra_dplane_ctx
*ctx
,
559 const struct prefix
*p
);
560 bool dplane_ctx_intf_has_label(const struct zebra_dplane_ctx
*ctx
);
561 const char *dplane_ctx_get_intf_label(const struct zebra_dplane_ctx
*ctx
);
562 void dplane_ctx_set_intf_label(struct zebra_dplane_ctx
*ctx
, const char *label
);
564 /* Accessors for MAC information */
565 vlanid_t
dplane_ctx_mac_get_vlan(const struct zebra_dplane_ctx
*ctx
);
566 bool dplane_ctx_mac_is_sticky(const struct zebra_dplane_ctx
*ctx
);
567 uint32_t dplane_ctx_mac_get_update_flags(const struct zebra_dplane_ctx
*ctx
);
568 uint32_t dplane_ctx_mac_get_nhg_id(const struct zebra_dplane_ctx
*ctx
);
569 const struct ethaddr
*dplane_ctx_mac_get_addr(
570 const struct zebra_dplane_ctx
*ctx
);
571 vni_t
dplane_ctx_mac_get_vni(const struct zebra_dplane_ctx
*ctx
);
572 const struct in_addr
*dplane_ctx_mac_get_vtep_ip(
573 const struct zebra_dplane_ctx
*ctx
);
574 ifindex_t
dplane_ctx_mac_get_br_ifindex(const struct zebra_dplane_ctx
*ctx
);
576 /* Accessors for neighbor information */
577 const struct ipaddr
*dplane_ctx_neigh_get_ipaddr(
578 const struct zebra_dplane_ctx
*ctx
);
579 const struct ethaddr
*dplane_ctx_neigh_get_mac(
580 const struct zebra_dplane_ctx
*ctx
);
581 vni_t
dplane_ctx_neigh_get_vni(const struct zebra_dplane_ctx
*ctx
);
582 const struct ipaddr
*
583 dplane_ctx_neigh_get_link_ip(const struct zebra_dplane_ctx
*ctx
);
584 uint32_t dplane_ctx_neigh_get_flags(const struct zebra_dplane_ctx
*ctx
);
585 uint16_t dplane_ctx_neigh_get_state(const struct zebra_dplane_ctx
*ctx
);
586 uint32_t dplane_ctx_neigh_get_update_flags(const struct zebra_dplane_ctx
*ctx
);
588 /* Accessors for policy based routing rule information */
589 int dplane_ctx_rule_get_sock(const struct zebra_dplane_ctx
*ctx
);
590 int dplane_ctx_rule_get_unique(const struct zebra_dplane_ctx
*ctx
);
591 int dplane_ctx_rule_get_seq(const struct zebra_dplane_ctx
*ctx
);
592 const char *dplane_ctx_rule_get_ifname(const struct zebra_dplane_ctx
*ctx
);
593 uint32_t dplane_ctx_rule_get_priority(const struct zebra_dplane_ctx
*ctx
);
594 uint32_t dplane_ctx_rule_get_old_priority(const struct zebra_dplane_ctx
*ctx
);
595 uint32_t dplane_ctx_rule_get_table(const struct zebra_dplane_ctx
*ctx
);
596 uint32_t dplane_ctx_rule_get_old_table(const struct zebra_dplane_ctx
*ctx
);
597 uint32_t dplane_ctx_rule_get_filter_bm(const struct zebra_dplane_ctx
*ctx
);
598 uint32_t dplane_ctx_rule_get_old_filter_bm(const struct zebra_dplane_ctx
*ctx
);
599 uint32_t dplane_ctx_rule_get_fwmark(const struct zebra_dplane_ctx
*ctx
);
600 uint32_t dplane_ctx_rule_get_old_fwmark(const struct zebra_dplane_ctx
*ctx
);
601 uint8_t dplane_ctx_rule_get_dsfield(const struct zebra_dplane_ctx
*ctx
);
602 uint8_t dplane_ctx_rule_get_old_dsfield(const struct zebra_dplane_ctx
*ctx
);
603 uint8_t dplane_ctx_rule_get_ipproto(const struct zebra_dplane_ctx
*ctx
);
604 uint8_t dplane_ctx_rule_get_old_ipproto(const struct zebra_dplane_ctx
*ctx
);
605 uint16_t dplane_ctx_rule_get_src_port(const struct zebra_dplane_ctx
*ctx
);
606 uint16_t dplane_ctx_rule_get_old_src_port(const struct zebra_dplane_ctx
*ctx
);
607 uint16_t dplane_ctx_rule_get_dst_port(const struct zebra_dplane_ctx
*ctx
);
608 uint16_t dplane_ctx_rule_get_old_dst_port(const struct zebra_dplane_ctx
*ctx
);
609 const struct prefix
*
610 dplane_ctx_rule_get_src_ip(const struct zebra_dplane_ctx
*ctx
);
611 const struct prefix
*
612 dplane_ctx_rule_get_old_src_ip(const struct zebra_dplane_ctx
*ctx
);
613 const struct prefix
*
614 dplane_ctx_rule_get_dst_ip(const struct zebra_dplane_ctx
*ctx
);
615 const struct prefix
*
616 dplane_ctx_rule_get_old_dst_ip(const struct zebra_dplane_ctx
*ctx
);
617 const struct ethaddr
*
618 dplane_ctx_rule_get_smac(const struct zebra_dplane_ctx
*ctx
);
619 const struct ethaddr
*
620 dplane_ctx_rule_get_dmac(const struct zebra_dplane_ctx
*ctx
);
621 int dplane_ctx_rule_get_out_ifindex(const struct zebra_dplane_ctx
*ctx
);
622 intptr_t dplane_ctx_rule_get_dp_flow_ptr(const struct zebra_dplane_ctx
*ctx
);
624 dplane_ctx_rule_get_old_dp_flow_ptr(const struct zebra_dplane_ctx
*ctx
);
625 void dplane_ctx_rule_set_dp_flow_ptr(struct zebra_dplane_ctx
*ctx
,
626 intptr_t dp_flow_ptr
);
627 /* Accessors for policy based routing iptable information */
628 struct zebra_pbr_iptable
;
629 void dplane_ctx_get_pbr_iptable(const struct zebra_dplane_ctx
*ctx
,
630 struct zebra_pbr_iptable
*table
);
631 struct zebra_pbr_ipset
;
632 void dplane_ctx_get_pbr_ipset(const struct zebra_dplane_ctx
*ctx
,
633 struct zebra_pbr_ipset
*ipset
);
634 struct zebra_pbr_ipset_entry
;
635 void dplane_ctx_get_pbr_ipset_entry(const struct zebra_dplane_ctx
*ctx
,
636 struct zebra_pbr_ipset_entry
*entry
);
637 /* Accessors for bridge port information */
638 uint32_t dplane_ctx_get_br_port_flags(const struct zebra_dplane_ctx
*ctx
);
640 dplane_ctx_get_br_port_sph_filter_cnt(const struct zebra_dplane_ctx
*ctx
);
641 const struct in_addr
*
642 dplane_ctx_get_br_port_sph_filters(const struct zebra_dplane_ctx
*ctx
);
644 dplane_ctx_get_br_port_backup_nhg_id(const struct zebra_dplane_ctx
*ctx
);
646 /* Accessors for neighbor table information */
647 uint8_t dplane_ctx_neightable_get_family(const struct zebra_dplane_ctx
*ctx
);
649 dplane_ctx_neightable_get_app_probes(const struct zebra_dplane_ctx
*ctx
);
651 dplane_ctx_neightable_get_mcast_probes(const struct zebra_dplane_ctx
*ctx
);
653 dplane_ctx_neightable_get_ucast_probes(const struct zebra_dplane_ctx
*ctx
);
655 /* Accessor for GRE set */
657 dplane_ctx_gre_get_link_ifindex(const struct zebra_dplane_ctx
*ctx
);
659 dplane_ctx_gre_get_mtu(const struct zebra_dplane_ctx
*ctx
);
660 const struct zebra_l2info_gre
*
661 dplane_ctx_gre_get_info(const struct zebra_dplane_ctx
*ctx
);
663 /* Interface netconf info */
664 enum dplane_netconf_status_e
665 dplane_ctx_get_netconf_mpls(const struct zebra_dplane_ctx
*ctx
);
666 enum dplane_netconf_status_e
667 dplane_ctx_get_netconf_mcast(const struct zebra_dplane_ctx
*ctx
);
668 enum dplane_netconf_status_e
669 dplane_ctx_get_netconf_linkdown(const struct zebra_dplane_ctx
*ctx
);
671 void dplane_ctx_set_netconf_mpls(struct zebra_dplane_ctx
*ctx
,
672 enum dplane_netconf_status_e val
);
673 void dplane_ctx_set_netconf_mcast(struct zebra_dplane_ctx
*ctx
,
674 enum dplane_netconf_status_e val
);
675 void dplane_ctx_set_netconf_linkdown(struct zebra_dplane_ctx
*ctx
,
676 enum dplane_netconf_status_e val
);
678 /* Namespace fd info - esp. for netlink communication */
679 const struct zebra_dplane_info
*dplane_ctx_get_ns(
680 const struct zebra_dplane_ctx
*ctx
);
681 int dplane_ctx_get_ns_sock(const struct zebra_dplane_ctx
*ctx
);
683 /* Indicates zebra shutdown/exit is in progress. Some operations may be
684 * simplified or skipped during shutdown processing.
686 bool dplane_is_in_shutdown(void);
689 * Enqueue route change operations for the dataplane.
691 enum zebra_dplane_result
dplane_route_add(struct route_node
*rn
,
692 struct route_entry
*re
);
694 enum zebra_dplane_result
dplane_route_update(struct route_node
*rn
,
695 struct route_entry
*re
,
696 struct route_entry
*old_re
);
698 enum zebra_dplane_result
dplane_route_delete(struct route_node
*rn
,
699 struct route_entry
*re
);
701 /* Notify the dplane when system/connected routes change */
702 enum zebra_dplane_result
dplane_sys_route_add(struct route_node
*rn
,
703 struct route_entry
*re
);
704 enum zebra_dplane_result
dplane_sys_route_del(struct route_node
*rn
,
705 struct route_entry
*re
);
707 /* Update from an async notification, to bring other fibs up-to-date */
708 enum zebra_dplane_result
dplane_route_notif_update(
709 struct route_node
*rn
,
710 struct route_entry
*re
,
712 struct zebra_dplane_ctx
*ctx
);
715 * Enqueue bridge port changes for the dataplane.
717 enum zebra_dplane_result
dplane_br_port_update(
718 const struct interface
*ifp
, bool non_df
, uint32_t sph_filter_cnt
,
719 const struct in_addr
*sph_filters
, uint32_t backup_nhg_id
);
721 /* Forward ref of nhg_hash_entry */
722 struct nhg_hash_entry
;
724 * Enqueue a nexthop change operation for the dataplane.
726 enum zebra_dplane_result
dplane_nexthop_add(struct nhg_hash_entry
*nhe
);
727 enum zebra_dplane_result
dplane_nexthop_update(struct nhg_hash_entry
*nhe
);
728 enum zebra_dplane_result
dplane_nexthop_delete(struct nhg_hash_entry
*nhe
);
731 * Enqueue LSP change operations for the dataplane.
733 enum zebra_dplane_result
dplane_lsp_add(struct zebra_lsp
*lsp
);
734 enum zebra_dplane_result
dplane_lsp_update(struct zebra_lsp
*lsp
);
735 enum zebra_dplane_result
dplane_lsp_delete(struct zebra_lsp
*lsp
);
737 /* Update or un-install resulting from an async notification */
738 enum zebra_dplane_result
dplane_lsp_notif_update(struct zebra_lsp
*lsp
,
740 struct zebra_dplane_ctx
*ctx
);
743 * Enqueue pseudowire operations for the dataplane.
745 enum zebra_dplane_result
dplane_pw_install(struct zebra_pw
*pw
);
746 enum zebra_dplane_result
dplane_pw_uninstall(struct zebra_pw
*pw
);
748 enum zebra_dplane_result
749 dplane_intf_mpls_modify_state(const struct interface
*ifp
, const bool set
);
751 * Enqueue interface address changes for the dataplane.
753 enum zebra_dplane_result
dplane_intf_addr_set(const struct interface
*ifp
,
754 const struct connected
*ifc
);
755 enum zebra_dplane_result
dplane_intf_addr_unset(const struct interface
*ifp
,
756 const struct connected
*ifc
);
759 * Enqueue interface link changes for the dataplane.
761 enum zebra_dplane_result
dplane_intf_add(const struct interface
*ifp
);
762 enum zebra_dplane_result
dplane_intf_update(const struct interface
*ifp
);
763 enum zebra_dplane_result
dplane_intf_delete(const struct interface
*ifp
);
766 * Enqueue tc link changes for the dataplane.
769 struct zebra_tc_qdisc
;
770 struct zebra_tc_class
;
771 struct zebra_tc_filter
;
772 enum zebra_dplane_result
dplane_tc_qdisc_install(struct zebra_tc_qdisc
*qdisc
);
773 enum zebra_dplane_result
774 dplane_tc_qdisc_uninstall(struct zebra_tc_qdisc
*qdisc
);
775 enum zebra_dplane_result
dplane_tc_class_add(struct zebra_tc_class
*class);
776 enum zebra_dplane_result
dplane_tc_class_delete(struct zebra_tc_class
*class);
777 enum zebra_dplane_result
dplane_tc_class_update(struct zebra_tc_class
*class);
778 enum zebra_dplane_result
dplane_tc_filter_add(struct zebra_tc_filter
*filter
);
779 enum zebra_dplane_result
780 dplane_tc_filter_delete(struct zebra_tc_filter
*filter
);
781 enum zebra_dplane_result
782 dplane_tc_filter_update(struct zebra_tc_filter
*filter
);
785 * Link layer operations for the dataplane.
787 enum zebra_dplane_result
dplane_neigh_ip_update(enum dplane_op_e op
,
788 const struct interface
*ifp
,
789 struct ipaddr
*link_ip
,
795 * Enqueue evpn mac operations for the dataplane.
797 enum zebra_dplane_result
798 dplane_rem_mac_add(const struct interface
*ifp
,
799 const struct interface
*bridge_ifp
, vlanid_t vid
,
800 const struct ethaddr
*mac
, vni_t vni
, struct in_addr vtep_ip
,
801 bool sticky
, uint32_t nhg_id
, bool was_static
);
803 enum zebra_dplane_result
dplane_local_mac_add(const struct interface
*ifp
,
804 const struct interface
*bridge_ifp
,
806 const struct ethaddr
*mac
,
809 uint32_t set_inactive
);
811 enum zebra_dplane_result
812 dplane_local_mac_del(const struct interface
*ifp
,
813 const struct interface
*bridge_ifp
, vlanid_t vid
,
814 const struct ethaddr
*mac
);
816 enum zebra_dplane_result
dplane_rem_mac_del(const struct interface
*ifp
,
817 const struct interface
*bridge_ifp
,
819 const struct ethaddr
*mac
,
820 vni_t vni
, struct in_addr vtep_ip
);
822 /* Helper api to init an empty or new context for a MAC update */
823 void dplane_mac_init(struct zebra_dplane_ctx
*ctx
, const struct interface
*ifp
,
824 const struct interface
*br_ifp
, vlanid_t vid
,
825 const struct ethaddr
*mac
, vni_t vni
,
826 struct in_addr vtep_ip
, bool sticky
, uint32_t nhg_id
,
827 uint32_t update_flags
);
830 * Enqueue evpn neighbor updates for the dataplane.
832 enum zebra_dplane_result
dplane_rem_neigh_add(const struct interface
*ifp
,
833 const struct ipaddr
*ip
,
834 const struct ethaddr
*mac
,
835 uint32_t flags
, bool was_static
);
836 enum zebra_dplane_result
dplane_local_neigh_add(const struct interface
*ifp
,
837 const struct ipaddr
*ip
,
838 const struct ethaddr
*mac
,
839 bool set_router
, bool set_static
,
841 enum zebra_dplane_result
dplane_rem_neigh_delete(const struct interface
*ifp
,
842 const struct ipaddr
*ip
);
845 * Enqueue evpn VTEP updates for the dataplane.
847 enum zebra_dplane_result
dplane_vtep_add(const struct interface
*ifp
,
848 const struct in_addr
*ip
,
850 enum zebra_dplane_result
dplane_vtep_delete(const struct interface
*ifp
,
851 const struct in_addr
*ip
,
855 * Enqueue a neighbour discovery request for the dataplane.
857 enum zebra_dplane_result
dplane_neigh_discover(const struct interface
*ifp
,
858 const struct ipaddr
*ip
);
861 * Enqueue a neighbor table parameter set
863 enum zebra_dplane_result
dplane_neigh_table_update(const struct interface
*ifp
,
864 const uint8_t family
,
865 const uint32_t app_probes
,
866 const uint32_t ucast_probes
,
867 const uint32_t mcast_probes
);
872 enum zebra_dplane_result
873 dplane_gre_set(struct interface
*ifp
, struct interface
*ifp_link
,
874 unsigned int mtu
, const struct zebra_l2info_gre
*gre_info
);
876 /* Forward ref of zebra_pbr_rule */
877 struct zebra_pbr_rule
;
880 * Enqueue policy based routing rule for the dataplane.
881 * It is possible that the user-defined sequence number and the one in the
882 * forwarding plane may not coincide, hence the API requires a separate
883 * rule priority - maps to preference/FRA_PRIORITY on Linux.
885 enum zebra_dplane_result
dplane_pbr_rule_add(struct zebra_pbr_rule
*rule
);
886 enum zebra_dplane_result
dplane_pbr_rule_delete(struct zebra_pbr_rule
*rule
);
887 enum zebra_dplane_result
888 dplane_pbr_rule_update(struct zebra_pbr_rule
*old_rule
,
889 struct zebra_pbr_rule
*new_rule
);
891 enum zebra_dplane_result
892 dplane_pbr_iptable_add(struct zebra_pbr_iptable
*iptable
);
893 enum zebra_dplane_result
894 dplane_pbr_iptable_delete(struct zebra_pbr_iptable
*iptable
);
897 struct zebra_pbr_ipset
;
898 enum zebra_dplane_result
dplane_pbr_ipset_add(struct zebra_pbr_ipset
*ipset
);
899 enum zebra_dplane_result
dplane_pbr_ipset_delete(struct zebra_pbr_ipset
*ipset
);
902 struct zebra_pbr_ipset_entry
;
903 enum zebra_dplane_result
904 dplane_pbr_ipset_entry_add(struct zebra_pbr_ipset_entry
*ipset
);
905 enum zebra_dplane_result
906 dplane_pbr_ipset_entry_delete(struct zebra_pbr_ipset_entry
*ipset
);
908 /* Encode route information into data plane context. */
909 int dplane_ctx_route_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
910 struct route_node
*rn
, struct route_entry
*re
);
912 int dplane_ctx_route_init_basic(struct zebra_dplane_ctx
*ctx
,
913 enum dplane_op_e op
, struct route_entry
*re
,
914 const struct prefix
*p
,
915 const struct prefix_ipv6
*src_p
, afi_t afi
,
918 /* Encode next hop information into data plane context. */
919 int dplane_ctx_nexthop_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
920 struct nhg_hash_entry
*nhe
);
922 /* Encode interface information into data plane context. */
923 int dplane_ctx_intf_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
,
924 const struct interface
*ifp
);
926 /* Encode traffic control information into data plane context. */
927 int dplane_ctx_tc_init(struct zebra_dplane_ctx
*ctx
, enum dplane_op_e op
);
929 /* Retrieve the limit on the number of pending, unprocessed updates. */
930 uint32_t dplane_get_in_queue_limit(void);
932 /* Configure limit on the number of pending, queued updates. If 'unset', reset
935 void dplane_set_in_queue_limit(uint32_t limit
, bool set
);
937 /* Retrieve the current queue depth of incoming, unprocessed updates */
938 uint32_t dplane_get_in_queue_len(void);
943 int dplane_show_helper(struct vty
*vty
, bool detailed
);
944 int dplane_show_provs_helper(struct vty
*vty
, bool detailed
);
945 int dplane_config_write_helper(struct vty
*vty
);
948 * Dataplane providers: modules that process or consume dataplane events.
951 struct zebra_dplane_provider
;
953 /* Support string name for a dataplane provider */
954 #define DPLANE_PROVIDER_NAMELEN 64
956 /* Priority or ordering values for providers. The idea is that there may be
957 * some pre-processing, followed by an external or remote dataplane,
958 * followed by the kernel, followed by some post-processing step (such as
959 * the fpm output stream.)
961 enum dplane_provider_prio
{
962 DPLANE_PRIO_NONE
= 0,
963 DPLANE_PRIO_PREPROCESS
,
964 DPLANE_PRIO_PRE_KERNEL
,
966 DPLANE_PRIO_POSTPROCESS
,
970 /* Flags values used during provider registration. */
971 #define DPLANE_PROV_FLAGS_DEFAULT 0x0
973 /* Provider will be spawning its own worker thread */
974 #define DPLANE_PROV_FLAG_THREADED 0x1
976 /* Provider registration: ordering or priority value, callbacks, and optional
977 * opaque data value. If 'prov_p', return the newly-allocated provider object
981 /* Providers offer an entry-point for incoming work, called in the context of
982 * the dataplane pthread. The dataplane pthread enqueues any new work to the
983 * provider's 'inbound' queue, then calls the callback. The dataplane
984 * then checks the provider's outbound queue for completed work.
988 * Providers can offer a 'start' callback; if present, the dataplane will
989 * call it when it is starting - when its pthread and event-scheduling
990 * thread_master are available.
993 /* Providers can offer an entry-point for shutdown and cleanup. This is called
994 * with 'early' during shutdown, to indicate that the dataplane subsystem
995 * is allowing work to move through the providers and finish.
996 * When called without 'early', the provider should release
997 * all resources (if it has any allocated).
999 int dplane_provider_register(const char *name
,
1000 enum dplane_provider_prio prio
,
1002 int (*start_fp
)(struct zebra_dplane_provider
*),
1003 int (*fp
)(struct zebra_dplane_provider
*),
1004 int (*fini_fp
)(struct zebra_dplane_provider
*,
1007 struct zebra_dplane_provider
**prov_p
);
1009 /* Accessors for provider attributes */
1010 const char *dplane_provider_get_name(const struct zebra_dplane_provider
*prov
);
1011 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider
*prov
);
1012 void *dplane_provider_get_data(const struct zebra_dplane_provider
*prov
);
1013 bool dplane_provider_is_threaded(const struct zebra_dplane_provider
*prov
);
1015 /* Lock/unlock a provider's mutex - iff the provider was registered with
1016 * the THREADED flag.
1018 void dplane_provider_lock(struct zebra_dplane_provider
*prov
);
1019 void dplane_provider_unlock(struct zebra_dplane_provider
*prov
);
1021 /* Obtain thread_master for dataplane thread */
1022 struct thread_master
*dplane_get_thread_master(void);
1024 /* Providers should (generally) limit number of updates per work cycle */
1025 int dplane_provider_get_work_limit(const struct zebra_dplane_provider
*prov
);
1027 /* Provider api to signal that work/events are available
1028 * for the dataplane pthread.
1030 int dplane_provider_work_ready(void);
1032 /* Dequeue, maintain associated counter and locking */
1033 struct zebra_dplane_ctx
*dplane_provider_dequeue_in_ctx(
1034 struct zebra_dplane_provider
*prov
);
1036 /* Dequeue work to a list, maintain counter and locking, return count */
1037 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider
*prov
,
1038 struct dplane_ctx_list_head
*listp
);
1040 /* Current completed work queue length */
1041 uint32_t dplane_provider_out_ctx_queue_len(struct zebra_dplane_provider
*prov
);
1043 /* Enqueue completed work, maintain associated counter and locking */
1044 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider
*prov
,
1045 struct zebra_dplane_ctx
*ctx
);
1047 /* Enqueue a context directly to zebra main. */
1048 void dplane_provider_enqueue_to_zebra(struct zebra_dplane_ctx
*ctx
);
1050 /* Enable collection of extra info about interfaces in route updates;
1051 * this allows a provider/plugin to see some extra info in route update
1054 void dplane_enable_intf_extra_info(void);
1057 * Initialize the dataplane modules at zebra startup. This is currently called
1058 * by the rib module. Zebra registers a results callback with the dataplane.
1059 * The callback is called in the dataplane pthread context,
1060 * so the expectation is that the contexts are queued for the zebra
1063 void zebra_dplane_init(int (*)(struct dplane_ctx_list_head
*));
1066 * Start the dataplane pthread. This step needs to be run later than the
1067 * 'init' step, in case zebra has fork-ed.
1069 void zebra_dplane_start(void);
1071 /* Finalize/cleanup apis, one called early as shutdown is starting,
1072 * one called late at the end of zebra shutdown, and then one called
1073 * from the zebra main pthread to stop the dplane pthread and
1074 * free all resources.
1076 * Zebra expects to try to clean up all vrfs and all routes during
1077 * shutdown, so the dplane must be available until very late.
1079 void zebra_dplane_pre_finish(void);
1080 void zebra_dplane_finish(void);
1081 void zebra_dplane_shutdown(void);
1084 * decision point for sending a routing update through the old
1085 * straight to zebra master pthread or through the dplane to
1086 * the master pthread for handling
1088 void dplane_rib_add_multipath(afi_t afi
, safi_t safi
, struct prefix
*p
,
1089 struct prefix_ipv6
*src_p
, struct route_entry
*re
,
1090 struct nexthop_group
*ng
, int startup
,
1091 struct zebra_dplane_ctx
*ctx
);
1097 #endif /* _ZEBRA_DPLANE_H */