platform.c 20.5 KB
Newer Older
1 2 3
/*
 * Persistent Storage - platform driver interface parts.
 *
4
 * Copyright (C) 2007-2008 Google, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

F
Fabian Frederick 已提交
21 22
#define pr_fmt(fmt) "pstore: " fmt

23 24 25 26 27
#include <linux/atomic.h>
#include <linux/types.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/kmsg_dump.h>
28
#include <linux/console.h>
29 30
#include <linux/module.h>
#include <linux/pstore.h>
31
#ifdef CONFIG_PSTORE_ZLIB_COMPRESS
32
#include <linux/zlib.h>
33 34 35 36 37 38 39
#endif
#ifdef CONFIG_PSTORE_LZO_COMPRESS
#include <linux/lzo.h>
#endif
#ifdef CONFIG_PSTORE_LZ4_COMPRESS
#include <linux/lz4.h>
#endif
40
#include <linux/string.h>
41
#include <linux/timer.h>
42 43
#include <linux/slab.h>
#include <linux/uaccess.h>
44
#include <linux/hardirq.h>
45
#include <linux/jiffies.h>
46
#include <linux/workqueue.h>
47 48 49

#include "internal.h"

50 51 52 53 54
/*
 * We defer making "oops" entries appear in pstore - see
 * whether the system is actually still running well enough
 * to let someone see the entry
 */
55
static int pstore_update_ms = -1;
56 57
module_param_named(update_ms, pstore_update_ms, int, 0600);
MODULE_PARM_DESC(update_ms, "milliseconds before pstore updates its content "
58 59 60
		 "(default is -1, which means runtime updates are disabled; "
		 "enabling this option is not safe, it may lead to further "
		 "corruption on Oopses)");
61 62 63 64 65 66 67 68 69

static int pstore_new_entry;

static void pstore_timefunc(unsigned long);
static DEFINE_TIMER(pstore_timer, pstore_timefunc, 0, 0);

static void pstore_dowork(struct work_struct *);
static DECLARE_WORK(pstore_work, pstore_dowork);

70 71 72 73 74
/*
 * pstore_lock just protects "psinfo" during
 * calls to pstore_register()
 */
static DEFINE_SPINLOCK(pstore_lock);
75
struct pstore_info *psinfo;
76

77 78
static char *backend;

79
/* Compression parameters */
80
#ifdef CONFIG_PSTORE_ZLIB_COMPRESS
81 82 83 84
#define COMPR_LEVEL 6
#define WINDOW_BITS 12
#define MEM_LEVEL 4
static struct z_stream_s stream;
85 86 87 88 89 90 91 92 93 94 95 96
#else
static unsigned char *workspace;
#endif

struct pstore_zbackend {
	int (*compress)(const void *in, void *out, size_t inlen, size_t outlen);
	int (*decompress)(void *in, void *out, size_t inlen, size_t outlen);
	void (*allocate)(void);
	void (*free)(void);

	const char *name;
};
97 98 99 100

static char *big_oops_buf;
static size_t big_oops_buf_sz;

101
/* How much of the console log to snapshot */
D
David Howells 已提交
102
unsigned long kmsg_bytes = PSTORE_DEFAULT_KMSG_BYTES;
103

104
void pstore_set_kmsg_bytes(int bytes)
105
{
106
	kmsg_bytes = bytes;
107 108 109 110 111
}

/* Tag each group of saved records with a sequence number */
static int	oopscount;

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
static const char *get_reason_str(enum kmsg_dump_reason reason)
{
	switch (reason) {
	case KMSG_DUMP_PANIC:
		return "Panic";
	case KMSG_DUMP_OOPS:
		return "Oops";
	case KMSG_DUMP_EMERG:
		return "Emergency";
	case KMSG_DUMP_RESTART:
		return "Restart";
	case KMSG_DUMP_HALT:
		return "Halt";
	case KMSG_DUMP_POWEROFF:
		return "Poweroff";
	default:
		return "Unknown";
	}
}
T
Tony Luck 已提交
131

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
bool pstore_cannot_block_path(enum kmsg_dump_reason reason)
{
	/*
	 * In case of NMI path, pstore shouldn't be blocked
	 * regardless of reason.
	 */
	if (in_nmi())
		return true;

	switch (reason) {
	/* In panic case, other cpus are stopped by smp_send_stop(). */
	case KMSG_DUMP_PANIC:
	/* Emergency restart shouldn't be blocked by spin lock. */
	case KMSG_DUMP_EMERG:
		return true;
	default:
		return false;
	}
}
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)
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
{
	int err, ret;

	ret = -EIO;
	err = zlib_deflateInit2(&stream, COMPR_LEVEL, Z_DEFLATED, WINDOW_BITS,
						MEM_LEVEL, Z_DEFAULT_STRATEGY);
	if (err != Z_OK)
		goto error;

	stream.next_in = in;
	stream.avail_in = inlen;
	stream.total_in = 0;
	stream.next_out = out;
	stream.avail_out = outlen;
	stream.total_out = 0;

	err = zlib_deflate(&stream, Z_FINISH);
	if (err != Z_STREAM_END)
		goto error;

	err = zlib_deflateEnd(&stream);
	if (err != Z_OK)
		goto error;

	if (stream.total_out >= stream.total_in)
		goto error;

	ret = stream.total_out;
error:
	return ret;
}

188
/* Derived from logfs_uncompress */
189
static int decompress_zlib(void *in, void *out, size_t inlen, size_t outlen)
190 191 192 193
{
	int err, ret;

	ret = -EIO;
194
	err = zlib_inflateInit2(&stream, WINDOW_BITS);
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
	if (err != Z_OK)
		goto error;

	stream.next_in = in;
	stream.avail_in = inlen;
	stream.total_in = 0;
	stream.next_out = out;
	stream.avail_out = outlen;
	stream.total_out = 0;

	err = zlib_inflate(&stream, Z_FINISH);
	if (err != Z_STREAM_END)
		goto error;

	err = zlib_inflateEnd(&stream);
	if (err != Z_OK)
		goto error;

	ret = stream.total_out;
error:
	return ret;
}

218
static void allocate_zlib(void)
219 220
{
	size_t size;
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
	size_t cmpr;

	switch (psinfo->bufsize) {
	/* buffer range for efivars */
	case 1000 ... 2000:
		cmpr = 56;
		break;
	case 2001 ... 3000:
		cmpr = 54;
		break;
	case 3001 ... 3999:
		cmpr = 52;
		break;
	/* buffer range for nvram, erst */
	case 4000 ... 10000:
		cmpr = 45;
		break;
	default:
		cmpr = 60;
		break;
	}
242

243
	big_oops_buf_sz = (psinfo->bufsize * 100) / cmpr;
244 245 246 247 248 249
	big_oops_buf = kmalloc(big_oops_buf_sz, GFP_KERNEL);
	if (big_oops_buf) {
		size = max(zlib_deflate_workspacesize(WINDOW_BITS, MEM_LEVEL),
			zlib_inflate_workspacesize());
		stream.workspace = kmalloc(size, GFP_KERNEL);
		if (!stream.workspace) {
F
Fabian Frederick 已提交
250
			pr_err("No memory for compression workspace; skipping compression\n");
251 252 253 254
			kfree(big_oops_buf);
			big_oops_buf = NULL;
		}
	} else {
F
Fabian Frederick 已提交
255
		pr_err("No memory for uncompressed data; skipping compression\n");
256 257 258 259 260
		stream.workspace = NULL;
	}

}

261
static void free_zlib(void)
G
Geliang Tang 已提交
262 263 264 265 266
{
	kfree(stream.workspace);
	stream.workspace = NULL;
	kfree(big_oops_buf);
	big_oops_buf = NULL;
267 268 269
	big_oops_buf_sz = 0;
}

270
static const struct pstore_zbackend backend_zlib = {
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
	.compress	= compress_zlib,
	.decompress	= decompress_zlib,
	.allocate	= allocate_zlib,
	.free		= free_zlib,
	.name		= "zlib",
};
#endif

#ifdef CONFIG_PSTORE_LZO_COMPRESS
static int compress_lzo(const void *in, void *out, size_t inlen, size_t outlen)
{
	int ret;

	ret = lzo1x_1_compress(in, inlen, out, &outlen, workspace);
	if (ret != LZO_E_OK) {
		pr_err("lzo_compress error, ret = %d!\n", ret);
		return -EIO;
	}

	return outlen;
}

static int decompress_lzo(void *in, void *out, size_t inlen, size_t outlen)
{
	int ret;

	ret = lzo1x_decompress_safe(in, inlen, out, &outlen);
	if (ret != LZO_E_OK) {
		pr_err("lzo_decompress error, ret = %d!\n", ret);
		return -EIO;
	}

	return outlen;
}

static void allocate_lzo(void)
{
	big_oops_buf_sz = lzo1x_worst_compress(psinfo->bufsize);
	big_oops_buf = kmalloc(big_oops_buf_sz, GFP_KERNEL);
	if (big_oops_buf) {
		workspace = kmalloc(LZO1X_MEM_COMPRESS, GFP_KERNEL);
		if (!workspace) {
			pr_err("No memory for compression workspace; skipping compression\n");
			kfree(big_oops_buf);
			big_oops_buf = NULL;
		}
	} else {
		pr_err("No memory for uncompressed data; skipping compression\n");
		workspace = NULL;
	}
}

static void free_lzo(void)
{
	kfree(workspace);
	kfree(big_oops_buf);
	big_oops_buf = NULL;
	big_oops_buf_sz = 0;
}

331
static const struct pstore_zbackend backend_lzo = {
332 333 334 335 336 337 338 339 340 341 342 343 344
	.compress	= compress_lzo,
	.decompress	= decompress_lzo,
	.allocate	= allocate_lzo,
	.free		= free_lzo,
	.name		= "lzo",
};
#endif

#ifdef CONFIG_PSTORE_LZ4_COMPRESS
static int compress_lz4(const void *in, void *out, size_t inlen, size_t outlen)
{
	int ret;

345 346 347
	ret = LZ4_compress_default(in, out, inlen, outlen, workspace);
	if (!ret) {
		pr_err("LZ4_compress_default error; compression failed!\n");
348 349 350
		return -EIO;
	}

351
	return ret;
352 353 354 355 356 357
}

static int decompress_lz4(void *in, void *out, size_t inlen, size_t outlen)
{
	int ret;

358 359 360 361 362 363 364
	ret = LZ4_decompress_safe(in, out, inlen, outlen);
	if (ret < 0) {
		/*
		 * LZ4_decompress_safe will return an error code
		 * (< 0) if decompression failed
		 */
		pr_err("LZ4_decompress_safe error, ret = %d!\n", ret);
365 366 367
		return -EIO;
	}

368
	return ret;
369 370 371 372
}

static void allocate_lz4(void)
{
373
	big_oops_buf_sz = LZ4_compressBound(psinfo->bufsize);
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
	big_oops_buf = kmalloc(big_oops_buf_sz, GFP_KERNEL);
	if (big_oops_buf) {
		workspace = kmalloc(LZ4_MEM_COMPRESS, GFP_KERNEL);
		if (!workspace) {
			pr_err("No memory for compression workspace; skipping compression\n");
			kfree(big_oops_buf);
			big_oops_buf = NULL;
		}
	} else {
		pr_err("No memory for uncompressed data; skipping compression\n");
		workspace = NULL;
	}
}

static void free_lz4(void)
{
	kfree(workspace);
	kfree(big_oops_buf);
	big_oops_buf = NULL;
	big_oops_buf_sz = 0;
}

396
static const struct pstore_zbackend backend_lz4 = {
397 398 399 400 401 402 403 404
	.compress	= compress_lz4,
	.decompress	= decompress_lz4,
	.allocate	= allocate_lz4,
	.free		= free_lz4,
	.name		= "lz4",
};
#endif

405
static const struct pstore_zbackend *zbackend =
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
#if defined(CONFIG_PSTORE_ZLIB_COMPRESS)
	&backend_zlib;
#elif defined(CONFIG_PSTORE_LZO_COMPRESS)
	&backend_lzo;
#elif defined(CONFIG_PSTORE_LZ4_COMPRESS)
	&backend_lz4;
#else
	NULL;
#endif

static int pstore_compress(const void *in, void *out,
			   size_t inlen, size_t outlen)
{
	if (zbackend)
		return zbackend->compress(in, out, inlen, outlen);
	else
		return -EIO;
}

static int pstore_decompress(void *in, void *out, size_t inlen, size_t outlen)
{
	if (zbackend)
		return zbackend->decompress(in, out, inlen, outlen);
	else
		return -EIO;
}

static void allocate_buf_for_compression(void)
{
	if (zbackend) {
		pr_info("using %s compression\n", zbackend->name);
		zbackend->allocate();
	} else {
		pr_err("allocate compression buffer error!\n");
	}
}

static void free_buf_for_compression(void)
{
	if (zbackend)
		zbackend->free();
	else
		pr_err("free compression buffer error!\n");
G
Geliang Tang 已提交
449 450
}

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
/*
 * Called when compression fails, since the printk buffer
 * would be fetched for compression calling it again when
 * compression fails would have moved the iterator of
 * printk buffer which results in fetching old contents.
 * Copy the recent messages from big_oops_buf to psinfo->buf
 */
static size_t copy_kmsg_to_buffer(int hsize, size_t len)
{
	size_t total_len;
	size_t diff;

	total_len = hsize + len;

	if (total_len > psinfo->bufsize) {
		diff = total_len - psinfo->bufsize + hsize;
		memcpy(psinfo->buf, big_oops_buf, hsize);
		memcpy(psinfo->buf + hsize, big_oops_buf + diff,
					psinfo->bufsize - hsize);
		total_len = psinfo->bufsize;
	} else
		memcpy(psinfo->buf, big_oops_buf, total_len);

	return total_len;
}

477 478 479 480 481 482
void pstore_record_init(struct pstore_record *record,
			struct pstore_info *psinfo)
{
	memset(record, 0, sizeof(*record));

	record->psi = psinfo;
483 484 485 486 487 488

	/* Report zeroed timestamp if called before timekeeping has resumed. */
	if (__getnstimeofday(&record->time)) {
		record->time.tv_sec = 0;
		record->time.tv_nsec = 0;
	}
489 490
}

491 492 493 494 495 496
/*
 * callback from kmsg_dump. (s2,l2) has the most recently
 * written bytes, older bytes are in (s1,l1). Save as much
 * as we can from the end of the buffer.
 */
static void pstore_dump(struct kmsg_dumper *dumper,
497
			enum kmsg_dump_reason reason)
498
{
499
	unsigned long	total = 0;
500
	const char	*why;
M
Matthew Garrett 已提交
501
	unsigned int	part = 1;
502
	unsigned long	flags = 0;
503
	int		is_locked;
504
	int		ret;
505

506
	why = get_reason_str(reason);
T
Tony Luck 已提交
507

508 509 510 511 512
	if (pstore_cannot_block_path(reason)) {
		is_locked = spin_trylock_irqsave(&psinfo->buf_lock, flags);
		if (!is_locked) {
			pr_err("pstore dump routine blocked in %s path, may corrupt error record\n"
				       , in_nmi() ? "NMI" : why);
513
			return;
514
		}
515
	} else {
516
		spin_lock_irqsave(&psinfo->buf_lock, flags);
517 518
		is_locked = 1;
	}
519 520
	oopscount++;
	while (total < kmsg_bytes) {
521
		char *dst;
522 523
		size_t dst_size;
		int header_size;
524
		int zipped_len = -1;
525
		size_t dump_size;
526 527 528 529 530 531 532 533
		struct pstore_record record;

		pstore_record_init(&record, psinfo);
		record.type = PSTORE_TYPE_DMESG;
		record.count = oopscount;
		record.reason = reason;
		record.part = part;
		record.buf = psinfo->buf;
534

535
		if (big_oops_buf && is_locked) {
536
			dst = big_oops_buf;
537
			dst_size = big_oops_buf_sz;
N
Namhyung Kim 已提交
538 539
		} else {
			dst = psinfo->buf;
540
			dst_size = psinfo->bufsize;
N
Namhyung Kim 已提交
541 542
		}

543 544 545 546
		/* Write dump header. */
		header_size = snprintf(dst, dst_size, "%s#%d Part%u\n", why,
				 oopscount, part);
		dst_size -= header_size;
547

548 549 550
		/* Write dump contents. */
		if (!kmsg_dump_get_buffer(dumper, true, dst + header_size,
					  dst_size, &dump_size))
N
Namhyung Kim 已提交
551
			break;
552

N
Namhyung Kim 已提交
553
		if (big_oops_buf && is_locked) {
554
			zipped_len = pstore_compress(dst, psinfo->buf,
555 556
						header_size + dump_size,
						psinfo->bufsize);
557 558

			if (zipped_len > 0) {
559 560
				record.compressed = true;
				record.size = zipped_len;
561
			} else {
562 563
				record.size = copy_kmsg_to_buffer(header_size,
								  dump_size);
564 565
			}
		} else {
566
			record.size = header_size + dump_size;
567
		}
568

569
		ret = psinfo->write(&record);
570
		if (ret == 0 && reason == KMSG_DUMP_OOPS && pstore_is_mounted())
571
			pstore_new_entry = 1;
572

573
		total += record.size;
574
		part++;
575
	}
576
	if (is_locked)
577
		spin_unlock_irqrestore(&psinfo->buf_lock, flags);
578 579 580 581 582 583
}

static struct kmsg_dumper pstore_dumper = {
	.dump = pstore_dump,
};

584 585 586
/*
 * Register with kmsg_dump to save last part of console log on panic.
 */
587 588 589 590 591
static void pstore_register_kmsg(void)
{
	kmsg_dump_register(&pstore_dumper);
}

G
Geliang Tang 已提交
592 593 594 595 596
static void pstore_unregister_kmsg(void)
{
	kmsg_dump_unregister(&pstore_dumper);
}

597 598 599 600 601 602
#ifdef CONFIG_PSTORE_CONSOLE
static void pstore_console_write(struct console *con, const char *s, unsigned c)
{
	const char *e = s + c;

	while (s < e) {
603
		struct pstore_record record;
604 605
		unsigned long flags;

606 607 608
		pstore_record_init(&record, psinfo);
		record.type = PSTORE_TYPE_CONSOLE;

609 610
		if (c > psinfo->bufsize)
			c = psinfo->bufsize;
611 612 613 614 615 616 617

		if (oops_in_progress) {
			if (!spin_trylock_irqsave(&psinfo->buf_lock, flags))
				break;
		} else {
			spin_lock_irqsave(&psinfo->buf_lock, flags);
		}
618 619
		record.buf = (char *)s;
		record.size = c;
K
Kees Cook 已提交
620
		psinfo->write(&record);
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
		spin_unlock_irqrestore(&psinfo->buf_lock, flags);
		s += c;
		c = e - s;
	}
}

static struct console pstore_console = {
	.name	= "pstore",
	.write	= pstore_console_write,
	.flags	= CON_PRINTBUFFER | CON_ENABLED | CON_ANYTIME,
	.index	= -1,
};

static void pstore_register_console(void)
{
	register_console(&pstore_console);
}
G
Geliang Tang 已提交
638 639 640 641 642

static void pstore_unregister_console(void)
{
	unregister_console(&pstore_console);
}
643 644
#else
static void pstore_register_console(void) {}
G
Geliang Tang 已提交
645
static void pstore_unregister_console(void) {}
646 647
#endif

K
Kees Cook 已提交
648 649
static int pstore_write_user_compat(struct pstore_record *record,
				    const char __user *buf)
M
Mark Salyzyn 已提交
650
{
K
Kees Cook 已提交
651 652 653 654 655
	int ret = 0;

	if (record->buf)
		return -EINVAL;

G
Geliang Tang 已提交
656 657 658
	record->buf = memdup_user(buf, record->size);
	if (unlikely(IS_ERR(record->buf))) {
		ret = PTR_ERR(record->buf);
K
Kees Cook 已提交
659
		goto out;
M
Mark Salyzyn 已提交
660
	}
K
Kees Cook 已提交
661 662 663 664

	ret = record->psi->write(record);

	kfree(record->buf);
G
Geliang Tang 已提交
665
out:
K
Kees Cook 已提交
666 667 668
	record->buf = NULL;

	return unlikely(ret < 0) ? ret : record->size;
M
Mark Salyzyn 已提交
669 670
}

671 672 673 674 675 676 677 678 679 680 681
/*
 * platform specific persistent storage driver registers with
 * us here. If pstore is already mounted, call the platform
 * read function right away to populate the file system. If not
 * then the pstore mount code will call us later to fill out
 * the file system.
 */
int pstore_register(struct pstore_info *psi)
{
	struct module *owner = psi->owner;

682 683
	if (backend && strcmp(backend, psi->name)) {
		pr_warn("ignoring unexpected backend '%s'\n", psi->name);
684
		return -EPERM;
685
	}
686

K
Kees Cook 已提交
687 688 689 690 691 692 693 694 695 696 697 698 699 700
	/* Sanity check flags. */
	if (!psi->flags) {
		pr_warn("backend '%s' must support at least one frontend\n",
			psi->name);
		return -EINVAL;
	}

	/* Check for required functions. */
	if (!psi->read || !psi->write) {
		pr_warn("backend '%s' must implement read() and write()\n",
			psi->name);
		return -EINVAL;
	}

701 702
	spin_lock(&pstore_lock);
	if (psinfo) {
703 704
		pr_warn("backend '%s' already loaded: ignoring '%s'\n",
			psinfo->name, psi->name);
705 706 707
		spin_unlock(&pstore_lock);
		return -EBUSY;
	}
708

K
Kees Cook 已提交
709 710
	if (!psi->write_user)
		psi->write_user = pstore_write_user_compat;
711
	psinfo = psi;
712
	mutex_init(&psinfo->read_mutex);
713 714 715 716 717 718 719
	spin_unlock(&pstore_lock);

	if (owner && !try_module_get(owner)) {
		psinfo = NULL;
		return -EINVAL;
	}

720 721
	allocate_buf_for_compression();

722
	if (pstore_is_mounted())
723
		pstore_get_records(0);
724

725 726 727
	if (psi->flags & PSTORE_FLAGS_DMESG)
		pstore_register_kmsg();
	if (psi->flags & PSTORE_FLAGS_CONSOLE)
728
		pstore_register_console();
729
	if (psi->flags & PSTORE_FLAGS_FTRACE)
730
		pstore_register_ftrace();
731
	if (psi->flags & PSTORE_FLAGS_PMSG)
732
		pstore_register_pmsg();
733

734
	/* Start watching for new records, if desired. */
735 736 737 738 739
	if (pstore_update_ms >= 0) {
		pstore_timer.expires = jiffies +
			msecs_to_jiffies(pstore_update_ms);
		add_timer(&pstore_timer);
	}
740

741 742 743 744 745 746
	/*
	 * Update the module parameter backend, so it is visible
	 * through /sys/module/pstore/parameters/backend
	 */
	backend = psi->name;

F
Fabian Frederick 已提交
747
	pr_info("Registered %s as persistent store backend\n", psi->name);
748

749 750
	module_put(owner);

751 752 753 754
	return 0;
}
EXPORT_SYMBOL_GPL(pstore_register);

G
Geliang Tang 已提交
755 756
void pstore_unregister(struct pstore_info *psi)
{
757 758 759 760 761
	/* Stop timer and make sure all work has finished. */
	pstore_update_ms = -1;
	del_timer_sync(&pstore_timer);
	flush_work(&pstore_work);

762
	if (psi->flags & PSTORE_FLAGS_PMSG)
763
		pstore_unregister_pmsg();
764
	if (psi->flags & PSTORE_FLAGS_FTRACE)
765
		pstore_unregister_ftrace();
766
	if (psi->flags & PSTORE_FLAGS_CONSOLE)
767
		pstore_unregister_console();
768 769
	if (psi->flags & PSTORE_FLAGS_DMESG)
		pstore_unregister_kmsg();
G
Geliang Tang 已提交
770 771 772 773 774 775 776 777

	free_buf_for_compression();

	psinfo = NULL;
	backend = NULL;
}
EXPORT_SYMBOL_GPL(pstore_unregister);

778 779 780
static void decompress_record(struct pstore_record *record)
{
	int unzipped_len;
781
	char *decompressed;
782

783 784 785
	if (!record->compressed)
		return;

786
	/* Only PSTORE_TYPE_DMESG support compression. */
787
	if (record->type != PSTORE_TYPE_DMESG) {
788 789 790 791 792 793 794 795 796 797 798 799
		pr_warn("ignored compressed record type %d\n", record->type);
		return;
	}

	/* No compression method has created the common buffer. */
	if (!big_oops_buf) {
		pr_warn("no decompression buffer allocated\n");
		return;
	}

	unzipped_len = pstore_decompress(record->buf, big_oops_buf,
					 record->size, big_oops_buf_sz);
800
	if (unzipped_len <= 0) {
801
		pr_err("decompression failed: %d\n", unzipped_len);
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
		return;
	}

	/* Build new buffer for decompressed contents. */
	decompressed = kmalloc(unzipped_len + record->ecc_notice_size,
			       GFP_KERNEL);
	if (!decompressed) {
		pr_err("decompression ran out of memory\n");
		return;
	}
	memcpy(decompressed, big_oops_buf, unzipped_len);

	/* Append ECC notice to decompressed buffer. */
	memcpy(decompressed + unzipped_len, record->buf + record->size,
	       record->ecc_notice_size);

	/* Swap out compresed contents with decompressed contents. */
	kfree(record->buf);
	record->buf = decompressed;
	record->size = unzipped_len;
	record->compressed = false;
823 824
}

825
/*
826
 * Read all the records from one persistent store backend. Create
827 828 829
 * files in our filesystem.  Don't warn about -EEXIST errors
 * when we are re-scanning the backing store looking to add new
 * error records.
830
 */
831 832
void pstore_get_backend_records(struct pstore_info *psi,
				struct dentry *root, int quiet)
833
{
834
	int failed = 0;
835
	unsigned int stop_loop = 65536;
836

837
	if (!psi || !root)
838 839
		return;

840
	mutex_lock(&psi->read_mutex);
841
	if (psi->open && psi->open(psi))
842 843
		goto out;

844 845 846 847 848
	/*
	 * Backend callback read() allocates record.buf. decompress_record()
	 * may reallocate record.buf. On success, pstore_mkfile() will keep
	 * the record.buf, so free it only on failure.
	 */
849
	for (; stop_loop; stop_loop--) {
850 851 852 853 854 855 856 857
		struct pstore_record *record;
		int rc;

		record = kzalloc(sizeof(*record), GFP_KERNEL);
		if (!record) {
			pr_err("out of memory creating record\n");
			break;
		}
858
		pstore_record_init(record, psi);
859 860 861 862

		record->size = psi->read(record);

		/* No more records left in backend? */
863 864
		if (record->size <= 0) {
			kfree(record);
865
			break;
866
		}
867 868

		decompress_record(record);
869
		rc = pstore_mkfile(root, record);
870
		if (rc) {
871
			/* pstore_mkfile() did not take record, so free it. */
872
			kfree(record->buf);
873
			kfree(record);
874 875 876
			if (rc != -EEXIST || !quiet)
				failed++;
		}
877
	}
878 879
	if (psi->close)
		psi->close(psi);
880
out:
881
	mutex_unlock(&psi->read_mutex);
882 883

	if (failed)
884
		pr_warn("failed to create %d record(s) from '%s'\n",
F
Fabian Frederick 已提交
885
			failed, psi->name);
886 887 888
	if (!stop_loop)
		pr_err("looping? Too many records seen from '%s'\n",
			psi->name);
889 890
}

891 892 893 894 895 896 897 898 899 900 901 902
static void pstore_dowork(struct work_struct *work)
{
	pstore_get_records(1);
}

static void pstore_timefunc(unsigned long dummy)
{
	if (pstore_new_entry) {
		pstore_new_entry = 0;
		schedule_work(&pstore_work);
	}

903 904 905
	if (pstore_update_ms >= 0)
		mod_timer(&pstore_timer,
			  jiffies + msecs_to_jiffies(pstore_update_ms));
906 907
}

908 909
module_param(backend, charp, 0444);
MODULE_PARM_DESC(backend, "Pstore backend to use");