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