xref: /openbmc/linux/drivers/mtd/ubi/vmt.c (revision ba61bb17)
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 static struct attribute *volume_dev_attrs[] = {
124 	&attr_vol_reserved_ebs.attr,
125 	&attr_vol_type.attr,
126 	&attr_vol_name.attr,
127 	&attr_vol_corrupted.attr,
128 	&attr_vol_alignment.attr,
129 	&attr_vol_usable_eb_size.attr,
130 	&attr_vol_data_bytes.attr,
131 	&attr_vol_upd_marker.attr,
132 	NULL
133 };
134 ATTRIBUTE_GROUPS(volume_dev);
135 
136 /* Release method for volume devices */
137 static void vol_release(struct device *dev)
138 {
139 	struct ubi_volume *vol = container_of(dev, struct ubi_volume, dev);
140 
141 	ubi_eba_replace_table(vol, NULL);
142 	ubi_fastmap_destroy_checkmap(vol);
143 	kfree(vol);
144 }
145 
146 /**
147  * ubi_create_volume - create volume.
148  * @ubi: UBI device description object
149  * @req: volume creation request
150  *
151  * This function creates volume described by @req. If @req->vol_id id
152  * %UBI_VOL_NUM_AUTO, this function automatically assign ID to the new volume
153  * and saves it in @req->vol_id. Returns zero in case of success and a negative
154  * error code in case of failure. Note, the caller has to have the
155  * @ubi->device_mutex locked.
156  */
157 int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req)
158 {
159 	int i, err, vol_id = req->vol_id;
160 	struct ubi_volume *vol;
161 	struct ubi_vtbl_record vtbl_rec;
162 	struct ubi_eba_table *eba_tbl = NULL;
163 
164 	if (ubi->ro_mode)
165 		return -EROFS;
166 
167 	vol = kzalloc(sizeof(struct ubi_volume), GFP_KERNEL);
168 	if (!vol)
169 		return -ENOMEM;
170 
171 	device_initialize(&vol->dev);
172 	vol->dev.release = vol_release;
173 	vol->dev.parent = &ubi->dev;
174 	vol->dev.class = &ubi_class;
175 	vol->dev.groups = volume_dev_groups;
176 
177 	spin_lock(&ubi->volumes_lock);
178 	if (vol_id == UBI_VOL_NUM_AUTO) {
179 		/* Find unused volume ID */
180 		dbg_gen("search for vacant volume ID");
181 		for (i = 0; i < ubi->vtbl_slots; i++)
182 			if (!ubi->volumes[i]) {
183 				vol_id = i;
184 				break;
185 			}
186 
187 		if (vol_id == UBI_VOL_NUM_AUTO) {
188 			ubi_err(ubi, "out of volume IDs");
189 			err = -ENFILE;
190 			goto out_unlock;
191 		}
192 		req->vol_id = vol_id;
193 	}
194 
195 	dbg_gen("create device %d, volume %d, %llu bytes, type %d, name %s",
196 		ubi->ubi_num, vol_id, (unsigned long long)req->bytes,
197 		(int)req->vol_type, req->name);
198 
199 	/* Ensure that this volume does not exist */
200 	err = -EEXIST;
201 	if (ubi->volumes[vol_id]) {
202 		ubi_err(ubi, "volume %d already exists", vol_id);
203 		goto out_unlock;
204 	}
205 
206 	/* Ensure that the name is unique */
207 	for (i = 0; i < ubi->vtbl_slots; i++)
208 		if (ubi->volumes[i] &&
209 		    ubi->volumes[i]->name_len == req->name_len &&
210 		    !strcmp(ubi->volumes[i]->name, req->name)) {
211 			ubi_err(ubi, "volume \"%s\" exists (ID %d)",
212 				req->name, i);
213 			goto out_unlock;
214 		}
215 
216 	/* Calculate how many eraseblocks are requested */
217 	vol->usable_leb_size = ubi->leb_size - ubi->leb_size % req->alignment;
218 	vol->reserved_pebs = div_u64(req->bytes + vol->usable_leb_size - 1,
219 				     vol->usable_leb_size);
220 
221 	/* Reserve physical eraseblocks */
222 	if (vol->reserved_pebs > ubi->avail_pebs) {
223 		ubi_err(ubi, "not enough PEBs, only %d available",
224 			ubi->avail_pebs);
225 		if (ubi->corr_peb_count)
226 			ubi_err(ubi, "%d PEBs are corrupted and not used",
227 				ubi->corr_peb_count);
228 		err = -ENOSPC;
229 		goto out_unlock;
230 	}
231 	ubi->avail_pebs -= vol->reserved_pebs;
232 	ubi->rsvd_pebs += vol->reserved_pebs;
233 	spin_unlock(&ubi->volumes_lock);
234 
235 	vol->vol_id    = vol_id;
236 	vol->alignment = req->alignment;
237 	vol->data_pad  = ubi->leb_size % vol->alignment;
238 	vol->vol_type  = req->vol_type;
239 	vol->name_len  = req->name_len;
240 	memcpy(vol->name, req->name, vol->name_len);
241 	vol->ubi = ubi;
242 
243 	/*
244 	 * Finish all pending erases because there may be some LEBs belonging
245 	 * to the same volume ID.
246 	 */
247 	err = ubi_wl_flush(ubi, vol_id, UBI_ALL);
248 	if (err)
249 		goto out_acc;
250 
251 	eba_tbl = ubi_eba_create_table(vol, vol->reserved_pebs);
252 	if (IS_ERR(eba_tbl)) {
253 		err = PTR_ERR(eba_tbl);
254 		goto out_acc;
255 	}
256 
257 	ubi_eba_replace_table(vol, eba_tbl);
258 
259 	if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
260 		vol->used_ebs = vol->reserved_pebs;
261 		vol->last_eb_bytes = vol->usable_leb_size;
262 		vol->used_bytes =
263 			(long long)vol->used_ebs * vol->usable_leb_size;
264 	} else {
265 		vol->used_ebs = div_u64_rem(vol->used_bytes,
266 					    vol->usable_leb_size,
267 					    &vol->last_eb_bytes);
268 		if (vol->last_eb_bytes != 0)
269 			vol->used_ebs += 1;
270 		else
271 			vol->last_eb_bytes = vol->usable_leb_size;
272 	}
273 
274 	/* Make volume "available" before it becomes accessible via sysfs */
275 	spin_lock(&ubi->volumes_lock);
276 	ubi->volumes[vol_id] = vol;
277 	ubi->vol_count += 1;
278 	spin_unlock(&ubi->volumes_lock);
279 
280 	/* Register character device for the volume */
281 	cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
282 	vol->cdev.owner = THIS_MODULE;
283 
284 	vol->dev.devt = MKDEV(MAJOR(ubi->cdev.dev), vol_id + 1);
285 	dev_set_name(&vol->dev, "%s_%d", ubi->ubi_name, vol->vol_id);
286 	err = cdev_device_add(&vol->cdev, &vol->dev);
287 	if (err) {
288 		ubi_err(ubi, "cannot add device");
289 		goto out_mapping;
290 	}
291 
292 	/* Fill volume table record */
293 	memset(&vtbl_rec, 0, sizeof(struct ubi_vtbl_record));
294 	vtbl_rec.reserved_pebs = cpu_to_be32(vol->reserved_pebs);
295 	vtbl_rec.alignment     = cpu_to_be32(vol->alignment);
296 	vtbl_rec.data_pad      = cpu_to_be32(vol->data_pad);
297 	vtbl_rec.name_len      = cpu_to_be16(vol->name_len);
298 	if (vol->vol_type == UBI_DYNAMIC_VOLUME)
299 		vtbl_rec.vol_type = UBI_VID_DYNAMIC;
300 	else
301 		vtbl_rec.vol_type = UBI_VID_STATIC;
302 	memcpy(vtbl_rec.name, vol->name, vol->name_len);
303 
304 	err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
305 	if (err)
306 		goto out_sysfs;
307 
308 	ubi_volume_notify(ubi, vol, UBI_VOLUME_ADDED);
309 	self_check_volumes(ubi);
310 	return err;
311 
312 out_sysfs:
313 	/*
314 	 * We have registered our device, we should not free the volume
315 	 * description object in this function in case of an error - it is
316 	 * freed by the release function.
317 	 */
318 	cdev_device_del(&vol->cdev, &vol->dev);
319 out_mapping:
320 	spin_lock(&ubi->volumes_lock);
321 	ubi->volumes[vol_id] = NULL;
322 	ubi->vol_count -= 1;
323 	spin_unlock(&ubi->volumes_lock);
324 	ubi_eba_destroy_table(eba_tbl);
325 out_acc:
326 	spin_lock(&ubi->volumes_lock);
327 	ubi->rsvd_pebs -= vol->reserved_pebs;
328 	ubi->avail_pebs += vol->reserved_pebs;
329 out_unlock:
330 	spin_unlock(&ubi->volumes_lock);
331 	put_device(&vol->dev);
332 	ubi_err(ubi, "cannot create volume %d, error %d", vol_id, err);
333 	return err;
334 }
335 
336 /**
337  * ubi_remove_volume - remove volume.
338  * @desc: volume descriptor
339  * @no_vtbl: do not change volume table if not zero
340  *
341  * This function removes volume described by @desc. The volume has to be opened
342  * in "exclusive" mode. Returns zero in case of success and a negative error
343  * code in case of failure. The caller has to have the @ubi->device_mutex
344  * locked.
345  */
346 int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl)
347 {
348 	struct ubi_volume *vol = desc->vol;
349 	struct ubi_device *ubi = vol->ubi;
350 	int i, err, vol_id = vol->vol_id, reserved_pebs = vol->reserved_pebs;
351 
352 	dbg_gen("remove device %d, volume %d", ubi->ubi_num, vol_id);
353 	ubi_assert(desc->mode == UBI_EXCLUSIVE);
354 	ubi_assert(vol == ubi->volumes[vol_id]);
355 
356 	if (ubi->ro_mode)
357 		return -EROFS;
358 
359 	spin_lock(&ubi->volumes_lock);
360 	if (vol->ref_count > 1) {
361 		/*
362 		 * The volume is busy, probably someone is reading one of its
363 		 * sysfs files.
364 		 */
365 		err = -EBUSY;
366 		goto out_unlock;
367 	}
368 	ubi->volumes[vol_id] = NULL;
369 	spin_unlock(&ubi->volumes_lock);
370 
371 	if (!no_vtbl) {
372 		err = ubi_change_vtbl_record(ubi, vol_id, NULL);
373 		if (err)
374 			goto out_err;
375 	}
376 
377 	for (i = 0; i < vol->reserved_pebs; i++) {
378 		err = ubi_eba_unmap_leb(ubi, vol, i);
379 		if (err)
380 			goto out_err;
381 	}
382 
383 	cdev_device_del(&vol->cdev, &vol->dev);
384 	put_device(&vol->dev);
385 
386 	spin_lock(&ubi->volumes_lock);
387 	ubi->rsvd_pebs -= reserved_pebs;
388 	ubi->avail_pebs += reserved_pebs;
389 	ubi_update_reserved(ubi);
390 	ubi->vol_count -= 1;
391 	spin_unlock(&ubi->volumes_lock);
392 
393 	ubi_volume_notify(ubi, vol, UBI_VOLUME_REMOVED);
394 	if (!no_vtbl)
395 		self_check_volumes(ubi);
396 
397 	return 0;
398 
399 out_err:
400 	ubi_err(ubi, "cannot remove volume %d, error %d", vol_id, err);
401 	spin_lock(&ubi->volumes_lock);
402 	ubi->volumes[vol_id] = vol;
403 out_unlock:
404 	spin_unlock(&ubi->volumes_lock);
405 	return err;
406 }
407 
408 /**
409  * ubi_resize_volume - re-size volume.
410  * @desc: volume descriptor
411  * @reserved_pebs: new size in physical eraseblocks
412  *
413  * This function re-sizes the volume and returns zero in case of success, and a
414  * negative error code in case of failure. The caller has to have the
415  * @ubi->device_mutex locked.
416  */
417 int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs)
418 {
419 	int i, err, pebs;
420 	struct ubi_volume *vol = desc->vol;
421 	struct ubi_device *ubi = vol->ubi;
422 	struct ubi_vtbl_record vtbl_rec;
423 	struct ubi_eba_table *new_eba_tbl = NULL;
424 	int vol_id = vol->vol_id;
425 
426 	if (ubi->ro_mode)
427 		return -EROFS;
428 
429 	dbg_gen("re-size device %d, volume %d to from %d to %d PEBs",
430 		ubi->ubi_num, vol_id, vol->reserved_pebs, reserved_pebs);
431 
432 	if (vol->vol_type == UBI_STATIC_VOLUME &&
433 	    reserved_pebs < vol->used_ebs) {
434 		ubi_err(ubi, "too small size %d, %d LEBs contain data",
435 			reserved_pebs, vol->used_ebs);
436 		return -EINVAL;
437 	}
438 
439 	/* If the size is the same, we have nothing to do */
440 	if (reserved_pebs == vol->reserved_pebs)
441 		return 0;
442 
443 	new_eba_tbl = ubi_eba_create_table(vol, reserved_pebs);
444 	if (IS_ERR(new_eba_tbl))
445 		return PTR_ERR(new_eba_tbl);
446 
447 	spin_lock(&ubi->volumes_lock);
448 	if (vol->ref_count > 1) {
449 		spin_unlock(&ubi->volumes_lock);
450 		err = -EBUSY;
451 		goto out_free;
452 	}
453 	spin_unlock(&ubi->volumes_lock);
454 
455 	/* Reserve physical eraseblocks */
456 	pebs = reserved_pebs - vol->reserved_pebs;
457 	if (pebs > 0) {
458 		spin_lock(&ubi->volumes_lock);
459 		if (pebs > ubi->avail_pebs) {
460 			ubi_err(ubi, "not enough PEBs: requested %d, available %d",
461 				pebs, ubi->avail_pebs);
462 			if (ubi->corr_peb_count)
463 				ubi_err(ubi, "%d PEBs are corrupted and not used",
464 					ubi->corr_peb_count);
465 			spin_unlock(&ubi->volumes_lock);
466 			err = -ENOSPC;
467 			goto out_free;
468 		}
469 		ubi->avail_pebs -= pebs;
470 		ubi->rsvd_pebs += pebs;
471 		ubi_eba_copy_table(vol, new_eba_tbl, vol->reserved_pebs);
472 		ubi_eba_replace_table(vol, new_eba_tbl);
473 		spin_unlock(&ubi->volumes_lock);
474 	}
475 
476 	if (pebs < 0) {
477 		for (i = 0; i < -pebs; i++) {
478 			err = ubi_eba_unmap_leb(ubi, vol, reserved_pebs + i);
479 			if (err)
480 				goto out_acc;
481 		}
482 		spin_lock(&ubi->volumes_lock);
483 		ubi->rsvd_pebs += pebs;
484 		ubi->avail_pebs -= pebs;
485 		ubi_update_reserved(ubi);
486 		ubi_eba_copy_table(vol, new_eba_tbl, reserved_pebs);
487 		ubi_eba_replace_table(vol, new_eba_tbl);
488 		spin_unlock(&ubi->volumes_lock);
489 	}
490 
491 	/*
492 	 * When we shrink a volume we have to flush all pending (erase) work.
493 	 * Otherwise it can happen that upon next attach UBI finds a LEB with
494 	 * lnum > highest_lnum and refuses to attach.
495 	 */
496 	if (pebs < 0) {
497 		err = ubi_wl_flush(ubi, vol_id, UBI_ALL);
498 		if (err)
499 			goto out_acc;
500 	}
501 
502 	/* Change volume table record */
503 	vtbl_rec = ubi->vtbl[vol_id];
504 	vtbl_rec.reserved_pebs = cpu_to_be32(reserved_pebs);
505 	err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
506 	if (err)
507 		goto out_acc;
508 
509 	vol->reserved_pebs = reserved_pebs;
510 	if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
511 		vol->used_ebs = reserved_pebs;
512 		vol->last_eb_bytes = vol->usable_leb_size;
513 		vol->used_bytes =
514 			(long long)vol->used_ebs * vol->usable_leb_size;
515 	}
516 
517 	ubi_volume_notify(ubi, vol, UBI_VOLUME_RESIZED);
518 	self_check_volumes(ubi);
519 	return err;
520 
521 out_acc:
522 	if (pebs > 0) {
523 		spin_lock(&ubi->volumes_lock);
524 		ubi->rsvd_pebs -= pebs;
525 		ubi->avail_pebs += pebs;
526 		spin_unlock(&ubi->volumes_lock);
527 	}
528 out_free:
529 	kfree(new_eba_tbl);
530 	return err;
531 }
532 
533 /**
534  * ubi_rename_volumes - re-name UBI volumes.
535  * @ubi: UBI device description object
536  * @rename_list: list of &struct ubi_rename_entry objects
537  *
538  * This function re-names or removes volumes specified in the re-name list.
539  * Returns zero in case of success and a negative error code in case of
540  * failure.
541  */
542 int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list)
543 {
544 	int err;
545 	struct ubi_rename_entry *re;
546 
547 	err = ubi_vtbl_rename_volumes(ubi, rename_list);
548 	if (err)
549 		return err;
550 
551 	list_for_each_entry(re, rename_list, list) {
552 		if (re->remove) {
553 			err = ubi_remove_volume(re->desc, 1);
554 			if (err)
555 				break;
556 		} else {
557 			struct ubi_volume *vol = re->desc->vol;
558 
559 			spin_lock(&ubi->volumes_lock);
560 			vol->name_len = re->new_name_len;
561 			memcpy(vol->name, re->new_name, re->new_name_len + 1);
562 			spin_unlock(&ubi->volumes_lock);
563 			ubi_volume_notify(ubi, vol, UBI_VOLUME_RENAMED);
564 		}
565 	}
566 
567 	if (!err)
568 		self_check_volumes(ubi);
569 	return err;
570 }
571 
572 /**
573  * ubi_add_volume - add volume.
574  * @ubi: UBI device description object
575  * @vol: volume description object
576  *
577  * This function adds an existing volume and initializes all its data
578  * structures. Returns zero in case of success and a negative error code in
579  * case of failure.
580  */
581 int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol)
582 {
583 	int err, vol_id = vol->vol_id;
584 	dev_t dev;
585 
586 	dbg_gen("add volume %d", vol_id);
587 
588 	/* Register character device for the volume */
589 	cdev_init(&vol->cdev, &ubi_vol_cdev_operations);
590 	vol->cdev.owner = THIS_MODULE;
591 	dev = MKDEV(MAJOR(ubi->cdev.dev), vol->vol_id + 1);
592 	err = cdev_add(&vol->cdev, dev, 1);
593 	if (err) {
594 		ubi_err(ubi, "cannot add character device for volume %d, error %d",
595 			vol_id, err);
596 		return err;
597 	}
598 
599 	vol->dev.release = vol_release;
600 	vol->dev.parent = &ubi->dev;
601 	vol->dev.devt = dev;
602 	vol->dev.class = &ubi_class;
603 	vol->dev.groups = volume_dev_groups;
604 	dev_set_name(&vol->dev, "%s_%d", ubi->ubi_name, vol->vol_id);
605 	err = device_register(&vol->dev);
606 	if (err)
607 		goto out_cdev;
608 
609 	self_check_volumes(ubi);
610 	return err;
611 
612 out_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: volume description object
621  *
622  * This function frees all resources for volume @vol but does not remove it.
623  * Used only when the UBI device is detached.
624  */
625 void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol)
626 {
627 	dbg_gen("free volume %d", vol->vol_id);
628 
629 	ubi->volumes[vol->vol_id] = NULL;
630 	cdev_del(&vol->cdev);
631 	device_unregister(&vol->dev);
632 }
633 
634 /**
635  * self_check_volume - check volume information.
636  * @ubi: UBI device description object
637  * @vol_id: volume ID
638  *
639  * Returns zero if volume is all right and a a negative error code if not.
640  */
641 static int self_check_volume(struct ubi_device *ubi, int vol_id)
642 {
643 	int idx = vol_id2idx(ubi, vol_id);
644 	int reserved_pebs, alignment, data_pad, vol_type, name_len, upd_marker;
645 	const struct ubi_volume *vol;
646 	long long n;
647 	const char *name;
648 
649 	spin_lock(&ubi->volumes_lock);
650 	reserved_pebs = be32_to_cpu(ubi->vtbl[vol_id].reserved_pebs);
651 	vol = ubi->volumes[idx];
652 
653 	if (!vol) {
654 		if (reserved_pebs) {
655 			ubi_err(ubi, "no volume info, but volume exists");
656 			goto fail;
657 		}
658 		spin_unlock(&ubi->volumes_lock);
659 		return 0;
660 	}
661 
662 	if (vol->reserved_pebs < 0 || vol->alignment < 0 || vol->data_pad < 0 ||
663 	    vol->name_len < 0) {
664 		ubi_err(ubi, "negative values");
665 		goto fail;
666 	}
667 	if (vol->alignment > ubi->leb_size || vol->alignment == 0) {
668 		ubi_err(ubi, "bad alignment");
669 		goto fail;
670 	}
671 
672 	n = vol->alignment & (ubi->min_io_size - 1);
673 	if (vol->alignment != 1 && n) {
674 		ubi_err(ubi, "alignment is not multiple of min I/O unit");
675 		goto fail;
676 	}
677 
678 	n = ubi->leb_size % vol->alignment;
679 	if (vol->data_pad != n) {
680 		ubi_err(ubi, "bad data_pad, has to be %lld", n);
681 		goto fail;
682 	}
683 
684 	if (vol->vol_type != UBI_DYNAMIC_VOLUME &&
685 	    vol->vol_type != UBI_STATIC_VOLUME) {
686 		ubi_err(ubi, "bad vol_type");
687 		goto fail;
688 	}
689 
690 	if (vol->upd_marker && vol->corrupted) {
691 		ubi_err(ubi, "update marker and corrupted simultaneously");
692 		goto fail;
693 	}
694 
695 	if (vol->reserved_pebs > ubi->good_peb_count) {
696 		ubi_err(ubi, "too large reserved_pebs");
697 		goto fail;
698 	}
699 
700 	n = ubi->leb_size - vol->data_pad;
701 	if (vol->usable_leb_size != ubi->leb_size - vol->data_pad) {
702 		ubi_err(ubi, "bad usable_leb_size, has to be %lld", n);
703 		goto fail;
704 	}
705 
706 	if (vol->name_len > UBI_VOL_NAME_MAX) {
707 		ubi_err(ubi, "too long volume name, max is %d",
708 			UBI_VOL_NAME_MAX);
709 		goto fail;
710 	}
711 
712 	n = strnlen(vol->name, vol->name_len + 1);
713 	if (n != vol->name_len) {
714 		ubi_err(ubi, "bad name_len %lld", n);
715 		goto fail;
716 	}
717 
718 	n = (long long)vol->used_ebs * vol->usable_leb_size;
719 	if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
720 		if (vol->corrupted) {
721 			ubi_err(ubi, "corrupted dynamic volume");
722 			goto fail;
723 		}
724 		if (vol->used_ebs != vol->reserved_pebs) {
725 			ubi_err(ubi, "bad used_ebs");
726 			goto fail;
727 		}
728 		if (vol->last_eb_bytes != vol->usable_leb_size) {
729 			ubi_err(ubi, "bad last_eb_bytes");
730 			goto fail;
731 		}
732 		if (vol->used_bytes != n) {
733 			ubi_err(ubi, "bad used_bytes");
734 			goto fail;
735 		}
736 	} else {
737 		if (vol->used_ebs < 0 || vol->used_ebs > vol->reserved_pebs) {
738 			ubi_err(ubi, "bad used_ebs");
739 			goto fail;
740 		}
741 		if (vol->last_eb_bytes < 0 ||
742 		    vol->last_eb_bytes > vol->usable_leb_size) {
743 			ubi_err(ubi, "bad last_eb_bytes");
744 			goto fail;
745 		}
746 		if (vol->used_bytes < 0 || vol->used_bytes > n ||
747 		    vol->used_bytes < n - vol->usable_leb_size) {
748 			ubi_err(ubi, "bad used_bytes");
749 			goto fail;
750 		}
751 	}
752 
753 	alignment  = be32_to_cpu(ubi->vtbl[vol_id].alignment);
754 	data_pad   = be32_to_cpu(ubi->vtbl[vol_id].data_pad);
755 	name_len   = be16_to_cpu(ubi->vtbl[vol_id].name_len);
756 	upd_marker = ubi->vtbl[vol_id].upd_marker;
757 	name       = &ubi->vtbl[vol_id].name[0];
758 	if (ubi->vtbl[vol_id].vol_type == UBI_VID_DYNAMIC)
759 		vol_type = UBI_DYNAMIC_VOLUME;
760 	else
761 		vol_type = UBI_STATIC_VOLUME;
762 
763 	if (alignment != vol->alignment || data_pad != vol->data_pad ||
764 	    upd_marker != vol->upd_marker || vol_type != vol->vol_type ||
765 	    name_len != vol->name_len || strncmp(name, vol->name, name_len)) {
766 		ubi_err(ubi, "volume info is different");
767 		goto fail;
768 	}
769 
770 	spin_unlock(&ubi->volumes_lock);
771 	return 0;
772 
773 fail:
774 	ubi_err(ubi, "self-check failed for volume %d", vol_id);
775 	if (vol)
776 		ubi_dump_vol_info(vol);
777 	ubi_dump_vtbl_record(&ubi->vtbl[vol_id], vol_id);
778 	dump_stack();
779 	spin_unlock(&ubi->volumes_lock);
780 	return -EINVAL;
781 }
782 
783 /**
784  * self_check_volumes - check information about all volumes.
785  * @ubi: UBI device description object
786  *
787  * Returns zero if volumes are all right and a a negative error code if not.
788  */
789 static int self_check_volumes(struct ubi_device *ubi)
790 {
791 	int i, err = 0;
792 
793 	if (!ubi_dbg_chk_gen(ubi))
794 		return 0;
795 
796 	for (i = 0; i < ubi->vtbl_slots; i++) {
797 		err = self_check_volume(ubi, i);
798 		if (err)
799 			break;
800 	}
801 
802 	return err;
803 }
804