xref: /rk3399_rockchip-uboot/fs/ubifs/recovery.c (revision e573bdb324c78fac56655a493bea843842c9d9f8)
19eefe2a2SStefan Roese /*
29eefe2a2SStefan Roese  * This file is part of UBIFS.
39eefe2a2SStefan Roese  *
49eefe2a2SStefan Roese  * Copyright (C) 2006-2008 Nokia Corporation
59eefe2a2SStefan Roese  *
6ff94bc40SHeiko Schocher  * SPDX-License-Identifier:	GPL-2.0+
79eefe2a2SStefan Roese  *
89eefe2a2SStefan Roese  * Authors: Adrian Hunter
99eefe2a2SStefan Roese  *          Artem Bityutskiy (Битюцкий Артём)
109eefe2a2SStefan Roese  */
119eefe2a2SStefan Roese 
129eefe2a2SStefan Roese /*
139eefe2a2SStefan Roese  * This file implements functions needed to recover from unclean un-mounts.
149eefe2a2SStefan Roese  * When UBIFS is mounted, it checks a flag on the master node to determine if
15ff94bc40SHeiko Schocher  * an un-mount was completed successfully. If not, the process of mounting
16ff94bc40SHeiko Schocher  * incorporates additional checking and fixing of on-flash data structures.
179eefe2a2SStefan Roese  * UBIFS always cleans away all remnants of an unclean un-mount, so that
189eefe2a2SStefan Roese  * errors do not accumulate. However UBIFS defers recovery if it is mounted
199eefe2a2SStefan Roese  * read-only, and the flash is not modified in that case.
20ff94bc40SHeiko Schocher  *
21ff94bc40SHeiko Schocher  * The general UBIFS approach to the recovery is that it recovers from
22ff94bc40SHeiko Schocher  * corruptions which could be caused by power cuts, but it refuses to recover
23ff94bc40SHeiko Schocher  * from corruption caused by other reasons. And UBIFS tries to distinguish
24ff94bc40SHeiko Schocher  * between these 2 reasons of corruptions and silently recover in the former
25ff94bc40SHeiko Schocher  * case and loudly complain in the latter case.
26ff94bc40SHeiko Schocher  *
27ff94bc40SHeiko Schocher  * UBIFS writes only to erased LEBs, so it writes only to the flash space
28ff94bc40SHeiko Schocher  * containing only 0xFFs. UBIFS also always writes strictly from the beginning
29ff94bc40SHeiko Schocher  * of the LEB to the end. And UBIFS assumes that the underlying flash media
30ff94bc40SHeiko Schocher  * writes in @c->max_write_size bytes at a time.
31ff94bc40SHeiko Schocher  *
32ff94bc40SHeiko Schocher  * Hence, if UBIFS finds a corrupted node at offset X, it expects only the min.
33ff94bc40SHeiko Schocher  * I/O unit corresponding to offset X to contain corrupted data, all the
34ff94bc40SHeiko Schocher  * following min. I/O units have to contain empty space (all 0xFFs). If this is
35ff94bc40SHeiko Schocher  * not true, the corruption cannot be the result of a power cut, and UBIFS
36ff94bc40SHeiko Schocher  * refuses to mount.
379eefe2a2SStefan Roese  */
389eefe2a2SStefan Roese 
39ff94bc40SHeiko Schocher #ifndef __UBOOT__
40ff94bc40SHeiko Schocher #include <linux/crc32.h>
41ff94bc40SHeiko Schocher #include <linux/slab.h>
42ff94bc40SHeiko Schocher #else
43ff94bc40SHeiko Schocher #include <linux/err.h>
44ff94bc40SHeiko Schocher #endif
459eefe2a2SStefan Roese #include "ubifs.h"
469eefe2a2SStefan Roese 
479eefe2a2SStefan Roese /**
489eefe2a2SStefan Roese  * is_empty - determine whether a buffer is empty (contains all 0xff).
499eefe2a2SStefan Roese  * @buf: buffer to clean
509eefe2a2SStefan Roese  * @len: length of buffer
519eefe2a2SStefan Roese  *
529eefe2a2SStefan Roese  * This function returns %1 if the buffer is empty (contains all 0xff) otherwise
539eefe2a2SStefan Roese  * %0 is returned.
549eefe2a2SStefan Roese  */
is_empty(void * buf,int len)559eefe2a2SStefan Roese static int is_empty(void *buf, int len)
569eefe2a2SStefan Roese {
579eefe2a2SStefan Roese 	uint8_t *p = buf;
589eefe2a2SStefan Roese 	int i;
599eefe2a2SStefan Roese 
609eefe2a2SStefan Roese 	for (i = 0; i < len; i++)
619eefe2a2SStefan Roese 		if (*p++ != 0xff)
629eefe2a2SStefan Roese 			return 0;
639eefe2a2SStefan Roese 	return 1;
649eefe2a2SStefan Roese }
659eefe2a2SStefan Roese 
669eefe2a2SStefan Roese /**
67ff94bc40SHeiko Schocher  * first_non_ff - find offset of the first non-0xff byte.
68ff94bc40SHeiko Schocher  * @buf: buffer to search in
69ff94bc40SHeiko Schocher  * @len: length of buffer
70ff94bc40SHeiko Schocher  *
71ff94bc40SHeiko Schocher  * This function returns offset of the first non-0xff byte in @buf or %-1 if
72ff94bc40SHeiko Schocher  * the buffer contains only 0xff bytes.
73ff94bc40SHeiko Schocher  */
first_non_ff(void * buf,int len)74ff94bc40SHeiko Schocher static int first_non_ff(void *buf, int len)
75ff94bc40SHeiko Schocher {
76ff94bc40SHeiko Schocher 	uint8_t *p = buf;
77ff94bc40SHeiko Schocher 	int i;
78ff94bc40SHeiko Schocher 
79ff94bc40SHeiko Schocher 	for (i = 0; i < len; i++)
80ff94bc40SHeiko Schocher 		if (*p++ != 0xff)
81ff94bc40SHeiko Schocher 			return i;
82ff94bc40SHeiko Schocher 	return -1;
83ff94bc40SHeiko Schocher }
84ff94bc40SHeiko Schocher 
85ff94bc40SHeiko Schocher /**
869eefe2a2SStefan Roese  * get_master_node - get the last valid master node allowing for corruption.
879eefe2a2SStefan Roese  * @c: UBIFS file-system description object
889eefe2a2SStefan Roese  * @lnum: LEB number
899eefe2a2SStefan Roese  * @pbuf: buffer containing the LEB read, is returned here
909eefe2a2SStefan Roese  * @mst: master node, if found, is returned here
919eefe2a2SStefan Roese  * @cor: corruption, if found, is returned here
929eefe2a2SStefan Roese  *
939eefe2a2SStefan Roese  * This function allocates a buffer, reads the LEB into it, and finds and
949eefe2a2SStefan Roese  * returns the last valid master node allowing for one area of corruption.
959eefe2a2SStefan Roese  * The corrupt area, if there is one, must be consistent with the assumption
969eefe2a2SStefan Roese  * that it is the result of an unclean unmount while the master node was being
979eefe2a2SStefan Roese  * written. Under those circumstances, it is valid to use the previously written
989eefe2a2SStefan Roese  * master node.
999eefe2a2SStefan Roese  *
1009eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
1019eefe2a2SStefan Roese  */
get_master_node(const struct ubifs_info * c,int lnum,void ** pbuf,struct ubifs_mst_node ** mst,void ** cor)1029eefe2a2SStefan Roese static int get_master_node(const struct ubifs_info *c, int lnum, void **pbuf,
1039eefe2a2SStefan Roese 			   struct ubifs_mst_node **mst, void **cor)
1049eefe2a2SStefan Roese {
1059eefe2a2SStefan Roese 	const int sz = c->mst_node_alsz;
1069eefe2a2SStefan Roese 	int err, offs, len;
1079eefe2a2SStefan Roese 	void *sbuf, *buf;
1089eefe2a2SStefan Roese 
1099eefe2a2SStefan Roese 	sbuf = vmalloc(c->leb_size);
1109eefe2a2SStefan Roese 	if (!sbuf)
1119eefe2a2SStefan Roese 		return -ENOMEM;
1129eefe2a2SStefan Roese 
113ff94bc40SHeiko Schocher 	err = ubifs_leb_read(c, lnum, sbuf, 0, c->leb_size, 0);
1149eefe2a2SStefan Roese 	if (err && err != -EBADMSG)
1159eefe2a2SStefan Roese 		goto out_free;
1169eefe2a2SStefan Roese 
1179eefe2a2SStefan Roese 	/* Find the first position that is definitely not a node */
1189eefe2a2SStefan Roese 	offs = 0;
1199eefe2a2SStefan Roese 	buf = sbuf;
1209eefe2a2SStefan Roese 	len = c->leb_size;
1219eefe2a2SStefan Roese 	while (offs + UBIFS_MST_NODE_SZ <= c->leb_size) {
1229eefe2a2SStefan Roese 		struct ubifs_ch *ch = buf;
1239eefe2a2SStefan Roese 
1249eefe2a2SStefan Roese 		if (le32_to_cpu(ch->magic) != UBIFS_NODE_MAGIC)
1259eefe2a2SStefan Roese 			break;
1269eefe2a2SStefan Roese 		offs += sz;
1279eefe2a2SStefan Roese 		buf  += sz;
1289eefe2a2SStefan Roese 		len  -= sz;
1299eefe2a2SStefan Roese 	}
1309eefe2a2SStefan Roese 	/* See if there was a valid master node before that */
1319eefe2a2SStefan Roese 	if (offs) {
1329eefe2a2SStefan Roese 		int ret;
1339eefe2a2SStefan Roese 
1349eefe2a2SStefan Roese 		offs -= sz;
1359eefe2a2SStefan Roese 		buf  -= sz;
1369eefe2a2SStefan Roese 		len  += sz;
1379eefe2a2SStefan Roese 		ret = ubifs_scan_a_node(c, buf, len, lnum, offs, 1);
1389eefe2a2SStefan Roese 		if (ret != SCANNED_A_NODE && offs) {
1399eefe2a2SStefan Roese 			/* Could have been corruption so check one place back */
1409eefe2a2SStefan Roese 			offs -= sz;
1419eefe2a2SStefan Roese 			buf  -= sz;
1429eefe2a2SStefan Roese 			len  += sz;
1439eefe2a2SStefan Roese 			ret = ubifs_scan_a_node(c, buf, len, lnum, offs, 1);
1449eefe2a2SStefan Roese 			if (ret != SCANNED_A_NODE)
1459eefe2a2SStefan Roese 				/*
1469eefe2a2SStefan Roese 				 * We accept only one area of corruption because
1479eefe2a2SStefan Roese 				 * we are assuming that it was caused while
1489eefe2a2SStefan Roese 				 * trying to write a master node.
1499eefe2a2SStefan Roese 				 */
1509eefe2a2SStefan Roese 				goto out_err;
1519eefe2a2SStefan Roese 		}
1529eefe2a2SStefan Roese 		if (ret == SCANNED_A_NODE) {
1539eefe2a2SStefan Roese 			struct ubifs_ch *ch = buf;
1549eefe2a2SStefan Roese 
1559eefe2a2SStefan Roese 			if (ch->node_type != UBIFS_MST_NODE)
1569eefe2a2SStefan Roese 				goto out_err;
1579eefe2a2SStefan Roese 			dbg_rcvry("found a master node at %d:%d", lnum, offs);
1589eefe2a2SStefan Roese 			*mst = buf;
1599eefe2a2SStefan Roese 			offs += sz;
1609eefe2a2SStefan Roese 			buf  += sz;
1619eefe2a2SStefan Roese 			len  -= sz;
1629eefe2a2SStefan Roese 		}
1639eefe2a2SStefan Roese 	}
1649eefe2a2SStefan Roese 	/* Check for corruption */
1659eefe2a2SStefan Roese 	if (offs < c->leb_size) {
1669eefe2a2SStefan Roese 		if (!is_empty(buf, min_t(int, len, sz))) {
1679eefe2a2SStefan Roese 			*cor = buf;
1689eefe2a2SStefan Roese 			dbg_rcvry("found corruption at %d:%d", lnum, offs);
1699eefe2a2SStefan Roese 		}
1709eefe2a2SStefan Roese 		offs += sz;
1719eefe2a2SStefan Roese 		buf  += sz;
1729eefe2a2SStefan Roese 		len  -= sz;
1739eefe2a2SStefan Roese 	}
1749eefe2a2SStefan Roese 	/* Check remaining empty space */
1759eefe2a2SStefan Roese 	if (offs < c->leb_size)
1769eefe2a2SStefan Roese 		if (!is_empty(buf, len))
1779eefe2a2SStefan Roese 			goto out_err;
1789eefe2a2SStefan Roese 	*pbuf = sbuf;
1799eefe2a2SStefan Roese 	return 0;
1809eefe2a2SStefan Roese 
1819eefe2a2SStefan Roese out_err:
1829eefe2a2SStefan Roese 	err = -EINVAL;
1839eefe2a2SStefan Roese out_free:
1849eefe2a2SStefan Roese 	vfree(sbuf);
1859eefe2a2SStefan Roese 	*mst = NULL;
1869eefe2a2SStefan Roese 	*cor = NULL;
1879eefe2a2SStefan Roese 	return err;
1889eefe2a2SStefan Roese }
1899eefe2a2SStefan Roese 
1909eefe2a2SStefan Roese /**
1919eefe2a2SStefan Roese  * write_rcvrd_mst_node - write recovered master node.
1929eefe2a2SStefan Roese  * @c: UBIFS file-system description object
1939eefe2a2SStefan Roese  * @mst: master node
1949eefe2a2SStefan Roese  *
1959eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
1969eefe2a2SStefan Roese  */
write_rcvrd_mst_node(struct ubifs_info * c,struct ubifs_mst_node * mst)1979eefe2a2SStefan Roese static int write_rcvrd_mst_node(struct ubifs_info *c,
1989eefe2a2SStefan Roese 				struct ubifs_mst_node *mst)
1999eefe2a2SStefan Roese {
2009eefe2a2SStefan Roese 	int err = 0, lnum = UBIFS_MST_LNUM, sz = c->mst_node_alsz;
2019eefe2a2SStefan Roese 	__le32 save_flags;
2029eefe2a2SStefan Roese 
2039eefe2a2SStefan Roese 	dbg_rcvry("recovery");
2049eefe2a2SStefan Roese 
2059eefe2a2SStefan Roese 	save_flags = mst->flags;
2069eefe2a2SStefan Roese 	mst->flags |= cpu_to_le32(UBIFS_MST_RCVRY);
2079eefe2a2SStefan Roese 
2089eefe2a2SStefan Roese 	ubifs_prepare_node(c, mst, UBIFS_MST_NODE_SZ, 1);
209ff94bc40SHeiko Schocher 	err = ubifs_leb_change(c, lnum, mst, sz);
2109eefe2a2SStefan Roese 	if (err)
2119eefe2a2SStefan Roese 		goto out;
212ff94bc40SHeiko Schocher 	err = ubifs_leb_change(c, lnum + 1, mst, sz);
2139eefe2a2SStefan Roese 	if (err)
2149eefe2a2SStefan Roese 		goto out;
2159eefe2a2SStefan Roese out:
2169eefe2a2SStefan Roese 	mst->flags = save_flags;
2179eefe2a2SStefan Roese 	return err;
2189eefe2a2SStefan Roese }
2199eefe2a2SStefan Roese 
2209eefe2a2SStefan Roese /**
2219eefe2a2SStefan Roese  * ubifs_recover_master_node - recover the master node.
2229eefe2a2SStefan Roese  * @c: UBIFS file-system description object
2239eefe2a2SStefan Roese  *
2249eefe2a2SStefan Roese  * This function recovers the master node from corruption that may occur due to
2259eefe2a2SStefan Roese  * an unclean unmount.
2269eefe2a2SStefan Roese  *
2279eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
2289eefe2a2SStefan Roese  */
ubifs_recover_master_node(struct ubifs_info * c)2299eefe2a2SStefan Roese int ubifs_recover_master_node(struct ubifs_info *c)
2309eefe2a2SStefan Roese {
2319eefe2a2SStefan Roese 	void *buf1 = NULL, *buf2 = NULL, *cor1 = NULL, *cor2 = NULL;
2329eefe2a2SStefan Roese 	struct ubifs_mst_node *mst1 = NULL, *mst2 = NULL, *mst;
2339eefe2a2SStefan Roese 	const int sz = c->mst_node_alsz;
2349eefe2a2SStefan Roese 	int err, offs1, offs2;
2359eefe2a2SStefan Roese 
2369eefe2a2SStefan Roese 	dbg_rcvry("recovery");
2379eefe2a2SStefan Roese 
2389eefe2a2SStefan Roese 	err = get_master_node(c, UBIFS_MST_LNUM, &buf1, &mst1, &cor1);
2399eefe2a2SStefan Roese 	if (err)
2409eefe2a2SStefan Roese 		goto out_free;
2419eefe2a2SStefan Roese 
2429eefe2a2SStefan Roese 	err = get_master_node(c, UBIFS_MST_LNUM + 1, &buf2, &mst2, &cor2);
2439eefe2a2SStefan Roese 	if (err)
2449eefe2a2SStefan Roese 		goto out_free;
2459eefe2a2SStefan Roese 
2469eefe2a2SStefan Roese 	if (mst1) {
2479eefe2a2SStefan Roese 		offs1 = (void *)mst1 - buf1;
2489eefe2a2SStefan Roese 		if ((le32_to_cpu(mst1->flags) & UBIFS_MST_RCVRY) &&
2499eefe2a2SStefan Roese 		    (offs1 == 0 && !cor1)) {
2509eefe2a2SStefan Roese 			/*
2519eefe2a2SStefan Roese 			 * mst1 was written by recovery at offset 0 with no
2529eefe2a2SStefan Roese 			 * corruption.
2539eefe2a2SStefan Roese 			 */
2549eefe2a2SStefan Roese 			dbg_rcvry("recovery recovery");
2559eefe2a2SStefan Roese 			mst = mst1;
2569eefe2a2SStefan Roese 		} else if (mst2) {
2579eefe2a2SStefan Roese 			offs2 = (void *)mst2 - buf2;
2589eefe2a2SStefan Roese 			if (offs1 == offs2) {
2599eefe2a2SStefan Roese 				/* Same offset, so must be the same */
2609eefe2a2SStefan Roese 				if (memcmp((void *)mst1 + UBIFS_CH_SZ,
2619eefe2a2SStefan Roese 					   (void *)mst2 + UBIFS_CH_SZ,
2629eefe2a2SStefan Roese 					   UBIFS_MST_NODE_SZ - UBIFS_CH_SZ))
2639eefe2a2SStefan Roese 					goto out_err;
2649eefe2a2SStefan Roese 				mst = mst1;
2659eefe2a2SStefan Roese 			} else if (offs2 + sz == offs1) {
2669eefe2a2SStefan Roese 				/* 1st LEB was written, 2nd was not */
2679eefe2a2SStefan Roese 				if (cor1)
2689eefe2a2SStefan Roese 					goto out_err;
2699eefe2a2SStefan Roese 				mst = mst1;
270ff94bc40SHeiko Schocher 			} else if (offs1 == 0 &&
271ff94bc40SHeiko Schocher 				   c->leb_size - offs2 - sz < sz) {
2729eefe2a2SStefan Roese 				/* 1st LEB was unmapped and written, 2nd not */
2739eefe2a2SStefan Roese 				if (cor1)
2749eefe2a2SStefan Roese 					goto out_err;
2759eefe2a2SStefan Roese 				mst = mst1;
2769eefe2a2SStefan Roese 			} else
2779eefe2a2SStefan Roese 				goto out_err;
2789eefe2a2SStefan Roese 		} else {
2799eefe2a2SStefan Roese 			/*
2809eefe2a2SStefan Roese 			 * 2nd LEB was unmapped and about to be written, so
2819eefe2a2SStefan Roese 			 * there must be only one master node in the first LEB
2829eefe2a2SStefan Roese 			 * and no corruption.
2839eefe2a2SStefan Roese 			 */
2849eefe2a2SStefan Roese 			if (offs1 != 0 || cor1)
2859eefe2a2SStefan Roese 				goto out_err;
2869eefe2a2SStefan Roese 			mst = mst1;
2879eefe2a2SStefan Roese 		}
2889eefe2a2SStefan Roese 	} else {
2899eefe2a2SStefan Roese 		if (!mst2)
2909eefe2a2SStefan Roese 			goto out_err;
2919eefe2a2SStefan Roese 		/*
2929eefe2a2SStefan Roese 		 * 1st LEB was unmapped and about to be written, so there must
2939eefe2a2SStefan Roese 		 * be no room left in 2nd LEB.
2949eefe2a2SStefan Roese 		 */
2959eefe2a2SStefan Roese 		offs2 = (void *)mst2 - buf2;
2969eefe2a2SStefan Roese 		if (offs2 + sz + sz <= c->leb_size)
2979eefe2a2SStefan Roese 			goto out_err;
2989eefe2a2SStefan Roese 		mst = mst2;
2999eefe2a2SStefan Roese 	}
3009eefe2a2SStefan Roese 
301*0195a7bbSHeiko Schocher 	ubifs_msg(c, "recovered master node from LEB %d",
3029eefe2a2SStefan Roese 		  (mst == mst1 ? UBIFS_MST_LNUM : UBIFS_MST_LNUM + 1));
3039eefe2a2SStefan Roese 
3049eefe2a2SStefan Roese 	memcpy(c->mst_node, mst, UBIFS_MST_NODE_SZ);
3059eefe2a2SStefan Roese 
306ff94bc40SHeiko Schocher 	if (c->ro_mount) {
3079eefe2a2SStefan Roese 		/* Read-only mode. Keep a copy for switching to rw mode */
3089eefe2a2SStefan Roese 		c->rcvrd_mst_node = kmalloc(sz, GFP_KERNEL);
3099eefe2a2SStefan Roese 		if (!c->rcvrd_mst_node) {
3109eefe2a2SStefan Roese 			err = -ENOMEM;
3119eefe2a2SStefan Roese 			goto out_free;
3129eefe2a2SStefan Roese 		}
3139eefe2a2SStefan Roese 		memcpy(c->rcvrd_mst_node, c->mst_node, UBIFS_MST_NODE_SZ);
314ff94bc40SHeiko Schocher 
315ff94bc40SHeiko Schocher 		/*
316ff94bc40SHeiko Schocher 		 * We had to recover the master node, which means there was an
317ff94bc40SHeiko Schocher 		 * unclean reboot. However, it is possible that the master node
318ff94bc40SHeiko Schocher 		 * is clean at this point, i.e., %UBIFS_MST_DIRTY is not set.
319ff94bc40SHeiko Schocher 		 * E.g., consider the following chain of events:
320ff94bc40SHeiko Schocher 		 *
321ff94bc40SHeiko Schocher 		 * 1. UBIFS was cleanly unmounted, so the master node is clean
322ff94bc40SHeiko Schocher 		 * 2. UBIFS is being mounted R/W and starts changing the master
323ff94bc40SHeiko Schocher 		 *    node in the first (%UBIFS_MST_LNUM). A power cut happens,
324ff94bc40SHeiko Schocher 		 *    so this LEB ends up with some amount of garbage at the
325ff94bc40SHeiko Schocher 		 *    end.
326ff94bc40SHeiko Schocher 		 * 3. UBIFS is being mounted R/O. We reach this place and
327ff94bc40SHeiko Schocher 		 *    recover the master node from the second LEB
328ff94bc40SHeiko Schocher 		 *    (%UBIFS_MST_LNUM + 1). But we cannot update the media
329ff94bc40SHeiko Schocher 		 *    because we are being mounted R/O. We have to defer the
330ff94bc40SHeiko Schocher 		 *    operation.
331ff94bc40SHeiko Schocher 		 * 4. However, this master node (@c->mst_node) is marked as
332ff94bc40SHeiko Schocher 		 *    clean (since the step 1). And if we just return, the
333ff94bc40SHeiko Schocher 		 *    mount code will be confused and won't recover the master
334ff94bc40SHeiko Schocher 		 *    node when it is re-mounter R/W later.
335ff94bc40SHeiko Schocher 		 *
336ff94bc40SHeiko Schocher 		 *    Thus, to force the recovery by marking the master node as
337ff94bc40SHeiko Schocher 		 *    dirty.
338ff94bc40SHeiko Schocher 		 */
339ff94bc40SHeiko Schocher 		c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
340ff94bc40SHeiko Schocher #ifndef __UBOOT__
341ff94bc40SHeiko Schocher 	} else {
342ff94bc40SHeiko Schocher 		/* Write the recovered master node */
343ff94bc40SHeiko Schocher 		c->max_sqnum = le64_to_cpu(mst->ch.sqnum) - 1;
344ff94bc40SHeiko Schocher 		err = write_rcvrd_mst_node(c, c->mst_node);
345ff94bc40SHeiko Schocher 		if (err)
346ff94bc40SHeiko Schocher 			goto out_free;
347ff94bc40SHeiko Schocher #endif
3489eefe2a2SStefan Roese 	}
3499eefe2a2SStefan Roese 
3509eefe2a2SStefan Roese 	vfree(buf2);
3519eefe2a2SStefan Roese 	vfree(buf1);
3529eefe2a2SStefan Roese 
3539eefe2a2SStefan Roese 	return 0;
3549eefe2a2SStefan Roese 
3559eefe2a2SStefan Roese out_err:
3569eefe2a2SStefan Roese 	err = -EINVAL;
3579eefe2a2SStefan Roese out_free:
358*0195a7bbSHeiko Schocher 	ubifs_err(c, "failed to recover master node");
3599eefe2a2SStefan Roese 	if (mst1) {
360*0195a7bbSHeiko Schocher 		ubifs_err(c, "dumping first master node");
361ff94bc40SHeiko Schocher 		ubifs_dump_node(c, mst1);
3629eefe2a2SStefan Roese 	}
3639eefe2a2SStefan Roese 	if (mst2) {
364*0195a7bbSHeiko Schocher 		ubifs_err(c, "dumping second master node");
365ff94bc40SHeiko Schocher 		ubifs_dump_node(c, mst2);
3669eefe2a2SStefan Roese 	}
3679eefe2a2SStefan Roese 	vfree(buf2);
3689eefe2a2SStefan Roese 	vfree(buf1);
3699eefe2a2SStefan Roese 	return err;
3709eefe2a2SStefan Roese }
3719eefe2a2SStefan Roese 
3729eefe2a2SStefan Roese /**
3739eefe2a2SStefan Roese  * ubifs_write_rcvrd_mst_node - write the recovered master node.
3749eefe2a2SStefan Roese  * @c: UBIFS file-system description object
3759eefe2a2SStefan Roese  *
3769eefe2a2SStefan Roese  * This function writes the master node that was recovered during mounting in
3779eefe2a2SStefan Roese  * read-only mode and must now be written because we are remounting rw.
3789eefe2a2SStefan Roese  *
3799eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
3809eefe2a2SStefan Roese  */
ubifs_write_rcvrd_mst_node(struct ubifs_info * c)3819eefe2a2SStefan Roese int ubifs_write_rcvrd_mst_node(struct ubifs_info *c)
3829eefe2a2SStefan Roese {
3839eefe2a2SStefan Roese 	int err;
3849eefe2a2SStefan Roese 
3859eefe2a2SStefan Roese 	if (!c->rcvrd_mst_node)
3869eefe2a2SStefan Roese 		return 0;
3879eefe2a2SStefan Roese 	c->rcvrd_mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
3889eefe2a2SStefan Roese 	c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
3899eefe2a2SStefan Roese 	err = write_rcvrd_mst_node(c, c->rcvrd_mst_node);
3909eefe2a2SStefan Roese 	if (err)
3919eefe2a2SStefan Roese 		return err;
3929eefe2a2SStefan Roese 	kfree(c->rcvrd_mst_node);
3939eefe2a2SStefan Roese 	c->rcvrd_mst_node = NULL;
3949eefe2a2SStefan Roese 	return 0;
3959eefe2a2SStefan Roese }
3969eefe2a2SStefan Roese 
3979eefe2a2SStefan Roese /**
3989eefe2a2SStefan Roese  * is_last_write - determine if an offset was in the last write to a LEB.
3999eefe2a2SStefan Roese  * @c: UBIFS file-system description object
4009eefe2a2SStefan Roese  * @buf: buffer to check
4019eefe2a2SStefan Roese  * @offs: offset to check
4029eefe2a2SStefan Roese  *
4039eefe2a2SStefan Roese  * This function returns %1 if @offs was in the last write to the LEB whose data
4049eefe2a2SStefan Roese  * is in @buf, otherwise %0 is returned. The determination is made by checking
405ff94bc40SHeiko Schocher  * for subsequent empty space starting from the next @c->max_write_size
406ff94bc40SHeiko Schocher  * boundary.
4079eefe2a2SStefan Roese  */
is_last_write(const struct ubifs_info * c,void * buf,int offs)4089eefe2a2SStefan Roese static int is_last_write(const struct ubifs_info *c, void *buf, int offs)
4099eefe2a2SStefan Roese {
410ff94bc40SHeiko Schocher 	int empty_offs, check_len;
4119eefe2a2SStefan Roese 	uint8_t *p;
4129eefe2a2SStefan Roese 
4139eefe2a2SStefan Roese 	/*
414ff94bc40SHeiko Schocher 	 * Round up to the next @c->max_write_size boundary i.e. @offs is in
415ff94bc40SHeiko Schocher 	 * the last wbuf written. After that should be empty space.
4169eefe2a2SStefan Roese 	 */
417ff94bc40SHeiko Schocher 	empty_offs = ALIGN(offs + 1, c->max_write_size);
4189eefe2a2SStefan Roese 	check_len = c->leb_size - empty_offs;
4199eefe2a2SStefan Roese 	p = buf + empty_offs - offs;
420ff94bc40SHeiko Schocher 	return is_empty(p, check_len);
4219eefe2a2SStefan Roese }
4229eefe2a2SStefan Roese 
4239eefe2a2SStefan Roese /**
4249eefe2a2SStefan Roese  * clean_buf - clean the data from an LEB sitting in a buffer.
4259eefe2a2SStefan Roese  * @c: UBIFS file-system description object
4269eefe2a2SStefan Roese  * @buf: buffer to clean
4279eefe2a2SStefan Roese  * @lnum: LEB number to clean
4289eefe2a2SStefan Roese  * @offs: offset from which to clean
4299eefe2a2SStefan Roese  * @len: length of buffer
4309eefe2a2SStefan Roese  *
4319eefe2a2SStefan Roese  * This function pads up to the next min_io_size boundary (if there is one) and
4329eefe2a2SStefan Roese  * sets empty space to all 0xff. @buf, @offs and @len are updated to the next
433ff94bc40SHeiko Schocher  * @c->min_io_size boundary.
4349eefe2a2SStefan Roese  */
clean_buf(const struct ubifs_info * c,void ** buf,int lnum,int * offs,int * len)4359eefe2a2SStefan Roese static void clean_buf(const struct ubifs_info *c, void **buf, int lnum,
4369eefe2a2SStefan Roese 		      int *offs, int *len)
4379eefe2a2SStefan Roese {
4389eefe2a2SStefan Roese 	int empty_offs, pad_len;
4399eefe2a2SStefan Roese 
4409eefe2a2SStefan Roese 	lnum = lnum;
4419eefe2a2SStefan Roese 	dbg_rcvry("cleaning corruption at %d:%d", lnum, *offs);
4429eefe2a2SStefan Roese 
4439eefe2a2SStefan Roese 	ubifs_assert(!(*offs & 7));
4449eefe2a2SStefan Roese 	empty_offs = ALIGN(*offs, c->min_io_size);
4459eefe2a2SStefan Roese 	pad_len = empty_offs - *offs;
4469eefe2a2SStefan Roese 	ubifs_pad(c, *buf, pad_len);
4479eefe2a2SStefan Roese 	*offs += pad_len;
4489eefe2a2SStefan Roese 	*buf += pad_len;
4499eefe2a2SStefan Roese 	*len -= pad_len;
4509eefe2a2SStefan Roese 	memset(*buf, 0xff, c->leb_size - empty_offs);
4519eefe2a2SStefan Roese }
4529eefe2a2SStefan Roese 
4539eefe2a2SStefan Roese /**
4549eefe2a2SStefan Roese  * no_more_nodes - determine if there are no more nodes in a buffer.
4559eefe2a2SStefan Roese  * @c: UBIFS file-system description object
4569eefe2a2SStefan Roese  * @buf: buffer to check
4579eefe2a2SStefan Roese  * @len: length of buffer
4589eefe2a2SStefan Roese  * @lnum: LEB number of the LEB from which @buf was read
4599eefe2a2SStefan Roese  * @offs: offset from which @buf was read
4609eefe2a2SStefan Roese  *
4616356daffSAdrian Hunter  * This function ensures that the corrupted node at @offs is the last thing
4626356daffSAdrian Hunter  * written to a LEB. This function returns %1 if more data is not found and
4636356daffSAdrian Hunter  * %0 if more data is found.
4649eefe2a2SStefan Roese  */
no_more_nodes(const struct ubifs_info * c,void * buf,int len,int lnum,int offs)4659eefe2a2SStefan Roese static int no_more_nodes(const struct ubifs_info *c, void *buf, int len,
4669eefe2a2SStefan Roese 			int lnum, int offs)
4679eefe2a2SStefan Roese {
4689eefe2a2SStefan Roese 	struct ubifs_ch *ch = buf;
4696356daffSAdrian Hunter 	int skip, dlen = le32_to_cpu(ch->len);
4709eefe2a2SStefan Roese 
4716356daffSAdrian Hunter 	/* Check for empty space after the corrupt node's common header */
472ff94bc40SHeiko Schocher 	skip = ALIGN(offs + UBIFS_CH_SZ, c->max_write_size) - offs;
4736356daffSAdrian Hunter 	if (is_empty(buf + skip, len - skip))
4746356daffSAdrian Hunter 		return 1;
4759eefe2a2SStefan Roese 	/*
4766356daffSAdrian Hunter 	 * The area after the common header size is not empty, so the common
4776356daffSAdrian Hunter 	 * header must be intact. Check it.
4789eefe2a2SStefan Roese 	 */
4796356daffSAdrian Hunter 	if (ubifs_check_node(c, buf, lnum, offs, 1, 0) != -EUCLEAN) {
4806356daffSAdrian Hunter 		dbg_rcvry("unexpected bad common header at %d:%d", lnum, offs);
4819eefe2a2SStefan Roese 		return 0;
4829eefe2a2SStefan Roese 	}
4836356daffSAdrian Hunter 	/* Now we know the corrupt node's length we can skip over it */
484ff94bc40SHeiko Schocher 	skip = ALIGN(offs + dlen, c->max_write_size) - offs;
4856356daffSAdrian Hunter 	/* After which there should be empty space */
4866356daffSAdrian Hunter 	if (is_empty(buf + skip, len - skip))
4879eefe2a2SStefan Roese 		return 1;
4886356daffSAdrian Hunter 	dbg_rcvry("unexpected data at %d:%d", lnum, offs + skip);
4896356daffSAdrian Hunter 	return 0;
4909eefe2a2SStefan Roese }
4919eefe2a2SStefan Roese 
4929eefe2a2SStefan Roese /**
4939eefe2a2SStefan Roese  * fix_unclean_leb - fix an unclean LEB.
4949eefe2a2SStefan Roese  * @c: UBIFS file-system description object
4959eefe2a2SStefan Roese  * @sleb: scanned LEB information
4969eefe2a2SStefan Roese  * @start: offset where scan started
4979eefe2a2SStefan Roese  */
fix_unclean_leb(struct ubifs_info * c,struct ubifs_scan_leb * sleb,int start)4989eefe2a2SStefan Roese static int fix_unclean_leb(struct ubifs_info *c, struct ubifs_scan_leb *sleb,
4999eefe2a2SStefan Roese 			   int start)
5009eefe2a2SStefan Roese {
5019eefe2a2SStefan Roese 	int lnum = sleb->lnum, endpt = start;
5029eefe2a2SStefan Roese 
5039eefe2a2SStefan Roese 	/* Get the end offset of the last node we are keeping */
5049eefe2a2SStefan Roese 	if (!list_empty(&sleb->nodes)) {
5059eefe2a2SStefan Roese 		struct ubifs_scan_node *snod;
5069eefe2a2SStefan Roese 
5079eefe2a2SStefan Roese 		snod = list_entry(sleb->nodes.prev,
5089eefe2a2SStefan Roese 				  struct ubifs_scan_node, list);
5099eefe2a2SStefan Roese 		endpt = snod->offs + snod->len;
5109eefe2a2SStefan Roese 	}
5119eefe2a2SStefan Roese 
512ff94bc40SHeiko Schocher 	if (c->ro_mount && !c->remounting_rw) {
5139eefe2a2SStefan Roese 		/* Add to recovery list */
5149eefe2a2SStefan Roese 		struct ubifs_unclean_leb *ucleb;
5159eefe2a2SStefan Roese 
5169eefe2a2SStefan Roese 		dbg_rcvry("need to fix LEB %d start %d endpt %d",
5179eefe2a2SStefan Roese 			  lnum, start, sleb->endpt);
5189eefe2a2SStefan Roese 		ucleb = kzalloc(sizeof(struct ubifs_unclean_leb), GFP_NOFS);
5199eefe2a2SStefan Roese 		if (!ucleb)
5209eefe2a2SStefan Roese 			return -ENOMEM;
5219eefe2a2SStefan Roese 		ucleb->lnum = lnum;
5229eefe2a2SStefan Roese 		ucleb->endpt = endpt;
5239eefe2a2SStefan Roese 		list_add_tail(&ucleb->list, &c->unclean_leb_list);
524ff94bc40SHeiko Schocher #ifndef __UBOOT__
525ff94bc40SHeiko Schocher 	} else {
526ff94bc40SHeiko Schocher 		/* Write the fixed LEB back to flash */
527ff94bc40SHeiko Schocher 		int err;
528ff94bc40SHeiko Schocher 
529ff94bc40SHeiko Schocher 		dbg_rcvry("fixing LEB %d start %d endpt %d",
530ff94bc40SHeiko Schocher 			  lnum, start, sleb->endpt);
531ff94bc40SHeiko Schocher 		if (endpt == 0) {
532ff94bc40SHeiko Schocher 			err = ubifs_leb_unmap(c, lnum);
533ff94bc40SHeiko Schocher 			if (err)
534ff94bc40SHeiko Schocher 				return err;
535ff94bc40SHeiko Schocher 		} else {
536ff94bc40SHeiko Schocher 			int len = ALIGN(endpt, c->min_io_size);
537ff94bc40SHeiko Schocher 
538ff94bc40SHeiko Schocher 			if (start) {
539ff94bc40SHeiko Schocher 				err = ubifs_leb_read(c, lnum, sleb->buf, 0,
540ff94bc40SHeiko Schocher 						     start, 1);
541ff94bc40SHeiko Schocher 				if (err)
542ff94bc40SHeiko Schocher 					return err;
543ff94bc40SHeiko Schocher 			}
544ff94bc40SHeiko Schocher 			/* Pad to min_io_size */
545ff94bc40SHeiko Schocher 			if (len > endpt) {
546ff94bc40SHeiko Schocher 				int pad_len = len - ALIGN(endpt, 8);
547ff94bc40SHeiko Schocher 
548ff94bc40SHeiko Schocher 				if (pad_len > 0) {
549ff94bc40SHeiko Schocher 					void *buf = sleb->buf + len - pad_len;
550ff94bc40SHeiko Schocher 
551ff94bc40SHeiko Schocher 					ubifs_pad(c, buf, pad_len);
552ff94bc40SHeiko Schocher 				}
553ff94bc40SHeiko Schocher 			}
554ff94bc40SHeiko Schocher 			err = ubifs_leb_change(c, lnum, sleb->buf, len);
555ff94bc40SHeiko Schocher 			if (err)
556ff94bc40SHeiko Schocher 				return err;
557ff94bc40SHeiko Schocher 		}
558ff94bc40SHeiko Schocher #endif
5599eefe2a2SStefan Roese 	}
5609eefe2a2SStefan Roese 	return 0;
5619eefe2a2SStefan Roese }
5629eefe2a2SStefan Roese 
5639eefe2a2SStefan Roese /**
564ff94bc40SHeiko Schocher  * drop_last_group - drop the last group of nodes.
5659eefe2a2SStefan Roese  * @sleb: scanned LEB information
5669eefe2a2SStefan Roese  * @offs: offset of dropped nodes is returned here
5679eefe2a2SStefan Roese  *
568ff94bc40SHeiko Schocher  * This is a helper function for 'ubifs_recover_leb()' which drops the last
569ff94bc40SHeiko Schocher  * group of nodes of the scanned LEB.
5709eefe2a2SStefan Roese  */
drop_last_group(struct ubifs_scan_leb * sleb,int * offs)571ff94bc40SHeiko Schocher static void drop_last_group(struct ubifs_scan_leb *sleb, int *offs)
5729eefe2a2SStefan Roese {
5739eefe2a2SStefan Roese 	while (!list_empty(&sleb->nodes)) {
5749eefe2a2SStefan Roese 		struct ubifs_scan_node *snod;
5759eefe2a2SStefan Roese 		struct ubifs_ch *ch;
5769eefe2a2SStefan Roese 
5779eefe2a2SStefan Roese 		snod = list_entry(sleb->nodes.prev, struct ubifs_scan_node,
5789eefe2a2SStefan Roese 				  list);
5799eefe2a2SStefan Roese 		ch = snod->node;
5809eefe2a2SStefan Roese 		if (ch->group_type != UBIFS_IN_NODE_GROUP)
581ff94bc40SHeiko Schocher 			break;
582ff94bc40SHeiko Schocher 
583ff94bc40SHeiko Schocher 		dbg_rcvry("dropping grouped node at %d:%d",
584ff94bc40SHeiko Schocher 			  sleb->lnum, snod->offs);
5859eefe2a2SStefan Roese 		*offs = snod->offs;
5869eefe2a2SStefan Roese 		list_del(&snod->list);
5879eefe2a2SStefan Roese 		kfree(snod);
5889eefe2a2SStefan Roese 		sleb->nodes_cnt -= 1;
5899eefe2a2SStefan Roese 	}
590ff94bc40SHeiko Schocher }
591ff94bc40SHeiko Schocher 
592ff94bc40SHeiko Schocher /**
593ff94bc40SHeiko Schocher  * drop_last_node - drop the last node.
594ff94bc40SHeiko Schocher  * @sleb: scanned LEB information
595ff94bc40SHeiko Schocher  * @offs: offset of dropped nodes is returned here
596ff94bc40SHeiko Schocher  *
597ff94bc40SHeiko Schocher  * This is a helper function for 'ubifs_recover_leb()' which drops the last
598ff94bc40SHeiko Schocher  * node of the scanned LEB.
599ff94bc40SHeiko Schocher  */
drop_last_node(struct ubifs_scan_leb * sleb,int * offs)600ff94bc40SHeiko Schocher static void drop_last_node(struct ubifs_scan_leb *sleb, int *offs)
601ff94bc40SHeiko Schocher {
602ff94bc40SHeiko Schocher 	struct ubifs_scan_node *snod;
603ff94bc40SHeiko Schocher 
604ff94bc40SHeiko Schocher 	if (!list_empty(&sleb->nodes)) {
605ff94bc40SHeiko Schocher 		snod = list_entry(sleb->nodes.prev, struct ubifs_scan_node,
606ff94bc40SHeiko Schocher 				  list);
607ff94bc40SHeiko Schocher 
608ff94bc40SHeiko Schocher 		dbg_rcvry("dropping last node at %d:%d",
609ff94bc40SHeiko Schocher 			  sleb->lnum, snod->offs);
610ff94bc40SHeiko Schocher 		*offs = snod->offs;
611ff94bc40SHeiko Schocher 		list_del(&snod->list);
612ff94bc40SHeiko Schocher 		kfree(snod);
613ff94bc40SHeiko Schocher 		sleb->nodes_cnt -= 1;
614ff94bc40SHeiko Schocher 	}
6159eefe2a2SStefan Roese }
6169eefe2a2SStefan Roese 
6179eefe2a2SStefan Roese /**
6189eefe2a2SStefan Roese  * ubifs_recover_leb - scan and recover a LEB.
6199eefe2a2SStefan Roese  * @c: UBIFS file-system description object
6209eefe2a2SStefan Roese  * @lnum: LEB number
6219eefe2a2SStefan Roese  * @offs: offset
6229eefe2a2SStefan Roese  * @sbuf: LEB-sized buffer to use
623ff94bc40SHeiko Schocher  * @jhead: journal head number this LEB belongs to (%-1 if the LEB does not
624ff94bc40SHeiko Schocher  *         belong to any journal head)
6259eefe2a2SStefan Roese  *
6269eefe2a2SStefan Roese  * This function does a scan of a LEB, but caters for errors that might have
6279eefe2a2SStefan Roese  * been caused by the unclean unmount from which we are attempting to recover.
628*0195a7bbSHeiko Schocher  * Returns the scanned information on success and a negative error code on
629*0195a7bbSHeiko Schocher  * failure.
6309eefe2a2SStefan Roese  */
ubifs_recover_leb(struct ubifs_info * c,int lnum,int offs,void * sbuf,int jhead)6319eefe2a2SStefan Roese struct ubifs_scan_leb *ubifs_recover_leb(struct ubifs_info *c, int lnum,
632ff94bc40SHeiko Schocher 					 int offs, void *sbuf, int jhead)
6339eefe2a2SStefan Roese {
634ff94bc40SHeiko Schocher 	int ret = 0, err, len = c->leb_size - offs, start = offs, min_io_unit;
635ff94bc40SHeiko Schocher 	int grouped = jhead == -1 ? 0 : c->jheads[jhead].grouped;
6369eefe2a2SStefan Roese 	struct ubifs_scan_leb *sleb;
6379eefe2a2SStefan Roese 	void *buf = sbuf + offs;
6389eefe2a2SStefan Roese 
639ff94bc40SHeiko Schocher 	dbg_rcvry("%d:%d, jhead %d, grouped %d", lnum, offs, jhead, grouped);
6409eefe2a2SStefan Roese 
6419eefe2a2SStefan Roese 	sleb = ubifs_start_scan(c, lnum, offs, sbuf);
6429eefe2a2SStefan Roese 	if (IS_ERR(sleb))
6439eefe2a2SStefan Roese 		return sleb;
6449eefe2a2SStefan Roese 
645ff94bc40SHeiko Schocher 	ubifs_assert(len >= 8);
6469eefe2a2SStefan Roese 	while (len >= 8) {
6479eefe2a2SStefan Roese 		dbg_scan("look at LEB %d:%d (%d bytes left)",
6489eefe2a2SStefan Roese 			 lnum, offs, len);
6499eefe2a2SStefan Roese 
6509eefe2a2SStefan Roese 		cond_resched();
6519eefe2a2SStefan Roese 
6529eefe2a2SStefan Roese 		/*
6539eefe2a2SStefan Roese 		 * Scan quietly until there is an error from which we cannot
6549eefe2a2SStefan Roese 		 * recover
6559eefe2a2SStefan Roese 		 */
656ff94bc40SHeiko Schocher 		ret = ubifs_scan_a_node(c, buf, len, lnum, offs, 1);
6579eefe2a2SStefan Roese 		if (ret == SCANNED_A_NODE) {
6589eefe2a2SStefan Roese 			/* A valid node, and not a padding node */
6599eefe2a2SStefan Roese 			struct ubifs_ch *ch = buf;
6609eefe2a2SStefan Roese 			int node_len;
6619eefe2a2SStefan Roese 
6629eefe2a2SStefan Roese 			err = ubifs_add_snod(c, sleb, buf, offs);
6639eefe2a2SStefan Roese 			if (err)
6649eefe2a2SStefan Roese 				goto error;
6659eefe2a2SStefan Roese 			node_len = ALIGN(le32_to_cpu(ch->len), 8);
6669eefe2a2SStefan Roese 			offs += node_len;
6679eefe2a2SStefan Roese 			buf += node_len;
6689eefe2a2SStefan Roese 			len -= node_len;
669ff94bc40SHeiko Schocher 		} else if (ret > 0) {
6709eefe2a2SStefan Roese 			/* Padding bytes or a valid padding node */
6719eefe2a2SStefan Roese 			offs += ret;
6729eefe2a2SStefan Roese 			buf += ret;
6739eefe2a2SStefan Roese 			len -= ret;
674ff94bc40SHeiko Schocher 		} else if (ret == SCANNED_EMPTY_SPACE ||
675ff94bc40SHeiko Schocher 			   ret == SCANNED_GARBAGE     ||
676ff94bc40SHeiko Schocher 			   ret == SCANNED_A_BAD_PAD_NODE ||
677ff94bc40SHeiko Schocher 			   ret == SCANNED_A_CORRUPT_NODE) {
678ff94bc40SHeiko Schocher 			dbg_rcvry("found corruption (%d) at %d:%d",
679ff94bc40SHeiko Schocher 				  ret, lnum, offs);
6809eefe2a2SStefan Roese 			break;
6819eefe2a2SStefan Roese 		} else {
682*0195a7bbSHeiko Schocher 			ubifs_err(c, "unexpected return value %d", ret);
683ff94bc40SHeiko Schocher 			err = -EINVAL;
684ff94bc40SHeiko Schocher 			goto error;
685ff94bc40SHeiko Schocher 		}
686ff94bc40SHeiko Schocher 	}
687ff94bc40SHeiko Schocher 
688ff94bc40SHeiko Schocher 	if (ret == SCANNED_GARBAGE || ret == SCANNED_A_BAD_PAD_NODE) {
689ff94bc40SHeiko Schocher 		if (!is_last_write(c, buf, offs))
690ff94bc40SHeiko Schocher 			goto corrupted_rescan;
691ff94bc40SHeiko Schocher 	} else if (ret == SCANNED_A_CORRUPT_NODE) {
692ff94bc40SHeiko Schocher 		if (!no_more_nodes(c, buf, len, lnum, offs))
693ff94bc40SHeiko Schocher 			goto corrupted_rescan;
694ff94bc40SHeiko Schocher 	} else if (!is_empty(buf, len)) {
695ff94bc40SHeiko Schocher 		if (!is_last_write(c, buf, offs)) {
696ff94bc40SHeiko Schocher 			int corruption = first_non_ff(buf, len);
697ff94bc40SHeiko Schocher 
698ff94bc40SHeiko Schocher 			/*
699ff94bc40SHeiko Schocher 			 * See header comment for this file for more
700ff94bc40SHeiko Schocher 			 * explanations about the reasons we have this check.
701ff94bc40SHeiko Schocher 			 */
702*0195a7bbSHeiko Schocher 			ubifs_err(c, "corrupt empty space LEB %d:%d, corruption starts at %d",
703ff94bc40SHeiko Schocher 				  lnum, offs, corruption);
704ff94bc40SHeiko Schocher 			/* Make sure we dump interesting non-0xFF data */
705ff94bc40SHeiko Schocher 			offs += corruption;
706ff94bc40SHeiko Schocher 			buf += corruption;
7079eefe2a2SStefan Roese 			goto corrupted;
7089eefe2a2SStefan Roese 		}
7099eefe2a2SStefan Roese 	}
7109eefe2a2SStefan Roese 
711ff94bc40SHeiko Schocher 	min_io_unit = round_down(offs, c->min_io_size);
712ff94bc40SHeiko Schocher 	if (grouped)
713ff94bc40SHeiko Schocher 		/*
714ff94bc40SHeiko Schocher 		 * If nodes are grouped, always drop the incomplete group at
715ff94bc40SHeiko Schocher 		 * the end.
716ff94bc40SHeiko Schocher 		 */
717ff94bc40SHeiko Schocher 		drop_last_group(sleb, &offs);
718ff94bc40SHeiko Schocher 
719ff94bc40SHeiko Schocher 	if (jhead == GCHD) {
720ff94bc40SHeiko Schocher 		/*
721ff94bc40SHeiko Schocher 		 * If this LEB belongs to the GC head then while we are in the
722ff94bc40SHeiko Schocher 		 * middle of the same min. I/O unit keep dropping nodes. So
723ff94bc40SHeiko Schocher 		 * basically, what we want is to make sure that the last min.
724ff94bc40SHeiko Schocher 		 * I/O unit where we saw the corruption is dropped completely
725ff94bc40SHeiko Schocher 		 * with all the uncorrupted nodes which may possibly sit there.
726ff94bc40SHeiko Schocher 		 *
727ff94bc40SHeiko Schocher 		 * In other words, let's name the min. I/O unit where the
728ff94bc40SHeiko Schocher 		 * corruption starts B, and the previous min. I/O unit A. The
729ff94bc40SHeiko Schocher 		 * below code tries to deal with a situation when half of B
730ff94bc40SHeiko Schocher 		 * contains valid nodes or the end of a valid node, and the
731ff94bc40SHeiko Schocher 		 * second half of B contains corrupted data or garbage. This
732ff94bc40SHeiko Schocher 		 * means that UBIFS had been writing to B just before the power
733ff94bc40SHeiko Schocher 		 * cut happened. I do not know how realistic is this scenario
734ff94bc40SHeiko Schocher 		 * that half of the min. I/O unit had been written successfully
735ff94bc40SHeiko Schocher 		 * and the other half not, but this is possible in our 'failure
736ff94bc40SHeiko Schocher 		 * mode emulation' infrastructure at least.
737ff94bc40SHeiko Schocher 		 *
738ff94bc40SHeiko Schocher 		 * So what is the problem, why we need to drop those nodes? Why
739ff94bc40SHeiko Schocher 		 * can't we just clean-up the second half of B by putting a
740ff94bc40SHeiko Schocher 		 * padding node there? We can, and this works fine with one
741ff94bc40SHeiko Schocher 		 * exception which was reproduced with power cut emulation
742ff94bc40SHeiko Schocher 		 * testing and happens extremely rarely.
743ff94bc40SHeiko Schocher 		 *
744ff94bc40SHeiko Schocher 		 * Imagine the file-system is full, we run GC which starts
745ff94bc40SHeiko Schocher 		 * moving valid nodes from LEB X to LEB Y (obviously, LEB Y is
746ff94bc40SHeiko Schocher 		 * the current GC head LEB). The @c->gc_lnum is -1, which means
747ff94bc40SHeiko Schocher 		 * that GC will retain LEB X and will try to continue. Imagine
748ff94bc40SHeiko Schocher 		 * that LEB X is currently the dirtiest LEB, and the amount of
749ff94bc40SHeiko Schocher 		 * used space in LEB Y is exactly the same as amount of free
750ff94bc40SHeiko Schocher 		 * space in LEB X.
751ff94bc40SHeiko Schocher 		 *
752ff94bc40SHeiko Schocher 		 * And a power cut happens when nodes are moved from LEB X to
753ff94bc40SHeiko Schocher 		 * LEB Y. We are here trying to recover LEB Y which is the GC
754ff94bc40SHeiko Schocher 		 * head LEB. We find the min. I/O unit B as described above.
755ff94bc40SHeiko Schocher 		 * Then we clean-up LEB Y by padding min. I/O unit. And later
756ff94bc40SHeiko Schocher 		 * 'ubifs_rcvry_gc_commit()' function fails, because it cannot
757ff94bc40SHeiko Schocher 		 * find a dirty LEB which could be GC'd into LEB Y! Even LEB X
758ff94bc40SHeiko Schocher 		 * does not match because the amount of valid nodes there does
759ff94bc40SHeiko Schocher 		 * not fit the free space in LEB Y any more! And this is
760ff94bc40SHeiko Schocher 		 * because of the padding node which we added to LEB Y. The
761ff94bc40SHeiko Schocher 		 * user-visible effect of this which I once observed and
762ff94bc40SHeiko Schocher 		 * analysed is that we cannot mount the file-system with
763ff94bc40SHeiko Schocher 		 * -ENOSPC error.
764ff94bc40SHeiko Schocher 		 *
765ff94bc40SHeiko Schocher 		 * So obviously, to make sure that situation does not happen we
766ff94bc40SHeiko Schocher 		 * should free min. I/O unit B in LEB Y completely and the last
767ff94bc40SHeiko Schocher 		 * used min. I/O unit in LEB Y should be A. This is basically
768ff94bc40SHeiko Schocher 		 * what the below code tries to do.
769ff94bc40SHeiko Schocher 		 */
770ff94bc40SHeiko Schocher 		while (offs > min_io_unit)
771ff94bc40SHeiko Schocher 			drop_last_node(sleb, &offs);
772ff94bc40SHeiko Schocher 	}
773ff94bc40SHeiko Schocher 
7749eefe2a2SStefan Roese 	buf = sbuf + offs;
7759eefe2a2SStefan Roese 	len = c->leb_size - offs;
7769eefe2a2SStefan Roese 
7779eefe2a2SStefan Roese 	clean_buf(c, &buf, lnum, &offs, &len);
7789eefe2a2SStefan Roese 	ubifs_end_scan(c, sleb, lnum, offs);
7799eefe2a2SStefan Roese 
7809eefe2a2SStefan Roese 	err = fix_unclean_leb(c, sleb, start);
7819eefe2a2SStefan Roese 	if (err)
7829eefe2a2SStefan Roese 		goto error;
7839eefe2a2SStefan Roese 
7849eefe2a2SStefan Roese 	return sleb;
7859eefe2a2SStefan Roese 
786ff94bc40SHeiko Schocher corrupted_rescan:
787ff94bc40SHeiko Schocher 	/* Re-scan the corrupted data with verbose messages */
788*0195a7bbSHeiko Schocher 	ubifs_err(c, "corruption %d", ret);
789ff94bc40SHeiko Schocher 	ubifs_scan_a_node(c, buf, len, lnum, offs, 1);
7909eefe2a2SStefan Roese corrupted:
7919eefe2a2SStefan Roese 	ubifs_scanned_corruption(c, lnum, offs, buf);
7929eefe2a2SStefan Roese 	err = -EUCLEAN;
7939eefe2a2SStefan Roese error:
794*0195a7bbSHeiko Schocher 	ubifs_err(c, "LEB %d scanning failed", lnum);
7959eefe2a2SStefan Roese 	ubifs_scan_destroy(sleb);
7969eefe2a2SStefan Roese 	return ERR_PTR(err);
7979eefe2a2SStefan Roese }
7989eefe2a2SStefan Roese 
7999eefe2a2SStefan Roese /**
8009eefe2a2SStefan Roese  * get_cs_sqnum - get commit start sequence number.
8019eefe2a2SStefan Roese  * @c: UBIFS file-system description object
8029eefe2a2SStefan Roese  * @lnum: LEB number of commit start node
8039eefe2a2SStefan Roese  * @offs: offset of commit start node
8049eefe2a2SStefan Roese  * @cs_sqnum: commit start sequence number is returned here
8059eefe2a2SStefan Roese  *
8069eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
8079eefe2a2SStefan Roese  */
get_cs_sqnum(struct ubifs_info * c,int lnum,int offs,unsigned long long * cs_sqnum)8089eefe2a2SStefan Roese static int get_cs_sqnum(struct ubifs_info *c, int lnum, int offs,
8099eefe2a2SStefan Roese 			unsigned long long *cs_sqnum)
8109eefe2a2SStefan Roese {
8119eefe2a2SStefan Roese 	struct ubifs_cs_node *cs_node = NULL;
8129eefe2a2SStefan Roese 	int err, ret;
8139eefe2a2SStefan Roese 
8149eefe2a2SStefan Roese 	dbg_rcvry("at %d:%d", lnum, offs);
8159eefe2a2SStefan Roese 	cs_node = kmalloc(UBIFS_CS_NODE_SZ, GFP_KERNEL);
8169eefe2a2SStefan Roese 	if (!cs_node)
8179eefe2a2SStefan Roese 		return -ENOMEM;
8189eefe2a2SStefan Roese 	if (c->leb_size - offs < UBIFS_CS_NODE_SZ)
8199eefe2a2SStefan Roese 		goto out_err;
820ff94bc40SHeiko Schocher 	err = ubifs_leb_read(c, lnum, (void *)cs_node, offs,
821ff94bc40SHeiko Schocher 			     UBIFS_CS_NODE_SZ, 0);
8229eefe2a2SStefan Roese 	if (err && err != -EBADMSG)
8239eefe2a2SStefan Roese 		goto out_free;
8249eefe2a2SStefan Roese 	ret = ubifs_scan_a_node(c, cs_node, UBIFS_CS_NODE_SZ, lnum, offs, 0);
8259eefe2a2SStefan Roese 	if (ret != SCANNED_A_NODE) {
826*0195a7bbSHeiko Schocher 		ubifs_err(c, "Not a valid node");
8279eefe2a2SStefan Roese 		goto out_err;
8289eefe2a2SStefan Roese 	}
8299eefe2a2SStefan Roese 	if (cs_node->ch.node_type != UBIFS_CS_NODE) {
830*0195a7bbSHeiko Schocher 		ubifs_err(c, "Node a CS node, type is %d", cs_node->ch.node_type);
8319eefe2a2SStefan Roese 		goto out_err;
8329eefe2a2SStefan Roese 	}
8339eefe2a2SStefan Roese 	if (le64_to_cpu(cs_node->cmt_no) != c->cmt_no) {
834*0195a7bbSHeiko Schocher 		ubifs_err(c, "CS node cmt_no %llu != current cmt_no %llu",
8359eefe2a2SStefan Roese 			  (unsigned long long)le64_to_cpu(cs_node->cmt_no),
8369eefe2a2SStefan Roese 			  c->cmt_no);
8379eefe2a2SStefan Roese 		goto out_err;
8389eefe2a2SStefan Roese 	}
8399eefe2a2SStefan Roese 	*cs_sqnum = le64_to_cpu(cs_node->ch.sqnum);
8409eefe2a2SStefan Roese 	dbg_rcvry("commit start sqnum %llu", *cs_sqnum);
8419eefe2a2SStefan Roese 	kfree(cs_node);
8429eefe2a2SStefan Roese 	return 0;
8439eefe2a2SStefan Roese 
8449eefe2a2SStefan Roese out_err:
8459eefe2a2SStefan Roese 	err = -EINVAL;
8469eefe2a2SStefan Roese out_free:
847*0195a7bbSHeiko Schocher 	ubifs_err(c, "failed to get CS sqnum");
8489eefe2a2SStefan Roese 	kfree(cs_node);
8499eefe2a2SStefan Roese 	return err;
8509eefe2a2SStefan Roese }
8519eefe2a2SStefan Roese 
8529eefe2a2SStefan Roese /**
8539eefe2a2SStefan Roese  * ubifs_recover_log_leb - scan and recover a log LEB.
8549eefe2a2SStefan Roese  * @c: UBIFS file-system description object
8559eefe2a2SStefan Roese  * @lnum: LEB number
8569eefe2a2SStefan Roese  * @offs: offset
8579eefe2a2SStefan Roese  * @sbuf: LEB-sized buffer to use
8589eefe2a2SStefan Roese  *
8599eefe2a2SStefan Roese  * This function does a scan of a LEB, but caters for errors that might have
860ff94bc40SHeiko Schocher  * been caused by unclean reboots from which we are attempting to recover
861ff94bc40SHeiko Schocher  * (assume that only the last log LEB can be corrupted by an unclean reboot).
8629eefe2a2SStefan Roese  *
8639eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
8649eefe2a2SStefan Roese  */
ubifs_recover_log_leb(struct ubifs_info * c,int lnum,int offs,void * sbuf)8659eefe2a2SStefan Roese struct ubifs_scan_leb *ubifs_recover_log_leb(struct ubifs_info *c, int lnum,
8669eefe2a2SStefan Roese 					     int offs, void *sbuf)
8679eefe2a2SStefan Roese {
8689eefe2a2SStefan Roese 	struct ubifs_scan_leb *sleb;
8699eefe2a2SStefan Roese 	int next_lnum;
8709eefe2a2SStefan Roese 
8719eefe2a2SStefan Roese 	dbg_rcvry("LEB %d", lnum);
8729eefe2a2SStefan Roese 	next_lnum = lnum + 1;
8739eefe2a2SStefan Roese 	if (next_lnum >= UBIFS_LOG_LNUM + c->log_lebs)
8749eefe2a2SStefan Roese 		next_lnum = UBIFS_LOG_LNUM;
8759eefe2a2SStefan Roese 	if (next_lnum != c->ltail_lnum) {
8769eefe2a2SStefan Roese 		/*
8779eefe2a2SStefan Roese 		 * We can only recover at the end of the log, so check that the
8789eefe2a2SStefan Roese 		 * next log LEB is empty or out of date.
8799eefe2a2SStefan Roese 		 */
880ff94bc40SHeiko Schocher 		sleb = ubifs_scan(c, next_lnum, 0, sbuf, 0);
8819eefe2a2SStefan Roese 		if (IS_ERR(sleb))
8829eefe2a2SStefan Roese 			return sleb;
8839eefe2a2SStefan Roese 		if (sleb->nodes_cnt) {
8849eefe2a2SStefan Roese 			struct ubifs_scan_node *snod;
8859eefe2a2SStefan Roese 			unsigned long long cs_sqnum = c->cs_sqnum;
8869eefe2a2SStefan Roese 
8879eefe2a2SStefan Roese 			snod = list_entry(sleb->nodes.next,
8889eefe2a2SStefan Roese 					  struct ubifs_scan_node, list);
8899eefe2a2SStefan Roese 			if (cs_sqnum == 0) {
8909eefe2a2SStefan Roese 				int err;
8919eefe2a2SStefan Roese 
8929eefe2a2SStefan Roese 				err = get_cs_sqnum(c, lnum, offs, &cs_sqnum);
8939eefe2a2SStefan Roese 				if (err) {
8949eefe2a2SStefan Roese 					ubifs_scan_destroy(sleb);
8959eefe2a2SStefan Roese 					return ERR_PTR(err);
8969eefe2a2SStefan Roese 				}
8979eefe2a2SStefan Roese 			}
8989eefe2a2SStefan Roese 			if (snod->sqnum > cs_sqnum) {
899*0195a7bbSHeiko Schocher 				ubifs_err(c, "unrecoverable log corruption in LEB %d",
900ff94bc40SHeiko Schocher 					  lnum);
9019eefe2a2SStefan Roese 				ubifs_scan_destroy(sleb);
9029eefe2a2SStefan Roese 				return ERR_PTR(-EUCLEAN);
9039eefe2a2SStefan Roese 			}
9049eefe2a2SStefan Roese 		}
9059eefe2a2SStefan Roese 		ubifs_scan_destroy(sleb);
9069eefe2a2SStefan Roese 	}
907ff94bc40SHeiko Schocher 	return ubifs_recover_leb(c, lnum, offs, sbuf, -1);
9089eefe2a2SStefan Roese }
9099eefe2a2SStefan Roese 
9109eefe2a2SStefan Roese /**
9119eefe2a2SStefan Roese  * recover_head - recover a head.
9129eefe2a2SStefan Roese  * @c: UBIFS file-system description object
9139eefe2a2SStefan Roese  * @lnum: LEB number of head to recover
9149eefe2a2SStefan Roese  * @offs: offset of head to recover
9159eefe2a2SStefan Roese  * @sbuf: LEB-sized buffer to use
9169eefe2a2SStefan Roese  *
9179eefe2a2SStefan Roese  * This function ensures that there is no data on the flash at a head location.
9189eefe2a2SStefan Roese  *
9199eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
9209eefe2a2SStefan Roese  */
recover_head(struct ubifs_info * c,int lnum,int offs,void * sbuf)921ff94bc40SHeiko Schocher static int recover_head(struct ubifs_info *c, int lnum, int offs, void *sbuf)
9229eefe2a2SStefan Roese {
923ff94bc40SHeiko Schocher 	int len = c->max_write_size, err;
9249eefe2a2SStefan Roese 
9259eefe2a2SStefan Roese 	if (offs + len > c->leb_size)
9269eefe2a2SStefan Roese 		len = c->leb_size - offs;
9279eefe2a2SStefan Roese 
9289eefe2a2SStefan Roese 	if (!len)
9299eefe2a2SStefan Roese 		return 0;
9309eefe2a2SStefan Roese 
9319eefe2a2SStefan Roese 	/* Read at the head location and check it is empty flash */
932ff94bc40SHeiko Schocher 	err = ubifs_leb_read(c, lnum, sbuf, offs, len, 1);
933ff94bc40SHeiko Schocher 	if (err || !is_empty(sbuf, len)) {
9349eefe2a2SStefan Roese 		dbg_rcvry("cleaning head at %d:%d", lnum, offs);
9359eefe2a2SStefan Roese 		if (offs == 0)
9369eefe2a2SStefan Roese 			return ubifs_leb_unmap(c, lnum);
937ff94bc40SHeiko Schocher 		err = ubifs_leb_read(c, lnum, sbuf, 0, offs, 1);
9389eefe2a2SStefan Roese 		if (err)
9399eefe2a2SStefan Roese 			return err;
940ff94bc40SHeiko Schocher 		return ubifs_leb_change(c, lnum, sbuf, offs);
9419eefe2a2SStefan Roese 	}
9429eefe2a2SStefan Roese 
9439eefe2a2SStefan Roese 	return 0;
9449eefe2a2SStefan Roese }
9459eefe2a2SStefan Roese 
9469eefe2a2SStefan Roese /**
9479eefe2a2SStefan Roese  * ubifs_recover_inl_heads - recover index and LPT heads.
9489eefe2a2SStefan Roese  * @c: UBIFS file-system description object
9499eefe2a2SStefan Roese  * @sbuf: LEB-sized buffer to use
9509eefe2a2SStefan Roese  *
9519eefe2a2SStefan Roese  * This function ensures that there is no data on the flash at the index and
9529eefe2a2SStefan Roese  * LPT head locations.
9539eefe2a2SStefan Roese  *
9549eefe2a2SStefan Roese  * This deals with the recovery of a half-completed journal commit. UBIFS is
9559eefe2a2SStefan Roese  * careful never to overwrite the last version of the index or the LPT. Because
9569eefe2a2SStefan Roese  * the index and LPT are wandering trees, data from a half-completed commit will
9579eefe2a2SStefan Roese  * not be referenced anywhere in UBIFS. The data will be either in LEBs that are
9589eefe2a2SStefan Roese  * assumed to be empty and will be unmapped anyway before use, or in the index
9599eefe2a2SStefan Roese  * and LPT heads.
9609eefe2a2SStefan Roese  *
9619eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
9629eefe2a2SStefan Roese  */
ubifs_recover_inl_heads(struct ubifs_info * c,void * sbuf)963ff94bc40SHeiko Schocher int ubifs_recover_inl_heads(struct ubifs_info *c, void *sbuf)
9649eefe2a2SStefan Roese {
9659eefe2a2SStefan Roese 	int err;
9669eefe2a2SStefan Roese 
967ff94bc40SHeiko Schocher 	ubifs_assert(!c->ro_mount || c->remounting_rw);
9689eefe2a2SStefan Roese 
9699eefe2a2SStefan Roese 	dbg_rcvry("checking index head at %d:%d", c->ihead_lnum, c->ihead_offs);
9709eefe2a2SStefan Roese 	err = recover_head(c, c->ihead_lnum, c->ihead_offs, sbuf);
9719eefe2a2SStefan Roese 	if (err)
9729eefe2a2SStefan Roese 		return err;
9739eefe2a2SStefan Roese 
9749eefe2a2SStefan Roese 	dbg_rcvry("checking LPT head at %d:%d", c->nhead_lnum, c->nhead_offs);
9759eefe2a2SStefan Roese 
976*0195a7bbSHeiko Schocher 	return recover_head(c, c->nhead_lnum, c->nhead_offs, sbuf);
9779eefe2a2SStefan Roese }
9789eefe2a2SStefan Roese 
9799eefe2a2SStefan Roese /**
9809eefe2a2SStefan Roese  * clean_an_unclean_leb - read and write a LEB to remove corruption.
9819eefe2a2SStefan Roese  * @c: UBIFS file-system description object
9829eefe2a2SStefan Roese  * @ucleb: unclean LEB information
9839eefe2a2SStefan Roese  * @sbuf: LEB-sized buffer to use
9849eefe2a2SStefan Roese  *
9859eefe2a2SStefan Roese  * This function reads a LEB up to a point pre-determined by the mount recovery,
9869eefe2a2SStefan Roese  * checks the nodes, and writes the result back to the flash, thereby cleaning
9879eefe2a2SStefan Roese  * off any following corruption, or non-fatal ECC errors.
9889eefe2a2SStefan Roese  *
9899eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
9909eefe2a2SStefan Roese  */
clean_an_unclean_leb(struct ubifs_info * c,struct ubifs_unclean_leb * ucleb,void * sbuf)991ff94bc40SHeiko Schocher static int clean_an_unclean_leb(struct ubifs_info *c,
9929eefe2a2SStefan Roese 				struct ubifs_unclean_leb *ucleb, void *sbuf)
9939eefe2a2SStefan Roese {
9949eefe2a2SStefan Roese 	int err, lnum = ucleb->lnum, offs = 0, len = ucleb->endpt, quiet = 1;
9959eefe2a2SStefan Roese 	void *buf = sbuf;
9969eefe2a2SStefan Roese 
9979eefe2a2SStefan Roese 	dbg_rcvry("LEB %d len %d", lnum, len);
9989eefe2a2SStefan Roese 
9999eefe2a2SStefan Roese 	if (len == 0) {
10009eefe2a2SStefan Roese 		/* Nothing to read, just unmap it */
1001*0195a7bbSHeiko Schocher 		return ubifs_leb_unmap(c, lnum);
10029eefe2a2SStefan Roese 	}
10039eefe2a2SStefan Roese 
1004ff94bc40SHeiko Schocher 	err = ubifs_leb_read(c, lnum, buf, offs, len, 0);
10059eefe2a2SStefan Roese 	if (err && err != -EBADMSG)
10069eefe2a2SStefan Roese 		return err;
10079eefe2a2SStefan Roese 
10089eefe2a2SStefan Roese 	while (len >= 8) {
10099eefe2a2SStefan Roese 		int ret;
10109eefe2a2SStefan Roese 
10119eefe2a2SStefan Roese 		cond_resched();
10129eefe2a2SStefan Roese 
10139eefe2a2SStefan Roese 		/* Scan quietly until there is an error */
10149eefe2a2SStefan Roese 		ret = ubifs_scan_a_node(c, buf, len, lnum, offs, quiet);
10159eefe2a2SStefan Roese 
10169eefe2a2SStefan Roese 		if (ret == SCANNED_A_NODE) {
10179eefe2a2SStefan Roese 			/* A valid node, and not a padding node */
10189eefe2a2SStefan Roese 			struct ubifs_ch *ch = buf;
10199eefe2a2SStefan Roese 			int node_len;
10209eefe2a2SStefan Roese 
10219eefe2a2SStefan Roese 			node_len = ALIGN(le32_to_cpu(ch->len), 8);
10229eefe2a2SStefan Roese 			offs += node_len;
10239eefe2a2SStefan Roese 			buf += node_len;
10249eefe2a2SStefan Roese 			len -= node_len;
10259eefe2a2SStefan Roese 			continue;
10269eefe2a2SStefan Roese 		}
10279eefe2a2SStefan Roese 
10289eefe2a2SStefan Roese 		if (ret > 0) {
10299eefe2a2SStefan Roese 			/* Padding bytes or a valid padding node */
10309eefe2a2SStefan Roese 			offs += ret;
10319eefe2a2SStefan Roese 			buf += ret;
10329eefe2a2SStefan Roese 			len -= ret;
10339eefe2a2SStefan Roese 			continue;
10349eefe2a2SStefan Roese 		}
10359eefe2a2SStefan Roese 
10369eefe2a2SStefan Roese 		if (ret == SCANNED_EMPTY_SPACE) {
1037*0195a7bbSHeiko Schocher 			ubifs_err(c, "unexpected empty space at %d:%d",
10389eefe2a2SStefan Roese 				  lnum, offs);
10399eefe2a2SStefan Roese 			return -EUCLEAN;
10409eefe2a2SStefan Roese 		}
10419eefe2a2SStefan Roese 
10429eefe2a2SStefan Roese 		if (quiet) {
10439eefe2a2SStefan Roese 			/* Redo the last scan but noisily */
10449eefe2a2SStefan Roese 			quiet = 0;
10459eefe2a2SStefan Roese 			continue;
10469eefe2a2SStefan Roese 		}
10479eefe2a2SStefan Roese 
10489eefe2a2SStefan Roese 		ubifs_scanned_corruption(c, lnum, offs, buf);
10499eefe2a2SStefan Roese 		return -EUCLEAN;
10509eefe2a2SStefan Roese 	}
10519eefe2a2SStefan Roese 
10529eefe2a2SStefan Roese 	/* Pad to min_io_size */
10539eefe2a2SStefan Roese 	len = ALIGN(ucleb->endpt, c->min_io_size);
10549eefe2a2SStefan Roese 	if (len > ucleb->endpt) {
10559eefe2a2SStefan Roese 		int pad_len = len - ALIGN(ucleb->endpt, 8);
10569eefe2a2SStefan Roese 
10579eefe2a2SStefan Roese 		if (pad_len > 0) {
10589eefe2a2SStefan Roese 			buf = c->sbuf + len - pad_len;
10599eefe2a2SStefan Roese 			ubifs_pad(c, buf, pad_len);
10609eefe2a2SStefan Roese 		}
10619eefe2a2SStefan Roese 	}
10629eefe2a2SStefan Roese 
10639eefe2a2SStefan Roese 	/* Write back the LEB atomically */
1064ff94bc40SHeiko Schocher 	err = ubifs_leb_change(c, lnum, sbuf, len);
10659eefe2a2SStefan Roese 	if (err)
10669eefe2a2SStefan Roese 		return err;
10679eefe2a2SStefan Roese 
10689eefe2a2SStefan Roese 	dbg_rcvry("cleaned LEB %d", lnum);
10699eefe2a2SStefan Roese 
10709eefe2a2SStefan Roese 	return 0;
10719eefe2a2SStefan Roese }
10729eefe2a2SStefan Roese 
10739eefe2a2SStefan Roese /**
10749eefe2a2SStefan Roese  * ubifs_clean_lebs - clean LEBs recovered during read-only mount.
10759eefe2a2SStefan Roese  * @c: UBIFS file-system description object
10769eefe2a2SStefan Roese  * @sbuf: LEB-sized buffer to use
10779eefe2a2SStefan Roese  *
10789eefe2a2SStefan Roese  * This function cleans a LEB identified during recovery that needs to be
10799eefe2a2SStefan Roese  * written but was not because UBIFS was mounted read-only. This happens when
10809eefe2a2SStefan Roese  * remounting to read-write mode.
10819eefe2a2SStefan Roese  *
10829eefe2a2SStefan Roese  * This function returns %0 on success and a negative error code on failure.
10839eefe2a2SStefan Roese  */
ubifs_clean_lebs(struct ubifs_info * c,void * sbuf)1084ff94bc40SHeiko Schocher int ubifs_clean_lebs(struct ubifs_info *c, void *sbuf)
10859eefe2a2SStefan Roese {
10869eefe2a2SStefan Roese 	dbg_rcvry("recovery");
10879eefe2a2SStefan Roese 	while (!list_empty(&c->unclean_leb_list)) {
10889eefe2a2SStefan Roese 		struct ubifs_unclean_leb *ucleb;
10899eefe2a2SStefan Roese 		int err;
10909eefe2a2SStefan Roese 
10919eefe2a2SStefan Roese 		ucleb = list_entry(c->unclean_leb_list.next,
10929eefe2a2SStefan Roese 				   struct ubifs_unclean_leb, list);
10939eefe2a2SStefan Roese 		err = clean_an_unclean_leb(c, ucleb, sbuf);
10949eefe2a2SStefan Roese 		if (err)
10959eefe2a2SStefan Roese 			return err;
10969eefe2a2SStefan Roese 		list_del(&ucleb->list);
10979eefe2a2SStefan Roese 		kfree(ucleb);
10989eefe2a2SStefan Roese 	}
10999eefe2a2SStefan Roese 	return 0;
11009eefe2a2SStefan Roese }
11019eefe2a2SStefan Roese 
1102ff94bc40SHeiko Schocher #ifndef __UBOOT__
1103ff94bc40SHeiko Schocher /**
1104ff94bc40SHeiko Schocher  * grab_empty_leb - grab an empty LEB to use as GC LEB and run commit.
1105ff94bc40SHeiko Schocher  * @c: UBIFS file-system description object
1106ff94bc40SHeiko Schocher  *
1107ff94bc40SHeiko Schocher  * This is a helper function for 'ubifs_rcvry_gc_commit()' which grabs an empty
1108ff94bc40SHeiko Schocher  * LEB to be used as GC LEB (@c->gc_lnum), and then runs the commit. Returns
1109ff94bc40SHeiko Schocher  * zero in case of success and a negative error code in case of failure.
1110ff94bc40SHeiko Schocher  */
grab_empty_leb(struct ubifs_info * c)1111ff94bc40SHeiko Schocher static int grab_empty_leb(struct ubifs_info *c)
1112ff94bc40SHeiko Schocher {
1113ff94bc40SHeiko Schocher 	int lnum, err;
1114ff94bc40SHeiko Schocher 
1115ff94bc40SHeiko Schocher 	/*
1116ff94bc40SHeiko Schocher 	 * Note, it is very important to first search for an empty LEB and then
1117ff94bc40SHeiko Schocher 	 * run the commit, not vice-versa. The reason is that there might be
1118ff94bc40SHeiko Schocher 	 * only one empty LEB at the moment, the one which has been the
1119ff94bc40SHeiko Schocher 	 * @c->gc_lnum just before the power cut happened. During the regular
1120ff94bc40SHeiko Schocher 	 * UBIFS operation (not now) @c->gc_lnum is marked as "taken", so no
1121ff94bc40SHeiko Schocher 	 * one but GC can grab it. But at this moment this single empty LEB is
1122ff94bc40SHeiko Schocher 	 * not marked as taken, so if we run commit - what happens? Right, the
1123ff94bc40SHeiko Schocher 	 * commit will grab it and write the index there. Remember that the
1124ff94bc40SHeiko Schocher 	 * index always expands as long as there is free space, and it only
1125ff94bc40SHeiko Schocher 	 * starts consolidating when we run out of space.
1126ff94bc40SHeiko Schocher 	 *
1127ff94bc40SHeiko Schocher 	 * IOW, if we run commit now, we might not be able to find a free LEB
1128ff94bc40SHeiko Schocher 	 * after this.
1129ff94bc40SHeiko Schocher 	 */
1130ff94bc40SHeiko Schocher 	lnum = ubifs_find_free_leb_for_idx(c);
1131ff94bc40SHeiko Schocher 	if (lnum < 0) {
1132*0195a7bbSHeiko Schocher 		ubifs_err(c, "could not find an empty LEB");
1133ff94bc40SHeiko Schocher 		ubifs_dump_lprops(c);
1134ff94bc40SHeiko Schocher 		ubifs_dump_budg(c, &c->bi);
1135ff94bc40SHeiko Schocher 		return lnum;
1136ff94bc40SHeiko Schocher 	}
1137ff94bc40SHeiko Schocher 
1138ff94bc40SHeiko Schocher 	/* Reset the index flag */
1139ff94bc40SHeiko Schocher 	err = ubifs_change_one_lp(c, lnum, LPROPS_NC, LPROPS_NC, 0,
1140ff94bc40SHeiko Schocher 				  LPROPS_INDEX, 0);
1141ff94bc40SHeiko Schocher 	if (err)
1142ff94bc40SHeiko Schocher 		return err;
1143ff94bc40SHeiko Schocher 
1144ff94bc40SHeiko Schocher 	c->gc_lnum = lnum;
1145ff94bc40SHeiko Schocher 	dbg_rcvry("found empty LEB %d, run commit", lnum);
1146ff94bc40SHeiko Schocher 
1147ff94bc40SHeiko Schocher 	return ubifs_run_commit(c);
1148ff94bc40SHeiko Schocher }
1149ff94bc40SHeiko Schocher 
1150ff94bc40SHeiko Schocher /**
1151ff94bc40SHeiko Schocher  * ubifs_rcvry_gc_commit - recover the GC LEB number and run the commit.
1152ff94bc40SHeiko Schocher  * @c: UBIFS file-system description object
1153ff94bc40SHeiko Schocher  *
1154ff94bc40SHeiko Schocher  * Out-of-place garbage collection requires always one empty LEB with which to
1155ff94bc40SHeiko Schocher  * start garbage collection. The LEB number is recorded in c->gc_lnum and is
1156ff94bc40SHeiko Schocher  * written to the master node on unmounting. In the case of an unclean unmount
1157ff94bc40SHeiko Schocher  * the value of gc_lnum recorded in the master node is out of date and cannot
1158ff94bc40SHeiko Schocher  * be used. Instead, recovery must allocate an empty LEB for this purpose.
1159ff94bc40SHeiko Schocher  * However, there may not be enough empty space, in which case it must be
1160ff94bc40SHeiko Schocher  * possible to GC the dirtiest LEB into the GC head LEB.
1161ff94bc40SHeiko Schocher  *
1162ff94bc40SHeiko Schocher  * This function also runs the commit which causes the TNC updates from
1163ff94bc40SHeiko Schocher  * size-recovery and orphans to be written to the flash. That is important to
1164ff94bc40SHeiko Schocher  * ensure correct replay order for subsequent mounts.
1165ff94bc40SHeiko Schocher  *
1166ff94bc40SHeiko Schocher  * This function returns %0 on success and a negative error code on failure.
1167ff94bc40SHeiko Schocher  */
ubifs_rcvry_gc_commit(struct ubifs_info * c)1168ff94bc40SHeiko Schocher int ubifs_rcvry_gc_commit(struct ubifs_info *c)
1169ff94bc40SHeiko Schocher {
1170ff94bc40SHeiko Schocher 	struct ubifs_wbuf *wbuf = &c->jheads[GCHD].wbuf;
1171ff94bc40SHeiko Schocher 	struct ubifs_lprops lp;
1172ff94bc40SHeiko Schocher 	int err;
1173ff94bc40SHeiko Schocher 
1174ff94bc40SHeiko Schocher 	dbg_rcvry("GC head LEB %d, offs %d", wbuf->lnum, wbuf->offs);
1175ff94bc40SHeiko Schocher 
1176ff94bc40SHeiko Schocher 	c->gc_lnum = -1;
1177ff94bc40SHeiko Schocher 	if (wbuf->lnum == -1 || wbuf->offs == c->leb_size)
1178ff94bc40SHeiko Schocher 		return grab_empty_leb(c);
1179ff94bc40SHeiko Schocher 
1180ff94bc40SHeiko Schocher 	err = ubifs_find_dirty_leb(c, &lp, wbuf->offs, 2);
1181ff94bc40SHeiko Schocher 	if (err) {
1182ff94bc40SHeiko Schocher 		if (err != -ENOSPC)
1183ff94bc40SHeiko Schocher 			return err;
1184ff94bc40SHeiko Schocher 
1185ff94bc40SHeiko Schocher 		dbg_rcvry("could not find a dirty LEB");
1186ff94bc40SHeiko Schocher 		return grab_empty_leb(c);
1187ff94bc40SHeiko Schocher 	}
1188ff94bc40SHeiko Schocher 
1189ff94bc40SHeiko Schocher 	ubifs_assert(!(lp.flags & LPROPS_INDEX));
1190ff94bc40SHeiko Schocher 	ubifs_assert(lp.free + lp.dirty >= wbuf->offs);
1191ff94bc40SHeiko Schocher 
1192ff94bc40SHeiko Schocher 	/*
1193ff94bc40SHeiko Schocher 	 * We run the commit before garbage collection otherwise subsequent
1194ff94bc40SHeiko Schocher 	 * mounts will see the GC and orphan deletion in a different order.
1195ff94bc40SHeiko Schocher 	 */
1196ff94bc40SHeiko Schocher 	dbg_rcvry("committing");
1197ff94bc40SHeiko Schocher 	err = ubifs_run_commit(c);
1198ff94bc40SHeiko Schocher 	if (err)
1199ff94bc40SHeiko Schocher 		return err;
1200ff94bc40SHeiko Schocher 
1201ff94bc40SHeiko Schocher 	dbg_rcvry("GC'ing LEB %d", lp.lnum);
1202ff94bc40SHeiko Schocher 	mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
1203ff94bc40SHeiko Schocher 	err = ubifs_garbage_collect_leb(c, &lp);
1204ff94bc40SHeiko Schocher 	if (err >= 0) {
1205ff94bc40SHeiko Schocher 		int err2 = ubifs_wbuf_sync_nolock(wbuf);
1206ff94bc40SHeiko Schocher 
1207ff94bc40SHeiko Schocher 		if (err2)
1208ff94bc40SHeiko Schocher 			err = err2;
1209ff94bc40SHeiko Schocher 	}
1210ff94bc40SHeiko Schocher 	mutex_unlock(&wbuf->io_mutex);
1211ff94bc40SHeiko Schocher 	if (err < 0) {
1212*0195a7bbSHeiko Schocher 		ubifs_err(c, "GC failed, error %d", err);
1213ff94bc40SHeiko Schocher 		if (err == -EAGAIN)
1214ff94bc40SHeiko Schocher 			err = -EINVAL;
1215ff94bc40SHeiko Schocher 		return err;
1216ff94bc40SHeiko Schocher 	}
1217ff94bc40SHeiko Schocher 
1218ff94bc40SHeiko Schocher 	ubifs_assert(err == LEB_RETAINED);
1219ff94bc40SHeiko Schocher 	if (err != LEB_RETAINED)
1220ff94bc40SHeiko Schocher 		return -EINVAL;
1221ff94bc40SHeiko Schocher 
1222ff94bc40SHeiko Schocher 	err = ubifs_leb_unmap(c, c->gc_lnum);
1223ff94bc40SHeiko Schocher 	if (err)
1224ff94bc40SHeiko Schocher 		return err;
1225ff94bc40SHeiko Schocher 
1226ff94bc40SHeiko Schocher 	dbg_rcvry("allocated LEB %d for GC", lp.lnum);
1227ff94bc40SHeiko Schocher 	return 0;
1228ff94bc40SHeiko Schocher }
1229ff94bc40SHeiko Schocher #else
ubifs_rcvry_gc_commit(struct ubifs_info * c)1230ff94bc40SHeiko Schocher int ubifs_rcvry_gc_commit(struct ubifs_info *c)
1231ff94bc40SHeiko Schocher {
1232ff94bc40SHeiko Schocher 	return 0;
1233ff94bc40SHeiko Schocher }
1234ff94bc40SHeiko Schocher #endif
1235ff94bc40SHeiko Schocher 
12369eefe2a2SStefan Roese /**
12379eefe2a2SStefan Roese  * struct size_entry - inode size information for recovery.
12389eefe2a2SStefan Roese  * @rb: link in the RB-tree of sizes
12399eefe2a2SStefan Roese  * @inum: inode number
12409eefe2a2SStefan Roese  * @i_size: size on inode
12419eefe2a2SStefan Roese  * @d_size: maximum size based on data nodes
12429eefe2a2SStefan Roese  * @exists: indicates whether the inode exists
12439eefe2a2SStefan Roese  * @inode: inode if pinned in memory awaiting rw mode to fix it
12449eefe2a2SStefan Roese  */
12459eefe2a2SStefan Roese struct size_entry {
12469eefe2a2SStefan Roese 	struct rb_node rb;
12479eefe2a2SStefan Roese 	ino_t inum;
12489eefe2a2SStefan Roese 	loff_t i_size;
12499eefe2a2SStefan Roese 	loff_t d_size;
12509eefe2a2SStefan Roese 	int exists;
12519eefe2a2SStefan Roese 	struct inode *inode;
12529eefe2a2SStefan Roese };
12539eefe2a2SStefan Roese 
12549eefe2a2SStefan Roese /**
12559eefe2a2SStefan Roese  * add_ino - add an entry to the size tree.
12569eefe2a2SStefan Roese  * @c: UBIFS file-system description object
12579eefe2a2SStefan Roese  * @inum: inode number
12589eefe2a2SStefan Roese  * @i_size: size on inode
12599eefe2a2SStefan Roese  * @d_size: maximum size based on data nodes
12609eefe2a2SStefan Roese  * @exists: indicates whether the inode exists
12619eefe2a2SStefan Roese  */
add_ino(struct ubifs_info * c,ino_t inum,loff_t i_size,loff_t d_size,int exists)12629eefe2a2SStefan Roese static int add_ino(struct ubifs_info *c, ino_t inum, loff_t i_size,
12639eefe2a2SStefan Roese 		   loff_t d_size, int exists)
12649eefe2a2SStefan Roese {
12659eefe2a2SStefan Roese 	struct rb_node **p = &c->size_tree.rb_node, *parent = NULL;
12669eefe2a2SStefan Roese 	struct size_entry *e;
12679eefe2a2SStefan Roese 
12689eefe2a2SStefan Roese 	while (*p) {
12699eefe2a2SStefan Roese 		parent = *p;
12709eefe2a2SStefan Roese 		e = rb_entry(parent, struct size_entry, rb);
12719eefe2a2SStefan Roese 		if (inum < e->inum)
12729eefe2a2SStefan Roese 			p = &(*p)->rb_left;
12739eefe2a2SStefan Roese 		else
12749eefe2a2SStefan Roese 			p = &(*p)->rb_right;
12759eefe2a2SStefan Roese 	}
12769eefe2a2SStefan Roese 
12779eefe2a2SStefan Roese 	e = kzalloc(sizeof(struct size_entry), GFP_KERNEL);
12789eefe2a2SStefan Roese 	if (!e)
12799eefe2a2SStefan Roese 		return -ENOMEM;
12809eefe2a2SStefan Roese 
12819eefe2a2SStefan Roese 	e->inum = inum;
12829eefe2a2SStefan Roese 	e->i_size = i_size;
12839eefe2a2SStefan Roese 	e->d_size = d_size;
12849eefe2a2SStefan Roese 	e->exists = exists;
12859eefe2a2SStefan Roese 
12869eefe2a2SStefan Roese 	rb_link_node(&e->rb, parent, p);
12879eefe2a2SStefan Roese 	rb_insert_color(&e->rb, &c->size_tree);
12889eefe2a2SStefan Roese 
12899eefe2a2SStefan Roese 	return 0;
12909eefe2a2SStefan Roese }
12919eefe2a2SStefan Roese 
12929eefe2a2SStefan Roese /**
12939eefe2a2SStefan Roese  * find_ino - find an entry on the size tree.
12949eefe2a2SStefan Roese  * @c: UBIFS file-system description object
12959eefe2a2SStefan Roese  * @inum: inode number
12969eefe2a2SStefan Roese  */
find_ino(struct ubifs_info * c,ino_t inum)12979eefe2a2SStefan Roese static struct size_entry *find_ino(struct ubifs_info *c, ino_t inum)
12989eefe2a2SStefan Roese {
12999eefe2a2SStefan Roese 	struct rb_node *p = c->size_tree.rb_node;
13009eefe2a2SStefan Roese 	struct size_entry *e;
13019eefe2a2SStefan Roese 
13029eefe2a2SStefan Roese 	while (p) {
13039eefe2a2SStefan Roese 		e = rb_entry(p, struct size_entry, rb);
13049eefe2a2SStefan Roese 		if (inum < e->inum)
13059eefe2a2SStefan Roese 			p = p->rb_left;
13069eefe2a2SStefan Roese 		else if (inum > e->inum)
13079eefe2a2SStefan Roese 			p = p->rb_right;
13089eefe2a2SStefan Roese 		else
13099eefe2a2SStefan Roese 			return e;
13109eefe2a2SStefan Roese 	}
13119eefe2a2SStefan Roese 	return NULL;
13129eefe2a2SStefan Roese }
13139eefe2a2SStefan Roese 
13149eefe2a2SStefan Roese /**
13159eefe2a2SStefan Roese  * remove_ino - remove an entry from the size tree.
13169eefe2a2SStefan Roese  * @c: UBIFS file-system description object
13179eefe2a2SStefan Roese  * @inum: inode number
13189eefe2a2SStefan Roese  */
remove_ino(struct ubifs_info * c,ino_t inum)13199eefe2a2SStefan Roese static void remove_ino(struct ubifs_info *c, ino_t inum)
13209eefe2a2SStefan Roese {
13219eefe2a2SStefan Roese 	struct size_entry *e = find_ino(c, inum);
13229eefe2a2SStefan Roese 
13239eefe2a2SStefan Roese 	if (!e)
13249eefe2a2SStefan Roese 		return;
13259eefe2a2SStefan Roese 	rb_erase(&e->rb, &c->size_tree);
13269eefe2a2SStefan Roese 	kfree(e);
13279eefe2a2SStefan Roese }
13289eefe2a2SStefan Roese 
13299eefe2a2SStefan Roese /**
1330ff94bc40SHeiko Schocher  * ubifs_destroy_size_tree - free resources related to the size tree.
1331ff94bc40SHeiko Schocher  * @c: UBIFS file-system description object
1332ff94bc40SHeiko Schocher  */
ubifs_destroy_size_tree(struct ubifs_info * c)1333ff94bc40SHeiko Schocher void ubifs_destroy_size_tree(struct ubifs_info *c)
1334ff94bc40SHeiko Schocher {
1335ff94bc40SHeiko Schocher 	struct size_entry *e, *n;
1336ff94bc40SHeiko Schocher 
1337ff94bc40SHeiko Schocher 	rbtree_postorder_for_each_entry_safe(e, n, &c->size_tree, rb) {
1338ff94bc40SHeiko Schocher 		if (e->inode)
1339ff94bc40SHeiko Schocher 			iput(e->inode);
1340ff94bc40SHeiko Schocher 		kfree(e);
1341ff94bc40SHeiko Schocher 	}
1342ff94bc40SHeiko Schocher 
1343ff94bc40SHeiko Schocher 	c->size_tree = RB_ROOT;
1344ff94bc40SHeiko Schocher }
1345ff94bc40SHeiko Schocher 
1346ff94bc40SHeiko Schocher /**
13479eefe2a2SStefan Roese  * ubifs_recover_size_accum - accumulate inode sizes for recovery.
13489eefe2a2SStefan Roese  * @c: UBIFS file-system description object
13499eefe2a2SStefan Roese  * @key: node key
13509eefe2a2SStefan Roese  * @deletion: node is for a deletion
13519eefe2a2SStefan Roese  * @new_size: inode size
13529eefe2a2SStefan Roese  *
13539eefe2a2SStefan Roese  * This function has two purposes:
13549eefe2a2SStefan Roese  *     1) to ensure there are no data nodes that fall outside the inode size
13559eefe2a2SStefan Roese  *     2) to ensure there are no data nodes for inodes that do not exist
13569eefe2a2SStefan Roese  * To accomplish those purposes, a rb-tree is constructed containing an entry
13579eefe2a2SStefan Roese  * for each inode number in the journal that has not been deleted, and recording
13589eefe2a2SStefan Roese  * the size from the inode node, the maximum size of any data node (also altered
13599eefe2a2SStefan Roese  * by truncations) and a flag indicating a inode number for which no inode node
13609eefe2a2SStefan Roese  * was present in the journal.
13619eefe2a2SStefan Roese  *
13629eefe2a2SStefan Roese  * Note that there is still the possibility that there are data nodes that have
13639eefe2a2SStefan Roese  * been committed that are beyond the inode size, however the only way to find
13649eefe2a2SStefan Roese  * them would be to scan the entire index. Alternatively, some provision could
13659eefe2a2SStefan Roese  * be made to record the size of inodes at the start of commit, which would seem
13669eefe2a2SStefan Roese  * very cumbersome for a scenario that is quite unlikely and the only negative
13679eefe2a2SStefan Roese  * consequence of which is wasted space.
13689eefe2a2SStefan Roese  *
13699eefe2a2SStefan Roese  * This functions returns %0 on success and a negative error code on failure.
13709eefe2a2SStefan Roese  */
ubifs_recover_size_accum(struct ubifs_info * c,union ubifs_key * key,int deletion,loff_t new_size)13719eefe2a2SStefan Roese int ubifs_recover_size_accum(struct ubifs_info *c, union ubifs_key *key,
13729eefe2a2SStefan Roese 			     int deletion, loff_t new_size)
13739eefe2a2SStefan Roese {
13749eefe2a2SStefan Roese 	ino_t inum = key_inum(c, key);
13759eefe2a2SStefan Roese 	struct size_entry *e;
13769eefe2a2SStefan Roese 	int err;
13779eefe2a2SStefan Roese 
13789eefe2a2SStefan Roese 	switch (key_type(c, key)) {
13799eefe2a2SStefan Roese 	case UBIFS_INO_KEY:
13809eefe2a2SStefan Roese 		if (deletion)
13819eefe2a2SStefan Roese 			remove_ino(c, inum);
13829eefe2a2SStefan Roese 		else {
13839eefe2a2SStefan Roese 			e = find_ino(c, inum);
13849eefe2a2SStefan Roese 			if (e) {
13859eefe2a2SStefan Roese 				e->i_size = new_size;
13869eefe2a2SStefan Roese 				e->exists = 1;
13879eefe2a2SStefan Roese 			} else {
13889eefe2a2SStefan Roese 				err = add_ino(c, inum, new_size, 0, 1);
13899eefe2a2SStefan Roese 				if (err)
13909eefe2a2SStefan Roese 					return err;
13919eefe2a2SStefan Roese 			}
13929eefe2a2SStefan Roese 		}
13939eefe2a2SStefan Roese 		break;
13949eefe2a2SStefan Roese 	case UBIFS_DATA_KEY:
13959eefe2a2SStefan Roese 		e = find_ino(c, inum);
13969eefe2a2SStefan Roese 		if (e) {
13979eefe2a2SStefan Roese 			if (new_size > e->d_size)
13989eefe2a2SStefan Roese 				e->d_size = new_size;
13999eefe2a2SStefan Roese 		} else {
14009eefe2a2SStefan Roese 			err = add_ino(c, inum, 0, new_size, 0);
14019eefe2a2SStefan Roese 			if (err)
14029eefe2a2SStefan Roese 				return err;
14039eefe2a2SStefan Roese 		}
14049eefe2a2SStefan Roese 		break;
14059eefe2a2SStefan Roese 	case UBIFS_TRUN_KEY:
14069eefe2a2SStefan Roese 		e = find_ino(c, inum);
14079eefe2a2SStefan Roese 		if (e)
14089eefe2a2SStefan Roese 			e->d_size = new_size;
14099eefe2a2SStefan Roese 		break;
14109eefe2a2SStefan Roese 	}
14119eefe2a2SStefan Roese 	return 0;
14129eefe2a2SStefan Roese }
14139eefe2a2SStefan Roese 
1414ff94bc40SHeiko Schocher #ifndef __UBOOT__
1415ff94bc40SHeiko Schocher /**
1416ff94bc40SHeiko Schocher  * fix_size_in_place - fix inode size in place on flash.
1417ff94bc40SHeiko Schocher  * @c: UBIFS file-system description object
1418ff94bc40SHeiko Schocher  * @e: inode size information for recovery
1419ff94bc40SHeiko Schocher  */
fix_size_in_place(struct ubifs_info * c,struct size_entry * e)1420ff94bc40SHeiko Schocher static int fix_size_in_place(struct ubifs_info *c, struct size_entry *e)
1421ff94bc40SHeiko Schocher {
1422ff94bc40SHeiko Schocher 	struct ubifs_ino_node *ino = c->sbuf;
1423ff94bc40SHeiko Schocher 	unsigned char *p;
1424ff94bc40SHeiko Schocher 	union ubifs_key key;
1425ff94bc40SHeiko Schocher 	int err, lnum, offs, len;
1426ff94bc40SHeiko Schocher 	loff_t i_size;
1427ff94bc40SHeiko Schocher 	uint32_t crc;
1428ff94bc40SHeiko Schocher 
1429ff94bc40SHeiko Schocher 	/* Locate the inode node LEB number and offset */
1430ff94bc40SHeiko Schocher 	ino_key_init(c, &key, e->inum);
1431ff94bc40SHeiko Schocher 	err = ubifs_tnc_locate(c, &key, ino, &lnum, &offs);
1432ff94bc40SHeiko Schocher 	if (err)
1433ff94bc40SHeiko Schocher 		goto out;
1434ff94bc40SHeiko Schocher 	/*
1435ff94bc40SHeiko Schocher 	 * If the size recorded on the inode node is greater than the size that
1436ff94bc40SHeiko Schocher 	 * was calculated from nodes in the journal then don't change the inode.
1437ff94bc40SHeiko Schocher 	 */
1438ff94bc40SHeiko Schocher 	i_size = le64_to_cpu(ino->size);
1439ff94bc40SHeiko Schocher 	if (i_size >= e->d_size)
1440ff94bc40SHeiko Schocher 		return 0;
1441ff94bc40SHeiko Schocher 	/* Read the LEB */
1442ff94bc40SHeiko Schocher 	err = ubifs_leb_read(c, lnum, c->sbuf, 0, c->leb_size, 1);
1443ff94bc40SHeiko Schocher 	if (err)
1444ff94bc40SHeiko Schocher 		goto out;
1445ff94bc40SHeiko Schocher 	/* Change the size field and recalculate the CRC */
1446ff94bc40SHeiko Schocher 	ino = c->sbuf + offs;
1447ff94bc40SHeiko Schocher 	ino->size = cpu_to_le64(e->d_size);
1448ff94bc40SHeiko Schocher 	len = le32_to_cpu(ino->ch.len);
1449ff94bc40SHeiko Schocher 	crc = crc32(UBIFS_CRC32_INIT, (void *)ino + 8, len - 8);
1450ff94bc40SHeiko Schocher 	ino->ch.crc = cpu_to_le32(crc);
1451ff94bc40SHeiko Schocher 	/* Work out where data in the LEB ends and free space begins */
1452ff94bc40SHeiko Schocher 	p = c->sbuf;
1453ff94bc40SHeiko Schocher 	len = c->leb_size - 1;
1454ff94bc40SHeiko Schocher 	while (p[len] == 0xff)
1455ff94bc40SHeiko Schocher 		len -= 1;
1456ff94bc40SHeiko Schocher 	len = ALIGN(len + 1, c->min_io_size);
1457ff94bc40SHeiko Schocher 	/* Atomically write the fixed LEB back again */
1458ff94bc40SHeiko Schocher 	err = ubifs_leb_change(c, lnum, c->sbuf, len);
1459ff94bc40SHeiko Schocher 	if (err)
1460ff94bc40SHeiko Schocher 		goto out;
1461ff94bc40SHeiko Schocher 	dbg_rcvry("inode %lu at %d:%d size %lld -> %lld",
1462ff94bc40SHeiko Schocher 		  (unsigned long)e->inum, lnum, offs, i_size, e->d_size);
1463ff94bc40SHeiko Schocher 	return 0;
1464ff94bc40SHeiko Schocher 
1465ff94bc40SHeiko Schocher out:
1466*0195a7bbSHeiko Schocher 	ubifs_warn(c, "inode %lu failed to fix size %lld -> %lld error %d",
1467ff94bc40SHeiko Schocher 		   (unsigned long)e->inum, e->i_size, e->d_size, err);
1468ff94bc40SHeiko Schocher 	return err;
1469ff94bc40SHeiko Schocher }
1470ff94bc40SHeiko Schocher #endif
1471ff94bc40SHeiko Schocher 
14729eefe2a2SStefan Roese /**
14739eefe2a2SStefan Roese  * ubifs_recover_size - recover inode size.
14749eefe2a2SStefan Roese  * @c: UBIFS file-system description object
14759eefe2a2SStefan Roese  *
14769eefe2a2SStefan Roese  * This function attempts to fix inode size discrepancies identified by the
14779eefe2a2SStefan Roese  * 'ubifs_recover_size_accum()' function.
14789eefe2a2SStefan Roese  *
14799eefe2a2SStefan Roese  * This functions returns %0 on success and a negative error code on failure.
14809eefe2a2SStefan Roese  */
ubifs_recover_size(struct ubifs_info * c)14819eefe2a2SStefan Roese int ubifs_recover_size(struct ubifs_info *c)
14829eefe2a2SStefan Roese {
14839eefe2a2SStefan Roese 	struct rb_node *this = rb_first(&c->size_tree);
14849eefe2a2SStefan Roese 
14859eefe2a2SStefan Roese 	while (this) {
14869eefe2a2SStefan Roese 		struct size_entry *e;
14879eefe2a2SStefan Roese 		int err;
14889eefe2a2SStefan Roese 
14899eefe2a2SStefan Roese 		e = rb_entry(this, struct size_entry, rb);
14909eefe2a2SStefan Roese 		if (!e->exists) {
14919eefe2a2SStefan Roese 			union ubifs_key key;
14929eefe2a2SStefan Roese 
14939eefe2a2SStefan Roese 			ino_key_init(c, &key, e->inum);
14949eefe2a2SStefan Roese 			err = ubifs_tnc_lookup(c, &key, c->sbuf);
14959eefe2a2SStefan Roese 			if (err && err != -ENOENT)
14969eefe2a2SStefan Roese 				return err;
14979eefe2a2SStefan Roese 			if (err == -ENOENT) {
14989eefe2a2SStefan Roese 				/* Remove data nodes that have no inode */
14999eefe2a2SStefan Roese 				dbg_rcvry("removing ino %lu",
15009eefe2a2SStefan Roese 					  (unsigned long)e->inum);
15019eefe2a2SStefan Roese 				err = ubifs_tnc_remove_ino(c, e->inum);
15029eefe2a2SStefan Roese 				if (err)
15039eefe2a2SStefan Roese 					return err;
15049eefe2a2SStefan Roese 			} else {
15059eefe2a2SStefan Roese 				struct ubifs_ino_node *ino = c->sbuf;
15069eefe2a2SStefan Roese 
15079eefe2a2SStefan Roese 				e->exists = 1;
15089eefe2a2SStefan Roese 				e->i_size = le64_to_cpu(ino->size);
15099eefe2a2SStefan Roese 			}
15109eefe2a2SStefan Roese 		}
1511ff94bc40SHeiko Schocher 
15129eefe2a2SStefan Roese 		if (e->exists && e->i_size < e->d_size) {
1513ff94bc40SHeiko Schocher 			if (c->ro_mount) {
15149eefe2a2SStefan Roese 				/* Fix the inode size and pin it in memory */
15159eefe2a2SStefan Roese 				struct inode *inode;
1516ff94bc40SHeiko Schocher 				struct ubifs_inode *ui;
1517ff94bc40SHeiko Schocher 
1518ff94bc40SHeiko Schocher 				ubifs_assert(!e->inode);
15199eefe2a2SStefan Roese 
15209eefe2a2SStefan Roese 				inode = ubifs_iget(c->vfs_sb, e->inum);
15219eefe2a2SStefan Roese 				if (IS_ERR(inode))
15229eefe2a2SStefan Roese 					return PTR_ERR(inode);
1523ff94bc40SHeiko Schocher 
1524ff94bc40SHeiko Schocher 				ui = ubifs_inode(inode);
15259eefe2a2SStefan Roese 				if (inode->i_size < e->d_size) {
15269eefe2a2SStefan Roese 					dbg_rcvry("ino %lu size %lld -> %lld",
15279eefe2a2SStefan Roese 						  (unsigned long)e->inum,
1528ff94bc40SHeiko Schocher 						  inode->i_size, e->d_size);
15299eefe2a2SStefan Roese 					inode->i_size = e->d_size;
1530ff94bc40SHeiko Schocher 					ui->ui_size = e->d_size;
1531ff94bc40SHeiko Schocher 					ui->synced_i_size = e->d_size;
15329eefe2a2SStefan Roese 					e->inode = inode;
15339eefe2a2SStefan Roese 					this = rb_next(this);
15349eefe2a2SStefan Roese 					continue;
15359eefe2a2SStefan Roese 				}
15369eefe2a2SStefan Roese 				iput(inode);
1537ff94bc40SHeiko Schocher #ifndef __UBOOT__
1538ff94bc40SHeiko Schocher 			} else {
1539ff94bc40SHeiko Schocher 				/* Fix the size in place */
1540ff94bc40SHeiko Schocher 				err = fix_size_in_place(c, e);
1541ff94bc40SHeiko Schocher 				if (err)
1542ff94bc40SHeiko Schocher 					return err;
1543ff94bc40SHeiko Schocher 				if (e->inode)
1544ff94bc40SHeiko Schocher 					iput(e->inode);
1545ff94bc40SHeiko Schocher #endif
15469eefe2a2SStefan Roese 			}
15479eefe2a2SStefan Roese 		}
1548ff94bc40SHeiko Schocher 
15499eefe2a2SStefan Roese 		this = rb_next(this);
15509eefe2a2SStefan Roese 		rb_erase(&e->rb, &c->size_tree);
15519eefe2a2SStefan Roese 		kfree(e);
15529eefe2a2SStefan Roese 	}
1553ff94bc40SHeiko Schocher 
15549eefe2a2SStefan Roese 	return 0;
15559eefe2a2SStefan Roese }
1556