drivers/mtd/ubi/vmt.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  * This file contains implementation of volume creation, deletion, updating and
  23  * resizing.
  24  */
  25
  26 #include <linux/err.h>
  27 #include <asm/div64.h>
  28 #include "ubi.h"
  29
  30 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
  31 static void paranoid_check_volumes(struct ubi_device *ubi);
  32 #else
  33 #define paranoid_check_volumes(ubi)
  34 #endif
  35
  36 static ssize_t vol_attribute_show(struct device *dev,
  37                                   struct device_attribute *attr, char *buf);
  38
  39 /* Device attributes corresponding to files in '/<sysfs>/class/ubi/ubiX_Y' */
  40 static struct device_attribute attr_vol_reserved_ebs =
  41         __ATTR(reserved_ebs, S_IRUGO, vol_attribute_show, NULL);
  42 static struct device_attribute attr_vol_type =
  43         __ATTR(type, S_IRUGO, vol_attribute_show, NULL);
  44 static struct device_attribute attr_vol_name =
  45         __ATTR(name, S_IRUGO, vol_attribute_show, NULL);
  46 static struct device_attribute attr_vol_corrupted =
  47         __ATTR(corrupted, S_IRUGO, vol_attribute_show, NULL);
  48 static struct device_attribute attr_vol_alignment =
  49         __ATTR(alignment, S_IRUGO, vol_attribute_show, NULL);
  50 static struct device_attribute attr_vol_usable_eb_size =
  51         __ATTR(usable_eb_size, S_IRUGO, vol_attribute_show, NULL);
  52 static struct device_attribute attr_vol_data_bytes =
  53         __ATTR(data_bytes, S_IRUGO, vol_attribute_show, NULL);
  54 static struct device_attribute attr_vol_upd_marker =
  55         __ATTR(upd_marker, S_IRUGO, vol_attribute_show, NULL);
  56
  57 /*
  58  * "Show" method for files in '/<sysfs>/class/ubi/ubiX_Y/'.
  59  *
  60  * Consider a situation:
  61  * A. process 1 opens a sysfs file related to volume Y, say
  62  *    /<sysfs>/class/ubi/ubiX_Y/reserved_ebs;
  63  * B. process 2 removes volume Y;
  64  * C. process 1 starts reading the /<sysfs>/class/ubi/ubiX_Y/reserved_ebs file;
  65  *
  66  * What we want to do in a situation like that is to return error when the file
  67  * is read. This is done by means of the 'removed' flag and the 'vol_lock' of
  68  * the UBI volume description object.
  69  */
  70 static ssize_t vol_attribute_show(struct device *dev,
  71                                   struct device_attribute *attr, char *buf)
  72 {
  73         int ret = -ENODEV;
  74         struct ubi_volume *vol = container_of(dev, struct ubi_volume, dev);
  75
  76         spin_lock(&vol->ubi->volumes_lock);
  77         if (vol->removed) {
  78                 spin_unlock(&vol->ubi->volumes_lock);
  79                 return ret;
  80         }
  81
  82         if (attr == &attr_vol_reserved_ebs)
  83                 ret = sprintf(buf, "%d\n", vol->reserved_pebs);
  84         else if (attr == &attr_vol_type) {
  85                 const char *tp;
  86
  87                 if (vol->vol_type == UBI_DYNAMIC_VOLUME)
  88                         tp = "dynamic";
  89                 else
  90                         tp = "static";
  91                 ret = sprintf(buf, "%s\n", tp);
  92         } else if (attr == &attr_vol_name)
  93                 ret = sprintf(buf, "%s\n", vol->name);
  94         else if (attr == &attr_vol_corrupted)
  95                 ret = sprintf(buf, "%d\n", vol->corrupted);
  96         else if (attr == &attr_vol_alignment)
  97                 ret = sprintf(buf, "%d\n", vol->alignment);
  98         else if (attr == &attr_vol_usable_eb_size)
  99                 ret = sprintf(buf, "%d\n", vol->usable_leb_size);
 100         else if (attr == &attr_vol_data_bytes)
 101                 ret = sprintf(buf, "%lld\n", vol->used_bytes);
 102         else if (attr == &attr_vol_upd_marker)
 103                 ret = sprintf(buf, "%d\n", vol->upd_marker);
 104         else
 105                 BUG();
 106         spin_unlock(&vol->ubi->volumes_lock);
 107         return ret;
 108 }
 109
 110 /* Release method for volume devices */
 111 static void vol_release(struct device *dev)
 112 {
 113         struct ubi_volume *vol = container_of(dev, struct ubi_volume, dev);
 114
 115         ubi_assert(vol->removed);
 116         kfree(vol);
 117 }
 118
 119 /**
 120  * volume_sysfs_init - initialize sysfs for new volume.
 121  * @ubi: UBI device description object
 122  * @vol: volume description object
 123  *
 124  * This function returns zero in case of success and a negative error code in
 125  * case of failure.
 126  *
 127  * Note, this function does not free allocated resources in case of failure -
 128  * the caller does it. This is because this would cause release() here and the
 129  * caller would oops.
 130  */
 131 static int volume_sysfs_init(struct ubi_device *ubi, struct ubi_volume *vol)
 132 {
 133         int err;
 134
 135         err = device_create_file(&vol->dev, &attr_vol_reserved_ebs);
 136         if (err)
 137                 return err;
 138         err = device_create_file(&vol->dev, &attr_vol_type);
 139         if (err)
 140                 return err;
 141         err = device_create_file(&vol->dev, &attr_vol_name);
 142         if (err)
 143                 return err;
 144         err = device_create_file(&vol->dev, &attr_vol_corrupted);
 145         if (err)
 146                 return err;
 147         err = device_create_file(&vol->dev, &attr_vol_alignment);
 148         if (err)
 149                 return err;
 150         err = device_create_file(&vol->dev, &attr_vol_usable_eb_size);
 151         if (err)
 152                 return err;
 153         err = device_create_file(&vol->dev, &attr_vol_data_bytes);
 154         if (err)
 155                 return err;
 156         err = device_create_file(&vol->dev, &attr_vol_upd_marker);
 157         if (err)
 158                 return err;
 159         return 0;
 160 }
 161
 162 /**
 163  * volume_sysfs_close - close sysfs for a volume.
 164  * @vol: volume description object
 165  */
 166 static void volume_sysfs_close(struct ubi_volume *vol)
 167 {
 168         device_remove_file(&vol->dev, &attr_vol_upd_marker);
 169         device_remove_file(&vol->dev, &attr_vol_data_bytes);
 170         device_remove_file(&vol->dev, &attr_vol_usable_eb_size);
 171         device_remove_file(&vol->dev, &attr_vol_alignment);
 172         device_remove_file(&vol->dev, &attr_vol_corrupted);
 173         device_remove_file(&vol->dev, &attr_vol_name);
 174         device_remove_file(&vol->dev, &attr_vol_type);
 175         device_remove_file(&vol->dev, &attr_vol_reserved_ebs);
 176         device_unregister(&vol->dev);
 177 }
 178
 179 /**
 180  * ubi_create_volume - create volume.
 181  * @ubi: UBI device description object
 182  * @req: volume creation request
 183  *
 184  * This function creates volume described by @req. If @req->vol_id id
 185  * %UBI_VOL_NUM_AUTO, this function automatically assigne ID to the new volume
 186  * and saves it in @req->vol_id. Returns zero in case of success and a negative
 187  * error code in case of failure.
 188  */
 189 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req)
 190 {
 191         int i, err, vol_id = req->vol_id;
 192         struct ubi_volume *vol;
 193         struct ubi_vtbl_record vtbl_rec;
 194         uint64_t bytes;
 195         dev_t dev;
 196
 197         if (ubi->ro_mode)
 198                 return -EROFS;
 199
 200         vol = kzalloc(sizeof(struct ubi_volume), GFP_KERNEL);
 201         if (!vol)
 202                 return -ENOMEM;
 203
 204         spin_lock(&ubi->volumes_lock);
 205
 206         if (vol_id == UBI_VOL_NUM_AUTO) {
 207                 /* Find unused volume ID */
 208                 dbg_msg("search for vacant volume ID");
 209                 for (i = 0; i < ubi->vtbl_slots; i++)
 210                         if (!ubi->volumes[i]) {
 211                                 vol_id = i;
 212                                 break;
 213                         }
 214
 215                 if (vol_id == UBI_VOL_NUM_AUTO) {
 216                         dbg_err("out of volume IDs");
 217                         err = -ENFILE;
 218                         goto out_unlock;
 219                 }
 220                 req->vol_id = vol_id;
 221         }
 222
 223         dbg_msg("volume ID %d, %llu bytes, type %d, name %s",
 224                 vol_id, (unsigned long long)req->bytes,
 225                 (int)req->vol_type, req->name);
 226
 227         /* Ensure that this volume does not exist */
 228         err = -EEXIST;
 229         if (ubi->volumes[vol_id]) {
 230                 dbg_err("volume %d already exists", vol_id);
 231                 goto out_unlock;
 232         }
 233
 234         /* Ensure that the name is unique */
 235         for (i = 0; i < ubi->vtbl_slots; i++)
 236                 if (ubi->volumes[i] &&
 237                     ubi->volumes[i]->name_len == req->name_len &&
 238                     !strcmp(ubi->volumes[i]->name, req->name)) {
 239                         dbg_err("volume \"%s\" exists (ID %d)", req->name, i);
 240                         goto out_unlock;
 241                 }
 242
 243         /* Calculate how many eraseblocks are requested */
 244         vol->usable_leb_size = ubi->leb_size - ubi->leb_size % req->alignment;
 245         bytes = req->bytes;
 246         if (do_div(bytes, vol->usable_leb_size))
 247                 vol->reserved_pebs = 1;
 248         vol->reserved_pebs += bytes;
 249
 250         /* Reserve physical eraseblocks */
 251         if (vol->reserved_pebs > ubi->avail_pebs) {
 252                 dbg_err("not enough PEBs, only %d available", ubi->avail_pebs);
 253                 err = -ENOSPC;
 254                 goto out_unlock;
 255         }
 256         ubi->avail_pebs -= vol->reserved_pebs;
 257         ubi->rsvd_pebs += vol->reserved_pebs;
 258
 259         vol->vol_id    = vol_id;
 260         vol->alignment = req->alignment;
 261         vol->data_pad  = ubi->leb_size % vol->alignment;
 262         vol->vol_type  = req->vol_type;
 263         vol->name_len  = req->name_len;
 264         memcpy(vol->name, req->name, vol->name_len + 1);
 265         vol->exclusive = 1;
 266         vol->ubi = ubi;
 267         ubi->volumes[vol_id] = vol;
 268         spin_unlock(&ubi->volumes_lock);
 269
 270         /*
 271          * Finish all pending erases because there may be some LEBs belonging
 272          * to the same volume ID.
 273          */
 274         err = ubi_wl_flush(ubi);
 275         if (err)
 276                 goto out_acc;
 277
 278         vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int), GFP_KERNEL);
 279         if (!vol->eba_tbl) {
 280                 err = -ENOMEM;
 281                 goto out_acc;
 282         }
 283
 284         for (i = 0; i < vol->reserved_pebs; i++)
 285                 vol->eba_tbl[i] = UBI_LEB_UNMAPPED;
 286
 287         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
 288                 vol->used_ebs = vol->reserved_pebs;
 289                 vol->last_eb_bytes = vol->usable_leb_size;
 290                 vol->used_bytes =
 291                         (long long)vol->used_ebs * vol->usable_leb_size;
 292         } else {
 293                 bytes = vol->used_bytes;
 294                 vol->last_eb_bytes = do_div(bytes, vol->usable_leb_size);
 295                 vol->used_ebs = bytes;
 296                 if (vol->last_eb_bytes)
 297                         vol->used_ebs += 1;
 298                 else
 299                         vol->last_eb_bytes = vol->usable_leb_size;
 300         }
 301
 302         /* Register character device for the volume */
 303         cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
 304         vol->cdev.owner = THIS_MODULE;
 305         dev = MKDEV(MAJOR(ubi->cdev.dev), vol_id + 1);
 306         err = cdev_add(&vol->cdev, dev, 1);
 307         if (err) {
 308                 ubi_err("cannot add character device for volume %d", vol_id);
 309                 goto out_mapping;
 310         }
 311
 312         err = ubi_create_gluebi(ubi, vol);
 313         if (err)
 314                 goto out_cdev;
 315
 316         vol->dev.release = vol_release;
 317         vol->dev.parent = &ubi->dev;
 318         vol->dev.devt = dev;
 319         vol->dev.class = ubi_class;
 320         sprintf(&vol->dev.bus_id[0], "%s_%d", ubi->ubi_name, vol->vol_id);
 321         err = device_register(&vol->dev);
 322         if (err)
 323                 goto out_gluebi;
 324
 325         err = volume_sysfs_init(ubi, vol);
 326         if (err)
 327                 goto out_sysfs;
 328
 329         /* Fill volume table record */
 330         memset(&vtbl_rec, 0, sizeof(struct ubi_vtbl_record));
 331         vtbl_rec.reserved_pebs = cpu_to_be32(vol->reserved_pebs);
 332         vtbl_rec.alignment     = cpu_to_be32(vol->alignment);
 333         vtbl_rec.data_pad      = cpu_to_be32(vol->data_pad);
 334         vtbl_rec.name_len      = cpu_to_be16(vol->name_len);
 335         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 336                 vtbl_rec.vol_type = UBI_VID_DYNAMIC;
 337         else
 338                 vtbl_rec.vol_type = UBI_VID_STATIC;
 339         memcpy(vtbl_rec.name, vol->name, vol->name_len + 1);
 340
 341         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
 342         if (err)
 343                 goto out_sysfs;
 344
 345         spin_lock(&ubi->volumes_lock);
 346         ubi->vol_count += 1;
 347         vol->exclusive = 0;
 348         spin_unlock(&ubi->volumes_lock);
 349
 350         paranoid_check_volumes(ubi);
 351         return 0;
 352
 353 out_gluebi:
 354         err = ubi_destroy_gluebi(vol);
 355 out_cdev:
 356         cdev_del(&vol->cdev);
 357 out_mapping:
 358         kfree(vol->eba_tbl);
 359 out_acc:
 360         spin_lock(&ubi->volumes_lock);
 361         ubi->rsvd_pebs -= vol->reserved_pebs;
 362         ubi->avail_pebs += vol->reserved_pebs;
 363         ubi->volumes[vol_id] = NULL;
 364 out_unlock:
 365         spin_unlock(&ubi->volumes_lock);
 366         kfree(vol);
 367         return err;
 368
 369         /*
 370          * We are registered, so @vol is destroyed in the release function and
 371          * we have to de-initialize differently.
 372          */
 373 out_sysfs:
 374         err = ubi_destroy_gluebi(vol);
 375         cdev_del(&vol->cdev);
 376         kfree(vol->eba_tbl);
 377         spin_lock(&ubi->volumes_lock);
 378         ubi->rsvd_pebs -= vol->reserved_pebs;
 379         ubi->avail_pebs += vol->reserved_pebs;
 380         ubi->volumes[vol_id] = NULL;
 381         spin_unlock(&ubi->volumes_lock);
 382         volume_sysfs_close(vol);
 383         return err;
 384 }
 385
 386 /**
 387  * ubi_remove_volume - remove volume.
 388  * @desc: volume descriptor
 389  *
 390  * This function removes volume described by @desc. The volume has to be opened
 391  * in "exclusive" mode. Returns zero in case of success and a negative error
 392  * code in case of failure.
 393  */
 394 int ubi_remove_volume(struct ubi_volume_desc *desc)
 395 {
 396         struct ubi_volume *vol = desc->vol;
 397         struct ubi_device *ubi = vol->ubi;
 398         int i, err, vol_id = vol->vol_id, reserved_pebs = vol->reserved_pebs;
 399
 400         dbg_msg("remove UBI volume %d", vol_id);
 401         ubi_assert(desc->mode == UBI_EXCLUSIVE);
 402         ubi_assert(vol == ubi->volumes[vol_id]);
 403
 404         if (ubi->ro_mode)
 405                 return -EROFS;
 406
 407         err = ubi_destroy_gluebi(vol);
 408         if (err)
 409                 return err;
 410
 411         err = ubi_change_vtbl_record(ubi, vol_id, NULL);
 412         if (err)
 413                 return err;
 414
 415         for (i = 0; i < vol->reserved_pebs; i++) {
 416                 err = ubi_eba_unmap_leb(ubi, vol_id, i);
 417                 if (err)
 418                         return err;
 419         }
 420
 421         spin_lock(&ubi->volumes_lock);
 422         vol->removed = 1;
 423         ubi->volumes[vol_id] = NULL;
 424         spin_unlock(&ubi->volumes_lock);
 425
 426         kfree(vol->eba_tbl);
 427         vol->eba_tbl = NULL;
 428         cdev_del(&vol->cdev);
 429         volume_sysfs_close(vol);
 430         kfree(desc);
 431
 432         spin_lock(&ubi->volumes_lock);
 433         ubi->rsvd_pebs -= reserved_pebs;
 434         ubi->avail_pebs += reserved_pebs;
 435         i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
 436         if (i > 0) {
 437                 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
 438                 ubi->avail_pebs -= i;
 439                 ubi->rsvd_pebs += i;
 440                 ubi->beb_rsvd_pebs += i;
 441                 if (i > 0)
 442                         ubi_msg("reserve more %d PEBs", i);
 443         }
 444         ubi->vol_count -= 1;
 445         spin_unlock(&ubi->volumes_lock);
 446
 447         paranoid_check_volumes(ubi);
 448         module_put(THIS_MODULE);
 449         return 0;
 450 }
 451
 452 /**
 453  * ubi_resize_volume - re-size volume.
 454  * @desc: volume descriptor
 455  * @reserved_pebs: new size in physical eraseblocks
 456  *
 457  * This function returns zero in case of success, and a negative error code in
 458  * case of failure.
 459  */
 460 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs)
 461 {
 462         int i, err, pebs, *new_mapping;
 463         struct ubi_volume *vol = desc->vol;
 464         struct ubi_device *ubi = vol->ubi;
 465         struct ubi_vtbl_record vtbl_rec;
 466         int vol_id = vol->vol_id;
 467
 468         if (ubi->ro_mode)
 469                 return -EROFS;
 470
 471         dbg_msg("re-size volume %d to from %d to %d PEBs",
 472                 vol_id, vol->reserved_pebs, reserved_pebs);
 473         ubi_assert(desc->mode == UBI_EXCLUSIVE);
 474         ubi_assert(vol == ubi->volumes[vol_id]);
 475
 476         if (vol->vol_type == UBI_STATIC_VOLUME &&
 477             reserved_pebs < vol->used_ebs) {
 478                 dbg_err("too small size %d, %d LEBs contain data",
 479                         reserved_pebs, vol->used_ebs);
 480                 return -EINVAL;
 481         }
 482
 483         /* If the size is the same, we have nothing to do */
 484         if (reserved_pebs == vol->reserved_pebs)
 485                 return 0;
 486
 487         new_mapping = kmalloc(reserved_pebs * sizeof(int), GFP_KERNEL);
 488         if (!new_mapping)
 489                 return -ENOMEM;
 490
 491         for (i = 0; i < reserved_pebs; i++)
 492                 new_mapping[i] = UBI_LEB_UNMAPPED;
 493
 494         /* Reserve physical eraseblocks */
 495         pebs = reserved_pebs - vol->reserved_pebs;
 496         if (pebs > 0) {
 497                 spin_lock(&ubi->volumes_lock);
 498                 if (pebs > ubi->avail_pebs) {
 499                         dbg_err("not enough PEBs: requested %d, available %d",
 500                                 pebs, ubi->avail_pebs);
 501                         spin_unlock(&ubi->volumes_lock);
 502                         err = -ENOSPC;
 503                         goto out_free;
 504                 }
 505                 ubi->avail_pebs -= pebs;
 506                 ubi->rsvd_pebs += pebs;
 507                 for (i = 0; i < vol->reserved_pebs; i++)
 508                         new_mapping[i] = vol->eba_tbl[i];
 509                 kfree(vol->eba_tbl);
 510                 vol->eba_tbl = new_mapping;
 511                 spin_unlock(&ubi->volumes_lock);
 512         }
 513
 514         /* Change volume table record */
 515         memcpy(&vtbl_rec, &ubi->vtbl[vol_id], sizeof(struct ubi_vtbl_record));
 516         vtbl_rec.reserved_pebs = cpu_to_be32(reserved_pebs);
 517         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
 518         if (err)
 519                 goto out_acc;
 520
 521         if (pebs < 0) {
 522                 for (i = 0; i < -pebs; i++) {
 523                         err = ubi_eba_unmap_leb(ubi, vol_id, reserved_pebs + i);
 524                         if (err)
 525                                 goto out_acc;
 526                 }
 527                 spin_lock(&ubi->volumes_lock);
 528                 ubi->rsvd_pebs += pebs;
 529                 ubi->avail_pebs -= pebs;
 530                 pebs = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
 531                 if (pebs > 0) {
 532                         pebs = ubi->avail_pebs >= pebs ? pebs : ubi->avail_pebs;
 533                         ubi->avail_pebs -= pebs;
 534                         ubi->rsvd_pebs += pebs;
 535                         ubi->beb_rsvd_pebs += pebs;
 536                         if (pebs > 0)
 537                                 ubi_msg("reserve more %d PEBs", pebs);
 538                 }
 539                 for (i = 0; i < reserved_pebs; i++)
 540                         new_mapping[i] = vol->eba_tbl[i];
 541                 kfree(vol->eba_tbl);
 542                 vol->eba_tbl = new_mapping;
 543                 spin_unlock(&ubi->volumes_lock);
 544         }
 545
 546         vol->reserved_pebs = reserved_pebs;
 547         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
 548                 vol->used_ebs = reserved_pebs;
 549                 vol->last_eb_bytes = vol->usable_leb_size;
 550                 vol->used_bytes =
 551                         (long long)vol->used_ebs * vol->usable_leb_size;
 552         }
 553
 554         paranoid_check_volumes(ubi);
 555         return 0;
 556
 557 out_acc:
 558         if (pebs > 0) {
 559                 spin_lock(&ubi->volumes_lock);
 560                 ubi->rsvd_pebs -= pebs;
 561                 ubi->avail_pebs += pebs;
 562                 spin_unlock(&ubi->volumes_lock);
 563         }
 564 out_free:
 565         kfree(new_mapping);
 566         return err;
 567 }
 568
 569 /**
 570  * ubi_add_volume - add volume.
 571  * @ubi: UBI device description object
 572  * @vol_id: volume ID
 573  *
 574  * This function adds an existin volume and initializes all its data
 575  * structures. Returnes zero in case of success and a negative error code in
 576  * case of failure.
 577  */
 578 int ubi_add_volume(struct ubi_device *ubi, int vol_id)
 579 {
 580         int err;
 581         dev_t dev;
 582         struct ubi_volume *vol = ubi->volumes[vol_id];
 583
 584         dbg_msg("add volume %d", vol_id);
 585         ubi_dbg_dump_vol_info(vol);
 586         ubi_assert(vol);
 587
 588         /* Register character device for the volume */
 589         cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
 590         vol->cdev.owner = THIS_MODULE;
 591         dev = MKDEV(MAJOR(ubi->cdev.dev), vol->vol_id + 1);
 592         err = cdev_add(&vol->cdev, dev, 1);
 593         if (err) {
 594                 ubi_err("cannot add character device for volume %d", vol_id);
 595                 return err;
 596         }
 597
 598         err = ubi_create_gluebi(ubi, vol);
 599         if (err)
 600                 goto out_cdev;
 601
 602         vol->dev.release = vol_release;
 603         vol->dev.parent = &ubi->dev;
 604         vol->dev.devt = dev;
 605         vol->dev.class = ubi_class;
 606         sprintf(&vol->dev.bus_id[0], "%s_%d", ubi->ubi_name, vol->vol_id);
 607         err = device_register(&vol->dev);
 608         if (err)
 609                 goto out_gluebi;
 610
 611         err = volume_sysfs_init(ubi, vol);
 612         if (err) {
 613                 cdev_del(&vol->cdev);
 614                 err = ubi_destroy_gluebi(vol);
 615                 volume_sysfs_close(vol);
 616                 return err;
 617         }
 618
 619         paranoid_check_volumes(ubi);
 620         return 0;
 621
 622 out_gluebi:
 623         err = ubi_destroy_gluebi(vol);
 624 out_cdev:
 625         cdev_del(&vol->cdev);
 626         return err;
 627 }
 628
 629 /**
 630  * ubi_free_volume - free volume.
 631  * @ubi: UBI device description object
 632  * @vol_id: volume ID
 633  *
 634  * This function frees all resources for volume @vol_id but does not remove it.
 635  * Used only when the UBI device is detached.
 636  */
 637 void ubi_free_volume(struct ubi_device *ubi, int vol_id)
 638 {
 639         int err;
 640         struct ubi_volume *vol = ubi->volumes[vol_id];
 641
 642         dbg_msg("free volume %d", vol_id);
 643         ubi_assert(vol);
 644
 645         vol->removed = 1;
 646         err = ubi_destroy_gluebi(vol);
 647         ubi->volumes[vol_id] = NULL;
 648         cdev_del(&vol->cdev);
 649         volume_sysfs_close(vol);
 650 }
 651
 652 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
 653
 654 /**
 655  * paranoid_check_volume - check volume information.
 656  * @ubi: UBI device description object
 657  * @vol_id: volume ID
 658  */
 659 static void paranoid_check_volume(struct ubi_device *ubi, int vol_id)
 660 {
 661         int idx = vol_id2idx(ubi, vol_id);
 662         int reserved_pebs, alignment, data_pad, vol_type, name_len, upd_marker;
 663         const struct ubi_volume *vol;
 664         long long n;
 665         const char *name;
 666
 667         spin_lock(&ubi->volumes_lock);
 668         reserved_pebs = be32_to_cpu(ubi->vtbl[vol_id].reserved_pebs);
 669         vol = ubi->volumes[idx];
 670
 671         if (!vol) {
 672                 if (reserved_pebs) {
 673                         ubi_err("no volume info, but volume exists");
 674                         goto fail;
 675                 }
 676                 spin_unlock(&ubi->volumes_lock);
 677                 return;
 678         }
 679
 680         if (vol->exclusive) {
 681                 /*
 682                  * The volume may be being created at the moment, do not check
 683                  * it (e.g., it may be in the middle of ubi_create_volume().
 684                  */
 685                 spin_unlock(&ubi->volumes_lock);
 686                 return;
 687         }
 688
 689         if (vol->reserved_pebs < 0 || vol->alignment < 0 || vol->data_pad < 0 ||
 690             vol->name_len < 0) {
 691                 ubi_err("negative values");
 692                 goto fail;
 693         }
 694         if (vol->alignment > ubi->leb_size || vol->alignment == 0) {
 695                 ubi_err("bad alignment");
 696                 goto fail;
 697         }
 698
 699         n = vol->alignment % ubi->min_io_size;
 700         if (vol->alignment != 1 && n) {
 701                 ubi_err("alignment is not multiple of min I/O unit");
 702                 goto fail;
 703         }
 704
 705         n = ubi->leb_size % vol->alignment;
 706         if (vol->data_pad != n) {
 707                 ubi_err("bad data_pad, has to be %lld", n);
 708                 goto fail;
 709         }
 710
 711         if (vol->vol_type != UBI_DYNAMIC_VOLUME &&
 712             vol->vol_type != UBI_STATIC_VOLUME) {
 713                 ubi_err("bad vol_type");
 714                 goto fail;
 715         }
 716
 717         if (vol->upd_marker != 0 && vol->upd_marker != 1) {
 718                 ubi_err("bad upd_marker");
 719                 goto fail;
 720         }
 721
 722         if (vol->upd_marker && vol->corrupted) {
 723                 dbg_err("update marker and corrupted simultaneously");
 724                 goto fail;
 725         }
 726
 727         if (vol->reserved_pebs > ubi->good_peb_count) {
 728                 ubi_err("too large reserved_pebs");
 729                 goto fail;
 730         }
 731
 732         n = ubi->leb_size - vol->data_pad;
 733         if (vol->usable_leb_size != ubi->leb_size - vol->data_pad) {
 734                 ubi_err("bad usable_leb_size, has to be %lld", n);
 735                 goto fail;
 736         }
 737
 738         if (vol->name_len > UBI_VOL_NAME_MAX) {
 739                 ubi_err("too long volume name, max is %d", UBI_VOL_NAME_MAX);
 740                 goto fail;
 741         }
 742
 743         if (!vol->name) {
 744                 ubi_err("NULL volume name");
 745                 goto fail;
 746         }
 747
 748         n = strnlen(vol->name, vol->name_len + 1);
 749         if (n != vol->name_len) {
 750                 ubi_err("bad name_len %lld", n);
 751                 goto fail;
 752         }
 753
 754         n = (long long)vol->used_ebs * vol->usable_leb_size;
 755         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
 756                 if (vol->corrupted != 0) {
 757                         ubi_err("corrupted dynamic volume");
 758                         goto fail;
 759                 }
 760                 if (vol->used_ebs != vol->reserved_pebs) {
 761                         ubi_err("bad used_ebs");
 762                         goto fail;
 763                 }
 764                 if (vol->last_eb_bytes != vol->usable_leb_size) {
 765                         ubi_err("bad last_eb_bytes");
 766                         goto fail;
 767                 }
 768                 if (vol->used_bytes != n) {
 769                         ubi_err("bad used_bytes");
 770                         goto fail;
 771                 }
 772         } else {
 773                 if (vol->corrupted != 0 && vol->corrupted != 1) {
 774                         ubi_err("bad corrupted");
 775                         goto fail;
 776                 }
 777                 if (vol->used_ebs < 0 || vol->used_ebs > vol->reserved_pebs) {
 778                         ubi_err("bad used_ebs");
 779                         goto fail;
 780                 }
 781                 if (vol->last_eb_bytes < 0 ||
 782                     vol->last_eb_bytes > vol->usable_leb_size) {
 783                         ubi_err("bad last_eb_bytes");
 784                         goto fail;
 785                 }
 786                 if (vol->used_bytes < 0 || vol->used_bytes > n ||
 787                     vol->used_bytes < n - vol->usable_leb_size) {
 788                         ubi_err("bad used_bytes");
 789                         goto fail;
 790                 }
 791         }
 792
 793         alignment  = be32_to_cpu(ubi->vtbl[vol_id].alignment);
 794         data_pad   = be32_to_cpu(ubi->vtbl[vol_id].data_pad);
 795         name_len   = be16_to_cpu(ubi->vtbl[vol_id].name_len);
 796         upd_marker = ubi->vtbl[vol_id].upd_marker;
 797         name       = &ubi->vtbl[vol_id].name[0];
 798         if (ubi->vtbl[vol_id].vol_type == UBI_VID_DYNAMIC)
 799                 vol_type = UBI_DYNAMIC_VOLUME;
 800         else
 801                 vol_type = UBI_STATIC_VOLUME;
 802
 803         if (alignment != vol->alignment || data_pad != vol->data_pad ||
 804             upd_marker != vol->upd_marker || vol_type != vol->vol_type ||
 805             name_len!= vol->name_len || strncmp(name, vol->name, name_len)) {
 806                 ubi_err("volume info is different");
 807                 goto fail;
 808         }
 809
 810         spin_unlock(&ubi->volumes_lock);
 811         return;
 812
 813 fail:
 814         ubi_err("paranoid check failed for volume %d", vol_id);
 815         ubi_dbg_dump_vol_info(vol);
 816         ubi_dbg_dump_vtbl_record(&ubi->vtbl[vol_id], vol_id);
 817         spin_unlock(&ubi->volumes_lock);
 818         BUG();
 819 }
 820
 821 /**
 822  * paranoid_check_volumes - check information about all volumes.
 823  * @ubi: UBI device description object
 824  */
 825 static void paranoid_check_volumes(struct ubi_device *ubi)
 826 {
 827         int i;
 828
 829         mutex_lock(&ubi->vtbl_mutex);
 830         for (i = 0; i < ubi->vtbl_slots; i++)
 831                 paranoid_check_volume(ubi, i);
 832         mutex_unlock(&ubi->vtbl_mutex);
 833 }
 834 #endif