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"
28 #include "zebra/zebra_ns.h"
29 #include "zebra/rib.h"
30 #include "zebra/zserv.h"
31 #include "zebra/zebra_mpls.h"
37 /* Key netlink info from zebra ns */
38 struct zebra_dplane_info
{
41 #if defined(HAVE_NETLINK)
47 /* Utility to fill in zns info from main zns struct */
49 zebra_dplane_info_from_zns(struct zebra_dplane_info
*zns_info
,
50 const struct zebra_ns
*zns
, bool is_cmd
)
52 zns_info
->ns_id
= zns
->ns_id
;
54 #if defined(HAVE_NETLINK)
55 zns_info
->is_cmd
= is_cmd
;
57 zns_info
->nls
= zns
->netlink_cmd
;
59 zns_info
->nls
= zns
->netlink
;
65 * Result codes used when returning status back to the main zebra context.
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.
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
,
87 enum zebra_dplane_result
{
88 ZEBRA_DPLANE_REQUEST_QUEUED
,
89 ZEBRA_DPLANE_REQUEST_SUCCESS
,
90 ZEBRA_DPLANE_REQUEST_FAILURE
,
94 * API between the zebra dataplane system and the main zebra processing
99 * Enqueue a route install or update for the dataplane.
105 DPLANE_OP_ROUTE_INSTALL
,
106 DPLANE_OP_ROUTE_UPDATE
,
107 DPLANE_OP_ROUTE_DELETE
,
110 DPLANE_OP_LSP_INSTALL
,
111 DPLANE_OP_LSP_UPDATE
,
112 DPLANE_OP_LSP_DELETE
,
114 /* Pseudowire update */
115 DPLANE_OP_PW_INSTALL
,
116 DPLANE_OP_PW_UNINSTALL
,
118 /* System route notification */
119 DPLANE_OP_SYS_ROUTE_ADD
,
120 DPLANE_OP_SYS_ROUTE_DELETE
,
122 /* Interface address update */
123 DPLANE_OP_ADDR_INSTALL
,
124 DPLANE_OP_ADDR_UNINSTALL
,
127 /* Enable system route notifications */
128 void dplane_enable_sys_route_notifs(void);
131 * The dataplane context struct is used to exchange info between the main zebra
132 * context and the dataplane module(s). If these are two independent pthreads,
133 * they cannot share existing global data structures safely.
136 /* Define a tailq list type for context blocks. The list is exposed/public,
137 * but the internal linkage in the context struct is private, so there
138 * are accessor apis that support enqueue and dequeue.
140 TAILQ_HEAD(dplane_ctx_q
, zebra_dplane_ctx
);
142 /* Return a dataplane results context block after use; the caller's pointer will
145 void dplane_ctx_fini(struct zebra_dplane_ctx
**pctx
);
147 /* Enqueue a context block to caller's tailq. This exists so that the
148 * context struct can remain opaque.
150 void dplane_ctx_enqueue_tail(struct dplane_ctx_q
*q
,
151 const struct zebra_dplane_ctx
*ctx
);
153 /* Append a list of context blocks to another list - again, just keeping
154 * the context struct opaque.
156 void dplane_ctx_list_append(struct dplane_ctx_q
*to_list
,
157 struct dplane_ctx_q
*from_list
);
159 /* Dequeue a context block from the head of caller's tailq */
160 struct zebra_dplane_ctx
*dplane_ctx_dequeue(struct dplane_ctx_q
*q
);
163 * Accessors for information from the context object
165 enum zebra_dplane_result
dplane_ctx_get_status(
166 const struct zebra_dplane_ctx
*ctx
);
167 void dplane_ctx_set_status(struct zebra_dplane_ctx
*ctx
,
168 enum zebra_dplane_result status
);
169 const char *dplane_res2str(enum zebra_dplane_result res
);
171 enum dplane_op_e
dplane_ctx_get_op(const struct zebra_dplane_ctx
*ctx
);
172 const char *dplane_op2str(enum dplane_op_e op
);
174 const struct prefix
*dplane_ctx_get_dest(const struct zebra_dplane_ctx
*ctx
);
176 /* Retrieve last/current provider id */
177 uint32_t dplane_ctx_get_provider(const struct zebra_dplane_ctx
*ctx
);
179 /* Providers running before the kernel can control whether a kernel
180 * update should be done.
182 void dplane_ctx_set_skip_kernel(struct zebra_dplane_ctx
*ctx
);
183 bool dplane_ctx_is_skip_kernel(const struct zebra_dplane_ctx
*ctx
);
185 /* Source prefix is a little special - use convention to return NULL
186 * to mean "no src prefix"
188 const struct prefix
*dplane_ctx_get_src(const struct zebra_dplane_ctx
*ctx
);
190 bool dplane_ctx_is_update(const struct zebra_dplane_ctx
*ctx
);
191 uint32_t dplane_ctx_get_seq(const struct zebra_dplane_ctx
*ctx
);
192 uint32_t dplane_ctx_get_old_seq(const struct zebra_dplane_ctx
*ctx
);
193 vrf_id_t
dplane_ctx_get_vrf(const struct zebra_dplane_ctx
*ctx
);
195 /* Accessors for route update information */
196 int dplane_ctx_get_type(const struct zebra_dplane_ctx
*ctx
);
197 int dplane_ctx_get_old_type(const struct zebra_dplane_ctx
*ctx
);
198 afi_t
dplane_ctx_get_afi(const struct zebra_dplane_ctx
*ctx
);
199 safi_t
dplane_ctx_get_safi(const struct zebra_dplane_ctx
*ctx
);
200 uint32_t dplane_ctx_get_table(const struct zebra_dplane_ctx
*ctx
);
201 route_tag_t
dplane_ctx_get_tag(const struct zebra_dplane_ctx
*ctx
);
202 route_tag_t
dplane_ctx_get_old_tag(const struct zebra_dplane_ctx
*ctx
);
203 uint16_t dplane_ctx_get_instance(const struct zebra_dplane_ctx
*ctx
);
204 uint16_t dplane_ctx_get_old_instance(const struct zebra_dplane_ctx
*ctx
);
205 uint32_t dplane_ctx_get_metric(const struct zebra_dplane_ctx
*ctx
);
206 uint32_t dplane_ctx_get_old_metric(const struct zebra_dplane_ctx
*ctx
);
207 uint32_t dplane_ctx_get_mtu(const struct zebra_dplane_ctx
*ctx
);
208 uint32_t dplane_ctx_get_nh_mtu(const struct zebra_dplane_ctx
*ctx
);
209 uint8_t dplane_ctx_get_distance(const struct zebra_dplane_ctx
*ctx
);
210 uint8_t dplane_ctx_get_old_distance(const struct zebra_dplane_ctx
*ctx
);
212 const struct nexthop_group
*dplane_ctx_get_ng(
213 const struct zebra_dplane_ctx
*ctx
);
214 const struct nexthop_group
*dplane_ctx_get_old_ng(
215 const struct zebra_dplane_ctx
*ctx
);
217 /* Accessors for LSP information */
218 mpls_label_t
dplane_ctx_get_in_label(const struct zebra_dplane_ctx
*ctx
);
219 uint8_t dplane_ctx_get_addr_family(const struct zebra_dplane_ctx
*ctx
);
220 uint32_t dplane_ctx_get_lsp_flags(const struct zebra_dplane_ctx
*ctx
);
221 const zebra_nhlfe_t
*dplane_ctx_get_nhlfe(const struct zebra_dplane_ctx
*ctx
);
222 const zebra_nhlfe_t
*dplane_ctx_get_best_nhlfe(
223 const struct zebra_dplane_ctx
*ctx
);
224 uint32_t dplane_ctx_get_lsp_num_ecmp(const struct zebra_dplane_ctx
*ctx
);
226 /* Accessors for pseudowire information */
227 const char *dplane_ctx_get_pw_ifname(const struct zebra_dplane_ctx
*ctx
);
228 mpls_label_t
dplane_ctx_get_pw_local_label(const struct zebra_dplane_ctx
*ctx
);
229 mpls_label_t
dplane_ctx_get_pw_remote_label(const struct zebra_dplane_ctx
*ctx
);
230 int dplane_ctx_get_pw_type(const struct zebra_dplane_ctx
*ctx
);
231 int dplane_ctx_get_pw_af(const struct zebra_dplane_ctx
*ctx
);
232 uint32_t dplane_ctx_get_pw_flags(const struct zebra_dplane_ctx
*ctx
);
233 int dplane_ctx_get_pw_status(const struct zebra_dplane_ctx
*ctx
);
234 const union g_addr
*dplane_ctx_get_pw_dest(
235 const struct zebra_dplane_ctx
*ctx
);
236 const union pw_protocol_fields
*dplane_ctx_get_pw_proto(
237 const struct zebra_dplane_ctx
*ctx
);
238 const struct nexthop_group
*dplane_ctx_get_pw_nhg(
239 const struct zebra_dplane_ctx
*ctx
);
241 /* Accessors for interface information */
242 const char *dplane_ctx_get_ifname(const struct zebra_dplane_ctx
*ctx
);
243 ifindex_t
dplane_ctx_get_ifindex(const struct zebra_dplane_ctx
*ctx
);
244 uint32_t dplane_ctx_get_intf_metric(const struct zebra_dplane_ctx
*ctx
);
245 /* Is interface addr p2p? */
246 bool dplane_ctx_intf_is_connected(const struct zebra_dplane_ctx
*ctx
);
247 bool dplane_ctx_intf_is_secondary(const struct zebra_dplane_ctx
*ctx
);
248 bool dplane_ctx_intf_is_broadcast(const struct zebra_dplane_ctx
*ctx
);
249 const struct prefix
*dplane_ctx_get_intf_addr(
250 const struct zebra_dplane_ctx
*ctx
);
251 bool dplane_ctx_intf_has_dest(const struct zebra_dplane_ctx
*ctx
);
252 const struct prefix
*dplane_ctx_get_intf_dest(
253 const struct zebra_dplane_ctx
*ctx
);
254 bool dplane_ctx_intf_has_label(const struct zebra_dplane_ctx
*ctx
);
255 const char *dplane_ctx_get_intf_label(const struct zebra_dplane_ctx
*ctx
);
257 /* Namespace info - esp. for netlink communication */
258 const struct zebra_dplane_info
*dplane_ctx_get_ns(
259 const struct zebra_dplane_ctx
*ctx
);
261 /* Indicates zebra shutdown/exit is in progress. Some operations may be
262 * simplified or skipped during shutdown processing.
264 bool dplane_is_in_shutdown(void);
267 * Enqueue route change operations for the dataplane.
269 enum zebra_dplane_result
dplane_route_add(struct route_node
*rn
,
270 struct route_entry
*re
);
272 enum zebra_dplane_result
dplane_route_update(struct route_node
*rn
,
273 struct route_entry
*re
,
274 struct route_entry
*old_re
);
276 enum zebra_dplane_result
dplane_route_delete(struct route_node
*rn
,
277 struct route_entry
*re
);
279 /* Notify the dplane when system/connected routes change */
280 enum zebra_dplane_result
dplane_sys_route_add(struct route_node
*rn
,
281 struct route_entry
*re
);
282 enum zebra_dplane_result
dplane_sys_route_del(struct route_node
*rn
,
283 struct route_entry
*re
);
286 * Enqueue LSP change operations for the dataplane.
288 enum zebra_dplane_result
dplane_lsp_add(zebra_lsp_t
*lsp
);
289 enum zebra_dplane_result
dplane_lsp_update(zebra_lsp_t
*lsp
);
290 enum zebra_dplane_result
dplane_lsp_delete(zebra_lsp_t
*lsp
);
293 * Enqueue pseudowire operations for the dataplane.
295 enum zebra_dplane_result
dplane_pw_install(struct zebra_pw
*pw
);
296 enum zebra_dplane_result
dplane_pw_uninstall(struct zebra_pw
*pw
);
299 * Enqueue interface address changes for the dataplane.
301 enum zebra_dplane_result
dplane_intf_addr_set(const struct interface
*ifp
,
302 const struct connected
*ifc
);
303 enum zebra_dplane_result
dplane_intf_addr_unset(const struct interface
*ifp
,
304 const struct connected
*ifc
);
307 /* Retrieve the limit on the number of pending, unprocessed updates. */
308 uint32_t dplane_get_in_queue_limit(void);
310 /* Configure limit on the number of pending, queued updates. If 'unset', reset
313 void dplane_set_in_queue_limit(uint32_t limit
, bool set
);
315 /* Retrieve the current queue depth of incoming, unprocessed updates */
316 uint32_t dplane_get_in_queue_len(void);
321 int dplane_show_helper(struct vty
*vty
, bool detailed
);
322 int dplane_show_provs_helper(struct vty
*vty
, bool detailed
);
326 * Dataplane providers: modules that process or consume dataplane events.
329 struct zebra_dplane_provider
;
331 /* Support string name for a dataplane provider */
332 #define DPLANE_PROVIDER_NAMELEN 64
334 /* Priority or ordering values for providers. The idea is that there may be
335 * some pre-processing, followed by an external or remote dataplane,
336 * followed by the kernel, followed by some post-processing step (such as
337 * the fpm output stream.)
339 enum dplane_provider_prio
{
340 DPLANE_PRIO_NONE
= 0,
341 DPLANE_PRIO_PREPROCESS
,
342 DPLANE_PRIO_PRE_KERNEL
,
344 DPLANE_PRIO_POSTPROCESS
,
348 /* Flags values used during provider registration. */
349 #define DPLANE_PROV_FLAGS_DEFAULT 0x0
351 /* Provider will be spawning its own worker thread */
352 #define DPLANE_PROV_FLAG_THREADED 0x1
355 /* Provider registration: ordering or priority value, callbacks, and optional
356 * opaque data value. If 'prov_p', return the newly-allocated provider object
360 /* Providers offer an entry-point for incoming work, called in the context of
361 * the dataplane pthread. The dataplane pthread enqueues any new work to the
362 * provider's 'inbound' queue, then calls the callback. The dataplane
363 * then checks the provider's outbound queue for completed work.
366 /* Providers offer an entry-point for shutdown and cleanup. This is called
367 * with 'early' during shutdown, to indicate that the dataplane subsystem
368 * is allowing work to move through the providers and finish.
369 * When called without 'early', the provider should release
370 * all resources (if it has any allocated).
372 int dplane_provider_register(const char *name
,
373 enum dplane_provider_prio prio
,
375 int (*fp
)(struct zebra_dplane_provider
*),
376 int (*fini_fp
)(struct zebra_dplane_provider
*,
379 struct zebra_dplane_provider
**prov_p
);
381 /* Accessors for provider attributes */
382 const char *dplane_provider_get_name(const struct zebra_dplane_provider
*prov
);
383 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider
*prov
);
384 void *dplane_provider_get_data(const struct zebra_dplane_provider
*prov
);
385 bool dplane_provider_is_threaded(const struct zebra_dplane_provider
*prov
);
387 /* Lock/unlock a provider's mutex - iff the provider was registered with
390 void dplane_provider_lock(struct zebra_dplane_provider
*prov
);
391 void dplane_provider_unlock(struct zebra_dplane_provider
*prov
);
393 /* Obtain thread_master for dataplane thread */
394 struct thread_master
*dplane_get_thread_master(void);
396 /* Providers should (generally) limit number of updates per work cycle */
397 int dplane_provider_get_work_limit(const struct zebra_dplane_provider
*prov
);
399 /* Provider api to signal that work/events are available
400 * for the dataplane pthread.
402 int dplane_provider_work_ready(void);
404 /* Dequeue, maintain associated counter and locking */
405 struct zebra_dplane_ctx
*dplane_provider_dequeue_in_ctx(
406 struct zebra_dplane_provider
*prov
);
408 /* Dequeue work to a list, maintain counter and locking, return count */
409 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider
*prov
,
410 struct dplane_ctx_q
*listp
);
412 /* Enqueue, maintain associated counter and locking */
413 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider
*prov
,
414 struct zebra_dplane_ctx
*ctx
);
417 * Initialize the dataplane modules at zebra startup. This is currently called
418 * by the rib module. Zebra registers a results callback with the dataplane.
419 * The callback is called in the dataplane pthread context,
420 * so the expectation is that the contexts are queued for the zebra
423 void zebra_dplane_init(int (*) (struct dplane_ctx_q
*));
426 * Start the dataplane pthread. This step needs to be run later than the
427 * 'init' step, in case zebra has fork-ed.
429 void zebra_dplane_start(void);
431 /* Finalize/cleanup apis, one called early as shutdown is starting,
432 * one called late at the end of zebra shutdown, and then one called
433 * from the zebra main pthread to stop the dplane pthread and
434 * free all resources.
436 * Zebra expects to try to clean up all vrfs and all routes during
437 * shutdown, so the dplane must be available until very late.
439 void zebra_dplane_pre_finish(void);
440 void zebra_dplane_finish(void);
441 void zebra_dplane_shutdown(void);
447 #endif /* _ZEBRA_DPLANE_H */