Skip to contentSkip to conversation

f2fs: compress: support compress level

PATCH In review Chao Yu 3 participants 3 messages Dec 2, 2020 – Dec 3, 2020

Subsystems (2)
lore
Share & tools
lore

Chao Yu

author maintainer
#0 lore raw

PATCH v4 1/1 f2fs: compress: support compress level

From: Chao Yu <[email protected]>

Expand 'compress_algorithm' mount option to accept parameter as format of <algorithm>:<level>, by this way, it gives a way to allow user to do more specified config on lz4 and zstd compression level, then f2fs compression can provide higher compress ratio.

In order to set compress level for lz4 algorithm, it needs to set CONFIG_LZ4HC_COMPRESS and CONFIG_F2FS_FS_LZ4HC config to enable lz4hc compress algorithm.

---
v4:
- rebase to last dev branch

 Documentation/filesystems/f2fs.rst |  5 +++
 fs/f2fs/Kconfig                    |  9 ++++
 fs/f2fs/compress.c                 | 40 ++++++++++++++++--
 fs/f2fs/f2fs.h                     |  9 ++++
 fs/f2fs/super.c                    | 67 +++++++++++++++++++++++++++++-
 include/linux/f2fs_fs.h            |  3 ++
 6 files changed, 128 insertions(+), 5 deletions(-)
Documentation/filesystems/f2fs.rst +5 -0
index fd413d319e93..eef683c3266f 100644
@@ -249,6 +249,11 @@ checkpoint=%s[:%u[%]]	 Set to "disable" to turn off checkpointing. Set to "enabl
 			 This space is reclaimed once checkpoint=enable.
 compress_algorithm=%s	 Control compress algorithm, currently f2fs supports "lzo",
 			 "lz4", "zstd" and "lzo-rle" algorithm.
+compress_algorithm=%s:%d Control compress algorithm and its compress level, now, only
+			 "lz4" and "zstd" support compress level config.
+			 		level range
+			 lz4		3 - 16
+			 zstd		1 - 22
 compress_log_size=%u	 Support configuring compress cluster size, the size will
 			 be 4KB * (1 << %u), 16KB is minimum size, also it's
 			 default size.
fs/f2fs/Kconfig +9 -0
index d13c5c6a9787..8134b145ae4f 100644
@@ -119,6 +119,15 @@ config F2FS_FS_LZ4
 	help
 	  Support LZ4 compress algorithm, if unsure, say Y.
 
+config F2FS_FS_LZ4HC
+	bool "LZ4HC compression support"
+	depends on F2FS_FS_COMPRESSION
+	depends on F2FS_FS_LZ4
+	select LZ4HC_COMPRESS
+	default y
+	help
+	  Support LZ4HC compress algorithm, if unsure, say Y.
+
 config F2FS_FS_ZSTD
 	bool "ZSTD compression support"
 	depends on F2FS_FS_COMPRESSION
fs/f2fs/compress.c +37 -3
index db82da311fe4..dfadbc78946c 100644
@@ -254,8 +254,13 @@ static const struct f2fs_compress_ops f2fs_lzo_ops = {
 #ifdef CONFIG_F2FS_FS_LZ4
 static int lz4_init_compress_ctx(struct compress_ctx *cc)
 {
-	cc->private = f2fs_kvmalloc(F2FS_I_SB(cc->inode),
-				LZ4_MEM_COMPRESS, GFP_NOFS);
+	unsigned int size;
+	unsigned char level = F2FS_I(cc->inode)->i_compress_flag >>
+						COMPRESS_LEVEL_OFFSET;
+
+	size = level ? LZ4HC_MEM_COMPRESS : LZ4_MEM_COMPRESS;
+
+	cc->private = f2fs_kvmalloc(F2FS_I_SB(cc->inode), size, GFP_NOFS);
 	if (!cc->private)
 		return -ENOMEM;
 
@@ -274,10 +279,34 @@ static void lz4_destroy_compress_ctx(struct compress_ctx *cc)
 	cc->private = NULL;
 }
 
+#ifdef CONFIG_F2FS_FS_LZ4HC
+static int lz4hc_compress_pages(struct compress_ctx *cc)
+{
+	unsigned char level = F2FS_I(cc->inode)->i_compress_flag >>
+						COMPRESS_LEVEL_OFFSET;
+	int len;
+
+	if (level)
+		len = LZ4_compress_HC(cc->rbuf, cc->cbuf->cdata, cc->rlen,
+					cc->clen, level, cc->private);
+	else
+		len = LZ4_compress_default(cc->rbuf, cc->cbuf->cdata, cc->rlen,
+						cc->clen, cc->private);
+	if (!len)
+		return -EAGAIN;
+
+	cc->clen = len;
+	return 0;
+}
+#endif
+
 static int lz4_compress_pages(struct compress_ctx *cc)
 {
 	int len;
 
+#ifdef CONFIG_F2FS_FS_LZ4HC
+	return lz4hc_compress_pages(cc);
+#endif
 	len = LZ4_compress_default(cc->rbuf, cc->cbuf->cdata, cc->rlen,
 						cc->clen, cc->private);
 	if (!len)
@@ -327,8 +356,13 @@ static int zstd_init_compress_ctx(struct compress_ctx *cc)
 	ZSTD_CStream *stream;
 	void *workspace;
 	unsigned int workspace_size;
+	unsigned char level = F2FS_I(cc->inode)->i_compress_flag >>
+						COMPRESS_LEVEL_OFFSET;
+
+	if (!level)
+		level = F2FS_ZSTD_DEFAULT_CLEVEL;
 
-	params = ZSTD_getParams(F2FS_ZSTD_DEFAULT_CLEVEL, cc->rlen, 0);
+	params = ZSTD_getParams(level, cc->rlen, 0);
 	workspace_size = ZSTD_CStreamWorkspaceBound(params.cParams);
 
 	workspace = f2fs_kvmalloc(F2FS_I_SB(cc->inode),
fs/f2fs/f2fs.h +9 -0
index 377a2e2bf466..76edec7483f3 100644
@@ -147,6 +147,7 @@ struct f2fs_mount_info {
 	/* For compression */
 	unsigned char compress_algorithm;	/* algorithm type */
 	unsigned char compress_log_size;	/* cluster log size */
+	unsigned char compress_level;		/* compress level */
 	bool compress_chksum;			/* compressed data chksum */
 	unsigned char compress_ext_cnt;		/* extension count */
 	int compress_mode;			/* compression mode */
@@ -736,6 +737,7 @@ struct f2fs_inode_info {
 	atomic_t i_compr_blocks;		/* # of compressed blocks */
 	unsigned char i_compress_algorithm;	/* algorithm type */
 	unsigned char i_log_cluster_size;	/* log of cluster size */
+	unsigned char i_compress_level;		/* compress level (lz4hc,zstd) */
 	unsigned short i_compress_flag;		/* compress flag */
 	unsigned int i_cluster_size;		/* cluster size */
 };
@@ -1308,6 +1310,8 @@ struct compress_data {
 
 #define F2FS_COMPRESSED_PAGE_MAGIC	0xF5F2C000
 
+#define	COMPRESS_LEVEL_OFFSET	8
+
 /* compress context */
 struct compress_ctx {
 	struct inode *inode;		/* inode the context belong to */
@@ -3959,6 +3963,11 @@ static inline void set_compress_context(struct inode *inode)
 				1 << COMPRESS_CHKSUM : 0;
 	F2FS_I(inode)->i_cluster_size =
 			1 << F2FS_I(inode)->i_log_cluster_size;
+	if (F2FS_I(inode)->i_compress_algorithm == COMPRESS_LZ4 &&
+			F2FS_OPTION(sbi).compress_level)
+		F2FS_I(inode)->i_compress_flag |=
+				F2FS_OPTION(sbi).compress_level <<
+				COMPRESS_LEVEL_OFFSET;
 	F2FS_I(inode)->i_flags |= F2FS_COMPR_FL;
 	set_inode_flag(inode, FI_COMPRESSED_FILE);
 	stat_inc_compr_inode(inode);
fs/f2fs/super.c +65 -2

93 lines not on this page · raw message

include/linux/f2fs_fs.h +3 -0
index 55be7afeee90..2dcc63fe8494 100644
@@ -275,6 +275,9 @@ struct f2fs_inode {
 			__u8 i_compress_algorithm;	/* compress algorithm */
 			__u8 i_log_cluster_size;	/* log of cluster size */
 			__le16 i_compress_flag;		/* compress flag */
+						/* 0 bit: chksum flag
+						 * [10,15] bits: compress level
+						 */
 			__le32 i_extra_end[0];	/* for attribute size calculation */
 		} __packed;
 		__le32 i_addr[DEF_ADDRS_PER_INODE];	/* Pointers to data blocks */
Signature · 8 lines
2.22.0



_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
#1 lore raw
I love your patch! Yet something to improve:

Hi Chao,

I love your patch! Yet something to improve:

[auto build test ERROR on f2fs/dev-test]
[cannot apply to v5.10-rc6 next-20201201]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Chao-Yu/f2fs-compress-support-compress-level/20201202-230008
base:   https://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs.git dev-test
config: i386-randconfig-a013-20201202 (attached as .config)
compiler: gcc-9 (Debian 9.3.0-15) 9.3.0
reproduce (this is a W=1 build):
        # https://github.com/0day-ci/linux/commit/d9c3b7b5530238923fb521561c309a98b1e3797a
        git remote add linux-review https://github.com/0day-ci/linux
        git fetch --no-tags linux-review Chao-Yu/f2fs-compress-support-compress-level/20201202-230008
        git checkout d9c3b7b5530238923fb521561c309a98b1e3797a
        # save the attached .config to linux build tree
        make W=1 ARCH=i386 

If you fix the issue, kindly add following tag as appropriate

All errors (new ones prefixed by >>):

ld: fs/f2fs/super.o: in function `f2fs_compress_set_level':

>> fs/f2fs/super.c:505: undefined reference to `ZSTD_maxCLevel'

vim +505 fs/f2fs/super.c

468
469 #ifdef CONFIG_F2FS_FS_COMPRESSION
470 static int f2fs_compress_set_level(struct f2fs_sb_info *sbi, const char *str,
471 int type)
472 {
473 unsigned int level;
474 int len;
475
476 if (type == COMPRESS_LZ4)
477 len = 3;
478 else if (type == COMPRESS_ZSTD)
479 len = 4;
480 else
481 return 0;
482
483 if (strlen(str) == len)
484 return 0;
485
486 str += len;
487
488 if (str[0] != ':') {
489 f2fs_info(sbi, "wrong format, e.g. <alg_name>:<compr_level>");
490 return -EINVAL;
491 }
492 if (kstrtouint(str + 1, 10, &level))
493 return -EINVAL;
494 if (type == COMPRESS_LZ4) {
495 #ifdef CONFIG_F2FS_FS_LZ4HC
496 if (level < LZ4HC_MIN_CLEVEL || level > LZ4HC_MAX_CLEVEL) {
497 f2fs_info(sbi, "invalid lz4hc compress level: %d", level);
498 return -EINVAL;
499 }
500 #else
501 f2fs_info(sbi, "doesn't support lz4hc compression");
502 return 0;
503 #endif
504 } else if (type == COMPRESS_ZSTD) {

 > 505			if (!level || level > ZSTD_maxCLevel()) {

506 f2fs_info(sbi, "invalid zstd compress level: %d", level);
507 return -EINVAL;
508 }
509 }
510 F2FS_OPTION(sbi).compress_level = level;
511 return 0;
512 }
513 #endif
514

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

#2 lore raw

Hi,

Thanks a lot for the report.

I missed to cover this under zstd config.

Quoted 83 lines · kernel test robot

Hi Chao,

I love your patch! Yet something to improve:

[auto build test ERROR on f2fs/dev-test]
[cannot apply to v5.10-rc6 next-20201201]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Chao-Yu/f2fs-compress-support-compress-level/20201202-230008
base:   https://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs.git dev-test
config: i386-randconfig-a013-20201202 (attached as .config)
compiler: gcc-9 (Debian 9.3.0-15) 9.3.0
reproduce (this is a W=1 build):
         # https://github.com/0day-ci/linux/commit/d9c3b7b5530238923fb521561c309a98b1e3797a
         git remote add linux-review https://github.com/0day-ci/linux
         git fetch --no-tags linux-review Chao-Yu/f2fs-compress-support-compress-level/20201202-230008
         git checkout d9c3b7b5530238923fb521561c309a98b1e3797a
         # save the attached .config to linux build tree
         make W=1 ARCH=i386

If you fix the issue, kindly add following tag as appropriate

All errors (new ones prefixed by >>):

ld: fs/f2fs/super.o: in function `f2fs_compress_set_level':

Quoted 1 line
Quoted 1 line

fs/f2fs/super.c:505: undefined reference to `ZSTD_maxCLevel' >

vim +505 fs/f2fs/super.c

    468	
    469	#ifdef CONFIG_F2FS_FS_COMPRESSION
    470	static int f2fs_compress_set_level(struct f2fs_sb_info *sbi, const char *str,
    471							int type)
    472	{
    473		unsigned int level;
    474		int len;
    475	
    476		if (type == COMPRESS_LZ4)
    477			len = 3;
    478		else if (type == COMPRESS_ZSTD)
    479			len = 4;
    480		else
    481			return 0;
    482	
    483		if (strlen(str) == len)
    484			return 0;
    485	
    486		str += len;
    487	
    488		if (str[0] != ':') {
    489			f2fs_info(sbi, "wrong format, e.g. <alg_name>:<compr_level>");
    490			return -EINVAL;
    491		}
    492		if (kstrtouint(str + 1, 10, &level))
    493			return -EINVAL;
    494		if (type == COMPRESS_LZ4) {
    495	#ifdef CONFIG_F2FS_FS_LZ4HC
    496			if (level < LZ4HC_MIN_CLEVEL || level > LZ4HC_MAX_CLEVEL) {
    497				f2fs_info(sbi, "invalid lz4hc compress level: %d", level);
    498				return -EINVAL;
    499			}
    500	#else
    501			f2fs_info(sbi, "doesn't support lz4hc compression");
    502			return 0;
    503	#endif
    504		} else if (type == COMPRESS_ZSTD) {
Quoted 1 line

505 if (!level || level > ZSTD_maxCLevel()) {

    506				f2fs_info(sbi, "invalid zstd compress level: %d", level);
    507				return -EINVAL;
    508			}
    509		}
    510		F2FS_OPTION(sbi).compress_level = level;
    511		return 0;
    512	}
    513	#endif
    514	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org