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 "util/event.h"
21 #include <api/fs/fs.h>
22 #include <api/fs/tracing_path.h>
28 #include <sys/types.h>
31 #include <linux/kernel.h>
33 const char perf_usage_string[] =
34 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
36 const char perf_more_info_string[] =
37 "See 'perf help COMMAND' for more information on a specific command.";
39 static int use_pager = -1;
40 const char *input_name;
44 int (*fn)(int, const char **);
48 static struct cmd_struct commands[] = {
49 { "buildid-cache", cmd_buildid_cache, 0 },
50 { "buildid-list", cmd_buildid_list, 0 },
51 { "config", cmd_config, 0 },
52 { "c2c", cmd_c2c, 0 },
53 { "diff", cmd_diff, 0 },
54 { "evlist", cmd_evlist, 0 },
55 { "help", cmd_help, 0 },
56 { "kallsyms", cmd_kallsyms, 0 },
57 { "list", cmd_list, 0 },
58 { "record", cmd_record, 0 },
59 { "report", cmd_report, 0 },
60 { "bench", cmd_bench, 0 },
61 { "stat", cmd_stat, 0 },
62 { "timechart", cmd_timechart, 0 },
63 { "top", cmd_top, 0 },
64 { "annotate", cmd_annotate, 0 },
65 { "version", cmd_version, 0 },
66 { "script", cmd_script, 0 },
67 { "sched", cmd_sched, 0 },
68 #ifdef HAVE_LIBELF_SUPPORT
69 { "probe", cmd_probe, 0 },
71 { "kmem", cmd_kmem, 0 },
72 { "lock", cmd_lock, 0 },
73 { "kvm", cmd_kvm, 0 },
74 { "test", cmd_test, 0 },
75 #ifdef HAVE_LIBAUDIT_SUPPORT
76 { "trace", cmd_trace, 0 },
78 { "inject", cmd_inject, 0 },
79 { "mem", cmd_mem, 0 },
80 { "data", cmd_data, 0 },
81 { "ftrace", cmd_ftrace, 0 },
89 static int pager_command_config(const char *var, const char *value, void *data)
91 struct pager_config *c = data;
92 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
93 c->val = perf_config_bool(var, value);
97 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
98 static int check_pager_config(const char *cmd)
101 struct pager_config c;
104 err = perf_config(pager_command_config, &c);
108 static int browser_command_config(const char *var, const char *value, void *data)
110 struct pager_config *c = data;
111 if (!prefixcmp(var, "tui.") && !strcmp(var + 4, c->cmd))
112 c->val = perf_config_bool(var, value);
113 if (!prefixcmp(var, "gtk.") && !strcmp(var + 4, c->cmd))
114 c->val = perf_config_bool(var, value) ? 2 : 0;
119 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
120 * and -1 for "not specified"
122 static int check_browser_config(const char *cmd)
125 struct pager_config c;
128 err = perf_config(browser_command_config, &c);
132 static void commit_pager_choice(void)
136 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
146 struct option options[] = {
147 OPT_ARGUMENT("help", "help"),
148 OPT_ARGUMENT("version", "version"),
149 OPT_ARGUMENT("exec-path", "exec-path"),
150 OPT_ARGUMENT("html-path", "html-path"),
151 OPT_ARGUMENT("paginate", "paginate"),
152 OPT_ARGUMENT("no-pager", "no-pager"),
153 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
154 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
155 OPT_ARGUMENT("list-cmds", "list-cmds"),
156 OPT_ARGUMENT("list-opts", "list-opts"),
157 OPT_ARGUMENT("debug", "debug"),
161 static int handle_options(const char ***argv, int *argc, int *envchanged)
166 const char *cmd = (*argv)[0];
171 * For legacy reasons, the "version" and "help"
172 * commands can be written with "--" prepended
173 * to make them look like flags.
175 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
179 * Shortcut for '-h' and '-v' options to invoke help
180 * and version command.
182 if (!strcmp(cmd, "-h")) {
183 (*argv)[0] = "--help";
187 if (!strcmp(cmd, "-v")) {
188 (*argv)[0] = "--version";
193 * Check remaining flags.
195 if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
196 cmd += strlen(CMD_EXEC_PATH);
198 set_argv_exec_path(cmd + 1);
200 puts(get_argv_exec_path());
203 } else if (!strcmp(cmd, "--html-path")) {
204 puts(system_path(PERF_HTML_PATH));
206 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
208 } else if (!strcmp(cmd, "--no-pager")) {
212 } else if (!strcmp(cmd, "--debugfs-dir")) {
214 fprintf(stderr, "No directory given for --debugfs-dir.\n");
215 usage(perf_usage_string);
217 tracing_path_set((*argv)[1]);
222 } else if (!strcmp(cmd, "--buildid-dir")) {
224 fprintf(stderr, "No directory given for --buildid-dir.\n");
225 usage(perf_usage_string);
227 set_buildid_dir((*argv)[1]);
232 } else if (!prefixcmp(cmd, CMD_DEBUGFS_DIR)) {
233 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
234 fprintf(stderr, "dir: %s\n", tracing_path);
237 } else if (!strcmp(cmd, "--list-cmds")) {
240 for (i = 0; i < ARRAY_SIZE(commands); i++) {
241 struct cmd_struct *p = commands+i;
242 printf("%s ", p->cmd);
246 } else if (!strcmp(cmd, "--list-opts")) {
249 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
250 struct option *p = options+i;
251 printf("--%s ", p->long_name);
255 } else if (!strcmp(cmd, "--debug")) {
257 fprintf(stderr, "No variable specified for --debug.\n");
258 usage(perf_usage_string);
260 if (perf_debug_option((*argv)[1]))
261 usage(perf_usage_string);
266 fprintf(stderr, "Unknown option: %s\n", cmd);
267 usage(perf_usage_string);
277 #define RUN_SETUP (1<<0)
278 #define USE_PAGER (1<<1)
280 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
284 char sbuf[STRERR_BUFSIZE];
286 if (use_browser == -1)
287 use_browser = check_browser_config(p->cmd);
289 if (use_pager == -1 && p->option & RUN_SETUP)
290 use_pager = check_pager_config(p->cmd);
291 if (use_pager == -1 && p->option & USE_PAGER)
293 commit_pager_choice();
295 perf_env__set_cmdline(&perf_env, argc, argv);
296 status = p->fn(argc, argv);
298 exit_browser(status);
299 perf_env__exit(&perf_env);
303 return status & 0xff;
305 /* Somebody closed stdout? */
306 if (fstat(fileno(stdout), &st))
308 /* Ignore write errors for pipes and sockets.. */
309 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
313 /* Check for ENOSPC and EIO errors.. */
314 if (fflush(stdout)) {
315 fprintf(stderr, "write failure on standard output: %s",
316 str_error_r(errno, sbuf, sizeof(sbuf)));
319 if (ferror(stdout)) {
320 fprintf(stderr, "unknown write failure on standard output");
323 if (fclose(stdout)) {
324 fprintf(stderr, "close failed on standard output: %s",
325 str_error_r(errno, sbuf, sizeof(sbuf)));
333 static void handle_internal_command(int argc, const char **argv)
335 const char *cmd = argv[0];
338 /* Turn "perf cmd --help" into "perf help cmd" */
339 if (argc > 1 && !strcmp(argv[1], "--help")) {
341 argv[0] = cmd = "help";
344 for (i = 0; i < ARRAY_SIZE(commands); i++) {
345 struct cmd_struct *p = commands+i;
346 if (strcmp(p->cmd, cmd))
348 exit(run_builtin(p, argc, argv));
352 static void execv_dashed_external(const char **argv)
358 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
362 * argv[0] must be the perf command, but the argv array
363 * belongs to the caller, and may be reused in
364 * subsequent loop iterations. Save argv[0] and
365 * restore it on error.
371 * if we fail because the command is not found, it is
372 * OK to return. Otherwise, we just pass along the status code.
374 status = run_command_v_opt(argv, 0);
375 if (status != -ERR_RUN_COMMAND_EXEC) {
376 if (IS_RUN_COMMAND_ERR(status)) {
378 pr_err("FATAL: unable to run '%s'", argv[0]);
383 errno = ENOENT; /* as if we called execvp */
389 static int run_argv(int *argcp, const char ***argv)
391 /* See if it's an internal command */
392 handle_internal_command(*argcp, *argv);
394 /* .. then try the external ones */
395 execv_dashed_external(*argv);
399 static void pthread__block_sigwinch(void)
404 sigaddset(&set, SIGWINCH);
405 pthread_sigmask(SIG_BLOCK, &set, NULL);
408 void pthread__unblock_sigwinch(void)
413 sigaddset(&set, SIGWINCH);
414 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
417 #ifdef _SC_LEVEL1_DCACHE_LINESIZE
418 #define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
420 static void cache_line_size(int *cacheline_sizep)
422 if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
423 pr_debug("cannot determine cache line size");
427 int main(int argc, const char **argv)
431 char sbuf[STRERR_BUFSIZE];
435 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
436 pager_init(PERF_PAGER_ENVIRONMENT);
438 /* The page_size is placed in util object. */
439 page_size = sysconf(_SC_PAGE_SIZE);
440 cache_line_size(&cacheline_size);
442 if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
443 sysctl_perf_event_max_stack = value;
445 if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
446 sysctl_perf_event_max_contexts_per_stack = value;
448 cmd = extract_argv0_path(argv[0]);
455 err = perf_config(perf_default_config, NULL);
458 set_buildid_dir(NULL);
460 /* get debugfs/tracefs mount point from /proc/mounts */
461 tracing_path_mount();
464 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
466 * - cannot take flags in between the "perf" and the "xxxx".
467 * - cannot execute it externally (since it would just do
468 * the same thing over again)
470 * So we just directly call the internal command handler, and
471 * die if that one cannot handle it.
473 if (!prefixcmp(cmd, "perf-")) {
476 handle_internal_command(argc, argv);
477 fprintf(stderr, "cannot handle %s internally", cmd);
480 if (!prefixcmp(cmd, "trace")) {
481 #ifdef HAVE_LIBAUDIT_SUPPORT
484 return cmd_trace(argc, argv);
487 "trace command not available: missing audit-libs devel package at build time.\n");
491 /* Look for flags.. */
494 handle_options(&argv, &argc, NULL);
495 commit_pager_choice();
498 if (!prefixcmp(argv[0], "--"))
501 /* The user didn't specify a command; give them help */
502 printf("\n usage: %s\n\n", perf_usage_string);
503 list_common_cmds_help();
504 printf("\n %s\n\n", perf_more_info_string);
512 * We use PATH to find perf commands, but we prepend some higher
513 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
514 * environment, and the $(perfexecdir) from the Makefile at build
519 * Block SIGWINCH notifications so that the thread that wants it can
520 * unblock and get syscalls like select interrupted instead of waiting
521 * forever while the signal goes to some other non interested thread.
523 pthread__block_sigwinch();
528 static int done_help;
530 run_argv(&argc, &argv);
536 cmd = argv[0] = help_unknown_cmd(cmd);
542 fprintf(stderr, "Failed to run command '%s': %s\n",
543 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));