tools/perf/perf.c

   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 **);
  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 #define RUN_SETUP       (1<<0)
 271 #define USE_PAGER       (1<<1)
 272
 273 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
 274 {
 275         int status;
 276         struct stat st;
 277         char sbuf[STRERR_BUFSIZE];
 278
 279         if (use_browser == -1)
 280                 use_browser = check_browser_config(p->cmd);
 281
 282         if (use_pager == -1 && p->option & RUN_SETUP)
 283                 use_pager = check_pager_config(p->cmd);
 284         if (use_pager == -1 && p->option & USE_PAGER)
 285                 use_pager = 1;
 286         commit_pager_choice();
 287
 288         perf_env__set_cmdline(&perf_env, argc, argv);
 289         status = p->fn(argc, argv);
 290         perf_config__exit();
 291         exit_browser(status);
 292         perf_env__exit(&perf_env);
 293         bpf__clear();
 294
 295         if (status)
 296                 return status & 0xff;
 297
 298         /* Somebody closed stdout? */
 299         if (fstat(fileno(stdout), &st))
 300                 return 0;
 301         /* Ignore write errors for pipes and sockets.. */
 302         if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
 303                 return 0;
 304
 305         status = 1;
 306         /* Check for ENOSPC and EIO errors.. */
 307         if (fflush(stdout)) {
 308                 fprintf(stderr, "write failure on standard output: %s",
 309                         str_error_r(errno, sbuf, sizeof(sbuf)));
 310                 goto out;
 311         }
 312         if (ferror(stdout)) {
 313                 fprintf(stderr, "unknown write failure on standard output");
 314                 goto out;
 315         }
 316         if (fclose(stdout)) {
 317                 fprintf(stderr, "close failed on standard output: %s",
 318                         str_error_r(errno, sbuf, sizeof(sbuf)));
 319                 goto out;
 320         }
 321         status = 0;
 322 out:
 323         return status;
 324 }
 325
 326 static void handle_internal_command(int argc, const char **argv)
 327 {
 328         const char *cmd = argv[0];
 329         unsigned int i;
 330         static const char ext[] = STRIP_EXTENSION;
 331
 332         if (sizeof(ext) > 1) {
 333                 i = strlen(argv[0]) - strlen(ext);
 334                 if (i > 0 && !strcmp(argv[0] + i, ext)) {
 335                         char *argv0 = strdup(argv[0]);
 336                         argv[0] = cmd = argv0;
 337                         argv0[i] = '\0';
 338                 }
 339         }
 340
 341         /* Turn "perf cmd --help" into "perf help cmd" */
 342         if (argc > 1 && !strcmp(argv[1], "--help")) {
 343                 argv[1] = argv[0];
 344                 argv[0] = cmd = "help";
 345         }
 346
 347         for (i = 0; i < ARRAY_SIZE(commands); i++) {
 348                 struct cmd_struct *p = commands+i;
 349                 if (strcmp(p->cmd, cmd))
 350                         continue;
 351                 exit(run_builtin(p, argc, argv));
 352         }
 353 }
 354
 355 static void execv_dashed_external(const char **argv)
 356 {
 357         char *cmd;
 358         const char *tmp;
 359         int status;
 360
 361         if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
 362                 goto do_die;
 363
 364         /*
 365          * argv[0] must be the perf command, but the argv array
 366          * belongs to the caller, and may be reused in
 367          * subsequent loop iterations. Save argv[0] and
 368          * restore it on error.
 369          */
 370         tmp = argv[0];
 371         argv[0] = cmd;
 372
 373         /*
 374          * if we fail because the command is not found, it is
 375          * OK to return. Otherwise, we just pass along the status code.
 376          */
 377         status = run_command_v_opt(argv, 0);
 378         if (status != -ERR_RUN_COMMAND_EXEC) {
 379                 if (IS_RUN_COMMAND_ERR(status)) {
 380 do_die:
 381                         pr_err("FATAL: unable to run '%s'", argv[0]);
 382                         status = -128;
 383                 }
 384                 exit(-status);
 385         }
 386         errno = ENOENT; /* as if we called execvp */
 387
 388         argv[0] = tmp;
 389         zfree(&cmd);
 390 }
 391
 392 static int run_argv(int *argcp, const char ***argv)
 393 {
 394         /* See if it's an internal command */
 395         handle_internal_command(*argcp, *argv);
 396
 397         /* .. then try the external ones */
 398         execv_dashed_external(*argv);
 399         return 0;
 400 }
 401
 402 static void pthread__block_sigwinch(void)
 403 {
 404         sigset_t set;
 405
 406         sigemptyset(&set);
 407         sigaddset(&set, SIGWINCH);
 408         pthread_sigmask(SIG_BLOCK, &set, NULL);
 409 }
 410
 411 void pthread__unblock_sigwinch(void)
 412 {
 413         sigset_t set;
 414
 415         sigemptyset(&set);
 416         sigaddset(&set, SIGWINCH);
 417         pthread_sigmask(SIG_UNBLOCK, &set, NULL);
 418 }
 419
 420 #ifdef _SC_LEVEL1_DCACHE_LINESIZE
 421 #define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
 422 #else
 423 static void cache_line_size(int *cacheline_sizep)
 424 {
 425         if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
 426                 pr_debug("cannot determine cache line size");
 427 }
 428 #endif
 429
 430 int main(int argc, const char **argv)
 431 {
 432         int err;
 433         const char *cmd;
 434         char sbuf[STRERR_BUFSIZE];
 435         int value;
 436
 437         /* libsubcmd init */
 438         exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
 439         pager_init(PERF_PAGER_ENVIRONMENT);
 440
 441         /* The page_size is placed in util object. */
 442         page_size = sysconf(_SC_PAGE_SIZE);
 443         cache_line_size(&cacheline_size);
 444
 445         if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
 446                 sysctl_perf_event_max_stack = value;
 447
 448         if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
 449                 sysctl_perf_event_max_contexts_per_stack = value;
 450
 451         cmd = extract_argv0_path(argv[0]);
 452         if (!cmd)
 453                 cmd = "perf-help";
 454
 455         srandom(time(NULL));
 456
 457         perf_config__init();
 458         err = perf_config(perf_default_config, NULL);
 459         if (err)
 460                 return err;
 461         set_buildid_dir(NULL);
 462
 463         /* get debugfs/tracefs mount point from /proc/mounts */
 464         tracing_path_mount();
 465
 466         /*
 467          * "perf-xxxx" is the same as "perf xxxx", but we obviously:
 468          *
 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)
 472          *
 473          * So we just directly call the internal command handler, and
 474          * die if that one cannot handle it.
 475          */
 476         if (!prefixcmp(cmd, "perf-")) {
 477                 cmd += 5;
 478                 argv[0] = cmd;
 479                 handle_internal_command(argc, argv);
 480                 fprintf(stderr, "cannot handle %s internally", cmd);
 481                 goto out;
 482         }
 483         if (!prefixcmp(cmd, "trace")) {
 484 #ifdef HAVE_LIBAUDIT_SUPPORT
 485                 setup_path();
 486                 argv[0] = "trace";
 487                 return cmd_trace(argc, argv);
 488 #else
 489                 fprintf(stderr,
 490                         "trace command not available: missing audit-libs devel package at build time.\n");
 491                 goto out;
 492 #endif
 493         }
 494         /* Look for flags.. */
 495         argv++;
 496         argc--;
 497         handle_options(&argv, &argc, NULL);
 498         commit_pager_choice();
 499
 500         if (argc > 0) {
 501                 if (!prefixcmp(argv[0], "--"))
 502                         argv[0] += 2;
 503         } else {
 504                 /* The user didn't specify a command; give them help */
 505                 printf("\n usage: %s\n\n", perf_usage_string);
 506                 list_common_cmds_help();
 507                 printf("\n %s\n\n", perf_more_info_string);
 508                 goto out;
 509         }
 510         cmd = argv[0];
 511
 512         test_attr__init();
 513
 514         /*
 515          * We use PATH to find perf commands, but we prepend some higher
 516          * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
 517          * environment, and the $(perfexecdir) from the Makefile at build
 518          * time.
 519          */
 520         setup_path();
 521         /*
 522          * Block SIGWINCH notifications so that the thread that wants it can
 523          * unblock and get syscalls like select interrupted instead of waiting
 524          * forever while the signal goes to some other non interested thread.
 525          */
 526         pthread__block_sigwinch();
 527
 528         perf_debug_setup();
 529
 530         while (1) {
 531                 static int done_help;
 532
 533                 run_argv(&argc, &argv);
 534
 535                 if (errno != ENOENT)
 536                         break;
 537
 538                 if (!done_help) {
 539                         cmd = argv[0] = help_unknown_cmd(cmd);
 540                         done_help = 1;
 541                 } else
 542                         break;
 543         }
 544
 545         fprintf(stderr, "Failed to run command '%s': %s\n",
 546                 cmd, str_error_r(errno, sbuf, sizeof(sbuf)));
 547 out:
 548         return 1;
 549 }