kernel.rst 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735
  1. ===================================
  2. Documentation for /proc/sys/kernel/
  3. ===================================
  4. .. See scripts/check-sysctl-docs to keep this up to date
  5. Copyright (c) 1998, 1999, Rik van Riel <riel@nl.linux.org>
  6. Copyright (c) 2009, Shen Feng<shen@cn.fujitsu.com>
  7. For general info and legal blurb, please look in
  8. Documentation/admin-guide/sysctl/index.rst.
  9. ------------------------------------------------------------------------------
  10. This file contains documentation for the sysctl files in
  11. ``/proc/sys/kernel/``.
  12. The files in this directory can be used to tune and monitor
  13. miscellaneous and general things in the operation of the Linux
  14. kernel. Since some of the files *can* be used to screw up your
  15. system, it is advisable to read both documentation and source
  16. before actually making adjustments.
  17. Currently, these files might (depending on your configuration)
  18. show up in ``/proc/sys/kernel``:
  19. .. contents:: :local:
  20. acct
  21. ====
  22. ::
  23. highwater lowwater frequency
  24. If BSD-style process accounting is enabled these values control
  25. its behaviour. If free space on filesystem where the log lives
  26. goes below ``lowwater``\ % accounting suspends. If free space gets
  27. above ``highwater``\ % accounting resumes. ``frequency`` determines
  28. how often do we check the amount of free space (value is in
  29. seconds). Default:
  30. ::
  31. 4 2 30
  32. That is, suspend accounting if free space drops below 2%; resume it
  33. if it increases to at least 4%; consider information about amount of
  34. free space valid for 30 seconds.
  35. acpi_video_flags
  36. ================
  37. See Documentation/power/video.rst. This allows the video resume mode to be set,
  38. in a similar fashion to the ``acpi_sleep`` kernel parameter, by
  39. combining the following values:
  40. = =======
  41. 1 s3_bios
  42. 2 s3_mode
  43. 4 s3_beep
  44. = =======
  45. arch
  46. ====
  47. The machine hardware name, the same output as ``uname -m``
  48. (e.g. ``x86_64`` or ``aarch64``).
  49. auto_msgmni
  50. ===========
  51. This variable has no effect and may be removed in future kernel
  52. releases. Reading it always returns 0.
  53. Up to Linux 3.17, it enabled/disabled automatic recomputing of
  54. `msgmni`_
  55. upon memory add/remove or upon IPC namespace creation/removal.
  56. Echoing "1" into this file enabled msgmni automatic recomputing.
  57. Echoing "0" turned it off. The default value was 1.
  58. bootloader_type (x86 only)
  59. ==========================
  60. This gives the bootloader type number as indicated by the bootloader,
  61. shifted left by 4, and OR'd with the low four bits of the bootloader
  62. version. The reason for this encoding is that this used to match the
  63. ``type_of_loader`` field in the kernel header; the encoding is kept for
  64. backwards compatibility. That is, if the full bootloader type number
  65. is 0x15 and the full version number is 0x234, this file will contain
  66. the value 340 = 0x154.
  67. See the ``type_of_loader`` and ``ext_loader_type`` fields in
  68. Documentation/arch/x86/boot.rst for additional information.
  69. bootloader_version (x86 only)
  70. =============================
  71. The complete bootloader version number. In the example above, this
  72. file will contain the value 564 = 0x234.
  73. See the ``type_of_loader`` and ``ext_loader_ver`` fields in
  74. Documentation/arch/x86/boot.rst for additional information.
  75. bpf_stats_enabled
  76. =================
  77. Controls whether the kernel should collect statistics on BPF programs
  78. (total time spent running, number of times run...). Enabling
  79. statistics causes a slight reduction in performance on each program
  80. run. The statistics can be seen using ``bpftool``.
  81. = ===================================
  82. 0 Don't collect statistics (default).
  83. 1 Collect statistics.
  84. = ===================================
  85. cad_pid
  86. =======
  87. This is the pid which will be signalled on reboot (notably, by
  88. Ctrl-Alt-Delete). Writing a value to this file which doesn't
  89. correspond to a running process will result in ``-ESRCH``.
  90. See also `ctrl-alt-del`_.
  91. cap_last_cap
  92. ============
  93. Highest valid capability of the running kernel. Exports
  94. ``CAP_LAST_CAP`` from the kernel.
  95. .. _core_pattern:
  96. core_pattern
  97. ============
  98. ``core_pattern`` is used to specify a core dumpfile pattern name.
  99. * max length 127 characters; default value is "core"
  100. * ``core_pattern`` is used as a pattern template for the output
  101. filename; certain string patterns (beginning with '%') are
  102. substituted with their actual values.
  103. * backward compatibility with ``core_uses_pid``:
  104. If ``core_pattern`` does not include "%p" (default does not)
  105. and ``core_uses_pid`` is set, then .PID will be appended to
  106. the filename.
  107. * corename format specifiers
  108. ======== ==========================================
  109. %<NUL> '%' is dropped
  110. %% output one '%'
  111. %p pid
  112. %P global pid (init PID namespace)
  113. %i tid
  114. %I global tid (init PID namespace)
  115. %u uid (in initial user namespace)
  116. %g gid (in initial user namespace)
  117. %d dump mode, matches ``PR_SET_DUMPABLE`` and
  118. ``/proc/sys/fs/suid_dumpable``
  119. %s signal number
  120. %t UNIX time of dump
  121. %h hostname
  122. %e executable filename (may be shortened, could be changed by prctl etc)
  123. %f executable filename
  124. %E executable path
  125. %c maximum size of core file by resource limit RLIMIT_CORE
  126. %C CPU the task ran on
  127. %F pidfd number
  128. %<OTHER> both are dropped
  129. ======== ==========================================
  130. * If the first character of the pattern is a '|', the kernel will treat
  131. the rest of the pattern as a command to run. The core dump will be
  132. written to the standard input of that program instead of to a file.
  133. core_pipe_limit
  134. ===============
  135. This sysctl is only applicable when `core_pattern`_ is configured to
  136. pipe core files to a user space helper (when the first character of
  137. ``core_pattern`` is a '|', see above).
  138. When collecting cores via a pipe to an application, it is occasionally
  139. useful for the collecting application to gather data about the
  140. crashing process from its ``/proc/pid`` directory.
  141. In order to do this safely, the kernel must wait for the collecting
  142. process to exit, so as not to remove the crashing processes proc files
  143. prematurely.
  144. This in turn creates the possibility that a misbehaving userspace
  145. collecting process can block the reaping of a crashed process simply
  146. by never exiting.
  147. This sysctl defends against that.
  148. It defines how many concurrent crashing processes may be piped to user
  149. space applications in parallel.
  150. If this value is exceeded, then those crashing processes above that
  151. value are noted via the kernel log and their cores are skipped.
  152. 0 is a special value, indicating that unlimited processes may be
  153. captured in parallel, but that no waiting will take place (i.e. the
  154. collecting process is not guaranteed access to ``/proc/<crashing
  155. pid>/``).
  156. This value defaults to 0.
  157. core_sort_vma
  158. =============
  159. The default coredump writes VMAs in address order. By setting
  160. ``core_sort_vma`` to 1, VMAs will be written from smallest size
  161. to largest size. This is known to break at least elfutils, but
  162. can be handy when dealing with very large (and truncated)
  163. coredumps where the more useful debugging details are included
  164. in the smaller VMAs.
  165. core_uses_pid
  166. =============
  167. The default coredump filename is "core". By setting
  168. ``core_uses_pid`` to 1, the coredump filename becomes core.PID.
  169. If `core_pattern`_ does not include "%p" (default does not)
  170. and ``core_uses_pid`` is set, then .PID will be appended to
  171. the filename.
  172. ctrl-alt-del
  173. ============
  174. When the value in this file is 0, ctrl-alt-del is trapped and
  175. sent to the ``init(1)`` program to handle a graceful restart.
  176. When, however, the value is > 0, Linux's reaction to a Vulcan
  177. Nerve Pinch (tm) will be an immediate reboot, without even
  178. syncing its dirty buffers.
  179. Note:
  180. when a program (like dosemu) has the keyboard in 'raw'
  181. mode, the ctrl-alt-del is intercepted by the program before it
  182. ever reaches the kernel tty layer, and it's up to the program
  183. to decide what to do with it.
  184. dmesg_restrict
  185. ==============
  186. This toggle indicates whether unprivileged users are prevented
  187. from using ``dmesg(8)`` to view messages from the kernel's log
  188. buffer.
  189. When ``dmesg_restrict`` is set to 0 there are no restrictions.
  190. When ``dmesg_restrict`` is set to 1, users must have
  191. ``CAP_SYSLOG`` to use ``dmesg(8)``.
  192. The kernel config option ``CONFIG_SECURITY_DMESG_RESTRICT`` sets the
  193. default value of ``dmesg_restrict``.
  194. domainname & hostname
  195. =====================
  196. These files can be used to set the NIS/YP domainname and the
  197. hostname of your box in exactly the same way as the commands
  198. domainname and hostname, i.e.::
  199. # echo "darkstar" > /proc/sys/kernel/hostname
  200. # echo "mydomain" > /proc/sys/kernel/domainname
  201. has the same effect as::
  202. # hostname "darkstar"
  203. # domainname "mydomain"
  204. Note, however, that the classic darkstar.frop.org has the
  205. hostname "darkstar" and DNS (Internet Domain Name Server)
  206. domainname "frop.org", not to be confused with the NIS (Network
  207. Information Service) or YP (Yellow Pages) domainname. These two
  208. domain names are in general different. For a detailed discussion
  209. see the ``hostname(1)`` man page.
  210. firmware_config
  211. ===============
  212. See Documentation/driver-api/firmware/fallback-mechanisms.rst.
  213. The entries in this directory allow the firmware loader helper
  214. fallback to be controlled:
  215. * ``force_sysfs_fallback``, when set to 1, forces the use of the
  216. fallback;
  217. * ``ignore_sysfs_fallback``, when set to 1, ignores any fallback.
  218. ftrace_dump_on_oops
  219. ===================
  220. Determines whether ``ftrace_dump()`` should be called on an oops (or
  221. kernel panic). This will output the contents of the ftrace buffers to
  222. the console. This is very useful for capturing traces that lead to
  223. crashes and outputting them to a serial console.
  224. ======================= ===========================================
  225. 0 Disabled (default).
  226. 1 Dump buffers of all CPUs.
  227. 2(orig_cpu) Dump the buffer of the CPU that triggered the
  228. oops.
  229. <instance> Dump the specific instance buffer on all CPUs.
  230. <instance>=2(orig_cpu) Dump the specific instance buffer on the CPU
  231. that triggered the oops.
  232. ======================= ===========================================
  233. Multiple instance dump is also supported, and instances are separated
  234. by commas. If global buffer also needs to be dumped, please specify
  235. the dump mode (1/2/orig_cpu) first for global buffer.
  236. So for example to dump "foo" and "bar" instance buffer on all CPUs,
  237. user can::
  238. echo "foo,bar" > /proc/sys/kernel/ftrace_dump_on_oops
  239. To dump global buffer and "foo" instance buffer on all
  240. CPUs along with the "bar" instance buffer on CPU that triggered the
  241. oops, user can::
  242. echo "1,foo,bar=2" > /proc/sys/kernel/ftrace_dump_on_oops
  243. ftrace_enabled, stack_tracer_enabled
  244. ====================================
  245. See Documentation/trace/ftrace.rst.
  246. hardlockup_all_cpu_backtrace
  247. ============================
  248. This value controls the hard lockup detector behavior when a hard
  249. lockup condition is detected as to whether or not to gather further
  250. debug information. If enabled, arch-specific all-CPU stack dumping
  251. will be initiated.
  252. = ============================================
  253. 0 Do nothing. This is the default behavior.
  254. 1 On detection capture more debug information.
  255. = ============================================
  256. hardlockup_panic
  257. ================
  258. This parameter can be used to control whether the kernel panics
  259. when a hard lockup is detected.
  260. = ===========================
  261. 0 Don't panic on hard lockup.
  262. 1 Panic on hard lockup.
  263. = ===========================
  264. See Documentation/admin-guide/lockup-watchdogs.rst for more information.
  265. This can also be set using the nmi_watchdog kernel parameter.
  266. hotplug
  267. =======
  268. Path for the hotplug policy agent.
  269. Default value is ``CONFIG_UEVENT_HELPER_PATH``, which in turn defaults
  270. to the empty string.
  271. This file only exists when ``CONFIG_UEVENT_HELPER`` is enabled. Most
  272. modern systems rely exclusively on the netlink-based uevent source and
  273. don't need this.
  274. hung_task_all_cpu_backtrace
  275. ===========================
  276. If this option is set, the kernel will send an NMI to all CPUs to dump
  277. their backtraces when a hung task is detected. This file shows up if
  278. CONFIG_DETECT_HUNG_TASK and CONFIG_SMP are enabled.
  279. 0: Won't show all CPUs backtraces when a hung task is detected.
  280. This is the default behavior.
  281. 1: Will non-maskably interrupt all CPUs and dump their backtraces when
  282. a hung task is detected.
  283. hung_task_panic
  284. ===============
  285. When set to a non-zero value, a kernel panic will be triggered if the
  286. number of hung tasks found during a single scan reaches this value.
  287. This file shows up if ``CONFIG_DETECT_HUNG_TASK`` is enabled.
  288. = =======================================================
  289. 0 Continue operation. This is the default behavior.
  290. N Panic when N hung tasks are found during a single scan.
  291. = =======================================================
  292. hung_task_check_count
  293. =====================
  294. The upper bound on the number of tasks that are checked.
  295. This file shows up if ``CONFIG_DETECT_HUNG_TASK`` is enabled.
  296. hung_task_detect_count
  297. ======================
  298. Indicates the total number of tasks that have been detected as hung since
  299. the system boot.
  300. This file shows up if ``CONFIG_DETECT_HUNG_TASK`` is enabled.
  301. hung_task_sys_info
  302. ==================
  303. A comma separated list of extra system information to be dumped when
  304. hung task is detected, for example, "tasks,mem,timers,locks,...".
  305. Refer 'panic_sys_info' section below for more details.
  306. hung_task_timeout_secs
  307. ======================
  308. When a task in D state did not get scheduled
  309. for more than this value report a warning.
  310. This file shows up if ``CONFIG_DETECT_HUNG_TASK`` is enabled.
  311. 0 means infinite timeout, no checking is done.
  312. Possible values to set are in range {0:``LONG_MAX``/``HZ``}.
  313. hung_task_check_interval_secs
  314. =============================
  315. Hung task check interval. If hung task checking is enabled
  316. (see `hung_task_timeout_secs`_), the check is done every
  317. ``hung_task_check_interval_secs`` seconds.
  318. This file shows up if ``CONFIG_DETECT_HUNG_TASK`` is enabled.
  319. 0 (default) means use ``hung_task_timeout_secs`` as checking
  320. interval.
  321. Possible values to set are in range {0:``LONG_MAX``/``HZ``}.
  322. hung_task_warnings
  323. ==================
  324. The maximum number of warnings to report. During a check interval
  325. if a hung task is detected, this value is decreased by 1.
  326. When this value reaches 0, no more warnings will be reported.
  327. This file shows up if ``CONFIG_DETECT_HUNG_TASK`` is enabled.
  328. -1: report an infinite number of warnings.
  329. hyperv_record_panic_msg
  330. =======================
  331. Controls whether the panic kmsg data should be reported to Hyper-V.
  332. = =========================================================
  333. 0 Do not report panic kmsg data.
  334. 1 Report the panic kmsg data. This is the default behavior.
  335. = =========================================================
  336. ignore-unaligned-usertrap
  337. =========================
  338. On architectures where unaligned accesses cause traps, and where this
  339. feature is supported (``CONFIG_SYSCTL_ARCH_UNALIGN_NO_WARN``;
  340. currently, ``arc``, ``parisc`` and ``loongarch``), controls whether all
  341. unaligned traps are logged.
  342. = =============================================================
  343. 0 Log all unaligned accesses.
  344. 1 Only warn the first time a process traps. This is the default
  345. setting.
  346. = =============================================================
  347. See also `unaligned-trap`_.
  348. io_uring_disabled
  349. =================
  350. Prevents all processes from creating new io_uring instances. Enabling this
  351. shrinks the kernel's attack surface.
  352. = ======================================================================
  353. 0 All processes can create io_uring instances as normal. This is the
  354. default setting.
  355. 1 io_uring creation is disabled (io_uring_setup() will fail with
  356. -EPERM) for unprivileged processes not in the io_uring_group group.
  357. Existing io_uring instances can still be used. See the
  358. documentation for io_uring_group for more information.
  359. 2 io_uring creation is disabled for all processes. io_uring_setup()
  360. always fails with -EPERM. Existing io_uring instances can still be
  361. used.
  362. = ======================================================================
  363. io_uring_group
  364. ==============
  365. When io_uring_disabled is set to 1, a process must either be
  366. privileged (CAP_SYS_ADMIN) or be in the io_uring_group group in order
  367. to create an io_uring instance. If io_uring_group is set to -1 (the
  368. default), only processes with the CAP_SYS_ADMIN capability may create
  369. io_uring instances.
  370. kernel_sys_info
  371. ===============
  372. A comma separated list of extra system information to be dumped when
  373. soft/hard lockup is detected, for example, "tasks,mem,timers,locks,...".
  374. Refer 'panic_sys_info' section below for more details.
  375. It serves as the default kernel control knob, which will take effect
  376. when a kernel module calls sys_info() with parameter==0.
  377. kexec_load_disabled
  378. ===================
  379. A toggle indicating if the syscalls ``kexec_load`` and
  380. ``kexec_file_load`` have been disabled.
  381. This value defaults to 0 (false: ``kexec_*load`` enabled), but can be
  382. set to 1 (true: ``kexec_*load`` disabled).
  383. Once true, kexec can no longer be used, and the toggle cannot be set
  384. back to false.
  385. This allows a kexec image to be loaded before disabling the syscall,
  386. allowing a system to set up (and later use) an image without it being
  387. altered.
  388. Generally used together with the `modules_disabled`_ sysctl.
  389. kexec_load_limit_panic
  390. ======================
  391. This parameter specifies a limit to the number of times the syscalls
  392. ``kexec_load`` and ``kexec_file_load`` can be called with a crash
  393. image. It can only be set with a more restrictive value than the
  394. current one.
  395. == ======================================================
  396. -1 Unlimited calls to kexec. This is the default setting.
  397. N Number of calls left.
  398. == ======================================================
  399. kexec_load_limit_reboot
  400. =======================
  401. Similar functionality as ``kexec_load_limit_panic``, but for a normal
  402. image.
  403. kptr_restrict
  404. =============
  405. This toggle indicates whether restrictions are placed on
  406. exposing kernel addresses via ``/proc`` and other interfaces.
  407. When ``kptr_restrict`` is set to 0 (the default) the address is hashed
  408. before printing.
  409. (This is the equivalent to %p.)
  410. When ``kptr_restrict`` is set to 1, kernel pointers printed using the
  411. %pK format specifier will be replaced with 0s unless the user has
  412. ``CAP_SYSLOG`` and effective user and group ids are equal to the real
  413. ids.
  414. This is because %pK checks are done at read() time rather than open()
  415. time, so if permissions are elevated between the open() and the read()
  416. (e.g via a setuid binary) then %pK will not leak kernel pointers to
  417. unprivileged users.
  418. Note, this is a temporary solution only.
  419. The correct long-term solution is to do the permission checks at
  420. open() time.
  421. Consider removing world read permissions from files that use %pK, and
  422. using `dmesg_restrict`_ to protect against uses of %pK in ``dmesg(8)``
  423. if leaking kernel pointer values to unprivileged users is a concern.
  424. When ``kptr_restrict`` is set to 2, kernel pointers printed using
  425. %pK will be replaced with 0s regardless of privileges.
  426. For disabling these security restrictions early at boot time (and once
  427. for all), use the ``hash_pointers`` boot parameter instead.
  428. softlockup_sys_info & hardlockup_sys_info
  429. =========================================
  430. A comma separated list of extra system information to be dumped when
  431. soft/hard lockup is detected, for example, "tasks,mem,timers,locks,...".
  432. Refer 'panic_sys_info' section below for more details.
  433. modprobe
  434. ========
  435. The full path to the usermode helper for autoloading kernel modules,
  436. by default ``CONFIG_MODPROBE_PATH``, which in turn defaults to
  437. "/sbin/modprobe". This binary is executed when the kernel requests a
  438. module. For example, if userspace passes an unknown filesystem type
  439. to mount(), then the kernel will automatically request the
  440. corresponding filesystem module by executing this usermode helper.
  441. This usermode helper should insert the needed module into the kernel.
  442. This sysctl only affects module autoloading. It has no effect on the
  443. ability to explicitly insert modules.
  444. This sysctl can be used to debug module loading requests::
  445. echo '#! /bin/sh' > /tmp/modprobe
  446. echo 'echo "$@" >> /tmp/modprobe.log' >> /tmp/modprobe
  447. echo 'exec /sbin/modprobe "$@"' >> /tmp/modprobe
  448. chmod a+x /tmp/modprobe
  449. echo /tmp/modprobe > /proc/sys/kernel/modprobe
  450. Alternatively, if this sysctl is set to the empty string, then module
  451. autoloading is completely disabled. The kernel will not try to
  452. execute a usermode helper at all, nor will it call the
  453. kernel_module_request LSM hook.
  454. If CONFIG_STATIC_USERMODEHELPER=y is set in the kernel configuration,
  455. then the configured static usermode helper overrides this sysctl,
  456. except that the empty string is still accepted to completely disable
  457. module autoloading as described above.
  458. modules_disabled
  459. ================
  460. A toggle value indicating if modules are allowed to be loaded
  461. in an otherwise modular kernel. This toggle defaults to off
  462. (0), but can be set true (1). Once true, modules can be
  463. neither loaded nor unloaded, and the toggle cannot be set back
  464. to false. Generally used with the `kexec_load_disabled`_ toggle.
  465. .. _msgmni:
  466. msgmax, msgmnb, and msgmni
  467. ==========================
  468. ``msgmax`` is the maximum size of an IPC message, in bytes. 8192 by
  469. default (``MSGMAX``).
  470. ``msgmnb`` is the maximum size of an IPC queue, in bytes. 16384 by
  471. default (``MSGMNB``).
  472. ``msgmni`` is the maximum number of IPC queues. 32000 by default
  473. (``MSGMNI``).
  474. All of these parameters are set per ipc namespace. The maximum number of bytes
  475. in POSIX message queues is limited by ``RLIMIT_MSGQUEUE``. This limit is
  476. respected hierarchically in the each user namespace.
  477. msg_next_id, sem_next_id, and shm_next_id (System V IPC)
  478. ========================================================
  479. These three toggles allows to specify desired id for next allocated IPC
  480. object: message, semaphore or shared memory respectively.
  481. By default they are equal to -1, which means generic allocation logic.
  482. Possible values to set are in range {0:``INT_MAX``}.
  483. Notes:
  484. 1) kernel doesn't guarantee, that new object will have desired id. So,
  485. it's up to userspace, how to handle an object with "wrong" id.
  486. 2) Toggle with non-default value will be set back to -1 by kernel after
  487. successful IPC object allocation. If an IPC object allocation syscall
  488. fails, it is undefined if the value remains unmodified or is reset to -1.
  489. ngroups_max
  490. ===========
  491. Maximum number of supplementary groups, _i.e._ the maximum size which
  492. ``setgroups`` will accept. Exports ``NGROUPS_MAX`` from the kernel.
  493. nmi_watchdog
  494. ============
  495. This parameter can be used to control the NMI watchdog
  496. (i.e. the hard lockup detector) on x86 systems.
  497. = =================================
  498. 0 Disable the hard lockup detector.
  499. 1 Enable the hard lockup detector.
  500. = =================================
  501. The hard lockup detector monitors each CPU for its ability to respond to
  502. timer interrupts. The mechanism utilizes CPU performance counter registers
  503. that are programmed to generate Non-Maskable Interrupts (NMIs) periodically
  504. while a CPU is busy. Hence, the alternative name 'NMI watchdog'.
  505. The NMI watchdog is disabled by default if the kernel is running as a guest
  506. in a KVM virtual machine. This default can be overridden by adding::
  507. nmi_watchdog=1
  508. to the guest kernel command line (see
  509. Documentation/admin-guide/kernel-parameters.rst).
  510. nmi_wd_lpm_factor (PPC only)
  511. ============================
  512. Factor to apply to the NMI watchdog timeout (only when ``nmi_watchdog`` is
  513. set to 1). This factor represents the percentage added to
  514. ``watchdog_thresh`` when calculating the NMI watchdog timeout during an
  515. LPM. The soft lockup timeout is not impacted.
  516. A value of 0 means no change. The default value is 200 meaning the NMI
  517. watchdog is set to 30s (based on ``watchdog_thresh`` equal to 10).
  518. numa_balancing
  519. ==============
  520. Enables/disables and configures automatic page fault based NUMA memory
  521. balancing. Memory is moved automatically to nodes that access it often.
  522. The value to set can be the result of ORing the following:
  523. = =================================
  524. 0 NUMA_BALANCING_DISABLED
  525. 1 NUMA_BALANCING_NORMAL
  526. 2 NUMA_BALANCING_MEMORY_TIERING
  527. = =================================
  528. Or NUMA_BALANCING_NORMAL to optimize page placement among different
  529. NUMA nodes to reduce remote accessing. On NUMA machines, there is a
  530. performance penalty if remote memory is accessed by a CPU. When this
  531. feature is enabled the kernel samples what task thread is accessing
  532. memory by periodically unmapping pages and later trapping a page
  533. fault. At the time of the page fault, it is determined if the data
  534. being accessed should be migrated to a local memory node.
  535. The unmapping of pages and trapping faults incur additional overhead that
  536. ideally is offset by improved memory locality but there is no universal
  537. guarantee. If the target workload is already bound to NUMA nodes then this
  538. feature should be disabled.
  539. Or NUMA_BALANCING_MEMORY_TIERING to optimize page placement among
  540. different types of memory (represented as different NUMA nodes) to
  541. place the hot pages in the fast memory. This is implemented based on
  542. unmapping and page fault too.
  543. numa_balancing_promote_rate_limit_MBps
  544. ======================================
  545. Too high promotion/demotion throughput between different memory types
  546. may hurt application latency. This can be used to rate limit the
  547. promotion throughput. The per-node max promotion throughput in MB/s
  548. will be limited to be no more than the set value.
  549. A rule of thumb is to set this to less than 1/10 of the PMEM node
  550. write bandwidth.
  551. oops_all_cpu_backtrace
  552. ======================
  553. If this option is set, the kernel will send an NMI to all CPUs to dump
  554. their backtraces when an oops event occurs. It should be used as a last
  555. resort in case a panic cannot be triggered (to protect VMs running, for
  556. example) or kdump can't be collected. This file shows up if CONFIG_SMP
  557. is enabled.
  558. 0: Won't show all CPUs backtraces when an oops is detected.
  559. This is the default behavior.
  560. 1: Will non-maskably interrupt all CPUs and dump their backtraces when
  561. an oops event is detected.
  562. oops_limit
  563. ==========
  564. Number of kernel oopses after which the kernel should panic when
  565. ``panic_on_oops`` is not set. Setting this to 0 disables checking
  566. the count. Setting this to 1 has the same effect as setting
  567. ``panic_on_oops=1``. The default value is 10000.
  568. osrelease, ostype & version
  569. ===========================
  570. ::
  571. # cat osrelease
  572. 2.1.88
  573. # cat ostype
  574. Linux
  575. # cat version
  576. #5 Wed Feb 25 21:49:24 MET 1998
  577. The files ``osrelease`` and ``ostype`` should be clear enough.
  578. ``version``
  579. needs a little more clarification however. The '#5' means that
  580. this is the fifth kernel built from this source base and the
  581. date behind it indicates the time the kernel was built.
  582. The only way to tune these values is to rebuild the kernel :-)
  583. overflowgid & overflowuid
  584. =========================
  585. if your architecture did not always support 32-bit UIDs (i.e. arm,
  586. i386, m68k, sh, and sparc32), a fixed UID and GID will be returned to
  587. applications that use the old 16-bit UID/GID system calls, if the
  588. actual UID or GID would exceed 65535.
  589. These sysctls allow you to change the value of the fixed UID and GID.
  590. The default is 65534.
  591. panic
  592. =====
  593. The value in this file determines the behaviour of the kernel on a
  594. panic:
  595. * if zero, the kernel will loop forever;
  596. * if negative, the kernel will reboot immediately;
  597. * if positive, the kernel will reboot after the corresponding number
  598. of seconds.
  599. When you use the software watchdog, the recommended setting is 60.
  600. panic_on_io_nmi
  601. ===============
  602. Controls the kernel's behavior when a CPU receives an NMI caused by
  603. an IO error.
  604. = ==================================================================
  605. 0 Try to continue operation (default).
  606. 1 Panic immediately. The IO error triggered an NMI. This indicates a
  607. serious system condition which could result in IO data corruption.
  608. Rather than continuing, panicking might be a better choice. Some
  609. servers issue this sort of NMI when the dump button is pushed,
  610. and you can use this option to take a crash dump.
  611. = ==================================================================
  612. panic_on_oops
  613. =============
  614. Controls the kernel's behaviour when an oops or BUG is encountered.
  615. = ===================================================================
  616. 0 Try to continue operation.
  617. 1 Panic immediately. If the `panic` sysctl is also non-zero then the
  618. machine will be rebooted.
  619. = ===================================================================
  620. panic_on_stackoverflow
  621. ======================
  622. Controls the kernel's behavior when detecting the overflows of
  623. kernel, IRQ and exception stacks except a user stack.
  624. This file shows up if ``CONFIG_DEBUG_STACKOVERFLOW`` is enabled.
  625. = ==========================
  626. 0 Try to continue operation.
  627. 1 Panic immediately.
  628. = ==========================
  629. panic_on_unrecovered_nmi
  630. ========================
  631. The default Linux behaviour on an NMI of either memory or unknown is
  632. to continue operation. For many environments such as scientific
  633. computing it is preferable that the box is taken out and the error
  634. dealt with than an uncorrected parity/ECC error get propagated.
  635. A small number of systems do generate NMIs for bizarre random reasons
  636. such as power management so the default is off. That sysctl works like
  637. the existing panic controls already in that directory.
  638. panic_on_warn
  639. =============
  640. Calls panic() in the WARN() path when set to 1. This is useful to avoid
  641. a kernel rebuild when attempting to kdump at the location of a WARN().
  642. = ================================================
  643. 0 Only WARN(), default behaviour.
  644. 1 Call panic() after printing out WARN() location.
  645. = ================================================
  646. panic_print
  647. ===========
  648. Bitmask for printing system info when panic happens. User can chose
  649. combination of the following bits:
  650. ===== ============================================
  651. bit 0 print all tasks info
  652. bit 1 print system memory info
  653. bit 2 print timer info
  654. bit 3 print locks info if ``CONFIG_LOCKDEP`` is on
  655. bit 4 print ftrace buffer
  656. bit 5 replay all kernel messages on consoles at the end of panic
  657. bit 6 print all CPUs backtrace (if available in the arch)
  658. bit 7 print only tasks in uninterruptible (blocked) state
  659. ===== ============================================
  660. So for example to print tasks and memory info on panic, user can::
  661. echo 3 > /proc/sys/kernel/panic_print
  662. panic_sys_info
  663. ==============
  664. A comma separated list of extra information to be dumped on panic,
  665. for example, "tasks,mem,timers,...". It is a human readable alternative
  666. to 'panic_print'. Possible values are:
  667. ============= ===================================================
  668. tasks print all tasks info
  669. mem print system memory info
  670. timers print timers info
  671. locks print locks info if CONFIG_LOCKDEP is on
  672. ftrace print ftrace buffer
  673. all_bt print all CPUs backtrace (if available in the arch)
  674. blocked_tasks print only tasks in uninterruptible (blocked) state
  675. ============= ===================================================
  676. panic_on_rcu_stall
  677. ==================
  678. When set to 1, calls panic() after RCU stall detection messages. This
  679. is useful to define the root cause of RCU stalls using a vmcore.
  680. = ============================================================
  681. 0 Do not panic() when RCU stall takes place, default behavior.
  682. 1 panic() after printing RCU stall messages.
  683. = ============================================================
  684. max_rcu_stall_to_panic
  685. ======================
  686. When ``panic_on_rcu_stall`` is set to 1, this value determines the
  687. number of times that RCU can stall before panic() is called.
  688. When ``panic_on_rcu_stall`` is set to 0, this value is has no effect.
  689. perf_cpu_time_max_percent
  690. =========================
  691. Hints to the kernel how much CPU time it should be allowed to
  692. use to handle perf sampling events. If the perf subsystem
  693. is informed that its samples are exceeding this limit, it
  694. will drop its sampling frequency to attempt to reduce its CPU
  695. usage.
  696. Some perf sampling happens in NMIs. If these samples
  697. unexpectedly take too long to execute, the NMIs can become
  698. stacked up next to each other so much that nothing else is
  699. allowed to execute.
  700. ===== ========================================================
  701. 0 Disable the mechanism. Do not monitor or correct perf's
  702. sampling rate no matter how CPU time it takes.
  703. 1-100 Attempt to throttle perf's sample rate to this
  704. percentage of CPU. Note: the kernel calculates an
  705. "expected" length of each sample event. 100 here means
  706. 100% of that expected length. Even if this is set to
  707. 100, you may still see sample throttling if this
  708. length is exceeded. Set to 0 if you truly do not care
  709. how much CPU is consumed.
  710. ===== ========================================================
  711. perf_event_paranoid
  712. ===================
  713. Controls use of the performance events system by unprivileged
  714. users (without CAP_PERFMON). The default value is 2.
  715. For backward compatibility reasons access to system performance
  716. monitoring and observability remains open for CAP_SYS_ADMIN
  717. privileged processes but CAP_SYS_ADMIN usage for secure system
  718. performance monitoring and observability operations is discouraged
  719. with respect to CAP_PERFMON use cases.
  720. === ==================================================================
  721. -1 Allow use of (almost) all events by all users.
  722. Ignore mlock limit after perf_event_mlock_kb without
  723. ``CAP_IPC_LOCK``.
  724. >=0 Disallow ftrace function tracepoint by users without
  725. ``CAP_PERFMON``.
  726. Disallow raw tracepoint access by users without ``CAP_PERFMON``.
  727. >=1 Disallow CPU event access by users without ``CAP_PERFMON``.
  728. >=2 Disallow kernel profiling by users without ``CAP_PERFMON``.
  729. === ==================================================================
  730. perf_event_max_stack
  731. ====================
  732. Controls maximum number of stack frames to copy for (``attr.sample_type &
  733. PERF_SAMPLE_CALLCHAIN``) configured events, for instance, when using
  734. '``perf record -g``' or '``perf trace --call-graph fp``'.
  735. This can only be done when no events are in use that have callchains
  736. enabled, otherwise writing to this file will return ``-EBUSY``.
  737. The default value is 127.
  738. perf_event_mlock_kb
  739. ===================
  740. Control size of per-cpu ring buffer not counted against mlock limit.
  741. The default value is 512 + 1 page
  742. perf_event_max_contexts_per_stack
  743. =================================
  744. Controls maximum number of stack frame context entries for
  745. (``attr.sample_type & PERF_SAMPLE_CALLCHAIN``) configured events, for
  746. instance, when using '``perf record -g``' or '``perf trace --call-graph fp``'.
  747. This can only be done when no events are in use that have callchains
  748. enabled, otherwise writing to this file will return ``-EBUSY``.
  749. The default value is 8.
  750. perf_user_access (arm64 and riscv only)
  751. =======================================
  752. Controls user space access for reading perf event counters.
  753. * for arm64
  754. The default value is 0 (access disabled).
  755. When set to 1, user space can read performance monitor counter registers
  756. directly.
  757. See Documentation/arch/arm64/perf.rst for more information.
  758. * for riscv
  759. When set to 0, user space access is disabled.
  760. The default value is 1, user space can read performance monitor counter
  761. registers through perf, any direct access without perf intervention will trigger
  762. an illegal instruction.
  763. When set to 2, which enables legacy mode (user space has direct access to cycle
  764. and insret CSRs only). Note that this legacy value is deprecated and will be
  765. removed once all user space applications are fixed.
  766. Note that the time CSR is always directly accessible to all modes.
  767. pid_max
  768. =======
  769. PID allocation wrap value. When the kernel's next PID value
  770. reaches this value, it wraps back to a minimum PID value.
  771. PIDs of value ``pid_max`` or larger are not allocated.
  772. ns_last_pid
  773. ===========
  774. The last pid allocated in the current (the one task using this sysctl
  775. lives in) pid namespace. When selecting a pid for a next task on fork
  776. kernel tries to allocate a number starting from this one.
  777. powersave-nap (PPC only)
  778. ========================
  779. If set, Linux-PPC will use the 'nap' mode of powersaving,
  780. otherwise the 'doze' mode will be used.
  781. ==============================================================
  782. printk
  783. ======
  784. The four values in printk denote: ``console_loglevel``,
  785. ``default_message_loglevel``, ``minimum_console_loglevel`` and
  786. ``default_console_loglevel`` respectively.
  787. These values influence printk() behavior when printing or
  788. logging error messages. See '``man 2 syslog``' for more info on
  789. the different loglevels.
  790. ======================== =====================================
  791. console_loglevel messages with a higher priority than
  792. this will be printed to the console
  793. default_message_loglevel messages without an explicit priority
  794. will be printed with this priority
  795. minimum_console_loglevel minimum (highest) value to which
  796. console_loglevel can be set
  797. default_console_loglevel default value for console_loglevel
  798. ======================== =====================================
  799. printk_delay
  800. ============
  801. Delay each printk message in ``printk_delay`` milliseconds
  802. Value from 0 - 10000 is allowed.
  803. printk_ratelimit
  804. ================
  805. Some warning messages are rate limited. ``printk_ratelimit`` specifies
  806. the minimum length of time between these messages (in seconds).
  807. The default value is 5 seconds.
  808. A value of 0 will disable rate limiting.
  809. printk_ratelimit_burst
  810. ======================
  811. While long term we enforce one message per `printk_ratelimit`_
  812. seconds, we do allow a burst of messages to pass through.
  813. ``printk_ratelimit_burst`` specifies the number of messages we can
  814. send before ratelimiting kicks in. After `printk_ratelimit`_ seconds
  815. have elapsed, another burst of messages may be sent.
  816. The default value is 10 messages.
  817. printk_devkmsg
  818. ==============
  819. Control the logging to ``/dev/kmsg`` from userspace:
  820. ========= =============================================
  821. ratelimit default, ratelimited
  822. on unlimited logging to /dev/kmsg from userspace
  823. off logging to /dev/kmsg disabled
  824. ========= =============================================
  825. The kernel command line parameter ``printk.devkmsg=`` overrides this and is
  826. a one-time setting until next reboot: once set, it cannot be changed by
  827. this sysctl interface anymore.
  828. ==============================================================
  829. pty
  830. ===
  831. See Documentation/filesystems/devpts.rst.
  832. random
  833. ======
  834. This is a directory, with the following entries:
  835. * ``boot_id``: a UUID generated the first time this is retrieved, and
  836. unvarying after that;
  837. * ``uuid``: a UUID generated every time this is retrieved (this can
  838. thus be used to generate UUIDs at will);
  839. * ``entropy_avail``: the pool's entropy count, in bits;
  840. * ``poolsize``: the entropy pool size, in bits;
  841. * ``urandom_min_reseed_secs``: obsolete (used to determine the minimum
  842. number of seconds between urandom pool reseeding). This file is
  843. writable for compatibility purposes, but writing to it has no effect
  844. on any RNG behavior;
  845. * ``write_wakeup_threshold``: when the entropy count drops below this
  846. (as a number of bits), processes waiting to write to ``/dev/random``
  847. are woken up. This file is writable for compatibility purposes, but
  848. writing to it has no effect on any RNG behavior.
  849. randomize_va_space
  850. ==================
  851. This option can be used to select the type of process address
  852. space randomization that is used in the system, for architectures
  853. that support this feature.
  854. == ===========================================================================
  855. 0 Turn the process address space randomization off. This is the
  856. default for architectures that do not support this feature anyways,
  857. and kernels that are booted with the "norandmaps" parameter.
  858. 1 Make the addresses of mmap base, stack and VDSO page randomized.
  859. This, among other things, implies that shared libraries will be
  860. loaded to random addresses. Also for PIE-linked binaries, the
  861. location of code start is randomized. This is the default if the
  862. ``CONFIG_COMPAT_BRK`` option is enabled.
  863. 2 Additionally enable heap randomization. This is the default if
  864. ``CONFIG_COMPAT_BRK`` is disabled.
  865. There are a few legacy applications out there (such as some ancient
  866. versions of libc.so.5 from 1996) that assume that brk area starts
  867. just after the end of the code+bss. These applications break when
  868. start of the brk area is randomized. There are however no known
  869. non-legacy applications that would be broken this way, so for most
  870. systems it is safe to choose full randomization.
  871. Systems with ancient and/or broken binaries should be configured
  872. with ``CONFIG_COMPAT_BRK`` enabled, which excludes the heap from process
  873. address space randomization.
  874. == ===========================================================================
  875. reboot-cmd (SPARC only)
  876. =======================
  877. ??? This seems to be a way to give an argument to the Sparc
  878. ROM/Flash boot loader. Maybe to tell it what to do after
  879. rebooting. ???
  880. sched_energy_aware
  881. ==================
  882. Enables/disables Energy Aware Scheduling (EAS). EAS starts
  883. automatically on platforms where it can run (that is,
  884. platforms with asymmetric CPU topologies and having an Energy
  885. Model available). If your platform happens to meet the
  886. requirements for EAS but you do not want to use it, change
  887. this value to 0. On Non-EAS platforms, write operation fails and
  888. read doesn't return anything.
  889. task_delayacct
  890. ===============
  891. Enables/disables task delay accounting (see
  892. Documentation/accounting/delay-accounting.rst. Enabling this feature incurs
  893. a small amount of overhead in the scheduler but is useful for debugging
  894. and performance tuning. It is required by some tools such as iotop.
  895. sched_schedstats
  896. ================
  897. Enables/disables scheduler statistics. Enabling this feature
  898. incurs a small amount of overhead in the scheduler but is
  899. useful for debugging and performance tuning.
  900. sched_util_clamp_min
  901. ====================
  902. Max allowed *minimum* utilization.
  903. Default value is 1024, which is the maximum possible value.
  904. It means that any requested uclamp.min value cannot be greater than
  905. sched_util_clamp_min, i.e., it is restricted to the range
  906. [0:sched_util_clamp_min].
  907. sched_util_clamp_max
  908. ====================
  909. Max allowed *maximum* utilization.
  910. Default value is 1024, which is the maximum possible value.
  911. It means that any requested uclamp.max value cannot be greater than
  912. sched_util_clamp_max, i.e., it is restricted to the range
  913. [0:sched_util_clamp_max].
  914. sched_util_clamp_min_rt_default
  915. ===============================
  916. By default Linux is tuned for performance. Which means that RT tasks always run
  917. at the highest frequency and most capable (highest capacity) CPU (in
  918. heterogeneous systems).
  919. Uclamp achieves this by setting the requested uclamp.min of all RT tasks to
  920. 1024 by default, which effectively boosts the tasks to run at the highest
  921. frequency and biases them to run on the biggest CPU.
  922. This knob allows admins to change the default behavior when uclamp is being
  923. used. In battery powered devices particularly, running at the maximum
  924. capacity and frequency will increase energy consumption and shorten the battery
  925. life.
  926. This knob is only effective for RT tasks which the user hasn't modified their
  927. requested uclamp.min value via sched_setattr() syscall.
  928. This knob will not escape the range constraint imposed by sched_util_clamp_min
  929. defined above.
  930. For example if
  931. sched_util_clamp_min_rt_default = 800
  932. sched_util_clamp_min = 600
  933. Then the boost will be clamped to 600 because 800 is outside of the permissible
  934. range of [0:600]. This could happen for instance if a powersave mode will
  935. restrict all boosts temporarily by modifying sched_util_clamp_min. As soon as
  936. this restriction is lifted, the requested sched_util_clamp_min_rt_default
  937. will take effect.
  938. seccomp
  939. =======
  940. See Documentation/userspace-api/seccomp_filter.rst.
  941. sg-big-buff
  942. ===========
  943. This file shows the size of the generic SCSI (sg) buffer.
  944. You can't tune it just yet, but you could change it on
  945. compile time by editing ``include/scsi/sg.h`` and changing
  946. the value of ``SG_BIG_BUFF``.
  947. There shouldn't be any reason to change this value. If
  948. you can come up with one, you probably know what you
  949. are doing anyway :)
  950. shmall
  951. ======
  952. This parameter sets the total amount of shared memory pages that can be used
  953. inside ipc namespace. The shared memory pages counting occurs for each ipc
  954. namespace separately and is not inherited. Hence, ``shmall`` should always be at
  955. least ``ceil(shmmax/PAGE_SIZE)``.
  956. If you are not sure what the default ``PAGE_SIZE`` is on your Linux
  957. system, you can run the following command::
  958. # getconf PAGE_SIZE
  959. To reduce or disable the ability to allocate shared memory, you must create a
  960. new ipc namespace, set this parameter to the required value and prohibit the
  961. creation of a new ipc namespace in the current user namespace or cgroups can
  962. be used.
  963. shmmax
  964. ======
  965. This value can be used to query and set the run time limit
  966. on the maximum shared memory segment size that can be created.
  967. Shared memory segments up to 1Gb are now supported in the
  968. kernel. This value defaults to ``SHMMAX``.
  969. shmmni
  970. ======
  971. This value determines the maximum number of shared memory segments.
  972. 4096 by default (``SHMMNI``).
  973. shm_rmid_forced
  974. ===============
  975. Linux lets you set resource limits, including how much memory one
  976. process can consume, via ``setrlimit(2)``. Unfortunately, shared memory
  977. segments are allowed to exist without association with any process, and
  978. thus might not be counted against any resource limits. If enabled,
  979. shared memory segments are automatically destroyed when their attach
  980. count becomes zero after a detach or a process termination. It will
  981. also destroy segments that were created, but never attached to, on exit
  982. from the process. The only use left for ``IPC_RMID`` is to immediately
  983. destroy an unattached segment. Of course, this breaks the way things are
  984. defined, so some applications might stop working. Note that this
  985. feature will do you no good unless you also configure your resource
  986. limits (in particular, ``RLIMIT_AS`` and ``RLIMIT_NPROC``). Most systems don't
  987. need this.
  988. Note that if you change this from 0 to 1, already created segments
  989. without users and with a dead originative process will be destroyed.
  990. sysctl_writes_strict
  991. ====================
  992. Control how file position affects the behavior of updating sysctl values
  993. via the ``/proc/sys`` interface:
  994. == ======================================================================
  995. -1 Legacy per-write sysctl value handling, with no printk warnings.
  996. Each write syscall must fully contain the sysctl value to be
  997. written, and multiple writes on the same sysctl file descriptor
  998. will rewrite the sysctl value, regardless of file position.
  999. 0 Same behavior as above, but warn about processes that perform writes
  1000. to a sysctl file descriptor when the file position is not 0.
  1001. 1 (default) Respect file position when writing sysctl strings. Multiple
  1002. writes will append to the sysctl value buffer. Anything past the max
  1003. length of the sysctl value buffer will be ignored. Writes to numeric
  1004. sysctl entries must always be at file position 0 and the value must
  1005. be fully contained in the buffer sent in the write syscall.
  1006. == ======================================================================
  1007. softlockup_all_cpu_backtrace
  1008. ============================
  1009. This value controls the soft lockup detector thread's behavior
  1010. when a soft lockup condition is detected as to whether or not
  1011. to gather further debug information. If enabled, each cpu will
  1012. be issued an NMI and instructed to capture stack trace.
  1013. This feature is only applicable for architectures which support
  1014. NMI.
  1015. = ============================================
  1016. 0 Do nothing. This is the default behavior.
  1017. 1 On detection capture more debug information.
  1018. = ============================================
  1019. softlockup_panic
  1020. =================
  1021. This parameter can be used to control whether the kernel panics
  1022. when a soft lockup is detected.
  1023. = ============================================
  1024. 0 Don't panic on soft lockup.
  1025. 1 Panic on soft lockup.
  1026. = ============================================
  1027. This can also be set using the softlockup_panic kernel parameter.
  1028. soft_watchdog
  1029. =============
  1030. This parameter can be used to control the soft lockup detector.
  1031. = =================================
  1032. 0 Disable the soft lockup detector.
  1033. 1 Enable the soft lockup detector.
  1034. = =================================
  1035. The soft lockup detector monitors CPUs for threads that are hogging the CPUs
  1036. without rescheduling voluntarily, and thus prevent the 'migration/N' threads
  1037. from running, causing the watchdog work fail to execute. The mechanism depends
  1038. on the CPUs ability to respond to timer interrupts which are needed for the
  1039. watchdog work to be queued by the watchdog timer function, otherwise the NMI
  1040. watchdog — if enabled — can detect a hard lockup condition.
  1041. split_lock_mitigate (x86 only)
  1042. ==============================
  1043. On x86, each "split lock" imposes a system-wide performance penalty. On larger
  1044. systems, large numbers of split locks from unprivileged users can result in
  1045. denials of service to well-behaved and potentially more important users.
  1046. The kernel mitigates these bad users by detecting split locks and imposing
  1047. penalties: forcing them to wait and only allowing one core to execute split
  1048. locks at a time.
  1049. These mitigations can make those bad applications unbearably slow. Setting
  1050. split_lock_mitigate=0 may restore some application performance, but will also
  1051. increase system exposure to denial of service attacks from split lock users.
  1052. = ===================================================================
  1053. 0 Disable the mitigation mode - just warns the split lock on kernel log
  1054. and exposes the system to denials of service from the split lockers.
  1055. 1 Enable the mitigation mode (this is the default) - penalizes the split
  1056. lockers with intentional performance degradation.
  1057. = ===================================================================
  1058. stack_erasing
  1059. =============
  1060. This parameter can be used to control kernel stack erasing at the end
  1061. of syscalls for kernels built with ``CONFIG_KSTACK_ERASE``.
  1062. That erasing reduces the information which kernel stack leak bugs
  1063. can reveal and blocks some uninitialized stack variable attacks.
  1064. The tradeoff is the performance impact: on a single CPU system kernel
  1065. compilation sees a 1% slowdown, other systems and workloads may vary.
  1066. = ====================================================================
  1067. 0 Kernel stack erasing is disabled, KSTACK_ERASE_METRICS are not updated.
  1068. 1 Kernel stack erasing is enabled (default), it is performed before
  1069. returning to the userspace at the end of syscalls.
  1070. = ====================================================================
  1071. stop-a (SPARC only)
  1072. ===================
  1073. Controls Stop-A:
  1074. = ====================================
  1075. 0 Stop-A has no effect.
  1076. 1 Stop-A breaks to the PROM (default).
  1077. = ====================================
  1078. Stop-A is always enabled on a panic, so that the user can return to
  1079. the boot PROM.
  1080. sysrq
  1081. =====
  1082. See Documentation/admin-guide/sysrq.rst.
  1083. tainted
  1084. =======
  1085. Non-zero if the kernel has been tainted. Numeric values, which can be
  1086. ORed together. The letters are seen in "Tainted" line of Oops reports.
  1087. ====== ===== ==============================================================
  1088. 1 `(P)` proprietary module was loaded
  1089. 2 `(F)` module was force loaded
  1090. 4 `(S)` kernel running on an out of specification system
  1091. 8 `(R)` module was force unloaded
  1092. 16 `(M)` processor reported a Machine Check Exception (MCE)
  1093. 32 `(B)` bad page referenced or some unexpected page flags
  1094. 64 `(U)` taint requested by userspace application
  1095. 128 `(D)` kernel died recently, i.e. there was an OOPS or BUG
  1096. 256 `(A)` an ACPI table was overridden by user
  1097. 512 `(W)` kernel issued warning
  1098. 1024 `(C)` staging driver was loaded
  1099. 2048 `(I)` workaround for bug in platform firmware applied
  1100. 4096 `(O)` externally-built ("out-of-tree") module was loaded
  1101. 8192 `(E)` unsigned module was loaded
  1102. 16384 `(L)` soft lockup occurred
  1103. 32768 `(K)` kernel has been live patched
  1104. 65536 `(X)` Auxiliary taint, defined and used by for distros
  1105. 131072 `(T)` The kernel was built with the struct randomization plugin
  1106. ====== ===== ==============================================================
  1107. See Documentation/admin-guide/tainted-kernels.rst for more information.
  1108. Note:
  1109. writes to this sysctl interface will fail with ``EINVAL`` if the kernel is
  1110. booted with the command line option ``panic_on_taint=<bitmask>,nousertaint``
  1111. and any of the ORed together values being written to ``tainted`` match with
  1112. the bitmask declared on panic_on_taint.
  1113. See Documentation/admin-guide/kernel-parameters.rst for more details on
  1114. that particular kernel command line option and its optional
  1115. ``nousertaint`` switch.
  1116. threads-max
  1117. ===========
  1118. This value controls the maximum number of threads that can be created
  1119. using ``fork()``.
  1120. During initialization the kernel sets this value such that even if the
  1121. maximum number of threads is created, the thread structures occupy only
  1122. a part (1/8th) of the available RAM pages.
  1123. The minimum value that can be written to ``threads-max`` is 1.
  1124. The maximum value that can be written to ``threads-max`` is given by the
  1125. constant ``FUTEX_TID_MASK`` (0x3fffffff).
  1126. If a value outside of this range is written to ``threads-max`` an
  1127. ``EINVAL`` error occurs.
  1128. timer_migration
  1129. ===============
  1130. When set to a non-zero value, attempt to migrate timers away from idle cpus to
  1131. allow them to remain in low power states longer.
  1132. Default is set (1).
  1133. traceoff_on_warning
  1134. ===================
  1135. When set, disables tracing (see Documentation/trace/ftrace.rst) when a
  1136. ``WARN()`` is hit.
  1137. tracepoint_printk
  1138. =================
  1139. When tracepoints are sent to printk() (enabled by the ``tp_printk``
  1140. boot parameter), this entry provides runtime control::
  1141. echo 0 > /proc/sys/kernel/tracepoint_printk
  1142. will stop tracepoints from being sent to printk(), and::
  1143. echo 1 > /proc/sys/kernel/tracepoint_printk
  1144. will send them to printk() again.
  1145. This only works if the kernel was booted with ``tp_printk`` enabled.
  1146. See Documentation/admin-guide/kernel-parameters.rst and
  1147. Documentation/trace/boottime-trace.rst.
  1148. unaligned-trap
  1149. ==============
  1150. On architectures where unaligned accesses cause traps, and where this
  1151. feature is supported (``CONFIG_SYSCTL_ARCH_UNALIGN_ALLOW``; currently,
  1152. ``arc``, ``parisc`` and ``loongarch``), controls whether unaligned traps
  1153. are caught and emulated (instead of failing).
  1154. = ========================================================
  1155. 0 Do not emulate unaligned accesses.
  1156. 1 Emulate unaligned accesses. This is the default setting.
  1157. = ========================================================
  1158. See also `ignore-unaligned-usertrap`_.
  1159. unknown_nmi_panic
  1160. =================
  1161. The value in this file affects behavior of handling NMI. When the
  1162. value is non-zero, unknown NMI is trapped and then panic occurs. At
  1163. that time, kernel debugging information is displayed on console.
  1164. NMI switch that most IA32 servers have fires unknown NMI up, for
  1165. example. If a system hangs up, try pressing the NMI switch.
  1166. unprivileged_bpf_disabled
  1167. =========================
  1168. Writing 1 to this entry will disable unprivileged calls to ``bpf()``;
  1169. once disabled, calling ``bpf()`` without ``CAP_SYS_ADMIN`` or ``CAP_BPF``
  1170. will return ``-EPERM``. Once set to 1, this can't be cleared from the
  1171. running kernel anymore.
  1172. Writing 2 to this entry will also disable unprivileged calls to ``bpf()``,
  1173. however, an admin can still change this setting later on, if needed, by
  1174. writing 0 or 1 to this entry.
  1175. If ``BPF_UNPRIV_DEFAULT_OFF`` is enabled in the kernel config, then this
  1176. entry will default to 2 instead of 0.
  1177. = =============================================================
  1178. 0 Unprivileged calls to ``bpf()`` are enabled
  1179. 1 Unprivileged calls to ``bpf()`` are disabled without recovery
  1180. 2 Unprivileged calls to ``bpf()`` are disabled
  1181. = =============================================================
  1182. warn_limit
  1183. ==========
  1184. Number of kernel warnings after which the kernel should panic when
  1185. ``panic_on_warn`` is not set. Setting this to 0 disables checking
  1186. the warning count. Setting this to 1 has the same effect as setting
  1187. ``panic_on_warn=1``. The default value is 0.
  1188. watchdog
  1189. ========
  1190. This parameter can be used to disable or enable the soft lockup detector
  1191. *and* the NMI watchdog (i.e. the hard lockup detector) at the same time.
  1192. = ==============================
  1193. 0 Disable both lockup detectors.
  1194. 1 Enable both lockup detectors.
  1195. = ==============================
  1196. The soft lockup detector and the NMI watchdog can also be disabled or
  1197. enabled individually, using the ``soft_watchdog`` and ``nmi_watchdog``
  1198. parameters.
  1199. If the ``watchdog`` parameter is read, for example by executing::
  1200. cat /proc/sys/kernel/watchdog
  1201. the output of this command (0 or 1) shows the logical OR of
  1202. ``soft_watchdog`` and ``nmi_watchdog``.
  1203. watchdog_cpumask
  1204. ================
  1205. This value can be used to control on which cpus the watchdog may run.
  1206. The default cpumask is all possible cores, but if ``NO_HZ_FULL`` is
  1207. enabled in the kernel config, and cores are specified with the
  1208. ``nohz_full=`` boot argument, those cores are excluded by default.
  1209. Offline cores can be included in this mask, and if the core is later
  1210. brought online, the watchdog will be started based on the mask value.
  1211. Typically this value would only be touched in the ``nohz_full`` case
  1212. to re-enable cores that by default were not running the watchdog,
  1213. if a kernel lockup was suspected on those cores.
  1214. The argument value is the standard cpulist format for cpumasks,
  1215. so for example to enable the watchdog on cores 0, 2, 3, and 4 you
  1216. might say::
  1217. echo 0,2-4 > /proc/sys/kernel/watchdog_cpumask
  1218. watchdog_thresh
  1219. ===============
  1220. This value can be used to control the frequency of hrtimer and NMI
  1221. events and the soft and hard lockup thresholds. The default threshold
  1222. is 10 seconds.
  1223. The softlockup threshold is (``2 * watchdog_thresh``). Setting this
  1224. tunable to zero will disable lockup detection altogether.