Skip to contentSkip to conversation

f2fs: add F2FS_IOC_GET_COMPRESS_OPTION ioctl

PATCH Superseded Daeho Jeong 3 participants 11 messages Oct 29, 2020 – Oct 30, 2020 F2FS file system

v5 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

PATCH v5 1/2 f2fs: add F2FS_IOC_GET_COMPRESS_OPTION ioctl

From: Daeho Jeong <[email protected]>

Added a new F2FS_IOC_GET_COMPRESS_OPTION ioctl to get file compression option of a file.

struct f2fs_comp_option {
u8 algorithm; => compression algorithm
=> 0:lzo, 1:lz4, 2:zstd, 3:lzorle
u8 log_cluster_size; => log scale cluster size
=> 2 ~ 8
};

struct f2fs_comp_option option;

ioctl(fd, F2FS_IOC_GET_COMPRESS_OPTION, &option);

---

v4: changed commit message.
v3: changed the error number more specific.
v2: added ioctl description.

---
 fs/f2fs/f2fs.h |  7 +++++++
 fs/f2fs/file.c | 30 ++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)
fs/f2fs/f2fs.h +7 -0
index 53fe2853579c..a33c90cf979b 100644
@@ -433,6 +433,8 @@ static inline bool __has_cursum_space(struct f2fs_journal *journal,
 					_IOR(F2FS_IOCTL_MAGIC, 19, __u64)
 #define F2FS_IOC_SEC_TRIM_FILE		_IOW(F2FS_IOCTL_MAGIC, 20,	\
 						struct f2fs_sectrim_range)
+#define F2FS_IOC_GET_COMPRESS_OPTION	_IOR(F2FS_IOCTL_MAGIC, 21,	\
+						struct f2fs_comp_option)
 
 /*
  * should be same as XFS_IOC_GOINGDOWN.
@@ -481,6 +483,11 @@ struct f2fs_sectrim_range {
 	u64 flags;
 };
 
+struct f2fs_comp_option {
+	u8 algorithm;
+	u8 log_cluster_size;
+};
+
 /* for inline stuff */
 #define DEF_INLINE_RESERVED_SIZE	1
 static inline int get_extra_isize(struct inode *inode);
fs/f2fs/file.c +30 -0
index ef5a844de53f..8922ab191a9d 100644
@@ -3936,6 +3936,33 @@ static int f2fs_sec_trim_file(struct file *filp, unsigned long arg)
 	return ret;
 }
 
+static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg)
+{
+	struct inode *inode = file_inode(filp);
+	struct f2fs_comp_option option;
+
+	if (!f2fs_sb_has_compression(F2FS_I_SB(inode)))
+		return -EOPNOTSUPP;
+
+	inode_lock(inode);
+
+	if (!f2fs_compressed_file(inode)) {
+		inode_unlock(inode);
+		return -ENODATA;
+	}
+
+	option.algorithm = F2FS_I(inode)->i_compress_algorithm;
+	option.log_cluster_size = F2FS_I(inode)->i_log_cluster_size;
+
+	inode_unlock(inode);
+
+	if (copy_to_user((struct f2fs_comp_option __user *)arg, &option,
+				sizeof(option)))
+		return -EFAULT;
+
+	return 0;
+}
+
 long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
 {
 	if (unlikely(f2fs_cp_error(F2FS_I_SB(file_inode(filp)))))
@@ -4024,6 +4051,8 @@ long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
 		return f2fs_reserve_compress_blocks(filp, arg);
 	case F2FS_IOC_SEC_TRIM_FILE:
 		return f2fs_sec_trim_file(filp, arg);
+	case F2FS_IOC_GET_COMPRESS_OPTION:
+		return f2fs_ioc_get_compress_option(filp, arg);
 	default:
 		return -ENOTTY;
 	}
@@ -4194,6 +4223,7 @@ long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 	case F2FS_IOC_RELEASE_COMPRESS_BLOCKS:
 	case F2FS_IOC_RESERVE_COMPRESS_BLOCKS:
 	case F2FS_IOC_SEC_TRIM_FILE:
+	case F2FS_IOC_GET_COMPRESS_OPTION:
 		break;
 	default:
 		return -ENOIOCTLCMD;
Signature · 8 lines
2.29.1.341.ge80a0c044ae-goog



_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
#1 lore raw

PATCH v5 2/2 f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

From: Daeho Jeong <[email protected]>

Added a new F2FS_IOC_SET_COMPRESS_OPTION ioctl to change file compression option of a file.

struct f2fs_comp_option {
u8 algorithm; => compression algorithm
=> 0:lzo, 1:lz4, 2:zstd, 3:lzorle
u8 log_cluster_size; => log scale cluster size
=> 2 ~ 8
};

struct f2fs_comp_option option;

option.algorithm = 1;
option.log_cluster_size = 7;

ioctl(fd, F2FS_IOC_SET_COMPRESS_OPTION, &option);

---

v5: allowed to set algorithm which is not currently enabled by kernel
v4: changed commit message.
v3: changed the error number more specific.
folded in fix for build breakage reported by kernel test robot <[email protected]> and Dan Carpenter <[email protected]>.
v2: added ioctl description.

---
 fs/f2fs/compress.c |  5 +++++
 fs/f2fs/f2fs.h     |  7 ++++++
 fs/f2fs/file.c     | 54 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 66 insertions(+)
fs/f2fs/compress.c +5 -0
index 7895186cc765..816d7adc914c 100644
@@ -514,6 +514,11 @@ bool f2fs_is_compress_backend_ready(struct inode *inode)
 	return f2fs_cops[F2FS_I(inode)->i_compress_algorithm];
 }
 
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+	return algorithm < COMPRESS_MAX && f2fs_cops[algorithm] != NULL;
+}
+
 static mempool_t *compress_page_pool;
 static int num_compress_pages = 512;
 module_param(num_compress_pages, uint, 0444);
fs/f2fs/f2fs.h +7 -0
index a33c90cf979b..cc38afde6c04 100644
@@ -435,6 +435,8 @@ static inline bool __has_cursum_space(struct f2fs_journal *journal,
 						struct f2fs_sectrim_range)
 #define F2FS_IOC_GET_COMPRESS_OPTION	_IOR(F2FS_IOCTL_MAGIC, 21,	\
 						struct f2fs_comp_option)
+#define F2FS_IOC_SET_COMPRESS_OPTION	_IOW(F2FS_IOCTL_MAGIC, 22,	\
+						struct f2fs_comp_option)
 
 /*
  * should be same as XFS_IOC_GOINGDOWN.
@@ -3915,6 +3917,7 @@ bool f2fs_compress_write_end(struct inode *inode, void *fsdata,
 int f2fs_truncate_partial_cluster(struct inode *inode, u64 from, bool lock);
 void f2fs_compress_write_end_io(struct bio *bio, struct page *page);
 bool f2fs_is_compress_backend_ready(struct inode *inode);
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm);
 int f2fs_init_compress_mempool(void);
 void f2fs_destroy_compress_mempool(void);
 void f2fs_decompress_pages(struct bio *bio, struct page *page, bool verity);
@@ -3945,6 +3948,10 @@ static inline bool f2fs_is_compress_backend_ready(struct inode *inode)
 	/* not support compression */
 	return false;
 }
+static inline bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+	return false;
+}
 static inline struct page *f2fs_compress_control_page(struct page *page)
 {
 	WARN_ON_ONCE(1);
fs/f2fs/file.c +54 -0

72 lines not on this page · raw message

Signature · 8 lines
2.29.1.341.ge80a0c044ae-goog



_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
#2 lore raw

Re: [f2fs-dev] [PATCH v5 2/2] f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

Quoted 115 lines · Daeho Jeong

From: Daeho Jeong <[email protected]>

Added a new F2FS_IOC_SET_COMPRESS_OPTION ioctl to change file compression option of a file.

struct f2fs_comp_option {
u8 algorithm; => compression algorithm
=> 0:lzo, 1:lz4, 2:zstd, 3:lzorle
u8 log_cluster_size; => log scale cluster size
=> 2 ~ 8
};

struct f2fs_comp_option option;

option.algorithm = 1;
option.log_cluster_size = 7;

ioctl(fd, F2FS_IOC_SET_COMPRESS_OPTION, &option);

---

v5: allowed to set algorithm which is not currently enabled by kernel
v4: changed commit message.
v3: changed the error number more specific.
folded in fix for build breakage reported by kernel test robot <[email protected]> and Dan Carpenter <[email protected]>.
v2: added ioctl description.

---
  fs/f2fs/compress.c |  5 +++++
  fs/f2fs/f2fs.h     |  7 ++++++
  fs/f2fs/file.c     | 54 ++++++++++++++++++++++++++++++++++++++++++++++
  3 files changed, 66 insertions(+)
fs/f2fs/compress.c +5 -0
index 7895186cc765..816d7adc914c 100644
@@ -514,6 +514,11 @@ bool f2fs_is_compress_backend_ready(struct inode *inode)
  	return f2fs_cops[F2FS_I(inode)->i_compress_algorithm];
  }
 
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+	return algorithm < COMPRESS_MAX && f2fs_cops[algorithm] != NULL;
+}
+
  static mempool_t *compress_page_pool;
  static int num_compress_pages = 512;
  module_param(num_compress_pages, uint, 0444);
fs/f2fs/f2fs.h +7 -0
index a33c90cf979b..cc38afde6c04 100644
@@ -435,6 +435,8 @@ static inline bool __has_cursum_space(struct f2fs_journal *journal,
  						struct f2fs_sectrim_range)
  #define F2FS_IOC_GET_COMPRESS_OPTION	_IOR(F2FS_IOCTL_MAGIC, 21,	\
  						struct f2fs_comp_option)
+#define F2FS_IOC_SET_COMPRESS_OPTION	_IOW(F2FS_IOCTL_MAGIC, 22,	\
+						struct f2fs_comp_option)
 
  /*
   * should be same as XFS_IOC_GOINGDOWN.
@@ -3915,6 +3917,7 @@ bool f2fs_compress_write_end(struct inode *inode, void *fsdata,
  int f2fs_truncate_partial_cluster(struct inode *inode, u64 from, bool lock);
  void f2fs_compress_write_end_io(struct bio *bio, struct page *page);
  bool f2fs_is_compress_backend_ready(struct inode *inode);
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm);
  int f2fs_init_compress_mempool(void);
  void f2fs_destroy_compress_mempool(void);
  void f2fs_decompress_pages(struct bio *bio, struct page *page, bool verity);
@@ -3945,6 +3948,10 @@ static inline bool f2fs_is_compress_backend_ready(struct inode *inode)
  	/* not support compression */
  	return false;
  }
+static inline bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+	return false;
+}
  static inline struct page *f2fs_compress_control_page(struct page *page)
  {
  	WARN_ON_ONCE(1);
fs/f2fs/file.c +25 -0
index 8922ab191a9d..a0f31d8ebcfd 100644
@@ -3963,6 +3963,57 @@ static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg)
  	return 0;
  }
 
+static int f2fs_ioc_set_compress_option(struct file *filp, unsigned long arg)
+{
+	struct inode *inode = file_inode(filp);
+	struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
+	struct f2fs_comp_option option;
+	int ret = 0;
+
+	if (!f2fs_sb_has_compression(sbi))
+		return -EOPNOTSUPP;
+
+	if (!(filp->f_mode & FMODE_WRITE))
+		return -EBADF;
+
+	if (copy_from_user(&option, (struct f2fs_comp_option __user *)arg,
+				sizeof(option)))
+		return -EFAULT;
+
+	if (!f2fs_compressed_file(inode) ||
+			option.log_cluster_size < MIN_COMPRESS_LOG_SIZE ||
+			option.log_cluster_size > MAX_COMPRESS_LOG_SIZE ||
+			option.algorithm >= COMPRESS_MAX)
+		return -EINVAL;
+
+	file_start_write(filp);
+	inode_lock(inode);

fs/f2fs/file.c static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg) · line 4000

Quoted 10 lines
fs/f2fs/file.c +10 -0
+
+	if (f2fs_is_mmap_file(inode) || get_dirty_pages(inode)) {
+		ret = -EBUSY;
+		goto out;
+	}
+
+	if (inode->i_size != 0) {
+		ret = -EFBIG;
+		goto out;
+	}

Hmm...

Shouldn't it be:

if (algorithm >= COMPRESS_MAX) {
	ret = -ENOPKG;
	goto out;
}

if (!f2fs_cops[algorithm])

	f2fs_warn(...);
Quoted 30 lines
fs/f2fs/file.c +18 -0
+
+	F2FS_I(inode)->i_compress_algorithm = option.algorithm;
+	F2FS_I(inode)->i_log_cluster_size = option.log_cluster_size;
+	F2FS_I(inode)->i_cluster_size = 1 << option.log_cluster_size;
+	f2fs_mark_inode_dirty_sync(inode, true);
+
+	if (!f2fs_is_compress_algorithm_ready(option.algorithm))
+		f2fs_warn(sbi, "compression algorithm is successfully set, "
+			"but current kernel doesn't support this algorithm.");
+out:
+	inode_unlock(inode);
+	file_end_write(filp);
+
+	return ret;
+}
+
  long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
  {
  	if (unlikely(f2fs_cp_error(F2FS_I_SB(file_inode(filp)))))
@@ -4053,6 +4104,8 @@ long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
  		return f2fs_sec_trim_file(filp, arg);
  	case F2FS_IOC_GET_COMPRESS_OPTION:
  		return f2fs_ioc_get_compress_option(filp, arg);
+	case F2FS_IOC_SET_COMPRESS_OPTION:
+		return f2fs_ioc_set_compress_option(filp, arg);
  	default:
  		return -ENOTTY;
  	}

fs/f2fs/file.c long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg) · line 4283

Quoted 7 lines
fs/f2fs/file.c +1 -0
@@ -4224,6 +4277,7 @@ long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
  	case F2FS_IOC_RESERVE_COMPRESS_BLOCKS:
  	case F2FS_IOC_SEC_TRIM_FILE:
  	case F2FS_IOC_GET_COMPRESS_OPTION:
+	case F2FS_IOC_SET_COMPRESS_OPTION:
  		break;
  	default:
  		return -ENOIOCTLCMD;

_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel

#3 lore raw

Re: [f2fs-dev] [PATCH v5 2/2] f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

f2fs_cops is a static variable. Do you wanna change this to global variable (extern)?

2020년 10월 29일 (목) 오후 4:29, Chao Yu <[email protected]>님이 작성:

Quoted 169 lines · Daeho Jeong
Quoted 115 lines

From: Daeho Jeong <[email protected]>

Added a new F2FS_IOC_SET_COMPRESS_OPTION ioctl to change file compression option of a file.

struct f2fs_comp_option {
u8 algorithm; => compression algorithm
=> 0:lzo, 1:lz4, 2:zstd, 3:lzorle
u8 log_cluster_size; => log scale cluster size
=> 2 ~ 8
};

struct f2fs_comp_option option;

option.algorithm = 1;
option.log_cluster_size = 7;

ioctl(fd, F2FS_IOC_SET_COMPRESS_OPTION, &option);

---

v5: allowed to set algorithm which is not currently enabled by kernel
v4: changed commit message.
v3: changed the error number more specific.
folded in fix for build breakage reported by kernel test robot <[email protected]> and Dan Carpenter <[email protected]>.
v2: added ioctl description.

---
  fs/f2fs/compress.c |  5 +++++
  fs/f2fs/f2fs.h     |  7 ++++++
  fs/f2fs/file.c     | 54 ++++++++++++++++++++++++++++++++++++++++++++++
  3 files changed, 66 insertions(+)
fs/f2fs/compress.c +5 -0
index 7895186cc765..816d7adc914c 100644
@@ -514,6 +514,11 @@ bool f2fs_is_compress_backend_ready(struct inode *inode)
      return f2fs_cops[F2FS_I(inode)->i_compress_algorithm];
  }
 
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+     return algorithm < COMPRESS_MAX && f2fs_cops[algorithm] != NULL;
+}
+
  static mempool_t *compress_page_pool;
  static int num_compress_pages = 512;
  module_param(num_compress_pages, uint, 0444);
fs/f2fs/f2fs.h +7 -0
index a33c90cf979b..cc38afde6c04 100644
@@ -435,6 +435,8 @@ static inline bool __has_cursum_space(struct f2fs_journal *journal,
                                              struct f2fs_sectrim_range)
  #define F2FS_IOC_GET_COMPRESS_OPTION        _IOR(F2FS_IOCTL_MAGIC, 21,      \
                                              struct f2fs_comp_option)
+#define F2FS_IOC_SET_COMPRESS_OPTION _IOW(F2FS_IOCTL_MAGIC, 22,      \
+                                             struct f2fs_comp_option)
 
  /*
   * should be same as XFS_IOC_GOINGDOWN.
@@ -3915,6 +3917,7 @@ bool f2fs_compress_write_end(struct inode *inode, void *fsdata,
  int f2fs_truncate_partial_cluster(struct inode *inode, u64 from, bool lock);
  void f2fs_compress_write_end_io(struct bio *bio, struct page *page);
  bool f2fs_is_compress_backend_ready(struct inode *inode);
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm);
  int f2fs_init_compress_mempool(void);
  void f2fs_destroy_compress_mempool(void);
  void f2fs_decompress_pages(struct bio *bio, struct page *page, bool verity);
@@ -3945,6 +3948,10 @@ static inline bool f2fs_is_compress_backend_ready(struct inode *inode)
      /* not support compression */
      return false;
  }
+static inline bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+     return false;
+}
  static inline struct page *f2fs_compress_control_page(struct page *page)
  {
      WARN_ON_ONCE(1);
fs/f2fs/file.c +25 -0
index 8922ab191a9d..a0f31d8ebcfd 100644
@@ -3963,6 +3963,57 @@ static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg)
      return 0;
  }
 
+static int f2fs_ioc_set_compress_option(struct file *filp, unsigned long arg)
+{
+     struct inode *inode = file_inode(filp);
+     struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
+     struct f2fs_comp_option option;
+     int ret = 0;
+
+     if (!f2fs_sb_has_compression(sbi))
+             return -EOPNOTSUPP;
+
+     if (!(filp->f_mode & FMODE_WRITE))
+             return -EBADF;
+
+     if (copy_from_user(&option, (struct f2fs_comp_option __user *)arg,
+                             sizeof(option)))
+             return -EFAULT;
+
+     if (!f2fs_compressed_file(inode) ||
+                     option.log_cluster_size < MIN_COMPRESS_LOG_SIZE ||
+                     option.log_cluster_size > MAX_COMPRESS_LOG_SIZE ||
+                     option.algorithm >= COMPRESS_MAX)
+             return -EINVAL;
+
+     file_start_write(filp);
+     inode_lock(inode);

fs/f2fs/file.c static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg) · line 4000

Quoted 10 lines
fs/f2fs/file.c +10 -0
+
+     if (f2fs_is_mmap_file(inode) || get_dirty_pages(inode)) {
+             ret = -EBUSY;
+             goto out;
+     }
+
+     if (inode->i_size != 0) {
+             ret = -EFBIG;
+             goto out;
+     }

Hmm...

Shouldn't it be:

if (algorithm >= COMPRESS_MAX) {
        ret = -ENOPKG;
        goto out;
}

if (!f2fs_cops[algorithm])

        f2fs_warn(...);
Quoted 29 lines
fs/f2fs/file.c +18 -0
+
+     F2FS_I(inode)->i_compress_algorithm = option.algorithm;
+     F2FS_I(inode)->i_log_cluster_size = option.log_cluster_size;
+     F2FS_I(inode)->i_cluster_size = 1 << option.log_cluster_size;
+     f2fs_mark_inode_dirty_sync(inode, true);
+
+     if (!f2fs_is_compress_algorithm_ready(option.algorithm))
+             f2fs_warn(sbi, "compression algorithm is successfully set, "
+                     "but current kernel doesn't support this algorithm.");
+out:
+     inode_unlock(inode);
+     file_end_write(filp);
+
+     return ret;
+}
+
  long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
  {
      if (unlikely(f2fs_cp_error(F2FS_I_SB(file_inode(filp)))))
@@ -4053,6 +4104,8 @@ long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
              return f2fs_sec_trim_file(filp, arg);
      case F2FS_IOC_GET_COMPRESS_OPTION:
              return f2fs_ioc_get_compress_option(filp, arg);
+     case F2FS_IOC_SET_COMPRESS_OPTION:
+             return f2fs_ioc_set_compress_option(filp, arg);
      default:
              return -ENOTTY;
      }
@@ -4224,6 +4277,7 @@ long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Quoted 8 lines

fs/f2fs/file.c long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg) · line 4283

Quoted 8 lines
fs/f2fs/file.c +1 -0
      case F2FS_IOC_RESERVE_COMPRESS_BLOCKS:
      case F2FS_IOC_SEC_TRIM_FILE:
      case F2FS_IOC_GET_COMPRESS_OPTION:
+     case F2FS_IOC_SET_COMPRESS_OPTION:
              break;
      default:
              return -ENOIOCTLCMD;

_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel

#4 lore raw

Re: [f2fs-dev] [PATCH v5 2/2] f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

Quoted 2 lines · Daeho Jeong

f2fs_cops is a static variable. Do you wanna change this to global variable (extern)?

Oh, no, how about updating f2fs_is_compress_algorithm_ready() as below? and use this function in f2fs_ioc_set_compress_option().

bool f2fs_is_compress_algorithm_valid(unsigned char algorithm)

{
	return f2fs_cops[algorithm];
}
Quoted 172 lines

2020년 10월 29일 (목) 오후 4:29, Chao Yu <[email protected]>님이 작성:

Quoted 170 lines · Daeho Jeong
Quoted 115 lines

From: Daeho Jeong <[email protected]>

Added a new F2FS_IOC_SET_COMPRESS_OPTION ioctl to change file compression option of a file.

struct f2fs_comp_option {
u8 algorithm; => compression algorithm
=> 0:lzo, 1:lz4, 2:zstd, 3:lzorle
u8 log_cluster_size; => log scale cluster size
=> 2 ~ 8
};

struct f2fs_comp_option option;

option.algorithm = 1;
option.log_cluster_size = 7;

ioctl(fd, F2FS_IOC_SET_COMPRESS_OPTION, &option);

---

v5: allowed to set algorithm which is not currently enabled by kernel
v4: changed commit message.
v3: changed the error number more specific.
folded in fix for build breakage reported by kernel test robot <[email protected]> and Dan Carpenter <[email protected]>.
v2: added ioctl description.

---
   fs/f2fs/compress.c |  5 +++++
   fs/f2fs/f2fs.h     |  7 ++++++
   fs/f2fs/file.c     | 54 ++++++++++++++++++++++++++++++++++++++++++++++
   3 files changed, 66 insertions(+)
fs/f2fs/compress.c +5 -0
index 7895186cc765..816d7adc914c 100644
@@ -514,6 +514,11 @@ bool f2fs_is_compress_backend_ready(struct inode *inode)
       return f2fs_cops[F2FS_I(inode)->i_compress_algorithm];
   }
 
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+     return algorithm < COMPRESS_MAX && f2fs_cops[algorithm] != NULL;
+}
+
   static mempool_t *compress_page_pool;
   static int num_compress_pages = 512;
   module_param(num_compress_pages, uint, 0444);
fs/f2fs/f2fs.h +7 -0
index a33c90cf979b..cc38afde6c04 100644
@@ -435,6 +435,8 @@ static inline bool __has_cursum_space(struct f2fs_journal *journal,
                                               struct f2fs_sectrim_range)
   #define F2FS_IOC_GET_COMPRESS_OPTION        _IOR(F2FS_IOCTL_MAGIC, 21,      \
                                               struct f2fs_comp_option)
+#define F2FS_IOC_SET_COMPRESS_OPTION _IOW(F2FS_IOCTL_MAGIC, 22,      \
+                                             struct f2fs_comp_option)
 
   /*
    * should be same as XFS_IOC_GOINGDOWN.
@@ -3915,6 +3917,7 @@ bool f2fs_compress_write_end(struct inode *inode, void *fsdata,
   int f2fs_truncate_partial_cluster(struct inode *inode, u64 from, bool lock);
   void f2fs_compress_write_end_io(struct bio *bio, struct page *page);
   bool f2fs_is_compress_backend_ready(struct inode *inode);
+bool f2fs_is_compress_algorithm_ready(unsigned char algorithm);
   int f2fs_init_compress_mempool(void);
   void f2fs_destroy_compress_mempool(void);
   void f2fs_decompress_pages(struct bio *bio, struct page *page, bool verity);
@@ -3945,6 +3948,10 @@ static inline bool f2fs_is_compress_backend_ready(struct inode *inode)
       /* not support compression */
       return false;
   }
+static inline bool f2fs_is_compress_algorithm_ready(unsigned char algorithm)
+{
+     return false;
+}
   static inline struct page *f2fs_compress_control_page(struct page *page)
   {
       WARN_ON_ONCE(1);
fs/f2fs/file.c +25 -0
index 8922ab191a9d..a0f31d8ebcfd 100644
@@ -3963,6 +3963,57 @@ static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg)
       return 0;
   }
 
+static int f2fs_ioc_set_compress_option(struct file *filp, unsigned long arg)
+{
+     struct inode *inode = file_inode(filp);
+     struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
+     struct f2fs_comp_option option;
+     int ret = 0;
+
+     if (!f2fs_sb_has_compression(sbi))
+             return -EOPNOTSUPP;
+
+     if (!(filp->f_mode & FMODE_WRITE))
+             return -EBADF;
+
+     if (copy_from_user(&option, (struct f2fs_comp_option __user *)arg,
+                             sizeof(option)))
+             return -EFAULT;
+
+     if (!f2fs_compressed_file(inode) ||
+                     option.log_cluster_size < MIN_COMPRESS_LOG_SIZE ||
+                     option.log_cluster_size > MAX_COMPRESS_LOG_SIZE ||
+                     option.algorithm >= COMPRESS_MAX)
+             return -EINVAL;
+
+     file_start_write(filp);
+     inode_lock(inode);

fs/f2fs/file.c static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg) · line 4000

Quoted 10 lines
fs/f2fs/file.c +10 -0
+
+     if (f2fs_is_mmap_file(inode) || get_dirty_pages(inode)) {
+             ret = -EBUSY;
+             goto out;
+     }
+
+     if (inode->i_size != 0) {
+             ret = -EFBIG;
+             goto out;
+     }

Hmm...

Shouldn't it be:

if (algorithm >= COMPRESS_MAX) {
         ret = -ENOPKG;
         goto out;
}

if (!f2fs_cops[algorithm])

         f2fs_warn(...);
Quoted 30 lines
fs/f2fs/file.c +18 -0
+
+     F2FS_I(inode)->i_compress_algorithm = option.algorithm;
+     F2FS_I(inode)->i_log_cluster_size = option.log_cluster_size;
+     F2FS_I(inode)->i_cluster_size = 1 << option.log_cluster_size;
+     f2fs_mark_inode_dirty_sync(inode, true);
+
+     if (!f2fs_is_compress_algorithm_ready(option.algorithm))
+             f2fs_warn(sbi, "compression algorithm is successfully set, "
+                     "but current kernel doesn't support this algorithm.");
+out:
+     inode_unlock(inode);
+     file_end_write(filp);
+
+     return ret;
+}
+
   long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
   {
       if (unlikely(f2fs_cp_error(F2FS_I_SB(file_inode(filp)))))
@@ -4053,6 +4104,8 @@ long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
               return f2fs_sec_trim_file(filp, arg);
       case F2FS_IOC_GET_COMPRESS_OPTION:
               return f2fs_ioc_get_compress_option(filp, arg);
+     case F2FS_IOC_SET_COMPRESS_OPTION:
+             return f2fs_ioc_set_compress_option(filp, arg);
       default:
               return -ENOTTY;
       }
@@ -4224,6 +4277,7 @@ long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
       case F2FS_IOC_RESERVE_COMPRESS_BLOCKS:
Quoted 9 lines
Quoted 7 lines

fs/f2fs/file.c long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg) · line 4283

Quoted 7 lines
fs/f2fs/file.c +1 -0
       case F2FS_IOC_SEC_TRIM_FILE:
       case F2FS_IOC_GET_COMPRESS_OPTION:
+     case F2FS_IOC_SET_COMPRESS_OPTION:
               break;
       default:
               return -ENOIOCTLCMD;

.

_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel

#5 lore raw

Re: [f2fs-dev] [PATCH v5 2/2] f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

In reply to Chao Yu
Quoted 40 lines · Chao Yu
Quoted 25 lines
fs/f2fs/file.c +25 -0
+static int f2fs_ioc_set_compress_option(struct file *filp, unsigned long arg)
+{
+	struct inode *inode = file_inode(filp);
+	struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
+	struct f2fs_comp_option option;
+	int ret = 0;
+
+	if (!f2fs_sb_has_compression(sbi))
+		return -EOPNOTSUPP;
+
+	if (!(filp->f_mode & FMODE_WRITE))
+		return -EBADF;
+
+	if (copy_from_user(&option, (struct f2fs_comp_option __user *)arg,
+				sizeof(option)))
+		return -EFAULT;
+
+	if (!f2fs_compressed_file(inode) ||
+			option.log_cluster_size < MIN_COMPRESS_LOG_SIZE ||
+			option.log_cluster_size > MAX_COMPRESS_LOG_SIZE ||
+			option.algorithm >= COMPRESS_MAX)
+		return -EINVAL;
+
+	file_start_write(filp);
+	inode_lock(inode);

fs/f2fs/file.c static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg) · line 4000

Quoted 10 lines
fs/f2fs/file.c +10 -0
+
+	if (f2fs_is_mmap_file(inode) || get_dirty_pages(inode)) {
+		ret = -EBUSY;
+		goto out;
+	}
+
+	if (inode->i_size != 0) {
+		ret = -EFBIG;
+		goto out;
+	}

Hmm...

Shouldn't it be:

Quoted 7 lines
if (algorithm >= COMPRESS_MAX) {
	ret = -ENOPKG;
	goto out;
}

if (!f2fs_cops[algorithm])

	f2fs_warn(...);

Note that my intent with recommending ENOPKG was for it to be returned in the !f2fs_cops[algorithm] case, similar to how opening an encrypted file when the encryption algorithm is recognized but not supported by the kernel returns ENOPKG. For a truly unrecognized algorithm (algorithm >= COMPRESS_MAX), EINVAL would probably be more appropriate. So if !f2fs_cops[algorithm] is now allowed, then ENOPKG should no longer be among the error codes this ioctl returns.

- Eric

#6 lore raw

Re: [f2fs-dev] [PATCH v5 2/2] f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

Chao, got it on f2fs_is_compress_algorithm_valid(). I also agree on Eric's opinion on that error value.

2020년 10월 30일 (금) 오전 12:54, Eric Biggers <[email protected]>님이 작성:

Quoted 58 lines · Chao Yu
Quoted 40 lines
Quoted 25 lines
fs/f2fs/file.c +25 -0
+static int f2fs_ioc_set_compress_option(struct file *filp, unsigned long arg)
+{
+   struct inode *inode = file_inode(filp);
+   struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
+   struct f2fs_comp_option option;
+   int ret = 0;
+
+   if (!f2fs_sb_has_compression(sbi))
+           return -EOPNOTSUPP;
+
+   if (!(filp->f_mode & FMODE_WRITE))
+           return -EBADF;
+
+   if (copy_from_user(&option, (struct f2fs_comp_option __user *)arg,
+                           sizeof(option)))
+           return -EFAULT;
+
+   if (!f2fs_compressed_file(inode) ||
+                   option.log_cluster_size < MIN_COMPRESS_LOG_SIZE ||
+                   option.log_cluster_size > MAX_COMPRESS_LOG_SIZE ||
+                   option.algorithm >= COMPRESS_MAX)
+           return -EINVAL;
+
+   file_start_write(filp);
+   inode_lock(inode);

fs/f2fs/file.c static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg) · line 4000

Quoted 10 lines
fs/f2fs/file.c +10 -0
+
+   if (f2fs_is_mmap_file(inode) || get_dirty_pages(inode)) {
+           ret = -EBUSY;
+           goto out;
+   }
+
+   if (inode->i_size != 0) {
+           ret = -EFBIG;
+           goto out;
+   }

Hmm...

Shouldn't it be:

Quoted 7 lines
if (algorithm >= COMPRESS_MAX) {
      ret = -ENOPKG;
      goto out;
}

if (!f2fs_cops[algorithm])

      f2fs_warn(...);

Note that my intent with recommending ENOPKG was for it to be returned in the !f2fs_cops[algorithm] case, similar to how opening an encrypted file when the encryption algorithm is recognized but not supported by the kernel returns ENOPKG. For a truly unrecognized algorithm (algorithm >= COMPRESS_MAX), EINVAL would probably be more appropriate. So if !f2fs_cops[algorithm] is now allowed, then ENOPKG should no longer be among the error codes this ioctl returns.

- Eric

#7 lore raw

Re: [f2fs-dev] [PATCH v5 2/2] f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

In reply to Eric Biggers
Quoted 6 lines · Eric Biggers

Note that my intent with recommending ENOPKG was for it to be returned in the !f2fs_cops[algorithm] case, similar to how opening an encrypted file when the encryption algorithm is recognized but not supported by the kernel returns ENOPKG. For a truly unrecognized algorithm (algorithm >= COMPRESS_MAX), EINVAL would probably be more appropriate. So if !f2fs_cops[algorithm] is now allowed, then ENOPKG should no longer be among the error codes this ioctl returns.

Agreed.

Thanks,

Quoted 4 lines

- Eric
.

#8 lore raw
In reply to Daeho Jeong
Quoted 59 lines · Daeho Jeong

From: Daeho Jeong <[email protected]>

Added a new F2FS_IOC_GET_COMPRESS_OPTION ioctl to get file compression option of a file.

struct f2fs_comp_option {
u8 algorithm; => compression algorithm
=> 0:lzo, 1:lz4, 2:zstd, 3:lzorle
u8 log_cluster_size; => log scale cluster size
=> 2 ~ 8
};

struct f2fs_comp_option option;

ioctl(fd, F2FS_IOC_GET_COMPRESS_OPTION, &option);

---

v4: changed commit message.
v3: changed the error number more specific.
v2: added ioctl description.

---
  fs/f2fs/f2fs.h |  7 +++++++
  fs/f2fs/file.c | 30 ++++++++++++++++++++++++++++++
  2 files changed, 37 insertions(+)
fs/f2fs/f2fs.h +7 -0
index 53fe2853579c..a33c90cf979b 100644
@@ -433,6 +433,8 @@ static inline bool __has_cursum_space(struct f2fs_journal *journal,
  					_IOR(F2FS_IOCTL_MAGIC, 19, __u64)
  #define F2FS_IOC_SEC_TRIM_FILE		_IOW(F2FS_IOCTL_MAGIC, 20,	\
  						struct f2fs_sectrim_range)
+#define F2FS_IOC_GET_COMPRESS_OPTION	_IOR(F2FS_IOCTL_MAGIC, 21,	\
+						struct f2fs_comp_option)
 
  /*
   * should be same as XFS_IOC_GOINGDOWN.
@@ -481,6 +483,11 @@ struct f2fs_sectrim_range {
  	u64 flags;
  };
 
+struct f2fs_comp_option {
+	u8 algorithm;
+	u8 log_cluster_size;
+};
+
  /* for inline stuff */
  #define DEF_INLINE_RESERVED_SIZE	1
  static inline int get_extra_isize(struct inode *inode);
fs/f2fs/file.c +0 -0
index ef5a844de53f..8922ab191a9d 100644
@@ -3936,6 +3936,33 @@ static int f2fs_sec_trim_file(struct file *filp, unsigned long arg)
  	return ret;
  }

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3947

Quoted 10 lines
fs/f2fs/file.c +9 -0
 
+static int f2fs_ioc_get_compress_option(struct file *filp, unsigned long arg)
+{
+	struct inode *inode = file_inode(filp);
+	struct f2fs_comp_option option;
+
+	if (!f2fs_sb_has_compression(F2FS_I_SB(inode)))
+		return -EOPNOTSUPP;
+
+	inode_lock(inode);

It's minor,

inode_lock_shared()?

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3950

Quoted 3 lines
fs/f2fs/file.c +3 -0
+
+	if (!f2fs_compressed_file(inode)) {
+		inode_unlock(inode);

inode_unlock_shared()?

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3957

Quoted 7 lines
fs/f2fs/file.c +7 -0
+		return -ENODATA;
+	}
+
+	option.algorithm = F2FS_I(inode)->i_compress_algorithm;
+	option.log_cluster_size = F2FS_I(inode)->i_log_cluster_size;
+
+	inode_unlock(inode);

ditto.

Quoted 22 lines
fs/f2fs/file.c +10 -0
+
+	if (copy_to_user((struct f2fs_comp_option __user *)arg, &option,
+				sizeof(option)))
+		return -EFAULT;
+
+	return 0;
+}
+
  long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
  {
  	if (unlikely(f2fs_cp_error(F2FS_I_SB(file_inode(filp)))))
@@ -4024,6 +4051,8 @@ long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
  		return f2fs_reserve_compress_blocks(filp, arg);
  	case F2FS_IOC_SEC_TRIM_FILE:
  		return f2fs_sec_trim_file(filp, arg);
+	case F2FS_IOC_GET_COMPRESS_OPTION:
+		return f2fs_ioc_get_compress_option(filp, arg);
  	default:
  		return -ENOTTY;
  	}

fs/f2fs/file.c long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg) · line 4229

Quoted 7 lines
fs/f2fs/file.c +1 -0
@@ -4194,6 +4223,7 @@ long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
  	case F2FS_IOC_RELEASE_COMPRESS_BLOCKS:
  	case F2FS_IOC_RESERVE_COMPRESS_BLOCKS:
  	case F2FS_IOC_SEC_TRIM_FILE:
+	case F2FS_IOC_GET_COMPRESS_OPTION:
  		break;
  	default:
  		return -ENOIOCTLCMD;

_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel

#9 lore raw
Quoted 14 lines · Chao Yu

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3947

Quoted 1 line · Daeho Jeong
fs/f2fs/file.c +1 -0
+	inode_lock(inode);

It's minor,

inode_lock_shared()?

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3950

Quoted 3 lines
fs/f2fs/file.c +3 -0
+
+	if (!f2fs_compressed_file(inode)) {
+		inode_unlock(inode);

inode_unlock_shared()?

Quoted 9 lines

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3957

Quoted 7 lines
fs/f2fs/file.c +7 -0
+		return -ENODATA;
+	}
+
+	option.algorithm = F2FS_I(inode)->i_compress_algorithm;
+	option.log_cluster_size = F2FS_I(inode)->i_log_cluster_size;
+
+	inode_unlock(inode);

ditto.

Any comments?

Thanks,

#10 lore raw

Opps, I missed this.
We need v7... lol

2020년 10월 30일 (금) 오전 11:37, Chao Yu <[email protected]>님이 작성:

Quoted 29 lines · Chao Yu
Quoted 14 lines · Daeho Jeong
Quoted 2 lines

+ inode_lock(inode);

It's minor,

inode_lock_shared()?

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3950

Quoted 3 lines
fs/f2fs/file.c +3 -0
+
+    if (!f2fs_compressed_file(inode)) {
+            inode_unlock(inode);

inode_unlock_shared()?

Quoted 9 lines

fs/f2fs/file.c static int f2fs_sec_trim_file(struct file *filp, unsigned long arg) · line 3957

Quoted 7 lines
fs/f2fs/file.c +7 -0
+            return -ENODATA;
+    }
+
+    option.algorithm = F2FS_I(inode)->i_compress_algorithm;
+    option.log_cluster_size = F2FS_I(inode)->i_log_cluster_size;
+
+    inode_unlock(inode);

ditto.

Any comments?

Thanks,