Commit | Line | Data |
---|---|---|
082dfb3c | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
51b1130e PM |
2 | /* |
3 | * Common functions for in-kernel torture tests. | |
4 | * | |
51b1130e PM |
5 | * Copyright IBM Corporation, 2014 |
6 | * | |
082dfb3c | 7 | * Author: Paul E. McKenney <paulmck@linux.ibm.com> |
51b1130e PM |
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 | ||
9e250225 PM |
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 | ||
c2884de3 PM |
31 | #define TORTURE_FLAG "-torture:" |
32 | #define TOROUT_STRING(s) \ | |
489bb3d2 | 33 | pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s) |
c2884de3 | 34 | #define VERBOSE_TOROUT_STRING(s) \ |
8a67a20b PM |
35 | do { \ |
36 | if (verbose) { \ | |
37 | verbose_torout_sleep(); \ | |
38 | pr_alert("%s" TORTURE_FLAG " %s\n", torture_type, s); \ | |
39 | } \ | |
40 | } while (0) | |
81faa4f6 LZ |
41 | #define TOROUT_ERRSTRING(s) \ |
42 | pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s) | |
8a67a20b | 43 | void verbose_torout_sleep(void); |
c2884de3 | 44 | |
efeff6b3 PM |
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 | ||
2e9e8081 | 53 | /* Definitions for online/offline exerciser. */ |
1afb95fe PM |
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 */ | |
3a6cb58f | 59 | typedef void torture_ofl_func(void); |
d95f5ba9 PM |
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); | |
3a6cb58f | 64 | int torture_onoff_init(long ooholdoff, long oointerval, torture_ofl_func *f); |
eea203fe | 65 | void torture_onoff_stats(void); |
2e9e8081 PM |
66 | bool torture_onoff_failures(void); |
67 | ||
9e250225 | 68 | /* Low-rider random number generator. */ |
51b1130e PM |
69 | struct torture_random_state { |
70 | unsigned long trs_state; | |
71 | long trs_count; | |
72 | }; | |
51b1130e | 73 | #define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 } |
3025520e PM |
74 | #define DEFINE_TORTURE_RANDOM_PERCPU(name) \ |
75 | DEFINE_PER_CPU(struct torture_random_state, name) | |
51b1130e | 76 | unsigned long torture_random(struct torture_random_state *trsp); |
4a5f133c PM |
77 | static inline void torture_random_init(struct torture_random_state *trsp) |
78 | { | |
79 | trsp->trs_state = 0; | |
80 | trsp->trs_count = 0; | |
81 | } | |
51b1130e | 82 | |
ae19aaaf PM |
83 | /* Definitions for high-resolution-timer sleeps. */ |
84 | int torture_hrtimeout_ns(ktime_t baset_ns, u32 fuzzt_ns, struct torture_random_state *trsp); | |
85 | int torture_hrtimeout_us(u32 baset_us, u32 fuzzt_ns, struct torture_random_state *trsp); | |
86 | int torture_hrtimeout_ms(u32 baset_ms, u32 fuzzt_us, struct torture_random_state *trsp); | |
87 | int torture_hrtimeout_jiffies(u32 baset_j, struct torture_random_state *trsp); | |
88 | int torture_hrtimeout_s(u32 baset_s, u32 fuzzt_ms, struct torture_random_state *trsp); | |
89 | ||
3808dc9f PM |
90 | /* Task shuffler, which causes CPUs to occasionally go idle. */ |
91 | void torture_shuffle_task_register(struct task_struct *tp); | |
92 | int torture_shuffle_init(long shuffint); | |
3808dc9f | 93 | |
e991dbc0 | 94 | /* Test auto-shutdown handling. */ |
f67a3356 | 95 | void torture_shutdown_absorb(const char *title); |
e991dbc0 | 96 | int torture_shutdown_init(int ssecs, void (*cleanup)(void)); |
f67a3356 | 97 | |
628edaa5 | 98 | /* Task stuttering, which forces load/no-load transitions. */ |
474e59b4 | 99 | bool stutter_wait(const char *title); |
ff3bf92d | 100 | int torture_stutter_init(int s, int sgap); |
628edaa5 | 101 | |
b5daa8f3 | 102 | /* Initialization and cleanup. */ |
90127d60 | 103 | bool torture_init_begin(char *ttype, int v); |
b5daa8f3 | 104 | void torture_init_end(void); |
d36a7a0d DB |
105 | bool torture_cleanup_begin(void); |
106 | void torture_cleanup_end(void); | |
36970bb9 PM |
107 | bool torture_must_stop(void); |
108 | bool torture_must_stop_irq(void); | |
7fafaac5 | 109 | void torture_kthread_stopping(char *title); |
47cf29b9 PM |
110 | int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m, |
111 | char *f, struct task_struct **tp); | |
9c029b86 | 112 | void _torture_stop_kthread(char *m, struct task_struct **tp); |
47cf29b9 PM |
113 | |
114 | #define torture_create_kthread(n, arg, tp) \ | |
115 | _torture_create_kthread(n, (arg), #n, "Creating " #n " task", \ | |
116 | "Failed to create " #n, &(tp)) | |
9c029b86 PM |
117 | #define torture_stop_kthread(n, tp) \ |
118 | _torture_stop_kthread("Stopping " #n " task", &(tp)) | |
b5daa8f3 | 119 | |
01b1d88b | 120 | #ifdef CONFIG_PREEMPTION |
bd6c375b | 121 | #define torture_preempt_schedule() __preempt_schedule() |
cc1321c9 | 122 | #else |
be44ae62 | 123 | #define torture_preempt_schedule() do { } while (0) |
cc1321c9 PM |
124 | #endif |
125 | ||
51b1130e | 126 | #endif /* __LINUX_TORTURE_H */ |