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