blob: d3cff4a7ee10592bfd411832c3af6d09000c1674 [file] [log] [blame]
Mauro Carvalho Chehab9fc36782021-09-16 10:59:37 +02001What: /sys/fs/pstore/...
2What: /dev/pstore/...
Luck, Tony366f7e72011-03-18 15:33:43 -07003Date: March 2011
Mauro Carvalho Chehab129fb4c2019-06-14 14:52:16 -03004KernelVersion: 2.6.39
Tony Luckca01d6d2010-12-28 14:25:21 -08005Contact: tony.luck@intel.com
6Description: Generic interface to platform dependent persistent storage.
7
8 Platforms that provide a mechanism to preserve some data
9 across system reboots can register with this driver to
10 provide a generic interface to show records captured in
11 the dying moments. In the case of a panic the last part
12 of the console log is captured, but other interesting
Mauro Carvalho Chehab54a19b42020-10-30 08:40:50 +010013 data can also be saved::
Tony Luckca01d6d2010-12-28 14:25:21 -080014
Mauro Carvalho Chehab54a19b42020-10-30 08:40:50 +010015 # mount -t pstore -o kmsg_bytes=8000 - /sys/fs/pstore
Tony Luckca01d6d2010-12-28 14:25:21 -080016
Mauro Carvalho Chehab54a19b42020-10-30 08:40:50 +010017 $ ls -l /sys/fs/pstore/
18 total 0
19 -r--r--r-- 1 root root 7896 Nov 30 15:38 dmesg-erst-1
Tony Luckca01d6d2010-12-28 14:25:21 -080020
21 Different users of this interface will result in different
22 filename prefixes. Currently two are defined:
23
Mauro Carvalho Chehab54a19b42020-10-30 08:40:50 +010024 - "dmesg" - saved console log
25 - "mce" - architecture dependent data from fatal h/w error
Tony Luckca01d6d2010-12-28 14:25:21 -080026
27 Once the information in a file has been read, removing
28 the file will signal to the underlying persistent storage
Mauro Carvalho Chehab54a19b42020-10-30 08:40:50 +010029 device that it can reclaim the space for later re-use::
Tony Luckca01d6d2010-12-28 14:25:21 -080030
Mauro Carvalho Chehab54a19b42020-10-30 08:40:50 +010031 $ rm /sys/fs/pstore/dmesg-erst-1
Tony Luckca01d6d2010-12-28 14:25:21 -080032
Josh Boyerfb0af3f2013-02-12 13:07:22 -080033 The expectation is that all files in /sys/fs/pstore/
Tony Luckca01d6d2010-12-28 14:25:21 -080034 will be saved elsewhere and erased from persistent store
35 soon after boot to free up space ready for the next
36 catastrophe.
Luck, Tony366f7e72011-03-18 15:33:43 -070037
38 The 'kmsg_bytes' mount option changes the target amount of
39 data saved on each oops/panic. Pstore saves (possibly
40 multiple) files based on the record size of the underlying
41 persistent storage until at least this amount is reached.
42 Default is 10 Kbytes.
Matthew Garrettdee28e72011-07-21 16:57:55 -040043
44 Pstore only supports one backend at a time. If multiple
45 backends are available, the preferred backend may be
46 set by passing the pstore.backend= argument to the kernel at
47 boot time.