xfs: xfs_buf: drop useless LIST_HEAD
[linux-2.6-block.git] / kernel / torture.c
CommitLineData
51b1130e
PM
1/*
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 (C) IBM Corporation, 2014
19 *
20 * Author: Paul E. McKenney <paulmck@us.ibm.com>
21 * Based on kernel/rcu/torture.c.
22 */
60500037
PM
23
24#define pr_fmt(fmt) fmt
25
51b1130e
PM
26#include <linux/types.h>
27#include <linux/kernel.h>
28#include <linux/init.h>
29#include <linux/module.h>
30#include <linux/kthread.h>
31#include <linux/err.h>
32#include <linux/spinlock.h>
33#include <linux/smp.h>
34#include <linux/interrupt.h>
35#include <linux/sched.h>
e6017571 36#include <linux/sched/clock.h>
51b1130e
PM
37#include <linux/atomic.h>
38#include <linux/bitops.h>
39#include <linux/completion.h>
40#include <linux/moduleparam.h>
41#include <linux/percpu.h>
42#include <linux/notifier.h>
43#include <linux/reboot.h>
44#include <linux/freezer.h>
45#include <linux/cpu.h>
46#include <linux/delay.h>
47#include <linux/stat.h>
48#include <linux/slab.h>
49#include <linux/trace_clock.h>
31257c3c 50#include <linux/ktime.h>
51b1130e
PM
51#include <asm/byteorder.h>
52#include <linux/torture.h>
dac95906 53#include "rcu/rcu.h"
51b1130e
PM
54
55MODULE_LICENSE("GPL");
56MODULE_AUTHOR("Paul E. McKenney <paulmck@us.ibm.com>");
57
b5daa8f3 58static char *torture_type;
90127d60 59static int verbose;
b5daa8f3 60
36970bb9
PM
61/* Mediate rmmod and system shutdown. Concurrent rmmod & shutdown illegal! */
62#define FULLSTOP_DONTSTOP 0 /* Normal operation. */
63#define FULLSTOP_SHUTDOWN 1 /* System shutdown with torture running. */
64#define FULLSTOP_RMMOD 2 /* Normal rmmod of torture. */
65static int fullstop = FULLSTOP_RMMOD;
4622b487 66static DEFINE_MUTEX(fullstop_mutex);
f67a3356 67
2e9e8081
PM
68#ifdef CONFIG_HOTPLUG_CPU
69
70/*
71 * Variables for online-offline handling. Only present if CPU hotplug
72 * is enabled, otherwise does nothing.
73 */
74
75static struct task_struct *onoff_task;
76static long onoff_holdoff;
77static long onoff_interval;
78static long n_offline_attempts;
79static long n_offline_successes;
80static unsigned long sum_offline;
81static int min_offline = -1;
82static int max_offline;
83static long n_online_attempts;
84static long n_online_successes;
85static unsigned long sum_online;
86static int min_online = -1;
87static int max_online;
88
d95f5ba9
PM
89/*
90 * Attempt to take a CPU offline. Return false if the CPU is already
91 * offline or if it is not subject to CPU-hotplug operations. The
92 * caller can detect other failures by looking at the statistics.
93 */
94bool torture_offline(int cpu, long *n_offl_attempts, long *n_offl_successes,
95 unsigned long *sum_offl, int *min_offl, int *max_offl)
96{
97 unsigned long delta;
98 int ret;
99 unsigned long starttime;
100
101 if (!cpu_online(cpu) || !cpu_is_hotpluggable(cpu))
102 return false;
103
90127d60 104 if (verbose > 1)
d95f5ba9
PM
105 pr_alert("%s" TORTURE_FLAG
106 "torture_onoff task: offlining %d\n",
107 torture_type, cpu);
108 starttime = jiffies;
109 (*n_offl_attempts)++;
110 ret = cpu_down(cpu);
111 if (ret) {
112 if (verbose)
113 pr_alert("%s" TORTURE_FLAG
114 "torture_onoff task: offline %d failed: errno %d\n",
115 torture_type, cpu, ret);
116 } else {
90127d60 117 if (verbose > 1)
d95f5ba9
PM
118 pr_alert("%s" TORTURE_FLAG
119 "torture_onoff task: offlined %d\n",
120 torture_type, cpu);
121 (*n_offl_successes)++;
122 delta = jiffies - starttime;
a2b2df20 123 *sum_offl += delta;
d95f5ba9
PM
124 if (*min_offl < 0) {
125 *min_offl = delta;
126 *max_offl = delta;
127 }
128 if (*min_offl > delta)
129 *min_offl = delta;
130 if (*max_offl < delta)
131 *max_offl = delta;
132 }
133
134 return true;
135}
136EXPORT_SYMBOL_GPL(torture_offline);
137
138/*
139 * Attempt to bring a CPU online. Return false if the CPU is already
140 * online or if it is not subject to CPU-hotplug operations. The
141 * caller can detect other failures by looking at the statistics.
142 */
143bool torture_online(int cpu, long *n_onl_attempts, long *n_onl_successes,
144 unsigned long *sum_onl, int *min_onl, int *max_onl)
145{
146 unsigned long delta;
147 int ret;
148 unsigned long starttime;
149
150 if (cpu_online(cpu) || !cpu_is_hotpluggable(cpu))
151 return false;
152
90127d60 153 if (verbose > 1)
d95f5ba9
PM
154 pr_alert("%s" TORTURE_FLAG
155 "torture_onoff task: onlining %d\n",
156 torture_type, cpu);
157 starttime = jiffies;
158 (*n_onl_attempts)++;
159 ret = cpu_up(cpu);
160 if (ret) {
161 if (verbose)
162 pr_alert("%s" TORTURE_FLAG
163 "torture_onoff task: online %d failed: errno %d\n",
164 torture_type, cpu, ret);
165 } else {
90127d60 166 if (verbose > 1)
d95f5ba9
PM
167 pr_alert("%s" TORTURE_FLAG
168 "torture_onoff task: onlined %d\n",
169 torture_type, cpu);
170 (*n_onl_successes)++;
171 delta = jiffies - starttime;
172 *sum_onl += delta;
173 if (*min_onl < 0) {
174 *min_onl = delta;
175 *max_onl = delta;
176 }
177 if (*min_onl > delta)
178 *min_onl = delta;
179 if (*max_onl < delta)
180 *max_onl = delta;
181 }
182
183 return true;
184}
185EXPORT_SYMBOL_GPL(torture_online);
186
2e9e8081
PM
187/*
188 * Execute random CPU-hotplug operations at the interval specified
189 * by the onoff_interval.
190 */
191static int
192torture_onoff(void *arg)
193{
194 int cpu;
2e9e8081
PM
195 int maxcpu = -1;
196 DEFINE_TORTURE_RANDOM(rand);
2e9e8081
PM
197
198 VERBOSE_TOROUT_STRING("torture_onoff task started");
199 for_each_online_cpu(cpu)
200 maxcpu = cpu;
201 WARN_ON(maxcpu < 0);
750db0f5
BF
202
203 if (maxcpu == 0) {
204 VERBOSE_TOROUT_STRING("Only one CPU, so CPU-hotplug testing is disabled");
205 goto stop;
206 }
207
2e9e8081
PM
208 if (onoff_holdoff > 0) {
209 VERBOSE_TOROUT_STRING("torture_onoff begin holdoff");
210 schedule_timeout_interruptible(onoff_holdoff);
211 VERBOSE_TOROUT_STRING("torture_onoff end holdoff");
212 }
213 while (!torture_must_stop()) {
214 cpu = (torture_random(&rand) >> 4) % (maxcpu + 1);
d95f5ba9
PM
215 if (!torture_offline(cpu,
216 &n_offline_attempts, &n_offline_successes,
217 &sum_offline, &min_offline, &max_offline))
218 torture_online(cpu,
219 &n_online_attempts, &n_online_successes,
220 &sum_online, &min_online, &max_online);
2e9e8081
PM
221 schedule_timeout_interruptible(onoff_interval);
222 }
750db0f5
BF
223
224stop:
7fafaac5 225 torture_kthread_stopping("torture_onoff");
2e9e8081
PM
226 return 0;
227}
228
229#endif /* #ifdef CONFIG_HOTPLUG_CPU */
230
231/*
232 * Initiate online-offline handling.
233 */
234int torture_onoff_init(long ooholdoff, long oointerval)
235{
47cf29b9 236 int ret = 0;
2e9e8081 237
47cf29b9 238#ifdef CONFIG_HOTPLUG_CPU
2e9e8081
PM
239 onoff_holdoff = ooholdoff;
240 onoff_interval = oointerval;
241 if (onoff_interval <= 0)
242 return 0;
47cf29b9 243 ret = torture_create_kthread(torture_onoff, NULL, onoff_task);
2e9e8081 244#endif /* #ifdef CONFIG_HOTPLUG_CPU */
47cf29b9 245 return ret;
2e9e8081
PM
246}
247EXPORT_SYMBOL_GPL(torture_onoff_init);
248
249/*
250 * Clean up after online/offline testing.
251 */
cc47ae08 252static void torture_onoff_cleanup(void)
2e9e8081
PM
253{
254#ifdef CONFIG_HOTPLUG_CPU
255 if (onoff_task == NULL)
256 return;
257 VERBOSE_TOROUT_STRING("Stopping torture_onoff task");
258 kthread_stop(onoff_task);
259 onoff_task = NULL;
260#endif /* #ifdef CONFIG_HOTPLUG_CPU */
261}
262EXPORT_SYMBOL_GPL(torture_onoff_cleanup);
263
264/*
265 * Print online/offline testing statistics.
266 */
eea203fe 267void torture_onoff_stats(void)
2e9e8081
PM
268{
269#ifdef CONFIG_HOTPLUG_CPU
eea203fe
JP
270 pr_cont("onoff: %ld/%ld:%ld/%ld %d,%d:%d,%d %lu:%lu (HZ=%d) ",
271 n_online_successes, n_online_attempts,
272 n_offline_successes, n_offline_attempts,
273 min_online, max_online,
274 min_offline, max_offline,
275 sum_online, sum_offline, HZ);
2e9e8081 276#endif /* #ifdef CONFIG_HOTPLUG_CPU */
2e9e8081
PM
277}
278EXPORT_SYMBOL_GPL(torture_onoff_stats);
279
280/*
281 * Were all the online/offline operations successful?
282 */
283bool torture_onoff_failures(void)
284{
285#ifdef CONFIG_HOTPLUG_CPU
286 return n_online_successes != n_online_attempts ||
287 n_offline_successes != n_offline_attempts;
288#else /* #ifdef CONFIG_HOTPLUG_CPU */
289 return false;
290#endif /* #else #ifdef CONFIG_HOTPLUG_CPU */
291}
292EXPORT_SYMBOL_GPL(torture_onoff_failures);
293
51b1130e
PM
294#define TORTURE_RANDOM_MULT 39916801 /* prime */
295#define TORTURE_RANDOM_ADD 479001701 /* prime */
296#define TORTURE_RANDOM_REFRESH 10000
297
298/*
299 * Crude but fast random-number generator. Uses a linear congruential
300 * generator, with occasional help from cpu_clock().
301 */
302unsigned long
303torture_random(struct torture_random_state *trsp)
304{
305 if (--trsp->trs_count < 0) {
306 trsp->trs_state += (unsigned long)local_clock();
307 trsp->trs_count = TORTURE_RANDOM_REFRESH;
308 }
309 trsp->trs_state = trsp->trs_state * TORTURE_RANDOM_MULT +
310 TORTURE_RANDOM_ADD;
311 return swahw32(trsp->trs_state);
312}
313EXPORT_SYMBOL_GPL(torture_random);
f67a3356 314
3808dc9f
PM
315/*
316 * Variables for shuffling. The idea is to ensure that each CPU stays
317 * idle for an extended period to test interactions with dyntick idle,
b564d62e 318 * as well as interactions with any per-CPU variables.
3808dc9f
PM
319 */
320struct shuffle_task {
321 struct list_head st_l;
322 struct task_struct *st_t;
323};
324
325static long shuffle_interval; /* In jiffies. */
326static struct task_struct *shuffler_task;
327static cpumask_var_t shuffle_tmp_mask;
328static int shuffle_idle_cpu; /* Force all torture tasks off this CPU */
329static struct list_head shuffle_task_list = LIST_HEAD_INIT(shuffle_task_list);
330static DEFINE_MUTEX(shuffle_task_mutex);
331
332/*
333 * Register a task to be shuffled. If there is no memory, just splat
334 * and don't bother registering.
335 */
336void torture_shuffle_task_register(struct task_struct *tp)
337{
338 struct shuffle_task *stp;
339
340 if (WARN_ON_ONCE(tp == NULL))
341 return;
342 stp = kmalloc(sizeof(*stp), GFP_KERNEL);
343 if (WARN_ON_ONCE(stp == NULL))
344 return;
345 stp->st_t = tp;
346 mutex_lock(&shuffle_task_mutex);
347 list_add(&stp->st_l, &shuffle_task_list);
348 mutex_unlock(&shuffle_task_mutex);
349}
350EXPORT_SYMBOL_GPL(torture_shuffle_task_register);
351
352/*
353 * Unregister all tasks, for example, at the end of the torture run.
354 */
355static void torture_shuffle_task_unregister_all(void)
356{
357 struct shuffle_task *stp;
358 struct shuffle_task *p;
359
360 mutex_lock(&shuffle_task_mutex);
361 list_for_each_entry_safe(stp, p, &shuffle_task_list, st_l) {
362 list_del(&stp->st_l);
363 kfree(stp);
364 }
365 mutex_unlock(&shuffle_task_mutex);
366}
367
368/* Shuffle tasks such that we allow shuffle_idle_cpu to become idle.
369 * A special case is when shuffle_idle_cpu = -1, in which case we allow
370 * the tasks to run on all CPUs.
371 */
372static void torture_shuffle_tasks(void)
373{
374 struct shuffle_task *stp;
375
376 cpumask_setall(shuffle_tmp_mask);
377 get_online_cpus();
378
379 /* No point in shuffling if there is only one online CPU (ex: UP) */
380 if (num_online_cpus() == 1) {
381 put_online_cpus();
382 return;
383 }
384
385 /* Advance to the next CPU. Upon overflow, don't idle any CPUs. */
386 shuffle_idle_cpu = cpumask_next(shuffle_idle_cpu, shuffle_tmp_mask);
387 if (shuffle_idle_cpu >= nr_cpu_ids)
388 shuffle_idle_cpu = -1;
5ed63b19 389 else
3808dc9f 390 cpumask_clear_cpu(shuffle_idle_cpu, shuffle_tmp_mask);
3808dc9f
PM
391
392 mutex_lock(&shuffle_task_mutex);
393 list_for_each_entry(stp, &shuffle_task_list, st_l)
394 set_cpus_allowed_ptr(stp->st_t, shuffle_tmp_mask);
395 mutex_unlock(&shuffle_task_mutex);
396
397 put_online_cpus();
398}
399
400/* Shuffle tasks across CPUs, with the intent of allowing each CPU in the
401 * system to become idle at a time and cut off its timer ticks. This is meant
402 * to test the support for such tickless idle CPU in RCU.
403 */
404static int torture_shuffle(void *arg)
405{
406 VERBOSE_TOROUT_STRING("torture_shuffle task started");
407 do {
408 schedule_timeout_interruptible(shuffle_interval);
409 torture_shuffle_tasks();
410 torture_shutdown_absorb("torture_shuffle");
411 } while (!torture_must_stop());
7fafaac5 412 torture_kthread_stopping("torture_shuffle");
3808dc9f
PM
413 return 0;
414}
415
416/*
417 * Start the shuffler, with shuffint in jiffies.
418 */
419int torture_shuffle_init(long shuffint)
420{
3808dc9f
PM
421 shuffle_interval = shuffint;
422
423 shuffle_idle_cpu = -1;
424
425 if (!alloc_cpumask_var(&shuffle_tmp_mask, GFP_KERNEL)) {
426 VERBOSE_TOROUT_ERRSTRING("Failed to alloc mask");
427 return -ENOMEM;
428 }
429
430 /* Create the shuffler thread */
47cf29b9 431 return torture_create_kthread(torture_shuffle, NULL, shuffler_task);
3808dc9f
PM
432}
433EXPORT_SYMBOL_GPL(torture_shuffle_init);
434
435/*
436 * Stop the shuffling.
437 */
cc47ae08 438static void torture_shuffle_cleanup(void)
3808dc9f
PM
439{
440 torture_shuffle_task_unregister_all();
441 if (shuffler_task) {
442 VERBOSE_TOROUT_STRING("Stopping torture_shuffle task");
443 kthread_stop(shuffler_task);
444 free_cpumask_var(shuffle_tmp_mask);
445 }
446 shuffler_task = NULL;
447}
448EXPORT_SYMBOL_GPL(torture_shuffle_cleanup);
449
e991dbc0
PM
450/*
451 * Variables for auto-shutdown. This allows "lights out" torture runs
452 * to be fully scripted.
453 */
e991dbc0 454static struct task_struct *shutdown_task;
31257c3c 455static ktime_t shutdown_time; /* time to system shutdown. */
e991dbc0
PM
456static void (*torture_shutdown_hook)(void);
457
f67a3356
PM
458/*
459 * Absorb kthreads into a kernel function that won't return, so that
460 * they won't ever access module text or data again.
461 */
462void torture_shutdown_absorb(const char *title)
463{
7d0ae808 464 while (READ_ONCE(fullstop) == FULLSTOP_SHUTDOWN) {
4622b487
PM
465 pr_notice("torture thread %s parking due to system shutdown\n",
466 title);
f67a3356
PM
467 schedule_timeout_uninterruptible(MAX_SCHEDULE_TIMEOUT);
468 }
469}
470EXPORT_SYMBOL_GPL(torture_shutdown_absorb);
b5daa8f3 471
e991dbc0
PM
472/*
473 * Cause the torture test to shutdown the system after the test has
474 * run for the time specified by the shutdown_secs parameter.
475 */
476static int torture_shutdown(void *arg)
477{
31257c3c 478 ktime_t ktime_snap;
e991dbc0
PM
479
480 VERBOSE_TOROUT_STRING("torture_shutdown task started");
31257c3c
PM
481 ktime_snap = ktime_get();
482 while (ktime_before(ktime_snap, shutdown_time) &&
e991dbc0 483 !torture_must_stop()) {
e991dbc0
PM
484 if (verbose)
485 pr_alert("%s" TORTURE_FLAG
31257c3c
PM
486 "torture_shutdown task: %llu ms remaining\n",
487 torture_type,
488 ktime_ms_delta(shutdown_time, ktime_snap));
489 set_current_state(TASK_INTERRUPTIBLE);
490 schedule_hrtimeout(&shutdown_time, HRTIMER_MODE_ABS);
491 ktime_snap = ktime_get();
e991dbc0
PM
492 }
493 if (torture_must_stop()) {
7fafaac5 494 torture_kthread_stopping("torture_shutdown");
e991dbc0
PM
495 return 0;
496 }
497
498 /* OK, shut down the system. */
499
500 VERBOSE_TOROUT_STRING("torture_shutdown task shutting down system");
501 shutdown_task = NULL; /* Avoid self-kill deadlock. */
f881825a
PM
502 if (torture_shutdown_hook)
503 torture_shutdown_hook();
504 else
505 VERBOSE_TOROUT_STRING("No torture_shutdown_hook(), skipping.");
dac95906 506 rcu_ftrace_dump(DUMP_ALL);
e991dbc0
PM
507 kernel_power_off(); /* Shut down the system. */
508 return 0;
509}
510
511/*
512 * Start up the shutdown task.
513 */
514int torture_shutdown_init(int ssecs, void (*cleanup)(void))
515{
47cf29b9 516 int ret = 0;
e991dbc0 517
e991dbc0 518 torture_shutdown_hook = cleanup;
31257c3c
PM
519 if (ssecs > 0) {
520 shutdown_time = ktime_add(ktime_get(), ktime_set(ssecs, 0));
47cf29b9
PM
521 ret = torture_create_kthread(torture_shutdown, NULL,
522 shutdown_task);
e991dbc0 523 }
47cf29b9 524 return ret;
e991dbc0
PM
525}
526EXPORT_SYMBOL_GPL(torture_shutdown_init);
527
4622b487
PM
528/*
529 * Detect and respond to a system shutdown.
530 */
531static int torture_shutdown_notify(struct notifier_block *unused1,
532 unsigned long unused2, void *unused3)
533{
534 mutex_lock(&fullstop_mutex);
7d0ae808 535 if (READ_ONCE(fullstop) == FULLSTOP_DONTSTOP) {
fac480ef 536 VERBOSE_TOROUT_STRING("Unscheduled system shutdown detected");
7d0ae808 537 WRITE_ONCE(fullstop, FULLSTOP_SHUTDOWN);
fac480ef 538 } else {
4622b487 539 pr_warn("Concurrent rmmod and shutdown illegal!\n");
fac480ef 540 }
4622b487
PM
541 mutex_unlock(&fullstop_mutex);
542 return NOTIFY_DONE;
543}
544
545static struct notifier_block torture_shutdown_nb = {
546 .notifier_call = torture_shutdown_notify,
547};
548
bfefc73a
PM
549/*
550 * Shut down the shutdown task. Say what??? Heh! This can happen if
551 * the torture module gets an rmmod before the shutdown time arrives. ;-)
552 */
553static void torture_shutdown_cleanup(void)
554{
555 unregister_reboot_notifier(&torture_shutdown_nb);
556 if (shutdown_task != NULL) {
557 VERBOSE_TOROUT_STRING("Stopping torture_shutdown task");
558 kthread_stop(shutdown_task);
559 }
560 shutdown_task = NULL;
561}
562
628edaa5
PM
563/*
564 * Variables for stuttering, which means to periodically pause and
565 * restart testing in order to catch bugs that appear when load is
566 * suddenly applied to or removed from the system.
567 */
568static struct task_struct *stutter_task;
569static int stutter_pause_test;
570static int stutter;
571
572/*
573 * Block until the stutter interval ends. This must be called periodically
574 * by all running kthreads that need to be subject to stuttering.
575 */
474e59b4 576bool stutter_wait(const char *title)
628edaa5 577{
4ced3314
PM
578 int spt;
579
cee43939 580 cond_resched_tasks_rcu_qs();
4ced3314 581 spt = READ_ONCE(stutter_pause_test);
29d39390 582 for (; spt; spt = READ_ONCE(stutter_pause_test)) {
4ced3314
PM
583 if (spt == 1) {
584 schedule_timeout_interruptible(1);
585 } else if (spt == 2) {
586 while (READ_ONCE(stutter_pause_test))
587 cond_resched();
588 } else {
628edaa5 589 schedule_timeout_interruptible(round_jiffies_relative(HZ));
4ced3314 590 }
628edaa5
PM
591 torture_shutdown_absorb(title);
592 }
474e59b4 593 return !!spt;
628edaa5
PM
594}
595EXPORT_SYMBOL_GPL(stutter_wait);
596
597/*
598 * Cause the torture test to "stutter", starting and stopping all
599 * threads periodically.
600 */
601static int torture_stutter(void *arg)
602{
603 VERBOSE_TOROUT_STRING("torture_stutter task started");
604 do {
4ced3314 605 if (!torture_must_stop() && stutter > 1) {
7d0ae808 606 WRITE_ONCE(stutter_pause_test, 1);
4ced3314
PM
607 schedule_timeout_interruptible(stutter - 1);
608 WRITE_ONCE(stutter_pause_test, 2);
609 schedule_timeout_interruptible(1);
628edaa5 610 }
4ced3314 611 WRITE_ONCE(stutter_pause_test, 0);
628edaa5
PM
612 if (!torture_must_stop())
613 schedule_timeout_interruptible(stutter);
628edaa5
PM
614 torture_shutdown_absorb("torture_stutter");
615 } while (!torture_must_stop());
7fafaac5 616 torture_kthread_stopping("torture_stutter");
628edaa5
PM
617 return 0;
618}
619
620/*
621 * Initialize and kick off the torture_stutter kthread.
622 */
623int torture_stutter_init(int s)
624{
625 int ret;
626
627 stutter = s;
47cf29b9
PM
628 ret = torture_create_kthread(torture_stutter, NULL, stutter_task);
629 return ret;
628edaa5
PM
630}
631EXPORT_SYMBOL_GPL(torture_stutter_init);
632
633/*
634 * Cleanup after the torture_stutter kthread.
635 */
bfefc73a 636static void torture_stutter_cleanup(void)
628edaa5
PM
637{
638 if (!stutter_task)
639 return;
640 VERBOSE_TOROUT_STRING("Stopping torture_stutter task");
641 kthread_stop(stutter_task);
642 stutter_task = NULL;
643}
628edaa5 644
b5daa8f3
PM
645/*
646 * Initialize torture module. Please note that this is -not- invoked via
647 * the usual module_init() mechanism, but rather by an explicit call from
648 * the client torture module. This call must be paired with a later
649 * torture_init_end().
628edaa5
PM
650 *
651 * The runnable parameter points to a flag that controls whether or not
652 * the test is currently runnable. If there is no such flag, pass in NULL.
b5daa8f3 653 */
90127d60 654bool torture_init_begin(char *ttype, int v)
b5daa8f3
PM
655{
656 mutex_lock(&fullstop_mutex);
5228084e 657 if (torture_type != NULL) {
9eb5188a 658 pr_alert("torture_init_begin: Refusing %s init: %s running.\n",
5228084e 659 ttype, torture_type);
9eb5188a 660 pr_alert("torture_init_begin: One torture test at a time!\n");
5228084e
PM
661 mutex_unlock(&fullstop_mutex);
662 return false;
663 }
b5daa8f3
PM
664 torture_type = ttype;
665 verbose = v;
36970bb9 666 fullstop = FULLSTOP_DONTSTOP;
5228084e 667 return true;
b5daa8f3
PM
668}
669EXPORT_SYMBOL_GPL(torture_init_begin);
670
671/*
672 * Tell the torture module that initialization is complete.
673 */
2b3f8ffe 674void torture_init_end(void)
b5daa8f3
PM
675{
676 mutex_unlock(&fullstop_mutex);
4622b487 677 register_reboot_notifier(&torture_shutdown_nb);
b5daa8f3
PM
678}
679EXPORT_SYMBOL_GPL(torture_init_end);
cc47ae08
PM
680
681/*
682 * Clean up torture module. Please note that this is -not- invoked via
683 * the usual module_exit() mechanism, but rather by an explicit call from
684 * the client torture module. Returns true if a race with system shutdown
bfefc73a
PM
685 * is detected, otherwise, all kthreads started by functions in this file
686 * will be shut down.
cc47ae08
PM
687 *
688 * This must be called before the caller starts shutting down its own
689 * kthreads.
d36a7a0d
DB
690 *
691 * Both torture_cleanup_begin() and torture_cleanup_end() must be paired,
692 * in order to correctly perform the cleanup. They are separated because
693 * threads can still need to reference the torture_type type, thus nullify
694 * only after completing all other relevant calls.
cc47ae08 695 */
d36a7a0d 696bool torture_cleanup_begin(void)
cc47ae08
PM
697{
698 mutex_lock(&fullstop_mutex);
7d0ae808 699 if (READ_ONCE(fullstop) == FULLSTOP_SHUTDOWN) {
cc47ae08
PM
700 pr_warn("Concurrent rmmod and shutdown illegal!\n");
701 mutex_unlock(&fullstop_mutex);
702 schedule_timeout_uninterruptible(10);
703 return true;
704 }
7d0ae808 705 WRITE_ONCE(fullstop, FULLSTOP_RMMOD);
cc47ae08 706 mutex_unlock(&fullstop_mutex);
bfefc73a 707 torture_shutdown_cleanup();
cc47ae08 708 torture_shuffle_cleanup();
bfefc73a 709 torture_stutter_cleanup();
cc47ae08 710 torture_onoff_cleanup();
d36a7a0d
DB
711 return false;
712}
713EXPORT_SYMBOL_GPL(torture_cleanup_begin);
714
715void torture_cleanup_end(void)
716{
5228084e
PM
717 mutex_lock(&fullstop_mutex);
718 torture_type = NULL;
719 mutex_unlock(&fullstop_mutex);
cc47ae08 720}
d36a7a0d 721EXPORT_SYMBOL_GPL(torture_cleanup_end);
36970bb9
PM
722
723/*
724 * Is it time for the current torture test to stop?
725 */
726bool torture_must_stop(void)
727{
728 return torture_must_stop_irq() || kthread_should_stop();
729}
730EXPORT_SYMBOL_GPL(torture_must_stop);
731
732/*
733 * Is it time for the current torture test to stop? This is the irq-safe
734 * version, hence no check for kthread_should_stop().
735 */
736bool torture_must_stop_irq(void)
737{
7d0ae808 738 return READ_ONCE(fullstop) != FULLSTOP_DONTSTOP;
36970bb9
PM
739}
740EXPORT_SYMBOL_GPL(torture_must_stop_irq);
7fafaac5
PM
741
742/*
743 * Each kthread must wait for kthread_should_stop() before returning from
744 * its top-level function, otherwise segfaults ensue. This function
745 * prints a "stopping" message and waits for kthread_should_stop(), and
746 * should be called from all torture kthreads immediately prior to
747 * returning.
748 */
749void torture_kthread_stopping(char *title)
750{
0d6821d5
PM
751 char buf[128];
752
753 snprintf(buf, sizeof(buf), "Stopping %s", title);
754 VERBOSE_TOROUT_STRING(buf);
7fafaac5
PM
755 while (!kthread_should_stop()) {
756 torture_shutdown_absorb(title);
757 schedule_timeout_uninterruptible(1);
758 }
759}
760EXPORT_SYMBOL_GPL(torture_kthread_stopping);
47cf29b9
PM
761
762/*
763 * Create a generic torture kthread that is immediately runnable. If you
764 * need the kthread to be stopped so that you can do something to it before
765 * it starts, you will need to open-code your own.
766 */
767int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m,
768 char *f, struct task_struct **tp)
769{
770 int ret = 0;
771
772 VERBOSE_TOROUT_STRING(m);
6945915e 773 *tp = kthread_run(fn, arg, "%s", s);
47cf29b9
PM
774 if (IS_ERR(*tp)) {
775 ret = PTR_ERR(*tp);
776 VERBOSE_TOROUT_ERRSTRING(f);
777 *tp = NULL;
778 }
779 torture_shuffle_task_register(*tp);
780 return ret;
781}
782EXPORT_SYMBOL_GPL(_torture_create_kthread);
9c029b86
PM
783
784/*
785 * Stop a generic kthread, emitting a message.
786 */
787void _torture_stop_kthread(char *m, struct task_struct **tp)
788{
789 if (*tp == NULL)
790 return;
791 VERBOSE_TOROUT_STRING(m);
792 kthread_stop(*tp);
793 *tp = NULL;
794}
795EXPORT_SYMBOL_GPL(_torture_stop_kthread);