Merge pull request FRRouting#20259 from LabNConsulting/chopps/libyang4

lib: adapt to libyang4 NBC API changes

Author: donaldsharp

configure.ac

@@ -2086,6 +2086,20 @@ dnl ---------------
 PKG_CHECK_MODULES([LIBYANG], [libyang >= 2.1.128], , [
 AC_MSG_ERROR([m4_normalize([libyang >= 2.1.128 is required, and was not found on your system.
 Please consult doc/developer/building-libyang.rst for instructions on installing or building libyang.])])])
+
+LIBYANG_MAJOR=$(pkg-config --modversion libyang | cut -f1 -d.)
+if test "$LIBYANG_MAJOR" -ge 4; then
+  dnl NOTE: binary encoding (LYD_LYB) is no longer supported in v4,
+  dnl so v3 may be more efficient for certain use cases
+  AC_MSG_WARN([m4_normalize([
+    Libyang v4 is supported; however libyang v3 use is still suggested. Libyang
+    v4 has changed its binary encoding (LYD_LYB) format to a very restricted
+    subset of users which does not include FRR. This mean FRR will always use
+    JSON or XML even when passing intermediate results internally.
+    ])
+  ])
+fi
+
 ac_cflags_save="$CFLAGS"
 CFLAGS="$CFLAGS $LIBYANG_CFLAGS"
 AC_CHECK_MEMBER([struct lyd_node.priv], [], [

doc/developer/logging.rst

@@ -444,6 +444,14 @@ General utility formats
    (This is a GNU extension not specific to FRR.  FRR guarantees it is
    available on all systems in printfrr, though BSDs support it in printf too.)
 
+.. frrfmt:: %pSA (const char **)
+
+   ([S]tring [A]rray.)  Like ``%s``, but prints an array of strings (char *)
+   until a NULL pointer is seen.
+
+   If a length is specified (``%*pSA`` or ``%.*pSA``), it is the number of
+   strings in the array to print.
+
 .. frrfmt:: %pSQ (char *)
 
    ([S]tring [Q]uote.)  Like ``%s``, but produce a quoted string.  Options:

lib/if.c

@@ -1762,8 +1762,8 @@ static enum nb_error lib_interface_state_if_index_get(const struct nb_node *nb_n
 	const struct interface *ifp = list_entry;
 	int32_t value = ifp->ifindex;
 
-	if (lyd_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
-			     LYD_NEW_PATH_UPDATE, NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 	return NB_OK;
 }
@@ -1778,8 +1778,8 @@ static enum nb_error lib_interface_state_mtu_get(const struct nb_node *nb_node,
 	const struct interface *ifp = list_entry;
 	uint32_t value = ifp->mtu;
 
-	if (lyd_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
-			     LYD_NEW_PATH_UPDATE, NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 	return NB_OK;
 }
@@ -1794,8 +1794,8 @@ static enum nb_error lib_interface_state_speed_get(const struct nb_node *nb_node
 	const struct interface *ifp = list_entry;
 	uint32_t value = ifp->speed;
 
-	if (lyd_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
-			     LYD_NEW_PATH_UPDATE, NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 	return NB_OK;
 }
@@ -1810,8 +1810,8 @@ static enum nb_error lib_interface_state_metric_get(const struct nb_node *nb_nod
 	const struct interface *ifp = list_entry;
 	uint32_t value = ifp->metric;
 
-	if (lyd_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
-			     LYD_NEW_PATH_UPDATE, NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 	return NB_OK;
 }

lib/mgmt_be_client.c

@@ -848,17 +848,15 @@ static void be_client_handle_rpc(struct mgmt_be_client *client, uint64_t txn_id,
 		 * It is especially needed for actions, because their parents
 		 * may hold necessary information.
 		 */
-		err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0,
-				    NULL, &input);
+		err = yang_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL, &input);
 	}
 	if (err) {
 		be_client_send_error(client, txn_id, rpc_msg->req_id, false, -EINVAL,
 				     "Can't parse RPC data for: %s", xpath);
 		return;
 	}
 
-	err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL,
-			    &output);
+	err = yang_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL, &output);
 	if (err) {
 		lyd_free_all(input);
 		be_client_send_error(client, txn_id, rpc_msg->req_id, false,
@@ -1223,8 +1221,8 @@ static enum nb_error clients_client_state_candidate_config_version_get(
 	else
 		value = __be_client->running_config->version;
 
-	if (lyd_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
-			     LYD_NEW_PATH_UPDATE, NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 
 	return NB_OK;
@@ -1240,8 +1238,8 @@ static enum nb_error clients_client_state_running_config_version_get(const struc
 	const struct lysc_node *snode = nb_node->snode;
 	uint64_t value = __be_client->running_config->version;
 
-	if (lyd_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
-			     LYD_NEW_PATH_UPDATE, NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, &value, sizeof(value),
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 
 	return NB_OK;

lib/northbound.c

@@ -723,8 +723,8 @@ static LY_ERR dnode_create(struct nb_config *candidate, const char *xpath, const
 	struct lyd_node *dnode;
 	LY_ERR err;
 
-	err = lyd_new_path2(candidate->dnode, ly_native_ctx, xpath, value, 0, 0, options, NULL,
-			    &dnode);
+	err = yang_new_path2(candidate->dnode, ly_native_ctx, xpath, value, 0, 0, options, NULL,
+			     &dnode);
 	if (err) {
 		flog_warn(EC_LIB_LIBYANG, "%s: lyd_new_path(%s) failed: %d",
 			  __func__, xpath, err);
@@ -892,8 +892,8 @@ static int nb_candidate_edit_tree_add(struct nb_config *candidate,
 	 * merged later with candidate.
 	 */
 	if (parent_xpath) {
-		err = lyd_new_path2(NULL, ly_native_ctx, parent_xpath, NULL, 0,
-				    0, 0, &tree, &parent);
+		err = yang_new_path2(NULL, ly_native_ctx, parent_xpath, NULL, 0, 0, 0, &tree,
+				     &parent);
 		if (err) {
 			yang_print_errors(ly_native_ctx, errmsg, errmsg_len);
 			ret = NB_ERR;
@@ -2301,7 +2301,12 @@ bool nb_cb_operation_is_valid(enum nb_cb_operation operation,
 			if (sleaf->when)
 				return true;
 			if (CHECK_FLAG(sleaf->flags, LYS_MAND_TRUE)
-			    || sleaf->dflt)
+#if (LY_VERSION_MAJOR < 4)
+			    || sleaf->dflt
+#else
+			    || sleaf->dflt.str
+#endif
+			)
 				return false;
 			break;
 		case LYS_CONTAINER:

lib/northbound_cli.c

@@ -296,8 +296,7 @@ int nb_cli_rpc(struct vty *vty, const char *xpath, struct lyd_node **output_p)
 	}
 
 	/* create input tree */
-	err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL,
-			    &input);
+	err = yang_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL, &input);
 	assert(err == LY_SUCCESS);
 
 	for (size_t i = 0; i < vty->num_rpc_params; i++) {
@@ -318,8 +317,7 @@ int nb_cli_rpc(struct vty *vty, const char *xpath, struct lyd_node **output_p)
 	assert(err == LY_SUCCESS);
 
 	/* create output tree root for population in the callback */
-	err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL,
-			    &output);
+	err = yang_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL, &output);
 	assert(err == LY_SUCCESS);
 
 	ret = nb_callback_rpc(nb_node, xpath, input, output, errmsg,

lib/northbound_grpc.cpp

@@ -1032,8 +1032,8 @@ grpc::Status HandleUnaryExecute(
 				    "Unknown data path");
 
 	// Create input data tree.
-	err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0,
-			    (LYD_ANYDATA_VALUETYPE)0, 0, NULL, &input_tree);
+	err = yang_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, (LYD_ANYDATA_VALUETYPE)0, 0,
+			     NULL, &input_tree);
 	if (err != LY_SUCCESS) {
 		return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
 				    "Invalid data path");
@@ -1061,8 +1061,8 @@ grpc::Status HandleUnaryExecute(
 	}
 
 	// Create output data tree.
-	err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0,
-			    (LYD_ANYDATA_VALUETYPE)0, 0, NULL, &output_tree);
+	err = yang_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, (LYD_ANYDATA_VALUETYPE)0, 0,
+			     NULL, &output_tree);
 	if (err != LY_SUCCESS) {
 		lyd_free_tree(input_tree);
 		return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,

lib/northbound_oper.c

@@ -442,8 +442,8 @@ static enum nb_error nb_op_xpath_to_trunk(const char *xpath_in, char **xpath_out
 
 	ly_temp_log_options(&llopts);
 	for (;;) {
-		err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0,
-				    LYD_NEW_PATH_UPDATE, NULL, trunk);
+		err = yang_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, LYD_NEW_PATH_UPDATE,
+				     NULL, trunk);
 		if (err == LY_SUCCESS)
 			break;
 
@@ -2405,8 +2405,8 @@ enum nb_error nb_oper_uint64_get(const struct nb_node *nb_node, const void *pare
 	size_t size;
 
 	valuep = _adjust_ptr(lsnode, (const char *)&ubigval, &size);
-	if (lyd_new_term_bin(parent, snode->module, snode->name, valuep, size, LYD_NEW_PATH_UPDATE,
-			     NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, valuep, size,
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 	return NB_OK;
 }
@@ -2423,8 +2423,8 @@ enum nb_error nb_oper_uint32_get(const struct nb_node *nb_node, const void *pare
 	size_t size;
 
 	valuep = _adjust_ptr(lsnode, (const char *)&ubigval, &size);
-	if (lyd_new_term_bin(parent, snode->module, snode->name, valuep, size, LYD_NEW_PATH_UPDATE,
-			     NULL))
+	if (yang_new_term_bin(parent, snode->module, snode->name, valuep, size,
+			      LYD_NEW_PATH_UPDATE, NULL))
 		return NB_ERR_RESOURCE;
 	return NB_OK;
 }

lib/printfrr.h

@@ -265,6 +265,7 @@ struct va_format {
 };
 
 #ifdef _FRR_ATTRIBUTE_PRINTFRR
+// clang-format off
 #pragma FRR printfrr_ext "%pFB" (struct fbuf *)
 #pragma FRR printfrr_ext "%pVA" (struct va_format *)
 
@@ -277,10 +278,12 @@ struct va_format {
 
 #pragma FRR printfrr_ext "%pSE" (char *)
 #pragma FRR printfrr_ext "%pSQ" (char *)
+#pragma FRR printfrr_ext "%pSA" (const char **)
 
 #pragma FRR printfrr_ext "%pTS" (struct timespec *)
 #pragma FRR printfrr_ext "%pTV" (struct timeval *)
 #pragma FRR printfrr_ext "%pTT" (time_t *)
+// clang-format on
 #endif
 
 /* when using non-ISO-C compatible extension specifiers... */

lib/strformat.c

@@ -262,6 +262,27 @@ static ssize_t printfrr_quote(struct fbuf *buf, struct printfrr_eargs *ea,
 	return ret;
 }
 
+printfrr_ext_autoreg_p("SA", printfrr_str_array);
+static ssize_t printfrr_str_array(struct fbuf *buf, struct printfrr_eargs *ea, const void *vptr)
+{
+	ssize_t len = printfrr_ext_len(ea);
+	char const *const *sarr = vptr;
+	ssize_t olen = 0;
+	int i;
+
+	if (!sarr)
+		return bputs(buf, "");
+
+	for (i = 0; len < 0 || i < len; i++) {
+		if (!sarr[i])
+			break;
+		if (i > 0)
+			olen += bputch(buf, ',');
+		olen += bputs(buf, sarr[i]);
+	}
+	return olen;
+}
+
 static ssize_t printfrr_abstime(struct fbuf *buf, struct printfrr_eargs *ea,
 				const struct timespec *ts, unsigned int flags);
 static ssize_t printfrr_reltime(struct fbuf *buf, struct printfrr_eargs *ea,