/* * ***** BEGIN LICENSE BLOCK ***** Copyright (C) 2009-2019 Olof Hagsand Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate) This file is part of CLIXON. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Alternatively, the contents of this file may be used under the terms of the GNU General Public License Version 3 or later (the "GPL"), in which case the provisions of the GPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of the GPL, and not to allow others to use your version of this file under the terms of Apache License version 2, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the Apache License version 2 or the GPL. ***** END LICENSE BLOCK ***** * * Translation between database specs * yang_spec CLIgen parse_tree * +-------------+ yang2cli +-------------+ * | | ------------> | cli | * | list{key A;}| | syntax | * +-------------+ +-------------+ * YANG generate CLI * A special tree called @datamodel is generated by the yang2cli function. * This tree contains generated CLIgen syntax for loaded YANG modules, according to the * include/exclude logic in clixon-autocli.yang defined by the following fields: * module-default * rule/module-name * rule/operation=exclude|include * The @datamodel tree can be used using the CLIgen "tree reference" functionality as described in * the cligen tutorial Secion 2.7. * The tree can be modified by removing labels. * By default "ac-state" are removed. * This means that using @datamodel without modifiers is a "clean" config tree. This is an example yang module: module m { container x { namespace "urn:example:m"; prefix m; list m1 { key "a"; leaf a { type string; } leaf b { type string; } } } } You can see which CLISPEC it generates via clixon_cli -D 2: x,cli_set("/example:x");{ m1 a (|),overwrite_me("/example:x/m1=%s/"); { b (|),overwrite_me("/example:x/m1=%s/b"); } } */ #ifdef HAVE_CONFIG_H #include "clixon_config.h" /* generated by config & autoconf */ #endif #include #include #include #include #include #include #include #include /* cligen */ #include /* libclixon */ #include #include "clixon_cli_api.h" #include "cli_plugin.h" #include "cli_autocli.h" #include "cli_generate.h" /*! Create cligen variable expand entry with api-pathfmt format string as argument * * Add api-fmt as first argument to callback, eg: * /ex:table * Then if mountpoint add special entry: * /ctrl:dev/ctrl:config * @param[in] h Clixon handle * @param[in] ys yang_stmt of the node at hand * @param[in] cvtype Type of the cligen variable * @param[in] options * @param[in] fraction_digits * @param[out] cb The string where the result format string is inserted. * @retval 1 OK * @retval 0 Hide, dont show helptext etc * @retval -1 Error * @see expand_dbvar This is where the expand string is used * @note XXX only fraction_digits handled,should also have mincv, maxcv, pattern */ static int cli_expand_var_generate(clixon_handle h, yang_stmt *ys, const char *cvtypestr, int options, uint8_t fraction_digits, int pre, cbuf *cb) { int retval = -1; char *api_path_fmt = NULL; int extvalue = 0; yang_stmt *yspec; cg_var *cv = NULL; if ((yspec = ys_spec(ys)) != NULL) cv = yang_cv_get(yspec); if (yang_extension_value(ys, "hide", CLIXON_AUTOCLI_NS, &extvalue, NULL) < 0) goto done; if (extvalue || yang_find(ys, Y_STATUS, "deprecated") != NULL) goto hide; if (yang2api_path_fmt(ys, 1, &api_path_fmt) < 0) goto done; if (pre) cprintf(cb, "|"); cprintf(cb, "<%s:%s", yang_argument_get(ys), cvtypestr); if (options & YANG_OPTIONS_FRACTION_DIGITS) cprintf(cb, " fraction-digits:%u", fraction_digits); cprintf(cb, " %s(\"candidate\",\"%s\"", GENERATE_EXPAND_XMLDB, api_path_fmt); if (cv){ /* Add optional mountpoint */ cprintf(cb, ",\"%s%s\"", MTPOINT_PREFIX, cv_string_get(cv)); } cprintf(cb, ")>"); retval = 1; done: if (api_path_fmt) free(api_path_fmt); return retval; hide: retval = 0; goto done; } /*! Create callback with api_path format string as argument * * @param[in] h Clixon handle * @param[in] ys yang_stmt of the node at hand * @param[out] cb The string where the result format string is inserted. * @retval 0 OK * @retval -1 Error * @see cli_dbxml This is where the xmlkeyfmt string is used * @see pt_callback_reference in CLIgen where the actual callback overwrites the template */ static int cli_callback_generate(clixon_handle h, yang_stmt *ys, cbuf *cb) { int retval = -1; char *api_path_fmt = NULL; yang_stmt *yspec; cg_var *cv = NULL; if ((yspec = ys_spec(ys)) != NULL) cv = yang_cv_get(yspec); if (yang2api_path_fmt(ys, 0, &api_path_fmt) < 0) goto done; cprintf(cb, ",%s(\"%s\"", GENERATE_CALLBACK, api_path_fmt); if (cv){ /* Add optional mountpoint */ cprintf(cb, ",\"%s%s\"", MTPOINT_PREFIX, cv_string_get(cv)); } cprintf(cb, ")"); retval = 0; done: if (api_path_fmt) free(api_path_fmt); return retval; } /*! Print cligen help string as ("") * * @param[in] cb CLIgen buf holding generated CLIspec * @param[in] helptext Help text */ static int yang2cli_helptext(cbuf *cb, char *helptext) { if (helptext) cprintf(cb, "(\"%s\")", helptext); return 0; } /*! Print yang argument to cbuf, or aliased via extension * * This is only implemented for leafs. * the reason it does not work for non-terminals is somewhat complex: * If alias, the CLIgen command is instead given as a "keyword" variable: * This in turn is treated as a single-value choice in cligen_parse.y * But then in cli_dbxml, choice is treated as a variable which is correct on other cases. * So one needs to distinguish between "keyword" as given here, and a choice with one argument. */ static int yang2cli_print_alias(cbuf *cb, yang_stmt *ys) { int retval = -1; int extvalue = 0; char *name; char *alias = NULL; if (yang_extension_value(ys, "alias", CLIXON_AUTOCLI_NS, &extvalue, &alias) < 0) goto done; name = yang_argument_get(ys); if (extvalue) cprintf(cb, "<%s:string keyword:%s>", name, alias); else cprintf(cb, "%s", name); retval = 0; done: return retval; } /*! Generate identityref statements for CLI variables * * @param[in] ys Yang statement * @param[in] ytype Resolved yang type. * @param[in] helptext CLI help text * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error * @see yang2cli_var_sub Its sub-function */ static int yang2cli_var_identityref(yang_stmt *ys, yang_stmt *ytype, const char *cvtypestr, char *helptext, cbuf *cb) { int retval = -1; yang_stmt *ybaseref; yang_stmt *ybaseid; cg_var *cv = NULL; char *prefix = NULL; char *id = NULL; int i; cvec *idrefvec; yang_stmt *ymod; yang_stmt *yprefix; yang_stmt *yspec; if ((ybaseref = yang_find(ytype, Y_BASE, NULL)) == NULL) goto ok; if ((ybaseid = yang_find_identity(ytype, yang_argument_get(ybaseref))) == NULL) goto ok; idrefvec = yang_cvec_get(ybaseid); if (cvec_len(idrefvec) > 0){ /* Add a wildchar string first -let validate take it for default prefix */ cprintf(cb, ">"); yang2cli_helptext(cb, helptext); cprintf(cb, "|<%s:%s choice:", yang_argument_get(ys), cvtypestr); yspec = ys_spec(ys); i = 0; while ((cv = cvec_each(idrefvec, cv)) != NULL){ if (nodeid_split(cv_name_get(cv), &prefix, &id) < 0) goto done; /* Translate from module-name(prefix) to global prefix * This is actually quite complicated: the cli needs to generate * a netconf statement with correct xmlns binding */ if ((ymod = yang_find_module_by_name(yspec, prefix)) != NULL && (yprefix = yang_find(ymod, Y_PREFIX, NULL)) != NULL){ if (i++) cprintf(cb, "|"); cprintf(cb, "%s:%s", yang_argument_get(yprefix), id); } if (prefix){ free(prefix); prefix = NULL; } if (id){ free(id); id = NULL; } } } ok: retval = 0; done: if (prefix) free(prefix); if (id) free(id); return retval; } /*! Generate range check statements for CLI variables * * @param[in] ys Yang statement * @param[in] options Flags field of optional values, eg YANG_OPTIONS_RANGE * @param[in] cvv Cvec with array of range_min/range_max cv:s (if YANG_OPTIONS_RANGE is set in options) * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error * @see yang2cli_var_sub which is the main function * In yang ranges are given as range 1 or range 1 .. 16, encoded in a cvv * 0 : range_min = x * and * 0 : range_min = x * 1 : range_max = y * Multiple ranges are given as: range x..y | x1..y1 * This is encode in clixon as a cvec as: * 0 : range_min = x * 1 : range_max = y * 0 : range_min = x1 * 1 : range_max = y1 * * Generation of cli code * Single range is made by eg: * * Multiple ranges is made by generating code eg: * */ static int yang2cli_var_range(yang_stmt *ys, int options, cvec *cvv, cbuf *cb) { int retval = -1; int i; cg_var *cv1; /* lower limit */ cg_var *cv2; /* upper limit */ /* Loop through range_min and range_min..range_max */ i = 0; while (i \" */ static int yang2cli_var_pattern(clixon_handle h, cvec *patterns, cbuf *cb) { int retval = -1; enum regexp_mode mode; cg_var *cvp; char *pattern; int invert; char *posix = NULL; int i; mode = clicon_yang_regexp(h); cvp = NULL; /* Loop over compiled regexps */ while ((cvp = cvec_each(patterns, cvp)) != NULL){ pattern = cv_string_get(cvp); invert = cv_flag(cvp, V_INVERT); cprintf(cb, " regexp:%s\"", invert?"!":""); if (mode == REGEXP_POSIX){ posix = NULL; if (regexp_xsd2posix(pattern, &posix) < 0) goto done; for (i=0; i"); yang2cli_helptext(cb, helptext); if (type && strcmp(type, "identityref") == 0) cprintf(cb, ")"); retval = 0; done: return retval; } /*! Resolve a single Yang union and generate code * * Part of generating CLI code for Yang leaf statement to CLIgen variable * @param[in] h Clixon handle * @param[in] ys Yang statement (caller of type) * @param[in] origtype Name of original type in the call * @param[in] ytsub Yang type invocation, a sub-type of a resolved union type * @param[in] cb Buffer where cligen code is written * @param[in] helptext CLI help text * @retval 0 OK * @retval -1 Error */ static int yang2cli_var_union_one(clixon_handle h, yang_stmt *ys, char *origtype, yang_stmt *ytsub, char *helptext, cbuf *cb) { int retval = -1; int options = 0; cvec *cvv = NULL; cvec *patterns = NULL; uint8_t fraction_digits = 0; enum cv_type cvtype; yang_stmt *ytype; /* resolved type */ char *restype; if ((patterns = cvec_new(0)) == NULL){ clixon_err(OE_UNIX, errno, "cvec_new"); goto done; } /* Resolve the sub-union type to a resolved type */ if (yang_type_resolve(ys, ys, ytsub, /* in */ &ytype, &options, /* resolved type */ &cvv, patterns, NULL, &fraction_digits) < 0) goto done; if (ytype == NULL){ clixon_err(OE_YANG, 0, "result-type should not be NULL"); goto done; } restype = ytype?yang_argument_get(ytype):NULL; if (restype && strcmp(restype, "union") == 0){ /* recursive union */ if (yang2cli_var_union(h, ys, origtype, ytype, helptext, cb) < 0) goto done; } /* XXX leafref inside union ? */ else { if (clicon_type2cv(origtype, restype, ys, &cvtype) < 0) goto done; if ((retval = yang2cli_var_sub(h, ys, ytype, helptext, cvtype, options, cvv, patterns, fraction_digits, cb)) < 0) goto done; } retval = 0; done: if (patterns) cvec_free(patterns); return retval; } /*! Loop over all sub-types of a Yang union * * Part of generating CLI code for Yang leaf statement to CLIgen variable * @param[in] h Clixon handle * @param[in] ys Yang statement (caller) * @param[in] origtype Name of original type in the call * @param[in] ytype Yang resolved type (a union in this case) * @param[in] helptext CLI help text * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error */ static int yang2cli_var_union(clixon_handle h, yang_stmt *ys, char *origtype, yang_stmt *ytype, char *helptext, cbuf *cb) { int retval = -1; yang_stmt *ytsub; int i; int inext; i = 0; inext = 0; /* Loop over all sub-types in the resolved union type, note these are * not resolved types (unless they are built-in, but the resolve call is * made in the union_one call. */ while ((ytsub = yn_iter(ytype, &inext)) != NULL){ if (yang_keyword_get(ytsub) != Y_TYPE) continue; if (i++) cprintf(cb, "|"); if (yang2cli_var_union_one(h, ys, origtype, ytsub, helptext, cb) < 0) goto done; } retval = 0; done: return retval; } static int yang2cli_var_leafref(clixon_handle h, yang_stmt *ys, yang_stmt *yrestype, char *helptext, enum cv_type cvtype, int options, cvec *cvv, cvec *patterns, uint8_t fraction_digits, cbuf *cb) { int retval = -1; char *type; int completionp; const char *cvtypestr; int ret; int flag; int regular_value = 1; /* if strict-expand==0 then regular-value is false */ /* Give up: use yreferred * XXX: inline of else clause below */ type = yrestype?yang_argument_get(yrestype):NULL; cvtypestr = cv_type2str(cvtype); if (autocli_completion(h, &completionp) < 0) goto done; if (type && completionp){ completionp = strcmp(type, "enumeration") != 0 && strcmp(type, "identityref") != 0 && strcmp(type, "bits") != 0; } if (yang_extension_value(ys, "strict-expand", CLIXON_AUTOCLI_NS, &flag, NULL) < 0) goto done; regular_value = !flag; if (completionp && regular_value) cprintf(cb, "("); if (regular_value) if (yang2cli_var_sub(h, ys, yrestype, helptext, cvtype, options, cvv, patterns, fraction_digits, cb) < 0) goto done; if (completionp){ if ((ret = cli_expand_var_generate(h, ys, cvtypestr, options, fraction_digits, regular_value, cb)) < 0) goto done; if (ret == 1) yang2cli_helptext(cb, helptext); } if (completionp && regular_value) cprintf(cb, ")"); retval = 0; done: return retval; } /*! Generate CLI code for Yang leaf statement to CLIgen variable * * @param[in] h Clixon handle * @param[in] ys Yang statement of original leaf * @param[in] yreferred Yang statement of referred node for type (leafref) * @param[in] helptext CLI help text * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error * * Make a type lookup and complete a cligen variable expression such as . * One complication is yang union, that needs a recursion since it consists of * sub-types. * eg type union{ type int32; type string } --> (| ) * Another is multiple ranges * @note leafrefs are troublesome. In this code their cligen type are string, but they should really * be the type of the referred node. But since the path pointing to the referred node is XML, and * only YANG is known here, we cannot easily determine the YANG node of the referred XML node, * and thus its type. */ static int yang2cli_var(clixon_handle h, yang_stmt *ys, yang_stmt *yreferred, char *helptext, cbuf *cb) { int retval = -1; char *origtype = NULL; yang_stmt *yrestype; /* resolved type */ char *restype; /* resolved type */ cvec *cvv = NULL; cvec *patterns = NULL; uint8_t fraction_digits = 0; enum cv_type cvtype; const char *cvtypestr; int options = 0; int completionp; int ret; if ((patterns = cvec_new(0)) == NULL){ clixon_err(OE_UNIX, errno, "cvec_new"); goto done; } if (yang_type_get(yreferred, &origtype, &yrestype, &options, &cvv, patterns, NULL, &fraction_digits) < 0) goto done; restype = yang_argument_get(yrestype); if (strcmp(restype, "empty") == 0) goto ok; if (clicon_type2cv(origtype, restype, yreferred, &cvtype) < 0) goto done; cvtypestr = cv_type2str(cvtype); /* Note restype can be NULL here for example with unresolved hardcoded uuid */ if (strcmp(restype, "union") == 0){ /* Union: loop over resolved type's sub-types (can also be recursive unions) */ cprintf(cb, "("); if (yang2cli_var_union(h, ys, origtype, yrestype, helptext, cb) < 0) goto done; if (autocli_completion(h, &completionp) < 0) goto done; if (completionp){ if ((ret = cli_expand_var_generate(h, ys, cvtypestr, options, fraction_digits, 1, cb)) < 0) goto done; if (ret == 1) yang2cli_helptext(cb, helptext); } cprintf(cb, ")"); } else if (strcmp(restype, "leafref")==0){ yang_stmt *ypath; char *path_arg; yang_stmt *yref = NULL; if ((ypath = yang_find(yrestype, Y_PATH, NULL)) == NULL){ clixon_err(OE_YANG, 0, "No Y_PATH for leafref"); goto done; } if ((path_arg = yang_argument_get(ypath)) == NULL){ clixon_err(OE_YANG, 0, "No argument for Y_PATH"); goto done; } if (yang_path_arg(yreferred, path_arg, &yref) < 0) goto done; if (yref == NULL){ /* Give up: use yreferred */ if (yang2cli_var_leafref(h, ys, yrestype, helptext, cvtype, options, cvv, patterns, fraction_digits, cb) < 0) goto done; } else { if (yreferred == yref){ clixon_err(OE_YANG, 0, "Referred YANG node for leafref path %s points to self", path_arg); goto done; } /* recurse call with new referred node */ if (yang2cli_var(h, ys, yref, helptext, cb) < 0) goto done; } } else{ if (yang2cli_var_leafref(h, ys, yrestype, helptext, cvtype, options, cvv, patterns, fraction_digits, cb) < 0) goto done; } ok: retval = 0; done: if (origtype) free(origtype); if (patterns) cvec_free(patterns); return retval; } /*! Generate CLI code for Yang leaf statement * * @param[in] h Clixon handle * @param[in] ys Yang statement * @param[in] level Indentation level * @param[in] callback If set, include a "; cli_set()" callback, otherwise not * @param[in] key_leaf 0: ordinary leaf, 1:prekey, 2: lastkey * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error * Some complexity in callback, key_leaf and extralevel logic. * If extralevel -> add extra { } level * + if callbacks add: cb();{} */ static int yang2cli_leaf(clixon_handle h, yang_stmt *ys, int level, int callback, int key_leaf, cbuf *cb) { int retval = -1; yang_stmt *yd; /* description */ char *helptext = NULL; char *s; autocli_listkw_t listkw; int hideext = 0; int extralevel = 0; yang_stmt *yrestype; /* resolved type */ /* description */ if ((yd = yang_find(ys, Y_DESCRIPTION, NULL)) != NULL){ if ((helptext = strdup(yang_argument_get(yd))) == NULL){ clixon_err(OE_UNIX, errno, "strdup"); goto done; } if ((s = strstr(helptext, "\n\n")) != NULL) *s = '\0'; } cprintf(cb, "%*s", level*3, ""); /* Called a second time in yang2cli_var, room for optimization */ if (yang_type_get(ys, NULL, &yrestype, NULL, NULL, NULL, NULL, NULL) < 0) goto done; if (key_leaf == 0 && strcmp(yang_argument_get(yrestype), "empty") != 0) extralevel = 1; if (autocli_list_keyword(h, &listkw) < 0) goto done; if (listkw == AUTOCLI_LISTKW_ALL || (key_leaf==0 && listkw == AUTOCLI_LISTKW_NOKEY)){ if (yang2cli_print_alias(cb, ys) < 0) goto done; yang2cli_helptext(cb, helptext); cprintf(cb, " "); if (yang_extension_value(ys, "hide", CLIXON_AUTOCLI_NS, &hideext, NULL) < 0) goto done; if (hideext || yang_find(ys, Y_STATUS, "deprecated") != NULL){ cprintf(cb, ", hide"); /* XXX ensure always { */ } if (extralevel){ if (callback){ if (cli_callback_generate(h, ys, cb) < 0) goto done; cprintf(cb, ", ac-leaf"); cprintf(cb, ", act-leafconst"); cprintf(cb, ";\n"); } cprintf(cb, "{"); /* termleaf label + extra level around leaf */ } if (yang2cli_var(h, ys, ys, helptext, cb) < 0) goto done; } else{ if (yang2cli_var(h, ys, ys, helptext, cb) < 0) goto done; } if (callback){ if (cli_callback_generate(h, ys, cb) < 0) goto done; switch (key_leaf){ case 0: cprintf(cb, ", ac-leaf"); cprintf(cb, ", act-leafvar"); break; case 1: cprintf(cb, ", ac-leaf"); cprintf(cb, ", act-prekey"); break; case 2: /* Dont mark as leaf since it represents a (single) list entry */ cprintf(cb, ", act-lastkey"); break; } cprintf(cb, ";\n"); } if (extralevel) cprintf(cb, "}\n"); retval = 0; done: if (helptext) free(helptext); return retval; } /*! Generate CLI code for Yang container statement * * @param[in] h Clixon handle * @param[in] ys Yang statement * @param[in] level Indentation level * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error */ static int yang2cli_container(clixon_handle h, yang_stmt *ys, int level, cbuf *cb) { int retval = -1; yang_stmt *yc; yang_stmt *yd; char *helptext = NULL; char *s; int compress = 0; yang_stmt *ymod = NULL; int extvalue = 0; int inext; int ret; if (ys_real_module(ys, &ymod) < 0) goto done; /* If non-presence container && HIDE mode && only child is * a list, then skip container keyword * See also clixon_cli2file */ if (autocli_compress(h, ys, &compress) < 0) goto done; if (!compress){ cprintf(cb, "%*s%s", level*3, "", yang_argument_get(ys)); if ((yd = yang_find(ys, Y_DESCRIPTION, NULL)) != NULL){ if ((helptext = strdup(yang_argument_get(yd))) == NULL){ clixon_err(OE_UNIX, errno, "strdup"); goto done; } if ((s = strstr(helptext, "\n\n")) != NULL) *s = '\0'; yang2cli_helptext(cb, helptext); } if (cli_callback_generate(h, ys, cb) < 0) goto done; if (yang_extension_value(ys, "hide", CLIXON_AUTOCLI_NS, &extvalue, NULL) < 0) goto done; if (extvalue || yang_find(ys, Y_STATUS, "deprecated") != NULL){ cprintf(cb, ", hide"); } cprintf(cb, ", act-container;{\n"); } /* Is schema mount-point? */ if (clicon_option_bool(h, "CLICON_YANG_SCHEMA_MOUNT")){ if ((ret = yang_schema_mount_point(ys)) < 0) goto done; if (ret){ cprintf(cb, "%*s%s", (level+1)*3, "", "@mountpoint;\n"); } } inext = 0; while ((yc = yn_iter(ys, &inext)) != NULL) if (yang2cli_stmt(h, yc, level+1, cb) < 0) goto done; if (!compress) cprintf(cb, "%*s}\n", level*3, ""); retval = 0; done: if (helptext) free(helptext); return retval; } /*! Generate CLI code for Yang list statement * * @param[in] h Clixon handle * @param[in] ys Yang statement * @param[in] level Indentation level * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error */ static int yang2cli_list(clixon_handle h, yang_stmt *ys, int level, cbuf *cb) { int retval = -1; yang_stmt *yc; yang_stmt *yd; yang_stmt *yleaf; cg_var *cvi; char *keyname; cvec *cvk = NULL; /* vector of index keys */ char *helptext = NULL; char *s; int last_key = 0; int exist = 0; int keynr = 0; int inext; cprintf(cb, "%*s%s", level*3, "", yang_argument_get(ys)); if ((yd = yang_find(ys, Y_DESCRIPTION, NULL)) != NULL){ if ((helptext = strdup(yang_argument_get(yd))) == NULL){ clixon_err(OE_UNIX, errno, "strdup"); goto done; } if ((s = strstr(helptext, "\n\n")) != NULL) *s = '\0'; yang2cli_helptext(cb, helptext); } if (yang_extension_value(ys, "hide", CLIXON_AUTOCLI_NS, &exist, NULL) < 0) goto done; if (exist || yang_find(ys, Y_STATUS, "deprecated") != NULL){ cprintf(cb, ",hide"); } /* Loop over all key variables */ cvk = yang_cvec_get(ys); /* Use Y_LIST cache, see ys_populate_list() */ cvi = NULL; /* Iterate over individual keys */ while ((cvi = cvec_each(cvk, cvi)) != NULL) { keyname = cv_string_get(cvi); if ((yleaf = yang_find(ys, Y_LEAF, keyname)) == NULL){ clixon_err(OE_XML, 0, "List statement \"%s\" has no key leaf \"%s\"", yang_argument_get(ys), keyname); goto done; } /* Print key variable now, and skip it in loop below * Note, only print callback on last statement */ last_key = cvec_next(cvk, cvi)?0:1; if (cli_callback_generate(h, ys, cb) < 0) goto done; if (keynr == 0) cprintf(cb, ",act-list"); else cprintf(cb, ",act-prekey"); cprintf(cb, ";\n"); cprintf(cb, "{\n"); if (yang2cli_leaf(h, yleaf, level+1, last_key, /* callback */ last_key?2:1, /* key_leaf */ cb) < 0) goto done; keynr++; } cprintf(cb, "{\n"); inext = 0; while ((yc = yn_iter(ys, &inext)) != NULL) { /* cvk is a cvec of strings containing variable names yc is a leaf that may match one of the values of cvk. */ cvi = NULL; while ((cvi = cvec_each(cvk, cvi)) != NULL) { keyname = cv_string_get(cvi); if (strcmp(keyname, yang_argument_get(yc)) == 0) break; } if (cvi != NULL) continue; if (yang2cli_stmt(h, yc, level+1, cb) < 0) goto done; } cprintf(cb, "%*s}\n", level*3, ""); /* Close with } for each key */ while (keynr--) cprintf(cb, "%*s}\n", level*3, ""); retval = 0; done: if (helptext) free(helptext); return retval; } /*! Generate CLI code for Yang choice statement * * @param[in] h Clixon handle * @param[in] ys Yang statement * @param[in] level Indentation level * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error * @code choice interface-type { container ethernet { ... } container fddi { ... } } * @code.end @note Removes 'meta-syntax' from cli syntax. They are not shown when xml is translated to cli. and therefore input-syntax != output syntax. Which is bad */ static int yang2cli_choice(clixon_handle h, yang_stmt *ys, int level, cbuf *cb) { int retval = -1; yang_stmt *yc; int inext; inext = 0; while ((yc = yn_iter(ys, &inext)) != NULL) { switch (yang_keyword_get(yc)){ case Y_CASE: if (yang2cli_stmt(h, yc, level+2, cb) < 0) goto done; break; case Y_CONTAINER: case Y_LEAF: case Y_LEAF_LIST: case Y_LIST: default: if (yang2cli_stmt(h, yc, level+1, cb) < 0) goto done; break; } } retval = 0; done: return retval; } /*! Generate clispec for all modules in a grouping * * Called in cli main function for top-level yangs. But may also be called dynamically for * mountpoints. * @param[in] h Clixon handle * @param[in] ys Top-level Yang statement * @param[in] treename Name of tree * @retval 0 OK * @retval -1 Error * @note Tie-break of same top-level symbol: prefix is NYI * @see yang2cli_yspec for original */ static int yang2cli_grouping(clixon_handle h, yang_stmt *ys, char *treename); /*! Generate CLI code for Yang uses statement * * @param[in] h Clixon handle * @param[in] ys Yang statement * @param[in] level Indentation level * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error */ static int yang2cli_uses(clixon_handle h, yang_stmt *ys, int level, cbuf *cb) { int retval = -1; char *id = NULL; char *prefix = NULL; char *ns; yang_stmt *ygrouping; cbuf *cbtree = NULL; char *api_path_fmt = NULL; yang_stmt *yp; int ret; if (nodeid_split(yang_argument_get(ys), &prefix, &id) < 0) goto done; if (ys_grouping_resolve(ys, prefix, id, &ygrouping) < 0) goto done; if (ygrouping == NULL){ clixon_err(OE_YANG, 0, "grouping %s not found in \n", yang_argument_get(ys)); goto done; } if ((cbtree = cbuf_new()) == NULL){ clixon_err(OE_XML, errno, "cbuf_new"); goto done; } /* prefix is not globally unique, need namespace */ if ((ns = yang_find_mynamespace(ygrouping)) == NULL) goto done; cprintf(cbtree, "grouping-%s-%s", ns, id); if (cligen_ph_find(cli_cligen(h), cbuf_get(cbtree)) == NULL){ /* No such tree, generate it */ if ((ret = yang2cli_grouping(h, ygrouping, cbuf_get(cbtree))) < 0) goto done; if (ret == 0) /* tree empty */ goto ok; } cprintf(cb, "%*s@%s", level*3, "", cbuf_get(cbtree)); /* get api-path to parent, do not include "uses" argument since it is replaced */ yp = yang_parent_get(ys); if (yang2api_path_fmt(yp, 0, &api_path_fmt) < 0) goto done; /* This adds a "prepend" callback with decendant argument */ cprintf(cb, ",%s(\"%s\")", GROUPING_CALLBACK, api_path_fmt); cprintf(cb, ";\n"); ok: retval = 0; done: if (api_path_fmt) free(api_path_fmt); if (prefix) free(prefix); if (id) free(id); if (cbtree) cbuf_free(cbtree); return retval; } /*! Generate CLI code for Yang statement * * @param[in] h Clixon handle * @param[in] ys Yang statement * @param[in] level Indentation level * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error */ static int yang2cli_stmt(clixon_handle h, yang_stmt *ys, int level, cbuf *cb) { int retval = -1; yang_stmt *yc; int treeref_state = 0; int grouping_treeref = 0; int extvalue = 0; int inext; if (ys == NULL){ clixon_err(OE_YANG, EINVAL, "No yang spec"); goto done; } if (yang_find(ys, Y_STATUS, "obsolete") != NULL){ clixon_debug(CLIXON_DBG_CLI | CLIXON_DBG_DETAIL, "obsolete: %s %s, skipped", yang_argument_get(ys), yang_argument_get(ys_module(ys))); goto ok; } if (yang_find(ys, Y_STATUS, "deprecated") != NULL){ clixon_debug(CLIXON_DBG_CLI | CLIXON_DBG_DETAIL, "deprecated: %s %s", yang_argument_get(ys), yang_argument_get(ys_module(ys))); } /* Check if autocli skip */ if (yang_extension_value(ys, "skip", CLIXON_AUTOCLI_NS, &extvalue, NULL) < 0) goto done; if (extvalue == 1) goto ok; /* Only produce autocli for YANG non-config only if autocli-treeref-state is true */ if (autocli_treeref_state(h, &treeref_state) < 0) goto done; if (autocli_grouping_treeref(h, &grouping_treeref) < 0) goto done; if (treeref_state || yang_config(ys)){ int cornercase = 0; if (grouping_treeref){ #ifdef AUTOCLI_GROUPING_TOPLEVEL_SKIP cornercase = yang_keyword_get(yang_parent_get(ys)) == Y_MODULE || yang_keyword_get(yang_parent_get(ys)) == Y_SUBMODULE; #endif if (yang_keyword_get(ys) != Y_USES && yang_flag_get(ys, YANG_FLAG_GROUPING) && !cornercase ) goto ok; } switch (yang_keyword_get(ys)){ case Y_CONTAINER: if (yang2cli_container(h, ys, level, cb) < 0) goto done; break; case Y_LIST: if (yang2cli_list(h, ys, level, cb) < 0) goto done; break; case Y_CHOICE: if (yang2cli_choice(h, ys, level, cb) < 0) goto done; break; case Y_LEAF_LIST: case Y_LEAF: if (yang2cli_leaf(h, ys, level, 1, /* callback */ 0, /* keyleaf */ cb) < 0) goto done; break; case Y_USES: if (grouping_treeref && !cornercase) if (yang2cli_uses(h, ys, level, cb) < 0) goto done; break; case Y_CASE: case Y_SUBMODULE: case Y_MODULE: inext = 0; while ((yc = yn_iter(ys, &inext)) != NULL) if (yang2cli_stmt(h, yc, level+1, cb) < 0) goto done; break; default: /* skip */ break; } } ok: retval = 0; done: return retval; } /*! Add cv with name to cvec * * @param[in] cvv Either existing or NULL * @param[in] name Name of cv to add * @retval cvv Either same as in cvv parameter or new */ static cvec* cvec_add_name(cvec *cvv, char *name) { cg_var *cv= NULL; if (cvv == NULL && (cvv = cvec_new(0)) == NULL){ clixon_err(OE_UNIX, errno, "cvec_new"); return NULL; } if ((cv = cvec_add(cvv, CGV_STRING)) == NULL){ clixon_err(OE_UNIX, errno, "cvec_add"); return NULL; } /* Filter out state data, use "nonconfig" as defined in RFC8040 4.8.1 */ cv_name_set(cv, name); return cvv; } /*! Recursive post processing of generated cligen parsetree: populate with co_cvec labels * * This function adds labels to the generated CLIgen tree using YANG as follows: * These labels can be filtered when applying them with the @treeref, @add: