rcu: Document kernel command-line parameters

Bring RCU's kernel command-line parameter documentation up to date. Signed-off-by: Paul E. McKenney <paul.mckenney@linaro.org> Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>

rcu: Document kernel command-line parameters
Bring RCU's kernel command-line parameter documentation up to date. Signed-off-by: Paul E. McKenney <paul.mckenney@linaro.org> Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Paul E. McKenney · Paul E. McKenney
1 parent 8932a63d5e
Showing 1 changed file with 85 additions and 3 deletions Side-by-side Diff
Documentation/kernel-parameters.txt
@@ -2330,17 +2330,99 @@
 	ramdisk_size=	[RAM] Sizes of RAM disks in kilobytes
 			See Documentation/blockdev/ramdisk.txt.
  
-	rcupdate.blimit=	[KNL,BOOT]
+	rcutree.blimit=	[KNL,BOOT]
 			Set maximum number of finished RCU callbacks to process
 			in one batch.
  
-	rcupdate.qhimark=	[KNL,BOOT]
+	rcutree.qhimark=	[KNL,BOOT]
 			Set threshold of queued
 			RCU callbacks over which batch limiting is disabled.
  
-	rcupdate.qlowmark=	[KNL,BOOT]
+	rcutree.qlowmark=	[KNL,BOOT]
 			Set threshold of queued RCU callbacks below which
 			batch limiting is re-enabled.
+
+	rcutree.rcu_cpu_stall_suppress=	[KNL,BOOT]
+			Suppress RCU CPU stall warning messages.
+
+	rcutree.rcu_cpu_stall_timeout= [KNL,BOOT]
+			Set timeout for RCU CPU stall warning messages.
+
+	rcutorture.fqs_duration= [KNL,BOOT]
+			Set duration of force_quiescent_state bursts.
+
+	rcutorture.fqs_holdoff= [KNL,BOOT]
+			Set holdoff time within force_quiescent_state bursts.
+
+	rcutorture.fqs_stutter= [KNL,BOOT]
+			Set wait time between force_quiescent_state bursts.
+
+	rcutorture.irqreader= [KNL,BOOT]
+			Test RCU readers from irq handlers.
+
+	rcutorture.n_barrier_cbs= [KNL,BOOT]
+			Set callbacks/threads for rcu_barrier() testing.
+
+	rcutorture.nfakewriters= [KNL,BOOT]
+			Set number of concurrent RCU writers.  These just
+			stress RCU, they don't participate in the actual
+			test, hence the "fake".
+
+	rcutorture.nreaders= [KNL,BOOT]
+			Set number of RCU readers.
+
+	rcutorture.onoff_holdoff= [KNL,BOOT]
+			Set time (s) after boot for CPU-hotplug testing.
+
+	rcutorture.onoff_interval= [KNL,BOOT]
+			Set time (s) between CPU-hotplug operations, or
+			zero to disable CPU-hotplug testing.
+
+	rcutorture.shuffle_interval= [KNL,BOOT]
+			Set task-shuffle interval (s).  Shuffling tasks
+			allows some CPUs to go into dyntick-idle mode
+			during the rcutorture test.
+
+	rcutorture.shutdown_secs= [KNL,BOOT]
+			Set time (s) after boot system shutdown.  This
+			is useful for hands-off automated testing.
+
+	rcutorture.stall_cpu= [KNL,BOOT]
+			Duration of CPU stall (s) to test RCU CPU stall
+			warnings, zero to disable.
+
+	rcutorture.stall_cpu_holdoff= [KNL,BOOT]
+			Time to wait (s) after boot before inducing stall.
+
+	rcutorture.stat_interval= [KNL,BOOT]
+			Time (s) between statistics printk()s.
+
+	rcutorture.stutter= [KNL,BOOT]
+			Time (s) to stutter testing, for example, specifying
+			five seconds causes the test to run for five seconds,
+			wait for five seconds, and so on.  This tests RCU's
+			ability to transition abruptly to and from idle.
+
+	rcutorture.test_boost= [KNL,BOOT]
+			Test RCU priority boosting?  0=no, 1=maybe, 2=yes.
+			"Maybe" means test if the RCU implementation
+			under test support RCU priority boosting.
+
+	rcutorture.test_boost_duration= [KNL,BOOT]
+			Duration (s) of each individual boost test.
+
+	rcutorture.test_boost_interval= [KNL,BOOT]
+			Interval (s) between each boost test.
+
+	rcutorture.test_no_idle_hz= [KNL,BOOT]
+			Test RCU's dyntick-idle handling.  See also the
+			rcutorture.shuffle_interval parameter.
+
+	rcutorture.torture_type= [KNL,BOOT]
+			Specify the RCU implementation to test.
+
+	rcutorture.verbose= [KNL,BOOT]
+			Enable additional printk() statements.
  
 	rdinit=		[KNL]
 			Format: <full_path>
...	...	@@ -2330,17 +2330,99 @@
2330	2330	ramdisk_size= [RAM] Sizes of RAM disks in kilobytes
2331	2331	See Documentation/blockdev/ramdisk.txt.
2332	2332
2333		- rcupdate.blimit= [KNL,BOOT]
	2333	+ rcutree.blimit= [KNL,BOOT]
2334	2334	Set maximum number of finished RCU callbacks to process
2335	2335	in one batch.
2336	2336
2337		- rcupdate.qhimark= [KNL,BOOT]
	2337	+ rcutree.qhimark= [KNL,BOOT]
2338	2338	Set threshold of queued
2339	2339	RCU callbacks over which batch limiting is disabled.
2340	2340
2341		- rcupdate.qlowmark= [KNL,BOOT]
	2341	+ rcutree.qlowmark= [KNL,BOOT]
2342	2342	Set threshold of queued RCU callbacks below which
2343	2343	batch limiting is re-enabled.
	2344	+
	2345	+ rcutree.rcu_cpu_stall_suppress= [KNL,BOOT]
	2346	+ Suppress RCU CPU stall warning messages.
	2347	+
	2348	+ rcutree.rcu_cpu_stall_timeout= [KNL,BOOT]
	2349	+ Set timeout for RCU CPU stall warning messages.
	2350	+
	2351	+ rcutorture.fqs_duration= [KNL,BOOT]
	2352	+ Set duration of force_quiescent_state bursts.
	2353	+
	2354	+ rcutorture.fqs_holdoff= [KNL,BOOT]
	2355	+ Set holdoff time within force_quiescent_state bursts.
	2356	+
	2357	+ rcutorture.fqs_stutter= [KNL,BOOT]
	2358	+ Set wait time between force_quiescent_state bursts.
	2359	+
	2360	+ rcutorture.irqreader= [KNL,BOOT]
	2361	+ Test RCU readers from irq handlers.
	2362	+
	2363	+ rcutorture.n_barrier_cbs= [KNL,BOOT]
	2364	+ Set callbacks/threads for rcu_barrier() testing.
	2365	+
	2366	+ rcutorture.nfakewriters= [KNL,BOOT]
	2367	+ Set number of concurrent RCU writers. These just
	2368	+ stress RCU, they don't participate in the actual
	2369	+ test, hence the "fake".
	2370	+
	2371	+ rcutorture.nreaders= [KNL,BOOT]
	2372	+ Set number of RCU readers.
	2373	+
	2374	+ rcutorture.onoff_holdoff= [KNL,BOOT]
	2375	+ Set time (s) after boot for CPU-hotplug testing.
	2376	+
	2377	+ rcutorture.onoff_interval= [KNL,BOOT]
	2378	+ Set time (s) between CPU-hotplug operations, or
	2379	+ zero to disable CPU-hotplug testing.
	2380	+
	2381	+ rcutorture.shuffle_interval= [KNL,BOOT]
	2382	+ Set task-shuffle interval (s). Shuffling tasks
	2383	+ allows some CPUs to go into dyntick-idle mode
	2384	+ during the rcutorture test.
	2385	+
	2386	+ rcutorture.shutdown_secs= [KNL,BOOT]
	2387	+ Set time (s) after boot system shutdown. This
	2388	+ is useful for hands-off automated testing.
	2389	+
	2390	+ rcutorture.stall_cpu= [KNL,BOOT]
	2391	+ Duration of CPU stall (s) to test RCU CPU stall
	2392	+ warnings, zero to disable.
	2393	+
	2394	+ rcutorture.stall_cpu_holdoff= [KNL,BOOT]
	2395	+ Time to wait (s) after boot before inducing stall.
	2396	+
	2397	+ rcutorture.stat_interval= [KNL,BOOT]
	2398	+ Time (s) between statistics printk()s.
	2399	+
	2400	+ rcutorture.stutter= [KNL,BOOT]
	2401	+ Time (s) to stutter testing, for example, specifying
	2402	+ five seconds causes the test to run for five seconds,
	2403	+ wait for five seconds, and so on. This tests RCU's
	2404	+ ability to transition abruptly to and from idle.
	2405	+
	2406	+ rcutorture.test_boost= [KNL,BOOT]
	2407	+ Test RCU priority boosting? 0=no, 1=maybe, 2=yes.
	2408	+ "Maybe" means test if the RCU implementation
	2409	+ under test support RCU priority boosting.
	2410	+
	2411	+ rcutorture.test_boost_duration= [KNL,BOOT]
	2412	+ Duration (s) of each individual boost test.
	2413	+
	2414	+ rcutorture.test_boost_interval= [KNL,BOOT]
	2415	+ Interval (s) between each boost test.
	2416	+
	2417	+ rcutorture.test_no_idle_hz= [KNL,BOOT]
	2418	+ Test RCU's dyntick-idle handling. See also the
	2419	+ rcutorture.shuffle_interval parameter.
	2420	+
	2421	+ rcutorture.torture_type= [KNL,BOOT]
	2422	+ Specify the RCU implementation to test.
	2423	+
	2424	+ rcutorture.verbose= [KNL,BOOT]
	2425	+ Enable additional printk() statements.
2344	2426
2345	2427	rdinit= [KNL]
2346	2428	Format: <full_path>