trace/beauty/beauty.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef _PERF_TRACE_BEAUTY_H
0003 #define _PERF_TRACE_BEAUTY_H
0004
0005 #include <linux/kernel.h>
0006 #include <linux/types.h>
0007 #include <sys/types.h>
0008 #include <stdbool.h>
0009
0010 struct strarray {
0011     u64     offset;
0012     int     nr_entries;
0013     const char *prefix;
0014     const char **entries;
0015 };
0016
0017 #define DEFINE_STRARRAY(array, _prefix) struct strarray strarray__##array = { \
0018     .nr_entries = ARRAY_SIZE(array), \
0019     .entries = array, \
0020     .prefix = _prefix, \
0021 }
0022
0023 #define DEFINE_STRARRAY_OFFSET(array, _prefix, off) struct strarray strarray__##array = { \
0024     .offset     = off, \
0025     .nr_entries = ARRAY_SIZE(array), \
0026     .entries = array, \
0027     .prefix = _prefix, \
0028 }
0029
0030 size_t strarray__scnprintf(struct strarray *sa, char *bf, size_t size, const char *intfmt, bool show_prefix, int val);
0031 size_t strarray__scnprintf_suffix(struct strarray *sa, char *bf, size_t size, const char *intfmt, bool show_suffix, int val);
0032 size_t strarray__scnprintf_flags(struct strarray *sa, char *bf, size_t size, bool show_prefix, unsigned long flags);
0033
0034 bool strarray__strtoul(struct strarray *sa, char *bf, size_t size, u64 *ret);
0035 bool strarray__strtoul_flags(struct strarray *sa, char *bf, size_t size, u64 *ret);
0036
0037 struct trace;
0038 struct thread;
0039
0040 struct file {
0041     char *pathname;
0042     int  dev_maj;
0043 };
0044
0045 struct file *thread__files_entry(struct thread *thread, int fd);
0046
0047 struct strarrays {
0048     int     nr_entries;
0049     struct strarray **entries;
0050 };
0051
0052 #define DEFINE_STRARRAYS(array) struct strarrays strarrays__##array = { \
0053     .nr_entries = ARRAY_SIZE(array), \
0054     .entries = array, \
0055 }
0056
0057 size_t strarrays__scnprintf(struct strarrays *sas, char *bf, size_t size, const char *intfmt, bool show_prefix, int val);
0058
0059 bool strarrays__strtoul(struct strarrays *sas, char *bf, size_t size, u64 *ret);
0060
0061 size_t pid__scnprintf_fd(struct trace *trace, pid_t pid, int fd, char *bf, size_t size);
0062
0063 extern struct strarray strarray__socket_families;
0064
0065 extern struct strarray strarray__socket_level;
0066
0067 /**
0068  * augmented_arg: extra payload for syscall pointer arguments
0069
0070  * If perf_sample->raw_size is more than what a syscall sys_enter_FOO puts,
0071  * then its the arguments contents, so that we can show more than just a
0072  * pointer. This will be done initially with eBPF, the start of that is at the
0073  * tools/perf/examples/bpf/augmented_syscalls.c example for the openat, but
0074  * will eventually be done automagically caching the running kernel tracefs
0075  * events data into an eBPF C script, that then gets compiled and its .o file
0076  * cached for subsequent use. For char pointers like the ones for 'open' like
0077  * syscalls its easy, for the rest we should use DWARF or better, BTF, much
0078  * more compact.
0079  *
0080  * @size: 8 if all we need is an integer, otherwise all of the augmented arg.
0081  * @int_arg: will be used for integer like pointer contents, like 'accept's 'upeer_addrlen'
0082  * @value: u64 aligned, for structs, pathnames
0083  */
0084 struct augmented_arg {
0085     int  size;
0086     int  int_arg;
0087     u64  value[];
0088 };
0089
0090 struct syscall_arg_fmt;
0091
0092 /**
0093  * @val: value of syscall argument being formatted
0094  * @len: for tracepoint dynamic arrays, if fmt->nr_entries == 0, then its not a fixed array, look at arg->len
0095  * @args: All the args, use syscall_args__val(arg, nth) to access one
0096  * @augmented_args: Extra data that can be collected, for instance, with eBPF for expanding the pathname for open, etc
0097  * @augmented_args_size: augmented_args total payload size
0098  * @thread: tid state (maps, pid, tid, etc)
0099  * @trace: 'perf trace' internals: all threads, etc
0100  * @parm: private area, may be an strarray, for instance
0101  * @idx: syscall arg idx (is this the first?)
0102  * @mask: a syscall arg may mask another arg, see syscall_arg__scnprintf_futex_op
0103  * @show_string_prefix: When there is a common prefix in a string table, show it or not
0104  */
0105
0106 struct syscall_arg {
0107     unsigned long val;
0108     unsigned char *args;
0109     struct syscall_arg_fmt *fmt;
0110     struct {
0111         struct augmented_arg *args;
0112         int          size;
0113     } augmented;
0114     struct thread *thread;
0115     struct trace  *trace;
0116     void          *parm;
0117     u16       len;
0118     u8        idx;
0119     u8        mask;
0120     bool          show_string_prefix;
0121 };
0122
0123 unsigned long syscall_arg__val(struct syscall_arg *arg, u8 idx);
0124
0125 size_t syscall_arg__scnprintf_strarray_flags(char *bf, size_t size, struct syscall_arg *arg);
0126 #define SCA_STRARRAY_FLAGS syscall_arg__scnprintf_strarray_flags
0127
0128 bool syscall_arg__strtoul_strarray(char *bf, size_t size, struct syscall_arg *arg, u64 *ret);
0129 #define STUL_STRARRAY syscall_arg__strtoul_strarray
0130
0131 bool syscall_arg__strtoul_strarray_flags(char *bf, size_t size, struct syscall_arg *arg, u64 *ret);
0132 #define STUL_STRARRAY_FLAGS syscall_arg__strtoul_strarray_flags
0133
0134 bool syscall_arg__strtoul_strarrays(char *bf, size_t size, struct syscall_arg *arg, u64 *ret);
0135 #define STUL_STRARRAYS syscall_arg__strtoul_strarrays
0136
0137 size_t syscall_arg__scnprintf_x86_irq_vectors(char *bf, size_t size, struct syscall_arg *arg);
0138 #define SCA_X86_IRQ_VECTORS syscall_arg__scnprintf_x86_irq_vectors
0139
0140 bool syscall_arg__strtoul_x86_irq_vectors(char *bf, size_t size, struct syscall_arg *arg, u64 *ret);
0141 #define STUL_X86_IRQ_VECTORS syscall_arg__strtoul_x86_irq_vectors
0142
0143 size_t syscall_arg__scnprintf_x86_MSR(char *bf, size_t size, struct syscall_arg *arg);
0144 #define SCA_X86_MSR syscall_arg__scnprintf_x86_MSR
0145
0146 bool syscall_arg__strtoul_x86_MSR(char *bf, size_t size, struct syscall_arg *arg, u64 *ret);
0147 #define STUL_X86_MSR syscall_arg__strtoul_x86_MSR
0148
0149 size_t syscall_arg__scnprintf_strarrays(char *bf, size_t size, struct syscall_arg *arg);
0150 #define SCA_STRARRAYS syscall_arg__scnprintf_strarrays
0151
0152 size_t syscall_arg__scnprintf_fd(char *bf, size_t size, struct syscall_arg *arg);
0153 #define SCA_FD syscall_arg__scnprintf_fd
0154
0155 size_t syscall_arg__scnprintf_hex(char *bf, size_t size, struct syscall_arg *arg);
0156 #define SCA_HEX syscall_arg__scnprintf_hex
0157
0158 size_t syscall_arg__scnprintf_ptr(char *bf, size_t size, struct syscall_arg *arg);
0159 #define SCA_PTR syscall_arg__scnprintf_ptr
0160
0161 size_t syscall_arg__scnprintf_int(char *bf, size_t size, struct syscall_arg *arg);
0162 #define SCA_INT syscall_arg__scnprintf_int
0163
0164 size_t syscall_arg__scnprintf_long(char *bf, size_t size, struct syscall_arg *arg);
0165 #define SCA_LONG syscall_arg__scnprintf_long
0166
0167 size_t syscall_arg__scnprintf_pid(char *bf, size_t size, struct syscall_arg *arg);
0168 #define SCA_PID syscall_arg__scnprintf_pid
0169
0170 size_t syscall_arg__scnprintf_clone_flags(char *bf, size_t size, struct syscall_arg *arg);
0171 #define SCA_CLONE_FLAGS syscall_arg__scnprintf_clone_flags
0172
0173 size_t syscall_arg__scnprintf_fcntl_cmd(char *bf, size_t size, struct syscall_arg *arg);
0174 #define SCA_FCNTL_CMD syscall_arg__scnprintf_fcntl_cmd
0175
0176 size_t syscall_arg__scnprintf_fcntl_arg(char *bf, size_t size, struct syscall_arg *arg);
0177 #define SCA_FCNTL_ARG syscall_arg__scnprintf_fcntl_arg
0178
0179 size_t syscall_arg__scnprintf_flock(char *bf, size_t size, struct syscall_arg *arg);
0180 #define SCA_FLOCK syscall_arg__scnprintf_flock
0181
0182 size_t syscall_arg__scnprintf_fsmount_attr_flags(char *bf, size_t size, struct syscall_arg *arg);
0183 #define SCA_FSMOUNT_ATTR_FLAGS syscall_arg__scnprintf_fsmount_attr_flags
0184
0185 size_t syscall_arg__scnprintf_fspick_flags(char *bf, size_t size, struct syscall_arg *arg);
0186 #define SCA_FSPICK_FLAGS syscall_arg__scnprintf_fspick_flags
0187
0188 size_t syscall_arg__scnprintf_ioctl_cmd(char *bf, size_t size, struct syscall_arg *arg);
0189 #define SCA_IOCTL_CMD syscall_arg__scnprintf_ioctl_cmd
0190
0191 size_t syscall_arg__scnprintf_kcmp_type(char *bf, size_t size, struct syscall_arg *arg);
0192 #define SCA_KCMP_TYPE syscall_arg__scnprintf_kcmp_type
0193
0194 size_t syscall_arg__scnprintf_kcmp_idx(char *bf, size_t size, struct syscall_arg *arg);
0195 #define SCA_KCMP_IDX syscall_arg__scnprintf_kcmp_idx
0196
0197 unsigned long syscall_arg__mask_val_mount_flags(struct syscall_arg *arg, unsigned long flags);
0198 #define SCAMV_MOUNT_FLAGS syscall_arg__mask_val_mount_flags
0199
0200 size_t syscall_arg__scnprintf_mount_flags(char *bf, size_t size, struct syscall_arg *arg);
0201 #define SCA_MOUNT_FLAGS syscall_arg__scnprintf_mount_flags
0202
0203 size_t syscall_arg__scnprintf_move_mount_flags(char *bf, size_t size, struct syscall_arg *arg);
0204 #define SCA_MOVE_MOUNT_FLAGS syscall_arg__scnprintf_move_mount_flags
0205
0206 size_t syscall_arg__scnprintf_pkey_alloc_access_rights(char *bf, size_t size, struct syscall_arg *arg);
0207 #define SCA_PKEY_ALLOC_ACCESS_RIGHTS syscall_arg__scnprintf_pkey_alloc_access_rights
0208
0209 size_t syscall_arg__scnprintf_open_flags(char *bf, size_t size, struct syscall_arg *arg);
0210 #define SCA_OPEN_FLAGS syscall_arg__scnprintf_open_flags
0211
0212 size_t syscall_arg__scnprintf_x86_arch_prctl_code(char *bf, size_t size, struct syscall_arg *arg);
0213 #define SCA_X86_ARCH_PRCTL_CODE syscall_arg__scnprintf_x86_arch_prctl_code
0214
0215 size_t syscall_arg__scnprintf_prctl_option(char *bf, size_t size, struct syscall_arg *arg);
0216 #define SCA_PRCTL_OPTION syscall_arg__scnprintf_prctl_option
0217
0218 extern struct strarray strarray__prctl_options;
0219
0220 size_t syscall_arg__scnprintf_prctl_arg2(char *bf, size_t size, struct syscall_arg *arg);
0221 #define SCA_PRCTL_ARG2 syscall_arg__scnprintf_prctl_arg2
0222
0223 size_t syscall_arg__scnprintf_prctl_arg3(char *bf, size_t size, struct syscall_arg *arg);
0224 #define SCA_PRCTL_ARG3 syscall_arg__scnprintf_prctl_arg3
0225
0226 size_t syscall_arg__scnprintf_renameat2_flags(char *bf, size_t size, struct syscall_arg *arg);
0227 #define SCA_RENAMEAT2_FLAGS syscall_arg__scnprintf_renameat2_flags
0228
0229 size_t syscall_arg__scnprintf_sockaddr(char *bf, size_t size, struct syscall_arg *arg);
0230 #define SCA_SOCKADDR syscall_arg__scnprintf_sockaddr
0231
0232 size_t syscall_arg__scnprintf_socket_protocol(char *bf, size_t size, struct syscall_arg *arg);
0233 #define SCA_SK_PROTO syscall_arg__scnprintf_socket_protocol
0234
0235 size_t syscall_arg__scnprintf_socket_level(char *bf, size_t size, struct syscall_arg *arg);
0236 #define SCA_SK_LEVEL syscall_arg__scnprintf_socket_level
0237
0238 size_t syscall_arg__scnprintf_statx_flags(char *bf, size_t size, struct syscall_arg *arg);
0239 #define SCA_STATX_FLAGS syscall_arg__scnprintf_statx_flags
0240
0241 size_t syscall_arg__scnprintf_statx_mask(char *bf, size_t size, struct syscall_arg *arg);
0242 #define SCA_STATX_MASK syscall_arg__scnprintf_statx_mask
0243
0244 size_t syscall_arg__scnprintf_sync_file_range_flags(char *bf, size_t size, struct syscall_arg *arg);
0245 #define SCA_SYNC_FILE_RANGE_FLAGS syscall_arg__scnprintf_sync_file_range_flags
0246
0247 size_t open__scnprintf_flags(unsigned long flags, char *bf, size_t size, bool show_prefix);
0248
0249 void syscall_arg__set_ret_scnprintf(struct syscall_arg *arg,
0250                     size_t (*ret_scnprintf)(char *bf, size_t size, struct syscall_arg *arg));
0251
0252 const char *arch_syscalls__strerrno(const char *arch, int err);
0253
0254 #endif /* _PERF_TRACE_BEAUTY_H */