drivers/mtd/ubi/vtbl.c

   1 /*
   2  * Copyright (c) International Business Machines Corp., 2006
   3  * Copyright (c) Nokia Corporation, 2006, 2007
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
  13  * the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18  *
  19  * Author: Artem Bityutskiy (Битюцкий Артём)
  20  */
  21
  22 /*
  23  * This file includes volume table manipulation code. The volume table is an
  24  * on-flash table containing volume meta-data like name, number of reserved
  25  * physical eraseblocks, type, etc. The volume table is stored in the so-called
  26  * "layout volume".
  27  *
  28  * The layout volume is an internal volume which is organized as follows. It
  29  * consists of two logical eraseblocks - LEB 0 and LEB 1. Each logical
  30  * eraseblock stores one volume table copy, i.e. LEB 0 and LEB 1 duplicate each
  31  * other. This redundancy guarantees robustness to unclean reboots. The volume
  32  * table is basically an array of volume table records. Each record contains
  33  * full information about the volume and protected by a CRC checksum.
  34  *
  35  * The volume table is changed, it is first changed in RAM. Then LEB 0 is
  36  * erased, and the updated volume table is written back to LEB 0. Then same for
  37  * LEB 1. This scheme guarantees recoverability from unclean reboots.
  38  *
  39  * In this UBI implementation the on-flash volume table does not contain any
  40  * information about how many data static volumes contain. This information may
  41  * be found from the scanning data.
  42  *
  43  * But it would still be beneficial to store this information in the volume
  44  * table. For example, suppose we have a static volume X, and all its physical
  45  * eraseblocks became bad for some reasons. Suppose we are attaching the
  46  * corresponding MTD device, the scanning has found no logical eraseblocks
  47  * corresponding to the volume X. According to the volume table volume X does
  48  * exist. So we don't know whether it is just empty or all its physical
  49  * eraseblocks went bad. So we cannot alarm the user about this corruption.
  50  *
  51  * The volume table also stores so-called "update marker", which is used for
  52  * volume updates. Before updating the volume, the update marker is set, and
  53  * after the update operation is finished, the update marker is cleared. So if
  54  * the update operation was interrupted (e.g. by an unclean reboot) - the
  55  * update marker is still there and we know that the volume's contents is
  56  * damaged.
  57  */
  58
  59 #include <linux/crc32.h>
  60 #include <linux/err.h>
  61 #include <linux/slab.h>
  62 #include <asm/div64.h>
  63 #include "ubi.h"
  64
  65 static void self_vtbl_check(const struct ubi_device *ubi);
  66
  67 /* Empty volume table record */
  68 static struct ubi_vtbl_record empty_vtbl_record;
  69
  70 /**
  71  * ubi_change_vtbl_record - change volume table record.
  72  * @ubi: UBI device description object
  73  * @idx: table index to change
  74  * @vtbl_rec: new volume table record
  75  *
  76  * This function changes volume table record @idx. If @vtbl_rec is %NULL, empty
  77  * volume table record is written. The caller does not have to calculate CRC of
  78  * the record as it is done by this function. Returns zero in case of success
  79  * and a negative error code in case of failure.
  80  */
  81 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
  82                            struct ubi_vtbl_record *vtbl_rec)
  83 {
  84         int i, err;
  85         uint32_t crc;
  86         struct ubi_volume *layout_vol;
  87
  88         ubi_assert(idx >= 0 && idx < ubi->vtbl_slots);
  89         layout_vol = ubi->volumes[vol_id2idx(ubi, UBI_LAYOUT_VOLUME_ID)];
  90
  91         if (!vtbl_rec)
  92                 vtbl_rec = &empty_vtbl_record;
  93         else {
  94                 crc = crc32(UBI_CRC32_INIT, vtbl_rec, UBI_VTBL_RECORD_SIZE_CRC);
  95                 vtbl_rec->crc = cpu_to_be32(crc);
  96         }
  97
  98         memcpy(&ubi->vtbl[idx], vtbl_rec, sizeof(struct ubi_vtbl_record));
  99         for (i = 0; i < UBI_LAYOUT_VOLUME_EBS; i++) {
 100                 err = ubi_eba_unmap_leb(ubi, layout_vol, i);
 101                 if (err)
 102                         return err;
 103
 104                 err = ubi_eba_write_leb(ubi, layout_vol, i, ubi->vtbl, 0,
 105                                         ubi->vtbl_size);
 106                 if (err)
 107                         return err;
 108         }
 109
 110         self_vtbl_check(ubi);
 111         return 0;
 112 }
 113
 114 /**
 115  * ubi_vtbl_rename_volumes - rename UBI volumes in the volume table.
 116  * @ubi: UBI device description object
 117  * @rename_list: list of &struct ubi_rename_entry objects
 118  *
 119  * This function re-names multiple volumes specified in @req in the volume
 120  * table. Returns zero in case of success and a negative error code in case of
 121  * failure.
 122  */
 123 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
 124                             struct list_head *rename_list)
 125 {
 126         int i, err;
 127         struct ubi_rename_entry *re;
 128         struct ubi_volume *layout_vol;
 129
 130         list_for_each_entry(re, rename_list, list) {
 131                 uint32_t crc;
 132                 struct ubi_volume *vol = re->desc->vol;
 133                 struct ubi_vtbl_record *vtbl_rec = &ubi->vtbl[vol->vol_id];
 134
 135                 if (re->remove) {
 136                         memcpy(vtbl_rec, &empty_vtbl_record,
 137                                sizeof(struct ubi_vtbl_record));
 138                         continue;
 139                 }
 140
 141                 vtbl_rec->name_len = cpu_to_be16(re->new_name_len);
 142                 memcpy(vtbl_rec->name, re->new_name, re->new_name_len);
 143                 memset(vtbl_rec->name + re->new_name_len, 0,
 144                        UBI_VOL_NAME_MAX + 1 - re->new_name_len);
 145                 crc = crc32(UBI_CRC32_INIT, vtbl_rec,
 146                             UBI_VTBL_RECORD_SIZE_CRC);
 147                 vtbl_rec->crc = cpu_to_be32(crc);
 148         }
 149
 150         layout_vol = ubi->volumes[vol_id2idx(ubi, UBI_LAYOUT_VOLUME_ID)];
 151         for (i = 0; i < UBI_LAYOUT_VOLUME_EBS; i++) {
 152                 err = ubi_eba_unmap_leb(ubi, layout_vol, i);
 153                 if (err)
 154                         return err;
 155
 156                 err = ubi_eba_write_leb(ubi, layout_vol, i, ubi->vtbl, 0,
 157                                         ubi->vtbl_size);
 158                 if (err)
 159                         return err;
 160         }
 161
 162         return 0;
 163 }
 164
 165 /**
 166  * vtbl_check - check if volume table is not corrupted and sensible.
 167  * @ubi: UBI device description object
 168  * @vtbl: volume table
 169  *
 170  * This function returns zero if @vtbl is all right, %1 if CRC is incorrect,
 171  * and %-EINVAL if it contains inconsistent data.
 172  */
 173 static int vtbl_check(const struct ubi_device *ubi,
 174                       const struct ubi_vtbl_record *vtbl)
 175 {
 176         int i, n, reserved_pebs, alignment, data_pad, vol_type, name_len;
 177         int upd_marker, err;
 178         uint32_t crc;
 179         const char *name;
 180
 181         for (i = 0; i < ubi->vtbl_slots; i++) {
 182                 cond_resched();
 183
 184                 reserved_pebs = be32_to_cpu(vtbl[i].reserved_pebs);
 185                 alignment = be32_to_cpu(vtbl[i].alignment);
 186                 data_pad = be32_to_cpu(vtbl[i].data_pad);
 187                 upd_marker = vtbl[i].upd_marker;
 188                 vol_type = vtbl[i].vol_type;
 189                 name_len = be16_to_cpu(vtbl[i].name_len);
 190                 name = &vtbl[i].name[0];
 191
 192                 crc = crc32(UBI_CRC32_INIT, &vtbl[i], UBI_VTBL_RECORD_SIZE_CRC);
 193                 if (be32_to_cpu(vtbl[i].crc) != crc) {
 194                         ubi_err("bad CRC at record %u: %#08x, not %#08x",
 195                                  i, crc, be32_to_cpu(vtbl[i].crc));
 196                         ubi_dump_vtbl_record(&vtbl[i], i);
 197                         return 1;
 198                 }
 199
 200                 if (reserved_pebs == 0) {
 201                         if (memcmp(&vtbl[i], &empty_vtbl_record,
 202                                                 UBI_VTBL_RECORD_SIZE)) {
 203                                 err = 2;
 204                                 goto bad;
 205                         }
 206                         continue;
 207                 }
 208
 209                 if (reserved_pebs < 0 || alignment < 0 || data_pad < 0 ||
 210                     name_len < 0) {
 211                         err = 3;
 212                         goto bad;
 213                 }
 214
 215                 if (alignment > ubi->leb_size || alignment == 0) {
 216                         err = 4;
 217                         goto bad;
 218                 }
 219
 220                 n = alignment & (ubi->min_io_size - 1);
 221                 if (alignment != 1 && n) {
 222                         err = 5;
 223                         goto bad;
 224                 }
 225
 226                 n = ubi->leb_size % alignment;
 227                 if (data_pad != n) {
 228                         ubi_err("bad data_pad, has to be %d", n);
 229                         err = 6;
 230                         goto bad;
 231                 }
 232
 233                 if (vol_type != UBI_VID_DYNAMIC && vol_type != UBI_VID_STATIC) {
 234                         err = 7;
 235                         goto bad;
 236                 }
 237
 238                 if (upd_marker != 0 && upd_marker != 1) {
 239                         err = 8;
 240                         goto bad;
 241                 }
 242
 243                 if (reserved_pebs > ubi->good_peb_count) {
 244                         ubi_err("too large reserved_pebs %d, good PEBs %d",
 245                                 reserved_pebs, ubi->good_peb_count);
 246                         err = 9;
 247                         goto bad;
 248                 }
 249
 250                 if (name_len > UBI_VOL_NAME_MAX) {
 251                         err = 10;
 252                         goto bad;
 253                 }
 254
 255                 if (name[0] == '\0') {
 256                         err = 11;
 257                         goto bad;
 258                 }
 259
 260                 if (name_len != strnlen(name, name_len + 1)) {
 261                         err = 12;
 262                         goto bad;
 263                 }
 264         }
 265
 266         /* Checks that all names are unique */
 267         for (i = 0; i < ubi->vtbl_slots - 1; i++) {
 268                 for (n = i + 1; n < ubi->vtbl_slots; n++) {
 269                         int len1 = be16_to_cpu(vtbl[i].name_len);
 270                         int len2 = be16_to_cpu(vtbl[n].name_len);
 271
 272                         if (len1 > 0 && len1 == len2 &&
 273                             !strncmp(vtbl[i].name, vtbl[n].name, len1)) {
 274                                 ubi_err("volumes %d and %d have the same name"
 275                                         " \"%s\"", i, n, vtbl[i].name);
 276                                 ubi_dump_vtbl_record(&vtbl[i], i);
 277                                 ubi_dump_vtbl_record(&vtbl[n], n);
 278                                 return -EINVAL;
 279                         }
 280                 }
 281         }
 282
 283         return 0;
 284
 285 bad:
 286         ubi_err("volume table check failed: record %d, error %d", i, err);
 287         ubi_dump_vtbl_record(&vtbl[i], i);
 288         return -EINVAL;
 289 }
 290
 291 /**
 292  * create_vtbl - create a copy of volume table.
 293  * @ubi: UBI device description object
 294  * @si: scanning information
 295  * @copy: number of the volume table copy
 296  * @vtbl: contents of the volume table
 297  *
 298  * This function returns zero in case of success and a negative error code in
 299  * case of failure.
 300  */
 301 static int create_vtbl(struct ubi_device *ubi, struct ubi_attach_info *si,
 302                        int copy, void *vtbl)
 303 {
 304         int err, tries = 0;
 305         struct ubi_vid_hdr *vid_hdr;
 306         struct ubi_ainf_peb *new_aeb;
 307
 308         ubi_msg("create volume table (copy #%d)", copy + 1);
 309
 310         vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_KERNEL);
 311         if (!vid_hdr)
 312                 return -ENOMEM;
 313
 314 retry:
 315         new_aeb = ubi_scan_get_free_peb(ubi, si);
 316         if (IS_ERR(new_aeb)) {
 317                 err = PTR_ERR(new_aeb);
 318                 goto out_free;
 319         }
 320
 321         vid_hdr->vol_type = UBI_LAYOUT_VOLUME_TYPE;
 322         vid_hdr->vol_id = cpu_to_be32(UBI_LAYOUT_VOLUME_ID);
 323         vid_hdr->compat = UBI_LAYOUT_VOLUME_COMPAT;
 324         vid_hdr->data_size = vid_hdr->used_ebs =
 325                              vid_hdr->data_pad = cpu_to_be32(0);
 326         vid_hdr->lnum = cpu_to_be32(copy);
 327         vid_hdr->sqnum = cpu_to_be64(++si->max_sqnum);
 328
 329         /* The EC header is already there, write the VID header */
 330         err = ubi_io_write_vid_hdr(ubi, new_aeb->pnum, vid_hdr);
 331         if (err)
 332                 goto write_error;
 333
 334         /* Write the layout volume contents */
 335         err = ubi_io_write_data(ubi, vtbl, new_aeb->pnum, 0, ubi->vtbl_size);
 336         if (err)
 337                 goto write_error;
 338
 339         /*
 340          * And add it to the scanning information. Don't delete the old version
 341          * of this LEB as it will be deleted and freed in 'ubi_scan_add_used()'.
 342          */
 343         err = ubi_scan_add_used(ubi, si, new_aeb->pnum, new_aeb->ec,
 344                                 vid_hdr, 0);
 345         kfree(new_aeb);
 346         ubi_free_vid_hdr(ubi, vid_hdr);
 347         return err;
 348
 349 write_error:
 350         if (err == -EIO && ++tries <= 5) {
 351                 /*
 352                  * Probably this physical eraseblock went bad, try to pick
 353                  * another one.
 354                  */
 355                 list_add(&new_aeb->u.list, &si->erase);
 356                 goto retry;
 357         }
 358         kfree(new_aeb);
 359 out_free:
 360         ubi_free_vid_hdr(ubi, vid_hdr);
 361         return err;
 362
 363 }
 364
 365 /**
 366  * process_lvol - process the layout volume.
 367  * @ubi: UBI device description object
 368  * @si: scanning information
 369  * @sv: layout volume scanning information
 370  *
 371  * This function is responsible for reading the layout volume, ensuring it is
 372  * not corrupted, and recovering from corruptions if needed. Returns volume
 373  * table in case of success and a negative error code in case of failure.
 374  */
 375 static struct ubi_vtbl_record *process_lvol(struct ubi_device *ubi,
 376                                             struct ubi_attach_info *si,
 377                                             struct ubi_ainf_volume *sv)
 378 {
 379         int err;
 380         struct rb_node *rb;
 381         struct ubi_ainf_peb *aeb;
 382         struct ubi_vtbl_record *leb[UBI_LAYOUT_VOLUME_EBS] = { NULL, NULL };
 383         int leb_corrupted[UBI_LAYOUT_VOLUME_EBS] = {1, 1};
 384
 385         /*
 386          * UBI goes through the following steps when it changes the layout
 387          * volume:
 388          * a. erase LEB 0;
 389          * b. write new data to LEB 0;
 390          * c. erase LEB 1;
 391          * d. write new data to LEB 1.
 392          *
 393          * Before the change, both LEBs contain the same data.
 394          *
 395          * Due to unclean reboots, the contents of LEB 0 may be lost, but there
 396          * should LEB 1. So it is OK if LEB 0 is corrupted while LEB 1 is not.
 397          * Similarly, LEB 1 may be lost, but there should be LEB 0. And
 398          * finally, unclean reboots may result in a situation when neither LEB
 399          * 0 nor LEB 1 are corrupted, but they are different. In this case, LEB
 400          * 0 contains more recent information.
 401          *
 402          * So the plan is to first check LEB 0. Then
 403          * a. if LEB 0 is OK, it must be containing the most recent data; then
 404          *    we compare it with LEB 1, and if they are different, we copy LEB
 405          *    0 to LEB 1;
 406          * b. if LEB 0 is corrupted, but LEB 1 has to be OK, and we copy LEB 1
 407          *    to LEB 0.
 408          */
 409
 410         dbg_gen("check layout volume");
 411
 412         /* Read both LEB 0 and LEB 1 into memory */
 413         ubi_rb_for_each_entry(rb, aeb, &sv->root, u.rb) {
 414                 leb[aeb->lnum] = vzalloc(ubi->vtbl_size);
 415                 if (!leb[aeb->lnum]) {
 416                         err = -ENOMEM;
 417                         goto out_free;
 418                 }
 419
 420                 err = ubi_io_read_data(ubi, leb[aeb->lnum], aeb->pnum, 0,
 421                                        ubi->vtbl_size);
 422                 if (err == UBI_IO_BITFLIPS || mtd_is_eccerr(err))
 423                         /*
 424                          * Scrub the PEB later. Note, -EBADMSG indicates an
 425                          * uncorrectable ECC error, but we have our own CRC and
 426                          * the data will be checked later. If the data is OK,
 427                          * the PEB will be scrubbed (because we set
 428                          * aeb->scrub). If the data is not OK, the contents of
 429                          * the PEB will be recovered from the second copy, and
 430                          * aeb->scrub will be cleared in
 431                          * 'ubi_scan_add_used()'.
 432                          */
 433                         aeb->scrub = 1;
 434                 else if (err)
 435                         goto out_free;
 436         }
 437
 438         err = -EINVAL;
 439         if (leb[0]) {
 440                 leb_corrupted[0] = vtbl_check(ubi, leb[0]);
 441                 if (leb_corrupted[0] < 0)
 442                         goto out_free;
 443         }
 444
 445         if (!leb_corrupted[0]) {
 446                 /* LEB 0 is OK */
 447                 if (leb[1])
 448                         leb_corrupted[1] = memcmp(leb[0], leb[1],
 449                                                   ubi->vtbl_size);
 450                 if (leb_corrupted[1]) {
 451                         ubi_warn("volume table copy #2 is corrupted");
 452                         err = create_vtbl(ubi, si, 1, leb[0]);
 453                         if (err)
 454                                 goto out_free;
 455                         ubi_msg("volume table was restored");
 456                 }
 457
 458                 /* Both LEB 1 and LEB 2 are OK and consistent */
 459                 vfree(leb[1]);
 460                 return leb[0];
 461         } else {
 462                 /* LEB 0 is corrupted or does not exist */
 463                 if (leb[1]) {
 464                         leb_corrupted[1] = vtbl_check(ubi, leb[1]);
 465                         if (leb_corrupted[1] < 0)
 466                                 goto out_free;
 467                 }
 468                 if (leb_corrupted[1]) {
 469                         /* Both LEB 0 and LEB 1 are corrupted */
 470                         ubi_err("both volume tables are corrupted");
 471                         goto out_free;
 472                 }
 473
 474                 ubi_warn("volume table copy #1 is corrupted");
 475                 err = create_vtbl(ubi, si, 0, leb[1]);
 476                 if (err)
 477                         goto out_free;
 478                 ubi_msg("volume table was restored");
 479
 480                 vfree(leb[0]);
 481                 return leb[1];
 482         }
 483
 484 out_free:
 485         vfree(leb[0]);
 486         vfree(leb[1]);
 487         return ERR_PTR(err);
 488 }
 489
 490 /**
 491  * create_empty_lvol - create empty layout volume.
 492  * @ubi: UBI device description object
 493  * @si: scanning information
 494  *
 495  * This function returns volume table contents in case of success and a
 496  * negative error code in case of failure.
 497  */
 498 static struct ubi_vtbl_record *create_empty_lvol(struct ubi_device *ubi,
 499                                                  struct ubi_attach_info *si)
 500 {
 501         int i;
 502         struct ubi_vtbl_record *vtbl;
 503
 504         vtbl = vzalloc(ubi->vtbl_size);
 505         if (!vtbl)
 506                 return ERR_PTR(-ENOMEM);
 507
 508         for (i = 0; i < ubi->vtbl_slots; i++)
 509                 memcpy(&vtbl[i], &empty_vtbl_record, UBI_VTBL_RECORD_SIZE);
 510
 511         for (i = 0; i < UBI_LAYOUT_VOLUME_EBS; i++) {
 512                 int err;
 513
 514                 err = create_vtbl(ubi, si, i, vtbl);
 515                 if (err) {
 516                         vfree(vtbl);
 517                         return ERR_PTR(err);
 518                 }
 519         }
 520
 521         return vtbl;
 522 }
 523
 524 /**
 525  * init_volumes - initialize volume information for existing volumes.
 526  * @ubi: UBI device description object
 527  * @si: scanning information
 528  * @vtbl: volume table
 529  *
 530  * This function allocates volume description objects for existing volumes.
 531  * Returns zero in case of success and a negative error code in case of
 532  * failure.
 533  */
 534 static int init_volumes(struct ubi_device *ubi,
 535                         const struct ubi_attach_info *si,
 536                         const struct ubi_vtbl_record *vtbl)
 537 {
 538         int i, reserved_pebs = 0;
 539         struct ubi_ainf_volume *sv;
 540         struct ubi_volume *vol;
 541
 542         for (i = 0; i < ubi->vtbl_slots; i++) {
 543                 cond_resched();
 544
 545                 if (be32_to_cpu(vtbl[i].reserved_pebs) == 0)
 546                         continue; /* Empty record */
 547
 548                 vol = kzalloc(sizeof(struct ubi_volume), GFP_KERNEL);
 549                 if (!vol)
 550                         return -ENOMEM;
 551
 552                 vol->reserved_pebs = be32_to_cpu(vtbl[i].reserved_pebs);
 553                 vol->alignment = be32_to_cpu(vtbl[i].alignment);
 554                 vol->data_pad = be32_to_cpu(vtbl[i].data_pad);
 555                 vol->upd_marker = vtbl[i].upd_marker;
 556                 vol->vol_type = vtbl[i].vol_type == UBI_VID_DYNAMIC ?
 557                                         UBI_DYNAMIC_VOLUME : UBI_STATIC_VOLUME;
 558                 vol->name_len = be16_to_cpu(vtbl[i].name_len);
 559                 vol->usable_leb_size = ubi->leb_size - vol->data_pad;
 560                 memcpy(vol->name, vtbl[i].name, vol->name_len);
 561                 vol->name[vol->name_len] = '\0';
 562                 vol->vol_id = i;
 563
 564                 if (vtbl[i].flags & UBI_VTBL_AUTORESIZE_FLG) {
 565                         /* Auto re-size flag may be set only for one volume */
 566                         if (ubi->autoresize_vol_id != -1) {
 567                                 ubi_err("more than one auto-resize volume (%d "
 568                                         "and %d)", ubi->autoresize_vol_id, i);
 569                                 kfree(vol);
 570                                 return -EINVAL;
 571                         }
 572
 573                         ubi->autoresize_vol_id = i;
 574                 }
 575
 576                 ubi_assert(!ubi->volumes[i]);
 577                 ubi->volumes[i] = vol;
 578                 ubi->vol_count += 1;
 579                 vol->ubi = ubi;
 580                 reserved_pebs += vol->reserved_pebs;
 581
 582                 /*
 583                  * In case of dynamic volume UBI knows nothing about how many
 584                  * data is stored there. So assume the whole volume is used.
 585                  */
 586                 if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
 587                         vol->used_ebs = vol->reserved_pebs;
 588                         vol->last_eb_bytes = vol->usable_leb_size;
 589                         vol->used_bytes =
 590                                 (long long)vol->used_ebs * vol->usable_leb_size;
 591                         continue;
 592                 }
 593
 594                 /* Static volumes only */
 595                 sv = ubi_scan_find_sv(si, i);
 596                 if (!sv) {
 597                         /*
 598                          * No eraseblocks belonging to this volume found. We
 599                          * don't actually know whether this static volume is
 600                          * completely corrupted or just contains no data. And
 601                          * we cannot know this as long as data size is not
 602                          * stored on flash. So we just assume the volume is
 603                          * empty. FIXME: this should be handled.
 604                          */
 605                         continue;
 606                 }
 607
 608                 if (sv->leb_count != sv->used_ebs) {
 609                         /*
 610                          * We found a static volume which misses several
 611                          * eraseblocks. Treat it as corrupted.
 612                          */
 613                         ubi_warn("static volume %d misses %d LEBs - corrupted",
 614                                  sv->vol_id, sv->used_ebs - sv->leb_count);
 615                         vol->corrupted = 1;
 616                         continue;
 617                 }
 618
 619                 vol->used_ebs = sv->used_ebs;
 620                 vol->used_bytes =
 621                         (long long)(vol->used_ebs - 1) * vol->usable_leb_size;
 622                 vol->used_bytes += sv->last_data_size;
 623                 vol->last_eb_bytes = sv->last_data_size;
 624         }
 625
 626         /* And add the layout volume */
 627         vol = kzalloc(sizeof(struct ubi_volume), GFP_KERNEL);
 628         if (!vol)
 629                 return -ENOMEM;
 630
 631         vol->reserved_pebs = UBI_LAYOUT_VOLUME_EBS;
 632         vol->alignment = UBI_LAYOUT_VOLUME_ALIGN;
 633         vol->vol_type = UBI_DYNAMIC_VOLUME;
 634         vol->name_len = sizeof(UBI_LAYOUT_VOLUME_NAME) - 1;
 635         memcpy(vol->name, UBI_LAYOUT_VOLUME_NAME, vol->name_len + 1);
 636         vol->usable_leb_size = ubi->leb_size;
 637         vol->used_ebs = vol->reserved_pebs;
 638         vol->last_eb_bytes = vol->reserved_pebs;
 639         vol->used_bytes =
 640                 (long long)vol->used_ebs * (ubi->leb_size - vol->data_pad);
 641         vol->vol_id = UBI_LAYOUT_VOLUME_ID;
 642         vol->ref_count = 1;
 643
 644         ubi_assert(!ubi->volumes[i]);
 645         ubi->volumes[vol_id2idx(ubi, vol->vol_id)] = vol;
 646         reserved_pebs += vol->reserved_pebs;
 647         ubi->vol_count += 1;
 648         vol->ubi = ubi;
 649
 650         if (reserved_pebs > ubi->avail_pebs) {
 651                 ubi_err("not enough PEBs, required %d, available %d",
 652                         reserved_pebs, ubi->avail_pebs);
 653                 if (ubi->corr_peb_count)
 654                         ubi_err("%d PEBs are corrupted and not used",
 655                                 ubi->corr_peb_count);
 656         }
 657         ubi->rsvd_pebs += reserved_pebs;
 658         ubi->avail_pebs -= reserved_pebs;
 659
 660         return 0;
 661 }
 662
 663 /**
 664  * check_sv - check volume scanning information.
 665  * @vol: UBI volume description object
 666  * @sv: volume scanning information
 667  *
 668  * This function returns zero if the volume scanning information is consistent
 669  * to the data read from the volume tabla, and %-EINVAL if not.
 670  */
 671 static int check_sv(const struct ubi_volume *vol,
 672                     const struct ubi_ainf_volume *sv)
 673 {
 674         int err;
 675
 676         if (sv->highest_lnum >= vol->reserved_pebs) {
 677                 err = 1;
 678                 goto bad;
 679         }
 680         if (sv->leb_count > vol->reserved_pebs) {
 681                 err = 2;
 682                 goto bad;
 683         }
 684         if (sv->vol_type != vol->vol_type) {
 685                 err = 3;
 686                 goto bad;
 687         }
 688         if (sv->used_ebs > vol->reserved_pebs) {
 689                 err = 4;
 690                 goto bad;
 691         }
 692         if (sv->data_pad != vol->data_pad) {
 693                 err = 5;
 694                 goto bad;
 695         }
 696         return 0;
 697
 698 bad:
 699         ubi_err("bad scanning information, error %d", err);
 700         ubi_dump_sv(sv);
 701         ubi_dump_vol_info(vol);
 702         return -EINVAL;
 703 }
 704
 705 /**
 706  * check_scanning_info - check that scanning information.
 707  * @ubi: UBI device description object
 708  * @si: scanning information
 709  *
 710  * Even though we protect on-flash data by CRC checksums, we still don't trust
 711  * the media. This function ensures that scanning information is consistent to
 712  * the information read from the volume table. Returns zero if the scanning
 713  * information is OK and %-EINVAL if it is not.
 714  */
 715 static int check_scanning_info(const struct ubi_device *ubi,
 716                                struct ubi_attach_info *si)
 717 {
 718         int err, i;
 719         struct ubi_ainf_volume *sv;
 720         struct ubi_volume *vol;
 721
 722         if (si->vols_found > UBI_INT_VOL_COUNT + ubi->vtbl_slots) {
 723                 ubi_err("scanning found %d volumes, maximum is %d + %d",
 724                         si->vols_found, UBI_INT_VOL_COUNT, ubi->vtbl_slots);
 725                 return -EINVAL;
 726         }
 727
 728         if (si->highest_vol_id >= ubi->vtbl_slots + UBI_INT_VOL_COUNT &&
 729             si->highest_vol_id < UBI_INTERNAL_VOL_START) {
 730                 ubi_err("too large volume ID %d found by scanning",
 731                         si->highest_vol_id);
 732                 return -EINVAL;
 733         }
 734
 735         for (i = 0; i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
 736                 cond_resched();
 737
 738                 sv = ubi_scan_find_sv(si, i);
 739                 vol = ubi->volumes[i];
 740                 if (!vol) {
 741                         if (sv)
 742                                 ubi_scan_rm_volume(si, sv);
 743                         continue;
 744                 }
 745
 746                 if (vol->reserved_pebs == 0) {
 747                         ubi_assert(i < ubi->vtbl_slots);
 748
 749                         if (!sv)
 750                                 continue;
 751
 752                         /*
 753                          * During scanning we found a volume which does not
 754                          * exist according to the information in the volume
 755                          * table. This must have happened due to an unclean
 756                          * reboot while the volume was being removed. Discard
 757                          * these eraseblocks.
 758                          */
 759                         ubi_msg("finish volume %d removal", sv->vol_id);
 760                         ubi_scan_rm_volume(si, sv);
 761                 } else if (sv) {
 762                         err = check_sv(vol, sv);
 763                         if (err)
 764                                 return err;
 765                 }
 766         }
 767
 768         return 0;
 769 }
 770
 771 /**
 772  * ubi_read_volume_table - read the volume table.
 773  * @ubi: UBI device description object
 774  * @si: scanning information
 775  *
 776  * This function reads volume table, checks it, recover from errors if needed,
 777  * or creates it if needed. Returns zero in case of success and a negative
 778  * error code in case of failure.
 779  */
 780 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *si)
 781 {
 782         int i, err;
 783         struct ubi_ainf_volume *sv;
 784
 785         empty_vtbl_record.crc = cpu_to_be32(0xf116c36b);
 786
 787         /*
 788          * The number of supported volumes is limited by the eraseblock size
 789          * and by the UBI_MAX_VOLUMES constant.
 790          */
 791         ubi->vtbl_slots = ubi->leb_size / UBI_VTBL_RECORD_SIZE;
 792         if (ubi->vtbl_slots > UBI_MAX_VOLUMES)
 793                 ubi->vtbl_slots = UBI_MAX_VOLUMES;
 794
 795         ubi->vtbl_size = ubi->vtbl_slots * UBI_VTBL_RECORD_SIZE;
 796         ubi->vtbl_size = ALIGN(ubi->vtbl_size, ubi->min_io_size);
 797
 798         sv = ubi_scan_find_sv(si, UBI_LAYOUT_VOLUME_ID);
 799         if (!sv) {
 800                 /*
 801                  * No logical eraseblocks belonging to the layout volume were
 802                  * found. This could mean that the flash is just empty. In
 803                  * this case we create empty layout volume.
 804                  *
 805                  * But if flash is not empty this must be a corruption or the
 806                  * MTD device just contains garbage.
 807                  */
 808                 if (si->is_empty) {
 809                         ubi->vtbl = create_empty_lvol(ubi, si);
 810                         if (IS_ERR(ubi->vtbl))
 811                                 return PTR_ERR(ubi->vtbl);
 812                 } else {
 813                         ubi_err("the layout volume was not found");
 814                         return -EINVAL;
 815                 }
 816         } else {
 817                 if (sv->leb_count > UBI_LAYOUT_VOLUME_EBS) {
 818                         /* This must not happen with proper UBI images */
 819                         ubi_err("too many LEBs (%d) in layout volume",
 820                                 sv->leb_count);
 821                         return -EINVAL;
 822                 }
 823
 824                 ubi->vtbl = process_lvol(ubi, si, sv);
 825                 if (IS_ERR(ubi->vtbl))
 826                         return PTR_ERR(ubi->vtbl);
 827         }
 828
 829         ubi->avail_pebs = ubi->good_peb_count - ubi->corr_peb_count;
 830
 831         /*
 832          * The layout volume is OK, initialize the corresponding in-RAM data
 833          * structures.
 834          */
 835         err = init_volumes(ubi, si, ubi->vtbl);
 836         if (err)
 837                 goto out_free;
 838
 839         /*
 840          * Make sure that the scanning information is consistent to the
 841          * information stored in the volume table.
 842          */
 843         err = check_scanning_info(ubi, si);
 844         if (err)
 845                 goto out_free;
 846
 847         return 0;
 848
 849 out_free:
 850         vfree(ubi->vtbl);
 851         for (i = 0; i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
 852                 kfree(ubi->volumes[i]);
 853                 ubi->volumes[i] = NULL;
 854         }
 855         return err;
 856 }
 857
 858 /**
 859  * self_vtbl_check - check volume table.
 860  * @ubi: UBI device description object
 861  */
 862 static void self_vtbl_check(const struct ubi_device *ubi)
 863 {
 864         if (!ubi->dbg->chk_gen)
 865                 return;
 866
 867         if (vtbl_check(ubi, ubi->vtbl)) {
 868                 ubi_err("self-check failed");
 869                 BUG();
 870         }
 871 }