kernel/trace/trace_probe.h

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