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 #include <stdbool.h> 9 10 struct strarray { 11 u64 offset; 12 int nr_entries; 13 const char *prefix; 14 const char * const *entries; 15 }; 16 17 #define DEFINE_STRARRAY(array, _prefix) struct strarray strarray__##array = { \ 18 .nr_entries = ARRAY_SIZE(array), \ 19 .entries = array, \ 20 .prefix = _prefix, \ 21 } 22 23 #define DEFINE_STRARRAY_OFFSET(array, _prefix, off) struct strarray strarray__##array = { \ 24 .offset = off, \ 25 .nr_entries = ARRAY_SIZE(array), \ 26 .entries = array, \ 27 .prefix = _prefix, \ 28 } 29 30 size_t strarray__scnprintf(struct strarray *sa, char *bf, size_t size, const char *intfmt, bool show_prefix, int val); 31 size_t strarray__scnprintf_suffix(struct strarray *sa, char *bf, size_t size, const char *intfmt, bool show_suffix, int val); 32 size_t strarray__scnprintf_flags(struct strarray *sa, char *bf, size_t size, bool show_prefix, unsigned long flags); 33 34 bool strarray__strtoul(struct strarray *sa, char *bf, size_t size, u64 *ret); 35 bool strarray__strtoul_flags(struct strarray *sa, char *bf, size_t size, u64 *ret); 36 37 struct trace; 38 bool trace__show_zeros(const struct trace *trace); 39 struct machine *trace__host(const struct trace *trace); 40 struct thread; 41 42 struct file { 43 char *pathname; 44 int dev_maj; 45 }; 46 47 struct file *thread__files_entry(struct thread *thread, int fd); 48 49 struct strarrays { 50 int nr_entries; 51 struct strarray **entries; 52 }; 53 54 #define DEFINE_STRARRAYS(array) struct strarrays strarrays__##array = { \ 55 .nr_entries = ARRAY_SIZE(array), \ 56 .entries = array, \ 57 } 58 59 size_t strarrays__scnprintf(struct strarrays *sas, char *bf, size_t size, const char *intfmt, bool show_prefix, int val); 60 61 bool strarrays__strtoul(struct strarrays *sas, char *bf, size_t size, u64 *ret); 62 63 size_t pid__scnprintf_fd(struct trace *trace, pid_t pid, int fd, char *bf, size_t size); 64 65 extern struct strarray strarray__socket_families; 66 67 extern struct strarray strarray__socket_level; 68 69 /** 70 * augmented_arg: extra payload for syscall pointer arguments 71 72 * If perf_sample->raw_size is more than what a syscall sys_enter_FOO puts, then 73 * its the arguments contents, so that we can show more than just a 74 * pointer. This will be done initially with eBPF, the start of that is at the 75 * tools/perf/util/bpf_skel/augmented_syscalls.bpf.c that will eventually be 76 * done automagically caching the running kernel tracefs events data into an 77 * eBPF C script, that then gets compiled and its .o file cached for subsequent 78 * use. For char pointers like the ones for 'open' like syscalls its easy, for 79 * the rest we should use DWARF or better, BTF, much more compact. 80 * 81 * @size: 8 if all we need is an integer, otherwise all of the augmented arg. 82 * @int_arg: will be used for integer like pointer contents, like 'accept's 'upeer_addrlen' 83 * @value: u64 aligned, for structs, pathnames 84 */ 85 struct augmented_arg { 86 int size; 87 int int_arg; 88 u64 value[]; 89 }; 90 91 struct syscall_arg_fmt; 92 93 /** 94 * @val: value of syscall argument being formatted 95 * @len: for tracepoint dynamic arrays, if fmt->nr_entries == 0, then its not a fixed array, look at arg->len 96 * @args: All the args, use syscall_args__val(arg, nth) to access one 97 * @augmented_args: Extra data that can be collected, for instance, with eBPF for expanding the pathname for open, etc 98 * @augmented_args_size: augmented_args total payload size 99 * @thread: tid state (maps, pid, tid, etc) 100 * @trace: 'perf trace' internals: all threads, etc 101 * @parm: private area, may be an strarray, for instance 102 * @idx: syscall arg idx (is this the first?) 103 * @mask: a syscall arg may mask another arg, see syscall_arg__scnprintf_futex_op 104 * @show_string_prefix: When there is a common prefix in a string table, show it or not 105 */ 106 107 struct syscall_arg { 108 unsigned long val; 109 unsigned char *args; 110 struct syscall_arg_fmt *fmt; 111 struct { 112 struct augmented_arg *args; 113 int size; 114 } augmented; 115 struct thread *thread; 116 struct trace *trace; 117 void *parm; 118 char *type_name; 119 u16 len; 120 u8 idx; 121 u8 mask; 122 bool show_string_prefix; 123 }; 124 125 unsigned long syscall_arg__val(struct syscall_arg *arg, u8 idx); 126 127 size_t syscall_arg__scnprintf_strarray_flags(char *bf, size_t size, struct syscall_arg *arg); 128 #define SCA_STRARRAY_FLAGS syscall_arg__scnprintf_strarray_flags 129 130 bool syscall_arg__strtoul_strarray(char *bf, size_t size, struct syscall_arg *arg, u64 *ret); 131 #define STUL_STRARRAY syscall_arg__strtoul_strarray 132 133 bool syscall_arg__strtoul_strarray_flags(char *bf, size_t size, struct syscall_arg *arg, u64 *ret); 134 #define STUL_STRARRAY_FLAGS syscall_arg__strtoul_strarray_flags 135 136 bool syscall_arg__strtoul_strarrays(char *bf, size_t size, struct syscall_arg *arg, u64 *ret); 137 #define STUL_STRARRAYS syscall_arg__strtoul_strarrays 138 139 size_t syscall_arg__scnprintf_x86_irq_vectors(char *bf, size_t size, struct syscall_arg *arg); 140 #define SCA_X86_IRQ_VECTORS syscall_arg__scnprintf_x86_irq_vectors 141 142 bool syscall_arg__strtoul_x86_irq_vectors(char *bf, size_t size, struct syscall_arg *arg, u64 *ret); 143 #define STUL_X86_IRQ_VECTORS syscall_arg__strtoul_x86_irq_vectors 144 145 size_t syscall_arg__scnprintf_x86_MSR(char *bf, size_t size, struct syscall_arg *arg); 146 #define SCA_X86_MSR syscall_arg__scnprintf_x86_MSR 147 148 bool syscall_arg__strtoul_x86_MSR(char *bf, size_t size, struct syscall_arg *arg, u64 *ret); 149 #define STUL_X86_MSR syscall_arg__strtoul_x86_MSR 150 151 size_t syscall_arg__scnprintf_strarrays(char *bf, size_t size, struct syscall_arg *arg); 152 #define SCA_STRARRAYS syscall_arg__scnprintf_strarrays 153 154 size_t syscall_arg__scnprintf_fd(char *bf, size_t size, struct syscall_arg *arg); 155 #define SCA_FD syscall_arg__scnprintf_fd 156 157 size_t syscall_arg__scnprintf_hex(char *bf, size_t size, struct syscall_arg *arg); 158 #define SCA_HEX syscall_arg__scnprintf_hex 159 160 size_t syscall_arg__scnprintf_ptr(char *bf, size_t size, struct syscall_arg *arg); 161 #define SCA_PTR syscall_arg__scnprintf_ptr 162 163 size_t syscall_arg__scnprintf_int(char *bf, size_t size, struct syscall_arg *arg); 164 #define SCA_INT syscall_arg__scnprintf_int 165 166 size_t syscall_arg__scnprintf_long(char *bf, size_t size, struct syscall_arg *arg); 167 #define SCA_LONG syscall_arg__scnprintf_long 168 169 size_t syscall_arg__scnprintf_pid(char *bf, size_t size, struct syscall_arg *arg); 170 #define SCA_PID syscall_arg__scnprintf_pid 171 172 size_t syscall_arg__scnprintf_clone_flags(char *bf, size_t size, struct syscall_arg *arg); 173 #define SCA_CLONE_FLAGS syscall_arg__scnprintf_clone_flags 174 175 size_t syscall_arg__scnprintf_fcntl_cmd(char *bf, size_t size, struct syscall_arg *arg); 176 #define SCA_FCNTL_CMD syscall_arg__scnprintf_fcntl_cmd 177 178 size_t syscall_arg__scnprintf_fcntl_arg(char *bf, size_t size, struct syscall_arg *arg); 179 #define SCA_FCNTL_ARG syscall_arg__scnprintf_fcntl_arg 180 181 size_t syscall_arg__scnprintf_flock(char *bf, size_t size, struct syscall_arg *arg); 182 #define SCA_FLOCK syscall_arg__scnprintf_flock 183 184 size_t syscall_arg__scnprintf_fsmount_flags(char *bf, size_t size, struct syscall_arg *arg); 185 #define SCA_FSMOUNT_FLAGS syscall_arg__scnprintf_fsmount_flags 186 187 size_t syscall_arg__scnprintf_fsmount_attr_flags(char *bf, size_t size, struct syscall_arg *arg); 188 #define SCA_FSMOUNT_ATTR_FLAGS syscall_arg__scnprintf_fsmount_attr_flags 189 190 size_t syscall_arg__scnprintf_fspick_flags(char *bf, size_t size, struct syscall_arg *arg); 191 #define SCA_FSPICK_FLAGS syscall_arg__scnprintf_fspick_flags 192 193 size_t syscall_arg__scnprintf_ioctl_cmd(char *bf, size_t size, struct syscall_arg *arg); 194 #define SCA_IOCTL_CMD syscall_arg__scnprintf_ioctl_cmd 195 196 size_t syscall_arg__scnprintf_kcmp_type(char *bf, size_t size, struct syscall_arg *arg); 197 #define SCA_KCMP_TYPE syscall_arg__scnprintf_kcmp_type 198 199 size_t syscall_arg__scnprintf_kcmp_idx(char *bf, size_t size, struct syscall_arg *arg); 200 #define SCA_KCMP_IDX syscall_arg__scnprintf_kcmp_idx 201 202 unsigned long syscall_arg__mask_val_mount_flags(struct syscall_arg *arg, unsigned long flags); 203 #define SCAMV_MOUNT_FLAGS syscall_arg__mask_val_mount_flags 204 205 size_t syscall_arg__scnprintf_mount_flags(char *bf, size_t size, struct syscall_arg *arg); 206 #define SCA_MOUNT_FLAGS syscall_arg__scnprintf_mount_flags 207 208 size_t syscall_arg__scnprintf_move_mount_flags(char *bf, size_t size, struct syscall_arg *arg); 209 #define SCA_MOVE_MOUNT_FLAGS syscall_arg__scnprintf_move_mount_flags 210 211 size_t syscall_arg__scnprintf_pkey_alloc_access_rights(char *bf, size_t size, struct syscall_arg *arg); 212 #define SCA_PKEY_ALLOC_ACCESS_RIGHTS syscall_arg__scnprintf_pkey_alloc_access_rights 213 214 size_t syscall_arg__scnprintf_open_flags(char *bf, size_t size, struct syscall_arg *arg); 215 #define SCA_OPEN_FLAGS syscall_arg__scnprintf_open_flags 216 217 size_t syscall_arg__scnprintf_x86_arch_prctl_code(char *bf, size_t size, struct syscall_arg *arg); 218 #define SCA_X86_ARCH_PRCTL_CODE syscall_arg__scnprintf_x86_arch_prctl_code 219 220 size_t syscall_arg__scnprintf_prctl_option(char *bf, size_t size, struct syscall_arg *arg); 221 #define SCA_PRCTL_OPTION syscall_arg__scnprintf_prctl_option 222 223 extern struct strarray strarray__prctl_options; 224 225 size_t syscall_arg__scnprintf_prctl_arg2(char *bf, size_t size, struct syscall_arg *arg); 226 #define SCA_PRCTL_ARG2 syscall_arg__scnprintf_prctl_arg2 227 228 size_t syscall_arg__scnprintf_prctl_arg3(char *bf, size_t size, struct syscall_arg *arg); 229 #define SCA_PRCTL_ARG3 syscall_arg__scnprintf_prctl_arg3 230 231 size_t syscall_arg__scnprintf_renameat2_flags(char *bf, size_t size, struct syscall_arg *arg); 232 #define SCA_RENAMEAT2_FLAGS syscall_arg__scnprintf_renameat2_flags 233 234 size_t syscall_arg__scnprintf_sockaddr(char *bf, size_t size, struct syscall_arg *arg); 235 #define SCA_SOCKADDR syscall_arg__scnprintf_sockaddr 236 237 // 'argname' is just documentational at this point, to remove the previous comment with that info 238 #define SCA_SOCKADDR_FROM_USER(argname) \ 239 { .scnprintf = SCA_SOCKADDR, \ 240 .from_user = true, } 241 242 size_t syscall_arg__scnprintf_socket_protocol(char *bf, size_t size, struct syscall_arg *arg); 243 #define SCA_SK_PROTO syscall_arg__scnprintf_socket_protocol 244 245 size_t syscall_arg__scnprintf_socket_level(char *bf, size_t size, struct syscall_arg *arg); 246 #define SCA_SK_LEVEL syscall_arg__scnprintf_socket_level 247 248 size_t syscall_arg__scnprintf_fs_at_flags(char *bf, size_t size, struct syscall_arg *arg); 249 #define SCA_FS_AT_FLAGS syscall_arg__scnprintf_fs_at_flags 250 251 size_t syscall_arg__scnprintf_faccessat2_flags(char *bf, size_t size, struct syscall_arg *arg); 252 #define SCA_FACCESSAT2_FLAGS syscall_arg__scnprintf_faccessat2_flags 253 254 size_t syscall_arg__scnprintf_statx_mask(char *bf, size_t size, struct syscall_arg *arg); 255 #define SCA_STATX_MASK syscall_arg__scnprintf_statx_mask 256 257 size_t syscall_arg__scnprintf_sync_file_range_flags(char *bf, size_t size, struct syscall_arg *arg); 258 #define SCA_SYNC_FILE_RANGE_FLAGS syscall_arg__scnprintf_sync_file_range_flags 259 260 size_t syscall_arg__scnprintf_timespec(char *bf, size_t size, struct syscall_arg *arg); 261 #define SCA_TIMESPEC syscall_arg__scnprintf_timespec 262 263 // 'argname' is just documentational at this point, to remove the previous comment with that info 264 #define SCA_TIMESPEC_FROM_USER(argname) \ 265 { .scnprintf = SCA_TIMESPEC, \ 266 .from_user = true, } 267 268 size_t open__scnprintf_flags(unsigned long flags, char *bf, size_t size, bool show_prefix); 269 270 void syscall_arg__set_ret_scnprintf(struct syscall_arg *arg, 271 size_t (*ret_scnprintf)(char *bf, size_t size, struct syscall_arg *arg)); 272 273 extern struct strarray strarray__fsconfig_cmds; 274 275 size_t syscall_arg__scnprintf_eventfd_flags(char *bf, size_t size, struct syscall_arg *arg); 276 #define SCA_EFD_FLAGS syscall_arg__scnprintf_eventfd_flags 277 278 size_t syscall_arg__scnprintf_futex_op(char *bf, size_t size, struct syscall_arg *arg); 279 #define SCA_FUTEX_OP syscall_arg__scnprintf_futex_op 280 281 size_t syscall_arg__scnprintf_futex_val3(char *bf, size_t size, struct syscall_arg *arg); 282 #define SCA_FUTEX_VAL3 syscall_arg__scnprintf_futex_val3 283 284 size_t syscall_arg__scnprintf_mmap_prot(char *bf, size_t size, struct syscall_arg *arg); 285 #define SCA_MMAP_PROT syscall_arg__scnprintf_mmap_prot 286 287 extern struct strarray strarray__mmap_flags; 288 289 size_t syscall_arg__scnprintf_mmap_flags(char *bf, size_t size, struct syscall_arg *arg); 290 #define SCA_MMAP_FLAGS syscall_arg__scnprintf_mmap_flags 291 292 size_t syscall_arg__scnprintf_mremap_flags(char *bf, size_t size, struct syscall_arg *arg); 293 #define SCA_MREMAP_FLAGS syscall_arg__scnprintf_mremap_flags 294 295 size_t syscall_arg__scnprintf_madvise_behavior(char *bf, size_t size, struct syscall_arg *arg); 296 #define SCA_MADV_BHV syscall_arg__scnprintf_madvise_behavior 297 298 size_t syscall_arg__scnprintf_mode_t(char *bf, size_t size, struct syscall_arg *arg); 299 #define SCA_MODE_T syscall_arg__scnprintf_mode_t 300 301 size_t syscall_arg__scnprintf_msg_flags(char *bf, size_t size, struct syscall_arg *arg); 302 #define SCA_MSG_FLAGS syscall_arg__scnprintf_msg_flags 303 304 size_t syscall_arg__scnprintf_perf_flags(char *bf, size_t size, struct syscall_arg *arg); 305 #define SCA_PERF_FLAGS syscall_arg__scnprintf_perf_flags 306 307 size_t syscall_arg__scnprintf_perf_event_attr(char *bf, size_t size, struct syscall_arg *arg); 308 #define SCA_PERF_ATTR syscall_arg__scnprintf_perf_event_attr 309 #define SCA_PERF_ATTR_FROM_USER(argname) \ 310 { .scnprintf = SCA_PERF_ATTR, \ 311 .from_user = true, } 312 313 size_t syscall_arg__scnprintf_sched_policy(char *bf, size_t size, struct syscall_arg *arg); 314 #define SCA_SCHED_POLICY syscall_arg__scnprintf_sched_policy 315 316 size_t syscall_arg__scnprintf_seccomp_op(char *bf, size_t size, struct syscall_arg *arg); 317 #define SCA_SECCOMP_OP syscall_arg__scnprintf_seccomp_op 318 319 size_t syscall_arg__scnprintf_seccomp_flags(char *bf, size_t size, struct syscall_arg *arg); 320 #define SCA_SECCOMP_FLAGS syscall_arg__scnprintf_seccomp_flags 321 322 size_t syscall_arg__scnprintf_signum(char *bf, size_t size, struct syscall_arg *arg); 323 #define SCA_SIGNUM syscall_arg__scnprintf_signum 324 325 size_t syscall_arg__scnprintf_socket_type(char *bf, size_t size, struct syscall_arg *arg); 326 #define SCA_SK_TYPE syscall_arg__scnprintf_socket_type 327 328 size_t syscall_arg__scnprintf_waitid_options(char *bf, size_t size, struct syscall_arg *arg); 329 #define SCA_WAITID_OPTIONS syscall_arg__scnprintf_waitid_options 330 331 #endif /* _PERF_TRACE_BEAUTY_H */ 332