[lttng-modules.git] / src / probes / lttng-kprobes.c

/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
 *
 * probes/lttng-kprobes.c
 *
 * LTTng kprobes integration module.
 *
 * Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#include <linux/module.h>
#include <linux/kprobes.h>
#include <linux/slab.h>
#include <lttng/events.h>
#include <lttng/events-internal.h>
#include <ringbuffer/frontend_types.h>
#include <wrapper/vmalloc.h>
#include <wrapper/irqflags.h>
#include <lttng/tracer.h>
#include <blacklist/kprobes.h>

static
int lttng_kprobes_event_handler_pre(struct kprobe *p, struct pt_regs *regs)
{
	struct lttng_kernel_event_common_private *event_priv =
		container_of(p, struct lttng_kernel_event_common_private, u.kprobe.kp);
	struct lttng_kernel_event_common *event = event_priv->pub;
	struct lttng_kernel_probe_ctx lttng_probe_ctx = {
		.event = event,
		.interruptible = !lttng_regs_irqs_disabled(regs),
	};
	unsigned long data = (unsigned long) p->addr;

	switch (event->type) {
	case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
	{
		struct lttng_kernel_event_recorder_private *event_recorder_priv =
			container_of(event_priv, struct lttng_kernel_event_recorder_private, parent);
		struct lttng_kernel_event_recorder *event_recorder =
			event_recorder_priv->pub;
		struct lttng_kernel_channel_buffer *chan = event_recorder->chan;

		if (unlikely(!LTTNG_READ_ONCE(chan->parent.session->active)))
			return 0;
		if (unlikely(!LTTNG_READ_ONCE(chan->parent.enabled)))
			return 0;
		break;
	}
	case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
		break;
	default:
		WARN_ON_ONCE(1);
	}

	if (unlikely(!LTTNG_READ_ONCE(event->enabled)))
		return 0;

	switch (event->type) {
	case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
	{
		struct lttng_kernel_event_recorder *event_recorder =
			container_of(event, struct lttng_kernel_event_recorder, parent);
		struct lttng_kernel_channel_buffer *chan = event_recorder->chan;
		struct lttng_kernel_ring_buffer_ctx ctx;
		int ret;

		lib_ring_buffer_ctx_init(&ctx, event_recorder, sizeof(data),
					 lttng_alignof(data), &lttng_probe_ctx);
		ret = chan->ops->event_reserve(&ctx);
		if (ret < 0)
			return 0;
		chan->ops->event_write(&ctx, &data, sizeof(data), lttng_alignof(data));
		chan->ops->event_commit(&ctx);
		break;
	}
	case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
	{
		struct lttng_kernel_event_notifier *event_notifier =
			container_of(event, struct lttng_kernel_event_notifier, parent);
		struct lttng_kernel_notification_ctx notif_ctx;

		notif_ctx.eval_capture = LTTNG_READ_ONCE(event_notifier->eval_capture);
		event_notifier->notification_send(event_notifier, NULL, NULL, &notif_ctx);
		break;
	}
	default:
		WARN_ON_ONCE(1);
	}
	return 0;
}

static const struct lttng_kernel_event_field *event_fields[] = {
	lttng_kernel_static_event_field("ip",
		lttng_kernel_static_type_integer_from_type(unsigned long, __BYTE_ORDER, 16),
		false, false, false),
};

static const struct lttng_kernel_tracepoint_class tp_class = {
	.nr_fields = ARRAY_SIZE(event_fields),
	.fields = event_fields,
};

/*
 * Create event description
 */
static
int lttng_create_kprobe_event(const char *name, struct lttng_kernel_event_recorder *event_recorder)
{
	struct lttng_kernel_event_desc *desc;
	int ret;

	desc = kzalloc(sizeof(*desc), GFP_KERNEL);
	if (!desc)
		return -ENOMEM;
	desc->tp_class = &tp_class;
	desc->event_name = kstrdup(name, GFP_KERNEL);
	if (!desc->event_name) {
		ret = -ENOMEM;
		goto error_str;
	}
	desc->owner = THIS_MODULE;
	event_recorder->priv->parent.desc = desc;

	return 0;

error_str:
	kfree(desc);
	return ret;
}

/*
 * Create event_notifier description
 */
static
int lttng_create_kprobe_event_notifier(const char *name, struct lttng_kernel_event_notifier *event_notifier)
{
	struct lttng_kernel_event_desc *desc;
	int ret;

	desc = kzalloc(sizeof(*desc), GFP_KERNEL);
	if (!desc)
		return -ENOMEM;
	desc->tp_class = &tp_class;
	desc->event_name = kstrdup(name, GFP_KERNEL);
	if (!desc->event_name) {
		ret = -ENOMEM;
		goto error_str;
	}
	desc->owner = THIS_MODULE;
	event_notifier->priv->parent.desc = desc;

	return 0;

error_str:
	kfree(desc);
	return ret;
}

static
int _lttng_kprobes_register(const char *symbol_name,
			   uint64_t offset,
			   uint64_t addr,
			   struct lttng_kprobe *lttng_kp,
			   kprobe_pre_handler_t pre_handler)
{
	int ret;

	/* Kprobes expects a NULL symbol name if unused */
	if (symbol_name[0] == '\0')
		symbol_name = NULL;

	memset(&lttng_kp->kp, 0, sizeof(lttng_kp->kp));
	lttng_kp->kp.pre_handler = pre_handler;

	if (symbol_name) {
		lttng_kp->symbol_name =
			kzalloc(LTTNG_KERNEL_ABI_SYM_NAME_LEN * sizeof(char),
				GFP_KERNEL);
		if (!lttng_kp->symbol_name) {
			ret = -ENOMEM;
			goto name_error;
		}
		memcpy(lttng_kp->symbol_name, symbol_name,
		       LTTNG_KERNEL_ABI_SYM_NAME_LEN * sizeof(char));
		lttng_kp->kp.symbol_name = lttng_kp->symbol_name;
	}

	lttng_kp->kp.offset = offset;
	lttng_kp->kp.addr = (void *) (unsigned long) addr;

	/*
	 * Ensure the memory we just allocated don't notify page faults.
	 * Well.. kprobes itself puts the page fault handler on the blacklist,
	 * but we can never be too careful.
	 */
	wrapper_vmalloc_sync_mappings();

	ret = register_kprobe(&lttng_kp->kp);
	if (ret)
		goto register_error;

	return 0;

register_error:
	kfree(lttng_kp->symbol_name);
name_error:
	return ret;
}

int lttng_kprobes_register_event(const char *name,
			   const char *symbol_name,
			   uint64_t offset,
			   uint64_t addr,
			   struct lttng_kernel_event_recorder *event_recorder)
{
	int ret;

	ret = lttng_create_kprobe_event(name, event_recorder);
	if (ret)
		goto error;

	ret = _lttng_kprobes_register(symbol_name, offset, addr,
		&event_recorder->priv->parent.u.kprobe, lttng_kprobes_event_handler_pre);
	if (ret)
		goto register_error;

	return 0;

register_error:
	kfree(event_recorder->priv->parent.desc->event_name);
	kfree(event_recorder->priv->parent.desc);
error:
	return ret;
}
EXPORT_SYMBOL_GPL(lttng_kprobes_register_event);

int lttng_kprobes_register_event_notifier(const char *symbol_name,
			   uint64_t offset,
			   uint64_t addr,
			   struct lttng_kernel_event_notifier *event_notifier)
{
	int ret;
	ret = lttng_create_kprobe_event_notifier(symbol_name, event_notifier);
	if (ret)
		goto error;

	ret = _lttng_kprobes_register(symbol_name, offset, addr,
		&event_notifier->priv->parent.u.kprobe, lttng_kprobes_event_handler_pre);
	if (ret)
		goto register_error;

	return 0;

register_error:
	kfree(event_notifier->priv->parent.desc->event_name);
	kfree(event_notifier->priv->parent.desc);
error:
	return ret;
}
EXPORT_SYMBOL_GPL(lttng_kprobes_register_event_notifier);

void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder *event_recorder)
{
	unregister_kprobe(&event_recorder->priv->parent.u.kprobe.kp);
}
EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event);

void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier)
{
	unregister_kprobe(&event_notifier->priv->parent.u.kprobe.kp);
}
EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event_notifier);

void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder *event_recorder)
{
	kfree(event_recorder->priv->parent.u.kprobe.symbol_name);
	kfree(event_recorder->priv->parent.desc->event_name);
	kfree(event_recorder->priv->parent.desc);
}
EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_private);

void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier)
{
	kfree(event_notifier->priv->parent.u.kprobe.symbol_name);
	kfree(event_notifier->priv->parent.desc->event_name);
	kfree(event_notifier->priv->parent.desc);
}
EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_notifier_private);

MODULE_LICENSE("GPL and additional rights");
MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
MODULE_DESCRIPTION("LTTng kprobes probes");
MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "."
	__stringify(LTTNG_MODULES_MINOR_VERSION) "."
	__stringify(LTTNG_MODULES_PATCHLEVEL_VERSION)
	LTTNG_MODULES_EXTRAVERSION);
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>
156a3977 MD	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 =
a67ba386 MD	25	container_of(p, struct lttng_kernel_event_common_private, u.kprobe.kp);
e2d5dbc7	26	struct lttng_kernel_event_common *event = event_priv->pub;
a92e844e	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;
d6d808f3 MD	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;
f7d06400	40	struct lttng_kernel_channel_buffer *chan = event_recorder->chan;
e2d5dbc7	41
f7d06400	42	if (unlikely(!LTTNG_READ_ONCE(chan->parent.session->active)))
e2d5dbc7	43	return 0;
f7d06400	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;
2b16f0c9 FD	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);
f7d06400	62	struct lttng_kernel_channel_buffer *chan = event_recorder->chan;
8a57ec02	63	struct lttng_kernel_ring_buffer_ctx ctx;
e2d5dbc7 MD	64	int ret;
e2d5dbc7 MD	65
b1199bd3 MD	66	lib_ring_buffer_ctx_init(&ctx, event_recorder, sizeof(data),
b1199bd3 MD	67	lttng_alignof(data), &lttng_probe_ctx);
c2fb9c1c	68	ret = chan->ops->event_reserve(&ctx);
e2d5dbc7 MD	69	if (ret < 0)
e2d5dbc7 MD	70	return 0;
f5ffbd77	71	chan->ops->event_write(&ctx, &data, sizeof(data), lttng_alignof(data));
e2d5dbc7 MD	72	chan->ops->event_commit(&ctx);
	73	break;
	74	}
	75	case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
	76	{
	77	struct lttng_kernel_event_notifier *event_notifier =
	78	container_of(event, struct lttng_kernel_event_notifier, parent);
	79	struct lttng_kernel_notification_ctx notif_ctx;
	80
	81	notif_ctx.eval_capture = LTTNG_READ_ONCE(event_notifier->eval_capture);
	82	event_notifier->notification_send(event_notifier, NULL, NULL, &notif_ctx);
	83	break;
	84	}
	85	default:
	86	WARN_ON_ONCE(1);
	87	}
2b16f0c9 FD	88	return 0;
	89	}
	90
6c8c025b MD	91	static const struct lttng_kernel_event_field *event_fields[] = {
	92	lttng_kernel_static_event_field("ip",
	93	lttng_kernel_static_type_integer_from_type(unsigned long, __BYTE_ORDER, 16),
	94	false, false, false),
	95	};
	96
	97	static const struct lttng_kernel_tracepoint_class tp_class = {
	98	.nr_fields = ARRAY_SIZE(event_fields),
	99	.fields = event_fields,
	100	};
437d5aa5	101
f17701fb MD	102	/*
	103	* Create event description
	104	*/
	105	static
a67ba386	106	int lttng_create_kprobe_event(const char name, struct lttng_kernel_event_recorder event_recorder)
f17701fb	107	{
437d5aa5	108	struct lttng_kernel_event_desc *desc;
f17701fb MD	109	int ret;
f17701fb MD	110
437d5aa5	111	desc = kzalloc(sizeof(*desc), GFP_KERNEL);
d3dbe23c	112	if (!desc)
f17701fb	113	return -ENOMEM;
6c8c025b	114	desc->tp_class = &tp_class;
437d5aa5 MD	115	desc->event_name = kstrdup(name, GFP_KERNEL);
437d5aa5 MD	116	if (!desc->event_name) {
f17701fb MD	117	ret = -ENOMEM;
	118	goto error_str;
	119	}
dc7f600a	120	desc->owner = THIS_MODULE;
a67ba386	121	event_recorder->priv->parent.desc = desc;
f17701fb MD	122
	123	return 0;
	124
	125	error_str:
d3dbe23c	126	kfree(desc);
f17701fb MD	127	return ret;
	128	}
	129
2b16f0c9 FD	130	/*
	131	* Create event_notifier description
	132	*/
	133	static
a67ba386	134	int lttng_create_kprobe_event_notifier(const char name, struct lttng_kernel_event_notifier event_notifier)
2b16f0c9	135	{
437d5aa5	136	struct lttng_kernel_event_desc *desc;
2b16f0c9 FD	137	int ret;
2b16f0c9 FD	138
437d5aa5	139	desc = kzalloc(sizeof(*desc), GFP_KERNEL);
2b16f0c9 FD	140	if (!desc)
2b16f0c9 FD	141	return -ENOMEM;
6c8c025b	142	desc->tp_class = &tp_class;
437d5aa5 MD	143	desc->event_name = kstrdup(name, GFP_KERNEL);
437d5aa5 MD	144	if (!desc->event_name) {
2b16f0c9 FD	145	ret = -ENOMEM;
	146	goto error_str;
	147	}
2b16f0c9	148	desc->owner = THIS_MODULE;
a67ba386	149	event_notifier->priv->parent.desc = desc;
2b16f0c9 FD	150
	151	return 0;
	152
	153	error_str:
	154	kfree(desc);
	155	return ret;
	156	}
	157
8bf17deb FD	158	static
8bf17deb FD	159	int _lttng_kprobes_register(const char *symbol_name,
f17701fb MD	160	uint64_t offset,
f17701fb MD	161	uint64_t addr,
8bf17deb FD	162	struct lttng_kprobe *lttng_kp,
8bf17deb FD	163	kprobe_pre_handler_t pre_handler)
f17701fb MD	164	{
	165	int ret;
	166
c37f2a9b MD	167	/* Kprobes expects a NULL symbol name if unused */
	168	if (symbol_name[0] == '\0')
	169	symbol_name = NULL;
	170
8bf17deb FD	171	memset(&lttng_kp->kp, 0, sizeof(lttng_kp->kp));
	172	lttng_kp->kp.pre_handler = pre_handler;
	173
c37f2a9b	174	if (symbol_name) {
8bf17deb	175	lttng_kp->symbol_name =
606828e4	176	kzalloc(LTTNG_KERNEL_ABI_SYM_NAME_LEN * sizeof(char),
c37f2a9b	177	GFP_KERNEL);
8bf17deb	178	if (!lttng_kp->symbol_name) {
c37f2a9b MD	179	ret = -ENOMEM;
	180	goto name_error;
	181	}
8bf17deb	182	memcpy(lttng_kp->symbol_name, symbol_name,
606828e4	183	LTTNG_KERNEL_ABI_SYM_NAME_LEN * sizeof(char));
8bf17deb	184	lttng_kp->kp.symbol_name = lttng_kp->symbol_name;
f17701fb	185	}
8bf17deb FD	186
	187	lttng_kp->kp.offset = offset;
	188	lttng_kp->kp.addr = (void *) (unsigned long) addr;
16a9a591 MD	189
16a9a591 MD	190	/*
196bfc6a	191	* Ensure the memory we just allocated don't notify page faults.
16a9a591 MD	192	* Well.. kprobes itself puts the page fault handler on the blacklist,
	193	* but we can never be too careful.
	194	*/
263b6c88	195	wrapper_vmalloc_sync_mappings();
16a9a591	196
8bf17deb	197	ret = register_kprobe(&lttng_kp->kp);
f17701fb MD	198	if (ret)
f17701fb MD	199	goto register_error;
8bf17deb	200
f17701fb MD	201	return 0;
	202
	203	register_error:
8bf17deb	204	kfree(lttng_kp->symbol_name);
f17701fb	205	name_error:
8bf17deb FD	206	return ret;
	207	}
	208
	209	int lttng_kprobes_register_event(const char *name,
	210	const char *symbol_name,
	211	uint64_t offset,
	212	uint64_t addr,
a67ba386	213	struct lttng_kernel_event_recorder *event_recorder)
8bf17deb FD	214	{
	215	int ret;
	216
a67ba386	217	ret = lttng_create_kprobe_event(name, event_recorder);
8bf17deb FD	218	if (ret)
	219	goto error;
	220
	221	ret = _lttng_kprobes_register(symbol_name, offset, addr,
a67ba386	222	&event_recorder->priv->parent.u.kprobe, lttng_kprobes_event_handler_pre);
8bf17deb FD	223	if (ret)
	224	goto register_error;
	225
	226	return 0;
	227
	228	register_error:
a67ba386 MD	229	kfree(event_recorder->priv->parent.desc->event_name);
a67ba386 MD	230	kfree(event_recorder->priv->parent.desc);
f17701fb MD	231	error:
	232	return ret;
	233	}
8bf17deb	234	EXPORT_SYMBOL_GPL(lttng_kprobes_register_event);
f17701fb	235
2b16f0c9 FD	236	int lttng_kprobes_register_event_notifier(const char *symbol_name,
	237	uint64_t offset,
	238	uint64_t addr,
a67ba386	239	struct lttng_kernel_event_notifier *event_notifier)
2b16f0c9 FD	240	{
	241	int ret;
	242	ret = lttng_create_kprobe_event_notifier(symbol_name, event_notifier);
	243	if (ret)
	244	goto error;
	245
	246	ret = _lttng_kprobes_register(symbol_name, offset, addr,
e2d5dbc7	247	&event_notifier->priv->parent.u.kprobe, lttng_kprobes_event_handler_pre);
2b16f0c9 FD	248	if (ret)
	249	goto register_error;
	250
	251	return 0;
	252
	253	register_error:
a67ba386 MD	254	kfree(event_notifier->priv->parent.desc->event_name);
a67ba386 MD	255	kfree(event_notifier->priv->parent.desc);
2b16f0c9 FD	256	error:
	257	return ret;
	258	}
	259	EXPORT_SYMBOL_GPL(lttng_kprobes_register_event_notifier);
	260
a67ba386	261	void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder *event_recorder)
f17701fb	262	{
a67ba386	263	unregister_kprobe(&event_recorder->priv->parent.u.kprobe.kp);
edeb3137	264	}
8bf17deb	265	EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event);
edeb3137	266
a67ba386	267	void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier)
2b16f0c9	268	{
a67ba386	269	unregister_kprobe(&event_notifier->priv->parent.u.kprobe.kp);
2b16f0c9 FD	270	}
	271	EXPORT_SYMBOL_GPL(lttng_kprobes_unregister_event_notifier);
	272
a67ba386	273	void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder *event_recorder)
edeb3137	274	{
a67ba386	275	kfree(event_recorder->priv->parent.u.kprobe.symbol_name);
a67ba386 MD	276	kfree(event_recorder->priv->parent.desc->event_name);
a67ba386 MD	277	kfree(event_recorder->priv->parent.desc);
f17701fb	278	}
8bf17deb	279	EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_private);
d6d808f3	280
a67ba386	281	void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier)
2b16f0c9	282	{
a67ba386 MD	283	kfree(event_notifier->priv->parent.u.kprobe.symbol_name);
	284	kfree(event_notifier->priv->parent.desc->event_name);
	285	kfree(event_notifier->priv->parent.desc);
2b16f0c9 FD	286	}
	287	EXPORT_SYMBOL_GPL(lttng_kprobes_destroy_event_notifier_private);
	288
d6d808f3	289	MODULE_LICENSE("GPL and additional rights");
1c124020 MJ	290	MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
1c124020 MJ	291	MODULE_DESCRIPTION("LTTng kprobes probes");
13ab8b0a MD	292	MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "."
	293	__stringify(LTTNG_MODULES_MINOR_VERSION) "."
	294	__stringify(LTTNG_MODULES_PATCHLEVEL_VERSION)
	295	LTTNG_MODULES_EXTRAVERSION);