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
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 <api/fs/debugfs.h>
17#include <pthread.h>
18
19const char perf_usage_string[] =
20 "perf [--version] [--help] COMMAND [ARGS]";
21
22const char perf_more_info_string[] =
23 "See 'perf help COMMAND' for more information on a specific command.";
24
25int use_browser = -1;
26static int use_pager = -1;
27const char *input_name;
28
29struct cmd_struct {
30 const char *cmd;
31 int (*fn)(int, const char **, const char *);
32 int option;
33};
34
35static 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 },
52#ifdef HAVE_LIBELF_SUPPORT
53 { "probe", cmd_probe, 0 },
54#endif
55 { "kmem", cmd_kmem, 0 },
56 { "lock", cmd_lock, 0 },
57 { "kvm", cmd_kvm, 0 },
58 { "test", cmd_test, 0 },
59#ifdef HAVE_LIBAUDIT_SUPPORT
60 { "trace", cmd_trace, 0 },
61#endif
62 { "inject", cmd_inject, 0 },
63 { "mem", cmd_mem, 0 },
64};
65
66struct pager_config {
67 const char *cmd;
68 int val;
69};
70
71static int pager_command_config(const char *var, const char *value, void *data)
72{
73 struct pager_config *c = data;
74 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
75 c->val = perf_config_bool(var, value);
76 return 0;
77}
78
79/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
80int check_pager_config(const char *cmd)
81{
82 struct pager_config c;
83 c.cmd = cmd;
84 c.val = -1;
85 perf_config(pager_command_config, &c);
86 return c.val;
87}
88
89static int browser_command_config(const char *var, const char *value, void *data)
90{
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;
96 return 0;
97}
98
99/*
100 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
101 * and -1 for "not specified"
102 */
103static int check_browser_config(const char *cmd)
104{
105 struct pager_config c;
106 c.cmd = cmd;
107 c.val = -1;
108 perf_config(browser_command_config, &c);
109 return c.val;
110}
111
112static void commit_pager_choice(void)
113{
114 switch (use_pager) {
115 case 0:
116 setenv("PERF_PAGER", "cat", 1);
117 break;
118 case 1:
119 /* setup_pager(); */
120 break;
121 default:
122 break;
123 }
124}
125
126static int handle_options(const char ***argv, int *argc, int *envchanged)
127{
128 int handled = 0;
129
130 while (*argc > 0) {
131 const char *cmd = (*argv)[0];
132 if (cmd[0] != '-')
133 break;
134
135 /*
136 * For legacy reasons, the "version" and "help"
137 * commands can be written with "--" prepended
138 * to make them look like flags.
139 */
140 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
141 break;
142
143 /*
144 * Check remaining flags.
145 */
146 if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
147 cmd += strlen(CMD_EXEC_PATH);
148 if (*cmd == '=')
149 perf_set_argv_exec_path(cmd + 1);
150 else {
151 puts(perf_exec_path());
152 exit(0);
153 }
154 } else if (!strcmp(cmd, "--html-path")) {
155 puts(system_path(PERF_HTML_PATH));
156 exit(0);
157 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
158 use_pager = 1;
159 } else if (!strcmp(cmd, "--no-pager")) {
160 use_pager = 0;
161 if (envchanged)
162 *envchanged = 1;
163 } else if (!strcmp(cmd, "--perf-dir")) {
164 if (*argc < 2) {
165 fprintf(stderr, "No directory given for --perf-dir.\n");
166 usage(perf_usage_string);
167 }
168 setenv(PERF_DIR_ENVIRONMENT, (*argv)[1], 1);
169 if (envchanged)
170 *envchanged = 1;
171 (*argv)++;
172 (*argc)--;
173 handled++;
174 } else if (!prefixcmp(cmd, CMD_PERF_DIR)) {
175 setenv(PERF_DIR_ENVIRONMENT, cmd + strlen(CMD_PERF_DIR), 1);
176 if (envchanged)
177 *envchanged = 1;
178 } else if (!strcmp(cmd, "--work-tree")) {
179 if (*argc < 2) {
180 fprintf(stderr, "No directory given for --work-tree.\n");
181 usage(perf_usage_string);
182 }
183 setenv(PERF_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
184 if (envchanged)
185 *envchanged = 1;
186 (*argv)++;
187 (*argc)--;
188 } else if (!prefixcmp(cmd, CMD_WORK_TREE)) {
189 setenv(PERF_WORK_TREE_ENVIRONMENT, cmd + strlen(CMD_WORK_TREE), 1);
190 if (envchanged)
191 *envchanged = 1;
192 } else if (!strcmp(cmd, "--debugfs-dir")) {
193 if (*argc < 2) {
194 fprintf(stderr, "No directory given for --debugfs-dir.\n");
195 usage(perf_usage_string);
196 }
197 perf_debugfs_set_path((*argv)[1]);
198 if (envchanged)
199 *envchanged = 1;
200 (*argv)++;
201 (*argc)--;
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);
205 if (envchanged)
206 *envchanged = 1;
207 } else if (!strcmp(cmd, "--list-cmds")) {
208 unsigned int i;
209
210 for (i = 0; i < ARRAY_SIZE(commands); i++) {
211 struct cmd_struct *p = commands+i;
212 printf("%s ", p->cmd);
213 }
214 exit(0);
215 } else {
216 fprintf(stderr, "Unknown option: %s\n", cmd);
217 usage(perf_usage_string);
218 }
219
220 (*argv)++;
221 (*argc)--;
222 handled++;
223 }
224 return handled;
225}
226
227static int handle_alias(int *argcp, const char ***argv)
228{
229 int envchanged = 0, ret = 0, saved_errno = errno;
230 int count, option_count;
231 const char **new_argv;
232 const char *alias_command;
233 char *alias_string;
234
235 alias_command = (*argv)[0];
236 alias_string = alias_lookup(alias_command);
237 if (alias_string) {
238 if (alias_string[0] == '!') {
239 if (*argcp > 1) {
240 struct strbuf buf;
241
242 strbuf_init(&buf, PATH_MAX);
243 strbuf_addstr(&buf, alias_string);
244 sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
245 free(alias_string);
246 alias_string = buf.buf;
247 }
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);
254 }
255 count = split_cmdline(alias_string, &new_argv);
256 if (count < 0)
257 die("Bad alias.%s string", alias_command);
258 option_count = handle_options(&new_argv, &count, &envchanged);
259 if (envchanged)
260 die("alias '%s' changes environment variables\n"
261 "You can use '!perf' in the alias to do this.",
262 alias_command);
263 memmove(new_argv - option_count, new_argv,
264 count * sizeof(char *));
265 new_argv -= option_count;
266
267 if (count < 1)
268 die("empty alias for %s", alias_command);
269
270 if (!strcmp(alias_command, new_argv[0]))
271 die("recursive alias: %s", alias_command);
272
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;
278
279 *argv = new_argv;
280 *argcp += count - 1;
281
282 ret = 1;
283 }
284
285 errno = saved_errno;
286
287 return ret;
288}
289
290const char perf_version_string[] = PERF_VERSION;
291
292#define RUN_SETUP (1<<0)
293#define USE_PAGER (1<<1)
294/*
295 * require working tree to be present -- anything uses this needs
296 * RUN_SETUP for reading from the configuration file.
297 */
298#define NEED_WORK_TREE (1<<2)
299
300static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
301{
302 int status;
303 struct stat st;
304 const char *prefix;
305
306 prefix = NULL;
307 if (p->option & RUN_SETUP)
308 prefix = NULL; /* setup_perf_directory(); */
309
310 if (use_browser == -1)
311 use_browser = check_browser_config(p->cmd);
312
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)
316 use_pager = 1;
317 commit_pager_choice();
318
319 status = p->fn(argc, argv, prefix);
320 exit_browser(status);
321
322 if (status)
323 return status & 0xff;
324
325 /* Somebody closed stdout? */
326 if (fstat(fileno(stdout), &st))
327 return 0;
328 /* Ignore write errors for pipes and sockets.. */
329 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
330 return 0;
331
332 status = 1;
333 /* Check for ENOSPC and EIO errors.. */
334 if (fflush(stdout)) {
335 fprintf(stderr, "write failure on standard output: %s", strerror(errno));
336 goto out;
337 }
338 if (ferror(stdout)) {
339 fprintf(stderr, "unknown write failure on standard output");
340 goto out;
341 }
342 if (fclose(stdout)) {
343 fprintf(stderr, "close failed on standard output: %s", strerror(errno));
344 goto out;
345 }
346 status = 0;
347out:
348 return status;
349}
350
351static void handle_internal_command(int argc, const char **argv)
352{
353 const char *cmd = argv[0];
354 unsigned int i;
355 static const char ext[] = STRIP_EXTENSION;
356
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;
362 argv0[i] = '\0';
363 }
364 }
365
366 /* Turn "perf cmd --help" into "perf help cmd" */
367 if (argc > 1 && !strcmp(argv[1], "--help")) {
368 argv[1] = argv[0];
369 argv[0] = cmd = "help";
370 }
371
372 for (i = 0; i < ARRAY_SIZE(commands); i++) {
373 struct cmd_struct *p = commands+i;
374 if (strcmp(p->cmd, cmd))
375 continue;
376 exit(run_builtin(p, argc, argv));
377 }
378}
379
380static void execv_dashed_external(const char **argv)
381{
382 struct strbuf cmd = STRBUF_INIT;
383 const char *tmp;
384 int status;
385
386 strbuf_addf(&cmd, "perf-%s", argv[0]);
387
388 /*
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.
393 */
394 tmp = argv[0];
395 argv[0] = cmd.buf;
396
397 /*
398 * if we fail because the command is not found, it is
399 * OK to return. Otherwise, we just pass along the status code.
400 */
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]);
405 exit(-status);
406 }
407 errno = ENOENT; /* as if we called execvp */
408
409 argv[0] = tmp;
410
411 strbuf_release(&cmd);
412}
413
414static int run_argv(int *argcp, const char ***argv)
415{
416 int done_alias = 0;
417
418 while (1) {
419 /* See if it's an internal command */
420 handle_internal_command(*argcp, *argv);
421
422 /* .. then try the external ones */
423 execv_dashed_external(*argv);
424
425 /* It could be an alias -- this works around the insanity
426 * of overriding "perf log" with "perf show" by having
427 * alias.log = show
428 */
429 if (done_alias || !handle_alias(argcp, argv))
430 break;
431 done_alias = 1;
432 }
433
434 return done_alias;
435}
436
437static void pthread__block_sigwinch(void)
438{
439 sigset_t set;
440
441 sigemptyset(&set);
442 sigaddset(&set, SIGWINCH);
443 pthread_sigmask(SIG_BLOCK, &set, NULL);
444}
445
446void pthread__unblock_sigwinch(void)
447{
448 sigset_t set;
449
450 sigemptyset(&set);
451 sigaddset(&set, SIGWINCH);
452 pthread_sigmask(SIG_UNBLOCK, &set, NULL);
453}
454
455int main(int argc, const char **argv)
456{
457 const char *cmd;
458
459 /* The page_size is placed in util object. */
460 page_size = sysconf(_SC_PAGE_SIZE);
461
462 cmd = perf_extract_argv0_path(argv[0]);
463 if (!cmd)
464 cmd = "perf-help";
465 /* get debugfs mount point from /proc/mounts */
466 perf_debugfs_mount(NULL);
467 /*
468 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
469 *
470 * - cannot take flags in between the "perf" and the "xxxx".
471 * - cannot execute it externally (since it would just do
472 * the same thing over again)
473 *
474 * So we just directly call the internal command handler, and
475 * die if that one cannot handle it.
476 */
477 if (!prefixcmp(cmd, "perf-")) {
478 cmd += 5;
479 argv[0] = cmd;
480 handle_internal_command(argc, argv);
481 fprintf(stderr, "cannot handle %s internally", cmd);
482 goto out;
483 }
484#ifdef HAVE_LIBAUDIT_SUPPORT
485 if (!prefixcmp(cmd, "trace")) {
486 set_buildid_dir();
487 setup_path();
488 argv[0] = "trace";
489 return cmd_trace(argc, argv, NULL);
490 }
491#endif
492 /* Look for flags.. */
493 argv++;
494 argc--;
495 handle_options(&argv, &argc, NULL);
496 commit_pager_choice();
497 set_buildid_dir();
498
499 if (argc > 0) {
500 if (!prefixcmp(argv[0], "--"))
501 argv[0] += 2;
502 } else {
503 /* The user didn't specify a command; give them help */
504 printf("\n usage: %s\n\n", perf_usage_string);
505 list_common_cmds_help();
506 printf("\n %s\n\n", perf_more_info_string);
507 goto out;
508 }
509 cmd = argv[0];
510
511 test_attr__init();
512
513 /*
514 * We use PATH to find perf commands, but we prepend some higher
515 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
516 * environment, and the $(perfexecdir) from the Makefile at build
517 * time.
518 */
519 setup_path();
520 /*
521 * Block SIGWINCH notifications so that the thread that wants it can
522 * unblock and get syscalls like select interrupted instead of waiting
523 * forever while the signal goes to some other non interested thread.
524 */
525 pthread__block_sigwinch();
526
527 while (1) {
528 static int done_help;
529 int was_alias = run_argv(&argc, &argv);
530
531 if (errno != ENOENT)
532 break;
533
534 if (was_alias) {
535 fprintf(stderr, "Expansion of alias '%s' failed; "
536 "'%s' is not a perf-command\n",
537 cmd, argv[0]);
538 goto out;
539 }
540 if (!done_help) {
541 cmd = argv[0] = help_unknown_cmd(cmd);
542 done_help = 1;
543 } else
544 break;
545 }
546
547 fprintf(stderr, "Failed to run command '%s': %s\n",
548 cmd, strerror(errno));
549out:
550 return 1;
551}