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