ram.c 14.6 KB
Newer Older
1 2 3 4
/*
 * RAM Oops/Panic logger
 *
 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
K
Kees Cook 已提交
5
 * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

23 24
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

25
#include <linux/kernel.h>
26
#include <linux/err.h>
27
#include <linux/module.h>
28
#include <linux/version.h>
K
Kees Cook 已提交
29
#include <linux/pstore.h>
30 31 32
#include <linux/time.h>
#include <linux/io.h>
#include <linux/ioport.h>
33
#include <linux/platform_device.h>
34
#include <linux/slab.h>
35
#include <linux/compiler.h>
36
#include <linux/pstore_ram.h>
37 38

#define RAMOOPS_KERNMSG_HDR "===="
39
#define MIN_MEM_SIZE 4096UL
40

41 42 43 44
static ulong record_size = MIN_MEM_SIZE;
module_param(record_size, ulong, 0400);
MODULE_PARM_DESC(record_size,
		"size of each dump done on oops/panic");
45

46 47 48 49
static ulong ramoops_console_size = MIN_MEM_SIZE;
module_param_named(console_size, ramoops_console_size, ulong, 0400);
MODULE_PARM_DESC(console_size, "size of kernel console log");

50 51 52 53
static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
MODULE_PARM_DESC(ftrace_size, "size of ftrace log");

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
static ulong mem_address;
module_param(mem_address, ulong, 0400);
MODULE_PARM_DESC(mem_address,
		"start of reserved RAM used to store oops/panic logs");

static ulong mem_size;
module_param(mem_size, ulong, 0400);
MODULE_PARM_DESC(mem_size,
		"size of reserved RAM used to store oops/panic logs");

static int dump_oops = 1;
module_param(dump_oops, int, 0600);
MODULE_PARM_DESC(dump_oops,
		"set to 1 to dump oopses, 0 to only dump panics (default 1)");

A
Anton Vorontsov 已提交
69 70 71
static int ramoops_ecc;
module_param_named(ecc, ramoops_ecc, int, 0600);
MODULE_PARM_DESC(ramoops_ecc,
72 73 74
		"if non-zero, the option enables ECC support and specifies "
		"ECC buffer size in bytes (1 is a special value, means 16 "
		"bytes ECC)");
A
Anton Vorontsov 已提交
75

K
Kees Cook 已提交
76
struct ramoops_context {
77
	struct persistent_ram_zone **przs;
78
	struct persistent_ram_zone *cprz;
79
	struct persistent_ram_zone *fprz;
80 81
	phys_addr_t phys_addr;
	unsigned long size;
K
Kees Cook 已提交
82
	size_t record_size;
83
	size_t console_size;
84
	size_t ftrace_size;
85
	int dump_oops;
86
	struct persistent_ram_ecc_info ecc_info;
87 88 89
	unsigned int max_dump_cnt;
	unsigned int dump_write_cnt;
	unsigned int dump_read_cnt;
90
	unsigned int console_read_cnt;
91
	unsigned int ftrace_read_cnt;
K
Kees Cook 已提交
92 93
	struct pstore_info pstore;
};
94

95 96 97
static struct platform_device *dummy;
static struct ramoops_platform_data *dummy_data;

K
Kees Cook 已提交
98 99 100 101
static int ramoops_pstore_open(struct pstore_info *psi)
{
	struct ramoops_context *cxt = psi->data;

102
	cxt->dump_read_cnt = 0;
103
	cxt->console_read_cnt = 0;
K
Kees Cook 已提交
104 105 106
	return 0;
}

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
static struct persistent_ram_zone *
ramoops_get_next_prz(struct persistent_ram_zone *przs[], uint *c, uint max,
		     u64 *id,
		     enum pstore_type_id *typep, enum pstore_type_id type,
		     bool update)
{
	struct persistent_ram_zone *prz;
	int i = (*c)++;

	if (i >= max)
		return NULL;

	prz = przs[i];

	if (update) {
		/* Update old/shadowed buffer. */
		persistent_ram_save_old(prz);
		if (!persistent_ram_old_size(prz))
			return NULL;
	}

	*typep = type;
	*id = i;

	return prz;
}

K
Kees Cook 已提交
134
static ssize_t ramoops_pstore_read(u64 *id, enum pstore_type_id *type,
135 136
				   int *count, struct timespec *time,
				   char **buf, struct pstore_info *psi)
137
{
K
Kees Cook 已提交
138
	ssize_t size;
139
	ssize_t ecc_notice_size;
K
Kees Cook 已提交
140
	struct ramoops_context *cxt = psi->data;
141
	struct persistent_ram_zone *prz;
K
Kees Cook 已提交
142

143 144 145
	prz = ramoops_get_next_prz(cxt->przs, &cxt->dump_read_cnt,
				   cxt->max_dump_cnt, id, type,
				   PSTORE_TYPE_DMESG, 1);
146 147 148
	if (!prz)
		prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
					   1, id, type, PSTORE_TYPE_CONSOLE, 0);
149 150 151
	if (!prz)
		prz = ramoops_get_next_prz(&cxt->fprz, &cxt->ftrace_read_cnt,
					   1, id, type, PSTORE_TYPE_FTRACE, 0);
152 153
	if (!prz)
		return 0;
154

K
Kees Cook 已提交
155 156 157 158
	/* TODO(kees): Bogus time for the moment. */
	time->tv_sec = 0;
	time->tv_nsec = 0;

159
	size = persistent_ram_old_size(prz);
160 161 162 163 164

	/* ECC correction notice */
	ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);

	*buf = kmalloc(size + ecc_notice_size + 1, GFP_KERNEL);
K
Kees Cook 已提交
165 166 167
	if (*buf == NULL)
		return -ENOMEM;

168 169 170 171
	memcpy(*buf, persistent_ram_old(prz), size);
	persistent_ram_ecc_string(prz, *buf + size, ecc_notice_size + 1);

	return size + ecc_notice_size;
K
Kees Cook 已提交
172 173
}

174 175 176
static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz)
{
	char *hdr;
177
	struct timespec timestamp;
178 179
	size_t len;

180 181 182 183 184
	/* Report zeroed timestamp if called before timekeeping has resumed. */
	if (__getnstimeofday(&timestamp)) {
		timestamp.tv_sec = 0;
		timestamp.tv_nsec = 0;
	}
185
	hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lu.%lu\n",
186
		(long)timestamp.tv_sec, (long)(timestamp.tv_nsec / 1000));
187 188 189 190 191 192 193 194
	WARN_ON_ONCE(!hdr);
	len = hdr ? strlen(hdr) : 0;
	persistent_ram_write(prz, hdr, len);
	kfree(hdr);

	return len;
}

195 196 197
static int notrace ramoops_pstore_write_buf(enum pstore_type_id type,
					    enum kmsg_dump_reason reason,
					    u64 *id, unsigned int part,
198 199
					    const char *buf,
					    size_t hsize, size_t size,
200
					    struct pstore_info *psi)
K
Kees Cook 已提交
201 202
{
	struct ramoops_context *cxt = psi->data;
203
	struct persistent_ram_zone *prz;
204
	size_t hlen;
K
Kees Cook 已提交
205

206 207 208
	if (type == PSTORE_TYPE_CONSOLE) {
		if (!cxt->cprz)
			return -ENOMEM;
209
		persistent_ram_write(cxt->cprz, buf, size);
210
		return 0;
211 212 213 214 215
	} else if (type == PSTORE_TYPE_FTRACE) {
		if (!cxt->fprz)
			return -ENOMEM;
		persistent_ram_write(cxt->fprz, buf, size);
		return 0;
216 217
	}

K
Kees Cook 已提交
218 219
	if (type != PSTORE_TYPE_DMESG)
		return -EINVAL;
220

K
Kees Cook 已提交
221 222 223
	/* Out of the various dmesg dump types, ramoops is currently designed
	 * to only store crash logs, rather than storing general kernel logs.
	 */
224
	if (reason != KMSG_DUMP_OOPS &&
W
WANG Cong 已提交
225
	    reason != KMSG_DUMP_PANIC)
K
Kees Cook 已提交
226
		return -EINVAL;
227

K
Kees Cook 已提交
228
	/* Skip Oopes when configured to do so. */
229
	if (reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
K
Kees Cook 已提交
230 231 232 233 234 235 236 237 238
		return -EINVAL;

	/* Explicitly only take the first part of any new crash.
	 * If our buffer is larger than kmsg_bytes, this can never happen,
	 * and if our buffer is smaller than kmsg_bytes, we don't want the
	 * report split across multiple records.
	 */
	if (part != 1)
		return -ENOSPC;
239

240 241 242 243 244
	if (!cxt->przs)
		return -ENOSPC;

	prz = cxt->przs[cxt->dump_write_cnt];

245 246 247
	hlen = ramoops_write_kmsg_hdr(prz);
	if (size + hlen > prz->buffer_size)
		size = prz->buffer_size - hlen;
248
	persistent_ram_write(prz, buf, size);
249

250
	cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
K
Kees Cook 已提交
251 252 253 254

	return 0;
}

255
static int ramoops_pstore_erase(enum pstore_type_id type, u64 id, int count,
256
				struct timespec time, struct pstore_info *psi)
K
Kees Cook 已提交
257 258
{
	struct ramoops_context *cxt = psi->data;
259
	struct persistent_ram_zone *prz;
K
Kees Cook 已提交
260

261 262 263 264 265 266 267 268 269
	switch (type) {
	case PSTORE_TYPE_DMESG:
		if (id >= cxt->max_dump_cnt)
			return -EINVAL;
		prz = cxt->przs[id];
		break;
	case PSTORE_TYPE_CONSOLE:
		prz = cxt->cprz;
		break;
270 271 272
	case PSTORE_TYPE_FTRACE:
		prz = cxt->fprz;
		break;
273
	default:
K
Kees Cook 已提交
274
		return -EINVAL;
275
	}
K
Kees Cook 已提交
276

277 278
	persistent_ram_free_old(prz);
	persistent_ram_zap(prz);
K
Kees Cook 已提交
279 280

	return 0;
281 282
}

K
Kees Cook 已提交
283 284 285 286 287 288
static struct ramoops_context oops_cxt = {
	.pstore = {
		.owner	= THIS_MODULE,
		.name	= "ramoops",
		.open	= ramoops_pstore_open,
		.read	= ramoops_pstore_read,
289
		.write_buf	= ramoops_pstore_write_buf,
K
Kees Cook 已提交
290 291 292 293
		.erase	= ramoops_pstore_erase,
	},
};

294 295 296 297 298 299 300
static void ramoops_free_przs(struct ramoops_context *cxt)
{
	int i;

	if (!cxt->przs)
		return;

301
	for (i = 0; !IS_ERR_OR_NULL(cxt->przs[i]); i++)
302 303 304 305
		persistent_ram_free(cxt->przs[i]);
	kfree(cxt->przs);
}

306 307
static int ramoops_init_przs(struct device *dev, struct ramoops_context *cxt,
			     phys_addr_t *paddr, size_t dump_mem_sz)
308 309 310 311 312 313 314
{
	int err = -ENOMEM;
	int i;

	if (!cxt->record_size)
		return 0;

315 316 317 318 319
	if (*paddr + dump_mem_sz - cxt->phys_addr > cxt->size) {
		dev_err(dev, "no room for dumps\n");
		return -ENOMEM;
	}

320 321 322 323 324 325 326 327 328 329 330 331 332 333
	cxt->max_dump_cnt = dump_mem_sz / cxt->record_size;
	if (!cxt->max_dump_cnt)
		return -ENOMEM;

	cxt->przs = kzalloc(sizeof(*cxt->przs) * cxt->max_dump_cnt,
			     GFP_KERNEL);
	if (!cxt->przs) {
		dev_err(dev, "failed to initialize a prz array for dumps\n");
		return -ENOMEM;
	}

	for (i = 0; i < cxt->max_dump_cnt; i++) {
		size_t sz = cxt->record_size;

334 335
		cxt->przs[i] = persistent_ram_new(*paddr, sz, 0,
						  &cxt->ecc_info);
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
		if (IS_ERR(cxt->przs[i])) {
			err = PTR_ERR(cxt->przs[i]);
			dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
				sz, (unsigned long long)*paddr, err);
			goto fail_prz;
		}
		*paddr += sz;
	}

	return 0;
fail_prz:
	ramoops_free_przs(cxt);
	return err;
}

351 352 353
static int ramoops_init_prz(struct device *dev, struct ramoops_context *cxt,
			    struct persistent_ram_zone **prz,
			    phys_addr_t *paddr, size_t sz, u32 sig)
354 355 356 357
{
	if (!sz)
		return 0;

358 359 360 361
	if (*paddr + sz - cxt->phys_addr > cxt->size) {
		dev_err(dev, "no room for mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
			sz, (unsigned long long)*paddr,
			cxt->size, (unsigned long long)cxt->phys_addr);
362
		return -ENOMEM;
363
	}
364

365
	*prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info);
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
	if (IS_ERR(*prz)) {
		int err = PTR_ERR(*prz);

		dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
			sz, (unsigned long long)*paddr, err);
		return err;
	}

	persistent_ram_zap(*prz);

	*paddr += sz;

	return 0;
}

381
static int ramoops_probe(struct platform_device *pdev)
382
{
383
	struct device *dev = &pdev->dev;
384
	struct ramoops_platform_data *pdata = pdev->dev.platform_data;
385
	struct ramoops_context *cxt = &oops_cxt;
386 387
	size_t dump_mem_sz;
	phys_addr_t paddr;
388 389
	int err = -EINVAL;

K
Kees Cook 已提交
390 391 392
	/* Only a single ramoops area allowed at a time, so fail extra
	 * probes.
	 */
393
	if (cxt->max_dump_cnt)
K
Kees Cook 已提交
394 395
		goto fail_out;

396 397
	if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
			!pdata->ftrace_size)) {
398
		pr_err("The memory size and the record/console size must be "
399
			"non-zero\n");
K
Kees Cook 已提交
400
		goto fail_out;
401 402
	}

403 404 405 406 407 408 409 410
	if (!is_power_of_2(pdata->mem_size))
		pdata->mem_size = rounddown_pow_of_two(pdata->mem_size);
	if (!is_power_of_2(pdata->record_size))
		pdata->record_size = rounddown_pow_of_two(pdata->record_size);
	if (!is_power_of_2(pdata->console_size))
		pdata->console_size = rounddown_pow_of_two(pdata->console_size);
	if (!is_power_of_2(pdata->ftrace_size))
		pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
411

412
	cxt->dump_read_cnt = 0;
413 414
	cxt->size = pdata->mem_size;
	cxt->phys_addr = pdata->mem_address;
415
	cxt->record_size = pdata->record_size;
416
	cxt->console_size = pdata->console_size;
417
	cxt->ftrace_size = pdata->ftrace_size;
418
	cxt->dump_oops = pdata->dump_oops;
419
	cxt->ecc_info = pdata->ecc_info;
420

421
	paddr = cxt->phys_addr;
422

423
	dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size;
424
	err = ramoops_init_przs(dev, cxt, &paddr, dump_mem_sz);
425 426 427
	if (err)
		goto fail_out;

428 429
	err = ramoops_init_prz(dev, cxt, &cxt->cprz, &paddr,
			       cxt->console_size, 0);
430 431 432
	if (err)
		goto fail_init_cprz;

433 434
	err = ramoops_init_prz(dev, cxt, &cxt->fprz, &paddr, cxt->ftrace_size,
			       LINUX_VERSION_CODE);
435 436 437 438
	if (err)
		goto fail_init_fprz;

	if (!cxt->przs && !cxt->cprz && !cxt->fprz) {
439
		pr_err("memory size too small, minimum is %zu\n",
440 441
			cxt->console_size + cxt->record_size +
			cxt->ftrace_size);
442
		err = -EINVAL;
443
		goto fail_cnt;
444 445
	}

K
Kees Cook 已提交
446
	cxt->pstore.data = cxt;
447
	/*
448 449 450 451
	 * Console can handle any buffer size, so prefer LOG_LINE_MAX. If we
	 * have to handle dumps, we must have at least record_size buffer. And
	 * for ftrace, bufsize is irrelevant (if bufsize is 0, buf will be
	 * ZERO_SIZE_PTR).
452
	 */
453 454 455
	if (cxt->console_size)
		cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
	cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
K
Kees Cook 已提交
456 457 458 459
	cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
	spin_lock_init(&cxt->pstore.buf_lock);
	if (!cxt->pstore.buf) {
		pr_err("cannot allocate pstore buffer\n");
460
		err = -ENOMEM;
K
Kees Cook 已提交
461 462 463 464
		goto fail_clear;
	}

	err = pstore_register(&cxt->pstore);
465
	if (err) {
K
Kees Cook 已提交
466
		pr_err("registering with pstore failed\n");
467
		goto fail_buf;
468 469
	}

470 471 472 473 474 475 476 477 478
	/*
	 * Update the module parameter variables as well so they are visible
	 * through /sys/module/ramoops/parameters/
	 */
	mem_size = pdata->mem_size;
	mem_address = pdata->mem_address;
	record_size = pdata->record_size;
	dump_oops = pdata->dump_oops;

479
	pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
480
		cxt->size, (unsigned long long)cxt->phys_addr,
481
		cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
K
Kees Cook 已提交
482

483 484
	return 0;

K
Kees Cook 已提交
485 486 487 488
fail_buf:
	kfree(cxt->pstore.buf);
fail_clear:
	cxt->pstore.bufsize = 0;
489
	cxt->max_dump_cnt = 0;
490
fail_cnt:
491 492
	kfree(cxt->fprz);
fail_init_fprz:
493 494
	kfree(cxt->cprz);
fail_init_cprz:
495
	ramoops_free_przs(cxt);
K
Kees Cook 已提交
496
fail_out:
497 498 499
	return err;
}

500
static int __exit ramoops_remove(struct platform_device *pdev)
501
{
K
Kees Cook 已提交
502 503 504 505
#if 0
	/* TODO(kees): We cannot unload ramoops since pstore doesn't support
	 * unregistering yet.
	 */
506 507 508 509
	struct ramoops_context *cxt = &oops_cxt;

	iounmap(cxt->virt_addr);
	release_mem_region(cxt->phys_addr, cxt->size);
510
	cxt->max_dump_cnt = 0;
K
Kees Cook 已提交
511 512 513 514 515

	/* TODO(kees): When pstore supports unregistering, call it here. */
	kfree(cxt->pstore.buf);
	cxt->pstore.bufsize = 0;

516
	return 0;
K
Kees Cook 已提交
517 518
#endif
	return -EBUSY;
519 520
}

521
static struct platform_driver ramoops_driver = {
522
	.probe		= ramoops_probe,
523 524 525 526 527 528 529
	.remove		= __exit_p(ramoops_remove),
	.driver		= {
		.name	= "ramoops",
		.owner	= THIS_MODULE,
	},
};

530
static void ramoops_register_dummy(void)
531
{
532 533 534 535 536 537 538 539 540
	if (!mem_size)
		return;

	pr_info("using module parameters\n");

	dummy_data = kzalloc(sizeof(*dummy_data), GFP_KERNEL);
	if (!dummy_data) {
		pr_info("could not allocate pdata\n");
		return;
541 542
	}

543 544 545 546
	dummy_data->mem_size = mem_size;
	dummy_data->mem_address = mem_address;
	dummy_data->record_size = record_size;
	dummy_data->console_size = ramoops_console_size;
547
	dummy_data->ftrace_size = ramoops_ftrace_size;
548
	dummy_data->dump_oops = dump_oops;
549 550 551 552
	/*
	 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
	 * (using 1 byte for ECC isn't much of use anyway).
	 */
553
	dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
554 555 556 557 558 559 560 561 562 563 564 565 566

	dummy = platform_device_register_data(NULL, "ramoops", -1,
			dummy_data, sizeof(struct ramoops_platform_data));
	if (IS_ERR(dummy)) {
		pr_info("could not create platform device: %ld\n",
			PTR_ERR(dummy));
	}
}

static int __init ramoops_init(void)
{
	ramoops_register_dummy();
	return platform_driver_register(&ramoops_driver);
567
}
568
postcore_initcall(ramoops_init);
569 570 571 572

static void __exit ramoops_exit(void)
{
	platform_driver_unregister(&ramoops_driver);
573
	platform_device_unregister(dummy);
574
	kfree(dummy_data);
575
}
576 577 578 579 580
module_exit(ramoops_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");