blob: 76b6fe01ca17359c3a705b0725a1151cb6e5bb2a [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"
Radek Krejci535ea9f2020-05-29 16:01:05 +020029#include "tools/config.h"
30
Radek Krejcie9f13b12020-11-09 17:42:04 +010031/**
32 * @brief Context structure to hold and pass variables in a structured form.
33 */
34struct context {
35 /* libyang context for the run */
36 struct ly_ctx *ctx;
Radek Krejci535ea9f2020-05-29 16:01:05 +020037
Radek Krejcie9f13b12020-11-09 17:42:04 +010038 /* prepared output (--output option or stdout by default) */
39 struct ly_out *out;
Radek Krejci535ea9f2020-05-29 16:01:05 +020040
Radek Krejcie9f13b12020-11-09 17:42:04 +010041 struct ly_set searchpaths;
Radek Krejcied5acc52019-04-25 15:57:04 +020042
Radek Krejcie9f13b12020-11-09 17:42:04 +010043 /* options flags */
44 uint8_t list; /* -l option to print list of schemas */
Radek Krejcied5acc52019-04-25 15:57:04 +020045
aPiecek2cfeeae2021-04-21 13:17:34 +020046 /* line length for 'tree' format */
47 size_t line_length; /* --tree-line-length */
48
Radek Krejcie9f13b12020-11-09 17:42:04 +010049 /*
50 * schema
51 */
52 /* set schema modules' features via --feature option (struct schema_features *) */
53 struct ly_set schema_features;
54
55 /* set of loaded schema modules (struct lys_module *) */
56 struct ly_set schema_modules;
57
58 /* options to parse and print schema modules */
59 uint32_t schema_parse_options;
60 uint32_t schema_print_options;
61
62 /* specification of printing schema node subtree, option --schema-node */
63 const char *schema_node_path;
64 const struct lysc_node *schema_node;
65
66 /* value of --format in case of schema format */
67 LYS_OUTFORMAT schema_out_format;
68
69 /*
70 * data
71 */
72 /* various options based on --type option */
Michal Vaskoe0665742021-02-11 11:08:44 +010073 enum lyd_type data_type;
Radek Krejcie9f13b12020-11-09 17:42:04 +010074 uint32_t data_parse_options;
75 uint32_t data_validate_options;
76 uint32_t data_print_options;
77
78 /* flag for --merge option */
79 uint8_t data_merge;
80
81 /* value of --format in case of data format */
82 LYD_FORMAT data_out_format;
83
84 /* input data files (struct cmdline_file *) */
85 struct ly_set data_inputs;
86
Radek Krejcie9f13b12020-11-09 17:42:04 +010087 /* storage for --operational */
88 struct cmdline_file data_operational;
89};
90
91static void
92erase_context(struct context *c)
93{
94 /* data */
95 ly_set_erase(&c->data_inputs, free_cmdline_file);
Radek Krejcie9f13b12020-11-09 17:42:04 +010096 ly_in_free(c->data_operational.in, 1);
97
98 /* schema */
99 ly_set_erase(&c->schema_features, free_features);
100 ly_set_erase(&c->schema_modules, NULL);
101
102 /* context */
103 ly_set_erase(&c->searchpaths, NULL);
104
105 ly_out_free(c->out, NULL, 0);
Radek Krejci90ed21e2021-04-12 14:47:46 +0200106 ly_ctx_destroy(c->ctx);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100107}
108
109static void
110version(void)
111{
112 printf("yanglint %s\n", PROJECT_VERSION);
113}
114
115static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200116help(int shortout)
117{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100118
119 printf("Usage:\n"
120 " yanglint [Options] [-f { yang | yin | info}] <schema>...\n"
121 " Validates the YANG module in <schema>, and all its dependencies.\n\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100122 " yanglint [Options] [-f { xml | json }] <schema>... <file> ...\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100123 " Validates the YANG modeled data in <file> according to the <schema>.\n\n"
124 " yanglint\n"
125 " Starts interactive mode with more features.\n\n");
Radek Krejcied5acc52019-04-25 15:57:04 +0200126
127 if (shortout) {
128 return;
129 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100130 printf("Options:\n"
131 " -h, --help Show this help message and exit.\n"
132 " -v, --version Show version number and exit.\n"
133 " -V, --verbose Show verbose messages, can be used multiple times to\n"
134 " increase verbosity.\n"
Radek Krejcied5acc52019-04-25 15:57:04 +0200135#ifndef NDEBUG
Radek Krejcie9f13b12020-11-09 17:42:04 +0100136 " -G GROUPS, --debug=GROUPS\n"
137 " Enable printing of specific debugging message group\n"
138 " (nothing will be printed unless verbosity is set to debug):\n"
139 " <group>[,<group>]* (dict, xpath)\n\n"
Radek Krejcied5acc52019-04-25 15:57:04 +0200140#endif
Radek Krejcie9f13b12020-11-09 17:42:04 +0100141
142 " -d MODE, --default=MODE\n"
143 " Print data with default values, according to the MODE\n"
144 " (to print attributes, ietf-netconf-with-defaults model\n"
145 " must be loaded):\n"
146 " all - Add missing default nodes.\n"
147 " all-tagged - Add missing default nodes and mark all the default\n"
148 " nodes with the attribute.\n"
149 " trim - Remove all nodes with a default value.\n"
150 " implicit-tagged - Add missing nodes and mark them with the attribute.\n\n"
151
152 " -D, --disable-searchdir\n"
153 " Do not implicitly search in current working directory for\n"
154 " schema modules. If specified a second time, do not even\n"
155 " search in the module directory (all modules must be \n"
156 " explicitly specified).\n\n"
157
158 " -p PATH, --path=PATH\n"
159 " Search path for schema (YANG/YIN) modules. The option can be\n"
160 " used multiple times. The current working directory and the\n"
161 " path of the module being added is used implicitly.\n\n"
162
163 " -F FEATURES, --features=FEATURES\n"
164 " Features to support, default all.\n"
165 " <modname>:[<feature>,]*\n\n"
166
167 " -i, --makeimplemented\n"
168 " Make the imported modules \"referenced\" from any loaded\n"
169 " module also implemented. If specified a second time, all the\n"
170 " modules are set implemented.\n\n"
171
172 " -l, --list Print info about the loaded schemas.\n"
173 " (i - imported module, I - implemented module)\n"
174 " In case the -f option with data encoding is specified,\n"
175 " the list is printed as ietf-yang-library data.\n\n"
176
aPiecek2cfeeae2021-04-21 13:17:34 +0200177 " -L LINE_LENGTH, --tree-line-length=LINE_LENGTH\n"
178 " The limit of the maximum line length on which the 'tree'\n"
179 " format will try to be printed.\n\n"
180
Radek Krejcie9f13b12020-11-09 17:42:04 +0100181 " -o OUTFILE, --output=OUTFILE\n"
182 " Write the output to OUTFILE instead of stdout.\n\n"
183
184 " -f FORMAT, --format=FORMAT\n"
185 " Convert input into FORMAT. Supported formats: \n"
186 " yang, yin, tree and info for schemas,\n"
187 " xml, json for data.\n\n"
188
189 " -P PATH, --schema-node=PATH\n"
190 " Print only the specified subtree of the schema.\n"
191 " The PATH is the XPath subset mentioned in documentation as\n"
192 " the Path format. The option can be combined with --single-node\n"
193 " option to print information only about the specified node.\n"
194 " -q, --single-node\n"
195 " Supplement to the --schema-node option to print information\n"
196 " only about a single node specified as PATH argument.\n\n"
197
Michal Vasko667ce6b2021-01-25 15:00:27 +0100198 " -n, --not-strict\n"
199 " Do not require strict data parsing (silently skip unknown data),\n"
200 " has no effect for schemas.\n\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100201
202 " -e, --present Validate only with the schema modules whose data actually\n"
203 " exist in the provided input data files. Takes effect only\n"
204 " with the 'data' or 'config' TYPEs. Used to avoid requiring\n"
205 " mandatory nodes from modules which data are not present in the\n"
206 " provided input data files.\n\n"
207
208 " -t TYPE, --type=TYPE\n"
209 " Specify data tree type in the input data file(s):\n"
210 " data - Complete datastore with status data (default type).\n"
211 " config - Configuration datastore (without status data).\n"
212 " get - Result of the NETCONF <get> operation.\n"
213 " getconfig - Result of the NETCONF <get-config> operation.\n"
214 " edit - Content of the NETCONF <edit-config> operation.\n"
215 " rpc - Content of the NETCONF <rpc> message, defined as YANG's\n"
216 " RPC/Action input statement.\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100217 " reply - Reply to the RPC/Action. Note that the reply data are\n"
218 " expected inside a container representing the original\n"
219 " RPC/Action. This is necessary to identify appropriate\n"
220 " data definitions in the schema module.\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100221 " notif - Notification instance (content of the <notification>\n"
222 " element without <eventTime>).\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100223
224 " -O FILE, --operational=FILE\n"
225 " Provide optional data to extend validation of the 'rpc',\n"
226 " 'reply' or 'notif' TYPEs. The FILE is supposed to contain\n"
227 " the :running configuration datastore and state data\n"
228 " (operational datastore) referenced from the RPC/Notification.\n\n"
229
230 " -m, --merge Merge input data files into a single tree and validate at\n"
231 " once.The option has effect only for 'data' and 'config' TYPEs.\n\n"
232
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100233 " -y, --yang-library\n"
234 " Load and implement internal \"ietf-yang-library\" YANG module.\n"
235 " Note that this module includes definitions of mandatory state\n"
236 " data that can result in unexpected data validation errors.\n\n"
aPiecek2cfeeae2021-04-21 13:17:34 +0200237 "");
Radek Krejcied5acc52019-04-25 15:57:04 +0200238}
239
Radek Krejcie9f13b12020-11-09 17:42:04 +0100240static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200241libyang_verbclb(LY_LOG_LEVEL level, const char *msg, const char *path)
242{
243 char *levstr;
244
Radek Krejcie9f13b12020-11-09 17:42:04 +0100245 switch (level) {
246 case LY_LLERR:
247 levstr = "err :";
248 break;
249 case LY_LLWRN:
250 levstr = "warn:";
251 break;
252 case LY_LLVRB:
253 levstr = "verb:";
254 break;
255 default:
256 levstr = "dbg :";
257 break;
258 }
259 if (path) {
260 fprintf(stderr, "libyang %s %s (%s)\n", levstr, msg, path);
261 } else {
262 fprintf(stderr, "libyang %s %s\n", levstr, msg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200263 }
264}
265
Radek Krejcie9f13b12020-11-09 17:42:04 +0100266static int
267fill_context_inputs(int argc, char *argv[], struct context *c)
268{
Radek Krejcif53b0d52020-12-03 11:29:24 +0100269 struct ly_in *in;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100270
271 /* process the operational content if any */
272 if (c->data_operational.path) {
273 if (get_input(c->data_operational.path, NULL, &c->data_operational.format, &c->data_operational.in)) {
274 return -1;
275 }
276 }
277
278 for (int i = 0; i < argc - optind; i++) {
279 LYS_INFORMAT format_schema = LYS_IN_UNKNOWN;
280 LYD_FORMAT format_data = LYD_UNKNOWN;
Radek Krejcif53b0d52020-12-03 11:29:24 +0100281 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100282
283 if (get_input(argv[optind + i], &format_schema, &format_data, &in)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100284 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100285 }
286
287 if (format_schema) {
288 LY_ERR ret;
289 uint8_t path_unset = 1; /* flag to unset the path from the searchpaths list (if not already present) */
290 char *dir, *module;
291 const char *fall = "*";
292 const char **features = &fall;
293 const struct lys_module *mod;
294
295 if (parse_schema_path(argv[optind + i], &dir, &module)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100296 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100297 }
298
299 /* add temporarily also the path of the module itself */
300 if (ly_ctx_set_searchdir(c->ctx, dir) == LY_EEXIST) {
301 path_unset = 0;
302 }
303
304 /* get features list for this module */
305 get_features(&c->schema_features, module, &features);
306
307 /* temporary cleanup */
308 free(dir);
309 free(module);
310
311 ret = lys_parse(c->ctx, in, format_schema, features, &mod);
312 ly_ctx_unset_searchdir_last(c->ctx, path_unset);
Radek Krejcif53b0d52020-12-03 11:29:24 +0100313 ly_in_free(in, 1);
314 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100315 if (ret) {
316 YLMSG_E("Processing schema module from %s failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100317 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100318 }
319
320 if (c->schema_out_format) {
321 /* modules will be printed */
322 if (ly_set_add(&c->schema_modules, (void *)mod, 1, NULL)) {
323 YLMSG_E("Storing parsed schema module (%s) for print failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100324 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100325 }
326 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100327 } else if (format_data) {
Radek Krejci6784a4e2020-12-09 14:23:05 +0100328 if (!fill_cmdline_file(&c->data_inputs, in, argv[optind + i], format_data)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100329 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100330 }
Radek Krejcif53b0d52020-12-03 11:29:24 +0100331 in = NULL;
Radek Krejci3329b652020-12-05 23:54:07 +0100332 } else {
333 ly_in_free(in, 1);
334 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100335 }
336 }
337
Radek Krejcie9f13b12020-11-09 17:42:04 +0100338 return 0;
Radek Krejcif2afd672020-11-26 12:29:23 +0100339
340error:
341 ly_in_free(in, 1);
342 return -1;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100343}
344
345/**
346 * @brief Process command line options and store the settings into the context.
347 *
348 * return -1 in case of error;
349 * return 0 in case of success and ready to process
350 * return 1 in case of success, but expect to exit.
Radek Krejcied5acc52019-04-25 15:57:04 +0200351 */
352static int
Radek Krejcie9f13b12020-11-09 17:42:04 +0100353fill_context(int argc, char *argv[], struct context *c)
Radek Krejcied5acc52019-04-25 15:57:04 +0200354{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100355 int ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200356
Radek Krejcie9f13b12020-11-09 17:42:04 +0100357 int opt, opt_index;
Radek Krejcied5acc52019-04-25 15:57:04 +0200358 struct option options[] = {
Radek Krejciff61c882020-09-03 13:04:18 +0200359 {"default", required_argument, NULL, 'd'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100360 {"disable-searchdir", no_argument, NULL, 'D'},
361 {"present", no_argument, NULL, 'e'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200362 {"format", required_argument, NULL, 'f'},
363 {"features", required_argument, NULL, 'F'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100364#ifndef NDEBUG
365 {"debug", required_argument, NULL, 'G'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200366#endif
367 {"help", no_argument, NULL, 'h'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100368 {"makeimplemented", no_argument, NULL, 'i'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200369 {"list", no_argument, NULL, 'l'},
aPiecek2cfeeae2021-04-21 13:17:34 +0200370 {"tree-line-length", required_argument, NULL, 'L'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200371 {"merge", no_argument, NULL, 'm'},
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100372 {"yang-library", no_argument, NULL, 'y'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200373 {"output", required_argument, NULL, 'o'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200374 {"operational", required_argument, NULL, 'O'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100375 {"path", required_argument, NULL, 'p'},
376 {"schema-node", required_argument, NULL, 'P'},
Radek Krejcie1f6d5a2019-11-17 14:03:04 +0800377 {"single-node", no_argument, NULL, 'q'},
Michal Vasko667ce6b2021-01-25 15:00:27 +0100378 {"not-strict", no_argument, NULL, 'n'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200379 {"type", required_argument, NULL, 't'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200380 {"version", no_argument, NULL, 'v'},
381 {"verbose", no_argument, NULL, 'V'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200382 {NULL, 0, NULL, 0}
383 };
Radek Krejcied5acc52019-04-25 15:57:04 +0200384
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100385 uint16_t options_ctx = YL_DEFAULT_CTX_OPTIONS;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100386 uint8_t data_type_set = 0;
387
Michal Vasko667ce6b2021-01-25 15:00:27 +0100388 c->data_parse_options = YL_DEFAULT_DATA_PARSE_OPTIONS;
aPiecek2cfeeae2021-04-21 13:17:34 +0200389 c->line_length = 0;
Michal Vasko667ce6b2021-01-25 15:00:27 +0100390
Radek Krejcied5acc52019-04-25 15:57:04 +0200391#ifndef NDEBUG
aPiecek2cfeeae2021-04-21 13:17:34 +0200392 while ((opt = getopt_long(argc, argv, "d:Def:F:hilL:myo:p:P:qnt:vV", options, &opt_index)) != -1) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200393#else
aPiecek2cfeeae2021-04-21 13:17:34 +0200394 while ((opt = getopt_long(argc, argv, "d:Def:F:G:hilL:myo:p:P:qnt:vV", options, &opt_index)) != -1) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200395#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200396 switch (opt) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100397 case 'd': /* --default */
398 if (!strcasecmp(optarg, "all")) {
399 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL;
400 } else if (!strcasecmp(optarg, "all-tagged")) {
401 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL_TAG;
402 } else if (!strcasecmp(optarg, "trim")) {
403 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_TRIM;
404 } else if (!strcasecmp(optarg, "implicit-tagged")) {
405 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_IMPL_TAG;
Radek Krejcied5acc52019-04-25 15:57:04 +0200406 } else {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100407 YLMSG_E("Unknown default mode %s\n", optarg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200408 help(1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100409 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200410 }
411 break;
Radek Krejcied5acc52019-04-25 15:57:04 +0200412
Radek Krejcie9f13b12020-11-09 17:42:04 +0100413 case 'D': /* --disable-search */
Radek Krejcied5acc52019-04-25 15:57:04 +0200414 if (options_ctx & LY_CTX_DISABLE_SEARCHDIRS) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100415 YLMSG_W("The -D option specified too many times.\n");
416 }
417 if (options_ctx & LY_CTX_DISABLE_SEARCHDIR_CWD) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200418 options_ctx &= ~LY_CTX_DISABLE_SEARCHDIR_CWD;
419 options_ctx |= LY_CTX_DISABLE_SEARCHDIRS;
420 } else {
421 options_ctx |= LY_CTX_DISABLE_SEARCHDIR_CWD;
422 }
423 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100424
425 case 'p': { /* --path */
426 struct stat st;
427
Radek Krejcied5acc52019-04-25 15:57:04 +0200428 if (stat(optarg, &st) == -1) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100429 YLMSG_E("Unable to use search path (%s) - %s.\n", optarg, strerror(errno));
430 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200431 }
432 if (!S_ISDIR(st.st_mode)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100433 YLMSG_E("Provided search path is not a directory.\n");
434 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200435 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100436
437 if (ly_set_add(&c->searchpaths, optarg, 0, NULL)) {
438 YLMSG_E("Storing searchpath failed.\n");
439 return -1;
440 }
441
442 break;
443 } /* case 'p' */
444
445 case 'i': /* --makeimplemented */
446 if (options_ctx & LY_CTX_REF_IMPLEMENTED) {
447 options_ctx &= ~LY_CTX_REF_IMPLEMENTED;
448 options_ctx |= LY_CTX_ALL_IMPLEMENTED;
449 } else {
450 options_ctx |= LY_CTX_REF_IMPLEMENTED;
451 }
452 break;
453
454 case 'F': /* --features */
455 if (parse_features(optarg, &c->schema_features)) {
456 return -1;
457 }
458 break;
459
460 case 'l': /* --list */
461 c->list = 1;
462 break;
463
aPiecek2cfeeae2021-04-21 13:17:34 +0200464 case 'L': /* --tree-line-length */
465 c->line_length = atoi(optarg);
466 break;
467
Radek Krejcie9f13b12020-11-09 17:42:04 +0100468 case 'o': /* --output */
469 if (c->out) {
470 YLMSG_E("Only a single output can be specified.\n");
471 return -1;
472 } else {
473 if (ly_out_new_filepath(optarg, &c->out)) {
474 YLMSG_E("Unable open output file %s (%s)\n", optarg, strerror(errno));
475 return -1;
Radek Krejciba03a5a2020-08-27 14:40:41 +0200476 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200477 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200478 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100479
480 case 'f': /* --format */
481 if (!strcasecmp(optarg, "yang")) {
482 c->schema_out_format = LYS_OUT_YANG;
483 c->data_out_format = 0;
484 } else if (!strcasecmp(optarg, "yin")) {
485 c->schema_out_format = LYS_OUT_YIN;
486 c->data_out_format = 0;
487 } else if (!strcasecmp(optarg, "info")) {
488 c->schema_out_format = LYS_OUT_YANG_COMPILED;
489 c->data_out_format = 0;
490 } else if (!strcasecmp(optarg, "tree")) {
491 c->schema_out_format = LYS_OUT_TREE;
492 c->data_out_format = 0;
493 } else if (!strcasecmp(optarg, "xml")) {
494 c->schema_out_format = 0;
495 c->data_out_format = LYD_XML;
496 } else if (!strcasecmp(optarg, "json")) {
497 c->schema_out_format = 0;
498 c->data_out_format = LYD_JSON;
Radek Krejcied5acc52019-04-25 15:57:04 +0200499 } else {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100500 YLMSG_E("Unknown output format %s\n", optarg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200501 help(1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100502 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200503 }
504 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100505
506 case 'P': /* --schema-node */
507 c->schema_node_path = optarg;
Radek Krejcied5acc52019-04-25 15:57:04 +0200508 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100509
510 case 'q': /* --single-node */
511 c->schema_print_options |= LYS_PRINT_NO_SUBSTMT;
512 break;
513
Michal Vasko667ce6b2021-01-25 15:00:27 +0100514 case 'n': /* --not-strict */
515 c->data_parse_options &= ~LYD_PARSE_STRICT;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100516 break;
517
518 case 'e': /* --present */
519 c->data_validate_options |= LYD_VALIDATE_PRESENT;
520 break;
521
522 case 't': /* --type */
523 if (data_type_set) {
524 YLMSG_E("The data type (-t) cannot be set multiple times.\n");
525 return -1;
526 }
527
528 if (!strcasecmp(optarg, "config")) {
529 c->data_parse_options |= LYD_PARSE_NO_STATE;
Michal Vaskof6bda332021-02-01 08:59:03 +0100530 c->data_validate_options |= LYD_VALIDATE_NO_STATE;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100531 } else if (!strcasecmp(optarg, "get")) {
532 c->data_parse_options |= LYD_PARSE_ONLY;
533 } else if (!strcasecmp(optarg, "getconfig") || !strcasecmp(optarg, "get-config")) {
534 c->data_parse_options |= LYD_PARSE_ONLY | LYD_PARSE_NO_STATE;
535 } else if (!strcasecmp(optarg, "edit")) {
536 c->data_parse_options |= LYD_PARSE_ONLY;
537 } else if (!strcasecmp(optarg, "rpc") || !strcasecmp(optarg, "action")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100538 c->data_type = LYD_TYPE_RPC_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100539 } else if (!strcasecmp(optarg, "reply") || !strcasecmp(optarg, "rpcreply")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100540 c->data_type = LYD_TYPE_REPLY_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100541 } else if (!strcasecmp(optarg, "notif") || !strcasecmp(optarg, "notification")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100542 c->data_type = LYD_TYPE_NOTIF_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100543 } else if (!strcasecmp(optarg, "data")) {
544 /* default option */
545 } else {
546 YLMSG_E("Unknown data tree type %s\n", optarg);
547 help(1);
548 return -1;
549 }
550
551 data_type_set = 1;
552 break;
553
554 case 'O': /* --operational */
555 if (c->data_operational.path) {
556 YLMSG_E("The operational datastore (-O) cannot be set multiple times.\n");
557 return -1;
558 }
559 c->data_operational.path = optarg;
560 break;
561
Radek Krejcie9f13b12020-11-09 17:42:04 +0100562 case 'm': /* --merge */
563 c->data_merge = 1;
564 break;
565
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100566 case 'y': /* --yang-library */
567 options_ctx &= ~LY_CTX_NO_YANGLIBRARY;
568 break;
569
Radek Krejcie9f13b12020-11-09 17:42:04 +0100570 case 'h': /* --help */
571 help(0);
572 return 1;
573
574 case 'v': /* --version */
575 version();
576 return 1;
577
578 case 'V': { /* --verbose */
579 LY_LOG_LEVEL verbosity = ly_log_level(LY_LLERR);
580 ly_log_level(verbosity);
581
582 if (verbosity < LY_LLDBG) {
583 ly_log_level(verbosity + 1);
584 }
585 break;
586 } /* case 'V' */
587
Radek Krejcied5acc52019-04-25 15:57:04 +0200588#ifndef NDEBUG
Radek Krejcie9f13b12020-11-09 17:42:04 +0100589 case 'G': { /* --debug */
590 uint32_t dbg_groups = 0;
591 const char *ptr = optarg;
592
Radek Krejcied5acc52019-04-25 15:57:04 +0200593 while (ptr[0]) {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100594 if (!strncasecmp(ptr, "dict", sizeof "dict" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100595 dbg_groups |= LY_LDGDICT;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100596 ptr += sizeof "dict" - 1;
597 } else if (!strncasecmp(ptr, "xpath", sizeof "xpath" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100598 dbg_groups |= LY_LDGXPATH;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100599 ptr += sizeof "xpath" - 1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200600 }
601
602 if (ptr[0]) {
603 if (ptr[0] != ',') {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100604 YLMSG_E("Unknown debug group string \"%s\"\n", optarg);
605 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200606 }
607 ++ptr;
608 }
609 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100610 ly_log_dbg_groups(dbg_groups);
Radek Krejcied5acc52019-04-25 15:57:04 +0200611 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100612 } /* case 'G' */
Radek Krejcied5acc52019-04-25 15:57:04 +0200613#endif
Radek Krejcie9f13b12020-11-09 17:42:04 +0100614 } /* switch */
615 }
616
617 /* libyang context */
618 if (ly_ctx_new(NULL, options_ctx, &c->ctx)) {
619 YLMSG_E("Unable to create libyang context.\n");
620 return -1;
621 }
622 for (uint32_t u = 0; u < c->searchpaths.count; ++u) {
623 ly_ctx_set_searchdir(c->ctx, c->searchpaths.objs[u]);
624 }
625
626 /* additional checks for the options combinations */
627 if (!c->list && (optind >= argc)) {
628 help(1);
629 YLMSG_E("Missing <schema> to process.\n");
630 return 1;
631 }
632
633 if (c->data_merge) {
634 if (c->data_type || (c->data_parse_options & LYD_PARSE_ONLY)) {
635 /* switch off the option, incompatible input data type */
636 c->data_merge = 0;
637 } else {
638 /* postpone validation after the merge of all the input data */
639 c->data_parse_options |= LYD_PARSE_ONLY;
Radek Krejcied5acc52019-04-25 15:57:04 +0200640 }
641 }
642
Radek Krejcie9f13b12020-11-09 17:42:04 +0100643 if (c->data_operational.path && !c->data_type) {
644 YLMSG_E("Operational datastore takes effect only with RPCs/Actions/Replies/Notifications input data types.\n");
645 c->data_operational.path = NULL;
Radek Krejcied5acc52019-04-25 15:57:04 +0200646 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100647
aPiecek2cfeeae2021-04-21 13:17:34 +0200648 if ((c->schema_out_format != LYS_OUT_TREE) && c->line_length) {
649 YLMSG_E("--tree-line-length take effect only in case of the tree output format.\n");
650 }
651
Radek Krejcie9f13b12020-11-09 17:42:04 +0100652 /* default output stream */
653 if (!c->out) {
654 if (ly_out_new_file(stdout, &c->out)) {
655 YLMSG_E("Unable to set stdout as output.\n");
656 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200657 }
658 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100659
aPiecek7ac66d52021-05-20 07:54:07 +0200660 if (c->schema_out_format == LYS_OUT_TREE) {
661 /* print tree from lysc_nodes */
662 ly_ctx_set_options(c->ctx, LY_CTX_SET_PRIV_PARSED);
663 }
664
Radek Krejcie9f13b12020-11-09 17:42:04 +0100665 /* process input files provided as standalone command line arguments,
666 * schema modules are parsed and inserted into the context,
667 * data files are just checked and prepared into internal structures for further processing */
668 ret = fill_context_inputs(argc, argv, c);
669 if (ret) {
670 return ret;
671 }
672
673 /* the second batch of checks */
674 if (c->schema_print_options && !c->schema_out_format) {
675 YLMSG_W("Schema printer options specified, but the schema output format is missing.\n");
676 }
677 if (c->schema_parse_options && !c->schema_modules.count) {
678 YLMSG_W("Schema parser options specified, but no schema input file provided.\n");
679 }
680 if (c->data_print_options && !c->data_out_format) {
681 YLMSG_W("data printer options specified, but the data output format is missing.\n");
682 }
Michal Vasko667ce6b2021-01-25 15:00:27 +0100683 if (((c->data_parse_options != YL_DEFAULT_DATA_PARSE_OPTIONS) || c->data_type) && !c->data_inputs.count) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100684 YLMSG_W("Data parser options specified, but no data input file provided.\n");
685 }
686
687 if (c->schema_node_path) {
688 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 0);
689 if (!c->schema_node) {
690 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 1);
691
692 if (!c->schema_node) {
693 YLMSG_E("Invalid schema path.\n");
694 return -1;
695 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200696 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200697 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100698
Radek Krejcie9f13b12020-11-09 17:42:04 +0100699 return 0;
700}
701
702int
703main_ni(int argc, char *argv[])
704{
705 int ret = EXIT_SUCCESS, r;
706 struct context c = {0};
Radek Krejcied5acc52019-04-25 15:57:04 +0200707
708 /* set callback for printing libyang messages */
709 ly_set_log_clb(libyang_verbclb, 1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100710
711 r = fill_context(argc, argv, &c);
712 if (r < 0) {
713 ret = EXIT_FAILURE;
Radek Krejcied5acc52019-04-25 15:57:04 +0200714 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100715 if (r) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200716 goto cleanup;
717 }
718
Radek Krejcie9f13b12020-11-09 17:42:04 +0100719 /* do the required job - parse, validate, print */
720
721 if (c.list) {
722 /* print the list of schemas */
723 print_list(c.out, c.ctx, c.data_out_format);
Radek Krejci047d64e2020-12-03 12:57:10 +0100724 } else {
725 if (c.schema_out_format) {
726 if (c.schema_node) {
727 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 +0100728 if (ret) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100729 YLMSG_E("Unable to print schema node %s.\n", c.schema_node_path);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100730 goto cleanup;
731 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100732 } else {
733 for (uint32_t u = 0; u < c.schema_modules.count; ++u) {
aPiecek2cfeeae2021-04-21 13:17:34 +0200734 ret = lys_print_module(c.out, (struct lys_module *)c.schema_modules.objs[u], c.schema_out_format,
735 c.line_length, c.schema_print_options);
Radek Krejci047d64e2020-12-03 12:57:10 +0100736 if (ret) {
737 YLMSG_E("Unable to print module %s.\n", ((struct lys_module *)c.schema_modules.objs[u])->name);
738 goto cleanup;
739 }
740 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100741 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200742 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100743
744 /* do the data validation despite the schema was printed */
745 if (c.data_inputs.size) {
746 if (process_data(c.ctx, c.data_type, c.data_merge, c.data_out_format, c.out,
747 c.data_parse_options, c.data_validate_options, c.data_print_options,
Radek Krejci6784a4e2020-12-09 14:23:05 +0100748 &c.data_operational, &c.data_inputs, NULL)) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100749 goto cleanup;
750 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200751 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200752 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200753
754cleanup:
Radek Krejcie9f13b12020-11-09 17:42:04 +0100755 /* cleanup */
756 erase_context(&c);
Radek Krejcied5acc52019-04-25 15:57:04 +0200757
Radek Krejcied5acc52019-04-25 15:57:04 +0200758 return ret;
759}