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/seq_file.h> 14 #include <linux/slab.h> 15 #include <linux/smp.h> 16 #include <linux/tracefs.h> 17 #include <linux/types.h> 18 #include <linux/string.h> 19 #include <linux/ptrace.h> 20 #include <linux/perf_event.h> 21 #include <linux/kprobes.h> 22 #include <linux/stringify.h> 23 #include <linux/limits.h> 24 #include <linux/uaccess.h> 25 #include <linux/bitops.h> 26 #include <asm/bitsperlong.h> 27 28 #include "trace.h" 29 #include "trace_output.h" 30 31 #define MAX_TRACE_ARGS 128 32 #define MAX_ARGSTR_LEN 63 33 #define MAX_ARRAY_LEN 64 34 #define MAX_ARG_NAME_LEN 32 35 #define MAX_STRING_SIZE PATH_MAX 36 37 /* Reserved field names */ 38 #define FIELD_STRING_IP "__probe_ip" 39 #define FIELD_STRING_RETIP "__probe_ret_ip" 40 #define FIELD_STRING_FUNC "__probe_func" 41 42 #undef DEFINE_FIELD 43 #define DEFINE_FIELD(type, item, name, is_signed) \ 44 do { \ 45 ret = trace_define_field(event_call, #type, name, \ 46 offsetof(typeof(field), item), \ 47 sizeof(field.item), is_signed, \ 48 FILTER_OTHER); \ 49 if (ret) \ 50 return ret; \ 51 } while (0) 52 53 54 /* Flags for trace_probe */ 55 #define TP_FLAG_TRACE 1 56 #define TP_FLAG_PROFILE 2 57 58 /* data_loc: data location, compatible with u32 */ 59 #define make_data_loc(len, offs) \ 60 (((u32)(len) << 16) | ((u32)(offs) & 0xffff)) 61 #define get_loc_len(dl) ((u32)(dl) >> 16) 62 #define get_loc_offs(dl) ((u32)(dl) & 0xffff) 63 64 static nokprobe_inline void *get_loc_data(u32 *dl, void *ent) 65 { 66 return (u8 *)ent + get_loc_offs(*dl); 67 } 68 69 static nokprobe_inline u32 update_data_loc(u32 loc, int consumed) 70 { 71 u32 maxlen = get_loc_len(loc); 72 u32 offset = get_loc_offs(loc); 73 74 return make_data_loc(maxlen - consumed, offset + consumed); 75 } 76 77 /* Printing function type */ 78 typedef int (*print_type_func_t)(struct trace_seq *, void *, void *); 79 80 enum fetch_op { 81 FETCH_OP_NOP = 0, 82 // Stage 1 (load) ops 83 FETCH_OP_REG, /* Register : .param = offset */ 84 FETCH_OP_STACK, /* Stack : .param = index */ 85 FETCH_OP_STACKP, /* Stack pointer */ 86 FETCH_OP_RETVAL, /* Return value */ 87 FETCH_OP_IMM, /* Immediate : .immediate */ 88 FETCH_OP_COMM, /* Current comm */ 89 FETCH_OP_ARG, /* Function argument : .param */ 90 FETCH_OP_FOFFS, /* File offset: .immediate */ 91 FETCH_OP_DATA, /* Allocated data: .data */ 92 // Stage 2 (dereference) op 93 FETCH_OP_DEREF, /* Dereference: .offset */ 94 FETCH_OP_UDEREF, /* User-space Dereference: .offset */ 95 // Stage 3 (store) ops 96 FETCH_OP_ST_RAW, /* Raw: .size */ 97 FETCH_OP_ST_MEM, /* Mem: .offset, .size */ 98 FETCH_OP_ST_UMEM, /* Mem: .offset, .size */ 99 FETCH_OP_ST_STRING, /* String: .offset, .size */ 100 FETCH_OP_ST_USTRING, /* User String: .offset, .size */ 101 FETCH_OP_ST_SYMSTR, /* Kernel Symbol String: .offset, .size */ 102 // Stage 4 (modify) op 103 FETCH_OP_MOD_BF, /* Bitfield: .basesize, .lshift, .rshift */ 104 // Stage 5 (loop) op 105 FETCH_OP_LP_ARRAY, /* Array: .param = loop count */ 106 FETCH_OP_TP_ARG, /* Trace Point argument */ 107 FETCH_OP_END, 108 FETCH_NOP_SYMBOL, /* Unresolved Symbol holder */ 109 }; 110 111 struct fetch_insn { 112 enum fetch_op op; 113 union { 114 unsigned int param; 115 struct { 116 unsigned int size; 117 int offset; 118 }; 119 struct { 120 unsigned char basesize; 121 unsigned char lshift; 122 unsigned char rshift; 123 }; 124 unsigned long immediate; 125 void *data; 126 }; 127 }; 128 129 /* fetch + deref*N + store + mod + end <= 16, this allows N=12, enough */ 130 #define FETCH_INSN_MAX 16 131 #define FETCH_TOKEN_COMM (-ECOMM) 132 133 /* Fetch type information table */ 134 struct fetch_type { 135 const char *name; /* Name of type */ 136 size_t size; /* Byte size of type */ 137 bool is_signed; /* Signed flag */ 138 bool is_string; /* String flag */ 139 print_type_func_t print; /* Print functions */ 140 const char *fmt; /* Format string */ 141 const char *fmttype; /* Name in format file */ 142 }; 143 144 /* For defining macros, define string/string_size types */ 145 typedef u32 string; 146 typedef u32 string_size; 147 148 #define PRINT_TYPE_FUNC_NAME(type) print_type_##type 149 #define PRINT_TYPE_FMT_NAME(type) print_type_format_##type 150 151 /* Printing in basic type function template */ 152 #define DECLARE_BASIC_PRINT_TYPE_FUNC(type) \ 153 int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, void *data, void *ent);\ 154 extern const char PRINT_TYPE_FMT_NAME(type)[] 155 156 DECLARE_BASIC_PRINT_TYPE_FUNC(u8); 157 DECLARE_BASIC_PRINT_TYPE_FUNC(u16); 158 DECLARE_BASIC_PRINT_TYPE_FUNC(u32); 159 DECLARE_BASIC_PRINT_TYPE_FUNC(u64); 160 DECLARE_BASIC_PRINT_TYPE_FUNC(s8); 161 DECLARE_BASIC_PRINT_TYPE_FUNC(s16); 162 DECLARE_BASIC_PRINT_TYPE_FUNC(s32); 163 DECLARE_BASIC_PRINT_TYPE_FUNC(s64); 164 DECLARE_BASIC_PRINT_TYPE_FUNC(x8); 165 DECLARE_BASIC_PRINT_TYPE_FUNC(x16); 166 DECLARE_BASIC_PRINT_TYPE_FUNC(x32); 167 DECLARE_BASIC_PRINT_TYPE_FUNC(x64); 168 169 DECLARE_BASIC_PRINT_TYPE_FUNC(char); 170 DECLARE_BASIC_PRINT_TYPE_FUNC(string); 171 DECLARE_BASIC_PRINT_TYPE_FUNC(symbol); 172 173 /* Default (unsigned long) fetch type */ 174 #define __DEFAULT_FETCH_TYPE(t) x##t 175 #define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t) 176 #define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG) 177 #define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE) 178 179 #define __ADDR_FETCH_TYPE(t) u##t 180 #define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t) 181 #define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG) 182 183 #define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, str, _fmttype) \ 184 {.name = _name, \ 185 .size = _size, \ 186 .is_signed = (bool)sign, \ 187 .is_string = (bool)str, \ 188 .print = PRINT_TYPE_FUNC_NAME(ptype), \ 189 .fmt = PRINT_TYPE_FMT_NAME(ptype), \ 190 .fmttype = _fmttype, \ 191 } 192 193 /* Non string types can use these macros */ 194 #define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \ 195 __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, 0, #_fmttype) 196 #define ASSIGN_FETCH_TYPE(ptype, ftype, sign) \ 197 _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype) 198 199 /* If ptype is an alias of atype, use this macro (show atype in format) */ 200 #define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign) \ 201 _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype) 202 203 #define ASSIGN_FETCH_TYPE_END {} 204 #define MAX_ARRAY_LEN 64 205 206 #ifdef CONFIG_KPROBE_EVENTS 207 bool trace_kprobe_on_func_entry(struct trace_event_call *call); 208 bool trace_kprobe_error_injectable(struct trace_event_call *call); 209 #else 210 static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call) 211 { 212 return false; 213 } 214 215 static inline bool trace_kprobe_error_injectable(struct trace_event_call *call) 216 { 217 return false; 218 } 219 #endif /* CONFIG_KPROBE_EVENTS */ 220 221 struct probe_arg { 222 struct fetch_insn *code; 223 bool dynamic;/* Dynamic array (string) is used */ 224 unsigned int offset; /* Offset from argument entry */ 225 unsigned int count; /* Array count */ 226 const char *name; /* Name of this argument */ 227 const char *comm; /* Command of this argument */ 228 char *fmt; /* Format string if needed */ 229 const struct fetch_type *type; /* Type of this argument */ 230 }; 231 232 struct trace_uprobe_filter { 233 rwlock_t rwlock; 234 int nr_systemwide; 235 struct list_head perf_events; 236 }; 237 238 /* Event call and class holder */ 239 struct trace_probe_event { 240 unsigned int flags; /* For TP_FLAG_* */ 241 struct trace_event_class class; 242 struct trace_event_call call; 243 struct list_head files; 244 struct list_head probes; 245 struct trace_uprobe_filter filter[]; 246 }; 247 248 struct trace_probe { 249 struct list_head list; 250 struct trace_probe_event *event; 251 ssize_t size; /* trace entry size */ 252 unsigned int nr_args; 253 struct probe_arg args[]; 254 }; 255 256 struct event_file_link { 257 struct trace_event_file *file; 258 struct list_head list; 259 }; 260 261 static inline bool trace_probe_test_flag(struct trace_probe *tp, 262 unsigned int flag) 263 { 264 return !!(tp->event->flags & flag); 265 } 266 267 static inline void trace_probe_set_flag(struct trace_probe *tp, 268 unsigned int flag) 269 { 270 tp->event->flags |= flag; 271 } 272 273 static inline void trace_probe_clear_flag(struct trace_probe *tp, 274 unsigned int flag) 275 { 276 tp->event->flags &= ~flag; 277 } 278 279 static inline bool trace_probe_is_enabled(struct trace_probe *tp) 280 { 281 return trace_probe_test_flag(tp, TP_FLAG_TRACE | TP_FLAG_PROFILE); 282 } 283 284 static inline const char *trace_probe_name(struct trace_probe *tp) 285 { 286 return trace_event_name(&tp->event->call); 287 } 288 289 static inline const char *trace_probe_group_name(struct trace_probe *tp) 290 { 291 return tp->event->call.class->system; 292 } 293 294 static inline struct trace_event_call * 295 trace_probe_event_call(struct trace_probe *tp) 296 { 297 return &tp->event->call; 298 } 299 300 static inline struct trace_probe_event * 301 trace_probe_event_from_call(struct trace_event_call *event_call) 302 { 303 return container_of(event_call, struct trace_probe_event, call); 304 } 305 306 static inline struct trace_probe * 307 trace_probe_primary_from_call(struct trace_event_call *call) 308 { 309 struct trace_probe_event *tpe = trace_probe_event_from_call(call); 310 311 return list_first_entry_or_null(&tpe->probes, struct trace_probe, list); 312 } 313 314 static inline struct list_head *trace_probe_probe_list(struct trace_probe *tp) 315 { 316 return &tp->event->probes; 317 } 318 319 static inline bool trace_probe_has_sibling(struct trace_probe *tp) 320 { 321 struct list_head *list = trace_probe_probe_list(tp); 322 323 return !list_empty(list) && !list_is_singular(list); 324 } 325 326 static inline int trace_probe_unregister_event_call(struct trace_probe *tp) 327 { 328 /* tp->event is unregistered in trace_remove_event_call() */ 329 return trace_remove_event_call(&tp->event->call); 330 } 331 332 static inline bool trace_probe_has_single_file(struct trace_probe *tp) 333 { 334 return !!list_is_singular(&tp->event->files); 335 } 336 337 int trace_probe_init(struct trace_probe *tp, const char *event, 338 const char *group, bool alloc_filter); 339 void trace_probe_cleanup(struct trace_probe *tp); 340 int trace_probe_append(struct trace_probe *tp, struct trace_probe *to); 341 void trace_probe_unlink(struct trace_probe *tp); 342 int trace_probe_register_event_call(struct trace_probe *tp); 343 int trace_probe_add_file(struct trace_probe *tp, struct trace_event_file *file); 344 int trace_probe_remove_file(struct trace_probe *tp, 345 struct trace_event_file *file); 346 struct event_file_link *trace_probe_get_file_link(struct trace_probe *tp, 347 struct trace_event_file *file); 348 int trace_probe_compare_arg_type(struct trace_probe *a, struct trace_probe *b); 349 bool trace_probe_match_command_args(struct trace_probe *tp, 350 int argc, const char **argv); 351 int trace_probe_create(const char *raw_command, int (*createfn)(int, const char **)); 352 int trace_probe_print_args(struct trace_seq *s, struct probe_arg *args, int nr_args, 353 u8 *data, void *field); 354 355 #define trace_probe_for_each_link(pos, tp) \ 356 list_for_each_entry(pos, &(tp)->event->files, list) 357 #define trace_probe_for_each_link_rcu(pos, tp) \ 358 list_for_each_entry_rcu(pos, &(tp)->event->files, list) 359 360 #define TPARG_FL_RETURN BIT(0) 361 #define TPARG_FL_KERNEL BIT(1) 362 #define TPARG_FL_FENTRY BIT(2) 363 #define TPARG_FL_TPOINT BIT(3) 364 #define TPARG_FL_USER BIT(4) 365 #define TPARG_FL_MASK GENMASK(4, 0) 366 367 extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i, 368 const char *argv, unsigned int flags); 369 370 extern int traceprobe_update_arg(struct probe_arg *arg); 371 extern void traceprobe_free_probe_arg(struct probe_arg *arg); 372 373 extern int traceprobe_split_symbol_offset(char *symbol, long *offset); 374 int traceprobe_parse_event_name(const char **pevent, const char **pgroup, 375 char *buf, int offset); 376 377 enum probe_print_type { 378 PROBE_PRINT_NORMAL, 379 PROBE_PRINT_RETURN, 380 PROBE_PRINT_EVENT, 381 }; 382 383 extern int traceprobe_set_print_fmt(struct trace_probe *tp, enum probe_print_type ptype); 384 385 #ifdef CONFIG_PERF_EVENTS 386 extern struct trace_event_call * 387 create_local_trace_kprobe(char *func, void *addr, unsigned long offs, 388 bool is_return); 389 extern void destroy_local_trace_kprobe(struct trace_event_call *event_call); 390 391 extern struct trace_event_call * 392 create_local_trace_uprobe(char *name, unsigned long offs, 393 unsigned long ref_ctr_offset, bool is_return); 394 extern void destroy_local_trace_uprobe(struct trace_event_call *event_call); 395 #endif 396 extern int traceprobe_define_arg_fields(struct trace_event_call *event_call, 397 size_t offset, struct trace_probe *tp); 398 399 #undef ERRORS 400 #define ERRORS \ 401 C(FILE_NOT_FOUND, "Failed to find the given file"), \ 402 C(NO_REGULAR_FILE, "Not a regular file"), \ 403 C(BAD_REFCNT, "Invalid reference counter offset"), \ 404 C(REFCNT_OPEN_BRACE, "Reference counter brace is not closed"), \ 405 C(BAD_REFCNT_SUFFIX, "Reference counter has wrong suffix"), \ 406 C(BAD_UPROBE_OFFS, "Invalid uprobe offset"), \ 407 C(MAXACT_NO_KPROBE, "Maxactive is not for kprobe"), \ 408 C(BAD_MAXACT, "Invalid maxactive number"), \ 409 C(MAXACT_TOO_BIG, "Maxactive is too big"), \ 410 C(BAD_PROBE_ADDR, "Invalid probed address or symbol"), \ 411 C(BAD_RETPROBE, "Retprobe address must be an function entry"), \ 412 C(BAD_ADDR_SUFFIX, "Invalid probed address suffix"), \ 413 C(NO_GROUP_NAME, "Group name is not specified"), \ 414 C(GROUP_TOO_LONG, "Group name is too long"), \ 415 C(BAD_GROUP_NAME, "Group name must follow the same rules as C identifiers"), \ 416 C(NO_EVENT_NAME, "Event name is not specified"), \ 417 C(EVENT_TOO_LONG, "Event name is too long"), \ 418 C(BAD_EVENT_NAME, "Event name must follow the same rules as C identifiers"), \ 419 C(EVENT_EXIST, "Given group/event name is already used by another event"), \ 420 C(RETVAL_ON_PROBE, "$retval is not available on probe"), \ 421 C(BAD_STACK_NUM, "Invalid stack number"), \ 422 C(BAD_ARG_NUM, "Invalid argument number"), \ 423 C(BAD_VAR, "Invalid $-valiable specified"), \ 424 C(BAD_REG_NAME, "Invalid register name"), \ 425 C(BAD_MEM_ADDR, "Invalid memory address"), \ 426 C(BAD_IMM, "Invalid immediate value"), \ 427 C(IMMSTR_NO_CLOSE, "String is not closed with '\"'"), \ 428 C(FILE_ON_KPROBE, "File offset is not available with kprobe"), \ 429 C(BAD_FILE_OFFS, "Invalid file offset value"), \ 430 C(SYM_ON_UPROBE, "Symbol is not available with uprobe"), \ 431 C(TOO_MANY_OPS, "Dereference is too much nested"), \ 432 C(DEREF_NEED_BRACE, "Dereference needs a brace"), \ 433 C(BAD_DEREF_OFFS, "Invalid dereference offset"), \ 434 C(DEREF_OPEN_BRACE, "Dereference brace is not closed"), \ 435 C(COMM_CANT_DEREF, "$comm can not be dereferenced"), \ 436 C(BAD_FETCH_ARG, "Invalid fetch argument"), \ 437 C(ARRAY_NO_CLOSE, "Array is not closed"), \ 438 C(BAD_ARRAY_SUFFIX, "Array has wrong suffix"), \ 439 C(BAD_ARRAY_NUM, "Invalid array size"), \ 440 C(ARRAY_TOO_BIG, "Array number is too big"), \ 441 C(BAD_TYPE, "Unknown type is specified"), \ 442 C(BAD_STRING, "String accepts only memory argument"), \ 443 C(BAD_SYMSTRING, "Symbol String doesn't accept data/userdata"), \ 444 C(BAD_BITFIELD, "Invalid bitfield"), \ 445 C(ARG_NAME_TOO_LONG, "Argument name is too long"), \ 446 C(NO_ARG_NAME, "Argument name is not specified"), \ 447 C(BAD_ARG_NAME, "Argument name must follow the same rules as C identifiers"), \ 448 C(USED_ARG_NAME, "This argument name is already used"), \ 449 C(ARG_TOO_LONG, "Argument expression is too long"), \ 450 C(NO_ARG_BODY, "No argument expression"), \ 451 C(BAD_INSN_BNDRY, "Probe point is not an instruction boundary"),\ 452 C(FAIL_REG_PROBE, "Failed to register probe event"),\ 453 C(DIFF_PROBE_TYPE, "Probe type is different from existing probe"),\ 454 C(DIFF_ARG_TYPE, "Argument type or name is different from existing probe"),\ 455 C(SAME_PROBE, "There is already the exact same probe event"),\ 456 C(NO_EVENT_INFO, "This requires both group and event name to attach"),\ 457 C(BAD_ATTACH_EVENT, "Attached event does not exist"),\ 458 C(BAD_ATTACH_ARG, "Attached event does not have this field"),\ 459 C(NO_EP_FILTER, "No filter rule after 'if'"), 460 461 #undef C 462 #define C(a, b) TP_ERR_##a 463 464 /* Define TP_ERR_ */ 465 enum { ERRORS }; 466 467 /* Error text is defined in trace_probe.c */ 468 469 struct trace_probe_log { 470 const char *subsystem; 471 const char **argv; 472 int argc; 473 int index; 474 }; 475 476 void trace_probe_log_init(const char *subsystem, int argc, const char **argv); 477 void trace_probe_log_set_index(int index); 478 void trace_probe_log_clear(void); 479 void __trace_probe_log_err(int offset, int err); 480 481 #define trace_probe_log_err(offs, err) \ 482 __trace_probe_log_err(offs, TP_ERR_##err) 483