blob: bff705a4bbd11570672e07b9028e6e91059330a0 [file] [log] [blame]
Radek Krejcied5acc52019-04-25 15:57:04 +02001/**
2 * @file main_ni.c
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang's yanglint tool - noninteractive code
5 *
Radek Krejcie9f13b12020-11-09 17:42:04 +01006 * Copyright (c) 2020 CESNET, z.s.p.o.
Radek Krejcied5acc52019-04-25 15:57:04 +02007 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
Radek Krejci535ea9f2020-05-29 16:01:05 +020015#define _GNU_SOURCE
Radek Krejcied5acc52019-04-25 15:57:04 +020016
Radek Krejcie9f13b12020-11-09 17:42:04 +010017#include <errno.h>
18#include <getopt.h>
Radek Krejci47fab892020-11-05 17:02:41 +010019#include <stdint.h>
Radek Krejcied5acc52019-04-25 15:57:04 +020020#include <stdio.h>
21#include <stdlib.h>
Radek Krejcied5acc52019-04-25 15:57:04 +020022#include <string.h>
Radek Krejci47fab892020-11-05 17:02:41 +010023#include <strings.h>
Radek Krejcie9f13b12020-11-09 17:42:04 +010024#include <sys/stat.h>
Radek Krejcied5acc52019-04-25 15:57:04 +020025
Radek Krejcied5acc52019-04-25 15:57:04 +020026#include "libyang.h"
27
Radek Krejcie9f13b12020-11-09 17:42:04 +010028#include "common.h"
aPiecek8f0b7882021-05-21 10:18:36 +020029#include "out.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020030#include "tools/config.h"
31
Radek Krejcie9f13b12020-11-09 17:42:04 +010032/**
33 * @brief Context structure to hold and pass variables in a structured form.
34 */
35struct context {
36 /* libyang context for the run */
37 struct ly_ctx *ctx;
Radek Krejci535ea9f2020-05-29 16:01:05 +020038
Radek Krejcie9f13b12020-11-09 17:42:04 +010039 /* prepared output (--output option or stdout by default) */
40 struct ly_out *out;
Radek Krejci535ea9f2020-05-29 16:01:05 +020041
Radek Krejcie9f13b12020-11-09 17:42:04 +010042 struct ly_set searchpaths;
Radek Krejcied5acc52019-04-25 15:57:04 +020043
Radek Krejcie9f13b12020-11-09 17:42:04 +010044 /* options flags */
45 uint8_t list; /* -l option to print list of schemas */
Radek Krejcied5acc52019-04-25 15:57:04 +020046
aPiecek2cfeeae2021-04-21 13:17:34 +020047 /* line length for 'tree' format */
48 size_t line_length; /* --tree-line-length */
49
Radek Krejcie9f13b12020-11-09 17:42:04 +010050 /*
51 * schema
52 */
Michal Vaskoa9a98612021-11-22 10:00:27 +010053 /* set schema modules' features via --features option (struct schema_features *) */
Radek Krejcie9f13b12020-11-09 17:42:04 +010054 struct ly_set schema_features;
55
56 /* set of loaded schema modules (struct lys_module *) */
57 struct ly_set schema_modules;
58
59 /* options to parse and print schema modules */
60 uint32_t schema_parse_options;
61 uint32_t schema_print_options;
62
63 /* specification of printing schema node subtree, option --schema-node */
64 const char *schema_node_path;
65 const struct lysc_node *schema_node;
Michal Vaskofe74d1e2021-09-30 13:17:36 +020066 const char *submodule;
Radek Krejcie9f13b12020-11-09 17:42:04 +010067
68 /* value of --format in case of schema format */
69 LYS_OUTFORMAT schema_out_format;
70
71 /*
72 * data
73 */
74 /* various options based on --type option */
Michal Vaskoe0665742021-02-11 11:08:44 +010075 enum lyd_type data_type;
Radek Krejcie9f13b12020-11-09 17:42:04 +010076 uint32_t data_parse_options;
77 uint32_t data_validate_options;
78 uint32_t data_print_options;
79
80 /* flag for --merge option */
81 uint8_t data_merge;
82
83 /* value of --format in case of data format */
84 LYD_FORMAT data_out_format;
85
86 /* input data files (struct cmdline_file *) */
87 struct ly_set data_inputs;
88
Radek Krejcie9f13b12020-11-09 17:42:04 +010089 /* storage for --operational */
90 struct cmdline_file data_operational;
91};
92
93static void
94erase_context(struct context *c)
95{
96 /* data */
97 ly_set_erase(&c->data_inputs, free_cmdline_file);
Radek Krejcie9f13b12020-11-09 17:42:04 +010098 ly_in_free(c->data_operational.in, 1);
99
100 /* schema */
101 ly_set_erase(&c->schema_features, free_features);
102 ly_set_erase(&c->schema_modules, NULL);
103
104 /* context */
105 ly_set_erase(&c->searchpaths, NULL);
106
107 ly_out_free(c->out, NULL, 0);
Radek Krejci90ed21e2021-04-12 14:47:46 +0200108 ly_ctx_destroy(c->ctx);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100109}
110
111static void
112version(void)
113{
114 printf("yanglint %s\n", PROJECT_VERSION);
115}
116
117static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200118help(int shortout)
119{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100120
121 printf("Usage:\n"
122 " yanglint [Options] [-f { yang | yin | info}] <schema>...\n"
123 " Validates the YANG module in <schema>, and all its dependencies.\n\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100124 " yanglint [Options] [-f { xml | json }] <schema>... <file> ...\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100125 " Validates the YANG modeled data in <file> according to the <schema>.\n\n"
126 " yanglint\n"
127 " Starts interactive mode with more features.\n\n");
Radek Krejcied5acc52019-04-25 15:57:04 +0200128
129 if (shortout) {
130 return;
131 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100132 printf("Options:\n"
133 " -h, --help Show this help message and exit.\n"
134 " -v, --version Show version number and exit.\n"
Michal Vaskob0d307b2021-11-25 11:15:16 +0100135 " -V, --verbose Increase libyang verbosity and show verbose messages. If specified\n"
136 " a second time, show even debug messages.\n"
137 " -Q, --quiet Decrease libyang verbosity and hide warnings. If specified a second\n"
138 " time, hide errors so no libyang messages are printed.\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100139
Michal Vaskoc40548b2021-09-30 13:05:47 +0200140 printf(" -f FORMAT, --format=FORMAT\n"
141 " Convert input into FORMAT. Supported formats: \n"
142 " yang, yin, tree and info for schemas,\n"
143 " xml, json for data.\n\n");
144
145 printf(" -p PATH, --path=PATH\n"
146 " Search path for schema (YANG/YIN) modules. The option can be\n"
147 " used multiple times. The current working directory and the\n"
148 " path of the module being added is used implicitly.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100149
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200150 printf(" -D, --disable-searchdir\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100151 " Do not implicitly search in current working directory for\n"
152 " schema modules. If specified a second time, do not even\n"
153 " search in the module directory (all modules must be \n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200154 " explicitly specified).\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100155
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200156 printf(" -F FEATURES, --features=FEATURES\n"
Michal Vasko59740872021-11-22 10:01:34 +0100157 " Specific module features to support in the form <module-name>:(<feature>,)*\n"
158 " Use <feature> '*' to enable all features of a module. This option can be\n"
159 " specified multiple times, to enable features in multiple modules. If this\n"
160 " option is not specified, all the features in all the implemented modules\n"
161 " are enabled.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100162
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200163 printf(" -i, --make-implemented\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100164 " Make the imported modules \"referenced\" from any loaded\n"
165 " module also implemented. If specified a second time, all the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200166 " modules are set implemented.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100167
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200168 printf(" -P PATH, --schema-node=PATH\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100169 " Print only the specified subtree of the schema.\n"
170 " The PATH is the XPath subset mentioned in documentation as\n"
171 " the Path format. The option can be combined with --single-node\n"
172 " option to print information only about the specified node.\n"
173 " -q, --single-node\n"
174 " Supplement to the --schema-node option to print information\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200175 " only about a single node specified as PATH argument.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100176
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200177 printf(" -s SUBMODULE, --submodule=SUBMODULE\n"
178 " Print the specific submodule instead of the main module.\n\n");
179
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200180 printf(" -n, --not-strict\n"
Michal Vasko667ce6b2021-01-25 15:00:27 +0100181 " Do not require strict data parsing (silently skip unknown data),\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200182 " has no effect for schemas.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100183
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200184 printf(" -e, --present Validate only with the schema modules whose data actually\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100185 " exist in the provided input data files. Takes effect only\n"
186 " with the 'data' or 'config' TYPEs. Used to avoid requiring\n"
187 " mandatory nodes from modules which data are not present in the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200188 " provided input data files.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100189
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200190 printf(" -t TYPE, --type=TYPE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100191 " Specify data tree type in the input data file(s):\n"
192 " data - Complete datastore with status data (default type).\n"
193 " config - Configuration datastore (without status data).\n"
194 " get - Result of the NETCONF <get> operation.\n"
195 " getconfig - Result of the NETCONF <get-config> operation.\n"
196 " edit - Content of the NETCONF <edit-config> operation.\n"
197 " rpc - Content of the NETCONF <rpc> message, defined as YANG's\n"
198 " RPC/Action input statement.\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100199 " reply - Reply to the RPC/Action. Note that the reply data are\n"
200 " expected inside a container representing the original\n"
201 " RPC/Action. This is necessary to identify appropriate\n"
202 " data definitions in the schema module.\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100203 " notif - Notification instance (content of the <notification>\n"
Michal Vaskoc40548b2021-09-30 13:05:47 +0200204 " element without <eventTime>).\n\n");
205
206 printf(" -d MODE, --default=MODE\n"
207 " Print data with default values, according to the MODE\n"
208 " (to print attributes, ietf-netconf-with-defaults model\n"
209 " must be loaded):\n"
210 " all - Add missing default nodes.\n"
211 " all-tagged - Add missing default nodes and mark all the default\n"
212 " nodes with the attribute.\n"
213 " trim - Remove all nodes with a default value.\n"
214 " implicit-tagged - Add missing nodes and mark them with the attribute.\n\n");
215
216 printf(" -l, --list Print info about the loaded schemas.\n"
217 " (i - imported module, I - implemented module)\n"
218 " In case the -f option with data encoding is specified,\n"
219 " the list is printed as ietf-yang-library data.\n\n");
220
221 printf(" -L LINE_LENGTH, --tree-line-length=LINE_LENGTH\n"
222 " The limit of the maximum line length on which the 'tree'\n"
223 " format will try to be printed.\n\n");
224
225 printf(" -o OUTFILE, --output=OUTFILE\n"
226 " Write the output to OUTFILE instead of stdout.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100227
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200228 printf(" -O FILE, --operational=FILE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100229 " Provide optional data to extend validation of the 'rpc',\n"
230 " 'reply' or 'notif' TYPEs. The FILE is supposed to contain\n"
231 " the :running configuration datastore and state data\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200232 " (operational datastore) referenced from the RPC/Notification.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100233
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200234 printf(" -m, --merge Merge input data files into a single tree and validate at\n"
235 " once.The option has effect only for 'data' and 'config' TYPEs.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100236
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200237 printf(" -y, --yang-library\n"
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100238 " Load and implement internal \"ietf-yang-library\" YANG module.\n"
239 " Note that this module includes definitions of mandatory state\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200240 " data that can result in unexpected data validation errors.\n\n");
Michal Vaskoc40548b2021-09-30 13:05:47 +0200241
242#ifndef NDEBUG
243 printf(" -G GROUPS, --debug=GROUPS\n"
244 " Enable printing of specific debugging message group\n"
245 " (nothing will be printed unless verbosity is set to debug):\n"
Michal Vasko27a4acb2021-11-22 10:03:46 +0100246 " <group>[,<group>]* (dict, xpath, dep-sets)\n\n");
Michal Vaskoc40548b2021-09-30 13:05:47 +0200247#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200248}
249
Radek Krejcie9f13b12020-11-09 17:42:04 +0100250static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200251libyang_verbclb(LY_LOG_LEVEL level, const char *msg, const char *path)
252{
253 char *levstr;
254
Radek Krejcie9f13b12020-11-09 17:42:04 +0100255 switch (level) {
256 case LY_LLERR:
257 levstr = "err :";
258 break;
259 case LY_LLWRN:
260 levstr = "warn:";
261 break;
262 case LY_LLVRB:
263 levstr = "verb:";
264 break;
265 default:
266 levstr = "dbg :";
267 break;
268 }
269 if (path) {
270 fprintf(stderr, "libyang %s %s (%s)\n", levstr, msg, path);
271 } else {
272 fprintf(stderr, "libyang %s %s\n", levstr, msg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200273 }
274}
275
Michal Vasko686d8fc2021-11-22 10:03:23 +0100276static struct schema_features *
277get_features_not_applied(const struct ly_set *fset)
278{
279 for (uint32_t u = 0; u < fset->count; ++u) {
280 struct schema_features *sf = fset->objs[u];
281 if (!sf->applied) {
282 return sf;
283 }
284 }
285
286 return NULL;
287}
288
Radek Krejcie9f13b12020-11-09 17:42:04 +0100289static int
290fill_context_inputs(int argc, char *argv[], struct context *c)
291{
Radek Krejcif53b0d52020-12-03 11:29:24 +0100292 struct ly_in *in;
Michal Vasko686d8fc2021-11-22 10:03:23 +0100293 struct schema_features *sf;
Michal Vaskoc91fb122021-11-23 09:00:17 +0100294 struct lys_module *mod;
Michal Vasko686d8fc2021-11-22 10:03:23 +0100295 const char *all_features[] = {"*", NULL};
Radek Krejcie9f13b12020-11-09 17:42:04 +0100296
297 /* process the operational content if any */
298 if (c->data_operational.path) {
299 if (get_input(c->data_operational.path, NULL, &c->data_operational.format, &c->data_operational.in)) {
300 return -1;
301 }
302 }
303
304 for (int i = 0; i < argc - optind; i++) {
305 LYS_INFORMAT format_schema = LYS_IN_UNKNOWN;
306 LYD_FORMAT format_data = LYD_UNKNOWN;
Radek Krejcif53b0d52020-12-03 11:29:24 +0100307 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100308
309 if (get_input(argv[optind + i], &format_schema, &format_data, &in)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100310 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100311 }
312
313 if (format_schema) {
314 LY_ERR ret;
315 uint8_t path_unset = 1; /* flag to unset the path from the searchpaths list (if not already present) */
316 char *dir, *module;
Michal Vasko59740872021-11-22 10:01:34 +0100317 const char **features;
Michal Vasko4de7d072021-07-09 09:13:18 +0200318 struct lys_module *mod;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100319
320 if (parse_schema_path(argv[optind + i], &dir, &module)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100321 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100322 }
323
324 /* add temporarily also the path of the module itself */
325 if (ly_ctx_set_searchdir(c->ctx, dir) == LY_EEXIST) {
326 path_unset = 0;
327 }
328
329 /* get features list for this module */
Michal Vasko703370c2021-10-19 14:07:16 +0200330 if (!c->schema_features.count) {
Michal Vasko59740872021-11-22 10:01:34 +0100331 features = all_features;
332 } else {
333 get_features(&c->schema_features, module, &features);
Michal Vasko703370c2021-10-19 14:07:16 +0200334 }
335
Radek Krejcie9f13b12020-11-09 17:42:04 +0100336 /* temporary cleanup */
337 free(dir);
338 free(module);
339
Michal Vasko703370c2021-10-19 14:07:16 +0200340 /* parse module */
Radek Krejcie9f13b12020-11-09 17:42:04 +0100341 ret = lys_parse(c->ctx, in, format_schema, features, &mod);
342 ly_ctx_unset_searchdir_last(c->ctx, path_unset);
Radek Krejcif53b0d52020-12-03 11:29:24 +0100343 ly_in_free(in, 1);
344 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100345 if (ret) {
Michal Vaskoc91fb122021-11-23 09:00:17 +0100346 YLMSG_E("Parsing schema module \"%s\" failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100347 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100348 }
349
350 if (c->schema_out_format) {
351 /* modules will be printed */
352 if (ly_set_add(&c->schema_modules, (void *)mod, 1, NULL)) {
353 YLMSG_E("Storing parsed schema module (%s) for print failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100354 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100355 }
356 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100357 } else if (format_data) {
Radek Krejci6784a4e2020-12-09 14:23:05 +0100358 if (!fill_cmdline_file(&c->data_inputs, in, argv[optind + i], format_data)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100359 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100360 }
Radek Krejcif53b0d52020-12-03 11:29:24 +0100361 in = NULL;
Radek Krejci3329b652020-12-05 23:54:07 +0100362 } else {
363 ly_in_free(in, 1);
364 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100365 }
366 }
367
Michal Vaskoc91fb122021-11-23 09:00:17 +0100368 /* check that all specified features were applied, apply now if possible */
369 while ((sf = get_features_not_applied(&c->schema_features))) {
370 /* try to find implemented or the latest revision of this module */
371 mod = ly_ctx_get_module_implemented(c->ctx, sf->mod_name);
372 if (!mod) {
373 mod = ly_ctx_get_module_latest(c->ctx, sf->mod_name);
Michal Vasko686d8fc2021-11-22 10:03:23 +0100374 }
Michal Vaskoc91fb122021-11-23 09:00:17 +0100375 if (!mod) {
376 YLMSG_E("Specified features not applied, module \"%s\" not loaded.\n", sf->mod_name);
377 goto error;
378 }
379
380 /* we have the module, implement it if needed and enable the specific features */
381 if (lys_set_implemented(mod, (const char **)sf->features)) {
382 YLMSG_E("Implementing module \"%s\" failed.\n", mod->name);
383 goto error;
384 }
385 sf->applied = 1;
Michal Vasko686d8fc2021-11-22 10:03:23 +0100386 }
387
Radek Krejcie9f13b12020-11-09 17:42:04 +0100388 return 0;
Radek Krejcif2afd672020-11-26 12:29:23 +0100389
390error:
391 ly_in_free(in, 1);
392 return -1;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100393}
394
395/**
396 * @brief Process command line options and store the settings into the context.
397 *
398 * return -1 in case of error;
399 * return 0 in case of success and ready to process
400 * return 1 in case of success, but expect to exit.
Radek Krejcied5acc52019-04-25 15:57:04 +0200401 */
402static int
Radek Krejcie9f13b12020-11-09 17:42:04 +0100403fill_context(int argc, char *argv[], struct context *c)
Radek Krejcied5acc52019-04-25 15:57:04 +0200404{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100405 int ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200406
Radek Krejcie9f13b12020-11-09 17:42:04 +0100407 int opt, opt_index;
Radek Krejcied5acc52019-04-25 15:57:04 +0200408 struct option options[] = {
Radek Krejcied5acc52019-04-25 15:57:04 +0200409 {"help", no_argument, NULL, 'h'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200410 {"version", no_argument, NULL, 'v'},
411 {"verbose", no_argument, NULL, 'V'},
Michal Vaskob0d307b2021-11-25 11:15:16 +0100412 {"quiet", no_argument, NULL, 'Q'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200413 {"format", required_argument, NULL, 'f'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100414 {"path", required_argument, NULL, 'p'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200415 {"disable-searchdir", no_argument, NULL, 'D'},
416 {"features", required_argument, NULL, 'F'},
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200417 {"make-implemented", no_argument, NULL, 'i'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100418 {"schema-node", required_argument, NULL, 'P'},
Radek Krejcie1f6d5a2019-11-17 14:03:04 +0800419 {"single-node", no_argument, NULL, 'q'},
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200420 {"submodule", required_argument, NULL, 's'},
Michal Vasko667ce6b2021-01-25 15:00:27 +0100421 {"not-strict", no_argument, NULL, 'n'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200422 {"present", no_argument, NULL, 'e'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200423 {"type", required_argument, NULL, 't'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200424 {"default", required_argument, NULL, 'd'},
425 {"list", no_argument, NULL, 'l'},
426 {"tree-line-length", required_argument, NULL, 'L'},
427 {"output", required_argument, NULL, 'o'},
428 {"operational", required_argument, NULL, 'O'},
429 {"merge", no_argument, NULL, 'm'},
430 {"yang-library", no_argument, NULL, 'y'},
431#ifndef NDEBUG
432 {"debug", required_argument, NULL, 'G'},
433#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200434 {NULL, 0, NULL, 0}
435 };
Radek Krejcied5acc52019-04-25 15:57:04 +0200436
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100437 uint16_t options_ctx = YL_DEFAULT_CTX_OPTIONS;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100438 uint8_t data_type_set = 0;
439
Michal Vasko667ce6b2021-01-25 15:00:27 +0100440 c->data_parse_options = YL_DEFAULT_DATA_PARSE_OPTIONS;
aPiecek2cfeeae2021-04-21 13:17:34 +0200441 c->line_length = 0;
Michal Vasko667ce6b2021-01-25 15:00:27 +0100442
Michal Vasko27a4acb2021-11-22 10:03:46 +0100443 opterr = 0;
Radek Krejcied5acc52019-04-25 15:57:04 +0200444#ifndef NDEBUG
Michal Vaskob0d307b2021-11-25 11:15:16 +0100445 while ((opt = getopt_long(argc, argv, "hvVQf:p:DF:iP:qs:net:d:lL:o:OmyG:", options, &opt_index)) != -1) {
Michal Vasko27a4acb2021-11-22 10:03:46 +0100446#else
Michal Vaskob0d307b2021-11-25 11:15:16 +0100447 while ((opt = getopt_long(argc, argv, "hvVQf:p:DF:iP:qs:net:d:lL:o:Omy", options, &opt_index)) != -1) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200448#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200449 switch (opt) {
Michal Vaskoc40548b2021-09-30 13:05:47 +0200450 case 'h': /* --help */
451 help(0);
452 return 1;
453
454 case 'v': /* --version */
455 version();
456 return 1;
457
458 case 'V': { /* --verbose */
459 LY_LOG_LEVEL verbosity = ly_log_level(LY_LLERR);
Michal Vaskoc40548b2021-09-30 13:05:47 +0200460 if (verbosity < LY_LLDBG) {
Michal Vaskob0d307b2021-11-25 11:15:16 +0100461 ++verbosity;
Radek Krejcied5acc52019-04-25 15:57:04 +0200462 }
Michal Vaskob0d307b2021-11-25 11:15:16 +0100463 ly_log_level(verbosity);
Radek Krejcied5acc52019-04-25 15:57:04 +0200464 break;
Michal Vaskoc40548b2021-09-30 13:05:47 +0200465 } /* case 'V' */
Radek Krejcie9f13b12020-11-09 17:42:04 +0100466
Michal Vaskob0d307b2021-11-25 11:15:16 +0100467 case 'Q': { /* --quiet */
468 LY_LOG_LEVEL verbosity = ly_log_level(LY_LLERR);
469 if (verbosity == LY_LLERR) {
470 /* turn logging off */
471 ly_log_options(LY_LOSTORE_LAST);
472 } else if (verbosity > LY_LLERR) {
473 --verbosity;
474 }
475 ly_log_level(verbosity);
476 break;
477 } /* case 'Q' */
478
Radek Krejcie9f13b12020-11-09 17:42:04 +0100479 case 'f': /* --format */
480 if (!strcasecmp(optarg, "yang")) {
481 c->schema_out_format = LYS_OUT_YANG;
482 c->data_out_format = 0;
483 } else if (!strcasecmp(optarg, "yin")) {
484 c->schema_out_format = LYS_OUT_YIN;
485 c->data_out_format = 0;
486 } else if (!strcasecmp(optarg, "info")) {
487 c->schema_out_format = LYS_OUT_YANG_COMPILED;
488 c->data_out_format = 0;
489 } else if (!strcasecmp(optarg, "tree")) {
490 c->schema_out_format = LYS_OUT_TREE;
491 c->data_out_format = 0;
492 } else if (!strcasecmp(optarg, "xml")) {
493 c->schema_out_format = 0;
494 c->data_out_format = LYD_XML;
495 } else if (!strcasecmp(optarg, "json")) {
496 c->schema_out_format = 0;
497 c->data_out_format = LYD_JSON;
Radek Krejcied5acc52019-04-25 15:57:04 +0200498 } else {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100499 YLMSG_E("Unknown output format %s\n", optarg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200500 help(1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100501 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200502 }
503 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100504
Michal Vaskoc40548b2021-09-30 13:05:47 +0200505 case 'p': { /* --path */
506 struct stat st;
507
508 if (stat(optarg, &st) == -1) {
509 YLMSG_E("Unable to use search path (%s) - %s.\n", optarg, strerror(errno));
510 return -1;
511 }
512 if (!S_ISDIR(st.st_mode)) {
513 YLMSG_E("Provided search path is not a directory.\n");
514 return -1;
515 }
516
517 if (ly_set_add(&c->searchpaths, optarg, 0, NULL)) {
518 YLMSG_E("Storing searchpath failed.\n");
519 return -1;
520 }
521
522 break;
523 } /* case 'p' */
524
525 case 'D': /* --disable-search */
526 if (options_ctx & LY_CTX_DISABLE_SEARCHDIRS) {
527 YLMSG_W("The -D option specified too many times.\n");
528 }
529 if (options_ctx & LY_CTX_DISABLE_SEARCHDIR_CWD) {
530 options_ctx &= ~LY_CTX_DISABLE_SEARCHDIR_CWD;
531 options_ctx |= LY_CTX_DISABLE_SEARCHDIRS;
532 } else {
533 options_ctx |= LY_CTX_DISABLE_SEARCHDIR_CWD;
534 }
535 break;
536
537 case 'F': /* --features */
538 if (parse_features(optarg, &c->schema_features)) {
539 return -1;
540 }
541 break;
542
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200543 case 'i': /* --make-implemented */
Michal Vaskoc40548b2021-09-30 13:05:47 +0200544 if (options_ctx & LY_CTX_REF_IMPLEMENTED) {
545 options_ctx &= ~LY_CTX_REF_IMPLEMENTED;
546 options_ctx |= LY_CTX_ALL_IMPLEMENTED;
547 } else {
548 options_ctx |= LY_CTX_REF_IMPLEMENTED;
549 }
550 break;
551
Radek Krejcie9f13b12020-11-09 17:42:04 +0100552 case 'P': /* --schema-node */
553 c->schema_node_path = optarg;
Radek Krejcied5acc52019-04-25 15:57:04 +0200554 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100555
556 case 'q': /* --single-node */
557 c->schema_print_options |= LYS_PRINT_NO_SUBSTMT;
558 break;
559
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200560 case 's': /* --submodule */
561 c->submodule = optarg;
562 break;
563
Michal Vasko667ce6b2021-01-25 15:00:27 +0100564 case 'n': /* --not-strict */
565 c->data_parse_options &= ~LYD_PARSE_STRICT;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100566 break;
567
568 case 'e': /* --present */
569 c->data_validate_options |= LYD_VALIDATE_PRESENT;
570 break;
571
572 case 't': /* --type */
573 if (data_type_set) {
574 YLMSG_E("The data type (-t) cannot be set multiple times.\n");
575 return -1;
576 }
577
578 if (!strcasecmp(optarg, "config")) {
579 c->data_parse_options |= LYD_PARSE_NO_STATE;
Michal Vaskof6bda332021-02-01 08:59:03 +0100580 c->data_validate_options |= LYD_VALIDATE_NO_STATE;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100581 } else if (!strcasecmp(optarg, "get")) {
582 c->data_parse_options |= LYD_PARSE_ONLY;
583 } else if (!strcasecmp(optarg, "getconfig") || !strcasecmp(optarg, "get-config")) {
584 c->data_parse_options |= LYD_PARSE_ONLY | LYD_PARSE_NO_STATE;
585 } else if (!strcasecmp(optarg, "edit")) {
586 c->data_parse_options |= LYD_PARSE_ONLY;
587 } else if (!strcasecmp(optarg, "rpc") || !strcasecmp(optarg, "action")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100588 c->data_type = LYD_TYPE_RPC_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100589 } else if (!strcasecmp(optarg, "reply") || !strcasecmp(optarg, "rpcreply")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100590 c->data_type = LYD_TYPE_REPLY_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100591 } else if (!strcasecmp(optarg, "notif") || !strcasecmp(optarg, "notification")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100592 c->data_type = LYD_TYPE_NOTIF_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100593 } else if (!strcasecmp(optarg, "data")) {
594 /* default option */
595 } else {
596 YLMSG_E("Unknown data tree type %s\n", optarg);
597 help(1);
598 return -1;
599 }
600
601 data_type_set = 1;
602 break;
603
Michal Vaskoc40548b2021-09-30 13:05:47 +0200604 case 'd': /* --default */
605 if (!strcasecmp(optarg, "all")) {
606 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL;
607 } else if (!strcasecmp(optarg, "all-tagged")) {
608 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL_TAG;
609 } else if (!strcasecmp(optarg, "trim")) {
610 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_TRIM;
611 } else if (!strcasecmp(optarg, "implicit-tagged")) {
612 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_IMPL_TAG;
613 } else {
614 YLMSG_E("Unknown default mode %s\n", optarg);
615 help(1);
616 return -1;
617 }
618 break;
619
620 case 'l': /* --list */
621 c->list = 1;
622 break;
623
624 case 'L': /* --tree-line-length */
625 c->line_length = atoi(optarg);
626 break;
627
628 case 'o': /* --output */
629 if (c->out) {
630 YLMSG_E("Only a single output can be specified.\n");
631 return -1;
632 } else {
633 if (ly_out_new_filepath(optarg, &c->out)) {
634 YLMSG_E("Unable open output file %s (%s)\n", optarg, strerror(errno));
635 return -1;
636 }
637 }
638 break;
639
Radek Krejcie9f13b12020-11-09 17:42:04 +0100640 case 'O': /* --operational */
641 if (c->data_operational.path) {
642 YLMSG_E("The operational datastore (-O) cannot be set multiple times.\n");
643 return -1;
644 }
645 c->data_operational.path = optarg;
646 break;
647
Radek Krejcie9f13b12020-11-09 17:42:04 +0100648 case 'm': /* --merge */
649 c->data_merge = 1;
650 break;
651
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100652 case 'y': /* --yang-library */
653 options_ctx &= ~LY_CTX_NO_YANGLIBRARY;
654 break;
655
Radek Krejcied5acc52019-04-25 15:57:04 +0200656#ifndef NDEBUG
Radek Krejcie9f13b12020-11-09 17:42:04 +0100657 case 'G': { /* --debug */
658 uint32_t dbg_groups = 0;
659 const char *ptr = optarg;
660
Radek Krejcied5acc52019-04-25 15:57:04 +0200661 while (ptr[0]) {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100662 if (!strncasecmp(ptr, "dict", sizeof "dict" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100663 dbg_groups |= LY_LDGDICT;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100664 ptr += sizeof "dict" - 1;
665 } else if (!strncasecmp(ptr, "xpath", sizeof "xpath" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100666 dbg_groups |= LY_LDGXPATH;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100667 ptr += sizeof "xpath" - 1;
Michal Vasko27a4acb2021-11-22 10:03:46 +0100668 } else if (!strncasecmp(ptr, "dep-sets", sizeof "dep-sets" - 1)) {
669 dbg_groups |= LY_LDGDEPSETS;
670 ptr += sizeof "dep-sets" - 1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200671 }
672
673 if (ptr[0]) {
674 if (ptr[0] != ',') {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100675 YLMSG_E("Unknown debug group string \"%s\"\n", optarg);
676 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200677 }
678 ++ptr;
679 }
680 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100681 ly_log_dbg_groups(dbg_groups);
Radek Krejcied5acc52019-04-25 15:57:04 +0200682 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100683 } /* case 'G' */
Radek Krejcied5acc52019-04-25 15:57:04 +0200684#endif
Michal Vasko27a4acb2021-11-22 10:03:46 +0100685 default:
686 YLMSG_E("Invalid option or missing argument: -%c\n", optopt);
687 return -1;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100688 } /* switch */
689 }
690
Michal Vasko59740872021-11-22 10:01:34 +0100691 /* set imp feature flag if all should be enabled */
692 if (!c->schema_features.count) {
693 options_ctx |= LY_CTX_ENABLE_IMP_FEATURES;
694 }
695
Radek Krejcie9f13b12020-11-09 17:42:04 +0100696 /* libyang context */
697 if (ly_ctx_new(NULL, options_ctx, &c->ctx)) {
698 YLMSG_E("Unable to create libyang context.\n");
699 return -1;
700 }
701 for (uint32_t u = 0; u < c->searchpaths.count; ++u) {
702 ly_ctx_set_searchdir(c->ctx, c->searchpaths.objs[u]);
703 }
704
705 /* additional checks for the options combinations */
706 if (!c->list && (optind >= argc)) {
707 help(1);
708 YLMSG_E("Missing <schema> to process.\n");
709 return 1;
710 }
711
712 if (c->data_merge) {
713 if (c->data_type || (c->data_parse_options & LYD_PARSE_ONLY)) {
714 /* switch off the option, incompatible input data type */
715 c->data_merge = 0;
716 } else {
717 /* postpone validation after the merge of all the input data */
718 c->data_parse_options |= LYD_PARSE_ONLY;
Radek Krejcied5acc52019-04-25 15:57:04 +0200719 }
720 }
721
Radek Krejcie9f13b12020-11-09 17:42:04 +0100722 if (c->data_operational.path && !c->data_type) {
723 YLMSG_E("Operational datastore takes effect only with RPCs/Actions/Replies/Notifications input data types.\n");
724 c->data_operational.path = NULL;
Radek Krejcied5acc52019-04-25 15:57:04 +0200725 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100726
aPiecek2cfeeae2021-04-21 13:17:34 +0200727 if ((c->schema_out_format != LYS_OUT_TREE) && c->line_length) {
728 YLMSG_E("--tree-line-length take effect only in case of the tree output format.\n");
729 }
730
Radek Krejcie9f13b12020-11-09 17:42:04 +0100731 /* default output stream */
732 if (!c->out) {
733 if (ly_out_new_file(stdout, &c->out)) {
734 YLMSG_E("Unable to set stdout as output.\n");
735 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200736 }
737 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100738
aPiecek7ac66d52021-05-20 07:54:07 +0200739 if (c->schema_out_format == LYS_OUT_TREE) {
740 /* print tree from lysc_nodes */
741 ly_ctx_set_options(c->ctx, LY_CTX_SET_PRIV_PARSED);
742 }
743
Radek Krejcie9f13b12020-11-09 17:42:04 +0100744 /* process input files provided as standalone command line arguments,
745 * schema modules are parsed and inserted into the context,
746 * data files are just checked and prepared into internal structures for further processing */
747 ret = fill_context_inputs(argc, argv, c);
748 if (ret) {
749 return ret;
750 }
751
752 /* the second batch of checks */
753 if (c->schema_print_options && !c->schema_out_format) {
754 YLMSG_W("Schema printer options specified, but the schema output format is missing.\n");
755 }
756 if (c->schema_parse_options && !c->schema_modules.count) {
757 YLMSG_W("Schema parser options specified, but no schema input file provided.\n");
758 }
759 if (c->data_print_options && !c->data_out_format) {
760 YLMSG_W("data printer options specified, but the data output format is missing.\n");
761 }
Michal Vasko667ce6b2021-01-25 15:00:27 +0100762 if (((c->data_parse_options != YL_DEFAULT_DATA_PARSE_OPTIONS) || c->data_type) && !c->data_inputs.count) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100763 YLMSG_W("Data parser options specified, but no data input file provided.\n");
764 }
765
766 if (c->schema_node_path) {
767 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 0);
768 if (!c->schema_node) {
769 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 1);
770
771 if (!c->schema_node) {
772 YLMSG_E("Invalid schema path.\n");
773 return -1;
774 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200775 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200776 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100777
Radek Krejcie9f13b12020-11-09 17:42:04 +0100778 return 0;
779}
780
781int
782main_ni(int argc, char *argv[])
783{
784 int ret = EXIT_SUCCESS, r;
785 struct context c = {0};
Radek Krejcied5acc52019-04-25 15:57:04 +0200786
787 /* set callback for printing libyang messages */
788 ly_set_log_clb(libyang_verbclb, 1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100789
790 r = fill_context(argc, argv, &c);
791 if (r < 0) {
792 ret = EXIT_FAILURE;
Radek Krejcied5acc52019-04-25 15:57:04 +0200793 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100794 if (r) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200795 goto cleanup;
796 }
797
Radek Krejcie9f13b12020-11-09 17:42:04 +0100798 /* do the required job - parse, validate, print */
799
800 if (c.list) {
801 /* print the list of schemas */
802 print_list(c.out, c.ctx, c.data_out_format);
Radek Krejci047d64e2020-12-03 12:57:10 +0100803 } else {
804 if (c.schema_out_format) {
805 if (c.schema_node) {
806 ret = lys_print_node(c.out, c.schema_node, c.schema_out_format, 0, c.schema_print_options);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100807 if (ret) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100808 YLMSG_E("Unable to print schema node %s.\n", c.schema_node_path);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100809 goto cleanup;
810 }
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200811 } else if (c.submodule) {
812 const struct lysp_submodule *submod = ly_ctx_get_submodule_latest(c.ctx, c.submodule);
813 if (!submod) {
814 YLMSG_E("Unable to find submodule %s.\n", c.submodule);
815 goto cleanup;
816 }
817
818 ret = lys_print_submodule(c.out, submod, c.schema_out_format, c.line_length, c.schema_print_options);
819 if (ret) {
820 YLMSG_E("Unable to print submodule %s.\n", submod->name);
821 goto cleanup;
822 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100823 } else {
824 for (uint32_t u = 0; u < c.schema_modules.count; ++u) {
aPiecek2cfeeae2021-04-21 13:17:34 +0200825 ret = lys_print_module(c.out, (struct lys_module *)c.schema_modules.objs[u], c.schema_out_format,
826 c.line_length, c.schema_print_options);
aPiecek8f0b7882021-05-21 10:18:36 +0200827 /* for YANG Tree Diagrams printing it's more readable to print a blank line between modules. */
828 if ((c.schema_out_format == LYS_OUT_TREE) && (u + 1 < c.schema_modules.count)) {
829 ly_print(c.out, "\n");
830 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100831 if (ret) {
832 YLMSG_E("Unable to print module %s.\n", ((struct lys_module *)c.schema_modules.objs[u])->name);
833 goto cleanup;
834 }
835 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100836 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200837 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100838
839 /* do the data validation despite the schema was printed */
840 if (c.data_inputs.size) {
841 if (process_data(c.ctx, c.data_type, c.data_merge, c.data_out_format, c.out,
842 c.data_parse_options, c.data_validate_options, c.data_print_options,
Radek Krejci6784a4e2020-12-09 14:23:05 +0100843 &c.data_operational, &c.data_inputs, NULL)) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100844 goto cleanup;
845 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200846 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200847 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200848
849cleanup:
Radek Krejcie9f13b12020-11-09 17:42:04 +0100850 /* cleanup */
851 erase_context(&c);
Radek Krejcied5acc52019-04-25 15:57:04 +0200852
Radek Krejcied5acc52019-04-25 15:57:04 +0200853 return ret;
854}