perf.c 12.5 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5 6 7 8 9
/*
 * perf.c
 *
 * Performance analysis utility.
 *
 * This is the main hub from which the sub-commands (perf stat,
 * perf top, perf record, perf report, etc.) are started.
 */
10
#include "builtin.h"
11

12
#include "util/env.h"
13
#include <subcmd/exec-cmd.h>
14
#include "util/config.h"
15
#include "util/quote.h"
16
#include <subcmd/run-command.h>
17
#include "util/parse-events.h"
18
#include <subcmd/parse-options.h>
19
#include "util/bpf-loader.h"
20
#include "util/debug.h"
21
#include "util/event.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 28
#include <stdlib.h>
#include <time.h>
29 30 31
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
32
#include <linux/kernel.h>
33 34

const char perf_usage_string[] =
35
	"perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
36 37 38 39 40

const char perf_more_info_string[] =
	"See 'perf help COMMAND' for more information on a specific command.";

static int use_pager = -1;
41
const char *input_name;
42

43 44
struct cmd_struct {
	const char *cmd;
45
	int (*fn)(int, const char **);
46 47 48 49 50 51
	int option;
};

static struct cmd_struct commands[] = {
	{ "buildid-cache", cmd_buildid_cache, 0 },
	{ "buildid-list", cmd_buildid_list, 0 },
52
	{ "config",	cmd_config,	0 },
J
Jiri Olsa 已提交
53
	{ "c2c",	cmd_c2c,	0 },
54 55 56
	{ "diff",	cmd_diff,	0 },
	{ "evlist",	cmd_evlist,	0 },
	{ "help",	cmd_help,	0 },
57
	{ "kallsyms",	cmd_kallsyms,	0 },
58 59 60 61 62 63 64 65 66 67 68
	{ "list",	cmd_list,	0 },
	{ "record",	cmd_record,	0 },
	{ "report",	cmd_report,	0 },
	{ "bench",	cmd_bench,	0 },
	{ "stat",	cmd_stat,	0 },
	{ "timechart",	cmd_timechart,	0 },
	{ "top",	cmd_top,	0 },
	{ "annotate",	cmd_annotate,	0 },
	{ "version",	cmd_version,	0 },
	{ "script",	cmd_script,	0 },
	{ "sched",	cmd_sched,	0 },
69
#ifdef HAVE_LIBELF_SUPPORT
70
	{ "probe",	cmd_probe,	0 },
71
#endif
72 73 74 75
	{ "kmem",	cmd_kmem,	0 },
	{ "lock",	cmd_lock,	0 },
	{ "kvm",	cmd_kvm,	0 },
	{ "test",	cmd_test,	0 },
76
#if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
A
Arnaldo Carvalho de Melo 已提交
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 86 87 88 89 90 91 92
struct pager_config {
	const char *cmd;
	int val;
};

static int pager_command_config(const char *var, const char *value, void *data)
{
	struct pager_config *c = data;
93
	if (strstarts(var, "pager.") && !strcmp(var + 6, c->cmd))
94 95 96 97 98
		c->val = perf_config_bool(var, value);
	return 0;
}

/* 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 103 104
	struct pager_config c;
	c.cmd = cmd;
	c.val = -1;
105 106
	err = perf_config(pager_command_config, &c);
	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 117 118
	return 0;
}

119 120 121 122 123
/*
 * returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
 * and -1 for "not specified"
 */
static int check_browser_config(const char *cmd)
124
{
125
	int err;
126 127 128
	struct pager_config c;
	c.cmd = cmd;
	c.val = -1;
129 130
	err = perf_config(browser_command_config, &c);
	return err ?: c.val;
131 132
}

133 134
static void commit_pager_choice(void)
{
135 136
	switch (use_pager) {
	case 0:
137
		setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
138 139 140 141 142 143 144 145 146
		break;
	case 1:
		/* setup_pager(); */
		break;
	default:
		break;
	}
}

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
struct option options[] = {
	OPT_ARGUMENT("help", "help"),
	OPT_ARGUMENT("version", "version"),
	OPT_ARGUMENT("exec-path", "exec-path"),
	OPT_ARGUMENT("html-path", "html-path"),
	OPT_ARGUMENT("paginate", "paginate"),
	OPT_ARGUMENT("no-pager", "no-pager"),
	OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
	OPT_ARGUMENT("buildid-dir", "buildid-dir"),
	OPT_ARGUMENT("list-cmds", "list-cmds"),
	OPT_ARGUMENT("list-opts", "list-opts"),
	OPT_ARGUMENT("debug", "debug"),
	OPT_END()
};

162
static int handle_options(const char ***argv, int *argc, int *envchanged)
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
{
	int handled = 0;

	while (*argc > 0) {
		const char *cmd = (*argv)[0];
		if (cmd[0] != '-')
			break;

		/*
		 * For legacy reasons, the "version" and "help"
		 * commands can be written with "--" prepended
		 * to make them look like flags.
		 */
		if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
			break;

J
Jiri Olsa 已提交
179 180 181 182 183 184 185 186 187 188 189 190 191 192
		/*
		 * Shortcut for '-h' and '-v' options to invoke help
		 * and version command.
		 */
		if (!strcmp(cmd, "-h")) {
			(*argv)[0] = "--help";
			break;
		}

		if (!strcmp(cmd, "-v")) {
			(*argv)[0] = "--version";
			break;
		}

193 194 195 196 197 198
		if (!strcmp(cmd, "-vv")) {
			(*argv)[0] = "version";
			version_verbose = 1;
			break;
		}

199 200 201
		/*
		 * Check remaining flags.
		 */
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 209 210 211 212 213 214 215 216 217 218
				exit(0);
			}
		} else if (!strcmp(cmd, "--html-path")) {
			puts(system_path(PERF_HTML_PATH));
			exit(0);
		} else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
			use_pager = 1;
		} else if (!strcmp(cmd, "--no-pager")) {
			use_pager = 0;
			if (envchanged)
				*envchanged = 1;
219 220 221 222 223
		} else if (!strcmp(cmd, "--debugfs-dir")) {
			if (*argc < 2) {
				fprintf(stderr, "No directory given for --debugfs-dir.\n");
				usage(perf_usage_string);
			}
224
			tracing_path_set((*argv)[1]);
225 226 227 228
			if (envchanged)
				*envchanged = 1;
			(*argv)++;
			(*argc)--;
229 230 231 232 233 234 235 236 237 238
		} else if (!strcmp(cmd, "--buildid-dir")) {
			if (*argc < 2) {
				fprintf(stderr, "No directory given for --buildid-dir.\n");
				usage(perf_usage_string);
			}
			set_buildid_dir((*argv)[1]);
			if (envchanged)
				*envchanged = 1;
			(*argv)++;
			(*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 243
			if (envchanged)
				*envchanged = 1;
244 245 246 247 248 249 250
		} else if (!strcmp(cmd, "--list-cmds")) {
			unsigned int i;

			for (i = 0; i < ARRAY_SIZE(commands); i++) {
				struct cmd_struct *p = commands+i;
				printf("%s ", p->cmd);
			}
251
			putchar('\n');
252
			exit(0);
253 254 255 256 257 258 259 260 261
		} else if (!strcmp(cmd, "--list-opts")) {
			unsigned int i;

			for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
				struct option *p = options+i;
				printf("--%s ", p->long_name);
			}
			putchar('\n');
			exit(0);
262 263 264 265 266 267 268 269 270 271
		} else if (!strcmp(cmd, "--debug")) {
			if (*argc < 2) {
				fprintf(stderr, "No variable specified for --debug.\n");
				usage(perf_usage_string);
			}
			if (perf_debug_option((*argv)[1]))
				usage(perf_usage_string);

			(*argv)++;
			(*argc)--;
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
		} else {
			fprintf(stderr, "Unknown option: %s\n", cmd);
			usage(perf_usage_string);
		}

		(*argv)++;
		(*argc)--;
		handled++;
	}
	return handled;
}

#define RUN_SETUP	(1<<0)
#define USE_PAGER	(1<<1)

static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
{
	int status;
	struct stat st;
291
	char sbuf[STRERR_BUFSIZE];
292

293
	if (use_browser == -1)
294
		use_browser = check_browser_config(p->cmd);
295

296 297 298 299 300 301
	if (use_pager == -1 && p->option & RUN_SETUP)
		use_pager = check_pager_config(p->cmd);
	if (use_pager == -1 && p->option & USE_PAGER)
		use_pager = 1;
	commit_pager_choice();

302
	perf_env__set_cmdline(&perf_env, argc, argv);
303
	status = p->fn(argc, argv);
304
	perf_config__exit();
305
	exit_browser(status);
306
	perf_env__exit(&perf_env);
307
	bpf__clear();
308

309 310 311 312 313 314 315 316 317 318
	if (status)
		return status & 0xff;

	/* Somebody closed stdout? */
	if (fstat(fileno(stdout), &st))
		return 0;
	/* Ignore write errors for pipes and sockets.. */
	if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
		return 0;

319
	status = 1;
320
	/* Check for ENOSPC and EIO errors.. */
321
	if (fflush(stdout)) {
322
		fprintf(stderr, "write failure on standard output: %s",
323
			str_error_r(errno, sbuf, sizeof(sbuf)));
324 325 326 327 328 329 330
		goto out;
	}
	if (ferror(stdout)) {
		fprintf(stderr, "unknown write failure on standard output");
		goto out;
	}
	if (fclose(stdout)) {
331
		fprintf(stderr, "close failed on standard output: %s",
332
			str_error_r(errno, sbuf, sizeof(sbuf)));
333 334 335 336 337
		goto out;
	}
	status = 0;
out:
	return status;
338 339 340 341 342
}

static void handle_internal_command(int argc, const char **argv)
{
	const char *cmd = argv[0];
343
	unsigned int i;
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360

	/* Turn "perf cmd --help" into "perf help cmd" */
	if (argc > 1 && !strcmp(argv[1], "--help")) {
		argv[1] = argv[0];
		argv[0] = cmd = "help";
	}

	for (i = 0; i < ARRAY_SIZE(commands); i++) {
		struct cmd_struct *p = commands+i;
		if (strcmp(p->cmd, cmd))
			continue;
		exit(run_builtin(p, argc, argv));
	}
}

static void execv_dashed_external(const char **argv)
{
361
	char *cmd;
362 363 364
	const char *tmp;
	int status;

365 366
	if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
		goto do_die;
367 368 369 370 371 372 373 374

	/*
	 * argv[0] must be the perf command, but the argv array
	 * belongs to the caller, and may be reused in
	 * subsequent loop iterations. Save argv[0] and
	 * restore it on error.
	 */
	tmp = argv[0];
375
	argv[0] = cmd;
376 377 378 379 380 381 382

	/*
	 * if we fail because the command is not found, it is
	 * OK to return. Otherwise, we just pass along the status code.
	 */
	status = run_command_v_opt(argv, 0);
	if (status != -ERR_RUN_COMMAND_EXEC) {
383 384
		if (IS_RUN_COMMAND_ERR(status)) {
do_die:
385 386
			pr_err("FATAL: unable to run '%s'", argv[0]);
			status = -128;
387
		}
388 389 390 391 392
		exit(-status);
	}
	errno = ENOENT; /* as if we called execvp */

	argv[0] = tmp;
393
	zfree(&cmd);
394 395 396 397
}

static int run_argv(int *argcp, const char ***argv)
{
398 399
	/* See if it's an internal command */
	handle_internal_command(*argcp, *argv);
400

401 402 403
	/* .. then try the external ones */
	execv_dashed_external(*argv);
	return 0;
404 405
}

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
static void pthread__block_sigwinch(void)
{
	sigset_t set;

	sigemptyset(&set);
	sigaddset(&set, SIGWINCH);
	pthread_sigmask(SIG_BLOCK, &set, NULL);
}

void pthread__unblock_sigwinch(void)
{
	sigset_t set;

	sigemptyset(&set);
	sigaddset(&set, SIGWINCH);
	pthread_sigmask(SIG_UNBLOCK, &set, NULL);
}

424 425
int main(int argc, const char **argv)
{
426
	int err;
427
	const char *cmd;
428
	char sbuf[STRERR_BUFSIZE];
429
	int value;
430

431 432 433 434
	/* libsubcmd init */
	exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
	pager_init(PERF_PAGER_ENVIRONMENT);

J
Jiri Olsa 已提交
435
	/* The page_size is placed in util object. */
436 437
	page_size = sysconf(_SC_PAGE_SIZE);

438 439 440
	if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
		sysctl_perf_event_max_stack = value;

441 442 443
	if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
		sysctl_perf_event_max_contexts_per_stack = value;

444
	cmd = extract_argv0_path(argv[0]);
445 446
	if (!cmd)
		cmd = "perf-help";
447

448 449
	srandom(time(NULL));

450 451 452
	err = perf_config(perf_default_config, NULL);
	if (err)
		return err;
453
	set_buildid_dir(NULL);
454

455 456 457 458 459 460 461
	/*
	 * "perf-xxxx" is the same as "perf xxxx", but we obviously:
	 *
	 *  - cannot take flags in between the "perf" and the "xxxx".
	 *  - cannot execute it externally (since it would just do
	 *    the same thing over again)
	 *
462 463 464 465
	 * So we just directly call the internal command handler. If that one
	 * fails to handle this, then maybe we just run a renamed perf binary
	 * that contains a dash in its name. To handle this scenario, we just
	 * fall through and ignore the "xxxx" part of the command string.
466
	 */
467
	if (strstarts(cmd, "perf-")) {
468
		cmd += 5;
469 470
		argv[0] = cmd;
		handle_internal_command(argc, argv);
471 472 473 474 475 476
		/*
		 * If the command is handled, the above function does not
		 * return undo changes and fall through in such a case.
		 */
		cmd -= 5;
		argv[0] = cmd;
477
	}
478
	if (strstarts(cmd, "trace")) {
479
#if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
480 481
		setup_path();
		argv[0] = "trace";
482
		return cmd_trace(argc, argv);
483 484 485 486
#else
		fprintf(stderr,
			"trace command not available: missing audit-libs devel package at build time.\n");
		goto out;
487
#endif
488
	}
489 490 491 492 493
	/* Look for flags.. */
	argv++;
	argc--;
	handle_options(&argv, &argc, NULL);
	commit_pager_choice();
494

495
	if (argc > 0) {
496
		if (strstarts(argv[0], "--"))
497 498 499
			argv[0] += 2;
	} else {
		/* The user didn't specify a command; give them help */
500
		printf("\n usage: %s\n\n", perf_usage_string);
501
		list_common_cmds_help();
502
		printf("\n %s\n\n", perf_more_info_string);
503
		goto out;
504 505 506
	}
	cmd = argv[0];

507 508
	test_attr__init();

509 510
	/*
	 * We use PATH to find perf commands, but we prepend some higher
511
	 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
512 513 514 515
	 * environment, and the $(perfexecdir) from the Makefile at build
	 * time.
	 */
	setup_path();
516 517 518 519 520 521
	/*
	 * Block SIGWINCH notifications so that the thread that wants it can
	 * unblock and get syscalls like select interrupted instead of waiting
	 * forever while the signal goes to some other non interested thread.
	 */
	pthread__block_sigwinch();
522

523 524
	perf_debug_setup();

525
	while (1) {
526
		static int done_help;
527 528

		run_argv(&argc, &argv);
529

530 531
		if (errno != ENOENT)
			break;
532

533 534 535 536 537 538 539 540
		if (!done_help) {
			cmd = argv[0] = help_unknown_cmd(cmd);
			done_help = 1;
		} else
			break;
	}

	fprintf(stderr, "Failed to run command '%s': %s\n",
541
		cmd, str_error_r(errno, sbuf, sizeof(sbuf)));
542
out:
543 544
	return 1;
}