fs/pstore/platform.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Persistent Storage - platform driver interface parts.
   4  *
   5  * Copyright (C) 2007-2008 Google, Inc.
   6  * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
   7  */
   8
   9 #define pr_fmt(fmt) "pstore: " fmt
  10
  11 #include <linux/atomic.h>
  12 #include <linux/types.h>
  13 #include <linux/errno.h>
  14 #include <linux/init.h>
  15 #include <linux/kmsg_dump.h>
  16 #include <linux/console.h>
  17 #include <linux/module.h>
  18 #include <linux/pstore.h>
  19 #if IS_ENABLED(CONFIG_PSTORE_LZO_COMPRESS)
  20 #include <linux/lzo.h>
  21 #endif
  22 #if IS_ENABLED(CONFIG_PSTORE_LZ4_COMPRESS) || IS_ENABLED(CONFIG_PSTORE_LZ4HC_COMPRESS)
  23 #include <linux/lz4.h>
  24 #endif
  25 #if IS_ENABLED(CONFIG_PSTORE_ZSTD_COMPRESS)
  26 #include <linux/zstd.h>
  27 #endif
  28 #include <linux/crypto.h>
  29 #include <linux/string.h>
  30 #include <linux/timer.h>
  31 #include <linux/slab.h>
  32 #include <linux/uaccess.h>
  33 #include <linux/jiffies.h>
  34 #include <linux/workqueue.h>
  35
  36 #include "internal.h"
  37
  38 /*
  39  * We defer making "oops" entries appear in pstore - see
  40  * whether the system is actually still running well enough
  41  * to let someone see the entry
  42  */
  43 static int pstore_update_ms = -1;
  44 module_param_named(update_ms, pstore_update_ms, int, 0600);
  45 MODULE_PARM_DESC(update_ms, "milliseconds before pstore updates its content "
  46                  "(default is -1, which means runtime updates are disabled; "
  47                  "enabling this option may not be safe; it may lead to further "
  48                  "corruption on Oopses)");
  49
  50 /* Names should be in the same order as the enum pstore_type_id */
  51 static const char * const pstore_type_names[] = {
  52         "dmesg",
  53         "mce",
  54         "console",
  55         "ftrace",
  56         "rtas",
  57         "powerpc-ofw",
  58         "powerpc-common",
  59         "pmsg",
  60         "powerpc-opal",
  61 };
  62
  63 static int pstore_new_entry;
  64
  65 static void pstore_timefunc(struct timer_list *);
  66 static DEFINE_TIMER(pstore_timer, pstore_timefunc);
  67
  68 static void pstore_dowork(struct work_struct *);
  69 static DECLARE_WORK(pstore_work, pstore_dowork);
  70
  71 /*
  72  * psinfo_lock protects "psinfo" during calls to
  73  * pstore_register(), pstore_unregister(), and
  74  * the filesystem mount/unmount routines.
  75  */
  76 static DEFINE_MUTEX(psinfo_lock);
  77 struct pstore_info *psinfo;
  78
  79 static char *backend;
  80 module_param(backend, charp, 0444);
  81 MODULE_PARM_DESC(backend, "specific backend to use");
  82
  83 static char *compress =
  84 #ifdef CONFIG_PSTORE_COMPRESS_DEFAULT
  85                 CONFIG_PSTORE_COMPRESS_DEFAULT;
  86 #else
  87                 NULL;
  88 #endif
  89 module_param(compress, charp, 0444);
  90 MODULE_PARM_DESC(compress, "compression to use");
  91
  92 /* Compression parameters */
  93 static struct crypto_comp *tfm;
  94
  95 struct pstore_zbackend {
  96         int (*zbufsize)(size_t size);
  97         const char *name;
  98 };
  99
 100 static char *big_oops_buf;
 101 static size_t big_oops_buf_sz;
 102
 103 /* How much of the console log to snapshot */
 104 unsigned long kmsg_bytes = PSTORE_DEFAULT_KMSG_BYTES;
 105
 106 void pstore_set_kmsg_bytes(int bytes)
 107 {
 108         kmsg_bytes = bytes;
 109 }
 110
 111 /* Tag each group of saved records with a sequence number */
 112 static int      oopscount;
 113
 114 const char *pstore_type_to_name(enum pstore_type_id type)
 115 {
 116         BUILD_BUG_ON(ARRAY_SIZE(pstore_type_names) != PSTORE_TYPE_MAX);
 117
 118         if (WARN_ON_ONCE(type >= PSTORE_TYPE_MAX))
 119                 return "unknown";
 120
 121         return pstore_type_names[type];
 122 }
 123 EXPORT_SYMBOL_GPL(pstore_type_to_name);
 124
 125 enum pstore_type_id pstore_name_to_type(const char *name)
 126 {
 127         int i;
 128
 129         for (i = 0; i < PSTORE_TYPE_MAX; i++) {
 130                 if (!strcmp(pstore_type_names[i], name))
 131                         return i;
 132         }
 133
 134         return PSTORE_TYPE_MAX;
 135 }
 136 EXPORT_SYMBOL_GPL(pstore_name_to_type);
 137
 138 static void pstore_timer_kick(void)
 139 {
 140         if (pstore_update_ms < 0)
 141                 return;
 142
 143         mod_timer(&pstore_timer, jiffies + msecs_to_jiffies(pstore_update_ms));
 144 }
 145
 146 static bool pstore_cannot_block_path(enum kmsg_dump_reason reason)
 147 {
 148         /*
 149          * In case of NMI path, pstore shouldn't be blocked
 150          * regardless of reason.
 151          */
 152         if (in_nmi())
 153                 return true;
 154
 155         switch (reason) {
 156         /* In panic case, other cpus are stopped by smp_send_stop(). */
 157         case KMSG_DUMP_PANIC:
 158         /*
 159          * Emergency restart shouldn't be blocked by spinning on
 160          * pstore_info::buf_lock.
 161          */
 162         case KMSG_DUMP_EMERG:
 163                 return true;
 164         default:
 165                 return false;
 166         }
 167 }
 168
 169 #if IS_ENABLED(CONFIG_PSTORE_DEFLATE_COMPRESS)
 170 static int zbufsize_deflate(size_t size)
 171 {
 172         size_t cmpr;
 173
 174         switch (size) {
 175         /* buffer range for efivars */
 176         case 1000 ... 2000:
 177                 cmpr = 56;
 178                 break;
 179         case 2001 ... 3000:
 180                 cmpr = 54;
 181                 break;
 182         case 3001 ... 3999:
 183                 cmpr = 52;
 184                 break;
 185         /* buffer range for nvram, erst */
 186         case 4000 ... 10000:
 187                 cmpr = 45;
 188                 break;
 189         default:
 190                 cmpr = 60;
 191                 break;
 192         }
 193
 194         return (size * 100) / cmpr;
 195 }
 196 #endif
 197
 198 #if IS_ENABLED(CONFIG_PSTORE_LZO_COMPRESS)
 199 static int zbufsize_lzo(size_t size)
 200 {
 201         return lzo1x_worst_compress(size);
 202 }
 203 #endif
 204
 205 #if IS_ENABLED(CONFIG_PSTORE_LZ4_COMPRESS) || IS_ENABLED(CONFIG_PSTORE_LZ4HC_COMPRESS)
 206 static int zbufsize_lz4(size_t size)
 207 {
 208         return LZ4_compressBound(size);
 209 }
 210 #endif
 211
 212 #if IS_ENABLED(CONFIG_PSTORE_842_COMPRESS)
 213 static int zbufsize_842(size_t size)
 214 {
 215         return size;
 216 }
 217 #endif
 218
 219 #if IS_ENABLED(CONFIG_PSTORE_ZSTD_COMPRESS)
 220 static int zbufsize_zstd(size_t size)
 221 {
 222         return ZSTD_compressBound(size);
 223 }
 224 #endif
 225
 226 static const struct pstore_zbackend *zbackend __ro_after_init;
 227
 228 static const struct pstore_zbackend zbackends[] = {
 229 #if IS_ENABLED(CONFIG_PSTORE_DEFLATE_COMPRESS)
 230         {
 231                 .zbufsize       = zbufsize_deflate,
 232                 .name           = "deflate",
 233         },
 234 #endif
 235 #if IS_ENABLED(CONFIG_PSTORE_LZO_COMPRESS)
 236         {
 237                 .zbufsize       = zbufsize_lzo,
 238                 .name           = "lzo",
 239         },
 240 #endif
 241 #if IS_ENABLED(CONFIG_PSTORE_LZ4_COMPRESS)
 242         {
 243                 .zbufsize       = zbufsize_lz4,
 244                 .name           = "lz4",
 245         },
 246 #endif
 247 #if IS_ENABLED(CONFIG_PSTORE_LZ4HC_COMPRESS)
 248         {
 249                 .zbufsize       = zbufsize_lz4,
 250                 .name           = "lz4hc",
 251         },
 252 #endif
 253 #if IS_ENABLED(CONFIG_PSTORE_842_COMPRESS)
 254         {
 255                 .zbufsize       = zbufsize_842,
 256                 .name           = "842",
 257         },
 258 #endif
 259 #if IS_ENABLED(CONFIG_PSTORE_ZSTD_COMPRESS)
 260         {
 261                 .zbufsize       = zbufsize_zstd,
 262                 .name           = "zstd",
 263         },
 264 #endif
 265         { }
 266 };
 267
 268 static int pstore_compress(const void *in, void *out,
 269                            unsigned int inlen, unsigned int outlen)
 270 {
 271         int ret;
 272
 273         if (!IS_ENABLED(CONFIG_PSTORE_COMPRESS))
 274                 return -EINVAL;
 275
 276         ret = crypto_comp_compress(tfm, in, inlen, out, &outlen);
 277         if (ret) {
 278                 pr_err("crypto_comp_compress failed, ret = %d!\n", ret);
 279                 return ret;
 280         }
 281
 282         return outlen;
 283 }
 284
 285 static void allocate_buf_for_compression(void)
 286 {
 287         struct crypto_comp *ctx;
 288         int size;
 289         char *buf;
 290
 291         /* Skip if not built-in or compression backend not selected yet. */
 292         if (!IS_ENABLED(CONFIG_PSTORE_COMPRESS) || !zbackend)
 293                 return;
 294
 295         /* Skip if no pstore backend yet or compression init already done. */
 296         if (!psinfo || tfm)
 297                 return;
 298
 299         if (!crypto_has_comp(zbackend->name, 0, 0)) {
 300                 pr_err("Unknown compression: %s\n", zbackend->name);
 301                 return;
 302         }
 303
 304         size = zbackend->zbufsize(psinfo->bufsize);
 305         if (size <= 0) {
 306                 pr_err("Invalid compression size for %s: %d\n",
 307                        zbackend->name, size);
 308                 return;
 309         }
 310
 311         buf = kmalloc(size, GFP_KERNEL);
 312         if (!buf) {
 313                 pr_err("Failed %d byte compression buffer allocation for: %s\n",
 314                        size, zbackend->name);
 315                 return;
 316         }
 317
 318         ctx = crypto_alloc_comp(zbackend->name, 0, 0);
 319         if (IS_ERR_OR_NULL(ctx)) {
 320                 kfree(buf);
 321                 pr_err("crypto_alloc_comp('%s') failed: %ld\n", zbackend->name,
 322                        PTR_ERR(ctx));
 323                 return;
 324         }
 325
 326         /* A non-NULL big_oops_buf indicates compression is available. */
 327         tfm = ctx;
 328         big_oops_buf_sz = size;
 329         big_oops_buf = buf;
 330
 331         pr_info("Using crash dump compression: %s\n", zbackend->name);
 332 }
 333
 334 static void free_buf_for_compression(void)
 335 {
 336         if (IS_ENABLED(CONFIG_PSTORE_COMPRESS) && tfm) {
 337                 crypto_free_comp(tfm);
 338                 tfm = NULL;
 339         }
 340         kfree(big_oops_buf);
 341         big_oops_buf = NULL;
 342         big_oops_buf_sz = 0;
 343 }
 344
 345 /*
 346  * Called when compression fails, since the printk buffer
 347  * would be fetched for compression calling it again when
 348  * compression fails would have moved the iterator of
 349  * printk buffer which results in fetching old contents.
 350  * Copy the recent messages from big_oops_buf to psinfo->buf
 351  */
 352 static size_t copy_kmsg_to_buffer(int hsize, size_t len)
 353 {
 354         size_t total_len;
 355         size_t diff;
 356
 357         total_len = hsize + len;
 358
 359         if (total_len > psinfo->bufsize) {
 360                 diff = total_len - psinfo->bufsize + hsize;
 361                 memcpy(psinfo->buf, big_oops_buf, hsize);
 362                 memcpy(psinfo->buf + hsize, big_oops_buf + diff,
 363                                         psinfo->bufsize - hsize);
 364                 total_len = psinfo->bufsize;
 365         } else
 366                 memcpy(psinfo->buf, big_oops_buf, total_len);
 367
 368         return total_len;
 369 }
 370
 371 void pstore_record_init(struct pstore_record *record,
 372                         struct pstore_info *psinfo)
 373 {
 374         memset(record, 0, sizeof(*record));
 375
 376         record->psi = psinfo;
 377
 378         /* Report zeroed timestamp if called before timekeeping has resumed. */
 379         record->time = ns_to_timespec64(ktime_get_real_fast_ns());
 380 }
 381
 382 /*
 383  * callback from kmsg_dump. Save as much as we can (up to kmsg_bytes) from the
 384  * end of the buffer.
 385  */
 386 static void pstore_dump(struct kmsg_dumper *dumper,
 387                         enum kmsg_dump_reason reason)
 388 {
 389         unsigned long   total = 0;
 390         const char      *why;
 391         unsigned int    part = 1;
 392         unsigned long   flags = 0;
 393         int             ret;
 394
 395         why = kmsg_dump_reason_str(reason);
 396
 397         if (pstore_cannot_block_path(reason)) {
 398                 if (!spin_trylock_irqsave(&psinfo->buf_lock, flags)) {
 399                         pr_err("dump skipped in %s path because of concurrent dump\n",
 400                                         in_nmi() ? "NMI" : why);
 401                         return;
 402                 }
 403         } else {
 404                 spin_lock_irqsave(&psinfo->buf_lock, flags);
 405         }
 406
 407         oopscount++;
 408         while (total < kmsg_bytes) {
 409                 char *dst;
 410                 size_t dst_size;
 411                 int header_size;
 412                 int zipped_len = -1;
 413                 size_t dump_size;
 414                 struct pstore_record record;
 415
 416                 pstore_record_init(&record, psinfo);
 417                 record.type = PSTORE_TYPE_DMESG;
 418                 record.count = oopscount;
 419                 record.reason = reason;
 420                 record.part = part;
 421                 record.buf = psinfo->buf;
 422
 423                 if (big_oops_buf) {
 424                         dst = big_oops_buf;
 425                         dst_size = big_oops_buf_sz;
 426                 } else {
 427                         dst = psinfo->buf;
 428                         dst_size = psinfo->bufsize;
 429                 }
 430
 431                 /* Write dump header. */
 432                 header_size = snprintf(dst, dst_size, "%s#%d Part%u\n", why,
 433                                  oopscount, part);
 434                 dst_size -= header_size;
 435
 436                 /* Write dump contents. */
 437                 if (!kmsg_dump_get_buffer(dumper, true, dst + header_size,
 438                                           dst_size, &dump_size))
 439                         break;
 440
 441                 if (big_oops_buf) {
 442                         zipped_len = pstore_compress(dst, psinfo->buf,
 443                                                 header_size + dump_size,
 444                                                 psinfo->bufsize);
 445
 446                         if (zipped_len > 0) {
 447                                 record.compressed = true;
 448                                 record.size = zipped_len;
 449                         } else {
 450                                 record.size = copy_kmsg_to_buffer(header_size,
 451                                                                   dump_size);
 452                         }
 453                 } else {
 454                         record.size = header_size + dump_size;
 455                 }
 456
 457                 ret = psinfo->write(&record);
 458                 if (ret == 0 && reason == KMSG_DUMP_OOPS) {
 459                         pstore_new_entry = 1;
 460                         pstore_timer_kick();
 461                 }
 462
 463                 total += record.size;
 464                 part++;
 465         }
 466         spin_unlock_irqrestore(&psinfo->buf_lock, flags);
 467 }
 468
 469 static struct kmsg_dumper pstore_dumper = {
 470         .dump = pstore_dump,
 471 };
 472
 473 /*
 474  * Register with kmsg_dump to save last part of console log on panic.
 475  */
 476 static void pstore_register_kmsg(void)
 477 {
 478         kmsg_dump_register(&pstore_dumper);
 479 }
 480
 481 static void pstore_unregister_kmsg(void)
 482 {
 483         kmsg_dump_unregister(&pstore_dumper);
 484 }
 485
 486 #ifdef CONFIG_PSTORE_CONSOLE
 487 static void pstore_console_write(struct console *con, const char *s, unsigned c)
 488 {
 489         struct pstore_record record;
 490
 491         if (!c)
 492                 return;
 493
 494         pstore_record_init(&record, psinfo);
 495         record.type = PSTORE_TYPE_CONSOLE;
 496
 497         record.buf = (char *)s;
 498         record.size = c;
 499         psinfo->write(&record);
 500 }
 501
 502 static struct console pstore_console = {
 503         .write  = pstore_console_write,
 504         .index  = -1,
 505 };
 506
 507 static void pstore_register_console(void)
 508 {
 509         /* Show which backend is going to get console writes. */
 510         strscpy(pstore_console.name, psinfo->name,
 511                 sizeof(pstore_console.name));
 512         /*
 513          * Always initialize flags here since prior unregister_console()
 514          * calls may have changed settings (specifically CON_ENABLED).
 515          */
 516         pstore_console.flags = CON_PRINTBUFFER | CON_ENABLED | CON_ANYTIME;
 517         register_console(&pstore_console);
 518 }
 519
 520 static void pstore_unregister_console(void)
 521 {
 522         unregister_console(&pstore_console);
 523 }
 524 #else
 525 static void pstore_register_console(void) {}
 526 static void pstore_unregister_console(void) {}
 527 #endif
 528
 529 static int pstore_write_user_compat(struct pstore_record *record,
 530                                     const char __user *buf)
 531 {
 532         int ret = 0;
 533
 534         if (record->buf)
 535                 return -EINVAL;
 536
 537         record->buf = memdup_user(buf, record->size);
 538         if (IS_ERR(record->buf)) {
 539                 ret = PTR_ERR(record->buf);
 540                 goto out;
 541         }
 542
 543         ret = record->psi->write(record);
 544
 545         kfree(record->buf);
 546 out:
 547         record->buf = NULL;
 548
 549         return unlikely(ret < 0) ? ret : record->size;
 550 }
 551
 552 /*
 553  * platform specific persistent storage driver registers with
 554  * us here. If pstore is already mounted, call the platform
 555  * read function right away to populate the file system. If not
 556  * then the pstore mount code will call us later to fill out
 557  * the file system.
 558  */
 559 int pstore_register(struct pstore_info *psi)
 560 {
 561         if (backend && strcmp(backend, psi->name)) {
 562                 pr_warn("ignoring unexpected backend '%s'\n", psi->name);
 563                 return -EPERM;
 564         }
 565
 566         /* Sanity check flags. */
 567         if (!psi->flags) {
 568                 pr_warn("backend '%s' must support at least one frontend\n",
 569                         psi->name);
 570                 return -EINVAL;
 571         }
 572
 573         /* Check for required functions. */
 574         if (!psi->read || !psi->write) {
 575                 pr_warn("backend '%s' must implement read() and write()\n",
 576                         psi->name);
 577                 return -EINVAL;
 578         }
 579
 580         mutex_lock(&psinfo_lock);
 581         if (psinfo) {
 582                 pr_warn("backend '%s' already loaded: ignoring '%s'\n",
 583                         psinfo->name, psi->name);
 584                 mutex_unlock(&psinfo_lock);
 585                 return -EBUSY;
 586         }
 587
 588         if (!psi->write_user)
 589                 psi->write_user = pstore_write_user_compat;
 590         psinfo = psi;
 591         mutex_init(&psinfo->read_mutex);
 592         spin_lock_init(&psinfo->buf_lock);
 593
 594         if (psi->flags & PSTORE_FLAGS_DMESG)
 595                 allocate_buf_for_compression();
 596
 597         pstore_get_records(0);
 598
 599         if (psi->flags & PSTORE_FLAGS_DMESG) {
 600                 pstore_dumper.max_reason = psinfo->max_reason;
 601                 pstore_register_kmsg();
 602         }
 603         if (psi->flags & PSTORE_FLAGS_CONSOLE)
 604                 pstore_register_console();
 605         if (psi->flags & PSTORE_FLAGS_FTRACE)
 606                 pstore_register_ftrace();
 607         if (psi->flags & PSTORE_FLAGS_PMSG)
 608                 pstore_register_pmsg();
 609
 610         /* Start watching for new records, if desired. */
 611         pstore_timer_kick();
 612
 613         /*
 614          * Update the module parameter backend, so it is visible
 615          * through /sys/module/pstore/parameters/backend
 616          */
 617         backend = kstrdup(psi->name, GFP_KERNEL);
 618
 619         pr_info("Registered %s as persistent store backend\n", psi->name);
 620
 621         mutex_unlock(&psinfo_lock);
 622         return 0;
 623 }
 624 EXPORT_SYMBOL_GPL(pstore_register);
 625
 626 void pstore_unregister(struct pstore_info *psi)
 627 {
 628         /* It's okay to unregister nothing. */
 629         if (!psi)
 630                 return;
 631
 632         mutex_lock(&psinfo_lock);
 633
 634         /* Only one backend can be registered at a time. */
 635         if (WARN_ON(psi != psinfo)) {
 636                 mutex_unlock(&psinfo_lock);
 637                 return;
 638         }
 639
 640         /* Unregister all callbacks. */
 641         if (psi->flags & PSTORE_FLAGS_PMSG)
 642                 pstore_unregister_pmsg();
 643         if (psi->flags & PSTORE_FLAGS_FTRACE)
 644                 pstore_unregister_ftrace();
 645         if (psi->flags & PSTORE_FLAGS_CONSOLE)
 646                 pstore_unregister_console();
 647         if (psi->flags & PSTORE_FLAGS_DMESG)
 648                 pstore_unregister_kmsg();
 649
 650         /* Stop timer and make sure all work has finished. */
 651         del_timer_sync(&pstore_timer);
 652         flush_work(&pstore_work);
 653
 654         /* Remove all backend records from filesystem tree. */
 655         pstore_put_backend_records(psi);
 656
 657         free_buf_for_compression();
 658
 659         psinfo = NULL;
 660         kfree(backend);
 661         backend = NULL;
 662         mutex_unlock(&psinfo_lock);
 663 }
 664 EXPORT_SYMBOL_GPL(pstore_unregister);
 665
 666 static void decompress_record(struct pstore_record *record)
 667 {
 668         int ret;
 669         int unzipped_len;
 670         char *unzipped, *workspace;
 671
 672         if (!IS_ENABLED(CONFIG_PSTORE_COMPRESS) || !record->compressed)
 673                 return;
 674
 675         /* Only PSTORE_TYPE_DMESG support compression. */
 676         if (record->type != PSTORE_TYPE_DMESG) {
 677                 pr_warn("ignored compressed record type %d\n", record->type);
 678                 return;
 679         }
 680
 681         /* Missing compression buffer means compression was not initialized. */
 682         if (!big_oops_buf) {
 683                 pr_warn("no decompression method initialized!\n");
 684                 return;
 685         }
 686
 687         /* Allocate enough space to hold max decompression and ECC. */
 688         unzipped_len = big_oops_buf_sz;
 689         workspace = kmalloc(unzipped_len + record->ecc_notice_size,
 690                             GFP_KERNEL);
 691         if (!workspace)
 692                 return;
 693
 694         /* After decompression "unzipped_len" is almost certainly smaller. */
 695         ret = crypto_comp_decompress(tfm, record->buf, record->size,
 696                                           workspace, &unzipped_len);
 697         if (ret) {
 698                 pr_err("crypto_comp_decompress failed, ret = %d!\n", ret);
 699                 kfree(workspace);
 700                 return;
 701         }
 702
 703         /* Append ECC notice to decompressed buffer. */
 704         memcpy(workspace + unzipped_len, record->buf + record->size,
 705                record->ecc_notice_size);
 706
 707         /* Copy decompressed contents into an minimum-sized allocation. */
 708         unzipped = kmemdup(workspace, unzipped_len + record->ecc_notice_size,
 709                            GFP_KERNEL);
 710         kfree(workspace);
 711         if (!unzipped)
 712                 return;
 713
 714         /* Swap out compressed contents with decompressed contents. */
 715         kfree(record->buf);
 716         record->buf = unzipped;
 717         record->size = unzipped_len;
 718         record->compressed = false;
 719 }
 720
 721 /*
 722  * Read all the records from one persistent store backend. Create
 723  * files in our filesystem.  Don't warn about -EEXIST errors
 724  * when we are re-scanning the backing store looking to add new
 725  * error records.
 726  */
 727 void pstore_get_backend_records(struct pstore_info *psi,
 728                                 struct dentry *root, int quiet)
 729 {
 730         int failed = 0;
 731         unsigned int stop_loop = 65536;
 732
 733         if (!psi || !root)
 734                 return;
 735
 736         mutex_lock(&psi->read_mutex);
 737         if (psi->open && psi->open(psi))
 738                 goto out;
 739
 740         /*
 741          * Backend callback read() allocates record.buf. decompress_record()
 742          * may reallocate record.buf. On success, pstore_mkfile() will keep
 743          * the record.buf, so free it only on failure.
 744          */
 745         for (; stop_loop; stop_loop--) {
 746                 struct pstore_record *record;
 747                 int rc;
 748
 749                 record = kzalloc(sizeof(*record), GFP_KERNEL);
 750                 if (!record) {
 751                         pr_err("out of memory creating record\n");
 752                         break;
 753                 }
 754                 pstore_record_init(record, psi);
 755
 756                 record->size = psi->read(record);
 757
 758                 /* No more records left in backend? */
 759                 if (record->size <= 0) {
 760                         kfree(record);
 761                         break;
 762                 }
 763
 764                 decompress_record(record);
 765                 rc = pstore_mkfile(root, record);
 766                 if (rc) {
 767                         /* pstore_mkfile() did not take record, so free it. */
 768                         kfree(record->buf);
 769                         kfree(record);
 770                         if (rc != -EEXIST || !quiet)
 771                                 failed++;
 772                 }
 773         }
 774         if (psi->close)
 775                 psi->close(psi);
 776 out:
 777         mutex_unlock(&psi->read_mutex);
 778
 779         if (failed)
 780                 pr_warn("failed to create %d record(s) from '%s'\n",
 781                         failed, psi->name);
 782         if (!stop_loop)
 783                 pr_err("looping? Too many records seen from '%s'\n",
 784                         psi->name);
 785 }
 786
 787 static void pstore_dowork(struct work_struct *work)
 788 {
 789         pstore_get_records(1);
 790 }
 791
 792 static void pstore_timefunc(struct timer_list *unused)
 793 {
 794         if (pstore_new_entry) {
 795                 pstore_new_entry = 0;
 796                 schedule_work(&pstore_work);
 797         }
 798
 799         pstore_timer_kick();
 800 }
 801
 802 static void __init pstore_choose_compression(void)
 803 {
 804         const struct pstore_zbackend *step;
 805
 806         if (!compress)
 807                 return;
 808
 809         for (step = zbackends; step->name; step++) {
 810                 if (!strcmp(compress, step->name)) {
 811                         zbackend = step;
 812                         return;
 813                 }
 814         }
 815 }
 816
 817 static int __init pstore_init(void)
 818 {
 819         int ret;
 820
 821         pstore_choose_compression();
 822
 823         /*
 824          * Check if any pstore backends registered earlier but did not
 825          * initialize compression because crypto was not ready. If so,
 826          * initialize compression now.
 827          */
 828         allocate_buf_for_compression();
 829
 830         ret = pstore_init_fs();
 831         if (ret)
 832                 free_buf_for_compression();
 833
 834         return ret;
 835 }
 836 late_initcall(pstore_init);
 837
 838 static void __exit pstore_exit(void)
 839 {
 840         pstore_exit_fs();
 841 }
 842 module_exit(pstore_exit)
 843
 844 MODULE_AUTHOR("Tony Luck <tony.luck@intel.com>");
 845 MODULE_LICENSE("GPL");