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 <stdlib.h>
  19 #include <objtool/builtin.h>
  20 #include <objtool/objtool.h>
  21
  22 bool no_fp, no_unreachable, retpoline, module, backtrace, uaccess, stats,
  23      lto, vmlinux, mcount, noinstr, backup, sls, dryrun,
  24      ibt;
  25
  26 static const char * const check_usage[] = {
  27         "objtool check [<options>] file.o",
  28         NULL,
  29 };
  30
  31 static const char * const env_usage[] = {
  32         "OBJTOOL_ARGS=\"<options>\"",
  33         NULL,
  34 };
  35
  36 const struct option check_options[] = {
  37         OPT_BOOLEAN('f', "no-fp", &no_fp, "Skip frame pointer validation"),
  38         OPT_BOOLEAN('u', "no-unreachable", &no_unreachable, "Skip 'unreachable instruction' warnings"),
  39         OPT_BOOLEAN('r', "retpoline", &retpoline, "Validate retpoline assumptions"),
  40         OPT_BOOLEAN('m', "module", &module, "Indicates the object will be part of a kernel module"),
  41         OPT_BOOLEAN('b', "backtrace", &backtrace, "unwind on error"),
  42         OPT_BOOLEAN('a', "uaccess", &uaccess, "enable uaccess checking"),
  43         OPT_BOOLEAN('s', "stats", &stats, "print statistics"),
  44         OPT_BOOLEAN(0, "lto", &lto, "whole-archive like runs"),
  45         OPT_BOOLEAN('n', "noinstr", &noinstr, "noinstr validation for vmlinux.o"),
  46         OPT_BOOLEAN('l', "vmlinux", &vmlinux, "vmlinux.o validation"),
  47         OPT_BOOLEAN('M', "mcount", &mcount, "generate __mcount_loc"),
  48         OPT_BOOLEAN('B', "backup", &backup, "create .orig files before modification"),
  49         OPT_BOOLEAN('S', "sls", &sls, "validate straight-line-speculation"),
  50         OPT_BOOLEAN(0, "dry-run", &dryrun, "don't write the modifications"),
  51         OPT_BOOLEAN(0, "ibt", &ibt, "validate ENDBR placement"),
  52         OPT_END(),
  53 };
  54
  55 int cmd_parse_options(int argc, const char **argv, const char * const usage[])
  56 {
  57         const char *envv[16] = { };
  58         char *env;
  59         int envc;
  60
  61         env = getenv("OBJTOOL_ARGS");
  62         if (env) {
  63                 envv[0] = "OBJTOOL_ARGS";
  64                 for (envc = 1; envc < ARRAY_SIZE(envv); ) {
  65                         envv[envc++] = env;
  66                         env = strchr(env, ' ');
  67                         if (!env)
  68                                 break;
  69                         *env = '\0';
  70                         env++;
  71                 }
  72
  73                 parse_options(envc, envv, check_options, env_usage, 0);
  74         }
  75
  76         argc = parse_options(argc, argv, check_options, usage, 0);
  77         if (argc != 1)
  78                 usage_with_options(usage, check_options);
  79         return argc;
  80 }
  81
  82 int cmd_check(int argc, const char **argv)
  83 {
  84         const char *objname;
  85         struct objtool_file *file;
  86         int ret;
  87
  88         argc = cmd_parse_options(argc, argv, check_usage);
  89         objname = argv[0];
  90
  91         file = objtool_open_read(objname);
  92         if (!file)
  93                 return 1;
  94
  95         ret = check(file);
  96         if (ret)
  97                 return ret;
  98
  99         if (file->elf->changed)
 100                 return elf_write(file->elf);
 101
 102         return 0;
 103 }