blob: 2177c206de151c1b4e17b491020d0d9cd0af57a8 [file] [log] [blame]
Steven Rostedt (VMware)bcea3f92018-08-16 11:23:53 -04001// SPDX-License-Identifier: GPL-2.0
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +05302/*
3 * Common header file for probe-based Dynamic events.
4 *
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +05305 * 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>
Steven Rostedt (Red Hat)8434dc92015-01-20 12:13:40 -050016#include <linux/tracefs.h>
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +053017#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>
Masami Hiramatsua1303af2018-04-25 21:21:26 +090026#include <linux/bitops.h>
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +053027#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
Masami Hiramatsu40b53b72018-04-25 21:21:55 +090034#define MAX_ARRAY_LEN 64
Masami Hiramatsub4443c12019-03-14 13:30:30 +090035#define MAX_ARG_NAME_LEN 32
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +053036#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#define TP_FLAG_REGISTERED 4
59
Masami Hiramatsu91784122018-04-25 21:19:01 +090060/* data_loc: data location, compatible with u32 */
61#define make_data_loc(len, offs) \
62 (((u32)(len) << 16) | ((u32)(offs) & 0xffff))
63#define get_loc_len(dl) ((u32)(dl) >> 16)
64#define get_loc_offs(dl) ((u32)(dl) & 0xffff)
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +053065
Masami Hiramatsu3da0f182014-04-17 17:18:28 +090066static nokprobe_inline void *get_loc_data(u32 *dl, void *ent)
Namhyung Kimb26c74e2013-11-26 14:19:59 +090067{
Masami Hiramatsu91784122018-04-25 21:19:01 +090068 return (u8 *)ent + get_loc_offs(*dl);
Namhyung Kimb26c74e2013-11-26 14:19:59 +090069}
70
Masami Hiramatsu40b53b72018-04-25 21:21:55 +090071static nokprobe_inline u32 update_data_loc(u32 loc, int consumed)
72{
73 u32 maxlen = get_loc_len(loc);
74 u32 offset = get_loc_offs(loc);
75
76 return make_data_loc(maxlen - consumed, offset + consumed);
77}
78
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +053079/* Printing function type */
Masami Hiramatsu56de7632018-04-25 21:16:36 +090080typedef int (*print_type_func_t)(struct trace_seq *, void *, void *);
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +053081
Masami Hiramatsu53305922018-04-25 21:18:03 +090082enum fetch_op {
83 FETCH_OP_NOP = 0,
84 // Stage 1 (load) ops
85 FETCH_OP_REG, /* Register : .param = offset */
86 FETCH_OP_STACK, /* Stack : .param = index */
87 FETCH_OP_STACKP, /* Stack pointer */
88 FETCH_OP_RETVAL, /* Return value */
89 FETCH_OP_IMM, /* Immediate : .immediate */
90 FETCH_OP_COMM, /* Current comm */
Masami Hiramatsua1303af2018-04-25 21:21:26 +090091 FETCH_OP_ARG, /* Function argument : .param */
Masami Hiramatsu53305922018-04-25 21:18:03 +090092 FETCH_OP_FOFFS, /* File offset: .immediate */
93 // Stage 2 (dereference) op
94 FETCH_OP_DEREF, /* 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_STRING, /* String: .offset, .size */
99 // Stage 4 (modify) op
100 FETCH_OP_MOD_BF, /* Bitfield: .basesize, .lshift, .rshift */
Masami Hiramatsu40b53b72018-04-25 21:21:55 +0900101 // Stage 5 (loop) op
102 FETCH_OP_LP_ARRAY, /* Array: .param = loop count */
Masami Hiramatsu53305922018-04-25 21:18:03 +0900103 FETCH_OP_END,
Masami Hiramatsua6682812018-08-29 01:18:43 +0900104 FETCH_NOP_SYMBOL, /* Unresolved Symbol holder */
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530105};
106
Masami Hiramatsu53305922018-04-25 21:18:03 +0900107struct fetch_insn {
108 enum fetch_op op;
109 union {
110 unsigned int param;
111 struct {
112 unsigned int size;
113 int offset;
114 };
115 struct {
116 unsigned char basesize;
117 unsigned char lshift;
118 unsigned char rshift;
119 };
120 unsigned long immediate;
Masami Hiramatsua6682812018-08-29 01:18:43 +0900121 void *data;
Masami Hiramatsu53305922018-04-25 21:18:03 +0900122 };
123};
124
125/* fetch + deref*N + store + mod + end <= 16, this allows N=12, enough */
126#define FETCH_INSN_MAX 16
127
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530128/* Fetch type information table */
129struct fetch_type {
130 const char *name; /* Name of type */
131 size_t size; /* Byte size of type */
132 int is_signed; /* Signed flag */
133 print_type_func_t print; /* Print functions */
134 const char *fmt; /* Fromat string */
135 const char *fmttype; /* Name in format file */
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530136};
137
Namhyung Kim34fee3a2013-11-26 14:56:28 +0900138/* For defining macros, define string/string_size types */
139typedef u32 string;
140typedef u32 string_size;
141
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900142#define PRINT_TYPE_FUNC_NAME(type) print_type_##type
143#define PRINT_TYPE_FMT_NAME(type) print_type_format_##type
144
145/* Printing in basic type function template */
146#define DECLARE_BASIC_PRINT_TYPE_FUNC(type) \
Masami Hiramatsu56de7632018-04-25 21:16:36 +0900147int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, void *data, void *ent);\
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900148extern const char PRINT_TYPE_FMT_NAME(type)[]
149
150DECLARE_BASIC_PRINT_TYPE_FUNC(u8);
151DECLARE_BASIC_PRINT_TYPE_FUNC(u16);
152DECLARE_BASIC_PRINT_TYPE_FUNC(u32);
153DECLARE_BASIC_PRINT_TYPE_FUNC(u64);
154DECLARE_BASIC_PRINT_TYPE_FUNC(s8);
155DECLARE_BASIC_PRINT_TYPE_FUNC(s16);
156DECLARE_BASIC_PRINT_TYPE_FUNC(s32);
157DECLARE_BASIC_PRINT_TYPE_FUNC(s64);
Masami Hiramatsu17ce3dc2016-08-18 17:57:50 +0900158DECLARE_BASIC_PRINT_TYPE_FUNC(x8);
159DECLARE_BASIC_PRINT_TYPE_FUNC(x16);
160DECLARE_BASIC_PRINT_TYPE_FUNC(x32);
161DECLARE_BASIC_PRINT_TYPE_FUNC(x64);
162
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900163DECLARE_BASIC_PRINT_TYPE_FUNC(string);
Masami Hiramatsu60c2e0c2018-04-25 21:20:28 +0900164DECLARE_BASIC_PRINT_TYPE_FUNC(symbol);
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900165
166/* Default (unsigned long) fetch type */
Masami Hiramatsubdca79c22016-08-18 17:59:21 +0900167#define __DEFAULT_FETCH_TYPE(t) x##t
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900168#define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t)
169#define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG)
170#define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE)
171
Masami Hiramatsu60c2e0c2018-04-25 21:20:28 +0900172#define __ADDR_FETCH_TYPE(t) u##t
173#define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t)
174#define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG)
175
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900176#define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
177 {.name = _name, \
178 .size = _size, \
179 .is_signed = sign, \
180 .print = PRINT_TYPE_FUNC_NAME(ptype), \
181 .fmt = PRINT_TYPE_FMT_NAME(ptype), \
182 .fmttype = _fmttype, \
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900183 }
Masami Hiramatsu60c2e0c2018-04-25 21:20:28 +0900184#define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
185 __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, #_fmttype)
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900186#define ASSIGN_FETCH_TYPE(ptype, ftype, sign) \
Masami Hiramatsu60c2e0c2018-04-25 21:20:28 +0900187 _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype)
Namhyung Kimb26c74e2013-11-26 14:19:59 +0900188
Masami Hiramatsu17ce3dc2016-08-18 17:57:50 +0900189/* If ptype is an alias of atype, use this macro (show atype in format) */
190#define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign) \
Masami Hiramatsu60c2e0c2018-04-25 21:20:28 +0900191 _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype)
Masami Hiramatsu17ce3dc2016-08-18 17:57:50 +0900192
Namhyung Kim34fee3a2013-11-26 14:56:28 +0900193#define ASSIGN_FETCH_TYPE_END {}
Masami Hiramatsu40b53b72018-04-25 21:21:55 +0900194#define MAX_ARRAY_LEN 64
Namhyung Kim34fee3a2013-11-26 14:56:28 +0900195
Anton Blanchard6b0b7552017-02-16 17:00:50 +1100196#ifdef CONFIG_KPROBE_EVENTS
Masami Hiramatsub4da3342018-01-13 02:54:04 +0900197bool trace_kprobe_on_func_entry(struct trace_event_call *call);
198bool trace_kprobe_error_injectable(struct trace_event_call *call);
Namhyung Kim1301a442013-11-26 15:21:04 +0900199#else
Masami Hiramatsub4da3342018-01-13 02:54:04 +0900200static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call)
Josef Bacik9802d862017-12-11 11:36:48 -0500201{
Masami Hiramatsub4da3342018-01-13 02:54:04 +0900202 return false;
Josef Bacik9802d862017-12-11 11:36:48 -0500203}
204
Masami Hiramatsub4da3342018-01-13 02:54:04 +0900205static inline bool trace_kprobe_error_injectable(struct trace_event_call *call)
Josef Bacik9802d862017-12-11 11:36:48 -0500206{
Masami Hiramatsub4da3342018-01-13 02:54:04 +0900207 return false;
Josef Bacik9802d862017-12-11 11:36:48 -0500208}
Anton Blanchard6b0b7552017-02-16 17:00:50 +1100209#endif /* CONFIG_KPROBE_EVENTS */
Namhyung Kim1301a442013-11-26 15:21:04 +0900210
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530211struct probe_arg {
Masami Hiramatsu53305922018-04-25 21:18:03 +0900212 struct fetch_insn *code;
213 bool dynamic;/* Dynamic array (string) is used */
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530214 unsigned int offset; /* Offset from argument entry */
Masami Hiramatsu40b53b72018-04-25 21:21:55 +0900215 unsigned int count; /* Array count */
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530216 const char *name; /* Name of this argument */
217 const char *comm; /* Command of this argument */
Masami Hiramatsu40b53b72018-04-25 21:21:55 +0900218 char *fmt; /* Format string if needed */
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530219 const struct fetch_type *type; /* Type of this argument */
220};
221
Namhyung Kimc31ffb32013-07-03 13:50:51 +0900222struct trace_probe {
223 unsigned int flags; /* For TP_FLAG_* */
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -0400224 struct trace_event_class class;
225 struct trace_event_call call;
Namhyung Kimc31ffb32013-07-03 13:50:51 +0900226 struct list_head files;
227 ssize_t size; /* trace entry size */
228 unsigned int nr_args;
229 struct probe_arg args[];
230};
231
zhangwei(Jovi)70ed91c2014-01-17 17:08:38 +0900232struct event_file_link {
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -0400233 struct trace_event_file *file;
zhangwei(Jovi)70ed91c2014-01-17 17:08:38 +0900234 struct list_head list;
235};
236
Namhyung Kimc31ffb32013-07-03 13:50:51 +0900237static inline bool trace_probe_is_enabled(struct trace_probe *tp)
238{
239 return !!(tp->flags & (TP_FLAG_TRACE | TP_FLAG_PROFILE));
240}
241
242static inline bool trace_probe_is_registered(struct trace_probe *tp)
243{
244 return !!(tp->flags & TP_FLAG_REGISTERED);
245}
246
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530247/* Check the name is good for event/group/fields */
Yaowei Baif0132c42015-09-22 21:43:13 +0800248static inline bool is_good_name(const char *name)
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530249{
250 if (!isalpha(*name) && *name != '_')
Yaowei Baif0132c42015-09-22 21:43:13 +0800251 return false;
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530252 while (*++name != '\0') {
253 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
Yaowei Baif0132c42015-09-22 21:43:13 +0800254 return false;
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530255 }
Yaowei Baif0132c42015-09-22 21:43:13 +0800256 return true;
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530257}
258
zhangwei(Jovi)70ed91c2014-01-17 17:08:38 +0900259static inline struct event_file_link *
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -0400260find_event_file_link(struct trace_probe *tp, struct trace_event_file *file)
zhangwei(Jovi)70ed91c2014-01-17 17:08:38 +0900261{
262 struct event_file_link *link;
263
264 list_for_each_entry(link, &tp->files, list)
265 if (link->file == file)
266 return link;
267
268 return NULL;
269}
270
Masami Hiramatsua1303af2018-04-25 21:21:26 +0900271#define TPARG_FL_RETURN BIT(0)
272#define TPARG_FL_KERNEL BIT(1)
273#define TPARG_FL_FENTRY BIT(2)
274#define TPARG_FL_MASK GENMASK(2, 0)
275
Masami Hiramatsud00bbea92018-11-05 18:01:40 +0900276extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i,
277 char *arg, unsigned int flags);
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530278
Masami Hiramatsua6682812018-08-29 01:18:43 +0900279extern int traceprobe_update_arg(struct probe_arg *arg);
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530280extern void traceprobe_free_probe_arg(struct probe_arg *arg);
281
Masami Hiramatsuc5d343b2018-03-17 21:38:10 +0900282extern int traceprobe_split_symbol_offset(char *symbol, long *offset);
Masami Hiramatsu6212dd22018-11-05 18:02:36 +0900283extern int traceprobe_parse_event_name(const char **pevent,
284 const char **pgroup, char *buf);
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530285
Masami Hiramatsu0a46c852018-04-25 21:19:30 +0900286extern int traceprobe_set_print_fmt(struct trace_probe *tp, bool is_return);
Song Liue12f03d2017-12-06 14:45:15 -0800287
288#ifdef CONFIG_PERF_EVENTS
289extern struct trace_event_call *
290create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
291 bool is_return);
292extern void destroy_local_trace_kprobe(struct trace_event_call *event_call);
Song Liu33ea4b22017-12-06 14:45:16 -0800293
294extern struct trace_event_call *
Song Liua6ca88b2018-10-01 22:36:36 -0700295create_local_trace_uprobe(char *name, unsigned long offs,
296 unsigned long ref_ctr_offset, bool is_return);
Song Liu33ea4b22017-12-06 14:45:16 -0800297extern void destroy_local_trace_uprobe(struct trace_event_call *event_call);
Song Liue12f03d2017-12-06 14:45:15 -0800298#endif
Masami Hiramatsueeb07b02018-04-25 21:17:05 +0900299extern int traceprobe_define_arg_fields(struct trace_event_call *event_call,
300 size_t offset, struct trace_probe *tp);