xref: /openbmc/linux/tools/objtool/builtin-check.c (revision 1fa0a7dc)
1 /*
2  * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 /*
19  * objtool check:
20  *
21  * This command analyzes every .o file and ensures the validity of its stack
22  * trace metadata.  It enforces a set of rules on asm code and C inline
23  * assembly code so that stack traces can be reliable.
24  *
25  * For more information, see tools/objtool/Documentation/stack-validation.txt.
26  */
27 
28 #include <subcmd/parse-options.h>
29 #include "builtin.h"
30 #include "check.h"
31 
32 bool no_fp, no_unreachable, retpoline, module, backtrace, uaccess;
33 
34 static const char * const check_usage[] = {
35 	"objtool check [<options>] file.o",
36 	NULL,
37 };
38 
39 const struct option check_options[] = {
40 	OPT_BOOLEAN('f', "no-fp", &no_fp, "Skip frame pointer validation"),
41 	OPT_BOOLEAN('u', "no-unreachable", &no_unreachable, "Skip 'unreachable instruction' warnings"),
42 	OPT_BOOLEAN('r', "retpoline", &retpoline, "Validate retpoline assumptions"),
43 	OPT_BOOLEAN('m', "module", &module, "Indicates the object will be part of a kernel module"),
44 	OPT_BOOLEAN('b', "backtrace", &backtrace, "unwind on error"),
45 	OPT_BOOLEAN('a', "uaccess", &uaccess, "enable uaccess checking"),
46 	OPT_END(),
47 };
48 
49 int cmd_check(int argc, const char **argv)
50 {
51 	const char *objname;
52 
53 	argc = parse_options(argc, argv, check_options, check_usage, 0);
54 
55 	if (argc != 1)
56 		usage_with_options(check_usage, check_options);
57 
58 	objname = argv[0];
59 
60 	return check(objname, false);
61 }
62