[linux-block.git] / tools / perf / perf.c

// SPDX-License-Identifier: GPL-2.0
/*
 * 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 "util/env.h"
#include <subcmd/exec-cmd.h>
#include "util/config.h"
#include "util/quote.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 <api/fs/fs.h>
#include <api/fs/tracing_path.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>

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

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

#ifdef _SC_LEVEL1_DCACHE_LINESIZE
#define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
#else
static void cache_line_size(int *cacheline_sizep)
{
	if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
		pr_debug("cannot determine cache line size");
}
#endif

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

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

	/* The page_size is placed in util object. */
	page_size = sysconf(_SC_PAGE_SIZE);
	cache_line_size(&cacheline_size);

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

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

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

	srandom(time(NULL));

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

	/* get debugfs/tracefs mount point from /proc/mounts */
	tracing_path_mount();

	/*
	 * "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();

	perf_debug_setup();

	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
b2441318	1	// SPDX-License-Identifier: GPL-2.0
bf9e1876 IM	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	*/
07800601	10	#include "builtin.h"
bf9e1876	11
aa36ddd7	12	#include "util/env.h"
4b6ab94e	13	#include <subcmd/exec-cmd.h>
41840d21	14	#include "util/config.h"
148be2c1	15	#include "util/quote.h"
4b6ab94e	16	#include <subcmd/run-command.h>
5beeded1	17	#include "util/parse-events.h"
4b6ab94e	18	#include <subcmd/parse-options.h>
84c86ca1	19	#include "util/bpf-loader.h"
bbb2cea7	20	#include "util/debug.h"
5ab8c689	21	#include "util/event.h"
4cb93446	22	#include <api/fs/fs.h>
592d5a6b	23	#include <api/fs/tracing_path.h>
a43783ae	24	#include <errno.h>
27683dc5	25	#include <pthread.h>
9607ad3a	26	#include <signal.h>
14cbfbeb NK	27	#include <stdlib.h>
14cbfbeb NK	28	#include <time.h>
7a8ef4c4 ACM	29	#include <sys/types.h>
	30	#include <sys/stat.h>
	31	#include <unistd.h>
877a7a11	32	#include <linux/kernel.h>
07800601 IM	33
07800601 IM	34	const char perf_usage_string[] =
78a1b503	35	"perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
07800601 IM	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;
70cb4e96	41	const char *input_name;
5d06e691	42
98a4179c FW	43	struct cmd_struct {
98a4179c FW	44	const char *cmd;
b0ad8ea6	45	int (fn)(int, const char *);
98a4179c FW	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 },
30862f2c	52	{ "config", cmd_config, 0 },
7aef3bf3	53	{ "c2c", cmd_c2c, 0 },
98a4179c FW	54	{ "diff", cmd_diff, 0 },
	55	{ "evlist", cmd_evlist, 0 },
	56	{ "help", cmd_help, 0 },
35563771	57	{ "kallsyms", cmd_kallsyms, 0 },
98a4179c FW	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 },
89fe808a	69	#ifdef HAVE_LIBELF_SUPPORT
98a4179c	70	{ "probe", cmd_probe, 0 },
393be2e3	71	#endif
98a4179c FW	72	{ "kmem", cmd_kmem, 0 },
	73	{ "lock", cmd_lock, 0 },
	74	{ "kvm", cmd_kvm, 0 },
	75	{ "test", cmd_test, 0 },
22e9af4e	76	#if defined(HAVE_LIBAUDIT_SUPPORT) \|\| defined(HAVE_SYSCALL_TABLE_SUPPORT)
514f1c67	77	{ "trace", cmd_trace, 0 },
4d29089c	78	#endif
98a4179c	79	{ "inject", cmd_inject, 0 },
028f12ee	80	{ "mem", cmd_mem, 0 },
2245bf14	81	{ "data", cmd_data, 0 },
d01f4e8d	82	{ "ftrace", cmd_ftrace, 0 },
98a4179c FW	83	};
98a4179c FW	84
07800601 IM	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;
8e99b6d4	93	if (strstarts(var, "pager.") && !strcmp(var + 6, c->cmd))
07800601 IM	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" */
a3b70b3b	99	static int check_pager_config(const char *cmd)
07800601	100	{
ecc4c561	101	int err;
07800601 IM	102	struct pager_config c;
	103	c.cmd = cmd;
	104	c.val = -1;
ecc4c561 ACM	105	err = perf_config(pager_command_config, &c);
ecc4c561 ACM	106	return err ?: c.val;
07800601 IM	107	}
07800601 IM	108
0020ce23	109	static int browser_command_config(const char var, const char value, void *data)
5d06e691 ACM	110	{
5d06e691 ACM	111	struct pager_config *c = data;
8e99b6d4	112	if (strstarts(var, "tui.") && !strcmp(var + 4, c->cmd))
5d06e691	113	c->val = perf_config_bool(var, value);
8e99b6d4	114	if (strstarts(var, "gtk.") && !strcmp(var + 4, c->cmd))
0020ce23	115	c->val = perf_config_bool(var, value) ? 2 : 0;
5d06e691 ACM	116	return 0;
	117	}
	118
0020ce23 NK	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)
5d06e691	124	{
ecc4c561	125	int err;
5d06e691 ACM	126	struct pager_config c;
	127	c.cmd = cmd;
	128	c.val = -1;
ecc4c561 ACM	129	err = perf_config(browser_command_config, &c);
ecc4c561 ACM	130	return err ?: c.val;
5d06e691 ACM	131	}
5d06e691 ACM	132
4c574159 TF	133	static void commit_pager_choice(void)
4c574159 TF	134	{
07800601 IM	135	switch (use_pager) {
07800601 IM	136	case 0:
096d3558	137	setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
07800601 IM	138	break;
	139	case 1:
	140	/* setup_pager(); */
	141	break;
	142	default:
	143	break;
	144	}
	145	}
	146
7335399a YS	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"),
7335399a YS	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
4c574159	162	static int handle_options(const char **argv, int argc, int *envchanged)
07800601 IM	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
a1853e2c JO	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
3aa94b10 JY	193	if (!strcmp(cmd, "-vv")) {
	194	(*argv)[0] = "version";
	195	version_verbose = 1;
	196	break;
	197	}
	198
07800601 IM	199	/*
	200	* Check remaining flags.
	201	*/
8e99b6d4	202	if (strstarts(cmd, CMD_EXEC_PATH)) {
cfed95a6	203	cmd += strlen(CMD_EXEC_PATH);
07800601	204	if (*cmd == '=')
46113a54	205	set_argv_exec_path(cmd + 1);
07800601	206	else {
46113a54	207	puts(get_argv_exec_path());
07800601 IM	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;
5beeded1 JB	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	}
65d4b265	224	tracing_path_set((*argv)[1]);
5beeded1 JB	225	if (envchanged)
	226	*envchanged = 1;
	227	(*argv)++;
	228	(*argc)--;
99ce8e9f JO	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)--;
8e99b6d4	239	} else if (strstarts(cmd, CMD_DEBUGFS_DIR)) {
65d4b265	240	tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
9f30fffc	241	fprintf(stderr, "dir: %s\n", tracing_path);
5beeded1 JB	242	if (envchanged)
5beeded1 JB	243	*envchanged = 1;
98a4179c FW	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	}
ed457520	251	putchar('\n');
98a4179c	252	exit(0);
7335399a YS	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);
bbb2cea7 JO	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)--;
07800601 IM	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
07800601 IM	284	#define RUN_SETUP (1<<0)
07800601 IM	285	#define USE_PAGER (1<<1)
07800601	286
07800601 IM	287	static int run_builtin(struct cmd_struct p, int argc, const char *argv)
	288	{
	289	int status;
	290	struct stat st;
b2348e1d	291	char sbuf[STRERR_BUFSIZE];
07800601	292
5d06e691	293	if (use_browser == -1)
0020ce23	294	use_browser = check_browser_config(p->cmd);
5d06e691	295
07800601 IM	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
2bdb2c27	302	perf_env__set_cmdline(&perf_env, argc, argv);
b0ad8ea6	303	status = p->fn(argc, argv);
8a0a9c7e	304	perf_config__exit();
f3a1f0ea	305	exit_browser(status);
aa36ddd7	306	perf_env__exit(&perf_env);
84c86ca1	307	bpf__clear();
f3a1f0ea	308
07800601 IM	309	if (status)
	310	return status & 0xff;
	311
	312	/* Somebody closed stdout? */
	313	if (fstat(fileno(stdout), &st))
	314	return 0;
	315	/* Ignore write errors for pipes and sockets.. */
	316	if (S_ISFIFO(st.st_mode) \|\| S_ISSOCK(st.st_mode))
	317	return 0;
	318
2a16bf8c	319	status = 1;
07800601	320	/* Check for ENOSPC and EIO errors.. */
2a16bf8c	321	if (fflush(stdout)) {
b2348e1d	322	fprintf(stderr, "write failure on standard output: %s",
c8b5f2c9	323	str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c ACM	324	goto out;
	325	}
	326	if (ferror(stdout)) {
	327	fprintf(stderr, "unknown write failure on standard output");
	328	goto out;
	329	}
	330	if (fclose(stdout)) {
b2348e1d	331	fprintf(stderr, "close failed on standard output: %s",
c8b5f2c9	332	str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c ACM	333	goto out;
	334	}
	335	status = 0;
	336	out:
	337	return status;
07800601 IM	338	}
	339
	340	static void handle_internal_command(int argc, const char **argv)
	341	{
	342	const char *cmd = argv[0];
f37a291c	343	unsigned int i;
07800601 IM	344
	345	/* Turn "perf cmd --help" into "perf help cmd" */
	346	if (argc > 1 && !strcmp(argv[1], "--help")) {
	347	argv[1] = argv[0];
	348	argv[0] = cmd = "help";
	349	}
	350
	351	for (i = 0; i < ARRAY_SIZE(commands); i++) {
	352	struct cmd_struct *p = commands+i;
	353	if (strcmp(p->cmd, cmd))
	354	continue;
	355	exit(run_builtin(p, argc, argv));
	356	}
	357	}
	358
	359	static void execv_dashed_external(const char **argv)
	360	{
5104ffb2	361	char *cmd;
07800601 IM	362	const char *tmp;
	363	int status;
	364
5104ffb2 ACM	365	if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
5104ffb2 ACM	366	goto do_die;
07800601 IM	367
	368	/*
	369	* argv[0] must be the perf command, but the argv array
	370	* belongs to the caller, and may be reused in
	371	* subsequent loop iterations. Save argv[0] and
	372	* restore it on error.
	373	*/
	374	tmp = argv[0];
5104ffb2	375	argv[0] = cmd;
07800601 IM	376
	377	/*
	378	* if we fail because the command is not found, it is
	379	* OK to return. Otherwise, we just pass along the status code.
	380	*/
	381	status = run_command_v_opt(argv, 0);
	382	if (status != -ERR_RUN_COMMAND_EXEC) {
5104ffb2 ACM	383	if (IS_RUN_COMMAND_ERR(status)) {
5104ffb2 ACM	384	do_die:
42774806 ACM	385	pr_err("FATAL: unable to run '%s'", argv[0]);
42774806 ACM	386	status = -128;
5104ffb2	387	}
07800601 IM	388	exit(-status);
	389	}
	390	errno = ENOENT; /* as if we called execvp */
	391
	392	argv[0] = tmp;
5104ffb2	393	zfree(&cmd);
07800601 IM	394	}
	395
	396	static int run_argv(int argcp, const char **argv)
	397	{
c6867701 ACM	398	/* See if it's an internal command */
c6867701 ACM	399	handle_internal_command(argcp, argv);
07800601	400
c6867701 ACM	401	/* .. then try the external ones */
	402	execv_dashed_external(*argv);
	403	return 0;
07800601 IM	404	}
07800601 IM	405
3af6e338 ACM	406	static void pthread__block_sigwinch(void)
	407	{
	408	sigset_t set;
	409
	410	sigemptyset(&set);
	411	sigaddset(&set, SIGWINCH);
	412	pthread_sigmask(SIG_BLOCK, &set, NULL);
	413	}
	414
	415	void pthread__unblock_sigwinch(void)
	416	{
	417	sigset_t set;
	418
	419	sigemptyset(&set);
	420	sigaddset(&set, SIGWINCH);
	421	pthread_sigmask(SIG_UNBLOCK, &set, NULL);
	422	}
	423
9a3dc28b ACM	424	#ifdef _SC_LEVEL1_DCACHE_LINESIZE
	425	#define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
	426	#else
	427	static void cache_line_size(int *cacheline_sizep)
	428	{
	429	if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
8811e8ea	430	pr_debug("cannot determine cache line size");
9a3dc28b ACM	431	}
	432	#endif
	433
07800601 IM	434	int main(int argc, const char **argv)
07800601 IM	435	{
ecc4c561	436	int err;
07800601	437	const char *cmd;
b2348e1d	438	char sbuf[STRERR_BUFSIZE];
4cb93446	439	int value;
07800601	440
096d3558 JP	441	/* libsubcmd init */
	442	exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
	443	pager_init(PERF_PAGER_ENVIRONMENT);
	444
918512b4	445	/* The page_size is placed in util object. */
0c1fe6b2	446	page_size = sysconf(_SC_PAGE_SIZE);
9a3dc28b	447	cache_line_size(&cacheline_size);
0c1fe6b2	448
4cb93446 ACM	449	if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
	450	sysctl_perf_event_max_stack = value;
	451
a29d5c9b ACM	452	if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
	453	sysctl_perf_event_max_contexts_per_stack = value;
	454
46113a54	455	cmd = extract_argv0_path(argv[0]);
07800601 IM	456	if (!cmd)
07800601 IM	457	cmd = "perf-help";
65d4b265	458
14cbfbeb NK	459	srandom(time(NULL));
14cbfbeb NK	460
8a0a9c7e	461	perf_config__init();
ecc4c561 ACM	462	err = perf_config(perf_default_config, NULL);
	463	if (err)
	464	return err;
58cb9d65	465	set_buildid_dir(NULL);
b8cbb349	466
65d4b265 JO	467	/* get debugfs/tracefs mount point from /proc/mounts */
	468	tracing_path_mount();
	469
07800601 IM	470	/*
	471	* "perf-xxxx" is the same as "perf xxxx", but we obviously:
	472	*
	473	* - cannot take flags in between the "perf" and the "xxxx".
	474	* - cannot execute it externally (since it would just do
	475	* the same thing over again)
	476	*
3192f1ed MW	477	* So we just directly call the internal command handler. If that one
	478	* fails to handle this, then maybe we just run a renamed perf binary
	479	* that contains a dash in its name. To handle this scenario, we just
	480	* fall through and ignore the "xxxx" part of the command string.
07800601	481	*/
8e99b6d4	482	if (strstarts(cmd, "perf-")) {
266dfb0b	483	cmd += 5;
07800601 IM	484	argv[0] = cmd;
07800601 IM	485	handle_internal_command(argc, argv);
3192f1ed MW	486	/*
	487	* If the command is handled, the above function does not
	488	* return undo changes and fall through in such a case.
	489	*/
	490	cmd -= 5;
	491	argv[0] = cmd;
07800601	492	}
8e99b6d4	493	if (strstarts(cmd, "trace")) {
22e9af4e	494	#if defined(HAVE_LIBAUDIT_SUPPORT) \|\| defined(HAVE_SYSCALL_TABLE_SUPPORT)
b52bc234 ACM	495	setup_path();
b52bc234 ACM	496	argv[0] = "trace";
b0ad8ea6	497	return cmd_trace(argc, argv);
1b572622 ACM	498	#else
	499	fprintf(stderr,
	500	"trace command not available: missing audit-libs devel package at build time.\n");
	501	goto out;
b52bc234	502	#endif
1b572622	503	}
07800601 IM	504	/* Look for flags.. */
	505	argv++;
	506	argc--;
	507	handle_options(&argv, &argc, NULL);
	508	commit_pager_choice();
45de34bb	509
07800601	510	if (argc > 0) {
8e99b6d4	511	if (strstarts(argv[0], "--"))
07800601 IM	512	argv[0] += 2;
	513	} else {
	514	/* The user didn't specify a command; give them help */
502fc5c7	515	printf("\n usage: %s\n\n", perf_usage_string);
07800601	516	list_common_cmds_help();
502fc5c7	517	printf("\n %s\n\n", perf_more_info_string);
2a16bf8c	518	goto out;
07800601 IM	519	}
	520	cmd = argv[0];
	521
52502bf2 JO	522	test_attr__init();
52502bf2 JO	523
07800601 IM	524	/*
07800601 IM	525	* We use PATH to find perf commands, but we prepend some higher
659431fc	526	* precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
07800601 IM	527	* environment, and the $(perfexecdir) from the Makefile at build
	528	* time.
	529	*/
	530	setup_path();
3af6e338 ACM	531	/*
	532	* Block SIGWINCH notifications so that the thread that wants it can
	533	* unblock and get syscalls like select interrupted instead of waiting
	534	* forever while the signal goes to some other non interested thread.
	535	*/
	536	pthread__block_sigwinch();
07800601	537
dd629cc0 JO	538	perf_debug_setup();
dd629cc0 JO	539
07800601	540	while (1) {
4c574159	541	static int done_help;
c6867701 ACM	542
c6867701 ACM	543	run_argv(&argc, &argv);
8035e428	544
07800601 IM	545	if (errno != ENOENT)
07800601 IM	546	break;
8035e428	547
07800601 IM	548	if (!done_help) {
	549	cmd = argv[0] = help_unknown_cmd(cmd);
	550	done_help = 1;
	551	} else
	552	break;
	553	}
	554
	555	fprintf(stderr, "Failed to run command '%s': %s\n",
c8b5f2c9	556	cmd, str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c	557	out:
07800601 IM	558	return 1;
07800601 IM	559	}