1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
3 * probes/lttng-kprobes.c
5 * LTTng kprobes integration module.
7 * Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 #include <linux/module.h>
11 #include <linux/kprobes.h>
12 #include <linux/slab.h>
13 #include <lttng/events.h>
14 #include <ringbuffer/frontend_types.h>
15 #include <wrapper/vmalloc.h>
16 #include <wrapper/irqflags.h>
17 #include <lttng/tracer.h>
18 #include <blacklist/kprobes.h>
21 int lttng_kprobes_event_handler_pre(struct kprobe
*p
, struct pt_regs
*regs
)
23 struct lttng_event
*event
=
24 container_of(p
, struct lttng_event
, u
.kprobe
.kp
);
25 struct lttng_probe_ctx lttng_probe_ctx
= {
27 .interruptible
= !lttng_regs_irqs_disabled(regs
),
29 struct lttng_channel
*chan
= event
->chan
;
30 struct lib_ring_buffer_ctx ctx
;
32 unsigned long data
= (unsigned long) p
->addr
;
34 if (unlikely(!LTTNG_READ_ONCE(chan
->session
->active
)))
36 if (unlikely(!LTTNG_READ_ONCE(chan
->enabled
)))
38 if (unlikely(!LTTNG_READ_ONCE(event
->enabled
)))
41 lib_ring_buffer_ctx_init(&ctx
, chan
->chan
, <tng_probe_ctx
, sizeof(data
),
42 lttng_alignof(data
), -1);
43 ret
= chan
->ops
->event_reserve(&ctx
, event
->id
);
46 lib_ring_buffer_align_ctx(&ctx
, lttng_alignof(data
));
47 chan
->ops
->event_write(&ctx
, &data
, sizeof(data
));
48 chan
->ops
->event_commit(&ctx
);
53 int lttng_kprobes_event_notifier_handler_pre(struct kprobe
*p
, struct pt_regs
*regs
)
55 struct lttng_event_notifier
*event_notifier
=
56 container_of(p
, struct lttng_event_notifier
, u
.kprobe
.kp
);
58 if (unlikely(!READ_ONCE(event_notifier
->enabled
)))
61 event_notifier
->send_notification(event_notifier
, NULL
, NULL
);
67 * Create event description
70 int lttng_create_kprobe_event(const char *name
, struct lttng_event
*event
)
72 struct lttng_event_field
*field
;
73 struct lttng_event_desc
*desc
;
76 desc
= kzalloc(sizeof(*event
->desc
), GFP_KERNEL
);
79 desc
->name
= kstrdup(name
, GFP_KERNEL
);
85 desc
->fields
= field
=
86 kzalloc(1 * sizeof(struct lttng_event_field
), GFP_KERNEL
);
92 field
->type
.atype
= atype_integer
;
93 field
->type
.u
.integer
.size
= sizeof(unsigned long) * CHAR_BIT
;
94 field
->type
.u
.integer
.alignment
= lttng_alignof(unsigned long) * CHAR_BIT
;
95 field
->type
.u
.integer
.signedness
= lttng_is_signed_type(unsigned long);
96 field
->type
.u
.integer
.reverse_byte_order
= 0;
97 field
->type
.u
.integer
.base
= 16;
98 field
->type
.u
.integer
.encoding
= lttng_encode_none
;
99 desc
->owner
= THIS_MODULE
;
112 * Create event_notifier description
115 int lttng_create_kprobe_event_notifier(const char *name
, struct lttng_event_notifier
*event_notifier
)
117 struct lttng_event_desc
*desc
;
120 desc
= kzalloc(sizeof(*event_notifier
->desc
), GFP_KERNEL
);
123 desc
->name
= kstrdup(name
, GFP_KERNEL
);
130 desc
->owner
= THIS_MODULE
;
131 event_notifier
->desc
= desc
;
141 int _lttng_kprobes_register(const char *symbol_name
,
144 struct lttng_kprobe
*lttng_kp
,
145 kprobe_pre_handler_t pre_handler
)
149 /* Kprobes expects a NULL symbol name if unused */
150 if (symbol_name
[0] == '\0')
153 memset(<tng_kp
->kp
, 0, sizeof(lttng_kp
->kp
));
154 lttng_kp
->kp
.pre_handler
= pre_handler
;
157 lttng_kp
->symbol_name
=
158 kzalloc(LTTNG_KERNEL_SYM_NAME_LEN
* sizeof(char),
160 if (!lttng_kp
->symbol_name
) {
164 memcpy(lttng_kp
->symbol_name
, symbol_name
,
165 LTTNG_KERNEL_SYM_NAME_LEN
* sizeof(char));
166 lttng_kp
->kp
.symbol_name
= lttng_kp
->symbol_name
;
169 lttng_kp
->kp
.offset
= offset
;
170 lttng_kp
->kp
.addr
= (void *) (unsigned long) addr
;
173 * Ensure the memory we just allocated don't event_notifier page faults.
174 * Well.. kprobes itself puts the page fault handler on the blacklist,
175 * but we can never be too careful.
177 wrapper_vmalloc_sync_mappings();
179 ret
= register_kprobe(<tng_kp
->kp
);
186 kfree(lttng_kp
->symbol_name
);
191 int lttng_kprobes_register_event(const char *name
,
192 const char *symbol_name
,
195 struct lttng_event
*event
)
199 ret
= lttng_create_kprobe_event(name
, event
);
203 ret
= _lttng_kprobes_register(symbol_name
, offset
, addr
,
204 &event
->u
.kprobe
, lttng_kprobes_event_handler_pre
);
211 kfree(event
->desc
->fields
);
212 kfree(event
->desc
->name
);
217 EXPORT_SYMBOL_GPL(lttng_kprobes_register_event
);
219 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
222 struct lttng_event_notifier
*event_notifier
)
225 ret
= lttng_create_kprobe_event_notifier(symbol_name
, event_notifier
);
229 ret
= _lttng_kprobes_register(symbol_name
, offset
, addr
,
230 &event_notifier
->u
.kprobe
, lttng_kprobes_event_notifier_handler_pre
);
237 kfree(event_notifier
->desc
->name
);
238 kfree(event_notifier
->desc
);
242 EXPORT_SYMBOL_GPL(lttng_kprobes_register_event_notifier
);
244 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
246 unregister_kprobe(&event
->u
.kprobe
.kp
);
248 EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event
);
250 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
252 unregister_kprobe(&event_notifier
->u
.kprobe
.kp
);
254 EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event_notifier
);
256 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
258 kfree(event
->u
.kprobe
.symbol_name
);
259 kfree(event
->desc
->fields
);
260 kfree(event
->desc
->name
);
263 EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_private
);
265 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
267 kfree(event_notifier
->u
.kprobe
.symbol_name
);
268 kfree(event_notifier
->desc
->name
);
269 kfree(event_notifier
->desc
);
271 EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_notifier_private
);
273 MODULE_LICENSE("GPL and additional rights");
274 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
275 MODULE_DESCRIPTION("LTTng kprobes probes");
276 MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION
) "."
277 __stringify(LTTNG_MODULES_MINOR_VERSION
) "."
278 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION
)
279 LTTNG_MODULES_EXTRAVERSION
);