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/exec_cmd.h"
13 #include "util/cache.h"
14 #include "util/quote.h"
15 #include "util/run-command.h"
16 #include "util/parse-events.h"
17 #include "util/parse-options.h"
18 #include "util/bpf-loader.h"
19 #include "util/debug.h"
20 #include <api/fs/tracing_path.h>
23 const char perf_usage_string
[] =
24 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
26 const char perf_more_info_string
[] =
27 "See 'perf help COMMAND' for more information on a specific command.";
30 static int use_pager
= -1;
31 const char *input_name
;
35 int (*fn
)(int, const char **, const char *);
39 static struct cmd_struct commands
[] = {
40 { "buildid-cache", cmd_buildid_cache
, 0 },
41 { "buildid-list", cmd_buildid_list
, 0 },
42 { "config", cmd_config
, 0 },
43 { "diff", cmd_diff
, 0 },
44 { "evlist", cmd_evlist
, 0 },
45 { "help", cmd_help
, 0 },
46 { "list", cmd_list
, 0 },
47 { "record", cmd_record
, 0 },
48 { "report", cmd_report
, 0 },
49 { "bench", cmd_bench
, 0 },
50 { "stat", cmd_stat
, 0 },
51 { "timechart", cmd_timechart
, 0 },
52 { "top", cmd_top
, 0 },
53 { "annotate", cmd_annotate
, 0 },
54 { "version", cmd_version
, 0 },
55 { "script", cmd_script
, 0 },
56 { "sched", cmd_sched
, 0 },
57 #ifdef HAVE_LIBELF_SUPPORT
58 { "probe", cmd_probe
, 0 },
60 { "kmem", cmd_kmem
, 0 },
61 { "lock", cmd_lock
, 0 },
62 { "kvm", cmd_kvm
, 0 },
63 { "test", cmd_test
, 0 },
64 #ifdef HAVE_LIBAUDIT_SUPPORT
65 { "trace", cmd_trace
, 0 },
67 { "inject", cmd_inject
, 0 },
68 { "mem", cmd_mem
, 0 },
69 { "data", cmd_data
, 0 },
77 static int pager_command_config(const char *var
, const char *value
, void *data
)
79 struct pager_config
*c
= data
;
80 if (!prefixcmp(var
, "pager.") && !strcmp(var
+ 6, c
->cmd
))
81 c
->val
= perf_config_bool(var
, value
);
85 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
86 int check_pager_config(const char *cmd
)
88 struct pager_config c
;
91 perf_config(pager_command_config
, &c
);
95 static int browser_command_config(const char *var
, const char *value
, void *data
)
97 struct pager_config
*c
= data
;
98 if (!prefixcmp(var
, "tui.") && !strcmp(var
+ 4, c
->cmd
))
99 c
->val
= perf_config_bool(var
, value
);
100 if (!prefixcmp(var
, "gtk.") && !strcmp(var
+ 4, c
->cmd
))
101 c
->val
= perf_config_bool(var
, value
) ? 2 : 0;
106 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
107 * and -1 for "not specified"
109 static int check_browser_config(const char *cmd
)
111 struct pager_config c
;
114 perf_config(browser_command_config
, &c
);
118 static void commit_pager_choice(void)
122 setenv(PERF_PAGER_ENVIRONMENT
, "cat", 1);
132 struct option options
[] = {
133 OPT_ARGUMENT("help", "help"),
134 OPT_ARGUMENT("version", "version"),
135 OPT_ARGUMENT("exec-path", "exec-path"),
136 OPT_ARGUMENT("html-path", "html-path"),
137 OPT_ARGUMENT("paginate", "paginate"),
138 OPT_ARGUMENT("no-pager", "no-pager"),
139 OPT_ARGUMENT("perf-dir", "perf-dir"),
140 OPT_ARGUMENT("work-tree", "work-tree"),
141 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
142 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
143 OPT_ARGUMENT("list-cmds", "list-cmds"),
144 OPT_ARGUMENT("list-opts", "list-opts"),
145 OPT_ARGUMENT("debug", "debug"),
149 static int handle_options(const char ***argv
, int *argc
, int *envchanged
)
154 const char *cmd
= (*argv
)[0];
159 * For legacy reasons, the "version" and "help"
160 * commands can be written with "--" prepended
161 * to make them look like flags.
163 if (!strcmp(cmd
, "--help") || !strcmp(cmd
, "--version"))
167 * Shortcut for '-h' and '-v' options to invoke help
168 * and version command.
170 if (!strcmp(cmd
, "-h")) {
171 (*argv
)[0] = "--help";
175 if (!strcmp(cmd
, "-v")) {
176 (*argv
)[0] = "--version";
181 * Check remaining flags.
183 if (!prefixcmp(cmd
, CMD_EXEC_PATH
)) {
184 cmd
+= strlen(CMD_EXEC_PATH
);
186 set_argv_exec_path(cmd
+ 1);
188 puts(get_argv_exec_path());
191 } else if (!strcmp(cmd
, "--html-path")) {
192 puts(system_path(PERF_HTML_PATH
));
194 } else if (!strcmp(cmd
, "-p") || !strcmp(cmd
, "--paginate")) {
196 } else if (!strcmp(cmd
, "--no-pager")) {
200 } else if (!strcmp(cmd
, "--perf-dir")) {
202 fprintf(stderr
, "No directory given for --perf-dir.\n");
203 usage(perf_usage_string
);
205 setenv(PERF_DIR_ENVIRONMENT
, (*argv
)[1], 1);
211 } else if (!prefixcmp(cmd
, CMD_PERF_DIR
)) {
212 setenv(PERF_DIR_ENVIRONMENT
, cmd
+ strlen(CMD_PERF_DIR
), 1);
215 } else if (!strcmp(cmd
, "--work-tree")) {
217 fprintf(stderr
, "No directory given for --work-tree.\n");
218 usage(perf_usage_string
);
220 setenv(PERF_WORK_TREE_ENVIRONMENT
, (*argv
)[1], 1);
225 } else if (!prefixcmp(cmd
, CMD_WORK_TREE
)) {
226 setenv(PERF_WORK_TREE_ENVIRONMENT
, cmd
+ strlen(CMD_WORK_TREE
), 1);
229 } else if (!strcmp(cmd
, "--debugfs-dir")) {
231 fprintf(stderr
, "No directory given for --debugfs-dir.\n");
232 usage(perf_usage_string
);
234 tracing_path_set((*argv
)[1]);
239 } else if (!strcmp(cmd
, "--buildid-dir")) {
241 fprintf(stderr
, "No directory given for --buildid-dir.\n");
242 usage(perf_usage_string
);
244 set_buildid_dir((*argv
)[1]);
249 } else if (!prefixcmp(cmd
, CMD_DEBUGFS_DIR
)) {
250 tracing_path_set(cmd
+ strlen(CMD_DEBUGFS_DIR
));
251 fprintf(stderr
, "dir: %s\n", tracing_path
);
254 } else if (!strcmp(cmd
, "--list-cmds")) {
257 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
258 struct cmd_struct
*p
= commands
+i
;
259 printf("%s ", p
->cmd
);
263 } else if (!strcmp(cmd
, "--list-opts")) {
266 for (i
= 0; i
< ARRAY_SIZE(options
)-1; i
++) {
267 struct option
*p
= options
+i
;
268 printf("--%s ", p
->long_name
);
272 } else if (!strcmp(cmd
, "--debug")) {
274 fprintf(stderr
, "No variable specified for --debug.\n");
275 usage(perf_usage_string
);
277 if (perf_debug_option((*argv
)[1]))
278 usage(perf_usage_string
);
283 fprintf(stderr
, "Unknown option: %s\n", cmd
);
284 usage(perf_usage_string
);
294 static int handle_alias(int *argcp
, const char ***argv
)
296 int envchanged
= 0, ret
= 0, saved_errno
= errno
;
297 int count
, option_count
;
298 const char **new_argv
;
299 const char *alias_command
;
302 alias_command
= (*argv
)[0];
303 alias_string
= alias_lookup(alias_command
);
305 if (alias_string
[0] == '!') {
309 strbuf_init(&buf
, PATH_MAX
);
310 strbuf_addstr(&buf
, alias_string
);
311 sq_quote_argv(&buf
, (*argv
) + 1, PATH_MAX
);
313 alias_string
= buf
.buf
;
315 ret
= system(alias_string
+ 1);
316 if (ret
>= 0 && WIFEXITED(ret
) &&
317 WEXITSTATUS(ret
) != 127)
318 exit(WEXITSTATUS(ret
));
319 die("Failed to run '%s' when expanding alias '%s'",
320 alias_string
+ 1, alias_command
);
322 count
= split_cmdline(alias_string
, &new_argv
);
324 die("Bad alias.%s string", alias_command
);
325 option_count
= handle_options(&new_argv
, &count
, &envchanged
);
327 die("alias '%s' changes environment variables\n"
328 "You can use '!perf' in the alias to do this.",
330 memmove(new_argv
- option_count
, new_argv
,
331 count
* sizeof(char *));
332 new_argv
-= option_count
;
335 die("empty alias for %s", alias_command
);
337 if (!strcmp(alias_command
, new_argv
[0]))
338 die("recursive alias: %s", alias_command
);
340 new_argv
= realloc(new_argv
, sizeof(char *) *
341 (count
+ *argcp
+ 1));
342 /* insert after command name */
343 memcpy(new_argv
+ count
, *argv
+ 1, sizeof(char *) * *argcp
);
344 new_argv
[count
+ *argcp
] = NULL
;
357 const char perf_version_string
[] = PERF_VERSION
;
359 #define RUN_SETUP (1<<0)
360 #define USE_PAGER (1<<1)
362 * require working tree to be present -- anything uses this needs
363 * RUN_SETUP for reading from the configuration file.
365 #define NEED_WORK_TREE (1<<2)
367 static int run_builtin(struct cmd_struct
*p
, int argc
, const char **argv
)
372 char sbuf
[STRERR_BUFSIZE
];
375 if (p
->option
& RUN_SETUP
)
376 prefix
= NULL
; /* setup_perf_directory(); */
378 if (use_browser
== -1)
379 use_browser
= check_browser_config(p
->cmd
);
381 if (use_pager
== -1 && p
->option
& RUN_SETUP
)
382 use_pager
= check_pager_config(p
->cmd
);
383 if (use_pager
== -1 && p
->option
& USE_PAGER
)
385 commit_pager_choice();
387 perf_env__set_cmdline(&perf_env
, argc
, argv
);
388 status
= p
->fn(argc
, argv
, prefix
);
389 exit_browser(status
);
390 perf_env__exit(&perf_env
);
394 return status
& 0xff;
396 /* Somebody closed stdout? */
397 if (fstat(fileno(stdout
), &st
))
399 /* Ignore write errors for pipes and sockets.. */
400 if (S_ISFIFO(st
.st_mode
) || S_ISSOCK(st
.st_mode
))
404 /* Check for ENOSPC and EIO errors.. */
405 if (fflush(stdout
)) {
406 fprintf(stderr
, "write failure on standard output: %s",
407 strerror_r(errno
, sbuf
, sizeof(sbuf
)));
410 if (ferror(stdout
)) {
411 fprintf(stderr
, "unknown write failure on standard output");
414 if (fclose(stdout
)) {
415 fprintf(stderr
, "close failed on standard output: %s",
416 strerror_r(errno
, sbuf
, sizeof(sbuf
)));
424 static void handle_internal_command(int argc
, const char **argv
)
426 const char *cmd
= argv
[0];
428 static const char ext
[] = STRIP_EXTENSION
;
430 if (sizeof(ext
) > 1) {
431 i
= strlen(argv
[0]) - strlen(ext
);
432 if (i
> 0 && !strcmp(argv
[0] + i
, ext
)) {
433 char *argv0
= strdup(argv
[0]);
434 argv
[0] = cmd
= argv0
;
439 /* Turn "perf cmd --help" into "perf help cmd" */
440 if (argc
> 1 && !strcmp(argv
[1], "--help")) {
442 argv
[0] = cmd
= "help";
445 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
446 struct cmd_struct
*p
= commands
+i
;
447 if (strcmp(p
->cmd
, cmd
))
449 exit(run_builtin(p
, argc
, argv
));
453 static void execv_dashed_external(const char **argv
)
455 struct strbuf cmd
= STRBUF_INIT
;
459 strbuf_addf(&cmd
, "perf-%s", argv
[0]);
462 * argv[0] must be the perf command, but the argv array
463 * belongs to the caller, and may be reused in
464 * subsequent loop iterations. Save argv[0] and
465 * restore it on error.
471 * if we fail because the command is not found, it is
472 * OK to return. Otherwise, we just pass along the status code.
474 status
= run_command_v_opt(argv
, 0);
475 if (status
!= -ERR_RUN_COMMAND_EXEC
) {
476 if (IS_RUN_COMMAND_ERR(status
))
477 die("unable to run '%s'", argv
[0]);
480 errno
= ENOENT
; /* as if we called execvp */
484 strbuf_release(&cmd
);
487 static int run_argv(int *argcp
, const char ***argv
)
492 /* See if it's an internal command */
493 handle_internal_command(*argcp
, *argv
);
495 /* .. then try the external ones */
496 execv_dashed_external(*argv
);
498 /* It could be an alias -- this works around the insanity
499 * of overriding "perf log" with "perf show" by having
502 if (done_alias
|| !handle_alias(argcp
, argv
))
510 static void pthread__block_sigwinch(void)
515 sigaddset(&set
, SIGWINCH
);
516 pthread_sigmask(SIG_BLOCK
, &set
, NULL
);
519 void pthread__unblock_sigwinch(void)
524 sigaddset(&set
, SIGWINCH
);
525 pthread_sigmask(SIG_UNBLOCK
, &set
, NULL
);
528 int main(int argc
, const char **argv
)
531 char sbuf
[STRERR_BUFSIZE
];
534 exec_cmd_init("perf", PREFIX
, PERF_EXEC_PATH
, EXEC_PATH_ENVIRONMENT
);
535 pager_init(PERF_PAGER_ENVIRONMENT
);
537 /* The page_size is placed in util object. */
538 page_size
= sysconf(_SC_PAGE_SIZE
);
539 cacheline_size
= sysconf(_SC_LEVEL1_DCACHE_LINESIZE
);
541 cmd
= extract_argv0_path(argv
[0]);
545 /* get debugfs/tracefs mount point from /proc/mounts */
546 tracing_path_mount();
549 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
551 * - cannot take flags in between the "perf" and the "xxxx".
552 * - cannot execute it externally (since it would just do
553 * the same thing over again)
555 * So we just directly call the internal command handler, and
556 * die if that one cannot handle it.
558 if (!prefixcmp(cmd
, "perf-")) {
561 handle_internal_command(argc
, argv
);
562 fprintf(stderr
, "cannot handle %s internally", cmd
);
565 if (!prefixcmp(cmd
, "trace")) {
566 #ifdef HAVE_LIBAUDIT_SUPPORT
567 set_buildid_dir(NULL
);
570 return cmd_trace(argc
, argv
, NULL
);
573 "trace command not available: missing audit-libs devel package at build time.\n");
577 /* Look for flags.. */
580 handle_options(&argv
, &argc
, NULL
);
581 commit_pager_choice();
582 set_buildid_dir(NULL
);
585 if (!prefixcmp(argv
[0], "--"))
588 /* The user didn't specify a command; give them help */
589 printf("\n usage: %s\n\n", perf_usage_string
);
590 list_common_cmds_help();
591 printf("\n %s\n\n", perf_more_info_string
);
599 * We use PATH to find perf commands, but we prepend some higher
600 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
601 * environment, and the $(perfexecdir) from the Makefile at build
606 * Block SIGWINCH notifications so that the thread that wants it can
607 * unblock and get syscalls like select interrupted instead of waiting
608 * forever while the signal goes to some other non interested thread.
610 pthread__block_sigwinch();
613 static int done_help
;
614 int was_alias
= run_argv(&argc
, &argv
);
620 fprintf(stderr
, "Expansion of alias '%s' failed; "
621 "'%s' is not a perf-command\n",
626 cmd
= argv
[0] = help_unknown_cmd(cmd
);
632 fprintf(stderr
, "Failed to run command '%s': %s\n",
633 cmd
, strerror_r(errno
, sbuf
, sizeof(sbuf
)));