1 # SPDX-License-Identifier: GPL-2.0-only 1 # SPDX-License-Identifier: GPL-2.0-only
2 config PSTORE 2 config PSTORE
3 tristate "Persistent store support" 3 tristate "Persistent store support"
>> 4 select CRYPTO if PSTORE_COMPRESS
4 default n 5 default n
5 help 6 help
6 This option enables generic access 7 This option enables generic access to platform level
7 persistent storage via "pstore" fil 8 persistent storage via "pstore" filesystem that can
8 be mounted as /dev/pstore. Only us 9 be mounted as /dev/pstore. Only useful if you have
9 a platform level driver that regist 10 a platform level driver that registers with pstore to
10 provide the data, so you probably s 11 provide the data, so you probably should just go say "Y"
11 (or "M") to a platform specific per 12 (or "M") to a platform specific persistent store driver
12 (e.g. ACPI_APEI on X86) which will 13 (e.g. ACPI_APEI on X86) which will select this for you.
13 If you don't have a platform persis 14 If you don't have a platform persistent store driver,
14 say N. 15 say N.
15 16
16 config PSTORE_DEFAULT_KMSG_BYTES !! 17 config PSTORE_DEFLATE_COMPRESS
17 int "Default kernel log storage space" !! 18 tristate "DEFLATE (ZLIB) compression"
>> 19 default y
>> 20 depends on PSTORE
>> 21 select CRYPTO_DEFLATE
>> 22 help
>> 23 This option enables DEFLATE (also known as ZLIB) compression
>> 24 algorithm support.
>> 25
>> 26 config PSTORE_LZO_COMPRESS
>> 27 tristate "LZO compression"
>> 28 depends on PSTORE
>> 29 select CRYPTO_LZO
>> 30 help
>> 31 This option enables LZO compression algorithm support.
>> 32
>> 33 config PSTORE_LZ4_COMPRESS
>> 34 tristate "LZ4 compression"
>> 35 depends on PSTORE
>> 36 select CRYPTO_LZ4
>> 37 help
>> 38 This option enables LZ4 compression algorithm support.
>> 39
>> 40 config PSTORE_LZ4HC_COMPRESS
>> 41 tristate "LZ4HC compression"
>> 42 depends on PSTORE
>> 43 select CRYPTO_LZ4HC
>> 44 help
>> 45 This option enables LZ4HC (high compression) mode algorithm.
>> 46
>> 47 config PSTORE_842_COMPRESS
>> 48 bool "842 compression"
>> 49 depends on PSTORE
>> 50 select CRYPTO_842
>> 51 help
>> 52 This option enables 842 compression algorithm support.
>> 53
>> 54 config PSTORE_ZSTD_COMPRESS
>> 55 bool "zstd compression"
18 depends on PSTORE 56 depends on PSTORE
19 default "10240" !! 57 select CRYPTO_ZSTD
20 help 58 help
21 Defines default size of pstore kerne !! 59 This option enables zstd compression algorithm support.
22 Can be enlarged if needed, not recom <<
23 60
24 config PSTORE_COMPRESS 61 config PSTORE_COMPRESS
25 bool "Pstore compression (deflate)" !! 62 def_bool y
26 depends on PSTORE 63 depends on PSTORE
27 select ZLIB_INFLATE !! 64 depends on PSTORE_DEFLATE_COMPRESS || PSTORE_LZO_COMPRESS || \
28 select ZLIB_DEFLATE !! 65 PSTORE_LZ4_COMPRESS || PSTORE_LZ4HC_COMPRESS || \
29 default y !! 66 PSTORE_842_COMPRESS || PSTORE_ZSTD_COMPRESS
>> 67
>> 68 choice
>> 69 prompt "Default pstore compression algorithm"
>> 70 depends on PSTORE_COMPRESS
30 help 71 help
31 Whether pstore records should be com !! 72 This option chooses the default active compression algorithm.
32 the backing store. This is implement !! 73 This change be changed at boot with "pstore.compress=..." on
33 algorithm, using the library impleme !! 74 the kernel command line.
34 blown crypto API. This reduces the r !! 75
35 problems while pstore is recording p !! 76 Currently, pstore has support for 6 compression algorithms:
>> 77 deflate, lzo, lz4, lz4hc, 842 and zstd.
>> 78
>> 79 The default compression algorithm is deflate.
>> 80
>> 81 config PSTORE_DEFLATE_COMPRESS_DEFAULT
>> 82 bool "deflate" if PSTORE_DEFLATE_COMPRESS
>> 83
>> 84 config PSTORE_LZO_COMPRESS_DEFAULT
>> 85 bool "lzo" if PSTORE_LZO_COMPRESS
>> 86
>> 87 config PSTORE_LZ4_COMPRESS_DEFAULT
>> 88 bool "lz4" if PSTORE_LZ4_COMPRESS
>> 89
>> 90 config PSTORE_LZ4HC_COMPRESS_DEFAULT
>> 91 bool "lz4hc" if PSTORE_LZ4HC_COMPRESS
>> 92
>> 93 config PSTORE_842_COMPRESS_DEFAULT
>> 94 bool "842" if PSTORE_842_COMPRESS
>> 95
>> 96 config PSTORE_ZSTD_COMPRESS_DEFAULT
>> 97 bool "zstd" if PSTORE_ZSTD_COMPRESS
>> 98
>> 99 endchoice
>> 100
>> 101 config PSTORE_COMPRESS_DEFAULT
>> 102 string
>> 103 depends on PSTORE_COMPRESS
>> 104 default "deflate" if PSTORE_DEFLATE_COMPRESS_DEFAULT
>> 105 default "lzo" if PSTORE_LZO_COMPRESS_DEFAULT
>> 106 default "lz4" if PSTORE_LZ4_COMPRESS_DEFAULT
>> 107 default "lz4hc" if PSTORE_LZ4HC_COMPRESS_DEFAULT
>> 108 default "842" if PSTORE_842_COMPRESS_DEFAULT
>> 109 default "zstd" if PSTORE_ZSTD_COMPRESS_DEFAULT
36 110
37 config PSTORE_CONSOLE 111 config PSTORE_CONSOLE
38 bool "Log kernel console messages" 112 bool "Log kernel console messages"
39 depends on PSTORE 113 depends on PSTORE
40 help 114 help
41 When the option is enabled, pstore w 115 When the option is enabled, pstore will log all kernel
42 messages, even if no oops or panic h 116 messages, even if no oops or panic happened.
43 117
44 config PSTORE_PMSG 118 config PSTORE_PMSG
45 bool "Log user space messages" 119 bool "Log user space messages"
46 depends on PSTORE 120 depends on PSTORE
47 select RT_MUTEXES 121 select RT_MUTEXES
48 help 122 help
49 When the option is enabled, pstore w 123 When the option is enabled, pstore will export a character
50 interface /dev/pmsg0 to log user spa 124 interface /dev/pmsg0 to log user space messages. On reboot
51 data can be retrieved from /sys/fs/p 125 data can be retrieved from /sys/fs/pstore/pmsg-ramoops-[ID].
52 126
53 If unsure, say N. 127 If unsure, say N.
54 128
55 config PSTORE_FTRACE 129 config PSTORE_FTRACE
56 bool "Persistent function tracer" 130 bool "Persistent function tracer"
57 depends on PSTORE 131 depends on PSTORE
58 depends on FUNCTION_TRACER 132 depends on FUNCTION_TRACER
59 depends on DEBUG_FS 133 depends on DEBUG_FS
60 help 134 help
61 With this option kernel traces funct 135 With this option kernel traces function calls into a persistent
62 ram buffer that can be decoded and d 136 ram buffer that can be decoded and dumped after reboot through
63 pstore filesystem. It can be used to 137 pstore filesystem. It can be used to determine what function
64 was last called before a reset or pa 138 was last called before a reset or panic.
65 139
66 If unsure, say N. 140 If unsure, say N.
67 141
68 config PSTORE_RAM 142 config PSTORE_RAM
69 tristate "Log panic/oops to a RAM buff 143 tristate "Log panic/oops to a RAM buffer"
70 depends on PSTORE 144 depends on PSTORE
71 depends on HAS_IOMEM 145 depends on HAS_IOMEM
72 select REED_SOLOMON 146 select REED_SOLOMON
73 select REED_SOLOMON_ENC8 147 select REED_SOLOMON_ENC8
74 select REED_SOLOMON_DEC8 148 select REED_SOLOMON_DEC8
75 help 149 help
76 This enables panic and oops messages 150 This enables panic and oops messages to be logged to a circular
77 buffer in RAM where it can be read b 151 buffer in RAM where it can be read back at some later point.
78 152
79 Note that for historical reasons, th 153 Note that for historical reasons, the module will be named
80 "ramoops.ko". 154 "ramoops.ko".
81 155
82 For more information, see Documentat 156 For more information, see Documentation/admin-guide/ramoops.rst.
83 157
84 config PSTORE_ZONE 158 config PSTORE_ZONE
85 tristate 159 tristate
86 depends on PSTORE 160 depends on PSTORE
87 help 161 help
88 The common layer for pstore/blk (and 162 The common layer for pstore/blk (and pstore/ram in the future)
89 to manage storage in zones. 163 to manage storage in zones.
90 164
91 config PSTORE_BLK 165 config PSTORE_BLK
92 tristate "Log panic/oops to a block de 166 tristate "Log panic/oops to a block device"
93 depends on PSTORE 167 depends on PSTORE
94 depends on BLOCK 168 depends on BLOCK
>> 169 depends on BROKEN
95 select PSTORE_ZONE 170 select PSTORE_ZONE
96 default n 171 default n
97 help 172 help
98 This enables panic and oops message 173 This enables panic and oops message to be logged to a block dev
99 where it can be read back at some la 174 where it can be read back at some later point.
100 175
101 For more information, see Documentat 176 For more information, see Documentation/admin-guide/pstore-blk.rst
102 177
103 If unsure, say N. 178 If unsure, say N.
104 179
105 config PSTORE_BLK_BLKDEV 180 config PSTORE_BLK_BLKDEV
106 string "block device identifier" 181 string "block device identifier"
107 depends on PSTORE_BLK 182 depends on PSTORE_BLK
108 default "" 183 default ""
109 help 184 help
110 Which block device should be used fo 185 Which block device should be used for pstore/blk.
111 186
112 It accepts the following variants: 187 It accepts the following variants:
113 1) <hex_major><hex_minor> device num 188 1) <hex_major><hex_minor> device number in hexadecimal representation,
114 with no leading 0x, for example b 189 with no leading 0x, for example b302.
115 2) /dev/<disk_name> represents the d 190 2) /dev/<disk_name> represents the device name of disk
116 3) /dev/<disk_name><decimal> represe 191 3) /dev/<disk_name><decimal> represents the device name and number
117 of partition - device number of d 192 of partition - device number of disk plus the partition number
118 4) /dev/<disk_name>p<decimal> - same 193 4) /dev/<disk_name>p<decimal> - same as the above, this form is
119 used when disk name of partitione 194 used when disk name of partitioned disk ends with a digit.
120 5) PARTUUID=00112233-4455-6677-8899- 195 5) PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF representing the
121 unique id of a partition if the p 196 unique id of a partition if the partition table provides it.
122 The UUID may be either an EFI/GPT 197 The UUID may be either an EFI/GPT UUID, or refer to an MSDOS
123 partition using the format SSSSSS 198 partition using the format SSSSSSSS-PP, where SSSSSSSS is a zero-
124 filled hex representation of the 199 filled hex representation of the 32-bit "NT disk signature", and PP
125 is a zero-filled hex representati 200 is a zero-filled hex representation of the 1-based partition number.
126 6) PARTUUID=<UUID>/PARTNROFF=<int> t 201 6) PARTUUID=<UUID>/PARTNROFF=<int> to select a partition in relation
127 to a partition with a known uniqu 202 to a partition with a known unique id.
128 7) <major>:<minor> major and minor n 203 7) <major>:<minor> major and minor number of the device separated by
129 a colon. 204 a colon.
130 205
131 NOTE that, both Kconfig and module p 206 NOTE that, both Kconfig and module parameters can configure
132 pstore/blk, but module parameters ha 207 pstore/blk, but module parameters have priority over Kconfig.
133 208
134 config PSTORE_BLK_KMSG_SIZE 209 config PSTORE_BLK_KMSG_SIZE
135 int "Size in Kbytes of kmsg dump log t 210 int "Size in Kbytes of kmsg dump log to store"
136 depends on PSTORE_BLK 211 depends on PSTORE_BLK
137 default 64 212 default 64
138 help 213 help
139 This just sets size of kmsg dump (oo 214 This just sets size of kmsg dump (oops, panic, etc) log for
140 pstore/blk. The size is in KB and mu 215 pstore/blk. The size is in KB and must be a multiple of 4.
141 216
142 NOTE that, both Kconfig and module p 217 NOTE that, both Kconfig and module parameters can configure
143 pstore/blk, but module parameters ha 218 pstore/blk, but module parameters have priority over Kconfig.
144 219
145 config PSTORE_BLK_MAX_REASON 220 config PSTORE_BLK_MAX_REASON
146 int "Maximum kmsg dump reason to store 221 int "Maximum kmsg dump reason to store"
147 depends on PSTORE_BLK 222 depends on PSTORE_BLK
148 default 2 223 default 2
149 help 224 help
150 The maximum reason for kmsg dumps to 225 The maximum reason for kmsg dumps to store. The default is
151 2 (KMSG_DUMP_OOPS), see include/linu 226 2 (KMSG_DUMP_OOPS), see include/linux/kmsg_dump.h's
152 enum kmsg_dump_reason for more detai 227 enum kmsg_dump_reason for more details.
153 228
154 NOTE that, both Kconfig and module p 229 NOTE that, both Kconfig and module parameters can configure
155 pstore/blk, but module parameters ha 230 pstore/blk, but module parameters have priority over Kconfig.
156 231
157 config PSTORE_BLK_PMSG_SIZE 232 config PSTORE_BLK_PMSG_SIZE
158 int "Size in Kbytes of pmsg to store" 233 int "Size in Kbytes of pmsg to store"
159 depends on PSTORE_BLK 234 depends on PSTORE_BLK
160 depends on PSTORE_PMSG 235 depends on PSTORE_PMSG
161 default 64 236 default 64
162 help 237 help
163 This just sets size of pmsg (pmsg_si 238 This just sets size of pmsg (pmsg_size) for pstore/blk. The size is
164 in KB and must be a multiple of 4. 239 in KB and must be a multiple of 4.
165 240
166 NOTE that, both Kconfig and module p 241 NOTE that, both Kconfig and module parameters can configure
167 pstore/blk, but module parameters ha 242 pstore/blk, but module parameters have priority over Kconfig.
168 243
169 config PSTORE_BLK_CONSOLE_SIZE 244 config PSTORE_BLK_CONSOLE_SIZE
170 int "Size in Kbytes of console log to 245 int "Size in Kbytes of console log to store"
171 depends on PSTORE_BLK 246 depends on PSTORE_BLK
172 depends on PSTORE_CONSOLE 247 depends on PSTORE_CONSOLE
173 default 64 248 default 64
174 help 249 help
175 This just sets size of console log ( 250 This just sets size of console log (console_size) to store via
176 pstore/blk. The size is in KB and mu 251 pstore/blk. The size is in KB and must be a multiple of 4.
177 252
178 NOTE that, both Kconfig and module p 253 NOTE that, both Kconfig and module parameters can configure
179 pstore/blk, but module parameters ha 254 pstore/blk, but module parameters have priority over Kconfig.
180 255
181 config PSTORE_BLK_FTRACE_SIZE 256 config PSTORE_BLK_FTRACE_SIZE
182 int "Size in Kbytes of ftrace log to s 257 int "Size in Kbytes of ftrace log to store"
183 depends on PSTORE_BLK 258 depends on PSTORE_BLK
184 depends on PSTORE_FTRACE 259 depends on PSTORE_FTRACE
185 default 64 260 default 64
186 help 261 help
187 This just sets size of ftrace log (f 262 This just sets size of ftrace log (ftrace_size) for pstore/blk. The
188 size is in KB and must be a multiple 263 size is in KB and must be a multiple of 4.
189 264
190 NOTE that, both Kconfig and module p 265 NOTE that, both Kconfig and module parameters can configure
191 pstore/blk, but module parameters ha 266 pstore/blk, but module parameters have priority over Kconfig.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.