2 * uprobes-based tracing events
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 * Copyright (C) IBM Corporation, 2010-2012
18 * Author: Srikar Dronamraju <srikar@linux.vnet.ibm.com>
21 #include <linux/module.h>
22 #include <linux/uaccess.h>
23 #include <linux/uprobes.h>
24 #include <linux/namei.h>
25 #include <linux/string.h>
27 #include "trace_probe.h"
29 #define UPROBE_EVENT_SYSTEM "uprobes"
31 struct uprobe_trace_entry_head
{
32 struct trace_entry ent
;
33 unsigned long vaddr
[];
36 #define SIZEOF_TRACE_ENTRY(is_return) \
37 (sizeof(struct uprobe_trace_entry_head) + \
38 sizeof(unsigned long) * (is_return ? 2 : 1))
40 #define DATAOF_TRACE_ENTRY(entry, is_return) \
41 ((void*)(entry) + SIZEOF_TRACE_ENTRY(is_return))
43 struct trace_uprobe_filter
{
46 struct list_head perf_events
;
50 * uprobe event core functions
53 struct list_head list
;
54 struct trace_uprobe_filter filter
;
55 struct uprobe_consumer consumer
;
60 struct trace_probe tp
;
63 #define SIZEOF_TRACE_UPROBE(n) \
64 (offsetof(struct trace_uprobe, tp.args) + \
65 (sizeof(struct probe_arg) * (n)))
67 static int register_uprobe_event(struct trace_uprobe
*tu
);
68 static int unregister_uprobe_event(struct trace_uprobe
*tu
);
70 static DEFINE_MUTEX(uprobe_lock
);
71 static LIST_HEAD(uprobe_list
);
73 struct uprobe_dispatch_data
{
74 struct trace_uprobe
*tu
;
75 unsigned long bp_addr
;
78 static int uprobe_dispatcher(struct uprobe_consumer
*con
, struct pt_regs
*regs
);
79 static int uretprobe_dispatcher(struct uprobe_consumer
*con
,
80 unsigned long func
, struct pt_regs
*regs
);
82 #ifdef CONFIG_STACK_GROWSUP
83 static unsigned long adjust_stack_addr(unsigned long addr
, unsigned int n
)
85 return addr
- (n
* sizeof(long));
88 static unsigned long adjust_stack_addr(unsigned long addr
, unsigned int n
)
90 return addr
+ (n
* sizeof(long));
94 static unsigned long get_user_stack_nth(struct pt_regs
*regs
, unsigned int n
)
97 unsigned long addr
= user_stack_pointer(regs
);
99 addr
= adjust_stack_addr(addr
, n
);
101 if (copy_from_user(&ret
, (void __force __user
*) addr
, sizeof(ret
)))
108 * Uprobes-specific fetch functions
110 #define DEFINE_FETCH_stack(type) \
111 static void FETCH_FUNC_NAME(stack, type)(struct pt_regs *regs, \
112 void *offset, void *dest) \
114 *(type *)dest = (type)get_user_stack_nth(regs, \
115 ((unsigned long)offset)); \
117 DEFINE_BASIC_FETCH_FUNCS(stack
)
118 /* No string on the stack entry */
119 #define fetch_stack_string NULL
120 #define fetch_stack_string_size NULL
122 #define DEFINE_FETCH_memory(type) \
123 static void FETCH_FUNC_NAME(memory, type)(struct pt_regs *regs, \
124 void *addr, void *dest) \
127 void __user *vaddr = (void __force __user *) addr; \
129 if (copy_from_user(&retval, vaddr, sizeof(type))) \
132 *(type *) dest = retval; \
134 DEFINE_BASIC_FETCH_FUNCS(memory
)
136 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
137 * length and relative data location.
139 static void FETCH_FUNC_NAME(memory
, string
)(struct pt_regs
*regs
,
140 void *addr
, void *dest
)
143 u32 rloc
= *(u32
*)dest
;
144 int maxlen
= get_rloc_len(rloc
);
145 u8
*dst
= get_rloc_data(dest
);
146 void __user
*src
= (void __force __user
*) addr
;
151 ret
= strncpy_from_user(dst
, src
, maxlen
);
155 if (ret
< 0) { /* Failed to fetch string */
156 ((u8
*)get_rloc_data(dest
))[0] = '\0';
157 *(u32
*)dest
= make_data_rloc(0, get_rloc_offs(rloc
));
159 *(u32
*)dest
= make_data_rloc(ret
, get_rloc_offs(rloc
));
163 static void FETCH_FUNC_NAME(memory
, string_size
)(struct pt_regs
*regs
,
164 void *addr
, void *dest
)
167 void __user
*vaddr
= (void __force __user
*) addr
;
169 len
= strnlen_user(vaddr
, MAX_STRING_SIZE
);
171 if (len
== 0 || len
> MAX_STRING_SIZE
) /* Failed to check length */
177 static unsigned long translate_user_vaddr(void *file_offset
)
179 unsigned long base_addr
;
180 struct uprobe_dispatch_data
*udd
;
182 udd
= (void *) current
->utask
->vaddr
;
184 base_addr
= udd
->bp_addr
- udd
->tu
->offset
;
185 return base_addr
+ (unsigned long)file_offset
;
188 #define DEFINE_FETCH_file_offset(type) \
189 static void FETCH_FUNC_NAME(file_offset, type)(struct pt_regs *regs, \
190 void *offset, void *dest)\
192 void *vaddr = (void *)translate_user_vaddr(offset); \
194 FETCH_FUNC_NAME(memory, type)(regs, vaddr, dest); \
196 DEFINE_BASIC_FETCH_FUNCS(file_offset
)
197 DEFINE_FETCH_file_offset(string
)
198 DEFINE_FETCH_file_offset(string_size
)
200 /* Fetch type information table */
201 static const struct fetch_type uprobes_fetch_type_table
[] = {
203 [FETCH_TYPE_STRING
] = __ASSIGN_FETCH_TYPE("string", string
, string
,
204 sizeof(u32
), 1, "__data_loc char[]"),
205 [FETCH_TYPE_STRSIZE
] = __ASSIGN_FETCH_TYPE("string_size", u32
,
206 string_size
, sizeof(u32
), 0, "u32"),
208 ASSIGN_FETCH_TYPE(u8
, u8
, 0),
209 ASSIGN_FETCH_TYPE(u16
, u16
, 0),
210 ASSIGN_FETCH_TYPE(u32
, u32
, 0),
211 ASSIGN_FETCH_TYPE(u64
, u64
, 0),
212 ASSIGN_FETCH_TYPE(s8
, u8
, 1),
213 ASSIGN_FETCH_TYPE(s16
, u16
, 1),
214 ASSIGN_FETCH_TYPE(s32
, u32
, 1),
215 ASSIGN_FETCH_TYPE(s64
, u64
, 1),
217 ASSIGN_FETCH_TYPE_END
220 static inline void init_trace_uprobe_filter(struct trace_uprobe_filter
*filter
)
222 rwlock_init(&filter
->rwlock
);
223 filter
->nr_systemwide
= 0;
224 INIT_LIST_HEAD(&filter
->perf_events
);
227 static inline bool uprobe_filter_is_empty(struct trace_uprobe_filter
*filter
)
229 return !filter
->nr_systemwide
&& list_empty(&filter
->perf_events
);
232 static inline bool is_ret_probe(struct trace_uprobe
*tu
)
234 return tu
->consumer
.ret_handler
!= NULL
;
238 * Allocate new trace_uprobe and initialize it (including uprobes).
240 static struct trace_uprobe
*
241 alloc_trace_uprobe(const char *group
, const char *event
, int nargs
, bool is_ret
)
243 struct trace_uprobe
*tu
;
245 if (!event
|| !is_good_name(event
))
246 return ERR_PTR(-EINVAL
);
248 if (!group
|| !is_good_name(group
))
249 return ERR_PTR(-EINVAL
);
251 tu
= kzalloc(SIZEOF_TRACE_UPROBE(nargs
), GFP_KERNEL
);
253 return ERR_PTR(-ENOMEM
);
255 tu
->tp
.call
.class = &tu
->tp
.class;
256 tu
->tp
.call
.name
= kstrdup(event
, GFP_KERNEL
);
257 if (!tu
->tp
.call
.name
)
260 tu
->tp
.class.system
= kstrdup(group
, GFP_KERNEL
);
261 if (!tu
->tp
.class.system
)
264 INIT_LIST_HEAD(&tu
->list
);
265 INIT_LIST_HEAD(&tu
->tp
.files
);
266 tu
->consumer
.handler
= uprobe_dispatcher
;
268 tu
->consumer
.ret_handler
= uretprobe_dispatcher
;
269 init_trace_uprobe_filter(&tu
->filter
);
273 kfree(tu
->tp
.call
.name
);
276 return ERR_PTR(-ENOMEM
);
279 static void free_trace_uprobe(struct trace_uprobe
*tu
)
283 for (i
= 0; i
< tu
->tp
.nr_args
; i
++)
284 traceprobe_free_probe_arg(&tu
->tp
.args
[i
]);
287 kfree(tu
->tp
.call
.class->system
);
288 kfree(tu
->tp
.call
.name
);
293 static struct trace_uprobe
*find_probe_event(const char *event
, const char *group
)
295 struct trace_uprobe
*tu
;
297 list_for_each_entry(tu
, &uprobe_list
, list
)
298 if (strcmp(trace_event_name(&tu
->tp
.call
), event
) == 0 &&
299 strcmp(tu
->tp
.call
.class->system
, group
) == 0)
305 /* Unregister a trace_uprobe and probe_event: call with locking uprobe_lock */
306 static int unregister_trace_uprobe(struct trace_uprobe
*tu
)
310 ret
= unregister_uprobe_event(tu
);
315 free_trace_uprobe(tu
);
319 /* Register a trace_uprobe and probe_event */
320 static int register_trace_uprobe(struct trace_uprobe
*tu
)
322 struct trace_uprobe
*old_tu
;
325 mutex_lock(&uprobe_lock
);
327 /* register as an event */
328 old_tu
= find_probe_event(trace_event_name(&tu
->tp
.call
),
329 tu
->tp
.call
.class->system
);
331 /* delete old event */
332 ret
= unregister_trace_uprobe(old_tu
);
337 ret
= register_uprobe_event(tu
);
339 pr_warning("Failed to register probe event(%d)\n", ret
);
343 list_add_tail(&tu
->list
, &uprobe_list
);
346 mutex_unlock(&uprobe_lock
);
353 * - Add uprobe: p|r[:[GRP/]EVENT] PATH:OFFSET [FETCHARGS]
355 * - Remove uprobe: -:[GRP/]EVENT
357 static int create_trace_uprobe(int argc
, char **argv
)
359 struct trace_uprobe
*tu
;
361 char *arg
, *event
, *group
, *filename
;
362 char buf
[MAX_EVENT_NAME_LEN
];
364 unsigned long offset
;
365 bool is_delete
, is_return
;
375 /* argc must be >= 1 */
376 if (argv
[0][0] == '-')
378 else if (argv
[0][0] == 'r')
380 else if (argv
[0][0] != 'p') {
381 pr_info("Probe definition must be started with 'p', 'r' or '-'.\n");
385 if (argv
[0][1] == ':') {
387 arg
= strchr(event
, '/');
394 if (strlen(group
) == 0) {
395 pr_info("Group name is not specified\n");
399 if (strlen(event
) == 0) {
400 pr_info("Event name is not specified\n");
405 group
= UPROBE_EVENT_SYSTEM
;
411 pr_info("Delete command needs an event name.\n");
414 mutex_lock(&uprobe_lock
);
415 tu
= find_probe_event(event
, group
);
418 mutex_unlock(&uprobe_lock
);
419 pr_info("Event %s/%s doesn't exist.\n", group
, event
);
422 /* delete an event */
423 ret
= unregister_trace_uprobe(tu
);
424 mutex_unlock(&uprobe_lock
);
429 pr_info("Probe point is not specified.\n");
432 if (isdigit(argv
[1][0])) {
433 pr_info("probe point must be have a filename.\n");
436 arg
= strchr(argv
[1], ':');
439 goto fail_address_parse
;
444 ret
= kern_path(filename
, LOOKUP_FOLLOW
, &path
);
446 goto fail_address_parse
;
448 inode
= igrab(d_inode(path
.dentry
));
451 if (!inode
|| !S_ISREG(inode
->i_mode
)) {
453 goto fail_address_parse
;
456 ret
= kstrtoul(arg
, 0, &offset
);
458 goto fail_address_parse
;
468 tail
= kstrdup(kbasename(filename
), GFP_KERNEL
);
471 goto fail_address_parse
;
474 ptr
= strpbrk(tail
, ".-_");
478 snprintf(buf
, MAX_EVENT_NAME_LEN
, "%c_%s_0x%lx", 'p', tail
, offset
);
483 tu
= alloc_trace_uprobe(group
, event
, argc
, is_return
);
485 pr_info("Failed to allocate trace_uprobe.(%d)\n", (int)PTR_ERR(tu
));
487 goto fail_address_parse
;
491 tu
->filename
= kstrdup(filename
, GFP_KERNEL
);
494 pr_info("Failed to allocate filename.\n");
499 /* parse arguments */
501 for (i
= 0; i
< argc
&& i
< MAX_TRACE_ARGS
; i
++) {
502 struct probe_arg
*parg
= &tu
->tp
.args
[i
];
504 /* Increment count for freeing args in error case */
507 /* Parse argument name */
508 arg
= strchr(argv
[i
], '=');
511 parg
->name
= kstrdup(argv
[i
], GFP_KERNEL
);
514 /* If argument name is omitted, set "argN" */
515 snprintf(buf
, MAX_EVENT_NAME_LEN
, "arg%d", i
+ 1);
516 parg
->name
= kstrdup(buf
, GFP_KERNEL
);
520 pr_info("Failed to allocate argument[%d] name.\n", i
);
525 if (!is_good_name(parg
->name
)) {
526 pr_info("Invalid argument[%d] name: %s\n", i
, parg
->name
);
531 if (traceprobe_conflict_field_name(parg
->name
, tu
->tp
.args
, i
)) {
532 pr_info("Argument[%d] name '%s' conflicts with "
533 "another field.\n", i
, argv
[i
]);
538 /* Parse fetch argument */
539 ret
= traceprobe_parse_probe_arg(arg
, &tu
->tp
.size
, parg
,
541 uprobes_fetch_type_table
);
543 pr_info("Parse error at argument[%d]. (%d)\n", i
, ret
);
548 ret
= register_trace_uprobe(tu
);
554 free_trace_uprobe(tu
);
560 pr_info("Failed to parse address or file.\n");
565 static int cleanup_all_probes(void)
567 struct trace_uprobe
*tu
;
570 mutex_lock(&uprobe_lock
);
571 while (!list_empty(&uprobe_list
)) {
572 tu
= list_entry(uprobe_list
.next
, struct trace_uprobe
, list
);
573 ret
= unregister_trace_uprobe(tu
);
577 mutex_unlock(&uprobe_lock
);
581 /* Probes listing interfaces */
582 static void *probes_seq_start(struct seq_file
*m
, loff_t
*pos
)
584 mutex_lock(&uprobe_lock
);
585 return seq_list_start(&uprobe_list
, *pos
);
588 static void *probes_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
590 return seq_list_next(v
, &uprobe_list
, pos
);
593 static void probes_seq_stop(struct seq_file
*m
, void *v
)
595 mutex_unlock(&uprobe_lock
);
598 static int probes_seq_show(struct seq_file
*m
, void *v
)
600 struct trace_uprobe
*tu
= v
;
601 char c
= is_ret_probe(tu
) ? 'r' : 'p';
604 seq_printf(m
, "%c:%s/%s", c
, tu
->tp
.call
.class->system
,
605 trace_event_name(&tu
->tp
.call
));
606 seq_printf(m
, " %s:", tu
->filename
);
608 /* Don't print "0x (null)" when offset is 0 */
610 seq_printf(m
, "0x%p", (void *)tu
->offset
);
612 switch (sizeof(void *)) {
614 seq_printf(m
, "0x00000000");
618 seq_printf(m
, "0x0000000000000000");
623 for (i
= 0; i
< tu
->tp
.nr_args
; i
++)
624 seq_printf(m
, " %s=%s", tu
->tp
.args
[i
].name
, tu
->tp
.args
[i
].comm
);
630 static const struct seq_operations probes_seq_op
= {
631 .start
= probes_seq_start
,
632 .next
= probes_seq_next
,
633 .stop
= probes_seq_stop
,
634 .show
= probes_seq_show
637 static int probes_open(struct inode
*inode
, struct file
*file
)
641 if ((file
->f_mode
& FMODE_WRITE
) && (file
->f_flags
& O_TRUNC
)) {
642 ret
= cleanup_all_probes();
647 return seq_open(file
, &probes_seq_op
);
650 static ssize_t
probes_write(struct file
*file
, const char __user
*buffer
,
651 size_t count
, loff_t
*ppos
)
653 return traceprobe_probes_write(file
, buffer
, count
, ppos
, create_trace_uprobe
);
656 static const struct file_operations uprobe_events_ops
= {
657 .owner
= THIS_MODULE
,
661 .release
= seq_release
,
662 .write
= probes_write
,
665 /* Probes profiling interfaces */
666 static int probes_profile_seq_show(struct seq_file
*m
, void *v
)
668 struct trace_uprobe
*tu
= v
;
670 seq_printf(m
, " %s %-44s %15lu\n", tu
->filename
,
671 trace_event_name(&tu
->tp
.call
), tu
->nhit
);
675 static const struct seq_operations profile_seq_op
= {
676 .start
= probes_seq_start
,
677 .next
= probes_seq_next
,
678 .stop
= probes_seq_stop
,
679 .show
= probes_profile_seq_show
682 static int profile_open(struct inode
*inode
, struct file
*file
)
684 return seq_open(file
, &profile_seq_op
);
687 static const struct file_operations uprobe_profile_ops
= {
688 .owner
= THIS_MODULE
,
689 .open
= profile_open
,
692 .release
= seq_release
,
695 struct uprobe_cpu_buffer
{
699 static struct uprobe_cpu_buffer __percpu
*uprobe_cpu_buffer
;
700 static int uprobe_buffer_refcnt
;
702 static int uprobe_buffer_init(void)
706 uprobe_cpu_buffer
= alloc_percpu(struct uprobe_cpu_buffer
);
707 if (uprobe_cpu_buffer
== NULL
)
710 for_each_possible_cpu(cpu
) {
711 struct page
*p
= alloc_pages_node(cpu_to_node(cpu
),
717 per_cpu_ptr(uprobe_cpu_buffer
, cpu
)->buf
= page_address(p
);
718 mutex_init(&per_cpu_ptr(uprobe_cpu_buffer
, cpu
)->mutex
);
724 for_each_possible_cpu(cpu
) {
727 free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer
, cpu
)->buf
);
730 free_percpu(uprobe_cpu_buffer
);
734 static int uprobe_buffer_enable(void)
738 BUG_ON(!mutex_is_locked(&event_mutex
));
740 if (uprobe_buffer_refcnt
++ == 0) {
741 ret
= uprobe_buffer_init();
743 uprobe_buffer_refcnt
--;
749 static void uprobe_buffer_disable(void)
753 BUG_ON(!mutex_is_locked(&event_mutex
));
755 if (--uprobe_buffer_refcnt
== 0) {
756 for_each_possible_cpu(cpu
)
757 free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer
,
760 free_percpu(uprobe_cpu_buffer
);
761 uprobe_cpu_buffer
= NULL
;
765 static struct uprobe_cpu_buffer
*uprobe_buffer_get(void)
767 struct uprobe_cpu_buffer
*ucb
;
770 cpu
= raw_smp_processor_id();
771 ucb
= per_cpu_ptr(uprobe_cpu_buffer
, cpu
);
774 * Use per-cpu buffers for fastest access, but we might migrate
775 * so the mutex makes sure we have sole access to it.
777 mutex_lock(&ucb
->mutex
);
782 static void uprobe_buffer_put(struct uprobe_cpu_buffer
*ucb
)
784 mutex_unlock(&ucb
->mutex
);
787 static void __uprobe_trace_func(struct trace_uprobe
*tu
,
788 unsigned long func
, struct pt_regs
*regs
,
789 struct uprobe_cpu_buffer
*ucb
, int dsize
,
790 struct trace_event_file
*trace_file
)
792 struct uprobe_trace_entry_head
*entry
;
793 struct ring_buffer_event
*event
;
794 struct ring_buffer
*buffer
;
797 struct trace_event_call
*call
= &tu
->tp
.call
;
799 WARN_ON(call
!= trace_file
->event_call
);
801 if (WARN_ON_ONCE(tu
->tp
.size
+ dsize
> PAGE_SIZE
))
804 if (trace_trigger_soft_disabled(trace_file
))
807 esize
= SIZEOF_TRACE_ENTRY(is_ret_probe(tu
));
808 size
= esize
+ tu
->tp
.size
+ dsize
;
809 event
= trace_event_buffer_lock_reserve(&buffer
, trace_file
,
810 call
->event
.type
, size
, 0, 0);
814 entry
= ring_buffer_event_data(event
);
815 if (is_ret_probe(tu
)) {
816 entry
->vaddr
[0] = func
;
817 entry
->vaddr
[1] = instruction_pointer(regs
);
818 data
= DATAOF_TRACE_ENTRY(entry
, true);
820 entry
->vaddr
[0] = instruction_pointer(regs
);
821 data
= DATAOF_TRACE_ENTRY(entry
, false);
824 memcpy(data
, ucb
->buf
, tu
->tp
.size
+ dsize
);
826 event_trigger_unlock_commit(trace_file
, buffer
, event
, entry
, 0, 0);
830 static int uprobe_trace_func(struct trace_uprobe
*tu
, struct pt_regs
*regs
,
831 struct uprobe_cpu_buffer
*ucb
, int dsize
)
833 struct event_file_link
*link
;
835 if (is_ret_probe(tu
))
839 list_for_each_entry_rcu(link
, &tu
->tp
.files
, list
)
840 __uprobe_trace_func(tu
, 0, regs
, ucb
, dsize
, link
->file
);
846 static void uretprobe_trace_func(struct trace_uprobe
*tu
, unsigned long func
,
847 struct pt_regs
*regs
,
848 struct uprobe_cpu_buffer
*ucb
, int dsize
)
850 struct event_file_link
*link
;
853 list_for_each_entry_rcu(link
, &tu
->tp
.files
, list
)
854 __uprobe_trace_func(tu
, func
, regs
, ucb
, dsize
, link
->file
);
858 /* Event entry printers */
859 static enum print_line_t
860 print_uprobe_event(struct trace_iterator
*iter
, int flags
, struct trace_event
*event
)
862 struct uprobe_trace_entry_head
*entry
;
863 struct trace_seq
*s
= &iter
->seq
;
864 struct trace_uprobe
*tu
;
868 entry
= (struct uprobe_trace_entry_head
*)iter
->ent
;
869 tu
= container_of(event
, struct trace_uprobe
, tp
.call
.event
);
871 if (is_ret_probe(tu
)) {
872 trace_seq_printf(s
, "%s: (0x%lx <- 0x%lx)",
873 trace_event_name(&tu
->tp
.call
),
874 entry
->vaddr
[1], entry
->vaddr
[0]);
875 data
= DATAOF_TRACE_ENTRY(entry
, true);
877 trace_seq_printf(s
, "%s: (0x%lx)",
878 trace_event_name(&tu
->tp
.call
),
880 data
= DATAOF_TRACE_ENTRY(entry
, false);
883 for (i
= 0; i
< tu
->tp
.nr_args
; i
++) {
884 struct probe_arg
*parg
= &tu
->tp
.args
[i
];
886 if (!parg
->type
->print(s
, parg
->name
, data
+ parg
->offset
, entry
))
890 trace_seq_putc(s
, '\n');
893 return trace_handle_return(s
);
896 typedef bool (*filter_func_t
)(struct uprobe_consumer
*self
,
897 enum uprobe_filter_ctx ctx
,
898 struct mm_struct
*mm
);
901 probe_event_enable(struct trace_uprobe
*tu
, struct trace_event_file
*file
,
902 filter_func_t filter
)
904 bool enabled
= trace_probe_is_enabled(&tu
->tp
);
905 struct event_file_link
*link
= NULL
;
909 if (tu
->tp
.flags
& TP_FLAG_PROFILE
)
912 link
= kmalloc(sizeof(*link
), GFP_KERNEL
);
917 list_add_tail_rcu(&link
->list
, &tu
->tp
.files
);
919 tu
->tp
.flags
|= TP_FLAG_TRACE
;
921 if (tu
->tp
.flags
& TP_FLAG_TRACE
)
924 tu
->tp
.flags
|= TP_FLAG_PROFILE
;
927 WARN_ON(!uprobe_filter_is_empty(&tu
->filter
));
932 ret
= uprobe_buffer_enable();
936 tu
->consumer
.filter
= filter
;
937 ret
= uprobe_register(tu
->inode
, tu
->offset
, &tu
->consumer
);
944 uprobe_buffer_disable();
948 list_del(&link
->list
);
950 tu
->tp
.flags
&= ~TP_FLAG_TRACE
;
952 tu
->tp
.flags
&= ~TP_FLAG_PROFILE
;
958 probe_event_disable(struct trace_uprobe
*tu
, struct trace_event_file
*file
)
960 if (!trace_probe_is_enabled(&tu
->tp
))
964 struct event_file_link
*link
;
966 link
= find_event_file_link(&tu
->tp
, file
);
970 list_del_rcu(&link
->list
);
971 /* synchronize with u{,ret}probe_trace_func */
975 if (!list_empty(&tu
->tp
.files
))
979 WARN_ON(!uprobe_filter_is_empty(&tu
->filter
));
981 uprobe_unregister(tu
->inode
, tu
->offset
, &tu
->consumer
);
982 tu
->tp
.flags
&= file
? ~TP_FLAG_TRACE
: ~TP_FLAG_PROFILE
;
984 uprobe_buffer_disable();
987 static int uprobe_event_define_fields(struct trace_event_call
*event_call
)
990 struct uprobe_trace_entry_head field
;
991 struct trace_uprobe
*tu
= event_call
->data
;
993 if (is_ret_probe(tu
)) {
994 DEFINE_FIELD(unsigned long, vaddr
[0], FIELD_STRING_FUNC
, 0);
995 DEFINE_FIELD(unsigned long, vaddr
[1], FIELD_STRING_RETIP
, 0);
996 size
= SIZEOF_TRACE_ENTRY(true);
998 DEFINE_FIELD(unsigned long, vaddr
[0], FIELD_STRING_IP
, 0);
999 size
= SIZEOF_TRACE_ENTRY(false);
1001 /* Set argument names as fields */
1002 for (i
= 0; i
< tu
->tp
.nr_args
; i
++) {
1003 struct probe_arg
*parg
= &tu
->tp
.args
[i
];
1005 ret
= trace_define_field(event_call
, parg
->type
->fmttype
,
1006 parg
->name
, size
+ parg
->offset
,
1007 parg
->type
->size
, parg
->type
->is_signed
,
1016 #ifdef CONFIG_PERF_EVENTS
1018 __uprobe_perf_filter(struct trace_uprobe_filter
*filter
, struct mm_struct
*mm
)
1020 struct perf_event
*event
;
1022 if (filter
->nr_systemwide
)
1025 list_for_each_entry(event
, &filter
->perf_events
, hw
.tp_list
) {
1026 if (event
->hw
.target
->mm
== mm
)
1034 uprobe_filter_event(struct trace_uprobe
*tu
, struct perf_event
*event
)
1036 return __uprobe_perf_filter(&tu
->filter
, event
->hw
.target
->mm
);
1039 static int uprobe_perf_close(struct trace_uprobe
*tu
, struct perf_event
*event
)
1043 write_lock(&tu
->filter
.rwlock
);
1044 if (event
->hw
.target
) {
1045 list_del(&event
->hw
.tp_list
);
1046 done
= tu
->filter
.nr_systemwide
||
1047 (event
->hw
.target
->flags
& PF_EXITING
) ||
1048 uprobe_filter_event(tu
, event
);
1050 tu
->filter
.nr_systemwide
--;
1051 done
= tu
->filter
.nr_systemwide
;
1053 write_unlock(&tu
->filter
.rwlock
);
1056 return uprobe_apply(tu
->inode
, tu
->offset
, &tu
->consumer
, false);
1061 static int uprobe_perf_open(struct trace_uprobe
*tu
, struct perf_event
*event
)
1066 write_lock(&tu
->filter
.rwlock
);
1067 if (event
->hw
.target
) {
1069 * event->parent != NULL means copy_process(), we can avoid
1070 * uprobe_apply(). current->mm must be probed and we can rely
1071 * on dup_mmap() which preserves the already installed bp's.
1073 * attr.enable_on_exec means that exec/mmap will install the
1074 * breakpoints we need.
1076 done
= tu
->filter
.nr_systemwide
||
1077 event
->parent
|| event
->attr
.enable_on_exec
||
1078 uprobe_filter_event(tu
, event
);
1079 list_add(&event
->hw
.tp_list
, &tu
->filter
.perf_events
);
1081 done
= tu
->filter
.nr_systemwide
;
1082 tu
->filter
.nr_systemwide
++;
1084 write_unlock(&tu
->filter
.rwlock
);
1088 err
= uprobe_apply(tu
->inode
, tu
->offset
, &tu
->consumer
, true);
1090 uprobe_perf_close(tu
, event
);
1095 static bool uprobe_perf_filter(struct uprobe_consumer
*uc
,
1096 enum uprobe_filter_ctx ctx
, struct mm_struct
*mm
)
1098 struct trace_uprobe
*tu
;
1101 tu
= container_of(uc
, struct trace_uprobe
, consumer
);
1102 read_lock(&tu
->filter
.rwlock
);
1103 ret
= __uprobe_perf_filter(&tu
->filter
, mm
);
1104 read_unlock(&tu
->filter
.rwlock
);
1109 static void __uprobe_perf_func(struct trace_uprobe
*tu
,
1110 unsigned long func
, struct pt_regs
*regs
,
1111 struct uprobe_cpu_buffer
*ucb
, int dsize
)
1113 struct trace_event_call
*call
= &tu
->tp
.call
;
1114 struct uprobe_trace_entry_head
*entry
;
1115 struct bpf_prog
*prog
= call
->prog
;
1116 struct hlist_head
*head
;
1121 if (prog
&& !trace_call_bpf(prog
, regs
))
1124 esize
= SIZEOF_TRACE_ENTRY(is_ret_probe(tu
));
1126 size
= esize
+ tu
->tp
.size
+ dsize
;
1127 size
= ALIGN(size
+ sizeof(u32
), sizeof(u64
)) - sizeof(u32
);
1128 if (WARN_ONCE(size
> PERF_MAX_TRACE_SIZE
, "profile buffer not large enough"))
1132 head
= this_cpu_ptr(call
->perf_events
);
1133 if (hlist_empty(head
))
1136 entry
= perf_trace_buf_prepare(size
, call
->event
.type
, NULL
, &rctx
);
1140 if (is_ret_probe(tu
)) {
1141 entry
->vaddr
[0] = func
;
1142 entry
->vaddr
[1] = instruction_pointer(regs
);
1143 data
= DATAOF_TRACE_ENTRY(entry
, true);
1145 entry
->vaddr
[0] = instruction_pointer(regs
);
1146 data
= DATAOF_TRACE_ENTRY(entry
, false);
1149 memcpy(data
, ucb
->buf
, tu
->tp
.size
+ dsize
);
1151 if (size
- esize
> tu
->tp
.size
+ dsize
) {
1152 int len
= tu
->tp
.size
+ dsize
;
1154 memset(data
+ len
, 0, size
- esize
- len
);
1157 perf_trace_buf_submit(entry
, size
, rctx
, 0, 1, regs
, head
, NULL
);
1162 /* uprobe profile handler */
1163 static int uprobe_perf_func(struct trace_uprobe
*tu
, struct pt_regs
*regs
,
1164 struct uprobe_cpu_buffer
*ucb
, int dsize
)
1166 if (!uprobe_perf_filter(&tu
->consumer
, 0, current
->mm
))
1167 return UPROBE_HANDLER_REMOVE
;
1169 if (!is_ret_probe(tu
))
1170 __uprobe_perf_func(tu
, 0, regs
, ucb
, dsize
);
1174 static void uretprobe_perf_func(struct trace_uprobe
*tu
, unsigned long func
,
1175 struct pt_regs
*regs
,
1176 struct uprobe_cpu_buffer
*ucb
, int dsize
)
1178 __uprobe_perf_func(tu
, func
, regs
, ucb
, dsize
);
1180 #endif /* CONFIG_PERF_EVENTS */
1183 trace_uprobe_register(struct trace_event_call
*event
, enum trace_reg type
,
1186 struct trace_uprobe
*tu
= event
->data
;
1187 struct trace_event_file
*file
= data
;
1190 case TRACE_REG_REGISTER
:
1191 return probe_event_enable(tu
, file
, NULL
);
1193 case TRACE_REG_UNREGISTER
:
1194 probe_event_disable(tu
, file
);
1197 #ifdef CONFIG_PERF_EVENTS
1198 case TRACE_REG_PERF_REGISTER
:
1199 return probe_event_enable(tu
, NULL
, uprobe_perf_filter
);
1201 case TRACE_REG_PERF_UNREGISTER
:
1202 probe_event_disable(tu
, NULL
);
1205 case TRACE_REG_PERF_OPEN
:
1206 return uprobe_perf_open(tu
, data
);
1208 case TRACE_REG_PERF_CLOSE
:
1209 return uprobe_perf_close(tu
, data
);
1218 static int uprobe_dispatcher(struct uprobe_consumer
*con
, struct pt_regs
*regs
)
1220 struct trace_uprobe
*tu
;
1221 struct uprobe_dispatch_data udd
;
1222 struct uprobe_cpu_buffer
*ucb
;
1227 tu
= container_of(con
, struct trace_uprobe
, consumer
);
1231 udd
.bp_addr
= instruction_pointer(regs
);
1233 current
->utask
->vaddr
= (unsigned long) &udd
;
1235 if (WARN_ON_ONCE(!uprobe_cpu_buffer
))
1238 dsize
= __get_data_size(&tu
->tp
, regs
);
1239 esize
= SIZEOF_TRACE_ENTRY(is_ret_probe(tu
));
1241 ucb
= uprobe_buffer_get();
1242 store_trace_args(esize
, &tu
->tp
, regs
, ucb
->buf
, dsize
);
1244 if (tu
->tp
.flags
& TP_FLAG_TRACE
)
1245 ret
|= uprobe_trace_func(tu
, regs
, ucb
, dsize
);
1247 #ifdef CONFIG_PERF_EVENTS
1248 if (tu
->tp
.flags
& TP_FLAG_PROFILE
)
1249 ret
|= uprobe_perf_func(tu
, regs
, ucb
, dsize
);
1251 uprobe_buffer_put(ucb
);
1255 static int uretprobe_dispatcher(struct uprobe_consumer
*con
,
1256 unsigned long func
, struct pt_regs
*regs
)
1258 struct trace_uprobe
*tu
;
1259 struct uprobe_dispatch_data udd
;
1260 struct uprobe_cpu_buffer
*ucb
;
1263 tu
= container_of(con
, struct trace_uprobe
, consumer
);
1268 current
->utask
->vaddr
= (unsigned long) &udd
;
1270 if (WARN_ON_ONCE(!uprobe_cpu_buffer
))
1273 dsize
= __get_data_size(&tu
->tp
, regs
);
1274 esize
= SIZEOF_TRACE_ENTRY(is_ret_probe(tu
));
1276 ucb
= uprobe_buffer_get();
1277 store_trace_args(esize
, &tu
->tp
, regs
, ucb
->buf
, dsize
);
1279 if (tu
->tp
.flags
& TP_FLAG_TRACE
)
1280 uretprobe_trace_func(tu
, func
, regs
, ucb
, dsize
);
1282 #ifdef CONFIG_PERF_EVENTS
1283 if (tu
->tp
.flags
& TP_FLAG_PROFILE
)
1284 uretprobe_perf_func(tu
, func
, regs
, ucb
, dsize
);
1286 uprobe_buffer_put(ucb
);
1290 static struct trace_event_functions uprobe_funcs
= {
1291 .trace
= print_uprobe_event
1294 static int register_uprobe_event(struct trace_uprobe
*tu
)
1296 struct trace_event_call
*call
= &tu
->tp
.call
;
1299 /* Initialize trace_event_call */
1300 INIT_LIST_HEAD(&call
->class->fields
);
1301 call
->event
.funcs
= &uprobe_funcs
;
1302 call
->class->define_fields
= uprobe_event_define_fields
;
1304 if (set_print_fmt(&tu
->tp
, is_ret_probe(tu
)) < 0)
1307 ret
= register_trace_event(&call
->event
);
1309 kfree(call
->print_fmt
);
1313 call
->flags
= TRACE_EVENT_FL_UPROBE
;
1314 call
->class->reg
= trace_uprobe_register
;
1316 ret
= trace_add_event_call(call
);
1319 pr_info("Failed to register uprobe event: %s\n",
1320 trace_event_name(call
));
1321 kfree(call
->print_fmt
);
1322 unregister_trace_event(&call
->event
);
1328 static int unregister_uprobe_event(struct trace_uprobe
*tu
)
1332 /* tu->event is unregistered in trace_remove_event_call() */
1333 ret
= trace_remove_event_call(&tu
->tp
.call
);
1336 kfree(tu
->tp
.call
.print_fmt
);
1337 tu
->tp
.call
.print_fmt
= NULL
;
1341 /* Make a trace interface for controling probe points */
1342 static __init
int init_uprobe_trace(void)
1344 struct dentry
*d_tracer
;
1346 d_tracer
= tracing_init_dentry();
1347 if (IS_ERR(d_tracer
))
1350 trace_create_file("uprobe_events", 0644, d_tracer
,
1351 NULL
, &uprobe_events_ops
);
1352 /* Profile interface */
1353 trace_create_file("uprobe_profile", 0444, d_tracer
,
1354 NULL
, &uprobe_profile_ops
);
1358 fs_initcall(init_uprobe_trace
);