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