4  * Copyright (C) 2006-2008 Nokia Corporation
6  * SPDX-License-Identifier:	GPL-2.0+
13  * This file implements the scan which is a general-purpose function for
15  * journal, to do garbage collection. for the TNC in-the-gaps method, and by
26  * scan_padding_bytes - scan for padding bytes.
52  * ubifs_scan_a_node - scan for a node or padding.
53  * @c: UBIFS file-system description object
62 int ubifs_scan_a_node(const struct ubifs_info *c, void *buf, int len, int lnum,  in ubifs_scan_a_node()  argument
68 	magic = le32_to_cpu(ch->magic);  in ubifs_scan_a_node()
82 		 dbg_ntype(ch->node_type), lnum, offs);  in ubifs_scan_a_node()
84 	if (ubifs_check_node(c, buf, lnum, offs, quiet, 1))  in ubifs_scan_a_node()
87 	if (ch->node_type == UBIFS_PAD_NODE) {  in ubifs_scan_a_node()
89 		int pad_len = le32_to_cpu(pad->pad_len);  in ubifs_scan_a_node()
90 		int node_len = le32_to_cpu(ch->len);  in ubifs_scan_a_node()
94 		    offs + node_len + pad_len > c->leb_size) {  in ubifs_scan_a_node()
96 				ubifs_err(c, "bad pad node at LEB %d:%d",  in ubifs_scan_a_node()
98 				ubifs_dump_node(c, pad);  in ubifs_scan_a_node()
103 		/* Make the node pads to 8-byte boundary */  in ubifs_scan_a_node()
106 				ubifs_err(c, "bad padding length %d - %d",  in ubifs_scan_a_node()
121  * ubifs_start_scan - create LEB scanning information at start of scan.
122  * @c: UBIFS file-system description object
125  * @sbuf: scan buffer (must be c->leb_size)
130 struct ubifs_scan_leb *ubifs_start_scan(const struct ubifs_info *c, int lnum,  in ubifs_start_scan()  argument
140 		return ERR_PTR(-ENOMEM);  in ubifs_start_scan()
142 	sleb->lnum = lnum;  in ubifs_start_scan()
143 	INIT_LIST_HEAD(&sleb->nodes);  in ubifs_start_scan()
144 	sleb->buf = sbuf;  in ubifs_start_scan()
146 	err = ubifs_leb_read(c, lnum, sbuf + offs, offs, c->leb_size - offs, 0);  in ubifs_start_scan()
147 	if (err && err != -EBADMSG) {  in ubifs_start_scan()
148 		ubifs_err(c, "cannot read %d bytes from LEB %d:%d, error %d",  in ubifs_start_scan()
149 			  c->leb_size - offs, lnum, offs, err);  in ubifs_start_scan()
162  * ubifs_end_scan - update LEB scanning information at end of scan.
163  * @c: UBIFS file-system description object
168 void ubifs_end_scan(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,  in ubifs_end_scan()  argument
173 	ubifs_assert(offs % c->min_io_size == 0);  in ubifs_end_scan()
175 	sleb->endpt = ALIGN(offs, c->min_io_size);  in ubifs_end_scan()
179  * ubifs_add_snod - add a scanned node to LEB scanning information.
180  * @c: UBIFS file-system description object
187 int ubifs_add_snod(const struct ubifs_info *c, struct ubifs_scan_leb *sleb,  in ubifs_add_snod()  argument
196 		return -ENOMEM;  in ubifs_add_snod()
198 	snod->sqnum = le64_to_cpu(ch->sqnum);  in ubifs_add_snod()
199 	snod->type = ch->node_type;  in ubifs_add_snod()
200 	snod->offs = offs;  in ubifs_add_snod()
201 	snod->len = le32_to_cpu(ch->len);  in ubifs_add_snod()
202 	snod->node = buf;  in ubifs_add_snod()
204 	switch (ch->node_type) {  in ubifs_add_snod()
213 		key_read(c, &ino->key, &snod->key);  in ubifs_add_snod()
216 		invalid_key_init(c, &snod->key);  in ubifs_add_snod()
219 	list_add_tail(&snod->list, &sleb->nodes);  in ubifs_add_snod()
220 	sleb->nodes_cnt += 1;  in ubifs_add_snod()
225  * ubifs_scanned_corruption - print information after UBIFS scanned corruption.
226  * @c: UBIFS file-system description object
231 void ubifs_scanned_corruption(const struct ubifs_info *c, int lnum, int offs,  in ubifs_scanned_corruption()  argument
236 	ubifs_err(c, "corruption at LEB %d:%d", lnum, offs);  in ubifs_scanned_corruption()
237 	len = c->leb_size - offs;  in ubifs_scanned_corruption()
240 	ubifs_err(c, "first %d bytes from LEB %d:%d", len, lnum, offs);  in ubifs_scanned_corruption()
245  * ubifs_scan - scan a logical eraseblock.
246  * @c: UBIFS file-system description object
249  * @sbuf: scan buffer (must be of @c->leb_size bytes in size)
254  * %-EUCLEAN if the LEB neads recovery, and other negative error codes in case
257  * If @quiet is non-zero, this function does not print large and scary
260 struct ubifs_scan_leb *ubifs_scan(const struct ubifs_info *c, int lnum,  in ubifs_scan()  argument
264 	int err, len = c->leb_size - offs;  in ubifs_scan()
267 	sleb = ubifs_start_scan(c, lnum, offs, sbuf);  in ubifs_scan()
280 		ret = ubifs_scan_a_node(c, buf, len, lnum, offs, quiet);  in ubifs_scan()
285 			len -= ret;  in ubifs_scan()
295 			ubifs_err(c, "garbage");  in ubifs_scan()
301 			ubifs_err(c, "bad node");  in ubifs_scan()
304 			ubifs_err(c, "unknown");  in ubifs_scan()
305 			err = -EINVAL;  in ubifs_scan()
309 		err = ubifs_add_snod(c, sleb, buf, offs);  in ubifs_scan()
313 		node_len = ALIGN(le32_to_cpu(ch->len), 8);  in ubifs_scan()
316 		len -= node_len;  in ubifs_scan()
319 	if (offs % c->min_io_size) {  in ubifs_scan()
321 			ubifs_err(c, "empty space starts at non-aligned offset %d",  in ubifs_scan()
326 	ubifs_end_scan(c, sleb, lnum, offs);  in ubifs_scan()
328 	for (; len > 4; offs += 4, buf = buf + 4, len -= 4)  in ubifs_scan()
331 	for (; len; offs++, buf++, len--)  in ubifs_scan()
334 				ubifs_err(c, "corrupt empty space at LEB %d:%d",  in ubifs_scan()
343 		ubifs_scanned_corruption(c, lnum, offs, buf);  in ubifs_scan()
344 		ubifs_err(c, "LEB %d scanning failed", lnum);  in ubifs_scan()
346 	err = -EUCLEAN;  in ubifs_scan()
351 	ubifs_err(c, "LEB %d scanning failed, error %d", lnum, err);  in ubifs_scan()
357  * ubifs_scan_destroy - destroy LEB scanning information.
365 	head = &sleb->nodes;  in ubifs_scan_destroy()
367 		node = list_entry(head->next, struct ubifs_scan_node, list);  in ubifs_scan_destroy()
368 		list_del(&node->list);  in ubifs_scan_destroy()