Loading...
1/*
2 * perf.c
3 *
4 * Performance analysis utility.
5 *
6 * This is the main hub from which the sub-commands (perf stat,
7 * perf top, perf record, perf report, etc.) are started.
8 */
9#include "builtin.h"
10
11#include "util/env.h"
12#include <subcmd/exec-cmd.h>
13#include "util/cache.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 <api/fs/tracing_path.h>
21#include <pthread.h>
22#include <stdlib.h>
23#include <time.h>
24
25const char perf_usage_string[] =
26 "perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
27
28const char perf_more_info_string[] =
29 "See 'perf help COMMAND' for more information on a specific command.";
30
31int use_browser = -1;
32static int use_pager = -1;
33const char *input_name;
34
35struct cmd_struct {
36 const char *cmd;
37 int (*fn)(int, const char **, const char *);
38 int option;
39};
40
41static struct cmd_struct commands[] = {
42 { "buildid-cache", cmd_buildid_cache, 0 },
43 { "buildid-list", cmd_buildid_list, 0 },
44 { "config", cmd_config, 0 },
45 { "diff", cmd_diff, 0 },
46 { "evlist", cmd_evlist, 0 },
47 { "help", cmd_help, 0 },
48 { "list", cmd_list, 0 },
49 { "record", cmd_record, 0 },
50 { "report", cmd_report, 0 },
51 { "bench", cmd_bench, 0 },
52 { "stat", cmd_stat, 0 },
53 { "timechart", cmd_timechart, 0 },
54 { "top", cmd_top, 0 },
55 { "annotate", cmd_annotate, 0 },
56 { "version", cmd_version, 0 },
57 { "script", cmd_script, 0 },
58 { "sched", cmd_sched, 0 },
59#ifdef HAVE_LIBELF_SUPPORT
60 { "probe", cmd_probe, 0 },
61#endif
62 { "kmem", cmd_kmem, 0 },
63 { "lock", cmd_lock, 0 },
64 { "kvm", cmd_kvm, 0 },
65 { "test", cmd_test, 0 },
66#ifdef HAVE_LIBAUDIT_SUPPORT
67 { "trace", cmd_trace, 0 },
68#endif
69 { "inject", cmd_inject, 0 },
70 { "mem", cmd_mem, 0 },
71 { "data", cmd_data, 0 },
72};
73
74struct pager_config {
75 const char *cmd;
76 int val;
77};
78
79static int pager_command_config(const char *var, const char *value, void *data)
80{
81 struct pager_config *c = data;
82 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
83 c->val = perf_config_bool(var, value);
84 return 0;
85}
86
87/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
88int check_pager_config(const char *cmd)
89{
90 struct pager_config c;
91 c.cmd = cmd;
92 c.val = -1;
93 perf_config(pager_command_config, &c);
94 return c.val;
95}
96
97static int browser_command_config(const char *var, const char *value, void *data)
98{
99 struct pager_config *c = data;
100 if (!prefixcmp(var, "tui.") && !strcmp(var + 4, c->cmd))
101 c->val = perf_config_bool(var, value);
102 if (!prefixcmp(var, "gtk.") && !strcmp(var + 4, c->cmd))
103 c->val = perf_config_bool(var, value) ? 2 : 0;
104 return 0;
105}
106
107/*
108 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
109 * and -1 for "not specified"
110 */
111static int check_browser_config(const char *cmd)
112{
113 struct pager_config c;
114 c.cmd = cmd;
115 c.val = -1;
116 perf_config(browser_command_config, &c);
117 return c.val;
118}
119
120static void commit_pager_choice(void)
121{
122 switch (use_pager) {
123 case 0:
124 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
125 break;
126 case 1:
127 /* setup_pager(); */
128 break;
129 default:
130 break;
131 }
132}
133
134struct option options[] = {
135 OPT_ARGUMENT("help", "help"),
136 OPT_ARGUMENT("version", "version"),
137 OPT_ARGUMENT("exec-path", "exec-path"),
138 OPT_ARGUMENT("html-path", "html-path"),
139 OPT_ARGUMENT("paginate", "paginate"),
140 OPT_ARGUMENT("no-pager", "no-pager"),
141 OPT_ARGUMENT("perf-dir", "perf-dir"),
142 OPT_ARGUMENT("work-tree", "work-tree"),
143 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
144 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
145 OPT_ARGUMENT("list-cmds", "list-cmds"),
146 OPT_ARGUMENT("list-opts", "list-opts"),
147 OPT_ARGUMENT("debug", "debug"),
148 OPT_END()
149};
150
151static int handle_options(const char ***argv, int *argc, int *envchanged)
152{
153 int handled = 0;
154
155 while (*argc > 0) {
156 const char *cmd = (*argv)[0];
157 if (cmd[0] != '-')
158 break;
159
160 /*
161 * For legacy reasons, the "version" and "help"
162 * commands can be written with "--" prepended
163 * to make them look like flags.
164 */
165 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
166 break;
167
168 /*
169 * Shortcut for '-h' and '-v' options to invoke help
170 * and version command.
171 */
172 if (!strcmp(cmd, "-h")) {
173 (*argv)[0] = "--help";
174 break;
175 }
176
177 if (!strcmp(cmd, "-v")) {
178 (*argv)[0] = "--version";
179 break;
180 }
181
182 /*
183 * Check remaining flags.
184 */
185 if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
186 cmd += strlen(CMD_EXEC_PATH);
187 if (*cmd == '=')
188 set_argv_exec_path(cmd + 1);
189 else {
190 puts(get_argv_exec_path());
191 exit(0);
192 }
193 } else if (!strcmp(cmd, "--html-path")) {
194 puts(system_path(PERF_HTML_PATH));
195 exit(0);
196 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
197 use_pager = 1;
198 } else if (!strcmp(cmd, "--no-pager")) {
199 use_pager = 0;
200 if (envchanged)
201 *envchanged = 1;
202 } else if (!strcmp(cmd, "--perf-dir")) {
203 if (*argc < 2) {
204 fprintf(stderr, "No directory given for --perf-dir.\n");
205 usage(perf_usage_string);
206 }
207 setenv(PERF_DIR_ENVIRONMENT, (*argv)[1], 1);
208 if (envchanged)
209 *envchanged = 1;
210 (*argv)++;
211 (*argc)--;
212 handled++;
213 } else if (!prefixcmp(cmd, CMD_PERF_DIR)) {
214 setenv(PERF_DIR_ENVIRONMENT, cmd + strlen(CMD_PERF_DIR), 1);
215 if (envchanged)
216 *envchanged = 1;
217 } else if (!strcmp(cmd, "--work-tree")) {
218 if (*argc < 2) {
219 fprintf(stderr, "No directory given for --work-tree.\n");
220 usage(perf_usage_string);
221 }
222 setenv(PERF_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
223 if (envchanged)
224 *envchanged = 1;
225 (*argv)++;
226 (*argc)--;
227 } else if (!prefixcmp(cmd, CMD_WORK_TREE)) {
228 setenv(PERF_WORK_TREE_ENVIRONMENT, cmd + strlen(CMD_WORK_TREE), 1);
229 if (envchanged)
230 *envchanged = 1;
231 } else if (!strcmp(cmd, "--debugfs-dir")) {
232 if (*argc < 2) {
233 fprintf(stderr, "No directory given for --debugfs-dir.\n");
234 usage(perf_usage_string);
235 }
236 tracing_path_set((*argv)[1]);
237 if (envchanged)
238 *envchanged = 1;
239 (*argv)++;
240 (*argc)--;
241 } else if (!strcmp(cmd, "--buildid-dir")) {
242 if (*argc < 2) {
243 fprintf(stderr, "No directory given for --buildid-dir.\n");
244 usage(perf_usage_string);
245 }
246 set_buildid_dir((*argv)[1]);
247 if (envchanged)
248 *envchanged = 1;
249 (*argv)++;
250 (*argc)--;
251 } else if (!prefixcmp(cmd, CMD_DEBUGFS_DIR)) {
252 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
253 fprintf(stderr, "dir: %s\n", tracing_path);
254 if (envchanged)
255 *envchanged = 1;
256 } else if (!strcmp(cmd, "--list-cmds")) {
257 unsigned int i;
258
259 for (i = 0; i < ARRAY_SIZE(commands); i++) {
260 struct cmd_struct *p = commands+i;
261 printf("%s ", p->cmd);
262 }
263 putchar('\n');
264 exit(0);
265 } else if (!strcmp(cmd, "--list-opts")) {
266 unsigned int i;
267
268 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
269 struct option *p = options+i;
270 printf("--%s ", p->long_name);
271 }
272 putchar('\n');
273 exit(0);
274 } else if (!strcmp(cmd, "--debug")) {
275 if (*argc < 2) {
276 fprintf(stderr, "No variable specified for --debug.\n");
277 usage(perf_usage_string);
278 }
279 if (perf_debug_option((*argv)[1]))
280 usage(perf_usage_string);
281
282 (*argv)++;
283 (*argc)--;
284 } else {
285 fprintf(stderr, "Unknown option: %s\n", cmd);
286 usage(perf_usage_string);
287 }
288
289 (*argv)++;
290 (*argc)--;
291 handled++;
292 }
293 return handled;
294}
295
296static int handle_alias(int *argcp, const char ***argv)
297{
298 int envchanged = 0, ret = 0, saved_errno = errno;
299 int count, option_count;
300 const char **new_argv;
301 const char *alias_command;
302 char *alias_string;
303
304 alias_command = (*argv)[0];
305 alias_string = alias_lookup(alias_command);
306 if (alias_string) {
307 if (alias_string[0] == '!') {
308 if (*argcp > 1) {
309 struct strbuf buf;
310
311 strbuf_init(&buf, PATH_MAX);
312 strbuf_addstr(&buf, alias_string);
313 sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
314 free(alias_string);
315 alias_string = buf.buf;
316 }
317 ret = system(alias_string + 1);
318 if (ret >= 0 && WIFEXITED(ret) &&
319 WEXITSTATUS(ret) != 127)
320 exit(WEXITSTATUS(ret));
321 die("Failed to run '%s' when expanding alias '%s'",
322 alias_string + 1, alias_command);
323 }
324 count = split_cmdline(alias_string, &new_argv);
325 if (count < 0)
326 die("Bad alias.%s string", alias_command);
327 option_count = handle_options(&new_argv, &count, &envchanged);
328 if (envchanged)
329 die("alias '%s' changes environment variables\n"
330 "You can use '!perf' in the alias to do this.",
331 alias_command);
332 memmove(new_argv - option_count, new_argv,
333 count * sizeof(char *));
334 new_argv -= option_count;
335
336 if (count < 1)
337 die("empty alias for %s", alias_command);
338
339 if (!strcmp(alias_command, new_argv[0]))
340 die("recursive alias: %s", alias_command);
341
342 new_argv = realloc(new_argv, sizeof(char *) *
343 (count + *argcp + 1));
344 /* insert after command name */
345 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
346 new_argv[count + *argcp] = NULL;
347
348 *argv = new_argv;
349 *argcp += count - 1;
350
351 ret = 1;
352 }
353
354 errno = saved_errno;
355
356 return ret;
357}
358
359const char perf_version_string[] = PERF_VERSION;
360
361#define RUN_SETUP (1<<0)
362#define USE_PAGER (1<<1)
363/*
364 * require working tree to be present -- anything uses this needs
365 * RUN_SETUP for reading from the configuration file.
366 */
367#define NEED_WORK_TREE (1<<2)
368
369static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
370{
371 int status;
372 struct stat st;
373 const char *prefix;
374 char sbuf[STRERR_BUFSIZE];
375
376 prefix = NULL;
377 if (p->option & RUN_SETUP)
378 prefix = NULL; /* setup_perf_directory(); */
379
380 if (use_browser == -1)
381 use_browser = check_browser_config(p->cmd);
382
383 if (use_pager == -1 && p->option & RUN_SETUP)
384 use_pager = check_pager_config(p->cmd);
385 if (use_pager == -1 && p->option & USE_PAGER)
386 use_pager = 1;
387 commit_pager_choice();
388
389 perf_env__set_cmdline(&perf_env, argc, argv);
390 status = p->fn(argc, argv, prefix);
391 exit_browser(status);
392 perf_env__exit(&perf_env);
393 bpf__clear();
394
395 if (status)
396 return status & 0xff;
397
398 /* Somebody closed stdout? */
399 if (fstat(fileno(stdout), &st))
400 return 0;
401 /* Ignore write errors for pipes and sockets.. */
402 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
403 return 0;
404
405 status = 1;
406 /* Check for ENOSPC and EIO errors.. */
407 if (fflush(stdout)) {
408 fprintf(stderr, "write failure on standard output: %s",
409 strerror_r(errno, sbuf, sizeof(sbuf)));
410 goto out;
411 }
412 if (ferror(stdout)) {
413 fprintf(stderr, "unknown write failure on standard output");
414 goto out;
415 }
416 if (fclose(stdout)) {
417 fprintf(stderr, "close failed on standard output: %s",
418 strerror_r(errno, sbuf, sizeof(sbuf)));
419 goto out;
420 }
421 status = 0;
422out:
423 return status;
424}
425
426static void handle_internal_command(int argc, const char **argv)
427{
428 const char *cmd = argv[0];
429 unsigned int i;
430 static const char ext[] = STRIP_EXTENSION;
431
432 if (sizeof(ext) > 1) {
433 i = strlen(argv[0]) - strlen(ext);
434 if (i > 0 && !strcmp(argv[0] + i, ext)) {
435 char *argv0 = strdup(argv[0]);
436 argv[0] = cmd = argv0;
437 argv0[i] = '\0';
438 }
439 }
440
441 /* Turn "perf cmd --help" into "perf help cmd" */
442 if (argc > 1 && !strcmp(argv[1], "--help")) {
443 argv[1] = argv[0];
444 argv[0] = cmd = "help";
445 }
446
447 for (i = 0; i < ARRAY_SIZE(commands); i++) {
448 struct cmd_struct *p = commands+i;
449 if (strcmp(p->cmd, cmd))
450 continue;
451 exit(run_builtin(p, argc, argv));
452 }
453}
454
455static void execv_dashed_external(const char **argv)
456{
457 char *cmd;
458 const char *tmp;
459 int status;
460
461 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
462 goto do_die;
463
464 /*
465 * argv[0] must be the perf command, but the argv array
466 * belongs to the caller, and may be reused in
467 * subsequent loop iterations. Save argv[0] and
468 * restore it on error.
469 */
470 tmp = argv[0];
471 argv[0] = cmd;
472
473 /*
474 * if we fail because the command is not found, it is
475 * OK to return. Otherwise, we just pass along the status code.
476 */
477 status = run_command_v_opt(argv, 0);
478 if (status != -ERR_RUN_COMMAND_EXEC) {
479 if (IS_RUN_COMMAND_ERR(status)) {
480do_die:
481 die("unable to run '%s'", argv[0]);
482 }
483 exit(-status);
484 }
485 errno = ENOENT; /* as if we called execvp */
486
487 argv[0] = tmp;
488 zfree(&cmd);
489}
490
491static int run_argv(int *argcp, const char ***argv)
492{
493 int done_alias = 0;
494
495 while (1) {
496 /* See if it's an internal command */
497 handle_internal_command(*argcp, *argv);
498
499 /* .. then try the external ones */
500 execv_dashed_external(*argv);
501
502 /* It could be an alias -- this works around the insanity
503 * of overriding "perf log" with "perf show" by having
504 * alias.log = show
505 */
506 if (done_alias || !handle_alias(argcp, argv))
507 break;
508 done_alias = 1;
509 }
510
511 return done_alias;
512}
513
514static void pthread__block_sigwinch(void)
515{
516 sigset_t set;
517
518 sigemptyset(&set);
519 sigaddset(&set, SIGWINCH);
520 pthread_sigmask(SIG_BLOCK, &set, NULL);
521}
522
523void pthread__unblock_sigwinch(void)
524{
525 sigset_t set;
526
527 sigemptyset(&set);
528 sigaddset(&set, SIGWINCH);
529 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
530}
531
532int main(int argc, const char **argv)
533{
534 const char *cmd;
535 char sbuf[STRERR_BUFSIZE];
536
537 /* libsubcmd init */
538 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
539 pager_init(PERF_PAGER_ENVIRONMENT);
540
541 /* The page_size is placed in util object. */
542 page_size = sysconf(_SC_PAGE_SIZE);
543 cacheline_size = sysconf(_SC_LEVEL1_DCACHE_LINESIZE);
544
545 cmd = extract_argv0_path(argv[0]);
546 if (!cmd)
547 cmd = "perf-help";
548
549 srandom(time(NULL));
550
551 perf_config(perf_default_config, NULL);
552
553 /* get debugfs/tracefs mount point from /proc/mounts */
554 tracing_path_mount();
555
556 /*
557 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
558 *
559 * - cannot take flags in between the "perf" and the "xxxx".
560 * - cannot execute it externally (since it would just do
561 * the same thing over again)
562 *
563 * So we just directly call the internal command handler, and
564 * die if that one cannot handle it.
565 */
566 if (!prefixcmp(cmd, "perf-")) {
567 cmd += 5;
568 argv[0] = cmd;
569 handle_internal_command(argc, argv);
570 fprintf(stderr, "cannot handle %s internally", cmd);
571 goto out;
572 }
573 if (!prefixcmp(cmd, "trace")) {
574#ifdef HAVE_LIBAUDIT_SUPPORT
575 set_buildid_dir(NULL);
576 setup_path();
577 argv[0] = "trace";
578 return cmd_trace(argc, argv, NULL);
579#else
580 fprintf(stderr,
581 "trace command not available: missing audit-libs devel package at build time.\n");
582 goto out;
583#endif
584 }
585 /* Look for flags.. */
586 argv++;
587 argc--;
588 handle_options(&argv, &argc, NULL);
589 commit_pager_choice();
590 set_buildid_dir(NULL);
591
592 if (argc > 0) {
593 if (!prefixcmp(argv[0], "--"))
594 argv[0] += 2;
595 } else {
596 /* The user didn't specify a command; give them help */
597 printf("\n usage: %s\n\n", perf_usage_string);
598 list_common_cmds_help();
599 printf("\n %s\n\n", perf_more_info_string);
600 goto out;
601 }
602 cmd = argv[0];
603
604 test_attr__init();
605
606 /*
607 * We use PATH to find perf commands, but we prepend some higher
608 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
609 * environment, and the $(perfexecdir) from the Makefile at build
610 * time.
611 */
612 setup_path();
613 /*
614 * Block SIGWINCH notifications so that the thread that wants it can
615 * unblock and get syscalls like select interrupted instead of waiting
616 * forever while the signal goes to some other non interested thread.
617 */
618 pthread__block_sigwinch();
619
620 perf_debug_setup();
621
622 while (1) {
623 static int done_help;
624 int was_alias = run_argv(&argc, &argv);
625
626 if (errno != ENOENT)
627 break;
628
629 if (was_alias) {
630 fprintf(stderr, "Expansion of alias '%s' failed; "
631 "'%s' is not a perf-command\n",
632 cmd, argv[0]);
633 goto out;
634 }
635 if (!done_help) {
636 cmd = argv[0] = help_unknown_cmd(cmd);
637 done_help = 1;
638 } else
639 break;
640 }
641
642 fprintf(stderr, "Failed to run command '%s': %s\n",
643 cmd, strerror_r(errno, sbuf, sizeof(sbuf)));
644out:
645 return 1;
646}
1/*
2 * perf.c
3 *
4 * Performance analysis utility.
5 *
6 * This is the main hub from which the sub-commands (perf stat,
7 * perf top, perf record, perf report, etc.) are started.
8 */
9#include "builtin.h"
10#include "perf.h"
11
12#include "util/build-id.h"
13#include "util/cache.h"
14#include "util/env.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/debug.h"
22#include "util/event.h"
23#include "util/util.h" // usage()
24#include "ui/ui.h"
25#include "perf-sys.h"
26#include <api/fs/fs.h>
27#include <api/fs/tracing_path.h>
28#include <perf/core.h>
29#include <errno.h>
30#include <pthread.h>
31#include <signal.h>
32#include <stdlib.h>
33#include <time.h>
34#include <sys/types.h>
35#include <sys/stat.h>
36#include <unistd.h>
37#include <linux/kernel.h>
38#include <linux/string.h>
39#include <linux/zalloc.h>
40
41static int use_pager = -1;
42static FILE *debug_fp = NULL;
43
44struct cmd_struct {
45 const char *cmd;
46 int (*fn)(int, const char **);
47 int option;
48};
49
50static struct cmd_struct commands[] = {
51 { "archive", NULL, 0 },
52 { "buildid-cache", cmd_buildid_cache, 0 },
53 { "buildid-list", cmd_buildid_list, 0 },
54 { "config", cmd_config, 0 },
55 { "c2c", cmd_c2c, 0 },
56 { "diff", cmd_diff, 0 },
57 { "evlist", cmd_evlist, 0 },
58 { "help", cmd_help, 0 },
59 { "iostat", NULL, 0 },
60 { "kallsyms", cmd_kallsyms, 0 },
61 { "list", cmd_list, 0 },
62 { "record", cmd_record, 0 },
63 { "report", cmd_report, 0 },
64 { "bench", cmd_bench, 0 },
65 { "stat", cmd_stat, 0 },
66#ifdef HAVE_LIBTRACEEVENT
67 { "timechart", cmd_timechart, 0 },
68#endif
69 { "top", cmd_top, 0 },
70 { "annotate", cmd_annotate, 0 },
71 { "version", cmd_version, 0 },
72 { "script", cmd_script, 0 },
73#ifdef HAVE_LIBTRACEEVENT
74 { "sched", cmd_sched, 0 },
75#endif
76#ifdef HAVE_LIBELF_SUPPORT
77 { "probe", cmd_probe, 0 },
78#endif
79#ifdef HAVE_LIBTRACEEVENT
80 { "kmem", cmd_kmem, 0 },
81 { "lock", cmd_lock, 0 },
82#endif
83 { "kvm", cmd_kvm, 0 },
84 { "test", cmd_test, 0 },
85#if defined(HAVE_LIBTRACEEVENT) && (defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT))
86 { "trace", cmd_trace, 0 },
87#endif
88 { "inject", cmd_inject, 0 },
89 { "mem", cmd_mem, 0 },
90 { "data", cmd_data, 0 },
91 { "ftrace", cmd_ftrace, 0 },
92 { "daemon", cmd_daemon, 0 },
93#ifdef HAVE_LIBTRACEEVENT
94 { "kwork", cmd_kwork, 0 },
95#endif
96};
97
98struct pager_config {
99 const char *cmd;
100 int val;
101};
102
103static bool same_cmd_with_prefix(const char *var, struct pager_config *c,
104 const char *header)
105{
106 return (strstarts(var, header) && !strcmp(var + strlen(header), c->cmd));
107}
108
109static int pager_command_config(const char *var, const char *value, void *data)
110{
111 struct pager_config *c = data;
112 if (same_cmd_with_prefix(var, c, "pager."))
113 c->val = perf_config_bool(var, value);
114 return 0;
115}
116
117/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
118static int check_pager_config(const char *cmd)
119{
120 int err;
121 struct pager_config c;
122 c.cmd = cmd;
123 c.val = -1;
124 err = perf_config(pager_command_config, &c);
125 return err ?: c.val;
126}
127
128static int browser_command_config(const char *var, const char *value, void *data)
129{
130 struct pager_config *c = data;
131 if (same_cmd_with_prefix(var, c, "tui."))
132 c->val = perf_config_bool(var, value);
133 if (same_cmd_with_prefix(var, c, "gtk."))
134 c->val = perf_config_bool(var, value) ? 2 : 0;
135 return 0;
136}
137
138/*
139 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
140 * and -1 for "not specified"
141 */
142static int check_browser_config(const char *cmd)
143{
144 int err;
145 struct pager_config c;
146 c.cmd = cmd;
147 c.val = -1;
148 err = perf_config(browser_command_config, &c);
149 return err ?: c.val;
150}
151
152static void commit_pager_choice(void)
153{
154 switch (use_pager) {
155 case 0:
156 setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
157 break;
158 case 1:
159 /* setup_pager(); */
160 break;
161 default:
162 break;
163 }
164}
165
166static int set_debug_file(const char *path)
167{
168 debug_fp = fopen(path, "w");
169 if (!debug_fp) {
170 fprintf(stderr, "Open debug file '%s' failed: %s\n",
171 path, strerror(errno));
172 return -1;
173 }
174
175 debug_set_file(debug_fp);
176 return 0;
177}
178
179struct option options[] = {
180 OPT_ARGUMENT("help", "help"),
181 OPT_ARGUMENT("version", "version"),
182 OPT_ARGUMENT("exec-path", "exec-path"),
183 OPT_ARGUMENT("html-path", "html-path"),
184 OPT_ARGUMENT("paginate", "paginate"),
185 OPT_ARGUMENT("no-pager", "no-pager"),
186 OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
187 OPT_ARGUMENT("buildid-dir", "buildid-dir"),
188 OPT_ARGUMENT("list-cmds", "list-cmds"),
189 OPT_ARGUMENT("list-opts", "list-opts"),
190 OPT_ARGUMENT("debug", "debug"),
191 OPT_ARGUMENT("debug-file", "debug-file"),
192 OPT_END()
193};
194
195static int handle_options(const char ***argv, int *argc, int *envchanged)
196{
197 int handled = 0;
198
199 while (*argc > 0) {
200 const char *cmd = (*argv)[0];
201 if (cmd[0] != '-')
202 break;
203
204 /*
205 * For legacy reasons, the "version" and "help"
206 * commands can be written with "--" prepended
207 * to make them look like flags.
208 */
209 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
210 break;
211
212 /*
213 * Shortcut for '-h' and '-v' options to invoke help
214 * and version command.
215 */
216 if (!strcmp(cmd, "-h")) {
217 (*argv)[0] = "--help";
218 break;
219 }
220
221 if (!strcmp(cmd, "-v")) {
222 (*argv)[0] = "--version";
223 break;
224 }
225
226 if (!strcmp(cmd, "-vv")) {
227 (*argv)[0] = "version";
228 verbose = 1;
229 break;
230 }
231
232 /*
233 * Check remaining flags.
234 */
235 if (strstarts(cmd, CMD_EXEC_PATH)) {
236 cmd += strlen(CMD_EXEC_PATH);
237 if (*cmd == '=')
238 set_argv_exec_path(cmd + 1);
239 else {
240 puts(get_argv_exec_path());
241 exit(0);
242 }
243 } else if (!strcmp(cmd, "--html-path")) {
244 puts(system_path(PERF_HTML_PATH));
245 exit(0);
246 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
247 use_pager = 1;
248 } else if (!strcmp(cmd, "--no-pager")) {
249 use_pager = 0;
250 if (envchanged)
251 *envchanged = 1;
252 } else if (!strcmp(cmd, "--debugfs-dir")) {
253 if (*argc < 2) {
254 fprintf(stderr, "No directory given for --debugfs-dir.\n");
255 usage(perf_usage_string);
256 }
257 tracing_path_set((*argv)[1]);
258 if (envchanged)
259 *envchanged = 1;
260 (*argv)++;
261 (*argc)--;
262 } else if (!strcmp(cmd, "--buildid-dir")) {
263 if (*argc < 2) {
264 fprintf(stderr, "No directory given for --buildid-dir.\n");
265 usage(perf_usage_string);
266 }
267 set_buildid_dir((*argv)[1]);
268 if (envchanged)
269 *envchanged = 1;
270 (*argv)++;
271 (*argc)--;
272 } else if (strstarts(cmd, CMD_DEBUGFS_DIR)) {
273 tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
274 fprintf(stderr, "dir: %s\n", tracing_path_mount());
275 if (envchanged)
276 *envchanged = 1;
277 } else if (!strcmp(cmd, "--list-cmds")) {
278 unsigned int i;
279
280 for (i = 0; i < ARRAY_SIZE(commands); i++) {
281 struct cmd_struct *p = commands+i;
282 printf("%s ", p->cmd);
283 }
284 putchar('\n');
285 exit(0);
286 } else if (!strcmp(cmd, "--list-opts")) {
287 unsigned int i;
288
289 for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
290 struct option *p = options+i;
291 printf("--%s ", p->long_name);
292 }
293 putchar('\n');
294 exit(0);
295 } else if (!strcmp(cmd, "--debug")) {
296 if (*argc < 2) {
297 fprintf(stderr, "No variable specified for --debug.\n");
298 usage(perf_usage_string);
299 }
300 if (perf_debug_option((*argv)[1]))
301 usage(perf_usage_string);
302
303 (*argv)++;
304 (*argc)--;
305 } else if (!strcmp(cmd, "--debug-file")) {
306 if (*argc < 2) {
307 fprintf(stderr, "No path given for --debug-file.\n");
308 usage(perf_usage_string);
309 }
310
311 if (set_debug_file((*argv)[1]))
312 usage(perf_usage_string);
313
314 (*argv)++;
315 (*argc)--;
316
317 } else {
318 fprintf(stderr, "Unknown option: %s\n", cmd);
319 usage(perf_usage_string);
320 }
321
322 (*argv)++;
323 (*argc)--;
324 handled++;
325 }
326 return handled;
327}
328
329#define RUN_SETUP (1<<0)
330#define USE_PAGER (1<<1)
331
332static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
333{
334 int status;
335 struct stat st;
336 char sbuf[STRERR_BUFSIZE];
337
338 if (use_browser == -1)
339 use_browser = check_browser_config(p->cmd);
340
341 if (use_pager == -1 && p->option & RUN_SETUP)
342 use_pager = check_pager_config(p->cmd);
343 if (use_pager == -1 && p->option & USE_PAGER)
344 use_pager = 1;
345 commit_pager_choice();
346
347 perf_env__init(&perf_env);
348 perf_env__set_cmdline(&perf_env, argc, argv);
349 status = p->fn(argc, argv);
350 perf_config__exit();
351 exit_browser(status);
352 perf_env__exit(&perf_env);
353
354 if (status)
355 return status & 0xff;
356
357 /* Somebody closed stdout? */
358 if (fstat(fileno(stdout), &st))
359 return 0;
360 /* Ignore write errors for pipes and sockets.. */
361 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
362 return 0;
363
364 status = 1;
365 /* Check for ENOSPC and EIO errors.. */
366 if (fflush(stdout)) {
367 fprintf(stderr, "write failure on standard output: %s",
368 str_error_r(errno, sbuf, sizeof(sbuf)));
369 goto out;
370 }
371 if (ferror(stdout)) {
372 fprintf(stderr, "unknown write failure on standard output");
373 goto out;
374 }
375 if (fclose(stdout)) {
376 fprintf(stderr, "close failed on standard output: %s",
377 str_error_r(errno, sbuf, sizeof(sbuf)));
378 goto out;
379 }
380 status = 0;
381out:
382 return status;
383}
384
385static void handle_internal_command(int argc, const char **argv)
386{
387 const char *cmd = argv[0];
388 unsigned int i;
389
390 /* Turn "perf cmd --help" into "perf help cmd" */
391 if (argc > 1 && !strcmp(argv[1], "--help")) {
392 argv[1] = argv[0];
393 argv[0] = cmd = "help";
394 }
395
396 for (i = 0; i < ARRAY_SIZE(commands); i++) {
397 struct cmd_struct *p = commands+i;
398 if (p->fn == NULL)
399 continue;
400 if (strcmp(p->cmd, cmd))
401 continue;
402 exit(run_builtin(p, argc, argv));
403 }
404}
405
406static void execv_dashed_external(const char **argv)
407{
408 char *cmd;
409 const char *tmp;
410 int status;
411
412 if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
413 goto do_die;
414
415 /*
416 * argv[0] must be the perf command, but the argv array
417 * belongs to the caller, and may be reused in
418 * subsequent loop iterations. Save argv[0] and
419 * restore it on error.
420 */
421 tmp = argv[0];
422 argv[0] = cmd;
423
424 /*
425 * if we fail because the command is not found, it is
426 * OK to return. Otherwise, we just pass along the status code.
427 */
428 status = run_command_v_opt(argv, 0);
429 if (status != -ERR_RUN_COMMAND_EXEC) {
430 if (IS_RUN_COMMAND_ERR(status)) {
431do_die:
432 pr_err("FATAL: unable to run '%s'", argv[0]);
433 status = -128;
434 }
435 exit(-status);
436 }
437 errno = ENOENT; /* as if we called execvp */
438
439 argv[0] = tmp;
440 zfree(&cmd);
441}
442
443static int run_argv(int *argcp, const char ***argv)
444{
445 /* See if it's an internal command */
446 handle_internal_command(*argcp, *argv);
447
448 /* .. then try the external ones */
449 execv_dashed_external(*argv);
450 return 0;
451}
452
453static int libperf_print(enum libperf_print_level level,
454 const char *fmt, va_list ap)
455{
456 return veprintf(level, verbose, fmt, ap);
457}
458
459int main(int argc, const char **argv)
460{
461 int err;
462 const char *cmd;
463 char sbuf[STRERR_BUFSIZE];
464
465 perf_debug_setup();
466
467 /* libsubcmd init */
468 exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
469 pager_init(PERF_PAGER_ENVIRONMENT);
470
471 libperf_init(libperf_print);
472
473 cmd = extract_argv0_path(argv[0]);
474 if (!cmd)
475 cmd = "perf-help";
476
477 srandom(time(NULL));
478
479 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
480 config_exclusive_filename = getenv("PERF_CONFIG");
481
482 err = perf_config(perf_default_config, NULL);
483 if (err)
484 return err;
485 set_buildid_dir(NULL);
486
487 /*
488 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
489 *
490 * - cannot take flags in between the "perf" and the "xxxx".
491 * - cannot execute it externally (since it would just do
492 * the same thing over again)
493 *
494 * So we just directly call the internal command handler. If that one
495 * fails to handle this, then maybe we just run a renamed perf binary
496 * that contains a dash in its name. To handle this scenario, we just
497 * fall through and ignore the "xxxx" part of the command string.
498 */
499 if (strstarts(cmd, "perf-")) {
500 cmd += 5;
501 argv[0] = cmd;
502 handle_internal_command(argc, argv);
503 /*
504 * If the command is handled, the above function does not
505 * return undo changes and fall through in such a case.
506 */
507 cmd -= 5;
508 argv[0] = cmd;
509 }
510 if (strstarts(cmd, "trace")) {
511#ifndef HAVE_LIBTRACEEVENT
512 fprintf(stderr,
513 "trace command not available: missing libtraceevent devel package at build time.\n");
514 goto out;
515#elif !defined(HAVE_LIBAUDIT_SUPPORT) && !defined(HAVE_SYSCALL_TABLE_SUPPORT)
516 fprintf(stderr,
517 "trace command not available: missing audit-libs devel package at build time.\n");
518 goto out;
519#else
520 setup_path();
521 argv[0] = "trace";
522 return cmd_trace(argc, argv);
523#endif
524 }
525 /* Look for flags.. */
526 argv++;
527 argc--;
528 handle_options(&argv, &argc, NULL);
529 commit_pager_choice();
530
531 if (argc > 0) {
532 if (strstarts(argv[0], "--"))
533 argv[0] += 2;
534 } else {
535 /* The user didn't specify a command; give them help */
536 printf("\n usage: %s\n\n", perf_usage_string);
537 list_common_cmds_help();
538 printf("\n %s\n\n", perf_more_info_string);
539 goto out;
540 }
541 cmd = argv[0];
542
543 test_attr__init();
544
545 /*
546 * We use PATH to find perf commands, but we prepend some higher
547 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
548 * environment, and the $(perfexecdir) from the Makefile at build
549 * time.
550 */
551 setup_path();
552 /*
553 * Block SIGWINCH notifications so that the thread that wants it can
554 * unblock and get syscalls like select interrupted instead of waiting
555 * forever while the signal goes to some other non interested thread.
556 */
557 pthread__block_sigwinch();
558
559 while (1) {
560 static int done_help;
561
562 run_argv(&argc, &argv);
563
564 if (errno != ENOENT)
565 break;
566
567 if (!done_help) {
568 cmd = argv[0] = help_unknown_cmd(cmd);
569 done_help = 1;
570 } else
571 break;
572 }
573
574 fprintf(stderr, "Failed to run command '%s': %s\n",
575 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));
576out:
577 if (debug_fp)
578 fclose(debug_fp);
579
580 return 1;
581}