1 // SPDX-License-Identifier: GPL-2.0
3 * Kprobes-based tracing events
5 * Created by Masami Hiramatsu <mhiramat@redhat.com>
8 #define pr_fmt(fmt) "trace_kprobe: " fmt
10 #include <linux/bpf-cgroup.h>
11 #include <linux/cleanup.h>
12 #include <linux/error-injection.h>
13 #include <linux/module.h>
14 #include <linux/rculist.h>
15 #include <linux/security.h>
16 #include <linux/uaccess.h>
18 #include <asm/setup.h> /* for COMMAND_LINE_SIZE */
20 #include "trace_dynevent.h"
21 #include "trace_kprobe_selftest.h"
22 #include "trace_probe.h"
23 #include "trace_probe_kernel.h"
24 #include "trace_probe_tmpl.h"
26 #define KPROBE_EVENT_SYSTEM "kprobes"
27 #define KRETPROBE_MAXACTIVE_MAX 4096
29 /* Kprobe early definition from command line */
30 static char kprobe_boot_events_buf[COMMAND_LINE_SIZE] __initdata;
32 static int __init set_kprobe_boot_events(char *str)
34 strscpy(kprobe_boot_events_buf, str, COMMAND_LINE_SIZE);
35 disable_tracing_selftest("running kprobe events");
39 __setup("kprobe_event=", set_kprobe_boot_events);
41 static int trace_kprobe_create(const char *raw_command);
42 static int trace_kprobe_show(struct seq_file *m, struct dyn_event *ev);
43 static int trace_kprobe_release(struct dyn_event *ev);
44 static bool trace_kprobe_is_busy(struct dyn_event *ev);
45 static bool trace_kprobe_match(const char *system, const char *event,
46 int argc, const char **argv, struct dyn_event *ev);
48 static struct dyn_event_operations trace_kprobe_ops = {
49 .create = trace_kprobe_create,
50 .show = trace_kprobe_show,
51 .is_busy = trace_kprobe_is_busy,
52 .free = trace_kprobe_release,
53 .match = trace_kprobe_match,
57 * Kprobe event core functions
60 struct dyn_event devent;
61 struct kretprobe rp; /* Use rp.kp for kprobe use */
62 unsigned long __percpu *nhit;
63 const char *symbol; /* symbol name */
64 struct trace_probe tp;
67 static bool is_trace_kprobe(struct dyn_event *ev)
69 return ev->ops == &trace_kprobe_ops;
72 static struct trace_kprobe *to_trace_kprobe(struct dyn_event *ev)
74 return container_of(ev, struct trace_kprobe, devent);
78 * for_each_trace_kprobe - iterate over the trace_kprobe list
79 * @pos: the struct trace_kprobe * for each entry
80 * @dpos: the struct dyn_event * to use as a loop cursor
82 #define for_each_trace_kprobe(pos, dpos) \
83 for_each_dyn_event(dpos) \
84 if (is_trace_kprobe(dpos) && (pos = to_trace_kprobe(dpos)))
86 static nokprobe_inline bool trace_kprobe_is_return(struct trace_kprobe *tk)
88 return tk->rp.handler != NULL;
91 static nokprobe_inline const char *trace_kprobe_symbol(struct trace_kprobe *tk)
93 return tk->symbol ? tk->symbol : "unknown";
96 static nokprobe_inline unsigned long trace_kprobe_offset(struct trace_kprobe *tk)
98 return tk->rp.kp.offset;
101 static nokprobe_inline bool trace_kprobe_has_gone(struct trace_kprobe *tk)
103 return kprobe_gone(&tk->rp.kp);
106 static nokprobe_inline bool trace_kprobe_within_module(struct trace_kprobe *tk,
109 int len = strlen(module_name(mod));
110 const char *name = trace_kprobe_symbol(tk);
112 return strncmp(module_name(mod), name, len) == 0 && name[len] == ':';
115 #ifdef CONFIG_MODULES
116 static nokprobe_inline bool trace_kprobe_module_exist(struct trace_kprobe *tk)
123 p = strchr(tk->symbol, ':');
128 ret = !!find_module(tk->symbol);
134 static inline bool trace_kprobe_module_exist(struct trace_kprobe *tk)
140 static bool trace_kprobe_is_busy(struct dyn_event *ev)
142 struct trace_kprobe *tk = to_trace_kprobe(ev);
144 return trace_probe_is_enabled(&tk->tp);
147 static bool trace_kprobe_match_command_head(struct trace_kprobe *tk,
148 int argc, const char **argv)
150 char buf[MAX_ARGSTR_LEN + 1];
156 snprintf(buf, sizeof(buf), "0x%p", tk->rp.kp.addr);
157 else if (tk->rp.kp.offset)
158 snprintf(buf, sizeof(buf), "%s+%u",
159 trace_kprobe_symbol(tk), tk->rp.kp.offset);
161 snprintf(buf, sizeof(buf), "%s", trace_kprobe_symbol(tk));
162 if (strcmp(buf, argv[0]))
166 return trace_probe_match_command_args(&tk->tp, argc, argv);
169 static bool trace_kprobe_match(const char *system, const char *event,
170 int argc, const char **argv, struct dyn_event *ev)
172 struct trace_kprobe *tk = to_trace_kprobe(ev);
174 return (event[0] == '\0' ||
175 strcmp(trace_probe_name(&tk->tp), event) == 0) &&
176 (!system || strcmp(trace_probe_group_name(&tk->tp), system) == 0) &&
177 trace_kprobe_match_command_head(tk, argc, argv);
180 static nokprobe_inline unsigned long trace_kprobe_nhit(struct trace_kprobe *tk)
182 unsigned long nhit = 0;
185 for_each_possible_cpu(cpu)
186 nhit += *per_cpu_ptr(tk->nhit, cpu);
191 static nokprobe_inline bool trace_kprobe_is_registered(struct trace_kprobe *tk)
193 return !(list_empty(&tk->rp.kp.list) &&
194 hlist_unhashed(&tk->rp.kp.hlist));
197 /* Return 0 if it fails to find the symbol address */
198 static nokprobe_inline
199 unsigned long trace_kprobe_address(struct trace_kprobe *tk)
204 addr = (unsigned long)
205 kallsyms_lookup_name(trace_kprobe_symbol(tk));
207 addr += tk->rp.kp.offset;
209 addr = (unsigned long)tk->rp.kp.addr;
214 static nokprobe_inline struct trace_kprobe *
215 trace_kprobe_primary_from_call(struct trace_event_call *call)
217 struct trace_probe *tp;
219 tp = trace_probe_primary_from_call(call);
220 if (WARN_ON_ONCE(!tp))
223 return container_of(tp, struct trace_kprobe, tp);
226 bool trace_kprobe_on_func_entry(struct trace_event_call *call)
228 struct trace_kprobe *tk = trace_kprobe_primary_from_call(call);
230 return tk ? (kprobe_on_func_entry(tk->rp.kp.addr,
231 tk->rp.kp.addr ? NULL : tk->rp.kp.symbol_name,
232 tk->rp.kp.addr ? 0 : tk->rp.kp.offset) == 0) : false;
235 bool trace_kprobe_error_injectable(struct trace_event_call *call)
237 struct trace_kprobe *tk = trace_kprobe_primary_from_call(call);
239 return tk ? within_error_injection_list(trace_kprobe_address(tk)) :
243 static int register_kprobe_event(struct trace_kprobe *tk);
244 static int unregister_kprobe_event(struct trace_kprobe *tk);
246 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs);
247 static int kretprobe_dispatcher(struct kretprobe_instance *ri,
248 struct pt_regs *regs);
250 static void free_trace_kprobe(struct trace_kprobe *tk)
253 trace_probe_cleanup(&tk->tp);
255 free_percpu(tk->nhit);
260 DEFINE_FREE(free_trace_kprobe, struct trace_kprobe *,
261 if (!IS_ERR_OR_NULL(_T)) free_trace_kprobe(_T))
264 * Allocate new trace_probe and initialize it (including kprobes).
266 static struct trace_kprobe *alloc_trace_kprobe(const char *group,
272 int nargs, bool is_return)
274 struct trace_kprobe *tk __free(free_trace_kprobe) = NULL;
277 tk = kzalloc(struct_size(tk, tp.args, nargs), GFP_KERNEL);
281 tk->nhit = alloc_percpu(unsigned long);
286 tk->symbol = kstrdup(symbol, GFP_KERNEL);
289 tk->rp.kp.symbol_name = tk->symbol;
290 tk->rp.kp.offset = offs;
292 tk->rp.kp.addr = addr;
295 tk->rp.handler = kretprobe_dispatcher;
297 tk->rp.kp.pre_handler = kprobe_dispatcher;
299 tk->rp.maxactive = maxactive;
300 INIT_HLIST_NODE(&tk->rp.kp.hlist);
301 INIT_LIST_HEAD(&tk->rp.kp.list);
303 ret = trace_probe_init(&tk->tp, event, group, false, nargs);
307 dyn_event_init(&tk->devent, &trace_kprobe_ops);
311 static struct trace_kprobe *find_trace_kprobe(const char *event,
314 struct dyn_event *pos;
315 struct trace_kprobe *tk;
317 for_each_trace_kprobe(tk, pos)
318 if (strcmp(trace_probe_name(&tk->tp), event) == 0 &&
319 strcmp(trace_probe_group_name(&tk->tp), group) == 0)
324 static inline int __enable_trace_kprobe(struct trace_kprobe *tk)
328 if (trace_kprobe_is_registered(tk) && !trace_kprobe_has_gone(tk)) {
329 if (trace_kprobe_is_return(tk))
330 ret = enable_kretprobe(&tk->rp);
332 ret = enable_kprobe(&tk->rp.kp);
338 static void __disable_trace_kprobe(struct trace_probe *tp)
340 struct trace_kprobe *tk;
342 list_for_each_entry(tk, trace_probe_probe_list(tp), tp.list) {
343 if (!trace_kprobe_is_registered(tk))
345 if (trace_kprobe_is_return(tk))
346 disable_kretprobe(&tk->rp);
348 disable_kprobe(&tk->rp.kp);
354 * if the file is NULL, enable "perf" handler, or enable "trace" handler.
356 static int enable_trace_kprobe(struct trace_event_call *call,
357 struct trace_event_file *file)
359 struct trace_probe *tp;
360 struct trace_kprobe *tk;
364 tp = trace_probe_primary_from_call(call);
365 if (WARN_ON_ONCE(!tp))
367 enabled = trace_probe_is_enabled(tp);
369 /* This also changes "enabled" state */
371 ret = trace_probe_add_file(tp, file);
375 trace_probe_set_flag(tp, TP_FLAG_PROFILE);
380 list_for_each_entry(tk, trace_probe_probe_list(tp), tp.list) {
381 if (trace_kprobe_has_gone(tk))
383 ret = __enable_trace_kprobe(tk);
390 /* Failed to enable one of them. Roll back all */
392 __disable_trace_kprobe(tp);
394 trace_probe_remove_file(tp, file);
396 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
403 * Disable trace_probe
404 * if the file is NULL, disable "perf" handler, or disable "trace" handler.
406 static int disable_trace_kprobe(struct trace_event_call *call,
407 struct trace_event_file *file)
409 struct trace_probe *tp;
411 tp = trace_probe_primary_from_call(call);
412 if (WARN_ON_ONCE(!tp))
416 if (!trace_probe_get_file_link(tp, file))
418 if (!trace_probe_has_single_file(tp))
420 trace_probe_clear_flag(tp, TP_FLAG_TRACE);
422 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
424 if (!trace_probe_is_enabled(tp))
425 __disable_trace_kprobe(tp);
430 * Synchronization is done in below function. For perf event,
431 * file == NULL and perf_trace_event_unreg() calls
432 * tracepoint_synchronize_unregister() to ensure synchronize
433 * event. We don't need to care about it.
435 trace_probe_remove_file(tp, file);
440 #if defined(CONFIG_DYNAMIC_FTRACE) && \
441 !defined(CONFIG_KPROBE_EVENTS_ON_NOTRACE)
442 static bool __within_notrace_func(unsigned long addr)
444 unsigned long offset, size;
446 if (!addr || !kallsyms_lookup_size_offset(addr, &size, &offset))
449 /* Get the entry address of the target function */
453 * Since ftrace_location_range() does inclusive range check, we need
454 * to subtract 1 byte from the end address.
456 return !ftrace_location_range(addr, addr + size - 1);
459 static bool within_notrace_func(struct trace_kprobe *tk)
461 unsigned long addr = trace_kprobe_address(tk);
462 char symname[KSYM_NAME_LEN], *p;
464 if (!__within_notrace_func(addr))
467 /* Check if the address is on a suffixed-symbol */
468 if (!lookup_symbol_name(addr, symname)) {
469 p = strchr(symname, '.');
473 addr = (unsigned long)kprobe_lookup_name(symname, 0);
475 return __within_notrace_func(addr);
481 #define within_notrace_func(tk) (false)
484 /* Internal register function - just handle k*probes and flags */
485 static int __register_trace_kprobe(struct trace_kprobe *tk)
489 ret = security_locked_down(LOCKDOWN_KPROBES);
493 if (trace_kprobe_is_registered(tk))
496 if (within_notrace_func(tk)) {
497 pr_warn("Could not probe notrace function %ps\n",
498 (void *)trace_kprobe_address(tk));
502 for (i = 0; i < tk->tp.nr_args; i++) {
503 ret = traceprobe_update_arg(&tk->tp.args[i]);
508 /* Set/clear disabled flag according to tp->flag */
509 if (trace_probe_is_enabled(&tk->tp))
510 tk->rp.kp.flags &= ~KPROBE_FLAG_DISABLED;
512 tk->rp.kp.flags |= KPROBE_FLAG_DISABLED;
514 if (trace_kprobe_is_return(tk))
515 ret = register_kretprobe(&tk->rp);
517 ret = register_kprobe(&tk->rp.kp);
522 /* Internal unregister function - just handle k*probes and flags */
523 static void __unregister_trace_kprobe(struct trace_kprobe *tk)
525 if (trace_kprobe_is_registered(tk)) {
526 if (trace_kprobe_is_return(tk))
527 unregister_kretprobe(&tk->rp);
529 unregister_kprobe(&tk->rp.kp);
530 /* Cleanup kprobe for reuse and mark it unregistered */
531 INIT_HLIST_NODE(&tk->rp.kp.hlist);
532 INIT_LIST_HEAD(&tk->rp.kp.list);
533 if (tk->rp.kp.symbol_name)
534 tk->rp.kp.addr = NULL;
538 /* Unregister a trace_probe and probe_event */
539 static int unregister_trace_kprobe(struct trace_kprobe *tk)
541 /* If other probes are on the event, just unregister kprobe */
542 if (trace_probe_has_sibling(&tk->tp))
545 /* Enabled event can not be unregistered */
546 if (trace_probe_is_enabled(&tk->tp))
549 /* If there's a reference to the dynamic event */
550 if (trace_event_dyn_busy(trace_probe_event_call(&tk->tp)))
553 /* Will fail if probe is being used by ftrace or perf */
554 if (unregister_kprobe_event(tk))
558 __unregister_trace_kprobe(tk);
559 dyn_event_remove(&tk->devent);
560 trace_probe_unlink(&tk->tp);
565 static bool trace_kprobe_has_same_kprobe(struct trace_kprobe *orig,
566 struct trace_kprobe *comp)
568 struct trace_probe_event *tpe = orig->tp.event;
571 list_for_each_entry(orig, &tpe->probes, tp.list) {
572 if (strcmp(trace_kprobe_symbol(orig),
573 trace_kprobe_symbol(comp)) ||
574 trace_kprobe_offset(orig) != trace_kprobe_offset(comp))
578 * trace_probe_compare_arg_type() ensured that nr_args and
579 * each argument name and type are same. Let's compare comm.
581 for (i = 0; i < orig->tp.nr_args; i++) {
582 if (strcmp(orig->tp.args[i].comm,
583 comp->tp.args[i].comm))
587 if (i == orig->tp.nr_args)
594 static int append_trace_kprobe(struct trace_kprobe *tk, struct trace_kprobe *to)
598 ret = trace_probe_compare_arg_type(&tk->tp, &to->tp);
600 /* Note that argument starts index = 2 */
601 trace_probe_log_set_index(ret + 1);
602 trace_probe_log_err(0, DIFF_ARG_TYPE);
605 if (trace_kprobe_has_same_kprobe(to, tk)) {
606 trace_probe_log_set_index(0);
607 trace_probe_log_err(0, SAME_PROBE);
611 /* Append to existing event */
612 ret = trace_probe_append(&tk->tp, &to->tp);
616 /* Register k*probe */
617 ret = __register_trace_kprobe(tk);
618 if (ret == -ENOENT && !trace_kprobe_module_exist(tk)) {
619 pr_warn("This probe might be able to register after target module is loaded. Continue.\n");
624 trace_probe_unlink(&tk->tp);
626 dyn_event_add(&tk->devent, trace_probe_event_call(&tk->tp));
631 /* Register a trace_probe and probe_event */
632 static int register_trace_kprobe(struct trace_kprobe *tk)
634 struct trace_kprobe *old_tk;
637 guard(mutex)(&event_mutex);
639 old_tk = find_trace_kprobe(trace_probe_name(&tk->tp),
640 trace_probe_group_name(&tk->tp));
642 if (trace_kprobe_is_return(tk) != trace_kprobe_is_return(old_tk)) {
643 trace_probe_log_set_index(0);
644 trace_probe_log_err(0, DIFF_PROBE_TYPE);
647 return append_trace_kprobe(tk, old_tk);
650 /* Register new event */
651 ret = register_kprobe_event(tk);
653 if (ret == -EEXIST) {
654 trace_probe_log_set_index(0);
655 trace_probe_log_err(0, EVENT_EXIST);
657 pr_warn("Failed to register probe event(%d)\n", ret);
661 /* Register k*probe */
662 ret = __register_trace_kprobe(tk);
663 if (ret == -ENOENT && !trace_kprobe_module_exist(tk)) {
664 pr_warn("This probe might be able to register after target module is loaded. Continue.\n");
669 unregister_kprobe_event(tk);
671 dyn_event_add(&tk->devent, trace_probe_event_call(&tk->tp));
676 #ifdef CONFIG_MODULES
677 static int validate_module_probe_symbol(const char *modname, const char *symbol);
679 static int register_module_trace_kprobe(struct module *mod, struct trace_kprobe *tk)
684 p = strchr(trace_kprobe_symbol(tk), ':');
686 ret = validate_module_probe_symbol(module_name(mod), p + 1);
688 ret = __register_trace_kprobe(tk);
692 /* Module notifier call back, checking event on the module */
693 static int trace_kprobe_module_callback(struct notifier_block *nb,
694 unsigned long val, void *data)
696 struct module *mod = data;
697 struct dyn_event *pos;
698 struct trace_kprobe *tk;
701 if (val != MODULE_STATE_COMING)
704 /* Update probes on coming module */
705 guard(mutex)(&event_mutex);
706 for_each_trace_kprobe(tk, pos) {
707 if (trace_kprobe_within_module(tk, mod)) {
708 /* Don't need to check busy - this should have gone. */
709 __unregister_trace_kprobe(tk);
710 ret = register_module_trace_kprobe(mod, tk);
712 pr_warn("Failed to re-register probe %s on %s: %d\n",
713 trace_probe_name(&tk->tp),
714 module_name(mod), ret);
721 static struct notifier_block trace_kprobe_module_nb = {
722 .notifier_call = trace_kprobe_module_callback,
723 .priority = 2 /* Invoked after kprobe and jump_label module callback */
725 static int trace_kprobe_register_module_notifier(void)
727 return register_module_notifier(&trace_kprobe_module_nb);
730 static int trace_kprobe_register_module_notifier(void)
734 #endif /* CONFIG_MODULES */
736 static int count_symbols(void *data, unsigned long unused)
738 unsigned int *count = data;
745 struct sym_count_ctx {
750 static int count_mod_symbols(void *data, const char *name, unsigned long unused)
752 struct sym_count_ctx *ctx = data;
754 if (strcmp(name, ctx->name) == 0)
760 static unsigned int number_of_same_symbols(const char *mod, const char *func_name)
762 struct sym_count_ctx ctx = { .count = 0, .name = func_name };
765 kallsyms_on_each_match_symbol(count_symbols, func_name, &ctx.count);
767 module_kallsyms_on_each_symbol(mod, count_mod_symbols, &ctx);
772 static int validate_module_probe_symbol(const char *modname, const char *symbol)
774 unsigned int count = number_of_same_symbols(modname, symbol);
778 * Users should use ADDR to remove the ambiguity of
781 return -EADDRNOTAVAIL;
782 } else if (count == 0) {
784 * We can return ENOENT earlier than when register the
792 #ifdef CONFIG_MODULES
793 /* Return NULL if the module is not loaded or under unloading. */
794 static struct module *try_module_get_by_name(const char *name)
799 mod = find_module(name);
800 if (mod && !try_module_get(mod))
805 #define try_module_get_by_name(name) (NULL)
808 static int validate_probe_symbol(char *symbol)
810 struct module *mod = NULL;
811 char *modname = NULL, *p;
814 p = strchr(symbol, ':');
819 mod = try_module_get_by_name(modname);
824 ret = validate_module_probe_symbol(modname, symbol);
833 static int trace_kprobe_entry_handler(struct kretprobe_instance *ri,
834 struct pt_regs *regs);
836 static int trace_kprobe_create_internal(int argc, const char *argv[],
837 struct traceprobe_parse_context *ctx)
842 * p[:[GRP/][EVENT]] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS]
844 * r[MAXACTIVE][:[GRP/][EVENT]] [MOD:]KSYM[+0] [FETCHARGS]
846 * p[:[GRP/][EVENT]] [MOD:]KSYM[+0]%return [FETCHARGS]
849 * $retval : fetch return value
850 * $stack : fetch stack address
851 * $stackN : fetch Nth of stack (N:0-)
852 * $comm : fetch current task comm
853 * @ADDR : fetch memory at ADDR (ADDR should be in kernel)
854 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol)
855 * %REG : fetch register REG
856 * Dereferencing memory fetch:
857 * +|-offs(ARG) : fetch memory at ARG +|- offs address.
858 * Alias name of args:
859 * NAME=FETCHARG : set NAME as alias of FETCHARG.
861 * FETCHARG:TYPE : use TYPE instead of unsigned long.
863 struct trace_kprobe *tk __free(free_trace_kprobe) = NULL;
864 const char *event = NULL, *group = KPROBE_EVENT_SYSTEM;
865 const char **new_argv __free(kfree) = NULL;
866 int i, len, new_argc = 0, ret = 0;
867 char *symbol __free(kfree) = NULL;
868 char *ebuf __free(kfree) = NULL;
869 char *gbuf __free(kfree) = NULL;
870 char *abuf __free(kfree) = NULL;
871 char *dbuf __free(kfree) = NULL;
872 enum probe_print_type ptype;
873 bool is_return = false;
879 switch (argv[0][0]) {
891 event = strchr(&argv[0][1], ':');
895 if (isdigit(argv[0][1])) {
896 char *buf __free(kfree) = NULL;
899 trace_probe_log_err(1, BAD_MAXACT_TYPE);
903 len = event - &argv[0][1] - 1;
905 len = strlen(&argv[0][1]);
906 if (len > MAX_EVENT_NAME_LEN - 1) {
907 trace_probe_log_err(1, BAD_MAXACT);
910 buf = kmemdup(&argv[0][1], len + 1, GFP_KERNEL);
912 ret = kstrtouint(buf, 0, &maxactive);
913 if (ret || !maxactive) {
914 trace_probe_log_err(1, BAD_MAXACT);
917 /* kretprobes instances are iterated over via a list. The
918 * maximum should stay reasonable.
920 if (maxactive > KRETPROBE_MAXACTIVE_MAX) {
921 trace_probe_log_err(1, MAXACT_TOO_BIG);
926 /* try to parse an address. if that fails, try to read the
927 * input as a symbol. */
928 if (kstrtoul(argv[1], 0, (unsigned long *)&addr)) {
929 trace_probe_log_set_index(1);
930 /* Check whether uprobe event specified */
931 if (strchr(argv[1], '/') && strchr(argv[1], ':'))
934 /* a symbol specified */
935 symbol = kstrdup(argv[1], GFP_KERNEL);
939 tmp = strchr(symbol, '%');
941 if (!strcmp(tmp, "%return")) {
945 trace_probe_log_err(tmp - symbol, BAD_ADDR_SUFFIX);
950 /* TODO: support .init module functions */
951 ret = traceprobe_split_symbol_offset(symbol, &offset);
952 if (ret || offset < 0 || offset > UINT_MAX) {
953 trace_probe_log_err(0, BAD_PROBE_ADDR);
956 ret = validate_probe_symbol(symbol);
958 if (ret == -EADDRNOTAVAIL)
959 trace_probe_log_err(0, NON_UNIQ_SYMBOL);
961 trace_probe_log_err(0, BAD_PROBE_ADDR);
965 ctx->flags |= TPARG_FL_RETURN;
966 ret = kprobe_on_func_entry(NULL, symbol, offset);
967 if (ret == 0 && !is_return)
968 ctx->flags |= TPARG_FL_FENTRY;
969 /* Defer the ENOENT case until register kprobe */
970 if (ret == -EINVAL && is_return) {
971 trace_probe_log_err(0, BAD_RETPROBE);
976 trace_probe_log_set_index(0);
978 gbuf = kmalloc(MAX_EVENT_NAME_LEN, GFP_KERNEL);
981 ret = traceprobe_parse_event_name(&event, &group, gbuf,
988 /* Make a new event name */
989 ebuf = kmalloc(MAX_EVENT_NAME_LEN, GFP_KERNEL);
993 snprintf(ebuf, MAX_EVENT_NAME_LEN, "%c_%s_%ld",
994 is_return ? 'r' : 'p', symbol, offset);
996 snprintf(ebuf, MAX_EVENT_NAME_LEN, "%c_0x%p",
997 is_return ? 'r' : 'p', addr);
998 sanitize_event_name(ebuf);
1002 abuf = kmalloc(MAX_BTF_ARGS_LEN, GFP_KERNEL);
1005 argc -= 2; argv += 2;
1006 ctx->funcname = symbol;
1007 new_argv = traceprobe_expand_meta_args(argc, argv, &new_argc,
1008 abuf, MAX_BTF_ARGS_LEN, ctx);
1009 if (IS_ERR(new_argv)) {
1010 ret = PTR_ERR(new_argv);
1018 if (argc > MAX_TRACE_ARGS) {
1019 trace_probe_log_set_index(2);
1020 trace_probe_log_err(0, TOO_MANY_ARGS);
1024 ret = traceprobe_expand_dentry_args(argc, argv, &dbuf);
1029 tk = alloc_trace_kprobe(group, event, addr, symbol, offset, maxactive,
1033 /* This must return -ENOMEM, else there is a bug */
1034 WARN_ON_ONCE(ret != -ENOMEM);
1035 return ret; /* We know tk is not allocated */
1038 /* parse arguments */
1039 for (i = 0; i < argc; i++) {
1040 trace_probe_log_set_index(i + 2);
1042 ret = traceprobe_parse_probe_arg(&tk->tp, i, argv[i], ctx);
1044 return ret; /* This can be -ENOMEM */
1046 /* entry handler for kretprobe */
1047 if (is_return && tk->tp.entry_arg) {
1048 tk->rp.entry_handler = trace_kprobe_entry_handler;
1049 tk->rp.data_size = traceprobe_get_entry_data_size(&tk->tp);
1052 ptype = is_return ? PROBE_PRINT_RETURN : PROBE_PRINT_NORMAL;
1053 ret = traceprobe_set_print_fmt(&tk->tp, ptype);
1057 ret = register_trace_kprobe(tk);
1059 trace_probe_log_set_index(1);
1061 trace_probe_log_err(0, BAD_INSN_BNDRY);
1062 else if (ret == -ENOENT)
1063 trace_probe_log_err(0, BAD_PROBE_ADDR);
1064 else if (ret != -ENOMEM && ret != -EEXIST)
1065 trace_probe_log_err(0, FAIL_REG_PROBE);
1069 * Here, 'tk' has been registered to the list successfully,
1070 * so we don't need to free it.
1077 static int trace_kprobe_create_cb(int argc, const char *argv[])
1079 struct traceprobe_parse_context *ctx __free(traceprobe_parse_context) = NULL;
1082 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
1085 ctx->flags = TPARG_FL_KERNEL;
1087 trace_probe_log_init("trace_kprobe", argc, argv);
1089 ret = trace_kprobe_create_internal(argc, argv, ctx);
1091 trace_probe_log_clear();
1095 static int trace_kprobe_create(const char *raw_command)
1097 return trace_probe_create(raw_command, trace_kprobe_create_cb);
1100 static int create_or_delete_trace_kprobe(const char *raw_command)
1104 if (raw_command[0] == '-')
1105 return dyn_event_release(raw_command, &trace_kprobe_ops);
1107 ret = dyn_event_create(raw_command, &trace_kprobe_ops);
1108 return ret == -ECANCELED ? -EINVAL : ret;
1111 static int trace_kprobe_run_command(struct dynevent_cmd *cmd)
1113 return create_or_delete_trace_kprobe(cmd->seq.buffer);
1117 * kprobe_event_cmd_init - Initialize a kprobe event command object
1118 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1119 * @buf: A pointer to the buffer used to build the command
1120 * @maxlen: The length of the buffer passed in @buf
1122 * Initialize a synthetic event command object. Use this before
1123 * calling any of the other kprobe_event functions.
1125 void kprobe_event_cmd_init(struct dynevent_cmd *cmd, char *buf, int maxlen)
1127 dynevent_cmd_init(cmd, buf, maxlen, DYNEVENT_TYPE_KPROBE,
1128 trace_kprobe_run_command);
1130 EXPORT_SYMBOL_GPL(kprobe_event_cmd_init);
1133 * __kprobe_event_gen_cmd_start - Generate a kprobe event command from arg list
1134 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1135 * @kretprobe: Is this a return probe?
1136 * @name: The name of the kprobe event
1137 * @loc: The location of the kprobe event
1138 * @...: Variable number of arg (pairs), one pair for each field
1140 * NOTE: Users normally won't want to call this function directly, but
1141 * rather use the kprobe_event_gen_cmd_start() wrapper, which automatically
1142 * adds a NULL to the end of the arg list. If this function is used
1143 * directly, make sure the last arg in the variable arg list is NULL.
1145 * Generate a kprobe event command to be executed by
1146 * kprobe_event_gen_cmd_end(). This function can be used to generate the
1147 * complete command or only the first part of it; in the latter case,
1148 * kprobe_event_add_fields() can be used to add more fields following this.
1150 * Unlikely the synth_event_gen_cmd_start(), @loc must be specified. This
1151 * returns -EINVAL if @loc == NULL.
1153 * Return: 0 if successful, error otherwise.
1155 int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd, bool kretprobe,
1156 const char *name, const char *loc, ...)
1158 char buf[MAX_EVENT_NAME_LEN];
1159 struct dynevent_arg arg;
1163 if (cmd->type != DYNEVENT_TYPE_KPROBE)
1170 snprintf(buf, MAX_EVENT_NAME_LEN, "r:kprobes/%s", name);
1172 snprintf(buf, MAX_EVENT_NAME_LEN, "p:kprobes/%s", name);
1174 ret = dynevent_str_add(cmd, buf);
1178 dynevent_arg_init(&arg, 0);
1180 ret = dynevent_arg_add(cmd, &arg, NULL);
1184 va_start(args, loc);
1188 field = va_arg(args, const char *);
1192 if (++cmd->n_fields > MAX_TRACE_ARGS) {
1198 ret = dynevent_arg_add(cmd, &arg, NULL);
1206 EXPORT_SYMBOL_GPL(__kprobe_event_gen_cmd_start);
1209 * __kprobe_event_add_fields - Add probe fields to a kprobe command from arg list
1210 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1211 * @...: Variable number of arg (pairs), one pair for each field
1213 * NOTE: Users normally won't want to call this function directly, but
1214 * rather use the kprobe_event_add_fields() wrapper, which
1215 * automatically adds a NULL to the end of the arg list. If this
1216 * function is used directly, make sure the last arg in the variable
1219 * Add probe fields to an existing kprobe command using a variable
1220 * list of args. Fields are added in the same order they're listed.
1222 * Return: 0 if successful, error otherwise.
1224 int __kprobe_event_add_fields(struct dynevent_cmd *cmd, ...)
1226 struct dynevent_arg arg;
1230 if (cmd->type != DYNEVENT_TYPE_KPROBE)
1233 dynevent_arg_init(&arg, 0);
1235 va_start(args, cmd);
1239 field = va_arg(args, const char *);
1243 if (++cmd->n_fields > MAX_TRACE_ARGS) {
1249 ret = dynevent_arg_add(cmd, &arg, NULL);
1257 EXPORT_SYMBOL_GPL(__kprobe_event_add_fields);
1260 * kprobe_event_delete - Delete a kprobe event
1261 * @name: The name of the kprobe event to delete
1263 * Delete a kprobe event with the give @name from kernel code rather
1264 * than directly from the command line.
1266 * Return: 0 if successful, error otherwise.
1268 int kprobe_event_delete(const char *name)
1270 char buf[MAX_EVENT_NAME_LEN];
1272 snprintf(buf, MAX_EVENT_NAME_LEN, "-:%s", name);
1274 return create_or_delete_trace_kprobe(buf);
1276 EXPORT_SYMBOL_GPL(kprobe_event_delete);
1278 static int trace_kprobe_release(struct dyn_event *ev)
1280 struct trace_kprobe *tk = to_trace_kprobe(ev);
1281 int ret = unregister_trace_kprobe(tk);
1284 free_trace_kprobe(tk);
1288 static int trace_kprobe_show(struct seq_file *m, struct dyn_event *ev)
1290 struct trace_kprobe *tk = to_trace_kprobe(ev);
1293 seq_putc(m, trace_kprobe_is_return(tk) ? 'r' : 'p');
1294 if (trace_kprobe_is_return(tk) && tk->rp.maxactive)
1295 seq_printf(m, "%d", tk->rp.maxactive);
1296 seq_printf(m, ":%s/%s", trace_probe_group_name(&tk->tp),
1297 trace_probe_name(&tk->tp));
1300 seq_printf(m, " 0x%p", tk->rp.kp.addr);
1301 else if (tk->rp.kp.offset)
1302 seq_printf(m, " %s+%u", trace_kprobe_symbol(tk),
1305 seq_printf(m, " %s", trace_kprobe_symbol(tk));
1307 for (i = 0; i < tk->tp.nr_args; i++)
1308 seq_printf(m, " %s=%s", tk->tp.args[i].name, tk->tp.args[i].comm);
1314 static int probes_seq_show(struct seq_file *m, void *v)
1316 struct dyn_event *ev = v;
1318 if (!is_trace_kprobe(ev))
1321 return trace_kprobe_show(m, ev);
1324 static const struct seq_operations probes_seq_op = {
1325 .start = dyn_event_seq_start,
1326 .next = dyn_event_seq_next,
1327 .stop = dyn_event_seq_stop,
1328 .show = probes_seq_show
1331 static int probes_open(struct inode *inode, struct file *file)
1335 ret = security_locked_down(LOCKDOWN_TRACEFS);
1339 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
1340 ret = dyn_events_release_all(&trace_kprobe_ops);
1345 return seq_open(file, &probes_seq_op);
1348 static ssize_t probes_write(struct file *file, const char __user *buffer,
1349 size_t count, loff_t *ppos)
1351 return trace_parse_run_command(file, buffer, count, ppos,
1352 create_or_delete_trace_kprobe);
1355 static const struct file_operations kprobe_events_ops = {
1356 .owner = THIS_MODULE,
1357 .open = probes_open,
1359 .llseek = seq_lseek,
1360 .release = seq_release,
1361 .write = probes_write,
1364 static unsigned long trace_kprobe_missed(struct trace_kprobe *tk)
1366 return trace_kprobe_is_return(tk) ?
1367 tk->rp.kp.nmissed + tk->rp.nmissed : tk->rp.kp.nmissed;
1370 /* Probes profiling interfaces */
1371 static int probes_profile_seq_show(struct seq_file *m, void *v)
1373 struct dyn_event *ev = v;
1374 struct trace_kprobe *tk;
1375 unsigned long nmissed;
1377 if (!is_trace_kprobe(ev))
1380 tk = to_trace_kprobe(ev);
1381 nmissed = trace_kprobe_missed(tk);
1382 seq_printf(m, " %-44s %15lu %15lu\n",
1383 trace_probe_name(&tk->tp),
1384 trace_kprobe_nhit(tk),
1390 static const struct seq_operations profile_seq_op = {
1391 .start = dyn_event_seq_start,
1392 .next = dyn_event_seq_next,
1393 .stop = dyn_event_seq_stop,
1394 .show = probes_profile_seq_show
1397 static int profile_open(struct inode *inode, struct file *file)
1401 ret = security_locked_down(LOCKDOWN_TRACEFS);
1405 return seq_open(file, &profile_seq_op);
1408 static const struct file_operations kprobe_profile_ops = {
1409 .owner = THIS_MODULE,
1410 .open = profile_open,
1412 .llseek = seq_lseek,
1413 .release = seq_release,
1416 /* Note that we don't verify it, since the code does not come from user space */
1418 process_fetch_insn(struct fetch_insn *code, void *rec, void *edata,
1419 void *dest, void *base)
1421 struct pt_regs *regs = rec;
1426 /* 1st stage: get value from context */
1429 val = regs_get_register(regs, code->param);
1431 case FETCH_OP_STACK:
1432 val = regs_get_kernel_stack_nth(regs, code->param);
1434 case FETCH_OP_STACKP:
1435 val = kernel_stack_pointer(regs);
1437 case FETCH_OP_RETVAL:
1438 val = regs_return_value(regs);
1440 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
1442 val = regs_get_kernel_argument(regs, code->param);
1444 case FETCH_OP_EDATA:
1445 val = *(unsigned long *)((unsigned long)edata + code->offset);
1448 case FETCH_NOP_SYMBOL: /* Ignore a place holder */
1452 ret = process_common_fetch_insn(code, &val);
1458 return process_fetch_insn_bottom(code, val, dest, base);
1460 NOKPROBE_SYMBOL(process_fetch_insn)
1462 /* Kprobe handler */
1463 static nokprobe_inline void
1464 __kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs,
1465 struct trace_event_file *trace_file)
1467 struct kprobe_trace_entry_head *entry;
1468 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1469 struct trace_event_buffer fbuffer;
1472 WARN_ON(call != trace_file->event_call);
1474 if (trace_trigger_soft_disabled(trace_file))
1477 dsize = __get_data_size(&tk->tp, regs, NULL);
1479 entry = trace_event_buffer_reserve(&fbuffer, trace_file,
1480 sizeof(*entry) + tk->tp.size + dsize);
1484 fbuffer.regs = regs;
1485 entry->ip = (unsigned long)tk->rp.kp.addr;
1486 store_trace_args(&entry[1], &tk->tp, regs, NULL, sizeof(*entry), dsize);
1488 trace_event_buffer_commit(&fbuffer);
1492 kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs)
1494 struct event_file_link *link;
1496 trace_probe_for_each_link_rcu(link, &tk->tp)
1497 __kprobe_trace_func(tk, regs, link->file);
1499 NOKPROBE_SYMBOL(kprobe_trace_func);
1501 /* Kretprobe handler */
1503 static int trace_kprobe_entry_handler(struct kretprobe_instance *ri,
1504 struct pt_regs *regs)
1506 struct kretprobe *rp = get_kretprobe(ri);
1507 struct trace_kprobe *tk;
1510 * There is a small chance that get_kretprobe(ri) returns NULL when
1511 * the kretprobe is unregister on another CPU between kretprobe's
1512 * trampoline_handler and this function.
1517 tk = container_of(rp, struct trace_kprobe, rp);
1519 /* store argument values into ri->data as entry data */
1520 if (tk->tp.entry_arg)
1521 store_trace_entry_data(ri->data, &tk->tp, regs);
1527 static nokprobe_inline void
1528 __kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1529 struct pt_regs *regs,
1530 struct trace_event_file *trace_file)
1532 struct kretprobe_trace_entry_head *entry;
1533 struct trace_event_buffer fbuffer;
1534 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1537 WARN_ON(call != trace_file->event_call);
1539 if (trace_trigger_soft_disabled(trace_file))
1542 dsize = __get_data_size(&tk->tp, regs, ri->data);
1544 entry = trace_event_buffer_reserve(&fbuffer, trace_file,
1545 sizeof(*entry) + tk->tp.size + dsize);
1549 fbuffer.regs = regs;
1550 entry->func = (unsigned long)tk->rp.kp.addr;
1551 entry->ret_ip = get_kretprobe_retaddr(ri);
1552 store_trace_args(&entry[1], &tk->tp, regs, ri->data, sizeof(*entry), dsize);
1554 trace_event_buffer_commit(&fbuffer);
1558 kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1559 struct pt_regs *regs)
1561 struct event_file_link *link;
1563 trace_probe_for_each_link_rcu(link, &tk->tp)
1564 __kretprobe_trace_func(tk, ri, regs, link->file);
1566 NOKPROBE_SYMBOL(kretprobe_trace_func);
1568 /* Event entry printers */
1569 static enum print_line_t
1570 print_kprobe_event(struct trace_iterator *iter, int flags,
1571 struct trace_event *event)
1573 struct kprobe_trace_entry_head *field;
1574 struct trace_seq *s = &iter->seq;
1575 struct trace_probe *tp;
1577 field = (struct kprobe_trace_entry_head *)iter->ent;
1578 tp = trace_probe_primary_from_call(
1579 container_of(event, struct trace_event_call, event));
1580 if (WARN_ON_ONCE(!tp))
1583 trace_seq_printf(s, "%s: (", trace_probe_name(tp));
1585 if (!seq_print_ip_sym(s, field->ip, flags | TRACE_ITER_SYM_OFFSET))
1588 trace_seq_putc(s, ')');
1590 if (trace_probe_print_args(s, tp->args, tp->nr_args,
1591 (u8 *)&field[1], field) < 0)
1594 trace_seq_putc(s, '\n');
1596 return trace_handle_return(s);
1599 static enum print_line_t
1600 print_kretprobe_event(struct trace_iterator *iter, int flags,
1601 struct trace_event *event)
1603 struct kretprobe_trace_entry_head *field;
1604 struct trace_seq *s = &iter->seq;
1605 struct trace_probe *tp;
1607 field = (struct kretprobe_trace_entry_head *)iter->ent;
1608 tp = trace_probe_primary_from_call(
1609 container_of(event, struct trace_event_call, event));
1610 if (WARN_ON_ONCE(!tp))
1613 trace_seq_printf(s, "%s: (", trace_probe_name(tp));
1615 if (!seq_print_ip_sym(s, field->ret_ip, flags | TRACE_ITER_SYM_OFFSET))
1618 trace_seq_puts(s, " <- ");
1620 if (!seq_print_ip_sym(s, field->func, flags & ~TRACE_ITER_SYM_OFFSET))
1623 trace_seq_putc(s, ')');
1625 if (trace_probe_print_args(s, tp->args, tp->nr_args,
1626 (u8 *)&field[1], field) < 0)
1629 trace_seq_putc(s, '\n');
1632 return trace_handle_return(s);
1636 static int kprobe_event_define_fields(struct trace_event_call *event_call)
1639 struct kprobe_trace_entry_head field;
1640 struct trace_probe *tp;
1642 tp = trace_probe_primary_from_call(event_call);
1643 if (WARN_ON_ONCE(!tp))
1646 DEFINE_FIELD(unsigned long, ip, FIELD_STRING_IP, 0);
1648 return traceprobe_define_arg_fields(event_call, sizeof(field), tp);
1651 static int kretprobe_event_define_fields(struct trace_event_call *event_call)
1654 struct kretprobe_trace_entry_head field;
1655 struct trace_probe *tp;
1657 tp = trace_probe_primary_from_call(event_call);
1658 if (WARN_ON_ONCE(!tp))
1661 DEFINE_FIELD(unsigned long, func, FIELD_STRING_FUNC, 0);
1662 DEFINE_FIELD(unsigned long, ret_ip, FIELD_STRING_RETIP, 0);
1664 return traceprobe_define_arg_fields(event_call, sizeof(field), tp);
1667 #ifdef CONFIG_PERF_EVENTS
1669 /* Kprobe profile handler */
1671 kprobe_perf_func(struct trace_kprobe *tk, struct pt_regs *regs)
1673 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1674 struct kprobe_trace_entry_head *entry;
1675 struct hlist_head *head;
1676 int size, __size, dsize;
1679 if (bpf_prog_array_valid(call)) {
1680 unsigned long orig_ip = instruction_pointer(regs);
1683 ret = trace_call_bpf(call, regs);
1686 * We need to check and see if we modified the pc of the
1687 * pt_regs, and if so return 1 so that we don't do the
1690 if (orig_ip != instruction_pointer(regs))
1696 head = this_cpu_ptr(call->perf_events);
1697 if (hlist_empty(head))
1700 dsize = __get_data_size(&tk->tp, regs, NULL);
1701 __size = sizeof(*entry) + tk->tp.size + dsize;
1702 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1703 size -= sizeof(u32);
1705 entry = perf_trace_buf_alloc(size, NULL, &rctx);
1709 entry->ip = (unsigned long)tk->rp.kp.addr;
1710 memset(&entry[1], 0, dsize);
1711 store_trace_args(&entry[1], &tk->tp, regs, NULL, sizeof(*entry), dsize);
1712 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
1716 NOKPROBE_SYMBOL(kprobe_perf_func);
1718 /* Kretprobe profile handler */
1720 kretprobe_perf_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1721 struct pt_regs *regs)
1723 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1724 struct kretprobe_trace_entry_head *entry;
1725 struct hlist_head *head;
1726 int size, __size, dsize;
1729 if (bpf_prog_array_valid(call) && !trace_call_bpf(call, regs))
1732 head = this_cpu_ptr(call->perf_events);
1733 if (hlist_empty(head))
1736 dsize = __get_data_size(&tk->tp, regs, ri->data);
1737 __size = sizeof(*entry) + tk->tp.size + dsize;
1738 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1739 size -= sizeof(u32);
1741 entry = perf_trace_buf_alloc(size, NULL, &rctx);
1745 entry->func = (unsigned long)tk->rp.kp.addr;
1746 entry->ret_ip = get_kretprobe_retaddr(ri);
1747 store_trace_args(&entry[1], &tk->tp, regs, ri->data, sizeof(*entry), dsize);
1748 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
1751 NOKPROBE_SYMBOL(kretprobe_perf_func);
1753 int bpf_get_kprobe_info(const struct perf_event *event, u32 *fd_type,
1754 const char **symbol, u64 *probe_offset,
1755 u64 *probe_addr, unsigned long *missed,
1756 bool perf_type_tracepoint)
1758 const char *pevent = trace_event_name(event->tp_event);
1759 const char *group = event->tp_event->class->system;
1760 struct trace_kprobe *tk;
1762 if (perf_type_tracepoint)
1763 tk = find_trace_kprobe(pevent, group);
1765 tk = trace_kprobe_primary_from_call(event->tp_event);
1769 *fd_type = trace_kprobe_is_return(tk) ? BPF_FD_TYPE_KRETPROBE
1770 : BPF_FD_TYPE_KPROBE;
1771 *probe_offset = tk->rp.kp.offset;
1772 *probe_addr = kallsyms_show_value(current_cred()) ?
1773 (unsigned long)tk->rp.kp.addr : 0;
1774 *symbol = tk->symbol;
1776 *missed = trace_kprobe_missed(tk);
1779 #endif /* CONFIG_PERF_EVENTS */
1782 * called by perf_trace_init() or __ftrace_set_clr_event() under event_mutex.
1784 * kprobe_trace_self_tests_init() does enable_trace_probe/disable_trace_probe
1785 * lockless, but we can't race with this __init function.
1787 static int kprobe_register(struct trace_event_call *event,
1788 enum trace_reg type, void *data)
1790 struct trace_event_file *file = data;
1793 case TRACE_REG_REGISTER:
1794 return enable_trace_kprobe(event, file);
1795 case TRACE_REG_UNREGISTER:
1796 return disable_trace_kprobe(event, file);
1798 #ifdef CONFIG_PERF_EVENTS
1799 case TRACE_REG_PERF_REGISTER:
1800 return enable_trace_kprobe(event, NULL);
1801 case TRACE_REG_PERF_UNREGISTER:
1802 return disable_trace_kprobe(event, NULL);
1803 case TRACE_REG_PERF_OPEN:
1804 case TRACE_REG_PERF_CLOSE:
1805 case TRACE_REG_PERF_ADD:
1806 case TRACE_REG_PERF_DEL:
1813 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs)
1815 struct trace_kprobe *tk = container_of(kp, struct trace_kprobe, rp.kp);
1818 raw_cpu_inc(*tk->nhit);
1820 if (trace_probe_test_flag(&tk->tp, TP_FLAG_TRACE))
1821 kprobe_trace_func(tk, regs);
1822 #ifdef CONFIG_PERF_EVENTS
1823 if (trace_probe_test_flag(&tk->tp, TP_FLAG_PROFILE))
1824 ret = kprobe_perf_func(tk, regs);
1828 NOKPROBE_SYMBOL(kprobe_dispatcher);
1831 kretprobe_dispatcher(struct kretprobe_instance *ri, struct pt_regs *regs)
1833 struct kretprobe *rp = get_kretprobe(ri);
1834 struct trace_kprobe *tk;
1837 * There is a small chance that get_kretprobe(ri) returns NULL when
1838 * the kretprobe is unregister on another CPU between kretprobe's
1839 * trampoline_handler and this function.
1844 tk = container_of(rp, struct trace_kprobe, rp);
1845 raw_cpu_inc(*tk->nhit);
1847 if (trace_probe_test_flag(&tk->tp, TP_FLAG_TRACE))
1848 kretprobe_trace_func(tk, ri, regs);
1849 #ifdef CONFIG_PERF_EVENTS
1850 if (trace_probe_test_flag(&tk->tp, TP_FLAG_PROFILE))
1851 kretprobe_perf_func(tk, ri, regs);
1853 return 0; /* We don't tweak kernel, so just return 0 */
1855 NOKPROBE_SYMBOL(kretprobe_dispatcher);
1857 static struct trace_event_functions kretprobe_funcs = {
1858 .trace = print_kretprobe_event
1861 static struct trace_event_functions kprobe_funcs = {
1862 .trace = print_kprobe_event
1865 static struct trace_event_fields kretprobe_fields_array[] = {
1866 { .type = TRACE_FUNCTION_TYPE,
1867 .define_fields = kretprobe_event_define_fields },
1871 static struct trace_event_fields kprobe_fields_array[] = {
1872 { .type = TRACE_FUNCTION_TYPE,
1873 .define_fields = kprobe_event_define_fields },
1877 static inline void init_trace_event_call(struct trace_kprobe *tk)
1879 struct trace_event_call *call = trace_probe_event_call(&tk->tp);
1881 if (trace_kprobe_is_return(tk)) {
1882 call->event.funcs = &kretprobe_funcs;
1883 call->class->fields_array = kretprobe_fields_array;
1885 call->event.funcs = &kprobe_funcs;
1886 call->class->fields_array = kprobe_fields_array;
1889 call->flags = TRACE_EVENT_FL_KPROBE;
1890 call->class->reg = kprobe_register;
1893 static int register_kprobe_event(struct trace_kprobe *tk)
1895 init_trace_event_call(tk);
1897 return trace_probe_register_event_call(&tk->tp);
1900 static int unregister_kprobe_event(struct trace_kprobe *tk)
1902 return trace_probe_unregister_event_call(&tk->tp);
1905 #ifdef CONFIG_PERF_EVENTS
1907 /* create a trace_kprobe, but don't add it to global lists */
1908 struct trace_event_call *
1909 create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
1912 enum probe_print_type ptype;
1913 struct trace_kprobe *tk __free(free_trace_kprobe) = NULL;
1918 ret = validate_probe_symbol(func);
1920 return ERR_PTR(ret);
1924 * local trace_kprobes are not added to dyn_event, so they are never
1925 * searched in find_trace_kprobe(). Therefore, there is no concern of
1926 * duplicated name here.
1928 event = func ? func : "DUMMY_EVENT";
1930 tk = alloc_trace_kprobe(KPROBE_EVENT_SYSTEM, event, (void *)addr, func,
1931 offs, 0 /* maxactive */, 0 /* nargs */,
1935 pr_info("Failed to allocate trace_probe.(%d)\n",
1937 return ERR_CAST(tk);
1940 init_trace_event_call(tk);
1942 ptype = trace_kprobe_is_return(tk) ?
1943 PROBE_PRINT_RETURN : PROBE_PRINT_NORMAL;
1944 if (traceprobe_set_print_fmt(&tk->tp, ptype) < 0)
1945 return ERR_PTR(-ENOMEM);
1947 ret = __register_trace_kprobe(tk);
1949 return ERR_PTR(ret);
1951 return trace_probe_event_call(&(no_free_ptr(tk)->tp));
1954 void destroy_local_trace_kprobe(struct trace_event_call *event_call)
1956 struct trace_kprobe *tk;
1958 tk = trace_kprobe_primary_from_call(event_call);
1962 if (trace_probe_is_enabled(&tk->tp)) {
1967 __unregister_trace_kprobe(tk);
1969 free_trace_kprobe(tk);
1971 #endif /* CONFIG_PERF_EVENTS */
1973 static __init void enable_boot_kprobe_events(void)
1975 struct trace_array *tr = top_trace_array();
1976 struct trace_event_file *file;
1977 struct trace_kprobe *tk;
1978 struct dyn_event *pos;
1980 guard(mutex)(&event_mutex);
1981 for_each_trace_kprobe(tk, pos) {
1982 list_for_each_entry(file, &tr->events, list)
1983 if (file->event_call == trace_probe_event_call(&tk->tp))
1984 trace_event_enable_disable(file, 1, 0);
1988 static __init void setup_boot_kprobe_events(void)
1990 char *p, *cmd = kprobe_boot_events_buf;
1993 strreplace(kprobe_boot_events_buf, ',', ' ');
1995 while (cmd && *cmd != '\0') {
1996 p = strchr(cmd, ';');
2000 ret = create_or_delete_trace_kprobe(cmd);
2002 pr_warn("Failed to add event(%d): %s\n", ret, cmd);
2007 enable_boot_kprobe_events();
2011 * Register dynevent at core_initcall. This allows kernel to setup kprobe
2012 * events in postcore_initcall without tracefs.
2014 static __init int init_kprobe_trace_early(void)
2018 ret = dyn_event_register(&trace_kprobe_ops);
2022 if (trace_kprobe_register_module_notifier())
2027 core_initcall(init_kprobe_trace_early);
2029 /* Make a tracefs interface for controlling probe points */
2030 static __init int init_kprobe_trace(void)
2034 ret = tracing_init_dentry();
2038 /* Event list interface */
2039 trace_create_file("kprobe_events", TRACE_MODE_WRITE,
2040 NULL, NULL, &kprobe_events_ops);
2042 /* Profile interface */
2043 trace_create_file("kprobe_profile", TRACE_MODE_READ,
2044 NULL, NULL, &kprobe_profile_ops);
2046 setup_boot_kprobe_events();
2050 fs_initcall(init_kprobe_trace);
2053 #ifdef CONFIG_FTRACE_STARTUP_TEST
2054 static __init struct trace_event_file *
2055 find_trace_probe_file(struct trace_kprobe *tk, struct trace_array *tr)
2057 struct trace_event_file *file;
2059 list_for_each_entry(file, &tr->events, list)
2060 if (file->event_call == trace_probe_event_call(&tk->tp))
2067 * Nobody but us can call enable_trace_kprobe/disable_trace_kprobe at this
2068 * stage, we can do this lockless.
2070 static __init int kprobe_trace_self_tests_init(void)
2073 int (*target)(int, int, int, int, int, int);
2074 struct trace_kprobe *tk;
2075 struct trace_event_file *file;
2077 if (tracing_is_disabled())
2080 if (tracing_selftest_disabled)
2083 target = kprobe_trace_selftest_target;
2085 pr_info("Testing kprobe tracing: ");
2087 ret = create_or_delete_trace_kprobe("p:testprobe kprobe_trace_selftest_target $stack $stack0 +0($stack)");
2088 if (WARN_ONCE(ret, "error on probing function entry.")) {
2091 /* Enable trace point */
2092 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
2093 if (WARN_ONCE(tk == NULL, "error on probing function entry.")) {
2096 file = find_trace_probe_file(tk, top_trace_array());
2097 if (WARN_ONCE(file == NULL, "error on getting probe file.")) {
2100 enable_trace_kprobe(
2101 trace_probe_event_call(&tk->tp), file);
2105 ret = create_or_delete_trace_kprobe("r:testprobe2 kprobe_trace_selftest_target $retval");
2106 if (WARN_ONCE(ret, "error on probing function return.")) {
2109 /* Enable trace point */
2110 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
2111 if (WARN_ONCE(tk == NULL, "error on getting 2nd new probe.")) {
2114 file = find_trace_probe_file(tk, top_trace_array());
2115 if (WARN_ONCE(file == NULL, "error on getting probe file.")) {
2118 enable_trace_kprobe(
2119 trace_probe_event_call(&tk->tp), file);
2126 ret = target(1, 2, 3, 4, 5, 6);
2129 * Not expecting an error here, the check is only to prevent the
2130 * optimizer from removing the call to target() as otherwise there
2131 * are no side-effects and the call is never performed.
2136 /* Disable trace points before removing it */
2137 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
2138 if (WARN_ONCE(tk == NULL, "error on getting test probe.")) {
2141 if (WARN_ONCE(trace_kprobe_nhit(tk) != 1,
2142 "incorrect number of testprobe hits."))
2145 file = find_trace_probe_file(tk, top_trace_array());
2146 if (WARN_ONCE(file == NULL, "error on getting probe file.")) {
2149 disable_trace_kprobe(
2150 trace_probe_event_call(&tk->tp), file);
2153 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
2154 if (WARN_ONCE(tk == NULL, "error on getting 2nd test probe.")) {
2157 if (WARN_ONCE(trace_kprobe_nhit(tk) != 1,
2158 "incorrect number of testprobe2 hits."))
2161 file = find_trace_probe_file(tk, top_trace_array());
2162 if (WARN_ONCE(file == NULL, "error on getting probe file.")) {
2165 disable_trace_kprobe(
2166 trace_probe_event_call(&tk->tp), file);
2169 ret = create_or_delete_trace_kprobe("-:testprobe");
2170 if (WARN_ONCE(ret, "error on deleting a probe."))
2173 ret = create_or_delete_trace_kprobe("-:testprobe2");
2174 if (WARN_ONCE(ret, "error on deleting a probe."))
2180 * Wait for the optimizer work to finish. Otherwise it might fiddle
2181 * with probes in already freed __init text.
2183 wait_for_kprobe_optimizer();
2185 pr_cont("NG: Some tests are failed. Please check them.\n");
2191 late_initcall(kprobe_trace_self_tests_init);