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