2 * Kprobes-based tracing events
4 * Created by Masami Hiramatsu <mhiramat@redhat.com>
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 */
34 const char *symbol; /* symbol name */
35 struct trace_probe tp;
38 struct event_file_link {
39 struct ftrace_event_file *file;
40 struct list_head list;
43 #define SIZEOF_TRACE_KPROBE(n) \
44 (offsetof(struct trace_kprobe, tp.args) + \
45 (sizeof(struct probe_arg) * (n)))
48 static __kprobes bool trace_kprobe_is_return(struct trace_kprobe *tk)
50 return tk->rp.handler != NULL;
53 static __kprobes const char *trace_kprobe_symbol(struct trace_kprobe *tk)
55 return tk->symbol ? tk->symbol : "unknown";
58 static __kprobes unsigned long trace_kprobe_offset(struct trace_kprobe *tk)
60 return tk->rp.kp.offset;
63 static __kprobes bool trace_kprobe_has_gone(struct trace_kprobe *tk)
65 return !!(kprobe_gone(&tk->rp.kp));
68 static __kprobes bool trace_kprobe_within_module(struct trace_kprobe *tk,
71 int len = strlen(mod->name);
72 const char *name = trace_kprobe_symbol(tk);
73 return strncmp(mod->name, name, len) == 0 && name[len] == ':';
76 static __kprobes bool trace_kprobe_is_on_module(struct trace_kprobe *tk)
78 return !!strchr(trace_kprobe_symbol(tk), ':');
81 static int register_kprobe_event(struct trace_kprobe *tk);
82 static int unregister_kprobe_event(struct trace_kprobe *tk);
84 static DEFINE_MUTEX(probe_lock);
85 static LIST_HEAD(probe_list);
87 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs);
88 static int kretprobe_dispatcher(struct kretprobe_instance *ri,
89 struct pt_regs *regs);
91 /* Memory fetching by symbol */
98 unsigned long update_symbol_cache(struct symbol_cache *sc)
100 sc->addr = (unsigned long)kallsyms_lookup_name(sc->symbol);
103 sc->addr += sc->offset;
108 void free_symbol_cache(struct symbol_cache *sc)
114 struct symbol_cache *alloc_symbol_cache(const char *sym, long offset)
116 struct symbol_cache *sc;
118 if (!sym || strlen(sym) == 0)
121 sc = kzalloc(sizeof(struct symbol_cache), GFP_KERNEL);
125 sc->symbol = kstrdup(sym, GFP_KERNEL);
131 update_symbol_cache(sc);
137 * Kprobes-specific fetch functions
139 #define DEFINE_FETCH_stack(type) \
140 static __kprobes void FETCH_FUNC_NAME(stack, type)(struct pt_regs *regs,\
141 void *offset, void *dest) \
143 *(type *)dest = (type)regs_get_kernel_stack_nth(regs, \
144 (unsigned int)((unsigned long)offset)); \
146 DEFINE_BASIC_FETCH_FUNCS(stack)
147 /* No string on the stack entry */
148 #define fetch_stack_string NULL
149 #define fetch_stack_string_size NULL
151 #define DEFINE_FETCH_memory(type) \
152 static __kprobes void FETCH_FUNC_NAME(memory, type)(struct pt_regs *regs,\
153 void *addr, void *dest) \
156 if (probe_kernel_address(addr, retval)) \
159 *(type *)dest = retval; \
161 DEFINE_BASIC_FETCH_FUNCS(memory)
163 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
164 * length and relative data location.
166 static __kprobes void FETCH_FUNC_NAME(memory, string)(struct pt_regs *regs,
167 void *addr, void *dest)
170 int maxlen = get_rloc_len(*(u32 *)dest);
171 u8 *dst = get_rloc_data(dest);
173 mm_segment_t old_fs = get_fs();
179 * Try to get string again, since the string can be changed while
186 ret = __copy_from_user_inatomic(dst++, src++, 1);
187 while (dst[-1] && ret == 0 && src - (u8 *)addr < maxlen);
193 if (ret < 0) { /* Failed to fetch string */
194 ((u8 *)get_rloc_data(dest))[0] = '\0';
195 *(u32 *)dest = make_data_rloc(0, get_rloc_offs(*(u32 *)dest));
197 *(u32 *)dest = make_data_rloc(src - (u8 *)addr,
198 get_rloc_offs(*(u32 *)dest));
202 /* Return the length of string -- including null terminal byte */
203 static __kprobes void FETCH_FUNC_NAME(memory, string_size)(struct pt_regs *regs,
204 void *addr, void *dest)
215 ret = __copy_from_user_inatomic(&c, (u8 *)addr + len, 1);
217 } while (c && ret == 0 && len < MAX_STRING_SIZE);
222 if (ret < 0) /* Failed to check the length */
228 #define DEFINE_FETCH_symbol(type) \
229 __kprobes void FETCH_FUNC_NAME(symbol, type)(struct pt_regs *regs, \
230 void *data, void *dest) \
232 struct symbol_cache *sc = data; \
234 fetch_memory_##type(regs, (void *)sc->addr, dest); \
238 DEFINE_BASIC_FETCH_FUNCS(symbol)
239 DEFINE_FETCH_symbol(string)
240 DEFINE_FETCH_symbol(string_size)
242 /* kprobes don't support file_offset fetch methods */
243 #define fetch_file_offset_u8 NULL
244 #define fetch_file_offset_u16 NULL
245 #define fetch_file_offset_u32 NULL
246 #define fetch_file_offset_u64 NULL
247 #define fetch_file_offset_string NULL
248 #define fetch_file_offset_string_size NULL
250 /* Fetch type information table */
251 const struct fetch_type kprobes_fetch_type_table[] = {
253 [FETCH_TYPE_STRING] = __ASSIGN_FETCH_TYPE("string", string, string,
254 sizeof(u32), 1, "__data_loc char[]"),
255 [FETCH_TYPE_STRSIZE] = __ASSIGN_FETCH_TYPE("string_size", u32,
256 string_size, sizeof(u32), 0, "u32"),
258 ASSIGN_FETCH_TYPE(u8, u8, 0),
259 ASSIGN_FETCH_TYPE(u16, u16, 0),
260 ASSIGN_FETCH_TYPE(u32, u32, 0),
261 ASSIGN_FETCH_TYPE(u64, u64, 0),
262 ASSIGN_FETCH_TYPE(s8, u8, 1),
263 ASSIGN_FETCH_TYPE(s16, u16, 1),
264 ASSIGN_FETCH_TYPE(s32, u32, 1),
265 ASSIGN_FETCH_TYPE(s64, u64, 1),
267 ASSIGN_FETCH_TYPE_END
271 * Allocate new trace_probe and initialize it (including kprobes).
273 static struct trace_kprobe *alloc_trace_kprobe(const char *group,
278 int nargs, bool is_return)
280 struct trace_kprobe *tk;
283 tk = kzalloc(SIZEOF_TRACE_KPROBE(nargs), GFP_KERNEL);
288 tk->symbol = kstrdup(symbol, GFP_KERNEL);
291 tk->rp.kp.symbol_name = tk->symbol;
292 tk->rp.kp.offset = offs;
294 tk->rp.kp.addr = addr;
297 tk->rp.handler = kretprobe_dispatcher;
299 tk->rp.kp.pre_handler = kprobe_dispatcher;
301 if (!event || !is_good_name(event)) {
306 tk->tp.call.class = &tk->tp.class;
307 tk->tp.call.name = kstrdup(event, GFP_KERNEL);
308 if (!tk->tp.call.name)
311 if (!group || !is_good_name(group)) {
316 tk->tp.class.system = kstrdup(group, GFP_KERNEL);
317 if (!tk->tp.class.system)
320 INIT_LIST_HEAD(&tk->list);
321 INIT_LIST_HEAD(&tk->tp.files);
324 kfree(tk->tp.call.name);
330 static void free_trace_kprobe(struct trace_kprobe *tk)
334 for (i = 0; i < tk->tp.nr_args; i++)
335 traceprobe_free_probe_arg(&tk->tp.args[i]);
337 kfree(tk->tp.call.class->system);
338 kfree(tk->tp.call.name);
343 static struct trace_kprobe *find_trace_kprobe(const char *event,
346 struct trace_kprobe *tk;
348 list_for_each_entry(tk, &probe_list, list)
349 if (strcmp(tk->tp.call.name, event) == 0 &&
350 strcmp(tk->tp.call.class->system, group) == 0)
357 * if the file is NULL, enable "perf" handler, or enable "trace" handler.
360 enable_trace_kprobe(struct trace_kprobe *tk, struct ftrace_event_file *file)
365 struct event_file_link *link;
367 link = kmalloc(sizeof(*link), GFP_KERNEL);
374 list_add_tail_rcu(&link->list, &tk->tp.files);
376 tk->tp.flags |= TP_FLAG_TRACE;
378 tk->tp.flags |= TP_FLAG_PROFILE;
380 if (trace_probe_is_registered(&tk->tp) && !trace_kprobe_has_gone(tk)) {
381 if (trace_kprobe_is_return(tk))
382 ret = enable_kretprobe(&tk->rp);
384 ret = enable_kprobe(&tk->rp.kp);
390 static struct event_file_link *
391 find_event_file_link(struct trace_probe *tp, struct ftrace_event_file *file)
393 struct event_file_link *link;
395 list_for_each_entry(link, &tp->files, list)
396 if (link->file == file)
403 * Disable trace_probe
404 * if the file is NULL, disable "perf" handler, or disable "trace" handler.
407 disable_trace_kprobe(struct trace_kprobe *tk, struct ftrace_event_file *file)
409 struct event_file_link *link = NULL;
414 link = find_event_file_link(&tk->tp, file);
420 list_del_rcu(&link->list);
422 if (!list_empty(&tk->tp.files))
425 tk->tp.flags &= ~TP_FLAG_TRACE;
427 tk->tp.flags &= ~TP_FLAG_PROFILE;
429 if (!trace_probe_is_enabled(&tk->tp) && trace_probe_is_registered(&tk->tp)) {
430 if (trace_kprobe_is_return(tk))
431 disable_kretprobe(&tk->rp);
433 disable_kprobe(&tk->rp.kp);
439 * Synchronize with kprobe_trace_func/kretprobe_trace_func
440 * to ensure disabled (all running handlers are finished).
441 * This is not only for kfree(), but also the caller,
442 * trace_remove_event_call() supposes it for releasing
443 * event_call related objects, which will be accessed in
444 * the kprobe_trace_func/kretprobe_trace_func.
447 kfree(link); /* Ignored if link == NULL */
453 /* Internal register function - just handle k*probes and flags */
454 static int __register_trace_kprobe(struct trace_kprobe *tk)
458 if (trace_probe_is_registered(&tk->tp))
461 for (i = 0; i < tk->tp.nr_args; i++)
462 traceprobe_update_arg(&tk->tp.args[i]);
464 /* Set/clear disabled flag according to tp->flag */
465 if (trace_probe_is_enabled(&tk->tp))
466 tk->rp.kp.flags &= ~KPROBE_FLAG_DISABLED;
468 tk->rp.kp.flags |= KPROBE_FLAG_DISABLED;
470 if (trace_kprobe_is_return(tk))
471 ret = register_kretprobe(&tk->rp);
473 ret = register_kprobe(&tk->rp.kp);
476 tk->tp.flags |= TP_FLAG_REGISTERED;
478 pr_warning("Could not insert probe at %s+%lu: %d\n",
479 trace_kprobe_symbol(tk), trace_kprobe_offset(tk), ret);
480 if (ret == -ENOENT && trace_kprobe_is_on_module(tk)) {
481 pr_warning("This probe might be able to register after"
482 "target module is loaded. Continue.\n");
484 } else if (ret == -EILSEQ) {
485 pr_warning("Probing address(0x%p) is not an "
486 "instruction boundary.\n",
495 /* Internal unregister function - just handle k*probes and flags */
496 static void __unregister_trace_kprobe(struct trace_kprobe *tk)
498 if (trace_probe_is_registered(&tk->tp)) {
499 if (trace_kprobe_is_return(tk))
500 unregister_kretprobe(&tk->rp);
502 unregister_kprobe(&tk->rp.kp);
503 tk->tp.flags &= ~TP_FLAG_REGISTERED;
504 /* Cleanup kprobe for reuse */
505 if (tk->rp.kp.symbol_name)
506 tk->rp.kp.addr = NULL;
510 /* Unregister a trace_probe and probe_event: call with locking probe_lock */
511 static int unregister_trace_kprobe(struct trace_kprobe *tk)
513 /* Enabled event can not be unregistered */
514 if (trace_probe_is_enabled(&tk->tp))
517 /* Will fail if probe is being used by ftrace or perf */
518 if (unregister_kprobe_event(tk))
521 __unregister_trace_kprobe(tk);
527 /* Register a trace_probe and probe_event */
528 static int register_trace_kprobe(struct trace_kprobe *tk)
530 struct trace_kprobe *old_tk;
533 mutex_lock(&probe_lock);
535 /* Delete old (same name) event if exist */
536 old_tk = find_trace_kprobe(tk->tp.call.name, tk->tp.call.class->system);
538 ret = unregister_trace_kprobe(old_tk);
541 free_trace_kprobe(old_tk);
544 /* Register new event */
545 ret = register_kprobe_event(tk);
547 pr_warning("Failed to register probe event(%d)\n", ret);
551 /* Register k*probe */
552 ret = __register_trace_kprobe(tk);
554 unregister_kprobe_event(tk);
556 list_add_tail(&tk->list, &probe_list);
559 mutex_unlock(&probe_lock);
563 /* Module notifier call back, checking event on the module */
564 static int trace_kprobe_module_callback(struct notifier_block *nb,
565 unsigned long val, void *data)
567 struct module *mod = data;
568 struct trace_kprobe *tk;
571 if (val != MODULE_STATE_COMING)
574 /* Update probes on coming module */
575 mutex_lock(&probe_lock);
576 list_for_each_entry(tk, &probe_list, list) {
577 if (trace_kprobe_within_module(tk, mod)) {
578 /* Don't need to check busy - this should have gone. */
579 __unregister_trace_kprobe(tk);
580 ret = __register_trace_kprobe(tk);
582 pr_warning("Failed to re-register probe %s on"
584 tk->tp.call.name, mod->name, ret);
587 mutex_unlock(&probe_lock);
592 static struct notifier_block trace_kprobe_module_nb = {
593 .notifier_call = trace_kprobe_module_callback,
594 .priority = 1 /* Invoked after kprobe module callback */
597 static int create_trace_kprobe(int argc, char **argv)
601 * - Add kprobe: p[:[GRP/]EVENT] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS]
602 * - Add kretprobe: r[:[GRP/]EVENT] [MOD:]KSYM[+0] [FETCHARGS]
604 * $retval : fetch return value
605 * $stack : fetch stack address
606 * $stackN : fetch Nth of stack (N:0-)
607 * @ADDR : fetch memory at ADDR (ADDR should be in kernel)
608 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol)
609 * %REG : fetch register REG
610 * Dereferencing memory fetch:
611 * +|-offs(ARG) : fetch memory at ARG +|- offs address.
612 * Alias name of args:
613 * NAME=FETCHARG : set NAME as alias of FETCHARG.
615 * FETCHARG:TYPE : use TYPE instead of unsigned long.
617 struct trace_kprobe *tk;
619 bool is_return = false, is_delete = false;
620 char *symbol = NULL, *event = NULL, *group = NULL;
622 unsigned long offset = 0;
624 char buf[MAX_EVENT_NAME_LEN];
626 /* argc must be >= 1 */
627 if (argv[0][0] == 'p')
629 else if (argv[0][0] == 'r')
631 else if (argv[0][0] == '-')
634 pr_info("Probe definition must be started with 'p', 'r' or"
639 if (argv[0][1] == ':') {
641 if (strchr(event, '/')) {
643 event = strchr(group, '/') + 1;
645 if (strlen(group) == 0) {
646 pr_info("Group name is not specified\n");
650 if (strlen(event) == 0) {
651 pr_info("Event name is not specified\n");
656 group = KPROBE_EVENT_SYSTEM;
660 pr_info("Delete command needs an event name.\n");
663 mutex_lock(&probe_lock);
664 tk = find_trace_kprobe(event, group);
666 mutex_unlock(&probe_lock);
667 pr_info("Event %s/%s doesn't exist.\n", group, event);
670 /* delete an event */
671 ret = unregister_trace_kprobe(tk);
673 free_trace_kprobe(tk);
674 mutex_unlock(&probe_lock);
679 pr_info("Probe point is not specified.\n");
682 if (isdigit(argv[1][0])) {
684 pr_info("Return probe point must be a symbol.\n");
687 /* an address specified */
688 ret = kstrtoul(&argv[1][0], 0, (unsigned long *)&addr);
690 pr_info("Failed to parse address.\n");
694 /* a symbol specified */
696 /* TODO: support .init module functions */
697 ret = traceprobe_split_symbol_offset(symbol, &offset);
699 pr_info("Failed to parse symbol.\n");
702 if (offset && is_return) {
703 pr_info("Return probe must be used without offset.\n");
707 argc -= 2; argv += 2;
711 /* Make a new event name */
713 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_%ld",
714 is_return ? 'r' : 'p', symbol, offset);
716 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_0x%p",
717 is_return ? 'r' : 'p', addr);
720 tk = alloc_trace_kprobe(group, event, addr, symbol, offset, argc,
723 pr_info("Failed to allocate trace_probe.(%d)\n",
728 /* parse arguments */
730 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) {
731 struct probe_arg *parg = &tk->tp.args[i];
733 /* Increment count for freeing args in error case */
736 /* Parse argument name */
737 arg = strchr(argv[i], '=');
740 parg->name = kstrdup(argv[i], GFP_KERNEL);
743 /* If argument name is omitted, set "argN" */
744 snprintf(buf, MAX_EVENT_NAME_LEN, "arg%d", i + 1);
745 parg->name = kstrdup(buf, GFP_KERNEL);
749 pr_info("Failed to allocate argument[%d] name.\n", i);
754 if (!is_good_name(parg->name)) {
755 pr_info("Invalid argument[%d] name: %s\n",
761 if (traceprobe_conflict_field_name(parg->name,
763 pr_info("Argument[%d] name '%s' conflicts with "
764 "another field.\n", i, argv[i]);
769 /* Parse fetch argument */
770 ret = traceprobe_parse_probe_arg(arg, &tk->tp.size, parg,
773 pr_info("Parse error at argument[%d]. (%d)\n", i, ret);
778 ret = register_trace_kprobe(tk);
784 free_trace_kprobe(tk);
788 static int release_all_trace_kprobes(void)
790 struct trace_kprobe *tk;
793 mutex_lock(&probe_lock);
794 /* Ensure no probe is in use. */
795 list_for_each_entry(tk, &probe_list, list)
796 if (trace_probe_is_enabled(&tk->tp)) {
800 /* TODO: Use batch unregistration */
801 while (!list_empty(&probe_list)) {
802 tk = list_entry(probe_list.next, struct trace_kprobe, list);
803 ret = unregister_trace_kprobe(tk);
806 free_trace_kprobe(tk);
810 mutex_unlock(&probe_lock);
815 /* Probes listing interfaces */
816 static void *probes_seq_start(struct seq_file *m, loff_t *pos)
818 mutex_lock(&probe_lock);
819 return seq_list_start(&probe_list, *pos);
822 static void *probes_seq_next(struct seq_file *m, void *v, loff_t *pos)
824 return seq_list_next(v, &probe_list, pos);
827 static void probes_seq_stop(struct seq_file *m, void *v)
829 mutex_unlock(&probe_lock);
832 static int probes_seq_show(struct seq_file *m, void *v)
834 struct trace_kprobe *tk = v;
837 seq_printf(m, "%c", trace_kprobe_is_return(tk) ? 'r' : 'p');
838 seq_printf(m, ":%s/%s", tk->tp.call.class->system, tk->tp.call.name);
841 seq_printf(m, " 0x%p", tk->rp.kp.addr);
842 else if (tk->rp.kp.offset)
843 seq_printf(m, " %s+%u", trace_kprobe_symbol(tk),
846 seq_printf(m, " %s", trace_kprobe_symbol(tk));
848 for (i = 0; i < tk->tp.nr_args; i++)
849 seq_printf(m, " %s=%s", tk->tp.args[i].name, tk->tp.args[i].comm);
855 static const struct seq_operations probes_seq_op = {
856 .start = probes_seq_start,
857 .next = probes_seq_next,
858 .stop = probes_seq_stop,
859 .show = probes_seq_show
862 static int probes_open(struct inode *inode, struct file *file)
866 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
867 ret = release_all_trace_kprobes();
872 return seq_open(file, &probes_seq_op);
875 static ssize_t probes_write(struct file *file, const char __user *buffer,
876 size_t count, loff_t *ppos)
878 return traceprobe_probes_write(file, buffer, count, ppos,
879 create_trace_kprobe);
882 static const struct file_operations kprobe_events_ops = {
883 .owner = THIS_MODULE,
887 .release = seq_release,
888 .write = probes_write,
891 /* Probes profiling interfaces */
892 static int probes_profile_seq_show(struct seq_file *m, void *v)
894 struct trace_kprobe *tk = v;
896 seq_printf(m, " %-44s %15lu %15lu\n", tk->tp.call.name, tk->nhit,
902 static const struct seq_operations profile_seq_op = {
903 .start = probes_seq_start,
904 .next = probes_seq_next,
905 .stop = probes_seq_stop,
906 .show = probes_profile_seq_show
909 static int profile_open(struct inode *inode, struct file *file)
911 return seq_open(file, &profile_seq_op);
914 static const struct file_operations kprobe_profile_ops = {
915 .owner = THIS_MODULE,
916 .open = profile_open,
919 .release = seq_release,
923 static __kprobes void
924 __kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs,
925 struct ftrace_event_file *ftrace_file)
927 struct kprobe_trace_entry_head *entry;
928 struct ring_buffer_event *event;
929 struct ring_buffer *buffer;
931 unsigned long irq_flags;
932 struct ftrace_event_call *call = &tk->tp.call;
934 WARN_ON(call != ftrace_file->event_call);
936 if (ftrace_trigger_soft_disabled(ftrace_file))
939 local_save_flags(irq_flags);
940 pc = preempt_count();
942 dsize = __get_data_size(&tk->tp, regs);
943 size = sizeof(*entry) + tk->tp.size + dsize;
945 event = trace_event_buffer_lock_reserve(&buffer, ftrace_file,
947 size, irq_flags, pc);
951 entry = ring_buffer_event_data(event);
952 entry->ip = (unsigned long)tk->rp.kp.addr;
953 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
955 event_trigger_unlock_commit_regs(ftrace_file, buffer, event,
956 entry, irq_flags, pc, regs);
959 static __kprobes void
960 kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs)
962 struct event_file_link *link;
964 list_for_each_entry_rcu(link, &tk->tp.files, list)
965 __kprobe_trace_func(tk, regs, link->file);
968 /* Kretprobe handler */
969 static __kprobes void
970 __kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
971 struct pt_regs *regs,
972 struct ftrace_event_file *ftrace_file)
974 struct kretprobe_trace_entry_head *entry;
975 struct ring_buffer_event *event;
976 struct ring_buffer *buffer;
978 unsigned long irq_flags;
979 struct ftrace_event_call *call = &tk->tp.call;
981 WARN_ON(call != ftrace_file->event_call);
983 if (ftrace_trigger_soft_disabled(ftrace_file))
986 local_save_flags(irq_flags);
987 pc = preempt_count();
989 dsize = __get_data_size(&tk->tp, regs);
990 size = sizeof(*entry) + tk->tp.size + dsize;
992 event = trace_event_buffer_lock_reserve(&buffer, ftrace_file,
994 size, irq_flags, pc);
998 entry = ring_buffer_event_data(event);
999 entry->func = (unsigned long)tk->rp.kp.addr;
1000 entry->ret_ip = (unsigned long)ri->ret_addr;
1001 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
1003 event_trigger_unlock_commit_regs(ftrace_file, buffer, event,
1004 entry, irq_flags, pc, regs);
1007 static __kprobes void
1008 kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1009 struct pt_regs *regs)
1011 struct event_file_link *link;
1013 list_for_each_entry_rcu(link, &tk->tp.files, list)
1014 __kretprobe_trace_func(tk, ri, regs, link->file);
1017 /* Event entry printers */
1018 static enum print_line_t
1019 print_kprobe_event(struct trace_iterator *iter, int flags,
1020 struct trace_event *event)
1022 struct kprobe_trace_entry_head *field;
1023 struct trace_seq *s = &iter->seq;
1024 struct trace_probe *tp;
1028 field = (struct kprobe_trace_entry_head *)iter->ent;
1029 tp = container_of(event, struct trace_probe, call.event);
1031 if (!trace_seq_printf(s, "%s: (", tp->call.name))
1034 if (!seq_print_ip_sym(s, field->ip, flags | TRACE_ITER_SYM_OFFSET))
1037 if (!trace_seq_puts(s, ")"))
1040 data = (u8 *)&field[1];
1041 for (i = 0; i < tp->nr_args; i++)
1042 if (!tp->args[i].type->print(s, tp->args[i].name,
1043 data + tp->args[i].offset, field))
1046 if (!trace_seq_puts(s, "\n"))
1049 return TRACE_TYPE_HANDLED;
1051 return TRACE_TYPE_PARTIAL_LINE;
1054 static enum print_line_t
1055 print_kretprobe_event(struct trace_iterator *iter, int flags,
1056 struct trace_event *event)
1058 struct kretprobe_trace_entry_head *field;
1059 struct trace_seq *s = &iter->seq;
1060 struct trace_probe *tp;
1064 field = (struct kretprobe_trace_entry_head *)iter->ent;
1065 tp = container_of(event, struct trace_probe, call.event);
1067 if (!trace_seq_printf(s, "%s: (", tp->call.name))
1070 if (!seq_print_ip_sym(s, field->ret_ip, flags | TRACE_ITER_SYM_OFFSET))
1073 if (!trace_seq_puts(s, " <- "))
1076 if (!seq_print_ip_sym(s, field->func, flags & ~TRACE_ITER_SYM_OFFSET))
1079 if (!trace_seq_puts(s, ")"))
1082 data = (u8 *)&field[1];
1083 for (i = 0; i < tp->nr_args; i++)
1084 if (!tp->args[i].type->print(s, tp->args[i].name,
1085 data + tp->args[i].offset, field))
1088 if (!trace_seq_puts(s, "\n"))
1091 return TRACE_TYPE_HANDLED;
1093 return TRACE_TYPE_PARTIAL_LINE;
1097 static int kprobe_event_define_fields(struct ftrace_event_call *event_call)
1100 struct kprobe_trace_entry_head field;
1101 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data;
1103 DEFINE_FIELD(unsigned long, ip, FIELD_STRING_IP, 0);
1104 /* Set argument names as fields */
1105 for (i = 0; i < tk->tp.nr_args; i++) {
1106 struct probe_arg *parg = &tk->tp.args[i];
1108 ret = trace_define_field(event_call, parg->type->fmttype,
1110 sizeof(field) + parg->offset,
1112 parg->type->is_signed,
1120 static int kretprobe_event_define_fields(struct ftrace_event_call *event_call)
1123 struct kretprobe_trace_entry_head field;
1124 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data;
1126 DEFINE_FIELD(unsigned long, func, FIELD_STRING_FUNC, 0);
1127 DEFINE_FIELD(unsigned long, ret_ip, FIELD_STRING_RETIP, 0);
1128 /* Set argument names as fields */
1129 for (i = 0; i < tk->tp.nr_args; i++) {
1130 struct probe_arg *parg = &tk->tp.args[i];
1132 ret = trace_define_field(event_call, parg->type->fmttype,
1134 sizeof(field) + parg->offset,
1136 parg->type->is_signed,
1144 #ifdef CONFIG_PERF_EVENTS
1146 /* Kprobe profile handler */
1147 static __kprobes void
1148 kprobe_perf_func(struct trace_kprobe *tk, struct pt_regs *regs)
1150 struct ftrace_event_call *call = &tk->tp.call;
1151 struct kprobe_trace_entry_head *entry;
1152 struct hlist_head *head;
1153 int size, __size, dsize;
1156 head = this_cpu_ptr(call->perf_events);
1157 if (hlist_empty(head))
1160 dsize = __get_data_size(&tk->tp, regs);
1161 __size = sizeof(*entry) + tk->tp.size + dsize;
1162 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1163 size -= sizeof(u32);
1165 entry = perf_trace_buf_prepare(size, call->event.type, regs, &rctx);
1169 entry->ip = (unsigned long)tk->rp.kp.addr;
1170 memset(&entry[1], 0, dsize);
1171 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
1172 perf_trace_buf_submit(entry, size, rctx, 0, 1, regs, head, NULL);
1175 /* Kretprobe profile handler */
1176 static __kprobes void
1177 kretprobe_perf_func(struct trace_kprobe *tk, struct kretprobe_instance *ri,
1178 struct pt_regs *regs)
1180 struct ftrace_event_call *call = &tk->tp.call;
1181 struct kretprobe_trace_entry_head *entry;
1182 struct hlist_head *head;
1183 int size, __size, dsize;
1186 head = this_cpu_ptr(call->perf_events);
1187 if (hlist_empty(head))
1190 dsize = __get_data_size(&tk->tp, regs);
1191 __size = sizeof(*entry) + tk->tp.size + dsize;
1192 size = ALIGN(__size + sizeof(u32), sizeof(u64));
1193 size -= sizeof(u32);
1195 entry = perf_trace_buf_prepare(size, call->event.type, regs, &rctx);
1199 entry->func = (unsigned long)tk->rp.kp.addr;
1200 entry->ret_ip = (unsigned long)ri->ret_addr;
1201 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize);
1202 perf_trace_buf_submit(entry, size, rctx, 0, 1, regs, head, NULL);
1204 #endif /* CONFIG_PERF_EVENTS */
1207 * called by perf_trace_init() or __ftrace_set_clr_event() under event_mutex.
1209 * kprobe_trace_self_tests_init() does enable_trace_probe/disable_trace_probe
1210 * lockless, but we can't race with this __init function.
1213 int kprobe_register(struct ftrace_event_call *event,
1214 enum trace_reg type, void *data)
1216 struct trace_kprobe *tk = (struct trace_kprobe *)event->data;
1217 struct ftrace_event_file *file = data;
1220 case TRACE_REG_REGISTER:
1221 return enable_trace_kprobe(tk, file);
1222 case TRACE_REG_UNREGISTER:
1223 return disable_trace_kprobe(tk, file);
1225 #ifdef CONFIG_PERF_EVENTS
1226 case TRACE_REG_PERF_REGISTER:
1227 return enable_trace_kprobe(tk, NULL);
1228 case TRACE_REG_PERF_UNREGISTER:
1229 return disable_trace_kprobe(tk, NULL);
1230 case TRACE_REG_PERF_OPEN:
1231 case TRACE_REG_PERF_CLOSE:
1232 case TRACE_REG_PERF_ADD:
1233 case TRACE_REG_PERF_DEL:
1241 int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs)
1243 struct trace_kprobe *tk = container_of(kp, struct trace_kprobe, rp.kp);
1247 if (tk->tp.flags & TP_FLAG_TRACE)
1248 kprobe_trace_func(tk, regs);
1249 #ifdef CONFIG_PERF_EVENTS
1250 if (tk->tp.flags & TP_FLAG_PROFILE)
1251 kprobe_perf_func(tk, regs);
1253 return 0; /* We don't tweek kernel, so just return 0 */
1257 int kretprobe_dispatcher(struct kretprobe_instance *ri, struct pt_regs *regs)
1259 struct trace_kprobe *tk = container_of(ri->rp, struct trace_kprobe, rp);
1263 if (tk->tp.flags & TP_FLAG_TRACE)
1264 kretprobe_trace_func(tk, ri, regs);
1265 #ifdef CONFIG_PERF_EVENTS
1266 if (tk->tp.flags & TP_FLAG_PROFILE)
1267 kretprobe_perf_func(tk, ri, regs);
1269 return 0; /* We don't tweek kernel, so just return 0 */
1272 static struct trace_event_functions kretprobe_funcs = {
1273 .trace = print_kretprobe_event
1276 static struct trace_event_functions kprobe_funcs = {
1277 .trace = print_kprobe_event
1280 static int register_kprobe_event(struct trace_kprobe *tk)
1282 struct ftrace_event_call *call = &tk->tp.call;
1285 /* Initialize ftrace_event_call */
1286 INIT_LIST_HEAD(&call->class->fields);
1287 if (trace_kprobe_is_return(tk)) {
1288 call->event.funcs = &kretprobe_funcs;
1289 call->class->define_fields = kretprobe_event_define_fields;
1291 call->event.funcs = &kprobe_funcs;
1292 call->class->define_fields = kprobe_event_define_fields;
1294 if (set_print_fmt(&tk->tp, trace_kprobe_is_return(tk)) < 0)
1296 ret = register_ftrace_event(&call->event);
1298 kfree(call->print_fmt);
1302 call->class->reg = kprobe_register;
1304 ret = trace_add_event_call(call);
1306 pr_info("Failed to register kprobe event: %s\n", call->name);
1307 kfree(call->print_fmt);
1308 unregister_ftrace_event(&call->event);
1313 static int unregister_kprobe_event(struct trace_kprobe *tk)
1317 /* tp->event is unregistered in trace_remove_event_call() */
1318 ret = trace_remove_event_call(&tk->tp.call);
1320 kfree(tk->tp.call.print_fmt);
1324 /* Make a debugfs interface for controlling probe points */
1325 static __init int init_kprobe_trace(void)
1327 struct dentry *d_tracer;
1328 struct dentry *entry;
1330 if (register_module_notifier(&trace_kprobe_module_nb))
1333 d_tracer = tracing_init_dentry();
1337 entry = debugfs_create_file("kprobe_events", 0644, d_tracer,
1338 NULL, &kprobe_events_ops);
1340 /* Event list interface */
1342 pr_warning("Could not create debugfs "
1343 "'kprobe_events' entry\n");
1345 /* Profile interface */
1346 entry = debugfs_create_file("kprobe_profile", 0444, d_tracer,
1347 NULL, &kprobe_profile_ops);
1350 pr_warning("Could not create debugfs "
1351 "'kprobe_profile' entry\n");
1354 fs_initcall(init_kprobe_trace);
1357 #ifdef CONFIG_FTRACE_STARTUP_TEST
1360 * The "__used" keeps gcc from removing the function symbol
1361 * from the kallsyms table.
1363 static __used int kprobe_trace_selftest_target(int a1, int a2, int a3,
1364 int a4, int a5, int a6)
1366 return a1 + a2 + a3 + a4 + a5 + a6;
1369 static struct ftrace_event_file *
1370 find_trace_probe_file(struct trace_kprobe *tk, struct trace_array *tr)
1372 struct ftrace_event_file *file;
1374 list_for_each_entry(file, &tr->events, list)
1375 if (file->event_call == &tk->tp.call)
1382 * Nobody but us can call enable_trace_kprobe/disable_trace_kprobe at this
1383 * stage, we can do this lockless.
1385 static __init int kprobe_trace_self_tests_init(void)
1388 int (*target)(int, int, int, int, int, int);
1389 struct trace_kprobe *tk;
1390 struct ftrace_event_file *file;
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);