| 1 | // SPDX-License-Identifier: GPL-2.0 | 
|---|
| 2 | /* | 
|---|
| 3 | * Common header file for probe-based Dynamic events. | 
|---|
| 4 | * | 
|---|
| 5 | * This code was copied from kernel/trace/trace_kprobe.h written by | 
|---|
| 6 | * Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com> | 
|---|
| 7 | * | 
|---|
| 8 | * Updates to make this generic: | 
|---|
| 9 | * Copyright (C) IBM Corporation, 2010-2011 | 
|---|
| 10 | * Author:     Srikar Dronamraju | 
|---|
| 11 | */ | 
|---|
| 12 |  | 
|---|
| 13 | #include <linux/bitops.h> | 
|---|
| 14 | #include <linux/btf.h> | 
|---|
| 15 | #include <linux/cleanup.h> | 
|---|
| 16 | #include <linux/kprobes.h> | 
|---|
| 17 | #include <linux/limits.h> | 
|---|
| 18 | #include <linux/perf_event.h> | 
|---|
| 19 | #include <linux/ptrace.h> | 
|---|
| 20 | #include <linux/seq_file.h> | 
|---|
| 21 | #include <linux/slab.h> | 
|---|
| 22 | #include <linux/smp.h> | 
|---|
| 23 | #include <linux/string.h> | 
|---|
| 24 | #include <linux/stringify.h> | 
|---|
| 25 | #include <linux/tracefs.h> | 
|---|
| 26 | #include <linux/types.h> | 
|---|
| 27 | #include <linux/uaccess.h> | 
|---|
| 28 |  | 
|---|
| 29 | #include <asm/bitsperlong.h> | 
|---|
| 30 |  | 
|---|
| 31 | #include "trace.h" | 
|---|
| 32 | #include "trace_output.h" | 
|---|
| 33 |  | 
|---|
| 34 | #define MAX_TRACE_ARGS		128 | 
|---|
| 35 | #define MAX_ARGSTR_LEN		63 | 
|---|
| 36 | #define MAX_ARRAY_LEN		64 | 
|---|
| 37 | #define MAX_ARG_NAME_LEN	32 | 
|---|
| 38 | #define MAX_BTF_ARGS_LEN	128 | 
|---|
| 39 | #define MAX_DENTRY_ARGS_LEN	256 | 
|---|
| 40 | #define MAX_STRING_SIZE		PATH_MAX | 
|---|
| 41 |  | 
|---|
| 42 | /* Reserved field names */ | 
|---|
| 43 | #define FIELD_STRING_IP		"__probe_ip" | 
|---|
| 44 | #define FIELD_STRING_RETIP	"__probe_ret_ip" | 
|---|
| 45 | #define FIELD_STRING_FUNC	"__probe_func" | 
|---|
| 46 |  | 
|---|
| 47 | #undef DEFINE_FIELD | 
|---|
| 48 | #define DEFINE_FIELD(type, item, name, is_signed)			\ | 
|---|
| 49 | do {								\ | 
|---|
| 50 | ret = trace_define_field(event_call, #type, name,	\ | 
|---|
| 51 | offsetof(typeof(field), item),	\ | 
|---|
| 52 | sizeof(field.item), is_signed, \ | 
|---|
| 53 | FILTER_OTHER);			\ | 
|---|
| 54 | if (ret)						\ | 
|---|
| 55 | return ret;					\ | 
|---|
| 56 | } while (0) | 
|---|
| 57 |  | 
|---|
| 58 |  | 
|---|
| 59 | /* Flags for trace_probe */ | 
|---|
| 60 | #define TP_FLAG_TRACE		1 | 
|---|
| 61 | #define TP_FLAG_PROFILE		2 | 
|---|
| 62 |  | 
|---|
| 63 | /* data_loc: data location, compatible with u32 */ | 
|---|
| 64 | #define make_data_loc(len, offs)	\ | 
|---|
| 65 | (((u32)(len) << 16) | ((u32)(offs) & 0xffff)) | 
|---|
| 66 | #define get_loc_len(dl)		((u32)(dl) >> 16) | 
|---|
| 67 | #define get_loc_offs(dl)	((u32)(dl) & 0xffff) | 
|---|
| 68 |  | 
|---|
| 69 | static nokprobe_inline void *get_loc_data(u32 *dl, void *ent) | 
|---|
| 70 | { | 
|---|
| 71 | return (u8 *)ent + get_loc_offs(*dl); | 
|---|
| 72 | } | 
|---|
| 73 |  | 
|---|
| 74 | static nokprobe_inline u32 update_data_loc(u32 loc, int consumed) | 
|---|
| 75 | { | 
|---|
| 76 | u32 maxlen = get_loc_len(loc); | 
|---|
| 77 | u32 offset = get_loc_offs(loc); | 
|---|
| 78 |  | 
|---|
| 79 | return make_data_loc(maxlen - consumed, offset + consumed); | 
|---|
| 80 | } | 
|---|
| 81 |  | 
|---|
| 82 | /* Printing function type */ | 
|---|
| 83 | typedef int (*print_type_func_t)(struct trace_seq *, void *, void *); | 
|---|
| 84 |  | 
|---|
| 85 | enum fetch_op { | 
|---|
| 86 | FETCH_OP_NOP = 0, | 
|---|
| 87 | // Stage 1 (load) ops | 
|---|
| 88 | FETCH_OP_REG,		/* Register : .param = offset */ | 
|---|
| 89 | FETCH_OP_STACK,		/* Stack : .param = index */ | 
|---|
| 90 | FETCH_OP_STACKP,	/* Stack pointer */ | 
|---|
| 91 | FETCH_OP_RETVAL,	/* Return value */ | 
|---|
| 92 | FETCH_OP_IMM,		/* Immediate : .immediate */ | 
|---|
| 93 | FETCH_OP_COMM,		/* Current comm */ | 
|---|
| 94 | FETCH_OP_ARG,		/* Function argument : .param */ | 
|---|
| 95 | FETCH_OP_FOFFS,		/* File offset: .immediate */ | 
|---|
| 96 | FETCH_OP_DATA,		/* Allocated data: .data */ | 
|---|
| 97 | FETCH_OP_EDATA,		/* Entry data: .offset */ | 
|---|
| 98 | // Stage 2 (dereference) op | 
|---|
| 99 | FETCH_OP_DEREF,		/* Dereference: .offset */ | 
|---|
| 100 | FETCH_OP_UDEREF,	/* User-space Dereference: .offset */ | 
|---|
| 101 | // Stage 3 (store) ops | 
|---|
| 102 | FETCH_OP_ST_RAW,	/* Raw: .size */ | 
|---|
| 103 | FETCH_OP_ST_MEM,	/* Mem: .offset, .size */ | 
|---|
| 104 | FETCH_OP_ST_UMEM,	/* Mem: .offset, .size */ | 
|---|
| 105 | FETCH_OP_ST_STRING,	/* String: .offset, .size */ | 
|---|
| 106 | FETCH_OP_ST_USTRING,	/* User String: .offset, .size */ | 
|---|
| 107 | FETCH_OP_ST_SYMSTR,	/* Kernel Symbol String: .offset, .size */ | 
|---|
| 108 | FETCH_OP_ST_EDATA,	/* Store Entry Data: .offset */ | 
|---|
| 109 | // Stage 4 (modify) op | 
|---|
| 110 | FETCH_OP_MOD_BF,	/* Bitfield: .basesize, .lshift, .rshift */ | 
|---|
| 111 | // Stage 5 (loop) op | 
|---|
| 112 | FETCH_OP_LP_ARRAY,	/* Array: .param = loop count */ | 
|---|
| 113 | FETCH_OP_TP_ARG,	/* Trace Point argument */ | 
|---|
| 114 | FETCH_OP_END, | 
|---|
| 115 | FETCH_NOP_SYMBOL,	/* Unresolved Symbol holder */ | 
|---|
| 116 | }; | 
|---|
| 117 |  | 
|---|
| 118 | struct fetch_insn { | 
|---|
| 119 | enum fetch_op op; | 
|---|
| 120 | union { | 
|---|
| 121 | unsigned int param; | 
|---|
| 122 | struct { | 
|---|
| 123 | unsigned int size; | 
|---|
| 124 | int offset; | 
|---|
| 125 | }; | 
|---|
| 126 | struct { | 
|---|
| 127 | unsigned char basesize; | 
|---|
| 128 | unsigned char lshift; | 
|---|
| 129 | unsigned char rshift; | 
|---|
| 130 | }; | 
|---|
| 131 | unsigned long immediate; | 
|---|
| 132 | void *data; | 
|---|
| 133 | }; | 
|---|
| 134 | }; | 
|---|
| 135 |  | 
|---|
| 136 | /* fetch + deref*N + store + mod + end <= 16, this allows N=12, enough */ | 
|---|
| 137 | #define FETCH_INSN_MAX	16 | 
|---|
| 138 | #define FETCH_TOKEN_COMM	(-ECOMM) | 
|---|
| 139 |  | 
|---|
| 140 | /* Fetch type information table */ | 
|---|
| 141 | struct fetch_type { | 
|---|
| 142 | const char		*name;		/* Name of type */ | 
|---|
| 143 | size_t			size;		/* Byte size of type */ | 
|---|
| 144 | bool			is_signed;	/* Signed flag */ | 
|---|
| 145 | bool			is_string;	/* String flag */ | 
|---|
| 146 | print_type_func_t	print;		/* Print functions */ | 
|---|
| 147 | const char		*fmt;		/* Format string */ | 
|---|
| 148 | const char		*fmttype;	/* Name in format file */ | 
|---|
| 149 | }; | 
|---|
| 150 |  | 
|---|
| 151 | /* For defining macros, define string/string_size types */ | 
|---|
| 152 | typedef u32 string; | 
|---|
| 153 | typedef u32 string_size; | 
|---|
| 154 |  | 
|---|
| 155 | #define PRINT_TYPE_FUNC_NAME(type)	print_type_##type | 
|---|
| 156 | #define PRINT_TYPE_FMT_NAME(type)	print_type_format_##type | 
|---|
| 157 |  | 
|---|
| 158 | /* Printing  in basic type function template */ | 
|---|
| 159 | #define DECLARE_BASIC_PRINT_TYPE_FUNC(type)				\ | 
|---|
| 160 | int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, void *data, void *ent);\ | 
|---|
| 161 | extern const char PRINT_TYPE_FMT_NAME(type)[] | 
|---|
| 162 |  | 
|---|
| 163 | DECLARE_BASIC_PRINT_TYPE_FUNC(u8); | 
|---|
| 164 | DECLARE_BASIC_PRINT_TYPE_FUNC(u16); | 
|---|
| 165 | DECLARE_BASIC_PRINT_TYPE_FUNC(u32); | 
|---|
| 166 | DECLARE_BASIC_PRINT_TYPE_FUNC(u64); | 
|---|
| 167 | DECLARE_BASIC_PRINT_TYPE_FUNC(s8); | 
|---|
| 168 | DECLARE_BASIC_PRINT_TYPE_FUNC(s16); | 
|---|
| 169 | DECLARE_BASIC_PRINT_TYPE_FUNC(s32); | 
|---|
| 170 | DECLARE_BASIC_PRINT_TYPE_FUNC(s64); | 
|---|
| 171 | DECLARE_BASIC_PRINT_TYPE_FUNC(x8); | 
|---|
| 172 | DECLARE_BASIC_PRINT_TYPE_FUNC(x16); | 
|---|
| 173 | DECLARE_BASIC_PRINT_TYPE_FUNC(x32); | 
|---|
| 174 | DECLARE_BASIC_PRINT_TYPE_FUNC(x64); | 
|---|
| 175 |  | 
|---|
| 176 | DECLARE_BASIC_PRINT_TYPE_FUNC(char); | 
|---|
| 177 | DECLARE_BASIC_PRINT_TYPE_FUNC(string); | 
|---|
| 178 | DECLARE_BASIC_PRINT_TYPE_FUNC(symbol); | 
|---|
| 179 |  | 
|---|
| 180 | /* Default (unsigned long) fetch type */ | 
|---|
| 181 | #define __DEFAULT_FETCH_TYPE(t) x##t | 
|---|
| 182 | #define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t) | 
|---|
| 183 | #define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG) | 
|---|
| 184 | #define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE) | 
|---|
| 185 |  | 
|---|
| 186 | #define __ADDR_FETCH_TYPE(t) u##t | 
|---|
| 187 | #define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t) | 
|---|
| 188 | #define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG) | 
|---|
| 189 |  | 
|---|
| 190 | #define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, str, _fmttype)	\ | 
|---|
| 191 | {.name = _name,					\ | 
|---|
| 192 | .size = _size,					\ | 
|---|
| 193 | .is_signed = (bool)sign,			\ | 
|---|
| 194 | .is_string = (bool)str,			\ | 
|---|
| 195 | .print = PRINT_TYPE_FUNC_NAME(ptype),		\ | 
|---|
| 196 | .fmt = PRINT_TYPE_FMT_NAME(ptype),		\ | 
|---|
| 197 | .fmttype = _fmttype,				\ | 
|---|
| 198 | } | 
|---|
| 199 |  | 
|---|
| 200 | /* Non string types can use these macros */ | 
|---|
| 201 | #define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype)	\ | 
|---|
| 202 | __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, 0, #_fmttype) | 
|---|
| 203 | #define ASSIGN_FETCH_TYPE(ptype, ftype, sign)			\ | 
|---|
| 204 | _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype) | 
|---|
| 205 |  | 
|---|
| 206 | /* If ptype is an alias of atype, use this macro (show atype in format) */ | 
|---|
| 207 | #define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign)		\ | 
|---|
| 208 | _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype) | 
|---|
| 209 |  | 
|---|
| 210 | #define ASSIGN_FETCH_TYPE_END {} | 
|---|
| 211 | #define MAX_ARRAY_LEN	64 | 
|---|
| 212 |  | 
|---|
| 213 | #ifdef CONFIG_KPROBE_EVENTS | 
|---|
| 214 | bool trace_kprobe_on_func_entry(struct trace_event_call *call); | 
|---|
| 215 | bool trace_kprobe_error_injectable(struct trace_event_call *call); | 
|---|
| 216 | #else | 
|---|
| 217 | static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call) | 
|---|
| 218 | { | 
|---|
| 219 | return false; | 
|---|
| 220 | } | 
|---|
| 221 |  | 
|---|
| 222 | static inline bool trace_kprobe_error_injectable(struct trace_event_call *call) | 
|---|
| 223 | { | 
|---|
| 224 | return false; | 
|---|
| 225 | } | 
|---|
| 226 | #endif /* CONFIG_KPROBE_EVENTS */ | 
|---|
| 227 |  | 
|---|
| 228 | struct probe_arg { | 
|---|
| 229 | struct fetch_insn	*code; | 
|---|
| 230 | bool			dynamic;/* Dynamic array (string) is used */ | 
|---|
| 231 | unsigned int		offset;	/* Offset from argument entry */ | 
|---|
| 232 | unsigned int		count;	/* Array count */ | 
|---|
| 233 | const char		*name;	/* Name of this argument */ | 
|---|
| 234 | const char		*comm;	/* Command of this argument */ | 
|---|
| 235 | char			*fmt;	/* Format string if needed */ | 
|---|
| 236 | const struct fetch_type	*type;	/* Type of this argument */ | 
|---|
| 237 | }; | 
|---|
| 238 |  | 
|---|
| 239 | struct probe_entry_arg { | 
|---|
| 240 | struct fetch_insn	*code; | 
|---|
| 241 | unsigned int		size;	/* The entry data size */ | 
|---|
| 242 | }; | 
|---|
| 243 |  | 
|---|
| 244 | struct trace_uprobe_filter { | 
|---|
| 245 | rwlock_t		rwlock; | 
|---|
| 246 | int			nr_systemwide; | 
|---|
| 247 | struct list_head	perf_events; | 
|---|
| 248 | }; | 
|---|
| 249 |  | 
|---|
| 250 | /* Event call and class holder */ | 
|---|
| 251 | struct trace_probe_event { | 
|---|
| 252 | unsigned int			flags;	/* For TP_FLAG_* */ | 
|---|
| 253 | struct trace_event_class	class; | 
|---|
| 254 | struct trace_event_call		call; | 
|---|
| 255 | struct list_head 		files; | 
|---|
| 256 | struct list_head		probes; | 
|---|
| 257 | struct trace_uprobe_filter	filter[]; | 
|---|
| 258 | }; | 
|---|
| 259 |  | 
|---|
| 260 | struct trace_probe { | 
|---|
| 261 | struct list_head		list; | 
|---|
| 262 | struct trace_probe_event	*event; | 
|---|
| 263 | ssize_t				size;	/* trace entry size */ | 
|---|
| 264 | unsigned int			nr_args; | 
|---|
| 265 | struct probe_entry_arg		*entry_arg;	/* This is only for return probe */ | 
|---|
| 266 | struct probe_arg		args[]; | 
|---|
| 267 | }; | 
|---|
| 268 |  | 
|---|
| 269 | struct event_file_link { | 
|---|
| 270 | struct trace_event_file		*file; | 
|---|
| 271 | struct list_head		list; | 
|---|
| 272 | }; | 
|---|
| 273 |  | 
|---|
| 274 | static inline unsigned int trace_probe_load_flag(struct trace_probe *tp) | 
|---|
| 275 | { | 
|---|
| 276 | return smp_load_acquire(&tp->event->flags); | 
|---|
| 277 | } | 
|---|
| 278 |  | 
|---|
| 279 | static inline bool trace_probe_test_flag(struct trace_probe *tp, | 
|---|
| 280 | unsigned int flag) | 
|---|
| 281 | { | 
|---|
| 282 | return !!(trace_probe_load_flag(tp) & flag); | 
|---|
| 283 | } | 
|---|
| 284 |  | 
|---|
| 285 | static inline void trace_probe_set_flag(struct trace_probe *tp, | 
|---|
| 286 | unsigned int flag) | 
|---|
| 287 | { | 
|---|
| 288 | smp_store_release(&tp->event->flags, tp->event->flags | flag); | 
|---|
| 289 | } | 
|---|
| 290 |  | 
|---|
| 291 | static inline void trace_probe_clear_flag(struct trace_probe *tp, | 
|---|
| 292 | unsigned int flag) | 
|---|
| 293 | { | 
|---|
| 294 | tp->event->flags &= ~flag; | 
|---|
| 295 | } | 
|---|
| 296 |  | 
|---|
| 297 | static inline bool trace_probe_is_enabled(struct trace_probe *tp) | 
|---|
| 298 | { | 
|---|
| 299 | return trace_probe_test_flag(tp, TP_FLAG_TRACE | TP_FLAG_PROFILE); | 
|---|
| 300 | } | 
|---|
| 301 |  | 
|---|
| 302 | static inline const char *trace_probe_name(struct trace_probe *tp) | 
|---|
| 303 | { | 
|---|
| 304 | return trace_event_name(call: &tp->event->call); | 
|---|
| 305 | } | 
|---|
| 306 |  | 
|---|
| 307 | static inline const char *trace_probe_group_name(struct trace_probe *tp) | 
|---|
| 308 | { | 
|---|
| 309 | return tp->event->call.class->system; | 
|---|
| 310 | } | 
|---|
| 311 |  | 
|---|
| 312 | static inline struct trace_event_call * | 
|---|
| 313 | trace_probe_event_call(struct trace_probe *tp) | 
|---|
| 314 | { | 
|---|
| 315 | return &tp->event->call; | 
|---|
| 316 | } | 
|---|
| 317 |  | 
|---|
| 318 | static inline struct trace_probe_event * | 
|---|
| 319 | trace_probe_event_from_call(struct trace_event_call *event_call) | 
|---|
| 320 | { | 
|---|
| 321 | return container_of(event_call, struct trace_probe_event, call); | 
|---|
| 322 | } | 
|---|
| 323 |  | 
|---|
| 324 | static inline struct trace_probe * | 
|---|
| 325 | trace_probe_primary_from_call(struct trace_event_call *call) | 
|---|
| 326 | { | 
|---|
| 327 | struct trace_probe_event *tpe = trace_probe_event_from_call(event_call: call); | 
|---|
| 328 |  | 
|---|
| 329 | return list_first_entry_or_null(&tpe->probes, struct trace_probe, list); | 
|---|
| 330 | } | 
|---|
| 331 |  | 
|---|
| 332 | static inline struct list_head *trace_probe_probe_list(struct trace_probe *tp) | 
|---|
| 333 | { | 
|---|
| 334 | return &tp->event->probes; | 
|---|
| 335 | } | 
|---|
| 336 |  | 
|---|
| 337 | static inline bool trace_probe_has_sibling(struct trace_probe *tp) | 
|---|
| 338 | { | 
|---|
| 339 | struct list_head *list = trace_probe_probe_list(tp); | 
|---|
| 340 |  | 
|---|
| 341 | return !list_empty(head: list) && !list_is_singular(head: list); | 
|---|
| 342 | } | 
|---|
| 343 |  | 
|---|
| 344 | static inline int trace_probe_unregister_event_call(struct trace_probe *tp) | 
|---|
| 345 | { | 
|---|
| 346 | /* tp->event is unregistered in trace_remove_event_call() */ | 
|---|
| 347 | return trace_remove_event_call(call: &tp->event->call); | 
|---|
| 348 | } | 
|---|
| 349 |  | 
|---|
| 350 | static inline bool trace_probe_has_single_file(struct trace_probe *tp) | 
|---|
| 351 | { | 
|---|
| 352 | return !!list_is_singular(head: &tp->event->files); | 
|---|
| 353 | } | 
|---|
| 354 |  | 
|---|
| 355 | int trace_probe_init(struct trace_probe *tp, const char *event, | 
|---|
| 356 | const char *group, bool alloc_filter, int nargs); | 
|---|
| 357 | void trace_probe_cleanup(struct trace_probe *tp); | 
|---|
| 358 | int trace_probe_append(struct trace_probe *tp, struct trace_probe *to); | 
|---|
| 359 | void trace_probe_unlink(struct trace_probe *tp); | 
|---|
| 360 | int trace_probe_register_event_call(struct trace_probe *tp); | 
|---|
| 361 | int trace_probe_add_file(struct trace_probe *tp, struct trace_event_file *file); | 
|---|
| 362 | int trace_probe_remove_file(struct trace_probe *tp, | 
|---|
| 363 | struct trace_event_file *file); | 
|---|
| 364 | struct event_file_link *trace_probe_get_file_link(struct trace_probe *tp, | 
|---|
| 365 | struct trace_event_file *file); | 
|---|
| 366 | int trace_probe_compare_arg_type(struct trace_probe *a, struct trace_probe *b); | 
|---|
| 367 | bool trace_probe_match_command_args(struct trace_probe *tp, | 
|---|
| 368 | int argc, const char **argv); | 
|---|
| 369 | int trace_probe_create(const char *raw_command, int (*createfn)(int, const char **)); | 
|---|
| 370 | int trace_probe_print_args(struct trace_seq *s, struct probe_arg *args, int nr_args, | 
|---|
| 371 | u8 *data, void *field); | 
|---|
| 372 |  | 
|---|
| 373 | #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API | 
|---|
| 374 | int traceprobe_get_entry_data_size(struct trace_probe *tp); | 
|---|
| 375 | /* This is a runtime function to store entry data */ | 
|---|
| 376 | void store_trace_entry_data(void *edata, struct trace_probe *tp, struct pt_regs *regs); | 
|---|
| 377 | #else /* !CONFIG_HAVE_FUNCTION_ARG_ACCESS_API */ | 
|---|
| 378 | static inline int traceprobe_get_entry_data_size(struct trace_probe *tp) | 
|---|
| 379 | { | 
|---|
| 380 | return 0; | 
|---|
| 381 | } | 
|---|
| 382 | #define store_trace_entry_data(edata, tp, regs) do { } while (0) | 
|---|
| 383 | #endif | 
|---|
| 384 |  | 
|---|
| 385 | #define trace_probe_for_each_link(pos, tp)	\ | 
|---|
| 386 | list_for_each_entry(pos, &(tp)->event->files, list) | 
|---|
| 387 | #define trace_probe_for_each_link_rcu(pos, tp)	\ | 
|---|
| 388 | list_for_each_entry_rcu(pos, &(tp)->event->files, list) | 
|---|
| 389 |  | 
|---|
| 390 | /* | 
|---|
| 391 | * The flags used for parsing trace_probe arguments. | 
|---|
| 392 | * TPARG_FL_RETURN, TPARG_FL_FENTRY and TPARG_FL_TEVENT are mutually exclusive. | 
|---|
| 393 | * TPARG_FL_KERNEL and TPARG_FL_USER are also mutually exclusive. | 
|---|
| 394 | * TPARG_FL_FPROBE and TPARG_FL_TPOINT are optional but it should be with | 
|---|
| 395 | * TPARG_FL_KERNEL. | 
|---|
| 396 | */ | 
|---|
| 397 | #define TPARG_FL_RETURN BIT(0) | 
|---|
| 398 | #define TPARG_FL_KERNEL BIT(1) | 
|---|
| 399 | #define TPARG_FL_FENTRY BIT(2) | 
|---|
| 400 | #define TPARG_FL_TEVENT BIT(3) | 
|---|
| 401 | #define TPARG_FL_USER   BIT(4) | 
|---|
| 402 | #define TPARG_FL_FPROBE BIT(5) | 
|---|
| 403 | #define TPARG_FL_TPOINT BIT(6) | 
|---|
| 404 | #define TPARG_FL_LOC_MASK	GENMASK(4, 0) | 
|---|
| 405 |  | 
|---|
| 406 | static inline bool tparg_is_function_entry(unsigned int flags) | 
|---|
| 407 | { | 
|---|
| 408 | return (flags & TPARG_FL_LOC_MASK) == (TPARG_FL_KERNEL | TPARG_FL_FENTRY); | 
|---|
| 409 | } | 
|---|
| 410 |  | 
|---|
| 411 | static inline bool tparg_is_function_return(unsigned int flags) | 
|---|
| 412 | { | 
|---|
| 413 | return (flags & TPARG_FL_LOC_MASK) == (TPARG_FL_KERNEL | TPARG_FL_RETURN); | 
|---|
| 414 | } | 
|---|
| 415 |  | 
|---|
| 416 | struct traceprobe_parse_context { | 
|---|
| 417 | struct trace_event_call *event; | 
|---|
| 418 | /* BTF related parameters */ | 
|---|
| 419 | const char *funcname;		/* Function name in BTF */ | 
|---|
| 420 | const struct btf_type  *proto;	/* Prototype of the function */ | 
|---|
| 421 | const struct btf_param *params;	/* Parameter of the function */ | 
|---|
| 422 | s32 nr_params;			/* The number of the parameters */ | 
|---|
| 423 | struct btf *btf;		/* The BTF to be used */ | 
|---|
| 424 | const struct btf_type *last_type;	/* Saved type */ | 
|---|
| 425 | u32 last_bitoffs;		/* Saved bitoffs */ | 
|---|
| 426 | u32 last_bitsize;		/* Saved bitsize */ | 
|---|
| 427 | struct trace_probe *tp; | 
|---|
| 428 | unsigned int flags; | 
|---|
| 429 | int offset; | 
|---|
| 430 | }; | 
|---|
| 431 |  | 
|---|
| 432 | extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i, | 
|---|
| 433 | const char *argv, | 
|---|
| 434 | struct traceprobe_parse_context *ctx); | 
|---|
| 435 | const char **traceprobe_expand_meta_args(int argc, const char *argv[], | 
|---|
| 436 | int *new_argc, char *buf, int bufsize, | 
|---|
| 437 | struct traceprobe_parse_context *ctx); | 
|---|
| 438 | extern int traceprobe_expand_dentry_args(int argc, const char *argv[], char **buf); | 
|---|
| 439 |  | 
|---|
| 440 | extern int traceprobe_update_arg(struct probe_arg *arg); | 
|---|
| 441 | extern void traceprobe_free_probe_arg(struct probe_arg *arg); | 
|---|
| 442 |  | 
|---|
| 443 | /* | 
|---|
| 444 | * If either traceprobe_parse_probe_arg() or traceprobe_expand_meta_args() is called, | 
|---|
| 445 | * this MUST be called for clean up the context and return a resource. | 
|---|
| 446 | */ | 
|---|
| 447 | void traceprobe_finish_parse(struct traceprobe_parse_context *ctx); | 
|---|
| 448 | static inline void traceprobe_free_parse_ctx(struct traceprobe_parse_context *ctx) | 
|---|
| 449 | { | 
|---|
| 450 | traceprobe_finish_parse(ctx); | 
|---|
| 451 | kfree(objp: ctx); | 
|---|
| 452 | } | 
|---|
| 453 |  | 
|---|
| 454 | DEFINE_FREE(traceprobe_parse_context, struct traceprobe_parse_context *, | 
|---|
| 455 | if (_T) traceprobe_free_parse_ctx(_T)) | 
|---|
| 456 |  | 
|---|
| 457 | extern int traceprobe_split_symbol_offset(char *symbol, long *offset); | 
|---|
| 458 | int traceprobe_parse_event_name(const char **pevent, const char **pgroup, | 
|---|
| 459 | char *buf, int offset); | 
|---|
| 460 |  | 
|---|
| 461 | enum probe_print_type { | 
|---|
| 462 | PROBE_PRINT_NORMAL, | 
|---|
| 463 | PROBE_PRINT_RETURN, | 
|---|
| 464 | PROBE_PRINT_EVENT, | 
|---|
| 465 | }; | 
|---|
| 466 |  | 
|---|
| 467 | extern int traceprobe_set_print_fmt(struct trace_probe *tp, enum probe_print_type ptype); | 
|---|
| 468 |  | 
|---|
| 469 | #ifdef CONFIG_PERF_EVENTS | 
|---|
| 470 | extern struct trace_event_call * | 
|---|
| 471 | create_local_trace_kprobe(char *func, void *addr, unsigned long offs, | 
|---|
| 472 | bool is_return); | 
|---|
| 473 | extern void destroy_local_trace_kprobe(struct trace_event_call *event_call); | 
|---|
| 474 |  | 
|---|
| 475 | extern struct trace_event_call * | 
|---|
| 476 | create_local_trace_uprobe(char *name, unsigned long offs, | 
|---|
| 477 | unsigned long ref_ctr_offset, bool is_return); | 
|---|
| 478 | extern void destroy_local_trace_uprobe(struct trace_event_call *event_call); | 
|---|
| 479 | #endif | 
|---|
| 480 | extern int traceprobe_define_arg_fields(struct trace_event_call *event_call, | 
|---|
| 481 | size_t offset, struct trace_probe *tp); | 
|---|
| 482 |  | 
|---|
| 483 | #undef ERRORS | 
|---|
| 484 | #define ERRORS	\ | 
|---|
| 485 | C(FILE_NOT_FOUND,	"Failed to find the given file"),	\ | 
|---|
| 486 | C(NO_REGULAR_FILE,	"Not a regular file"),			\ | 
|---|
| 487 | C(BAD_REFCNT,		"Invalid reference counter offset"),	\ | 
|---|
| 488 | C(REFCNT_OPEN_BRACE,	"Reference counter brace is not closed"), \ | 
|---|
| 489 | C(BAD_REFCNT_SUFFIX,	"Reference counter has wrong suffix"),	\ | 
|---|
| 490 | C(BAD_UPROBE_OFFS,	"Invalid uprobe offset"),		\ | 
|---|
| 491 | C(BAD_MAXACT_TYPE,	"Maxactive is only for function exit"),	\ | 
|---|
| 492 | C(BAD_MAXACT,		"Invalid maxactive number"),		\ | 
|---|
| 493 | C(MAXACT_TOO_BIG,	"Maxactive is too big"),		\ | 
|---|
| 494 | C(BAD_PROBE_ADDR,	"Invalid probed address or symbol"),	\ | 
|---|
| 495 | C(NON_UNIQ_SYMBOL,	"The symbol is not unique"),		\ | 
|---|
| 496 | C(BAD_RETPROBE,		"Retprobe address must be an function entry"), \ | 
|---|
| 497 | C(NO_TRACEPOINT,	"Tracepoint is not found"),		\ | 
|---|
| 498 | C(BAD_TP_NAME,		"Invalid character in tracepoint name"),\ | 
|---|
| 499 | C(BAD_ADDR_SUFFIX,	"Invalid probed address suffix"), \ | 
|---|
| 500 | C(NO_GROUP_NAME,	"Group name is not specified"),		\ | 
|---|
| 501 | C(GROUP_TOO_LONG,	"Group name is too long"),		\ | 
|---|
| 502 | C(BAD_GROUP_NAME,	"Group name must follow the same rules as C identifiers"), \ | 
|---|
| 503 | C(NO_EVENT_NAME,	"Event name is not specified"),		\ | 
|---|
| 504 | C(EVENT_TOO_LONG,	"Event name is too long"),		\ | 
|---|
| 505 | C(BAD_EVENT_NAME,	"Event name must follow the same rules as C identifiers"), \ | 
|---|
| 506 | C(EVENT_EXIST,		"Given group/event name is already used by another event"), \ | 
|---|
| 507 | C(RETVAL_ON_PROBE,	"$retval is not available on probe"),	\ | 
|---|
| 508 | C(NO_RETVAL,		"This function returns 'void' type"),	\ | 
|---|
| 509 | C(BAD_STACK_NUM,	"Invalid stack number"),		\ | 
|---|
| 510 | C(BAD_ARG_NUM,		"Invalid argument number"),		\ | 
|---|
| 511 | C(BAD_VAR,		"Invalid $-valiable specified"),	\ | 
|---|
| 512 | C(BAD_REG_NAME,		"Invalid register name"),		\ | 
|---|
| 513 | C(BAD_MEM_ADDR,		"Invalid memory address"),		\ | 
|---|
| 514 | C(BAD_IMM,		"Invalid immediate value"),		\ | 
|---|
| 515 | C(IMMSTR_NO_CLOSE,	"String is not closed with '\"'"),	\ | 
|---|
| 516 | C(FILE_ON_KPROBE,	"File offset is not available with kprobe"), \ | 
|---|
| 517 | C(BAD_FILE_OFFS,	"Invalid file offset value"),		\ | 
|---|
| 518 | C(SYM_ON_UPROBE,	"Symbol is not available with uprobe"),	\ | 
|---|
| 519 | C(TOO_MANY_OPS,		"Dereference is too much nested"), 	\ | 
|---|
| 520 | C(DEREF_NEED_BRACE,	"Dereference needs a brace"),		\ | 
|---|
| 521 | C(BAD_DEREF_OFFS,	"Invalid dereference offset"),		\ | 
|---|
| 522 | C(DEREF_OPEN_BRACE,	"Dereference brace is not closed"),	\ | 
|---|
| 523 | C(COMM_CANT_DEREF,	"$comm can not be dereferenced"),	\ | 
|---|
| 524 | C(BAD_FETCH_ARG,	"Invalid fetch argument"),		\ | 
|---|
| 525 | C(ARRAY_NO_CLOSE,	"Array is not closed"),			\ | 
|---|
| 526 | C(BAD_ARRAY_SUFFIX,	"Array has wrong suffix"),		\ | 
|---|
| 527 | C(BAD_ARRAY_NUM,	"Invalid array size"),			\ | 
|---|
| 528 | C(ARRAY_TOO_BIG,	"Array number is too big"),		\ | 
|---|
| 529 | C(BAD_TYPE,		"Unknown type is specified"),		\ | 
|---|
| 530 | C(BAD_STRING,		"String accepts only memory argument"),	\ | 
|---|
| 531 | C(BAD_SYMSTRING,	"Symbol String doesn't accept data/userdata"),	\ | 
|---|
| 532 | C(BAD_BITFIELD,		"Invalid bitfield"),			\ | 
|---|
| 533 | C(ARG_NAME_TOO_LONG,	"Argument name is too long"),		\ | 
|---|
| 534 | C(NO_ARG_NAME,		"Argument name is not specified"),	\ | 
|---|
| 535 | C(BAD_ARG_NAME,		"Argument name must follow the same rules as C identifiers"), \ | 
|---|
| 536 | C(USED_ARG_NAME,	"This argument name is already used"),	\ | 
|---|
| 537 | C(ARG_TOO_LONG,		"Argument expression is too long"),	\ | 
|---|
| 538 | C(NO_ARG_BODY,		"No argument expression"),		\ | 
|---|
| 539 | C(BAD_INSN_BNDRY,	"Probe point is not an instruction boundary"),\ | 
|---|
| 540 | C(FAIL_REG_PROBE,	"Failed to register probe event"),\ | 
|---|
| 541 | C(DIFF_PROBE_TYPE,	"Probe type is different from existing probe"),\ | 
|---|
| 542 | C(DIFF_ARG_TYPE,	"Argument type or name is different from existing probe"),\ | 
|---|
| 543 | C(SAME_PROBE,		"There is already the exact same probe event"),\ | 
|---|
| 544 | C(NO_EVENT_INFO,	"This requires both group and event name to attach"),\ | 
|---|
| 545 | C(BAD_ATTACH_EVENT,	"Attached event does not exist"),\ | 
|---|
| 546 | C(BAD_ATTACH_ARG,	"Attached event does not have this field"),\ | 
|---|
| 547 | C(NO_EP_FILTER,		"No filter rule after 'if'"),		\ | 
|---|
| 548 | C(NOSUP_BTFARG,		"BTF is not available or not supported"),	\ | 
|---|
| 549 | C(NO_BTFARG,		"This variable is not found at this probe point"),\ | 
|---|
| 550 | C(NO_BTF_ENTRY,		"No BTF entry for this probe point"),	\ | 
|---|
| 551 | C(BAD_VAR_ARGS,		"$arg* must be an independent parameter without name etc."),\ | 
|---|
| 552 | C(NOFENTRY_ARGS,	"$arg* can be used only on function entry or exit"),	\ | 
|---|
| 553 | C(DOUBLE_ARGS,		"$arg* can be used only once in the parameters"),	\ | 
|---|
| 554 | C(ARGS_2LONG,		"$arg* failed because the argument list is too long"),	\ | 
|---|
| 555 | C(ARGIDX_2BIG,		"$argN index is too big"),		\ | 
|---|
| 556 | C(NO_PTR_STRCT,		"This is not a pointer to union/structure."),	\ | 
|---|
| 557 | C(NOSUP_DAT_ARG,	"Non pointer structure/union argument is not supported."),\ | 
|---|
| 558 | C(BAD_HYPHEN,		"Failed to parse single hyphen. Forgot '>'?"),	\ | 
|---|
| 559 | C(NO_BTF_FIELD,		"This field is not found."),	\ | 
|---|
| 560 | C(BAD_BTF_TID,		"Failed to get BTF type info."),\ | 
|---|
| 561 | C(BAD_TYPE4STR,		"This type does not fit for string."),\ | 
|---|
| 562 | C(NEED_STRING_TYPE,	"$comm and immediate-string only accepts string type"),\ | 
|---|
| 563 | C(TOO_MANY_ARGS,	"Too many arguments are specified"),	\ | 
|---|
| 564 | C(TOO_MANY_EARGS,	"Too many entry arguments specified"), | 
|---|
| 565 |  | 
|---|
| 566 | #undef C | 
|---|
| 567 | #define C(a, b)		TP_ERR_##a | 
|---|
| 568 |  | 
|---|
| 569 | /* Define TP_ERR_ */ | 
|---|
| 570 | enum { ERRORS }; | 
|---|
| 571 |  | 
|---|
| 572 | /* Error text is defined in trace_probe.c */ | 
|---|
| 573 |  | 
|---|
| 574 | struct trace_probe_log { | 
|---|
| 575 | const char	*subsystem; | 
|---|
| 576 | const char	**argv; | 
|---|
| 577 | int		argc; | 
|---|
| 578 | int		index; | 
|---|
| 579 | }; | 
|---|
| 580 |  | 
|---|
| 581 | void trace_probe_log_init(const char *subsystem, int argc, const char **argv); | 
|---|
| 582 | void trace_probe_log_set_index(int index); | 
|---|
| 583 | void trace_probe_log_clear(void); | 
|---|
| 584 | void __trace_probe_log_err(int offset, int err); | 
|---|
| 585 |  | 
|---|
| 586 | #define trace_probe_log_err(offs, err)	\ | 
|---|
| 587 | __trace_probe_log_err(offs, TP_ERR_##err) | 
|---|
| 588 |  | 
|---|
| 589 | struct uprobe_dispatch_data { | 
|---|
| 590 | struct trace_uprobe	*tu; | 
|---|
| 591 | unsigned long		bp_addr; | 
|---|
| 592 | }; | 
|---|
| 593 |  | 
|---|