[linux-2.6-block.git] / include / linux / torture.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Common functions for in-kernel torture tests.
 *
 * Copyright IBM Corporation, 2014
 *
 * Author: Paul E. McKenney <paulmck@linux.ibm.com>
 */

#ifndef __LINUX_TORTURE_H
#define __LINUX_TORTURE_H

#include <linux/types.h>
#include <linux/cache.h>
#include <linux/spinlock.h>
#include <linux/threads.h>
#include <linux/cpumask.h>
#include <linux/seqlock.h>
#include <linux/lockdep.h>
#include <linux/completion.h>
#include <linux/debugobjects.h>
#include <linux/bug.h>
#include <linux/compiler.h>
#include <linux/hrtimer.h>

/* Definitions for a non-string torture-test module parameter. */
#define torture_param(type, name, init, msg) \
	static type name = init; \
	module_param(name, type, 0444); \
	MODULE_PARM_DESC(name, msg);

#define TORTURE_FLAG "-torture:"
#define TOROUT_STRING(s) \
	pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s)
#define VERBOSE_TOROUT_STRING(s) \
do {										\
	if (verbose) {								\
		verbose_torout_sleep();						\
		pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s);		\
	}									\
} while (0)
#define TOROUT_ERRSTRING(s) \
	pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s)
void verbose_torout_sleep(void);

#define torture_init_error(firsterr)						\
({										\
	int ___firsterr = (firsterr);						\
										\
	WARN_ONCE(!IS_MODULE(CONFIG_RCU_TORTURE_TEST) && ___firsterr < 0, "Torture-test initialization failed with error code %d\n", ___firsterr); \
	___firsterr < 0;								\
})

/* Definitions for online/offline exerciser. */
#ifdef CONFIG_HOTPLUG_CPU
int torture_num_online_cpus(void);
#else /* #ifdef CONFIG_HOTPLUG_CPU */
static inline int torture_num_online_cpus(void) { return 1; }
#endif /* #else #ifdef CONFIG_HOTPLUG_CPU */
typedef void torture_ofl_func(void);
bool torture_offline(int cpu, long *n_onl_attempts, long *n_onl_successes,
		     unsigned long *sum_offl, int *min_onl, int *max_onl);
bool torture_online(int cpu, long *n_onl_attempts, long *n_onl_successes,
		    unsigned long *sum_onl, int *min_onl, int *max_onl);
int torture_onoff_init(long ooholdoff, long oointerval, torture_ofl_func *f);
void torture_onoff_stats(void);
bool torture_onoff_failures(void);

/* Low-rider random number generator. */
struct torture_random_state {
	unsigned long trs_state;
	long trs_count;
};
#define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 }
#define DEFINE_TORTURE_RANDOM_PERCPU(name) \
	DEFINE_PER_CPU(struct torture_random_state, name)
unsigned long torture_random(struct torture_random_state *trsp);
static inline void torture_random_init(struct torture_random_state *trsp)
{
	trsp->trs_state = 0;
	trsp->trs_count = 0;
}

/* Definitions for high-resolution-timer sleeps. */
int torture_hrtimeout_ns(ktime_t baset_ns, u32 fuzzt_ns, const enum hrtimer_mode mode,
			 struct torture_random_state *trsp);
int torture_hrtimeout_us(u32 baset_us, u32 fuzzt_ns, struct torture_random_state *trsp);
int torture_hrtimeout_ms(u32 baset_ms, u32 fuzzt_us, struct torture_random_state *trsp);
int torture_hrtimeout_jiffies(u32 baset_j, struct torture_random_state *trsp);
int torture_hrtimeout_s(u32 baset_s, u32 fuzzt_ms, struct torture_random_state *trsp);

/* Task shuffler, which causes CPUs to occasionally go idle. */
void torture_shuffle_task_register(struct task_struct *tp);
int torture_shuffle_init(long shuffint);

/* Test auto-shutdown handling. */
void torture_shutdown_absorb(const char *title);
int torture_shutdown_init(int ssecs, void (*cleanup)(void));

/* Task stuttering, which forces load/no-load transitions. */
bool stutter_wait(const char *title);
int torture_stutter_init(int s, int sgap);

/* Initialization and cleanup. */
bool torture_init_begin(char *ttype, int v);
void torture_init_end(void);
bool torture_cleanup_begin(void);
void torture_cleanup_end(void);
bool torture_must_stop(void);
bool torture_must_stop_irq(void);
void torture_kthread_stopping(char *title);
int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m,
			     char *f, struct task_struct **tp, void (*cbf)(struct task_struct *tp));
void _torture_stop_kthread(char *m, struct task_struct **tp);

#define torture_create_kthread(n, arg, tp) \
	_torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
				"Failed to create " #n, &(tp), NULL)
#define torture_create_kthread_cb(n, arg, tp, cbf) \
	_torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
				"Failed to create " #n, &(tp), cbf)
#define torture_stop_kthread(n, tp) \
	_torture_stop_kthread("Stopping " #n " task", &(tp))

/* Scheduler-related definitions. */
#ifdef CONFIG_PREEMPTION
#define torture_preempt_schedule() __preempt_schedule()
#else
#define torture_preempt_schedule()	do { } while (0)
#endif

#if IS_ENABLED(CONFIG_RCU_TORTURE_TEST) || IS_MODULE(CONFIG_RCU_TORTURE_TEST) || IS_ENABLED(CONFIG_LOCK_TORTURE_TEST) || IS_MODULE(CONFIG_LOCK_TORTURE_TEST)
long torture_sched_setaffinity(pid_t pid, const struct cpumask *in_mask);
#endif

#endif /* __LINUX_TORTURE_H */
Commit	Line	Data
082dfb3c	1	/* SPDX-License-Identifier: GPL-2.0+ */
51b1130e PM	2	/*
	3	* Common functions for in-kernel torture tests.
	4	*
51b1130e PM	5	* Copyright IBM Corporation, 2014
51b1130e PM	6	*
082dfb3c	7	* Author: Paul E. McKenney <paulmck@linux.ibm.com>
51b1130e PM	8	*/
	9
	10	#ifndef __LINUX_TORTURE_H
	11	#define __LINUX_TORTURE_H
	12
	13	#include <linux/types.h>
	14	#include <linux/cache.h>
	15	#include <linux/spinlock.h>
	16	#include <linux/threads.h>
	17	#include <linux/cpumask.h>
	18	#include <linux/seqlock.h>
	19	#include <linux/lockdep.h>
	20	#include <linux/completion.h>
	21	#include <linux/debugobjects.h>
	22	#include <linux/bug.h>
	23	#include <linux/compiler.h>
ea115c24	24	#include <linux/hrtimer.h>
51b1130e	25
9e250225 PM	26	/* Definitions for a non-string torture-test module parameter. */
	27	#define torture_param(type, name, init, msg) \
	28	static type name = init; \
	29	module_param(name, type, 0444); \
	30	MODULE_PARM_DESC(name, msg);
	31
c2884de3 PM	32	#define TORTURE_FLAG "-torture:"
c2884de3 PM	33	#define TOROUT_STRING(s) \
489bb3d2	34	pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s)
c2884de3	35	#define VERBOSE_TOROUT_STRING(s) \
8a67a20b PM	36	do { \
	37	if (verbose) { \
	38	verbose_torout_sleep(); \
	39	pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s); \
	40	} \
	41	} while (0)
81faa4f6 LZ	42	#define TOROUT_ERRSTRING(s) \
81faa4f6 LZ	43	pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s)
8a67a20b	44	void verbose_torout_sleep(void);
c2884de3	45
efeff6b3 PM	46	#define torture_init_error(firsterr) \
	47	({ \
	48	int ___firsterr = (firsterr); \
	49	\
	50	WARN_ONCE(!IS_MODULE(CONFIG_RCU_TORTURE_TEST) && ___firsterr < 0, "Torture-test initialization failed with error code %d\n", ___firsterr); \
	51	___firsterr < 0; \
	52	})
	53
2e9e8081	54	/* Definitions for online/offline exerciser. */
1afb95fe PM	55	#ifdef CONFIG_HOTPLUG_CPU
	56	int torture_num_online_cpus(void);
	57	#else /* #ifdef CONFIG_HOTPLUG_CPU */
	58	static inline int torture_num_online_cpus(void) { return 1; }
	59	#endif /* #else #ifdef CONFIG_HOTPLUG_CPU */
3a6cb58f	60	typedef void torture_ofl_func(void);
d95f5ba9 PM	61	bool torture_offline(int cpu, long n_onl_attempts, long n_onl_successes,
	62	unsigned long sum_offl, int min_onl, int *max_onl);
	63	bool torture_online(int cpu, long n_onl_attempts, long n_onl_successes,
	64	unsigned long sum_onl, int min_onl, int *max_onl);
3a6cb58f	65	int torture_onoff_init(long ooholdoff, long oointerval, torture_ofl_func *f);
eea203fe	66	void torture_onoff_stats(void);
2e9e8081 PM	67	bool torture_onoff_failures(void);
2e9e8081 PM	68
9e250225	69	/* Low-rider random number generator. */
51b1130e PM	70	struct torture_random_state {
	71	unsigned long trs_state;
	72	long trs_count;
	73	};
51b1130e	74	#define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 }
3025520e PM	75	#define DEFINE_TORTURE_RANDOM_PERCPU(name) \
3025520e PM	76	DEFINE_PER_CPU(struct torture_random_state, name)
51b1130e	77	unsigned long torture_random(struct torture_random_state *trsp);
4a5f133c PM	78	static inline void torture_random_init(struct torture_random_state *trsp)
	79	{
	80	trsp->trs_state = 0;
	81	trsp->trs_count = 0;
	82	}
51b1130e	83
ae19aaaf	84	/* Definitions for high-resolution-timer sleeps. */
a741deac PM	85	int torture_hrtimeout_ns(ktime_t baset_ns, u32 fuzzt_ns, const enum hrtimer_mode mode,
a741deac PM	86	struct torture_random_state *trsp);
ae19aaaf PM	87	int torture_hrtimeout_us(u32 baset_us, u32 fuzzt_ns, struct torture_random_state *trsp);
	88	int torture_hrtimeout_ms(u32 baset_ms, u32 fuzzt_us, struct torture_random_state *trsp);
	89	int torture_hrtimeout_jiffies(u32 baset_j, struct torture_random_state *trsp);
	90	int torture_hrtimeout_s(u32 baset_s, u32 fuzzt_ms, struct torture_random_state *trsp);
	91
3808dc9f PM	92	/* Task shuffler, which causes CPUs to occasionally go idle. */
	93	void torture_shuffle_task_register(struct task_struct *tp);
	94	int torture_shuffle_init(long shuffint);
3808dc9f	95
e991dbc0	96	/* Test auto-shutdown handling. */
f67a3356	97	void torture_shutdown_absorb(const char *title);
e991dbc0	98	int torture_shutdown_init(int ssecs, void (*cleanup)(void));
f67a3356	99
628edaa5	100	/* Task stuttering, which forces load/no-load transitions. */
474e59b4	101	bool stutter_wait(const char *title);
ff3bf92d	102	int torture_stutter_init(int s, int sgap);
628edaa5	103
b5daa8f3	104	/* Initialization and cleanup. */
90127d60	105	bool torture_init_begin(char *ttype, int v);
b5daa8f3	106	void torture_init_end(void);
d36a7a0d DB	107	bool torture_cleanup_begin(void);
d36a7a0d DB	108	void torture_cleanup_end(void);
36970bb9 PM	109	bool torture_must_stop(void);
36970bb9 PM	110	bool torture_must_stop_irq(void);
7fafaac5	111	void torture_kthread_stopping(char *title);
47cf29b9	112	int _torture_create_kthread(int (fn)(void arg), void arg, char s, char *m,
67d5404d	113	char f, struct task_struct tp, void (cbf)(struct task_struct *tp));
9c029b86	114	void _torture_stop_kthread(char m, struct task_struct *tp);
47cf29b9 PM	115
	116	#define torture_create_kthread(n, arg, tp) \
	117	_torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
67d5404d PM	118	"Failed to create " #n, &(tp), NULL)
	119	#define torture_create_kthread_cb(n, arg, tp, cbf) \
	120	_torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
	121	"Failed to create " #n, &(tp), cbf)
9c029b86 PM	122	#define torture_stop_kthread(n, tp) \
9c029b86 PM	123	_torture_stop_kthread("Stopping " #n " task", &(tp))
b5daa8f3	124
0cfecd7d	125	/* Scheduler-related definitions. */
01b1d88b	126	#ifdef CONFIG_PREEMPTION
bd6c375b	127	#define torture_preempt_schedule() __preempt_schedule()
cc1321c9	128	#else
be44ae62	129	#define torture_preempt_schedule() do { } while (0)
cc1321c9 PM	130	#endif
cc1321c9 PM	131
0cfecd7d PM	132	#if IS_ENABLED(CONFIG_RCU_TORTURE_TEST) \|\| IS_MODULE(CONFIG_RCU_TORTURE_TEST) \|\| IS_ENABLED(CONFIG_LOCK_TORTURE_TEST) \|\| IS_MODULE(CONFIG_LOCK_TORTURE_TEST)
	133	long torture_sched_setaffinity(pid_t pid, const struct cpumask *in_mask);
	134	#endif
	135
51b1130e	136	#endif /* __LINUX_TORTURE_H */