blob: 5484ab5efd4f54433bc2a6f7c16c482cf8085001 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46------------------------------------------------------------------------------
47Preface
48------------------------------------------------------------------------------
49
500.1 Introduction/Credits
51------------------------
52
53This documentation is part of a soon (or so we hope) to be released book on
54the SuSE Linux distribution. As there is no complete documentation for the
55/proc file system and we've used many freely available sources to write these
56chapters, it seems only fair to give the work back to the Linux community.
57This work is based on the 2.2.* kernel version and the upcoming 2.4.*. I'm
58afraid it's still far from complete, but we hope it will be useful. As far as
59we know, it is the first 'all-in-one' document about the /proc file system. It
60is focused on the Intel x86 hardware, so if you are looking for PPC, ARM,
61SPARC, AXP, etc., features, you probably won't find what you are looking for.
62It also only covers IPv4 networking, not IPv6 nor other protocols - sorry. But
63additions and patches are welcome and will be added to this document if you
64mail them to Bodo.
65
66We'd like to thank Alan Cox, Rik van Riel, and Alexey Kuznetsov and a lot of
67other people for help compiling this documentation. We'd also like to extend a
68special thank you to Andi Kleen for documentation, which we relied on heavily
69to create this document, as well as the additional information he provided.
70Thanks to everybody else who contributed source or docs to the Linux kernel
71and helped create a great piece of software... :)
72
73If you have any comments, corrections or additions, please don't hesitate to
74contact Bodo Bauer at bb@ricochet.net. We'll be happy to add them to this
75document.
76
77The latest version of this document is available online at
78http://skaro.nightcrawler.com/~bb/Docs/Proc as HTML version.
79
80If the above direction does not works for you, ypu could try the kernel
81mailing list at linux-kernel@vger.kernel.org and/or try to reach me at
82comandante@zaralinux.com.
83
840.2 Legal Stuff
85---------------
86
87We don't guarantee the correctness of this document, and if you come to us
88complaining about how you screwed up your system because of incorrect
89documentation, we won't feel responsible...
90
91------------------------------------------------------------------------------
92CHAPTER 1: COLLECTING SYSTEM INFORMATION
93------------------------------------------------------------------------------
94
95------------------------------------------------------------------------------
96In This Chapter
97------------------------------------------------------------------------------
98* Investigating the properties of the pseudo file system /proc and its
99 ability to provide information on the running Linux system
100* Examining /proc's structure
101* Uncovering various information about the kernel and the processes running
102 on the system
103------------------------------------------------------------------------------
104
105
106The proc file system acts as an interface to internal data structures in the
107kernel. It can be used to obtain information about the system and to change
108certain kernel parameters at runtime (sysctl).
109
110First, we'll take a look at the read-only parts of /proc. In Chapter 2, we
111show you how you can use /proc/sys to change settings.
112
1131.1 Process-Specific Subdirectories
114-----------------------------------
115
116The directory /proc contains (among other things) one subdirectory for each
117process running on the system, which is named after the process ID (PID).
118
119The link self points to the process reading the file system. Each process
120subdirectory has the entries listed in Table 1-1.
121
122
123Table 1-1: Process specific entries in /proc
124..............................................................................
125 File Content
126 cmdline Command line arguments
Uwe Zeisbergerc30fe7f2006-03-24 18:23:14 +0100127 cpu Current and last cpu in which it was executed (2.4)(smp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 cwd Link to the current working directory
129 environ Values of environment variables
130 exe Link to the executable of this process
131 fd Directory, which contains all file descriptors
132 maps Memory maps to executables and library files (2.4)
133 mem Memory held by this process
134 root Link to the root directory of this process
135 stat Process status
136 statm Process memory status information
137 status Process status in human readable form
138 wchan If CONFIG_KALLSYMS is set, a pre-decoded wchan
Mauricio Line070ad42005-09-03 15:55:10 -0700139 smaps Extension based on maps, presenting the rss size for each mapped file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140..............................................................................
141
142For example, to get the status information of a process, all you have to do is
143read the file /proc/PID/status:
144
145 >cat /proc/self/status
146 Name: cat
147 State: R (running)
148 Pid: 5452
149 PPid: 743
150 TracerPid: 0 (2.4)
151 Uid: 501 501 501 501
152 Gid: 100 100 100 100
153 Groups: 100 14 16
154 VmSize: 1112 kB
155 VmLck: 0 kB
156 VmRSS: 348 kB
157 VmData: 24 kB
158 VmStk: 12 kB
159 VmExe: 8 kB
160 VmLib: 1044 kB
161 SigPnd: 0000000000000000
162 SigBlk: 0000000000000000
163 SigIgn: 0000000000000000
164 SigCgt: 0000000000000000
165 CapInh: 00000000fffffeff
166 CapPrm: 0000000000000000
167 CapEff: 0000000000000000
168
169
170This shows you nearly the same information you would get if you viewed it with
171the ps command. In fact, ps uses the proc file system to obtain its
172information. The statm file contains more detailed information about the
173process memory usage. Its seven fields are explained in Table 1-2.
174
175
176Table 1-2: Contents of the statm files (as of 2.6.8-rc3)
177..............................................................................
178 Field Content
179 size total program size (pages) (same as VmSize in status)
180 resident size of memory portions (pages) (same as VmRSS in status)
181 shared number of pages that are shared (i.e. backed by a file)
182 trs number of pages that are 'code' (not including libs; broken,
183 includes data segment)
184 lrs number of pages of library (always 0 on 2.6)
185 drs number of pages of data/stack (including libs; broken,
186 includes library text)
187 dt number of dirty pages (always 0 on 2.6)
188..............................................................................
189
1901.2 Kernel data
191---------------
192
193Similar to the process entries, the kernel data files give information about
194the running kernel. The files used to obtain this information are contained in
195/proc and are listed in Table 1-3. Not all of these will be present in your
196system. It depends on the kernel configuration and the loaded modules, which
197files are there, and which are missing.
198
199Table 1-3: Kernel info in /proc
200..............................................................................
201 File Content
202 apm Advanced power management info
203 buddyinfo Kernel memory allocator information (see text) (2.5)
204 bus Directory containing bus specific information
205 cmdline Kernel command line
206 cpuinfo Info about the CPU
207 devices Available devices (block and character)
208 dma Used DMS channels
209 filesystems Supported filesystems
210 driver Various drivers grouped here, currently rtc (2.4)
211 execdomains Execdomains, related to security (2.4)
212 fb Frame Buffer devices (2.4)
213 fs File system parameters, currently nfs/exports (2.4)
214 ide Directory containing info about the IDE subsystem
215 interrupts Interrupt usage
216 iomem Memory map (2.4)
217 ioports I/O port usage
218 irq Masks for irq to cpu affinity (2.4)(smp?)
219 isapnp ISA PnP (Plug&Play) Info (2.4)
220 kcore Kernel core image (can be ELF or A.OUT(deprecated in 2.4))
221 kmsg Kernel messages
222 ksyms Kernel symbol table
223 loadavg Load average of last 1, 5 & 15 minutes
224 locks Kernel locks
225 meminfo Memory info
226 misc Miscellaneous
227 modules List of loaded modules
228 mounts Mounted filesystems
229 net Networking info (see text)
230 partitions Table of partitions known to the system
231 pci Depreciated info of PCI bus (new way -> /proc/bus/pci/,
232 decoupled by lspci (2.4)
233 rtc Real time clock
234 scsi SCSI info (see text)
235 slabinfo Slab pool info
236 stat Overall statistics
237 swaps Swap space utilization
238 sys See chapter 2
239 sysvipc Info of SysVIPC Resources (msg, sem, shm) (2.4)
240 tty Info of tty drivers
241 uptime System uptime
242 version Kernel version
243 video bttv info of video resources (2.4)
244..............................................................................
245
246You can, for example, check which interrupts are currently in use and what
247they are used for by looking in the file /proc/interrupts:
248
249 > cat /proc/interrupts
250 CPU0
251 0: 8728810 XT-PIC timer
252 1: 895 XT-PIC keyboard
253 2: 0 XT-PIC cascade
254 3: 531695 XT-PIC aha152x
255 4: 2014133 XT-PIC serial
256 5: 44401 XT-PIC pcnet_cs
257 8: 2 XT-PIC rtc
258 11: 8 XT-PIC i82365
259 12: 182918 XT-PIC PS/2 Mouse
260 13: 1 XT-PIC fpu
261 14: 1232265 XT-PIC ide0
262 15: 7 XT-PIC ide1
263 NMI: 0
264
265In 2.4.* a couple of lines where added to this file LOC & ERR (this time is the
266output of a SMP machine):
267
268 > cat /proc/interrupts
269
270 CPU0 CPU1
271 0: 1243498 1214548 IO-APIC-edge timer
272 1: 8949 8958 IO-APIC-edge keyboard
273 2: 0 0 XT-PIC cascade
274 5: 11286 10161 IO-APIC-edge soundblaster
275 8: 1 0 IO-APIC-edge rtc
276 9: 27422 27407 IO-APIC-edge 3c503
277 12: 113645 113873 IO-APIC-edge PS/2 Mouse
278 13: 0 0 XT-PIC fpu
279 14: 22491 24012 IO-APIC-edge ide0
280 15: 2183 2415 IO-APIC-edge ide1
281 17: 30564 30414 IO-APIC-level eth0
282 18: 177 164 IO-APIC-level bttv
283 NMI: 2457961 2457959
284 LOC: 2457882 2457881
285 ERR: 2155
286
287NMI is incremented in this case because every timer interrupt generates a NMI
288(Non Maskable Interrupt) which is used by the NMI Watchdog to detect lockups.
289
290LOC is the local interrupt counter of the internal APIC of every CPU.
291
292ERR is incremented in the case of errors in the IO-APIC bus (the bus that
293connects the CPUs in a SMP system. This means that an error has been detected,
294the IO-APIC automatically retry the transmission, so it should not be a big
295problem, but you should read the SMP-FAQ.
296
297In this context it could be interesting to note the new irq directory in 2.4.
298It could be used to set IRQ to CPU affinity, this means that you can "hook" an
299IRQ to only one CPU, or to exclude a CPU of handling IRQs. The contents of the
300irq subdir is one subdir for each IRQ, and one file; prof_cpu_mask
301
302For example
303 > ls /proc/irq/
304 0 10 12 14 16 18 2 4 6 8 prof_cpu_mask
305 1 11 13 15 17 19 3 5 7 9
306 > ls /proc/irq/0/
307 smp_affinity
308
309The contents of the prof_cpu_mask file and each smp_affinity file for each IRQ
310is the same by default:
311
312 > cat /proc/irq/0/smp_affinity
313 ffffffff
314
Uwe Zeisbergerc30fe7f2006-03-24 18:23:14 +0100315It's a bitmask, in which you can specify which CPUs can handle the IRQ, you can
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316set it by doing:
317
318 > echo 1 > /proc/irq/prof_cpu_mask
319
320This means that only the first CPU will handle the IRQ, but you can also echo 5
Uwe Zeisbergerc30fe7f2006-03-24 18:23:14 +0100321which means that only the first and fourth CPU can handle the IRQ.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323The way IRQs are routed is handled by the IO-APIC, and it's Round Robin
324between all the CPUs which are allowed to handle it. As usual the kernel has
325more info than you and does a better job than you, so the defaults are the
326best choice for almost everyone.
327
328There are three more important subdirectories in /proc: net, scsi, and sys.
329The general rule is that the contents, or even the existence of these
330directories, depend on your kernel configuration. If SCSI is not enabled, the
331directory scsi may not exist. The same is true with the net, which is there
332only when networking support is present in the running kernel.
333
334The slabinfo file gives information about memory usage at the slab level.
335Linux uses slab pools for memory management above page level in version 2.2.
336Commonly used objects have their own slab pool (such as network buffers,
337directory cache, and so on).
338
339..............................................................................
340
341> cat /proc/buddyinfo
342
343Node 0, zone DMA 0 4 5 4 4 3 ...
344Node 0, zone Normal 1 0 0 1 101 8 ...
345Node 0, zone HighMem 2 0 0 1 1 0 ...
346
347Memory fragmentation is a problem under some workloads, and buddyinfo is a
348useful tool for helping diagnose these problems. Buddyinfo will give you a
349clue as to how big an area you can safely allocate, or why a previous
350allocation failed.
351
352Each column represents the number of pages of a certain order which are
353available. In this case, there are 0 chunks of 2^0*PAGE_SIZE available in
354ZONE_DMA, 4 chunks of 2^1*PAGE_SIZE in ZONE_DMA, 101 chunks of 2^4*PAGE_SIZE
355available in ZONE_NORMAL, etc...
356
357..............................................................................
358
359meminfo:
360
361Provides information about distribution and utilization of memory. This
362varies by architecture and compile options. The following is from a
36316GB PIII, which has highmem enabled. You may not have all of these fields.
364
365> cat /proc/meminfo
366
367
368MemTotal: 16344972 kB
369MemFree: 13634064 kB
370Buffers: 3656 kB
371Cached: 1195708 kB
372SwapCached: 0 kB
373Active: 891636 kB
374Inactive: 1077224 kB
375HighTotal: 15597528 kB
376HighFree: 13629632 kB
377LowTotal: 747444 kB
378LowFree: 4432 kB
379SwapTotal: 0 kB
380SwapFree: 0 kB
381Dirty: 968 kB
382Writeback: 0 kB
383Mapped: 280372 kB
384Slab: 684068 kB
385CommitLimit: 7669796 kB
386Committed_AS: 100056 kB
387PageTables: 24448 kB
388VmallocTotal: 112216 kB
389VmallocUsed: 428 kB
390VmallocChunk: 111088 kB
391
392 MemTotal: Total usable ram (i.e. physical ram minus a few reserved
393 bits and the kernel binary code)
394 MemFree: The sum of LowFree+HighFree
395 Buffers: Relatively temporary storage for raw disk blocks
396 shouldn't get tremendously large (20MB or so)
397 Cached: in-memory cache for files read from the disk (the
398 pagecache). Doesn't include SwapCached
399 SwapCached: Memory that once was swapped out, is swapped back in but
400 still also is in the swapfile (if memory is needed it
401 doesn't need to be swapped out AGAIN because it is already
402 in the swapfile. This saves I/O)
403 Active: Memory that has been used more recently and usually not
404 reclaimed unless absolutely necessary.
405 Inactive: Memory which has been less recently used. It is more
406 eligible to be reclaimed for other purposes
407 HighTotal:
408 HighFree: Highmem is all memory above ~860MB of physical memory
409 Highmem areas are for use by userspace programs, or
410 for the pagecache. The kernel must use tricks to access
411 this memory, making it slower to access than lowmem.
412 LowTotal:
413 LowFree: Lowmem is memory which can be used for everything that
Matt LaPlante3f6dee92006-10-03 22:45:33 +0200414 highmem can be used for, but it is also available for the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 kernel's use for its own data structures. Among many
416 other things, it is where everything from the Slab is
417 allocated. Bad things happen when you're out of lowmem.
418 SwapTotal: total amount of swap space available
419 SwapFree: Memory which has been evicted from RAM, and is temporarily
420 on the disk
421 Dirty: Memory which is waiting to get written back to the disk
422 Writeback: Memory which is actively being written back to the disk
423 Mapped: files which have been mmaped, such as libraries
Adrian Bunke82443c2006-01-10 00:20:30 +0100424 Slab: in-kernel data structures cache
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 CommitLimit: Based on the overcommit ratio ('vm.overcommit_ratio'),
426 this is the total amount of memory currently available to
427 be allocated on the system. This limit is only adhered to
428 if strict overcommit accounting is enabled (mode 2 in
429 'vm.overcommit_memory').
430 The CommitLimit is calculated with the following formula:
431 CommitLimit = ('vm.overcommit_ratio' * Physical RAM) + Swap
432 For example, on a system with 1G of physical RAM and 7G
433 of swap with a `vm.overcommit_ratio` of 30 it would
434 yield a CommitLimit of 7.3G.
435 For more details, see the memory overcommit documentation
436 in vm/overcommit-accounting.
437Committed_AS: The amount of memory presently allocated on the system.
438 The committed memory is a sum of all of the memory which
439 has been allocated by processes, even if it has not been
440 "used" by them as of yet. A process which malloc()'s 1G
441 of memory, but only touches 300M of it will only show up
442 as using 300M of memory even if it has the address space
443 allocated for the entire 1G. This 1G is memory which has
444 been "committed" to by the VM and can be used at any time
445 by the allocating application. With strict overcommit
446 enabled on the system (mode 2 in 'vm.overcommit_memory'),
447 allocations which would exceed the CommitLimit (detailed
448 above) will not be permitted. This is useful if one needs
449 to guarantee that processes will not fail due to lack of
450 memory once that memory has been successfully allocated.
451 PageTables: amount of memory dedicated to the lowest level of page
452 tables.
453VmallocTotal: total size of vmalloc memory area
454 VmallocUsed: amount of vmalloc area which is used
455VmallocChunk: largest contigious block of vmalloc area which is free
456
457
4581.3 IDE devices in /proc/ide
459----------------------------
460
461The subdirectory /proc/ide contains information about all IDE devices of which
462the kernel is aware. There is one subdirectory for each IDE controller, the
463file drivers and a link for each IDE device, pointing to the device directory
464in the controller specific subtree.
465
466The file drivers contains general information about the drivers used for the
467IDE devices:
468
469 > cat /proc/ide/drivers
470 ide-cdrom version 4.53
471 ide-disk version 1.08
472
473More detailed information can be found in the controller specific
474subdirectories. These are named ide0, ide1 and so on. Each of these
475directories contains the files shown in table 1-4.
476
477
478Table 1-4: IDE controller info in /proc/ide/ide?
479..............................................................................
480 File Content
481 channel IDE channel (0 or 1)
482 config Configuration (only for PCI/IDE bridge)
483 mate Mate name
484 model Type/Chipset of IDE controller
485..............................................................................
486
487Each device connected to a controller has a separate subdirectory in the
488controllers directory. The files listed in table 1-5 are contained in these
489directories.
490
491
492Table 1-5: IDE device information
493..............................................................................
494 File Content
495 cache The cache
496 capacity Capacity of the medium (in 512Byte blocks)
497 driver driver and version
498 geometry physical and logical geometry
499 identify device identify block
500 media media type
501 model device identifier
502 settings device setup
503 smart_thresholds IDE disk management thresholds
504 smart_values IDE disk management values
505..............................................................................
506
507The most interesting file is settings. This file contains a nice overview of
508the drive parameters:
509
510 # cat /proc/ide/ide0/hda/settings
511 name value min max mode
512 ---- ----- --- --- ----
513 bios_cyl 526 0 65535 rw
514 bios_head 255 0 255 rw
515 bios_sect 63 0 63 rw
516 breada_readahead 4 0 127 rw
517 bswap 0 0 1 r
518 file_readahead 72 0 2097151 rw
519 io_32bit 0 0 3 rw
520 keepsettings 0 0 1 rw
521 max_kb_per_request 122 1 127 rw
522 multcount 0 0 8 rw
523 nice1 1 0 1 rw
524 nowerr 0 0 1 rw
525 pio_mode write-only 0 255 w
526 slow 0 0 1 rw
527 unmaskirq 0 0 1 rw
528 using_dma 0 0 1 rw
529
530
5311.4 Networking info in /proc/net
532--------------------------------
533
534The subdirectory /proc/net follows the usual pattern. Table 1-6 shows the
535additional values you get for IP version 6 if you configure the kernel to
536support this. Table 1-7 lists the files and their meaning.
537
538
539Table 1-6: IPv6 info in /proc/net
540..............................................................................
541 File Content
542 udp6 UDP sockets (IPv6)
543 tcp6 TCP sockets (IPv6)
544 raw6 Raw device statistics (IPv6)
545 igmp6 IP multicast addresses, which this host joined (IPv6)
546 if_inet6 List of IPv6 interface addresses
547 ipv6_route Kernel routing table for IPv6
548 rt6_stats Global IPv6 routing tables statistics
549 sockstat6 Socket statistics (IPv6)
550 snmp6 Snmp data (IPv6)
551..............................................................................
552
553
554Table 1-7: Network info in /proc/net
555..............................................................................
556 File Content
557 arp Kernel ARP table
558 dev network devices with statistics
559 dev_mcast the Layer2 multicast groups a device is listening too
560 (interface index, label, number of references, number of bound
561 addresses).
562 dev_stat network device status
563 ip_fwchains Firewall chain linkage
564 ip_fwnames Firewall chain names
565 ip_masq Directory containing the masquerading tables
566 ip_masquerade Major masquerading table
567 netstat Network statistics
568 raw raw device statistics
569 route Kernel routing table
570 rpc Directory containing rpc info
571 rt_cache Routing cache
572 snmp SNMP data
573 sockstat Socket statistics
574 tcp TCP sockets
575 tr_rif Token ring RIF routing table
576 udp UDP sockets
577 unix UNIX domain sockets
578 wireless Wireless interface data (Wavelan etc)
579 igmp IP multicast addresses, which this host joined
580 psched Global packet scheduler parameters.
581 netlink List of PF_NETLINK sockets
582 ip_mr_vifs List of multicast virtual interfaces
583 ip_mr_cache List of multicast routing cache
584..............................................................................
585
586You can use this information to see which network devices are available in
587your system and how much traffic was routed over those devices:
588
589 > cat /proc/net/dev
590 Inter-|Receive |[...
591 face |bytes packets errs drop fifo frame compressed multicast|[...
592 lo: 908188 5596 0 0 0 0 0 0 [...
593 ppp0:15475140 20721 410 0 0 410 0 0 [...
594 eth0: 614530 7085 0 0 0 0 0 1 [...
595
596 ...] Transmit
597 ...] bytes packets errs drop fifo colls carrier compressed
598 ...] 908188 5596 0 0 0 0 0 0
599 ...] 1375103 17405 0 0 0 0 0 0
600 ...] 1703981 5535 0 0 0 3 0 0
601
602In addition, each Channel Bond interface has it's own directory. For
603example, the bond0 device will have a directory called /proc/net/bond0/.
604It will contain information that is specific to that bond, such as the
605current slaves of the bond, the link status of the slaves, and how
606many times the slaves link has failed.
607
6081.5 SCSI info
609-------------
610
611If you have a SCSI host adapter in your system, you'll find a subdirectory
612named after the driver for this adapter in /proc/scsi. You'll also see a list
613of all recognized SCSI devices in /proc/scsi:
614
615 >cat /proc/scsi/scsi
616 Attached devices:
617 Host: scsi0 Channel: 00 Id: 00 Lun: 00
618 Vendor: IBM Model: DGHS09U Rev: 03E0
619 Type: Direct-Access ANSI SCSI revision: 03
620 Host: scsi0 Channel: 00 Id: 06 Lun: 00
621 Vendor: PIONEER Model: CD-ROM DR-U06S Rev: 1.04
622 Type: CD-ROM ANSI SCSI revision: 02
623
624
625The directory named after the driver has one file for each adapter found in
626the system. These files contain information about the controller, including
627the used IRQ and the IO address range. The amount of information shown is
628dependent on the adapter you use. The example shows the output for an Adaptec
629AHA-2940 SCSI adapter:
630
631 > cat /proc/scsi/aic7xxx/0
632
633 Adaptec AIC7xxx driver version: 5.1.19/3.2.4
634 Compile Options:
635 TCQ Enabled By Default : Disabled
636 AIC7XXX_PROC_STATS : Disabled
637 AIC7XXX_RESET_DELAY : 5
638 Adapter Configuration:
639 SCSI Adapter: Adaptec AHA-294X Ultra SCSI host adapter
640 Ultra Wide Controller
641 PCI MMAPed I/O Base: 0xeb001000
642 Adapter SEEPROM Config: SEEPROM found and used.
643 Adaptec SCSI BIOS: Enabled
644 IRQ: 10
645 SCBs: Active 0, Max Active 2,
646 Allocated 15, HW 16, Page 255
647 Interrupts: 160328
648 BIOS Control Word: 0x18b6
649 Adapter Control Word: 0x005b
650 Extended Translation: Enabled
651 Disconnect Enable Flags: 0xffff
652 Ultra Enable Flags: 0x0001
653 Tag Queue Enable Flags: 0x0000
654 Ordered Queue Tag Flags: 0x0000
655 Default Tag Queue Depth: 8
656 Tagged Queue By Device array for aic7xxx host instance 0:
657 {255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255}
658 Actual queue depth per device for aic7xxx host instance 0:
659 {1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1}
660 Statistics:
661 (scsi0:0:0:0)
662 Device using Wide/Sync transfers at 40.0 MByte/sec, offset 8
663 Transinfo settings: current(12/8/1/0), goal(12/8/1/0), user(12/15/1/0)
664 Total transfers 160151 (74577 reads and 85574 writes)
665 (scsi0:0:6:0)
666 Device using Narrow/Sync transfers at 5.0 MByte/sec, offset 15
667 Transinfo settings: current(50/15/0/0), goal(50/15/0/0), user(50/15/0/0)
668 Total transfers 0 (0 reads and 0 writes)
669
670
6711.6 Parallel port info in /proc/parport
672---------------------------------------
673
674The directory /proc/parport contains information about the parallel ports of
675your system. It has one subdirectory for each port, named after the port
676number (0,1,2,...).
677
678These directories contain the four files shown in Table 1-8.
679
680
681Table 1-8: Files in /proc/parport
682..............................................................................
683 File Content
684 autoprobe Any IEEE-1284 device ID information that has been acquired.
685 devices list of the device drivers using that port. A + will appear by the
686 name of the device currently using the port (it might not appear
687 against any).
688 hardware Parallel port's base address, IRQ line and DMA channel.
689 irq IRQ that parport is using for that port. This is in a separate
690 file to allow you to alter it by writing a new value in (IRQ
691 number or none).
692..............................................................................
693
6941.7 TTY info in /proc/tty
695-------------------------
696
697Information about the available and actually used tty's can be found in the
698directory /proc/tty.You'll find entries for drivers and line disciplines in
699this directory, as shown in Table 1-9.
700
701
702Table 1-9: Files in /proc/tty
703..............................................................................
704 File Content
705 drivers list of drivers and their usage
706 ldiscs registered line disciplines
707 driver/serial usage statistic and status of single tty lines
708..............................................................................
709
710To see which tty's are currently in use, you can simply look into the file
711/proc/tty/drivers:
712
713 > cat /proc/tty/drivers
714 pty_slave /dev/pts 136 0-255 pty:slave
715 pty_master /dev/ptm 128 0-255 pty:master
716 pty_slave /dev/ttyp 3 0-255 pty:slave
717 pty_master /dev/pty 2 0-255 pty:master
718 serial /dev/cua 5 64-67 serial:callout
719 serial /dev/ttyS 4 64-67 serial
720 /dev/tty0 /dev/tty0 4 0 system:vtmaster
721 /dev/ptmx /dev/ptmx 5 2 system
722 /dev/console /dev/console 5 1 system:console
723 /dev/tty /dev/tty 5 0 system:/dev/tty
724 unknown /dev/tty 4 1-63 console
725
726
7271.8 Miscellaneous kernel statistics in /proc/stat
728-------------------------------------------------
729
730Various pieces of information about kernel activity are available in the
731/proc/stat file. All of the numbers reported in this file are aggregates
732since the system first booted. For a quick look, simply cat the file:
733
734 > cat /proc/stat
735 cpu 2255 34 2290 22625563 6290 127 456
736 cpu0 1132 34 1441 11311718 3675 127 438
737 cpu1 1123 0 849 11313845 2614 0 18
738 intr 114930548 113199788 3 0 5 263 0 4 [... lots more numbers ...]
739 ctxt 1990473
740 btime 1062191376
741 processes 2915
742 procs_running 1
743 procs_blocked 0
744
745The very first "cpu" line aggregates the numbers in all of the other "cpuN"
746lines. These numbers identify the amount of time the CPU has spent performing
747different kinds of work. Time units are in USER_HZ (typically hundredths of a
748second). The meanings of the columns are as follows, from left to right:
749
750- user: normal processes executing in user mode
751- nice: niced processes executing in user mode
752- system: processes executing in kernel mode
753- idle: twiddling thumbs
754- iowait: waiting for I/O to complete
755- irq: servicing interrupts
756- softirq: servicing softirqs
757
758The "intr" line gives counts of interrupts serviced since boot time, for each
759of the possible system interrupts. The first column is the total of all
760interrupts serviced; each subsequent column is the total for that particular
761interrupt.
762
763The "ctxt" line gives the total number of context switches across all CPUs.
764
765The "btime" line gives the time at which the system booted, in seconds since
766the Unix epoch.
767
768The "processes" line gives the number of processes and threads created, which
769includes (but is not limited to) those created by calls to the fork() and
770clone() system calls.
771
772The "procs_running" line gives the number of processes currently running on
773CPUs.
774
775The "procs_blocked" line gives the number of processes currently blocked,
776waiting for I/O to complete.
777
778
779------------------------------------------------------------------------------
780Summary
781------------------------------------------------------------------------------
782The /proc file system serves information about the running system. It not only
783allows access to process data but also allows you to request the kernel status
784by reading files in the hierarchy.
785
786The directory structure of /proc reflects the types of information and makes
787it easy, if not obvious, where to look for specific data.
788------------------------------------------------------------------------------
789
790------------------------------------------------------------------------------
791CHAPTER 2: MODIFYING SYSTEM PARAMETERS
792------------------------------------------------------------------------------
793
794------------------------------------------------------------------------------
795In This Chapter
796------------------------------------------------------------------------------
797* Modifying kernel parameters by writing into files found in /proc/sys
798* Exploring the files which modify certain parameters
799* Review of the /proc/sys file tree
800------------------------------------------------------------------------------
801
802
803A very interesting part of /proc is the directory /proc/sys. This is not only
804a source of information, it also allows you to change parameters within the
805kernel. Be very careful when attempting this. You can optimize your system,
806but you can also cause it to crash. Never alter kernel parameters on a
807production system. Set up a development machine and test to make sure that
808everything works the way you want it to. You may have no alternative but to
809reboot the machine once an error has been made.
810
811To change a value, simply echo the new value into the file. An example is
812given below in the section on the file system data. You need to be root to do
813this. You can create your own boot script to perform this every time your
814system boots.
815
816The files in /proc/sys can be used to fine tune and monitor miscellaneous and
817general things in the operation of the Linux kernel. Since some of the files
818can inadvertently disrupt your system, it is advisable to read both
819documentation and source before actually making adjustments. In any case, be
820very careful when writing to any of these files. The entries in /proc may
821change slightly between the 2.1.* and the 2.2 kernel, so if there is any doubt
822review the kernel documentation in the directory /usr/src/linux/Documentation.
823This chapter is heavily based on the documentation included in the pre 2.2
824kernels, and became part of it in version 2.2.1 of the Linux kernel.
825
8262.1 /proc/sys/fs - File system data
827-----------------------------------
828
829This subdirectory contains specific file system, file handle, inode, dentry
830and quota information.
831
832Currently, these files are in /proc/sys/fs:
833
834dentry-state
835------------
836
837Status of the directory cache. Since directory entries are dynamically
838allocated and deallocated, this file indicates the current status. It holds
839six values, in which the last two are not used and are always zero. The others
840are listed in table 2-1.
841
842
843Table 2-1: Status files of the directory cache
844..............................................................................
845 File Content
846 nr_dentry Almost always zero
847 nr_unused Number of unused cache entries
848 age_limit
849 in seconds after the entry may be reclaimed, when memory is short
850 want_pages internally
851..............................................................................
852
853dquot-nr and dquot-max
854----------------------
855
856The file dquot-max shows the maximum number of cached disk quota entries.
857
858The file dquot-nr shows the number of allocated disk quota entries and the
859number of free disk quota entries.
860
861If the number of available cached disk quotas is very low and you have a large
862number of simultaneous system users, you might want to raise the limit.
863
864file-nr and file-max
865--------------------
866
867The kernel allocates file handles dynamically, but doesn't free them again at
868this time.
869
870The value in file-max denotes the maximum number of file handles that the
871Linux kernel will allocate. When you get a lot of error messages about running
872out of file handles, you might want to raise this limit. The default value is
87310% of RAM in kilobytes. To change it, just write the new number into the
874file:
875
876 # cat /proc/sys/fs/file-max
877 4096
878 # echo 8192 > /proc/sys/fs/file-max
879 # cat /proc/sys/fs/file-max
880 8192
881
882
883This method of revision is useful for all customizable parameters of the
884kernel - simply echo the new value to the corresponding file.
885
886Historically, the three values in file-nr denoted the number of allocated file
887handles, the number of allocated but unused file handles, and the maximum
888number of file handles. Linux 2.6 always reports 0 as the number of free file
889handles -- this is not an error, it just means that the number of allocated
890file handles exactly matches the number of used file handles.
891
892Attempts to allocate more file descriptors than file-max are reported with
893printk, look for "VFS: file-max limit <number> reached".
894
895inode-state and inode-nr
896------------------------
897
898The file inode-nr contains the first two items from inode-state, so we'll skip
899to that file...
900
901inode-state contains two actual numbers and five dummy values. The numbers
902are nr_inodes and nr_free_inodes (in order of appearance).
903
904nr_inodes
905~~~~~~~~~
906
907Denotes the number of inodes the system has allocated. This number will
908grow and shrink dynamically.
909
910nr_free_inodes
911--------------
912
913Represents the number of free inodes. Ie. The number of inuse inodes is
914(nr_inodes - nr_free_inodes).
915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916aio-nr and aio-max-nr
917---------------------
918
919aio-nr is the running total of the number of events specified on the
920io_setup system call for all currently active aio contexts. If aio-nr
921reaches aio-max-nr then io_setup will fail with EAGAIN. Note that
922raising aio-max-nr does not result in the pre-allocation or re-sizing
923of any kernel data structures.
924
9252.2 /proc/sys/fs/binfmt_misc - Miscellaneous binary formats
926-----------------------------------------------------------
927
928Besides these files, there is the subdirectory /proc/sys/fs/binfmt_misc. This
929handles the kernel support for miscellaneous binary formats.
930
931Binfmt_misc provides the ability to register additional binary formats to the
932Kernel without compiling an additional module/kernel. Therefore, binfmt_misc
933needs to know magic numbers at the beginning or the filename extension of the
934binary.
935
936It works by maintaining a linked list of structs that contain a description of
937a binary format, including a magic with size (or the filename extension),
938offset and mask, and the interpreter name. On request it invokes the given
939interpreter with the original program as argument, as binfmt_java and
940binfmt_em86 and binfmt_mz do. Since binfmt_misc does not define any default
941binary-formats, you have to register an additional binary-format.
942
943There are two general files in binfmt_misc and one file per registered format.
944The two general files are register and status.
945
946Registering a new binary format
947-------------------------------
948
949To register a new binary format you have to issue the command
950
951 echo :name:type:offset:magic:mask:interpreter: > /proc/sys/fs/binfmt_misc/register
952
953
954
955with appropriate name (the name for the /proc-dir entry), offset (defaults to
9560, if omitted), magic, mask (which can be omitted, defaults to all 0xff) and
957last but not least, the interpreter that is to be invoked (for example and
958testing /bin/echo). Type can be M for usual magic matching or E for filename
959extension matching (give extension in place of magic).
960
961Check or reset the status of the binary format handler
962------------------------------------------------------
963
964If you do a cat on the file /proc/sys/fs/binfmt_misc/status, you will get the
965current status (enabled/disabled) of binfmt_misc. Change the status by echoing
9660 (disables) or 1 (enables) or -1 (caution: this clears all previously
967registered binary formats) to status. For example echo 0 > status to disable
968binfmt_misc (temporarily).
969
970Status of a single handler
971--------------------------
972
973Each registered handler has an entry in /proc/sys/fs/binfmt_misc. These files
974perform the same function as status, but their scope is limited to the actual
975binary format. By cating this file, you also receive all related information
976about the interpreter/magic of the binfmt.
977
978Example usage of binfmt_misc (emulate binfmt_java)
979--------------------------------------------------
980
981 cd /proc/sys/fs/binfmt_misc
982 echo ':Java:M::\xca\xfe\xba\xbe::/usr/local/java/bin/javawrapper:' > register
983 echo ':HTML:E::html::/usr/local/java/bin/appletviewer:' > register
984 echo ':Applet:M::<!--applet::/usr/local/java/bin/appletviewer:' > register
985 echo ':DEXE:M::\x0eDEX::/usr/bin/dosexec:' > register
986
987
988These four lines add support for Java executables and Java applets (like
989binfmt_java, additionally recognizing the .html extension with no need to put
990<!--applet> to every applet file). You have to install the JDK and the
991shell-script /usr/local/java/bin/javawrapper too. It works around the
992brokenness of the Java filename handling. To add a Java binary, just create a
993link to the class-file somewhere in the path.
994
9952.3 /proc/sys/kernel - general kernel parameters
996------------------------------------------------
997
998This directory reflects general kernel behaviors. As I've said before, the
999contents depend on your configuration. Here you'll find the most important
1000files, along with descriptions of what they mean and how to use them.
1001
1002acct
1003----
1004
1005The file contains three values; highwater, lowwater, and frequency.
1006
1007It exists only when BSD-style process accounting is enabled. These values
1008control its behavior. If the free space on the file system where the log lives
1009goes below lowwater percentage, accounting suspends. If it goes above
1010highwater percentage, accounting resumes. Frequency determines how often you
1011check the amount of free space (value is in seconds). Default settings are: 4,
10122, and 30. That is, suspend accounting if there is less than 2 percent free;
1013resume it if we have a value of 3 or more percent; consider information about
1014the amount of free space valid for 30 seconds
1015
1016ctrl-alt-del
1017------------
1018
1019When the value in this file is 0, ctrl-alt-del is trapped and sent to the init
1020program to handle a graceful restart. However, when the value is greater that
1021zero, Linux's reaction to this key combination will be an immediate reboot,
1022without syncing its dirty buffers.
1023
1024[NOTE]
1025 When a program (like dosemu) has the keyboard in raw mode, the
1026 ctrl-alt-del is intercepted by the program before it ever reaches the
1027 kernel tty layer, and it is up to the program to decide what to do with
1028 it.
1029
1030domainname and hostname
1031-----------------------
1032
1033These files can be controlled to set the NIS domainname and hostname of your
1034box. For the classic darkstar.frop.org a simple:
1035
1036 # echo "darkstar" > /proc/sys/kernel/hostname
1037 # echo "frop.org" > /proc/sys/kernel/domainname
1038
1039
1040would suffice to set your hostname and NIS domainname.
1041
1042osrelease, ostype and version
1043-----------------------------
1044
1045The names make it pretty obvious what these fields contain:
1046
1047 > cat /proc/sys/kernel/osrelease
1048 2.2.12
1049
1050 > cat /proc/sys/kernel/ostype
1051 Linux
1052
1053 > cat /proc/sys/kernel/version
1054 #4 Fri Oct 1 12:41:14 PDT 1999
1055
1056
1057The files osrelease and ostype should be clear enough. Version needs a little
1058more clarification. The #4 means that this is the 4th kernel built from this
1059source base and the date after it indicates the time the kernel was built. The
1060only way to tune these values is to rebuild the kernel.
1061
1062panic
1063-----
1064
1065The value in this file represents the number of seconds the kernel waits
1066before rebooting on a panic. When you use the software watchdog, the
1067recommended setting is 60. If set to 0, the auto reboot after a kernel panic
1068is disabled, which is the default setting.
1069
1070printk
1071------
1072
1073The four values in printk denote
1074* console_loglevel,
1075* default_message_loglevel,
1076* minimum_console_loglevel and
1077* default_console_loglevel
1078respectively.
1079
1080These values influence printk() behavior when printing or logging error
1081messages, which come from inside the kernel. See syslog(2) for more
1082information on the different log levels.
1083
1084console_loglevel
1085----------------
1086
1087Messages with a higher priority than this will be printed to the console.
1088
1089default_message_level
1090---------------------
1091
1092Messages without an explicit priority will be printed with this priority.
1093
1094minimum_console_loglevel
1095------------------------
1096
1097Minimum (highest) value to which the console_loglevel can be set.
1098
1099default_console_loglevel
1100------------------------
1101
1102Default value for console_loglevel.
1103
1104sg-big-buff
1105-----------
1106
1107This file shows the size of the generic SCSI (sg) buffer. At this point, you
1108can't tune it yet, but you can change it at compile time by editing
1109include/scsi/sg.h and changing the value of SG_BIG_BUFF.
1110
1111If you use a scanner with SANE (Scanner Access Now Easy) you might want to set
1112this to a higher value. Refer to the SANE documentation on this issue.
1113
1114modprobe
1115--------
1116
1117The location where the modprobe binary is located. The kernel uses this
1118program to load modules on demand.
1119
1120unknown_nmi_panic
1121-----------------
1122
1123The value in this file affects behavior of handling NMI. When the value is
1124non-zero, unknown NMI is trapped and then panic occurs. At that time, kernel
1125debugging information is displayed on console.
1126
1127NMI switch that most IA32 servers have fires unknown NMI up, for example.
1128If a system hangs up, try pressing the NMI switch.
1129
Don Zickuse33e89a2006-09-26 10:52:27 +02001130nmi_watchdog
1131------------
1132
1133Enables/Disables the NMI watchdog on x86 systems. When the value is non-zero
1134the NMI watchdog is enabled and will continuously test all online cpus to
1135determine whether or not they are still functioning properly.
1136
1137Because the NMI watchdog shares registers with oprofile, by disabling the NMI
1138watchdog, oprofile may have more registers to utilize.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
1140
11412.4 /proc/sys/vm - The virtual memory subsystem
1142-----------------------------------------------
1143
1144The files in this directory can be used to tune the operation of the virtual
1145memory (VM) subsystem of the Linux kernel.
1146
1147vfs_cache_pressure
1148------------------
1149
1150Controls the tendency of the kernel to reclaim the memory which is used for
1151caching of directory and inode objects.
1152
1153At the default value of vfs_cache_pressure=100 the kernel will attempt to
1154reclaim dentries and inodes at a "fair" rate with respect to pagecache and
1155swapcache reclaim. Decreasing vfs_cache_pressure causes the kernel to prefer
1156to retain dentry and inode caches. Increasing vfs_cache_pressure beyond 100
1157causes the kernel to prefer to reclaim dentries and inodes.
1158
1159dirty_background_ratio
1160----------------------
1161
1162Contains, as a percentage of total system memory, the number of pages at which
1163the pdflush background writeback daemon will start writing out dirty data.
1164
1165dirty_ratio
1166-----------------
1167
1168Contains, as a percentage of total system memory, the number of pages at which
1169a process which is generating disk writes will itself start writing out dirty
1170data.
1171
1172dirty_writeback_centisecs
1173-------------------------
1174
1175The pdflush writeback daemons will periodically wake up and write `old' data
1176out to disk. This tunable expresses the interval between those wakeups, in
1177100'ths of a second.
1178
1179Setting this to zero disables periodic writeback altogether.
1180
1181dirty_expire_centisecs
1182----------------------
1183
1184This tunable is used to define when dirty data is old enough to be eligible
1185for writeout by the pdflush daemons. It is expressed in 100'ths of a second.
1186Data which has been dirty in-memory for longer than this interval will be
1187written out next time a pdflush daemon wakes up.
1188
1189legacy_va_layout
1190----------------
1191
1192If non-zero, this sysctl disables the new 32-bit mmap mmap layout - the kernel
1193will use the legacy (2.4) layout for all processes.
1194
1195lower_zone_protection
1196---------------------
1197
1198For some specialised workloads on highmem machines it is dangerous for
1199the kernel to allow process memory to be allocated from the "lowmem"
1200zone. This is because that memory could then be pinned via the mlock()
1201system call, or by unavailability of swapspace.
1202
1203And on large highmem machines this lack of reclaimable lowmem memory
1204can be fatal.
1205
1206So the Linux page allocator has a mechanism which prevents allocations
1207which _could_ use highmem from using too much lowmem. This means that
1208a certain amount of lowmem is defended from the possibility of being
1209captured into pinned user memory.
1210
1211(The same argument applies to the old 16 megabyte ISA DMA region. This
1212mechanism will also defend that region from allocations which could use
1213highmem or lowmem).
1214
1215The `lower_zone_protection' tunable determines how aggressive the kernel is
1216in defending these lower zones. The default value is zero - no
1217protection at all.
1218
1219If you have a machine which uses highmem or ISA DMA and your
1220applications are using mlock(), or if you are running with no swap then
1221you probably should increase the lower_zone_protection setting.
1222
1223The units of this tunable are fairly vague. It is approximately equal
Matt LaPlante4ae0edc2006-11-30 04:58:40 +01001224to "megabytes," so setting lower_zone_protection=100 will protect around 100
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225megabytes of the lowmem zone from user allocations. It will also make
Matt LaPlante4ae0edc2006-11-30 04:58:40 +01001226those 100 megabytes unavailable for use by applications and by
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227pagecache, so there is a cost.
1228
1229The effects of this tunable may be observed by monitoring
1230/proc/meminfo:LowFree. Write a single huge file and observe the point
1231at which LowFree ceases to fall.
1232
1233A reasonable value for lower_zone_protection is 100.
1234
1235page-cluster
1236------------
1237
1238page-cluster controls the number of pages which are written to swap in
1239a single attempt. The swap I/O size.
1240
1241It is a logarithmic value - setting it to zero means "1 page", setting
1242it to 1 means "2 pages", setting it to 2 means "4 pages", etc.
1243
1244The default value is three (eight pages at a time). There may be some
1245small benefits in tuning this to a different value if your workload is
1246swap-intensive.
1247
1248overcommit_memory
1249-----------------
1250
Chuck Ebbertaf97c722005-09-09 13:10:15 -07001251Controls overcommit of system memory, possibly allowing processes
1252to allocate (but not use) more memory than is actually available.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
Chuck Ebbertaf97c722005-09-09 13:10:15 -07001254
12550 - Heuristic overcommit handling. Obvious overcommits of
1256 address space are refused. Used for a typical system. It
1257 ensures a seriously wild allocation fails while allowing
1258 overcommit to reduce swap usage. root is allowed to
Matt LaPlante53cb4722006-10-03 22:55:17 +02001259 allocate slightly more memory in this mode. This is the
Chuck Ebbertaf97c722005-09-09 13:10:15 -07001260 default.
1261
12621 - Always overcommit. Appropriate for some scientific
1263 applications.
1264
12652 - Don't overcommit. The total address space commit
1266 for the system is not permitted to exceed swap plus a
1267 configurable percentage (default is 50) of physical RAM.
1268 Depending on the percentage you use, in most situations
1269 this means a process will not be killed while attempting
1270 to use already-allocated memory but will receive errors
1271 on memory allocation as appropriate.
1272
1273overcommit_ratio
1274----------------
1275
1276Percentage of physical memory size to include in overcommit calculations
1277(see above.)
1278
1279Memory allocation limit = swapspace + physmem * (overcommit_ratio / 100)
1280
1281 swapspace = total size of all swap areas
1282 physmem = size of physical memory in system
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
1284nr_hugepages and hugetlb_shm_group
1285----------------------------------
1286
1287nr_hugepages configures number of hugetlb page reserved for the system.
1288
1289hugetlb_shm_group contains group id that is allowed to create SysV shared
1290memory segment using hugetlb page.
1291
1292laptop_mode
1293-----------
1294
1295laptop_mode is a knob that controls "laptop mode". All the things that are
1296controlled by this knob are discussed in Documentation/laptop-mode.txt.
1297
1298block_dump
1299----------
1300
1301block_dump enables block I/O debugging when set to a nonzero value. More
1302information on block I/O debugging is in Documentation/laptop-mode.txt.
1303
1304swap_token_timeout
1305------------------
1306
1307This file contains valid hold time of swap out protection token. The Linux
1308VM has token based thrashing control mechanism and uses the token to prevent
1309unnecessary page faults in thrashing situation. The unit of the value is
1310second. The value would be useful to tune thrashing behavior.
1311
Andrew Morton9d0243b2006-01-08 01:00:39 -08001312drop_caches
1313-----------
1314
1315Writing to this will cause the kernel to drop clean caches, dentries and
1316inodes from memory, causing that memory to become free.
1317
1318To free pagecache:
1319 echo 1 > /proc/sys/vm/drop_caches
1320To free dentries and inodes:
1321 echo 2 > /proc/sys/vm/drop_caches
1322To free pagecache, dentries and inodes:
1323 echo 3 > /proc/sys/vm/drop_caches
1324
1325As this is a non-destructive operation and dirty objects are not freeable, the
1326user should run `sync' first.
1327
1328
Linus Torvalds1da177e2005-04-16 15:20:36 -070013292.5 /proc/sys/dev - Device specific parameters
1330----------------------------------------------
1331
1332Currently there is only support for CDROM drives, and for those, there is only
1333one read-only file containing information about the CD-ROM drives attached to
1334the system:
1335
1336 >cat /proc/sys/dev/cdrom/info
1337 CD-ROM information, Id: cdrom.c 2.55 1999/04/25
1338
1339 drive name: sr0 hdb
1340 drive speed: 32 40
1341 drive # of slots: 1 0
1342 Can close tray: 1 1
1343 Can open tray: 1 1
1344 Can lock tray: 1 1
1345 Can change speed: 1 1
1346 Can select disk: 0 1
1347 Can read multisession: 1 1
1348 Can read MCN: 1 1
1349 Reports media changed: 1 1
1350 Can play audio: 1 1
1351
1352
1353You see two drives, sr0 and hdb, along with a list of their features.
1354
13552.6 /proc/sys/sunrpc - Remote procedure calls
1356---------------------------------------------
1357
1358This directory contains four files, which enable or disable debugging for the
1359RPC functions NFS, NFS-daemon, RPC and NLM. The default values are 0. They can
1360be set to one to turn debugging on. (The default value is 0 for each)
1361
13622.7 /proc/sys/net - Networking stuff
1363------------------------------------
1364
1365The interface to the networking parts of the kernel is located in
1366/proc/sys/net. Table 2-3 shows all possible subdirectories. You may see only
1367some of them, depending on your kernel's configuration.
1368
1369
1370Table 2-3: Subdirectories in /proc/sys/net
1371..............................................................................
1372 Directory Content Directory Content
1373 core General parameter appletalk Appletalk protocol
1374 unix Unix domain sockets netrom NET/ROM
1375 802 E802 protocol ax25 AX25
1376 ethernet Ethernet protocol rose X.25 PLP layer
1377 ipv4 IP version 4 x25 X.25 protocol
1378 ipx IPX token-ring IBM token ring
1379 bridge Bridging decnet DEC net
1380 ipv6 IP version 6
1381..............................................................................
1382
1383We will concentrate on IP networking here. Since AX15, X.25, and DEC Net are
1384only minor players in the Linux world, we'll skip them in this chapter. You'll
1385find some short info on Appletalk and IPX further on in this chapter. Review
1386the online documentation and the kernel source to get a detailed view of the
1387parameters for those protocols. In this section we'll discuss the
1388subdirectories printed in bold letters in the table above. As default values
1389are suitable for most needs, there is no need to change these values.
1390
1391/proc/sys/net/core - Network core options
1392-----------------------------------------
1393
1394rmem_default
1395------------
1396
1397The default setting of the socket receive buffer in bytes.
1398
1399rmem_max
1400--------
1401
1402The maximum receive socket buffer size in bytes.
1403
1404wmem_default
1405------------
1406
1407The default setting (in bytes) of the socket send buffer.
1408
1409wmem_max
1410--------
1411
1412The maximum send socket buffer size in bytes.
1413
1414message_burst and message_cost
1415------------------------------
1416
1417These parameters are used to limit the warning messages written to the kernel
1418log from the networking code. They enforce a rate limit to make a
1419denial-of-service attack impossible. A higher message_cost factor, results in
1420fewer messages that will be written. Message_burst controls when messages will
1421be dropped. The default settings limit warning messages to one every five
1422seconds.
1423
1424netdev_max_backlog
1425------------------
1426
1427Maximum number of packets, queued on the INPUT side, when the interface
1428receives packets faster than kernel can process them.
1429
1430optmem_max
1431----------
1432
1433Maximum ancillary buffer size allowed per socket. Ancillary data is a sequence
1434of struct cmsghdr structures with appended data.
1435
1436/proc/sys/net/unix - Parameters for Unix domain sockets
1437-------------------------------------------------------
1438
1439There are only two files in this subdirectory. They control the delays for
1440deleting and destroying socket descriptors.
1441
14422.8 /proc/sys/net/ipv4 - IPV4 settings
1443--------------------------------------
1444
1445IP version 4 is still the most used protocol in Unix networking. It will be
1446replaced by IP version 6 in the next couple of years, but for the moment it's
1447the de facto standard for the internet and is used in most networking
1448environments around the world. Because of the importance of this protocol,
1449we'll have a deeper look into the subtree controlling the behavior of the IPv4
1450subsystem of the Linux kernel.
1451
1452Let's start with the entries in /proc/sys/net/ipv4.
1453
1454ICMP settings
1455-------------
1456
1457icmp_echo_ignore_all and icmp_echo_ignore_broadcasts
1458----------------------------------------------------
1459
1460Turn on (1) or off (0), if the kernel should ignore all ICMP ECHO requests, or
1461just those to broadcast and multicast addresses.
1462
1463Please note that if you accept ICMP echo requests with a broadcast/multi\-cast
1464destination address your network may be used as an exploder for denial of
1465service packet flooding attacks to other hosts.
1466
1467icmp_destunreach_rate, icmp_echoreply_rate, icmp_paramprob_rate and icmp_timeexeed_rate
1468---------------------------------------------------------------------------------------
1469
1470Sets limits for sending ICMP packets to specific targets. A value of zero
1471disables all limiting. Any positive value sets the maximum package rate in
1472hundredth of a second (on Intel systems).
1473
1474IP settings
1475-----------
1476
1477ip_autoconfig
1478-------------
1479
1480This file contains the number one if the host received its IP configuration by
1481RARP, BOOTP, DHCP or a similar mechanism. Otherwise it is zero.
1482
1483ip_default_ttl
1484--------------
1485
1486TTL (Time To Live) for IPv4 interfaces. This is simply the maximum number of
1487hops a packet may travel.
1488
1489ip_dynaddr
1490----------
1491
1492Enable dynamic socket address rewriting on interface address change. This is
1493useful for dialup interface with changing IP addresses.
1494
1495ip_forward
1496----------
1497
1498Enable or disable forwarding of IP packages between interfaces. Changing this
1499value resets all other parameters to their default values. They differ if the
1500kernel is configured as host or router.
1501
1502ip_local_port_range
1503-------------------
1504
1505Range of ports used by TCP and UDP to choose the local port. Contains two
1506numbers, the first number is the lowest port, the second number the highest
1507local port. Default is 1024-4999. Should be changed to 32768-61000 for
1508high-usage systems.
1509
1510ip_no_pmtu_disc
1511---------------
1512
1513Global switch to turn path MTU discovery off. It can also be set on a per
1514socket basis by the applications or on a per route basis.
1515
1516ip_masq_debug
1517-------------
1518
1519Enable/disable debugging of IP masquerading.
1520
1521IP fragmentation settings
1522-------------------------
1523
1524ipfrag_high_trash and ipfrag_low_trash
1525--------------------------------------
1526
1527Maximum memory used to reassemble IP fragments. When ipfrag_high_thresh bytes
1528of memory is allocated for this purpose, the fragment handler will toss
1529packets until ipfrag_low_thresh is reached.
1530
1531ipfrag_time
1532-----------
1533
1534Time in seconds to keep an IP fragment in memory.
1535
1536TCP settings
1537------------
1538
1539tcp_ecn
1540-------
1541
Matt LaPlantefa00e7e2006-11-30 04:55:36 +01001542This file controls the use of the ECN bit in the IPv4 headers. This is a new
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543feature about Explicit Congestion Notification, but some routers and firewalls
Matt LaPlantefa00e7e2006-11-30 04:55:36 +01001544block traffic that has this bit set, so it could be necessary to echo 0 to
1545/proc/sys/net/ipv4/tcp_ecn if you want to talk to these sites. For more info
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546you could read RFC2481.
1547
1548tcp_retrans_collapse
1549--------------------
1550
1551Bug-to-bug compatibility with some broken printers. On retransmit, try to send
1552larger packets to work around bugs in certain TCP stacks. Can be turned off by
1553setting it to zero.
1554
1555tcp_keepalive_probes
1556--------------------
1557
1558Number of keep alive probes TCP sends out, until it decides that the
1559connection is broken.
1560
1561tcp_keepalive_time
1562------------------
1563
1564How often TCP sends out keep alive messages, when keep alive is enabled. The
1565default is 2 hours.
1566
1567tcp_syn_retries
1568---------------
1569
1570Number of times initial SYNs for a TCP connection attempt will be
1571retransmitted. Should not be higher than 255. This is only the timeout for
1572outgoing connections, for incoming connections the number of retransmits is
1573defined by tcp_retries1.
1574
1575tcp_sack
1576--------
1577
1578Enable select acknowledgments after RFC2018.
1579
1580tcp_timestamps
1581--------------
1582
1583Enable timestamps as defined in RFC1323.
1584
1585tcp_stdurg
1586----------
1587
1588Enable the strict RFC793 interpretation of the TCP urgent pointer field. The
1589default is to use the BSD compatible interpretation of the urgent pointer
1590pointing to the first byte after the urgent data. The RFC793 interpretation is
1591to have it point to the last byte of urgent data. Enabling this option may
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001592lead to interoperability problems. Disabled by default.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593
1594tcp_syncookies
1595--------------
1596
1597Only valid when the kernel was compiled with CONFIG_SYNCOOKIES. Send out
1598syncookies when the syn backlog queue of a socket overflows. This is to ward
1599off the common 'syn flood attack'. Disabled by default.
1600
1601Note that the concept of a socket backlog is abandoned. This means the peer
1602may not receive reliable error messages from an over loaded server with
1603syncookies enabled.
1604
1605tcp_window_scaling
1606------------------
1607
1608Enable window scaling as defined in RFC1323.
1609
1610tcp_fin_timeout
1611---------------
1612
1613The length of time in seconds it takes to receive a final FIN before the
1614socket is always closed. This is strictly a violation of the TCP
1615specification, but required to prevent denial-of-service attacks.
1616
1617tcp_max_ka_probes
1618-----------------
1619
1620Indicates how many keep alive probes are sent per slow timer run. Should not
1621be set too high to prevent bursts.
1622
1623tcp_max_syn_backlog
1624-------------------
1625
1626Length of the per socket backlog queue. Since Linux 2.2 the backlog specified
1627in listen(2) only specifies the length of the backlog queue of already
1628established sockets. When more connection requests arrive Linux starts to drop
1629packets. When syncookies are enabled the packets are still answered and the
1630maximum queue is effectively ignored.
1631
1632tcp_retries1
1633------------
1634
1635Defines how often an answer to a TCP connection request is retransmitted
1636before giving up.
1637
1638tcp_retries2
1639------------
1640
1641Defines how often a TCP packet is retransmitted before giving up.
1642
1643Interface specific settings
1644---------------------------
1645
1646In the directory /proc/sys/net/ipv4/conf you'll find one subdirectory for each
1647interface the system knows about and one directory calls all. Changes in the
1648all subdirectory affect all interfaces, whereas changes in the other
1649subdirectories affect only one interface. All directories have the same
1650entries:
1651
1652accept_redirects
1653----------------
1654
1655This switch decides if the kernel accepts ICMP redirect messages or not. The
1656default is 'yes' if the kernel is configured for a regular host and 'no' for a
1657router configuration.
1658
1659accept_source_route
1660-------------------
1661
1662Should source routed packages be accepted or declined. The default is
1663dependent on the kernel configuration. It's 'yes' for routers and 'no' for
1664hosts.
1665
1666bootp_relay
1667~~~~~~~~~~~
1668
1669Accept packets with source address 0.b.c.d with destinations not to this host
1670as local ones. It is supposed that a BOOTP relay daemon will catch and forward
1671such packets.
1672
1673The default is 0, since this feature is not implemented yet (kernel version
16742.2.12).
1675
1676forwarding
1677----------
1678
1679Enable or disable IP forwarding on this interface.
1680
1681log_martians
1682------------
1683
1684Log packets with source addresses with no known route to kernel log.
1685
1686mc_forwarding
1687-------------
1688
1689Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE and a
1690multicast routing daemon is required.
1691
1692proxy_arp
1693---------
1694
1695Does (1) or does not (0) perform proxy ARP.
1696
1697rp_filter
1698---------
1699
1700Integer value determines if a source validation should be made. 1 means yes, 0
1701means no. Disabled by default, but local/broadcast address spoofing is always
1702on.
1703
1704If you set this to 1 on a router that is the only connection for a network to
1705the net, it will prevent spoofing attacks against your internal networks
1706(external addresses can still be spoofed), without the need for additional
1707firewall rules.
1708
1709secure_redirects
1710----------------
1711
1712Accept ICMP redirect messages only for gateways, listed in default gateway
1713list. Enabled by default.
1714
1715shared_media
1716------------
1717
1718If it is not set the kernel does not assume that different subnets on this
1719device can communicate directly. Default setting is 'yes'.
1720
1721send_redirects
1722--------------
1723
1724Determines whether to send ICMP redirects to other hosts.
1725
1726Routing settings
1727----------------
1728
1729The directory /proc/sys/net/ipv4/route contains several file to control
1730routing issues.
1731
1732error_burst and error_cost
1733--------------------------
1734
1735These parameters are used to limit how many ICMP destination unreachable to
1736send from the host in question. ICMP destination unreachable messages are
Matt LaPlante84eb8d02006-10-03 22:53:09 +02001737sent when we cannot reach the next hop while trying to transmit a packet.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738It will also print some error messages to kernel logs if someone is ignoring
1739our ICMP redirects. The higher the error_cost factor is, the fewer
1740destination unreachable and error messages will be let through. Error_burst
1741controls when destination unreachable messages and error messages will be
1742dropped. The default settings limit warning messages to five every second.
1743
1744flush
1745-----
1746
1747Writing to this file results in a flush of the routing cache.
1748
1749gc_elasticity, gc_interval, gc_min_interval_ms, gc_timeout, gc_thresh
1750---------------------------------------------------------------------
1751
1752Values to control the frequency and behavior of the garbage collection
1753algorithm for the routing cache. gc_min_interval is deprecated and replaced
1754by gc_min_interval_ms.
1755
1756
1757max_size
1758--------
1759
1760Maximum size of the routing cache. Old entries will be purged once the cache
1761reached has this size.
1762
1763max_delay, min_delay
1764--------------------
1765
1766Delays for flushing the routing cache.
1767
1768redirect_load, redirect_number
1769------------------------------
1770
1771Factors which determine if more ICPM redirects should be sent to a specific
1772host. No redirects will be sent once the load limit or the maximum number of
1773redirects has been reached.
1774
1775redirect_silence
1776----------------
1777
1778Timeout for redirects. After this period redirects will be sent again, even if
1779this has been stopped, because the load or number limit has been reached.
1780
1781Network Neighbor handling
1782-------------------------
1783
1784Settings about how to handle connections with direct neighbors (nodes attached
1785to the same link) can be found in the directory /proc/sys/net/ipv4/neigh.
1786
1787As we saw it in the conf directory, there is a default subdirectory which
1788holds the default values, and one directory for each interface. The contents
1789of the directories are identical, with the single exception that the default
1790settings contain additional options to set garbage collection parameters.
1791
1792In the interface directories you'll find the following entries:
1793
1794base_reachable_time, base_reachable_time_ms
1795-------------------------------------------
1796
1797A base value used for computing the random reachable time value as specified
1798in RFC2461.
1799
1800Expression of base_reachable_time, which is deprecated, is in seconds.
1801Expression of base_reachable_time_ms is in milliseconds.
1802
1803retrans_time, retrans_time_ms
1804-----------------------------
1805
1806The time between retransmitted Neighbor Solicitation messages.
1807Used for address resolution and to determine if a neighbor is
1808unreachable.
1809
1810Expression of retrans_time, which is deprecated, is in 1/100 seconds (for
1811IPv4) or in jiffies (for IPv6).
1812Expression of retrans_time_ms is in milliseconds.
1813
1814unres_qlen
1815----------
1816
1817Maximum queue length for a pending arp request - the number of packets which
1818are accepted from other layers while the ARP address is still resolved.
1819
1820anycast_delay
1821-------------
1822
1823Maximum for random delay of answers to neighbor solicitation messages in
1824jiffies (1/100 sec). Not yet implemented (Linux does not have anycast support
1825yet).
1826
1827ucast_solicit
1828-------------
1829
1830Maximum number of retries for unicast solicitation.
1831
1832mcast_solicit
1833-------------
1834
1835Maximum number of retries for multicast solicitation.
1836
1837delay_first_probe_time
1838----------------------
1839
1840Delay for the first time probe if the neighbor is reachable. (see
1841gc_stale_time)
1842
1843locktime
1844--------
1845
1846An ARP/neighbor entry is only replaced with a new one if the old is at least
1847locktime old. This prevents ARP cache thrashing.
1848
1849proxy_delay
1850-----------
1851
1852Maximum time (real time is random [0..proxytime]) before answering to an ARP
1853request for which we have an proxy ARP entry. In some cases, this is used to
1854prevent network flooding.
1855
1856proxy_qlen
1857----------
1858
1859Maximum queue length of the delayed proxy arp timer. (see proxy_delay).
1860
Matt LaPlante53cb4722006-10-03 22:55:17 +02001861app_solicit
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862----------
1863
1864Determines the number of requests to send to the user level ARP daemon. Use 0
1865to turn off.
1866
1867gc_stale_time
1868-------------
1869
1870Determines how often to check for stale ARP entries. After an ARP entry is
1871stale it will be resolved again (which is useful when an IP address migrates
1872to another machine). When ucast_solicit is greater than 0 it first tries to
1873send an ARP packet directly to the known host When that fails and
1874mcast_solicit is greater than 0, an ARP request is broadcasted.
1875
18762.9 Appletalk
1877-------------
1878
1879The /proc/sys/net/appletalk directory holds the Appletalk configuration data
1880when Appletalk is loaded. The configurable parameters are:
1881
1882aarp-expiry-time
1883----------------
1884
1885The amount of time we keep an ARP entry before expiring it. Used to age out
1886old hosts.
1887
1888aarp-resolve-time
1889-----------------
1890
1891The amount of time we will spend trying to resolve an Appletalk address.
1892
1893aarp-retransmit-limit
1894---------------------
1895
1896The number of times we will retransmit a query before giving up.
1897
1898aarp-tick-time
1899--------------
1900
1901Controls the rate at which expires are checked.
1902
1903The directory /proc/net/appletalk holds the list of active Appletalk sockets
1904on a machine.
1905
1906The fields indicate the DDP type, the local address (in network:node format)
1907the remote address, the size of the transmit pending queue, the size of the
1908received queue (bytes waiting for applications to read) the state and the uid
1909owning the socket.
1910
1911/proc/net/atalk_iface lists all the interfaces configured for appletalk.It
1912shows the name of the interface, its Appletalk address, the network range on
1913that address (or network number for phase 1 networks), and the status of the
1914interface.
1915
1916/proc/net/atalk_route lists each known network route. It lists the target
1917(network) that the route leads to, the router (may be directly connected), the
1918route flags, and the device the route is using.
1919
19202.10 IPX
1921--------
1922
1923The IPX protocol has no tunable values in proc/sys/net.
1924
1925The IPX protocol does, however, provide proc/net/ipx. This lists each IPX
1926socket giving the local and remote addresses in Novell format (that is
1927network:node:port). In accordance with the strange Novell tradition,
1928everything but the port is in hex. Not_Connected is displayed for sockets that
1929are not tied to a specific remote address. The Tx and Rx queue sizes indicate
1930the number of bytes pending for transmission and reception. The state
1931indicates the state the socket is in and the uid is the owning uid of the
1932socket.
1933
1934The /proc/net/ipx_interface file lists all IPX interfaces. For each interface
1935it gives the network number, the node number, and indicates if the network is
1936the primary network. It also indicates which device it is bound to (or
1937Internal for internal networks) and the Frame Type if appropriate. Linux
1938supports 802.3, 802.2, 802.2 SNAP and DIX (Blue Book) ethernet framing for
1939IPX.
1940
1941The /proc/net/ipx_route table holds a list of IPX routes. For each route it
1942gives the destination network, the router node (or Directly) and the network
1943address of the router (or Connected) for internal networks.
1944
19452.11 /proc/sys/fs/mqueue - POSIX message queues filesystem
1946----------------------------------------------------------
1947
1948The "mqueue" filesystem provides the necessary kernel features to enable the
1949creation of a user space library that implements the POSIX message queues
1950API (as noted by the MSG tag in the POSIX 1003.1-2001 version of the System
1951Interfaces specification.)
1952
1953The "mqueue" filesystem contains values for determining/setting the amount of
1954resources used by the file system.
1955
1956/proc/sys/fs/mqueue/queues_max is a read/write file for setting/getting the
1957maximum number of message queues allowed on the system.
1958
1959/proc/sys/fs/mqueue/msg_max is a read/write file for setting/getting the
1960maximum number of messages in a queue value. In fact it is the limiting value
1961for another (user) limit which is set in mq_open invocation. This attribute of
1962a queue must be less or equal then msg_max.
1963
1964/proc/sys/fs/mqueue/msgsize_max is a read/write file for setting/getting the
1965maximum message size value (it is every message queue's attribute set during
1966its creation).
1967
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -070019682.12 /proc/<pid>/oom_adj - Adjust the oom-killer score
1969------------------------------------------------------
1970
1971This file can be used to adjust the score used to select which processes
1972should be killed in an out-of-memory situation. Giving it a high score will
1973increase the likelihood of this process being killed by the oom-killer. Valid
1974values are in the range -16 to +15, plus the special value -17, which disables
1975oom-killing altogether for this process.
1976
19772.13 /proc/<pid>/oom_score - Display current oom-killer score
1978-------------------------------------------------------------
1979
1980------------------------------------------------------------------------------
1981This file can be used to check the current score used by the oom-killer is for
1982any given <pid>. Use it together with /proc/<pid>/oom_adj to tune which
1983process should be killed in an out-of-memory situation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
1985------------------------------------------------------------------------------
1986Summary
1987------------------------------------------------------------------------------
1988Certain aspects of kernel behavior can be modified at runtime, without the
1989need to recompile the kernel, or even to reboot the system. The files in the
1990/proc/sys tree can not only be read, but also modified. You can use the echo
1991command to write value into these files, thereby changing the default settings
1992of the kernel.
1993------------------------------------------------------------------------------
Roland Kletzingf9c99462007-03-05 00:30:54 -08001994
19952.14 /proc/<pid>/io - Display the IO accounting fields
1996-------------------------------------------------------
1997
1998This file contains IO statistics for each running process
1999
2000Example
2001-------
2002
2003test:/tmp # dd if=/dev/zero of=/tmp/test.dat &
2004[1] 3828
2005
2006test:/tmp # cat /proc/3828/io
2007rchar: 323934931
2008wchar: 323929600
2009syscr: 632687
2010syscw: 632675
2011read_bytes: 0
2012write_bytes: 323932160
2013cancelled_write_bytes: 0
2014
2015
2016Description
2017-----------
2018
2019rchar
2020-----
2021
2022I/O counter: chars read
2023The number of bytes which this task has caused to be read from storage. This
2024is simply the sum of bytes which this process passed to read() and pread().
2025It includes things like tty IO and it is unaffected by whether or not actual
2026physical disk IO was required (the read might have been satisfied from
2027pagecache)
2028
2029
2030wchar
2031-----
2032
2033I/O counter: chars written
2034The number of bytes which this task has caused, or shall cause to be written
2035to disk. Similar caveats apply here as with rchar.
2036
2037
2038syscr
2039-----
2040
2041I/O counter: read syscalls
2042Attempt to count the number of read I/O operations, i.e. syscalls like read()
2043and pread().
2044
2045
2046syscw
2047-----
2048
2049I/O counter: write syscalls
2050Attempt to count the number of write I/O operations, i.e. syscalls like
2051write() and pwrite().
2052
2053
2054read_bytes
2055----------
2056
2057I/O counter: bytes read
2058Attempt to count the number of bytes which this process really did cause to
2059be fetched from the storage layer. Done at the submit_bio() level, so it is
2060accurate for block-backed filesystems. <please add status regarding NFS and
2061CIFS at a later time>
2062
2063
2064write_bytes
2065-----------
2066
2067I/O counter: bytes written
2068Attempt to count the number of bytes which this process caused to be sent to
2069the storage layer. This is done at page-dirtying time.
2070
2071
2072cancelled_write_bytes
2073---------------------
2074
2075The big inaccuracy here is truncate. If a process writes 1MB to a file and
2076then deletes the file, it will in fact perform no writeout. But it will have
2077been accounted as having caused 1MB of write.
2078In other words: The number of bytes which this process caused to not happen,
2079by truncating pagecache. A task can cause "negative" IO too. If this task
2080truncates some dirty pagecache, some IO which another task has been accounted
2081for (in it's write_bytes) will not be happening. We _could_ just subtract that
2082from the truncating task's write_bytes, but there is information loss in doing
2083that.
2084
2085
2086Note
2087----
2088
2089At its current implementation state, this is a bit racy on 32-bit machines: if
2090process A reads process B's /proc/pid/io while process B is updating one of
2091those 64-bit counters, process A could see an intermediate result.
2092
2093
2094More information about this can be found within the taskstats documentation in
2095Documentation/accounting.
2096
2097------------------------------------------------------------------------------