lib: introduce the northbound context structure

[mirror_frr.git] / lib / northbound_sysrepo.c

/*
 * Copyright (C) 2018  NetDEF, Inc.
 *                     Renato Westphal
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <zebra.h>

#include "log.h"
#include "lib_errors.h"
#include "command.h"
#include "debug.h"
#include "memory.h"
#include "libfrr.h"
#include "version.h"
#include "northbound.h"

#include <sysrepo.h>
#include <sysrepo/values.h>
#include <sysrepo/xpath.h>

DEFINE_MTYPE_STATIC(LIB, SYSREPO, "Sysrepo module")

static struct debug nb_dbg_client_sysrepo = {0, "Northbound client: Sysrepo"};

static struct thread_master *master;
static struct list *sysrepo_threads;
static sr_session_ctx_t *session;
static sr_conn_ctx_t *connection;
static struct nb_transaction *transaction;

static int frr_sr_read_cb(struct thread *thread);
static int frr_sr_write_cb(struct thread *thread);
static int frr_sr_finish(void);

/* Convert FRR YANG data value to sysrepo YANG data value. */
static int yang_data_frr2sr(struct yang_data *frr_data, sr_val_t *sr_data)
{
	struct nb_node *nb_node;
	const struct lys_node *snode;
	struct lys_node_container *scontainer;
	struct lys_node_leaf *sleaf;
	struct lys_node_leaflist *sleaflist;
	LY_DATA_TYPE type;

	sr_val_set_xpath(sr_data, frr_data->xpath);

	nb_node = nb_node_find(frr_data->xpath);
	if (!nb_node) {
		flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH,
			  "%s: unknown data path: %s", __func__,
			  frr_data->xpath);
		return -1;
	}

	snode = nb_node->snode;
	switch (snode->nodetype) {
	case LYS_CONTAINER:
		scontainer = (struct lys_node_container *)snode;
		if (!scontainer->presence)
			return -1;
		sr_data->type = SR_CONTAINER_PRESENCE_T;
		return 0;
	case LYS_LIST:
		sr_data->type = SR_LIST_T;
		return 0;
	case LYS_LEAF:
		sleaf = (struct lys_node_leaf *)snode;
		type = sleaf->type.base;
		break;
	case LYS_LEAFLIST:
		sleaflist = (struct lys_node_leaflist *)snode;
		type = sleaflist->type.base;
		break;
	default:
		return -1;
	}

	switch (type) {
	case LY_TYPE_BINARY:
		sr_val_set_str_data(sr_data, SR_BINARY_T, frr_data->value);
		break;
	case LY_TYPE_BITS:
		sr_val_set_str_data(sr_data, SR_BITS_T, frr_data->value);
		break;
	case LY_TYPE_BOOL:
		sr_data->type = SR_BOOL_T;
		sr_data->data.bool_val = yang_str2bool(frr_data->value);
		break;
	case LY_TYPE_DEC64:
		sr_data->type = SR_DECIMAL64_T;
		sr_data->data.decimal64_val =
			yang_str2dec64(frr_data->xpath, frr_data->value);
		break;
	case LY_TYPE_EMPTY:
		sr_data->type = SR_LEAF_EMPTY_T;
		break;
	case LY_TYPE_ENUM:
		sr_val_set_str_data(sr_data, SR_ENUM_T, frr_data->value);
		break;
	case LY_TYPE_IDENT:
		sr_val_set_str_data(sr_data, SR_IDENTITYREF_T, frr_data->value);
		break;
	case LY_TYPE_INST:
		sr_val_set_str_data(sr_data, SR_INSTANCEID_T, frr_data->value);
		break;
	case LY_TYPE_INT8:
		sr_data->type = SR_INT8_T;
		sr_data->data.int8_val = yang_str2int8(frr_data->value);
		break;
	case LY_TYPE_INT16:
		sr_data->type = SR_INT16_T;
		sr_data->data.int16_val = yang_str2int16(frr_data->value);
		break;
	case LY_TYPE_INT32:
		sr_data->type = SR_INT32_T;
		sr_data->data.int32_val = yang_str2int32(frr_data->value);
		break;
	case LY_TYPE_INT64:
		sr_data->type = SR_INT64_T;
		sr_data->data.int64_val = yang_str2int64(frr_data->value);
		break;
	case LY_TYPE_STRING:
		sr_val_set_str_data(sr_data, SR_STRING_T, frr_data->value);
		break;
	case LY_TYPE_UINT8:
		sr_data->type = SR_UINT8_T;
		sr_data->data.uint8_val = yang_str2uint8(frr_data->value);
		break;
	case LY_TYPE_UINT16:
		sr_data->type = SR_UINT16_T;
		sr_data->data.uint16_val = yang_str2uint16(frr_data->value);
		break;
	case LY_TYPE_UINT32:
		sr_data->type = SR_UINT32_T;
		sr_data->data.uint32_val = yang_str2uint32(frr_data->value);
		break;
	case LY_TYPE_UINT64:
		sr_data->type = SR_UINT64_T;
		sr_data->data.uint64_val = yang_str2uint64(frr_data->value);
		break;
	default:
		return -1;
	}

	return 0;
}

static int frr_sr_process_change(struct nb_config *candidate,
				 sr_change_oper_t sr_op, sr_val_t *sr_old_val,
				 sr_val_t *sr_new_val)
{
	struct nb_node *nb_node;
	enum nb_operation nb_op;
	sr_val_t *sr_data;
	const char *xpath;
	char value_str[YANG_VALUE_MAXLEN];
	struct yang_data *data;
	int ret;

	sr_data = sr_new_val ? sr_new_val : sr_old_val;
	assert(sr_data);

	xpath = sr_data->xpath;

	/* Non-presence container - nothing to do. */
	if (sr_data->type == SR_CONTAINER_T)
		return NB_OK;

	nb_node = nb_node_find(xpath);
	if (!nb_node) {
		flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH,
			  "%s: unknown data path: %s", __func__, xpath);
		return NB_ERR;
	}

	/* Map operation values. */
	switch (sr_op) {
	case SR_OP_CREATED:
	case SR_OP_MODIFIED:
		if (nb_operation_is_valid(NB_OP_CREATE, nb_node->snode))
			nb_op = NB_OP_CREATE;
		else if (nb_operation_is_valid(NB_OP_MODIFY, nb_node->snode)) {
			nb_op = NB_OP_MODIFY;
		} else
			/* Ignore list keys modifications. */
			return NB_OK;
		break;
	case SR_OP_DELETED:
		/*
		 * When a list is deleted or one of its keys is changed, we are
		 * notified about the removal of all of its leafs, even the ones
		 * that are non-optional. We need to ignore these notifications.
		 */
		if (!nb_operation_is_valid(NB_OP_DESTROY, nb_node->snode))
			return NB_OK;

		nb_op = NB_OP_DESTROY;
		break;
	case SR_OP_MOVED:
		nb_op = NB_OP_MOVE;
		break;
	default:
		flog_err(EC_LIB_DEVELOPMENT,
			 "%s: unexpected operation %u [xpath %s]", __func__,
			 sr_op, xpath);
		return NB_ERR;
	}

	sr_val_to_buff(sr_data, value_str, sizeof(value_str));
	data = yang_data_new(xpath, value_str);

	ret = nb_candidate_edit(candidate, nb_node, nb_op, xpath, NULL, data);
	yang_data_free(data);
	if (ret != NB_OK) {
		flog_warn(
			EC_LIB_NB_CANDIDATE_EDIT_ERROR,
			"%s: failed to edit candidate configuration: operation [%s] xpath [%s]",
			__func__, nb_operation_name(nb_op), xpath);
		return NB_ERR;
	}

	return NB_OK;
}

static int frr_sr_config_change_cb_verify(sr_session_ctx_t *session,
					  const char *module_name,
					  bool startup_config)
{
	sr_change_iter_t *it;
	int ret;
	sr_change_oper_t sr_op;
	sr_val_t *sr_old_val, *sr_new_val;
	char xpath[XPATH_MAXLEN];
	struct nb_context context = {};
	struct nb_config *candidate;

	snprintf(xpath, sizeof(xpath), "/%s:*", module_name);
	ret = sr_get_changes_iter(session, xpath, &it);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_LIBSYSREPO,
			 "%s: sr_get_changes_iter() failed for xpath %s",
			 __func__, xpath);
		return ret;
	}

	candidate = nb_config_dup(running_config);

	while ((ret = sr_get_change_next(session, it, &sr_op, &sr_old_val,
					 &sr_new_val))
	       == SR_ERR_OK) {
		ret = frr_sr_process_change(candidate, sr_op, sr_old_val,
					    sr_new_val);
		sr_free_val(sr_old_val);
		sr_free_val(sr_new_val);
		if (ret != NB_OK)
			break;
	}

	sr_free_change_iter(it);
	if (ret != NB_OK && ret != SR_ERR_NOT_FOUND) {
		nb_config_free(candidate);
		return SR_ERR_INTERNAL;
	}

	transaction = NULL;
	context.client = NB_CLIENT_SYSREPO;
	if (startup_config) {
		/*
		 * sysrepod sends the entire startup configuration using a
		 * single event (SR_EV_ENABLED). This means we need to perform
		 * the full two-phase commit protocol in one go here.
		 */
		ret = nb_candidate_commit(&context, candidate, true, NULL,
					  NULL);
	} else {
		/*
		 * Validate the configuration changes and allocate all resources
		 * required to apply them.
		 */
		ret = nb_candidate_commit_prepare(&context, candidate, NULL,
						  &transaction);
	}

	/* Map northbound return code to sysrepo return code. */
	switch (ret) {
	case NB_OK:
		return SR_ERR_OK;
	case NB_ERR_NO_CHANGES:
		nb_config_free(candidate);
		return SR_ERR_OK;
	case NB_ERR_LOCKED:
		return SR_ERR_LOCKED;
	case NB_ERR_RESOURCE:
		return SR_ERR_NOMEM;
	default:
		return SR_ERR_VALIDATION_FAILED;
	}
}

static int frr_sr_config_change_cb_apply(sr_session_ctx_t *session,
					 const char *module_name)
{
	/* Apply the transaction. */
	if (transaction) {
		struct nb_config *candidate = transaction->config;

		nb_candidate_commit_apply(transaction, true, NULL);
		nb_config_free(candidate);
	}

	return SR_ERR_OK;
}

static int frr_sr_config_change_cb_abort(sr_session_ctx_t *session,
					 const char *module_name)
{
	/* Abort the transaction. */
	if (transaction) {
		struct nb_config *candidate = transaction->config;

		nb_candidate_commit_abort(transaction);
		nb_config_free(candidate);
	}

	return SR_ERR_OK;
}

/* Callback for changes in the running configuration. */
static int frr_sr_config_change_cb(sr_session_ctx_t *session,
				   const char *module_name,
				   sr_notif_event_t sr_ev, void *private_ctx)
{
	switch (sr_ev) {
	case SR_EV_ENABLED:
		return frr_sr_config_change_cb_verify(session, module_name,
						      true);
	case SR_EV_VERIFY:
		return frr_sr_config_change_cb_verify(session, module_name,
						      false);
	case SR_EV_APPLY:
		return frr_sr_config_change_cb_apply(session, module_name);
	case SR_EV_ABORT:
		return frr_sr_config_change_cb_abort(session, module_name);
	default:
		flog_err(EC_LIB_LIBSYSREPO, "%s: unknown sysrepo event: %u",
			 __func__, sr_ev);
		return SR_ERR_INTERNAL;
	}
}

static int frr_sr_state_data_iter_cb(const struct lys_node *snode,
				     struct yang_translator *translator,
				     struct yang_data *data, void *arg)
{
	struct list *elements = arg;

	listnode_add(elements, data);

	return NB_OK;
}

/* Callback for state retrieval. */
static int frr_sr_state_cb(const char *xpath, sr_val_t **values,
			   size_t *values_cnt, uint64_t request_id,
			   const char *original_xpath, void *private_ctx)
{
	struct list *elements;
	struct yang_data *data;
	struct listnode *node;
	sr_val_t *v;
	int ret, count, i = 0;

	elements = yang_data_list_new();
	if (nb_oper_data_iterate(xpath, NULL, NB_OPER_DATA_ITER_NORECURSE,
				 frr_sr_state_data_iter_cb, elements)
	    != NB_OK) {
		flog_warn(EC_LIB_NB_OPERATIONAL_DATA,
			  "%s: failed to obtain operational data [xpath %s]",
			  __func__, xpath);
		goto exit;
	}

	if (list_isempty(elements))
		goto exit;

	count = listcount(elements);
	ret = sr_new_values(count, &v);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_LIBSYSREPO, "%s: sr_new_values(): %s", __func__,
			 sr_strerror(ret));
		goto exit;
	}

	for (ALL_LIST_ELEMENTS_RO(elements, node, data)) {
		if (yang_data_frr2sr(data, &v[i++]) != 0) {
			flog_err(EC_LIB_SYSREPO_DATA_CONVERT,
				 "%s: failed to convert data to sysrepo format",
				 __func__);
		}
	}

	*values = v;
	*values_cnt = count;

	list_delete(&elements);

	return SR_ERR_OK;

exit:
	list_delete(&elements);
	*values = NULL;
	*values_cnt = 0;

	return SR_ERR_OK;
}

static int frr_sr_config_rpc_cb(const char *xpath, const sr_val_t *sr_input,
				const size_t input_cnt, sr_val_t **sr_output,
				size_t *sr_output_cnt, void *private_ctx)
{
	struct nb_node *nb_node;
	struct list *input;
	struct list *output;
	struct yang_data *data;
	size_t cb_output_cnt;
	int ret = SR_ERR_OK;

	nb_node = nb_node_find(xpath);
	if (!nb_node) {
		flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH,
			  "%s: unknown data path: %s", __func__, xpath);
		return SR_ERR_INTERNAL;
	}

	input = yang_data_list_new();
	output = yang_data_list_new();

	/* Process input. */
	for (size_t i = 0; i < input_cnt; i++) {
		char value_str[YANG_VALUE_MAXLEN];

		sr_val_to_buff(&sr_input[i], value_str, sizeof(value_str));

		data = yang_data_new(xpath, value_str);
		listnode_add(input, data);
	}

	/* Execute callback registered for this XPath. */
	if (nb_callback_rpc(nb_node, xpath, input, output) != NB_OK) {
		flog_warn(EC_LIB_NB_CB_RPC, "%s: rpc callback failed: %s",
			  __func__, xpath);
		ret = SR_ERR_OPERATION_FAILED;
		goto exit;
	}

	/* Process output. */
	if (listcount(output) > 0) {
		sr_val_t *values = NULL;
		struct listnode *node;
		int i = 0;

		cb_output_cnt = listcount(output);
		ret = sr_new_values(cb_output_cnt, &values);
		if (ret != SR_ERR_OK) {
			flog_err(EC_LIB_LIBSYSREPO, "%s: sr_new_values(): %s",
				 __func__, sr_strerror(ret));
			goto exit;
		}

		for (ALL_LIST_ELEMENTS_RO(output, node, data)) {
			if (yang_data_frr2sr(data, &values[i++]) != 0) {
				flog_err(
					EC_LIB_SYSREPO_DATA_CONVERT,
					"%s: failed to convert data to Sysrepo format",
					__func__);
				ret = SR_ERR_INTERNAL;
				sr_free_values(values, cb_output_cnt);
				goto exit;
			}
		}

		*sr_output = values;
		*sr_output_cnt = cb_output_cnt;
	}

exit:
	/* Release memory. */
	list_delete(&input);
	list_delete(&output);

	return ret;
}

static int frr_sr_notification_send(const char *xpath, struct list *arguments)
{
	sr_val_t *values = NULL;
	size_t values_cnt = 0;
	int ret;

	if (arguments && listcount(arguments) > 0) {
		struct yang_data *data;
		struct listnode *node;
		int i = 0;

		values_cnt = listcount(arguments);
		ret = sr_new_values(values_cnt, &values);
		if (ret != SR_ERR_OK) {
			flog_err(EC_LIB_LIBSYSREPO, "%s: sr_new_values(): %s",
				 __func__, sr_strerror(ret));
			return NB_ERR;
		}

		for (ALL_LIST_ELEMENTS_RO(arguments, node, data)) {
			if (yang_data_frr2sr(data, &values[i++]) != 0) {
				flog_err(
					EC_LIB_SYSREPO_DATA_CONVERT,
					"%s: failed to convert data to sysrepo format",
					__func__);
				sr_free_values(values, values_cnt);
				return NB_ERR;
			}
		}
	}

	ret = sr_event_notif_send(session, xpath, values, values_cnt,
				  SR_EV_NOTIF_DEFAULT);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_LIBSYSREPO,
			 "%s: sr_event_notif_send() failed for xpath %s",
			 __func__, xpath);
		return NB_ERR;
	}

	return NB_OK;
}

/* Code to integrate the sysrepo client into FRR main event loop. */
struct sysrepo_thread {
	struct thread *thread;
	sr_fd_event_t event;
	int fd;
};

static struct sysrepo_thread *frr_sr_fd_lookup(sr_fd_event_t event, int fd)
{
	struct sysrepo_thread *sr_thread;
	struct listnode *node;

	for (ALL_LIST_ELEMENTS_RO(sysrepo_threads, node, sr_thread)) {
		if (sr_thread->event == event && sr_thread->fd == fd)
			return sr_thread;
	}

	return NULL;
}

static void frr_sr_fd_add(int event, int fd)
{
	struct sysrepo_thread *sr_thread;

	if (frr_sr_fd_lookup(event, fd) != NULL)
		return;

	sr_thread = XCALLOC(MTYPE_SYSREPO, sizeof(*sr_thread));
	sr_thread->event = event;
	sr_thread->fd = fd;
	listnode_add(sysrepo_threads, sr_thread);

	switch (event) {
	case SR_FD_INPUT_READY:
		thread_add_read(master, frr_sr_read_cb, NULL, fd,
				&sr_thread->thread);
		break;
	case SR_FD_OUTPUT_READY:
		thread_add_write(master, frr_sr_write_cb, NULL, fd,
				 &sr_thread->thread);
		break;
	default:
		return;
	}
}

static void frr_sr_fd_free(struct sysrepo_thread *sr_thread)
{
	THREAD_OFF(sr_thread->thread);
	XFREE(MTYPE_SYSREPO, sr_thread);
}

static void frr_sr_fd_del(int event, int fd)
{
	struct sysrepo_thread *sr_thread;

	sr_thread = frr_sr_fd_lookup(event, fd);
	if (!sr_thread)
		return;

	listnode_delete(sysrepo_threads, sr_thread);
	frr_sr_fd_free(sr_thread);
}

static void frr_sr_fd_update(sr_fd_change_t *fd_change_set,
			     size_t fd_change_set_cnt)
{
	for (size_t i = 0; i < fd_change_set_cnt; i++) {
		int fd = fd_change_set[i].fd;
		int event = fd_change_set[i].events;

		if (event != SR_FD_INPUT_READY && event != SR_FD_OUTPUT_READY)
			continue;

		switch (fd_change_set[i].action) {
		case SR_FD_START_WATCHING:
			frr_sr_fd_add(event, fd);
			break;
		case SR_FD_STOP_WATCHING:
			frr_sr_fd_del(event, fd);
			break;
		default:
			break;
		}
	}
}

static int frr_sr_read_cb(struct thread *thread)
{
	int fd = THREAD_FD(thread);
	sr_fd_change_t *fd_change_set = NULL;
	size_t fd_change_set_cnt = 0;
	int ret;

	ret = sr_fd_event_process(fd, SR_FD_INPUT_READY, &fd_change_set,
				  &fd_change_set_cnt);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_LIBSYSREPO, "%s: sr_fd_event_process(): %s",
			 __func__, sr_strerror(ret));
		return -1;
	}

	thread = NULL;
	thread_add_read(master, frr_sr_read_cb, NULL, fd, &thread);

	frr_sr_fd_update(fd_change_set, fd_change_set_cnt);
	free(fd_change_set);

	return 0;
}

static int frr_sr_write_cb(struct thread *thread)
{
	int fd = THREAD_FD(thread);
	sr_fd_change_t *fd_change_set = NULL;
	size_t fd_change_set_cnt = 0;
	int ret;

	ret = sr_fd_event_process(fd, SR_FD_OUTPUT_READY, &fd_change_set,
				  &fd_change_set_cnt);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_LIBSYSREPO, "%s: sr_fd_event_process(): %s",
			 __func__, sr_strerror(ret));
		return -1;
	}

	frr_sr_fd_update(fd_change_set, fd_change_set_cnt);
	free(fd_change_set);

	return 0;
}

static void frr_sr_subscribe_config(struct yang_module *module)
{
	int ret;

	ret = sr_module_change_subscribe(
		session, module->name, frr_sr_config_change_cb, NULL, 0,
		SR_SUBSCR_DEFAULT | SR_SUBSCR_EV_ENABLED,
		&module->sr_subscription);
	if (ret != SR_ERR_OK)
		flog_err(EC_LIB_LIBSYSREPO, "sr_module_change_subscribe(): %s",
			 sr_strerror(ret));
}

static int frr_sr_subscribe_state(const struct lys_node *snode, void *arg)
{
	struct yang_module *module = arg;
	struct nb_node *nb_node;
	int ret;

	if (!CHECK_FLAG(snode->flags, LYS_CONFIG_R))
		return YANG_ITER_CONTINUE;
	/* We only need to subscribe to the root of the state subtrees. */
	if (snode->parent && CHECK_FLAG(snode->parent->flags, LYS_CONFIG_R))
		return YANG_ITER_CONTINUE;

	nb_node = snode->priv;

	DEBUGD(&nb_dbg_client_sysrepo, "%s: providing data to '%s'", __func__,
	       nb_node->xpath);

	ret = sr_dp_get_items_subscribe(
		session, nb_node->xpath, frr_sr_state_cb, NULL,
		SR_SUBSCR_CTX_REUSE, &module->sr_subscription);
	if (ret != SR_ERR_OK)
		flog_err(EC_LIB_LIBSYSREPO, "sr_dp_get_items_subscribe(): %s",
			 sr_strerror(ret));

	return YANG_ITER_CONTINUE;
}

static int frr_sr_subscribe_rpc(const struct lys_node *snode, void *arg)
{
	struct yang_module *module = arg;
	struct nb_node *nb_node;
	int ret;

	if (snode->nodetype != LYS_RPC)
		return YANG_ITER_CONTINUE;

	nb_node = snode->priv;

	DEBUGD(&nb_dbg_client_sysrepo, "%s: providing RPC to '%s'", __func__,
	       nb_node->xpath);

	ret = sr_rpc_subscribe(session, nb_node->xpath, frr_sr_config_rpc_cb,
			       NULL, SR_SUBSCR_CTX_REUSE,
			       &module->sr_subscription);
	if (ret != SR_ERR_OK)
		flog_err(EC_LIB_LIBSYSREPO, "sr_rpc_subscribe(): %s",
			 sr_strerror(ret));

	return YANG_ITER_CONTINUE;
}

static int frr_sr_subscribe_action(const struct lys_node *snode, void *arg)
{
	struct yang_module *module = arg;
	struct nb_node *nb_node;
	int ret;

	if (snode->nodetype != LYS_ACTION)
		return YANG_ITER_CONTINUE;

	nb_node = snode->priv;

	DEBUGD(&nb_dbg_client_sysrepo, "%s: providing action to '%s'", __func__,
	       nb_node->xpath);

	ret = sr_action_subscribe(session, nb_node->xpath, frr_sr_config_rpc_cb,
				  NULL, SR_SUBSCR_CTX_REUSE,
				  &module->sr_subscription);
	if (ret != SR_ERR_OK)
		flog_err(EC_LIB_LIBSYSREPO, "sr_action_subscribe(): %s",
			 sr_strerror(ret));

	return YANG_ITER_CONTINUE;
}

/* CLI commands. */
DEFUN (debug_nb_sr,
       debug_nb_sr_cmd,
       "[no] debug northbound client sysrepo",
       NO_STR
       DEBUG_STR
       "Northbound debugging\n"
       "Northbound client\n"
       "Sysrepo\n")
{
	uint32_t mode = DEBUG_NODE2MODE(vty->node);
	bool no = strmatch(argv[0]->text, "no");

	DEBUG_MODE_SET(&nb_dbg_client_sysrepo, mode, !no);

	return CMD_SUCCESS;
}

static int frr_sr_debug_config_write(struct vty *vty)
{
	if (DEBUG_MODE_CHECK(&nb_dbg_client_sysrepo, DEBUG_MODE_CONF))
		vty_out(vty, "debug northbound client sysrepo\n");

	return 0;
}

static int frr_sr_debug_set_all(uint32_t flags, bool set)
{
	DEBUG_FLAGS_SET(&nb_dbg_client_sysrepo, flags, set);

	/* If all modes have been turned off, don't preserve options. */
	if (!DEBUG_MODE_CHECK(&nb_dbg_client_sysrepo, DEBUG_MODE_ALL))
		DEBUG_CLEAR(&nb_dbg_client_sysrepo);

	return 0;
}

static void frr_sr_cli_init(void)
{
	hook_register(nb_client_debug_config_write, frr_sr_debug_config_write);
	hook_register(nb_client_debug_set_all, frr_sr_debug_set_all);

	install_element(ENABLE_NODE, &debug_nb_sr_cmd);
	install_element(CONFIG_NODE, &debug_nb_sr_cmd);
}

/* FRR's Sysrepo initialization. */
static int frr_sr_init(const char *program_name)
{
	struct yang_module *module;
	int sysrepo_fd, ret;

	sysrepo_threads = list_new();

	ret = sr_fd_watcher_init(&sysrepo_fd, NULL);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_SYSREPO_INIT, "%s: sr_fd_watcher_init(): %s",
			 __func__, sr_strerror(ret));
		goto cleanup;
	}

	/* Connect to Sysrepo. */
	ret = sr_connect(program_name, SR_CONN_DEFAULT, &connection);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_SYSREPO_INIT, "%s: sr_connect(): %s", __func__,
			 sr_strerror(ret));
		goto cleanup;
	}

	/* Start session. */
	ret = sr_session_start(connection, SR_DS_RUNNING, SR_SESS_DEFAULT,
			       &session);
	if (ret != SR_ERR_OK) {
		flog_err(EC_LIB_SYSREPO_INIT, "%s: sr_session_start(): %s",
			 __func__, sr_strerror(ret));
		goto cleanup;
	}

	/* Perform subscriptions. */
	RB_FOREACH (module, yang_modules, &yang_modules) {
		frr_sr_subscribe_config(module);
		yang_snodes_iterate_module(module->info, frr_sr_subscribe_state,
					   0, module);
		yang_snodes_iterate_module(module->info, frr_sr_subscribe_rpc,
					   0, module);
		yang_snodes_iterate_module(module->info,
					   frr_sr_subscribe_action, 0, module);
	}

	hook_register(nb_notification_send, frr_sr_notification_send);

	frr_sr_fd_add(SR_FD_INPUT_READY, sysrepo_fd);

	return 0;

cleanup:
	frr_sr_finish();

	return -1;
}

static int frr_sr_finish(void)
{
	struct yang_module *module;

	RB_FOREACH (module, yang_modules, &yang_modules) {
		if (!module->sr_subscription)
			continue;
		sr_unsubscribe(session, module->sr_subscription);
	}

	if (session)
		sr_session_stop(session);
	if (connection)
		sr_disconnect(connection);

	sysrepo_threads->del = (void (*)(void *))frr_sr_fd_free;
	list_delete(&sysrepo_threads);
	sr_fd_watcher_cleanup();

	return 0;
}

static int frr_sr_module_late_init(struct thread_master *tm)
{
	master = tm;

	if (frr_sr_init(frr_get_progname()) < 0) {
		flog_err(EC_LIB_SYSREPO_INIT,
			 "failed to initialize the Sysrepo module");
		return -1;
	}

	hook_register(frr_fini, frr_sr_finish);
	frr_sr_cli_init();

	return 0;
}

static int frr_sr_module_init(void)
{
	hook_register(frr_late_init, frr_sr_module_late_init);

	return 0;
}

FRR_MODULE_SETUP(.name = "frr_sysrepo", .version = FRR_VERSION,
		 .description = "FRR sysrepo integration module",
		 .init = frr_sr_module_init, )