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 <<
48 help 121 help
49 When the option is enabled, pstore w 122 When the option is enabled, pstore will export a character
50 interface /dev/pmsg0 to log user spa 123 interface /dev/pmsg0 to log user space messages. On reboot
51 data can be retrieved from /sys/fs/p 124 data can be retrieved from /sys/fs/pstore/pmsg-ramoops-[ID].
52 125
53 If unsure, say N. 126 If unsure, say N.
54 127
55 config PSTORE_FTRACE 128 config PSTORE_FTRACE
56 bool "Persistent function tracer" 129 bool "Persistent function tracer"
57 depends on PSTORE 130 depends on PSTORE
58 depends on FUNCTION_TRACER 131 depends on FUNCTION_TRACER
59 depends on DEBUG_FS 132 depends on DEBUG_FS
60 help 133 help
61 With this option kernel traces funct 134 With this option kernel traces function calls into a persistent
62 ram buffer that can be decoded and d 135 ram buffer that can be decoded and dumped after reboot through
63 pstore filesystem. It can be used to 136 pstore filesystem. It can be used to determine what function
64 was last called before a reset or pa 137 was last called before a reset or panic.
65 138
66 If unsure, say N. 139 If unsure, say N.
67 140
68 config PSTORE_RAM 141 config PSTORE_RAM
69 tristate "Log panic/oops to a RAM buff 142 tristate "Log panic/oops to a RAM buffer"
70 depends on PSTORE 143 depends on PSTORE
71 depends on HAS_IOMEM 144 depends on HAS_IOMEM
72 select REED_SOLOMON 145 select REED_SOLOMON
73 select REED_SOLOMON_ENC8 146 select REED_SOLOMON_ENC8
74 select REED_SOLOMON_DEC8 147 select REED_SOLOMON_DEC8
75 help 148 help
76 This enables panic and oops messages 149 This enables panic and oops messages to be logged to a circular
77 buffer in RAM where it can be read b 150 buffer in RAM where it can be read back at some later point.
78 151
79 Note that for historical reasons, th 152 Note that for historical reasons, the module will be named
80 "ramoops.ko". 153 "ramoops.ko".
81 154
82 For more information, see Documentat 155 For more information, see Documentation/admin-guide/ramoops.rst.
83 156
84 config PSTORE_ZONE 157 config PSTORE_ZONE
85 tristate 158 tristate
86 depends on PSTORE 159 depends on PSTORE
87 help 160 help
88 The common layer for pstore/blk (and 161 The common layer for pstore/blk (and pstore/ram in the future)
89 to manage storage in zones. 162 to manage storage in zones.
90 163
91 config PSTORE_BLK 164 config PSTORE_BLK
92 tristate "Log panic/oops to a block de 165 tristate "Log panic/oops to a block device"
93 depends on PSTORE 166 depends on PSTORE
94 depends on BLOCK 167 depends on BLOCK
95 select PSTORE_ZONE 168 select PSTORE_ZONE
96 default n 169 default n
97 help 170 help
98 This enables panic and oops message 171 This enables panic and oops message to be logged to a block dev
99 where it can be read back at some la 172 where it can be read back at some later point.
100 173
101 For more information, see Documentat 174 For more information, see Documentation/admin-guide/pstore-blk.rst
102 175
103 If unsure, say N. 176 If unsure, say N.
104 177
105 config PSTORE_BLK_BLKDEV 178 config PSTORE_BLK_BLKDEV
106 string "block device identifier" 179 string "block device identifier"
107 depends on PSTORE_BLK 180 depends on PSTORE_BLK
108 default "" 181 default ""
109 help 182 help
110 Which block device should be used fo 183 Which block device should be used for pstore/blk.
111 184
112 It accepts the following variants: 185 It accepts the following variants:
113 1) <hex_major><hex_minor> device num 186 1) <hex_major><hex_minor> device number in hexadecimal representation,
114 with no leading 0x, for example b 187 with no leading 0x, for example b302.
115 2) /dev/<disk_name> represents the d 188 2) /dev/<disk_name> represents the device name of disk
116 3) /dev/<disk_name><decimal> represe 189 3) /dev/<disk_name><decimal> represents the device name and number
117 of partition - device number of d 190 of partition - device number of disk plus the partition number
118 4) /dev/<disk_name>p<decimal> - same 191 4) /dev/<disk_name>p<decimal> - same as the above, this form is
119 used when disk name of partitione 192 used when disk name of partitioned disk ends with a digit.
120 5) PARTUUID=00112233-4455-6677-8899- 193 5) PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF representing the
121 unique id of a partition if the p 194 unique id of a partition if the partition table provides it.
122 The UUID may be either an EFI/GPT 195 The UUID may be either an EFI/GPT UUID, or refer to an MSDOS
123 partition using the format SSSSSS 196 partition using the format SSSSSSSS-PP, where SSSSSSSS is a zero-
124 filled hex representation of the 197 filled hex representation of the 32-bit "NT disk signature", and PP
125 is a zero-filled hex representati 198 is a zero-filled hex representation of the 1-based partition number.
126 6) PARTUUID=<UUID>/PARTNROFF=<int> t 199 6) PARTUUID=<UUID>/PARTNROFF=<int> to select a partition in relation
127 to a partition with a known uniqu 200 to a partition with a known unique id.
128 7) <major>:<minor> major and minor n 201 7) <major>:<minor> major and minor number of the device separated by
129 a colon. 202 a colon.
130 203
131 NOTE that, both Kconfig and module p 204 NOTE that, both Kconfig and module parameters can configure
132 pstore/blk, but module parameters ha 205 pstore/blk, but module parameters have priority over Kconfig.
133 206
134 config PSTORE_BLK_KMSG_SIZE 207 config PSTORE_BLK_KMSG_SIZE
135 int "Size in Kbytes of kmsg dump log t 208 int "Size in Kbytes of kmsg dump log to store"
136 depends on PSTORE_BLK 209 depends on PSTORE_BLK
137 default 64 210 default 64
138 help 211 help
139 This just sets size of kmsg dump (oo 212 This just sets size of kmsg dump (oops, panic, etc) log for
140 pstore/blk. The size is in KB and mu 213 pstore/blk. The size is in KB and must be a multiple of 4.
141 214
142 NOTE that, both Kconfig and module p 215 NOTE that, both Kconfig and module parameters can configure
143 pstore/blk, but module parameters ha 216 pstore/blk, but module parameters have priority over Kconfig.
144 217
145 config PSTORE_BLK_MAX_REASON 218 config PSTORE_BLK_MAX_REASON
146 int "Maximum kmsg dump reason to store 219 int "Maximum kmsg dump reason to store"
147 depends on PSTORE_BLK 220 depends on PSTORE_BLK
148 default 2 221 default 2
149 help 222 help
150 The maximum reason for kmsg dumps to 223 The maximum reason for kmsg dumps to store. The default is
151 2 (KMSG_DUMP_OOPS), see include/linu 224 2 (KMSG_DUMP_OOPS), see include/linux/kmsg_dump.h's
152 enum kmsg_dump_reason for more detai 225 enum kmsg_dump_reason for more details.
153 226
154 NOTE that, both Kconfig and module p 227 NOTE that, both Kconfig and module parameters can configure
155 pstore/blk, but module parameters ha 228 pstore/blk, but module parameters have priority over Kconfig.
156 229
157 config PSTORE_BLK_PMSG_SIZE 230 config PSTORE_BLK_PMSG_SIZE
158 int "Size in Kbytes of pmsg to store" 231 int "Size in Kbytes of pmsg to store"
159 depends on PSTORE_BLK 232 depends on PSTORE_BLK
160 depends on PSTORE_PMSG 233 depends on PSTORE_PMSG
161 default 64 234 default 64
162 help 235 help
163 This just sets size of pmsg (pmsg_si 236 This just sets size of pmsg (pmsg_size) for pstore/blk. The size is
164 in KB and must be a multiple of 4. 237 in KB and must be a multiple of 4.
165 238
166 NOTE that, both Kconfig and module p 239 NOTE that, both Kconfig and module parameters can configure
167 pstore/blk, but module parameters ha 240 pstore/blk, but module parameters have priority over Kconfig.
168 241
169 config PSTORE_BLK_CONSOLE_SIZE 242 config PSTORE_BLK_CONSOLE_SIZE
170 int "Size in Kbytes of console log to 243 int "Size in Kbytes of console log to store"
171 depends on PSTORE_BLK 244 depends on PSTORE_BLK
172 depends on PSTORE_CONSOLE 245 depends on PSTORE_CONSOLE
173 default 64 246 default 64
174 help 247 help
175 This just sets size of console log ( 248 This just sets size of console log (console_size) to store via
176 pstore/blk. The size is in KB and mu 249 pstore/blk. The size is in KB and must be a multiple of 4.
177 250
178 NOTE that, both Kconfig and module p 251 NOTE that, both Kconfig and module parameters can configure
179 pstore/blk, but module parameters ha 252 pstore/blk, but module parameters have priority over Kconfig.
180 253
181 config PSTORE_BLK_FTRACE_SIZE 254 config PSTORE_BLK_FTRACE_SIZE
182 int "Size in Kbytes of ftrace log to s 255 int "Size in Kbytes of ftrace log to store"
183 depends on PSTORE_BLK 256 depends on PSTORE_BLK
184 depends on PSTORE_FTRACE 257 depends on PSTORE_FTRACE
185 default 64 258 default 64
186 help 259 help
187 This just sets size of ftrace log (f 260 This just sets size of ftrace log (ftrace_size) for pstore/blk. The
188 size is in KB and must be a multiple 261 size is in KB and must be a multiple of 4.
189 262
190 NOTE that, both Kconfig and module p 263 NOTE that, both Kconfig and module parameters can configure
191 pstore/blk, but module parameters ha 264 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.