x86: ptrace: Add function argument access API
[linux-2.6-block.git] / kernel / trace / trace_probe.h
CommitLineData
bcea3f96 1// SPDX-License-Identifier: GPL-2.0
8ab83f56
SD
2/*
3 * Common header file for probe-based Dynamic events.
4 *
8ab83f56
SD
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>
8434dc93 16#include <linux/tracefs.h>
8ab83f56
SD
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 <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
40b53b77 33#define MAX_ARRAY_LEN 64
8ab83f56
SD
34#define MAX_STRING_SIZE PATH_MAX
35
36/* Reserved field names */
37#define FIELD_STRING_IP "__probe_ip"
38#define FIELD_STRING_RETIP "__probe_ret_ip"
39#define FIELD_STRING_FUNC "__probe_func"
40
41#undef DEFINE_FIELD
42#define DEFINE_FIELD(type, item, name, is_signed) \
43 do { \
44 ret = trace_define_field(event_call, #type, name, \
45 offsetof(typeof(field), item), \
46 sizeof(field.item), is_signed, \
47 FILTER_OTHER); \
48 if (ret) \
49 return ret; \
50 } while (0)
51
52
53/* Flags for trace_probe */
54#define TP_FLAG_TRACE 1
55#define TP_FLAG_PROFILE 2
56#define TP_FLAG_REGISTERED 4
57
9178412d
MH
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)
8ab83f56 63
3da0f180 64static nokprobe_inline void *get_loc_data(u32 *dl, void *ent)
b26c74e1 65{
9178412d 66 return (u8 *)ent + get_loc_offs(*dl);
b26c74e1
NK
67}
68
40b53b77
MH
69static 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
8ab83f56 77/* Printing function type */
56de7630 78typedef int (*print_type_func_t)(struct trace_seq *, void *, void *);
8ab83f56 79
53305928
MH
80enum 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_FOFFS, /* File offset: .immediate */
90 // Stage 2 (dereference) op
91 FETCH_OP_DEREF, /* Dereference: .offset */
92 // Stage 3 (store) ops
93 FETCH_OP_ST_RAW, /* Raw: .size */
94 FETCH_OP_ST_MEM, /* Mem: .offset, .size */
95 FETCH_OP_ST_STRING, /* String: .offset, .size */
96 // Stage 4 (modify) op
97 FETCH_OP_MOD_BF, /* Bitfield: .basesize, .lshift, .rshift */
40b53b77
MH
98 // Stage 5 (loop) op
99 FETCH_OP_LP_ARRAY, /* Array: .param = loop count */
53305928 100 FETCH_OP_END,
8ab83f56
SD
101};
102
53305928
MH
103struct fetch_insn {
104 enum fetch_op op;
105 union {
106 unsigned int param;
107 struct {
108 unsigned int size;
109 int offset;
110 };
111 struct {
112 unsigned char basesize;
113 unsigned char lshift;
114 unsigned char rshift;
115 };
116 unsigned long immediate;
117 };
118};
119
120/* fetch + deref*N + store + mod + end <= 16, this allows N=12, enough */
121#define FETCH_INSN_MAX 16
122
8ab83f56
SD
123/* Fetch type information table */
124struct fetch_type {
125 const char *name; /* Name of type */
126 size_t size; /* Byte size of type */
127 int is_signed; /* Signed flag */
128 print_type_func_t print; /* Print functions */
129 const char *fmt; /* Fromat string */
130 const char *fmttype; /* Name in format file */
8ab83f56
SD
131};
132
34fee3a1
NK
133/* For defining macros, define string/string_size types */
134typedef u32 string;
135typedef u32 string_size;
136
b26c74e1
NK
137#define PRINT_TYPE_FUNC_NAME(type) print_type_##type
138#define PRINT_TYPE_FMT_NAME(type) print_type_format_##type
139
140/* Printing in basic type function template */
141#define DECLARE_BASIC_PRINT_TYPE_FUNC(type) \
56de7630 142int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, void *data, void *ent);\
b26c74e1
NK
143extern const char PRINT_TYPE_FMT_NAME(type)[]
144
145DECLARE_BASIC_PRINT_TYPE_FUNC(u8);
146DECLARE_BASIC_PRINT_TYPE_FUNC(u16);
147DECLARE_BASIC_PRINT_TYPE_FUNC(u32);
148DECLARE_BASIC_PRINT_TYPE_FUNC(u64);
149DECLARE_BASIC_PRINT_TYPE_FUNC(s8);
150DECLARE_BASIC_PRINT_TYPE_FUNC(s16);
151DECLARE_BASIC_PRINT_TYPE_FUNC(s32);
152DECLARE_BASIC_PRINT_TYPE_FUNC(s64);
17ce3dc7
MH
153DECLARE_BASIC_PRINT_TYPE_FUNC(x8);
154DECLARE_BASIC_PRINT_TYPE_FUNC(x16);
155DECLARE_BASIC_PRINT_TYPE_FUNC(x32);
156DECLARE_BASIC_PRINT_TYPE_FUNC(x64);
157
b26c74e1 158DECLARE_BASIC_PRINT_TYPE_FUNC(string);
60c2e0ce 159DECLARE_BASIC_PRINT_TYPE_FUNC(symbol);
b26c74e1
NK
160
161/* Default (unsigned long) fetch type */
bdca79c2 162#define __DEFAULT_FETCH_TYPE(t) x##t
b26c74e1
NK
163#define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t)
164#define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG)
165#define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE)
166
60c2e0ce
MH
167#define __ADDR_FETCH_TYPE(t) u##t
168#define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t)
169#define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG)
170
b26c74e1
NK
171#define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
172 {.name = _name, \
173 .size = _size, \
174 .is_signed = sign, \
175 .print = PRINT_TYPE_FUNC_NAME(ptype), \
176 .fmt = PRINT_TYPE_FMT_NAME(ptype), \
177 .fmttype = _fmttype, \
b26c74e1 178 }
60c2e0ce
MH
179#define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
180 __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, #_fmttype)
b26c74e1 181#define ASSIGN_FETCH_TYPE(ptype, ftype, sign) \
60c2e0ce 182 _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype)
b26c74e1 183
17ce3dc7
MH
184/* If ptype is an alias of atype, use this macro (show atype in format) */
185#define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign) \
60c2e0ce 186 _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype)
17ce3dc7 187
34fee3a1 188#define ASSIGN_FETCH_TYPE_END {}
40b53b77 189#define MAX_ARRAY_LEN 64
34fee3a1 190
6b0b7551 191#ifdef CONFIG_KPROBE_EVENTS
b4da3340
MH
192bool trace_kprobe_on_func_entry(struct trace_event_call *call);
193bool trace_kprobe_error_injectable(struct trace_event_call *call);
1301a44e 194#else
b4da3340 195static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call)
9802d865 196{
b4da3340 197 return false;
9802d865
JB
198}
199
b4da3340 200static inline bool trace_kprobe_error_injectable(struct trace_event_call *call)
9802d865 201{
b4da3340 202 return false;
9802d865 203}
6b0b7551 204#endif /* CONFIG_KPROBE_EVENTS */
1301a44e 205
8ab83f56 206struct probe_arg {
53305928
MH
207 struct fetch_insn *code;
208 bool dynamic;/* Dynamic array (string) is used */
8ab83f56 209 unsigned int offset; /* Offset from argument entry */
40b53b77 210 unsigned int count; /* Array count */
8ab83f56
SD
211 const char *name; /* Name of this argument */
212 const char *comm; /* Command of this argument */
40b53b77 213 char *fmt; /* Format string if needed */
8ab83f56
SD
214 const struct fetch_type *type; /* Type of this argument */
215};
216
c31ffb3f
NK
217struct trace_probe {
218 unsigned int flags; /* For TP_FLAG_* */
2425bcb9
SRRH
219 struct trace_event_class class;
220 struct trace_event_call call;
c31ffb3f
NK
221 struct list_head files;
222 ssize_t size; /* trace entry size */
223 unsigned int nr_args;
224 struct probe_arg args[];
225};
226
70ed91c6 227struct event_file_link {
7f1d2f82 228 struct trace_event_file *file;
70ed91c6
J
229 struct list_head list;
230};
231
c31ffb3f
NK
232static inline bool trace_probe_is_enabled(struct trace_probe *tp)
233{
234 return !!(tp->flags & (TP_FLAG_TRACE | TP_FLAG_PROFILE));
235}
236
237static inline bool trace_probe_is_registered(struct trace_probe *tp)
238{
239 return !!(tp->flags & TP_FLAG_REGISTERED);
240}
241
8ab83f56 242/* Check the name is good for event/group/fields */
f0132c4e 243static inline bool is_good_name(const char *name)
8ab83f56
SD
244{
245 if (!isalpha(*name) && *name != '_')
f0132c4e 246 return false;
8ab83f56
SD
247 while (*++name != '\0') {
248 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
f0132c4e 249 return false;
8ab83f56 250 }
f0132c4e 251 return true;
8ab83f56
SD
252}
253
70ed91c6 254static inline struct event_file_link *
7f1d2f82 255find_event_file_link(struct trace_probe *tp, struct trace_event_file *file)
70ed91c6
J
256{
257 struct event_file_link *link;
258
259 list_for_each_entry(link, &tp->files, list)
260 if (link->file == file)
261 return link;
262
263 return NULL;
264}
265
8ab83f56 266extern int traceprobe_parse_probe_arg(char *arg, ssize_t *size,
f451bc89 267 struct probe_arg *parg, bool is_return, bool is_kprobe);
8ab83f56
SD
268
269extern int traceprobe_conflict_field_name(const char *name,
270 struct probe_arg *args, int narg);
271
272extern void traceprobe_update_arg(struct probe_arg *arg);
273extern void traceprobe_free_probe_arg(struct probe_arg *arg);
274
c5d343b6 275extern int traceprobe_split_symbol_offset(char *symbol, long *offset);
8ab83f56 276
0a46c854 277extern int traceprobe_set_print_fmt(struct trace_probe *tp, bool is_return);
e12f03d7
SL
278
279#ifdef CONFIG_PERF_EVENTS
280extern struct trace_event_call *
281create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
282 bool is_return);
283extern void destroy_local_trace_kprobe(struct trace_event_call *event_call);
33ea4b24
SL
284
285extern struct trace_event_call *
a6ca88b2
SL
286create_local_trace_uprobe(char *name, unsigned long offs,
287 unsigned long ref_ctr_offset, bool is_return);
33ea4b24 288extern void destroy_local_trace_uprobe(struct trace_event_call *event_call);
e12f03d7 289#endif
eeb07b06
MH
290extern int traceprobe_define_arg_fields(struct trace_event_call *event_call,
291 size_t offset, struct trace_probe *tp);