tools/objtool/builtin-check.c

   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 <string.h>
  18 #include <objtool/builtin.h>
  19 #include <objtool/objtool.h>
  20
  21 bool no_fp, no_unreachable, retpoline, module, backtrace, uaccess, stats, validate_dup, vmlinux, mcount, noinstr;
  22
  23 static const char * const check_usage[] = {
  24         "objtool check [<options>] file.o",
  25         NULL,
  26 };
  27
  28 const struct option check_options[] = {
  29         OPT_BOOLEAN('f', "no-fp", &no_fp, "Skip frame pointer validation"),
  30         OPT_BOOLEAN('u', "no-unreachable", &no_unreachable, "Skip 'unreachable instruction' warnings"),
  31         OPT_BOOLEAN('r', "retpoline", &retpoline, "Validate retpoline assumptions"),
  32         OPT_BOOLEAN('m', "module", &module, "Indicates the object will be part of a kernel module"),
  33         OPT_BOOLEAN('b', "backtrace", &backtrace, "unwind on error"),
  34         OPT_BOOLEAN('a', "uaccess", &uaccess, "enable uaccess checking"),
  35         OPT_BOOLEAN('s', "stats", &stats, "print statistics"),
  36         OPT_BOOLEAN('d', "duplicate", &validate_dup, "duplicate validation for vmlinux.o"),
  37         OPT_BOOLEAN('n', "noinstr", &noinstr, "noinstr validation for vmlinux.o"),
  38         OPT_BOOLEAN('l', "vmlinux", &vmlinux, "vmlinux.o validation"),
  39         OPT_BOOLEAN('M', "mcount", &mcount, "generate __mcount_loc"),
  40         OPT_END(),
  41 };
  42
  43 int cmd_check(int argc, const char **argv)
  44 {
  45         const char *objname;
  46         struct objtool_file *file;
  47         int ret;
  48
  49         argc = parse_options(argc, argv, check_options, check_usage, 0);
  50
  51         if (argc != 1)
  52                 usage_with_options(check_usage, check_options);
  53
  54         objname = argv[0];
  55
  56         file = objtool_open_read(objname);
  57         if (!file)
  58                 return 1;
  59
  60         ret = check(file);
  61         if (ret)
  62                 return ret;
  63
  64         if (file->elf->changed)
  65                 return elf_write(file->elf);
  66
  67         return 0;
  68 }