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;
99 main(int argc, char **argv)
102 int outfile = fileno(stdout);
103 const char *outfile_name = "-";
104 const char *in_file = "-";
106 bool debug_mode = false;
107 auto write_fn = &device_tree::write_binary;
108 auto read_fn = &device_tree::parse_dts;
109 uint32_t boot_cpu = 0;
110 bool boot_cpu_specified = false;
111 bool keep_going = false;
113 clock_t c0 = clock();
114 class device_tree tree;
115 fdt::checking::check_manager checks;
116 const char *options = "@hqI:O:o:V:d:R:S:p:b:fi:svH:W:E:DP:";
118 // Don't forget to update the man page if any more options are added.
119 while ((ch = getopt(argc, argv, options)) != -1)
130 tree.write_symbols = true;
137 read_fn = &device_tree::parse_dtb;
139 else if (arg == "dts")
141 read_fn = &device_tree::parse_dts;
145 fprintf(stderr, "Unknown input format: %s\n", optarg);
155 write_fn = &device_tree::write_binary;
157 else if (arg == "asm")
159 write_fn = &device_tree::write_asm;
161 else if (arg == "dts")
163 write_fn = &device_tree::write_dts;
167 fprintf(stderr, "Unknown output format: %s\n", optarg);
174 outfile_name = optarg;
175 if (strcmp(outfile_name, "-") != 0)
177 outfile = open(optarg, O_CREAT | O_TRUNC | O_WRONLY, 0666);
180 perror("Unable to open output file");
190 if (string(optarg) != "17")
192 fprintf(stderr, "Unknown output format version: %s\n", optarg);
202 if (string(optarg) == "-")
208 depfile = fdopen(open(optarg, O_CREAT | O_TRUNC | O_WRONLY, 0666), "w");
211 perror("Unable to open dependency file");
222 tree.set_phandle_format(device_tree::BOTH);
224 else if (arg == "epapr")
226 tree.set_phandle_format(device_tree::EPAPR);
228 else if (arg == "linux")
230 tree.set_phandle_format(device_tree::LINUX);
234 fprintf(stderr, "Unknown phandle format: %s\n", optarg);
240 // Don't bother to check if strtoll fails, just
241 // use the 0 it returns.
242 boot_cpu = (uint32_t)strtoll(optarg, 0, 10);
243 boot_cpu_specified = true;
252 if ((arg.size() > 3) && (strncmp(optarg, "no-", 3) == 0))
254 arg = string(optarg+3);
255 if (!checks.disable_checker(arg))
257 fprintf(stderr, "Checker %s either does not exist or is already disabled\n", optarg+3);
261 if (!checks.enable_checker(arg))
263 fprintf(stderr, "Checker %s either does not exist or is already enabled\n", optarg);
274 tree.add_include_path(optarg);
277 // Should quiet warnings, but for now is silently ignored.
281 tree.set_empty_reserve_map_entries(strtoll(optarg, 0, 10));
284 tree.set_blob_minimum_size(strtoll(optarg, 0, 10));
287 tree.set_blob_padding(strtoll(optarg, 0, 10));
290 if (!tree.parse_define(optarg))
292 fprintf(stderr, "Invalid predefine value %s\n",
297 fprintf(stderr, "Unknown option %c\n", ch);
303 in_file = argv[optind];
307 fputs(outfile_name, depfile);
308 fputs(": ", depfile);
309 fputs(in_file, depfile);
311 clock_t c1 = clock();
312 (tree.*read_fn)(in_file, depfile);
313 // Override the boot CPU found in the header, if we're loading from dtb
314 if (boot_cpu_specified)
316 tree.set_boot_cpu(boot_cpu);
327 if (!(tree.is_valid() || keep_going))
329 fprintf(stderr, "Failed to parse tree.\n");
332 clock_t c2 = clock();
333 if (!(checks.run_checks(&tree, true) || keep_going))
337 clock_t c3 = clock();
338 (tree.*write_fn)(outfile);
340 clock_t c4 = clock();
346 getrusage(RUSAGE_SELF, &r);
347 fprintf(stderr, "Peak memory usage: %ld bytes\n", r.ru_maxrss);
348 fprintf(stderr, "Setup and option parsing took %f seconds\n",
349 ((double)(c1-c0))/CLOCKS_PER_SEC);
350 fprintf(stderr, "Parsing took %f seconds\n",
351 ((double)(c2-c1))/CLOCKS_PER_SEC);
352 fprintf(stderr, "Checking took %f seconds\n",
353 ((double)(c3-c2))/CLOCKS_PER_SEC);
354 fprintf(stderr, "Generating output took %f seconds\n",
355 ((double)(c4-c3))/CLOCKS_PER_SEC);
356 fprintf(stderr, "Total time: %f seconds\n",
357 ((double)(c4-c0))/CLOCKS_PER_SEC);
358 // This is not needed, but keeps valgrind quiet.