[mirror_ubuntu-jammy-kernel.git] / tools / perf / perf.c

/*
 * 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.
 */
#include "builtin.h"
#include "perf.h"

#include "util/build-id.h"
#include "util/cache.h"
#include "util/env.h"
#include <internal/lib.h> // page_size
#include <subcmd/exec-cmd.h>
#include "util/config.h"
#include <subcmd/run-command.h>
#include "util/parse-events.h"
#include <subcmd/parse-options.h>
#include "util/bpf-loader.h"
#include "util/debug.h"
#include "util/event.h"
#include "util/util.h" // usage()
#include "ui/ui.h"
#include "perf-sys.h"
#include <api/fs/fs.h>
#include <api/fs/tracing_path.h>
#include <perf/core.h>
#include <errno.h>
#include <pthread.h>
#include <signal.h>
#include <stdlib.h>
#include <time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/zalloc.h>

const char perf_usage_string[] =
	"perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";

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

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

struct cmd_struct {
	const char *cmd;
	int (*fn)(int, const char **);
	int option;
};

static struct cmd_struct commands[] = {
	{ "buildid-cache", cmd_buildid_cache, 0 },
	{ "buildid-list", cmd_buildid_list, 0 },
	{ "config",	cmd_config,	0 },
	{ "c2c",	cmd_c2c,	0 },
	{ "diff",	cmd_diff,	0 },
	{ "evlist",	cmd_evlist,	0 },
	{ "help",	cmd_help,	0 },
	{ "kallsyms",	cmd_kallsyms,	0 },
	{ "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 },
#ifdef HAVE_LIBELF_SUPPORT
	{ "probe",	cmd_probe,	0 },
#endif
	{ "kmem",	cmd_kmem,	0 },
	{ "lock",	cmd_lock,	0 },
	{ "kvm",	cmd_kvm,	0 },
	{ "test",	cmd_test,	0 },
#if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
	{ "trace",	cmd_trace,	0 },
#endif
	{ "inject",	cmd_inject,	0 },
	{ "mem",	cmd_mem,	0 },
	{ "data",	cmd_data,	0 },
	{ "ftrace",	cmd_ftrace,	0 },
	{ "daemon",	cmd_daemon,	0 },
};

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;
	if (strstarts(var, "pager.") && !strcmp(var + 6, c->cmd))
		c->val = perf_config_bool(var, value);
	return 0;
}

/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
static int check_pager_config(const char *cmd)
{
	int err;
	struct pager_config c;
	c.cmd = cmd;
	c.val = -1;
	err = perf_config(pager_command_config, &c);
	return err ?: c.val;
}

static int browser_command_config(const char *var, const char *value, void *data)
{
	struct pager_config *c = data;
	if (strstarts(var, "tui.") && !strcmp(var + 4, c->cmd))
		c->val = perf_config_bool(var, value);
	if (strstarts(var, "gtk.") && !strcmp(var + 4, c->cmd))
		c->val = perf_config_bool(var, value) ? 2 : 0;
	return 0;
}

/*
 * 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)
{
	int err;
	struct pager_config c;
	c.cmd = cmd;
	c.val = -1;
	err = perf_config(browser_command_config, &c);
	return err ?: c.val;
}

static void commit_pager_choice(void)
{
	switch (use_pager) {
	case 0:
		setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
		break;
	case 1:
		/* setup_pager(); */
		break;
	default:
		break;
	}
}

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()
};

static int handle_options(const char ***argv, int *argc, int *envchanged)
{
	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;

		/*
		 * 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;
		}

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

		/*
		 * Check remaining flags.
		 */
		if (strstarts(cmd, CMD_EXEC_PATH)) {
			cmd += strlen(CMD_EXEC_PATH);
			if (*cmd == '=')
				set_argv_exec_path(cmd + 1);
			else {
				puts(get_argv_exec_path());
				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;
		} else if (!strcmp(cmd, "--debugfs-dir")) {
			if (*argc < 2) {
				fprintf(stderr, "No directory given for --debugfs-dir.\n");
				usage(perf_usage_string);
			}
			tracing_path_set((*argv)[1]);
			if (envchanged)
				*envchanged = 1;
			(*argv)++;
			(*argc)--;
		} 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)--;
		} else if (strstarts(cmd, CMD_DEBUGFS_DIR)) {
			tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
			fprintf(stderr, "dir: %s\n", tracing_path_mount());
			if (envchanged)
				*envchanged = 1;
		} 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);
			}
			putchar('\n');
			exit(0);
		} 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);
		} 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)--;
		} 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;
	char sbuf[STRERR_BUFSIZE];

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

	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();

	perf_env__init(&perf_env);
	perf_env__set_cmdline(&perf_env, argc, argv);
	status = p->fn(argc, argv);
	perf_config__exit();
	exit_browser(status);
	perf_env__exit(&perf_env);
	bpf__clear();

	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;

	status = 1;
	/* Check for ENOSPC and EIO errors.. */
	if (fflush(stdout)) {
		fprintf(stderr, "write failure on standard output: %s",
			str_error_r(errno, sbuf, sizeof(sbuf)));
		goto out;
	}
	if (ferror(stdout)) {
		fprintf(stderr, "unknown write failure on standard output");
		goto out;
	}
	if (fclose(stdout)) {
		fprintf(stderr, "close failed on standard output: %s",
			str_error_r(errno, sbuf, sizeof(sbuf)));
		goto out;
	}
	status = 0;
out:
	return status;
}

static void handle_internal_command(int argc, const char **argv)
{
	const char *cmd = argv[0];
	unsigned int i;

	/* 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)
{
	char *cmd;
	const char *tmp;
	int status;

	if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
		goto do_die;

	/*
	 * 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];
	argv[0] = cmd;

	/*
	 * 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) {
		if (IS_RUN_COMMAND_ERR(status)) {
do_die:
			pr_err("FATAL: unable to run '%s'", argv[0]);
			status = -128;
		}
		exit(-status);
	}
	errno = ENOENT; /* as if we called execvp */

	argv[0] = tmp;
	zfree(&cmd);
}

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

	/* .. then try the external ones */
	execv_dashed_external(*argv);
	return 0;
}

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);
}

static int libperf_print(enum libperf_print_level level,
			 const char *fmt, va_list ap)
{
	return veprintf(level, verbose, fmt, ap);
}

int main(int argc, const char **argv)
{
	int err;
	const char *cmd;
	char sbuf[STRERR_BUFSIZE];

	perf_debug_setup();

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

	libperf_init(libperf_print);

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

	srandom(time(NULL));

	/* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
	config_exclusive_filename = getenv("PERF_CONFIG");

	err = perf_config(perf_default_config, NULL);
	if (err)
		return err;
	set_buildid_dir(NULL);

	/*
	 * "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)
	 *
	 * 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.
	 */
	if (strstarts(cmd, "perf-")) {
		cmd += 5;
		argv[0] = cmd;
		handle_internal_command(argc, argv);
		/*
		 * 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;
	}
	if (strstarts(cmd, "trace")) {
#if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE_SUPPORT)
		setup_path();
		argv[0] = "trace";
		return cmd_trace(argc, argv);
#else
		fprintf(stderr,
			"trace command not available: missing audit-libs devel package at build time.\n");
		goto out;
#endif
	}
	/* Look for flags.. */
	argv++;
	argc--;
	handle_options(&argv, &argc, NULL);
	commit_pager_choice();

	if (argc > 0) {
		if (strstarts(argv[0], "--"))
			argv[0] += 2;
	} else {
		/* The user didn't specify a command; give them help */
		printf("\n usage: %s\n\n", perf_usage_string);
		list_common_cmds_help();
		printf("\n %s\n\n", perf_more_info_string);
		goto out;
	}
	cmd = argv[0];

	test_attr__init();

	/*
	 * We use PATH to find perf commands, but we prepend some higher
	 * precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
	 * environment, and the $(perfexecdir) from the Makefile at build
	 * time.
	 */
	setup_path();
	/*
	 * 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();

	while (1) {
		static int done_help;

		run_argv(&argc, &argv);

		if (errno != ENOENT)
			break;

		if (!done_help) {
			cmd = argv[0] = help_unknown_cmd(cmd);
			done_help = 1;
		} else
			break;
	}

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