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 { "timechart", cmd_timechart, 0 },
74 { "top", cmd_top, 0 },
75 { "annotate", cmd_annotate, 0 },
76 { "version", cmd_version, 0 },
77 { "script", cmd_script, 0 },
78 { "sched", cmd_sched, 0 },
79 #ifdef HAVE_LIBELF_SUPPORT
80 { "probe", cmd_probe, 0 },
82 { "kmem", cmd_kmem, 0 },
83 { "lock", cmd_lock, 0 },
84 { "kvm", cmd_kvm, 0 },
85 { "test", cmd_test, 0 },
86 #if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
87 { "trace", cmd_trace, 0 },
89 { "inject", cmd_inject, 0 },
90 { "mem", cmd_mem, 0 },
91 { "data", cmd_data, 0 },
92 { "ftrace", cmd_ftrace, 0 },
93 { "daemon", cmd_daemon, 0 },
94 { "kwork", cmd_kwork, 0 },
102 static int pager_command_config(const char *var, const char *value, void *data)
104 struct pager_config *c = data;
105 if (strstarts(var, "pager.") && !strcmp(var + 6, c->cmd))
106 c->val = perf_config_bool(var, value);
110 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
111 static int check_pager_config(const char *cmd)
114 struct pager_config c;
117 err = perf_config(pager_command_config, &c);
121 static int browser_command_config(const char *var, const char *value, void *data)
123 struct pager_config *c = data;
124 if (strstarts(var, "tui.") && !strcmp(var + 4, c->cmd))
125 c->val = perf_config_bool(var, value);
126 if (strstarts(var, "gtk.") && !strcmp(var + 4, c->cmd))
127 c->val = perf_config_bool(var, value) ? 2 : 0;
132 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
133 * and -1 for "not specified"
135 static int check_browser_config(const char *cmd)
138 struct pager_config c;
141 err = perf_config(browser_command_config, &c);
145 static void commit_pager_choice(void)
149 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
159 struct option options[] = {
160 OPT_ARGUMENT("help", "help"),
161 OPT_ARGUMENT("version", "version"),
162 OPT_ARGUMENT("exec-path", "exec-path"),
163 OPT_ARGUMENT("html-path", "html-path"),
164 OPT_ARGUMENT("paginate", "paginate"),
165 OPT_ARGUMENT("no-pager", "no-pager"),
166 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
167 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
168 OPT_ARGUMENT("list-cmds", "list-cmds"),
169 OPT_ARGUMENT("list-opts", "list-opts"),
170 OPT_ARGUMENT("debug", "debug"),
174 static int handle_options(const char ***argv, int *argc, int *envchanged)
179 const char *cmd = (*argv)[0];
184 * For legacy reasons, the "version" and "help"
185 * commands can be written with "--" prepended
186 * to make them look like flags.
188 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
192 * Shortcut for '-h' and '-v' options to invoke help
193 * and version command.
195 if (!strcmp(cmd, "-h")) {
196 (*argv)[0] = "--help";
200 if (!strcmp(cmd, "-v")) {
201 (*argv)[0] = "--version";
205 if (!strcmp(cmd, "-vv")) {
206 (*argv)[0] = "version";
212 * Check remaining flags.
214 if (strstarts(cmd, CMD_EXEC_PATH)) {
215 cmd += strlen(CMD_EXEC_PATH);
217 set_argv_exec_path(cmd + 1);
219 puts(get_argv_exec_path());
222 } else if (!strcmp(cmd, "--html-path")) {
223 puts(system_path(PERF_HTML_PATH));
225 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
227 } else if (!strcmp(cmd, "--no-pager")) {
231 } else if (!strcmp(cmd, "--debugfs-dir")) {
233 fprintf(stderr, "No directory given for --debugfs-dir.\n");
234 usage(perf_usage_string);
236 tracing_path_set((*argv)[1]);
241 } else if (!strcmp(cmd, "--buildid-dir")) {
243 fprintf(stderr, "No directory given for --buildid-dir.\n");
244 usage(perf_usage_string);
246 set_buildid_dir((*argv)[1]);
251 } else if (strstarts(cmd, CMD_DEBUGFS_DIR)) {
252 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
253 fprintf(stderr, "dir: %s\n", tracing_path_mount());
256 } else if (!strcmp(cmd, "--list-cmds")) {
259 for (i = 0; i < ARRAY_SIZE(commands); i++) {
260 struct cmd_struct *p = commands+i;
261 printf("%s ", p->cmd);
265 } else if (!strcmp(cmd, "--list-opts")) {
268 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
269 struct option *p = options+i;
270 printf("--%s ", p->long_name);
274 } else if (!strcmp(cmd, "--debug")) {
276 fprintf(stderr, "No variable specified for --debug.\n");
277 usage(perf_usage_string);
279 if (perf_debug_option((*argv)[1]))
280 usage(perf_usage_string);
285 fprintf(stderr, "Unknown option: %s\n", cmd);
286 usage(perf_usage_string);
296 #define RUN_SETUP (1<<0)
297 #define USE_PAGER (1<<1)
299 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
303 char sbuf[STRERR_BUFSIZE];
305 if (use_browser == -1)
306 use_browser = check_browser_config(p->cmd);
308 if (use_pager == -1 && p->option & RUN_SETUP)
309 use_pager = check_pager_config(p->cmd);
310 if (use_pager == -1 && p->option & USE_PAGER)
312 commit_pager_choice();
314 perf_env__init(&perf_env);
315 perf_env__set_cmdline(&perf_env, argc, argv);
316 status = p->fn(argc, argv);
318 exit_browser(status);
319 perf_env__exit(&perf_env);
323 return status & 0xff;
325 /* Somebody closed stdout? */
326 if (fstat(fileno(stdout), &st))
328 /* Ignore write errors for pipes and sockets.. */
329 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
333 /* Check for ENOSPC and EIO errors.. */
334 if (fflush(stdout)) {
335 fprintf(stderr, "write failure on standard output: %s",
336 str_error_r(errno, sbuf, sizeof(sbuf)));
339 if (ferror(stdout)) {
340 fprintf(stderr, "unknown write failure on standard output");
343 if (fclose(stdout)) {
344 fprintf(stderr, "close failed on standard output: %s",
345 str_error_r(errno, sbuf, sizeof(sbuf)));
353 static void handle_internal_command(int argc, const char **argv)
355 const char *cmd = argv[0];
358 /* Turn "perf cmd --help" into "perf help cmd" */
359 if (argc > 1 && !strcmp(argv[1], "--help")) {
361 argv[0] = cmd = "help";
364 for (i = 0; i < ARRAY_SIZE(commands); i++) {
365 struct cmd_struct *p = commands+i;
368 if (strcmp(p->cmd, cmd))
370 exit(run_builtin(p, argc, argv));
374 static void execv_dashed_external(const char **argv)
380 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
384 * argv[0] must be the perf command, but the argv array
385 * belongs to the caller, and may be reused in
386 * subsequent loop iterations. Save argv[0] and
387 * restore it on error.
393 * if we fail because the command is not found, it is
394 * OK to return. Otherwise, we just pass along the status code.
396 status = run_command_v_opt(argv, 0);
397 if (status != -ERR_RUN_COMMAND_EXEC) {
398 if (IS_RUN_COMMAND_ERR(status)) {
400 pr_err("FATAL: unable to run '%s'", argv[0]);
405 errno = ENOENT; /* as if we called execvp */
411 static int run_argv(int *argcp, const char ***argv)
413 /* See if it's an internal command */
414 handle_internal_command(*argcp, *argv);
416 /* .. then try the external ones */
417 execv_dashed_external(*argv);
421 static void pthread__block_sigwinch(void)
426 sigaddset(&set, SIGWINCH);
427 pthread_sigmask(SIG_BLOCK, &set, NULL);
430 void pthread__unblock_sigwinch(void)
435 sigaddset(&set, SIGWINCH);
436 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
439 static int libperf_print(enum libperf_print_level level,
440 const char *fmt, va_list ap)
442 return veprintf(level, verbose, fmt, ap);
445 int main(int argc, const char **argv)
449 char sbuf[STRERR_BUFSIZE];
454 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
455 pager_init(PERF_PAGER_ENVIRONMENT);
457 libperf_init(libperf_print);
459 cmd = extract_argv0_path(argv[0]);
465 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
466 config_exclusive_filename = getenv("PERF_CONFIG");
468 err = perf_config(perf_default_config, NULL);
471 set_buildid_dir(NULL);
474 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
476 * - cannot take flags in between the "perf" and the "xxxx".
477 * - cannot execute it externally (since it would just do
478 * the same thing over again)
480 * So we just directly call the internal command handler. If that one
481 * fails to handle this, then maybe we just run a renamed perf binary
482 * that contains a dash in its name. To handle this scenario, we just
483 * fall through and ignore the "xxxx" part of the command string.
485 if (strstarts(cmd, "perf-")) {
488 handle_internal_command(argc, argv);
490 * If the command is handled, the above function does not
491 * return undo changes and fall through in such a case.
496 if (strstarts(cmd, "trace")) {
497 #if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
500 return cmd_trace(argc, argv);
503 "trace command not available: missing audit-libs devel package at build time.\n");
507 /* Look for flags.. */
510 handle_options(&argv, &argc, NULL);
511 commit_pager_choice();
514 if (strstarts(argv[0], "--"))
517 /* The user didn't specify a command; give them help */
518 printf("\n usage: %s\n\n", perf_usage_string);
519 list_common_cmds_help();
520 printf("\n %s\n\n", perf_more_info_string);
528 * We use PATH to find perf commands, but we prepend some higher
529 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
530 * environment, and the $(perfexecdir) from the Makefile at build
535 * Block SIGWINCH notifications so that the thread that wants it can
536 * unblock and get syscalls like select interrupted instead of waiting
537 * forever while the signal goes to some other non interested thread.
539 pthread__block_sigwinch();
542 static int done_help;
544 run_argv(&argc, &argv);
550 cmd = argv[0] = help_unknown_cmd(cmd);
556 fprintf(stderr, "Failed to run command '%s': %s\n",
557 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));