]> git.proxmox.com Git - mirror_frr.git/blob - zebra/zebra_dplane.h
Merge pull request #4821 from vishaldhingra/lcomm_json
[mirror_frr.git] / 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
134 /* Enable system route notifications */
135 void dplane_enable_sys_route_notifs(void);
136
137 /*
138 * The dataplane context struct is used to exchange info between the main zebra
139 * context and the dataplane module(s). If these are two independent pthreads,
140 * they cannot share existing global data structures safely.
141 */
142
143 /* Define a tailq list type for context blocks. The list is exposed/public,
144 * but the internal linkage in the context struct is private, so there
145 * are accessor apis that support enqueue and dequeue.
146 */
147 TAILQ_HEAD(dplane_ctx_q, zebra_dplane_ctx);
148
149 /* Allocate a context object */
150 struct zebra_dplane_ctx *dplane_ctx_alloc(void);
151
152 /* Return a dataplane results context block after use; the caller's pointer will
153 * be cleared.
154 */
155 void dplane_ctx_fini(struct zebra_dplane_ctx **pctx);
156
157 /* Enqueue a context block to caller's tailq. This exists so that the
158 * context struct can remain opaque.
159 */
160 void dplane_ctx_enqueue_tail(struct dplane_ctx_q *q,
161 const struct zebra_dplane_ctx *ctx);
162
163 /* Append a list of context blocks to another list - again, just keeping
164 * the context struct opaque.
165 */
166 void dplane_ctx_list_append(struct dplane_ctx_q *to_list,
167 struct dplane_ctx_q *from_list);
168
169 /* Dequeue a context block from the head of caller's tailq */
170 struct zebra_dplane_ctx *dplane_ctx_dequeue(struct dplane_ctx_q *q);
171
172 /*
173 * Accessors for information from the context object
174 */
175 enum zebra_dplane_result dplane_ctx_get_status(
176 const struct zebra_dplane_ctx *ctx);
177 void dplane_ctx_set_status(struct zebra_dplane_ctx *ctx,
178 enum zebra_dplane_result status);
179 const char *dplane_res2str(enum zebra_dplane_result res);
180
181 enum dplane_op_e dplane_ctx_get_op(const struct zebra_dplane_ctx *ctx);
182 void dplane_ctx_set_op(struct zebra_dplane_ctx *ctx, enum dplane_op_e op);
183 const char *dplane_op2str(enum dplane_op_e op);
184
185 const struct prefix *dplane_ctx_get_dest(const struct zebra_dplane_ctx *ctx);
186 void dplane_ctx_set_dest(struct zebra_dplane_ctx *ctx,
187 const struct prefix *dest);
188 const char *dplane_ctx_get_ifname(const struct zebra_dplane_ctx *ctx);
189 ifindex_t dplane_ctx_get_ifindex(const struct zebra_dplane_ctx *ctx);
190
191 /* Retrieve last/current provider id */
192 uint32_t dplane_ctx_get_provider(const struct zebra_dplane_ctx *ctx);
193
194 /* Providers running before the kernel can control whether a kernel
195 * update should be done.
196 */
197 void dplane_ctx_set_skip_kernel(struct zebra_dplane_ctx *ctx);
198 bool dplane_ctx_is_skip_kernel(const struct zebra_dplane_ctx *ctx);
199
200 /* Source prefix is a little special - use convention to return NULL
201 * to mean "no src prefix"
202 */
203 const struct prefix *dplane_ctx_get_src(const struct zebra_dplane_ctx *ctx);
204 void dplane_ctx_set_src(struct zebra_dplane_ctx *ctx, const struct prefix *src);
205
206 bool dplane_ctx_is_update(const struct zebra_dplane_ctx *ctx);
207 uint32_t dplane_ctx_get_seq(const struct zebra_dplane_ctx *ctx);
208 uint32_t dplane_ctx_get_old_seq(const struct zebra_dplane_ctx *ctx);
209 void dplane_ctx_set_vrf(struct zebra_dplane_ctx *ctx, vrf_id_t vrf);
210 vrf_id_t dplane_ctx_get_vrf(const struct zebra_dplane_ctx *ctx);
211
212 bool dplane_ctx_is_from_notif(const struct zebra_dplane_ctx *ctx);
213 void dplane_ctx_set_notif_provider(struct zebra_dplane_ctx *ctx,
214 uint32_t id);
215 uint32_t dplane_ctx_get_notif_provider(const struct zebra_dplane_ctx *ctx);
216
217 /* Accessors for route update information */
218 void dplane_ctx_set_type(struct zebra_dplane_ctx *ctx, int type);
219 int dplane_ctx_get_type(const struct zebra_dplane_ctx *ctx);
220 int dplane_ctx_get_old_type(const struct zebra_dplane_ctx *ctx);
221 void dplane_ctx_set_afi(struct zebra_dplane_ctx *ctx, afi_t afi);
222 afi_t dplane_ctx_get_afi(const struct zebra_dplane_ctx *ctx);
223 void dplane_ctx_set_safi(struct zebra_dplane_ctx *ctx, safi_t safi);
224 safi_t dplane_ctx_get_safi(const struct zebra_dplane_ctx *ctx);
225 void dplane_ctx_set_table(struct zebra_dplane_ctx *ctx, uint32_t table);
226 uint32_t dplane_ctx_get_table(const struct zebra_dplane_ctx *ctx);
227 route_tag_t dplane_ctx_get_tag(const struct zebra_dplane_ctx *ctx);
228 void dplane_ctx_set_tag(struct zebra_dplane_ctx *ctx, route_tag_t tag);
229 route_tag_t dplane_ctx_get_old_tag(const struct zebra_dplane_ctx *ctx);
230 uint16_t dplane_ctx_get_instance(const struct zebra_dplane_ctx *ctx);
231 void dplane_ctx_set_instance(struct zebra_dplane_ctx *ctx, uint16_t instance);
232 uint16_t dplane_ctx_get_old_instance(const struct zebra_dplane_ctx *ctx);
233 uint32_t dplane_ctx_get_metric(const struct zebra_dplane_ctx *ctx);
234 uint32_t dplane_ctx_get_old_metric(const struct zebra_dplane_ctx *ctx);
235 uint32_t dplane_ctx_get_mtu(const struct zebra_dplane_ctx *ctx);
236 uint32_t dplane_ctx_get_nh_mtu(const struct zebra_dplane_ctx *ctx);
237 uint8_t dplane_ctx_get_distance(const struct zebra_dplane_ctx *ctx);
238 void dplane_ctx_set_distance(struct zebra_dplane_ctx *ctx, uint8_t distance);
239 uint8_t dplane_ctx_get_old_distance(const struct zebra_dplane_ctx *ctx);
240
241 void dplane_ctx_set_nexthops(struct zebra_dplane_ctx *ctx, struct nexthop *nh);
242 const struct nexthop_group *dplane_ctx_get_ng(
243 const struct zebra_dplane_ctx *ctx);
244 const struct nexthop_group *dplane_ctx_get_old_ng(
245 const struct zebra_dplane_ctx *ctx);
246
247 /* Accessors for LSP information */
248 mpls_label_t dplane_ctx_get_in_label(const struct zebra_dplane_ctx *ctx);
249 void dplane_ctx_set_in_label(struct zebra_dplane_ctx *ctx,
250 mpls_label_t label);
251 uint8_t dplane_ctx_get_addr_family(const struct zebra_dplane_ctx *ctx);
252 void dplane_ctx_set_addr_family(struct zebra_dplane_ctx *ctx,
253 uint8_t family);
254 uint32_t dplane_ctx_get_lsp_flags(const struct zebra_dplane_ctx *ctx);
255 void dplane_ctx_set_lsp_flags(struct zebra_dplane_ctx *ctx,
256 uint32_t flags);
257 const zebra_nhlfe_t *dplane_ctx_get_nhlfe(const struct zebra_dplane_ctx *ctx);
258 zebra_nhlfe_t *dplane_ctx_add_nhlfe(struct zebra_dplane_ctx *ctx,
259 enum lsp_types_t lsp_type,
260 enum nexthop_types_t nh_type,
261 union g_addr *gate,
262 ifindex_t ifindex,
263 mpls_label_t out_label);
264
265 const zebra_nhlfe_t *dplane_ctx_get_best_nhlfe(
266 const struct zebra_dplane_ctx *ctx);
267 const zebra_nhlfe_t *dplane_ctx_set_best_nhlfe(struct zebra_dplane_ctx *ctx,
268 zebra_nhlfe_t *nhlfe);
269 uint32_t dplane_ctx_get_lsp_num_ecmp(const struct zebra_dplane_ctx *ctx);
270
271 /* Accessors for pseudowire information */
272 mpls_label_t dplane_ctx_get_pw_local_label(const struct zebra_dplane_ctx *ctx);
273 mpls_label_t dplane_ctx_get_pw_remote_label(const struct zebra_dplane_ctx *ctx);
274 int dplane_ctx_get_pw_type(const struct zebra_dplane_ctx *ctx);
275 int dplane_ctx_get_pw_af(const struct zebra_dplane_ctx *ctx);
276 uint32_t dplane_ctx_get_pw_flags(const struct zebra_dplane_ctx *ctx);
277 int dplane_ctx_get_pw_status(const struct zebra_dplane_ctx *ctx);
278 const union g_addr *dplane_ctx_get_pw_dest(
279 const struct zebra_dplane_ctx *ctx);
280 const union pw_protocol_fields *dplane_ctx_get_pw_proto(
281 const struct zebra_dplane_ctx *ctx);
282 const struct nexthop_group *dplane_ctx_get_pw_nhg(
283 const struct zebra_dplane_ctx *ctx);
284
285 /* Accessors for interface information */
286 uint32_t dplane_ctx_get_intf_metric(const struct zebra_dplane_ctx *ctx);
287 /* Is interface addr p2p? */
288 bool dplane_ctx_intf_is_connected(const struct zebra_dplane_ctx *ctx);
289 bool dplane_ctx_intf_is_secondary(const struct zebra_dplane_ctx *ctx);
290 bool dplane_ctx_intf_is_broadcast(const struct zebra_dplane_ctx *ctx);
291 const struct prefix *dplane_ctx_get_intf_addr(
292 const struct zebra_dplane_ctx *ctx);
293 bool dplane_ctx_intf_has_dest(const struct zebra_dplane_ctx *ctx);
294 const struct prefix *dplane_ctx_get_intf_dest(
295 const struct zebra_dplane_ctx *ctx);
296 bool dplane_ctx_intf_has_label(const struct zebra_dplane_ctx *ctx);
297 const char *dplane_ctx_get_intf_label(const struct zebra_dplane_ctx *ctx);
298
299 /* Accessors for MAC information */
300 vlanid_t dplane_ctx_mac_get_vlan(const struct zebra_dplane_ctx *ctx);
301 bool dplane_ctx_mac_is_sticky(const struct zebra_dplane_ctx *ctx);
302 const struct ethaddr *dplane_ctx_mac_get_addr(
303 const struct zebra_dplane_ctx *ctx);
304 const struct in_addr *dplane_ctx_mac_get_vtep_ip(
305 const struct zebra_dplane_ctx *ctx);
306
307 /* Namespace info - esp. for netlink communication */
308 const struct zebra_dplane_info *dplane_ctx_get_ns(
309 const struct zebra_dplane_ctx *ctx);
310
311 /* Indicates zebra shutdown/exit is in progress. Some operations may be
312 * simplified or skipped during shutdown processing.
313 */
314 bool dplane_is_in_shutdown(void);
315
316 /*
317 * Enqueue route change operations for the dataplane.
318 */
319 enum zebra_dplane_result dplane_route_add(struct route_node *rn,
320 struct route_entry *re);
321
322 enum zebra_dplane_result dplane_route_update(struct route_node *rn,
323 struct route_entry *re,
324 struct route_entry *old_re);
325
326 enum zebra_dplane_result dplane_route_delete(struct route_node *rn,
327 struct route_entry *re);
328
329 /* Notify the dplane when system/connected routes change */
330 enum zebra_dplane_result dplane_sys_route_add(struct route_node *rn,
331 struct route_entry *re);
332 enum zebra_dplane_result dplane_sys_route_del(struct route_node *rn,
333 struct route_entry *re);
334
335 /* Update from an async notification, to bring other fibs up-to-date */
336 enum zebra_dplane_result dplane_route_notif_update(
337 struct route_node *rn,
338 struct route_entry *re,
339 enum dplane_op_e op,
340 struct zebra_dplane_ctx *ctx);
341
342 /*
343 * Enqueue LSP change operations for the dataplane.
344 */
345 enum zebra_dplane_result dplane_lsp_add(zebra_lsp_t *lsp);
346 enum zebra_dplane_result dplane_lsp_update(zebra_lsp_t *lsp);
347 enum zebra_dplane_result dplane_lsp_delete(zebra_lsp_t *lsp);
348
349 /* Update or un-install resulting from an async notification */
350 enum zebra_dplane_result dplane_lsp_notif_update(zebra_lsp_t *lsp,
351 enum dplane_op_e op,
352 struct zebra_dplane_ctx *ctx);
353
354 /*
355 * Enqueue pseudowire operations for the dataplane.
356 */
357 enum zebra_dplane_result dplane_pw_install(struct zebra_pw *pw);
358 enum zebra_dplane_result dplane_pw_uninstall(struct zebra_pw *pw);
359
360 /*
361 * Enqueue interface address changes for the dataplane.
362 */
363 enum zebra_dplane_result dplane_intf_addr_set(const struct interface *ifp,
364 const struct connected *ifc);
365 enum zebra_dplane_result dplane_intf_addr_unset(const struct interface *ifp,
366 const struct connected *ifc);
367
368 /*
369 * Enqueue evpn mac operations for the dataplane.
370 */
371 enum zebra_dplane_result dplane_mac_add(const struct interface *ifp,
372 vlanid_t vid,
373 const struct ethaddr *mac,
374 struct in_addr vtep_ip,
375 bool sticky);
376
377 enum zebra_dplane_result dplane_mac_del(const struct interface *ifp,
378 vlanid_t vid,
379 const struct ethaddr *mac,
380 struct in_addr vtep_ip);
381
382 /* Retrieve the limit on the number of pending, unprocessed updates. */
383 uint32_t dplane_get_in_queue_limit(void);
384
385 /* Configure limit on the number of pending, queued updates. If 'unset', reset
386 * to default value.
387 */
388 void dplane_set_in_queue_limit(uint32_t limit, bool set);
389
390 /* Retrieve the current queue depth of incoming, unprocessed updates */
391 uint32_t dplane_get_in_queue_len(void);
392
393 /*
394 * Vty/cli apis
395 */
396 int dplane_show_helper(struct vty *vty, bool detailed);
397 int dplane_show_provs_helper(struct vty *vty, bool detailed);
398
399 /*
400 * Dataplane providers: modules that process or consume dataplane events.
401 */
402
403 struct zebra_dplane_provider;
404
405 /* Support string name for a dataplane provider */
406 #define DPLANE_PROVIDER_NAMELEN 64
407
408 /* Priority or ordering values for providers. The idea is that there may be
409 * some pre-processing, followed by an external or remote dataplane,
410 * followed by the kernel, followed by some post-processing step (such as
411 * the fpm output stream.)
412 */
413 enum dplane_provider_prio {
414 DPLANE_PRIO_NONE = 0,
415 DPLANE_PRIO_PREPROCESS,
416 DPLANE_PRIO_PRE_KERNEL,
417 DPLANE_PRIO_KERNEL,
418 DPLANE_PRIO_POSTPROCESS,
419 DPLANE_PRIO_LAST
420 };
421
422 /* Flags values used during provider registration. */
423 #define DPLANE_PROV_FLAGS_DEFAULT 0x0
424
425 /* Provider will be spawning its own worker thread */
426 #define DPLANE_PROV_FLAG_THREADED 0x1
427
428
429 /* Provider registration: ordering or priority value, callbacks, and optional
430 * opaque data value. If 'prov_p', return the newly-allocated provider object
431 * on success.
432 */
433
434 /* Providers offer an entry-point for incoming work, called in the context of
435 * the dataplane pthread. The dataplane pthread enqueues any new work to the
436 * provider's 'inbound' queue, then calls the callback. The dataplane
437 * then checks the provider's outbound queue for completed work.
438 */
439
440 /*
441 * Providers can offer a 'start' callback; if present, the dataplane will
442 * call it when it is starting - when its pthread and event-scheduling
443 * thread_master are available.
444 */
445
446 /* Providers can offer an entry-point for shutdown and cleanup. This is called
447 * with 'early' during shutdown, to indicate that the dataplane subsystem
448 * is allowing work to move through the providers and finish.
449 * When called without 'early', the provider should release
450 * all resources (if it has any allocated).
451 */
452 int dplane_provider_register(const char *name,
453 enum dplane_provider_prio prio,
454 int flags,
455 int (*start_fp)(struct zebra_dplane_provider *),
456 int (*fp)(struct zebra_dplane_provider *),
457 int (*fini_fp)(struct zebra_dplane_provider *,
458 bool early),
459 void *data,
460 struct zebra_dplane_provider **prov_p);
461
462 /* Accessors for provider attributes */
463 const char *dplane_provider_get_name(const struct zebra_dplane_provider *prov);
464 uint32_t dplane_provider_get_id(const struct zebra_dplane_provider *prov);
465 void *dplane_provider_get_data(const struct zebra_dplane_provider *prov);
466 bool dplane_provider_is_threaded(const struct zebra_dplane_provider *prov);
467
468 /* Lock/unlock a provider's mutex - iff the provider was registered with
469 * the THREADED flag.
470 */
471 void dplane_provider_lock(struct zebra_dplane_provider *prov);
472 void dplane_provider_unlock(struct zebra_dplane_provider *prov);
473
474 /* Obtain thread_master for dataplane thread */
475 struct thread_master *dplane_get_thread_master(void);
476
477 /* Providers should (generally) limit number of updates per work cycle */
478 int dplane_provider_get_work_limit(const struct zebra_dplane_provider *prov);
479
480 /* Provider api to signal that work/events are available
481 * for the dataplane pthread.
482 */
483 int dplane_provider_work_ready(void);
484
485 /* Dequeue, maintain associated counter and locking */
486 struct zebra_dplane_ctx *dplane_provider_dequeue_in_ctx(
487 struct zebra_dplane_provider *prov);
488
489 /* Dequeue work to a list, maintain counter and locking, return count */
490 int dplane_provider_dequeue_in_list(struct zebra_dplane_provider *prov,
491 struct dplane_ctx_q *listp);
492
493 /* Enqueue completed work, maintain associated counter and locking */
494 void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider *prov,
495 struct zebra_dplane_ctx *ctx);
496
497 /* Enqueue a context directly to zebra main. */
498 void dplane_provider_enqueue_to_zebra(struct zebra_dplane_ctx *ctx);
499
500 /*
501 * Initialize the dataplane modules at zebra startup. This is currently called
502 * by the rib module. Zebra registers a results callback with the dataplane.
503 * The callback is called in the dataplane pthread context,
504 * so the expectation is that the contexts are queued for the zebra
505 * main pthread.
506 */
507 void zebra_dplane_init(int (*) (struct dplane_ctx_q *));
508
509 /*
510 * Start the dataplane pthread. This step needs to be run later than the
511 * 'init' step, in case zebra has fork-ed.
512 */
513 void zebra_dplane_start(void);
514
515 /* Finalize/cleanup apis, one called early as shutdown is starting,
516 * one called late at the end of zebra shutdown, and then one called
517 * from the zebra main pthread to stop the dplane pthread and
518 * free all resources.
519 *
520 * Zebra expects to try to clean up all vrfs and all routes during
521 * shutdown, so the dplane must be available until very late.
522 */
523 void zebra_dplane_pre_finish(void);
524 void zebra_dplane_finish(void);
525 void zebra_dplane_shutdown(void);
526
527 #ifdef __cplusplus
528 }
529 #endif
530
531 #endif /* _ZEBRA_DPLANE_H */