Move alignment into event write callback
[lttng-modules.git] / src / probes / lttng-kretprobes.c
CommitLineData
b7cdc182 1/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
9f36eaed
MJ
2 *
3 * probes/lttng-kretprobes.c
7371f44c
MD
4 *
5 * LTTng kretprobes integration module.
6 *
886d51a3 7 * Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7371f44c
MD
8 */
9
10#include <linux/module.h>
08726907 11#include <wrapper/kprobes.h>
7371f44c
MD
12#include <linux/slab.h>
13#include <linux/kref.h>
2df37e95 14#include <lttng/events.h>
a67ba386 15#include <lttng/events-internal.h>
24591303 16#include <ringbuffer/frontend_types.h>
156a3977
MD
17#include <wrapper/vmalloc.h>
18#include <wrapper/irqflags.h>
2df37e95 19#include <lttng/tracer.h>
caa068b5 20#include <blacklist/kprobes.h>
7371f44c
MD
21
22enum lttng_kretprobe_type {
1b6cc48a
MD
23 EVENT_ENTRY = 0,
24 EVENT_EXIT = 1,
7371f44c
MD
25};
26
27struct lttng_krp {
28 struct kretprobe krp;
e2d5dbc7 29 struct lttng_kernel_event_common *event[2]; /* ENTRY and EXIT */
7371f44c
MD
30 struct kref kref_register;
31 struct kref kref_alloc;
32};
33
34static
35int _lttng_kretprobes_handler(struct kretprobe_instance *krpi,
36 struct pt_regs *regs,
37 enum lttng_kretprobe_type type)
38{
39 struct lttng_krp *lttng_krp =
08726907 40 container_of(lttng_get_kretprobe(krpi), struct lttng_krp, krp);
e2d5dbc7 41 struct lttng_kernel_event_common *event = lttng_krp->event[type];
a92e844e 42 struct lttng_kernel_probe_ctx lttng_probe_ctx = {
e2d5dbc7 43 .event = event,
ccecf3fb 44 .interruptible = !lttng_regs_irqs_disabled(regs),
79150a49 45 };
7371f44c
MD
46 struct {
47 unsigned long ip;
48 unsigned long parent_ip;
49 } payload;
50
e2d5dbc7
MD
51 switch (event->type) {
52 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
53 {
54 struct lttng_kernel_event_recorder *event_recorder =
55 container_of(event, struct lttng_kernel_event_recorder, parent);
f7d06400 56 struct lttng_kernel_channel_buffer *chan = event_recorder->chan;
e2d5dbc7 57
f7d06400 58 if (unlikely(!LTTNG_READ_ONCE(chan->parent.session->active)))
e2d5dbc7 59 return 0;
f7d06400 60 if (unlikely(!LTTNG_READ_ONCE(chan->parent.enabled)))
e2d5dbc7
MD
61 return 0;
62 break;
63 }
64 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER: /* Fall-through. */
65 default:
66 WARN_ON_ONCE(1);
67 }
7371f44c 68
e2d5dbc7 69 if (unlikely(!LTTNG_READ_ONCE(event->enabled)))
7371f44c 70 return 0;
e2d5dbc7
MD
71
72 switch (event->type) {
73 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
74 {
75 struct lttng_kernel_event_recorder *event_recorder =
76 container_of(event, struct lttng_kernel_event_recorder, parent);
f7d06400 77 struct lttng_kernel_channel_buffer *chan = event_recorder->chan;
8a57ec02 78 struct lttng_kernel_ring_buffer_ctx ctx;
e2d5dbc7
MD
79 int ret;
80
81 payload.ip = (unsigned long) lttng_get_kretprobe(krpi)->kp.addr;
82 payload.parent_ip = (unsigned long) krpi->ret_addr;
83
b1199bd3
MD
84 lib_ring_buffer_ctx_init(&ctx, event_recorder, sizeof(payload),
85 lttng_alignof(payload), &lttng_probe_ctx);
c2fb9c1c 86 ret = chan->ops->event_reserve(&ctx);
e2d5dbc7
MD
87 if (ret < 0)
88 return 0;
f5ffbd77 89 chan->ops->event_write(&ctx, &payload, sizeof(payload), lttng_alignof(payload));
e2d5dbc7
MD
90 chan->ops->event_commit(&ctx);
91 break;
92 }
93 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER: /* Fall-through. */
94 default:
95 WARN_ON_ONCE(1);
96 }
7371f44c
MD
97 return 0;
98}
99
100static
101int lttng_kretprobes_handler_entry(struct kretprobe_instance *krpi,
102 struct pt_regs *regs)
103{
104 return _lttng_kretprobes_handler(krpi, regs, EVENT_ENTRY);
105}
106
107static
1b6cc48a
MD
108int lttng_kretprobes_handler_exit(struct kretprobe_instance *krpi,
109 struct pt_regs *regs)
7371f44c 110{
1b6cc48a 111 return _lttng_kretprobes_handler(krpi, regs, EVENT_EXIT);
7371f44c
MD
112}
113
6c8c025b
MD
114static const struct lttng_kernel_event_field *event_fields[] = {
115 lttng_kernel_static_event_field("ip",
116 lttng_kernel_static_type_integer_from_type(unsigned long, __BYTE_ORDER, 16),
117 false, false, false),
118 lttng_kernel_static_event_field("parent_ip",
119 lttng_kernel_static_type_integer_from_type(unsigned long, __BYTE_ORDER, 16),
120 false, false, false),
121};
122
123static const struct lttng_kernel_tracepoint_class tp_class = {
124 .nr_fields = ARRAY_SIZE(event_fields),
125 .fields = event_fields,
126};
437d5aa5 127
7371f44c
MD
128/*
129 * Create event description
130 */
131static
a67ba386 132int lttng_create_kprobe_event(const char *name, struct lttng_kernel_event_recorder *event_recorder,
7371f44c
MD
133 enum lttng_kretprobe_type type)
134{
437d5aa5 135 struct lttng_kernel_event_desc *desc;
7371f44c
MD
136 char *alloc_name;
137 size_t name_len;
138 const char *suffix = NULL;
437d5aa5 139 int ret;
7371f44c 140
437d5aa5 141 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
7371f44c
MD
142 if (!desc)
143 return -ENOMEM;
144 name_len = strlen(name);
145 switch (type) {
146 case EVENT_ENTRY:
147 suffix = "_entry";
148 break;
1b6cc48a
MD
149 case EVENT_EXIT:
150 suffix = "_exit";
7371f44c
MD
151 break;
152 }
153 name_len += strlen(suffix);
154 alloc_name = kmalloc(name_len + 1, GFP_KERNEL);
155 if (!alloc_name) {
156 ret = -ENOMEM;
157 goto error_str;
158 }
159 strcpy(alloc_name, name);
160 strcat(alloc_name, suffix);
437d5aa5 161 desc->event_name = alloc_name;
6c8c025b 162 desc->tp_class = &tp_class;
7371f44c 163 desc->owner = THIS_MODULE;
a67ba386 164 event_recorder->priv->parent.desc = desc;
7371f44c
MD
165
166 return 0;
167
7371f44c
MD
168error_str:
169 kfree(desc);
170 return ret;
171}
172
173int lttng_kretprobes_register(const char *name,
174 const char *symbol_name,
175 uint64_t offset,
176 uint64_t addr,
a67ba386
MD
177 struct lttng_kernel_event_recorder *event_recorder_entry,
178 struct lttng_kernel_event_recorder *event_recorder_exit)
7371f44c
MD
179{
180 int ret;
181 struct lttng_krp *lttng_krp;
182
183 /* Kprobes expects a NULL symbol name if unused */
184 if (symbol_name[0] == '\0')
185 symbol_name = NULL;
186
a67ba386 187 ret = lttng_create_kprobe_event(name, event_recorder_entry, EVENT_ENTRY);
7371f44c
MD
188 if (ret)
189 goto error;
a67ba386 190 ret = lttng_create_kprobe_event(name, event_recorder_exit, EVENT_EXIT);
7371f44c 191 if (ret)
1b6cc48a 192 goto event_exit_error;
7371f44c
MD
193 lttng_krp = kzalloc(sizeof(*lttng_krp), GFP_KERNEL);
194 if (!lttng_krp)
195 goto krp_error;
196 lttng_krp->krp.entry_handler = lttng_kretprobes_handler_entry;
1b6cc48a 197 lttng_krp->krp.handler = lttng_kretprobes_handler_exit;
7371f44c
MD
198 if (symbol_name) {
199 char *alloc_symbol;
200
201 alloc_symbol = kstrdup(symbol_name, GFP_KERNEL);
202 if (!alloc_symbol) {
203 ret = -ENOMEM;
204 goto name_error;
205 }
206 lttng_krp->krp.kp.symbol_name =
207 alloc_symbol;
a67ba386 208 event_recorder_entry->priv->parent.u.kretprobe.symbol_name =
7371f44c 209 alloc_symbol;
a67ba386 210 event_recorder_exit->priv->parent.u.kretprobe.symbol_name =
7371f44c
MD
211 alloc_symbol;
212 }
213 lttng_krp->krp.kp.offset = offset;
b2c4e8fb 214 lttng_krp->krp.kp.addr = (void *) (unsigned long) addr;
7371f44c
MD
215
216 /* Allow probe handler to find event structures */
e2d5dbc7
MD
217 lttng_krp->event[EVENT_ENTRY] = &event_recorder_entry->parent;
218 lttng_krp->event[EVENT_EXIT] = &event_recorder_exit->parent;
a67ba386
MD
219 event_recorder_entry->priv->parent.u.kretprobe.lttng_krp = lttng_krp;
220 event_recorder_exit->priv->parent.u.kretprobe.lttng_krp = lttng_krp;
7371f44c
MD
221
222 /*
223 * Both events must be unregistered before the kretprobe is
224 * unregistered. Same for memory allocation.
225 */
226 kref_init(&lttng_krp->kref_alloc);
9c1f4643 227 kref_get(&lttng_krp->kref_alloc); /* inc refcount to 2, no overflow. */
7371f44c 228 kref_init(&lttng_krp->kref_register);
9c1f4643 229 kref_get(&lttng_krp->kref_register); /* inc refcount to 2, no overflow. */
7371f44c
MD
230
231 /*
232 * Ensure the memory we just allocated don't trigger page faults.
233 * Well.. kprobes itself puts the page fault handler on the blacklist,
234 * but we can never be too careful.
235 */
263b6c88 236 wrapper_vmalloc_sync_mappings();
7371f44c
MD
237
238 ret = register_kretprobe(&lttng_krp->krp);
239 if (ret)
240 goto register_error;
241 return 0;
242
243register_error:
244 kfree(lttng_krp->krp.kp.symbol_name);
245name_error:
246 kfree(lttng_krp);
247krp_error:
a67ba386
MD
248 kfree(event_recorder_exit->priv->parent.desc->event_name);
249 kfree(event_recorder_exit->priv->parent.desc);
1b6cc48a 250event_exit_error:
a67ba386
MD
251 kfree(event_recorder_entry->priv->parent.desc->event_name);
252 kfree(event_recorder_entry->priv->parent.desc);
7371f44c
MD
253error:
254 return ret;
255}
256EXPORT_SYMBOL_GPL(lttng_kretprobes_register);
257
258static
259void _lttng_kretprobes_unregister_release(struct kref *kref)
260{
261 struct lttng_krp *lttng_krp =
262 container_of(kref, struct lttng_krp, kref_register);
263 unregister_kretprobe(&lttng_krp->krp);
264}
265
a67ba386 266void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder *event_recorder)
7371f44c 267{
a67ba386 268 kref_put(&event_recorder->priv->parent.u.kretprobe.lttng_krp->kref_register,
7371f44c
MD
269 _lttng_kretprobes_unregister_release);
270}
271EXPORT_SYMBOL_GPL(lttng_kretprobes_unregister);
272
273static
274void _lttng_kretprobes_release(struct kref *kref)
275{
276 struct lttng_krp *lttng_krp =
277 container_of(kref, struct lttng_krp, kref_alloc);
278 kfree(lttng_krp->krp.kp.symbol_name);
279}
280
a67ba386 281void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder *event_recorder)
7371f44c 282{
a67ba386
MD
283 kfree(event_recorder->priv->parent.desc->event_name);
284 kfree(event_recorder->priv->parent.desc);
285 kref_put(&event_recorder->priv->parent.u.kretprobe.lttng_krp->kref_alloc,
7371f44c
MD
286 _lttng_kretprobes_release);
287}
288EXPORT_SYMBOL_GPL(lttng_kretprobes_destroy_private);
289
e2d5dbc7 290int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common *event,
a0493bef
MD
291 int enable)
292{
e2d5dbc7 293 struct lttng_kernel_event_common *event_exit;
a0493bef
MD
294 struct lttng_krp *lttng_krp;
295
e2d5dbc7 296 if (event->priv->instrumentation != LTTNG_KERNEL_ABI_KRETPROBE) {
a0493bef
MD
297 return -EINVAL;
298 }
e2d5dbc7 299 if (event->enabled == enable) {
a0493bef
MD
300 return -EBUSY;
301 }
e2d5dbc7
MD
302 lttng_krp = event->priv->u.kretprobe.lttng_krp;
303 event_exit = lttng_krp->event[EVENT_EXIT];
304 WRITE_ONCE(event->enabled, enable);
305 WRITE_ONCE(event_exit->enabled, enable);
a0493bef
MD
306 return 0;
307}
308EXPORT_SYMBOL_GPL(lttng_kretprobes_event_enable_state);
309
7371f44c 310MODULE_LICENSE("GPL and additional rights");
1c124020
MJ
311MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
312MODULE_DESCRIPTION("LTTng kretprobes probes");
13ab8b0a
MD
313MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "."
314 __stringify(LTTNG_MODULES_MINOR_VERSION) "."
315 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION)
316 LTTNG_MODULES_EXTRAVERSION);
This page took 0.064832 seconds and 4 git commands to generate.