1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (c) International Business Machines Corp., 2006
4 * Copyright (c) Nokia Corporation, 2006, 2007
5 *
6 * Author: Artem Bityutskiy (Битюцкий Артём)
7 */
8
9 /*
10 * This file includes volume table manipulation code. The volume table is an
11 * on-flash table containing volume meta-data like name, number of reserved
12 * physical eraseblocks, type, etc. The volume table is stored in the so-called
13 * "layout volume".
14 *
15 * The layout volume is an internal volume which is organized as follows. It
16 * consists of two logical eraseblocks - LEB 0 and LEB 1. Each logical
17 * eraseblock stores one volume table copy, i.e. LEB 0 and LEB 1 duplicate each
18 * other. This redundancy guarantees robustness to unclean reboots. The volume
19 * table is basically an array of volume table records. Each record contains
20 * full information about the volume and protected by a CRC checksum. Note,
21 * nowadays we use the atomic LEB change operation when updating the volume
22 * table, so we do not really need 2 LEBs anymore, but we preserve the older
23 * design for the backward compatibility reasons.
24 *
25 * When the volume table is changed, it is first changed in RAM. Then LEB 0 is
26 * erased, and the updated volume table is written back to LEB 0. Then same for
27 * LEB 1. This scheme guarantees recoverability from unclean reboots.
28 *
29 * In this UBI implementation the on-flash volume table does not contain any
30 * information about how much data static volumes contain.
31 *
32 * But it would still be beneficial to store this information in the volume
33 * table. For example, suppose we have a static volume X, and all its physical
34 * eraseblocks became bad for some reasons. Suppose we are attaching the
35 * corresponding MTD device, for some reason we find no logical eraseblocks
36 * corresponding to the volume X. According to the volume table volume X does
37 * exist. So we don't know whether it is just empty or all its physical
38 * eraseblocks went bad. So we cannot alarm the user properly.
39 *
40 * The volume table also stores so-called "update marker", which is used for
41 * volume updates. Before updating the volume, the update marker is set, and
42 * after the update operation is finished, the update marker is cleared. So if
43 * the update operation was interrupted (e.g. by an unclean reboot) - the
44 * update marker is still there and we know that the volume's contents is
45 * damaged.
46 */
47
48 #ifndef __UBOOT__
49 #include <linux/crc32.h>
50 #include <linux/err.h>
51 #include <linux/slab.h>
52 #include <asm/div64.h>
53 #include <u-boot/crc.h>
54 #else
55 #include <ubi_uboot.h>
56 #endif
57
58 #include <linux/err.h>
59 #include "ubi.h"
60
61 static void self_vtbl_check(const struct ubi_device *ubi);
62
63 /* Empty volume table record */
64 static struct ubi_vtbl_record empty_vtbl_record;
65
66 /**
67 * ubi_update_layout_vol - helper for updatting layout volumes on flash
68 * @ubi: UBI device description object
69 */
ubi_update_layout_vol(struct ubi_device * ubi)70 static int ubi_update_layout_vol(struct ubi_device *ubi)
71 {
72 struct ubi_volume *layout_vol;
73 int i, err;
74
75 layout_vol = ubi->volumes[vol_id2idx(ubi, UBI_LAYOUT_VOLUME_ID)];
76 for (i = 0; i < UBI_LAYOUT_VOLUME_EBS; i++) {
77 err = ubi_eba_atomic_leb_change(ubi, layout_vol, i, ubi->vtbl,
78 ubi->vtbl_size);
79 if (err)
80 return err;
81 }
82
83 return 0;
84 }
85
86 /**
87 * ubi_change_vtbl_record - change volume table record.
88 * @ubi: UBI device description object
89 * @idx: table index to change
90 * @vtbl_rec: new volume table record
91 *
92 * This function changes volume table record @idx. If @vtbl_rec is %NULL, empty
93 * volume table record is written. The caller does not have to calculate CRC of
94 * the record as it is done by this function. Returns zero in case of success
95 * and a negative error code in case of failure.
96 */
ubi_change_vtbl_record(struct ubi_device * ubi,int idx,struct ubi_vtbl_record * vtbl_rec)97 int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
98 struct ubi_vtbl_record *vtbl_rec)
99 {
100 int err;
101 uint32_t crc;
102
103 ubi_assert(idx >= 0 && idx < ubi->vtbl_slots);
104
105 if (!vtbl_rec)
106 vtbl_rec = &empty_vtbl_record;
107 else {
108 crc = crc32(UBI_CRC32_INIT, vtbl_rec, UBI_VTBL_RECORD_SIZE_CRC);
109 vtbl_rec->crc = cpu_to_be32(crc);
110 }
111
112 memcpy(&ubi->vtbl[idx], vtbl_rec, sizeof(struct ubi_vtbl_record));
113 err = ubi_update_layout_vol(ubi);
114
115 self_vtbl_check(ubi);
116 return err ? err : 0;
117 }
118
119 /**
120 * ubi_vtbl_rename_volumes - rename UBI volumes in the volume table.
121 * @ubi: UBI device description object
122 * @rename_list: list of &struct ubi_rename_entry objects
123 *
124 * This function re-names multiple volumes specified in @req in the volume
125 * table. Returns zero in case of success and a negative error code in case of
126 * failure.
127 */
ubi_vtbl_rename_volumes(struct ubi_device * ubi,struct list_head * rename_list)128 int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
129 struct list_head *rename_list)
130 {
131 struct ubi_rename_entry *re;
132
133 list_for_each_entry(re, rename_list, list) {
134 uint32_t crc;
135 struct ubi_volume *vol = re->desc->vol;
136 struct ubi_vtbl_record *vtbl_rec = &ubi->vtbl[vol->vol_id];
137
138 if (re->remove) {
139 memcpy(vtbl_rec, &empty_vtbl_record,
140 sizeof(struct ubi_vtbl_record));
141 continue;
142 }
143
144 vtbl_rec->name_len = cpu_to_be16(re->new_name_len);
145 memcpy(vtbl_rec->name, re->new_name, re->new_name_len);
146 memset(vtbl_rec->name + re->new_name_len, 0,
147 UBI_VOL_NAME_MAX + 1 - re->new_name_len);
148 crc = crc32(UBI_CRC32_INIT, vtbl_rec,
149 UBI_VTBL_RECORD_SIZE_CRC);
150 vtbl_rec->crc = cpu_to_be32(crc);
151 }
152
153 return ubi_update_layout_vol(ubi);
154 }
155
156 /**
157 * vtbl_check - check if volume table is not corrupted and sensible.
158 * @ubi: UBI device description object
159 * @vtbl: volume table
160 *
161 * This function returns zero if @vtbl is all right, %1 if CRC is incorrect,
162 * and %-EINVAL if it contains inconsistent data.
163 */
vtbl_check(const struct ubi_device * ubi,const struct ubi_vtbl_record * vtbl)164 static int vtbl_check(const struct ubi_device *ubi,
165 const struct ubi_vtbl_record *vtbl)
166 {
167 int i, n, reserved_pebs, alignment, data_pad, vol_type, name_len;
168 int upd_marker, err;
169 uint32_t crc;
170 const char *name;
171
172 for (i = 0; i < ubi->vtbl_slots; i++) {
173 cond_resched();
174
175 reserved_pebs = be32_to_cpu(vtbl[i].reserved_pebs);
176 alignment = be32_to_cpu(vtbl[i].alignment);
177 data_pad = be32_to_cpu(vtbl[i].data_pad);
178 upd_marker = vtbl[i].upd_marker;
179 vol_type = vtbl[i].vol_type;
180 name_len = be16_to_cpu(vtbl[i].name_len);
181 name = &vtbl[i].name[0];
182
183 crc = crc32(UBI_CRC32_INIT, &vtbl[i], UBI_VTBL_RECORD_SIZE_CRC);
184 if (be32_to_cpu(vtbl[i].crc) != crc) {
185 ubi_err(ubi, "bad CRC at record %u: %#08x, not %#08x",
186 i, crc, be32_to_cpu(vtbl[i].crc));
187 ubi_dump_vtbl_record(&vtbl[i], i);
188 return 1;
189 }
190
191 if (reserved_pebs == 0) {
192 if (memcmp(&vtbl[i], &empty_vtbl_record,
193 UBI_VTBL_RECORD_SIZE)) {
194 err = 2;
195 goto bad;
196 }
197 continue;
198 }
199
200 if (reserved_pebs < 0 || alignment < 0 || data_pad < 0 ||
201 name_len < 0) {
202 err = 3;
203 goto bad;
204 }
205
206 if (alignment > ubi->leb_size || alignment == 0) {
207 err = 4;
208 goto bad;
209 }
210
211 n = alignment & (ubi->min_io_size - 1);
212 if (alignment != 1 && n) {
213 err = 5;
214 goto bad;
215 }
216
217 n = ubi->leb_size % alignment;
218 if (data_pad != n) {
219 ubi_err(ubi, "bad data_pad, has to be %d", n);
220 err = 6;
221 goto bad;
222 }
223
224 if (vol_type != UBI_VID_DYNAMIC && vol_type != UBI_VID_STATIC) {
225 err = 7;
226 goto bad;
227 }
228
229 if (upd_marker != 0 && upd_marker != 1) {
230 err = 8;
231 goto bad;
232 }
233
234 if (reserved_pebs > ubi->good_peb_count) {
235 ubi_err(ubi, "too large reserved_pebs %d, good PEBs %d",
236 reserved_pebs, ubi->good_peb_count);
237 err = 9;
238 goto bad;
239 }
240
241 if (name_len > UBI_VOL_NAME_MAX) {
242 err = 10;
243 goto bad;
244 }
245
246 if (name[0] == '\0') {
247 err = 11;
248 goto bad;
249 }
250
251 if (name_len != strnlen(name, name_len + 1)) {
252 err = 12;
253 goto bad;
254 }
255 }
256
257 /* Checks that all names are unique */
258 for (i = 0; i < ubi->vtbl_slots - 1; i++) {
259 for (n = i + 1; n < ubi->vtbl_slots; n++) {
260 int len1 = be16_to_cpu(vtbl[i].name_len);
261 int len2 = be16_to_cpu(vtbl[n].name_len);
262
263 if (len1 > 0 && len1 == len2 &&
264 #ifndef __UBOOT__
265 !strncmp(vtbl[i].name, vtbl[n].name, len1)) {
266 #else
267 !strncmp((char *)vtbl[i].name, vtbl[n].name, len1)) {
268 #endif
269 ubi_err(ubi, "volumes %d and %d have the same name \"%s\"",
270 i, n, vtbl[i].name);
271 ubi_dump_vtbl_record(&vtbl[i], i);
272 ubi_dump_vtbl_record(&vtbl[n], n);
273 return -EINVAL;
274 }
275 }
276 }
277
278 return 0;
279
280 bad:
281 ubi_err(ubi, "volume table check failed: record %d, error %d", i, err);
282 ubi_dump_vtbl_record(&vtbl[i], i);
283 return -EINVAL;
284 }
285
286 /**
287 * create_vtbl - create a copy of volume table.
288 * @ubi: UBI device description object
289 * @ai: attaching information
290 * @copy: number of the volume table copy
291 * @vtbl: contents of the volume table
292 *
293 * This function returns zero in case of success and a negative error code in
294 * case of failure.
295 */
296 static int create_vtbl(struct ubi_device *ubi, struct ubi_attach_info *ai,
297 int copy, void *vtbl)
298 {
299 int err, tries = 0;
300 struct ubi_vid_hdr *vid_hdr;
301 struct ubi_ainf_peb *new_aeb;
302
303 dbg_gen("create volume table (copy #%d)", copy + 1);
304
305 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_KERNEL);
306 if (!vid_hdr)
307 return -ENOMEM;
308
309 retry:
310 new_aeb = ubi_early_get_peb(ubi, ai);
311 if (IS_ERR(new_aeb)) {
312 err = PTR_ERR(new_aeb);
313 goto out_free;
314 }
315
316 vid_hdr->vol_type = UBI_LAYOUT_VOLUME_TYPE;
317 vid_hdr->vol_id = cpu_to_be32(UBI_LAYOUT_VOLUME_ID);
318 vid_hdr->compat = UBI_LAYOUT_VOLUME_COMPAT;
319 vid_hdr->data_size = vid_hdr->used_ebs =
320 vid_hdr->data_pad = cpu_to_be32(0);
321 vid_hdr->lnum = cpu_to_be32(copy);
322 vid_hdr->sqnum = cpu_to_be64(++ai->max_sqnum);
323
324 /* The EC header is already there, write the VID header */
325 err = ubi_io_write_vid_hdr(ubi, new_aeb->pnum, vid_hdr);
326 if (err)
327 goto write_error;
328
329 /* Write the layout volume contents */
330 err = ubi_io_write_data(ubi, vtbl, new_aeb->pnum, 0, ubi->vtbl_size);
331 if (err)
332 goto write_error;
333
334 /*
335 * And add it to the attaching information. Don't delete the old version
336 * of this LEB as it will be deleted and freed in 'ubi_add_to_av()'.
337 */
338 err = ubi_add_to_av(ubi, ai, new_aeb->pnum, new_aeb->ec, vid_hdr, 0);
339 kmem_cache_free(ai->aeb_slab_cache, new_aeb);
340 ubi_free_vid_hdr(ubi, vid_hdr);
341 return err;
342
343 write_error:
344 if (err == -EIO && ++tries <= 5) {
345 /*
346 * Probably this physical eraseblock went bad, try to pick
347 * another one.
348 */
349 list_add(&new_aeb->u.list, &ai->erase);
350 goto retry;
351 }
352 kmem_cache_free(ai->aeb_slab_cache, new_aeb);
353 out_free:
354 ubi_free_vid_hdr(ubi, vid_hdr);
355 return err;
356
357 }
358
359 /**
360 * process_lvol - process the layout volume.
361 * @ubi: UBI device description object
362 * @ai: attaching information
363 * @av: layout volume attaching information
364 *
365 * This function is responsible for reading the layout volume, ensuring it is
366 * not corrupted, and recovering from corruptions if needed. Returns volume
367 * table in case of success and a negative error code in case of failure.
368 */
369 static struct ubi_vtbl_record *process_lvol(struct ubi_device *ubi,
370 struct ubi_attach_info *ai,
371 struct ubi_ainf_volume *av)
372 {
373 int err;
374 struct rb_node *rb;
375 struct ubi_ainf_peb *aeb;
376 struct ubi_vtbl_record *leb[UBI_LAYOUT_VOLUME_EBS] = { NULL, NULL };
377 int leb_corrupted[UBI_LAYOUT_VOLUME_EBS] = {1, 1};
378
379 /*
380 * UBI goes through the following steps when it changes the layout
381 * volume:
382 * a. erase LEB 0;
383 * b. write new data to LEB 0;
384 * c. erase LEB 1;
385 * d. write new data to LEB 1.
386 *
387 * Before the change, both LEBs contain the same data.
388 *
389 * Due to unclean reboots, the contents of LEB 0 may be lost, but there
390 * should LEB 1. So it is OK if LEB 0 is corrupted while LEB 1 is not.
391 * Similarly, LEB 1 may be lost, but there should be LEB 0. And
392 * finally, unclean reboots may result in a situation when neither LEB
393 * 0 nor LEB 1 are corrupted, but they are different. In this case, LEB
394 * 0 contains more recent information.
395 *
396 * So the plan is to first check LEB 0. Then
397 * a. if LEB 0 is OK, it must be containing the most recent data; then
398 * we compare it with LEB 1, and if they are different, we copy LEB
399 * 0 to LEB 1;
400 * b. if LEB 0 is corrupted, but LEB 1 has to be OK, and we copy LEB 1
401 * to LEB 0.
402 */
403
404 dbg_gen("check layout volume");
405
406 /* Read both LEB 0 and LEB 1 into memory */
407 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
408 leb[aeb->lnum] = vzalloc(ubi->vtbl_size);
409 if (!leb[aeb->lnum]) {
410 err = -ENOMEM;
411 goto out_free;
412 }
413
414 err = ubi_io_read_data(ubi, leb[aeb->lnum], aeb->pnum, 0,
415 ubi->vtbl_size);
416 if (err == UBI_IO_BITFLIPS || mtd_is_eccerr(err))
417 /*
418 * Scrub the PEB later. Note, -EBADMSG indicates an
419 * uncorrectable ECC error, but we have our own CRC and
420 * the data will be checked later. If the data is OK,
421 * the PEB will be scrubbed (because we set
422 * aeb->scrub). If the data is not OK, the contents of
423 * the PEB will be recovered from the second copy, and
424 * aeb->scrub will be cleared in
425 * 'ubi_add_to_av()'.
426 */
427 aeb->scrub = 1;
428 else if (err)
429 goto out_free;
430 }
431
432 err = -EINVAL;
433 if (leb[0]) {
434 leb_corrupted[0] = vtbl_check(ubi, leb[0]);
435 if (leb_corrupted[0] < 0)
436 goto out_free;
437 }
438
439 if (!leb_corrupted[0]) {
440 /* LEB 0 is OK */
441 if (leb[1])
442 leb_corrupted[1] = memcmp(leb[0], leb[1],
443 ubi->vtbl_size);
444 if (leb_corrupted[1]) {
445 ubi_warn(ubi, "volume table copy #2 is corrupted");
446 err = create_vtbl(ubi, ai, 1, leb[0]);
447 if (err)
448 goto out_free;
449 ubi_msg(ubi, "volume table was restored");
450 }
451
452 /* Both LEB 1 and LEB 2 are OK and consistent */
453 vfree(leb[1]);
454 return leb[0];
455 } else {
456 /* LEB 0 is corrupted or does not exist */
457 if (leb[1]) {
458 leb_corrupted[1] = vtbl_check(ubi, leb[1]);
459 if (leb_corrupted[1] < 0)
460 goto out_free;
461 }
462 if (leb_corrupted[1]) {
463 /* Both LEB 0 and LEB 1 are corrupted */
464 ubi_err(ubi, "both volume tables are corrupted");
465 goto out_free;
466 }
467
468 ubi_warn(ubi, "volume table copy #1 is corrupted");
469 err = create_vtbl(ubi, ai, 0, leb[1]);
470 if (err)
471 goto out_free;
472 ubi_msg(ubi, "volume table was restored");
473
474 vfree(leb[0]);
475 return leb[1];
476 }
477
478 out_free:
479 vfree(leb[0]);
480 vfree(leb[1]);
481 return ERR_PTR(err);
482 }
483
484 /**
485 * create_empty_lvol - create empty layout volume.
486 * @ubi: UBI device description object
487 * @ai: attaching information
488 *
489 * This function returns volume table contents in case of success and a
490 * negative error code in case of failure.
491 */
492 static struct ubi_vtbl_record *create_empty_lvol(struct ubi_device *ubi,
493 struct ubi_attach_info *ai)
494 {
495 int i;
496 struct ubi_vtbl_record *vtbl;
497
498 vtbl = vzalloc(ubi->vtbl_size);
499 if (!vtbl)
500 return ERR_PTR(-ENOMEM);
501
502 for (i = 0; i < ubi->vtbl_slots; i++)
503 memcpy(&vtbl[i], &empty_vtbl_record, UBI_VTBL_RECORD_SIZE);
504
505 for (i = 0; i < UBI_LAYOUT_VOLUME_EBS; i++) {
506 int err;
507
508 err = create_vtbl(ubi, ai, i, vtbl);
509 if (err) {
510 vfree(vtbl);
511 return ERR_PTR(err);
512 }
513 }
514
515 return vtbl;
516 }
517
518 /**
519 * init_volumes - initialize volume information for existing volumes.
520 * @ubi: UBI device description object
521 * @ai: scanning information
522 * @vtbl: volume table
523 *
524 * This function allocates volume description objects for existing volumes.
525 * Returns zero in case of success and a negative error code in case of
526 * failure.
527 */
528 static int init_volumes(struct ubi_device *ubi,
529 const struct ubi_attach_info *ai,
530 const struct ubi_vtbl_record *vtbl)
531 {
532 int i, reserved_pebs = 0;
533 struct ubi_ainf_volume *av;
534 struct ubi_volume *vol;
535
536 for (i = 0; i < ubi->vtbl_slots; i++) {
537 cond_resched();
538
539 if (be32_to_cpu(vtbl[i].reserved_pebs) == 0)
540 continue; /* Empty record */
541
542 vol = kzalloc(sizeof(struct ubi_volume), GFP_KERNEL);
543 if (!vol)
544 return -ENOMEM;
545
546 vol->reserved_pebs = be32_to_cpu(vtbl[i].reserved_pebs);
547 vol->alignment = be32_to_cpu(vtbl[i].alignment);
548 vol->data_pad = be32_to_cpu(vtbl[i].data_pad);
549 vol->upd_marker = vtbl[i].upd_marker;
550 vol->vol_type = vtbl[i].vol_type == UBI_VID_DYNAMIC ?
551 UBI_DYNAMIC_VOLUME : UBI_STATIC_VOLUME;
552 vol->name_len = be16_to_cpu(vtbl[i].name_len);
553 vol->usable_leb_size = ubi->leb_size - vol->data_pad;
554 memcpy(vol->name, vtbl[i].name, vol->name_len);
555 vol->name[vol->name_len] = '\0';
556 vol->vol_id = i;
557
558 if (vtbl[i].flags & UBI_VTBL_SKIP_CRC_CHECK_FLG)
559 vol->skip_check = 1;
560
561 if (vtbl[i].flags & UBI_VTBL_AUTORESIZE_FLG) {
562 /* Auto re-size flag may be set only for one volume */
563 if (ubi->autoresize_vol_id != -1) {
564 ubi_err(ubi, "more than one auto-resize volume (%d and %d)",
565 ubi->autoresize_vol_id, i);
566 kfree(vol);
567 return -EINVAL;
568 }
569
570 ubi->autoresize_vol_id = i;
571 }
572
573 ubi_assert(!ubi->volumes[i]);
574 ubi->volumes[i] = vol;
575 ubi->vol_count += 1;
576 vol->ubi = ubi;
577 reserved_pebs += vol->reserved_pebs;
578
579 /*
580 * In case of dynamic volume UBI knows nothing about how many
581 * data is stored there. So assume the whole volume is used.
582 */
583 if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
584 vol->used_ebs = vol->reserved_pebs;
585 vol->last_eb_bytes = vol->usable_leb_size;
586 vol->used_bytes =
587 (long long)vol->used_ebs * vol->usable_leb_size;
588 continue;
589 }
590
591 /* Static volumes only */
592 av = ubi_find_av(ai, i);
593 if (!av || !av->leb_count) {
594 /*
595 * No eraseblocks belonging to this volume found. We
596 * don't actually know whether this static volume is
597 * completely corrupted or just contains no data. And
598 * we cannot know this as long as data size is not
599 * stored on flash. So we just assume the volume is
600 * empty. FIXME: this should be handled.
601 */
602 continue;
603 }
604
605 if (av->leb_count != av->used_ebs) {
606 /*
607 * We found a static volume which misses several
608 * eraseblocks. Treat it as corrupted.
609 */
610 ubi_warn(ubi, "static volume %d misses %d LEBs - corrupted",
611 av->vol_id, av->used_ebs - av->leb_count);
612 vol->corrupted = 1;
613 continue;
614 }
615
616 vol->used_ebs = av->used_ebs;
617 vol->used_bytes =
618 (long long)(vol->used_ebs - 1) * vol->usable_leb_size;
619 vol->used_bytes += av->last_data_size;
620 vol->last_eb_bytes = av->last_data_size;
621 }
622
623 /* And add the layout volume */
624 vol = kzalloc(sizeof(struct ubi_volume), GFP_KERNEL);
625 if (!vol)
626 return -ENOMEM;
627
628 vol->reserved_pebs = UBI_LAYOUT_VOLUME_EBS;
629 vol->alignment = UBI_LAYOUT_VOLUME_ALIGN;
630 vol->vol_type = UBI_DYNAMIC_VOLUME;
631 vol->name_len = sizeof(UBI_LAYOUT_VOLUME_NAME) - 1;
632 memcpy(vol->name, UBI_LAYOUT_VOLUME_NAME, vol->name_len + 1);
633 vol->usable_leb_size = ubi->leb_size;
634 vol->used_ebs = vol->reserved_pebs;
635 vol->last_eb_bytes = vol->reserved_pebs;
636 vol->used_bytes =
637 (long long)vol->used_ebs * (ubi->leb_size - vol->data_pad);
638 vol->vol_id = UBI_LAYOUT_VOLUME_ID;
639 vol->ref_count = 1;
640
641 ubi_assert(!ubi->volumes[i]);
642 ubi->volumes[vol_id2idx(ubi, vol->vol_id)] = vol;
643 reserved_pebs += vol->reserved_pebs;
644 ubi->vol_count += 1;
645 vol->ubi = ubi;
646
647 if (reserved_pebs > ubi->avail_pebs) {
648 ubi_err(ubi, "not enough PEBs, required %d, available %d",
649 reserved_pebs, ubi->avail_pebs);
650 if (ubi->corr_peb_count)
651 ubi_err(ubi, "%d PEBs are corrupted and not used",
652 ubi->corr_peb_count);
653 }
654 ubi->rsvd_pebs += reserved_pebs;
655 ubi->avail_pebs -= reserved_pebs;
656
657 return 0;
658 }
659
660 /**
661 * check_av - check volume attaching information.
662 * @vol: UBI volume description object
663 * @av: volume attaching information
664 *
665 * This function returns zero if the volume attaching information is consistent
666 * to the data read from the volume tabla, and %-EINVAL if not.
667 */
668 static int check_av(const struct ubi_volume *vol,
669 const struct ubi_ainf_volume *av)
670 {
671 int err;
672
673 if (av->highest_lnum >= vol->reserved_pebs) {
674 err = 1;
675 goto bad;
676 }
677 if (av->leb_count > vol->reserved_pebs) {
678 err = 2;
679 goto bad;
680 }
681 if (av->vol_type != vol->vol_type) {
682 err = 3;
683 goto bad;
684 }
685 if (av->used_ebs > vol->reserved_pebs) {
686 err = 4;
687 goto bad;
688 }
689 if (av->data_pad != vol->data_pad) {
690 err = 5;
691 goto bad;
692 }
693 return 0;
694
695 bad:
696 ubi_err(vol->ubi, "bad attaching information, error %d", err);
697 ubi_dump_av(av);
698 ubi_dump_vol_info(vol);
699 return -EINVAL;
700 }
701
702 /**
703 * check_attaching_info - check that attaching information.
704 * @ubi: UBI device description object
705 * @ai: attaching information
706 *
707 * Even though we protect on-flash data by CRC checksums, we still don't trust
708 * the media. This function ensures that attaching information is consistent to
709 * the information read from the volume table. Returns zero if the attaching
710 * information is OK and %-EINVAL if it is not.
711 */
712 static int check_attaching_info(const struct ubi_device *ubi,
713 struct ubi_attach_info *ai)
714 {
715 int err, i;
716 struct ubi_ainf_volume *av;
717 struct ubi_volume *vol;
718
719 if (ai->vols_found > UBI_INT_VOL_COUNT + ubi->vtbl_slots) {
720 ubi_err(ubi, "found %d volumes while attaching, maximum is %d + %d",
721 ai->vols_found, UBI_INT_VOL_COUNT, ubi->vtbl_slots);
722 return -EINVAL;
723 }
724
725 if (ai->highest_vol_id >= ubi->vtbl_slots + UBI_INT_VOL_COUNT &&
726 ai->highest_vol_id < UBI_INTERNAL_VOL_START) {
727 ubi_err(ubi, "too large volume ID %d found",
728 ai->highest_vol_id);
729 return -EINVAL;
730 }
731
732 for (i = 0; i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
733 cond_resched();
734
735 av = ubi_find_av(ai, i);
736 vol = ubi->volumes[i];
737 if (!vol) {
738 if (av)
739 ubi_remove_av(ai, av);
740 continue;
741 }
742
743 if (vol->reserved_pebs == 0) {
744 ubi_assert(i < ubi->vtbl_slots);
745
746 if (!av)
747 continue;
748
749 /*
750 * During attaching we found a volume which does not
751 * exist according to the information in the volume
752 * table. This must have happened due to an unclean
753 * reboot while the volume was being removed. Discard
754 * these eraseblocks.
755 */
756 ubi_msg(ubi, "finish volume %d removal", av->vol_id);
757 ubi_remove_av(ai, av);
758 } else if (av) {
759 err = check_av(vol, av);
760 if (err)
761 return err;
762 }
763 }
764
765 return 0;
766 }
767
768 /**
769 * ubi_read_volume_table - read the volume table.
770 * @ubi: UBI device description object
771 * @ai: attaching information
772 *
773 * This function reads volume table, checks it, recover from errors if needed,
774 * or creates it if needed. Returns zero in case of success and a negative
775 * error code in case of failure.
776 */
777 int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai)
778 {
779 int i, err;
780 struct ubi_ainf_volume *av;
781
782 empty_vtbl_record.crc = cpu_to_be32(0xf116c36b);
783
784 /*
785 * The number of supported volumes is limited by the eraseblock size
786 * and by the UBI_MAX_VOLUMES constant.
787 */
788 ubi->vtbl_slots = ubi->leb_size / UBI_VTBL_RECORD_SIZE;
789 if (ubi->vtbl_slots > UBI_MAX_VOLUMES)
790 ubi->vtbl_slots = UBI_MAX_VOLUMES;
791
792 ubi->vtbl_size = ubi->vtbl_slots * UBI_VTBL_RECORD_SIZE;
793 ubi->vtbl_size = ALIGN(ubi->vtbl_size, ubi->min_io_size);
794
795 av = ubi_find_av(ai, UBI_LAYOUT_VOLUME_ID);
796 if (!av) {
797 /*
798 * No logical eraseblocks belonging to the layout volume were
799 * found. This could mean that the flash is just empty. In
800 * this case we create empty layout volume.
801 *
802 * But if flash is not empty this must be a corruption or the
803 * MTD device just contains garbage.
804 */
805 if (ai->is_empty) {
806 ubi->vtbl = create_empty_lvol(ubi, ai);
807 if (IS_ERR(ubi->vtbl))
808 return PTR_ERR(ubi->vtbl);
809 } else {
810 ubi_err(ubi, "the layout volume was not found");
811 return -EINVAL;
812 }
813 } else {
814 if (av->leb_count > UBI_LAYOUT_VOLUME_EBS) {
815 /* This must not happen with proper UBI images */
816 ubi_err(ubi, "too many LEBs (%d) in layout volume",
817 av->leb_count);
818 return -EINVAL;
819 }
820
821 ubi->vtbl = process_lvol(ubi, ai, av);
822 if (IS_ERR(ubi->vtbl))
823 return PTR_ERR(ubi->vtbl);
824 }
825
826 ubi->avail_pebs = ubi->good_peb_count - ubi->corr_peb_count;
827
828 /*
829 * The layout volume is OK, initialize the corresponding in-RAM data
830 * structures.
831 */
832 err = init_volumes(ubi, ai, ubi->vtbl);
833 if (err)
834 goto out_free;
835
836 /*
837 * Make sure that the attaching information is consistent to the
838 * information stored in the volume table.
839 */
840 err = check_attaching_info(ubi, ai);
841 if (err)
842 goto out_free;
843
844 return 0;
845
846 out_free:
847 vfree(ubi->vtbl);
848 for (i = 0; i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
849 kfree(ubi->volumes[i]);
850 ubi->volumes[i] = NULL;
851 }
852 return err;
853 }
854
855 /**
856 * self_vtbl_check - check volume table.
857 * @ubi: UBI device description object
858 */
859 static void self_vtbl_check(const struct ubi_device *ubi)
860 {
861 if (!ubi_dbg_chk_gen(ubi))
862 return;
863
864 if (vtbl_check(ubi, ubi->vtbl)) {
865 ubi_err(ubi, "self-check failed");
866 BUG();
867 }
868 }
869