Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | Documentation for /proc/sys/kernel/* kernel version 2.2.10 |
2 | (c) 1998, 1999, Rik van Riel <riel@nl.linux.org> | |
760df93e | 3 | (c) 2009, Shen Feng<shen@cn.fujitsu.com> |
1da177e4 LT |
4 | |
5 | For general info and legal blurb, please look in README. | |
6 | ||
7 | ============================================================== | |
8 | ||
9 | This file contains documentation for the sysctl files in | |
10 | /proc/sys/kernel/ and is valid for Linux kernel version 2.2. | |
11 | ||
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 | ||
18 | Currently, these files might (depending on your configuration) | |
19 | show up in /proc/sys/kernel: | |
807094c0 | 20 | |
1da177e4 | 21 | - acct |
807094c0 BP |
22 | - acpi_video_flags |
23 | - auto_msgmni | |
d75757ab PA |
24 | - bootloader_type [ X86 only ] |
25 | - bootloader_version [ X86 only ] | |
c114728a | 26 | - callhome [ S390 only ] |
73efc039 | 27 | - cap_last_cap |
1da177e4 | 28 | - core_pattern |
a293980c | 29 | - core_pipe_limit |
1da177e4 LT |
30 | - core_uses_pid |
31 | - ctrl-alt-del | |
eaf06b24 | 32 | - dmesg_restrict |
1da177e4 LT |
33 | - domainname |
34 | - hostname | |
35 | - hotplug | |
55537871 | 36 | - hardlockup_all_cpu_backtrace |
270750db AT |
37 | - hung_task_panic |
38 | - hung_task_check_count | |
39 | - hung_task_timeout_secs | |
40 | - hung_task_warnings | |
7984754b | 41 | - kexec_load_disabled |
455cd5ab | 42 | - kptr_restrict |
0741f4d2 | 43 | - kstack_depth_to_print [ X86 only ] |
1da177e4 | 44 | - l2cr [ PPC only ] |
ac76cff2 | 45 | - modprobe ==> Documentation/debugging-modules.txt |
3d43321b | 46 | - modules_disabled |
03f59566 | 47 | - msg_next_id [ sysv ipc ] |
1da177e4 LT |
48 | - msgmax |
49 | - msgmnb | |
50 | - msgmni | |
760df93e | 51 | - nmi_watchdog |
1da177e4 LT |
52 | - osrelease |
53 | - ostype | |
54 | - overflowgid | |
55 | - overflowuid | |
56 | - panic | |
807094c0 | 57 | - panic_on_oops |
55af7796 | 58 | - panic_on_stackoverflow |
9e3961a0 PB |
59 | - panic_on_unrecovered_nmi |
60 | - panic_on_warn | |
3379e0c3 BH |
61 | - perf_cpu_time_max_percent |
62 | - perf_event_paranoid | |
1da177e4 LT |
63 | - pid_max |
64 | - powersave-nap [ PPC only ] | |
65 | - printk | |
807094c0 BP |
66 | - printk_delay |
67 | - printk_ratelimit | |
68 | - printk_ratelimit_burst | |
8b253b07 | 69 | - pty ==> Documentation/filesystems/devpts.txt |
1ec7fd50 | 70 | - randomize_va_space |
1da177e4 LT |
71 | - real-root-dev ==> Documentation/initrd.txt |
72 | - reboot-cmd [ SPARC only ] | |
73 | - rtsig-max | |
74 | - rtsig-nr | |
75 | - sem | |
03f59566 | 76 | - sem_next_id [ sysv ipc ] |
1da177e4 | 77 | - sg-big-buff [ generic SCSI device (sg) ] |
03f59566 | 78 | - shm_next_id [ sysv ipc ] |
b34a6b1d | 79 | - shm_rmid_forced |
1da177e4 LT |
80 | - shmall |
81 | - shmmax [ sysv ipc ] | |
82 | - shmmni | |
ed235875 | 83 | - softlockup_all_cpu_backtrace |
195daf66 | 84 | - soft_watchdog |
1da177e4 LT |
85 | - stop-a [ SPARC only ] |
86 | - sysrq ==> Documentation/sysrq.txt | |
f4aacea2 | 87 | - sysctl_writes_strict |
1da177e4 LT |
88 | - tainted |
89 | - threads-max | |
760df93e | 90 | - unknown_nmi_panic |
195daf66 | 91 | - watchdog |
08825c90 | 92 | - watchdog_thresh |
1da177e4 LT |
93 | - version |
94 | ||
95 | ============================================================== | |
96 | ||
97 | acct: | |
98 | ||
99 | highwater lowwater frequency | |
100 | ||
101 | If BSD-style process accounting is enabled these values control | |
102 | its behaviour. If free space on filesystem where the log lives | |
103 | goes below <lowwater>% accounting suspends. If free space gets | |
104 | above <highwater>% accounting resumes. <Frequency> determines | |
105 | how often do we check the amount of free space (value is in | |
106 | seconds). Default: | |
107 | 4 2 30 | |
108 | That is, suspend accounting if there left <= 2% free; resume it | |
109 | if we got >=4%; consider information about amount of free space | |
110 | valid for 30 seconds. | |
111 | ||
807094c0 BP |
112 | ============================================================== |
113 | ||
114 | acpi_video_flags: | |
115 | ||
116 | flags | |
117 | ||
118 | See Doc*/kernel/power/video.txt, it allows mode of video boot to be | |
119 | set during run time. | |
120 | ||
121 | ============================================================== | |
122 | ||
123 | auto_msgmni: | |
124 | ||
0050ee05 MS |
125 | This variable has no effect and may be removed in future kernel |
126 | releases. Reading it always returns 0. | |
127 | Up to Linux 3.17, it enabled/disabled automatic recomputing of msgmni | |
128 | upon memory add/remove or upon ipc namespace creation/removal. | |
129 | Echoing "1" into this file enabled msgmni automatic recomputing. | |
130 | Echoing "0" turned it off. auto_msgmni default value was 1. | |
807094c0 BP |
131 | |
132 | ||
1da177e4 LT |
133 | ============================================================== |
134 | ||
d75757ab PA |
135 | bootloader_type: |
136 | ||
137 | x86 bootloader identification | |
138 | ||
139 | This gives the bootloader type number as indicated by the bootloader, | |
140 | shifted left by 4, and OR'd with the low four bits of the bootloader | |
141 | version. The reason for this encoding is that this used to match the | |
142 | type_of_loader field in the kernel header; the encoding is kept for | |
143 | backwards compatibility. That is, if the full bootloader type number | |
144 | is 0x15 and the full version number is 0x234, this file will contain | |
145 | the value 340 = 0x154. | |
146 | ||
147 | See the type_of_loader and ext_loader_type fields in | |
148 | Documentation/x86/boot.txt for additional information. | |
149 | ||
150 | ============================================================== | |
151 | ||
152 | bootloader_version: | |
153 | ||
154 | x86 bootloader version | |
155 | ||
156 | The complete bootloader version number. In the example above, this | |
157 | file will contain the value 564 = 0x234. | |
158 | ||
159 | See the type_of_loader and ext_loader_ver fields in | |
160 | Documentation/x86/boot.txt for additional information. | |
161 | ||
162 | ============================================================== | |
163 | ||
c114728a HJP |
164 | callhome: |
165 | ||
166 | Controls the kernel's callhome behavior in case of a kernel panic. | |
167 | ||
168 | The s390 hardware allows an operating system to send a notification | |
169 | to a service organization (callhome) in case of an operating system panic. | |
170 | ||
171 | When the value in this file is 0 (which is the default behavior) | |
172 | nothing happens in case of a kernel panic. If this value is set to "1" | |
173 | the complete kernel oops message is send to the IBM customer service | |
174 | organization in case the mainframe the Linux operating system is running | |
175 | on has a service contract with IBM. | |
176 | ||
177 | ============================================================== | |
178 | ||
73efc039 DB |
179 | cap_last_cap |
180 | ||
181 | Highest valid capability of the running kernel. Exports | |
182 | CAP_LAST_CAP from the kernel. | |
183 | ||
184 | ============================================================== | |
185 | ||
1da177e4 LT |
186 | core_pattern: |
187 | ||
188 | core_pattern is used to specify a core dumpfile pattern name. | |
cd081041 | 189 | . max length 128 characters; default value is "core" |
1da177e4 LT |
190 | . core_pattern is used as a pattern template for the output filename; |
191 | certain string patterns (beginning with '%') are substituted with | |
192 | their actual values. | |
193 | . backward compatibility with core_uses_pid: | |
194 | If core_pattern does not include "%p" (default does not) | |
195 | and core_uses_pid is set, then .PID will be appended to | |
196 | the filename. | |
197 | . corename format specifiers: | |
198 | %<NUL> '%' is dropped | |
199 | %% output one '%' | |
200 | %p pid | |
65aafb1e | 201 | %P global pid (init PID namespace) |
b03023ec ON |
202 | %i tid |
203 | %I global tid (init PID namespace) | |
5202efe5 NI |
204 | %u uid (in initial user namespace) |
205 | %g gid (in initial user namespace) | |
12a2b4b2 ON |
206 | %d dump mode, matches PR_SET_DUMPABLE and |
207 | /proc/sys/fs/suid_dumpable | |
1da177e4 LT |
208 | %s signal number |
209 | %t UNIX time of dump | |
210 | %h hostname | |
57cc083a JS |
211 | %e executable filename (may be shortened) |
212 | %E executable path | |
1da177e4 | 213 | %<OTHER> both are dropped |
cd081041 MU |
214 | . If the first character of the pattern is a '|', the kernel will treat |
215 | the rest of the pattern as a command to run. The core dump will be | |
216 | written to the standard input of that program instead of to a file. | |
1da177e4 LT |
217 | |
218 | ============================================================== | |
219 | ||
a293980c NH |
220 | core_pipe_limit: |
221 | ||
807094c0 BP |
222 | This sysctl is only applicable when core_pattern is configured to pipe |
223 | core files to a user space helper (when the first character of | |
224 | core_pattern is a '|', see above). When collecting cores via a pipe | |
225 | to an application, it is occasionally useful for the collecting | |
226 | application to gather data about the crashing process from its | |
227 | /proc/pid directory. In order to do this safely, the kernel must wait | |
228 | for the collecting process to exit, so as not to remove the crashing | |
229 | processes proc files prematurely. This in turn creates the | |
230 | possibility that a misbehaving userspace collecting process can block | |
231 | the reaping of a crashed process simply by never exiting. This sysctl | |
232 | defends against that. It defines how many concurrent crashing | |
233 | processes may be piped to user space applications in parallel. If | |
234 | this value is exceeded, then those crashing processes above that value | |
235 | are noted via the kernel log and their cores are skipped. 0 is a | |
236 | special value, indicating that unlimited processes may be captured in | |
237 | parallel, but that no waiting will take place (i.e. the collecting | |
238 | process is not guaranteed access to /proc/<crashing pid>/). This | |
239 | value defaults to 0. | |
a293980c NH |
240 | |
241 | ============================================================== | |
242 | ||
1da177e4 LT |
243 | core_uses_pid: |
244 | ||
245 | The default coredump filename is "core". By setting | |
246 | core_uses_pid to 1, the coredump filename becomes core.PID. | |
247 | If core_pattern does not include "%p" (default does not) | |
248 | and core_uses_pid is set, then .PID will be appended to | |
249 | the filename. | |
250 | ||
251 | ============================================================== | |
252 | ||
253 | ctrl-alt-del: | |
254 | ||
255 | When the value in this file is 0, ctrl-alt-del is trapped and | |
256 | sent to the init(1) program to handle a graceful restart. | |
257 | When, however, the value is > 0, Linux's reaction to a Vulcan | |
258 | Nerve Pinch (tm) will be an immediate reboot, without even | |
259 | syncing its dirty buffers. | |
260 | ||
261 | Note: when a program (like dosemu) has the keyboard in 'raw' | |
262 | mode, the ctrl-alt-del is intercepted by the program before it | |
263 | ever reaches the kernel tty layer, and it's up to the program | |
264 | to decide what to do with it. | |
265 | ||
266 | ============================================================== | |
267 | ||
eaf06b24 DR |
268 | dmesg_restrict: |
269 | ||
807094c0 BP |
270 | This toggle indicates whether unprivileged users are prevented |
271 | from using dmesg(8) to view messages from the kernel's log buffer. | |
272 | When dmesg_restrict is set to (0) there are no restrictions. When | |
38ef4c2e | 273 | dmesg_restrict is set set to (1), users must have CAP_SYSLOG to use |
eaf06b24 DR |
274 | dmesg(8). |
275 | ||
807094c0 BP |
276 | The kernel config option CONFIG_SECURITY_DMESG_RESTRICT sets the |
277 | default value of dmesg_restrict. | |
eaf06b24 DR |
278 | |
279 | ============================================================== | |
280 | ||
1da177e4 LT |
281 | domainname & hostname: |
282 | ||
283 | These files can be used to set the NIS/YP domainname and the | |
284 | hostname of your box in exactly the same way as the commands | |
285 | domainname and hostname, i.e.: | |
286 | # echo "darkstar" > /proc/sys/kernel/hostname | |
287 | # echo "mydomain" > /proc/sys/kernel/domainname | |
288 | has the same effect as | |
289 | # hostname "darkstar" | |
290 | # domainname "mydomain" | |
291 | ||
292 | Note, however, that the classic darkstar.frop.org has the | |
293 | hostname "darkstar" and DNS (Internet Domain Name Server) | |
294 | domainname "frop.org", not to be confused with the NIS (Network | |
295 | Information Service) or YP (Yellow Pages) domainname. These two | |
296 | domain names are in general different. For a detailed discussion | |
297 | see the hostname(1) man page. | |
298 | ||
55537871 JK |
299 | ============================================================== |
300 | hardlockup_all_cpu_backtrace: | |
301 | ||
302 | This value controls the hard lockup detector behavior when a hard | |
303 | lockup condition is detected as to whether or not to gather further | |
304 | debug information. If enabled, arch-specific all-CPU stack dumping | |
305 | will be initiated. | |
306 | ||
307 | 0: do nothing. This is the default behavior. | |
308 | ||
309 | 1: on detection capture more debug information. | |
1da177e4 LT |
310 | ============================================================== |
311 | ||
312 | hotplug: | |
313 | ||
314 | Path for the hotplug policy agent. | |
315 | Default value is "/sbin/hotplug". | |
316 | ||
317 | ============================================================== | |
318 | ||
270750db AT |
319 | hung_task_panic: |
320 | ||
321 | Controls the kernel's behavior when a hung task is detected. | |
322 | This file shows up if CONFIG_DETECT_HUNG_TASK is enabled. | |
323 | ||
324 | 0: continue operation. This is the default behavior. | |
325 | ||
326 | 1: panic immediately. | |
327 | ||
328 | ============================================================== | |
329 | ||
330 | hung_task_check_count: | |
331 | ||
332 | The upper bound on the number of tasks that are checked. | |
333 | This file shows up if CONFIG_DETECT_HUNG_TASK is enabled. | |
334 | ||
335 | ============================================================== | |
336 | ||
337 | hung_task_timeout_secs: | |
338 | ||
339 | Check interval. When a task in D state did not get scheduled | |
340 | for more than this value report a warning. | |
341 | This file shows up if CONFIG_DETECT_HUNG_TASK is enabled. | |
342 | ||
343 | 0: means infinite timeout - no checking done. | |
80df2847 | 344 | Possible values to set are in range {0..LONG_MAX/HZ}. |
270750db AT |
345 | |
346 | ============================================================== | |
347 | ||
70e0ac5f | 348 | hung_task_warnings: |
270750db AT |
349 | |
350 | The maximum number of warnings to report. During a check interval | |
70e0ac5f AT |
351 | if a hung task is detected, this value is decreased by 1. |
352 | When this value reaches 0, no more warnings will be reported. | |
270750db AT |
353 | This file shows up if CONFIG_DETECT_HUNG_TASK is enabled. |
354 | ||
355 | -1: report an infinite number of warnings. | |
356 | ||
357 | ============================================================== | |
358 | ||
7984754b KC |
359 | kexec_load_disabled: |
360 | ||
361 | A toggle indicating if the kexec_load syscall has been disabled. This | |
362 | value defaults to 0 (false: kexec_load enabled), but can be set to 1 | |
363 | (true: kexec_load disabled). Once true, kexec can no longer be used, and | |
364 | the toggle cannot be set back to false. This allows a kexec image to be | |
365 | loaded before disabling the syscall, allowing a system to set up (and | |
366 | later use) an image without it being altered. Generally used together | |
367 | with the "modules_disabled" sysctl. | |
368 | ||
369 | ============================================================== | |
370 | ||
455cd5ab DR |
371 | kptr_restrict: |
372 | ||
373 | This toggle indicates whether restrictions are placed on | |
312b4e22 RM |
374 | exposing kernel addresses via /proc and other interfaces. |
375 | ||
376 | When kptr_restrict is set to (0), the default, there are no restrictions. | |
377 | ||
378 | When kptr_restrict is set to (1), kernel pointers printed using the %pK | |
379 | format specifier will be replaced with 0's unless the user has CAP_SYSLOG | |
380 | and effective user and group ids are equal to the real ids. This is | |
381 | because %pK checks are done at read() time rather than open() time, so | |
382 | if permissions are elevated between the open() and the read() (e.g via | |
383 | a setuid binary) then %pK will not leak kernel pointers to unprivileged | |
384 | users. Note, this is a temporary solution only. The correct long-term | |
385 | solution is to do the permission checks at open() time. Consider removing | |
386 | world read permissions from files that use %pK, and using dmesg_restrict | |
387 | to protect against uses of %pK in dmesg(8) if leaking kernel pointer | |
388 | values to unprivileged users is a concern. | |
389 | ||
390 | When kptr_restrict is set to (2), kernel pointers printed using | |
391 | %pK will be replaced with 0's regardless of privileges. | |
455cd5ab DR |
392 | |
393 | ============================================================== | |
394 | ||
0741f4d2 CE |
395 | kstack_depth_to_print: (X86 only) |
396 | ||
397 | Controls the number of words to print when dumping the raw | |
398 | kernel stack. | |
399 | ||
400 | ============================================================== | |
401 | ||
807094c0 BP |
402 | l2cr: (PPC only) |
403 | ||
404 | This flag controls the L2 cache of G3 processor boards. If | |
405 | 0, the cache is disabled. Enabled if nonzero. | |
406 | ||
407 | ============================================================== | |
408 | ||
3d43321b KC |
409 | modules_disabled: |
410 | ||
411 | A toggle value indicating if modules are allowed to be loaded | |
412 | in an otherwise modular kernel. This toggle defaults to off | |
413 | (0), but can be set true (1). Once true, modules can be | |
414 | neither loaded nor unloaded, and the toggle cannot be set back | |
7984754b | 415 | to false. Generally used with the "kexec_load_disabled" toggle. |
3d43321b KC |
416 | |
417 | ============================================================== | |
418 | ||
03f59566 SK |
419 | msg_next_id, sem_next_id, and shm_next_id: |
420 | ||
421 | These three toggles allows to specify desired id for next allocated IPC | |
422 | object: message, semaphore or shared memory respectively. | |
423 | ||
424 | By default they are equal to -1, which means generic allocation logic. | |
425 | Possible values to set are in range {0..INT_MAX}. | |
426 | ||
427 | Notes: | |
428 | 1) kernel doesn't guarantee, that new object will have desired id. So, | |
429 | it's up to userspace, how to handle an object with "wrong" id. | |
430 | 2) Toggle with non-default value will be set back to -1 by kernel after | |
431 | successful IPC object allocation. | |
432 | ||
433 | ============================================================== | |
434 | ||
807094c0 BP |
435 | nmi_watchdog: |
436 | ||
195daf66 UO |
437 | This parameter can be used to control the NMI watchdog |
438 | (i.e. the hard lockup detector) on x86 systems. | |
807094c0 | 439 | |
195daf66 UO |
440 | 0 - disable the hard lockup detector |
441 | 1 - enable the hard lockup detector | |
442 | ||
443 | The hard lockup detector monitors each CPU for its ability to respond to | |
444 | timer interrupts. The mechanism utilizes CPU performance counter registers | |
445 | that are programmed to generate Non-Maskable Interrupts (NMIs) periodically | |
446 | while a CPU is busy. Hence, the alternative name 'NMI watchdog'. | |
447 | ||
448 | The NMI watchdog is disabled by default if the kernel is running as a guest | |
449 | in a KVM virtual machine. This default can be overridden by adding | |
450 | ||
451 | nmi_watchdog=1 | |
452 | ||
453 | to the guest kernel command line (see Documentation/kernel-parameters.txt). | |
807094c0 BP |
454 | |
455 | ============================================================== | |
456 | ||
10fc05d0 MG |
457 | numa_balancing |
458 | ||
459 | Enables/disables automatic page fault based NUMA memory | |
460 | balancing. Memory is moved automatically to nodes | |
461 | that access it often. | |
462 | ||
463 | Enables/disables automatic NUMA memory balancing. On NUMA machines, there | |
464 | is a performance penalty if remote memory is accessed by a CPU. When this | |
465 | feature is enabled the kernel samples what task thread is accessing memory | |
466 | by periodically unmapping pages and later trapping a page fault. At the | |
467 | time of the page fault, it is determined if the data being accessed should | |
468 | be migrated to a local memory node. | |
469 | ||
470 | The unmapping of pages and trapping faults incur additional overhead that | |
471 | ideally is offset by improved memory locality but there is no universal | |
472 | guarantee. If the target workload is already bound to NUMA nodes then this | |
473 | feature should be disabled. Otherwise, if the system overhead from the | |
474 | feature is too high then the rate the kernel samples for NUMA hinting | |
475 | faults may be controlled by the numa_balancing_scan_period_min_ms, | |
930aa174 | 476 | numa_balancing_scan_delay_ms, numa_balancing_scan_period_max_ms, |
52bf84aa | 477 | numa_balancing_scan_size_mb, and numa_balancing_settle_count sysctls. |
10fc05d0 MG |
478 | |
479 | ============================================================== | |
480 | ||
481 | numa_balancing_scan_period_min_ms, numa_balancing_scan_delay_ms, | |
930aa174 | 482 | numa_balancing_scan_period_max_ms, numa_balancing_scan_size_mb |
10fc05d0 MG |
483 | |
484 | Automatic NUMA balancing scans tasks address space and unmaps pages to | |
485 | detect if pages are properly placed or if the data should be migrated to a | |
486 | memory node local to where the task is running. Every "scan delay" the task | |
487 | scans the next "scan size" number of pages in its address space. When the | |
488 | end of the address space is reached the scanner restarts from the beginning. | |
489 | ||
490 | In combination, the "scan delay" and "scan size" determine the scan rate. | |
491 | When "scan delay" decreases, the scan rate increases. The scan delay and | |
492 | hence the scan rate of every task is adaptive and depends on historical | |
493 | behaviour. If pages are properly placed then the scan delay increases, | |
494 | otherwise the scan delay decreases. The "scan size" is not adaptive but | |
495 | the higher the "scan size", the higher the scan rate. | |
496 | ||
497 | Higher scan rates incur higher system overhead as page faults must be | |
498 | trapped and potentially data must be migrated. However, the higher the scan | |
499 | rate, the more quickly a tasks memory is migrated to a local node if the | |
500 | workload pattern changes and minimises performance impact due to remote | |
501 | memory accesses. These sysctls control the thresholds for scan delays and | |
502 | the number of pages scanned. | |
503 | ||
598f0ec0 MG |
504 | numa_balancing_scan_period_min_ms is the minimum time in milliseconds to |
505 | scan a tasks virtual memory. It effectively controls the maximum scanning | |
506 | rate for each task. | |
10fc05d0 MG |
507 | |
508 | numa_balancing_scan_delay_ms is the starting "scan delay" used for a task | |
509 | when it initially forks. | |
510 | ||
598f0ec0 MG |
511 | numa_balancing_scan_period_max_ms is the maximum time in milliseconds to |
512 | scan a tasks virtual memory. It effectively controls the minimum scanning | |
513 | rate for each task. | |
10fc05d0 MG |
514 | |
515 | numa_balancing_scan_size_mb is how many megabytes worth of pages are | |
516 | scanned for a given scan. | |
517 | ||
10fc05d0 MG |
518 | ============================================================== |
519 | ||
1da177e4 LT |
520 | osrelease, ostype & version: |
521 | ||
522 | # cat osrelease | |
523 | 2.1.88 | |
524 | # cat ostype | |
525 | Linux | |
526 | # cat version | |
527 | #5 Wed Feb 25 21:49:24 MET 1998 | |
528 | ||
529 | The files osrelease and ostype should be clear enough. Version | |
530 | needs a little more clarification however. The '#5' means that | |
531 | this is the fifth kernel built from this source base and the | |
532 | date behind it indicates the time the kernel was built. | |
533 | The only way to tune these values is to rebuild the kernel :-) | |
534 | ||
535 | ============================================================== | |
536 | ||
537 | overflowgid & overflowuid: | |
538 | ||
807094c0 BP |
539 | if your architecture did not always support 32-bit UIDs (i.e. arm, |
540 | i386, m68k, sh, and sparc32), a fixed UID and GID will be returned to | |
541 | applications that use the old 16-bit UID/GID system calls, if the | |
542 | actual UID or GID would exceed 65535. | |
1da177e4 LT |
543 | |
544 | These sysctls allow you to change the value of the fixed UID and GID. | |
545 | The default is 65534. | |
546 | ||
547 | ============================================================== | |
548 | ||
549 | panic: | |
550 | ||
807094c0 BP |
551 | The value in this file represents the number of seconds the kernel |
552 | waits before rebooting on a panic. When you use the software watchdog, | |
553 | the recommended setting is 60. | |
554 | ||
555 | ============================================================== | |
9f318e3f HK |
556 | |
557 | panic_on_io_nmi: | |
558 | ||
559 | Controls the kernel's behavior when a CPU receives an NMI caused by | |
560 | an IO error. | |
561 | ||
562 | 0: try to continue operation (default) | |
563 | ||
564 | 1: panic immediately. The IO error triggered an NMI. This indicates a | |
565 | serious system condition which could result in IO data corruption. | |
566 | Rather than continuing, panicking might be a better choice. Some | |
567 | servers issue this sort of NMI when the dump button is pushed, | |
568 | and you can use this option to take a crash dump. | |
569 | ||
570 | ============================================================== | |
807094c0 | 571 | |
1da177e4 LT |
572 | panic_on_oops: |
573 | ||
574 | Controls the kernel's behaviour when an oops or BUG is encountered. | |
575 | ||
576 | 0: try to continue operation | |
577 | ||
a982ac06 | 578 | 1: panic immediately. If the `panic' sysctl is also non-zero then the |
8b23d04d | 579 | machine will be rebooted. |
1da177e4 LT |
580 | |
581 | ============================================================== | |
582 | ||
55af7796 MH |
583 | panic_on_stackoverflow: |
584 | ||
585 | Controls the kernel's behavior when detecting the overflows of | |
586 | kernel, IRQ and exception stacks except a user stack. | |
587 | This file shows up if CONFIG_DEBUG_STACKOVERFLOW is enabled. | |
588 | ||
589 | 0: try to continue operation. | |
590 | ||
591 | 1: panic immediately. | |
592 | ||
593 | ============================================================== | |
594 | ||
9e3961a0 PB |
595 | panic_on_unrecovered_nmi: |
596 | ||
597 | The default Linux behaviour on an NMI of either memory or unknown is | |
598 | to continue operation. For many environments such as scientific | |
599 | computing it is preferable that the box is taken out and the error | |
600 | dealt with than an uncorrected parity/ECC error get propagated. | |
601 | ||
602 | A small number of systems do generate NMI's for bizarre random reasons | |
603 | such as power management so the default is off. That sysctl works like | |
604 | the existing panic controls already in that directory. | |
605 | ||
606 | ============================================================== | |
607 | ||
608 | panic_on_warn: | |
609 | ||
610 | Calls panic() in the WARN() path when set to 1. This is useful to avoid | |
611 | a kernel rebuild when attempting to kdump at the location of a WARN(). | |
612 | ||
613 | 0: only WARN(), default behaviour. | |
614 | ||
615 | 1: call panic() after printing out WARN() location. | |
616 | ||
617 | ============================================================== | |
618 | ||
14c63f17 DH |
619 | perf_cpu_time_max_percent: |
620 | ||
621 | Hints to the kernel how much CPU time it should be allowed to | |
622 | use to handle perf sampling events. If the perf subsystem | |
623 | is informed that its samples are exceeding this limit, it | |
624 | will drop its sampling frequency to attempt to reduce its CPU | |
625 | usage. | |
626 | ||
627 | Some perf sampling happens in NMIs. If these samples | |
628 | unexpectedly take too long to execute, the NMIs can become | |
629 | stacked up next to each other so much that nothing else is | |
630 | allowed to execute. | |
631 | ||
632 | 0: disable the mechanism. Do not monitor or correct perf's | |
633 | sampling rate no matter how CPU time it takes. | |
634 | ||
635 | 1-100: attempt to throttle perf's sample rate to this | |
636 | percentage of CPU. Note: the kernel calculates an | |
637 | "expected" length of each sample event. 100 here means | |
638 | 100% of that expected length. Even if this is set to | |
639 | 100, you may still see sample throttling if this | |
640 | length is exceeded. Set to 0 if you truly do not care | |
641 | how much CPU is consumed. | |
642 | ||
643 | ============================================================== | |
644 | ||
3379e0c3 BH |
645 | perf_event_paranoid: |
646 | ||
647 | Controls use of the performance events system by unprivileged | |
648 | users (without CAP_SYS_ADMIN). The default value is 1. | |
649 | ||
650 | -1: Allow use of (almost) all events by all users | |
651 | >=0: Disallow raw tracepoint access by users without CAP_IOC_LOCK | |
652 | >=1: Disallow CPU event access by users without CAP_SYS_ADMIN | |
653 | >=2: Disallow kernel profiling by users without CAP_SYS_ADMIN | |
654 | ||
655 | ============================================================== | |
55af7796 | 656 | |
1da177e4 LT |
657 | pid_max: |
658 | ||
beb7dd86 | 659 | PID allocation wrap value. When the kernel's next PID value |
1da177e4 LT |
660 | reaches this value, it wraps back to a minimum PID value. |
661 | PIDs of value pid_max or larger are not allocated. | |
662 | ||
663 | ============================================================== | |
664 | ||
b8f566b0 PE |
665 | ns_last_pid: |
666 | ||
667 | The last pid allocated in the current (the one task using this sysctl | |
668 | lives in) pid namespace. When selecting a pid for a next task on fork | |
669 | kernel tries to allocate a number starting from this one. | |
670 | ||
671 | ============================================================== | |
672 | ||
1da177e4 LT |
673 | powersave-nap: (PPC only) |
674 | ||
675 | If set, Linux-PPC will use the 'nap' mode of powersaving, | |
676 | otherwise the 'doze' mode will be used. | |
677 | ||
678 | ============================================================== | |
679 | ||
680 | printk: | |
681 | ||
682 | The four values in printk denote: console_loglevel, | |
683 | default_message_loglevel, minimum_console_loglevel and | |
684 | default_console_loglevel respectively. | |
685 | ||
686 | These values influence printk() behavior when printing or | |
687 | logging error messages. See 'man 2 syslog' for more info on | |
688 | the different loglevels. | |
689 | ||
690 | - console_loglevel: messages with a higher priority than | |
691 | this will be printed to the console | |
87889e15 | 692 | - default_message_loglevel: messages without an explicit priority |
1da177e4 LT |
693 | will be printed with this priority |
694 | - minimum_console_loglevel: minimum (highest) value to which | |
695 | console_loglevel can be set | |
696 | - default_console_loglevel: default value for console_loglevel | |
697 | ||
698 | ============================================================== | |
699 | ||
807094c0 BP |
700 | printk_delay: |
701 | ||
702 | Delay each printk message in printk_delay milliseconds | |
703 | ||
704 | Value from 0 - 10000 is allowed. | |
705 | ||
706 | ============================================================== | |
707 | ||
1da177e4 LT |
708 | printk_ratelimit: |
709 | ||
710 | Some warning messages are rate limited. printk_ratelimit specifies | |
711 | the minimum length of time between these messages (in jiffies), by | |
712 | default we allow one every 5 seconds. | |
713 | ||
714 | A value of 0 will disable rate limiting. | |
715 | ||
716 | ============================================================== | |
717 | ||
718 | printk_ratelimit_burst: | |
719 | ||
720 | While long term we enforce one message per printk_ratelimit | |
721 | seconds, we do allow a burst of messages to pass through. | |
722 | printk_ratelimit_burst specifies the number of messages we can | |
723 | send before ratelimiting kicks in. | |
724 | ||
725 | ============================================================== | |
726 | ||
807094c0 | 727 | randomize_va_space: |
1ec7fd50 JK |
728 | |
729 | This option can be used to select the type of process address | |
730 | space randomization that is used in the system, for architectures | |
731 | that support this feature. | |
732 | ||
b7f5ab6f HS |
733 | 0 - Turn the process address space randomization off. This is the |
734 | default for architectures that do not support this feature anyways, | |
735 | and kernels that are booted with the "norandmaps" parameter. | |
1ec7fd50 JK |
736 | |
737 | 1 - Make the addresses of mmap base, stack and VDSO page randomized. | |
738 | This, among other things, implies that shared libraries will be | |
b7f5ab6f HS |
739 | loaded to random addresses. Also for PIE-linked binaries, the |
740 | location of code start is randomized. This is the default if the | |
741 | CONFIG_COMPAT_BRK option is enabled. | |
1ec7fd50 | 742 | |
b7f5ab6f HS |
743 | 2 - Additionally enable heap randomization. This is the default if |
744 | CONFIG_COMPAT_BRK is disabled. | |
745 | ||
746 | There are a few legacy applications out there (such as some ancient | |
1ec7fd50 | 747 | versions of libc.so.5 from 1996) that assume that brk area starts |
b7f5ab6f HS |
748 | just after the end of the code+bss. These applications break when |
749 | start of the brk area is randomized. There are however no known | |
1ec7fd50 | 750 | non-legacy applications that would be broken this way, so for most |
b7f5ab6f HS |
751 | systems it is safe to choose full randomization. |
752 | ||
753 | Systems with ancient and/or broken binaries should be configured | |
754 | with CONFIG_COMPAT_BRK enabled, which excludes the heap from process | |
755 | address space randomization. | |
1ec7fd50 JK |
756 | |
757 | ============================================================== | |
758 | ||
1da177e4 LT |
759 | reboot-cmd: (Sparc only) |
760 | ||
761 | ??? This seems to be a way to give an argument to the Sparc | |
762 | ROM/Flash boot loader. Maybe to tell it what to do after | |
763 | rebooting. ??? | |
764 | ||
765 | ============================================================== | |
766 | ||
767 | rtsig-max & rtsig-nr: | |
768 | ||
769 | The file rtsig-max can be used to tune the maximum number | |
770 | of POSIX realtime (queued) signals that can be outstanding | |
771 | in the system. | |
772 | ||
773 | rtsig-nr shows the number of RT signals currently queued. | |
774 | ||
775 | ============================================================== | |
776 | ||
cb251765 MG |
777 | sched_schedstats: |
778 | ||
779 | Enables/disables scheduler statistics. Enabling this feature | |
780 | incurs a small amount of overhead in the scheduler but is | |
781 | useful for debugging and performance tuning. | |
782 | ||
783 | ============================================================== | |
784 | ||
1da177e4 LT |
785 | sg-big-buff: |
786 | ||
787 | This file shows the size of the generic SCSI (sg) buffer. | |
788 | You can't tune it just yet, but you could change it on | |
789 | compile time by editing include/scsi/sg.h and changing | |
790 | the value of SG_BIG_BUFF. | |
791 | ||
792 | There shouldn't be any reason to change this value. If | |
793 | you can come up with one, you probably know what you | |
794 | are doing anyway :) | |
795 | ||
796 | ============================================================== | |
797 | ||
358e419f CALP |
798 | shmall: |
799 | ||
800 | This parameter sets the total amount of shared memory pages that | |
801 | can be used system wide. Hence, SHMALL should always be at least | |
802 | ceil(shmmax/PAGE_SIZE). | |
803 | ||
804 | If you are not sure what the default PAGE_SIZE is on your Linux | |
805 | system, you can run the following command: | |
806 | ||
807 | # getconf PAGE_SIZE | |
808 | ||
809 | ============================================================== | |
810 | ||
807094c0 | 811 | shmmax: |
1da177e4 LT |
812 | |
813 | This value can be used to query and set the run time limit | |
814 | on the maximum shared memory segment size that can be created. | |
807094c0 | 815 | Shared memory segments up to 1Gb are now supported in the |
1da177e4 LT |
816 | kernel. This value defaults to SHMMAX. |
817 | ||
818 | ============================================================== | |
819 | ||
b34a6b1d VK |
820 | shm_rmid_forced: |
821 | ||
822 | Linux lets you set resource limits, including how much memory one | |
823 | process can consume, via setrlimit(2). Unfortunately, shared memory | |
824 | segments are allowed to exist without association with any process, and | |
825 | thus might not be counted against any resource limits. If enabled, | |
826 | shared memory segments are automatically destroyed when their attach | |
827 | count becomes zero after a detach or a process termination. It will | |
828 | also destroy segments that were created, but never attached to, on exit | |
829 | from the process. The only use left for IPC_RMID is to immediately | |
830 | destroy an unattached segment. Of course, this breaks the way things are | |
831 | defined, so some applications might stop working. Note that this | |
832 | feature will do you no good unless you also configure your resource | |
833 | limits (in particular, RLIMIT_AS and RLIMIT_NPROC). Most systems don't | |
834 | need this. | |
835 | ||
836 | Note that if you change this from 0 to 1, already created segments | |
837 | without users and with a dead originative process will be destroyed. | |
838 | ||
839 | ============================================================== | |
840 | ||
f4aacea2 KC |
841 | sysctl_writes_strict: |
842 | ||
843 | Control how file position affects the behavior of updating sysctl values | |
844 | via the /proc/sys interface: | |
845 | ||
846 | -1 - Legacy per-write sysctl value handling, with no printk warnings. | |
847 | Each write syscall must fully contain the sysctl value to be | |
848 | written, and multiple writes on the same sysctl file descriptor | |
849 | will rewrite the sysctl value, regardless of file position. | |
41662f5c KC |
850 | 0 - Same behavior as above, but warn about processes that perform writes |
851 | to a sysctl file descriptor when the file position is not 0. | |
852 | 1 - (default) Respect file position when writing sysctl strings. Multiple | |
853 | writes will append to the sysctl value buffer. Anything past the max | |
854 | length of the sysctl value buffer will be ignored. Writes to numeric | |
855 | sysctl entries must always be at file position 0 and the value must | |
856 | be fully contained in the buffer sent in the write syscall. | |
f4aacea2 KC |
857 | |
858 | ============================================================== | |
859 | ||
ed235875 AT |
860 | softlockup_all_cpu_backtrace: |
861 | ||
862 | This value controls the soft lockup detector thread's behavior | |
863 | when a soft lockup condition is detected as to whether or not | |
864 | to gather further debug information. If enabled, each cpu will | |
865 | be issued an NMI and instructed to capture stack trace. | |
866 | ||
867 | This feature is only applicable for architectures which support | |
868 | NMI. | |
869 | ||
870 | 0: do nothing. This is the default behavior. | |
871 | ||
872 | 1: on detection capture more debug information. | |
873 | ||
874 | ============================================================== | |
875 | ||
195daf66 UO |
876 | soft_watchdog |
877 | ||
878 | This parameter can be used to control the soft lockup detector. | |
879 | ||
880 | 0 - disable the soft lockup detector | |
881 | 1 - enable the soft lockup detector | |
882 | ||
883 | The soft lockup detector monitors CPUs for threads that are hogging the CPUs | |
884 | without rescheduling voluntarily, and thus prevent the 'watchdog/N' threads | |
885 | from running. The mechanism depends on the CPUs ability to respond to timer | |
886 | interrupts which are needed for the 'watchdog/N' threads to be woken up by | |
887 | the watchdog timer function, otherwise the NMI watchdog - if enabled - can | |
888 | detect a hard lockup condition. | |
889 | ||
890 | ============================================================== | |
891 | ||
807094c0 | 892 | tainted: |
1da177e4 LT |
893 | |
894 | Non-zero if the kernel has been tainted. Numeric values, which | |
895 | can be ORed together: | |
896 | ||
bb20698d GKH |
897 | 1 - A module with a non-GPL license has been loaded, this |
898 | includes modules with no license. | |
899 | Set by modutils >= 2.4.9 and module-init-tools. | |
900 | 2 - A module was force loaded by insmod -f. | |
901 | Set by modutils >= 2.4.9 and module-init-tools. | |
902 | 4 - Unsafe SMP processors: SMP with CPUs not designed for SMP. | |
903 | 8 - A module was forcibly unloaded from the system by rmmod -f. | |
904 | 16 - A hardware machine check error occurred on the system. | |
905 | 32 - A bad page was discovered on the system. | |
906 | 64 - The user has asked that the system be marked "tainted". This | |
907 | could be because they are running software that directly modifies | |
908 | the hardware, or for other reasons. | |
909 | 128 - The system has died. | |
910 | 256 - The ACPI DSDT has been overridden with one supplied by the user | |
911 | instead of using the one provided by the hardware. | |
912 | 512 - A kernel warning has occurred. | |
913 | 1024 - A module from drivers/staging was loaded. | |
f5fe184b LF |
914 | 2048 - The system is working around a severe firmware bug. |
915 | 4096 - An out-of-tree module has been loaded. | |
66cc69e3 MD |
916 | 8192 - An unsigned module has been loaded in a kernel supporting module |
917 | signature. | |
69361eef | 918 | 16384 - A soft lockup has previously occurred on the system. |
c5f45465 | 919 | 32768 - The kernel has been live patched. |
1da177e4 | 920 | |
760df93e SF |
921 | ============================================================== |
922 | ||
0ec62afe HS |
923 | threads-max |
924 | ||
925 | This value controls the maximum number of threads that can be created | |
926 | using fork(). | |
927 | ||
928 | During initialization the kernel sets this value such that even if the | |
929 | maximum number of threads is created, the thread structures occupy only | |
930 | a part (1/8th) of the available RAM pages. | |
931 | ||
932 | The minimum value that can be written to threads-max is 20. | |
933 | The maximum value that can be written to threads-max is given by the | |
934 | constant FUTEX_TID_MASK (0x3fffffff). | |
935 | If a value outside of this range is written to threads-max an error | |
936 | EINVAL occurs. | |
937 | ||
938 | The value written is checked against the available RAM pages. If the | |
939 | thread structures would occupy too much (more than 1/8th) of the | |
940 | available RAM pages threads-max is reduced accordingly. | |
941 | ||
942 | ============================================================== | |
943 | ||
760df93e SF |
944 | unknown_nmi_panic: |
945 | ||
807094c0 BP |
946 | The value in this file affects behavior of handling NMI. When the |
947 | value is non-zero, unknown NMI is trapped and then panic occurs. At | |
948 | that time, kernel debugging information is displayed on console. | |
760df93e | 949 | |
807094c0 BP |
950 | NMI switch that most IA32 servers have fires unknown NMI up, for |
951 | example. If a system hangs up, try pressing the NMI switch. | |
08825c90 LZ |
952 | |
953 | ============================================================== | |
954 | ||
195daf66 UO |
955 | watchdog: |
956 | ||
957 | This parameter can be used to disable or enable the soft lockup detector | |
958 | _and_ the NMI watchdog (i.e. the hard lockup detector) at the same time. | |
959 | ||
960 | 0 - disable both lockup detectors | |
961 | 1 - enable both lockup detectors | |
962 | ||
963 | The soft lockup detector and the NMI watchdog can also be disabled or | |
964 | enabled individually, using the soft_watchdog and nmi_watchdog parameters. | |
965 | If the watchdog parameter is read, for example by executing | |
966 | ||
967 | cat /proc/sys/kernel/watchdog | |
968 | ||
969 | the output of this command (0 or 1) shows the logical OR of soft_watchdog | |
970 | and nmi_watchdog. | |
971 | ||
972 | ============================================================== | |
973 | ||
fe4ba3c3 CM |
974 | watchdog_cpumask: |
975 | ||
976 | This value can be used to control on which cpus the watchdog may run. | |
977 | The default cpumask is all possible cores, but if NO_HZ_FULL is | |
978 | enabled in the kernel config, and cores are specified with the | |
979 | nohz_full= boot argument, those cores are excluded by default. | |
980 | Offline cores can be included in this mask, and if the core is later | |
981 | brought online, the watchdog will be started based on the mask value. | |
982 | ||
983 | Typically this value would only be touched in the nohz_full case | |
984 | to re-enable cores that by default were not running the watchdog, | |
985 | if a kernel lockup was suspected on those cores. | |
986 | ||
987 | The argument value is the standard cpulist format for cpumasks, | |
988 | so for example to enable the watchdog on cores 0, 2, 3, and 4 you | |
989 | might say: | |
990 | ||
991 | echo 0,2-4 > /proc/sys/kernel/watchdog_cpumask | |
992 | ||
993 | ============================================================== | |
994 | ||
08825c90 LZ |
995 | watchdog_thresh: |
996 | ||
997 | This value can be used to control the frequency of hrtimer and NMI | |
998 | events and the soft and hard lockup thresholds. The default threshold | |
999 | is 10 seconds. | |
1000 | ||
1001 | The softlockup threshold is (2 * watchdog_thresh). Setting this | |
1002 | tunable to zero will disable lockup detection altogether. | |
1003 | ||
1004 | ============================================================== |