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 "util/build-id.h"
13 #include "util/cache.h"
15 #include <internal/lib.h> // page_size
16 #include <subcmd/exec-cmd.h>
17 #include "util/config.h"
18 #include <subcmd/run-command.h>
19 #include "util/parse-events.h"
20 #include <subcmd/parse-options.h>
21 #include "util/bpf-loader.h"
22 #include "util/debug.h"
23 #include "util/event.h"
24 #include "util/util.h" // usage()
27 #include <api/fs/fs.h>
28 #include <api/fs/tracing_path.h>
29 #include <perf/core.h>
35 #include <sys/types.h>
38 #include <linux/kernel.h>
39 #include <linux/string.h>
40 #include <linux/zalloc.h>
42 const char perf_usage_string[] =
43 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
45 const char perf_more_info_string[] =
46 "See 'perf help COMMAND' for more information on a specific command.";
48 static int use_pager = -1;
49 const char *input_name;
53 int (*fn)(int, const char **);
57 static struct cmd_struct commands[] = {
58 { "archive", NULL, 0 },
59 { "buildid-cache", cmd_buildid_cache, 0 },
60 { "buildid-list", cmd_buildid_list, 0 },
61 { "config", cmd_config, 0 },
62 { "c2c", cmd_c2c, 0 },
63 { "diff", cmd_diff, 0 },
64 { "evlist", cmd_evlist, 0 },
65 { "help", cmd_help, 0 },
66 { "iostat", NULL, 0 },
67 { "kallsyms", cmd_kallsyms, 0 },
68 { "list", cmd_list, 0 },
69 { "record", cmd_record, 0 },
70 { "report", cmd_report, 0 },
71 { "bench", cmd_bench, 0 },
72 { "stat", cmd_stat, 0 },
73 #ifdef HAVE_LIBTRACEEVENT
74 { "timechart", cmd_timechart, 0 },
76 { "top", cmd_top, 0 },
77 { "annotate", cmd_annotate, 0 },
78 { "version", cmd_version, 0 },
79 { "script", cmd_script, 0 },
80 #ifdef HAVE_LIBTRACEEVENT
81 { "sched", cmd_sched, 0 },
83 #ifdef HAVE_LIBELF_SUPPORT
84 { "probe", cmd_probe, 0 },
86 #ifdef HAVE_LIBTRACEEVENT
87 { "kmem", cmd_kmem, 0 },
88 { "lock", cmd_lock, 0 },
90 { "kvm", cmd_kvm, 0 },
91 { "test", cmd_test, 0 },
92 #if defined(HAVE_LIBTRACEEVENT) && (defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT))
93 { "trace", cmd_trace, 0 },
95 { "inject", cmd_inject, 0 },
96 { "mem", cmd_mem, 0 },
97 { "data", cmd_data, 0 },
98 { "ftrace", cmd_ftrace, 0 },
99 { "daemon", cmd_daemon, 0 },
100 #ifdef HAVE_LIBTRACEEVENT
101 { "kwork", cmd_kwork, 0 },
105 struct pager_config {
110 static bool same_cmd_with_prefix(const char *var, struct pager_config *c,
113 return (strstarts(var, header) && !strcmp(var + strlen(header), c->cmd));
116 static int pager_command_config(const char *var, const char *value, void *data)
118 struct pager_config *c = data;
119 if (same_cmd_with_prefix(var, c, "pager."))
120 c->val = perf_config_bool(var, value);
124 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
125 static int check_pager_config(const char *cmd)
128 struct pager_config c;
131 err = perf_config(pager_command_config, &c);
135 static int browser_command_config(const char *var, const char *value, void *data)
137 struct pager_config *c = data;
138 if (same_cmd_with_prefix(var, c, "tui."))
139 c->val = perf_config_bool(var, value);
140 if (same_cmd_with_prefix(var, c, "gtk."))
141 c->val = perf_config_bool(var, value) ? 2 : 0;
146 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
147 * and -1 for "not specified"
149 static int check_browser_config(const char *cmd)
152 struct pager_config c;
155 err = perf_config(browser_command_config, &c);
159 static void commit_pager_choice(void)
163 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
173 struct option options[] = {
174 OPT_ARGUMENT("help", "help"),
175 OPT_ARGUMENT("version", "version"),
176 OPT_ARGUMENT("exec-path", "exec-path"),
177 OPT_ARGUMENT("html-path", "html-path"),
178 OPT_ARGUMENT("paginate", "paginate"),
179 OPT_ARGUMENT("no-pager", "no-pager"),
180 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
181 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
182 OPT_ARGUMENT("list-cmds", "list-cmds"),
183 OPT_ARGUMENT("list-opts", "list-opts"),
184 OPT_ARGUMENT("debug", "debug"),
188 static int handle_options(const char ***argv, int *argc, int *envchanged)
193 const char *cmd = (*argv)[0];
198 * For legacy reasons, the "version" and "help"
199 * commands can be written with "--" prepended
200 * to make them look like flags.
202 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
206 * Shortcut for '-h' and '-v' options to invoke help
207 * and version command.
209 if (!strcmp(cmd, "-h")) {
210 (*argv)[0] = "--help";
214 if (!strcmp(cmd, "-v")) {
215 (*argv)[0] = "--version";
219 if (!strcmp(cmd, "-vv")) {
220 (*argv)[0] = "version";
226 * Check remaining flags.
228 if (strstarts(cmd, CMD_EXEC_PATH)) {
229 cmd += strlen(CMD_EXEC_PATH);
231 set_argv_exec_path(cmd + 1);
233 puts(get_argv_exec_path());
236 } else if (!strcmp(cmd, "--html-path")) {
237 puts(system_path(PERF_HTML_PATH));
239 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
241 } else if (!strcmp(cmd, "--no-pager")) {
245 } else if (!strcmp(cmd, "--debugfs-dir")) {
247 fprintf(stderr, "No directory given for --debugfs-dir.\n");
248 usage(perf_usage_string);
250 tracing_path_set((*argv)[1]);
255 } else if (!strcmp(cmd, "--buildid-dir")) {
257 fprintf(stderr, "No directory given for --buildid-dir.\n");
258 usage(perf_usage_string);
260 set_buildid_dir((*argv)[1]);
265 } else if (strstarts(cmd, CMD_DEBUGFS_DIR)) {
266 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
267 fprintf(stderr, "dir: %s\n", tracing_path_mount());
270 } else if (!strcmp(cmd, "--list-cmds")) {
273 for (i = 0; i < ARRAY_SIZE(commands); i++) {
274 struct cmd_struct *p = commands+i;
275 printf("%s ", p->cmd);
279 } else if (!strcmp(cmd, "--list-opts")) {
282 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
283 struct option *p = options+i;
284 printf("--%s ", p->long_name);
288 } else if (!strcmp(cmd, "--debug")) {
290 fprintf(stderr, "No variable specified for --debug.\n");
291 usage(perf_usage_string);
293 if (perf_debug_option((*argv)[1]))
294 usage(perf_usage_string);
299 fprintf(stderr, "Unknown option: %s\n", cmd);
300 usage(perf_usage_string);
310 #define RUN_SETUP (1<<0)
311 #define USE_PAGER (1<<1)
313 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
317 char sbuf[STRERR_BUFSIZE];
319 if (use_browser == -1)
320 use_browser = check_browser_config(p->cmd);
322 if (use_pager == -1 && p->option & RUN_SETUP)
323 use_pager = check_pager_config(p->cmd);
324 if (use_pager == -1 && p->option & USE_PAGER)
326 commit_pager_choice();
328 perf_env__init(&perf_env);
329 perf_env__set_cmdline(&perf_env, argc, argv);
330 status = p->fn(argc, argv);
332 exit_browser(status);
333 perf_env__exit(&perf_env);
337 return status & 0xff;
339 /* Somebody closed stdout? */
340 if (fstat(fileno(stdout), &st))
342 /* Ignore write errors for pipes and sockets.. */
343 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
347 /* Check for ENOSPC and EIO errors.. */
348 if (fflush(stdout)) {
349 fprintf(stderr, "write failure on standard output: %s",
350 str_error_r(errno, sbuf, sizeof(sbuf)));
353 if (ferror(stdout)) {
354 fprintf(stderr, "unknown write failure on standard output");
357 if (fclose(stdout)) {
358 fprintf(stderr, "close failed on standard output: %s",
359 str_error_r(errno, sbuf, sizeof(sbuf)));
367 static void handle_internal_command(int argc, const char **argv)
369 const char *cmd = argv[0];
372 /* Turn "perf cmd --help" into "perf help cmd" */
373 if (argc > 1 && !strcmp(argv[1], "--help")) {
375 argv[0] = cmd = "help";
378 for (i = 0; i < ARRAY_SIZE(commands); i++) {
379 struct cmd_struct *p = commands+i;
382 if (strcmp(p->cmd, cmd))
384 exit(run_builtin(p, argc, argv));
388 static void execv_dashed_external(const char **argv)
394 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
398 * argv[0] must be the perf command, but the argv array
399 * belongs to the caller, and may be reused in
400 * subsequent loop iterations. Save argv[0] and
401 * restore it on error.
407 * if we fail because the command is not found, it is
408 * OK to return. Otherwise, we just pass along the status code.
410 status = run_command_v_opt(argv, 0);
411 if (status != -ERR_RUN_COMMAND_EXEC) {
412 if (IS_RUN_COMMAND_ERR(status)) {
414 pr_err("FATAL: unable to run '%s'", argv[0]);
419 errno = ENOENT; /* as if we called execvp */
425 static int run_argv(int *argcp, const char ***argv)
427 /* See if it's an internal command */
428 handle_internal_command(*argcp, *argv);
430 /* .. then try the external ones */
431 execv_dashed_external(*argv);
435 static void pthread__block_sigwinch(void)
440 sigaddset(&set, SIGWINCH);
441 pthread_sigmask(SIG_BLOCK, &set, NULL);
444 void pthread__unblock_sigwinch(void)
449 sigaddset(&set, SIGWINCH);
450 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
453 static int libperf_print(enum libperf_print_level level,
454 const char *fmt, va_list ap)
456 return veprintf(level, verbose, fmt, ap);
459 int main(int argc, const char **argv)
463 char sbuf[STRERR_BUFSIZE];
468 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
469 pager_init(PERF_PAGER_ENVIRONMENT);
471 libperf_init(libperf_print);
473 cmd = extract_argv0_path(argv[0]);
479 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
480 config_exclusive_filename = getenv("PERF_CONFIG");
482 err = perf_config(perf_default_config, NULL);
485 set_buildid_dir(NULL);
488 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
490 * - cannot take flags in between the "perf" and the "xxxx".
491 * - cannot execute it externally (since it would just do
492 * the same thing over again)
494 * So we just directly call the internal command handler. If that one
495 * fails to handle this, then maybe we just run a renamed perf binary
496 * that contains a dash in its name. To handle this scenario, we just
497 * fall through and ignore the "xxxx" part of the command string.
499 if (strstarts(cmd, "perf-")) {
502 handle_internal_command(argc, argv);
504 * If the command is handled, the above function does not
505 * return undo changes and fall through in such a case.
510 if (strstarts(cmd, "trace")) {
511 #ifndef HAVE_LIBTRACEEVENT
513 "trace command not available: missing libtraceevent devel package at build time.\n");
515 #elif !defined(HAVE_LIBAUDIT_SUPPORT) && !defined(HAVE_SYSCALL_TABLE_SUPPORT)
517 "trace command not available: missing audit-libs devel package at build time.\n");
522 return cmd_trace(argc, argv);
525 /* Look for flags.. */
528 handle_options(&argv, &argc, NULL);
529 commit_pager_choice();
532 if (strstarts(argv[0], "--"))
535 /* The user didn't specify a command; give them help */
536 printf("\n usage: %s\n\n", perf_usage_string);
537 list_common_cmds_help();
538 printf("\n %s\n\n", perf_more_info_string);
546 * We use PATH to find perf commands, but we prepend some higher
547 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
548 * environment, and the $(perfexecdir) from the Makefile at build
553 * Block SIGWINCH notifications so that the thread that wants it can
554 * unblock and get syscalls like select interrupted instead of waiting
555 * forever while the signal goes to some other non interested thread.
557 pthread__block_sigwinch();
560 static int done_help;
562 run_argv(&argc, &argv);
568 cmd = argv[0] = help_unknown_cmd(cmd);
574 fprintf(stderr, "Failed to run command '%s': %s\n",
575 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));