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.
17 #include <linux/capability.h>
18 #include <linux/string.h>
21 #include <subcmd/pager.h>
22 #include <subcmd/parse-options.h>
23 #include <api/fs/tracing_path.h>
27 #include "thread_map.h"
29 #include "util/config.h"
30 #include "util/units.h"
31 #include "util/parse-sublevel-options.h"
33 #define DEFAULT_TRACER "function_graph"
36 struct evlist *evlist;
39 bool list_avail_functions;
40 struct list_head filters;
41 struct list_head notrace;
42 struct list_head graph_funcs;
43 struct list_head nograph_funcs;
45 unsigned long percpu_buffer_size;
49 int graph_nosleep_time;
53 unsigned int initial_delay;
57 struct list_head list;
61 static volatile int workload_exec_errno;
64 static void sig_handler(int sig __maybe_unused)
70 * perf_evlist__prepare_workload will send a SIGUSR1 if the fork fails, since
71 * we asked by setting its exec_error to the function below,
72 * ftrace__workload_exec_failed_signal.
74 * XXX We need to handle this more appropriately, emitting an error, etc.
76 static void ftrace__workload_exec_failed_signal(int signo __maybe_unused,
77 siginfo_t *info __maybe_unused,
78 void *ucontext __maybe_unused)
80 workload_exec_errno = info->si_value.sival_int;
84 static int __write_tracing_file(const char *name, const char *val, bool append)
88 ssize_t size = strlen(val);
93 file = get_tracing_file(name);
95 pr_debug("cannot get tracing file: %s\n", name);
104 fd = open(file, flags);
106 pr_debug("cannot open tracing file: %s: %s\n",
107 name, str_error_r(errno, errbuf, sizeof(errbuf)));
112 * Copy the original value and append a '\n'. Without this,
113 * the kernel can hide possible errors.
115 val_copy = strdup(val);
118 val_copy[size] = '\n';
120 if (write(fd, val_copy, size + 1) == size + 1)
123 pr_debug("write '%s' to tracing/%s failed: %s\n",
124 val, name, str_error_r(errno, errbuf, sizeof(errbuf)));
130 put_tracing_file(file);
134 static int write_tracing_file(const char *name, const char *val)
136 return __write_tracing_file(name, val, false);
139 static int append_tracing_file(const char *name, const char *val)
141 return __write_tracing_file(name, val, true);
144 static int read_tracing_file_to_stdout(const char *name)
151 file = get_tracing_file(name);
153 pr_debug("cannot get tracing file: %s\n", name);
157 fd = open(file, O_RDONLY);
159 pr_debug("cannot open tracing file: %s: %s\n",
160 name, str_error_r(errno, buf, sizeof(buf)));
164 /* read contents to stdout */
166 int n = read(fd, buf, sizeof(buf));
172 if (fwrite(buf, n, 1, stdout) != 1)
180 put_tracing_file(file);
184 static int write_tracing_file_int(const char *name, int value)
188 snprintf(buf, sizeof(buf), "%d", value);
189 if (write_tracing_file(name, buf) < 0)
195 static int write_tracing_option_file(const char *name, const char *val)
200 if (asprintf(&file, "options/%s", name) < 0)
203 ret = __write_tracing_file(file, val, false);
208 static int reset_tracing_cpu(void);
209 static void reset_tracing_filters(void);
211 static void reset_tracing_options(struct perf_ftrace *ftrace __maybe_unused)
213 write_tracing_option_file("function-fork", "0");
214 write_tracing_option_file("func_stack_trace", "0");
215 write_tracing_option_file("sleep-time", "1");
216 write_tracing_option_file("funcgraph-irqs", "1");
217 write_tracing_option_file("funcgraph-proc", "0");
218 write_tracing_option_file("funcgraph-abstime", "0");
219 write_tracing_option_file("latency-format", "0");
220 write_tracing_option_file("irq-info", "0");
223 static int reset_tracing_files(struct perf_ftrace *ftrace __maybe_unused)
225 if (write_tracing_file("tracing_on", "0") < 0)
228 if (write_tracing_file("current_tracer", "nop") < 0)
231 if (write_tracing_file("set_ftrace_pid", " ") < 0)
234 if (reset_tracing_cpu() < 0)
237 if (write_tracing_file("max_graph_depth", "0") < 0)
240 if (write_tracing_file("tracing_thresh", "0") < 0)
243 reset_tracing_filters();
244 reset_tracing_options(ftrace);
248 static int set_tracing_pid(struct perf_ftrace *ftrace)
253 if (target__has_cpu(&ftrace->target))
256 for (i = 0; i < perf_thread_map__nr(ftrace->evlist->core.threads); i++) {
257 scnprintf(buf, sizeof(buf), "%d",
258 ftrace->evlist->core.threads->map[i]);
259 if (append_tracing_file("set_ftrace_pid", buf) < 0)
265 static int set_tracing_cpumask(struct perf_cpu_map *cpumap)
272 last_cpu = cpu_map__cpu(cpumap, cpumap->nr - 1);
273 mask_size = last_cpu / 4 + 2; /* one more byte for EOS */
274 mask_size += last_cpu / 32; /* ',' is needed for every 32th cpus */
276 cpumask = malloc(mask_size);
277 if (cpumask == NULL) {
278 pr_debug("failed to allocate cpu mask\n");
282 cpu_map__snprint_mask(cpumap, cpumask, mask_size);
284 ret = write_tracing_file("tracing_cpumask", cpumask);
290 static int set_tracing_cpu(struct perf_ftrace *ftrace)
292 struct perf_cpu_map *cpumap = ftrace->evlist->core.cpus;
294 if (!target__has_cpu(&ftrace->target))
297 return set_tracing_cpumask(cpumap);
300 static int set_tracing_func_stack_trace(struct perf_ftrace *ftrace)
302 if (!ftrace->func_stack_trace)
305 if (write_tracing_option_file("func_stack_trace", "1") < 0)
311 static int set_tracing_func_irqinfo(struct perf_ftrace *ftrace)
313 if (!ftrace->func_irq_info)
316 if (write_tracing_option_file("irq-info", "1") < 0)
322 static int reset_tracing_cpu(void)
324 struct perf_cpu_map *cpumap = perf_cpu_map__new(NULL);
327 ret = set_tracing_cpumask(cpumap);
328 perf_cpu_map__put(cpumap);
332 static int __set_tracing_filter(const char *filter_file, struct list_head *funcs)
334 struct filter_entry *pos;
336 list_for_each_entry(pos, funcs, list) {
337 if (append_tracing_file(filter_file, pos->name) < 0)
344 static int set_tracing_filters(struct perf_ftrace *ftrace)
348 ret = __set_tracing_filter("set_ftrace_filter", &ftrace->filters);
352 ret = __set_tracing_filter("set_ftrace_notrace", &ftrace->notrace);
356 ret = __set_tracing_filter("set_graph_function", &ftrace->graph_funcs);
360 /* old kernels do not have this filter */
361 __set_tracing_filter("set_graph_notrace", &ftrace->nograph_funcs);
366 static void reset_tracing_filters(void)
368 write_tracing_file("set_ftrace_filter", " ");
369 write_tracing_file("set_ftrace_notrace", " ");
370 write_tracing_file("set_graph_function", " ");
371 write_tracing_file("set_graph_notrace", " ");
374 static int set_tracing_depth(struct perf_ftrace *ftrace)
376 if (ftrace->graph_depth == 0)
379 if (ftrace->graph_depth < 0) {
380 pr_err("invalid graph depth: %d\n", ftrace->graph_depth);
384 if (write_tracing_file_int("max_graph_depth", ftrace->graph_depth) < 0)
390 static int set_tracing_percpu_buffer_size(struct perf_ftrace *ftrace)
394 if (ftrace->percpu_buffer_size == 0)
397 ret = write_tracing_file_int("buffer_size_kb",
398 ftrace->percpu_buffer_size / 1024);
405 static int set_tracing_trace_inherit(struct perf_ftrace *ftrace)
407 if (!ftrace->inherit)
410 if (write_tracing_option_file("function-fork", "1") < 0)
416 static int set_tracing_sleep_time(struct perf_ftrace *ftrace)
418 if (!ftrace->graph_nosleep_time)
421 if (write_tracing_option_file("sleep-time", "0") < 0)
427 static int set_tracing_funcgraph_irqs(struct perf_ftrace *ftrace)
429 if (!ftrace->graph_noirqs)
432 if (write_tracing_option_file("funcgraph-irqs", "0") < 0)
438 static int set_tracing_funcgraph_verbose(struct perf_ftrace *ftrace)
440 if (!ftrace->graph_verbose)
443 if (write_tracing_option_file("funcgraph-proc", "1") < 0)
446 if (write_tracing_option_file("funcgraph-abstime", "1") < 0)
449 if (write_tracing_option_file("latency-format", "1") < 0)
455 static int set_tracing_thresh(struct perf_ftrace *ftrace)
459 if (ftrace->graph_thresh == 0)
462 ret = write_tracing_file_int("tracing_thresh", ftrace->graph_thresh);
469 static int set_tracing_options(struct perf_ftrace *ftrace)
471 if (set_tracing_pid(ftrace) < 0) {
472 pr_err("failed to set ftrace pid\n");
476 if (set_tracing_cpu(ftrace) < 0) {
477 pr_err("failed to set tracing cpumask\n");
481 if (set_tracing_func_stack_trace(ftrace) < 0) {
482 pr_err("failed to set tracing option func_stack_trace\n");
486 if (set_tracing_func_irqinfo(ftrace) < 0) {
487 pr_err("failed to set tracing option irq-info\n");
491 if (set_tracing_filters(ftrace) < 0) {
492 pr_err("failed to set tracing filters\n");
496 if (set_tracing_depth(ftrace) < 0) {
497 pr_err("failed to set graph depth\n");
501 if (set_tracing_percpu_buffer_size(ftrace) < 0) {
502 pr_err("failed to set tracing per-cpu buffer size\n");
506 if (set_tracing_trace_inherit(ftrace) < 0) {
507 pr_err("failed to set tracing option function-fork\n");
511 if (set_tracing_sleep_time(ftrace) < 0) {
512 pr_err("failed to set tracing option sleep-time\n");
516 if (set_tracing_funcgraph_irqs(ftrace) < 0) {
517 pr_err("failed to set tracing option funcgraph-irqs\n");
521 if (set_tracing_funcgraph_verbose(ftrace) < 0) {
522 pr_err("failed to set tracing option funcgraph-proc/funcgraph-abstime\n");
526 if (set_tracing_thresh(ftrace) < 0) {
527 pr_err("failed to set tracing thresh\n");
534 static int __cmd_ftrace(struct perf_ftrace *ftrace, int argc, const char **argv)
539 struct pollfd pollfd = {
543 if (!(perf_cap__capable(CAP_PERFMON) ||
544 perf_cap__capable(CAP_SYS_ADMIN))) {
545 pr_err("ftrace only works for %s!\n",
546 #ifdef HAVE_LIBCAP_SUPPORT
547 "users with the CAP_PERFMON or CAP_SYS_ADMIN capability"
555 signal(SIGINT, sig_handler);
556 signal(SIGUSR1, sig_handler);
557 signal(SIGCHLD, sig_handler);
558 signal(SIGPIPE, sig_handler);
560 if (ftrace->list_avail_functions)
561 return read_tracing_file_to_stdout("available_filter_functions");
563 if (reset_tracing_files(ftrace) < 0) {
564 pr_err("failed to reset ftrace\n");
568 /* reset ftrace buffer */
569 if (write_tracing_file("trace", "0") < 0)
572 if (argc && perf_evlist__prepare_workload(ftrace->evlist,
573 &ftrace->target, argv, false,
574 ftrace__workload_exec_failed_signal) < 0) {
578 if (set_tracing_options(ftrace) < 0)
581 if (write_tracing_file("current_tracer", ftrace->tracer) < 0) {
582 pr_err("failed to set current_tracer to %s\n", ftrace->tracer);
588 trace_file = get_tracing_file("trace_pipe");
590 pr_err("failed to open trace_pipe\n");
594 trace_fd = open(trace_file, O_RDONLY);
596 put_tracing_file(trace_file);
599 pr_err("failed to open trace_pipe\n");
603 fcntl(trace_fd, F_SETFL, O_NONBLOCK);
604 pollfd.fd = trace_fd;
606 /* display column headers */
607 read_tracing_file_to_stdout("trace");
609 if (!ftrace->initial_delay) {
610 if (write_tracing_file("tracing_on", "1") < 0) {
611 pr_err("can't enable tracing\n");
616 perf_evlist__start_workload(ftrace->evlist);
618 if (ftrace->initial_delay) {
619 usleep(ftrace->initial_delay * 1000);
620 if (write_tracing_file("tracing_on", "1") < 0) {
621 pr_err("can't enable tracing\n");
627 if (poll(&pollfd, 1, -1) < 0)
630 if (pollfd.revents & POLLIN) {
631 int n = read(trace_fd, buf, sizeof(buf));
634 if (fwrite(buf, n, 1, stdout) != 1)
639 write_tracing_file("tracing_on", "0");
641 if (workload_exec_errno) {
642 const char *emsg = str_error_r(workload_exec_errno, buf, sizeof(buf));
643 /* flush stdout first so below error msg appears at the end. */
645 pr_err("workload failed: %s\n", emsg);
649 /* read remaining buffer contents */
651 int n = read(trace_fd, buf, sizeof(buf));
654 if (fwrite(buf, n, 1, stdout) != 1)
661 reset_tracing_files(ftrace);
663 return (done && !workload_exec_errno) ? 0 : -1;
666 static int perf_ftrace_config(const char *var, const char *value, void *cb)
668 struct perf_ftrace *ftrace = cb;
670 if (!strstarts(var, "ftrace."))
673 if (strcmp(var, "ftrace.tracer"))
676 if (!strcmp(value, "function_graph") ||
677 !strcmp(value, "function")) {
678 ftrace->tracer = value;
682 pr_err("Please select \"function_graph\" (default) or \"function\"\n");
686 static int parse_filter_func(const struct option *opt, const char *str,
687 int unset __maybe_unused)
689 struct list_head *head = opt->value;
690 struct filter_entry *entry;
692 entry = malloc(sizeof(*entry) + strlen(str) + 1);
696 strcpy(entry->name, str);
697 list_add_tail(&entry->list, head);
702 static void delete_filter_func(struct list_head *head)
704 struct filter_entry *pos, *tmp;
706 list_for_each_entry_safe(pos, tmp, head, list) {
707 list_del_init(&pos->list);
712 static int parse_buffer_size(const struct option *opt,
713 const char *str, int unset)
715 unsigned long *s = (unsigned long *)opt->value;
716 static struct parse_tag tags_size[] = {
717 { .tag = 'B', .mult = 1 },
718 { .tag = 'K', .mult = 1 << 10 },
719 { .tag = 'M', .mult = 1 << 20 },
720 { .tag = 'G', .mult = 1 << 30 },
730 val = parse_tag_value(str, tags_size);
731 if (val != (unsigned long) -1) {
733 pr_err("buffer size too small, must larger than 1KB.");
743 static int parse_func_tracer_opts(const struct option *opt,
744 const char *str, int unset)
747 struct perf_ftrace *ftrace = (struct perf_ftrace *) opt->value;
748 struct sublevel_option func_tracer_opts[] = {
749 { .name = "call-graph", .value_ptr = &ftrace->func_stack_trace },
750 { .name = "irq-info", .value_ptr = &ftrace->func_irq_info },
757 ret = perf_parse_sublevel_options(str, func_tracer_opts);
764 static int parse_graph_tracer_opts(const struct option *opt,
765 const char *str, int unset)
768 struct perf_ftrace *ftrace = (struct perf_ftrace *) opt->value;
769 struct sublevel_option graph_tracer_opts[] = {
770 { .name = "nosleep-time", .value_ptr = &ftrace->graph_nosleep_time },
771 { .name = "noirqs", .value_ptr = &ftrace->graph_noirqs },
772 { .name = "verbose", .value_ptr = &ftrace->graph_verbose },
773 { .name = "thresh", .value_ptr = &ftrace->graph_thresh },
774 { .name = "depth", .value_ptr = &ftrace->graph_depth },
781 ret = perf_parse_sublevel_options(str, graph_tracer_opts);
788 static void select_tracer(struct perf_ftrace *ftrace)
790 bool graph = !list_empty(&ftrace->graph_funcs) ||
791 !list_empty(&ftrace->nograph_funcs);
792 bool func = !list_empty(&ftrace->filters) ||
793 !list_empty(&ftrace->notrace);
795 /* The function_graph has priority over function tracer. */
797 ftrace->tracer = "function_graph";
799 ftrace->tracer = "function";
800 /* Otherwise, the default tracer is used. */
802 pr_debug("%s tracer is used\n", ftrace->tracer);
805 int cmd_ftrace(int argc, const char **argv)
808 struct perf_ftrace ftrace = {
809 .tracer = DEFAULT_TRACER,
810 .target = { .uid = UINT_MAX, },
812 const char * const ftrace_usage[] = {
813 "perf ftrace [<options>] [<command>]",
814 "perf ftrace [<options>] -- <command> [<options>]",
817 const struct option ftrace_options[] = {
818 OPT_STRING('t', "tracer", &ftrace.tracer, "tracer",
819 "Tracer to use: function_graph(default) or function"),
820 OPT_BOOLEAN('F', "funcs", &ftrace.list_avail_functions,
821 "Show available functions to filter"),
822 OPT_STRING('p', "pid", &ftrace.target.pid, "pid",
823 "Trace on existing process id"),
824 /* TODO: Add short option -t after -t/--tracer can be removed. */
825 OPT_STRING(0, "tid", &ftrace.target.tid, "tid",
826 "Trace on existing thread id (exclusive to --pid)"),
827 OPT_INCR('v', "verbose", &verbose,
829 OPT_BOOLEAN('a', "all-cpus", &ftrace.target.system_wide,
830 "System-wide collection from all CPUs"),
831 OPT_STRING('C', "cpu", &ftrace.target.cpu_list, "cpu",
832 "List of cpus to monitor"),
833 OPT_CALLBACK('T', "trace-funcs", &ftrace.filters, "func",
834 "Trace given functions using function tracer",
836 OPT_CALLBACK('N', "notrace-funcs", &ftrace.notrace, "func",
837 "Do not trace given functions", parse_filter_func),
838 OPT_CALLBACK(0, "func-opts", &ftrace, "options",
839 "Function tracer options, available options: call-graph,irq-info",
840 parse_func_tracer_opts),
841 OPT_CALLBACK('G', "graph-funcs", &ftrace.graph_funcs, "func",
842 "Trace given functions using function_graph tracer",
844 OPT_CALLBACK('g', "nograph-funcs", &ftrace.nograph_funcs, "func",
845 "Set nograph filter on given functions", parse_filter_func),
846 OPT_CALLBACK(0, "graph-opts", &ftrace, "options",
847 "Graph tracer options, available options: nosleep-time,noirqs,verbose,thresh=<n>,depth=<n>",
848 parse_graph_tracer_opts),
849 OPT_CALLBACK('m', "buffer-size", &ftrace.percpu_buffer_size, "size",
850 "Size of per cpu buffer, needs to use a B, K, M or G suffix.", parse_buffer_size),
851 OPT_BOOLEAN(0, "inherit", &ftrace.inherit,
852 "Trace children processes"),
853 OPT_UINTEGER('D', "delay", &ftrace.initial_delay,
854 "Number of milliseconds to wait before starting tracing after program start"),
858 INIT_LIST_HEAD(&ftrace.filters);
859 INIT_LIST_HEAD(&ftrace.notrace);
860 INIT_LIST_HEAD(&ftrace.graph_funcs);
861 INIT_LIST_HEAD(&ftrace.nograph_funcs);
863 ret = perf_config(perf_ftrace_config, &ftrace);
867 argc = parse_options(argc, argv, ftrace_options, ftrace_usage,
868 PARSE_OPT_STOP_AT_NON_OPTION);
869 if (!argc && target__none(&ftrace.target))
870 ftrace.target.system_wide = true;
872 select_tracer(&ftrace);
874 ret = target__validate(&ftrace.target);
878 target__strerror(&ftrace.target, ret, errbuf, 512);
879 pr_err("%s\n", errbuf);
880 goto out_delete_filters;
883 ftrace.evlist = evlist__new();
884 if (ftrace.evlist == NULL) {
886 goto out_delete_filters;
889 ret = perf_evlist__create_maps(ftrace.evlist, &ftrace.target);
891 goto out_delete_evlist;
893 ret = __cmd_ftrace(&ftrace, argc, argv);
896 evlist__delete(ftrace.evlist);
899 delete_filter_func(&ftrace.filters);
900 delete_filter_func(&ftrace.notrace);
901 delete_filter_func(&ftrace.graph_funcs);
902 delete_filter_func(&ftrace.nograph_funcs);