include/linux/torture.h

   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 VERBOSE_TOROUT_ERRSTRING(s) \
  42 do {                                                                            \
  43         if (verbose) {                                                          \
  44                 verbose_torout_sleep();                                         \
  45                 pr_alert("%s" TORTURE_FLAG "!!! %s\n", torture_type, s);        \
  46         }                                                                       \
  47 } while (0)
  48 void verbose_torout_sleep(void);
  49
  50 /* Definitions for online/offline exerciser. */
  51 #ifdef CONFIG_HOTPLUG_CPU
  52 int torture_num_online_cpus(void);
  53 #else /* #ifdef CONFIG_HOTPLUG_CPU */
  54 static inline int torture_num_online_cpus(void) { return 1; }
  55 #endif /* #else #ifdef CONFIG_HOTPLUG_CPU */
  56 typedef void torture_ofl_func(void);
  57 bool torture_offline(int cpu, long *n_onl_attempts, long *n_onl_successes,
  58                      unsigned long *sum_offl, int *min_onl, int *max_onl);
  59 bool torture_online(int cpu, long *n_onl_attempts, long *n_onl_successes,
  60                     unsigned long *sum_onl, int *min_onl, int *max_onl);
  61 int torture_onoff_init(long ooholdoff, long oointerval, torture_ofl_func *f);
  62 void torture_onoff_stats(void);
  63 bool torture_onoff_failures(void);
  64
  65 /* Low-rider random number generator. */
  66 struct torture_random_state {
  67         unsigned long trs_state;
  68         long trs_count;
  69 };
  70 #define DEFINE_TORTURE_RANDOM(name) struct torture_random_state name = { 0, 0 }
  71 #define DEFINE_TORTURE_RANDOM_PERCPU(name) \
  72         DEFINE_PER_CPU(struct torture_random_state, name)
  73 unsigned long torture_random(struct torture_random_state *trsp);
  74 static inline void torture_random_init(struct torture_random_state *trsp)
  75 {
  76         trsp->trs_state = 0;
  77         trsp->trs_count = 0;
  78 }
  79
  80 /* Definitions for high-resolution-timer sleeps. */
  81 int torture_hrtimeout_ns(ktime_t baset_ns, u32 fuzzt_ns, struct torture_random_state *trsp);
  82 int torture_hrtimeout_us(u32 baset_us, u32 fuzzt_ns, struct torture_random_state *trsp);
  83 int torture_hrtimeout_ms(u32 baset_ms, u32 fuzzt_us, struct torture_random_state *trsp);
  84 int torture_hrtimeout_jiffies(u32 baset_j, struct torture_random_state *trsp);
  85 int torture_hrtimeout_s(u32 baset_s, u32 fuzzt_ms, struct torture_random_state *trsp);
  86
  87 /* Task shuffler, which causes CPUs to occasionally go idle. */
  88 void torture_shuffle_task_register(struct task_struct *tp);
  89 int torture_shuffle_init(long shuffint);
  90
  91 /* Test auto-shutdown handling. */
  92 void torture_shutdown_absorb(const char *title);
  93 int torture_shutdown_init(int ssecs, void (*cleanup)(void));
  94
  95 /* Task stuttering, which forces load/no-load transitions. */
  96 bool stutter_wait(const char *title);
  97 int torture_stutter_init(int s, int sgap);
  98
  99 /* Initialization and cleanup. */
 100 bool torture_init_begin(char *ttype, int v);
 101 void torture_init_end(void);
 102 bool torture_cleanup_begin(void);
 103 void torture_cleanup_end(void);
 104 bool torture_must_stop(void);
 105 bool torture_must_stop_irq(void);
 106 void torture_kthread_stopping(char *title);
 107 int _torture_create_kthread(int (*fn)(void *arg), void *arg, char *s, char *m,
 108                              char *f, struct task_struct **tp);
 109 void _torture_stop_kthread(char *m, struct task_struct **tp);
 110
 111 #define torture_create_kthread(n, arg, tp) \
 112         _torture_create_kthread(n, (arg), #n, "Creating " #n " task", \
 113                                 "Failed to create " #n, &(tp))
 114 #define torture_stop_kthread(n, tp) \
 115         _torture_stop_kthread("Stopping " #n " task", &(tp))
 116
 117 #ifdef CONFIG_PREEMPTION
 118 #define torture_preempt_schedule() preempt_schedule()
 119 #else
 120 #define torture_preempt_schedule()      do { } while (0)
 121 #endif
 122
 123 #endif /* __LINUX_TORTURE_H */