]>
Commit | Line | Data |
---|---|---|
ea1c14f6 MS |
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 | ||
7cdb1a84 MS |
23 | #include "lib/zebra.h" |
24 | #include "lib/prefix.h" | |
25 | #include "lib/nexthop.h" | |
26 | #include "lib/nexthop_group.h" | |
214fc2bd | 27 | #include "lib/queue.h" |
7cdb1a84 MS |
28 | #include "zebra/zebra_ns.h" |
29 | #include "zebra/rib.h" | |
30 | #include "zebra/zserv.h" | |
0f461727 | 31 | #include "zebra/zebra_mpls.h" |
ea1c14f6 | 32 | |
85a75f1e MS |
33 | /* Key netlink info from zebra ns */ |
34 | struct zebra_dplane_info { | |
35 | ns_id_t ns_id; | |
36 | ||
37 | #if defined(HAVE_NETLINK) | |
7cdb1a84 | 38 | struct nlsock nls; |
85a75f1e MS |
39 | bool is_cmd; |
40 | #endif | |
41 | }; | |
42 | ||
43 | /* Utility to fill in zns info from main zns struct */ | |
44 | static inline void | |
45 | zebra_dplane_info_from_zns(struct zebra_dplane_info *zns_info, | |
46 | const struct zebra_ns *zns, bool is_cmd) | |
47 | { | |
48 | zns_info->ns_id = zns->ns_id; | |
49 | ||
50 | #if defined(HAVE_NETLINK) | |
51 | zns_info->is_cmd = is_cmd; | |
52 | if (is_cmd) { | |
7cdb1a84 | 53 | zns_info->nls = zns->netlink_cmd; |
85a75f1e | 54 | } else { |
7cdb1a84 | 55 | zns_info->nls = zns->netlink; |
85a75f1e MS |
56 | } |
57 | #endif /* NETLINK */ | |
58 | } | |
59 | ||
ea1c14f6 MS |
60 | /* |
61 | * Result codes used when returning status back to the main zebra context. | |
62 | */ | |
63 | ||
64 | /* | |
65 | * Philosophy Note: | |
66 | * | |
67 | * Flags being SET/UNSET do not belong in the South Bound | |
68 | * Interface. This Setting belongs at the calling level | |
69 | * because we can and will have multiple different interfaces | |
70 | * and we will have potentially multiple different | |
71 | * modules/filters to call. As such Setting/Unsetting | |
72 | * success failure should be handled by the caller. | |
73 | */ | |
74 | enum zebra_dplane_status { | |
75 | ZEBRA_DPLANE_STATUS_NONE = 0, | |
76 | ZEBRA_DPLANE_INSTALL_SUCCESS, | |
77 | ZEBRA_DPLANE_INSTALL_FAILURE, | |
78 | ZEBRA_DPLANE_DELETE_SUCCESS, | |
79 | ZEBRA_DPLANE_DELETE_FAILURE, | |
80 | ||
81 | }; | |
82 | ||
83 | enum zebra_dplane_result { | |
84 | ZEBRA_DPLANE_REQUEST_QUEUED, | |
85 | ZEBRA_DPLANE_REQUEST_SUCCESS, | |
86 | ZEBRA_DPLANE_REQUEST_FAILURE, | |
87 | }; | |
88 | ||
7cdb1a84 MS |
89 | /* |
90 | * API between the zebra dataplane system and the main zebra processing | |
91 | * context. | |
92 | */ | |
93 | ||
94 | /* | |
95 | * Enqueue a route install or update for the dataplane. | |
96 | */ | |
5709131c | 97 | enum dplane_op_e { |
7cdb1a84 MS |
98 | DPLANE_OP_NONE = 0, |
99 | ||
100 | /* Route update */ | |
101 | DPLANE_OP_ROUTE_INSTALL, | |
102 | DPLANE_OP_ROUTE_UPDATE, | |
103 | DPLANE_OP_ROUTE_DELETE, | |
104 | ||
16c628de MS |
105 | /* LSP update */ |
106 | DPLANE_OP_LSP_INSTALL, | |
107 | DPLANE_OP_LSP_UPDATE, | |
108 | DPLANE_OP_LSP_DELETE | |
5709131c | 109 | }; |
7cdb1a84 | 110 | |
7cdb1a84 | 111 | /* |
25779064 | 112 | * The dataplane context struct is used to exchange info between the main zebra |
7cdb1a84 MS |
113 | * context and the dataplane module(s). If these are two independent pthreads, |
114 | * they cannot share existing global data structures safely. | |
115 | */ | |
7cdb1a84 MS |
116 | |
117 | /* Define a tailq list type for context blocks. The list is exposed/public, | |
118 | * but the internal linkage in the context struct is private, so there | |
119 | * are accessor apis that support enqueue and dequeue. | |
120 | */ | |
25779064 | 121 | TAILQ_HEAD(dplane_ctx_q, zebra_dplane_ctx); |
7cdb1a84 | 122 | |
7cdb1a84 MS |
123 | /* Return a dataplane results context block after use; the caller's pointer will |
124 | * be cleared. | |
125 | */ | |
25779064 | 126 | void dplane_ctx_fini(struct zebra_dplane_ctx **pctx); |
7cdb1a84 | 127 | |
14b0bc8e | 128 | /* Enqueue a context block to caller's tailq. This exists so that the |
7cdb1a84 MS |
129 | * context struct can remain opaque. |
130 | */ | |
25779064 MS |
131 | void dplane_ctx_enqueue_tail(struct dplane_ctx_q *q, |
132 | const struct zebra_dplane_ctx *ctx); | |
7cdb1a84 | 133 | |
c831033f MS |
134 | /* Append a list of context blocks to another list - again, just keeping |
135 | * the context struct opaque. | |
136 | */ | |
137 | void dplane_ctx_list_append(struct dplane_ctx_q *to_list, | |
138 | struct dplane_ctx_q *from_list); | |
139 | ||
7cdb1a84 | 140 | /* Dequeue a context block from the head of caller's tailq */ |
68b375e0 | 141 | struct zebra_dplane_ctx *dplane_ctx_dequeue(struct dplane_ctx_q *q); |
7cdb1a84 MS |
142 | |
143 | /* | |
144 | * Accessors for information from the context object | |
145 | */ | |
25779064 MS |
146 | enum zebra_dplane_result dplane_ctx_get_status( |
147 | const struct zebra_dplane_ctx *ctx); | |
c831033f MS |
148 | void dplane_ctx_set_status(struct zebra_dplane_ctx *ctx, |
149 | enum zebra_dplane_result status); | |
f183e380 | 150 | const char *dplane_res2str(enum zebra_dplane_result res); |
7cdb1a84 | 151 | |
25779064 | 152 | enum dplane_op_e dplane_ctx_get_op(const struct zebra_dplane_ctx *ctx); |
5709131c | 153 | const char *dplane_op2str(enum dplane_op_e op); |
7cdb1a84 | 154 | |
25779064 | 155 | const struct prefix *dplane_ctx_get_dest(const struct zebra_dplane_ctx *ctx); |
7cdb1a84 | 156 | |
c831033f MS |
157 | /* Retrieve last/current provider id */ |
158 | uint32_t dplane_ctx_get_provider(const struct zebra_dplane_ctx *ctx); | |
159 | ||
160 | /* Providers running before the kernel can control whether a kernel | |
161 | * update should be done. | |
162 | */ | |
163 | void dplane_ctx_set_skip_kernel(struct zebra_dplane_ctx *ctx); | |
164 | bool dplane_ctx_is_skip_kernel(const struct zebra_dplane_ctx *ctx); | |
165 | ||
5709131c MS |
166 | /* Source prefix is a little special - use convention to return NULL |
167 | * to mean "no src prefix" | |
7cdb1a84 | 168 | */ |
25779064 MS |
169 | const struct prefix *dplane_ctx_get_src(const struct zebra_dplane_ctx *ctx); |
170 | ||
171 | bool dplane_ctx_is_update(const struct zebra_dplane_ctx *ctx); | |
172 | uint32_t dplane_ctx_get_seq(const struct zebra_dplane_ctx *ctx); | |
173 | uint32_t dplane_ctx_get_old_seq(const struct zebra_dplane_ctx *ctx); | |
174 | vrf_id_t dplane_ctx_get_vrf(const struct zebra_dplane_ctx *ctx); | |
0f461727 MS |
175 | |
176 | /* Accessors for route update information */ | |
25779064 MS |
177 | int dplane_ctx_get_type(const struct zebra_dplane_ctx *ctx); |
178 | int dplane_ctx_get_old_type(const struct zebra_dplane_ctx *ctx); | |
179 | afi_t dplane_ctx_get_afi(const struct zebra_dplane_ctx *ctx); | |
180 | safi_t dplane_ctx_get_safi(const struct zebra_dplane_ctx *ctx); | |
181 | uint32_t dplane_ctx_get_table(const struct zebra_dplane_ctx *ctx); | |
182 | route_tag_t dplane_ctx_get_tag(const struct zebra_dplane_ctx *ctx); | |
183 | route_tag_t dplane_ctx_get_old_tag(const struct zebra_dplane_ctx *ctx); | |
184 | uint16_t dplane_ctx_get_instance(const struct zebra_dplane_ctx *ctx); | |
185 | uint16_t dplane_ctx_get_old_instance(const struct zebra_dplane_ctx *ctx); | |
186 | uint32_t dplane_ctx_get_metric(const struct zebra_dplane_ctx *ctx); | |
187 | uint32_t dplane_ctx_get_old_metric(const struct zebra_dplane_ctx *ctx); | |
188 | uint32_t dplane_ctx_get_mtu(const struct zebra_dplane_ctx *ctx); | |
189 | uint32_t dplane_ctx_get_nh_mtu(const struct zebra_dplane_ctx *ctx); | |
190 | uint8_t dplane_ctx_get_distance(const struct zebra_dplane_ctx *ctx); | |
191 | uint8_t dplane_ctx_get_old_distance(const struct zebra_dplane_ctx *ctx); | |
192 | ||
193 | const struct nexthop_group *dplane_ctx_get_ng( | |
194 | const struct zebra_dplane_ctx *ctx); | |
195 | const struct nexthop_group *dplane_ctx_get_old_ng( | |
196 | const struct zebra_dplane_ctx *ctx); | |
197 | ||
0f461727 MS |
198 | /* Accessors for LSP information */ |
199 | mpls_label_t dplane_ctx_get_in_label(const struct zebra_dplane_ctx *ctx); | |
200 | uint8_t dplane_ctx_get_addr_family(const struct zebra_dplane_ctx *ctx); | |
201 | uint32_t dplane_ctx_get_lsp_flags(const struct zebra_dplane_ctx *ctx); | |
202 | zebra_nhlfe_t *dplane_ctx_get_nhlfe(struct zebra_dplane_ctx *ctx); | |
203 | zebra_nhlfe_t *dplane_ctx_get_best_nhlfe(struct zebra_dplane_ctx *ctx); | |
204 | uint32_t dplane_ctx_get_lsp_num_ecmp(const struct zebra_dplane_ctx *ctx); | |
205 | ||
206 | /* Namespace info - esp. for netlink communication */ | |
25779064 MS |
207 | const struct zebra_dplane_info *dplane_ctx_get_ns( |
208 | const struct zebra_dplane_ctx *ctx); | |
7cdb1a84 | 209 | |
4dfd7a02 MS |
210 | /* Indicates zebra shutdown/exit is in progress. Some operations may be |
211 | * simplified or skipped during shutdown processing. | |
212 | */ | |
213 | bool dplane_is_in_shutdown(void); | |
214 | ||
7cdb1a84 MS |
215 | /* |
216 | * Enqueue route change operations for the dataplane. | |
217 | */ | |
655d681a MS |
218 | enum zebra_dplane_result dplane_route_add(struct route_node *rn, |
219 | struct route_entry *re); | |
7cdb1a84 | 220 | |
655d681a MS |
221 | enum zebra_dplane_result dplane_route_update(struct route_node *rn, |
222 | struct route_entry *re, | |
223 | struct route_entry *old_re); | |
7cdb1a84 | 224 | |
655d681a MS |
225 | enum zebra_dplane_result dplane_route_delete(struct route_node *rn, |
226 | struct route_entry *re); | |
7cdb1a84 | 227 | |
16c628de MS |
228 | /* |
229 | * Enqueue LSP change operations for the dataplane. | |
230 | */ | |
231 | enum zebra_dplane_result dplane_lsp_add(zebra_lsp_t *lsp); | |
232 | enum zebra_dplane_result dplane_lsp_update(zebra_lsp_t *lsp); | |
233 | enum zebra_dplane_result dplane_lsp_delete(zebra_lsp_t *lsp); | |
234 | ||
91f16812 MS |
235 | /* Retrieve the limit on the number of pending, unprocessed updates. */ |
236 | uint32_t dplane_get_in_queue_limit(void); | |
237 | ||
238 | /* Configure limit on the number of pending, queued updates. If 'unset', reset | |
239 | * to default value. | |
240 | */ | |
241 | void dplane_set_in_queue_limit(uint32_t limit, bool set); | |
242 | ||
243 | /* Retrieve the current queue depth of incoming, unprocessed updates */ | |
244 | uint32_t dplane_get_in_queue_len(void); | |
245 | ||
1d11b21f MS |
246 | /* |
247 | * Vty/cli apis | |
248 | */ | |
249 | int dplane_show_helper(struct vty *vty, bool detailed); | |
250 | int dplane_show_provs_helper(struct vty *vty, bool detailed); | |
251 | ||
252 | ||
253 | /* | |
c831033f | 254 | * Dataplane providers: modules that process or consume dataplane events. |
1d11b21f MS |
255 | */ |
256 | ||
c831033f MS |
257 | struct zebra_dplane_provider; |
258 | ||
fe2c53d4 | 259 | /* Support string name for a dataplane provider */ |
7cdb1a84 MS |
260 | #define DPLANE_PROVIDER_NAMELEN 64 |
261 | ||
262 | /* Priority or ordering values for providers. The idea is that there may be | |
263 | * some pre-processing, followed by an external or remote dataplane, | |
264 | * followed by the kernel, followed by some post-processing step (such as | |
265 | * the fpm output stream.) | |
266 | */ | |
c831033f | 267 | enum dplane_provider_prio { |
7cdb1a84 MS |
268 | DPLANE_PRIO_NONE = 0, |
269 | DPLANE_PRIO_PREPROCESS, | |
270 | DPLANE_PRIO_PRE_KERNEL, | |
271 | DPLANE_PRIO_KERNEL, | |
272 | DPLANE_PRIO_POSTPROCESS, | |
b8e0423d | 273 | DPLANE_PRIO_LAST |
5709131c | 274 | }; |
7cdb1a84 | 275 | |
c831033f MS |
276 | /* Flags values used during provider registration. */ |
277 | #define DPLANE_PROV_FLAGS_DEFAULT 0x0 | |
278 | ||
279 | /* Provider will be spawning its own worker thread */ | |
280 | #define DPLANE_PROV_FLAG_THREADED 0x1 | |
7cdb1a84 | 281 | |
18c37974 | 282 | |
c831033f | 283 | /* Provider registration: ordering or priority value, callbacks, and optional |
1ff8a248 MS |
284 | * opaque data value. If 'prov_p', return the newly-allocated provider object |
285 | * on success. | |
c831033f | 286 | */ |
4c206c8f MS |
287 | |
288 | /* Providers offer an entry-point for incoming work, called in the context of | |
289 | * the dataplane pthread. The dataplane pthread enqueues any new work to the | |
290 | * provider's 'inbound' queue, then calls the callback. The dataplane | |
291 | * then checks the provider's outbound queue for completed work. | |
292 | */ | |
293 | ||
294 | /* Providers offer an entry-point for shutdown and cleanup. This is called | |
295 | * with 'early' during shutdown, to indicate that the dataplane subsystem | |
296 | * is allowing work to move through the providers and finish. | |
297 | * When called without 'early', the provider should release | |
298 | * all resources (if it has any allocated). | |
299 | */ | |
7cdb1a84 | 300 | int dplane_provider_register(const char *name, |
c831033f MS |
301 | enum dplane_provider_prio prio, |
302 | int flags, | |
4c206c8f MS |
303 | int (*fp)(struct zebra_dplane_provider *), |
304 | int (*fini_fp)(struct zebra_dplane_provider *, | |
305 | bool early), | |
1ff8a248 MS |
306 | void *data, |
307 | struct zebra_dplane_provider **prov_p); | |
7cdb1a84 | 308 | |
c831033f MS |
309 | /* Accessors for provider attributes */ |
310 | const char *dplane_provider_get_name(const struct zebra_dplane_provider *prov); | |
311 | uint32_t dplane_provider_get_id(const struct zebra_dplane_provider *prov); | |
312 | void *dplane_provider_get_data(const struct zebra_dplane_provider *prov); | |
313 | bool dplane_provider_is_threaded(const struct zebra_dplane_provider *prov); | |
314 | ||
ad6aad4d MS |
315 | /* Lock/unlock a provider's mutex - iff the provider was registered with |
316 | * the THREADED flag. | |
317 | */ | |
318 | void dplane_provider_lock(struct zebra_dplane_provider *prov); | |
319 | void dplane_provider_unlock(struct zebra_dplane_provider *prov); | |
320 | ||
321 | /* Obtain thread_master for dataplane thread */ | |
322 | struct thread_master *dplane_get_thread_master(void); | |
323 | ||
324 | /* Providers should (generally) limit number of updates per work cycle */ | |
c831033f MS |
325 | int dplane_provider_get_work_limit(const struct zebra_dplane_provider *prov); |
326 | ||
327 | /* Provider api to signal that work/events are available | |
328 | * for the dataplane pthread. | |
7cdb1a84 | 329 | */ |
c831033f MS |
330 | int dplane_provider_work_ready(void); |
331 | ||
332 | /* Dequeue, maintain associated counter and locking */ | |
333 | struct zebra_dplane_ctx *dplane_provider_dequeue_in_ctx( | |
334 | struct zebra_dplane_provider *prov); | |
335 | ||
336 | /* Dequeue work to a list, maintain counter and locking, return count */ | |
337 | int dplane_provider_dequeue_in_list(struct zebra_dplane_provider *prov, | |
338 | struct dplane_ctx_q *listp); | |
339 | ||
340 | /* Enqueue, maintain associated counter and locking */ | |
341 | void dplane_provider_enqueue_out_ctx(struct zebra_dplane_provider *prov, | |
342 | struct zebra_dplane_ctx *ctx); | |
7cdb1a84 | 343 | |
7cdb1a84 | 344 | /* |
1d11b21f | 345 | * Initialize the dataplane modules at zebra startup. This is currently called |
4c206c8f MS |
346 | * by the rib module. Zebra registers a results callback with the dataplane. |
347 | * The callback is called in the dataplane pthread context, | |
348 | * so the expectation is that the contexts are queued for the zebra | |
349 | * main pthread. | |
7cdb1a84 | 350 | */ |
4c206c8f | 351 | void zebra_dplane_init(int (*) (struct dplane_ctx_q *)); |
7cdb1a84 | 352 | |
e5a60d82 MS |
353 | /* |
354 | * Start the dataplane pthread. This step needs to be run later than the | |
355 | * 'init' step, in case zebra has fork-ed. | |
356 | */ | |
357 | void zebra_dplane_start(void); | |
358 | ||
4dfd7a02 MS |
359 | /* Finalize/cleanup apis, one called early as shutdown is starting, |
360 | * one called late at the end of zebra shutdown, and then one called | |
c831033f MS |
361 | * from the zebra main pthread to stop the dplane pthread and |
362 | * free all resources. | |
4dfd7a02 | 363 | * |
1d11b21f MS |
364 | * Zebra expects to try to clean up all vrfs and all routes during |
365 | * shutdown, so the dplane must be available until very late. | |
366 | */ | |
4dfd7a02 | 367 | void zebra_dplane_pre_finish(void); |
1d11b21f | 368 | void zebra_dplane_finish(void); |
4dfd7a02 | 369 | void zebra_dplane_shutdown(void); |
1d11b21f | 370 | |
ea1c14f6 | 371 | #endif /* _ZEBRA_DPLANE_H */ |