2 * Common functions for in-kernel torture tests.
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.
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.
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.
18 * Copyright IBM Corporation, 2014
20 * Author: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
23 #ifndef __LINUX_TORTURE_H
24 #define __LINUX_TORTURE_H
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>
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);
44 #define TORTURE_FLAG "-torture:"
45 #define TOROUT_STRING(s) \
46 pr_alert("%s" TORTURE_FLAG s "\n", torture_type)
47 #define VERBOSE_TOROUT_STRING(s) \
48 do { if (verbose) pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s); } while (0)
49 #define VERBOSE_TOROUT_ERRSTRING(s) \
50 do { if (verbose) pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s); } while (0)
52 /* Definitions for online/offline exerciser. */
53 int torture_onoff_init(long ooholdoff, long oointerval);
54 void torture_onoff_stats(void);
55 bool torture_onoff_failures(void);
57 /* Low-rider random number generator. */
58 struct torture_random_state {
59 unsigned long trs_state;
62 #define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 }
63 unsigned long torture_random(struct torture_random_state *trsp);
65 /* Task shuffler, which causes CPUs to occasionally go idle. */
66 void torture_shuffle_task_register(struct task_struct *tp);
67 int torture_shuffle_init(long shuffint);
69 /* Test auto-shutdown handling. */
70 void torture_shutdown_absorb(const char *title);
71 int torture_shutdown_init(int ssecs, void (*cleanup)(void));
73 /* Task stuttering, which forces load/no-load transitions. */
74 void stutter_wait(const char *title);
75 int torture_stutter_init(int s);
77 /* Initialization and cleanup. */
78 bool torture_init_begin(char *ttype, bool v, int *runnable);
79 void torture_init_end(void);
80 bool torture_cleanup_begin(void);
81 void torture_cleanup_end(void);
82 bool torture_must_stop(void);
83 bool torture_must_stop_irq(void);
84 void torture_kthread_stopping(char *title);
85 int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m,
86 char *f, struct task_struct **tp);
87 void _torture_stop_kthread(char *m, struct task_struct **tp);
89 #define torture_create_kthread(n, arg, tp) \
90 _torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
91 "Failed to create " #n, &(tp))
92 #define torture_stop_kthread(n, tp) \
93 _torture_stop_kthread("Stopping " #n " task", &(tp))
95 #endif /* __LINUX_TORTURE_H */