Skip to contentSkip to conversation

f2fs: add F2FS_IOC_GET_COMPRESS_OPTION ioctl

PATCH Superseded Daeho Jeong 2 participants 9 messages Oct 26, 2020 1 message not in the archive F2FS file system

v3 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 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);

---

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 · 1 line
2.29.0.rc1.297.gfa9743e501-goog
#1 lore raw

PATCH v3 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);

---

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

---
 fs/f2fs/compress.c |  5 +++++
 fs/f2fs/f2fs.h     |  7 +++++++
 fs/f2fs/file.c     | 52 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 64 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 +52 -0

70 lines not on this page · raw message

Signature · 1 line
2.29.0.rc1.297.gfa9743e501-goog
#2 lore raw

Re: [PATCH v3 2/2] f2fs: add F2FS_IOC_SET_COMPRESS_OPTION ioctl

Quoted 14 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;

Quoted 7 lines

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

ioctl(fd, F2FS_IOC_SET_COMPRESS_OPTION, &option);

Likewise, please don't add Reviewed-by until it is explicitly given.

The code looks fine now, but this is still missing any explicit mention of documentation, tests, or use cases.

Quoted 2 lines

It's best not to use Reported-by for fixes that get folded in to a patch, since Reported-by makes it seems like the patch itself is a bug fix. I recommend mentioning folded-in fixes informally in the commit message instead, e.g. "Folded in fix for build breakage reported by kernel test robot.".

- Eric

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

#3 lore raw
In reply to Daeho Jeong
Quoted 12 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
};

Quoted 6 lines

struct f2fs_comp_option option;

ioctl(fd, F2FS_IOC_GET_COMPRESS_OPTION, &option);

Please don't add Reviewed-by until it is explicitly given.

The actual code looks fine, but there's still no mention of documentation, tests, or use cases.

- Eric

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

#4 lore raw

I thought I gave the information about that in the commit message. Is this not enough for you?
Actually, there is no space for F2FS ioctl documentation now. :(

2020년 10월 27일 (화) 오전 4:04, Eric Biggers <[email protected]>님이 작성:

Quoted 27 lines · Daeho Jeong
Quoted 12 lines

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
};

Quoted 6 lines

struct f2fs_comp_option option;

ioctl(fd, F2FS_IOC_GET_COMPRESS_OPTION, &option);

Please don't add Reviewed-by until it is explicitly given.

The actual code looks fine, but there's still no mention of documentation, tests, or use cases.

- Eric

#5 lore raw
Quoted 4 lines · Daeho Jeong

I thought I gave the information about that in the commit message. Is this not enough for you?
Actually, there is no space for F2FS ioctl documentation now. :(

The commit message doesn't really matter. What I am asking for are actual documentation and tests.

The fscrypt ioctls, for example, are all documented in Documentation/filesystems/fscrypt.rst, and they have tests in xfstests.

- Eric

#6 lore raw

I checked that. We seem to need to complement missing parts including other ioctls in Documentation/filesystems/fscrypt.rst.

Thanks~

2020년 10월 27일 (화) 오전 8:05, Eric Biggers <[email protected]>님이 작성:

Quoted 14 lines · Daeho Jeong
Quoted 4 lines

I thought I gave the information about that in the commit message. Is this not enough for you?
Actually, there is no space for F2FS ioctl documentation now. :(

The commit message doesn't really matter. What I am asking for are actual documentation and tests.

The fscrypt ioctls, for example, are all documented in Documentation/filesystems/fscrypt.rst, and they have tests in xfstests.

- Eric

#7 lore raw
Quoted 5 lines · Daeho Jeong

I checked that. We seem to need to complement missing parts including other ioctls in Documentation/filesystems/fscrypt.rst.

Thanks~

Well, the f2fs-specific ioctls should probably be documented in Documentation/filesystems/f2fs.rst.

- Eric

A message that is not in the archive (sent off-list or not yet received): CABdZyew=D=S7MmitF55K8Jd6QiVzdJzFuQ2JkJ6x_T_a=AVMvQ@mail.gmail.com

#9 lore raw

Oops, typos...

2020년 10월 27일 (화) 오전 8:43, Daeho Jeong <[email protected]>님이 작성:

Quoted 16 lines

Oops, typos...

Quoted 12 lines · Eric Biggers
Quoted 5 lines · Daeho Jeong

I checked that. We seem to need to complement missing parts including other ioctls in Documentation/filesystems/fscrypt.rst.

Thanks~

Well, the f2fs-specific ioctls should probably be documented in Documentation/filesystems/f2fs.rst.

- Eric