blob: ace7ea0a7a158239e288f7a01ed778c31332b78d [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 Vaskofc5a1d12021-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"
135 " -V, --verbose Show verbose messages, can be used multiple times to\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200136 " increase verbosity.\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100137
Michal Vaskoc40548b2021-09-30 13:05:47 +0200138 printf(" -f FORMAT, --format=FORMAT\n"
139 " Convert input into FORMAT. Supported formats: \n"
140 " yang, yin, tree and info for schemas,\n"
141 " xml, json for data.\n\n");
142
143 printf(" -p PATH, --path=PATH\n"
144 " Search path for schema (YANG/YIN) modules. The option can be\n"
145 " used multiple times. The current working directory and the\n"
146 " path of the module being added is used implicitly.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100147
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200148 printf(" -D, --disable-searchdir\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100149 " Do not implicitly search in current working directory for\n"
150 " schema modules. If specified a second time, do not even\n"
151 " search in the module directory (all modules must be \n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200152 " explicitly specified).\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100153
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200154 printf(" -F FEATURES, --features=FEATURES\n"
Michal Vaskob0d0adf2021-11-22 10:01:34 +0100155 " Specific module features to support in the form <module-name>:(<feature>,)*\n"
156 " Use <feature> '*' to enable all features of a module. This option can be\n"
157 " specified multiple times, to enable features in multiple modules. If this\n"
158 " option is not specified, all the features in all the implemented modules\n"
159 " are enabled.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100160
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200161 printf(" -i, --make-implemented\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100162 " Make the imported modules \"referenced\" from any loaded\n"
163 " module also implemented. If specified a second time, all the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200164 " modules are set implemented.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100165
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200166 printf(" -P PATH, --schema-node=PATH\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100167 " Print only the specified subtree of the schema.\n"
168 " The PATH is the XPath subset mentioned in documentation as\n"
169 " the Path format. The option can be combined with --single-node\n"
170 " option to print information only about the specified node.\n"
171 " -q, --single-node\n"
172 " Supplement to the --schema-node option to print information\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200173 " only about a single node specified as PATH argument.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100174
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200175 printf(" -s SUBMODULE, --submodule=SUBMODULE\n"
176 " Print the specific submodule instead of the main module.\n\n");
177
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200178 printf(" -n, --not-strict\n"
Michal Vasko667ce6b2021-01-25 15:00:27 +0100179 " Do not require strict data parsing (silently skip unknown data),\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200180 " has no effect for schemas.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100181
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200182 printf(" -e, --present Validate only with the schema modules whose data actually\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100183 " exist in the provided input data files. Takes effect only\n"
184 " with the 'data' or 'config' TYPEs. Used to avoid requiring\n"
185 " mandatory nodes from modules which data are not present in the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200186 " provided input data files.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100187
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200188 printf(" -t TYPE, --type=TYPE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100189 " Specify data tree type in the input data file(s):\n"
190 " data - Complete datastore with status data (default type).\n"
191 " config - Configuration datastore (without status data).\n"
192 " get - Result of the NETCONF <get> operation.\n"
193 " getconfig - Result of the NETCONF <get-config> operation.\n"
194 " edit - Content of the NETCONF <edit-config> operation.\n"
195 " rpc - Content of the NETCONF <rpc> message, defined as YANG's\n"
196 " RPC/Action input statement.\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100197 " reply - Reply to the RPC/Action. Note that the reply data are\n"
198 " expected inside a container representing the original\n"
199 " RPC/Action. This is necessary to identify appropriate\n"
200 " data definitions in the schema module.\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100201 " notif - Notification instance (content of the <notification>\n"
Michal Vaskoc40548b2021-09-30 13:05:47 +0200202 " element without <eventTime>).\n\n");
203
204 printf(" -d MODE, --default=MODE\n"
205 " Print data with default values, according to the MODE\n"
206 " (to print attributes, ietf-netconf-with-defaults model\n"
207 " must be loaded):\n"
208 " all - Add missing default nodes.\n"
209 " all-tagged - Add missing default nodes and mark all the default\n"
210 " nodes with the attribute.\n"
211 " trim - Remove all nodes with a default value.\n"
212 " implicit-tagged - Add missing nodes and mark them with the attribute.\n\n");
213
214 printf(" -l, --list Print info about the loaded schemas.\n"
215 " (i - imported module, I - implemented module)\n"
216 " In case the -f option with data encoding is specified,\n"
217 " the list is printed as ietf-yang-library data.\n\n");
218
219 printf(" -L LINE_LENGTH, --tree-line-length=LINE_LENGTH\n"
220 " The limit of the maximum line length on which the 'tree'\n"
221 " format will try to be printed.\n\n");
222
223 printf(" -o OUTFILE, --output=OUTFILE\n"
224 " Write the output to OUTFILE instead of stdout.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100225
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200226 printf(" -O FILE, --operational=FILE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100227 " Provide optional data to extend validation of the 'rpc',\n"
228 " 'reply' or 'notif' TYPEs. The FILE is supposed to contain\n"
229 " the :running configuration datastore and state data\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200230 " (operational datastore) referenced from the RPC/Notification.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100231
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200232 printf(" -m, --merge Merge input data files into a single tree and validate at\n"
233 " once.The option has effect only for 'data' and 'config' TYPEs.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100234
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200235 printf(" -y, --yang-library\n"
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100236 " Load and implement internal \"ietf-yang-library\" YANG module.\n"
237 " Note that this module includes definitions of mandatory state\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200238 " data that can result in unexpected data validation errors.\n\n");
Michal Vaskoc40548b2021-09-30 13:05:47 +0200239
240#ifndef NDEBUG
241 printf(" -G GROUPS, --debug=GROUPS\n"
242 " Enable printing of specific debugging message group\n"
243 " (nothing will be printed unless verbosity is set to debug):\n"
244 " <group>[,<group>]* (dict, xpath)\n\n");
245#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200246}
247
Radek Krejcie9f13b12020-11-09 17:42:04 +0100248static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200249libyang_verbclb(LY_LOG_LEVEL level, const char *msg, const char *path)
250{
251 char *levstr;
252
Radek Krejcie9f13b12020-11-09 17:42:04 +0100253 switch (level) {
254 case LY_LLERR:
255 levstr = "err :";
256 break;
257 case LY_LLWRN:
258 levstr = "warn:";
259 break;
260 case LY_LLVRB:
261 levstr = "verb:";
262 break;
263 default:
264 levstr = "dbg :";
265 break;
266 }
267 if (path) {
268 fprintf(stderr, "libyang %s %s (%s)\n", levstr, msg, path);
269 } else {
270 fprintf(stderr, "libyang %s %s\n", levstr, msg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200271 }
272}
273
Radek Krejcie9f13b12020-11-09 17:42:04 +0100274static int
275fill_context_inputs(int argc, char *argv[], struct context *c)
276{
Radek Krejcif53b0d52020-12-03 11:29:24 +0100277 struct ly_in *in;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100278
279 /* process the operational content if any */
280 if (c->data_operational.path) {
281 if (get_input(c->data_operational.path, NULL, &c->data_operational.format, &c->data_operational.in)) {
282 return -1;
283 }
284 }
285
286 for (int i = 0; i < argc - optind; i++) {
287 LYS_INFORMAT format_schema = LYS_IN_UNKNOWN;
288 LYD_FORMAT format_data = LYD_UNKNOWN;
Radek Krejcif53b0d52020-12-03 11:29:24 +0100289 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100290
291 if (get_input(argv[optind + i], &format_schema, &format_data, &in)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100292 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100293 }
294
295 if (format_schema) {
296 LY_ERR ret;
297 uint8_t path_unset = 1; /* flag to unset the path from the searchpaths list (if not already present) */
298 char *dir, *module;
Michal Vaskob0d0adf2021-11-22 10:01:34 +0100299 const char **features;
Michal Vasko4de7d072021-07-09 09:13:18 +0200300 struct lys_module *mod;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100301
302 if (parse_schema_path(argv[optind + i], &dir, &module)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100303 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100304 }
305
306 /* add temporarily also the path of the module itself */
307 if (ly_ctx_set_searchdir(c->ctx, dir) == LY_EEXIST) {
308 path_unset = 0;
309 }
310
311 /* get features list for this module */
Michal Vasko703370c2021-10-19 14:07:16 +0200312 if (!c->schema_features.count) {
Michal Vaskob0d0adf2021-11-22 10:01:34 +0100313 features = all_features;
314 } else {
315 get_features(&c->schema_features, module, &features);
Michal Vasko703370c2021-10-19 14:07:16 +0200316 }
317
Radek Krejcie9f13b12020-11-09 17:42:04 +0100318 /* temporary cleanup */
319 free(dir);
320 free(module);
321
Michal Vasko703370c2021-10-19 14:07:16 +0200322 /* parse module */
Radek Krejcie9f13b12020-11-09 17:42:04 +0100323 ret = lys_parse(c->ctx, in, format_schema, features, &mod);
324 ly_ctx_unset_searchdir_last(c->ctx, path_unset);
Radek Krejcif53b0d52020-12-03 11:29:24 +0100325 ly_in_free(in, 1);
326 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100327 if (ret) {
328 YLMSG_E("Processing schema module from %s failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100329 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100330 }
331
332 if (c->schema_out_format) {
333 /* modules will be printed */
334 if (ly_set_add(&c->schema_modules, (void *)mod, 1, NULL)) {
335 YLMSG_E("Storing parsed schema module (%s) for print failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100336 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100337 }
338 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100339 } else if (format_data) {
Radek Krejci6784a4e2020-12-09 14:23:05 +0100340 if (!fill_cmdline_file(&c->data_inputs, in, argv[optind + i], format_data)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100341 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100342 }
Radek Krejcif53b0d52020-12-03 11:29:24 +0100343 in = NULL;
Radek Krejci3329b652020-12-05 23:54:07 +0100344 } else {
345 ly_in_free(in, 1);
346 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100347 }
348 }
349
Radek Krejcie9f13b12020-11-09 17:42:04 +0100350 return 0;
Radek Krejcif2afd672020-11-26 12:29:23 +0100351
352error:
353 ly_in_free(in, 1);
354 return -1;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100355}
356
357/**
358 * @brief Process command line options and store the settings into the context.
359 *
360 * return -1 in case of error;
361 * return 0 in case of success and ready to process
362 * return 1 in case of success, but expect to exit.
Radek Krejcied5acc52019-04-25 15:57:04 +0200363 */
364static int
Radek Krejcie9f13b12020-11-09 17:42:04 +0100365fill_context(int argc, char *argv[], struct context *c)
Radek Krejcied5acc52019-04-25 15:57:04 +0200366{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100367 int ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200368
Radek Krejcie9f13b12020-11-09 17:42:04 +0100369 int opt, opt_index;
Radek Krejcied5acc52019-04-25 15:57:04 +0200370 struct option options[] = {
Radek Krejcied5acc52019-04-25 15:57:04 +0200371 {"help", no_argument, NULL, 'h'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200372 {"version", no_argument, NULL, 'v'},
373 {"verbose", no_argument, NULL, 'V'},
374 {"format", required_argument, NULL, 'f'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100375 {"path", required_argument, NULL, 'p'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200376 {"disable-searchdir", no_argument, NULL, 'D'},
377 {"features", required_argument, NULL, 'F'},
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200378 {"make-implemented", no_argument, NULL, 'i'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100379 {"schema-node", required_argument, NULL, 'P'},
Radek Krejcie1f6d5a2019-11-17 14:03:04 +0800380 {"single-node", no_argument, NULL, 'q'},
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200381 {"submodule", required_argument, NULL, 's'},
Michal Vasko667ce6b2021-01-25 15:00:27 +0100382 {"not-strict", no_argument, NULL, 'n'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200383 {"present", no_argument, NULL, 'e'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200384 {"type", required_argument, NULL, 't'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200385 {"default", required_argument, NULL, 'd'},
386 {"list", no_argument, NULL, 'l'},
387 {"tree-line-length", required_argument, NULL, 'L'},
388 {"output", required_argument, NULL, 'o'},
389 {"operational", required_argument, NULL, 'O'},
390 {"merge", no_argument, NULL, 'm'},
391 {"yang-library", no_argument, NULL, 'y'},
392#ifndef NDEBUG
393 {"debug", required_argument, NULL, 'G'},
394#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200395 {NULL, 0, NULL, 0}
396 };
Radek Krejcied5acc52019-04-25 15:57:04 +0200397
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100398 uint16_t options_ctx = YL_DEFAULT_CTX_OPTIONS;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100399 uint8_t data_type_set = 0;
400
Michal Vasko667ce6b2021-01-25 15:00:27 +0100401 c->data_parse_options = YL_DEFAULT_DATA_PARSE_OPTIONS;
aPiecek2cfeeae2021-04-21 13:17:34 +0200402 c->line_length = 0;
Michal Vasko667ce6b2021-01-25 15:00:27 +0100403
Radek Krejcied5acc52019-04-25 15:57:04 +0200404#ifndef NDEBUG
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200405 while ((opt = getopt_long(argc, argv, "hvVf:p:DF:iP:qs:net:d:lL:o:Omy", options, &opt_index)) != -1) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200406#else
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200407 while ((opt = getopt_long(argc, argv, "hvVf:p:DF:iP:qs:net:d:lL:o:OmyG:", options, &opt_index)) != -1) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200408#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200409 switch (opt) {
Michal Vaskoc40548b2021-09-30 13:05:47 +0200410 case 'h': /* --help */
411 help(0);
412 return 1;
413
414 case 'v': /* --version */
415 version();
416 return 1;
417
418 case 'V': { /* --verbose */
419 LY_LOG_LEVEL verbosity = ly_log_level(LY_LLERR);
420 ly_log_level(verbosity);
421
422 if (verbosity < LY_LLDBG) {
423 ly_log_level(verbosity + 1);
Radek Krejcied5acc52019-04-25 15:57:04 +0200424 }
425 break;
Michal Vaskoc40548b2021-09-30 13:05:47 +0200426 } /* case 'V' */
Radek Krejcie9f13b12020-11-09 17:42:04 +0100427
428 case 'f': /* --format */
429 if (!strcasecmp(optarg, "yang")) {
430 c->schema_out_format = LYS_OUT_YANG;
431 c->data_out_format = 0;
432 } else if (!strcasecmp(optarg, "yin")) {
433 c->schema_out_format = LYS_OUT_YIN;
434 c->data_out_format = 0;
435 } else if (!strcasecmp(optarg, "info")) {
436 c->schema_out_format = LYS_OUT_YANG_COMPILED;
437 c->data_out_format = 0;
438 } else if (!strcasecmp(optarg, "tree")) {
439 c->schema_out_format = LYS_OUT_TREE;
440 c->data_out_format = 0;
441 } else if (!strcasecmp(optarg, "xml")) {
442 c->schema_out_format = 0;
443 c->data_out_format = LYD_XML;
444 } else if (!strcasecmp(optarg, "json")) {
445 c->schema_out_format = 0;
446 c->data_out_format = LYD_JSON;
Radek Krejcied5acc52019-04-25 15:57:04 +0200447 } else {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100448 YLMSG_E("Unknown output format %s\n", optarg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200449 help(1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100450 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200451 }
452 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100453
Michal Vaskoc40548b2021-09-30 13:05:47 +0200454 case 'p': { /* --path */
455 struct stat st;
456
457 if (stat(optarg, &st) == -1) {
458 YLMSG_E("Unable to use search path (%s) - %s.\n", optarg, strerror(errno));
459 return -1;
460 }
461 if (!S_ISDIR(st.st_mode)) {
462 YLMSG_E("Provided search path is not a directory.\n");
463 return -1;
464 }
465
466 if (ly_set_add(&c->searchpaths, optarg, 0, NULL)) {
467 YLMSG_E("Storing searchpath failed.\n");
468 return -1;
469 }
470
471 break;
472 } /* case 'p' */
473
474 case 'D': /* --disable-search */
475 if (options_ctx & LY_CTX_DISABLE_SEARCHDIRS) {
476 YLMSG_W("The -D option specified too many times.\n");
477 }
478 if (options_ctx & LY_CTX_DISABLE_SEARCHDIR_CWD) {
479 options_ctx &= ~LY_CTX_DISABLE_SEARCHDIR_CWD;
480 options_ctx |= LY_CTX_DISABLE_SEARCHDIRS;
481 } else {
482 options_ctx |= LY_CTX_DISABLE_SEARCHDIR_CWD;
483 }
484 break;
485
486 case 'F': /* --features */
487 if (parse_features(optarg, &c->schema_features)) {
488 return -1;
489 }
490 break;
491
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200492 case 'i': /* --make-implemented */
Michal Vaskoc40548b2021-09-30 13:05:47 +0200493 if (options_ctx & LY_CTX_REF_IMPLEMENTED) {
494 options_ctx &= ~LY_CTX_REF_IMPLEMENTED;
495 options_ctx |= LY_CTX_ALL_IMPLEMENTED;
496 } else {
497 options_ctx |= LY_CTX_REF_IMPLEMENTED;
498 }
499 break;
500
Radek Krejcie9f13b12020-11-09 17:42:04 +0100501 case 'P': /* --schema-node */
502 c->schema_node_path = optarg;
Radek Krejcied5acc52019-04-25 15:57:04 +0200503 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100504
505 case 'q': /* --single-node */
506 c->schema_print_options |= LYS_PRINT_NO_SUBSTMT;
507 break;
508
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200509 case 's': /* --submodule */
510 c->submodule = optarg;
511 break;
512
Michal Vasko667ce6b2021-01-25 15:00:27 +0100513 case 'n': /* --not-strict */
514 c->data_parse_options &= ~LYD_PARSE_STRICT;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100515 break;
516
517 case 'e': /* --present */
518 c->data_validate_options |= LYD_VALIDATE_PRESENT;
519 break;
520
521 case 't': /* --type */
522 if (data_type_set) {
523 YLMSG_E("The data type (-t) cannot be set multiple times.\n");
524 return -1;
525 }
526
527 if (!strcasecmp(optarg, "config")) {
528 c->data_parse_options |= LYD_PARSE_NO_STATE;
Michal Vaskof6bda332021-02-01 08:59:03 +0100529 c->data_validate_options |= LYD_VALIDATE_NO_STATE;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100530 } else if (!strcasecmp(optarg, "get")) {
531 c->data_parse_options |= LYD_PARSE_ONLY;
532 } else if (!strcasecmp(optarg, "getconfig") || !strcasecmp(optarg, "get-config")) {
533 c->data_parse_options |= LYD_PARSE_ONLY | LYD_PARSE_NO_STATE;
534 } else if (!strcasecmp(optarg, "edit")) {
535 c->data_parse_options |= LYD_PARSE_ONLY;
536 } else if (!strcasecmp(optarg, "rpc") || !strcasecmp(optarg, "action")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100537 c->data_type = LYD_TYPE_RPC_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100538 } else if (!strcasecmp(optarg, "reply") || !strcasecmp(optarg, "rpcreply")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100539 c->data_type = LYD_TYPE_REPLY_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100540 } else if (!strcasecmp(optarg, "notif") || !strcasecmp(optarg, "notification")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100541 c->data_type = LYD_TYPE_NOTIF_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100542 } else if (!strcasecmp(optarg, "data")) {
543 /* default option */
544 } else {
545 YLMSG_E("Unknown data tree type %s\n", optarg);
546 help(1);
547 return -1;
548 }
549
550 data_type_set = 1;
551 break;
552
Michal Vaskoc40548b2021-09-30 13:05:47 +0200553 case 'd': /* --default */
554 if (!strcasecmp(optarg, "all")) {
555 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL;
556 } else if (!strcasecmp(optarg, "all-tagged")) {
557 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL_TAG;
558 } else if (!strcasecmp(optarg, "trim")) {
559 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_TRIM;
560 } else if (!strcasecmp(optarg, "implicit-tagged")) {
561 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_IMPL_TAG;
562 } else {
563 YLMSG_E("Unknown default mode %s\n", optarg);
564 help(1);
565 return -1;
566 }
567 break;
568
569 case 'l': /* --list */
570 c->list = 1;
571 break;
572
573 case 'L': /* --tree-line-length */
574 c->line_length = atoi(optarg);
575 break;
576
577 case 'o': /* --output */
578 if (c->out) {
579 YLMSG_E("Only a single output can be specified.\n");
580 return -1;
581 } else {
582 if (ly_out_new_filepath(optarg, &c->out)) {
583 YLMSG_E("Unable open output file %s (%s)\n", optarg, strerror(errno));
584 return -1;
585 }
586 }
587 break;
588
Radek Krejcie9f13b12020-11-09 17:42:04 +0100589 case 'O': /* --operational */
590 if (c->data_operational.path) {
591 YLMSG_E("The operational datastore (-O) cannot be set multiple times.\n");
592 return -1;
593 }
594 c->data_operational.path = optarg;
595 break;
596
Radek Krejcie9f13b12020-11-09 17:42:04 +0100597 case 'm': /* --merge */
598 c->data_merge = 1;
599 break;
600
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100601 case 'y': /* --yang-library */
602 options_ctx &= ~LY_CTX_NO_YANGLIBRARY;
603 break;
604
Radek Krejcied5acc52019-04-25 15:57:04 +0200605#ifndef NDEBUG
Radek Krejcie9f13b12020-11-09 17:42:04 +0100606 case 'G': { /* --debug */
607 uint32_t dbg_groups = 0;
608 const char *ptr = optarg;
609
Radek Krejcied5acc52019-04-25 15:57:04 +0200610 while (ptr[0]) {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100611 if (!strncasecmp(ptr, "dict", sizeof "dict" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100612 dbg_groups |= LY_LDGDICT;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100613 ptr += sizeof "dict" - 1;
614 } else if (!strncasecmp(ptr, "xpath", sizeof "xpath" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100615 dbg_groups |= LY_LDGXPATH;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100616 ptr += sizeof "xpath" - 1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200617 }
618
619 if (ptr[0]) {
620 if (ptr[0] != ',') {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100621 YLMSG_E("Unknown debug group string \"%s\"\n", optarg);
622 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200623 }
624 ++ptr;
625 }
626 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100627 ly_log_dbg_groups(dbg_groups);
Radek Krejcied5acc52019-04-25 15:57:04 +0200628 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100629 } /* case 'G' */
Radek Krejcied5acc52019-04-25 15:57:04 +0200630#endif
Radek Krejcie9f13b12020-11-09 17:42:04 +0100631 } /* switch */
632 }
633
Michal Vaskob0d0adf2021-11-22 10:01:34 +0100634 /* set imp feature flag if all should be enabled */
635 if (!c->schema_features.count) {
636 options_ctx |= LY_CTX_ENABLE_IMP_FEATURES;
637 }
638
Radek Krejcie9f13b12020-11-09 17:42:04 +0100639 /* libyang context */
640 if (ly_ctx_new(NULL, options_ctx, &c->ctx)) {
641 YLMSG_E("Unable to create libyang context.\n");
642 return -1;
643 }
644 for (uint32_t u = 0; u < c->searchpaths.count; ++u) {
645 ly_ctx_set_searchdir(c->ctx, c->searchpaths.objs[u]);
646 }
647
648 /* additional checks for the options combinations */
649 if (!c->list && (optind >= argc)) {
650 help(1);
651 YLMSG_E("Missing <schema> to process.\n");
652 return 1;
653 }
654
655 if (c->data_merge) {
656 if (c->data_type || (c->data_parse_options & LYD_PARSE_ONLY)) {
657 /* switch off the option, incompatible input data type */
658 c->data_merge = 0;
659 } else {
660 /* postpone validation after the merge of all the input data */
661 c->data_parse_options |= LYD_PARSE_ONLY;
Radek Krejcied5acc52019-04-25 15:57:04 +0200662 }
663 }
664
Radek Krejcie9f13b12020-11-09 17:42:04 +0100665 if (c->data_operational.path && !c->data_type) {
666 YLMSG_E("Operational datastore takes effect only with RPCs/Actions/Replies/Notifications input data types.\n");
667 c->data_operational.path = NULL;
Radek Krejcied5acc52019-04-25 15:57:04 +0200668 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100669
aPiecek2cfeeae2021-04-21 13:17:34 +0200670 if ((c->schema_out_format != LYS_OUT_TREE) && c->line_length) {
671 YLMSG_E("--tree-line-length take effect only in case of the tree output format.\n");
672 }
673
Radek Krejcie9f13b12020-11-09 17:42:04 +0100674 /* default output stream */
675 if (!c->out) {
676 if (ly_out_new_file(stdout, &c->out)) {
677 YLMSG_E("Unable to set stdout as output.\n");
678 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200679 }
680 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100681
aPiecek7ac66d52021-05-20 07:54:07 +0200682 if (c->schema_out_format == LYS_OUT_TREE) {
683 /* print tree from lysc_nodes */
684 ly_ctx_set_options(c->ctx, LY_CTX_SET_PRIV_PARSED);
685 }
686
Radek Krejcie9f13b12020-11-09 17:42:04 +0100687 /* process input files provided as standalone command line arguments,
688 * schema modules are parsed and inserted into the context,
689 * data files are just checked and prepared into internal structures for further processing */
690 ret = fill_context_inputs(argc, argv, c);
691 if (ret) {
692 return ret;
693 }
694
695 /* the second batch of checks */
696 if (c->schema_print_options && !c->schema_out_format) {
697 YLMSG_W("Schema printer options specified, but the schema output format is missing.\n");
698 }
699 if (c->schema_parse_options && !c->schema_modules.count) {
700 YLMSG_W("Schema parser options specified, but no schema input file provided.\n");
701 }
702 if (c->data_print_options && !c->data_out_format) {
703 YLMSG_W("data printer options specified, but the data output format is missing.\n");
704 }
Michal Vasko667ce6b2021-01-25 15:00:27 +0100705 if (((c->data_parse_options != YL_DEFAULT_DATA_PARSE_OPTIONS) || c->data_type) && !c->data_inputs.count) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100706 YLMSG_W("Data parser options specified, but no data input file provided.\n");
707 }
708
709 if (c->schema_node_path) {
710 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 0);
711 if (!c->schema_node) {
712 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 1);
713
714 if (!c->schema_node) {
715 YLMSG_E("Invalid schema path.\n");
716 return -1;
717 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200718 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200719 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100720
Radek Krejcie9f13b12020-11-09 17:42:04 +0100721 return 0;
722}
723
724int
725main_ni(int argc, char *argv[])
726{
727 int ret = EXIT_SUCCESS, r;
728 struct context c = {0};
Radek Krejcied5acc52019-04-25 15:57:04 +0200729
730 /* set callback for printing libyang messages */
731 ly_set_log_clb(libyang_verbclb, 1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100732
733 r = fill_context(argc, argv, &c);
734 if (r < 0) {
735 ret = EXIT_FAILURE;
Radek Krejcied5acc52019-04-25 15:57:04 +0200736 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100737 if (r) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200738 goto cleanup;
739 }
740
Radek Krejcie9f13b12020-11-09 17:42:04 +0100741 /* do the required job - parse, validate, print */
742
743 if (c.list) {
744 /* print the list of schemas */
745 print_list(c.out, c.ctx, c.data_out_format);
Radek Krejci047d64e2020-12-03 12:57:10 +0100746 } else {
747 if (c.schema_out_format) {
748 if (c.schema_node) {
749 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 +0100750 if (ret) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100751 YLMSG_E("Unable to print schema node %s.\n", c.schema_node_path);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100752 goto cleanup;
753 }
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200754 } else if (c.submodule) {
755 const struct lysp_submodule *submod = ly_ctx_get_submodule_latest(c.ctx, c.submodule);
756 if (!submod) {
757 YLMSG_E("Unable to find submodule %s.\n", c.submodule);
758 goto cleanup;
759 }
760
761 ret = lys_print_submodule(c.out, submod, c.schema_out_format, c.line_length, c.schema_print_options);
762 if (ret) {
763 YLMSG_E("Unable to print submodule %s.\n", submod->name);
764 goto cleanup;
765 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100766 } else {
767 for (uint32_t u = 0; u < c.schema_modules.count; ++u) {
aPiecek2cfeeae2021-04-21 13:17:34 +0200768 ret = lys_print_module(c.out, (struct lys_module *)c.schema_modules.objs[u], c.schema_out_format,
769 c.line_length, c.schema_print_options);
aPiecek8f0b7882021-05-21 10:18:36 +0200770 /* for YANG Tree Diagrams printing it's more readable to print a blank line between modules. */
771 if ((c.schema_out_format == LYS_OUT_TREE) && (u + 1 < c.schema_modules.count)) {
772 ly_print(c.out, "\n");
773 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100774 if (ret) {
775 YLMSG_E("Unable to print module %s.\n", ((struct lys_module *)c.schema_modules.objs[u])->name);
776 goto cleanup;
777 }
778 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100779 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200780 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100781
782 /* do the data validation despite the schema was printed */
783 if (c.data_inputs.size) {
784 if (process_data(c.ctx, c.data_type, c.data_merge, c.data_out_format, c.out,
785 c.data_parse_options, c.data_validate_options, c.data_print_options,
Radek Krejci6784a4e2020-12-09 14:23:05 +0100786 &c.data_operational, &c.data_inputs, NULL)) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100787 goto cleanup;
788 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200789 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200790 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200791
792cleanup:
Radek Krejcie9f13b12020-11-09 17:42:04 +0100793 /* cleanup */
794 erase_context(&c);
Radek Krejcied5acc52019-04-25 15:57:04 +0200795
Radek Krejcied5acc52019-04-25 15:57:04 +0200796 return ret;
797}