1 /* SPDX-License-Identifier: (GPL-2.0-only OR LGPL-2.1-only)
3 * probes/lttng-uprobes.c
5 * LTTng uprobes integration module.
7 * Copyright (C) 2013 Yannick Brosseau <yannick.brosseau@gmail.com>
8 * Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 #include <wrapper/fdtable.h>
13 #include <linux/list.h>
14 #include <linux/module.h>
15 #include <linux/namei.h>
16 #include <linux/slab.h>
17 #include <linux/uaccess.h>
18 #include <lttng/events.h>
19 #include <lttng/events-internal.h>
20 #include <lttng/tracer.h>
21 #include <wrapper/irqflags.h>
22 #include <ringbuffer/frontend_types.h>
23 #include <wrapper/uprobes.h>
24 #include <wrapper/vmalloc.h>
27 int lttng_uprobes_event_handler_pre(struct uprobe_consumer
*uc
, struct pt_regs
*regs
)
29 struct lttng_uprobe_handler
*uprobe_handler
=
30 container_of(uc
, struct lttng_uprobe_handler
, up_consumer
);
31 struct lttng_kernel_event_common
*event
= uprobe_handler
->event
;
32 struct lttng_kernel_probe_ctx lttng_probe_ctx
= {
34 .interruptible
= !lttng_regs_irqs_disabled(regs
),
40 switch (event
->type
) {
41 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
43 struct lttng_kernel_event_recorder
*event_recorder
=
44 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
45 struct lttng_kernel_channel_buffer
*chan
= event_recorder
->chan
;
47 if (unlikely(!LTTNG_READ_ONCE(chan
->parent
.session
->active
)))
49 if (unlikely(!LTTNG_READ_ONCE(chan
->parent
.enabled
)))
53 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
59 if (unlikely(!LTTNG_READ_ONCE(event
->enabled
)))
62 switch (event
->type
) {
63 case LTTNG_KERNEL_EVENT_TYPE_RECORDER
:
65 struct lttng_kernel_event_recorder
*event_recorder
=
66 container_of(event
, struct lttng_kernel_event_recorder
, parent
);
67 struct lttng_kernel_channel_buffer
*chan
= event_recorder
->chan
;
68 struct lttng_kernel_ring_buffer_ctx ctx
;
71 lib_ring_buffer_ctx_init(&ctx
, event_recorder
,
72 sizeof(payload
), lttng_alignof(payload
), <tng_probe_ctx
);
74 ret
= chan
->ops
->event_reserve(&ctx
);
79 payload
.ip
= (unsigned long)instruction_pointer(regs
);
81 chan
->ops
->event_write(&ctx
, &payload
, sizeof(payload
), lttng_alignof(payload
));
82 chan
->ops
->event_commit(&ctx
);
85 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
:
87 struct lttng_kernel_event_notifier
*event_notifier
=
88 container_of(event
, struct lttng_kernel_event_notifier
, parent
);
89 struct lttng_kernel_notification_ctx notif_ctx
;
91 notif_ctx
.eval_capture
= LTTNG_READ_ONCE(event_notifier
->eval_capture
);
92 event_notifier
->notification_send(event_notifier
, NULL
, NULL
, ¬if_ctx
);
101 static const struct lttng_kernel_event_field
*event_fields
[] = {
102 lttng_kernel_static_event_field("ip",
103 lttng_kernel_static_type_integer_from_type(unsigned long, __BYTE_ORDER
, 16),
104 false, false, false),
107 static const struct lttng_kernel_tracepoint_class tp_class
= {
108 .nr_fields
= ARRAY_SIZE(event_fields
),
109 .fields
= event_fields
,
113 * Create event description.
116 int lttng_create_uprobe_event(const char *name
, struct lttng_kernel_event_recorder
*event_recorder
)
118 struct lttng_kernel_event_desc
*desc
;
121 desc
= kzalloc(sizeof(*desc
), GFP_KERNEL
);
124 desc
->tp_class
= &tp_class
;
125 desc
->event_name
= kstrdup(name
, GFP_KERNEL
);
126 if (!desc
->event_name
) {
130 desc
->owner
= THIS_MODULE
;
131 event_recorder
->priv
->parent
.desc
= desc
;
141 * Create event_notifier description.
144 int lttng_create_uprobe_event_notifier(const char *name
, struct lttng_kernel_event_notifier
*event_notifier
)
146 struct lttng_kernel_event_desc
*desc
;
149 desc
= kzalloc(sizeof(*desc
), GFP_KERNEL
);
152 desc
->tp_class
= &tp_class
;
153 desc
->event_name
= kstrdup(name
, GFP_KERNEL
);
154 if (!desc
->event_name
) {
158 desc
->owner
= THIS_MODULE
;
159 event_notifier
->priv
->parent
.desc
= desc
;
169 * Returns the inode struct from the current task and an fd. The inode is
170 * grabbed by this function and must be put once we are done with it using
173 static struct inode
*get_inode_from_fd(int fd
)
180 * Returns the file backing the given fd. Needs to be done inside an RCU
183 file
= lttng_lookup_fd_rcu(fd
);
185 printk(KERN_WARNING
"LTTng: Cannot access file backing the fd(%d)\n", fd
);
190 /* Grab a reference on the inode. */
191 inode
= igrab(file
->f_path
.dentry
->d_inode
);
193 printk(KERN_WARNING
"LTTng: Cannot grab a reference on the inode.\n");
201 int lttng_uprobes_add_callsite(struct lttng_uprobe
*uprobe
,
202 struct lttng_kernel_abi_event_callsite __user
*callsite
,
203 int (*handler
)(struct uprobe_consumer
*self
, struct pt_regs
*regs
),
207 struct lttng_uprobe_handler
*uprobe_handler
;
214 uprobe_handler
= kzalloc(sizeof(struct lttng_uprobe_handler
), GFP_KERNEL
);
215 if (!uprobe_handler
) {
216 printk(KERN_WARNING
"LTTng: Error allocating uprobe_handler");
221 /* Ensure the memory we just allocated don't notify page faults. */
222 wrapper_vmalloc_sync_mappings();
224 uprobe_handler
->event
= priv_data
;
225 uprobe_handler
->up_consumer
.handler
= handler
;
227 ret
= copy_from_user(&uprobe_handler
->offset
, &callsite
->u
.uprobe
.offset
, sizeof(uint64_t));
232 ret
= wrapper_uprobe_register(uprobe
->inode
,
233 uprobe_handler
->offset
, &uprobe_handler
->up_consumer
);
235 printk(KERN_WARNING
"LTTng: Error registering probe on inode %lu "
236 "and offset 0x%llx\n", uprobe
->inode
->i_ino
,
237 uprobe_handler
->offset
);
242 list_add(&uprobe_handler
->node
, &uprobe
->head
);
247 kfree(uprobe_handler
);
252 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common
*event
,
253 struct lttng_kernel_abi_event_callsite __user
*callsite
)
255 return lttng_uprobes_add_callsite(&event
->priv
->u
.uprobe
, callsite
,
256 lttng_uprobes_event_handler_pre
, event
);
258 EXPORT_SYMBOL_GPL(lttng_uprobes_event_add_callsite
);
261 int lttng_uprobes_register(struct lttng_uprobe
*uprobe
, int fd
)
266 inode
= get_inode_from_fd(fd
);
268 printk(KERN_WARNING
"LTTng: Cannot get inode from fd\n");
272 uprobe
->inode
= inode
;
273 INIT_LIST_HEAD(&uprobe
->head
);
279 int lttng_uprobes_register_event(const char *name
, int fd
, struct lttng_kernel_event_recorder
*event_recorder
)
283 ret
= lttng_create_uprobe_event(name
, event_recorder
);
287 ret
= lttng_uprobes_register(&event_recorder
->priv
->parent
.u
.uprobe
, fd
);
294 kfree(event_recorder
->priv
->parent
.desc
->event_name
);
295 kfree(event_recorder
->priv
->parent
.desc
);
299 EXPORT_SYMBOL_GPL(lttng_uprobes_register_event
);
301 int lttng_uprobes_register_event_notifier(const char *name
, int fd
,
302 struct lttng_kernel_event_notifier
*event_notifier
)
306 ret
= lttng_create_uprobe_event_notifier(name
, event_notifier
);
310 ret
= lttng_uprobes_register(&event_notifier
->priv
->parent
.u
.uprobe
, fd
);
317 kfree(event_notifier
->priv
->parent
.desc
->event_name
);
318 kfree(event_notifier
->priv
->parent
.desc
);
322 EXPORT_SYMBOL_GPL(lttng_uprobes_register_event_notifier
);
325 void lttng_uprobes_unregister(struct inode
*inode
, struct list_head
*head
)
327 struct lttng_uprobe_handler
*iter
, *tmp
;
330 * Iterate over the list of handler, remove each handler from the list
331 * and free the struct.
333 list_for_each_entry_safe(iter
, tmp
, head
, node
) {
334 wrapper_uprobe_unregister(inode
, iter
->offset
, &iter
->up_consumer
);
335 list_del(&iter
->node
);
340 void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder
*event_recorder
)
342 lttng_uprobes_unregister(event_recorder
->priv
->parent
.u
.uprobe
.inode
, &event_recorder
->priv
->parent
.u
.uprobe
.head
);
344 EXPORT_SYMBOL_GPL(lttng_uprobes_unregister_event
);
346 void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
348 lttng_uprobes_unregister(event_notifier
->priv
->parent
.u
.uprobe
.inode
, &event_notifier
->priv
->parent
.u
.uprobe
.head
);
350 EXPORT_SYMBOL_GPL(lttng_uprobes_unregister_event_notifier
);
352 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event_recorder
)
354 iput(event_recorder
->priv
->parent
.u
.uprobe
.inode
);
355 kfree(event_recorder
->priv
->parent
.desc
->event_name
);
356 kfree(event_recorder
->priv
->parent
.desc
);
358 EXPORT_SYMBOL_GPL(lttng_uprobes_destroy_event_private
);
360 void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
)
362 iput(event_notifier
->priv
->parent
.u
.uprobe
.inode
);
363 kfree(event_notifier
->priv
->parent
.desc
->event_name
);
364 kfree(event_notifier
->priv
->parent
.desc
);
366 EXPORT_SYMBOL_GPL(lttng_uprobes_destroy_event_notifier_private
);
368 MODULE_LICENSE("GPL and additional rights");
369 MODULE_AUTHOR("Yannick Brosseau");
370 MODULE_DESCRIPTION("Linux Trace Toolkit Uprobes Support");