blob: e2ecf248feb5b1531b9a743ca688846acfe4376e [file] [log] [blame]
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001.. SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01003====================
4The /proc Filesystem
5====================
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01007===================== ======================================= ================
8/proc/sys Terrehon Bowden <terrehon@pacbell.net>, October 7 1999
9 Bodo Bauer <bb@ricochet.net>
102.4.x update Jorge Nerin <comandante@zaralinux.com> November 14 2000
11move /proc/sys Shen Feng <shen@cn.fujitsu.com> April 1 2009
12fixes/update part 1.1 Stefani Seibold <stefani@seibold.net> June 9 2009
13===================== ======================================= ================
14
15
16
17.. Table of Contents
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19 0 Preface
20 0.1 Introduction/Credits
21 0.2 Legal Stuff
22
23 1 Collecting System Information
24 1.1 Process-Specific Subdirectories
25 1.2 Kernel data
26 1.3 IDE devices in /proc/ide
27 1.4 Networking info in /proc/net
28 1.5 SCSI info
29 1.6 Parallel port info in /proc/parport
30 1.7 TTY info in /proc/tty
31 1.8 Miscellaneous kernel statistics in /proc/stat
Trace Pillarsae96b342015-01-23 11:45:05 -050032 1.9 Ext4 file system parameters
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34 2 Modifying System Parameters
Shen Feng760df932009-04-02 16:57:20 -070035
36 3 Per-Process Parameters
David Rientjesfa0cbbf2012-11-12 17:53:04 -080037 3.1 /proc/<pid>/oom_adj & /proc/<pid>/oom_score_adj - Adjust the oom-killer
David Rientjesa63d83f2010-08-09 17:19:46 -070038 score
Shen Feng760df932009-04-02 16:57:20 -070039 3.2 /proc/<pid>/oom_score - Display current oom-killer score
40 3.3 /proc/<pid>/io - Display the IO accounting fields
41 3.4 /proc/<pid>/coredump_filter - Core dump filtering settings
42 3.5 /proc/<pid>/mountinfo - Information about mounts
john stultz4614a696b2009-12-14 18:00:05 -080043 3.6 /proc/<pid>/comm & /proc/<pid>/task/<tid>/comm
Cyrill Gorcunov818411612012-05-31 16:26:43 -070044 3.7 /proc/<pid>/task/<tid>/children - Information about task children
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -080045 3.8 /proc/<pid>/fdinfo/<fd> - Information about opened file
Cyrill Gorcunov740a5dd2015-02-11 15:28:31 -080046 3.9 /proc/<pid>/map_files - Information about memory mapped files
John Stultz5de23d42016-03-17 14:20:54 -070047 3.10 /proc/<pid>/timerslack_ns - Task timerslack value
Josh Poimboeuf7c23b332017-02-13 19:42:41 -060048 3.11 /proc/<pid>/patch_state - Livepatch patch operation state
Aubrey Li711486f2019-06-06 09:22:36 +080049 3.12 /proc/<pid>/arch_status - Task architecture specific information
Shen Feng760df932009-04-02 16:57:20 -070050
Vasiliy Kulikov04996802012-01-10 15:11:31 -080051 4 Configuring procfs
52 4.1 Mount options
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Alexey Gladkov37e76472020-04-19 16:10:55 +020054 5 Filesystem behavior
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056Preface
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +010057=======
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
590.1 Introduction/Credits
60------------------------
61
62This documentation is part of a soon (or so we hope) to be released book on
63the SuSE Linux distribution. As there is no complete documentation for the
64/proc file system and we've used many freely available sources to write these
65chapters, it seems only fair to give the work back to the Linux community.
66This work is based on the 2.2.* kernel version and the upcoming 2.4.*. I'm
67afraid it's still far from complete, but we hope it will be useful. As far as
68we know, it is the first 'all-in-one' document about the /proc file system. It
69is focused on the Intel x86 hardware, so if you are looking for PPC, ARM,
70SPARC, AXP, etc., features, you probably won't find what you are looking for.
71It also only covers IPv4 networking, not IPv6 nor other protocols - sorry. But
72additions and patches are welcome and will be added to this document if you
73mail them to Bodo.
74
75We'd like to thank Alan Cox, Rik van Riel, and Alexey Kuznetsov and a lot of
76other people for help compiling this documentation. We'd also like to extend a
77special thank you to Andi Kleen for documentation, which we relied on heavily
78to create this document, as well as the additional information he provided.
79Thanks to everybody else who contributed source or docs to the Linux kernel
80and helped create a great piece of software... :)
81
82If you have any comments, corrections or additions, please don't hesitate to
83contact Bodo Bauer at bb@ricochet.net. We'll be happy to add them to this
84document.
85
86The latest version of this document is available online at
Justin P. Mattock0ea6e612010-07-23 20:51:24 -070087http://tldp.org/LDP/Linux-Filesystem-Hierarchy/html/proc.html
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Justin P. Mattock0ea6e612010-07-23 20:51:24 -070089If the above direction does not works for you, you could try the kernel
Linus Torvalds1da177e2005-04-16 15:20:36 -070090mailing list at linux-kernel@vger.kernel.org and/or try to reach me at
91comandante@zaralinux.com.
92
930.2 Legal Stuff
94---------------
95
96We don't guarantee the correctness of this document, and if you come to us
97complaining about how you screwed up your system because of incorrect
98documentation, we won't feel responsible...
99
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100100Chapter 1: Collecting System Information
101========================================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103In This Chapter
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100104---------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105* Investigating the properties of the pseudo file system /proc and its
106 ability to provide information on the running Linux system
107* Examining /proc's structure
108* Uncovering various information about the kernel and the processes running
109 on the system
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100111------------------------------------------------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113The proc file system acts as an interface to internal data structures in the
114kernel. It can be used to obtain information about the system and to change
115certain kernel parameters at runtime (sysctl).
116
117First, we'll take a look at the read-only parts of /proc. In Chapter 2, we
118show you how you can use /proc/sys to change settings.
119
1201.1 Process-Specific Subdirectories
121-----------------------------------
122
123The directory /proc contains (among other things) one subdirectory for each
124process running on the system, which is named after the process ID (PID).
125
126The link self points to the process reading the file system. Each process
127subdirectory has the entries listed in Table 1-1.
128
Daniel Colascionec969eb82018-11-05 13:22:05 +0000129Note that an open a file descriptor to /proc/<pid> or to any of its
130contained files or subdirectories does not prevent <pid> being reused
131for some other process in the event that <pid> exits. Operations on
132open /proc/<pid> file descriptors corresponding to dead processes
133never act on any new process that the kernel may, through chance, have
134also assigned the process ID <pid>. Instead, operations on these FDs
135usually fail with ESRCH.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100137.. table:: Table 1-1: Process specific entries in /proc
138
139 ============= ===============================================================
David Rientjesb813e932007-05-06 14:49:24 -0700140 File Content
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100141 ============= ===============================================================
David Rientjesb813e932007-05-06 14:49:24 -0700142 clear_refs Clears page referenced bits shown in smaps output
143 cmdline Command line arguments
144 cpu Current and last cpu in which it was executed (2.4)(smp)
145 cwd Link to the current working directory
146 environ Values of environment variables
147 exe Link to the executable of this process
148 fd Directory, which contains all file descriptors
149 maps Memory maps to executables and library files (2.4)
150 mem Memory held by this process
151 root Link to the root directory of this process
152 stat Process status
153 statm Process memory status information
154 status Process status in human readable form
Ingo Molnarb2f73922015-09-30 15:59:17 +0200155 wchan Present with CONFIG_KALLSYMS=y: it shows the kernel function
156 symbol the task is blocked in - or "0" if not blocked.
Nikanth Karthikesan03f890f2010-10-27 15:34:11 -0700157 pagemap Page table
Ken Chen2ec220e2008-11-10 11:26:08 +0300158 stack Report full stack trace, enable via CONFIG_STACKTRACE
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700159 smaps An extension based on maps, showing the memory consumption of
Cyrill Gorcunov834f82e2012-12-17 16:03:13 -0800160 each mapping and flags associated with it
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700161 smaps_rollup Accumulated smaps stats for all mappings of the process. This
162 can be derived from smaps, but is faster and more convenient
163 numa_maps An extension based on maps, showing the memory locality and
Rafael Aquini0c369712015-02-12 15:01:05 -0800164 binding policy as well as mem usage (in pages) of each mapping.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100165 ============= ===============================================================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167For example, to get the status information of a process, all you have to do is
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100168read the file /proc/PID/status::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Stefani Seibold349888e2009-06-17 16:26:01 -0700170 >cat /proc/self/status
171 Name: cat
172 State: R (running)
173 Tgid: 5452
174 Pid: 5452
175 PPid: 743
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 TracerPid: 0 (2.4)
Stefani Seibold349888e2009-06-17 16:26:01 -0700177 Uid: 501 501 501 501
178 Gid: 100 100 100 100
179 FDSize: 256
180 Groups: 100 14 16
181 VmPeak: 5004 kB
182 VmSize: 5004 kB
183 VmLck: 0 kB
184 VmHWM: 476 kB
185 VmRSS: 476 kB
Jerome Marchand8cee8522016-01-14 15:19:29 -0800186 RssAnon: 352 kB
187 RssFile: 120 kB
188 RssShmem: 4 kB
Stefani Seibold349888e2009-06-17 16:26:01 -0700189 VmData: 156 kB
190 VmStk: 88 kB
191 VmExe: 68 kB
192 VmLib: 1412 kB
193 VmPTE: 20 kb
KAMEZAWA Hiroyukib084d432010-03-05 13:41:42 -0800194 VmSwap: 0 kB
Naoya Horiguchi5d317b22015-11-05 18:47:14 -0800195 HugetlbPages: 0 kB
Roman Gushchinc6434012017-11-17 15:26:45 -0800196 CoreDumping: 0
Michal Hockoa1400af2018-12-28 00:38:25 -0800197 THP_enabled: 1
Stefani Seibold349888e2009-06-17 16:26:01 -0700198 Threads: 1
199 SigQ: 0/28578
200 SigPnd: 0000000000000000
201 ShdPnd: 0000000000000000
202 SigBlk: 0000000000000000
203 SigIgn: 0000000000000000
204 SigCgt: 0000000000000000
205 CapInh: 00000000fffffeff
206 CapPrm: 0000000000000000
207 CapEff: 0000000000000000
208 CapBnd: ffffffffffffffff
Waiman Longf8d0dc22018-10-23 17:25:51 -0400209 CapAmb: 0000000000000000
Kees Cookaf884cd2016-12-12 16:45:05 -0800210 NoNewPrivs: 0
Kees Cook2f4b3bf2012-12-17 16:03:14 -0800211 Seccomp: 0
Waiman Longf8d0dc22018-10-23 17:25:51 -0400212 Speculation_Store_Bypass: thread vulnerable
Stefani Seibold349888e2009-06-17 16:26:01 -0700213 voluntary_ctxt_switches: 0
214 nonvoluntary_ctxt_switches: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216This shows you nearly the same information you would get if you viewed it with
217the ps command. In fact, ps uses the proc file system to obtain its
Stefani Seibold349888e2009-06-17 16:26:01 -0700218information. But you get a more detailed view of the process by reading the
219file /proc/PID/status. It fields are described in table 1-2.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Stefani Seibold349888e2009-06-17 16:26:01 -0700221The statm file contains more detailed information about the process
222memory usage. Its seven fields are explained in Table 1-3. The stat file
223contains details information about the process itself. Its fields are
224explained in Table 1-4.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
KAMEZAWA Hiroyuki34e55232010-03-05 13:41:40 -0800226(for SMP CONFIG users)
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100227
Nathan Scott15eb42d2015-04-16 12:49:35 -0700228For making accounting scalable, RSS related information are handled in an
229asynchronous manner and the value may not be very precise. To see a precise
KAMEZAWA Hiroyuki34e55232010-03-05 13:41:40 -0800230snapshot of a moment, you can see /proc/<pid>/smaps file and scan page table.
231It's slow but very precise.
232
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100233.. table:: Table 1-2: Contents of the status files (as of 4.19)
234
235 ========================== ===================================================
Stefani Seibold349888e2009-06-17 16:26:01 -0700236 Field Content
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100237 ========================== ===================================================
Stefani Seibold349888e2009-06-17 16:26:01 -0700238 Name filename of the executable
Fabian Frederickbbd88e12017-01-24 15:18:13 -0800239 Umask file mode creation mask
Stefani Seibold349888e2009-06-17 16:26:01 -0700240 State state (R is running, S is sleeping, D is sleeping
241 in an uninterruptible wait, Z is zombie,
242 T is traced or stopped)
243 Tgid thread group ID
Nathan Scott15eb42d2015-04-16 12:49:35 -0700244 Ngid NUMA group ID (0 if none)
Stefani Seibold349888e2009-06-17 16:26:01 -0700245 Pid process id
246 PPid process id of the parent process
247 TracerPid PID of process tracing this process (0 if not)
248 Uid Real, effective, saved set, and file system UIDs
249 Gid Real, effective, saved set, and file system GIDs
250 FDSize number of file descriptor slots currently allocated
251 Groups supplementary group list
Nathan Scott15eb42d2015-04-16 12:49:35 -0700252 NStgid descendant namespace thread group ID hierarchy
253 NSpid descendant namespace process ID hierarchy
254 NSpgid descendant namespace process group ID hierarchy
255 NSsid descendant namespace session ID hierarchy
Stefani Seibold349888e2009-06-17 16:26:01 -0700256 VmPeak peak virtual memory size
257 VmSize total program size
258 VmLck locked memory size
Fabian Frederickbbd88e12017-01-24 15:18:13 -0800259 VmPin pinned memory size
Stefani Seibold349888e2009-06-17 16:26:01 -0700260 VmHWM peak resident set size ("high water mark")
Jerome Marchand8cee8522016-01-14 15:19:29 -0800261 VmRSS size of memory portions. It contains the three
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100262 following parts
263 (VmRSS = RssAnon + RssFile + RssShmem)
Jerome Marchand8cee8522016-01-14 15:19:29 -0800264 RssAnon size of resident anonymous memory
265 RssFile size of resident file mappings
266 RssShmem size of resident shmem memory (includes SysV shm,
267 mapping of tmpfs and shared anonymous mappings)
Konstantin Khlebnikov30bdbb72016-02-02 16:57:46 -0800268 VmData size of private data segments
269 VmStk size of stack segments
Stefani Seibold349888e2009-06-17 16:26:01 -0700270 VmExe size of text segment
271 VmLib size of shared library code
272 VmPTE size of page table entries
Vlastimil Babkabf9683d2016-01-14 15:19:14 -0800273 VmSwap amount of swap used by anonymous private data
274 (shmem swap usage is not included)
Naoya Horiguchi5d317b22015-11-05 18:47:14 -0800275 HugetlbPages size of hugetlb memory portions
Roman Gushchinc6434012017-11-17 15:26:45 -0800276 CoreDumping process's memory is currently being dumped
277 (killing the process may lead to a corrupted core)
Michal Hockoa1400af2018-12-28 00:38:25 -0800278 THP_enabled process is allowed to use THP (returns 0 when
279 PR_SET_THP_DISABLE is set on the process
Stefani Seibold349888e2009-06-17 16:26:01 -0700280 Threads number of threads
281 SigQ number of signals queued/max. number for queue
282 SigPnd bitmap of pending signals for the thread
283 ShdPnd bitmap of shared pending signals for the process
284 SigBlk bitmap of blocked signals
285 SigIgn bitmap of ignored signals
Carlos Garciac98be0c2014-04-04 22:31:00 -0400286 SigCgt bitmap of caught signals
Stefani Seibold349888e2009-06-17 16:26:01 -0700287 CapInh bitmap of inheritable capabilities
288 CapPrm bitmap of permitted capabilities
289 CapEff bitmap of effective capabilities
290 CapBnd bitmap of capabilities bounding set
Waiman Longf8d0dc22018-10-23 17:25:51 -0400291 CapAmb bitmap of ambient capabilities
Kees Cookaf884cd2016-12-12 16:45:05 -0800292 NoNewPrivs no_new_privs, like prctl(PR_GET_NO_NEW_PRIV, ...)
Kees Cook2f4b3bf2012-12-17 16:03:14 -0800293 Seccomp seccomp mode, like prctl(PR_GET_SECCOMP, ...)
Waiman Longf8d0dc22018-10-23 17:25:51 -0400294 Speculation_Store_Bypass speculative store bypass mitigation status
Stefani Seibold349888e2009-06-17 16:26:01 -0700295 Cpus_allowed mask of CPUs on which this process may run
296 Cpus_allowed_list Same as previous, but in "list format"
297 Mems_allowed mask of memory nodes allowed to this process
298 Mems_allowed_list Same as previous, but in "list format"
299 voluntary_ctxt_switches number of voluntary context switches
300 nonvoluntary_ctxt_switches number of non voluntary context switches
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100301 ========================== ===================================================
Stefani Seibold349888e2009-06-17 16:26:01 -0700302
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100303
304.. table:: Table 1-3: Contents of the statm files (as of 2.6.8-rc3)
305
306 ======== =============================== ==============================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 Field Content
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100308 ======== =============================== ==============================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 size total program size (pages) (same as VmSize in status)
310 resident size of memory portions (pages) (same as VmRSS in status)
Jerome Marchand8cee8522016-01-14 15:19:29 -0800311 shared number of pages that are shared (i.e. backed by a file, same
312 as RssFile+RssShmem in status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 trs number of pages that are 'code' (not including libs; broken,
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100314 includes data segment)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 lrs number of pages of library (always 0 on 2.6)
316 drs number of pages of data/stack (including libs; broken,
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100317 includes library text)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 dt number of dirty pages (always 0 on 2.6)
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100319 ======== =============================== ==============================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Kees Cook18d96772007-07-15 23:40:38 -0700321
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100322.. table:: Table 1-4: Contents of the stat files (as of 2.6.30-rc7)
323
324 ============= ===============================================================
325 Field Content
326 ============= ===============================================================
Kees Cook18d96772007-07-15 23:40:38 -0700327 pid process id
328 tcomm filename of the executable
329 state state (R is running, S is sleeping, D is sleeping in an
330 uninterruptible wait, Z is zombie, T is traced or stopped)
331 ppid process id of the parent process
332 pgrp pgrp of the process
333 sid session id
334 tty_nr tty the process uses
335 tty_pgrp pgrp of the tty
336 flags task flags
337 min_flt number of minor faults
338 cmin_flt number of minor faults with child's
339 maj_flt number of major faults
340 cmaj_flt number of major faults with child's
341 utime user mode jiffies
342 stime kernel mode jiffies
343 cutime user mode jiffies with child's
344 cstime kernel mode jiffies with child's
345 priority priority level
346 nice nice level
347 num_threads number of threads
Leonardo Chiquitto2e01e002008-02-03 16:17:16 +0200348 it_real_value (obsolete, always 0)
Kees Cook18d96772007-07-15 23:40:38 -0700349 start_time time the process started after system boot
350 vsize virtual memory size
351 rss resident set memory size
352 rsslim current limit in bytes on the rss
353 start_code address above which program text can run
354 end_code address below which program text can run
Siddhesh Poyarekarb7643752012-03-21 16:34:04 -0700355 start_stack address of the start of the main process stack
Kees Cook18d96772007-07-15 23:40:38 -0700356 esp current value of ESP
357 eip current value of EIP
Stefani Seibold349888e2009-06-17 16:26:01 -0700358 pending bitmap of pending signals
359 blocked bitmap of blocked signals
360 sigign bitmap of ignored signals
Carlos Garciac98be0c2014-04-04 22:31:00 -0400361 sigcatch bitmap of caught signals
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100362 0 (place holder, used to be the wchan address,
363 use /proc/PID/wchan instead)
Kees Cook18d96772007-07-15 23:40:38 -0700364 0 (place holder)
365 0 (place holder)
366 exit_signal signal to send to parent thread on exit
367 task_cpu which CPU the task is scheduled on
368 rt_priority realtime priority
369 policy scheduling policy (man sched_setscheduler)
370 blkio_ticks time spent waiting for block IO
Stefani Seibold349888e2009-06-17 16:26:01 -0700371 gtime guest time of the task in jiffies
372 cgtime guest time of the task children in jiffies
Cyrill Gorcunovb3f7f572012-01-12 17:20:53 -0800373 start_data address above which program data+bss is placed
374 end_data address below which program data+bss is placed
375 start_brk address above which program heap can be expanded with brk()
Cyrill Gorcunov5b172082012-05-31 16:26:44 -0700376 arg_start address above which program command line is placed
377 arg_end address below which program command line is placed
378 env_start address above which program environment is placed
379 env_end address below which program environment is placed
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100380 exit_code the thread's exit_code in the form reported by the waitpid
381 system call
382 ============= ===============================================================
Kees Cook18d96772007-07-15 23:40:38 -0700383
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700384The /proc/PID/maps file contains the currently mapped memory regions and
Stefani Seibold349888e2009-06-17 16:26:01 -0700385their access permissions.
386
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100387The format is::
Stefani Seibold349888e2009-06-17 16:26:01 -0700388
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100389 address perms offset dev inode pathname
Stefani Seibold349888e2009-06-17 16:26:01 -0700390
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100391 08048000-08049000 r-xp 00000000 03:00 8312 /opt/test
392 08049000-0804a000 rw-p 00001000 03:00 8312 /opt/test
393 0804a000-0806b000 rw-p 00000000 00:00 0 [heap]
394 a7cb1000-a7cb2000 ---p 00000000 00:00 0
395 a7cb2000-a7eb2000 rw-p 00000000 00:00 0
396 a7eb2000-a7eb3000 ---p 00000000 00:00 0
397 a7eb3000-a7ed5000 rw-p 00000000 00:00 0
398 a7ed5000-a8008000 r-xp 00000000 03:00 4222 /lib/libc.so.6
399 a8008000-a800a000 r--p 00133000 03:00 4222 /lib/libc.so.6
400 a800a000-a800b000 rw-p 00135000 03:00 4222 /lib/libc.so.6
401 a800b000-a800e000 rw-p 00000000 00:00 0
402 a800e000-a8022000 r-xp 00000000 03:00 14462 /lib/libpthread.so.0
403 a8022000-a8023000 r--p 00013000 03:00 14462 /lib/libpthread.so.0
404 a8023000-a8024000 rw-p 00014000 03:00 14462 /lib/libpthread.so.0
405 a8024000-a8027000 rw-p 00000000 00:00 0
406 a8027000-a8043000 r-xp 00000000 03:00 8317 /lib/ld-linux.so.2
407 a8043000-a8044000 r--p 0001b000 03:00 8317 /lib/ld-linux.so.2
408 a8044000-a8045000 rw-p 0001c000 03:00 8317 /lib/ld-linux.so.2
409 aff35000-aff4a000 rw-p 00000000 00:00 0 [stack]
410 ffffe000-fffff000 r-xp 00000000 00:00 0 [vdso]
Stefani Seibold349888e2009-06-17 16:26:01 -0700411
412where "address" is the address space in the process that it occupies, "perms"
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100413is a set of permissions::
Stefani Seibold349888e2009-06-17 16:26:01 -0700414
415 r = read
416 w = write
417 x = execute
418 s = shared
419 p = private (copy on write)
420
421"offset" is the offset into the mapping, "dev" is the device (major:minor), and
422"inode" is the inode on that device. 0 indicates that no inode is associated
423with the memory region, as the case would be with BSS (uninitialized data).
424The "pathname" shows the name associated file for this mapping. If the mapping
425is not associated with a file:
426
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100427 ======= ====================================
428 [heap] the heap of the program
429 [stack] the stack of the main process
430 [vdso] the "virtual dynamic shared object",
Stefani Seibold349888e2009-06-17 16:26:01 -0700431 the kernel system call handler
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100432 ======= ====================================
Stefani Seibold349888e2009-06-17 16:26:01 -0700433
434 or if empty, the mapping is anonymous.
435
Stefani Seibold349888e2009-06-17 16:26:01 -0700436The /proc/PID/smaps is an extension based on maps, showing the memory
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700437consumption for each of the process's mappings. For each mapping (aka Virtual
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100438Memory Area, or VMA) there is a series of lines such as the following::
Stefani Seibold349888e2009-06-17 16:26:01 -0700439
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100440 08048000-080bc000 r-xp 00000000 03:02 13130 /bin/bash
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700441
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100442 Size: 1084 kB
443 KernelPageSize: 4 kB
444 MMUPageSize: 4 kB
445 Rss: 892 kB
446 Pss: 374 kB
447 Shared_Clean: 892 kB
448 Shared_Dirty: 0 kB
449 Private_Clean: 0 kB
450 Private_Dirty: 0 kB
451 Referenced: 892 kB
452 Anonymous: 0 kB
453 LazyFree: 0 kB
454 AnonHugePages: 0 kB
455 ShmemPmdMapped: 0 kB
456 Shared_Hugetlb: 0 kB
457 Private_Hugetlb: 0 kB
458 Swap: 0 kB
459 SwapPss: 0 kB
460 KernelPageSize: 4 kB
461 MMUPageSize: 4 kB
462 Locked: 0 kB
463 THPeligible: 0
464 VmFlags: rd ex mr mw me dw
Stefani Seibold349888e2009-06-17 16:26:01 -0700465
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700466The first of these lines shows the same information as is displayed for the
467mapping in /proc/PID/maps. Following lines show the size of the mapping
468(size); the size of each page allocated when backing a VMA (KernelPageSize),
469which is usually the same as the size in the page table entries; the page size
470used by the MMU when backing a VMA (in most cases, the same as KernelPageSize);
471the amount of the mapping that is currently resident in RAM (RSS); the
472process' proportional share of this mapping (PSS); and the number of clean and
473dirty shared and private pages in the mapping.
Minchan Kim8334b962015-09-08 15:00:24 -0700474
475The "proportional set size" (PSS) of a process is the count of pages it has
476in memory, where each page is divided by the number of processes sharing it.
477So if a process has 1000 pages all to itself, and 1000 shared with one other
478process, its PSS will be 1500.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100479
Minchan Kim8334b962015-09-08 15:00:24 -0700480Note that even a page which is part of a MAP_SHARED mapping, but has only
481a single pte mapped, i.e. is currently used by only one process, is accounted
482as private and not as shared.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100483
Minchan Kim8334b962015-09-08 15:00:24 -0700484"Referenced" indicates the amount of memory currently marked as referenced or
485accessed.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100486
Nikanth Karthikesanb40d4f82010-10-27 15:34:10 -0700487"Anonymous" shows the amount of memory that does not belong to any file. Even
488a mapping associated with a file may contain anonymous pages: when MAP_PRIVATE
489and a page is modified, the file page is replaced by a private anonymous copy.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100490
Shaohua Licf8496e2017-05-03 14:52:42 -0700491"LazyFree" shows the amount of memory which is marked by madvise(MADV_FREE).
492The memory isn't freed immediately with madvise(). It's freed in memory
493pressure if the memory is clean. Please note that the printed value might
494be lower than the real value due to optimizations used in the current
495implementation. If this is not desirable please file a bug report.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100496
Naoya Horiguchi25ee01a2015-11-05 18:47:11 -0800497"AnonHugePages" shows the ammount of memory backed by transparent hugepage.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100498
Kirill A. Shutemov1b5946a2016-07-26 15:26:40 -0700499"ShmemPmdMapped" shows the ammount of shared (shmem/tmpfs) memory backed by
500huge pages.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100501
Naoya Horiguchi25ee01a2015-11-05 18:47:11 -0800502"Shared_Hugetlb" and "Private_Hugetlb" show the ammounts of memory backed by
503hugetlbfs page which is *not* counted in "RSS" or "PSS" field for historical
504reasons. And these are not included in {Shared,Private}_{Clean,Dirty} field.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100505
Hugh Dickinsa5be3562015-11-05 18:50:37 -0800506"Swap" shows how much would-be-anonymous memory is also used, but out on swap.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100507
Vlastimil Babkac261e7d92016-01-14 15:19:17 -0800508For shmem mappings, "Swap" includes also the size of the mapped (and not
509replaced by copy-on-write) part of the underlying shmem object out on swap.
510"SwapPss" shows proportional swap share of this mapping. Unlike "Swap", this
511does not take into account swapped out page of underlying shmem objects.
Hugh Dickinsa5be3562015-11-05 18:50:37 -0800512"Locked" indicates whether the mapping is locked in memory or not.
Yang Shic0630662019-07-18 15:57:27 -0700513"THPeligible" indicates whether the mapping is eligible for allocating THP
514pages - 1 if true, 0 otherwise. It just shows the current status.
Naoya Horiguchi25ee01a2015-11-05 18:47:11 -0800515
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100516"VmFlags" field deserves a separate description. This member represents the
517kernel flags associated with the particular virtual memory area in two letter
518encoded manner. The codes are the following:
519
520 == =======================================
521 rd readable
522 wr writeable
523 ex executable
524 sh shared
525 mr may read
526 mw may write
527 me may execute
528 ms may share
529 gd stack segment growns down
530 pf pure PFN range
531 dw disabled write to the mapped file
532 lo pages are locked in memory
533 io memory mapped I/O area
534 sr sequential read advise provided
535 rr random read advise provided
536 dc do not copy area on fork
537 de do not expand area on remapping
538 ac area is accountable
539 nr swap space is not reserved for the area
540 ht area uses huge tlb pages
541 ar architecture specific flag
542 dd do not include area into core dump
543 sd soft dirty flag
544 mm mixed map area
545 hg huge page advise flag
546 nh no huge page advise flag
547 mg mergable advise flag
548 == =======================================
Cyrill Gorcunov834f82e2012-12-17 16:03:13 -0800549
550Note that there is no guarantee that every flag and associated mnemonic will
551be present in all further kernel releases. Things get changed, the flags may
Michal Hocko7550c602018-12-28 00:38:17 -0800552be vanished or the reverse -- new added. Interpretation of their meaning
553might change in future as well. So each consumer of these flags has to
554follow each specific kernel version for the exact semantic.
Cyrill Gorcunov834f82e2012-12-17 16:03:13 -0800555
Stefani Seibold349888e2009-06-17 16:26:01 -0700556This file is only present if the CONFIG_MMU kernel configuration option is
557enabled.
Kees Cook18d96772007-07-15 23:40:38 -0700558
Robert Ho53aeee72016-10-07 17:02:39 -0700559Note: reading /proc/PID/maps or /proc/PID/smaps is inherently racy (consistent
560output can be achieved only in the single read call).
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100561
Robert Ho53aeee72016-10-07 17:02:39 -0700562This typically manifests when doing partial reads of these files while the
563memory map is being modified. Despite the races, we do provide the following
564guarantees:
565
5661) The mapped addresses never go backwards, which implies no two
567 regions will ever overlap.
5682) If there is something at a given vaddr during the entirety of the
569 life of the smaps/maps walk, there will be some output for it.
570
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700571The /proc/PID/smaps_rollup file includes the same fields as /proc/PID/smaps,
572but their values are the sums of the corresponding values for all mappings of
573the process. Additionally, it contains these fields:
574
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100575- Pss_Anon
576- Pss_File
577- Pss_Shmem
Luigi Semenzatoee2ad712019-07-11 21:00:10 -0700578
579They represent the proportional shares of anonymous, file, and shmem pages, as
580described for smaps above. These fields are omitted in smaps since each
581mapping identifies the type (anon, file, or shmem) of all pages it contains.
582Thus all information in smaps_rollup can be derived from smaps, but at a
583significantly higher cost.
Robert Ho53aeee72016-10-07 17:02:39 -0700584
Moussa A. Ba398499d2009-09-21 17:02:29 -0700585The /proc/PID/clear_refs is used to reset the PG_Referenced and ACCESSED/YOUNG
Pavel Emelyanov0f8975e2013-07-03 15:01:20 -0700586bits on both physical and virtual pages associated with a process, and the
Mike Rapoport1ad13352018-04-18 11:07:49 +0300587soft-dirty bit on pte (see Documentation/admin-guide/mm/soft-dirty.rst
588for details).
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100589To clear the bits for all the pages associated with the process::
590
Moussa A. Ba398499d2009-09-21 17:02:29 -0700591 > echo 1 > /proc/PID/clear_refs
592
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100593To clear the bits for the anonymous pages associated with the process::
594
Moussa A. Ba398499d2009-09-21 17:02:29 -0700595 > echo 2 > /proc/PID/clear_refs
596
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100597To clear the bits for the file mapped pages associated with the process::
598
Moussa A. Ba398499d2009-09-21 17:02:29 -0700599 > echo 3 > /proc/PID/clear_refs
Pavel Emelyanov0f8975e2013-07-03 15:01:20 -0700600
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100601To clear the soft-dirty bit::
602
Pavel Emelyanov0f8975e2013-07-03 15:01:20 -0700603 > echo 4 > /proc/PID/clear_refs
604
Petr Cermak695f0552015-02-12 15:01:00 -0800605To reset the peak resident set size ("high water mark") to the process's
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100606current value::
607
Petr Cermak695f0552015-02-12 15:01:00 -0800608 > echo 5 > /proc/PID/clear_refs
609
Moussa A. Ba398499d2009-09-21 17:02:29 -0700610Any other value written to /proc/PID/clear_refs will have no effect.
611
Nikanth Karthikesan03f890f2010-10-27 15:34:11 -0700612The /proc/pid/pagemap gives the PFN, which can be used to find the pageflags
613using /proc/kpageflags and number of times a page is mapped using
Mike Rapoport1ad13352018-04-18 11:07:49 +0300614/proc/kpagecount. For detailed explanation, see
615Documentation/admin-guide/mm/pagemap.rst.
Moussa A. Ba398499d2009-09-21 17:02:29 -0700616
Rafael Aquini0c369712015-02-12 15:01:05 -0800617The /proc/pid/numa_maps is an extension based on maps, showing the memory
618locality and binding policy, as well as the memory usage (in pages) of
619each mapping. The output follows a general format where mapping details get
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100620summarized separated by blank spaces, one mapping per each file line::
Rafael Aquini0c369712015-02-12 15:01:05 -0800621
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100622 address policy mapping details
Rafael Aquini0c369712015-02-12 15:01:05 -0800623
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100624 00400000 default file=/usr/local/bin/app mapped=1 active=0 N3=1 kernelpagesize_kB=4
625 00600000 default file=/usr/local/bin/app anon=1 dirty=1 N3=1 kernelpagesize_kB=4
626 3206000000 default file=/lib64/ld-2.12.so mapped=26 mapmax=6 N0=24 N3=2 kernelpagesize_kB=4
627 320621f000 default file=/lib64/ld-2.12.so anon=1 dirty=1 N3=1 kernelpagesize_kB=4
628 3206220000 default file=/lib64/ld-2.12.so anon=1 dirty=1 N3=1 kernelpagesize_kB=4
629 3206221000 default anon=1 dirty=1 N3=1 kernelpagesize_kB=4
630 3206800000 default file=/lib64/libc-2.12.so mapped=59 mapmax=21 active=55 N0=41 N3=18 kernelpagesize_kB=4
631 320698b000 default file=/lib64/libc-2.12.so
632 3206b8a000 default file=/lib64/libc-2.12.so anon=2 dirty=2 N3=2 kernelpagesize_kB=4
633 3206b8e000 default file=/lib64/libc-2.12.so anon=1 dirty=1 N3=1 kernelpagesize_kB=4
634 3206b8f000 default anon=3 dirty=3 active=1 N3=3 kernelpagesize_kB=4
635 7f4dc10a2000 default anon=3 dirty=3 N3=3 kernelpagesize_kB=4
636 7f4dc10b4000 default anon=2 dirty=2 active=1 N3=2 kernelpagesize_kB=4
637 7f4dc1200000 default file=/anon_hugepage\040(deleted) huge anon=1 dirty=1 N3=1 kernelpagesize_kB=2048
638 7fff335f0000 default stack anon=3 dirty=3 N3=3 kernelpagesize_kB=4
639 7fff3369d000 default mapped=1 mapmax=35 active=0 N3=1 kernelpagesize_kB=4
Rafael Aquini0c369712015-02-12 15:01:05 -0800640
641Where:
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100642
Rafael Aquini0c369712015-02-12 15:01:05 -0800643"address" is the starting address for the mapping;
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100644
Mike Rapoport3ecf53e2018-05-08 10:02:10 +0300645"policy" reports the NUMA memory policy set for the mapping (see Documentation/admin-guide/mm/numa_memory_policy.rst);
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100646
Rafael Aquini0c369712015-02-12 15:01:05 -0800647"mapping details" summarizes mapping data such as mapping type, page usage counters,
648node locality page counters (N0 == node0, N1 == node1, ...) and the kernel page
649size, in KB, that is backing the mapping up.
650
Linus Torvalds1da177e2005-04-16 15:20:36 -07006511.2 Kernel data
652---------------
653
654Similar to the process entries, the kernel data files give information about
655the running kernel. The files used to obtain this information are contained in
Stefani Seibold349888e2009-06-17 16:26:01 -0700656/proc and are listed in Table 1-5. Not all of these will be present in your
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657system. It depends on the kernel configuration and the loaded modules, which
658files are there, and which are missing.
659
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100660.. table:: Table 1-5: Kernel info in /proc
661
662 ============ ===============================================================
663 File Content
664 ============ ===============================================================
665 apm Advanced power management info
666 buddyinfo Kernel memory allocator information (see text) (2.5)
667 bus Directory containing bus specific information
668 cmdline Kernel command line
669 cpuinfo Info about the CPU
670 devices Available devices (block and character)
671 dma Used DMS channels
672 filesystems Supported filesystems
673 driver Various drivers grouped here, currently rtc (2.4)
674 execdomains Execdomains, related to security (2.4)
675 fb Frame Buffer devices (2.4)
676 fs File system parameters, currently nfs/exports (2.4)
677 ide Directory containing info about the IDE subsystem
678 interrupts Interrupt usage
679 iomem Memory map (2.4)
680 ioports I/O port usage
681 irq Masks for irq to cpu affinity (2.4)(smp?)
682 isapnp ISA PnP (Plug&Play) Info (2.4)
683 kcore Kernel core image (can be ELF or A.OUT(deprecated in 2.4))
684 kmsg Kernel messages
685 ksyms Kernel symbol table
686 loadavg Load average of last 1, 5 & 15 minutes
687 locks Kernel locks
688 meminfo Memory info
689 misc Miscellaneous
690 modules List of loaded modules
691 mounts Mounted filesystems
692 net Networking info (see text)
Mel Gormana1b57ac2010-03-05 13:42:15 -0800693 pagetypeinfo Additional page allocator information (see text) (2.5)
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100694 partitions Table of partitions known to the system
695 pci Deprecated info of PCI bus (new way -> /proc/bus/pci/,
696 decoupled by lspci (2.4)
697 rtc Real time clock
698 scsi SCSI info (see text)
699 slabinfo Slab pool info
700 softirqs softirq usage
701 stat Overall statistics
702 swaps Swap space utilization
703 sys See chapter 2
704 sysvipc Info of SysVIPC Resources (msg, sem, shm) (2.4)
705 tty Info of tty drivers
706 uptime Wall clock since boot, combined idle time of all cpus
707 version Kernel version
708 video bttv info of video resources (2.4)
709 vmallocinfo Show vmalloced areas
710 ============ ===============================================================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
712You can, for example, check which interrupts are currently in use and what
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100713they are used for by looking in the file /proc/interrupts::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100715 > cat /proc/interrupts
716 CPU0
717 0: 8728810 XT-PIC timer
718 1: 895 XT-PIC keyboard
719 2: 0 XT-PIC cascade
720 3: 531695 XT-PIC aha152x
721 4: 2014133 XT-PIC serial
722 5: 44401 XT-PIC pcnet_cs
723 8: 2 XT-PIC rtc
724 11: 8 XT-PIC i82365
725 12: 182918 XT-PIC PS/2 Mouse
726 13: 1 XT-PIC fpu
727 14: 1232265 XT-PIC ide0
728 15: 7 XT-PIC ide1
729 NMI: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
731In 2.4.* a couple of lines where added to this file LOC & ERR (this time is the
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100732output of a SMP machine)::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100734 > cat /proc/interrupts
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100736 CPU0 CPU1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 0: 1243498 1214548 IO-APIC-edge timer
738 1: 8949 8958 IO-APIC-edge keyboard
739 2: 0 0 XT-PIC cascade
740 5: 11286 10161 IO-APIC-edge soundblaster
741 8: 1 0 IO-APIC-edge rtc
742 9: 27422 27407 IO-APIC-edge 3c503
743 12: 113645 113873 IO-APIC-edge PS/2 Mouse
744 13: 0 0 XT-PIC fpu
745 14: 22491 24012 IO-APIC-edge ide0
746 15: 2183 2415 IO-APIC-edge ide1
747 17: 30564 30414 IO-APIC-level eth0
748 18: 177 164 IO-APIC-level bttv
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100749 NMI: 2457961 2457959
750 LOC: 2457882 2457881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 ERR: 2155
752
753NMI is incremented in this case because every timer interrupt generates a NMI
754(Non Maskable Interrupt) which is used by the NMI Watchdog to detect lockups.
755
756LOC is the local interrupt counter of the internal APIC of every CPU.
757
758ERR is incremented in the case of errors in the IO-APIC bus (the bus that
759connects the CPUs in a SMP system. This means that an error has been detected,
760the IO-APIC automatically retry the transmission, so it should not be a big
761problem, but you should read the SMP-FAQ.
762
Joe Korty38e760a2007-10-17 18:04:40 +0200763In 2.6.2* /proc/interrupts was expanded again. This time the goal was for
764/proc/interrupts to display every IRQ vector in use by the system, not
765just those considered 'most important'. The new vectors are:
766
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100767THR
768 interrupt raised when a machine check threshold counter
Joe Korty38e760a2007-10-17 18:04:40 +0200769 (typically counting ECC corrected errors of memory or cache) exceeds
770 a configurable threshold. Only available on some systems.
771
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100772TRM
773 a thermal event interrupt occurs when a temperature threshold
Joe Korty38e760a2007-10-17 18:04:40 +0200774 has been exceeded for the CPU. This interrupt may also be generated
775 when the temperature drops back to normal.
776
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100777SPU
778 a spurious interrupt is some interrupt that was raised then lowered
Joe Korty38e760a2007-10-17 18:04:40 +0200779 by some IO device before it could be fully processed by the APIC. Hence
780 the APIC sees the interrupt but does not know what device it came from.
781 For this case the APIC will generate the interrupt with a IRQ vector
782 of 0xff. This might also be generated by chipset bugs.
783
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100784RES, CAL, TLB]
785 rescheduling, call and TLB flush interrupts are
Joe Korty38e760a2007-10-17 18:04:40 +0200786 sent from one CPU to another per the needs of the OS. Typically,
787 their statistics are used by kernel developers and interested users to
Matt LaPlante19f59462009-04-27 15:06:31 +0200788 determine the occurrence of interrupts of the given type.
Joe Korty38e760a2007-10-17 18:04:40 +0200789
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300790The above IRQ vectors are displayed only when relevant. For example,
Joe Korty38e760a2007-10-17 18:04:40 +0200791the threshold vector does not exist on x86_64 platforms. Others are
792suppressed when the system is a uniprocessor. As of this writing, only
793i386 and x86_64 platforms support the new IRQ vector displays.
794
795Of some interest is the introduction of the /proc/irq directory to 2.4.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796It could be used to set IRQ to CPU affinity, this means that you can "hook" an
797IRQ to only one CPU, or to exclude a CPU of handling IRQs. The contents of the
Max Krasnyansky18404752008-05-29 11:02:52 -0700798irq subdir is one subdir for each IRQ, and two files; default_smp_affinity and
799prof_cpu_mask.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100801For example::
802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 > ls /proc/irq/
804 0 10 12 14 16 18 2 4 6 8 prof_cpu_mask
Max Krasnyansky18404752008-05-29 11:02:52 -0700805 1 11 13 15 17 19 3 5 7 9 default_smp_affinity
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 > ls /proc/irq/0/
807 smp_affinity
808
Max Krasnyansky18404752008-05-29 11:02:52 -0700809smp_affinity is a bitmask, in which you can specify which CPUs can handle the
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100810IRQ, you can set it by doing::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Max Krasnyansky18404752008-05-29 11:02:52 -0700812 > echo 1 > /proc/irq/10/smp_affinity
813
814This means that only the first CPU will handle the IRQ, but you can also echo
John Kacur99e9d9582016-06-17 15:05:15 +02008155 which means that only the first and third CPU can handle the IRQ.
Max Krasnyansky18404752008-05-29 11:02:52 -0700816
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100817The contents of each smp_affinity file is the same by default::
Max Krasnyansky18404752008-05-29 11:02:52 -0700818
819 > cat /proc/irq/0/smp_affinity
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 ffffffff
821
Mike Travis4b0604202011-05-24 17:13:12 -0700822There is an alternate interface, smp_affinity_list which allows specifying
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100823a cpu range instead of a bitmask::
Mike Travis4b0604202011-05-24 17:13:12 -0700824
825 > cat /proc/irq/0/smp_affinity_list
826 1024-1031
827
Max Krasnyansky18404752008-05-29 11:02:52 -0700828The default_smp_affinity mask applies to all non-active IRQs, which are the
829IRQs which have not yet been allocated/activated, and hence which lack a
830/proc/irq/[0-9]* directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Dimitri Sivanich92d6b712010-03-11 14:08:56 -0800832The node file on an SMP system shows the node to which the device using the IRQ
833reports itself as being attached. This hardware locality information does not
834include information about any possible driver locality preference.
835
Max Krasnyansky18404752008-05-29 11:02:52 -0700836prof_cpu_mask specifies which CPUs are to be profiled by the system wide
Mike Travis4b0604202011-05-24 17:13:12 -0700837profiler. Default value is ffffffff (all cpus if there are only 32 of them).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
839The way IRQs are routed is handled by the IO-APIC, and it's Round Robin
840between all the CPUs which are allowed to handle it. As usual the kernel has
841more info than you and does a better job than you, so the defaults are the
Mike Travis4b0604202011-05-24 17:13:12 -0700842best choice for almost everyone. [Note this applies only to those IO-APIC's
843that support "Round Robin" interrupt distribution.]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
845There are three more important subdirectories in /proc: net, scsi, and sys.
846The general rule is that the contents, or even the existence of these
847directories, depend on your kernel configuration. If SCSI is not enabled, the
848directory scsi may not exist. The same is true with the net, which is there
849only when networking support is present in the running kernel.
850
851The slabinfo file gives information about memory usage at the slab level.
852Linux uses slab pools for memory management above page level in version 2.2.
853Commonly used objects have their own slab pool (such as network buffers,
854directory cache, and so on).
855
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100856::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100858 > cat /proc/buddyinfo
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100860 Node 0, zone DMA 0 4 5 4 4 3 ...
861 Node 0, zone Normal 1 0 0 1 101 8 ...
862 Node 0, zone HighMem 2 0 0 1 1 0 ...
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
Mel Gormana1b57ac2010-03-05 13:42:15 -0800864External fragmentation is a problem under some workloads, and buddyinfo is a
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100865useful tool for helping diagnose these problems. Buddyinfo will give you a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866clue as to how big an area you can safely allocate, or why a previous
867allocation failed.
868
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100869Each column represents the number of pages of a certain order which are
870available. In this case, there are 0 chunks of 2^0*PAGE_SIZE available in
871ZONE_DMA, 4 chunks of 2^1*PAGE_SIZE in ZONE_DMA, 101 chunks of 2^4*PAGE_SIZE
872available in ZONE_NORMAL, etc...
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Mel Gormana1b57ac2010-03-05 13:42:15 -0800874More information relevant to external fragmentation can be found in
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100875pagetypeinfo::
Mel Gormana1b57ac2010-03-05 13:42:15 -0800876
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100877 > cat /proc/pagetypeinfo
878 Page block order: 9
879 Pages per block: 512
Mel Gormana1b57ac2010-03-05 13:42:15 -0800880
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100881 Free pages count per migrate type at order 0 1 2 3 4 5 6 7 8 9 10
882 Node 0, zone DMA, type Unmovable 0 0 0 1 1 1 1 1 1 1 0
883 Node 0, zone DMA, type Reclaimable 0 0 0 0 0 0 0 0 0 0 0
884 Node 0, zone DMA, type Movable 1 1 2 1 2 1 1 0 1 0 2
885 Node 0, zone DMA, type Reserve 0 0 0 0 0 0 0 0 0 1 0
886 Node 0, zone DMA, type Isolate 0 0 0 0 0 0 0 0 0 0 0
887 Node 0, zone DMA32, type Unmovable 103 54 77 1 1 1 11 8 7 1 9
888 Node 0, zone DMA32, type Reclaimable 0 0 2 1 0 0 0 0 1 0 0
889 Node 0, zone DMA32, type Movable 169 152 113 91 77 54 39 13 6 1 452
890 Node 0, zone DMA32, type Reserve 1 2 2 2 2 0 1 1 1 1 0
891 Node 0, zone DMA32, type Isolate 0 0 0 0 0 0 0 0 0 0 0
Mel Gormana1b57ac2010-03-05 13:42:15 -0800892
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100893 Number of blocks type Unmovable Reclaimable Movable Reserve Isolate
894 Node 0, zone DMA 2 0 5 1 0
895 Node 0, zone DMA32 41 6 967 2 0
Mel Gormana1b57ac2010-03-05 13:42:15 -0800896
897Fragmentation avoidance in the kernel works by grouping pages of different
898migrate types into the same contiguous regions of memory called page blocks.
899A page block is typically the size of the default hugepage size e.g. 2MB on
900X86-64. By keeping pages grouped based on their ability to move, the kernel
901can reclaim pages within a page block to satisfy a high-order allocation.
902
903The pagetypinfo begins with information on the size of a page block. It
904then gives the same type of information as buddyinfo except broken down
905by migrate-type and finishes with details on how many page blocks of each
906type exist.
907
908If min_free_kbytes has been tuned correctly (recommendations made by hugeadm
SeongJae Parkceec86ec2016-01-13 16:47:56 +0900909from libhugetlbfs https://github.com/libhugetlbfs/libhugetlbfs/), one can
Mel Gormana1b57ac2010-03-05 13:42:15 -0800910make an estimate of the likely number of huge pages that can be allocated
911at a given point in time. All the "Movable" blocks should be allocatable
912unless memory has been mlock()'d. Some of the Reclaimable blocks should
913also be allocatable although a lot of filesystem metadata may have to be
914reclaimed to achieve this.
915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100917meminfo
918~~~~~~~
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
920Provides information about distribution and utilization of memory. This
921varies by architecture and compile options. The following is from a
92216GB PIII, which has highmem enabled. You may not have all of these fields.
923
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100924::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100926 > cat /proc/meminfo
Kirill A. Shutemov1b5946a2016-07-26 15:26:40 -0700927
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100928 MemTotal: 16344972 kB
929 MemFree: 13634064 kB
930 MemAvailable: 14836172 kB
931 Buffers: 3656 kB
932 Cached: 1195708 kB
933 SwapCached: 0 kB
934 Active: 891636 kB
935 Inactive: 1077224 kB
936 HighTotal: 15597528 kB
937 HighFree: 13629632 kB
938 LowTotal: 747444 kB
939 LowFree: 4432 kB
940 SwapTotal: 0 kB
941 SwapFree: 0 kB
942 Dirty: 968 kB
943 Writeback: 0 kB
944 AnonPages: 861800 kB
945 Mapped: 280372 kB
946 Shmem: 644 kB
947 KReclaimable: 168048 kB
948 Slab: 284364 kB
949 SReclaimable: 159856 kB
950 SUnreclaim: 124508 kB
951 PageTables: 24448 kB
952 NFS_Unstable: 0 kB
953 Bounce: 0 kB
954 WritebackTmp: 0 kB
955 CommitLimit: 7669796 kB
956 Committed_AS: 100056 kB
957 VmallocTotal: 112216 kB
958 VmallocUsed: 428 kB
959 VmallocChunk: 111088 kB
960 Percpu: 62080 kB
961 HardwareCorrupted: 0 kB
962 AnonHugePages: 49152 kB
963 ShmemHugePages: 0 kB
964 ShmemPmdMapped: 0 kB
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100966MemTotal
967 Total usable ram (i.e. physical ram minus a few reserved
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 bits and the kernel binary code)
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100969MemFree
970 The sum of LowFree+HighFree
971MemAvailable
972 An estimate of how much memory is available for starting new
Rik van Riel34e431b2014-01-21 15:49:05 -0800973 applications, without swapping. Calculated from MemFree,
974 SReclaimable, the size of the file LRU lists, and the low
975 watermarks in each zone.
976 The estimate takes into account that the system needs some
977 page cache to function well, and that not all reclaimable
978 slab will be reclaimable, due to items being in use. The
979 impact of those factors will vary from system to system.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100980Buffers
981 Relatively temporary storage for raw disk blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 shouldn't get tremendously large (20MB or so)
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100983Cached
984 in-memory cache for files read from the disk (the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 pagecache). Doesn't include SwapCached
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100986SwapCached
987 Memory that once was swapped out, is swapped back in but
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 still also is in the swapfile (if memory is needed it
989 doesn't need to be swapped out AGAIN because it is already
990 in the swapfile. This saves I/O)
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100991Active
992 Memory that has been used more recently and usually not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 reclaimed unless absolutely necessary.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100994Inactive
995 Memory which has been less recently used. It is more
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 eligible to be reclaimed for other purposes
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100997HighTotal, HighFree
998 Highmem is all memory above ~860MB of physical memory
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 Highmem areas are for use by userspace programs, or
1000 for the pagecache. The kernel must use tricks to access
1001 this memory, making it slower to access than lowmem.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001002LowTotal, LowFree
1003 Lowmem is memory which can be used for everything that
Matt LaPlante3f6dee92006-10-03 22:45:33 +02001004 highmem can be used for, but it is also available for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 kernel's use for its own data structures. Among many
1006 other things, it is where everything from the Slab is
1007 allocated. Bad things happen when you're out of lowmem.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001008SwapTotal
1009 total amount of swap space available
1010SwapFree
1011 Memory which has been evicted from RAM, and is temporarily
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 on the disk
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001013Dirty
1014 Memory which is waiting to get written back to the disk
1015Writeback
1016 Memory which is actively being written back to the disk
1017AnonPages
1018 Non-file backed pages mapped into userspace page tables
1019HardwareCorrupted
1020 The amount of RAM/memory in KB, the kernel identifies as
Prashant Dhamdhere655c75a2018-07-13 22:58:06 +05301021 corrupted.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001022AnonHugePages
1023 Non-file backed huge pages mapped into userspace page tables
1024Mapped
1025 files which have been mmaped, such as libraries
1026Shmem
1027 Total memory used by shared memory (shmem) and tmpfs
1028ShmemHugePages
1029 Memory used by shared memory (shmem) and tmpfs allocated
Kirill A. Shutemov1b5946a2016-07-26 15:26:40 -07001030 with huge pages
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001031ShmemPmdMapped
1032 Shared memory mapped into userspace with huge pages
1033KReclaimable
1034 Kernel allocations that the kernel will attempt to reclaim
Vlastimil Babka61f94e12018-10-26 15:05:50 -07001035 under memory pressure. Includes SReclaimable (below), and other
1036 direct allocations with a shrinker.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001037Slab
1038 in-kernel data structures cache
1039SReclaimable
1040 Part of Slab, that might be reclaimed, such as caches
1041SUnreclaim
1042 Part of Slab, that cannot be reclaimed on memory pressure
1043PageTables
1044 amount of memory dedicated to the lowest level of page
Miklos Szeredib88473f2008-04-30 00:54:39 -07001045 tables.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001046NFS_Unstable
1047 NFS pages sent to the server, but not yet committed to stable
Miklos Szeredib88473f2008-04-30 00:54:39 -07001048 storage
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001049Bounce
1050 Memory used for block device "bounce buffers"
1051WritebackTmp
1052 Memory used by FUSE for temporary writeback buffers
1053CommitLimit
1054 Based on the overcommit ratio ('vm.overcommit_ratio'),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 this is the total amount of memory currently available to
1056 be allocated on the system. This limit is only adhered to
1057 if strict overcommit accounting is enabled (mode 2 in
1058 'vm.overcommit_memory').
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001059
1060 The CommitLimit is calculated with the following formula::
1061
1062 CommitLimit = ([total RAM pages] - [total huge TLB pages]) *
1063 overcommit_ratio / 100 + [total swap pages]
1064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 For example, on a system with 1G of physical RAM and 7G
1066 of swap with a `vm.overcommit_ratio` of 30 it would
1067 yield a CommitLimit of 7.3G.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 For more details, see the memory overcommit documentation
1070 in vm/overcommit-accounting.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001071Committed_AS
1072 The amount of memory presently allocated on the system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 The committed memory is a sum of all of the memory which
1074 has been allocated by processes, even if it has not been
1075 "used" by them as of yet. A process which malloc()'s 1G
Minto Joseph46496022013-09-11 14:24:35 -07001076 of memory, but only touches 300M of it will show up as
1077 using 1G. This 1G is memory which has been "committed" to
1078 by the VM and can be used at any time by the allocating
1079 application. With strict overcommit enabled on the system
1080 (mode 2 in 'vm.overcommit_memory'),allocations which would
1081 exceed the CommitLimit (detailed above) will not be permitted.
1082 This is useful if one needs to guarantee that processes will
1083 not fail due to lack of memory once that memory has been
1084 successfully allocated.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001085VmallocTotal
1086 total size of vmalloc memory area
1087VmallocUsed
1088 amount of vmalloc area which is used
1089VmallocChunk
1090 largest contiguous block of vmalloc area which is free
1091Percpu
1092 Memory allocated to the percpu allocator used to back percpu
Dennis Zhou (Facebook)7e8a6302018-08-21 21:53:58 -07001093 allocations. This stat excludes the cost of metadata.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001095vmallocinfo
1096~~~~~~~~~~~
Eric Dumazeta47a1262008-07-23 21:27:38 -07001097
1098Provides information about vmalloced/vmaped areas. One line per area,
1099containing the virtual address range of the area, size in bytes,
1100caller information of the creator, and optional information depending
1101on the kind of area :
1102
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001103 ========== ===================================================
Eric Dumazeta47a1262008-07-23 21:27:38 -07001104 pages=nr number of pages
1105 phys=addr if a physical address was specified
1106 ioremap I/O mapping (ioremap() and friends)
1107 vmalloc vmalloc() area
1108 vmap vmap()ed pages
1109 user VM_USERMAP area
1110 vpages buffer for pages pointers was vmalloced (huge area)
1111 N<node>=nr (Only on NUMA kernels)
1112 Number of pages allocated on memory node <node>
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001113 ========== ===================================================
Eric Dumazeta47a1262008-07-23 21:27:38 -07001114
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001115::
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001117 > cat /proc/vmallocinfo
1118 0xffffc20000000000-0xffffc20000201000 2101248 alloc_large_system_hash+0x204 ...
1119 /0x2c0 pages=512 vmalloc N0=128 N1=128 N2=128 N3=128
1120 0xffffc20000201000-0xffffc20000302000 1052672 alloc_large_system_hash+0x204 ...
1121 /0x2c0 pages=256 vmalloc N0=64 N1=64 N2=64 N3=64
1122 0xffffc20000302000-0xffffc20000304000 8192 acpi_tb_verify_table+0x21/0x4f...
1123 phys=7fee8000 ioremap
1124 0xffffc20000304000-0xffffc20000307000 12288 acpi_tb_verify_table+0x21/0x4f...
1125 phys=7fee7000 ioremap
1126 0xffffc2000031d000-0xffffc2000031f000 8192 init_vdso_vars+0x112/0x210
1127 0xffffc2000031f000-0xffffc2000032b000 49152 cramfs_uncompress_init+0x2e ...
1128 /0x80 pages=11 vmalloc N0=3 N1=3 N2=2 N3=3
1129 0xffffc2000033a000-0xffffc2000033d000 12288 sys_swapon+0x640/0xac0 ...
1130 pages=2 vmalloc N1=2
1131 0xffffc20000347000-0xffffc2000034c000 20480 xt_alloc_table_info+0xfe ...
1132 /0x130 [x_tables] pages=4 vmalloc N0=4
1133 0xffffffffa0000000-0xffffffffa000f000 61440 sys_init_module+0xc27/0x1d00 ...
1134 pages=14 vmalloc N2=14
1135 0xffffffffa000f000-0xffffffffa0014000 20480 sys_init_module+0xc27/0x1d00 ...
1136 pages=4 vmalloc N1=4
1137 0xffffffffa0014000-0xffffffffa0017000 12288 sys_init_module+0xc27/0x1d00 ...
1138 pages=2 vmalloc N1=2
1139 0xffffffffa0017000-0xffffffffa0022000 45056 sys_init_module+0xc27/0x1d00 ...
1140 pages=10 vmalloc N0=10
Keika Kobayashid3d64df2009-06-17 16:25:55 -07001141
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001142
1143softirqs
1144~~~~~~~~
Keika Kobayashid3d64df2009-06-17 16:25:55 -07001145
1146Provides counts of softirq handlers serviced since boot time, for each cpu.
1147
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001148::
1149
1150 > cat /proc/softirqs
1151 CPU0 CPU1 CPU2 CPU3
1152 HI: 0 0 0 0
1153 TIMER: 27166 27120 27097 27034
1154 NET_TX: 0 0 0 17
1155 NET_RX: 42 0 0 39
1156 BLOCK: 0 0 107 1121
1157 TASKLET: 0 0 0 290
1158 SCHED: 27035 26983 26971 26746
1159 HRTIMER: 0 0 0 0
1160 RCU: 1678 1769 2178 2250
Keika Kobayashid3d64df2009-06-17 16:25:55 -07001161
1162
Linus Torvalds1da177e2005-04-16 15:20:36 -070011631.3 IDE devices in /proc/ide
1164----------------------------
1165
1166The subdirectory /proc/ide contains information about all IDE devices of which
1167the kernel is aware. There is one subdirectory for each IDE controller, the
1168file drivers and a link for each IDE device, pointing to the device directory
1169in the controller specific subtree.
1170
1171The file drivers contains general information about the drivers used for the
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001172IDE devices::
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
1174 > cat /proc/ide/drivers
1175 ide-cdrom version 4.53
1176 ide-disk version 1.08
1177
1178More detailed information can be found in the controller specific
1179subdirectories. These are named ide0, ide1 and so on. Each of these
Stefani Seibold349888e2009-06-17 16:26:01 -07001180directories contains the files shown in table 1-6.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181
1182
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001183.. table:: Table 1-6: IDE controller info in /proc/ide/ide?
1184
1185 ======= =======================================
1186 File Content
1187 ======= =======================================
1188 channel IDE channel (0 or 1)
1189 config Configuration (only for PCI/IDE bridge)
1190 mate Mate name
1191 model Type/Chipset of IDE controller
1192 ======= =======================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
1194Each device connected to a controller has a separate subdirectory in the
Stefani Seibold349888e2009-06-17 16:26:01 -07001195controllers directory. The files listed in table 1-7 are contained in these
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196directories.
1197
1198
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001199.. table:: Table 1-7: IDE device information
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001201 ================ ==========================================
1202 File Content
1203 ================ ==========================================
1204 cache The cache
1205 capacity Capacity of the medium (in 512Byte blocks)
1206 driver driver and version
1207 geometry physical and logical geometry
1208 identify device identify block
1209 media media type
1210 model device identifier
1211 settings device setup
1212 smart_thresholds IDE disk management thresholds
1213 smart_values IDE disk management values
1214 ================ ==========================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001216The most interesting file is ``settings``. This file contains a nice
1217overview of the drive parameters::
1218
1219 # cat /proc/ide/ide0/hda/settings
1220 name value min max mode
1221 ---- ----- --- --- ----
1222 bios_cyl 526 0 65535 rw
1223 bios_head 255 0 255 rw
1224 bios_sect 63 0 63 rw
1225 breada_readahead 4 0 127 rw
1226 bswap 0 0 1 r
1227 file_readahead 72 0 2097151 rw
1228 io_32bit 0 0 3 rw
1229 keepsettings 0 0 1 rw
1230 max_kb_per_request 122 1 127 rw
1231 multcount 0 0 8 rw
1232 nice1 1 0 1 rw
1233 nowerr 0 0 1 rw
1234 pio_mode write-only 0 255 w
1235 slow 0 0 1 rw
1236 unmaskirq 0 0 1 rw
1237 using_dma 0 0 1 rw
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
1239
12401.4 Networking info in /proc/net
1241--------------------------------
1242
Stefani Seibold349888e2009-06-17 16:26:01 -07001243The subdirectory /proc/net follows the usual pattern. Table 1-8 shows the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244additional values you get for IP version 6 if you configure the kernel to
Stefani Seibold349888e2009-06-17 16:26:01 -07001245support this. Table 1-9 lists the files and their meaning.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246
1247
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001248.. table:: Table 1-8: IPv6 info in /proc/net
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001250 ========== =====================================================
1251 File Content
1252 ========== =====================================================
1253 udp6 UDP sockets (IPv6)
1254 tcp6 TCP sockets (IPv6)
1255 raw6 Raw device statistics (IPv6)
1256 igmp6 IP multicast addresses, which this host joined (IPv6)
1257 if_inet6 List of IPv6 interface addresses
1258 ipv6_route Kernel routing table for IPv6
1259 rt6_stats Global IPv6 routing tables statistics
1260 sockstat6 Socket statistics (IPv6)
1261 snmp6 Snmp data (IPv6)
1262 ========== =====================================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001264.. table:: Table 1-9: Network info in /proc/net
1265
1266 ============= ================================================================
1267 File Content
1268 ============= ================================================================
1269 arp Kernel ARP table
1270 dev network devices with statistics
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 dev_mcast the Layer2 multicast groups a device is listening too
1272 (interface index, label, number of references, number of bound
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001273 addresses).
1274 dev_stat network device status
1275 ip_fwchains Firewall chain linkage
1276 ip_fwnames Firewall chain names
1277 ip_masq Directory containing the masquerading tables
1278 ip_masquerade Major masquerading table
1279 netstat Network statistics
1280 raw raw device statistics
1281 route Kernel routing table
1282 rpc Directory containing rpc info
1283 rt_cache Routing cache
1284 snmp SNMP data
1285 sockstat Socket statistics
1286 tcp TCP sockets
1287 udp UDP sockets
1288 unix UNIX domain sockets
1289 wireless Wireless interface data (Wavelan etc)
1290 igmp IP multicast addresses, which this host joined
1291 psched Global packet scheduler parameters.
1292 netlink List of PF_NETLINK sockets
1293 ip_mr_vifs List of multicast virtual interfaces
1294 ip_mr_cache List of multicast routing cache
1295 ============= ================================================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
1297You can use this information to see which network devices are available in
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001298your system and how much traffic was routed over those devices::
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001300 > cat /proc/net/dev
1301 Inter-|Receive |[...
1302 face |bytes packets errs drop fifo frame compressed multicast|[...
1303 lo: 908188 5596 0 0 0 0 0 0 [...
1304 ppp0:15475140 20721 410 0 0 410 0 0 [...
1305 eth0: 614530 7085 0 0 0 0 0 1 [...
1306
1307 ...] Transmit
1308 ...] bytes packets errs drop fifo colls carrier compressed
1309 ...] 908188 5596 0 0 0 0 0 0
1310 ...] 1375103 17405 0 0 0 0 0 0
1311 ...] 1703981 5535 0 0 0 3 0 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312
Francis Galieguea33f3222010-04-23 00:08:02 +02001313In addition, each Channel Bond interface has its own directory. For
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314example, the bond0 device will have a directory called /proc/net/bond0/.
1315It will contain information that is specific to that bond, such as the
1316current slaves of the bond, the link status of the slaves, and how
1317many times the slaves link has failed.
1318
13191.5 SCSI info
1320-------------
1321
1322If you have a SCSI host adapter in your system, you'll find a subdirectory
1323named after the driver for this adapter in /proc/scsi. You'll also see a list
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001324of all recognized SCSI devices in /proc/scsi::
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001326 >cat /proc/scsi/scsi
1327 Attached devices:
1328 Host: scsi0 Channel: 00 Id: 00 Lun: 00
1329 Vendor: IBM Model: DGHS09U Rev: 03E0
1330 Type: Direct-Access ANSI SCSI revision: 03
1331 Host: scsi0 Channel: 00 Id: 06 Lun: 00
1332 Vendor: PIONEER Model: CD-ROM DR-U06S Rev: 1.04
1333 Type: CD-ROM ANSI SCSI revision: 02
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
1335
1336The directory named after the driver has one file for each adapter found in
1337the system. These files contain information about the controller, including
1338the used IRQ and the IO address range. The amount of information shown is
1339dependent on the adapter you use. The example shows the output for an Adaptec
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001340AHA-2940 SCSI adapter::
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001342 > cat /proc/scsi/aic7xxx/0
1343
1344 Adaptec AIC7xxx driver version: 5.1.19/3.2.4
1345 Compile Options:
1346 TCQ Enabled By Default : Disabled
1347 AIC7XXX_PROC_STATS : Disabled
1348 AIC7XXX_RESET_DELAY : 5
1349 Adapter Configuration:
1350 SCSI Adapter: Adaptec AHA-294X Ultra SCSI host adapter
1351 Ultra Wide Controller
1352 PCI MMAPed I/O Base: 0xeb001000
1353 Adapter SEEPROM Config: SEEPROM found and used.
1354 Adaptec SCSI BIOS: Enabled
1355 IRQ: 10
1356 SCBs: Active 0, Max Active 2,
1357 Allocated 15, HW 16, Page 255
1358 Interrupts: 160328
1359 BIOS Control Word: 0x18b6
1360 Adapter Control Word: 0x005b
1361 Extended Translation: Enabled
1362 Disconnect Enable Flags: 0xffff
1363 Ultra Enable Flags: 0x0001
1364 Tag Queue Enable Flags: 0x0000
1365 Ordered Queue Tag Flags: 0x0000
1366 Default Tag Queue Depth: 8
1367 Tagged Queue By Device array for aic7xxx host instance 0:
1368 {255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255}
1369 Actual queue depth per device for aic7xxx host instance 0:
1370 {1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1}
1371 Statistics:
1372 (scsi0:0:0:0)
1373 Device using Wide/Sync transfers at 40.0 MByte/sec, offset 8
1374 Transinfo settings: current(12/8/1/0), goal(12/8/1/0), user(12/15/1/0)
1375 Total transfers 160151 (74577 reads and 85574 writes)
1376 (scsi0:0:6:0)
1377 Device using Narrow/Sync transfers at 5.0 MByte/sec, offset 15
1378 Transinfo settings: current(50/15/0/0), goal(50/15/0/0), user(50/15/0/0)
1379 Total transfers 0 (0 reads and 0 writes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
1381
13821.6 Parallel port info in /proc/parport
1383---------------------------------------
1384
1385The directory /proc/parport contains information about the parallel ports of
1386your system. It has one subdirectory for each port, named after the port
1387number (0,1,2,...).
1388
Stefani Seibold349888e2009-06-17 16:26:01 -07001389These directories contain the four files shown in Table 1-10.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
1391
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001392.. table:: Table 1-10: Files in /proc/parport
1393
1394 ========= ====================================================================
1395 File Content
1396 ========= ====================================================================
1397 autoprobe Any IEEE-1284 device ID information that has been acquired.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 devices list of the device drivers using that port. A + will appear by the
1399 name of the device currently using the port (it might not appear
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001400 against any).
1401 hardware Parallel port's base address, IRQ line and DMA channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 irq IRQ that parport is using for that port. This is in a separate
1403 file to allow you to alter it by writing a new value in (IRQ
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001404 number or none).
1405 ========= ====================================================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
14071.7 TTY info in /proc/tty
1408-------------------------
1409
1410Information about the available and actually used tty's can be found in the
1411directory /proc/tty.You'll find entries for drivers and line disciplines in
Stefani Seibold349888e2009-06-17 16:26:01 -07001412this directory, as shown in Table 1-11.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
1414
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001415.. table:: Table 1-11: Files in /proc/tty
1416
1417 ============= ==============================================
1418 File Content
1419 ============= ==============================================
1420 drivers list of drivers and their usage
1421 ldiscs registered line disciplines
1422 driver/serial usage statistic and status of single tty lines
1423 ============= ==============================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
1425To see which tty's are currently in use, you can simply look into the file
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001426/proc/tty/drivers::
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001428 > cat /proc/tty/drivers
1429 pty_slave /dev/pts 136 0-255 pty:slave
1430 pty_master /dev/ptm 128 0-255 pty:master
1431 pty_slave /dev/ttyp 3 0-255 pty:slave
1432 pty_master /dev/pty 2 0-255 pty:master
1433 serial /dev/cua 5 64-67 serial:callout
1434 serial /dev/ttyS 4 64-67 serial
1435 /dev/tty0 /dev/tty0 4 0 system:vtmaster
1436 /dev/ptmx /dev/ptmx 5 2 system
1437 /dev/console /dev/console 5 1 system:console
1438 /dev/tty /dev/tty 5 0 system:/dev/tty
1439 unknown /dev/tty 4 1-63 console
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
1441
14421.8 Miscellaneous kernel statistics in /proc/stat
1443-------------------------------------------------
1444
1445Various pieces of information about kernel activity are available in the
1446/proc/stat file. All of the numbers reported in this file are aggregates
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001447since the system first booted. For a quick look, simply cat the file::
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
1449 > cat /proc/stat
Tobias Klauserc8a329c2015-03-30 15:49:26 +02001450 cpu 2255 34 2290 22625563 6290 127 456 0 0 0
1451 cpu0 1132 34 1441 11311718 3675 127 438 0 0 0
1452 cpu1 1123 0 849 11313845 2614 0 18 0 0 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 intr 114930548 113199788 3 0 5 263 0 4 [... lots more numbers ...]
1454 ctxt 1990473
1455 btime 1062191376
1456 processes 2915
1457 procs_running 1
1458 procs_blocked 0
Keika Kobayashid3d64df2009-06-17 16:25:55 -07001459 softirq 183433 0 21755 12 39 1137 231 21459 2263
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
1461The very first "cpu" line aggregates the numbers in all of the other "cpuN"
1462lines. These numbers identify the amount of time the CPU has spent performing
1463different kinds of work. Time units are in USER_HZ (typically hundredths of a
1464second). The meanings of the columns are as follows, from left to right:
1465
1466- user: normal processes executing in user mode
1467- nice: niced processes executing in user mode
1468- system: processes executing in kernel mode
1469- idle: twiddling thumbs
Chao Fan9c240d72016-10-26 10:41:28 +08001470- iowait: In a word, iowait stands for waiting for I/O to complete. But there
1471 are several problems:
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001472
Chao Fan9c240d72016-10-26 10:41:28 +08001473 1. Cpu will not wait for I/O to complete, iowait is the time that a task is
1474 waiting for I/O to complete. When cpu goes into idle state for
1475 outstanding task io, another task will be scheduled on this CPU.
1476 2. In a multi-core CPU, the task waiting for I/O to complete is not running
1477 on any CPU, so the iowait of each CPU is difficult to calculate.
1478 3. The value of iowait field in /proc/stat will decrease in certain
1479 conditions.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001480
Chao Fan9c240d72016-10-26 10:41:28 +08001481 So, the iowait is not reliable by reading from /proc/stat.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482- irq: servicing interrupts
1483- softirq: servicing softirqs
Leonardo Chiquittob68f2c3a2007-10-20 03:03:38 +02001484- steal: involuntary wait
Ryota Ozakice0e7b22009-10-24 01:20:10 +09001485- guest: running a normal guest
1486- guest_nice: running a niced guest
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487
1488The "intr" line gives counts of interrupts serviced since boot time, for each
1489of the possible system interrupts. The first column is the total of all
Jan Moskyto Matejka3568a1d2014-05-15 13:55:34 -07001490interrupts serviced including unnumbered architecture specific interrupts;
1491each subsequent column is the total for that particular numbered interrupt.
1492Unnumbered interrupts are not shown, only summed into the total.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
1494The "ctxt" line gives the total number of context switches across all CPUs.
1495
1496The "btime" line gives the time at which the system booted, in seconds since
1497the Unix epoch.
1498
1499The "processes" line gives the number of processes and threads created, which
1500includes (but is not limited to) those created by calls to the fork() and
1501clone() system calls.
1502
Luis Garces-Ericee3cc2222009-12-06 18:30:44 -08001503The "procs_running" line gives the total number of threads that are
1504running or ready to run (i.e., the total number of runnable threads).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505
1506The "procs_blocked" line gives the number of processes currently blocked,
1507waiting for I/O to complete.
1508
Keika Kobayashid3d64df2009-06-17 16:25:55 -07001509The "softirq" line gives counts of softirqs serviced since boot time, for each
1510of the possible system softirqs. The first column is the total of all
1511softirqs serviced; each subsequent column is the total for that particular
1512softirq.
1513
Theodore Ts'o37515fa2008-10-09 23:21:54 -04001514
Alex Tomasc9de5602008-01-29 00:19:52 -050015151.9 Ext4 file system parameters
Maisa Roponen690b0542014-11-24 09:54:17 +02001516-------------------------------
Alex Tomasc9de5602008-01-29 00:19:52 -05001517
Theodore Ts'o37515fa2008-10-09 23:21:54 -04001518Information about mounted ext4 file systems can be found in
1519/proc/fs/ext4. Each mounted filesystem will have a directory in
1520/proc/fs/ext4 based on its device name (i.e., /proc/fs/ext4/hdc or
1521/proc/fs/ext4/dm-0). The files in each per-device directory are shown
Stefani Seibold349888e2009-06-17 16:26:01 -07001522in Table 1-12, below.
Alex Tomasc9de5602008-01-29 00:19:52 -05001523
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001524.. table:: Table 1-12: Files in /proc/fs/ext4/<devname>
1525
1526 ============== ==========================================================
1527 File Content
Theodore Ts'o37515fa2008-10-09 23:21:54 -04001528 mb_groups details of multiblock allocator buddy cache of free blocks
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001529 ============== ==========================================================
Alex Tomasc9de5602008-01-29 00:19:52 -05001530
Jiri Slaby23308ba2010-11-04 16:20:24 +010015312.0 /proc/consoles
1532------------------
1533Shows registered system console lines.
1534
1535To see which character device lines are currently used for the system console
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001536/dev/console, you may simply look into the file /proc/consoles::
Jiri Slaby23308ba2010-11-04 16:20:24 +01001537
1538 > cat /proc/consoles
1539 tty0 -WU (ECp) 4:7
1540 ttyS0 -W- (Ep) 4:64
1541
1542The columns are:
1543
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001544+--------------------+-------------------------------------------------------+
1545| device | name of the device |
1546+====================+=======================================================+
1547| operations | * R = can do read operations |
1548| | * W = can do write operations |
1549| | * U = can do unblank |
1550+--------------------+-------------------------------------------------------+
1551| flags | * E = it is enabled |
1552| | * C = it is preferred console |
1553| | * B = it is primary boot console |
1554| | * p = it is used for printk buffer |
1555| | * b = it is not a TTY but a Braille device |
1556| | * a = it is safe to use when cpu is offline |
1557+--------------------+-------------------------------------------------------+
1558| major:minor | major and minor number of the device separated by a |
1559| | colon |
1560+--------------------+-------------------------------------------------------+
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562Summary
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001563-------
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565The /proc file system serves information about the running system. It not only
1566allows access to process data but also allows you to request the kernel status
1567by reading files in the hierarchy.
1568
1569The directory structure of /proc reflects the types of information and makes
1570it easy, if not obvious, where to look for specific data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001572Chapter 2: Modifying System Parameters
1573======================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575In This Chapter
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001576---------------
1577
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578* Modifying kernel parameters by writing into files found in /proc/sys
1579* Exploring the files which modify certain parameters
1580* Review of the /proc/sys file tree
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001582------------------------------------------------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
1584A very interesting part of /proc is the directory /proc/sys. This is not only
1585a source of information, it also allows you to change parameters within the
1586kernel. Be very careful when attempting this. You can optimize your system,
1587but you can also cause it to crash. Never alter kernel parameters on a
1588production system. Set up a development machine and test to make sure that
1589everything works the way you want it to. You may have no alternative but to
1590reboot the machine once an error has been made.
1591
1592To change a value, simply echo the new value into the file. An example is
1593given below in the section on the file system data. You need to be root to do
1594this. You can create your own boot script to perform this every time your
1595system boots.
1596
1597The files in /proc/sys can be used to fine tune and monitor miscellaneous and
1598general things in the operation of the Linux kernel. Since some of the files
1599can inadvertently disrupt your system, it is advisable to read both
1600documentation and source before actually making adjustments. In any case, be
1601very careful when writing to any of these files. The entries in /proc may
1602change slightly between the 2.1.* and the 2.2 kernel, so if there is any doubt
1603review the kernel documentation in the directory /usr/src/linux/Documentation.
1604This chapter is heavily based on the documentation included in the pre 2.2
1605kernels, and became part of it in version 2.2.1 of the Linux kernel.
1606
Mauro Carvalho Chehab57043242019-04-22 16:48:00 -03001607Please see: Documentation/admin-guide/sysctl/ directory for descriptions of these
Peter W Morrealedb0fb182009-01-15 13:50:42 -08001608entries.
Andrew Morton9d0243b2006-01-08 01:00:39 -08001609
Shen Feng760df932009-04-02 16:57:20 -07001610Summary
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001611-------
1612
Shen Feng760df932009-04-02 16:57:20 -07001613Certain aspects of kernel behavior can be modified at runtime, without the
1614need to recompile the kernel, or even to reboot the system. The files in the
1615/proc/sys tree can not only be read, but also modified. You can use the echo
1616command to write value into these files, thereby changing the default settings
1617of the kernel.
Andrew Morton9d0243b2006-01-08 01:00:39 -08001618
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001619
1620Chapter 3: Per-process Parameters
1621=================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
David Rientjesfa0cbbf2012-11-12 17:53:04 -080016233.1 /proc/<pid>/oom_adj & /proc/<pid>/oom_score_adj- Adjust the oom-killer score
David Rientjesa63d83f2010-08-09 17:19:46 -07001624--------------------------------------------------------------------------------
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -07001625
David Rientjesfa0cbbf2012-11-12 17:53:04 -08001626These file can be used to adjust the badness heuristic used to select which
David Rientjesa63d83f2010-08-09 17:19:46 -07001627process gets killed in out of memory conditions.
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -07001628
David Rientjesa63d83f2010-08-09 17:19:46 -07001629The badness heuristic assigns a value to each candidate task ranging from 0
1630(never kill) to 1000 (always kill) to determine which process is targeted. The
1631units are roughly a proportion along that range of allowed memory the process
1632may allocate from based on an estimation of its current memory and swap use.
1633For example, if a task is using all allowed memory, its badness score will be
16341000. If it is using half of its allowed memory, its score will be 500.
Evgeniy Polyakov9e9e3cb2009-01-29 14:25:09 -08001635
David Rientjes778c14a2014-01-30 15:46:11 -08001636There is an additional factor included in the badness score: the current memory
1637and swap usage is discounted by 3% for root processes.
Evgeniy Polyakov9e9e3cb2009-01-29 14:25:09 -08001638
David Rientjesa63d83f2010-08-09 17:19:46 -07001639The amount of "allowed" memory depends on the context in which the oom killer
1640was called. If it is due to the memory assigned to the allocating task's cpuset
1641being exhausted, the allowed memory represents the set of mems assigned to that
1642cpuset. If it is due to a mempolicy's node(s) being exhausted, the allowed
1643memory represents the set of mempolicy nodes. If it is due to a memory
1644limit (or swap limit) being reached, the allowed memory is that configured
1645limit. Finally, if it is due to the entire system being out of memory, the
1646allowed memory represents all allocatable resources.
Evgeniy Polyakov9e9e3cb2009-01-29 14:25:09 -08001647
David Rientjesa63d83f2010-08-09 17:19:46 -07001648The value of /proc/<pid>/oom_score_adj is added to the badness score before it
1649is used to determine which task to kill. Acceptable values range from -1000
1650(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). This allows userspace to
1651polarize the preference for oom killing either by always preferring a certain
1652task or completely disabling it. The lowest possible value, -1000, is
1653equivalent to disabling oom killing entirely for that task since it will always
1654report a badness score of 0.
Evgeniy Polyakov9e9e3cb2009-01-29 14:25:09 -08001655
David Rientjesa63d83f2010-08-09 17:19:46 -07001656Consequently, it is very simple for userspace to define the amount of memory to
1657consider for each task. Setting a /proc/<pid>/oom_score_adj value of +500, for
1658example, is roughly equivalent to allowing the remainder of tasks sharing the
1659same system, cpuset, mempolicy, or memory controller resources to use at least
166050% more memory. A value of -500, on the other hand, would be roughly
1661equivalent to discounting 50% of the task's allowed memory from being considered
1662as scoring against the task.
1663
David Rientjesfa0cbbf2012-11-12 17:53:04 -08001664For backwards compatibility with previous kernels, /proc/<pid>/oom_adj may also
1665be used to tune the badness score. Its acceptable values range from -16
1666(OOM_ADJUST_MIN) to +15 (OOM_ADJUST_MAX) and a special value of -17
1667(OOM_DISABLE) to disable oom killing entirely for that task. Its value is
1668scaled linearly with /proc/<pid>/oom_score_adj.
1669
Mandeep Singh Bainesdabb16f2011-01-13 15:46:05 -08001670The value of /proc/<pid>/oom_score_adj may be reduced no lower than the last
1671value set by a CAP_SYS_RESOURCE process. To reduce the value any lower
1672requires CAP_SYS_RESOURCE.
1673
David Rientjesa63d83f2010-08-09 17:19:46 -07001674Caveat: when a parent task is selected, the oom killer will sacrifice any first
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001675generation children with separate address spaces instead, if possible. This
David Rientjesa63d83f2010-08-09 17:19:46 -07001676avoids servers and important system daemons from being killed and loses the
1677minimal amount of work.
1678
Evgeniy Polyakov9e9e3cb2009-01-29 14:25:09 -08001679
Shen Feng760df932009-04-02 16:57:20 -070016803.2 /proc/<pid>/oom_score - Display current oom-killer score
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -07001681-------------------------------------------------------------
1682
Jan-Frode Myklebustd7ff0db2006-09-29 01:59:45 -07001683This file can be used to check the current score used by the oom-killer is for
David Rientjesfa0cbbf2012-11-12 17:53:04 -08001684any given <pid>. Use it together with /proc/<pid>/oom_score_adj to tune which
1685process should be killed in an out-of-memory situation.
1686
Roland Kletzingf9c99462007-03-05 00:30:54 -08001687
Shen Feng760df932009-04-02 16:57:20 -070016883.3 /proc/<pid>/io - Display the IO accounting fields
Roland Kletzingf9c99462007-03-05 00:30:54 -08001689-------------------------------------------------------
1690
1691This file contains IO statistics for each running process
1692
1693Example
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001694~~~~~~~
Roland Kletzingf9c99462007-03-05 00:30:54 -08001695
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001696::
Roland Kletzingf9c99462007-03-05 00:30:54 -08001697
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001698 test:/tmp # dd if=/dev/zero of=/tmp/test.dat &
1699 [1] 3828
1700
1701 test:/tmp # cat /proc/3828/io
1702 rchar: 323934931
1703 wchar: 323929600
1704 syscr: 632687
1705 syscw: 632675
1706 read_bytes: 0
1707 write_bytes: 323932160
1708 cancelled_write_bytes: 0
Roland Kletzingf9c99462007-03-05 00:30:54 -08001709
1710
1711Description
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001712~~~~~~~~~~~
Roland Kletzingf9c99462007-03-05 00:30:54 -08001713
1714rchar
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001715^^^^^
Roland Kletzingf9c99462007-03-05 00:30:54 -08001716
1717I/O counter: chars read
1718The number of bytes which this task has caused to be read from storage. This
1719is simply the sum of bytes which this process passed to read() and pread().
1720It includes things like tty IO and it is unaffected by whether or not actual
1721physical disk IO was required (the read might have been satisfied from
1722pagecache)
1723
1724
1725wchar
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001726^^^^^
Roland Kletzingf9c99462007-03-05 00:30:54 -08001727
1728I/O counter: chars written
1729The number of bytes which this task has caused, or shall cause to be written
1730to disk. Similar caveats apply here as with rchar.
1731
1732
1733syscr
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001734^^^^^
Roland Kletzingf9c99462007-03-05 00:30:54 -08001735
1736I/O counter: read syscalls
1737Attempt to count the number of read I/O operations, i.e. syscalls like read()
1738and pread().
1739
1740
1741syscw
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001742^^^^^
Roland Kletzingf9c99462007-03-05 00:30:54 -08001743
1744I/O counter: write syscalls
1745Attempt to count the number of write I/O operations, i.e. syscalls like
1746write() and pwrite().
1747
1748
1749read_bytes
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001750^^^^^^^^^^
Roland Kletzingf9c99462007-03-05 00:30:54 -08001751
1752I/O counter: bytes read
1753Attempt to count the number of bytes which this process really did cause to
1754be fetched from the storage layer. Done at the submit_bio() level, so it is
1755accurate for block-backed filesystems. <please add status regarding NFS and
1756CIFS at a later time>
1757
1758
1759write_bytes
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001760^^^^^^^^^^^
Roland Kletzingf9c99462007-03-05 00:30:54 -08001761
1762I/O counter: bytes written
1763Attempt to count the number of bytes which this process caused to be sent to
1764the storage layer. This is done at page-dirtying time.
1765
1766
1767cancelled_write_bytes
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001768^^^^^^^^^^^^^^^^^^^^^
Roland Kletzingf9c99462007-03-05 00:30:54 -08001769
1770The big inaccuracy here is truncate. If a process writes 1MB to a file and
1771then deletes the file, it will in fact perform no writeout. But it will have
1772been accounted as having caused 1MB of write.
1773In other words: The number of bytes which this process caused to not happen,
1774by truncating pagecache. A task can cause "negative" IO too. If this task
1775truncates some dirty pagecache, some IO which another task has been accounted
Francis Galieguea33f3222010-04-23 00:08:02 +02001776for (in its write_bytes) will not be happening. We _could_ just subtract that
Roland Kletzingf9c99462007-03-05 00:30:54 -08001777from the truncating task's write_bytes, but there is information loss in doing
1778that.
1779
1780
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001781.. Note::
Roland Kletzingf9c99462007-03-05 00:30:54 -08001782
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001783 At its current implementation state, this is a bit racy on 32-bit machines:
1784 if process A reads process B's /proc/pid/io while process B is updating one
1785 of those 64-bit counters, process A could see an intermediate result.
Roland Kletzingf9c99462007-03-05 00:30:54 -08001786
1787
1788More information about this can be found within the taskstats documentation in
1789Documentation/accounting.
1790
Shen Feng760df932009-04-02 16:57:20 -070017913.4 /proc/<pid>/coredump_filter - Core dump filtering settings
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001792---------------------------------------------------------------
1793When a process is dumped, all anonymous memory is written to a core file as
1794long as the size of the core file isn't limited. But sometimes we don't want
Ross Zwisler50378352015-10-05 16:33:36 -06001795to dump some memory segments, for example, huge shared memory or DAX.
1796Conversely, sometimes we want to save file-backed memory segments into a core
1797file, not only the individual files.
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001798
1799/proc/<pid>/coredump_filter allows you to customize which memory segments
1800will be dumped when the <pid> process is dumped. coredump_filter is a bitmask
1801of memory types. If a bit of the bitmask is set, memory segments of the
1802corresponding memory type are dumped, otherwise they are not dumped.
1803
Ross Zwisler50378352015-10-05 16:33:36 -06001804The following 9 memory types are supported:
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001805
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001806 - (bit 0) anonymous private memory
1807 - (bit 1) anonymous shared memory
1808 - (bit 2) file-backed private memory
1809 - (bit 3) file-backed shared memory
Hidehiro Kawaib261dfe2008-09-13 02:33:10 -07001810 - (bit 4) ELF header pages in file-backed private memory areas (it is
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001811 effective only if the bit 2 is cleared)
KOSAKI Motohiroe575f112008-10-18 20:27:08 -07001812 - (bit 5) hugetlb private memory
1813 - (bit 6) hugetlb shared memory
Ross Zwisler50378352015-10-05 16:33:36 -06001814 - (bit 7) DAX private memory
1815 - (bit 8) DAX shared memory
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001816
1817 Note that MMIO pages such as frame buffer are never dumped and vDSO pages
1818 are always dumped regardless of the bitmask status.
1819
Ross Zwisler50378352015-10-05 16:33:36 -06001820 Note that bits 0-4 don't affect hugetlb or DAX memory. hugetlb memory is
1821 only affected by bit 5-6, and DAX is only affected by bits 7-8.
KOSAKI Motohiroe575f112008-10-18 20:27:08 -07001822
Ross Zwisler50378352015-10-05 16:33:36 -06001823The default value of coredump_filter is 0x33; this means all anonymous memory
1824segments, ELF header pages and hugetlb private memory are dumped.
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001825
1826If you don't want to dump all shared memory segments attached to pid 1234,
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001827write 0x31 to the process's proc file::
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001828
Ross Zwisler50378352015-10-05 16:33:36 -06001829 $ echo 0x31 > /proc/1234/coredump_filter
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001830
1831When a new process is created, the process inherits the bitmask status from its
1832parent. It is useful to set up coredump_filter before the program runs.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001833For example::
Kawai, Hidehirobb901102007-07-19 01:48:31 -07001834
1835 $ echo 0x7 > /proc/self/coredump_filter
1836 $ ./some_program
1837
Shen Feng760df932009-04-02 16:57:20 -070018383.5 /proc/<pid>/mountinfo - Information about mounts
Ram Pai2d4d4862008-03-27 13:06:25 +01001839--------------------------------------------------------
1840
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001841This file contains lines of the form::
Ram Pai2d4d4862008-03-27 13:06:25 +01001842
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001843 36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue
1844 (1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)
Ram Pai2d4d4862008-03-27 13:06:25 +01001845
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001846 (1) mount ID: unique identifier of the mount (may be reused after umount)
1847 (2) parent ID: ID of parent (or of self for the top of the mount tree)
1848 (3) major:minor: value of st_dev for files on filesystem
1849 (4) root: root of the mount within the filesystem
1850 (5) mount point: mount point relative to the process's root
1851 (6) mount options: per mount options
1852 (7) optional fields: zero or more fields of the form "tag[:value]"
1853 (8) separator: marks the end of the optional fields
1854 (9) filesystem type: name of filesystem of the form "type[.subtype]"
1855 (10) mount source: filesystem specific information or "none"
1856 (11) super options: per super block options
Ram Pai2d4d4862008-03-27 13:06:25 +01001857
1858Parsers should ignore all unrecognised optional fields. Currently the
1859possible optional fields are:
1860
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001861================ ==============================================================
1862shared:X mount is shared in peer group X
1863master:X mount is slave to peer group X
1864propagate_from:X mount is slave and receives propagation from peer group X [#]_
1865unbindable mount is unbindable
1866================ ==============================================================
Ram Pai2d4d4862008-03-27 13:06:25 +01001867
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001868.. [#] X is the closest dominant peer group under the process's root. If
1869 X is the immediate master of the mount, or if there's no dominant peer
1870 group under the same root, then only the "master:X" field is present
1871 and not the "propagate_from:X" field.
Miklos Szeredi97e7e0f2008-03-27 13:06:26 +01001872
Ram Pai2d4d4862008-03-27 13:06:25 +01001873For more information on mount propagation see:
1874
1875 Documentation/filesystems/sharedsubtree.txt
1876
john stultz4614a696b2009-12-14 18:00:05 -08001877
18783.6 /proc/<pid>/comm & /proc/<pid>/task/<tid>/comm
1879--------------------------------------------------------
1880These files provide a method to access a tasks comm value. It also allows for
1881a task to set its own or one of its thread siblings comm value. The comm value
1882is limited in size compared to the cmdline value, so writing anything longer
1883then the kernel's TASK_COMM_LEN (currently 16 chars) will result in a truncated
1884comm value.
Vasiliy Kulikov04996802012-01-10 15:11:31 -08001885
1886
Cyrill Gorcunov818411612012-05-31 16:26:43 -070018873.7 /proc/<pid>/task/<tid>/children - Information about task children
1888-------------------------------------------------------------------------
1889This file provides a fast way to retrieve first level children pids
1890of a task pointed by <pid>/<tid> pair. The format is a space separated
1891stream of pids.
1892
1893Note the "first level" here -- if a child has own children they will
1894not be listed here, one needs to read /proc/<children-pid>/task/<tid>/children
1895to obtain the descendants.
1896
1897Since this interface is intended to be fast and cheap it doesn't
1898guarantee to provide precise results and some children might be
1899skipped, especially if they've exited right after we printed their
1900pids, so one need to either stop or freeze processes being inspected
1901if precise results are needed.
1902
1903
Andrey Vagin49d063c2014-04-07 15:38:34 -070019043.8 /proc/<pid>/fdinfo/<fd> - Information about opened file
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001905---------------------------------------------------------------
1906This file provides information associated with an opened file. The regular
Andrey Vagin49d063c2014-04-07 15:38:34 -07001907files have at least three fields -- 'pos', 'flags' and mnt_id. The 'pos'
1908represents the current offset of the opened file in decimal form [see lseek(2)
1909for details], 'flags' denotes the octal O_xxx mask the file has been
1910created with [see open(2) for details] and 'mnt_id' represents mount ID of
1911the file system containing the opened file [see 3.5 /proc/<pid>/mountinfo
1912for details].
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001913
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001914A typical output is::
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001915
1916 pos: 0
1917 flags: 0100002
Andrey Vagin49d063c2014-04-07 15:38:34 -07001918 mnt_id: 19
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001919
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001920All locks associated with a file descriptor are shown in its fdinfo too::
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001921
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001922 lock: 1: FLOCK ADVISORY WRITE 359 00:13:11691 0 EOF
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001923
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001924The files such as eventfd, fsnotify, signalfd, epoll among the regular pos/flags
1925pair provide additional information particular to the objects they represent.
1926
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001927Eventfd files
1928~~~~~~~~~~~~~
1929
1930::
1931
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001932 pos: 0
1933 flags: 04002
Andrey Vagin49d063c2014-04-07 15:38:34 -07001934 mnt_id: 9
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001935 eventfd-count: 5a
1936
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001937where 'eventfd-count' is hex value of a counter.
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001938
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001939Signalfd files
1940~~~~~~~~~~~~~~
1941
1942::
1943
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001944 pos: 0
1945 flags: 04002
Andrey Vagin49d063c2014-04-07 15:38:34 -07001946 mnt_id: 9
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001947 sigmask: 0000000000000200
1948
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001949where 'sigmask' is hex value of the signal mask associated
1950with a file.
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001951
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001952Epoll files
1953~~~~~~~~~~~
1954
1955::
1956
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001957 pos: 0
1958 flags: 02
Andrey Vagin49d063c2014-04-07 15:38:34 -07001959 mnt_id: 9
Cyrill Gorcunov77493f02017-07-12 14:34:25 -07001960 tfd: 5 events: 1d data: ffffffffffffffff pos:0 ino:61af sdev:7
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001961
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001962where 'tfd' is a target file descriptor number in decimal form,
1963'events' is events mask being watched and the 'data' is data
1964associated with a target [see epoll(7) for more details].
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001965
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001966The 'pos' is current offset of the target file in decimal form
1967[see lseek(2)], 'ino' and 'sdev' are inode and device numbers
1968where target file resides, all in hex format.
Cyrill Gorcunov77493f02017-07-12 14:34:25 -07001969
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001970Fsnotify files
1971~~~~~~~~~~~~~~
1972For inotify files the format is the following::
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001973
1974 pos: 0
1975 flags: 02000000
1976 inotify wd:3 ino:9e7e sdev:800013 mask:800afce ignored_mask:0 fhandle-bytes:8 fhandle-type:1 f_handle:7e9e0000640d1b6d
1977
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001978where 'wd' is a watch descriptor in decimal form, ie a target file
1979descriptor number, 'ino' and 'sdev' are inode and device where the
1980target file resides and the 'mask' is the mask of events, all in hex
1981form [see inotify(7) for more details].
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001982
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001983If the kernel was built with exportfs support, the path to the target
1984file is encoded as a file handle. The file handle is provided by three
1985fields 'fhandle-bytes', 'fhandle-type' and 'f_handle', all in hex
1986format.
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001987
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001988If the kernel is built without exportfs support the file handle won't be
1989printed out.
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001990
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001991If there is no inotify mark attached yet the 'inotify' line will be omitted.
Cyrill Gorcunove71ec592012-12-17 16:05:18 -08001992
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01001993For fanotify files the format is::
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08001994
1995 pos: 0
1996 flags: 02
Andrey Vagin49d063c2014-04-07 15:38:34 -07001997 mnt_id: 9
Cyrill Gorcunove71ec592012-12-17 16:05:18 -08001998 fanotify flags:10 event-flags:0
1999 fanotify mnt_id:12 mflags:40 mask:38 ignored_mask:40000003
2000 fanotify ino:4f969 sdev:800013 mflags:0 mask:3b ignored_mask:40000000 fhandle-bytes:8 fhandle-type:1 f_handle:69f90400c275b5b4
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08002001
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002002where fanotify 'flags' and 'event-flags' are values used in fanotify_init
2003call, 'mnt_id' is the mount point identifier, 'mflags' is the value of
2004flags associated with mark which are tracked separately from events
2005mask. 'ino', 'sdev' are target inode and device, 'mask' is the events
2006mask and 'ignored_mask' is the mask of events which are to be ignored.
2007All in hex format. Incorporation of 'mflags', 'mask' and 'ignored_mask'
2008does provide information about flags and mask used in fanotify_mark
2009call [see fsnotify manpage for details].
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08002010
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002011While the first three lines are mandatory and always printed, the rest is
2012optional and may be omitted if no marks created yet.
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08002013
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002014Timerfd files
2015~~~~~~~~~~~~~
2016
2017::
Cyrill Gorcunov854d06d2014-07-16 01:54:53 +04002018
2019 pos: 0
2020 flags: 02
2021 mnt_id: 9
2022 clockid: 0
2023 ticks: 0
2024 settime flags: 01
2025 it_value: (0, 49406829)
2026 it_interval: (1, 0)
2027
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002028where 'clockid' is the clock type and 'ticks' is the number of the timer expirations
2029that have occurred [see timerfd_create(2) for details]. 'settime flags' are
2030flags in octal form been used to setup the timer [see timerfd_settime(2) for
2031details]. 'it_value' is remaining time until the timer exiration.
2032'it_interval' is the interval for the timer. Note the timer might be set up
2033with TIMER_ABSTIME option which will be shown in 'settime flags', but 'it_value'
2034still exhibits timer's remaining time.
Cyrill Gorcunovf1d8c162012-12-17 16:05:14 -08002035
Cyrill Gorcunov740a5dd2015-02-11 15:28:31 -080020363.9 /proc/<pid>/map_files - Information about memory mapped files
2037---------------------------------------------------------------------
2038This directory contains symbolic links which represent memory mapped files
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002039the process is maintaining. Example output::
Cyrill Gorcunov740a5dd2015-02-11 15:28:31 -08002040
2041 | lr-------- 1 root root 64 Jan 27 11:24 333c600000-333c620000 -> /usr/lib64/ld-2.18.so
2042 | lr-------- 1 root root 64 Jan 27 11:24 333c81f000-333c820000 -> /usr/lib64/ld-2.18.so
2043 | lr-------- 1 root root 64 Jan 27 11:24 333c820000-333c821000 -> /usr/lib64/ld-2.18.so
2044 | ...
2045 | lr-------- 1 root root 64 Jan 27 11:24 35d0421000-35d0422000 -> /usr/lib64/libselinux.so.1
2046 | lr-------- 1 root root 64 Jan 27 11:24 400000-41a000 -> /usr/bin/ls
2047
2048The name of a link represents the virtual memory bounds of a mapping, i.e.
2049vm_area_struct::vm_start-vm_area_struct::vm_end.
2050
2051The main purpose of the map_files is to retrieve a set of memory mapped
2052files in a fast way instead of parsing /proc/<pid>/maps or
2053/proc/<pid>/smaps, both of which contain many more records. At the same
2054time one can open(2) mappings from the listings of two processes and
2055comparing their inode numbers to figure out which anonymous memory areas
2056are actually shared.
2057
John Stultz5de23d42016-03-17 14:20:54 -070020583.10 /proc/<pid>/timerslack_ns - Task timerslack value
2059---------------------------------------------------------
2060This file provides the value of the task's timerslack value in nanoseconds.
2061This value specifies a amount of time that normal timers may be deferred
2062in order to coalesce timers and avoid unnecessary wakeups.
2063
2064This allows a task's interactivity vs power consumption trade off to be
2065adjusted.
2066
2067Writing 0 to the file will set the tasks timerslack to the default value.
2068
2069Valid values are from 0 - ULLONG_MAX
2070
2071An application setting the value must have PTRACE_MODE_ATTACH_FSCREDS level
2072permissions on the task specified to change its timerslack_ns value.
2073
Josh Poimboeuf7c23b332017-02-13 19:42:41 -060020743.11 /proc/<pid>/patch_state - Livepatch patch operation state
2075-----------------------------------------------------------------
2076When CONFIG_LIVEPATCH is enabled, this file displays the value of the
2077patch state for the task.
2078
2079A value of '-1' indicates that no patch is in transition.
2080
2081A value of '0' indicates that a patch is in transition and the task is
2082unpatched. If the patch is being enabled, then the task hasn't been
2083patched yet. If the patch is being disabled, then the task has already
2084been unpatched.
2085
2086A value of '1' indicates that a patch is in transition and the task is
2087patched. If the patch is being enabled, then the task has already been
2088patched. If the patch is being disabled, then the task hasn't been
2089unpatched yet.
2090
Aubrey Li711486f2019-06-06 09:22:36 +080020913.12 /proc/<pid>/arch_status - task architecture specific status
2092-------------------------------------------------------------------
2093When CONFIG_PROC_PID_ARCH_STATUS is enabled, this file displays the
2094architecture specific status of the task.
2095
2096Example
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002097~~~~~~~
2098
2099::
2100
Aubrey Li711486f2019-06-06 09:22:36 +08002101 $ cat /proc/6753/arch_status
2102 AVX512_elapsed_ms: 8
2103
2104Description
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002105~~~~~~~~~~~
Aubrey Li711486f2019-06-06 09:22:36 +08002106
2107x86 specific entries:
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002108~~~~~~~~~~~~~~~~~~~~~
2109
2110AVX512_elapsed_ms:
2111^^^^^^^^^^^^^^^^^^
2112
Aubrey Li711486f2019-06-06 09:22:36 +08002113 If AVX512 is supported on the machine, this entry shows the milliseconds
2114 elapsed since the last time AVX512 usage was recorded. The recording
2115 happens on a best effort basis when a task is scheduled out. This means
2116 that the value depends on two factors:
2117
2118 1) The time which the task spent on the CPU without being scheduled
2119 out. With CPU isolation and a single runnable task this can take
2120 several seconds.
2121
2122 2) The time since the task was scheduled out last. Depending on the
2123 reason for being scheduled out (time slice exhausted, syscall ...)
2124 this can be arbitrary long time.
2125
2126 As a consequence the value cannot be considered precise and authoritative
2127 information. The application which uses this information has to be aware
2128 of the overall scenario on the system in order to determine whether a
2129 task is a real AVX512 user or not. Precise information can be obtained
2130 with performance counters.
2131
2132 A special value of '-1' indicates that no AVX512 usage was recorded, thus
2133 the task is unlikely an AVX512 user, but depends on the workload and the
2134 scheduling scenario, it also could be a false negative mentioned above.
John Stultz5de23d42016-03-17 14:20:54 -07002135
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002136Configuring procfs
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002137------------------
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002138
21394.1 Mount options
2140---------------------
2141
2142The following mount options are supported:
2143
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002144 ========= ========================================================
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002145 hidepid= Set /proc/<pid>/ access mode.
2146 gid= Set the group authorized to learn processes information.
Alexey Gladkov37e76472020-04-19 16:10:55 +02002147 subset= Show only the specified subset of procfs.
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +01002148 ========= ========================================================
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002149
Alexey Gladkov1c6c4d12020-04-19 16:10:56 +02002150hidepid=off or hidepid=0 means classic mode - everybody may access all
2151/proc/<pid>/ directories (default).
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002152
Alexey Gladkov1c6c4d12020-04-19 16:10:56 +02002153hidepid=noaccess or hidepid=1 means users may not access any /proc/<pid>/
2154directories but their own. Sensitive files like cmdline, sched*, status are now
2155protected against other users. This makes it impossible to learn whether any
2156user runs specific program (given the program doesn't reveal itself by its
2157behaviour). As an additional bonus, as /proc/<pid>/cmdline is unaccessible for
2158other users, poorly written programs passing sensitive information via program
2159arguments are now protected against local eavesdroppers.
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002160
Alexey Gladkov1c6c4d12020-04-19 16:10:56 +02002161hidepid=invisible or hidepid=2 means hidepid=1 plus all /proc/<pid>/ will be
2162fully invisible to other users. It doesn't mean that it hides a fact whether a
2163process with a specific pid value exists (it can be learned by other means, e.g.
2164by "kill -0 $PID"), but it hides process' uid and gid, which may be learned by
2165stat()'ing /proc/<pid>/ otherwise. It greatly complicates an intruder's task of
2166gathering information about running processes, whether some daemon runs with
2167elevated privileges, whether other user runs some sensitive program, whether
2168other users run any program at all, etc.
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002169
Alexey Gladkov1c6c4d12020-04-19 16:10:56 +02002170hidepid=ptraceable or hidepid=4 means that procfs should only contain
2171/proc/<pid>/ directories that the caller can ptrace.
Alexey Gladkov37e76472020-04-19 16:10:55 +02002172
Vasiliy Kulikov04996802012-01-10 15:11:31 -08002173gid= defines a group authorized to learn processes information otherwise
2174prohibited by hidepid=. If you use some daemon like identd which needs to learn
2175information about processes information, just add identd to this group.
Alexey Gladkov37e76472020-04-19 16:10:55 +02002176
2177subset=pid hides all top level files and directories in the procfs that
2178are not related to tasks.
2179
21805 Filesystem behavior
2181----------------------------
2182
2183Originally, before the advent of pid namepsace, procfs was a global file
2184system. It means that there was only one procfs instance in the system.
2185
2186When pid namespace was added, a separate procfs instance was mounted in
2187each pid namespace. So, procfs mount options are global among all
2188mountpoints within the same namespace.
2189
2190::
2191
2192# grep ^proc /proc/mounts
2193proc /proc proc rw,relatime,hidepid=2 0 0
2194
2195# strace -e mount mount -o hidepid=1 -t proc proc /tmp/proc
2196mount("proc", "/tmp/proc", "proc", 0, "hidepid=1") = 0
2197+++ exited with 0 +++
2198
2199# grep ^proc /proc/mounts
2200proc /proc proc rw,relatime,hidepid=2 0 0
2201proc /tmp/proc proc rw,relatime,hidepid=2 0 0
2202
2203and only after remounting procfs mount options will change at all
2204mountpoints.
2205
2206# mount -o remount,hidepid=1 -t proc proc /tmp/proc
2207
2208# grep ^proc /proc/mounts
2209proc /proc proc rw,relatime,hidepid=1 0 0
2210proc /tmp/proc proc rw,relatime,hidepid=1 0 0
2211
2212This behavior is different from the behavior of other filesystems.
2213
2214The new procfs behavior is more like other filesystems. Each procfs mount
2215creates a new procfs instance. Mount options affect own procfs instance.
2216It means that it became possible to have several procfs instances
2217displaying tasks with different filtering options in one pid namespace.
2218
Alexey Gladkov1c6c4d12020-04-19 16:10:56 +02002219# mount -o hidepid=invisible -t proc proc /proc
2220# mount -o hidepid=noaccess -t proc proc /tmp/proc
Alexey Gladkov37e76472020-04-19 16:10:55 +02002221# grep ^proc /proc/mounts
Alexey Gladkov1c6c4d12020-04-19 16:10:56 +02002222proc /proc proc rw,relatime,hidepid=invisible 0 0
2223proc /tmp/proc proc rw,relatime,hidepid=noaccess 0 0