2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Authors: Adrian Hunter
20 * Artem Bityutskiy (Битюцкий Артём)
24 * This file implements functions needed to recover from unclean un-mounts.
25 * When UBIFS is mounted, it checks a flag on the master node to determine if
26 * an un-mount was completed sucessfully. If not, the process of mounting
27 * incorparates additional checking and fixing of on-flash data structures.
28 * UBIFS always cleans away all remnants of an unclean un-mount, so that
29 * errors do not accumulate. However UBIFS defers recovery if it is mounted
30 * read-only, and the flash is not modified in that case.
33 #include <linux/crc32.h>
37 * is_empty - determine whether a buffer is empty (contains all 0xff).
38 * @buf: buffer to clean
39 * @len: length of buffer
41 * This function returns %1 if the buffer is empty (contains all 0xff) otherwise
44 static int is_empty(void *buf, int len)
49 for (i = 0; i < len; i++)
56 * get_master_node - get the last valid master node allowing for corruption.
57 * @c: UBIFS file-system description object
59 * @pbuf: buffer containing the LEB read, is returned here
60 * @mst: master node, if found, is returned here
61 * @cor: corruption, if found, is returned here
63 * This function allocates a buffer, reads the LEB into it, and finds and
64 * returns the last valid master node allowing for one area of corruption.
65 * The corrupt area, if there is one, must be consistent with the assumption
66 * that it is the result of an unclean unmount while the master node was being
67 * written. Under those circumstances, it is valid to use the previously written
70 * This function returns %0 on success and a negative error code on failure.
72 static int get_master_node(const struct ubifs_info *c, int lnum, void **pbuf,
73 struct ubifs_mst_node **mst, void **cor)
75 const int sz = c->mst_node_alsz;
79 sbuf = vmalloc(c->leb_size);
83 err = ubi_read(c->ubi, lnum, sbuf, 0, c->leb_size);
84 if (err && err != -EBADMSG)
87 /* Find the first position that is definitely not a node */
91 while (offs + UBIFS_MST_NODE_SZ <= c->leb_size) {
92 struct ubifs_ch *ch = buf;
94 if (le32_to_cpu(ch->magic) != UBIFS_NODE_MAGIC)
100 /* See if there was a valid master node before that */
107 ret = ubifs_scan_a_node(c, buf, len, lnum, offs, 1);
108 if (ret != SCANNED_A_NODE && offs) {
109 /* Could have been corruption so check one place back */
113 ret = ubifs_scan_a_node(c, buf, len, lnum, offs, 1);
114 if (ret != SCANNED_A_NODE)
116 * We accept only one area of corruption because
117 * we are assuming that it was caused while
118 * trying to write a master node.
122 if (ret == SCANNED_A_NODE) {
123 struct ubifs_ch *ch = buf;
125 if (ch->node_type != UBIFS_MST_NODE)
127 dbg_rcvry("found a master node at %d:%d", lnum, offs);
134 /* Check for corruption */
135 if (offs < c->leb_size) {
136 if (!is_empty(buf, min_t(int, len, sz))) {
138 dbg_rcvry("found corruption at %d:%d", lnum, offs);
144 /* Check remaining empty space */
145 if (offs < c->leb_size)
146 if (!is_empty(buf, len))
161 * write_rcvrd_mst_node - write recovered master node.
162 * @c: UBIFS file-system description object
165 * This function returns %0 on success and a negative error code on failure.
167 static int write_rcvrd_mst_node(struct ubifs_info *c,
168 struct ubifs_mst_node *mst)
170 int err = 0, lnum = UBIFS_MST_LNUM, sz = c->mst_node_alsz;
173 dbg_rcvry("recovery");
175 save_flags = mst->flags;
176 mst->flags |= cpu_to_le32(UBIFS_MST_RCVRY);
178 ubifs_prepare_node(c, mst, UBIFS_MST_NODE_SZ, 1);
179 err = ubi_leb_change(c->ubi, lnum, mst, sz, UBI_SHORTTERM);
182 err = ubi_leb_change(c->ubi, lnum + 1, mst, sz, UBI_SHORTTERM);
186 mst->flags = save_flags;
191 * ubifs_recover_master_node - recover the master node.
192 * @c: UBIFS file-system description object
194 * This function recovers the master node from corruption that may occur due to
195 * an unclean unmount.
197 * This function returns %0 on success and a negative error code on failure.
199 int ubifs_recover_master_node(struct ubifs_info *c)
201 void *buf1 = NULL, *buf2 = NULL, *cor1 = NULL, *cor2 = NULL;
202 struct ubifs_mst_node *mst1 = NULL, *mst2 = NULL, *mst;
203 const int sz = c->mst_node_alsz;
204 int err, offs1, offs2;
206 dbg_rcvry("recovery");
208 err = get_master_node(c, UBIFS_MST_LNUM, &buf1, &mst1, &cor1);
212 err = get_master_node(c, UBIFS_MST_LNUM + 1, &buf2, &mst2, &cor2);
217 offs1 = (void *)mst1 - buf1;
218 if ((le32_to_cpu(mst1->flags) & UBIFS_MST_RCVRY) &&
219 (offs1 == 0 && !cor1)) {
221 * mst1 was written by recovery at offset 0 with no
224 dbg_rcvry("recovery recovery");
227 offs2 = (void *)mst2 - buf2;
228 if (offs1 == offs2) {
229 /* Same offset, so must be the same */
230 if (memcmp((void *)mst1 + UBIFS_CH_SZ,
231 (void *)mst2 + UBIFS_CH_SZ,
232 UBIFS_MST_NODE_SZ - UBIFS_CH_SZ))
235 } else if (offs2 + sz == offs1) {
236 /* 1st LEB was written, 2nd was not */
240 } else if (offs1 == 0 && offs2 + sz >= c->leb_size) {
241 /* 1st LEB was unmapped and written, 2nd not */
249 * 2nd LEB was unmapped and about to be written, so
250 * there must be only one master node in the first LEB
253 if (offs1 != 0 || cor1)
261 * 1st LEB was unmapped and about to be written, so there must
262 * be no room left in 2nd LEB.
264 offs2 = (void *)mst2 - buf2;
265 if (offs2 + sz + sz <= c->leb_size)
270 dbg_rcvry("recovered master node from LEB %d",
271 (mst == mst1 ? UBIFS_MST_LNUM : UBIFS_MST_LNUM + 1));
273 memcpy(c->mst_node, mst, UBIFS_MST_NODE_SZ);
275 if ((c->vfs_sb->s_flags & MS_RDONLY)) {
276 /* Read-only mode. Keep a copy for switching to rw mode */
277 c->rcvrd_mst_node = kmalloc(sz, GFP_KERNEL);
278 if (!c->rcvrd_mst_node) {
282 memcpy(c->rcvrd_mst_node, c->mst_node, UBIFS_MST_NODE_SZ);
284 /* Write the recovered master node */
285 c->max_sqnum = le64_to_cpu(mst->ch.sqnum) - 1;
286 err = write_rcvrd_mst_node(c, c->mst_node);
299 ubifs_err("failed to recover master node");
301 dbg_err("dumping first master node");
302 dbg_dump_node(c, mst1);
305 dbg_err("dumping second master node");
306 dbg_dump_node(c, mst2);
314 * ubifs_write_rcvrd_mst_node - write the recovered master node.
315 * @c: UBIFS file-system description object
317 * This function writes the master node that was recovered during mounting in
318 * read-only mode and must now be written because we are remounting rw.
320 * This function returns %0 on success and a negative error code on failure.
322 int ubifs_write_rcvrd_mst_node(struct ubifs_info *c)
326 if (!c->rcvrd_mst_node)
328 c->rcvrd_mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
329 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
330 err = write_rcvrd_mst_node(c, c->rcvrd_mst_node);
333 kfree(c->rcvrd_mst_node);
334 c->rcvrd_mst_node = NULL;
339 * is_last_write - determine if an offset was in the last write to a LEB.
340 * @c: UBIFS file-system description object
341 * @buf: buffer to check
342 * @offs: offset to check
344 * This function returns %1 if @offs was in the last write to the LEB whose data
345 * is in @buf, otherwise %0 is returned. The determination is made by checking
346 * for subsequent empty space starting from the next @c->min_io_size boundary.
348 static int is_last_write(const struct ubifs_info *c, void *buf, int offs)
350 int empty_offs, check_len;
354 * Round up to the next @c->min_io_size boundary i.e. @offs is in the
355 * last wbuf written. After that should be empty space.
357 empty_offs = ALIGN(offs + 1, c->min_io_size);
358 check_len = c->leb_size - empty_offs;
359 p = buf + empty_offs - offs;
361 for (; check_len > 0; check_len--)
368 * clean_buf - clean the data from an LEB sitting in a buffer.
369 * @c: UBIFS file-system description object
370 * @buf: buffer to clean
371 * @lnum: LEB number to clean
372 * @offs: offset from which to clean
373 * @len: length of buffer
375 * This function pads up to the next min_io_size boundary (if there is one) and
376 * sets empty space to all 0xff. @buf, @offs and @len are updated to the next
377 * @c->min_io_size boundary.
379 static void clean_buf(const struct ubifs_info *c, void **buf, int lnum,
382 int empty_offs, pad_len;
385 dbg_rcvry("cleaning corruption at %d:%d", lnum, *offs);
387 ubifs_assert(!(*offs & 7));
388 empty_offs = ALIGN(*offs, c->min_io_size);
389 pad_len = empty_offs - *offs;
390 ubifs_pad(c, *buf, pad_len);
394 memset(*buf, 0xff, c->leb_size - empty_offs);
398 * no_more_nodes - determine if there are no more nodes in a buffer.
399 * @c: UBIFS file-system description object
400 * @buf: buffer to check
401 * @len: length of buffer
402 * @lnum: LEB number of the LEB from which @buf was read
403 * @offs: offset from which @buf was read
405 * This function ensures that the corrupted node at @offs is the last thing
406 * written to a LEB. This function returns %1 if more data is not found and
407 * %0 if more data is found.
409 static int no_more_nodes(const struct ubifs_info *c, void *buf, int len,
412 struct ubifs_ch *ch = buf;
413 int skip, dlen = le32_to_cpu(ch->len);
415 /* Check for empty space after the corrupt node's common header */
416 skip = ALIGN(offs + UBIFS_CH_SZ, c->min_io_size) - offs;
417 if (is_empty(buf + skip, len - skip))
420 * The area after the common header size is not empty, so the common
421 * header must be intact. Check it.
423 if (ubifs_check_node(c, buf, lnum, offs, 1, 0) != -EUCLEAN) {
424 dbg_rcvry("unexpected bad common header at %d:%d", lnum, offs);
427 /* Now we know the corrupt node's length we can skip over it */
428 skip = ALIGN(offs + dlen, c->min_io_size) - offs;
429 /* After which there should be empty space */
430 if (is_empty(buf + skip, len - skip))
432 dbg_rcvry("unexpected data at %d:%d", lnum, offs + skip);
437 * fix_unclean_leb - fix an unclean LEB.
438 * @c: UBIFS file-system description object
439 * @sleb: scanned LEB information
440 * @start: offset where scan started
442 static int fix_unclean_leb(struct ubifs_info *c, struct ubifs_scan_leb *sleb,
445 int lnum = sleb->lnum, endpt = start;
447 /* Get the end offset of the last node we are keeping */
448 if (!list_empty(&sleb->nodes)) {
449 struct ubifs_scan_node *snod;
451 snod = list_entry(sleb->nodes.prev,
452 struct ubifs_scan_node, list);
453 endpt = snod->offs + snod->len;
456 if ((c->vfs_sb->s_flags & MS_RDONLY) && !c->remounting_rw) {
457 /* Add to recovery list */
458 struct ubifs_unclean_leb *ucleb;
460 dbg_rcvry("need to fix LEB %d start %d endpt %d",
461 lnum, start, sleb->endpt);
462 ucleb = kzalloc(sizeof(struct ubifs_unclean_leb), GFP_NOFS);
466 ucleb->endpt = endpt;
467 list_add_tail(&ucleb->list, &c->unclean_leb_list);
469 /* Write the fixed LEB back to flash */
472 dbg_rcvry("fixing LEB %d start %d endpt %d",
473 lnum, start, sleb->endpt);
475 err = ubifs_leb_unmap(c, lnum);
479 int len = ALIGN(endpt, c->min_io_size);
482 err = ubi_read(c->ubi, lnum, sleb->buf, 0,
487 /* Pad to min_io_size */
489 int pad_len = len - ALIGN(endpt, 8);
492 void *buf = sleb->buf + len - pad_len;
494 ubifs_pad(c, buf, pad_len);
497 err = ubi_leb_change(c->ubi, lnum, sleb->buf, len,
507 * drop_incomplete_group - drop nodes from an incomplete group.
508 * @sleb: scanned LEB information
509 * @offs: offset of dropped nodes is returned here
511 * This function returns %1 if nodes are dropped and %0 otherwise.
513 static int drop_incomplete_group(struct ubifs_scan_leb *sleb, int *offs)
517 while (!list_empty(&sleb->nodes)) {
518 struct ubifs_scan_node *snod;
521 snod = list_entry(sleb->nodes.prev, struct ubifs_scan_node,
524 if (ch->group_type != UBIFS_IN_NODE_GROUP)
526 dbg_rcvry("dropping node at %d:%d", sleb->lnum, snod->offs);
528 list_del(&snod->list);
530 sleb->nodes_cnt -= 1;
537 * ubifs_recover_leb - scan and recover a LEB.
538 * @c: UBIFS file-system description object
541 * @sbuf: LEB-sized buffer to use
542 * @grouped: nodes may be grouped for recovery
544 * This function does a scan of a LEB, but caters for errors that might have
545 * been caused by the unclean unmount from which we are attempting to recover.
546 * Returns %0 in case of success, %-EUCLEAN if an unrecoverable corruption is
547 * found, and a negative error code in case of failure.
549 struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
550 int offs, void *sbuf, int grouped)
552 int err, len = c->leb_size - offs, need_clean = 0, quiet = 1;
553 int empty_chkd = 0, start = offs;
554 struct ubifs_scan_leb *sleb;
555 void *buf = sbuf + offs;
557 dbg_rcvry("%d:%d", lnum, offs);
559 sleb = ubifs_start_scan(c, lnum, offs, sbuf);
569 dbg_scan("look at LEB %d:%d (%d bytes left)",
575 * Scan quietly until there is an error from which we cannot
578 ret = ubifs_scan_a_node(c, buf, len, lnum, offs, quiet);
580 if (ret == SCANNED_A_NODE) {
581 /* A valid node, and not a padding node */
582 struct ubifs_ch *ch = buf;
585 err = ubifs_add_snod(c, sleb, buf, offs);
588 node_len = ALIGN(le32_to_cpu(ch->len), 8);
596 /* Padding bytes or a valid padding node */
603 if (ret == SCANNED_EMPTY_SPACE) {
604 if (!is_empty(buf, len)) {
605 if (!is_last_write(c, buf, offs))
607 clean_buf(c, &buf, lnum, &offs, &len);
614 if (ret == SCANNED_GARBAGE || ret == SCANNED_A_BAD_PAD_NODE)
615 if (is_last_write(c, buf, offs)) {
616 clean_buf(c, &buf, lnum, &offs, &len);
622 if (ret == SCANNED_A_CORRUPT_NODE)
623 if (no_more_nodes(c, buf, len, lnum, offs)) {
624 clean_buf(c, &buf, lnum, &offs, &len);
631 /* Redo the last scan but noisily */
637 case SCANNED_GARBAGE:
640 case SCANNED_A_CORRUPT_NODE:
641 case SCANNED_A_BAD_PAD_NODE:
651 if (!empty_chkd && !is_empty(buf, len)) {
652 if (is_last_write(c, buf, offs)) {
653 clean_buf(c, &buf, lnum, &offs, &len);
656 ubifs_err("corrupt empty space at LEB %d:%d",
662 /* Drop nodes from incomplete group */
663 if (grouped && drop_incomplete_group(sleb, &offs)) {
665 len = c->leb_size - offs;
666 clean_buf(c, &buf, lnum, &offs, &len);
670 if (offs % c->min_io_size) {
671 clean_buf(c, &buf, lnum, &offs, &len);
675 ubifs_end_scan(c, sleb, lnum, offs);
678 err = fix_unclean_leb(c, sleb, start);
686 ubifs_scanned_corruption(c, lnum, offs, buf);
689 ubifs_err("LEB %d scanning failed", lnum);
690 ubifs_scan_destroy(sleb);
695 * get_cs_sqnum - get commit start sequence number.
696 * @c: UBIFS file-system description object
697 * @lnum: LEB number of commit start node
698 * @offs: offset of commit start node
699 * @cs_sqnum: commit start sequence number is returned here
701 * This function returns %0 on success and a negative error code on failure.
703 static int get_cs_sqnum(struct ubifs_info *c, int lnum, int offs,
704 unsigned long long *cs_sqnum)
706 struct ubifs_cs_node *cs_node = NULL;
709 dbg_rcvry("at %d:%d", lnum, offs);
710 cs_node = kmalloc(UBIFS_CS_NODE_SZ, GFP_KERNEL);
713 if (c->leb_size - offs < UBIFS_CS_NODE_SZ)
715 err = ubi_read(c->ubi, lnum, (void *)cs_node, offs, UBIFS_CS_NODE_SZ);
716 if (err && err != -EBADMSG)
718 ret = ubifs_scan_a_node(c, cs_node, UBIFS_CS_NODE_SZ, lnum, offs, 0);
719 if (ret != SCANNED_A_NODE) {
720 dbg_err("Not a valid node");
723 if (cs_node->ch.node_type != UBIFS_CS_NODE) {
724 dbg_err("Node a CS node, type is %d", cs_node->ch.node_type);
727 if (le64_to_cpu(cs_node->cmt_no) != c->cmt_no) {
728 dbg_err("CS node cmt_no %llu != current cmt_no %llu",
729 (unsigned long long)le64_to_cpu(cs_node->cmt_no),
733 *cs_sqnum = le64_to_cpu(cs_node->ch.sqnum);
734 dbg_rcvry("commit start sqnum %llu", *cs_sqnum);
741 ubifs_err("failed to get CS sqnum");
747 * ubifs_recover_log_leb - scan and recover a log LEB.
748 * @c: UBIFS file-system description object
751 * @sbuf: LEB-sized buffer to use
753 * This function does a scan of a LEB, but caters for errors that might have
754 * been caused by the unclean unmount from which we are attempting to recover.
756 * This function returns %0 on success and a negative error code on failure.
758 struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
759 int offs, void *sbuf)
761 struct ubifs_scan_leb *sleb;
764 dbg_rcvry("LEB %d", lnum);
765 next_lnum = lnum + 1;
766 if (next_lnum >= UBIFS_LOG_LNUM + c->log_lebs)
767 next_lnum = UBIFS_LOG_LNUM;
768 if (next_lnum != c->ltail_lnum) {
770 * We can only recover at the end of the log, so check that the
771 * next log LEB is empty or out of date.
773 sleb = ubifs_scan(c, next_lnum, 0, sbuf);
776 if (sleb->nodes_cnt) {
777 struct ubifs_scan_node *snod;
778 unsigned long long cs_sqnum = c->cs_sqnum;
780 snod = list_entry(sleb->nodes.next,
781 struct ubifs_scan_node, list);
785 err = get_cs_sqnum(c, lnum, offs, &cs_sqnum);
787 ubifs_scan_destroy(sleb);
791 if (snod->sqnum > cs_sqnum) {
792 ubifs_err("unrecoverable log corruption "
794 ubifs_scan_destroy(sleb);
795 return ERR_PTR(-EUCLEAN);
798 ubifs_scan_destroy(sleb);
800 return ubifs_recover_leb(c, lnum, offs, sbuf, 0);
804 * recover_head - recover a head.
805 * @c: UBIFS file-system description object
806 * @lnum: LEB number of head to recover
807 * @offs: offset of head to recover
808 * @sbuf: LEB-sized buffer to use
810 * This function ensures that there is no data on the flash at a head location.
812 * This function returns %0 on success and a negative error code on failure.
814 static int recover_head(const struct ubifs_info *c, int lnum, int offs,
817 int len, err, need_clean = 0;
819 if (c->min_io_size > 1)
820 len = c->min_io_size;
823 if (offs + len > c->leb_size)
824 len = c->leb_size - offs;
829 /* Read at the head location and check it is empty flash */
830 err = ubi_read(c->ubi, lnum, sbuf, offs, len);
844 dbg_rcvry("cleaning head at %d:%d", lnum, offs);
846 return ubifs_leb_unmap(c, lnum);
847 err = ubi_read(c->ubi, lnum, sbuf, 0, offs);
850 return ubi_leb_change(c->ubi, lnum, sbuf, offs, UBI_UNKNOWN);
857 * ubifs_recover_inl_heads - recover index and LPT heads.
858 * @c: UBIFS file-system description object
859 * @sbuf: LEB-sized buffer to use
861 * This function ensures that there is no data on the flash at the index and
862 * LPT head locations.
864 * This deals with the recovery of a half-completed journal commit. UBIFS is
865 * careful never to overwrite the last version of the index or the LPT. Because
866 * the index and LPT are wandering trees, data from a half-completed commit will
867 * not be referenced anywhere in UBIFS. The data will be either in LEBs that are
868 * assumed to be empty and will be unmapped anyway before use, or in the index
871 * This function returns %0 on success and a negative error code on failure.
873 int ubifs_recover_inl_heads(const struct ubifs_info *c, void *sbuf)
877 ubifs_assert(!(c->vfs_sb->s_flags & MS_RDONLY) || c->remounting_rw);
879 dbg_rcvry("checking index head at %d:%d", c->ihead_lnum, c->ihead_offs);
880 err = recover_head(c, c->ihead_lnum, c->ihead_offs, sbuf);
884 dbg_rcvry("checking LPT head at %d:%d", c->nhead_lnum, c->nhead_offs);
885 err = recover_head(c, c->nhead_lnum, c->nhead_offs, sbuf);
893 * clean_an_unclean_leb - read and write a LEB to remove corruption.
894 * @c: UBIFS file-system description object
895 * @ucleb: unclean LEB information
896 * @sbuf: LEB-sized buffer to use
898 * This function reads a LEB up to a point pre-determined by the mount recovery,
899 * checks the nodes, and writes the result back to the flash, thereby cleaning
900 * off any following corruption, or non-fatal ECC errors.
902 * This function returns %0 on success and a negative error code on failure.
904 static int clean_an_unclean_leb(const struct ubifs_info *c,
905 struct ubifs_unclean_leb *ucleb, void *sbuf)
907 int err, lnum = ucleb->lnum, offs = 0, len = ucleb->endpt, quiet = 1;
910 dbg_rcvry("LEB %d len %d", lnum, len);
913 /* Nothing to read, just unmap it */
914 err = ubifs_leb_unmap(c, lnum);
920 err = ubi_read(c->ubi, lnum, buf, offs, len);
921 if (err && err != -EBADMSG)
929 /* Scan quietly until there is an error */
930 ret = ubifs_scan_a_node(c, buf, len, lnum, offs, quiet);
932 if (ret == SCANNED_A_NODE) {
933 /* A valid node, and not a padding node */
934 struct ubifs_ch *ch = buf;
937 node_len = ALIGN(le32_to_cpu(ch->len), 8);
945 /* Padding bytes or a valid padding node */
952 if (ret == SCANNED_EMPTY_SPACE) {
953 ubifs_err("unexpected empty space at %d:%d",
959 /* Redo the last scan but noisily */
964 ubifs_scanned_corruption(c, lnum, offs, buf);
968 /* Pad to min_io_size */
969 len = ALIGN(ucleb->endpt, c->min_io_size);
970 if (len > ucleb->endpt) {
971 int pad_len = len - ALIGN(ucleb->endpt, 8);
974 buf = c->sbuf + len - pad_len;
975 ubifs_pad(c, buf, pad_len);
979 /* Write back the LEB atomically */
980 err = ubi_leb_change(c->ubi, lnum, sbuf, len, UBI_UNKNOWN);
984 dbg_rcvry("cleaned LEB %d", lnum);
990 * ubifs_clean_lebs - clean LEBs recovered during read-only mount.
991 * @c: UBIFS file-system description object
992 * @sbuf: LEB-sized buffer to use
994 * This function cleans a LEB identified during recovery that needs to be
995 * written but was not because UBIFS was mounted read-only. This happens when
996 * remounting to read-write mode.
998 * This function returns %0 on success and a negative error code on failure.
1000 int ubifs_clean_lebs(const struct ubifs_info *c, void *sbuf)
1002 dbg_rcvry("recovery");
1003 while (!list_empty(&c->unclean_leb_list)) {
1004 struct ubifs_unclean_leb *ucleb;
1007 ucleb = list_entry(c->unclean_leb_list.next,
1008 struct ubifs_unclean_leb, list);
1009 err = clean_an_unclean_leb(c, ucleb, sbuf);
1012 list_del(&ucleb->list);
1019 * ubifs_rcvry_gc_commit - recover the GC LEB number and run the commit.
1020 * @c: UBIFS file-system description object
1022 * Out-of-place garbage collection requires always one empty LEB with which to
1023 * start garbage collection. The LEB number is recorded in c->gc_lnum and is
1024 * written to the master node on unmounting. In the case of an unclean unmount
1025 * the value of gc_lnum recorded in the master node is out of date and cannot
1026 * be used. Instead, recovery must allocate an empty LEB for this purpose.
1027 * However, there may not be enough empty space, in which case it must be
1028 * possible to GC the dirtiest LEB into the GC head LEB.
1030 * This function also runs the commit which causes the TNC updates from
1031 * size-recovery and orphans to be written to the flash. That is important to
1032 * ensure correct replay order for subsequent mounts.
1034 * This function returns %0 on success and a negative error code on failure.
1036 int ubifs_rcvry_gc_commit(struct ubifs_info *c)
1038 struct ubifs_wbuf *wbuf = &c->jheads[GCHD].wbuf;
1039 struct ubifs_lprops lp;
1043 if (wbuf->lnum == -1) {
1044 dbg_rcvry("no GC head LEB");
1048 * See whether the used space in the dirtiest LEB fits in the GC head
1051 if (wbuf->offs == c->leb_size) {
1052 dbg_rcvry("no room in GC head LEB");
1055 err = ubifs_find_dirty_leb(c, &lp, wbuf->offs, 2);
1058 dbg_err("could not find a dirty LEB");
1061 ubifs_assert(!(lp.flags & LPROPS_INDEX));
1063 if (lp.free + lp.dirty == c->leb_size) {
1064 /* An empty LEB was returned */
1065 if (lp.free != c->leb_size) {
1066 err = ubifs_change_one_lp(c, lnum, c->leb_size,
1071 err = ubifs_leb_unmap(c, lnum);
1075 dbg_rcvry("allocated LEB %d for GC", lnum);
1076 /* Run the commit */
1077 dbg_rcvry("committing");
1078 return ubifs_run_commit(c);
1081 * There was no empty LEB so the used space in the dirtiest LEB must fit
1082 * in the GC head LEB.
1084 if (lp.free + lp.dirty < wbuf->offs) {
1085 dbg_rcvry("LEB %d doesn't fit in GC head LEB %d:%d",
1086 lnum, wbuf->lnum, wbuf->offs);
1087 err = ubifs_return_leb(c, lnum);
1093 * We run the commit before garbage collection otherwise subsequent
1094 * mounts will see the GC and orphan deletion in a different order.
1096 dbg_rcvry("committing");
1097 err = ubifs_run_commit(c);
1101 * The data in the dirtiest LEB fits in the GC head LEB, so do the GC
1102 * - use locking to keep 'ubifs_assert()' happy.
1104 dbg_rcvry("GC'ing LEB %d", lnum);
1105 mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
1106 err = ubifs_garbage_collect_leb(c, &lp);
1108 int err2 = ubifs_wbuf_sync_nolock(wbuf);
1113 mutex_unlock(&wbuf->io_mutex);
1115 dbg_err("GC failed, error %d", err);
1120 if (err != LEB_RETAINED) {
1121 dbg_err("GC returned %d", err);
1124 err = ubifs_leb_unmap(c, c->gc_lnum);
1127 dbg_rcvry("allocated LEB %d for GC", lnum);
1132 * There is no GC head LEB or the free space in the GC head LEB is too
1133 * small. Allocate gc_lnum by calling 'ubifs_find_free_leb_for_idx()' so
1136 lnum = ubifs_find_free_leb_for_idx(c);
1138 dbg_err("could not find an empty LEB");
1141 /* And reset the index flag */
1142 err = ubifs_change_one_lp(c, lnum, LPROPS_NC, LPROPS_NC, 0,
1147 dbg_rcvry("allocated LEB %d for GC", lnum);
1148 /* Run the commit */
1149 dbg_rcvry("committing");
1150 return ubifs_run_commit(c);
1154 * struct size_entry - inode size information for recovery.
1155 * @rb: link in the RB-tree of sizes
1156 * @inum: inode number
1157 * @i_size: size on inode
1158 * @d_size: maximum size based on data nodes
1159 * @exists: indicates whether the inode exists
1160 * @inode: inode if pinned in memory awaiting rw mode to fix it
1168 struct inode *inode;
1172 * add_ino - add an entry to the size tree.
1173 * @c: UBIFS file-system description object
1174 * @inum: inode number
1175 * @i_size: size on inode
1176 * @d_size: maximum size based on data nodes
1177 * @exists: indicates whether the inode exists
1179 static int add_ino(struct ubifs_info *c, ino_t inum, loff_t i_size,
1180 loff_t d_size, int exists)
1182 struct rb_node **p = &c->size_tree.rb_node, *parent = NULL;
1183 struct size_entry *e;
1187 e = rb_entry(parent, struct size_entry, rb);
1191 p = &(*p)->rb_right;
1194 e = kzalloc(sizeof(struct size_entry), GFP_KERNEL);
1203 rb_link_node(&e->rb, parent, p);
1204 rb_insert_color(&e->rb, &c->size_tree);
1210 * find_ino - find an entry on the size tree.
1211 * @c: UBIFS file-system description object
1212 * @inum: inode number
1214 static struct size_entry *find_ino(struct ubifs_info *c, ino_t inum)
1216 struct rb_node *p = c->size_tree.rb_node;
1217 struct size_entry *e;
1220 e = rb_entry(p, struct size_entry, rb);
1223 else if (inum > e->inum)
1232 * remove_ino - remove an entry from the size tree.
1233 * @c: UBIFS file-system description object
1234 * @inum: inode number
1236 static void remove_ino(struct ubifs_info *c, ino_t inum)
1238 struct size_entry *e = find_ino(c, inum);
1242 rb_erase(&e->rb, &c->size_tree);
1247 * ubifs_destroy_size_tree - free resources related to the size tree.
1248 * @c: UBIFS file-system description object
1250 void ubifs_destroy_size_tree(struct ubifs_info *c)
1252 struct rb_node *this = c->size_tree.rb_node;
1253 struct size_entry *e;
1256 if (this->rb_left) {
1257 this = this->rb_left;
1259 } else if (this->rb_right) {
1260 this = this->rb_right;
1263 e = rb_entry(this, struct size_entry, rb);
1266 this = rb_parent(this);
1268 if (this->rb_left == &e->rb)
1269 this->rb_left = NULL;
1271 this->rb_right = NULL;
1275 c->size_tree = RB_ROOT;
1279 * ubifs_recover_size_accum - accumulate inode sizes for recovery.
1280 * @c: UBIFS file-system description object
1282 * @deletion: node is for a deletion
1283 * @new_size: inode size
1285 * This function has two purposes:
1286 * 1) to ensure there are no data nodes that fall outside the inode size
1287 * 2) to ensure there are no data nodes for inodes that do not exist
1288 * To accomplish those purposes, a rb-tree is constructed containing an entry
1289 * for each inode number in the journal that has not been deleted, and recording
1290 * the size from the inode node, the maximum size of any data node (also altered
1291 * by truncations) and a flag indicating a inode number for which no inode node
1292 * was present in the journal.
1294 * Note that there is still the possibility that there are data nodes that have
1295 * been committed that are beyond the inode size, however the only way to find
1296 * them would be to scan the entire index. Alternatively, some provision could
1297 * be made to record the size of inodes at the start of commit, which would seem
1298 * very cumbersome for a scenario that is quite unlikely and the only negative
1299 * consequence of which is wasted space.
1301 * This functions returns %0 on success and a negative error code on failure.
1303 int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
1304 int deletion, loff_t new_size)
1306 ino_t inum = key_inum(c, key);
1307 struct size_entry *e;
1310 switch (key_type(c, key)) {
1313 remove_ino(c, inum);
1315 e = find_ino(c, inum);
1317 e->i_size = new_size;
1320 err = add_ino(c, inum, new_size, 0, 1);
1326 case UBIFS_DATA_KEY:
1327 e = find_ino(c, inum);
1329 if (new_size > e->d_size)
1330 e->d_size = new_size;
1332 err = add_ino(c, inum, 0, new_size, 0);
1337 case UBIFS_TRUN_KEY:
1338 e = find_ino(c, inum);
1340 e->d_size = new_size;
1347 * fix_size_in_place - fix inode size in place on flash.
1348 * @c: UBIFS file-system description object
1349 * @e: inode size information for recovery
1351 static int fix_size_in_place(struct ubifs_info *c, struct size_entry *e)
1353 struct ubifs_ino_node *ino = c->sbuf;
1355 union ubifs_key key;
1356 int err, lnum, offs, len;
1360 /* Locate the inode node LEB number and offset */
1361 ino_key_init(c, &key, e->inum);
1362 err = ubifs_tnc_locate(c, &key, ino, &lnum, &offs);
1366 * If the size recorded on the inode node is greater than the size that
1367 * was calculated from nodes in the journal then don't change the inode.
1369 i_size = le64_to_cpu(ino->size);
1370 if (i_size >= e->d_size)
1373 err = ubi_read(c->ubi, lnum, c->sbuf, 0, c->leb_size);
1376 /* Change the size field and recalculate the CRC */
1377 ino = c->sbuf + offs;
1378 ino->size = cpu_to_le64(e->d_size);
1379 len = le32_to_cpu(ino->ch.len);
1380 crc = crc32(UBIFS_CRC32_INIT, (void *)ino + 8, len - 8);
1381 ino->ch.crc = cpu_to_le32(crc);
1382 /* Work out where data in the LEB ends and free space begins */
1384 len = c->leb_size - 1;
1385 while (p[len] == 0xff)
1387 len = ALIGN(len + 1, c->min_io_size);
1388 /* Atomically write the fixed LEB back again */
1389 err = ubi_leb_change(c->ubi, lnum, c->sbuf, len, UBI_UNKNOWN);
1392 dbg_rcvry("inode %lu at %d:%d size %lld -> %lld ",
1393 (unsigned long)e->inum, lnum, offs, i_size, e->d_size);
1397 ubifs_warn("inode %lu failed to fix size %lld -> %lld error %d",
1398 (unsigned long)e->inum, e->i_size, e->d_size, err);
1403 * ubifs_recover_size - recover inode size.
1404 * @c: UBIFS file-system description object
1406 * This function attempts to fix inode size discrepancies identified by the
1407 * 'ubifs_recover_size_accum()' function.
1409 * This functions returns %0 on success and a negative error code on failure.
1411 int ubifs_recover_size(struct ubifs_info *c)
1413 struct rb_node *this = rb_first(&c->size_tree);
1416 struct size_entry *e;
1419 e = rb_entry(this, struct size_entry, rb);
1421 union ubifs_key key;
1423 ino_key_init(c, &key, e->inum);
1424 err = ubifs_tnc_lookup(c, &key, c->sbuf);
1425 if (err && err != -ENOENT)
1427 if (err == -ENOENT) {
1428 /* Remove data nodes that have no inode */
1429 dbg_rcvry("removing ino %lu",
1430 (unsigned long)e->inum);
1431 err = ubifs_tnc_remove_ino(c, e->inum);
1435 struct ubifs_ino_node *ino = c->sbuf;
1438 e->i_size = le64_to_cpu(ino->size);
1441 if (e->exists && e->i_size < e->d_size) {
1442 if (!e->inode && (c->vfs_sb->s_flags & MS_RDONLY)) {
1443 /* Fix the inode size and pin it in memory */
1444 struct inode *inode;
1446 inode = ubifs_iget(c->vfs_sb, e->inum);
1448 return PTR_ERR(inode);
1449 if (inode->i_size < e->d_size) {
1450 dbg_rcvry("ino %lu size %lld -> %lld",
1451 (unsigned long)e->inum,
1452 e->d_size, inode->i_size);
1453 inode->i_size = e->d_size;
1454 ubifs_inode(inode)->ui_size = e->d_size;
1456 this = rb_next(this);
1461 /* Fix the size in place */
1462 err = fix_size_in_place(c, e);
1469 this = rb_next(this);
1470 rb_erase(&e->rb, &c->size_tree);