xref: /linux/include/uapi/linux/f2fs.h (revision 49bda4826843be0ef97a162009a29ea3a63f3935)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 
3 #ifndef _UAPI_LINUX_F2FS_H
4 #define _UAPI_LINUX_F2FS_H
5 #include <linux/types.h>
6 #include <linux/ioctl.h>
7 
8 /*
9  * f2fs-specific ioctl commands
10  */
11 #define F2FS_IOCTL_MAGIC		0xf5
12 #define F2FS_IOC_START_ATOMIC_WRITE	_IO(F2FS_IOCTL_MAGIC, 1)
13 #define F2FS_IOC_COMMIT_ATOMIC_WRITE	_IO(F2FS_IOCTL_MAGIC, 2)
14 #define F2FS_IOC_START_VOLATILE_WRITE	_IO(F2FS_IOCTL_MAGIC, 3)
15 #define F2FS_IOC_RELEASE_VOLATILE_WRITE	_IO(F2FS_IOCTL_MAGIC, 4)
16 #define F2FS_IOC_ABORT_ATOMIC_WRITE	_IO(F2FS_IOCTL_MAGIC, 5)
17 #define F2FS_IOC_GARBAGE_COLLECT	_IOW(F2FS_IOCTL_MAGIC, 6, __u32)
18 #define F2FS_IOC_WRITE_CHECKPOINT	_IO(F2FS_IOCTL_MAGIC, 7)
19 #define F2FS_IOC_DEFRAGMENT		_IOWR(F2FS_IOCTL_MAGIC, 8,	\
20 						struct f2fs_defragment)
21 #define F2FS_IOC_MOVE_RANGE		_IOWR(F2FS_IOCTL_MAGIC, 9,	\
22 						struct f2fs_move_range)
23 #define F2FS_IOC_FLUSH_DEVICE		_IOW(F2FS_IOCTL_MAGIC, 10,	\
24 						struct f2fs_flush_device)
25 #define F2FS_IOC_GARBAGE_COLLECT_RANGE	_IOW(F2FS_IOCTL_MAGIC, 11,	\
26 						struct f2fs_gc_range)
27 #define F2FS_IOC_GET_FEATURES		_IOR(F2FS_IOCTL_MAGIC, 12, __u32)
28 #define F2FS_IOC_SET_PIN_FILE		_IOW(F2FS_IOCTL_MAGIC, 13, __u32)
29 #define F2FS_IOC_GET_PIN_FILE		_IOR(F2FS_IOCTL_MAGIC, 14, __u32)
30 #define F2FS_IOC_PRECACHE_EXTENTS	_IO(F2FS_IOCTL_MAGIC, 15)
31 #define F2FS_IOC_RESIZE_FS		_IOW(F2FS_IOCTL_MAGIC, 16, __u64)
32 #define F2FS_IOC_GET_COMPRESS_BLOCKS	_IOR(F2FS_IOCTL_MAGIC, 17, __u64)
33 #define F2FS_IOC_RELEASE_COMPRESS_BLOCKS				\
34 					_IOR(F2FS_IOCTL_MAGIC, 18, __u64)
35 #define F2FS_IOC_RESERVE_COMPRESS_BLOCKS				\
36 					_IOR(F2FS_IOCTL_MAGIC, 19, __u64)
37 #define F2FS_IOC_SEC_TRIM_FILE		_IOW(F2FS_IOCTL_MAGIC, 20,	\
38 						struct f2fs_sectrim_range)
39 #define F2FS_IOC_GET_COMPRESS_OPTION	_IOR(F2FS_IOCTL_MAGIC, 21,	\
40 						struct f2fs_comp_option)
41 #define F2FS_IOC_SET_COMPRESS_OPTION	_IOW(F2FS_IOCTL_MAGIC, 22,	\
42 						struct f2fs_comp_option)
43 #define F2FS_IOC_DECOMPRESS_FILE	_IO(F2FS_IOCTL_MAGIC, 23)
44 #define F2FS_IOC_COMPRESS_FILE		_IO(F2FS_IOCTL_MAGIC, 24)
45 #define F2FS_IOC_START_ATOMIC_REPLACE	_IO(F2FS_IOCTL_MAGIC, 25)
46 #define F2FS_IOC_GET_DEV_ALIAS_FILE	_IOR(F2FS_IOCTL_MAGIC, 26, __u32)
47 #define F2FS_IOC_IO_PRIO		_IOW(F2FS_IOCTL_MAGIC, 27, __u32)
48 #define F2FS_IOC_RESERVE_DEV_ALIAS	_IO(F2FS_IOCTL_MAGIC, 28)
49 #define F2FS_IOC_RELEASE_DEV_ALIAS	_IO(F2FS_IOCTL_MAGIC, 29)
50 #define F2FS_IOC_GET_DEV_ALIAS_STATUS	_IOR(F2FS_IOCTL_MAGIC, 30, __u32)
51 
52 /*
53  * should be same as XFS_IOC_GOINGDOWN.
54  * Flags for going down operation used by FS_IOC_GOINGDOWN
55  */
56 #define F2FS_IOC_SHUTDOWN	_IOR('X', 125, __u32)	/* Shutdown */
57 #define F2FS_GOING_DOWN_FULLSYNC	0x0	/* going down with full sync */
58 #define F2FS_GOING_DOWN_METASYNC	0x1	/* going down with metadata */
59 #define F2FS_GOING_DOWN_NOSYNC		0x2	/* going down */
60 #define F2FS_GOING_DOWN_METAFLUSH	0x3	/* going down with meta flush */
61 #define F2FS_GOING_DOWN_NEED_FSCK	0x4	/* going down to trigger fsck */
62 
63 /*
64  * Flags used by F2FS_IOC_SEC_TRIM_FILE
65  */
66 #define F2FS_TRIM_FILE_DISCARD		0x1	/* send discard command */
67 #define F2FS_TRIM_FILE_ZEROOUT		0x2	/* zero out */
68 #define F2FS_TRIM_FILE_MASK		0x3
69 
70 /* for F2FS_IOC_IO_PRIO */
71 enum {
72 	F2FS_IOPRIO_WRITE = 1,	/* high write priority */
73 	F2FS_IOPRIO_MAX,
74 };
75 
76 /* for F2FS_IOC_GET_DEV_ALIAS_STATUS */
77 #define F2FS_DEV_ALIAS_STATUS_RELEASED	0
78 #define F2FS_DEV_ALIAS_STATUS_RESERVED	1
79 
80 struct f2fs_gc_range {
81 	__u32 sync;
82 	__u64 start;
83 	__u64 len;
84 };
85 
86 struct f2fs_defragment {
87 	__u64 start;
88 	__u64 len;
89 };
90 
91 struct f2fs_move_range {
92 	__u32 dst_fd;		/* destination fd */
93 	__u64 pos_in;		/* start position in src_fd */
94 	__u64 pos_out;		/* start position in dst_fd */
95 	__u64 len;		/* size to move */
96 };
97 
98 struct f2fs_flush_device {
99 	__u32 dev_num;		/* device number to flush */
100 	__u32 segments;		/* # of segments to flush */
101 };
102 
103 struct f2fs_sectrim_range {
104 	__u64 start;
105 	__u64 len;
106 	__u64 flags;
107 };
108 
109 struct f2fs_comp_option {
110 	__u8 algorithm;
111 	__u8 log_cluster_size;
112 };
113 
114 #endif /* _UAPI_LINUX_F2FS_H */
115