include/linux/fileattr.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002
0003 #ifndef _LINUX_FILEATTR_H
0004 #define _LINUX_FILEATTR_H
0005
0006 /* Flags shared betwen flags/xflags */
0007 #define FS_COMMON_FL \
0008     (FS_SYNC_FL | FS_IMMUTABLE_FL | FS_APPEND_FL | \
0009      FS_NODUMP_FL | FS_NOATIME_FL | FS_DAX_FL | \
0010      FS_PROJINHERIT_FL)
0011
0012 #define FS_XFLAG_COMMON \
0013     (FS_XFLAG_SYNC | FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND | \
0014      FS_XFLAG_NODUMP | FS_XFLAG_NOATIME | FS_XFLAG_DAX | \
0015      FS_XFLAG_PROJINHERIT)
0016
0017 /*
0018  * Merged interface for miscellaneous file attributes.  'flags' originates from
0019  * ext* and 'fsx_flags' from xfs.  There's some overlap between the two, which
0020  * is handled by the VFS helpers, so filesystems are free to implement just one
0021  * or both of these sub-interfaces.
0022  */
0023 struct fileattr {
0024     u32 flags;      /* flags (FS_IOC_GETFLAGS/FS_IOC_SETFLAGS) */
0025     /* struct fsxattr: */
0026     u32 fsx_xflags; /* xflags field value (get/set) */
0027     u32 fsx_extsize;    /* extsize field value (get/set)*/
0028     u32 fsx_nextents;   /* nextents field value (get)   */
0029     u32 fsx_projid; /* project identifier (get/set) */
0030     u32 fsx_cowextsize; /* CoW extsize field value (get/set)*/
0031     /* selectors: */
0032     bool    flags_valid:1;
0033     bool    fsx_valid:1;
0034 };
0035
0036 int copy_fsxattr_to_user(const struct fileattr *fa, struct fsxattr __user *ufa);
0037
0038 void fileattr_fill_xflags(struct fileattr *fa, u32 xflags);
0039 void fileattr_fill_flags(struct fileattr *fa, u32 flags);
0040
0041 /**
0042  * fileattr_has_fsx - check for extended flags/attributes
0043  * @fa:     fileattr pointer
0044  *
0045  * Return: true if any attributes are present that are not represented in
0046  * ->flags.
0047  */
0048 static inline bool fileattr_has_fsx(const struct fileattr *fa)
0049 {
0050     return fa->fsx_valid &&
0051         ((fa->fsx_xflags & ~FS_XFLAG_COMMON) || fa->fsx_extsize != 0 ||
0052          fa->fsx_projid != 0 || fa->fsx_cowextsize != 0);
0053 }
0054
0055 int vfs_fileattr_get(struct dentry *dentry, struct fileattr *fa);
0056 int vfs_fileattr_set(struct user_namespace *mnt_userns, struct dentry *dentry,
0057              struct fileattr *fa);
0058
0059 #endif /* _LINUX_FILEATTR_H */