xref: /linux/include/linux/fileattr.h (revision 056a5087d87ead77dedbe9cf5bde53b7cd4b4651)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 
3 #ifndef _LINUX_FILEATTR_H
4 #define _LINUX_FILEATTR_H
5 
6 /* Flags shared betwen flags/xflags */
7 #define FS_COMMON_FL \
8 	(FS_SYNC_FL | FS_IMMUTABLE_FL | FS_APPEND_FL | \
9 	 FS_NODUMP_FL |	FS_NOATIME_FL | FS_DAX_FL | \
10 	 FS_PROJINHERIT_FL | FS_VERITY_FL)
11 
12 #define FS_XFLAG_COMMON \
13 	(FS_XFLAG_SYNC | FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND | \
14 	 FS_XFLAG_NODUMP | FS_XFLAG_NOATIME | FS_XFLAG_DAX | \
15 	 FS_XFLAG_PROJINHERIT | FS_XFLAG_VERITY)
16 
17 /* Read-only inode flags */
18 #define FS_XFLAG_RDONLY_MASK \
19 	(FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR | FS_XFLAG_VERITY | \
20 	 FS_XFLAG_CASEFOLD | FS_XFLAG_CASENONPRESERVING)
21 
22 /* Flags to indicate valid value of fsx_ fields */
23 #define FS_XFLAG_VALUES_MASK \
24 	(FS_XFLAG_EXTSIZE | FS_XFLAG_COWEXTSIZE)
25 
26 /* Flags for directories */
27 #define FS_XFLAG_DIRONLY_MASK \
28 	(FS_XFLAG_RTINHERIT | FS_XFLAG_NOSYMLINKS | FS_XFLAG_EXTSZINHERIT)
29 
30 /* Misc settable flags */
31 #define FS_XFLAG_MISC_MASK \
32 	(FS_XFLAG_REALTIME | FS_XFLAG_NODEFRAG | FS_XFLAG_FILESTREAM)
33 
34 #define FS_XFLAGS_MASK \
35 	(FS_XFLAG_COMMON | FS_XFLAG_RDONLY_MASK | FS_XFLAG_VALUES_MASK | \
36 	 FS_XFLAG_DIRONLY_MASK | FS_XFLAG_MISC_MASK)
37 
38 /*
39  * Merged interface for miscellaneous file attributes.  'flags' originates from
40  * ext* and 'fsx_flags' from xfs.  There's some overlap between the two, which
41  * is handled by the VFS helpers, so filesystems are free to implement just one
42  * or both of these sub-interfaces.
43  */
44 struct file_kattr {
45 	u32	flags;		/* flags (FS_IOC_GETFLAGS/FS_IOC_SETFLAGS) */
46 	/* struct fsxattr: */
47 	u32	fsx_xflags;	/* xflags field value (get/set) */
48 	u32	fsx_extsize;	/* extsize field value (get/set)*/
49 	u32	fsx_nextents;	/* nextents field value (get)	*/
50 	u32	fsx_projid;	/* project identifier (get/set) */
51 	u32	fsx_cowextsize;	/* CoW extsize field value (get/set)*/
52 	/* selectors: */
53 	bool	flags_valid:1;
54 	bool	fsx_valid:1;
55 };
56 
57 int copy_fsxattr_to_user(const struct file_kattr *fa, struct fsxattr __user *ufa);
58 
59 void fileattr_fill_xflags(struct file_kattr *fa, u32 xflags);
60 void fileattr_fill_flags(struct file_kattr *fa, u32 flags);
61 
62 /**
63  * fileattr_has_fsx - check for extended flags/attributes
64  * @fa:		fileattr pointer
65  *
66  * Return: true if any attributes are present that are not represented in
67  * ->flags.
68  */
69 static inline bool fileattr_has_fsx(const struct file_kattr *fa)
70 {
71 	return fa->fsx_valid &&
72 		((fa->fsx_xflags & ~FS_XFLAG_COMMON) || fa->fsx_extsize != 0 ||
73 		 fa->fsx_projid != 0 ||	fa->fsx_cowextsize != 0);
74 }
75 
76 int vfs_fileattr_get(struct dentry *dentry, struct file_kattr *fa);
77 int vfs_fileattr_set(struct mnt_idmap *idmap, struct dentry *dentry,
78 		     struct file_kattr *fa);
79 int ioctl_getflags(struct file *file, unsigned int __user *argp);
80 int ioctl_setflags(struct file *file, unsigned int __user *argp);
81 int ioctl_fsgetxattr(struct file *file, void __user *argp);
82 int ioctl_fssetxattr(struct file *file, void __user *argp);
83 
84 #endif /* _LINUX_FILEATTR_H */
85