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