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.";
32 static int use_pager = -1;
33 const char *input_name;
37 int (*fn)(int, const char **);
41 static struct cmd_struct commands[] = {
42 { "buildid-cache", cmd_buildid_cache, 0 },
43 { "buildid-list", cmd_buildid_list, 0 },
44 { "config", cmd_config, 0 },
45 { "c2c", cmd_c2c, 0 },
46 { "diff", cmd_diff, 0 },
47 { "evlist", cmd_evlist, 0 },
48 { "help", cmd_help, 0 },
49 { "kallsyms", cmd_kallsyms, 0 },
50 { "list", cmd_list, 0 },
51 { "record", cmd_record, 0 },
52 { "report", cmd_report, 0 },
53 { "bench", cmd_bench, 0 },
54 { "stat", cmd_stat, 0 },
55 { "timechart", cmd_timechart, 0 },
56 { "top", cmd_top, 0 },
57 { "annotate", cmd_annotate, 0 },
58 { "version", cmd_version, 0 },
59 { "script", cmd_script, 0 },
60 { "sched", cmd_sched, 0 },
61 #ifdef HAVE_LIBELF_SUPPORT
62 { "probe", cmd_probe, 0 },
64 { "kmem", cmd_kmem, 0 },
65 { "lock", cmd_lock, 0 },
66 { "kvm", cmd_kvm, 0 },
67 { "test", cmd_test, 0 },
68 #ifdef HAVE_LIBAUDIT_SUPPORT
69 { "trace", cmd_trace, 0 },
71 { "inject", cmd_inject, 0 },
72 { "mem", cmd_mem, 0 },
73 { "data", cmd_data, 0 },
74 { "ftrace", cmd_ftrace, 0 },
82 static int pager_command_config(const char *var, const char *value, void *data)
84 struct pager_config *c = data;
85 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
86 c->val = perf_config_bool(var, value);
90 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
91 int check_pager_config(const char *cmd)
94 struct pager_config c;
97 err = perf_config(pager_command_config, &c);
101 static int browser_command_config(const char *var, const char *value, void *data)
103 struct pager_config *c = data;
104 if (!prefixcmp(var, "tui.") && !strcmp(var + 4, c->cmd))
105 c->val = perf_config_bool(var, value);
106 if (!prefixcmp(var, "gtk.") && !strcmp(var + 4, c->cmd))
107 c->val = perf_config_bool(var, value) ? 2 : 0;
112 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
113 * and -1 for "not specified"
115 static int check_browser_config(const char *cmd)
118 struct pager_config c;
121 err = perf_config(browser_command_config, &c);
125 static void commit_pager_choice(void)
129 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
139 struct option options[] = {
140 OPT_ARGUMENT("help", "help"),
141 OPT_ARGUMENT("version", "version"),
142 OPT_ARGUMENT("exec-path", "exec-path"),
143 OPT_ARGUMENT("html-path", "html-path"),
144 OPT_ARGUMENT("paginate", "paginate"),
145 OPT_ARGUMENT("no-pager", "no-pager"),
146 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
147 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
148 OPT_ARGUMENT("list-cmds", "list-cmds"),
149 OPT_ARGUMENT("list-opts", "list-opts"),
150 OPT_ARGUMENT("debug", "debug"),
154 static int handle_options(const char ***argv, int *argc, int *envchanged)
159 const char *cmd = (*argv)[0];
164 * For legacy reasons, the "version" and "help"
165 * commands can be written with "--" prepended
166 * to make them look like flags.
168 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
172 * Shortcut for '-h' and '-v' options to invoke help
173 * and version command.
175 if (!strcmp(cmd, "-h")) {
176 (*argv)[0] = "--help";
180 if (!strcmp(cmd, "-v")) {
181 (*argv)[0] = "--version";
186 * Check remaining flags.
188 if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
189 cmd += strlen(CMD_EXEC_PATH);
191 set_argv_exec_path(cmd + 1);
193 puts(get_argv_exec_path());
196 } else if (!strcmp(cmd, "--html-path")) {
197 puts(system_path(PERF_HTML_PATH));
199 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
201 } else if (!strcmp(cmd, "--no-pager")) {
205 } else if (!strcmp(cmd, "--debugfs-dir")) {
207 fprintf(stderr, "No directory given for --debugfs-dir.\n");
208 usage(perf_usage_string);
210 tracing_path_set((*argv)[1]);
215 } else if (!strcmp(cmd, "--buildid-dir")) {
217 fprintf(stderr, "No directory given for --buildid-dir.\n");
218 usage(perf_usage_string);
220 set_buildid_dir((*argv)[1]);
225 } else if (!prefixcmp(cmd, CMD_DEBUGFS_DIR)) {
226 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
227 fprintf(stderr, "dir: %s\n", tracing_path);
230 } else if (!strcmp(cmd, "--list-cmds")) {
233 for (i = 0; i < ARRAY_SIZE(commands); i++) {
234 struct cmd_struct *p = commands+i;
235 printf("%s ", p->cmd);
239 } else if (!strcmp(cmd, "--list-opts")) {
242 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
243 struct option *p = options+i;
244 printf("--%s ", p->long_name);
248 } else if (!strcmp(cmd, "--debug")) {
250 fprintf(stderr, "No variable specified for --debug.\n");
251 usage(perf_usage_string);
253 if (perf_debug_option((*argv)[1]))
254 usage(perf_usage_string);
259 fprintf(stderr, "Unknown option: %s\n", cmd);
260 usage(perf_usage_string);
270 #define RUN_SETUP (1<<0)
271 #define USE_PAGER (1<<1)
273 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
277 char sbuf[STRERR_BUFSIZE];
279 if (use_browser == -1)
280 use_browser = check_browser_config(p->cmd);
282 if (use_pager == -1 && p->option & RUN_SETUP)
283 use_pager = check_pager_config(p->cmd);
284 if (use_pager == -1 && p->option & USE_PAGER)
286 commit_pager_choice();
288 perf_env__set_cmdline(&perf_env, argc, argv);
289 status = p->fn(argc, argv);
291 exit_browser(status);
292 perf_env__exit(&perf_env);
296 return status & 0xff;
298 /* Somebody closed stdout? */
299 if (fstat(fileno(stdout), &st))
301 /* Ignore write errors for pipes and sockets.. */
302 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
306 /* Check for ENOSPC and EIO errors.. */
307 if (fflush(stdout)) {
308 fprintf(stderr, "write failure on standard output: %s",
309 str_error_r(errno, sbuf, sizeof(sbuf)));
312 if (ferror(stdout)) {
313 fprintf(stderr, "unknown write failure on standard output");
316 if (fclose(stdout)) {
317 fprintf(stderr, "close failed on standard output: %s",
318 str_error_r(errno, sbuf, sizeof(sbuf)));
326 static void handle_internal_command(int argc, const char **argv)
328 const char *cmd = argv[0];
330 static const char ext[] = STRIP_EXTENSION;
332 if (sizeof(ext) > 1) {
333 i = strlen(argv[0]) - strlen(ext);
334 if (i > 0 && !strcmp(argv[0] + i, ext)) {
335 char *argv0 = strdup(argv[0]);
336 argv[0] = cmd = argv0;
341 /* Turn "perf cmd --help" into "perf help cmd" */
342 if (argc > 1 && !strcmp(argv[1], "--help")) {
344 argv[0] = cmd = "help";
347 for (i = 0; i < ARRAY_SIZE(commands); i++) {
348 struct cmd_struct *p = commands+i;
349 if (strcmp(p->cmd, cmd))
351 exit(run_builtin(p, argc, argv));
355 static void execv_dashed_external(const char **argv)
361 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
365 * argv[0] must be the perf command, but the argv array
366 * belongs to the caller, and may be reused in
367 * subsequent loop iterations. Save argv[0] and
368 * restore it on error.
374 * if we fail because the command is not found, it is
375 * OK to return. Otherwise, we just pass along the status code.
377 status = run_command_v_opt(argv, 0);
378 if (status != -ERR_RUN_COMMAND_EXEC) {
379 if (IS_RUN_COMMAND_ERR(status)) {
381 die("unable to run '%s'", argv[0]);
385 errno = ENOENT; /* as if we called execvp */
391 static int run_argv(int *argcp, const char ***argv)
393 /* See if it's an internal command */
394 handle_internal_command(*argcp, *argv);
396 /* .. then try the external ones */
397 execv_dashed_external(*argv);
401 static void pthread__block_sigwinch(void)
406 sigaddset(&set, SIGWINCH);
407 pthread_sigmask(SIG_BLOCK, &set, NULL);
410 void pthread__unblock_sigwinch(void)
415 sigaddset(&set, SIGWINCH);
416 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
419 #ifdef _SC_LEVEL1_DCACHE_LINESIZE
420 #define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
422 static void cache_line_size(int *cacheline_sizep)
424 if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
425 pr_debug("cannot determine cache line size");
429 int main(int argc, const char **argv)
433 char sbuf[STRERR_BUFSIZE];
437 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
438 pager_init(PERF_PAGER_ENVIRONMENT);
440 /* The page_size is placed in util object. */
441 page_size = sysconf(_SC_PAGE_SIZE);
442 cache_line_size(&cacheline_size);
444 if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
445 sysctl_perf_event_max_stack = value;
447 if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
448 sysctl_perf_event_max_contexts_per_stack = value;
450 cmd = extract_argv0_path(argv[0]);
457 err = perf_config(perf_default_config, NULL);
460 set_buildid_dir(NULL);
462 /* get debugfs/tracefs mount point from /proc/mounts */
463 tracing_path_mount();
466 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
468 * - cannot take flags in between the "perf" and the "xxxx".
469 * - cannot execute it externally (since it would just do
470 * the same thing over again)
472 * So we just directly call the internal command handler, and
473 * die if that one cannot handle it.
475 if (!prefixcmp(cmd, "perf-")) {
478 handle_internal_command(argc, argv);
479 fprintf(stderr, "cannot handle %s internally", cmd);
482 if (!prefixcmp(cmd, "trace")) {
483 #ifdef HAVE_LIBAUDIT_SUPPORT
486 return cmd_trace(argc, argv);
489 "trace command not available: missing audit-libs devel package at build time.\n");
493 /* Look for flags.. */
496 handle_options(&argv, &argc, NULL);
497 commit_pager_choice();
500 if (!prefixcmp(argv[0], "--"))
503 /* The user didn't specify a command; give them help */
504 printf("\n usage: %s\n\n", perf_usage_string);
505 list_common_cmds_help();
506 printf("\n %s\n\n", perf_more_info_string);
514 * We use PATH to find perf commands, but we prepend some higher
515 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
516 * environment, and the $(perfexecdir) from the Makefile at build
521 * Block SIGWINCH notifications so that the thread that wants it can
522 * unblock and get syscalls like select interrupted instead of waiting
523 * forever while the signal goes to some other non interested thread.
525 pthread__block_sigwinch();
530 static int done_help;
532 run_argv(&argc, &argv);
538 cmd = argv[0] = help_unknown_cmd(cmd);
544 fprintf(stderr, "Failed to run command '%s': %s\n",
545 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));