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