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_is_mapped - check if a LEB is mapped.
 316  * @vol: volume description object
 317  * @lnum: logical eraseblock number
 318  *
 319  * This function returns true if the LEB is mapped, false otherwise.
 320  */
 321 bool ubi_eba_is_mapped(struct ubi_volume *vol, int lnum)
 322 {
 323         return vol->eba_tbl[lnum] >= 0;
 324 }
 325
 326 /**
 327  * ubi_eba_unmap_leb - un-map logical eraseblock.
 328  * @ubi: UBI device description object
 329  * @vol: volume description object
 330  * @lnum: logical eraseblock number
 331  *
 332  * This function un-maps logical eraseblock @lnum and schedules corresponding
 333  * physical eraseblock for erasure. Returns zero in case of success and a
 334  * negative error code in case of failure.
 335  */
 336 int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
 337                       int lnum)
 338 {
 339         int err, pnum, vol_id = vol->vol_id;
 340
 341         if (ubi->ro_mode)
 342                 return -EROFS;
 343
 344         err = leb_write_lock(ubi, vol_id, lnum);
 345         if (err)
 346                 return err;
 347
 348         pnum = vol->eba_tbl[lnum];
 349         if (pnum < 0)
 350                 /* This logical eraseblock is already unmapped */
 351                 goto out_unlock;
 352
 353         dbg_eba("erase LEB %d:%d, PEB %d", vol_id, lnum, pnum);
 354
 355         down_read(&ubi->fm_eba_sem);
 356         vol->eba_tbl[lnum] = UBI_LEB_UNMAPPED;
 357         up_read(&ubi->fm_eba_sem);
 358         err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 0);
 359
 360 out_unlock:
 361         leb_write_unlock(ubi, vol_id, lnum);
 362         return err;
 363 }
 364
 365 /**
 366  * ubi_eba_read_leb - read data.
 367  * @ubi: UBI device description object
 368  * @vol: volume description object
 369  * @lnum: logical eraseblock number
 370  * @buf: buffer to store the read data
 371  * @offset: offset from where to read
 372  * @len: how many bytes to read
 373  * @check: data CRC check flag
 374  *
 375  * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
 376  * bytes. The @check flag only makes sense for static volumes and forces
 377  * eraseblock data CRC checking.
 378  *
 379  * In case of success this function returns zero. In case of a static volume,
 380  * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
 381  * returned for any volume type if an ECC error was detected by the MTD device
 382  * driver. Other negative error cored may be returned in case of other errors.
 383  */
 384 int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 385                      void *buf, int offset, int len, int check)
 386 {
 387         int err, pnum, scrub = 0, vol_id = vol->vol_id;
 388         struct ubi_vid_hdr *vid_hdr;
 389         uint32_t uninitialized_var(crc);
 390
 391         err = leb_read_lock(ubi, vol_id, lnum);
 392         if (err)
 393                 return err;
 394
 395         pnum = vol->eba_tbl[lnum];
 396         if (pnum < 0) {
 397                 /*
 398                  * The logical eraseblock is not mapped, fill the whole buffer
 399                  * with 0xFF bytes. The exception is static volumes for which
 400                  * it is an error to read unmapped logical eraseblocks.
 401                  */
 402                 dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
 403                         len, offset, vol_id, lnum);
 404                 leb_read_unlock(ubi, vol_id, lnum);
 405                 ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
 406                 memset(buf, 0xFF, len);
 407                 return 0;
 408         }
 409
 410         dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
 411                 len, offset, vol_id, lnum, pnum);
 412
 413         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 414                 check = 0;
 415
 416 retry:
 417         if (check) {
 418                 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
 419                 if (!vid_hdr) {
 420                         err = -ENOMEM;
 421                         goto out_unlock;
 422                 }
 423
 424                 err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
 425                 if (err && err != UBI_IO_BITFLIPS) {
 426                         if (err > 0) {
 427                                 /*
 428                                  * The header is either absent or corrupted.
 429                                  * The former case means there is a bug -
 430                                  * switch to read-only mode just in case.
 431                                  * The latter case means a real corruption - we
 432                                  * may try to recover data. FIXME: but this is
 433                                  * not implemented.
 434                                  */
 435                                 if (err == UBI_IO_BAD_HDR_EBADMSG ||
 436                                     err == UBI_IO_BAD_HDR) {
 437                                         ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
 438                                                  pnum, vol_id, lnum);
 439                                         err = -EBADMSG;
 440                                 } else {
 441                                         /*
 442                                          * Ending up here in the non-Fastmap case
 443                                          * is a clear bug as the VID header had to
 444                                          * be present at scan time to have it referenced.
 445                                          * With fastmap the story is more complicated.
 446                                          * Fastmap has the mapping info without the need
 447                                          * of a full scan. So the LEB could have been
 448                                          * unmapped, Fastmap cannot know this and keeps
 449                                          * the LEB referenced.
 450                                          * This is valid and works as the layer above UBI
 451                                          * has to do bookkeeping about used/referenced
 452                                          * LEBs in any case.
 453                                          */
 454                                         if (ubi->fast_attach) {
 455                                                 err = -EBADMSG;
 456                                         } else {
 457                                                 err = -EINVAL;
 458                                                 ubi_ro_mode(ubi);
 459                                         }
 460                                 }
 461                         }
 462                         goto out_free;
 463                 } else if (err == UBI_IO_BITFLIPS)
 464                         scrub = 1;
 465
 466                 ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
 467                 ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
 468
 469                 crc = be32_to_cpu(vid_hdr->data_crc);
 470                 ubi_free_vid_hdr(ubi, vid_hdr);
 471         }
 472
 473         err = ubi_io_read_data(ubi, buf, pnum, offset, len);
 474         if (err) {
 475                 if (err == UBI_IO_BITFLIPS)
 476                         scrub = 1;
 477                 else if (mtd_is_eccerr(err)) {
 478                         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 479                                 goto out_unlock;
 480                         scrub = 1;
 481                         if (!check) {
 482                                 ubi_msg(ubi, "force data checking");
 483                                 check = 1;
 484                                 goto retry;
 485                         }
 486                 } else
 487                         goto out_unlock;
 488         }
 489
 490         if (check) {
 491                 uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
 492                 if (crc1 != crc) {
 493                         ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
 494                                  crc1, crc);
 495                         err = -EBADMSG;
 496                         goto out_unlock;
 497                 }
 498         }
 499
 500         if (scrub)
 501                 err = ubi_wl_scrub_peb(ubi, pnum);
 502
 503         leb_read_unlock(ubi, vol_id, lnum);
 504         return err;
 505
 506 out_free:
 507         ubi_free_vid_hdr(ubi, vid_hdr);
 508 out_unlock:
 509         leb_read_unlock(ubi, vol_id, lnum);
 510         return err;
 511 }
 512
 513 /**
 514  * ubi_eba_read_leb_sg - read data into a scatter gather list.
 515  * @ubi: UBI device description object
 516  * @vol: volume description object
 517  * @lnum: logical eraseblock number
 518  * @sgl: UBI scatter gather list to store the read data
 519  * @offset: offset from where to read
 520  * @len: how many bytes to read
 521  * @check: data CRC check flag
 522  *
 523  * This function works exactly like ubi_eba_read_leb(). But instead of
 524  * storing the read data into a buffer it writes to an UBI scatter gather
 525  * list.
 526  */
 527 int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
 528                         struct ubi_sgl *sgl, int lnum, int offset, int len,
 529                         int check)
 530 {
 531         int to_read;
 532         int ret;
 533         struct scatterlist *sg;
 534
 535         for (;;) {
 536                 ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
 537                 sg = &sgl->sg[sgl->list_pos];
 538                 if (len < sg->length - sgl->page_pos)
 539                         to_read = len;
 540                 else
 541                         to_read = sg->length - sgl->page_pos;
 542
 543                 ret = ubi_eba_read_leb(ubi, vol, lnum,
 544                                        sg_virt(sg) + sgl->page_pos, offset,
 545                                        to_read, check);
 546                 if (ret < 0)
 547                         return ret;
 548
 549                 offset += to_read;
 550                 len -= to_read;
 551                 if (!len) {
 552                         sgl->page_pos += to_read;
 553                         if (sgl->page_pos == sg->length) {
 554                                 sgl->list_pos++;
 555                                 sgl->page_pos = 0;
 556                         }
 557
 558                         break;
 559                 }
 560
 561                 sgl->list_pos++;
 562                 sgl->page_pos = 0;
 563         }
 564
 565         return ret;
 566 }
 567
 568 /**
 569  * try_recover_peb - try to recover from write failure.
 570  * @vol: volume description object
 571  * @pnum: the physical eraseblock to recover
 572  * @lnum: logical eraseblock number
 573  * @buf: data which was not written because of the write failure
 574  * @offset: offset of the failed write
 575  * @len: how many bytes should have been written
 576  * @vid: VID header
 577  * @retry: whether the caller should retry in case of failure
 578  *
 579  * This function is called in case of a write failure and moves all good data
 580  * from the potentially bad physical eraseblock to a good physical eraseblock.
 581  * This function also writes the data which was not written due to the failure.
 582  * Returns 0 in case of success, and a negative error code in case of failure.
 583  * In case of failure, the %retry parameter is set to false if this is a fatal
 584  * error (retrying won't help), and true otherwise.
 585  */
 586 static int try_recover_peb(struct ubi_volume *vol, int pnum, int lnum,
 587                            const void *buf, int offset, int len,
 588                            struct ubi_vid_hdr *vid_hdr, bool *retry)
 589 {
 590         struct ubi_device *ubi = vol->ubi;
 591         int new_pnum, err, vol_id = vol->vol_id, data_size;
 592         uint32_t crc;
 593
 594         *retry = false;
 595
 596         new_pnum = ubi_wl_get_peb(ubi);
 597         if (new_pnum < 0) {
 598                 err = new_pnum;
 599                 goto out_put;
 600         }
 601
 602         ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
 603                 pnum, new_pnum);
 604
 605         err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
 606         if (err && err != UBI_IO_BITFLIPS) {
 607                 if (err > 0)
 608                         err = -EIO;
 609                 goto out_put;
 610         }
 611
 612         ubi_assert(vid_hdr->vol_type == UBI_VID_DYNAMIC);
 613
 614         mutex_lock(&ubi->buf_mutex);
 615         memset(ubi->peb_buf + offset, 0xFF, len);
 616
 617         /* Read everything before the area where the write failure happened */
 618         if (offset > 0) {
 619                 err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
 620                 if (err && err != UBI_IO_BITFLIPS)
 621                         goto out_unlock;
 622         }
 623
 624         *retry = true;
 625
 626         memcpy(ubi->peb_buf + offset, buf, len);
 627
 628         data_size = offset + len;
 629         crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
 630         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 631         vid_hdr->copy_flag = 1;
 632         vid_hdr->data_size = cpu_to_be32(data_size);
 633         vid_hdr->data_crc = cpu_to_be32(crc);
 634         err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
 635         if (err)
 636                 goto out_unlock;
 637
 638         err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
 639
 640 out_unlock:
 641         mutex_unlock(&ubi->buf_mutex);
 642
 643         if (!err)
 644                 vol->eba_tbl[lnum] = new_pnum;
 645
 646 out_put:
 647         up_read(&ubi->fm_eba_sem);
 648
 649         if (!err) {
 650                 ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
 651                 ubi_msg(ubi, "data was successfully recovered");
 652         } else if (new_pnum >= 0) {
 653                 /*
 654                  * Bad luck? This physical eraseblock is bad too? Crud. Let's
 655                  * try to get another one.
 656                  */
 657                 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
 658                 ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
 659         }
 660
 661         return err;
 662 }
 663
 664 /**
 665  * recover_peb - recover from write failure.
 666  * @ubi: UBI device description object
 667  * @pnum: the physical eraseblock to recover
 668  * @vol_id: volume ID
 669  * @lnum: logical eraseblock number
 670  * @buf: data which was not written because of the write failure
 671  * @offset: offset of the failed write
 672  * @len: how many bytes should have been written
 673  *
 674  * This function is called in case of a write failure and moves all good data
 675  * from the potentially bad physical eraseblock to a good physical eraseblock.
 676  * This function also writes the data which was not written due to the failure.
 677  * Returns 0 in case of success, and a negative error code in case of failure.
 678  * This function tries %UBI_IO_RETRIES before giving up.
 679  */
 680 static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
 681                        const void *buf, int offset, int len)
 682 {
 683         int err, idx = vol_id2idx(ubi, vol_id), tries;
 684         struct ubi_volume *vol = ubi->volumes[idx];
 685         struct ubi_vid_hdr *vid_hdr;
 686
 687         vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
 688         if (!vid_hdr)
 689                 return -ENOMEM;
 690
 691         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
 692                 bool retry;
 693
 694                 err = try_recover_peb(vol, pnum, lnum, buf, offset, len,
 695                                       vid_hdr, &retry);
 696                 if (!err || !retry)
 697                         break;
 698
 699                 ubi_msg(ubi, "try again");
 700         }
 701
 702         ubi_free_vid_hdr(ubi, vid_hdr);
 703
 704         return err;
 705 }
 706
 707 /**
 708  * try_write_vid_and_data - try to write VID header and data to a new PEB.
 709  * @vol: volume description object
 710  * @lnum: logical eraseblock number
 711  * @vid_hdr: VID header to write
 712  * @buf: buffer containing the data
 713  * @offset: where to start writing data
 714  * @len: how many bytes should be written
 715  *
 716  * This function tries to write VID header and data belonging to logical
 717  * eraseblock @lnum of volume @vol to a new physical eraseblock. Returns zero
 718  * in case of success and a negative error code in case of failure.
 719  * In case of error, it is possible that something was still written to the
 720  * flash media, but may be some garbage.
 721  */
 722 static int try_write_vid_and_data(struct ubi_volume *vol, int lnum,
 723                                   struct ubi_vid_hdr *vid_hdr, const void *buf,
 724                                   int offset, int len)
 725 {
 726         struct ubi_device *ubi = vol->ubi;
 727         int pnum, opnum, err, vol_id = vol->vol_id;
 728
 729         pnum = ubi_wl_get_peb(ubi);
 730         if (pnum < 0) {
 731                 err = pnum;
 732                 goto out_put;
 733         }
 734
 735         opnum = vol->eba_tbl[lnum];
 736
 737         dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
 738                 len, offset, vol_id, lnum, pnum);
 739
 740         err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
 741         if (err) {
 742                 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
 743                          vol_id, lnum, pnum);
 744                 goto out_put;
 745         }
 746
 747         if (len) {
 748                 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
 749                 if (err) {
 750                         ubi_warn(ubi,
 751                                  "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
 752                                  len, offset, vol_id, lnum, pnum);
 753                         goto out_put;
 754                 }
 755         }
 756
 757         vol->eba_tbl[lnum] = pnum;
 758
 759 out_put:
 760         up_read(&ubi->fm_eba_sem);
 761
 762         if (err && pnum >= 0)
 763                 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
 764         else if (!err && opnum >= 0)
 765                 err = ubi_wl_put_peb(ubi, vol_id, lnum, opnum, 0);
 766
 767         return err;
 768 }
 769
 770 /**
 771  * ubi_eba_write_leb - write data to dynamic volume.
 772  * @ubi: UBI device description object
 773  * @vol: volume description object
 774  * @lnum: logical eraseblock number
 775  * @buf: the data to write
 776  * @offset: offset within the logical eraseblock where to write
 777  * @len: how many bytes to write
 778  *
 779  * This function writes data to logical eraseblock @lnum of a dynamic volume
 780  * @vol. Returns zero in case of success and a negative error code in case
 781  * of failure. In case of error, it is possible that something was still
 782  * written to the flash media, but may be some garbage.
 783  * This function retries %UBI_IO_RETRIES times before giving up.
 784  */
 785 int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
 786                       const void *buf, int offset, int len)
 787 {
 788         int err, pnum, tries, vol_id = vol->vol_id;
 789         struct ubi_vid_hdr *vid_hdr;
 790
 791         if (ubi->ro_mode)
 792                 return -EROFS;
 793
 794         err = leb_write_lock(ubi, vol_id, lnum);
 795         if (err)
 796                 return err;
 797
 798         pnum = vol->eba_tbl[lnum];
 799         if (pnum >= 0) {
 800                 dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
 801                         len, offset, vol_id, lnum, pnum);
 802
 803                 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
 804                 if (err) {
 805                         ubi_warn(ubi, "failed to write data to PEB %d", pnum);
 806                         if (err == -EIO && ubi->bad_allowed)
 807                                 err = recover_peb(ubi, pnum, vol_id, lnum, buf,
 808                                                   offset, len);
 809                 }
 810
 811                 goto out;
 812         }
 813
 814         /*
 815          * The logical eraseblock is not mapped. We have to get a free physical
 816          * eraseblock and write the volume identifier header there first.
 817          */
 818         vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
 819         if (!vid_hdr) {
 820                 leb_write_unlock(ubi, vol_id, lnum);
 821                 return -ENOMEM;
 822         }
 823
 824         vid_hdr->vol_type = UBI_VID_DYNAMIC;
 825         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 826         vid_hdr->vol_id = cpu_to_be32(vol_id);
 827         vid_hdr->lnum = cpu_to_be32(lnum);
 828         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
 829         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
 830
 831         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
 832                 err = try_write_vid_and_data(vol, lnum, vid_hdr, buf, offset,
 833                                              len);
 834                 if (err != -EIO || !ubi->bad_allowed)
 835                         break;
 836
 837                 /*
 838                  * Fortunately, this is the first write operation to this
 839                  * physical eraseblock, so just put it and request a new one.
 840                  * We assume that if this physical eraseblock went bad, the
 841                  * erase code will handle that.
 842                  */
 843                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 844                 ubi_msg(ubi, "try another PEB");
 845         }
 846
 847         ubi_free_vid_hdr(ubi, vid_hdr);
 848
 849 out:
 850         if (err)
 851                 ubi_ro_mode(ubi);
 852
 853         leb_write_unlock(ubi, vol_id, lnum);
 854
 855         return err;
 856 }
 857
 858 /**
 859  * ubi_eba_write_leb_st - write data to static volume.
 860  * @ubi: UBI device description object
 861  * @vol: volume description object
 862  * @lnum: logical eraseblock number
 863  * @buf: data to write
 864  * @len: how many bytes to write
 865  * @used_ebs: how many logical eraseblocks will this volume contain
 866  *
 867  * This function writes data to logical eraseblock @lnum of static volume
 868  * @vol. The @used_ebs argument should contain total number of logical
 869  * eraseblock in this static volume.
 870  *
 871  * When writing to the last logical eraseblock, the @len argument doesn't have
 872  * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
 873  * to the real data size, although the @buf buffer has to contain the
 874  * alignment. In all other cases, @len has to be aligned.
 875  *
 876  * It is prohibited to write more than once to logical eraseblocks of static
 877  * volumes. This function returns zero in case of success and a negative error
 878  * code in case of failure.
 879  */
 880 int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
 881                          int lnum, const void *buf, int len, int used_ebs)
 882 {
 883         int err, tries, data_size = len, vol_id = vol->vol_id;
 884         struct ubi_vid_hdr *vid_hdr;
 885         uint32_t crc;
 886
 887         if (ubi->ro_mode)
 888                 return -EROFS;
 889
 890         if (lnum == used_ebs - 1)
 891                 /* If this is the last LEB @len may be unaligned */
 892                 len = ALIGN(data_size, ubi->min_io_size);
 893         else
 894                 ubi_assert(!(len & (ubi->min_io_size - 1)));
 895
 896         vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
 897         if (!vid_hdr)
 898                 return -ENOMEM;
 899
 900         err = leb_write_lock(ubi, vol_id, lnum);
 901         if (err)
 902                 goto out;
 903
 904         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 905         vid_hdr->vol_id = cpu_to_be32(vol_id);
 906         vid_hdr->lnum = cpu_to_be32(lnum);
 907         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
 908         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
 909
 910         crc = crc32(UBI_CRC32_INIT, buf, data_size);
 911         vid_hdr->vol_type = UBI_VID_STATIC;
 912         vid_hdr->data_size = cpu_to_be32(data_size);
 913         vid_hdr->used_ebs = cpu_to_be32(used_ebs);
 914         vid_hdr->data_crc = cpu_to_be32(crc);
 915
 916         ubi_assert(vol->eba_tbl[lnum] < 0);
 917
 918         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
 919                 err = try_write_vid_and_data(vol, lnum, vid_hdr, buf, 0, len);
 920                 if (err != -EIO || !ubi->bad_allowed)
 921                         break;
 922
 923                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 924                 ubi_msg(ubi, "try another PEB");
 925         }
 926
 927         if (err)
 928                 ubi_ro_mode(ubi);
 929
 930         leb_write_unlock(ubi, vol_id, lnum);
 931
 932 out:
 933         ubi_free_vid_hdr(ubi, vid_hdr);
 934
 935         return err;
 936 }
 937
 938 /*
 939  * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
 940  * @ubi: UBI device description object
 941  * @vol: volume description object
 942  * @lnum: logical eraseblock number
 943  * @buf: data to write
 944  * @len: how many bytes to write
 945  *
 946  * This function changes the contents of a logical eraseblock atomically. @buf
 947  * has to contain new logical eraseblock data, and @len - the length of the
 948  * data, which has to be aligned. This function guarantees that in case of an
 949  * unclean reboot the old contents is preserved. Returns zero in case of
 950  * success and a negative error code in case of failure.
 951  *
 952  * UBI reserves one LEB for the "atomic LEB change" operation, so only one
 953  * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
 954  */
 955 int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
 956                               int lnum, const void *buf, int len)
 957 {
 958         int err, tries, vol_id = vol->vol_id;
 959         struct ubi_vid_hdr *vid_hdr;
 960         uint32_t crc;
 961
 962         if (ubi->ro_mode)
 963                 return -EROFS;
 964
 965         if (len == 0) {
 966                 /*
 967                  * Special case when data length is zero. In this case the LEB
 968                  * has to be unmapped and mapped somewhere else.
 969                  */
 970                 err = ubi_eba_unmap_leb(ubi, vol, lnum);
 971                 if (err)
 972                         return err;
 973                 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
 974         }
 975
 976         vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
 977         if (!vid_hdr)
 978                 return -ENOMEM;
 979
 980         mutex_lock(&ubi->alc_mutex);
 981         err = leb_write_lock(ubi, vol_id, lnum);
 982         if (err)
 983                 goto out_mutex;
 984
 985         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
 986         vid_hdr->vol_id = cpu_to_be32(vol_id);
 987         vid_hdr->lnum = cpu_to_be32(lnum);
 988         vid_hdr->compat = ubi_get_compat(ubi, vol_id);
 989         vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
 990
 991         crc = crc32(UBI_CRC32_INIT, buf, len);
 992         vid_hdr->vol_type = UBI_VID_DYNAMIC;
 993         vid_hdr->data_size = cpu_to_be32(len);
 994         vid_hdr->copy_flag = 1;
 995         vid_hdr->data_crc = cpu_to_be32(crc);
 996
 997         dbg_eba("change LEB %d:%d", vol_id, lnum);
 998
 999         for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1000                 err = try_write_vid_and_data(vol, lnum, vid_hdr, buf, 0, len);
1001                 if (err != -EIO || !ubi->bad_allowed)
1002                         break;
1003
1004                 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1005                 ubi_msg(ubi, "try another PEB");
1006         }
1007
1008         /*
1009          * This flash device does not admit of bad eraseblocks or
1010          * something nasty and unexpected happened. Switch to read-only
1011          * mode just in case.
1012          */
1013         if (err)
1014                 ubi_ro_mode(ubi);
1015
1016         leb_write_unlock(ubi, vol_id, lnum);
1017
1018 out_mutex:
1019         mutex_unlock(&ubi->alc_mutex);
1020         ubi_free_vid_hdr(ubi, vid_hdr);
1021         return err;
1022 }
1023
1024 /**
1025  * is_error_sane - check whether a read error is sane.
1026  * @err: code of the error happened during reading
1027  *
1028  * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1029  * cannot read data from the target PEB (an error @err happened). If the error
1030  * code is sane, then we treat this error as non-fatal. Otherwise the error is
1031  * fatal and UBI will be switched to R/O mode later.
1032  *
1033  * The idea is that we try not to switch to R/O mode if the read error is
1034  * something which suggests there was a real read problem. E.g., %-EIO. Or a
1035  * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1036  * mode, simply because we do not know what happened at the MTD level, and we
1037  * cannot handle this. E.g., the underlying driver may have become crazy, and
1038  * it is safer to switch to R/O mode to preserve the data.
1039  *
1040  * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1041  * which we have just written.
1042  */
1043 static int is_error_sane(int err)
1044 {
1045         if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
1046             err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
1047                 return 0;
1048         return 1;
1049 }
1050
1051 /**
1052  * ubi_eba_copy_leb - copy logical eraseblock.
1053  * @ubi: UBI device description object
1054  * @from: physical eraseblock number from where to copy
1055  * @to: physical eraseblock number where to copy
1056  * @vid_hdr: VID header of the @from physical eraseblock
1057  *
1058  * This function copies logical eraseblock from physical eraseblock @from to
1059  * physical eraseblock @to. The @vid_hdr buffer may be changed by this
1060  * function. Returns:
1061  *   o %0 in case of success;
1062  *   o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
1063  *   o a negative error code in case of failure.
1064  */
1065 int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1066                      struct ubi_vid_hdr *vid_hdr)
1067 {
1068         int err, vol_id, lnum, data_size, aldata_size, idx;
1069         struct ubi_volume *vol;
1070         uint32_t crc;
1071
1072         vol_id = be32_to_cpu(vid_hdr->vol_id);
1073         lnum = be32_to_cpu(vid_hdr->lnum);
1074
1075         dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
1076
1077         if (vid_hdr->vol_type == UBI_VID_STATIC) {
1078                 data_size = be32_to_cpu(vid_hdr->data_size);
1079                 aldata_size = ALIGN(data_size, ubi->min_io_size);
1080         } else
1081                 data_size = aldata_size =
1082                             ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
1083
1084         idx = vol_id2idx(ubi, vol_id);
1085         spin_lock(&ubi->volumes_lock);
1086         /*
1087          * Note, we may race with volume deletion, which means that the volume
1088          * this logical eraseblock belongs to might be being deleted. Since the
1089          * volume deletion un-maps all the volume's logical eraseblocks, it will
1090          * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1091          */
1092         vol = ubi->volumes[idx];
1093         spin_unlock(&ubi->volumes_lock);
1094         if (!vol) {
1095                 /* No need to do further work, cancel */
1096                 dbg_wl("volume %d is being removed, cancel", vol_id);
1097                 return MOVE_CANCEL_RACE;
1098         }
1099
1100         /*
1101          * We do not want anybody to write to this logical eraseblock while we
1102          * are moving it, so lock it.
1103          *
1104          * Note, we are using non-waiting locking here, because we cannot sleep
1105          * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1106          * unmapping the LEB which is mapped to the PEB we are going to move
1107          * (@from). This task locks the LEB and goes sleep in the
1108          * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1109          * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
1110          * LEB is already locked, we just do not move it and return
1111          * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1112          * we do not know the reasons of the contention - it may be just a
1113          * normal I/O on this LEB, so we want to re-try.
1114          */
1115         err = leb_write_trylock(ubi, vol_id, lnum);
1116         if (err) {
1117                 dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
1118                 return MOVE_RETRY;
1119         }
1120
1121         /*
1122          * The LEB might have been put meanwhile, and the task which put it is
1123          * probably waiting on @ubi->move_mutex. No need to continue the work,
1124          * cancel it.
1125          */
1126         if (vol->eba_tbl[lnum] != from) {
1127                 dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1128                        vol_id, lnum, from, vol->eba_tbl[lnum]);
1129                 err = MOVE_CANCEL_RACE;
1130                 goto out_unlock_leb;
1131         }
1132
1133         /*
1134          * OK, now the LEB is locked and we can safely start moving it. Since
1135          * this function utilizes the @ubi->peb_buf buffer which is shared
1136          * with some other functions - we lock the buffer by taking the
1137          * @ubi->buf_mutex.
1138          */
1139         mutex_lock(&ubi->buf_mutex);
1140         dbg_wl("read %d bytes of data", aldata_size);
1141         err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
1142         if (err && err != UBI_IO_BITFLIPS) {
1143                 ubi_warn(ubi, "error %d while reading data from PEB %d",
1144                          err, from);
1145                 err = MOVE_SOURCE_RD_ERR;
1146                 goto out_unlock_buf;
1147         }
1148
1149         /*
1150          * Now we have got to calculate how much data we have to copy. In
1151          * case of a static volume it is fairly easy - the VID header contains
1152          * the data size. In case of a dynamic volume it is more difficult - we
1153          * have to read the contents, cut 0xFF bytes from the end and copy only
1154          * the first part. We must do this to avoid writing 0xFF bytes as it
1155          * may have some side-effects. And not only this. It is important not
1156          * to include those 0xFFs to CRC because later the they may be filled
1157          * by data.
1158          */
1159         if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1160                 aldata_size = data_size =
1161                         ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
1162
1163         cond_resched();
1164         crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
1165         cond_resched();
1166
1167         /*
1168          * It may turn out to be that the whole @from physical eraseblock
1169          * contains only 0xFF bytes. Then we have to only write the VID header
1170          * and do not write any data. This also means we should not set
1171          * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1172          */
1173         if (data_size > 0) {
1174                 vid_hdr->copy_flag = 1;
1175                 vid_hdr->data_size = cpu_to_be32(data_size);
1176                 vid_hdr->data_crc = cpu_to_be32(crc);
1177         }
1178         vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1179
1180         err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
1181         if (err) {
1182                 if (err == -EIO)
1183                         err = MOVE_TARGET_WR_ERR;
1184                 goto out_unlock_buf;
1185         }
1186
1187         cond_resched();
1188
1189         /* Read the VID header back and check if it was written correctly */
1190         err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1191         if (err) {
1192                 if (err != UBI_IO_BITFLIPS) {
1193                         ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
1194                                  err, to);
1195                         if (is_error_sane(err))
1196                                 err = MOVE_TARGET_RD_ERR;
1197                 } else
1198                         err = MOVE_TARGET_BITFLIPS;
1199                 goto out_unlock_buf;
1200         }
1201
1202         if (data_size > 0) {
1203                 err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
1204                 if (err) {
1205                         if (err == -EIO)
1206                                 err = MOVE_TARGET_WR_ERR;
1207                         goto out_unlock_buf;
1208                 }
1209
1210                 cond_resched();
1211         }
1212
1213         ubi_assert(vol->eba_tbl[lnum] == from);
1214         down_read(&ubi->fm_eba_sem);
1215         vol->eba_tbl[lnum] = to;
1216         up_read(&ubi->fm_eba_sem);
1217
1218 out_unlock_buf:
1219         mutex_unlock(&ubi->buf_mutex);
1220 out_unlock_leb:
1221         leb_write_unlock(ubi, vol_id, lnum);
1222         return err;
1223 }
1224
1225 /**
1226  * print_rsvd_warning - warn about not having enough reserved PEBs.
1227  * @ubi: UBI device description object
1228  *
1229  * This is a helper function for 'ubi_eba_init()' which is called when UBI
1230  * cannot reserve enough PEBs for bad block handling. This function makes a
1231  * decision whether we have to print a warning or not. The algorithm is as
1232  * follows:
1233  *   o if this is a new UBI image, then just print the warning
1234  *   o if this is an UBI image which has already been used for some time, print
1235  *     a warning only if we can reserve less than 10% of the expected amount of
1236  *     the reserved PEB.
1237  *
1238  * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1239  * of PEBs becomes smaller, which is normal and we do not want to scare users
1240  * with a warning every time they attach the MTD device. This was an issue
1241  * reported by real users.
1242  */
1243 static void print_rsvd_warning(struct ubi_device *ubi,
1244                                struct ubi_attach_info *ai)
1245 {
1246         /*
1247          * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1248          * large number to distinguish between newly flashed and used images.
1249          */
1250         if (ai->max_sqnum > (1 << 18)) {
1251                 int min = ubi->beb_rsvd_level / 10;
1252
1253                 if (!min)
1254                         min = 1;
1255                 if (ubi->beb_rsvd_pebs > min)
1256                         return;
1257         }
1258
1259         ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
1260                  ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
1261         if (ubi->corr_peb_count)
1262                 ubi_warn(ubi, "%d PEBs are corrupted and not used",
1263                          ubi->corr_peb_count);
1264 }
1265
1266 /**
1267  * self_check_eba - run a self check on the EBA table constructed by fastmap.
1268  * @ubi: UBI device description object
1269  * @ai_fastmap: UBI attach info object created by fastmap
1270  * @ai_scan: UBI attach info object created by scanning
1271  *
1272  * Returns < 0 in case of an internal error, 0 otherwise.
1273  * If a bad EBA table entry was found it will be printed out and
1274  * ubi_assert() triggers.
1275  */
1276 int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1277                    struct ubi_attach_info *ai_scan)
1278 {
1279         int i, j, num_volumes, ret = 0;
1280         int **scan_eba, **fm_eba;
1281         struct ubi_ainf_volume *av;
1282         struct ubi_volume *vol;
1283         struct ubi_ainf_peb *aeb;
1284         struct rb_node *rb;
1285
1286         num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1287
1288         scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1289         if (!scan_eba)
1290                 return -ENOMEM;
1291
1292         fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1293         if (!fm_eba) {
1294                 kfree(scan_eba);
1295                 return -ENOMEM;
1296         }
1297
1298         for (i = 0; i < num_volumes; i++) {
1299                 vol = ubi->volumes[i];
1300                 if (!vol)
1301                         continue;
1302
1303                 scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1304                                       GFP_KERNEL);
1305                 if (!scan_eba[i]) {
1306                         ret = -ENOMEM;
1307                         goto out_free;
1308                 }
1309
1310                 fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1311                                     GFP_KERNEL);
1312                 if (!fm_eba[i]) {
1313                         ret = -ENOMEM;
1314                         goto out_free;
1315                 }
1316
1317                 for (j = 0; j < vol->reserved_pebs; j++)
1318                         scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1319
1320                 av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1321                 if (!av)
1322                         continue;
1323
1324                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1325                         scan_eba[i][aeb->lnum] = aeb->pnum;
1326
1327                 av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1328                 if (!av)
1329                         continue;
1330
1331                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1332                         fm_eba[i][aeb->lnum] = aeb->pnum;
1333
1334                 for (j = 0; j < vol->reserved_pebs; j++) {
1335                         if (scan_eba[i][j] != fm_eba[i][j]) {
1336                                 if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1337                                         fm_eba[i][j] == UBI_LEB_UNMAPPED)
1338                                         continue;
1339
1340                                 ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
1341                                         vol->vol_id, j, fm_eba[i][j],
1342                                         scan_eba[i][j]);
1343                                 ubi_assert(0);
1344                         }
1345                 }
1346         }
1347
1348 out_free:
1349         for (i = 0; i < num_volumes; i++) {
1350                 if (!ubi->volumes[i])
1351                         continue;
1352
1353                 kfree(scan_eba[i]);
1354                 kfree(fm_eba[i]);
1355         }
1356
1357         kfree(scan_eba);
1358         kfree(fm_eba);
1359         return ret;
1360 }
1361
1362 /**
1363  * ubi_eba_init - initialize the EBA sub-system using attaching information.
1364  * @ubi: UBI device description object
1365  * @ai: attaching information
1366  *
1367  * This function returns zero in case of success and a negative error code in
1368  * case of failure.
1369  */
1370 int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
1371 {
1372         int i, j, err, num_volumes;
1373         struct ubi_ainf_volume *av;
1374         struct ubi_volume *vol;
1375         struct ubi_ainf_peb *aeb;
1376         struct rb_node *rb;
1377
1378         dbg_eba("initialize EBA sub-system");
1379
1380         spin_lock_init(&ubi->ltree_lock);
1381         mutex_init(&ubi->alc_mutex);
1382         ubi->ltree = RB_ROOT;
1383
1384         ubi->global_sqnum = ai->max_sqnum + 1;
1385         num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1386
1387         for (i = 0; i < num_volumes; i++) {
1388                 vol = ubi->volumes[i];
1389                 if (!vol)
1390                         continue;
1391
1392                 cond_resched();
1393
1394                 vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int),
1395                                        GFP_KERNEL);
1396                 if (!vol->eba_tbl) {
1397                         err = -ENOMEM;
1398                         goto out_free;
1399                 }
1400
1401                 for (j = 0; j < vol->reserved_pebs; j++)
1402                         vol->eba_tbl[j] = UBI_LEB_UNMAPPED;
1403
1404                 av = ubi_find_av(ai, idx2vol_id(ubi, i));
1405                 if (!av)
1406                         continue;
1407
1408                 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
1409                         if (aeb->lnum >= vol->reserved_pebs)
1410                                 /*
1411                                  * This may happen in case of an unclean reboot
1412                                  * during re-size.
1413                                  */
1414                                 ubi_move_aeb_to_list(av, aeb, &ai->erase);
1415                         else
1416                                 vol->eba_tbl[aeb->lnum] = aeb->pnum;
1417                 }
1418         }
1419
1420         if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
1421                 ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
1422                         ubi->avail_pebs, EBA_RESERVED_PEBS);
1423                 if (ubi->corr_peb_count)
1424                         ubi_err(ubi, "%d PEBs are corrupted and not used",
1425                                 ubi->corr_peb_count);
1426                 err = -ENOSPC;
1427                 goto out_free;
1428         }
1429         ubi->avail_pebs -= EBA_RESERVED_PEBS;
1430         ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1431
1432         if (ubi->bad_allowed) {
1433                 ubi_calculate_reserved(ubi);
1434
1435                 if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1436                         /* No enough free physical eraseblocks */
1437                         ubi->beb_rsvd_pebs = ubi->avail_pebs;
1438                         print_rsvd_warning(ubi, ai);
1439                 } else
1440                         ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1441
1442                 ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1443                 ubi->rsvd_pebs  += ubi->beb_rsvd_pebs;
1444         }
1445
1446         dbg_eba("EBA sub-system is initialized");
1447         return 0;
1448
1449 out_free:
1450         for (i = 0; i < num_volumes; i++) {
1451                 if (!ubi->volumes[i])
1452                         continue;
1453                 kfree(ubi->volumes[i]->eba_tbl);
1454                 ubi->volumes[i]->eba_tbl = NULL;
1455         }
1456         return err;
1457 }