]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - Documentation/filesystems/proc.txt
mm, shmem: add internal shmem resident memory accounting
[mirror_ubuntu-bionic-kernel.git] / Documentation / filesystems / proc.txt
CommitLineData
1da177e4
LT
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
72.4.x update Jorge Nerin <comandante@zaralinux.com> November 14 2000
349888ee 8move /proc/sys Shen Feng <shen@cn.fujitsu.com> April 1 2009
1da177e4
LT
9------------------------------------------------------------------------------
10Version 1.3 Kernel version 2.2.12
11 Kernel version 2.4.0-test11-pre4
12------------------------------------------------------------------------------
349888ee 13fixes/update part 1.1 Stefani Seibold <stefani@seibold.net> June 9 2009
1da177e4
LT
14
15Table of Contents
16-----------------
17
18 0 Preface
19 0.1 Introduction/Credits
20 0.2 Legal Stuff
21
22 1 Collecting System Information
23 1.1 Process-Specific Subdirectories
24 1.2 Kernel data
25 1.3 IDE devices in /proc/ide
26 1.4 Networking info in /proc/net
27 1.5 SCSI info
28 1.6 Parallel port info in /proc/parport
29 1.7 TTY info in /proc/tty
30 1.8 Miscellaneous kernel statistics in /proc/stat
ae96b348 31 1.9 Ext4 file system parameters
1da177e4
LT
32
33 2 Modifying System Parameters
760df93e
SF
34
35 3 Per-Process Parameters
fa0cbbf1 36 3.1 /proc/<pid>/oom_adj & /proc/<pid>/oom_score_adj - Adjust the oom-killer
a63d83f4 37 score
760df93e
SF
38 3.2 /proc/<pid>/oom_score - Display current oom-killer score
39 3.3 /proc/<pid>/io - Display the IO accounting fields
40 3.4 /proc/<pid>/coredump_filter - Core dump filtering settings
41 3.5 /proc/<pid>/mountinfo - Information about mounts
4614a696 42 3.6 /proc/<pid>/comm & /proc/<pid>/task/<tid>/comm
81841161 43 3.7 /proc/<pid>/task/<tid>/children - Information about task children
f1d8c162 44 3.8 /proc/<pid>/fdinfo/<fd> - Information about opened file
740a5ddb 45 3.9 /proc/<pid>/map_files - Information about memory mapped files
760df93e 46
0499680a
VK
47 4 Configuring procfs
48 4.1 Mount options
1da177e4
LT
49
50------------------------------------------------------------------------------
51Preface
52------------------------------------------------------------------------------
53
540.1 Introduction/Credits
55------------------------
56
57This documentation is part of a soon (or so we hope) to be released book on
58the SuSE Linux distribution. As there is no complete documentation for the
59/proc file system and we've used many freely available sources to write these
60chapters, it seems only fair to give the work back to the Linux community.
61This work is based on the 2.2.* kernel version and the upcoming 2.4.*. I'm
62afraid it's still far from complete, but we hope it will be useful. As far as
63we know, it is the first 'all-in-one' document about the /proc file system. It
64is focused on the Intel x86 hardware, so if you are looking for PPC, ARM,
65SPARC, AXP, etc., features, you probably won't find what you are looking for.
66It also only covers IPv4 networking, not IPv6 nor other protocols - sorry. But
67additions and patches are welcome and will be added to this document if you
68mail them to Bodo.
69
70We'd like to thank Alan Cox, Rik van Riel, and Alexey Kuznetsov and a lot of
71other people for help compiling this documentation. We'd also like to extend a
72special thank you to Andi Kleen for documentation, which we relied on heavily
73to create this document, as well as the additional information he provided.
74Thanks to everybody else who contributed source or docs to the Linux kernel
75and helped create a great piece of software... :)
76
77If you have any comments, corrections or additions, please don't hesitate to
78contact Bodo Bauer at bb@ricochet.net. We'll be happy to add them to this
79document.
80
81The latest version of this document is available online at
0ea6e611 82http://tldp.org/LDP/Linux-Filesystem-Hierarchy/html/proc.html
1da177e4 83
0ea6e611 84If the above direction does not works for you, you could try the kernel
1da177e4
LT
85mailing list at linux-kernel@vger.kernel.org and/or try to reach me at
86comandante@zaralinux.com.
87
880.2 Legal Stuff
89---------------
90
91We don't guarantee the correctness of this document, and if you come to us
92complaining about how you screwed up your system because of incorrect
93documentation, we won't feel responsible...
94
95------------------------------------------------------------------------------
96CHAPTER 1: COLLECTING SYSTEM INFORMATION
97------------------------------------------------------------------------------
98
99------------------------------------------------------------------------------
100In This Chapter
101------------------------------------------------------------------------------
102* Investigating the properties of the pseudo file system /proc and its
103 ability to provide information on the running Linux system
104* Examining /proc's structure
105* Uncovering various information about the kernel and the processes running
106 on the system
107------------------------------------------------------------------------------
108
109
110The proc file system acts as an interface to internal data structures in the
111kernel. It can be used to obtain information about the system and to change
112certain kernel parameters at runtime (sysctl).
113
114First, we'll take a look at the read-only parts of /proc. In Chapter 2, we
115show you how you can use /proc/sys to change settings.
116
1171.1 Process-Specific Subdirectories
118-----------------------------------
119
120The directory /proc contains (among other things) one subdirectory for each
121process running on the system, which is named after the process ID (PID).
122
123The link self points to the process reading the file system. Each process
124subdirectory has the entries listed in Table 1-1.
125
126
349888ee 127Table 1-1: Process specific entries in /proc
1da177e4 128..............................................................................
b813e931
DR
129 File Content
130 clear_refs Clears page referenced bits shown in smaps output
131 cmdline Command line arguments
132 cpu Current and last cpu in which it was executed (2.4)(smp)
133 cwd Link to the current working directory
134 environ Values of environment variables
135 exe Link to the executable of this process
136 fd Directory, which contains all file descriptors
137 maps Memory maps to executables and library files (2.4)
138 mem Memory held by this process
139 root Link to the root directory of this process
140 stat Process status
141 statm Process memory status information
142 status Process status in human readable form
b2f73922
IM
143 wchan Present with CONFIG_KALLSYMS=y: it shows the kernel function
144 symbol the task is blocked in - or "0" if not blocked.
03f890f8 145 pagemap Page table
2ec220e2 146 stack Report full stack trace, enable via CONFIG_STACKTRACE
349888ee 147 smaps a extension based on maps, showing the memory consumption of
834f82e2 148 each mapping and flags associated with it
0c369711
RA
149 numa_maps an extension based on maps, showing the memory locality and
150 binding policy as well as mem usage (in pages) of each mapping.
1da177e4
LT
151..............................................................................
152
153For example, to get the status information of a process, all you have to do is
154read the file /proc/PID/status:
155
349888ee
SS
156 >cat /proc/self/status
157 Name: cat
158 State: R (running)
159 Tgid: 5452
160 Pid: 5452
161 PPid: 743
1da177e4 162 TracerPid: 0 (2.4)
349888ee
SS
163 Uid: 501 501 501 501
164 Gid: 100 100 100 100
165 FDSize: 256
166 Groups: 100 14 16
167 VmPeak: 5004 kB
168 VmSize: 5004 kB
169 VmLck: 0 kB
170 VmHWM: 476 kB
171 VmRSS: 476 kB
172 VmData: 156 kB
173 VmStk: 88 kB
174 VmExe: 68 kB
175 VmLib: 1412 kB
176 VmPTE: 20 kb
b084d435 177 VmSwap: 0 kB
5d317b2b 178 HugetlbPages: 0 kB
349888ee
SS
179 Threads: 1
180 SigQ: 0/28578
181 SigPnd: 0000000000000000
182 ShdPnd: 0000000000000000
183 SigBlk: 0000000000000000
184 SigIgn: 0000000000000000
185 SigCgt: 0000000000000000
186 CapInh: 00000000fffffeff
187 CapPrm: 0000000000000000
188 CapEff: 0000000000000000
189 CapBnd: ffffffffffffffff
2f4b3bf6 190 Seccomp: 0
349888ee
SS
191 voluntary_ctxt_switches: 0
192 nonvoluntary_ctxt_switches: 1
1da177e4
LT
193
194This shows you nearly the same information you would get if you viewed it with
195the ps command. In fact, ps uses the proc file system to obtain its
349888ee
SS
196information. But you get a more detailed view of the process by reading the
197file /proc/PID/status. It fields are described in table 1-2.
198
199The statm file contains more detailed information about the process
200memory usage. Its seven fields are explained in Table 1-3. The stat file
201contains details information about the process itself. Its fields are
202explained in Table 1-4.
1da177e4 203
34e55232 204(for SMP CONFIG users)
15eb42d6
NS
205For making accounting scalable, RSS related information are handled in an
206asynchronous manner and the value may not be very precise. To see a precise
34e55232
KH
207snapshot of a moment, you can see /proc/<pid>/smaps file and scan page table.
208It's slow but very precise.
209
9eb05998 210Table 1-2: Contents of the status files (as of 4.1)
349888ee
SS
211..............................................................................
212 Field Content
213 Name filename of the executable
214 State state (R is running, S is sleeping, D is sleeping
215 in an uninterruptible wait, Z is zombie,
216 T is traced or stopped)
217 Tgid thread group ID
15eb42d6 218 Ngid NUMA group ID (0 if none)
349888ee
SS
219 Pid process id
220 PPid process id of the parent process
221 TracerPid PID of process tracing this process (0 if not)
222 Uid Real, effective, saved set, and file system UIDs
223 Gid Real, effective, saved set, and file system GIDs
224 FDSize number of file descriptor slots currently allocated
225 Groups supplementary group list
15eb42d6
NS
226 NStgid descendant namespace thread group ID hierarchy
227 NSpid descendant namespace process ID hierarchy
228 NSpgid descendant namespace process group ID hierarchy
229 NSsid descendant namespace session ID hierarchy
349888ee
SS
230 VmPeak peak virtual memory size
231 VmSize total program size
232 VmLck locked memory size
233 VmHWM peak resident set size ("high water mark")
234 VmRSS size of memory portions
235 VmData size of data, stack, and text segments
236 VmStk size of data, stack, and text segments
237 VmExe size of text segment
238 VmLib size of shared library code
239 VmPTE size of page table entries
c0d2143d 240 VmPMD size of second level page tables
bf9683d6
VB
241 VmSwap amount of swap used by anonymous private data
242 (shmem swap usage is not included)
5d317b2b 243 HugetlbPages size of hugetlb memory portions
349888ee
SS
244 Threads number of threads
245 SigQ number of signals queued/max. number for queue
246 SigPnd bitmap of pending signals for the thread
247 ShdPnd bitmap of shared pending signals for the process
248 SigBlk bitmap of blocked signals
249 SigIgn bitmap of ignored signals
c98be0c9 250 SigCgt bitmap of caught signals
349888ee
SS
251 CapInh bitmap of inheritable capabilities
252 CapPrm bitmap of permitted capabilities
253 CapEff bitmap of effective capabilities
254 CapBnd bitmap of capabilities bounding set
2f4b3bf6 255 Seccomp seccomp mode, like prctl(PR_GET_SECCOMP, ...)
349888ee
SS
256 Cpus_allowed mask of CPUs on which this process may run
257 Cpus_allowed_list Same as previous, but in "list format"
258 Mems_allowed mask of memory nodes allowed to this process
259 Mems_allowed_list Same as previous, but in "list format"
260 voluntary_ctxt_switches number of voluntary context switches
261 nonvoluntary_ctxt_switches number of non voluntary context switches
262..............................................................................
1da177e4 263
349888ee 264Table 1-3: Contents of the statm files (as of 2.6.8-rc3)
1da177e4
LT
265..............................................................................
266 Field Content
267 size total program size (pages) (same as VmSize in status)
268 resident size of memory portions (pages) (same as VmRSS in status)
269 shared number of pages that are shared (i.e. backed by a file)
270 trs number of pages that are 'code' (not including libs; broken,
271 includes data segment)
272 lrs number of pages of library (always 0 on 2.6)
273 drs number of pages of data/stack (including libs; broken,
274 includes library text)
275 dt number of dirty pages (always 0 on 2.6)
276..............................................................................
277
18d96779 278
349888ee 279Table 1-4: Contents of the stat files (as of 2.6.30-rc7)
18d96779
KC
280..............................................................................
281 Field Content
282 pid process id
283 tcomm filename of the executable
284 state state (R is running, S is sleeping, D is sleeping in an
285 uninterruptible wait, Z is zombie, T is traced or stopped)
286 ppid process id of the parent process
287 pgrp pgrp of the process
288 sid session id
289 tty_nr tty the process uses
290 tty_pgrp pgrp of the tty
291 flags task flags
292 min_flt number of minor faults
293 cmin_flt number of minor faults with child's
294 maj_flt number of major faults
295 cmaj_flt number of major faults with child's
296 utime user mode jiffies
297 stime kernel mode jiffies
298 cutime user mode jiffies with child's
299 cstime kernel mode jiffies with child's
300 priority priority level
301 nice nice level
302 num_threads number of threads
2e01e00e 303 it_real_value (obsolete, always 0)
18d96779
KC
304 start_time time the process started after system boot
305 vsize virtual memory size
306 rss resident set memory size
307 rsslim current limit in bytes on the rss
308 start_code address above which program text can run
309 end_code address below which program text can run
b7643757 310 start_stack address of the start of the main process stack
18d96779
KC
311 esp current value of ESP
312 eip current value of EIP
349888ee
SS
313 pending bitmap of pending signals
314 blocked bitmap of blocked signals
315 sigign bitmap of ignored signals
c98be0c9 316 sigcatch bitmap of caught signals
b2f73922 317 0 (place holder, used to be the wchan address, use /proc/PID/wchan instead)
18d96779
KC
318 0 (place holder)
319 0 (place holder)
320 exit_signal signal to send to parent thread on exit
321 task_cpu which CPU the task is scheduled on
322 rt_priority realtime priority
323 policy scheduling policy (man sched_setscheduler)
324 blkio_ticks time spent waiting for block IO
349888ee
SS
325 gtime guest time of the task in jiffies
326 cgtime guest time of the task children in jiffies
b3f7f573
CG
327 start_data address above which program data+bss is placed
328 end_data address below which program data+bss is placed
329 start_brk address above which program heap can be expanded with brk()
5b172087
CG
330 arg_start address above which program command line is placed
331 arg_end address below which program command line is placed
332 env_start address above which program environment is placed
333 env_end address below which program environment is placed
334 exit_code the thread's exit_code in the form reported by the waitpid system call
18d96779
KC
335..............................................................................
336
32e688b8 337The /proc/PID/maps file containing the currently mapped memory regions and
349888ee
SS
338their access permissions.
339
340The format is:
341
342address perms offset dev inode pathname
343
34408048000-08049000 r-xp 00000000 03:00 8312 /opt/test
34508049000-0804a000 rw-p 00001000 03:00 8312 /opt/test
3460804a000-0806b000 rw-p 00000000 00:00 0 [heap]
347a7cb1000-a7cb2000 ---p 00000000 00:00 0
34441427 348a7cb2000-a7eb2000 rw-p 00000000 00:00 0
349888ee 349a7eb2000-a7eb3000 ---p 00000000 00:00 0
b7643757 350a7eb3000-a7ed5000 rw-p 00000000 00:00 0 [stack:1001]
349888ee
SS
351a7ed5000-a8008000 r-xp 00000000 03:00 4222 /lib/libc.so.6
352a8008000-a800a000 r--p 00133000 03:00 4222 /lib/libc.so.6
353a800a000-a800b000 rw-p 00135000 03:00 4222 /lib/libc.so.6
354a800b000-a800e000 rw-p 00000000 00:00 0
355a800e000-a8022000 r-xp 00000000 03:00 14462 /lib/libpthread.so.0
356a8022000-a8023000 r--p 00013000 03:00 14462 /lib/libpthread.so.0
357a8023000-a8024000 rw-p 00014000 03:00 14462 /lib/libpthread.so.0
358a8024000-a8027000 rw-p 00000000 00:00 0
359a8027000-a8043000 r-xp 00000000 03:00 8317 /lib/ld-linux.so.2
360a8043000-a8044000 r--p 0001b000 03:00 8317 /lib/ld-linux.so.2
361a8044000-a8045000 rw-p 0001c000 03:00 8317 /lib/ld-linux.so.2
362aff35000-aff4a000 rw-p 00000000 00:00 0 [stack]
363ffffe000-fffff000 r-xp 00000000 00:00 0 [vdso]
364
365where "address" is the address space in the process that it occupies, "perms"
366is a set of permissions:
367
368 r = read
369 w = write
370 x = execute
371 s = shared
372 p = private (copy on write)
373
374"offset" is the offset into the mapping, "dev" is the device (major:minor), and
375"inode" is the inode on that device. 0 indicates that no inode is associated
376with the memory region, as the case would be with BSS (uninitialized data).
377The "pathname" shows the name associated file for this mapping. If the mapping
378is not associated with a file:
379
380 [heap] = the heap of the program
381 [stack] = the stack of the main process
b7643757 382 [stack:1001] = the stack of the thread with tid 1001
349888ee
SS
383 [vdso] = the "virtual dynamic shared object",
384 the kernel system call handler
385
386 or if empty, the mapping is anonymous.
387
b7643757
SP
388The /proc/PID/task/TID/maps is a view of the virtual memory from the viewpoint
389of the individual tasks of a process. In this file you will see a mapping marked
390as [stack] if that task sees it as a stack. This is a key difference from the
391content of /proc/PID/maps, where you will see all mappings that are being used
392as stack by all of those tasks. Hence, for the example above, the task-level
393map, i.e. /proc/PID/task/TID/maps for thread 1001 will look like this:
394
39508048000-08049000 r-xp 00000000 03:00 8312 /opt/test
39608049000-0804a000 rw-p 00001000 03:00 8312 /opt/test
3970804a000-0806b000 rw-p 00000000 00:00 0 [heap]
398a7cb1000-a7cb2000 ---p 00000000 00:00 0
399a7cb2000-a7eb2000 rw-p 00000000 00:00 0
400a7eb2000-a7eb3000 ---p 00000000 00:00 0
401a7eb3000-a7ed5000 rw-p 00000000 00:00 0 [stack]
402a7ed5000-a8008000 r-xp 00000000 03:00 4222 /lib/libc.so.6
403a8008000-a800a000 r--p 00133000 03:00 4222 /lib/libc.so.6
404a800a000-a800b000 rw-p 00135000 03:00 4222 /lib/libc.so.6
405a800b000-a800e000 rw-p 00000000 00:00 0
406a800e000-a8022000 r-xp 00000000 03:00 14462 /lib/libpthread.so.0
407a8022000-a8023000 r--p 00013000 03:00 14462 /lib/libpthread.so.0
408a8023000-a8024000 rw-p 00014000 03:00 14462 /lib/libpthread.so.0
409a8024000-a8027000 rw-p 00000000 00:00 0
410a8027000-a8043000 r-xp 00000000 03:00 8317 /lib/ld-linux.so.2
411a8043000-a8044000 r--p 0001b000 03:00 8317 /lib/ld-linux.so.2
412a8044000-a8045000 rw-p 0001c000 03:00 8317 /lib/ld-linux.so.2
413aff35000-aff4a000 rw-p 00000000 00:00 0
414ffffe000-fffff000 r-xp 00000000 00:00 0 [vdso]
349888ee
SS
415
416The /proc/PID/smaps is an extension based on maps, showing the memory
417consumption for each of the process's mappings. For each of mappings there
418is a series of lines such as the following:
419
42008048000-080bc000 r-xp 00000000 03:02 13130 /bin/bash
421Size: 1084 kB
422Rss: 892 kB
423Pss: 374 kB
424Shared_Clean: 892 kB
425Shared_Dirty: 0 kB
426Private_Clean: 0 kB
427Private_Dirty: 0 kB
428Referenced: 892 kB
b40d4f84 429Anonymous: 0 kB
25ee01a2
NH
430AnonHugePages: 0 kB
431Shared_Hugetlb: 0 kB
432Private_Hugetlb: 0 kB
349888ee 433Swap: 0 kB
8334b962 434SwapPss: 0 kB
349888ee
SS
435KernelPageSize: 4 kB
436MMUPageSize: 4 kB
a5be3563
HD
437Locked: 0 kB
438VmFlags: rd ex mr mw me dw
349888ee 439
834f82e2 440the first of these lines shows the same information as is displayed for the
0f4d208f
MM
441mapping in /proc/PID/maps. The remaining lines show the size of the mapping
442(size), the amount of the mapping that is currently resident in RAM (RSS), the
443process' proportional share of this mapping (PSS), the number of clean and
8334b962
MK
444dirty private pages in the mapping.
445
446The "proportional set size" (PSS) of a process is the count of pages it has
447in memory, where each page is divided by the number of processes sharing it.
448So if a process has 1000 pages all to itself, and 1000 shared with one other
449process, its PSS will be 1500.
450Note that even a page which is part of a MAP_SHARED mapping, but has only
451a single pte mapped, i.e. is currently used by only one process, is accounted
452as private and not as shared.
453"Referenced" indicates the amount of memory currently marked as referenced or
454accessed.
b40d4f84
NK
455"Anonymous" shows the amount of memory that does not belong to any file. Even
456a mapping associated with a file may contain anonymous pages: when MAP_PRIVATE
457and a page is modified, the file page is replaced by a private anonymous copy.
25ee01a2
NH
458"AnonHugePages" shows the ammount of memory backed by transparent hugepage.
459"Shared_Hugetlb" and "Private_Hugetlb" show the ammounts of memory backed by
460hugetlbfs page which is *not* counted in "RSS" or "PSS" field for historical
461reasons. And these are not included in {Shared,Private}_{Clean,Dirty} field.
a5be3563 462"Swap" shows how much would-be-anonymous memory is also used, but out on swap.
c261e7d9
VB
463For shmem mappings, "Swap" includes also the size of the mapped (and not
464replaced by copy-on-write) part of the underlying shmem object out on swap.
465"SwapPss" shows proportional swap share of this mapping. Unlike "Swap", this
466does not take into account swapped out page of underlying shmem objects.
a5be3563 467"Locked" indicates whether the mapping is locked in memory or not.
25ee01a2 468
834f82e2
CG
469"VmFlags" field deserves a separate description. This member represents the kernel
470flags associated with the particular virtual memory area in two letter encoded
471manner. The codes are the following:
472 rd - readable
473 wr - writeable
474 ex - executable
475 sh - shared
476 mr - may read
477 mw - may write
478 me - may execute
479 ms - may share
480 gd - stack segment growns down
481 pf - pure PFN range
482 dw - disabled write to the mapped file
483 lo - pages are locked in memory
484 io - memory mapped I/O area
485 sr - sequential read advise provided
486 rr - random read advise provided
487 dc - do not copy area on fork
488 de - do not expand area on remapping
489 ac - area is accountable
490 nr - swap space is not reserved for the area
491 ht - area uses huge tlb pages
834f82e2
CG
492 ar - architecture specific flag
493 dd - do not include area into core dump
ec8e41ae 494 sd - soft-dirty flag
834f82e2
CG
495 mm - mixed map area
496 hg - huge page advise flag
497 nh - no-huge page advise flag
498 mg - mergable advise flag
499
500Note that there is no guarantee that every flag and associated mnemonic will
501be present in all further kernel releases. Things get changed, the flags may
502be vanished or the reverse -- new added.
503
349888ee
SS
504This file is only present if the CONFIG_MMU kernel configuration option is
505enabled.
18d96779 506
398499d5 507The /proc/PID/clear_refs is used to reset the PG_Referenced and ACCESSED/YOUNG
0f8975ec
PE
508bits on both physical and virtual pages associated with a process, and the
509soft-dirty bit on pte (see Documentation/vm/soft-dirty.txt for details).
398499d5
MB
510To clear the bits for all the pages associated with the process
511 > echo 1 > /proc/PID/clear_refs
512
513To clear the bits for the anonymous pages associated with the process
514 > echo 2 > /proc/PID/clear_refs
515
516To clear the bits for the file mapped pages associated with the process
517 > echo 3 > /proc/PID/clear_refs
0f8975ec
PE
518
519To clear the soft-dirty bit
520 > echo 4 > /proc/PID/clear_refs
521
695f0559
PC
522To reset the peak resident set size ("high water mark") to the process's
523current value:
524 > echo 5 > /proc/PID/clear_refs
525
398499d5
MB
526Any other value written to /proc/PID/clear_refs will have no effect.
527
03f890f8
NK
528The /proc/pid/pagemap gives the PFN, which can be used to find the pageflags
529using /proc/kpageflags and number of times a page is mapped using
530/proc/kpagecount. For detailed explanation, see Documentation/vm/pagemap.txt.
398499d5 531
0c369711
RA
532The /proc/pid/numa_maps is an extension based on maps, showing the memory
533locality and binding policy, as well as the memory usage (in pages) of
534each mapping. The output follows a general format where mapping details get
535summarized separated by blank spaces, one mapping per each file line:
536
537address policy mapping details
538
198d1597
RA
53900400000 default file=/usr/local/bin/app mapped=1 active=0 N3=1 kernelpagesize_kB=4
54000600000 default file=/usr/local/bin/app anon=1 dirty=1 N3=1 kernelpagesize_kB=4
5413206000000 default file=/lib64/ld-2.12.so mapped=26 mapmax=6 N0=24 N3=2 kernelpagesize_kB=4
542320621f000 default file=/lib64/ld-2.12.so anon=1 dirty=1 N3=1 kernelpagesize_kB=4
5433206220000 default file=/lib64/ld-2.12.so anon=1 dirty=1 N3=1 kernelpagesize_kB=4
5443206221000 default anon=1 dirty=1 N3=1 kernelpagesize_kB=4
5453206800000 default file=/lib64/libc-2.12.so mapped=59 mapmax=21 active=55 N0=41 N3=18 kernelpagesize_kB=4
0c369711 546320698b000 default file=/lib64/libc-2.12.so
198d1597
RA
5473206b8a000 default file=/lib64/libc-2.12.so anon=2 dirty=2 N3=2 kernelpagesize_kB=4
5483206b8e000 default file=/lib64/libc-2.12.so anon=1 dirty=1 N3=1 kernelpagesize_kB=4
5493206b8f000 default anon=3 dirty=3 active=1 N3=3 kernelpagesize_kB=4
5507f4dc10a2000 default anon=3 dirty=3 N3=3 kernelpagesize_kB=4
5517f4dc10b4000 default anon=2 dirty=2 active=1 N3=2 kernelpagesize_kB=4
5527f4dc1200000 default file=/anon_hugepage\040(deleted) huge anon=1 dirty=1 N3=1 kernelpagesize_kB=2048
5537fff335f0000 default stack anon=3 dirty=3 N3=3 kernelpagesize_kB=4
5547fff3369d000 default mapped=1 mapmax=35 active=0 N3=1 kernelpagesize_kB=4
0c369711
RA
555
556Where:
557"address" is the starting address for the mapping;
558"policy" reports the NUMA memory policy set for the mapping (see vm/numa_memory_policy.txt);
559"mapping details" summarizes mapping data such as mapping type, page usage counters,
560node locality page counters (N0 == node0, N1 == node1, ...) and the kernel page
561size, in KB, that is backing the mapping up.
562
1da177e4
LT
5631.2 Kernel data
564---------------
565
566Similar to the process entries, the kernel data files give information about
567the running kernel. The files used to obtain this information are contained in
349888ee 568/proc and are listed in Table 1-5. Not all of these will be present in your
1da177e4
LT
569system. It depends on the kernel configuration and the loaded modules, which
570files are there, and which are missing.
571
349888ee 572Table 1-5: Kernel info in /proc
1da177e4
LT
573..............................................................................
574 File Content
575 apm Advanced power management info
576 buddyinfo Kernel memory allocator information (see text) (2.5)
577 bus Directory containing bus specific information
578 cmdline Kernel command line
579 cpuinfo Info about the CPU
580 devices Available devices (block and character)
581 dma Used DMS channels
582 filesystems Supported filesystems
583 driver Various drivers grouped here, currently rtc (2.4)
584 execdomains Execdomains, related to security (2.4)
585 fb Frame Buffer devices (2.4)
586 fs File system parameters, currently nfs/exports (2.4)
587 ide Directory containing info about the IDE subsystem
588 interrupts Interrupt usage
589 iomem Memory map (2.4)
590 ioports I/O port usage
591 irq Masks for irq to cpu affinity (2.4)(smp?)
592 isapnp ISA PnP (Plug&Play) Info (2.4)
593 kcore Kernel core image (can be ELF or A.OUT(deprecated in 2.4))
594 kmsg Kernel messages
595 ksyms Kernel symbol table
596 loadavg Load average of last 1, 5 & 15 minutes
597 locks Kernel locks
598 meminfo Memory info
599 misc Miscellaneous
600 modules List of loaded modules
601 mounts Mounted filesystems
602 net Networking info (see text)
a1b57ac0 603 pagetypeinfo Additional page allocator information (see text) (2.5)
1da177e4 604 partitions Table of partitions known to the system
8b60756a 605 pci Deprecated info of PCI bus (new way -> /proc/bus/pci/,
1da177e4
LT
606 decoupled by lspci (2.4)
607 rtc Real time clock
608 scsi SCSI info (see text)
609 slabinfo Slab pool info
d3d64df2 610 softirqs softirq usage
1da177e4
LT
611 stat Overall statistics
612 swaps Swap space utilization
613 sys See chapter 2
614 sysvipc Info of SysVIPC Resources (msg, sem, shm) (2.4)
615 tty Info of tty drivers
49457896 616 uptime Wall clock since boot, combined idle time of all cpus
1da177e4
LT
617 version Kernel version
618 video bttv info of video resources (2.4)
a47a126a 619 vmallocinfo Show vmalloced areas
1da177e4
LT
620..............................................................................
621
622You can, for example, check which interrupts are currently in use and what
623they are used for by looking in the file /proc/interrupts:
624
625 > cat /proc/interrupts
626 CPU0
627 0: 8728810 XT-PIC timer
628 1: 895 XT-PIC keyboard
629 2: 0 XT-PIC cascade
630 3: 531695 XT-PIC aha152x
631 4: 2014133 XT-PIC serial
632 5: 44401 XT-PIC pcnet_cs
633 8: 2 XT-PIC rtc
634 11: 8 XT-PIC i82365
635 12: 182918 XT-PIC PS/2 Mouse
636 13: 1 XT-PIC fpu
637 14: 1232265 XT-PIC ide0
638 15: 7 XT-PIC ide1
639 NMI: 0
640
641In 2.4.* a couple of lines where added to this file LOC & ERR (this time is the
642output of a SMP machine):
643
644 > cat /proc/interrupts
645
646 CPU0 CPU1
647 0: 1243498 1214548 IO-APIC-edge timer
648 1: 8949 8958 IO-APIC-edge keyboard
649 2: 0 0 XT-PIC cascade
650 5: 11286 10161 IO-APIC-edge soundblaster
651 8: 1 0 IO-APIC-edge rtc
652 9: 27422 27407 IO-APIC-edge 3c503
653 12: 113645 113873 IO-APIC-edge PS/2 Mouse
654 13: 0 0 XT-PIC fpu
655 14: 22491 24012 IO-APIC-edge ide0
656 15: 2183 2415 IO-APIC-edge ide1
657 17: 30564 30414 IO-APIC-level eth0
658 18: 177 164 IO-APIC-level bttv
659 NMI: 2457961 2457959
660 LOC: 2457882 2457881
661 ERR: 2155
662
663NMI is incremented in this case because every timer interrupt generates a NMI
664(Non Maskable Interrupt) which is used by the NMI Watchdog to detect lockups.
665
666LOC is the local interrupt counter of the internal APIC of every CPU.
667
668ERR is incremented in the case of errors in the IO-APIC bus (the bus that
669connects the CPUs in a SMP system. This means that an error has been detected,
670the IO-APIC automatically retry the transmission, so it should not be a big
671problem, but you should read the SMP-FAQ.
672
38e760a1
JK
673In 2.6.2* /proc/interrupts was expanded again. This time the goal was for
674/proc/interrupts to display every IRQ vector in use by the system, not
675just those considered 'most important'. The new vectors are:
676
677 THR -- interrupt raised when a machine check threshold counter
678 (typically counting ECC corrected errors of memory or cache) exceeds
679 a configurable threshold. Only available on some systems.
680
681 TRM -- a thermal event interrupt occurs when a temperature threshold
682 has been exceeded for the CPU. This interrupt may also be generated
683 when the temperature drops back to normal.
684
685 SPU -- a spurious interrupt is some interrupt that was raised then lowered
686 by some IO device before it could be fully processed by the APIC. Hence
687 the APIC sees the interrupt but does not know what device it came from.
688 For this case the APIC will generate the interrupt with a IRQ vector
689 of 0xff. This might also be generated by chipset bugs.
690
691 RES, CAL, TLB -- rescheduling, call and TLB flush interrupts are
692 sent from one CPU to another per the needs of the OS. Typically,
693 their statistics are used by kernel developers and interested users to
19f59460 694 determine the occurrence of interrupts of the given type.
38e760a1 695
25985edc 696The above IRQ vectors are displayed only when relevant. For example,
38e760a1
JK
697the threshold vector does not exist on x86_64 platforms. Others are
698suppressed when the system is a uniprocessor. As of this writing, only
699i386 and x86_64 platforms support the new IRQ vector displays.
700
701Of some interest is the introduction of the /proc/irq directory to 2.4.
1da177e4
LT
702It could be used to set IRQ to CPU affinity, this means that you can "hook" an
703IRQ to only one CPU, or to exclude a CPU of handling IRQs. The contents of the
18404756
MK
704irq subdir is one subdir for each IRQ, and two files; default_smp_affinity and
705prof_cpu_mask.
1da177e4
LT
706
707For example
708 > ls /proc/irq/
709 0 10 12 14 16 18 2 4 6 8 prof_cpu_mask
18404756 710 1 11 13 15 17 19 3 5 7 9 default_smp_affinity
1da177e4
LT
711 > ls /proc/irq/0/
712 smp_affinity
713
18404756
MK
714smp_affinity is a bitmask, in which you can specify which CPUs can handle the
715IRQ, you can set it by doing:
1da177e4 716
18404756
MK
717 > echo 1 > /proc/irq/10/smp_affinity
718
719This means that only the first CPU will handle the IRQ, but you can also echo
7205 which means that only the first and fourth CPU can handle the IRQ.
1da177e4 721
18404756
MK
722The contents of each smp_affinity file is the same by default:
723
724 > cat /proc/irq/0/smp_affinity
725 ffffffff
1da177e4 726
4b060420
MT
727There is an alternate interface, smp_affinity_list which allows specifying
728a cpu range instead of a bitmask:
729
730 > cat /proc/irq/0/smp_affinity_list
731 1024-1031
732
18404756
MK
733The default_smp_affinity mask applies to all non-active IRQs, which are the
734IRQs which have not yet been allocated/activated, and hence which lack a
735/proc/irq/[0-9]* directory.
1da177e4 736
92d6b71a
DS
737The node file on an SMP system shows the node to which the device using the IRQ
738reports itself as being attached. This hardware locality information does not
739include information about any possible driver locality preference.
740
18404756 741prof_cpu_mask specifies which CPUs are to be profiled by the system wide
4b060420 742profiler. Default value is ffffffff (all cpus if there are only 32 of them).
1da177e4
LT
743
744The way IRQs are routed is handled by the IO-APIC, and it's Round Robin
745between all the CPUs which are allowed to handle it. As usual the kernel has
746more info than you and does a better job than you, so the defaults are the
4b060420
MT
747best choice for almost everyone. [Note this applies only to those IO-APIC's
748that support "Round Robin" interrupt distribution.]
1da177e4
LT
749
750There are three more important subdirectories in /proc: net, scsi, and sys.
751The general rule is that the contents, or even the existence of these
752directories, depend on your kernel configuration. If SCSI is not enabled, the
753directory scsi may not exist. The same is true with the net, which is there
754only when networking support is present in the running kernel.
755
756The slabinfo file gives information about memory usage at the slab level.
757Linux uses slab pools for memory management above page level in version 2.2.
758Commonly used objects have their own slab pool (such as network buffers,
759directory cache, and so on).
760
761..............................................................................
762
763> cat /proc/buddyinfo
764
765Node 0, zone DMA 0 4 5 4 4 3 ...
766Node 0, zone Normal 1 0 0 1 101 8 ...
767Node 0, zone HighMem 2 0 0 1 1 0 ...
768
a1b57ac0 769External fragmentation is a problem under some workloads, and buddyinfo is a
1da177e4
LT
770useful tool for helping diagnose these problems. Buddyinfo will give you a
771clue as to how big an area you can safely allocate, or why a previous
772allocation failed.
773
774Each column represents the number of pages of a certain order which are
775available. In this case, there are 0 chunks of 2^0*PAGE_SIZE available in
776ZONE_DMA, 4 chunks of 2^1*PAGE_SIZE in ZONE_DMA, 101 chunks of 2^4*PAGE_SIZE
777available in ZONE_NORMAL, etc...
778
a1b57ac0
MG
779More information relevant to external fragmentation can be found in
780pagetypeinfo.
781
782> cat /proc/pagetypeinfo
783Page block order: 9
784Pages per block: 512
785
786Free pages count per migrate type at order 0 1 2 3 4 5 6 7 8 9 10
787Node 0, zone DMA, type Unmovable 0 0 0 1 1 1 1 1 1 1 0
788Node 0, zone DMA, type Reclaimable 0 0 0 0 0 0 0 0 0 0 0
789Node 0, zone DMA, type Movable 1 1 2 1 2 1 1 0 1 0 2
790Node 0, zone DMA, type Reserve 0 0 0 0 0 0 0 0 0 1 0
791Node 0, zone DMA, type Isolate 0 0 0 0 0 0 0 0 0 0 0
792Node 0, zone DMA32, type Unmovable 103 54 77 1 1 1 11 8 7 1 9
793Node 0, zone DMA32, type Reclaimable 0 0 2 1 0 0 0 0 1 0 0
794Node 0, zone DMA32, type Movable 169 152 113 91 77 54 39 13 6 1 452
795Node 0, zone DMA32, type Reserve 1 2 2 2 2 0 1 1 1 1 0
796Node 0, zone DMA32, type Isolate 0 0 0 0 0 0 0 0 0 0 0
797
798Number of blocks type Unmovable Reclaimable Movable Reserve Isolate
799Node 0, zone DMA 2 0 5 1 0
800Node 0, zone DMA32 41 6 967 2 0
801
802Fragmentation avoidance in the kernel works by grouping pages of different
803migrate types into the same contiguous regions of memory called page blocks.
804A page block is typically the size of the default hugepage size e.g. 2MB on
805X86-64. By keeping pages grouped based on their ability to move, the kernel
806can reclaim pages within a page block to satisfy a high-order allocation.
807
808The pagetypinfo begins with information on the size of a page block. It
809then gives the same type of information as buddyinfo except broken down
810by migrate-type and finishes with details on how many page blocks of each
811type exist.
812
813If min_free_kbytes has been tuned correctly (recommendations made by hugeadm
814from libhugetlbfs http://sourceforge.net/projects/libhugetlbfs/), one can
815make an estimate of the likely number of huge pages that can be allocated
816at a given point in time. All the "Movable" blocks should be allocatable
817unless memory has been mlock()'d. Some of the Reclaimable blocks should
818also be allocatable although a lot of filesystem metadata may have to be
819reclaimed to achieve this.
820
1da177e4
LT
821..............................................................................
822
823meminfo:
824
825Provides information about distribution and utilization of memory. This
826varies by architecture and compile options. The following is from a
82716GB PIII, which has highmem enabled. You may not have all of these fields.
828
829> cat /proc/meminfo
830
1da177e4
LT
831MemTotal: 16344972 kB
832MemFree: 13634064 kB
34e431b0 833MemAvailable: 14836172 kB
1da177e4
LT
834Buffers: 3656 kB
835Cached: 1195708 kB
836SwapCached: 0 kB
837Active: 891636 kB
838Inactive: 1077224 kB
839HighTotal: 15597528 kB
840HighFree: 13629632 kB
841LowTotal: 747444 kB
842LowFree: 4432 kB
843SwapTotal: 0 kB
844SwapFree: 0 kB
845Dirty: 968 kB
846Writeback: 0 kB
b88473f7 847AnonPages: 861800 kB
1da177e4 848Mapped: 280372 kB
b88473f7
MS
849Slab: 284364 kB
850SReclaimable: 159856 kB
851SUnreclaim: 124508 kB
852PageTables: 24448 kB
853NFS_Unstable: 0 kB
854Bounce: 0 kB
855WritebackTmp: 0 kB
1da177e4
LT
856CommitLimit: 7669796 kB
857Committed_AS: 100056 kB
1da177e4
LT
858VmallocTotal: 112216 kB
859VmallocUsed: 428 kB
860VmallocChunk: 111088 kB
69256994 861AnonHugePages: 49152 kB
1da177e4
LT
862
863 MemTotal: Total usable ram (i.e. physical ram minus a few reserved
864 bits and the kernel binary code)
865 MemFree: The sum of LowFree+HighFree
34e431b0
RR
866MemAvailable: An estimate of how much memory is available for starting new
867 applications, without swapping. Calculated from MemFree,
868 SReclaimable, the size of the file LRU lists, and the low
869 watermarks in each zone.
870 The estimate takes into account that the system needs some
871 page cache to function well, and that not all reclaimable
872 slab will be reclaimable, due to items being in use. The
873 impact of those factors will vary from system to system.
1da177e4
LT
874 Buffers: Relatively temporary storage for raw disk blocks
875 shouldn't get tremendously large (20MB or so)
876 Cached: in-memory cache for files read from the disk (the
877 pagecache). Doesn't include SwapCached
878 SwapCached: Memory that once was swapped out, is swapped back in but
879 still also is in the swapfile (if memory is needed it
880 doesn't need to be swapped out AGAIN because it is already
881 in the swapfile. This saves I/O)
882 Active: Memory that has been used more recently and usually not
883 reclaimed unless absolutely necessary.
884 Inactive: Memory which has been less recently used. It is more
885 eligible to be reclaimed for other purposes
886 HighTotal:
887 HighFree: Highmem is all memory above ~860MB of physical memory
888 Highmem areas are for use by userspace programs, or
889 for the pagecache. The kernel must use tricks to access
890 this memory, making it slower to access than lowmem.
891 LowTotal:
892 LowFree: Lowmem is memory which can be used for everything that
3f6dee9b 893 highmem can be used for, but it is also available for the
1da177e4
LT
894 kernel's use for its own data structures. Among many
895 other things, it is where everything from the Slab is
896 allocated. Bad things happen when you're out of lowmem.
897 SwapTotal: total amount of swap space available
898 SwapFree: Memory which has been evicted from RAM, and is temporarily
899 on the disk
900 Dirty: Memory which is waiting to get written back to the disk
901 Writeback: Memory which is actively being written back to the disk
b88473f7 902 AnonPages: Non-file backed pages mapped into userspace page tables
69256994 903AnonHugePages: Non-file backed huge pages mapped into userspace page tables
1da177e4 904 Mapped: files which have been mmaped, such as libraries
e82443c0 905 Slab: in-kernel data structures cache
b88473f7
MS
906SReclaimable: Part of Slab, that might be reclaimed, such as caches
907 SUnreclaim: Part of Slab, that cannot be reclaimed on memory pressure
908 PageTables: amount of memory dedicated to the lowest level of page
909 tables.
910NFS_Unstable: NFS pages sent to the server, but not yet committed to stable
911 storage
912 Bounce: Memory used for block device "bounce buffers"
913WritebackTmp: Memory used by FUSE for temporary writeback buffers
1da177e4
LT
914 CommitLimit: Based on the overcommit ratio ('vm.overcommit_ratio'),
915 this is the total amount of memory currently available to
916 be allocated on the system. This limit is only adhered to
917 if strict overcommit accounting is enabled (mode 2 in
918 'vm.overcommit_memory').
919 The CommitLimit is calculated with the following formula:
7a9e6da1
PO
920 CommitLimit = ([total RAM pages] - [total huge TLB pages]) *
921 overcommit_ratio / 100 + [total swap pages]
1da177e4
LT
922 For example, on a system with 1G of physical RAM and 7G
923 of swap with a `vm.overcommit_ratio` of 30 it would
924 yield a CommitLimit of 7.3G.
925 For more details, see the memory overcommit documentation
926 in vm/overcommit-accounting.
927Committed_AS: The amount of memory presently allocated on the system.
928 The committed memory is a sum of all of the memory which
929 has been allocated by processes, even if it has not been
930 "used" by them as of yet. A process which malloc()'s 1G
46496022
MJ
931 of memory, but only touches 300M of it will show up as
932 using 1G. This 1G is memory which has been "committed" to
933 by the VM and can be used at any time by the allocating
934 application. With strict overcommit enabled on the system
935 (mode 2 in 'vm.overcommit_memory'),allocations which would
936 exceed the CommitLimit (detailed above) will not be permitted.
937 This is useful if one needs to guarantee that processes will
938 not fail due to lack of memory once that memory has been
939 successfully allocated.
1da177e4
LT
940VmallocTotal: total size of vmalloc memory area
941 VmallocUsed: amount of vmalloc area which is used
19f59460 942VmallocChunk: largest contiguous block of vmalloc area which is free
1da177e4 943
a47a126a
ED
944..............................................................................
945
946vmallocinfo:
947
948Provides information about vmalloced/vmaped areas. One line per area,
949containing the virtual address range of the area, size in bytes,
950caller information of the creator, and optional information depending
951on the kind of area :
952
953 pages=nr number of pages
954 phys=addr if a physical address was specified
955 ioremap I/O mapping (ioremap() and friends)
956 vmalloc vmalloc() area
957 vmap vmap()ed pages
958 user VM_USERMAP area
959 vpages buffer for pages pointers was vmalloced (huge area)
960 N<node>=nr (Only on NUMA kernels)
961 Number of pages allocated on memory node <node>
962
963> cat /proc/vmallocinfo
9640xffffc20000000000-0xffffc20000201000 2101248 alloc_large_system_hash+0x204 ...
965 /0x2c0 pages=512 vmalloc N0=128 N1=128 N2=128 N3=128
9660xffffc20000201000-0xffffc20000302000 1052672 alloc_large_system_hash+0x204 ...
967 /0x2c0 pages=256 vmalloc N0=64 N1=64 N2=64 N3=64
9680xffffc20000302000-0xffffc20000304000 8192 acpi_tb_verify_table+0x21/0x4f...
969 phys=7fee8000 ioremap
9700xffffc20000304000-0xffffc20000307000 12288 acpi_tb_verify_table+0x21/0x4f...
971 phys=7fee7000 ioremap
9720xffffc2000031d000-0xffffc2000031f000 8192 init_vdso_vars+0x112/0x210
9730xffffc2000031f000-0xffffc2000032b000 49152 cramfs_uncompress_init+0x2e ...
974 /0x80 pages=11 vmalloc N0=3 N1=3 N2=2 N3=3
9750xffffc2000033a000-0xffffc2000033d000 12288 sys_swapon+0x640/0xac0 ...
976 pages=2 vmalloc N1=2
9770xffffc20000347000-0xffffc2000034c000 20480 xt_alloc_table_info+0xfe ...
978 /0x130 [x_tables] pages=4 vmalloc N0=4
9790xffffffffa0000000-0xffffffffa000f000 61440 sys_init_module+0xc27/0x1d00 ...
980 pages=14 vmalloc N2=14
9810xffffffffa000f000-0xffffffffa0014000 20480 sys_init_module+0xc27/0x1d00 ...
982 pages=4 vmalloc N1=4
9830xffffffffa0014000-0xffffffffa0017000 12288 sys_init_module+0xc27/0x1d00 ...
984 pages=2 vmalloc N1=2
9850xffffffffa0017000-0xffffffffa0022000 45056 sys_init_module+0xc27/0x1d00 ...
986 pages=10 vmalloc N0=10
1da177e4 987
d3d64df2
KK
988..............................................................................
989
990softirqs:
991
992Provides counts of softirq handlers serviced since boot time, for each cpu.
993
994> cat /proc/softirqs
995 CPU0 CPU1 CPU2 CPU3
996 HI: 0 0 0 0
997 TIMER: 27166 27120 27097 27034
998 NET_TX: 0 0 0 17
999 NET_RX: 42 0 0 39
1000 BLOCK: 0 0 107 1121
1001 TASKLET: 0 0 0 290
1002 SCHED: 27035 26983 26971 26746
1003 HRTIMER: 0 0 0 0
09223371 1004 RCU: 1678 1769 2178 2250
d3d64df2
KK
1005
1006
1da177e4
LT
10071.3 IDE devices in /proc/ide
1008----------------------------
1009
1010The subdirectory /proc/ide contains information about all IDE devices of which
1011the kernel is aware. There is one subdirectory for each IDE controller, the
1012file drivers and a link for each IDE device, pointing to the device directory
1013in the controller specific subtree.
1014
1015The file drivers contains general information about the drivers used for the
1016IDE devices:
1017
1018 > cat /proc/ide/drivers
1019 ide-cdrom version 4.53
1020 ide-disk version 1.08
1021
1022More detailed information can be found in the controller specific
1023subdirectories. These are named ide0, ide1 and so on. Each of these
349888ee 1024directories contains the files shown in table 1-6.
1da177e4
LT
1025
1026
349888ee 1027Table 1-6: IDE controller info in /proc/ide/ide?
1da177e4
LT
1028..............................................................................
1029 File Content
1030 channel IDE channel (0 or 1)
1031 config Configuration (only for PCI/IDE bridge)
1032 mate Mate name
1033 model Type/Chipset of IDE controller
1034..............................................................................
1035
1036Each device connected to a controller has a separate subdirectory in the
349888ee 1037controllers directory. The files listed in table 1-7 are contained in these
1da177e4
LT
1038directories.
1039
1040
349888ee 1041Table 1-7: IDE device information
1da177e4
LT
1042..............................................................................
1043 File Content
1044 cache The cache
1045 capacity Capacity of the medium (in 512Byte blocks)
1046 driver driver and version
1047 geometry physical and logical geometry
1048 identify device identify block
1049 media media type
1050 model device identifier
1051 settings device setup
1052 smart_thresholds IDE disk management thresholds
1053 smart_values IDE disk management values
1054..............................................................................
1055
1056The most interesting file is settings. This file contains a nice overview of
1057the drive parameters:
1058
1059 # cat /proc/ide/ide0/hda/settings
1060 name value min max mode
1061 ---- ----- --- --- ----
1062 bios_cyl 526 0 65535 rw
1063 bios_head 255 0 255 rw
1064 bios_sect 63 0 63 rw
1065 breada_readahead 4 0 127 rw
1066 bswap 0 0 1 r
1067 file_readahead 72 0 2097151 rw
1068 io_32bit 0 0 3 rw
1069 keepsettings 0 0 1 rw
1070 max_kb_per_request 122 1 127 rw
1071 multcount 0 0 8 rw
1072 nice1 1 0 1 rw
1073 nowerr 0 0 1 rw
1074 pio_mode write-only 0 255 w
1075 slow 0 0 1 rw
1076 unmaskirq 0 0 1 rw
1077 using_dma 0 0 1 rw
1078
1079
10801.4 Networking info in /proc/net
1081--------------------------------
1082
349888ee 1083The subdirectory /proc/net follows the usual pattern. Table 1-8 shows the
1da177e4 1084additional values you get for IP version 6 if you configure the kernel to
349888ee 1085support this. Table 1-9 lists the files and their meaning.
1da177e4
LT
1086
1087
349888ee 1088Table 1-8: IPv6 info in /proc/net
1da177e4
LT
1089..............................................................................
1090 File Content
1091 udp6 UDP sockets (IPv6)
1092 tcp6 TCP sockets (IPv6)
1093 raw6 Raw device statistics (IPv6)
1094 igmp6 IP multicast addresses, which this host joined (IPv6)
1095 if_inet6 List of IPv6 interface addresses
1096 ipv6_route Kernel routing table for IPv6
1097 rt6_stats Global IPv6 routing tables statistics
1098 sockstat6 Socket statistics (IPv6)
1099 snmp6 Snmp data (IPv6)
1100..............................................................................
1101
1102
349888ee 1103Table 1-9: Network info in /proc/net
1da177e4
LT
1104..............................................................................
1105 File Content
1106 arp Kernel ARP table
1107 dev network devices with statistics
1108 dev_mcast the Layer2 multicast groups a device is listening too
1109 (interface index, label, number of references, number of bound
1110 addresses).
1111 dev_stat network device status
1112 ip_fwchains Firewall chain linkage
1113 ip_fwnames Firewall chain names
1114 ip_masq Directory containing the masquerading tables
1115 ip_masquerade Major masquerading table
1116 netstat Network statistics
1117 raw raw device statistics
1118 route Kernel routing table
1119 rpc Directory containing rpc info
1120 rt_cache Routing cache
1121 snmp SNMP data
1122 sockstat Socket statistics
1123 tcp TCP sockets
1da177e4
LT
1124 udp UDP sockets
1125 unix UNIX domain sockets
1126 wireless Wireless interface data (Wavelan etc)
1127 igmp IP multicast addresses, which this host joined
1128 psched Global packet scheduler parameters.
1129 netlink List of PF_NETLINK sockets
1130 ip_mr_vifs List of multicast virtual interfaces
1131 ip_mr_cache List of multicast routing cache
1132..............................................................................
1133
1134You can use this information to see which network devices are available in
1135your system and how much traffic was routed over those devices:
1136
1137 > cat /proc/net/dev
1138 Inter-|Receive |[...
1139 face |bytes packets errs drop fifo frame compressed multicast|[...
1140 lo: 908188 5596 0 0 0 0 0 0 [...
1141 ppp0:15475140 20721 410 0 0 410 0 0 [...
1142 eth0: 614530 7085 0 0 0 0 0 1 [...
1143
1144 ...] Transmit
1145 ...] bytes packets errs drop fifo colls carrier compressed
1146 ...] 908188 5596 0 0 0 0 0 0
1147 ...] 1375103 17405 0 0 0 0 0 0
1148 ...] 1703981 5535 0 0 0 3 0 0
1149
a33f3224 1150In addition, each Channel Bond interface has its own directory. For
1da177e4
LT
1151example, the bond0 device will have a directory called /proc/net/bond0/.
1152It will contain information that is specific to that bond, such as the
1153current slaves of the bond, the link status of the slaves, and how
1154many times the slaves link has failed.
1155
11561.5 SCSI info
1157-------------
1158
1159If you have a SCSI host adapter in your system, you'll find a subdirectory
1160named after the driver for this adapter in /proc/scsi. You'll also see a list
1161of all recognized SCSI devices in /proc/scsi:
1162
1163 >cat /proc/scsi/scsi
1164 Attached devices:
1165 Host: scsi0 Channel: 00 Id: 00 Lun: 00
1166 Vendor: IBM Model: DGHS09U Rev: 03E0
1167 Type: Direct-Access ANSI SCSI revision: 03
1168 Host: scsi0 Channel: 00 Id: 06 Lun: 00
1169 Vendor: PIONEER Model: CD-ROM DR-U06S Rev: 1.04
1170 Type: CD-ROM ANSI SCSI revision: 02
1171
1172
1173The directory named after the driver has one file for each adapter found in
1174the system. These files contain information about the controller, including
1175the used IRQ and the IO address range. The amount of information shown is
1176dependent on the adapter you use. The example shows the output for an Adaptec
1177AHA-2940 SCSI adapter:
1178
1179 > cat /proc/scsi/aic7xxx/0
1180
1181 Adaptec AIC7xxx driver version: 5.1.19/3.2.4
1182 Compile Options:
1183 TCQ Enabled By Default : Disabled
1184 AIC7XXX_PROC_STATS : Disabled
1185 AIC7XXX_RESET_DELAY : 5
1186 Adapter Configuration:
1187 SCSI Adapter: Adaptec AHA-294X Ultra SCSI host adapter
1188 Ultra Wide Controller
1189 PCI MMAPed I/O Base: 0xeb001000
1190 Adapter SEEPROM Config: SEEPROM found and used.
1191 Adaptec SCSI BIOS: Enabled
1192 IRQ: 10
1193 SCBs: Active 0, Max Active 2,
1194 Allocated 15, HW 16, Page 255
1195 Interrupts: 160328
1196 BIOS Control Word: 0x18b6
1197 Adapter Control Word: 0x005b
1198 Extended Translation: Enabled
1199 Disconnect Enable Flags: 0xffff
1200 Ultra Enable Flags: 0x0001
1201 Tag Queue Enable Flags: 0x0000
1202 Ordered Queue Tag Flags: 0x0000
1203 Default Tag Queue Depth: 8
1204 Tagged Queue By Device array for aic7xxx host instance 0:
1205 {255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255}
1206 Actual queue depth per device for aic7xxx host instance 0:
1207 {1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1}
1208 Statistics:
1209 (scsi0:0:0:0)
1210 Device using Wide/Sync transfers at 40.0 MByte/sec, offset 8
1211 Transinfo settings: current(12/8/1/0), goal(12/8/1/0), user(12/15/1/0)
1212 Total transfers 160151 (74577 reads and 85574 writes)
1213 (scsi0:0:6:0)
1214 Device using Narrow/Sync transfers at 5.0 MByte/sec, offset 15
1215 Transinfo settings: current(50/15/0/0), goal(50/15/0/0), user(50/15/0/0)
1216 Total transfers 0 (0 reads and 0 writes)
1217
1218
12191.6 Parallel port info in /proc/parport
1220---------------------------------------
1221
1222The directory /proc/parport contains information about the parallel ports of
1223your system. It has one subdirectory for each port, named after the port
1224number (0,1,2,...).
1225
349888ee 1226These directories contain the four files shown in Table 1-10.
1da177e4
LT
1227
1228
349888ee 1229Table 1-10: Files in /proc/parport
1da177e4
LT
1230..............................................................................
1231 File Content
1232 autoprobe Any IEEE-1284 device ID information that has been acquired.
1233 devices list of the device drivers using that port. A + will appear by the
1234 name of the device currently using the port (it might not appear
1235 against any).
1236 hardware Parallel port's base address, IRQ line and DMA channel.
1237 irq IRQ that parport is using for that port. This is in a separate
1238 file to allow you to alter it by writing a new value in (IRQ
1239 number or none).
1240..............................................................................
1241
12421.7 TTY info in /proc/tty
1243-------------------------
1244
1245Information about the available and actually used tty's can be found in the
1246directory /proc/tty.You'll find entries for drivers and line disciplines in
349888ee 1247this directory, as shown in Table 1-11.
1da177e4
LT
1248
1249
349888ee 1250Table 1-11: Files in /proc/tty
1da177e4
LT
1251..............................................................................
1252 File Content
1253 drivers list of drivers and their usage
1254 ldiscs registered line disciplines
1255 driver/serial usage statistic and status of single tty lines
1256..............................................................................
1257
1258To see which tty's are currently in use, you can simply look into the file
1259/proc/tty/drivers:
1260
1261 > cat /proc/tty/drivers
1262 pty_slave /dev/pts 136 0-255 pty:slave
1263 pty_master /dev/ptm 128 0-255 pty:master
1264 pty_slave /dev/ttyp 3 0-255 pty:slave
1265 pty_master /dev/pty 2 0-255 pty:master
1266 serial /dev/cua 5 64-67 serial:callout
1267 serial /dev/ttyS 4 64-67 serial
1268 /dev/tty0 /dev/tty0 4 0 system:vtmaster
1269 /dev/ptmx /dev/ptmx 5 2 system
1270 /dev/console /dev/console 5 1 system:console
1271 /dev/tty /dev/tty 5 0 system:/dev/tty
1272 unknown /dev/tty 4 1-63 console
1273
1274
12751.8 Miscellaneous kernel statistics in /proc/stat
1276-------------------------------------------------
1277
1278Various pieces of information about kernel activity are available in the
1279/proc/stat file. All of the numbers reported in this file are aggregates
1280since the system first booted. For a quick look, simply cat the file:
1281
1282 > cat /proc/stat
c8a329c7
TK
1283 cpu 2255 34 2290 22625563 6290 127 456 0 0 0
1284 cpu0 1132 34 1441 11311718 3675 127 438 0 0 0
1285 cpu1 1123 0 849 11313845 2614 0 18 0 0 0
1da177e4
LT
1286 intr 114930548 113199788 3 0 5 263 0 4 [... lots more numbers ...]
1287 ctxt 1990473
1288 btime 1062191376
1289 processes 2915
1290 procs_running 1
1291 procs_blocked 0
d3d64df2 1292 softirq 183433 0 21755 12 39 1137 231 21459 2263
1da177e4
LT
1293
1294The very first "cpu" line aggregates the numbers in all of the other "cpuN"
1295lines. These numbers identify the amount of time the CPU has spent performing
1296different kinds of work. Time units are in USER_HZ (typically hundredths of a
1297second). The meanings of the columns are as follows, from left to right:
1298
1299- user: normal processes executing in user mode
1300- nice: niced processes executing in user mode
1301- system: processes executing in kernel mode
1302- idle: twiddling thumbs
1303- iowait: waiting for I/O to complete
1304- irq: servicing interrupts
1305- softirq: servicing softirqs
b68f2c3a 1306- steal: involuntary wait
ce0e7b28
RO
1307- guest: running a normal guest
1308- guest_nice: running a niced guest
1da177e4
LT
1309
1310The "intr" line gives counts of interrupts serviced since boot time, for each
1311of the possible system interrupts. The first column is the total of all
3568a1db
JMM
1312interrupts serviced including unnumbered architecture specific interrupts;
1313each subsequent column is the total for that particular numbered interrupt.
1314Unnumbered interrupts are not shown, only summed into the total.
1da177e4
LT
1315
1316The "ctxt" line gives the total number of context switches across all CPUs.
1317
1318The "btime" line gives the time at which the system booted, in seconds since
1319the Unix epoch.
1320
1321The "processes" line gives the number of processes and threads created, which
1322includes (but is not limited to) those created by calls to the fork() and
1323clone() system calls.
1324
e3cc2226
LGE
1325The "procs_running" line gives the total number of threads that are
1326running or ready to run (i.e., the total number of runnable threads).
1da177e4
LT
1327
1328The "procs_blocked" line gives the number of processes currently blocked,
1329waiting for I/O to complete.
1330
d3d64df2
KK
1331The "softirq" line gives counts of softirqs serviced since boot time, for each
1332of the possible system softirqs. The first column is the total of all
1333softirqs serviced; each subsequent column is the total for that particular
1334softirq.
1335
37515fac 1336
c9de560d 13371.9 Ext4 file system parameters
690b0543 1338-------------------------------
37515fac
TT
1339
1340Information about mounted ext4 file systems can be found in
1341/proc/fs/ext4. Each mounted filesystem will have a directory in
1342/proc/fs/ext4 based on its device name (i.e., /proc/fs/ext4/hdc or
1343/proc/fs/ext4/dm-0). The files in each per-device directory are shown
349888ee 1344in Table 1-12, below.
37515fac 1345
349888ee 1346Table 1-12: Files in /proc/fs/ext4/<devname>
37515fac
TT
1347..............................................................................
1348 File Content
1349 mb_groups details of multiblock allocator buddy cache of free blocks
37515fac
TT
1350..............................................................................
1351
23308ba5
JS
13522.0 /proc/consoles
1353------------------
1354Shows registered system console lines.
1355
1356To see which character device lines are currently used for the system console
1357/dev/console, you may simply look into the file /proc/consoles:
1358
1359 > cat /proc/consoles
1360 tty0 -WU (ECp) 4:7
1361 ttyS0 -W- (Ep) 4:64
1362
1363The columns are:
1364
1365 device name of the device
1366 operations R = can do read operations
1367 W = can do write operations
1368 U = can do unblank
1369 flags E = it is enabled
25985edc 1370 C = it is preferred console
23308ba5
JS
1371 B = it is primary boot console
1372 p = it is used for printk buffer
1373 b = it is not a TTY but a Braille device
1374 a = it is safe to use when cpu is offline
1375 major:minor major and minor number of the device separated by a colon
1da177e4
LT
1376
1377------------------------------------------------------------------------------
1378Summary
1379------------------------------------------------------------------------------
1380The /proc file system serves information about the running system. It not only
1381allows access to process data but also allows you to request the kernel status
1382by reading files in the hierarchy.
1383
1384The directory structure of /proc reflects the types of information and makes
1385it easy, if not obvious, where to look for specific data.
1386------------------------------------------------------------------------------
1387
1388------------------------------------------------------------------------------
1389CHAPTER 2: MODIFYING SYSTEM PARAMETERS
1390------------------------------------------------------------------------------
1391
1392------------------------------------------------------------------------------
1393In This Chapter
1394------------------------------------------------------------------------------
1395* Modifying kernel parameters by writing into files found in /proc/sys
1396* Exploring the files which modify certain parameters
1397* Review of the /proc/sys file tree
1398------------------------------------------------------------------------------
1399
1400
1401A very interesting part of /proc is the directory /proc/sys. This is not only
1402a source of information, it also allows you to change parameters within the
1403kernel. Be very careful when attempting this. You can optimize your system,
1404but you can also cause it to crash. Never alter kernel parameters on a
1405production system. Set up a development machine and test to make sure that
1406everything works the way you want it to. You may have no alternative but to
1407reboot the machine once an error has been made.
1408
1409To change a value, simply echo the new value into the file. An example is
1410given below in the section on the file system data. You need to be root to do
1411this. You can create your own boot script to perform this every time your
1412system boots.
1413
1414The files in /proc/sys can be used to fine tune and monitor miscellaneous and
1415general things in the operation of the Linux kernel. Since some of the files
1416can inadvertently disrupt your system, it is advisable to read both
1417documentation and source before actually making adjustments. In any case, be
1418very careful when writing to any of these files. The entries in /proc may
1419change slightly between the 2.1.* and the 2.2 kernel, so if there is any doubt
1420review the kernel documentation in the directory /usr/src/linux/Documentation.
1421This chapter is heavily based on the documentation included in the pre 2.2
1422kernels, and became part of it in version 2.2.1 of the Linux kernel.
1423
395cf969 1424Please see: Documentation/sysctl/ directory for descriptions of these
db0fb184 1425entries.
9d0243bc 1426
760df93e
SF
1427------------------------------------------------------------------------------
1428Summary
1429------------------------------------------------------------------------------
1430Certain aspects of kernel behavior can be modified at runtime, without the
1431need to recompile the kernel, or even to reboot the system. The files in the
1432/proc/sys tree can not only be read, but also modified. You can use the echo
1433command to write value into these files, thereby changing the default settings
1434of the kernel.
1435------------------------------------------------------------------------------
9d0243bc 1436
760df93e
SF
1437------------------------------------------------------------------------------
1438CHAPTER 3: PER-PROCESS PARAMETERS
1439------------------------------------------------------------------------------
1da177e4 1440
fa0cbbf1 14413.1 /proc/<pid>/oom_adj & /proc/<pid>/oom_score_adj- Adjust the oom-killer score
a63d83f4
DR
1442--------------------------------------------------------------------------------
1443
fa0cbbf1 1444These file can be used to adjust the badness heuristic used to select which
a63d83f4
DR
1445process gets killed in out of memory conditions.
1446
1447The badness heuristic assigns a value to each candidate task ranging from 0
1448(never kill) to 1000 (always kill) to determine which process is targeted. The
1449units are roughly a proportion along that range of allowed memory the process
1450may allocate from based on an estimation of its current memory and swap use.
1451For example, if a task is using all allowed memory, its badness score will be
14521000. If it is using half of its allowed memory, its score will be 500.
1453
778c14af
DR
1454There is an additional factor included in the badness score: the current memory
1455and swap usage is discounted by 3% for root processes.
a63d83f4
DR
1456
1457The amount of "allowed" memory depends on the context in which the oom killer
1458was called. If it is due to the memory assigned to the allocating task's cpuset
1459being exhausted, the allowed memory represents the set of mems assigned to that
1460cpuset. If it is due to a mempolicy's node(s) being exhausted, the allowed
1461memory represents the set of mempolicy nodes. If it is due to a memory
1462limit (or swap limit) being reached, the allowed memory is that configured
1463limit. Finally, if it is due to the entire system being out of memory, the
1464allowed memory represents all allocatable resources.
1465
1466The value of /proc/<pid>/oom_score_adj is added to the badness score before it
1467is used to determine which task to kill. Acceptable values range from -1000
1468(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). This allows userspace to
1469polarize the preference for oom killing either by always preferring a certain
1470task or completely disabling it. The lowest possible value, -1000, is
1471equivalent to disabling oom killing entirely for that task since it will always
1472report a badness score of 0.
1473
1474Consequently, it is very simple for userspace to define the amount of memory to
1475consider for each task. Setting a /proc/<pid>/oom_score_adj value of +500, for
1476example, is roughly equivalent to allowing the remainder of tasks sharing the
1477same system, cpuset, mempolicy, or memory controller resources to use at least
147850% more memory. A value of -500, on the other hand, would be roughly
1479equivalent to discounting 50% of the task's allowed memory from being considered
1480as scoring against the task.
1481
fa0cbbf1
DR
1482For backwards compatibility with previous kernels, /proc/<pid>/oom_adj may also
1483be used to tune the badness score. Its acceptable values range from -16
1484(OOM_ADJUST_MIN) to +15 (OOM_ADJUST_MAX) and a special value of -17
1485(OOM_DISABLE) to disable oom killing entirely for that task. Its value is
1486scaled linearly with /proc/<pid>/oom_score_adj.
1487
dabb16f6
MSB
1488The value of /proc/<pid>/oom_score_adj may be reduced no lower than the last
1489value set by a CAP_SYS_RESOURCE process. To reduce the value any lower
1490requires CAP_SYS_RESOURCE.
1491
a63d83f4 1492Caveat: when a parent task is selected, the oom killer will sacrifice any first
25985edc 1493generation children with separate address spaces instead, if possible. This
a63d83f4
DR
1494avoids servers and important system daemons from being killed and loses the
1495minimal amount of work.
1496
9e9e3cbc 1497
760df93e 14983.2 /proc/<pid>/oom_score - Display current oom-killer score
d7ff0dbf
JFM
1499-------------------------------------------------------------
1500
d7ff0dbf 1501This file can be used to check the current score used by the oom-killer is for
fa0cbbf1
DR
1502any given <pid>. Use it together with /proc/<pid>/oom_score_adj to tune which
1503process should be killed in an out-of-memory situation.
1504
f9c99463 1505
760df93e 15063.3 /proc/<pid>/io - Display the IO accounting fields
f9c99463
RK
1507-------------------------------------------------------
1508
1509This file contains IO statistics for each running process
1510
1511Example
1512-------
1513
1514test:/tmp # dd if=/dev/zero of=/tmp/test.dat &
1515[1] 3828
1516
1517test:/tmp # cat /proc/3828/io
1518rchar: 323934931
1519wchar: 323929600
1520syscr: 632687
1521syscw: 632675
1522read_bytes: 0
1523write_bytes: 323932160
1524cancelled_write_bytes: 0
1525
1526
1527Description
1528-----------
1529
1530rchar
1531-----
1532
1533I/O counter: chars read
1534The number of bytes which this task has caused to be read from storage. This
1535is simply the sum of bytes which this process passed to read() and pread().
1536It includes things like tty IO and it is unaffected by whether or not actual
1537physical disk IO was required (the read might have been satisfied from
1538pagecache)
1539
1540
1541wchar
1542-----
1543
1544I/O counter: chars written
1545The number of bytes which this task has caused, or shall cause to be written
1546to disk. Similar caveats apply here as with rchar.
1547
1548
1549syscr
1550-----
1551
1552I/O counter: read syscalls
1553Attempt to count the number of read I/O operations, i.e. syscalls like read()
1554and pread().
1555
1556
1557syscw
1558-----
1559
1560I/O counter: write syscalls
1561Attempt to count the number of write I/O operations, i.e. syscalls like
1562write() and pwrite().
1563
1564
1565read_bytes
1566----------
1567
1568I/O counter: bytes read
1569Attempt to count the number of bytes which this process really did cause to
1570be fetched from the storage layer. Done at the submit_bio() level, so it is
1571accurate for block-backed filesystems. <please add status regarding NFS and
1572CIFS at a later time>
1573
1574
1575write_bytes
1576-----------
1577
1578I/O counter: bytes written
1579Attempt to count the number of bytes which this process caused to be sent to
1580the storage layer. This is done at page-dirtying time.
1581
1582
1583cancelled_write_bytes
1584---------------------
1585
1586The big inaccuracy here is truncate. If a process writes 1MB to a file and
1587then deletes the file, it will in fact perform no writeout. But it will have
1588been accounted as having caused 1MB of write.
1589In other words: The number of bytes which this process caused to not happen,
1590by truncating pagecache. A task can cause "negative" IO too. If this task
1591truncates some dirty pagecache, some IO which another task has been accounted
a33f3224 1592for (in its write_bytes) will not be happening. We _could_ just subtract that
f9c99463
RK
1593from the truncating task's write_bytes, but there is information loss in doing
1594that.
1595
1596
1597Note
1598----
1599
1600At its current implementation state, this is a bit racy on 32-bit machines: if
1601process A reads process B's /proc/pid/io while process B is updating one of
1602those 64-bit counters, process A could see an intermediate result.
1603
1604
1605More information about this can be found within the taskstats documentation in
1606Documentation/accounting.
1607
760df93e 16083.4 /proc/<pid>/coredump_filter - Core dump filtering settings
bb90110d
KH
1609---------------------------------------------------------------
1610When a process is dumped, all anonymous memory is written to a core file as
1611long as the size of the core file isn't limited. But sometimes we don't want
5037835c
RZ
1612to dump some memory segments, for example, huge shared memory or DAX.
1613Conversely, sometimes we want to save file-backed memory segments into a core
1614file, not only the individual files.
bb90110d
KH
1615
1616/proc/<pid>/coredump_filter allows you to customize which memory segments
1617will be dumped when the <pid> process is dumped. coredump_filter is a bitmask
1618of memory types. If a bit of the bitmask is set, memory segments of the
1619corresponding memory type are dumped, otherwise they are not dumped.
1620
5037835c 1621The following 9 memory types are supported:
bb90110d
KH
1622 - (bit 0) anonymous private memory
1623 - (bit 1) anonymous shared memory
1624 - (bit 2) file-backed private memory
1625 - (bit 3) file-backed shared memory
b261dfea
HK
1626 - (bit 4) ELF header pages in file-backed private memory areas (it is
1627 effective only if the bit 2 is cleared)
e575f111
KM
1628 - (bit 5) hugetlb private memory
1629 - (bit 6) hugetlb shared memory
5037835c
RZ
1630 - (bit 7) DAX private memory
1631 - (bit 8) DAX shared memory
bb90110d
KH
1632
1633 Note that MMIO pages such as frame buffer are never dumped and vDSO pages
1634 are always dumped regardless of the bitmask status.
1635
5037835c
RZ
1636 Note that bits 0-4 don't affect hugetlb or DAX memory. hugetlb memory is
1637 only affected by bit 5-6, and DAX is only affected by bits 7-8.
e575f111 1638
5037835c
RZ
1639The default value of coredump_filter is 0x33; this means all anonymous memory
1640segments, ELF header pages and hugetlb private memory are dumped.
bb90110d
KH
1641
1642If you don't want to dump all shared memory segments attached to pid 1234,
5037835c 1643write 0x31 to the process's proc file.
bb90110d 1644
5037835c 1645 $ echo 0x31 > /proc/1234/coredump_filter
bb90110d
KH
1646
1647When a new process is created, the process inherits the bitmask status from its
1648parent. It is useful to set up coredump_filter before the program runs.
1649For example:
1650
1651 $ echo 0x7 > /proc/self/coredump_filter
1652 $ ./some_program
1653
760df93e 16543.5 /proc/<pid>/mountinfo - Information about mounts
2d4d4864
RP
1655--------------------------------------------------------
1656
1657This file contains lines of the form:
1658
165936 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue
1660(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)
1661
1662(1) mount ID: unique identifier of the mount (may be reused after umount)
1663(2) parent ID: ID of parent (or of self for the top of the mount tree)
1664(3) major:minor: value of st_dev for files on filesystem
1665(4) root: root of the mount within the filesystem
1666(5) mount point: mount point relative to the process's root
1667(6) mount options: per mount options
1668(7) optional fields: zero or more fields of the form "tag[:value]"
1669(8) separator: marks the end of the optional fields
1670(9) filesystem type: name of filesystem of the form "type[.subtype]"
1671(10) mount source: filesystem specific information or "none"
1672(11) super options: per super block options
1673
1674Parsers should ignore all unrecognised optional fields. Currently the
1675possible optional fields are:
1676
1677shared:X mount is shared in peer group X
1678master:X mount is slave to peer group X
97e7e0f7 1679propagate_from:X mount is slave and receives propagation from peer group X (*)
2d4d4864
RP
1680unbindable mount is unbindable
1681
97e7e0f7
MS
1682(*) X is the closest dominant peer group under the process's root. If
1683X is the immediate master of the mount, or if there's no dominant peer
1684group under the same root, then only the "master:X" field is present
1685and not the "propagate_from:X" field.
1686
2d4d4864
RP
1687For more information on mount propagation see:
1688
1689 Documentation/filesystems/sharedsubtree.txt
1690
4614a696
JS
1691
16923.6 /proc/<pid>/comm & /proc/<pid>/task/<tid>/comm
1693--------------------------------------------------------
1694These files provide a method to access a tasks comm value. It also allows for
1695a task to set its own or one of its thread siblings comm value. The comm value
1696is limited in size compared to the cmdline value, so writing anything longer
1697then the kernel's TASK_COMM_LEN (currently 16 chars) will result in a truncated
1698comm value.
0499680a
VK
1699
1700
81841161
CG
17013.7 /proc/<pid>/task/<tid>/children - Information about task children
1702-------------------------------------------------------------------------
1703This file provides a fast way to retrieve first level children pids
1704of a task pointed by <pid>/<tid> pair. The format is a space separated
1705stream of pids.
1706
1707Note the "first level" here -- if a child has own children they will
1708not be listed here, one needs to read /proc/<children-pid>/task/<tid>/children
1709to obtain the descendants.
1710
1711Since this interface is intended to be fast and cheap it doesn't
1712guarantee to provide precise results and some children might be
1713skipped, especially if they've exited right after we printed their
1714pids, so one need to either stop or freeze processes being inspected
1715if precise results are needed.
1716
1717
49d063cb 17183.8 /proc/<pid>/fdinfo/<fd> - Information about opened file
f1d8c162
CG
1719---------------------------------------------------------------
1720This file provides information associated with an opened file. The regular
49d063cb
AV
1721files have at least three fields -- 'pos', 'flags' and mnt_id. The 'pos'
1722represents the current offset of the opened file in decimal form [see lseek(2)
1723for details], 'flags' denotes the octal O_xxx mask the file has been
1724created with [see open(2) for details] and 'mnt_id' represents mount ID of
1725the file system containing the opened file [see 3.5 /proc/<pid>/mountinfo
1726for details].
f1d8c162
CG
1727
1728A typical output is
1729
1730 pos: 0
1731 flags: 0100002
49d063cb 1732 mnt_id: 19
f1d8c162 1733
6c8c9031
AV
1734All locks associated with a file descriptor are shown in its fdinfo too.
1735
1736lock: 1: FLOCK ADVISORY WRITE 359 00:13:11691 0 EOF
1737
f1d8c162
CG
1738The files such as eventfd, fsnotify, signalfd, epoll among the regular pos/flags
1739pair provide additional information particular to the objects they represent.
1740
1741 Eventfd files
1742 ~~~~~~~~~~~~~
1743 pos: 0
1744 flags: 04002
49d063cb 1745 mnt_id: 9
f1d8c162
CG
1746 eventfd-count: 5a
1747
1748 where 'eventfd-count' is hex value of a counter.
1749
1750 Signalfd files
1751 ~~~~~~~~~~~~~~
1752 pos: 0
1753 flags: 04002
49d063cb 1754 mnt_id: 9
f1d8c162
CG
1755 sigmask: 0000000000000200
1756
1757 where 'sigmask' is hex value of the signal mask associated
1758 with a file.
1759
1760 Epoll files
1761 ~~~~~~~~~~~
1762 pos: 0
1763 flags: 02
49d063cb 1764 mnt_id: 9
f1d8c162
CG
1765 tfd: 5 events: 1d data: ffffffffffffffff
1766
1767 where 'tfd' is a target file descriptor number in decimal form,
1768 'events' is events mask being watched and the 'data' is data
1769 associated with a target [see epoll(7) for more details].
1770
1771 Fsnotify files
1772 ~~~~~~~~~~~~~~
1773 For inotify files the format is the following
1774
1775 pos: 0
1776 flags: 02000000
1777 inotify wd:3 ino:9e7e sdev:800013 mask:800afce ignored_mask:0 fhandle-bytes:8 fhandle-type:1 f_handle:7e9e0000640d1b6d
1778
1779 where 'wd' is a watch descriptor in decimal form, ie a target file
1780 descriptor number, 'ino' and 'sdev' are inode and device where the
1781 target file resides and the 'mask' is the mask of events, all in hex
1782 form [see inotify(7) for more details].
1783
1784 If the kernel was built with exportfs support, the path to the target
1785 file is encoded as a file handle. The file handle is provided by three
1786 fields 'fhandle-bytes', 'fhandle-type' and 'f_handle', all in hex
1787 format.
1788
1789 If the kernel is built without exportfs support the file handle won't be
1790 printed out.
1791
e71ec593 1792 If there is no inotify mark attached yet the 'inotify' line will be omitted.
f1d8c162 1793
e71ec593 1794 For fanotify files the format is
f1d8c162
CG
1795
1796 pos: 0
1797 flags: 02
49d063cb 1798 mnt_id: 9
e71ec593
CG
1799 fanotify flags:10 event-flags:0
1800 fanotify mnt_id:12 mflags:40 mask:38 ignored_mask:40000003
1801 fanotify ino:4f969 sdev:800013 mflags:0 mask:3b ignored_mask:40000000 fhandle-bytes:8 fhandle-type:1 f_handle:69f90400c275b5b4
1802
1803 where fanotify 'flags' and 'event-flags' are values used in fanotify_init
1804 call, 'mnt_id' is the mount point identifier, 'mflags' is the value of
1805 flags associated with mark which are tracked separately from events
1806 mask. 'ino', 'sdev' are target inode and device, 'mask' is the events
1807 mask and 'ignored_mask' is the mask of events which are to be ignored.
1808 All in hex format. Incorporation of 'mflags', 'mask' and 'ignored_mask'
1809 does provide information about flags and mask used in fanotify_mark
1810 call [see fsnotify manpage for details].
1811
1812 While the first three lines are mandatory and always printed, the rest is
1813 optional and may be omitted if no marks created yet.
f1d8c162 1814
854d06d9
CG
1815 Timerfd files
1816 ~~~~~~~~~~~~~
1817
1818 pos: 0
1819 flags: 02
1820 mnt_id: 9
1821 clockid: 0
1822 ticks: 0
1823 settime flags: 01
1824 it_value: (0, 49406829)
1825 it_interval: (1, 0)
1826
1827 where 'clockid' is the clock type and 'ticks' is the number of the timer expirations
1828 that have occurred [see timerfd_create(2) for details]. 'settime flags' are
1829 flags in octal form been used to setup the timer [see timerfd_settime(2) for
1830 details]. 'it_value' is remaining time until the timer exiration.
1831 'it_interval' is the interval for the timer. Note the timer might be set up
1832 with TIMER_ABSTIME option which will be shown in 'settime flags', but 'it_value'
1833 still exhibits timer's remaining time.
f1d8c162 1834
740a5ddb
CG
18353.9 /proc/<pid>/map_files - Information about memory mapped files
1836---------------------------------------------------------------------
1837This directory contains symbolic links which represent memory mapped files
1838the process is maintaining. Example output:
1839
1840 | lr-------- 1 root root 64 Jan 27 11:24 333c600000-333c620000 -> /usr/lib64/ld-2.18.so
1841 | lr-------- 1 root root 64 Jan 27 11:24 333c81f000-333c820000 -> /usr/lib64/ld-2.18.so
1842 | lr-------- 1 root root 64 Jan 27 11:24 333c820000-333c821000 -> /usr/lib64/ld-2.18.so
1843 | ...
1844 | lr-------- 1 root root 64 Jan 27 11:24 35d0421000-35d0422000 -> /usr/lib64/libselinux.so.1
1845 | lr-------- 1 root root 64 Jan 27 11:24 400000-41a000 -> /usr/bin/ls
1846
1847The name of a link represents the virtual memory bounds of a mapping, i.e.
1848vm_area_struct::vm_start-vm_area_struct::vm_end.
1849
1850The main purpose of the map_files is to retrieve a set of memory mapped
1851files in a fast way instead of parsing /proc/<pid>/maps or
1852/proc/<pid>/smaps, both of which contain many more records. At the same
1853time one can open(2) mappings from the listings of two processes and
1854comparing their inode numbers to figure out which anonymous memory areas
1855are actually shared.
1856
0499680a
VK
1857------------------------------------------------------------------------------
1858Configuring procfs
1859------------------------------------------------------------------------------
1860
18614.1 Mount options
1862---------------------
1863
1864The following mount options are supported:
1865
1866 hidepid= Set /proc/<pid>/ access mode.
1867 gid= Set the group authorized to learn processes information.
1868
1869hidepid=0 means classic mode - everybody may access all /proc/<pid>/ directories
1870(default).
1871
1872hidepid=1 means users may not access any /proc/<pid>/ directories but their
1873own. Sensitive files like cmdline, sched*, status are now protected against
1874other users. This makes it impossible to learn whether any user runs
1875specific program (given the program doesn't reveal itself by its behaviour).
1876As an additional bonus, as /proc/<pid>/cmdline is unaccessible for other users,
1877poorly written programs passing sensitive information via program arguments are
1878now protected against local eavesdroppers.
1879
1880hidepid=2 means hidepid=1 plus all /proc/<pid>/ will be fully invisible to other
1881users. It doesn't mean that it hides a fact whether a process with a specific
1882pid value exists (it can be learned by other means, e.g. by "kill -0 $PID"),
1883but it hides process' uid and gid, which may be learned by stat()'ing
1884/proc/<pid>/ otherwise. It greatly complicates an intruder's task of gathering
1885information about running processes, whether some daemon runs with elevated
1886privileges, whether other user runs some sensitive program, whether other users
1887run any program at all, etc.
1888
1889gid= defines a group authorized to learn processes information otherwise
1890prohibited by hidepid=. If you use some daemon like identd which needs to learn
1891information about processes information, just add identd to this group.