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 __kprobes 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 __kprobes 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 __kprobes
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
);
153 if (ret
< 0) { /* Failed to fetch string */
154 ((u8
*)get_rloc_data(dest
))[0] = '\0';
155 *(u32
*)dest
= make_data_rloc(0, get_rloc_offs(rloc
));
157 *(u32
*)dest
= make_data_rloc(ret
, get_rloc_offs(rloc
));
161 static __kprobes
void FETCH_FUNC_NAME(memory
, string_size
)(struct pt_regs
*regs
,
162 void *addr
, void *dest
)
165 void __user
*vaddr
= (void __force __user
*) addr
;
167 len
= strnlen_user(vaddr
, MAX_STRING_SIZE
);
169 if (len
== 0 || len
> MAX_STRING_SIZE
) /* Failed to check length */
175 static unsigned long translate_user_vaddr(void *file_offset
)
177 unsigned long base_addr
;
178 struct uprobe_dispatch_data
*udd
;
180 udd
= (void *) current
->utask
->vaddr
;
182 base_addr
= udd
->bp_addr
- udd
->tu
->offset
;
183 return base_addr
+ (unsigned long)file_offset
;
186 #define DEFINE_FETCH_file_offset(type) \
187 static __kprobes void FETCH_FUNC_NAME(file_offset, type)(struct pt_regs *regs,\
188 void *offset, void *dest) \
190 void *vaddr = (void *)translate_user_vaddr(offset); \
192 FETCH_FUNC_NAME(memory, type)(regs, vaddr, dest); \
194 DEFINE_BASIC_FETCH_FUNCS(file_offset
)
195 DEFINE_FETCH_file_offset(string
)
196 DEFINE_FETCH_file_offset(string_size
)
198 /* Fetch type information table */
199 const struct fetch_type uprobes_fetch_type_table
[] = {
201 [FETCH_TYPE_STRING
] = __ASSIGN_FETCH_TYPE("string", string
, string
,
202 sizeof(u32
), 1, "__data_loc char[]"),
203 [FETCH_TYPE_STRSIZE
] = __ASSIGN_FETCH_TYPE("string_size", u32
,
204 string_size
, sizeof(u32
), 0, "u32"),
206 ASSIGN_FETCH_TYPE(u8
, u8
, 0),
207 ASSIGN_FETCH_TYPE(u16
, u16
, 0),
208 ASSIGN_FETCH_TYPE(u32
, u32
, 0),
209 ASSIGN_FETCH_TYPE(u64
, u64
, 0),
210 ASSIGN_FETCH_TYPE(s8
, u8
, 1),
211 ASSIGN_FETCH_TYPE(s16
, u16
, 1),
212 ASSIGN_FETCH_TYPE(s32
, u32
, 1),
213 ASSIGN_FETCH_TYPE(s64
, u64
, 1),
215 ASSIGN_FETCH_TYPE_END
218 static inline void init_trace_uprobe_filter(struct trace_uprobe_filter
*filter
)
220 rwlock_init(&filter
->rwlock
);
221 filter
->nr_systemwide
= 0;
222 INIT_LIST_HEAD(&filter
->perf_events
);
225 static inline bool uprobe_filter_is_empty(struct trace_uprobe_filter
*filter
)
227 return !filter
->nr_systemwide
&& list_empty(&filter
->perf_events
);
230 static inline bool is_ret_probe(struct trace_uprobe
*tu
)
232 return tu
->consumer
.ret_handler
!= NULL
;
236 * Allocate new trace_uprobe and initialize it (including uprobes).
238 static struct trace_uprobe
*
239 alloc_trace_uprobe(const char *group
, const char *event
, int nargs
, bool is_ret
)
241 struct trace_uprobe
*tu
;
243 if (!event
|| !is_good_name(event
))
244 return ERR_PTR(-EINVAL
);
246 if (!group
|| !is_good_name(group
))
247 return ERR_PTR(-EINVAL
);
249 tu
= kzalloc(SIZEOF_TRACE_UPROBE(nargs
), GFP_KERNEL
);
251 return ERR_PTR(-ENOMEM
);
253 tu
->tp
.call
.class = &tu
->tp
.class;
254 tu
->tp
.call
.name
= kstrdup(event
, GFP_KERNEL
);
255 if (!tu
->tp
.call
.name
)
258 tu
->tp
.class.system
= kstrdup(group
, GFP_KERNEL
);
259 if (!tu
->tp
.class.system
)
262 INIT_LIST_HEAD(&tu
->list
);
263 tu
->consumer
.handler
= uprobe_dispatcher
;
265 tu
->consumer
.ret_handler
= uretprobe_dispatcher
;
266 init_trace_uprobe_filter(&tu
->filter
);
267 tu
->tp
.call
.flags
|= TRACE_EVENT_FL_USE_CALL_FILTER
;
271 kfree(tu
->tp
.call
.name
);
274 return ERR_PTR(-ENOMEM
);
277 static void free_trace_uprobe(struct trace_uprobe
*tu
)
281 for (i
= 0; i
< tu
->tp
.nr_args
; i
++)
282 traceprobe_free_probe_arg(&tu
->tp
.args
[i
]);
285 kfree(tu
->tp
.call
.class->system
);
286 kfree(tu
->tp
.call
.name
);
291 static struct trace_uprobe
*find_probe_event(const char *event
, const char *group
)
293 struct trace_uprobe
*tu
;
295 list_for_each_entry(tu
, &uprobe_list
, list
)
296 if (strcmp(tu
->tp
.call
.name
, event
) == 0 &&
297 strcmp(tu
->tp
.call
.class->system
, group
) == 0)
303 /* Unregister a trace_uprobe and probe_event: call with locking uprobe_lock */
304 static int unregister_trace_uprobe(struct trace_uprobe
*tu
)
308 ret
= unregister_uprobe_event(tu
);
313 free_trace_uprobe(tu
);
317 /* Register a trace_uprobe and probe_event */
318 static int register_trace_uprobe(struct trace_uprobe
*tu
)
320 struct trace_uprobe
*old_tu
;
323 mutex_lock(&uprobe_lock
);
325 /* register as an event */
326 old_tu
= find_probe_event(tu
->tp
.call
.name
, tu
->tp
.call
.class->system
);
328 /* delete old event */
329 ret
= unregister_trace_uprobe(old_tu
);
334 ret
= register_uprobe_event(tu
);
336 pr_warning("Failed to register probe event(%d)\n", ret
);
340 list_add_tail(&tu
->list
, &uprobe_list
);
343 mutex_unlock(&uprobe_lock
);
350 * - Add uprobe: p|r[:[GRP/]EVENT] PATH:OFFSET [FETCHARGS]
352 * - Remove uprobe: -:[GRP/]EVENT
354 static int create_trace_uprobe(int argc
, char **argv
)
356 struct trace_uprobe
*tu
;
358 char *arg
, *event
, *group
, *filename
;
359 char buf
[MAX_EVENT_NAME_LEN
];
361 unsigned long offset
;
362 bool is_delete
, is_return
;
372 /* argc must be >= 1 */
373 if (argv
[0][0] == '-')
375 else if (argv
[0][0] == 'r')
377 else if (argv
[0][0] != 'p') {
378 pr_info("Probe definition must be started with 'p', 'r' or '-'.\n");
382 if (argv
[0][1] == ':') {
384 arg
= strchr(event
, '/');
391 if (strlen(group
) == 0) {
392 pr_info("Group name is not specified\n");
396 if (strlen(event
) == 0) {
397 pr_info("Event name is not specified\n");
402 group
= UPROBE_EVENT_SYSTEM
;
408 pr_info("Delete command needs an event name.\n");
411 mutex_lock(&uprobe_lock
);
412 tu
= find_probe_event(event
, group
);
415 mutex_unlock(&uprobe_lock
);
416 pr_info("Event %s/%s doesn't exist.\n", group
, event
);
419 /* delete an event */
420 ret
= unregister_trace_uprobe(tu
);
421 mutex_unlock(&uprobe_lock
);
426 pr_info("Probe point is not specified.\n");
429 if (isdigit(argv
[1][0])) {
430 pr_info("probe point must be have a filename.\n");
433 arg
= strchr(argv
[1], ':');
436 goto fail_address_parse
;
441 ret
= kern_path(filename
, LOOKUP_FOLLOW
, &path
);
443 goto fail_address_parse
;
445 inode
= igrab(path
.dentry
->d_inode
);
448 if (!inode
|| !S_ISREG(inode
->i_mode
)) {
450 goto fail_address_parse
;
453 ret
= kstrtoul(arg
, 0, &offset
);
455 goto fail_address_parse
;
465 tail
= kstrdup(kbasename(filename
), GFP_KERNEL
);
468 goto fail_address_parse
;
471 ptr
= strpbrk(tail
, ".-_");
475 snprintf(buf
, MAX_EVENT_NAME_LEN
, "%c_%s_0x%lx", 'p', tail
, offset
);
480 tu
= alloc_trace_uprobe(group
, event
, argc
, is_return
);
482 pr_info("Failed to allocate trace_uprobe.(%d)\n", (int)PTR_ERR(tu
));
484 goto fail_address_parse
;
488 tu
->filename
= kstrdup(filename
, GFP_KERNEL
);
491 pr_info("Failed to allocate filename.\n");
496 /* parse arguments */
498 for (i
= 0; i
< argc
&& i
< MAX_TRACE_ARGS
; i
++) {
499 struct probe_arg
*parg
= &tu
->tp
.args
[i
];
501 /* Increment count for freeing args in error case */
504 /* Parse argument name */
505 arg
= strchr(argv
[i
], '=');
508 parg
->name
= kstrdup(argv
[i
], GFP_KERNEL
);
511 /* If argument name is omitted, set "argN" */
512 snprintf(buf
, MAX_EVENT_NAME_LEN
, "arg%d", i
+ 1);
513 parg
->name
= kstrdup(buf
, GFP_KERNEL
);
517 pr_info("Failed to allocate argument[%d] name.\n", i
);
522 if (!is_good_name(parg
->name
)) {
523 pr_info("Invalid argument[%d] name: %s\n", i
, parg
->name
);
528 if (traceprobe_conflict_field_name(parg
->name
, tu
->tp
.args
, i
)) {
529 pr_info("Argument[%d] name '%s' conflicts with "
530 "another field.\n", i
, argv
[i
]);
535 /* Parse fetch argument */
536 ret
= traceprobe_parse_probe_arg(arg
, &tu
->tp
.size
, parg
,
539 pr_info("Parse error at argument[%d]. (%d)\n", i
, ret
);
544 ret
= register_trace_uprobe(tu
);
550 free_trace_uprobe(tu
);
557 pr_info("Failed to parse address or file.\n");
562 static int cleanup_all_probes(void)
564 struct trace_uprobe
*tu
;
567 mutex_lock(&uprobe_lock
);
568 while (!list_empty(&uprobe_list
)) {
569 tu
= list_entry(uprobe_list
.next
, struct trace_uprobe
, list
);
570 ret
= unregister_trace_uprobe(tu
);
574 mutex_unlock(&uprobe_lock
);
578 /* Probes listing interfaces */
579 static void *probes_seq_start(struct seq_file
*m
, loff_t
*pos
)
581 mutex_lock(&uprobe_lock
);
582 return seq_list_start(&uprobe_list
, *pos
);
585 static void *probes_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
587 return seq_list_next(v
, &uprobe_list
, pos
);
590 static void probes_seq_stop(struct seq_file
*m
, void *v
)
592 mutex_unlock(&uprobe_lock
);
595 static int probes_seq_show(struct seq_file
*m
, void *v
)
597 struct trace_uprobe
*tu
= v
;
598 char c
= is_ret_probe(tu
) ? 'r' : 'p';
601 seq_printf(m
, "%c:%s/%s", c
, tu
->tp
.call
.class->system
, tu
->tp
.call
.name
);
602 seq_printf(m
, " %s:0x%p", tu
->filename
, (void *)tu
->offset
);
604 for (i
= 0; i
< tu
->tp
.nr_args
; i
++)
605 seq_printf(m
, " %s=%s", tu
->tp
.args
[i
].name
, tu
->tp
.args
[i
].comm
);
611 static const struct seq_operations probes_seq_op
= {
612 .start
= probes_seq_start
,
613 .next
= probes_seq_next
,
614 .stop
= probes_seq_stop
,
615 .show
= probes_seq_show
618 static int probes_open(struct inode
*inode
, struct file
*file
)
622 if ((file
->f_mode
& FMODE_WRITE
) && (file
->f_flags
& O_TRUNC
)) {
623 ret
= cleanup_all_probes();
628 return seq_open(file
, &probes_seq_op
);
631 static ssize_t
probes_write(struct file
*file
, const char __user
*buffer
,
632 size_t count
, loff_t
*ppos
)
634 return traceprobe_probes_write(file
, buffer
, count
, ppos
, create_trace_uprobe
);
637 static const struct file_operations uprobe_events_ops
= {
638 .owner
= THIS_MODULE
,
642 .release
= seq_release
,
643 .write
= probes_write
,
646 /* Probes profiling interfaces */
647 static int probes_profile_seq_show(struct seq_file
*m
, void *v
)
649 struct trace_uprobe
*tu
= v
;
651 seq_printf(m
, " %s %-44s %15lu\n", tu
->filename
, tu
->tp
.call
.name
, tu
->nhit
);
655 static const struct seq_operations profile_seq_op
= {
656 .start
= probes_seq_start
,
657 .next
= probes_seq_next
,
658 .stop
= probes_seq_stop
,
659 .show
= probes_profile_seq_show
662 static int profile_open(struct inode
*inode
, struct file
*file
)
664 return seq_open(file
, &profile_seq_op
);
667 static const struct file_operations uprobe_profile_ops
= {
668 .owner
= THIS_MODULE
,
669 .open
= profile_open
,
672 .release
= seq_release
,
675 struct uprobe_cpu_buffer
{
679 static struct uprobe_cpu_buffer __percpu
*uprobe_cpu_buffer
;
680 static int uprobe_buffer_refcnt
;
682 static int uprobe_buffer_init(void)
686 uprobe_cpu_buffer
= alloc_percpu(struct uprobe_cpu_buffer
);
687 if (uprobe_cpu_buffer
== NULL
)
690 for_each_possible_cpu(cpu
) {
691 struct page
*p
= alloc_pages_node(cpu_to_node(cpu
),
697 per_cpu_ptr(uprobe_cpu_buffer
, cpu
)->buf
= page_address(p
);
698 mutex_init(&per_cpu_ptr(uprobe_cpu_buffer
, cpu
)->mutex
);
704 for_each_possible_cpu(cpu
) {
707 free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer
, cpu
)->buf
);
710 free_percpu(uprobe_cpu_buffer
);
714 static int uprobe_buffer_enable(void)
718 BUG_ON(!mutex_is_locked(&event_mutex
));
720 if (uprobe_buffer_refcnt
++ == 0) {
721 ret
= uprobe_buffer_init();
723 uprobe_buffer_refcnt
--;
729 static void uprobe_buffer_disable(void)
733 BUG_ON(!mutex_is_locked(&event_mutex
));
735 if (--uprobe_buffer_refcnt
== 0) {
736 for_each_possible_cpu(cpu
)
737 free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer
,
740 free_percpu(uprobe_cpu_buffer
);
741 uprobe_cpu_buffer
= NULL
;
745 static struct uprobe_cpu_buffer
*uprobe_buffer_get(void)
747 struct uprobe_cpu_buffer
*ucb
;
750 cpu
= raw_smp_processor_id();
751 ucb
= per_cpu_ptr(uprobe_cpu_buffer
, cpu
);
754 * Use per-cpu buffers for fastest access, but we might migrate
755 * so the mutex makes sure we have sole access to it.
757 mutex_lock(&ucb
->mutex
);
762 static void uprobe_buffer_put(struct uprobe_cpu_buffer
*ucb
)
764 mutex_unlock(&ucb
->mutex
);
767 static void uprobe_trace_print(struct trace_uprobe
*tu
,
768 unsigned long func
, struct pt_regs
*regs
)
770 struct uprobe_trace_entry_head
*entry
;
771 struct ring_buffer_event
*event
;
772 struct ring_buffer
*buffer
;
773 struct uprobe_cpu_buffer
*ucb
;
775 int size
, dsize
, esize
;
776 struct ftrace_event_call
*call
= &tu
->tp
.call
;
778 dsize
= __get_data_size(&tu
->tp
, regs
);
779 esize
= SIZEOF_TRACE_ENTRY(is_ret_probe(tu
));
781 if (WARN_ON_ONCE(!uprobe_cpu_buffer
|| tu
->tp
.size
+ dsize
> PAGE_SIZE
))
784 ucb
= uprobe_buffer_get();
785 store_trace_args(esize
, &tu
->tp
, regs
, ucb
->buf
, dsize
);
787 size
= esize
+ tu
->tp
.size
+ dsize
;
788 event
= trace_current_buffer_lock_reserve(&buffer
, call
->event
.type
,
793 entry
= ring_buffer_event_data(event
);
794 if (is_ret_probe(tu
)) {
795 entry
->vaddr
[0] = func
;
796 entry
->vaddr
[1] = instruction_pointer(regs
);
797 data
= DATAOF_TRACE_ENTRY(entry
, true);
799 entry
->vaddr
[0] = instruction_pointer(regs
);
800 data
= DATAOF_TRACE_ENTRY(entry
, false);
803 memcpy(data
, ucb
->buf
, tu
->tp
.size
+ dsize
);
805 if (!call_filter_check_discard(call
, entry
, buffer
, event
))
806 trace_buffer_unlock_commit(buffer
, event
, 0, 0);
809 uprobe_buffer_put(ucb
);
813 static int uprobe_trace_func(struct trace_uprobe
*tu
, struct pt_regs
*regs
)
815 if (!is_ret_probe(tu
))
816 uprobe_trace_print(tu
, 0, regs
);
820 static void uretprobe_trace_func(struct trace_uprobe
*tu
, unsigned long func
,
821 struct pt_regs
*regs
)
823 uprobe_trace_print(tu
, func
, regs
);
826 /* Event entry printers */
827 static enum print_line_t
828 print_uprobe_event(struct trace_iterator
*iter
, int flags
, struct trace_event
*event
)
830 struct uprobe_trace_entry_head
*entry
;
831 struct trace_seq
*s
= &iter
->seq
;
832 struct trace_uprobe
*tu
;
836 entry
= (struct uprobe_trace_entry_head
*)iter
->ent
;
837 tu
= container_of(event
, struct trace_uprobe
, tp
.call
.event
);
839 if (is_ret_probe(tu
)) {
840 if (!trace_seq_printf(s
, "%s: (0x%lx <- 0x%lx)", tu
->tp
.call
.name
,
841 entry
->vaddr
[1], entry
->vaddr
[0]))
843 data
= DATAOF_TRACE_ENTRY(entry
, true);
845 if (!trace_seq_printf(s
, "%s: (0x%lx)", tu
->tp
.call
.name
,
848 data
= DATAOF_TRACE_ENTRY(entry
, false);
851 for (i
= 0; i
< tu
->tp
.nr_args
; i
++) {
852 struct probe_arg
*parg
= &tu
->tp
.args
[i
];
854 if (!parg
->type
->print(s
, parg
->name
, data
+ parg
->offset
, entry
))
858 if (trace_seq_puts(s
, "\n"))
859 return TRACE_TYPE_HANDLED
;
862 return TRACE_TYPE_PARTIAL_LINE
;
865 typedef bool (*filter_func_t
)(struct uprobe_consumer
*self
,
866 enum uprobe_filter_ctx ctx
,
867 struct mm_struct
*mm
);
870 probe_event_enable(struct trace_uprobe
*tu
, int flag
, filter_func_t filter
)
874 if (trace_probe_is_enabled(&tu
->tp
))
877 ret
= uprobe_buffer_enable();
881 WARN_ON(!uprobe_filter_is_empty(&tu
->filter
));
883 tu
->tp
.flags
|= flag
;
884 tu
->consumer
.filter
= filter
;
885 ret
= uprobe_register(tu
->inode
, tu
->offset
, &tu
->consumer
);
887 tu
->tp
.flags
&= ~flag
;
892 static void probe_event_disable(struct trace_uprobe
*tu
, int flag
)
894 if (!trace_probe_is_enabled(&tu
->tp
))
897 WARN_ON(!uprobe_filter_is_empty(&tu
->filter
));
899 uprobe_unregister(tu
->inode
, tu
->offset
, &tu
->consumer
);
900 tu
->tp
.flags
&= ~flag
;
902 uprobe_buffer_disable();
905 static int uprobe_event_define_fields(struct ftrace_event_call
*event_call
)
908 struct uprobe_trace_entry_head field
;
909 struct trace_uprobe
*tu
= event_call
->data
;
911 if (is_ret_probe(tu
)) {
912 DEFINE_FIELD(unsigned long, vaddr
[0], FIELD_STRING_FUNC
, 0);
913 DEFINE_FIELD(unsigned long, vaddr
[1], FIELD_STRING_RETIP
, 0);
914 size
= SIZEOF_TRACE_ENTRY(true);
916 DEFINE_FIELD(unsigned long, vaddr
[0], FIELD_STRING_IP
, 0);
917 size
= SIZEOF_TRACE_ENTRY(false);
919 /* Set argument names as fields */
920 for (i
= 0; i
< tu
->tp
.nr_args
; i
++) {
921 struct probe_arg
*parg
= &tu
->tp
.args
[i
];
923 ret
= trace_define_field(event_call
, parg
->type
->fmttype
,
924 parg
->name
, size
+ parg
->offset
,
925 parg
->type
->size
, parg
->type
->is_signed
,
934 #ifdef CONFIG_PERF_EVENTS
936 __uprobe_perf_filter(struct trace_uprobe_filter
*filter
, struct mm_struct
*mm
)
938 struct perf_event
*event
;
940 if (filter
->nr_systemwide
)
943 list_for_each_entry(event
, &filter
->perf_events
, hw
.tp_list
) {
944 if (event
->hw
.tp_target
->mm
== mm
)
952 uprobe_filter_event(struct trace_uprobe
*tu
, struct perf_event
*event
)
954 return __uprobe_perf_filter(&tu
->filter
, event
->hw
.tp_target
->mm
);
957 static int uprobe_perf_open(struct trace_uprobe
*tu
, struct perf_event
*event
)
961 write_lock(&tu
->filter
.rwlock
);
962 if (event
->hw
.tp_target
) {
964 * event->parent != NULL means copy_process(), we can avoid
965 * uprobe_apply(). current->mm must be probed and we can rely
966 * on dup_mmap() which preserves the already installed bp's.
968 * attr.enable_on_exec means that exec/mmap will install the
969 * breakpoints we need.
971 done
= tu
->filter
.nr_systemwide
||
972 event
->parent
|| event
->attr
.enable_on_exec
||
973 uprobe_filter_event(tu
, event
);
974 list_add(&event
->hw
.tp_list
, &tu
->filter
.perf_events
);
976 done
= tu
->filter
.nr_systemwide
;
977 tu
->filter
.nr_systemwide
++;
979 write_unlock(&tu
->filter
.rwlock
);
982 uprobe_apply(tu
->inode
, tu
->offset
, &tu
->consumer
, true);
987 static int uprobe_perf_close(struct trace_uprobe
*tu
, struct perf_event
*event
)
991 write_lock(&tu
->filter
.rwlock
);
992 if (event
->hw
.tp_target
) {
993 list_del(&event
->hw
.tp_list
);
994 done
= tu
->filter
.nr_systemwide
||
995 (event
->hw
.tp_target
->flags
& PF_EXITING
) ||
996 uprobe_filter_event(tu
, event
);
998 tu
->filter
.nr_systemwide
--;
999 done
= tu
->filter
.nr_systemwide
;
1001 write_unlock(&tu
->filter
.rwlock
);
1004 uprobe_apply(tu
->inode
, tu
->offset
, &tu
->consumer
, false);
1009 static bool uprobe_perf_filter(struct uprobe_consumer
*uc
,
1010 enum uprobe_filter_ctx ctx
, struct mm_struct
*mm
)
1012 struct trace_uprobe
*tu
;
1015 tu
= container_of(uc
, struct trace_uprobe
, consumer
);
1016 read_lock(&tu
->filter
.rwlock
);
1017 ret
= __uprobe_perf_filter(&tu
->filter
, mm
);
1018 read_unlock(&tu
->filter
.rwlock
);
1023 static void uprobe_perf_print(struct trace_uprobe
*tu
,
1024 unsigned long func
, struct pt_regs
*regs
)
1026 struct ftrace_event_call
*call
= &tu
->tp
.call
;
1027 struct uprobe_trace_entry_head
*entry
;
1028 struct hlist_head
*head
;
1029 struct uprobe_cpu_buffer
*ucb
;
1031 int size
, dsize
, esize
;
1034 dsize
= __get_data_size(&tu
->tp
, regs
);
1035 esize
= SIZEOF_TRACE_ENTRY(is_ret_probe(tu
));
1037 if (WARN_ON_ONCE(!uprobe_cpu_buffer
))
1040 size
= esize
+ tu
->tp
.size
+ dsize
;
1041 size
= ALIGN(size
+ sizeof(u32
), sizeof(u64
)) - sizeof(u32
);
1042 if (WARN_ONCE(size
> PERF_MAX_TRACE_SIZE
, "profile buffer not large enough"))
1045 ucb
= uprobe_buffer_get();
1046 store_trace_args(esize
, &tu
->tp
, regs
, ucb
->buf
, dsize
);
1049 head
= this_cpu_ptr(call
->perf_events
);
1050 if (hlist_empty(head
))
1053 entry
= perf_trace_buf_prepare(size
, call
->event
.type
, regs
, &rctx
);
1057 if (is_ret_probe(tu
)) {
1058 entry
->vaddr
[0] = func
;
1059 entry
->vaddr
[1] = instruction_pointer(regs
);
1060 data
= DATAOF_TRACE_ENTRY(entry
, true);
1062 entry
->vaddr
[0] = instruction_pointer(regs
);
1063 data
= DATAOF_TRACE_ENTRY(entry
, false);
1066 memcpy(data
, ucb
->buf
, tu
->tp
.size
+ dsize
);
1068 if (size
- esize
> tu
->tp
.size
+ dsize
) {
1069 int len
= tu
->tp
.size
+ dsize
;
1071 memset(data
+ len
, 0, size
- esize
- len
);
1074 perf_trace_buf_submit(entry
, size
, rctx
, 0, 1, regs
, head
, NULL
);
1077 uprobe_buffer_put(ucb
);
1080 /* uprobe profile handler */
1081 static int uprobe_perf_func(struct trace_uprobe
*tu
, struct pt_regs
*regs
)
1083 if (!uprobe_perf_filter(&tu
->consumer
, 0, current
->mm
))
1084 return UPROBE_HANDLER_REMOVE
;
1086 if (!is_ret_probe(tu
))
1087 uprobe_perf_print(tu
, 0, regs
);
1091 static void uretprobe_perf_func(struct trace_uprobe
*tu
, unsigned long func
,
1092 struct pt_regs
*regs
)
1094 uprobe_perf_print(tu
, func
, regs
);
1096 #endif /* CONFIG_PERF_EVENTS */
1099 int trace_uprobe_register(struct ftrace_event_call
*event
, enum trace_reg type
, void *data
)
1101 struct trace_uprobe
*tu
= event
->data
;
1104 case TRACE_REG_REGISTER
:
1105 return probe_event_enable(tu
, TP_FLAG_TRACE
, NULL
);
1107 case TRACE_REG_UNREGISTER
:
1108 probe_event_disable(tu
, TP_FLAG_TRACE
);
1111 #ifdef CONFIG_PERF_EVENTS
1112 case TRACE_REG_PERF_REGISTER
:
1113 return probe_event_enable(tu
, TP_FLAG_PROFILE
, uprobe_perf_filter
);
1115 case TRACE_REG_PERF_UNREGISTER
:
1116 probe_event_disable(tu
, TP_FLAG_PROFILE
);
1119 case TRACE_REG_PERF_OPEN
:
1120 return uprobe_perf_open(tu
, data
);
1122 case TRACE_REG_PERF_CLOSE
:
1123 return uprobe_perf_close(tu
, data
);
1132 static int uprobe_dispatcher(struct uprobe_consumer
*con
, struct pt_regs
*regs
)
1134 struct trace_uprobe
*tu
;
1135 struct uprobe_dispatch_data udd
;
1138 tu
= container_of(con
, struct trace_uprobe
, consumer
);
1142 udd
.bp_addr
= instruction_pointer(regs
);
1144 current
->utask
->vaddr
= (unsigned long) &udd
;
1146 if (tu
->tp
.flags
& TP_FLAG_TRACE
)
1147 ret
|= uprobe_trace_func(tu
, regs
);
1149 #ifdef CONFIG_PERF_EVENTS
1150 if (tu
->tp
.flags
& TP_FLAG_PROFILE
)
1151 ret
|= uprobe_perf_func(tu
, regs
);
1156 static int uretprobe_dispatcher(struct uprobe_consumer
*con
,
1157 unsigned long func
, struct pt_regs
*regs
)
1159 struct trace_uprobe
*tu
;
1160 struct uprobe_dispatch_data udd
;
1162 tu
= container_of(con
, struct trace_uprobe
, consumer
);
1167 current
->utask
->vaddr
= (unsigned long) &udd
;
1169 if (tu
->tp
.flags
& TP_FLAG_TRACE
)
1170 uretprobe_trace_func(tu
, func
, regs
);
1172 #ifdef CONFIG_PERF_EVENTS
1173 if (tu
->tp
.flags
& TP_FLAG_PROFILE
)
1174 uretprobe_perf_func(tu
, func
, regs
);
1179 static struct trace_event_functions uprobe_funcs
= {
1180 .trace
= print_uprobe_event
1183 static int register_uprobe_event(struct trace_uprobe
*tu
)
1185 struct ftrace_event_call
*call
= &tu
->tp
.call
;
1188 /* Initialize ftrace_event_call */
1189 INIT_LIST_HEAD(&call
->class->fields
);
1190 call
->event
.funcs
= &uprobe_funcs
;
1191 call
->class->define_fields
= uprobe_event_define_fields
;
1193 if (set_print_fmt(&tu
->tp
, is_ret_probe(tu
)) < 0)
1196 ret
= register_ftrace_event(&call
->event
);
1198 kfree(call
->print_fmt
);
1202 call
->class->reg
= trace_uprobe_register
;
1204 ret
= trace_add_event_call(call
);
1207 pr_info("Failed to register uprobe event: %s\n", call
->name
);
1208 kfree(call
->print_fmt
);
1209 unregister_ftrace_event(&call
->event
);
1215 static int unregister_uprobe_event(struct trace_uprobe
*tu
)
1219 /* tu->event is unregistered in trace_remove_event_call() */
1220 ret
= trace_remove_event_call(&tu
->tp
.call
);
1223 kfree(tu
->tp
.call
.print_fmt
);
1224 tu
->tp
.call
.print_fmt
= NULL
;
1228 /* Make a trace interface for controling probe points */
1229 static __init
int init_uprobe_trace(void)
1231 struct dentry
*d_tracer
;
1233 d_tracer
= tracing_init_dentry();
1237 trace_create_file("uprobe_events", 0644, d_tracer
,
1238 NULL
, &uprobe_events_ops
);
1239 /* Profile interface */
1240 trace_create_file("uprobe_profile", 0444, d_tracer
,
1241 NULL
, &uprobe_profile_ops
);
1245 fs_initcall(init_uprobe_trace
);