perf.c

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