Skip to contentSkip to conversation

erofs: code for verifying superblock checksum of an erofs image.

PATCH Superseded Pratik Shinde 2 participants 2 messages Oct 20, 2019 – Oct 21, 2019 EROFS file system

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 erofs: code for verifying superblock checksum of an erofs image.

Patch for kernel side changes of checksum feature.I used kernel's crc32c library for calculating the checksum.

---
 fs/erofs/erofs_fs.h |  5 +++--
 fs/erofs/internal.h |  2 +-
 fs/erofs/super.c    | 50 ++++++++++++++++++++++++++++++++++++++++++++++----
 3 files changed, 50 insertions(+), 7 deletions(-)
fs/erofs/erofs_fs.h +3 -2
index b1ee565..bab5506 100644
@@ -17,6 +17,7 @@
  */
 #define EROFS_FEATURE_INCOMPAT_LZ4_0PADDING	0x00000001
 #define EROFS_ALL_FEATURE_INCOMPAT		EROFS_FEATURE_INCOMPAT_LZ4_0PADDING
+#define EROFS_FEATURE_SB_CHKSUM 0x0001
 
 /* 128-byte erofs on-disk super block */
 struct erofs_super_block {
@@ -37,8 +38,8 @@ struct erofs_super_block {
 	__u8 uuid[16];          /* 128-bit uuid for volume */
 	__u8 volume_name[16];   /* volume name */
 	__le32 feature_incompat;
-
-	__u8 reserved2[44];
+	__le32 chksum_blocks;	/* number of blocks used for checksum */
+	__u8 reserved2[40];
 };
 
 /*
fs/erofs/internal.h +1 -1
index 544a453..cd3af45 100644
@@ -86,7 +86,7 @@ struct erofs_sb_info {
 	u8 uuid[16];                    /* 128-bit uuid for volume */
 	u8 volume_name[16];             /* volume name */
 	u32 feature_incompat;
-
+	u32 features;
 	unsigned int mount_opt;
 };
 
fs/erofs/super.c +46 -4

76 lines not on this page · raw message

Signature · 1 line
2.9.3
#1 lore raw

Hi Pratik,

Some comments as below...

Quoted 15 lines · Pratik Shinde

Patch for kernel side changes of checksum feature.I used kernel's crc32c library for calculating the checksum.

---
 fs/erofs/erofs_fs.h |  5 +++--
 fs/erofs/internal.h |  2 +-
 fs/erofs/super.c    | 50 ++++++++++++++++++++++++++++++++++++++++++++++----
 3 files changed, 50 insertions(+), 7 deletions(-)
fs/erofs/erofs_fs.h +0 -0
index b1ee565..bab5506 100644

fs/erofs/erofs_fs.h line 20

Quoted 4 lines
fs/erofs/erofs_fs.h +1 -0
@@ -17,6 +17,7 @@
  */
 #define EROFS_FEATURE_INCOMPAT_LZ4_0PADDING	0x00000001
 #define EROFS_ALL_FEATURE_INCOMPAT		EROFS_FEATURE_INCOMPAT_LZ4_0PADDING
+#define EROFS_FEATURE_SB_CHKSUM 0x0001

How about keeping in sync with erofs-utils?

Quoted 19 lines
fs/erofs/erofs_fs.h +2 -2
 /* 128-byte erofs on-disk super block */
 struct erofs_super_block {
@@ -37,8 +38,8 @@ struct erofs_super_block {
 	__u8 uuid[16];          /* 128-bit uuid for volume */
 	__u8 volume_name[16];   /* volume name */
 	__le32 feature_incompat;
-
-	__u8 reserved2[44];
+	__le32 chksum_blocks;	/* number of blocks used for checksum */
+	__u8 reserved2[40];
 };
 
 /*
fs/erofs/internal.h +0 -0
index 544a453..cd3af45 100644

fs/erofs/internal.h struct erofs_sb_info { · line 89

Quoted 5 lines
fs/erofs/internal.h +1 -1
@@ -86,7 +86,7 @@ struct erofs_sb_info {
 	u8 uuid[16];                    /* 128-bit uuid for volume */
 	u8 volume_name[16];             /* volume name */
 	u32 feature_incompat;
-
+	u32 features;

no use? and
how about keeping in sync with erofs-utils, naming feature_compat as well? see,

https://lore.kernel.org/r/20191020141102.GA30399@hsiangkao-HP-ZHAN-66-Pro-G1/

Quoted 16 lines
fs/erofs/internal.h +0 -0
 	unsigned int mount_opt;
 };
 
fs/erofs/super.c +1 -0
index 0e36949..94e1d6a 100644
@@ -9,6 +9,7 @@
 #include <linux/statfs.h>
 #include <linux/parser.h>
 #include <linux/seq_file.h>
+#include <linux/crc32c.h>
 #include "xattr.h"
 
 #define CREATE_TRACE_POINTS

fs/erofs/super.c void _erofs_info(struct super_block *sb, const char *function, · line 51

Quoted 5 lines
fs/erofs/super.c +2 -0
@@ -46,6 +47,45 @@ void _erofs_info(struct super_block *sb, const char *function,
 	va_end(args);
 }
 
+static int erofs_validate_sb_chksum(struct erofs_super_block *dsb,
+				       struct super_block *sb)

erofs_validate_sb_chksum(struct super_block *sb, void *sbdata)

Can we pass void *sbdata --- first page(block) instead?

fs/erofs/super.c void _erofs_info(struct super_block *sb, const char *function, · line 63

Quoted 12 lines
fs/erofs/super.c +12 -0
+{
+	u32 disk_chksum = le32_to_cpu(dsb->checksum);
+	u32 nblocks = le32_to_cpu(dsb->chksum_blocks);
+	u32 crc;
+	struct erofs_super_block *dsb2;
+	char *buf;
+	unsigned int off = 0;
+	void *kaddr;
+	struct page *page;
+	int i, ret = -EINVAL;
+
+	buf = kmalloc(nblocks * EROFS_BLKSIZ, GFP_KERNEL);

IMO, I think we could just
1) malloc EROFS_BLKSIZ;
2) copy sbdata -> buf;
3) dsb->checksum = 0;
4) crc32c the first copied block;
5) kfree.

or some better approach without allocating memory.

fs/erofs/super.c void _erofs_info(struct super_block *sb, const char *function, · line 65

Quoted 2 lines
fs/erofs/super.c +2 -0
+	if (!buf)
+		goto out;

how about erroring out with proper return value?

fs/erofs/super.c void _erofs_info(struct super_block *sb, const char *function, · line 68

Quoted 3 lines
fs/erofs/super.c +3 -0
+	for (i = 0; i < nblocks; i++) {
+		page = erofs_get_meta_page(sb, i);
+		if (IS_ERR(page))

ditto.

fs/erofs/super.c void _erofs_info(struct super_block *sb, const char *function, · line 71

Quoted 3 lines
fs/erofs/super.c +3 -0
+			goto out;
+		kaddr = kmap_atomic(page);
+		(void) memcpy(buf + off, kaddr, EROFS_BLKSIZ);

we can call crc32c for multiple times, and no need to get and calc 0-th block again...

and no memcpy at all.

Quoted 21 lines
fs/erofs/super.c +17 -0
+		kunmap_atomic(kaddr);
+		unlock_page(page);
+		/* first page will be released by erofs_read_superblock */
+		if (i != 0)
+			put_page(page);
+		off += EROFS_BLKSIZ;
+	}
+	dsb2 = (struct erofs_super_block *)(buf + EROFS_SUPER_OFFSET);
+	dsb2->checksum = 0;
+	crc = crc32c(0, buf, nblocks * EROFS_BLKSIZ);
+	if (crc != disk_chksum)
+		goto out;
+	ret = 0;
+out:	kfree(buf);
+	return ret;
+}
+
 static void erofs_inode_init_once(void *ptr)
 {
 	struct erofs_inode *vi = ptr;

fs/erofs/super.c static int erofs_read_superblock(struct super_block *sb) · line 153

Quoted 7 lines
fs/erofs/super.c +0 -2
@@ -109,18 +149,20 @@ static int erofs_read_superblock(struct super_block *sb)
 		erofs_err(sb, "cannot read erofs superblock");
 		return PTR_ERR(page);
 	}
-
 	sbi = EROFS_SB(sb);
-
 	data = kmap_atomic(page);

should use kmap() then, because kmalloc() and get_meta_page() can sleep and last for long time.

fs/erofs/super.c static int erofs_read_superblock(struct super_block *sb) · line 161

Quoted 10 lines
fs/erofs/super.c +2 -2
 	dsb = (struct erofs_super_block *)(data + EROFS_SUPER_OFFSET);
-
 	ret = -EINVAL;
 	if (le32_to_cpu(dsb->magic) != EROFS_SUPER_MAGIC_V1) {
 		erofs_err(sb, "cannot find valid erofs superblock");
 		goto out;
 	}
-
+	if (dsb->feature_compat & EROFS_FEATURE_SB_CHKSUM) {
+		if (erofs_validate_sb_chksum(dsb, sb)) {

erofs_validate_sb_chksum(sb, data)

fs/erofs/super.c static int erofs_read_superblock(struct super_block *sb) · line 162

Quoted 1 line
fs/erofs/super.c +1 -0
+			erofs_err(sb, "super block checksum incorrect");

It should be with a proper return value and corresponding messages, see the related discussion:
https://lore.kernel.org/r/20190822090541.GA193349@architecture4/

Thanks,
Gao Xiang

Quoted 9 lines
fs/erofs/super.c +3 -0
+			goto out;
+		}
+	}
 	blkszbits = dsb->blkszbits;
 	/* 9(512 bytes) + LOG_SECTORS_PER_BLOCK == LOG_BLOCK_SIZE */
 	if (blkszbits != LOG_BLOCK_SIZE) {
Signature · 1 line
2.9.3