drivers/mtd/ubi/eba.c

   1 /*
   2  * Copyright (c) International Business Machines Corp., 2006
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
  12  * the GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  17  *
  18  * Author: Artem Bityutskiy (Битюцкий Артём)
  19  */
  20
  21 /*
  22  * The UBI Eraseblock Association (EBA) sub-system.
  23  *
  24  * This sub-system is responsible for I/O to/from logical eraseblock.
  25  *
  26  * Although in this implementation the EBA table is fully kept and managed in
  27  * RAM, which assumes poor scalability, it might be (partially) maintained on
  28  * flash in future implementations.
  29  *
  30  * The EBA sub-system implements per-logical eraseblock locking. Before
  31  * accessing a logical eraseblock it is locked for reading or writing. The
  32  * per-logical eraseblock locking is implemented by means of the lock tree. The
  33  * lock tree is an RB-tree which refers all the currently locked logical
  34  * eraseblocks. The lock tree elements are &struct ubi_ltree_entry objects.
  35  * They are indexed by (@vol_id, @lnum) pairs.
  36  *
  37  * EBA also maintains the global sequence counter which is incremented each
  38  * time a logical eraseblock is mapped to a physical eraseblock and it is
  39  * stored in the volume identifier header. This means that each VID header has
  40  * a unique sequence number. The sequence number is only increased an we assume
  41  * 64 bits is enough to never overflow.
  42  */
  43
  44 #include <linux/slab.h>
  45 #include <linux/crc32.h>
  46 #include <linux/err.h>
  47 #include "ubi.h"
  48
  49 /* Number of physical eraseblocks reserved for atomic LEB change operation */
  50 #define EBA_RESERVED_PEBS 1
  51
  52 /**
  53  * struct ubi_eba_entry - structure encoding a single LEB -> PEB association
  54  * @pnum: the physical eraseblock number attached to the LEB
  55  *
  56  * This structure is encoding a LEB -> PEB association. Note that the LEB
  57  * number is not stored here, because it is the index used to access the
  58  * entries table.
  59  */
  60 struct ubi_eba_entry {
  61         int pnum;
  62 };
  63
  64 /**
  65  * struct ubi_eba_table - LEB -> PEB association information
  66  * @entries: the LEB to PEB mapping (one entry per LEB).
  67  *
  68  * This structure is private to the EBA logic and should be kept here.
  69  * It is encoding the LEB to PEB association table, and is subject to
  70  * changes.
  71  */
  72 struct ubi_eba_table {
  73         struct ubi_eba_entry *entries;
  74 };
  75
  76 /**
  77  * next_sqnum - get next sequence number.
  78  * @ubi: UBI device description object
  79  *
  80  * This function returns next sequence number to use, which is just the current
  81  * global sequence counter value. It also increases the global sequence
  82  * counter.
  83  */
  84 unsigned long long ubi_next_sqnum(struct ubi_device *ubi)
  85 {
  86         unsigned long long sqnum;
  87
  88         spin_lock(&ubi->ltree_lock);
  89         sqnum = ubi->global_sqnum++;
  90         spin_unlock(&ubi->ltree_lock);
  91
  92         return sqnum;
  93 }
  94
  95 /**
  96  * ubi_get_compat - get compatibility flags of a volume.
  97  * @ubi: UBI device description object
  98  * @vol_id: volume ID
  99  *
 100  * This function returns compatibility flags for an internal volume. User
 101  * volumes have no compatibility flags, so %0 is returned.
 102  */
 103 static int ubi_get_compat(const struct ubi_device *ubi, int vol_id)
 104 {
 105         if (vol_id == UBI_LAYOUT_VOLUME_ID)
 106                 return UBI_LAYOUT_VOLUME_COMPAT;
 107         return 0;
 108 }
 109
 110 /**
 111  * ubi_eba_get_ldesc - get information about a LEB
 112  * @vol: volume description object
 113  * @lnum: logical eraseblock number
 114  * @ldesc: the LEB descriptor to fill
 115  *
 116  * Used to query information about a specific LEB.
 117  * It is currently only returning the physical position of the LEB, but will be
 118  * extended to provide more information.
 119  */
 120 void ubi_eba_get_ldesc(struct ubi_volume *vol, int lnum,
 121                        struct ubi_eba_leb_desc *ldesc)
 122 {
 123         ldesc->lnum = lnum;
 124         ldesc->pnum = vol->eba_tbl->entries[lnum].pnum;
 125 }
 126
 127 /**
 128  * ubi_eba_create_table - allocate a new EBA table and initialize it with all
 129  *                        LEBs unmapped
 130  * @vol: volume containing the EBA table to copy
 131  * @nentries: number of entries in the table
 132  *
 133  * Allocate a new EBA table and initialize it with all LEBs unmapped.
 134  * Returns a valid pointer if it succeed, an ERR_PTR() otherwise.
 135  */
 136 struct ubi_eba_table *ubi_eba_create_table(struct ubi_volume *vol,
 137                                            int nentries)
 138 {
 139         struct ubi_eba_table *tbl;
 140         int err = -ENOMEM;
 141         int i;
 142
 143         tbl = kzalloc(sizeof(*tbl), GFP_KERNEL);
 144         if (!tbl)
 145                 return ERR_PTR(-ENOMEM);
 146
 147         tbl->entries = kmalloc_array(nentries, sizeof(*tbl->entries),
 148                                      GFP_KERNEL);
 149         if (!tbl->entries)
 150                 goto err;
 151
 152         for (i = 0; i < nentries; i++)
 153                 tbl->entries[i].pnum = UBI_LEB_UNMAPPED;
 154
 155         return tbl;
 156
 157 err:
 158         kfree(tbl->entries);
 159         kfree(tbl);
 160
 161         return ERR_PTR(err);
 162 }
 163
 164 /**
 165  * ubi_eba_destroy_table - destroy an EBA table
 166  * @tbl: the table to destroy
 167  *
 168  * Destroy an EBA table.
 169  */
 170 void ubi_eba_destroy_table(struct ubi_eba_table *tbl)
 171 {
 172         if (!tbl)
 173                 return;
 174
 175         kfree(tbl->entries);
 176         kfree(tbl);
 177 }
 178
 179 /**
 180  * ubi_eba_copy_table - copy the EBA table attached to vol into another table
 181  * @vol: volume containing the EBA table to copy
 182  * @dst: destination
 183  * @nentries: number of entries to copy
 184  *
 185  * Copy the EBA table stored in vol into the one pointed by dst.
 186  */
 187 void ubi_eba_copy_table(struct ubi_volume *vol, struct ubi_eba_table *dst,
 188                         int nentries)
 189 {
 190         struct ubi_eba_table *src;
 191         int i;
 192
 193         ubi_assert(dst && vol && vol->eba_tbl);
 194
 195         src = vol->eba_tbl;
 196
 197         for (i = 0; i < nentries; i++)
 198                 dst->entries[i].pnum = src->entries[i].pnum;
 199 }
 200
 201 /**
 202  * ubi_eba_replace_table - assign a new EBA table to a volume
 203  * @vol: volume containing the EBA table to copy
 204  * @tbl: new EBA table
 205  *
 206  * Assign a new EBA table to the volume and release the old one.
 207  */
 208 void ubi_eba_replace_table(struct ubi_volume *vol, struct ubi_eba_table *tbl)
 209 {
 210         ubi_eba_destroy_table(vol->eba_tbl);
 211         vol->eba_tbl = tbl;
 212 }
 213
 214 /**
 215  * ltree_lookup - look up the lock tree.
 216  * @ubi: UBI device description object
 217  * @vol_id: volume ID
 218  * @lnum: logical eraseblock number
 219  *
 220  * This function returns a pointer to the corresponding &struct ubi_ltree_entry
 221  * object if the logical eraseblock is locked and %NULL if it is not.
 222  * @ubi->ltree_lock has to be locked.
 223  */
 224 static struct ubi_ltree_entry *ltree_lookup(struct ubi_device *ubi, int vol_id,
 225                                             int lnum)
 226 {
 227         struct rb_node *p;
 228
 229         p = ubi->ltree.rb_node;
 230         while (p) {
 231                 struct ubi_ltree_entry *le;
 232
 233                 le = rb_entry(p, struct ubi_ltree_entry, rb);
 234
 235                 if (vol_id < le->vol_id)
 236                         p = p->rb_left;
 237                 else if (vol_id > le->vol_id)
 238                         p = p->rb_right;
 239                 else {
 240                         if (lnum < le->lnum)
 241                                 p = p->rb_left;
 242                         else if (lnum > le->lnum)
 243                                 p = p->rb_right;
 244                         else
 245                                 return le;
 246                 }
 247         }
 248
 249         return NULL;
 250 }
 251
 252 /**
 253  * ltree_add_entry - add new entry to the lock tree.
 254  * @ubi: UBI device description object
 255  * @vol_id: volume ID
 256  * @lnum: logical eraseblock number
 257  *
 258  * This function adds new entry for logical eraseblock (@vol_id, @lnum) to the
 259  * lock tree. If such entry is already there, its usage counter is increased.
 260  * Returns pointer to the lock tree entry or %-ENOMEM if memory allocation
 261  * failed.
 262  */
 263 static struct ubi_ltree_entry *ltree_add_entry(struct ubi_device *ubi,
 264                                                int vol_id, int lnum)
 265 {
 266         struct ubi_ltree_entry *le, *le1, *le_free;
 267
 268         le = kmalloc(sizeof(struct ubi_ltree_entry), GFP_NOFS);
 269         if (!le)
 270                 return ERR_PTR(-ENOMEM);
 271
 272         le->users = 0;
 273         init_rwsem(&le->mutex);
 274         le->vol_id = vol_id;
 275         le->lnum = lnum;
 276
 277         spin_lock(&ubi->ltree_lock);
 278         le1 = ltree_lookup(ubi, vol_id, lnum);
 279
 280         if (le1) {
 281                 /*
 282                  * This logical eraseblock is already locked. The newly
 283                  * allocated lock entry is not needed.
 284                  */
 285                 le_free = le;
 286                 le = le1;
 287         } else {
 288                 struct rb_node **p, *parent = NULL;
 289
 290                 /*
 291                  * No lock entry, add the newly allocated one to the
 292                  * @ubi->ltree RB-tree.
 293                  */
 294                 le_free = NULL;
 295
 296                 p = &ubi->ltree.rb_node;
 297                 while (*p) {
 298                         parent = *p;
 299                         le1 = rb_entry(parent, struct ubi_ltree_entry, rb);
 300
 301                         if (vol_id < le1->vol_id)
 302                                 p = &(*p)->rb_left;
 303                         else if (vol_id > le1->vol_id)
 304                                 p = &(*p)->rb_right;
 305                         else {
 306                                 ubi_assert(lnum != le1->lnum);
 307                                 if (lnum < le1->lnum)
 308                                         p = &(*p)->rb_left;
 309                                 else
 310                                         p = &(*p)->rb_right;
 311                         }
 312                 }
 313
 314                 rb_link_node(&le->rb, parent, p);
 315                 rb_insert_color(&le->rb, &ubi->ltree);
 316         }
 317         le->users += 1;
 318         spin_unlock(&ubi->ltree_lock);
 319
 320         kfree(le_free);
 321         return le;
 322 }
 323
 324 /**
 325  * leb_read_lock - lock logical eraseblock for reading.
 326  * @ubi: UBI device description object
 327  * @vol_id: volume ID
 328  * @lnum: logical eraseblock number
 329  *
 330  * This function locks a logical eraseblock for reading. Returns zero in case
 331  * of success and a negative error code in case of failure.
 332  */
 333 static int leb_read_lock(struct ubi_device *ubi, int vol_id, int lnum)
 334 {
 335         struct ubi_ltree_entry *le;
 336
 337         le = ltree_add_entry(ubi, vol_id, lnum);
 338         if (IS_ERR(le))
 339                 return PTR_ERR(le);
 340         down_read(&le->mutex);
 341         return 0;
 342 }
 343
 344 /**
 345  * leb_read_unlock - unlock logical eraseblock.
 346  * @ubi: UBI device description object
 347  * @vol_id: volume ID
 348  * @lnum: logical eraseblock number
 349  */
 350 static void leb_read_unlock(struct ubi_device *ubi, int vol_id, int lnum)
 351 {
 352         struct ubi_ltree_entry *le;
 353
 354         spin_lock(&ubi->ltree_lock);
 355         le = ltree_lookup(ubi, vol_id, lnum);
 356         le->users -= 1;
 357         ubi_assert(le->users >= 0);
 358         up_read(&le->mutex);
 359         if (le->users == 0) {
 360                 rb_erase(&le->rb, &ubi->ltree);
 361                 kfree(le);
 362         }
 363         spin_unlock(&ubi->ltree_lock);
 364 }
 365
 366 /**
 367  * leb_write_lock - lock logical eraseblock for writing.
 368  * @ubi: UBI device description object
 369  * @vol_id: volume ID
 370  * @lnum: logical eraseblock number
 371  *
 372  * This function locks a logical eraseblock for writing. Returns zero in case
 373  * of success and a negative error code in case of failure.
 374  */
 375 static int leb_write_lock(struct ubi_device *ubi, int vol_id, int lnum)
 376 {
 377         struct ubi_ltree_entry *le;
 378
 379         le = ltree_add_entry(ubi, vol_id, lnum);
 380         if (IS_ERR(le))
 381                 return PTR_ERR(le);
 382         down_write(&le->mutex);
 383         return 0;
 384 }
 385
 386 /**
 387  * leb_write_trylock - try to lock logical eraseblock for writing.
 388  * @ubi: UBI device description object
 389  * @vol_id: volume ID
 390  * @lnum: logical eraseblock number
 391  *
 392  * This function locks a logical eraseblock for writing if there is no
 393  * contention and does nothing if there is contention. Returns %0 in case of
 394  * success, %1 in case of contention, and and a negative error code in case of
 395  * failure.
 396  */
 397 static int leb_write_trylock(struct ubi_device *ubi, int vol_id, int lnum)
 398 {
 399         struct ubi_ltree_entry *le;
 400
 401         le = ltree_add_entry(ubi, vol_id, lnum);
 402         if (IS_ERR(le))
 403                 return PTR_ERR(le);
 404         if (down_write_trylock(&le->mutex))
 405                 return 0;
 406
 407         /* Contention, cancel */
 408         spin_lock(&ubi->ltree_lock);
 409         le->users -= 1;
 410         ubi_assert(le->users >= 0);
 411         if (le->users == 0) {
 412                 rb_erase(&le->rb, &ubi->ltree);
 413                 kfree(le);
 414         }
 415         spin_unlock(&ubi->ltree_lock);
 416
 417         return 1;
 418 }
 419
 420 /**
 421  * leb_write_unlock - unlock logical eraseblock.
 422  * @ubi: UBI device description object
 423  * @vol_id: volume ID
 424  * @lnum: logical eraseblock number
 425  */
 426 static void leb_write_unlock(struct ubi_device *ubi, int vol_id, int lnum)
 427 {
 428         struct ubi_ltree_entry *le;
 429
 430         spin_lock(&ubi->ltree_lock);
 431         le = ltree_lookup(ubi, vol_id, lnum);
 432         le->users -= 1;
 433         ubi_assert(le->users >= 0);
 434         up_write(&le->mutex);
 435         if (le->users == 0) {
 436                 rb_erase(&le->rb, &ubi->ltree);
 437                 kfree(le);
 438         }
 439         spin_unlock(&ubi->ltree_lock);
 440 }
 441
 442 /**
 443  * ubi_eba_is_mapped - check if a LEB is mapped.
 444  * @vol: volume description object
 445  * @lnum: logical eraseblock number
 446  *
 447  * This function returns true if the LEB is mapped, false otherwise.
 448  */
 449 bool ubi_eba_is_mapped(struct ubi_volume *vol, int lnum)
 450 {
 451         return vol->eba_tbl->entries[lnum].pnum >= 0;
 452 }
 453
 454 /**
 455  * ubi_eba_unmap_leb - un-map logical eraseblock.
 456  * @ubi: UBI device description object
 457  * @vol: volume description object
 458  * @lnum: logical eraseblock number
 459  *
 460  * This function un-maps logical eraseblock @lnum and schedules corresponding
 461  * physical eraseblock for erasure. Returns zero in case of success and a
 462  * negative error code in case of failure.
 463  */
 464 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
 465                       int lnum)
 466 {
 467         int err, pnum, vol_id = vol->vol_id;
 468
 469         if (ubi->ro_mode)
 470                 return -EROFS;
 471
 472         err = leb_write_lock(ubi, vol_id, lnum);
 473         if (err)
 474                 return err;
 475
 476         pnum = vol->eba_tbl->entries[lnum].pnum;
 477         if (pnum < 0)
 478                 /* This logical eraseblock is already unmapped */
 479                 goto out_unlock;
 480
 481         dbg_eba("erase LEB %d:%d, PEB %d", vol_id, lnum, pnum);
 482
 483         down_read(&ubi->fm_eba_sem);
 484         vol->eba_tbl->entries[lnum].pnum = UBI_LEB_UNMAPPED;
 485         up_read(&ubi->fm_eba_sem);
 486         err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 0);
 487
 488 out_unlock:
 489         leb_write_unlock(ubi, vol_id, lnum);
 490         return err;
 491 }
 492
 493 #ifdef CONFIG_MTD_UBI_FASTMAP
 494 /**
 495  * check_mapping - check and fixup a mapping
 496  * @ubi: UBI device description object
 497  * @vol: volume description object
 498  * @lnum: logical eraseblock number
 499  * @pnum: physical eraseblock number
 500  *
 501  * Checks whether a given mapping is valid. Fastmap cannot track LEB unmap
 502  * operations, if such an operation is interrupted the mapping still looks
 503  * good, but upon first read an ECC is reported to the upper layer.
 504  * Normaly during the full-scan at attach time this is fixed, for Fastmap
 505  * we have to deal with it while reading.
 506  * If the PEB behind a LEB shows this symthom we change the mapping to
 507  * %UBI_LEB_UNMAPPED and schedule the PEB for erasure.
 508  *
 509  * Returns 0 on success, negative error code in case of failure.
 510  */
 511 static int check_mapping(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 512                          int *pnum)
 513 {
 514         int err;
 515         struct ubi_vid_io_buf *vidb;
 516         struct ubi_vid_hdr *vid_hdr;
 517
 518         if (!ubi->fast_attach)
 519                 return 0;
 520
 521         if (!vol->checkmap || test_bit(lnum, vol->checkmap))
 522                 return 0;
 523
 524         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
 525         if (!vidb)
 526                 return -ENOMEM;
 527
 528         err = ubi_io_read_vid_hdr(ubi, *pnum, vidb, 0);
 529         if (err > 0 && err != UBI_IO_BITFLIPS) {
 530                 int torture = 0;
 531
 532                 switch (err) {
 533                         case UBI_IO_FF:
 534                         case UBI_IO_FF_BITFLIPS:
 535                         case UBI_IO_BAD_HDR:
 536                         case UBI_IO_BAD_HDR_EBADMSG:
 537                                 break;
 538                         default:
 539                                 ubi_assert(0);
 540                 }
 541
 542                 if (err == UBI_IO_BAD_HDR_EBADMSG || err == UBI_IO_FF_BITFLIPS)
 543                         torture = 1;
 544
 545                 down_read(&ubi->fm_eba_sem);
 546                 vol->eba_tbl->entries[lnum].pnum = UBI_LEB_UNMAPPED;
 547                 up_read(&ubi->fm_eba_sem);
 548                 ubi_wl_put_peb(ubi, vol->vol_id, lnum, *pnum, torture);
 549
 550                 *pnum = UBI_LEB_UNMAPPED;
 551         } else if (err < 0) {
 552                 ubi_err(ubi, "unable to read VID header back from PEB %i: %i",
 553                         *pnum, err);
 554
 555                 goto out_free;
 556         } else {
 557                 int found_vol_id, found_lnum;
 558
 559                 ubi_assert(err == 0 || err == UBI_IO_BITFLIPS);
 560
 561                 vid_hdr = ubi_get_vid_hdr(vidb);
 562                 found_vol_id = be32_to_cpu(vid_hdr->vol_id);
 563                 found_lnum = be32_to_cpu(vid_hdr->lnum);
 564
 565                 if (found_lnum != lnum || found_vol_id != vol->vol_id) {
 566                         ubi_err(ubi, "EBA mismatch! PEB %i is LEB %i:%i instead of LEB %i:%i",
 567                                 *pnum, found_vol_id, found_lnum, vol->vol_id, lnum);
 568                         ubi_ro_mode(ubi);
 569                         err = -EINVAL;
 570                         goto out_free;
 571                 }
 572         }
 573
 574         set_bit(lnum, vol->checkmap);
 575         err = 0;
 576
 577 out_free:
 578         ubi_free_vid_buf(vidb);
 579
 580         return err;
 581 }
 582 #else
 583 static int check_mapping(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 584                   int *pnum)
 585 {
 586         return 0;
 587 }
 588 #endif
 589
 590 /**
 591  * ubi_eba_read_leb - read data.
 592  * @ubi: UBI device description object
 593  * @vol: volume description object
 594  * @lnum: logical eraseblock number
 595  * @buf: buffer to store the read data
 596  * @offset: offset from where to read
 597  * @len: how many bytes to read
 598  * @check: data CRC check flag
 599  *
 600  * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
 601  * bytes. The @check flag only makes sense for static volumes and forces
 602  * eraseblock data CRC checking.
 603  *
 604  * In case of success this function returns zero. In case of a static volume,
 605  * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
 606  * returned for any volume type if an ECC error was detected by the MTD device
 607  * driver. Other negative error cored may be returned in case of other errors.
 608  */
 609 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 610                      void *buf, int offset, int len, int check)
 611 {
 612         int err, pnum, scrub = 0, vol_id = vol->vol_id;
 613         struct ubi_vid_io_buf *vidb;
 614         struct ubi_vid_hdr *vid_hdr;
 615         uint32_t crc;
 616
 617         err = leb_read_lock(ubi, vol_id, lnum);
 618         if (err)
 619                 return err;
 620
 621         pnum = vol->eba_tbl->entries[lnum].pnum;
 622         if (pnum >= 0) {
 623                 err = check_mapping(ubi, vol, lnum, &pnum);
 624                 if (err < 0)
 625                         goto out_unlock;
 626         }
 627
 628         if (pnum == UBI_LEB_UNMAPPED) {
 629                 /*
 630                  * The logical eraseblock is not mapped, fill the whole buffer
 631                  * with 0xFF bytes. The exception is static volumes for which
 632                  * it is an error to read unmapped logical eraseblocks.
 633                  */
 634                 dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
 635                         len, offset, vol_id, lnum);
 636                 leb_read_unlock(ubi, vol_id, lnum);
 637                 ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
 638                 memset(buf, 0xFF, len);
 639                 return 0;
 640         }
 641
 642         dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
 643                 len, offset, vol_id, lnum, pnum);
 644
 645         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 646                 check = 0;
 647
 648 retry:
 649         if (check) {
 650                 vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
 651                 if (!vidb) {
 652                         err = -ENOMEM;
 653                         goto out_unlock;
 654                 }
 655
 656                 vid_hdr = ubi_get_vid_hdr(vidb);
 657
 658                 err = ubi_io_read_vid_hdr(ubi, pnum, vidb, 1);
 659                 if (err && err != UBI_IO_BITFLIPS) {
 660                         if (err > 0) {
 661                                 /*
 662                                  * The header is either absent or corrupted.
 663                                  * The former case means there is a bug -
 664                                  * switch to read-only mode just in case.
 665                                  * The latter case means a real corruption - we
 666                                  * may try to recover data. FIXME: but this is
 667                                  * not implemented.
 668                                  */
 669                                 if (err == UBI_IO_BAD_HDR_EBADMSG ||
 670                                     err == UBI_IO_BAD_HDR) {
 671                                         ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
 672                                                  pnum, vol_id, lnum);
 673                                         err = -EBADMSG;
 674                                 } else {
 675                                         /*
 676                                          * Ending up here in the non-Fastmap case
 677                                          * is a clear bug as the VID header had to
 678                                          * be present at scan time to have it referenced.
 679                                          * With fastmap the story is more complicated.
 680                                          * Fastmap has the mapping info without the need
 681                                          * of a full scan. So the LEB could have been
 682                                          * unmapped, Fastmap cannot know this and keeps
 683                                          * the LEB referenced.
 684                                          * This is valid and works as the layer above UBI
 685                                          * has to do bookkeeping about used/referenced
 686                                          * LEBs in any case.
 687                                          */
 688                                         if (ubi->fast_attach) {
 689                                                 err = -EBADMSG;
 690                                         } else {
 691                                                 err = -EINVAL;
 692                                                 ubi_ro_mode(ubi);
 693                                         }
 694                                 }
 695                         }
 696                         goto out_free;
 697                 } else if (err == UBI_IO_BITFLIPS)
 698                         scrub = 1;
 699
 700                 ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
 701                 ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
 702
 703                 crc = be32_to_cpu(vid_hdr->data_crc);
 704                 ubi_free_vid_buf(vidb);
 705         }
 706
 707         err = ubi_io_read_data(ubi, buf, pnum, offset, len);
 708         if (err) {
 709                 if (err == UBI_IO_BITFLIPS)
 710                         scrub = 1;
 711                 else if (mtd_is_eccerr(err)) {
 712                         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 713                                 goto out_unlock;
 714                         scrub = 1;
 715                         if (!check) {
 716                                 ubi_msg(ubi, "force data checking");
 717                                 check = 1;
 718                                 goto retry;
 719                         }
 720                 } else
 721                         goto out_unlock;
 722         }
 723
 724         if (check) {
 725                 uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
 726                 if (crc1 != crc) {
 727                         ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
 728                                  crc1, crc);
 729                         err = -EBADMSG;
 730                         goto out_unlock;
 731                 }
 732         }
 733
 734         if (scrub)
 735                 err = ubi_wl_scrub_peb(ubi, pnum);
 736
 737         leb_read_unlock(ubi, vol_id, lnum);
 738         return err;
 739
 740 out_free:
 741         ubi_free_vid_buf(vidb);
 742 out_unlock:
 743         leb_read_unlock(ubi, vol_id, lnum);
 744         return err;
 745 }
 746
 747 /**
 748  * ubi_eba_read_leb_sg - read data into a scatter gather list.
 749  * @ubi: UBI device description object
 750  * @vol: volume description object
 751  * @lnum: logical eraseblock number
 752  * @sgl: UBI scatter gather list to store the read data
 753  * @offset: offset from where to read
 754  * @len: how many bytes to read
 755  * @check: data CRC check flag
 756  *
 757  * This function works exactly like ubi_eba_read_leb(). But instead of
 758  * storing the read data into a buffer it writes to an UBI scatter gather
 759  * list.
 760  */
 761 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
 762                         struct ubi_sgl *sgl, int lnum, int offset, int len,
 763                         int check)
 764 {
 765         int to_read;
 766         int ret;
 767         struct scatterlist *sg;
 768
 769         for (;;) {
 770                 ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
 771                 sg = &sgl->sg[sgl->list_pos];
 772                 if (len < sg->length - sgl->page_pos)
 773                         to_read = len;
 774                 else
 775                         to_read = sg->length - sgl->page_pos;
 776
 777                 ret = ubi_eba_read_leb(ubi, vol, lnum,
 778                                        sg_virt(sg) + sgl->page_pos, offset,
 779                                        to_read, check);
 780                 if (ret < 0)
 781                         return ret;
 782
 783                 offset += to_read;
 784                 len -= to_read;
 785                 if (!len) {
 786                         sgl->page_pos += to_read;
 787                         if (sgl->page_pos == sg->length) {
 788                                 sgl->list_pos++;
 789                                 sgl->page_pos = 0;
 790                         }
 791
 792                         break;
 793                 }
 794
 795                 sgl->list_pos++;
 796                 sgl->page_pos = 0;
 797         }
 798
 799         return ret;
 800 }
 801
 802 /**
 803  * try_recover_peb - try to recover from write failure.
 804  * @vol: volume description object
 805  * @pnum: the physical eraseblock to recover
 806  * @lnum: logical eraseblock number
 807  * @buf: data which was not written because of the write failure
 808  * @offset: offset of the failed write
 809  * @len: how many bytes should have been written
 810  * @vidb: VID buffer
 811  * @retry: whether the caller should retry in case of failure
 812  *
 813  * This function is called in case of a write failure and moves all good data
 814  * from the potentially bad physical eraseblock to a good physical eraseblock.
 815  * This function also writes the data which was not written due to the failure.
 816  * Returns 0 in case of success, and a negative error code in case of failure.
 817  * In case of failure, the %retry parameter is set to false if this is a fatal
 818  * error (retrying won't help), and true otherwise.
 819  */
 820 static int try_recover_peb(struct ubi_volume *vol, int pnum, int lnum,
 821                            const void *buf, int offset, int len,
 822                            struct ubi_vid_io_buf *vidb, bool *retry)
 823 {
 824         struct ubi_device *ubi = vol->ubi;
 825         struct ubi_vid_hdr *vid_hdr;
 826         int new_pnum, err, vol_id = vol->vol_id, data_size;
 827         uint32_t crc;
 828
 829         *retry = false;
 830
 831         new_pnum = ubi_wl_get_peb(ubi);
 832         if (new_pnum < 0) {
 833                 err = new_pnum;
 834                 goto out_put;
 835         }
 836
 837         ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
 838                 pnum, new_pnum);
 839
 840         err = ubi_io_read_vid_hdr(ubi, pnum, vidb, 1);
 841         if (err && err != UBI_IO_BITFLIPS) {
 842                 if (err > 0)
 843                         err = -EIO;
 844                 goto out_put;
 845         }
 846
 847         vid_hdr = ubi_get_vid_hdr(vidb);
 848         ubi_assert(vid_hdr->vol_type == UBI_VID_DYNAMIC);
 849
 850         mutex_lock(&ubi->buf_mutex);
 851         memset(ubi->peb_buf + offset, 0xFF, len);
 852
 853         /* Read everything before the area where the write failure happened */
 854         if (offset > 0) {
 855                 err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
 856                 if (err && err != UBI_IO_BITFLIPS)
 857                         goto out_unlock;
 858         }
 859
 860         *retry = true;
 861
 862         memcpy(ubi->peb_buf + offset, buf, len);
 863
 864         data_size = offset + len;
 865         crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
 866         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 867         vid_hdr->copy_flag = 1;
 868         vid_hdr->data_size = cpu_to_be32(data_size);
 869         vid_hdr->data_crc = cpu_to_be32(crc);
 870         err = ubi_io_write_vid_hdr(ubi, new_pnum, vidb);
 871         if (err)
 872                 goto out_unlock;
 873
 874         err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
 875
 876 out_unlock:
 877         mutex_unlock(&ubi->buf_mutex);
 878
 879         if (!err)
 880                 vol->eba_tbl->entries[lnum].pnum = new_pnum;
 881
 882 out_put:
 883         up_read(&ubi->fm_eba_sem);
 884
 885         if (!err) {
 886                 ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
 887                 ubi_msg(ubi, "data was successfully recovered");
 888         } else if (new_pnum >= 0) {
 889                 /*
 890                  * Bad luck? This physical eraseblock is bad too? Crud. Let's
 891                  * try to get another one.
 892                  */
 893                 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
 894                 ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
 895         }
 896
 897         return err;
 898 }
 899
 900 /**
 901  * recover_peb - recover from write failure.
 902  * @ubi: UBI device description object
 903  * @pnum: the physical eraseblock to recover
 904  * @vol_id: volume ID
 905  * @lnum: logical eraseblock number
 906  * @buf: data which was not written because of the write failure
 907  * @offset: offset of the failed write
 908  * @len: how many bytes should have been written
 909  *
 910  * This function is called in case of a write failure and moves all good data
 911  * from the potentially bad physical eraseblock to a good physical eraseblock.
 912  * This function also writes the data which was not written due to the failure.
 913  * Returns 0 in case of success, and a negative error code in case of failure.
 914  * This function tries %UBI_IO_RETRIES before giving up.
 915  */
 916 static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
 917                        const void *buf, int offset, int len)
 918 {
 919         int err, idx = vol_id2idx(ubi, vol_id), tries;
 920         struct ubi_volume *vol = ubi->volumes[idx];
 921         struct ubi_vid_io_buf *vidb;
 922
 923         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
 924         if (!vidb)
 925                 return -ENOMEM;
 926
 927         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
 928                 bool retry;
 929
 930                 err = try_recover_peb(vol, pnum, lnum, buf, offset, len, vidb,
 931                                       &retry);
 932                 if (!err || !retry)
 933                         break;
 934
 935                 ubi_msg(ubi, "try again");
 936         }
 937
 938         ubi_free_vid_buf(vidb);
 939
 940         return err;
 941 }
 942
 943 /**
 944  * try_write_vid_and_data - try to write VID header and data to a new PEB.
 945  * @vol: volume description object
 946  * @lnum: logical eraseblock number
 947  * @vidb: the VID buffer to write
 948  * @buf: buffer containing the data
 949  * @offset: where to start writing data
 950  * @len: how many bytes should be written
 951  *
 952  * This function tries to write VID header and data belonging to logical
 953  * eraseblock @lnum of volume @vol to a new physical eraseblock. Returns zero
 954  * in case of success and a negative error code in case of failure.
 955  * In case of error, it is possible that something was still written to the
 956  * flash media, but may be some garbage.
 957  */
 958 static int try_write_vid_and_data(struct ubi_volume *vol, int lnum,
 959                                   struct ubi_vid_io_buf *vidb, const void *buf,
 960                                   int offset, int len)
 961 {
 962         struct ubi_device *ubi = vol->ubi;
 963         int pnum, opnum, err, err2, vol_id = vol->vol_id;
 964
 965         pnum = ubi_wl_get_peb(ubi);
 966         if (pnum < 0) {
 967                 err = pnum;
 968                 goto out_put;
 969         }
 970
 971         opnum = vol->eba_tbl->entries[lnum].pnum;
 972
 973         dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
 974                 len, offset, vol_id, lnum, pnum);
 975
 976         err = ubi_io_write_vid_hdr(ubi, pnum, vidb);
 977         if (err) {
 978                 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
 979                          vol_id, lnum, pnum);
 980                 goto out_put;
 981         }
 982
 983         if (len) {
 984                 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
 985                 if (err) {
 986                         ubi_warn(ubi,
 987                                  "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
 988                                  len, offset, vol_id, lnum, pnum);
 989                         goto out_put;
 990                 }
 991         }
 992
 993         vol->eba_tbl->entries[lnum].pnum = pnum;
 994
 995 out_put:
 996         up_read(&ubi->fm_eba_sem);
 997
 998         if (err && pnum >= 0) {
 999                 err2 = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
1000                 if (err2) {
1001                         ubi_warn(ubi, "failed to return physical eraseblock %d, error %d",
1002                                  pnum, err2);
1003                 }
1004         } else if (!err && opnum >= 0) {
1005                 err2 = ubi_wl_put_peb(ubi, vol_id, lnum, opnum, 0);
1006                 if (err2) {
1007                         ubi_warn(ubi, "failed to return physical eraseblock %d, error %d",
1008                                  opnum, err2);
1009                 }
1010         }
1011
1012         return err;
1013 }
1014
1015 /**
1016  * ubi_eba_write_leb - write data to dynamic volume.
1017  * @ubi: UBI device description object
1018  * @vol: volume description object
1019  * @lnum: logical eraseblock number
1020  * @buf: the data to write
1021  * @offset: offset within the logical eraseblock where to write
1022  * @len: how many bytes to write
1023  *
1024  * This function writes data to logical eraseblock @lnum of a dynamic volume
1025  * @vol. Returns zero in case of success and a negative error code in case
1026  * of failure. In case of error, it is possible that something was still
1027  * written to the flash media, but may be some garbage.
1028  * This function retries %UBI_IO_RETRIES times before giving up.
1029  */
1030 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
1031                       const void *buf, int offset, int len)
1032 {
1033         int err, pnum, tries, vol_id = vol->vol_id;
1034         struct ubi_vid_io_buf *vidb;
1035         struct ubi_vid_hdr *vid_hdr;
1036
1037         if (ubi->ro_mode)
1038                 return -EROFS;
1039
1040         err = leb_write_lock(ubi, vol_id, lnum);
1041         if (err)
1042                 return err;
1043
1044         pnum = vol->eba_tbl->entries[lnum].pnum;
1045         if (pnum >= 0) {
1046                 err = check_mapping(ubi, vol, lnum, &pnum);
1047                 if (err < 0)
1048                         goto out;
1049         }
1050
1051         if (pnum >= 0) {
1052                 dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
1053                         len, offset, vol_id, lnum, pnum);
1054
1055                 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
1056                 if (err) {
1057                         ubi_warn(ubi, "failed to write data to PEB %d", pnum);
1058                         if (err == -EIO && ubi->bad_allowed)
1059                                 err = recover_peb(ubi, pnum, vol_id, lnum, buf,
1060                                                   offset, len);
1061                 }
1062
1063                 goto out;
1064         }
1065
1066         /*
1067          * The logical eraseblock is not mapped. We have to get a free physical
1068          * eraseblock and write the volume identifier header there first.
1069          */
1070         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
1071         if (!vidb) {
1072                 leb_write_unlock(ubi, vol_id, lnum);
1073                 return -ENOMEM;
1074         }
1075
1076         vid_hdr = ubi_get_vid_hdr(vidb);
1077
1078         vid_hdr->vol_type = UBI_VID_DYNAMIC;
1079         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1080         vid_hdr->vol_id = cpu_to_be32(vol_id);
1081         vid_hdr->lnum = cpu_to_be32(lnum);
1082         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
1083         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
1084
1085         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1086                 err = try_write_vid_and_data(vol, lnum, vidb, buf, offset, len);
1087                 if (err != -EIO || !ubi->bad_allowed)
1088                         break;
1089
1090                 /*
1091                  * Fortunately, this is the first write operation to this
1092                  * physical eraseblock, so just put it and request a new one.
1093                  * We assume that if this physical eraseblock went bad, the
1094                  * erase code will handle that.
1095                  */
1096                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1097                 ubi_msg(ubi, "try another PEB");
1098         }
1099
1100         ubi_free_vid_buf(vidb);
1101
1102 out:
1103         if (err)
1104                 ubi_ro_mode(ubi);
1105
1106         leb_write_unlock(ubi, vol_id, lnum);
1107
1108         return err;
1109 }
1110
1111 /**
1112  * ubi_eba_write_leb_st - write data to static volume.
1113  * @ubi: UBI device description object
1114  * @vol: volume description object
1115  * @lnum: logical eraseblock number
1116  * @buf: data to write
1117  * @len: how many bytes to write
1118  * @used_ebs: how many logical eraseblocks will this volume contain
1119  *
1120  * This function writes data to logical eraseblock @lnum of static volume
1121  * @vol. The @used_ebs argument should contain total number of logical
1122  * eraseblock in this static volume.
1123  *
1124  * When writing to the last logical eraseblock, the @len argument doesn't have
1125  * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
1126  * to the real data size, although the @buf buffer has to contain the
1127  * alignment. In all other cases, @len has to be aligned.
1128  *
1129  * It is prohibited to write more than once to logical eraseblocks of static
1130  * volumes. This function returns zero in case of success and a negative error
1131  * code in case of failure.
1132  */
1133 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
1134                          int lnum, const void *buf, int len, int used_ebs)
1135 {
1136         int err, tries, data_size = len, vol_id = vol->vol_id;
1137         struct ubi_vid_io_buf *vidb;
1138         struct ubi_vid_hdr *vid_hdr;
1139         uint32_t crc;
1140
1141         if (ubi->ro_mode)
1142                 return -EROFS;
1143
1144         if (lnum == used_ebs - 1)
1145                 /* If this is the last LEB @len may be unaligned */
1146                 len = ALIGN(data_size, ubi->min_io_size);
1147         else
1148                 ubi_assert(!(len & (ubi->min_io_size - 1)));
1149
1150         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
1151         if (!vidb)
1152                 return -ENOMEM;
1153
1154         vid_hdr = ubi_get_vid_hdr(vidb);
1155
1156         err = leb_write_lock(ubi, vol_id, lnum);
1157         if (err)
1158                 goto out;
1159
1160         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1161         vid_hdr->vol_id = cpu_to_be32(vol_id);
1162         vid_hdr->lnum = cpu_to_be32(lnum);
1163         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
1164         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
1165
1166         crc = crc32(UBI_CRC32_INIT, buf, data_size);
1167         vid_hdr->vol_type = UBI_VID_STATIC;
1168         vid_hdr->data_size = cpu_to_be32(data_size);
1169         vid_hdr->used_ebs = cpu_to_be32(used_ebs);
1170         vid_hdr->data_crc = cpu_to_be32(crc);
1171
1172         ubi_assert(vol->eba_tbl->entries[lnum].pnum < 0);
1173
1174         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1175                 err = try_write_vid_and_data(vol, lnum, vidb, buf, 0, len);
1176                 if (err != -EIO || !ubi->bad_allowed)
1177                         break;
1178
1179                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1180                 ubi_msg(ubi, "try another PEB");
1181         }
1182
1183         if (err)
1184                 ubi_ro_mode(ubi);
1185
1186         leb_write_unlock(ubi, vol_id, lnum);
1187
1188 out:
1189         ubi_free_vid_buf(vidb);
1190
1191         return err;
1192 }
1193
1194 /*
1195  * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
1196  * @ubi: UBI device description object
1197  * @vol: volume description object
1198  * @lnum: logical eraseblock number
1199  * @buf: data to write
1200  * @len: how many bytes to write
1201  *
1202  * This function changes the contents of a logical eraseblock atomically. @buf
1203  * has to contain new logical eraseblock data, and @len - the length of the
1204  * data, which has to be aligned. This function guarantees that in case of an
1205  * unclean reboot the old contents is preserved. Returns zero in case of
1206  * success and a negative error code in case of failure.
1207  *
1208  * UBI reserves one LEB for the "atomic LEB change" operation, so only one
1209  * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
1210  */
1211 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
1212                               int lnum, const void *buf, int len)
1213 {
1214         int err, tries, vol_id = vol->vol_id;
1215         struct ubi_vid_io_buf *vidb;
1216         struct ubi_vid_hdr *vid_hdr;
1217         uint32_t crc;
1218
1219         if (ubi->ro_mode)
1220                 return -EROFS;
1221
1222         if (len == 0) {
1223                 /*
1224                  * Special case when data length is zero. In this case the LEB
1225                  * has to be unmapped and mapped somewhere else.
1226                  */
1227                 err = ubi_eba_unmap_leb(ubi, vol, lnum);
1228                 if (err)
1229                         return err;
1230                 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
1231         }
1232
1233         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
1234         if (!vidb)
1235                 return -ENOMEM;
1236
1237         vid_hdr = ubi_get_vid_hdr(vidb);
1238
1239         mutex_lock(&ubi->alc_mutex);
1240         err = leb_write_lock(ubi, vol_id, lnum);
1241         if (err)
1242                 goto out_mutex;
1243
1244         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1245         vid_hdr->vol_id = cpu_to_be32(vol_id);
1246         vid_hdr->lnum = cpu_to_be32(lnum);
1247         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
1248         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
1249
1250         crc = crc32(UBI_CRC32_INIT, buf, len);
1251         vid_hdr->vol_type = UBI_VID_DYNAMIC;
1252         vid_hdr->data_size = cpu_to_be32(len);
1253         vid_hdr->copy_flag = 1;
1254         vid_hdr->data_crc = cpu_to_be32(crc);
1255
1256         dbg_eba("change LEB %d:%d", vol_id, lnum);
1257
1258         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1259                 err = try_write_vid_and_data(vol, lnum, vidb, buf, 0, len);
1260                 if (err != -EIO || !ubi->bad_allowed)
1261                         break;
1262
1263                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1264                 ubi_msg(ubi, "try another PEB");
1265         }
1266
1267         /*
1268          * This flash device does not admit of bad eraseblocks or
1269          * something nasty and unexpected happened. Switch to read-only
1270          * mode just in case.
1271          */
1272         if (err)
1273                 ubi_ro_mode(ubi);
1274
1275         leb_write_unlock(ubi, vol_id, lnum);
1276
1277 out_mutex:
1278         mutex_unlock(&ubi->alc_mutex);
1279         ubi_free_vid_buf(vidb);
1280         return err;
1281 }
1282
1283 /**
1284  * is_error_sane - check whether a read error is sane.
1285  * @err: code of the error happened during reading
1286  *
1287  * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1288  * cannot read data from the target PEB (an error @err happened). If the error
1289  * code is sane, then we treat this error as non-fatal. Otherwise the error is
1290  * fatal and UBI will be switched to R/O mode later.
1291  *
1292  * The idea is that we try not to switch to R/O mode if the read error is
1293  * something which suggests there was a real read problem. E.g., %-EIO. Or a
1294  * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1295  * mode, simply because we do not know what happened at the MTD level, and we
1296  * cannot handle this. E.g., the underlying driver may have become crazy, and
1297  * it is safer to switch to R/O mode to preserve the data.
1298  *
1299  * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1300  * which we have just written.
1301  */
1302 static int is_error_sane(int err)
1303 {
1304         if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
1305             err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
1306                 return 0;
1307         return 1;
1308 }
1309
1310 /**
1311  * ubi_eba_copy_leb - copy logical eraseblock.
1312  * @ubi: UBI device description object
1313  * @from: physical eraseblock number from where to copy
1314  * @to: physical eraseblock number where to copy
1315  * @vid_hdr: VID header of the @from physical eraseblock
1316  *
1317  * This function copies logical eraseblock from physical eraseblock @from to
1318  * physical eraseblock @to. The @vid_hdr buffer may be changed by this
1319  * function. Returns:
1320  *   o %0 in case of success;
1321  *   o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
1322  *   o a negative error code in case of failure.
1323  */
1324 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1325                      struct ubi_vid_io_buf *vidb)
1326 {
1327         int err, vol_id, lnum, data_size, aldata_size, idx;
1328         struct ubi_vid_hdr *vid_hdr = ubi_get_vid_hdr(vidb);
1329         struct ubi_volume *vol;
1330         uint32_t crc;
1331
1332         ubi_assert(rwsem_is_locked(&ubi->fm_eba_sem));
1333
1334         vol_id = be32_to_cpu(vid_hdr->vol_id);
1335         lnum = be32_to_cpu(vid_hdr->lnum);
1336
1337         dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
1338
1339         if (vid_hdr->vol_type == UBI_VID_STATIC) {
1340                 data_size = be32_to_cpu(vid_hdr->data_size);
1341                 aldata_size = ALIGN(data_size, ubi->min_io_size);
1342         } else
1343                 data_size = aldata_size =
1344                             ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
1345
1346         idx = vol_id2idx(ubi, vol_id);
1347         spin_lock(&ubi->volumes_lock);
1348         /*
1349          * Note, we may race with volume deletion, which means that the volume
1350          * this logical eraseblock belongs to might be being deleted. Since the
1351          * volume deletion un-maps all the volume's logical eraseblocks, it will
1352          * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1353          */
1354         vol = ubi->volumes[idx];
1355         spin_unlock(&ubi->volumes_lock);
1356         if (!vol) {
1357                 /* No need to do further work, cancel */
1358                 dbg_wl("volume %d is being removed, cancel", vol_id);
1359                 return MOVE_CANCEL_RACE;
1360         }
1361
1362         /*
1363          * We do not want anybody to write to this logical eraseblock while we
1364          * are moving it, so lock it.
1365          *
1366          * Note, we are using non-waiting locking here, because we cannot sleep
1367          * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1368          * unmapping the LEB which is mapped to the PEB we are going to move
1369          * (@from). This task locks the LEB and goes sleep in the
1370          * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1371          * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
1372          * LEB is already locked, we just do not move it and return
1373          * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1374          * we do not know the reasons of the contention - it may be just a
1375          * normal I/O on this LEB, so we want to re-try.
1376          */
1377         err = leb_write_trylock(ubi, vol_id, lnum);
1378         if (err) {
1379                 dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
1380                 return MOVE_RETRY;
1381         }
1382
1383         /*
1384          * The LEB might have been put meanwhile, and the task which put it is
1385          * probably waiting on @ubi->move_mutex. No need to continue the work,
1386          * cancel it.
1387          */
1388         if (vol->eba_tbl->entries[lnum].pnum != from) {
1389                 dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1390                        vol_id, lnum, from, vol->eba_tbl->entries[lnum].pnum);
1391                 err = MOVE_CANCEL_RACE;
1392                 goto out_unlock_leb;
1393         }
1394
1395         /*
1396          * OK, now the LEB is locked and we can safely start moving it. Since
1397          * this function utilizes the @ubi->peb_buf buffer which is shared
1398          * with some other functions - we lock the buffer by taking the
1399          * @ubi->buf_mutex.
1400          */
1401         mutex_lock(&ubi->buf_mutex);
1402         dbg_wl("read %d bytes of data", aldata_size);
1403         err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
1404         if (err && err != UBI_IO_BITFLIPS) {
1405                 ubi_warn(ubi, "error %d while reading data from PEB %d",
1406                          err, from);
1407                 err = MOVE_SOURCE_RD_ERR;
1408                 goto out_unlock_buf;
1409         }
1410
1411         /*
1412          * Now we have got to calculate how much data we have to copy. In
1413          * case of a static volume it is fairly easy - the VID header contains
1414          * the data size. In case of a dynamic volume it is more difficult - we
1415          * have to read the contents, cut 0xFF bytes from the end and copy only
1416          * the first part. We must do this to avoid writing 0xFF bytes as it
1417          * may have some side-effects. And not only this. It is important not
1418          * to include those 0xFFs to CRC because later the they may be filled
1419          * by data.
1420          */
1421         if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1422                 aldata_size = data_size =
1423                         ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
1424
1425         cond_resched();
1426         crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
1427         cond_resched();
1428
1429         /*
1430          * It may turn out to be that the whole @from physical eraseblock
1431          * contains only 0xFF bytes. Then we have to only write the VID header
1432          * and do not write any data. This also means we should not set
1433          * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1434          */
1435         if (data_size > 0) {
1436                 vid_hdr->copy_flag = 1;
1437                 vid_hdr->data_size = cpu_to_be32(data_size);
1438                 vid_hdr->data_crc = cpu_to_be32(crc);
1439         }
1440         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1441
1442         err = ubi_io_write_vid_hdr(ubi, to, vidb);
1443         if (err) {
1444                 if (err == -EIO)
1445                         err = MOVE_TARGET_WR_ERR;
1446                 goto out_unlock_buf;
1447         }
1448
1449         cond_resched();
1450
1451         /* Read the VID header back and check if it was written correctly */
1452         err = ubi_io_read_vid_hdr(ubi, to, vidb, 1);
1453         if (err) {
1454                 if (err != UBI_IO_BITFLIPS) {
1455                         ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
1456                                  err, to);
1457                         if (is_error_sane(err))
1458                                 err = MOVE_TARGET_RD_ERR;
1459                 } else
1460                         err = MOVE_TARGET_BITFLIPS;
1461                 goto out_unlock_buf;
1462         }
1463
1464         if (data_size > 0) {
1465                 err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1466                 if (err) {
1467                         if (err == -EIO)
1468                                 err = MOVE_TARGET_WR_ERR;
1469                         goto out_unlock_buf;
1470                 }
1471
1472                 cond_resched();
1473         }
1474
1475         ubi_assert(vol->eba_tbl->entries[lnum].pnum == from);
1476         vol->eba_tbl->entries[lnum].pnum = to;
1477
1478 out_unlock_buf:
1479         mutex_unlock(&ubi->buf_mutex);
1480 out_unlock_leb:
1481         leb_write_unlock(ubi, vol_id, lnum);
1482         return err;
1483 }
1484
1485 /**
1486  * print_rsvd_warning - warn about not having enough reserved PEBs.
1487  * @ubi: UBI device description object
1488  *
1489  * This is a helper function for 'ubi_eba_init()' which is called when UBI
1490  * cannot reserve enough PEBs for bad block handling. This function makes a
1491  * decision whether we have to print a warning or not. The algorithm is as
1492  * follows:
1493  *   o if this is a new UBI image, then just print the warning
1494  *   o if this is an UBI image which has already been used for some time, print
1495  *     a warning only if we can reserve less than 10% of the expected amount of
1496  *     the reserved PEB.
1497  *
1498  * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1499  * of PEBs becomes smaller, which is normal and we do not want to scare users
1500  * with a warning every time they attach the MTD device. This was an issue
1501  * reported by real users.
1502  */
1503 static void print_rsvd_warning(struct ubi_device *ubi,
1504                                struct ubi_attach_info *ai)
1505 {
1506         /*
1507          * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1508          * large number to distinguish between newly flashed and used images.
1509          */
1510         if (ai->max_sqnum > (1 << 18)) {
1511                 int min = ubi->beb_rsvd_level / 10;
1512
1513                 if (!min)
1514                         min = 1;
1515                 if (ubi->beb_rsvd_pebs > min)
1516                         return;
1517         }
1518
1519         ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
1520                  ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
1521         if (ubi->corr_peb_count)
1522                 ubi_warn(ubi, "%d PEBs are corrupted and not used",
1523                          ubi->corr_peb_count);
1524 }
1525
1526 /**
1527  * self_check_eba - run a self check on the EBA table constructed by fastmap.
1528  * @ubi: UBI device description object
1529  * @ai_fastmap: UBI attach info object created by fastmap
1530  * @ai_scan: UBI attach info object created by scanning
1531  *
1532  * Returns < 0 in case of an internal error, 0 otherwise.
1533  * If a bad EBA table entry was found it will be printed out and
1534  * ubi_assert() triggers.
1535  */
1536 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1537                    struct ubi_attach_info *ai_scan)
1538 {
1539         int i, j, num_volumes, ret = 0;
1540         int **scan_eba, **fm_eba;
1541         struct ubi_ainf_volume *av;
1542         struct ubi_volume *vol;
1543         struct ubi_ainf_peb *aeb;
1544         struct rb_node *rb;
1545
1546         num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1547
1548         scan_eba = kmalloc_array(num_volumes, sizeof(*scan_eba), GFP_KERNEL);
1549         if (!scan_eba)
1550                 return -ENOMEM;
1551
1552         fm_eba = kmalloc_array(num_volumes, sizeof(*fm_eba), GFP_KERNEL);
1553         if (!fm_eba) {
1554                 kfree(scan_eba);
1555                 return -ENOMEM;
1556         }
1557
1558         for (i = 0; i < num_volumes; i++) {
1559                 vol = ubi->volumes[i];
1560                 if (!vol)
1561                         continue;
1562
1563                 scan_eba[i] = kmalloc_array(vol->reserved_pebs,
1564                                             sizeof(**scan_eba),
1565                                             GFP_KERNEL);
1566                 if (!scan_eba[i]) {
1567                         ret = -ENOMEM;
1568                         goto out_free;
1569                 }
1570
1571                 fm_eba[i] = kmalloc_array(vol->reserved_pebs,
1572                                           sizeof(**fm_eba),
1573                                           GFP_KERNEL);
1574                 if (!fm_eba[i]) {
1575                         ret = -ENOMEM;
1576                         goto out_free;
1577                 }
1578
1579                 for (j = 0; j < vol->reserved_pebs; j++)
1580                         scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1581
1582                 av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1583                 if (!av)
1584                         continue;
1585
1586                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1587                         scan_eba[i][aeb->lnum] = aeb->pnum;
1588
1589                 av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1590                 if (!av)
1591                         continue;
1592
1593                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1594                         fm_eba[i][aeb->lnum] = aeb->pnum;
1595
1596                 for (j = 0; j < vol->reserved_pebs; j++) {
1597                         if (scan_eba[i][j] != fm_eba[i][j]) {
1598                                 if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1599                                         fm_eba[i][j] == UBI_LEB_UNMAPPED)
1600                                         continue;
1601
1602                                 ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
1603                                         vol->vol_id, j, fm_eba[i][j],
1604                                         scan_eba[i][j]);
1605                                 ubi_assert(0);
1606                         }
1607                 }
1608         }
1609
1610 out_free:
1611         for (i = 0; i < num_volumes; i++) {
1612                 if (!ubi->volumes[i])
1613                         continue;
1614
1615                 kfree(scan_eba[i]);
1616                 kfree(fm_eba[i]);
1617         }
1618
1619         kfree(scan_eba);
1620         kfree(fm_eba);
1621         return ret;
1622 }
1623
1624 /**
1625  * ubi_eba_init - initialize the EBA sub-system using attaching information.
1626  * @ubi: UBI device description object
1627  * @ai: attaching information
1628  *
1629  * This function returns zero in case of success and a negative error code in
1630  * case of failure.
1631  */
1632 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
1633 {
1634         int i, err, num_volumes;
1635         struct ubi_ainf_volume *av;
1636         struct ubi_volume *vol;
1637         struct ubi_ainf_peb *aeb;
1638         struct rb_node *rb;
1639
1640         dbg_eba("initialize EBA sub-system");
1641
1642         spin_lock_init(&ubi->ltree_lock);
1643         mutex_init(&ubi->alc_mutex);
1644         ubi->ltree = RB_ROOT;
1645
1646         ubi->global_sqnum = ai->max_sqnum + 1;
1647         num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1648
1649         for (i = 0; i < num_volumes; i++) {
1650                 struct ubi_eba_table *tbl;
1651
1652                 vol = ubi->volumes[i];
1653                 if (!vol)
1654                         continue;
1655
1656                 cond_resched();
1657
1658                 tbl = ubi_eba_create_table(vol, vol->reserved_pebs);
1659                 if (IS_ERR(tbl)) {
1660                         err = PTR_ERR(tbl);
1661                         goto out_free;
1662                 }
1663
1664                 ubi_eba_replace_table(vol, tbl);
1665
1666                 av = ubi_find_av(ai, idx2vol_id(ubi, i));
1667                 if (!av)
1668                         continue;
1669
1670                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
1671                         if (aeb->lnum >= vol->reserved_pebs) {
1672                                 /*
1673                                  * This may happen in case of an unclean reboot
1674                                  * during re-size.
1675                                  */
1676                                 ubi_move_aeb_to_list(av, aeb, &ai->erase);
1677                         } else {
1678                                 struct ubi_eba_entry *entry;
1679
1680                                 entry = &vol->eba_tbl->entries[aeb->lnum];
1681                                 entry->pnum = aeb->pnum;
1682                         }
1683                 }
1684         }
1685
1686         if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
1687                 ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
1688                         ubi->avail_pebs, EBA_RESERVED_PEBS);
1689                 if (ubi->corr_peb_count)
1690                         ubi_err(ubi, "%d PEBs are corrupted and not used",
1691                                 ubi->corr_peb_count);
1692                 err = -ENOSPC;
1693                 goto out_free;
1694         }
1695         ubi->avail_pebs -= EBA_RESERVED_PEBS;
1696         ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1697
1698         if (ubi->bad_allowed) {
1699                 ubi_calculate_reserved(ubi);
1700
1701                 if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1702                         /* No enough free physical eraseblocks */
1703                         ubi->beb_rsvd_pebs = ubi->avail_pebs;
1704                         print_rsvd_warning(ubi, ai);
1705                 } else
1706                         ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1707
1708                 ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1709                 ubi->rsvd_pebs  += ubi->beb_rsvd_pebs;
1710         }
1711
1712         dbg_eba("EBA sub-system is initialized");
1713         return 0;
1714
1715 out_free:
1716         for (i = 0; i < num_volumes; i++) {
1717                 if (!ubi->volumes[i])
1718                         continue;
1719                 ubi_eba_replace_table(ubi->volumes[i], NULL);
1720         }
1721         return err;
1722 }