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