[linux-block.git] / include / linux / kcov.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_KCOV_H
#define _LINUX_KCOV_H

#include <linux/sched.h>
#include <uapi/linux/kcov.h>

struct task_struct;

#ifdef CONFIG_KCOV

enum kcov_mode {
	/* Coverage collection is not enabled yet. */
	KCOV_MODE_DISABLED = 0,
	/* KCOV was initialized, but tracing mode hasn't been chosen yet. */
	KCOV_MODE_INIT = 1,
	/*
	 * Tracing coverage collection mode.
	 * Covered PCs are collected in a per-task buffer.
	 */
	KCOV_MODE_TRACE_PC = 2,
	/* Collecting comparison operands mode. */
	KCOV_MODE_TRACE_CMP = 3,
};

#define KCOV_IN_CTXSW	(1 << 30)

void kcov_task_init(struct task_struct *t);
void kcov_task_exit(struct task_struct *t);

#define kcov_prepare_switch(t)			\
do {						\
	(t)->kcov_mode |= KCOV_IN_CTXSW;	\
} while (0)

#define kcov_finish_switch(t)			\
do {						\
	(t)->kcov_mode &= ~KCOV_IN_CTXSW;	\
} while (0)

/* See Documentation/dev-tools/kcov.rst for usage details. */
void kcov_remote_start(u64 handle);
void kcov_remote_stop(void);
u64 kcov_common_handle(void);

static inline void kcov_remote_start_common(u64 id)
{
	kcov_remote_start(kcov_remote_handle(KCOV_SUBSYSTEM_COMMON, id));
}

static inline void kcov_remote_start_usb(u64 id)
{
	kcov_remote_start(kcov_remote_handle(KCOV_SUBSYSTEM_USB, id));
}

/*
 * The softirq flavor of kcov_remote_*() functions is introduced as a temporary
 * work around for kcov's lack of nested remote coverage sections support in
 * task context. Adding suport for nested sections is tracked in:
 * https://bugzilla.kernel.org/show_bug.cgi?id=210337
 */

static inline void kcov_remote_start_usb_softirq(u64 id)
{
	if (in_serving_softirq())
		kcov_remote_start_usb(id);
}

static inline void kcov_remote_stop_softirq(void)
{
	if (in_serving_softirq())
		kcov_remote_stop();
}

#else

static inline void kcov_task_init(struct task_struct *t) {}
static inline void kcov_task_exit(struct task_struct *t) {}
static inline void kcov_prepare_switch(struct task_struct *t) {}
static inline void kcov_finish_switch(struct task_struct *t) {}
static inline void kcov_remote_start(u64 handle) {}
static inline void kcov_remote_stop(void) {}
static inline u64 kcov_common_handle(void)
{
	return 0;
}
static inline void kcov_remote_start_common(u64 id) {}
static inline void kcov_remote_start_usb(u64 id) {}
static inline void kcov_remote_start_usb_softirq(u64 id) {}
static inline void kcov_remote_stop_softirq(void) {}

#endif /* CONFIG_KCOV */
#endif /* _LINUX_KCOV_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
5c9a8750 DV	2	#ifndef _LINUX_KCOV_H
	3	#define _LINUX_KCOV_H
	4
183f47fc	5	#include <linux/sched.h>
5c9a8750 DV	6	#include <uapi/linux/kcov.h>
	7
	8	struct task_struct;
	9
	10	#ifdef CONFIG_KCOV
	11
5c9a8750 DV	12	enum kcov_mode {
	13	/* Coverage collection is not enabled yet. */
	14	KCOV_MODE_DISABLED = 0,
ded97d2c VC	15	/* KCOV was initialized, but tracing mode hasn't been chosen yet. */
ded97d2c VC	16	KCOV_MODE_INIT = 1,
5c9a8750 DV	17	/*
	18	* Tracing coverage collection mode.
	19	* Covered PCs are collected in a per-task buffer.
	20	*/
ded97d2c VC	21	KCOV_MODE_TRACE_PC = 2,
	22	/* Collecting comparison operands mode. */
	23	KCOV_MODE_TRACE_CMP = 3,
5c9a8750 DV	24	};
5c9a8750 DV	25
0ed557aa MR	26	#define KCOV_IN_CTXSW (1 << 30)
0ed557aa MR	27
ded97d2c VC	28	void kcov_task_init(struct task_struct *t);
	29	void kcov_task_exit(struct task_struct *t);
	30
0ed557aa MR	31	#define kcov_prepare_switch(t) \
	32	do { \
	33	(t)->kcov_mode \|= KCOV_IN_CTXSW; \
	34	} while (0)
	35
	36	#define kcov_finish_switch(t) \
	37	do { \
	38	(t)->kcov_mode &= ~KCOV_IN_CTXSW; \
	39	} while (0)
	40
eec028c9 AK	41	/* See Documentation/dev-tools/kcov.rst for usage details. */
	42	void kcov_remote_start(u64 handle);
	43	void kcov_remote_stop(void);
	44	u64 kcov_common_handle(void);
	45
	46	static inline void kcov_remote_start_common(u64 id)
	47	{
	48	kcov_remote_start(kcov_remote_handle(KCOV_SUBSYSTEM_COMMON, id));
	49	}
	50
	51	static inline void kcov_remote_start_usb(u64 id)
	52	{
	53	kcov_remote_start(kcov_remote_handle(KCOV_SUBSYSTEM_USB, id));
	54	}
	55
e89eed02 AK	56	/*
	57	* The softirq flavor of kcov_remote_*() functions is introduced as a temporary
	58	* work around for kcov's lack of nested remote coverage sections support in
	59	* task context. Adding suport for nested sections is tracked in:
	60	* https://bugzilla.kernel.org/show_bug.cgi?id=210337
	61	*/
	62
	63	static inline void kcov_remote_start_usb_softirq(u64 id)
	64	{
	65	if (in_serving_softirq())
	66	kcov_remote_start_usb(id);
	67	}
	68
	69	static inline void kcov_remote_stop_softirq(void)
	70	{
	71	if (in_serving_softirq())
	72	kcov_remote_stop();
	73	}
	74
5c9a8750 DV	75	#else
	76
	77	static inline void kcov_task_init(struct task_struct *t) {}
	78	static inline void kcov_task_exit(struct task_struct *t) {}
0ed557aa MR	79	static inline void kcov_prepare_switch(struct task_struct *t) {}
0ed557aa MR	80	static inline void kcov_finish_switch(struct task_struct *t) {}
eec028c9 AK	81	static inline void kcov_remote_start(u64 handle) {}
	82	static inline void kcov_remote_stop(void) {}
	83	static inline u64 kcov_common_handle(void)
	84	{
	85	return 0;
	86	}
	87	static inline void kcov_remote_start_common(u64 id) {}
	88	static inline void kcov_remote_start_usb(u64 id) {}
e89eed02 AK	89	static inline void kcov_remote_start_usb_softirq(u64 id) {}
e89eed02 AK	90	static inline void kcov_remote_stop_softirq(void) {}
5c9a8750 DV	91
	92	#endif /* CONFIG_KCOV */
	93	#endif /* _LINUX_KCOV_H */