clean
[linux-2.4.21-pre4.git] / Documentation / filesystems / proc.txt
1 ------------------------------------------------------------------------------
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
7 2.4.x update      Jorge Nerin <comandante@zaralinux.com>      November 14 2000
8 ------------------------------------------------------------------------------
9 Version 1.3                                              Kernel version 2.2.12
10                                               Kernel version 2.4.0-test11-pre4
11 ------------------------------------------------------------------------------
12
13 Table 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
29   2     Modifying System Parameters
30   2.1   /proc/sys/fs - File system data
31   2.2   /proc/sys/fs/binfmt_misc - Miscellaneous binary formats
32   2.3   /proc/sys/kernel - general kernel parameters
33   2.4   /proc/sys/vm - The virtual memory subsystem
34   2.5   /proc/sys/dev - Device specific parameters
35   2.6   /proc/sys/sunrpc - Remote procedure calls
36   2.7   /proc/sys/net - Networking stuff
37   2.8   /proc/sys/net/ipv4 - IPV4 settings
38   2.9   Appletalk
39   2.10  IPX
40
41 ------------------------------------------------------------------------------
42 Preface
43 ------------------------------------------------------------------------------
44
45 0.1 Introduction/Credits
46 ------------------------
47
48 This documentation is  part of a soon (or  so we hope) to be  released book on
49 the SuSE  Linux distribution. As  there is  no complete documentation  for the
50 /proc file system and we've used  many freely available sources to write these
51 chapters, it  seems only fair  to give the work  back to the  Linux community.
52 This work is  based on the 2.2.*  kernel version and the  upcoming 2.4.*. I'm
53 afraid it's still far from complete, but we  hope it will be useful. As far as
54 we know, it is the first 'all-in-one' document about the /proc file system. It
55 is focused  on the Intel  x86 hardware,  so if you  are looking for  PPC, ARM,
56 SPARC, APX, etc., features, you probably  won't find what you are looking for.
57 It also only covers IPv4 networking, not IPv6 nor other protocols - sorry. But
58 additions and patches  are welcome and will  be added to this  document if you
59 mail them to Bodo.
60
61 We'd like  to  thank Alan Cox, Rik van Riel, and Alexey Kuznetsov and a lot of
62 other people for help compiling this documentation. We'd also like to extend a
63 special thank  you to Andi Kleen for documentation, which we relied on heavily
64 to create  this  document,  as well as the additional information he provided.
65 Thanks to  everybody  else  who contributed source or docs to the Linux kernel
66 and helped create a great piece of software... :)
67
68 If you  have  any comments, corrections or additions, please don't hesitate to
69 contact Bodo  Bauer  at  bb@ricochet.net.  We'll  be happy to add them to this
70 document.
71
72 The   latest   version    of   this   document   is    available   online   at
73 http://skaro.nightcrawler.com/~bb/Docs/Proc as HTML version.
74
75 If  the above  direction does  not works  for you,  ypu could  try the  kernel
76 mailing  list  at  linux-kernel@vger.kernel.org  and/or try  to  reach  me  at
77 comandante@zaralinux.com.
78
79 0.2 Legal Stuff
80 ---------------
81
82 We don't  guarantee  the  correctness  of this document, and if you come to us
83 complaining about  how  you  screwed  up  your  system  because  of  incorrect
84 documentation, we won't feel responsible...
85
86 ------------------------------------------------------------------------------
87 CHAPTER 1: COLLECTING SYSTEM INFORMATION
88 ------------------------------------------------------------------------------
89
90 ------------------------------------------------------------------------------
91 In This Chapter
92 ------------------------------------------------------------------------------
93 * Investigating  the  properties  of  the  pseudo  file  system  /proc and its
94   ability to provide information on the running Linux system
95 * Examining /proc's structure
96 * Uncovering  various  information  about the kernel and the processes running
97   on the system
98 ------------------------------------------------------------------------------
99
100
101 The proc  file  system acts as an interface to internal data structures in the
102 kernel. It  can  be  used to obtain information about the system and to change
103 certain kernel parameters at runtime (sysctl).
104
105 First, we'll  take  a  look  at the read-only parts of /proc. In Chapter 2, we
106 show you how you can use /proc/sys to change settings.
107
108 1.1 Process-Specific Subdirectories
109 -----------------------------------
110
111 The directory  /proc  contains  (among other things) one subdirectory for each
112 process running on the system, which is named after the process ID (PID).
113
114 The link  self  points  to  the  process reading the file system. Each process
115 subdirectory has the entries listed in Table 1-1.
116
117
118 Table 1-1: Process specific entries in /proc 
119 ..............................................................................
120  File    Content                                        
121  cmdline Command line arguments                         
122  cpu     Current and last cpu in wich it was executed           (2.4)(smp)
123  cwd     Link to the current working directory
124  environ Values of environment variables      
125  exe     Link to the executable of this process
126  fd      Directory, which contains all file descriptors 
127  maps    Memory maps to executables and library files           (2.4)
128  mem     Memory held by this process                    
129  root    Link to the root directory of this process
130  stat    Process status                                 
131  statm   Process memory status information              
132  status  Process status in human readable form          
133 ..............................................................................
134
135 For example, to get the status information of a process, all you have to do is
136 read the file /proc/PID/status:
137
138   >cat /proc/self/status 
139   Name:   cat 
140   State:  R (running) 
141   Pid:    5452 
142   PPid:   743 
143   TracerPid:      0                                             (2.4)
144   Uid:    501     501     501     501 
145   Gid:    100     100     100     100 
146   Groups: 100 14 16 
147   VmSize:     1112 kB 
148   VmLck:         0 kB 
149   VmRSS:       348 kB 
150   VmData:       24 kB 
151   VmStk:        12 kB 
152   VmExe:         8 kB 
153   VmLib:      1044 kB 
154   SigPnd: 0000000000000000 
155   SigBlk: 0000000000000000 
156   SigIgn: 0000000000000000 
157   SigCgt: 0000000000000000 
158   CapInh: 00000000fffffeff 
159   CapPrm: 0000000000000000 
160   CapEff: 0000000000000000 
161
162
163 This shows you nearly the same information you would get if you viewed it with
164 the ps  command.  In  fact,  ps  uses  the  proc  file  system  to  obtain its
165 information. The  statm  file  contains  more  detailed  information about the
166 process memory usage. Its seven fields are explained in Table 1-2.
167
168
169 Table 1-2: Contents of the statm files 
170 ..............................................................................
171  File     Content                         
172  size     total program size              
173  resident size of memory portions         
174  shared   number of pages that are shared 
175  trs      number of pages that are 'code' 
176  drs      number of pages of data/stack   
177  lrs      number of pages of library      
178  dt       number of dirty pages           
179 ..............................................................................
180
181 1.2 Kernel data
182 ---------------
183
184 Similar to  the  process entries, the kernel data files give information about
185 the running kernel. The files used to obtain this information are contained in
186 /proc and  are  listed  in Table 1-3. Not all of these will be present in your
187 system. It  depends  on the kernel configuration and the loaded modules, which
188 files are there, and which are missing.
189
190 Table 1-3: Kernel info in /proc 
191 ..............................................................................
192  File        Content                                           
193  apm         Advanced power management info                    
194  bus         Directory containing bus specific information     
195  cmdline     Kernel command line                               
196  cpuinfo     Info about the CPU                                
197  devices     Available devices (block and character)           
198  dma         Used DMS channels                                 
199  filesystems Supported filesystems                             
200  driver      Various drivers grouped here, currently rtc        (2.4)
201  execdomains Execdomains, related to security                   (2.4)
202  fb          Frame Buffer devices                               (2.4)
203  fs          File system parameters, currently nfs/exports      (2.4)
204  ide         Directory containing info about the IDE subsystem 
205  interrupts  Interrupt usage                                   
206  iomem       Memory map                                         (2.4)
207  ioports     I/O port usage                                    
208  irq         Masks for irq to cpu affinity                      (2.4)(smp?)
209  isapnp      ISA PnP (Plug&Play) Info                           (2.4)
210  kcore       Kernel core image (can be ELF or A.OUT(deprecated in 2.4))   
211  kmsg        Kernel messages                                   
212  ksyms       Kernel symbol table                               
213  loadavg     Load average of last 1, 5 & 15 minutes                
214  locks       Kernel locks                                      
215  meminfo     Memory info                                       
216  misc        Miscellaneous                                     
217  modules     List of loaded modules                            
218  mounts      Mounted filesystems                               
219  net         Networking info (see text)                        
220  partitions  Table of partitions known to the system           
221  pci         Depreciated info of PCI bus (new way -> /proc/bus/pci/, 
222              decoupled by lspci                                 (2.4)
223  rtc         Real time clock                                   
224  scsi        SCSI info (see text)                              
225  slabinfo    Slab pool info                                    
226  stat        Overall statistics                                
227  swaps       Swap space utilization                            
228  sys         See chapter 2                                     
229  sysvipc     Info of SysVIPC Resources (msg, sem, shm)          (2.4)
230  tty         Info of tty drivers
231  uptime      System uptime                                     
232  version     Kernel version                                    
233  video       bttv info of video resources                       (2.4)
234 ..............................................................................
235
236 You can,  for  example,  check  which interrupts are currently in use and what
237 they are used for by looking in the file /proc/interrupts:
238
239   > cat /proc/interrupts 
240              CPU0        
241     0:    8728810          XT-PIC  timer 
242     1:        895          XT-PIC  keyboard 
243     2:          0          XT-PIC  cascade 
244     3:     531695          XT-PIC  aha152x 
245     4:    2014133          XT-PIC  serial 
246     5:      44401          XT-PIC  pcnet_cs 
247     8:          2          XT-PIC  rtc 
248    11:          8          XT-PIC  i82365 
249    12:     182918          XT-PIC  PS/2 Mouse 
250    13:          1          XT-PIC  fpu 
251    14:    1232265          XT-PIC  ide0 
252    15:          7          XT-PIC  ide1 
253   NMI:          0 
254
255 In 2.4.* a couple of lines where added to this file LOC & ERR (this time is the
256 output of a SMP machine):
257
258   > cat /proc/interrupts 
259
260              CPU0       CPU1       
261     0:    1243498    1214548    IO-APIC-edge  timer
262     1:       8949       8958    IO-APIC-edge  keyboard
263     2:          0          0          XT-PIC  cascade
264     5:      11286      10161    IO-APIC-edge  soundblaster
265     8:          1          0    IO-APIC-edge  rtc
266     9:      27422      27407    IO-APIC-edge  3c503
267    12:     113645     113873    IO-APIC-edge  PS/2 Mouse
268    13:          0          0          XT-PIC  fpu
269    14:      22491      24012    IO-APIC-edge  ide0
270    15:       2183       2415    IO-APIC-edge  ide1
271    17:      30564      30414   IO-APIC-level  eth0
272    18:        177        164   IO-APIC-level  bttv
273   NMI:    2457961    2457959 
274   LOC:    2457882    2457881 
275   ERR:       2155
276
277 NMI is incremented in this case because every timer interrupt generates a NMI
278 (Non Maskable Interrupt) which is used by the NMI Watchdog to detect lookups.
279
280 LOC is the local interrupt counter of the internal APIC of every CPU.
281
282 ERR is incremented in the case of errors in the IO-APIC bus (the bus that
283 connects the CPUs in a SMP system. This means that an error has been detected,
284 the IO-APIC automatically retry the transmission, so it should not be a big
285 problem, but you should read the SMP-FAQ.
286
287 In this context it could be interesting to note the new irq directory in 2.4.
288 It could be used to set IRQ to CPU affinity, this means that you can "hook" an
289 IRQ to only one CPU, or to exclude a CPU of handling IRQs. The contents of the
290 irq subdir is one subdir for each IRQ, and one file; prof_cpu_mask
291
292 For example 
293   > ls /proc/irq/
294   0  10  12  14  16  18  2  4  6  8  prof_cpu_mask
295   1  11  13  15  17  19  3  5  7  9
296   > ls /proc/irq/0/
297   smp_affinity
298
299 The contents of the prof_cpu_mask file and each smp_affinity file for each IRQ
300 is the same by default:
301
302   > cat /proc/irq/0/smp_affinity 
303   ffffffff
304
305 It's a bitmask, in wich you can specify wich CPUs can handle the IRQ, you can
306 set it by doing:
307
308   > echo 1 > /proc/irq/prof_cpu_mask
309
310 This means that only the first CPU will handle the IRQ, but you can also echo 5
311 wich means that only the first and fourth CPU can handle the IRQ.
312
313 The way IRQs are routed is handled by the IO-APIC, and it's Round Robin
314 between all the CPUs which are allowed to handle it. As usual the kernel has
315 more info than you and does a better job than you, so the defaults are the
316 best choice for almost everyone.
317
318 There are  three  more  important subdirectories in /proc: net, scsi, and sys.
319 The general  rule  is  that  the  contents,  or  even  the  existence of these
320 directories, depend  on your kernel configuration. If SCSI is not enabled, the
321 directory scsi  may  not  exist. The same is true with the net, which is there
322 only when networking support is present in the running kernel.
323
324 The slabinfo  file  gives  information  about  memory usage at the slab level.
325 Linux uses  slab  pools for memory management above page level in version 2.2.
326 Commonly used  objects  have  their  own  slab  pool (such as network buffers,
327 directory cache, and so on).
328
329 1.3 IDE devices in /proc/ide
330 ----------------------------
331
332 The subdirectory /proc/ide contains information about all IDE devices of which
333 the kernel  is  aware.  There is one subdirectory for each IDE controller, the
334 file drivers  and a link for each IDE device, pointing to the device directory
335 in the controller specific subtree.
336
337 The file  drivers  contains general information about the drivers used for the
338 IDE devices:
339
340   > cat /proc/ide/drivers 
341   ide-cdrom version 4.53 
342   ide-disk version 1.08 
343
344
345 More detailed  information  can  be  found  in  the  controller  specific
346 subdirectories. These  are  named  ide0,  ide1  and  so  on.  Each  of  these
347 directories contains the files shown in table 1-4.
348
349
350 Table 1-4: IDE controller info in  /proc/ide/ide? 
351 ..............................................................................
352  File    Content                                 
353  channel IDE channel (0 or 1)                    
354  config  Configuration (only for PCI/IDE bridge) 
355  mate    Mate name                               
356  model   Type/Chipset of IDE controller          
357 ..............................................................................
358
359 Each device  connected  to  a  controller  has  a separate subdirectory in the
360 controllers directory.  The  files  listed in table 1-5 are contained in these
361 directories.
362
363
364 Table 1-5: IDE device information 
365 ..............................................................................
366  File             Content                                    
367  cache            The cache                                  
368  capacity         Capacity of the medium (in 512Byte blocks) 
369  driver           driver and version                         
370  geometry         physical and logical geometry              
371  identify         device identify block                      
372  media            media type                                 
373  model            device identifier                          
374  settings         device setup                               
375  smart_thresholds IDE disk management thresholds             
376  smart_values     IDE disk management values                 
377 ..............................................................................
378
379 The most  interesting  file is settings. This file contains a nice overview of
380 the drive parameters:
381
382   # cat /proc/ide/ide0/hda/settings 
383   name                    value           min             max             mode 
384   ----                    -----           ---             ---             ---- 
385   bios_cyl                526             0               65535           rw 
386   bios_head               255             0               255             rw 
387   bios_sect               63              0               63              rw 
388   breada_readahead        4               0               127             rw 
389   bswap                   0               0               1               r 
390   file_readahead          72              0               2097151         rw 
391   io_32bit                0               0               3               rw 
392   keepsettings            0               0               1               rw 
393   max_kb_per_request      122             1               127             rw 
394   multcount               0               0               8               rw 
395   nice1                   1               0               1               rw 
396   nowerr                  0               0               1               rw 
397   pio_mode                write-only      0               255             w 
398   slow                    0               0               1               rw 
399   unmaskirq               0               0               1               rw 
400   using_dma               0               0               1               rw 
401
402
403 1.4 Networking info in /proc/net
404 --------------------------------
405
406 The subdirectory  /proc/net  follows  the  usual  pattern. Table 1-6 shows the
407 additional values  you  get  for  IP  version 6 if you configure the kernel to
408 support this. Table 1-7 lists the files and their meaning.
409
410
411 Table 1-6: IPv6 info in /proc/net 
412 ..............................................................................
413  File       Content                                               
414  udp6       UDP sockets (IPv6)                                    
415  tcp6       TCP sockets (IPv6)                                    
416  raw6       Raw device statistics (IPv6)                          
417  igmp6      IP multicast addresses, which this host joined (IPv6) 
418  if_inet6   List of IPv6 interface addresses                      
419  ipv6_route Kernel routing table for IPv6                         
420  rt6_stats  Global IPv6 routing tables statistics                 
421  sockstat6  Socket statistics (IPv6)                              
422  snmp6      Snmp data (IPv6)                                      
423 ..............................................................................
424
425
426 Table 1-7: Network info in /proc/net 
427 ..............................................................................
428  File          Content                                                         
429  arp           Kernel  ARP table                                               
430  dev           network devices with statistics                                 
431  dev_mcast     the Layer2 multicast groups a device is listening too
432                (interface index, label, number of references, number of bound
433                addresses). 
434  dev_stat      network device status                                           
435  ip_fwchains   Firewall chain linkage                                          
436  ip_fwnames    Firewall chain names                                            
437  ip_masq       Directory containing the masquerading tables                    
438  ip_masquerade Major masquerading table                                        
439  netstat       Network statistics                                              
440  raw           raw device statistics                                           
441  route         Kernel routing table                                            
442  rpc           Directory containing rpc info                                   
443  rt_cache      Routing cache                                                   
444  snmp          SNMP data                                                       
445  sockstat      Socket statistics                                               
446  tcp           TCP  sockets                                                    
447  tr_rif        Token ring RIF routing table                                    
448  udp           UDP sockets                                                     
449  unix          UNIX domain sockets                                             
450  wireless      Wireless interface data (Wavelan etc)                           
451  igmp          IP multicast addresses, which this host joined                  
452  psched        Global packet scheduler parameters.                             
453  netlink       List of PF_NETLINK sockets                                      
454  ip_mr_vifs    List of multicast virtual interfaces                            
455  ip_mr_cache   List of multicast routing cache                                 
456 ..............................................................................
457
458 You can  use  this  information  to see which network devices are available in
459 your system and how much traffic was routed over those devices:
460
461   > cat /proc/net/dev 
462   Inter-|Receive                                                   |[... 
463    face |bytes    packets errs drop fifo frame compressed multicast|[... 
464       lo:  908188   5596     0    0    0     0          0         0 [...         
465     ppp0:15475140  20721   410    0    0   410          0         0 [...  
466     eth0:  614530   7085     0    0    0     0          0         1 [... 
467    
468   ...] Transmit 
469   ...] bytes    packets errs drop fifo colls carrier compressed 
470   ...]  908188     5596    0    0    0     0       0          0 
471   ...] 1375103    17405    0    0    0     0       0          0 
472   ...] 1703981     5535    0    0    0     3       0          0 
473
474 In addition, each Channel Bond interface has it's own directory.  For
475 example, the bond0 device will have a directory called /proc/net/bond0/.
476 It will contain information that is specific to that bond, such as the
477 current slaves of the bond, the link status of the slaves, and how
478 many times the slaves link has failed.
479
480 1.5 SCSI info
481 -------------
482
483 If you  have  a  SCSI  host adapter in your system, you'll find a subdirectory
484 named after  the driver for this adapter in /proc/scsi. You'll also see a list
485 of all recognized SCSI devices in /proc/scsi:
486
487   >cat /proc/scsi/scsi 
488   Attached devices: 
489   Host: scsi0 Channel: 00 Id: 00 Lun: 00 
490     Vendor: IBM      Model: DGHS09U          Rev: 03E0 
491     Type:   Direct-Access                    ANSI SCSI revision: 03 
492   Host: scsi0 Channel: 00 Id: 06 Lun: 00 
493     Vendor: PIONEER  Model: CD-ROM DR-U06S   Rev: 1.04 
494     Type:   CD-ROM                           ANSI SCSI revision: 02 
495
496
497 The directory  named  after  the driver has one file for each adapter found in
498 the system.  These  files  contain information about the controller, including
499 the used  IRQ  and  the  IO  address range. The amount of information shown is
500 dependent on  the adapter you use. The example shows the output for an Adaptec
501 AHA-2940 SCSI adapter:
502
503   > cat /proc/scsi/aic7xxx/0 
504    
505   Adaptec AIC7xxx driver version: 5.1.19/3.2.4 
506   Compile Options: 
507     TCQ Enabled By Default : Disabled 
508     AIC7XXX_PROC_STATS     : Disabled 
509     AIC7XXX_RESET_DELAY    : 5 
510   Adapter Configuration: 
511              SCSI Adapter: Adaptec AHA-294X Ultra SCSI host adapter 
512                              Ultra Wide Controller 
513       PCI MMAPed I/O Base: 0xeb001000 
514    Adapter SEEPROM Config: SEEPROM found and used. 
515         Adaptec SCSI BIOS: Enabled 
516                       IRQ: 10 
517                      SCBs: Active 0, Max Active 2, 
518                            Allocated 15, HW 16, Page 255 
519                Interrupts: 160328 
520         BIOS Control Word: 0x18b6 
521      Adapter Control Word: 0x005b 
522      Extended Translation: Enabled 
523   Disconnect Enable Flags: 0xffff 
524        Ultra Enable Flags: 0x0001 
525    Tag Queue Enable Flags: 0x0000 
526   Ordered Queue Tag Flags: 0x0000 
527   Default Tag Queue Depth: 8 
528       Tagged Queue By Device array for aic7xxx host instance 0: 
529         {255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255} 
530       Actual queue depth per device for aic7xxx host instance 0: 
531         {1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1} 
532   Statistics: 
533   (scsi0:0:0:0) 
534     Device using Wide/Sync transfers at 40.0 MByte/sec, offset 8 
535     Transinfo settings: current(12/8/1/0), goal(12/8/1/0), user(12/15/1/0) 
536     Total transfers 160151 (74577 reads and 85574 writes) 
537   (scsi0:0:6:0) 
538     Device using Narrow/Sync transfers at 5.0 MByte/sec, offset 15 
539     Transinfo settings: current(50/15/0/0), goal(50/15/0/0), user(50/15/0/0) 
540     Total transfers 0 (0 reads and 0 writes) 
541
542
543 1.6 Parallel port info in /proc/parport
544 ---------------------------------------
545
546 The directory  /proc/parport  contains information about the parallel ports of
547 your system.  It  has  one  subdirectory  for  each port, named after the port
548 number (0,1,2,...).
549
550 These directories contain the four files shown in Table 1-8.
551
552
553 Table 1-8: Files in /proc/parport 
554 ..............................................................................
555  File      Content                                                             
556  autoprobe Any IEEE-1284 device ID information that has been acquired.         
557  devices   list of the device drivers using that port. A + will appear by the
558            name of the device currently using the port (it might not appear
559            against any). 
560  hardware  Parallel port's base address, IRQ line and DMA channel.             
561  irq       IRQ that parport is using for that port. This is in a separate
562            file to allow you to alter it by writing a new value in (IRQ
563            number or none). 
564 ..............................................................................
565
566 1.7 TTY info in /proc/tty
567 -------------------------
568
569 Information about  the  available  and actually used tty's can be found in the
570 directory /proc/tty.You'll  find  entries  for drivers and line disciplines in
571 this directory, as shown in Table 1-9.
572
573
574 Table 1-9: Files in /proc/tty 
575 ..............................................................................
576  File          Content                                        
577  drivers       list of drivers and their usage                
578  ldiscs        registered line disciplines                    
579  driver/serial usage statistic and status of single tty lines 
580 ..............................................................................
581
582 To see  which  tty's  are  currently in use, you can simply look into the file
583 /proc/tty/drivers:
584
585   > cat /proc/tty/drivers 
586   pty_slave            /dev/pts      136   0-255 pty:slave 
587   pty_master           /dev/ptm      128   0-255 pty:master 
588   pty_slave            /dev/ttyp       3   0-255 pty:slave 
589   pty_master           /dev/pty        2   0-255 pty:master 
590   serial               /dev/cua        5   64-67 serial:callout 
591   serial               /dev/ttyS       4   64-67 serial 
592   /dev/tty0            /dev/tty0       4       0 system:vtmaster 
593   /dev/ptmx            /dev/ptmx       5       2 system 
594   /dev/console         /dev/console    5       1 system:console 
595   /dev/tty             /dev/tty        5       0 system:/dev/tty 
596   unknown              /dev/tty        4    1-63 console 
597
598
599 ------------------------------------------------------------------------------
600 Summary
601 ------------------------------------------------------------------------------
602 The /proc file system serves information about the running system. It not only
603 allows access to process data but also allows you to request the kernel status
604 by reading files in the hierarchy.
605
606 The directory  structure  of /proc reflects the types of information and makes
607 it easy, if not obvious, where to look for specific data.
608 ------------------------------------------------------------------------------
609
610 ------------------------------------------------------------------------------
611 CHAPTER 2: MODIFYING SYSTEM PARAMETERS
612 ------------------------------------------------------------------------------
613
614 ------------------------------------------------------------------------------
615 In This Chapter
616 ------------------------------------------------------------------------------
617 * Modifying kernel parameters by writing into files found in /proc/sys
618 * Exploring the files which modify certain parameters
619 * Review of the /proc/sys file tree
620 ------------------------------------------------------------------------------
621
622
623 A very  interesting part of /proc is the directory /proc/sys. This is not only
624 a source  of  information,  it also allows you to change parameters within the
625 kernel. Be  very  careful  when attempting this. You can optimize your system,
626 but you  can  also  cause  it  to  crash.  Never  alter kernel parameters on a
627 production system.  Set  up  a  development machine and test to make sure that
628 everything works  the  way  you want it to. You may have no alternative but to
629 reboot the machine once an error has been made.
630
631 To change  a  value,  simply  echo  the new value into the file. An example is
632 given below  in the section on the file system data. You need to be root to do
633 this. You  can  create  your  own  boot script to perform this every time your
634 system boots.
635
636 The files  in /proc/sys can be used to fine tune and monitor miscellaneous and
637 general things  in  the operation of the Linux kernel. Since some of the files
638 can inadvertently  disrupt  your  system,  it  is  advisable  to  read  both
639 documentation and  source  before actually making adjustments. In any case, be
640 very careful  when  writing  to  any  of these files. The entries in /proc may
641 change slightly between the 2.1.* and the 2.2 kernel, so if there is any doubt
642 review the kernel documentation in the directory /usr/src/linux/Documentation.
643 This chapter  is  heavily  based  on the documentation included in the pre 2.2
644 kernels, and became part of it in version 2.2.1 of the Linux kernel.
645
646 2.1 /proc/sys/fs - File system data
647 -----------------------------------
648
649 This subdirectory  contains  specific  file system, file handle, inode, dentry
650 and quota information.
651
652 Currently, these files are in /proc/sys/fs:
653
654 dentry-state
655 ------------
656
657 Status of  the  directory  cache.  Since  directory  entries  are  dynamically
658 allocated and  deallocated,  this  file indicates the current status. It holds
659 six values, in which the last two are not used and are always zero. The others
660 are listed in table 2-1.
661
662
663 Table 2-1: Status files of the directory cache 
664 ..............................................................................
665  File       Content                                                            
666  nr_dentry  Almost always zero                                                 
667  nr_unused  Number of unused cache entries                                     
668  age_limit  
669             in seconds after the entry may be reclaimed, when memory is short 
670  want_pages internally                                                         
671 ..............................................................................
672
673 dquot-nr and dquot-max
674 ----------------------
675
676 The file dquot-max shows the maximum number of cached disk quota entries.
677
678 The file  dquot-nr  shows  the  number of allocated disk quota entries and the
679 number of free disk quota entries.
680
681 If the number of available cached disk quotas is very low and you have a large
682 number of simultaneous system users, you might want to raise the limit.
683
684 file-nr and file-max
685 --------------------
686
687 The kernel  allocates file handles dynamically, but doesn't free them again at
688 this time.
689
690 The value  in  file-max  denotes  the  maximum number of file handles that the
691 Linux kernel will allocate. When you get a lot of error messages about running
692 out of  file handles, you might want to raise this limit. The default value is
693 4096. To change it, just write the new number into the file:
694
695   # cat /proc/sys/fs/file-max 
696   4096 
697   # echo 8192 > /proc/sys/fs/file-max 
698   # cat /proc/sys/fs/file-max 
699   8192 
700
701
702 This method  of  revision  is  useful  for  all customizable parameters of the
703 kernel - simply echo the new value to the corresponding file.
704
705 The three  values  in file-nr denote the number of allocated file handles, the
706 number of  used file handles, and the maximum number of file handles. When the
707 allocated file  handles  come close to the maximum, but the number of actually
708 used ones  is  far  behind,  you've  encountered  a peak in your usage of file
709 handles and you don't need to increase the maximum.
710
711 inode-state and inode-nr
712 ------------------------
713
714 The file inode-nr contains the first two items from inode-state, so we'll skip
715 to that file...
716
717 inode-state contains  two  actual numbers and five dummy values. The numbers
718 are nr_inodes and nr_free_inodes (in order of appearance).
719
720 nr_inodes
721 ~~~~~~~~~
722
723 Denotes the  number  of  inodes the system has allocated. This number will
724 grow and shrink dynamically.
725
726 nr_free_inodes
727 --------------
728
729 Represents the  number of free inodes. Ie. The number of inuse inodes is
730 (nr_inodes - nr_free_inodes).
731
732 super-nr and super-max
733 ----------------------
734
735 Again, super  block structures are allocated by the kernel, but not freed. The
736 file super-max  contains  the  maximum  number  of super block handlers, where
737 super-nr shows the number of currently allocated ones.
738
739 Every mounted file system needs a super block, so if you plan to mount lots of
740 file systems, you may want to increase these numbers.
741
742 2.2 /proc/sys/fs/binfmt_misc - Miscellaneous binary formats
743 -----------------------------------------------------------
744
745 Besides these  files, there is the subdirectory /proc/sys/fs/binfmt_misc. This
746 handles the kernel support for miscellaneous binary formats.
747
748 Binfmt_misc provides  the ability to register additional binary formats to the
749 Kernel without  compiling  an additional module/kernel. Therefore, binfmt_misc
750 needs to  know magic numbers at the beginning or the filename extension of the
751 binary.
752
753 It works by maintaining a linked list of structs that contain a description of
754 a binary  format,  including  a  magic  with size (or the filename extension),
755 offset and  mask,  and  the  interpreter name. On request it invokes the given
756 interpreter with  the  original  program  as  argument,  as  binfmt_java  and
757 binfmt_em86 and  binfmt_mz  do.  Since binfmt_misc does not define any default
758 binary-formats, you have to register an additional binary-format.
759
760 There are two general files in binfmt_misc and one file per registered format.
761 The two general files are register and status.
762
763 Registering a new binary format
764 -------------------------------
765
766 To register a new binary format you have to issue the command
767
768   echo :name:type:offset:magic:mask:interpreter: > /proc/sys/fs/binfmt_misc/register 
769
770
771
772 with appropriate  name (the name for the /proc-dir entry), offset (defaults to
773 0, if  omitted),  magic, mask (which can be omitted, defaults to all 0xff) and
774 last but  not  least,  the  interpreter that is to be invoked (for example and
775 testing /bin/echo).  Type  can be M for usual magic matching or E for filename
776 extension matching (give extension in place of magic).
777
778 Check or reset the status of the binary format handler
779 ------------------------------------------------------
780
781 If you  do a cat on the file /proc/sys/fs/binfmt_misc/status, you will get the
782 current status (enabled/disabled) of binfmt_misc. Change the status by echoing
783 0 (disables)  or  1  (enables)  or  -1  (caution:  this  clears all previously
784 registered binary  formats)  to status. For example echo 0 > status to disable
785 binfmt_misc (temporarily).
786
787 Status of a single handler
788 --------------------------
789
790 Each registered  handler has an entry in /proc/sys/fs/binfmt_misc. These files
791 perform the  same function as status, but their scope is limited to the actual
792 binary format.  By  cating this file, you also receive all related information
793 about the interpreter/magic of the binfmt.
794
795 Example usage of binfmt_misc (emulate binfmt_java)
796 --------------------------------------------------
797
798   cd /proc/sys/fs/binfmt_misc  
799   echo ':Java:M::\xca\xfe\xba\xbe::/usr/local/java/bin/javawrapper:' > register  
800   echo ':HTML:E::html::/usr/local/java/bin/appletviewer:' > register  
801   echo ':Applet:M::<!--applet::/usr/local/java/bin/appletviewer:' > register 
802   echo ':DEXE:M::\x0eDEX::/usr/bin/dosexec:' > register 
803
804
805 These four  lines  add  support  for  Java  executables and Java applets (like
806 binfmt_java, additionally  recognizing the .html extension with no need to put
807 <!--applet> to  every  applet  file).  You  have  to  install  the JDK and the
808 shell-script /usr/local/java/bin/javawrapper  too.  It  works  around  the
809 brokenness of  the Java filename handling. To add a Java binary, just create a
810 link to the class-file somewhere in the path.
811
812 2.3 /proc/sys/kernel - general kernel parameters
813 ------------------------------------------------
814
815 This directory  reflects  general  kernel  behaviors. As I've said before, the
816 contents depend  on  your  configuration.  Here you'll find the most important
817 files, along with descriptions of what they mean and how to use them.
818
819 acct
820 ----
821
822 The file contains three values; highwater, lowwater, and frequency.
823
824 It exists  only  when  BSD-style  process  accounting is enabled. These values
825 control its behavior. If the free space on the file system where the log lives
826 goes below  lowwater  percentage,  accounting  suspends.  If  it  goes  above
827 highwater percentage,  accounting  resumes. Frequency determines how often you
828 check the amount of free space (value is in seconds). Default settings are: 4,
829 2, and  30.  That is, suspend accounting if there is less than 2 percent free;
830 resume it  if we have a value of 3 or more percent; consider information about
831 the amount of free space valid for 30 seconds
832
833 ctrl-alt-del
834 ------------
835
836 When the value in this file is 0, ctrl-alt-del is trapped and sent to the init
837 program to  handle a graceful restart. However, when the value is greater that
838 zero, Linux's  reaction  to  this key combination will be an immediate reboot,
839 without syncing its dirty buffers.
840
841 [NOTE]
842     When a  program  (like  dosemu)  has  the  keyboard  in  raw  mode,  the
843     ctrl-alt-del is  intercepted  by  the  program  before it ever reaches the
844     kernel tty  layer,  and  it is up to the program to decide what to do with
845     it.
846
847 domainname and hostname
848 -----------------------
849
850 These files  can  be controlled to set the NIS domainname and hostname of your
851 box. For the classic darkstar.frop.org a simple:
852
853   # echo "darkstar" > /proc/sys/kernel/hostname 
854   # echo "frop.org" > /proc/sys/kernel/domainname 
855
856
857 would suffice to set your hostname and NIS domainname.
858
859 osrelease, ostype and version
860 -----------------------------
861
862 The names make it pretty obvious what these fields contain:
863
864   > cat /proc/sys/kernel/osrelease 
865   2.2.12 
866    
867   > cat /proc/sys/kernel/ostype 
868   Linux 
869    
870   > cat /proc/sys/kernel/version 
871   #4 Fri Oct 1 12:41:14 PDT 1999 
872
873
874 The files  osrelease and ostype should be clear enough. Version needs a little
875 more clarification.  The  #4 means that this is the 4th kernel built from this
876 source base and the date after it indicates the time the kernel was built. The
877 only way to tune these values is to rebuild the kernel.
878
879 panic
880 -----
881
882 The value  in  this  file  represents  the  number of seconds the kernel waits
883 before rebooting  on  a  panic.  When  you  use  the  software  watchdog,  the
884 recommended setting  is  60. If set to 0, the auto reboot after a kernel panic
885 is disabled, which is the default setting.
886
887 printk
888 ------
889
890 The four values in printk denote
891 * console_loglevel,
892 * default_message_loglevel,
893 * minimum_console_level and
894 * default_console_loglevel
895 respectively.
896
897 These values  influence  printk()  behavior  when  printing  or  logging error
898 messages, which  come  from  inside  the  kernel.  See  syslog(2)  for  more
899 information on the different log levels.
900
901 console_loglevel
902 ----------------
903
904 Messages with a higher priority than this will be printed to the console.
905
906 default_message_level
907 ---------------------
908
909 Messages without an explicit priority will be printed with this priority.
910
911 minimum_console_loglevel
912 ------------------------
913
914 Minimum (highest) value to which the console_loglevel can be set.
915
916 default_console_loglevel
917 ------------------------
918
919 Default value for console_loglevel.
920
921 sg-big-buff
922 -----------
923
924 This file  shows  the size of the generic SCSI (sg) buffer. At this point, you
925 can't tune  it  yet,  but  you  can  change  it  at  compile  time  by editing
926 include/scsi/sg.h and changing the value of SG_BIG_BUFF.
927
928 If you use a scanner with SANE (Scanner Access Now Easy) you might want to set
929 this to a higher value. Refer to the SANE documentation on this issue.
930
931 modprobe
932 --------
933
934 The location  where  the  modprobe  binary  is  located.  The kernel uses this
935 program to load modules on demand.
936
937 2.4 /proc/sys/vm - The virtual memory subsystem
938 -----------------------------------------------
939
940 The files  in  this directory can be used to tune the operation of the virtual
941 memory (VM)  subsystem  of  the  Linux  kernel.  In addition, one of the files
942 (bdflush) has some influence on disk usage.
943
944 bdflush
945 -------
946
947 This file  controls  the  operation of the bdflush kernel daemon. It currently
948 contains nine  integer  values,  six of which are actually used by the kernel.
949 They are listed in table 2-2.
950
951
952 Table 2-2: Parameters in /proc/sys/vm/bdflush 
953 ..............................................................................
954  Value      Meaning                                                            
955  nfract     Percentage of buffer cache dirty to activate bdflush              
956  ndirty     Maximum number of dirty blocks to  write out per wake-cycle        
957  dummy      Unused                                                             
958  dummy      Unused                                                             
959  interval   jiffies delay between kupdate flushes
960  age_buffer Time for normal buffer to age before we flush it                   
961  nfract_sync Percentage of buffer cache dirty to activate bdflush synchronously
962  nfract_stop_bdflush Percetange of buffer cache dirty to stop bdflush
963  dummy      Unused                                                             
964 ..............................................................................
965
966 nfract
967 ------
968
969 This parameter  governs  the  maximum  number  of  dirty buffers in the buffer
970 cache. Dirty means that the contents of the buffer still have to be written to
971 disk (as  opposed  to  a  clean  buffer,  which  can just be forgotten about).
972 Setting this  to  a  higher value means that Linux can delay disk writes for a
973 long time, but it also means that it will have to do a lot of I/O at once when
974 memory becomes short. A lower value will spread out disk I/O more evenly.
975
976 interval
977 --------
978
979 The interval between two kupdate runs. The value is expressed in
980 jiffies (clockticks),  the  number of jiffies per second is 100.
981
982 ndirty
983 ------
984
985 Ndirty gives the maximum number of dirty buffers that bdflush can write to the
986 disk at  one  time.  A high value will mean delayed, bursty I/O, while a small
987 value can lead to memory shortage when bdflush isn't woken up often enough.
988
989 age_buffer
990 ----------
991
992 Finally, the age_buffer parameter govern the maximum time Linux
993 waits before  writing  out  a  dirty buffer to disk. The value is expressed in
994 jiffies (clockticks),  the  number of jiffies per second is 100.
995
996 nfract_sync
997 -----------
998
999 nfract_stop_bdflush
1000 -------------------
1001
1002 buffermem
1003 ---------
1004
1005 The three  values  in  this  file  control  how much memory should be used for
1006 buffer memory.  The  percentage  is calculated as a percentage of total system
1007 memory.
1008
1009 The values are:
1010
1011 min_percent
1012 -----------
1013
1014 This is  the  minimum  percentage  of  memory  that  should be spent on buffer
1015 memory.
1016
1017 borrow_percent
1018 --------------
1019
1020 When Linux is short on memory, and the buffer cache uses more than it has been
1021 allotted, the  memory  management  (MM)  subsystem will prune the buffer cache
1022 more heavily than other memory to compensate.
1023
1024 max_percent
1025 -----------
1026
1027 This is the maximum amount of memory that can be used for buffer memory.
1028
1029 freepages
1030 ---------
1031
1032 This file contains three values: min, low and high:
1033
1034 min
1035 ---
1036 When the  number  of  free  pages  in the system reaches this number, only the
1037 kernel can allocate more memory.
1038
1039 low
1040 ---
1041 If the number of free pages falls below this point, the kernel starts swapping
1042 aggressively.
1043
1044 high
1045 ----
1046 The kernel  tries  to  keep  up to this amount of memory free; if memory falls
1047 below this point, the kernel starts gently swapping in the hopes that it never
1048 has to do really aggressive swapping.
1049
1050 kswapd
1051 ------
1052
1053 Kswapd is  the  kernel  swap  out daemon. That is, kswapd is that piece of the
1054 kernel that  frees  memory when it gets fragmented or full. Since every system
1055 is different, you'll probably want some control over this piece of the system.
1056
1057 The file contains three numbers:
1058
1059 tries_base
1060 ----------
1061
1062 The maximum  number  of  pages kswapd tries to free in one round is calculated
1063 from this  number.  Usually  this  number  will  be  divided  by  4  or 8 (see
1064 mm/vmscan.c), so it isn't as big as it looks.
1065
1066 When you  need to increase the bandwidth to/from swap, you'll want to increase
1067 this number.
1068
1069 tries_min
1070 ---------
1071
1072 This is  the  minimum number of times kswapd tries to free a page each time it
1073 is called. Basically it's just there to make sure that kswapd frees some pages
1074 even when it's being called with minimum priority.
1075
1076 swap_cluster
1077 ------------
1078
1079 This is probably the greatest influence on system performance.
1080
1081 swap_cluster is  the  number  of  pages kswapd writes in one turn. You'll want
1082 this value  to  be  large  so that kswapd does its I/O in large chunks and the
1083 disk doesn't  have  to  seek  as  often, but you don't want it to be too large
1084 since that would flood the request queue.
1085
1086 overcommit_memory
1087 -----------------
1088
1089 This file  contains  one  value.  The following algorithm is used to decide if
1090 there's enough  memory:  if  the  value of overcommit_memory is positive, then
1091 there's always  enough  memory. This is a useful feature, since programs often
1092 malloc() huge  amounts  of  memory 'just in case', while they only use a small
1093 part of  it.  Leaving  this value at 0 will lead to the failure of such a huge
1094 malloc(), when in fact the system has enough memory for the program to run.
1095
1096 On the  other  hand,  enabling this feature can cause you to run out of memory
1097 and thrash the system to death, so large and/or important servers will want to
1098 set this value to 0.
1099
1100 pagecache
1101 ---------
1102
1103 This file  does exactly the same job as buffermem, only this file controls the
1104 amount of memory allowed for memory mapping and generic caching of files.
1105
1106 You don't  want  the  minimum level to be too low, otherwise your system might
1107 thrash when memory is tight or fragmentation is high.
1108
1109 pagetable_cache
1110 ---------------
1111
1112 The kernel  keeps a number of page tables in a per-processor cache (this helps
1113 a lot  on  SMP systems). The cache size for each processor will be between the
1114 low and the high value.
1115
1116 On a  low-memory,  single  CPU system, you can safely set these values to 0 so
1117 you don't  waste  memory.  It  is  used  on SMP systems so that the system can
1118 perform fast  pagetable allocations without having to acquire the kernel memory
1119 lock.
1120
1121 For large  systems,  the  settings  are probably fine. For normal systems they
1122 won't hurt  a  bit.  For  small  systems  (  less  than  16MB ram) it might be
1123 advantageous to set both values to 0.
1124
1125 swapctl
1126 -------
1127
1128 This file  contains  no less than 8 variables. All of these values are used by
1129 kswapd.
1130
1131 The first four variables
1132 * sc_max_page_age,
1133 * sc_page_advance,
1134 * sc_page_decline and
1135 * sc_page_initial_age
1136 are used  to  keep  track  of  Linux's page aging. Page aging is a bookkeeping
1137 method to  track  which pages of memory are often used, and which pages can be
1138 swapped out without consequences.
1139
1140 When a  page  is  swapped in, it starts at sc_page_initial_age (default 3) and
1141 when the  page  is  scanned  by  kswapd,  its age is adjusted according to the
1142 following scheme:
1143
1144 * If  the  page  was used since the last time we scanned, its age is increased
1145   by sc_page_advance  (default  3).  Where  the  maximum  value  is  given  by
1146   sc_max_page_age (default 20).
1147 * Otherwise  (meaning  it wasn't used) its age is decreased by sc_page_decline
1148   (default 1).
1149
1150 When a page reaches age 0, it's ready to be swapped out.
1151
1152 The variables  sc_age_cluster_fract, sc_age_cluster_min, sc_pageout_weight and
1153 sc_bufferout_weight, can  be  used  to  control  kswapd's  aggressiveness  in
1154 swapping out pages.
1155
1156 Sc_age_cluster_fract is used to calculate how many pages from a process are to
1157 be scanned by kswapd. The formula used is
1158
1159 (sc_age_cluster_fract divided by 1024) times resident set size
1160
1161 So if you want kswapd to scan the whole process, sc_age_cluster_fract needs to
1162 have a  value  of  1024.  The  minimum  number  of  pages  kswapd will scan is
1163 represented by sc_age_cluster_min, which is done so that kswapd will also scan
1164 small processes.
1165
1166 The values  of  sc_pageout_weight  and sc_bufferout_weight are used to control
1167 how many  tries  kswapd  will make in order to swap out one page/buffer. These
1168 values can  be used to fine-tune the ratio between user pages and buffer/cache
1169 memory. When  you find that your Linux system is swapping out too many process
1170 pages in  order  to  satisfy  buffer  memory  demands,  you may want to either
1171 increase sc_bufferout_weight, or decrease the value of sc_pageout_weight.
1172
1173 2.5 /proc/sys/dev - Device specific parameters
1174 ----------------------------------------------
1175
1176 Currently there is only support for CDROM drives, and for those, there is only
1177 one read-only  file containing information about the CD-ROM drives attached to
1178 the system:
1179
1180   >cat /proc/sys/dev/cdrom/info 
1181   CD-ROM information, Id: cdrom.c 2.55 1999/04/25 
1182    
1183   drive name:             sr0     hdb 
1184   drive speed:            32      40 
1185   drive # of slots:       1       0 
1186   Can close tray:         1       1 
1187   Can open tray:          1       1 
1188   Can lock tray:          1       1 
1189   Can change speed:       1       1 
1190   Can select disk:        0       1 
1191   Can read multisession:  1       1 
1192   Can read MCN:           1       1 
1193   Reports media changed:  1       1 
1194   Can play audio:         1       1 
1195
1196
1197 You see two drives, sr0 and hdb, along with a list of their features.
1198
1199 2.6 /proc/sys/sunrpc - Remote procedure calls
1200 ---------------------------------------------
1201
1202 This directory  contains four files, which enable or disable debugging for the
1203 RPC functions NFS, NFS-daemon, RPC and NLM. The default values are 0. They can
1204 be set to one to turn debugging on. (The default value is 0 for each)
1205
1206 2.7 /proc/sys/net - Networking stuff
1207 ------------------------------------
1208
1209 The interface  to  the  networking  parts  of  the  kernel  is  located  in
1210 /proc/sys/net. Table  2-3  shows all possible subdirectories. You may see only
1211 some of them, depending on your kernel's configuration.
1212
1213
1214 Table 2-3: Subdirectories in /proc/sys/net 
1215 ..............................................................................
1216  Directory Content             Directory  Content            
1217  core      General parameter   appletalk  Appletalk protocol 
1218  unix      Unix domain sockets netrom     NET/ROM            
1219  802       E802 protocol       ax25       AX25               
1220  ethernet  Ethernet protocol   rose       X.25 PLP layer     
1221  ipv4      IP version 4        x25        X.25 protocol      
1222  ipx       IPX                 token-ring IBM token ring     
1223  bridge    Bridging            decnet     DEC net            
1224  ipv6      IP version 6                   
1225 ..............................................................................
1226
1227 We will  concentrate  on IP networking here. Since AX15, X.25, and DEC Net are
1228 only minor players in the Linux world, we'll skip them in this chapter. You'll
1229 find some  short  info on Appletalk and IPX further on in this chapter. Review
1230 the online  documentation  and the kernel source to get a detailed view of the
1231 parameters for  those  protocols.  In  this  section  we'll  discuss  the
1232 subdirectories printed  in  bold letters in the table above. As default values
1233 are suitable for most needs, there is no need to change these values.
1234
1235 /proc/sys/net/core - Network core options
1236 -----------------------------------------
1237
1238 rmem_default
1239 ------------
1240
1241 The default setting of the socket receive buffer in bytes.
1242
1243 rmem_max
1244 --------
1245
1246 The maximum receive socket buffer size in bytes.
1247
1248 wmem_default
1249 ------------
1250
1251 The default setting (in bytes) of the socket send buffer.
1252
1253 wmem_max
1254 --------
1255
1256 The maximum send socket buffer size in bytes.
1257
1258 message_burst and message_cost
1259 ------------------------------
1260
1261 These parameters  are used to limit the warning messages written to the kernel
1262 log from  the  networking  code.  They  enforce  a  rate  limit  to  make  a
1263 denial-of-service attack  impossible. A higher message_cost factor, results in
1264 fewer messages that will be written. Message_burst controls when messages will
1265 be dropped.  The  default  settings  limit  warning messages to one every five
1266 seconds.
1267
1268 netdev_max_backlog
1269 ------------------
1270
1271 Maximum number  of  packets,  queued  on  the  INPUT  side, when the interface
1272 receives packets faster than kernel can process them.
1273
1274 optmem_max
1275 ----------
1276
1277 Maximum ancillary buffer size allowed per socket. Ancillary data is a sequence
1278 of struct cmsghdr structures with appended data.
1279
1280 /proc/sys/net/unix - Parameters for Unix domain sockets
1281 -------------------------------------------------------
1282
1283 There are  only  two  files  in this subdirectory. They control the delays for
1284 deleting and destroying socket descriptors.
1285
1286 2.8 /proc/sys/net/ipv4 - IPV4 settings
1287 --------------------------------------
1288
1289 IP version  4  is  still the most used protocol in Unix networking. It will be
1290 replaced by  IP version 6 in the next couple of years, but for the moment it's
1291 the de  facto  standard  for  the  internet  and  is  used  in most networking
1292 environments around  the  world.  Because  of the importance of this protocol,
1293 we'll have a deeper look into the subtree controlling the behavior of the IPv4
1294 subsystem of the Linux kernel.
1295
1296 Let's start with the entries in /proc/sys/net/ipv4.
1297
1298 ICMP settings
1299 -------------
1300
1301 icmp_echo_ignore_all and icmp_echo_ignore_broadcasts
1302 ----------------------------------------------------
1303
1304 Turn on (1) or off (0), if the kernel should ignore all ICMP ECHO requests, or
1305 just those to broadcast and multicast addresses.
1306
1307 Please note that if you accept ICMP echo requests with a broadcast/multi\-cast
1308 destination address  your  network  may  be  used as an exploder for denial of
1309 service packet flooding attacks to other hosts.
1310
1311 icmp_destunreach_rate, icmp_echoreply_rate, icmp_paramprob_rate and icmp_timeexeed_rate
1312 ---------------------------------------------------------------------------------------
1313
1314 Sets limits  for  sending  ICMP  packets  to specific targets. A value of zero
1315 disables all  limiting.  Any  positive  value sets the maximum package rate in
1316 hundredth of a second (on Intel systems).
1317
1318 IP settings
1319 -----------
1320
1321 ip_autoconfig
1322 -------------
1323
1324 This file contains the number one if the host received its IP configuration by
1325 RARP, BOOTP, DHCP or a similar mechanism. Otherwise it is zero.
1326
1327 ip_default_ttl
1328 --------------
1329
1330 TTL (Time  To  Live) for IPv4 interfaces. This is simply the maximum number of
1331 hops a packet may travel.
1332
1333 ip_dynaddr
1334 ----------
1335
1336 Enable dynamic  socket  address rewriting on interface address change. This is
1337 useful for dialup interface with changing IP addresses.
1338
1339 ip_forward
1340 ----------
1341
1342 Enable or  disable forwarding of IP packages between interfaces. Changing this
1343 value resets  all other parameters to their default values. They differ if the
1344 kernel is configured as host or router.
1345
1346 ip_local_port_range
1347 -------------------
1348
1349 Range of  ports  used  by  TCP  and UDP to choose the local port. Contains two
1350 numbers, the  first  number  is the lowest port, the second number the highest
1351 local port.  Default  is  1024-4999.  Should  be  changed  to  32768-61000 for
1352 high-usage systems.
1353
1354 ip_no_pmtu_disc
1355 ---------------
1356
1357 Global switch  to  turn  path  MTU  discovery off. It can also be set on a per
1358 socket basis by the applications or on a per route basis.
1359
1360 ip_masq_debug
1361 -------------
1362
1363 Enable/disable debugging of IP masquerading.
1364
1365 IP fragmentation settings
1366 -------------------------
1367
1368 ipfrag_high_trash and ipfrag_low_trash
1369 --------------------------------------
1370
1371 Maximum memory  used to reassemble IP fragments. When ipfrag_high_thresh bytes
1372 of memory  is  allocated  for  this  purpose,  the  fragment handler will toss
1373 packets until ipfrag_low_thresh is reached.
1374
1375 ipfrag_time
1376 -----------
1377
1378 Time in seconds to keep an IP fragment in memory.
1379
1380 TCP settings
1381 ------------
1382
1383 tcp_ecn
1384 -------
1385
1386 This file controls the use of the ECN bit in the IPv4 headers, this is a new
1387 feature about Explicit Congestion Notification, but some routers and firewalls
1388 block trafic that has this bit set, so it could be necessary to echo 0 to
1389 /proc/sys/net/ipv4/tcp_ecn, if you want to talk to this sites. For more info
1390 you could read RFC2481.
1391
1392 tcp_retrans_collapse
1393 --------------------
1394
1395 Bug-to-bug compatibility with some broken printers. On retransmit, try to send
1396 larger packets to work around bugs in certain TCP stacks. Can be turned off by
1397 setting it to zero.
1398
1399 tcp_keepalive_probes
1400 --------------------
1401
1402 Number of  keep  alive  probes  TCP  sends  out,  until  it  decides  that the
1403 connection is broken.
1404
1405 tcp_keepalive_time
1406 ------------------
1407
1408 How often  TCP  sends out keep alive messages, when keep alive is enabled. The
1409 default is 2 hours.
1410
1411 tcp_syn_retries
1412 ---------------
1413
1414 Number of  times  initial  SYNs  for  a  TCP  connection  attempt  will  be
1415 retransmitted. Should  not  be  higher  than 255. This is only the timeout for
1416 outgoing connections,  for  incoming  connections the number of retransmits is
1417 defined by tcp_retries1.
1418
1419 tcp_sack
1420 --------
1421
1422 Enable select acknowledgments after RFC2018.
1423
1424 tcp_timestamps
1425 --------------
1426
1427 Enable timestamps as defined in RFC1323.
1428
1429 tcp_stdurg
1430 ----------
1431
1432 Enable the  strict  RFC793 interpretation of the TCP urgent pointer field. The
1433 default is  to  use  the  BSD  compatible interpretation of the urgent pointer
1434 pointing to the first byte after the urgent data. The RFC793 interpretation is
1435 to have  it  point  to  the last byte of urgent data. Enabling this option may
1436 lead to interoperatibility problems. Disabled by default.
1437
1438 tcp_syncookies
1439 --------------
1440
1441 Only valid  when  the  kernel  was  compiled  with CONFIG_SYNCOOKIES. Send out
1442 syncookies when  the  syn backlog queue of a socket overflows. This is to ward
1443 off the common 'syn flood attack'. Disabled by default.
1444
1445 Note that  the  concept  of a socket backlog is abandoned. This means the peer
1446 may not  receive  reliable  error  messages  from  an  over loaded server with
1447 syncookies enabled.
1448
1449 tcp_window_scaling
1450 ------------------
1451
1452 Enable window scaling as defined in RFC1323.
1453
1454 tcp_fin_timeout
1455 ---------------
1456
1457 The length  of  time  in  seconds  it  takes to receive a final FIN before the
1458 socket is  always  closed.  This  is  strictly  a  violation  of  the  TCP
1459 specification, but required to prevent denial-of-service attacks.
1460
1461 tcp_max_ka_probes
1462 -----------------
1463
1464 Indicates how  many  keep alive probes are sent per slow timer run. Should not
1465 be set too high to prevent bursts.
1466
1467 tcp_max_syn_backlog
1468 -------------------
1469
1470 Length of  the per socket backlog queue. Since Linux 2.2 the backlog specified
1471 in listen(2)  only  specifies  the  length  of  the  backlog  queue of already
1472 established sockets. When more connection requests arrive Linux starts to drop
1473 packets. When  syncookies  are  enabled the packets are still answered and the
1474 maximum queue is effectively ignored.
1475
1476 tcp_retries1
1477 ------------
1478
1479 Defines how  often  an  answer  to  a  TCP connection request is retransmitted
1480 before giving up.
1481
1482 tcp_retries2
1483 ------------
1484
1485 Defines how often a TCP packet is retransmitted before giving up.
1486
1487 Interface specific settings
1488 ---------------------------
1489
1490 In the directory /proc/sys/net/ipv4/conf you'll find one subdirectory for each
1491 interface the  system  knows about and one directory calls all. Changes in the
1492 all subdirectory  affect  all  interfaces,  whereas  changes  in  the  other
1493 subdirectories affect  only  one  interface.  All  directories  have  the same
1494 entries:
1495
1496 accept_redirects
1497 ----------------
1498
1499 This switch  decides  if the kernel accepts ICMP redirect messages or not. The
1500 default is 'yes' if the kernel is configured for a regular host and 'no' for a
1501 router configuration.
1502
1503 accept_source_route
1504 -------------------
1505
1506 Should source  routed  packages  be  accepted  or  declined.  The  default  is
1507 dependent on  the  kernel  configuration.  It's 'yes' for routers and 'no' for
1508 hosts.
1509
1510 bootp_relay
1511 ~~~~~~~~~~~
1512
1513 Accept packets  with source address 0.b.c.d with destinations not to this host
1514 as local ones. It is supposed that a BOOTP relay daemon will catch and forward
1515 such packets.
1516
1517 The default  is  0,  since this feature is not implemented yet (kernel version
1518 2.2.12).
1519
1520 forwarding
1521 ----------
1522
1523 Enable or disable IP forwarding on this interface.
1524
1525 log_martians
1526 ------------
1527
1528 Log packets with source addresses with no known route to kernel log.
1529
1530 mc_forwarding
1531 -------------
1532
1533 Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE and a
1534 multicast routing daemon is required.
1535
1536 proxy_arp
1537 ---------
1538
1539 Does (1) or does not (0) perform proxy ARP.
1540
1541 rp_filter
1542 ---------
1543
1544 Integer value determines if a source validation should be made. 1 means yes, 0
1545 means no.  Disabled by default, but local/broadcast address spoofing is always
1546 on.
1547
1548 If you  set this to 1 on a router that is the only connection for a network to
1549 the net,  it  will  prevent  spoofing  attacks  against your internal networks
1550 (external addresses  can  still  be  spoofed), without the need for additional
1551 firewall rules.
1552
1553 secure_redirects
1554 ----------------
1555
1556 Accept ICMP  redirect  messages  only  for gateways, listed in default gateway
1557 list. Enabled by default.
1558
1559 shared_media
1560 ------------
1561
1562 If it  is  not  set  the kernel does not assume that different subnets on this
1563 device can communicate directly. Default setting is 'yes'.
1564
1565 send_redirects
1566 --------------
1567
1568 Determines whether to send ICMP redirects to other hosts.
1569
1570 Routing settings
1571 ----------------
1572
1573 The directory  /proc/sys/net/ipv4/route  contains  several  file  to  control
1574 routing issues.
1575
1576 error_burst and error_cost
1577 --------------------------
1578
1579 These  parameters  are used to limit how many ICMP destination unreachable to 
1580 send  from  the  host  in question. ICMP destination unreachable messages are 
1581 sent  when  we can not reach the next hop, while trying to transmit a packet. 
1582 It  will also print some error messages to kernel logs if someone is ignoring 
1583 our   ICMP  redirects.  The  higher  the  error_cost  factor  is,  the  fewer 
1584 destination  unreachable  and error messages will be let through. Error_burst 
1585 controls  when  destination  unreachable  messages and error messages will be
1586 dropped. The default settings limit warning messages to five every second.
1587
1588 flush
1589 -----
1590
1591 Writing to this file results in a flush of the routing cache.
1592
1593 gc_elastic, gc_interval, gc_min_interval, gc_tresh, gc_timeout
1594 --------------------------------------------------------------
1595
1596 Values to  control  the  frequency  and  behavior  of  the  garbage collection
1597 algorithm for the routing cache.
1598
1599 max_size
1600 --------
1601
1602 Maximum size  of  the routing cache. Old entries will be purged once the cache
1603 reached has this size.
1604
1605 max_delay, min_delay
1606 --------------------
1607
1608 Delays for flushing the routing cache.
1609
1610 redirect_load, redirect_number
1611 ------------------------------
1612
1613 Factors which  determine  if  more ICPM redirects should be sent to a specific
1614 host. No  redirects  will be sent once the load limit or the maximum number of
1615 redirects has been reached.
1616
1617 redirect_silence
1618 ----------------
1619
1620 Timeout for redirects. After this period redirects will be sent again, even if
1621 this has been stopped, because the load or number limit has been reached.
1622
1623 Network Neighbor handling
1624 -------------------------
1625
1626 Settings about how to handle connections with direct neighbors (nodes attached
1627 to the same link) can be found in the directory /proc/sys/net/ipv4/neigh.
1628
1629 As we  saw  it  in  the  conf directory, there is a default subdirectory which
1630 holds the  default  values, and one directory for each interface. The contents
1631 of the  directories  are identical, with the single exception that the default
1632 settings contain additional options to set garbage collection parameters.
1633
1634 In the interface directories you'll find the following entries:
1635
1636 base_reachable_time
1637 -------------------
1638
1639 A base  value  used for computing the random reachable time value as specified
1640 in RFC2461.
1641
1642 retrans_time
1643 ------------
1644
1645 The time,  expressed  in  jiffies  (1/100 sec), between retransmitted Neighbor
1646 Solicitation messages.  Used  for  address  resolution  and  to determine if a
1647 neighbor is unreachable.
1648
1649 unres_qlen
1650 ----------
1651
1652 Maximum queue  length  for a pending arp request - the number of packets which
1653 are accepted from other layers while the ARP address is still resolved.
1654
1655 anycast_delay
1656 -------------
1657
1658 Maximum for  random  delay  of  answers  to  neighbor solicitation messages in
1659 jiffies (1/100  sec). Not yet implemented (Linux does not have anycast support
1660 yet).
1661
1662 ucast_solicit
1663 -------------
1664
1665 Maximum number of retries for unicast solicitation.
1666
1667 mcast_solicit
1668 -------------
1669
1670 Maximum number of retries for multicast solicitation.
1671
1672 delay_first_probe_time
1673 ----------------------
1674
1675 Delay for  the  first  time  probe  if  the  neighbor  is  reachable.  (see
1676 gc_stale_time)
1677
1678 locktime
1679 --------
1680
1681 An ARP/neighbor  entry  is only replaced with a new one if the old is at least
1682 locktime old. This prevents ARP cache thrashing.
1683
1684 proxy_delay
1685 -----------
1686
1687 Maximum time  (real  time is random [0..proxytime]) before answering to an ARP
1688 request for  which  we have an proxy ARP entry. In some cases, this is used to
1689 prevent network flooding.
1690
1691 proxy_qlen
1692 ----------
1693
1694 Maximum queue length of the delayed proxy arp timer. (see proxy_delay).
1695
1696 app_solcit
1697 ----------
1698
1699 Determines the  number of requests to send to the user level ARP daemon. Use 0
1700 to turn off.
1701
1702 gc_stale_time
1703 -------------
1704
1705 Determines how  often  to  check  for stale ARP entries. After an ARP entry is
1706 stale it  will  be resolved again (which is useful when an IP address migrates
1707 to another  machine).  When  ucast_solicit is greater than 0 it first tries to
1708 send an  ARP  packet  directly  to  the  known  host  When  that  fails  and
1709 mcast_solicit is greater than 0, an ARP request is broadcasted.
1710
1711 2.9 Appletalk
1712 -------------
1713
1714 The /proc/sys/net/appletalk  directory  holds the Appletalk configuration data
1715 when Appletalk is loaded. The configurable parameters are:
1716
1717 aarp-expiry-time
1718 ----------------
1719
1720 The amount  of  time  we keep an ARP entry before expiring it. Used to age out
1721 old hosts.
1722
1723 aarp-resolve-time
1724 -----------------
1725
1726 The amount of time we will spend trying to resolve an Appletalk address.
1727
1728 aarp-retransmit-limit
1729 ---------------------
1730
1731 The number of times we will retransmit a query before giving up.
1732
1733 aarp-tick-time
1734 --------------
1735
1736 Controls the rate at which expires are checked.
1737
1738 The directory  /proc/net/appletalk  holds the list of active Appletalk sockets
1739 on a machine.
1740
1741 The fields  indicate  the DDP type, the local address (in network:node format)
1742 the remote  address,  the  size of the transmit pending queue, the size of the
1743 received queue  (bytes waiting for applications to read) the state and the uid
1744 owning the socket.
1745
1746 /proc/net/atalk_iface lists  all  the  interfaces  configured for appletalk.It
1747 shows the  name  of the interface, its Appletalk address, the network range on
1748 that address  (or  network number for phase 1 networks), and the status of the
1749 interface.
1750
1751 /proc/net/atalk_route lists  each  known  network  route.  It lists the target
1752 (network) that the route leads to, the router (may be directly connected), the
1753 route flags, and the device the route is using.
1754
1755 2.10 IPX
1756 --------
1757
1758 The IPX protocol has no tunable values in proc/sys/net.
1759
1760 The IPX  protocol  does,  however,  provide  proc/net/ipx. This lists each IPX
1761 socket giving  the  local  and  remote  addresses  in  Novell  format (that is
1762 network:node:port). In  accordance  with  the  strange  Novell  tradition,
1763 everything but the port is in hex. Not_Connected is displayed for sockets that
1764 are not  tied to a specific remote address. The Tx and Rx queue sizes indicate
1765 the number  of  bytes  pending  for  transmission  and  reception.  The  state
1766 indicates the  state  the  socket  is  in and the uid is the owning uid of the
1767 socket.
1768
1769 The /proc/net/ipx_interface  file lists all IPX interfaces. For each interface
1770 it gives  the network number, the node number, and indicates if the network is
1771 the primary  network.  It  also  indicates  which  device  it  is bound to (or
1772 Internal for  internal  networks)  and  the  Frame  Type if appropriate. Linux
1773 supports 802.3,  802.2,  802.2  SNAP  and DIX (Blue Book) ethernet framing for
1774 IPX.
1775
1776 The /proc/net/ipx_route  table  holds  a list of IPX routes. For each route it
1777 gives the  destination  network, the router node (or Directly) and the network
1778 address of the router (or Connected) for internal networks.
1779
1780 ------------------------------------------------------------------------------
1781 Summary
1782 ------------------------------------------------------------------------------
1783 Certain aspects  of  kernel  behavior  can be modified at runtime, without the
1784 need to  recompile  the kernel, or even to reboot the system. The files in the
1785 /proc/sys tree  can  not only be read, but also modified. You can use the echo
1786 command to write value into these files, thereby changing the default settings
1787 of the kernel.
1788 ------------------------------------------------------------------------------
1789
1790
1791
1792
1793
1794
1795