1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
2 | /* |
3 | * Common functions for in-kernel torture tests. |
4 | * |
5 | * Copyright IBM Corporation, 2014 |
6 | * |
7 | * Author: Paul E. McKenney <paulmck@linux.ibm.com> |
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> |
24 | |
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); |
30 | |
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 { \ |
36 | if (verbose) { \ |
37 | verbose_torout_sleep(); \ |
38 | pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s); \ |
39 | } \ |
40 | } while (0) |
41 | #define TOROUT_ERRSTRING(s) \ |
42 | pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s) |
43 | void verbose_torout_sleep(void); |
44 | |
45 | #define torture_init_error(firsterr) \ |
46 | ({ \ |
47 | int ___firsterr = (firsterr); \ |
48 | \ |
49 | WARN_ONCE(!IS_MODULE(CONFIG_RCU_TORTURE_TEST) && ___firsterr < 0, "Torture-test initialization failed with error code %d\n", ___firsterr); \ |
50 | ___firsterr < 0; \ |
51 | }) |
52 | |
53 | /* Definitions for online/offline exerciser. */ |
54 | #ifdef CONFIG_HOTPLUG_CPU |
55 | int torture_num_online_cpus(void); |
56 | #else /* #ifdef CONFIG_HOTPLUG_CPU */ |
57 | static inline int torture_num_online_cpus(void) { return 1; } |
58 | #endif /* #else #ifdef CONFIG_HOTPLUG_CPU */ |
59 | typedef void torture_ofl_func(void); |
60 | bool torture_offline(int cpu, long *n_onl_attempts, long *n_onl_successes, |
61 | unsigned long *sum_offl, int *min_onl, int *max_onl); |
62 | bool torture_online(int cpu, long *n_onl_attempts, long *n_onl_successes, |
63 | unsigned long *sum_onl, int *min_onl, int *max_onl); |
64 | int torture_onoff_init(long ooholdoff, long oointerval, torture_ofl_func *f); |
65 | void torture_onoff_stats(void); |
66 | bool torture_onoff_failures(void); |
67 | |
68 | /* Low-rider random number generator. */ |
69 | struct torture_random_state { |
70 | unsigned long trs_state; |
71 | long trs_count; |
72 | }; |
73 | #define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 } |
74 | #define DEFINE_TORTURE_RANDOM_PERCPU(name) \ |
75 | DEFINE_PER_CPU(struct torture_random_state, name) |
76 | unsigned long torture_random(struct torture_random_state *trsp); |
77 | static inline void torture_random_init(struct torture_random_state *trsp) |
78 | { |
79 | trsp->trs_state = 0; |
80 | trsp->trs_count = 0; |
81 | } |
82 | |
83 | /* Definitions for high-resolution-timer sleeps. */ |
84 | int torture_hrtimeout_ns(ktime_t baset_ns, u32 fuzzt_ns, const enum hrtimer_mode mode, |
85 | struct torture_random_state *trsp); |
86 | int torture_hrtimeout_us(u32 baset_us, u32 fuzzt_ns, struct torture_random_state *trsp); |
87 | int torture_hrtimeout_ms(u32 baset_ms, u32 fuzzt_us, struct torture_random_state *trsp); |
88 | int torture_hrtimeout_jiffies(u32 baset_j, struct torture_random_state *trsp); |
89 | int torture_hrtimeout_s(u32 baset_s, u32 fuzzt_ms, struct torture_random_state *trsp); |
90 | |
91 | /* Task shuffler, which causes CPUs to occasionally go idle. */ |
92 | void torture_shuffle_task_register(struct task_struct *tp); |
93 | int torture_shuffle_init(long shuffint); |
94 | |
95 | /* Test auto-shutdown handling. */ |
96 | void torture_shutdown_absorb(const char *title); |
97 | int torture_shutdown_init(int ssecs, void (*cleanup)(void)); |
98 | |
99 | /* Task stuttering, which forces load/no-load transitions. */ |
100 | bool stutter_wait(const char *title); |
101 | int torture_stutter_init(int s, int sgap); |
102 | |
103 | /* Initialization and cleanup. */ |
104 | bool torture_init_begin(char *ttype, int v); |
105 | void torture_init_end(void); |
106 | bool torture_cleanup_begin(void); |
107 | void torture_cleanup_end(void); |
108 | bool torture_must_stop(void); |
109 | bool torture_must_stop_irq(void); |
110 | void torture_kthread_stopping(char *title); |
111 | int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m, |
112 | char *f, struct task_struct **tp, void (*cbf)(struct task_struct *tp)); |
113 | void _torture_stop_kthread(char *m, struct task_struct **tp); |
114 | |
115 | #define torture_create_kthread(n, arg, tp) \ |
116 | _torture_create_kthread(n, (arg), #n, "Creating " #n " task", \ |
117 | "Failed to create " #n, &(tp), NULL) |
118 | #define torture_create_kthread_cb(n, arg, tp, cbf) \ |
119 | _torture_create_kthread(n, (arg), #n, "Creating " #n " task", \ |
120 | "Failed to create " #n, &(tp), cbf) |
121 | #define torture_stop_kthread(n, tp) \ |
122 | _torture_stop_kthread("Stopping " #n " task", &(tp)) |
123 | |
124 | /* Scheduler-related definitions. */ |
125 | #ifdef CONFIG_PREEMPTION |
126 | #define torture_preempt_schedule() __preempt_schedule() |
127 | #else |
128 | #define torture_preempt_schedule() do { } while (0) |
129 | #endif |
130 | |
131 | #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) |
132 | long torture_sched_setaffinity(pid_t pid, const struct cpumask *in_mask); |
133 | #endif |
134 | |
135 | #endif /* __LINUX_TORTURE_H */ |
136 | |