1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _PERF_TRACE_BEAUTY_H 3 #define _PERF_TRACE_BEAUTY_H 4 5 #include <linux/kernel.h> 6 #include <linux/types.h> 7 #include <sys/types.h> 8 9 struct strarray { 10 int offset; 11 int nr_entries; 12 const char **entries; 13 }; 14 15 #define DEFINE_STRARRAY(array) struct strarray strarray__##array = { \ 16 .nr_entries = ARRAY_SIZE(array), \ 17 .entries = array, \ 18 } 19 20 #define DEFINE_STRARRAY_OFFSET(array, off) struct strarray strarray__##array = { \ 21 .offset = off, \ 22 .nr_entries = ARRAY_SIZE(array), \ 23 .entries = array, \ 24 } 25 26 size_t strarray__scnprintf(struct strarray *sa, char *bf, size_t size, const char *intfmt, int val); 27 28 struct trace; 29 struct thread; 30 31 size_t pid__scnprintf_fd(struct trace *trace, pid_t pid, int fd, char *bf, size_t size); 32 33 extern struct strarray strarray__socket_families; 34 35 /** 36 * augmented_arg: extra payload for syscall pointer arguments 37 38 * If perf_sample->raw_size is more than what a syscall sys_enter_FOO puts, 39 * then its the arguments contents, so that we can show more than just a 40 * pointer. This will be done initially with eBPF, the start of that is at the 41 * tools/perf/examples/bpf/augmented_syscalls.c example for the openat, but 42 * will eventually be done automagically caching the running kernel tracefs 43 * events data into an eBPF C script, that then gets compiled and its .o file 44 * cached for subsequent use. For char pointers like the ones for 'open' like 45 * syscalls its easy, for the rest we should use DWARF or better, BTF, much 46 * more compact. 47 * 48 * @size: 8 if all we need is an integer, otherwise all of the augmented arg. 49 * @int_arg: will be used for integer like pointer contents, like 'accept's 'upeer_addrlen' 50 * @value: u64 aligned, for structs, pathnames 51 */ 52 struct augmented_arg { 53 int size; 54 int int_arg; 55 u64 value[]; 56 }; 57 58 /** 59 * @val: value of syscall argument being formatted 60 * @args: All the args, use syscall_args__val(arg, nth) to access one 61 * @augmented_args: Extra data that can be collected, for instance, with eBPF for expanding the pathname for open, etc 62 * @augmented_args_size: augmented_args total payload size 63 * @thread: tid state (maps, pid, tid, etc) 64 * @trace: 'perf trace' internals: all threads, etc 65 * @parm: private area, may be an strarray, for instance 66 * @idx: syscall arg idx (is this the first?) 67 * @mask: a syscall arg may mask another arg, see syscall_arg__scnprintf_futex_op 68 */ 69 70 struct syscall_arg { 71 unsigned long val; 72 unsigned char *args; 73 struct { 74 struct augmented_arg *args; 75 int size; 76 } augmented; 77 struct thread *thread; 78 struct trace *trace; 79 void *parm; 80 u8 idx; 81 u8 mask; 82 }; 83 84 unsigned long syscall_arg__val(struct syscall_arg *arg, u8 idx); 85 86 size_t syscall_arg__scnprintf_strarrays(char *bf, size_t size, struct syscall_arg *arg); 87 #define SCA_STRARRAYS syscall_arg__scnprintf_strarrays 88 89 size_t syscall_arg__scnprintf_fd(char *bf, size_t size, struct syscall_arg *arg); 90 #define SCA_FD syscall_arg__scnprintf_fd 91 92 size_t syscall_arg__scnprintf_hex(char *bf, size_t size, struct syscall_arg *arg); 93 #define SCA_HEX syscall_arg__scnprintf_hex 94 95 size_t syscall_arg__scnprintf_int(char *bf, size_t size, struct syscall_arg *arg); 96 #define SCA_INT syscall_arg__scnprintf_int 97 98 size_t syscall_arg__scnprintf_long(char *bf, size_t size, struct syscall_arg *arg); 99 #define SCA_LONG syscall_arg__scnprintf_long 100 101 size_t syscall_arg__scnprintf_pid(char *bf, size_t size, struct syscall_arg *arg); 102 #define SCA_PID syscall_arg__scnprintf_pid 103 104 size_t syscall_arg__scnprintf_clone_flags(char *bf, size_t size, struct syscall_arg *arg); 105 #define SCA_CLONE_FLAGS syscall_arg__scnprintf_clone_flags 106 107 size_t syscall_arg__scnprintf_fcntl_cmd(char *bf, size_t size, struct syscall_arg *arg); 108 #define SCA_FCNTL_CMD syscall_arg__scnprintf_fcntl_cmd 109 110 size_t syscall_arg__scnprintf_fcntl_arg(char *bf, size_t size, struct syscall_arg *arg); 111 #define SCA_FCNTL_ARG syscall_arg__scnprintf_fcntl_arg 112 113 size_t syscall_arg__scnprintf_flock(char *bf, size_t size, struct syscall_arg *arg); 114 #define SCA_FLOCK syscall_arg__scnprintf_flock 115 116 size_t syscall_arg__scnprintf_ioctl_cmd(char *bf, size_t size, struct syscall_arg *arg); 117 #define SCA_IOCTL_CMD syscall_arg__scnprintf_ioctl_cmd 118 119 size_t syscall_arg__scnprintf_kcmp_type(char *bf, size_t size, struct syscall_arg *arg); 120 #define SCA_KCMP_TYPE syscall_arg__scnprintf_kcmp_type 121 122 size_t syscall_arg__scnprintf_kcmp_idx(char *bf, size_t size, struct syscall_arg *arg); 123 #define SCA_KCMP_IDX syscall_arg__scnprintf_kcmp_idx 124 125 size_t syscall_arg__scnprintf_pkey_alloc_access_rights(char *bf, size_t size, struct syscall_arg *arg); 126 #define SCA_PKEY_ALLOC_ACCESS_RIGHTS syscall_arg__scnprintf_pkey_alloc_access_rights 127 128 size_t syscall_arg__scnprintf_open_flags(char *bf, size_t size, struct syscall_arg *arg); 129 #define SCA_OPEN_FLAGS syscall_arg__scnprintf_open_flags 130 131 size_t syscall_arg__scnprintf_prctl_option(char *bf, size_t size, struct syscall_arg *arg); 132 #define SCA_PRCTL_OPTION syscall_arg__scnprintf_prctl_option 133 134 size_t syscall_arg__scnprintf_prctl_arg2(char *bf, size_t size, struct syscall_arg *arg); 135 #define SCA_PRCTL_ARG2 syscall_arg__scnprintf_prctl_arg2 136 137 size_t syscall_arg__scnprintf_prctl_arg3(char *bf, size_t size, struct syscall_arg *arg); 138 #define SCA_PRCTL_ARG3 syscall_arg__scnprintf_prctl_arg3 139 140 size_t syscall_arg__scnprintf_sockaddr(char *bf, size_t size, struct syscall_arg *arg); 141 #define SCA_SOCKADDR syscall_arg__scnprintf_sockaddr 142 143 size_t syscall_arg__scnprintf_socket_protocol(char *bf, size_t size, struct syscall_arg *arg); 144 #define SCA_SK_PROTO syscall_arg__scnprintf_socket_protocol 145 146 size_t syscall_arg__scnprintf_statx_flags(char *bf, size_t size, struct syscall_arg *arg); 147 #define SCA_STATX_FLAGS syscall_arg__scnprintf_statx_flags 148 149 size_t syscall_arg__scnprintf_statx_mask(char *bf, size_t size, struct syscall_arg *arg); 150 #define SCA_STATX_MASK syscall_arg__scnprintf_statx_mask 151 152 size_t open__scnprintf_flags(unsigned long flags, char *bf, size_t size); 153 154 void syscall_arg__set_ret_scnprintf(struct syscall_arg *arg, 155 size_t (*ret_scnprintf)(char *bf, size_t size, struct syscall_arg *arg)); 156 157 const char *arch_syscalls__strerrno(const char *arch, int err); 158 159 #endif /* _PERF_TRACE_BEAUTY_H */ 160