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