Skip to contentSkip to conversation

pstore: new filesystem interface to platform persistent storage

PATCH New Luck, Tony 1 participant 1 message Dec 28, 2010

Subsystems (3)
lore
Share & tools
lore

Luck, Tony

author reviewer
#0 lore raw

PATCH 1/1 pstore: new filesystem interface to platform persistent storage

Some platforms have a small amount of non-volatile storage that can be used to store information useful to diagnose the cause of a system crash. This is the generic part of a file system interface that presents information from the crash as a series of files in /dev/pstore. Once the information has been seen, the underlying storage is freed by deleting the files.

---

Biggest changes from the previous version are
1) Save *all* oopses as well as panics.
2) Make files appear in /dev/pstore on running system so they can be erased (after being saved) for non-fatal errors.
3) Loop writing multiple records to log "enough" - default is 10K, but this can be changed using /sys/fs/pstore/kmsg_bytes.

Documentation/ABI/testing/pstore new file +35 -0
new file mode 100644
index 0000000..f1fb2a0
@@ -0,0 +1,35 @@
+Where:		/dev/pstore/...
+Date:		January 2011
+Kernel Version: 2.6.38
+Contact:	[email protected]
+Description:	Generic interface to platform dependent persistent storage.
+
+		Platforms that provide a mechanism to preserve some data
+		across system reboots can register with this driver to
+		provide a generic interface to show records captured in
+		the dying moments.  In the case of a panic the last part
+		of the console log is captured, but other interesting
+		data can also be saved.
+
+		# mount -t pstore - /dev/pstore
+
+		$ ls -l /dev/pstore
+		total 0
+		-r--r--r-- 1 root root 7896 Nov 30 15:38 dmesg-erst-1
+
+		Different users of this interface will result in different
+		filename prefixes.  Currently two are defined:
+
+		"dmesg"	- saved console log
+		"mce"	- architecture dependent data from fatal h/w error
+
+		Once the information in a file has been read, removing
+		the file will signal to the underlying persistent storage
+		device that it can reclaim the space for later re-use.
+
+		$ rm /dev/pstore/dmesg-erst-1
+
+		The expectation is that all files in /dev/pstore
+		will be saved elsewhere and erased from persistent store
+		soon after boot to free up space ready for the next
+		catastrophe.
Documentation/ABI/testing/sysfs-fs-pstore new file +7 -0
new file mode 100644
index 0000000..8e659d8
@@ -0,0 +1,7 @@
+What:		/sys/fs/pstore/kmsg_bytes
+Date:		January 2011
+Kernel Version: 2.6.38
+Contact:	"Tony Luck" <[email protected]>
+Description:
+		Controls amount of console log that will be saved
+		to persistent store on oops/panic.
fs/Kconfig +1 -0
index 771f457..2bbe47f 100644
@@ -188,6 +188,7 @@ source "fs/omfs/Kconfig"
 source "fs/hpfs/Kconfig"
 source "fs/qnx4/Kconfig"
 source "fs/romfs/Kconfig"
+source "fs/pstore/Kconfig"
 source "fs/sysv/Kconfig"
 source "fs/ufs/Kconfig"
 source "fs/exofs/Kconfig"
fs/Makefile +1 -0
index a7f7cef..db71a5b 100644
@@ -121,3 +121,4 @@ obj-$(CONFIG_BTRFS_FS)		+= btrfs/
 obj-$(CONFIG_GFS2_FS)           += gfs2/
 obj-$(CONFIG_EXOFS_FS)          += exofs/
 obj-$(CONFIG_CEPH_FS)		+= ceph/
+obj-$(CONFIG_PSTORE)		+= pstore/
fs/pstore/Kconfig new file +13 -0
new file mode 100644
index 0000000..867d0ac
@@ -0,0 +1,13 @@
+config PSTORE
+	bool "Persistant store support"
+	default n
+	help
+	   This option enables generic access to platform level
+	   persistent storage via "pstore" filesystem that can
+	   be mounted as /dev/pstore.  Only useful if you have
+	   a platform level driver that registers with pstore to
+	   provide the data, so you probably should just go say "Y"
+	   (or "M") to a platform specific persistent store driver
+	   (e.g. ACPI_APEI on X86) which will select this for you.
+	   If you don't have a platform persistent store driver,
+	   say N.
fs/pstore/Makefile new file +7 -0
new file mode 100644
index 0000000..760f4bc
@@ -0,0 +1,7 @@
+#
+# Makefile for the linux pstorefs routines.
+#
+
+obj-y += pstore.o
+
+pstore-objs += inode.o platform.o
fs/pstore/inode.c new file +280 -0

280 lines not on this page · raw message

fs/pstore/internal.h new file +7 -0
new file mode 100644
index 0000000..76c26d2
@@ -0,0 +1,7 @@
+extern void	pstore_get_records(void);
+extern int	pstore_mkfile(enum pstore_type_id, char *psname, u64 id,
+			      char *data, size_t size,
+			      struct timespec time, int (*erase)(u64));
+extern int	pstore_is_mounted(void);
+
+extern struct kobj_attribute pstore_kmsg_bytes_attr;
fs/pstore/platform.c new file +202 -0

202 lines not on this page · raw message

include/linux/magic.h +1 -0
index ff690d0..e87fd5a 100644
@@ -26,6 +26,7 @@
 #define ISOFS_SUPER_MAGIC	0x9660
 #define JFFS2_SUPER_MAGIC	0x72b6
 #define ANON_INODE_FS_MAGIC	0x09041934
+#define PSTOREFS_MAGIC		0x6165676C
 
 #define MINIX_SUPER_MAGIC	0x137F		/* original minix fs */
 #define MINIX_SUPER_MAGIC2	0x138F		/* minix fs, 30 char names */
include/linux/pstore.h new file +60 -0

60 lines not on this page · raw message