[mirror_ubuntu-zesty-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 "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 <api/fs/fs.h>
#include <api/fs/tracing_path.h>
#include <pthread.h>
#include <stdlib.h>
#include <time.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.";

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

struct cmd_struct {
	const char *cmd;
	int (*fn)(int, const char **, 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 },
	{ "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 },
#ifdef HAVE_LIBAUDIT_SUPPORT
	{ "trace",	cmd_trace,	0 },
#endif
	{ "inject",	cmd_inject,	0 },
	{ "mem",	cmd_mem,	0 },
	{ "data",	cmd_data,	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 (!prefixcmp(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" */
int check_pager_config(const char *cmd)
{
	struct pager_config c;
	c.cmd = cmd;
	c.val = -1;
	perf_config(pager_command_config, &c);
	return c.val;
}

static int browser_command_config(const char *var, const char *value, void *data)
{
	struct pager_config *c = data;
	if (!prefixcmp(var, "tui.") && !strcmp(var + 4, c->cmd))
		c->val = perf_config_bool(var, value);
	if (!prefixcmp(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)
{
	struct pager_config c;
	c.cmd = cmd;
	c.val = -1;
	perf_config(browser_command_config, &c);
	return 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;
		}

		/*
		 * Check remaining flags.
		 */
		if (!prefixcmp(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 (!prefixcmp(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;
}

static int handle_alias(int *argcp, const char ***argv)
{
	int envchanged = 0, ret = 0, saved_errno = errno;
	int count, option_count;
	const char **new_argv;
	const char *alias_command;
	char *alias_string;

	alias_command = (*argv)[0];
	alias_string = alias_lookup(alias_command);
	if (alias_string) {
		if (alias_string[0] == '!') {
			if (*argcp > 1) {
				struct strbuf buf;

				if (strbuf_init(&buf, PATH_MAX) < 0 ||
				    strbuf_addstr(&buf, alias_string) < 0 ||
				    sq_quote_argv(&buf, (*argv) + 1,
						  PATH_MAX) < 0)
					die("Failed to allocate memory.");
				free(alias_string);
				alias_string = buf.buf;
			}
			ret = system(alias_string + 1);
			if (ret >= 0 && WIFEXITED(ret) &&
			    WEXITSTATUS(ret) != 127)
				exit(WEXITSTATUS(ret));
			die("Failed to run '%s' when expanding alias '%s'",
			    alias_string + 1, alias_command);
		}
		count = split_cmdline(alias_string, &new_argv);
		if (count < 0)
			die("Bad alias.%s string", alias_command);
		option_count = handle_options(&new_argv, &count, &envchanged);
		if (envchanged)
			die("alias '%s' changes environment variables\n"
				 "You can use '!perf' in the alias to do this.",
				 alias_command);
		memmove(new_argv - option_count, new_argv,
				count * sizeof(char *));
		new_argv -= option_count;

		if (count < 1)
			die("empty alias for %s", alias_command);

		if (!strcmp(alias_command, new_argv[0]))
			die("recursive alias: %s", alias_command);

		new_argv = realloc(new_argv, sizeof(char *) *
				    (count + *argcp + 1));
		/* insert after command name */
		memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
		new_argv[count + *argcp] = NULL;

		*argv = new_argv;
		*argcp += count - 1;

		ret = 1;
	}

	errno = saved_errno;

	return ret;
}

const char perf_version_string[] = PERF_VERSION;

#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;
	const char *prefix;
	char sbuf[STRERR_BUFSIZE];

	prefix = NULL;
	if (p->option & RUN_SETUP)
		prefix = NULL; /* setup_perf_directory(); */

	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, prefix);
	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;
	static const char ext[] = STRIP_EXTENSION;

	if (sizeof(ext) > 1) {
		i = strlen(argv[0]) - strlen(ext);
		if (i > 0 && !strcmp(argv[0] + i, ext)) {
			char *argv0 = strdup(argv[0]);
			argv[0] = cmd = argv0;
			argv0[i] = '\0';
		}
	}

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

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

static int run_argv(int *argcp, const char ***argv)
{
	int done_alias = 0;

	while (1) {
		/* See if it's an internal command */
		handle_internal_command(*argcp, *argv);

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

		/* It could be an alias -- this works around the insanity
		 * of overriding "perf log" with "perf show" by having
		 * alias.log = show
		 */
		if (done_alias || !handle_alias(argcp, argv))
			break;
		done_alias = 1;
	}

	return done_alias;
}

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)
{
	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();
	perf_config(perf_default_config, NULL);
	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, and
	 * die if that one cannot handle it.
	 */
	if (!prefixcmp(cmd, "perf-")) {
		cmd += 5;
		argv[0] = cmd;
		handle_internal_command(argc, argv);
		fprintf(stderr, "cannot handle %s internally", cmd);
		goto out;
	}
	if (!prefixcmp(cmd, "trace")) {
#ifdef HAVE_LIBAUDIT_SUPPORT
		setup_path();
		argv[0] = "trace";
		return cmd_trace(argc, argv, NULL);
#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 (!prefixcmp(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;
		int was_alias = run_argv(&argc, &argv);

		if (errno != ENOENT)
			break;

		if (was_alias) {
			fprintf(stderr, "Expansion of alias '%s' failed; "
				"'%s' is not a perf-command\n",
				cmd, argv[0]);
			goto out;
		}
		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"
bf9e1876	10
aa36ddd7	11	#include "util/env.h"
4b6ab94e	12	#include <subcmd/exec-cmd.h>
41840d21	13	#include "util/config.h"
148be2c1	14	#include "util/quote.h"
4b6ab94e	15	#include <subcmd/run-command.h>
5beeded1	16	#include "util/parse-events.h"
4b6ab94e	17	#include <subcmd/parse-options.h>
84c86ca1	18	#include "util/bpf-loader.h"
bbb2cea7	19	#include "util/debug.h"
4cb93446	20	#include <api/fs/fs.h>
592d5a6b	21	#include <api/fs/tracing_path.h>
27683dc5	22	#include <pthread.h>
14cbfbeb NK	23	#include <stdlib.h>
14cbfbeb NK	24	#include <time.h>
07800601 IM	25
07800601 IM	26	const char perf_usage_string[] =
78a1b503	27	"perf [--version] [--help] [OPTIONS] COMMAND [ARGS]";
07800601 IM	28
	29	const char perf_more_info_string[] =
	30	"See 'perf help COMMAND' for more information on a specific command.";
	31
5d06e691	32	int use_browser = -1;
07800601	33	static int use_pager = -1;
70cb4e96	34	const char *input_name;
5d06e691	35
98a4179c FW	36	struct cmd_struct {
	37	const char *cmd;
	38	int (fn)(int, const char , const char );
	39	int option;
	40	};
	41
	42	static struct cmd_struct commands[] = {
	43	{ "buildid-cache", cmd_buildid_cache, 0 },
	44	{ "buildid-list", cmd_buildid_list, 0 },
30862f2c	45	{ "config", cmd_config, 0 },
7aef3bf3	46	{ "c2c", cmd_c2c, 0 },
98a4179c FW	47	{ "diff", cmd_diff, 0 },
	48	{ "evlist", cmd_evlist, 0 },
	49	{ "help", cmd_help, 0 },
	50	{ "list", cmd_list, 0 },
	51	{ "record", cmd_record, 0 },
	52	{ "report", cmd_report, 0 },
	53	{ "bench", cmd_bench, 0 },
	54	{ "stat", cmd_stat, 0 },
	55	{ "timechart", cmd_timechart, 0 },
	56	{ "top", cmd_top, 0 },
	57	{ "annotate", cmd_annotate, 0 },
	58	{ "version", cmd_version, 0 },
	59	{ "script", cmd_script, 0 },
	60	{ "sched", cmd_sched, 0 },
89fe808a	61	#ifdef HAVE_LIBELF_SUPPORT
98a4179c	62	{ "probe", cmd_probe, 0 },
393be2e3	63	#endif
98a4179c FW	64	{ "kmem", cmd_kmem, 0 },
	65	{ "lock", cmd_lock, 0 },
	66	{ "kvm", cmd_kvm, 0 },
	67	{ "test", cmd_test, 0 },
89fe808a	68	#ifdef HAVE_LIBAUDIT_SUPPORT
514f1c67	69	{ "trace", cmd_trace, 0 },
4d29089c	70	#endif
98a4179c	71	{ "inject", cmd_inject, 0 },
028f12ee	72	{ "mem", cmd_mem, 0 },
2245bf14	73	{ "data", cmd_data, 0 },
98a4179c FW	74	};
98a4179c FW	75
07800601 IM	76	struct pager_config {
	77	const char *cmd;
	78	int val;
	79	};
	80
	81	static int pager_command_config(const char var, const char value, void *data)
	82	{
	83	struct pager_config *c = data;
	84	if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
	85	c->val = perf_config_bool(var, value);
	86	return 0;
	87	}
	88
	89	/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
	90	int check_pager_config(const char *cmd)
	91	{
	92	struct pager_config c;
	93	c.cmd = cmd;
	94	c.val = -1;
	95	perf_config(pager_command_config, &c);
	96	return c.val;
	97	}
	98
0020ce23	99	static int browser_command_config(const char var, const char value, void *data)
5d06e691 ACM	100	{
	101	struct pager_config *c = data;
	102	if (!prefixcmp(var, "tui.") && !strcmp(var + 4, c->cmd))
	103	c->val = perf_config_bool(var, value);
0020ce23 NK	104	if (!prefixcmp(var, "gtk.") && !strcmp(var + 4, c->cmd))
0020ce23 NK	105	c->val = perf_config_bool(var, value) ? 2 : 0;
5d06e691 ACM	106	return 0;
	107	}
	108
0020ce23 NK	109	/*
	110	* returns 0 for "no tui", 1 for "use tui", 2 for "use gtk",
	111	* and -1 for "not specified"
	112	*/
	113	static int check_browser_config(const char *cmd)
5d06e691 ACM	114	{
	115	struct pager_config c;
	116	c.cmd = cmd;
	117	c.val = -1;
0020ce23	118	perf_config(browser_command_config, &c);
5d06e691 ACM	119	return c.val;
	120	}
	121
4c574159 TF	122	static void commit_pager_choice(void)
4c574159 TF	123	{
07800601 IM	124	switch (use_pager) {
07800601 IM	125	case 0:
096d3558	126	setenv(PERF_PAGER_ENVIRONMENT, "cat", 1);
07800601 IM	127	break;
	128	case 1:
	129	/* setup_pager(); */
	130	break;
	131	default:
	132	break;
	133	}
	134	}
	135
7335399a YS	136	struct option options[] = {
	137	OPT_ARGUMENT("help", "help"),
	138	OPT_ARGUMENT("version", "version"),
	139	OPT_ARGUMENT("exec-path", "exec-path"),
	140	OPT_ARGUMENT("html-path", "html-path"),
	141	OPT_ARGUMENT("paginate", "paginate"),
	142	OPT_ARGUMENT("no-pager", "no-pager"),
7335399a YS	143	OPT_ARGUMENT("debugfs-dir", "debugfs-dir"),
	144	OPT_ARGUMENT("buildid-dir", "buildid-dir"),
	145	OPT_ARGUMENT("list-cmds", "list-cmds"),
	146	OPT_ARGUMENT("list-opts", "list-opts"),
	147	OPT_ARGUMENT("debug", "debug"),
	148	OPT_END()
	149	};
	150
4c574159	151	static int handle_options(const char **argv, int argc, int *envchanged)
07800601 IM	152	{
	153	int handled = 0;
	154
	155	while (*argc > 0) {
	156	const char cmd = (argv)[0];
	157	if (cmd[0] != '-')
	158	break;
	159
	160	/*
	161	* For legacy reasons, the "version" and "help"
	162	* commands can be written with "--" prepended
	163	* to make them look like flags.
	164	*/
	165	if (!strcmp(cmd, "--help") \|\| !strcmp(cmd, "--version"))
	166	break;
	167
a1853e2c JO	168	/*
	169	* Shortcut for '-h' and '-v' options to invoke help
	170	* and version command.
	171	*/
	172	if (!strcmp(cmd, "-h")) {
	173	(*argv)[0] = "--help";
	174	break;
	175	}
	176
	177	if (!strcmp(cmd, "-v")) {
	178	(*argv)[0] = "--version";
	179	break;
	180	}
	181
07800601 IM	182	/*
	183	* Check remaining flags.
	184	*/
cfed95a6 VL	185	if (!prefixcmp(cmd, CMD_EXEC_PATH)) {
cfed95a6 VL	186	cmd += strlen(CMD_EXEC_PATH);
07800601	187	if (*cmd == '=')
46113a54	188	set_argv_exec_path(cmd + 1);
07800601	189	else {
46113a54	190	puts(get_argv_exec_path());
07800601 IM	191	exit(0);
	192	}
	193	} else if (!strcmp(cmd, "--html-path")) {
	194	puts(system_path(PERF_HTML_PATH));
	195	exit(0);
	196	} else if (!strcmp(cmd, "-p") \|\| !strcmp(cmd, "--paginate")) {
	197	use_pager = 1;
	198	} else if (!strcmp(cmd, "--no-pager")) {
	199	use_pager = 0;
	200	if (envchanged)
	201	*envchanged = 1;
5beeded1 JB	202	} else if (!strcmp(cmd, "--debugfs-dir")) {
	203	if (*argc < 2) {
	204	fprintf(stderr, "No directory given for --debugfs-dir.\n");
	205	usage(perf_usage_string);
	206	}
65d4b265	207	tracing_path_set((*argv)[1]);
5beeded1 JB	208	if (envchanged)
	209	*envchanged = 1;
	210	(*argv)++;
	211	(*argc)--;
99ce8e9f JO	212	} else if (!strcmp(cmd, "--buildid-dir")) {
	213	if (*argc < 2) {
	214	fprintf(stderr, "No directory given for --buildid-dir.\n");
	215	usage(perf_usage_string);
	216	}
	217	set_buildid_dir((*argv)[1]);
	218	if (envchanged)
	219	*envchanged = 1;
	220	(*argv)++;
	221	(*argc)--;
cfed95a6	222	} else if (!prefixcmp(cmd, CMD_DEBUGFS_DIR)) {
65d4b265	223	tracing_path_set(cmd + strlen(CMD_DEBUGFS_DIR));
9f30fffc	224	fprintf(stderr, "dir: %s\n", tracing_path);
5beeded1 JB	225	if (envchanged)
5beeded1 JB	226	*envchanged = 1;
98a4179c FW	227	} else if (!strcmp(cmd, "--list-cmds")) {
	228	unsigned int i;
	229
	230	for (i = 0; i < ARRAY_SIZE(commands); i++) {
	231	struct cmd_struct *p = commands+i;
	232	printf("%s ", p->cmd);
	233	}
ed457520	234	putchar('\n');
98a4179c	235	exit(0);
7335399a YS	236	} else if (!strcmp(cmd, "--list-opts")) {
	237	unsigned int i;
	238
	239	for (i = 0; i < ARRAY_SIZE(options)-1; i++) {
	240	struct option *p = options+i;
	241	printf("--%s ", p->long_name);
	242	}
	243	putchar('\n');
	244	exit(0);
bbb2cea7 JO	245	} else if (!strcmp(cmd, "--debug")) {
	246	if (*argc < 2) {
	247	fprintf(stderr, "No variable specified for --debug.\n");
	248	usage(perf_usage_string);
	249	}
	250	if (perf_debug_option((*argv)[1]))
	251	usage(perf_usage_string);
	252
	253	(*argv)++;
	254	(*argc)--;
07800601 IM	255	} else {
	256	fprintf(stderr, "Unknown option: %s\n", cmd);
	257	usage(perf_usage_string);
	258	}
	259
	260	(*argv)++;
	261	(*argc)--;
	262	handled++;
	263	}
	264	return handled;
	265	}
	266
	267	static int handle_alias(int argcp, const char **argv)
	268	{
	269	int envchanged = 0, ret = 0, saved_errno = errno;
	270	int count, option_count;
4c574159	271	const char **new_argv;
07800601 IM	272	const char *alias_command;
07800601 IM	273	char *alias_string;
07800601 IM	274
	275	alias_command = (*argv)[0];
	276	alias_string = alias_lookup(alias_command);
	277	if (alias_string) {
	278	if (alias_string[0] == '!') {
	279	if (*argcp > 1) {
	280	struct strbuf buf;
	281
70a6898f MH	282	if (strbuf_init(&buf, PATH_MAX) < 0 \|\|
	283	strbuf_addstr(&buf, alias_string) < 0 \|\|
	284	sq_quote_argv(&buf, (*argv) + 1,
	285	PATH_MAX) < 0)
	286	die("Failed to allocate memory.");
07800601 IM	287	free(alias_string);
	288	alias_string = buf.buf;
	289	}
	290	ret = system(alias_string + 1);
	291	if (ret >= 0 && WIFEXITED(ret) &&
	292	WEXITSTATUS(ret) != 127)
	293	exit(WEXITSTATUS(ret));
	294	die("Failed to run '%s' when expanding alias '%s'",
	295	alias_string + 1, alias_command);
	296	}
	297	count = split_cmdline(alias_string, &new_argv);
	298	if (count < 0)
	299	die("Bad alias.%s string", alias_command);
	300	option_count = handle_options(&new_argv, &count, &envchanged);
	301	if (envchanged)
	302	die("alias '%s' changes environment variables\n"
	303	"You can use '!perf' in the alias to do this.",
	304	alias_command);
	305	memmove(new_argv - option_count, new_argv,
	306	count * sizeof(char *));
	307	new_argv -= option_count;
	308
	309	if (count < 1)
	310	die("empty alias for %s", alias_command);
	311
	312	if (!strcmp(alias_command, new_argv[0]))
	313	die("recursive alias: %s", alias_command);
	314
4c574159	315	new_argv = realloc(new_argv, sizeof(char )
07800601 IM	316	(count + *argcp + 1));
07800601 IM	317	/* insert after command name */
4c574159 TF	318	memcpy(new_argv + count, argv + 1, sizeof(char ) * *argcp);
4c574159 TF	319	new_argv[count + *argcp] = NULL;
07800601 IM	320
	321	*argv = new_argv;
	322	*argcp += count - 1;
	323
	324	ret = 1;
	325	}
	326
	327	errno = saved_errno;
	328
	329	return ret;
	330	}
	331
	332	const char perf_version_string[] = PERF_VERSION;
	333
	334	#define RUN_SETUP (1<<0)
	335	#define USE_PAGER (1<<1)
07800601	336
07800601 IM	337	static int run_builtin(struct cmd_struct p, int argc, const char *argv)
	338	{
	339	int status;
	340	struct stat st;
	341	const char *prefix;
b2348e1d	342	char sbuf[STRERR_BUFSIZE];
07800601 IM	343
	344	prefix = NULL;
	345	if (p->option & RUN_SETUP)
	346	prefix = NULL; /* setup_perf_directory(); */
	347
5d06e691	348	if (use_browser == -1)
0020ce23	349	use_browser = check_browser_config(p->cmd);
5d06e691	350
07800601 IM	351	if (use_pager == -1 && p->option & RUN_SETUP)
	352	use_pager = check_pager_config(p->cmd);
	353	if (use_pager == -1 && p->option & USE_PAGER)
	354	use_pager = 1;
	355	commit_pager_choice();
	356
2bdb2c27	357	perf_env__set_cmdline(&perf_env, argc, argv);
07800601	358	status = p->fn(argc, argv, prefix);
8a0a9c7e	359	perf_config__exit();
f3a1f0ea	360	exit_browser(status);
aa36ddd7	361	perf_env__exit(&perf_env);
84c86ca1	362	bpf__clear();
f3a1f0ea	363
07800601 IM	364	if (status)
	365	return status & 0xff;
	366
	367	/* Somebody closed stdout? */
	368	if (fstat(fileno(stdout), &st))
	369	return 0;
	370	/* Ignore write errors for pipes and sockets.. */
	371	if (S_ISFIFO(st.st_mode) \|\| S_ISSOCK(st.st_mode))
	372	return 0;
	373
2a16bf8c	374	status = 1;
07800601	375	/* Check for ENOSPC and EIO errors.. */
2a16bf8c	376	if (fflush(stdout)) {
b2348e1d	377	fprintf(stderr, "write failure on standard output: %s",
c8b5f2c9	378	str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c ACM	379	goto out;
	380	}
	381	if (ferror(stdout)) {
	382	fprintf(stderr, "unknown write failure on standard output");
	383	goto out;
	384	}
	385	if (fclose(stdout)) {
b2348e1d	386	fprintf(stderr, "close failed on standard output: %s",
c8b5f2c9	387	str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c ACM	388	goto out;
	389	}
	390	status = 0;
	391	out:
	392	return status;
07800601 IM	393	}
	394
	395	static void handle_internal_command(int argc, const char **argv)
	396	{
	397	const char *cmd = argv[0];
f37a291c	398	unsigned int i;
07800601 IM	399	static const char ext[] = STRIP_EXTENSION;
	400
	401	if (sizeof(ext) > 1) {
	402	i = strlen(argv[0]) - strlen(ext);
	403	if (i > 0 && !strcmp(argv[0] + i, ext)) {
	404	char *argv0 = strdup(argv[0]);
	405	argv[0] = cmd = argv0;
	406	argv0[i] = '\0';
	407	}
	408	}
	409
	410	/* Turn "perf cmd --help" into "perf help cmd" */
	411	if (argc > 1 && !strcmp(argv[1], "--help")) {
	412	argv[1] = argv[0];
	413	argv[0] = cmd = "help";
	414	}
	415
	416	for (i = 0; i < ARRAY_SIZE(commands); i++) {
	417	struct cmd_struct *p = commands+i;
	418	if (strcmp(p->cmd, cmd))
	419	continue;
	420	exit(run_builtin(p, argc, argv));
	421	}
	422	}
	423
	424	static void execv_dashed_external(const char **argv)
	425	{
5104ffb2	426	char *cmd;
07800601 IM	427	const char *tmp;
	428	int status;
	429
5104ffb2 ACM	430	if (asprintf(&cmd, "perf-%s", argv[0]) < 0)
5104ffb2 ACM	431	goto do_die;
07800601 IM	432
	433	/*
	434	* argv[0] must be the perf command, but the argv array
	435	* belongs to the caller, and may be reused in
	436	* subsequent loop iterations. Save argv[0] and
	437	* restore it on error.
	438	*/
	439	tmp = argv[0];
5104ffb2	440	argv[0] = cmd;
07800601 IM	441
	442	/*
	443	* if we fail because the command is not found, it is
	444	* OK to return. Otherwise, we just pass along the status code.
	445	*/
	446	status = run_command_v_opt(argv, 0);
	447	if (status != -ERR_RUN_COMMAND_EXEC) {
5104ffb2 ACM	448	if (IS_RUN_COMMAND_ERR(status)) {
5104ffb2 ACM	449	do_die:
07800601	450	die("unable to run '%s'", argv[0]);
5104ffb2	451	}
07800601 IM	452	exit(-status);
	453	}
	454	errno = ENOENT; /* as if we called execvp */
	455
	456	argv[0] = tmp;
5104ffb2	457	zfree(&cmd);
07800601 IM	458	}
	459
	460	static int run_argv(int argcp, const char **argv)
	461	{
	462	int done_alias = 0;
	463
	464	while (1) {
	465	/* See if it's an internal command */
	466	handle_internal_command(argcp, argv);
	467
	468	/* .. then try the external ones */
	469	execv_dashed_external(*argv);
	470
	471	/* It could be an alias -- this works around the insanity
	472	* of overriding "perf log" with "perf show" by having
	473	* alias.log = show
	474	*/
	475	if (done_alias \|\| !handle_alias(argcp, argv))
	476	break;
	477	done_alias = 1;
	478	}
	479
	480	return done_alias;
	481	}
	482
3af6e338 ACM	483	static void pthread__block_sigwinch(void)
	484	{
	485	sigset_t set;
	486
	487	sigemptyset(&set);
	488	sigaddset(&set, SIGWINCH);
	489	pthread_sigmask(SIG_BLOCK, &set, NULL);
	490	}
	491
	492	void pthread__unblock_sigwinch(void)
	493	{
	494	sigset_t set;
	495
	496	sigemptyset(&set);
	497	sigaddset(&set, SIGWINCH);
	498	pthread_sigmask(SIG_UNBLOCK, &set, NULL);
	499	}
	500
9a3dc28b ACM	501	#ifdef _SC_LEVEL1_DCACHE_LINESIZE
	502	#define cache_line_size(cacheline_sizep) *cacheline_sizep = sysconf(_SC_LEVEL1_DCACHE_LINESIZE)
	503	#else
	504	static void cache_line_size(int *cacheline_sizep)
	505	{
	506	if (sysfs__read_int("devices/system/cpu/cpu0/cache/index0/coherency_line_size", cacheline_sizep))
8811e8ea	507	pr_debug("cannot determine cache line size");
9a3dc28b ACM	508	}
	509	#endif
	510
07800601 IM	511	int main(int argc, const char **argv)
	512	{
	513	const char *cmd;
b2348e1d	514	char sbuf[STRERR_BUFSIZE];
4cb93446	515	int value;
07800601	516
096d3558 JP	517	/* libsubcmd init */
	518	exec_cmd_init("perf", PREFIX, PERF_EXEC_PATH, EXEC_PATH_ENVIRONMENT);
	519	pager_init(PERF_PAGER_ENVIRONMENT);
	520
918512b4	521	/* The page_size is placed in util object. */
0c1fe6b2	522	page_size = sysconf(_SC_PAGE_SIZE);
9a3dc28b	523	cache_line_size(&cacheline_size);
0c1fe6b2	524
4cb93446 ACM	525	if (sysctl__read_int("kernel/perf_event_max_stack", &value) == 0)
	526	sysctl_perf_event_max_stack = value;
	527
a29d5c9b ACM	528	if (sysctl__read_int("kernel/perf_event_max_contexts_per_stack", &value) == 0)
	529	sysctl_perf_event_max_contexts_per_stack = value;
	530
46113a54	531	cmd = extract_argv0_path(argv[0]);
07800601 IM	532	if (!cmd)
07800601 IM	533	cmd = "perf-help";
65d4b265	534
14cbfbeb NK	535	srandom(time(NULL));
14cbfbeb NK	536
8a0a9c7e	537	perf_config__init();
b8cbb349	538	perf_config(perf_default_config, NULL);
58cb9d65	539	set_buildid_dir(NULL);
b8cbb349	540
65d4b265 JO	541	/* get debugfs/tracefs mount point from /proc/mounts */
	542	tracing_path_mount();
	543
07800601 IM	544	/*
	545	* "perf-xxxx" is the same as "perf xxxx", but we obviously:
	546	*
	547	* - cannot take flags in between the "perf" and the "xxxx".
	548	* - cannot execute it externally (since it would just do
	549	* the same thing over again)
	550	*
	551	* So we just directly call the internal command handler, and
	552	* die if that one cannot handle it.
	553	*/
	554	if (!prefixcmp(cmd, "perf-")) {
266dfb0b	555	cmd += 5;
07800601 IM	556	argv[0] = cmd;
07800601 IM	557	handle_internal_command(argc, argv);
2a16bf8c ACM	558	fprintf(stderr, "cannot handle %s internally", cmd);
2a16bf8c ACM	559	goto out;
07800601	560	}
b52bc234	561	if (!prefixcmp(cmd, "trace")) {
1b572622	562	#ifdef HAVE_LIBAUDIT_SUPPORT
b52bc234 ACM	563	setup_path();
	564	argv[0] = "trace";
	565	return cmd_trace(argc, argv, NULL);
1b572622 ACM	566	#else
	567	fprintf(stderr,
	568	"trace command not available: missing audit-libs devel package at build time.\n");
	569	goto out;
b52bc234	570	#endif
1b572622	571	}
07800601 IM	572	/* Look for flags.. */
	573	argv++;
	574	argc--;
	575	handle_options(&argv, &argc, NULL);
	576	commit_pager_choice();
45de34bb	577
07800601 IM	578	if (argc > 0) {
	579	if (!prefixcmp(argv[0], "--"))
	580	argv[0] += 2;
	581	} else {
	582	/* The user didn't specify a command; give them help */
502fc5c7	583	printf("\n usage: %s\n\n", perf_usage_string);
07800601	584	list_common_cmds_help();
502fc5c7	585	printf("\n %s\n\n", perf_more_info_string);
2a16bf8c	586	goto out;
07800601 IM	587	}
	588	cmd = argv[0];
	589
52502bf2 JO	590	test_attr__init();
52502bf2 JO	591
07800601 IM	592	/*
07800601 IM	593	* We use PATH to find perf commands, but we prepend some higher
659431fc	594	* precedence paths: the "--exec-path" option, the PERF_EXEC_PATH
07800601 IM	595	* environment, and the $(perfexecdir) from the Makefile at build
	596	* time.
	597	*/
	598	setup_path();
3af6e338 ACM	599	/*
	600	* Block SIGWINCH notifications so that the thread that wants it can
	601	* unblock and get syscalls like select interrupted instead of waiting
	602	* forever while the signal goes to some other non interested thread.
	603	*/
	604	pthread__block_sigwinch();
07800601	605
dd629cc0 JO	606	perf_debug_setup();
dd629cc0 JO	607
07800601	608	while (1) {
4c574159	609	static int done_help;
b5ded713	610	int was_alias = run_argv(&argc, &argv);
8035e428	611
07800601 IM	612	if (errno != ENOENT)
07800601 IM	613	break;
8035e428	614
07800601 IM	615	if (was_alias) {
	616	fprintf(stderr, "Expansion of alias '%s' failed; "
	617	"'%s' is not a perf-command\n",
	618	cmd, argv[0]);
2a16bf8c	619	goto out;
07800601 IM	620	}
	621	if (!done_help) {
	622	cmd = argv[0] = help_unknown_cmd(cmd);
	623	done_help = 1;
	624	} else
	625	break;
	626	}
	627
	628	fprintf(stderr, "Failed to run command '%s': %s\n",
c8b5f2c9	629	cmd, str_error_r(errno, sbuf, sizeof(sbuf)));
2a16bf8c	630	out:
07800601 IM	631	return 1;
07800601 IM	632	}