xref: /linux/tools/objtool/builtin-check.c (revision 37744feebc086908fd89760650f458ab19071750)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
4  */
5 
6 /*
7  * objtool check:
8  *
9  * This command analyzes every .o file and ensures the validity of its stack
10  * trace metadata.  It enforces a set of rules on asm code and C inline
11  * assembly code so that stack traces can be reliable.
12  *
13  * For more information, see tools/objtool/Documentation/stack-validation.txt.
14  */
15 
16 #include <subcmd/parse-options.h>
17 #include "builtin.h"
18 #include "check.h"
19 
20 bool no_fp, no_unreachable, retpoline, module, backtrace, uaccess, stats;
21 
22 static const char * const check_usage[] = {
23 	"objtool check [<options>] file.o",
24 	NULL,
25 };
26 
27 const struct option check_options[] = {
28 	OPT_BOOLEAN('f', "no-fp", &no_fp, "Skip frame pointer validation"),
29 	OPT_BOOLEAN('u', "no-unreachable", &no_unreachable, "Skip 'unreachable instruction' warnings"),
30 	OPT_BOOLEAN('r', "retpoline", &retpoline, "Validate retpoline assumptions"),
31 	OPT_BOOLEAN('m', "module", &module, "Indicates the object will be part of a kernel module"),
32 	OPT_BOOLEAN('b', "backtrace", &backtrace, "unwind on error"),
33 	OPT_BOOLEAN('a', "uaccess", &uaccess, "enable uaccess checking"),
34 	OPT_BOOLEAN('s', "stats", &stats, "print statistics"),
35 	OPT_END(),
36 };
37 
38 int cmd_check(int argc, const char **argv)
39 {
40 	const char *objname;
41 
42 	argc = parse_options(argc, argv, check_options, check_usage, 0);
43 
44 	if (argc != 1)
45 		usage_with_options(check_usage, check_options);
46 
47 	objname = argv[0];
48 
49 	return check(objname, false);
50 }
51