1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (c) 2013 LG Electronics, Namhyung Kim <namhyung@kernel.org>
6 * Copyright (c) 2020 Changbin Du <changbin.du@gmail.com>, significant enhancement.
19 #include <linux/capability.h>
20 #include <linux/string.h>
23 #include <subcmd/pager.h>
24 #include <subcmd/parse-options.h>
25 #include <api/fs/tracing_path.h>
29 #include "thread_map.h"
30 #include "strfilter.h"
32 #include "util/config.h"
33 #include "util/ftrace.h"
34 #include "util/units.h"
35 #include "util/parse-sublevel-options.h"
37 #define DEFAULT_TRACER "function_graph"
39 static volatile sig_atomic_t workload_exec_errno;
40 static volatile sig_atomic_t done;
42 static void sig_handler(int sig __maybe_unused)
48 * evlist__prepare_workload will send a SIGUSR1 if the fork fails, since
49 * we asked by setting its exec_error to the function below,
50 * ftrace__workload_exec_failed_signal.
52 * XXX We need to handle this more appropriately, emitting an error, etc.
54 static void ftrace__workload_exec_failed_signal(int signo __maybe_unused,
55 siginfo_t *info __maybe_unused,
56 void *ucontext __maybe_unused)
58 workload_exec_errno = info->si_value.sival_int;
62 static int __write_tracing_file(const char *name, const char *val, bool append)
66 ssize_t size = strlen(val);
71 file = get_tracing_file(name);
73 pr_debug("cannot get tracing file: %s\n", name);
82 fd = open(file, flags);
84 pr_debug("cannot open tracing file: %s: %s\n",
85 name, str_error_r(errno, errbuf, sizeof(errbuf)));
90 * Copy the original value and append a '\n'. Without this,
91 * the kernel can hide possible errors.
93 val_copy = strdup(val);
96 val_copy[size] = '\n';
98 if (write(fd, val_copy, size + 1) == size + 1)
101 pr_debug("write '%s' to tracing/%s failed: %s\n",
102 val, name, str_error_r(errno, errbuf, sizeof(errbuf)));
108 put_tracing_file(file);
112 static int write_tracing_file(const char *name, const char *val)
114 return __write_tracing_file(name, val, false);
117 static int append_tracing_file(const char *name, const char *val)
119 return __write_tracing_file(name, val, true);
122 static int read_tracing_file_to_stdout(const char *name)
129 file = get_tracing_file(name);
131 pr_debug("cannot get tracing file: %s\n", name);
135 fd = open(file, O_RDONLY);
137 pr_debug("cannot open tracing file: %s: %s\n",
138 name, str_error_r(errno, buf, sizeof(buf)));
142 /* read contents to stdout */
144 int n = read(fd, buf, sizeof(buf));
150 if (fwrite(buf, n, 1, stdout) != 1)
158 put_tracing_file(file);
162 static int read_tracing_file_by_line(const char *name,
163 void (*cb)(char *str, void *arg),
171 file = get_tracing_file(name);
173 pr_debug("cannot get tracing file: %s\n", name);
177 fp = fopen(file, "r");
179 pr_debug("cannot open tracing file: %s\n", name);
180 put_tracing_file(file);
184 while (getline(&line, &len, fp) != -1) {
192 put_tracing_file(file);
196 static int write_tracing_file_int(const char *name, int value)
200 snprintf(buf, sizeof(buf), "%d", value);
201 if (write_tracing_file(name, buf) < 0)
207 static int write_tracing_option_file(const char *name, const char *val)
212 if (asprintf(&file, "options/%s", name) < 0)
215 ret = __write_tracing_file(file, val, false);
220 static int reset_tracing_cpu(void);
221 static void reset_tracing_filters(void);
223 static void reset_tracing_options(struct perf_ftrace *ftrace __maybe_unused)
225 write_tracing_option_file("function-fork", "0");
226 write_tracing_option_file("func_stack_trace", "0");
227 write_tracing_option_file("sleep-time", "1");
228 write_tracing_option_file("funcgraph-irqs", "1");
229 write_tracing_option_file("funcgraph-proc", "0");
230 write_tracing_option_file("funcgraph-abstime", "0");
231 write_tracing_option_file("latency-format", "0");
232 write_tracing_option_file("irq-info", "0");
235 static int reset_tracing_files(struct perf_ftrace *ftrace __maybe_unused)
237 if (write_tracing_file("tracing_on", "0") < 0)
240 if (write_tracing_file("current_tracer", "nop") < 0)
243 if (write_tracing_file("set_ftrace_pid", " ") < 0)
246 if (reset_tracing_cpu() < 0)
249 if (write_tracing_file("max_graph_depth", "0") < 0)
252 if (write_tracing_file("tracing_thresh", "0") < 0)
255 reset_tracing_filters();
256 reset_tracing_options(ftrace);
260 static int set_tracing_pid(struct perf_ftrace *ftrace)
265 if (target__has_cpu(&ftrace->target))
268 for (i = 0; i < perf_thread_map__nr(ftrace->evlist->core.threads); i++) {
269 scnprintf(buf, sizeof(buf), "%d",
270 perf_thread_map__pid(ftrace->evlist->core.threads, i));
271 if (append_tracing_file("set_ftrace_pid", buf) < 0)
277 static int set_tracing_cpumask(struct perf_cpu_map *cpumap)
284 last_cpu = perf_cpu_map__cpu(cpumap, perf_cpu_map__nr(cpumap) - 1).cpu;
285 mask_size = last_cpu / 4 + 2; /* one more byte for EOS */
286 mask_size += last_cpu / 32; /* ',' is needed for every 32th cpus */
288 cpumask = malloc(mask_size);
289 if (cpumask == NULL) {
290 pr_debug("failed to allocate cpu mask\n");
294 cpu_map__snprint_mask(cpumap, cpumask, mask_size);
296 ret = write_tracing_file("tracing_cpumask", cpumask);
302 static int set_tracing_cpu(struct perf_ftrace *ftrace)
304 struct perf_cpu_map *cpumap = ftrace->evlist->core.user_requested_cpus;
306 if (!target__has_cpu(&ftrace->target))
309 return set_tracing_cpumask(cpumap);
312 static int set_tracing_func_stack_trace(struct perf_ftrace *ftrace)
314 if (!ftrace->func_stack_trace)
317 if (write_tracing_option_file("func_stack_trace", "1") < 0)
323 static int set_tracing_func_irqinfo(struct perf_ftrace *ftrace)
325 if (!ftrace->func_irq_info)
328 if (write_tracing_option_file("irq-info", "1") < 0)
334 static int reset_tracing_cpu(void)
336 struct perf_cpu_map *cpumap = perf_cpu_map__new(NULL);
339 ret = set_tracing_cpumask(cpumap);
340 perf_cpu_map__put(cpumap);
344 static int __set_tracing_filter(const char *filter_file, struct list_head *funcs)
346 struct filter_entry *pos;
348 list_for_each_entry(pos, funcs, list) {
349 if (append_tracing_file(filter_file, pos->name) < 0)
356 static int set_tracing_filters(struct perf_ftrace *ftrace)
360 ret = __set_tracing_filter("set_ftrace_filter", &ftrace->filters);
364 ret = __set_tracing_filter("set_ftrace_notrace", &ftrace->notrace);
368 ret = __set_tracing_filter("set_graph_function", &ftrace->graph_funcs);
372 /* old kernels do not have this filter */
373 __set_tracing_filter("set_graph_notrace", &ftrace->nograph_funcs);
378 static void reset_tracing_filters(void)
380 write_tracing_file("set_ftrace_filter", " ");
381 write_tracing_file("set_ftrace_notrace", " ");
382 write_tracing_file("set_graph_function", " ");
383 write_tracing_file("set_graph_notrace", " ");
386 static int set_tracing_depth(struct perf_ftrace *ftrace)
388 if (ftrace->graph_depth == 0)
391 if (ftrace->graph_depth < 0) {
392 pr_err("invalid graph depth: %d\n", ftrace->graph_depth);
396 if (write_tracing_file_int("max_graph_depth", ftrace->graph_depth) < 0)
402 static int set_tracing_percpu_buffer_size(struct perf_ftrace *ftrace)
406 if (ftrace->percpu_buffer_size == 0)
409 ret = write_tracing_file_int("buffer_size_kb",
410 ftrace->percpu_buffer_size / 1024);
417 static int set_tracing_trace_inherit(struct perf_ftrace *ftrace)
419 if (!ftrace->inherit)
422 if (write_tracing_option_file("function-fork", "1") < 0)
428 static int set_tracing_sleep_time(struct perf_ftrace *ftrace)
430 if (!ftrace->graph_nosleep_time)
433 if (write_tracing_option_file("sleep-time", "0") < 0)
439 static int set_tracing_funcgraph_irqs(struct perf_ftrace *ftrace)
441 if (!ftrace->graph_noirqs)
444 if (write_tracing_option_file("funcgraph-irqs", "0") < 0)
450 static int set_tracing_funcgraph_verbose(struct perf_ftrace *ftrace)
452 if (!ftrace->graph_verbose)
455 if (write_tracing_option_file("funcgraph-proc", "1") < 0)
458 if (write_tracing_option_file("funcgraph-abstime", "1") < 0)
461 if (write_tracing_option_file("latency-format", "1") < 0)
467 static int set_tracing_thresh(struct perf_ftrace *ftrace)
471 if (ftrace->graph_thresh == 0)
474 ret = write_tracing_file_int("tracing_thresh", ftrace->graph_thresh);
481 static int set_tracing_options(struct perf_ftrace *ftrace)
483 if (set_tracing_pid(ftrace) < 0) {
484 pr_err("failed to set ftrace pid\n");
488 if (set_tracing_cpu(ftrace) < 0) {
489 pr_err("failed to set tracing cpumask\n");
493 if (set_tracing_func_stack_trace(ftrace) < 0) {
494 pr_err("failed to set tracing option func_stack_trace\n");
498 if (set_tracing_func_irqinfo(ftrace) < 0) {
499 pr_err("failed to set tracing option irq-info\n");
503 if (set_tracing_filters(ftrace) < 0) {
504 pr_err("failed to set tracing filters\n");
508 if (set_tracing_depth(ftrace) < 0) {
509 pr_err("failed to set graph depth\n");
513 if (set_tracing_percpu_buffer_size(ftrace) < 0) {
514 pr_err("failed to set tracing per-cpu buffer size\n");
518 if (set_tracing_trace_inherit(ftrace) < 0) {
519 pr_err("failed to set tracing option function-fork\n");
523 if (set_tracing_sleep_time(ftrace) < 0) {
524 pr_err("failed to set tracing option sleep-time\n");
528 if (set_tracing_funcgraph_irqs(ftrace) < 0) {
529 pr_err("failed to set tracing option funcgraph-irqs\n");
533 if (set_tracing_funcgraph_verbose(ftrace) < 0) {
534 pr_err("failed to set tracing option funcgraph-proc/funcgraph-abstime\n");
538 if (set_tracing_thresh(ftrace) < 0) {
539 pr_err("failed to set tracing thresh\n");
546 static void select_tracer(struct perf_ftrace *ftrace)
548 bool graph = !list_empty(&ftrace->graph_funcs) ||
549 !list_empty(&ftrace->nograph_funcs);
550 bool func = !list_empty(&ftrace->filters) ||
551 !list_empty(&ftrace->notrace);
553 /* The function_graph has priority over function tracer. */
555 ftrace->tracer = "function_graph";
557 ftrace->tracer = "function";
558 /* Otherwise, the default tracer is used. */
560 pr_debug("%s tracer is used\n", ftrace->tracer);
563 static int __cmd_ftrace(struct perf_ftrace *ftrace)
568 struct pollfd pollfd = {
572 if (!(perf_cap__capable(CAP_PERFMON) ||
573 perf_cap__capable(CAP_SYS_ADMIN))) {
574 pr_err("ftrace only works for %s!\n",
575 #ifdef HAVE_LIBCAP_SUPPORT
576 "users with the CAP_PERFMON or CAP_SYS_ADMIN capability"
584 select_tracer(ftrace);
586 if (reset_tracing_files(ftrace) < 0) {
587 pr_err("failed to reset ftrace\n");
591 /* reset ftrace buffer */
592 if (write_tracing_file("trace", "0") < 0)
595 if (set_tracing_options(ftrace) < 0)
598 if (write_tracing_file("current_tracer", ftrace->tracer) < 0) {
599 pr_err("failed to set current_tracer to %s\n", ftrace->tracer);
605 trace_file = get_tracing_file("trace_pipe");
607 pr_err("failed to open trace_pipe\n");
611 trace_fd = open(trace_file, O_RDONLY);
613 put_tracing_file(trace_file);
616 pr_err("failed to open trace_pipe\n");
620 fcntl(trace_fd, F_SETFL, O_NONBLOCK);
621 pollfd.fd = trace_fd;
623 /* display column headers */
624 read_tracing_file_to_stdout("trace");
626 if (!ftrace->target.initial_delay) {
627 if (write_tracing_file("tracing_on", "1") < 0) {
628 pr_err("can't enable tracing\n");
633 evlist__start_workload(ftrace->evlist);
635 if (ftrace->target.initial_delay > 0) {
636 usleep(ftrace->target.initial_delay * 1000);
637 if (write_tracing_file("tracing_on", "1") < 0) {
638 pr_err("can't enable tracing\n");
644 if (poll(&pollfd, 1, -1) < 0)
647 if (pollfd.revents & POLLIN) {
648 int n = read(trace_fd, buf, sizeof(buf));
651 if (fwrite(buf, n, 1, stdout) != 1)
656 write_tracing_file("tracing_on", "0");
658 if (workload_exec_errno) {
659 const char *emsg = str_error_r(workload_exec_errno, buf, sizeof(buf));
660 /* flush stdout first so below error msg appears at the end. */
662 pr_err("workload failed: %s\n", emsg);
666 /* read remaining buffer contents */
668 int n = read(trace_fd, buf, sizeof(buf));
671 if (fwrite(buf, n, 1, stdout) != 1)
678 reset_tracing_files(ftrace);
680 return (done && !workload_exec_errno) ? 0 : -1;
683 static void make_histogram(int buckets[], char *buf, size_t len, char *linebuf,
691 /* ensure NUL termination */
694 /* handle data line by line */
695 for (p = buf; (q = strchr(p, '\n')) != NULL; p = q + 1) {
697 /* move it to the line buffer */
701 * parse trace output to get function duration like in
703 * # tracer: function_graph
705 * # CPU DURATION FUNCTION CALLS
707 * 1) + 10.291 us | do_filp_open();
708 * 1) 4.889 us | do_filp_open();
709 * 1) 6.086 us | do_filp_open();
712 if (linebuf[0] == '#')
716 p = strchr(linebuf, ')');
720 while (*p && !isdigit(*p) && (*p != '|'))
724 if (*p == '\0' || *p == '|')
727 num = strtod(p, &unit);
728 if (!unit || strncmp(unit, " us", 3))
743 /* empty the line buffer for the next output */
747 /* preserve any remaining output (before newline) */
751 static void display_histogram(int buckets[], bool use_nsec)
755 int bar_total = 46; /* to fit in 80 column */
756 char bar[] = "###############################################";
759 for (i = 0; i < NUM_BUCKET; i++)
763 printf("No data found\n");
767 printf("# %14s | %10s | %-*s |\n",
768 " DURATION ", "COUNT", bar_total, "GRAPH");
770 bar_len = buckets[0] * bar_total / total;
771 printf(" %4d - %-4d %s | %10d | %.*s%*s |\n",
772 0, 1, "us", buckets[0], bar_len, bar, bar_total - bar_len, "");
774 for (i = 1; i < NUM_BUCKET - 1; i++) {
775 int start = (1 << (i - 1));
777 const char *unit = use_nsec ? "ns" : "us";
782 unit = use_nsec ? "us" : "ms";
784 bar_len = buckets[i] * bar_total / total;
785 printf(" %4d - %-4d %s | %10d | %.*s%*s |\n",
786 start, stop, unit, buckets[i], bar_len, bar,
787 bar_total - bar_len, "");
790 bar_len = buckets[NUM_BUCKET - 1] * bar_total / total;
791 printf(" %4d - %-4s %s | %10d | %.*s%*s |\n",
792 1, "...", use_nsec ? "ms" : " s", buckets[NUM_BUCKET - 1],
793 bar_len, bar, bar_total - bar_len, "");
797 static int prepare_func_latency(struct perf_ftrace *ftrace)
802 if (ftrace->target.use_bpf)
803 return perf_ftrace__latency_prepare_bpf(ftrace);
805 if (reset_tracing_files(ftrace) < 0) {
806 pr_err("failed to reset ftrace\n");
810 /* reset ftrace buffer */
811 if (write_tracing_file("trace", "0") < 0)
814 if (set_tracing_options(ftrace) < 0)
817 /* force to use the function_graph tracer to track duration */
818 if (write_tracing_file("current_tracer", "function_graph") < 0) {
819 pr_err("failed to set current_tracer to function_graph\n");
823 trace_file = get_tracing_file("trace_pipe");
825 pr_err("failed to open trace_pipe\n");
829 fd = open(trace_file, O_RDONLY);
831 pr_err("failed to open trace_pipe\n");
833 put_tracing_file(trace_file);
837 static int start_func_latency(struct perf_ftrace *ftrace)
839 if (ftrace->target.use_bpf)
840 return perf_ftrace__latency_start_bpf(ftrace);
842 if (write_tracing_file("tracing_on", "1") < 0) {
843 pr_err("can't enable tracing\n");
850 static int stop_func_latency(struct perf_ftrace *ftrace)
852 if (ftrace->target.use_bpf)
853 return perf_ftrace__latency_stop_bpf(ftrace);
855 write_tracing_file("tracing_on", "0");
859 static int read_func_latency(struct perf_ftrace *ftrace, int buckets[])
861 if (ftrace->target.use_bpf)
862 return perf_ftrace__latency_read_bpf(ftrace, buckets);
867 static int cleanup_func_latency(struct perf_ftrace *ftrace)
869 if (ftrace->target.use_bpf)
870 return perf_ftrace__latency_cleanup_bpf(ftrace);
872 reset_tracing_files(ftrace);
876 static int __cmd_latency(struct perf_ftrace *ftrace)
881 struct pollfd pollfd = {
884 int buckets[NUM_BUCKET] = { };
886 if (!(perf_cap__capable(CAP_PERFMON) ||
887 perf_cap__capable(CAP_SYS_ADMIN))) {
888 pr_err("ftrace only works for %s!\n",
889 #ifdef HAVE_LIBCAP_SUPPORT
890 "users with the CAP_PERFMON or CAP_SYS_ADMIN capability"
898 trace_fd = prepare_func_latency(ftrace);
902 fcntl(trace_fd, F_SETFL, O_NONBLOCK);
903 pollfd.fd = trace_fd;
905 if (start_func_latency(ftrace) < 0)
908 evlist__start_workload(ftrace->evlist);
912 if (poll(&pollfd, 1, -1) < 0)
915 if (pollfd.revents & POLLIN) {
916 int n = read(trace_fd, buf, sizeof(buf) - 1);
920 make_histogram(buckets, buf, n, line, ftrace->use_nsec);
924 stop_func_latency(ftrace);
926 if (workload_exec_errno) {
927 const char *emsg = str_error_r(workload_exec_errno, buf, sizeof(buf));
928 pr_err("workload failed: %s\n", emsg);
932 /* read remaining buffer contents */
933 while (!ftrace->target.use_bpf) {
934 int n = read(trace_fd, buf, sizeof(buf) - 1);
937 make_histogram(buckets, buf, n, line, ftrace->use_nsec);
940 read_func_latency(ftrace, buckets);
942 display_histogram(buckets, ftrace->use_nsec);
946 cleanup_func_latency(ftrace);
948 return (done && !workload_exec_errno) ? 0 : -1;
951 static int perf_ftrace_config(const char *var, const char *value, void *cb)
953 struct perf_ftrace *ftrace = cb;
955 if (!strstarts(var, "ftrace."))
958 if (strcmp(var, "ftrace.tracer"))
961 if (!strcmp(value, "function_graph") ||
962 !strcmp(value, "function")) {
963 ftrace->tracer = value;
967 pr_err("Please select \"function_graph\" (default) or \"function\"\n");
971 static void list_function_cb(char *str, void *arg)
973 struct strfilter *filter = (struct strfilter *)arg;
975 if (strfilter__compare(filter, str))
979 static int opt_list_avail_functions(const struct option *opt __maybe_unused,
980 const char *str, int unset)
982 struct strfilter *filter;
983 const char *err = NULL;
989 filter = strfilter__new(str, &err);
991 return err ? -EINVAL : -ENOMEM;
993 ret = strfilter__or(filter, str, &err);
994 if (ret == -EINVAL) {
995 pr_err("Filter parse error at %td.\n", err - str + 1);
996 pr_err("Source: \"%s\"\n", str);
997 pr_err(" %*c\n", (int)(err - str + 1), '^');
998 strfilter__delete(filter);
1002 ret = read_tracing_file_by_line("available_filter_functions",
1003 list_function_cb, filter);
1004 strfilter__delete(filter);
1011 static int parse_filter_func(const struct option *opt, const char *str,
1012 int unset __maybe_unused)
1014 struct list_head *head = opt->value;
1015 struct filter_entry *entry;
1017 entry = malloc(sizeof(*entry) + strlen(str) + 1);
1021 strcpy(entry->name, str);
1022 list_add_tail(&entry->list, head);
1027 static void delete_filter_func(struct list_head *head)
1029 struct filter_entry *pos, *tmp;
1031 list_for_each_entry_safe(pos, tmp, head, list) {
1032 list_del_init(&pos->list);
1037 static int parse_buffer_size(const struct option *opt,
1038 const char *str, int unset)
1040 unsigned long *s = (unsigned long *)opt->value;
1041 static struct parse_tag tags_size[] = {
1042 { .tag = 'B', .mult = 1 },
1043 { .tag = 'K', .mult = 1 << 10 },
1044 { .tag = 'M', .mult = 1 << 20 },
1045 { .tag = 'G', .mult = 1 << 30 },
1055 val = parse_tag_value(str, tags_size);
1056 if (val != (unsigned long) -1) {
1058 pr_err("buffer size too small, must larger than 1KB.");
1068 static int parse_func_tracer_opts(const struct option *opt,
1069 const char *str, int unset)
1072 struct perf_ftrace *ftrace = (struct perf_ftrace *) opt->value;
1073 struct sublevel_option func_tracer_opts[] = {
1074 { .name = "call-graph", .value_ptr = &ftrace->func_stack_trace },
1075 { .name = "irq-info", .value_ptr = &ftrace->func_irq_info },
1082 ret = perf_parse_sublevel_options(str, func_tracer_opts);
1089 static int parse_graph_tracer_opts(const struct option *opt,
1090 const char *str, int unset)
1093 struct perf_ftrace *ftrace = (struct perf_ftrace *) opt->value;
1094 struct sublevel_option graph_tracer_opts[] = {
1095 { .name = "nosleep-time", .value_ptr = &ftrace->graph_nosleep_time },
1096 { .name = "noirqs", .value_ptr = &ftrace->graph_noirqs },
1097 { .name = "verbose", .value_ptr = &ftrace->graph_verbose },
1098 { .name = "thresh", .value_ptr = &ftrace->graph_thresh },
1099 { .name = "depth", .value_ptr = &ftrace->graph_depth },
1106 ret = perf_parse_sublevel_options(str, graph_tracer_opts);
1113 enum perf_ftrace_subcommand {
1116 PERF_FTRACE_LATENCY,
1119 int cmd_ftrace(int argc, const char **argv)
1122 int (*cmd_func)(struct perf_ftrace *) = NULL;
1123 struct perf_ftrace ftrace = {
1124 .tracer = DEFAULT_TRACER,
1125 .target = { .uid = UINT_MAX, },
1127 const struct option common_options[] = {
1128 OPT_STRING('p', "pid", &ftrace.target.pid, "pid",
1129 "Trace on existing process id"),
1130 /* TODO: Add short option -t after -t/--tracer can be removed. */
1131 OPT_STRING(0, "tid", &ftrace.target.tid, "tid",
1132 "Trace on existing thread id (exclusive to --pid)"),
1133 OPT_INCR('v', "verbose", &verbose,
1135 OPT_BOOLEAN('a', "all-cpus", &ftrace.target.system_wide,
1136 "System-wide collection from all CPUs"),
1137 OPT_STRING('C', "cpu", &ftrace.target.cpu_list, "cpu",
1138 "List of cpus to monitor"),
1141 const struct option ftrace_options[] = {
1142 OPT_STRING('t', "tracer", &ftrace.tracer, "tracer",
1143 "Tracer to use: function_graph(default) or function"),
1144 OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
1145 "Show available functions to filter",
1146 opt_list_avail_functions, "*"),
1147 OPT_CALLBACK('T', "trace-funcs", &ftrace.filters, "func",
1148 "Trace given functions using function tracer",
1150 OPT_CALLBACK('N', "notrace-funcs", &ftrace.notrace, "func",
1151 "Do not trace given functions", parse_filter_func),
1152 OPT_CALLBACK(0, "func-opts", &ftrace, "options",
1153 "Function tracer options, available options: call-graph,irq-info",
1154 parse_func_tracer_opts),
1155 OPT_CALLBACK('G', "graph-funcs", &ftrace.graph_funcs, "func",
1156 "Trace given functions using function_graph tracer",
1158 OPT_CALLBACK('g', "nograph-funcs", &ftrace.nograph_funcs, "func",
1159 "Set nograph filter on given functions", parse_filter_func),
1160 OPT_CALLBACK(0, "graph-opts", &ftrace, "options",
1161 "Graph tracer options, available options: nosleep-time,noirqs,verbose,thresh=<n>,depth=<n>",
1162 parse_graph_tracer_opts),
1163 OPT_CALLBACK('m', "buffer-size", &ftrace.percpu_buffer_size, "size",
1164 "Size of per cpu buffer, needs to use a B, K, M or G suffix.", parse_buffer_size),
1165 OPT_BOOLEAN(0, "inherit", &ftrace.inherit,
1166 "Trace children processes"),
1167 OPT_INTEGER('D', "delay", &ftrace.target.initial_delay,
1168 "Number of milliseconds to wait before starting tracing after program start"),
1169 OPT_PARENT(common_options),
1171 const struct option latency_options[] = {
1172 OPT_CALLBACK('T', "trace-funcs", &ftrace.filters, "func",
1173 "Show latency of given function", parse_filter_func),
1174 #ifdef HAVE_BPF_SKEL
1175 OPT_BOOLEAN('b', "use-bpf", &ftrace.target.use_bpf,
1176 "Use BPF to measure function latency"),
1178 OPT_BOOLEAN('n', "use-nsec", &ftrace.use_nsec,
1179 "Use nano-second histogram"),
1180 OPT_PARENT(common_options),
1182 const struct option *options = ftrace_options;
1184 const char * const ftrace_usage[] = {
1185 "perf ftrace [<options>] [<command>]",
1186 "perf ftrace [<options>] -- [<command>] [<options>]",
1187 "perf ftrace {trace|latency} [<options>] [<command>]",
1188 "perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]",
1191 enum perf_ftrace_subcommand subcmd = PERF_FTRACE_NONE;
1193 INIT_LIST_HEAD(&ftrace.filters);
1194 INIT_LIST_HEAD(&ftrace.notrace);
1195 INIT_LIST_HEAD(&ftrace.graph_funcs);
1196 INIT_LIST_HEAD(&ftrace.nograph_funcs);
1198 signal(SIGINT, sig_handler);
1199 signal(SIGUSR1, sig_handler);
1200 signal(SIGCHLD, sig_handler);
1201 signal(SIGPIPE, sig_handler);
1203 ret = perf_config(perf_ftrace_config, &ftrace);
1208 if (!strcmp(argv[1], "trace")) {
1209 subcmd = PERF_FTRACE_TRACE;
1210 } else if (!strcmp(argv[1], "latency")) {
1211 subcmd = PERF_FTRACE_LATENCY;
1212 options = latency_options;
1215 if (subcmd != PERF_FTRACE_NONE) {
1220 /* for backward compatibility */
1221 if (subcmd == PERF_FTRACE_NONE)
1222 subcmd = PERF_FTRACE_TRACE;
1224 argc = parse_options(argc, argv, options, ftrace_usage,
1225 PARSE_OPT_STOP_AT_NON_OPTION);
1228 goto out_delete_filters;
1231 /* Make system wide (-a) the default target. */
1232 if (!argc && target__none(&ftrace.target))
1233 ftrace.target.system_wide = true;
1236 case PERF_FTRACE_TRACE:
1237 cmd_func = __cmd_ftrace;
1239 case PERF_FTRACE_LATENCY:
1240 if (list_empty(&ftrace.filters)) {
1241 pr_err("Should provide a function to measure\n");
1242 parse_options_usage(ftrace_usage, options, "T", 1);
1244 goto out_delete_filters;
1246 cmd_func = __cmd_latency;
1248 case PERF_FTRACE_NONE:
1250 pr_err("Invalid subcommand\n");
1252 goto out_delete_filters;
1255 ret = target__validate(&ftrace.target);
1259 target__strerror(&ftrace.target, ret, errbuf, 512);
1260 pr_err("%s\n", errbuf);
1261 goto out_delete_filters;
1264 ftrace.evlist = evlist__new();
1265 if (ftrace.evlist == NULL) {
1267 goto out_delete_filters;
1270 ret = evlist__create_maps(ftrace.evlist, &ftrace.target);
1272 goto out_delete_evlist;
1275 ret = evlist__prepare_workload(ftrace.evlist, &ftrace.target,
1277 ftrace__workload_exec_failed_signal);
1279 goto out_delete_evlist;
1282 ret = cmd_func(&ftrace);
1285 evlist__delete(ftrace.evlist);
1288 delete_filter_func(&ftrace.filters);
1289 delete_filter_func(&ftrace.notrace);
1290 delete_filter_func(&ftrace.graph_funcs);
1291 delete_filter_func(&ftrace.nograph_funcs);