[lttng-modules.git] / include / instrumentation / events / module.h

// SPDX-FileCopyrightText: 2012 Paul Woegerer <paul_woegerer@mentor.com>
//
// SPDX-License-Identifier: GPL-2.0-only

/*
 * Because linux/module.h has tracepoints in the header, and ftrace.h
 * eventually includes this file, define_trace.h includes linux/module.h
 * But we do not want the module.h to override the TRACE_SYSTEM macro
 * variable that define_trace.h is processing, so we only set it
 * when module events are being processed, which would happen when
 * CREATE_TRACE_POINTS is defined.
 */
#ifdef CREATE_TRACE_POINTS
#undef TRACE_SYSTEM
#define TRACE_SYSTEM module
#endif

#if !defined(LTTNG_TRACE_MODULE_H) || defined(TRACE_HEADER_MULTI_READ)
#define LTTNG_TRACE_MODULE_H

#include <lttng/tracepoint-event.h>
#include <lttng/kernel-version.h>
#include <linux/kernel.h>

#ifdef CONFIG_MODULES

#ifndef _TRACE_MODULE_DEF
#define _TRACE_MODULE_DEF
struct module;

#endif

LTTNG_TRACEPOINT_ENUM(taint,
	TP_ENUM_VALUES(
		ctf_enum_value("PROPRIETARY_MODULE", 1UL << TAINT_PROPRIETARY_MODULE)
		ctf_enum_value("FORCED_MODULE", 1UL << TAINT_FORCED_MODULE)
		ctf_enum_value("CPU_OUT_OF_SPEC", 1UL << TAINT_CPU_OUT_OF_SPEC)
		ctf_enum_value("FORCED_RMMOD", 1UL << TAINT_FORCED_RMMOD)
		ctf_enum_value("MACHINE_CHECK", 1UL << TAINT_MACHINE_CHECK)
		ctf_enum_value("BAD_PAGE", 1UL << TAINT_BAD_PAGE)
		ctf_enum_value("USER", 1UL << TAINT_USER)
		ctf_enum_value("DIE", 1UL << TAINT_DIE)
		ctf_enum_value("OVERRIDDEN_ACPI_TABLE", 1UL << TAINT_OVERRIDDEN_ACPI_TABLE)
		ctf_enum_value("WARN", 1UL << TAINT_WARN)
		ctf_enum_value("CRAP", 1UL << TAINT_CRAP)
		ctf_enum_value("FIRMWARE_WORKAROUND", 1UL << TAINT_FIRMWARE_WORKAROUND)
		ctf_enum_value("OOT_MODULE", 1UL << TAINT_OOT_MODULE)
		ctf_enum_value("UNSIGNED_MODULE", 1UL << TAINT_UNSIGNED_MODULE)
		ctf_enum_value("SOFTLOCKUP", 1UL << TAINT_SOFTLOCKUP)
		ctf_enum_value("LIVEPATCH", 1UL << TAINT_LIVEPATCH)
#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,15,0))
		ctf_enum_value("AUX", 1UL << TAINT_AUX)
#endif
#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,17,0))
		ctf_enum_value("RANDSTRUCT", 1UL << TAINT_RANDSTRUCT)
#endif
	)
)

LTTNG_TRACEPOINT_EVENT(module_load,

	TP_PROTO(struct module *mod),

	TP_ARGS(mod),

	TP_FIELDS(
		ctf_enum(taint, unsigned int, taints, mod->taints)
		ctf_string(name, mod->name)
	)
)

LTTNG_TRACEPOINT_EVENT(module_free,

	TP_PROTO(struct module *mod),

	TP_ARGS(mod),

	TP_FIELDS(
		ctf_string(name, mod->name)
	)
)

#ifdef CONFIG_MODULE_UNLOAD
/* trace_module_get/put are only used if CONFIG_MODULE_UNLOAD is defined */

LTTNG_TRACEPOINT_EVENT_CLASS(module_refcnt,

	TP_PROTO(struct module *mod, unsigned long ip),

	TP_ARGS(mod, ip),

	TP_FIELDS(
		ctf_integer_hex(unsigned long, ip, ip)
		ctf_integer(int, refcnt, atomic_read(&mod->refcnt))
		ctf_string(name, mod->name)
	)
)

LTTNG_TRACEPOINT_EVENT_INSTANCE(module_refcnt, module_get,

	TP_PROTO(struct module *mod, unsigned long ip),

	TP_ARGS(mod, ip)
)

LTTNG_TRACEPOINT_EVENT_INSTANCE(module_refcnt, module_put,

	TP_PROTO(struct module *mod, unsigned long ip),

	TP_ARGS(mod, ip)
)
#endif /* CONFIG_MODULE_UNLOAD */

LTTNG_TRACEPOINT_EVENT(module_request,

	TP_PROTO(char *name, bool wait, unsigned long ip),

	TP_ARGS(name, wait, ip),

	TP_FIELDS(
		ctf_integer_hex(unsigned long, ip, ip)
		ctf_integer(bool, wait, wait)
		ctf_string(name, name)
	)
)

#endif /* CONFIG_MODULES */

#endif /* LTTNG_TRACE_MODULE_H */

/* This part must be outside protection */
#include <lttng/define_trace.h>
Commit	Line	Data
	1	// SPDX-FileCopyrightText: 2012 Paul Woegerer <paul_woegerer@mentor.com>
	2	//
	3	// SPDX-License-Identifier: GPL-2.0-only
	4
	5	/*
	6	* Because linux/module.h has tracepoints in the header, and ftrace.h
	7	* eventually includes this file, define_trace.h includes linux/module.h
	8	* But we do not want the module.h to override the TRACE_SYSTEM macro
	9	* variable that define_trace.h is processing, so we only set it
	10	* when module events are being processed, which would happen when
	11	* CREATE_TRACE_POINTS is defined.
	12	*/
	13	#ifdef CREATE_TRACE_POINTS
	14	#undef TRACE_SYSTEM
	15	#define TRACE_SYSTEM module
	16	#endif
	17
	18	#if !defined(LTTNG_TRACE_MODULE_H) \|\| defined(TRACE_HEADER_MULTI_READ)
	19	#define LTTNG_TRACE_MODULE_H
	20
	21	#include <lttng/tracepoint-event.h>
	22	#include <lttng/kernel-version.h>
	23	#include <linux/kernel.h>
	24
	25	#ifdef CONFIG_MODULES
	26
	27	#ifndef _TRACE_MODULE_DEF
	28	#define _TRACE_MODULE_DEF
	29	struct module;
	30
	31	#endif
	32
	33	LTTNG_TRACEPOINT_ENUM(taint,
	34	TP_ENUM_VALUES(
	35	ctf_enum_value("PROPRIETARY_MODULE", 1UL << TAINT_PROPRIETARY_MODULE)
	36	ctf_enum_value("FORCED_MODULE", 1UL << TAINT_FORCED_MODULE)
	37	ctf_enum_value("CPU_OUT_OF_SPEC", 1UL << TAINT_CPU_OUT_OF_SPEC)
	38	ctf_enum_value("FORCED_RMMOD", 1UL << TAINT_FORCED_RMMOD)
	39	ctf_enum_value("MACHINE_CHECK", 1UL << TAINT_MACHINE_CHECK)
	40	ctf_enum_value("BAD_PAGE", 1UL << TAINT_BAD_PAGE)
	41	ctf_enum_value("USER", 1UL << TAINT_USER)
	42	ctf_enum_value("DIE", 1UL << TAINT_DIE)
	43	ctf_enum_value("OVERRIDDEN_ACPI_TABLE", 1UL << TAINT_OVERRIDDEN_ACPI_TABLE)
	44	ctf_enum_value("WARN", 1UL << TAINT_WARN)
	45	ctf_enum_value("CRAP", 1UL << TAINT_CRAP)
	46	ctf_enum_value("FIRMWARE_WORKAROUND", 1UL << TAINT_FIRMWARE_WORKAROUND)
	47	ctf_enum_value("OOT_MODULE", 1UL << TAINT_OOT_MODULE)
	48	ctf_enum_value("UNSIGNED_MODULE", 1UL << TAINT_UNSIGNED_MODULE)
	49	ctf_enum_value("SOFTLOCKUP", 1UL << TAINT_SOFTLOCKUP)
	50	ctf_enum_value("LIVEPATCH", 1UL << TAINT_LIVEPATCH)
	51	#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,15,0))
	52	ctf_enum_value("AUX", 1UL << TAINT_AUX)
	53	#endif
	54	#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,17,0))
	55	ctf_enum_value("RANDSTRUCT", 1UL << TAINT_RANDSTRUCT)
	56	#endif
	57	)
	58	)
	59
	60	LTTNG_TRACEPOINT_EVENT(module_load,
	61
	62	TP_PROTO(struct module *mod),
	63
	64	TP_ARGS(mod),
	65
	66	TP_FIELDS(
	67	ctf_enum(taint, unsigned int, taints, mod->taints)
	68	ctf_string(name, mod->name)
	69	)
	70	)
	71
	72	LTTNG_TRACEPOINT_EVENT(module_free,
	73
	74	TP_PROTO(struct module *mod),
	75
	76	TP_ARGS(mod),
	77
	78	TP_FIELDS(
	79	ctf_string(name, mod->name)
	80	)
	81	)
	82
	83	#ifdef CONFIG_MODULE_UNLOAD
	84	/* trace_module_get/put are only used if CONFIG_MODULE_UNLOAD is defined */
	85
	86	LTTNG_TRACEPOINT_EVENT_CLASS(module_refcnt,
	87
	88	TP_PROTO(struct module *mod, unsigned long ip),
	89
	90	TP_ARGS(mod, ip),
	91
	92	TP_FIELDS(
	93	ctf_integer_hex(unsigned long, ip, ip)
	94	ctf_integer(int, refcnt, atomic_read(&mod->refcnt))
	95	ctf_string(name, mod->name)
	96	)
	97	)
	98
	99	LTTNG_TRACEPOINT_EVENT_INSTANCE(module_refcnt, module_get,
	100
	101	TP_PROTO(struct module *mod, unsigned long ip),
	102
	103	TP_ARGS(mod, ip)
	104	)
	105
	106	LTTNG_TRACEPOINT_EVENT_INSTANCE(module_refcnt, module_put,
	107
	108	TP_PROTO(struct module *mod, unsigned long ip),
	109
	110	TP_ARGS(mod, ip)
	111	)
	112	#endif /* CONFIG_MODULE_UNLOAD */
	113
	114	LTTNG_TRACEPOINT_EVENT(module_request,
	115
	116	TP_PROTO(char *name, bool wait, unsigned long ip),
	117
	118	TP_ARGS(name, wait, ip),
	119
	120	TP_FIELDS(
	121	ctf_integer_hex(unsigned long, ip, ip)
	122	ctf_integer(bool, wait, wait)
	123	ctf_string(name, name)
	124	)
	125	)
	126
	127	#endif /* CONFIG_MODULES */
	128
	129	#endif /* LTTNG_TRACE_MODULE_H */
	130
	131	/* This part must be outside protection */
	132	#include <lttng/define_trace.h>