fs/pstore/ram.c

   1 /*
   2  * RAM Oops/Panic logger
   3  *
   4  * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
   5  * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * version 2 as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  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., 51 Franklin St, Fifth Floor, Boston, MA
  19  * 02110-1301 USA
  20  *
  21  */
  22
  23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  24
  25 #include <linux/kernel.h>
  26 #include <linux/err.h>
  27 #include <linux/module.h>
  28 #include <linux/version.h>
  29 #include <linux/pstore.h>
  30 #include <linux/time.h>
  31 #include <linux/io.h>
  32 #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 static ulong record_size = MIN_MEM_SIZE;
  42 module_param(record_size, ulong, 0400);
  43 MODULE_PARM_DESC(record_size,
  44                 "size of each dump done on oops/panic");
  45
  46 static ulong ramoops_console_size = MIN_MEM_SIZE;
  47 module_param_named(console_size, ramoops_console_size, ulong, 0400);
  48 MODULE_PARM_DESC(console_size, "size of kernel console log");
  49
  50 static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
  51 module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
  52 MODULE_PARM_DESC(ftrace_size, "size of ftrace log");
  53
  54 static ulong mem_address;
  55 module_param(mem_address, ulong, 0400);
  56 MODULE_PARM_DESC(mem_address,
  57                 "start of reserved RAM used to store oops/panic logs");
  58
  59 static ulong mem_size;
  60 module_param(mem_size, ulong, 0400);
  61 MODULE_PARM_DESC(mem_size,
  62                 "size of reserved RAM used to store oops/panic logs");
  63
  64 static int dump_oops = 1;
  65 module_param(dump_oops, int, 0600);
  66 MODULE_PARM_DESC(dump_oops,
  67                 "set to 1 to dump oopses, 0 to only dump panics (default 1)");
  68
  69 static int ramoops_ecc;
  70 module_param_named(ecc, ramoops_ecc, int, 0600);
  71 MODULE_PARM_DESC(ramoops_ecc,
  72                 "if non-zero, the option enables ECC support and specifies "
  73                 "ECC buffer size in bytes (1 is a special value, means 16 "
  74                 "bytes ECC)");
  75
  76 struct ramoops_context {
  77         struct persistent_ram_zone **przs;
  78         struct persistent_ram_zone *cprz;
  79         struct persistent_ram_zone *fprz;
  80         phys_addr_t phys_addr;
  81         unsigned long size;
  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         unsigned int max_dump_cnt;
  88         unsigned int dump_write_cnt;
  89         unsigned int dump_read_cnt;
  90         unsigned int console_read_cnt;
  91         unsigned int ftrace_read_cnt;
  92         struct pstore_info pstore;
  93 };
  94
  95 static struct platform_device *dummy;
  96 static struct ramoops_platform_data *dummy_data;
  97
  98 static int ramoops_pstore_open(struct pstore_info *psi)
  99 {
 100         struct ramoops_context *cxt = psi->data;
 101
 102         cxt->dump_read_cnt = 0;
 103         cxt->console_read_cnt = 0;
 104         return 0;
 105 }
 106
 107 static struct persistent_ram_zone *
 108 ramoops_get_next_prz(struct persistent_ram_zone *przs[], uint *c, uint max,
 109                      u64 *id,
 110                      enum pstore_type_id *typep, enum pstore_type_id type,
 111                      bool update)
 112 {
 113         struct persistent_ram_zone *prz;
 114         int i = (*c)++;
 115
 116         if (i >= max)
 117                 return NULL;
 118
 119         prz = przs[i];
 120
 121         if (update) {
 122                 /* Update old/shadowed buffer. */
 123                 persistent_ram_save_old(prz);
 124                 if (!persistent_ram_old_size(prz))
 125                         return NULL;
 126         }
 127
 128         *typep = type;
 129         *id = i;
 130
 131         return prz;
 132 }
 133
 134 static ssize_t ramoops_pstore_read(u64 *id, enum pstore_type_id *type,
 135                                    int *count, struct timespec *time,
 136                                    char **buf, struct pstore_info *psi)
 137 {
 138         ssize_t size;
 139         ssize_t ecc_notice_size;
 140         struct ramoops_context *cxt = psi->data;
 141         struct persistent_ram_zone *prz;
 142
 143         prz = ramoops_get_next_prz(cxt->przs, &cxt->dump_read_cnt,
 144                                    cxt->max_dump_cnt, id, type,
 145                                    PSTORE_TYPE_DMESG, 1);
 146         if (!prz)
 147                 prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
 148                                            1, id, type, PSTORE_TYPE_CONSOLE, 0);
 149         if (!prz)
 150                 prz = ramoops_get_next_prz(&cxt->fprz, &cxt->ftrace_read_cnt,
 151                                            1, id, type, PSTORE_TYPE_FTRACE, 0);
 152         if (!prz)
 153                 return 0;
 154
 155         /* TODO(kees): Bogus time for the moment. */
 156         time->tv_sec = 0;
 157         time->tv_nsec = 0;
 158
 159         size = persistent_ram_old_size(prz);
 160
 161         /* ECC correction notice */
 162         ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
 163
 164         *buf = kmalloc(size + ecc_notice_size + 1, GFP_KERNEL);
 165         if (*buf == NULL)
 166                 return -ENOMEM;
 167
 168         memcpy(*buf, persistent_ram_old(prz), size);
 169         persistent_ram_ecc_string(prz, *buf + size, ecc_notice_size + 1);
 170
 171         return size + ecc_notice_size;
 172 }
 173
 174 static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz)
 175 {
 176         char *hdr;
 177         struct timespec timestamp;
 178         size_t len;
 179
 180         /* Report zeroed timestamp if called before timekeeping has resumed. */
 181         if (__getnstimeofday(&timestamp)) {
 182                 timestamp.tv_sec = 0;
 183                 timestamp.tv_nsec = 0;
 184         }
 185         hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lu.%lu\n",
 186                 (long)timestamp.tv_sec, (long)(timestamp.tv_nsec / 1000));
 187         WARN_ON_ONCE(!hdr);
 188         len = hdr ? strlen(hdr) : 0;
 189         persistent_ram_write(prz, hdr, len);
 190         kfree(hdr);
 191
 192         return len;
 193 }
 194
 195 static int notrace ramoops_pstore_write_buf(enum pstore_type_id type,
 196                                             enum kmsg_dump_reason reason,
 197                                             u64 *id, unsigned int part,
 198                                             const char *buf, size_t size,
 199                                             struct pstore_info *psi)
 200 {
 201         struct ramoops_context *cxt = psi->data;
 202         struct persistent_ram_zone *prz;
 203         size_t hlen;
 204
 205         if (type == PSTORE_TYPE_CONSOLE) {
 206                 if (!cxt->cprz)
 207                         return -ENOMEM;
 208                 persistent_ram_write(cxt->cprz, buf, size);
 209                 return 0;
 210         } else if (type == PSTORE_TYPE_FTRACE) {
 211                 if (!cxt->fprz)
 212                         return -ENOMEM;
 213                 persistent_ram_write(cxt->fprz, buf, size);
 214                 return 0;
 215         }
 216
 217         if (type != PSTORE_TYPE_DMESG)
 218                 return -EINVAL;
 219
 220         /* Out of the various dmesg dump types, ramoops is currently designed
 221          * to only store crash logs, rather than storing general kernel logs.
 222          */
 223         if (reason != KMSG_DUMP_OOPS &&
 224             reason != KMSG_DUMP_PANIC)
 225                 return -EINVAL;
 226
 227         /* Skip Oopes when configured to do so. */
 228         if (reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
 229                 return -EINVAL;
 230
 231         /* Explicitly only take the first part of any new crash.
 232          * If our buffer is larger than kmsg_bytes, this can never happen,
 233          * and if our buffer is smaller than kmsg_bytes, we don't want the
 234          * report split across multiple records.
 235          */
 236         if (part != 1)
 237                 return -ENOSPC;
 238
 239         if (!cxt->przs)
 240                 return -ENOSPC;
 241
 242         prz = cxt->przs[cxt->dump_write_cnt];
 243
 244         hlen = ramoops_write_kmsg_hdr(prz);
 245         if (size + hlen > prz->buffer_size)
 246                 size = prz->buffer_size - hlen;
 247         persistent_ram_write(prz, buf, size);
 248
 249         cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
 250
 251         return 0;
 252 }
 253
 254 static int ramoops_pstore_erase(enum pstore_type_id type, u64 id, int count,
 255                                 struct timespec time, struct pstore_info *psi)
 256 {
 257         struct ramoops_context *cxt = psi->data;
 258         struct persistent_ram_zone *prz;
 259
 260         switch (type) {
 261         case PSTORE_TYPE_DMESG:
 262                 if (id >= cxt->max_dump_cnt)
 263                         return -EINVAL;
 264                 prz = cxt->przs[id];
 265                 break;
 266         case PSTORE_TYPE_CONSOLE:
 267                 prz = cxt->cprz;
 268                 break;
 269         case PSTORE_TYPE_FTRACE:
 270                 prz = cxt->fprz;
 271                 break;
 272         default:
 273                 return -EINVAL;
 274         }
 275
 276         persistent_ram_free_old(prz);
 277         persistent_ram_zap(prz);
 278
 279         return 0;
 280 }
 281
 282 static struct ramoops_context oops_cxt = {
 283         .pstore = {
 284                 .owner  = THIS_MODULE,
 285                 .name   = "ramoops",
 286                 .open   = ramoops_pstore_open,
 287                 .read   = ramoops_pstore_read,
 288                 .write_buf      = ramoops_pstore_write_buf,
 289                 .erase  = ramoops_pstore_erase,
 290         },
 291 };
 292
 293 static void ramoops_free_przs(struct ramoops_context *cxt)
 294 {
 295         int i;
 296
 297         if (!cxt->przs)
 298                 return;
 299
 300         for (i = 0; !IS_ERR_OR_NULL(cxt->przs[i]); i++)
 301                 persistent_ram_free(cxt->przs[i]);
 302         kfree(cxt->przs);
 303 }
 304
 305 static int ramoops_init_przs(struct device *dev, struct ramoops_context *cxt,
 306                              phys_addr_t *paddr, size_t dump_mem_sz)
 307 {
 308         int err = -ENOMEM;
 309         int i;
 310
 311         if (!cxt->record_size)
 312                 return 0;
 313
 314         if (*paddr + dump_mem_sz - cxt->phys_addr > cxt->size) {
 315                 dev_err(dev, "no room for dumps\n");
 316                 return -ENOMEM;
 317         }
 318
 319         cxt->max_dump_cnt = dump_mem_sz / cxt->record_size;
 320         if (!cxt->max_dump_cnt)
 321                 return -ENOMEM;
 322
 323         cxt->przs = kzalloc(sizeof(*cxt->przs) * cxt->max_dump_cnt,
 324                              GFP_KERNEL);
 325         if (!cxt->przs) {
 326                 dev_err(dev, "failed to initialize a prz array for dumps\n");
 327                 return -ENOMEM;
 328         }
 329
 330         for (i = 0; i < cxt->max_dump_cnt; i++) {
 331                 size_t sz = cxt->record_size;
 332
 333                 cxt->przs[i] = persistent_ram_new(*paddr, sz, 0,
 334                                                   &cxt->ecc_info);
 335                 if (IS_ERR(cxt->przs[i])) {
 336                         err = PTR_ERR(cxt->przs[i]);
 337                         dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
 338                                 sz, (unsigned long long)*paddr, err);
 339                         goto fail_prz;
 340                 }
 341                 *paddr += sz;
 342         }
 343
 344         return 0;
 345 fail_prz:
 346         ramoops_free_przs(cxt);
 347         return err;
 348 }
 349
 350 static int ramoops_init_prz(struct device *dev, struct ramoops_context *cxt,
 351                             struct persistent_ram_zone **prz,
 352                             phys_addr_t *paddr, size_t sz, u32 sig)
 353 {
 354         if (!sz)
 355                 return 0;
 356
 357         if (*paddr + sz - cxt->phys_addr > cxt->size) {
 358                 dev_err(dev, "no room for mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
 359                         sz, (unsigned long long)*paddr,
 360                         cxt->size, (unsigned long long)cxt->phys_addr);
 361                 return -ENOMEM;
 362         }
 363
 364         *prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info);
 365         if (IS_ERR(*prz)) {
 366                 int err = PTR_ERR(*prz);
 367
 368                 dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
 369                         sz, (unsigned long long)*paddr, err);
 370                 return err;
 371         }
 372
 373         persistent_ram_zap(*prz);
 374
 375         *paddr += sz;
 376
 377         return 0;
 378 }
 379
 380 static int ramoops_probe(struct platform_device *pdev)
 381 {
 382         struct device *dev = &pdev->dev;
 383         struct ramoops_platform_data *pdata = pdev->dev.platform_data;
 384         struct ramoops_context *cxt = &oops_cxt;
 385         size_t dump_mem_sz;
 386         phys_addr_t paddr;
 387         int err = -EINVAL;
 388
 389         /* Only a single ramoops area allowed at a time, so fail extra
 390          * probes.
 391          */
 392         if (cxt->max_dump_cnt)
 393                 goto fail_out;
 394
 395         if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
 396                         !pdata->ftrace_size)) {
 397                 pr_err("The memory size and the record/console size must be "
 398                         "non-zero\n");
 399                 goto fail_out;
 400         }
 401
 402         if (!is_power_of_2(pdata->mem_size))
 403                 pdata->mem_size = rounddown_pow_of_two(pdata->mem_size);
 404         if (!is_power_of_2(pdata->record_size))
 405                 pdata->record_size = rounddown_pow_of_two(pdata->record_size);
 406         if (!is_power_of_2(pdata->console_size))
 407                 pdata->console_size = rounddown_pow_of_two(pdata->console_size);
 408         if (!is_power_of_2(pdata->ftrace_size))
 409                 pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
 410
 411         cxt->dump_read_cnt = 0;
 412         cxt->size = pdata->mem_size;
 413         cxt->phys_addr = pdata->mem_address;
 414         cxt->record_size = pdata->record_size;
 415         cxt->console_size = pdata->console_size;
 416         cxt->ftrace_size = pdata->ftrace_size;
 417         cxt->dump_oops = pdata->dump_oops;
 418         cxt->ecc_info = pdata->ecc_info;
 419
 420         paddr = cxt->phys_addr;
 421
 422         dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size;
 423         err = ramoops_init_przs(dev, cxt, &paddr, dump_mem_sz);
 424         if (err)
 425                 goto fail_out;
 426
 427         err = ramoops_init_prz(dev, cxt, &cxt->cprz, &paddr,
 428                                cxt->console_size, 0);
 429         if (err)
 430                 goto fail_init_cprz;
 431
 432         err = ramoops_init_prz(dev, cxt, &cxt->fprz, &paddr, cxt->ftrace_size,
 433                                LINUX_VERSION_CODE);
 434         if (err)
 435                 goto fail_init_fprz;
 436
 437         if (!cxt->przs && !cxt->cprz && !cxt->fprz) {
 438                 pr_err("memory size too small, minimum is %zu\n",
 439                         cxt->console_size + cxt->record_size +
 440                         cxt->ftrace_size);
 441                 goto fail_cnt;
 442         }
 443
 444         cxt->pstore.data = cxt;
 445         /*
 446          * Console can handle any buffer size, so prefer LOG_LINE_MAX. If we
 447          * have to handle dumps, we must have at least record_size buffer. And
 448          * for ftrace, bufsize is irrelevant (if bufsize is 0, buf will be
 449          * ZERO_SIZE_PTR).
 450          */
 451         if (cxt->console_size)
 452                 cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
 453         cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
 454         cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
 455         spin_lock_init(&cxt->pstore.buf_lock);
 456         if (!cxt->pstore.buf) {
 457                 pr_err("cannot allocate pstore buffer\n");
 458                 goto fail_clear;
 459         }
 460
 461         err = pstore_register(&cxt->pstore);
 462         if (err) {
 463                 pr_err("registering with pstore failed\n");
 464                 goto fail_buf;
 465         }
 466
 467         /*
 468          * Update the module parameter variables as well so they are visible
 469          * through /sys/module/ramoops/parameters/
 470          */
 471         mem_size = pdata->mem_size;
 472         mem_address = pdata->mem_address;
 473         record_size = pdata->record_size;
 474         dump_oops = pdata->dump_oops;
 475
 476         pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
 477                 cxt->size, (unsigned long long)cxt->phys_addr,
 478                 cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
 479
 480         return 0;
 481
 482 fail_buf:
 483         kfree(cxt->pstore.buf);
 484 fail_clear:
 485         cxt->pstore.bufsize = 0;
 486         cxt->max_dump_cnt = 0;
 487 fail_cnt:
 488         kfree(cxt->fprz);
 489 fail_init_fprz:
 490         kfree(cxt->cprz);
 491 fail_init_cprz:
 492         ramoops_free_przs(cxt);
 493 fail_out:
 494         return err;
 495 }
 496
 497 static int __exit ramoops_remove(struct platform_device *pdev)
 498 {
 499 #if 0
 500         /* TODO(kees): We cannot unload ramoops since pstore doesn't support
 501          * unregistering yet.
 502          */
 503         struct ramoops_context *cxt = &oops_cxt;
 504
 505         iounmap(cxt->virt_addr);
 506         release_mem_region(cxt->phys_addr, cxt->size);
 507         cxt->max_dump_cnt = 0;
 508
 509         /* TODO(kees): When pstore supports unregistering, call it here. */
 510         kfree(cxt->pstore.buf);
 511         cxt->pstore.bufsize = 0;
 512
 513         return 0;
 514 #endif
 515         return -EBUSY;
 516 }
 517
 518 static struct platform_driver ramoops_driver = {
 519         .probe          = ramoops_probe,
 520         .remove         = __exit_p(ramoops_remove),
 521         .driver         = {
 522                 .name   = "ramoops",
 523                 .owner  = THIS_MODULE,
 524         },
 525 };
 526
 527 static void ramoops_register_dummy(void)
 528 {
 529         if (!mem_size)
 530                 return;
 531
 532         pr_info("using module parameters\n");
 533
 534         dummy_data = kzalloc(sizeof(*dummy_data), GFP_KERNEL);
 535         if (!dummy_data) {
 536                 pr_info("could not allocate pdata\n");
 537                 return;
 538         }
 539
 540         dummy_data->mem_size = mem_size;
 541         dummy_data->mem_address = mem_address;
 542         dummy_data->record_size = record_size;
 543         dummy_data->console_size = ramoops_console_size;
 544         dummy_data->ftrace_size = ramoops_ftrace_size;
 545         dummy_data->dump_oops = dump_oops;
 546         /*
 547          * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
 548          * (using 1 byte for ECC isn't much of use anyway).
 549          */
 550         dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
 551
 552         dummy = platform_device_register_data(NULL, "ramoops", -1,
 553                         dummy_data, sizeof(struct ramoops_platform_data));
 554         if (IS_ERR(dummy)) {
 555                 pr_info("could not create platform device: %ld\n",
 556                         PTR_ERR(dummy));
 557         }
 558 }
 559
 560 static int __init ramoops_init(void)
 561 {
 562         ramoops_register_dummy();
 563         return platform_driver_register(&ramoops_driver);
 564 }
 565 postcore_initcall(ramoops_init);
 566
 567 static void __exit ramoops_exit(void)
 568 {
 569         platform_driver_unregister(&ramoops_driver);
 570         platform_device_unregister(dummy);
 571         kfree(dummy_data);
 572 }
 573 module_exit(ramoops_exit);
 574
 575 MODULE_LICENSE("GPL");
 576 MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
 577 MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");