tools/perf/perf.c

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