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