1 // SPDX-License-Identifier: GPL-2.0
3 * Common header file for probe-based Dynamic events.
5 * This code was copied from kernel/trace/trace_kprobe.h written by
6 * Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
8 * Updates to make this generic:
9 * Copyright (C) IBM Corporation, 2010-2011
10 * Author: Srikar Dronamraju
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>
30 #include "trace_output.h"
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
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"
44 #define DEFINE_FIELD(type, item, name, is_signed) \
46 ret = trace_define_field(event_call, #type, name, \
47 offsetof(typeof(field), item), \
48 sizeof(field.item), is_signed, \
55 /* Flags for trace_probe */
56 #define TP_FLAG_TRACE 1
57 #define TP_FLAG_PROFILE 2
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)
65 static nokprobe_inline void *get_loc_data(u32 *dl, void *ent)
67 return (u8 *)ent + get_loc_offs(*dl);
70 static nokprobe_inline u32 update_data_loc(u32 loc, int consumed)
72 u32 maxlen = get_loc_len(loc);
73 u32 offset = get_loc_offs(loc);
75 return make_data_loc(maxlen - consumed, offset + consumed);
78 /* Printing function type */
79 typedef int (*print_type_func_t)(struct trace_seq *, void *, void *);
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 */
104 FETCH_OP_LP_ARRAY, /* Array: .param = loop count */
106 FETCH_NOP_SYMBOL, /* Unresolved Symbol holder */
118 unsigned char basesize;
119 unsigned char lshift;
120 unsigned char rshift;
122 unsigned long immediate;
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)
131 /* Fetch type information table */
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 */
141 /* For defining macros, define string/string_size types */
143 typedef u32 string_size;
145 #define PRINT_TYPE_FUNC_NAME(type) print_type_##type
146 #define PRINT_TYPE_FMT_NAME(type) print_type_format_##type
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)[]
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);
166 DECLARE_BASIC_PRINT_TYPE_FUNC(string);
167 DECLARE_BASIC_PRINT_TYPE_FUNC(symbol);
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)
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)
179 #define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
183 .print = PRINT_TYPE_FUNC_NAME(ptype), \
184 .fmt = PRINT_TYPE_FMT_NAME(ptype), \
185 .fmttype = _fmttype, \
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)
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)
196 #define ASSIGN_FETCH_TYPE_END {}
197 #define MAX_ARRAY_LEN 64
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);
203 static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call)
208 static inline bool trace_kprobe_error_injectable(struct trace_event_call *call)
212 #endif /* CONFIG_KPROBE_EVENTS */
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 */
226 unsigned int flags; /* For TP_FLAG_* */
227 struct trace_event_class class;
228 struct trace_event_call call;
229 struct list_head files;
230 ssize_t size; /* trace entry size */
231 unsigned int nr_args;
232 struct probe_arg args[];
235 struct event_file_link {
236 struct trace_event_file *file;
237 struct list_head list;
240 static inline bool trace_probe_test_flag(struct trace_probe *tp,
243 return !!(tp->flags & flag);
246 static inline void trace_probe_set_flag(struct trace_probe *tp,
252 static inline void trace_probe_clear_flag(struct trace_probe *tp,
258 static inline bool trace_probe_is_enabled(struct trace_probe *tp)
260 return trace_probe_test_flag(tp, TP_FLAG_TRACE | TP_FLAG_PROFILE);
263 static inline const char *trace_probe_name(struct trace_probe *tp)
265 return trace_event_name(&tp->call);
268 static inline const char *trace_probe_group_name(struct trace_probe *tp)
270 return tp->call.class->system;
273 static inline struct trace_event_call *
274 trace_probe_event_call(struct trace_probe *tp)
279 static inline int trace_probe_unregister_event_call(struct trace_probe *tp)
281 /* tp->event is unregistered in trace_remove_event_call() */
282 return trace_remove_event_call(&tp->call);
285 static inline bool trace_probe_has_single_file(struct trace_probe *tp)
287 return !!list_is_singular(&tp->files);
290 int trace_probe_init(struct trace_probe *tp, const char *event,
292 void trace_probe_cleanup(struct trace_probe *tp);
293 int trace_probe_register_event_call(struct trace_probe *tp);
294 int trace_probe_add_file(struct trace_probe *tp, struct trace_event_file *file);
295 int trace_probe_remove_file(struct trace_probe *tp,
296 struct trace_event_file *file);
297 struct event_file_link *trace_probe_get_file_link(struct trace_probe *tp,
298 struct trace_event_file *file);
300 #define trace_probe_for_each_link(pos, tp) \
301 list_for_each_entry(pos, &(tp)->files, list)
302 #define trace_probe_for_each_link_rcu(pos, tp) \
303 list_for_each_entry_rcu(pos, &(tp)->files, list)
305 /* Check the name is good for event/group/fields */
306 static inline bool is_good_name(const char *name)
308 if (!isalpha(*name) && *name != '_')
310 while (*++name != '\0') {
311 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
317 #define TPARG_FL_RETURN BIT(0)
318 #define TPARG_FL_KERNEL BIT(1)
319 #define TPARG_FL_FENTRY BIT(2)
320 #define TPARG_FL_MASK GENMASK(2, 0)
322 extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i,
323 char *arg, unsigned int flags);
325 extern int traceprobe_update_arg(struct probe_arg *arg);
326 extern void traceprobe_free_probe_arg(struct probe_arg *arg);
328 extern int traceprobe_split_symbol_offset(char *symbol, long *offset);
329 int traceprobe_parse_event_name(const char **pevent, const char **pgroup,
330 char *buf, int offset);
332 extern int traceprobe_set_print_fmt(struct trace_probe *tp, bool is_return);
334 #ifdef CONFIG_PERF_EVENTS
335 extern struct trace_event_call *
336 create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
338 extern void destroy_local_trace_kprobe(struct trace_event_call *event_call);
340 extern struct trace_event_call *
341 create_local_trace_uprobe(char *name, unsigned long offs,
342 unsigned long ref_ctr_offset, bool is_return);
343 extern void destroy_local_trace_uprobe(struct trace_event_call *event_call);
345 extern int traceprobe_define_arg_fields(struct trace_event_call *event_call,
346 size_t offset, struct trace_probe *tp);
350 C(FILE_NOT_FOUND, "Failed to find the given file"), \
351 C(NO_REGULAR_FILE, "Not a regular file"), \
352 C(BAD_REFCNT, "Invalid reference counter offset"), \
353 C(REFCNT_OPEN_BRACE, "Reference counter brace is not closed"), \
354 C(BAD_REFCNT_SUFFIX, "Reference counter has wrong suffix"), \
355 C(BAD_UPROBE_OFFS, "Invalid uprobe offset"), \
356 C(MAXACT_NO_KPROBE, "Maxactive is not for kprobe"), \
357 C(BAD_MAXACT, "Invalid maxactive number"), \
358 C(MAXACT_TOO_BIG, "Maxactive is too big"), \
359 C(BAD_PROBE_ADDR, "Invalid probed address or symbol"), \
360 C(BAD_RETPROBE, "Retprobe address must be an function entry"), \
361 C(NO_GROUP_NAME, "Group name is not specified"), \
362 C(GROUP_TOO_LONG, "Group name is too long"), \
363 C(BAD_GROUP_NAME, "Group name must follow the same rules as C identifiers"), \
364 C(NO_EVENT_NAME, "Event name is not specified"), \
365 C(EVENT_TOO_LONG, "Event name is too long"), \
366 C(BAD_EVENT_NAME, "Event name must follow the same rules as C identifiers"), \
367 C(RETVAL_ON_PROBE, "$retval is not available on probe"), \
368 C(BAD_STACK_NUM, "Invalid stack number"), \
369 C(BAD_ARG_NUM, "Invalid argument number"), \
370 C(BAD_VAR, "Invalid $-valiable specified"), \
371 C(BAD_REG_NAME, "Invalid register name"), \
372 C(BAD_MEM_ADDR, "Invalid memory address"), \
373 C(FILE_ON_KPROBE, "File offset is not available with kprobe"), \
374 C(BAD_FILE_OFFS, "Invalid file offset value"), \
375 C(SYM_ON_UPROBE, "Symbol is not available with uprobe"), \
376 C(TOO_MANY_OPS, "Dereference is too much nested"), \
377 C(DEREF_NEED_BRACE, "Dereference needs a brace"), \
378 C(BAD_DEREF_OFFS, "Invalid dereference offset"), \
379 C(DEREF_OPEN_BRACE, "Dereference brace is not closed"), \
380 C(COMM_CANT_DEREF, "$comm can not be dereferenced"), \
381 C(BAD_FETCH_ARG, "Invalid fetch argument"), \
382 C(ARRAY_NO_CLOSE, "Array is not closed"), \
383 C(BAD_ARRAY_SUFFIX, "Array has wrong suffix"), \
384 C(BAD_ARRAY_NUM, "Invalid array size"), \
385 C(ARRAY_TOO_BIG, "Array number is too big"), \
386 C(BAD_TYPE, "Unknown type is specified"), \
387 C(BAD_STRING, "String accepts only memory argument"), \
388 C(BAD_BITFIELD, "Invalid bitfield"), \
389 C(ARG_NAME_TOO_LONG, "Argument name is too long"), \
390 C(NO_ARG_NAME, "Argument name is not specified"), \
391 C(BAD_ARG_NAME, "Argument name must follow the same rules as C identifiers"), \
392 C(USED_ARG_NAME, "This argument name is already used"), \
393 C(ARG_TOO_LONG, "Argument expression is too long"), \
394 C(NO_ARG_BODY, "No argument expression"), \
395 C(BAD_INSN_BNDRY, "Probe point is not an instruction boundary"),\
396 C(FAIL_REG_PROBE, "Failed to register probe event"),
399 #define C(a, b) TP_ERR_##a
404 /* Error text is defined in trace_probe.c */
406 struct trace_probe_log {
407 const char *subsystem;
413 void trace_probe_log_init(const char *subsystem, int argc, const char **argv);
414 void trace_probe_log_set_index(int index);
415 void trace_probe_log_clear(void);
416 void __trace_probe_log_err(int offset, int err);
418 #define trace_probe_log_err(offs, err) \
419 __trace_probe_log_err(offs, TP_ERR_##err)