diff mbox series

[1/3] rcutorture: Update rcutorture.fwd_progress help text

Message ID 20220620221757.3839212-1-paulmck@kernel.org (mailing list archive)
State Accepted
Commit cb506e130e02da24d98103d83b8de859e26d1860
Headers show
Series Documentation updates for v5.20 | expand

Commit Message

Paul E. McKenney June 20, 2022, 10:17 p.m. UTC
This commit updates the rcutorture.fwd_progress help text to say that
it is the number of forward-progress kthreads to spawn rather than the
old enable/disable functionality.  While in the area, make the list of
torture-test parameters easier to read by taking advantage of 100 columns.

Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
---
 kernel/rcu/rcutorture.c | 53 ++++++++++++++---------------------------
 1 file changed, 18 insertions(+), 35 deletions(-)

Comments

Neeraj Upadhyay June 21, 2022, 5:10 a.m. UTC | #1
On 6/21/2022 3:47 AM, Paul E. McKenney wrote:
> This commit updates the rcutorture.fwd_progress help text to say that
> it is the number of forward-progress kthreads to spawn rather than the
> old enable/disable functionality.  While in the area, make the list of
> torture-test parameters easier to read by taking advantage of 100 columns.
> 
> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
> ---

Reviewed-by: Neeraj Upadhyay <quic_neeraju@quicinc.com>

>   kernel/rcu/rcutorture.c | 53 ++++++++++++++---------------------------
>   1 file changed, 18 insertions(+), 35 deletions(-)
> 
> diff --git a/kernel/rcu/rcutorture.c b/kernel/rcu/rcutorture.c
> index 7120165a93426..6f47d1490c4f5 100644
> --- a/kernel/rcu/rcutorture.c
> +++ b/kernel/rcu/rcutorture.c
> @@ -75,62 +75,45 @@ MODULE_AUTHOR("Paul E. McKenney <paulmck@linux.ibm.com> and Josh Triplett <josh@
>   
>   torture_param(int, extendables, RCUTORTURE_MAX_EXTEND,
>   	      "Extend readers by disabling bh (1), irqs (2), or preempt (4)");
> -torture_param(int, fqs_duration, 0,
> -	      "Duration of fqs bursts (us), 0 to disable");
> +torture_param(int, fqs_duration, 0, "Duration of fqs bursts (us), 0 to disable");
>   torture_param(int, fqs_holdoff, 0, "Holdoff time within fqs bursts (us)");
>   torture_param(int, fqs_stutter, 3, "Wait time between fqs bursts (s)");
> -torture_param(int, fwd_progress, 1, "Test grace-period forward progress");
> +torture_param(int, fwd_progress, 1, "Number of grace-period forward progress tasks (0 to disable)");
>   torture_param(int, fwd_progress_div, 4, "Fraction of CPU stall to wait");
> -torture_param(int, fwd_progress_holdoff, 60,
> -	      "Time between forward-progress tests (s)");
> -torture_param(bool, fwd_progress_need_resched, 1,
> -	      "Hide cond_resched() behind need_resched()");
> +torture_param(int, fwd_progress_holdoff, 60, "Time between forward-progress tests (s)");
> +torture_param(bool, fwd_progress_need_resched, 1, "Hide cond_resched() behind need_resched()");
>   torture_param(bool, gp_cond, false, "Use conditional/async GP wait primitives");
>   torture_param(bool, gp_exp, false, "Use expedited GP wait primitives");
> -torture_param(bool, gp_normal, false,
> -	     "Use normal (non-expedited) GP wait primitives");
> +torture_param(bool, gp_normal, false, "Use normal (non-expedited) GP wait primitives");
>   torture_param(bool, gp_poll, false, "Use polling GP wait primitives");
>   torture_param(bool, gp_sync, false, "Use synchronous GP wait primitives");
>   torture_param(int, irqreader, 1, "Allow RCU readers from irq handlers");
>   torture_param(int, leakpointer, 0, "Leak pointer dereferences from readers");
> -torture_param(int, n_barrier_cbs, 0,
> -	     "# of callbacks/kthreads for barrier testing");
> +torture_param(int, n_barrier_cbs, 0, "# of callbacks/kthreads for barrier testing");
>   torture_param(int, nfakewriters, 4, "Number of RCU fake writer threads");
>   torture_param(int, nreaders, -1, "Number of RCU reader threads");
> -torture_param(int, object_debug, 0,
> -	     "Enable debug-object double call_rcu() testing");
> +torture_param(int, object_debug, 0, "Enable debug-object double call_rcu() testing");
>   torture_param(int, onoff_holdoff, 0, "Time after boot before CPU hotplugs (s)");
> -torture_param(int, onoff_interval, 0,
> -	     "Time between CPU hotplugs (jiffies), 0=disable");
> +torture_param(int, onoff_interval, 0, "Time between CPU hotplugs (jiffies), 0=disable");
>   torture_param(int, nocbs_nthreads, 0, "Number of NOCB toggle threads, 0 to disable");
>   torture_param(int, nocbs_toggle, 1000, "Time between toggling nocb state (ms)");
> -torture_param(int, read_exit_delay, 13,
> -	      "Delay between read-then-exit episodes (s)");
> -torture_param(int, read_exit_burst, 16,
> -	      "# of read-then-exit bursts per episode, zero to disable");
> +torture_param(int, read_exit_delay, 13, "Delay between read-then-exit episodes (s)");
> +torture_param(int, read_exit_burst, 16, "# of read-then-exit bursts per episode, zero to disable");
>   torture_param(int, shuffle_interval, 3, "Number of seconds between shuffles");
>   torture_param(int, shutdown_secs, 0, "Shutdown time (s), <= zero to disable.");
>   torture_param(int, stall_cpu, 0, "Stall duration (s), zero to disable.");
> -torture_param(int, stall_cpu_holdoff, 10,
> -	     "Time to wait before starting stall (s).");
> -torture_param(bool, stall_no_softlockup, false,
> -	     "Avoid softlockup warning during cpu stall.");
> +torture_param(int, stall_cpu_holdoff, 10, "Time to wait before starting stall (s).");
> +torture_param(bool, stall_no_softlockup, false, "Avoid softlockup warning during cpu stall.");
>   torture_param(int, stall_cpu_irqsoff, 0, "Disable interrupts while stalling.");
>   torture_param(int, stall_cpu_block, 0, "Sleep while stalling.");
> -torture_param(int, stall_gp_kthread, 0,
> -	      "Grace-period kthread stall duration (s).");
> -torture_param(int, stat_interval, 60,
> -	     "Number of seconds between stats printk()s");
> +torture_param(int, stall_gp_kthread, 0, "Grace-period kthread stall duration (s).");
> +torture_param(int, stat_interval, 60, "Number of seconds between stats printk()s");
>   torture_param(int, stutter, 5, "Number of seconds to run/halt test");
>   torture_param(int, test_boost, 1, "Test RCU prio boost: 0=no, 1=maybe, 2=yes.");
> -torture_param(int, test_boost_duration, 4,
> -	     "Duration of each boost test, seconds.");
> -torture_param(int, test_boost_interval, 7,
> -	     "Interval between boost tests, seconds.");
> -torture_param(bool, test_no_idle_hz, true,
> -	     "Test support for tickless idle CPUs");
> -torture_param(int, verbose, 1,
> -	     "Enable verbose debugging printk()s");
> +torture_param(int, test_boost_duration, 4, "Duration of each boost test, seconds.");
> +torture_param(int, test_boost_interval, 7, "Interval between boost tests, seconds.");
> +torture_param(bool, test_no_idle_hz, true, "Test support for tickless idle CPUs");
> +torture_param(int, verbose, 1, "Enable verbose debugging printk()s");
>   
>   static char *torture_type = "rcu";
>   module_param(torture_type, charp, 0444);
diff mbox series

Patch

diff --git a/kernel/rcu/rcutorture.c b/kernel/rcu/rcutorture.c
index 7120165a93426..6f47d1490c4f5 100644
--- a/kernel/rcu/rcutorture.c
+++ b/kernel/rcu/rcutorture.c
@@ -75,62 +75,45 @@  MODULE_AUTHOR("Paul E. McKenney <paulmck@linux.ibm.com> and Josh Triplett <josh@
 
 torture_param(int, extendables, RCUTORTURE_MAX_EXTEND,
 	      "Extend readers by disabling bh (1), irqs (2), or preempt (4)");
-torture_param(int, fqs_duration, 0,
-	      "Duration of fqs bursts (us), 0 to disable");
+torture_param(int, fqs_duration, 0, "Duration of fqs bursts (us), 0 to disable");
 torture_param(int, fqs_holdoff, 0, "Holdoff time within fqs bursts (us)");
 torture_param(int, fqs_stutter, 3, "Wait time between fqs bursts (s)");
-torture_param(int, fwd_progress, 1, "Test grace-period forward progress");
+torture_param(int, fwd_progress, 1, "Number of grace-period forward progress tasks (0 to disable)");
 torture_param(int, fwd_progress_div, 4, "Fraction of CPU stall to wait");
-torture_param(int, fwd_progress_holdoff, 60,
-	      "Time between forward-progress tests (s)");
-torture_param(bool, fwd_progress_need_resched, 1,
-	      "Hide cond_resched() behind need_resched()");
+torture_param(int, fwd_progress_holdoff, 60, "Time between forward-progress tests (s)");
+torture_param(bool, fwd_progress_need_resched, 1, "Hide cond_resched() behind need_resched()");
 torture_param(bool, gp_cond, false, "Use conditional/async GP wait primitives");
 torture_param(bool, gp_exp, false, "Use expedited GP wait primitives");
-torture_param(bool, gp_normal, false,
-	     "Use normal (non-expedited) GP wait primitives");
+torture_param(bool, gp_normal, false, "Use normal (non-expedited) GP wait primitives");
 torture_param(bool, gp_poll, false, "Use polling GP wait primitives");
 torture_param(bool, gp_sync, false, "Use synchronous GP wait primitives");
 torture_param(int, irqreader, 1, "Allow RCU readers from irq handlers");
 torture_param(int, leakpointer, 0, "Leak pointer dereferences from readers");
-torture_param(int, n_barrier_cbs, 0,
-	     "# of callbacks/kthreads for barrier testing");
+torture_param(int, n_barrier_cbs, 0, "# of callbacks/kthreads for barrier testing");
 torture_param(int, nfakewriters, 4, "Number of RCU fake writer threads");
 torture_param(int, nreaders, -1, "Number of RCU reader threads");
-torture_param(int, object_debug, 0,
-	     "Enable debug-object double call_rcu() testing");
+torture_param(int, object_debug, 0, "Enable debug-object double call_rcu() testing");
 torture_param(int, onoff_holdoff, 0, "Time after boot before CPU hotplugs (s)");
-torture_param(int, onoff_interval, 0,
-	     "Time between CPU hotplugs (jiffies), 0=disable");
+torture_param(int, onoff_interval, 0, "Time between CPU hotplugs (jiffies), 0=disable");
 torture_param(int, nocbs_nthreads, 0, "Number of NOCB toggle threads, 0 to disable");
 torture_param(int, nocbs_toggle, 1000, "Time between toggling nocb state (ms)");
-torture_param(int, read_exit_delay, 13,
-	      "Delay between read-then-exit episodes (s)");
-torture_param(int, read_exit_burst, 16,
-	      "# of read-then-exit bursts per episode, zero to disable");
+torture_param(int, read_exit_delay, 13, "Delay between read-then-exit episodes (s)");
+torture_param(int, read_exit_burst, 16, "# of read-then-exit bursts per episode, zero to disable");
 torture_param(int, shuffle_interval, 3, "Number of seconds between shuffles");
 torture_param(int, shutdown_secs, 0, "Shutdown time (s), <= zero to disable.");
 torture_param(int, stall_cpu, 0, "Stall duration (s), zero to disable.");
-torture_param(int, stall_cpu_holdoff, 10,
-	     "Time to wait before starting stall (s).");
-torture_param(bool, stall_no_softlockup, false,
-	     "Avoid softlockup warning during cpu stall.");
+torture_param(int, stall_cpu_holdoff, 10, "Time to wait before starting stall (s).");
+torture_param(bool, stall_no_softlockup, false, "Avoid softlockup warning during cpu stall.");
 torture_param(int, stall_cpu_irqsoff, 0, "Disable interrupts while stalling.");
 torture_param(int, stall_cpu_block, 0, "Sleep while stalling.");
-torture_param(int, stall_gp_kthread, 0,
-	      "Grace-period kthread stall duration (s).");
-torture_param(int, stat_interval, 60,
-	     "Number of seconds between stats printk()s");
+torture_param(int, stall_gp_kthread, 0, "Grace-period kthread stall duration (s).");
+torture_param(int, stat_interval, 60, "Number of seconds between stats printk()s");
 torture_param(int, stutter, 5, "Number of seconds to run/halt test");
 torture_param(int, test_boost, 1, "Test RCU prio boost: 0=no, 1=maybe, 2=yes.");
-torture_param(int, test_boost_duration, 4,
-	     "Duration of each boost test, seconds.");
-torture_param(int, test_boost_interval, 7,
-	     "Interval between boost tests, seconds.");
-torture_param(bool, test_no_idle_hz, true,
-	     "Test support for tickless idle CPUs");
-torture_param(int, verbose, 1,
-	     "Enable verbose debugging printk()s");
+torture_param(int, test_boost_duration, 4, "Duration of each boost test, seconds.");
+torture_param(int, test_boost_interval, 7, "Interval between boost tests, seconds.");
+torture_param(bool, test_no_idle_hz, true, "Test support for tickless idle CPUs");
+torture_param(int, verbose, 1, "Enable verbose debugging printk()s");
 
 static char *torture_type = "rcu";
 module_param(torture_type, charp, 0444);