blob: 7c13f5558b71939348ae3dca2d866b3fb83c490d [file] [log] [blame]
Paul E. McKenney8f8e76c2019-01-17 10:41:31 -08001// SPDX-License-Identifier: GPL-2.0+
Paul E. McKenney51b11302014-01-27 11:49:39 -08002/*
3 * Common functions for in-kernel torture tests.
4 *
Paul E. McKenney51b11302014-01-27 11:49:39 -08005 * Copyright (C) IBM Corporation, 2014
6 *
Paul E. McKenney8f8e76c2019-01-17 10:41:31 -08007 * Author: Paul E. McKenney <paulmck@linux.ibm.com>
Paul E. McKenney51b11302014-01-27 11:49:39 -08008 * Based on kernel/rcu/torture.c.
9 */
Paul E. McKenney60500032018-05-15 12:25:05 -070010
11#define pr_fmt(fmt) fmt
12
Paul E. McKenney51b11302014-01-27 11:49:39 -080013#include <linux/types.h>
14#include <linux/kernel.h>
15#include <linux/init.h>
16#include <linux/module.h>
17#include <linux/kthread.h>
18#include <linux/err.h>
19#include <linux/spinlock.h>
20#include <linux/smp.h>
21#include <linux/interrupt.h>
22#include <linux/sched.h>
Ingo Molnare6017572017-02-01 16:36:40 +010023#include <linux/sched/clock.h>
Paul E. McKenney51b11302014-01-27 11:49:39 -080024#include <linux/atomic.h>
25#include <linux/bitops.h>
26#include <linux/completion.h>
27#include <linux/moduleparam.h>
28#include <linux/percpu.h>
29#include <linux/notifier.h>
30#include <linux/reboot.h>
31#include <linux/freezer.h>
32#include <linux/cpu.h>
33#include <linux/delay.h>
34#include <linux/stat.h>
35#include <linux/slab.h>
36#include <linux/trace_clock.h>
Paul E. McKenney31257c32016-06-18 07:45:43 -070037#include <linux/ktime.h>
Paul E. McKenney51b11302014-01-27 11:49:39 -080038#include <asm/byteorder.h>
39#include <linux/torture.h>
Paul E. McKenneydac95902017-10-04 11:23:10 -070040#include "rcu/rcu.h"
Paul E. McKenney51b11302014-01-27 11:49:39 -080041
42MODULE_LICENSE("GPL");
Paul E. McKenney8f8e76c2019-01-17 10:41:31 -080043MODULE_AUTHOR("Paul E. McKenney <paulmck@linux.ibm.com>");
Paul E. McKenney51b11302014-01-27 11:49:39 -080044
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -080045static char *torture_type;
Paul E. McKenney90127d62018-05-09 10:29:18 -070046static int verbose;
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -080047
Paul E. McKenney36970bb2014-01-30 15:49:29 -080048/* Mediate rmmod and system shutdown. Concurrent rmmod & shutdown illegal! */
49#define FULLSTOP_DONTSTOP 0 /* Normal operation. */
50#define FULLSTOP_SHUTDOWN 1 /* System shutdown with torture running. */
51#define FULLSTOP_RMMOD 2 /* Normal rmmod of torture. */
52static int fullstop = FULLSTOP_RMMOD;
Paul E. McKenney4622b482014-01-30 15:37:19 -080053static DEFINE_MUTEX(fullstop_mutex);
Paul E. McKenneyf67a3352014-01-29 07:40:27 -080054
Paul E. McKenney2e9e8082014-01-28 15:58:22 -080055#ifdef CONFIG_HOTPLUG_CPU
56
57/*
58 * Variables for online-offline handling. Only present if CPU hotplug
59 * is enabled, otherwise does nothing.
60 */
61
62static struct task_struct *onoff_task;
63static long onoff_holdoff;
64static long onoff_interval;
Paul E. McKenney3a6cb582018-12-10 09:44:52 -080065static torture_ofl_func *onoff_f;
Paul E. McKenney2e9e8082014-01-28 15:58:22 -080066static long n_offline_attempts;
67static long n_offline_successes;
68static unsigned long sum_offline;
69static int min_offline = -1;
70static int max_offline;
71static long n_online_attempts;
72static long n_online_successes;
73static unsigned long sum_online;
74static int min_online = -1;
75static int max_online;
76
77/*
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -070078 * Attempt to take a CPU offline. Return false if the CPU is already
79 * offline or if it is not subject to CPU-hotplug operations. The
80 * caller can detect other failures by looking at the statistics.
81 */
82bool torture_offline(int cpu, long *n_offl_attempts, long *n_offl_successes,
83 unsigned long *sum_offl, int *min_offl, int *max_offl)
84{
85 unsigned long delta;
86 int ret;
87 unsigned long starttime;
88
89 if (!cpu_online(cpu) || !cpu_is_hotpluggable(cpu))
90 return false;
Paul E. McKenney24aca4a2019-01-22 19:23:00 -080091 if (num_online_cpus() <= 1)
92 return false; /* Can't offline the last CPU. */
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -070093
Paul E. McKenney90127d62018-05-09 10:29:18 -070094 if (verbose > 1)
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -070095 pr_alert("%s" TORTURE_FLAG
96 "torture_onoff task: offlining %d\n",
97 torture_type, cpu);
98 starttime = jiffies;
99 (*n_offl_attempts)++;
100 ret = cpu_down(cpu);
101 if (ret) {
102 if (verbose)
103 pr_alert("%s" TORTURE_FLAG
104 "torture_onoff task: offline %d failed: errno %d\n",
105 torture_type, cpu, ret);
106 } else {
Paul E. McKenney90127d62018-05-09 10:29:18 -0700107 if (verbose > 1)
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -0700108 pr_alert("%s" TORTURE_FLAG
109 "torture_onoff task: offlined %d\n",
110 torture_type, cpu);
Paul E. McKenney3a6cb582018-12-10 09:44:52 -0800111 if (onoff_f)
112 onoff_f();
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -0700113 (*n_offl_successes)++;
114 delta = jiffies - starttime;
Paul E. McKenneya2b2df22017-06-22 15:38:26 -0700115 *sum_offl += delta;
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -0700116 if (*min_offl < 0) {
117 *min_offl = delta;
118 *max_offl = delta;
119 }
120 if (*min_offl > delta)
121 *min_offl = delta;
122 if (*max_offl < delta)
123 *max_offl = delta;
124 }
125
126 return true;
127}
128EXPORT_SYMBOL_GPL(torture_offline);
129
130/*
131 * Attempt to bring a CPU online. Return false if the CPU is already
132 * online or if it is not subject to CPU-hotplug operations. The
133 * caller can detect other failures by looking at the statistics.
134 */
135bool torture_online(int cpu, long *n_onl_attempts, long *n_onl_successes,
136 unsigned long *sum_onl, int *min_onl, int *max_onl)
137{
138 unsigned long delta;
139 int ret;
140 unsigned long starttime;
141
142 if (cpu_online(cpu) || !cpu_is_hotpluggable(cpu))
143 return false;
144
Paul E. McKenney90127d62018-05-09 10:29:18 -0700145 if (verbose > 1)
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -0700146 pr_alert("%s" TORTURE_FLAG
147 "torture_onoff task: onlining %d\n",
148 torture_type, cpu);
149 starttime = jiffies;
150 (*n_onl_attempts)++;
151 ret = cpu_up(cpu);
152 if (ret) {
153 if (verbose)
154 pr_alert("%s" TORTURE_FLAG
155 "torture_onoff task: online %d failed: errno %d\n",
156 torture_type, cpu, ret);
157 } else {
Paul E. McKenney90127d62018-05-09 10:29:18 -0700158 if (verbose > 1)
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -0700159 pr_alert("%s" TORTURE_FLAG
160 "torture_onoff task: onlined %d\n",
161 torture_type, cpu);
162 (*n_onl_successes)++;
163 delta = jiffies - starttime;
164 *sum_onl += delta;
165 if (*min_onl < 0) {
166 *min_onl = delta;
167 *max_onl = delta;
168 }
169 if (*min_onl > delta)
170 *min_onl = delta;
171 if (*max_onl < delta)
172 *max_onl = delta;
173 }
174
175 return true;
176}
177EXPORT_SYMBOL_GPL(torture_online);
178
179/*
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800180 * Execute random CPU-hotplug operations at the interval specified
181 * by the onoff_interval.
182 */
183static int
184torture_onoff(void *arg)
185{
186 int cpu;
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800187 int maxcpu = -1;
188 DEFINE_TORTURE_RANDOM(rand);
Paul E. McKenney28cf5952018-08-21 15:27:16 -0700189 int ret;
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800190
191 VERBOSE_TOROUT_STRING("torture_onoff task started");
192 for_each_online_cpu(cpu)
193 maxcpu = cpu;
194 WARN_ON(maxcpu < 0);
Paul E. McKenney28cf5952018-08-21 15:27:16 -0700195 if (!IS_MODULE(CONFIG_TORTURE_TEST))
196 for_each_possible_cpu(cpu) {
197 if (cpu_online(cpu))
198 continue;
199 ret = cpu_up(cpu);
200 if (ret && verbose) {
201 pr_alert("%s" TORTURE_FLAG
202 "%s: Initial online %d: errno %d\n",
203 __func__, torture_type, cpu, ret);
204 }
205 }
Boqun Feng750db0f2016-05-02 10:30:00 +0800206
207 if (maxcpu == 0) {
208 VERBOSE_TOROUT_STRING("Only one CPU, so CPU-hotplug testing is disabled");
209 goto stop;
210 }
211
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800212 if (onoff_holdoff > 0) {
213 VERBOSE_TOROUT_STRING("torture_onoff begin holdoff");
214 schedule_timeout_interruptible(onoff_holdoff);
215 VERBOSE_TOROUT_STRING("torture_onoff end holdoff");
216 }
217 while (!torture_must_stop()) {
218 cpu = (torture_random(&rand) >> 4) % (maxcpu + 1);
Paul E. McKenneyd95f5ba2016-04-20 17:18:41 -0700219 if (!torture_offline(cpu,
220 &n_offline_attempts, &n_offline_successes,
221 &sum_offline, &min_offline, &max_offline))
222 torture_online(cpu,
223 &n_online_attempts, &n_online_successes,
224 &sum_online, &min_online, &max_online);
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800225 schedule_timeout_interruptible(onoff_interval);
226 }
Boqun Feng750db0f2016-05-02 10:30:00 +0800227
228stop:
Paul E. McKenney7fafaac2014-01-31 17:37:28 -0800229 torture_kthread_stopping("torture_onoff");
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800230 return 0;
231}
232
233#endif /* #ifdef CONFIG_HOTPLUG_CPU */
234
235/*
236 * Initiate online-offline handling.
237 */
Paul E. McKenney3a6cb582018-12-10 09:44:52 -0800238int torture_onoff_init(long ooholdoff, long oointerval, torture_ofl_func *f)
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800239{
Paul E. McKenney47cf29b2014-02-03 11:52:27 -0800240#ifdef CONFIG_HOTPLUG_CPU
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800241 onoff_holdoff = ooholdoff;
242 onoff_interval = oointerval;
Paul E. McKenney3a6cb582018-12-10 09:44:52 -0800243 onoff_f = f;
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800244 if (onoff_interval <= 0)
245 return 0;
Pierce Griffiths2a7d9682018-09-21 20:21:31 -0500246 return torture_create_kthread(torture_onoff, NULL, onoff_task);
247#else /* #ifdef CONFIG_HOTPLUG_CPU */
248 return 0;
249#endif /* #else #ifdef CONFIG_HOTPLUG_CPU */
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800250}
251EXPORT_SYMBOL_GPL(torture_onoff_init);
252
253/*
254 * Clean up after online/offline testing.
255 */
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800256static void torture_onoff_cleanup(void)
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800257{
258#ifdef CONFIG_HOTPLUG_CPU
259 if (onoff_task == NULL)
260 return;
261 VERBOSE_TOROUT_STRING("Stopping torture_onoff task");
262 kthread_stop(onoff_task);
263 onoff_task = NULL;
264#endif /* #ifdef CONFIG_HOTPLUG_CPU */
265}
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800266
267/*
268 * Print online/offline testing statistics.
269 */
Joe Percheseea203f2014-07-14 09:16:15 -0400270void torture_onoff_stats(void)
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800271{
272#ifdef CONFIG_HOTPLUG_CPU
Joe Percheseea203f2014-07-14 09:16:15 -0400273 pr_cont("onoff: %ld/%ld:%ld/%ld %d,%d:%d,%d %lu:%lu (HZ=%d) ",
274 n_online_successes, n_online_attempts,
275 n_offline_successes, n_offline_attempts,
276 min_online, max_online,
277 min_offline, max_offline,
278 sum_online, sum_offline, HZ);
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800279#endif /* #ifdef CONFIG_HOTPLUG_CPU */
Paul E. McKenney2e9e8082014-01-28 15:58:22 -0800280}
281EXPORT_SYMBOL_GPL(torture_onoff_stats);
282
283/*
284 * Were all the online/offline operations successful?
285 */
286bool torture_onoff_failures(void)
287{
288#ifdef CONFIG_HOTPLUG_CPU
289 return n_online_successes != n_online_attempts ||
290 n_offline_successes != n_offline_attempts;
291#else /* #ifdef CONFIG_HOTPLUG_CPU */
292 return false;
293#endif /* #else #ifdef CONFIG_HOTPLUG_CPU */
294}
295EXPORT_SYMBOL_GPL(torture_onoff_failures);
296
Paul E. McKenney51b11302014-01-27 11:49:39 -0800297#define TORTURE_RANDOM_MULT 39916801 /* prime */
298#define TORTURE_RANDOM_ADD 479001701 /* prime */
299#define TORTURE_RANDOM_REFRESH 10000
300
301/*
302 * Crude but fast random-number generator. Uses a linear congruential
303 * generator, with occasional help from cpu_clock().
304 */
305unsigned long
306torture_random(struct torture_random_state *trsp)
307{
308 if (--trsp->trs_count < 0) {
309 trsp->trs_state += (unsigned long)local_clock();
310 trsp->trs_count = TORTURE_RANDOM_REFRESH;
311 }
312 trsp->trs_state = trsp->trs_state * TORTURE_RANDOM_MULT +
313 TORTURE_RANDOM_ADD;
314 return swahw32(trsp->trs_state);
315}
316EXPORT_SYMBOL_GPL(torture_random);
Paul E. McKenneyf67a3352014-01-29 07:40:27 -0800317
318/*
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800319 * Variables for shuffling. The idea is to ensure that each CPU stays
320 * idle for an extended period to test interactions with dyntick idle,
Masahiro Yamadab564d622017-02-27 14:29:06 -0800321 * as well as interactions with any per-CPU variables.
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800322 */
323struct shuffle_task {
324 struct list_head st_l;
325 struct task_struct *st_t;
326};
327
328static long shuffle_interval; /* In jiffies. */
329static struct task_struct *shuffler_task;
330static cpumask_var_t shuffle_tmp_mask;
331static int shuffle_idle_cpu; /* Force all torture tasks off this CPU */
332static struct list_head shuffle_task_list = LIST_HEAD_INIT(shuffle_task_list);
333static DEFINE_MUTEX(shuffle_task_mutex);
334
335/*
336 * Register a task to be shuffled. If there is no memory, just splat
337 * and don't bother registering.
338 */
339void torture_shuffle_task_register(struct task_struct *tp)
340{
341 struct shuffle_task *stp;
342
343 if (WARN_ON_ONCE(tp == NULL))
344 return;
345 stp = kmalloc(sizeof(*stp), GFP_KERNEL);
346 if (WARN_ON_ONCE(stp == NULL))
347 return;
348 stp->st_t = tp;
349 mutex_lock(&shuffle_task_mutex);
350 list_add(&stp->st_l, &shuffle_task_list);
351 mutex_unlock(&shuffle_task_mutex);
352}
353EXPORT_SYMBOL_GPL(torture_shuffle_task_register);
354
355/*
356 * Unregister all tasks, for example, at the end of the torture run.
357 */
358static void torture_shuffle_task_unregister_all(void)
359{
360 struct shuffle_task *stp;
361 struct shuffle_task *p;
362
363 mutex_lock(&shuffle_task_mutex);
364 list_for_each_entry_safe(stp, p, &shuffle_task_list, st_l) {
365 list_del(&stp->st_l);
366 kfree(stp);
367 }
368 mutex_unlock(&shuffle_task_mutex);
369}
370
371/* Shuffle tasks such that we allow shuffle_idle_cpu to become idle.
372 * A special case is when shuffle_idle_cpu = -1, in which case we allow
373 * the tasks to run on all CPUs.
374 */
375static void torture_shuffle_tasks(void)
376{
377 struct shuffle_task *stp;
378
379 cpumask_setall(shuffle_tmp_mask);
380 get_online_cpus();
381
382 /* No point in shuffling if there is only one online CPU (ex: UP) */
383 if (num_online_cpus() == 1) {
384 put_online_cpus();
385 return;
386 }
387
388 /* Advance to the next CPU. Upon overflow, don't idle any CPUs. */
389 shuffle_idle_cpu = cpumask_next(shuffle_idle_cpu, shuffle_tmp_mask);
390 if (shuffle_idle_cpu >= nr_cpu_ids)
391 shuffle_idle_cpu = -1;
Iulia Manda5ed63b12014-03-17 15:21:21 +0200392 else
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800393 cpumask_clear_cpu(shuffle_idle_cpu, shuffle_tmp_mask);
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800394
395 mutex_lock(&shuffle_task_mutex);
396 list_for_each_entry(stp, &shuffle_task_list, st_l)
397 set_cpus_allowed_ptr(stp->st_t, shuffle_tmp_mask);
398 mutex_unlock(&shuffle_task_mutex);
399
400 put_online_cpus();
401}
402
403/* Shuffle tasks across CPUs, with the intent of allowing each CPU in the
404 * system to become idle at a time and cut off its timer ticks. This is meant
405 * to test the support for such tickless idle CPU in RCU.
406 */
407static int torture_shuffle(void *arg)
408{
409 VERBOSE_TOROUT_STRING("torture_shuffle task started");
410 do {
411 schedule_timeout_interruptible(shuffle_interval);
412 torture_shuffle_tasks();
413 torture_shutdown_absorb("torture_shuffle");
414 } while (!torture_must_stop());
Paul E. McKenney7fafaac2014-01-31 17:37:28 -0800415 torture_kthread_stopping("torture_shuffle");
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800416 return 0;
417}
418
419/*
420 * Start the shuffler, with shuffint in jiffies.
421 */
422int torture_shuffle_init(long shuffint)
423{
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800424 shuffle_interval = shuffint;
425
426 shuffle_idle_cpu = -1;
427
428 if (!alloc_cpumask_var(&shuffle_tmp_mask, GFP_KERNEL)) {
429 VERBOSE_TOROUT_ERRSTRING("Failed to alloc mask");
430 return -ENOMEM;
431 }
432
433 /* Create the shuffler thread */
Paul E. McKenney47cf29b2014-02-03 11:52:27 -0800434 return torture_create_kthread(torture_shuffle, NULL, shuffler_task);
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800435}
436EXPORT_SYMBOL_GPL(torture_shuffle_init);
437
438/*
439 * Stop the shuffling.
440 */
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800441static void torture_shuffle_cleanup(void)
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800442{
443 torture_shuffle_task_unregister_all();
444 if (shuffler_task) {
445 VERBOSE_TOROUT_STRING("Stopping torture_shuffle task");
446 kthread_stop(shuffler_task);
447 free_cpumask_var(shuffle_tmp_mask);
448 }
449 shuffler_task = NULL;
450}
Paul E. McKenney3808dc92014-01-28 15:29:21 -0800451
452/*
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800453 * Variables for auto-shutdown. This allows "lights out" torture runs
454 * to be fully scripted.
455 */
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800456static struct task_struct *shutdown_task;
Paul E. McKenney31257c32016-06-18 07:45:43 -0700457static ktime_t shutdown_time; /* time to system shutdown. */
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800458static void (*torture_shutdown_hook)(void);
459
460/*
Paul E. McKenneyf67a3352014-01-29 07:40:27 -0800461 * Absorb kthreads into a kernel function that won't return, so that
462 * they won't ever access module text or data again.
463 */
464void torture_shutdown_absorb(const char *title)
465{
Paul E. McKenney7d0ae802015-03-03 14:57:58 -0800466 while (READ_ONCE(fullstop) == FULLSTOP_SHUTDOWN) {
Paul E. McKenney4622b482014-01-30 15:37:19 -0800467 pr_notice("torture thread %s parking due to system shutdown\n",
468 title);
Paul E. McKenneyf67a3352014-01-29 07:40:27 -0800469 schedule_timeout_uninterruptible(MAX_SCHEDULE_TIMEOUT);
470 }
471}
472EXPORT_SYMBOL_GPL(torture_shutdown_absorb);
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800473
474/*
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800475 * Cause the torture test to shutdown the system after the test has
476 * run for the time specified by the shutdown_secs parameter.
477 */
478static int torture_shutdown(void *arg)
479{
Paul E. McKenney31257c32016-06-18 07:45:43 -0700480 ktime_t ktime_snap;
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800481
482 VERBOSE_TOROUT_STRING("torture_shutdown task started");
Paul E. McKenney31257c32016-06-18 07:45:43 -0700483 ktime_snap = ktime_get();
484 while (ktime_before(ktime_snap, shutdown_time) &&
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800485 !torture_must_stop()) {
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800486 if (verbose)
487 pr_alert("%s" TORTURE_FLAG
Paul E. McKenney31257c32016-06-18 07:45:43 -0700488 "torture_shutdown task: %llu ms remaining\n",
489 torture_type,
490 ktime_ms_delta(shutdown_time, ktime_snap));
491 set_current_state(TASK_INTERRUPTIBLE);
492 schedule_hrtimeout(&shutdown_time, HRTIMER_MODE_ABS);
493 ktime_snap = ktime_get();
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800494 }
495 if (torture_must_stop()) {
Paul E. McKenney7fafaac2014-01-31 17:37:28 -0800496 torture_kthread_stopping("torture_shutdown");
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800497 return 0;
498 }
499
500 /* OK, shut down the system. */
501
502 VERBOSE_TOROUT_STRING("torture_shutdown task shutting down system");
503 shutdown_task = NULL; /* Avoid self-kill deadlock. */
Paul E. McKenneyf8818252014-02-07 14:42:51 -0800504 if (torture_shutdown_hook)
505 torture_shutdown_hook();
506 else
507 VERBOSE_TOROUT_STRING("No torture_shutdown_hook(), skipping.");
Paul E. McKenneydac95902017-10-04 11:23:10 -0700508 rcu_ftrace_dump(DUMP_ALL);
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800509 kernel_power_off(); /* Shut down the system. */
510 return 0;
511}
512
513/*
514 * Start up the shutdown task.
515 */
516int torture_shutdown_init(int ssecs, void (*cleanup)(void))
517{
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800518 torture_shutdown_hook = cleanup;
Paul E. McKenney31257c32016-06-18 07:45:43 -0700519 if (ssecs > 0) {
520 shutdown_time = ktime_add(ktime_get(), ktime_set(ssecs, 0));
Pierce Griffiths2a7d9682018-09-21 20:21:31 -0500521 return torture_create_kthread(torture_shutdown, NULL,
Paul E. McKenney47cf29b2014-02-03 11:52:27 -0800522 shutdown_task);
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800523 }
Pierce Griffiths2a7d9682018-09-21 20:21:31 -0500524 return 0;
Paul E. McKenneye991dbc2014-01-31 14:52:13 -0800525}
526EXPORT_SYMBOL_GPL(torture_shutdown_init);
527
528/*
Paul E. McKenney4622b482014-01-30 15:37:19 -0800529 * 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);
Paul E. McKenney7d0ae802015-03-03 14:57:58 -0800535 if (READ_ONCE(fullstop) == FULLSTOP_DONTSTOP) {
Paul E. McKenneyfac480e2014-01-30 17:06:30 -0800536 VERBOSE_TOROUT_STRING("Unscheduled system shutdown detected");
Paul E. McKenney7d0ae802015-03-03 14:57:58 -0800537 WRITE_ONCE(fullstop, FULLSTOP_SHUTDOWN);
Paul E. McKenneyfac480e2014-01-30 17:06:30 -0800538 } else {
Paul E. McKenney4622b482014-01-30 15:37:19 -0800539 pr_warn("Concurrent rmmod and shutdown illegal!\n");
Paul E. McKenneyfac480e2014-01-30 17:06:30 -0800540 }
Paul E. McKenney4622b482014-01-30 15:37:19 -0800541 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
549/*
Paul E. McKenneybfefc732014-02-04 12:35:27 -0800550 * 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
563/*
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800564 * 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;
Paul E. McKenneyff3bf922019-04-09 14:44:49 -0700571static int stutter_gap;
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800572
573/*
574 * Block until the stutter interval ends. This must be called periodically
575 * by all running kthreads that need to be subject to stuttering.
576 */
Paul E. McKenney474e59b2018-08-07 14:34:44 -0700577bool stutter_wait(const char *title)
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800578{
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800579 int spt;
Paul E. McKenneye8516c62019-04-09 11:06:32 -0700580 bool ret = false;
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800581
Paul E. McKenneycee43932018-03-02 16:35:27 -0800582 cond_resched_tasks_rcu_qs();
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800583 spt = READ_ONCE(stutter_pause_test);
Paul E. McKenney29d39392017-11-21 22:07:59 -0800584 for (; spt; spt = READ_ONCE(stutter_pause_test)) {
Paul E. McKenneye8516c62019-04-09 11:06:32 -0700585 ret = true;
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800586 if (spt == 1) {
587 schedule_timeout_interruptible(1);
588 } else if (spt == 2) {
589 while (READ_ONCE(stutter_pause_test))
590 cond_resched();
591 } else {
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800592 schedule_timeout_interruptible(round_jiffies_relative(HZ));
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800593 }
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800594 torture_shutdown_absorb(title);
595 }
Paul E. McKenneye8516c62019-04-09 11:06:32 -0700596 return ret;
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800597}
598EXPORT_SYMBOL_GPL(stutter_wait);
599
600/*
601 * Cause the torture test to "stutter", starting and stopping all
602 * threads periodically.
603 */
604static int torture_stutter(void *arg)
605{
Paul E. McKenneye8516c62019-04-09 11:06:32 -0700606 int wtime;
607
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800608 VERBOSE_TOROUT_STRING("torture_stutter task started");
609 do {
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800610 if (!torture_must_stop() && stutter > 1) {
Paul E. McKenneye8516c62019-04-09 11:06:32 -0700611 wtime = stutter;
612 if (stutter > HZ + 1) {
613 WRITE_ONCE(stutter_pause_test, 1);
614 wtime = stutter - HZ - 1;
615 schedule_timeout_interruptible(wtime);
616 wtime = HZ + 1;
617 }
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800618 WRITE_ONCE(stutter_pause_test, 2);
Paul E. McKenneye8516c62019-04-09 11:06:32 -0700619 schedule_timeout_interruptible(wtime);
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800620 }
Paul E. McKenney4ced3312017-11-21 15:01:02 -0800621 WRITE_ONCE(stutter_pause_test, 0);
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800622 if (!torture_must_stop())
Paul E. McKenneyff3bf922019-04-09 14:44:49 -0700623 schedule_timeout_interruptible(stutter_gap);
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800624 torture_shutdown_absorb("torture_stutter");
625 } while (!torture_must_stop());
Paul E. McKenney7fafaac2014-01-31 17:37:28 -0800626 torture_kthread_stopping("torture_stutter");
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800627 return 0;
628}
629
630/*
631 * Initialize and kick off the torture_stutter kthread.
632 */
Paul E. McKenneyff3bf922019-04-09 14:44:49 -0700633int torture_stutter_init(const int s, const int sgap)
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800634{
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800635 stutter = s;
Paul E. McKenneyff3bf922019-04-09 14:44:49 -0700636 stutter_gap = sgap;
Pierce Griffiths2a7d9682018-09-21 20:21:31 -0500637 return torture_create_kthread(torture_stutter, NULL, stutter_task);
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800638}
639EXPORT_SYMBOL_GPL(torture_stutter_init);
640
641/*
642 * Cleanup after the torture_stutter kthread.
643 */
Paul E. McKenneybfefc732014-02-04 12:35:27 -0800644static void torture_stutter_cleanup(void)
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800645{
646 if (!stutter_task)
647 return;
648 VERBOSE_TOROUT_STRING("Stopping torture_stutter task");
649 kthread_stop(stutter_task);
650 stutter_task = NULL;
651}
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800652
653/*
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800654 * Initialize torture module. Please note that this is -not- invoked via
655 * the usual module_init() mechanism, but rather by an explicit call from
656 * the client torture module. This call must be paired with a later
657 * torture_init_end().
Paul E. McKenney628edaa2014-01-31 11:57:43 -0800658 *
659 * The runnable parameter points to a flag that controls whether or not
660 * the test is currently runnable. If there is no such flag, pass in NULL.
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800661 */
Paul E. McKenney90127d62018-05-09 10:29:18 -0700662bool torture_init_begin(char *ttype, int v)
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800663{
664 mutex_lock(&fullstop_mutex);
Paul E. McKenney52280842014-04-07 09:14:11 -0700665 if (torture_type != NULL) {
Paul E. McKenney9eb51882016-03-21 15:36:40 -0700666 pr_alert("torture_init_begin: Refusing %s init: %s running.\n",
Paul E. McKenney52280842014-04-07 09:14:11 -0700667 ttype, torture_type);
Paul E. McKenney9eb51882016-03-21 15:36:40 -0700668 pr_alert("torture_init_begin: One torture test at a time!\n");
Paul E. McKenney52280842014-04-07 09:14:11 -0700669 mutex_unlock(&fullstop_mutex);
670 return false;
671 }
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800672 torture_type = ttype;
673 verbose = v;
Paul E. McKenney36970bb2014-01-30 15:49:29 -0800674 fullstop = FULLSTOP_DONTSTOP;
Paul E. McKenney52280842014-04-07 09:14:11 -0700675 return true;
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800676}
677EXPORT_SYMBOL_GPL(torture_init_begin);
678
679/*
680 * Tell the torture module that initialization is complete.
681 */
Pranith Kumar2b3f8ff2014-04-16 13:42:09 -0700682void torture_init_end(void)
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800683{
684 mutex_unlock(&fullstop_mutex);
Paul E. McKenney4622b482014-01-30 15:37:19 -0800685 register_reboot_notifier(&torture_shutdown_nb);
Paul E. McKenneyb5daa8f2014-01-30 13:38:09 -0800686}
687EXPORT_SYMBOL_GPL(torture_init_end);
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800688
689/*
690 * Clean up torture module. Please note that this is -not- invoked via
691 * the usual module_exit() mechanism, but rather by an explicit call from
692 * the client torture module. Returns true if a race with system shutdown
Paul E. McKenneybfefc732014-02-04 12:35:27 -0800693 * is detected, otherwise, all kthreads started by functions in this file
694 * will be shut down.
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800695 *
696 * This must be called before the caller starts shutting down its own
697 * kthreads.
Davidlohr Buesod36a7a02014-09-11 20:40:21 -0700698 *
699 * Both torture_cleanup_begin() and torture_cleanup_end() must be paired,
700 * in order to correctly perform the cleanup. They are separated because
701 * threads can still need to reference the torture_type type, thus nullify
702 * only after completing all other relevant calls.
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800703 */
Davidlohr Buesod36a7a02014-09-11 20:40:21 -0700704bool torture_cleanup_begin(void)
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800705{
706 mutex_lock(&fullstop_mutex);
Paul E. McKenney7d0ae802015-03-03 14:57:58 -0800707 if (READ_ONCE(fullstop) == FULLSTOP_SHUTDOWN) {
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800708 pr_warn("Concurrent rmmod and shutdown illegal!\n");
709 mutex_unlock(&fullstop_mutex);
710 schedule_timeout_uninterruptible(10);
711 return true;
712 }
Paul E. McKenney7d0ae802015-03-03 14:57:58 -0800713 WRITE_ONCE(fullstop, FULLSTOP_RMMOD);
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800714 mutex_unlock(&fullstop_mutex);
Paul E. McKenneybfefc732014-02-04 12:35:27 -0800715 torture_shutdown_cleanup();
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800716 torture_shuffle_cleanup();
Paul E. McKenneybfefc732014-02-04 12:35:27 -0800717 torture_stutter_cleanup();
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800718 torture_onoff_cleanup();
Davidlohr Buesod36a7a02014-09-11 20:40:21 -0700719 return false;
720}
721EXPORT_SYMBOL_GPL(torture_cleanup_begin);
722
723void torture_cleanup_end(void)
724{
Paul E. McKenney52280842014-04-07 09:14:11 -0700725 mutex_lock(&fullstop_mutex);
726 torture_type = NULL;
727 mutex_unlock(&fullstop_mutex);
Paul E. McKenneycc47ae02014-01-30 14:21:11 -0800728}
Davidlohr Buesod36a7a02014-09-11 20:40:21 -0700729EXPORT_SYMBOL_GPL(torture_cleanup_end);
Paul E. McKenney36970bb2014-01-30 15:49:29 -0800730
731/*
732 * Is it time for the current torture test to stop?
733 */
734bool torture_must_stop(void)
735{
736 return torture_must_stop_irq() || kthread_should_stop();
737}
738EXPORT_SYMBOL_GPL(torture_must_stop);
739
740/*
741 * Is it time for the current torture test to stop? This is the irq-safe
742 * version, hence no check for kthread_should_stop().
743 */
744bool torture_must_stop_irq(void)
745{
Paul E. McKenney7d0ae802015-03-03 14:57:58 -0800746 return READ_ONCE(fullstop) != FULLSTOP_DONTSTOP;
Paul E. McKenney36970bb2014-01-30 15:49:29 -0800747}
748EXPORT_SYMBOL_GPL(torture_must_stop_irq);
Paul E. McKenney7fafaac2014-01-31 17:37:28 -0800749
750/*
751 * Each kthread must wait for kthread_should_stop() before returning from
752 * its top-level function, otherwise segfaults ensue. This function
753 * prints a "stopping" message and waits for kthread_should_stop(), and
754 * should be called from all torture kthreads immediately prior to
755 * returning.
756 */
757void torture_kthread_stopping(char *title)
758{
Paul E. McKenney0d6821d2014-03-03 16:58:03 -0800759 char buf[128];
760
761 snprintf(buf, sizeof(buf), "Stopping %s", title);
762 VERBOSE_TOROUT_STRING(buf);
Paul E. McKenney7fafaac2014-01-31 17:37:28 -0800763 while (!kthread_should_stop()) {
764 torture_shutdown_absorb(title);
765 schedule_timeout_uninterruptible(1);
766 }
767}
768EXPORT_SYMBOL_GPL(torture_kthread_stopping);
Paul E. McKenney47cf29b2014-02-03 11:52:27 -0800769
770/*
771 * Create a generic torture kthread that is immediately runnable. If you
772 * need the kthread to be stopped so that you can do something to it before
773 * it starts, you will need to open-code your own.
774 */
775int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m,
776 char *f, struct task_struct **tp)
777{
778 int ret = 0;
779
780 VERBOSE_TOROUT_STRING(m);
Kees Cook69459152014-05-22 11:51:04 -0700781 *tp = kthread_run(fn, arg, "%s", s);
Paul E. McKenney47cf29b2014-02-03 11:52:27 -0800782 if (IS_ERR(*tp)) {
783 ret = PTR_ERR(*tp);
784 VERBOSE_TOROUT_ERRSTRING(f);
785 *tp = NULL;
786 }
787 torture_shuffle_task_register(*tp);
788 return ret;
789}
790EXPORT_SYMBOL_GPL(_torture_create_kthread);
Paul E. McKenney9c029b82014-02-04 11:47:08 -0800791
792/*
793 * Stop a generic kthread, emitting a message.
794 */
795void _torture_stop_kthread(char *m, struct task_struct **tp)
796{
797 if (*tp == NULL)
798 return;
799 VERBOSE_TOROUT_STRING(m);
800 kthread_stop(*tp);
801 *tp = NULL;
802}
803EXPORT_SYMBOL_GPL(_torture_stop_kthread);