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