1 // SPDX-License-Identifier: GPL-2.0
3 * uprobes-based tracing events
5 * Copyright (C) IBM Corporation, 2010-2012
6 * Author: Srikar Dronamraju <srikar@linux.vnet.ibm.com>
8 #define pr_fmt(fmt) "trace_uprobe: " fmt
10 #include <linux/ctype.h>
11 #include <linux/module.h>
12 #include <linux/uaccess.h>
13 #include <linux/uprobes.h>
14 #include <linux/namei.h>
15 #include <linux/string.h>
16 #include <linux/rculist.h>
18 #include "trace_dynevent.h"
19 #include "trace_probe.h"
20 #include "trace_probe_tmpl.h"
22 #define UPROBE_EVENT_SYSTEM "uprobes"
24 struct uprobe_trace_entry_head {
25 struct trace_entry ent;
26 unsigned long vaddr[];
29 #define SIZEOF_TRACE_ENTRY(is_return) \
30 (sizeof(struct uprobe_trace_entry_head) + \
31 sizeof(unsigned long) * (is_return ? 2 : 1))
33 #define DATAOF_TRACE_ENTRY(entry, is_return) \
34 ((void*)(entry) + SIZEOF_TRACE_ENTRY(is_return))
36 struct trace_uprobe_filter {
39 struct list_head perf_events;
42 static int trace_uprobe_create(int argc, const char **argv);
43 static int trace_uprobe_show(struct seq_file *m, struct dyn_event *ev);
44 static int trace_uprobe_release(struct dyn_event *ev);
45 static bool trace_uprobe_is_busy(struct dyn_event *ev);
46 static bool trace_uprobe_match(const char *system, const char *event,
47 struct dyn_event *ev);
49 static struct dyn_event_operations trace_uprobe_ops = {
50 .create = trace_uprobe_create,
51 .show = trace_uprobe_show,
52 .is_busy = trace_uprobe_is_busy,
53 .free = trace_uprobe_release,
54 .match = trace_uprobe_match,
58 * uprobe event core functions
61 struct dyn_event devent;
62 struct trace_uprobe_filter filter;
63 struct uprobe_consumer consumer;
68 unsigned long ref_ctr_offset;
70 struct trace_probe tp;
73 static bool is_trace_uprobe(struct dyn_event *ev)
75 return ev->ops == &trace_uprobe_ops;
78 static struct trace_uprobe *to_trace_uprobe(struct dyn_event *ev)
80 return container_of(ev, struct trace_uprobe, devent);
84 * for_each_trace_uprobe - iterate over the trace_uprobe list
85 * @pos: the struct trace_uprobe * for each entry
86 * @dpos: the struct dyn_event * to use as a loop cursor
88 #define for_each_trace_uprobe(pos, dpos) \
89 for_each_dyn_event(dpos) \
90 if (is_trace_uprobe(dpos) && (pos = to_trace_uprobe(dpos)))
92 #define SIZEOF_TRACE_UPROBE(n) \
93 (offsetof(struct trace_uprobe, tp.args) + \
94 (sizeof(struct probe_arg) * (n)))
96 static int register_uprobe_event(struct trace_uprobe *tu);
97 static int unregister_uprobe_event(struct trace_uprobe *tu);
99 struct uprobe_dispatch_data {
100 struct trace_uprobe *tu;
101 unsigned long bp_addr;
104 static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs);
105 static int uretprobe_dispatcher(struct uprobe_consumer *con,
106 unsigned long func, struct pt_regs *regs);
108 #ifdef CONFIG_STACK_GROWSUP
109 static unsigned long adjust_stack_addr(unsigned long addr, unsigned int n)
111 return addr - (n * sizeof(long));
114 static unsigned long adjust_stack_addr(unsigned long addr, unsigned int n)
116 return addr + (n * sizeof(long));
120 static unsigned long get_user_stack_nth(struct pt_regs *regs, unsigned int n)
123 unsigned long addr = user_stack_pointer(regs);
125 addr = adjust_stack_addr(addr, n);
127 if (copy_from_user(&ret, (void __force __user *) addr, sizeof(ret)))
134 * Uprobes-specific fetch functions
136 static nokprobe_inline int
137 probe_mem_read(void *dest, void *src, size_t size)
139 void __user *vaddr = (void __force __user *)src;
141 return copy_from_user(dest, vaddr, size) ? -EFAULT : 0;
144 static nokprobe_inline int
145 probe_mem_read_user(void *dest, void *src, size_t size)
147 return probe_mem_read(dest, src, size);
151 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
152 * length and relative data location.
154 static nokprobe_inline int
155 fetch_store_string(unsigned long addr, void *dest, void *base)
158 u32 loc = *(u32 *)dest;
159 int maxlen = get_loc_len(loc);
160 u8 *dst = get_loc_data(dest, base);
161 void __user *src = (void __force __user *) addr;
163 if (unlikely(!maxlen))
166 if (addr == FETCH_TOKEN_COMM)
167 ret = strlcpy(dst, current->comm, maxlen);
169 ret = strncpy_from_user(dst, src, maxlen);
175 * Include the terminating null byte. In this case it
176 * was copied by strncpy_from_user but not accounted
180 *(u32 *)dest = make_data_loc(ret, (void *)dst - base);
186 static nokprobe_inline int
187 fetch_store_string_user(unsigned long addr, void *dest, void *base)
189 return fetch_store_string(addr, dest, base);
192 /* Return the length of string -- including null terminal byte */
193 static nokprobe_inline int
194 fetch_store_strlen(unsigned long addr)
197 void __user *vaddr = (void __force __user *) addr;
199 if (addr == FETCH_TOKEN_COMM)
200 len = strlen(current->comm) + 1;
202 len = strnlen_user(vaddr, MAX_STRING_SIZE);
204 return (len > MAX_STRING_SIZE) ? 0 : len;
207 static nokprobe_inline int
208 fetch_store_strlen_user(unsigned long addr)
210 return fetch_store_strlen(addr);
213 static unsigned long translate_user_vaddr(unsigned long file_offset)
215 unsigned long base_addr;
216 struct uprobe_dispatch_data *udd;
218 udd = (void *) current->utask->vaddr;
220 base_addr = udd->bp_addr - udd->tu->offset;
221 return base_addr + file_offset;
224 /* Note that we don't verify it, since the code does not come from user space */
226 process_fetch_insn(struct fetch_insn *code, struct pt_regs *regs, void *dest,
231 /* 1st stage: get value from context */
234 val = regs_get_register(regs, code->param);
237 val = get_user_stack_nth(regs, code->param);
239 case FETCH_OP_STACKP:
240 val = user_stack_pointer(regs);
242 case FETCH_OP_RETVAL:
243 val = regs_return_value(regs);
246 val = code->immediate;
249 val = FETCH_TOKEN_COMM;
252 val = translate_user_vaddr(code->immediate);
259 return process_fetch_insn_bottom(code, val, dest, base);
261 NOKPROBE_SYMBOL(process_fetch_insn)
263 static inline void init_trace_uprobe_filter(struct trace_uprobe_filter *filter)
265 rwlock_init(&filter->rwlock);
266 filter->nr_systemwide = 0;
267 INIT_LIST_HEAD(&filter->perf_events);
270 static inline bool uprobe_filter_is_empty(struct trace_uprobe_filter *filter)
272 return !filter->nr_systemwide && list_empty(&filter->perf_events);
275 static inline bool is_ret_probe(struct trace_uprobe *tu)
277 return tu->consumer.ret_handler != NULL;
280 static bool trace_uprobe_is_busy(struct dyn_event *ev)
282 struct trace_uprobe *tu = to_trace_uprobe(ev);
284 return trace_probe_is_enabled(&tu->tp);
287 static bool trace_uprobe_match(const char *system, const char *event,
288 struct dyn_event *ev)
290 struct trace_uprobe *tu = to_trace_uprobe(ev);
292 return strcmp(trace_probe_name(&tu->tp), event) == 0 &&
293 (!system || strcmp(trace_probe_group_name(&tu->tp), system) == 0);
296 static nokprobe_inline struct trace_uprobe *
297 trace_uprobe_primary_from_call(struct trace_event_call *call)
299 struct trace_probe *tp;
301 tp = trace_probe_primary_from_call(call);
302 if (WARN_ON_ONCE(!tp))
305 return container_of(tp, struct trace_uprobe, tp);
309 * Allocate new trace_uprobe and initialize it (including uprobes).
311 static struct trace_uprobe *
312 alloc_trace_uprobe(const char *group, const char *event, int nargs, bool is_ret)
314 struct trace_uprobe *tu;
317 tu = kzalloc(SIZEOF_TRACE_UPROBE(nargs), GFP_KERNEL);
319 return ERR_PTR(-ENOMEM);
321 ret = trace_probe_init(&tu->tp, event, group);
325 dyn_event_init(&tu->devent, &trace_uprobe_ops);
326 tu->consumer.handler = uprobe_dispatcher;
328 tu->consumer.ret_handler = uretprobe_dispatcher;
329 init_trace_uprobe_filter(&tu->filter);
338 static void free_trace_uprobe(struct trace_uprobe *tu)
344 trace_probe_cleanup(&tu->tp);
349 static struct trace_uprobe *find_probe_event(const char *event, const char *group)
351 struct dyn_event *pos;
352 struct trace_uprobe *tu;
354 for_each_trace_uprobe(tu, pos)
355 if (strcmp(trace_probe_name(&tu->tp), event) == 0 &&
356 strcmp(trace_probe_group_name(&tu->tp), group) == 0)
362 /* Unregister a trace_uprobe and probe_event */
363 static int unregister_trace_uprobe(struct trace_uprobe *tu)
367 ret = unregister_uprobe_event(tu);
371 dyn_event_remove(&tu->devent);
372 free_trace_uprobe(tu);
377 * Uprobe with multiple reference counter is not allowed. i.e.
378 * If inode and offset matches, reference counter offset *must*
379 * match as well. Though, there is one exception: If user is
380 * replacing old trace_uprobe with new one(same group/event),
381 * then we allow same uprobe with new reference counter as far
382 * as the new one does not conflict with any other existing
385 static struct trace_uprobe *find_old_trace_uprobe(struct trace_uprobe *new)
387 struct dyn_event *pos;
388 struct trace_uprobe *tmp, *old = NULL;
389 struct inode *new_inode = d_real_inode(new->path.dentry);
391 old = find_probe_event(trace_probe_name(&new->tp),
392 trace_probe_group_name(&new->tp));
394 for_each_trace_uprobe(tmp, pos) {
395 if ((old ? old != tmp : true) &&
396 new_inode == d_real_inode(tmp->path.dentry) &&
397 new->offset == tmp->offset &&
398 new->ref_ctr_offset != tmp->ref_ctr_offset) {
399 pr_warn("Reference counter offset mismatch.");
400 return ERR_PTR(-EINVAL);
406 /* Register a trace_uprobe and probe_event */
407 static int register_trace_uprobe(struct trace_uprobe *tu)
409 struct trace_uprobe *old_tu;
412 mutex_lock(&event_mutex);
414 /* register as an event */
415 old_tu = find_old_trace_uprobe(tu);
416 if (IS_ERR(old_tu)) {
417 ret = PTR_ERR(old_tu);
422 /* delete old event */
423 ret = unregister_trace_uprobe(old_tu);
428 ret = register_uprobe_event(tu);
430 pr_warn("Failed to register probe event(%d)\n", ret);
434 dyn_event_add(&tu->devent);
437 mutex_unlock(&event_mutex);
444 * - Add uprobe: p|r[:[GRP/]EVENT] PATH:OFFSET [FETCHARGS]
446 static int trace_uprobe_create(int argc, const char **argv)
448 struct trace_uprobe *tu;
449 const char *event = NULL, *group = UPROBE_EVENT_SYSTEM;
450 char *arg, *filename, *rctr, *rctr_end, *tmp;
451 char buf[MAX_EVENT_NAME_LEN];
453 unsigned long offset, ref_ctr_offset;
454 bool is_return = false;
460 switch (argv[0][0]) {
473 if (argv[0][1] == ':')
476 if (!strchr(argv[1], '/'))
479 filename = kstrdup(argv[1], GFP_KERNEL);
483 /* Find the last occurrence, in case the path contains ':' too. */
484 arg = strrchr(filename, ':');
485 if (!arg || !isdigit(arg[1])) {
490 trace_probe_log_init("trace_uprobe", argc, argv);
491 trace_probe_log_set_index(1); /* filename is the 2nd argument */
494 ret = kern_path(filename, LOOKUP_FOLLOW, &path);
496 trace_probe_log_err(0, FILE_NOT_FOUND);
498 trace_probe_log_clear();
501 if (!d_is_reg(path.dentry)) {
502 trace_probe_log_err(0, NO_REGULAR_FILE);
504 goto fail_address_parse;
507 /* Parse reference counter offset if specified. */
508 rctr = strchr(arg, '(');
510 rctr_end = strchr(rctr, ')');
513 rctr_end = rctr + strlen(rctr);
514 trace_probe_log_err(rctr_end - filename,
516 goto fail_address_parse;
517 } else if (rctr_end[1] != '\0') {
519 trace_probe_log_err(rctr_end + 1 - filename,
521 goto fail_address_parse;
526 ret = kstrtoul(rctr, 0, &ref_ctr_offset);
528 trace_probe_log_err(rctr - filename, BAD_REFCNT);
529 goto fail_address_parse;
533 /* Parse uprobe offset. */
534 ret = kstrtoul(arg, 0, &offset);
536 trace_probe_log_err(arg - filename, BAD_UPROBE_OFFS);
537 goto fail_address_parse;
541 trace_probe_log_set_index(0);
543 ret = traceprobe_parse_event_name(&event, &group, buf,
546 goto fail_address_parse;
551 tail = kstrdup(kbasename(filename), GFP_KERNEL);
554 goto fail_address_parse;
557 ptr = strpbrk(tail, ".-_");
561 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_0x%lx", 'p', tail, offset);
569 tu = alloc_trace_uprobe(group, event, argc, is_return);
572 /* This must return -ENOMEM otherwise there is a bug */
573 WARN_ON_ONCE(ret != -ENOMEM);
574 goto fail_address_parse;
577 tu->ref_ctr_offset = ref_ctr_offset;
579 tu->filename = filename;
581 /* parse arguments */
582 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) {
583 tmp = kstrdup(argv[i], GFP_KERNEL);
589 trace_probe_log_set_index(i + 2);
590 ret = traceprobe_parse_probe_arg(&tu->tp, i, tmp,
591 is_return ? TPARG_FL_RETURN : 0);
597 ret = traceprobe_set_print_fmt(&tu->tp, is_ret_probe(tu));
601 ret = register_trace_uprobe(tu);
606 free_trace_uprobe(tu);
608 trace_probe_log_clear();
612 trace_probe_log_clear();
619 static int create_or_delete_trace_uprobe(int argc, char **argv)
623 if (argv[0][0] == '-')
624 return dyn_event_release(argc, argv, &trace_uprobe_ops);
626 ret = trace_uprobe_create(argc, (const char **)argv);
627 return ret == -ECANCELED ? -EINVAL : ret;
630 static int trace_uprobe_release(struct dyn_event *ev)
632 struct trace_uprobe *tu = to_trace_uprobe(ev);
634 return unregister_trace_uprobe(tu);
637 /* Probes listing interfaces */
638 static int trace_uprobe_show(struct seq_file *m, struct dyn_event *ev)
640 struct trace_uprobe *tu = to_trace_uprobe(ev);
641 char c = is_ret_probe(tu) ? 'r' : 'p';
644 seq_printf(m, "%c:%s/%s %s:0x%0*lx", c, trace_probe_group_name(&tu->tp),
645 trace_probe_name(&tu->tp), tu->filename,
646 (int)(sizeof(void *) * 2), tu->offset);
648 if (tu->ref_ctr_offset)
649 seq_printf(m, "(0x%lx)", tu->ref_ctr_offset);
651 for (i = 0; i < tu->tp.nr_args; i++)
652 seq_printf(m, " %s=%s", tu->tp.args[i].name, tu->tp.args[i].comm);
658 static int probes_seq_show(struct seq_file *m, void *v)
660 struct dyn_event *ev = v;
662 if (!is_trace_uprobe(ev))
665 return trace_uprobe_show(m, ev);
668 static const struct seq_operations probes_seq_op = {
669 .start = dyn_event_seq_start,
670 .next = dyn_event_seq_next,
671 .stop = dyn_event_seq_stop,
672 .show = probes_seq_show
675 static int probes_open(struct inode *inode, struct file *file)
679 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
680 ret = dyn_events_release_all(&trace_uprobe_ops);
685 return seq_open(file, &probes_seq_op);
688 static ssize_t probes_write(struct file *file, const char __user *buffer,
689 size_t count, loff_t *ppos)
691 return trace_parse_run_command(file, buffer, count, ppos,
692 create_or_delete_trace_uprobe);
695 static const struct file_operations uprobe_events_ops = {
696 .owner = THIS_MODULE,
700 .release = seq_release,
701 .write = probes_write,
704 /* Probes profiling interfaces */
705 static int probes_profile_seq_show(struct seq_file *m, void *v)
707 struct dyn_event *ev = v;
708 struct trace_uprobe *tu;
710 if (!is_trace_uprobe(ev))
713 tu = to_trace_uprobe(ev);
714 seq_printf(m, " %s %-44s %15lu\n", tu->filename,
715 trace_probe_name(&tu->tp), tu->nhit);
719 static const struct seq_operations profile_seq_op = {
720 .start = dyn_event_seq_start,
721 .next = dyn_event_seq_next,
722 .stop = dyn_event_seq_stop,
723 .show = probes_profile_seq_show
726 static int profile_open(struct inode *inode, struct file *file)
728 return seq_open(file, &profile_seq_op);
731 static const struct file_operations uprobe_profile_ops = {
732 .owner = THIS_MODULE,
733 .open = profile_open,
736 .release = seq_release,
739 struct uprobe_cpu_buffer {
743 static struct uprobe_cpu_buffer __percpu *uprobe_cpu_buffer;
744 static int uprobe_buffer_refcnt;
746 static int uprobe_buffer_init(void)
750 uprobe_cpu_buffer = alloc_percpu(struct uprobe_cpu_buffer);
751 if (uprobe_cpu_buffer == NULL)
754 for_each_possible_cpu(cpu) {
755 struct page *p = alloc_pages_node(cpu_to_node(cpu),
761 per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf = page_address(p);
762 mutex_init(&per_cpu_ptr(uprobe_cpu_buffer, cpu)->mutex);
768 for_each_possible_cpu(cpu) {
771 free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf);
774 free_percpu(uprobe_cpu_buffer);
778 static int uprobe_buffer_enable(void)
782 BUG_ON(!mutex_is_locked(&event_mutex));
784 if (uprobe_buffer_refcnt++ == 0) {
785 ret = uprobe_buffer_init();
787 uprobe_buffer_refcnt--;
793 static void uprobe_buffer_disable(void)
797 BUG_ON(!mutex_is_locked(&event_mutex));
799 if (--uprobe_buffer_refcnt == 0) {
800 for_each_possible_cpu(cpu)
801 free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer,
804 free_percpu(uprobe_cpu_buffer);
805 uprobe_cpu_buffer = NULL;
809 static struct uprobe_cpu_buffer *uprobe_buffer_get(void)
811 struct uprobe_cpu_buffer *ucb;
814 cpu = raw_smp_processor_id();
815 ucb = per_cpu_ptr(uprobe_cpu_buffer, cpu);
818 * Use per-cpu buffers for fastest access, but we might migrate
819 * so the mutex makes sure we have sole access to it.
821 mutex_lock(&ucb->mutex);
826 static void uprobe_buffer_put(struct uprobe_cpu_buffer *ucb)
828 mutex_unlock(&ucb->mutex);
831 static void __uprobe_trace_func(struct trace_uprobe *tu,
832 unsigned long func, struct pt_regs *regs,
833 struct uprobe_cpu_buffer *ucb, int dsize,
834 struct trace_event_file *trace_file)
836 struct uprobe_trace_entry_head *entry;
837 struct ring_buffer_event *event;
838 struct ring_buffer *buffer;
841 struct trace_event_call *call = trace_probe_event_call(&tu->tp);
843 WARN_ON(call != trace_file->event_call);
845 if (WARN_ON_ONCE(tu->tp.size + dsize > PAGE_SIZE))
848 if (trace_trigger_soft_disabled(trace_file))
851 esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
852 size = esize + tu->tp.size + dsize;
853 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
854 call->event.type, size, 0, 0);
858 entry = ring_buffer_event_data(event);
859 if (is_ret_probe(tu)) {
860 entry->vaddr[0] = func;
861 entry->vaddr[1] = instruction_pointer(regs);
862 data = DATAOF_TRACE_ENTRY(entry, true);
864 entry->vaddr[0] = instruction_pointer(regs);
865 data = DATAOF_TRACE_ENTRY(entry, false);
868 memcpy(data, ucb->buf, tu->tp.size + dsize);
870 event_trigger_unlock_commit(trace_file, buffer, event, entry, 0, 0);
874 static int uprobe_trace_func(struct trace_uprobe *tu, struct pt_regs *regs,
875 struct uprobe_cpu_buffer *ucb, int dsize)
877 struct event_file_link *link;
879 if (is_ret_probe(tu))
883 trace_probe_for_each_link_rcu(link, &tu->tp)
884 __uprobe_trace_func(tu, 0, regs, ucb, dsize, link->file);
890 static void uretprobe_trace_func(struct trace_uprobe *tu, unsigned long func,
891 struct pt_regs *regs,
892 struct uprobe_cpu_buffer *ucb, int dsize)
894 struct event_file_link *link;
897 trace_probe_for_each_link_rcu(link, &tu->tp)
898 __uprobe_trace_func(tu, func, regs, ucb, dsize, link->file);
902 /* Event entry printers */
903 static enum print_line_t
904 print_uprobe_event(struct trace_iterator *iter, int flags, struct trace_event *event)
906 struct uprobe_trace_entry_head *entry;
907 struct trace_seq *s = &iter->seq;
908 struct trace_uprobe *tu;
911 entry = (struct uprobe_trace_entry_head *)iter->ent;
912 tu = trace_uprobe_primary_from_call(
913 container_of(event, struct trace_event_call, event));
917 if (is_ret_probe(tu)) {
918 trace_seq_printf(s, "%s: (0x%lx <- 0x%lx)",
919 trace_probe_name(&tu->tp),
920 entry->vaddr[1], entry->vaddr[0]);
921 data = DATAOF_TRACE_ENTRY(entry, true);
923 trace_seq_printf(s, "%s: (0x%lx)",
924 trace_probe_name(&tu->tp),
926 data = DATAOF_TRACE_ENTRY(entry, false);
929 if (print_probe_args(s, tu->tp.args, tu->tp.nr_args, data, entry) < 0)
932 trace_seq_putc(s, '\n');
935 return trace_handle_return(s);
938 typedef bool (*filter_func_t)(struct uprobe_consumer *self,
939 enum uprobe_filter_ctx ctx,
940 struct mm_struct *mm);
942 static int trace_uprobe_enable(struct trace_uprobe *tu, filter_func_t filter)
946 tu->consumer.filter = filter;
947 tu->inode = d_real_inode(tu->path.dentry);
949 if (tu->ref_ctr_offset)
950 ret = uprobe_register_refctr(tu->inode, tu->offset,
951 tu->ref_ctr_offset, &tu->consumer);
953 ret = uprobe_register(tu->inode, tu->offset, &tu->consumer);
961 static void __probe_event_disable(struct trace_probe *tp)
963 struct trace_probe *pos;
964 struct trace_uprobe *tu;
966 list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
967 tu = container_of(pos, struct trace_uprobe, tp);
971 WARN_ON(!uprobe_filter_is_empty(&tu->filter));
973 uprobe_unregister(tu->inode, tu->offset, &tu->consumer);
978 static int probe_event_enable(struct trace_event_call *call,
979 struct trace_event_file *file, filter_func_t filter)
981 struct trace_probe *pos, *tp;
982 struct trace_uprobe *tu;
986 tp = trace_probe_primary_from_call(call);
987 if (WARN_ON_ONCE(!tp))
989 enabled = trace_probe_is_enabled(tp);
991 /* This may also change "enabled" state */
993 if (trace_probe_test_flag(tp, TP_FLAG_PROFILE))
996 ret = trace_probe_add_file(tp, file);
1000 if (trace_probe_test_flag(tp, TP_FLAG_TRACE))
1003 trace_probe_set_flag(tp, TP_FLAG_PROFILE);
1006 tu = container_of(tp, struct trace_uprobe, tp);
1007 WARN_ON(!uprobe_filter_is_empty(&tu->filter));
1012 ret = uprobe_buffer_enable();
1016 list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
1017 tu = container_of(pos, struct trace_uprobe, tp);
1018 ret = trace_uprobe_enable(tu, filter);
1020 __probe_event_disable(tp);
1028 uprobe_buffer_disable();
1032 trace_probe_remove_file(tp, file);
1034 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
1039 static void probe_event_disable(struct trace_event_call *call,
1040 struct trace_event_file *file)
1042 struct trace_probe *tp;
1044 tp = trace_probe_primary_from_call(call);
1045 if (WARN_ON_ONCE(!tp))
1048 if (!trace_probe_is_enabled(tp))
1052 if (trace_probe_remove_file(tp, file) < 0)
1055 if (trace_probe_is_enabled(tp))
1058 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
1060 __probe_event_disable(tp);
1061 uprobe_buffer_disable();
1064 static int uprobe_event_define_fields(struct trace_event_call *event_call)
1067 struct uprobe_trace_entry_head field;
1068 struct trace_uprobe *tu;
1070 tu = trace_uprobe_primary_from_call(event_call);
1074 if (is_ret_probe(tu)) {
1075 DEFINE_FIELD(unsigned long, vaddr[0], FIELD_STRING_FUNC, 0);
1076 DEFINE_FIELD(unsigned long, vaddr[1], FIELD_STRING_RETIP, 0);
1077 size = SIZEOF_TRACE_ENTRY(true);
1079 DEFINE_FIELD(unsigned long, vaddr[0], FIELD_STRING_IP, 0);
1080 size = SIZEOF_TRACE_ENTRY(false);
1083 return traceprobe_define_arg_fields(event_call, size, &tu->tp);
1086 #ifdef CONFIG_PERF_EVENTS
1088 __uprobe_perf_filter(struct trace_uprobe_filter *filter, struct mm_struct *mm)
1090 struct perf_event *event;
1092 if (filter->nr_systemwide)
1095 list_for_each_entry(event, &filter->perf_events, hw.tp_list) {
1096 if (event->hw.target->mm == mm)
1104 uprobe_filter_event(struct trace_uprobe *tu, struct perf_event *event)
1106 return __uprobe_perf_filter(&tu->filter, event->hw.target->mm);
1109 static int uprobe_perf_close(struct trace_uprobe *tu, struct perf_event *event)
1113 write_lock(&tu->filter.rwlock);
1114 if (event->hw.target) {
1115 list_del(&event->hw.tp_list);
1116 done = tu->filter.nr_systemwide ||
1117 (event->hw.target->flags & PF_EXITING) ||
1118 uprobe_filter_event(tu, event);
1120 tu->filter.nr_systemwide--;
1121 done = tu->filter.nr_systemwide;
1123 write_unlock(&tu->filter.rwlock);
1126 return uprobe_apply(tu->inode, tu->offset, &tu->consumer, false);
1131 static int uprobe_perf_open(struct trace_uprobe *tu, struct perf_event *event)
1136 write_lock(&tu->filter.rwlock);
1137 if (event->hw.target) {
1139 * event->parent != NULL means copy_process(), we can avoid
1140 * uprobe_apply(). current->mm must be probed and we can rely
1141 * on dup_mmap() which preserves the already installed bp's.
1143 * attr.enable_on_exec means that exec/mmap will install the
1144 * breakpoints we need.
1146 done = tu->filter.nr_systemwide ||
1147 event->parent || event->attr.enable_on_exec ||
1148 uprobe_filter_event(tu, event);
1149 list_add(&event->hw.tp_list, &tu->filter.perf_events);
1151 done = tu->filter.nr_systemwide;
1152 tu->filter.nr_systemwide++;
1154 write_unlock(&tu->filter.rwlock);
1158 err = uprobe_apply(tu->inode, tu->offset, &tu->consumer, true);
1160 uprobe_perf_close(tu, event);
1165 static int uprobe_perf_multi_call(struct trace_event_call *call,
1166 struct perf_event *event,
1167 int (*op)(struct trace_uprobe *tu, struct perf_event *event))
1169 struct trace_probe *pos, *tp;
1170 struct trace_uprobe *tu;
1173 tp = trace_probe_primary_from_call(call);
1174 if (WARN_ON_ONCE(!tp))
1177 list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
1178 tu = container_of(pos, struct trace_uprobe, tp);
1179 ret = op(tu, event);
1186 static bool uprobe_perf_filter(struct uprobe_consumer *uc,
1187 enum uprobe_filter_ctx ctx, struct mm_struct *mm)
1189 struct trace_uprobe *tu;
1192 tu = container_of(uc, struct trace_uprobe, consumer);
1193 read_lock(&tu->filter.rwlock);
1194 ret = __uprobe_perf_filter(&tu->filter, mm);
1195 read_unlock(&tu->filter.rwlock);
1200 static void __uprobe_perf_func(struct trace_uprobe *tu,
1201 unsigned long func, struct pt_regs *regs,
1202 struct uprobe_cpu_buffer *ucb, int dsize)
1204 struct trace_event_call *call = trace_probe_event_call(&tu->tp);
1205 struct uprobe_trace_entry_head *entry;
1206 struct hlist_head *head;
1211 if (bpf_prog_array_valid(call) && !trace_call_bpf(call, regs))
1214 esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1216 size = esize + tu->tp.size + dsize;
1217 size = ALIGN(size + sizeof(u32), sizeof(u64)) - sizeof(u32);
1218 if (WARN_ONCE(size > PERF_MAX_TRACE_SIZE, "profile buffer not large enough"))
1222 head = this_cpu_ptr(call->perf_events);
1223 if (hlist_empty(head))
1226 entry = perf_trace_buf_alloc(size, NULL, &rctx);
1230 if (is_ret_probe(tu)) {
1231 entry->vaddr[0] = func;
1232 entry->vaddr[1] = instruction_pointer(regs);
1233 data = DATAOF_TRACE_ENTRY(entry, true);
1235 entry->vaddr[0] = instruction_pointer(regs);
1236 data = DATAOF_TRACE_ENTRY(entry, false);
1239 memcpy(data, ucb->buf, tu->tp.size + dsize);
1241 if (size - esize > tu->tp.size + dsize) {
1242 int len = tu->tp.size + dsize;
1244 memset(data + len, 0, size - esize - len);
1247 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs,
1253 /* uprobe profile handler */
1254 static int uprobe_perf_func(struct trace_uprobe *tu, struct pt_regs *regs,
1255 struct uprobe_cpu_buffer *ucb, int dsize)
1257 if (!uprobe_perf_filter(&tu->consumer, 0, current->mm))
1258 return UPROBE_HANDLER_REMOVE;
1260 if (!is_ret_probe(tu))
1261 __uprobe_perf_func(tu, 0, regs, ucb, dsize);
1265 static void uretprobe_perf_func(struct trace_uprobe *tu, unsigned long func,
1266 struct pt_regs *regs,
1267 struct uprobe_cpu_buffer *ucb, int dsize)
1269 __uprobe_perf_func(tu, func, regs, ucb, dsize);
1272 int bpf_get_uprobe_info(const struct perf_event *event, u32 *fd_type,
1273 const char **filename, u64 *probe_offset,
1274 bool perf_type_tracepoint)
1276 const char *pevent = trace_event_name(event->tp_event);
1277 const char *group = event->tp_event->class->system;
1278 struct trace_uprobe *tu;
1280 if (perf_type_tracepoint)
1281 tu = find_probe_event(pevent, group);
1283 tu = event->tp_event->data;
1287 *fd_type = is_ret_probe(tu) ? BPF_FD_TYPE_URETPROBE
1288 : BPF_FD_TYPE_UPROBE;
1289 *filename = tu->filename;
1290 *probe_offset = tu->offset;
1293 #endif /* CONFIG_PERF_EVENTS */
1296 trace_uprobe_register(struct trace_event_call *event, enum trace_reg type,
1299 struct trace_event_file *file = data;
1302 case TRACE_REG_REGISTER:
1303 return probe_event_enable(event, file, NULL);
1305 case TRACE_REG_UNREGISTER:
1306 probe_event_disable(event, file);
1309 #ifdef CONFIG_PERF_EVENTS
1310 case TRACE_REG_PERF_REGISTER:
1311 return probe_event_enable(event, NULL, uprobe_perf_filter);
1313 case TRACE_REG_PERF_UNREGISTER:
1314 probe_event_disable(event, NULL);
1317 case TRACE_REG_PERF_OPEN:
1318 return uprobe_perf_multi_call(event, data, uprobe_perf_open);
1320 case TRACE_REG_PERF_CLOSE:
1321 return uprobe_perf_multi_call(event, data, uprobe_perf_close);
1330 static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs)
1332 struct trace_uprobe *tu;
1333 struct uprobe_dispatch_data udd;
1334 struct uprobe_cpu_buffer *ucb;
1339 tu = container_of(con, struct trace_uprobe, consumer);
1343 udd.bp_addr = instruction_pointer(regs);
1345 current->utask->vaddr = (unsigned long) &udd;
1347 if (WARN_ON_ONCE(!uprobe_cpu_buffer))
1350 dsize = __get_data_size(&tu->tp, regs);
1351 esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1353 ucb = uprobe_buffer_get();
1354 store_trace_args(ucb->buf, &tu->tp, regs, esize, dsize);
1356 if (trace_probe_test_flag(&tu->tp, TP_FLAG_TRACE))
1357 ret |= uprobe_trace_func(tu, regs, ucb, dsize);
1359 #ifdef CONFIG_PERF_EVENTS
1360 if (trace_probe_test_flag(&tu->tp, TP_FLAG_PROFILE))
1361 ret |= uprobe_perf_func(tu, regs, ucb, dsize);
1363 uprobe_buffer_put(ucb);
1367 static int uretprobe_dispatcher(struct uprobe_consumer *con,
1368 unsigned long func, struct pt_regs *regs)
1370 struct trace_uprobe *tu;
1371 struct uprobe_dispatch_data udd;
1372 struct uprobe_cpu_buffer *ucb;
1375 tu = container_of(con, struct trace_uprobe, consumer);
1380 current->utask->vaddr = (unsigned long) &udd;
1382 if (WARN_ON_ONCE(!uprobe_cpu_buffer))
1385 dsize = __get_data_size(&tu->tp, regs);
1386 esize = SIZEOF_TRACE_ENTRY(is_ret_probe(tu));
1388 ucb = uprobe_buffer_get();
1389 store_trace_args(ucb->buf, &tu->tp, regs, esize, dsize);
1391 if (trace_probe_test_flag(&tu->tp, TP_FLAG_TRACE))
1392 uretprobe_trace_func(tu, func, regs, ucb, dsize);
1394 #ifdef CONFIG_PERF_EVENTS
1395 if (trace_probe_test_flag(&tu->tp, TP_FLAG_PROFILE))
1396 uretprobe_perf_func(tu, func, regs, ucb, dsize);
1398 uprobe_buffer_put(ucb);
1402 static struct trace_event_functions uprobe_funcs = {
1403 .trace = print_uprobe_event
1406 static inline void init_trace_event_call(struct trace_uprobe *tu)
1408 struct trace_event_call *call = trace_probe_event_call(&tu->tp);
1410 call->event.funcs = &uprobe_funcs;
1411 call->class->define_fields = uprobe_event_define_fields;
1413 call->flags = TRACE_EVENT_FL_UPROBE | TRACE_EVENT_FL_CAP_ANY;
1414 call->class->reg = trace_uprobe_register;
1417 static int register_uprobe_event(struct trace_uprobe *tu)
1419 init_trace_event_call(tu);
1421 return trace_probe_register_event_call(&tu->tp);
1424 static int unregister_uprobe_event(struct trace_uprobe *tu)
1426 return trace_probe_unregister_event_call(&tu->tp);
1429 #ifdef CONFIG_PERF_EVENTS
1430 struct trace_event_call *
1431 create_local_trace_uprobe(char *name, unsigned long offs,
1432 unsigned long ref_ctr_offset, bool is_return)
1434 struct trace_uprobe *tu;
1438 ret = kern_path(name, LOOKUP_FOLLOW, &path);
1440 return ERR_PTR(ret);
1442 if (!d_is_reg(path.dentry)) {
1444 return ERR_PTR(-EINVAL);
1448 * local trace_kprobes are not added to dyn_event, so they are never
1449 * searched in find_trace_kprobe(). Therefore, there is no concern of
1450 * duplicated name "DUMMY_EVENT" here.
1452 tu = alloc_trace_uprobe(UPROBE_EVENT_SYSTEM, "DUMMY_EVENT", 0,
1456 pr_info("Failed to allocate trace_uprobe.(%d)\n",
1459 return ERR_CAST(tu);
1464 tu->ref_ctr_offset = ref_ctr_offset;
1465 tu->filename = kstrdup(name, GFP_KERNEL);
1466 init_trace_event_call(tu);
1468 if (traceprobe_set_print_fmt(&tu->tp, is_ret_probe(tu)) < 0) {
1473 return trace_probe_event_call(&tu->tp);
1475 free_trace_uprobe(tu);
1476 return ERR_PTR(ret);
1479 void destroy_local_trace_uprobe(struct trace_event_call *event_call)
1481 struct trace_uprobe *tu;
1483 tu = trace_uprobe_primary_from_call(event_call);
1485 free_trace_uprobe(tu);
1487 #endif /* CONFIG_PERF_EVENTS */
1489 /* Make a trace interface for controling probe points */
1490 static __init int init_uprobe_trace(void)
1492 struct dentry *d_tracer;
1495 ret = dyn_event_register(&trace_uprobe_ops);
1499 d_tracer = tracing_init_dentry();
1500 if (IS_ERR(d_tracer))
1503 trace_create_file("uprobe_events", 0644, d_tracer,
1504 NULL, &uprobe_events_ops);
1505 /* Profile interface */
1506 trace_create_file("uprobe_profile", 0444, d_tracer,
1507 NULL, &uprobe_profile_ops);
1511 fs_initcall(init_uprobe_trace);