2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2013 David Chisnall
7 * This software was developed by SRI International and the University of
8 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
9 * ("CTSRD"), as part of the DARPA CRASH research programme.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #include <sys/resource.h>
46 #include "checking.hh"
53 * The current major version of the tool.
55 int version_major = 0;
56 int version_major_compatible = 1;
58 * The current minor version of the tool.
60 int version_minor = 5;
61 int version_minor_compatible = 4;
63 * The current patch level of the tool.
65 int version_patch = 0;
66 int version_patch_compatible = 0;
68 static void usage(const string &argv0)
70 fprintf(stderr, "Usage:\n"
71 "\t%s\t[-fhsv@] [-b boot_cpu_id] [-d dependency_file]"
72 "[-E [no-]checker_name]\n"
73 "\t\t[-H phandle_format] [-I input_format]"
74 "[-O output_format]\n"
75 "\t\t[-o output_file] [-R entries] [-S bytes] [-p bytes]"
77 "\t\t-W [no-]checker_name] input_file\n", basename(argv0).c_str());
81 * Prints the current version of this program..
83 static void version(const char* progname)
85 fprintf(stdout, "Version: %s %d.%d.%d compatible with gpl dtc %d.%d.%d\n", progname,
86 version_major, version_minor, version_patch,
87 version_major_compatible, version_minor_compatible,
88 version_patch_compatible);
91 using fdt::device_tree;
94 main(int argc, char **argv)
97 int outfile = fileno(stdout);
98 const char *outfile_name = "-";
99 const char *in_file = "-";
101 bool debug_mode = false;
102 auto write_fn = &device_tree::write_binary;
103 auto read_fn = &device_tree::parse_dts;
105 bool boot_cpu_specified = false;
106 bool keep_going = false;
108 clock_t c0 = clock();
109 class device_tree tree;
110 fdt::checking::check_manager checks;
111 const char *options = "@hqI:O:o:V:d:R:S:p:b:fi:svH:W:E:DP:";
113 // Don't forget to update the man page if any more options are added.
114 while ((ch = getopt(argc, argv, options)) != -1)
125 tree.write_symbols = true;
132 read_fn = &device_tree::parse_dtb;
134 else if (arg == "dts")
136 read_fn = &device_tree::parse_dts;
140 fprintf(stderr, "Unknown input format: %s\n", optarg);
150 write_fn = &device_tree::write_binary;
152 else if (arg == "asm")
154 write_fn = &device_tree::write_asm;
156 else if (arg == "dts")
158 write_fn = &device_tree::write_dts;
162 fprintf(stderr, "Unknown output format: %s\n", optarg);
169 outfile_name = optarg;
170 outfile = open(optarg, O_CREAT | O_TRUNC | O_WRONLY, 0666);
173 perror("Unable to open output file");
182 if (string(optarg) != "17")
184 fprintf(stderr, "Unknown output format version: %s\n", optarg);
194 if (string(optarg) == "-")
200 depfile = fdopen(open(optarg, O_CREAT | O_TRUNC | O_WRONLY, 0666), "w");
203 perror("Unable to open dependency file");
214 tree.set_phandle_format(device_tree::BOTH);
216 else if (arg == "epapr")
218 tree.set_phandle_format(device_tree::EPAPR);
220 else if (arg == "linux")
222 tree.set_phandle_format(device_tree::LINUX);
226 fprintf(stderr, "Unknown phandle format: %s\n", optarg);
232 // Don't bother to check if strtoll fails, just
233 // use the 0 it returns.
234 boot_cpu = (uint32_t)strtoll(optarg, 0, 10);
235 boot_cpu_specified = true;
244 if ((arg.size() > 3) && (strncmp(optarg, "no-", 3) == 0))
246 arg = string(optarg+3);
247 if (!checks.disable_checker(arg))
249 fprintf(stderr, "Checker %s either does not exist or is already disabled\n", optarg+3);
253 if (!checks.enable_checker(arg))
255 fprintf(stderr, "Checker %s either does not exist or is already enabled\n", optarg);
266 tree.add_include_path(optarg);
269 // Should quiet warnings, but for now is silently ignored.
273 tree.set_empty_reserve_map_entries(strtoll(optarg, 0, 10));
276 tree.set_blob_minimum_size(strtoll(optarg, 0, 10));
279 tree.set_blob_padding(strtoll(optarg, 0, 10));
282 if (!tree.parse_define(optarg))
284 fprintf(stderr, "Invalid predefine value %s\n",
289 fprintf(stderr, "Unknown option %c\n", ch);
295 in_file = argv[optind];
299 fputs(outfile_name, depfile);
300 fputs(": ", depfile);
301 fputs(in_file, depfile);
303 clock_t c1 = clock();
304 (tree.*read_fn)(in_file, depfile);
305 // Override the boot CPU found in the header, if we're loading from dtb
306 if (boot_cpu_specified)
308 tree.set_boot_cpu(boot_cpu);
319 if (!(tree.is_valid() || keep_going))
321 fprintf(stderr, "Failed to parse tree.\n");
324 clock_t c2 = clock();
325 if (!(checks.run_checks(&tree, true) || keep_going))
329 clock_t c3 = clock();
330 (tree.*write_fn)(outfile);
332 clock_t c4 = clock();
338 getrusage(RUSAGE_SELF, &r);
339 fprintf(stderr, "Peak memory usage: %ld bytes\n", r.ru_maxrss);
340 fprintf(stderr, "Setup and option parsing took %f seconds\n",
341 ((double)(c1-c0))/CLOCKS_PER_SEC);
342 fprintf(stderr, "Parsing took %f seconds\n",
343 ((double)(c2-c1))/CLOCKS_PER_SEC);
344 fprintf(stderr, "Checking took %f seconds\n",
345 ((double)(c3-c2))/CLOCKS_PER_SEC);
346 fprintf(stderr, "Generating output took %f seconds\n",
347 ((double)(c4-c3))/CLOCKS_PER_SEC);
348 fprintf(stderr, "Total time: %f seconds\n",
349 ((double)(c4-c0))/CLOCKS_PER_SEC);
350 // This is not needed, but keeps valgrind quiet.