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