Mirror/frr
0
0
Fork 1
mirror of https://github.com/FRRouting/frr.git synced 2025-04-30 13:37:17 +02:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

lib: change and improve walk finish callback function API

Browse source 
Signed-off-by: Christian Hopps <chopps@labn.net>
This commit is contained in:
Christian Hopps 2025-01-05 00:29:05 -05:00
parent 5ffa10aac1
commit 9aa2b04874
3 changed files with 37 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
lib/mgmt_be_client.c
View file

@ -854,8 +854,15 @@ static enum nb_error be_client_send_tree_data_batch(const struct lyd_node *tree,
more = true;
ret = NB_OK;
}
if (ret != NB_OK)
if (ret != NB_OK) {
if (be_client_send_error(client, args->txn_id, args->req_id, false, -EINVAL,
"BE client %s txn-id %Lu error fetching oper state %d",
client->name, args->txn_id, ret))
ret = NB_ERR;
else
ret = NB_OK;
goto done;
}
tree_msg = mgmt_msg_native_alloc_msg(struct mgmt_msg_tree_data, 0,
MTYPE_MSG_NATIVE_TREE_DATA);
@ -870,20 +877,15 @@ static enum nb_error be_client_send_tree_data_batch(const struct lyd_node *tree,
(LYD_PRINT_SHRINK | LYD_PRINT_WD_EXPLICIT |
LYD_PRINT_WITHSIBLINGS));
if (err) {
ret = NB_ERR;
goto done;
mgmt_msg_native_free_msg(tree_msg);
/* We will be called again to send the error */
return NB_ERR;
}
(void)be_client_send_native_msg(client, tree_msg,
mgmt_msg_native_get_msg_len(tree_msg),
false);
done:
mgmt_msg_native_free_msg(tree_msg);
if (ret)
be_client_send_error(client, args->txn_id, args->req_id, false,
-EINVAL,
"BE client %s txn-id %" PRIu64
" error fetching oper state %d",
client->name, args->txn_id, ret);
done:
if (ret != NB_OK || !more)
XFREE(MTYPE_MGMTD_BE_GT_CB_ARGS, args);
return ret;

15
lib/northbound.h
View file

@ -777,16 +777,19 @@ typedef int (*nb_oper_data_cb)(const struct lysc_node *snode,
* error.
*
* If nb_op_iterate_yielding() was passed with @should_batch set then this
* callback will be invoked during each portion (batch) of the walk.
* callback will be invoked during each portion (batch) of the walk with @ret
* set to NB_YIELD.
*
* The @tree is read-only and should not be modified or freed.
*
* If this function returns anything but NB_OK then the walk will be terminated.
* and this function will not be called again regardless of if @ret was
* `NB_YIELD` or not.
* When @ret is NB_YIELD and this function returns anything but NB_OK then the
* walk will be terminated, and this function *will* be called again with @ret
* set the non-NB_OK return value it just returned. This allows the callback
* have a single bit of code to send an error message and do any cleanup for any
* type of failure, whether that failure was from itself or from the infra code.
*
* Return: NB_OK to continue or complete the walk normally, otherwise an error
* to immediately terminate the walk.
* Return: NB_OK or an error during handling of @ret == NB_YIELD otherwise the
* value is ignored.
*/
/* Callback function used by nb_oper_data_iter_yielding(). */
typedef enum nb_error (*nb_oper_data_finish_cb)(const struct lyd_node *tree,

33
lib/northbound_oper.c
View file

@ -1483,17 +1483,13 @@ static void nb_op_walk_continue(struct event *thread)
ret = __walk(ys, true);
if (ret == NB_YIELD) {
if (nb_op_yield(ys) != NB_OK) {
if (ys->should_batch)
goto stopped;
else
goto finish;
}
return;
ret = nb_op_yield(ys);
if (ret == NB_OK)
return;
}
finish:
assert(ret != NB_YIELD);
(*ys->finish)(ys_root_node(ys), ys->finish_arg, ret);
stopped:
nb_op_free_yield_state(ys, false);
}
@ -1552,6 +1548,13 @@ static void nb_op_trim_yield_state(struct nb_op_yield_state *ys)
(int)darr_lasti(ys->node_infos));
}
/**
* nb_op_yield() - Yield during the walk.
* @ys: the yield state tracking the walk.
*
* Return: Any error from the `ys->finish` callback which should terminate the
* walk. Otherwise if `ys->should_batch` == false always returns NB_OK.
*/
static enum nb_error nb_op_yield(struct nb_op_yield_state *ys)
{
enum nb_error ret;
@ -1764,17 +1767,13 @@ void *nb_oper_walk(const char *xpath, struct yang_translator *translator,
ret = nb_op_walk_start(ys);
if (ret == NB_YIELD) {
if (nb_op_yield(ys) != NB_OK) {
if (ys->should_batch)
goto stopped;
else
goto finish;
}
return ys;
ret = nb_op_yield(ys);
if (ret == NB_OK)
return ys;
}
finish:
assert(ret != NB_YIELD);
(void)(*ys->finish)(ys_root_node(ys), ys->finish_arg, ret);
stopped:
nb_op_free_yield_state(ys, false);
return NULL;
}