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>
27 #include <linux/kernel.h>
29 const char perf_usage_string[] =
30 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
32 const char perf_more_info_string[] =
33 "See 'perf help COMMAND' for more information on a specific command.";
35 static int use_pager = -1;
36 const char *input_name;
40 int (*fn)(int, const char **);
44 static struct cmd_struct commands[] = {
45 { "buildid-cache", cmd_buildid_cache, 0 },
46 { "buildid-list", cmd_buildid_list, 0 },
47 { "config", cmd_config, 0 },
48 { "c2c", cmd_c2c, 0 },
49 { "diff", cmd_diff, 0 },
50 { "evlist", cmd_evlist, 0 },
51 { "help", cmd_help, 0 },
52 { "kallsyms", cmd_kallsyms, 0 },
53 { "list", cmd_list, 0 },
54 { "record", cmd_record, 0 },
55 { "report", cmd_report, 0 },
56 { "bench", cmd_bench, 0 },
57 { "stat", cmd_stat, 0 },
58 { "timechart", cmd_timechart, 0 },
59 { "top", cmd_top, 0 },
60 { "annotate", cmd_annotate, 0 },
61 { "version", cmd_version, 0 },
62 { "script", cmd_script, 0 },
63 { "sched", cmd_sched, 0 },
64 #ifdef HAVE_LIBELF_SUPPORT
65 { "probe", cmd_probe, 0 },
67 { "kmem", cmd_kmem, 0 },
68 { "lock", cmd_lock, 0 },
69 { "kvm", cmd_kvm, 0 },
70 { "test", cmd_test, 0 },
71 #ifdef HAVE_LIBAUDIT_SUPPORT
72 { "trace", cmd_trace, 0 },
74 { "inject", cmd_inject, 0 },
75 { "mem", cmd_mem, 0 },
76 { "data", cmd_data, 0 },
77 { "ftrace", cmd_ftrace, 0 },
85 static int pager_command_config(const char *var, const char *value, void *data)
87 struct pager_config *c = data;
88 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
89 c->val = perf_config_bool(var, value);
93 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
94 int check_pager_config(const char *cmd)
97 struct pager_config c;
100 err = perf_config(pager_command_config, &c);
104 static int browser_command_config(const char *var, const char *value, void *data)
106 struct pager_config *c = data;
107 if (!prefixcmp(var, "tui.") && !strcmp(var + 4, c->cmd))
108 c->val = perf_config_bool(var, value);
109 if (!prefixcmp(var, "gtk.") && !strcmp(var + 4, c->cmd))
110 c->val = perf_config_bool(var, value) ? 2 : 0;
115 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
116 * and -1 for "not specified"
118 static int check_browser_config(const char *cmd)
121 struct pager_config c;
124 err = perf_config(browser_command_config, &c);
128 static void commit_pager_choice(void)
132 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
142 struct option options[] = {
143 OPT_ARGUMENT("help", "help"),
144 OPT_ARGUMENT("version", "version"),
145 OPT_ARGUMENT("exec-path", "exec-path"),
146 OPT_ARGUMENT("html-path", "html-path"),
147 OPT_ARGUMENT("paginate", "paginate"),
148 OPT_ARGUMENT("no-pager", "no-pager"),
149 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
150 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
151 OPT_ARGUMENT("list-cmds", "list-cmds"),
152 OPT_ARGUMENT("list-opts", "list-opts"),
153 OPT_ARGUMENT("debug", "debug"),
157 static int handle_options(const char ***argv, int *argc, int *envchanged)
162 const char *cmd = (*argv)[0];
167 * For legacy reasons, the "version" and "help"
168 * commands can be written with "--" prepended
169 * to make them look like flags.
171 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
175 * Shortcut for '-h' and '-v' options to invoke help
176 * and version command.
178 if (!strcmp(cmd, "-h")) {
179 (*argv)[0] = "--help";
183 if (!strcmp(cmd, "-v")) {
184 (*argv)[0] = "--version";
189 * Check remaining flags.
191 if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
192 cmd += strlen(CMD_EXEC_PATH);
194 set_argv_exec_path(cmd + 1);
196 puts(get_argv_exec_path());
199 } else if (!strcmp(cmd, "--html-path")) {
200 puts(system_path(PERF_HTML_PATH));
202 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
204 } else if (!strcmp(cmd, "--no-pager")) {
208 } else if (!strcmp(cmd, "--debugfs-dir")) {
210 fprintf(stderr, "No directory given for --debugfs-dir.\n");
211 usage(perf_usage_string);
213 tracing_path_set((*argv)[1]);
218 } else if (!strcmp(cmd, "--buildid-dir")) {
220 fprintf(stderr, "No directory given for --buildid-dir.\n");
221 usage(perf_usage_string);
223 set_buildid_dir((*argv)[1]);
228 } else if (!prefixcmp(cmd, CMD_DEBUGFS_DIR)) {
229 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
230 fprintf(stderr, "dir: %s\n", tracing_path);
233 } else if (!strcmp(cmd, "--list-cmds")) {
236 for (i = 0; i < ARRAY_SIZE(commands); i++) {
237 struct cmd_struct *p = commands+i;
238 printf("%s ", p->cmd);
242 } else if (!strcmp(cmd, "--list-opts")) {
245 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
246 struct option *p = options+i;
247 printf("--%s ", p->long_name);
251 } else if (!strcmp(cmd, "--debug")) {
253 fprintf(stderr, "No variable specified for --debug.\n");
254 usage(perf_usage_string);
256 if (perf_debug_option((*argv)[1]))
257 usage(perf_usage_string);
262 fprintf(stderr, "Unknown option: %s\n", cmd);
263 usage(perf_usage_string);
273 #define RUN_SETUP (1<<0)
274 #define USE_PAGER (1<<1)
276 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
280 char sbuf[STRERR_BUFSIZE];
282 if (use_browser == -1)
283 use_browser = check_browser_config(p->cmd);
285 if (use_pager == -1 && p->option & RUN_SETUP)
286 use_pager = check_pager_config(p->cmd);
287 if (use_pager == -1 && p->option & USE_PAGER)
289 commit_pager_choice();
291 perf_env__set_cmdline(&perf_env, argc, argv);
292 status = p->fn(argc, argv);
294 exit_browser(status);
295 perf_env__exit(&perf_env);
299 return status & 0xff;
301 /* Somebody closed stdout? */
302 if (fstat(fileno(stdout), &st))
304 /* Ignore write errors for pipes and sockets.. */
305 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
309 /* Check for ENOSPC and EIO errors.. */
310 if (fflush(stdout)) {
311 fprintf(stderr, "write failure on standard output: %s",
312 str_error_r(errno, sbuf, sizeof(sbuf)));
315 if (ferror(stdout)) {
316 fprintf(stderr, "unknown write failure on standard output");
319 if (fclose(stdout)) {
320 fprintf(stderr, "close failed on standard output: %s",
321 str_error_r(errno, sbuf, sizeof(sbuf)));
329 static void handle_internal_command(int argc, const char **argv)
331 const char *cmd = argv[0];
334 /* Turn "perf cmd --help" into "perf help cmd" */
335 if (argc > 1 && !strcmp(argv[1], "--help")) {
337 argv[0] = cmd = "help";
340 for (i = 0; i < ARRAY_SIZE(commands); i++) {
341 struct cmd_struct *p = commands+i;
342 if (strcmp(p->cmd, cmd))
344 exit(run_builtin(p, argc, argv));
348 static void execv_dashed_external(const char **argv)
354 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
358 * argv[0] must be the perf command, but the argv array
359 * belongs to the caller, and may be reused in
360 * subsequent loop iterations. Save argv[0] and
361 * restore it on error.
367 * if we fail because the command is not found, it is
368 * OK to return. Otherwise, we just pass along the status code.
370 status = run_command_v_opt(argv, 0);
371 if (status != -ERR_RUN_COMMAND_EXEC) {
372 if (IS_RUN_COMMAND_ERR(status)) {
374 pr_err("FATAL: unable to run '%s'", argv[0]);
379 errno = ENOENT; /* as if we called execvp */
385 static int run_argv(int *argcp, const char ***argv)
387 /* See if it's an internal command */
388 handle_internal_command(*argcp, *argv);
390 /* .. then try the external ones */
391 execv_dashed_external(*argv);
395 static void pthread__block_sigwinch(void)
400 sigaddset(&set, SIGWINCH);
401 pthread_sigmask(SIG_BLOCK, &set, NULL);
404 void pthread__unblock_sigwinch(void)
409 sigaddset(&set, SIGWINCH);
410 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
413 #ifdef _SC_LEVEL1_DCACHE_LINESIZE
414 #define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
416 static void cache_line_size(int *cacheline_sizep)
418 if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
419 pr_debug("cannot determine cache line size");
423 int main(int argc, const char **argv)
427 char sbuf[STRERR_BUFSIZE];
431 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
432 pager_init(PERF_PAGER_ENVIRONMENT);
434 /* The page_size is placed in util object. */
435 page_size = sysconf(_SC_PAGE_SIZE);
436 cache_line_size(&cacheline_size);
438 if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
439 sysctl_perf_event_max_stack = value;
441 if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
442 sysctl_perf_event_max_contexts_per_stack = value;
444 cmd = extract_argv0_path(argv[0]);
451 err = perf_config(perf_default_config, NULL);
454 set_buildid_dir(NULL);
456 /* get debugfs/tracefs mount point from /proc/mounts */
457 tracing_path_mount();
460 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
462 * - cannot take flags in between the "perf" and the "xxxx".
463 * - cannot execute it externally (since it would just do
464 * the same thing over again)
466 * So we just directly call the internal command handler, and
467 * die if that one cannot handle it.
469 if (!prefixcmp(cmd, "perf-")) {
472 handle_internal_command(argc, argv);
473 fprintf(stderr, "cannot handle %s internally", cmd);
476 if (!prefixcmp(cmd, "trace")) {
477 #ifdef HAVE_LIBAUDIT_SUPPORT
480 return cmd_trace(argc, argv);
483 "trace command not available: missing audit-libs devel package at build time.\n");
487 /* Look for flags.. */
490 handle_options(&argv, &argc, NULL);
491 commit_pager_choice();
494 if (!prefixcmp(argv[0], "--"))
497 /* The user didn't specify a command; give them help */
498 printf("\n usage: %s\n\n", perf_usage_string);
499 list_common_cmds_help();
500 printf("\n %s\n\n", perf_more_info_string);
508 * We use PATH to find perf commands, but we prepend some higher
509 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
510 * environment, and the $(perfexecdir) from the Makefile at build
515 * Block SIGWINCH notifications so that the thread that wants it can
516 * unblock and get syscalls like select interrupted instead of waiting
517 * forever while the signal goes to some other non interested thread.
519 pthread__block_sigwinch();
524 static int done_help;
526 run_argv(&argc, &argv);
532 cmd = argv[0] = help_unknown_cmd(cmd);
538 fprintf(stderr, "Failed to run command '%s': %s\n",
539 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));