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