]>
Commit | Line | Data |
---|---|---|
1c2facd1 RW |
1 | /* |
2 | * Copyright (C) 2018 NetDEF, Inc. | |
3 | * Renato Westphal | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU General Public License as published by the Free | |
7 | * Software Foundation; either version 2 of the License, or (at your option) | |
8 | * any later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
11 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
12 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
13 | * 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 _FRR_NORTHBOUND_H_ | |
21 | #define _FRR_NORTHBOUND_H_ | |
22 | ||
fbdc1c0a | 23 | #include "thread.h" |
1c2facd1 | 24 | #include "hook.h" |
1c2facd1 RW |
25 | #include "linklist.h" |
26 | #include "openbsd-tree.h" | |
1a4bc045 RW |
27 | #include "yang.h" |
28 | #include "yang_translator.h" | |
1c2facd1 | 29 | |
5e244469 RW |
30 | #ifdef __cplusplus |
31 | extern "C" { | |
32 | #endif | |
33 | ||
1c2facd1 RW |
34 | /* Forward declaration(s). */ |
35 | struct vty; | |
9eb2c0a1 | 36 | struct debug; |
1c2facd1 RW |
37 | |
38 | /* Northbound events. */ | |
39 | enum nb_event { | |
40 | /* | |
41 | * The configuration callback is supposed to verify that the changes are | |
42 | * valid and can be applied. | |
43 | */ | |
44 | NB_EV_VALIDATE, | |
45 | ||
46 | /* | |
47 | * The configuration callback is supposed to prepare all resources | |
48 | * required to apply the changes. | |
49 | */ | |
50 | NB_EV_PREPARE, | |
51 | ||
52 | /* | |
53 | * Transaction has failed, the configuration callback needs to release | |
54 | * all resources previously allocated. | |
55 | */ | |
56 | NB_EV_ABORT, | |
57 | ||
58 | /* | |
59 | * The configuration changes need to be applied. The changes can't be | |
60 | * rejected at this point (errors are logged and ignored). | |
61 | */ | |
62 | NB_EV_APPLY, | |
63 | }; | |
64 | ||
65 | /* | |
66 | * Northbound operations. | |
67 | * | |
68 | * Refer to the documentation comments of nb_callbacks for more details. | |
69 | */ | |
70 | enum nb_operation { | |
71 | NB_OP_CREATE, | |
72 | NB_OP_MODIFY, | |
95ce849b | 73 | NB_OP_DESTROY, |
1c2facd1 | 74 | NB_OP_MOVE, |
34224f0c | 75 | NB_OP_PRE_VALIDATE, |
1c2facd1 RW |
76 | NB_OP_APPLY_FINISH, |
77 | NB_OP_GET_ELEM, | |
78 | NB_OP_GET_NEXT, | |
79 | NB_OP_GET_KEYS, | |
80 | NB_OP_LOOKUP_ENTRY, | |
81 | NB_OP_RPC, | |
82 | }; | |
83 | ||
84 | union nb_resource { | |
85 | int fd; | |
86 | void *ptr; | |
87 | }; | |
88 | ||
89 | struct nb_callbacks { | |
90 | /* | |
91 | * Configuration callback. | |
92 | * | |
93 | * A presence container, list entry, leaf-list entry or leaf of type | |
94 | * empty has been created. | |
95 | * | |
96 | * For presence-containers and list entries, the callback is supposed to | |
97 | * initialize the default values of its children (if any) from the YANG | |
98 | * models. | |
99 | * | |
100 | * event | |
101 | * The transaction phase. Refer to the documentation comments of | |
102 | * nb_event for more details. | |
103 | * | |
104 | * dnode | |
105 | * libyang data node that is being created. | |
106 | * | |
107 | * resource | |
108 | * Pointer to store resource(s) allocated during the NB_EV_PREPARE | |
109 | * phase. The same pointer can be used during the NB_EV_ABORT and | |
110 | * NB_EV_APPLY phases to either release or make use of the allocated | |
111 | * resource(s). It's set to NULL when the event is NB_EV_VALIDATE. | |
112 | * | |
113 | * Returns: | |
114 | * - NB_OK on success. | |
115 | * - NB_ERR_VALIDATION when a validation error occurred. | |
116 | * - NB_ERR_RESOURCE when the callback failed to allocate a resource. | |
117 | * - NB_ERR_INCONSISTENCY when an inconsistency was detected. | |
118 | * - NB_ERR for other errors. | |
119 | */ | |
120 | int (*create)(enum nb_event event, const struct lyd_node *dnode, | |
121 | union nb_resource *resource); | |
122 | ||
123 | /* | |
124 | * Configuration callback. | |
125 | * | |
126 | * The value of a leaf has been modified. | |
127 | * | |
128 | * List keys don't need to implement this callback. When a list key is | |
129 | * modified, the northbound treats this as if the list was deleted and a | |
130 | * new one created with the updated key value. | |
131 | * | |
132 | * event | |
133 | * The transaction phase. Refer to the documentation comments of | |
134 | * nb_event for more details. | |
135 | * | |
136 | * dnode | |
137 | * libyang data node that is being modified | |
138 | * | |
139 | * resource | |
140 | * Pointer to store resource(s) allocated during the NB_EV_PREPARE | |
141 | * phase. The same pointer can be used during the NB_EV_ABORT and | |
142 | * NB_EV_APPLY phases to either release or make use of the allocated | |
143 | * resource(s). It's set to NULL when the event is NB_EV_VALIDATE. | |
144 | * | |
145 | * Returns: | |
146 | * - NB_OK on success. | |
147 | * - NB_ERR_VALIDATION when a validation error occurred. | |
148 | * - NB_ERR_RESOURCE when the callback failed to allocate a resource. | |
149 | * - NB_ERR_INCONSISTENCY when an inconsistency was detected. | |
150 | * - NB_ERR for other errors. | |
151 | */ | |
152 | int (*modify)(enum nb_event event, const struct lyd_node *dnode, | |
153 | union nb_resource *resource); | |
154 | ||
155 | /* | |
156 | * Configuration callback. | |
157 | * | |
158 | * A presence container, list entry, leaf-list entry or optional leaf | |
159 | * has been deleted. | |
160 | * | |
161 | * The callback is supposed to delete the entire configuration object, | |
162 | * including its children when they exist. | |
163 | * | |
164 | * event | |
165 | * The transaction phase. Refer to the documentation comments of | |
166 | * nb_event for more details. | |
167 | * | |
168 | * dnode | |
169 | * libyang data node that is being deleted. | |
170 | * | |
171 | * Returns: | |
172 | * - NB_OK on success. | |
173 | * - NB_ERR_VALIDATION when a validation error occurred. | |
174 | * - NB_ERR_INCONSISTENCY when an inconsistency was detected. | |
175 | * - NB_ERR for other errors. | |
176 | */ | |
d01b92fd | 177 | int (*destroy)(enum nb_event event, const struct lyd_node *dnode); |
1c2facd1 RW |
178 | |
179 | /* | |
180 | * Configuration callback. | |
181 | * | |
182 | * A list entry or leaf-list entry has been moved. Only applicable when | |
183 | * the "ordered-by user" statement is present. | |
184 | * | |
185 | * event | |
186 | * The transaction phase. Refer to the documentation comments of | |
187 | * nb_event for more details. | |
188 | * | |
189 | * dnode | |
190 | * libyang data node that is being moved. | |
191 | * | |
192 | * Returns: | |
193 | * - NB_OK on success. | |
194 | * - NB_ERR_VALIDATION when a validation error occurred. | |
195 | * - NB_ERR_INCONSISTENCY when an inconsistency was detected. | |
196 | * - NB_ERR for other errors. | |
197 | */ | |
198 | int (*move)(enum nb_event event, const struct lyd_node *dnode); | |
199 | ||
34224f0c RW |
200 | /* |
201 | * Optional configuration callback. | |
202 | * | |
203 | * This callback can be used to validate subsections of the | |
204 | * configuration being committed before validating the configuration | |
205 | * changes themselves. It's useful to perform more complex validations | |
206 | * that depend on the relationship between multiple nodes. | |
207 | * | |
208 | * dnode | |
209 | * libyang data node associated with the 'pre_validate' callback. | |
210 | */ | |
211 | int (*pre_validate)(const struct lyd_node *dnode); | |
212 | ||
1c2facd1 RW |
213 | /* |
214 | * Optional configuration callback. | |
215 | * | |
216 | * The 'apply_finish' callbacks are called after all other callbacks | |
217 | * during the apply phase (NB_EV_APPLY). These callbacks are called only | |
218 | * under one of the following two cases: | |
219 | * - The data node has been created or modified (but not deleted); | |
220 | * - Any change was made within the descendants of the data node (e.g. a | |
221 | * child leaf was modified, created or deleted). | |
222 | * | |
223 | * In the second case above, the 'apply_finish' callback is called only | |
224 | * once even if multiple changes occurred within the descendants of the | |
225 | * data node. | |
226 | * | |
227 | * dnode | |
228 | * libyang data node associated with the 'apply_finish' callback. | |
229 | */ | |
230 | void (*apply_finish)(const struct lyd_node *dnode); | |
231 | ||
232 | /* | |
233 | * Operational data callback. | |
234 | * | |
1a4bc045 RW |
235 | * The callback function should return the value of a specific leaf, |
236 | * leaf-list entry or inform if a typeless value (presence containers or | |
237 | * leafs of type empty) exists or not. | |
1c2facd1 RW |
238 | * |
239 | * xpath | |
240 | * YANG data path of the data we want to get. | |
241 | * | |
242 | * list_entry | |
1a4bc045 | 243 | * Pointer to list entry (might be NULL). |
1c2facd1 RW |
244 | * |
245 | * Returns: | |
246 | * Pointer to newly created yang_data structure, or NULL to indicate | |
247 | * the absence of data. | |
248 | */ | |
249 | struct yang_data *(*get_elem)(const char *xpath, | |
250 | const void *list_entry); | |
251 | ||
252 | /* | |
1a4bc045 | 253 | * Operational data callback for YANG lists and leaf-lists. |
1c2facd1 | 254 | * |
1a4bc045 RW |
255 | * The callback function should return the next entry in the list or |
256 | * leaf-list. The 'list_entry' parameter will be NULL on the first | |
257 | * invocation. | |
1c2facd1 | 258 | * |
1a4bc045 RW |
259 | * parent_list_entry |
260 | * Pointer to parent list entry. | |
1c2facd1 RW |
261 | * |
262 | * list_entry | |
1a4bc045 | 263 | * Pointer to (leaf-)list entry. |
1c2facd1 RW |
264 | * |
265 | * Returns: | |
1a4bc045 RW |
266 | * Pointer to the next entry in the (leaf-)list, or NULL to signal |
267 | * that the end of the (leaf-)list was reached. | |
1c2facd1 | 268 | */ |
1a4bc045 RW |
269 | const void *(*get_next)(const void *parent_list_entry, |
270 | const void *list_entry); | |
1c2facd1 RW |
271 | |
272 | /* | |
273 | * Operational data callback for YANG lists. | |
274 | * | |
275 | * The callback function should fill the 'keys' parameter based on the | |
99fb518f RW |
276 | * given list_entry. Keyless lists don't need to implement this |
277 | * callback. | |
1c2facd1 RW |
278 | * |
279 | * list_entry | |
280 | * Pointer to list entry. | |
281 | * | |
282 | * keys | |
283 | * Structure to be filled based on the attributes of the provided | |
284 | * list entry. | |
285 | * | |
286 | * Returns: | |
287 | * NB_OK on success, NB_ERR otherwise. | |
288 | */ | |
289 | int (*get_keys)(const void *list_entry, struct yang_list_keys *keys); | |
290 | ||
291 | /* | |
292 | * Operational data callback for YANG lists. | |
293 | * | |
294 | * The callback function should return a list entry based on the list | |
99fb518f RW |
295 | * keys given as a parameter. Keyless lists don't need to implement this |
296 | * callback. | |
1c2facd1 | 297 | * |
1a4bc045 RW |
298 | * parent_list_entry |
299 | * Pointer to parent list entry. | |
300 | * | |
1c2facd1 RW |
301 | * keys |
302 | * Structure containing the keys of the list entry. | |
303 | * | |
304 | * Returns: | |
305 | * Pointer to the list entry if found, or NULL if not found. | |
306 | */ | |
1a4bc045 RW |
307 | const void *(*lookup_entry)(const void *parent_list_entry, |
308 | const struct yang_list_keys *keys); | |
1c2facd1 RW |
309 | |
310 | /* | |
311 | * RPC and action callback. | |
312 | * | |
313 | * Both 'input' and 'output' are lists of 'yang_data' structures. The | |
314 | * callback should fetch all the input parameters from the 'input' list, | |
315 | * and add output parameters to the 'output' list if necessary. | |
316 | * | |
317 | * xpath | |
318 | * XPath of the YANG RPC or action. | |
319 | * | |
320 | * input | |
321 | * Read-only list of input parameters. | |
322 | * | |
323 | * output | |
324 | * List of output parameters to be populated by the callback. | |
325 | * | |
326 | * Returns: | |
327 | * NB_OK on success, NB_ERR otherwise. | |
328 | */ | |
329 | int (*rpc)(const char *xpath, const struct list *input, | |
330 | struct list *output); | |
331 | ||
332 | /* | |
333 | * Optional callback to show the CLI command associated to the given | |
334 | * YANG data node. | |
335 | * | |
336 | * vty | |
337 | * The vty terminal to dump the configuration to. | |
338 | * | |
339 | * dnode | |
340 | * libyang data node that should be shown in the form of a CLI | |
341 | * command. | |
342 | * | |
343 | * show_defaults | |
344 | * Specify whether to display default configuration values or not. | |
345 | * This parameter can be ignored most of the time since the | |
346 | * northbound doesn't call this callback for default leaves or | |
347 | * non-presence containers that contain only default child nodes. | |
348 | * The exception are commands associated to multiple configuration | |
349 | * nodes, in which case it might be desirable to hide one or more | |
350 | * parts of the command when this parameter is set to false. | |
351 | */ | |
352 | void (*cli_show)(struct vty *vty, struct lyd_node *dnode, | |
353 | bool show_defaults); | |
a4d3c1d4 RZ |
354 | |
355 | /* | |
356 | * Optional callback to show the CLI node end for lists or containers. | |
357 | * | |
358 | * vty | |
359 | * The vty terminal to dump the configuration to. | |
360 | * | |
361 | * dnode | |
362 | * libyang data node that should be shown in the form of a CLI | |
363 | * command. | |
a4d3c1d4 RZ |
364 | */ |
365 | void (*cli_show_end)(struct vty *vty, struct lyd_node *dnode); | |
1c2facd1 RW |
366 | }; |
367 | ||
368 | /* | |
369 | * Northbound-specific data that is allocated for each schema node of the native | |
370 | * YANG modules. | |
371 | */ | |
372 | struct nb_node { | |
373 | /* Back pointer to the libyang schema node. */ | |
374 | const struct lys_node *snode; | |
375 | ||
376 | /* Data path of this YANG node. */ | |
377 | char xpath[XPATH_MAXLEN]; | |
378 | ||
379 | /* Priority - lower priorities are processed first. */ | |
380 | uint32_t priority; | |
381 | ||
382 | /* Callbacks implemented for this node. */ | |
383 | struct nb_callbacks cbs; | |
384 | ||
385 | /* | |
386 | * Pointer to the parent node (disconsidering non-presence containers). | |
387 | */ | |
388 | struct nb_node *parent; | |
389 | ||
390 | /* Pointer to the nearest parent list, if any. */ | |
391 | struct nb_node *parent_list; | |
392 | ||
544ca69a RW |
393 | /* Flags. */ |
394 | uint8_t flags; | |
395 | ||
1c2facd1 RW |
396 | #ifdef HAVE_CONFD |
397 | /* ConfD hash value corresponding to this YANG path. */ | |
398 | int confd_hash; | |
399 | #endif | |
400 | }; | |
544ca69a RW |
401 | /* The YANG container or list contains only config data. */ |
402 | #define F_NB_NODE_CONFIG_ONLY 0x01 | |
99fb518f RW |
403 | /* The YANG list doesn't contain key leafs. */ |
404 | #define F_NB_NODE_KEYLESS_LIST 0x02 | |
1c2facd1 RW |
405 | |
406 | struct frr_yang_module_info { | |
407 | /* YANG module name. */ | |
408 | const char *name; | |
409 | ||
410 | /* Northbound callbacks. */ | |
411 | const struct { | |
412 | /* Data path of this YANG node. */ | |
413 | const char *xpath; | |
414 | ||
415 | /* Callbacks implemented for this node. */ | |
416 | struct nb_callbacks cbs; | |
417 | ||
418 | /* Priority - lower priorities are processed first. */ | |
419 | uint32_t priority; | |
420 | } nodes[]; | |
421 | }; | |
422 | ||
423 | /* Northbound error codes. */ | |
424 | enum nb_error { | |
425 | NB_OK = 0, | |
426 | NB_ERR, | |
427 | NB_ERR_NO_CHANGES, | |
428 | NB_ERR_NOT_FOUND, | |
429 | NB_ERR_LOCKED, | |
430 | NB_ERR_VALIDATION, | |
431 | NB_ERR_RESOURCE, | |
432 | NB_ERR_INCONSISTENCY, | |
433 | }; | |
434 | ||
435 | /* Default priority. */ | |
436 | #define NB_DFLT_PRIORITY (UINT32_MAX / 2) | |
437 | ||
438 | /* Default maximum of configuration rollbacks to store. */ | |
439 | #define NB_DLFT_MAX_CONFIG_ROLLBACKS 20 | |
440 | ||
441 | /* Northbound clients. */ | |
442 | enum nb_client { | |
364ad673 RW |
443 | NB_CLIENT_NONE = 0, |
444 | NB_CLIENT_CLI, | |
5bce33b3 | 445 | NB_CLIENT_CONFD, |
a7ca2199 | 446 | NB_CLIENT_SYSREPO, |
ec2ac5f2 | 447 | NB_CLIENT_GRPC, |
1c2facd1 RW |
448 | }; |
449 | ||
450 | /* Northbound configuration. */ | |
451 | struct nb_config { | |
452 | struct lyd_node *dnode; | |
453 | uint32_t version; | |
454 | }; | |
455 | ||
456 | /* Northbound configuration callback. */ | |
457 | struct nb_config_cb { | |
458 | RB_ENTRY(nb_config_cb) entry; | |
459 | enum nb_operation operation; | |
460 | char xpath[XPATH_MAXLEN]; | |
461 | const struct nb_node *nb_node; | |
462 | const struct lyd_node *dnode; | |
463 | }; | |
464 | RB_HEAD(nb_config_cbs, nb_config_cb); | |
465 | RB_PROTOTYPE(nb_config_cbs, nb_config_cb, entry, nb_config_cb_compare); | |
466 | ||
467 | /* Northbound configuration change. */ | |
468 | struct nb_config_change { | |
469 | struct nb_config_cb cb; | |
470 | union nb_resource resource; | |
471 | bool prepare_ok; | |
472 | }; | |
473 | ||
474 | /* Northbound configuration transaction. */ | |
475 | struct nb_transaction { | |
476 | enum nb_client client; | |
477 | char comment[80]; | |
478 | struct nb_config *config; | |
479 | struct nb_config_cbs changes; | |
480 | }; | |
481 | ||
1a4bc045 RW |
482 | /* Callback function used by nb_oper_data_iterate(). */ |
483 | typedef int (*nb_oper_data_cb)(const struct lys_node *snode, | |
484 | struct yang_translator *translator, | |
485 | struct yang_data *data, void *arg); | |
486 | ||
487 | /* Iterate over direct child nodes only. */ | |
488 | #define NB_OPER_DATA_ITER_NORECURSE 0x0001 | |
489 | ||
9eb2c0a1 | 490 | /* Hooks. */ |
1c2facd1 RW |
491 | DECLARE_HOOK(nb_notification_send, (const char *xpath, struct list *arguments), |
492 | (xpath, arguments)) | |
9eb2c0a1 RW |
493 | DECLARE_HOOK(nb_client_debug_config_write, (struct vty *vty), (vty)) |
494 | DECLARE_HOOK(nb_client_debug_set_all, (uint32_t flags, bool set), (flags, set)) | |
1c2facd1 | 495 | |
9eb2c0a1 RW |
496 | /* Northbound debugging records */ |
497 | extern struct debug nb_dbg_cbs_config; | |
498 | extern struct debug nb_dbg_cbs_state; | |
499 | extern struct debug nb_dbg_cbs_rpc; | |
500 | extern struct debug nb_dbg_notif; | |
501 | extern struct debug nb_dbg_events; | |
502 | ||
503 | /* Global running configuration. */ | |
1c2facd1 RW |
504 | extern struct nb_config *running_config; |
505 | ||
9eb2c0a1 RW |
506 | /* Wrappers for the northbound callbacks. */ |
507 | extern struct yang_data *nb_callback_get_elem(const struct nb_node *nb_node, | |
508 | const char *xpath, | |
509 | const void *list_entry); | |
510 | extern const void *nb_callback_get_next(const struct nb_node *nb_node, | |
511 | const void *parent_list_entry, | |
512 | const void *list_entry); | |
513 | extern int nb_callback_get_keys(const struct nb_node *nb_node, | |
514 | const void *list_entry, | |
515 | struct yang_list_keys *keys); | |
516 | extern const void *nb_callback_lookup_entry(const struct nb_node *nb_node, | |
517 | const void *parent_list_entry, | |
518 | const struct yang_list_keys *keys); | |
519 | extern int nb_callback_rpc(const struct nb_node *nb_node, const char *xpath, | |
520 | const struct list *input, struct list *output); | |
521 | ||
544ca69a RW |
522 | /* |
523 | * Create a northbound node for all YANG schema nodes. | |
524 | */ | |
525 | void nb_nodes_create(void); | |
526 | ||
527 | /* | |
528 | * Delete all northbound nodes from all YANG schema nodes. | |
529 | */ | |
530 | void nb_nodes_delete(void); | |
531 | ||
1c2facd1 RW |
532 | /* |
533 | * Find the northbound node corresponding to a YANG data path. | |
534 | * | |
535 | * xpath | |
536 | * XPath to search for (with or without predicates). | |
537 | * | |
538 | * Returns: | |
539 | * Pointer to northbound node if found, NULL otherwise. | |
540 | */ | |
541 | extern struct nb_node *nb_node_find(const char *xpath); | |
542 | ||
543 | /* | |
544 | * Create a new northbound configuration. | |
545 | * | |
546 | * dnode | |
547 | * Pointer to a libyang data node containing the configuration data. If NULL | |
548 | * is given, an empty configuration will be created. | |
549 | * | |
550 | * Returns: | |
551 | * Pointer to newly created northbound configuration. | |
552 | */ | |
553 | extern struct nb_config *nb_config_new(struct lyd_node *dnode); | |
554 | ||
555 | /* | |
556 | * Delete a northbound configuration. | |
557 | * | |
558 | * config | |
559 | * Pointer to the config that is going to be deleted. | |
560 | */ | |
561 | extern void nb_config_free(struct nb_config *config); | |
562 | ||
563 | /* | |
564 | * Duplicate a northbound configuration. | |
565 | * | |
566 | * config | |
567 | * Northbound configuration to duplicate. | |
568 | * | |
569 | * Returns: | |
570 | * Pointer to duplicated configuration. | |
571 | */ | |
572 | extern struct nb_config *nb_config_dup(const struct nb_config *config); | |
573 | ||
574 | /* | |
575 | * Merge one configuration into another. | |
576 | * | |
577 | * config_dst | |
578 | * Configuration to merge to. | |
579 | * | |
580 | * config_src | |
581 | * Configuration to merge config_dst with. | |
582 | * | |
583 | * preserve_source | |
584 | * Specify whether config_src should be deleted or not after the merge | |
585 | * operation. | |
586 | * | |
587 | * Returns: | |
588 | * NB_OK on success, NB_ERR otherwise. | |
589 | */ | |
590 | extern int nb_config_merge(struct nb_config *config_dst, | |
591 | struct nb_config *config_src, bool preserve_source); | |
592 | ||
593 | /* | |
594 | * Replace one configuration by another. | |
595 | * | |
596 | * config_dst | |
597 | * Configuration to be replaced. | |
598 | * | |
599 | * config_src | |
600 | * Configuration to replace config_dst. | |
601 | * | |
602 | * preserve_source | |
603 | * Specify whether config_src should be deleted or not after the replace | |
604 | * operation. | |
605 | */ | |
606 | extern void nb_config_replace(struct nb_config *config_dst, | |
607 | struct nb_config *config_src, | |
608 | bool preserve_source); | |
609 | ||
610 | /* | |
611 | * Edit a candidate configuration. | |
612 | * | |
613 | * candidate | |
614 | * Candidate configuration to edit. | |
615 | * | |
616 | * nb_node | |
617 | * Northbound node associated to the configuration being edited. | |
618 | * | |
619 | * operation | |
620 | * Operation to apply. | |
621 | * | |
622 | * xpath | |
623 | * XPath of the configuration node being edited. | |
624 | * | |
625 | * previous | |
626 | * Previous value of the configuration node. Should be used only when the | |
627 | * operation is NB_OP_MOVE, otherwise this parameter is ignored. | |
628 | * | |
629 | * data | |
630 | * New value of the configuration node. | |
631 | * | |
632 | * Returns: | |
633 | * - NB_OK on success. | |
634 | * - NB_ERR_NOT_FOUND when the element to be deleted was not found. | |
635 | * - NB_ERR for other errors. | |
636 | */ | |
637 | extern int nb_candidate_edit(struct nb_config *candidate, | |
638 | const struct nb_node *nb_node, | |
639 | enum nb_operation operation, const char *xpath, | |
640 | const struct yang_data *previous, | |
641 | const struct yang_data *data); | |
642 | ||
643 | /* | |
644 | * Check if a candidate configuration is outdated and needs to be updated. | |
645 | * | |
646 | * candidate | |
647 | * Candidate configuration to check. | |
648 | * | |
649 | * Returns: | |
650 | * true if the candidate is outdated, false otherwise. | |
651 | */ | |
652 | extern bool nb_candidate_needs_update(const struct nb_config *candidate); | |
653 | ||
654 | /* | |
655 | * Update a candidate configuration by rebasing the changes on top of the latest | |
656 | * running configuration. Resolve conflicts automatically by giving preference | |
657 | * to the changes done in the candidate configuration. | |
658 | * | |
659 | * candidate | |
660 | * Candidate configuration to update. | |
661 | * | |
662 | * Returns: | |
663 | * NB_OK on success, NB_ERR otherwise. | |
664 | */ | |
665 | extern int nb_candidate_update(struct nb_config *candidate); | |
666 | ||
667 | /* | |
668 | * Validate a candidate configuration. Perform both YANG syntactic/semantic | |
669 | * validation and code-level validation using the northbound callbacks. | |
670 | * | |
671 | * WARNING: the candidate can be modified as part of the validation process | |
672 | * (e.g. add default nodes). | |
673 | * | |
674 | * candidate | |
675 | * Candidate configuration to validate. | |
676 | * | |
677 | * Returns: | |
678 | * NB_OK on success, NB_ERR_VALIDATION otherwise. | |
679 | */ | |
680 | extern int nb_candidate_validate(struct nb_config *candidate); | |
681 | ||
682 | /* | |
683 | * Create a new configuration transaction but do not commit it yet. Only | |
684 | * validate the candidate and prepare all resources required to apply the | |
685 | * configuration changes. | |
686 | * | |
687 | * candidate | |
688 | * Candidate configuration to commit. | |
689 | * | |
690 | * client | |
691 | * Northbound client performing the commit. | |
692 | * | |
364ad673 RW |
693 | * user |
694 | * Northbound user performing the commit (can be NULL). | |
695 | * | |
1c2facd1 RW |
696 | * comment |
697 | * Optional comment describing the commit. | |
698 | * | |
699 | * transaction | |
700 | * Output parameter providing the created transaction when one is created | |
701 | * successfully. In this case, it must be either aborted using | |
702 | * nb_candidate_commit_abort() or committed using | |
703 | * nb_candidate_commit_apply(). | |
704 | * | |
705 | * Returns: | |
706 | * - NB_OK on success. | |
707 | * - NB_ERR_NO_CHANGES when the candidate is identical to the running | |
708 | * configuration. | |
709 | * - NB_ERR_LOCKED when there's already another transaction in progress. | |
710 | * - NB_ERR_VALIDATION when the candidate fails the validation checks. | |
711 | * - NB_ERR_RESOURCE when the system fails to allocate resources to apply | |
712 | * the candidate configuration. | |
713 | * - NB_ERR for other errors. | |
714 | */ | |
715 | extern int nb_candidate_commit_prepare(struct nb_config *candidate, | |
364ad673 | 716 | enum nb_client client, const void *user, |
1c2facd1 RW |
717 | const char *comment, |
718 | struct nb_transaction **transaction); | |
719 | ||
720 | /* | |
721 | * Abort a previously created configuration transaction, releasing all resources | |
722 | * allocated during the preparation phase. | |
723 | * | |
724 | * transaction | |
725 | * Candidate configuration to abort. It's consumed by this function. | |
726 | */ | |
727 | extern void nb_candidate_commit_abort(struct nb_transaction *transaction); | |
728 | ||
729 | /* | |
730 | * Commit a previously created configuration transaction. | |
731 | * | |
732 | * transaction | |
733 | * Configuration transaction to commit. It's consumed by this function. | |
734 | * | |
735 | * save_transaction | |
736 | * Specify whether the transaction should be recorded in the transactions log | |
737 | * or not. | |
738 | * | |
739 | * transaction_id | |
740 | * Optional output parameter providing the ID of the committed transaction. | |
741 | */ | |
742 | extern void nb_candidate_commit_apply(struct nb_transaction *transaction, | |
743 | bool save_transaction, | |
744 | uint32_t *transaction_id); | |
745 | ||
746 | /* | |
747 | * Create a new transaction to commit a candidate configuration. This is a | |
748 | * convenience function that performs the two-phase commit protocol | |
749 | * transparently to the user. The cost is reduced flexibility, since | |
750 | * network-wide and multi-daemon transactions require the network manager to | |
751 | * take into account the results of the preparation phase of multiple managed | |
752 | * entities. | |
753 | * | |
754 | * candidate | |
755 | * Candidate configuration to commit. It's preserved regardless if the commit | |
756 | * operation fails or not. | |
757 | * | |
758 | * client | |
759 | * Northbound client performing the commit. | |
760 | * | |
364ad673 RW |
761 | * user |
762 | * Northbound user performing the commit (can be NULL). | |
763 | * | |
1c2facd1 RW |
764 | * save_transaction |
765 | * Specify whether the transaction should be recorded in the transactions log | |
766 | * or not. | |
767 | * | |
768 | * comment | |
769 | * Optional comment describing the commit. | |
770 | * | |
771 | * transaction_id | |
772 | * Optional output parameter providing the ID of the committed transaction. | |
773 | * | |
774 | * Returns: | |
775 | * - NB_OK on success. | |
776 | * - NB_ERR_NO_CHANGES when the candidate is identical to the running | |
777 | * configuration. | |
778 | * - NB_ERR_LOCKED when there's already another transaction in progress. | |
779 | * - NB_ERR_VALIDATION when the candidate fails the validation checks. | |
780 | * - NB_ERR_RESOURCE when the system fails to allocate resources to apply | |
781 | * the candidate configuration. | |
782 | * - NB_ERR for other errors. | |
783 | */ | |
784 | extern int nb_candidate_commit(struct nb_config *candidate, | |
364ad673 RW |
785 | enum nb_client client, const void *user, |
786 | bool save_transaction, const char *comment, | |
787 | uint32_t *transaction_id); | |
788 | ||
789 | /* | |
790 | * Lock the running configuration. | |
791 | * | |
792 | * client | |
793 | * Northbound client. | |
794 | * | |
795 | * user | |
796 | * Northbound user (can be NULL). | |
797 | * | |
798 | * Returns: | |
799 | * 0 on success, -1 when the running configuration is already locked. | |
800 | */ | |
801 | extern int nb_running_lock(enum nb_client client, const void *user); | |
802 | ||
803 | /* | |
804 | * Unlock the running configuration. | |
805 | * | |
806 | * client | |
807 | * Northbound client. | |
808 | * | |
809 | * user | |
810 | * Northbound user (can be NULL). | |
811 | * | |
812 | * Returns: | |
813 | * 0 on success, -1 when the running configuration is already unlocked or | |
814 | * locked by another client/user. | |
815 | */ | |
816 | extern int nb_running_unlock(enum nb_client client, const void *user); | |
817 | ||
818 | /* | |
819 | * Check if the running configuration is locked or not for the given | |
820 | * client/user. | |
821 | * | |
822 | * client | |
823 | * Northbound client. | |
824 | * | |
825 | * user | |
826 | * Northbound user (can be NULL). | |
827 | * | |
828 | * Returns: | |
829 | * 0 if the running configuration is unlocked or if the client/user owns the | |
830 | * lock, -1 otherwise. | |
831 | */ | |
832 | extern int nb_running_lock_check(enum nb_client client, const void *user); | |
1c2facd1 | 833 | |
1a4bc045 | 834 | /* |
364ad673 | 835 | * Iterate over operational data. |
1a4bc045 RW |
836 | * |
837 | * xpath | |
838 | * Data path of the YANG data we want to iterate over. | |
839 | * | |
840 | * translator | |
841 | * YANG module translator (might be NULL). | |
842 | * | |
843 | * flags | |
844 | * NB_OPER_DATA_ITER_ flags to control how the iteration is performed. | |
845 | * | |
846 | * cb | |
847 | * Function to call with each data node. | |
848 | * | |
849 | * arg | |
850 | * Arbitrary argument passed as the fourth parameter in each call to 'cb'. | |
851 | * | |
852 | * Returns: | |
853 | * NB_OK on success, NB_ERR otherwise. | |
854 | */ | |
855 | extern int nb_oper_data_iterate(const char *xpath, | |
856 | struct yang_translator *translator, | |
857 | uint32_t flags, nb_oper_data_cb cb, void *arg); | |
858 | ||
1c2facd1 RW |
859 | /* |
860 | * Validate if the northbound operation is valid for the given node. | |
861 | * | |
862 | * operation | |
863 | * Operation we want to check. | |
864 | * | |
865 | * snode | |
866 | * libyang schema node we want to check. | |
867 | * | |
868 | * Returns: | |
869 | * true if the operation is valid, false otherwise. | |
870 | */ | |
871 | extern bool nb_operation_is_valid(enum nb_operation operation, | |
872 | const struct lys_node *snode); | |
873 | ||
874 | /* | |
875 | * Send a YANG notification. This is a no-op unless the 'nb_notification_send' | |
876 | * hook was registered by a northbound plugin. | |
877 | * | |
878 | * xpath | |
879 | * XPath of the YANG notification. | |
880 | * | |
881 | * arguments | |
882 | * Linked list containing the arguments that should be sent. This list is | |
883 | * deleted after being used. | |
884 | * | |
885 | * Returns: | |
886 | * NB_OK on success, NB_ERR otherwise. | |
887 | */ | |
888 | extern int nb_notification_send(const char *xpath, struct list *arguments); | |
889 | ||
ccd43ada RW |
890 | /* |
891 | * Associate a user pointer to a configuration node. | |
892 | * | |
893 | * This should be called by northbound 'create' callbacks in the NB_EV_APPLY | |
894 | * phase only. | |
895 | * | |
896 | * dnode | |
897 | * libyang data node - only its XPath is used. | |
898 | * | |
899 | * entry | |
900 | * Arbitrary user-specified pointer. | |
901 | */ | |
902 | extern void nb_running_set_entry(const struct lyd_node *dnode, void *entry); | |
903 | ||
904 | /* | |
905 | * Unset the user pointer associated to a configuration node. | |
906 | * | |
907 | * This should be called by northbound 'destroy' callbacks in the NB_EV_APPLY | |
908 | * phase only. | |
909 | * | |
910 | * dnode | |
911 | * libyang data node - only its XPath is used. | |
912 | * | |
913 | * Returns: | |
914 | * The user pointer that was unset. | |
915 | */ | |
916 | extern void *nb_running_unset_entry(const struct lyd_node *dnode); | |
917 | ||
918 | /* | |
919 | * Find the user pointer (if any) associated to a configuration node. | |
920 | * | |
921 | * The XPath associated to the configuration node can be provided directly or | |
922 | * indirectly through a libyang data node. | |
923 | * | |
924 | * If an user point is not found, this function follows the parent nodes in the | |
925 | * running configuration until an user pointer is found or until the root node | |
926 | * is reached. | |
927 | * | |
928 | * dnode | |
929 | * libyang data node - only its XPath is used (can be NULL if 'xpath' is | |
930 | * provided). | |
931 | * | |
932 | * xpath | |
933 | * XPath of the configuration node (can be NULL if 'dnode' is provided). | |
934 | * | |
935 | * abort_if_not_found | |
936 | * When set to true, abort the program if no user pointer is found. | |
937 | * | |
938 | * As a rule of thumb, this parameter should be set to true in the following | |
939 | * scenarios: | |
940 | * - Calling this function from any northbound configuration callback during | |
941 | * the NB_EV_APPLY phase. | |
942 | * - Calling this function from a 'delete' northbound configuration callback | |
943 | * during any phase. | |
944 | * | |
945 | * In both the above cases, the given configuration node should contain an | |
946 | * user pointer except when there's a bug in the code, in which case it's | |
947 | * better to abort the program right away and eliminate the need for | |
948 | * unnecessary NULL checks. | |
949 | * | |
950 | * In all other cases, this parameter should be set to false and the caller | |
951 | * should check if the function returned NULL or not. | |
952 | * | |
953 | * Returns: | |
954 | * User pointer if found, NULL otherwise. | |
955 | */ | |
956 | extern void *nb_running_get_entry(const struct lyd_node *dnode, const char *xpath, | |
957 | bool abort_if_not_found); | |
958 | ||
1c2facd1 RW |
959 | /* |
960 | * Return a human-readable string representing a northbound event. | |
961 | * | |
962 | * event | |
963 | * Northbound event. | |
964 | * | |
965 | * Returns: | |
966 | * String representation of the given northbound event. | |
967 | */ | |
968 | extern const char *nb_event_name(enum nb_event event); | |
969 | ||
970 | /* | |
971 | * Return a human-readable string representing a northbound operation. | |
972 | * | |
973 | * operation | |
974 | * Northbound operation. | |
975 | * | |
976 | * Returns: | |
977 | * String representation of the given northbound operation. | |
978 | */ | |
979 | extern const char *nb_operation_name(enum nb_operation operation); | |
980 | ||
981 | /* | |
982 | * Return a human-readable string representing a northbound error. | |
983 | * | |
984 | * error | |
985 | * Northbound error. | |
986 | * | |
987 | * Returns: | |
988 | * String representation of the given northbound error. | |
989 | */ | |
990 | extern const char *nb_err_name(enum nb_error error); | |
991 | ||
992 | /* | |
993 | * Return a human-readable string representing a northbound client. | |
994 | * | |
995 | * client | |
996 | * Northbound client. | |
997 | * | |
998 | * Returns: | |
999 | * String representation of the given northbound client. | |
1000 | */ | |
1001 | extern const char *nb_client_name(enum nb_client client); | |
1002 | ||
1003 | /* | |
1004 | * Initialize the northbound layer. Should be called only once during the | |
1005 | * daemon initialization process. | |
1006 | * | |
1007 | * modules | |
1008 | * Array of YANG modules to parse and initialize. | |
1009 | * | |
1010 | * nmodules | |
1011 | * Size of the modules array. | |
1012 | */ | |
fbdc1c0a | 1013 | extern void nb_init(struct thread_master *tm, const struct frr_yang_module_info *modules[], |
1c2facd1 RW |
1014 | size_t nmodules); |
1015 | ||
1016 | /* | |
1017 | * Finish the northbound layer gracefully. Should be called only when the daemon | |
1018 | * is exiting. | |
1019 | */ | |
1020 | extern void nb_terminate(void); | |
1021 | ||
5e244469 RW |
1022 | #ifdef __cplusplus |
1023 | } | |
1024 | #endif | |
1025 | ||
1c2facd1 | 1026 | #endif /* _FRR_NORTHBOUND_H_ */ |