fs/pstore/ram_core.c

   1 /*
   2  * Copyright (C) 2012 Google, Inc.
   3  *
   4  * This software is licensed under the terms of the GNU General Public
   5  * License version 2, as published by the Free Software Foundation, and
   6  * may be copied, distributed, and modified under those terms.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  */
  14
  15 #define pr_fmt(fmt) "persistent_ram: " fmt
  16
  17 #include <linux/device.h>
  18 #include <linux/err.h>
  19 #include <linux/errno.h>
  20 #include <linux/init.h>
  21 #include <linux/io.h>
  22 #include <linux/kernel.h>
  23 #include <linux/list.h>
  24 #include <linux/memblock.h>
  25 #include <linux/pstore_ram.h>
  26 #include <linux/rslib.h>
  27 #include <linux/slab.h>
  28 #include <linux/uaccess.h>
  29 #include <linux/vmalloc.h>
  30 #include <asm/page.h>
  31
  32 struct persistent_ram_buffer {
  33         uint32_t    sig;
  34         atomic_t    start;
  35         atomic_t    size;
  36         uint8_t     data[0];
  37 };
  38
  39 #define PERSISTENT_RAM_SIG (0x43474244) /* DBGC */
  40
  41 static inline size_t buffer_size(struct persistent_ram_zone *prz)
  42 {
  43         return atomic_read(&prz->buffer->size);
  44 }
  45
  46 static inline size_t buffer_start(struct persistent_ram_zone *prz)
  47 {
  48         return atomic_read(&prz->buffer->start);
  49 }
  50
  51 /* increase and wrap the start pointer, returning the old value */
  52 static size_t buffer_start_add_atomic(struct persistent_ram_zone *prz, size_t a)
  53 {
  54         int old;
  55         int new;
  56
  57         do {
  58                 old = atomic_read(&prz->buffer->start);
  59                 new = old + a;
  60                 while (unlikely(new >= prz->buffer_size))
  61                         new -= prz->buffer_size;
  62         } while (atomic_cmpxchg(&prz->buffer->start, old, new) != old);
  63
  64         return old;
  65 }
  66
  67 /* increase the size counter until it hits the max size */
  68 static void buffer_size_add_atomic(struct persistent_ram_zone *prz, size_t a)
  69 {
  70         size_t old;
  71         size_t new;
  72
  73         if (atomic_read(&prz->buffer->size) == prz->buffer_size)
  74                 return;
  75
  76         do {
  77                 old = atomic_read(&prz->buffer->size);
  78                 new = old + a;
  79                 if (new > prz->buffer_size)
  80                         new = prz->buffer_size;
  81         } while (atomic_cmpxchg(&prz->buffer->size, old, new) != old);
  82 }
  83
  84 static DEFINE_RAW_SPINLOCK(buffer_lock);
  85
  86 /* increase and wrap the start pointer, returning the old value */
  87 static size_t buffer_start_add_locked(struct persistent_ram_zone *prz, size_t a)
  88 {
  89         int old;
  90         int new;
  91         unsigned long flags;
  92
  93         raw_spin_lock_irqsave(&buffer_lock, flags);
  94
  95         old = atomic_read(&prz->buffer->start);
  96         new = old + a;
  97         while (unlikely(new >= prz->buffer_size))
  98                 new -= prz->buffer_size;
  99         atomic_set(&prz->buffer->start, new);
 100
 101         raw_spin_unlock_irqrestore(&buffer_lock, flags);
 102
 103         return old;
 104 }
 105
 106 /* increase the size counter until it hits the max size */
 107 static void buffer_size_add_locked(struct persistent_ram_zone *prz, size_t a)
 108 {
 109         size_t old;
 110         size_t new;
 111         unsigned long flags;
 112
 113         raw_spin_lock_irqsave(&buffer_lock, flags);
 114
 115         old = atomic_read(&prz->buffer->size);
 116         if (old == prz->buffer_size)
 117                 goto exit;
 118
 119         new = old + a;
 120         if (new > prz->buffer_size)
 121                 new = prz->buffer_size;
 122         atomic_set(&prz->buffer->size, new);
 123
 124 exit:
 125         raw_spin_unlock_irqrestore(&buffer_lock, flags);
 126 }
 127
 128 static size_t (*buffer_start_add)(struct persistent_ram_zone *, size_t) = buffer_start_add_atomic;
 129 static void (*buffer_size_add)(struct persistent_ram_zone *, size_t) = buffer_size_add_atomic;
 130
 131 static void notrace persistent_ram_encode_rs8(struct persistent_ram_zone *prz,
 132         uint8_t *data, size_t len, uint8_t *ecc)
 133 {
 134         int i;
 135         uint16_t par[prz->ecc_info.ecc_size];
 136
 137         /* Initialize the parity buffer */
 138         memset(par, 0, sizeof(par));
 139         encode_rs8(prz->rs_decoder, data, len, par, 0);
 140         for (i = 0; i < prz->ecc_info.ecc_size; i++)
 141                 ecc[i] = par[i];
 142 }
 143
 144 static int persistent_ram_decode_rs8(struct persistent_ram_zone *prz,
 145         void *data, size_t len, uint8_t *ecc)
 146 {
 147         int i;
 148         uint16_t par[prz->ecc_info.ecc_size];
 149
 150         for (i = 0; i < prz->ecc_info.ecc_size; i++)
 151                 par[i] = ecc[i];
 152         return decode_rs8(prz->rs_decoder, data, par, len,
 153                                 NULL, 0, NULL, 0, NULL);
 154 }
 155
 156 static void notrace persistent_ram_update_ecc(struct persistent_ram_zone *prz,
 157         unsigned int start, unsigned int count)
 158 {
 159         struct persistent_ram_buffer *buffer = prz->buffer;
 160         uint8_t *buffer_end = buffer->data + prz->buffer_size;
 161         uint8_t *block;
 162         uint8_t *par;
 163         int ecc_block_size = prz->ecc_info.block_size;
 164         int ecc_size = prz->ecc_info.ecc_size;
 165         int size = ecc_block_size;
 166
 167         if (!ecc_size)
 168                 return;
 169
 170         block = buffer->data + (start & ~(ecc_block_size - 1));
 171         par = prz->par_buffer + (start / ecc_block_size) * ecc_size;
 172
 173         do {
 174                 if (block + ecc_block_size > buffer_end)
 175                         size = buffer_end - block;
 176                 persistent_ram_encode_rs8(prz, block, size, par);
 177                 block += ecc_block_size;
 178                 par += ecc_size;
 179         } while (block < buffer->data + start + count);
 180 }
 181
 182 static void persistent_ram_update_header_ecc(struct persistent_ram_zone *prz)
 183 {
 184         struct persistent_ram_buffer *buffer = prz->buffer;
 185
 186         if (!prz->ecc_info.ecc_size)
 187                 return;
 188
 189         persistent_ram_encode_rs8(prz, (uint8_t *)buffer, sizeof(*buffer),
 190                                   prz->par_header);
 191 }
 192
 193 static void persistent_ram_ecc_old(struct persistent_ram_zone *prz)
 194 {
 195         struct persistent_ram_buffer *buffer = prz->buffer;
 196         uint8_t *block;
 197         uint8_t *par;
 198
 199         if (!prz->ecc_info.ecc_size)
 200                 return;
 201
 202         block = buffer->data;
 203         par = prz->par_buffer;
 204         while (block < buffer->data + buffer_size(prz)) {
 205                 int numerr;
 206                 int size = prz->ecc_info.block_size;
 207                 if (block + size > buffer->data + prz->buffer_size)
 208                         size = buffer->data + prz->buffer_size - block;
 209                 numerr = persistent_ram_decode_rs8(prz, block, size, par);
 210                 if (numerr > 0) {
 211                         pr_devel("error in block %p, %d\n", block, numerr);
 212                         prz->corrected_bytes += numerr;
 213                 } else if (numerr < 0) {
 214                         pr_devel("uncorrectable error in block %p\n", block);
 215                         prz->bad_blocks++;
 216                 }
 217                 block += prz->ecc_info.block_size;
 218                 par += prz->ecc_info.ecc_size;
 219         }
 220 }
 221
 222 static int persistent_ram_init_ecc(struct persistent_ram_zone *prz,
 223                                    struct persistent_ram_ecc_info *ecc_info)
 224 {
 225         int numerr;
 226         struct persistent_ram_buffer *buffer = prz->buffer;
 227         int ecc_blocks;
 228         size_t ecc_total;
 229
 230         if (!ecc_info || !ecc_info->ecc_size)
 231                 return 0;
 232
 233         prz->ecc_info.block_size = ecc_info->block_size ?: 128;
 234         prz->ecc_info.ecc_size = ecc_info->ecc_size ?: 16;
 235         prz->ecc_info.symsize = ecc_info->symsize ?: 8;
 236         prz->ecc_info.poly = ecc_info->poly ?: 0x11d;
 237
 238         ecc_blocks = DIV_ROUND_UP(prz->buffer_size - prz->ecc_info.ecc_size,
 239                                   prz->ecc_info.block_size +
 240                                   prz->ecc_info.ecc_size);
 241         ecc_total = (ecc_blocks + 1) * prz->ecc_info.ecc_size;
 242         if (ecc_total >= prz->buffer_size) {
 243                 pr_err("%s: invalid ecc_size %u (total %zu, buffer size %zu)\n",
 244                        __func__, prz->ecc_info.ecc_size,
 245                        ecc_total, prz->buffer_size);
 246                 return -EINVAL;
 247         }
 248
 249         prz->buffer_size -= ecc_total;
 250         prz->par_buffer = buffer->data + prz->buffer_size;
 251         prz->par_header = prz->par_buffer +
 252                           ecc_blocks * prz->ecc_info.ecc_size;
 253
 254         /*
 255          * first consecutive root is 0
 256          * primitive element to generate roots = 1
 257          */
 258         prz->rs_decoder = init_rs(prz->ecc_info.symsize, prz->ecc_info.poly,
 259                                   0, 1, prz->ecc_info.ecc_size);
 260         if (prz->rs_decoder == NULL) {
 261                 pr_info("init_rs failed\n");
 262                 return -EINVAL;
 263         }
 264
 265         prz->corrected_bytes = 0;
 266         prz->bad_blocks = 0;
 267
 268         numerr = persistent_ram_decode_rs8(prz, buffer, sizeof(*buffer),
 269                                            prz->par_header);
 270         if (numerr > 0) {
 271                 pr_info("error in header, %d\n", numerr);
 272                 prz->corrected_bytes += numerr;
 273         } else if (numerr < 0) {
 274                 pr_info("uncorrectable error in header\n");
 275                 prz->bad_blocks++;
 276         }
 277
 278         return 0;
 279 }
 280
 281 ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
 282         char *str, size_t len)
 283 {
 284         ssize_t ret;
 285
 286         if (!prz->ecc_info.ecc_size)
 287                 return 0;
 288
 289         if (prz->corrected_bytes || prz->bad_blocks)
 290                 ret = snprintf(str, len, ""
 291                         "\n%d Corrected bytes, %d unrecoverable blocks\n",
 292                         prz->corrected_bytes, prz->bad_blocks);
 293         else
 294                 ret = snprintf(str, len, "\nNo errors detected\n");
 295
 296         return ret;
 297 }
 298
 299 static void notrace persistent_ram_update(struct persistent_ram_zone *prz,
 300         const void *s, unsigned int start, unsigned int count)
 301 {
 302         struct persistent_ram_buffer *buffer = prz->buffer;
 303         memcpy(buffer->data + start, s, count);
 304         persistent_ram_update_ecc(prz, start, count);
 305 }
 306
 307 static int notrace persistent_ram_update_user(struct persistent_ram_zone *prz,
 308         const void __user *s, unsigned int start, unsigned int count)
 309 {
 310         struct persistent_ram_buffer *buffer = prz->buffer;
 311         int ret = unlikely(__copy_from_user(buffer->data + start, s, count)) ?
 312                 -EFAULT : 0;
 313         persistent_ram_update_ecc(prz, start, count);
 314         return ret;
 315 }
 316
 317 void persistent_ram_save_old(struct persistent_ram_zone *prz)
 318 {
 319         struct persistent_ram_buffer *buffer = prz->buffer;
 320         size_t size = buffer_size(prz);
 321         size_t start = buffer_start(prz);
 322
 323         if (!size)
 324                 return;
 325
 326         if (!prz->old_log) {
 327                 persistent_ram_ecc_old(prz);
 328                 prz->old_log = kmalloc(size, GFP_KERNEL);
 329         }
 330         if (!prz->old_log) {
 331                 pr_err("failed to allocate buffer\n");
 332                 return;
 333         }
 334
 335         prz->old_log_size = size;
 336         memcpy(prz->old_log, &buffer->data[start], size - start);
 337         memcpy(prz->old_log + size - start, &buffer->data[0], start);
 338 }
 339
 340 int notrace persistent_ram_write(struct persistent_ram_zone *prz,
 341         const void *s, unsigned int count)
 342 {
 343         int rem;
 344         int c = count;
 345         size_t start;
 346
 347         if (unlikely(c > prz->buffer_size)) {
 348                 s += c - prz->buffer_size;
 349                 c = prz->buffer_size;
 350         }
 351
 352         buffer_size_add(prz, c);
 353
 354         start = buffer_start_add(prz, c);
 355
 356         rem = prz->buffer_size - start;
 357         if (unlikely(rem < c)) {
 358                 persistent_ram_update(prz, s, start, rem);
 359                 s += rem;
 360                 c -= rem;
 361                 start = 0;
 362         }
 363         persistent_ram_update(prz, s, start, c);
 364
 365         persistent_ram_update_header_ecc(prz);
 366
 367         return count;
 368 }
 369
 370 int notrace persistent_ram_write_user(struct persistent_ram_zone *prz,
 371         const void __user *s, unsigned int count)
 372 {
 373         int rem, ret = 0, c = count;
 374         size_t start;
 375
 376         if (unlikely(!access_ok(VERIFY_READ, s, count)))
 377                 return -EFAULT;
 378         if (unlikely(c > prz->buffer_size)) {
 379                 s += c - prz->buffer_size;
 380                 c = prz->buffer_size;
 381         }
 382
 383         buffer_size_add(prz, c);
 384
 385         start = buffer_start_add(prz, c);
 386
 387         rem = prz->buffer_size - start;
 388         if (unlikely(rem < c)) {
 389                 ret = persistent_ram_update_user(prz, s, start, rem);
 390                 s += rem;
 391                 c -= rem;
 392                 start = 0;
 393         }
 394         if (likely(!ret))
 395                 ret = persistent_ram_update_user(prz, s, start, c);
 396
 397         persistent_ram_update_header_ecc(prz);
 398
 399         return unlikely(ret) ? ret : count;
 400 }
 401
 402 size_t persistent_ram_old_size(struct persistent_ram_zone *prz)
 403 {
 404         return prz->old_log_size;
 405 }
 406
 407 void *persistent_ram_old(struct persistent_ram_zone *prz)
 408 {
 409         return prz->old_log;
 410 }
 411
 412 void persistent_ram_free_old(struct persistent_ram_zone *prz)
 413 {
 414         kfree(prz->old_log);
 415         prz->old_log = NULL;
 416         prz->old_log_size = 0;
 417 }
 418
 419 void persistent_ram_zap(struct persistent_ram_zone *prz)
 420 {
 421         atomic_set(&prz->buffer->start, 0);
 422         atomic_set(&prz->buffer->size, 0);
 423         persistent_ram_update_header_ecc(prz);
 424 }
 425
 426 static void *persistent_ram_vmap(phys_addr_t start, size_t size,
 427                 unsigned int memtype)
 428 {
 429         struct page **pages;
 430         phys_addr_t page_start;
 431         unsigned int page_count;
 432         pgprot_t prot;
 433         unsigned int i;
 434         void *vaddr;
 435
 436         page_start = start - offset_in_page(start);
 437         page_count = DIV_ROUND_UP(size + offset_in_page(start), PAGE_SIZE);
 438
 439         if (memtype)
 440                 prot = pgprot_noncached(PAGE_KERNEL);
 441         else
 442                 prot = pgprot_writecombine(PAGE_KERNEL);
 443
 444         pages = kmalloc_array(page_count, sizeof(struct page *), GFP_KERNEL);
 445         if (!pages) {
 446                 pr_err("%s: Failed to allocate array for %u pages\n",
 447                        __func__, page_count);
 448                 return NULL;
 449         }
 450
 451         for (i = 0; i < page_count; i++) {
 452                 phys_addr_t addr = page_start + i * PAGE_SIZE;
 453                 pages[i] = pfn_to_page(addr >> PAGE_SHIFT);
 454         }
 455         vaddr = vmap(pages, page_count, VM_MAP, prot);
 456         kfree(pages);
 457
 458         return vaddr;
 459 }
 460
 461 static void *persistent_ram_iomap(phys_addr_t start, size_t size,
 462                 unsigned int memtype)
 463 {
 464         void *va;
 465
 466         if (!request_mem_region(start, size, "persistent_ram")) {
 467                 pr_err("request mem region (0x%llx@0x%llx) failed\n",
 468                         (unsigned long long)size, (unsigned long long)start);
 469                 return NULL;
 470         }
 471
 472         buffer_start_add = buffer_start_add_locked;
 473         buffer_size_add = buffer_size_add_locked;
 474
 475         if (memtype)
 476                 va = ioremap(start, size);
 477         else
 478                 va = ioremap_wc(start, size);
 479
 480         return va;
 481 }
 482
 483 static int persistent_ram_buffer_map(phys_addr_t start, phys_addr_t size,
 484                 struct persistent_ram_zone *prz, int memtype)
 485 {
 486         prz->paddr = start;
 487         prz->size = size;
 488
 489         if (pfn_valid(start >> PAGE_SHIFT))
 490                 prz->vaddr = persistent_ram_vmap(start, size, memtype);
 491         else
 492                 prz->vaddr = persistent_ram_iomap(start, size, memtype);
 493
 494         if (!prz->vaddr) {
 495                 pr_err("%s: Failed to map 0x%llx pages at 0x%llx\n", __func__,
 496                         (unsigned long long)size, (unsigned long long)start);
 497                 return -ENOMEM;
 498         }
 499
 500         prz->buffer = prz->vaddr + offset_in_page(start);
 501         prz->buffer_size = size - sizeof(struct persistent_ram_buffer);
 502
 503         return 0;
 504 }
 505
 506 static int persistent_ram_post_init(struct persistent_ram_zone *prz, u32 sig,
 507                                     struct persistent_ram_ecc_info *ecc_info)
 508 {
 509         int ret;
 510
 511         ret = persistent_ram_init_ecc(prz, ecc_info);
 512         if (ret)
 513                 return ret;
 514
 515         sig ^= PERSISTENT_RAM_SIG;
 516
 517         if (prz->buffer->sig == sig) {
 518                 if (buffer_size(prz) > prz->buffer_size ||
 519                     buffer_start(prz) > buffer_size(prz))
 520                         pr_info("found existing invalid buffer, size %zu, start %zu\n",
 521                                 buffer_size(prz), buffer_start(prz));
 522                 else {
 523                         pr_debug("found existing buffer, size %zu, start %zu\n",
 524                                  buffer_size(prz), buffer_start(prz));
 525                         persistent_ram_save_old(prz);
 526                         return 0;
 527                 }
 528         } else {
 529                 pr_debug("no valid data in buffer (sig = 0x%08x)\n",
 530                          prz->buffer->sig);
 531         }
 532
 533         prz->buffer->sig = sig;
 534         persistent_ram_zap(prz);
 535
 536         return 0;
 537 }
 538
 539 void persistent_ram_free(struct persistent_ram_zone *prz)
 540 {
 541         if (!prz)
 542                 return;
 543
 544         if (prz->vaddr) {
 545                 if (pfn_valid(prz->paddr >> PAGE_SHIFT)) {
 546                         vunmap(prz->vaddr);
 547                 } else {
 548                         iounmap(prz->vaddr);
 549                         release_mem_region(prz->paddr, prz->size);
 550                 }
 551                 prz->vaddr = NULL;
 552         }
 553         persistent_ram_free_old(prz);
 554         kfree(prz);
 555 }
 556
 557 struct persistent_ram_zone *persistent_ram_new(phys_addr_t start, size_t size,
 558                         u32 sig, struct persistent_ram_ecc_info *ecc_info,
 559                         unsigned int memtype)
 560 {
 561         struct persistent_ram_zone *prz;
 562         int ret = -ENOMEM;
 563
 564         prz = kzalloc(sizeof(struct persistent_ram_zone), GFP_KERNEL);
 565         if (!prz) {
 566                 pr_err("failed to allocate persistent ram zone\n");
 567                 goto err;
 568         }
 569
 570         ret = persistent_ram_buffer_map(start, size, prz, memtype);
 571         if (ret)
 572                 goto err;
 573
 574         ret = persistent_ram_post_init(prz, sig, ecc_info);
 575         if (ret)
 576                 goto err;
 577
 578         return prz;
 579 err:
 580         persistent_ram_free(prz);
 581         return ERR_PTR(ret);
 582 }