1 // SPDX-License-Identifier: GPL-2.0
5 * Performance analysis utility.
7 * This is the main hub from which the sub-commands (perf stat,
8 * perf top, perf record, perf report, etc.) are started.
13 #include <subcmd/exec-cmd.h>
14 #include "util/config.h"
15 #include "util/quote.h"
16 #include <subcmd/run-command.h>
17 #include "util/parse-events.h"
18 #include <subcmd/parse-options.h>
19 #include "util/bpf-loader.h"
20 #include "util/debug.h"
21 #include "util/event.h"
22 #include <api/fs/fs.h>
23 #include <api/fs/tracing_path.h>
29 #include <sys/types.h>
32 #include <linux/kernel.h>
34 const char perf_usage_string[] =
35 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
37 const char perf_more_info_string[] =
38 "See 'perf help COMMAND' for more information on a specific command.";
40 static int use_pager = -1;
41 const char *input_name;
45 int (*fn)(int, const char **);
49 static struct cmd_struct commands[] = {
50 { "buildid-cache", cmd_buildid_cache, 0 },
51 { "buildid-list", cmd_buildid_list, 0 },
52 { "config", cmd_config, 0 },
53 { "c2c", cmd_c2c, 0 },
54 { "diff", cmd_diff, 0 },
55 { "evlist", cmd_evlist, 0 },
56 { "help", cmd_help, 0 },
57 { "kallsyms", cmd_kallsyms, 0 },
58 { "list", cmd_list, 0 },
59 { "record", cmd_record, 0 },
60 { "report", cmd_report, 0 },
61 { "bench", cmd_bench, 0 },
62 { "stat", cmd_stat, 0 },
63 { "timechart", cmd_timechart, 0 },
64 { "top", cmd_top, 0 },
65 { "annotate", cmd_annotate, 0 },
66 { "version", cmd_version, 0 },
67 { "script", cmd_script, 0 },
68 { "sched", cmd_sched, 0 },
69 #ifdef HAVE_LIBELF_SUPPORT
70 { "probe", cmd_probe, 0 },
72 { "kmem", cmd_kmem, 0 },
73 { "lock", cmd_lock, 0 },
74 { "kvm", cmd_kvm, 0 },
75 { "test", cmd_test, 0 },
76 #if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
77 { "trace", cmd_trace, 0 },
79 { "inject", cmd_inject, 0 },
80 { "mem", cmd_mem, 0 },
81 { "data", cmd_data, 0 },
82 { "ftrace", cmd_ftrace, 0 },
90 static int pager_command_config(const char *var, const char *value, void *data)
92 struct pager_config *c = data;
93 if (strstarts(var, "pager.") && !strcmp(var + 6, c->cmd))
94 c->val = perf_config_bool(var, value);
98 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
99 static int check_pager_config(const char *cmd)
102 struct pager_config c;
105 err = perf_config(pager_command_config, &c);
109 static int browser_command_config(const char *var, const char *value, void *data)
111 struct pager_config *c = data;
112 if (strstarts(var, "tui.") && !strcmp(var + 4, c->cmd))
113 c->val = perf_config_bool(var, value);
114 if (strstarts(var, "gtk.") && !strcmp(var + 4, c->cmd))
115 c->val = perf_config_bool(var, value) ? 2 : 0;
120 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
121 * and -1 for "not specified"
123 static int check_browser_config(const char *cmd)
126 struct pager_config c;
129 err = perf_config(browser_command_config, &c);
133 static void commit_pager_choice(void)
137 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
147 struct option options[] = {
148 OPT_ARGUMENT("help", "help"),
149 OPT_ARGUMENT("version", "version"),
150 OPT_ARGUMENT("exec-path", "exec-path"),
151 OPT_ARGUMENT("html-path", "html-path"),
152 OPT_ARGUMENT("paginate", "paginate"),
153 OPT_ARGUMENT("no-pager", "no-pager"),
154 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
155 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
156 OPT_ARGUMENT("list-cmds", "list-cmds"),
157 OPT_ARGUMENT("list-opts", "list-opts"),
158 OPT_ARGUMENT("debug", "debug"),
162 static int handle_options(const char ***argv, int *argc, int *envchanged)
167 const char *cmd = (*argv)[0];
172 * For legacy reasons, the "version" and "help"
173 * commands can be written with "--" prepended
174 * to make them look like flags.
176 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
180 * Shortcut for '-h' and '-v' options to invoke help
181 * and version command.
183 if (!strcmp(cmd, "-h")) {
184 (*argv)[0] = "--help";
188 if (!strcmp(cmd, "-v")) {
189 (*argv)[0] = "--version";
193 if (!strcmp(cmd, "-vv")) {
194 (*argv)[0] = "version";
200 * Check remaining flags.
202 if (strstarts(cmd, CMD_EXEC_PATH)) {
203 cmd += strlen(CMD_EXEC_PATH);
205 set_argv_exec_path(cmd + 1);
207 puts(get_argv_exec_path());
210 } else if (!strcmp(cmd, "--html-path")) {
211 puts(system_path(PERF_HTML_PATH));
213 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
215 } else if (!strcmp(cmd, "--no-pager")) {
219 } else if (!strcmp(cmd, "--debugfs-dir")) {
221 fprintf(stderr, "No directory given for --debugfs-dir.\n");
222 usage(perf_usage_string);
224 tracing_path_set((*argv)[1]);
229 } else if (!strcmp(cmd, "--buildid-dir")) {
231 fprintf(stderr, "No directory given for --buildid-dir.\n");
232 usage(perf_usage_string);
234 set_buildid_dir((*argv)[1]);
239 } else if (strstarts(cmd, CMD_DEBUGFS_DIR)) {
240 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
241 fprintf(stderr, "dir: %s\n", tracing_path);
244 } else if (!strcmp(cmd, "--list-cmds")) {
247 for (i = 0; i < ARRAY_SIZE(commands); i++) {
248 struct cmd_struct *p = commands+i;
249 printf("%s ", p->cmd);
253 } else if (!strcmp(cmd, "--list-opts")) {
256 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
257 struct option *p = options+i;
258 printf("--%s ", p->long_name);
262 } else if (!strcmp(cmd, "--debug")) {
264 fprintf(stderr, "No variable specified for --debug.\n");
265 usage(perf_usage_string);
267 if (perf_debug_option((*argv)[1]))
268 usage(perf_usage_string);
273 fprintf(stderr, "Unknown option: %s\n", cmd);
274 usage(perf_usage_string);
284 #define RUN_SETUP (1<<0)
285 #define USE_PAGER (1<<1)
287 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
291 char sbuf[STRERR_BUFSIZE];
293 if (use_browser == -1)
294 use_browser = check_browser_config(p->cmd);
296 if (use_pager == -1 && p->option & RUN_SETUP)
297 use_pager = check_pager_config(p->cmd);
298 if (use_pager == -1 && p->option & USE_PAGER)
300 commit_pager_choice();
302 perf_env__set_cmdline(&perf_env, argc, argv);
303 status = p->fn(argc, argv);
305 exit_browser(status);
306 perf_env__exit(&perf_env);
310 return status & 0xff;
312 /* Somebody closed stdout? */
313 if (fstat(fileno(stdout), &st))
315 /* Ignore write errors for pipes and sockets.. */
316 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
320 /* Check for ENOSPC and EIO errors.. */
321 if (fflush(stdout)) {
322 fprintf(stderr, "write failure on standard output: %s",
323 str_error_r(errno, sbuf, sizeof(sbuf)));
326 if (ferror(stdout)) {
327 fprintf(stderr, "unknown write failure on standard output");
330 if (fclose(stdout)) {
331 fprintf(stderr, "close failed on standard output: %s",
332 str_error_r(errno, sbuf, sizeof(sbuf)));
340 static void handle_internal_command(int argc, const char **argv)
342 const char *cmd = argv[0];
345 /* Turn "perf cmd --help" into "perf help cmd" */
346 if (argc > 1 && !strcmp(argv[1], "--help")) {
348 argv[0] = cmd = "help";
351 for (i = 0; i < ARRAY_SIZE(commands); i++) {
352 struct cmd_struct *p = commands+i;
353 if (strcmp(p->cmd, cmd))
355 exit(run_builtin(p, argc, argv));
359 static void execv_dashed_external(const char **argv)
365 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
369 * argv[0] must be the perf command, but the argv array
370 * belongs to the caller, and may be reused in
371 * subsequent loop iterations. Save argv[0] and
372 * restore it on error.
378 * if we fail because the command is not found, it is
379 * OK to return. Otherwise, we just pass along the status code.
381 status = run_command_v_opt(argv, 0);
382 if (status != -ERR_RUN_COMMAND_EXEC) {
383 if (IS_RUN_COMMAND_ERR(status)) {
385 pr_err("FATAL: unable to run '%s'", argv[0]);
390 errno = ENOENT; /* as if we called execvp */
396 static int run_argv(int *argcp, const char ***argv)
398 /* See if it's an internal command */
399 handle_internal_command(*argcp, *argv);
401 /* .. then try the external ones */
402 execv_dashed_external(*argv);
406 static void pthread__block_sigwinch(void)
411 sigaddset(&set, SIGWINCH);
412 pthread_sigmask(SIG_BLOCK, &set, NULL);
415 void pthread__unblock_sigwinch(void)
420 sigaddset(&set, SIGWINCH);
421 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
424 #ifdef _SC_LEVEL1_DCACHE_LINESIZE
425 #define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
427 static void cache_line_size(int *cacheline_sizep)
429 if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
430 pr_debug("cannot determine cache line size");
434 int main(int argc, const char **argv)
438 char sbuf[STRERR_BUFSIZE];
442 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
443 pager_init(PERF_PAGER_ENVIRONMENT);
445 /* The page_size is placed in util object. */
446 page_size = sysconf(_SC_PAGE_SIZE);
447 cache_line_size(&cacheline_size);
449 if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
450 sysctl_perf_event_max_stack = value;
452 if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
453 sysctl_perf_event_max_contexts_per_stack = value;
455 cmd = extract_argv0_path(argv[0]);
462 err = perf_config(perf_default_config, NULL);
465 set_buildid_dir(NULL);
467 /* get debugfs/tracefs mount point from /proc/mounts */
468 tracing_path_mount();
471 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
473 * - cannot take flags in between the "perf" and the "xxxx".
474 * - cannot execute it externally (since it would just do
475 * the same thing over again)
477 * So we just directly call the internal command handler. If that one
478 * fails to handle this, then maybe we just run a renamed perf binary
479 * that contains a dash in its name. To handle this scenario, we just
480 * fall through and ignore the "xxxx" part of the command string.
482 if (strstarts(cmd, "perf-")) {
485 handle_internal_command(argc, argv);
487 * If the command is handled, the above function does not
488 * return undo changes and fall through in such a case.
493 if (strstarts(cmd, "trace")) {
494 #if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
497 return cmd_trace(argc, argv);
500 "trace command not available: missing audit-libs devel package at build time.\n");
504 /* Look for flags.. */
507 handle_options(&argv, &argc, NULL);
508 commit_pager_choice();
511 if (strstarts(argv[0], "--"))
514 /* The user didn't specify a command; give them help */
515 printf("\n usage: %s\n\n", perf_usage_string);
516 list_common_cmds_help();
517 printf("\n %s\n\n", perf_more_info_string);
525 * We use PATH to find perf commands, but we prepend some higher
526 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
527 * environment, and the $(perfexecdir) from the Makefile at build
532 * Block SIGWINCH notifications so that the thread that wants it can
533 * unblock and get syscalls like select interrupted instead of waiting
534 * forever while the signal goes to some other non interested thread.
536 pthread__block_sigwinch();
541 static int done_help;
543 run_argv(&argc, &argv);
549 cmd = argv[0] = help_unknown_cmd(cmd);
555 fprintf(stderr, "Failed to run command '%s': %s\n",
556 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));