Skip to content

Commit 519fe1b

Browse files
joshtripletttytso
joshtriplett
authored and
tytso
committed
ext4: Add a uapi header for ext4 userspace APIs
Create a uapi header include/uapi/linux/ext4.h, move the ioctls and associated data structures to the uapi header, and include it from fs/ext4/ext4.h. Signed-off-by: Josh Triplett <[email protected]> Link: https://lore.kernel.org/r/680175260970d977d16b5cc7e7606483ec99eb63.1680402881.git.josh@joshtriplett.org Signed-off-by: Theodore Ts'o <[email protected]>
1 parent 17809d3 commit 519fe1b

File tree

3 files changed

+119
-90
lines changed

3 files changed

+119
-90
lines changed

‎MAINTAINERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7728,6 +7728,7 @@ T: git git://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git
77287728
F: Documentation/filesystems/ext4/
77297729
F: fs/ext4/
77307730
F: include/trace/events/ext4.h
7731+
F: include/uapi/linux/ext4.h
77317732

77327733
Extended Verification Module (EVM)
77337734
M: Mimi Zohar <[email protected]>

‎fs/ext4/ext4.h

Lines changed: 1 addition & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
#ifdef __KERNEL__
4141
#include <linux/compat.h>
4242
#endif
43+
#include <uapi/linux/ext4.h>
4344

4445
#include <linux/fscrypt.h>
4546
#include <linux/fsverity.h>
@@ -591,17 +592,6 @@ static inline void ext4_check_flag_values(void)
591592
CHECK_FLAG_VALUE(RESERVED);
592593
}
593594

594-
/* Used to pass group descriptor data when online resize is done */
595-
struct ext4_new_group_input {
596-
__u32 group; /* Group number for this data */
597-
__u64 block_bitmap; /* Absolute block number of block bitmap */
598-
__u64 inode_bitmap; /* Absolute block number of inode bitmap */
599-
__u64 inode_table; /* Absolute block number of inode table start */
600-
__u32 blocks_count; /* Total number of blocks in this group */
601-
__u16 reserved_blocks; /* Number of reserved blocks in this group */
602-
__u16 unused;
603-
};
604-
605595
#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
606596
struct compat_ext4_new_group_input {
607597
u32 group;
@@ -698,70 +688,6 @@ enum {
698688
#define EXT4_FREE_BLOCKS_NOFREE_LAST_CLUSTER 0x0020
699689
#define EXT4_FREE_BLOCKS_RERESERVE_CLUSTER 0x0040
700690

701-
/*
702-
* ioctl commands
703-
*/
704-
#define EXT4_IOC_GETVERSION _IOR('f', 3, long)
705-
#define EXT4_IOC_SETVERSION _IOW('f', 4, long)
706-
#define EXT4_IOC_GETVERSION_OLD FS_IOC_GETVERSION
707-
#define EXT4_IOC_SETVERSION_OLD FS_IOC_SETVERSION
708-
#define EXT4_IOC_GETRSVSZ _IOR('f', 5, long)
709-
#define EXT4_IOC_SETRSVSZ _IOW('f', 6, long)
710-
#define EXT4_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
711-
#define EXT4_IOC_GROUP_ADD _IOW('f', 8, struct ext4_new_group_input)
712-
#define EXT4_IOC_MIGRATE _IO('f', 9)
713-
/* note ioctl 10 reserved for an early version of the FIEMAP ioctl */
714-
/* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
715-
#define EXT4_IOC_ALLOC_DA_BLKS _IO('f', 12)
716-
#define EXT4_IOC_MOVE_EXT _IOWR('f', 15, struct move_extent)
717-
#define EXT4_IOC_RESIZE_FS _IOW('f', 16, __u64)
718-
#define EXT4_IOC_SWAP_BOOT _IO('f', 17)
719-
#define EXT4_IOC_PRECACHE_EXTENTS _IO('f', 18)
720-
/* ioctl codes 19--39 are reserved for fscrypt */
721-
#define EXT4_IOC_CLEAR_ES_CACHE _IO('f', 40)
722-
#define EXT4_IOC_GETSTATE _IOW('f', 41, __u32)
723-
#define EXT4_IOC_GET_ES_CACHE _IOWR('f', 42, struct fiemap)
724-
#define EXT4_IOC_CHECKPOINT _IOW('f', 43, __u32)
725-
#define EXT4_IOC_GETFSUUID _IOR('f', 44, struct fsuuid)
726-
#define EXT4_IOC_SETFSUUID _IOW('f', 44, struct fsuuid)
727-
728-
#define EXT4_IOC_SHUTDOWN _IOR ('X', 125, __u32)
729-
730-
/*
731-
* Flags for going down operation
732-
*/
733-
#define EXT4_GOING_FLAGS_DEFAULT 0x0 /* going down */
734-
#define EXT4_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
735-
#define EXT4_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
736-
737-
/*
738-
* Flags returned by EXT4_IOC_GETSTATE
739-
*
740-
* We only expose to userspace a subset of the state flags in
741-
* i_state_flags
742-
*/
743-
#define EXT4_STATE_FLAG_EXT_PRECACHED 0x00000001
744-
#define EXT4_STATE_FLAG_NEW 0x00000002
745-
#define EXT4_STATE_FLAG_NEWENTRY 0x00000004
746-
#define EXT4_STATE_FLAG_DA_ALLOC_CLOSE 0x00000008
747-
748-
/* flags for ioctl EXT4_IOC_CHECKPOINT */
749-
#define EXT4_IOC_CHECKPOINT_FLAG_DISCARD 0x1
750-
#define EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT 0x2
751-
#define EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN 0x4
752-
#define EXT4_IOC_CHECKPOINT_FLAG_VALID (EXT4_IOC_CHECKPOINT_FLAG_DISCARD | \
753-
EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT | \
754-
EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN)
755-
756-
/*
757-
* Structure for EXT4_IOC_GETFSUUID/EXT4_IOC_SETFSUUID
758-
*/
759-
struct fsuuid {
760-
__u32 fsu_len;
761-
__u32 fsu_flags;
762-
__u8 fsu_uuid[];
763-
};
764-
765691
#if defined(__KERNEL__) && defined(CONFIG_COMPAT)
766692
/*
767693
* ioctl commands in 32 bit emulation
@@ -776,12 +702,6 @@ struct fsuuid {
776702
#define EXT4_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
777703
#endif
778704

779-
/*
780-
* Returned by EXT4_IOC_GET_ES_CACHE as an additional possible flag.
781-
* It indicates that the entry in extent status cache is for a hole.
782-
*/
783-
#define EXT4_FIEMAP_EXTENT_HOLE 0x08000000
784-
785705
/* Max physical block we can address w/o extents */
786706
#define EXT4_MAX_BLOCK_FILE_PHYS 0xFFFFFFFF
787707

@@ -852,15 +772,6 @@ struct ext4_inode {
852772
__le32 i_projid; /* Project ID */
853773
};
854774

855-
struct move_extent {
856-
__u32 reserved; /* should be zero */
857-
__u32 donor_fd; /* donor file descriptor */
858-
__u64 orig_start; /* logical start offset in block for orig */
859-
__u64 donor_start; /* logical start offset in block for donor */
860-
__u64 len; /* block length to be moved */
861-
__u64 moved_len; /* moved block length */
862-
};
863-
864775
#define EXT4_EPOCH_BITS 2
865776
#define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
866777
#define EXT4_NSEC_MASK (~0UL << EXT4_EPOCH_BITS)

‎include/uapi/linux/ext4.h

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2+
3+
#ifndef _UAPI_LINUX_EXT4_H
4+
#define _UAPI_LINUX_EXT4_H
5+
#include <linux/fiemap.h>
6+
#include <linux/fs.h>
7+
#include <linux/ioctl.h>
8+
#include <linux/types.h>
9+
10+
/*
11+
* ext4-specific ioctl commands
12+
*/
13+
#define EXT4_IOC_GETVERSION _IOR('f', 3, long)
14+
#define EXT4_IOC_SETVERSION _IOW('f', 4, long)
15+
#define EXT4_IOC_GETVERSION_OLD FS_IOC_GETVERSION
16+
#define EXT4_IOC_SETVERSION_OLD FS_IOC_SETVERSION
17+
#define EXT4_IOC_GETRSVSZ _IOR('f', 5, long)
18+
#define EXT4_IOC_SETRSVSZ _IOW('f', 6, long)
19+
#define EXT4_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
20+
#define EXT4_IOC_GROUP_ADD _IOW('f', 8, struct ext4_new_group_input)
21+
#define EXT4_IOC_MIGRATE _IO('f', 9)
22+
/* note ioctl 10 reserved for an early version of the FIEMAP ioctl */
23+
/* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
24+
#define EXT4_IOC_ALLOC_DA_BLKS _IO('f', 12)
25+
#define EXT4_IOC_MOVE_EXT _IOWR('f', 15, struct move_extent)
26+
#define EXT4_IOC_RESIZE_FS _IOW('f', 16, __u64)
27+
#define EXT4_IOC_SWAP_BOOT _IO('f', 17)
28+
#define EXT4_IOC_PRECACHE_EXTENTS _IO('f', 18)
29+
/* ioctl codes 19--39 are reserved for fscrypt */
30+
#define EXT4_IOC_CLEAR_ES_CACHE _IO('f', 40)
31+
#define EXT4_IOC_GETSTATE _IOW('f', 41, __u32)
32+
#define EXT4_IOC_GET_ES_CACHE _IOWR('f', 42, struct fiemap)
33+
#define EXT4_IOC_CHECKPOINT _IOW('f', 43, __u32)
34+
#define EXT4_IOC_GETFSUUID _IOR('f', 44, struct fsuuid)
35+
#define EXT4_IOC_SETFSUUID _IOW('f', 44, struct fsuuid)
36+
37+
#define EXT4_IOC_SHUTDOWN _IOR('X', 125, __u32)
38+
39+
/*
40+
* ioctl commands in 32 bit emulation
41+
*/
42+
#define EXT4_IOC32_GETVERSION _IOR('f', 3, int)
43+
#define EXT4_IOC32_SETVERSION _IOW('f', 4, int)
44+
#define EXT4_IOC32_GETRSVSZ _IOR('f', 5, int)
45+
#define EXT4_IOC32_SETRSVSZ _IOW('f', 6, int)
46+
#define EXT4_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
47+
#define EXT4_IOC32_GROUP_ADD _IOW('f', 8, struct compat_ext4_new_group_input)
48+
#define EXT4_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
49+
#define EXT4_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
50+
51+
/*
52+
* Flags returned by EXT4_IOC_GETSTATE
53+
*
54+
* We only expose to userspace a subset of the state flags in
55+
* i_state_flags
56+
*/
57+
#define EXT4_STATE_FLAG_EXT_PRECACHED 0x00000001
58+
#define EXT4_STATE_FLAG_NEW 0x00000002
59+
#define EXT4_STATE_FLAG_NEWENTRY 0x00000004
60+
#define EXT4_STATE_FLAG_DA_ALLOC_CLOSE 0x00000008
61+
62+
/*
63+
* Flags for ioctl EXT4_IOC_CHECKPOINT
64+
*/
65+
#define EXT4_IOC_CHECKPOINT_FLAG_DISCARD 0x1
66+
#define EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT 0x2
67+
#define EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN 0x4
68+
#define EXT4_IOC_CHECKPOINT_FLAG_VALID (EXT4_IOC_CHECKPOINT_FLAG_DISCARD | \
69+
EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT | \
70+
EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN)
71+
72+
/*
73+
* Structure for EXT4_IOC_GETFSUUID/EXT4_IOC_SETFSUUID
74+
*/
75+
struct fsuuid {
76+
__u32 fsu_len;
77+
__u32 fsu_flags;
78+
__u8 fsu_uuid[];
79+
};
80+
81+
/*
82+
* Structure for EXT4_IOC_MOVE_EXT
83+
*/
84+
struct move_extent {
85+
__u32 reserved; /* should be zero */
86+
__u32 donor_fd; /* donor file descriptor */
87+
__u64 orig_start; /* logical start offset in block for orig */
88+
__u64 donor_start; /* logical start offset in block for donor */
89+
__u64 len; /* block length to be moved */
90+
__u64 moved_len; /* moved block length */
91+
};
92+
93+
/*
94+
* Flags used by EXT4_IOC_SHUTDOWN
95+
*/
96+
#define EXT4_GOING_FLAGS_DEFAULT 0x0 /* going down */
97+
#define EXT4_GOING_FLAGS_LOGFLUSH 0x1 /* flush log but not data */
98+
#define EXT4_GOING_FLAGS_NOLOGFLUSH 0x2 /* don't flush log nor data */
99+
100+
/* Used to pass group descriptor data when online resize is done */
101+
struct ext4_new_group_input {
102+
__u32 group; /* Group number for this data */
103+
__u64 block_bitmap; /* Absolute block number of block bitmap */
104+
__u64 inode_bitmap; /* Absolute block number of inode bitmap */
105+
__u64 inode_table; /* Absolute block number of inode table start */
106+
__u32 blocks_count; /* Total number of blocks in this group */
107+
__u16 reserved_blocks; /* Number of reserved blocks in this group */
108+
__u16 unused;
109+
};
110+
111+
/*
112+
* Returned by EXT4_IOC_GET_ES_CACHE as an additional possible flag.
113+
* It indicates that the entry in extent status cache is for a hole.
114+
*/
115+
#define EXT4_FIEMAP_EXTENT_HOLE 0x08000000
116+
117+
#endif /* _UAPI_LINUX_EXT4_H */

0 commit comments

Comments
 (0)