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.
11 #include "util/exec_cmd.h"
12 #include "util/cache.h"
13 #include "util/quote.h"
14 #include "util/run-command.h"
15 #include "util/parse-events.h"
16 #include <lk/debugfs.h>
19 const char perf_usage_string
[] =
20 "perf [--version] [--help] COMMAND [ARGS]";
22 const char perf_more_info_string
[] =
23 "See 'perf help COMMAND' for more information on a specific command.";
26 static int use_pager
= -1;
27 const char *input_name
;
31 int (*fn
)(int, const char **, const char *);
35 static struct cmd_struct commands
[] = {
36 { "buildid-cache", cmd_buildid_cache
, 0 },
37 { "buildid-list", cmd_buildid_list
, 0 },
38 { "diff", cmd_diff
, 0 },
39 { "evlist", cmd_evlist
, 0 },
40 { "help", cmd_help
, 0 },
41 { "list", cmd_list
, 0 },
42 { "record", cmd_record
, 0 },
43 { "report", cmd_report
, 0 },
44 { "bench", cmd_bench
, 0 },
45 { "stat", cmd_stat
, 0 },
46 { "timechart", cmd_timechart
, 0 },
47 { "top", cmd_top
, 0 },
48 { "annotate", cmd_annotate
, 0 },
49 { "version", cmd_version
, 0 },
50 { "script", cmd_script
, 0 },
51 { "sched", cmd_sched
, 0 },
53 { "probe", cmd_probe
, 0 },
55 { "kmem", cmd_kmem
, 0 },
56 { "lock", cmd_lock
, 0 },
57 { "kvm", cmd_kvm
, 0 },
58 { "test", cmd_test
, 0 },
59 #ifdef LIBAUDIT_SUPPORT
60 { "trace", cmd_trace
, 0 },
62 { "inject", cmd_inject
, 0 },
63 { "mem", cmd_mem
, 0 },
71 static int pager_command_config(const char *var
, const char *value
, void *data
)
73 struct pager_config
*c
= data
;
74 if (!prefixcmp(var
, "pager.") && !strcmp(var
+ 6, c
->cmd
))
75 c
->val
= perf_config_bool(var
, value
);
79 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
80 int check_pager_config(const char *cmd
)
82 struct pager_config c
;
85 perf_config(pager_command_config
, &c
);
89 static int browser_command_config(const char *var
, const char *value
, void *data
)
91 struct pager_config
*c
= data
;
92 if (!prefixcmp(var
, "tui.") && !strcmp(var
+ 4, c
->cmd
))
93 c
->val
= perf_config_bool(var
, value
);
94 if (!prefixcmp(var
, "gtk.") && !strcmp(var
+ 4, c
->cmd
))
95 c
->val
= perf_config_bool(var
, value
) ? 2 : 0;
100 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
101 * and -1 for "not specified"
103 static int check_browser_config(const char *cmd
)
105 struct pager_config c
;
108 perf_config(browser_command_config
, &c
);
112 static void commit_pager_choice(void)
116 setenv("PERF_PAGER", "cat", 1);
126 static int handle_options(const char ***argv
, int *argc
, int *envchanged
)
131 const char *cmd
= (*argv
)[0];
136 * For legacy reasons, the "version" and "help"
137 * commands can be written with "--" prepended
138 * to make them look like flags.
140 if (!strcmp(cmd
, "--help") || !strcmp(cmd
, "--version"))
144 * Check remaining flags.
146 if (!prefixcmp(cmd
, CMD_EXEC_PATH
)) {
147 cmd
+= strlen(CMD_EXEC_PATH
);
149 perf_set_argv_exec_path(cmd
+ 1);
151 puts(perf_exec_path());
154 } else if (!strcmp(cmd
, "--html-path")) {
155 puts(system_path(PERF_HTML_PATH
));
157 } else if (!strcmp(cmd
, "-p") || !strcmp(cmd
, "--paginate")) {
159 } else if (!strcmp(cmd
, "--no-pager")) {
163 } else if (!strcmp(cmd
, "--perf-dir")) {
165 fprintf(stderr
, "No directory given for --perf-dir.\n");
166 usage(perf_usage_string
);
168 setenv(PERF_DIR_ENVIRONMENT
, (*argv
)[1], 1);
174 } else if (!prefixcmp(cmd
, CMD_PERF_DIR
)) {
175 setenv(PERF_DIR_ENVIRONMENT
, cmd
+ strlen(CMD_PERF_DIR
), 1);
178 } else if (!strcmp(cmd
, "--work-tree")) {
180 fprintf(stderr
, "No directory given for --work-tree.\n");
181 usage(perf_usage_string
);
183 setenv(PERF_WORK_TREE_ENVIRONMENT
, (*argv
)[1], 1);
188 } else if (!prefixcmp(cmd
, CMD_WORK_TREE
)) {
189 setenv(PERF_WORK_TREE_ENVIRONMENT
, cmd
+ strlen(CMD_WORK_TREE
), 1);
192 } else if (!strcmp(cmd
, "--debugfs-dir")) {
194 fprintf(stderr
, "No directory given for --debugfs-dir.\n");
195 usage(perf_usage_string
);
197 perf_debugfs_set_path((*argv
)[1]);
202 } else if (!prefixcmp(cmd
, CMD_DEBUGFS_DIR
)) {
203 perf_debugfs_set_path(cmd
+ strlen(CMD_DEBUGFS_DIR
));
204 fprintf(stderr
, "dir: %s\n", debugfs_mountpoint
);
207 } else if (!strcmp(cmd
, "--list-cmds")) {
210 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
211 struct cmd_struct
*p
= commands
+i
;
212 printf("%s ", p
->cmd
);
216 fprintf(stderr
, "Unknown option: %s\n", cmd
);
217 usage(perf_usage_string
);
227 static int handle_alias(int *argcp
, const char ***argv
)
229 int envchanged
= 0, ret
= 0, saved_errno
= errno
;
230 int count
, option_count
;
231 const char **new_argv
;
232 const char *alias_command
;
235 alias_command
= (*argv
)[0];
236 alias_string
= alias_lookup(alias_command
);
238 if (alias_string
[0] == '!') {
242 strbuf_init(&buf
, PATH_MAX
);
243 strbuf_addstr(&buf
, alias_string
);
244 sq_quote_argv(&buf
, (*argv
) + 1, PATH_MAX
);
246 alias_string
= buf
.buf
;
248 ret
= system(alias_string
+ 1);
249 if (ret
>= 0 && WIFEXITED(ret
) &&
250 WEXITSTATUS(ret
) != 127)
251 exit(WEXITSTATUS(ret
));
252 die("Failed to run '%s' when expanding alias '%s'",
253 alias_string
+ 1, alias_command
);
255 count
= split_cmdline(alias_string
, &new_argv
);
257 die("Bad alias.%s string", alias_command
);
258 option_count
= handle_options(&new_argv
, &count
, &envchanged
);
260 die("alias '%s' changes environment variables\n"
261 "You can use '!perf' in the alias to do this.",
263 memmove(new_argv
- option_count
, new_argv
,
264 count
* sizeof(char *));
265 new_argv
-= option_count
;
268 die("empty alias for %s", alias_command
);
270 if (!strcmp(alias_command
, new_argv
[0]))
271 die("recursive alias: %s", alias_command
);
273 new_argv
= realloc(new_argv
, sizeof(char *) *
274 (count
+ *argcp
+ 1));
275 /* insert after command name */
276 memcpy(new_argv
+ count
, *argv
+ 1, sizeof(char *) * *argcp
);
277 new_argv
[count
+ *argcp
] = NULL
;
290 const char perf_version_string
[] = PERF_VERSION
;
292 #define RUN_SETUP (1<<0)
293 #define USE_PAGER (1<<1)
295 * require working tree to be present -- anything uses this needs
296 * RUN_SETUP for reading from the configuration file.
298 #define NEED_WORK_TREE (1<<2)
300 static int run_builtin(struct cmd_struct
*p
, int argc
, const char **argv
)
307 if (p
->option
& RUN_SETUP
)
308 prefix
= NULL
; /* setup_perf_directory(); */
310 if (use_browser
== -1)
311 use_browser
= check_browser_config(p
->cmd
);
313 if (use_pager
== -1 && p
->option
& RUN_SETUP
)
314 use_pager
= check_pager_config(p
->cmd
);
315 if (use_pager
== -1 && p
->option
& USE_PAGER
)
317 commit_pager_choice();
319 status
= p
->fn(argc
, argv
, prefix
);
320 exit_browser(status
);
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", strerror(errno
));
338 if (ferror(stdout
)) {
339 fprintf(stderr
, "unknown write failure on standard output");
342 if (fclose(stdout
)) {
343 fprintf(stderr
, "close failed on standard output: %s", strerror(errno
));
351 static void handle_internal_command(int argc
, const char **argv
)
353 const char *cmd
= argv
[0];
355 static const char ext
[] = STRIP_EXTENSION
;
357 if (sizeof(ext
) > 1) {
358 i
= strlen(argv
[0]) - strlen(ext
);
359 if (i
> 0 && !strcmp(argv
[0] + i
, ext
)) {
360 char *argv0
= strdup(argv
[0]);
361 argv
[0] = cmd
= argv0
;
366 /* Turn "perf cmd --help" into "perf help cmd" */
367 if (argc
> 1 && !strcmp(argv
[1], "--help")) {
369 argv
[0] = cmd
= "help";
372 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
373 struct cmd_struct
*p
= commands
+i
;
374 if (strcmp(p
->cmd
, cmd
))
376 exit(run_builtin(p
, argc
, argv
));
380 static void execv_dashed_external(const char **argv
)
382 struct strbuf cmd
= STRBUF_INIT
;
386 strbuf_addf(&cmd
, "perf-%s", argv
[0]);
389 * argv[0] must be the perf command, but the argv array
390 * belongs to the caller, and may be reused in
391 * subsequent loop iterations. Save argv[0] and
392 * restore it on error.
398 * if we fail because the command is not found, it is
399 * OK to return. Otherwise, we just pass along the status code.
401 status
= run_command_v_opt(argv
, 0);
402 if (status
!= -ERR_RUN_COMMAND_EXEC
) {
403 if (IS_RUN_COMMAND_ERR(status
))
404 die("unable to run '%s'", argv
[0]);
407 errno
= ENOENT
; /* as if we called execvp */
411 strbuf_release(&cmd
);
414 static int run_argv(int *argcp
, const char ***argv
)
419 /* See if it's an internal command */
420 handle_internal_command(*argcp
, *argv
);
422 /* .. then try the external ones */
423 execv_dashed_external(*argv
);
425 /* It could be an alias -- this works around the insanity
426 * of overriding "perf log" with "perf show" by having
429 if (done_alias
|| !handle_alias(argcp
, argv
))
437 static void pthread__block_sigwinch(void)
442 sigaddset(&set
, SIGWINCH
);
443 pthread_sigmask(SIG_BLOCK
, &set
, NULL
);
446 void pthread__unblock_sigwinch(void)
451 sigaddset(&set
, SIGWINCH
);
452 pthread_sigmask(SIG_UNBLOCK
, &set
, NULL
);
455 int main(int argc
, const char **argv
)
459 page_size
= sysconf(_SC_PAGE_SIZE
);
461 cmd
= perf_extract_argv0_path(argv
[0]);
464 /* get debugfs mount point from /proc/mounts */
465 perf_debugfs_mount(NULL
);
467 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
469 * - cannot take flags in between the "perf" and the "xxxx".
470 * - cannot execute it externally (since it would just do
471 * the same thing over again)
473 * So we just directly call the internal command handler, and
474 * die if that one cannot handle it.
476 if (!prefixcmp(cmd
, "perf-")) {
479 handle_internal_command(argc
, argv
);
480 fprintf(stderr
, "cannot handle %s internally", cmd
);
484 /* Look for flags.. */
487 handle_options(&argv
, &argc
, NULL
);
488 commit_pager_choice();
492 if (!prefixcmp(argv
[0], "--"))
495 /* The user didn't specify a command; give them help */
496 printf("\n usage: %s\n\n", perf_usage_string
);
497 list_common_cmds_help();
498 printf("\n %s\n\n", perf_more_info_string
);
506 * We use PATH to find perf commands, but we prepend some higher
507 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
508 * environment, and the $(perfexecdir) from the Makefile at build
513 * Block SIGWINCH notifications so that the thread that wants it can
514 * unblock and get syscalls like select interrupted instead of waiting
515 * forever while the signal goes to some other non interested thread.
517 pthread__block_sigwinch();
520 static int done_help
;
521 int was_alias
= run_argv(&argc
, &argv
);
527 fprintf(stderr
, "Expansion of alias '%s' failed; "
528 "'%s' is not a perf-command\n",
533 cmd
= argv
[0] = help_unknown_cmd(cmd
);
539 fprintf(stderr
, "Failed to run command '%s': %s\n",
540 cmd
, strerror(errno
));