Commit | Line | Data |
---|---|---|
b7cdc182 | 1 | /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only) |
9f36eaed | 2 | * |
886d51a3 | 3 | * probes/lttng-kprobes.c |
d6d808f3 MD |
4 | * |
5 | * LTTng kprobes integration module. | |
6 | * | |
886d51a3 | 7 | * Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
d6d808f3 MD |
8 | */ |
9 | ||
10 | #include <linux/module.h> | |
11 | #include <linux/kprobes.h> | |
f17701fb | 12 | #include <linux/slab.h> |
2df37e95 | 13 | #include <lttng/events.h> |
a67ba386 | 14 | #include <lttng/events-internal.h> |
24591303 | 15 | #include <ringbuffer/frontend_types.h> |
156a3977 MD |
16 | #include <wrapper/vmalloc.h> |
17 | #include <wrapper/irqflags.h> | |
2df37e95 | 18 | #include <lttng/tracer.h> |
caa068b5 | 19 | #include <blacklist/kprobes.h> |
d6d808f3 | 20 | |
f17701fb | 21 | static |
8bf17deb | 22 | int lttng_kprobes_event_handler_pre(struct kprobe *p, struct pt_regs *regs) |
d6d808f3 | 23 | { |
a67ba386 MD |
24 | struct lttng_kernel_event_common_private *event_priv = |
25 | container_of(p, struct lttng_kernel_event_common_private, u.kprobe.kp); | |
e2d5dbc7 | 26 | struct lttng_kernel_event_common *event = event_priv->pub; |
346cb5ee | 27 | struct lttng_kernel_probe_ctx lttng_probe_ctx = { |
e2d5dbc7 | 28 | .event = event, |
ccecf3fb | 29 | .interruptible = !lttng_regs_irqs_disabled(regs), |
79150a49 | 30 | }; |
d6d808f3 MD |
31 | unsigned long data = (unsigned long) p->addr; |
32 | ||
e2d5dbc7 MD |
33 | switch (event->type) { |
34 | case LTTNG_KERNEL_EVENT_TYPE_RECORDER: | |
35 | { | |
36 | struct lttng_kernel_event_recorder_private *event_recorder_priv = | |
37 | container_of(event_priv, struct lttng_kernel_event_recorder_private, parent); | |
38 | struct lttng_kernel_event_recorder *event_recorder = | |
39 | event_recorder_priv->pub; | |
ac847066 | 40 | struct lttng_kernel_channel_buffer *chan = event_recorder->chan; |
e2d5dbc7 | 41 | |
ac847066 | 42 | if (unlikely(!LTTNG_READ_ONCE(chan->parent.session->active))) |
e2d5dbc7 | 43 | return 0; |
ac847066 | 44 | if (unlikely(!LTTNG_READ_ONCE(chan->parent.enabled))) |
e2d5dbc7 MD |
45 | return 0; |
46 | break; | |
47 | } | |
48 | case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER: | |
49 | break; | |
50 | default: | |
51 | WARN_ON_ONCE(1); | |
52 | } | |
a67ba386 | 53 | |
e2d5dbc7 | 54 | if (unlikely(!LTTNG_READ_ONCE(event->enabled))) |
2b16f0c9 FD |
55 | return 0; |
56 | ||
e2d5dbc7 MD |
57 | switch (event->type) { |
58 | case LTTNG_KERNEL_EVENT_TYPE_RECORDER: | |
59 | { | |
60 | struct lttng_kernel_event_recorder *event_recorder = | |
61 | container_of(event, struct lttng_kernel_event_recorder, parent); | |
ac847066 | 62 | struct lttng_kernel_channel_buffer *chan = event_recorder->chan; |
e27e4381 | 63 | struct lttng_kernel_ring_buffer_ctx ctx; |
e2d5dbc7 MD |
64 | int ret; |
65 | ||
c7d9db61 MD |
66 | lib_ring_buffer_ctx_init(&ctx, event_recorder, sizeof(data), |
67 | lttng_alignof(data), <tng_probe_ctx); | |
cefd899f | 68 | ret = chan->ops->event_reserve(&ctx); |
e2d5dbc7 MD |
69 | if (ret < 0) |
70 | return 0; | |
71 | lib_ring_buffer_align_ctx(&ctx, lttng_alignof(data)); | |
72 | chan->ops->event_write(&ctx, &data, sizeof(data)); | |
73 | chan->ops->event_commit(&ctx); | |
74 | break; | |
75 | } | |
76 | case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER: | |
77 | { | |
78 | struct lttng_kernel_event_notifier *event_notifier = | |
79 | container_of(event, struct lttng_kernel_event_notifier, parent); | |
80 | struct lttng_kernel_notification_ctx notif_ctx; | |
81 | ||
82 | notif_ctx.eval_capture = LTTNG_READ_ONCE(event_notifier->eval_capture); | |
83 | event_notifier->notification_send(event_notifier, NULL, NULL, ¬if_ctx); | |
84 | break; | |
85 | } | |
86 | default: | |
87 | WARN_ON_ONCE(1); | |
88 | } | |
2b16f0c9 FD |
89 | return 0; |
90 | } | |
91 | ||
e69abdfd MD |
92 | static const struct lttng_kernel_event_field *event_fields[] = { |
93 | lttng_kernel_static_event_field("ip", | |
94 | lttng_kernel_static_type_integer_from_type(unsigned long, __BYTE_ORDER, 16), | |
95 | false, false, false), | |
96 | }; | |
97 | ||
98 | static const struct lttng_kernel_tracepoint_class tp_class = { | |
99 | .nr_fields = ARRAY_SIZE(event_fields), | |
100 | .fields = event_fields, | |
101 | }; | |
437d5aa5 | 102 | |
f17701fb MD |
103 | /* |
104 | * Create event description | |
105 | */ | |
106 | static | |
a67ba386 | 107 | int lttng_create_kprobe_event(const char *name, struct lttng_kernel_event_recorder *event_recorder) |
f17701fb | 108 | { |
437d5aa5 | 109 | struct lttng_kernel_event_desc *desc; |
f17701fb MD |
110 | int ret; |
111 | ||
437d5aa5 | 112 | desc = kzalloc(sizeof(*desc), GFP_KERNEL); |
d3dbe23c | 113 | if (!desc) |
f17701fb | 114 | return -ENOMEM; |
e69abdfd | 115 | desc->tp_class = &tp_class; |
437d5aa5 MD |
116 | desc->event_name = kstrdup(name, GFP_KERNEL); |
117 | if (!desc->event_name) { | |
f17701fb MD |
118 | ret = -ENOMEM; |
119 | goto error_str; | |
120 | } | |
dc7f600a | 121 | desc->owner = THIS_MODULE; |
a67ba386 | 122 | event_recorder->priv->parent.desc = desc; |
f17701fb MD |
123 | |
124 | return 0; | |
125 | ||
126 | error_str: | |
d3dbe23c | 127 | kfree(desc); |
f17701fb MD |
128 | return ret; |
129 | } | |
130 | ||
2b16f0c9 FD |
131 | /* |
132 | * Create event_notifier description | |
133 | */ | |
134 | static | |
a67ba386 | 135 | int lttng_create_kprobe_event_notifier(const char *name, struct lttng_kernel_event_notifier *event_notifier) |
2b16f0c9 | 136 | { |
437d5aa5 | 137 | struct lttng_kernel_event_desc *desc; |
2b16f0c9 FD |
138 | int ret; |
139 | ||
437d5aa5 | 140 | desc = kzalloc(sizeof(*desc), GFP_KERNEL); |
2b16f0c9 FD |
141 | if (!desc) |
142 | return -ENOMEM; | |
e69abdfd | 143 | desc->tp_class = &tp_class; |
437d5aa5 MD |
144 | desc->event_name = kstrdup(name, GFP_KERNEL); |
145 | if (!desc->event_name) { | |
2b16f0c9 FD |
146 | ret = -ENOMEM; |
147 | goto error_str; | |
148 | } | |
2b16f0c9 | 149 | desc->owner = THIS_MODULE; |
a67ba386 | 150 | event_notifier->priv->parent.desc = desc; |
2b16f0c9 FD |
151 | |
152 | return 0; | |
153 | ||
154 | error_str: | |
155 | kfree(desc); | |
156 | return ret; | |
157 | } | |
158 | ||
8bf17deb FD |
159 | static |
160 | int _lttng_kprobes_register(const char *symbol_name, | |
f17701fb MD |
161 | uint64_t offset, |
162 | uint64_t addr, | |
8bf17deb FD |
163 | struct lttng_kprobe *lttng_kp, |
164 | kprobe_pre_handler_t pre_handler) | |
f17701fb MD |
165 | { |
166 | int ret; | |
167 | ||
c37f2a9b MD |
168 | /* Kprobes expects a NULL symbol name if unused */ |
169 | if (symbol_name[0] == '\0') | |
170 | symbol_name = NULL; | |
171 | ||
8bf17deb FD |
172 | memset(<tng_kp->kp, 0, sizeof(lttng_kp->kp)); |
173 | lttng_kp->kp.pre_handler = pre_handler; | |
174 | ||
c37f2a9b | 175 | if (symbol_name) { |
8bf17deb | 176 | lttng_kp->symbol_name = |
606828e4 | 177 | kzalloc(LTTNG_KERNEL_ABI_SYM_NAME_LEN * sizeof(char), |
c37f2a9b | 178 | GFP_KERNEL); |
8bf17deb | 179 | if (!lttng_kp->symbol_name) { |
c37f2a9b MD |
180 | ret = -ENOMEM; |
181 | goto name_error; | |
182 | } | |
8bf17deb | 183 | memcpy(lttng_kp->symbol_name, symbol_name, |
606828e4 | 184 | LTTNG_KERNEL_ABI_SYM_NAME_LEN * sizeof(char)); |
8bf17deb | 185 | lttng_kp->kp.symbol_name = lttng_kp->symbol_name; |
f17701fb | 186 | } |
8bf17deb FD |
187 | |
188 | lttng_kp->kp.offset = offset; | |
189 | lttng_kp->kp.addr = (void *) (unsigned long) addr; | |
16a9a591 MD |
190 | |
191 | /* | |
196bfc6a | 192 | * Ensure the memory we just allocated don't notify page faults. |
16a9a591 MD |
193 | * Well.. kprobes itself puts the page fault handler on the blacklist, |
194 | * but we can never be too careful. | |
195 | */ | |
263b6c88 | 196 | wrapper_vmalloc_sync_mappings(); |
16a9a591 | 197 | |
8bf17deb | 198 | ret = register_kprobe(<tng_kp->kp); |
f17701fb MD |
199 | if (ret) |
200 | goto register_error; | |
8bf17deb | 201 | |
f17701fb MD |
202 | return 0; |
203 | ||
204 | register_error: | |
8bf17deb | 205 | kfree(lttng_kp->symbol_name); |
f17701fb | 206 | name_error: |
8bf17deb FD |
207 | return ret; |
208 | } | |
209 | ||
210 | int lttng_kprobes_register_event(const char *name, | |
211 | const char *symbol_name, | |
212 | uint64_t offset, | |
213 | uint64_t addr, | |
a67ba386 | 214 | struct lttng_kernel_event_recorder *event_recorder) |
8bf17deb FD |
215 | { |
216 | int ret; | |
217 | ||
a67ba386 | 218 | ret = lttng_create_kprobe_event(name, event_recorder); |
8bf17deb FD |
219 | if (ret) |
220 | goto error; | |
221 | ||
222 | ret = _lttng_kprobes_register(symbol_name, offset, addr, | |
a67ba386 | 223 | &event_recorder->priv->parent.u.kprobe, lttng_kprobes_event_handler_pre); |
8bf17deb FD |
224 | if (ret) |
225 | goto register_error; | |
226 | ||
227 | return 0; | |
228 | ||
229 | register_error: | |
a67ba386 MD |
230 | kfree(event_recorder->priv->parent.desc->event_name); |
231 | kfree(event_recorder->priv->parent.desc); | |
f17701fb MD |
232 | error: |
233 | return ret; | |
234 | } | |
8bf17deb | 235 | EXPORT_SYMBOL_GPL(lttng_kprobes_register_event); |
f17701fb | 236 | |
2b16f0c9 FD |
237 | int lttng_kprobes_register_event_notifier(const char *symbol_name, |
238 | uint64_t offset, | |
239 | uint64_t addr, | |
a67ba386 | 240 | struct lttng_kernel_event_notifier *event_notifier) |
2b16f0c9 FD |
241 | { |
242 | int ret; | |
243 | ret = lttng_create_kprobe_event_notifier(symbol_name, event_notifier); | |
244 | if (ret) | |
245 | goto error; | |
246 | ||
247 | ret = _lttng_kprobes_register(symbol_name, offset, addr, | |
e2d5dbc7 | 248 | &event_notifier->priv->parent.u.kprobe, lttng_kprobes_event_handler_pre); |
2b16f0c9 FD |
249 | if (ret) |
250 | goto register_error; | |
251 | ||
252 | return 0; | |
253 | ||
254 | register_error: | |
a67ba386 MD |
255 | kfree(event_notifier->priv->parent.desc->event_name); |
256 | kfree(event_notifier->priv->parent.desc); | |
2b16f0c9 FD |
257 | error: |
258 | return ret; | |
259 | } | |
260 | EXPORT_SYMBOL_GPL(lttng_kprobes_register_event_notifier); | |
261 | ||
a67ba386 | 262 | void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder *event_recorder) |
f17701fb | 263 | { |
a67ba386 | 264 | unregister_kprobe(&event_recorder->priv->parent.u.kprobe.kp); |
edeb3137 | 265 | } |
8bf17deb | 266 | EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event); |
edeb3137 | 267 | |
a67ba386 | 268 | void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier) |
2b16f0c9 | 269 | { |
a67ba386 | 270 | unregister_kprobe(&event_notifier->priv->parent.u.kprobe.kp); |
2b16f0c9 FD |
271 | } |
272 | EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event_notifier); | |
273 | ||
a67ba386 | 274 | void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder *event_recorder) |
edeb3137 | 275 | { |
a67ba386 | 276 | kfree(event_recorder->priv->parent.u.kprobe.symbol_name); |
a67ba386 MD |
277 | kfree(event_recorder->priv->parent.desc->event_name); |
278 | kfree(event_recorder->priv->parent.desc); | |
f17701fb | 279 | } |
8bf17deb | 280 | EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_private); |
d6d808f3 | 281 | |
a67ba386 | 282 | void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier) |
2b16f0c9 | 283 | { |
a67ba386 MD |
284 | kfree(event_notifier->priv->parent.u.kprobe.symbol_name); |
285 | kfree(event_notifier->priv->parent.desc->event_name); | |
286 | kfree(event_notifier->priv->parent.desc); | |
2b16f0c9 FD |
287 | } |
288 | EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_notifier_private); | |
289 | ||
d6d808f3 | 290 | MODULE_LICENSE("GPL and additional rights"); |
1c124020 MJ |
291 | MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>"); |
292 | MODULE_DESCRIPTION("LTTng kprobes probes"); | |
13ab8b0a MD |
293 | MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "." |
294 | __stringify(LTTNG_MODULES_MINOR_VERSION) "." | |
295 | __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION) | |
296 | LTTNG_MODULES_EXTRAVERSION); |