zebra/zebra_dplane.h

   1 /*
   2  * Zebra dataplane layer api interfaces.
   3  * Copyright (c) 2018 Volta Networks, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  */
  19
  20 #ifndef _ZEBRA_DPLANE_H
  21 #define _ZEBRA_DPLANE_H 1
  22
  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"
  28 #include "lib/vlan.h"
  29 #include "zebra/zebra_ns.h"
  30 #include "zebra/rib.h"
  31 #include "zebra/zserv.h"
  32 #include "zebra/zebra_mpls.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /* Key netlink info from zebra ns */
  39 struct zebra_dplane_info {
  40         ns_id_t ns_id;
  41
  42 #if defined(HAVE_NETLINK)
  43         struct nlsock nls;
  44         bool is_cmd;
  45 #endif
  46 };
  47
  48 /* Utility to fill in zns info from main zns struct */
  49 static inline void
  50 zebra_dplane_info_from_zns(struct zebra_dplane_info *zns_info,
  51                            const struct zebra_ns *zns, bool is_cmd)
  52 {
  53         zns_info->ns_id = zns->ns_id;
  54
  55 #if defined(HAVE_NETLINK)
  56         zns_info->is_cmd = is_cmd;
  57         if (is_cmd) {
  58                 zns_info->nls = zns->netlink_cmd;
  59         } else {
  60                 zns_info->nls = zns->netlink;
  61         }
  62 #endif /* NETLINK */
  63 }
  64
  65 /*
  66  * Result codes used when returning status back to the main zebra context.
  67  */
  68
  69 /*
  70  * Philosophy Note:
  71  *
  72  * Flags being SET/UNSET do not belong in the South Bound
  73  * Interface.  This Setting belongs at the calling level
  74  * because we can and will have multiple different interfaces
  75  * and we will have potentially multiple different
  76  * modules/filters to call.  As such Setting/Unsetting
  77  * success failure should be handled by the caller.
  78  */
  79 enum zebra_dplane_status {
  80         ZEBRA_DPLANE_STATUS_NONE = 0,
  81         ZEBRA_DPLANE_INSTALL_SUCCESS,
  82         ZEBRA_DPLANE_INSTALL_FAILURE,
  83         ZEBRA_DPLANE_DELETE_SUCCESS,
  84         ZEBRA_DPLANE_DELETE_FAILURE,
  85
  86 };
  87
  88 enum zebra_dplane_result {
  89         ZEBRA_DPLANE_REQUEST_QUEUED,
  90         ZEBRA_DPLANE_REQUEST_SUCCESS,
  91         ZEBRA_DPLANE_REQUEST_FAILURE,
  92 };
  93
  94 /*
  95  * API between the zebra dataplane system and the main zebra processing
  96  * context.
  97  */
  98
  99 /*
 100  * Enqueue a route install or update for the dataplane.
 101  */
 102 enum dplane_op_e {
 103         DPLANE_OP_NONE = 0,
 104
 105         /* Route update */
 106         DPLANE_OP_ROUTE_INSTALL,
 107         DPLANE_OP_ROUTE_UPDATE,
 108         DPLANE_OP_ROUTE_DELETE,
 109         DPLANE_OP_ROUTE_NOTIFY,
 110
 111         /* LSP update */
 112         DPLANE_OP_LSP_INSTALL,
 113         DPLANE_OP_LSP_UPDATE,
 114         DPLANE_OP_LSP_DELETE,
 115         DPLANE_OP_LSP_NOTIFY,
 116
 117         /* Pseudowire update */
 118         DPLANE_OP_PW_INSTALL,
 119         DPLANE_OP_PW_UNINSTALL,
 120
 121         /* System route notification */
 122         DPLANE_OP_SYS_ROUTE_ADD,
 123         DPLANE_OP_SYS_ROUTE_DELETE,
 124
 125         /* Interface address update */
 126         DPLANE_OP_ADDR_INSTALL,
 127         DPLANE_OP_ADDR_UNINSTALL,
 128
 129         /* MAC address update */
 130         DPLANE_OP_MAC_INSTALL,
 131         DPLANE_OP_MAC_DELETE,
 132
 133         /* EVPN neighbor updates */
 134         DPLANE_OP_NEIGH_INSTALL,
 135         DPLANE_OP_NEIGH_UPDATE,
 136         DPLANE_OP_NEIGH_DELETE,
 137
 138         /* EVPN VTEP updates */
 139         DPLANE_OP_VTEP_ADD,
 140         DPLANE_OP_VTEP_DELETE,
 141 };
 142
 143 /*
 144  * The vxlan/evpn neighbor management code needs some values to use
 145  * when programming neighbor changes. Offer some platform-neutral values
 146  * here for use within the dplane apis and plugins.
 147  */
 148
 149 /* Neighbor cache flags */
 150 #define DPLANE_NTF_EXT_LEARNED    0x01
 151 #define DPLANE_NTF_ROUTER         0x02
 152
 153 /* Neighbor cache states */
 154 #define DPLANE_NUD_REACHABLE      0x01
 155 #define DPLANE_NUD_STALE          0x02
 156 #define DPLANE_NUD_NOARP          0x04
 157 #define DPLANE_NUD_PROBE          0x08
 158
 159 /* Enable system route notifications */
 160 void dplane_enable_sys_route_notifs(void);
 161
 162 /*
 163  * The dataplane context struct is used to exchange info between the main zebra
 164  * context and the dataplane module(s). If these are two independent pthreads,
 165  * they cannot share existing global data structures safely.
 166  */
 167
 168 /* Define a tailq list type for context blocks. The list is exposed/public,
 169  * but the internal linkage in the context struct is private, so there
 170  * are accessor apis that support enqueue and dequeue.
 171  */
 172 TAILQ_HEAD(dplane_ctx_q, zebra_dplane_ctx);
 173
 174 /* Allocate a context object */
 175 struct zebra_dplane_ctx *dplane_ctx_alloc(void);
 176
 177 /* Return a dataplane results context block after use; the caller's pointer will
 178  * be cleared.
 179  */
 180 void dplane_ctx_fini(struct zebra_dplane_ctx **pctx);
 181
 182 /* Enqueue a context block to caller's tailq. This exists so that the
 183  * context struct can remain opaque.
 184  */
 185 void dplane_ctx_enqueue_tail(struct dplane_ctx_q *q,
 186                              const struct zebra_dplane_ctx *ctx);
 187
 188 /* Append a list of context blocks to another list - again, just keeping
 189  * the context struct opaque.
 190  */
 191 void dplane_ctx_list_append(struct dplane_ctx_q *to_list,
 192                             struct dplane_ctx_q *from_list);
 193
 194 /* Dequeue a context block from the head of caller's tailq */
 195 struct zebra_dplane_ctx *dplane_ctx_dequeue(struct dplane_ctx_q *q);
 196
 197 /*
 198  * Accessors for information from the context object
 199  */
 200 enum zebra_dplane_result dplane_ctx_get_status(
 201         const struct zebra_dplane_ctx *ctx);
 202 void dplane_ctx_set_status(struct zebra_dplane_ctx *ctx,
 203                            enum zebra_dplane_result status);
 204 const char *dplane_res2str(enum zebra_dplane_result res);
 205
 206 enum dplane_op_e dplane_ctx_get_op(const struct zebra_dplane_ctx *ctx);
 207 void dplane_ctx_set_op(struct zebra_dplane_ctx *ctx, enum dplane_op_e op);
 208 const char *dplane_op2str(enum dplane_op_e op);
 209
 210 const struct prefix *dplane_ctx_get_dest(const struct zebra_dplane_ctx *ctx);
 211 void dplane_ctx_set_dest(struct zebra_dplane_ctx *ctx,
 212                          const struct prefix *dest);
 213 const char *dplane_ctx_get_ifname(const struct zebra_dplane_ctx *ctx);
 214 ifindex_t dplane_ctx_get_ifindex(const struct zebra_dplane_ctx *ctx);
 215
 216 /* Retrieve last/current provider id */
 217 uint32_t dplane_ctx_get_provider(const struct zebra_dplane_ctx *ctx);
 218
 219 /* Providers running before the kernel can control whether a kernel
 220  * update should be done.
 221  */
 222 void dplane_ctx_set_skip_kernel(struct zebra_dplane_ctx *ctx);
 223 bool dplane_ctx_is_skip_kernel(const struct zebra_dplane_ctx *ctx);
 224
 225 /* Source prefix is a little special - use convention to return NULL
 226  * to mean "no src prefix"
 227  */
 228 const struct prefix *dplane_ctx_get_src(const struct zebra_dplane_ctx *ctx);
 229 void dplane_ctx_set_src(struct zebra_dplane_ctx *ctx, const struct prefix *src);
 230
 231 bool dplane_ctx_is_update(const struct zebra_dplane_ctx *ctx);
 232 uint32_t dplane_ctx_get_seq(const struct zebra_dplane_ctx *ctx);
 233 uint32_t dplane_ctx_get_old_seq(const struct zebra_dplane_ctx *ctx);
 234 void dplane_ctx_set_vrf(struct zebra_dplane_ctx *ctx, vrf_id_t vrf);
 235 vrf_id_t dplane_ctx_get_vrf(const struct zebra_dplane_ctx *ctx);
 236
 237 bool dplane_ctx_is_from_notif(const struct zebra_dplane_ctx *ctx);
 238 void dplane_ctx_set_notif_provider(struct zebra_dplane_ctx *ctx,
 239                                    uint32_t id);
 240 uint32_t dplane_ctx_get_notif_provider(const struct zebra_dplane_ctx *ctx);
 241
 242 /* Accessors for route update information */
 243 void dplane_ctx_set_type(struct zebra_dplane_ctx *ctx, int type);
 244 int dplane_ctx_get_type(const struct zebra_dplane_ctx *ctx);
 245 int dplane_ctx_get_old_type(const struct zebra_dplane_ctx *ctx);
 246 void dplane_ctx_set_afi(struct zebra_dplane_ctx *ctx, afi_t afi);
 247 afi_t dplane_ctx_get_afi(const struct zebra_dplane_ctx *ctx);
 248 void dplane_ctx_set_safi(struct zebra_dplane_ctx *ctx, safi_t safi);
 249 safi_t dplane_ctx_get_safi(const struct zebra_dplane_ctx *ctx);
 250 void dplane_ctx_set_table(struct zebra_dplane_ctx *ctx, uint32_t table);
 251 uint32_t dplane_ctx_get_table(const struct zebra_dplane_ctx *ctx);
 252 route_tag_t dplane_ctx_get_tag(const struct zebra_dplane_ctx *ctx);
 253 void dplane_ctx_set_tag(struct zebra_dplane_ctx *ctx, route_tag_t tag);
 254 route_tag_t dplane_ctx_get_old_tag(const struct zebra_dplane_ctx *ctx);
 255 uint16_t dplane_ctx_get_instance(const struct zebra_dplane_ctx *ctx);
 256 void dplane_ctx_set_instance(struct zebra_dplane_ctx *ctx, uint16_t instance);
 257 uint16_t dplane_ctx_get_old_instance(const struct zebra_dplane_ctx *ctx);
 258 uint32_t dplane_ctx_get_metric(const struct zebra_dplane_ctx *ctx);
 259 uint32_t dplane_ctx_get_old_metric(const struct zebra_dplane_ctx *ctx);
 260 uint32_t dplane_ctx_get_mtu(const struct zebra_dplane_ctx *ctx);
 261 uint32_t dplane_ctx_get_nh_mtu(const struct zebra_dplane_ctx *ctx);
 262 uint8_t dplane_ctx_get_distance(const struct zebra_dplane_ctx *ctx);
 263 void dplane_ctx_set_distance(struct zebra_dplane_ctx *ctx, uint8_t distance);
 264 uint8_t dplane_ctx_get_old_distance(const struct zebra_dplane_ctx *ctx);
 265
 266 void dplane_ctx_set_nexthops(struct zebra_dplane_ctx *ctx, struct nexthop *nh);
 267 const struct nexthop_group *dplane_ctx_get_ng(
 268         const struct zebra_dplane_ctx *ctx);
 269 const struct nexthop_group *dplane_ctx_get_old_ng(
 270         const struct zebra_dplane_ctx *ctx);
 271
 272 /* Accessors for LSP information */
 273 mpls_label_t dplane_ctx_get_in_label(const struct zebra_dplane_ctx *ctx);
 274 void dplane_ctx_set_in_label(struct zebra_dplane_ctx *ctx,
 275                              mpls_label_t label);
 276 uint8_t dplane_ctx_get_addr_family(const struct zebra_dplane_ctx *ctx);
 277 void dplane_ctx_set_addr_family(struct zebra_dplane_ctx *ctx,
 278                                 uint8_t family);
 279 uint32_t dplane_ctx_get_lsp_flags(const struct zebra_dplane_ctx *ctx);
 280 void dplane_ctx_set_lsp_flags(struct zebra_dplane_ctx *ctx,
 281                               uint32_t flags);
 282 const zebra_nhlfe_t *dplane_ctx_get_nhlfe(const struct zebra_dplane_ctx *ctx);
 283 zebra_nhlfe_t *dplane_ctx_add_nhlfe(struct zebra_dplane_ctx *ctx,
 284                                     enum lsp_types_t lsp_type,
 285                                     enum nexthop_types_t nh_type,
 286                                     union g_addr *gate,
 287                                     ifindex_t ifindex,
 288                                     mpls_label_t out_label);
 289
 290 const zebra_nhlfe_t *dplane_ctx_get_best_nhlfe(
 291         const struct zebra_dplane_ctx *ctx);
 292 const zebra_nhlfe_t *dplane_ctx_set_best_nhlfe(struct zebra_dplane_ctx *ctx,
 293                                                zebra_nhlfe_t *nhlfe);
 294 uint32_t dplane_ctx_get_lsp_num_ecmp(const struct zebra_dplane_ctx *ctx);
 295
 296 /* Accessors for pseudowire information */
 297 mpls_label_t dplane_ctx_get_pw_local_label(const struct zebra_dplane_ctx *ctx);
 298 mpls_label_t dplane_ctx_get_pw_remote_label(const struct zebra_dplane_ctx *ctx);
 299 int dplane_ctx_get_pw_type(const struct zebra_dplane_ctx *ctx);
 300 int dplane_ctx_get_pw_af(const struct zebra_dplane_ctx *ctx);
 301 uint32_t dplane_ctx_get_pw_flags(const struct zebra_dplane_ctx *ctx);
 302 int dplane_ctx_get_pw_status(const struct zebra_dplane_ctx *ctx);
 303 const union g_addr *dplane_ctx_get_pw_dest(
 304         const struct zebra_dplane_ctx *ctx);
 305 const union pw_protocol_fields *dplane_ctx_get_pw_proto(
 306         const struct zebra_dplane_ctx *ctx);
 307 const struct nexthop_group *dplane_ctx_get_pw_nhg(
 308         const struct zebra_dplane_ctx *ctx);
 309
 310 /* Accessors for interface information */
 311 uint32_t dplane_ctx_get_intf_metric(const struct zebra_dplane_ctx *ctx);
 312 /* Is interface addr p2p? */
 313 bool dplane_ctx_intf_is_connected(const struct zebra_dplane_ctx *ctx);
 314 bool dplane_ctx_intf_is_secondary(const struct zebra_dplane_ctx *ctx);
 315 bool dplane_ctx_intf_is_broadcast(const struct zebra_dplane_ctx *ctx);
 316 const struct prefix *dplane_ctx_get_intf_addr(
 317         const struct zebra_dplane_ctx *ctx);
 318 bool dplane_ctx_intf_has_dest(const struct zebra_dplane_ctx *ctx);
 319 const struct prefix *dplane_ctx_get_intf_dest(
 320         const struct zebra_dplane_ctx *ctx);
 321 bool dplane_ctx_intf_has_label(const struct zebra_dplane_ctx *ctx);
 322 const char *dplane_ctx_get_intf_label(const struct zebra_dplane_ctx *ctx);
 323
 324 /* Accessors for MAC information */
 325 vlanid_t dplane_ctx_mac_get_vlan(const struct zebra_dplane_ctx *ctx);
 326 bool dplane_ctx_mac_is_sticky(const struct zebra_dplane_ctx *ctx);
 327 const struct ethaddr *dplane_ctx_mac_get_addr(
 328         const struct zebra_dplane_ctx *ctx);
 329 const struct in_addr *dplane_ctx_mac_get_vtep_ip(
 330         const struct zebra_dplane_ctx *ctx);
 331
 332 /* Accessors for neighbor information */
 333 const struct ipaddr *dplane_ctx_neigh_get_ipaddr(
 334         const struct zebra_dplane_ctx *ctx);
 335 const struct ethaddr *dplane_ctx_neigh_get_mac(
 336         const struct zebra_dplane_ctx *ctx);
 337 uint32_t dplane_ctx_neigh_get_flags(const struct zebra_dplane_ctx *ctx);
 338 uint16_t dplane_ctx_neigh_get_state(const struct zebra_dplane_ctx *ctx);
 339
 340 /* Namespace info - esp. for netlink communication */
 341 const struct zebra_dplane_info *dplane_ctx_get_ns(
 342         const struct zebra_dplane_ctx *ctx);
 343
 344 /* Indicates zebra shutdown/exit is in progress. Some operations may be
 345  * simplified or skipped during shutdown processing.
 346  */
 347 bool dplane_is_in_shutdown(void);
 348
 349 /*
 350  * Enqueue route change operations for the dataplane.
 351  */
 352 enum zebra_dplane_result dplane_route_add(struct route_node *rn,
 353                                           struct route_entry *re);
 354
 355 enum zebra_dplane_result dplane_route_update(struct route_node *rn,
 356                                              struct route_entry *re,
 357                                              struct route_entry *old_re);
 358
 359 enum zebra_dplane_result dplane_route_delete(struct route_node *rn,
 360                                              struct route_entry *re);
 361
 362 /* Notify the dplane when system/connected routes change */
 363 enum zebra_dplane_result dplane_sys_route_add(struct route_node *rn,
 364                                               struct route_entry *re);
 365 enum zebra_dplane_result dplane_sys_route_del(struct route_node *rn,
 366                                               struct route_entry *re);
 367
 368 /* Update from an async notification, to bring other fibs up-to-date */
 369 enum zebra_dplane_result dplane_route_notif_update(
 370         struct route_node *rn,
 371         struct route_entry *re,
 372         enum dplane_op_e op,
 373         struct zebra_dplane_ctx *ctx);
 374
 375 /*
 376  * Enqueue LSP change operations for the dataplane.
 377  */
 378 enum zebra_dplane_result dplane_lsp_add(zebra_lsp_t *lsp);
 379 enum zebra_dplane_result dplane_lsp_update(zebra_lsp_t *lsp);
 380 enum zebra_dplane_result dplane_lsp_delete(zebra_lsp_t *lsp);
 381
 382 /* Update or un-install resulting from an async notification */
 383 enum zebra_dplane_result dplane_lsp_notif_update(zebra_lsp_t *lsp,
 384                                                  enum dplane_op_e op,
 385                                                  struct zebra_dplane_ctx *ctx);
 386
 387 /*
 388  * Enqueue pseudowire operations for the dataplane.
 389  */
 390 enum zebra_dplane_result dplane_pw_install(struct zebra_pw *pw);
 391 enum zebra_dplane_result dplane_pw_uninstall(struct zebra_pw *pw);
 392
 393 /*
 394  * Enqueue interface address changes for the dataplane.
 395  */
 396 enum zebra_dplane_result dplane_intf_addr_set(const struct interface *ifp,
 397                                               const struct connected *ifc);
 398 enum zebra_dplane_result dplane_intf_addr_unset(const struct interface *ifp,
 399                                                 const struct connected *ifc);
 400
 401 /*
 402  * Enqueue evpn mac operations for the dataplane.
 403  */
 404 enum zebra_dplane_result dplane_mac_add(const struct interface *ifp,
 405                                         vlanid_t vid,
 406                                         const struct ethaddr *mac,
 407                                         struct in_addr vtep_ip,
 408                                         bool sticky);
 409
 410 enum zebra_dplane_result dplane_mac_del(const struct interface *ifp,
 411                                         vlanid_t vid,
 412                                         const struct ethaddr *mac,
 413                                         struct in_addr vtep_ip);
 414
 415 /*
 416  * Enqueue evpn neighbor updates for the dataplane.
 417  */
 418 enum zebra_dplane_result dplane_neigh_add(const struct interface *ifp,
 419                                           const struct ipaddr *ip,
 420                                           const struct ethaddr *mac,
 421                                           uint32_t flags);
 422 enum zebra_dplane_result dplane_neigh_update(const struct interface *ifp,
 423                                              const struct ipaddr *ip,
 424                                              const struct ethaddr *mac);
 425 enum zebra_dplane_result dplane_neigh_delete(const struct interface *ifp,
 426                                              const struct ipaddr *ip);
 427
 428 /*
 429  * Enqueue evpn VTEP updates for the dataplane.
 430  */
 431 enum zebra_dplane_result dplane_vtep_add(const struct interface *ifp,
 432                                          const struct in_addr *ip,
 433                                          vni_t vni);
 434 enum zebra_dplane_result dplane_vtep_delete(const struct interface *ifp,
 435                                             const struct in_addr *ip,
 436                                             vni_t vni);
 437
 438
 439 /* Retrieve the limit on the number of pending, unprocessed updates. */
 440 uint32_t dplane_get_in_queue_limit(void);
 441
 442 /* Configure limit on the number of pending, queued updates. If 'unset', reset
 443  * to default value.
 444  */
 445 void dplane_set_in_queue_limit(uint32_t limit, bool set);
 446
 447 /* Retrieve the current queue depth of incoming, unprocessed updates */
 448 uint32_t dplane_get_in_queue_len(void);
 449
 450 /*
 451  * Vty/cli apis
 452  */
 453 int dplane_show_helper(struct vty *vty, bool detailed);
 454 int dplane_show_provs_helper(struct vty *vty, bool detailed);
 455 int dplane_config_write_helper(struct vty *vty);
 456
 457 /*
 458  * Dataplane providers: modules that process or consume dataplane events.
 459  */
 460
 461 struct zebra_dplane_provider;
 462
 463 /* Support string name for a dataplane provider */
 464 #define DPLANE_PROVIDER_NAMELEN 64
 465
 466 /* Priority or ordering values for providers. The idea is that there may be
 467  * some pre-processing, followed by an external or remote dataplane,
 468  * followed by the kernel, followed by some post-processing step (such as
 469  * the fpm output stream.)
 470  */
 471 enum dplane_provider_prio {
 472         DPLANE_PRIO_NONE = 0,
 473         DPLANE_PRIO_PREPROCESS,
 474         DPLANE_PRIO_PRE_KERNEL,
 475         DPLANE_PRIO_KERNEL,
 476         DPLANE_PRIO_POSTPROCESS,
 477         DPLANE_PRIO_LAST
 478 };
 479
 480 /* Flags values used during provider registration. */
 481 #define DPLANE_PROV_FLAGS_DEFAULT  0x0
 482
 483 /* Provider will be spawning its own worker thread */
 484 #define DPLANE_PROV_FLAG_THREADED  0x1
 485
 486
 487 /* Provider registration: ordering or priority value, callbacks, and optional
 488  * opaque data value. If 'prov_p', return the newly-allocated provider object
 489  * on success.
 490  */
 491
 492 /* Providers offer an entry-point for incoming work, called in the context of
 493  * the dataplane pthread. The dataplane pthread enqueues any new work to the
 494  * provider's 'inbound' queue, then calls the callback. The dataplane
 495  * then checks the provider's outbound queue for completed work.
 496  */
 497
 498 /*
 499  * Providers can offer a 'start' callback; if present, the dataplane will
 500  * call it when it is starting - when its pthread and event-scheduling
 501  * thread_master are available.
 502  */
 503
 504 /* Providers can offer an entry-point for shutdown and cleanup. This is called
 505  * with 'early' during shutdown, to indicate that the dataplane subsystem
 506  * is allowing work to move through the providers and finish.
 507  * When called without 'early', the provider should release
 508  * all resources (if it has any allocated).
 509  */
 510 int dplane_provider_register(const char *name,
 511                              enum dplane_provider_prio prio,
 512                              int flags,
 513                              int (*start_fp)(struct zebra_dplane_provider *),
 514                              int (*fp)(struct zebra_dplane_provider *),
 515                              int (*fini_fp)(struct zebra_dplane_provider *,
 516                                             bool early),
 517                              void *data,
 518                              struct zebra_dplane_provider **prov_p);
 519
 520 /* Accessors for provider attributes */
 521 const char *dplane_provider_get_name(const struct zebra_dplane_provider *prov);
 522 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider *prov);
 523 void *dplane_provider_get_data(const struct zebra_dplane_provider *prov);
 524 bool dplane_provider_is_threaded(const struct zebra_dplane_provider *prov);
 525
 526 /* Lock/unlock a provider's mutex - iff the provider was registered with
 527  * the THREADED flag.
 528  */
 529 void dplane_provider_lock(struct zebra_dplane_provider *prov);
 530 void dplane_provider_unlock(struct zebra_dplane_provider *prov);
 531
 532 /* Obtain thread_master for dataplane thread */
 533 struct thread_master *dplane_get_thread_master(void);
 534
 535 /* Providers should (generally) limit number of updates per work cycle */
 536 int dplane_provider_get_work_limit(const struct zebra_dplane_provider *prov);
 537
 538 /* Provider api to signal that work/events are available
 539  * for the dataplane pthread.
 540  */
 541 int dplane_provider_work_ready(void);
 542
 543 /* Dequeue, maintain associated counter and locking */
 544 struct zebra_dplane_ctx *dplane_provider_dequeue_in_ctx(
 545         struct zebra_dplane_provider *prov);
 546
 547 /* Dequeue work to a list, maintain counter and locking, return count */
 548 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider *prov,
 549                                     struct dplane_ctx_q *listp);
 550
 551 /* Enqueue completed work, maintain associated counter and locking */
 552 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider *prov,
 553                                      struct zebra_dplane_ctx *ctx);
 554
 555 /* Enqueue a context directly to zebra main. */
 556 void dplane_provider_enqueue_to_zebra(struct zebra_dplane_ctx *ctx);
 557
 558 /*
 559  * Initialize the dataplane modules at zebra startup. This is currently called
 560  * by the rib module. Zebra registers a results callback with the dataplane.
 561  * The callback is called in the dataplane pthread context,
 562  * so the expectation is that the contexts are queued for the zebra
 563  * main pthread.
 564  */
 565 void zebra_dplane_init(int (*) (struct dplane_ctx_q *));
 566
 567 /*
 568  * Start the dataplane pthread. This step needs to be run later than the
 569  * 'init' step, in case zebra has fork-ed.
 570  */
 571 void zebra_dplane_start(void);
 572
 573 /* Finalize/cleanup apis, one called early as shutdown is starting,
 574  * one called late at the end of zebra shutdown, and then one called
 575  * from the zebra main pthread to stop the dplane pthread and
 576  * free all resources.
 577  *
 578  * Zebra expects to try to clean up all vrfs and all routes during
 579  * shutdown, so the dplane must be available until very late.
 580  */
 581 void zebra_dplane_pre_finish(void);
 582 void zebra_dplane_finish(void);
 583 void zebra_dplane_shutdown(void);
 584
 585 #ifdef __cplusplus
 586 }
 587 #endif
 588
 589 #endif  /* _ZEBRA_DPLANE_H */