Blame view

tools/objtool/objtool.c 3.07 KB
1ccea77e2   Thomas Gleixner   treewide: Replace...
1
  // SPDX-License-Identifier: GPL-2.0-or-later
442f04c34   Josh Poimboeuf   objtool: Add tool...
2
3
  /*
   * Copyright (C) 2015 Josh Poimboeuf <jpoimboe@redhat.com>
442f04c34   Josh Poimboeuf   objtool: Add tool...
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
   */
  
  /*
   * objtool:
   *
   * The 'check' subcmd analyzes every .o file and ensures the validity of its
   * stack trace metadata.  It enforces a set of rules on asm code and C inline
   * assembly code so that stack traces can be reliable.
   *
   * For more information, see tools/objtool/Documentation/stack-validation.txt.
   */
  
  #include <stdio.h>
  #include <stdbool.h>
  #include <string.h>
  #include <stdlib.h>
  #include <subcmd/exec-cmd.h>
  #include <subcmd/pager.h>
006145974   Arnaldo Carvalho de Melo   objtool: Drop ARR...
22
  #include <linux/kernel.h>
442f04c34   Josh Poimboeuf   objtool: Add tool...
23
24
  
  #include "builtin.h"
6545eb030   Julien Thierry   objtool: Move obj...
25
26
  #include "objtool.h"
  #include "warn.h"
442f04c34   Josh Poimboeuf   objtool: Add tool...
27

442f04c34   Josh Poimboeuf   objtool: Add tool...
28
29
30
31
32
33
34
  struct cmd_struct {
  	const char *name;
  	int (*fn)(int, const char **);
  	const char *help;
  };
  
  static const char objtool_usage_string[] =
627fce148   Josh Poimboeuf   objtool: Add ORC ...
35
  	"objtool COMMAND [ARGS]";
442f04c34   Josh Poimboeuf   objtool: Add tool...
36
37
38
  
  static struct cmd_struct objtool_cmds[] = {
  	{"check",	cmd_check,	"Perform stack metadata validation on an object file" },
627fce148   Josh Poimboeuf   objtool: Add ORC ...
39
  	{"orc",		cmd_orc,	"Generate in-place ORC unwind tables for an object file" },
442f04c34   Josh Poimboeuf   objtool: Add tool...
40
41
42
  };
  
  bool help;
6545eb030   Julien Thierry   objtool: Move obj...
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  const char *objname;
  static struct objtool_file file;
  
  struct objtool_file *objtool_open_read(const char *_objname)
  {
  	if (objname) {
  		if (strcmp(objname, _objname)) {
  			WARN("won't handle more than one file at a time");
  			return NULL;
  		}
  		return &file;
  	}
  	objname = _objname;
  
  	file.elf = elf_open_read(objname, O_RDWR);
  	if (!file.elf)
  		return NULL;
  
  	INIT_LIST_HEAD(&file.insn_list);
  	hash_init(file.insn_hash);
  	INIT_LIST_HEAD(&file.static_call_list);
7dcfcd46b   Peter Zijlstra   FROMLIST: objtool...
64
  	INIT_LIST_HEAD(&file.mcount_loc_list);
6545eb030   Julien Thierry   objtool: Move obj...
65
66
67
68
69
70
  	file.c_file = !vmlinux && find_section_by_name(file.elf, ".comment");
  	file.ignore_unreachables = no_unreachable;
  	file.hints = false;
  
  	return &file;
  }
442f04c34   Josh Poimboeuf   objtool: Add tool...
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
  static void cmd_usage(void)
  {
  	unsigned int i, longest = 0;
  
  	printf("
   usage: %s
  
  ", objtool_usage_string);
  
  	for (i = 0; i < ARRAY_SIZE(objtool_cmds); i++) {
  		if (longest < strlen(objtool_cmds[i].name))
  			longest = strlen(objtool_cmds[i].name);
  	}
  
  	puts(" Commands:");
  	for (i = 0; i < ARRAY_SIZE(objtool_cmds); i++) {
  		printf("   %-*s   ", longest, objtool_cmds[i].name);
  		puts(objtool_cmds[i].help);
  	}
  
  	printf("
  ");
f15c648f2   Matt Helsley   objtool: Exit suc...
93
94
95
  	if (!help)
  		exit(129);
  	exit(0);
442f04c34   Josh Poimboeuf   objtool: Add tool...
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  }
  
  static void handle_options(int *argc, const char ***argv)
  {
  	while (*argc > 0) {
  		const char *cmd = (*argv)[0];
  
  		if (cmd[0] != '-')
  			break;
  
  		if (!strcmp(cmd, "--help") || !strcmp(cmd, "-h")) {
  			help = true;
  			break;
  		} else {
  			fprintf(stderr, "Unknown option: %s
  ", cmd);
6a93bb7e4   Kamalesh Babulal   objtool: Print to...
112
  			cmd_usage();
442f04c34   Josh Poimboeuf   objtool: Add tool...
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
  		}
  
  		(*argv)++;
  		(*argc)--;
  	}
  }
  
  static void handle_internal_command(int argc, const char **argv)
  {
  	const char *cmd = argv[0];
  	unsigned int i, ret;
  
  	for (i = 0; i < ARRAY_SIZE(objtool_cmds); i++) {
  		struct cmd_struct *p = objtool_cmds+i;
  
  		if (strcmp(p->name, cmd))
  			continue;
  
  		ret = p->fn(argc, argv);
  
  		exit(ret);
  	}
  
  	cmd_usage();
  }
  
  int main(int argc, const char **argv)
  {
  	static const char *UNUSED = "OBJTOOL_NOT_IMPLEMENTED";
  
  	/* libsubcmd init */
  	exec_cmd_init("objtool", UNUSED, UNUSED, UNUSED);
  	pager_init(UNUSED);
  
  	argv++;
  	argc--;
  	handle_options(&argc, &argv);
  
  	if (!argc || help)
  		cmd_usage();
  
  	handle_internal_command(argc, argv);
  
  	return 0;
  }