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>
47 #include "checking.hh"
56 * The current major version of the tool.
58 int version_major = 0;
59 int version_major_compatible = 1;
61 * The current minor version of the tool.
63 int version_minor = 5;
64 int version_minor_compatible = 4;
66 * The current patch level of the tool.
68 int version_patch = 0;
69 int version_patch_compatible = 7;
71 void usage(const string &argv0)
73 fprintf(stderr, "Usage:\n"
74 "\t%s\t[-fhsv@] [-b boot_cpu_id] [-d dependency_file]"
75 "[-E [no-]checker_name]\n"
76 "\t\t[-H phandle_format] [-I input_format]"
77 "[-O output_format]\n"
78 "\t\t[-o output_file] [-R entries] [-S bytes] [-p bytes]"
80 "\t\t-W [no-]checker_name] input_file\n", basename(argv0).c_str());
84 * Prints the current version of this program..
86 void version(const char* progname)
88 fprintf(stdout, "Version: %s %d.%d.%d compatible with gpl dtc %d.%d.%d\n", progname,
89 version_major, version_minor, version_patch,
90 version_major_compatible, version_minor_compatible,
91 version_patch_compatible);
94 } // Anonymous namespace
96 using fdt::device_tree;
97 using fdt::tree_write_fn_ptr;
98 using fdt::tree_read_fn_ptr;
101 main(int argc, char **argv)
104 int outfile = fileno(stdout);
105 const char *outfile_name = "-";
106 const char *in_file = "-";
108 bool debug_mode = false;
109 tree_write_fn_ptr write_fn = nullptr;
110 tree_read_fn_ptr read_fn = nullptr;
111 uint32_t boot_cpu = 0;
112 bool boot_cpu_specified = false;
113 bool keep_going = false;
115 clock_t c0 = clock();
116 class device_tree tree;
117 fdt::checking::check_manager checks;
118 const char *options = "@hqI:O:o:V:d:R:S:p:b:fi:svH:W:E:DP:";
120 // Don't forget to update the man page if any more options are added.
121 while ((ch = getopt(argc, argv, options)) != -1)
132 tree.write_symbols = true;
139 read_fn = &device_tree::parse_dtb;
140 if (write_fn == nullptr)
142 write_fn = &device_tree::write_dts;
145 else if (arg == "dts")
147 read_fn = &device_tree::parse_dts;
151 fprintf(stderr, "Unknown input format: %s\n", optarg);
161 write_fn = &device_tree::write_binary;
163 else if (arg == "asm")
165 write_fn = &device_tree::write_asm;
167 else if (arg == "dts")
169 write_fn = &device_tree::write_dts;
170 if (read_fn == nullptr)
172 read_fn = &device_tree::parse_dtb;
177 fprintf(stderr, "Unknown output format: %s\n", optarg);
184 outfile_name = optarg;
185 if (strcmp(outfile_name, "-") != 0)
187 outfile = open(optarg, O_CREAT | O_TRUNC | O_WRONLY, 0666);
190 perror("Unable to open output file");
200 if (string(optarg) != "17")
202 fprintf(stderr, "Unknown output format version: %s\n", optarg);
212 if (string(optarg) == "-")
218 depfile = fdopen(open(optarg, O_CREAT | O_TRUNC | O_WRONLY, 0666), "w");
221 perror("Unable to open dependency file");
232 tree.set_phandle_format(device_tree::BOTH);
234 else if (arg == "epapr")
236 tree.set_phandle_format(device_tree::EPAPR);
238 else if (arg == "linux")
240 tree.set_phandle_format(device_tree::LINUX);
244 fprintf(stderr, "Unknown phandle format: %s\n", optarg);
250 // Don't bother to check if strtoll fails, just
251 // use the 0 it returns.
252 boot_cpu = (uint32_t)strtoll(optarg, 0, 10);
253 boot_cpu_specified = true;
262 if ((arg.size() > 3) && (strncmp(optarg, "no-", 3) == 0))
264 arg = string(optarg+3);
265 if (!checks.disable_checker(arg))
267 fprintf(stderr, "Checker %s either does not exist or is already disabled\n", optarg+3);
271 if (!checks.enable_checker(arg))
273 fprintf(stderr, "Checker %s either does not exist or is already enabled\n", optarg);
284 tree.add_include_path(optarg);
287 // Should quiet warnings, but for now is silently ignored.
291 tree.set_empty_reserve_map_entries(strtoll(optarg, 0, 10));
294 tree.set_blob_minimum_size(strtoll(optarg, 0, 10));
297 tree.set_blob_padding(strtoll(optarg, 0, 10));
300 if (!tree.parse_define(optarg))
302 fprintf(stderr, "Invalid predefine value %s\n",
308 * Since opterr is non-zero, getopt will have
309 * already printed an error message.
314 if (read_fn == nullptr)
316 read_fn = &device_tree::parse_dts;
318 if (write_fn == nullptr)
320 write_fn = &device_tree::write_binary;
324 in_file = argv[optind];
328 fputs(outfile_name, depfile);
329 fputs(": ", depfile);
330 fputs(in_file, depfile);
332 clock_t c1 = clock();
333 (tree.*read_fn)(in_file, depfile);
334 // Override the boot CPU found in the header, if we're loading from dtb
335 if (boot_cpu_specified)
337 tree.set_boot_cpu(boot_cpu);
348 if (!(tree.is_valid() || keep_going))
350 fprintf(stderr, "Failed to parse tree.\n");
353 clock_t c2 = clock();
354 if (!(checks.run_checks(&tree, true) || keep_going))
358 clock_t c3 = clock();
359 (tree.*write_fn)(outfile);
361 clock_t c4 = clock();
367 getrusage(RUSAGE_SELF, &r);
368 fprintf(stderr, "Peak memory usage: %ld bytes\n", r.ru_maxrss);
369 fprintf(stderr, "Setup and option parsing took %f seconds\n",
370 ((double)(c1-c0))/CLOCKS_PER_SEC);
371 fprintf(stderr, "Parsing took %f seconds\n",
372 ((double)(c2-c1))/CLOCKS_PER_SEC);
373 fprintf(stderr, "Checking took %f seconds\n",
374 ((double)(c3-c2))/CLOCKS_PER_SEC);
375 fprintf(stderr, "Generating output took %f seconds\n",
376 ((double)(c4-c3))/CLOCKS_PER_SEC);
377 fprintf(stderr, "Total time: %f seconds\n",
378 ((double)(c4-c0))/CLOCKS_PER_SEC);
379 // This is not needed, but keeps valgrind quiet.