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/config.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("debugfs-dir", "debugfs-dir"),
143 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
144 OPT_ARGUMENT("list-cmds", "list-cmds"),
145 OPT_ARGUMENT("list-opts", "list-opts"),
146 OPT_ARGUMENT("debug", "debug"),
150 static int handle_options(const char ***argv, int *argc, int *envchanged)
155 const char *cmd = (*argv)[0];
160 * For legacy reasons, the "version" and "help"
161 * commands can be written with "--" prepended
162 * to make them look like flags.
164 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
168 * Shortcut for '-h' and '-v' options to invoke help
169 * and version command.
171 if (!strcmp(cmd, "-h")) {
172 (*argv)[0] = "--help";
176 if (!strcmp(cmd, "-v")) {
177 (*argv)[0] = "--version";
182 * Check remaining flags.
184 if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
185 cmd += strlen(CMD_EXEC_PATH);
187 set_argv_exec_path(cmd + 1);
189 puts(get_argv_exec_path());
192 } else if (!strcmp(cmd, "--html-path")) {
193 puts(system_path(PERF_HTML_PATH));
195 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
197 } else if (!strcmp(cmd, "--no-pager")) {
201 } else if (!strcmp(cmd, "--debugfs-dir")) {
203 fprintf(stderr, "No directory given for --debugfs-dir.\n");
204 usage(perf_usage_string);
206 tracing_path_set((*argv)[1]);
211 } else if (!strcmp(cmd, "--buildid-dir")) {
213 fprintf(stderr, "No directory given for --buildid-dir.\n");
214 usage(perf_usage_string);
216 set_buildid_dir((*argv)[1]);
221 } else if (!prefixcmp(cmd, CMD_DEBUGFS_DIR)) {
222 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
223 fprintf(stderr, "dir: %s\n", tracing_path);
226 } else if (!strcmp(cmd, "--list-cmds")) {
229 for (i = 0; i < ARRAY_SIZE(commands); i++) {
230 struct cmd_struct *p = commands+i;
231 printf("%s ", p->cmd);
235 } else if (!strcmp(cmd, "--list-opts")) {
238 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
239 struct option *p = options+i;
240 printf("--%s ", p->long_name);
244 } else if (!strcmp(cmd, "--debug")) {
246 fprintf(stderr, "No variable specified for --debug.\n");
247 usage(perf_usage_string);
249 if (perf_debug_option((*argv)[1]))
250 usage(perf_usage_string);
255 fprintf(stderr, "Unknown option: %s\n", cmd);
256 usage(perf_usage_string);
266 static int handle_alias(int *argcp, const char ***argv)
268 int envchanged = 0, ret = 0, saved_errno = errno;
269 int count, option_count;
270 const char **new_argv;
271 const char *alias_command;
274 alias_command = (*argv)[0];
275 alias_string = alias_lookup(alias_command);
277 if (alias_string[0] == '!') {
281 if (strbuf_init(&buf, PATH_MAX) < 0 ||
282 strbuf_addstr(&buf, alias_string) < 0 ||
283 sq_quote_argv(&buf, (*argv) + 1,
285 die("Failed to allocate memory.");
287 alias_string = buf.buf;
289 ret = system(alias_string + 1);
290 if (ret >= 0 && WIFEXITED(ret) &&
291 WEXITSTATUS(ret) != 127)
292 exit(WEXITSTATUS(ret));
293 die("Failed to run '%s' when expanding alias '%s'",
294 alias_string + 1, alias_command);
296 count = split_cmdline(alias_string, &new_argv);
298 die("Bad alias.%s string", alias_command);
299 option_count = handle_options(&new_argv, &count, &envchanged);
301 die("alias '%s' changes environment variables\n"
302 "You can use '!perf' in the alias to do this.",
304 memmove(new_argv - option_count, new_argv,
305 count * sizeof(char *));
306 new_argv -= option_count;
309 die("empty alias for %s", alias_command);
311 if (!strcmp(alias_command, new_argv[0]))
312 die("recursive alias: %s", alias_command);
314 new_argv = realloc(new_argv, sizeof(char *) *
315 (count + *argcp + 1));
316 /* insert after command name */
317 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
318 new_argv[count + *argcp] = NULL;
331 const char perf_version_string[] = PERF_VERSION;
333 #define RUN_SETUP (1<<0)
334 #define USE_PAGER (1<<1)
336 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
341 char sbuf[STRERR_BUFSIZE];
344 if (p->option & RUN_SETUP)
345 prefix = NULL; /* setup_perf_directory(); */
347 if (use_browser == -1)
348 use_browser = check_browser_config(p->cmd);
350 if (use_pager == -1 && p->option & RUN_SETUP)
351 use_pager = check_pager_config(p->cmd);
352 if (use_pager == -1 && p->option & USE_PAGER)
354 commit_pager_choice();
356 perf_env__set_cmdline(&perf_env, argc, argv);
357 status = p->fn(argc, argv, prefix);
359 exit_browser(status);
360 perf_env__exit(&perf_env);
364 return status & 0xff;
366 /* Somebody closed stdout? */
367 if (fstat(fileno(stdout), &st))
369 /* Ignore write errors for pipes and sockets.. */
370 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
374 /* Check for ENOSPC and EIO errors.. */
375 if (fflush(stdout)) {
376 fprintf(stderr, "write failure on standard output: %s",
377 str_error_r(errno, sbuf, sizeof(sbuf)));
380 if (ferror(stdout)) {
381 fprintf(stderr, "unknown write failure on standard output");
384 if (fclose(stdout)) {
385 fprintf(stderr, "close failed on standard output: %s",
386 str_error_r(errno, sbuf, sizeof(sbuf)));
394 static void handle_internal_command(int argc, const char **argv)
396 const char *cmd = argv[0];
398 static const char ext[] = STRIP_EXTENSION;
400 if (sizeof(ext) > 1) {
401 i = strlen(argv[0]) - strlen(ext);
402 if (i > 0 && !strcmp(argv[0] + i, ext)) {
403 char *argv0 = strdup(argv[0]);
404 argv[0] = cmd = argv0;
409 /* Turn "perf cmd --help" into "perf help cmd" */
410 if (argc > 1 && !strcmp(argv[1], "--help")) {
412 argv[0] = cmd = "help";
415 for (i = 0; i < ARRAY_SIZE(commands); i++) {
416 struct cmd_struct *p = commands+i;
417 if (strcmp(p->cmd, cmd))
419 exit(run_builtin(p, argc, argv));
423 static void execv_dashed_external(const char **argv)
429 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
433 * argv[0] must be the perf command, but the argv array
434 * belongs to the caller, and may be reused in
435 * subsequent loop iterations. Save argv[0] and
436 * restore it on error.
442 * if we fail because the command is not found, it is
443 * OK to return. Otherwise, we just pass along the status code.
445 status = run_command_v_opt(argv, 0);
446 if (status != -ERR_RUN_COMMAND_EXEC) {
447 if (IS_RUN_COMMAND_ERR(status)) {
449 die("unable to run '%s'", argv[0]);
453 errno = ENOENT; /* as if we called execvp */
459 static int run_argv(int *argcp, const char ***argv)
464 /* See if it's an internal command */
465 handle_internal_command(*argcp, *argv);
467 /* .. then try the external ones */
468 execv_dashed_external(*argv);
470 /* It could be an alias -- this works around the insanity
471 * of overriding "perf log" with "perf show" by having
474 if (done_alias || !handle_alias(argcp, argv))
482 static void pthread__block_sigwinch(void)
487 sigaddset(&set, SIGWINCH);
488 pthread_sigmask(SIG_BLOCK, &set, NULL);
491 void pthread__unblock_sigwinch(void)
496 sigaddset(&set, SIGWINCH);
497 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
500 #ifdef _SC_LEVEL1_DCACHE_LINESIZE
501 #define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
503 static void cache_line_size(int *cacheline_sizep)
505 if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
506 pr_debug("cannot determine cache line size");
510 int main(int argc, const char **argv)
513 char sbuf[STRERR_BUFSIZE];
517 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
518 pager_init(PERF_PAGER_ENVIRONMENT);
520 /* The page_size is placed in util object. */
521 page_size = sysconf(_SC_PAGE_SIZE);
522 cache_line_size(&cacheline_size);
524 if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
525 sysctl_perf_event_max_stack = value;
527 if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
528 sysctl_perf_event_max_contexts_per_stack = value;
530 cmd = extract_argv0_path(argv[0]);
537 perf_config(perf_default_config, NULL);
538 set_buildid_dir(NULL);
540 /* get debugfs/tracefs mount point from /proc/mounts */
541 tracing_path_mount();
544 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
546 * - cannot take flags in between the "perf" and the "xxxx".
547 * - cannot execute it externally (since it would just do
548 * the same thing over again)
550 * So we just directly call the internal command handler, and
551 * die if that one cannot handle it.
553 if (!prefixcmp(cmd, "perf-")) {
556 handle_internal_command(argc, argv);
557 fprintf(stderr, "cannot handle %s internally", cmd);
560 if (!prefixcmp(cmd, "trace")) {
561 #ifdef HAVE_LIBAUDIT_SUPPORT
564 return cmd_trace(argc, argv, NULL);
567 "trace command not available: missing audit-libs devel package at build time.\n");
571 /* Look for flags.. */
574 handle_options(&argv, &argc, NULL);
575 commit_pager_choice();
578 if (!prefixcmp(argv[0], "--"))
581 /* The user didn't specify a command; give them help */
582 printf("\n usage: %s\n\n", perf_usage_string);
583 list_common_cmds_help();
584 printf("\n %s\n\n", perf_more_info_string);
592 * We use PATH to find perf commands, but we prepend some higher
593 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
594 * environment, and the $(perfexecdir) from the Makefile at build
599 * Block SIGWINCH notifications so that the thread that wants it can
600 * unblock and get syscalls like select interrupted instead of waiting
601 * forever while the signal goes to some other non interested thread.
603 pthread__block_sigwinch();
608 static int done_help;
609 int was_alias = run_argv(&argc, &argv);
615 fprintf(stderr, "Expansion of alias '%s' failed; "
616 "'%s' is not a perf-command\n",
621 cmd = argv[0] = help_unknown_cmd(cmd);
627 fprintf(stderr, "Failed to run command '%s': %s\n",
628 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));