[linux-2.6-block.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/cache.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/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 },
	{ "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("perf-dir", "perf-dir"),
	OPT_ARGUMENT("work-tree", "work-tree"),
	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, "--perf-dir")) {
			if (*argc < 2) {
				fprintf(stderr, "No directory given for --perf-dir.\n");
				usage(perf_usage_string);
			}
			setenv(PERF_DIR_ENVIRONMENT, (*argv)[1], 1);
			if (envchanged)
				*envchanged = 1;
			(*argv)++;
			(*argc)--;
			handled++;
		} else if (!prefixcmp(cmd, CMD_PERF_DIR)) {
			setenv(PERF_DIR_ENVIRONMENT, cmd + strlen(CMD_PERF_DIR), 1);
			if (envchanged)
				*envchanged = 1;
		} else if (!strcmp(cmd, "--work-tree")) {
			if (*argc < 2) {
				fprintf(stderr, "No directory given for --work-tree.\n");
				usage(perf_usage_string);
			}
			setenv(PERF_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
			if (envchanged)
				*envchanged = 1;
			(*argv)++;
			(*argc)--;
		} else if (!prefixcmp(cmd, CMD_WORK_TREE)) {
			setenv(PERF_WORK_TREE_ENVIRONMENT, cmd + strlen(CMD_WORK_TREE), 1);
			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;

				strbuf_init(&buf, PATH_MAX);
				strbuf_addstr(&buf, alias_string);
				sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
				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)
/*
 * require working tree to be present -- anything uses this needs
 * RUN_SETUP for reading from the configuration file.
 */
#define NEED_WORK_TREE	(1<<2)

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);
	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",
			strerror_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",
			strerror_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);
}

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

	/* 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);
	cacheline_size = sysconf(_SC_LEVEL1_DCACHE_LINESIZE);

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

	srandom(time(NULL));

	perf_config(perf_default_config, 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
		set_buildid_dir(NULL);
		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();
	set_buildid_dir(NULL);

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