blob: 8941f184e7094f9298de808d0ebf8115c16084f0 [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 Vasko703370c2021-10-19 14:07:16 +0200155 " Features to support, default all in all implemented modules.\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200156 " <modname>:[<feature>,]*\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100157
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200158 printf(" -i, --make-implemented\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100159 " Make the imported modules \"referenced\" from any loaded\n"
160 " module also implemented. If specified a second time, all the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200161 " modules are set implemented.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100162
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200163 printf(" -P PATH, --schema-node=PATH\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100164 " Print only the specified subtree of the schema.\n"
165 " The PATH is the XPath subset mentioned in documentation as\n"
166 " the Path format. The option can be combined with --single-node\n"
167 " option to print information only about the specified node.\n"
168 " -q, --single-node\n"
169 " Supplement to the --schema-node option to print information\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200170 " only about a single node specified as PATH argument.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100171
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200172 printf(" -s SUBMODULE, --submodule=SUBMODULE\n"
173 " Print the specific submodule instead of the main module.\n\n");
174
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200175 printf(" -n, --not-strict\n"
Michal Vasko667ce6b2021-01-25 15:00:27 +0100176 " Do not require strict data parsing (silently skip unknown data),\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200177 " has no effect for schemas.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100178
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200179 printf(" -e, --present Validate only with the schema modules whose data actually\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100180 " exist in the provided input data files. Takes effect only\n"
181 " with the 'data' or 'config' TYPEs. Used to avoid requiring\n"
182 " mandatory nodes from modules which data are not present in the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200183 " provided input data files.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100184
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200185 printf(" -t TYPE, --type=TYPE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100186 " Specify data tree type in the input data file(s):\n"
187 " data - Complete datastore with status data (default type).\n"
188 " config - Configuration datastore (without status data).\n"
189 " get - Result of the NETCONF <get> operation.\n"
190 " getconfig - Result of the NETCONF <get-config> operation.\n"
191 " edit - Content of the NETCONF <edit-config> operation.\n"
192 " rpc - Content of the NETCONF <rpc> message, defined as YANG's\n"
193 " RPC/Action input statement.\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100194 " reply - Reply to the RPC/Action. Note that the reply data are\n"
195 " expected inside a container representing the original\n"
196 " RPC/Action. This is necessary to identify appropriate\n"
197 " data definitions in the schema module.\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100198 " notif - Notification instance (content of the <notification>\n"
Michal Vaskoc40548b2021-09-30 13:05:47 +0200199 " element without <eventTime>).\n\n");
200
201 printf(" -d MODE, --default=MODE\n"
202 " Print data with default values, according to the MODE\n"
203 " (to print attributes, ietf-netconf-with-defaults model\n"
204 " must be loaded):\n"
205 " all - Add missing default nodes.\n"
206 " all-tagged - Add missing default nodes and mark all the default\n"
207 " nodes with the attribute.\n"
208 " trim - Remove all nodes with a default value.\n"
209 " implicit-tagged - Add missing nodes and mark them with the attribute.\n\n");
210
211 printf(" -l, --list Print info about the loaded schemas.\n"
212 " (i - imported module, I - implemented module)\n"
213 " In case the -f option with data encoding is specified,\n"
214 " the list is printed as ietf-yang-library data.\n\n");
215
216 printf(" -L LINE_LENGTH, --tree-line-length=LINE_LENGTH\n"
217 " The limit of the maximum line length on which the 'tree'\n"
218 " format will try to be printed.\n\n");
219
220 printf(" -o OUTFILE, --output=OUTFILE\n"
221 " Write the output to OUTFILE instead of stdout.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100222
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200223 printf(" -O FILE, --operational=FILE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100224 " Provide optional data to extend validation of the 'rpc',\n"
225 " 'reply' or 'notif' TYPEs. The FILE is supposed to contain\n"
226 " the :running configuration datastore and state data\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200227 " (operational datastore) referenced from the RPC/Notification.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100228
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200229 printf(" -m, --merge Merge input data files into a single tree and validate at\n"
230 " once.The option has effect only for 'data' and 'config' TYPEs.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100231
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200232 printf(" -y, --yang-library\n"
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100233 " Load and implement internal \"ietf-yang-library\" YANG module.\n"
234 " Note that this module includes definitions of mandatory state\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200235 " data that can result in unexpected data validation errors.\n\n");
Michal Vaskoc40548b2021-09-30 13:05:47 +0200236
237#ifndef NDEBUG
238 printf(" -G GROUPS, --debug=GROUPS\n"
239 " Enable printing of specific debugging message group\n"
240 " (nothing will be printed unless verbosity is set to debug):\n"
241 " <group>[,<group>]* (dict, xpath)\n\n");
242#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200243}
244
Radek Krejcie9f13b12020-11-09 17:42:04 +0100245static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200246libyang_verbclb(LY_LOG_LEVEL level, const char *msg, const char *path)
247{
248 char *levstr;
249
Radek Krejcie9f13b12020-11-09 17:42:04 +0100250 switch (level) {
251 case LY_LLERR:
252 levstr = "err :";
253 break;
254 case LY_LLWRN:
255 levstr = "warn:";
256 break;
257 case LY_LLVRB:
258 levstr = "verb:";
259 break;
260 default:
261 levstr = "dbg :";
262 break;
263 }
264 if (path) {
265 fprintf(stderr, "libyang %s %s (%s)\n", levstr, msg, path);
266 } else {
267 fprintf(stderr, "libyang %s %s\n", levstr, msg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200268 }
269}
270
Radek Krejcie9f13b12020-11-09 17:42:04 +0100271static int
272fill_context_inputs(int argc, char *argv[], struct context *c)
273{
Radek Krejcif53b0d52020-12-03 11:29:24 +0100274 struct ly_in *in;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100275
276 /* process the operational content if any */
277 if (c->data_operational.path) {
278 if (get_input(c->data_operational.path, NULL, &c->data_operational.format, &c->data_operational.in)) {
279 return -1;
280 }
281 }
282
283 for (int i = 0; i < argc - optind; i++) {
284 LYS_INFORMAT format_schema = LYS_IN_UNKNOWN;
285 LYD_FORMAT format_data = LYD_UNKNOWN;
Radek Krejcif53b0d52020-12-03 11:29:24 +0100286 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100287
288 if (get_input(argv[optind + i], &format_schema, &format_data, &in)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100289 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100290 }
291
292 if (format_schema) {
293 LY_ERR ret;
294 uint8_t path_unset = 1; /* flag to unset the path from the searchpaths list (if not already present) */
295 char *dir, *module;
Michal Vasko0083c7b2021-10-19 12:11:48 +0200296 const char **features = NULL;
Michal Vasko703370c2021-10-19 14:07:16 +0200297 uint16_t ctx_opts = 0;
Michal Vasko4de7d072021-07-09 09:13:18 +0200298 struct lys_module *mod;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100299
300 if (parse_schema_path(argv[optind + i], &dir, &module)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100301 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100302 }
303
304 /* add temporarily also the path of the module itself */
305 if (ly_ctx_set_searchdir(c->ctx, dir) == LY_EEXIST) {
306 path_unset = 0;
307 }
308
309 /* get features list for this module */
310 get_features(&c->schema_features, module, &features);
311
Michal Vasko703370c2021-10-19 14:07:16 +0200312 /* set imp feature flag if all should be enabled */
313 if (!c->schema_features.count) {
314 ctx_opts = LY_CTX_ENABLE_IMP_FEATURES;
315 ly_ctx_set_options(c->ctx, ctx_opts);
316 }
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);
Michal Vasko703370c2021-10-19 14:07:16 +0200325 ly_ctx_unset_options(c->ctx, ctx_opts);
Radek Krejcif53b0d52020-12-03 11:29:24 +0100326 ly_in_free(in, 1);
327 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100328 if (ret) {
329 YLMSG_E("Processing schema module from %s failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100330 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100331 }
332
333 if (c->schema_out_format) {
334 /* modules will be printed */
335 if (ly_set_add(&c->schema_modules, (void *)mod, 1, NULL)) {
336 YLMSG_E("Storing parsed schema module (%s) for print failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100337 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100338 }
339 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100340 } else if (format_data) {
Radek Krejci6784a4e2020-12-09 14:23:05 +0100341 if (!fill_cmdline_file(&c->data_inputs, in, argv[optind + i], format_data)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100342 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100343 }
Radek Krejcif53b0d52020-12-03 11:29:24 +0100344 in = NULL;
Radek Krejci3329b652020-12-05 23:54:07 +0100345 } else {
346 ly_in_free(in, 1);
347 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100348 }
349 }
350
Radek Krejcie9f13b12020-11-09 17:42:04 +0100351 return 0;
Radek Krejcif2afd672020-11-26 12:29:23 +0100352
353error:
354 ly_in_free(in, 1);
355 return -1;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100356}
357
358/**
359 * @brief Process command line options and store the settings into the context.
360 *
361 * return -1 in case of error;
362 * return 0 in case of success and ready to process
363 * return 1 in case of success, but expect to exit.
Radek Krejcied5acc52019-04-25 15:57:04 +0200364 */
365static int
Radek Krejcie9f13b12020-11-09 17:42:04 +0100366fill_context(int argc, char *argv[], struct context *c)
Radek Krejcied5acc52019-04-25 15:57:04 +0200367{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100368 int ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200369
Radek Krejcie9f13b12020-11-09 17:42:04 +0100370 int opt, opt_index;
Radek Krejcied5acc52019-04-25 15:57:04 +0200371 struct option options[] = {
Radek Krejcied5acc52019-04-25 15:57:04 +0200372 {"help", no_argument, NULL, 'h'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200373 {"version", no_argument, NULL, 'v'},
374 {"verbose", no_argument, NULL, 'V'},
375 {"format", required_argument, NULL, 'f'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100376 {"path", required_argument, NULL, 'p'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200377 {"disable-searchdir", no_argument, NULL, 'D'},
378 {"features", required_argument, NULL, 'F'},
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200379 {"make-implemented", no_argument, NULL, 'i'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100380 {"schema-node", required_argument, NULL, 'P'},
Radek Krejcie1f6d5a2019-11-17 14:03:04 +0800381 {"single-node", no_argument, NULL, 'q'},
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200382 {"submodule", required_argument, NULL, 's'},
Michal Vasko667ce6b2021-01-25 15:00:27 +0100383 {"not-strict", no_argument, NULL, 'n'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200384 {"present", no_argument, NULL, 'e'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200385 {"type", required_argument, NULL, 't'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200386 {"default", required_argument, NULL, 'd'},
387 {"list", no_argument, NULL, 'l'},
388 {"tree-line-length", required_argument, NULL, 'L'},
389 {"output", required_argument, NULL, 'o'},
390 {"operational", required_argument, NULL, 'O'},
391 {"merge", no_argument, NULL, 'm'},
392 {"yang-library", no_argument, NULL, 'y'},
393#ifndef NDEBUG
394 {"debug", required_argument, NULL, 'G'},
395#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200396 {NULL, 0, NULL, 0}
397 };
Radek Krejcied5acc52019-04-25 15:57:04 +0200398
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100399 uint16_t options_ctx = YL_DEFAULT_CTX_OPTIONS;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100400 uint8_t data_type_set = 0;
401
Michal Vasko667ce6b2021-01-25 15:00:27 +0100402 c->data_parse_options = YL_DEFAULT_DATA_PARSE_OPTIONS;
aPiecek2cfeeae2021-04-21 13:17:34 +0200403 c->line_length = 0;
Michal Vasko667ce6b2021-01-25 15:00:27 +0100404
Radek Krejcied5acc52019-04-25 15:57:04 +0200405#ifndef NDEBUG
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200406 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 +0200407#else
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200408 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 +0200409#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200410 switch (opt) {
Michal Vaskoc40548b2021-09-30 13:05:47 +0200411 case 'h': /* --help */
412 help(0);
413 return 1;
414
415 case 'v': /* --version */
416 version();
417 return 1;
418
419 case 'V': { /* --verbose */
420 LY_LOG_LEVEL verbosity = ly_log_level(LY_LLERR);
421 ly_log_level(verbosity);
422
423 if (verbosity < LY_LLDBG) {
424 ly_log_level(verbosity + 1);
Radek Krejcied5acc52019-04-25 15:57:04 +0200425 }
426 break;
Michal Vaskoc40548b2021-09-30 13:05:47 +0200427 } /* case 'V' */
Radek Krejcie9f13b12020-11-09 17:42:04 +0100428
429 case 'f': /* --format */
430 if (!strcasecmp(optarg, "yang")) {
431 c->schema_out_format = LYS_OUT_YANG;
432 c->data_out_format = 0;
433 } else if (!strcasecmp(optarg, "yin")) {
434 c->schema_out_format = LYS_OUT_YIN;
435 c->data_out_format = 0;
436 } else if (!strcasecmp(optarg, "info")) {
437 c->schema_out_format = LYS_OUT_YANG_COMPILED;
438 c->data_out_format = 0;
439 } else if (!strcasecmp(optarg, "tree")) {
440 c->schema_out_format = LYS_OUT_TREE;
441 c->data_out_format = 0;
442 } else if (!strcasecmp(optarg, "xml")) {
443 c->schema_out_format = 0;
444 c->data_out_format = LYD_XML;
445 } else if (!strcasecmp(optarg, "json")) {
446 c->schema_out_format = 0;
447 c->data_out_format = LYD_JSON;
Radek Krejcied5acc52019-04-25 15:57:04 +0200448 } else {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100449 YLMSG_E("Unknown output format %s\n", optarg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200450 help(1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100451 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200452 }
453 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100454
Michal Vaskoc40548b2021-09-30 13:05:47 +0200455 case 'p': { /* --path */
456 struct stat st;
457
458 if (stat(optarg, &st) == -1) {
459 YLMSG_E("Unable to use search path (%s) - %s.\n", optarg, strerror(errno));
460 return -1;
461 }
462 if (!S_ISDIR(st.st_mode)) {
463 YLMSG_E("Provided search path is not a directory.\n");
464 return -1;
465 }
466
467 if (ly_set_add(&c->searchpaths, optarg, 0, NULL)) {
468 YLMSG_E("Storing searchpath failed.\n");
469 return -1;
470 }
471
472 break;
473 } /* case 'p' */
474
475 case 'D': /* --disable-search */
476 if (options_ctx & LY_CTX_DISABLE_SEARCHDIRS) {
477 YLMSG_W("The -D option specified too many times.\n");
478 }
479 if (options_ctx & LY_CTX_DISABLE_SEARCHDIR_CWD) {
480 options_ctx &= ~LY_CTX_DISABLE_SEARCHDIR_CWD;
481 options_ctx |= LY_CTX_DISABLE_SEARCHDIRS;
482 } else {
483 options_ctx |= LY_CTX_DISABLE_SEARCHDIR_CWD;
484 }
485 break;
486
487 case 'F': /* --features */
488 if (parse_features(optarg, &c->schema_features)) {
489 return -1;
490 }
491 break;
492
Michal Vasko8d6d0ad2021-10-19 12:32:27 +0200493 case 'i': /* --make-implemented */
Michal Vaskoc40548b2021-09-30 13:05:47 +0200494 if (options_ctx & LY_CTX_REF_IMPLEMENTED) {
495 options_ctx &= ~LY_CTX_REF_IMPLEMENTED;
496 options_ctx |= LY_CTX_ALL_IMPLEMENTED;
497 } else {
498 options_ctx |= LY_CTX_REF_IMPLEMENTED;
499 }
500 break;
501
Radek Krejcie9f13b12020-11-09 17:42:04 +0100502 case 'P': /* --schema-node */
503 c->schema_node_path = optarg;
Radek Krejcied5acc52019-04-25 15:57:04 +0200504 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100505
506 case 'q': /* --single-node */
507 c->schema_print_options |= LYS_PRINT_NO_SUBSTMT;
508 break;
509
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200510 case 's': /* --submodule */
511 c->submodule = optarg;
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
Michal Vaskoc40548b2021-09-30 13:05:47 +0200554 case 'd': /* --default */
555 if (!strcasecmp(optarg, "all")) {
556 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL;
557 } else if (!strcasecmp(optarg, "all-tagged")) {
558 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL_TAG;
559 } else if (!strcasecmp(optarg, "trim")) {
560 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_TRIM;
561 } else if (!strcasecmp(optarg, "implicit-tagged")) {
562 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_IMPL_TAG;
563 } else {
564 YLMSG_E("Unknown default mode %s\n", optarg);
565 help(1);
566 return -1;
567 }
568 break;
569
570 case 'l': /* --list */
571 c->list = 1;
572 break;
573
574 case 'L': /* --tree-line-length */
575 c->line_length = atoi(optarg);
576 break;
577
578 case 'o': /* --output */
579 if (c->out) {
580 YLMSG_E("Only a single output can be specified.\n");
581 return -1;
582 } else {
583 if (ly_out_new_filepath(optarg, &c->out)) {
584 YLMSG_E("Unable open output file %s (%s)\n", optarg, strerror(errno));
585 return -1;
586 }
587 }
588 break;
589
Radek Krejcie9f13b12020-11-09 17:42:04 +0100590 case 'O': /* --operational */
591 if (c->data_operational.path) {
592 YLMSG_E("The operational datastore (-O) cannot be set multiple times.\n");
593 return -1;
594 }
595 c->data_operational.path = optarg;
596 break;
597
Radek Krejcie9f13b12020-11-09 17:42:04 +0100598 case 'm': /* --merge */
599 c->data_merge = 1;
600 break;
601
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100602 case 'y': /* --yang-library */
603 options_ctx &= ~LY_CTX_NO_YANGLIBRARY;
604 break;
605
Radek Krejcied5acc52019-04-25 15:57:04 +0200606#ifndef NDEBUG
Radek Krejcie9f13b12020-11-09 17:42:04 +0100607 case 'G': { /* --debug */
608 uint32_t dbg_groups = 0;
609 const char *ptr = optarg;
610
Radek Krejcied5acc52019-04-25 15:57:04 +0200611 while (ptr[0]) {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100612 if (!strncasecmp(ptr, "dict", sizeof "dict" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100613 dbg_groups |= LY_LDGDICT;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100614 ptr += sizeof "dict" - 1;
615 } else if (!strncasecmp(ptr, "xpath", sizeof "xpath" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100616 dbg_groups |= LY_LDGXPATH;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100617 ptr += sizeof "xpath" - 1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200618 }
619
620 if (ptr[0]) {
621 if (ptr[0] != ',') {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100622 YLMSG_E("Unknown debug group string \"%s\"\n", optarg);
623 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200624 }
625 ++ptr;
626 }
627 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100628 ly_log_dbg_groups(dbg_groups);
Radek Krejcied5acc52019-04-25 15:57:04 +0200629 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100630 } /* case 'G' */
Radek Krejcied5acc52019-04-25 15:57:04 +0200631#endif
Radek Krejcie9f13b12020-11-09 17:42:04 +0100632 } /* switch */
633 }
634
635 /* libyang context */
636 if (ly_ctx_new(NULL, options_ctx, &c->ctx)) {
637 YLMSG_E("Unable to create libyang context.\n");
638 return -1;
639 }
640 for (uint32_t u = 0; u < c->searchpaths.count; ++u) {
641 ly_ctx_set_searchdir(c->ctx, c->searchpaths.objs[u]);
642 }
643
644 /* additional checks for the options combinations */
645 if (!c->list && (optind >= argc)) {
646 help(1);
647 YLMSG_E("Missing <schema> to process.\n");
648 return 1;
649 }
650
651 if (c->data_merge) {
652 if (c->data_type || (c->data_parse_options & LYD_PARSE_ONLY)) {
653 /* switch off the option, incompatible input data type */
654 c->data_merge = 0;
655 } else {
656 /* postpone validation after the merge of all the input data */
657 c->data_parse_options |= LYD_PARSE_ONLY;
Radek Krejcied5acc52019-04-25 15:57:04 +0200658 }
659 }
660
Radek Krejcie9f13b12020-11-09 17:42:04 +0100661 if (c->data_operational.path && !c->data_type) {
662 YLMSG_E("Operational datastore takes effect only with RPCs/Actions/Replies/Notifications input data types.\n");
663 c->data_operational.path = NULL;
Radek Krejcied5acc52019-04-25 15:57:04 +0200664 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100665
aPiecek2cfeeae2021-04-21 13:17:34 +0200666 if ((c->schema_out_format != LYS_OUT_TREE) && c->line_length) {
667 YLMSG_E("--tree-line-length take effect only in case of the tree output format.\n");
668 }
669
Radek Krejcie9f13b12020-11-09 17:42:04 +0100670 /* default output stream */
671 if (!c->out) {
672 if (ly_out_new_file(stdout, &c->out)) {
673 YLMSG_E("Unable to set stdout as output.\n");
674 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200675 }
676 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100677
aPiecek7ac66d52021-05-20 07:54:07 +0200678 if (c->schema_out_format == LYS_OUT_TREE) {
679 /* print tree from lysc_nodes */
680 ly_ctx_set_options(c->ctx, LY_CTX_SET_PRIV_PARSED);
681 }
682
Radek Krejcie9f13b12020-11-09 17:42:04 +0100683 /* process input files provided as standalone command line arguments,
684 * schema modules are parsed and inserted into the context,
685 * data files are just checked and prepared into internal structures for further processing */
686 ret = fill_context_inputs(argc, argv, c);
687 if (ret) {
688 return ret;
689 }
690
691 /* the second batch of checks */
692 if (c->schema_print_options && !c->schema_out_format) {
693 YLMSG_W("Schema printer options specified, but the schema output format is missing.\n");
694 }
695 if (c->schema_parse_options && !c->schema_modules.count) {
696 YLMSG_W("Schema parser options specified, but no schema input file provided.\n");
697 }
698 if (c->data_print_options && !c->data_out_format) {
699 YLMSG_W("data printer options specified, but the data output format is missing.\n");
700 }
Michal Vasko667ce6b2021-01-25 15:00:27 +0100701 if (((c->data_parse_options != YL_DEFAULT_DATA_PARSE_OPTIONS) || c->data_type) && !c->data_inputs.count) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100702 YLMSG_W("Data parser options specified, but no data input file provided.\n");
703 }
704
705 if (c->schema_node_path) {
706 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 0);
707 if (!c->schema_node) {
708 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 1);
709
710 if (!c->schema_node) {
711 YLMSG_E("Invalid schema path.\n");
712 return -1;
713 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200714 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200715 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100716
Radek Krejcie9f13b12020-11-09 17:42:04 +0100717 return 0;
718}
719
720int
721main_ni(int argc, char *argv[])
722{
723 int ret = EXIT_SUCCESS, r;
724 struct context c = {0};
Radek Krejcied5acc52019-04-25 15:57:04 +0200725
726 /* set callback for printing libyang messages */
727 ly_set_log_clb(libyang_verbclb, 1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100728
729 r = fill_context(argc, argv, &c);
730 if (r < 0) {
731 ret = EXIT_FAILURE;
Radek Krejcied5acc52019-04-25 15:57:04 +0200732 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100733 if (r) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200734 goto cleanup;
735 }
736
Radek Krejcie9f13b12020-11-09 17:42:04 +0100737 /* do the required job - parse, validate, print */
738
739 if (c.list) {
740 /* print the list of schemas */
741 print_list(c.out, c.ctx, c.data_out_format);
Radek Krejci047d64e2020-12-03 12:57:10 +0100742 } else {
743 if (c.schema_out_format) {
744 if (c.schema_node) {
745 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 +0100746 if (ret) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100747 YLMSG_E("Unable to print schema node %s.\n", c.schema_node_path);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100748 goto cleanup;
749 }
Michal Vaskofe74d1e2021-09-30 13:17:36 +0200750 } else if (c.submodule) {
751 const struct lysp_submodule *submod = ly_ctx_get_submodule_latest(c.ctx, c.submodule);
752 if (!submod) {
753 YLMSG_E("Unable to find submodule %s.\n", c.submodule);
754 goto cleanup;
755 }
756
757 ret = lys_print_submodule(c.out, submod, c.schema_out_format, c.line_length, c.schema_print_options);
758 if (ret) {
759 YLMSG_E("Unable to print submodule %s.\n", submod->name);
760 goto cleanup;
761 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100762 } else {
763 for (uint32_t u = 0; u < c.schema_modules.count; ++u) {
aPiecek2cfeeae2021-04-21 13:17:34 +0200764 ret = lys_print_module(c.out, (struct lys_module *)c.schema_modules.objs[u], c.schema_out_format,
765 c.line_length, c.schema_print_options);
aPiecek8f0b7882021-05-21 10:18:36 +0200766 /* for YANG Tree Diagrams printing it's more readable to print a blank line between modules. */
767 if ((c.schema_out_format == LYS_OUT_TREE) && (u + 1 < c.schema_modules.count)) {
768 ly_print(c.out, "\n");
769 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100770 if (ret) {
771 YLMSG_E("Unable to print module %s.\n", ((struct lys_module *)c.schema_modules.objs[u])->name);
772 goto cleanup;
773 }
774 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100775 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200776 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100777
778 /* do the data validation despite the schema was printed */
779 if (c.data_inputs.size) {
780 if (process_data(c.ctx, c.data_type, c.data_merge, c.data_out_format, c.out,
781 c.data_parse_options, c.data_validate_options, c.data_print_options,
Radek Krejci6784a4e2020-12-09 14:23:05 +0100782 &c.data_operational, &c.data_inputs, NULL)) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100783 goto cleanup;
784 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200785 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200786 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200787
788cleanup:
Radek Krejcie9f13b12020-11-09 17:42:04 +0100789 /* cleanup */
790 erase_context(&c);
Radek Krejcied5acc52019-04-25 15:57:04 +0200791
Radek Krejcied5acc52019-04-25 15:57:04 +0200792 return ret;
793}