drbd: merge_bvec_fn: properly remap bvm->bi_bdev
[linux/fpc-iii.git] / kernel / trace / trace_uprobe.c
blobbd0c9b133b54857923c548c5678362dfde522d49
1 /*
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 {
44 rwlock_t rwlock;
45 int nr_systemwide;
46 struct list_head perf_events;
50 * uprobe event core functions
52 struct trace_uprobe {
53 struct list_head list;
54 struct trace_uprobe_filter filter;
55 struct uprobe_consumer consumer;
56 struct inode *inode;
57 char *filename;
58 unsigned long offset;
59 unsigned long nhit;
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));
87 #else
88 static unsigned long adjust_stack_addr(unsigned long addr, unsigned int n)
90 return addr + (n * sizeof(long));
92 #endif
94 static unsigned long get_user_stack_nth(struct pt_regs *regs, unsigned int n)
96 unsigned long ret;
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)))
102 return 0;
104 return 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) \
126 type retval; \
127 void __user *vaddr = (void __force __user *) addr; \
129 if (copy_from_user(&retval, vaddr, sizeof(type))) \
130 *(type *)dest = 0; \
131 else \
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)
142 long ret;
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;
148 if (!maxlen)
149 return;
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));
156 } else {
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)
164 int len;
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 */
170 *(u32 *)dest = 0;
171 else
172 *(u32 *)dest = len;
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[] = {
200 /* Special types */
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"),
205 /* Basic types */
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);
250 if (!tu)
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)
256 goto error;
258 tu->tp.class.system = kstrdup(group, GFP_KERNEL);
259 if (!tu->tp.class.system)
260 goto error;
262 INIT_LIST_HEAD(&tu->list);
263 tu->consumer.handler = uprobe_dispatcher;
264 if (is_ret)
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;
268 return tu;
270 error:
271 kfree(tu->tp.call.name);
272 kfree(tu);
274 return ERR_PTR(-ENOMEM);
277 static void free_trace_uprobe(struct trace_uprobe *tu)
279 int i;
281 for (i = 0; i < tu->tp.nr_args; i++)
282 traceprobe_free_probe_arg(&tu->tp.args[i]);
284 iput(tu->inode);
285 kfree(tu->tp.call.class->system);
286 kfree(tu->tp.call.name);
287 kfree(tu->filename);
288 kfree(tu);
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)
298 return tu;
300 return NULL;
303 /* Unregister a trace_uprobe and probe_event: call with locking uprobe_lock */
304 static int unregister_trace_uprobe(struct trace_uprobe *tu)
306 int ret;
308 ret = unregister_uprobe_event(tu);
309 if (ret)
310 return ret;
312 list_del(&tu->list);
313 free_trace_uprobe(tu);
314 return 0;
317 /* Register a trace_uprobe and probe_event */
318 static int register_trace_uprobe(struct trace_uprobe *tu)
320 struct trace_uprobe *old_tu;
321 int ret;
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);
327 if (old_tu) {
328 /* delete old event */
329 ret = unregister_trace_uprobe(old_tu);
330 if (ret)
331 goto end;
334 ret = register_uprobe_event(tu);
335 if (ret) {
336 pr_warning("Failed to register probe event(%d)\n", ret);
337 goto end;
340 list_add_tail(&tu->list, &uprobe_list);
342 end:
343 mutex_unlock(&uprobe_lock);
345 return ret;
349 * Argument syntax:
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;
357 struct inode *inode;
358 char *arg, *event, *group, *filename;
359 char buf[MAX_EVENT_NAME_LEN];
360 struct path path;
361 unsigned long offset;
362 bool is_delete, is_return;
363 int i, ret;
365 inode = NULL;
366 ret = 0;
367 is_delete = false;
368 is_return = false;
369 event = NULL;
370 group = NULL;
372 /* argc must be >= 1 */
373 if (argv[0][0] == '-')
374 is_delete = true;
375 else if (argv[0][0] == 'r')
376 is_return = true;
377 else if (argv[0][0] != 'p') {
378 pr_info("Probe definition must be started with 'p', 'r' or '-'.\n");
379 return -EINVAL;
382 if (argv[0][1] == ':') {
383 event = &argv[0][2];
384 arg = strchr(event, '/');
386 if (arg) {
387 group = event;
388 event = arg + 1;
389 event[-1] = '\0';
391 if (strlen(group) == 0) {
392 pr_info("Group name is not specified\n");
393 return -EINVAL;
396 if (strlen(event) == 0) {
397 pr_info("Event name is not specified\n");
398 return -EINVAL;
401 if (!group)
402 group = UPROBE_EVENT_SYSTEM;
404 if (is_delete) {
405 int ret;
407 if (!event) {
408 pr_info("Delete command needs an event name.\n");
409 return -EINVAL;
411 mutex_lock(&uprobe_lock);
412 tu = find_probe_event(event, group);
414 if (!tu) {
415 mutex_unlock(&uprobe_lock);
416 pr_info("Event %s/%s doesn't exist.\n", group, event);
417 return -ENOENT;
419 /* delete an event */
420 ret = unregister_trace_uprobe(tu);
421 mutex_unlock(&uprobe_lock);
422 return ret;
425 if (argc < 2) {
426 pr_info("Probe point is not specified.\n");
427 return -EINVAL;
429 if (isdigit(argv[1][0])) {
430 pr_info("probe point must be have a filename.\n");
431 return -EINVAL;
433 arg = strchr(argv[1], ':');
434 if (!arg) {
435 ret = -EINVAL;
436 goto fail_address_parse;
439 *arg++ = '\0';
440 filename = argv[1];
441 ret = kern_path(filename, LOOKUP_FOLLOW, &path);
442 if (ret)
443 goto fail_address_parse;
445 inode = igrab(path.dentry->d_inode);
446 path_put(&path);
448 if (!inode || !S_ISREG(inode->i_mode)) {
449 ret = -EINVAL;
450 goto fail_address_parse;
453 ret = kstrtoul(arg, 0, &offset);
454 if (ret)
455 goto fail_address_parse;
457 argc -= 2;
458 argv += 2;
460 /* setup a probe */
461 if (!event) {
462 char *tail;
463 char *ptr;
465 tail = kstrdup(kbasename(filename), GFP_KERNEL);
466 if (!tail) {
467 ret = -ENOMEM;
468 goto fail_address_parse;
471 ptr = strpbrk(tail, ".-_");
472 if (ptr)
473 *ptr = '\0';
475 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_0x%lx", 'p', tail, offset);
476 event = buf;
477 kfree(tail);
480 tu = alloc_trace_uprobe(group, event, argc, is_return);
481 if (IS_ERR(tu)) {
482 pr_info("Failed to allocate trace_uprobe.(%d)\n", (int)PTR_ERR(tu));
483 ret = PTR_ERR(tu);
484 goto fail_address_parse;
486 tu->offset = offset;
487 tu->inode = inode;
488 tu->filename = kstrdup(filename, GFP_KERNEL);
490 if (!tu->filename) {
491 pr_info("Failed to allocate filename.\n");
492 ret = -ENOMEM;
493 goto error;
496 /* parse arguments */
497 ret = 0;
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 */
502 tu->tp.nr_args++;
504 /* Parse argument name */
505 arg = strchr(argv[i], '=');
506 if (arg) {
507 *arg++ = '\0';
508 parg->name = kstrdup(argv[i], GFP_KERNEL);
509 } else {
510 arg = argv[i];
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);
516 if (!parg->name) {
517 pr_info("Failed to allocate argument[%d] name.\n", i);
518 ret = -ENOMEM;
519 goto error;
522 if (!is_good_name(parg->name)) {
523 pr_info("Invalid argument[%d] name: %s\n", i, parg->name);
524 ret = -EINVAL;
525 goto error;
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]);
531 ret = -EINVAL;
532 goto error;
535 /* Parse fetch argument */
536 ret = traceprobe_parse_probe_arg(arg, &tu->tp.size, parg,
537 is_return, false);
538 if (ret) {
539 pr_info("Parse error at argument[%d]. (%d)\n", i, ret);
540 goto error;
544 ret = register_trace_uprobe(tu);
545 if (ret)
546 goto error;
547 return 0;
549 error:
550 free_trace_uprobe(tu);
551 return ret;
553 fail_address_parse:
554 if (inode)
555 iput(inode);
557 pr_info("Failed to parse address or file.\n");
559 return ret;
562 static int cleanup_all_probes(void)
564 struct trace_uprobe *tu;
565 int ret = 0;
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);
571 if (ret)
572 break;
574 mutex_unlock(&uprobe_lock);
575 return ret;
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';
599 int i;
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);
607 seq_printf(m, "\n");
608 return 0;
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)
620 int ret;
622 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
623 ret = cleanup_all_probes();
624 if (ret)
625 return ret;
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,
639 .open = probes_open,
640 .read = seq_read,
641 .llseek = seq_lseek,
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);
652 return 0;
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,
670 .read = seq_read,
671 .llseek = seq_lseek,
672 .release = seq_release,
675 struct uprobe_cpu_buffer {
676 struct mutex mutex;
677 void *buf;
679 static struct uprobe_cpu_buffer __percpu *uprobe_cpu_buffer;
680 static int uprobe_buffer_refcnt;
682 static int uprobe_buffer_init(void)
684 int cpu, err_cpu;
686 uprobe_cpu_buffer = alloc_percpu(struct uprobe_cpu_buffer);
687 if (uprobe_cpu_buffer == NULL)
688 return -ENOMEM;
690 for_each_possible_cpu(cpu) {
691 struct page *p = alloc_pages_node(cpu_to_node(cpu),
692 GFP_KERNEL, 0);
693 if (p == NULL) {
694 err_cpu = cpu;
695 goto err;
697 per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf = page_address(p);
698 mutex_init(&per_cpu_ptr(uprobe_cpu_buffer, cpu)->mutex);
701 return 0;
703 err:
704 for_each_possible_cpu(cpu) {
705 if (cpu == err_cpu)
706 break;
707 free_page((unsigned long)per_cpu_ptr(uprobe_cpu_buffer, cpu)->buf);
710 free_percpu(uprobe_cpu_buffer);
711 return -ENOMEM;
714 static int uprobe_buffer_enable(void)
716 int ret = 0;
718 BUG_ON(!mutex_is_locked(&event_mutex));
720 if (uprobe_buffer_refcnt++ == 0) {
721 ret = uprobe_buffer_init();
722 if (ret < 0)
723 uprobe_buffer_refcnt--;
726 return ret;
729 static void uprobe_buffer_disable(void)
731 int cpu;
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,
738 cpu)->buf);
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;
748 int cpu;
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);
759 return ucb;
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;
774 void *data;
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))
782 return;
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,
789 size, 0, 0);
790 if (!event)
791 goto out;
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);
798 } else {
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);
808 out:
809 uprobe_buffer_put(ucb);
812 /* uprobe handler */
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);
817 return 0;
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;
833 u8 *data;
834 int i;
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]))
842 goto partial;
843 data = DATAOF_TRACE_ENTRY(entry, true);
844 } else {
845 if (!trace_seq_printf(s, "%s: (0x%lx)", tu->tp.call.name,
846 entry->vaddr[0]))
847 goto partial;
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))
855 goto partial;
858 if (trace_seq_puts(s, "\n"))
859 return TRACE_TYPE_HANDLED;
861 partial:
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);
869 static int
870 probe_event_enable(struct trace_uprobe *tu, int flag, filter_func_t filter)
872 int ret = 0;
874 if (trace_probe_is_enabled(&tu->tp))
875 return -EINTR;
877 ret = uprobe_buffer_enable();
878 if (ret < 0)
879 return ret;
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);
886 if (ret)
887 tu->tp.flags &= ~flag;
889 return ret;
892 static void probe_event_disable(struct trace_uprobe *tu, int flag)
894 if (!trace_probe_is_enabled(&tu->tp))
895 return;
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)
907 int ret, i, size;
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);
915 } else {
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,
926 FILTER_OTHER);
928 if (ret)
929 return ret;
931 return 0;
934 #ifdef CONFIG_PERF_EVENTS
935 static bool
936 __uprobe_perf_filter(struct trace_uprobe_filter *filter, struct mm_struct *mm)
938 struct perf_event *event;
940 if (filter->nr_systemwide)
941 return true;
943 list_for_each_entry(event, &filter->perf_events, hw.tp_list) {
944 if (event->hw.tp_target->mm == mm)
945 return true;
948 return false;
951 static inline bool
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)
959 bool done;
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);
975 } else {
976 done = tu->filter.nr_systemwide;
977 tu->filter.nr_systemwide++;
979 write_unlock(&tu->filter.rwlock);
981 if (!done)
982 uprobe_apply(tu->inode, tu->offset, &tu->consumer, true);
984 return 0;
987 static int uprobe_perf_close(struct trace_uprobe *tu, struct perf_event *event)
989 bool done;
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);
997 } else {
998 tu->filter.nr_systemwide--;
999 done = tu->filter.nr_systemwide;
1001 write_unlock(&tu->filter.rwlock);
1003 if (!done)
1004 uprobe_apply(tu->inode, tu->offset, &tu->consumer, false);
1006 return 0;
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;
1013 int ret;
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);
1020 return ret;
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;
1030 void *data;
1031 int size, dsize, esize;
1032 int rctx;
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))
1038 return;
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"))
1043 return;
1045 ucb = uprobe_buffer_get();
1046 store_trace_args(esize, &tu->tp, regs, ucb->buf, dsize);
1048 preempt_disable();
1049 head = this_cpu_ptr(call->perf_events);
1050 if (hlist_empty(head))
1051 goto out;
1053 entry = perf_trace_buf_prepare(size, call->event.type, regs, &rctx);
1054 if (!entry)
1055 goto out;
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);
1061 } else {
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);
1075 out:
1076 preempt_enable();
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);
1088 return 0;
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 */
1098 static
1099 int trace_uprobe_register(struct ftrace_event_call *event, enum trace_reg type, void *data)
1101 struct trace_uprobe *tu = event->data;
1103 switch (type) {
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);
1109 return 0;
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);
1117 return 0;
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);
1125 #endif
1126 default:
1127 return 0;
1129 return 0;
1132 static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs)
1134 struct trace_uprobe *tu;
1135 struct uprobe_dispatch_data udd;
1136 int ret = 0;
1138 tu = container_of(con, struct trace_uprobe, consumer);
1139 tu->nhit++;
1141 udd.tu = tu;
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);
1152 #endif
1153 return ret;
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);
1164 udd.tu = tu;
1165 udd.bp_addr = func;
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);
1175 #endif
1176 return 0;
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;
1186 int ret;
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)
1194 return -ENOMEM;
1196 ret = register_ftrace_event(&call->event);
1197 if (!ret) {
1198 kfree(call->print_fmt);
1199 return -ENODEV;
1201 call->flags = 0;
1202 call->class->reg = trace_uprobe_register;
1203 call->data = tu;
1204 ret = trace_add_event_call(call);
1206 if (ret) {
1207 pr_info("Failed to register uprobe event: %s\n", call->name);
1208 kfree(call->print_fmt);
1209 unregister_ftrace_event(&call->event);
1212 return ret;
1215 static int unregister_uprobe_event(struct trace_uprobe *tu)
1217 int ret;
1219 /* tu->event is unregistered in trace_remove_event_call() */
1220 ret = trace_remove_event_call(&tu->tp.call);
1221 if (ret)
1222 return ret;
1223 kfree(tu->tp.call.print_fmt);
1224 tu->tp.call.print_fmt = NULL;
1225 return 0;
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();
1234 if (!d_tracer)
1235 return 0;
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);
1242 return 0;
1245 fs_initcall(init_uprobe_trace);