]> git.proxmox.com Git - mirror_ubuntu-disco-kernel.git/blame - kernel/trace/trace_kprobe.c
tracing/kprobe: bpf: Check error injectable event is on function entry
[mirror_ubuntu-disco-kernel.git] / kernel / trace / trace_kprobe.c
CommitLineData
413d37d1 1/*
77b44d1b 2 * Kprobes-based tracing events
413d37d1
MH
3 *
4 * Created by Masami Hiramatsu <mhiramat@redhat.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
72576341 19#define pr_fmt(fmt) "trace_kprobe: " fmt
413d37d1
MH
20
21#include <linux/module.h>
22#include <linux/uaccess.h>
b2d09103 23#include <linux/rculist.h>
413d37d1 24
8ab83f56 25#include "trace_probe.h"
1ff511e3 26
8ab83f56 27#define KPROBE_EVENT_SYSTEM "kprobes"
696ced4f 28#define KRETPROBE_MAXACTIVE_MAX 4096
e09c8614 29
413d37d1 30/**
77b44d1b 31 * Kprobe event core functions
413d37d1 32 */
c31ffb3f 33struct trace_kprobe {
413d37d1 34 struct list_head list;
4a846b44 35 struct kretprobe rp; /* Use rp.kp for kprobe use */
a7636d9e 36 unsigned long __percpu *nhit;
413d37d1 37 const char *symbol; /* symbol name */
c31ffb3f 38 struct trace_probe tp;
413d37d1
MH
39};
40
c31ffb3f
NK
41#define SIZEOF_TRACE_KPROBE(n) \
42 (offsetof(struct trace_kprobe, tp.args) + \
eca0d916 43 (sizeof(struct probe_arg) * (n)))
a82378d8 44
9802d865 45DEFINE_PER_CPU(int, bpf_kprobe_override);
93ccae7a 46
3da0f180 47static nokprobe_inline bool trace_kprobe_is_return(struct trace_kprobe *tk)
413d37d1 48{
c31ffb3f 49 return tk->rp.handler != NULL;
413d37d1
MH
50}
51
3da0f180 52static nokprobe_inline const char *trace_kprobe_symbol(struct trace_kprobe *tk)
413d37d1 53{
c31ffb3f 54 return tk->symbol ? tk->symbol : "unknown";
413d37d1
MH
55}
56
3da0f180 57static nokprobe_inline unsigned long trace_kprobe_offset(struct trace_kprobe *tk)
61424318 58{
c31ffb3f 59 return tk->rp.kp.offset;
61424318
MH
60}
61
3da0f180 62static nokprobe_inline bool trace_kprobe_has_gone(struct trace_kprobe *tk)
61424318 63{
c31ffb3f 64 return !!(kprobe_gone(&tk->rp.kp));
61424318
MH
65}
66
3da0f180 67static nokprobe_inline bool trace_kprobe_within_module(struct trace_kprobe *tk,
c31ffb3f 68 struct module *mod)
61424318
MH
69{
70 int len = strlen(mod->name);
c31ffb3f 71 const char *name = trace_kprobe_symbol(tk);
61424318
MH
72 return strncmp(mod->name, name, len) == 0 && name[len] == ':';
73}
74
3da0f180 75static nokprobe_inline bool trace_kprobe_is_on_module(struct trace_kprobe *tk)
61424318 76{
c31ffb3f 77 return !!strchr(trace_kprobe_symbol(tk), ':');
61424318
MH
78}
79
f18f97ac
MN
80static nokprobe_inline unsigned long trace_kprobe_nhit(struct trace_kprobe *tk)
81{
82 unsigned long nhit = 0;
83 int cpu;
84
85 for_each_possible_cpu(cpu)
86 nhit += *per_cpu_ptr(tk->nhit, cpu);
87
88 return nhit;
89}
90
b4da3340 91bool trace_kprobe_on_func_entry(struct trace_event_call *call)
9802d865
JB
92{
93 struct trace_kprobe *tk = (struct trace_kprobe *)call->data;
b4da3340
MH
94
95 return kprobe_on_func_entry(tk->rp.kp.addr,
96 tk->rp.kp.addr ? NULL : tk->rp.kp.symbol_name,
97 tk->rp.kp.addr ? 0 : tk->rp.kp.offset);
9802d865
JB
98}
99
b4da3340 100bool trace_kprobe_error_injectable(struct trace_event_call *call)
9802d865
JB
101{
102 struct trace_kprobe *tk = (struct trace_kprobe *)call->data;
103 unsigned long addr;
104
105 if (tk->symbol) {
106 addr = (unsigned long)
107 kallsyms_lookup_name(trace_kprobe_symbol(tk));
108 addr += tk->rp.kp.offset;
109 } else {
110 addr = (unsigned long)tk->rp.kp.addr;
111 }
112 return within_kprobe_error_injection_list(addr);
113}
114
c31ffb3f
NK
115static int register_kprobe_event(struct trace_kprobe *tk);
116static int unregister_kprobe_event(struct trace_kprobe *tk);
413d37d1
MH
117
118static DEFINE_MUTEX(probe_lock);
119static LIST_HEAD(probe_list);
120
50d78056
MH
121static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs);
122static int kretprobe_dispatcher(struct kretprobe_instance *ri,
123 struct pt_regs *regs);
124
1301a44e
NK
125/* Memory fetching by symbol */
126struct symbol_cache {
127 char *symbol;
128 long offset;
129 unsigned long addr;
130};
131
132unsigned long update_symbol_cache(struct symbol_cache *sc)
133{
134 sc->addr = (unsigned long)kallsyms_lookup_name(sc->symbol);
135
136 if (sc->addr)
137 sc->addr += sc->offset;
138
139 return sc->addr;
140}
141
142void free_symbol_cache(struct symbol_cache *sc)
143{
144 kfree(sc->symbol);
145 kfree(sc);
146}
147
148struct symbol_cache *alloc_symbol_cache(const char *sym, long offset)
149{
150 struct symbol_cache *sc;
151
152 if (!sym || strlen(sym) == 0)
153 return NULL;
154
155 sc = kzalloc(sizeof(struct symbol_cache), GFP_KERNEL);
156 if (!sc)
157 return NULL;
158
159 sc->symbol = kstrdup(sym, GFP_KERNEL);
160 if (!sc->symbol) {
161 kfree(sc);
162 return NULL;
163 }
164 sc->offset = offset;
165 update_symbol_cache(sc);
166
167 return sc;
168}
169
3fd996a2
NK
170/*
171 * Kprobes-specific fetch functions
172 */
173#define DEFINE_FETCH_stack(type) \
3da0f180 174static void FETCH_FUNC_NAME(stack, type)(struct pt_regs *regs, \
3fd996a2
NK
175 void *offset, void *dest) \
176{ \
177 *(type *)dest = (type)regs_get_kernel_stack_nth(regs, \
178 (unsigned int)((unsigned long)offset)); \
3da0f180
MH
179} \
180NOKPROBE_SYMBOL(FETCH_FUNC_NAME(stack, type));
181
3fd996a2
NK
182DEFINE_BASIC_FETCH_FUNCS(stack)
183/* No string on the stack entry */
184#define fetch_stack_string NULL
185#define fetch_stack_string_size NULL
186
5baaa59e 187#define DEFINE_FETCH_memory(type) \
3da0f180 188static void FETCH_FUNC_NAME(memory, type)(struct pt_regs *regs, \
5baaa59e
NK
189 void *addr, void *dest) \
190{ \
191 type retval; \
192 if (probe_kernel_address(addr, retval)) \
193 *(type *)dest = 0; \
194 else \
195 *(type *)dest = retval; \
3da0f180
MH
196} \
197NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, type));
198
5baaa59e
NK
199DEFINE_BASIC_FETCH_FUNCS(memory)
200/*
201 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
202 * length and relative data location.
203 */
3da0f180
MH
204static void FETCH_FUNC_NAME(memory, string)(struct pt_regs *regs,
205 void *addr, void *dest)
5baaa59e 206{
5baaa59e
NK
207 int maxlen = get_rloc_len(*(u32 *)dest);
208 u8 *dst = get_rloc_data(dest);
1a6877b9 209 long ret;
5baaa59e
NK
210
211 if (!maxlen)
212 return;
213
214 /*
215 * Try to get string again, since the string can be changed while
216 * probing.
217 */
1a6877b9 218 ret = strncpy_from_unsafe(dst, addr, maxlen);
5baaa59e
NK
219
220 if (ret < 0) { /* Failed to fetch string */
1a6877b9 221 dst[0] = '\0';
5baaa59e
NK
222 *(u32 *)dest = make_data_rloc(0, get_rloc_offs(*(u32 *)dest));
223 } else {
1a6877b9 224 *(u32 *)dest = make_data_rloc(ret, get_rloc_offs(*(u32 *)dest));
5baaa59e
NK
225 }
226}
3da0f180 227NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, string));
5baaa59e
NK
228
229/* Return the length of string -- including null terminal byte */
3da0f180
MH
230static void FETCH_FUNC_NAME(memory, string_size)(struct pt_regs *regs,
231 void *addr, void *dest)
5baaa59e
NK
232{
233 mm_segment_t old_fs;
234 int ret, len = 0;
235 u8 c;
236
237 old_fs = get_fs();
238 set_fs(KERNEL_DS);
239 pagefault_disable();
240
241 do {
242 ret = __copy_from_user_inatomic(&c, (u8 *)addr + len, 1);
243 len++;
244 } while (c && ret == 0 && len < MAX_STRING_SIZE);
245
246 pagefault_enable();
247 set_fs(old_fs);
248
249 if (ret < 0) /* Failed to check the length */
250 *(u32 *)dest = 0;
251 else
252 *(u32 *)dest = len;
253}
3da0f180 254NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, string_size));
5baaa59e 255
1301a44e 256#define DEFINE_FETCH_symbol(type) \
3da0f180 257void FETCH_FUNC_NAME(symbol, type)(struct pt_regs *regs, void *data, void *dest)\
1301a44e
NK
258{ \
259 struct symbol_cache *sc = data; \
260 if (sc->addr) \
261 fetch_memory_##type(regs, (void *)sc->addr, dest); \
262 else \
263 *(type *)dest = 0; \
3da0f180
MH
264} \
265NOKPROBE_SYMBOL(FETCH_FUNC_NAME(symbol, type));
266
1301a44e
NK
267DEFINE_BASIC_FETCH_FUNCS(symbol)
268DEFINE_FETCH_symbol(string)
269DEFINE_FETCH_symbol(string_size)
270
b7e0bf34
NK
271/* kprobes don't support file_offset fetch methods */
272#define fetch_file_offset_u8 NULL
273#define fetch_file_offset_u16 NULL
274#define fetch_file_offset_u32 NULL
275#define fetch_file_offset_u64 NULL
276#define fetch_file_offset_string NULL
277#define fetch_file_offset_string_size NULL
278
34fee3a1 279/* Fetch type information table */
d9a16d3a 280static const struct fetch_type kprobes_fetch_type_table[] = {
34fee3a1
NK
281 /* Special types */
282 [FETCH_TYPE_STRING] = __ASSIGN_FETCH_TYPE("string", string, string,
283 sizeof(u32), 1, "__data_loc char[]"),
284 [FETCH_TYPE_STRSIZE] = __ASSIGN_FETCH_TYPE("string_size", u32,
285 string_size, sizeof(u32), 0, "u32"),
286 /* Basic types */
287 ASSIGN_FETCH_TYPE(u8, u8, 0),
288 ASSIGN_FETCH_TYPE(u16, u16, 0),
289 ASSIGN_FETCH_TYPE(u32, u32, 0),
290 ASSIGN_FETCH_TYPE(u64, u64, 0),
291 ASSIGN_FETCH_TYPE(s8, u8, 1),
292 ASSIGN_FETCH_TYPE(s16, u16, 1),
293 ASSIGN_FETCH_TYPE(s32, u32, 1),
294 ASSIGN_FETCH_TYPE(s64, u64, 1),
17ce3dc7
MH
295 ASSIGN_FETCH_TYPE_ALIAS(x8, u8, u8, 0),
296 ASSIGN_FETCH_TYPE_ALIAS(x16, u16, u16, 0),
297 ASSIGN_FETCH_TYPE_ALIAS(x32, u32, u32, 0),
298 ASSIGN_FETCH_TYPE_ALIAS(x64, u64, u64, 0),
34fee3a1
NK
299
300 ASSIGN_FETCH_TYPE_END
301};
302
4a846b44
MH
303/*
304 * Allocate new trace_probe and initialize it (including kprobes).
305 */
c31ffb3f 306static struct trace_kprobe *alloc_trace_kprobe(const char *group,
f52487e9 307 const char *event,
4a846b44
MH
308 void *addr,
309 const char *symbol,
310 unsigned long offs,
696ced4f 311 int maxactive,
3a6b7666 312 int nargs, bool is_return)
413d37d1 313{
c31ffb3f 314 struct trace_kprobe *tk;
6f3cf440 315 int ret = -ENOMEM;
413d37d1 316
c31ffb3f
NK
317 tk = kzalloc(SIZEOF_TRACE_KPROBE(nargs), GFP_KERNEL);
318 if (!tk)
6f3cf440 319 return ERR_PTR(ret);
413d37d1 320
a7636d9e
MKL
321 tk->nhit = alloc_percpu(unsigned long);
322 if (!tk->nhit)
323 goto error;
324
413d37d1 325 if (symbol) {
c31ffb3f
NK
326 tk->symbol = kstrdup(symbol, GFP_KERNEL);
327 if (!tk->symbol)
413d37d1 328 goto error;
c31ffb3f
NK
329 tk->rp.kp.symbol_name = tk->symbol;
330 tk->rp.kp.offset = offs;
4a846b44 331 } else
c31ffb3f 332 tk->rp.kp.addr = addr;
4a846b44
MH
333
334 if (is_return)
c31ffb3f 335 tk->rp.handler = kretprobe_dispatcher;
4a846b44 336 else
c31ffb3f 337 tk->rp.kp.pre_handler = kprobe_dispatcher;
4a846b44 338
696ced4f
AC
339 tk->rp.maxactive = maxactive;
340
da34634f 341 if (!event || !is_good_name(event)) {
6f3cf440 342 ret = -EINVAL;
4263565d 343 goto error;
6f3cf440
MH
344 }
345
c31ffb3f
NK
346 tk->tp.call.class = &tk->tp.class;
347 tk->tp.call.name = kstrdup(event, GFP_KERNEL);
348 if (!tk->tp.call.name)
4263565d 349 goto error;
413d37d1 350
da34634f 351 if (!group || !is_good_name(group)) {
6f3cf440 352 ret = -EINVAL;
f52487e9 353 goto error;
6f3cf440
MH
354 }
355
c31ffb3f
NK
356 tk->tp.class.system = kstrdup(group, GFP_KERNEL);
357 if (!tk->tp.class.system)
f52487e9
MH
358 goto error;
359
c31ffb3f
NK
360 INIT_LIST_HEAD(&tk->list);
361 INIT_LIST_HEAD(&tk->tp.files);
362 return tk;
413d37d1 363error:
c31ffb3f
NK
364 kfree(tk->tp.call.name);
365 kfree(tk->symbol);
a7636d9e 366 free_percpu(tk->nhit);
c31ffb3f 367 kfree(tk);
6f3cf440 368 return ERR_PTR(ret);
413d37d1
MH
369}
370
c31ffb3f 371static void free_trace_kprobe(struct trace_kprobe *tk)
413d37d1
MH
372{
373 int i;
374
c31ffb3f
NK
375 for (i = 0; i < tk->tp.nr_args; i++)
376 traceprobe_free_probe_arg(&tk->tp.args[i]);
413d37d1 377
c31ffb3f
NK
378 kfree(tk->tp.call.class->system);
379 kfree(tk->tp.call.name);
380 kfree(tk->symbol);
a7636d9e 381 free_percpu(tk->nhit);
c31ffb3f 382 kfree(tk);
413d37d1
MH
383}
384
c31ffb3f
NK
385static struct trace_kprobe *find_trace_kprobe(const char *event,
386 const char *group)
413d37d1 387{
c31ffb3f 388 struct trace_kprobe *tk;
413d37d1 389
c31ffb3f 390 list_for_each_entry(tk, &probe_list, list)
687fcc4a 391 if (strcmp(trace_event_name(&tk->tp.call), event) == 0 &&
c31ffb3f
NK
392 strcmp(tk->tp.call.class->system, group) == 0)
393 return tk;
413d37d1
MH
394 return NULL;
395}
396
41a7dd42
MH
397/*
398 * Enable trace_probe
399 * if the file is NULL, enable "perf" handler, or enable "trace" handler.
400 */
401static int
7f1d2f82 402enable_trace_kprobe(struct trace_kprobe *tk, struct trace_event_file *file)
1538f888
MH
403{
404 int ret = 0;
405
41a7dd42 406 if (file) {
b04d52e3
ON
407 struct event_file_link *link;
408
409 link = kmalloc(sizeof(*link), GFP_KERNEL);
410 if (!link) {
41a7dd42 411 ret = -ENOMEM;
3fe3d619 412 goto out;
41a7dd42 413 }
41a7dd42 414
b04d52e3 415 link->file = file;
c31ffb3f 416 list_add_tail_rcu(&link->list, &tk->tp.files);
41a7dd42 417
c31ffb3f 418 tk->tp.flags |= TP_FLAG_TRACE;
41a7dd42 419 } else
c31ffb3f 420 tk->tp.flags |= TP_FLAG_PROFILE;
41a7dd42 421
c31ffb3f
NK
422 if (trace_probe_is_registered(&tk->tp) && !trace_kprobe_has_gone(tk)) {
423 if (trace_kprobe_is_return(tk))
424 ret = enable_kretprobe(&tk->rp);
1538f888 425 else
c31ffb3f 426 ret = enable_kprobe(&tk->rp.kp);
1538f888 427 }
3fe3d619 428 out:
1538f888
MH
429 return ret;
430}
431
41a7dd42
MH
432/*
433 * Disable trace_probe
434 * if the file is NULL, disable "perf" handler, or disable "trace" handler.
435 */
436static int
7f1d2f82 437disable_trace_kprobe(struct trace_kprobe *tk, struct trace_event_file *file)
1538f888 438{
a232e270
MH
439 struct event_file_link *link = NULL;
440 int wait = 0;
41a7dd42
MH
441 int ret = 0;
442
41a7dd42 443 if (file) {
c31ffb3f 444 link = find_event_file_link(&tk->tp, file);
b04d52e3 445 if (!link) {
41a7dd42 446 ret = -EINVAL;
3fe3d619 447 goto out;
41a7dd42
MH
448 }
449
b04d52e3 450 list_del_rcu(&link->list);
a232e270 451 wait = 1;
c31ffb3f 452 if (!list_empty(&tk->tp.files))
b04d52e3 453 goto out;
41a7dd42 454
c31ffb3f 455 tk->tp.flags &= ~TP_FLAG_TRACE;
41a7dd42 456 } else
c31ffb3f 457 tk->tp.flags &= ~TP_FLAG_PROFILE;
41a7dd42 458
c31ffb3f
NK
459 if (!trace_probe_is_enabled(&tk->tp) && trace_probe_is_registered(&tk->tp)) {
460 if (trace_kprobe_is_return(tk))
461 disable_kretprobe(&tk->rp);
1538f888 462 else
c31ffb3f 463 disable_kprobe(&tk->rp.kp);
a232e270 464 wait = 1;
1538f888 465 }
3fe3d619 466 out:
a232e270
MH
467 if (wait) {
468 /*
469 * Synchronize with kprobe_trace_func/kretprobe_trace_func
470 * to ensure disabled (all running handlers are finished).
471 * This is not only for kfree(), but also the caller,
472 * trace_remove_event_call() supposes it for releasing
473 * event_call related objects, which will be accessed in
474 * the kprobe_trace_func/kretprobe_trace_func.
475 */
476 synchronize_sched();
477 kfree(link); /* Ignored if link == NULL */
478 }
479
41a7dd42 480 return ret;
1538f888
MH
481}
482
61424318 483/* Internal register function - just handle k*probes and flags */
c31ffb3f 484static int __register_trace_kprobe(struct trace_kprobe *tk)
413d37d1 485{
7f6878a3 486 int i, ret;
61424318 487
c31ffb3f 488 if (trace_probe_is_registered(&tk->tp))
61424318
MH
489 return -EINVAL;
490
c31ffb3f
NK
491 for (i = 0; i < tk->tp.nr_args; i++)
492 traceprobe_update_arg(&tk->tp.args[i]);
7f6878a3 493
61424318 494 /* Set/clear disabled flag according to tp->flag */
c31ffb3f
NK
495 if (trace_probe_is_enabled(&tk->tp))
496 tk->rp.kp.flags &= ~KPROBE_FLAG_DISABLED;
61424318 497 else
c31ffb3f 498 tk->rp.kp.flags |= KPROBE_FLAG_DISABLED;
61424318 499
c31ffb3f
NK
500 if (trace_kprobe_is_return(tk))
501 ret = register_kretprobe(&tk->rp);
413d37d1 502 else
c31ffb3f 503 ret = register_kprobe(&tk->rp.kp);
61424318
MH
504
505 if (ret == 0)
c31ffb3f 506 tk->tp.flags |= TP_FLAG_REGISTERED;
61424318 507 else {
a395d6a7
JP
508 pr_warn("Could not insert probe at %s+%lu: %d\n",
509 trace_kprobe_symbol(tk), trace_kprobe_offset(tk), ret);
c31ffb3f 510 if (ret == -ENOENT && trace_kprobe_is_on_module(tk)) {
a395d6a7 511 pr_warn("This probe might be able to register after target module is loaded. Continue.\n");
61424318
MH
512 ret = 0;
513 } else if (ret == -EILSEQ) {
a395d6a7
JP
514 pr_warn("Probing address(0x%p) is not an instruction boundary.\n",
515 tk->rp.kp.addr);
61424318
MH
516 ret = -EINVAL;
517 }
518 }
519
520 return ret;
521}
522
523/* Internal unregister function - just handle k*probes and flags */
c31ffb3f 524static void __unregister_trace_kprobe(struct trace_kprobe *tk)
61424318 525{
c31ffb3f
NK
526 if (trace_probe_is_registered(&tk->tp)) {
527 if (trace_kprobe_is_return(tk))
528 unregister_kretprobe(&tk->rp);
61424318 529 else
c31ffb3f
NK
530 unregister_kprobe(&tk->rp.kp);
531 tk->tp.flags &= ~TP_FLAG_REGISTERED;
61424318 532 /* Cleanup kprobe for reuse */
c31ffb3f
NK
533 if (tk->rp.kp.symbol_name)
534 tk->rp.kp.addr = NULL;
61424318
MH
535 }
536}
537
538/* Unregister a trace_probe and probe_event: call with locking probe_lock */
c31ffb3f 539static int unregister_trace_kprobe(struct trace_kprobe *tk)
61424318 540{
02ca1521 541 /* Enabled event can not be unregistered */
c31ffb3f 542 if (trace_probe_is_enabled(&tk->tp))
02ca1521
MH
543 return -EBUSY;
544
40c32592 545 /* Will fail if probe is being used by ftrace or perf */
c31ffb3f 546 if (unregister_kprobe_event(tk))
40c32592
SRRH
547 return -EBUSY;
548
c31ffb3f
NK
549 __unregister_trace_kprobe(tk);
550 list_del(&tk->list);
02ca1521
MH
551
552 return 0;
413d37d1
MH
553}
554
555/* Register a trace_probe and probe_event */
c31ffb3f 556static int register_trace_kprobe(struct trace_kprobe *tk)
413d37d1 557{
c31ffb3f 558 struct trace_kprobe *old_tk;
413d37d1
MH
559 int ret;
560
561 mutex_lock(&probe_lock);
562
61424318 563 /* Delete old (same name) event if exist */
687fcc4a 564 old_tk = find_trace_kprobe(trace_event_name(&tk->tp.call),
de7b2973 565 tk->tp.call.class->system);
c31ffb3f
NK
566 if (old_tk) {
567 ret = unregister_trace_kprobe(old_tk);
02ca1521
MH
568 if (ret < 0)
569 goto end;
c31ffb3f 570 free_trace_kprobe(old_tk);
2d5e067e 571 }
61424318
MH
572
573 /* Register new event */
c31ffb3f 574 ret = register_kprobe_event(tk);
2d5e067e 575 if (ret) {
a395d6a7 576 pr_warn("Failed to register probe event(%d)\n", ret);
2d5e067e
MH
577 goto end;
578 }
579
61424318 580 /* Register k*probe */
c31ffb3f 581 ret = __register_trace_kprobe(tk);
61424318 582 if (ret < 0)
c31ffb3f 583 unregister_kprobe_event(tk);
61424318 584 else
c31ffb3f 585 list_add_tail(&tk->list, &probe_list);
61424318 586
413d37d1
MH
587end:
588 mutex_unlock(&probe_lock);
589 return ret;
590}
591
61424318 592/* Module notifier call back, checking event on the module */
c31ffb3f 593static int trace_kprobe_module_callback(struct notifier_block *nb,
61424318
MH
594 unsigned long val, void *data)
595{
596 struct module *mod = data;
c31ffb3f 597 struct trace_kprobe *tk;
61424318
MH
598 int ret;
599
600 if (val != MODULE_STATE_COMING)
601 return NOTIFY_DONE;
602
603 /* Update probes on coming module */
604 mutex_lock(&probe_lock);
c31ffb3f
NK
605 list_for_each_entry(tk, &probe_list, list) {
606 if (trace_kprobe_within_module(tk, mod)) {
02ca1521 607 /* Don't need to check busy - this should have gone. */
c31ffb3f
NK
608 __unregister_trace_kprobe(tk);
609 ret = __register_trace_kprobe(tk);
61424318 610 if (ret)
a395d6a7
JP
611 pr_warn("Failed to re-register probe %s on %s: %d\n",
612 trace_event_name(&tk->tp.call),
613 mod->name, ret);
61424318
MH
614 }
615 }
616 mutex_unlock(&probe_lock);
617
618 return NOTIFY_DONE;
619}
620
c31ffb3f
NK
621static struct notifier_block trace_kprobe_module_nb = {
622 .notifier_call = trace_kprobe_module_callback,
61424318
MH
623 .priority = 1 /* Invoked after kprobe module callback */
624};
625
fca18a47
NR
626/* Convert certain expected symbols into '_' when generating event names */
627static inline void sanitize_event_name(char *name)
628{
629 while (*name++ != '\0')
630 if (*name == ':' || *name == '.')
631 *name = '_';
632}
633
c31ffb3f 634static int create_trace_kprobe(int argc, char **argv)
413d37d1
MH
635{
636 /*
637 * Argument syntax:
696ced4f
AC
638 * - Add kprobe:
639 * p[:[GRP/]EVENT] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS]
640 * - Add kretprobe:
641 * r[MAXACTIVE][:[GRP/]EVENT] [MOD:]KSYM[+0] [FETCHARGS]
413d37d1 642 * Fetch args:
2e06ff63
MH
643 * $retval : fetch return value
644 * $stack : fetch stack address
645 * $stackN : fetch Nth of stack (N:0-)
35abb67d 646 * $comm : fetch current task comm
413d37d1
MH
647 * @ADDR : fetch memory at ADDR (ADDR should be in kernel)
648 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol)
649 * %REG : fetch register REG
93ccae7a 650 * Dereferencing memory fetch:
413d37d1 651 * +|-offs(ARG) : fetch memory at ARG +|- offs address.
eca0d916
MH
652 * Alias name of args:
653 * NAME=FETCHARG : set NAME as alias of FETCHARG.
93ccae7a
MH
654 * Type of args:
655 * FETCHARG:TYPE : use TYPE instead of unsigned long.
413d37d1 656 */
c31ffb3f 657 struct trace_kprobe *tk;
413d37d1 658 int i, ret = 0;
3a6b7666 659 bool is_return = false, is_delete = false;
93ccae7a 660 char *symbol = NULL, *event = NULL, *group = NULL;
696ced4f 661 int maxactive = 0;
da34634f 662 char *arg;
2fba0c88 663 unsigned long offset = 0;
413d37d1 664 void *addr = NULL;
4a846b44 665 char buf[MAX_EVENT_NAME_LEN];
413d37d1 666
a7c312be 667 /* argc must be >= 1 */
413d37d1 668 if (argv[0][0] == 'p')
3a6b7666 669 is_return = false;
413d37d1 670 else if (argv[0][0] == 'r')
3a6b7666 671 is_return = true;
a7c312be 672 else if (argv[0][0] == '-')
3a6b7666 673 is_delete = true;
e63cc239 674 else {
a7c312be
MH
675 pr_info("Probe definition must be started with 'p', 'r' or"
676 " '-'.\n");
413d37d1 677 return -EINVAL;
e63cc239 678 }
413d37d1 679
696ced4f
AC
680 event = strchr(&argv[0][1], ':');
681 if (event) {
682 event[0] = '\0';
683 event++;
684 }
685 if (is_return && isdigit(argv[0][1])) {
686 ret = kstrtouint(&argv[0][1], 0, &maxactive);
687 if (ret) {
688 pr_info("Failed to parse maxactive.\n");
689 return ret;
690 }
691 /* kretprobes instances are iterated over via a list. The
692 * maximum should stay reasonable.
693 */
694 if (maxactive > KRETPROBE_MAXACTIVE_MAX) {
695 pr_info("Maxactive is too big (%d > %d).\n",
696 maxactive, KRETPROBE_MAXACTIVE_MAX);
697 return -E2BIG;
698 }
699 }
700
701 if (event) {
f52487e9
MH
702 if (strchr(event, '/')) {
703 group = event;
704 event = strchr(group, '/') + 1;
705 event[-1] = '\0';
706 if (strlen(group) == 0) {
a5efd925 707 pr_info("Group name is not specified\n");
f52487e9
MH
708 return -EINVAL;
709 }
710 }
413d37d1 711 if (strlen(event) == 0) {
a5efd925 712 pr_info("Event name is not specified\n");
413d37d1
MH
713 return -EINVAL;
714 }
715 }
a7c312be
MH
716 if (!group)
717 group = KPROBE_EVENT_SYSTEM;
413d37d1 718
a7c312be
MH
719 if (is_delete) {
720 if (!event) {
721 pr_info("Delete command needs an event name.\n");
722 return -EINVAL;
723 }
9da79ab8 724 mutex_lock(&probe_lock);
c31ffb3f
NK
725 tk = find_trace_kprobe(event, group);
726 if (!tk) {
9da79ab8 727 mutex_unlock(&probe_lock);
a7c312be
MH
728 pr_info("Event %s/%s doesn't exist.\n", group, event);
729 return -ENOENT;
730 }
731 /* delete an event */
c31ffb3f 732 ret = unregister_trace_kprobe(tk);
02ca1521 733 if (ret == 0)
c31ffb3f 734 free_trace_kprobe(tk);
9da79ab8 735 mutex_unlock(&probe_lock);
02ca1521 736 return ret;
a7c312be
MH
737 }
738
739 if (argc < 2) {
740 pr_info("Probe point is not specified.\n");
741 return -EINVAL;
742 }
9e52b325
SD
743
744 /* try to parse an address. if that fails, try to read the
745 * input as a symbol. */
746 if (kstrtoul(argv[1], 0, (unsigned long *)&addr)) {
413d37d1
MH
747 /* a symbol specified */
748 symbol = argv[1];
749 /* TODO: support .init module functions */
8ab83f56 750 ret = traceprobe_split_symbol_offset(symbol, &offset);
e63cc239 751 if (ret) {
9e52b325 752 pr_info("Failed to parse either an address or a symbol.\n");
413d37d1 753 return ret;
e63cc239 754 }
d0e02579 755 if (offset && is_return &&
659b957f 756 !kprobe_on_func_entry(NULL, symbol, offset)) {
d0e02579 757 pr_info("Given offset is not valid for return probe.\n");
413d37d1 758 return -EINVAL;
e63cc239 759 }
413d37d1 760 }
a82378d8 761 argc -= 2; argv += 2;
413d37d1
MH
762
763 /* setup a probe */
4263565d
MH
764 if (!event) {
765 /* Make a new event name */
4263565d 766 if (symbol)
6f3cf440 767 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_%ld",
4263565d
MH
768 is_return ? 'r' : 'p', symbol, offset);
769 else
6f3cf440 770 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_0x%p",
4263565d 771 is_return ? 'r' : 'p', addr);
fca18a47 772 sanitize_event_name(buf);
4a846b44
MH
773 event = buf;
774 }
696ced4f
AC
775 tk = alloc_trace_kprobe(group, event, addr, symbol, offset, maxactive,
776 argc, is_return);
c31ffb3f 777 if (IS_ERR(tk)) {
e63cc239 778 pr_info("Failed to allocate trace_probe.(%d)\n",
c31ffb3f
NK
779 (int)PTR_ERR(tk));
780 return PTR_ERR(tk);
e63cc239 781 }
413d37d1 782
413d37d1 783 /* parse arguments */
a82378d8
MH
784 ret = 0;
785 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) {
c31ffb3f
NK
786 struct probe_arg *parg = &tk->tp.args[i];
787
61a52736 788 /* Increment count for freeing args in error case */
c31ffb3f 789 tk->tp.nr_args++;
61a52736 790
eca0d916
MH
791 /* Parse argument name */
792 arg = strchr(argv[i], '=');
aba91595 793 if (arg) {
eca0d916 794 *arg++ = '\0';
c31ffb3f 795 parg->name = kstrdup(argv[i], GFP_KERNEL);
aba91595 796 } else {
eca0d916 797 arg = argv[i];
aba91595
MH
798 /* If argument name is omitted, set "argN" */
799 snprintf(buf, MAX_EVENT_NAME_LEN, "arg%d", i + 1);
c31ffb3f 800 parg->name = kstrdup(buf, GFP_KERNEL);
aba91595 801 }
a703d946 802
c31ffb3f 803 if (!parg->name) {
aba91595 804 pr_info("Failed to allocate argument[%d] name.\n", i);
ba8665d7 805 ret = -ENOMEM;
413d37d1
MH
806 goto error;
807 }
da34634f 808
c31ffb3f 809 if (!is_good_name(parg->name)) {
da34634f 810 pr_info("Invalid argument[%d] name: %s\n",
c31ffb3f 811 i, parg->name);
da34634f
MH
812 ret = -EINVAL;
813 goto error;
814 }
93ccae7a 815
c31ffb3f
NK
816 if (traceprobe_conflict_field_name(parg->name,
817 tk->tp.args, i)) {
aba91595 818 pr_info("Argument[%d] name '%s' conflicts with "
93ccae7a
MH
819 "another field.\n", i, argv[i]);
820 ret = -EINVAL;
821 goto error;
822 }
ba8665d7
MH
823
824 /* Parse fetch argument */
c31ffb3f 825 ret = traceprobe_parse_probe_arg(arg, &tk->tp.size, parg,
d9a16d3a
SR
826 is_return, true,
827 kprobes_fetch_type_table);
e63cc239 828 if (ret) {
aba91595 829 pr_info("Parse error at argument[%d]. (%d)\n", i, ret);
413d37d1 830 goto error;
e63cc239 831 }
413d37d1 832 }
413d37d1 833
c31ffb3f 834 ret = register_trace_kprobe(tk);
413d37d1
MH
835 if (ret)
836 goto error;
837 return 0;
838
839error:
c31ffb3f 840 free_trace_kprobe(tk);
413d37d1
MH
841 return ret;
842}
843
c31ffb3f 844static int release_all_trace_kprobes(void)
413d37d1 845{
c31ffb3f 846 struct trace_kprobe *tk;
02ca1521 847 int ret = 0;
413d37d1
MH
848
849 mutex_lock(&probe_lock);
02ca1521 850 /* Ensure no probe is in use. */
c31ffb3f
NK
851 list_for_each_entry(tk, &probe_list, list)
852 if (trace_probe_is_enabled(&tk->tp)) {
02ca1521
MH
853 ret = -EBUSY;
854 goto end;
855 }
413d37d1
MH
856 /* TODO: Use batch unregistration */
857 while (!list_empty(&probe_list)) {
c31ffb3f
NK
858 tk = list_entry(probe_list.next, struct trace_kprobe, list);
859 ret = unregister_trace_kprobe(tk);
40c32592
SRRH
860 if (ret)
861 goto end;
c31ffb3f 862 free_trace_kprobe(tk);
413d37d1 863 }
02ca1521
MH
864
865end:
413d37d1 866 mutex_unlock(&probe_lock);
02ca1521
MH
867
868 return ret;
413d37d1
MH
869}
870
413d37d1
MH
871/* Probes listing interfaces */
872static void *probes_seq_start(struct seq_file *m, loff_t *pos)
873{
874 mutex_lock(&probe_lock);
875 return seq_list_start(&probe_list, *pos);
876}
877
878static void *probes_seq_next(struct seq_file *m, void *v, loff_t *pos)
879{
880 return seq_list_next(v, &probe_list, pos);
881}
882
883static void probes_seq_stop(struct seq_file *m, void *v)
884{
885 mutex_unlock(&probe_lock);
886}
887
888static int probes_seq_show(struct seq_file *m, void *v)
889{
c31ffb3f 890 struct trace_kprobe *tk = v;
93ccae7a 891 int i;
413d37d1 892
fa6f0cc7 893 seq_putc(m, trace_kprobe_is_return(tk) ? 'r' : 'p');
de7b2973 894 seq_printf(m, ":%s/%s", tk->tp.call.class->system,
687fcc4a 895 trace_event_name(&tk->tp.call));
413d37d1 896
c31ffb3f
NK
897 if (!tk->symbol)
898 seq_printf(m, " 0x%p", tk->rp.kp.addr);
899 else if (tk->rp.kp.offset)
900 seq_printf(m, " %s+%u", trace_kprobe_symbol(tk),
901 tk->rp.kp.offset);
413d37d1 902 else
c31ffb3f 903 seq_printf(m, " %s", trace_kprobe_symbol(tk));
413d37d1 904
c31ffb3f
NK
905 for (i = 0; i < tk->tp.nr_args; i++)
906 seq_printf(m, " %s=%s", tk->tp.args[i].name, tk->tp.args[i].comm);
fa6f0cc7 907 seq_putc(m, '\n');
93ccae7a 908
413d37d1
MH
909 return 0;
910}
911
912static const struct seq_operations probes_seq_op = {
913 .start = probes_seq_start,
914 .next = probes_seq_next,
915 .stop = probes_seq_stop,
916 .show = probes_seq_show
917};
918
919static int probes_open(struct inode *inode, struct file *file)
920{
02ca1521
MH
921 int ret;
922
923 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
c31ffb3f 924 ret = release_all_trace_kprobes();
02ca1521
MH
925 if (ret < 0)
926 return ret;
927 }
413d37d1
MH
928
929 return seq_open(file, &probes_seq_op);
930}
931
413d37d1
MH
932static ssize_t probes_write(struct file *file, const char __user *buffer,
933 size_t count, loff_t *ppos)
934{
7e465baa
TZ
935 return trace_parse_run_command(file, buffer, count, ppos,
936 create_trace_kprobe);
413d37d1
MH
937}
938
939static const struct file_operations kprobe_events_ops = {
940 .owner = THIS_MODULE,
941 .open = probes_open,
942 .read = seq_read,
943 .llseek = seq_lseek,
944 .release = seq_release,
945 .write = probes_write,
946};
947
cd7e7bd5
MH
948/* Probes profiling interfaces */
949static int probes_profile_seq_show(struct seq_file *m, void *v)
950{
c31ffb3f 951 struct trace_kprobe *tk = v;
cd7e7bd5 952
de7b2973 953 seq_printf(m, " %-44s %15lu %15lu\n",
f18f97ac
MN
954 trace_event_name(&tk->tp.call),
955 trace_kprobe_nhit(tk),
c31ffb3f 956 tk->rp.kp.nmissed);
cd7e7bd5
MH
957
958 return 0;
959}
960
961static const struct seq_operations profile_seq_op = {
962 .start = probes_seq_start,
963 .next = probes_seq_next,
964 .stop = probes_seq_stop,
965 .show = probes_profile_seq_show
966};
967
968static int profile_open(struct inode *inode, struct file *file)
969{
970 return seq_open(file, &profile_seq_op);
971}
972
973static const struct file_operations kprobe_profile_ops = {
974 .owner = THIS_MODULE,
975 .open = profile_open,
976 .read = seq_read,
977 .llseek = seq_lseek,
978 .release = seq_release,
979};
980
413d37d1 981/* Kprobe handler */
3da0f180 982static nokprobe_inline void
c31ffb3f 983__kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs,
7f1d2f82 984 struct trace_event_file *trace_file)
413d37d1 985{
93ccae7a 986 struct kprobe_trace_entry_head *entry;
413d37d1 987 struct ring_buffer_event *event;
8f8ffe24 988 struct ring_buffer *buffer;
e09c8614 989 int size, dsize, pc;
413d37d1 990 unsigned long irq_flags;
2425bcb9 991 struct trace_event_call *call = &tk->tp.call;
413d37d1 992
7f1d2f82 993 WARN_ON(call != trace_file->event_call);
41a7dd42 994
09a5059a 995 if (trace_trigger_soft_disabled(trace_file))
13a1e4ae 996 return;
b8820084 997
413d37d1
MH
998 local_save_flags(irq_flags);
999 pc = preempt_count();
1000
c31ffb3f
NK
1001 dsize = __get_data_size(&tk->tp, regs);
1002 size = sizeof(*entry) + tk->tp.size + dsize;
413d37d1 1003
7f1d2f82 1004 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
41a7dd42
MH
1005 call->event.type,
1006 size, irq_flags, pc);
413d37d1 1007 if (!event)
1e12a4a7 1008 return;
413d37d1
MH
1009
1010 entry = ring_buffer_event_data(event);
c31ffb3f
NK
1011 entry->ip = (unsigned long)tk->rp.kp.addr;
1012 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
413d37d1 1013
7f1d2f82 1014 event_trigger_unlock_commit_regs(trace_file, buffer, event,
13a1e4ae 1015 entry, irq_flags, pc, regs);
413d37d1
MH
1016}
1017
3da0f180 1018static void
c31ffb3f 1019kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs)
41a7dd42 1020{
b04d52e3 1021 struct event_file_link *link;
41a7dd42 1022
c31ffb3f
NK
1023 list_for_each_entry_rcu(link, &tk->tp.files, list)
1024 __kprobe_trace_func(tk, regs, link->file);
41a7dd42 1025}
3da0f180 1026NOKPROBE_SYMBOL(kprobe_trace_func);
41a7dd42 1027
413d37d1 1028/* Kretprobe handler */
3da0f180 1029static nokprobe_inline void
c31ffb3f 1030__kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
41a7dd42 1031 struct pt_regs *regs,
7f1d2f82 1032 struct trace_event_file *trace_file)
413d37d1 1033{
93ccae7a 1034 struct kretprobe_trace_entry_head *entry;
413d37d1 1035 struct ring_buffer_event *event;
8f8ffe24 1036 struct ring_buffer *buffer;
e09c8614 1037 int size, pc, dsize;
413d37d1 1038 unsigned long irq_flags;
2425bcb9 1039 struct trace_event_call *call = &tk->tp.call;
413d37d1 1040
7f1d2f82 1041 WARN_ON(call != trace_file->event_call);
41a7dd42 1042
09a5059a 1043 if (trace_trigger_soft_disabled(trace_file))
13a1e4ae 1044 return;
b8820084 1045
413d37d1
MH
1046 local_save_flags(irq_flags);
1047 pc = preempt_count();
1048
c31ffb3f
NK
1049 dsize = __get_data_size(&tk->tp, regs);
1050 size = sizeof(*entry) + tk->tp.size + dsize;
413d37d1 1051
7f1d2f82 1052 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
41a7dd42
MH
1053 call->event.type,
1054 size, irq_flags, pc);
413d37d1 1055 if (!event)
1e12a4a7 1056 return;
413d37d1
MH
1057
1058 entry = ring_buffer_event_data(event);
c31ffb3f 1059 entry->func = (unsigned long)tk->rp.kp.addr;
413d37d1 1060 entry->ret_ip = (unsigned long)ri->ret_addr;
c31ffb3f 1061 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
413d37d1 1062
7f1d2f82 1063 event_trigger_unlock_commit_regs(trace_file, buffer, event,
13a1e4ae 1064 entry, irq_flags, pc, regs);
413d37d1
MH
1065}
1066
3da0f180 1067static void
c31ffb3f 1068kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
41a7dd42
MH
1069 struct pt_regs *regs)
1070{
b04d52e3 1071 struct event_file_link *link;
41a7dd42 1072
c31ffb3f
NK
1073 list_for_each_entry_rcu(link, &tk->tp.files, list)
1074 __kretprobe_trace_func(tk, ri, regs, link->file);
41a7dd42 1075}
3da0f180 1076NOKPROBE_SYMBOL(kretprobe_trace_func);
41a7dd42 1077
413d37d1 1078/* Event entry printers */
b62fdd97 1079static enum print_line_t
a9a57763
SR
1080print_kprobe_event(struct trace_iterator *iter, int flags,
1081 struct trace_event *event)
413d37d1 1082{
93ccae7a 1083 struct kprobe_trace_entry_head *field;
413d37d1 1084 struct trace_seq *s = &iter->seq;
eca0d916 1085 struct trace_probe *tp;
93ccae7a 1086 u8 *data;
413d37d1
MH
1087 int i;
1088
93ccae7a 1089 field = (struct kprobe_trace_entry_head *)iter->ent;
80decc70 1090 tp = container_of(event, struct trace_probe, call.event);
413d37d1 1091
687fcc4a 1092 trace_seq_printf(s, "%s: (", trace_event_name(&tp->call));
6e9f23d1 1093
413d37d1 1094 if (!seq_print_ip_sym(s, field->ip, flags | TRACE_ITER_SYM_OFFSET))
85224da0 1095 goto out;
413d37d1 1096
85224da0 1097 trace_seq_putc(s, ')');
413d37d1 1098
93ccae7a
MH
1099 data = (u8 *)&field[1];
1100 for (i = 0; i < tp->nr_args; i++)
1101 if (!tp->args[i].type->print(s, tp->args[i].name,
e09c8614 1102 data + tp->args[i].offset, field))
85224da0 1103 goto out;
413d37d1 1104
85224da0
SRRH
1105 trace_seq_putc(s, '\n');
1106 out:
1107 return trace_handle_return(s);
413d37d1
MH
1108}
1109
b62fdd97 1110static enum print_line_t
a9a57763
SR
1111print_kretprobe_event(struct trace_iterator *iter, int flags,
1112 struct trace_event *event)
413d37d1 1113{
93ccae7a 1114 struct kretprobe_trace_entry_head *field;
413d37d1 1115 struct trace_seq *s = &iter->seq;
eca0d916 1116 struct trace_probe *tp;
93ccae7a 1117 u8 *data;
413d37d1
MH
1118 int i;
1119
93ccae7a 1120 field = (struct kretprobe_trace_entry_head *)iter->ent;
80decc70 1121 tp = container_of(event, struct trace_probe, call.event);
413d37d1 1122
687fcc4a 1123 trace_seq_printf(s, "%s: (", trace_event_name(&tp->call));
6e9f23d1 1124
413d37d1 1125 if (!seq_print_ip_sym(s, field->ret_ip, flags | TRACE_ITER_SYM_OFFSET))
85224da0 1126 goto out;
413d37d1 1127
85224da0 1128 trace_seq_puts(s, " <- ");
413d37d1
MH
1129
1130 if (!seq_print_ip_sym(s, field->func, flags & ~TRACE_ITER_SYM_OFFSET))
85224da0 1131 goto out;
413d37d1 1132
85224da0 1133 trace_seq_putc(s, ')');
413d37d1 1134
93ccae7a
MH
1135 data = (u8 *)&field[1];
1136 for (i = 0; i < tp->nr_args; i++)
1137 if (!tp->args[i].type->print(s, tp->args[i].name,
e09c8614 1138 data + tp->args[i].offset, field))
85224da0 1139 goto out;
413d37d1 1140
85224da0 1141 trace_seq_putc(s, '\n');
413d37d1 1142
85224da0
SRRH
1143 out:
1144 return trace_handle_return(s);
413d37d1
MH
1145}
1146
413d37d1 1147
2425bcb9 1148static int kprobe_event_define_fields(struct trace_event_call *event_call)
413d37d1
MH
1149{
1150 int ret, i;
93ccae7a 1151 struct kprobe_trace_entry_head field;
c31ffb3f 1152 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data;
413d37d1 1153
a703d946 1154 DEFINE_FIELD(unsigned long, ip, FIELD_STRING_IP, 0);
eca0d916 1155 /* Set argument names as fields */
c31ffb3f
NK
1156 for (i = 0; i < tk->tp.nr_args; i++) {
1157 struct probe_arg *parg = &tk->tp.args[i];
1158
1159 ret = trace_define_field(event_call, parg->type->fmttype,
1160 parg->name,
1161 sizeof(field) + parg->offset,
1162 parg->type->size,
1163 parg->type->is_signed,
93ccae7a
MH
1164 FILTER_OTHER);
1165 if (ret)
1166 return ret;
1167 }
413d37d1
MH
1168 return 0;
1169}
1170
2425bcb9 1171static int kretprobe_event_define_fields(struct trace_event_call *event_call)
413d37d1
MH
1172{
1173 int ret, i;
93ccae7a 1174 struct kretprobe_trace_entry_head field;
c31ffb3f 1175 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data;
413d37d1 1176
a703d946
MH
1177 DEFINE_FIELD(unsigned long, func, FIELD_STRING_FUNC, 0);
1178 DEFINE_FIELD(unsigned long, ret_ip, FIELD_STRING_RETIP, 0);
eca0d916 1179 /* Set argument names as fields */
c31ffb3f
NK
1180 for (i = 0; i < tk->tp.nr_args; i++) {
1181 struct probe_arg *parg = &tk->tp.args[i];
1182
1183 ret = trace_define_field(event_call, parg->type->fmttype,
1184 parg->name,
1185 sizeof(field) + parg->offset,
1186 parg->type->size,
1187 parg->type->is_signed,
93ccae7a
MH
1188 FILTER_OTHER);
1189 if (ret)
1190 return ret;
1191 }
413d37d1
MH
1192 return 0;
1193}
1194
07b139c8 1195#ifdef CONFIG_PERF_EVENTS
e08d1c65
MH
1196
1197/* Kprobe profile handler */
9802d865 1198static int
c31ffb3f 1199kprobe_perf_func(struct trace_kprobe *tk, struct pt_regs *regs)
e08d1c65 1200{
2425bcb9 1201 struct trace_event_call *call = &tk->tp.call;
93ccae7a 1202 struct kprobe_trace_entry_head *entry;
1c024eca 1203 struct hlist_head *head;
e09c8614 1204 int size, __size, dsize;
4ed7c92d 1205 int rctx;
e08d1c65 1206
9802d865
JB
1207 if (bpf_prog_array_valid(call)) {
1208 int ret;
1209
1210 ret = trace_call_bpf(call, regs);
1211
1212 /*
1213 * We need to check and see if we modified the pc of the
1214 * pt_regs, and if so clear the kprobe and return 1 so that we
1215 * don't do the instruction skipping. Also reset our state so
1216 * we are clean the next pass through.
1217 */
1218 if (__this_cpu_read(bpf_kprobe_override)) {
1219 __this_cpu_write(bpf_kprobe_override, 0);
1220 reset_current_kprobe();
1221 return 1;
1222 }
1223 if (!ret)
1224 return 0;
1225 }
2541517c 1226
288e984e
ON
1227 head = this_cpu_ptr(call->perf_events);
1228 if (hlist_empty(head))
9802d865 1229 return 0;
288e984e 1230
c31ffb3f
NK
1231 dsize = __get_data_size(&tk->tp, regs);
1232 __size = sizeof(*entry) + tk->tp.size + dsize;
74ebb63e
MH
1233 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1234 size -= sizeof(u32);
ce71b9df 1235
1e1dcd93 1236 entry = perf_trace_buf_alloc(size, NULL, &rctx);
430ad5a6 1237 if (!entry)
9802d865 1238 return 0;
a1a138d0 1239
c31ffb3f 1240 entry->ip = (unsigned long)tk->rp.kp.addr;
e09c8614 1241 memset(&entry[1], 0, dsize);
c31ffb3f 1242 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
1e1dcd93 1243 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
8fd0fbbe 1244 head, NULL);
9802d865 1245 return 0;
e08d1c65 1246}
3da0f180 1247NOKPROBE_SYMBOL(kprobe_perf_func);
e08d1c65
MH
1248
1249/* Kretprobe profile handler */
3da0f180 1250static void
c31ffb3f 1251kretprobe_perf_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
2b106aab 1252 struct pt_regs *regs)
e08d1c65 1253{
2425bcb9 1254 struct trace_event_call *call = &tk->tp.call;
93ccae7a 1255 struct kretprobe_trace_entry_head *entry;
1c024eca 1256 struct hlist_head *head;
e09c8614 1257 int size, __size, dsize;
4ed7c92d 1258 int rctx;
e08d1c65 1259
e87c6bc3 1260 if (bpf_prog_array_valid(call) && !trace_call_bpf(call, regs))
2541517c
AS
1261 return;
1262
288e984e
ON
1263 head = this_cpu_ptr(call->perf_events);
1264 if (hlist_empty(head))
1265 return;
1266
c31ffb3f
NK
1267 dsize = __get_data_size(&tk->tp, regs);
1268 __size = sizeof(*entry) + tk->tp.size + dsize;
74ebb63e
MH
1269 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1270 size -= sizeof(u32);
444a2a3b 1271
1e1dcd93 1272 entry = perf_trace_buf_alloc(size, NULL, &rctx);
430ad5a6 1273 if (!entry)
1e12a4a7 1274 return;
e08d1c65 1275
c31ffb3f 1276 entry->func = (unsigned long)tk->rp.kp.addr;
a1a138d0 1277 entry->ret_ip = (unsigned long)ri->ret_addr;
c31ffb3f 1278 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
1e1dcd93 1279 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
8fd0fbbe 1280 head, NULL);
e08d1c65 1281}
3da0f180 1282NOKPROBE_SYMBOL(kretprobe_perf_func);
07b139c8 1283#endif /* CONFIG_PERF_EVENTS */
50d78056 1284
3fe3d619
ON
1285/*
1286 * called by perf_trace_init() or __ftrace_set_clr_event() under event_mutex.
1287 *
1288 * kprobe_trace_self_tests_init() does enable_trace_probe/disable_trace_probe
1289 * lockless, but we can't race with this __init function.
1290 */
2425bcb9 1291static int kprobe_register(struct trace_event_call *event,
fbc1963d 1292 enum trace_reg type, void *data)
2239291a 1293{
c31ffb3f 1294 struct trace_kprobe *tk = (struct trace_kprobe *)event->data;
7f1d2f82 1295 struct trace_event_file *file = data;
1538f888 1296
2239291a
SR
1297 switch (type) {
1298 case TRACE_REG_REGISTER:
c31ffb3f 1299 return enable_trace_kprobe(tk, file);
2239291a 1300 case TRACE_REG_UNREGISTER:
c31ffb3f 1301 return disable_trace_kprobe(tk, file);
2239291a
SR
1302
1303#ifdef CONFIG_PERF_EVENTS
1304 case TRACE_REG_PERF_REGISTER:
c31ffb3f 1305 return enable_trace_kprobe(tk, NULL);
2239291a 1306 case TRACE_REG_PERF_UNREGISTER:
c31ffb3f 1307 return disable_trace_kprobe(tk, NULL);
ceec0b6f
JO
1308 case TRACE_REG_PERF_OPEN:
1309 case TRACE_REG_PERF_CLOSE:
489c75c3
JO
1310 case TRACE_REG_PERF_ADD:
1311 case TRACE_REG_PERF_DEL:
ceec0b6f 1312 return 0;
2239291a
SR
1313#endif
1314 }
1315 return 0;
1316}
50d78056 1317
3da0f180 1318static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs)
50d78056 1319{
c31ffb3f 1320 struct trace_kprobe *tk = container_of(kp, struct trace_kprobe, rp.kp);
9802d865 1321 int ret = 0;
e08d1c65 1322
a7636d9e 1323 raw_cpu_inc(*tk->nhit);
48182bd2 1324
c31ffb3f
NK
1325 if (tk->tp.flags & TP_FLAG_TRACE)
1326 kprobe_trace_func(tk, regs);
07b139c8 1327#ifdef CONFIG_PERF_EVENTS
46df3d20 1328 if (tk->tp.flags & TP_FLAG_PROFILE) {
9802d865 1329 ret = kprobe_perf_func(tk, regs);
46df3d20
JB
1330 /*
1331 * The ftrace kprobe handler leaves it up to us to re-enable
1332 * preemption here before returning if we've modified the ip.
1333 */
1334 if (ret)
1335 preempt_enable_no_resched();
1336 }
07b139c8 1337#endif
9802d865 1338 return ret;
50d78056 1339}
3da0f180 1340NOKPROBE_SYMBOL(kprobe_dispatcher);
50d78056 1341
3da0f180
MH
1342static int
1343kretprobe_dispatcher(struct kretprobe_instance *ri, struct pt_regs *regs)
50d78056 1344{
c31ffb3f 1345 struct trace_kprobe *tk = container_of(ri->rp, struct trace_kprobe, rp);
50d78056 1346
a7636d9e 1347 raw_cpu_inc(*tk->nhit);
48182bd2 1348
c31ffb3f
NK
1349 if (tk->tp.flags & TP_FLAG_TRACE)
1350 kretprobe_trace_func(tk, ri, regs);
07b139c8 1351#ifdef CONFIG_PERF_EVENTS
c31ffb3f
NK
1352 if (tk->tp.flags & TP_FLAG_PROFILE)
1353 kretprobe_perf_func(tk, ri, regs);
07b139c8 1354#endif
50d78056
MH
1355 return 0; /* We don't tweek kernel, so just return 0 */
1356}
3da0f180 1357NOKPROBE_SYMBOL(kretprobe_dispatcher);
e08d1c65 1358
a9a57763
SR
1359static struct trace_event_functions kretprobe_funcs = {
1360 .trace = print_kretprobe_event
1361};
1362
1363static struct trace_event_functions kprobe_funcs = {
1364 .trace = print_kprobe_event
1365};
1366
c31ffb3f 1367static int register_kprobe_event(struct trace_kprobe *tk)
413d37d1 1368{
2425bcb9 1369 struct trace_event_call *call = &tk->tp.call;
413d37d1
MH
1370 int ret;
1371
2425bcb9 1372 /* Initialize trace_event_call */
ffb9f995 1373 INIT_LIST_HEAD(&call->class->fields);
c31ffb3f 1374 if (trace_kprobe_is_return(tk)) {
80decc70 1375 call->event.funcs = &kretprobe_funcs;
2e33af02 1376 call->class->define_fields = kretprobe_event_define_fields;
413d37d1 1377 } else {
80decc70 1378 call->event.funcs = &kprobe_funcs;
2e33af02 1379 call->class->define_fields = kprobe_event_define_fields;
413d37d1 1380 }
5bf652aa 1381 if (set_print_fmt(&tk->tp, trace_kprobe_is_return(tk)) < 0)
a342a028 1382 return -ENOMEM;
9023c930 1383 ret = register_trace_event(&call->event);
32c0edae 1384 if (!ret) {
a342a028 1385 kfree(call->print_fmt);
ff50d991 1386 return -ENODEV;
a342a028 1387 }
72cbbc89 1388 call->flags = TRACE_EVENT_FL_KPROBE;
2239291a 1389 call->class->reg = kprobe_register;
c31ffb3f 1390 call->data = tk;
413d37d1 1391 ret = trace_add_event_call(call);
ff50d991 1392 if (ret) {
de7b2973 1393 pr_info("Failed to register kprobe event: %s\n",
687fcc4a 1394 trace_event_name(call));
a342a028 1395 kfree(call->print_fmt);
9023c930 1396 unregister_trace_event(&call->event);
ff50d991 1397 }
413d37d1
MH
1398 return ret;
1399}
1400
c31ffb3f 1401static int unregister_kprobe_event(struct trace_kprobe *tk)
413d37d1 1402{
40c32592
SRRH
1403 int ret;
1404
ff50d991 1405 /* tp->event is unregistered in trace_remove_event_call() */
c31ffb3f 1406 ret = trace_remove_event_call(&tk->tp.call);
40c32592 1407 if (!ret)
c31ffb3f 1408 kfree(tk->tp.call.print_fmt);
40c32592 1409 return ret;
413d37d1
MH
1410}
1411
8434dc93 1412/* Make a tracefs interface for controlling probe points */
413d37d1
MH
1413static __init int init_kprobe_trace(void)
1414{
1415 struct dentry *d_tracer;
1416 struct dentry *entry;
413d37d1 1417
c31ffb3f 1418 if (register_module_notifier(&trace_kprobe_module_nb))
61424318
MH
1419 return -EINVAL;
1420
413d37d1 1421 d_tracer = tracing_init_dentry();
14a5ae40 1422 if (IS_ERR(d_tracer))
413d37d1
MH
1423 return 0;
1424
8434dc93 1425 entry = tracefs_create_file("kprobe_events", 0644, d_tracer,
413d37d1
MH
1426 NULL, &kprobe_events_ops);
1427
cd7e7bd5 1428 /* Event list interface */
413d37d1 1429 if (!entry)
a395d6a7 1430 pr_warn("Could not create tracefs 'kprobe_events' entry\n");
cd7e7bd5
MH
1431
1432 /* Profile interface */
8434dc93 1433 entry = tracefs_create_file("kprobe_profile", 0444, d_tracer,
cd7e7bd5
MH
1434 NULL, &kprobe_profile_ops);
1435
1436 if (!entry)
a395d6a7 1437 pr_warn("Could not create tracefs 'kprobe_profile' entry\n");
413d37d1
MH
1438 return 0;
1439}
1440fs_initcall(init_kprobe_trace);
1441
1442
1443#ifdef CONFIG_FTRACE_STARTUP_TEST
265a5b7e
SR
1444/*
1445 * The "__used" keeps gcc from removing the function symbol
d4d7ccc8
MN
1446 * from the kallsyms table. 'noinline' makes sure that there
1447 * isn't an inlined version used by the test method below
265a5b7e 1448 */
d4d7ccc8
MN
1449static __used __init noinline int
1450kprobe_trace_selftest_target(int a1, int a2, int a3, int a4, int a5, int a6)
413d37d1
MH
1451{
1452 return a1 + a2 + a3 + a4 + a5 + a6;
1453}
1454
26a346f2 1455static __init struct trace_event_file *
c31ffb3f 1456find_trace_probe_file(struct trace_kprobe *tk, struct trace_array *tr)
41a7dd42 1457{
7f1d2f82 1458 struct trace_event_file *file;
41a7dd42
MH
1459
1460 list_for_each_entry(file, &tr->events, list)
c31ffb3f 1461 if (file->event_call == &tk->tp.call)
41a7dd42
MH
1462 return file;
1463
1464 return NULL;
1465}
1466
3fe3d619 1467/*
c31ffb3f 1468 * Nobody but us can call enable_trace_kprobe/disable_trace_kprobe at this
3fe3d619
ON
1469 * stage, we can do this lockless.
1470 */
413d37d1
MH
1471static __init int kprobe_trace_self_tests_init(void)
1472{
231e36f4 1473 int ret, warn = 0;
413d37d1 1474 int (*target)(int, int, int, int, int, int);
c31ffb3f 1475 struct trace_kprobe *tk;
7f1d2f82 1476 struct trace_event_file *file;
413d37d1 1477
748ec3a2
YY
1478 if (tracing_is_disabled())
1479 return -ENODEV;
1480
413d37d1
MH
1481 target = kprobe_trace_selftest_target;
1482
1483 pr_info("Testing kprobe tracing: ");
1484
7e465baa
TZ
1485 ret = trace_run_command("p:testprobe kprobe_trace_selftest_target "
1486 "$stack $stack0 +0($stack)",
1487 create_trace_kprobe);
231e36f4 1488 if (WARN_ON_ONCE(ret)) {
41a7dd42 1489 pr_warn("error on probing function entry.\n");
231e36f4
MH
1490 warn++;
1491 } else {
1492 /* Enable trace point */
c31ffb3f
NK
1493 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
1494 if (WARN_ON_ONCE(tk == NULL)) {
41a7dd42 1495 pr_warn("error on getting new probe.\n");
231e36f4 1496 warn++;
41a7dd42 1497 } else {
c31ffb3f 1498 file = find_trace_probe_file(tk, top_trace_array());
41a7dd42
MH
1499 if (WARN_ON_ONCE(file == NULL)) {
1500 pr_warn("error on getting probe file.\n");
1501 warn++;
1502 } else
c31ffb3f 1503 enable_trace_kprobe(tk, file);
41a7dd42 1504 }
231e36f4 1505 }
413d37d1 1506
7e465baa
TZ
1507 ret = trace_run_command("r:testprobe2 kprobe_trace_selftest_target "
1508 "$retval", create_trace_kprobe);
231e36f4 1509 if (WARN_ON_ONCE(ret)) {
41a7dd42 1510 pr_warn("error on probing function return.\n");
231e36f4
MH
1511 warn++;
1512 } else {
1513 /* Enable trace point */
c31ffb3f
NK
1514 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
1515 if (WARN_ON_ONCE(tk == NULL)) {
41a7dd42 1516 pr_warn("error on getting 2nd new probe.\n");
231e36f4 1517 warn++;
41a7dd42 1518 } else {
c31ffb3f 1519 file = find_trace_probe_file(tk, top_trace_array());
41a7dd42
MH
1520 if (WARN_ON_ONCE(file == NULL)) {
1521 pr_warn("error on getting probe file.\n");
1522 warn++;
1523 } else
c31ffb3f 1524 enable_trace_kprobe(tk, file);
41a7dd42 1525 }
231e36f4
MH
1526 }
1527
1528 if (warn)
1529 goto end;
413d37d1
MH
1530
1531 ret = target(1, 2, 3, 4, 5, 6);
1532
d4d7ccc8
MN
1533 /*
1534 * Not expecting an error here, the check is only to prevent the
1535 * optimizer from removing the call to target() as otherwise there
1536 * are no side-effects and the call is never performed.
1537 */
1538 if (ret != 21)
1539 warn++;
1540
02ca1521 1541 /* Disable trace points before removing it */
c31ffb3f
NK
1542 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
1543 if (WARN_ON_ONCE(tk == NULL)) {
41a7dd42 1544 pr_warn("error on getting test probe.\n");
02ca1521 1545 warn++;
41a7dd42 1546 } else {
d4d7ccc8
MN
1547 if (trace_kprobe_nhit(tk) != 1) {
1548 pr_warn("incorrect number of testprobe hits\n");
1549 warn++;
1550 }
1551
c31ffb3f 1552 file = find_trace_probe_file(tk, top_trace_array());
41a7dd42
MH
1553 if (WARN_ON_ONCE(file == NULL)) {
1554 pr_warn("error on getting probe file.\n");
1555 warn++;
1556 } else
c31ffb3f 1557 disable_trace_kprobe(tk, file);
41a7dd42 1558 }
02ca1521 1559
c31ffb3f
NK
1560 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
1561 if (WARN_ON_ONCE(tk == NULL)) {
41a7dd42 1562 pr_warn("error on getting 2nd test probe.\n");
02ca1521 1563 warn++;
41a7dd42 1564 } else {
d4d7ccc8
MN
1565 if (trace_kprobe_nhit(tk) != 1) {
1566 pr_warn("incorrect number of testprobe2 hits\n");
1567 warn++;
1568 }
1569
c31ffb3f 1570 file = find_trace_probe_file(tk, top_trace_array());
41a7dd42
MH
1571 if (WARN_ON_ONCE(file == NULL)) {
1572 pr_warn("error on getting probe file.\n");
1573 warn++;
1574 } else
c31ffb3f 1575 disable_trace_kprobe(tk, file);
41a7dd42 1576 }
02ca1521 1577
7e465baa 1578 ret = trace_run_command("-:testprobe", create_trace_kprobe);
231e36f4 1579 if (WARN_ON_ONCE(ret)) {
41a7dd42 1580 pr_warn("error on deleting a probe.\n");
231e36f4
MH
1581 warn++;
1582 }
1583
7e465baa 1584 ret = trace_run_command("-:testprobe2", create_trace_kprobe);
231e36f4 1585 if (WARN_ON_ONCE(ret)) {
41a7dd42 1586 pr_warn("error on deleting a probe.\n");
231e36f4
MH
1587 warn++;
1588 }
413d37d1 1589
231e36f4 1590end:
c31ffb3f 1591 release_all_trace_kprobes();
30e7d894
TG
1592 /*
1593 * Wait for the optimizer work to finish. Otherwise it might fiddle
1594 * with probes in already freed __init text.
1595 */
1596 wait_for_kprobe_optimizer();
231e36f4
MH
1597 if (warn)
1598 pr_cont("NG: Some tests are failed. Please check them.\n");
1599 else
1600 pr_cont("OK\n");
413d37d1
MH
1601 return 0;
1602}
1603
1604late_initcall(kprobe_trace_self_tests_init);
1605
1606#endif