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         mutex_lock(&ubi->volumes_mutex);
 205         spin_lock(&ubi->volumes_lock);
 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");
 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                 ubi_err("cannot register device");
 324                 goto out_gluebi;
 325         }
 326
 327         err = volume_sysfs_init(ubi, vol);
 328         if (err)
 329                 goto out_sysfs;
 330
 331         /* Fill volume table record */
 332         memset(&vtbl_rec, 0, sizeof(struct ubi_vtbl_record));
 333         vtbl_rec.reserved_pebs = cpu_to_be32(vol->reserved_pebs);
 334         vtbl_rec.alignment     = cpu_to_be32(vol->alignment);
 335         vtbl_rec.data_pad      = cpu_to_be32(vol->data_pad);
 336         vtbl_rec.name_len      = cpu_to_be16(vol->name_len);
 337         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
 338                 vtbl_rec.vol_type = UBI_VID_DYNAMIC;
 339         else
 340                 vtbl_rec.vol_type = UBI_VID_STATIC;
 341         memcpy(vtbl_rec.name, vol->name, vol->name_len + 1);
 342
 343         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
 344         if (err)
 345                 goto out_sysfs;
 346
 347         spin_lock(&ubi->volumes_lock);
 348         ubi->vol_count += 1;
 349         vol->exclusive = 0;
 350         spin_unlock(&ubi->volumes_lock);
 351
 352         paranoid_check_volumes(ubi);
 353         mutex_unlock(&ubi->volumes_mutex);
 354         return 0;
 355
 356 out_gluebi:
 357         err = ubi_destroy_gluebi(vol);
 358 out_cdev:
 359         cdev_del(&vol->cdev);
 360 out_mapping:
 361         kfree(vol->eba_tbl);
 362 out_acc:
 363         spin_lock(&ubi->volumes_lock);
 364         ubi->rsvd_pebs -= vol->reserved_pebs;
 365         ubi->avail_pebs += vol->reserved_pebs;
 366         ubi->volumes[vol_id] = NULL;
 367 out_unlock:
 368         spin_unlock(&ubi->volumes_lock);
 369         mutex_unlock(&ubi->volumes_mutex);
 370         kfree(vol);
 371         ubi_err("cannot create volume %d, error %d", vol_id, err);
 372         return err;
 373
 374         /*
 375          * We are registered, so @vol is destroyed in the release function and
 376          * we have to de-initialize differently.
 377          */
 378 out_sysfs:
 379         err = ubi_destroy_gluebi(vol);
 380         cdev_del(&vol->cdev);
 381         kfree(vol->eba_tbl);
 382         spin_lock(&ubi->volumes_lock);
 383         ubi->rsvd_pebs -= vol->reserved_pebs;
 384         ubi->avail_pebs += vol->reserved_pebs;
 385         ubi->volumes[vol_id] = NULL;
 386         spin_unlock(&ubi->volumes_lock);
 387         mutex_unlock(&ubi->volumes_mutex);
 388         volume_sysfs_close(vol);
 389         ubi_err("cannot create volume %d, error %d", vol_id, err);
 390         return err;
 391 }
 392
 393 /**
 394  * ubi_remove_volume - remove volume.
 395  * @desc: volume descriptor
 396  *
 397  * This function removes volume described by @desc. The volume has to be opened
 398  * in "exclusive" mode. Returns zero in case of success and a negative error
 399  * code in case of failure.
 400  */
 401 int ubi_remove_volume(struct ubi_volume_desc *desc)
 402 {
 403         struct ubi_volume *vol = desc->vol;
 404         struct ubi_device *ubi = vol->ubi;
 405         int i, err, vol_id = vol->vol_id, reserved_pebs = vol->reserved_pebs;
 406
 407         dbg_msg("remove UBI volume %d", vol_id);
 408         ubi_assert(desc->mode == UBI_EXCLUSIVE);
 409         ubi_assert(vol == ubi->volumes[vol_id]);
 410
 411         if (ubi->ro_mode)
 412                 return -EROFS;
 413
 414         mutex_lock(&ubi->volumes_mutex);
 415         err = ubi_destroy_gluebi(vol);
 416         if (err)
 417                 goto out;
 418
 419         err = ubi_change_vtbl_record(ubi, vol_id, NULL);
 420         if (err)
 421                 goto out;
 422
 423         for (i = 0; i < vol->reserved_pebs; i++) {
 424                 err = ubi_eba_unmap_leb(ubi, vol, i);
 425                 if (err)
 426                         goto out;
 427         }
 428
 429         spin_lock(&ubi->volumes_lock);
 430         vol->removed = 1;
 431         ubi->volumes[vol_id] = NULL;
 432         spin_unlock(&ubi->volumes_lock);
 433
 434         kfree(vol->eba_tbl);
 435         vol->eba_tbl = NULL;
 436         cdev_del(&vol->cdev);
 437         volume_sysfs_close(vol);
 438
 439         spin_lock(&ubi->volumes_lock);
 440         ubi->rsvd_pebs -= reserved_pebs;
 441         ubi->avail_pebs += reserved_pebs;
 442         i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
 443         if (i > 0) {
 444                 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
 445                 ubi->avail_pebs -= i;
 446                 ubi->rsvd_pebs += i;
 447                 ubi->beb_rsvd_pebs += i;
 448                 if (i > 0)
 449                         ubi_msg("reserve more %d PEBs", i);
 450         }
 451         ubi->vol_count -= 1;
 452         spin_unlock(&ubi->volumes_lock);
 453
 454         paranoid_check_volumes(ubi);
 455 out:
 456         mutex_unlock(&ubi->volumes_mutex);
 457         return err;
 458 }
 459
 460 /**
 461  * ubi_resize_volume - re-size volume.
 462  * @desc: volume descriptor
 463  * @reserved_pebs: new size in physical eraseblocks
 464  *
 465  * This function returns zero in case of success, and a negative error code in
 466  * case of failure.
 467  */
 468 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs)
 469 {
 470         int i, err, pebs, *new_mapping;
 471         struct ubi_volume *vol = desc->vol;
 472         struct ubi_device *ubi = vol->ubi;
 473         struct ubi_vtbl_record vtbl_rec;
 474         int vol_id = vol->vol_id;
 475
 476         if (ubi->ro_mode)
 477                 return -EROFS;
 478
 479         dbg_msg("re-size volume %d to from %d to %d PEBs",
 480                 vol_id, vol->reserved_pebs, reserved_pebs);
 481         ubi_assert(desc->mode == UBI_EXCLUSIVE);
 482         ubi_assert(vol == ubi->volumes[vol_id]);
 483
 484         if (vol->vol_type == UBI_STATIC_VOLUME &&
 485             reserved_pebs < vol->used_ebs) {
 486                 dbg_err("too small size %d, %d LEBs contain data",
 487                         reserved_pebs, vol->used_ebs);
 488                 return -EINVAL;
 489         }
 490
 491         /* If the size is the same, we have nothing to do */
 492         if (reserved_pebs == vol->reserved_pebs)
 493                 return 0;
 494
 495         new_mapping = kmalloc(reserved_pebs * sizeof(int), GFP_KERNEL);
 496         if (!new_mapping)
 497                 return -ENOMEM;
 498
 499         for (i = 0; i < reserved_pebs; i++)
 500                 new_mapping[i] = UBI_LEB_UNMAPPED;
 501
 502         /* Reserve physical eraseblocks */
 503         mutex_lock(&ubi->volumes_mutex);
 504         pebs = reserved_pebs - vol->reserved_pebs;
 505         if (pebs > 0) {
 506                 spin_lock(&ubi->volumes_lock);
 507                 if (pebs > ubi->avail_pebs) {
 508                         dbg_err("not enough PEBs: requested %d, available %d",
 509                                 pebs, ubi->avail_pebs);
 510                         spin_unlock(&ubi->volumes_lock);
 511                         err = -ENOSPC;
 512                         goto out_free;
 513                 }
 514                 ubi->avail_pebs -= pebs;
 515                 ubi->rsvd_pebs += pebs;
 516                 for (i = 0; i < vol->reserved_pebs; i++)
 517                         new_mapping[i] = vol->eba_tbl[i];
 518                 kfree(vol->eba_tbl);
 519                 vol->eba_tbl = new_mapping;
 520                 spin_unlock(&ubi->volumes_lock);
 521         }
 522
 523         /* Change volume table record */
 524         memcpy(&vtbl_rec, &ubi->vtbl[vol_id], sizeof(struct ubi_vtbl_record));
 525         vtbl_rec.reserved_pebs = cpu_to_be32(reserved_pebs);
 526         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
 527         if (err)
 528                 goto out_acc;
 529
 530         if (pebs < 0) {
 531                 for (i = 0; i < -pebs; i++) {
 532                         err = ubi_eba_unmap_leb(ubi, vol, reserved_pebs + i);
 533                         if (err)
 534                                 goto out_acc;
 535                 }
 536                 spin_lock(&ubi->volumes_lock);
 537                 ubi->rsvd_pebs += pebs;
 538                 ubi->avail_pebs -= pebs;
 539                 pebs = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
 540                 if (pebs > 0) {
 541                         pebs = ubi->avail_pebs >= pebs ? pebs : ubi->avail_pebs;
 542                         ubi->avail_pebs -= pebs;
 543                         ubi->rsvd_pebs += pebs;
 544                         ubi->beb_rsvd_pebs += pebs;
 545                         if (pebs > 0)
 546                                 ubi_msg("reserve more %d PEBs", pebs);
 547                 }
 548                 for (i = 0; i < reserved_pebs; i++)
 549                         new_mapping[i] = vol->eba_tbl[i];
 550                 kfree(vol->eba_tbl);
 551                 vol->eba_tbl = new_mapping;
 552                 spin_unlock(&ubi->volumes_lock);
 553         }
 554
 555         vol->reserved_pebs = reserved_pebs;
 556         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
 557                 vol->used_ebs = reserved_pebs;
 558                 vol->last_eb_bytes = vol->usable_leb_size;
 559                 vol->used_bytes =
 560                         (long long)vol->used_ebs * vol->usable_leb_size;
 561         }
 562
 563         paranoid_check_volumes(ubi);
 564         mutex_unlock(&ubi->volumes_mutex);
 565         return 0;
 566
 567 out_acc:
 568         if (pebs > 0) {
 569                 spin_lock(&ubi->volumes_lock);
 570                 ubi->rsvd_pebs -= pebs;
 571                 ubi->avail_pebs += pebs;
 572                 spin_unlock(&ubi->volumes_lock);
 573         }
 574 out_free:
 575         kfree(new_mapping);
 576         mutex_unlock(&ubi->volumes_mutex);
 577         return err;
 578 }
 579
 580 /**
 581  * ubi_add_volume - add volume.
 582  * @ubi: UBI device description object
 583  * @vol: volume description object
 584  *
 585  * This function adds an existin volume and initializes all its data
 586  * structures. Returnes zero in case of success and a negative error code in
 587  * case of failure.
 588  */
 589 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol)
 590 {
 591         int err, vol_id = vol->vol_id;
 592         dev_t dev;
 593
 594         dbg_msg("add volume %d", vol_id);
 595         ubi_dbg_dump_vol_info(vol);
 596         ubi_assert(vol);
 597
 598         /* Register character device for the volume */
 599         cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
 600         vol->cdev.owner = THIS_MODULE;
 601         dev = MKDEV(MAJOR(ubi->cdev.dev), vol->vol_id + 1);
 602         err = cdev_add(&vol->cdev, dev, 1);
 603         if (err) {
 604                 ubi_err("cannot add character device for volume %d, error %d",
 605                         vol_id, err);
 606                 return err;
 607         }
 608
 609         err = ubi_create_gluebi(ubi, vol);
 610         if (err)
 611                 goto out_cdev;
 612
 613         vol->dev.release = vol_release;
 614         vol->dev.parent = &ubi->dev;
 615         vol->dev.devt = dev;
 616         vol->dev.class = ubi_class;
 617         sprintf(&vol->dev.bus_id[0], "%s_%d", ubi->ubi_name, vol->vol_id);
 618         err = device_register(&vol->dev);
 619         if (err)
 620                 goto out_gluebi;
 621
 622         err = volume_sysfs_init(ubi, vol);
 623         if (err) {
 624                 cdev_del(&vol->cdev);
 625                 err = ubi_destroy_gluebi(vol);
 626                 volume_sysfs_close(vol);
 627                 return err;
 628         }
 629
 630         paranoid_check_volumes(ubi);
 631         return 0;
 632
 633 out_gluebi:
 634         err = ubi_destroy_gluebi(vol);
 635 out_cdev:
 636         cdev_del(&vol->cdev);
 637         return err;
 638 }
 639
 640 /**
 641  * ubi_free_volume - free volume.
 642  * @ubi: UBI device description object
 643  * @vol: volume description object
 644  *
 645  * This function frees all resources for volume @vol but does not remove it.
 646  * Used only when the UBI device is detached.
 647  */
 648 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol)
 649 {
 650         int err;
 651
 652         dbg_msg("free volume %d", vol->vol_id);
 653         ubi_assert(vol);
 654
 655         vol->removed = 1;
 656         err = ubi_destroy_gluebi(vol);
 657         ubi->volumes[vol->vol_id] = NULL;
 658         cdev_del(&vol->cdev);
 659         volume_sysfs_close(vol);
 660 }
 661
 662 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
 663
 664 /**
 665  * paranoid_check_volume - check volume information.
 666  * @ubi: UBI device description object
 667  * @vol_id: volume ID
 668  */
 669 static void paranoid_check_volume(struct ubi_device *ubi, int vol_id)
 670 {
 671         int idx = vol_id2idx(ubi, vol_id);
 672         int reserved_pebs, alignment, data_pad, vol_type, name_len, upd_marker;
 673         const struct ubi_volume *vol;
 674         long long n;
 675         const char *name;
 676
 677         spin_lock(&ubi->volumes_lock);
 678         reserved_pebs = be32_to_cpu(ubi->vtbl[vol_id].reserved_pebs);
 679         vol = ubi->volumes[idx];
 680
 681         if (!vol) {
 682                 if (reserved_pebs) {
 683                         ubi_err("no volume info, but volume exists");
 684                         goto fail;
 685                 }
 686                 spin_unlock(&ubi->volumes_lock);
 687                 return;
 688         }
 689
 690         if (vol->exclusive) {
 691                 /*
 692                  * The volume may be being created at the moment, do not check
 693                  * it (e.g., it may be in the middle of ubi_create_volume().
 694                  */
 695                 spin_unlock(&ubi->volumes_lock);
 696                 return;
 697         }
 698
 699         if (vol->reserved_pebs < 0 || vol->alignment < 0 || vol->data_pad < 0 ||
 700             vol->name_len < 0) {
 701                 ubi_err("negative values");
 702                 goto fail;
 703         }
 704         if (vol->alignment > ubi->leb_size || vol->alignment == 0) {
 705                 ubi_err("bad alignment");
 706                 goto fail;
 707         }
 708
 709         n = vol->alignment % ubi->min_io_size;
 710         if (vol->alignment != 1 && n) {
 711                 ubi_err("alignment is not multiple of min I/O unit");
 712                 goto fail;
 713         }
 714
 715         n = ubi->leb_size % vol->alignment;
 716         if (vol->data_pad != n) {
 717                 ubi_err("bad data_pad, has to be %lld", n);
 718                 goto fail;
 719         }
 720
 721         if (vol->vol_type != UBI_DYNAMIC_VOLUME &&
 722             vol->vol_type != UBI_STATIC_VOLUME) {
 723                 ubi_err("bad vol_type");
 724                 goto fail;
 725         }
 726
 727         if (vol->upd_marker != 0 && vol->upd_marker != 1) {
 728                 ubi_err("bad upd_marker");
 729                 goto fail;
 730         }
 731
 732         if (vol->upd_marker && vol->corrupted) {
 733                 dbg_err("update marker and corrupted simultaneously");
 734                 goto fail;
 735         }
 736
 737         if (vol->reserved_pebs > ubi->good_peb_count) {
 738                 ubi_err("too large reserved_pebs");
 739                 goto fail;
 740         }
 741
 742         n = ubi->leb_size - vol->data_pad;
 743         if (vol->usable_leb_size != ubi->leb_size - vol->data_pad) {
 744                 ubi_err("bad usable_leb_size, has to be %lld", n);
 745                 goto fail;
 746         }
 747
 748         if (vol->name_len > UBI_VOL_NAME_MAX) {
 749                 ubi_err("too long volume name, max is %d", UBI_VOL_NAME_MAX);
 750                 goto fail;
 751         }
 752
 753         if (!vol->name) {
 754                 ubi_err("NULL volume name");
 755                 goto fail;
 756         }
 757
 758         n = strnlen(vol->name, vol->name_len + 1);
 759         if (n != vol->name_len) {
 760                 ubi_err("bad name_len %lld", n);
 761                 goto fail;
 762         }
 763
 764         n = (long long)vol->used_ebs * vol->usable_leb_size;
 765         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
 766                 if (vol->corrupted != 0) {
 767                         ubi_err("corrupted dynamic volume");
 768                         goto fail;
 769                 }
 770                 if (vol->used_ebs != vol->reserved_pebs) {
 771                         ubi_err("bad used_ebs");
 772                         goto fail;
 773                 }
 774                 if (vol->last_eb_bytes != vol->usable_leb_size) {
 775                         ubi_err("bad last_eb_bytes");
 776                         goto fail;
 777                 }
 778                 if (vol->used_bytes != n) {
 779                         ubi_err("bad used_bytes");
 780                         goto fail;
 781                 }
 782         } else {
 783                 if (vol->corrupted != 0 && vol->corrupted != 1) {
 784                         ubi_err("bad corrupted");
 785                         goto fail;
 786                 }
 787                 if (vol->used_ebs < 0 || vol->used_ebs > vol->reserved_pebs) {
 788                         ubi_err("bad used_ebs");
 789                         goto fail;
 790                 }
 791                 if (vol->last_eb_bytes < 0 ||
 792                     vol->last_eb_bytes > vol->usable_leb_size) {
 793                         ubi_err("bad last_eb_bytes");
 794                         goto fail;
 795                 }
 796                 if (vol->used_bytes < 0 || vol->used_bytes > n ||
 797                     vol->used_bytes < n - vol->usable_leb_size) {
 798                         ubi_err("bad used_bytes");
 799                         goto fail;
 800                 }
 801         }
 802
 803         alignment  = be32_to_cpu(ubi->vtbl[vol_id].alignment);
 804         data_pad   = be32_to_cpu(ubi->vtbl[vol_id].data_pad);
 805         name_len   = be16_to_cpu(ubi->vtbl[vol_id].name_len);
 806         upd_marker = ubi->vtbl[vol_id].upd_marker;
 807         name       = &ubi->vtbl[vol_id].name[0];
 808         if (ubi->vtbl[vol_id].vol_type == UBI_VID_DYNAMIC)
 809                 vol_type = UBI_DYNAMIC_VOLUME;
 810         else
 811                 vol_type = UBI_STATIC_VOLUME;
 812
 813         if (alignment != vol->alignment || data_pad != vol->data_pad ||
 814             upd_marker != vol->upd_marker || vol_type != vol->vol_type ||
 815             name_len!= vol->name_len || strncmp(name, vol->name, name_len)) {
 816                 ubi_err("volume info is different");
 817                 goto fail;
 818         }
 819
 820         spin_unlock(&ubi->volumes_lock);
 821         return;
 822
 823 fail:
 824         ubi_err("paranoid check failed for volume %d", vol_id);
 825         ubi_dbg_dump_vol_info(vol);
 826         ubi_dbg_dump_vtbl_record(&ubi->vtbl[vol_id], vol_id);
 827         spin_unlock(&ubi->volumes_lock);
 828         BUG();
 829 }
 830
 831 /**
 832  * paranoid_check_volumes - check information about all volumes.
 833  * @ubi: UBI device description object
 834  */
 835 static void paranoid_check_volumes(struct ubi_device *ubi)
 836 {
 837         int i;
 838
 839         for (i = 0; i < ubi->vtbl_slots; i++)
 840                 paranoid_check_volume(ubi, i);
 841 }
 842 #endif