Skip to contentSkip to conversation

uboot: fs/btrfs: Fix read error on LZO compressed extents

PATCH In review Qu Wenruo 6 participants 10 messages Mar 19, 2020 – Mar 25, 2020 Btrfs file system

lore
Share & tools
lore

Qu Wenruo

author
#0 lore raw

cover uboot: fs/btrfs: Fix read error on LZO compressed extents

There is a bug that uboot can't load LZO compressed data extent while kernel can handle it without any problem.

It turns out to be a page boundary case. The 2nd patch is the proper fix, backported from btrfs-progs.

The first patch is just to make my eyes less hurt.

I guess it's time to backport proper code from btrfs-progs, other than using tons of immediate numbers.

Qu Wenruo (2):
uboot: fs/btrfs: Use LZO_LEN to replace immediate number
uboot: fs/btrfs: Fix LZO false decompression error caused by pending
zero

 fs/btrfs/compression.c | 42 ++++++++++++++++++++++++++++++++----------
 1 file changed, 32 insertions(+), 10 deletions(-)
Signature · 1 line
2.25.1
author
#1 lore raw

PATCH 1/2 uboot: fs/btrfs: Use LZO_LEN to replace immediate number

Just a cleanup. The immediate number makes my eye hurt.

---
 fs/btrfs/compression.c | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)
fs/btrfs/compression.c +12 -10
index 346875d45a1b..4ef44ce11485 100644
@@ -12,36 +12,38 @@
 #include <u-boot/zlib.h>
 #include <asm/unaligned.h>
 
+/* Header for each segment, LE32, recording the compressed size */
+#define LZO_LEN		4
 static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 {
 	u32 tot_len, in_len, res;
 	size_t out_len;
 	int ret;
 
-	if (clen < 4)
+	if (clen < LZO_LEN)
 		return -1;
 
 	tot_len = le32_to_cpu(get_unaligned((u32 *)cbuf));
-	cbuf += 4;
-	clen -= 4;
-	tot_len -= 4;
+	cbuf += LZO_LEN;
+	clen -= LZO_LEN;
+	tot_len -= LZO_LEN;
 
 	if (tot_len == 0 && dlen)
 		return -1;
-	if (tot_len < 4)
+	if (tot_len < LZO_LEN)
 		return -1;
 
 	res = 0;
 
-	while (tot_len > 4) {
+	while (tot_len > LZO_LEN) {
 		in_len = le32_to_cpu(get_unaligned((u32 *)cbuf));
-		cbuf += 4;
-		clen -= 4;
+		cbuf += LZO_LEN;
+		clen -= LZO_LEN;
 
-		if (in_len > clen || tot_len < 4 + in_len)
+		if (in_len > clen || tot_len < LZO_LEN + in_len)
 			return -1;
 
-		tot_len -= 4 + in_len;
+		tot_len -= (LZO_LEN + in_len);
 
 		out_len = dlen;
 		ret = lzo1x_decompress_safe(cbuf, in_len, dbuf, &out_len);
Signature · 1 line
2.25.1
author
#2 lore raw

PATCH 2/2 uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

In reply to Qu Wenruo

[BUG]
For certain btrfs files with compressed file extent, uboot will fail to load it:

btrfs_read_extent_reg: disk_bytenr=14229504 disk_len=73728 offset=0 nr_bytes=131 072
decompress_lzo: tot_len=70770
decompress_lzo: in_len=1389
decompress_lzo: in_len=2400
decompress_lzo: in_len=3002
decompress_lzo: in_len=1379
decompress_lzo: in_len=88539136
decompress_lzo: header error, in_len=88539136 clen=65534 tot_len=62580

NOTE: except the last line, all other lines are debug output.

[CAUSE]
Btrfs lzo compression uses its own format to record compressed size (segmant header, LE32).

However to make decompression easier, we never put such segment header across page boundary.

In above case, the xxd dump of the lzo compressed data looks like this:

00001fe0: 4cdc 02fc 0bfd 02c0 dc02 0d13 0100 0001  L...............
00001ff0: 0000 0008 0300 0000 0000 0011 0000|0000  ................
00002000: 4705 0000 0001 cc02 0000 0000 0000 1e01  G...............

'|' is the "expected" segment header start position.

But in that page, there are only 2 bytes left, can't contain the 4 bytes segment header.

So btrfs compression will skip that 2 bytes, put the segment header in next page directly.

Uboot doesn't have such check, and read the header with 2 bytes offset, result 0x05470000 (88539136), other than the expected result 0x00000547 (1351), resulting above error.

[FIX]
Follow the btrfs-progs restore implementation, by introducing tot_in to record total processed bytes (including headers), and do proper page boundary skip to fix it.

---
 fs/btrfs/compression.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
fs/btrfs/compression.c +20 -0
index 4ef44ce11485..2a6ac8bb1029 100644
@@ -9,6 +9,7 @@
 #include <malloc.h>
 #include <linux/lzo.h>
 #include <linux/zstd.h>
+#include <linux/compat.h>
 #include <u-boot/zlib.h>
 #include <asm/unaligned.h>
 
@@ -17,6 +18,7 @@
 static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 {
 	u32 tot_len, in_len, res;
+	u32 tot_in = 0;
 	size_t out_len;
 	int ret;
 
@@ -27,6 +29,7 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 	cbuf += LZO_LEN;
 	clen -= LZO_LEN;
 	tot_len -= LZO_LEN;
+	tot_in += LZO_LEN;
 
 	if (tot_len == 0 && dlen)
 		return -1;
@@ -36,6 +39,9 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 	res = 0;
 
 	while (tot_len > LZO_LEN) {
+		size_t mod_page;
+		size_t rem_page;
+
 		in_len = le32_to_cpu(get_unaligned((u32 *)cbuf));
 		cbuf += LZO_LEN;
 		clen -= LZO_LEN;
@@ -44,6 +50,7 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 			return -1;
 
 		tot_len -= (LZO_LEN + in_len);
+		tot_in += (LZO_LEN + in_len);
 
 		out_len = dlen;
 		ret = lzo1x_decompress_safe(cbuf, in_len, dbuf, &out_len);
@@ -56,6 +63,19 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 		dlen -= out_len;
 
 		res += out_len;
+
+		/*
+		 * If the 4 bytes header does not fit to the rest of the page we
+		 * have to move to next one, or we read some garbage.
+		 */
+		mod_page = tot_in % PAGE_SIZE;
+		rem_page = PAGE_SIZE - mod_page;
+		if (rem_page < LZO_LEN) {
+			cbuf += rem_page;
+			tot_in += rem_page;
+			clen -= rem_page;
+			tot_len -= rem_page;
+		}
 	}
 
 	return res;
Signature · 1 line
2.25.1
#3 lore raw

Re: [PATCH 2/2] uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

Hi Qu,

Quoted 98 lines · Qu Wenruo

[BUG]
For certain btrfs files with compressed file extent, uboot will fail to load it:

btrfs_read_extent_reg: disk_bytenr=14229504 disk_len=73728 offset=0 nr_bytes=131 072
decompress_lzo: tot_len=70770
decompress_lzo: in_len=1389
decompress_lzo: in_len=2400
decompress_lzo: in_len=3002
decompress_lzo: in_len=1379
decompress_lzo: in_len=88539136
decompress_lzo: header error, in_len=88539136 clen=65534 tot_len=62580

NOTE: except the last line, all other lines are debug output.

[CAUSE]
Btrfs lzo compression uses its own format to record compressed size (segmant header, LE32).

However to make decompression easier, we never put such segment header across page boundary.

In above case, the xxd dump of the lzo compressed data looks like this:

00001fe0: 4cdc 02fc 0bfd 02c0 dc02 0d13 0100 0001  L...............
00001ff0: 0000 0008 0300 0000 0000 0011 0000|0000  ................
00002000: 4705 0000 0001 cc02 0000 0000 0000 1e01  G...............

'|' is the "expected" segment header start position.

But in that page, there are only 2 bytes left, can't contain the 4 bytes segment header.

So btrfs compression will skip that 2 bytes, put the segment header in next page directly.

Uboot doesn't have such check, and read the header with 2 bytes offset, result 0x05470000 (88539136), other than the expected result 0x00000547 (1351), resulting above error.

[FIX]
Follow the btrfs-progs restore implementation, by introducing tot_in to record total processed bytes (including headers), and do proper page boundary skip to fix it.

---
 fs/btrfs/compression.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
fs/btrfs/compression.c +7 -0
index 4ef44ce11485..2a6ac8bb1029 100644
@@ -9,6 +9,7 @@
 #include <malloc.h>
 #include <linux/lzo.h>
 #include <linux/zstd.h>
+#include <linux/compat.h>
 #include <u-boot/zlib.h>
 #include <asm/unaligned.h>
 
@@ -17,6 +18,7 @@
 static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 {
 	u32 tot_len, in_len, res;
+	u32 tot_in = 0;
 	size_t out_len;
 	int ret;
 
@@ -27,6 +29,7 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 	cbuf += LZO_LEN;
 	clen -= LZO_LEN;
 	tot_len -= LZO_LEN;
+	tot_in += LZO_LEN;
 
 	if (tot_len == 0 && dlen)
 		return -1;
@@ -36,6 +39,9 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 	res = 0;
 
 	while (tot_len > LZO_LEN) {
+		size_t mod_page;
+		size_t rem_page;
+
 		in_len = le32_to_cpu(get_unaligned((u32 *)cbuf));
 		cbuf += LZO_LEN;
 		clen -= LZO_LEN;
@@ -44,6 +50,7 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 			return -1;
 
 		tot_len -= (LZO_LEN + in_len);
+		tot_in += (LZO_LEN + in_len);
 
 		out_len = dlen;
 		ret = lzo1x_decompress_safe(cbuf, in_len, dbuf, &out_len);

fs/btrfs/compression.c static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen) · line 71

Quoted 9 lines
fs/btrfs/compression.c +6 -0
@@ -56,6 +63,19 @@ static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen)
 		dlen -= out_len;
 
 		res += out_len;
+
+		/*
+		 * If the 4 bytes header does not fit to the rest of the page we
+		 * have to move to next one, or we read some garbage.
+		 */
+		mod_page = tot_in % PAGE_SIZE;

in U-Boot we use 4K page sizes, but the OS could use another page size (16K or 64k). Would we need to adapt that code to reflect which page size is used on the medium we want to access?

Regards,
Matthias

Quoted 11 lines
fs/btrfs/compression.c +7 -0
+		rem_page = PAGE_SIZE - mod_page;
+		if (rem_page < LZO_LEN) {
+			cbuf += rem_page;
+			tot_in += rem_page;
+			clen -= rem_page;
+			tot_len -= rem_page;
+		}
 	}
 
 	return res;
#4 lore raw

Re: [PATCH 2/2] uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

Quoted 13 lines · Matthias Brugger

fs/btrfs/compression.c static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen) · line 71

Quoted 9 lines
fs/btrfs/compression.c +6 -0
 		dlen -= out_len;
 
 		res += out_len;
+
+		/*
+		 * If the 4 bytes header does not fit to the rest of the page we
+		 * have to move to next one, or we read some garbage.
+		 */
+		mod_page = tot_in % PAGE_SIZE;

in U-Boot we use 4K page sizes, but the OS could use another page size (16K or 64k). Would we need to adapt that code to reflect which page size is used on the medium we want to access?

Yes, it is the 'sectorsize' as it's set up in fs_info or it's equivalent in uboot. For kernel the page size == sectorsize is kind of implicit and verified at mount time.

#5 lore raw

Re: [PATCH 2/2] uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

Quoted 15 lines · David Sterba
Quoted 13 lines · Matthias Brugger

fs/btrfs/compression.c static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen) · line 71

Quoted 9 lines
fs/btrfs/compression.c +6 -0
 		dlen -= out_len;
 
 		res += out_len;
+
+		/*
+		 * If the 4 bytes header does not fit to the rest of the page we
+		 * have to move to next one, or we read some garbage.
+		 */
+		mod_page = tot_in % PAGE_SIZE;

in U-Boot we use 4K page sizes, but the OS could use another page size (16K or 64k). Would we need to adapt that code to reflect which page size is used on the medium we want to access?

Quoted 4 lines

Yes, it is the 'sectorsize' as it's set up in fs_info or it's equivalent in uboot. For kernel the page size == sectorsize is kind of implicit and verified at mount time.

Does this mean we would need to add a Kconfig option to set the sectorsize in U-Boot?

Regards,
Matthias

#6 lore raw

Re: [PATCH 2/2] uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

Quoted 18 lines · Matthias Brugger
Quoted 15 lines · David Sterba
Quoted 13 lines · Matthias Brugger

fs/btrfs/compression.c static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen) · line 71

Quoted 9 lines
fs/btrfs/compression.c +6 -0
 		dlen -= out_len;
 
 		res += out_len;
+
+		/*
+		 * If the 4 bytes header does not fit to the rest of the page we
+		 * have to move to next one, or we read some garbage.
+		 */
+		mod_page = tot_in % PAGE_SIZE;

in U-Boot we use 4K page sizes, but the OS could use another page size (16K or 64k). Would we need to adapt that code to reflect which page size is used on the medium we want to access?

Quoted 7 lines
Quoted 4 lines

Yes, it is the 'sectorsize' as it's set up in fs_info or it's equivalent in uboot. For kernel the page size == sectorsize is kind of implicit and verified at mount time.

Does this mean we would need to add a Kconfig option to set the sectorsize in U-Boot?

No, the value depends on the filesystem so it can't be a config option. What I mean is btrfs_super_block::sectorsize, where the superblock is btrfs_info::sb.

#7 lore raw

Re: [PATCH 2/2] uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

Quoted 24 lines · David Sterba
Quoted 23 lines · Matthias Brugger
Quoted 19 lines · David Sterba
Quoted 13 lines · Matthias Brugger

fs/btrfs/compression.c static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen) · line 71

Quoted 9 lines
fs/btrfs/compression.c +6 -0
 		dlen -= out_len;
 
 		res += out_len;
+
+		/*
+		 * If the 4 bytes header does not fit to the rest of the page we
+		 * have to move to next one, or we read some garbage.
+		 */
+		mod_page = tot_in % PAGE_SIZE;

in U-Boot we use 4K page sizes, but the OS could use another page size (16K or 64k). Would we need to adapt that code to reflect which page size is used on the medium we want to access?

Yes, it is the 'sectorsize' as it's set up in fs_info or it's equivalent in uboot. For kernel the page size == sectorsize is kind of implicit and verified at mount time.

Quoted 7 lines
Quoted 2 lines

Does this mean we would need to add a Kconfig option to set the sectorsize in U-Boot?

No, the value depends on the filesystem so it can't be a config option. What I mean is btrfs_super_block::sectorsize, where the superblock is btrfs_info::sb.

Sorry for the delayed reply. (Stupid filter setup).

Currently most Uboot boards should use the same page size setup for its kernel, and most btrfs uses 4K sector size.

So for Uboot it should be no problem.

Although the best practice is to read the fs_info::sectorsize as David mentioned, but the code base doesn't allow us to do that yet.

So I'm going to backport the read part code from btrfs-progs in the near-future, and completely solve it, making it sector size independent.

Would this plan looks sound? Or we need to wait for the full re-implementation?

Thanks,
Qu

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: OpenPGP digital signature
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200324/2e2c9232/attachment.sig>

#8 lore raw

Re: [PATCH 2/2] uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

Quoted 10 lines · On Tue, 24 Mar 2020 19:03:30 +0800 Qu Wenruo <[email protected]> wrote:

Sorry for the delayed reply. (Stupid filter setup).

Currently most Uboot boards should use the same page size setup for its kernel, and most btrfs uses 4K sector size.

So for Uboot it should be no problem.

Although the best practice is to read the fs_info::sectorsize as David mentioned, but the code base doesn't allow us to do that yet.

Quoted 9 lines

So I'm going to backport the read part code from btrfs-progs in the near-future, and completely solve it, making it sector size independent.

Would this plan looks sound? Or we need to wait for the full re-implementation?

Thanks,
Qu

The situation is Linux is such that btrfs sectorsize must be same as PAGE_SIZE, otherwise the Linux btrfs driver won't work. AFAIK there are only few architectures where PAGE_SIZE is not 4 KiB. btrfs filesystems created there cannot be mounted on systems with PAGE_SIZE = 4 KiB.

I don't know if U-Boot is used on non 4KiB PAGE_SIZE boards. If it is, it should be solved, but I would check that before complicating the code.

#9 lore raw

Re: [PATCH 2/2] uboot: fs/btrfs: Fix LZO false decompression error caused by pending zero

In reply to David Sterba
Quoted 24 lines · David Sterba
Quoted 23 lines · Matthias Brugger
Quoted 19 lines · David Sterba
Quoted 13 lines · Matthias Brugger

fs/btrfs/compression.c static u32 decompress_lzo(const u8 *cbuf, u32 clen, u8 *dbuf, u32 dlen) · line 71

Quoted 9 lines
fs/btrfs/compression.c +6 -0
 		dlen -= out_len;
 
 		res += out_len;
+
+		/*
+		 * If the 4 bytes header does not fit to the rest of the page we
+		 * have to move to next one, or we read some garbage.
+		 */
+		mod_page = tot_in % PAGE_SIZE;

in U-Boot we use 4K page sizes, but the OS could use another page size (16K or 64k). Would we need to adapt that code to reflect which page size is used on the medium we want to access?

Yes, it is the 'sectorsize' as it's set up in fs_info or it's equivalent in uboot. For kernel the page size == sectorsize is kind of implicit and verified at mount time.

Quoted 7 lines
Quoted 2 lines

Does this mean we would need to add a Kconfig option to set the sectorsize in U-Boot?

No, the value depends on the filesystem so it can't be a config option. What I mean is btrfs_super_block::sectorsize, where the superblock is btrfs_info::sb.

Sorry for the delayed reply. (Stupid filter setup).

Currently most Uboot boards should use the same page size setup for its kernel, and most btrfs uses 4K sector size.

So for Uboot it should be no problem.

Although the best practice is to read the fs_info::sectorsize as David mentioned, but the code base doesn't allow us to do that yet.

So I'm going to backport the read part code from btrfs-progs in the near-future, and completely solve it, making it sector size independent.

Would this plan look OK to you? Or we need to wait for the full re-implementation?

Thanks,
Qu

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: OpenPGP digital signature
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200324/22e935bd/attachment.sig>