Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc-2.6
[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 <linux/math64.h>
28 #include "ubi.h"
29
30 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
31 static int paranoid_check_volumes(struct ubi_device *ubi);
32 #else
33 #define paranoid_check_volumes(ubi) 0
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->eba_tbl);
131         kfree(vol);
132 }
133
134 /**
135  * volume_sysfs_init - initialize sysfs for new volume.
136  * @ubi: UBI device description object
137  * @vol: volume description object
138  *
139  * This function returns zero in case of success and a negative error code in
140  * case of failure.
141  *
142  * Note, this function does not free allocated resources in case of failure -
143  * the caller does it. This is because this would cause release() here and the
144  * caller would oops.
145  */
146 static int volume_sysfs_init(struct ubi_device *ubi, struct ubi_volume *vol)
147 {
148         int err;
149
150         err = device_create_file(&vol->dev, &attr_vol_reserved_ebs);
151         if (err)
152                 return err;
153         err = device_create_file(&vol->dev, &attr_vol_type);
154         if (err)
155                 return err;
156         err = device_create_file(&vol->dev, &attr_vol_name);
157         if (err)
158                 return err;
159         err = device_create_file(&vol->dev, &attr_vol_corrupted);
160         if (err)
161                 return err;
162         err = device_create_file(&vol->dev, &attr_vol_alignment);
163         if (err)
164                 return err;
165         err = device_create_file(&vol->dev, &attr_vol_usable_eb_size);
166         if (err)
167                 return err;
168         err = device_create_file(&vol->dev, &attr_vol_data_bytes);
169         if (err)
170                 return err;
171         err = device_create_file(&vol->dev, &attr_vol_upd_marker);
172         return err;
173 }
174
175 /**
176  * volume_sysfs_close - close sysfs for a volume.
177  * @vol: volume description object
178  */
179 static void volume_sysfs_close(struct ubi_volume *vol)
180 {
181         device_remove_file(&vol->dev, &attr_vol_upd_marker);
182         device_remove_file(&vol->dev, &attr_vol_data_bytes);
183         device_remove_file(&vol->dev, &attr_vol_usable_eb_size);
184         device_remove_file(&vol->dev, &attr_vol_alignment);
185         device_remove_file(&vol->dev, &attr_vol_corrupted);
186         device_remove_file(&vol->dev, &attr_vol_name);
187         device_remove_file(&vol->dev, &attr_vol_type);
188         device_remove_file(&vol->dev, &attr_vol_reserved_ebs);
189         device_unregister(&vol->dev);
190 }
191
192 /**
193  * ubi_create_volume - create volume.
194  * @ubi: UBI device description object
195  * @req: volume creation request
196  *
197  * This function creates volume described by @req. If @req->vol_id id
198  * %UBI_VOL_NUM_AUTO, this function automatically assign ID to the new volume
199  * and saves it in @req->vol_id. Returns zero in case of success and a negative
200  * error code in case of failure. Note, the caller has to have the
201  * @ubi->volumes_mutex locked.
202  */
203 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req)
204 {
205         int i, err, vol_id = req->vol_id, do_free = 1;
206         struct ubi_volume *vol;
207         struct ubi_vtbl_record vtbl_rec;
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_gen("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_gen("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         vol->reserved_pebs += div_u64(req->bytes + vol->usable_leb_size - 1,
258                                       vol->usable_leb_size);
259
260         /* Reserve physical eraseblocks */
261         if (vol->reserved_pebs > ubi->avail_pebs) {
262                 dbg_err("not enough PEBs, only %d available", ubi->avail_pebs);
263                 err = -ENOSPC;
264                 goto out_unlock;
265         }
266         ubi->avail_pebs -= vol->reserved_pebs;
267         ubi->rsvd_pebs += vol->reserved_pebs;
268         spin_unlock(&ubi->volumes_lock);
269
270         vol->vol_id    = vol_id;
271         vol->alignment = req->alignment;
272         vol->data_pad  = ubi->leb_size % vol->alignment;
273         vol->vol_type  = req->vol_type;
274         vol->name_len  = req->name_len;
275         memcpy(vol->name, req->name, vol->name_len);
276         vol->ubi = ubi;
277
278         /*
279          * Finish all pending erases because there may be some LEBs belonging
280          * to the same volume ID.
281          */
282         err = ubi_wl_flush(ubi);
283         if (err)
284                 goto out_acc;
285
286         vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int), GFP_KERNEL);
287         if (!vol->eba_tbl) {
288                 err = -ENOMEM;
289                 goto out_acc;
290         }
291
292         for (i = 0; i < vol->reserved_pebs; i++)
293                 vol->eba_tbl[i] = UBI_LEB_UNMAPPED;
294
295         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
296                 vol->used_ebs = vol->reserved_pebs;
297                 vol->last_eb_bytes = vol->usable_leb_size;
298                 vol->used_bytes =
299                         (long long)vol->used_ebs * vol->usable_leb_size;
300         } else {
301                 vol->used_ebs = div_u64_rem(vol->used_bytes,
302                                             vol->usable_leb_size,
303                                             &vol->last_eb_bytes);
304                 if (vol->last_eb_bytes != 0)
305                         vol->used_ebs += 1;
306                 else
307                         vol->last_eb_bytes = vol->usable_leb_size;
308         }
309
310         /* Register character device for the volume */
311         cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
312         vol->cdev.owner = THIS_MODULE;
313         dev = MKDEV(MAJOR(ubi->cdev.dev), vol_id + 1);
314         err = cdev_add(&vol->cdev, dev, 1);
315         if (err) {
316                 ubi_err("cannot add character device");
317                 goto out_mapping;
318         }
319
320         err = ubi_create_gluebi(ubi, vol);
321         if (err)
322                 goto out_cdev;
323
324         vol->dev.release = vol_release;
325         vol->dev.parent = &ubi->dev;
326         vol->dev.devt = dev;
327         vol->dev.class = ubi_class;
328
329         dev_set_name(&vol->dev, "%s_%d", ubi->ubi_name, vol->vol_id);
330         err = device_register(&vol->dev);
331         if (err) {
332                 ubi_err("cannot register device");
333                 goto out_gluebi;
334         }
335
336         err = volume_sysfs_init(ubi, vol);
337         if (err)
338                 goto out_sysfs;
339
340         /* Fill volume table record */
341         memset(&vtbl_rec, 0, sizeof(struct ubi_vtbl_record));
342         vtbl_rec.reserved_pebs = cpu_to_be32(vol->reserved_pebs);
343         vtbl_rec.alignment     = cpu_to_be32(vol->alignment);
344         vtbl_rec.data_pad      = cpu_to_be32(vol->data_pad);
345         vtbl_rec.name_len      = cpu_to_be16(vol->name_len);
346         if (vol->vol_type == UBI_DYNAMIC_VOLUME)
347                 vtbl_rec.vol_type = UBI_VID_DYNAMIC;
348         else
349                 vtbl_rec.vol_type = UBI_VID_STATIC;
350         memcpy(vtbl_rec.name, vol->name, vol->name_len);
351
352         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
353         if (err)
354                 goto out_sysfs;
355
356         spin_lock(&ubi->volumes_lock);
357         ubi->volumes[vol_id] = vol;
358         ubi->vol_count += 1;
359         spin_unlock(&ubi->volumes_lock);
360
361         err = paranoid_check_volumes(ubi);
362         return err;
363
364 out_sysfs:
365         /*
366          * We have registered our device, we should not free the volume
367          * description object in this function in case of an error - it is
368          * freed by the release function.
369          *
370          * Get device reference to prevent the release function from being
371          * called just after sysfs has been closed.
372          */
373         do_free = 0;
374         get_device(&vol->dev);
375         volume_sysfs_close(vol);
376 out_gluebi:
377         if (ubi_destroy_gluebi(vol))
378                 dbg_err("cannot destroy gluebi for volume %d:%d",
379                         ubi->ubi_num, vol_id);
380 out_cdev:
381         cdev_del(&vol->cdev);
382 out_mapping:
383         if (do_free)
384                 kfree(vol->eba_tbl);
385 out_acc:
386         spin_lock(&ubi->volumes_lock);
387         ubi->rsvd_pebs -= vol->reserved_pebs;
388         ubi->avail_pebs += vol->reserved_pebs;
389 out_unlock:
390         spin_unlock(&ubi->volumes_lock);
391         if (do_free)
392                 kfree(vol);
393         else
394                 put_device(&vol->dev);
395         ubi_err("cannot create volume %d, error %d", vol_id, err);
396         return err;
397 }
398
399 /**
400  * ubi_remove_volume - remove volume.
401  * @desc: volume descriptor
402  * @no_vtbl: do not change volume table if not zero
403  *
404  * This function removes volume described by @desc. The volume has to be opened
405  * in "exclusive" mode. Returns zero in case of success and a negative error
406  * code in case of failure. The caller has to have the @ubi->volumes_mutex
407  * locked.
408  */
409 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl)
410 {
411         struct ubi_volume *vol = desc->vol;
412         struct ubi_device *ubi = vol->ubi;
413         int i, err, vol_id = vol->vol_id, reserved_pebs = vol->reserved_pebs;
414
415         dbg_gen("remove UBI volume %d", vol_id);
416         ubi_assert(desc->mode == UBI_EXCLUSIVE);
417         ubi_assert(vol == ubi->volumes[vol_id]);
418
419         if (ubi->ro_mode)
420                 return -EROFS;
421
422         spin_lock(&ubi->volumes_lock);
423         if (vol->ref_count > 1) {
424                 /*
425                  * The volume is busy, probably someone is reading one of its
426                  * sysfs files.
427                  */
428                 err = -EBUSY;
429                 goto out_unlock;
430         }
431         ubi->volumes[vol_id] = NULL;
432         spin_unlock(&ubi->volumes_lock);
433
434         err = ubi_destroy_gluebi(vol);
435         if (err)
436                 goto out_err;
437
438         if (!no_vtbl) {
439                 err = ubi_change_vtbl_record(ubi, vol_id, NULL);
440                 if (err)
441                         goto out_err;
442         }
443
444         for (i = 0; i < vol->reserved_pebs; i++) {
445                 err = ubi_eba_unmap_leb(ubi, vol, i);
446                 if (err)
447                         goto out_err;
448         }
449
450         cdev_del(&vol->cdev);
451         volume_sysfs_close(vol);
452
453         spin_lock(&ubi->volumes_lock);
454         ubi->rsvd_pebs -= reserved_pebs;
455         ubi->avail_pebs += reserved_pebs;
456         i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
457         if (i > 0) {
458                 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
459                 ubi->avail_pebs -= i;
460                 ubi->rsvd_pebs += i;
461                 ubi->beb_rsvd_pebs += i;
462                 if (i > 0)
463                         ubi_msg("reserve more %d PEBs", i);
464         }
465         ubi->vol_count -= 1;
466         spin_unlock(&ubi->volumes_lock);
467
468         if (!no_vtbl)
469                 err = paranoid_check_volumes(ubi);
470         return err;
471
472 out_err:
473         ubi_err("cannot remove volume %d, error %d", vol_id, err);
474         spin_lock(&ubi->volumes_lock);
475         ubi->volumes[vol_id] = vol;
476 out_unlock:
477         spin_unlock(&ubi->volumes_lock);
478         return err;
479 }
480
481 /**
482  * ubi_resize_volume - re-size volume.
483  * @desc: volume descriptor
484  * @reserved_pebs: new size in physical eraseblocks
485  *
486  * This function re-sizes the volume and returns zero in case of success, and a
487  * negative error code in case of failure. The caller has to have the
488  * @ubi->volumes_mutex locked.
489  */
490 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs)
491 {
492         int i, err, pebs, *new_mapping;
493         struct ubi_volume *vol = desc->vol;
494         struct ubi_device *ubi = vol->ubi;
495         struct ubi_vtbl_record vtbl_rec;
496         int vol_id = vol->vol_id;
497
498         if (ubi->ro_mode)
499                 return -EROFS;
500
501         dbg_gen("re-size volume %d to from %d to %d PEBs",
502                 vol_id, vol->reserved_pebs, reserved_pebs);
503
504         if (vol->vol_type == UBI_STATIC_VOLUME &&
505             reserved_pebs < vol->used_ebs) {
506                 dbg_err("too small size %d, %d LEBs contain data",
507                         reserved_pebs, vol->used_ebs);
508                 return -EINVAL;
509         }
510
511         /* If the size is the same, we have nothing to do */
512         if (reserved_pebs == vol->reserved_pebs)
513                 return 0;
514
515         new_mapping = kmalloc(reserved_pebs * sizeof(int), GFP_KERNEL);
516         if (!new_mapping)
517                 return -ENOMEM;
518
519         for (i = 0; i < reserved_pebs; i++)
520                 new_mapping[i] = UBI_LEB_UNMAPPED;
521
522         spin_lock(&ubi->volumes_lock);
523         if (vol->ref_count > 1) {
524                 spin_unlock(&ubi->volumes_lock);
525                 err = -EBUSY;
526                 goto out_free;
527         }
528         spin_unlock(&ubi->volumes_lock);
529
530         /* Reserve physical eraseblocks */
531         pebs = reserved_pebs - vol->reserved_pebs;
532         if (pebs > 0) {
533                 spin_lock(&ubi->volumes_lock);
534                 if (pebs > ubi->avail_pebs) {
535                         dbg_err("not enough PEBs: requested %d, available %d",
536                                 pebs, ubi->avail_pebs);
537                         spin_unlock(&ubi->volumes_lock);
538                         err = -ENOSPC;
539                         goto out_free;
540                 }
541                 ubi->avail_pebs -= pebs;
542                 ubi->rsvd_pebs += pebs;
543                 for (i = 0; i < vol->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         /* Change volume table record */
551         memcpy(&vtbl_rec, &ubi->vtbl[vol_id], sizeof(struct ubi_vtbl_record));
552         vtbl_rec.reserved_pebs = cpu_to_be32(reserved_pebs);
553         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
554         if (err)
555                 goto out_acc;
556
557         if (pebs < 0) {
558                 for (i = 0; i < -pebs; i++) {
559                         err = ubi_eba_unmap_leb(ubi, vol, reserved_pebs + i);
560                         if (err)
561                                 goto out_acc;
562                 }
563                 spin_lock(&ubi->volumes_lock);
564                 ubi->rsvd_pebs += pebs;
565                 ubi->avail_pebs -= pebs;
566                 pebs = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
567                 if (pebs > 0) {
568                         pebs = ubi->avail_pebs >= pebs ? pebs : ubi->avail_pebs;
569                         ubi->avail_pebs -= pebs;
570                         ubi->rsvd_pebs += pebs;
571                         ubi->beb_rsvd_pebs += pebs;
572                         if (pebs > 0)
573                                 ubi_msg("reserve more %d PEBs", pebs);
574                 }
575                 for (i = 0; i < reserved_pebs; i++)
576                         new_mapping[i] = vol->eba_tbl[i];
577                 kfree(vol->eba_tbl);
578                 vol->eba_tbl = new_mapping;
579                 spin_unlock(&ubi->volumes_lock);
580         }
581
582         vol->reserved_pebs = reserved_pebs;
583         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
584                 vol->used_ebs = reserved_pebs;
585                 vol->last_eb_bytes = vol->usable_leb_size;
586                 vol->used_bytes =
587                         (long long)vol->used_ebs * vol->usable_leb_size;
588         }
589
590         err = paranoid_check_volumes(ubi);
591         return err;
592
593 out_acc:
594         if (pebs > 0) {
595                 spin_lock(&ubi->volumes_lock);
596                 ubi->rsvd_pebs -= pebs;
597                 ubi->avail_pebs += pebs;
598                 spin_unlock(&ubi->volumes_lock);
599         }
600 out_free:
601         kfree(new_mapping);
602         return err;
603 }
604
605 /**
606  * ubi_rename_volumes - re-name UBI volumes.
607  * @ubi: UBI device description object
608  * @rename_list: list of &struct ubi_rename_entry objects
609  *
610  * This function re-names or removes volumes specified in the re-name list.
611  * Returns zero in case of success and a negative error code in case of
612  * failure.
613  */
614 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list)
615 {
616         int err;
617         struct ubi_rename_entry *re;
618
619         err = ubi_vtbl_rename_volumes(ubi, rename_list);
620         if (err)
621                 return err;
622
623         list_for_each_entry(re, rename_list, list) {
624                 if (re->remove) {
625                         err = ubi_remove_volume(re->desc, 1);
626                         if (err)
627                                 break;
628                 } else {
629                         struct ubi_volume *vol = re->desc->vol;
630
631                         spin_lock(&ubi->volumes_lock);
632                         vol->name_len = re->new_name_len;
633                         memcpy(vol->name, re->new_name, re->new_name_len + 1);
634                         spin_unlock(&ubi->volumes_lock);
635                 }
636         }
637
638         if (!err)
639                 err = paranoid_check_volumes(ubi);
640         return err;
641 }
642
643 /**
644  * ubi_add_volume - add volume.
645  * @ubi: UBI device description object
646  * @vol: volume description object
647  *
648  * This function adds an existing volume and initializes all its data
649  * structures. Returns zero in case of success and a negative error code in
650  * case of failure.
651  */
652 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol)
653 {
654         int err, vol_id = vol->vol_id;
655         dev_t dev;
656
657         dbg_gen("add volume %d", vol_id);
658
659         /* Register character device for the volume */
660         cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
661         vol->cdev.owner = THIS_MODULE;
662         dev = MKDEV(MAJOR(ubi->cdev.dev), vol->vol_id + 1);
663         err = cdev_add(&vol->cdev, dev, 1);
664         if (err) {
665                 ubi_err("cannot add character device for volume %d, error %d",
666                         vol_id, err);
667                 return err;
668         }
669
670         err = ubi_create_gluebi(ubi, vol);
671         if (err)
672                 goto out_cdev;
673
674         vol->dev.release = vol_release;
675         vol->dev.parent = &ubi->dev;
676         vol->dev.devt = dev;
677         vol->dev.class = ubi_class;
678         dev_set_name(&vol->dev, "%s_%d", ubi->ubi_name, vol->vol_id);
679         err = device_register(&vol->dev);
680         if (err)
681                 goto out_gluebi;
682
683         err = volume_sysfs_init(ubi, vol);
684         if (err) {
685                 cdev_del(&vol->cdev);
686                 err = ubi_destroy_gluebi(vol);
687                 volume_sysfs_close(vol);
688                 return err;
689         }
690
691         err = paranoid_check_volumes(ubi);
692         return err;
693
694 out_gluebi:
695         err = ubi_destroy_gluebi(vol);
696 out_cdev:
697         cdev_del(&vol->cdev);
698         return err;
699 }
700
701 /**
702  * ubi_free_volume - free volume.
703  * @ubi: UBI device description object
704  * @vol: volume description object
705  *
706  * This function frees all resources for volume @vol but does not remove it.
707  * Used only when the UBI device is detached.
708  */
709 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol)
710 {
711         int err;
712
713         dbg_gen("free volume %d", vol->vol_id);
714
715         ubi->volumes[vol->vol_id] = NULL;
716         err = ubi_destroy_gluebi(vol);
717         cdev_del(&vol->cdev);
718         volume_sysfs_close(vol);
719 }
720
721 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
722
723 /**
724  * paranoid_check_volume - check volume information.
725  * @ubi: UBI device description object
726  * @vol_id: volume ID
727  *
728  * Returns zero if volume is all right and a a negative error code if not.
729  */
730 static int paranoid_check_volume(struct ubi_device *ubi, int vol_id)
731 {
732         int idx = vol_id2idx(ubi, vol_id);
733         int reserved_pebs, alignment, data_pad, vol_type, name_len, upd_marker;
734         const struct ubi_volume *vol;
735         long long n;
736         const char *name;
737
738         spin_lock(&ubi->volumes_lock);
739         reserved_pebs = be32_to_cpu(ubi->vtbl[vol_id].reserved_pebs);
740         vol = ubi->volumes[idx];
741
742         if (!vol) {
743                 if (reserved_pebs) {
744                         ubi_err("no volume info, but volume exists");
745                         goto fail;
746                 }
747                 spin_unlock(&ubi->volumes_lock);
748                 return 0;
749         }
750
751         if (vol->reserved_pebs < 0 || vol->alignment < 0 || vol->data_pad < 0 ||
752             vol->name_len < 0) {
753                 ubi_err("negative values");
754                 goto fail;
755         }
756         if (vol->alignment > ubi->leb_size || vol->alignment == 0) {
757                 ubi_err("bad alignment");
758                 goto fail;
759         }
760
761         n = vol->alignment & (ubi->min_io_size - 1);
762         if (vol->alignment != 1 && n) {
763                 ubi_err("alignment is not multiple of min I/O unit");
764                 goto fail;
765         }
766
767         n = ubi->leb_size % vol->alignment;
768         if (vol->data_pad != n) {
769                 ubi_err("bad data_pad, has to be %lld", n);
770                 goto fail;
771         }
772
773         if (vol->vol_type != UBI_DYNAMIC_VOLUME &&
774             vol->vol_type != UBI_STATIC_VOLUME) {
775                 ubi_err("bad vol_type");
776                 goto fail;
777         }
778
779         if (vol->upd_marker && vol->corrupted) {
780                 dbg_err("update marker and corrupted simultaneously");
781                 goto fail;
782         }
783
784         if (vol->reserved_pebs > ubi->good_peb_count) {
785                 ubi_err("too large reserved_pebs");
786                 goto fail;
787         }
788
789         n = ubi->leb_size - vol->data_pad;
790         if (vol->usable_leb_size != ubi->leb_size - vol->data_pad) {
791                 ubi_err("bad usable_leb_size, has to be %lld", n);
792                 goto fail;
793         }
794
795         if (vol->name_len > UBI_VOL_NAME_MAX) {
796                 ubi_err("too long volume name, max is %d", UBI_VOL_NAME_MAX);
797                 goto fail;
798         }
799
800         if (!vol->name) {
801                 ubi_err("NULL volume name");
802                 goto fail;
803         }
804
805         n = strnlen(vol->name, vol->name_len + 1);
806         if (n != vol->name_len) {
807                 ubi_err("bad name_len %lld", n);
808                 goto fail;
809         }
810
811         n = (long long)vol->used_ebs * vol->usable_leb_size;
812         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
813                 if (vol->corrupted) {
814                         ubi_err("corrupted dynamic volume");
815                         goto fail;
816                 }
817                 if (vol->used_ebs != vol->reserved_pebs) {
818                         ubi_err("bad used_ebs");
819                         goto fail;
820                 }
821                 if (vol->last_eb_bytes != vol->usable_leb_size) {
822                         ubi_err("bad last_eb_bytes");
823                         goto fail;
824                 }
825                 if (vol->used_bytes != n) {
826                         ubi_err("bad used_bytes");
827                         goto fail;
828                 }
829         } else {
830                 if (vol->used_ebs < 0 || vol->used_ebs > vol->reserved_pebs) {
831                         ubi_err("bad used_ebs");
832                         goto fail;
833                 }
834                 if (vol->last_eb_bytes < 0 ||
835                     vol->last_eb_bytes > vol->usable_leb_size) {
836                         ubi_err("bad last_eb_bytes");
837                         goto fail;
838                 }
839                 if (vol->used_bytes < 0 || vol->used_bytes > n ||
840                     vol->used_bytes < n - vol->usable_leb_size) {
841                         ubi_err("bad used_bytes");
842                         goto fail;
843                 }
844         }
845
846         alignment  = be32_to_cpu(ubi->vtbl[vol_id].alignment);
847         data_pad   = be32_to_cpu(ubi->vtbl[vol_id].data_pad);
848         name_len   = be16_to_cpu(ubi->vtbl[vol_id].name_len);
849         upd_marker = ubi->vtbl[vol_id].upd_marker;
850         name       = &ubi->vtbl[vol_id].name[0];
851         if (ubi->vtbl[vol_id].vol_type == UBI_VID_DYNAMIC)
852                 vol_type = UBI_DYNAMIC_VOLUME;
853         else
854                 vol_type = UBI_STATIC_VOLUME;
855
856         if (alignment != vol->alignment || data_pad != vol->data_pad ||
857             upd_marker != vol->upd_marker || vol_type != vol->vol_type ||
858             name_len != vol->name_len || strncmp(name, vol->name, name_len)) {
859                 ubi_err("volume info is different");
860                 goto fail;
861         }
862
863         spin_unlock(&ubi->volumes_lock);
864         return 0;
865
866 fail:
867         ubi_err("paranoid check failed for volume %d", vol_id);
868         if (vol)
869                 ubi_dbg_dump_vol_info(vol);
870         ubi_dbg_dump_vtbl_record(&ubi->vtbl[vol_id], vol_id);
871         spin_unlock(&ubi->volumes_lock);
872         return -EINVAL;
873 }
874
875 /**
876  * paranoid_check_volumes - check information about all volumes.
877  * @ubi: UBI device description object
878  *
879  * Returns zero if volumes are all right and a a negative error code if not.
880  */
881 static int paranoid_check_volumes(struct ubi_device *ubi)
882 {
883         int i, err = 0;
884
885         for (i = 0; i < ubi->vtbl_slots; i++) {
886                 err = paranoid_check_volume(ubi, i);
887                 if (err)
888                         break;
889         }
890
891         return err;
892 }
893 #endif