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_lock - 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
 517         if (!ubi->fast_attach)
 518                 return 0;
 519
 520         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
 521         if (!vidb)
 522                 return -ENOMEM;
 523
 524         err = ubi_io_read_vid_hdr(ubi, *pnum, vidb, 0);
 525         if (err > 0 && err != UBI_IO_BITFLIPS) {
 526                 int torture = 0;
 527
 528                 switch (err) {
 529                         case UBI_IO_FF:
 530                         case UBI_IO_FF_BITFLIPS:
 531                         case UBI_IO_BAD_HDR:
 532                         case UBI_IO_BAD_HDR_EBADMSG:
 533                                 break;
 534                         default:
 535                                 ubi_assert(0);
 536                 }
 537
 538                 if (err == UBI_IO_BAD_HDR_EBADMSG || err == UBI_IO_FF_BITFLIPS)
 539                         torture = 1;
 540
 541                 down_read(&ubi->fm_eba_sem);
 542                 vol->eba_tbl->entries[lnum].pnum = UBI_LEB_UNMAPPED;
 543                 up_read(&ubi->fm_eba_sem);
 544                 ubi_wl_put_peb(ubi, vol->vol_id, lnum, *pnum, torture);
 545
 546                 *pnum = UBI_LEB_UNMAPPED;
 547         } else if (err < 0) {
 548                 ubi_err(ubi, "unable to read VID header back from PEB %i: %i",
 549                         *pnum, err);
 550
 551                 goto out_free;
 552         }
 553
 554         err = 0;
 555
 556 out_free:
 557         ubi_free_vid_buf(vidb);
 558
 559         return err;
 560 }
 561 #else
 562 static int check_mapping(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 563                   int *pnum)
 564 {
 565         return 0;
 566 }
 567 #endif
 568
 569 /**
 570  * ubi_eba_read_leb - read data.
 571  * @ubi: UBI device description object
 572  * @vol: volume description object
 573  * @lnum: logical eraseblock number
 574  * @buf: buffer to store the read data
 575  * @offset: offset from where to read
 576  * @len: how many bytes to read
 577  * @check: data CRC check flag
 578  *
 579  * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
 580  * bytes. The @check flag only makes sense for static volumes and forces
 581  * eraseblock data CRC checking.
 582  *
 583  * In case of success this function returns zero. In case of a static volume,
 584  * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
 585  * returned for any volume type if an ECC error was detected by the MTD device
 586  * driver. Other negative error cored may be returned in case of other errors.
 587  */
 588 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 589                      void *buf, int offset, int len, int check)
 590 {
 591         int err, pnum, scrub = 0, vol_id = vol->vol_id;
 592         struct ubi_vid_io_buf *vidb;
 593         struct ubi_vid_hdr *vid_hdr;
 594         uint32_t uninitialized_var(crc);
 595
 596         err = leb_read_lock(ubi, vol_id, lnum);
 597         if (err)
 598                 return err;
 599
 600         pnum = vol->eba_tbl->entries[lnum].pnum;
 601         if (pnum >= 0) {
 602                 err = check_mapping(ubi, vol, lnum, &pnum);
 603                 if (err < 0)
 604                         goto out_unlock;
 605         }
 606
 607         if (pnum == UBI_LEB_UNMAPPED) {
 608                 /*
 609                  * The logical eraseblock is not mapped, fill the whole buffer
 610                  * with 0xFF bytes. The exception is static volumes for which
 611                  * it is an error to read unmapped logical eraseblocks.
 612                  */
 613                 dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
 614                         len, offset, vol_id, lnum);
 615                 leb_read_unlock(ubi, vol_id, lnum);
 616                 ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
 617                 memset(buf, 0xFF, len);
 618                 return 0;
 619         }
 620
 621         dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
 622                 len, offset, vol_id, lnum, pnum);
 623
 624         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 625                 check = 0;
 626
 627 retry:
 628         if (check) {
 629                 vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
 630                 if (!vidb) {
 631                         err = -ENOMEM;
 632                         goto out_unlock;
 633                 }
 634
 635                 vid_hdr = ubi_get_vid_hdr(vidb);
 636
 637                 err = ubi_io_read_vid_hdr(ubi, pnum, vidb, 1);
 638                 if (err && err != UBI_IO_BITFLIPS) {
 639                         if (err > 0) {
 640                                 /*
 641                                  * The header is either absent or corrupted.
 642                                  * The former case means there is a bug -
 643                                  * switch to read-only mode just in case.
 644                                  * The latter case means a real corruption - we
 645                                  * may try to recover data. FIXME: but this is
 646                                  * not implemented.
 647                                  */
 648                                 if (err == UBI_IO_BAD_HDR_EBADMSG ||
 649                                     err == UBI_IO_BAD_HDR) {
 650                                         ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
 651                                                  pnum, vol_id, lnum);
 652                                         err = -EBADMSG;
 653                                 } else {
 654                                         /*
 655                                          * Ending up here in the non-Fastmap case
 656                                          * is a clear bug as the VID header had to
 657                                          * be present at scan time to have it referenced.
 658                                          * With fastmap the story is more complicated.
 659                                          * Fastmap has the mapping info without the need
 660                                          * of a full scan. So the LEB could have been
 661                                          * unmapped, Fastmap cannot know this and keeps
 662                                          * the LEB referenced.
 663                                          * This is valid and works as the layer above UBI
 664                                          * has to do bookkeeping about used/referenced
 665                                          * LEBs in any case.
 666                                          */
 667                                         if (ubi->fast_attach) {
 668                                                 err = -EBADMSG;
 669                                         } else {
 670                                                 err = -EINVAL;
 671                                                 ubi_ro_mode(ubi);
 672                                         }
 673                                 }
 674                         }
 675                         goto out_free;
 676                 } else if (err == UBI_IO_BITFLIPS)
 677                         scrub = 1;
 678
 679                 ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
 680                 ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
 681
 682                 crc = be32_to_cpu(vid_hdr->data_crc);
 683                 ubi_free_vid_buf(vidb);
 684         }
 685
 686         err = ubi_io_read_data(ubi, buf, pnum, offset, len);
 687         if (err) {
 688                 if (err == UBI_IO_BITFLIPS)
 689                         scrub = 1;
 690                 else if (mtd_is_eccerr(err)) {
 691                         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 692                                 goto out_unlock;
 693                         scrub = 1;
 694                         if (!check) {
 695                                 ubi_msg(ubi, "force data checking");
 696                                 check = 1;
 697                                 goto retry;
 698                         }
 699                 } else
 700                         goto out_unlock;
 701         }
 702
 703         if (check) {
 704                 uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
 705                 if (crc1 != crc) {
 706                         ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
 707                                  crc1, crc);
 708                         err = -EBADMSG;
 709                         goto out_unlock;
 710                 }
 711         }
 712
 713         if (scrub)
 714                 err = ubi_wl_scrub_peb(ubi, pnum);
 715
 716         leb_read_unlock(ubi, vol_id, lnum);
 717         return err;
 718
 719 out_free:
 720         ubi_free_vid_buf(vidb);
 721 out_unlock:
 722         leb_read_unlock(ubi, vol_id, lnum);
 723         return err;
 724 }
 725
 726 /**
 727  * ubi_eba_read_leb_sg - read data into a scatter gather list.
 728  * @ubi: UBI device description object
 729  * @vol: volume description object
 730  * @lnum: logical eraseblock number
 731  * @sgl: UBI scatter gather list to store the read data
 732  * @offset: offset from where to read
 733  * @len: how many bytes to read
 734  * @check: data CRC check flag
 735  *
 736  * This function works exactly like ubi_eba_read_leb(). But instead of
 737  * storing the read data into a buffer it writes to an UBI scatter gather
 738  * list.
 739  */
 740 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
 741                         struct ubi_sgl *sgl, int lnum, int offset, int len,
 742                         int check)
 743 {
 744         int to_read;
 745         int ret;
 746         struct scatterlist *sg;
 747
 748         for (;;) {
 749                 ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
 750                 sg = &sgl->sg[sgl->list_pos];
 751                 if (len < sg->length - sgl->page_pos)
 752                         to_read = len;
 753                 else
 754                         to_read = sg->length - sgl->page_pos;
 755
 756                 ret = ubi_eba_read_leb(ubi, vol, lnum,
 757                                        sg_virt(sg) + sgl->page_pos, offset,
 758                                        to_read, check);
 759                 if (ret < 0)
 760                         return ret;
 761
 762                 offset += to_read;
 763                 len -= to_read;
 764                 if (!len) {
 765                         sgl->page_pos += to_read;
 766                         if (sgl->page_pos == sg->length) {
 767                                 sgl->list_pos++;
 768                                 sgl->page_pos = 0;
 769                         }
 770
 771                         break;
 772                 }
 773
 774                 sgl->list_pos++;
 775                 sgl->page_pos = 0;
 776         }
 777
 778         return ret;
 779 }
 780
 781 /**
 782  * try_recover_peb - try to recover from write failure.
 783  * @vol: volume description object
 784  * @pnum: the physical eraseblock to recover
 785  * @lnum: logical eraseblock number
 786  * @buf: data which was not written because of the write failure
 787  * @offset: offset of the failed write
 788  * @len: how many bytes should have been written
 789  * @vidb: VID buffer
 790  * @retry: whether the caller should retry in case of failure
 791  *
 792  * This function is called in case of a write failure and moves all good data
 793  * from the potentially bad physical eraseblock to a good physical eraseblock.
 794  * This function also writes the data which was not written due to the failure.
 795  * Returns 0 in case of success, and a negative error code in case of failure.
 796  * In case of failure, the %retry parameter is set to false if this is a fatal
 797  * error (retrying won't help), and true otherwise.
 798  */
 799 static int try_recover_peb(struct ubi_volume *vol, int pnum, int lnum,
 800                            const void *buf, int offset, int len,
 801                            struct ubi_vid_io_buf *vidb, bool *retry)
 802 {
 803         struct ubi_device *ubi = vol->ubi;
 804         struct ubi_vid_hdr *vid_hdr;
 805         int new_pnum, err, vol_id = vol->vol_id, data_size;
 806         uint32_t crc;
 807
 808         *retry = false;
 809
 810         new_pnum = ubi_wl_get_peb(ubi);
 811         if (new_pnum < 0) {
 812                 err = new_pnum;
 813                 goto out_put;
 814         }
 815
 816         ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
 817                 pnum, new_pnum);
 818
 819         err = ubi_io_read_vid_hdr(ubi, pnum, vidb, 1);
 820         if (err && err != UBI_IO_BITFLIPS) {
 821                 if (err > 0)
 822                         err = -EIO;
 823                 goto out_put;
 824         }
 825
 826         vid_hdr = ubi_get_vid_hdr(vidb);
 827         ubi_assert(vid_hdr->vol_type == UBI_VID_DYNAMIC);
 828
 829         mutex_lock(&ubi->buf_mutex);
 830         memset(ubi->peb_buf + offset, 0xFF, len);
 831
 832         /* Read everything before the area where the write failure happened */
 833         if (offset > 0) {
 834                 err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
 835                 if (err && err != UBI_IO_BITFLIPS)
 836                         goto out_unlock;
 837         }
 838
 839         *retry = true;
 840
 841         memcpy(ubi->peb_buf + offset, buf, len);
 842
 843         data_size = offset + len;
 844         crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
 845         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 846         vid_hdr->copy_flag = 1;
 847         vid_hdr->data_size = cpu_to_be32(data_size);
 848         vid_hdr->data_crc = cpu_to_be32(crc);
 849         err = ubi_io_write_vid_hdr(ubi, new_pnum, vidb);
 850         if (err)
 851                 goto out_unlock;
 852
 853         err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
 854
 855 out_unlock:
 856         mutex_unlock(&ubi->buf_mutex);
 857
 858         if (!err)
 859                 vol->eba_tbl->entries[lnum].pnum = new_pnum;
 860
 861 out_put:
 862         up_read(&ubi->fm_eba_sem);
 863
 864         if (!err) {
 865                 ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
 866                 ubi_msg(ubi, "data was successfully recovered");
 867         } else if (new_pnum >= 0) {
 868                 /*
 869                  * Bad luck? This physical eraseblock is bad too? Crud. Let's
 870                  * try to get another one.
 871                  */
 872                 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
 873                 ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
 874         }
 875
 876         return err;
 877 }
 878
 879 /**
 880  * recover_peb - recover from write failure.
 881  * @ubi: UBI device description object
 882  * @pnum: the physical eraseblock to recover
 883  * @vol_id: volume ID
 884  * @lnum: logical eraseblock number
 885  * @buf: data which was not written because of the write failure
 886  * @offset: offset of the failed write
 887  * @len: how many bytes should have been written
 888  *
 889  * This function is called in case of a write failure and moves all good data
 890  * from the potentially bad physical eraseblock to a good physical eraseblock.
 891  * This function also writes the data which was not written due to the failure.
 892  * Returns 0 in case of success, and a negative error code in case of failure.
 893  * This function tries %UBI_IO_RETRIES before giving up.
 894  */
 895 static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
 896                        const void *buf, int offset, int len)
 897 {
 898         int err, idx = vol_id2idx(ubi, vol_id), tries;
 899         struct ubi_volume *vol = ubi->volumes[idx];
 900         struct ubi_vid_io_buf *vidb;
 901
 902         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
 903         if (!vidb)
 904                 return -ENOMEM;
 905
 906         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
 907                 bool retry;
 908
 909                 err = try_recover_peb(vol, pnum, lnum, buf, offset, len, vidb,
 910                                       &retry);
 911                 if (!err || !retry)
 912                         break;
 913
 914                 ubi_msg(ubi, "try again");
 915         }
 916
 917         ubi_free_vid_buf(vidb);
 918
 919         return err;
 920 }
 921
 922 /**
 923  * try_write_vid_and_data - try to write VID header and data to a new PEB.
 924  * @vol: volume description object
 925  * @lnum: logical eraseblock number
 926  * @vidb: the VID buffer to write
 927  * @buf: buffer containing the data
 928  * @offset: where to start writing data
 929  * @len: how many bytes should be written
 930  *
 931  * This function tries to write VID header and data belonging to logical
 932  * eraseblock @lnum of volume @vol to a new physical eraseblock. Returns zero
 933  * in case of success and a negative error code in case of failure.
 934  * In case of error, it is possible that something was still written to the
 935  * flash media, but may be some garbage.
 936  */
 937 static int try_write_vid_and_data(struct ubi_volume *vol, int lnum,
 938                                   struct ubi_vid_io_buf *vidb, const void *buf,
 939                                   int offset, int len)
 940 {
 941         struct ubi_device *ubi = vol->ubi;
 942         int pnum, opnum, err, vol_id = vol->vol_id;
 943
 944         pnum = ubi_wl_get_peb(ubi);
 945         if (pnum < 0) {
 946                 err = pnum;
 947                 goto out_put;
 948         }
 949
 950         opnum = vol->eba_tbl->entries[lnum].pnum;
 951
 952         dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
 953                 len, offset, vol_id, lnum, pnum);
 954
 955         err = ubi_io_write_vid_hdr(ubi, pnum, vidb);
 956         if (err) {
 957                 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
 958                          vol_id, lnum, pnum);
 959                 goto out_put;
 960         }
 961
 962         if (len) {
 963                 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
 964                 if (err) {
 965                         ubi_warn(ubi,
 966                                  "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
 967                                  len, offset, vol_id, lnum, pnum);
 968                         goto out_put;
 969                 }
 970         }
 971
 972         vol->eba_tbl->entries[lnum].pnum = pnum;
 973
 974 out_put:
 975         up_read(&ubi->fm_eba_sem);
 976
 977         if (err && pnum >= 0)
 978                 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
 979         else if (!err && opnum >= 0)
 980                 err = ubi_wl_put_peb(ubi, vol_id, lnum, opnum, 0);
 981
 982         return err;
 983 }
 984
 985 /**
 986  * ubi_eba_write_leb - write data to dynamic volume.
 987  * @ubi: UBI device description object
 988  * @vol: volume description object
 989  * @lnum: logical eraseblock number
 990  * @buf: the data to write
 991  * @offset: offset within the logical eraseblock where to write
 992  * @len: how many bytes to write
 993  *
 994  * This function writes data to logical eraseblock @lnum of a dynamic volume
 995  * @vol. Returns zero in case of success and a negative error code in case
 996  * of failure. In case of error, it is possible that something was still
 997  * written to the flash media, but may be some garbage.
 998  * This function retries %UBI_IO_RETRIES times before giving up.
 999  */
1000 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
1001                       const void *buf, int offset, int len)
1002 {
1003         int err, pnum, tries, vol_id = vol->vol_id;
1004         struct ubi_vid_io_buf *vidb;
1005         struct ubi_vid_hdr *vid_hdr;
1006
1007         if (ubi->ro_mode)
1008                 return -EROFS;
1009
1010         err = leb_write_lock(ubi, vol_id, lnum);
1011         if (err)
1012                 return err;
1013
1014         pnum = vol->eba_tbl->entries[lnum].pnum;
1015         if (pnum >= 0) {
1016                 err = check_mapping(ubi, vol, lnum, &pnum);
1017                 if (err < 0)
1018                         goto out;
1019         }
1020
1021         if (pnum >= 0) {
1022                 dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
1023                         len, offset, vol_id, lnum, pnum);
1024
1025                 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
1026                 if (err) {
1027                         ubi_warn(ubi, "failed to write data to PEB %d", pnum);
1028                         if (err == -EIO && ubi->bad_allowed)
1029                                 err = recover_peb(ubi, pnum, vol_id, lnum, buf,
1030                                                   offset, len);
1031                 }
1032
1033                 goto out;
1034         }
1035
1036         /*
1037          * The logical eraseblock is not mapped. We have to get a free physical
1038          * eraseblock and write the volume identifier header there first.
1039          */
1040         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
1041         if (!vidb) {
1042                 leb_write_unlock(ubi, vol_id, lnum);
1043                 return -ENOMEM;
1044         }
1045
1046         vid_hdr = ubi_get_vid_hdr(vidb);
1047
1048         vid_hdr->vol_type = UBI_VID_DYNAMIC;
1049         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1050         vid_hdr->vol_id = cpu_to_be32(vol_id);
1051         vid_hdr->lnum = cpu_to_be32(lnum);
1052         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
1053         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
1054
1055         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1056                 err = try_write_vid_and_data(vol, lnum, vidb, buf, offset, len);
1057                 if (err != -EIO || !ubi->bad_allowed)
1058                         break;
1059
1060                 /*
1061                  * Fortunately, this is the first write operation to this
1062                  * physical eraseblock, so just put it and request a new one.
1063                  * We assume that if this physical eraseblock went bad, the
1064                  * erase code will handle that.
1065                  */
1066                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1067                 ubi_msg(ubi, "try another PEB");
1068         }
1069
1070         ubi_free_vid_buf(vidb);
1071
1072 out:
1073         if (err)
1074                 ubi_ro_mode(ubi);
1075
1076         leb_write_unlock(ubi, vol_id, lnum);
1077
1078         return err;
1079 }
1080
1081 /**
1082  * ubi_eba_write_leb_st - write data to static volume.
1083  * @ubi: UBI device description object
1084  * @vol: volume description object
1085  * @lnum: logical eraseblock number
1086  * @buf: data to write
1087  * @len: how many bytes to write
1088  * @used_ebs: how many logical eraseblocks will this volume contain
1089  *
1090  * This function writes data to logical eraseblock @lnum of static volume
1091  * @vol. The @used_ebs argument should contain total number of logical
1092  * eraseblock in this static volume.
1093  *
1094  * When writing to the last logical eraseblock, the @len argument doesn't have
1095  * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
1096  * to the real data size, although the @buf buffer has to contain the
1097  * alignment. In all other cases, @len has to be aligned.
1098  *
1099  * It is prohibited to write more than once to logical eraseblocks of static
1100  * volumes. This function returns zero in case of success and a negative error
1101  * code in case of failure.
1102  */
1103 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
1104                          int lnum, const void *buf, int len, int used_ebs)
1105 {
1106         int err, tries, data_size = len, vol_id = vol->vol_id;
1107         struct ubi_vid_io_buf *vidb;
1108         struct ubi_vid_hdr *vid_hdr;
1109         uint32_t crc;
1110
1111         if (ubi->ro_mode)
1112                 return -EROFS;
1113
1114         if (lnum == used_ebs - 1)
1115                 /* If this is the last LEB @len may be unaligned */
1116                 len = ALIGN(data_size, ubi->min_io_size);
1117         else
1118                 ubi_assert(!(len & (ubi->min_io_size - 1)));
1119
1120         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
1121         if (!vidb)
1122                 return -ENOMEM;
1123
1124         vid_hdr = ubi_get_vid_hdr(vidb);
1125
1126         err = leb_write_lock(ubi, vol_id, lnum);
1127         if (err)
1128                 goto out;
1129
1130         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1131         vid_hdr->vol_id = cpu_to_be32(vol_id);
1132         vid_hdr->lnum = cpu_to_be32(lnum);
1133         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
1134         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
1135
1136         crc = crc32(UBI_CRC32_INIT, buf, data_size);
1137         vid_hdr->vol_type = UBI_VID_STATIC;
1138         vid_hdr->data_size = cpu_to_be32(data_size);
1139         vid_hdr->used_ebs = cpu_to_be32(used_ebs);
1140         vid_hdr->data_crc = cpu_to_be32(crc);
1141
1142         ubi_assert(vol->eba_tbl->entries[lnum].pnum < 0);
1143
1144         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1145                 err = try_write_vid_and_data(vol, lnum, vidb, buf, 0, len);
1146                 if (err != -EIO || !ubi->bad_allowed)
1147                         break;
1148
1149                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1150                 ubi_msg(ubi, "try another PEB");
1151         }
1152
1153         if (err)
1154                 ubi_ro_mode(ubi);
1155
1156         leb_write_unlock(ubi, vol_id, lnum);
1157
1158 out:
1159         ubi_free_vid_buf(vidb);
1160
1161         return err;
1162 }
1163
1164 /*
1165  * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
1166  * @ubi: UBI device description object
1167  * @vol: volume description object
1168  * @lnum: logical eraseblock number
1169  * @buf: data to write
1170  * @len: how many bytes to write
1171  *
1172  * This function changes the contents of a logical eraseblock atomically. @buf
1173  * has to contain new logical eraseblock data, and @len - the length of the
1174  * data, which has to be aligned. This function guarantees that in case of an
1175  * unclean reboot the old contents is preserved. Returns zero in case of
1176  * success and a negative error code in case of failure.
1177  *
1178  * UBI reserves one LEB for the "atomic LEB change" operation, so only one
1179  * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
1180  */
1181 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
1182                               int lnum, const void *buf, int len)
1183 {
1184         int err, tries, vol_id = vol->vol_id;
1185         struct ubi_vid_io_buf *vidb;
1186         struct ubi_vid_hdr *vid_hdr;
1187         uint32_t crc;
1188
1189         if (ubi->ro_mode)
1190                 return -EROFS;
1191
1192         if (len == 0) {
1193                 /*
1194                  * Special case when data length is zero. In this case the LEB
1195                  * has to be unmapped and mapped somewhere else.
1196                  */
1197                 err = ubi_eba_unmap_leb(ubi, vol, lnum);
1198                 if (err)
1199                         return err;
1200                 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
1201         }
1202
1203         vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
1204         if (!vidb)
1205                 return -ENOMEM;
1206
1207         vid_hdr = ubi_get_vid_hdr(vidb);
1208
1209         mutex_lock(&ubi->alc_mutex);
1210         err = leb_write_lock(ubi, vol_id, lnum);
1211         if (err)
1212                 goto out_mutex;
1213
1214         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1215         vid_hdr->vol_id = cpu_to_be32(vol_id);
1216         vid_hdr->lnum = cpu_to_be32(lnum);
1217         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
1218         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
1219
1220         crc = crc32(UBI_CRC32_INIT, buf, len);
1221         vid_hdr->vol_type = UBI_VID_DYNAMIC;
1222         vid_hdr->data_size = cpu_to_be32(len);
1223         vid_hdr->copy_flag = 1;
1224         vid_hdr->data_crc = cpu_to_be32(crc);
1225
1226         dbg_eba("change LEB %d:%d", vol_id, lnum);
1227
1228         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1229                 err = try_write_vid_and_data(vol, lnum, vidb, buf, 0, len);
1230                 if (err != -EIO || !ubi->bad_allowed)
1231                         break;
1232
1233                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1234                 ubi_msg(ubi, "try another PEB");
1235         }
1236
1237         /*
1238          * This flash device does not admit of bad eraseblocks or
1239          * something nasty and unexpected happened. Switch to read-only
1240          * mode just in case.
1241          */
1242         if (err)
1243                 ubi_ro_mode(ubi);
1244
1245         leb_write_unlock(ubi, vol_id, lnum);
1246
1247 out_mutex:
1248         mutex_unlock(&ubi->alc_mutex);
1249         ubi_free_vid_buf(vidb);
1250         return err;
1251 }
1252
1253 /**
1254  * is_error_sane - check whether a read error is sane.
1255  * @err: code of the error happened during reading
1256  *
1257  * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1258  * cannot read data from the target PEB (an error @err happened). If the error
1259  * code is sane, then we treat this error as non-fatal. Otherwise the error is
1260  * fatal and UBI will be switched to R/O mode later.
1261  *
1262  * The idea is that we try not to switch to R/O mode if the read error is
1263  * something which suggests there was a real read problem. E.g., %-EIO. Or a
1264  * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1265  * mode, simply because we do not know what happened at the MTD level, and we
1266  * cannot handle this. E.g., the underlying driver may have become crazy, and
1267  * it is safer to switch to R/O mode to preserve the data.
1268  *
1269  * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1270  * which we have just written.
1271  */
1272 static int is_error_sane(int err)
1273 {
1274         if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
1275             err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
1276                 return 0;
1277         return 1;
1278 }
1279
1280 /**
1281  * ubi_eba_copy_leb - copy logical eraseblock.
1282  * @ubi: UBI device description object
1283  * @from: physical eraseblock number from where to copy
1284  * @to: physical eraseblock number where to copy
1285  * @vid_hdr: VID header of the @from physical eraseblock
1286  *
1287  * This function copies logical eraseblock from physical eraseblock @from to
1288  * physical eraseblock @to. The @vid_hdr buffer may be changed by this
1289  * function. Returns:
1290  *   o %0 in case of success;
1291  *   o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
1292  *   o a negative error code in case of failure.
1293  */
1294 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1295                      struct ubi_vid_io_buf *vidb)
1296 {
1297         int err, vol_id, lnum, data_size, aldata_size, idx;
1298         struct ubi_vid_hdr *vid_hdr = ubi_get_vid_hdr(vidb);
1299         struct ubi_volume *vol;
1300         uint32_t crc;
1301
1302         ubi_assert(rwsem_is_locked(&ubi->fm_eba_sem));
1303
1304         vol_id = be32_to_cpu(vid_hdr->vol_id);
1305         lnum = be32_to_cpu(vid_hdr->lnum);
1306
1307         dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
1308
1309         if (vid_hdr->vol_type == UBI_VID_STATIC) {
1310                 data_size = be32_to_cpu(vid_hdr->data_size);
1311                 aldata_size = ALIGN(data_size, ubi->min_io_size);
1312         } else
1313                 data_size = aldata_size =
1314                             ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
1315
1316         idx = vol_id2idx(ubi, vol_id);
1317         spin_lock(&ubi->volumes_lock);
1318         /*
1319          * Note, we may race with volume deletion, which means that the volume
1320          * this logical eraseblock belongs to might be being deleted. Since the
1321          * volume deletion un-maps all the volume's logical eraseblocks, it will
1322          * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1323          */
1324         vol = ubi->volumes[idx];
1325         spin_unlock(&ubi->volumes_lock);
1326         if (!vol) {
1327                 /* No need to do further work, cancel */
1328                 dbg_wl("volume %d is being removed, cancel", vol_id);
1329                 return MOVE_CANCEL_RACE;
1330         }
1331
1332         /*
1333          * We do not want anybody to write to this logical eraseblock while we
1334          * are moving it, so lock it.
1335          *
1336          * Note, we are using non-waiting locking here, because we cannot sleep
1337          * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1338          * unmapping the LEB which is mapped to the PEB we are going to move
1339          * (@from). This task locks the LEB and goes sleep in the
1340          * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1341          * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
1342          * LEB is already locked, we just do not move it and return
1343          * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1344          * we do not know the reasons of the contention - it may be just a
1345          * normal I/O on this LEB, so we want to re-try.
1346          */
1347         err = leb_write_trylock(ubi, vol_id, lnum);
1348         if (err) {
1349                 dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
1350                 return MOVE_RETRY;
1351         }
1352
1353         /*
1354          * The LEB might have been put meanwhile, and the task which put it is
1355          * probably waiting on @ubi->move_mutex. No need to continue the work,
1356          * cancel it.
1357          */
1358         if (vol->eba_tbl->entries[lnum].pnum != from) {
1359                 dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1360                        vol_id, lnum, from, vol->eba_tbl->entries[lnum].pnum);
1361                 err = MOVE_CANCEL_RACE;
1362                 goto out_unlock_leb;
1363         }
1364
1365         /*
1366          * OK, now the LEB is locked and we can safely start moving it. Since
1367          * this function utilizes the @ubi->peb_buf buffer which is shared
1368          * with some other functions - we lock the buffer by taking the
1369          * @ubi->buf_mutex.
1370          */
1371         mutex_lock(&ubi->buf_mutex);
1372         dbg_wl("read %d bytes of data", aldata_size);
1373         err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
1374         if (err && err != UBI_IO_BITFLIPS) {
1375                 ubi_warn(ubi, "error %d while reading data from PEB %d",
1376                          err, from);
1377                 err = MOVE_SOURCE_RD_ERR;
1378                 goto out_unlock_buf;
1379         }
1380
1381         /*
1382          * Now we have got to calculate how much data we have to copy. In
1383          * case of a static volume it is fairly easy - the VID header contains
1384          * the data size. In case of a dynamic volume it is more difficult - we
1385          * have to read the contents, cut 0xFF bytes from the end and copy only
1386          * the first part. We must do this to avoid writing 0xFF bytes as it
1387          * may have some side-effects. And not only this. It is important not
1388          * to include those 0xFFs to CRC because later the they may be filled
1389          * by data.
1390          */
1391         if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1392                 aldata_size = data_size =
1393                         ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
1394
1395         cond_resched();
1396         crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
1397         cond_resched();
1398
1399         /*
1400          * It may turn out to be that the whole @from physical eraseblock
1401          * contains only 0xFF bytes. Then we have to only write the VID header
1402          * and do not write any data. This also means we should not set
1403          * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1404          */
1405         if (data_size > 0) {
1406                 vid_hdr->copy_flag = 1;
1407                 vid_hdr->data_size = cpu_to_be32(data_size);
1408                 vid_hdr->data_crc = cpu_to_be32(crc);
1409         }
1410         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1411
1412         err = ubi_io_write_vid_hdr(ubi, to, vidb);
1413         if (err) {
1414                 if (err == -EIO)
1415                         err = MOVE_TARGET_WR_ERR;
1416                 goto out_unlock_buf;
1417         }
1418
1419         cond_resched();
1420
1421         /* Read the VID header back and check if it was written correctly */
1422         err = ubi_io_read_vid_hdr(ubi, to, vidb, 1);
1423         if (err) {
1424                 if (err != UBI_IO_BITFLIPS) {
1425                         ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
1426                                  err, to);
1427                         if (is_error_sane(err))
1428                                 err = MOVE_TARGET_RD_ERR;
1429                 } else
1430                         err = MOVE_TARGET_BITFLIPS;
1431                 goto out_unlock_buf;
1432         }
1433
1434         if (data_size > 0) {
1435                 err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1436                 if (err) {
1437                         if (err == -EIO)
1438                                 err = MOVE_TARGET_WR_ERR;
1439                         goto out_unlock_buf;
1440                 }
1441
1442                 cond_resched();
1443         }
1444
1445         ubi_assert(vol->eba_tbl->entries[lnum].pnum == from);
1446         vol->eba_tbl->entries[lnum].pnum = to;
1447
1448 out_unlock_buf:
1449         mutex_unlock(&ubi->buf_mutex);
1450 out_unlock_leb:
1451         leb_write_unlock(ubi, vol_id, lnum);
1452         return err;
1453 }
1454
1455 /**
1456  * print_rsvd_warning - warn about not having enough reserved PEBs.
1457  * @ubi: UBI device description object
1458  *
1459  * This is a helper function for 'ubi_eba_init()' which is called when UBI
1460  * cannot reserve enough PEBs for bad block handling. This function makes a
1461  * decision whether we have to print a warning or not. The algorithm is as
1462  * follows:
1463  *   o if this is a new UBI image, then just print the warning
1464  *   o if this is an UBI image which has already been used for some time, print
1465  *     a warning only if we can reserve less than 10% of the expected amount of
1466  *     the reserved PEB.
1467  *
1468  * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1469  * of PEBs becomes smaller, which is normal and we do not want to scare users
1470  * with a warning every time they attach the MTD device. This was an issue
1471  * reported by real users.
1472  */
1473 static void print_rsvd_warning(struct ubi_device *ubi,
1474                                struct ubi_attach_info *ai)
1475 {
1476         /*
1477          * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1478          * large number to distinguish between newly flashed and used images.
1479          */
1480         if (ai->max_sqnum > (1 << 18)) {
1481                 int min = ubi->beb_rsvd_level / 10;
1482
1483                 if (!min)
1484                         min = 1;
1485                 if (ubi->beb_rsvd_pebs > min)
1486                         return;
1487         }
1488
1489         ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
1490                  ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
1491         if (ubi->corr_peb_count)
1492                 ubi_warn(ubi, "%d PEBs are corrupted and not used",
1493                          ubi->corr_peb_count);
1494 }
1495
1496 /**
1497  * self_check_eba - run a self check on the EBA table constructed by fastmap.
1498  * @ubi: UBI device description object
1499  * @ai_fastmap: UBI attach info object created by fastmap
1500  * @ai_scan: UBI attach info object created by scanning
1501  *
1502  * Returns < 0 in case of an internal error, 0 otherwise.
1503  * If a bad EBA table entry was found it will be printed out and
1504  * ubi_assert() triggers.
1505  */
1506 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1507                    struct ubi_attach_info *ai_scan)
1508 {
1509         int i, j, num_volumes, ret = 0;
1510         int **scan_eba, **fm_eba;
1511         struct ubi_ainf_volume *av;
1512         struct ubi_volume *vol;
1513         struct ubi_ainf_peb *aeb;
1514         struct rb_node *rb;
1515
1516         num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1517
1518         scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1519         if (!scan_eba)
1520                 return -ENOMEM;
1521
1522         fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1523         if (!fm_eba) {
1524                 kfree(scan_eba);
1525                 return -ENOMEM;
1526         }
1527
1528         for (i = 0; i < num_volumes; i++) {
1529                 vol = ubi->volumes[i];
1530                 if (!vol)
1531                         continue;
1532
1533                 scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1534                                       GFP_KERNEL);
1535                 if (!scan_eba[i]) {
1536                         ret = -ENOMEM;
1537                         goto out_free;
1538                 }
1539
1540                 fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1541                                     GFP_KERNEL);
1542                 if (!fm_eba[i]) {
1543                         ret = -ENOMEM;
1544                         goto out_free;
1545                 }
1546
1547                 for (j = 0; j < vol->reserved_pebs; j++)
1548                         scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1549
1550                 av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1551                 if (!av)
1552                         continue;
1553
1554                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1555                         scan_eba[i][aeb->lnum] = aeb->pnum;
1556
1557                 av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1558                 if (!av)
1559                         continue;
1560
1561                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1562                         fm_eba[i][aeb->lnum] = aeb->pnum;
1563
1564                 for (j = 0; j < vol->reserved_pebs; j++) {
1565                         if (scan_eba[i][j] != fm_eba[i][j]) {
1566                                 if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1567                                         fm_eba[i][j] == UBI_LEB_UNMAPPED)
1568                                         continue;
1569
1570                                 ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
1571                                         vol->vol_id, j, fm_eba[i][j],
1572                                         scan_eba[i][j]);
1573                                 ubi_assert(0);
1574                         }
1575                 }
1576         }
1577
1578 out_free:
1579         for (i = 0; i < num_volumes; i++) {
1580                 if (!ubi->volumes[i])
1581                         continue;
1582
1583                 kfree(scan_eba[i]);
1584                 kfree(fm_eba[i]);
1585         }
1586
1587         kfree(scan_eba);
1588         kfree(fm_eba);
1589         return ret;
1590 }
1591
1592 /**
1593  * ubi_eba_init - initialize the EBA sub-system using attaching information.
1594  * @ubi: UBI device description object
1595  * @ai: attaching information
1596  *
1597  * This function returns zero in case of success and a negative error code in
1598  * case of failure.
1599  */
1600 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
1601 {
1602         int i, err, num_volumes;
1603         struct ubi_ainf_volume *av;
1604         struct ubi_volume *vol;
1605         struct ubi_ainf_peb *aeb;
1606         struct rb_node *rb;
1607
1608         dbg_eba("initialize EBA sub-system");
1609
1610         spin_lock_init(&ubi->ltree_lock);
1611         mutex_init(&ubi->alc_mutex);
1612         ubi->ltree = RB_ROOT;
1613
1614         ubi->global_sqnum = ai->max_sqnum + 1;
1615         num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1616
1617         for (i = 0; i < num_volumes; i++) {
1618                 struct ubi_eba_table *tbl;
1619
1620                 vol = ubi->volumes[i];
1621                 if (!vol)
1622                         continue;
1623
1624                 cond_resched();
1625
1626                 tbl = ubi_eba_create_table(vol, vol->reserved_pebs);
1627                 if (IS_ERR(tbl)) {
1628                         err = PTR_ERR(tbl);
1629                         goto out_free;
1630                 }
1631
1632                 ubi_eba_replace_table(vol, tbl);
1633
1634                 av = ubi_find_av(ai, idx2vol_id(ubi, i));
1635                 if (!av)
1636                         continue;
1637
1638                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
1639                         if (aeb->lnum >= vol->reserved_pebs) {
1640                                 /*
1641                                  * This may happen in case of an unclean reboot
1642                                  * during re-size.
1643                                  */
1644                                 ubi_move_aeb_to_list(av, aeb, &ai->erase);
1645                         } else {
1646                                 struct ubi_eba_entry *entry;
1647
1648                                 entry = &vol->eba_tbl->entries[aeb->lnum];
1649                                 entry->pnum = aeb->pnum;
1650                         }
1651                 }
1652         }
1653
1654         if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
1655                 ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
1656                         ubi->avail_pebs, EBA_RESERVED_PEBS);
1657                 if (ubi->corr_peb_count)
1658                         ubi_err(ubi, "%d PEBs are corrupted and not used",
1659                                 ubi->corr_peb_count);
1660                 err = -ENOSPC;
1661                 goto out_free;
1662         }
1663         ubi->avail_pebs -= EBA_RESERVED_PEBS;
1664         ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1665
1666         if (ubi->bad_allowed) {
1667                 ubi_calculate_reserved(ubi);
1668
1669                 if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1670                         /* No enough free physical eraseblocks */
1671                         ubi->beb_rsvd_pebs = ubi->avail_pebs;
1672                         print_rsvd_warning(ubi, ai);
1673                 } else
1674                         ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1675
1676                 ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1677                 ubi->rsvd_pebs  += ubi->beb_rsvd_pebs;
1678         }
1679
1680         dbg_eba("EBA sub-system is initialized");
1681         return 0;
1682
1683 out_free:
1684         for (i = 0; i < num_volumes; i++) {
1685                 if (!ubi->volumes[i])
1686                         continue;
1687                 ubi_eba_replace_table(ubi->volumes[i], NULL);
1688         }
1689         return err;
1690 }