]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/mtd/ubi/vmt.c
UBI: add notification API
[karo-tx-linux.git] / 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->device_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("create device %d, volume %d, %llu bytes, type %d, name %s",
236                 ubi->ubi_num, 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         ubi_volume_notify(ubi, vol, UBI_VOLUME_ADDED);
362         if (paranoid_check_volumes(ubi))
363                 dbg_err("check failed while creating volume %d", vol_id);
364         return err;
365
366 out_sysfs:
367         /*
368          * We have registered our device, we should not free the volume
369          * description object in this function in case of an error - it is
370          * freed by the release function.
371          *
372          * Get device reference to prevent the release function from being
373          * called just after sysfs has been closed.
374          */
375         do_free = 0;
376         get_device(&vol->dev);
377         volume_sysfs_close(vol);
378 out_gluebi:
379         if (ubi_destroy_gluebi(vol))
380                 dbg_err("cannot destroy gluebi for volume %d:%d",
381                         ubi->ubi_num, vol_id);
382 out_cdev:
383         cdev_del(&vol->cdev);
384 out_mapping:
385         if (do_free)
386                 kfree(vol->eba_tbl);
387 out_acc:
388         spin_lock(&ubi->volumes_lock);
389         ubi->rsvd_pebs -= vol->reserved_pebs;
390         ubi->avail_pebs += vol->reserved_pebs;
391 out_unlock:
392         spin_unlock(&ubi->volumes_lock);
393         if (do_free)
394                 kfree(vol);
395         else
396                 put_device(&vol->dev);
397         ubi_err("cannot create volume %d, error %d", vol_id, err);
398         return err;
399 }
400
401 /**
402  * ubi_remove_volume - remove volume.
403  * @desc: volume descriptor
404  * @no_vtbl: do not change volume table if not zero
405  *
406  * This function removes volume described by @desc. The volume has to be opened
407  * in "exclusive" mode. Returns zero in case of success and a negative error
408  * code in case of failure. The caller has to have the @ubi->device_mutex
409  * locked.
410  */
411 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl)
412 {
413         struct ubi_volume *vol = desc->vol;
414         struct ubi_device *ubi = vol->ubi;
415         int i, err, vol_id = vol->vol_id, reserved_pebs = vol->reserved_pebs;
416
417         dbg_gen("remove device %d, volume %d", ubi->ubi_num, vol_id);
418         ubi_assert(desc->mode == UBI_EXCLUSIVE);
419         ubi_assert(vol == ubi->volumes[vol_id]);
420
421         if (ubi->ro_mode)
422                 return -EROFS;
423
424         spin_lock(&ubi->volumes_lock);
425         if (vol->ref_count > 1) {
426                 /*
427                  * The volume is busy, probably someone is reading one of its
428                  * sysfs files.
429                  */
430                 err = -EBUSY;
431                 goto out_unlock;
432         }
433         ubi->volumes[vol_id] = NULL;
434         spin_unlock(&ubi->volumes_lock);
435
436         err = ubi_destroy_gluebi(vol);
437         if (err)
438                 goto out_err;
439
440         if (!no_vtbl) {
441                 err = ubi_change_vtbl_record(ubi, vol_id, NULL);
442                 if (err)
443                         goto out_err;
444         }
445
446         for (i = 0; i < vol->reserved_pebs; i++) {
447                 err = ubi_eba_unmap_leb(ubi, vol, i);
448                 if (err)
449                         goto out_err;
450         }
451
452         cdev_del(&vol->cdev);
453         volume_sysfs_close(vol);
454
455         spin_lock(&ubi->volumes_lock);
456         ubi->rsvd_pebs -= reserved_pebs;
457         ubi->avail_pebs += reserved_pebs;
458         i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
459         if (i > 0) {
460                 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
461                 ubi->avail_pebs -= i;
462                 ubi->rsvd_pebs += i;
463                 ubi->beb_rsvd_pebs += i;
464                 if (i > 0)
465                         ubi_msg("reserve more %d PEBs", i);
466         }
467         ubi->vol_count -= 1;
468         spin_unlock(&ubi->volumes_lock);
469
470         ubi_volume_notify(ubi, vol, UBI_VOLUME_REMOVED);
471         if (!no_vtbl && paranoid_check_volumes(ubi))
472                 dbg_err("check failed while removing volume %d", vol_id);
473
474         return err;
475
476 out_err:
477         ubi_err("cannot remove volume %d, error %d", vol_id, err);
478         spin_lock(&ubi->volumes_lock);
479         ubi->volumes[vol_id] = vol;
480 out_unlock:
481         spin_unlock(&ubi->volumes_lock);
482         return err;
483 }
484
485 /**
486  * ubi_resize_volume - re-size volume.
487  * @desc: volume descriptor
488  * @reserved_pebs: new size in physical eraseblocks
489  *
490  * This function re-sizes the volume and returns zero in case of success, and a
491  * negative error code in case of failure. The caller has to have the
492  * @ubi->device_mutex locked.
493  */
494 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs)
495 {
496         int i, err, pebs, *new_mapping;
497         struct ubi_volume *vol = desc->vol;
498         struct ubi_device *ubi = vol->ubi;
499         struct ubi_vtbl_record vtbl_rec;
500         int vol_id = vol->vol_id;
501
502         if (ubi->ro_mode)
503                 return -EROFS;
504
505         dbg_gen("re-size device %d, volume %d to from %d to %d PEBs",
506                 ubi->ubi_num, vol_id, vol->reserved_pebs, reserved_pebs);
507
508         if (vol->vol_type == UBI_STATIC_VOLUME &&
509             reserved_pebs < vol->used_ebs) {
510                 dbg_err("too small size %d, %d LEBs contain data",
511                         reserved_pebs, vol->used_ebs);
512                 return -EINVAL;
513         }
514
515         /* If the size is the same, we have nothing to do */
516         if (reserved_pebs == vol->reserved_pebs)
517                 return 0;
518
519         new_mapping = kmalloc(reserved_pebs * sizeof(int), GFP_KERNEL);
520         if (!new_mapping)
521                 return -ENOMEM;
522
523         for (i = 0; i < reserved_pebs; i++)
524                 new_mapping[i] = UBI_LEB_UNMAPPED;
525
526         spin_lock(&ubi->volumes_lock);
527         if (vol->ref_count > 1) {
528                 spin_unlock(&ubi->volumes_lock);
529                 err = -EBUSY;
530                 goto out_free;
531         }
532         spin_unlock(&ubi->volumes_lock);
533
534         /* Reserve physical eraseblocks */
535         pebs = reserved_pebs - vol->reserved_pebs;
536         if (pebs > 0) {
537                 spin_lock(&ubi->volumes_lock);
538                 if (pebs > ubi->avail_pebs) {
539                         dbg_err("not enough PEBs: requested %d, available %d",
540                                 pebs, ubi->avail_pebs);
541                         spin_unlock(&ubi->volumes_lock);
542                         err = -ENOSPC;
543                         goto out_free;
544                 }
545                 ubi->avail_pebs -= pebs;
546                 ubi->rsvd_pebs += pebs;
547                 for (i = 0; i < vol->reserved_pebs; i++)
548                         new_mapping[i] = vol->eba_tbl[i];
549                 kfree(vol->eba_tbl);
550                 vol->eba_tbl = new_mapping;
551                 spin_unlock(&ubi->volumes_lock);
552         }
553
554         /* Change volume table record */
555         memcpy(&vtbl_rec, &ubi->vtbl[vol_id], sizeof(struct ubi_vtbl_record));
556         vtbl_rec.reserved_pebs = cpu_to_be32(reserved_pebs);
557         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
558         if (err)
559                 goto out_acc;
560
561         if (pebs < 0) {
562                 for (i = 0; i < -pebs; i++) {
563                         err = ubi_eba_unmap_leb(ubi, vol, reserved_pebs + i);
564                         if (err)
565                                 goto out_acc;
566                 }
567                 spin_lock(&ubi->volumes_lock);
568                 ubi->rsvd_pebs += pebs;
569                 ubi->avail_pebs -= pebs;
570                 pebs = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
571                 if (pebs > 0) {
572                         pebs = ubi->avail_pebs >= pebs ? pebs : ubi->avail_pebs;
573                         ubi->avail_pebs -= pebs;
574                         ubi->rsvd_pebs += pebs;
575                         ubi->beb_rsvd_pebs += pebs;
576                         if (pebs > 0)
577                                 ubi_msg("reserve more %d PEBs", pebs);
578                 }
579                 for (i = 0; i < reserved_pebs; i++)
580                         new_mapping[i] = vol->eba_tbl[i];
581                 kfree(vol->eba_tbl);
582                 vol->eba_tbl = new_mapping;
583                 spin_unlock(&ubi->volumes_lock);
584         }
585
586         vol->reserved_pebs = reserved_pebs;
587         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
588                 vol->used_ebs = reserved_pebs;
589                 vol->last_eb_bytes = vol->usable_leb_size;
590                 vol->used_bytes =
591                         (long long)vol->used_ebs * vol->usable_leb_size;
592         }
593
594         ubi_volume_notify(ubi, vol, UBI_VOLUME_RESIZED);
595         if (paranoid_check_volumes(ubi))
596                 dbg_err("check failed while re-sizing volume %d", vol_id);
597         return err;
598
599 out_acc:
600         if (pebs > 0) {
601                 spin_lock(&ubi->volumes_lock);
602                 ubi->rsvd_pebs -= pebs;
603                 ubi->avail_pebs += pebs;
604                 spin_unlock(&ubi->volumes_lock);
605         }
606 out_free:
607         kfree(new_mapping);
608         return err;
609 }
610
611 /**
612  * ubi_rename_volumes - re-name UBI volumes.
613  * @ubi: UBI device description object
614  * @rename_list: list of &struct ubi_rename_entry objects
615  *
616  * This function re-names or removes volumes specified in the re-name list.
617  * Returns zero in case of success and a negative error code in case of
618  * failure.
619  */
620 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list)
621 {
622         int err;
623         struct ubi_rename_entry *re;
624
625         err = ubi_vtbl_rename_volumes(ubi, rename_list);
626         if (err)
627                 return err;
628
629         list_for_each_entry(re, rename_list, list) {
630                 if (re->remove) {
631                         err = ubi_remove_volume(re->desc, 1);
632                         if (err)
633                                 break;
634                 } else {
635                         struct ubi_volume *vol = re->desc->vol;
636
637                         spin_lock(&ubi->volumes_lock);
638                         vol->name_len = re->new_name_len;
639                         memcpy(vol->name, re->new_name, re->new_name_len + 1);
640                         spin_unlock(&ubi->volumes_lock);
641                         ubi_volume_notify(ubi, vol, UBI_VOLUME_RENAMED);
642                 }
643         }
644
645         if (!err && paranoid_check_volumes(ubi))
646                 ;
647         return err;
648 }
649
650 /**
651  * ubi_add_volume - add volume.
652  * @ubi: UBI device description object
653  * @vol: volume description object
654  *
655  * This function adds an existing volume and initializes all its data
656  * structures. Returns zero in case of success and a negative error code in
657  * case of failure.
658  */
659 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol)
660 {
661         int err, vol_id = vol->vol_id;
662         dev_t dev;
663
664         dbg_gen("add volume %d", vol_id);
665
666         /* Register character device for the volume */
667         cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
668         vol->cdev.owner = THIS_MODULE;
669         dev = MKDEV(MAJOR(ubi->cdev.dev), vol->vol_id + 1);
670         err = cdev_add(&vol->cdev, dev, 1);
671         if (err) {
672                 ubi_err("cannot add character device for volume %d, error %d",
673                         vol_id, err);
674                 return err;
675         }
676
677         err = ubi_create_gluebi(ubi, vol);
678         if (err)
679                 goto out_cdev;
680
681         vol->dev.release = vol_release;
682         vol->dev.parent = &ubi->dev;
683         vol->dev.devt = dev;
684         vol->dev.class = ubi_class;
685         dev_set_name(&vol->dev, "%s_%d", ubi->ubi_name, vol->vol_id);
686         err = device_register(&vol->dev);
687         if (err)
688                 goto out_gluebi;
689
690         err = volume_sysfs_init(ubi, vol);
691         if (err) {
692                 cdev_del(&vol->cdev);
693                 err = ubi_destroy_gluebi(vol);
694                 volume_sysfs_close(vol);
695                 return err;
696         }
697
698         if (paranoid_check_volumes(ubi))
699                 dbg_err("check failed while adding volume %d", vol_id);
700         return err;
701
702 out_gluebi:
703         err = ubi_destroy_gluebi(vol);
704 out_cdev:
705         cdev_del(&vol->cdev);
706         return err;
707 }
708
709 /**
710  * ubi_free_volume - free volume.
711  * @ubi: UBI device description object
712  * @vol: volume description object
713  *
714  * This function frees all resources for volume @vol but does not remove it.
715  * Used only when the UBI device is detached.
716  */
717 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol)
718 {
719         int err;
720
721         dbg_gen("free volume %d", vol->vol_id);
722
723         ubi->volumes[vol->vol_id] = NULL;
724         err = ubi_destroy_gluebi(vol);
725         cdev_del(&vol->cdev);
726         volume_sysfs_close(vol);
727 }
728
729 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
730
731 /**
732  * paranoid_check_volume - check volume information.
733  * @ubi: UBI device description object
734  * @vol_id: volume ID
735  *
736  * Returns zero if volume is all right and a a negative error code if not.
737  */
738 static int paranoid_check_volume(struct ubi_device *ubi, int vol_id)
739 {
740         int idx = vol_id2idx(ubi, vol_id);
741         int reserved_pebs, alignment, data_pad, vol_type, name_len, upd_marker;
742         const struct ubi_volume *vol;
743         long long n;
744         const char *name;
745
746         spin_lock(&ubi->volumes_lock);
747         reserved_pebs = be32_to_cpu(ubi->vtbl[vol_id].reserved_pebs);
748         vol = ubi->volumes[idx];
749
750         if (!vol) {
751                 if (reserved_pebs) {
752                         ubi_err("no volume info, but volume exists");
753                         goto fail;
754                 }
755                 spin_unlock(&ubi->volumes_lock);
756                 return 0;
757         }
758
759         if (vol->reserved_pebs < 0 || vol->alignment < 0 || vol->data_pad < 0 ||
760             vol->name_len < 0) {
761                 ubi_err("negative values");
762                 goto fail;
763         }
764         if (vol->alignment > ubi->leb_size || vol->alignment == 0) {
765                 ubi_err("bad alignment");
766                 goto fail;
767         }
768
769         n = vol->alignment & (ubi->min_io_size - 1);
770         if (vol->alignment != 1 && n) {
771                 ubi_err("alignment is not multiple of min I/O unit");
772                 goto fail;
773         }
774
775         n = ubi->leb_size % vol->alignment;
776         if (vol->data_pad != n) {
777                 ubi_err("bad data_pad, has to be %lld", n);
778                 goto fail;
779         }
780
781         if (vol->vol_type != UBI_DYNAMIC_VOLUME &&
782             vol->vol_type != UBI_STATIC_VOLUME) {
783                 ubi_err("bad vol_type");
784                 goto fail;
785         }
786
787         if (vol->upd_marker && vol->corrupted) {
788                 dbg_err("update marker and corrupted simultaneously");
789                 goto fail;
790         }
791
792         if (vol->reserved_pebs > ubi->good_peb_count) {
793                 ubi_err("too large reserved_pebs");
794                 goto fail;
795         }
796
797         n = ubi->leb_size - vol->data_pad;
798         if (vol->usable_leb_size != ubi->leb_size - vol->data_pad) {
799                 ubi_err("bad usable_leb_size, has to be %lld", n);
800                 goto fail;
801         }
802
803         if (vol->name_len > UBI_VOL_NAME_MAX) {
804                 ubi_err("too long volume name, max is %d", UBI_VOL_NAME_MAX);
805                 goto fail;
806         }
807
808         if (!vol->name) {
809                 ubi_err("NULL volume name");
810                 goto fail;
811         }
812
813         n = strnlen(vol->name, vol->name_len + 1);
814         if (n != vol->name_len) {
815                 ubi_err("bad name_len %lld", n);
816                 goto fail;
817         }
818
819         n = (long long)vol->used_ebs * vol->usable_leb_size;
820         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
821                 if (vol->corrupted) {
822                         ubi_err("corrupted dynamic volume");
823                         goto fail;
824                 }
825                 if (vol->used_ebs != vol->reserved_pebs) {
826                         ubi_err("bad used_ebs");
827                         goto fail;
828                 }
829                 if (vol->last_eb_bytes != vol->usable_leb_size) {
830                         ubi_err("bad last_eb_bytes");
831                         goto fail;
832                 }
833                 if (vol->used_bytes != n) {
834                         ubi_err("bad used_bytes");
835                         goto fail;
836                 }
837         } else {
838                 if (vol->used_ebs < 0 || vol->used_ebs > vol->reserved_pebs) {
839                         ubi_err("bad used_ebs");
840                         goto fail;
841                 }
842                 if (vol->last_eb_bytes < 0 ||
843                     vol->last_eb_bytes > vol->usable_leb_size) {
844                         ubi_err("bad last_eb_bytes");
845                         goto fail;
846                 }
847                 if (vol->used_bytes < 0 || vol->used_bytes > n ||
848                     vol->used_bytes < n - vol->usable_leb_size) {
849                         ubi_err("bad used_bytes");
850                         goto fail;
851                 }
852         }
853
854         alignment  = be32_to_cpu(ubi->vtbl[vol_id].alignment);
855         data_pad   = be32_to_cpu(ubi->vtbl[vol_id].data_pad);
856         name_len   = be16_to_cpu(ubi->vtbl[vol_id].name_len);
857         upd_marker = ubi->vtbl[vol_id].upd_marker;
858         name       = &ubi->vtbl[vol_id].name[0];
859         if (ubi->vtbl[vol_id].vol_type == UBI_VID_DYNAMIC)
860                 vol_type = UBI_DYNAMIC_VOLUME;
861         else
862                 vol_type = UBI_STATIC_VOLUME;
863
864         if (alignment != vol->alignment || data_pad != vol->data_pad ||
865             upd_marker != vol->upd_marker || vol_type != vol->vol_type ||
866             name_len != vol->name_len || strncmp(name, vol->name, name_len)) {
867                 ubi_err("volume info is different");
868                 goto fail;
869         }
870
871         spin_unlock(&ubi->volumes_lock);
872         return 0;
873
874 fail:
875         ubi_err("paranoid check failed for volume %d", vol_id);
876         if (vol)
877                 ubi_dbg_dump_vol_info(vol);
878         ubi_dbg_dump_vtbl_record(&ubi->vtbl[vol_id], vol_id);
879         dump_stack();
880         spin_unlock(&ubi->volumes_lock);
881         return -EINVAL;
882 }
883
884 /**
885  * paranoid_check_volumes - check information about all volumes.
886  * @ubi: UBI device description object
887  *
888  * Returns zero if volumes are all right and a a negative error code if not.
889  */
890 static int paranoid_check_volumes(struct ubi_device *ubi)
891 {
892         int i, err = 0;
893
894         for (i = 0; i < ubi->vtbl_slots; i++) {
895                 err = paranoid_check_volume(ubi, i);
896                 if (err)
897                         break;
898         }
899
900         return err;
901 }
902 #endif