]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/linux/torture.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Common functions for in-kernel torture tests.
5 * Copyright IBM Corporation, 2014
7 * Author: Paul E. McKenney <paulmck@linux.ibm.com>
10 #ifndef __LINUX_TORTURE_H
11 #define __LINUX_TORTURE_H
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>
25 /* Definitions for a non-string torture-test module parameter. */
26 #define torture_param(type, name, init, msg) \
27 static type name = init; \
28 module_param(name, type, 0444); \
29 MODULE_PARM_DESC(name, msg);
31 #define TORTURE_FLAG "-torture:"
32 #define TOROUT_STRING(s) \
33 pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s)
34 #define VERBOSE_TOROUT_STRING(s) \
35 do { if (verbose) pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s); } while (0)
36 #define VERBOSE_TOROUT_ERRSTRING(s) \
37 do { if (verbose) pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s); } while (0)
39 /* Definitions for online/offline exerciser. */
40 typedef void torture_ofl_func(void);
41 bool torture_offline(int cpu
, long *n_onl_attempts
, long *n_onl_successes
,
42 unsigned long *sum_offl
, int *min_onl
, int *max_onl
);
43 bool torture_online(int cpu
, long *n_onl_attempts
, long *n_onl_successes
,
44 unsigned long *sum_onl
, int *min_onl
, int *max_onl
);
45 int torture_onoff_init(long ooholdoff
, long oointerval
, torture_ofl_func
*f
);
46 void torture_onoff_stats(void);
47 bool torture_onoff_failures(void);
49 /* Low-rider random number generator. */
50 struct torture_random_state
{
51 unsigned long trs_state
;
54 #define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 }
55 #define DEFINE_TORTURE_RANDOM_PERCPU(name) \
56 DEFINE_PER_CPU(struct torture_random_state, name)
57 unsigned long torture_random(struct torture_random_state
*trsp
);
59 /* Task shuffler, which causes CPUs to occasionally go idle. */
60 void torture_shuffle_task_register(struct task_struct
*tp
);
61 int torture_shuffle_init(long shuffint
);
63 /* Test auto-shutdown handling. */
64 void torture_shutdown_absorb(const char *title
);
65 int torture_shutdown_init(int ssecs
, void (*cleanup
)(void));
67 /* Task stuttering, which forces load/no-load transitions. */
68 bool stutter_wait(const char *title
);
69 int torture_stutter_init(int s
, int sgap
);
71 /* Initialization and cleanup. */
72 bool torture_init_begin(char *ttype
, int v
);
73 void torture_init_end(void);
74 bool torture_cleanup_begin(void);
75 void torture_cleanup_end(void);
76 bool torture_must_stop(void);
77 bool torture_must_stop_irq(void);
78 void torture_kthread_stopping(char *title
);
79 int _torture_create_kthread(int (*fn
)(void *arg
), void *arg
, char *s
, char *m
,
80 char *f
, struct task_struct
**tp
);
81 void _torture_stop_kthread(char *m
, struct task_struct
**tp
);
83 #define torture_create_kthread(n, arg, tp) \
84 _torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
85 "Failed to create " #n, &(tp))
86 #define torture_stop_kthread(n, tp) \
87 _torture_stop_kthread("Stopping " #n " task", &(tp))
90 #define torture_preempt_schedule() preempt_schedule()
92 #define torture_preempt_schedule()
95 #endif /* __LINUX_TORTURE_H */