blob: 56d22752a52e31f1cef300b98fc8343c6808da79 [file] [log] [blame]
b.liue9582032025-04-17 19:18:16 +08001// SPDX-License-Identifier: GPL-2.0
2/*
3 * Kprobes-based tracing events
4 *
5 * Created by Masami Hiramatsu <mhiramat@redhat.com>
6 *
7 */
8#define pr_fmt(fmt) "trace_kprobe: " fmt
9
10#include <linux/security.h>
11#include <linux/module.h>
12#include <linux/uaccess.h>
13#include <linux/rculist.h>
14#include <linux/error-injection.h>
15
16#include <asm/setup.h> /* for COMMAND_LINE_SIZE */
17
18#include "trace_dynevent.h"
19#include "trace_kprobe_selftest.h"
20#include "trace_probe.h"
21#include "trace_probe_tmpl.h"
22
23#define KPROBE_EVENT_SYSTEM "kprobes"
24#define KRETPROBE_MAXACTIVE_MAX 4096
25#define MAX_KPROBE_CMDLINE_SIZE 1024
26
27/* Kprobe early definition from command line */
28static char kprobe_boot_events_buf[COMMAND_LINE_SIZE] __initdata;
29static bool kprobe_boot_events_enabled __initdata;
30
31static int __init set_kprobe_boot_events(char *str)
32{
33 strlcpy(kprobe_boot_events_buf, str, COMMAND_LINE_SIZE);
34 return 0;
35}
36__setup("kprobe_event=", set_kprobe_boot_events);
37
38static int trace_kprobe_create(int argc, const char **argv);
39static int trace_kprobe_show(struct seq_file *m, struct dyn_event *ev);
40static int trace_kprobe_release(struct dyn_event *ev);
41static bool trace_kprobe_is_busy(struct dyn_event *ev);
42static bool trace_kprobe_match(const char *system, const char *event,
43 int argc, const char **argv, struct dyn_event *ev);
44
45static struct dyn_event_operations trace_kprobe_ops = {
46 .create = trace_kprobe_create,
47 .show = trace_kprobe_show,
48 .is_busy = trace_kprobe_is_busy,
49 .free = trace_kprobe_release,
50 .match = trace_kprobe_match,
51};
52
53/*
54 * Kprobe event core functions
55 */
56struct trace_kprobe {
57 struct dyn_event devent;
58 struct kretprobe rp; /* Use rp.kp for kprobe use */
59 unsigned long __percpu *nhit;
60 const char *symbol; /* symbol name */
61 struct trace_probe tp;
62};
63
64static bool is_trace_kprobe(struct dyn_event *ev)
65{
66 return ev->ops == &trace_kprobe_ops;
67}
68
69static struct trace_kprobe *to_trace_kprobe(struct dyn_event *ev)
70{
71 return container_of(ev, struct trace_kprobe, devent);
72}
73
74/**
75 * for_each_trace_kprobe - iterate over the trace_kprobe list
76 * @pos: the struct trace_kprobe * for each entry
77 * @dpos: the struct dyn_event * to use as a loop cursor
78 */
79#define for_each_trace_kprobe(pos, dpos) \
80 for_each_dyn_event(dpos) \
81 if (is_trace_kprobe(dpos) && (pos = to_trace_kprobe(dpos)))
82
83#define SIZEOF_TRACE_KPROBE(n) \
84 (offsetof(struct trace_kprobe, tp.args) + \
85 (sizeof(struct probe_arg) * (n)))
86
87static nokprobe_inline bool trace_kprobe_is_return(struct trace_kprobe *tk)
88{
89 return tk->rp.handler != NULL;
90}
91
92static nokprobe_inline const char *trace_kprobe_symbol(struct trace_kprobe *tk)
93{
94 return tk->symbol ? tk->symbol : "unknown";
95}
96
97static nokprobe_inline unsigned long trace_kprobe_offset(struct trace_kprobe *tk)
98{
99 return tk->rp.kp.offset;
100}
101
102static nokprobe_inline bool trace_kprobe_has_gone(struct trace_kprobe *tk)
103{
104 return !!(kprobe_gone(&tk->rp.kp));
105}
106
107static nokprobe_inline bool trace_kprobe_within_module(struct trace_kprobe *tk,
108 struct module *mod)
109{
110 int len = strlen(mod->name);
111 const char *name = trace_kprobe_symbol(tk);
112 return strncmp(mod->name, name, len) == 0 && name[len] == ':';
113}
114
115static nokprobe_inline bool trace_kprobe_module_exist(struct trace_kprobe *tk)
116{
117 char *p;
118 bool ret;
119
120 if (!tk->symbol)
121 return false;
122 p = strchr(tk->symbol, ':');
123 if (!p)
124 return true;
125 *p = '\0';
126 mutex_lock(&module_mutex);
127 ret = !!find_module(tk->symbol);
128 mutex_unlock(&module_mutex);
129 *p = ':';
130
131 return ret;
132}
133
134static bool trace_kprobe_is_busy(struct dyn_event *ev)
135{
136 struct trace_kprobe *tk = to_trace_kprobe(ev);
137
138 return trace_probe_is_enabled(&tk->tp);
139}
140
141static bool trace_kprobe_match_command_head(struct trace_kprobe *tk,
142 int argc, const char **argv)
143{
144 char buf[MAX_ARGSTR_LEN + 1];
145
146 if (!argc)
147 return true;
148
149 if (!tk->symbol)
150 snprintf(buf, sizeof(buf), "0x%p", tk->rp.kp.addr);
151 else if (tk->rp.kp.offset)
152 snprintf(buf, sizeof(buf), "%s+%u",
153 trace_kprobe_symbol(tk), tk->rp.kp.offset);
154 else
155 snprintf(buf, sizeof(buf), "%s", trace_kprobe_symbol(tk));
156 if (strcmp(buf, argv[0]))
157 return false;
158 argc--; argv++;
159
160 return trace_probe_match_command_args(&tk->tp, argc, argv);
161}
162
163static bool trace_kprobe_match(const char *system, const char *event,
164 int argc, const char **argv, struct dyn_event *ev)
165{
166 struct trace_kprobe *tk = to_trace_kprobe(ev);
167
168 return strcmp(trace_probe_name(&tk->tp), event) == 0 &&
169 (!system || strcmp(trace_probe_group_name(&tk->tp), system) == 0) &&
170 trace_kprobe_match_command_head(tk, argc, argv);
171}
172
173static nokprobe_inline unsigned long trace_kprobe_nhit(struct trace_kprobe *tk)
174{
175 unsigned long nhit = 0;
176 int cpu;
177
178 for_each_possible_cpu(cpu)
179 nhit += *per_cpu_ptr(tk->nhit, cpu);
180
181 return nhit;
182}
183
184static nokprobe_inline bool trace_kprobe_is_registered(struct trace_kprobe *tk)
185{
186 return !(list_empty(&tk->rp.kp.list) &&
187 hlist_unhashed(&tk->rp.kp.hlist));
188}
189
190/* Return 0 if it fails to find the symbol address */
191static nokprobe_inline
192unsigned long trace_kprobe_address(struct trace_kprobe *tk)
193{
194 unsigned long addr;
195
196 if (tk->symbol) {
197 addr = (unsigned long)
198 kallsyms_lookup_name(trace_kprobe_symbol(tk));
199 if (addr)
200 addr += tk->rp.kp.offset;
201 } else {
202 addr = (unsigned long)tk->rp.kp.addr;
203 }
204 return addr;
205}
206
207static nokprobe_inline struct trace_kprobe *
208trace_kprobe_primary_from_call(struct trace_event_call *call)
209{
210 struct trace_probe *tp;
211
212 tp = trace_probe_primary_from_call(call);
213 if (WARN_ON_ONCE(!tp))
214 return NULL;
215
216 return container_of(tp, struct trace_kprobe, tp);
217}
218
219bool trace_kprobe_on_func_entry(struct trace_event_call *call)
220{
221 struct trace_kprobe *tk = trace_kprobe_primary_from_call(call);
222
223 return tk ? (kprobe_on_func_entry(tk->rp.kp.addr,
224 tk->rp.kp.addr ? NULL : tk->rp.kp.symbol_name,
225 tk->rp.kp.addr ? 0 : tk->rp.kp.offset) == 0) : false;
226}
227
228bool trace_kprobe_error_injectable(struct trace_event_call *call)
229{
230 struct trace_kprobe *tk = trace_kprobe_primary_from_call(call);
231
232 return tk ? within_error_injection_list(trace_kprobe_address(tk)) :
233 false;
234}
235
236static int register_kprobe_event(struct trace_kprobe *tk);
237static int unregister_kprobe_event(struct trace_kprobe *tk);
238
239static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs);
240static int kretprobe_dispatcher(struct kretprobe_instance *ri,
241 struct pt_regs *regs);
242
243static void free_trace_kprobe(struct trace_kprobe *tk)
244{
245 if (tk) {
246 trace_probe_cleanup(&tk->tp);
247 kfree(tk->symbol);
248 free_percpu(tk->nhit);
249 kfree(tk);
250 }
251}
252
253/*
254 * Allocate new trace_probe and initialize it (including kprobes).
255 */
256static struct trace_kprobe *alloc_trace_kprobe(const char *group,
257 const char *event,
258 void *addr,
259 const char *symbol,
260 unsigned long offs,
261 int maxactive,
262 int nargs, bool is_return)
263{
264 struct trace_kprobe *tk;
265 int ret = -ENOMEM;
266
267 tk = kzalloc(SIZEOF_TRACE_KPROBE(nargs), GFP_KERNEL);
268 if (!tk)
269 return ERR_PTR(ret);
270
271 tk->nhit = alloc_percpu(unsigned long);
272 if (!tk->nhit)
273 goto error;
274
275 if (symbol) {
276 tk->symbol = kstrdup(symbol, GFP_KERNEL);
277 if (!tk->symbol)
278 goto error;
279 tk->rp.kp.symbol_name = tk->symbol;
280 tk->rp.kp.offset = offs;
281 } else
282 tk->rp.kp.addr = addr;
283
284 if (is_return)
285 tk->rp.handler = kretprobe_dispatcher;
286 else
287 tk->rp.kp.pre_handler = kprobe_dispatcher;
288
289 tk->rp.maxactive = maxactive;
290 INIT_HLIST_NODE(&tk->rp.kp.hlist);
291 INIT_LIST_HEAD(&tk->rp.kp.list);
292
293 ret = trace_probe_init(&tk->tp, event, group, false);
294 if (ret < 0)
295 goto error;
296
297 dyn_event_init(&tk->devent, &trace_kprobe_ops);
298 return tk;
299error:
300 free_trace_kprobe(tk);
301 return ERR_PTR(ret);
302}
303
304static struct trace_kprobe *find_trace_kprobe(const char *event,
305 const char *group)
306{
307 struct dyn_event *pos;
308 struct trace_kprobe *tk;
309
310 for_each_trace_kprobe(tk, pos)
311 if (strcmp(trace_probe_name(&tk->tp), event) == 0 &&
312 strcmp(trace_probe_group_name(&tk->tp), group) == 0)
313 return tk;
314 return NULL;
315}
316
317static inline int __enable_trace_kprobe(struct trace_kprobe *tk)
318{
319 int ret = 0;
320
321 if (trace_kprobe_is_registered(tk) && !trace_kprobe_has_gone(tk)) {
322 if (trace_kprobe_is_return(tk))
323 ret = enable_kretprobe(&tk->rp);
324 else
325 ret = enable_kprobe(&tk->rp.kp);
326 }
327
328 return ret;
329}
330
331static void __disable_trace_kprobe(struct trace_probe *tp)
332{
333 struct trace_probe *pos;
334 struct trace_kprobe *tk;
335
336 list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
337 tk = container_of(pos, struct trace_kprobe, tp);
338 if (!trace_kprobe_is_registered(tk))
339 continue;
340 if (trace_kprobe_is_return(tk))
341 disable_kretprobe(&tk->rp);
342 else
343 disable_kprobe(&tk->rp.kp);
344 }
345}
346
347/*
348 * Enable trace_probe
349 * if the file is NULL, enable "perf" handler, or enable "trace" handler.
350 */
351static int enable_trace_kprobe(struct trace_event_call *call,
352 struct trace_event_file *file)
353{
354 struct trace_probe *pos, *tp;
355 struct trace_kprobe *tk;
356 bool enabled;
357 int ret = 0;
358
359 tp = trace_probe_primary_from_call(call);
360 if (WARN_ON_ONCE(!tp))
361 return -ENODEV;
362 enabled = trace_probe_is_enabled(tp);
363
364 /* This also changes "enabled" state */
365 if (file) {
366 ret = trace_probe_add_file(tp, file);
367 if (ret)
368 return ret;
369 } else
370 trace_probe_set_flag(tp, TP_FLAG_PROFILE);
371
372 if (enabled)
373 return 0;
374
375 list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
376 tk = container_of(pos, struct trace_kprobe, tp);
377 if (trace_kprobe_has_gone(tk))
378 continue;
379 ret = __enable_trace_kprobe(tk);
380 if (ret)
381 break;
382 enabled = true;
383 }
384
385 if (ret) {
386 /* Failed to enable one of them. Roll back all */
387 if (enabled)
388 __disable_trace_kprobe(tp);
389 if (file)
390 trace_probe_remove_file(tp, file);
391 else
392 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
393 }
394
395 return ret;
396}
397
398/*
399 * Disable trace_probe
400 * if the file is NULL, disable "perf" handler, or disable "trace" handler.
401 */
402static int disable_trace_kprobe(struct trace_event_call *call,
403 struct trace_event_file *file)
404{
405 struct trace_probe *tp;
406
407 tp = trace_probe_primary_from_call(call);
408 if (WARN_ON_ONCE(!tp))
409 return -ENODEV;
410
411 if (file) {
412 if (!trace_probe_get_file_link(tp, file))
413 return -ENOENT;
414 if (!trace_probe_has_single_file(tp))
415 goto out;
416 trace_probe_clear_flag(tp, TP_FLAG_TRACE);
417 } else
418 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
419
420 if (!trace_probe_is_enabled(tp))
421 __disable_trace_kprobe(tp);
422
423 out:
424 if (file)
425 /*
426 * Synchronization is done in below function. For perf event,
427 * file == NULL and perf_trace_event_unreg() calls
428 * tracepoint_synchronize_unregister() to ensure synchronize
429 * event. We don't need to care about it.
430 */
431 trace_probe_remove_file(tp, file);
432
433 return 1;
434}
435
436#if defined(CONFIG_DYNAMIC_FTRACE) && \
437 !defined(CONFIG_KPROBE_EVENTS_ON_NOTRACE)
438static bool __within_notrace_func(unsigned long addr)
439{
440 unsigned long offset, size;
441
442 if (!addr || !kallsyms_lookup_size_offset(addr, &size, &offset))
443 return false;
444
445 /* Get the entry address of the target function */
446 addr -= offset;
447
448 /*
449 * Since ftrace_location_range() does inclusive range check, we need
450 * to subtract 1 byte from the end address.
451 */
452 return !ftrace_location_range(addr, addr + size - 1);
453}
454
455static bool within_notrace_func(struct trace_kprobe *tk)
456{
457 unsigned long addr = trace_kprobe_address(tk);
458 char symname[KSYM_NAME_LEN], *p;
459
460 if (!__within_notrace_func(addr))
461 return false;
462
463 /* Check if the address is on a suffixed-symbol */
464 if (!lookup_symbol_name(addr, symname)) {
465 p = strchr(symname, '.');
466 if (!p)
467 return true;
468 *p = '\0';
469 addr = (unsigned long)kprobe_lookup_name(symname, 0);
470 if (addr)
471 return __within_notrace_func(addr);
472 }
473
474 return true;
475}
476#else
477#define within_notrace_func(tk) (false)
478#endif
479
480/* Internal register function - just handle k*probes and flags */
481static int __register_trace_kprobe(struct trace_kprobe *tk)
482{
483 int i, ret;
484
485 ret = security_locked_down(LOCKDOWN_KPROBES);
486 if (ret)
487 return ret;
488
489 if (trace_kprobe_is_registered(tk))
490 return -EINVAL;
491
492 if (within_notrace_func(tk)) {
493 pr_warn("Could not probe notrace function %s\n",
494 trace_kprobe_symbol(tk));
495 return -EINVAL;
496 }
497
498 for (i = 0; i < tk->tp.nr_args; i++) {
499 ret = traceprobe_update_arg(&tk->tp.args[i]);
500 if (ret)
501 return ret;
502 }
503
504 /* Set/clear disabled flag according to tp->flag */
505 if (trace_probe_is_enabled(&tk->tp))
506 tk->rp.kp.flags &= ~KPROBE_FLAG_DISABLED;
507 else
508 tk->rp.kp.flags |= KPROBE_FLAG_DISABLED;
509
510 if (trace_kprobe_is_return(tk))
511 ret = register_kretprobe(&tk->rp);
512 else
513 ret = register_kprobe(&tk->rp.kp);
514
515 return ret;
516}
517
518/* Internal unregister function - just handle k*probes and flags */
519static void __unregister_trace_kprobe(struct trace_kprobe *tk)
520{
521 if (trace_kprobe_is_registered(tk)) {
522 if (trace_kprobe_is_return(tk))
523 unregister_kretprobe(&tk->rp);
524 else
525 unregister_kprobe(&tk->rp.kp);
526 /* Cleanup kprobe for reuse and mark it unregistered */
527 INIT_HLIST_NODE(&tk->rp.kp.hlist);
528 INIT_LIST_HEAD(&tk->rp.kp.list);
529 if (tk->rp.kp.symbol_name)
530 tk->rp.kp.addr = NULL;
531 }
532}
533
534/* Unregister a trace_probe and probe_event */
535static int unregister_trace_kprobe(struct trace_kprobe *tk)
536{
537 /* If other probes are on the event, just unregister kprobe */
538 if (trace_probe_has_sibling(&tk->tp))
539 goto unreg;
540
541 /* Enabled event can not be unregistered */
542 if (trace_probe_is_enabled(&tk->tp))
543 return -EBUSY;
544
545 /* Will fail if probe is being used by ftrace or perf */
546 if (unregister_kprobe_event(tk))
547 return -EBUSY;
548
549unreg:
550 __unregister_trace_kprobe(tk);
551 dyn_event_remove(&tk->devent);
552 trace_probe_unlink(&tk->tp);
553
554 return 0;
555}
556
557static bool trace_kprobe_has_same_kprobe(struct trace_kprobe *orig,
558 struct trace_kprobe *comp)
559{
560 struct trace_probe_event *tpe = orig->tp.event;
561 struct trace_probe *pos;
562 int i;
563
564 list_for_each_entry(pos, &tpe->probes, list) {
565 orig = container_of(pos, struct trace_kprobe, tp);
566 if (strcmp(trace_kprobe_symbol(orig),
567 trace_kprobe_symbol(comp)) ||
568 trace_kprobe_offset(orig) != trace_kprobe_offset(comp))
569 continue;
570
571 /*
572 * trace_probe_compare_arg_type() ensured that nr_args and
573 * each argument name and type are same. Let's compare comm.
574 */
575 for (i = 0; i < orig->tp.nr_args; i++) {
576 if (strcmp(orig->tp.args[i].comm,
577 comp->tp.args[i].comm))
578 break;
579 }
580
581 if (i == orig->tp.nr_args)
582 return true;
583 }
584
585 return false;
586}
587
588static int append_trace_kprobe(struct trace_kprobe *tk, struct trace_kprobe *to)
589{
590 int ret;
591
592 ret = trace_probe_compare_arg_type(&tk->tp, &to->tp);
593 if (ret) {
594 /* Note that argument starts index = 2 */
595 trace_probe_log_set_index(ret + 1);
596 trace_probe_log_err(0, DIFF_ARG_TYPE);
597 return -EEXIST;
598 }
599 if (trace_kprobe_has_same_kprobe(to, tk)) {
600 trace_probe_log_set_index(0);
601 trace_probe_log_err(0, SAME_PROBE);
602 return -EEXIST;
603 }
604
605 /* Append to existing event */
606 ret = trace_probe_append(&tk->tp, &to->tp);
607 if (ret)
608 return ret;
609
610 /* Register k*probe */
611 ret = __register_trace_kprobe(tk);
612 if (ret == -ENOENT && !trace_kprobe_module_exist(tk)) {
613 pr_warn("This probe might be able to register after target module is loaded. Continue.\n");
614 ret = 0;
615 }
616
617 if (ret)
618 trace_probe_unlink(&tk->tp);
619 else
620 dyn_event_add(&tk->devent);
621
622 return ret;
623}
624
625/* Register a trace_probe and probe_event */
626static int register_trace_kprobe(struct trace_kprobe *tk)
627{
628 struct trace_kprobe *old_tk;
629 int ret;
630
631 mutex_lock(&event_mutex);
632
633 old_tk = find_trace_kprobe(trace_probe_name(&tk->tp),
634 trace_probe_group_name(&tk->tp));
635 if (old_tk) {
636 if (trace_kprobe_is_return(tk) != trace_kprobe_is_return(old_tk)) {
637 trace_probe_log_set_index(0);
638 trace_probe_log_err(0, DIFF_PROBE_TYPE);
639 ret = -EEXIST;
640 } else {
641 ret = append_trace_kprobe(tk, old_tk);
642 }
643 goto end;
644 }
645
646 /* Register new event */
647 ret = register_kprobe_event(tk);
648 if (ret) {
649 if (ret == -EEXIST) {
650 trace_probe_log_set_index(0);
651 trace_probe_log_err(0, EVENT_EXIST);
652 } else
653 pr_warn("Failed to register probe event(%d)\n", ret);
654 goto end;
655 }
656
657 /* Register k*probe */
658 ret = __register_trace_kprobe(tk);
659 if (ret == -ENOENT && !trace_kprobe_module_exist(tk)) {
660 pr_warn("This probe might be able to register after target module is loaded. Continue.\n");
661 ret = 0;
662 }
663
664 if (ret < 0)
665 unregister_kprobe_event(tk);
666 else
667 dyn_event_add(&tk->devent);
668
669end:
670 mutex_unlock(&event_mutex);
671 return ret;
672}
673
674/* Module notifier call back, checking event on the module */
675static int trace_kprobe_module_callback(struct notifier_block *nb,
676 unsigned long val, void *data)
677{
678 struct module *mod = data;
679 struct dyn_event *pos;
680 struct trace_kprobe *tk;
681 int ret;
682
683 if (val != MODULE_STATE_COMING)
684 return NOTIFY_DONE;
685
686 /* Update probes on coming module */
687 mutex_lock(&event_mutex);
688 for_each_trace_kprobe(tk, pos) {
689 if (trace_kprobe_within_module(tk, mod)) {
690 /* Don't need to check busy - this should have gone. */
691 __unregister_trace_kprobe(tk);
692 ret = __register_trace_kprobe(tk);
693 if (ret)
694 pr_warn("Failed to re-register probe %s on %s: %d\n",
695 trace_probe_name(&tk->tp),
696 mod->name, ret);
697 }
698 }
699 mutex_unlock(&event_mutex);
700
701 return NOTIFY_DONE;
702}
703
704static struct notifier_block trace_kprobe_module_nb = {
705 .notifier_call = trace_kprobe_module_callback,
706 .priority = 2 /* Invoked after kprobe and jump_label module callback */
707};
708
709/* Convert certain expected symbols into '_' when generating event names */
710static inline void sanitize_event_name(char *name)
711{
712 while (*name++ != '\0')
713 if (*name == ':' || *name == '.')
714 *name = '_';
715}
716
717struct count_symbols_struct {
718 const char *func_name;
719 unsigned int count;
720};
721
722static int count_symbols(void *data, const char *name, struct module *unused0,
723 unsigned long unused1)
724{
725 struct count_symbols_struct *args = data;
726
727 if (strcmp(args->func_name, name))
728 return 0;
729
730 args->count++;
731
732 return 0;
733}
734
735static unsigned int number_of_same_symbols(char *func_name)
736{
737 struct count_symbols_struct args = {
738 .func_name = func_name,
739 .count = 0,
740 };
741
742 kallsyms_on_each_symbol(count_symbols, &args);
743
744 module_kallsyms_on_each_symbol(count_symbols, &args);
745
746 return args.count;
747}
748
749static int trace_kprobe_create(int argc, const char *argv[])
750{
751 /*
752 * Argument syntax:
753 * - Add kprobe:
754 * p[:[GRP/]EVENT] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS]
755 * - Add kretprobe:
756 * r[MAXACTIVE][:[GRP/]EVENT] [MOD:]KSYM[+0] [FETCHARGS]
757 * Fetch args:
758 * $retval : fetch return value
759 * $stack : fetch stack address
760 * $stackN : fetch Nth of stack (N:0-)
761 * $comm : fetch current task comm
762 * @ADDR : fetch memory at ADDR (ADDR should be in kernel)
763 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol)
764 * %REG : fetch register REG
765 * Dereferencing memory fetch:
766 * +|-offs(ARG) : fetch memory at ARG +|- offs address.
767 * Alias name of args:
768 * NAME=FETCHARG : set NAME as alias of FETCHARG.
769 * Type of args:
770 * FETCHARG:TYPE : use TYPE instead of unsigned long.
771 */
772 struct trace_kprobe *tk = NULL;
773 int i, len, ret = 0;
774 bool is_return = false;
775 char *symbol = NULL, *tmp = NULL;
776 const char *event = NULL, *group = KPROBE_EVENT_SYSTEM;
777 int maxactive = 0;
778 long offset = 0;
779 void *addr = NULL;
780 char buf[MAX_EVENT_NAME_LEN];
781 unsigned int flags = TPARG_FL_KERNEL;
782
783 switch (argv[0][0]) {
784 case 'r':
785 is_return = true;
786 flags |= TPARG_FL_RETURN;
787 break;
788 case 'p':
789 break;
790 default:
791 return -ECANCELED;
792 }
793 if (argc < 2)
794 return -ECANCELED;
795
796 trace_probe_log_init("trace_kprobe", argc, argv);
797
798 event = strchr(&argv[0][1], ':');
799 if (event)
800 event++;
801
802 if (isdigit(argv[0][1])) {
803 if (!is_return) {
804 trace_probe_log_err(1, MAXACT_NO_KPROBE);
805 goto parse_error;
806 }
807 if (event)
808 len = event - &argv[0][1] - 1;
809 else
810 len = strlen(&argv[0][1]);
811 if (len > MAX_EVENT_NAME_LEN - 1) {
812 trace_probe_log_err(1, BAD_MAXACT);
813 goto parse_error;
814 }
815 memcpy(buf, &argv[0][1], len);
816 buf[len] = '\0';
817 ret = kstrtouint(buf, 0, &maxactive);
818 if (ret || !maxactive) {
819 trace_probe_log_err(1, BAD_MAXACT);
820 goto parse_error;
821 }
822 /* kretprobes instances are iterated over via a list. The
823 * maximum should stay reasonable.
824 */
825 if (maxactive > KRETPROBE_MAXACTIVE_MAX) {
826 trace_probe_log_err(1, MAXACT_TOO_BIG);
827 goto parse_error;
828 }
829 }
830
831 /* try to parse an address. if that fails, try to read the
832 * input as a symbol. */
833 if (kstrtoul(argv[1], 0, (unsigned long *)&addr)) {
834 trace_probe_log_set_index(1);
835 /* Check whether uprobe event specified */
836 if (strchr(argv[1], '/') && strchr(argv[1], ':')) {
837 ret = -ECANCELED;
838 goto error;
839 }
840 /* a symbol specified */
841 symbol = kstrdup(argv[1], GFP_KERNEL);
842 if (!symbol)
843 return -ENOMEM;
844 /* TODO: support .init module functions */
845 ret = traceprobe_split_symbol_offset(symbol, &offset);
846 if (ret || offset < 0 || offset > UINT_MAX) {
847 trace_probe_log_err(0, BAD_PROBE_ADDR);
848 goto parse_error;
849 }
850 ret = kprobe_on_func_entry(NULL, symbol, offset);
851 if (ret == 0)
852 flags |= TPARG_FL_FENTRY;
853 /* Defer the ENOENT case until register kprobe */
854 if (ret == -EINVAL && is_return) {
855 trace_probe_log_err(0, BAD_RETPROBE);
856 goto parse_error;
857 }
858 }
859
860 if (symbol && !strchr(symbol, ':')) {
861 unsigned int count;
862
863 count = number_of_same_symbols(symbol);
864 if (count > 1) {
865 /*
866 * Users should use ADDR to remove the ambiguity of
867 * using KSYM only.
868 */
869 trace_probe_log_err(0, NON_UNIQ_SYMBOL);
870 ret = -EADDRNOTAVAIL;
871
872 goto error;
873 } else if (count == 0) {
874 /*
875 * We can return ENOENT earlier than when register the
876 * kprobe.
877 */
878 trace_probe_log_err(0, BAD_PROBE_ADDR);
879 ret = -ENOENT;
880
881 goto error;
882 }
883 }
884
885 trace_probe_log_set_index(0);
886 if (event) {
887 ret = traceprobe_parse_event_name(&event, &group, buf,
888 event - argv[0]);
889 if (ret)
890 goto parse_error;
891 } else {
892 /* Make a new event name */
893 if (symbol)
894 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_%ld",
895 is_return ? 'r' : 'p', symbol, offset);
896 else
897 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_0x%p",
898 is_return ? 'r' : 'p', addr);
899 sanitize_event_name(buf);
900 event = buf;
901 }
902
903 /* setup a probe */
904 tk = alloc_trace_kprobe(group, event, addr, symbol, offset, maxactive,
905 argc - 2, is_return);
906 if (IS_ERR(tk)) {
907 ret = PTR_ERR(tk);
908 /* This must return -ENOMEM, else there is a bug */
909 WARN_ON_ONCE(ret != -ENOMEM);
910 goto out; /* We know tk is not allocated */
911 }
912 argc -= 2; argv += 2;
913
914 /* parse arguments */
915 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) {
916 tmp = kstrdup(argv[i], GFP_KERNEL);
917 if (!tmp) {
918 ret = -ENOMEM;
919 goto error;
920 }
921
922 trace_probe_log_set_index(i + 2);
923 ret = traceprobe_parse_probe_arg(&tk->tp, i, tmp, flags);
924 kfree(tmp);
925 if (ret)
926 goto error; /* This can be -ENOMEM */
927 }
928
929 ret = traceprobe_set_print_fmt(&tk->tp, is_return);
930 if (ret < 0)
931 goto error;
932
933 ret = register_trace_kprobe(tk);
934 if (ret) {
935 trace_probe_log_set_index(1);
936 if (ret == -EILSEQ)
937 trace_probe_log_err(0, BAD_INSN_BNDRY);
938 else if (ret == -ENOENT)
939 trace_probe_log_err(0, BAD_PROBE_ADDR);
940 else if (ret != -ENOMEM && ret != -EEXIST)
941 trace_probe_log_err(0, FAIL_REG_PROBE);
942 goto error;
943 }
944
945out:
946 trace_probe_log_clear();
947 kfree(symbol);
948 return ret;
949
950parse_error:
951 ret = -EINVAL;
952error:
953 free_trace_kprobe(tk);
954 goto out;
955}
956
957static int create_or_delete_trace_kprobe(int argc, char **argv)
958{
959 int ret;
960
961 if (argv[0][0] == '-')
962 return dyn_event_release(argc, argv, &trace_kprobe_ops);
963
964 ret = trace_kprobe_create(argc, (const char **)argv);
965 return ret == -ECANCELED ? -EINVAL : ret;
966}
967
968static int trace_kprobe_release(struct dyn_event *ev)
969{
970 struct trace_kprobe *tk = to_trace_kprobe(ev);
971 int ret = unregister_trace_kprobe(tk);
972
973 if (!ret)
974 free_trace_kprobe(tk);
975 return ret;
976}
977
978static int trace_kprobe_show(struct seq_file *m, struct dyn_event *ev)
979{
980 struct trace_kprobe *tk = to_trace_kprobe(ev);
981 int i;
982
983 seq_putc(m, trace_kprobe_is_return(tk) ? 'r' : 'p');
984 if (trace_kprobe_is_return(tk) && tk->rp.maxactive)
985 seq_printf(m, "%d", tk->rp.maxactive);
986 seq_printf(m, ":%s/%s", trace_probe_group_name(&tk->tp),
987 trace_probe_name(&tk->tp));
988
989 if (!tk->symbol)
990 seq_printf(m, " 0x%p", tk->rp.kp.addr);
991 else if (tk->rp.kp.offset)
992 seq_printf(m, " %s+%u", trace_kprobe_symbol(tk),
993 tk->rp.kp.offset);
994 else
995 seq_printf(m, " %s", trace_kprobe_symbol(tk));
996
997 for (i = 0; i < tk->tp.nr_args; i++)
998 seq_printf(m, " %s=%s", tk->tp.args[i].name, tk->tp.args[i].comm);
999 seq_putc(m, '\n');
1000
1001 return 0;
1002}
1003
1004static int probes_seq_show(struct seq_file *m, void *v)
1005{
1006 struct dyn_event *ev = v;
1007
1008 if (!is_trace_kprobe(ev))
1009 return 0;
1010
1011 return trace_kprobe_show(m, ev);
1012}
1013
1014static const struct seq_operations probes_seq_op = {
1015 .start = dyn_event_seq_start,
1016 .next = dyn_event_seq_next,
1017 .stop = dyn_event_seq_stop,
1018 .show = probes_seq_show
1019};
1020
1021static int probes_open(struct inode *inode, struct file *file)
1022{
1023 int ret;
1024
1025 ret = security_locked_down(LOCKDOWN_TRACEFS);
1026 if (ret)
1027 return ret;
1028
1029 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
1030 ret = dyn_events_release_all(&trace_kprobe_ops);
1031 if (ret < 0)
1032 return ret;
1033 }
1034
1035 return seq_open(file, &probes_seq_op);
1036}
1037
1038static ssize_t probes_write(struct file *file, const char __user *buffer,
1039 size_t count, loff_t *ppos)
1040{
1041 return trace_parse_run_command(file, buffer, count, ppos,
1042 create_or_delete_trace_kprobe);
1043}
1044
1045static const struct file_operations kprobe_events_ops = {
1046 .owner = THIS_MODULE,
1047 .open = probes_open,
1048 .read = seq_read,
1049 .llseek = seq_lseek,
1050 .release = seq_release,
1051 .write = probes_write,
1052};
1053
1054/* Probes profiling interfaces */
1055static int probes_profile_seq_show(struct seq_file *m, void *v)
1056{
1057 struct dyn_event *ev = v;
1058 struct trace_kprobe *tk;
1059 unsigned long nmissed;
1060
1061 if (!is_trace_kprobe(ev))
1062 return 0;
1063
1064 tk = to_trace_kprobe(ev);
1065 nmissed = trace_kprobe_is_return(tk) ?
1066 tk->rp.kp.nmissed + tk->rp.nmissed : tk->rp.kp.nmissed;
1067 seq_printf(m, " %-44s %15lu %15lu\n",
1068 trace_probe_name(&tk->tp),
1069 trace_kprobe_nhit(tk),
1070 nmissed);
1071
1072 return 0;
1073}
1074
1075static const struct seq_operations profile_seq_op = {
1076 .start = dyn_event_seq_start,
1077 .next = dyn_event_seq_next,
1078 .stop = dyn_event_seq_stop,
1079 .show = probes_profile_seq_show
1080};
1081
1082static int profile_open(struct inode *inode, struct file *file)
1083{
1084 int ret;
1085
1086 ret = security_locked_down(LOCKDOWN_TRACEFS);
1087 if (ret)
1088 return ret;
1089
1090 return seq_open(file, &profile_seq_op);
1091}
1092
1093static const struct file_operations kprobe_profile_ops = {
1094 .owner = THIS_MODULE,
1095 .open = profile_open,
1096 .read = seq_read,
1097 .llseek = seq_lseek,
1098 .release = seq_release,
1099};
1100
1101/* Kprobe specific fetch functions */
1102
1103/* Return the length of string -- including null terminal byte */
1104static nokprobe_inline int
1105fetch_store_strlen(unsigned long addr)
1106{
1107 int ret, len = 0;
1108 u8 c;
1109
1110 do {
1111 ret = probe_kernel_read(&c, (u8 *)addr + len, 1);
1112 len++;
1113 } while (c && ret == 0 && len < MAX_STRING_SIZE);
1114
1115 return (ret < 0) ? ret : len;
1116}
1117
1118/* Return the length of string -- including null terminal byte */
1119static nokprobe_inline int
1120fetch_store_strlen_user(unsigned long addr)
1121{
1122 const void __user *uaddr = (__force const void __user *)addr;
1123
1124 return strnlen_unsafe_user(uaddr, MAX_STRING_SIZE);
1125}
1126
1127/*
1128 * Fetch a null-terminated string. Caller MUST set *(u32 *)buf with max
1129 * length and relative data location.
1130 */
1131static nokprobe_inline int
1132fetch_store_string(unsigned long addr, void *dest, void *base)
1133{
1134 int maxlen = get_loc_len(*(u32 *)dest);
1135 void *__dest;
1136 long ret;
1137
1138 if (unlikely(!maxlen))
1139 return -ENOMEM;
1140
1141 __dest = get_loc_data(dest, base);
1142
1143 /*
1144 * Try to get string again, since the string can be changed while
1145 * probing.
1146 */
1147 ret = strncpy_from_unsafe(__dest, (void *)addr, maxlen);
1148 if (ret >= 0)
1149 *(u32 *)dest = make_data_loc(ret, __dest - base);
1150
1151 return ret;
1152}
1153
1154/*
1155 * Fetch a null-terminated string from user. Caller MUST set *(u32 *)buf
1156 * with max length and relative data location.
1157 */
1158static nokprobe_inline int
1159fetch_store_string_user(unsigned long addr, void *dest, void *base)
1160{
1161 const void __user *uaddr = (__force const void __user *)addr;
1162 int maxlen = get_loc_len(*(u32 *)dest);
1163 void *__dest;
1164 long ret;
1165
1166 if (unlikely(!maxlen))
1167 return -ENOMEM;
1168
1169 __dest = get_loc_data(dest, base);
1170
1171 ret = strncpy_from_unsafe_user(__dest, uaddr, maxlen);
1172 if (ret >= 0)
1173 *(u32 *)dest = make_data_loc(ret, __dest - base);
1174
1175 return ret;
1176}
1177
1178static nokprobe_inline int
1179probe_mem_read(void *dest, void *src, size_t size)
1180{
1181 return probe_kernel_read(dest, src, size);
1182}
1183
1184static nokprobe_inline int
1185probe_mem_read_user(void *dest, void *src, size_t size)
1186{
1187 const void __user *uaddr = (__force const void __user *)src;
1188
1189 return probe_user_read(dest, uaddr, size);
1190}
1191
1192/* Note that we don't verify it, since the code does not come from user space */
1193static int
1194process_fetch_insn(struct fetch_insn *code, void *rec, void *dest,
1195 void *base)
1196{
1197 struct pt_regs *regs = rec;
1198 unsigned long val;
1199
1200retry:
1201 /* 1st stage: get value from context */
1202 switch (code->op) {
1203 case FETCH_OP_REG:
1204 val = regs_get_register(regs, code->param);
1205 break;
1206 case FETCH_OP_STACK:
1207 val = regs_get_kernel_stack_nth(regs, code->param);
1208 break;
1209 case FETCH_OP_STACKP:
1210 val = kernel_stack_pointer(regs);
1211 break;
1212 case FETCH_OP_RETVAL:
1213 val = regs_return_value(regs);
1214 break;
1215 case FETCH_OP_IMM:
1216 val = code->immediate;
1217 break;
1218 case FETCH_OP_COMM:
1219 val = (unsigned long)current->comm;
1220 break;
1221 case FETCH_OP_DATA:
1222 val = (unsigned long)code->data;
1223 break;
1224#ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
1225 case FETCH_OP_ARG:
1226 val = regs_get_kernel_argument(regs, code->param);
1227 break;
1228#endif
1229 case FETCH_NOP_SYMBOL: /* Ignore a place holder */
1230 code++;
1231 goto retry;
1232 default:
1233 return -EILSEQ;
1234 }
1235 code++;
1236
1237 return process_fetch_insn_bottom(code, val, dest, base);
1238}
1239NOKPROBE_SYMBOL(process_fetch_insn)
1240
1241/* Kprobe handler */
1242static nokprobe_inline void
1243__kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs,
1244 struct trace_event_file *trace_file)
1245{
1246 struct kprobe_trace_entry_head *entry;
1247 struct ring_buffer_event *event;
1248 struct ring_buffer *buffer;
1249 int size, dsize, pc;
1250 unsigned long irq_flags;
1251 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1252
1253 WARN_ON(call != trace_file->event_call);
1254
1255 if (trace_trigger_soft_disabled(trace_file))
1256 return;
1257
1258 local_save_flags(irq_flags);
1259 pc = preempt_count();
1260
1261 dsize = __get_data_size(&tk->tp, regs);
1262 size = sizeof(*entry) + tk->tp.size + dsize;
1263
1264 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
1265 call->event.type,
1266 size, irq_flags, pc);
1267 if (!event)
1268 return;
1269
1270 entry = ring_buffer_event_data(event);
1271 entry->ip = (unsigned long)tk->rp.kp.addr;
1272 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize);
1273
1274 event_trigger_unlock_commit_regs(trace_file, buffer, event,
1275 entry, irq_flags, pc, regs);
1276}
1277
1278static void
1279kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs)
1280{
1281 struct event_file_link *link;
1282
1283 trace_probe_for_each_link_rcu(link, &tk->tp)
1284 __kprobe_trace_func(tk, regs, link->file);
1285}
1286NOKPROBE_SYMBOL(kprobe_trace_func);
1287
1288/* Kretprobe handler */
1289static nokprobe_inline void
1290__kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1291 struct pt_regs *regs,
1292 struct trace_event_file *trace_file)
1293{
1294 struct kretprobe_trace_entry_head *entry;
1295 struct ring_buffer_event *event;
1296 struct ring_buffer *buffer;
1297 int size, pc, dsize;
1298 unsigned long irq_flags;
1299 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1300
1301 WARN_ON(call != trace_file->event_call);
1302
1303 if (trace_trigger_soft_disabled(trace_file))
1304 return;
1305
1306 local_save_flags(irq_flags);
1307 pc = preempt_count();
1308
1309 dsize = __get_data_size(&tk->tp, regs);
1310 size = sizeof(*entry) + tk->tp.size + dsize;
1311
1312 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
1313 call->event.type,
1314 size, irq_flags, pc);
1315 if (!event)
1316 return;
1317
1318 entry = ring_buffer_event_data(event);
1319 entry->func = (unsigned long)tk->rp.kp.addr;
1320 entry->ret_ip = (unsigned long)ri->ret_addr;
1321 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize);
1322
1323 event_trigger_unlock_commit_regs(trace_file, buffer, event,
1324 entry, irq_flags, pc, regs);
1325}
1326
1327static void
1328kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1329 struct pt_regs *regs)
1330{
1331 struct event_file_link *link;
1332
1333 trace_probe_for_each_link_rcu(link, &tk->tp)
1334 __kretprobe_trace_func(tk, ri, regs, link->file);
1335}
1336NOKPROBE_SYMBOL(kretprobe_trace_func);
1337
1338/* Event entry printers */
1339static enum print_line_t
1340print_kprobe_event(struct trace_iterator *iter, int flags,
1341 struct trace_event *event)
1342{
1343 struct kprobe_trace_entry_head *field;
1344 struct trace_seq *s = &iter->seq;
1345 struct trace_probe *tp;
1346
1347 field = (struct kprobe_trace_entry_head *)iter->ent;
1348 tp = trace_probe_primary_from_call(
1349 container_of(event, struct trace_event_call, event));
1350 if (WARN_ON_ONCE(!tp))
1351 goto out;
1352
1353 trace_seq_printf(s, "%s: (", trace_probe_name(tp));
1354
1355 if (!seq_print_ip_sym(s, field->ip, flags | TRACE_ITER_SYM_OFFSET))
1356 goto out;
1357
1358 trace_seq_putc(s, ')');
1359
1360 if (print_probe_args(s, tp->args, tp->nr_args,
1361 (u8 *)&field[1], field) < 0)
1362 goto out;
1363
1364 trace_seq_putc(s, '\n');
1365 out:
1366 return trace_handle_return(s);
1367}
1368
1369static enum print_line_t
1370print_kretprobe_event(struct trace_iterator *iter, int flags,
1371 struct trace_event *event)
1372{
1373 struct kretprobe_trace_entry_head *field;
1374 struct trace_seq *s = &iter->seq;
1375 struct trace_probe *tp;
1376
1377 field = (struct kretprobe_trace_entry_head *)iter->ent;
1378 tp = trace_probe_primary_from_call(
1379 container_of(event, struct trace_event_call, event));
1380 if (WARN_ON_ONCE(!tp))
1381 goto out;
1382
1383 trace_seq_printf(s, "%s: (", trace_probe_name(tp));
1384
1385 if (!seq_print_ip_sym(s, field->ret_ip, flags | TRACE_ITER_SYM_OFFSET))
1386 goto out;
1387
1388 trace_seq_puts(s, " <- ");
1389
1390 if (!seq_print_ip_sym(s, field->func, flags & ~TRACE_ITER_SYM_OFFSET))
1391 goto out;
1392
1393 trace_seq_putc(s, ')');
1394
1395 if (print_probe_args(s, tp->args, tp->nr_args,
1396 (u8 *)&field[1], field) < 0)
1397 goto out;
1398
1399 trace_seq_putc(s, '\n');
1400
1401 out:
1402 return trace_handle_return(s);
1403}
1404
1405
1406static int kprobe_event_define_fields(struct trace_event_call *event_call)
1407{
1408 int ret;
1409 struct kprobe_trace_entry_head field;
1410 struct trace_probe *tp;
1411
1412 tp = trace_probe_primary_from_call(event_call);
1413 if (WARN_ON_ONCE(!tp))
1414 return -ENOENT;
1415
1416 DEFINE_FIELD(unsigned long, ip, FIELD_STRING_IP, 0);
1417
1418 return traceprobe_define_arg_fields(event_call, sizeof(field), tp);
1419}
1420
1421static int kretprobe_event_define_fields(struct trace_event_call *event_call)
1422{
1423 int ret;
1424 struct kretprobe_trace_entry_head field;
1425 struct trace_probe *tp;
1426
1427 tp = trace_probe_primary_from_call(event_call);
1428 if (WARN_ON_ONCE(!tp))
1429 return -ENOENT;
1430
1431 DEFINE_FIELD(unsigned long, func, FIELD_STRING_FUNC, 0);
1432 DEFINE_FIELD(unsigned long, ret_ip, FIELD_STRING_RETIP, 0);
1433
1434 return traceprobe_define_arg_fields(event_call, sizeof(field), tp);
1435}
1436
1437#ifdef CONFIG_PERF_EVENTS
1438
1439/* Kprobe profile handler */
1440static int
1441kprobe_perf_func(struct trace_kprobe *tk, struct pt_regs *regs)
1442{
1443 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1444 struct kprobe_trace_entry_head *entry;
1445 struct hlist_head *head;
1446 int size, __size, dsize;
1447 int rctx;
1448
1449 if (bpf_prog_array_valid(call)) {
1450 unsigned long orig_ip = instruction_pointer(regs);
1451 int ret;
1452
1453 ret = trace_call_bpf(call, regs);
1454
1455 /*
1456 * We need to check and see if we modified the pc of the
1457 * pt_regs, and if so return 1 so that we don't do the
1458 * single stepping.
1459 */
1460 if (orig_ip != instruction_pointer(regs))
1461 return 1;
1462 if (!ret)
1463 return 0;
1464 }
1465
1466 head = this_cpu_ptr(call->perf_events);
1467 if (hlist_empty(head))
1468 return 0;
1469
1470 dsize = __get_data_size(&tk->tp, regs);
1471 __size = sizeof(*entry) + tk->tp.size + dsize;
1472 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1473 size -= sizeof(u32);
1474
1475 entry = perf_trace_buf_alloc(size, NULL, &rctx);
1476 if (!entry)
1477 return 0;
1478
1479 entry->ip = (unsigned long)tk->rp.kp.addr;
1480 memset(&entry[1], 0, dsize);
1481 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize);
1482 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
1483 head, NULL);
1484 return 0;
1485}
1486NOKPROBE_SYMBOL(kprobe_perf_func);
1487
1488/* Kretprobe profile handler */
1489static void
1490kretprobe_perf_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1491 struct pt_regs *regs)
1492{
1493 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1494 struct kretprobe_trace_entry_head *entry;
1495 struct hlist_head *head;
1496 int size, __size, dsize;
1497 int rctx;
1498
1499 if (bpf_prog_array_valid(call) && !trace_call_bpf(call, regs))
1500 return;
1501
1502 head = this_cpu_ptr(call->perf_events);
1503 if (hlist_empty(head))
1504 return;
1505
1506 dsize = __get_data_size(&tk->tp, regs);
1507 __size = sizeof(*entry) + tk->tp.size + dsize;
1508 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1509 size -= sizeof(u32);
1510
1511 entry = perf_trace_buf_alloc(size, NULL, &rctx);
1512 if (!entry)
1513 return;
1514
1515 entry->func = (unsigned long)tk->rp.kp.addr;
1516 entry->ret_ip = (unsigned long)ri->ret_addr;
1517 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize);
1518 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
1519 head, NULL);
1520}
1521NOKPROBE_SYMBOL(kretprobe_perf_func);
1522
1523int bpf_get_kprobe_info(const struct perf_event *event, u32 *fd_type,
1524 const char **symbol, u64 *probe_offset,
1525 u64 *probe_addr, bool perf_type_tracepoint)
1526{
1527 const char *pevent = trace_event_name(event->tp_event);
1528 const char *group = event->tp_event->class->system;
1529 struct trace_kprobe *tk;
1530
1531 if (perf_type_tracepoint)
1532 tk = find_trace_kprobe(pevent, group);
1533 else
1534 tk = trace_kprobe_primary_from_call(event->tp_event);
1535 if (!tk)
1536 return -EINVAL;
1537
1538 *fd_type = trace_kprobe_is_return(tk) ? BPF_FD_TYPE_KRETPROBE
1539 : BPF_FD_TYPE_KPROBE;
1540 if (tk->symbol) {
1541 *symbol = tk->symbol;
1542 *probe_offset = tk->rp.kp.offset;
1543 *probe_addr = 0;
1544 } else {
1545 *symbol = NULL;
1546 *probe_offset = 0;
1547 *probe_addr = (unsigned long)tk->rp.kp.addr;
1548 }
1549 return 0;
1550}
1551#endif /* CONFIG_PERF_EVENTS */
1552
1553/*
1554 * called by perf_trace_init() or __ftrace_set_clr_event() under event_mutex.
1555 *
1556 * kprobe_trace_self_tests_init() does enable_trace_probe/disable_trace_probe
1557 * lockless, but we can't race with this __init function.
1558 */
1559static int kprobe_register(struct trace_event_call *event,
1560 enum trace_reg type, void *data)
1561{
1562 struct trace_event_file *file = data;
1563
1564 switch (type) {
1565 case TRACE_REG_REGISTER:
1566 return enable_trace_kprobe(event, file);
1567 case TRACE_REG_UNREGISTER:
1568 return disable_trace_kprobe(event, file);
1569
1570#ifdef CONFIG_PERF_EVENTS
1571 case TRACE_REG_PERF_REGISTER:
1572 return enable_trace_kprobe(event, NULL);
1573 case TRACE_REG_PERF_UNREGISTER:
1574 return disable_trace_kprobe(event, NULL);
1575 case TRACE_REG_PERF_OPEN:
1576 case TRACE_REG_PERF_CLOSE:
1577 case TRACE_REG_PERF_ADD:
1578 case TRACE_REG_PERF_DEL:
1579 return 0;
1580#endif
1581 }
1582 return 0;
1583}
1584
1585static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs)
1586{
1587 struct trace_kprobe *tk = container_of(kp, struct trace_kprobe, rp.kp);
1588 int ret = 0;
1589
1590 raw_cpu_inc(*tk->nhit);
1591
1592 if (trace_probe_test_flag(&tk->tp, TP_FLAG_TRACE))
1593 kprobe_trace_func(tk, regs);
1594#ifdef CONFIG_PERF_EVENTS
1595 if (trace_probe_test_flag(&tk->tp, TP_FLAG_PROFILE))
1596 ret = kprobe_perf_func(tk, regs);
1597#endif
1598 return ret;
1599}
1600NOKPROBE_SYMBOL(kprobe_dispatcher);
1601
1602static int
1603kretprobe_dispatcher(struct kretprobe_instance *ri, struct pt_regs *regs)
1604{
1605 struct trace_kprobe *tk = container_of(ri->rp, struct trace_kprobe, rp);
1606
1607 raw_cpu_inc(*tk->nhit);
1608
1609 if (trace_probe_test_flag(&tk->tp, TP_FLAG_TRACE))
1610 kretprobe_trace_func(tk, ri, regs);
1611#ifdef CONFIG_PERF_EVENTS
1612 if (trace_probe_test_flag(&tk->tp, TP_FLAG_PROFILE))
1613 kretprobe_perf_func(tk, ri, regs);
1614#endif
1615 return 0; /* We don't tweek kernel, so just return 0 */
1616}
1617NOKPROBE_SYMBOL(kretprobe_dispatcher);
1618
1619static struct trace_event_functions kretprobe_funcs = {
1620 .trace = print_kretprobe_event
1621};
1622
1623static struct trace_event_functions kprobe_funcs = {
1624 .trace = print_kprobe_event
1625};
1626
1627static inline void init_trace_event_call(struct trace_kprobe *tk)
1628{
1629 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1630
1631 if (trace_kprobe_is_return(tk)) {
1632 call->event.funcs = &kretprobe_funcs;
1633 call->class->define_fields = kretprobe_event_define_fields;
1634 } else {
1635 call->event.funcs = &kprobe_funcs;
1636 call->class->define_fields = kprobe_event_define_fields;
1637 }
1638
1639 call->flags = TRACE_EVENT_FL_KPROBE;
1640 call->class->reg = kprobe_register;
1641}
1642
1643static int register_kprobe_event(struct trace_kprobe *tk)
1644{
1645 init_trace_event_call(tk);
1646
1647 return trace_probe_register_event_call(&tk->tp);
1648}
1649
1650static int unregister_kprobe_event(struct trace_kprobe *tk)
1651{
1652 return trace_probe_unregister_event_call(&tk->tp);
1653}
1654
1655#ifdef CONFIG_PERF_EVENTS
1656
1657/* create a trace_kprobe, but don't add it to global lists */
1658struct trace_event_call *
1659create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
1660 bool is_return)
1661{
1662 struct trace_kprobe *tk;
1663 int ret;
1664 char *event;
1665
1666 if (func && !strchr(func, ':')) {
1667 unsigned int count;
1668
1669 count = number_of_same_symbols(func);
1670 if (count > 1)
1671 /*
1672 * Users should use addr to remove the ambiguity of
1673 * using func only.
1674 */
1675 return ERR_PTR(-EADDRNOTAVAIL);
1676 else if (count == 0)
1677 /*
1678 * We can return ENOENT earlier than when register the
1679 * kprobe.
1680 */
1681 return ERR_PTR(-ENOENT);
1682 }
1683
1684 /*
1685 * local trace_kprobes are not added to dyn_event, so they are never
1686 * searched in find_trace_kprobe(). Therefore, there is no concern of
1687 * duplicated name here.
1688 */
1689 event = func ? func : "DUMMY_EVENT";
1690
1691 tk = alloc_trace_kprobe(KPROBE_EVENT_SYSTEM, event, (void *)addr, func,
1692 offs, 0 /* maxactive */, 0 /* nargs */,
1693 is_return);
1694
1695 if (IS_ERR(tk)) {
1696 pr_info("Failed to allocate trace_probe.(%d)\n",
1697 (int)PTR_ERR(tk));
1698 return ERR_CAST(tk);
1699 }
1700
1701 init_trace_event_call(tk);
1702
1703 if (traceprobe_set_print_fmt(&tk->tp, trace_kprobe_is_return(tk)) < 0) {
1704 ret = -ENOMEM;
1705 goto error;
1706 }
1707
1708 ret = __register_trace_kprobe(tk);
1709 if (ret < 0)
1710 goto error;
1711
1712 return trace_probe_event_call(&tk->tp);
1713error:
1714 free_trace_kprobe(tk);
1715 return ERR_PTR(ret);
1716}
1717
1718void destroy_local_trace_kprobe(struct trace_event_call *event_call)
1719{
1720 struct trace_kprobe *tk;
1721
1722 tk = trace_kprobe_primary_from_call(event_call);
1723 if (unlikely(!tk))
1724 return;
1725
1726 if (trace_probe_is_enabled(&tk->tp)) {
1727 WARN_ON(1);
1728 return;
1729 }
1730
1731 __unregister_trace_kprobe(tk);
1732
1733 free_trace_kprobe(tk);
1734}
1735#endif /* CONFIG_PERF_EVENTS */
1736
1737static __init void enable_boot_kprobe_events(void)
1738{
1739 struct trace_array *tr = top_trace_array();
1740 struct trace_event_file *file;
1741 struct trace_kprobe *tk;
1742 struct dyn_event *pos;
1743
1744 mutex_lock(&event_mutex);
1745 for_each_trace_kprobe(tk, pos) {
1746 list_for_each_entry(file, &tr->events, list)
1747 if (file->event_call == trace_probe_event_call(&tk->tp))
1748 trace_event_enable_disable(file, 1, 0);
1749 }
1750 mutex_unlock(&event_mutex);
1751}
1752
1753static __init void setup_boot_kprobe_events(void)
1754{
1755 char *p, *cmd = kprobe_boot_events_buf;
1756 int ret;
1757
1758 strreplace(kprobe_boot_events_buf, ',', ' ');
1759
1760 while (cmd && *cmd != '\0') {
1761 p = strchr(cmd, ';');
1762 if (p)
1763 *p++ = '\0';
1764
1765 ret = trace_run_command(cmd, create_or_delete_trace_kprobe);
1766 if (ret)
1767 pr_warn("Failed to add event(%d): %s\n", ret, cmd);
1768 else
1769 kprobe_boot_events_enabled = true;
1770
1771 cmd = p;
1772 }
1773
1774 enable_boot_kprobe_events();
1775}
1776
1777/* Make a tracefs interface for controlling probe points */
1778static __init int init_kprobe_trace(void)
1779{
1780 struct dentry *d_tracer;
1781 struct dentry *entry;
1782 int ret;
1783
1784 ret = dyn_event_register(&trace_kprobe_ops);
1785 if (ret)
1786 return ret;
1787
1788 if (register_module_notifier(&trace_kprobe_module_nb))
1789 return -EINVAL;
1790
1791 d_tracer = tracing_init_dentry();
1792 if (IS_ERR(d_tracer))
1793 return 0;
1794
1795 entry = tracefs_create_file("kprobe_events", 0644, d_tracer,
1796 NULL, &kprobe_events_ops);
1797
1798 /* Event list interface */
1799 if (!entry)
1800 pr_warn("Could not create tracefs 'kprobe_events' entry\n");
1801
1802 /* Profile interface */
1803 entry = tracefs_create_file("kprobe_profile", 0444, d_tracer,
1804 NULL, &kprobe_profile_ops);
1805
1806 if (!entry)
1807 pr_warn("Could not create tracefs 'kprobe_profile' entry\n");
1808
1809 setup_boot_kprobe_events();
1810
1811 return 0;
1812}
1813fs_initcall(init_kprobe_trace);
1814
1815
1816#ifdef CONFIG_FTRACE_STARTUP_TEST
1817static __init struct trace_event_file *
1818find_trace_probe_file(struct trace_kprobe *tk, struct trace_array *tr)
1819{
1820 struct trace_event_file *file;
1821
1822 list_for_each_entry(file, &tr->events, list)
1823 if (file->event_call == trace_probe_event_call(&tk->tp))
1824 return file;
1825
1826 return NULL;
1827}
1828
1829/*
1830 * Nobody but us can call enable_trace_kprobe/disable_trace_kprobe at this
1831 * stage, we can do this lockless.
1832 */
1833static __init int kprobe_trace_self_tests_init(void)
1834{
1835 int ret, warn = 0;
1836 int (*target)(int, int, int, int, int, int);
1837 struct trace_kprobe *tk;
1838 struct trace_event_file *file;
1839
1840 if (tracing_is_disabled())
1841 return -ENODEV;
1842
1843 if (kprobe_boot_events_enabled) {
1844 pr_info("Skipping kprobe tests due to kprobe_event on cmdline\n");
1845 return 0;
1846 }
1847
1848 target = kprobe_trace_selftest_target;
1849
1850 pr_info("Testing kprobe tracing: ");
1851
1852 ret = trace_run_command("p:testprobe kprobe_trace_selftest_target $stack $stack0 +0($stack)",
1853 create_or_delete_trace_kprobe);
1854 if (WARN_ON_ONCE(ret)) {
1855 pr_warn("error on probing function entry.\n");
1856 warn++;
1857 } else {
1858 /* Enable trace point */
1859 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
1860 if (WARN_ON_ONCE(tk == NULL)) {
1861 pr_warn("error on getting new probe.\n");
1862 warn++;
1863 } else {
1864 file = find_trace_probe_file(tk, top_trace_array());
1865 if (WARN_ON_ONCE(file == NULL)) {
1866 pr_warn("error on getting probe file.\n");
1867 warn++;
1868 } else
1869 enable_trace_kprobe(
1870 trace_probe_event_call(&tk->tp), file);
1871 }
1872 }
1873
1874 ret = trace_run_command("r:testprobe2 kprobe_trace_selftest_target $retval",
1875 create_or_delete_trace_kprobe);
1876 if (WARN_ON_ONCE(ret)) {
1877 pr_warn("error on probing function return.\n");
1878 warn++;
1879 } else {
1880 /* Enable trace point */
1881 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
1882 if (WARN_ON_ONCE(tk == NULL)) {
1883 pr_warn("error on getting 2nd new probe.\n");
1884 warn++;
1885 } else {
1886 file = find_trace_probe_file(tk, top_trace_array());
1887 if (WARN_ON_ONCE(file == NULL)) {
1888 pr_warn("error on getting probe file.\n");
1889 warn++;
1890 } else
1891 enable_trace_kprobe(
1892 trace_probe_event_call(&tk->tp), file);
1893 }
1894 }
1895
1896 if (warn)
1897 goto end;
1898
1899 ret = target(1, 2, 3, 4, 5, 6);
1900
1901 /*
1902 * Not expecting an error here, the check is only to prevent the
1903 * optimizer from removing the call to target() as otherwise there
1904 * are no side-effects and the call is never performed.
1905 */
1906 if (ret != 21)
1907 warn++;
1908
1909 /* Disable trace points before removing it */
1910 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
1911 if (WARN_ON_ONCE(tk == NULL)) {
1912 pr_warn("error on getting test probe.\n");
1913 warn++;
1914 } else {
1915 if (trace_kprobe_nhit(tk) != 1) {
1916 pr_warn("incorrect number of testprobe hits\n");
1917 warn++;
1918 }
1919
1920 file = find_trace_probe_file(tk, top_trace_array());
1921 if (WARN_ON_ONCE(file == NULL)) {
1922 pr_warn("error on getting probe file.\n");
1923 warn++;
1924 } else
1925 disable_trace_kprobe(
1926 trace_probe_event_call(&tk->tp), file);
1927 }
1928
1929 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
1930 if (WARN_ON_ONCE(tk == NULL)) {
1931 pr_warn("error on getting 2nd test probe.\n");
1932 warn++;
1933 } else {
1934 if (trace_kprobe_nhit(tk) != 1) {
1935 pr_warn("incorrect number of testprobe2 hits\n");
1936 warn++;
1937 }
1938
1939 file = find_trace_probe_file(tk, top_trace_array());
1940 if (WARN_ON_ONCE(file == NULL)) {
1941 pr_warn("error on getting probe file.\n");
1942 warn++;
1943 } else
1944 disable_trace_kprobe(
1945 trace_probe_event_call(&tk->tp), file);
1946 }
1947
1948 ret = trace_run_command("-:testprobe", create_or_delete_trace_kprobe);
1949 if (WARN_ON_ONCE(ret)) {
1950 pr_warn("error on deleting a probe.\n");
1951 warn++;
1952 }
1953
1954 ret = trace_run_command("-:testprobe2", create_or_delete_trace_kprobe);
1955 if (WARN_ON_ONCE(ret)) {
1956 pr_warn("error on deleting a probe.\n");
1957 warn++;
1958 }
1959
1960end:
1961 ret = dyn_events_release_all(&trace_kprobe_ops);
1962 if (WARN_ON_ONCE(ret)) {
1963 pr_warn("error on cleaning up probes.\n");
1964 warn++;
1965 }
1966 /*
1967 * Wait for the optimizer work to finish. Otherwise it might fiddle
1968 * with probes in already freed __init text.
1969 */
1970 wait_for_kprobe_optimizer();
1971 if (warn)
1972 pr_cont("NG: Some tests are failed. Please check them.\n");
1973 else
1974 pr_cont("OK\n");
1975 return 0;
1976}
1977
1978late_initcall(kprobe_trace_self_tests_init);
1979
1980#endif