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