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