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