Documentation: add missing tainted bits to Documentation/sysctl/kernel.txt
[linux-2.6.git] / Documentation / sysctl / kernel.txt
1 Documentation for /proc/sys/kernel/*    kernel version 2.2.10
2         (c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
3         (c) 2009,        Shen Feng<shen@cn.fujitsu.com>
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:
20
21 - acct
22 - acpi_video_flags
23 - auto_msgmni
24 - bootloader_type            [ X86 only ]
25 - bootloader_version         [ X86 only ]
26 - callhome                   [ S390 only ]
27 - cap_last_cap
28 - core_pattern
29 - core_pipe_limit
30 - core_uses_pid
31 - ctrl-alt-del
32 - dmesg_restrict
33 - domainname
34 - hostname
35 - hotplug
36 - kptr_restrict
37 - kstack_depth_to_print       [ X86 only ]
38 - l2cr                        [ PPC only ]
39 - modprobe                    ==> Documentation/debugging-modules.txt
40 - modules_disabled
41 - msgmax
42 - msgmnb
43 - msgmni
44 - nmi_watchdog
45 - osrelease
46 - ostype
47 - overflowgid
48 - overflowuid
49 - panic
50 - panic_on_oops
51 - panic_on_unrecovered_nmi
52 - panic_on_stackoverflow
53 - pid_max
54 - powersave-nap               [ PPC only ]
55 - printk
56 - printk_delay
57 - printk_ratelimit
58 - printk_ratelimit_burst
59 - randomize_va_space
60 - real-root-dev               ==> Documentation/initrd.txt
61 - reboot-cmd                  [ SPARC only ]
62 - rtsig-max
63 - rtsig-nr
64 - sem
65 - sg-big-buff                 [ generic SCSI device (sg) ]
66 - shm_rmid_forced
67 - shmall
68 - shmmax                      [ sysv ipc ]
69 - shmmni
70 - softlockup_thresh
71 - stop-a                      [ SPARC only ]
72 - sysrq                       ==> Documentation/sysrq.txt
73 - tainted
74 - threads-max
75 - unknown_nmi_panic
76 - version
77
78 ==============================================================
79
80 acct:
81
82 highwater lowwater frequency
83
84 If BSD-style process accounting is enabled these values control
85 its behaviour. If free space on filesystem where the log lives
86 goes below <lowwater>% accounting suspends. If free space gets
87 above <highwater>% accounting resumes. <Frequency> determines
88 how often do we check the amount of free space (value is in
89 seconds). Default:
90 4 2 30
91 That is, suspend accounting if there left <= 2% free; resume it
92 if we got >=4%; consider information about amount of free space
93 valid for 30 seconds.
94
95 ==============================================================
96
97 acpi_video_flags:
98
99 flags
100
101 See Doc*/kernel/power/video.txt, it allows mode of video boot to be
102 set during run time.
103
104 ==============================================================
105
106 auto_msgmni:
107
108 Enables/Disables automatic recomputing of msgmni upon memory add/remove
109 or upon ipc namespace creation/removal (see the msgmni description
110 above). Echoing "1" into this file enables msgmni automatic recomputing.
111 Echoing "0" turns it off. auto_msgmni default value is 1.
112
113
114 ==============================================================
115
116 bootloader_type:
117
118 x86 bootloader identification
119
120 This gives the bootloader type number as indicated by the bootloader,
121 shifted left by 4, and OR'd with the low four bits of the bootloader
122 version.  The reason for this encoding is that this used to match the
123 type_of_loader field in the kernel header; the encoding is kept for
124 backwards compatibility.  That is, if the full bootloader type number
125 is 0x15 and the full version number is 0x234, this file will contain
126 the value 340 = 0x154.
127
128 See the type_of_loader and ext_loader_type fields in
129 Documentation/x86/boot.txt for additional information.
130
131 ==============================================================
132
133 bootloader_version:
134
135 x86 bootloader version
136
137 The complete bootloader version number.  In the example above, this
138 file will contain the value 564 = 0x234.
139
140 See the type_of_loader and ext_loader_ver fields in
141 Documentation/x86/boot.txt for additional information.
142
143 ==============================================================
144
145 callhome:
146
147 Controls the kernel's callhome behavior in case of a kernel panic.
148
149 The s390 hardware allows an operating system to send a notification
150 to a service organization (callhome) in case of an operating system panic.
151
152 When the value in this file is 0 (which is the default behavior)
153 nothing happens in case of a kernel panic. If this value is set to "1"
154 the complete kernel oops message is send to the IBM customer service
155 organization in case the mainframe the Linux operating system is running
156 on has a service contract with IBM.
157
158 ==============================================================
159
160 cap_last_cap
161
162 Highest valid capability of the running kernel.  Exports
163 CAP_LAST_CAP from the kernel.
164
165 ==============================================================
166
167 core_pattern:
168
169 core_pattern is used to specify a core dumpfile pattern name.
170 . max length 128 characters; default value is "core"
171 . core_pattern is used as a pattern template for the output filename;
172   certain string patterns (beginning with '%') are substituted with
173   their actual values.
174 . backward compatibility with core_uses_pid:
175         If core_pattern does not include "%p" (default does not)
176         and core_uses_pid is set, then .PID will be appended to
177         the filename.
178 . corename format specifiers:
179         %<NUL>  '%' is dropped
180         %%      output one '%'
181         %p      pid
182         %u      uid
183         %g      gid
184         %s      signal number
185         %t      UNIX time of dump
186         %h      hostname
187         %e      executable filename (may be shortened)
188         %E      executable path
189         %<OTHER> both are dropped
190 . If the first character of the pattern is a '|', the kernel will treat
191   the rest of the pattern as a command to run.  The core dump will be
192   written to the standard input of that program instead of to a file.
193
194 ==============================================================
195
196 core_pipe_limit:
197
198 This sysctl is only applicable when core_pattern is configured to pipe
199 core files to a user space helper (when the first character of
200 core_pattern is a '|', see above).  When collecting cores via a pipe
201 to an application, it is occasionally useful for the collecting
202 application to gather data about the crashing process from its
203 /proc/pid directory.  In order to do this safely, the kernel must wait
204 for the collecting process to exit, so as not to remove the crashing
205 processes proc files prematurely.  This in turn creates the
206 possibility that a misbehaving userspace collecting process can block
207 the reaping of a crashed process simply by never exiting.  This sysctl
208 defends against that.  It defines how many concurrent crashing
209 processes may be piped to user space applications in parallel.  If
210 this value is exceeded, then those crashing processes above that value
211 are noted via the kernel log and their cores are skipped.  0 is a
212 special value, indicating that unlimited processes may be captured in
213 parallel, but that no waiting will take place (i.e. the collecting
214 process is not guaranteed access to /proc/<crashing pid>/).  This
215 value defaults to 0.
216
217 ==============================================================
218
219 core_uses_pid:
220
221 The default coredump filename is "core".  By setting
222 core_uses_pid to 1, the coredump filename becomes core.PID.
223 If core_pattern does not include "%p" (default does not)
224 and core_uses_pid is set, then .PID will be appended to
225 the filename.
226
227 ==============================================================
228
229 ctrl-alt-del:
230
231 When the value in this file is 0, ctrl-alt-del is trapped and
232 sent to the init(1) program to handle a graceful restart.
233 When, however, the value is > 0, Linux's reaction to a Vulcan
234 Nerve Pinch (tm) will be an immediate reboot, without even
235 syncing its dirty buffers.
236
237 Note: when a program (like dosemu) has the keyboard in 'raw'
238 mode, the ctrl-alt-del is intercepted by the program before it
239 ever reaches the kernel tty layer, and it's up to the program
240 to decide what to do with it.
241
242 ==============================================================
243
244 dmesg_restrict:
245
246 This toggle indicates whether unprivileged users are prevented
247 from using dmesg(8) to view messages from the kernel's log buffer.
248 When dmesg_restrict is set to (0) there are no restrictions. When
249 dmesg_restrict is set set to (1), users must have CAP_SYSLOG to use
250 dmesg(8).
251
252 The kernel config option CONFIG_SECURITY_DMESG_RESTRICT sets the
253 default value of dmesg_restrict.
254
255 ==============================================================
256
257 domainname & hostname:
258
259 These files can be used to set the NIS/YP domainname and the
260 hostname of your box in exactly the same way as the commands
261 domainname and hostname, i.e.:
262 # echo "darkstar" > /proc/sys/kernel/hostname
263 # echo "mydomain" > /proc/sys/kernel/domainname
264 has the same effect as
265 # hostname "darkstar"
266 # domainname "mydomain"
267
268 Note, however, that the classic darkstar.frop.org has the
269 hostname "darkstar" and DNS (Internet Domain Name Server)
270 domainname "frop.org", not to be confused with the NIS (Network
271 Information Service) or YP (Yellow Pages) domainname. These two
272 domain names are in general different. For a detailed discussion
273 see the hostname(1) man page.
274
275 ==============================================================
276
277 hotplug:
278
279 Path for the hotplug policy agent.
280 Default value is "/sbin/hotplug".
281
282 ==============================================================
283
284 kptr_restrict:
285
286 This toggle indicates whether restrictions are placed on
287 exposing kernel addresses via /proc and other interfaces.  When
288 kptr_restrict is set to (0), there are no restrictions.  When
289 kptr_restrict is set to (1), the default, kernel pointers
290 printed using the %pK format specifier will be replaced with 0's
291 unless the user has CAP_SYSLOG.  When kptr_restrict is set to
292 (2), kernel pointers printed using %pK will be replaced with 0's
293 regardless of privileges.
294
295 ==============================================================
296
297 kstack_depth_to_print: (X86 only)
298
299 Controls the number of words to print when dumping the raw
300 kernel stack.
301
302 ==============================================================
303
304 l2cr: (PPC only)
305
306 This flag controls the L2 cache of G3 processor boards. If
307 0, the cache is disabled. Enabled if nonzero.
308
309 ==============================================================
310
311 modules_disabled:
312
313 A toggle value indicating if modules are allowed to be loaded
314 in an otherwise modular kernel.  This toggle defaults to off
315 (0), but can be set true (1).  Once true, modules can be
316 neither loaded nor unloaded, and the toggle cannot be set back
317 to false.
318
319 ==============================================================
320
321 nmi_watchdog:
322
323 Enables/Disables the NMI watchdog on x86 systems. When the value is
324 non-zero the NMI watchdog is enabled and will continuously test all
325 online cpus to determine whether or not they are still functioning
326 properly. Currently, passing "nmi_watchdog=" parameter at boot time is
327 required for this function to work.
328
329 If LAPIC NMI watchdog method is in use (nmi_watchdog=2 kernel
330 parameter), the NMI watchdog shares registers with oprofile. By
331 disabling the NMI watchdog, oprofile may have more registers to
332 utilize.
333
334 ==============================================================
335
336 osrelease, ostype & version:
337
338 # cat osrelease
339 2.1.88
340 # cat ostype
341 Linux
342 # cat version
343 #5 Wed Feb 25 21:49:24 MET 1998
344
345 The files osrelease and ostype should be clear enough. Version
346 needs a little more clarification however. The '#5' means that
347 this is the fifth kernel built from this source base and the
348 date behind it indicates the time the kernel was built.
349 The only way to tune these values is to rebuild the kernel :-)
350
351 ==============================================================
352
353 overflowgid & overflowuid:
354
355 if your architecture did not always support 32-bit UIDs (i.e. arm,
356 i386, m68k, sh, and sparc32), a fixed UID and GID will be returned to
357 applications that use the old 16-bit UID/GID system calls, if the
358 actual UID or GID would exceed 65535.
359
360 These sysctls allow you to change the value of the fixed UID and GID.
361 The default is 65534.
362
363 ==============================================================
364
365 panic:
366
367 The value in this file represents the number of seconds the kernel
368 waits before rebooting on a panic. When you use the software watchdog,
369 the recommended setting is 60.
370
371 ==============================================================
372
373 panic_on_unrecovered_nmi:
374
375 The default Linux behaviour on an NMI of either memory or unknown is
376 to continue operation. For many environments such as scientific
377 computing it is preferable that the box is taken out and the error
378 dealt with than an uncorrected parity/ECC error get propagated.
379
380 A small number of systems do generate NMI's for bizarre random reasons
381 such as power management so the default is off. That sysctl works like
382 the existing panic controls already in that directory.
383
384 ==============================================================
385
386 panic_on_oops:
387
388 Controls the kernel's behaviour when an oops or BUG is encountered.
389
390 0: try to continue operation
391
392 1: panic immediately.  If the `panic' sysctl is also non-zero then the
393    machine will be rebooted.
394
395 ==============================================================
396
397 panic_on_stackoverflow:
398
399 Controls the kernel's behavior when detecting the overflows of
400 kernel, IRQ and exception stacks except a user stack.
401 This file shows up if CONFIG_DEBUG_STACKOVERFLOW is enabled.
402
403 0: try to continue operation.
404
405 1: panic immediately.
406
407 ==============================================================
408
409
410 pid_max:
411
412 PID allocation wrap value.  When the kernel's next PID value
413 reaches this value, it wraps back to a minimum PID value.
414 PIDs of value pid_max or larger are not allocated.
415
416 ==============================================================
417
418 ns_last_pid:
419
420 The last pid allocated in the current (the one task using this sysctl
421 lives in) pid namespace. When selecting a pid for a next task on fork
422 kernel tries to allocate a number starting from this one.
423
424 ==============================================================
425
426 powersave-nap: (PPC only)
427
428 If set, Linux-PPC will use the 'nap' mode of powersaving,
429 otherwise the 'doze' mode will be used.
430
431 ==============================================================
432
433 printk:
434
435 The four values in printk denote: console_loglevel,
436 default_message_loglevel, minimum_console_loglevel and
437 default_console_loglevel respectively.
438
439 These values influence printk() behavior when printing or
440 logging error messages. See 'man 2 syslog' for more info on
441 the different loglevels.
442
443 - console_loglevel: messages with a higher priority than
444   this will be printed to the console
445 - default_message_loglevel: messages without an explicit priority
446   will be printed with this priority
447 - minimum_console_loglevel: minimum (highest) value to which
448   console_loglevel can be set
449 - default_console_loglevel: default value for console_loglevel
450
451 ==============================================================
452
453 printk_delay:
454
455 Delay each printk message in printk_delay milliseconds
456
457 Value from 0 - 10000 is allowed.
458
459 ==============================================================
460
461 printk_ratelimit:
462
463 Some warning messages are rate limited. printk_ratelimit specifies
464 the minimum length of time between these messages (in jiffies), by
465 default we allow one every 5 seconds.
466
467 A value of 0 will disable rate limiting.
468
469 ==============================================================
470
471 printk_ratelimit_burst:
472
473 While long term we enforce one message per printk_ratelimit
474 seconds, we do allow a burst of messages to pass through.
475 printk_ratelimit_burst specifies the number of messages we can
476 send before ratelimiting kicks in.
477
478 ==============================================================
479
480 randomize_va_space:
481
482 This option can be used to select the type of process address
483 space randomization that is used in the system, for architectures
484 that support this feature.
485
486 0 - Turn the process address space randomization off.  This is the
487     default for architectures that do not support this feature anyways,
488     and kernels that are booted with the "norandmaps" parameter.
489
490 1 - Make the addresses of mmap base, stack and VDSO page randomized.
491     This, among other things, implies that shared libraries will be
492     loaded to random addresses.  Also for PIE-linked binaries, the
493     location of code start is randomized.  This is the default if the
494     CONFIG_COMPAT_BRK option is enabled.
495
496 2 - Additionally enable heap randomization.  This is the default if
497     CONFIG_COMPAT_BRK is disabled.
498
499     There are a few legacy applications out there (such as some ancient
500     versions of libc.so.5 from 1996) that assume that brk area starts
501     just after the end of the code+bss.  These applications break when
502     start of the brk area is randomized.  There are however no known
503     non-legacy applications that would be broken this way, so for most
504     systems it is safe to choose full randomization.
505
506     Systems with ancient and/or broken binaries should be configured
507     with CONFIG_COMPAT_BRK enabled, which excludes the heap from process
508     address space randomization.
509
510 ==============================================================
511
512 reboot-cmd: (Sparc only)
513
514 ??? This seems to be a way to give an argument to the Sparc
515 ROM/Flash boot loader. Maybe to tell it what to do after
516 rebooting. ???
517
518 ==============================================================
519
520 rtsig-max & rtsig-nr:
521
522 The file rtsig-max can be used to tune the maximum number
523 of POSIX realtime (queued) signals that can be outstanding
524 in the system.
525
526 rtsig-nr shows the number of RT signals currently queued.
527
528 ==============================================================
529
530 sg-big-buff:
531
532 This file shows the size of the generic SCSI (sg) buffer.
533 You can't tune it just yet, but you could change it on
534 compile time by editing include/scsi/sg.h and changing
535 the value of SG_BIG_BUFF.
536
537 There shouldn't be any reason to change this value. If
538 you can come up with one, you probably know what you
539 are doing anyway :)
540
541 ==============================================================
542
543 shmmax:
544
545 This value can be used to query and set the run time limit
546 on the maximum shared memory segment size that can be created.
547 Shared memory segments up to 1Gb are now supported in the
548 kernel.  This value defaults to SHMMAX.
549
550 ==============================================================
551
552 shm_rmid_forced:
553
554 Linux lets you set resource limits, including how much memory one
555 process can consume, via setrlimit(2).  Unfortunately, shared memory
556 segments are allowed to exist without association with any process, and
557 thus might not be counted against any resource limits.  If enabled,
558 shared memory segments are automatically destroyed when their attach
559 count becomes zero after a detach or a process termination.  It will
560 also destroy segments that were created, but never attached to, on exit
561 from the process.  The only use left for IPC_RMID is to immediately
562 destroy an unattached segment.  Of course, this breaks the way things are
563 defined, so some applications might stop working.  Note that this
564 feature will do you no good unless you also configure your resource
565 limits (in particular, RLIMIT_AS and RLIMIT_NPROC).  Most systems don't
566 need this.
567
568 Note that if you change this from 0 to 1, already created segments
569 without users and with a dead originative process will be destroyed.
570
571 ==============================================================
572
573 softlockup_thresh:
574
575 This value can be used to lower the softlockup tolerance threshold.  The
576 default threshold is 60 seconds.  If a cpu is locked up for 60 seconds,
577 the kernel complains.  Valid values are 1-60 seconds.  Setting this
578 tunable to zero will disable the softlockup detection altogether.
579
580 ==============================================================
581
582 tainted:
583
584 Non-zero if the kernel has been tainted.  Numeric values, which
585 can be ORed together:
586
587    1 - A module with a non-GPL license has been loaded, this
588        includes modules with no license.
589        Set by modutils >= 2.4.9 and module-init-tools.
590    2 - A module was force loaded by insmod -f.
591        Set by modutils >= 2.4.9 and module-init-tools.
592    4 - Unsafe SMP processors: SMP with CPUs not designed for SMP.
593    8 - A module was forcibly unloaded from the system by rmmod -f.
594   16 - A hardware machine check error occurred on the system.
595   32 - A bad page was discovered on the system.
596   64 - The user has asked that the system be marked "tainted".  This
597        could be because they are running software that directly modifies
598        the hardware, or for other reasons.
599  128 - The system has died.
600  256 - The ACPI DSDT has been overridden with one supplied by the user
601         instead of using the one provided by the hardware.
602  512 - A kernel warning has occurred.
603 1024 - A module from drivers/staging was loaded.
604 2048 - The system is working around a severe firmware bug.
605 4096 - An out-of-tree module has been loaded.
606
607 ==============================================================
608
609 unknown_nmi_panic:
610
611 The value in this file affects behavior of handling NMI. When the
612 value is non-zero, unknown NMI is trapped and then panic occurs. At
613 that time, kernel debugging information is displayed on console.
614
615 NMI switch that most IA32 servers have fires unknown NMI up, for
616 example.  If a system hangs up, try pressing the NMI switch.