4 * Performance analysis utility.
6 * This is the main hub from which the sub-commands (perf stat,
7 * perf top, perf record, perf report, etc.) are started.
12 #include <subcmd/exec-cmd.h>
13 #include "util/cache.h"
14 #include "util/quote.h"
15 #include <subcmd/run-command.h>
16 #include "util/parse-events.h"
17 #include <subcmd/parse-options.h>
18 #include "util/bpf-loader.h"
19 #include "util/debug.h"
20 #include <api/fs/fs.h>
21 #include <api/fs/tracing_path.h>
26 const char perf_usage_string[] =
27 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
29 const char perf_more_info_string[] =
30 "See 'perf help COMMAND' for more information on a specific command.";
33 static int use_pager = -1;
34 const char *input_name;
38 int (*fn)(int, const char **, const char *);
42 static struct cmd_struct commands[] = {
43 { "buildid-cache", cmd_buildid_cache, 0 },
44 { "buildid-list", cmd_buildid_list, 0 },
45 { "config", cmd_config, 0 },
46 { "diff", cmd_diff, 0 },
47 { "evlist", cmd_evlist, 0 },
48 { "help", cmd_help, 0 },
49 { "list", cmd_list, 0 },
50 { "record", cmd_record, 0 },
51 { "report", cmd_report, 0 },
52 { "bench", cmd_bench, 0 },
53 { "stat", cmd_stat, 0 },
54 { "timechart", cmd_timechart, 0 },
55 { "top", cmd_top, 0 },
56 { "annotate", cmd_annotate, 0 },
57 { "version", cmd_version, 0 },
58 { "script", cmd_script, 0 },
59 { "sched", cmd_sched, 0 },
60 #ifdef HAVE_LIBELF_SUPPORT
61 { "probe", cmd_probe, 0 },
63 { "kmem", cmd_kmem, 0 },
64 { "lock", cmd_lock, 0 },
65 { "kvm", cmd_kvm, 0 },
66 { "test", cmd_test, 0 },
67 #ifdef HAVE_LIBAUDIT_SUPPORT
68 { "trace", cmd_trace, 0 },
70 { "inject", cmd_inject, 0 },
71 { "mem", cmd_mem, 0 },
72 { "data", cmd_data, 0 },
80 static int pager_command_config(const char *var, const char *value, void *data)
82 struct pager_config *c = data;
83 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
84 c->val = perf_config_bool(var, value);
88 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
89 int check_pager_config(const char *cmd)
91 struct pager_config c;
94 perf_config(pager_command_config, &c);
98 static int browser_command_config(const char *var, const char *value, void *data)
100 struct pager_config *c = data;
101 if (!prefixcmp(var, "tui.") && !strcmp(var + 4, c->cmd))
102 c->val = perf_config_bool(var, value);
103 if (!prefixcmp(var, "gtk.") && !strcmp(var + 4, c->cmd))
104 c->val = perf_config_bool(var, value) ? 2 : 0;
109 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
110 * and -1 for "not specified"
112 static int check_browser_config(const char *cmd)
114 struct pager_config c;
117 perf_config(browser_command_config, &c);
121 static void commit_pager_choice(void)
125 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
135 struct option options[] = {
136 OPT_ARGUMENT("help", "help"),
137 OPT_ARGUMENT("version", "version"),
138 OPT_ARGUMENT("exec-path", "exec-path"),
139 OPT_ARGUMENT("html-path", "html-path"),
140 OPT_ARGUMENT("paginate", "paginate"),
141 OPT_ARGUMENT("no-pager", "no-pager"),
142 OPT_ARGUMENT("perf-dir", "perf-dir"),
143 OPT_ARGUMENT("work-tree", "work-tree"),
144 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
145 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
146 OPT_ARGUMENT("list-cmds", "list-cmds"),
147 OPT_ARGUMENT("list-opts", "list-opts"),
148 OPT_ARGUMENT("debug", "debug"),
152 static int handle_options(const char ***argv, int *argc, int *envchanged)
157 const char *cmd = (*argv)[0];
162 * For legacy reasons, the "version" and "help"
163 * commands can be written with "--" prepended
164 * to make them look like flags.
166 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
170 * Shortcut for '-h' and '-v' options to invoke help
171 * and version command.
173 if (!strcmp(cmd, "-h")) {
174 (*argv)[0] = "--help";
178 if (!strcmp(cmd, "-v")) {
179 (*argv)[0] = "--version";
184 * Check remaining flags.
186 if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
187 cmd += strlen(CMD_EXEC_PATH);
189 set_argv_exec_path(cmd + 1);
191 puts(get_argv_exec_path());
194 } else if (!strcmp(cmd, "--html-path")) {
195 puts(system_path(PERF_HTML_PATH));
197 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
199 } else if (!strcmp(cmd, "--no-pager")) {
203 } else if (!strcmp(cmd, "--perf-dir")) {
205 fprintf(stderr, "No directory given for --perf-dir.\n");
206 usage(perf_usage_string);
208 setenv(PERF_DIR_ENVIRONMENT, (*argv)[1], 1);
214 } else if (!prefixcmp(cmd, CMD_PERF_DIR)) {
215 setenv(PERF_DIR_ENVIRONMENT, cmd + strlen(CMD_PERF_DIR), 1);
218 } else if (!strcmp(cmd, "--work-tree")) {
220 fprintf(stderr, "No directory given for --work-tree.\n");
221 usage(perf_usage_string);
223 setenv(PERF_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
228 } else if (!prefixcmp(cmd, CMD_WORK_TREE)) {
229 setenv(PERF_WORK_TREE_ENVIRONMENT, cmd + strlen(CMD_WORK_TREE), 1);
232 } else if (!strcmp(cmd, "--debugfs-dir")) {
234 fprintf(stderr, "No directory given for --debugfs-dir.\n");
235 usage(perf_usage_string);
237 tracing_path_set((*argv)[1]);
242 } else if (!strcmp(cmd, "--buildid-dir")) {
244 fprintf(stderr, "No directory given for --buildid-dir.\n");
245 usage(perf_usage_string);
247 set_buildid_dir((*argv)[1]);
252 } else if (!prefixcmp(cmd, CMD_DEBUGFS_DIR)) {
253 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
254 fprintf(stderr, "dir: %s\n", tracing_path);
257 } else if (!strcmp(cmd, "--list-cmds")) {
260 for (i = 0; i < ARRAY_SIZE(commands); i++) {
261 struct cmd_struct *p = commands+i;
262 printf("%s ", p->cmd);
266 } else if (!strcmp(cmd, "--list-opts")) {
269 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
270 struct option *p = options+i;
271 printf("--%s ", p->long_name);
275 } else if (!strcmp(cmd, "--debug")) {
277 fprintf(stderr, "No variable specified for --debug.\n");
278 usage(perf_usage_string);
280 if (perf_debug_option((*argv)[1]))
281 usage(perf_usage_string);
286 fprintf(stderr, "Unknown option: %s\n", cmd);
287 usage(perf_usage_string);
297 static int handle_alias(int *argcp, const char ***argv)
299 int envchanged = 0, ret = 0, saved_errno = errno;
300 int count, option_count;
301 const char **new_argv;
302 const char *alias_command;
305 alias_command = (*argv)[0];
306 alias_string = alias_lookup(alias_command);
308 if (alias_string[0] == '!') {
312 if (strbuf_init(&buf, PATH_MAX) < 0 ||
313 strbuf_addstr(&buf, alias_string) < 0 ||
314 sq_quote_argv(&buf, (*argv) + 1,
316 die("Failed to allocate memory.");
318 alias_string = buf.buf;
320 ret = system(alias_string + 1);
321 if (ret >= 0 && WIFEXITED(ret) &&
322 WEXITSTATUS(ret) != 127)
323 exit(WEXITSTATUS(ret));
324 die("Failed to run '%s' when expanding alias '%s'",
325 alias_string + 1, alias_command);
327 count = split_cmdline(alias_string, &new_argv);
329 die("Bad alias.%s string", alias_command);
330 option_count = handle_options(&new_argv, &count, &envchanged);
332 die("alias '%s' changes environment variables\n"
333 "You can use '!perf' in the alias to do this.",
335 memmove(new_argv - option_count, new_argv,
336 count * sizeof(char *));
337 new_argv -= option_count;
340 die("empty alias for %s", alias_command);
342 if (!strcmp(alias_command, new_argv[0]))
343 die("recursive alias: %s", alias_command);
345 new_argv = realloc(new_argv, sizeof(char *) *
346 (count + *argcp + 1));
347 /* insert after command name */
348 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
349 new_argv[count + *argcp] = NULL;
362 const char perf_version_string[] = PERF_VERSION;
364 #define RUN_SETUP (1<<0)
365 #define USE_PAGER (1<<1)
367 * require working tree to be present -- anything uses this needs
368 * RUN_SETUP for reading from the configuration file.
370 #define NEED_WORK_TREE (1<<2)
372 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
377 char sbuf[STRERR_BUFSIZE];
380 if (p->option & RUN_SETUP)
381 prefix = NULL; /* setup_perf_directory(); */
383 if (use_browser == -1)
384 use_browser = check_browser_config(p->cmd);
386 if (use_pager == -1 && p->option & RUN_SETUP)
387 use_pager = check_pager_config(p->cmd);
388 if (use_pager == -1 && p->option & USE_PAGER)
390 commit_pager_choice();
392 perf_env__set_cmdline(&perf_env, argc, argv);
393 status = p->fn(argc, argv, prefix);
394 exit_browser(status);
395 perf_env__exit(&perf_env);
399 return status & 0xff;
401 /* Somebody closed stdout? */
402 if (fstat(fileno(stdout), &st))
404 /* Ignore write errors for pipes and sockets.. */
405 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
409 /* Check for ENOSPC and EIO errors.. */
410 if (fflush(stdout)) {
411 fprintf(stderr, "write failure on standard output: %s",
412 strerror_r(errno, sbuf, sizeof(sbuf)));
415 if (ferror(stdout)) {
416 fprintf(stderr, "unknown write failure on standard output");
419 if (fclose(stdout)) {
420 fprintf(stderr, "close failed on standard output: %s",
421 strerror_r(errno, sbuf, sizeof(sbuf)));
429 static void handle_internal_command(int argc, const char **argv)
431 const char *cmd = argv[0];
433 static const char ext[] = STRIP_EXTENSION;
435 if (sizeof(ext) > 1) {
436 i = strlen(argv[0]) - strlen(ext);
437 if (i > 0 && !strcmp(argv[0] + i, ext)) {
438 char *argv0 = strdup(argv[0]);
439 argv[0] = cmd = argv0;
444 /* Turn "perf cmd --help" into "perf help cmd" */
445 if (argc > 1 && !strcmp(argv[1], "--help")) {
447 argv[0] = cmd = "help";
450 for (i = 0; i < ARRAY_SIZE(commands); i++) {
451 struct cmd_struct *p = commands+i;
452 if (strcmp(p->cmd, cmd))
454 exit(run_builtin(p, argc, argv));
458 static void execv_dashed_external(const char **argv)
464 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
468 * argv[0] must be the perf command, but the argv array
469 * belongs to the caller, and may be reused in
470 * subsequent loop iterations. Save argv[0] and
471 * restore it on error.
477 * if we fail because the command is not found, it is
478 * OK to return. Otherwise, we just pass along the status code.
480 status = run_command_v_opt(argv, 0);
481 if (status != -ERR_RUN_COMMAND_EXEC) {
482 if (IS_RUN_COMMAND_ERR(status)) {
484 die("unable to run '%s'", argv[0]);
488 errno = ENOENT; /* as if we called execvp */
494 static int run_argv(int *argcp, const char ***argv)
499 /* See if it's an internal command */
500 handle_internal_command(*argcp, *argv);
502 /* .. then try the external ones */
503 execv_dashed_external(*argv);
505 /* It could be an alias -- this works around the insanity
506 * of overriding "perf log" with "perf show" by having
509 if (done_alias || !handle_alias(argcp, argv))
517 static void pthread__block_sigwinch(void)
522 sigaddset(&set, SIGWINCH);
523 pthread_sigmask(SIG_BLOCK, &set, NULL);
526 void pthread__unblock_sigwinch(void)
531 sigaddset(&set, SIGWINCH);
532 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
535 int main(int argc, const char **argv)
538 char sbuf[STRERR_BUFSIZE];
542 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
543 pager_init(PERF_PAGER_ENVIRONMENT);
545 /* The page_size is placed in util object. */
546 page_size = sysconf(_SC_PAGE_SIZE);
547 cacheline_size = sysconf(_SC_LEVEL1_DCACHE_LINESIZE);
549 if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
550 sysctl_perf_event_max_stack = value;
552 if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
553 sysctl_perf_event_max_contexts_per_stack = value;
555 cmd = extract_argv0_path(argv[0]);
561 perf_config(perf_default_config, NULL);
562 set_buildid_dir(NULL);
564 /* get debugfs/tracefs mount point from /proc/mounts */
565 tracing_path_mount();
568 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
570 * - cannot take flags in between the "perf" and the "xxxx".
571 * - cannot execute it externally (since it would just do
572 * the same thing over again)
574 * So we just directly call the internal command handler, and
575 * die if that one cannot handle it.
577 if (!prefixcmp(cmd, "perf-")) {
580 handle_internal_command(argc, argv);
581 fprintf(stderr, "cannot handle %s internally", cmd);
584 if (!prefixcmp(cmd, "trace")) {
585 #ifdef HAVE_LIBAUDIT_SUPPORT
588 return cmd_trace(argc, argv, NULL);
591 "trace command not available: missing audit-libs devel package at build time.\n");
595 /* Look for flags.. */
598 handle_options(&argv, &argc, NULL);
599 commit_pager_choice();
602 if (!prefixcmp(argv[0], "--"))
605 /* The user didn't specify a command; give them help */
606 printf("\n usage: %s\n\n", perf_usage_string);
607 list_common_cmds_help();
608 printf("\n %s\n\n", perf_more_info_string);
616 * We use PATH to find perf commands, but we prepend some higher
617 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
618 * environment, and the $(perfexecdir) from the Makefile at build
623 * Block SIGWINCH notifications so that the thread that wants it can
624 * unblock and get syscalls like select interrupted instead of waiting
625 * forever while the signal goes to some other non interested thread.
627 pthread__block_sigwinch();
632 static int done_help;
633 int was_alias = run_argv(&argc, &argv);
639 fprintf(stderr, "Expansion of alias '%s' failed; "
640 "'%s' is not a perf-command\n",
645 cmd = argv[0] = help_unknown_cmd(cmd);
651 fprintf(stderr, "Failed to run command '%s': %s\n",
652 cmd, strerror_r(errno, sbuf, sizeof(sbuf)));