Merge tag 'nfs-for-5.2-2' of git://git.linux-nfs.org/projects/anna/linux-nfs
[linux-2.6-block.git] / tools / perf / perf.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
bf9e1876
IM
2/*
3 * perf.c
4 *
5 * Performance analysis utility.
6 *
7 * This is the main hub from which the sub-commands (perf stat,
8 * perf top, perf record, perf report, etc.) are started.
9 */
07800601 10#include "builtin.h"
bf9e1876 11
aa36ddd7 12#include "util/env.h"
4b6ab94e 13#include <subcmd/exec-cmd.h>
41840d21 14#include "util/config.h"
4b6ab94e 15#include <subcmd/run-command.h>
5beeded1 16#include "util/parse-events.h"
4b6ab94e 17#include <subcmd/parse-options.h>
84c86ca1 18#include "util/bpf-loader.h"
bbb2cea7 19#include "util/debug.h"
5ab8c689 20#include "util/event.h"
4cb93446 21#include <api/fs/fs.h>
592d5a6b 22#include <api/fs/tracing_path.h>
a43783ae 23#include <errno.h>
27683dc5 24#include <pthread.h>
9607ad3a 25#include <signal.h>
14cbfbeb
NK
26#include <stdlib.h>
27#include <time.h>
7a8ef4c4
ACM
28#include <sys/types.h>
29#include <sys/stat.h>
30#include <unistd.h>
877a7a11 31#include <linux/kernel.h>
07800601
IM
32
33const char perf_usage_string[] =
78a1b503 34 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
07800601
IM
35
36const char perf_more_info_string[] =
37 "See 'perf help COMMAND' for more information on a specific command.";
38
39static int use_pager = -1;
70cb4e96 40const char *input_name;
5d06e691 41
98a4179c
FW
42struct cmd_struct {
43 const char *cmd;
b0ad8ea6 44 int (*fn)(int, const char **);
98a4179c
FW
45 int option;
46};
47
48static struct cmd_struct commands[] = {
49 { "buildid-cache", cmd_buildid_cache, 0 },
50 { "buildid-list", cmd_buildid_list, 0 },
30862f2c 51 { "config", cmd_config, 0 },
7aef3bf3 52 { "c2c", cmd_c2c, 0 },
98a4179c
FW
53 { "diff", cmd_diff, 0 },
54 { "evlist", cmd_evlist, 0 },
55 { "help", cmd_help, 0 },
35563771 56 { "kallsyms", cmd_kallsyms, 0 },
98a4179c
FW
57 { "list", cmd_list, 0 },
58 { "record", cmd_record, 0 },
59 { "report", cmd_report, 0 },
60 { "bench", cmd_bench, 0 },
61 { "stat", cmd_stat, 0 },
62 { "timechart", cmd_timechart, 0 },
63 { "top", cmd_top, 0 },
64 { "annotate", cmd_annotate, 0 },
65 { "version", cmd_version, 0 },
66 { "script", cmd_script, 0 },
67 { "sched", cmd_sched, 0 },
89fe808a 68#ifdef HAVE_LIBELF_SUPPORT
98a4179c 69 { "probe", cmd_probe, 0 },
393be2e3 70#endif
98a4179c
FW
71 { "kmem", cmd_kmem, 0 },
72 { "lock", cmd_lock, 0 },
73 { "kvm", cmd_kvm, 0 },
74 { "test", cmd_test, 0 },
22e9af4e 75#if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
514f1c67 76 { "trace", cmd_trace, 0 },
4d29089c 77#endif
98a4179c 78 { "inject", cmd_inject, 0 },
028f12ee 79 { "mem", cmd_mem, 0 },
2245bf14 80 { "data", cmd_data, 0 },
d01f4e8d 81 { "ftrace", cmd_ftrace, 0 },
98a4179c
FW
82};
83
07800601
IM
84struct pager_config {
85 const char *cmd;
86 int val;
87};
88
89static int pager_command_config(const char *var, const char *value, void *data)
90{
91 struct pager_config *c = data;
8e99b6d4 92 if (strstarts(var, "pager.") && !strcmp(var + 6, c->cmd))
07800601
IM
93 c->val = perf_config_bool(var, value);
94 return 0;
95}
96
97/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
a3b70b3b 98static int check_pager_config(const char *cmd)
07800601 99{
ecc4c561 100 int err;
07800601
IM
101 struct pager_config c;
102 c.cmd = cmd;
103 c.val = -1;
ecc4c561
ACM
104 err = perf_config(pager_command_config, &c);
105 return err ?: c.val;
07800601
IM
106}
107
0020ce23 108static int browser_command_config(const char *var, const char *value, void *data)
5d06e691
ACM
109{
110 struct pager_config *c = data;
8e99b6d4 111 if (strstarts(var, "tui.") && !strcmp(var + 4, c->cmd))
5d06e691 112 c->val = perf_config_bool(var, value);
8e99b6d4 113 if (strstarts(var, "gtk.") && !strcmp(var + 4, c->cmd))
0020ce23 114 c->val = perf_config_bool(var, value) ? 2 : 0;
5d06e691
ACM
115 return 0;
116}
117
0020ce23
NK
118/*
119 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
120 * and -1 for "not specified"
121 */
122static int check_browser_config(const char *cmd)
5d06e691 123{
ecc4c561 124 int err;
5d06e691
ACM
125 struct pager_config c;
126 c.cmd = cmd;
127 c.val = -1;
ecc4c561
ACM
128 err = perf_config(browser_command_config, &c);
129 return err ?: c.val;
5d06e691
ACM
130}
131
4c574159
TF
132static void commit_pager_choice(void)
133{
07800601
IM
134 switch (use_pager) {
135 case 0:
096d3558 136 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
07800601
IM
137 break;
138 case 1:
139 /* setup_pager(); */
140 break;
141 default:
142 break;
143 }
144}
145
7335399a
YS
146struct option options[] = {
147 OPT_ARGUMENT("help", "help"),
148 OPT_ARGUMENT("version", "version"),
149 OPT_ARGUMENT("exec-path", "exec-path"),
150 OPT_ARGUMENT("html-path", "html-path"),
151 OPT_ARGUMENT("paginate", "paginate"),
152 OPT_ARGUMENT("no-pager", "no-pager"),
7335399a
YS
153 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
154 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
155 OPT_ARGUMENT("list-cmds", "list-cmds"),
156 OPT_ARGUMENT("list-opts", "list-opts"),
157 OPT_ARGUMENT("debug", "debug"),
158 OPT_END()
159};
160
4c574159 161static int handle_options(const char ***argv, int *argc, int *envchanged)
07800601
IM
162{
163 int handled = 0;
164
165 while (*argc > 0) {
166 const char *cmd = (*argv)[0];
167 if (cmd[0] != '-')
168 break;
169
170 /*
171 * For legacy reasons, the "version" and "help"
172 * commands can be written with "--" prepended
173 * to make them look like flags.
174 */
175 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
176 break;
177
a1853e2c
JO
178 /*
179 * Shortcut for '-h' and '-v' options to invoke help
180 * and version command.
181 */
182 if (!strcmp(cmd, "-h")) {
183 (*argv)[0] = "--help";
184 break;
185 }
186
187 if (!strcmp(cmd, "-v")) {
188 (*argv)[0] = "--version";
189 break;
190 }
191
3aa94b10
JY
192 if (!strcmp(cmd, "-vv")) {
193 (*argv)[0] = "version";
194 version_verbose = 1;
195 break;
196 }
197
07800601
IM
198 /*
199 * Check remaining flags.
200 */
8e99b6d4 201 if (strstarts(cmd, CMD_EXEC_PATH)) {
cfed95a6 202 cmd += strlen(CMD_EXEC_PATH);
07800601 203 if (*cmd == '=')
46113a54 204 set_argv_exec_path(cmd + 1);
07800601 205 else {
46113a54 206 puts(get_argv_exec_path());
07800601
IM
207 exit(0);
208 }
209 } else if (!strcmp(cmd, "--html-path")) {
210 puts(system_path(PERF_HTML_PATH));
211 exit(0);
212 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
213 use_pager = 1;
214 } else if (!strcmp(cmd, "--no-pager")) {
215 use_pager = 0;
216 if (envchanged)
217 *envchanged = 1;
5beeded1
JB
218 } else if (!strcmp(cmd, "--debugfs-dir")) {
219 if (*argc < 2) {
220 fprintf(stderr, "No directory given for --debugfs-dir.\n");
221 usage(perf_usage_string);
222 }
65d4b265 223 tracing_path_set((*argv)[1]);
5beeded1
JB
224 if (envchanged)
225 *envchanged = 1;
226 (*argv)++;
227 (*argc)--;
99ce8e9f
JO
228 } else if (!strcmp(cmd, "--buildid-dir")) {
229 if (*argc < 2) {
230 fprintf(stderr, "No directory given for --buildid-dir.\n");
231 usage(perf_usage_string);
232 }
233 set_buildid_dir((*argv)[1]);
234 if (envchanged)
235 *envchanged = 1;
236 (*argv)++;
237 (*argc)--;
8e99b6d4 238 } else if (strstarts(cmd, CMD_DEBUGFS_DIR)) {
65d4b265 239 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
17c257e8 240 fprintf(stderr, "dir: %s\n", tracing_path_mount());
5beeded1
JB
241 if (envchanged)
242 *envchanged = 1;
98a4179c
FW
243 } else if (!strcmp(cmd, "--list-cmds")) {
244 unsigned int i;
245
246 for (i = 0; i < ARRAY_SIZE(commands); i++) {
247 struct cmd_struct *p = commands+i;
248 printf("%s ", p->cmd);
249 }
ed457520 250 putchar('\n');
98a4179c 251 exit(0);
7335399a
YS
252 } else if (!strcmp(cmd, "--list-opts")) {
253 unsigned int i;
254
255 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
256 struct option *p = options+i;
257 printf("--%s ", p->long_name);
258 }
259 putchar('\n');
260 exit(0);
bbb2cea7
JO
261 } else if (!strcmp(cmd, "--debug")) {
262 if (*argc < 2) {
263 fprintf(stderr, "No variable specified for --debug.\n");
264 usage(perf_usage_string);
265 }
266 if (perf_debug_option((*argv)[1]))
267 usage(perf_usage_string);
268
269 (*argv)++;
270 (*argc)--;
07800601
IM
271 } else {
272 fprintf(stderr, "Unknown option: %s\n", cmd);
273 usage(perf_usage_string);
274 }
275
276 (*argv)++;
277 (*argc)--;
278 handled++;
279 }
280 return handled;
281}
282
07800601
IM
283#define RUN_SETUP (1<<0)
284#define USE_PAGER (1<<1)
07800601 285
07800601
IM
286static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
287{
288 int status;
289 struct stat st;
b2348e1d 290 char sbuf[STRERR_BUFSIZE];
07800601 291
5d06e691 292 if (use_browser == -1)
0020ce23 293 use_browser = check_browser_config(p->cmd);
5d06e691 294
07800601
IM
295 if (use_pager == -1 && p->option & RUN_SETUP)
296 use_pager = check_pager_config(p->cmd);
297 if (use_pager == -1 && p->option & USE_PAGER)
298 use_pager = 1;
299 commit_pager_choice();
300
e4378f0c 301 perf_env__init(&perf_env);
2bdb2c27 302 perf_env__set_cmdline(&perf_env, argc, argv);
b0ad8ea6 303 status = p->fn(argc, argv);
8a0a9c7e 304 perf_config__exit();
f3a1f0ea 305 exit_browser(status);
aa36ddd7 306 perf_env__exit(&perf_env);
84c86ca1 307 bpf__clear();
f3a1f0ea 308
07800601
IM
309 if (status)
310 return status & 0xff;
311
312 /* Somebody closed stdout? */
313 if (fstat(fileno(stdout), &st))
314 return 0;
315 /* Ignore write errors for pipes and sockets.. */
316 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
317 return 0;
318
2a16bf8c 319 status = 1;
07800601 320 /* Check for ENOSPC and EIO errors.. */
2a16bf8c 321 if (fflush(stdout)) {
b2348e1d 322 fprintf(stderr, "write failure on standard output: %s",
c8b5f2c9 323 str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c
ACM
324 goto out;
325 }
326 if (ferror(stdout)) {
327 fprintf(stderr, "unknown write failure on standard output");
328 goto out;
329 }
330 if (fclose(stdout)) {
b2348e1d 331 fprintf(stderr, "close failed on standard output: %s",
c8b5f2c9 332 str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c
ACM
333 goto out;
334 }
335 status = 0;
336out:
337 return status;
07800601
IM
338}
339
340static void handle_internal_command(int argc, const char **argv)
341{
342 const char *cmd = argv[0];
f37a291c 343 unsigned int i;
07800601
IM
344
345 /* Turn "perf cmd --help" into "perf help cmd" */
346 if (argc > 1 && !strcmp(argv[1], "--help")) {
347 argv[1] = argv[0];
348 argv[0] = cmd = "help";
349 }
350
351 for (i = 0; i < ARRAY_SIZE(commands); i++) {
352 struct cmd_struct *p = commands+i;
353 if (strcmp(p->cmd, cmd))
354 continue;
355 exit(run_builtin(p, argc, argv));
356 }
357}
358
359static void execv_dashed_external(const char **argv)
360{
5104ffb2 361 char *cmd;
07800601
IM
362 const char *tmp;
363 int status;
364
5104ffb2
ACM
365 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
366 goto do_die;
07800601
IM
367
368 /*
369 * argv[0] must be the perf command, but the argv array
370 * belongs to the caller, and may be reused in
371 * subsequent loop iterations. Save argv[0] and
372 * restore it on error.
373 */
374 tmp = argv[0];
5104ffb2 375 argv[0] = cmd;
07800601
IM
376
377 /*
378 * if we fail because the command is not found, it is
379 * OK to return. Otherwise, we just pass along the status code.
380 */
381 status = run_command_v_opt(argv, 0);
382 if (status != -ERR_RUN_COMMAND_EXEC) {
5104ffb2
ACM
383 if (IS_RUN_COMMAND_ERR(status)) {
384do_die:
42774806
ACM
385 pr_err("FATAL: unable to run '%s'", argv[0]);
386 status = -128;
5104ffb2 387 }
07800601
IM
388 exit(-status);
389 }
390 errno = ENOENT; /* as if we called execvp */
391
392 argv[0] = tmp;
5104ffb2 393 zfree(&cmd);
07800601
IM
394}
395
396static int run_argv(int *argcp, const char ***argv)
397{
c6867701
ACM
398 /* See if it's an internal command */
399 handle_internal_command(*argcp, *argv);
07800601 400
c6867701
ACM
401 /* .. then try the external ones */
402 execv_dashed_external(*argv);
403 return 0;
07800601
IM
404}
405
3af6e338
ACM
406static void pthread__block_sigwinch(void)
407{
408 sigset_t set;
409
410 sigemptyset(&set);
411 sigaddset(&set, SIGWINCH);
412 pthread_sigmask(SIG_BLOCK, &set, NULL);
413}
414
415void pthread__unblock_sigwinch(void)
416{
417 sigset_t set;
418
419 sigemptyset(&set);
420 sigaddset(&set, SIGWINCH);
421 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
422}
423
07800601
IM
424int main(int argc, const char **argv)
425{
ecc4c561 426 int err;
07800601 427 const char *cmd;
b2348e1d 428 char sbuf[STRERR_BUFSIZE];
07800601 429
096d3558
JP
430 /* libsubcmd init */
431 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
432 pager_init(PERF_PAGER_ENVIRONMENT);
433
918512b4 434 /* The page_size is placed in util object. */
0c1fe6b2
ACM
435 page_size = sysconf(_SC_PAGE_SIZE);
436
46113a54 437 cmd = extract_argv0_path(argv[0]);
07800601
IM
438 if (!cmd)
439 cmd = "perf-help";
65d4b265 440
14cbfbeb
NK
441 srandom(time(NULL));
442
ecc4c561
ACM
443 err = perf_config(perf_default_config, NULL);
444 if (err)
445 return err;
58cb9d65 446 set_buildid_dir(NULL);
b8cbb349 447
07800601
IM
448 /*
449 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
450 *
451 * - cannot take flags in between the "perf" and the "xxxx".
452 * - cannot execute it externally (since it would just do
453 * the same thing over again)
454 *
3192f1ed
MW
455 * So we just directly call the internal command handler. If that one
456 * fails to handle this, then maybe we just run a renamed perf binary
457 * that contains a dash in its name. To handle this scenario, we just
458 * fall through and ignore the "xxxx" part of the command string.
07800601 459 */
8e99b6d4 460 if (strstarts(cmd, "perf-")) {
266dfb0b 461 cmd += 5;
07800601
IM
462 argv[0] = cmd;
463 handle_internal_command(argc, argv);
3192f1ed
MW
464 /*
465 * If the command is handled, the above function does not
466 * return undo changes and fall through in such a case.
467 */
468 cmd -= 5;
469 argv[0] = cmd;
07800601 470 }
8e99b6d4 471 if (strstarts(cmd, "trace")) {
22e9af4e 472#if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
b52bc234
ACM
473 setup_path();
474 argv[0] = "trace";
b0ad8ea6 475 return cmd_trace(argc, argv);
1b572622
ACM
476#else
477 fprintf(stderr,
478 "trace command not available: missing audit-libs devel package at build time.\n");
479 goto out;
b52bc234 480#endif
1b572622 481 }
07800601
IM
482 /* Look for flags.. */
483 argv++;
484 argc--;
485 handle_options(&argv, &argc, NULL);
486 commit_pager_choice();
45de34bb 487
07800601 488 if (argc > 0) {
8e99b6d4 489 if (strstarts(argv[0], "--"))
07800601
IM
490 argv[0] += 2;
491 } else {
492 /* The user didn't specify a command; give them help */
502fc5c7 493 printf("\n usage: %s\n\n", perf_usage_string);
07800601 494 list_common_cmds_help();
502fc5c7 495 printf("\n %s\n\n", perf_more_info_string);
2a16bf8c 496 goto out;
07800601
IM
497 }
498 cmd = argv[0];
499
52502bf2
JO
500 test_attr__init();
501
07800601
IM
502 /*
503 * We use PATH to find perf commands, but we prepend some higher
659431fc 504 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
07800601
IM
505 * environment, and the $(perfexecdir) from the Makefile at build
506 * time.
507 */
508 setup_path();
3af6e338
ACM
509 /*
510 * Block SIGWINCH notifications so that the thread that wants it can
511 * unblock and get syscalls like select interrupted instead of waiting
512 * forever while the signal goes to some other non interested thread.
513 */
514 pthread__block_sigwinch();
07800601 515
dd629cc0
JO
516 perf_debug_setup();
517
07800601 518 while (1) {
4c574159 519 static int done_help;
c6867701
ACM
520
521 run_argv(&argc, &argv);
8035e428 522
07800601
IM
523 if (errno != ENOENT)
524 break;
8035e428 525
07800601
IM
526 if (!done_help) {
527 cmd = argv[0] = help_unknown_cmd(cmd);
528 done_help = 1;
529 } else
530 break;
531 }
532
533 fprintf(stderr, "Failed to run command '%s': %s\n",
c8b5f2c9 534 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c 535out:
07800601
IM
536 return 1;
537}