blob: a87be42f82117cb94c5320baeda799becbdc6933 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001------------------------------------------------------------------------------
2 T H E /proc F I L E S Y S T E M
3------------------------------------------------------------------------------
4/proc/sys Terrehon Bowden <terrehon@pacbell.net> October 7 1999
5 Bodo Bauer <bb@ricochet.net>
6
72.4.x update Jorge Nerin <comandante@zaralinux.com> November 14 2000
8------------------------------------------------------------------------------
9Version 1.3 Kernel version 2.2.12
10 Kernel version 2.4.0-test11-pre4
11------------------------------------------------------------------------------
12
13Table of Contents
14-----------------
15
16 0 Preface
17 0.1 Introduction/Credits
18 0.2 Legal Stuff
19
20 1 Collecting System Information
21 1.1 Process-Specific Subdirectories
22 1.2 Kernel data
23 1.3 IDE devices in /proc/ide
24 1.4 Networking info in /proc/net
25 1.5 SCSI info
26 1.6 Parallel port info in /proc/parport
27 1.7 TTY info in /proc/tty
28 1.8 Miscellaneous kernel statistics in /proc/stat
29
30 2 Modifying System Parameters
31 2.1 /proc/sys/fs - File system data
32 2.2 /proc/sys/fs/binfmt_misc - Miscellaneous binary formats
33 2.3 /proc/sys/kernel - general kernel parameters
34 2.4 /proc/sys/vm - The virtual memory subsystem
35 2.5 /proc/sys/dev - Device specific parameters
36 2.6 /proc/sys/sunrpc - Remote procedure calls
37 2.7 /proc/sys/net - Networking stuff
38 2.8 /proc/sys/net/ipv4 - IPV4 settings
39 2.9 Appletalk
40 2.10 IPX
41 2.11 /proc/sys/fs/mqueue - POSIX message queues filesystem
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -070042 2.12 /proc/<pid>/oom_adj - Adjust the oom-killer score
43 2.13 /proc/<pid>/oom_score - Display current oom-killer score
Roland Kletzingf9c99462007-03-05 00:30:54 -080044 2.14 /proc/<pid>/io - Display the IO accounting fields
Kawai, Hidehirobb901102007-07-19 01:48:31 -070045 2.15 /proc/<pid>/coredump_filter - Core dump filtering settings
Ram Pai2d4d4862008-03-27 13:06:25 +010046 2.16 /proc/<pid>/mountinfo - Information about mounts
Davide Libenzi7ef99642008-12-01 13:13:55 -080047 2.17 /proc/sys/fs/epoll - Configuration options for the epoll interface
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49------------------------------------------------------------------------------
50Preface
51------------------------------------------------------------------------------
52
530.1 Introduction/Credits
54------------------------
55
56This documentation is part of a soon (or so we hope) to be released book on
57the SuSE Linux distribution. As there is no complete documentation for the
58/proc file system and we've used many freely available sources to write these
59chapters, it seems only fair to give the work back to the Linux community.
60This work is based on the 2.2.* kernel version and the upcoming 2.4.*. I'm
61afraid it's still far from complete, but we hope it will be useful. As far as
62we know, it is the first 'all-in-one' document about the /proc file system. It
63is focused on the Intel x86 hardware, so if you are looking for PPC, ARM,
64SPARC, AXP, etc., features, you probably won't find what you are looking for.
65It also only covers IPv4 networking, not IPv6 nor other protocols - sorry. But
66additions and patches are welcome and will be added to this document if you
67mail them to Bodo.
68
69We'd like to thank Alan Cox, Rik van Riel, and Alexey Kuznetsov and a lot of
70other people for help compiling this documentation. We'd also like to extend a
71special thank you to Andi Kleen for documentation, which we relied on heavily
72to create this document, as well as the additional information he provided.
73Thanks to everybody else who contributed source or docs to the Linux kernel
74and helped create a great piece of software... :)
75
76If you have any comments, corrections or additions, please don't hesitate to
77contact Bodo Bauer at bb@ricochet.net. We'll be happy to add them to this
78document.
79
80The latest version of this document is available online at
81http://skaro.nightcrawler.com/~bb/Docs/Proc as HTML version.
82
83If the above direction does not works for you, ypu could try the kernel
84mailing list at linux-kernel@vger.kernel.org and/or try to reach me at
85comandante@zaralinux.com.
86
870.2 Legal Stuff
88---------------
89
90We don't guarantee the correctness of this document, and if you come to us
91complaining about how you screwed up your system because of incorrect
92documentation, we won't feel responsible...
93
94------------------------------------------------------------------------------
95CHAPTER 1: COLLECTING SYSTEM INFORMATION
96------------------------------------------------------------------------------
97
98------------------------------------------------------------------------------
99In This Chapter
100------------------------------------------------------------------------------
101* Investigating the properties of the pseudo file system /proc and its
102 ability to provide information on the running Linux system
103* Examining /proc's structure
104* Uncovering various information about the kernel and the processes running
105 on the system
106------------------------------------------------------------------------------
107
108
109The proc file system acts as an interface to internal data structures in the
110kernel. It can be used to obtain information about the system and to change
111certain kernel parameters at runtime (sysctl).
112
113First, we'll take a look at the read-only parts of /proc. In Chapter 2, we
114show you how you can use /proc/sys to change settings.
115
1161.1 Process-Specific Subdirectories
117-----------------------------------
118
119The directory /proc contains (among other things) one subdirectory for each
120process running on the system, which is named after the process ID (PID).
121
122The link self points to the process reading the file system. Each process
123subdirectory has the entries listed in Table 1-1.
124
125
126Table 1-1: Process specific entries in /proc
127..............................................................................
David Rientjesb813e932007-05-06 14:49:24 -0700128 File Content
129 clear_refs Clears page referenced bits shown in smaps output
130 cmdline Command line arguments
131 cpu Current and last cpu in which it was executed (2.4)(smp)
132 cwd Link to the current working directory
133 environ Values of environment variables
134 exe Link to the executable of this process
135 fd Directory, which contains all file descriptors
136 maps Memory maps to executables and library files (2.4)
137 mem Memory held by this process
138 root Link to the root directory of this process
139 stat Process status
140 statm Process memory status information
141 status Process status in human readable form
142 wchan If CONFIG_KALLSYMS is set, a pre-decoded wchan
Ken Chen2ec220e2008-11-10 11:26:08 +0300143 stack Report full stack trace, enable via CONFIG_STACKTRACE
David Rientjesb813e932007-05-06 14:49:24 -0700144 smaps Extension based on maps, the rss size for each mapped file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145..............................................................................
146
147For example, to get the status information of a process, all you have to do is
148read the file /proc/PID/status:
149
150 >cat /proc/self/status
151 Name: cat
152 State: R (running)
153 Pid: 5452
154 PPid: 743
155 TracerPid: 0 (2.4)
156 Uid: 501 501 501 501
157 Gid: 100 100 100 100
158 Groups: 100 14 16
159 VmSize: 1112 kB
160 VmLck: 0 kB
161 VmRSS: 348 kB
162 VmData: 24 kB
163 VmStk: 12 kB
164 VmExe: 8 kB
165 VmLib: 1044 kB
166 SigPnd: 0000000000000000
167 SigBlk: 0000000000000000
168 SigIgn: 0000000000000000
169 SigCgt: 0000000000000000
170 CapInh: 00000000fffffeff
171 CapPrm: 0000000000000000
172 CapEff: 0000000000000000
173
174
175This shows you nearly the same information you would get if you viewed it with
176the ps command. In fact, ps uses the proc file system to obtain its
177information. The statm file contains more detailed information about the
Kees Cook18d96772007-07-15 23:40:38 -0700178process memory usage. Its seven fields are explained in Table 1-2. The stat
179file contains details information about the process itself. Its fields are
180explained in Table 1-3.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
182
183Table 1-2: Contents of the statm files (as of 2.6.8-rc3)
184..............................................................................
185 Field Content
186 size total program size (pages) (same as VmSize in status)
187 resident size of memory portions (pages) (same as VmRSS in status)
188 shared number of pages that are shared (i.e. backed by a file)
189 trs number of pages that are 'code' (not including libs; broken,
190 includes data segment)
191 lrs number of pages of library (always 0 on 2.6)
192 drs number of pages of data/stack (including libs; broken,
193 includes library text)
194 dt number of dirty pages (always 0 on 2.6)
195..............................................................................
196
Kees Cook18d96772007-07-15 23:40:38 -0700197
198Table 1-3: Contents of the stat files (as of 2.6.22-rc3)
199..............................................................................
200 Field Content
201 pid process id
202 tcomm filename of the executable
203 state state (R is running, S is sleeping, D is sleeping in an
204 uninterruptible wait, Z is zombie, T is traced or stopped)
205 ppid process id of the parent process
206 pgrp pgrp of the process
207 sid session id
208 tty_nr tty the process uses
209 tty_pgrp pgrp of the tty
210 flags task flags
211 min_flt number of minor faults
212 cmin_flt number of minor faults with child's
213 maj_flt number of major faults
214 cmaj_flt number of major faults with child's
215 utime user mode jiffies
216 stime kernel mode jiffies
217 cutime user mode jiffies with child's
218 cstime kernel mode jiffies with child's
219 priority priority level
220 nice nice level
221 num_threads number of threads
Leonardo Chiquitto2e01e002008-02-03 16:17:16 +0200222 it_real_value (obsolete, always 0)
Kees Cook18d96772007-07-15 23:40:38 -0700223 start_time time the process started after system boot
224 vsize virtual memory size
225 rss resident set memory size
226 rsslim current limit in bytes on the rss
227 start_code address above which program text can run
228 end_code address below which program text can run
229 start_stack address of the start of the stack
230 esp current value of ESP
231 eip current value of EIP
232 pending bitmap of pending signals (obsolete)
233 blocked bitmap of blocked signals (obsolete)
234 sigign bitmap of ignored signals (obsolete)
235 sigcatch bitmap of catched signals (obsolete)
236 wchan address where process went to sleep
237 0 (place holder)
238 0 (place holder)
239 exit_signal signal to send to parent thread on exit
240 task_cpu which CPU the task is scheduled on
241 rt_priority realtime priority
242 policy scheduling policy (man sched_setscheduler)
243 blkio_ticks time spent waiting for block IO
244..............................................................................
245
246
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471.2 Kernel data
248---------------
249
250Similar to the process entries, the kernel data files give information about
251the running kernel. The files used to obtain this information are contained in
Kees Cook18d96772007-07-15 23:40:38 -0700252/proc and are listed in Table 1-4. Not all of these will be present in your
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253system. It depends on the kernel configuration and the loaded modules, which
254files are there, and which are missing.
255
Kees Cook18d96772007-07-15 23:40:38 -0700256Table 1-4: Kernel info in /proc
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257..............................................................................
258 File Content
259 apm Advanced power management info
260 buddyinfo Kernel memory allocator information (see text) (2.5)
261 bus Directory containing bus specific information
262 cmdline Kernel command line
263 cpuinfo Info about the CPU
264 devices Available devices (block and character)
265 dma Used DMS channels
266 filesystems Supported filesystems
267 driver Various drivers grouped here, currently rtc (2.4)
268 execdomains Execdomains, related to security (2.4)
269 fb Frame Buffer devices (2.4)
270 fs File system parameters, currently nfs/exports (2.4)
271 ide Directory containing info about the IDE subsystem
272 interrupts Interrupt usage
273 iomem Memory map (2.4)
274 ioports I/O port usage
275 irq Masks for irq to cpu affinity (2.4)(smp?)
276 isapnp ISA PnP (Plug&Play) Info (2.4)
277 kcore Kernel core image (can be ELF or A.OUT(deprecated in 2.4))
278 kmsg Kernel messages
279 ksyms Kernel symbol table
280 loadavg Load average of last 1, 5 & 15 minutes
281 locks Kernel locks
282 meminfo Memory info
283 misc Miscellaneous
284 modules List of loaded modules
285 mounts Mounted filesystems
286 net Networking info (see text)
287 partitions Table of partitions known to the system
Randy Dunlap8b607562007-05-09 07:19:14 +0200288 pci Deprecated info of PCI bus (new way -> /proc/bus/pci/,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 decoupled by lspci (2.4)
290 rtc Real time clock
291 scsi SCSI info (see text)
292 slabinfo Slab pool info
293 stat Overall statistics
294 swaps Swap space utilization
295 sys See chapter 2
296 sysvipc Info of SysVIPC Resources (msg, sem, shm) (2.4)
297 tty Info of tty drivers
298 uptime System uptime
299 version Kernel version
300 video bttv info of video resources (2.4)
Eric Dumazeta47a1262008-07-23 21:27:38 -0700301 vmallocinfo Show vmalloced areas
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302..............................................................................
303
304You can, for example, check which interrupts are currently in use and what
305they are used for by looking in the file /proc/interrupts:
306
307 > cat /proc/interrupts
308 CPU0
309 0: 8728810 XT-PIC timer
310 1: 895 XT-PIC keyboard
311 2: 0 XT-PIC cascade
312 3: 531695 XT-PIC aha152x
313 4: 2014133 XT-PIC serial
314 5: 44401 XT-PIC pcnet_cs
315 8: 2 XT-PIC rtc
316 11: 8 XT-PIC i82365
317 12: 182918 XT-PIC PS/2 Mouse
318 13: 1 XT-PIC fpu
319 14: 1232265 XT-PIC ide0
320 15: 7 XT-PIC ide1
321 NMI: 0
322
323In 2.4.* a couple of lines where added to this file LOC & ERR (this time is the
324output of a SMP machine):
325
326 > cat /proc/interrupts
327
328 CPU0 CPU1
329 0: 1243498 1214548 IO-APIC-edge timer
330 1: 8949 8958 IO-APIC-edge keyboard
331 2: 0 0 XT-PIC cascade
332 5: 11286 10161 IO-APIC-edge soundblaster
333 8: 1 0 IO-APIC-edge rtc
334 9: 27422 27407 IO-APIC-edge 3c503
335 12: 113645 113873 IO-APIC-edge PS/2 Mouse
336 13: 0 0 XT-PIC fpu
337 14: 22491 24012 IO-APIC-edge ide0
338 15: 2183 2415 IO-APIC-edge ide1
339 17: 30564 30414 IO-APIC-level eth0
340 18: 177 164 IO-APIC-level bttv
341 NMI: 2457961 2457959
342 LOC: 2457882 2457881
343 ERR: 2155
344
345NMI is incremented in this case because every timer interrupt generates a NMI
346(Non Maskable Interrupt) which is used by the NMI Watchdog to detect lockups.
347
348LOC is the local interrupt counter of the internal APIC of every CPU.
349
350ERR is incremented in the case of errors in the IO-APIC bus (the bus that
351connects the CPUs in a SMP system. This means that an error has been detected,
352the IO-APIC automatically retry the transmission, so it should not be a big
353problem, but you should read the SMP-FAQ.
354
Joe Korty38e760a2007-10-17 18:04:40 +0200355In 2.6.2* /proc/interrupts was expanded again. This time the goal was for
356/proc/interrupts to display every IRQ vector in use by the system, not
357just those considered 'most important'. The new vectors are:
358
359 THR -- interrupt raised when a machine check threshold counter
360 (typically counting ECC corrected errors of memory or cache) exceeds
361 a configurable threshold. Only available on some systems.
362
363 TRM -- a thermal event interrupt occurs when a temperature threshold
364 has been exceeded for the CPU. This interrupt may also be generated
365 when the temperature drops back to normal.
366
367 SPU -- a spurious interrupt is some interrupt that was raised then lowered
368 by some IO device before it could be fully processed by the APIC. Hence
369 the APIC sees the interrupt but does not know what device it came from.
370 For this case the APIC will generate the interrupt with a IRQ vector
371 of 0xff. This might also be generated by chipset bugs.
372
373 RES, CAL, TLB -- rescheduling, call and TLB flush interrupts are
374 sent from one CPU to another per the needs of the OS. Typically,
375 their statistics are used by kernel developers and interested users to
376 determine the occurance of interrupt of the given type.
377
378The above IRQ vectors are displayed only when relevent. For example,
379the threshold vector does not exist on x86_64 platforms. Others are
380suppressed when the system is a uniprocessor. As of this writing, only
381i386 and x86_64 platforms support the new IRQ vector displays.
382
383Of some interest is the introduction of the /proc/irq directory to 2.4.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384It could be used to set IRQ to CPU affinity, this means that you can "hook" an
385IRQ to only one CPU, or to exclude a CPU of handling IRQs. The contents of the
Max Krasnyansky18404752008-05-29 11:02:52 -0700386irq subdir is one subdir for each IRQ, and two files; default_smp_affinity and
387prof_cpu_mask.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389For example
390 > ls /proc/irq/
391 0 10 12 14 16 18 2 4 6 8 prof_cpu_mask
Max Krasnyansky18404752008-05-29 11:02:52 -0700392 1 11 13 15 17 19 3 5 7 9 default_smp_affinity
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 > ls /proc/irq/0/
394 smp_affinity
395
Max Krasnyansky18404752008-05-29 11:02:52 -0700396smp_affinity is a bitmask, in which you can specify which CPUs can handle the
397IRQ, you can set it by doing:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Max Krasnyansky18404752008-05-29 11:02:52 -0700399 > echo 1 > /proc/irq/10/smp_affinity
400
401This means that only the first CPU will handle the IRQ, but you can also echo
4025 which means that only the first and fourth CPU can handle the IRQ.
403
404The contents of each smp_affinity file is the same by default:
405
406 > cat /proc/irq/0/smp_affinity
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 ffffffff
408
Max Krasnyansky18404752008-05-29 11:02:52 -0700409The default_smp_affinity mask applies to all non-active IRQs, which are the
410IRQs which have not yet been allocated/activated, and hence which lack a
411/proc/irq/[0-9]* directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Max Krasnyansky18404752008-05-29 11:02:52 -0700413prof_cpu_mask specifies which CPUs are to be profiled by the system wide
414profiler. Default value is ffffffff (all cpus).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416The way IRQs are routed is handled by the IO-APIC, and it's Round Robin
417between all the CPUs which are allowed to handle it. As usual the kernel has
418more info than you and does a better job than you, so the defaults are the
419best choice for almost everyone.
420
421There are three more important subdirectories in /proc: net, scsi, and sys.
422The general rule is that the contents, or even the existence of these
423directories, depend on your kernel configuration. If SCSI is not enabled, the
424directory scsi may not exist. The same is true with the net, which is there
425only when networking support is present in the running kernel.
426
427The slabinfo file gives information about memory usage at the slab level.
428Linux uses slab pools for memory management above page level in version 2.2.
429Commonly used objects have their own slab pool (such as network buffers,
430directory cache, and so on).
431
432..............................................................................
433
434> cat /proc/buddyinfo
435
436Node 0, zone DMA 0 4 5 4 4 3 ...
437Node 0, zone Normal 1 0 0 1 101 8 ...
438Node 0, zone HighMem 2 0 0 1 1 0 ...
439
440Memory fragmentation is a problem under some workloads, and buddyinfo is a
441useful tool for helping diagnose these problems. Buddyinfo will give you a
442clue as to how big an area you can safely allocate, or why a previous
443allocation failed.
444
445Each column represents the number of pages of a certain order which are
446available. In this case, there are 0 chunks of 2^0*PAGE_SIZE available in
447ZONE_DMA, 4 chunks of 2^1*PAGE_SIZE in ZONE_DMA, 101 chunks of 2^4*PAGE_SIZE
448available in ZONE_NORMAL, etc...
449
450..............................................................................
451
452meminfo:
453
454Provides information about distribution and utilization of memory. This
455varies by architecture and compile options. The following is from a
45616GB PIII, which has highmem enabled. You may not have all of these fields.
457
458> cat /proc/meminfo
459
460
461MemTotal: 16344972 kB
462MemFree: 13634064 kB
463Buffers: 3656 kB
464Cached: 1195708 kB
465SwapCached: 0 kB
466Active: 891636 kB
467Inactive: 1077224 kB
468HighTotal: 15597528 kB
469HighFree: 13629632 kB
470LowTotal: 747444 kB
471LowFree: 4432 kB
472SwapTotal: 0 kB
473SwapFree: 0 kB
474Dirty: 968 kB
475Writeback: 0 kB
Miklos Szeredib88473f2008-04-30 00:54:39 -0700476AnonPages: 861800 kB
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477Mapped: 280372 kB
Miklos Szeredib88473f2008-04-30 00:54:39 -0700478Slab: 284364 kB
479SReclaimable: 159856 kB
480SUnreclaim: 124508 kB
481PageTables: 24448 kB
482NFS_Unstable: 0 kB
483Bounce: 0 kB
484WritebackTmp: 0 kB
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485CommitLimit: 7669796 kB
486Committed_AS: 100056 kB
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487VmallocTotal: 112216 kB
488VmallocUsed: 428 kB
489VmallocChunk: 111088 kB
490
491 MemTotal: Total usable ram (i.e. physical ram minus a few reserved
492 bits and the kernel binary code)
493 MemFree: The sum of LowFree+HighFree
494 Buffers: Relatively temporary storage for raw disk blocks
495 shouldn't get tremendously large (20MB or so)
496 Cached: in-memory cache for files read from the disk (the
497 pagecache). Doesn't include SwapCached
498 SwapCached: Memory that once was swapped out, is swapped back in but
499 still also is in the swapfile (if memory is needed it
500 doesn't need to be swapped out AGAIN because it is already
501 in the swapfile. This saves I/O)
502 Active: Memory that has been used more recently and usually not
503 reclaimed unless absolutely necessary.
504 Inactive: Memory which has been less recently used. It is more
505 eligible to be reclaimed for other purposes
506 HighTotal:
507 HighFree: Highmem is all memory above ~860MB of physical memory
508 Highmem areas are for use by userspace programs, or
509 for the pagecache. The kernel must use tricks to access
510 this memory, making it slower to access than lowmem.
511 LowTotal:
512 LowFree: Lowmem is memory which can be used for everything that
Matt LaPlante3f6dee92006-10-03 22:45:33 +0200513 highmem can be used for, but it is also available for the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 kernel's use for its own data structures. Among many
515 other things, it is where everything from the Slab is
516 allocated. Bad things happen when you're out of lowmem.
517 SwapTotal: total amount of swap space available
518 SwapFree: Memory which has been evicted from RAM, and is temporarily
519 on the disk
520 Dirty: Memory which is waiting to get written back to the disk
521 Writeback: Memory which is actively being written back to the disk
Miklos Szeredib88473f2008-04-30 00:54:39 -0700522 AnonPages: Non-file backed pages mapped into userspace page tables
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 Mapped: files which have been mmaped, such as libraries
Adrian Bunke82443c2006-01-10 00:20:30 +0100524 Slab: in-kernel data structures cache
Miklos Szeredib88473f2008-04-30 00:54:39 -0700525SReclaimable: Part of Slab, that might be reclaimed, such as caches
526 SUnreclaim: Part of Slab, that cannot be reclaimed on memory pressure
527 PageTables: amount of memory dedicated to the lowest level of page
528 tables.
529NFS_Unstable: NFS pages sent to the server, but not yet committed to stable
530 storage
531 Bounce: Memory used for block device "bounce buffers"
532WritebackTmp: Memory used by FUSE for temporary writeback buffers
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 CommitLimit: Based on the overcommit ratio ('vm.overcommit_ratio'),
534 this is the total amount of memory currently available to
535 be allocated on the system. This limit is only adhered to
536 if strict overcommit accounting is enabled (mode 2 in
537 'vm.overcommit_memory').
538 The CommitLimit is calculated with the following formula:
539 CommitLimit = ('vm.overcommit_ratio' * Physical RAM) + Swap
540 For example, on a system with 1G of physical RAM and 7G
541 of swap with a `vm.overcommit_ratio` of 30 it would
542 yield a CommitLimit of 7.3G.
543 For more details, see the memory overcommit documentation
544 in vm/overcommit-accounting.
545Committed_AS: The amount of memory presently allocated on the system.
546 The committed memory is a sum of all of the memory which
547 has been allocated by processes, even if it has not been
548 "used" by them as of yet. A process which malloc()'s 1G
549 of memory, but only touches 300M of it will only show up
550 as using 300M of memory even if it has the address space
551 allocated for the entire 1G. This 1G is memory which has
552 been "committed" to by the VM and can be used at any time
553 by the allocating application. With strict overcommit
554 enabled on the system (mode 2 in 'vm.overcommit_memory'),
555 allocations which would exceed the CommitLimit (detailed
556 above) will not be permitted. This is useful if one needs
557 to guarantee that processes will not fail due to lack of
558 memory once that memory has been successfully allocated.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559VmallocTotal: total size of vmalloc memory area
560 VmallocUsed: amount of vmalloc area which is used
561VmallocChunk: largest contigious block of vmalloc area which is free
562
Eric Dumazeta47a1262008-07-23 21:27:38 -0700563..............................................................................
564
565vmallocinfo:
566
567Provides information about vmalloced/vmaped areas. One line per area,
568containing the virtual address range of the area, size in bytes,
569caller information of the creator, and optional information depending
570on the kind of area :
571
572 pages=nr number of pages
573 phys=addr if a physical address was specified
574 ioremap I/O mapping (ioremap() and friends)
575 vmalloc vmalloc() area
576 vmap vmap()ed pages
577 user VM_USERMAP area
578 vpages buffer for pages pointers was vmalloced (huge area)
579 N<node>=nr (Only on NUMA kernels)
580 Number of pages allocated on memory node <node>
581
582> cat /proc/vmallocinfo
5830xffffc20000000000-0xffffc20000201000 2101248 alloc_large_system_hash+0x204 ...
584 /0x2c0 pages=512 vmalloc N0=128 N1=128 N2=128 N3=128
5850xffffc20000201000-0xffffc20000302000 1052672 alloc_large_system_hash+0x204 ...
586 /0x2c0 pages=256 vmalloc N0=64 N1=64 N2=64 N3=64
5870xffffc20000302000-0xffffc20000304000 8192 acpi_tb_verify_table+0x21/0x4f...
588 phys=7fee8000 ioremap
5890xffffc20000304000-0xffffc20000307000 12288 acpi_tb_verify_table+0x21/0x4f...
590 phys=7fee7000 ioremap
5910xffffc2000031d000-0xffffc2000031f000 8192 init_vdso_vars+0x112/0x210
5920xffffc2000031f000-0xffffc2000032b000 49152 cramfs_uncompress_init+0x2e ...
593 /0x80 pages=11 vmalloc N0=3 N1=3 N2=2 N3=3
5940xffffc2000033a000-0xffffc2000033d000 12288 sys_swapon+0x640/0xac0 ...
595 pages=2 vmalloc N1=2
5960xffffc20000347000-0xffffc2000034c000 20480 xt_alloc_table_info+0xfe ...
597 /0x130 [x_tables] pages=4 vmalloc N0=4
5980xffffffffa0000000-0xffffffffa000f000 61440 sys_init_module+0xc27/0x1d00 ...
599 pages=14 vmalloc N2=14
6000xffffffffa000f000-0xffffffffa0014000 20480 sys_init_module+0xc27/0x1d00 ...
601 pages=4 vmalloc N1=4
6020xffffffffa0014000-0xffffffffa0017000 12288 sys_init_module+0xc27/0x1d00 ...
603 pages=2 vmalloc N1=2
6040xffffffffa0017000-0xffffffffa0022000 45056 sys_init_module+0xc27/0x1d00 ...
605 pages=10 vmalloc N0=10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
6071.3 IDE devices in /proc/ide
608----------------------------
609
610The subdirectory /proc/ide contains information about all IDE devices of which
611the kernel is aware. There is one subdirectory for each IDE controller, the
612file drivers and a link for each IDE device, pointing to the device directory
613in the controller specific subtree.
614
615The file drivers contains general information about the drivers used for the
616IDE devices:
617
618 > cat /proc/ide/drivers
619 ide-cdrom version 4.53
620 ide-disk version 1.08
621
622More detailed information can be found in the controller specific
623subdirectories. These are named ide0, ide1 and so on. Each of these
Kees Cook18d96772007-07-15 23:40:38 -0700624directories contains the files shown in table 1-5.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626
Kees Cook18d96772007-07-15 23:40:38 -0700627Table 1-5: IDE controller info in /proc/ide/ide?
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628..............................................................................
629 File Content
630 channel IDE channel (0 or 1)
631 config Configuration (only for PCI/IDE bridge)
632 mate Mate name
633 model Type/Chipset of IDE controller
634..............................................................................
635
636Each device connected to a controller has a separate subdirectory in the
Kees Cook18d96772007-07-15 23:40:38 -0700637controllers directory. The files listed in table 1-6 are contained in these
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638directories.
639
640
Kees Cook18d96772007-07-15 23:40:38 -0700641Table 1-6: IDE device information
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642..............................................................................
643 File Content
644 cache The cache
645 capacity Capacity of the medium (in 512Byte blocks)
646 driver driver and version
647 geometry physical and logical geometry
648 identify device identify block
649 media media type
650 model device identifier
651 settings device setup
652 smart_thresholds IDE disk management thresholds
653 smart_values IDE disk management values
654..............................................................................
655
656The most interesting file is settings. This file contains a nice overview of
657the drive parameters:
658
659 # cat /proc/ide/ide0/hda/settings
660 name value min max mode
661 ---- ----- --- --- ----
662 bios_cyl 526 0 65535 rw
663 bios_head 255 0 255 rw
664 bios_sect 63 0 63 rw
665 breada_readahead 4 0 127 rw
666 bswap 0 0 1 r
667 file_readahead 72 0 2097151 rw
668 io_32bit 0 0 3 rw
669 keepsettings 0 0 1 rw
670 max_kb_per_request 122 1 127 rw
671 multcount 0 0 8 rw
672 nice1 1 0 1 rw
673 nowerr 0 0 1 rw
674 pio_mode write-only 0 255 w
675 slow 0 0 1 rw
676 unmaskirq 0 0 1 rw
677 using_dma 0 0 1 rw
678
679
6801.4 Networking info in /proc/net
681--------------------------------
682
683The subdirectory /proc/net follows the usual pattern. Table 1-6 shows the
684additional values you get for IP version 6 if you configure the kernel to
685support this. Table 1-7 lists the files and their meaning.
686
687
688Table 1-6: IPv6 info in /proc/net
689..............................................................................
690 File Content
691 udp6 UDP sockets (IPv6)
692 tcp6 TCP sockets (IPv6)
693 raw6 Raw device statistics (IPv6)
694 igmp6 IP multicast addresses, which this host joined (IPv6)
695 if_inet6 List of IPv6 interface addresses
696 ipv6_route Kernel routing table for IPv6
697 rt6_stats Global IPv6 routing tables statistics
698 sockstat6 Socket statistics (IPv6)
699 snmp6 Snmp data (IPv6)
700..............................................................................
701
702
703Table 1-7: Network info in /proc/net
704..............................................................................
705 File Content
706 arp Kernel ARP table
707 dev network devices with statistics
708 dev_mcast the Layer2 multicast groups a device is listening too
709 (interface index, label, number of references, number of bound
710 addresses).
711 dev_stat network device status
712 ip_fwchains Firewall chain linkage
713 ip_fwnames Firewall chain names
714 ip_masq Directory containing the masquerading tables
715 ip_masquerade Major masquerading table
716 netstat Network statistics
717 raw raw device statistics
718 route Kernel routing table
719 rpc Directory containing rpc info
720 rt_cache Routing cache
721 snmp SNMP data
722 sockstat Socket statistics
723 tcp TCP sockets
724 tr_rif Token ring RIF routing table
725 udp UDP sockets
726 unix UNIX domain sockets
727 wireless Wireless interface data (Wavelan etc)
728 igmp IP multicast addresses, which this host joined
729 psched Global packet scheduler parameters.
730 netlink List of PF_NETLINK sockets
731 ip_mr_vifs List of multicast virtual interfaces
732 ip_mr_cache List of multicast routing cache
733..............................................................................
734
735You can use this information to see which network devices are available in
736your system and how much traffic was routed over those devices:
737
738 > cat /proc/net/dev
739 Inter-|Receive |[...
740 face |bytes packets errs drop fifo frame compressed multicast|[...
741 lo: 908188 5596 0 0 0 0 0 0 [...
742 ppp0:15475140 20721 410 0 0 410 0 0 [...
743 eth0: 614530 7085 0 0 0 0 0 1 [...
744
745 ...] Transmit
746 ...] bytes packets errs drop fifo colls carrier compressed
747 ...] 908188 5596 0 0 0 0 0 0
748 ...] 1375103 17405 0 0 0 0 0 0
749 ...] 1703981 5535 0 0 0 3 0 0
750
751In addition, each Channel Bond interface has it's own directory. For
752example, the bond0 device will have a directory called /proc/net/bond0/.
753It will contain information that is specific to that bond, such as the
754current slaves of the bond, the link status of the slaves, and how
755many times the slaves link has failed.
756
7571.5 SCSI info
758-------------
759
760If you have a SCSI host adapter in your system, you'll find a subdirectory
761named after the driver for this adapter in /proc/scsi. You'll also see a list
762of all recognized SCSI devices in /proc/scsi:
763
764 >cat /proc/scsi/scsi
765 Attached devices:
766 Host: scsi0 Channel: 00 Id: 00 Lun: 00
767 Vendor: IBM Model: DGHS09U Rev: 03E0
768 Type: Direct-Access ANSI SCSI revision: 03
769 Host: scsi0 Channel: 00 Id: 06 Lun: 00
770 Vendor: PIONEER Model: CD-ROM DR-U06S Rev: 1.04
771 Type: CD-ROM ANSI SCSI revision: 02
772
773
774The directory named after the driver has one file for each adapter found in
775the system. These files contain information about the controller, including
776the used IRQ and the IO address range. The amount of information shown is
777dependent on the adapter you use. The example shows the output for an Adaptec
778AHA-2940 SCSI adapter:
779
780 > cat /proc/scsi/aic7xxx/0
781
782 Adaptec AIC7xxx driver version: 5.1.19/3.2.4
783 Compile Options:
784 TCQ Enabled By Default : Disabled
785 AIC7XXX_PROC_STATS : Disabled
786 AIC7XXX_RESET_DELAY : 5
787 Adapter Configuration:
788 SCSI Adapter: Adaptec AHA-294X Ultra SCSI host adapter
789 Ultra Wide Controller
790 PCI MMAPed I/O Base: 0xeb001000
791 Adapter SEEPROM Config: SEEPROM found and used.
792 Adaptec SCSI BIOS: Enabled
793 IRQ: 10
794 SCBs: Active 0, Max Active 2,
795 Allocated 15, HW 16, Page 255
796 Interrupts: 160328
797 BIOS Control Word: 0x18b6
798 Adapter Control Word: 0x005b
799 Extended Translation: Enabled
800 Disconnect Enable Flags: 0xffff
801 Ultra Enable Flags: 0x0001
802 Tag Queue Enable Flags: 0x0000
803 Ordered Queue Tag Flags: 0x0000
804 Default Tag Queue Depth: 8
805 Tagged Queue By Device array for aic7xxx host instance 0:
806 {255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255}
807 Actual queue depth per device for aic7xxx host instance 0:
808 {1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1}
809 Statistics:
810 (scsi0:0:0:0)
811 Device using Wide/Sync transfers at 40.0 MByte/sec, offset 8
812 Transinfo settings: current(12/8/1/0), goal(12/8/1/0), user(12/15/1/0)
813 Total transfers 160151 (74577 reads and 85574 writes)
814 (scsi0:0:6:0)
815 Device using Narrow/Sync transfers at 5.0 MByte/sec, offset 15
816 Transinfo settings: current(50/15/0/0), goal(50/15/0/0), user(50/15/0/0)
817 Total transfers 0 (0 reads and 0 writes)
818
819
8201.6 Parallel port info in /proc/parport
821---------------------------------------
822
823The directory /proc/parport contains information about the parallel ports of
824your system. It has one subdirectory for each port, named after the port
825number (0,1,2,...).
826
827These directories contain the four files shown in Table 1-8.
828
829
830Table 1-8: Files in /proc/parport
831..............................................................................
832 File Content
833 autoprobe Any IEEE-1284 device ID information that has been acquired.
834 devices list of the device drivers using that port. A + will appear by the
835 name of the device currently using the port (it might not appear
836 against any).
837 hardware Parallel port's base address, IRQ line and DMA channel.
838 irq IRQ that parport is using for that port. This is in a separate
839 file to allow you to alter it by writing a new value in (IRQ
840 number or none).
841..............................................................................
842
8431.7 TTY info in /proc/tty
844-------------------------
845
846Information about the available and actually used tty's can be found in the
847directory /proc/tty.You'll find entries for drivers and line disciplines in
848this directory, as shown in Table 1-9.
849
850
851Table 1-9: Files in /proc/tty
852..............................................................................
853 File Content
854 drivers list of drivers and their usage
855 ldiscs registered line disciplines
856 driver/serial usage statistic and status of single tty lines
857..............................................................................
858
859To see which tty's are currently in use, you can simply look into the file
860/proc/tty/drivers:
861
862 > cat /proc/tty/drivers
863 pty_slave /dev/pts 136 0-255 pty:slave
864 pty_master /dev/ptm 128 0-255 pty:master
865 pty_slave /dev/ttyp 3 0-255 pty:slave
866 pty_master /dev/pty 2 0-255 pty:master
867 serial /dev/cua 5 64-67 serial:callout
868 serial /dev/ttyS 4 64-67 serial
869 /dev/tty0 /dev/tty0 4 0 system:vtmaster
870 /dev/ptmx /dev/ptmx 5 2 system
871 /dev/console /dev/console 5 1 system:console
872 /dev/tty /dev/tty 5 0 system:/dev/tty
873 unknown /dev/tty 4 1-63 console
874
875
8761.8 Miscellaneous kernel statistics in /proc/stat
877-------------------------------------------------
878
879Various pieces of information about kernel activity are available in the
880/proc/stat file. All of the numbers reported in this file are aggregates
881since the system first booted. For a quick look, simply cat the file:
882
883 > cat /proc/stat
Leonardo Chiquittob68f2c32007-10-20 03:03:38 +0200884 cpu 2255 34 2290 22625563 6290 127 456 0
885 cpu0 1132 34 1441 11311718 3675 127 438 0
886 cpu1 1123 0 849 11313845 2614 0 18 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 intr 114930548 113199788 3 0 5 263 0 4 [... lots more numbers ...]
888 ctxt 1990473
889 btime 1062191376
890 processes 2915
891 procs_running 1
892 procs_blocked 0
893
894The very first "cpu" line aggregates the numbers in all of the other "cpuN"
895lines. These numbers identify the amount of time the CPU has spent performing
896different kinds of work. Time units are in USER_HZ (typically hundredths of a
897second). The meanings of the columns are as follows, from left to right:
898
899- user: normal processes executing in user mode
900- nice: niced processes executing in user mode
901- system: processes executing in kernel mode
902- idle: twiddling thumbs
903- iowait: waiting for I/O to complete
904- irq: servicing interrupts
905- softirq: servicing softirqs
Leonardo Chiquittob68f2c32007-10-20 03:03:38 +0200906- steal: involuntary wait
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
908The "intr" line gives counts of interrupts serviced since boot time, for each
909of the possible system interrupts. The first column is the total of all
910interrupts serviced; each subsequent column is the total for that particular
911interrupt.
912
913The "ctxt" line gives the total number of context switches across all CPUs.
914
915The "btime" line gives the time at which the system booted, in seconds since
916the Unix epoch.
917
918The "processes" line gives the number of processes and threads created, which
919includes (but is not limited to) those created by calls to the fork() and
920clone() system calls.
921
922The "procs_running" line gives the number of processes currently running on
923CPUs.
924
925The "procs_blocked" line gives the number of processes currently blocked,
926waiting for I/O to complete.
927
Theodore Ts'o37515fa2008-10-09 23:21:54 -0400928
Alex Tomasc9de5602008-01-29 00:19:52 -05009291.9 Ext4 file system parameters
930------------------------------
Alex Tomasc9de5602008-01-29 00:19:52 -0500931
Theodore Ts'o37515fa2008-10-09 23:21:54 -0400932Information about mounted ext4 file systems can be found in
933/proc/fs/ext4. Each mounted filesystem will have a directory in
934/proc/fs/ext4 based on its device name (i.e., /proc/fs/ext4/hdc or
935/proc/fs/ext4/dm-0). The files in each per-device directory are shown
936in Table 1-10, below.
Alex Tomasc9de5602008-01-29 00:19:52 -0500937
Theodore Ts'o37515fa2008-10-09 23:21:54 -0400938Table 1-10: Files in /proc/fs/ext4/<devname>
939..............................................................................
940 File Content
941 mb_groups details of multiblock allocator buddy cache of free blocks
942 mb_history multiblock allocation history
943 stats controls whether the multiblock allocator should start
944 collecting statistics, which are shown during the unmount
945 group_prealloc the multiblock allocator will round up allocation
946 requests to a multiple of this tuning parameter if the
947 stripe size is not set in the ext4 superblock
948 max_to_scan The maximum number of extents the multiblock allocator
949 will search to find the best extent
950 min_to_scan The minimum number of extents the multiblock allocator
951 will search to find the best extent
952 order2_req Tuning parameter which controls the minimum size for
953 requests (as a power of 2) where the buddy cache is
954 used
955 stream_req Files which have fewer blocks than this tunable
956 parameter will have their blocks allocated out of a
957 block group specific preallocation pool, so that small
958 files are packed closely together. Each large file
959 will have its blocks allocated out of its own unique
960 preallocation pool.
Theodore Ts'o240799c2008-10-09 23:53:47 -0400961inode_readahead Tuning parameter which controls the maximum number of
962 inode table blocks that ext4's inode table readahead
963 algorithm will pre-read into the buffer cache
Theodore Ts'o37515fa2008-10-09 23:21:54 -0400964..............................................................................
Alex Tomasc9de5602008-01-29 00:19:52 -0500965
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966
967------------------------------------------------------------------------------
968Summary
969------------------------------------------------------------------------------
970The /proc file system serves information about the running system. It not only
971allows access to process data but also allows you to request the kernel status
972by reading files in the hierarchy.
973
974The directory structure of /proc reflects the types of information and makes
975it easy, if not obvious, where to look for specific data.
976------------------------------------------------------------------------------
977
978------------------------------------------------------------------------------
979CHAPTER 2: MODIFYING SYSTEM PARAMETERS
980------------------------------------------------------------------------------
981
982------------------------------------------------------------------------------
983In This Chapter
984------------------------------------------------------------------------------
985* Modifying kernel parameters by writing into files found in /proc/sys
986* Exploring the files which modify certain parameters
987* Review of the /proc/sys file tree
988------------------------------------------------------------------------------
989
990
991A very interesting part of /proc is the directory /proc/sys. This is not only
992a source of information, it also allows you to change parameters within the
993kernel. Be very careful when attempting this. You can optimize your system,
994but you can also cause it to crash. Never alter kernel parameters on a
995production system. Set up a development machine and test to make sure that
996everything works the way you want it to. You may have no alternative but to
997reboot the machine once an error has been made.
998
999To change a value, simply echo the new value into the file. An example is
1000given below in the section on the file system data. You need to be root to do
1001this. You can create your own boot script to perform this every time your
1002system boots.
1003
1004The files in /proc/sys can be used to fine tune and monitor miscellaneous and
1005general things in the operation of the Linux kernel. Since some of the files
1006can inadvertently disrupt your system, it is advisable to read both
1007documentation and source before actually making adjustments. In any case, be
1008very careful when writing to any of these files. The entries in /proc may
1009change slightly between the 2.1.* and the 2.2 kernel, so if there is any doubt
1010review the kernel documentation in the directory /usr/src/linux/Documentation.
1011This chapter is heavily based on the documentation included in the pre 2.2
1012kernels, and became part of it in version 2.2.1 of the Linux kernel.
1013
10142.1 /proc/sys/fs - File system data
1015-----------------------------------
1016
1017This subdirectory contains specific file system, file handle, inode, dentry
1018and quota information.
1019
1020Currently, these files are in /proc/sys/fs:
1021
1022dentry-state
1023------------
1024
1025Status of the directory cache. Since directory entries are dynamically
1026allocated and deallocated, this file indicates the current status. It holds
1027six values, in which the last two are not used and are always zero. The others
1028are listed in table 2-1.
1029
1030
1031Table 2-1: Status files of the directory cache
1032..............................................................................
1033 File Content
1034 nr_dentry Almost always zero
1035 nr_unused Number of unused cache entries
1036 age_limit
1037 in seconds after the entry may be reclaimed, when memory is short
1038 want_pages internally
1039..............................................................................
1040
1041dquot-nr and dquot-max
1042----------------------
1043
1044The file dquot-max shows the maximum number of cached disk quota entries.
1045
1046The file dquot-nr shows the number of allocated disk quota entries and the
1047number of free disk quota entries.
1048
1049If the number of available cached disk quotas is very low and you have a large
1050number of simultaneous system users, you might want to raise the limit.
1051
1052file-nr and file-max
1053--------------------
1054
1055The kernel allocates file handles dynamically, but doesn't free them again at
1056this time.
1057
1058The value in file-max denotes the maximum number of file handles that the
1059Linux kernel will allocate. When you get a lot of error messages about running
1060out of file handles, you might want to raise this limit. The default value is
106110% of RAM in kilobytes. To change it, just write the new number into the
1062file:
1063
1064 # cat /proc/sys/fs/file-max
1065 4096
1066 # echo 8192 > /proc/sys/fs/file-max
1067 # cat /proc/sys/fs/file-max
1068 8192
1069
1070
1071This method of revision is useful for all customizable parameters of the
1072kernel - simply echo the new value to the corresponding file.
1073
1074Historically, the three values in file-nr denoted the number of allocated file
1075handles, the number of allocated but unused file handles, and the maximum
1076number of file handles. Linux 2.6 always reports 0 as the number of free file
1077handles -- this is not an error, it just means that the number of allocated
1078file handles exactly matches the number of used file handles.
1079
1080Attempts to allocate more file descriptors than file-max are reported with
1081printk, look for "VFS: file-max limit <number> reached".
1082
1083inode-state and inode-nr
1084------------------------
1085
1086The file inode-nr contains the first two items from inode-state, so we'll skip
1087to that file...
1088
1089inode-state contains two actual numbers and five dummy values. The numbers
1090are nr_inodes and nr_free_inodes (in order of appearance).
1091
1092nr_inodes
1093~~~~~~~~~
1094
1095Denotes the number of inodes the system has allocated. This number will
1096grow and shrink dynamically.
1097
Eric Dumazet9cfe0152008-02-06 01:37:16 -08001098nr_open
1099-------
1100
1101Denotes the maximum number of file-handles a process can
1102allocate. Default value is 1024*1024 (1048576) which should be
1103enough for most machines. Actual limit depends on RLIMIT_NOFILE
1104resource limit.
1105
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106nr_free_inodes
1107--------------
1108
1109Represents the number of free inodes. Ie. The number of inuse inodes is
1110(nr_inodes - nr_free_inodes).
1111
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112aio-nr and aio-max-nr
1113---------------------
1114
1115aio-nr is the running total of the number of events specified on the
1116io_setup system call for all currently active aio contexts. If aio-nr
1117reaches aio-max-nr then io_setup will fail with EAGAIN. Note that
1118raising aio-max-nr does not result in the pre-allocation or re-sizing
1119of any kernel data structures.
1120
11212.2 /proc/sys/fs/binfmt_misc - Miscellaneous binary formats
1122-----------------------------------------------------------
1123
1124Besides these files, there is the subdirectory /proc/sys/fs/binfmt_misc. This
1125handles the kernel support for miscellaneous binary formats.
1126
1127Binfmt_misc provides the ability to register additional binary formats to the
1128Kernel without compiling an additional module/kernel. Therefore, binfmt_misc
1129needs to know magic numbers at the beginning or the filename extension of the
1130binary.
1131
1132It works by maintaining a linked list of structs that contain a description of
1133a binary format, including a magic with size (or the filename extension),
1134offset and mask, and the interpreter name. On request it invokes the given
1135interpreter with the original program as argument, as binfmt_java and
1136binfmt_em86 and binfmt_mz do. Since binfmt_misc does not define any default
1137binary-formats, you have to register an additional binary-format.
1138
1139There are two general files in binfmt_misc and one file per registered format.
1140The two general files are register and status.
1141
1142Registering a new binary format
1143-------------------------------
1144
1145To register a new binary format you have to issue the command
1146
1147 echo :name:type:offset:magic:mask:interpreter: > /proc/sys/fs/binfmt_misc/register
1148
1149
1150
1151with appropriate name (the name for the /proc-dir entry), offset (defaults to
11520, if omitted), magic, mask (which can be omitted, defaults to all 0xff) and
1153last but not least, the interpreter that is to be invoked (for example and
1154testing /bin/echo). Type can be M for usual magic matching or E for filename
1155extension matching (give extension in place of magic).
1156
1157Check or reset the status of the binary format handler
1158------------------------------------------------------
1159
1160If you do a cat on the file /proc/sys/fs/binfmt_misc/status, you will get the
1161current status (enabled/disabled) of binfmt_misc. Change the status by echoing
11620 (disables) or 1 (enables) or -1 (caution: this clears all previously
1163registered binary formats) to status. For example echo 0 > status to disable
1164binfmt_misc (temporarily).
1165
1166Status of a single handler
1167--------------------------
1168
1169Each registered handler has an entry in /proc/sys/fs/binfmt_misc. These files
1170perform the same function as status, but their scope is limited to the actual
1171binary format. By cating this file, you also receive all related information
1172about the interpreter/magic of the binfmt.
1173
1174Example usage of binfmt_misc (emulate binfmt_java)
1175--------------------------------------------------
1176
1177 cd /proc/sys/fs/binfmt_misc
1178 echo ':Java:M::\xca\xfe\xba\xbe::/usr/local/java/bin/javawrapper:' > register
1179 echo ':HTML:E::html::/usr/local/java/bin/appletviewer:' > register
1180 echo ':Applet:M::<!--applet::/usr/local/java/bin/appletviewer:' > register
1181 echo ':DEXE:M::\x0eDEX::/usr/bin/dosexec:' > register
1182
1183
1184These four lines add support for Java executables and Java applets (like
1185binfmt_java, additionally recognizing the .html extension with no need to put
1186<!--applet> to every applet file). You have to install the JDK and the
1187shell-script /usr/local/java/bin/javawrapper too. It works around the
1188brokenness of the Java filename handling. To add a Java binary, just create a
1189link to the class-file somewhere in the path.
1190
11912.3 /proc/sys/kernel - general kernel parameters
1192------------------------------------------------
1193
1194This directory reflects general kernel behaviors. As I've said before, the
1195contents depend on your configuration. Here you'll find the most important
1196files, along with descriptions of what they mean and how to use them.
1197
1198acct
1199----
1200
1201The file contains three values; highwater, lowwater, and frequency.
1202
1203It exists only when BSD-style process accounting is enabled. These values
1204control its behavior. If the free space on the file system where the log lives
1205goes below lowwater percentage, accounting suspends. If it goes above
1206highwater percentage, accounting resumes. Frequency determines how often you
1207check the amount of free space (value is in seconds). Default settings are: 4,
12082, and 30. That is, suspend accounting if there is less than 2 percent free;
1209resume it if we have a value of 3 or more percent; consider information about
1210the amount of free space valid for 30 seconds
1211
1212ctrl-alt-del
1213------------
1214
1215When the value in this file is 0, ctrl-alt-del is trapped and sent to the init
1216program to handle a graceful restart. However, when the value is greater that
1217zero, Linux's reaction to this key combination will be an immediate reboot,
1218without syncing its dirty buffers.
1219
1220[NOTE]
1221 When a program (like dosemu) has the keyboard in raw mode, the
1222 ctrl-alt-del is intercepted by the program before it ever reaches the
1223 kernel tty layer, and it is up to the program to decide what to do with
1224 it.
1225
1226domainname and hostname
1227-----------------------
1228
1229These files can be controlled to set the NIS domainname and hostname of your
1230box. For the classic darkstar.frop.org a simple:
1231
1232 # echo "darkstar" > /proc/sys/kernel/hostname
1233 # echo "frop.org" > /proc/sys/kernel/domainname
1234
1235
1236would suffice to set your hostname and NIS domainname.
1237
1238osrelease, ostype and version
1239-----------------------------
1240
1241The names make it pretty obvious what these fields contain:
1242
1243 > cat /proc/sys/kernel/osrelease
1244 2.2.12
1245
1246 > cat /proc/sys/kernel/ostype
1247 Linux
1248
1249 > cat /proc/sys/kernel/version
1250 #4 Fri Oct 1 12:41:14 PDT 1999
1251
1252
1253The files osrelease and ostype should be clear enough. Version needs a little
1254more clarification. The #4 means that this is the 4th kernel built from this
1255source base and the date after it indicates the time the kernel was built. The
1256only way to tune these values is to rebuild the kernel.
1257
1258panic
1259-----
1260
1261The value in this file represents the number of seconds the kernel waits
1262before rebooting on a panic. When you use the software watchdog, the
1263recommended setting is 60. If set to 0, the auto reboot after a kernel panic
1264is disabled, which is the default setting.
1265
1266printk
1267------
1268
1269The four values in printk denote
1270* console_loglevel,
1271* default_message_loglevel,
1272* minimum_console_loglevel and
1273* default_console_loglevel
1274respectively.
1275
1276These values influence printk() behavior when printing or logging error
1277messages, which come from inside the kernel. See syslog(2) for more
1278information on the different log levels.
1279
1280console_loglevel
1281----------------
1282
1283Messages with a higher priority than this will be printed to the console.
1284
1285default_message_level
1286---------------------
1287
1288Messages without an explicit priority will be printed with this priority.
1289
1290minimum_console_loglevel
1291------------------------
1292
1293Minimum (highest) value to which the console_loglevel can be set.
1294
1295default_console_loglevel
1296------------------------
1297
1298Default value for console_loglevel.
1299
1300sg-big-buff
1301-----------
1302
1303This file shows the size of the generic SCSI (sg) buffer. At this point, you
1304can't tune it yet, but you can change it at compile time by editing
1305include/scsi/sg.h and changing the value of SG_BIG_BUFF.
1306
1307If you use a scanner with SANE (Scanner Access Now Easy) you might want to set
1308this to a higher value. Refer to the SANE documentation on this issue.
1309
1310modprobe
1311--------
1312
1313The location where the modprobe binary is located. The kernel uses this
1314program to load modules on demand.
1315
1316unknown_nmi_panic
1317-----------------
1318
1319The value in this file affects behavior of handling NMI. When the value is
1320non-zero, unknown NMI is trapped and then panic occurs. At that time, kernel
1321debugging information is displayed on console.
1322
1323NMI switch that most IA32 servers have fires unknown NMI up, for example.
1324If a system hangs up, try pressing the NMI switch.
1325
Bernhard Walle22b8ab62008-10-15 22:02:01 -07001326panic_on_unrecovered_nmi
1327------------------------
1328
1329The default Linux behaviour on an NMI of either memory or unknown is to continue
1330operation. For many environments such as scientific computing it is preferable
1331that the box is taken out and the error dealt with than an uncorrected
1332parity/ECC error get propogated.
1333
1334A small number of systems do generate NMI's for bizarre random reasons such as
1335power management so the default is off. That sysctl works like the existing
1336panic controls already in that directory.
1337
Don Zickuse33e89a2006-09-26 10:52:27 +02001338nmi_watchdog
1339------------
1340
1341Enables/Disables the NMI watchdog on x86 systems. When the value is non-zero
1342the NMI watchdog is enabled and will continuously test all online cpus to
Aristeu Rozanski8a1c8eb2008-10-30 13:08:50 -04001343determine whether or not they are still functioning properly. Currently,
1344passing "nmi_watchdog=" parameter at boot time is required for this function
1345to work.
Don Zickuse33e89a2006-09-26 10:52:27 +02001346
Aristeu Rozanski8a1c8eb2008-10-30 13:08:50 -04001347If LAPIC NMI watchdog method is in use (nmi_watchdog=2 kernel parameter), the
1348NMI watchdog shares registers with oprofile. By disabling the NMI watchdog,
1349oprofile may have more registers to utilize.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
Nadia Derbey61e55d02008-09-02 14:35:59 -07001351msgmni
1352------
1353
1354Maximum number of message queue ids on the system.
1355This value scales to the amount of lowmem. It is automatically recomputed
1356upon memory add/remove or ipc namespace creation/removal.
1357When a value is written into this file, msgmni's value becomes fixed, i.e. it
1358is not recomputed anymore when one of the above events occurs.
1359Use auto_msgmni to change this behavior.
1360
1361auto_msgmni
1362-----------
1363
1364Enables/Disables automatic recomputing of msgmni upon memory add/remove or
1365upon ipc namespace creation/removal (see the msgmni description above).
1366Echoing "1" into this file enables msgmni automatic recomputing.
1367Echoing "0" turns it off.
1368auto_msgmni default value is 1.
1369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
13712.4 /proc/sys/vm - The virtual memory subsystem
1372-----------------------------------------------
1373
Peter W Morrealedb0fb182009-01-15 13:50:42 -08001374Please see: Documentation/sysctls/vm.txt for a description of these
1375entries.
Andrew Morton9d0243b2006-01-08 01:00:39 -08001376
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -070013782.5 /proc/sys/dev - Device specific parameters
1379----------------------------------------------
1380
1381Currently there is only support for CDROM drives, and for those, there is only
1382one read-only file containing information about the CD-ROM drives attached to
1383the system:
1384
1385 >cat /proc/sys/dev/cdrom/info
1386 CD-ROM information, Id: cdrom.c 2.55 1999/04/25
1387
1388 drive name: sr0 hdb
1389 drive speed: 32 40
1390 drive # of slots: 1 0
1391 Can close tray: 1 1
1392 Can open tray: 1 1
1393 Can lock tray: 1 1
1394 Can change speed: 1 1
1395 Can select disk: 0 1
1396 Can read multisession: 1 1
1397 Can read MCN: 1 1
1398 Reports media changed: 1 1
1399 Can play audio: 1 1
1400
1401
1402You see two drives, sr0 and hdb, along with a list of their features.
1403
14042.6 /proc/sys/sunrpc - Remote procedure calls
1405---------------------------------------------
1406
1407This directory contains four files, which enable or disable debugging for the
1408RPC functions NFS, NFS-daemon, RPC and NLM. The default values are 0. They can
1409be set to one to turn debugging on. (The default value is 0 for each)
1410
14112.7 /proc/sys/net - Networking stuff
1412------------------------------------
1413
1414The interface to the networking parts of the kernel is located in
1415/proc/sys/net. Table 2-3 shows all possible subdirectories. You may see only
1416some of them, depending on your kernel's configuration.
1417
1418
1419Table 2-3: Subdirectories in /proc/sys/net
1420..............................................................................
1421 Directory Content Directory Content
1422 core General parameter appletalk Appletalk protocol
1423 unix Unix domain sockets netrom NET/ROM
1424 802 E802 protocol ax25 AX25
1425 ethernet Ethernet protocol rose X.25 PLP layer
1426 ipv4 IP version 4 x25 X.25 protocol
1427 ipx IPX token-ring IBM token ring
1428 bridge Bridging decnet DEC net
1429 ipv6 IP version 6
1430..............................................................................
1431
1432We will concentrate on IP networking here. Since AX15, X.25, and DEC Net are
1433only minor players in the Linux world, we'll skip them in this chapter. You'll
1434find some short info on Appletalk and IPX further on in this chapter. Review
1435the online documentation and the kernel source to get a detailed view of the
1436parameters for those protocols. In this section we'll discuss the
1437subdirectories printed in bold letters in the table above. As default values
1438are suitable for most needs, there is no need to change these values.
1439
1440/proc/sys/net/core - Network core options
1441-----------------------------------------
1442
1443rmem_default
1444------------
1445
1446The default setting of the socket receive buffer in bytes.
1447
1448rmem_max
1449--------
1450
1451The maximum receive socket buffer size in bytes.
1452
1453wmem_default
1454------------
1455
1456The default setting (in bytes) of the socket send buffer.
1457
1458wmem_max
1459--------
1460
1461The maximum send socket buffer size in bytes.
1462
1463message_burst and message_cost
1464------------------------------
1465
1466These parameters are used to limit the warning messages written to the kernel
1467log from the networking code. They enforce a rate limit to make a
1468denial-of-service attack impossible. A higher message_cost factor, results in
1469fewer messages that will be written. Message_burst controls when messages will
1470be dropped. The default settings limit warning messages to one every five
1471seconds.
1472
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08001473warnings
1474--------
1475
1476This controls console messages from the networking stack that can occur because
1477of problems on the network like duplicate address or bad checksums. Normally,
1478this should be enabled, but if the problem persists the messages can be
1479disabled.
1480
1481
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482netdev_max_backlog
1483------------------
1484
1485Maximum number of packets, queued on the INPUT side, when the interface
1486receives packets faster than kernel can process them.
1487
1488optmem_max
1489----------
1490
1491Maximum ancillary buffer size allowed per socket. Ancillary data is a sequence
1492of struct cmsghdr structures with appended data.
1493
1494/proc/sys/net/unix - Parameters for Unix domain sockets
1495-------------------------------------------------------
1496
1497There are only two files in this subdirectory. They control the delays for
1498deleting and destroying socket descriptors.
1499
15002.8 /proc/sys/net/ipv4 - IPV4 settings
1501--------------------------------------
1502
1503IP version 4 is still the most used protocol in Unix networking. It will be
1504replaced by IP version 6 in the next couple of years, but for the moment it's
1505the de facto standard for the internet and is used in most networking
1506environments around the world. Because of the importance of this protocol,
1507we'll have a deeper look into the subtree controlling the behavior of the IPv4
1508subsystem of the Linux kernel.
1509
1510Let's start with the entries in /proc/sys/net/ipv4.
1511
1512ICMP settings
1513-------------
1514
1515icmp_echo_ignore_all and icmp_echo_ignore_broadcasts
1516----------------------------------------------------
1517
1518Turn on (1) or off (0), if the kernel should ignore all ICMP ECHO requests, or
1519just those to broadcast and multicast addresses.
1520
1521Please note that if you accept ICMP echo requests with a broadcast/multi\-cast
1522destination address your network may be used as an exploder for denial of
1523service packet flooding attacks to other hosts.
1524
1525icmp_destunreach_rate, icmp_echoreply_rate, icmp_paramprob_rate and icmp_timeexeed_rate
1526---------------------------------------------------------------------------------------
1527
1528Sets limits for sending ICMP packets to specific targets. A value of zero
1529disables all limiting. Any positive value sets the maximum package rate in
1530hundredth of a second (on Intel systems).
1531
1532IP settings
1533-----------
1534
1535ip_autoconfig
1536-------------
1537
1538This file contains the number one if the host received its IP configuration by
1539RARP, BOOTP, DHCP or a similar mechanism. Otherwise it is zero.
1540
1541ip_default_ttl
1542--------------
1543
1544TTL (Time To Live) for IPv4 interfaces. This is simply the maximum number of
1545hops a packet may travel.
1546
1547ip_dynaddr
1548----------
1549
1550Enable dynamic socket address rewriting on interface address change. This is
1551useful for dialup interface with changing IP addresses.
1552
1553ip_forward
1554----------
1555
1556Enable or disable forwarding of IP packages between interfaces. Changing this
1557value resets all other parameters to their default values. They differ if the
1558kernel is configured as host or router.
1559
1560ip_local_port_range
1561-------------------
1562
1563Range of ports used by TCP and UDP to choose the local port. Contains two
1564numbers, the first number is the lowest port, the second number the highest
1565local port. Default is 1024-4999. Should be changed to 32768-61000 for
1566high-usage systems.
1567
1568ip_no_pmtu_disc
1569---------------
1570
1571Global switch to turn path MTU discovery off. It can also be set on a per
1572socket basis by the applications or on a per route basis.
1573
1574ip_masq_debug
1575-------------
1576
1577Enable/disable debugging of IP masquerading.
1578
1579IP fragmentation settings
1580-------------------------
1581
1582ipfrag_high_trash and ipfrag_low_trash
1583--------------------------------------
1584
1585Maximum memory used to reassemble IP fragments. When ipfrag_high_thresh bytes
1586of memory is allocated for this purpose, the fragment handler will toss
1587packets until ipfrag_low_thresh is reached.
1588
1589ipfrag_time
1590-----------
1591
1592Time in seconds to keep an IP fragment in memory.
1593
1594TCP settings
1595------------
1596
1597tcp_ecn
1598-------
1599
Matt LaPlantefa00e7e2006-11-30 04:55:36 +01001600This file controls the use of the ECN bit in the IPv4 headers. This is a new
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601feature about Explicit Congestion Notification, but some routers and firewalls
Matt LaPlantefa00e7e2006-11-30 04:55:36 +01001602block traffic that has this bit set, so it could be necessary to echo 0 to
1603/proc/sys/net/ipv4/tcp_ecn if you want to talk to these sites. For more info
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604you could read RFC2481.
1605
1606tcp_retrans_collapse
1607--------------------
1608
1609Bug-to-bug compatibility with some broken printers. On retransmit, try to send
1610larger packets to work around bugs in certain TCP stacks. Can be turned off by
1611setting it to zero.
1612
1613tcp_keepalive_probes
1614--------------------
1615
1616Number of keep alive probes TCP sends out, until it decides that the
1617connection is broken.
1618
1619tcp_keepalive_time
1620------------------
1621
1622How often TCP sends out keep alive messages, when keep alive is enabled. The
1623default is 2 hours.
1624
1625tcp_syn_retries
1626---------------
1627
1628Number of times initial SYNs for a TCP connection attempt will be
1629retransmitted. Should not be higher than 255. This is only the timeout for
1630outgoing connections, for incoming connections the number of retransmits is
1631defined by tcp_retries1.
1632
1633tcp_sack
1634--------
1635
1636Enable select acknowledgments after RFC2018.
1637
1638tcp_timestamps
1639--------------
1640
1641Enable timestamps as defined in RFC1323.
1642
1643tcp_stdurg
1644----------
1645
1646Enable the strict RFC793 interpretation of the TCP urgent pointer field. The
1647default is to use the BSD compatible interpretation of the urgent pointer
1648pointing to the first byte after the urgent data. The RFC793 interpretation is
1649to have it point to the last byte of urgent data. Enabling this option may
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001650lead to interoperability problems. Disabled by default.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
1652tcp_syncookies
1653--------------
1654
1655Only valid when the kernel was compiled with CONFIG_SYNCOOKIES. Send out
1656syncookies when the syn backlog queue of a socket overflows. This is to ward
1657off the common 'syn flood attack'. Disabled by default.
1658
1659Note that the concept of a socket backlog is abandoned. This means the peer
1660may not receive reliable error messages from an over loaded server with
1661syncookies enabled.
1662
1663tcp_window_scaling
1664------------------
1665
1666Enable window scaling as defined in RFC1323.
1667
1668tcp_fin_timeout
1669---------------
1670
1671The length of time in seconds it takes to receive a final FIN before the
1672socket is always closed. This is strictly a violation of the TCP
1673specification, but required to prevent denial-of-service attacks.
1674
1675tcp_max_ka_probes
1676-----------------
1677
1678Indicates how many keep alive probes are sent per slow timer run. Should not
1679be set too high to prevent bursts.
1680
1681tcp_max_syn_backlog
1682-------------------
1683
1684Length of the per socket backlog queue. Since Linux 2.2 the backlog specified
1685in listen(2) only specifies the length of the backlog queue of already
1686established sockets. When more connection requests arrive Linux starts to drop
1687packets. When syncookies are enabled the packets are still answered and the
1688maximum queue is effectively ignored.
1689
1690tcp_retries1
1691------------
1692
1693Defines how often an answer to a TCP connection request is retransmitted
1694before giving up.
1695
1696tcp_retries2
1697------------
1698
1699Defines how often a TCP packet is retransmitted before giving up.
1700
1701Interface specific settings
1702---------------------------
1703
1704In the directory /proc/sys/net/ipv4/conf you'll find one subdirectory for each
1705interface the system knows about and one directory calls all. Changes in the
1706all subdirectory affect all interfaces, whereas changes in the other
1707subdirectories affect only one interface. All directories have the same
1708entries:
1709
1710accept_redirects
1711----------------
1712
1713This switch decides if the kernel accepts ICMP redirect messages or not. The
1714default is 'yes' if the kernel is configured for a regular host and 'no' for a
1715router configuration.
1716
1717accept_source_route
1718-------------------
1719
1720Should source routed packages be accepted or declined. The default is
1721dependent on the kernel configuration. It's 'yes' for routers and 'no' for
1722hosts.
1723
1724bootp_relay
1725~~~~~~~~~~~
1726
1727Accept packets with source address 0.b.c.d with destinations not to this host
1728as local ones. It is supposed that a BOOTP relay daemon will catch and forward
1729such packets.
1730
1731The default is 0, since this feature is not implemented yet (kernel version
17322.2.12).
1733
1734forwarding
1735----------
1736
1737Enable or disable IP forwarding on this interface.
1738
1739log_martians
1740------------
1741
1742Log packets with source addresses with no known route to kernel log.
1743
1744mc_forwarding
1745-------------
1746
1747Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE and a
1748multicast routing daemon is required.
1749
1750proxy_arp
1751---------
1752
1753Does (1) or does not (0) perform proxy ARP.
1754
1755rp_filter
1756---------
1757
1758Integer value determines if a source validation should be made. 1 means yes, 0
1759means no. Disabled by default, but local/broadcast address spoofing is always
1760on.
1761
1762If you set this to 1 on a router that is the only connection for a network to
1763the net, it will prevent spoofing attacks against your internal networks
1764(external addresses can still be spoofed), without the need for additional
1765firewall rules.
1766
1767secure_redirects
1768----------------
1769
1770Accept ICMP redirect messages only for gateways, listed in default gateway
1771list. Enabled by default.
1772
1773shared_media
1774------------
1775
1776If it is not set the kernel does not assume that different subnets on this
1777device can communicate directly. Default setting is 'yes'.
1778
1779send_redirects
1780--------------
1781
1782Determines whether to send ICMP redirects to other hosts.
1783
1784Routing settings
1785----------------
1786
1787The directory /proc/sys/net/ipv4/route contains several file to control
1788routing issues.
1789
1790error_burst and error_cost
1791--------------------------
1792
1793These parameters are used to limit how many ICMP destination unreachable to
1794send from the host in question. ICMP destination unreachable messages are
Matt LaPlante84eb8d02006-10-03 22:53:09 +02001795sent when we cannot reach the next hop while trying to transmit a packet.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796It will also print some error messages to kernel logs if someone is ignoring
1797our ICMP redirects. The higher the error_cost factor is, the fewer
1798destination unreachable and error messages will be let through. Error_burst
1799controls when destination unreachable messages and error messages will be
1800dropped. The default settings limit warning messages to five every second.
1801
1802flush
1803-----
1804
1805Writing to this file results in a flush of the routing cache.
1806
1807gc_elasticity, gc_interval, gc_min_interval_ms, gc_timeout, gc_thresh
1808---------------------------------------------------------------------
1809
1810Values to control the frequency and behavior of the garbage collection
1811algorithm for the routing cache. gc_min_interval is deprecated and replaced
1812by gc_min_interval_ms.
1813
1814
1815max_size
1816--------
1817
1818Maximum size of the routing cache. Old entries will be purged once the cache
1819reached has this size.
1820
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821redirect_load, redirect_number
1822------------------------------
1823
1824Factors which determine if more ICPM redirects should be sent to a specific
1825host. No redirects will be sent once the load limit or the maximum number of
1826redirects has been reached.
1827
1828redirect_silence
1829----------------
1830
1831Timeout for redirects. After this period redirects will be sent again, even if
1832this has been stopped, because the load or number limit has been reached.
1833
1834Network Neighbor handling
1835-------------------------
1836
1837Settings about how to handle connections with direct neighbors (nodes attached
1838to the same link) can be found in the directory /proc/sys/net/ipv4/neigh.
1839
1840As we saw it in the conf directory, there is a default subdirectory which
1841holds the default values, and one directory for each interface. The contents
1842of the directories are identical, with the single exception that the default
1843settings contain additional options to set garbage collection parameters.
1844
1845In the interface directories you'll find the following entries:
1846
1847base_reachable_time, base_reachable_time_ms
1848-------------------------------------------
1849
1850A base value used for computing the random reachable time value as specified
1851in RFC2461.
1852
1853Expression of base_reachable_time, which is deprecated, is in seconds.
1854Expression of base_reachable_time_ms is in milliseconds.
1855
1856retrans_time, retrans_time_ms
1857-----------------------------
1858
1859The time between retransmitted Neighbor Solicitation messages.
1860Used for address resolution and to determine if a neighbor is
1861unreachable.
1862
1863Expression of retrans_time, which is deprecated, is in 1/100 seconds (for
1864IPv4) or in jiffies (for IPv6).
1865Expression of retrans_time_ms is in milliseconds.
1866
1867unres_qlen
1868----------
1869
1870Maximum queue length for a pending arp request - the number of packets which
1871are accepted from other layers while the ARP address is still resolved.
1872
1873anycast_delay
1874-------------
1875
1876Maximum for random delay of answers to neighbor solicitation messages in
1877jiffies (1/100 sec). Not yet implemented (Linux does not have anycast support
1878yet).
1879
1880ucast_solicit
1881-------------
1882
1883Maximum number of retries for unicast solicitation.
1884
1885mcast_solicit
1886-------------
1887
1888Maximum number of retries for multicast solicitation.
1889
1890delay_first_probe_time
1891----------------------
1892
1893Delay for the first time probe if the neighbor is reachable. (see
1894gc_stale_time)
1895
1896locktime
1897--------
1898
1899An ARP/neighbor entry is only replaced with a new one if the old is at least
1900locktime old. This prevents ARP cache thrashing.
1901
1902proxy_delay
1903-----------
1904
1905Maximum time (real time is random [0..proxytime]) before answering to an ARP
1906request for which we have an proxy ARP entry. In some cases, this is used to
1907prevent network flooding.
1908
1909proxy_qlen
1910----------
1911
1912Maximum queue length of the delayed proxy arp timer. (see proxy_delay).
1913
Matt LaPlante53cb4722006-10-03 22:55:17 +02001914app_solicit
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915----------
1916
1917Determines the number of requests to send to the user level ARP daemon. Use 0
1918to turn off.
1919
1920gc_stale_time
1921-------------
1922
1923Determines how often to check for stale ARP entries. After an ARP entry is
1924stale it will be resolved again (which is useful when an IP address migrates
1925to another machine). When ucast_solicit is greater than 0 it first tries to
1926send an ARP packet directly to the known host When that fails and
1927mcast_solicit is greater than 0, an ARP request is broadcasted.
1928
19292.9 Appletalk
1930-------------
1931
1932The /proc/sys/net/appletalk directory holds the Appletalk configuration data
1933when Appletalk is loaded. The configurable parameters are:
1934
1935aarp-expiry-time
1936----------------
1937
1938The amount of time we keep an ARP entry before expiring it. Used to age out
1939old hosts.
1940
1941aarp-resolve-time
1942-----------------
1943
1944The amount of time we will spend trying to resolve an Appletalk address.
1945
1946aarp-retransmit-limit
1947---------------------
1948
1949The number of times we will retransmit a query before giving up.
1950
1951aarp-tick-time
1952--------------
1953
1954Controls the rate at which expires are checked.
1955
1956The directory /proc/net/appletalk holds the list of active Appletalk sockets
1957on a machine.
1958
1959The fields indicate the DDP type, the local address (in network:node format)
1960the remote address, the size of the transmit pending queue, the size of the
1961received queue (bytes waiting for applications to read) the state and the uid
1962owning the socket.
1963
1964/proc/net/atalk_iface lists all the interfaces configured for appletalk.It
1965shows the name of the interface, its Appletalk address, the network range on
1966that address (or network number for phase 1 networks), and the status of the
1967interface.
1968
1969/proc/net/atalk_route lists each known network route. It lists the target
1970(network) that the route leads to, the router (may be directly connected), the
1971route flags, and the device the route is using.
1972
19732.10 IPX
1974--------
1975
1976The IPX protocol has no tunable values in proc/sys/net.
1977
1978The IPX protocol does, however, provide proc/net/ipx. This lists each IPX
1979socket giving the local and remote addresses in Novell format (that is
1980network:node:port). In accordance with the strange Novell tradition,
1981everything but the port is in hex. Not_Connected is displayed for sockets that
1982are not tied to a specific remote address. The Tx and Rx queue sizes indicate
1983the number of bytes pending for transmission and reception. The state
1984indicates the state the socket is in and the uid is the owning uid of the
1985socket.
1986
1987The /proc/net/ipx_interface file lists all IPX interfaces. For each interface
1988it gives the network number, the node number, and indicates if the network is
1989the primary network. It also indicates which device it is bound to (or
1990Internal for internal networks) and the Frame Type if appropriate. Linux
1991supports 802.3, 802.2, 802.2 SNAP and DIX (Blue Book) ethernet framing for
1992IPX.
1993
1994The /proc/net/ipx_route table holds a list of IPX routes. For each route it
1995gives the destination network, the router node (or Directly) and the network
1996address of the router (or Connected) for internal networks.
1997
19982.11 /proc/sys/fs/mqueue - POSIX message queues filesystem
1999----------------------------------------------------------
2000
2001The "mqueue" filesystem provides the necessary kernel features to enable the
2002creation of a user space library that implements the POSIX message queues
2003API (as noted by the MSG tag in the POSIX 1003.1-2001 version of the System
2004Interfaces specification.)
2005
2006The "mqueue" filesystem contains values for determining/setting the amount of
2007resources used by the file system.
2008
2009/proc/sys/fs/mqueue/queues_max is a read/write file for setting/getting the
2010maximum number of message queues allowed on the system.
2011
2012/proc/sys/fs/mqueue/msg_max is a read/write file for setting/getting the
2013maximum number of messages in a queue value. In fact it is the limiting value
2014for another (user) limit which is set in mq_open invocation. This attribute of
2015a queue must be less or equal then msg_max.
2016
2017/proc/sys/fs/mqueue/msgsize_max is a read/write file for setting/getting the
2018maximum message size value (it is every message queue's attribute set during
2019its creation).
2020
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -070020212.12 /proc/<pid>/oom_adj - Adjust the oom-killer score
2022------------------------------------------------------
2023
2024This file can be used to adjust the score used to select which processes
2025should be killed in an out-of-memory situation. Giving it a high score will
2026increase the likelihood of this process being killed by the oom-killer. Valid
2027values are in the range -16 to +15, plus the special value -17, which disables
2028oom-killing altogether for this process.
2029
Evgeniy Polyakov9e9e3cb2009-01-29 14:25:09 -08002030The process to be killed in an out-of-memory situation is selected among all others
2031based on its badness score. This value equals the original memory size of the process
2032and is then updated according to its CPU time (utime + stime) and the
2033run time (uptime - start time). The longer it runs the smaller is the score.
2034Badness score is divided by the square root of the CPU time and then by
2035the double square root of the run time.
2036
2037Swapped out tasks are killed first. Half of each child's memory size is added to
2038the parent's score if they do not share the same memory. Thus forking servers
2039are the prime candidates to be killed. Having only one 'hungry' child will make
2040parent less preferable than the child.
2041
2042/proc/<pid>/oom_score shows process' current badness score.
2043
2044The following heuristics are then applied:
2045 * if the task was reniced, its score doubles
2046 * superuser or direct hardware access tasks (CAP_SYS_ADMIN, CAP_SYS_RESOURCE
2047 or CAP_SYS_RAWIO) have their score divided by 4
2048 * if oom condition happened in one cpuset and checked task does not belong
2049 to it, its score is divided by 8
2050 * the resulting score is multiplied by two to the power of oom_adj, i.e.
2051 points <<= oom_adj when it is positive and
2052 points >>= -(oom_adj) otherwise
2053
2054The task with the highest badness score is then selected and its children
2055are killed, process itself will be killed in an OOM situation when it does
2056not have children or some of them disabled oom like described above.
2057
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -070020582.13 /proc/<pid>/oom_score - Display current oom-killer score
2059-------------------------------------------------------------
2060
2061------------------------------------------------------------------------------
2062This file can be used to check the current score used by the oom-killer is for
2063any given <pid>. Use it together with /proc/<pid>/oom_adj to tune which
2064process should be killed in an out-of-memory situation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
2066------------------------------------------------------------------------------
2067Summary
2068------------------------------------------------------------------------------
2069Certain aspects of kernel behavior can be modified at runtime, without the
2070need to recompile the kernel, or even to reboot the system. The files in the
2071/proc/sys tree can not only be read, but also modified. You can use the echo
2072command to write value into these files, thereby changing the default settings
2073of the kernel.
2074------------------------------------------------------------------------------
Roland Kletzingf9c99462007-03-05 00:30:54 -08002075
20762.14 /proc/<pid>/io - Display the IO accounting fields
2077-------------------------------------------------------
2078
2079This file contains IO statistics for each running process
2080
2081Example
2082-------
2083
2084test:/tmp # dd if=/dev/zero of=/tmp/test.dat &
2085[1] 3828
2086
2087test:/tmp # cat /proc/3828/io
2088rchar: 323934931
2089wchar: 323929600
2090syscr: 632687
2091syscw: 632675
2092read_bytes: 0
2093write_bytes: 323932160
2094cancelled_write_bytes: 0
2095
2096
2097Description
2098-----------
2099
2100rchar
2101-----
2102
2103I/O counter: chars read
2104The number of bytes which this task has caused to be read from storage. This
2105is simply the sum of bytes which this process passed to read() and pread().
2106It includes things like tty IO and it is unaffected by whether or not actual
2107physical disk IO was required (the read might have been satisfied from
2108pagecache)
2109
2110
2111wchar
2112-----
2113
2114I/O counter: chars written
2115The number of bytes which this task has caused, or shall cause to be written
2116to disk. Similar caveats apply here as with rchar.
2117
2118
2119syscr
2120-----
2121
2122I/O counter: read syscalls
2123Attempt to count the number of read I/O operations, i.e. syscalls like read()
2124and pread().
2125
2126
2127syscw
2128-----
2129
2130I/O counter: write syscalls
2131Attempt to count the number of write I/O operations, i.e. syscalls like
2132write() and pwrite().
2133
2134
2135read_bytes
2136----------
2137
2138I/O counter: bytes read
2139Attempt to count the number of bytes which this process really did cause to
2140be fetched from the storage layer. Done at the submit_bio() level, so it is
2141accurate for block-backed filesystems. <please add status regarding NFS and
2142CIFS at a later time>
2143
2144
2145write_bytes
2146-----------
2147
2148I/O counter: bytes written
2149Attempt to count the number of bytes which this process caused to be sent to
2150the storage layer. This is done at page-dirtying time.
2151
2152
2153cancelled_write_bytes
2154---------------------
2155
2156The big inaccuracy here is truncate. If a process writes 1MB to a file and
2157then deletes the file, it will in fact perform no writeout. But it will have
2158been accounted as having caused 1MB of write.
2159In other words: The number of bytes which this process caused to not happen,
2160by truncating pagecache. A task can cause "negative" IO too. If this task
2161truncates some dirty pagecache, some IO which another task has been accounted
2162for (in it's write_bytes) will not be happening. We _could_ just subtract that
2163from the truncating task's write_bytes, but there is information loss in doing
2164that.
2165
2166
2167Note
2168----
2169
2170At its current implementation state, this is a bit racy on 32-bit machines: if
2171process A reads process B's /proc/pid/io while process B is updating one of
2172those 64-bit counters, process A could see an intermediate result.
2173
2174
2175More information about this can be found within the taskstats documentation in
2176Documentation/accounting.
2177
Kawai, Hidehirobb901102007-07-19 01:48:31 -070021782.15 /proc/<pid>/coredump_filter - Core dump filtering settings
2179---------------------------------------------------------------
2180When a process is dumped, all anonymous memory is written to a core file as
2181long as the size of the core file isn't limited. But sometimes we don't want
2182to dump some memory segments, for example, huge shared memory. Conversely,
2183sometimes we want to save file-backed memory segments into a core file, not
2184only the individual files.
2185
2186/proc/<pid>/coredump_filter allows you to customize which memory segments
2187will be dumped when the <pid> process is dumped. coredump_filter is a bitmask
2188of memory types. If a bit of the bitmask is set, memory segments of the
2189corresponding memory type are dumped, otherwise they are not dumped.
2190
KOSAKI Motohiroe575f112008-10-18 20:27:08 -07002191The following 7 memory types are supported:
Kawai, Hidehirobb901102007-07-19 01:48:31 -07002192 - (bit 0) anonymous private memory
2193 - (bit 1) anonymous shared memory
2194 - (bit 2) file-backed private memory
2195 - (bit 3) file-backed shared memory
Hidehiro Kawaib261dfe2008-09-13 02:33:10 -07002196 - (bit 4) ELF header pages in file-backed private memory areas (it is
2197 effective only if the bit 2 is cleared)
KOSAKI Motohiroe575f112008-10-18 20:27:08 -07002198 - (bit 5) hugetlb private memory
2199 - (bit 6) hugetlb shared memory
Kawai, Hidehirobb901102007-07-19 01:48:31 -07002200
2201 Note that MMIO pages such as frame buffer are never dumped and vDSO pages
2202 are always dumped regardless of the bitmask status.
2203
KOSAKI Motohiroe575f112008-10-18 20:27:08 -07002204 Note bit 0-4 doesn't effect any hugetlb memory. hugetlb memory are only
2205 effected by bit 5-6.
2206
2207Default value of coredump_filter is 0x23; this means all anonymous memory
2208segments and hugetlb private memory are dumped.
Kawai, Hidehirobb901102007-07-19 01:48:31 -07002209
2210If you don't want to dump all shared memory segments attached to pid 1234,
KOSAKI Motohiroe575f112008-10-18 20:27:08 -07002211write 0x21 to the process's proc file.
Kawai, Hidehirobb901102007-07-19 01:48:31 -07002212
KOSAKI Motohiroe575f112008-10-18 20:27:08 -07002213 $ echo 0x21 > /proc/1234/coredump_filter
Kawai, Hidehirobb901102007-07-19 01:48:31 -07002214
2215When a new process is created, the process inherits the bitmask status from its
2216parent. It is useful to set up coredump_filter before the program runs.
2217For example:
2218
2219 $ echo 0x7 > /proc/self/coredump_filter
2220 $ ./some_program
2221
Ram Pai2d4d4862008-03-27 13:06:25 +010022222.16 /proc/<pid>/mountinfo - Information about mounts
2223--------------------------------------------------------
2224
2225This file contains lines of the form:
2226
222736 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue
2228(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)
2229
2230(1) mount ID: unique identifier of the mount (may be reused after umount)
2231(2) parent ID: ID of parent (or of self for the top of the mount tree)
2232(3) major:minor: value of st_dev for files on filesystem
2233(4) root: root of the mount within the filesystem
2234(5) mount point: mount point relative to the process's root
2235(6) mount options: per mount options
2236(7) optional fields: zero or more fields of the form "tag[:value]"
2237(8) separator: marks the end of the optional fields
2238(9) filesystem type: name of filesystem of the form "type[.subtype]"
2239(10) mount source: filesystem specific information or "none"
2240(11) super options: per super block options
2241
2242Parsers should ignore all unrecognised optional fields. Currently the
2243possible optional fields are:
2244
2245shared:X mount is shared in peer group X
2246master:X mount is slave to peer group X
Miklos Szeredi97e7e0f2008-03-27 13:06:26 +01002247propagate_from:X mount is slave and receives propagation from peer group X (*)
Ram Pai2d4d4862008-03-27 13:06:25 +01002248unbindable mount is unbindable
2249
Miklos Szeredi97e7e0f2008-03-27 13:06:26 +01002250(*) X is the closest dominant peer group under the process's root. If
2251X is the immediate master of the mount, or if there's no dominant peer
2252group under the same root, then only the "master:X" field is present
2253and not the "propagate_from:X" field.
2254
Ram Pai2d4d4862008-03-27 13:06:25 +01002255For more information on mount propagation see:
2256
2257 Documentation/filesystems/sharedsubtree.txt
2258
Davide Libenzi7ef99642008-12-01 13:13:55 -080022592.17 /proc/sys/fs/epoll - Configuration options for the epoll interface
2260--------------------------------------------------------
2261
2262This directory contains configuration options for the epoll(7) interface.
2263
2264max_user_instances
2265------------------
2266
2267This is the maximum number of epoll file descriptors that a single user can
2268have open at a given time. The default value is 128, and should be enough
2269for normal users.
2270
2271max_user_watches
2272----------------
2273
2274Every epoll file descriptor can store a number of files to be monitored
2275for event readiness. Each one of these monitored files constitutes a "watch".
2276This configuration option sets the maximum number of "watches" that are
2277allowed for each user.
2278Each "watch" costs roughly 90 bytes on a 32bit kernel, and roughly 160 bytes
2279on a 64bit one.
2280The current default value for max_user_watches is the 1/32 of the available
2281low memory, divided for the "watch" cost in bytes.
2282
2283
Roland Kletzingf9c99462007-03-05 00:30:54 -08002284------------------------------------------------------------------------------
Davide Libenzi7ef99642008-12-01 13:13:55 -08002285