treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / tools / perf / builtin-trace.c
blob46a72ecac427f33a16d0d7d0ff7d713a306b8464
1 /*
2 * builtin-trace.c
4 * Builtin 'trace' command:
6 * Display a continuously updated trace of any workload, CPU, specific PID,
7 * system wide, etc. Default format is loosely strace like, but any other
8 * event may be specified using --event.
10 * Copyright (C) 2012, 2013, 2014, 2015 Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
12 * Initially based on the 'trace' prototype by Thomas Gleixner:
14 * http://lwn.net/Articles/415728/ ("Announcing a new utility: 'trace'")
17 #include "util/record.h"
18 #include <traceevent/event-parse.h>
19 #include <api/fs/tracing_path.h>
20 #include <bpf/bpf.h>
21 #include "util/bpf_map.h"
22 #include "util/rlimit.h"
23 #include "builtin.h"
24 #include "util/cgroup.h"
25 #include "util/color.h"
26 #include "util/config.h"
27 #include "util/debug.h"
28 #include "util/dso.h"
29 #include "util/env.h"
30 #include "util/event.h"
31 #include "util/evsel.h"
32 #include "util/evsel_fprintf.h"
33 #include "util/synthetic-events.h"
34 #include "util/evlist.h"
35 #include "util/evswitch.h"
36 #include "util/mmap.h"
37 #include <subcmd/pager.h>
38 #include <subcmd/exec-cmd.h>
39 #include "util/machine.h"
40 #include "util/map.h"
41 #include "util/symbol.h"
42 #include "util/path.h"
43 #include "util/session.h"
44 #include "util/thread.h"
45 #include <subcmd/parse-options.h>
46 #include "util/strlist.h"
47 #include "util/intlist.h"
48 #include "util/thread_map.h"
49 #include "util/stat.h"
50 #include "util/tool.h"
51 #include "util/util.h"
52 #include "trace/beauty/beauty.h"
53 #include "trace-event.h"
54 #include "util/parse-events.h"
55 #include "util/bpf-loader.h"
56 #include "callchain.h"
57 #include "print_binary.h"
58 #include "string2.h"
59 #include "syscalltbl.h"
60 #include "rb_resort.h"
61 #include "../perf.h"
63 #include <errno.h>
64 #include <inttypes.h>
65 #include <poll.h>
66 #include <signal.h>
67 #include <stdlib.h>
68 #include <string.h>
69 #include <linux/err.h>
70 #include <linux/filter.h>
71 #include <linux/kernel.h>
72 #include <linux/random.h>
73 #include <linux/stringify.h>
74 #include <linux/time64.h>
75 #include <linux/zalloc.h>
76 #include <fcntl.h>
77 #include <sys/sysmacros.h>
79 #include <linux/ctype.h>
80 #include <perf/mmap.h>
82 #ifndef O_CLOEXEC
83 # define O_CLOEXEC 02000000
84 #endif
86 #ifndef F_LINUX_SPECIFIC_BASE
87 # define F_LINUX_SPECIFIC_BASE 1024
88 #endif
91 * strtoul: Go from a string to a value, i.e. for msr: MSR_FS_BASE to 0xc0000100
93 struct syscall_arg_fmt {
94 size_t (*scnprintf)(char *bf, size_t size, struct syscall_arg *arg);
95 bool (*strtoul)(char *bf, size_t size, struct syscall_arg *arg, u64 *val);
96 unsigned long (*mask_val)(struct syscall_arg *arg, unsigned long val);
97 void *parm;
98 const char *name;
99 u16 nr_entries; // for arrays
100 bool show_zero;
103 struct syscall_fmt {
104 const char *name;
105 const char *alias;
106 struct {
107 const char *sys_enter,
108 *sys_exit;
109 } bpf_prog_name;
110 struct syscall_arg_fmt arg[6];
111 u8 nr_args;
112 bool errpid;
113 bool timeout;
114 bool hexret;
117 struct trace {
118 struct perf_tool tool;
119 struct syscalltbl *sctbl;
120 struct {
121 struct syscall *table;
122 struct bpf_map *map;
123 struct { // per syscall BPF_MAP_TYPE_PROG_ARRAY
124 struct bpf_map *sys_enter,
125 *sys_exit;
126 } prog_array;
127 struct {
128 struct evsel *sys_enter,
129 *sys_exit,
130 *augmented;
131 } events;
132 struct bpf_program *unaugmented_prog;
133 } syscalls;
134 struct {
135 struct bpf_map *map;
136 } dump;
137 struct record_opts opts;
138 struct evlist *evlist;
139 struct machine *host;
140 struct thread *current;
141 struct bpf_object *bpf_obj;
142 struct cgroup *cgroup;
143 u64 base_time;
144 FILE *output;
145 unsigned long nr_events;
146 unsigned long nr_events_printed;
147 unsigned long max_events;
148 struct evswitch evswitch;
149 struct strlist *ev_qualifier;
150 struct {
151 size_t nr;
152 int *entries;
153 } ev_qualifier_ids;
154 struct {
155 size_t nr;
156 pid_t *entries;
157 struct bpf_map *map;
158 } filter_pids;
159 double duration_filter;
160 double runtime_ms;
161 struct {
162 u64 vfs_getname,
163 proc_getname;
164 } stats;
165 unsigned int max_stack;
166 unsigned int min_stack;
167 int raw_augmented_syscalls_args_size;
168 bool raw_augmented_syscalls;
169 bool fd_path_disabled;
170 bool sort_events;
171 bool not_ev_qualifier;
172 bool live;
173 bool full_time;
174 bool sched;
175 bool multiple_threads;
176 bool summary;
177 bool summary_only;
178 bool errno_summary;
179 bool failure_only;
180 bool show_comm;
181 bool print_sample;
182 bool show_tool_stats;
183 bool trace_syscalls;
184 bool libtraceevent_print;
185 bool kernel_syscallchains;
186 s16 args_alignment;
187 bool show_tstamp;
188 bool show_duration;
189 bool show_zeros;
190 bool show_arg_names;
191 bool show_string_prefix;
192 bool force;
193 bool vfs_getname;
194 int trace_pgfaults;
195 char *perfconfig_events;
196 struct {
197 struct ordered_events data;
198 u64 last;
199 } oe;
202 struct tp_field {
203 int offset;
204 union {
205 u64 (*integer)(struct tp_field *field, struct perf_sample *sample);
206 void *(*pointer)(struct tp_field *field, struct perf_sample *sample);
210 #define TP_UINT_FIELD(bits) \
211 static u64 tp_field__u##bits(struct tp_field *field, struct perf_sample *sample) \
213 u##bits value; \
214 memcpy(&value, sample->raw_data + field->offset, sizeof(value)); \
215 return value; \
218 TP_UINT_FIELD(8);
219 TP_UINT_FIELD(16);
220 TP_UINT_FIELD(32);
221 TP_UINT_FIELD(64);
223 #define TP_UINT_FIELD__SWAPPED(bits) \
224 static u64 tp_field__swapped_u##bits(struct tp_field *field, struct perf_sample *sample) \
226 u##bits value; \
227 memcpy(&value, sample->raw_data + field->offset, sizeof(value)); \
228 return bswap_##bits(value);\
231 TP_UINT_FIELD__SWAPPED(16);
232 TP_UINT_FIELD__SWAPPED(32);
233 TP_UINT_FIELD__SWAPPED(64);
235 static int __tp_field__init_uint(struct tp_field *field, int size, int offset, bool needs_swap)
237 field->offset = offset;
239 switch (size) {
240 case 1:
241 field->integer = tp_field__u8;
242 break;
243 case 2:
244 field->integer = needs_swap ? tp_field__swapped_u16 : tp_field__u16;
245 break;
246 case 4:
247 field->integer = needs_swap ? tp_field__swapped_u32 : tp_field__u32;
248 break;
249 case 8:
250 field->integer = needs_swap ? tp_field__swapped_u64 : tp_field__u64;
251 break;
252 default:
253 return -1;
256 return 0;
259 static int tp_field__init_uint(struct tp_field *field, struct tep_format_field *format_field, bool needs_swap)
261 return __tp_field__init_uint(field, format_field->size, format_field->offset, needs_swap);
264 static void *tp_field__ptr(struct tp_field *field, struct perf_sample *sample)
266 return sample->raw_data + field->offset;
269 static int __tp_field__init_ptr(struct tp_field *field, int offset)
271 field->offset = offset;
272 field->pointer = tp_field__ptr;
273 return 0;
276 static int tp_field__init_ptr(struct tp_field *field, struct tep_format_field *format_field)
278 return __tp_field__init_ptr(field, format_field->offset);
281 struct syscall_tp {
282 struct tp_field id;
283 union {
284 struct tp_field args, ret;
289 * The evsel->priv as used by 'perf trace'
290 * sc: for raw_syscalls:sys_{enter,exit} and syscalls:sys_{enter,exit}_SYSCALLNAME
291 * fmt: for all the other tracepoints
293 struct evsel_trace {
294 struct syscall_tp sc;
295 struct syscall_arg_fmt *fmt;
298 static struct evsel_trace *evsel_trace__new(void)
300 return zalloc(sizeof(struct evsel_trace));
303 static void evsel_trace__delete(struct evsel_trace *et)
305 if (et == NULL)
306 return;
308 zfree(&et->fmt);
309 free(et);
313 * Used with raw_syscalls:sys_{enter,exit} and with the
314 * syscalls:sys_{enter,exit}_SYSCALL tracepoints
316 static inline struct syscall_tp *__evsel__syscall_tp(struct evsel *evsel)
318 struct evsel_trace *et = evsel->priv;
320 return &et->sc;
323 static struct syscall_tp *evsel__syscall_tp(struct evsel *evsel)
325 if (evsel->priv == NULL) {
326 evsel->priv = evsel_trace__new();
327 if (evsel->priv == NULL)
328 return NULL;
331 return __evsel__syscall_tp(evsel);
335 * Used with all the other tracepoints.
337 static inline struct syscall_arg_fmt *__evsel__syscall_arg_fmt(struct evsel *evsel)
339 struct evsel_trace *et = evsel->priv;
341 return et->fmt;
344 static struct syscall_arg_fmt *evsel__syscall_arg_fmt(struct evsel *evsel)
346 struct evsel_trace *et = evsel->priv;
348 if (evsel->priv == NULL) {
349 et = evsel->priv = evsel_trace__new();
351 if (et == NULL)
352 return NULL;
355 if (et->fmt == NULL) {
356 et->fmt = calloc(evsel->tp_format->format.nr_fields, sizeof(struct syscall_arg_fmt));
357 if (et->fmt == NULL)
358 goto out_delete;
361 return __evsel__syscall_arg_fmt(evsel);
363 out_delete:
364 evsel_trace__delete(evsel->priv);
365 evsel->priv = NULL;
366 return NULL;
369 static int perf_evsel__init_tp_uint_field(struct evsel *evsel,
370 struct tp_field *field,
371 const char *name)
373 struct tep_format_field *format_field = perf_evsel__field(evsel, name);
375 if (format_field == NULL)
376 return -1;
378 return tp_field__init_uint(field, format_field, evsel->needs_swap);
381 #define perf_evsel__init_sc_tp_uint_field(evsel, name) \
382 ({ struct syscall_tp *sc = __evsel__syscall_tp(evsel);\
383 perf_evsel__init_tp_uint_field(evsel, &sc->name, #name); })
385 static int perf_evsel__init_tp_ptr_field(struct evsel *evsel,
386 struct tp_field *field,
387 const char *name)
389 struct tep_format_field *format_field = perf_evsel__field(evsel, name);
391 if (format_field == NULL)
392 return -1;
394 return tp_field__init_ptr(field, format_field);
397 #define perf_evsel__init_sc_tp_ptr_field(evsel, name) \
398 ({ struct syscall_tp *sc = __evsel__syscall_tp(evsel);\
399 perf_evsel__init_tp_ptr_field(evsel, &sc->name, #name); })
401 static void evsel__delete_priv(struct evsel *evsel)
403 zfree(&evsel->priv);
404 evsel__delete(evsel);
407 static int perf_evsel__init_syscall_tp(struct evsel *evsel)
409 struct syscall_tp *sc = evsel__syscall_tp(evsel);
411 if (sc != NULL) {
412 if (perf_evsel__init_tp_uint_field(evsel, &sc->id, "__syscall_nr") &&
413 perf_evsel__init_tp_uint_field(evsel, &sc->id, "nr"))
414 return -ENOENT;
415 return 0;
418 return -ENOMEM;
421 static int perf_evsel__init_augmented_syscall_tp(struct evsel *evsel, struct evsel *tp)
423 struct syscall_tp *sc = evsel__syscall_tp(evsel);
425 if (sc != NULL) {
426 struct tep_format_field *syscall_id = perf_evsel__field(tp, "id");
427 if (syscall_id == NULL)
428 syscall_id = perf_evsel__field(tp, "__syscall_nr");
429 if (syscall_id == NULL ||
430 __tp_field__init_uint(&sc->id, syscall_id->size, syscall_id->offset, evsel->needs_swap))
431 return -EINVAL;
433 return 0;
436 return -ENOMEM;
439 static int perf_evsel__init_augmented_syscall_tp_args(struct evsel *evsel)
441 struct syscall_tp *sc = __evsel__syscall_tp(evsel);
443 return __tp_field__init_ptr(&sc->args, sc->id.offset + sizeof(u64));
446 static int perf_evsel__init_augmented_syscall_tp_ret(struct evsel *evsel)
448 struct syscall_tp *sc = __evsel__syscall_tp(evsel);
450 return __tp_field__init_uint(&sc->ret, sizeof(u64), sc->id.offset + sizeof(u64), evsel->needs_swap);
453 static int perf_evsel__init_raw_syscall_tp(struct evsel *evsel, void *handler)
455 if (evsel__syscall_tp(evsel) != NULL) {
456 if (perf_evsel__init_sc_tp_uint_field(evsel, id))
457 return -ENOENT;
459 evsel->handler = handler;
460 return 0;
463 return -ENOMEM;
466 static struct evsel *perf_evsel__raw_syscall_newtp(const char *direction, void *handler)
468 struct evsel *evsel = perf_evsel__newtp("raw_syscalls", direction);
470 /* older kernel (e.g., RHEL6) use syscalls:{enter,exit} */
471 if (IS_ERR(evsel))
472 evsel = perf_evsel__newtp("syscalls", direction);
474 if (IS_ERR(evsel))
475 return NULL;
477 if (perf_evsel__init_raw_syscall_tp(evsel, handler))
478 goto out_delete;
480 return evsel;
482 out_delete:
483 evsel__delete_priv(evsel);
484 return NULL;
487 #define perf_evsel__sc_tp_uint(evsel, name, sample) \
488 ({ struct syscall_tp *fields = __evsel__syscall_tp(evsel); \
489 fields->name.integer(&fields->name, sample); })
491 #define perf_evsel__sc_tp_ptr(evsel, name, sample) \
492 ({ struct syscall_tp *fields = __evsel__syscall_tp(evsel); \
493 fields->name.pointer(&fields->name, sample); })
495 size_t strarray__scnprintf_suffix(struct strarray *sa, char *bf, size_t size, const char *intfmt, bool show_suffix, int val)
497 int idx = val - sa->offset;
499 if (idx < 0 || idx >= sa->nr_entries || sa->entries[idx] == NULL) {
500 size_t printed = scnprintf(bf, size, intfmt, val);
501 if (show_suffix)
502 printed += scnprintf(bf + printed, size - printed, " /* %s??? */", sa->prefix);
503 return printed;
506 return scnprintf(bf, size, "%s%s", sa->entries[idx], show_suffix ? sa->prefix : "");
509 size_t strarray__scnprintf(struct strarray *sa, char *bf, size_t size, const char *intfmt, bool show_prefix, int val)
511 int idx = val - sa->offset;
513 if (idx < 0 || idx >= sa->nr_entries || sa->entries[idx] == NULL) {
514 size_t printed = scnprintf(bf, size, intfmt, val);
515 if (show_prefix)
516 printed += scnprintf(bf + printed, size - printed, " /* %s??? */", sa->prefix);
517 return printed;
520 return scnprintf(bf, size, "%s%s", show_prefix ? sa->prefix : "", sa->entries[idx]);
523 static size_t __syscall_arg__scnprintf_strarray(char *bf, size_t size,
524 const char *intfmt,
525 struct syscall_arg *arg)
527 return strarray__scnprintf(arg->parm, bf, size, intfmt, arg->show_string_prefix, arg->val);
530 static size_t syscall_arg__scnprintf_strarray(char *bf, size_t size,
531 struct syscall_arg *arg)
533 return __syscall_arg__scnprintf_strarray(bf, size, "%d", arg);
536 #define SCA_STRARRAY syscall_arg__scnprintf_strarray
538 bool syscall_arg__strtoul_strarray(char *bf, size_t size, struct syscall_arg *arg, u64 *ret)
540 return strarray__strtoul(arg->parm, bf, size, ret);
543 bool syscall_arg__strtoul_strarray_flags(char *bf, size_t size, struct syscall_arg *arg, u64 *ret)
545 return strarray__strtoul_flags(arg->parm, bf, size, ret);
548 bool syscall_arg__strtoul_strarrays(char *bf, size_t size, struct syscall_arg *arg, u64 *ret)
550 return strarrays__strtoul(arg->parm, bf, size, ret);
553 size_t syscall_arg__scnprintf_strarray_flags(char *bf, size_t size, struct syscall_arg *arg)
555 return strarray__scnprintf_flags(arg->parm, bf, size, arg->show_string_prefix, arg->val);
558 size_t strarrays__scnprintf(struct strarrays *sas, char *bf, size_t size, const char *intfmt, bool show_prefix, int val)
560 size_t printed;
561 int i;
563 for (i = 0; i < sas->nr_entries; ++i) {
564 struct strarray *sa = sas->entries[i];
565 int idx = val - sa->offset;
567 if (idx >= 0 && idx < sa->nr_entries) {
568 if (sa->entries[idx] == NULL)
569 break;
570 return scnprintf(bf, size, "%s%s", show_prefix ? sa->prefix : "", sa->entries[idx]);
574 printed = scnprintf(bf, size, intfmt, val);
575 if (show_prefix)
576 printed += scnprintf(bf + printed, size - printed, " /* %s??? */", sas->entries[0]->prefix);
577 return printed;
580 bool strarray__strtoul(struct strarray *sa, char *bf, size_t size, u64 *ret)
582 int i;
584 for (i = 0; i < sa->nr_entries; ++i) {
585 if (sa->entries[i] && strncmp(sa->entries[i], bf, size) == 0 && sa->entries[i][size] == '\0') {
586 *ret = sa->offset + i;
587 return true;
591 return false;
594 bool strarray__strtoul_flags(struct strarray *sa, char *bf, size_t size, u64 *ret)
596 u64 val = 0;
597 char *tok = bf, *sep, *end;
599 *ret = 0;
601 while (size != 0) {
602 int toklen = size;
604 sep = memchr(tok, '|', size);
605 if (sep != NULL) {
606 size -= sep - tok + 1;
608 end = sep - 1;
609 while (end > tok && isspace(*end))
610 --end;
612 toklen = end - tok + 1;
615 while (isspace(*tok))
616 ++tok;
618 if (isalpha(*tok) || *tok == '_') {
619 if (!strarray__strtoul(sa, tok, toklen, &val))
620 return false;
621 } else {
622 bool is_hexa = tok[0] == 0 && (tok[1] = 'x' || tok[1] == 'X');
624 val = strtoul(tok, NULL, is_hexa ? 16 : 0);
627 *ret |= (1 << (val - 1));
629 if (sep == NULL)
630 break;
631 tok = sep + 1;
634 return true;
637 bool strarrays__strtoul(struct strarrays *sas, char *bf, size_t size, u64 *ret)
639 int i;
641 for (i = 0; i < sas->nr_entries; ++i) {
642 struct strarray *sa = sas->entries[i];
644 if (strarray__strtoul(sa, bf, size, ret))
645 return true;
648 return false;
651 size_t syscall_arg__scnprintf_strarrays(char *bf, size_t size,
652 struct syscall_arg *arg)
654 return strarrays__scnprintf(arg->parm, bf, size, "%d", arg->show_string_prefix, arg->val);
657 #ifndef AT_FDCWD
658 #define AT_FDCWD -100
659 #endif
661 static size_t syscall_arg__scnprintf_fd_at(char *bf, size_t size,
662 struct syscall_arg *arg)
664 int fd = arg->val;
665 const char *prefix = "AT_FD";
667 if (fd == AT_FDCWD)
668 return scnprintf(bf, size, "%s%s", arg->show_string_prefix ? prefix : "", "CWD");
670 return syscall_arg__scnprintf_fd(bf, size, arg);
673 #define SCA_FDAT syscall_arg__scnprintf_fd_at
675 static size_t syscall_arg__scnprintf_close_fd(char *bf, size_t size,
676 struct syscall_arg *arg);
678 #define SCA_CLOSE_FD syscall_arg__scnprintf_close_fd
680 size_t syscall_arg__scnprintf_hex(char *bf, size_t size, struct syscall_arg *arg)
682 return scnprintf(bf, size, "%#lx", arg->val);
685 size_t syscall_arg__scnprintf_ptr(char *bf, size_t size, struct syscall_arg *arg)
687 if (arg->val == 0)
688 return scnprintf(bf, size, "NULL");
689 return syscall_arg__scnprintf_hex(bf, size, arg);
692 size_t syscall_arg__scnprintf_int(char *bf, size_t size, struct syscall_arg *arg)
694 return scnprintf(bf, size, "%d", arg->val);
697 size_t syscall_arg__scnprintf_long(char *bf, size_t size, struct syscall_arg *arg)
699 return scnprintf(bf, size, "%ld", arg->val);
702 static size_t syscall_arg__scnprintf_char_array(char *bf, size_t size, struct syscall_arg *arg)
704 // XXX Hey, maybe for sched:sched_switch prev/next comm fields we can
705 // fill missing comms using thread__set_comm()...
706 // here or in a special syscall_arg__scnprintf_pid_sched_tp...
707 return scnprintf(bf, size, "\"%-.*s\"", arg->fmt->nr_entries ?: arg->len, arg->val);
710 #define SCA_CHAR_ARRAY syscall_arg__scnprintf_char_array
712 static const char *bpf_cmd[] = {
713 "MAP_CREATE", "MAP_LOOKUP_ELEM", "MAP_UPDATE_ELEM", "MAP_DELETE_ELEM",
714 "MAP_GET_NEXT_KEY", "PROG_LOAD",
716 static DEFINE_STRARRAY(bpf_cmd, "BPF_");
718 static const char *fsmount_flags[] = {
719 [1] = "CLOEXEC",
721 static DEFINE_STRARRAY(fsmount_flags, "FSMOUNT_");
723 #include "trace/beauty/generated/fsconfig_arrays.c"
725 static DEFINE_STRARRAY(fsconfig_cmds, "FSCONFIG_");
727 static const char *epoll_ctl_ops[] = { "ADD", "DEL", "MOD", };
728 static DEFINE_STRARRAY_OFFSET(epoll_ctl_ops, "EPOLL_CTL_", 1);
730 static const char *itimers[] = { "REAL", "VIRTUAL", "PROF", };
731 static DEFINE_STRARRAY(itimers, "ITIMER_");
733 static const char *keyctl_options[] = {
734 "GET_KEYRING_ID", "JOIN_SESSION_KEYRING", "UPDATE", "REVOKE", "CHOWN",
735 "SETPERM", "DESCRIBE", "CLEAR", "LINK", "UNLINK", "SEARCH", "READ",
736 "INSTANTIATE", "NEGATE", "SET_REQKEY_KEYRING", "SET_TIMEOUT",
737 "ASSUME_AUTHORITY", "GET_SECURITY", "SESSION_TO_PARENT", "REJECT",
738 "INSTANTIATE_IOV", "INVALIDATE", "GET_PERSISTENT",
740 static DEFINE_STRARRAY(keyctl_options, "KEYCTL_");
742 static const char *whences[] = { "SET", "CUR", "END",
743 #ifdef SEEK_DATA
744 "DATA",
745 #endif
746 #ifdef SEEK_HOLE
747 "HOLE",
748 #endif
750 static DEFINE_STRARRAY(whences, "SEEK_");
752 static const char *fcntl_cmds[] = {
753 "DUPFD", "GETFD", "SETFD", "GETFL", "SETFL", "GETLK", "SETLK",
754 "SETLKW", "SETOWN", "GETOWN", "SETSIG", "GETSIG", "GETLK64",
755 "SETLK64", "SETLKW64", "SETOWN_EX", "GETOWN_EX",
756 "GETOWNER_UIDS",
758 static DEFINE_STRARRAY(fcntl_cmds, "F_");
760 static const char *fcntl_linux_specific_cmds[] = {
761 "SETLEASE", "GETLEASE", "NOTIFY", [5] = "CANCELLK", "DUPFD_CLOEXEC",
762 "SETPIPE_SZ", "GETPIPE_SZ", "ADD_SEALS", "GET_SEALS",
763 "GET_RW_HINT", "SET_RW_HINT", "GET_FILE_RW_HINT", "SET_FILE_RW_HINT",
766 static DEFINE_STRARRAY_OFFSET(fcntl_linux_specific_cmds, "F_", F_LINUX_SPECIFIC_BASE);
768 static struct strarray *fcntl_cmds_arrays[] = {
769 &strarray__fcntl_cmds,
770 &strarray__fcntl_linux_specific_cmds,
773 static DEFINE_STRARRAYS(fcntl_cmds_arrays);
775 static const char *rlimit_resources[] = {
776 "CPU", "FSIZE", "DATA", "STACK", "CORE", "RSS", "NPROC", "NOFILE",
777 "MEMLOCK", "AS", "LOCKS", "SIGPENDING", "MSGQUEUE", "NICE", "RTPRIO",
778 "RTTIME",
780 static DEFINE_STRARRAY(rlimit_resources, "RLIMIT_");
782 static const char *sighow[] = { "BLOCK", "UNBLOCK", "SETMASK", };
783 static DEFINE_STRARRAY(sighow, "SIG_");
785 static const char *clockid[] = {
786 "REALTIME", "MONOTONIC", "PROCESS_CPUTIME_ID", "THREAD_CPUTIME_ID",
787 "MONOTONIC_RAW", "REALTIME_COARSE", "MONOTONIC_COARSE", "BOOTTIME",
788 "REALTIME_ALARM", "BOOTTIME_ALARM", "SGI_CYCLE", "TAI"
790 static DEFINE_STRARRAY(clockid, "CLOCK_");
792 static size_t syscall_arg__scnprintf_access_mode(char *bf, size_t size,
793 struct syscall_arg *arg)
795 bool show_prefix = arg->show_string_prefix;
796 const char *suffix = "_OK";
797 size_t printed = 0;
798 int mode = arg->val;
800 if (mode == F_OK) /* 0 */
801 return scnprintf(bf, size, "F%s", show_prefix ? suffix : "");
802 #define P_MODE(n) \
803 if (mode & n##_OK) { \
804 printed += scnprintf(bf + printed, size - printed, "%s%s", #n, show_prefix ? suffix : ""); \
805 mode &= ~n##_OK; \
808 P_MODE(R);
809 P_MODE(W);
810 P_MODE(X);
811 #undef P_MODE
813 if (mode)
814 printed += scnprintf(bf + printed, size - printed, "|%#x", mode);
816 return printed;
819 #define SCA_ACCMODE syscall_arg__scnprintf_access_mode
821 static size_t syscall_arg__scnprintf_filename(char *bf, size_t size,
822 struct syscall_arg *arg);
824 #define SCA_FILENAME syscall_arg__scnprintf_filename
826 static size_t syscall_arg__scnprintf_pipe_flags(char *bf, size_t size,
827 struct syscall_arg *arg)
829 bool show_prefix = arg->show_string_prefix;
830 const char *prefix = "O_";
831 int printed = 0, flags = arg->val;
833 #define P_FLAG(n) \
834 if (flags & O_##n) { \
835 printed += scnprintf(bf + printed, size - printed, "%s%s%s", printed ? "|" : "", show_prefix ? prefix : "", #n); \
836 flags &= ~O_##n; \
839 P_FLAG(CLOEXEC);
840 P_FLAG(NONBLOCK);
841 #undef P_FLAG
843 if (flags)
844 printed += scnprintf(bf + printed, size - printed, "%s%#x", printed ? "|" : "", flags);
846 return printed;
849 #define SCA_PIPE_FLAGS syscall_arg__scnprintf_pipe_flags
851 #ifndef GRND_NONBLOCK
852 #define GRND_NONBLOCK 0x0001
853 #endif
854 #ifndef GRND_RANDOM
855 #define GRND_RANDOM 0x0002
856 #endif
858 static size_t syscall_arg__scnprintf_getrandom_flags(char *bf, size_t size,
859 struct syscall_arg *arg)
861 bool show_prefix = arg->show_string_prefix;
862 const char *prefix = "GRND_";
863 int printed = 0, flags = arg->val;
865 #define P_FLAG(n) \
866 if (flags & GRND_##n) { \
867 printed += scnprintf(bf + printed, size - printed, "%s%s%s", printed ? "|" : "", show_prefix ? prefix : "", #n); \
868 flags &= ~GRND_##n; \
871 P_FLAG(RANDOM);
872 P_FLAG(NONBLOCK);
873 #undef P_FLAG
875 if (flags)
876 printed += scnprintf(bf + printed, size - printed, "%s%#x", printed ? "|" : "", flags);
878 return printed;
881 #define SCA_GETRANDOM_FLAGS syscall_arg__scnprintf_getrandom_flags
883 #define STRARRAY(name, array) \
884 { .scnprintf = SCA_STRARRAY, \
885 .strtoul = STUL_STRARRAY, \
886 .parm = &strarray__##array, }
888 #define STRARRAY_FLAGS(name, array) \
889 { .scnprintf = SCA_STRARRAY_FLAGS, \
890 .strtoul = STUL_STRARRAY_FLAGS, \
891 .parm = &strarray__##array, }
893 #include "trace/beauty/arch_errno_names.c"
894 #include "trace/beauty/eventfd.c"
895 #include "trace/beauty/futex_op.c"
896 #include "trace/beauty/futex_val3.c"
897 #include "trace/beauty/mmap.c"
898 #include "trace/beauty/mode_t.c"
899 #include "trace/beauty/msg_flags.c"
900 #include "trace/beauty/open_flags.c"
901 #include "trace/beauty/perf_event_open.c"
902 #include "trace/beauty/pid.c"
903 #include "trace/beauty/sched_policy.c"
904 #include "trace/beauty/seccomp.c"
905 #include "trace/beauty/signum.c"
906 #include "trace/beauty/socket_type.c"
907 #include "trace/beauty/waitid_options.c"
909 static struct syscall_fmt syscall_fmts[] = {
910 { .name = "access",
911 .arg = { [1] = { .scnprintf = SCA_ACCMODE, /* mode */ }, }, },
912 { .name = "arch_prctl",
913 .arg = { [0] = { .scnprintf = SCA_X86_ARCH_PRCTL_CODE, /* code */ },
914 [1] = { .scnprintf = SCA_PTR, /* arg2 */ }, }, },
915 { .name = "bind",
916 .arg = { [0] = { .scnprintf = SCA_INT, /* fd */ },
917 [1] = { .scnprintf = SCA_SOCKADDR, /* umyaddr */ },
918 [2] = { .scnprintf = SCA_INT, /* addrlen */ }, }, },
919 { .name = "bpf",
920 .arg = { [0] = STRARRAY(cmd, bpf_cmd), }, },
921 { .name = "brk", .hexret = true,
922 .arg = { [0] = { .scnprintf = SCA_PTR, /* brk */ }, }, },
923 { .name = "clock_gettime",
924 .arg = { [0] = STRARRAY(clk_id, clockid), }, },
925 { .name = "clone", .errpid = true, .nr_args = 5,
926 .arg = { [0] = { .name = "flags", .scnprintf = SCA_CLONE_FLAGS, },
927 [1] = { .name = "child_stack", .scnprintf = SCA_HEX, },
928 [2] = { .name = "parent_tidptr", .scnprintf = SCA_HEX, },
929 [3] = { .name = "child_tidptr", .scnprintf = SCA_HEX, },
930 [4] = { .name = "tls", .scnprintf = SCA_HEX, }, }, },
931 { .name = "close",
932 .arg = { [0] = { .scnprintf = SCA_CLOSE_FD, /* fd */ }, }, },
933 { .name = "connect",
934 .arg = { [0] = { .scnprintf = SCA_INT, /* fd */ },
935 [1] = { .scnprintf = SCA_SOCKADDR, /* servaddr */ },
936 [2] = { .scnprintf = SCA_INT, /* addrlen */ }, }, },
937 { .name = "epoll_ctl",
938 .arg = { [1] = STRARRAY(op, epoll_ctl_ops), }, },
939 { .name = "eventfd2",
940 .arg = { [1] = { .scnprintf = SCA_EFD_FLAGS, /* flags */ }, }, },
941 { .name = "fchmodat",
942 .arg = { [0] = { .scnprintf = SCA_FDAT, /* fd */ }, }, },
943 { .name = "fchownat",
944 .arg = { [0] = { .scnprintf = SCA_FDAT, /* fd */ }, }, },
945 { .name = "fcntl",
946 .arg = { [1] = { .scnprintf = SCA_FCNTL_CMD, /* cmd */
947 .strtoul = STUL_STRARRAYS,
948 .parm = &strarrays__fcntl_cmds_arrays,
949 .show_zero = true, },
950 [2] = { .scnprintf = SCA_FCNTL_ARG, /* arg */ }, }, },
951 { .name = "flock",
952 .arg = { [1] = { .scnprintf = SCA_FLOCK, /* cmd */ }, }, },
953 { .name = "fsconfig",
954 .arg = { [1] = STRARRAY(cmd, fsconfig_cmds), }, },
955 { .name = "fsmount",
956 .arg = { [1] = STRARRAY_FLAGS(flags, fsmount_flags),
957 [2] = { .scnprintf = SCA_FSMOUNT_ATTR_FLAGS, /* attr_flags */ }, }, },
958 { .name = "fspick",
959 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ },
960 [1] = { .scnprintf = SCA_FILENAME, /* path */ },
961 [2] = { .scnprintf = SCA_FSPICK_FLAGS, /* flags */ }, }, },
962 { .name = "fstat", .alias = "newfstat", },
963 { .name = "fstatat", .alias = "newfstatat", },
964 { .name = "futex",
965 .arg = { [1] = { .scnprintf = SCA_FUTEX_OP, /* op */ },
966 [5] = { .scnprintf = SCA_FUTEX_VAL3, /* val3 */ }, }, },
967 { .name = "futimesat",
968 .arg = { [0] = { .scnprintf = SCA_FDAT, /* fd */ }, }, },
969 { .name = "getitimer",
970 .arg = { [0] = STRARRAY(which, itimers), }, },
971 { .name = "getpid", .errpid = true, },
972 { .name = "getpgid", .errpid = true, },
973 { .name = "getppid", .errpid = true, },
974 { .name = "getrandom",
975 .arg = { [2] = { .scnprintf = SCA_GETRANDOM_FLAGS, /* flags */ }, }, },
976 { .name = "getrlimit",
977 .arg = { [0] = STRARRAY(resource, rlimit_resources), }, },
978 { .name = "gettid", .errpid = true, },
979 { .name = "ioctl",
980 .arg = {
981 #if defined(__i386__) || defined(__x86_64__)
983 * FIXME: Make this available to all arches.
985 [1] = { .scnprintf = SCA_IOCTL_CMD, /* cmd */ },
986 [2] = { .scnprintf = SCA_HEX, /* arg */ }, }, },
987 #else
988 [2] = { .scnprintf = SCA_HEX, /* arg */ }, }, },
989 #endif
990 { .name = "kcmp", .nr_args = 5,
991 .arg = { [0] = { .name = "pid1", .scnprintf = SCA_PID, },
992 [1] = { .name = "pid2", .scnprintf = SCA_PID, },
993 [2] = { .name = "type", .scnprintf = SCA_KCMP_TYPE, },
994 [3] = { .name = "idx1", .scnprintf = SCA_KCMP_IDX, },
995 [4] = { .name = "idx2", .scnprintf = SCA_KCMP_IDX, }, }, },
996 { .name = "keyctl",
997 .arg = { [0] = STRARRAY(option, keyctl_options), }, },
998 { .name = "kill",
999 .arg = { [1] = { .scnprintf = SCA_SIGNUM, /* sig */ }, }, },
1000 { .name = "linkat",
1001 .arg = { [0] = { .scnprintf = SCA_FDAT, /* fd */ }, }, },
1002 { .name = "lseek",
1003 .arg = { [2] = STRARRAY(whence, whences), }, },
1004 { .name = "lstat", .alias = "newlstat", },
1005 { .name = "madvise",
1006 .arg = { [0] = { .scnprintf = SCA_HEX, /* start */ },
1007 [2] = { .scnprintf = SCA_MADV_BHV, /* behavior */ }, }, },
1008 { .name = "mkdirat",
1009 .arg = { [0] = { .scnprintf = SCA_FDAT, /* fd */ }, }, },
1010 { .name = "mknodat",
1011 .arg = { [0] = { .scnprintf = SCA_FDAT, /* fd */ }, }, },
1012 { .name = "mmap", .hexret = true,
1013 /* The standard mmap maps to old_mmap on s390x */
1014 #if defined(__s390x__)
1015 .alias = "old_mmap",
1016 #endif
1017 .arg = { [2] = { .scnprintf = SCA_MMAP_PROT, /* prot */ },
1018 [3] = { .scnprintf = SCA_MMAP_FLAGS, /* flags */
1019 .strtoul = STUL_STRARRAY_FLAGS,
1020 .parm = &strarray__mmap_flags, },
1021 [5] = { .scnprintf = SCA_HEX, /* offset */ }, }, },
1022 { .name = "mount",
1023 .arg = { [0] = { .scnprintf = SCA_FILENAME, /* dev_name */ },
1024 [3] = { .scnprintf = SCA_MOUNT_FLAGS, /* flags */
1025 .mask_val = SCAMV_MOUNT_FLAGS, /* flags */ }, }, },
1026 { .name = "move_mount",
1027 .arg = { [0] = { .scnprintf = SCA_FDAT, /* from_dfd */ },
1028 [1] = { .scnprintf = SCA_FILENAME, /* from_pathname */ },
1029 [2] = { .scnprintf = SCA_FDAT, /* to_dfd */ },
1030 [3] = { .scnprintf = SCA_FILENAME, /* to_pathname */ },
1031 [4] = { .scnprintf = SCA_MOVE_MOUNT_FLAGS, /* flags */ }, }, },
1032 { .name = "mprotect",
1033 .arg = { [0] = { .scnprintf = SCA_HEX, /* start */ },
1034 [2] = { .scnprintf = SCA_MMAP_PROT, /* prot */ }, }, },
1035 { .name = "mq_unlink",
1036 .arg = { [0] = { .scnprintf = SCA_FILENAME, /* u_name */ }, }, },
1037 { .name = "mremap", .hexret = true,
1038 .arg = { [3] = { .scnprintf = SCA_MREMAP_FLAGS, /* flags */ }, }, },
1039 { .name = "name_to_handle_at",
1040 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ }, }, },
1041 { .name = "newfstatat",
1042 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ }, }, },
1043 { .name = "open",
1044 .arg = { [1] = { .scnprintf = SCA_OPEN_FLAGS, /* flags */ }, }, },
1045 { .name = "open_by_handle_at",
1046 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ },
1047 [2] = { .scnprintf = SCA_OPEN_FLAGS, /* flags */ }, }, },
1048 { .name = "openat",
1049 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ },
1050 [2] = { .scnprintf = SCA_OPEN_FLAGS, /* flags */ }, }, },
1051 { .name = "perf_event_open",
1052 .arg = { [2] = { .scnprintf = SCA_INT, /* cpu */ },
1053 [3] = { .scnprintf = SCA_FD, /* group_fd */ },
1054 [4] = { .scnprintf = SCA_PERF_FLAGS, /* flags */ }, }, },
1055 { .name = "pipe2",
1056 .arg = { [1] = { .scnprintf = SCA_PIPE_FLAGS, /* flags */ }, }, },
1057 { .name = "pkey_alloc",
1058 .arg = { [1] = { .scnprintf = SCA_PKEY_ALLOC_ACCESS_RIGHTS, /* access_rights */ }, }, },
1059 { .name = "pkey_free",
1060 .arg = { [0] = { .scnprintf = SCA_INT, /* key */ }, }, },
1061 { .name = "pkey_mprotect",
1062 .arg = { [0] = { .scnprintf = SCA_HEX, /* start */ },
1063 [2] = { .scnprintf = SCA_MMAP_PROT, /* prot */ },
1064 [3] = { .scnprintf = SCA_INT, /* pkey */ }, }, },
1065 { .name = "poll", .timeout = true, },
1066 { .name = "ppoll", .timeout = true, },
1067 { .name = "prctl",
1068 .arg = { [0] = { .scnprintf = SCA_PRCTL_OPTION, /* option */ },
1069 [1] = { .scnprintf = SCA_PRCTL_ARG2, /* arg2 */ },
1070 [2] = { .scnprintf = SCA_PRCTL_ARG3, /* arg3 */ }, }, },
1071 { .name = "pread", .alias = "pread64", },
1072 { .name = "preadv", .alias = "pread", },
1073 { .name = "prlimit64",
1074 .arg = { [1] = STRARRAY(resource, rlimit_resources), }, },
1075 { .name = "pwrite", .alias = "pwrite64", },
1076 { .name = "readlinkat",
1077 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ }, }, },
1078 { .name = "recvfrom",
1079 .arg = { [3] = { .scnprintf = SCA_MSG_FLAGS, /* flags */ }, }, },
1080 { .name = "recvmmsg",
1081 .arg = { [3] = { .scnprintf = SCA_MSG_FLAGS, /* flags */ }, }, },
1082 { .name = "recvmsg",
1083 .arg = { [2] = { .scnprintf = SCA_MSG_FLAGS, /* flags */ }, }, },
1084 { .name = "renameat",
1085 .arg = { [0] = { .scnprintf = SCA_FDAT, /* olddirfd */ },
1086 [2] = { .scnprintf = SCA_FDAT, /* newdirfd */ }, }, },
1087 { .name = "renameat2",
1088 .arg = { [0] = { .scnprintf = SCA_FDAT, /* olddirfd */ },
1089 [2] = { .scnprintf = SCA_FDAT, /* newdirfd */ },
1090 [4] = { .scnprintf = SCA_RENAMEAT2_FLAGS, /* flags */ }, }, },
1091 { .name = "rt_sigaction",
1092 .arg = { [0] = { .scnprintf = SCA_SIGNUM, /* sig */ }, }, },
1093 { .name = "rt_sigprocmask",
1094 .arg = { [0] = STRARRAY(how, sighow), }, },
1095 { .name = "rt_sigqueueinfo",
1096 .arg = { [1] = { .scnprintf = SCA_SIGNUM, /* sig */ }, }, },
1097 { .name = "rt_tgsigqueueinfo",
1098 .arg = { [2] = { .scnprintf = SCA_SIGNUM, /* sig */ }, }, },
1099 { .name = "sched_setscheduler",
1100 .arg = { [1] = { .scnprintf = SCA_SCHED_POLICY, /* policy */ }, }, },
1101 { .name = "seccomp",
1102 .arg = { [0] = { .scnprintf = SCA_SECCOMP_OP, /* op */ },
1103 [1] = { .scnprintf = SCA_SECCOMP_FLAGS, /* flags */ }, }, },
1104 { .name = "select", .timeout = true, },
1105 { .name = "sendfile", .alias = "sendfile64", },
1106 { .name = "sendmmsg",
1107 .arg = { [3] = { .scnprintf = SCA_MSG_FLAGS, /* flags */ }, }, },
1108 { .name = "sendmsg",
1109 .arg = { [2] = { .scnprintf = SCA_MSG_FLAGS, /* flags */ }, }, },
1110 { .name = "sendto",
1111 .arg = { [3] = { .scnprintf = SCA_MSG_FLAGS, /* flags */ },
1112 [4] = { .scnprintf = SCA_SOCKADDR, /* addr */ }, }, },
1113 { .name = "set_tid_address", .errpid = true, },
1114 { .name = "setitimer",
1115 .arg = { [0] = STRARRAY(which, itimers), }, },
1116 { .name = "setrlimit",
1117 .arg = { [0] = STRARRAY(resource, rlimit_resources), }, },
1118 { .name = "socket",
1119 .arg = { [0] = STRARRAY(family, socket_families),
1120 [1] = { .scnprintf = SCA_SK_TYPE, /* type */ },
1121 [2] = { .scnprintf = SCA_SK_PROTO, /* protocol */ }, }, },
1122 { .name = "socketpair",
1123 .arg = { [0] = STRARRAY(family, socket_families),
1124 [1] = { .scnprintf = SCA_SK_TYPE, /* type */ },
1125 [2] = { .scnprintf = SCA_SK_PROTO, /* protocol */ }, }, },
1126 { .name = "stat", .alias = "newstat", },
1127 { .name = "statx",
1128 .arg = { [0] = { .scnprintf = SCA_FDAT, /* fdat */ },
1129 [2] = { .scnprintf = SCA_STATX_FLAGS, /* flags */ } ,
1130 [3] = { .scnprintf = SCA_STATX_MASK, /* mask */ }, }, },
1131 { .name = "swapoff",
1132 .arg = { [0] = { .scnprintf = SCA_FILENAME, /* specialfile */ }, }, },
1133 { .name = "swapon",
1134 .arg = { [0] = { .scnprintf = SCA_FILENAME, /* specialfile */ }, }, },
1135 { .name = "symlinkat",
1136 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ }, }, },
1137 { .name = "sync_file_range",
1138 .arg = { [3] = { .scnprintf = SCA_SYNC_FILE_RANGE_FLAGS, /* flags */ }, }, },
1139 { .name = "tgkill",
1140 .arg = { [2] = { .scnprintf = SCA_SIGNUM, /* sig */ }, }, },
1141 { .name = "tkill",
1142 .arg = { [1] = { .scnprintf = SCA_SIGNUM, /* sig */ }, }, },
1143 { .name = "umount2", .alias = "umount",
1144 .arg = { [0] = { .scnprintf = SCA_FILENAME, /* name */ }, }, },
1145 { .name = "uname", .alias = "newuname", },
1146 { .name = "unlinkat",
1147 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ }, }, },
1148 { .name = "utimensat",
1149 .arg = { [0] = { .scnprintf = SCA_FDAT, /* dirfd */ }, }, },
1150 { .name = "wait4", .errpid = true,
1151 .arg = { [2] = { .scnprintf = SCA_WAITID_OPTIONS, /* options */ }, }, },
1152 { .name = "waitid", .errpid = true,
1153 .arg = { [3] = { .scnprintf = SCA_WAITID_OPTIONS, /* options */ }, }, },
1156 static int syscall_fmt__cmp(const void *name, const void *fmtp)
1158 const struct syscall_fmt *fmt = fmtp;
1159 return strcmp(name, fmt->name);
1162 static struct syscall_fmt *__syscall_fmt__find(struct syscall_fmt *fmts, const int nmemb, const char *name)
1164 return bsearch(name, fmts, nmemb, sizeof(struct syscall_fmt), syscall_fmt__cmp);
1167 static struct syscall_fmt *syscall_fmt__find(const char *name)
1169 const int nmemb = ARRAY_SIZE(syscall_fmts);
1170 return __syscall_fmt__find(syscall_fmts, nmemb, name);
1173 static struct syscall_fmt *__syscall_fmt__find_by_alias(struct syscall_fmt *fmts, const int nmemb, const char *alias)
1175 int i;
1177 for (i = 0; i < nmemb; ++i) {
1178 if (fmts[i].alias && strcmp(fmts[i].alias, alias) == 0)
1179 return &fmts[i];
1182 return NULL;
1185 static struct syscall_fmt *syscall_fmt__find_by_alias(const char *alias)
1187 const int nmemb = ARRAY_SIZE(syscall_fmts);
1188 return __syscall_fmt__find_by_alias(syscall_fmts, nmemb, alias);
1192 * is_exit: is this "exit" or "exit_group"?
1193 * is_open: is this "open" or "openat"? To associate the fd returned in sys_exit with the pathname in sys_enter.
1194 * args_size: sum of the sizes of the syscall arguments, anything after that is augmented stuff: pathname for openat, etc.
1195 * nonexistent: Just a hole in the syscall table, syscall id not allocated
1197 struct syscall {
1198 struct tep_event *tp_format;
1199 int nr_args;
1200 int args_size;
1201 struct {
1202 struct bpf_program *sys_enter,
1203 *sys_exit;
1204 } bpf_prog;
1205 bool is_exit;
1206 bool is_open;
1207 bool nonexistent;
1208 struct tep_format_field *args;
1209 const char *name;
1210 struct syscall_fmt *fmt;
1211 struct syscall_arg_fmt *arg_fmt;
1215 * Must match what is in the BPF program:
1217 * tools/perf/examples/bpf/augmented_raw_syscalls.c
1219 struct bpf_map_syscall_entry {
1220 bool enabled;
1221 u16 string_args_len[6];
1225 * We need to have this 'calculated' boolean because in some cases we really
1226 * don't know what is the duration of a syscall, for instance, when we start
1227 * a session and some threads are waiting for a syscall to finish, say 'poll',
1228 * in which case all we can do is to print "( ? ) for duration and for the
1229 * start timestamp.
1231 static size_t fprintf_duration(unsigned long t, bool calculated, FILE *fp)
1233 double duration = (double)t / NSEC_PER_MSEC;
1234 size_t printed = fprintf(fp, "(");
1236 if (!calculated)
1237 printed += fprintf(fp, " ");
1238 else if (duration >= 1.0)
1239 printed += color_fprintf(fp, PERF_COLOR_RED, "%6.3f ms", duration);
1240 else if (duration >= 0.01)
1241 printed += color_fprintf(fp, PERF_COLOR_YELLOW, "%6.3f ms", duration);
1242 else
1243 printed += color_fprintf(fp, PERF_COLOR_NORMAL, "%6.3f ms", duration);
1244 return printed + fprintf(fp, "): ");
1248 * filename.ptr: The filename char pointer that will be vfs_getname'd
1249 * filename.entry_str_pos: Where to insert the string translated from
1250 * filename.ptr by the vfs_getname tracepoint/kprobe.
1251 * ret_scnprintf: syscall args may set this to a different syscall return
1252 * formatter, for instance, fcntl may return fds, file flags, etc.
1254 struct thread_trace {
1255 u64 entry_time;
1256 bool entry_pending;
1257 unsigned long nr_events;
1258 unsigned long pfmaj, pfmin;
1259 char *entry_str;
1260 double runtime_ms;
1261 size_t (*ret_scnprintf)(char *bf, size_t size, struct syscall_arg *arg);
1262 struct {
1263 unsigned long ptr;
1264 short int entry_str_pos;
1265 bool pending_open;
1266 unsigned int namelen;
1267 char *name;
1268 } filename;
1269 struct {
1270 int max;
1271 struct file *table;
1272 } files;
1274 struct intlist *syscall_stats;
1277 static struct thread_trace *thread_trace__new(void)
1279 struct thread_trace *ttrace = zalloc(sizeof(struct thread_trace));
1281 if (ttrace) {
1282 ttrace->files.max = -1;
1283 ttrace->syscall_stats = intlist__new(NULL);
1286 return ttrace;
1289 static struct thread_trace *thread__trace(struct thread *thread, FILE *fp)
1291 struct thread_trace *ttrace;
1293 if (thread == NULL)
1294 goto fail;
1296 if (thread__priv(thread) == NULL)
1297 thread__set_priv(thread, thread_trace__new());
1299 if (thread__priv(thread) == NULL)
1300 goto fail;
1302 ttrace = thread__priv(thread);
1303 ++ttrace->nr_events;
1305 return ttrace;
1306 fail:
1307 color_fprintf(fp, PERF_COLOR_RED,
1308 "WARNING: not enough memory, dropping samples!\n");
1309 return NULL;
1313 void syscall_arg__set_ret_scnprintf(struct syscall_arg *arg,
1314 size_t (*ret_scnprintf)(char *bf, size_t size, struct syscall_arg *arg))
1316 struct thread_trace *ttrace = thread__priv(arg->thread);
1318 ttrace->ret_scnprintf = ret_scnprintf;
1321 #define TRACE_PFMAJ (1 << 0)
1322 #define TRACE_PFMIN (1 << 1)
1324 static const size_t trace__entry_str_size = 2048;
1326 static struct file *thread_trace__files_entry(struct thread_trace *ttrace, int fd)
1328 if (fd < 0)
1329 return NULL;
1331 if (fd > ttrace->files.max) {
1332 struct file *nfiles = realloc(ttrace->files.table, (fd + 1) * sizeof(struct file));
1334 if (nfiles == NULL)
1335 return NULL;
1337 if (ttrace->files.max != -1) {
1338 memset(nfiles + ttrace->files.max + 1, 0,
1339 (fd - ttrace->files.max) * sizeof(struct file));
1340 } else {
1341 memset(nfiles, 0, (fd + 1) * sizeof(struct file));
1344 ttrace->files.table = nfiles;
1345 ttrace->files.max = fd;
1348 return ttrace->files.table + fd;
1351 struct file *thread__files_entry(struct thread *thread, int fd)
1353 return thread_trace__files_entry(thread__priv(thread), fd);
1356 static int trace__set_fd_pathname(struct thread *thread, int fd, const char *pathname)
1358 struct thread_trace *ttrace = thread__priv(thread);
1359 struct file *file = thread_trace__files_entry(ttrace, fd);
1361 if (file != NULL) {
1362 struct stat st;
1363 if (stat(pathname, &st) == 0)
1364 file->dev_maj = major(st.st_rdev);
1365 file->pathname = strdup(pathname);
1366 if (file->pathname)
1367 return 0;
1370 return -1;
1373 static int thread__read_fd_path(struct thread *thread, int fd)
1375 char linkname[PATH_MAX], pathname[PATH_MAX];
1376 struct stat st;
1377 int ret;
1379 if (thread->pid_ == thread->tid) {
1380 scnprintf(linkname, sizeof(linkname),
1381 "/proc/%d/fd/%d", thread->pid_, fd);
1382 } else {
1383 scnprintf(linkname, sizeof(linkname),
1384 "/proc/%d/task/%d/fd/%d", thread->pid_, thread->tid, fd);
1387 if (lstat(linkname, &st) < 0 || st.st_size + 1 > (off_t)sizeof(pathname))
1388 return -1;
1390 ret = readlink(linkname, pathname, sizeof(pathname));
1392 if (ret < 0 || ret > st.st_size)
1393 return -1;
1395 pathname[ret] = '\0';
1396 return trace__set_fd_pathname(thread, fd, pathname);
1399 static const char *thread__fd_path(struct thread *thread, int fd,
1400 struct trace *trace)
1402 struct thread_trace *ttrace = thread__priv(thread);
1404 if (ttrace == NULL || trace->fd_path_disabled)
1405 return NULL;
1407 if (fd < 0)
1408 return NULL;
1410 if ((fd > ttrace->files.max || ttrace->files.table[fd].pathname == NULL)) {
1411 if (!trace->live)
1412 return NULL;
1413 ++trace->stats.proc_getname;
1414 if (thread__read_fd_path(thread, fd))
1415 return NULL;
1418 return ttrace->files.table[fd].pathname;
1421 size_t syscall_arg__scnprintf_fd(char *bf, size_t size, struct syscall_arg *arg)
1423 int fd = arg->val;
1424 size_t printed = scnprintf(bf, size, "%d", fd);
1425 const char *path = thread__fd_path(arg->thread, fd, arg->trace);
1427 if (path)
1428 printed += scnprintf(bf + printed, size - printed, "<%s>", path);
1430 return printed;
1433 size_t pid__scnprintf_fd(struct trace *trace, pid_t pid, int fd, char *bf, size_t size)
1435 size_t printed = scnprintf(bf, size, "%d", fd);
1436 struct thread *thread = machine__find_thread(trace->host, pid, pid);
1438 if (thread) {
1439 const char *path = thread__fd_path(thread, fd, trace);
1441 if (path)
1442 printed += scnprintf(bf + printed, size - printed, "<%s>", path);
1444 thread__put(thread);
1447 return printed;
1450 static size_t syscall_arg__scnprintf_close_fd(char *bf, size_t size,
1451 struct syscall_arg *arg)
1453 int fd = arg->val;
1454 size_t printed = syscall_arg__scnprintf_fd(bf, size, arg);
1455 struct thread_trace *ttrace = thread__priv(arg->thread);
1457 if (ttrace && fd >= 0 && fd <= ttrace->files.max)
1458 zfree(&ttrace->files.table[fd].pathname);
1460 return printed;
1463 static void thread__set_filename_pos(struct thread *thread, const char *bf,
1464 unsigned long ptr)
1466 struct thread_trace *ttrace = thread__priv(thread);
1468 ttrace->filename.ptr = ptr;
1469 ttrace->filename.entry_str_pos = bf - ttrace->entry_str;
1472 static size_t syscall_arg__scnprintf_augmented_string(struct syscall_arg *arg, char *bf, size_t size)
1474 struct augmented_arg *augmented_arg = arg->augmented.args;
1475 size_t printed = scnprintf(bf, size, "\"%.*s\"", augmented_arg->size, augmented_arg->value);
1477 * So that the next arg with a payload can consume its augmented arg, i.e. for rename* syscalls
1478 * we would have two strings, each prefixed by its size.
1480 int consumed = sizeof(*augmented_arg) + augmented_arg->size;
1482 arg->augmented.args = ((void *)arg->augmented.args) + consumed;
1483 arg->augmented.size -= consumed;
1485 return printed;
1488 static size_t syscall_arg__scnprintf_filename(char *bf, size_t size,
1489 struct syscall_arg *arg)
1491 unsigned long ptr = arg->val;
1493 if (arg->augmented.args)
1494 return syscall_arg__scnprintf_augmented_string(arg, bf, size);
1496 if (!arg->trace->vfs_getname)
1497 return scnprintf(bf, size, "%#x", ptr);
1499 thread__set_filename_pos(arg->thread, bf, ptr);
1500 return 0;
1503 static bool trace__filter_duration(struct trace *trace, double t)
1505 return t < (trace->duration_filter * NSEC_PER_MSEC);
1508 static size_t __trace__fprintf_tstamp(struct trace *trace, u64 tstamp, FILE *fp)
1510 double ts = (double)(tstamp - trace->base_time) / NSEC_PER_MSEC;
1512 return fprintf(fp, "%10.3f ", ts);
1516 * We're handling tstamp=0 as an undefined tstamp, i.e. like when we are
1517 * using ttrace->entry_time for a thread that receives a sys_exit without
1518 * first having received a sys_enter ("poll" issued before tracing session
1519 * starts, lost sys_enter exit due to ring buffer overflow).
1521 static size_t trace__fprintf_tstamp(struct trace *trace, u64 tstamp, FILE *fp)
1523 if (tstamp > 0)
1524 return __trace__fprintf_tstamp(trace, tstamp, fp);
1526 return fprintf(fp, " ? ");
1529 static bool done = false;
1530 static bool interrupted = false;
1532 static void sig_handler(int sig)
1534 done = true;
1535 interrupted = sig == SIGINT;
1538 static size_t trace__fprintf_comm_tid(struct trace *trace, struct thread *thread, FILE *fp)
1540 size_t printed = 0;
1542 if (trace->multiple_threads) {
1543 if (trace->show_comm)
1544 printed += fprintf(fp, "%.14s/", thread__comm_str(thread));
1545 printed += fprintf(fp, "%d ", thread->tid);
1548 return printed;
1551 static size_t trace__fprintf_entry_head(struct trace *trace, struct thread *thread,
1552 u64 duration, bool duration_calculated, u64 tstamp, FILE *fp)
1554 size_t printed = 0;
1556 if (trace->show_tstamp)
1557 printed = trace__fprintf_tstamp(trace, tstamp, fp);
1558 if (trace->show_duration)
1559 printed += fprintf_duration(duration, duration_calculated, fp);
1560 return printed + trace__fprintf_comm_tid(trace, thread, fp);
1563 static int trace__process_event(struct trace *trace, struct machine *machine,
1564 union perf_event *event, struct perf_sample *sample)
1566 int ret = 0;
1568 switch (event->header.type) {
1569 case PERF_RECORD_LOST:
1570 color_fprintf(trace->output, PERF_COLOR_RED,
1571 "LOST %" PRIu64 " events!\n", event->lost.lost);
1572 ret = machine__process_lost_event(machine, event, sample);
1573 break;
1574 default:
1575 ret = machine__process_event(machine, event, sample);
1576 break;
1579 return ret;
1582 static int trace__tool_process(struct perf_tool *tool,
1583 union perf_event *event,
1584 struct perf_sample *sample,
1585 struct machine *machine)
1587 struct trace *trace = container_of(tool, struct trace, tool);
1588 return trace__process_event(trace, machine, event, sample);
1591 static char *trace__machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp)
1593 struct machine *machine = vmachine;
1595 if (machine->kptr_restrict_warned)
1596 return NULL;
1598 if (symbol_conf.kptr_restrict) {
1599 pr_warning("Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
1600 "Check /proc/sys/kernel/kptr_restrict and /proc/sys/kernel/perf_event_paranoid.\n\n"
1601 "Kernel samples will not be resolved.\n");
1602 machine->kptr_restrict_warned = true;
1603 return NULL;
1606 return machine__resolve_kernel_addr(vmachine, addrp, modp);
1609 static int trace__symbols_init(struct trace *trace, struct evlist *evlist)
1611 int err = symbol__init(NULL);
1613 if (err)
1614 return err;
1616 trace->host = machine__new_host();
1617 if (trace->host == NULL)
1618 return -ENOMEM;
1620 err = trace_event__register_resolver(trace->host, trace__machine__resolve_kernel_addr);
1621 if (err < 0)
1622 goto out;
1624 err = __machine__synthesize_threads(trace->host, &trace->tool, &trace->opts.target,
1625 evlist->core.threads, trace__tool_process, false,
1627 out:
1628 if (err)
1629 symbol__exit();
1631 return err;
1634 static void trace__symbols__exit(struct trace *trace)
1636 machine__exit(trace->host);
1637 trace->host = NULL;
1639 symbol__exit();
1642 static int syscall__alloc_arg_fmts(struct syscall *sc, int nr_args)
1644 int idx;
1646 if (nr_args == 6 && sc->fmt && sc->fmt->nr_args != 0)
1647 nr_args = sc->fmt->nr_args;
1649 sc->arg_fmt = calloc(nr_args, sizeof(*sc->arg_fmt));
1650 if (sc->arg_fmt == NULL)
1651 return -1;
1653 for (idx = 0; idx < nr_args; ++idx) {
1654 if (sc->fmt)
1655 sc->arg_fmt[idx] = sc->fmt->arg[idx];
1658 sc->nr_args = nr_args;
1659 return 0;
1662 static struct syscall_arg_fmt syscall_arg_fmts__by_name[] = {
1663 { .name = "msr", .scnprintf = SCA_X86_MSR, .strtoul = STUL_X86_MSR, },
1664 { .name = "vector", .scnprintf = SCA_X86_IRQ_VECTORS, .strtoul = STUL_X86_IRQ_VECTORS, },
1667 static int syscall_arg_fmt__cmp(const void *name, const void *fmtp)
1669 const struct syscall_arg_fmt *fmt = fmtp;
1670 return strcmp(name, fmt->name);
1673 static struct syscall_arg_fmt *
1674 __syscall_arg_fmt__find_by_name(struct syscall_arg_fmt *fmts, const int nmemb, const char *name)
1676 return bsearch(name, fmts, nmemb, sizeof(struct syscall_arg_fmt), syscall_arg_fmt__cmp);
1679 static struct syscall_arg_fmt *syscall_arg_fmt__find_by_name(const char *name)
1681 const int nmemb = ARRAY_SIZE(syscall_arg_fmts__by_name);
1682 return __syscall_arg_fmt__find_by_name(syscall_arg_fmts__by_name, nmemb, name);
1685 static struct tep_format_field *
1686 syscall_arg_fmt__init_array(struct syscall_arg_fmt *arg, struct tep_format_field *field)
1688 struct tep_format_field *last_field = NULL;
1689 int len;
1691 for (; field; field = field->next, ++arg) {
1692 last_field = field;
1694 if (arg->scnprintf)
1695 continue;
1697 len = strlen(field->name);
1699 if (strcmp(field->type, "const char *") == 0 &&
1700 ((len >= 4 && strcmp(field->name + len - 4, "name") == 0) ||
1701 strstr(field->name, "path") != NULL))
1702 arg->scnprintf = SCA_FILENAME;
1703 else if ((field->flags & TEP_FIELD_IS_POINTER) || strstr(field->name, "addr"))
1704 arg->scnprintf = SCA_PTR;
1705 else if (strcmp(field->type, "pid_t") == 0)
1706 arg->scnprintf = SCA_PID;
1707 else if (strcmp(field->type, "umode_t") == 0)
1708 arg->scnprintf = SCA_MODE_T;
1709 else if ((field->flags & TEP_FIELD_IS_ARRAY) && strstr(field->type, "char")) {
1710 arg->scnprintf = SCA_CHAR_ARRAY;
1711 arg->nr_entries = field->arraylen;
1712 } else if ((strcmp(field->type, "int") == 0 ||
1713 strcmp(field->type, "unsigned int") == 0 ||
1714 strcmp(field->type, "long") == 0) &&
1715 len >= 2 && strcmp(field->name + len - 2, "fd") == 0) {
1717 * /sys/kernel/tracing/events/syscalls/sys_enter*
1718 * egrep 'field:.*fd;' .../format|sed -r 's/.*field:([a-z ]+) [a-z_]*fd.+/\1/g'|sort|uniq -c
1719 * 65 int
1720 * 23 unsigned int
1721 * 7 unsigned long
1723 arg->scnprintf = SCA_FD;
1724 } else {
1725 struct syscall_arg_fmt *fmt = syscall_arg_fmt__find_by_name(field->name);
1727 if (fmt) {
1728 arg->scnprintf = fmt->scnprintf;
1729 arg->strtoul = fmt->strtoul;
1734 return last_field;
1737 static int syscall__set_arg_fmts(struct syscall *sc)
1739 struct tep_format_field *last_field = syscall_arg_fmt__init_array(sc->arg_fmt, sc->args);
1741 if (last_field)
1742 sc->args_size = last_field->offset + last_field->size;
1744 return 0;
1747 static int trace__read_syscall_info(struct trace *trace, int id)
1749 char tp_name[128];
1750 struct syscall *sc;
1751 const char *name = syscalltbl__name(trace->sctbl, id);
1753 if (trace->syscalls.table == NULL) {
1754 trace->syscalls.table = calloc(trace->sctbl->syscalls.max_id + 1, sizeof(*sc));
1755 if (trace->syscalls.table == NULL)
1756 return -ENOMEM;
1759 sc = trace->syscalls.table + id;
1760 if (sc->nonexistent)
1761 return 0;
1763 if (name == NULL) {
1764 sc->nonexistent = true;
1765 return 0;
1768 sc->name = name;
1769 sc->fmt = syscall_fmt__find(sc->name);
1771 snprintf(tp_name, sizeof(tp_name), "sys_enter_%s", sc->name);
1772 sc->tp_format = trace_event__tp_format("syscalls", tp_name);
1774 if (IS_ERR(sc->tp_format) && sc->fmt && sc->fmt->alias) {
1775 snprintf(tp_name, sizeof(tp_name), "sys_enter_%s", sc->fmt->alias);
1776 sc->tp_format = trace_event__tp_format("syscalls", tp_name);
1779 if (syscall__alloc_arg_fmts(sc, IS_ERR(sc->tp_format) ? 6 : sc->tp_format->format.nr_fields))
1780 return -ENOMEM;
1782 if (IS_ERR(sc->tp_format))
1783 return PTR_ERR(sc->tp_format);
1785 sc->args = sc->tp_format->format.fields;
1787 * We need to check and discard the first variable '__syscall_nr'
1788 * or 'nr' that mean the syscall number. It is needless here.
1789 * So drop '__syscall_nr' or 'nr' field but does not exist on older kernels.
1791 if (sc->args && (!strcmp(sc->args->name, "__syscall_nr") || !strcmp(sc->args->name, "nr"))) {
1792 sc->args = sc->args->next;
1793 --sc->nr_args;
1796 sc->is_exit = !strcmp(name, "exit_group") || !strcmp(name, "exit");
1797 sc->is_open = !strcmp(name, "open") || !strcmp(name, "openat");
1799 return syscall__set_arg_fmts(sc);
1802 static int perf_evsel__init_tp_arg_scnprintf(struct evsel *evsel)
1804 struct syscall_arg_fmt *fmt = evsel__syscall_arg_fmt(evsel);
1806 if (fmt != NULL) {
1807 syscall_arg_fmt__init_array(fmt, evsel->tp_format->format.fields);
1808 return 0;
1811 return -ENOMEM;
1814 static int intcmp(const void *a, const void *b)
1816 const int *one = a, *another = b;
1818 return *one - *another;
1821 static int trace__validate_ev_qualifier(struct trace *trace)
1823 int err = 0;
1824 bool printed_invalid_prefix = false;
1825 struct str_node *pos;
1826 size_t nr_used = 0, nr_allocated = strlist__nr_entries(trace->ev_qualifier);
1828 trace->ev_qualifier_ids.entries = malloc(nr_allocated *
1829 sizeof(trace->ev_qualifier_ids.entries[0]));
1831 if (trace->ev_qualifier_ids.entries == NULL) {
1832 fputs("Error:\tNot enough memory for allocating events qualifier ids\n",
1833 trace->output);
1834 err = -EINVAL;
1835 goto out;
1838 strlist__for_each_entry(pos, trace->ev_qualifier) {
1839 const char *sc = pos->s;
1840 int id = syscalltbl__id(trace->sctbl, sc), match_next = -1;
1842 if (id < 0) {
1843 id = syscalltbl__strglobmatch_first(trace->sctbl, sc, &match_next);
1844 if (id >= 0)
1845 goto matches;
1847 if (!printed_invalid_prefix) {
1848 pr_debug("Skipping unknown syscalls: ");
1849 printed_invalid_prefix = true;
1850 } else {
1851 pr_debug(", ");
1854 pr_debug("%s", sc);
1855 continue;
1857 matches:
1858 trace->ev_qualifier_ids.entries[nr_used++] = id;
1859 if (match_next == -1)
1860 continue;
1862 while (1) {
1863 id = syscalltbl__strglobmatch_next(trace->sctbl, sc, &match_next);
1864 if (id < 0)
1865 break;
1866 if (nr_allocated == nr_used) {
1867 void *entries;
1869 nr_allocated += 8;
1870 entries = realloc(trace->ev_qualifier_ids.entries,
1871 nr_allocated * sizeof(trace->ev_qualifier_ids.entries[0]));
1872 if (entries == NULL) {
1873 err = -ENOMEM;
1874 fputs("\nError:\t Not enough memory for parsing\n", trace->output);
1875 goto out_free;
1877 trace->ev_qualifier_ids.entries = entries;
1879 trace->ev_qualifier_ids.entries[nr_used++] = id;
1883 trace->ev_qualifier_ids.nr = nr_used;
1884 qsort(trace->ev_qualifier_ids.entries, nr_used, sizeof(int), intcmp);
1885 out:
1886 if (printed_invalid_prefix)
1887 pr_debug("\n");
1888 return err;
1889 out_free:
1890 zfree(&trace->ev_qualifier_ids.entries);
1891 trace->ev_qualifier_ids.nr = 0;
1892 goto out;
1895 static __maybe_unused bool trace__syscall_enabled(struct trace *trace, int id)
1897 bool in_ev_qualifier;
1899 if (trace->ev_qualifier_ids.nr == 0)
1900 return true;
1902 in_ev_qualifier = bsearch(&id, trace->ev_qualifier_ids.entries,
1903 trace->ev_qualifier_ids.nr, sizeof(int), intcmp) != NULL;
1905 if (in_ev_qualifier)
1906 return !trace->not_ev_qualifier;
1908 return trace->not_ev_qualifier;
1912 * args is to be interpreted as a series of longs but we need to handle
1913 * 8-byte unaligned accesses. args points to raw_data within the event
1914 * and raw_data is guaranteed to be 8-byte unaligned because it is
1915 * preceded by raw_size which is a u32. So we need to copy args to a temp
1916 * variable to read it. Most notably this avoids extended load instructions
1917 * on unaligned addresses
1919 unsigned long syscall_arg__val(struct syscall_arg *arg, u8 idx)
1921 unsigned long val;
1922 unsigned char *p = arg->args + sizeof(unsigned long) * idx;
1924 memcpy(&val, p, sizeof(val));
1925 return val;
1928 static size_t syscall__scnprintf_name(struct syscall *sc, char *bf, size_t size,
1929 struct syscall_arg *arg)
1931 if (sc->arg_fmt && sc->arg_fmt[arg->idx].name)
1932 return scnprintf(bf, size, "%s: ", sc->arg_fmt[arg->idx].name);
1934 return scnprintf(bf, size, "arg%d: ", arg->idx);
1938 * Check if the value is in fact zero, i.e. mask whatever needs masking, such
1939 * as mount 'flags' argument that needs ignoring some magic flag, see comment
1940 * in tools/perf/trace/beauty/mount_flags.c
1942 static unsigned long syscall_arg_fmt__mask_val(struct syscall_arg_fmt *fmt, struct syscall_arg *arg, unsigned long val)
1944 if (fmt && fmt->mask_val)
1945 return fmt->mask_val(arg, val);
1947 return val;
1950 static size_t syscall_arg_fmt__scnprintf_val(struct syscall_arg_fmt *fmt, char *bf, size_t size,
1951 struct syscall_arg *arg, unsigned long val)
1953 if (fmt && fmt->scnprintf) {
1954 arg->val = val;
1955 if (fmt->parm)
1956 arg->parm = fmt->parm;
1957 return fmt->scnprintf(bf, size, arg);
1959 return scnprintf(bf, size, "%ld", val);
1962 static size_t syscall__scnprintf_args(struct syscall *sc, char *bf, size_t size,
1963 unsigned char *args, void *augmented_args, int augmented_args_size,
1964 struct trace *trace, struct thread *thread)
1966 size_t printed = 0;
1967 unsigned long val;
1968 u8 bit = 1;
1969 struct syscall_arg arg = {
1970 .args = args,
1971 .augmented = {
1972 .size = augmented_args_size,
1973 .args = augmented_args,
1975 .idx = 0,
1976 .mask = 0,
1977 .trace = trace,
1978 .thread = thread,
1979 .show_string_prefix = trace->show_string_prefix,
1981 struct thread_trace *ttrace = thread__priv(thread);
1984 * Things like fcntl will set this in its 'cmd' formatter to pick the
1985 * right formatter for the return value (an fd? file flags?), which is
1986 * not needed for syscalls that always return a given type, say an fd.
1988 ttrace->ret_scnprintf = NULL;
1990 if (sc->args != NULL) {
1991 struct tep_format_field *field;
1993 for (field = sc->args; field;
1994 field = field->next, ++arg.idx, bit <<= 1) {
1995 if (arg.mask & bit)
1996 continue;
1998 arg.fmt = &sc->arg_fmt[arg.idx];
1999 val = syscall_arg__val(&arg, arg.idx);
2001 * Some syscall args need some mask, most don't and
2002 * return val untouched.
2004 val = syscall_arg_fmt__mask_val(&sc->arg_fmt[arg.idx], &arg, val);
2007 * Suppress this argument if its value is zero and
2008 * and we don't have a string associated in an
2009 * strarray for it.
2011 if (val == 0 &&
2012 !trace->show_zeros &&
2013 !(sc->arg_fmt &&
2014 (sc->arg_fmt[arg.idx].show_zero ||
2015 sc->arg_fmt[arg.idx].scnprintf == SCA_STRARRAY ||
2016 sc->arg_fmt[arg.idx].scnprintf == SCA_STRARRAYS) &&
2017 sc->arg_fmt[arg.idx].parm))
2018 continue;
2020 printed += scnprintf(bf + printed, size - printed, "%s", printed ? ", " : "");
2022 if (trace->show_arg_names)
2023 printed += scnprintf(bf + printed, size - printed, "%s: ", field->name);
2025 printed += syscall_arg_fmt__scnprintf_val(&sc->arg_fmt[arg.idx],
2026 bf + printed, size - printed, &arg, val);
2028 } else if (IS_ERR(sc->tp_format)) {
2030 * If we managed to read the tracepoint /format file, then we
2031 * may end up not having any args, like with gettid(), so only
2032 * print the raw args when we didn't manage to read it.
2034 while (arg.idx < sc->nr_args) {
2035 if (arg.mask & bit)
2036 goto next_arg;
2037 val = syscall_arg__val(&arg, arg.idx);
2038 if (printed)
2039 printed += scnprintf(bf + printed, size - printed, ", ");
2040 printed += syscall__scnprintf_name(sc, bf + printed, size - printed, &arg);
2041 printed += syscall_arg_fmt__scnprintf_val(&sc->arg_fmt[arg.idx], bf + printed, size - printed, &arg, val);
2042 next_arg:
2043 ++arg.idx;
2044 bit <<= 1;
2048 return printed;
2051 typedef int (*tracepoint_handler)(struct trace *trace, struct evsel *evsel,
2052 union perf_event *event,
2053 struct perf_sample *sample);
2055 static struct syscall *trace__syscall_info(struct trace *trace,
2056 struct evsel *evsel, int id)
2058 int err = 0;
2060 if (id < 0) {
2063 * XXX: Noticed on x86_64, reproduced as far back as 3.0.36, haven't tried
2064 * before that, leaving at a higher verbosity level till that is
2065 * explained. Reproduced with plain ftrace with:
2067 * echo 1 > /t/events/raw_syscalls/sys_exit/enable
2068 * grep "NR -1 " /t/trace_pipe
2070 * After generating some load on the machine.
2072 if (verbose > 1) {
2073 static u64 n;
2074 fprintf(trace->output, "Invalid syscall %d id, skipping (%s, %" PRIu64 ") ...\n",
2075 id, perf_evsel__name(evsel), ++n);
2077 return NULL;
2080 err = -EINVAL;
2082 if (id > trace->sctbl->syscalls.max_id)
2083 goto out_cant_read;
2085 if ((trace->syscalls.table == NULL || trace->syscalls.table[id].name == NULL) &&
2086 (err = trace__read_syscall_info(trace, id)) != 0)
2087 goto out_cant_read;
2089 if (trace->syscalls.table[id].name == NULL) {
2090 if (trace->syscalls.table[id].nonexistent)
2091 return NULL;
2092 goto out_cant_read;
2095 return &trace->syscalls.table[id];
2097 out_cant_read:
2098 if (verbose > 0) {
2099 char sbuf[STRERR_BUFSIZE];
2100 fprintf(trace->output, "Problems reading syscall %d: %d (%s)", id, -err, str_error_r(-err, sbuf, sizeof(sbuf)));
2101 if (id <= trace->sctbl->syscalls.max_id && trace->syscalls.table[id].name != NULL)
2102 fprintf(trace->output, "(%s)", trace->syscalls.table[id].name);
2103 fputs(" information\n", trace->output);
2105 return NULL;
2108 struct syscall_stats {
2109 struct stats stats;
2110 u64 nr_failures;
2111 int max_errno;
2112 u32 *errnos;
2115 static void thread__update_stats(struct thread *thread, struct thread_trace *ttrace,
2116 int id, struct perf_sample *sample, long err, bool errno_summary)
2118 struct int_node *inode;
2119 struct syscall_stats *stats;
2120 u64 duration = 0;
2122 inode = intlist__findnew(ttrace->syscall_stats, id);
2123 if (inode == NULL)
2124 return;
2126 stats = inode->priv;
2127 if (stats == NULL) {
2128 stats = malloc(sizeof(*stats));
2129 if (stats == NULL)
2130 return;
2132 stats->nr_failures = 0;
2133 stats->max_errno = 0;
2134 stats->errnos = NULL;
2135 init_stats(&stats->stats);
2136 inode->priv = stats;
2139 if (ttrace->entry_time && sample->time > ttrace->entry_time)
2140 duration = sample->time - ttrace->entry_time;
2142 update_stats(&stats->stats, duration);
2144 if (err < 0) {
2145 ++stats->nr_failures;
2147 if (!errno_summary)
2148 return;
2150 err = -err;
2151 if (err > stats->max_errno) {
2152 u32 *new_errnos = realloc(stats->errnos, err * sizeof(u32));
2154 if (new_errnos) {
2155 memset(new_errnos + stats->max_errno, 0, (err - stats->max_errno) * sizeof(u32));
2156 } else {
2157 pr_debug("Not enough memory for errno stats for thread \"%s\"(%d/%d), results will be incomplete\n",
2158 thread__comm_str(thread), thread->pid_, thread->tid);
2159 return;
2162 stats->errnos = new_errnos;
2163 stats->max_errno = err;
2166 ++stats->errnos[err - 1];
2170 static int trace__printf_interrupted_entry(struct trace *trace)
2172 struct thread_trace *ttrace;
2173 size_t printed;
2174 int len;
2176 if (trace->failure_only || trace->current == NULL)
2177 return 0;
2179 ttrace = thread__priv(trace->current);
2181 if (!ttrace->entry_pending)
2182 return 0;
2184 printed = trace__fprintf_entry_head(trace, trace->current, 0, false, ttrace->entry_time, trace->output);
2185 printed += len = fprintf(trace->output, "%s)", ttrace->entry_str);
2187 if (len < trace->args_alignment - 4)
2188 printed += fprintf(trace->output, "%-*s", trace->args_alignment - 4 - len, " ");
2190 printed += fprintf(trace->output, " ...\n");
2192 ttrace->entry_pending = false;
2193 ++trace->nr_events_printed;
2195 return printed;
2198 static int trace__fprintf_sample(struct trace *trace, struct evsel *evsel,
2199 struct perf_sample *sample, struct thread *thread)
2201 int printed = 0;
2203 if (trace->print_sample) {
2204 double ts = (double)sample->time / NSEC_PER_MSEC;
2206 printed += fprintf(trace->output, "%22s %10.3f %s %d/%d [%d]\n",
2207 perf_evsel__name(evsel), ts,
2208 thread__comm_str(thread),
2209 sample->pid, sample->tid, sample->cpu);
2212 return printed;
2215 static void *syscall__augmented_args(struct syscall *sc, struct perf_sample *sample, int *augmented_args_size, int raw_augmented_args_size)
2217 void *augmented_args = NULL;
2219 * For now with BPF raw_augmented we hook into raw_syscalls:sys_enter
2220 * and there we get all 6 syscall args plus the tracepoint common fields
2221 * that gets calculated at the start and the syscall_nr (another long).
2222 * So we check if that is the case and if so don't look after the
2223 * sc->args_size but always after the full raw_syscalls:sys_enter payload,
2224 * which is fixed.
2226 * We'll revisit this later to pass s->args_size to the BPF augmenter
2227 * (now tools/perf/examples/bpf/augmented_raw_syscalls.c, so that it
2228 * copies only what we need for each syscall, like what happens when we
2229 * use syscalls:sys_enter_NAME, so that we reduce the kernel/userspace
2230 * traffic to just what is needed for each syscall.
2232 int args_size = raw_augmented_args_size ?: sc->args_size;
2234 *augmented_args_size = sample->raw_size - args_size;
2235 if (*augmented_args_size > 0)
2236 augmented_args = sample->raw_data + args_size;
2238 return augmented_args;
2241 static int trace__sys_enter(struct trace *trace, struct evsel *evsel,
2242 union perf_event *event __maybe_unused,
2243 struct perf_sample *sample)
2245 char *msg;
2246 void *args;
2247 int printed = 0;
2248 struct thread *thread;
2249 int id = perf_evsel__sc_tp_uint(evsel, id, sample), err = -1;
2250 int augmented_args_size = 0;
2251 void *augmented_args = NULL;
2252 struct syscall *sc = trace__syscall_info(trace, evsel, id);
2253 struct thread_trace *ttrace;
2255 if (sc == NULL)
2256 return -1;
2258 thread = machine__findnew_thread(trace->host, sample->pid, sample->tid);
2259 ttrace = thread__trace(thread, trace->output);
2260 if (ttrace == NULL)
2261 goto out_put;
2263 trace__fprintf_sample(trace, evsel, sample, thread);
2265 args = perf_evsel__sc_tp_ptr(evsel, args, sample);
2267 if (ttrace->entry_str == NULL) {
2268 ttrace->entry_str = malloc(trace__entry_str_size);
2269 if (!ttrace->entry_str)
2270 goto out_put;
2273 if (!(trace->duration_filter || trace->summary_only || trace->min_stack))
2274 trace__printf_interrupted_entry(trace);
2276 * If this is raw_syscalls.sys_enter, then it always comes with the 6 possible
2277 * arguments, even if the syscall being handled, say "openat", uses only 4 arguments
2278 * this breaks syscall__augmented_args() check for augmented args, as we calculate
2279 * syscall->args_size using each syscalls:sys_enter_NAME tracefs format file,
2280 * so when handling, say the openat syscall, we end up getting 6 args for the
2281 * raw_syscalls:sys_enter event, when we expected just 4, we end up mistakenly
2282 * thinking that the extra 2 u64 args are the augmented filename, so just check
2283 * here and avoid using augmented syscalls when the evsel is the raw_syscalls one.
2285 if (evsel != trace->syscalls.events.sys_enter)
2286 augmented_args = syscall__augmented_args(sc, sample, &augmented_args_size, trace->raw_augmented_syscalls_args_size);
2287 ttrace->entry_time = sample->time;
2288 msg = ttrace->entry_str;
2289 printed += scnprintf(msg + printed, trace__entry_str_size - printed, "%s(", sc->name);
2291 printed += syscall__scnprintf_args(sc, msg + printed, trace__entry_str_size - printed,
2292 args, augmented_args, augmented_args_size, trace, thread);
2294 if (sc->is_exit) {
2295 if (!(trace->duration_filter || trace->summary_only || trace->failure_only || trace->min_stack)) {
2296 int alignment = 0;
2298 trace__fprintf_entry_head(trace, thread, 0, false, ttrace->entry_time, trace->output);
2299 printed = fprintf(trace->output, "%s)", ttrace->entry_str);
2300 if (trace->args_alignment > printed)
2301 alignment = trace->args_alignment - printed;
2302 fprintf(trace->output, "%*s= ?\n", alignment, " ");
2304 } else {
2305 ttrace->entry_pending = true;
2306 /* See trace__vfs_getname & trace__sys_exit */
2307 ttrace->filename.pending_open = false;
2310 if (trace->current != thread) {
2311 thread__put(trace->current);
2312 trace->current = thread__get(thread);
2314 err = 0;
2315 out_put:
2316 thread__put(thread);
2317 return err;
2320 static int trace__fprintf_sys_enter(struct trace *trace, struct evsel *evsel,
2321 struct perf_sample *sample)
2323 struct thread_trace *ttrace;
2324 struct thread *thread;
2325 int id = perf_evsel__sc_tp_uint(evsel, id, sample), err = -1;
2326 struct syscall *sc = trace__syscall_info(trace, evsel, id);
2327 char msg[1024];
2328 void *args, *augmented_args = NULL;
2329 int augmented_args_size;
2331 if (sc == NULL)
2332 return -1;
2334 thread = machine__findnew_thread(trace->host, sample->pid, sample->tid);
2335 ttrace = thread__trace(thread, trace->output);
2337 * We need to get ttrace just to make sure it is there when syscall__scnprintf_args()
2338 * and the rest of the beautifiers accessing it via struct syscall_arg touches it.
2340 if (ttrace == NULL)
2341 goto out_put;
2343 args = perf_evsel__sc_tp_ptr(evsel, args, sample);
2344 augmented_args = syscall__augmented_args(sc, sample, &augmented_args_size, trace->raw_augmented_syscalls_args_size);
2345 syscall__scnprintf_args(sc, msg, sizeof(msg), args, augmented_args, augmented_args_size, trace, thread);
2346 fprintf(trace->output, "%s", msg);
2347 err = 0;
2348 out_put:
2349 thread__put(thread);
2350 return err;
2353 static int trace__resolve_callchain(struct trace *trace, struct evsel *evsel,
2354 struct perf_sample *sample,
2355 struct callchain_cursor *cursor)
2357 struct addr_location al;
2358 int max_stack = evsel->core.attr.sample_max_stack ?
2359 evsel->core.attr.sample_max_stack :
2360 trace->max_stack;
2361 int err;
2363 if (machine__resolve(trace->host, &al, sample) < 0)
2364 return -1;
2366 err = thread__resolve_callchain(al.thread, cursor, evsel, sample, NULL, NULL, max_stack);
2367 addr_location__put(&al);
2368 return err;
2371 static int trace__fprintf_callchain(struct trace *trace, struct perf_sample *sample)
2373 /* TODO: user-configurable print_opts */
2374 const unsigned int print_opts = EVSEL__PRINT_SYM |
2375 EVSEL__PRINT_DSO |
2376 EVSEL__PRINT_UNKNOWN_AS_ADDR;
2378 return sample__fprintf_callchain(sample, 38, print_opts, &callchain_cursor, symbol_conf.bt_stop_list, trace->output);
2381 static const char *errno_to_name(struct evsel *evsel, int err)
2383 struct perf_env *env = perf_evsel__env(evsel);
2384 const char *arch_name = perf_env__arch(env);
2386 return arch_syscalls__strerrno(arch_name, err);
2389 static int trace__sys_exit(struct trace *trace, struct evsel *evsel,
2390 union perf_event *event __maybe_unused,
2391 struct perf_sample *sample)
2393 long ret;
2394 u64 duration = 0;
2395 bool duration_calculated = false;
2396 struct thread *thread;
2397 int id = perf_evsel__sc_tp_uint(evsel, id, sample), err = -1, callchain_ret = 0, printed = 0;
2398 int alignment = trace->args_alignment;
2399 struct syscall *sc = trace__syscall_info(trace, evsel, id);
2400 struct thread_trace *ttrace;
2402 if (sc == NULL)
2403 return -1;
2405 thread = machine__findnew_thread(trace->host, sample->pid, sample->tid);
2406 ttrace = thread__trace(thread, trace->output);
2407 if (ttrace == NULL)
2408 goto out_put;
2410 trace__fprintf_sample(trace, evsel, sample, thread);
2412 ret = perf_evsel__sc_tp_uint(evsel, ret, sample);
2414 if (trace->summary)
2415 thread__update_stats(thread, ttrace, id, sample, ret, trace->errno_summary);
2417 if (!trace->fd_path_disabled && sc->is_open && ret >= 0 && ttrace->filename.pending_open) {
2418 trace__set_fd_pathname(thread, ret, ttrace->filename.name);
2419 ttrace->filename.pending_open = false;
2420 ++trace->stats.vfs_getname;
2423 if (ttrace->entry_time) {
2424 duration = sample->time - ttrace->entry_time;
2425 if (trace__filter_duration(trace, duration))
2426 goto out;
2427 duration_calculated = true;
2428 } else if (trace->duration_filter)
2429 goto out;
2431 if (sample->callchain) {
2432 callchain_ret = trace__resolve_callchain(trace, evsel, sample, &callchain_cursor);
2433 if (callchain_ret == 0) {
2434 if (callchain_cursor.nr < trace->min_stack)
2435 goto out;
2436 callchain_ret = 1;
2440 if (trace->summary_only || (ret >= 0 && trace->failure_only))
2441 goto out;
2443 trace__fprintf_entry_head(trace, thread, duration, duration_calculated, ttrace->entry_time, trace->output);
2445 if (ttrace->entry_pending) {
2446 printed = fprintf(trace->output, "%s", ttrace->entry_str);
2447 } else {
2448 printed += fprintf(trace->output, " ... [");
2449 color_fprintf(trace->output, PERF_COLOR_YELLOW, "continued");
2450 printed += 9;
2451 printed += fprintf(trace->output, "]: %s()", sc->name);
2454 printed++; /* the closing ')' */
2456 if (alignment > printed)
2457 alignment -= printed;
2458 else
2459 alignment = 0;
2461 fprintf(trace->output, ")%*s= ", alignment, " ");
2463 if (sc->fmt == NULL) {
2464 if (ret < 0)
2465 goto errno_print;
2466 signed_print:
2467 fprintf(trace->output, "%ld", ret);
2468 } else if (ret < 0) {
2469 errno_print: {
2470 char bf[STRERR_BUFSIZE];
2471 const char *emsg = str_error_r(-ret, bf, sizeof(bf)),
2472 *e = errno_to_name(evsel, -ret);
2474 fprintf(trace->output, "-1 %s (%s)", e, emsg);
2476 } else if (ret == 0 && sc->fmt->timeout)
2477 fprintf(trace->output, "0 (Timeout)");
2478 else if (ttrace->ret_scnprintf) {
2479 char bf[1024];
2480 struct syscall_arg arg = {
2481 .val = ret,
2482 .thread = thread,
2483 .trace = trace,
2485 ttrace->ret_scnprintf(bf, sizeof(bf), &arg);
2486 ttrace->ret_scnprintf = NULL;
2487 fprintf(trace->output, "%s", bf);
2488 } else if (sc->fmt->hexret)
2489 fprintf(trace->output, "%#lx", ret);
2490 else if (sc->fmt->errpid) {
2491 struct thread *child = machine__find_thread(trace->host, ret, ret);
2493 if (child != NULL) {
2494 fprintf(trace->output, "%ld", ret);
2495 if (child->comm_set)
2496 fprintf(trace->output, " (%s)", thread__comm_str(child));
2497 thread__put(child);
2499 } else
2500 goto signed_print;
2502 fputc('\n', trace->output);
2505 * We only consider an 'event' for the sake of --max-events a non-filtered
2506 * sys_enter + sys_exit and other tracepoint events.
2508 if (++trace->nr_events_printed == trace->max_events && trace->max_events != ULONG_MAX)
2509 interrupted = true;
2511 if (callchain_ret > 0)
2512 trace__fprintf_callchain(trace, sample);
2513 else if (callchain_ret < 0)
2514 pr_err("Problem processing %s callchain, skipping...\n", perf_evsel__name(evsel));
2515 out:
2516 ttrace->entry_pending = false;
2517 err = 0;
2518 out_put:
2519 thread__put(thread);
2520 return err;
2523 static int trace__vfs_getname(struct trace *trace, struct evsel *evsel,
2524 union perf_event *event __maybe_unused,
2525 struct perf_sample *sample)
2527 struct thread *thread = machine__findnew_thread(trace->host, sample->pid, sample->tid);
2528 struct thread_trace *ttrace;
2529 size_t filename_len, entry_str_len, to_move;
2530 ssize_t remaining_space;
2531 char *pos;
2532 const char *filename = perf_evsel__rawptr(evsel, sample, "pathname");
2534 if (!thread)
2535 goto out;
2537 ttrace = thread__priv(thread);
2538 if (!ttrace)
2539 goto out_put;
2541 filename_len = strlen(filename);
2542 if (filename_len == 0)
2543 goto out_put;
2545 if (ttrace->filename.namelen < filename_len) {
2546 char *f = realloc(ttrace->filename.name, filename_len + 1);
2548 if (f == NULL)
2549 goto out_put;
2551 ttrace->filename.namelen = filename_len;
2552 ttrace->filename.name = f;
2555 strcpy(ttrace->filename.name, filename);
2556 ttrace->filename.pending_open = true;
2558 if (!ttrace->filename.ptr)
2559 goto out_put;
2561 entry_str_len = strlen(ttrace->entry_str);
2562 remaining_space = trace__entry_str_size - entry_str_len - 1; /* \0 */
2563 if (remaining_space <= 0)
2564 goto out_put;
2566 if (filename_len > (size_t)remaining_space) {
2567 filename += filename_len - remaining_space;
2568 filename_len = remaining_space;
2571 to_move = entry_str_len - ttrace->filename.entry_str_pos + 1; /* \0 */
2572 pos = ttrace->entry_str + ttrace->filename.entry_str_pos;
2573 memmove(pos + filename_len, pos, to_move);
2574 memcpy(pos, filename, filename_len);
2576 ttrace->filename.ptr = 0;
2577 ttrace->filename.entry_str_pos = 0;
2578 out_put:
2579 thread__put(thread);
2580 out:
2581 return 0;
2584 static int trace__sched_stat_runtime(struct trace *trace, struct evsel *evsel,
2585 union perf_event *event __maybe_unused,
2586 struct perf_sample *sample)
2588 u64 runtime = perf_evsel__intval(evsel, sample, "runtime");
2589 double runtime_ms = (double)runtime / NSEC_PER_MSEC;
2590 struct thread *thread = machine__findnew_thread(trace->host,
2591 sample->pid,
2592 sample->tid);
2593 struct thread_trace *ttrace = thread__trace(thread, trace->output);
2595 if (ttrace == NULL)
2596 goto out_dump;
2598 ttrace->runtime_ms += runtime_ms;
2599 trace->runtime_ms += runtime_ms;
2600 out_put:
2601 thread__put(thread);
2602 return 0;
2604 out_dump:
2605 fprintf(trace->output, "%s: comm=%s,pid=%u,runtime=%" PRIu64 ",vruntime=%" PRIu64 ")\n",
2606 evsel->name,
2607 perf_evsel__strval(evsel, sample, "comm"),
2608 (pid_t)perf_evsel__intval(evsel, sample, "pid"),
2609 runtime,
2610 perf_evsel__intval(evsel, sample, "vruntime"));
2611 goto out_put;
2614 static int bpf_output__printer(enum binary_printer_ops op,
2615 unsigned int val, void *extra __maybe_unused, FILE *fp)
2617 unsigned char ch = (unsigned char)val;
2619 switch (op) {
2620 case BINARY_PRINT_CHAR_DATA:
2621 return fprintf(fp, "%c", isprint(ch) ? ch : '.');
2622 case BINARY_PRINT_DATA_BEGIN:
2623 case BINARY_PRINT_LINE_BEGIN:
2624 case BINARY_PRINT_ADDR:
2625 case BINARY_PRINT_NUM_DATA:
2626 case BINARY_PRINT_NUM_PAD:
2627 case BINARY_PRINT_SEP:
2628 case BINARY_PRINT_CHAR_PAD:
2629 case BINARY_PRINT_LINE_END:
2630 case BINARY_PRINT_DATA_END:
2631 default:
2632 break;
2635 return 0;
2638 static void bpf_output__fprintf(struct trace *trace,
2639 struct perf_sample *sample)
2641 binary__fprintf(sample->raw_data, sample->raw_size, 8,
2642 bpf_output__printer, NULL, trace->output);
2643 ++trace->nr_events_printed;
2646 static size_t trace__fprintf_tp_fields(struct trace *trace, struct evsel *evsel, struct perf_sample *sample,
2647 struct thread *thread, void *augmented_args, int augmented_args_size)
2649 char bf[2048];
2650 size_t size = sizeof(bf);
2651 struct tep_format_field *field = evsel->tp_format->format.fields;
2652 struct syscall_arg_fmt *arg = __evsel__syscall_arg_fmt(evsel);
2653 size_t printed = 0;
2654 unsigned long val;
2655 u8 bit = 1;
2656 struct syscall_arg syscall_arg = {
2657 .augmented = {
2658 .size = augmented_args_size,
2659 .args = augmented_args,
2661 .idx = 0,
2662 .mask = 0,
2663 .trace = trace,
2664 .thread = thread,
2665 .show_string_prefix = trace->show_string_prefix,
2668 for (; field && arg; field = field->next, ++syscall_arg.idx, bit <<= 1, ++arg) {
2669 if (syscall_arg.mask & bit)
2670 continue;
2672 syscall_arg.len = 0;
2673 syscall_arg.fmt = arg;
2674 if (field->flags & TEP_FIELD_IS_ARRAY) {
2675 int offset = field->offset;
2677 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
2678 offset = format_field__intval(field, sample, evsel->needs_swap);
2679 syscall_arg.len = offset >> 16;
2680 offset &= 0xffff;
2683 val = (uintptr_t)(sample->raw_data + offset);
2684 } else
2685 val = format_field__intval(field, sample, evsel->needs_swap);
2687 * Some syscall args need some mask, most don't and
2688 * return val untouched.
2690 val = syscall_arg_fmt__mask_val(arg, &syscall_arg, val);
2693 * Suppress this argument if its value is zero and
2694 * and we don't have a string associated in an
2695 * strarray for it.
2697 if (val == 0 &&
2698 !trace->show_zeros &&
2699 !((arg->show_zero ||
2700 arg->scnprintf == SCA_STRARRAY ||
2701 arg->scnprintf == SCA_STRARRAYS) &&
2702 arg->parm))
2703 continue;
2705 printed += scnprintf(bf + printed, size - printed, "%s", printed ? ", " : "");
2708 * XXX Perhaps we should have a show_tp_arg_names,
2709 * leaving show_arg_names just for syscalls?
2711 if (1 || trace->show_arg_names)
2712 printed += scnprintf(bf + printed, size - printed, "%s: ", field->name);
2714 printed += syscall_arg_fmt__scnprintf_val(arg, bf + printed, size - printed, &syscall_arg, val);
2717 return printed + fprintf(trace->output, "%s", bf);
2720 static int trace__event_handler(struct trace *trace, struct evsel *evsel,
2721 union perf_event *event __maybe_unused,
2722 struct perf_sample *sample)
2724 struct thread *thread;
2725 int callchain_ret = 0;
2727 * Check if we called perf_evsel__disable(evsel) due to, for instance,
2728 * this event's max_events having been hit and this is an entry coming
2729 * from the ring buffer that we should discard, since the max events
2730 * have already been considered/printed.
2732 if (evsel->disabled)
2733 return 0;
2735 thread = machine__findnew_thread(trace->host, sample->pid, sample->tid);
2737 if (sample->callchain) {
2738 callchain_ret = trace__resolve_callchain(trace, evsel, sample, &callchain_cursor);
2739 if (callchain_ret == 0) {
2740 if (callchain_cursor.nr < trace->min_stack)
2741 goto out;
2742 callchain_ret = 1;
2746 trace__printf_interrupted_entry(trace);
2747 trace__fprintf_tstamp(trace, sample->time, trace->output);
2749 if (trace->trace_syscalls && trace->show_duration)
2750 fprintf(trace->output, "( ): ");
2752 if (thread)
2753 trace__fprintf_comm_tid(trace, thread, trace->output);
2755 if (evsel == trace->syscalls.events.augmented) {
2756 int id = perf_evsel__sc_tp_uint(evsel, id, sample);
2757 struct syscall *sc = trace__syscall_info(trace, evsel, id);
2759 if (sc) {
2760 fprintf(trace->output, "%s(", sc->name);
2761 trace__fprintf_sys_enter(trace, evsel, sample);
2762 fputc(')', trace->output);
2763 goto newline;
2767 * XXX: Not having the associated syscall info or not finding/adding
2768 * the thread should never happen, but if it does...
2769 * fall thru and print it as a bpf_output event.
2773 fprintf(trace->output, "%s(", evsel->name);
2775 if (perf_evsel__is_bpf_output(evsel)) {
2776 bpf_output__fprintf(trace, sample);
2777 } else if (evsel->tp_format) {
2778 if (strncmp(evsel->tp_format->name, "sys_enter_", 10) ||
2779 trace__fprintf_sys_enter(trace, evsel, sample)) {
2780 if (trace->libtraceevent_print) {
2781 event_format__fprintf(evsel->tp_format, sample->cpu,
2782 sample->raw_data, sample->raw_size,
2783 trace->output);
2784 } else {
2785 trace__fprintf_tp_fields(trace, evsel, sample, thread, NULL, 0);
2790 newline:
2791 fprintf(trace->output, ")\n");
2793 if (callchain_ret > 0)
2794 trace__fprintf_callchain(trace, sample);
2795 else if (callchain_ret < 0)
2796 pr_err("Problem processing %s callchain, skipping...\n", perf_evsel__name(evsel));
2798 ++trace->nr_events_printed;
2800 if (evsel->max_events != ULONG_MAX && ++evsel->nr_events_printed == evsel->max_events) {
2801 evsel__disable(evsel);
2802 evsel__close(evsel);
2804 out:
2805 thread__put(thread);
2806 return 0;
2809 static void print_location(FILE *f, struct perf_sample *sample,
2810 struct addr_location *al,
2811 bool print_dso, bool print_sym)
2814 if ((verbose > 0 || print_dso) && al->map)
2815 fprintf(f, "%s@", al->map->dso->long_name);
2817 if ((verbose > 0 || print_sym) && al->sym)
2818 fprintf(f, "%s+0x%" PRIx64, al->sym->name,
2819 al->addr - al->sym->start);
2820 else if (al->map)
2821 fprintf(f, "0x%" PRIx64, al->addr);
2822 else
2823 fprintf(f, "0x%" PRIx64, sample->addr);
2826 static int trace__pgfault(struct trace *trace,
2827 struct evsel *evsel,
2828 union perf_event *event __maybe_unused,
2829 struct perf_sample *sample)
2831 struct thread *thread;
2832 struct addr_location al;
2833 char map_type = 'd';
2834 struct thread_trace *ttrace;
2835 int err = -1;
2836 int callchain_ret = 0;
2838 thread = machine__findnew_thread(trace->host, sample->pid, sample->tid);
2840 if (sample->callchain) {
2841 callchain_ret = trace__resolve_callchain(trace, evsel, sample, &callchain_cursor);
2842 if (callchain_ret == 0) {
2843 if (callchain_cursor.nr < trace->min_stack)
2844 goto out_put;
2845 callchain_ret = 1;
2849 ttrace = thread__trace(thread, trace->output);
2850 if (ttrace == NULL)
2851 goto out_put;
2853 if (evsel->core.attr.config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)
2854 ttrace->pfmaj++;
2855 else
2856 ttrace->pfmin++;
2858 if (trace->summary_only)
2859 goto out;
2861 thread__find_symbol(thread, sample->cpumode, sample->ip, &al);
2863 trace__fprintf_entry_head(trace, thread, 0, true, sample->time, trace->output);
2865 fprintf(trace->output, "%sfault [",
2866 evsel->core.attr.config == PERF_COUNT_SW_PAGE_FAULTS_MAJ ?
2867 "maj" : "min");
2869 print_location(trace->output, sample, &al, false, true);
2871 fprintf(trace->output, "] => ");
2873 thread__find_symbol(thread, sample->cpumode, sample->addr, &al);
2875 if (!al.map) {
2876 thread__find_symbol(thread, sample->cpumode, sample->addr, &al);
2878 if (al.map)
2879 map_type = 'x';
2880 else
2881 map_type = '?';
2884 print_location(trace->output, sample, &al, true, false);
2886 fprintf(trace->output, " (%c%c)\n", map_type, al.level);
2888 if (callchain_ret > 0)
2889 trace__fprintf_callchain(trace, sample);
2890 else if (callchain_ret < 0)
2891 pr_err("Problem processing %s callchain, skipping...\n", perf_evsel__name(evsel));
2893 ++trace->nr_events_printed;
2894 out:
2895 err = 0;
2896 out_put:
2897 thread__put(thread);
2898 return err;
2901 static void trace__set_base_time(struct trace *trace,
2902 struct evsel *evsel,
2903 struct perf_sample *sample)
2906 * BPF events were not setting PERF_SAMPLE_TIME, so be more robust
2907 * and don't use sample->time unconditionally, we may end up having
2908 * some other event in the future without PERF_SAMPLE_TIME for good
2909 * reason, i.e. we may not be interested in its timestamps, just in
2910 * it taking place, picking some piece of information when it
2911 * appears in our event stream (vfs_getname comes to mind).
2913 if (trace->base_time == 0 && !trace->full_time &&
2914 (evsel->core.attr.sample_type & PERF_SAMPLE_TIME))
2915 trace->base_time = sample->time;
2918 static int trace__process_sample(struct perf_tool *tool,
2919 union perf_event *event,
2920 struct perf_sample *sample,
2921 struct evsel *evsel,
2922 struct machine *machine __maybe_unused)
2924 struct trace *trace = container_of(tool, struct trace, tool);
2925 struct thread *thread;
2926 int err = 0;
2928 tracepoint_handler handler = evsel->handler;
2930 thread = machine__findnew_thread(trace->host, sample->pid, sample->tid);
2931 if (thread && thread__is_filtered(thread))
2932 goto out;
2934 trace__set_base_time(trace, evsel, sample);
2936 if (handler) {
2937 ++trace->nr_events;
2938 handler(trace, evsel, event, sample);
2940 out:
2941 thread__put(thread);
2942 return err;
2945 static int trace__record(struct trace *trace, int argc, const char **argv)
2947 unsigned int rec_argc, i, j;
2948 const char **rec_argv;
2949 const char * const record_args[] = {
2950 "record",
2951 "-R",
2952 "-m", "1024",
2953 "-c", "1",
2955 pid_t pid = getpid();
2956 char *filter = asprintf__tp_filter_pids(1, &pid);
2957 const char * const sc_args[] = { "-e", };
2958 unsigned int sc_args_nr = ARRAY_SIZE(sc_args);
2959 const char * const majpf_args[] = { "-e", "major-faults" };
2960 unsigned int majpf_args_nr = ARRAY_SIZE(majpf_args);
2961 const char * const minpf_args[] = { "-e", "minor-faults" };
2962 unsigned int minpf_args_nr = ARRAY_SIZE(minpf_args);
2963 int err = -1;
2965 /* +3 is for the event string below and the pid filter */
2966 rec_argc = ARRAY_SIZE(record_args) + sc_args_nr + 3 +
2967 majpf_args_nr + minpf_args_nr + argc;
2968 rec_argv = calloc(rec_argc + 1, sizeof(char *));
2970 if (rec_argv == NULL || filter == NULL)
2971 goto out_free;
2973 j = 0;
2974 for (i = 0; i < ARRAY_SIZE(record_args); i++)
2975 rec_argv[j++] = record_args[i];
2977 if (trace->trace_syscalls) {
2978 for (i = 0; i < sc_args_nr; i++)
2979 rec_argv[j++] = sc_args[i];
2981 /* event string may be different for older kernels - e.g., RHEL6 */
2982 if (is_valid_tracepoint("raw_syscalls:sys_enter"))
2983 rec_argv[j++] = "raw_syscalls:sys_enter,raw_syscalls:sys_exit";
2984 else if (is_valid_tracepoint("syscalls:sys_enter"))
2985 rec_argv[j++] = "syscalls:sys_enter,syscalls:sys_exit";
2986 else {
2987 pr_err("Neither raw_syscalls nor syscalls events exist.\n");
2988 goto out_free;
2992 rec_argv[j++] = "--filter";
2993 rec_argv[j++] = filter;
2995 if (trace->trace_pgfaults & TRACE_PFMAJ)
2996 for (i = 0; i < majpf_args_nr; i++)
2997 rec_argv[j++] = majpf_args[i];
2999 if (trace->trace_pgfaults & TRACE_PFMIN)
3000 for (i = 0; i < minpf_args_nr; i++)
3001 rec_argv[j++] = minpf_args[i];
3003 for (i = 0; i < (unsigned int)argc; i++)
3004 rec_argv[j++] = argv[i];
3006 err = cmd_record(j, rec_argv);
3007 out_free:
3008 free(filter);
3009 free(rec_argv);
3010 return err;
3013 static size_t trace__fprintf_thread_summary(struct trace *trace, FILE *fp);
3015 static bool evlist__add_vfs_getname(struct evlist *evlist)
3017 bool found = false;
3018 struct evsel *evsel, *tmp;
3019 struct parse_events_error err;
3020 int ret;
3022 bzero(&err, sizeof(err));
3023 ret = parse_events(evlist, "probe:vfs_getname*", &err);
3024 if (ret) {
3025 free(err.str);
3026 free(err.help);
3027 free(err.first_str);
3028 free(err.first_help);
3029 return false;
3032 evlist__for_each_entry_safe(evlist, evsel, tmp) {
3033 if (!strstarts(perf_evsel__name(evsel), "probe:vfs_getname"))
3034 continue;
3036 if (perf_evsel__field(evsel, "pathname")) {
3037 evsel->handler = trace__vfs_getname;
3038 found = true;
3039 continue;
3042 list_del_init(&evsel->core.node);
3043 evsel->evlist = NULL;
3044 evsel__delete(evsel);
3047 return found;
3050 static struct evsel *perf_evsel__new_pgfault(u64 config)
3052 struct evsel *evsel;
3053 struct perf_event_attr attr = {
3054 .type = PERF_TYPE_SOFTWARE,
3055 .mmap_data = 1,
3058 attr.config = config;
3059 attr.sample_period = 1;
3061 event_attr_init(&attr);
3063 evsel = evsel__new(&attr);
3064 if (evsel)
3065 evsel->handler = trace__pgfault;
3067 return evsel;
3070 static void trace__handle_event(struct trace *trace, union perf_event *event, struct perf_sample *sample)
3072 const u32 type = event->header.type;
3073 struct evsel *evsel;
3075 if (type != PERF_RECORD_SAMPLE) {
3076 trace__process_event(trace, trace->host, event, sample);
3077 return;
3080 evsel = perf_evlist__id2evsel(trace->evlist, sample->id);
3081 if (evsel == NULL) {
3082 fprintf(trace->output, "Unknown tp ID %" PRIu64 ", skipping...\n", sample->id);
3083 return;
3086 if (evswitch__discard(&trace->evswitch, evsel))
3087 return;
3089 trace__set_base_time(trace, evsel, sample);
3091 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT &&
3092 sample->raw_data == NULL) {
3093 fprintf(trace->output, "%s sample with no payload for tid: %d, cpu %d, raw_size=%d, skipping...\n",
3094 perf_evsel__name(evsel), sample->tid,
3095 sample->cpu, sample->raw_size);
3096 } else {
3097 tracepoint_handler handler = evsel->handler;
3098 handler(trace, evsel, event, sample);
3101 if (trace->nr_events_printed >= trace->max_events && trace->max_events != ULONG_MAX)
3102 interrupted = true;
3105 static int trace__add_syscall_newtp(struct trace *trace)
3107 int ret = -1;
3108 struct evlist *evlist = trace->evlist;
3109 struct evsel *sys_enter, *sys_exit;
3111 sys_enter = perf_evsel__raw_syscall_newtp("sys_enter", trace__sys_enter);
3112 if (sys_enter == NULL)
3113 goto out;
3115 if (perf_evsel__init_sc_tp_ptr_field(sys_enter, args))
3116 goto out_delete_sys_enter;
3118 sys_exit = perf_evsel__raw_syscall_newtp("sys_exit", trace__sys_exit);
3119 if (sys_exit == NULL)
3120 goto out_delete_sys_enter;
3122 if (perf_evsel__init_sc_tp_uint_field(sys_exit, ret))
3123 goto out_delete_sys_exit;
3125 perf_evsel__config_callchain(sys_enter, &trace->opts, &callchain_param);
3126 perf_evsel__config_callchain(sys_exit, &trace->opts, &callchain_param);
3128 evlist__add(evlist, sys_enter);
3129 evlist__add(evlist, sys_exit);
3131 if (callchain_param.enabled && !trace->kernel_syscallchains) {
3133 * We're interested only in the user space callchain
3134 * leading to the syscall, allow overriding that for
3135 * debugging reasons using --kernel_syscall_callchains
3137 sys_exit->core.attr.exclude_callchain_kernel = 1;
3140 trace->syscalls.events.sys_enter = sys_enter;
3141 trace->syscalls.events.sys_exit = sys_exit;
3143 ret = 0;
3144 out:
3145 return ret;
3147 out_delete_sys_exit:
3148 evsel__delete_priv(sys_exit);
3149 out_delete_sys_enter:
3150 evsel__delete_priv(sys_enter);
3151 goto out;
3154 static int trace__set_ev_qualifier_tp_filter(struct trace *trace)
3156 int err = -1;
3157 struct evsel *sys_exit;
3158 char *filter = asprintf_expr_inout_ints("id", !trace->not_ev_qualifier,
3159 trace->ev_qualifier_ids.nr,
3160 trace->ev_qualifier_ids.entries);
3162 if (filter == NULL)
3163 goto out_enomem;
3165 if (!perf_evsel__append_tp_filter(trace->syscalls.events.sys_enter,
3166 filter)) {
3167 sys_exit = trace->syscalls.events.sys_exit;
3168 err = perf_evsel__append_tp_filter(sys_exit, filter);
3171 free(filter);
3172 out:
3173 return err;
3174 out_enomem:
3175 errno = ENOMEM;
3176 goto out;
3179 #ifdef HAVE_LIBBPF_SUPPORT
3180 static struct bpf_program *trace__find_bpf_program_by_title(struct trace *trace, const char *name)
3182 if (trace->bpf_obj == NULL)
3183 return NULL;
3185 return bpf_object__find_program_by_title(trace->bpf_obj, name);
3188 static struct bpf_program *trace__find_syscall_bpf_prog(struct trace *trace, struct syscall *sc,
3189 const char *prog_name, const char *type)
3191 struct bpf_program *prog;
3193 if (prog_name == NULL) {
3194 char default_prog_name[256];
3195 scnprintf(default_prog_name, sizeof(default_prog_name), "!syscalls:sys_%s_%s", type, sc->name);
3196 prog = trace__find_bpf_program_by_title(trace, default_prog_name);
3197 if (prog != NULL)
3198 goto out_found;
3199 if (sc->fmt && sc->fmt->alias) {
3200 scnprintf(default_prog_name, sizeof(default_prog_name), "!syscalls:sys_%s_%s", type, sc->fmt->alias);
3201 prog = trace__find_bpf_program_by_title(trace, default_prog_name);
3202 if (prog != NULL)
3203 goto out_found;
3205 goto out_unaugmented;
3208 prog = trace__find_bpf_program_by_title(trace, prog_name);
3210 if (prog != NULL) {
3211 out_found:
3212 return prog;
3215 pr_debug("Couldn't find BPF prog \"%s\" to associate with syscalls:sys_%s_%s, not augmenting it\n",
3216 prog_name, type, sc->name);
3217 out_unaugmented:
3218 return trace->syscalls.unaugmented_prog;
3221 static void trace__init_syscall_bpf_progs(struct trace *trace, int id)
3223 struct syscall *sc = trace__syscall_info(trace, NULL, id);
3225 if (sc == NULL)
3226 return;
3228 sc->bpf_prog.sys_enter = trace__find_syscall_bpf_prog(trace, sc, sc->fmt ? sc->fmt->bpf_prog_name.sys_enter : NULL, "enter");
3229 sc->bpf_prog.sys_exit = trace__find_syscall_bpf_prog(trace, sc, sc->fmt ? sc->fmt->bpf_prog_name.sys_exit : NULL, "exit");
3232 static int trace__bpf_prog_sys_enter_fd(struct trace *trace, int id)
3234 struct syscall *sc = trace__syscall_info(trace, NULL, id);
3235 return sc ? bpf_program__fd(sc->bpf_prog.sys_enter) : bpf_program__fd(trace->syscalls.unaugmented_prog);
3238 static int trace__bpf_prog_sys_exit_fd(struct trace *trace, int id)
3240 struct syscall *sc = trace__syscall_info(trace, NULL, id);
3241 return sc ? bpf_program__fd(sc->bpf_prog.sys_exit) : bpf_program__fd(trace->syscalls.unaugmented_prog);
3244 static void trace__init_bpf_map_syscall_args(struct trace *trace, int id, struct bpf_map_syscall_entry *entry)
3246 struct syscall *sc = trace__syscall_info(trace, NULL, id);
3247 int arg = 0;
3249 if (sc == NULL)
3250 goto out;
3252 for (; arg < sc->nr_args; ++arg) {
3253 entry->string_args_len[arg] = 0;
3254 if (sc->arg_fmt[arg].scnprintf == SCA_FILENAME) {
3255 /* Should be set like strace -s strsize */
3256 entry->string_args_len[arg] = PATH_MAX;
3259 out:
3260 for (; arg < 6; ++arg)
3261 entry->string_args_len[arg] = 0;
3263 static int trace__set_ev_qualifier_bpf_filter(struct trace *trace)
3265 int fd = bpf_map__fd(trace->syscalls.map);
3266 struct bpf_map_syscall_entry value = {
3267 .enabled = !trace->not_ev_qualifier,
3269 int err = 0;
3270 size_t i;
3272 for (i = 0; i < trace->ev_qualifier_ids.nr; ++i) {
3273 int key = trace->ev_qualifier_ids.entries[i];
3275 if (value.enabled) {
3276 trace__init_bpf_map_syscall_args(trace, key, &value);
3277 trace__init_syscall_bpf_progs(trace, key);
3280 err = bpf_map_update_elem(fd, &key, &value, BPF_EXIST);
3281 if (err)
3282 break;
3285 return err;
3288 static int __trace__init_syscalls_bpf_map(struct trace *trace, bool enabled)
3290 int fd = bpf_map__fd(trace->syscalls.map);
3291 struct bpf_map_syscall_entry value = {
3292 .enabled = enabled,
3294 int err = 0, key;
3296 for (key = 0; key < trace->sctbl->syscalls.nr_entries; ++key) {
3297 if (enabled)
3298 trace__init_bpf_map_syscall_args(trace, key, &value);
3300 err = bpf_map_update_elem(fd, &key, &value, BPF_ANY);
3301 if (err)
3302 break;
3305 return err;
3308 static int trace__init_syscalls_bpf_map(struct trace *trace)
3310 bool enabled = true;
3312 if (trace->ev_qualifier_ids.nr)
3313 enabled = trace->not_ev_qualifier;
3315 return __trace__init_syscalls_bpf_map(trace, enabled);
3318 static struct bpf_program *trace__find_usable_bpf_prog_entry(struct trace *trace, struct syscall *sc)
3320 struct tep_format_field *field, *candidate_field;
3321 int id;
3324 * We're only interested in syscalls that have a pointer:
3326 for (field = sc->args; field; field = field->next) {
3327 if (field->flags & TEP_FIELD_IS_POINTER)
3328 goto try_to_find_pair;
3331 return NULL;
3333 try_to_find_pair:
3334 for (id = 0; id < trace->sctbl->syscalls.nr_entries; ++id) {
3335 struct syscall *pair = trace__syscall_info(trace, NULL, id);
3336 struct bpf_program *pair_prog;
3337 bool is_candidate = false;
3339 if (pair == NULL || pair == sc ||
3340 pair->bpf_prog.sys_enter == trace->syscalls.unaugmented_prog)
3341 continue;
3343 for (field = sc->args, candidate_field = pair->args;
3344 field && candidate_field; field = field->next, candidate_field = candidate_field->next) {
3345 bool is_pointer = field->flags & TEP_FIELD_IS_POINTER,
3346 candidate_is_pointer = candidate_field->flags & TEP_FIELD_IS_POINTER;
3348 if (is_pointer) {
3349 if (!candidate_is_pointer) {
3350 // The candidate just doesn't copies our pointer arg, might copy other pointers we want.
3351 continue;
3353 } else {
3354 if (candidate_is_pointer) {
3355 // The candidate might copy a pointer we don't have, skip it.
3356 goto next_candidate;
3358 continue;
3361 if (strcmp(field->type, candidate_field->type))
3362 goto next_candidate;
3364 is_candidate = true;
3367 if (!is_candidate)
3368 goto next_candidate;
3371 * Check if the tentative pair syscall augmenter has more pointers, if it has,
3372 * then it may be collecting that and we then can't use it, as it would collect
3373 * more than what is common to the two syscalls.
3375 if (candidate_field) {
3376 for (candidate_field = candidate_field->next; candidate_field; candidate_field = candidate_field->next)
3377 if (candidate_field->flags & TEP_FIELD_IS_POINTER)
3378 goto next_candidate;
3381 pair_prog = pair->bpf_prog.sys_enter;
3383 * If the pair isn't enabled, then its bpf_prog.sys_enter will not
3384 * have been searched for, so search it here and if it returns the
3385 * unaugmented one, then ignore it, otherwise we'll reuse that BPF
3386 * program for a filtered syscall on a non-filtered one.
3388 * For instance, we have "!syscalls:sys_enter_renameat" and that is
3389 * useful for "renameat2".
3391 if (pair_prog == NULL) {
3392 pair_prog = trace__find_syscall_bpf_prog(trace, pair, pair->fmt ? pair->fmt->bpf_prog_name.sys_enter : NULL, "enter");
3393 if (pair_prog == trace->syscalls.unaugmented_prog)
3394 goto next_candidate;
3397 pr_debug("Reusing \"%s\" BPF sys_enter augmenter for \"%s\"\n", pair->name, sc->name);
3398 return pair_prog;
3399 next_candidate:
3400 continue;
3403 return NULL;
3406 static int trace__init_syscalls_bpf_prog_array_maps(struct trace *trace)
3408 int map_enter_fd = bpf_map__fd(trace->syscalls.prog_array.sys_enter),
3409 map_exit_fd = bpf_map__fd(trace->syscalls.prog_array.sys_exit);
3410 int err = 0, key;
3412 for (key = 0; key < trace->sctbl->syscalls.nr_entries; ++key) {
3413 int prog_fd;
3415 if (!trace__syscall_enabled(trace, key))
3416 continue;
3418 trace__init_syscall_bpf_progs(trace, key);
3420 // It'll get at least the "!raw_syscalls:unaugmented"
3421 prog_fd = trace__bpf_prog_sys_enter_fd(trace, key);
3422 err = bpf_map_update_elem(map_enter_fd, &key, &prog_fd, BPF_ANY);
3423 if (err)
3424 break;
3425 prog_fd = trace__bpf_prog_sys_exit_fd(trace, key);
3426 err = bpf_map_update_elem(map_exit_fd, &key, &prog_fd, BPF_ANY);
3427 if (err)
3428 break;
3432 * Now lets do a second pass looking for enabled syscalls without
3433 * an augmenter that have a signature that is a superset of another
3434 * syscall with an augmenter so that we can auto-reuse it.
3436 * I.e. if we have an augmenter for the "open" syscall that has
3437 * this signature:
3439 * int open(const char *pathname, int flags, mode_t mode);
3441 * I.e. that will collect just the first string argument, then we
3442 * can reuse it for the 'creat' syscall, that has this signature:
3444 * int creat(const char *pathname, mode_t mode);
3446 * and for:
3448 * int stat(const char *pathname, struct stat *statbuf);
3449 * int lstat(const char *pathname, struct stat *statbuf);
3451 * Because the 'open' augmenter will collect the first arg as a string,
3452 * and leave alone all the other args, which already helps with
3453 * beautifying 'stat' and 'lstat''s pathname arg.
3455 * Then, in time, when 'stat' gets an augmenter that collects both
3456 * first and second arg (this one on the raw_syscalls:sys_exit prog
3457 * array tail call, then that one will be used.
3459 for (key = 0; key < trace->sctbl->syscalls.nr_entries; ++key) {
3460 struct syscall *sc = trace__syscall_info(trace, NULL, key);
3461 struct bpf_program *pair_prog;
3462 int prog_fd;
3464 if (sc == NULL || sc->bpf_prog.sys_enter == NULL)
3465 continue;
3468 * For now we're just reusing the sys_enter prog, and if it
3469 * already has an augmenter, we don't need to find one.
3471 if (sc->bpf_prog.sys_enter != trace->syscalls.unaugmented_prog)
3472 continue;
3475 * Look at all the other syscalls for one that has a signature
3476 * that is close enough that we can share:
3478 pair_prog = trace__find_usable_bpf_prog_entry(trace, sc);
3479 if (pair_prog == NULL)
3480 continue;
3482 sc->bpf_prog.sys_enter = pair_prog;
3485 * Update the BPF_MAP_TYPE_PROG_SHARED for raw_syscalls:sys_enter
3486 * with the fd for the program we're reusing:
3488 prog_fd = bpf_program__fd(sc->bpf_prog.sys_enter);
3489 err = bpf_map_update_elem(map_enter_fd, &key, &prog_fd, BPF_ANY);
3490 if (err)
3491 break;
3495 return err;
3498 static void trace__delete_augmented_syscalls(struct trace *trace)
3500 struct evsel *evsel, *tmp;
3502 evlist__remove(trace->evlist, trace->syscalls.events.augmented);
3503 evsel__delete(trace->syscalls.events.augmented);
3504 trace->syscalls.events.augmented = NULL;
3506 evlist__for_each_entry_safe(trace->evlist, tmp, evsel) {
3507 if (evsel->bpf_obj == trace->bpf_obj) {
3508 evlist__remove(trace->evlist, evsel);
3509 evsel__delete(evsel);
3514 bpf_object__close(trace->bpf_obj);
3515 trace->bpf_obj = NULL;
3517 #else // HAVE_LIBBPF_SUPPORT
3518 static int trace__set_ev_qualifier_bpf_filter(struct trace *trace __maybe_unused)
3520 return 0;
3523 static int trace__init_syscalls_bpf_map(struct trace *trace __maybe_unused)
3525 return 0;
3528 static struct bpf_program *trace__find_bpf_program_by_title(struct trace *trace __maybe_unused,
3529 const char *name __maybe_unused)
3531 return NULL;
3534 static int trace__init_syscalls_bpf_prog_array_maps(struct trace *trace __maybe_unused)
3536 return 0;
3539 static void trace__delete_augmented_syscalls(struct trace *trace __maybe_unused)
3542 #endif // HAVE_LIBBPF_SUPPORT
3544 static bool trace__only_augmented_syscalls_evsels(struct trace *trace)
3546 struct evsel *evsel;
3548 evlist__for_each_entry(trace->evlist, evsel) {
3549 if (evsel == trace->syscalls.events.augmented ||
3550 evsel->bpf_obj == trace->bpf_obj)
3551 continue;
3553 return false;
3556 return true;
3559 static int trace__set_ev_qualifier_filter(struct trace *trace)
3561 if (trace->syscalls.map)
3562 return trace__set_ev_qualifier_bpf_filter(trace);
3563 if (trace->syscalls.events.sys_enter)
3564 return trace__set_ev_qualifier_tp_filter(trace);
3565 return 0;
3568 static int bpf_map__set_filter_pids(struct bpf_map *map __maybe_unused,
3569 size_t npids __maybe_unused, pid_t *pids __maybe_unused)
3571 int err = 0;
3572 #ifdef HAVE_LIBBPF_SUPPORT
3573 bool value = true;
3574 int map_fd = bpf_map__fd(map);
3575 size_t i;
3577 for (i = 0; i < npids; ++i) {
3578 err = bpf_map_update_elem(map_fd, &pids[i], &value, BPF_ANY);
3579 if (err)
3580 break;
3582 #endif
3583 return err;
3586 static int trace__set_filter_loop_pids(struct trace *trace)
3588 unsigned int nr = 1, err;
3589 pid_t pids[32] = {
3590 getpid(),
3592 struct thread *thread = machine__find_thread(trace->host, pids[0], pids[0]);
3594 while (thread && nr < ARRAY_SIZE(pids)) {
3595 struct thread *parent = machine__find_thread(trace->host, thread->ppid, thread->ppid);
3597 if (parent == NULL)
3598 break;
3600 if (!strcmp(thread__comm_str(parent), "sshd") ||
3601 strstarts(thread__comm_str(parent), "gnome-terminal")) {
3602 pids[nr++] = parent->tid;
3603 break;
3605 thread = parent;
3608 err = perf_evlist__append_tp_filter_pids(trace->evlist, nr, pids);
3609 if (!err && trace->filter_pids.map)
3610 err = bpf_map__set_filter_pids(trace->filter_pids.map, nr, pids);
3612 return err;
3615 static int trace__set_filter_pids(struct trace *trace)
3617 int err = 0;
3619 * Better not use !target__has_task() here because we need to cover the
3620 * case where no threads were specified in the command line, but a
3621 * workload was, and in that case we will fill in the thread_map when
3622 * we fork the workload in perf_evlist__prepare_workload.
3624 if (trace->filter_pids.nr > 0) {
3625 err = perf_evlist__append_tp_filter_pids(trace->evlist, trace->filter_pids.nr,
3626 trace->filter_pids.entries);
3627 if (!err && trace->filter_pids.map) {
3628 err = bpf_map__set_filter_pids(trace->filter_pids.map, trace->filter_pids.nr,
3629 trace->filter_pids.entries);
3631 } else if (perf_thread_map__pid(trace->evlist->core.threads, 0) == -1) {
3632 err = trace__set_filter_loop_pids(trace);
3635 return err;
3638 static int __trace__deliver_event(struct trace *trace, union perf_event *event)
3640 struct evlist *evlist = trace->evlist;
3641 struct perf_sample sample;
3642 int err;
3644 err = perf_evlist__parse_sample(evlist, event, &sample);
3645 if (err)
3646 fprintf(trace->output, "Can't parse sample, err = %d, skipping...\n", err);
3647 else
3648 trace__handle_event(trace, event, &sample);
3650 return 0;
3653 static int __trace__flush_events(struct trace *trace)
3655 u64 first = ordered_events__first_time(&trace->oe.data);
3656 u64 flush = trace->oe.last - NSEC_PER_SEC;
3658 /* Is there some thing to flush.. */
3659 if (first && first < flush)
3660 return ordered_events__flush_time(&trace->oe.data, flush);
3662 return 0;
3665 static int trace__flush_events(struct trace *trace)
3667 return !trace->sort_events ? 0 : __trace__flush_events(trace);
3670 static int trace__deliver_event(struct trace *trace, union perf_event *event)
3672 int err;
3674 if (!trace->sort_events)
3675 return __trace__deliver_event(trace, event);
3677 err = perf_evlist__parse_sample_timestamp(trace->evlist, event, &trace->oe.last);
3678 if (err && err != -1)
3679 return err;
3681 err = ordered_events__queue(&trace->oe.data, event, trace->oe.last, 0);
3682 if (err)
3683 return err;
3685 return trace__flush_events(trace);
3688 static int ordered_events__deliver_event(struct ordered_events *oe,
3689 struct ordered_event *event)
3691 struct trace *trace = container_of(oe, struct trace, oe.data);
3693 return __trace__deliver_event(trace, event->event);
3696 static struct syscall_arg_fmt *perf_evsel__syscall_arg_fmt(struct evsel *evsel, char *arg)
3698 struct tep_format_field *field;
3699 struct syscall_arg_fmt *fmt = __evsel__syscall_arg_fmt(evsel);
3701 if (evsel->tp_format == NULL || fmt == NULL)
3702 return NULL;
3704 for (field = evsel->tp_format->format.fields; field; field = field->next, ++fmt)
3705 if (strcmp(field->name, arg) == 0)
3706 return fmt;
3708 return NULL;
3711 static int trace__expand_filter(struct trace *trace __maybe_unused, struct evsel *evsel)
3713 char *tok, *left = evsel->filter, *new_filter = evsel->filter;
3715 while ((tok = strpbrk(left, "=<>!")) != NULL) {
3716 char *right = tok + 1, *right_end;
3718 if (*right == '=')
3719 ++right;
3721 while (isspace(*right))
3722 ++right;
3724 if (*right == '\0')
3725 break;
3727 while (!isalpha(*left))
3728 if (++left == tok) {
3730 * Bail out, can't find the name of the argument that is being
3731 * used in the filter, let it try to set this filter, will fail later.
3733 return 0;
3736 right_end = right + 1;
3737 while (isalnum(*right_end) || *right_end == '_' || *right_end == '|')
3738 ++right_end;
3740 if (isalpha(*right)) {
3741 struct syscall_arg_fmt *fmt;
3742 int left_size = tok - left,
3743 right_size = right_end - right;
3744 char arg[128];
3746 while (isspace(left[left_size - 1]))
3747 --left_size;
3749 scnprintf(arg, sizeof(arg), "%.*s", left_size, left);
3751 fmt = perf_evsel__syscall_arg_fmt(evsel, arg);
3752 if (fmt == NULL) {
3753 pr_err("\"%s\" not found in \"%s\", can't set filter \"%s\"\n",
3754 arg, evsel->name, evsel->filter);
3755 return -1;
3758 pr_debug2("trying to expand \"%s\" \"%.*s\" \"%.*s\" -> ",
3759 arg, (int)(right - tok), tok, right_size, right);
3761 if (fmt->strtoul) {
3762 u64 val;
3763 struct syscall_arg syscall_arg = {
3764 .parm = fmt->parm,
3767 if (fmt->strtoul(right, right_size, &syscall_arg, &val)) {
3768 char *n, expansion[19];
3769 int expansion_lenght = scnprintf(expansion, sizeof(expansion), "%#" PRIx64, val);
3770 int expansion_offset = right - new_filter;
3772 pr_debug("%s", expansion);
3774 if (asprintf(&n, "%.*s%s%s", expansion_offset, new_filter, expansion, right_end) < 0) {
3775 pr_debug(" out of memory!\n");
3776 free(new_filter);
3777 return -1;
3779 if (new_filter != evsel->filter)
3780 free(new_filter);
3781 left = n + expansion_offset + expansion_lenght;
3782 new_filter = n;
3783 } else {
3784 pr_err("\"%.*s\" not found for \"%s\" in \"%s\", can't set filter \"%s\"\n",
3785 right_size, right, arg, evsel->name, evsel->filter);
3786 return -1;
3788 } else {
3789 pr_err("No resolver (strtoul) for \"%s\" in \"%s\", can't set filter \"%s\"\n",
3790 arg, evsel->name, evsel->filter);
3791 return -1;
3794 pr_debug("\n");
3795 } else {
3796 left = right_end;
3800 if (new_filter != evsel->filter) {
3801 pr_debug("New filter for %s: %s\n", evsel->name, new_filter);
3802 perf_evsel__set_filter(evsel, new_filter);
3803 free(new_filter);
3806 return 0;
3809 static int trace__expand_filters(struct trace *trace, struct evsel **err_evsel)
3811 struct evlist *evlist = trace->evlist;
3812 struct evsel *evsel;
3814 evlist__for_each_entry(evlist, evsel) {
3815 if (evsel->filter == NULL)
3816 continue;
3818 if (trace__expand_filter(trace, evsel)) {
3819 *err_evsel = evsel;
3820 return -1;
3824 return 0;
3827 static int trace__run(struct trace *trace, int argc, const char **argv)
3829 struct evlist *evlist = trace->evlist;
3830 struct evsel *evsel, *pgfault_maj = NULL, *pgfault_min = NULL;
3831 int err = -1, i;
3832 unsigned long before;
3833 const bool forks = argc > 0;
3834 bool draining = false;
3836 trace->live = true;
3838 if (!trace->raw_augmented_syscalls) {
3839 if (trace->trace_syscalls && trace__add_syscall_newtp(trace))
3840 goto out_error_raw_syscalls;
3842 if (trace->trace_syscalls)
3843 trace->vfs_getname = evlist__add_vfs_getname(evlist);
3846 if ((trace->trace_pgfaults & TRACE_PFMAJ)) {
3847 pgfault_maj = perf_evsel__new_pgfault(PERF_COUNT_SW_PAGE_FAULTS_MAJ);
3848 if (pgfault_maj == NULL)
3849 goto out_error_mem;
3850 perf_evsel__config_callchain(pgfault_maj, &trace->opts, &callchain_param);
3851 evlist__add(evlist, pgfault_maj);
3854 if ((trace->trace_pgfaults & TRACE_PFMIN)) {
3855 pgfault_min = perf_evsel__new_pgfault(PERF_COUNT_SW_PAGE_FAULTS_MIN);
3856 if (pgfault_min == NULL)
3857 goto out_error_mem;
3858 perf_evsel__config_callchain(pgfault_min, &trace->opts, &callchain_param);
3859 evlist__add(evlist, pgfault_min);
3862 if (trace->sched &&
3863 perf_evlist__add_newtp(evlist, "sched", "sched_stat_runtime",
3864 trace__sched_stat_runtime))
3865 goto out_error_sched_stat_runtime;
3867 * If a global cgroup was set, apply it to all the events without an
3868 * explicit cgroup. I.e.:
3870 * trace -G A -e sched:*switch
3872 * Will set all raw_syscalls:sys_{enter,exit}, pgfault, vfs_getname, etc
3873 * _and_ sched:sched_switch to the 'A' cgroup, while:
3875 * trace -e sched:*switch -G A
3877 * will only set the sched:sched_switch event to the 'A' cgroup, all the
3878 * other events (raw_syscalls:sys_{enter,exit}, etc are left "without"
3879 * a cgroup (on the root cgroup, sys wide, etc).
3881 * Multiple cgroups:
3883 * trace -G A -e sched:*switch -G B
3885 * the syscall ones go to the 'A' cgroup, the sched:sched_switch goes
3886 * to the 'B' cgroup.
3888 * evlist__set_default_cgroup() grabs a reference of the passed cgroup
3889 * only for the evsels still without a cgroup, i.e. evsel->cgroup == NULL.
3891 if (trace->cgroup)
3892 evlist__set_default_cgroup(trace->evlist, trace->cgroup);
3894 err = perf_evlist__create_maps(evlist, &trace->opts.target);
3895 if (err < 0) {
3896 fprintf(trace->output, "Problems parsing the target to trace, check your options!\n");
3897 goto out_delete_evlist;
3900 err = trace__symbols_init(trace, evlist);
3901 if (err < 0) {
3902 fprintf(trace->output, "Problems initializing symbol libraries!\n");
3903 goto out_delete_evlist;
3906 perf_evlist__config(evlist, &trace->opts, &callchain_param);
3908 signal(SIGCHLD, sig_handler);
3909 signal(SIGINT, sig_handler);
3911 if (forks) {
3912 err = perf_evlist__prepare_workload(evlist, &trace->opts.target,
3913 argv, false, NULL);
3914 if (err < 0) {
3915 fprintf(trace->output, "Couldn't run the workload!\n");
3916 goto out_delete_evlist;
3920 err = evlist__open(evlist);
3921 if (err < 0)
3922 goto out_error_open;
3924 err = bpf__apply_obj_config();
3925 if (err) {
3926 char errbuf[BUFSIZ];
3928 bpf__strerror_apply_obj_config(err, errbuf, sizeof(errbuf));
3929 pr_err("ERROR: Apply config to BPF failed: %s\n",
3930 errbuf);
3931 goto out_error_open;
3934 err = trace__set_filter_pids(trace);
3935 if (err < 0)
3936 goto out_error_mem;
3938 if (trace->syscalls.map)
3939 trace__init_syscalls_bpf_map(trace);
3941 if (trace->syscalls.prog_array.sys_enter)
3942 trace__init_syscalls_bpf_prog_array_maps(trace);
3944 if (trace->ev_qualifier_ids.nr > 0) {
3945 err = trace__set_ev_qualifier_filter(trace);
3946 if (err < 0)
3947 goto out_errno;
3949 if (trace->syscalls.events.sys_exit) {
3950 pr_debug("event qualifier tracepoint filter: %s\n",
3951 trace->syscalls.events.sys_exit->filter);
3956 * If the "close" syscall is not traced, then we will not have the
3957 * opportunity to, in syscall_arg__scnprintf_close_fd() invalidate the
3958 * fd->pathname table and were ending up showing the last value set by
3959 * syscalls opening a pathname and associating it with a descriptor or
3960 * reading it from /proc/pid/fd/ in cases where that doesn't make
3961 * sense.
3963 * So just disable this beautifier (SCA_FD, SCA_FDAT) when 'close' is
3964 * not in use.
3966 trace->fd_path_disabled = !trace__syscall_enabled(trace, syscalltbl__id(trace->sctbl, "close"));
3968 err = trace__expand_filters(trace, &evsel);
3969 if (err)
3970 goto out_delete_evlist;
3971 err = perf_evlist__apply_filters(evlist, &evsel);
3972 if (err < 0)
3973 goto out_error_apply_filters;
3975 if (trace->dump.map)
3976 bpf_map__fprintf(trace->dump.map, trace->output);
3978 err = evlist__mmap(evlist, trace->opts.mmap_pages);
3979 if (err < 0)
3980 goto out_error_mmap;
3982 if (!target__none(&trace->opts.target) && !trace->opts.initial_delay)
3983 evlist__enable(evlist);
3985 if (forks)
3986 perf_evlist__start_workload(evlist);
3988 if (trace->opts.initial_delay) {
3989 usleep(trace->opts.initial_delay * 1000);
3990 evlist__enable(evlist);
3993 trace->multiple_threads = perf_thread_map__pid(evlist->core.threads, 0) == -1 ||
3994 evlist->core.threads->nr > 1 ||
3995 evlist__first(evlist)->core.attr.inherit;
3998 * Now that we already used evsel->core.attr to ask the kernel to setup the
3999 * events, lets reuse evsel->core.attr.sample_max_stack as the limit in
4000 * trace__resolve_callchain(), allowing per-event max-stack settings
4001 * to override an explicitly set --max-stack global setting.
4003 evlist__for_each_entry(evlist, evsel) {
4004 if (evsel__has_callchain(evsel) &&
4005 evsel->core.attr.sample_max_stack == 0)
4006 evsel->core.attr.sample_max_stack = trace->max_stack;
4008 again:
4009 before = trace->nr_events;
4011 for (i = 0; i < evlist->core.nr_mmaps; i++) {
4012 union perf_event *event;
4013 struct mmap *md;
4015 md = &evlist->mmap[i];
4016 if (perf_mmap__read_init(&md->core) < 0)
4017 continue;
4019 while ((event = perf_mmap__read_event(&md->core)) != NULL) {
4020 ++trace->nr_events;
4022 err = trace__deliver_event(trace, event);
4023 if (err)
4024 goto out_disable;
4026 perf_mmap__consume(&md->core);
4028 if (interrupted)
4029 goto out_disable;
4031 if (done && !draining) {
4032 evlist__disable(evlist);
4033 draining = true;
4036 perf_mmap__read_done(&md->core);
4039 if (trace->nr_events == before) {
4040 int timeout = done ? 100 : -1;
4042 if (!draining && evlist__poll(evlist, timeout) > 0) {
4043 if (evlist__filter_pollfd(evlist, POLLERR | POLLHUP | POLLNVAL) == 0)
4044 draining = true;
4046 goto again;
4047 } else {
4048 if (trace__flush_events(trace))
4049 goto out_disable;
4051 } else {
4052 goto again;
4055 out_disable:
4056 thread__zput(trace->current);
4058 evlist__disable(evlist);
4060 if (trace->sort_events)
4061 ordered_events__flush(&trace->oe.data, OE_FLUSH__FINAL);
4063 if (!err) {
4064 if (trace->summary)
4065 trace__fprintf_thread_summary(trace, trace->output);
4067 if (trace->show_tool_stats) {
4068 fprintf(trace->output, "Stats:\n "
4069 " vfs_getname : %" PRIu64 "\n"
4070 " proc_getname: %" PRIu64 "\n",
4071 trace->stats.vfs_getname,
4072 trace->stats.proc_getname);
4076 out_delete_evlist:
4077 trace__symbols__exit(trace);
4079 evlist__delete(evlist);
4080 cgroup__put(trace->cgroup);
4081 trace->evlist = NULL;
4082 trace->live = false;
4083 return err;
4085 char errbuf[BUFSIZ];
4087 out_error_sched_stat_runtime:
4088 tracing_path__strerror_open_tp(errno, errbuf, sizeof(errbuf), "sched", "sched_stat_runtime");
4089 goto out_error;
4091 out_error_raw_syscalls:
4092 tracing_path__strerror_open_tp(errno, errbuf, sizeof(errbuf), "raw_syscalls", "sys_(enter|exit)");
4093 goto out_error;
4095 out_error_mmap:
4096 perf_evlist__strerror_mmap(evlist, errno, errbuf, sizeof(errbuf));
4097 goto out_error;
4099 out_error_open:
4100 perf_evlist__strerror_open(evlist, errno, errbuf, sizeof(errbuf));
4102 out_error:
4103 fprintf(trace->output, "%s\n", errbuf);
4104 goto out_delete_evlist;
4106 out_error_apply_filters:
4107 fprintf(trace->output,
4108 "Failed to set filter \"%s\" on event %s with %d (%s)\n",
4109 evsel->filter, perf_evsel__name(evsel), errno,
4110 str_error_r(errno, errbuf, sizeof(errbuf)));
4111 goto out_delete_evlist;
4113 out_error_mem:
4114 fprintf(trace->output, "Not enough memory to run!\n");
4115 goto out_delete_evlist;
4117 out_errno:
4118 fprintf(trace->output, "errno=%d,%s\n", errno, strerror(errno));
4119 goto out_delete_evlist;
4122 static int trace__replay(struct trace *trace)
4124 const struct evsel_str_handler handlers[] = {
4125 { "probe:vfs_getname", trace__vfs_getname, },
4127 struct perf_data data = {
4128 .path = input_name,
4129 .mode = PERF_DATA_MODE_READ,
4130 .force = trace->force,
4132 struct perf_session *session;
4133 struct evsel *evsel;
4134 int err = -1;
4136 trace->tool.sample = trace__process_sample;
4137 trace->tool.mmap = perf_event__process_mmap;
4138 trace->tool.mmap2 = perf_event__process_mmap2;
4139 trace->tool.comm = perf_event__process_comm;
4140 trace->tool.exit = perf_event__process_exit;
4141 trace->tool.fork = perf_event__process_fork;
4142 trace->tool.attr = perf_event__process_attr;
4143 trace->tool.tracing_data = perf_event__process_tracing_data;
4144 trace->tool.build_id = perf_event__process_build_id;
4145 trace->tool.namespaces = perf_event__process_namespaces;
4147 trace->tool.ordered_events = true;
4148 trace->tool.ordering_requires_timestamps = true;
4150 /* add tid to output */
4151 trace->multiple_threads = true;
4153 session = perf_session__new(&data, false, &trace->tool);
4154 if (IS_ERR(session))
4155 return PTR_ERR(session);
4157 if (trace->opts.target.pid)
4158 symbol_conf.pid_list_str = strdup(trace->opts.target.pid);
4160 if (trace->opts.target.tid)
4161 symbol_conf.tid_list_str = strdup(trace->opts.target.tid);
4163 if (symbol__init(&session->header.env) < 0)
4164 goto out;
4166 trace->host = &session->machines.host;
4168 err = perf_session__set_tracepoints_handlers(session, handlers);
4169 if (err)
4170 goto out;
4172 evsel = perf_evlist__find_tracepoint_by_name(session->evlist,
4173 "raw_syscalls:sys_enter");
4174 /* older kernels have syscalls tp versus raw_syscalls */
4175 if (evsel == NULL)
4176 evsel = perf_evlist__find_tracepoint_by_name(session->evlist,
4177 "syscalls:sys_enter");
4179 if (evsel &&
4180 (perf_evsel__init_raw_syscall_tp(evsel, trace__sys_enter) < 0 ||
4181 perf_evsel__init_sc_tp_ptr_field(evsel, args))) {
4182 pr_err("Error during initialize raw_syscalls:sys_enter event\n");
4183 goto out;
4186 evsel = perf_evlist__find_tracepoint_by_name(session->evlist,
4187 "raw_syscalls:sys_exit");
4188 if (evsel == NULL)
4189 evsel = perf_evlist__find_tracepoint_by_name(session->evlist,
4190 "syscalls:sys_exit");
4191 if (evsel &&
4192 (perf_evsel__init_raw_syscall_tp(evsel, trace__sys_exit) < 0 ||
4193 perf_evsel__init_sc_tp_uint_field(evsel, ret))) {
4194 pr_err("Error during initialize raw_syscalls:sys_exit event\n");
4195 goto out;
4198 evlist__for_each_entry(session->evlist, evsel) {
4199 if (evsel->core.attr.type == PERF_TYPE_SOFTWARE &&
4200 (evsel->core.attr.config == PERF_COUNT_SW_PAGE_FAULTS_MAJ ||
4201 evsel->core.attr.config == PERF_COUNT_SW_PAGE_FAULTS_MIN ||
4202 evsel->core.attr.config == PERF_COUNT_SW_PAGE_FAULTS))
4203 evsel->handler = trace__pgfault;
4206 setup_pager();
4208 err = perf_session__process_events(session);
4209 if (err)
4210 pr_err("Failed to process events, error %d", err);
4212 else if (trace->summary)
4213 trace__fprintf_thread_summary(trace, trace->output);
4215 out:
4216 perf_session__delete(session);
4218 return err;
4221 static size_t trace__fprintf_threads_header(FILE *fp)
4223 size_t printed;
4225 printed = fprintf(fp, "\n Summary of events:\n\n");
4227 return printed;
4230 DEFINE_RESORT_RB(syscall_stats, a->msecs > b->msecs,
4231 struct syscall_stats *stats;
4232 double msecs;
4233 int syscall;
4236 struct int_node *source = rb_entry(nd, struct int_node, rb_node);
4237 struct syscall_stats *stats = source->priv;
4239 entry->syscall = source->i;
4240 entry->stats = stats;
4241 entry->msecs = stats ? (u64)stats->stats.n * (avg_stats(&stats->stats) / NSEC_PER_MSEC) : 0;
4244 static size_t thread__dump_stats(struct thread_trace *ttrace,
4245 struct trace *trace, FILE *fp)
4247 size_t printed = 0;
4248 struct syscall *sc;
4249 struct rb_node *nd;
4250 DECLARE_RESORT_RB_INTLIST(syscall_stats, ttrace->syscall_stats);
4252 if (syscall_stats == NULL)
4253 return 0;
4255 printed += fprintf(fp, "\n");
4257 printed += fprintf(fp, " syscall calls errors total min avg max stddev\n");
4258 printed += fprintf(fp, " (msec) (msec) (msec) (msec) (%%)\n");
4259 printed += fprintf(fp, " --------------- -------- ------ -------- --------- --------- --------- ------\n");
4261 resort_rb__for_each_entry(nd, syscall_stats) {
4262 struct syscall_stats *stats = syscall_stats_entry->stats;
4263 if (stats) {
4264 double min = (double)(stats->stats.min) / NSEC_PER_MSEC;
4265 double max = (double)(stats->stats.max) / NSEC_PER_MSEC;
4266 double avg = avg_stats(&stats->stats);
4267 double pct;
4268 u64 n = (u64)stats->stats.n;
4270 pct = avg ? 100.0 * stddev_stats(&stats->stats) / avg : 0.0;
4271 avg /= NSEC_PER_MSEC;
4273 sc = &trace->syscalls.table[syscall_stats_entry->syscall];
4274 printed += fprintf(fp, " %-15s", sc->name);
4275 printed += fprintf(fp, " %8" PRIu64 " %6" PRIu64 " %9.3f %9.3f %9.3f",
4276 n, stats->nr_failures, syscall_stats_entry->msecs, min, avg);
4277 printed += fprintf(fp, " %9.3f %9.2f%%\n", max, pct);
4279 if (trace->errno_summary && stats->nr_failures) {
4280 const char *arch_name = perf_env__arch(trace->host->env);
4281 int e;
4283 for (e = 0; e < stats->max_errno; ++e) {
4284 if (stats->errnos[e] != 0)
4285 fprintf(fp, "\t\t\t\t%s: %d\n", arch_syscalls__strerrno(arch_name, e + 1), stats->errnos[e]);
4291 resort_rb__delete(syscall_stats);
4292 printed += fprintf(fp, "\n\n");
4294 return printed;
4297 static size_t trace__fprintf_thread(FILE *fp, struct thread *thread, struct trace *trace)
4299 size_t printed = 0;
4300 struct thread_trace *ttrace = thread__priv(thread);
4301 double ratio;
4303 if (ttrace == NULL)
4304 return 0;
4306 ratio = (double)ttrace->nr_events / trace->nr_events * 100.0;
4308 printed += fprintf(fp, " %s (%d), ", thread__comm_str(thread), thread->tid);
4309 printed += fprintf(fp, "%lu events, ", ttrace->nr_events);
4310 printed += fprintf(fp, "%.1f%%", ratio);
4311 if (ttrace->pfmaj)
4312 printed += fprintf(fp, ", %lu majfaults", ttrace->pfmaj);
4313 if (ttrace->pfmin)
4314 printed += fprintf(fp, ", %lu minfaults", ttrace->pfmin);
4315 if (trace->sched)
4316 printed += fprintf(fp, ", %.3f msec\n", ttrace->runtime_ms);
4317 else if (fputc('\n', fp) != EOF)
4318 ++printed;
4320 printed += thread__dump_stats(ttrace, trace, fp);
4322 return printed;
4325 static unsigned long thread__nr_events(struct thread_trace *ttrace)
4327 return ttrace ? ttrace->nr_events : 0;
4330 DEFINE_RESORT_RB(threads, (thread__nr_events(a->thread->priv) < thread__nr_events(b->thread->priv)),
4331 struct thread *thread;
4334 entry->thread = rb_entry(nd, struct thread, rb_node);
4337 static size_t trace__fprintf_thread_summary(struct trace *trace, FILE *fp)
4339 size_t printed = trace__fprintf_threads_header(fp);
4340 struct rb_node *nd;
4341 int i;
4343 for (i = 0; i < THREADS__TABLE_SIZE; i++) {
4344 DECLARE_RESORT_RB_MACHINE_THREADS(threads, trace->host, i);
4346 if (threads == NULL) {
4347 fprintf(fp, "%s", "Error sorting output by nr_events!\n");
4348 return 0;
4351 resort_rb__for_each_entry(nd, threads)
4352 printed += trace__fprintf_thread(fp, threads_entry->thread, trace);
4354 resort_rb__delete(threads);
4356 return printed;
4359 static int trace__set_duration(const struct option *opt, const char *str,
4360 int unset __maybe_unused)
4362 struct trace *trace = opt->value;
4364 trace->duration_filter = atof(str);
4365 return 0;
4368 static int trace__set_filter_pids_from_option(const struct option *opt, const char *str,
4369 int unset __maybe_unused)
4371 int ret = -1;
4372 size_t i;
4373 struct trace *trace = opt->value;
4375 * FIXME: introduce a intarray class, plain parse csv and create a
4376 * { int nr, int entries[] } struct...
4378 struct intlist *list = intlist__new(str);
4380 if (list == NULL)
4381 return -1;
4383 i = trace->filter_pids.nr = intlist__nr_entries(list) + 1;
4384 trace->filter_pids.entries = calloc(i, sizeof(pid_t));
4386 if (trace->filter_pids.entries == NULL)
4387 goto out;
4389 trace->filter_pids.entries[0] = getpid();
4391 for (i = 1; i < trace->filter_pids.nr; ++i)
4392 trace->filter_pids.entries[i] = intlist__entry(list, i - 1)->i;
4394 intlist__delete(list);
4395 ret = 0;
4396 out:
4397 return ret;
4400 static int trace__open_output(struct trace *trace, const char *filename)
4402 struct stat st;
4404 if (!stat(filename, &st) && st.st_size) {
4405 char oldname[PATH_MAX];
4407 scnprintf(oldname, sizeof(oldname), "%s.old", filename);
4408 unlink(oldname);
4409 rename(filename, oldname);
4412 trace->output = fopen(filename, "w");
4414 return trace->output == NULL ? -errno : 0;
4417 static int parse_pagefaults(const struct option *opt, const char *str,
4418 int unset __maybe_unused)
4420 int *trace_pgfaults = opt->value;
4422 if (strcmp(str, "all") == 0)
4423 *trace_pgfaults |= TRACE_PFMAJ | TRACE_PFMIN;
4424 else if (strcmp(str, "maj") == 0)
4425 *trace_pgfaults |= TRACE_PFMAJ;
4426 else if (strcmp(str, "min") == 0)
4427 *trace_pgfaults |= TRACE_PFMIN;
4428 else
4429 return -1;
4431 return 0;
4434 static void evlist__set_default_evsel_handler(struct evlist *evlist, void *handler)
4436 struct evsel *evsel;
4438 evlist__for_each_entry(evlist, evsel) {
4439 if (evsel->handler == NULL)
4440 evsel->handler = handler;
4444 static void evsel__set_syscall_arg_fmt(struct evsel *evsel, const char *name)
4446 struct syscall_arg_fmt *fmt = evsel__syscall_arg_fmt(evsel);
4448 if (fmt) {
4449 struct syscall_fmt *scfmt = syscall_fmt__find(name);
4451 if (scfmt) {
4452 int skip = 0;
4454 if (strcmp(evsel->tp_format->format.fields->name, "__syscall_nr") == 0 ||
4455 strcmp(evsel->tp_format->format.fields->name, "nr") == 0)
4456 ++skip;
4458 memcpy(fmt + skip, scfmt->arg, (evsel->tp_format->format.nr_fields - skip) * sizeof(*fmt));
4463 static int evlist__set_syscall_tp_fields(struct evlist *evlist)
4465 struct evsel *evsel;
4467 evlist__for_each_entry(evlist, evsel) {
4468 if (evsel->priv || !evsel->tp_format)
4469 continue;
4471 if (strcmp(evsel->tp_format->system, "syscalls")) {
4472 perf_evsel__init_tp_arg_scnprintf(evsel);
4473 continue;
4476 if (perf_evsel__init_syscall_tp(evsel))
4477 return -1;
4479 if (!strncmp(evsel->tp_format->name, "sys_enter_", 10)) {
4480 struct syscall_tp *sc = __evsel__syscall_tp(evsel);
4482 if (__tp_field__init_ptr(&sc->args, sc->id.offset + sizeof(u64)))
4483 return -1;
4485 evsel__set_syscall_arg_fmt(evsel, evsel->tp_format->name + sizeof("sys_enter_") - 1);
4486 } else if (!strncmp(evsel->tp_format->name, "sys_exit_", 9)) {
4487 struct syscall_tp *sc = __evsel__syscall_tp(evsel);
4489 if (__tp_field__init_uint(&sc->ret, sizeof(u64), sc->id.offset + sizeof(u64), evsel->needs_swap))
4490 return -1;
4492 evsel__set_syscall_arg_fmt(evsel, evsel->tp_format->name + sizeof("sys_exit_") - 1);
4496 return 0;
4500 * XXX: Hackish, just splitting the combined -e+--event (syscalls
4501 * (raw_syscalls:{sys_{enter,exit}} + events (tracepoints, HW, SW, etc) to use
4502 * existing facilities unchanged (trace->ev_qualifier + parse_options()).
4504 * It'd be better to introduce a parse_options() variant that would return a
4505 * list with the terms it didn't match to an event...
4507 static int trace__parse_events_option(const struct option *opt, const char *str,
4508 int unset __maybe_unused)
4510 struct trace *trace = (struct trace *)opt->value;
4511 const char *s = str;
4512 char *sep = NULL, *lists[2] = { NULL, NULL, };
4513 int len = strlen(str) + 1, err = -1, list, idx;
4514 char *strace_groups_dir = system_path(STRACE_GROUPS_DIR);
4515 char group_name[PATH_MAX];
4516 struct syscall_fmt *fmt;
4518 if (strace_groups_dir == NULL)
4519 return -1;
4521 if (*s == '!') {
4522 ++s;
4523 trace->not_ev_qualifier = true;
4526 while (1) {
4527 if ((sep = strchr(s, ',')) != NULL)
4528 *sep = '\0';
4530 list = 0;
4531 if (syscalltbl__id(trace->sctbl, s) >= 0 ||
4532 syscalltbl__strglobmatch_first(trace->sctbl, s, &idx) >= 0) {
4533 list = 1;
4534 goto do_concat;
4537 fmt = syscall_fmt__find_by_alias(s);
4538 if (fmt != NULL) {
4539 list = 1;
4540 s = fmt->name;
4541 } else {
4542 path__join(group_name, sizeof(group_name), strace_groups_dir, s);
4543 if (access(group_name, R_OK) == 0)
4544 list = 1;
4546 do_concat:
4547 if (lists[list]) {
4548 sprintf(lists[list] + strlen(lists[list]), ",%s", s);
4549 } else {
4550 lists[list] = malloc(len);
4551 if (lists[list] == NULL)
4552 goto out;
4553 strcpy(lists[list], s);
4556 if (!sep)
4557 break;
4559 *sep = ',';
4560 s = sep + 1;
4563 if (lists[1] != NULL) {
4564 struct strlist_config slist_config = {
4565 .dirname = strace_groups_dir,
4568 trace->ev_qualifier = strlist__new(lists[1], &slist_config);
4569 if (trace->ev_qualifier == NULL) {
4570 fputs("Not enough memory to parse event qualifier", trace->output);
4571 goto out;
4574 if (trace__validate_ev_qualifier(trace))
4575 goto out;
4576 trace->trace_syscalls = true;
4579 err = 0;
4581 if (lists[0]) {
4582 struct option o = OPT_CALLBACK('e', "event", &trace->evlist, "event",
4583 "event selector. use 'perf list' to list available events",
4584 parse_events_option);
4585 err = parse_events_option(&o, lists[0], 0);
4587 out:
4588 if (sep)
4589 *sep = ',';
4591 return err;
4594 static int trace__parse_cgroups(const struct option *opt, const char *str, int unset)
4596 struct trace *trace = opt->value;
4598 if (!list_empty(&trace->evlist->core.entries))
4599 return parse_cgroups(opt, str, unset);
4601 trace->cgroup = evlist__findnew_cgroup(trace->evlist, str);
4603 return 0;
4606 static struct bpf_map *trace__find_bpf_map_by_name(struct trace *trace, const char *name)
4608 if (trace->bpf_obj == NULL)
4609 return NULL;
4611 return bpf_object__find_map_by_name(trace->bpf_obj, name);
4614 static void trace__set_bpf_map_filtered_pids(struct trace *trace)
4616 trace->filter_pids.map = trace__find_bpf_map_by_name(trace, "pids_filtered");
4619 static void trace__set_bpf_map_syscalls(struct trace *trace)
4621 trace->syscalls.map = trace__find_bpf_map_by_name(trace, "syscalls");
4622 trace->syscalls.prog_array.sys_enter = trace__find_bpf_map_by_name(trace, "syscalls_sys_enter");
4623 trace->syscalls.prog_array.sys_exit = trace__find_bpf_map_by_name(trace, "syscalls_sys_exit");
4626 static int trace__config(const char *var, const char *value, void *arg)
4628 struct trace *trace = arg;
4629 int err = 0;
4631 if (!strcmp(var, "trace.add_events")) {
4632 trace->perfconfig_events = strdup(value);
4633 if (trace->perfconfig_events == NULL) {
4634 pr_err("Not enough memory for %s\n", "trace.add_events");
4635 return -1;
4637 } else if (!strcmp(var, "trace.show_timestamp")) {
4638 trace->show_tstamp = perf_config_bool(var, value);
4639 } else if (!strcmp(var, "trace.show_duration")) {
4640 trace->show_duration = perf_config_bool(var, value);
4641 } else if (!strcmp(var, "trace.show_arg_names")) {
4642 trace->show_arg_names = perf_config_bool(var, value);
4643 if (!trace->show_arg_names)
4644 trace->show_zeros = true;
4645 } else if (!strcmp(var, "trace.show_zeros")) {
4646 bool new_show_zeros = perf_config_bool(var, value);
4647 if (!trace->show_arg_names && !new_show_zeros) {
4648 pr_warning("trace.show_zeros has to be set when trace.show_arg_names=no\n");
4649 goto out;
4651 trace->show_zeros = new_show_zeros;
4652 } else if (!strcmp(var, "trace.show_prefix")) {
4653 trace->show_string_prefix = perf_config_bool(var, value);
4654 } else if (!strcmp(var, "trace.no_inherit")) {
4655 trace->opts.no_inherit = perf_config_bool(var, value);
4656 } else if (!strcmp(var, "trace.args_alignment")) {
4657 int args_alignment = 0;
4658 if (perf_config_int(&args_alignment, var, value) == 0)
4659 trace->args_alignment = args_alignment;
4660 } else if (!strcmp(var, "trace.tracepoint_beautifiers")) {
4661 if (strcasecmp(value, "libtraceevent") == 0)
4662 trace->libtraceevent_print = true;
4663 else if (strcasecmp(value, "libbeauty") == 0)
4664 trace->libtraceevent_print = false;
4666 out:
4667 return err;
4670 int cmd_trace(int argc, const char **argv)
4672 const char *trace_usage[] = {
4673 "perf trace [<options>] [<command>]",
4674 "perf trace [<options>] -- <command> [<options>]",
4675 "perf trace record [<options>] [<command>]",
4676 "perf trace record [<options>] -- <command> [<options>]",
4677 NULL
4679 struct trace trace = {
4680 .opts = {
4681 .target = {
4682 .uid = UINT_MAX,
4683 .uses_mmap = true,
4685 .user_freq = UINT_MAX,
4686 .user_interval = ULLONG_MAX,
4687 .no_buffering = true,
4688 .mmap_pages = UINT_MAX,
4690 .output = stderr,
4691 .show_comm = true,
4692 .show_tstamp = true,
4693 .show_duration = true,
4694 .show_arg_names = true,
4695 .args_alignment = 70,
4696 .trace_syscalls = false,
4697 .kernel_syscallchains = false,
4698 .max_stack = UINT_MAX,
4699 .max_events = ULONG_MAX,
4701 const char *map_dump_str = NULL;
4702 const char *output_name = NULL;
4703 const struct option trace_options[] = {
4704 OPT_CALLBACK('e', "event", &trace, "event",
4705 "event/syscall selector. use 'perf list' to list available events",
4706 trace__parse_events_option),
4707 OPT_CALLBACK(0, "filter", &trace.evlist, "filter",
4708 "event filter", parse_filter),
4709 OPT_BOOLEAN(0, "comm", &trace.show_comm,
4710 "show the thread COMM next to its id"),
4711 OPT_BOOLEAN(0, "tool_stats", &trace.show_tool_stats, "show tool stats"),
4712 OPT_CALLBACK(0, "expr", &trace, "expr", "list of syscalls/events to trace",
4713 trace__parse_events_option),
4714 OPT_STRING('o', "output", &output_name, "file", "output file name"),
4715 OPT_STRING('i', "input", &input_name, "file", "Analyze events in file"),
4716 OPT_STRING('p', "pid", &trace.opts.target.pid, "pid",
4717 "trace events on existing process id"),
4718 OPT_STRING('t', "tid", &trace.opts.target.tid, "tid",
4719 "trace events on existing thread id"),
4720 OPT_CALLBACK(0, "filter-pids", &trace, "CSV list of pids",
4721 "pids to filter (by the kernel)", trace__set_filter_pids_from_option),
4722 OPT_BOOLEAN('a', "all-cpus", &trace.opts.target.system_wide,
4723 "system-wide collection from all CPUs"),
4724 OPT_STRING('C', "cpu", &trace.opts.target.cpu_list, "cpu",
4725 "list of cpus to monitor"),
4726 OPT_BOOLEAN(0, "no-inherit", &trace.opts.no_inherit,
4727 "child tasks do not inherit counters"),
4728 OPT_CALLBACK('m', "mmap-pages", &trace.opts.mmap_pages, "pages",
4729 "number of mmap data pages",
4730 perf_evlist__parse_mmap_pages),
4731 OPT_STRING('u', "uid", &trace.opts.target.uid_str, "user",
4732 "user to profile"),
4733 OPT_CALLBACK(0, "duration", &trace, "float",
4734 "show only events with duration > N.M ms",
4735 trace__set_duration),
4736 #ifdef HAVE_LIBBPF_SUPPORT
4737 OPT_STRING(0, "map-dump", &map_dump_str, "BPF map", "BPF map to periodically dump"),
4738 #endif
4739 OPT_BOOLEAN(0, "sched", &trace.sched, "show blocking scheduler events"),
4740 OPT_INCR('v', "verbose", &verbose, "be more verbose"),
4741 OPT_BOOLEAN('T', "time", &trace.full_time,
4742 "Show full timestamp, not time relative to first start"),
4743 OPT_BOOLEAN(0, "failure", &trace.failure_only,
4744 "Show only syscalls that failed"),
4745 OPT_BOOLEAN('s', "summary", &trace.summary_only,
4746 "Show only syscall summary with statistics"),
4747 OPT_BOOLEAN('S', "with-summary", &trace.summary,
4748 "Show all syscalls and summary with statistics"),
4749 OPT_BOOLEAN(0, "errno-summary", &trace.errno_summary,
4750 "Show errno stats per syscall, use with -s or -S"),
4751 OPT_CALLBACK_DEFAULT('F', "pf", &trace.trace_pgfaults, "all|maj|min",
4752 "Trace pagefaults", parse_pagefaults, "maj"),
4753 OPT_BOOLEAN(0, "syscalls", &trace.trace_syscalls, "Trace syscalls"),
4754 OPT_BOOLEAN('f', "force", &trace.force, "don't complain, do it"),
4755 OPT_CALLBACK(0, "call-graph", &trace.opts,
4756 "record_mode[,record_size]", record_callchain_help,
4757 &record_parse_callchain_opt),
4758 OPT_BOOLEAN(0, "libtraceevent_print", &trace.libtraceevent_print,
4759 "Use libtraceevent to print the tracepoint arguments."),
4760 OPT_BOOLEAN(0, "kernel-syscall-graph", &trace.kernel_syscallchains,
4761 "Show the kernel callchains on the syscall exit path"),
4762 OPT_ULONG(0, "max-events", &trace.max_events,
4763 "Set the maximum number of events to print, exit after that is reached. "),
4764 OPT_UINTEGER(0, "min-stack", &trace.min_stack,
4765 "Set the minimum stack depth when parsing the callchain, "
4766 "anything below the specified depth will be ignored."),
4767 OPT_UINTEGER(0, "max-stack", &trace.max_stack,
4768 "Set the maximum stack depth when parsing the callchain, "
4769 "anything beyond the specified depth will be ignored. "
4770 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
4771 OPT_BOOLEAN(0, "sort-events", &trace.sort_events,
4772 "Sort batch of events before processing, use if getting out of order events"),
4773 OPT_BOOLEAN(0, "print-sample", &trace.print_sample,
4774 "print the PERF_RECORD_SAMPLE PERF_SAMPLE_ info, for debugging"),
4775 OPT_UINTEGER(0, "proc-map-timeout", &proc_map_timeout,
4776 "per thread proc mmap processing timeout in ms"),
4777 OPT_CALLBACK('G', "cgroup", &trace, "name", "monitor event in cgroup name only",
4778 trace__parse_cgroups),
4779 OPT_UINTEGER('D', "delay", &trace.opts.initial_delay,
4780 "ms to wait before starting measurement after program "
4781 "start"),
4782 OPTS_EVSWITCH(&trace.evswitch),
4783 OPT_END()
4785 bool __maybe_unused max_stack_user_set = true;
4786 bool mmap_pages_user_set = true;
4787 struct evsel *evsel;
4788 const char * const trace_subcommands[] = { "record", NULL };
4789 int err = -1;
4790 char bf[BUFSIZ];
4792 signal(SIGSEGV, sighandler_dump_stack);
4793 signal(SIGFPE, sighandler_dump_stack);
4795 trace.evlist = evlist__new();
4796 trace.sctbl = syscalltbl__new();
4798 if (trace.evlist == NULL || trace.sctbl == NULL) {
4799 pr_err("Not enough memory to run!\n");
4800 err = -ENOMEM;
4801 goto out;
4805 * Parsing .perfconfig may entail creating a BPF event, that may need
4806 * to create BPF maps, so bump RLIM_MEMLOCK as the default 64K setting
4807 * is too small. This affects just this process, not touching the
4808 * global setting. If it fails we'll get something in 'perf trace -v'
4809 * to help diagnose the problem.
4811 rlimit__bump_memlock();
4813 err = perf_config(trace__config, &trace);
4814 if (err)
4815 goto out;
4817 argc = parse_options_subcommand(argc, argv, trace_options, trace_subcommands,
4818 trace_usage, PARSE_OPT_STOP_AT_NON_OPTION);
4821 * Here we already passed thru trace__parse_events_option() and it has
4822 * already figured out if -e syscall_name, if not but if --event
4823 * foo:bar was used, the user is interested _just_ in those, say,
4824 * tracepoint events, not in the strace-like syscall-name-based mode.
4826 * This is important because we need to check if strace-like mode is
4827 * needed to decided if we should filter out the eBPF
4828 * __augmented_syscalls__ code, if it is in the mix, say, via
4829 * .perfconfig trace.add_events, and filter those out.
4831 if (!trace.trace_syscalls && !trace.trace_pgfaults &&
4832 trace.evlist->core.nr_entries == 0 /* Was --events used? */) {
4833 trace.trace_syscalls = true;
4836 * Now that we have --verbose figured out, lets see if we need to parse
4837 * events from .perfconfig, so that if those events fail parsing, say some
4838 * BPF program fails, then we'll be able to use --verbose to see what went
4839 * wrong in more detail.
4841 if (trace.perfconfig_events != NULL) {
4842 struct parse_events_error parse_err;
4844 bzero(&parse_err, sizeof(parse_err));
4845 err = parse_events(trace.evlist, trace.perfconfig_events, &parse_err);
4846 if (err) {
4847 parse_events_print_error(&parse_err, trace.perfconfig_events);
4848 goto out;
4852 if ((nr_cgroups || trace.cgroup) && !trace.opts.target.system_wide) {
4853 usage_with_options_msg(trace_usage, trace_options,
4854 "cgroup monitoring only available in system-wide mode");
4857 evsel = bpf__setup_output_event(trace.evlist, "__augmented_syscalls__");
4858 if (IS_ERR(evsel)) {
4859 bpf__strerror_setup_output_event(trace.evlist, PTR_ERR(evsel), bf, sizeof(bf));
4860 pr_err("ERROR: Setup trace syscalls enter failed: %s\n", bf);
4861 goto out;
4864 if (evsel) {
4865 trace.syscalls.events.augmented = evsel;
4867 evsel = perf_evlist__find_tracepoint_by_name(trace.evlist, "raw_syscalls:sys_enter");
4868 if (evsel == NULL) {
4869 pr_err("ERROR: raw_syscalls:sys_enter not found in the augmented BPF object\n");
4870 goto out;
4873 if (evsel->bpf_obj == NULL) {
4874 pr_err("ERROR: raw_syscalls:sys_enter not associated to a BPF object\n");
4875 goto out;
4878 trace.bpf_obj = evsel->bpf_obj;
4881 * If we have _just_ the augmenter event but don't have a
4882 * explicit --syscalls, then assume we want all strace-like
4883 * syscalls:
4885 if (!trace.trace_syscalls && trace__only_augmented_syscalls_evsels(&trace))
4886 trace.trace_syscalls = true;
4888 * So, if we have a syscall augmenter, but trace_syscalls, aka
4889 * strace-like syscall tracing is not set, then we need to trow
4890 * away the augmenter, i.e. all the events that were created
4891 * from that BPF object file.
4893 * This is more to fix the current .perfconfig trace.add_events
4894 * style of setting up the strace-like eBPF based syscall point
4895 * payload augmenter.
4897 * All this complexity will be avoided by adding an alternative
4898 * to trace.add_events in the form of
4899 * trace.bpf_augmented_syscalls, that will be only parsed if we
4900 * need it.
4902 * .perfconfig trace.add_events is still useful if we want, for
4903 * instance, have msr_write.msr in some .perfconfig profile based
4904 * 'perf trace --config determinism.profile' mode, where for some
4905 * particular goal/workload type we want a set of events and
4906 * output mode (with timings, etc) instead of having to add
4907 * all via the command line.
4909 * Also --config to specify an alternate .perfconfig file needs
4910 * to be implemented.
4912 if (!trace.trace_syscalls) {
4913 trace__delete_augmented_syscalls(&trace);
4914 } else {
4915 trace__set_bpf_map_filtered_pids(&trace);
4916 trace__set_bpf_map_syscalls(&trace);
4917 trace.syscalls.unaugmented_prog = trace__find_bpf_program_by_title(&trace, "!raw_syscalls:unaugmented");
4921 err = bpf__setup_stdout(trace.evlist);
4922 if (err) {
4923 bpf__strerror_setup_stdout(trace.evlist, err, bf, sizeof(bf));
4924 pr_err("ERROR: Setup BPF stdout failed: %s\n", bf);
4925 goto out;
4928 err = -1;
4930 if (map_dump_str) {
4931 trace.dump.map = trace__find_bpf_map_by_name(&trace, map_dump_str);
4932 if (trace.dump.map == NULL) {
4933 pr_err("ERROR: BPF map \"%s\" not found\n", map_dump_str);
4934 goto out;
4938 if (trace.trace_pgfaults) {
4939 trace.opts.sample_address = true;
4940 trace.opts.sample_time = true;
4943 if (trace.opts.mmap_pages == UINT_MAX)
4944 mmap_pages_user_set = false;
4946 if (trace.max_stack == UINT_MAX) {
4947 trace.max_stack = input_name ? PERF_MAX_STACK_DEPTH : sysctl__max_stack();
4948 max_stack_user_set = false;
4951 #ifdef HAVE_DWARF_UNWIND_SUPPORT
4952 if ((trace.min_stack || max_stack_user_set) && !callchain_param.enabled) {
4953 record_opts__parse_callchain(&trace.opts, &callchain_param, "dwarf", false);
4955 #endif
4957 if (callchain_param.enabled) {
4958 if (!mmap_pages_user_set && geteuid() == 0)
4959 trace.opts.mmap_pages = perf_event_mlock_kb_in_pages() * 4;
4961 symbol_conf.use_callchain = true;
4964 if (trace.evlist->core.nr_entries > 0) {
4965 evlist__set_default_evsel_handler(trace.evlist, trace__event_handler);
4966 if (evlist__set_syscall_tp_fields(trace.evlist)) {
4967 perror("failed to set syscalls:* tracepoint fields");
4968 goto out;
4972 if (trace.sort_events) {
4973 ordered_events__init(&trace.oe.data, ordered_events__deliver_event, &trace);
4974 ordered_events__set_copy_on_queue(&trace.oe.data, true);
4978 * If we are augmenting syscalls, then combine what we put in the
4979 * __augmented_syscalls__ BPF map with what is in the
4980 * syscalls:sys_exit_FOO tracepoints, i.e. just like we do without BPF,
4981 * combining raw_syscalls:sys_enter with raw_syscalls:sys_exit.
4983 * We'll switch to look at two BPF maps, one for sys_enter and the
4984 * other for sys_exit when we start augmenting the sys_exit paths with
4985 * buffers that are being copied from kernel to userspace, think 'read'
4986 * syscall.
4988 if (trace.syscalls.events.augmented) {
4989 evlist__for_each_entry(trace.evlist, evsel) {
4990 bool raw_syscalls_sys_exit = strcmp(perf_evsel__name(evsel), "raw_syscalls:sys_exit") == 0;
4992 if (raw_syscalls_sys_exit) {
4993 trace.raw_augmented_syscalls = true;
4994 goto init_augmented_syscall_tp;
4997 if (trace.syscalls.events.augmented->priv == NULL &&
4998 strstr(perf_evsel__name(evsel), "syscalls:sys_enter")) {
4999 struct evsel *augmented = trace.syscalls.events.augmented;
5000 if (perf_evsel__init_augmented_syscall_tp(augmented, evsel) ||
5001 perf_evsel__init_augmented_syscall_tp_args(augmented))
5002 goto out;
5004 * Augmented is __augmented_syscalls__ BPF_OUTPUT event
5005 * Above we made sure we can get from the payload the tp fields
5006 * that we get from syscalls:sys_enter tracefs format file.
5008 augmented->handler = trace__sys_enter;
5010 * Now we do the same for the *syscalls:sys_enter event so that
5011 * if we handle it directly, i.e. if the BPF prog returns 0 so
5012 * as not to filter it, then we'll handle it just like we would
5013 * for the BPF_OUTPUT one:
5015 if (perf_evsel__init_augmented_syscall_tp(evsel, evsel) ||
5016 perf_evsel__init_augmented_syscall_tp_args(evsel))
5017 goto out;
5018 evsel->handler = trace__sys_enter;
5021 if (strstarts(perf_evsel__name(evsel), "syscalls:sys_exit_")) {
5022 struct syscall_tp *sc;
5023 init_augmented_syscall_tp:
5024 if (perf_evsel__init_augmented_syscall_tp(evsel, evsel))
5025 goto out;
5026 sc = __evsel__syscall_tp(evsel);
5028 * For now with BPF raw_augmented we hook into
5029 * raw_syscalls:sys_enter and there we get all
5030 * 6 syscall args plus the tracepoint common
5031 * fields and the syscall_nr (another long).
5032 * So we check if that is the case and if so
5033 * don't look after the sc->args_size but
5034 * always after the full raw_syscalls:sys_enter
5035 * payload, which is fixed.
5037 * We'll revisit this later to pass
5038 * s->args_size to the BPF augmenter (now
5039 * tools/perf/examples/bpf/augmented_raw_syscalls.c,
5040 * so that it copies only what we need for each
5041 * syscall, like what happens when we use
5042 * syscalls:sys_enter_NAME, so that we reduce
5043 * the kernel/userspace traffic to just what is
5044 * needed for each syscall.
5046 if (trace.raw_augmented_syscalls)
5047 trace.raw_augmented_syscalls_args_size = (6 + 1) * sizeof(long) + sc->id.offset;
5048 perf_evsel__init_augmented_syscall_tp_ret(evsel);
5049 evsel->handler = trace__sys_exit;
5054 if ((argc >= 1) && (strcmp(argv[0], "record") == 0))
5055 return trace__record(&trace, argc-1, &argv[1]);
5057 /* Using just --errno-summary will trigger --summary */
5058 if (trace.errno_summary && !trace.summary && !trace.summary_only)
5059 trace.summary_only = true;
5061 /* summary_only implies summary option, but don't overwrite summary if set */
5062 if (trace.summary_only)
5063 trace.summary = trace.summary_only;
5065 if (output_name != NULL) {
5066 err = trace__open_output(&trace, output_name);
5067 if (err < 0) {
5068 perror("failed to create output file");
5069 goto out;
5073 err = evswitch__init(&trace.evswitch, trace.evlist, stderr);
5074 if (err)
5075 goto out_close;
5077 err = target__validate(&trace.opts.target);
5078 if (err) {
5079 target__strerror(&trace.opts.target, err, bf, sizeof(bf));
5080 fprintf(trace.output, "%s", bf);
5081 goto out_close;
5084 err = target__parse_uid(&trace.opts.target);
5085 if (err) {
5086 target__strerror(&trace.opts.target, err, bf, sizeof(bf));
5087 fprintf(trace.output, "%s", bf);
5088 goto out_close;
5091 if (!argc && target__none(&trace.opts.target))
5092 trace.opts.target.system_wide = true;
5094 if (input_name)
5095 err = trace__replay(&trace);
5096 else
5097 err = trace__run(&trace, argc, argv);
5099 out_close:
5100 if (output_name != NULL)
5101 fclose(trace.output);
5102 out:
5103 zfree(&trace.perfconfig_events);
5104 return err;