blob: b2e2b468e511d43949c5cee31b5e23a06ab433e7 [file] [log] [blame]
Paul E. McKenney51b11302014-01-27 11:49:39 -08001/*
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
Paul E. McKenney9e250222014-01-27 16:27:00 -080038/* 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
Paul E. McKenneyc2884de2014-01-29 07:30:50 -080044#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) \
Paul E. McKenney7fafaac2014-01-31 17:37:28 -080048 do { if (verbose) pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s); } while (0)
Paul E. McKenneyc2884de2014-01-29 07:30:50 -080049#define VERBOSE_TOROUT_ERRSTRING(s) \
Paul E. McKenney47cf29b2014-02-03 11:52:27 -080050 do { if (verbose) pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s); } while (0)
Paul E. McKenneyc2884de2014-01-29 07:30:50 -080051
Paul E. McKenney2e9e8082014-01-28 15:58:22 -080052/* Definitions for a non-string torture-test module parameter. */
53#define torture_parm(type, name, init, msg) \
54 static type name = init; \
55 module_param(name, type, 0444); \
56 MODULE_PARM_DESC(name, msg);
57
58/* Definitions for online/offline exerciser. */
59int torture_onoff_init(long ooholdoff, long oointerval);
Paul E. McKenney2e9e8082014-01-28 15:58:22 -080060char *torture_onoff_stats(char *page);
61bool torture_onoff_failures(void);
62
Paul E. McKenney9e250222014-01-27 16:27:00 -080063/* Low-rider random number generator. */
Paul E. McKenney51b11302014-01-27 11:49:39 -080064struct torture_random_state {
65 unsigned long trs_state;
66 long trs_count;
67};
Paul E. McKenney51b11302014-01-27 11:49:39 -080068#define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 }
Paul E. McKenney51b11302014-01-27 11:49:39 -080069unsigned long torture_random(struct torture_random_state *trsp);
70
Paul E. McKenney3808dc92014-01-28 15:29:21 -080071/* Task shuffler, which causes CPUs to occasionally go idle. */
72void torture_shuffle_task_register(struct task_struct *tp);
73int torture_shuffle_init(long shuffint);
Paul E. McKenney3808dc92014-01-28 15:29:21 -080074
Paul E. McKenneye991dbc2014-01-31 14:52:13 -080075/* Test auto-shutdown handling. */
Paul E. McKenneyf67a3352014-01-29 07:40:27 -080076void torture_shutdown_absorb(const char *title);
Paul E. McKenneye991dbc2014-01-31 14:52:13 -080077int torture_shutdown_init(int ssecs, void (*cleanup)(void));
Paul E. McKenneyf67a3352014-01-29 07:40:27 -080078
Paul E. McKenney628edaa2014-01-31 11:57:43 -080079/* Task stuttering, which forces load/no-load transitions. */
80void stutter_wait(const char *title);
81int torture_stutter_init(int s);
Paul E. McKenney628edaa2014-01-31 11:57:43 -080082
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -080083/* Initialization and cleanup. */
Paul E. McKenney628edaa2014-01-31 11:57:43 -080084void torture_init_begin(char *ttype, bool v, int *runnable);
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -080085void torture_init_end(void);
Paul E. McKenneycc47ae02014-01-30 14:21:11 -080086bool torture_cleanup(void);
Paul E. McKenney36970bb2014-01-30 15:49:29 -080087bool torture_must_stop(void);
88bool torture_must_stop_irq(void);
Paul E. McKenney7fafaac2014-01-31 17:37:28 -080089void torture_kthread_stopping(char *title);
Paul E. McKenney47cf29b2014-02-03 11:52:27 -080090int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m,
91 char *f, struct task_struct **tp);
Paul E. McKenney9c029b82014-02-04 11:47:08 -080092void _torture_stop_kthread(char *m, struct task_struct **tp);
Paul E. McKenney47cf29b2014-02-03 11:52:27 -080093
94#define torture_create_kthread(n, arg, tp) \
95 _torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
96 "Failed to create " #n, &(tp))
Paul E. McKenney9c029b82014-02-04 11:47:08 -080097#define torture_stop_kthread(n, tp) \
98 _torture_stop_kthread("Stopping " #n " task", &(tp))
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -080099
Paul E. McKenney51b11302014-01-27 11:49:39 -0800100#endif /* __LINUX_TORTURE_H */