Linux 4.8.3
[linux/fpc-iii.git] / fs / pstore / platform.c
blob16ecca5b72d815d92163def3f03bd9f26c4cc8b1
1 /*
2 * Persistent Storage - platform driver interface parts.
4 * Copyright (C) 2007-2008 Google, Inc.
5 * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #define pr_fmt(fmt) "pstore: " fmt
23 #include <linux/atomic.h>
24 #include <linux/types.h>
25 #include <linux/errno.h>
26 #include <linux/init.h>
27 #include <linux/kmsg_dump.h>
28 #include <linux/console.h>
29 #include <linux/module.h>
30 #include <linux/pstore.h>
31 #ifdef CONFIG_PSTORE_ZLIB_COMPRESS
32 #include <linux/zlib.h>
33 #endif
34 #ifdef CONFIG_PSTORE_LZO_COMPRESS
35 #include <linux/lzo.h>
36 #endif
37 #ifdef CONFIG_PSTORE_LZ4_COMPRESS
38 #include <linux/lz4.h>
39 #endif
40 #include <linux/string.h>
41 #include <linux/timer.h>
42 #include <linux/slab.h>
43 #include <linux/uaccess.h>
44 #include <linux/hardirq.h>
45 #include <linux/jiffies.h>
46 #include <linux/workqueue.h>
48 #include "internal.h"
51 * We defer making "oops" entries appear in pstore - see
52 * whether the system is actually still running well enough
53 * to let someone see the entry
55 static int pstore_update_ms = -1;
56 module_param_named(update_ms, pstore_update_ms, int, 0600);
57 MODULE_PARM_DESC(update_ms, "milliseconds before pstore updates its content "
58 "(default is -1, which means runtime updates are disabled; "
59 "enabling this option is not safe, it may lead to further "
60 "corruption on Oopses)");
62 static int pstore_new_entry;
64 static void pstore_timefunc(unsigned long);
65 static DEFINE_TIMER(pstore_timer, pstore_timefunc, 0, 0);
67 static void pstore_dowork(struct work_struct *);
68 static DECLARE_WORK(pstore_work, pstore_dowork);
71 * pstore_lock just protects "psinfo" during
72 * calls to pstore_register()
74 static DEFINE_SPINLOCK(pstore_lock);
75 struct pstore_info *psinfo;
77 static char *backend;
79 /* Compression parameters */
80 #ifdef CONFIG_PSTORE_ZLIB_COMPRESS
81 #define COMPR_LEVEL 6
82 #define WINDOW_BITS 12
83 #define MEM_LEVEL 4
84 static struct z_stream_s stream;
85 #else
86 static unsigned char *workspace;
87 #endif
89 struct pstore_zbackend {
90 int (*compress)(const void *in, void *out, size_t inlen, size_t outlen);
91 int (*decompress)(void *in, void *out, size_t inlen, size_t outlen);
92 void (*allocate)(void);
93 void (*free)(void);
95 const char *name;
98 static char *big_oops_buf;
99 static size_t big_oops_buf_sz;
101 /* How much of the console log to snapshot */
102 static unsigned long kmsg_bytes = 10240;
104 void pstore_set_kmsg_bytes(int bytes)
106 kmsg_bytes = bytes;
109 /* Tag each group of saved records with a sequence number */
110 static int oopscount;
112 static const char *get_reason_str(enum kmsg_dump_reason reason)
114 switch (reason) {
115 case KMSG_DUMP_PANIC:
116 return "Panic";
117 case KMSG_DUMP_OOPS:
118 return "Oops";
119 case KMSG_DUMP_EMERG:
120 return "Emergency";
121 case KMSG_DUMP_RESTART:
122 return "Restart";
123 case KMSG_DUMP_HALT:
124 return "Halt";
125 case KMSG_DUMP_POWEROFF:
126 return "Poweroff";
127 default:
128 return "Unknown";
132 bool pstore_cannot_block_path(enum kmsg_dump_reason reason)
135 * In case of NMI path, pstore shouldn't be blocked
136 * regardless of reason.
138 if (in_nmi())
139 return true;
141 switch (reason) {
142 /* In panic case, other cpus are stopped by smp_send_stop(). */
143 case KMSG_DUMP_PANIC:
144 /* Emergency restart shouldn't be blocked by spin lock. */
145 case KMSG_DUMP_EMERG:
146 return true;
147 default:
148 return false;
151 EXPORT_SYMBOL_GPL(pstore_cannot_block_path);
153 #ifdef CONFIG_PSTORE_ZLIB_COMPRESS
154 /* Derived from logfs_compress() */
155 static int compress_zlib(const void *in, void *out, size_t inlen, size_t outlen)
157 int err, ret;
159 ret = -EIO;
160 err = zlib_deflateInit2(&stream, COMPR_LEVEL, Z_DEFLATED, WINDOW_BITS,
161 MEM_LEVEL, Z_DEFAULT_STRATEGY);
162 if (err != Z_OK)
163 goto error;
165 stream.next_in = in;
166 stream.avail_in = inlen;
167 stream.total_in = 0;
168 stream.next_out = out;
169 stream.avail_out = outlen;
170 stream.total_out = 0;
172 err = zlib_deflate(&stream, Z_FINISH);
173 if (err != Z_STREAM_END)
174 goto error;
176 err = zlib_deflateEnd(&stream);
177 if (err != Z_OK)
178 goto error;
180 if (stream.total_out >= stream.total_in)
181 goto error;
183 ret = stream.total_out;
184 error:
185 return ret;
188 /* Derived from logfs_uncompress */
189 static int decompress_zlib(void *in, void *out, size_t inlen, size_t outlen)
191 int err, ret;
193 ret = -EIO;
194 err = zlib_inflateInit2(&stream, WINDOW_BITS);
195 if (err != Z_OK)
196 goto error;
198 stream.next_in = in;
199 stream.avail_in = inlen;
200 stream.total_in = 0;
201 stream.next_out = out;
202 stream.avail_out = outlen;
203 stream.total_out = 0;
205 err = zlib_inflate(&stream, Z_FINISH);
206 if (err != Z_STREAM_END)
207 goto error;
209 err = zlib_inflateEnd(&stream);
210 if (err != Z_OK)
211 goto error;
213 ret = stream.total_out;
214 error:
215 return ret;
218 static void allocate_zlib(void)
220 size_t size;
221 size_t cmpr;
223 switch (psinfo->bufsize) {
224 /* buffer range for efivars */
225 case 1000 ... 2000:
226 cmpr = 56;
227 break;
228 case 2001 ... 3000:
229 cmpr = 54;
230 break;
231 case 3001 ... 3999:
232 cmpr = 52;
233 break;
234 /* buffer range for nvram, erst */
235 case 4000 ... 10000:
236 cmpr = 45;
237 break;
238 default:
239 cmpr = 60;
240 break;
243 big_oops_buf_sz = (psinfo->bufsize * 100) / cmpr;
244 big_oops_buf = kmalloc(big_oops_buf_sz, GFP_KERNEL);
245 if (big_oops_buf) {
246 size = max(zlib_deflate_workspacesize(WINDOW_BITS, MEM_LEVEL),
247 zlib_inflate_workspacesize());
248 stream.workspace = kmalloc(size, GFP_KERNEL);
249 if (!stream.workspace) {
250 pr_err("No memory for compression workspace; skipping compression\n");
251 kfree(big_oops_buf);
252 big_oops_buf = NULL;
254 } else {
255 pr_err("No memory for uncompressed data; skipping compression\n");
256 stream.workspace = NULL;
261 static void free_zlib(void)
263 kfree(stream.workspace);
264 stream.workspace = NULL;
265 kfree(big_oops_buf);
266 big_oops_buf = NULL;
267 big_oops_buf_sz = 0;
270 static struct pstore_zbackend backend_zlib = {
271 .compress = compress_zlib,
272 .decompress = decompress_zlib,
273 .allocate = allocate_zlib,
274 .free = free_zlib,
275 .name = "zlib",
277 #endif
279 #ifdef CONFIG_PSTORE_LZO_COMPRESS
280 static int compress_lzo(const void *in, void *out, size_t inlen, size_t outlen)
282 int ret;
284 ret = lzo1x_1_compress(in, inlen, out, &outlen, workspace);
285 if (ret != LZO_E_OK) {
286 pr_err("lzo_compress error, ret = %d!\n", ret);
287 return -EIO;
290 return outlen;
293 static int decompress_lzo(void *in, void *out, size_t inlen, size_t outlen)
295 int ret;
297 ret = lzo1x_decompress_safe(in, inlen, out, &outlen);
298 if (ret != LZO_E_OK) {
299 pr_err("lzo_decompress error, ret = %d!\n", ret);
300 return -EIO;
303 return outlen;
306 static void allocate_lzo(void)
308 big_oops_buf_sz = lzo1x_worst_compress(psinfo->bufsize);
309 big_oops_buf = kmalloc(big_oops_buf_sz, GFP_KERNEL);
310 if (big_oops_buf) {
311 workspace = kmalloc(LZO1X_MEM_COMPRESS, GFP_KERNEL);
312 if (!workspace) {
313 pr_err("No memory for compression workspace; skipping compression\n");
314 kfree(big_oops_buf);
315 big_oops_buf = NULL;
317 } else {
318 pr_err("No memory for uncompressed data; skipping compression\n");
319 workspace = NULL;
323 static void free_lzo(void)
325 kfree(workspace);
326 kfree(big_oops_buf);
327 big_oops_buf = NULL;
328 big_oops_buf_sz = 0;
331 static struct pstore_zbackend backend_lzo = {
332 .compress = compress_lzo,
333 .decompress = decompress_lzo,
334 .allocate = allocate_lzo,
335 .free = free_lzo,
336 .name = "lzo",
338 #endif
340 #ifdef CONFIG_PSTORE_LZ4_COMPRESS
341 static int compress_lz4(const void *in, void *out, size_t inlen, size_t outlen)
343 int ret;
345 ret = lz4_compress(in, inlen, out, &outlen, workspace);
346 if (ret) {
347 pr_err("lz4_compress error, ret = %d!\n", ret);
348 return -EIO;
351 return outlen;
354 static int decompress_lz4(void *in, void *out, size_t inlen, size_t outlen)
356 int ret;
358 ret = lz4_decompress_unknownoutputsize(in, inlen, out, &outlen);
359 if (ret) {
360 pr_err("lz4_decompress error, ret = %d!\n", ret);
361 return -EIO;
364 return outlen;
367 static void allocate_lz4(void)
369 big_oops_buf_sz = lz4_compressbound(psinfo->bufsize);
370 big_oops_buf = kmalloc(big_oops_buf_sz, GFP_KERNEL);
371 if (big_oops_buf) {
372 workspace = kmalloc(LZ4_MEM_COMPRESS, GFP_KERNEL);
373 if (!workspace) {
374 pr_err("No memory for compression workspace; skipping compression\n");
375 kfree(big_oops_buf);
376 big_oops_buf = NULL;
378 } else {
379 pr_err("No memory for uncompressed data; skipping compression\n");
380 workspace = NULL;
384 static void free_lz4(void)
386 kfree(workspace);
387 kfree(big_oops_buf);
388 big_oops_buf = NULL;
389 big_oops_buf_sz = 0;
392 static struct pstore_zbackend backend_lz4 = {
393 .compress = compress_lz4,
394 .decompress = decompress_lz4,
395 .allocate = allocate_lz4,
396 .free = free_lz4,
397 .name = "lz4",
399 #endif
401 static struct pstore_zbackend *zbackend =
402 #if defined(CONFIG_PSTORE_ZLIB_COMPRESS)
403 &backend_zlib;
404 #elif defined(CONFIG_PSTORE_LZO_COMPRESS)
405 &backend_lzo;
406 #elif defined(CONFIG_PSTORE_LZ4_COMPRESS)
407 &backend_lz4;
408 #else
409 NULL;
410 #endif
412 static int pstore_compress(const void *in, void *out,
413 size_t inlen, size_t outlen)
415 if (zbackend)
416 return zbackend->compress(in, out, inlen, outlen);
417 else
418 return -EIO;
421 static int pstore_decompress(void *in, void *out, size_t inlen, size_t outlen)
423 if (zbackend)
424 return zbackend->decompress(in, out, inlen, outlen);
425 else
426 return -EIO;
429 static void allocate_buf_for_compression(void)
431 if (zbackend) {
432 pr_info("using %s compression\n", zbackend->name);
433 zbackend->allocate();
434 } else {
435 pr_err("allocate compression buffer error!\n");
439 static void free_buf_for_compression(void)
441 if (zbackend)
442 zbackend->free();
443 else
444 pr_err("free compression buffer error!\n");
448 * Called when compression fails, since the printk buffer
449 * would be fetched for compression calling it again when
450 * compression fails would have moved the iterator of
451 * printk buffer which results in fetching old contents.
452 * Copy the recent messages from big_oops_buf to psinfo->buf
454 static size_t copy_kmsg_to_buffer(int hsize, size_t len)
456 size_t total_len;
457 size_t diff;
459 total_len = hsize + len;
461 if (total_len > psinfo->bufsize) {
462 diff = total_len - psinfo->bufsize + hsize;
463 memcpy(psinfo->buf, big_oops_buf, hsize);
464 memcpy(psinfo->buf + hsize, big_oops_buf + diff,
465 psinfo->bufsize - hsize);
466 total_len = psinfo->bufsize;
467 } else
468 memcpy(psinfo->buf, big_oops_buf, total_len);
470 return total_len;
474 * callback from kmsg_dump. (s2,l2) has the most recently
475 * written bytes, older bytes are in (s1,l1). Save as much
476 * as we can from the end of the buffer.
478 static void pstore_dump(struct kmsg_dumper *dumper,
479 enum kmsg_dump_reason reason)
481 unsigned long total = 0;
482 const char *why;
483 u64 id;
484 unsigned int part = 1;
485 unsigned long flags = 0;
486 int is_locked;
487 int ret;
489 why = get_reason_str(reason);
491 if (pstore_cannot_block_path(reason)) {
492 is_locked = spin_trylock_irqsave(&psinfo->buf_lock, flags);
493 if (!is_locked) {
494 pr_err("pstore dump routine blocked in %s path, may corrupt error record\n"
495 , in_nmi() ? "NMI" : why);
497 } else {
498 spin_lock_irqsave(&psinfo->buf_lock, flags);
499 is_locked = 1;
501 oopscount++;
502 while (total < kmsg_bytes) {
503 char *dst;
504 unsigned long size;
505 int hsize;
506 int zipped_len = -1;
507 size_t len;
508 bool compressed = false;
509 size_t total_len;
511 if (big_oops_buf && is_locked) {
512 dst = big_oops_buf;
513 size = big_oops_buf_sz;
514 } else {
515 dst = psinfo->buf;
516 size = psinfo->bufsize;
519 hsize = sprintf(dst, "%s#%d Part%u\n", why, oopscount, part);
520 size -= hsize;
522 if (!kmsg_dump_get_buffer(dumper, true, dst + hsize,
523 size, &len))
524 break;
526 if (big_oops_buf && is_locked) {
527 zipped_len = pstore_compress(dst, psinfo->buf,
528 hsize + len, psinfo->bufsize);
530 if (zipped_len > 0) {
531 compressed = true;
532 total_len = zipped_len;
533 } else {
534 total_len = copy_kmsg_to_buffer(hsize, len);
536 } else {
537 total_len = hsize + len;
540 ret = psinfo->write(PSTORE_TYPE_DMESG, reason, &id, part,
541 oopscount, compressed, total_len, psinfo);
542 if (ret == 0 && reason == KMSG_DUMP_OOPS && pstore_is_mounted())
543 pstore_new_entry = 1;
545 total += total_len;
546 part++;
548 if (is_locked)
549 spin_unlock_irqrestore(&psinfo->buf_lock, flags);
552 static struct kmsg_dumper pstore_dumper = {
553 .dump = pstore_dump,
557 * Register with kmsg_dump to save last part of console log on panic.
559 static void pstore_register_kmsg(void)
561 kmsg_dump_register(&pstore_dumper);
564 static void pstore_unregister_kmsg(void)
566 kmsg_dump_unregister(&pstore_dumper);
569 #ifdef CONFIG_PSTORE_CONSOLE
570 static void pstore_console_write(struct console *con, const char *s, unsigned c)
572 const char *e = s + c;
574 while (s < e) {
575 unsigned long flags;
576 u64 id;
578 if (c > psinfo->bufsize)
579 c = psinfo->bufsize;
581 if (oops_in_progress) {
582 if (!spin_trylock_irqsave(&psinfo->buf_lock, flags))
583 break;
584 } else {
585 spin_lock_irqsave(&psinfo->buf_lock, flags);
587 memcpy(psinfo->buf, s, c);
588 psinfo->write(PSTORE_TYPE_CONSOLE, 0, &id, 0, 0, 0, c, psinfo);
589 spin_unlock_irqrestore(&psinfo->buf_lock, flags);
590 s += c;
591 c = e - s;
595 static struct console pstore_console = {
596 .name = "pstore",
597 .write = pstore_console_write,
598 .flags = CON_PRINTBUFFER | CON_ENABLED | CON_ANYTIME,
599 .index = -1,
602 static void pstore_register_console(void)
604 register_console(&pstore_console);
607 static void pstore_unregister_console(void)
609 unregister_console(&pstore_console);
611 #else
612 static void pstore_register_console(void) {}
613 static void pstore_unregister_console(void) {}
614 #endif
616 static int pstore_write_compat(enum pstore_type_id type,
617 enum kmsg_dump_reason reason,
618 u64 *id, unsigned int part, int count,
619 bool compressed, size_t size,
620 struct pstore_info *psi)
622 return psi->write_buf(type, reason, id, part, psinfo->buf, compressed,
623 size, psi);
627 * platform specific persistent storage driver registers with
628 * us here. If pstore is already mounted, call the platform
629 * read function right away to populate the file system. If not
630 * then the pstore mount code will call us later to fill out
631 * the file system.
633 int pstore_register(struct pstore_info *psi)
635 struct module *owner = psi->owner;
637 if (backend && strcmp(backend, psi->name))
638 return -EPERM;
640 spin_lock(&pstore_lock);
641 if (psinfo) {
642 spin_unlock(&pstore_lock);
643 return -EBUSY;
646 if (!psi->write)
647 psi->write = pstore_write_compat;
648 psinfo = psi;
649 mutex_init(&psinfo->read_mutex);
650 spin_unlock(&pstore_lock);
652 if (owner && !try_module_get(owner)) {
653 psinfo = NULL;
654 return -EINVAL;
657 allocate_buf_for_compression();
659 if (pstore_is_mounted())
660 pstore_get_records(0);
662 pstore_register_kmsg();
664 if ((psi->flags & PSTORE_FLAGS_FRAGILE) == 0) {
665 pstore_register_console();
666 pstore_register_ftrace();
667 pstore_register_pmsg();
670 if (pstore_update_ms >= 0) {
671 pstore_timer.expires = jiffies +
672 msecs_to_jiffies(pstore_update_ms);
673 add_timer(&pstore_timer);
677 * Update the module parameter backend, so it is visible
678 * through /sys/module/pstore/parameters/backend
680 backend = psi->name;
682 module_put(owner);
684 pr_info("Registered %s as persistent store backend\n", psi->name);
686 return 0;
688 EXPORT_SYMBOL_GPL(pstore_register);
690 void pstore_unregister(struct pstore_info *psi)
692 if ((psi->flags & PSTORE_FLAGS_FRAGILE) == 0) {
693 pstore_unregister_pmsg();
694 pstore_unregister_ftrace();
695 pstore_unregister_console();
697 pstore_unregister_kmsg();
699 free_buf_for_compression();
701 psinfo = NULL;
702 backend = NULL;
704 EXPORT_SYMBOL_GPL(pstore_unregister);
707 * Read all the records from the persistent store. Create
708 * files in our filesystem. Don't warn about -EEXIST errors
709 * when we are re-scanning the backing store looking to add new
710 * error records.
712 void pstore_get_records(int quiet)
714 struct pstore_info *psi = psinfo;
715 char *buf = NULL;
716 ssize_t size;
717 u64 id;
718 int count;
719 enum pstore_type_id type;
720 struct timespec time;
721 int failed = 0, rc;
722 bool compressed;
723 int unzipped_len = -1;
724 ssize_t ecc_notice_size = 0;
726 if (!psi)
727 return;
729 mutex_lock(&psi->read_mutex);
730 if (psi->open && psi->open(psi))
731 goto out;
733 while ((size = psi->read(&id, &type, &count, &time, &buf, &compressed,
734 &ecc_notice_size, psi)) > 0) {
735 if (compressed && (type == PSTORE_TYPE_DMESG)) {
736 if (big_oops_buf)
737 unzipped_len = pstore_decompress(buf,
738 big_oops_buf, size,
739 big_oops_buf_sz);
741 if (unzipped_len > 0) {
742 if (ecc_notice_size)
743 memcpy(big_oops_buf + unzipped_len,
744 buf + size, ecc_notice_size);
745 kfree(buf);
746 buf = big_oops_buf;
747 size = unzipped_len;
748 compressed = false;
749 } else {
750 pr_err("decompression failed;returned %d\n",
751 unzipped_len);
752 compressed = true;
755 rc = pstore_mkfile(type, psi->name, id, count, buf,
756 compressed, size + ecc_notice_size,
757 time, psi);
758 if (unzipped_len < 0) {
759 /* Free buffer other than big oops */
760 kfree(buf);
761 buf = NULL;
762 } else
763 unzipped_len = -1;
764 if (rc && (rc != -EEXIST || !quiet))
765 failed++;
767 if (psi->close)
768 psi->close(psi);
769 out:
770 mutex_unlock(&psi->read_mutex);
772 if (failed)
773 pr_warn("failed to load %d record(s) from '%s'\n",
774 failed, psi->name);
777 static void pstore_dowork(struct work_struct *work)
779 pstore_get_records(1);
782 static void pstore_timefunc(unsigned long dummy)
784 if (pstore_new_entry) {
785 pstore_new_entry = 0;
786 schedule_work(&pstore_work);
789 mod_timer(&pstore_timer, jiffies + msecs_to_jiffies(pstore_update_ms));
792 module_param(backend, charp, 0444);
793 MODULE_PARM_DESC(backend, "Pstore backend to use");