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