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