[mirror_ubuntu-bionic-kernel.git] / include / linux / torture.h

/*
 * Common functions for in-kernel torture tests.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you can access it online at
 * http://www.gnu.org/licenses/gpl-2.0.html.
 *
 * Copyright IBM Corporation, 2014
 *
 * Author: Paul E. McKenney <paulmck@linux.vnet.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>

/* 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);

/* Mediate rmmod and system shutdown.  Concurrent rmmod & shutdown illegal! */
#define FULLSTOP_DONTSTOP 0	/* Normal operation. */
#define FULLSTOP_SHUTDOWN 1	/* System shutdown with rcutorture running. */
#define FULLSTOP_RMMOD    2	/* Normal rmmod of rcutorture. */
extern int fullstop;
/* Protect fullstop transitions and spawning of kthreads.  */
extern struct mutex fullstop_mutex;

/* Common module parameters. */
extern char *torture_type;
extern bool verbose;

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

/* 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 }
unsigned long torture_random(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);
void torture_shuffle_cleanup(void);

/* Shutdown task absorption, for when the tasks cannot safely be killed. */
void torture_shutdown_absorb(const char *title);

#endif /* __LINUX_TORTURE_H */
Commit	Line	Data
51b1130e PM	1	/*
	2	* Common functions for in-kernel torture tests.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, you can access it online at
	16	* http://www.gnu.org/licenses/gpl-2.0.html.
	17	*
	18	* Copyright IBM Corporation, 2014
	19	*
	20	* Author: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
	21	*/
	22
	23	#ifndef __LINUX_TORTURE_H
	24	#define __LINUX_TORTURE_H
	25
	26	#include <linux/types.h>
	27	#include <linux/cache.h>
	28	#include <linux/spinlock.h>
	29	#include <linux/threads.h>
	30	#include <linux/cpumask.h>
	31	#include <linux/seqlock.h>
	32	#include <linux/lockdep.h>
	33	#include <linux/completion.h>
	34	#include <linux/debugobjects.h>
	35	#include <linux/bug.h>
	36	#include <linux/compiler.h>
	37
9e250225 PM	38	/* Definitions for a non-string torture-test module parameter. */
	39	#define torture_param(type, name, init, msg) \
	40	static type name = init; \
	41	module_param(name, type, 0444); \
	42	MODULE_PARM_DESC(name, msg);
	43
f67a3356 PM	44	/* Mediate rmmod and system shutdown. Concurrent rmmod & shutdown illegal! */
	45	#define FULLSTOP_DONTSTOP 0 /* Normal operation. */
	46	#define FULLSTOP_SHUTDOWN 1 /* System shutdown with rcutorture running. */
	47	#define FULLSTOP_RMMOD 2 /* Normal rmmod of rcutorture. */
	48	extern int fullstop;
	49	/* Protect fullstop transitions and spawning of kthreads. */
	50	extern struct mutex fullstop_mutex;
	51
	52	/* Common module parameters. */
	53	extern char *torture_type;
	54	extern bool verbose;
	55
c2884de3 PM	56	#define TORTURE_FLAG "-torture:"
	57	#define TOROUT_STRING(s) \
	58	pr_alert("%s" TORTURE_FLAG s "\n", torture_type)
	59	#define VERBOSE_TOROUT_STRING(s) \
	60	do { if (verbose) pr_alert("%s" TORTURE_FLAG s "\n", torture_type); } while (0)
	61	#define VERBOSE_TOROUT_ERRSTRING(s) \
	62	do { if (verbose) pr_alert("%s" TORTURE_FLAG "!!! " s "\n", torture_type); } while (0)
	63
9e250225	64	/* Low-rider random number generator. */
51b1130e PM	65	struct torture_random_state {
	66	unsigned long trs_state;
	67	long trs_count;
	68	};
51b1130e	69	#define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 }
51b1130e PM	70	unsigned long torture_random(struct torture_random_state *trsp);
51b1130e PM	71
3808dc9f PM	72	/* Task shuffler, which causes CPUs to occasionally go idle. */
	73	void torture_shuffle_task_register(struct task_struct *tp);
	74	int torture_shuffle_init(long shuffint);
	75	void torture_shuffle_cleanup(void);
	76
f67a3356 PM	77	/* Shutdown task absorption, for when the tasks cannot safely be killed. */
	78	void torture_shutdown_absorb(const char *title);
	79
51b1130e	80	#endif /* __LINUX_TORTURE_H */