2 * Kprobes-based tracing events
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/module.h>
21 #include <linux/uaccess.h>
23 #include "trace_probe.h"
25 #define KPROBE_EVENT_SYSTEM "kprobes"
28 * Kprobe event core functions
31 struct list_head list;
32 struct kretprobe rp; /* Use rp.kp for kprobe use */
33 unsigned long __percpu *nhit;
34 const char *symbol; /* symbol name */
35 struct trace_probe tp;
38 #define SIZEOF_TRACE_KPROBE(n) \
39 (offsetof(struct trace_kprobe, tp.args) + \
40 (sizeof(struct probe_arg) * (n)))
43 static nokprobe_inline bool trace_kprobe_is_return(struct trace_kprobe *tk)
45 return tk->rp.handler != NULL;
48 static nokprobe_inline const char *trace_kprobe_symbol(struct trace_kprobe *tk)
50 return tk->symbol ? tk->symbol : "unknown";
53 static nokprobe_inline unsigned long trace_kprobe_offset(struct trace_kprobe *tk)
55 return tk->rp.kp.offset;
58 static nokprobe_inline bool trace_kprobe_has_gone(struct trace_kprobe *tk)
60 return !!(kprobe_gone(&tk->rp.kp));
63 static nokprobe_inline bool trace_kprobe_within_module(struct trace_kprobe *tk,
66 int len = strlen(mod->name);
67 const char *name = trace_kprobe_symbol(tk);
68 return strncmp(mod->name, name, len) == 0 && name[len] == ':';
71 static nokprobe_inline bool trace_kprobe_is_on_module(struct trace_kprobe *tk)
73 return !!strchr(trace_kprobe_symbol(tk), ':');
76 static int register_kprobe_event(struct trace_kprobe *tk);
77 static int unregister_kprobe_event(struct trace_kprobe *tk);
79 static DEFINE_MUTEX(probe_lock);
80 static LIST_HEAD(probe_list);
82 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs);
83 static int kretprobe_dispatcher(struct kretprobe_instance *ri,
84 struct pt_regs *regs);
86 /* Memory fetching by symbol */
93 unsigned long update_symbol_cache(struct symbol_cache *sc)
95 sc->addr = (unsigned long)kallsyms_lookup_name(sc->symbol);
98 sc->addr += sc->offset;
103 void free_symbol_cache(struct symbol_cache *sc)
109 struct symbol_cache *alloc_symbol_cache(const char *sym, long offset)
111 struct symbol_cache *sc;
113 if (!sym || strlen(sym) == 0)
116 sc = kzalloc(sizeof(struct symbol_cache), GFP_KERNEL);
120 sc->symbol = kstrdup(sym, GFP_KERNEL);
126 update_symbol_cache(sc);
132 * Kprobes-specific fetch functions
134 #define DEFINE_FETCH_stack(type) \
135 static void FETCH_FUNC_NAME(stack, type)(struct pt_regs *regs, \
136 void *offset, void *dest) \
138 *(type *)dest = (type)regs_get_kernel_stack_nth(regs, \
139 (unsigned int)((unsigned long)offset)); \
141 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(stack, type));
143 DEFINE_BASIC_FETCH_FUNCS(stack)
144 /* No string on the stack entry */
145 #define fetch_stack_string NULL
146 #define fetch_stack_string_size NULL
148 #define DEFINE_FETCH_memory(type) \
149 static void FETCH_FUNC_NAME(memory, type)(struct pt_regs *regs, \
150 void *addr, void *dest) \
153 if (probe_kernel_address(addr, retval)) \
156 *(type *)dest = retval; \
158 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, type));
160 DEFINE_BASIC_FETCH_FUNCS(memory)
162 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
163 * length and relative data location.
165 static void FETCH_FUNC_NAME(memory, string)(struct pt_regs *regs,
166 void *addr, void *dest)
168 int maxlen = get_rloc_len(*(u32 *)dest);
169 u8 *dst = get_rloc_data(dest);
176 * Try to get string again, since the string can be changed while
179 ret = strncpy_from_unsafe(dst, addr, maxlen);
181 if (ret < 0) { /* Failed to fetch string */
183 *(u32 *)dest = make_data_rloc(0, get_rloc_offs(*(u32 *)dest));
185 *(u32 *)dest = make_data_rloc(ret, get_rloc_offs(*(u32 *)dest));
188 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, string));
190 /* Return the length of string -- including null terminal byte */
191 static void FETCH_FUNC_NAME(memory, string_size)(struct pt_regs *regs,
192 void *addr, void *dest)
203 ret = __copy_from_user_inatomic(&c, (u8 *)addr + len, 1);
205 } while (c && ret == 0 && len < MAX_STRING_SIZE);
210 if (ret < 0) /* Failed to check the length */
215 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, string_size));
217 #define DEFINE_FETCH_symbol(type) \
218 void FETCH_FUNC_NAME(symbol, type)(struct pt_regs *regs, void *data, void *dest)\
220 struct symbol_cache *sc = data; \
222 fetch_memory_##type(regs, (void *)sc->addr, dest); \
226 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(symbol, type));
228 DEFINE_BASIC_FETCH_FUNCS(symbol)
229 DEFINE_FETCH_symbol(string)
230 DEFINE_FETCH_symbol(string_size)
232 /* kprobes don't support file_offset fetch methods */
233 #define fetch_file_offset_u8 NULL
234 #define fetch_file_offset_u16 NULL
235 #define fetch_file_offset_u32 NULL
236 #define fetch_file_offset_u64 NULL
237 #define fetch_file_offset_string NULL
238 #define fetch_file_offset_string_size NULL
240 /* Fetch type information table */
241 static const struct fetch_type kprobes_fetch_type_table[] = {
243 [FETCH_TYPE_STRING] = __ASSIGN_FETCH_TYPE("string", string, string,
244 sizeof(u32), 1, "__data_loc char[]"),
245 [FETCH_TYPE_STRSIZE] = __ASSIGN_FETCH_TYPE("string_size", u32,
246 string_size, sizeof(u32), 0, "u32"),
248 ASSIGN_FETCH_TYPE(u8, u8, 0),
249 ASSIGN_FETCH_TYPE(u16, u16, 0),
250 ASSIGN_FETCH_TYPE(u32, u32, 0),
251 ASSIGN_FETCH_TYPE(u64, u64, 0),
252 ASSIGN_FETCH_TYPE(s8, u8, 1),
253 ASSIGN_FETCH_TYPE(s16, u16, 1),
254 ASSIGN_FETCH_TYPE(s32, u32, 1),
255 ASSIGN_FETCH_TYPE(s64, u64, 1),
257 ASSIGN_FETCH_TYPE_END
261 * Allocate new trace_probe and initialize it (including kprobes).
263 static struct trace_kprobe *alloc_trace_kprobe(const char *group,
268 int nargs, bool is_return)
270 struct trace_kprobe *tk;
273 tk = kzalloc(SIZEOF_TRACE_KPROBE(nargs), GFP_KERNEL);
277 tk->nhit = alloc_percpu(unsigned long);
282 tk->symbol = kstrdup(symbol, GFP_KERNEL);
285 tk->rp.kp.symbol_name = tk->symbol;
286 tk->rp.kp.offset = offs;
288 tk->rp.kp.addr = addr;
291 tk->rp.handler = kretprobe_dispatcher;
293 tk->rp.kp.pre_handler = kprobe_dispatcher;
295 if (!event || !is_good_name(event)) {
300 tk->tp.call.class = &tk->tp.class;
301 tk->tp.call.name = kstrdup(event, GFP_KERNEL);
302 if (!tk->tp.call.name)
305 if (!group || !is_good_name(group)) {
310 tk->tp.class.system = kstrdup(group, GFP_KERNEL);
311 if (!tk->tp.class.system)
314 INIT_LIST_HEAD(&tk->list);
315 INIT_LIST_HEAD(&tk->tp.files);
318 kfree(tk->tp.call.name);
320 free_percpu(tk->nhit);
325 static void free_trace_kprobe(struct trace_kprobe *tk)
329 for (i = 0; i < tk->tp.nr_args; i++)
330 traceprobe_free_probe_arg(&tk->tp.args[i]);
332 kfree(tk->tp.call.class->system);
333 kfree(tk->tp.call.name);
335 free_percpu(tk->nhit);
339 static struct trace_kprobe *find_trace_kprobe(const char *event,
342 struct trace_kprobe *tk;
344 list_for_each_entry(tk, &probe_list, list)
345 if (strcmp(trace_event_name(&tk->tp.call), event) == 0 &&
346 strcmp(tk->tp.call.class->system, group) == 0)
353 * if the file is NULL, enable "perf" handler, or enable "trace" handler.
356 enable_trace_kprobe(struct trace_kprobe *tk, struct trace_event_file *file)
361 struct event_file_link *link;
363 link = kmalloc(sizeof(*link), GFP_KERNEL);
370 list_add_tail_rcu(&link->list, &tk->tp.files);
372 tk->tp.flags |= TP_FLAG_TRACE;
374 tk->tp.flags |= TP_FLAG_PROFILE;
376 if (trace_probe_is_registered(&tk->tp) && !trace_kprobe_has_gone(tk)) {
377 if (trace_kprobe_is_return(tk))
378 ret = enable_kretprobe(&tk->rp);
380 ret = enable_kprobe(&tk->rp.kp);
387 * Disable trace_probe
388 * if the file is NULL, disable "perf" handler, or disable "trace" handler.
391 disable_trace_kprobe(struct trace_kprobe *tk, struct trace_event_file *file)
393 struct event_file_link *link = NULL;
398 link = find_event_file_link(&tk->tp, file);
404 list_del_rcu(&link->list);
406 if (!list_empty(&tk->tp.files))
409 tk->tp.flags &= ~TP_FLAG_TRACE;
411 tk->tp.flags &= ~TP_FLAG_PROFILE;
413 if (!trace_probe_is_enabled(&tk->tp) && trace_probe_is_registered(&tk->tp)) {
414 if (trace_kprobe_is_return(tk))
415 disable_kretprobe(&tk->rp);
417 disable_kprobe(&tk->rp.kp);
423 * Synchronize with kprobe_trace_func/kretprobe_trace_func
424 * to ensure disabled (all running handlers are finished).
425 * This is not only for kfree(), but also the caller,
426 * trace_remove_event_call() supposes it for releasing
427 * event_call related objects, which will be accessed in
428 * the kprobe_trace_func/kretprobe_trace_func.
431 kfree(link); /* Ignored if link == NULL */
437 /* Internal register function - just handle k*probes and flags */
438 static int __register_trace_kprobe(struct trace_kprobe *tk)
442 if (trace_probe_is_registered(&tk->tp))
445 for (i = 0; i < tk->tp.nr_args; i++)
446 traceprobe_update_arg(&tk->tp.args[i]);
448 /* Set/clear disabled flag according to tp->flag */
449 if (trace_probe_is_enabled(&tk->tp))
450 tk->rp.kp.flags &= ~KPROBE_FLAG_DISABLED;
452 tk->rp.kp.flags |= KPROBE_FLAG_DISABLED;
454 if (trace_kprobe_is_return(tk))
455 ret = register_kretprobe(&tk->rp);
457 ret = register_kprobe(&tk->rp.kp);
460 tk->tp.flags |= TP_FLAG_REGISTERED;
462 pr_warning("Could not insert probe at %s+%lu: %d\n",
463 trace_kprobe_symbol(tk), trace_kprobe_offset(tk), ret);
464 if (ret == -ENOENT && trace_kprobe_is_on_module(tk)) {
465 pr_warning("This probe might be able to register after"
466 "target module is loaded. Continue.\n");
468 } else if (ret == -EILSEQ) {
469 pr_warning("Probing address(0x%p) is not an "
470 "instruction boundary.\n",
479 /* Internal unregister function - just handle k*probes and flags */
480 static void __unregister_trace_kprobe(struct trace_kprobe *tk)
482 if (trace_probe_is_registered(&tk->tp)) {
483 if (trace_kprobe_is_return(tk))
484 unregister_kretprobe(&tk->rp);
486 unregister_kprobe(&tk->rp.kp);
487 tk->tp.flags &= ~TP_FLAG_REGISTERED;
488 /* Cleanup kprobe for reuse */
489 if (tk->rp.kp.symbol_name)
490 tk->rp.kp.addr = NULL;
494 /* Unregister a trace_probe and probe_event: call with locking probe_lock */
495 static int unregister_trace_kprobe(struct trace_kprobe *tk)
497 /* Enabled event can not be unregistered */
498 if (trace_probe_is_enabled(&tk->tp))
501 /* Will fail if probe is being used by ftrace or perf */
502 if (unregister_kprobe_event(tk))
505 __unregister_trace_kprobe(tk);
511 /* Register a trace_probe and probe_event */
512 static int register_trace_kprobe(struct trace_kprobe *tk)
514 struct trace_kprobe *old_tk;
517 mutex_lock(&probe_lock);
519 /* Delete old (same name) event if exist */
520 old_tk = find_trace_kprobe(trace_event_name(&tk->tp.call),
521 tk->tp.call.class->system);
523 ret = unregister_trace_kprobe(old_tk);
526 free_trace_kprobe(old_tk);
529 /* Register new event */
530 ret = register_kprobe_event(tk);
532 pr_warning("Failed to register probe event(%d)\n", ret);
536 /* Register k*probe */
537 ret = __register_trace_kprobe(tk);
539 unregister_kprobe_event(tk);
541 list_add_tail(&tk->list, &probe_list);
544 mutex_unlock(&probe_lock);
548 /* Module notifier call back, checking event on the module */
549 static int trace_kprobe_module_callback(struct notifier_block *nb,
550 unsigned long val, void *data)
552 struct module *mod = data;
553 struct trace_kprobe *tk;
556 if (val != MODULE_STATE_COMING)
559 /* Update probes on coming module */
560 mutex_lock(&probe_lock);
561 list_for_each_entry(tk, &probe_list, list) {
562 if (trace_kprobe_within_module(tk, mod)) {
563 /* Don't need to check busy - this should have gone. */
564 __unregister_trace_kprobe(tk);
565 ret = __register_trace_kprobe(tk);
567 pr_warning("Failed to re-register probe %s on"
569 trace_event_name(&tk->tp.call),
573 mutex_unlock(&probe_lock);
578 static struct notifier_block trace_kprobe_module_nb = {
579 .notifier_call = trace_kprobe_module_callback,
580 .priority = 1 /* Invoked after kprobe module callback */
583 static int create_trace_kprobe(int argc, char **argv)
587 * - Add kprobe: p[:[GRP/]EVENT] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS]
588 * - Add kretprobe: r[:[GRP/]EVENT] [MOD:]KSYM[+0] [FETCHARGS]
590 * $retval : fetch return value
591 * $stack : fetch stack address
592 * $stackN : fetch Nth of stack (N:0-)
593 * @ADDR : fetch memory at ADDR (ADDR should be in kernel)
594 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol)
595 * %REG : fetch register REG
596 * Dereferencing memory fetch:
597 * +|-offs(ARG) : fetch memory at ARG +|- offs address.
598 * Alias name of args:
599 * NAME=FETCHARG : set NAME as alias of FETCHARG.
601 * FETCHARG:TYPE : use TYPE instead of unsigned long.
603 struct trace_kprobe *tk;
605 bool is_return = false, is_delete = false;
606 char *symbol = NULL, *event = NULL, *group = NULL;
608 unsigned long offset = 0;
610 char buf[MAX_EVENT_NAME_LEN];
612 /* argc must be >= 1 */
613 if (argv[0][0] == 'p')
615 else if (argv[0][0] == 'r')
617 else if (argv[0][0] == '-')
620 pr_info("Probe definition must be started with 'p', 'r' or"
625 if (argv[0][1] == ':') {
627 if (strchr(event, '/')) {
629 event = strchr(group, '/') + 1;
631 if (strlen(group) == 0) {
632 pr_info("Group name is not specified\n");
636 if (strlen(event) == 0) {
637 pr_info("Event name is not specified\n");
642 group = KPROBE_EVENT_SYSTEM;
646 pr_info("Delete command needs an event name.\n");
649 mutex_lock(&probe_lock);
650 tk = find_trace_kprobe(event, group);
652 mutex_unlock(&probe_lock);
653 pr_info("Event %s/%s doesn't exist.\n", group, event);
656 /* delete an event */
657 ret = unregister_trace_kprobe(tk);
659 free_trace_kprobe(tk);
660 mutex_unlock(&probe_lock);
665 pr_info("Probe point is not specified.\n");
668 if (isdigit(argv[1][0])) {
670 pr_info("Return probe point must be a symbol.\n");
673 /* an address specified */
674 ret = kstrtoul(&argv[1][0], 0, (unsigned long *)&addr);
676 pr_info("Failed to parse address.\n");
680 /* a symbol specified */
682 /* TODO: support .init module functions */
683 ret = traceprobe_split_symbol_offset(symbol, &offset);
685 pr_info("Failed to parse symbol.\n");
688 if (offset && is_return) {
689 pr_info("Return probe must be used without offset.\n");
693 argc -= 2; argv += 2;
697 /* Make a new event name */
699 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_%ld",
700 is_return ? 'r' : 'p', symbol, offset);
702 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_0x%p",
703 is_return ? 'r' : 'p', addr);
706 tk = alloc_trace_kprobe(group, event, addr, symbol, offset, argc,
709 pr_info("Failed to allocate trace_probe.(%d)\n",
714 /* parse arguments */
716 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) {
717 struct probe_arg *parg = &tk->tp.args[i];
719 /* Increment count for freeing args in error case */
722 /* Parse argument name */
723 arg = strchr(argv[i], '=');
726 parg->name = kstrdup(argv[i], GFP_KERNEL);
729 /* If argument name is omitted, set "argN" */
730 snprintf(buf, MAX_EVENT_NAME_LEN, "arg%d", i + 1);
731 parg->name = kstrdup(buf, GFP_KERNEL);
735 pr_info("Failed to allocate argument[%d] name.\n", i);
740 if (!is_good_name(parg->name)) {
741 pr_info("Invalid argument[%d] name: %s\n",
747 if (traceprobe_conflict_field_name(parg->name,
749 pr_info("Argument[%d] name '%s' conflicts with "
750 "another field.\n", i, argv[i]);
755 /* Parse fetch argument */
756 ret = traceprobe_parse_probe_arg(arg, &tk->tp.size, parg,
758 kprobes_fetch_type_table);
760 pr_info("Parse error at argument[%d]. (%d)\n", i, ret);
765 ret = register_trace_kprobe(tk);
771 free_trace_kprobe(tk);
775 static int release_all_trace_kprobes(void)
777 struct trace_kprobe *tk;
780 mutex_lock(&probe_lock);
781 /* Ensure no probe is in use. */
782 list_for_each_entry(tk, &probe_list, list)
783 if (trace_probe_is_enabled(&tk->tp)) {
787 /* TODO: Use batch unregistration */
788 while (!list_empty(&probe_list)) {
789 tk = list_entry(probe_list.next, struct trace_kprobe, list);
790 ret = unregister_trace_kprobe(tk);
793 free_trace_kprobe(tk);
797 mutex_unlock(&probe_lock);
802 /* Probes listing interfaces */
803 static void *probes_seq_start(struct seq_file *m, loff_t *pos)
805 mutex_lock(&probe_lock);
806 return seq_list_start(&probe_list, *pos);
809 static void *probes_seq_next(struct seq_file *m, void *v, loff_t *pos)
811 return seq_list_next(v, &probe_list, pos);
814 static void probes_seq_stop(struct seq_file *m, void *v)
816 mutex_unlock(&probe_lock);
819 static int probes_seq_show(struct seq_file *m, void *v)
821 struct trace_kprobe *tk = v;
824 seq_putc(m, trace_kprobe_is_return(tk) ? 'r' : 'p');
825 seq_printf(m, ":%s/%s", tk->tp.call.class->system,
826 trace_event_name(&tk->tp.call));
829 seq_printf(m, " 0x%p", tk->rp.kp.addr);
830 else if (tk->rp.kp.offset)
831 seq_printf(m, " %s+%u", trace_kprobe_symbol(tk),
834 seq_printf(m, " %s", trace_kprobe_symbol(tk));
836 for (i = 0; i < tk->tp.nr_args; i++)
837 seq_printf(m, " %s=%s", tk->tp.args[i].name, tk->tp.args[i].comm);
843 static const struct seq_operations probes_seq_op = {
844 .start = probes_seq_start,
845 .next = probes_seq_next,
846 .stop = probes_seq_stop,
847 .show = probes_seq_show
850 static int probes_open(struct inode *inode, struct file *file)
854 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
855 ret = release_all_trace_kprobes();
860 return seq_open(file, &probes_seq_op);
863 static ssize_t probes_write(struct file *file, const char __user *buffer,
864 size_t count, loff_t *ppos)
866 return traceprobe_probes_write(file, buffer, count, ppos,
867 create_trace_kprobe);
870 static const struct file_operations kprobe_events_ops = {
871 .owner = THIS_MODULE,
875 .release = seq_release,
876 .write = probes_write,
879 /* Probes profiling interfaces */
880 static int probes_profile_seq_show(struct seq_file *m, void *v)
882 struct trace_kprobe *tk = v;
883 unsigned long nhit = 0;
886 for_each_possible_cpu(cpu)
887 nhit += *per_cpu_ptr(tk->nhit, cpu);
889 seq_printf(m, " %-44s %15lu %15lu\n",
890 trace_event_name(&tk->tp.call), nhit,
896 static const struct seq_operations profile_seq_op = {
897 .start = probes_seq_start,
898 .next = probes_seq_next,
899 .stop = probes_seq_stop,
900 .show = probes_profile_seq_show
903 static int profile_open(struct inode *inode, struct file *file)
905 return seq_open(file, &profile_seq_op);
908 static const struct file_operations kprobe_profile_ops = {
909 .owner = THIS_MODULE,
910 .open = profile_open,
913 .release = seq_release,
917 static nokprobe_inline void
918 __kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs,
919 struct trace_event_file *trace_file)
921 struct kprobe_trace_entry_head *entry;
922 struct ring_buffer_event *event;
923 struct ring_buffer *buffer;
925 unsigned long irq_flags;
926 struct trace_event_call *call = &tk->tp.call;
928 WARN_ON(call != trace_file->event_call);
930 if (trace_trigger_soft_disabled(trace_file))
933 local_save_flags(irq_flags);
934 pc = preempt_count();
936 dsize = __get_data_size(&tk->tp, regs);
937 size = sizeof(*entry) + tk->tp.size + dsize;
939 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
941 size, irq_flags, pc);
945 entry = ring_buffer_event_data(event);
946 entry->ip = (unsigned long)tk->rp.kp.addr;
947 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
949 event_trigger_unlock_commit_regs(trace_file, buffer, event,
950 entry, irq_flags, pc, regs);
954 kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs)
956 struct event_file_link *link;
958 list_for_each_entry_rcu(link, &tk->tp.files, list)
959 __kprobe_trace_func(tk, regs, link->file);
961 NOKPROBE_SYMBOL(kprobe_trace_func);
963 /* Kretprobe handler */
964 static nokprobe_inline void
965 __kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
966 struct pt_regs *regs,
967 struct trace_event_file *trace_file)
969 struct kretprobe_trace_entry_head *entry;
970 struct ring_buffer_event *event;
971 struct ring_buffer *buffer;
973 unsigned long irq_flags;
974 struct trace_event_call *call = &tk->tp.call;
976 WARN_ON(call != trace_file->event_call);
978 if (trace_trigger_soft_disabled(trace_file))
981 local_save_flags(irq_flags);
982 pc = preempt_count();
984 dsize = __get_data_size(&tk->tp, regs);
985 size = sizeof(*entry) + tk->tp.size + dsize;
987 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
989 size, irq_flags, pc);
993 entry = ring_buffer_event_data(event);
994 entry->func = (unsigned long)tk->rp.kp.addr;
995 entry->ret_ip = (unsigned long)ri->ret_addr;
996 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
998 event_trigger_unlock_commit_regs(trace_file, buffer, event,
999 entry, irq_flags, pc, regs);
1003 kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1004 struct pt_regs *regs)
1006 struct event_file_link *link;
1008 list_for_each_entry_rcu(link, &tk->tp.files, list)
1009 __kretprobe_trace_func(tk, ri, regs, link->file);
1011 NOKPROBE_SYMBOL(kretprobe_trace_func);
1013 /* Event entry printers */
1014 static enum print_line_t
1015 print_kprobe_event(struct trace_iterator *iter, int flags,
1016 struct trace_event *event)
1018 struct kprobe_trace_entry_head *field;
1019 struct trace_seq *s = &iter->seq;
1020 struct trace_probe *tp;
1024 field = (struct kprobe_trace_entry_head *)iter->ent;
1025 tp = container_of(event, struct trace_probe, call.event);
1027 trace_seq_printf(s, "%s: (", trace_event_name(&tp->call));
1029 if (!seq_print_ip_sym(s, field->ip, flags | TRACE_ITER_SYM_OFFSET))
1032 trace_seq_putc(s, ')');
1034 data = (u8 *)&field[1];
1035 for (i = 0; i < tp->nr_args; i++)
1036 if (!tp->args[i].type->print(s, tp->args[i].name,
1037 data + tp->args[i].offset, field))
1040 trace_seq_putc(s, '\n');
1042 return trace_handle_return(s);
1045 static enum print_line_t
1046 print_kretprobe_event(struct trace_iterator *iter, int flags,
1047 struct trace_event *event)
1049 struct kretprobe_trace_entry_head *field;
1050 struct trace_seq *s = &iter->seq;
1051 struct trace_probe *tp;
1055 field = (struct kretprobe_trace_entry_head *)iter->ent;
1056 tp = container_of(event, struct trace_probe, call.event);
1058 trace_seq_printf(s, "%s: (", trace_event_name(&tp->call));
1060 if (!seq_print_ip_sym(s, field->ret_ip, flags | TRACE_ITER_SYM_OFFSET))
1063 trace_seq_puts(s, " <- ");
1065 if (!seq_print_ip_sym(s, field->func, flags & ~TRACE_ITER_SYM_OFFSET))
1068 trace_seq_putc(s, ')');
1070 data = (u8 *)&field[1];
1071 for (i = 0; i < tp->nr_args; i++)
1072 if (!tp->args[i].type->print(s, tp->args[i].name,
1073 data + tp->args[i].offset, field))
1076 trace_seq_putc(s, '\n');
1079 return trace_handle_return(s);
1083 static int kprobe_event_define_fields(struct trace_event_call *event_call)
1086 struct kprobe_trace_entry_head field;
1087 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data;
1089 DEFINE_FIELD(unsigned long, ip, FIELD_STRING_IP, 0);
1090 /* Set argument names as fields */
1091 for (i = 0; i < tk->tp.nr_args; i++) {
1092 struct probe_arg *parg = &tk->tp.args[i];
1094 ret = trace_define_field(event_call, parg->type->fmttype,
1096 sizeof(field) + parg->offset,
1098 parg->type->is_signed,
1106 static int kretprobe_event_define_fields(struct trace_event_call *event_call)
1109 struct kretprobe_trace_entry_head field;
1110 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data;
1112 DEFINE_FIELD(unsigned long, func, FIELD_STRING_FUNC, 0);
1113 DEFINE_FIELD(unsigned long, ret_ip, FIELD_STRING_RETIP, 0);
1114 /* Set argument names as fields */
1115 for (i = 0; i < tk->tp.nr_args; i++) {
1116 struct probe_arg *parg = &tk->tp.args[i];
1118 ret = trace_define_field(event_call, parg->type->fmttype,
1120 sizeof(field) + parg->offset,
1122 parg->type->is_signed,
1130 #ifdef CONFIG_PERF_EVENTS
1132 /* Kprobe profile handler */
1134 kprobe_perf_func(struct trace_kprobe *tk, struct pt_regs *regs)
1136 struct trace_event_call *call = &tk->tp.call;
1137 struct bpf_prog *prog = call->prog;
1138 struct kprobe_trace_entry_head *entry;
1139 struct hlist_head *head;
1140 int size, __size, dsize;
1143 if (prog && !trace_call_bpf(prog, regs))
1146 head = this_cpu_ptr(call->perf_events);
1147 if (hlist_empty(head))
1150 dsize = __get_data_size(&tk->tp, regs);
1151 __size = sizeof(*entry) + tk->tp.size + dsize;
1152 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1153 size -= sizeof(u32);
1155 entry = perf_trace_buf_prepare(size, call->event.type, NULL, &rctx);
1159 entry->ip = (unsigned long)tk->rp.kp.addr;
1160 memset(&entry[1], 0, dsize);
1161 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
1162 perf_trace_buf_submit(entry, size, rctx, 0, 1, regs, head, NULL);
1164 NOKPROBE_SYMBOL(kprobe_perf_func);
1166 /* Kretprobe profile handler */
1168 kretprobe_perf_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1169 struct pt_regs *regs)
1171 struct trace_event_call *call = &tk->tp.call;
1172 struct bpf_prog *prog = call->prog;
1173 struct kretprobe_trace_entry_head *entry;
1174 struct hlist_head *head;
1175 int size, __size, dsize;
1178 if (prog && !trace_call_bpf(prog, regs))
1181 head = this_cpu_ptr(call->perf_events);
1182 if (hlist_empty(head))
1185 dsize = __get_data_size(&tk->tp, regs);
1186 __size = sizeof(*entry) + tk->tp.size + dsize;
1187 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1188 size -= sizeof(u32);
1190 entry = perf_trace_buf_prepare(size, call->event.type, NULL, &rctx);
1194 entry->func = (unsigned long)tk->rp.kp.addr;
1195 entry->ret_ip = (unsigned long)ri->ret_addr;
1196 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
1197 perf_trace_buf_submit(entry, size, rctx, 0, 1, regs, head, NULL);
1199 NOKPROBE_SYMBOL(kretprobe_perf_func);
1200 #endif /* CONFIG_PERF_EVENTS */
1203 * called by perf_trace_init() or __ftrace_set_clr_event() under event_mutex.
1205 * kprobe_trace_self_tests_init() does enable_trace_probe/disable_trace_probe
1206 * lockless, but we can't race with this __init function.
1208 static int kprobe_register(struct trace_event_call *event,
1209 enum trace_reg type, void *data)
1211 struct trace_kprobe *tk = (struct trace_kprobe *)event->data;
1212 struct trace_event_file *file = data;
1215 case TRACE_REG_REGISTER:
1216 return enable_trace_kprobe(tk, file);
1217 case TRACE_REG_UNREGISTER:
1218 return disable_trace_kprobe(tk, file);
1220 #ifdef CONFIG_PERF_EVENTS
1221 case TRACE_REG_PERF_REGISTER:
1222 return enable_trace_kprobe(tk, NULL);
1223 case TRACE_REG_PERF_UNREGISTER:
1224 return disable_trace_kprobe(tk, NULL);
1225 case TRACE_REG_PERF_OPEN:
1226 case TRACE_REG_PERF_CLOSE:
1227 case TRACE_REG_PERF_ADD:
1228 case TRACE_REG_PERF_DEL:
1235 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs)
1237 struct trace_kprobe *tk = container_of(kp, struct trace_kprobe, rp.kp);
1239 raw_cpu_inc(*tk->nhit);
1241 if (tk->tp.flags & TP_FLAG_TRACE)
1242 kprobe_trace_func(tk, regs);
1243 #ifdef CONFIG_PERF_EVENTS
1244 if (tk->tp.flags & TP_FLAG_PROFILE)
1245 kprobe_perf_func(tk, regs);
1247 return 0; /* We don't tweek kernel, so just return 0 */
1249 NOKPROBE_SYMBOL(kprobe_dispatcher);
1252 kretprobe_dispatcher(struct kretprobe_instance *ri, struct pt_regs *regs)
1254 struct trace_kprobe *tk = container_of(ri->rp, struct trace_kprobe, rp);
1256 raw_cpu_inc(*tk->nhit);
1258 if (tk->tp.flags & TP_FLAG_TRACE)
1259 kretprobe_trace_func(tk, ri, regs);
1260 #ifdef CONFIG_PERF_EVENTS
1261 if (tk->tp.flags & TP_FLAG_PROFILE)
1262 kretprobe_perf_func(tk, ri, regs);
1264 return 0; /* We don't tweek kernel, so just return 0 */
1266 NOKPROBE_SYMBOL(kretprobe_dispatcher);
1268 static struct trace_event_functions kretprobe_funcs = {
1269 .trace = print_kretprobe_event
1272 static struct trace_event_functions kprobe_funcs = {
1273 .trace = print_kprobe_event
1276 static int register_kprobe_event(struct trace_kprobe *tk)
1278 struct trace_event_call *call = &tk->tp.call;
1281 /* Initialize trace_event_call */
1282 INIT_LIST_HEAD(&call->class->fields);
1283 if (trace_kprobe_is_return(tk)) {
1284 call->event.funcs = &kretprobe_funcs;
1285 call->class->define_fields = kretprobe_event_define_fields;
1287 call->event.funcs = &kprobe_funcs;
1288 call->class->define_fields = kprobe_event_define_fields;
1290 if (set_print_fmt(&tk->tp, trace_kprobe_is_return(tk)) < 0)
1292 ret = register_trace_event(&call->event);
1294 kfree(call->print_fmt);
1297 call->flags = TRACE_EVENT_FL_KPROBE;
1298 call->class->reg = kprobe_register;
1300 ret = trace_add_event_call(call);
1302 pr_info("Failed to register kprobe event: %s\n",
1303 trace_event_name(call));
1304 kfree(call->print_fmt);
1305 unregister_trace_event(&call->event);
1310 static int unregister_kprobe_event(struct trace_kprobe *tk)
1314 /* tp->event is unregistered in trace_remove_event_call() */
1315 ret = trace_remove_event_call(&tk->tp.call);
1317 kfree(tk->tp.call.print_fmt);
1321 /* Make a tracefs interface for controlling probe points */
1322 static __init int init_kprobe_trace(void)
1324 struct dentry *d_tracer;
1325 struct dentry *entry;
1327 if (register_module_notifier(&trace_kprobe_module_nb))
1330 d_tracer = tracing_init_dentry();
1331 if (IS_ERR(d_tracer))
1334 entry = tracefs_create_file("kprobe_events", 0644, d_tracer,
1335 NULL, &kprobe_events_ops);
1337 /* Event list interface */
1339 pr_warning("Could not create tracefs "
1340 "'kprobe_events' entry\n");
1342 /* Profile interface */
1343 entry = tracefs_create_file("kprobe_profile", 0444, d_tracer,
1344 NULL, &kprobe_profile_ops);
1347 pr_warning("Could not create tracefs "
1348 "'kprobe_profile' entry\n");
1351 fs_initcall(init_kprobe_trace);
1354 #ifdef CONFIG_FTRACE_STARTUP_TEST
1357 * The "__used" keeps gcc from removing the function symbol
1358 * from the kallsyms table.
1360 static __used int kprobe_trace_selftest_target(int a1, int a2, int a3,
1361 int a4, int a5, int a6)
1363 return a1 + a2 + a3 + a4 + a5 + a6;
1366 static struct trace_event_file *
1367 find_trace_probe_file(struct trace_kprobe *tk, struct trace_array *tr)
1369 struct trace_event_file *file;
1371 list_for_each_entry(file, &tr->events, list)
1372 if (file->event_call == &tk->tp.call)
1379 * Nobody but us can call enable_trace_kprobe/disable_trace_kprobe at this
1380 * stage, we can do this lockless.
1382 static __init int kprobe_trace_self_tests_init(void)
1385 int (*target)(int, int, int, int, int, int);
1386 struct trace_kprobe *tk;
1387 struct trace_event_file *file;
1389 if (tracing_is_disabled())
1392 target = kprobe_trace_selftest_target;
1394 pr_info("Testing kprobe tracing: ");
1396 ret = traceprobe_command("p:testprobe kprobe_trace_selftest_target "
1397 "$stack $stack0 +0($stack)",
1398 create_trace_kprobe);
1399 if (WARN_ON_ONCE(ret)) {
1400 pr_warn("error on probing function entry.\n");
1403 /* Enable trace point */
1404 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
1405 if (WARN_ON_ONCE(tk == NULL)) {
1406 pr_warn("error on getting new probe.\n");
1409 file = find_trace_probe_file(tk, top_trace_array());
1410 if (WARN_ON_ONCE(file == NULL)) {
1411 pr_warn("error on getting probe file.\n");
1414 enable_trace_kprobe(tk, file);
1418 ret = traceprobe_command("r:testprobe2 kprobe_trace_selftest_target "
1419 "$retval", create_trace_kprobe);
1420 if (WARN_ON_ONCE(ret)) {
1421 pr_warn("error on probing function return.\n");
1424 /* Enable trace point */
1425 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
1426 if (WARN_ON_ONCE(tk == NULL)) {
1427 pr_warn("error on getting 2nd new probe.\n");
1430 file = find_trace_probe_file(tk, top_trace_array());
1431 if (WARN_ON_ONCE(file == NULL)) {
1432 pr_warn("error on getting probe file.\n");
1435 enable_trace_kprobe(tk, file);
1442 ret = target(1, 2, 3, 4, 5, 6);
1444 /* Disable trace points before removing it */
1445 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM);
1446 if (WARN_ON_ONCE(tk == NULL)) {
1447 pr_warn("error on getting test probe.\n");
1450 file = find_trace_probe_file(tk, top_trace_array());
1451 if (WARN_ON_ONCE(file == NULL)) {
1452 pr_warn("error on getting probe file.\n");
1455 disable_trace_kprobe(tk, file);
1458 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM);
1459 if (WARN_ON_ONCE(tk == NULL)) {
1460 pr_warn("error on getting 2nd test probe.\n");
1463 file = find_trace_probe_file(tk, top_trace_array());
1464 if (WARN_ON_ONCE(file == NULL)) {
1465 pr_warn("error on getting probe file.\n");
1468 disable_trace_kprobe(tk, file);
1471 ret = traceprobe_command("-:testprobe", create_trace_kprobe);
1472 if (WARN_ON_ONCE(ret)) {
1473 pr_warn("error on deleting a probe.\n");
1477 ret = traceprobe_command("-:testprobe2", create_trace_kprobe);
1478 if (WARN_ON_ONCE(ret)) {
1479 pr_warn("error on deleting a probe.\n");
1484 release_all_trace_kprobes();
1486 pr_cont("NG: Some tests are failed. Please check them.\n");
1492 late_initcall(kprobe_trace_self_tests_init);