2 * Common functions for in-kernel torture tests.
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.
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.
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.
18 * Copyright (C) IBM Corporation, 2014
20 * Author: Paul E. McKenney <paulmck@us.ibm.com>
21 * Based on kernel/rcu/torture.c.
23 #include <linux/types.h>
24 #include <linux/kernel.h>
25 #include <linux/init.h>
26 #include <linux/module.h>
27 #include <linux/kthread.h>
28 #include <linux/err.h>
29 #include <linux/spinlock.h>
30 #include <linux/smp.h>
31 #include <linux/interrupt.h>
32 #include <linux/sched.h>
33 #include <linux/atomic.h>
34 #include <linux/bitops.h>
35 #include <linux/completion.h>
36 #include <linux/moduleparam.h>
37 #include <linux/percpu.h>
38 #include <linux/notifier.h>
39 #include <linux/reboot.h>
40 #include <linux/freezer.h>
41 #include <linux/cpu.h>
42 #include <linux/delay.h>
43 #include <linux/stat.h>
44 #include <linux/slab.h>
45 #include <linux/trace_clock.h>
46 #include <asm/byteorder.h>
47 #include <linux/torture.h>
49 MODULE_LICENSE("GPL");
50 MODULE_AUTHOR("Paul E. McKenney <paulmck@us.ibm.com>");
52 static char *torture_type;
55 /* Mediate rmmod and system shutdown. Concurrent rmmod & shutdown illegal! */
56 #define FULLSTOP_DONTSTOP 0 /* Normal operation. */
57 #define FULLSTOP_SHUTDOWN 1 /* System shutdown with torture running. */
58 #define FULLSTOP_RMMOD 2 /* Normal rmmod of torture. */
59 static int fullstop = FULLSTOP_RMMOD;
60 static DEFINE_MUTEX(fullstop_mutex);
61 static int *torture_runnable;
63 #ifdef CONFIG_HOTPLUG_CPU
66 * Variables for online-offline handling. Only present if CPU hotplug
67 * is enabled, otherwise does nothing.
70 static struct task_struct *onoff_task;
71 static long onoff_holdoff;
72 static long onoff_interval;
73 static long n_offline_attempts;
74 static long n_offline_successes;
75 static unsigned long sum_offline;
76 static int min_offline = -1;
77 static int max_offline;
78 static long n_online_attempts;
79 static long n_online_successes;
80 static unsigned long sum_online;
81 static int min_online = -1;
82 static int max_online;
85 * Execute random CPU-hotplug operations at the interval specified
86 * by the onoff_interval.
89 torture_onoff(void *arg)
94 DEFINE_TORTURE_RANDOM(rand);
96 unsigned long starttime;
98 VERBOSE_TOROUT_STRING("torture_onoff task started");
99 for_each_online_cpu(cpu)
102 if (onoff_holdoff > 0) {
103 VERBOSE_TOROUT_STRING("torture_onoff begin holdoff");
104 schedule_timeout_interruptible(onoff_holdoff);
105 VERBOSE_TOROUT_STRING("torture_onoff end holdoff");
107 while (!torture_must_stop()) {
108 cpu = (torture_random(&rand) >> 4) % (maxcpu + 1);
109 if (cpu_online(cpu) && cpu_is_hotpluggable(cpu)) {
111 pr_alert("%s" TORTURE_FLAG
112 "torture_onoff task: offlining %d\n",
115 n_offline_attempts++;
119 pr_alert("%s" TORTURE_FLAG
120 "torture_onoff task: offline %d failed: errno %d\n",
121 torture_type, cpu, ret);
124 pr_alert("%s" TORTURE_FLAG
125 "torture_onoff task: offlined %d\n",
127 n_offline_successes++;
128 delta = jiffies - starttime;
129 sum_offline += delta;
130 if (min_offline < 0) {
134 if (min_offline > delta)
136 if (max_offline < delta)
139 } else if (cpu_is_hotpluggable(cpu)) {
141 pr_alert("%s" TORTURE_FLAG
142 "torture_onoff task: onlining %d\n",
149 pr_alert("%s" TORTURE_FLAG
150 "torture_onoff task: online %d failed: errno %d\n",
151 torture_type, cpu, ret);
154 pr_alert("%s" TORTURE_FLAG
155 "torture_onoff task: onlined %d\n",
157 n_online_successes++;
158 delta = jiffies - starttime;
160 if (min_online < 0) {
164 if (min_online > delta)
166 if (max_online < delta)
170 schedule_timeout_interruptible(onoff_interval);
172 VERBOSE_TOROUT_STRING("torture_onoff task stopping");
176 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
179 * Initiate online-offline handling.
181 int torture_onoff_init(long ooholdoff, long oointerval)
183 #ifdef CONFIG_HOTPLUG_CPU
186 onoff_holdoff = ooholdoff;
187 onoff_interval = oointerval;
188 if (onoff_interval <= 0)
190 onoff_task = kthread_run(torture_onoff, NULL, "torture_onoff");
191 if (IS_ERR(onoff_task)) {
192 ret = PTR_ERR(onoff_task);
196 torture_shuffle_task_register(onoff_task);
197 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
200 EXPORT_SYMBOL_GPL(torture_onoff_init);
203 * Clean up after online/offline testing.
205 static void torture_onoff_cleanup(void)
207 #ifdef CONFIG_HOTPLUG_CPU
208 if (onoff_task == NULL)
210 VERBOSE_TOROUT_STRING("Stopping torture_onoff task");
211 kthread_stop(onoff_task);
213 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
215 EXPORT_SYMBOL_GPL(torture_onoff_cleanup);
218 * Print online/offline testing statistics.
220 char *torture_onoff_stats(char *page)
222 #ifdef CONFIG_HOTPLUG_CPU
223 page += sprintf(page,
224 "onoff: %ld/%ld:%ld/%ld %d,%d:%d,%d %lu:%lu (HZ=%d) ",
225 n_online_successes, n_online_attempts,
226 n_offline_successes, n_offline_attempts,
227 min_online, max_online,
228 min_offline, max_offline,
229 sum_online, sum_offline, HZ);
230 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
233 EXPORT_SYMBOL_GPL(torture_onoff_stats);
236 * Were all the online/offline operations successful?
238 bool torture_onoff_failures(void)
240 #ifdef CONFIG_HOTPLUG_CPU
241 return n_online_successes != n_online_attempts ||
242 n_offline_successes != n_offline_attempts;
243 #else /* #ifdef CONFIG_HOTPLUG_CPU */
245 #endif /* #else #ifdef CONFIG_HOTPLUG_CPU */
247 EXPORT_SYMBOL_GPL(torture_onoff_failures);
249 #define TORTURE_RANDOM_MULT 39916801 /* prime */
250 #define TORTURE_RANDOM_ADD 479001701 /* prime */
251 #define TORTURE_RANDOM_REFRESH 10000
254 * Crude but fast random-number generator. Uses a linear congruential
255 * generator, with occasional help from cpu_clock().
258 torture_random(struct torture_random_state *trsp)
260 if (--trsp->trs_count < 0) {
261 trsp->trs_state += (unsigned long)local_clock();
262 trsp->trs_count = TORTURE_RANDOM_REFRESH;
264 trsp->trs_state = trsp->trs_state * TORTURE_RANDOM_MULT +
266 return swahw32(trsp->trs_state);
268 EXPORT_SYMBOL_GPL(torture_random);
271 * Variables for shuffling. The idea is to ensure that each CPU stays
272 * idle for an extended period to test interactions with dyntick idle,
273 * as well as interactions with any per-CPU varibles.
275 struct shuffle_task {
276 struct list_head st_l;
277 struct task_struct *st_t;
280 static long shuffle_interval; /* In jiffies. */
281 static struct task_struct *shuffler_task;
282 static cpumask_var_t shuffle_tmp_mask;
283 static int shuffle_idle_cpu; /* Force all torture tasks off this CPU */
284 static struct list_head shuffle_task_list = LIST_HEAD_INIT(shuffle_task_list);
285 static DEFINE_MUTEX(shuffle_task_mutex);
288 * Register a task to be shuffled. If there is no memory, just splat
289 * and don't bother registering.
291 void torture_shuffle_task_register(struct task_struct *tp)
293 struct shuffle_task *stp;
295 if (WARN_ON_ONCE(tp == NULL))
297 stp = kmalloc(sizeof(*stp), GFP_KERNEL);
298 if (WARN_ON_ONCE(stp == NULL))
301 mutex_lock(&shuffle_task_mutex);
302 list_add(&stp->st_l, &shuffle_task_list);
303 mutex_unlock(&shuffle_task_mutex);
305 EXPORT_SYMBOL_GPL(torture_shuffle_task_register);
308 * Unregister all tasks, for example, at the end of the torture run.
310 static void torture_shuffle_task_unregister_all(void)
312 struct shuffle_task *stp;
313 struct shuffle_task *p;
315 mutex_lock(&shuffle_task_mutex);
316 list_for_each_entry_safe(stp, p, &shuffle_task_list, st_l) {
317 list_del(&stp->st_l);
320 mutex_unlock(&shuffle_task_mutex);
323 /* Shuffle tasks such that we allow shuffle_idle_cpu to become idle.
324 * A special case is when shuffle_idle_cpu = -1, in which case we allow
325 * the tasks to run on all CPUs.
327 static void torture_shuffle_tasks(void)
329 struct shuffle_task *stp;
331 cpumask_setall(shuffle_tmp_mask);
334 /* No point in shuffling if there is only one online CPU (ex: UP) */
335 if (num_online_cpus() == 1) {
340 /* Advance to the next CPU. Upon overflow, don't idle any CPUs. */
341 shuffle_idle_cpu = cpumask_next(shuffle_idle_cpu, shuffle_tmp_mask);
342 if (shuffle_idle_cpu >= nr_cpu_ids)
343 shuffle_idle_cpu = -1;
344 if (shuffle_idle_cpu != -1) {
345 cpumask_clear_cpu(shuffle_idle_cpu, shuffle_tmp_mask);
346 if (cpumask_empty(shuffle_tmp_mask)) {
352 mutex_lock(&shuffle_task_mutex);
353 list_for_each_entry(stp, &shuffle_task_list, st_l)
354 set_cpus_allowed_ptr(stp->st_t, shuffle_tmp_mask);
355 mutex_unlock(&shuffle_task_mutex);
360 /* Shuffle tasks across CPUs, with the intent of allowing each CPU in the
361 * system to become idle at a time and cut off its timer ticks. This is meant
362 * to test the support for such tickless idle CPU in RCU.
364 static int torture_shuffle(void *arg)
366 VERBOSE_TOROUT_STRING("torture_shuffle task started");
368 schedule_timeout_interruptible(shuffle_interval);
369 torture_shuffle_tasks();
370 torture_shutdown_absorb("torture_shuffle");
371 } while (!torture_must_stop());
372 VERBOSE_TOROUT_STRING("torture_shuffle task stopping");
377 * Start the shuffler, with shuffint in jiffies.
379 int torture_shuffle_init(long shuffint)
383 shuffle_interval = shuffint;
385 shuffle_idle_cpu = -1;
387 if (!alloc_cpumask_var(&shuffle_tmp_mask, GFP_KERNEL)) {
388 VERBOSE_TOROUT_ERRSTRING("Failed to alloc mask");
392 /* Create the shuffler thread */
393 shuffler_task = kthread_run(torture_shuffle, NULL, "torture_shuffle");
394 if (IS_ERR(shuffler_task)) {
395 ret = PTR_ERR(shuffler_task);
396 free_cpumask_var(shuffle_tmp_mask);
397 VERBOSE_TOROUT_ERRSTRING("Failed to create shuffler");
398 shuffler_task = NULL;
401 torture_shuffle_task_register(shuffler_task);
404 EXPORT_SYMBOL_GPL(torture_shuffle_init);
407 * Stop the shuffling.
409 static void torture_shuffle_cleanup(void)
411 torture_shuffle_task_unregister_all();
413 VERBOSE_TOROUT_STRING("Stopping torture_shuffle task");
414 kthread_stop(shuffler_task);
415 free_cpumask_var(shuffle_tmp_mask);
417 shuffler_task = NULL;
419 EXPORT_SYMBOL_GPL(torture_shuffle_cleanup);
422 * Variables for auto-shutdown. This allows "lights out" torture runs
423 * to be fully scripted.
425 static int shutdown_secs; /* desired test duration in seconds. */
426 static struct task_struct *shutdown_task;
427 static unsigned long shutdown_time; /* jiffies to system shutdown. */
428 static void (*torture_shutdown_hook)(void);
431 * Absorb kthreads into a kernel function that won't return, so that
432 * they won't ever access module text or data again.
434 void torture_shutdown_absorb(const char *title)
436 while (ACCESS_ONCE(fullstop) == FULLSTOP_SHUTDOWN) {
437 pr_notice("torture thread %s parking due to system shutdown\n",
439 schedule_timeout_uninterruptible(MAX_SCHEDULE_TIMEOUT);
442 EXPORT_SYMBOL_GPL(torture_shutdown_absorb);
445 * Cause the torture test to shutdown the system after the test has
446 * run for the time specified by the shutdown_secs parameter.
448 static int torture_shutdown(void *arg)
451 unsigned long jiffies_snap;
453 VERBOSE_TOROUT_STRING("torture_shutdown task started");
454 jiffies_snap = jiffies;
455 while (ULONG_CMP_LT(jiffies_snap, shutdown_time) &&
456 !torture_must_stop()) {
457 delta = shutdown_time - jiffies_snap;
459 pr_alert("%s" TORTURE_FLAG
460 "torture_shutdown task: %lu jiffies remaining\n",
461 torture_type, delta);
462 schedule_timeout_interruptible(delta);
463 jiffies_snap = jiffies;
465 if (torture_must_stop()) {
466 VERBOSE_TOROUT_STRING("torture_shutdown task stopping");
470 /* OK, shut down the system. */
472 VERBOSE_TOROUT_STRING("torture_shutdown task shutting down system");
473 shutdown_task = NULL; /* Avoid self-kill deadlock. */
474 torture_shutdown_hook();/* Shut down the enclosing torture test. */
475 kernel_power_off(); /* Shut down the system. */
480 * Start up the shutdown task.
482 int torture_shutdown_init(int ssecs, void (*cleanup)(void))
486 shutdown_secs = ssecs;
487 torture_shutdown_hook = cleanup;
488 if (shutdown_secs > 0) {
489 shutdown_time = jiffies + shutdown_secs * HZ;
490 shutdown_task = kthread_create(torture_shutdown, NULL,
492 if (IS_ERR(shutdown_task)) {
493 ret = PTR_ERR(shutdown_task);
494 VERBOSE_TOROUT_ERRSTRING("Failed to create shutdown");
495 shutdown_task = NULL;
498 torture_shuffle_task_register(shutdown_task);
499 wake_up_process(shutdown_task);
503 EXPORT_SYMBOL_GPL(torture_shutdown_init);
506 * Shut down the shutdown task. Say what??? Heh! This can happen if
507 * the torture module gets an rmmod before the shutdown time arrives. ;-)
509 void torture_shutdown_cleanup(void)
511 if (shutdown_task != NULL) {
512 VERBOSE_TOROUT_STRING("Stopping torture_shutdown task");
513 kthread_stop(shutdown_task);
515 shutdown_task = NULL;
517 EXPORT_SYMBOL_GPL(torture_shutdown_cleanup);
520 * Detect and respond to a system shutdown.
522 static int torture_shutdown_notify(struct notifier_block *unused1,
523 unsigned long unused2, void *unused3)
525 mutex_lock(&fullstop_mutex);
526 if (ACCESS_ONCE(fullstop) == FULLSTOP_DONTSTOP) {
527 VERBOSE_TOROUT_STRING("Unscheduled system shutdown detected");
528 ACCESS_ONCE(fullstop) = FULLSTOP_SHUTDOWN;
530 pr_warn("Concurrent rmmod and shutdown illegal!\n");
532 mutex_unlock(&fullstop_mutex);
536 static struct notifier_block torture_shutdown_nb = {
537 .notifier_call = torture_shutdown_notify,
541 * Variables for stuttering, which means to periodically pause and
542 * restart testing in order to catch bugs that appear when load is
543 * suddenly applied to or removed from the system.
545 static struct task_struct *stutter_task;
546 static int stutter_pause_test;
550 * Block until the stutter interval ends. This must be called periodically
551 * by all running kthreads that need to be subject to stuttering.
553 void stutter_wait(const char *title)
555 while (ACCESS_ONCE(stutter_pause_test) ||
556 (torture_runnable && !ACCESS_ONCE(*torture_runnable))) {
557 if (stutter_pause_test)
558 schedule_timeout_interruptible(1);
560 schedule_timeout_interruptible(round_jiffies_relative(HZ));
561 torture_shutdown_absorb(title);
564 EXPORT_SYMBOL_GPL(stutter_wait);
567 * Cause the torture test to "stutter", starting and stopping all
568 * threads periodically.
570 static int torture_stutter(void *arg)
572 VERBOSE_TOROUT_STRING("torture_stutter task started");
574 if (!torture_must_stop()) {
575 schedule_timeout_interruptible(stutter);
576 ACCESS_ONCE(stutter_pause_test) = 1;
578 if (!torture_must_stop())
579 schedule_timeout_interruptible(stutter);
580 ACCESS_ONCE(stutter_pause_test) = 0;
581 torture_shutdown_absorb("torture_stutter");
582 } while (!torture_must_stop());
583 VERBOSE_TOROUT_STRING("torture_stutter task stopping");
588 * Initialize and kick off the torture_stutter kthread.
590 int torture_stutter_init(int s)
595 stutter_task = kthread_run(torture_stutter, NULL, "torture_stutter");
596 if (IS_ERR(stutter_task)) {
597 ret = PTR_ERR(stutter_task);
598 VERBOSE_TOROUT_ERRSTRING("Failed to create stutter");
602 torture_shuffle_task_register(stutter_task);
605 EXPORT_SYMBOL_GPL(torture_stutter_init);
608 * Cleanup after the torture_stutter kthread.
610 void torture_stutter_cleanup(void)
614 VERBOSE_TOROUT_STRING("Stopping torture_stutter task");
615 kthread_stop(stutter_task);
618 EXPORT_SYMBOL_GPL(torture_stutter_cleanup);
621 * Initialize torture module. Please note that this is -not- invoked via
622 * the usual module_init() mechanism, but rather by an explicit call from
623 * the client torture module. This call must be paired with a later
624 * torture_init_end().
626 * The runnable parameter points to a flag that controls whether or not
627 * the test is currently runnable. If there is no such flag, pass in NULL.
629 void __init torture_init_begin(char *ttype, bool v, int *runnable)
631 mutex_lock(&fullstop_mutex);
632 torture_type = ttype;
634 torture_runnable = runnable;
635 fullstop = FULLSTOP_DONTSTOP;
638 EXPORT_SYMBOL_GPL(torture_init_begin);
641 * Tell the torture module that initialization is complete.
643 void __init torture_init_end(void)
645 mutex_unlock(&fullstop_mutex);
646 register_reboot_notifier(&torture_shutdown_nb);
648 EXPORT_SYMBOL_GPL(torture_init_end);
651 * Clean up torture module. Please note that this is -not- invoked via
652 * the usual module_exit() mechanism, but rather by an explicit call from
653 * the client torture module. Returns true if a race with system shutdown
656 * This must be called before the caller starts shutting down its own
659 bool torture_cleanup(void)
661 mutex_lock(&fullstop_mutex);
662 if (ACCESS_ONCE(fullstop) == FULLSTOP_SHUTDOWN) {
663 pr_warn("Concurrent rmmod and shutdown illegal!\n");
664 mutex_unlock(&fullstop_mutex);
665 schedule_timeout_uninterruptible(10);
668 ACCESS_ONCE(fullstop) = FULLSTOP_RMMOD;
669 mutex_unlock(&fullstop_mutex);
670 unregister_reboot_notifier(&torture_shutdown_nb);
671 torture_shuffle_cleanup();
672 torture_onoff_cleanup();
675 EXPORT_SYMBOL_GPL(torture_cleanup);
678 * Is it time for the current torture test to stop?
680 bool torture_must_stop(void)
682 return torture_must_stop_irq() || kthread_should_stop();
684 EXPORT_SYMBOL_GPL(torture_must_stop);
687 * Is it time for the current torture test to stop? This is the irq-safe
688 * version, hence no check for kthread_should_stop().
690 bool torture_must_stop_irq(void)
692 return ACCESS_ONCE(fullstop) != FULLSTOP_DONTSTOP;
694 EXPORT_SYMBOL_GPL(torture_must_stop_irq);