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