xref: /linux/kernel/rcu/Kconfig (revision 8c1cf2da6f8af7f6b6e0e06d3a83115712cc04b8)
10af92d46SPaul E. McKenney#
20af92d46SPaul E. McKenney# RCU-related configuration options
30af92d46SPaul E. McKenney#
40af92d46SPaul E. McKenney
50af92d46SPaul E. McKenneymenu "RCU Subsystem"
60af92d46SPaul E. McKenney
70af92d46SPaul E. McKenneyconfig TREE_RCU
80af92d46SPaul E. McKenney	bool
90af92d46SPaul E. McKenney	default y if !PREEMPT && SMP
100af92d46SPaul E. McKenney	help
110af92d46SPaul E. McKenney	  This option selects the RCU implementation that is
120af92d46SPaul E. McKenney	  designed for very large SMP system with hundreds or
130af92d46SPaul E. McKenney	  thousands of CPUs.  It also scales down nicely to
140af92d46SPaul E. McKenney	  smaller systems.
150af92d46SPaul E. McKenney
160af92d46SPaul E. McKenneyconfig PREEMPT_RCU
170af92d46SPaul E. McKenney	bool
180af92d46SPaul E. McKenney	default y if PREEMPT
190af92d46SPaul E. McKenney	help
200af92d46SPaul E. McKenney	  This option selects the RCU implementation that is
210af92d46SPaul E. McKenney	  designed for very large SMP systems with hundreds or
220af92d46SPaul E. McKenney	  thousands of CPUs, but for which real-time response
230af92d46SPaul E. McKenney	  is also required.  It also scales down nicely to
240af92d46SPaul E. McKenney	  smaller systems.
250af92d46SPaul E. McKenney
260af92d46SPaul E. McKenney	  Select this option if you are unsure.
270af92d46SPaul E. McKenney
280af92d46SPaul E. McKenneyconfig TINY_RCU
290af92d46SPaul E. McKenney	bool
300af92d46SPaul E. McKenney	default y if !PREEMPT && !SMP
310af92d46SPaul E. McKenney	help
320af92d46SPaul E. McKenney	  This option selects the RCU implementation that is
330af92d46SPaul E. McKenney	  designed for UP systems from which real-time response
340af92d46SPaul E. McKenney	  is not required.  This option greatly reduces the
350af92d46SPaul E. McKenney	  memory footprint of RCU.
360af92d46SPaul E. McKenney
370af92d46SPaul E. McKenneyconfig RCU_EXPERT
380af92d46SPaul E. McKenney	bool "Make expert-level adjustments to RCU configuration"
390af92d46SPaul E. McKenney	default n
400af92d46SPaul E. McKenney	help
410af92d46SPaul E. McKenney	  This option needs to be enabled if you wish to make
420af92d46SPaul E. McKenney	  expert-level adjustments to RCU configuration.  By default,
430af92d46SPaul E. McKenney	  no such adjustments can be made, which has the often-beneficial
440af92d46SPaul E. McKenney	  side-effect of preventing "make oldconfig" from asking you all
450af92d46SPaul E. McKenney	  sorts of detailed questions about how you would like numerous
460af92d46SPaul E. McKenney	  obscure RCU options to be set up.
470af92d46SPaul E. McKenney
480af92d46SPaul E. McKenney	  Say Y if you need to make expert-level adjustments to RCU.
490af92d46SPaul E. McKenney
500af92d46SPaul E. McKenney	  Say N if you are unsure.
510af92d46SPaul E. McKenney
520af92d46SPaul E. McKenneyconfig SRCU
530af92d46SPaul E. McKenney	bool
540af92d46SPaul E. McKenney	help
550af92d46SPaul E. McKenney	  This option selects the sleepable version of RCU. This version
560af92d46SPaul E. McKenney	  permits arbitrary sleeping or blocking within RCU read-side critical
570af92d46SPaul E. McKenney	  sections.
580af92d46SPaul E. McKenney
590af92d46SPaul E. McKenneyconfig TINY_SRCU
600af92d46SPaul E. McKenney	bool
610af92d46SPaul E. McKenney	default y if SRCU && TINY_RCU
620af92d46SPaul E. McKenney	help
630af92d46SPaul E. McKenney	  This option selects the single-CPU non-preemptible version of SRCU.
640af92d46SPaul E. McKenney
650af92d46SPaul E. McKenneyconfig TREE_SRCU
660af92d46SPaul E. McKenney	bool
670af92d46SPaul E. McKenney	default y if SRCU && !TINY_RCU
680af92d46SPaul E. McKenney	help
690af92d46SPaul E. McKenney	  This option selects the full-fledged version of SRCU.
700af92d46SPaul E. McKenney
710af92d46SPaul E. McKenneyconfig TASKS_RCU
727e42776dSPaul E. McKenney	def_bool PREEMPT
730af92d46SPaul E. McKenney	select SRCU
740af92d46SPaul E. McKenney	help
750af92d46SPaul E. McKenney	  This option enables a task-based RCU implementation that uses
760af92d46SPaul E. McKenney	  only voluntary context switch (not preemption!), idle, and
770af92d46SPaul E. McKenney	  user-mode execution as quiescent states.
780af92d46SPaul E. McKenney
790af92d46SPaul E. McKenneyconfig RCU_STALL_COMMON
806d48152eSPaul E. McKenney	def_bool ( TREE_RCU || PREEMPT_RCU )
810af92d46SPaul E. McKenney	help
820af92d46SPaul E. McKenney	  This option enables RCU CPU stall code that is common between
830af92d46SPaul E. McKenney	  the TINY and TREE variants of RCU.  The purpose is to allow
840af92d46SPaul E. McKenney	  the tiny variants to disable RCU CPU stall warnings, while
850af92d46SPaul E. McKenney	  making these warnings mandatory for the tree variants.
860af92d46SPaul E. McKenney
870af92d46SPaul E. McKenneyconfig RCU_NEED_SEGCBLIST
880af92d46SPaul E. McKenney	def_bool ( TREE_RCU || PREEMPT_RCU || TREE_SRCU )
890af92d46SPaul E. McKenney
900af92d46SPaul E. McKenneyconfig CONTEXT_TRACKING
910af92d46SPaul E. McKenney       bool
920af92d46SPaul E. McKenney
930af92d46SPaul E. McKenneyconfig CONTEXT_TRACKING_FORCE
940af92d46SPaul E. McKenney	bool "Force context tracking"
950af92d46SPaul E. McKenney	depends on CONTEXT_TRACKING
960af92d46SPaul E. McKenney	default y if !NO_HZ_FULL
970af92d46SPaul E. McKenney	help
980af92d46SPaul E. McKenney	  The major pre-requirement for full dynticks to work is to
990af92d46SPaul E. McKenney	  support the context tracking subsystem. But there are also
1000af92d46SPaul E. McKenney	  other dependencies to provide in order to make the full
1010af92d46SPaul E. McKenney	  dynticks working.
1020af92d46SPaul E. McKenney
1030af92d46SPaul E. McKenney	  This option stands for testing when an arch implements the
1040af92d46SPaul E. McKenney	  context tracking backend but doesn't yet fullfill all the
1050af92d46SPaul E. McKenney	  requirements to make the full dynticks feature working.
1060af92d46SPaul E. McKenney	  Without the full dynticks, there is no way to test the support
1070af92d46SPaul E. McKenney	  for context tracking and the subsystems that rely on it: RCU
1080af92d46SPaul E. McKenney	  userspace extended quiescent state and tickless cputime
1090af92d46SPaul E. McKenney	  accounting. This option copes with the absence of the full
1100af92d46SPaul E. McKenney	  dynticks subsystem by forcing the context tracking on all
1110af92d46SPaul E. McKenney	  CPUs in the system.
1120af92d46SPaul E. McKenney
1130af92d46SPaul E. McKenney	  Say Y only if you're working on the development of an
1140af92d46SPaul E. McKenney	  architecture backend for the context tracking.
1150af92d46SPaul E. McKenney
1160af92d46SPaul E. McKenney	  Say N otherwise, this option brings an overhead that you
1170af92d46SPaul E. McKenney	  don't want in production.
1180af92d46SPaul E. McKenney
1190af92d46SPaul E. McKenney
1200af92d46SPaul E. McKenneyconfig RCU_FANOUT
1210af92d46SPaul E. McKenney	int "Tree-based hierarchical RCU fanout value"
1220af92d46SPaul E. McKenney	range 2 64 if 64BIT
1230af92d46SPaul E. McKenney	range 2 32 if !64BIT
1240af92d46SPaul E. McKenney	depends on (TREE_RCU || PREEMPT_RCU) && RCU_EXPERT
1250af92d46SPaul E. McKenney	default 64 if 64BIT
1260af92d46SPaul E. McKenney	default 32 if !64BIT
1270af92d46SPaul E. McKenney	help
1280af92d46SPaul E. McKenney	  This option controls the fanout of hierarchical implementations
1290af92d46SPaul E. McKenney	  of RCU, allowing RCU to work efficiently on machines with
1300af92d46SPaul E. McKenney	  large numbers of CPUs.  This value must be at least the fourth
1310af92d46SPaul E. McKenney	  root of NR_CPUS, which allows NR_CPUS to be insanely large.
1320af92d46SPaul E. McKenney	  The default value of RCU_FANOUT should be used for production
1330af92d46SPaul E. McKenney	  systems, but if you are stress-testing the RCU implementation
1340af92d46SPaul E. McKenney	  itself, small RCU_FANOUT values allow you to test large-system
1350af92d46SPaul E. McKenney	  code paths on small(er) systems.
1360af92d46SPaul E. McKenney
1370af92d46SPaul E. McKenney	  Select a specific number if testing RCU itself.
1380af92d46SPaul E. McKenney	  Take the default if unsure.
1390af92d46SPaul E. McKenney
1400af92d46SPaul E. McKenneyconfig RCU_FANOUT_LEAF
1410af92d46SPaul E. McKenney	int "Tree-based hierarchical RCU leaf-level fanout value"
1420af92d46SPaul E. McKenney	range 2 64 if 64BIT
1430af92d46SPaul E. McKenney	range 2 32 if !64BIT
1440af92d46SPaul E. McKenney	depends on (TREE_RCU || PREEMPT_RCU) && RCU_EXPERT
1450af92d46SPaul E. McKenney	default 16
1460af92d46SPaul E. McKenney	help
1470af92d46SPaul E. McKenney	  This option controls the leaf-level fanout of hierarchical
1480af92d46SPaul E. McKenney	  implementations of RCU, and allows trading off cache misses
1490af92d46SPaul E. McKenney	  against lock contention.  Systems that synchronize their
1500af92d46SPaul E. McKenney	  scheduling-clock interrupts for energy-efficiency reasons will
1510af92d46SPaul E. McKenney	  want the default because the smaller leaf-level fanout keeps
1520af92d46SPaul E. McKenney	  lock contention levels acceptably low.  Very large systems
1530af92d46SPaul E. McKenney	  (hundreds or thousands of CPUs) will instead want to set this
1540af92d46SPaul E. McKenney	  value to the maximum value possible in order to reduce the
1550af92d46SPaul E. McKenney	  number of cache misses incurred during RCU's grace-period
1560af92d46SPaul E. McKenney	  initialization.  These systems tend to run CPU-bound, and thus
1570af92d46SPaul E. McKenney	  are not helped by synchronized interrupts, and thus tend to
1580af92d46SPaul E. McKenney	  skew them, which reduces lock contention enough that large
1590af92d46SPaul E. McKenney	  leaf-level fanouts work well.  That said, setting leaf-level
1600af92d46SPaul E. McKenney	  fanout to a large number will likely cause problematic
1610af92d46SPaul E. McKenney	  lock contention on the leaf-level rcu_node structures unless
1620af92d46SPaul E. McKenney	  you boot with the skew_tick kernel parameter.
1630af92d46SPaul E. McKenney
1640af92d46SPaul E. McKenney	  Select a specific number if testing RCU itself.
1650af92d46SPaul E. McKenney
1660af92d46SPaul E. McKenney	  Select the maximum permissible value for large systems, but
1670af92d46SPaul E. McKenney	  please understand that you may also need to set the skew_tick
1680af92d46SPaul E. McKenney	  kernel boot parameter to avoid contention on the rcu_node
1690af92d46SPaul E. McKenney	  structure's locks.
1700af92d46SPaul E. McKenney
1710af92d46SPaul E. McKenney	  Take the default if unsure.
1720af92d46SPaul E. McKenney
1730af92d46SPaul E. McKenneyconfig RCU_FAST_NO_HZ
1740af92d46SPaul E. McKenney	bool "Accelerate last non-dyntick-idle CPU's grace periods"
1750af92d46SPaul E. McKenney	depends on NO_HZ_COMMON && SMP && RCU_EXPERT
1760af92d46SPaul E. McKenney	default n
1770af92d46SPaul E. McKenney	help
1780af92d46SPaul E. McKenney	  This option permits CPUs to enter dynticks-idle state even if
1790af92d46SPaul E. McKenney	  they have RCU callbacks queued, and prevents RCU from waking
1800af92d46SPaul E. McKenney	  these CPUs up more than roughly once every four jiffies (by
1810af92d46SPaul E. McKenney	  default, you can adjust this using the rcutree.rcu_idle_gp_delay
1820af92d46SPaul E. McKenney	  parameter), thus improving energy efficiency.  On the other
1830af92d46SPaul E. McKenney	  hand, this option increases the duration of RCU grace periods,
1840af92d46SPaul E. McKenney	  for example, slowing down synchronize_rcu().
1850af92d46SPaul E. McKenney
1860af92d46SPaul E. McKenney	  Say Y if energy efficiency is critically important, and you
1870af92d46SPaul E. McKenney	  	don't care about increased grace-period durations.
1880af92d46SPaul E. McKenney
1890af92d46SPaul E. McKenney	  Say N if you are unsure.
1900af92d46SPaul E. McKenney
1910af92d46SPaul E. McKenneyconfig RCU_BOOST
1920af92d46SPaul E. McKenney	bool "Enable RCU priority boosting"
1930af92d46SPaul E. McKenney	depends on RT_MUTEXES && PREEMPT_RCU && RCU_EXPERT
1940af92d46SPaul E. McKenney	default n
1950af92d46SPaul E. McKenney	help
1960af92d46SPaul E. McKenney	  This option boosts the priority of preempted RCU readers that
1970af92d46SPaul E. McKenney	  block the current preemptible RCU grace period for too long.
1980af92d46SPaul E. McKenney	  This option also prevents heavy loads from blocking RCU
199*8c1cf2daSPaul E. McKenney	  callback invocation.
2000af92d46SPaul E. McKenney
2010af92d46SPaul E. McKenney	  Say Y here if you are working with real-time apps or heavy loads
2020af92d46SPaul E. McKenney	  Say N here if you are unsure.
2030af92d46SPaul E. McKenney
2040af92d46SPaul E. McKenneyconfig RCU_BOOST_DELAY
2050af92d46SPaul E. McKenney	int "Milliseconds to delay boosting after RCU grace-period start"
2060af92d46SPaul E. McKenney	range 0 3000
2070af92d46SPaul E. McKenney	depends on RCU_BOOST
2080af92d46SPaul E. McKenney	default 500
2090af92d46SPaul E. McKenney	help
2100af92d46SPaul E. McKenney	  This option specifies the time to wait after the beginning of
2110af92d46SPaul E. McKenney	  a given grace period before priority-boosting preempted RCU
2120af92d46SPaul E. McKenney	  readers blocking that grace period.  Note that any RCU reader
2130af92d46SPaul E. McKenney	  blocking an expedited RCU grace period is boosted immediately.
2140af92d46SPaul E. McKenney
2150af92d46SPaul E. McKenney	  Accept the default if unsure.
2160af92d46SPaul E. McKenney
2170af92d46SPaul E. McKenneyconfig RCU_NOCB_CPU
2180af92d46SPaul E. McKenney	bool "Offload RCU callback processing from boot-selected CPUs"
2190af92d46SPaul E. McKenney	depends on TREE_RCU || PREEMPT_RCU
2200af92d46SPaul E. McKenney	depends on RCU_EXPERT || NO_HZ_FULL
2210af92d46SPaul E. McKenney	default n
2220af92d46SPaul E. McKenney	help
2230af92d46SPaul E. McKenney	  Use this option to reduce OS jitter for aggressive HPC or
2240af92d46SPaul E. McKenney	  real-time workloads.	It can also be used to offload RCU
2250af92d46SPaul E. McKenney	  callback invocation to energy-efficient CPUs in battery-powered
2260af92d46SPaul E. McKenney	  asymmetric multiprocessors.
2270af92d46SPaul E. McKenney
228*8c1cf2daSPaul E. McKenney	  This option offloads callback invocation from the set of CPUs
229*8c1cf2daSPaul E. McKenney	  specified at boot time by the rcu_nocbs parameter.  For each
230*8c1cf2daSPaul E. McKenney	  such CPU, a kthread ("rcuox/N") will be created to invoke
231*8c1cf2daSPaul E. McKenney	  callbacks, where the "N" is the CPU being offloaded, and where
232*8c1cf2daSPaul E. McKenney	  the "p" for RCU-preempt (PREEMPT kernels) and "s" for RCU-sched
233*8c1cf2daSPaul E. McKenney	  (!PREEMPT kernels).  Nothing prevents this kthread from running
234*8c1cf2daSPaul E. McKenney	  on the specified CPUs, but (1) the kthreads may be preempted
235*8c1cf2daSPaul E. McKenney	  between each callback, and (2) affinity or cgroups can be used
236*8c1cf2daSPaul E. McKenney	  to force the kthreads to run on whatever set of CPUs is desired.
2370af92d46SPaul E. McKenney
2380af92d46SPaul E. McKenney	  Say Y here if you want to help to debug reduced OS jitter.
2390af92d46SPaul E. McKenney	  Say N here if you are unsure.
2400af92d46SPaul E. McKenney
2410af92d46SPaul E. McKenneyendmenu # "RCU Subsystem"
242