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