[PATCH 1/2] staging: erofs: add requirements field in superblock

[PATCH 1/2] staging: erofs: add requirements field in superblock

[Gao Xiang]

There are some backward incompatible optimizations pending
for months, mainly due to on-disk format expensions.

However, we should ensure that it cannot be mounted with
old kernels. Otherwise, it will causes unexpected behaviors.

Fixes: ba2b77a82022 ("staging: erofs: add super block operations")
Cc: <stable@vger.kernel.org> # 4.19+
Signed-off-by: Gao Xiang <gaoxiang25@huawei.com>
---
 drivers/staging/erofs/erofs_fs.h | 11 +++++++++--
 drivers/staging/erofs/super.c    |  8 ++++++++
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/drivers/staging/erofs/erofs_fs.h b/drivers/staging/erofs/erofs_fs.h
index fa52898df006..531821757845 100644
--- a/drivers/staging/erofs/erofs_fs.h
+++ b/drivers/staging/erofs/erofs_fs.h
@@ -17,10 +17,16 @@
 #define EROFS_SUPER_MAGIC_V1    0xE0F5E1E2
 #define EROFS_SUPER_OFFSET      1024
 
+/*
+ * Any bits that aren't in EROFS_ALL_REQUIREMENTS should be
+ * incompatible with this kernel version.
+ */
+#define EROFS_ALL_REQUIREMENTS  0
+
 struct erofs_super_block {
 /*  0 */__le32 magic;           /* in the little endian */
 /*  4 */__le32 checksum;        /* crc32c(super_block) */
-/*  8 */__le32 features;
+/*  8 */__le32 features;        /* extra features for the image */
 /* 12 */__u8 blkszbits;         /* support block_size == PAGE_SIZE only */
 /* 13 */__u8 reserved;
 
@@ -34,8 +40,9 @@ struct erofs_super_block {
 /* 44 */__le32 xattr_blkaddr;
 /* 48 */__u8 uuid[16];          /* 128-bit uuid for volume */
 /* 64 */__u8 volume_name[16];   /* volume name */
+/* 80 */__le32 requirements;    /* all mandatory minimum requirements */
 
-/* 80 */__u8 reserved2[48];     /* 128 bytes */
+/* 84 */__u8 reserved2[44];     /* 128 bytes */
 } __packed;
 
 /*
diff --git a/drivers/staging/erofs/super.c b/drivers/staging/erofs/super.c
index f580d4ef77a1..815e5825db59 100644
--- a/drivers/staging/erofs/super.c
+++ b/drivers/staging/erofs/super.c
@@ -104,6 +104,14 @@ static int superblock_read(struct super_block *sb)
 		goto out;
 	}
 
+	/* check if the kernel meets all mandatory requirements */
+	if (le32_to_cpu(layout->requirements) & (~EROFS_ALL_REQUIREMENTS)) {
+		errln("too old to meet minimum requirements: %x supported: %x",
+		      le32_to_cpu(layout->requirements),
+		      EROFS_ALL_REQUIREMENTS);
+		goto out;
+	}
+
 	sbi->blocks = le32_to_cpu(layout->blocks);
 	sbi->meta_blkaddr = le32_to_cpu(layout->meta_blkaddr);
 #ifdef CONFIG_EROFS_FS_XATTR
-- 
2.17.1

[PATCH 2/2] staging: erofs: rename data_mapping_mode to datamode

[Gao Xiang]

data_mapping_mode is too long as a member name of erofs_vnode,
datamode is straight-forward enough.

Signed-off-by: Gao Xiang <gaoxiang25@huawei.com>
---
 drivers/staging/erofs/inode.c    | 17 ++++++++---------
 drivers/staging/erofs/internal.h | 10 ++++------
 2 files changed, 12 insertions(+), 15 deletions(-)

diff --git a/drivers/staging/erofs/inode.c b/drivers/staging/erofs/inode.c
index 9520419f746c..e51348f7e838 100644
--- a/drivers/staging/erofs/inode.c
+++ b/drivers/staging/erofs/inode.c
@@ -22,11 +22,11 @@ static int read_inode(struct inode *inode, void *data)
 	const unsigned int advise = le16_to_cpu(v1->i_advise);
 	erofs_blk_t nblks = 0;
 
-	vi->data_mapping_mode = __inode_data_mapping(advise);
+	vi->datamode = __inode_data_mapping(advise);
 
-	if (unlikely(vi->data_mapping_mode >= EROFS_INODE_LAYOUT_MAX)) {
-		errln("unknown data mapping mode %u of nid %llu",
-		      vi->data_mapping_mode, vi->nid);
+	if (unlikely(vi->datamode >= EROFS_INODE_LAYOUT_MAX)) {
+		errln("unsupported data mapping %u of nid %llu",
+		      vi->datamode, vi->nid);
 		DBG_BUGON(1);
 		return -EIO;
 	}
@@ -63,7 +63,7 @@ static int read_inode(struct inode *inode, void *data)
 		inode->i_size = le64_to_cpu(v2->i_size);
 
 		/* total blocks for compressed files */
-		if (vi->data_mapping_mode == EROFS_INODE_LAYOUT_COMPRESSION)
+		if (is_inode_layout_compression(inode))
 			nblks = le32_to_cpu(v2->i_u.compressed_blocks);
 	} else if (__inode_version(advise) == EROFS_INODE_LAYOUT_V1) {
 		struct erofs_sb_info *sbi = EROFS_SB(inode->i_sb);
@@ -95,7 +95,7 @@ static int read_inode(struct inode *inode, void *data)
 			sbi->build_time_nsec;
 
 		inode->i_size = le32_to_cpu(v1->i_size);
-		if (vi->data_mapping_mode == EROFS_INODE_LAYOUT_COMPRESSION)
+		if (is_inode_layout_compression(inode))
 			nblks = le32_to_cpu(v1->i_u.compressed_blocks);
 	} else {
 		errln("unsupported on-disk inode version %u of nid %llu",
@@ -127,7 +127,7 @@ static int fill_inline_data(struct inode *inode, void *data,
 {
 	struct erofs_vnode *vi = EROFS_V(inode);
 	struct erofs_sb_info *sbi = EROFS_I_SB(inode);
-	int mode = vi->data_mapping_mode;
+	const int mode = vi->datamode;
 
 	DBG_BUGON(mode >= EROFS_INODE_LAYOUT_MAX);
 
@@ -299,9 +299,8 @@ int erofs_getattr(const struct path *path, struct kstat *stat,
 		  u32 request_mask, unsigned int query_flags)
 {
 	struct inode *const inode = d_inode(path->dentry);
-	struct erofs_vnode *const vi = EROFS_V(inode);
 
-	if (vi->data_mapping_mode == EROFS_INODE_LAYOUT_COMPRESSION)
+	if (is_inode_layout_compression(inode))
 		stat->attributes |= STATX_ATTR_COMPRESSED;
 
 	stat->attributes |= STATX_ATTR_IMMUTABLE;
diff --git a/drivers/staging/erofs/internal.h b/drivers/staging/erofs/internal.h
index 911333cdeef4..6a7eb04d29b4 100644
--- a/drivers/staging/erofs/internal.h
+++ b/drivers/staging/erofs/internal.h
@@ -347,8 +347,7 @@ struct erofs_vnode {
 	/* atomic flags (including bitlocks) */
 	unsigned long flags;
 
-	unsigned char data_mapping_mode;
-	/* inline size in bytes */
+	unsigned char datamode;
 	unsigned char inode_isize;
 	unsigned short xattr_isize;
 
@@ -383,18 +382,17 @@ static inline unsigned long inode_datablocks(struct inode *inode)
 
 static inline bool is_inode_layout_plain(struct inode *inode)
 {
-	return EROFS_V(inode)->data_mapping_mode == EROFS_INODE_LAYOUT_PLAIN;
+	return EROFS_V(inode)->datamode == EROFS_INODE_LAYOUT_PLAIN;
 }
 
 static inline bool is_inode_layout_compression(struct inode *inode)
 {
-	return EROFS_V(inode)->data_mapping_mode ==
-					EROFS_INODE_LAYOUT_COMPRESSION;
+	return EROFS_V(inode)->datamode == EROFS_INODE_LAYOUT_COMPRESSION;
 }
 
 static inline bool is_inode_layout_inline(struct inode *inode)
 {
-	return EROFS_V(inode)->data_mapping_mode == EROFS_INODE_LAYOUT_INLINE;
+	return EROFS_V(inode)->datamode == EROFS_INODE_LAYOUT_INLINE;
 }
 
 extern const struct super_operations erofs_sops;
-- 
2.17.1

Re: [PATCH 2/2] staging: erofs: rename data_mapping_mode to datamode

[Chao Yu]

On 2019/6/10 17:36, Gao Xiang wrote:
> data_mapping_mode is too long as a member name of erofs_vnode,
> datamode is straight-forward enough.
> 
> Signed-off-by: Gao Xiang <gaoxiang25@huawei.com>

Reviewed-by: Chao Yu <yuchao0@huawei.com>

Thanks,

Re: [PATCH 1/2] staging: erofs: add requirements field in superblock

[Chao Yu]

On 2019/6/10 17:36, Gao Xiang wrote:
> There are some backward incompatible optimizations pending
> for months, mainly due to on-disk format expensions.
> 
> However, we should ensure that it cannot be mounted with
> old kernels. Otherwise, it will causes unexpected behaviors.
> 
> Fixes: ba2b77a82022 ("staging: erofs: add super block operations")
> Cc: <stable@vger.kernel.org> # 4.19+
> Signed-off-by: Gao Xiang <gaoxiang25@huawei.com>
> ---
>  drivers/staging/erofs/erofs_fs.h | 11 +++++++++--
>  drivers/staging/erofs/super.c    |  8 ++++++++
>  2 files changed, 17 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/staging/erofs/erofs_fs.h b/drivers/staging/erofs/erofs_fs.h
> index fa52898df006..531821757845 100644
> --- a/drivers/staging/erofs/erofs_fs.h
> +++ b/drivers/staging/erofs/erofs_fs.h
> @@ -17,10 +17,16 @@
>  #define EROFS_SUPER_MAGIC_V1    0xE0F5E1E2
>  #define EROFS_SUPER_OFFSET      1024
>  
> +/*
> + * Any bits that aren't in EROFS_ALL_REQUIREMENTS should be
> + * incompatible with this kernel version.
> + */
> +#define EROFS_ALL_REQUIREMENTS  0
> +
>  struct erofs_super_block {
>  /*  0 */__le32 magic;           /* in the little endian */
>  /*  4 */__le32 checksum;        /* crc32c(super_block) */
> -/*  8 */__le32 features;
> +/*  8 */__le32 features;        /* extra features for the image */
>  /* 12 */__u8 blkszbits;         /* support block_size == PAGE_SIZE only */
>  /* 13 */__u8 reserved;
>  
> @@ -34,8 +40,9 @@ struct erofs_super_block {
>  /* 44 */__le32 xattr_blkaddr;
>  /* 48 */__u8 uuid[16];          /* 128-bit uuid for volume */
>  /* 64 */__u8 volume_name[16];   /* volume name */
> +/* 80 */__le32 requirements;    /* all mandatory minimum requirements */
>  
> -/* 80 */__u8 reserved2[48];     /* 128 bytes */
> +/* 84 */__u8 reserved2[44];     /* 128 bytes */

Xiang,

It needs to update the comment behind reserved2, it's locating at 132 bytes.

>  } __packed;
>  
>  /*
> diff --git a/drivers/staging/erofs/super.c b/drivers/staging/erofs/super.c
> index f580d4ef77a1..815e5825db59 100644
> --- a/drivers/staging/erofs/super.c
> +++ b/drivers/staging/erofs/super.c
> @@ -104,6 +104,14 @@ static int superblock_read(struct super_block *sb)
>  		goto out;
>  	}
>  
> +	/* check if the kernel meets all mandatory requirements */
> +	if (le32_to_cpu(layout->requirements) & (~EROFS_ALL_REQUIREMENTS)) {
> +		errln("too old to meet minimum requirements: %x supported: %x",

It will be better to give a suggestion to user to upgrade kernel version to
match the image with new layout, otherwise it's just a little confused about
above printed message.

Thanks,

> +		      le32_to_cpu(layout->requirements),
> +		      EROFS_ALL_REQUIREMENTS);
> +		goto out;
> +	}
> +
>  	sbi->blocks = le32_to_cpu(layout->blocks);
>  	sbi->meta_blkaddr = le32_to_cpu(layout->meta_blkaddr);
>  #ifdef CONFIG_EROFS_FS_XATTR
> 

Re: [PATCH 1/2] staging: erofs: add requirements field in superblock

[Gao Xiang]

Hi Chao,

On 2019/6/11 9:37, Chao Yu wrote:
> On 2019/6/10 17:36, Gao Xiang wrote:
>> There are some backward incompatible optimizations pending
>> for months, mainly due to on-disk format expensions.
>>
>> However, we should ensure that it cannot be mounted with
>> old kernels. Otherwise, it will causes unexpected behaviors.
>>
>> Fixes: ba2b77a82022 ("staging: erofs: add super block operations")
>> Cc: <stable@vger.kernel.org> # 4.19+
>> Signed-off-by: Gao Xiang <gaoxiang25@huawei.com>
>> ---
>>  drivers/staging/erofs/erofs_fs.h | 11 +++++++++--
>>  drivers/staging/erofs/super.c    |  8 ++++++++
>>  2 files changed, 17 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/staging/erofs/erofs_fs.h b/drivers/staging/erofs/erofs_fs.h
>> index fa52898df006..531821757845 100644
>> --- a/drivers/staging/erofs/erofs_fs.h
>> +++ b/drivers/staging/erofs/erofs_fs.h
>> @@ -17,10 +17,16 @@
>>  #define EROFS_SUPER_MAGIC_V1    0xE0F5E1E2
>>  #define EROFS_SUPER_OFFSET      1024
>>  
>> +/*
>> + * Any bits that aren't in EROFS_ALL_REQUIREMENTS should be
>> + * incompatible with this kernel version.
>> + */
>> +#define EROFS_ALL_REQUIREMENTS  0
>> +
>>  struct erofs_super_block {
>>  /*  0 */__le32 magic;           /* in the little endian */
>>  /*  4 */__le32 checksum;        /* crc32c(super_block) */
>> -/*  8 */__le32 features;
>> +/*  8 */__le32 features;        /* extra features for the image */
>>  /* 12 */__u8 blkszbits;         /* support block_size == PAGE_SIZE only */
>>  /* 13 */__u8 reserved;
>>  
>> @@ -34,8 +40,9 @@ struct erofs_super_block {
>>  /* 44 */__le32 xattr_blkaddr;
>>  /* 48 */__u8 uuid[16];          /* 128-bit uuid for volume */
>>  /* 64 */__u8 volume_name[16];   /* volume name */
>> +/* 80 */__le32 requirements;    /* all mandatory minimum requirements */
>>  
>> -/* 80 */__u8 reserved2[48];     /* 128 bytes */
>> +/* 84 */__u8 reserved2[44];     /* 128 bytes */
> 
> Xiang,
> 
> It needs to update the comment behind reserved2, it's locating at 132 bytes.

I don't get the point... the whole struct is totally 128bytes I think?

> 
>>  } __packed;
>>  
>>  /*
>> diff --git a/drivers/staging/erofs/super.c b/drivers/staging/erofs/super.c
>> index f580d4ef77a1..815e5825db59 100644
>> --- a/drivers/staging/erofs/super.c
>> +++ b/drivers/staging/erofs/super.c
>> @@ -104,6 +104,14 @@ static int superblock_read(struct super_block *sb)
>>  		goto out;
>>  	}
>>  
>> +	/* check if the kernel meets all mandatory requirements */
>> +	if (le32_to_cpu(layout->requirements) & (~EROFS_ALL_REQUIREMENTS)) {
>> +		errln("too old to meet minimum requirements: %x supported: %x",
> 
> It will be better to give a suggestion to user to upgrade kernel version to
> match the image with new layout, otherwise it's just a little confused about
> above printed message.

OK, I will refine the printed message :)

Thanks,
Gao Xiang

> 
> Thanks,
> 
>> +		      le32_to_cpu(layout->requirements),
>> +		      EROFS_ALL_REQUIREMENTS);
>> +		goto out;
>> +	}
>> +
>>  	sbi->blocks = le32_to_cpu(layout->blocks);
>>  	sbi->meta_blkaddr = le32_to_cpu(layout->meta_blkaddr);
>>  #ifdef CONFIG_EROFS_FS_XATTR
>>

Re: [PATCH 1/2] staging: erofs: add requirements field in superblock

[Chao Yu]

On 2019/6/11 9:43, Gao Xiang wrote:
> Hi Chao,
> 
> On 2019/6/11 9:37, Chao Yu wrote:
>> On 2019/6/10 17:36, Gao Xiang wrote:
>>> There are some backward incompatible optimizations pending
>>> for months, mainly due to on-disk format expensions.
>>>
>>> However, we should ensure that it cannot be mounted with
>>> old kernels. Otherwise, it will causes unexpected behaviors.
>>>
>>> Fixes: ba2b77a82022 ("staging: erofs: add super block operations")
>>> Cc: <stable@vger.kernel.org> # 4.19+
>>> Signed-off-by: Gao Xiang <gaoxiang25@huawei.com>
>>> ---
>>>  drivers/staging/erofs/erofs_fs.h | 11 +++++++++--
>>>  drivers/staging/erofs/super.c    |  8 ++++++++
>>>  2 files changed, 17 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/drivers/staging/erofs/erofs_fs.h b/drivers/staging/erofs/erofs_fs.h
>>> index fa52898df006..531821757845 100644
>>> --- a/drivers/staging/erofs/erofs_fs.h
>>> +++ b/drivers/staging/erofs/erofs_fs.h
>>> @@ -17,10 +17,16 @@
>>>  #define EROFS_SUPER_MAGIC_V1    0xE0F5E1E2
>>>  #define EROFS_SUPER_OFFSET      1024
>>>  
>>> +/*
>>> + * Any bits that aren't in EROFS_ALL_REQUIREMENTS should be
>>> + * incompatible with this kernel version.
>>> + */
>>> +#define EROFS_ALL_REQUIREMENTS  0
>>> +
>>>  struct erofs_super_block {
>>>  /*  0 */__le32 magic;           /* in the little endian */
>>>  /*  4 */__le32 checksum;        /* crc32c(super_block) */
>>> -/*  8 */__le32 features;
>>> +/*  8 */__le32 features;        /* extra features for the image */
>>>  /* 12 */__u8 blkszbits;         /* support block_size == PAGE_SIZE only */
>>>  /* 13 */__u8 reserved;
>>>  
>>> @@ -34,8 +40,9 @@ struct erofs_super_block {
>>>  /* 44 */__le32 xattr_blkaddr;
>>>  /* 48 */__u8 uuid[16];          /* 128-bit uuid for volume */
>>>  /* 64 */__u8 volume_name[16];   /* volume name */
>>> +/* 80 */__le32 requirements;    /* all mandatory minimum requirements */
>>>  
>>> -/* 80 */__u8 reserved2[48];     /* 128 bytes */
>>> +/* 84 */__u8 reserved2[44];     /* 128 bytes */
>>
>> Xiang,
>>
>> It needs to update the comment behind reserved2, it's locating at 132 bytes.
> 
> I don't get the point... the whole struct is totally 128bytes I think?

Xiang, I misunderstood meaning of comments, please ignore it, sorry. :)

Thanks,

> 
>>
>>>  } __packed;
>>>  
>>>  /*
>>> diff --git a/drivers/staging/erofs/super.c b/drivers/staging/erofs/super.c
>>> index f580d4ef77a1..815e5825db59 100644
>>> --- a/drivers/staging/erofs/super.c
>>> +++ b/drivers/staging/erofs/super.c
>>> @@ -104,6 +104,14 @@ static int superblock_read(struct super_block *sb)
>>>  		goto out;
>>>  	}
>>>  
>>> +	/* check if the kernel meets all mandatory requirements */
>>> +	if (le32_to_cpu(layout->requirements) & (~EROFS_ALL_REQUIREMENTS)) {
>>> +		errln("too old to meet minimum requirements: %x supported: %x",
>>
>> It will be better to give a suggestion to user to upgrade kernel version to
>> match the image with new layout, otherwise it's just a little confused about
>> above printed message.
> 
> OK, I will refine the printed message :)
> 
> Thanks,
> Gao Xiang
> 
>>
>> Thanks,
>>
>>> +		      le32_to_cpu(layout->requirements),
>>> +		      EROFS_ALL_REQUIREMENTS);
>>> +		goto out;
>>> +	}
>>> +
>>>  	sbi->blocks = le32_to_cpu(layout->blocks);
>>>  	sbi->meta_blkaddr = le32_to_cpu(layout->meta_blkaddr);
>>>  #ifdef CONFIG_EROFS_FS_XATTR
>>>
> .
>