blob: 694abc628e9b3060b2252c1e8c86af4d6176e518 [file] [log] [blame]
Josh Poimboeuf442f04c2016-02-28 22:22:41 -06001/*
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -05002 * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
Josh Poimboeuf442f04c2016-02-28 22:22:41 -06003 *
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
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060028#include <subcmd/parse-options.h>
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060029#include "builtin.h"
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -050030#include "check.h"
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060031
Greg Kroah-Hartmanb790b4f2018-06-03 12:35:15 +020032bool no_fp, no_unreachable, retpoline, module;
Josh Poimboeuf042ba732016-03-09 00:07:00 -060033
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -050034static const char * const check_usage[] = {
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060035 "objtool check [<options>] file.o",
36 NULL,
37};
38
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -050039const struct option check_options[] = {
Greg Kroah-Hartmanb790b4f2018-06-03 12:35:15 +020040 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"),
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -050044 OPT_END(),
45};
46
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060047int cmd_check(int argc, const char **argv)
48{
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -050049 const char *objname;
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060050
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -050051 argc = parse_options(argc, argv, check_options, check_usage, 0);
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060052
53 if (argc != 1)
Josh Poimboeuf24ac7a42017-06-28 10:11:05 -050054 usage_with_options(check_usage, check_options);
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060055
56 objname = argv[0];
57
Greg Kroah-Hartmanb790b4f2018-06-03 12:35:15 +020058 return check(objname, false);
Josh Poimboeuf442f04c2016-02-28 22:22:41 -060059}