1e9be9d5eSMiklos Szeredi /* 2e9be9d5eSMiklos Szeredi * 3e9be9d5eSMiklos Szeredi * Copyright (C) 2011 Novell Inc. 4e9be9d5eSMiklos Szeredi * 5e9be9d5eSMiklos Szeredi * This program is free software; you can redistribute it and/or modify it 6e9be9d5eSMiklos Szeredi * under the terms of the GNU General Public License version 2 as published by 7e9be9d5eSMiklos Szeredi * the Free Software Foundation. 8e9be9d5eSMiklos Szeredi */ 9e9be9d5eSMiklos Szeredi 10e9be9d5eSMiklos Szeredi #include <linux/kernel.h> 113a1e819bSAmir Goldstein #include <linux/uuid.h> 12e9be9d5eSMiklos Szeredi 13e9be9d5eSMiklos Szeredi enum ovl_path_type { 1438e813dbSMiklos Szeredi __OVL_PATH_UPPER = (1 << 0), 1538e813dbSMiklos Szeredi __OVL_PATH_MERGE = (1 << 1), 1659548503SAmir Goldstein __OVL_PATH_ORIGIN = (1 << 2), 17e9be9d5eSMiklos Szeredi }; 18e9be9d5eSMiklos Szeredi 191afaba1eSMiklos Szeredi #define OVL_TYPE_UPPER(type) ((type) & __OVL_PATH_UPPER) 201afaba1eSMiklos Szeredi #define OVL_TYPE_MERGE(type) ((type) & __OVL_PATH_MERGE) 2159548503SAmir Goldstein #define OVL_TYPE_ORIGIN(type) ((type) & __OVL_PATH_ORIGIN) 22d837a49bSMiklos Szeredi 23fe2b7595SAndreas Gruenbacher #define OVL_XATTR_PREFIX XATTR_TRUSTED_PREFIX "overlay." 24fe2b7595SAndreas Gruenbacher #define OVL_XATTR_OPAQUE OVL_XATTR_PREFIX "opaque" 2502b69b28SMiklos Szeredi #define OVL_XATTR_REDIRECT OVL_XATTR_PREFIX "redirect" 263a1e819bSAmir Goldstein #define OVL_XATTR_ORIGIN OVL_XATTR_PREFIX "origin" 27ee1d6d37SAmir Goldstein #define OVL_XATTR_IMPURE OVL_XATTR_PREFIX "impure" 283a1e819bSAmir Goldstein 293a1e819bSAmir Goldstein /* 303a1e819bSAmir Goldstein * The tuple (fh,uuid) is a universal unique identifier for a copy up origin, 313a1e819bSAmir Goldstein * where: 323a1e819bSAmir Goldstein * origin.fh - exported file handle of the lower file 333a1e819bSAmir Goldstein * origin.uuid - uuid of the lower filesystem 343a1e819bSAmir Goldstein */ 353a1e819bSAmir Goldstein #define OVL_FH_VERSION 0 363a1e819bSAmir Goldstein #define OVL_FH_MAGIC 0xfb 373a1e819bSAmir Goldstein 383a1e819bSAmir Goldstein /* CPU byte order required for fid decoding: */ 393a1e819bSAmir Goldstein #define OVL_FH_FLAG_BIG_ENDIAN (1 << 0) 403a1e819bSAmir Goldstein #define OVL_FH_FLAG_ANY_ENDIAN (1 << 1) 413a1e819bSAmir Goldstein 423a1e819bSAmir Goldstein #define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN) 433a1e819bSAmir Goldstein 443a1e819bSAmir Goldstein #if defined(__LITTLE_ENDIAN) 453a1e819bSAmir Goldstein #define OVL_FH_FLAG_CPU_ENDIAN 0 463a1e819bSAmir Goldstein #elif defined(__BIG_ENDIAN) 473a1e819bSAmir Goldstein #define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN 483a1e819bSAmir Goldstein #else 493a1e819bSAmir Goldstein #error Endianness not defined 503a1e819bSAmir Goldstein #endif 513a1e819bSAmir Goldstein 523a1e819bSAmir Goldstein /* On-disk and in-memeory format for redirect by file handle */ 533a1e819bSAmir Goldstein struct ovl_fh { 543a1e819bSAmir Goldstein u8 version; /* 0 */ 553a1e819bSAmir Goldstein u8 magic; /* 0xfb */ 563a1e819bSAmir Goldstein u8 len; /* size of this header + size of fid */ 573a1e819bSAmir Goldstein u8 flags; /* OVL_FH_FLAG_* */ 583a1e819bSAmir Goldstein u8 type; /* fid_type of fid */ 593a1e819bSAmir Goldstein uuid_be uuid; /* uuid of filesystem */ 603a1e819bSAmir Goldstein u8 fid[0]; /* file identifier */ 613a1e819bSAmir Goldstein } __packed; 62e9be9d5eSMiklos Szeredi 6339b681f8SMiklos Szeredi #define OVL_ISUPPER_MASK 1UL 6439b681f8SMiklos Szeredi 65e9be9d5eSMiklos Szeredi static inline int ovl_do_rmdir(struct inode *dir, struct dentry *dentry) 66e9be9d5eSMiklos Szeredi { 67e9be9d5eSMiklos Szeredi int err = vfs_rmdir(dir, dentry); 68e9be9d5eSMiklos Szeredi pr_debug("rmdir(%pd2) = %i\n", dentry, err); 69e9be9d5eSMiklos Szeredi return err; 70e9be9d5eSMiklos Szeredi } 71e9be9d5eSMiklos Szeredi 72e9be9d5eSMiklos Szeredi static inline int ovl_do_unlink(struct inode *dir, struct dentry *dentry) 73e9be9d5eSMiklos Szeredi { 74e9be9d5eSMiklos Szeredi int err = vfs_unlink(dir, dentry, NULL); 75e9be9d5eSMiklos Szeredi pr_debug("unlink(%pd2) = %i\n", dentry, err); 76e9be9d5eSMiklos Szeredi return err; 77e9be9d5eSMiklos Szeredi } 78e9be9d5eSMiklos Szeredi 79e9be9d5eSMiklos Szeredi static inline int ovl_do_link(struct dentry *old_dentry, struct inode *dir, 80e9be9d5eSMiklos Szeredi struct dentry *new_dentry, bool debug) 81e9be9d5eSMiklos Szeredi { 82e9be9d5eSMiklos Szeredi int err = vfs_link(old_dentry, dir, new_dentry, NULL); 83e9be9d5eSMiklos Szeredi if (debug) { 84e9be9d5eSMiklos Szeredi pr_debug("link(%pd2, %pd2) = %i\n", 85e9be9d5eSMiklos Szeredi old_dentry, new_dentry, err); 86e9be9d5eSMiklos Szeredi } 87e9be9d5eSMiklos Szeredi return err; 88e9be9d5eSMiklos Szeredi } 89e9be9d5eSMiklos Szeredi 90e9be9d5eSMiklos Szeredi static inline int ovl_do_create(struct inode *dir, struct dentry *dentry, 91e9be9d5eSMiklos Szeredi umode_t mode, bool debug) 92e9be9d5eSMiklos Szeredi { 93e9be9d5eSMiklos Szeredi int err = vfs_create(dir, dentry, mode, true); 94e9be9d5eSMiklos Szeredi if (debug) 95e9be9d5eSMiklos Szeredi pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err); 96e9be9d5eSMiklos Szeredi return err; 97e9be9d5eSMiklos Szeredi } 98e9be9d5eSMiklos Szeredi 99e9be9d5eSMiklos Szeredi static inline int ovl_do_mkdir(struct inode *dir, struct dentry *dentry, 100e9be9d5eSMiklos Szeredi umode_t mode, bool debug) 101e9be9d5eSMiklos Szeredi { 102e9be9d5eSMiklos Szeredi int err = vfs_mkdir(dir, dentry, mode); 103e9be9d5eSMiklos Szeredi if (debug) 104e9be9d5eSMiklos Szeredi pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err); 105e9be9d5eSMiklos Szeredi return err; 106e9be9d5eSMiklos Szeredi } 107e9be9d5eSMiklos Szeredi 108e9be9d5eSMiklos Szeredi static inline int ovl_do_mknod(struct inode *dir, struct dentry *dentry, 109e9be9d5eSMiklos Szeredi umode_t mode, dev_t dev, bool debug) 110e9be9d5eSMiklos Szeredi { 111e9be9d5eSMiklos Szeredi int err = vfs_mknod(dir, dentry, mode, dev); 112e9be9d5eSMiklos Szeredi if (debug) { 113e9be9d5eSMiklos Szeredi pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", 114e9be9d5eSMiklos Szeredi dentry, mode, dev, err); 115e9be9d5eSMiklos Szeredi } 116e9be9d5eSMiklos Szeredi return err; 117e9be9d5eSMiklos Szeredi } 118e9be9d5eSMiklos Szeredi 119e9be9d5eSMiklos Szeredi static inline int ovl_do_symlink(struct inode *dir, struct dentry *dentry, 120e9be9d5eSMiklos Szeredi const char *oldname, bool debug) 121e9be9d5eSMiklos Szeredi { 122e9be9d5eSMiklos Szeredi int err = vfs_symlink(dir, dentry, oldname); 123e9be9d5eSMiklos Szeredi if (debug) 124e9be9d5eSMiklos Szeredi pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err); 125e9be9d5eSMiklos Szeredi return err; 126e9be9d5eSMiklos Szeredi } 127e9be9d5eSMiklos Szeredi 128e9be9d5eSMiklos Szeredi static inline int ovl_do_setxattr(struct dentry *dentry, const char *name, 129e9be9d5eSMiklos Szeredi const void *value, size_t size, int flags) 130e9be9d5eSMiklos Szeredi { 131e9be9d5eSMiklos Szeredi int err = vfs_setxattr(dentry, name, value, size, flags); 132e9be9d5eSMiklos Szeredi pr_debug("setxattr(%pd2, \"%s\", \"%*s\", 0x%x) = %i\n", 133e9be9d5eSMiklos Szeredi dentry, name, (int) size, (char *) value, flags, err); 134e9be9d5eSMiklos Szeredi return err; 135e9be9d5eSMiklos Szeredi } 136e9be9d5eSMiklos Szeredi 137e9be9d5eSMiklos Szeredi static inline int ovl_do_removexattr(struct dentry *dentry, const char *name) 138e9be9d5eSMiklos Szeredi { 139e9be9d5eSMiklos Szeredi int err = vfs_removexattr(dentry, name); 140e9be9d5eSMiklos Szeredi pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err); 141e9be9d5eSMiklos Szeredi return err; 142e9be9d5eSMiklos Szeredi } 143e9be9d5eSMiklos Szeredi 144e9be9d5eSMiklos Szeredi static inline int ovl_do_rename(struct inode *olddir, struct dentry *olddentry, 145e9be9d5eSMiklos Szeredi struct inode *newdir, struct dentry *newdentry, 146e9be9d5eSMiklos Szeredi unsigned int flags) 147e9be9d5eSMiklos Szeredi { 148e9be9d5eSMiklos Szeredi int err; 149e9be9d5eSMiklos Szeredi 1502773bf00SMiklos Szeredi pr_debug("rename(%pd2, %pd2, 0x%x)\n", 151e9be9d5eSMiklos Szeredi olddentry, newdentry, flags); 152e9be9d5eSMiklos Szeredi 153e9be9d5eSMiklos Szeredi err = vfs_rename(olddir, olddentry, newdir, newdentry, NULL, flags); 154e9be9d5eSMiklos Szeredi 155e9be9d5eSMiklos Szeredi if (err) { 1562773bf00SMiklos Szeredi pr_debug("...rename(%pd2, %pd2, ...) = %i\n", 157e9be9d5eSMiklos Szeredi olddentry, newdentry, err); 158e9be9d5eSMiklos Szeredi } 159e9be9d5eSMiklos Szeredi return err; 160e9be9d5eSMiklos Szeredi } 161e9be9d5eSMiklos Szeredi 162e9be9d5eSMiklos Szeredi static inline int ovl_do_whiteout(struct inode *dir, struct dentry *dentry) 163e9be9d5eSMiklos Szeredi { 164e9be9d5eSMiklos Szeredi int err = vfs_whiteout(dir, dentry); 165e9be9d5eSMiklos Szeredi pr_debug("whiteout(%pd2) = %i\n", dentry, err); 166e9be9d5eSMiklos Szeredi return err; 167e9be9d5eSMiklos Szeredi } 168e9be9d5eSMiklos Szeredi 169e7f52429SAmir Goldstein static inline struct dentry *ovl_do_tmpfile(struct dentry *dentry, umode_t mode) 170e7f52429SAmir Goldstein { 171e7f52429SAmir Goldstein struct dentry *ret = vfs_tmpfile(dentry, mode, 0); 172e7f52429SAmir Goldstein int err = IS_ERR(ret) ? PTR_ERR(ret) : 0; 173e7f52429SAmir Goldstein 174e7f52429SAmir Goldstein pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err); 175e7f52429SAmir Goldstein return ret; 176e7f52429SAmir Goldstein } 177e7f52429SAmir Goldstein 17839b681f8SMiklos Szeredi static inline struct inode *ovl_inode_real(struct inode *inode, bool *is_upper) 17939b681f8SMiklos Szeredi { 18039b681f8SMiklos Szeredi unsigned long x = (unsigned long) READ_ONCE(inode->i_private); 18139b681f8SMiklos Szeredi 18239b681f8SMiklos Szeredi if (is_upper) 18339b681f8SMiklos Szeredi *is_upper = x & OVL_ISUPPER_MASK; 18439b681f8SMiklos Szeredi 18539b681f8SMiklos Szeredi return (struct inode *) (x & ~OVL_ISUPPER_MASK); 18639b681f8SMiklos Szeredi } 18739b681f8SMiklos Szeredi 188bbb1e54dSMiklos Szeredi /* util.c */ 189bbb1e54dSMiklos Szeredi int ovl_want_write(struct dentry *dentry); 190bbb1e54dSMiklos Szeredi void ovl_drop_write(struct dentry *dentry); 191bbb1e54dSMiklos Szeredi struct dentry *ovl_workdir(struct dentry *dentry); 192bbb1e54dSMiklos Szeredi const struct cred *ovl_override_creds(struct super_block *sb); 1937bcd74b9SAmir Goldstein struct super_block *ovl_same_sb(struct super_block *sb); 194bbb1e54dSMiklos Szeredi struct ovl_entry *ovl_alloc_entry(unsigned int numlower); 195bbb1e54dSMiklos Szeredi bool ovl_dentry_remote(struct dentry *dentry); 196bbb1e54dSMiklos Szeredi bool ovl_dentry_weird(struct dentry *dentry); 197e9be9d5eSMiklos Szeredi enum ovl_path_type ovl_path_type(struct dentry *dentry); 198e9be9d5eSMiklos Szeredi void ovl_path_upper(struct dentry *dentry, struct path *path); 199e9be9d5eSMiklos Szeredi void ovl_path_lower(struct dentry *dentry, struct path *path); 200e9be9d5eSMiklos Szeredi enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path); 201e9be9d5eSMiklos Szeredi struct dentry *ovl_dentry_upper(struct dentry *dentry); 202e9be9d5eSMiklos Szeredi struct dentry *ovl_dentry_lower(struct dentry *dentry); 203e9be9d5eSMiklos Szeredi struct dentry *ovl_dentry_real(struct dentry *dentry); 204e9be9d5eSMiklos Szeredi struct ovl_dir_cache *ovl_dir_cache(struct dentry *dentry); 205e9be9d5eSMiklos Szeredi void ovl_set_dir_cache(struct dentry *dentry, struct ovl_dir_cache *cache); 206e9be9d5eSMiklos Szeredi bool ovl_dentry_is_opaque(struct dentry *dentry); 207ee1d6d37SAmir Goldstein bool ovl_dentry_is_impure(struct dentry *dentry); 208c412ce49SMiklos Szeredi bool ovl_dentry_is_whiteout(struct dentry *dentry); 2095cf5b477SMiklos Szeredi void ovl_dentry_set_opaque(struct dentry *dentry); 210a6c60655SMiklos Szeredi bool ovl_redirect_dir(struct super_block *sb); 211a6c60655SMiklos Szeredi const char *ovl_dentry_get_redirect(struct dentry *dentry); 212a6c60655SMiklos Szeredi void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect); 213e9be9d5eSMiklos Szeredi void ovl_dentry_update(struct dentry *dentry, struct dentry *upperdentry); 214bbb1e54dSMiklos Szeredi void ovl_inode_init(struct inode *inode, struct inode *realinode, 215bbb1e54dSMiklos Szeredi bool is_upper); 21639b681f8SMiklos Szeredi void ovl_inode_update(struct inode *inode, struct inode *upperinode); 217bbb1e54dSMiklos Szeredi void ovl_dentry_version_inc(struct dentry *dentry); 218bbb1e54dSMiklos Szeredi u64 ovl_dentry_version_get(struct dentry *dentry); 219bbb1e54dSMiklos Szeredi bool ovl_is_whiteout(struct dentry *dentry); 220e9be9d5eSMiklos Szeredi struct file *ovl_path_open(struct path *path, int flags); 22139d3d60aSAmir Goldstein int ovl_copy_up_start(struct dentry *dentry); 22239d3d60aSAmir Goldstein void ovl_copy_up_end(struct dentry *dentry); 223f3a15685SAmir Goldstein bool ovl_check_dir_xattr(struct dentry *dentry, const char *name); 224f3a15685SAmir Goldstein int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry, 225f3a15685SAmir Goldstein const char *name, const void *value, size_t size, 226f3a15685SAmir Goldstein int xerr); 227f3a15685SAmir Goldstein int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry); 228f3a15685SAmir Goldstein 229f3a15685SAmir Goldstein static inline bool ovl_is_impuredir(struct dentry *dentry) 230f3a15685SAmir Goldstein { 231f3a15685SAmir Goldstein return ovl_check_dir_xattr(dentry, OVL_XATTR_IMPURE); 232f3a15685SAmir Goldstein } 233f3a15685SAmir Goldstein 234e9be9d5eSMiklos Szeredi 235bbb1e54dSMiklos Szeredi /* namei.c */ 236bbb1e54dSMiklos Szeredi int ovl_path_next(int idx, struct dentry *dentry, struct path *path); 237bbb1e54dSMiklos Szeredi struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags); 238bbb1e54dSMiklos Szeredi bool ovl_lower_positive(struct dentry *dentry); 239e9be9d5eSMiklos Szeredi 240e9be9d5eSMiklos Szeredi /* readdir.c */ 241e9be9d5eSMiklos Szeredi extern const struct file_operations ovl_dir_operations; 242e9be9d5eSMiklos Szeredi int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list); 243e9be9d5eSMiklos Szeredi void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list); 244e9be9d5eSMiklos Szeredi void ovl_cache_free(struct list_head *list); 24545aebeafSVivek Goyal int ovl_check_d_type_supported(struct path *realpath); 246eea2fb48SMiklos Szeredi void ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt, 247eea2fb48SMiklos Szeredi struct dentry *dentry, int level); 248e9be9d5eSMiklos Szeredi 249e9be9d5eSMiklos Szeredi /* inode.c */ 250e9be9d5eSMiklos Szeredi int ovl_setattr(struct dentry *dentry, struct iattr *attr); 2515b712091SMiklos Szeredi int ovl_getattr(const struct path *path, struct kstat *stat, 2525b712091SMiklos Szeredi u32 request_mask, unsigned int flags); 253e9be9d5eSMiklos Szeredi int ovl_permission(struct inode *inode, int mask); 2540e585cccSAndreas Gruenbacher int ovl_xattr_set(struct dentry *dentry, const char *name, const void *value, 2553767e255SAl Viro size_t size, int flags); 2560eb45fc3SAndreas Gruenbacher int ovl_xattr_get(struct dentry *dentry, const char *name, 2570eb45fc3SAndreas Gruenbacher void *value, size_t size); 258e9be9d5eSMiklos Szeredi ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size); 25939a25b2bSVivek Goyal struct posix_acl *ovl_get_acl(struct inode *inode, int type); 2602d902671SMiklos Szeredi int ovl_open_maybe_copy_up(struct dentry *dentry, unsigned int file_flags); 261d719e8f2SMiklos Szeredi int ovl_update_time(struct inode *inode, struct timespec *ts, int flags); 2620956254aSMiklos Szeredi bool ovl_is_private_xattr(const char *name); 263e9be9d5eSMiklos Szeredi 264ca4c8a3aSMiklos Szeredi struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev); 26551f7e52dSMiklos Szeredi struct inode *ovl_get_inode(struct super_block *sb, struct inode *realinode); 266e9be9d5eSMiklos Szeredi static inline void ovl_copyattr(struct inode *from, struct inode *to) 267e9be9d5eSMiklos Szeredi { 268e9be9d5eSMiklos Szeredi to->i_uid = from->i_uid; 269e9be9d5eSMiklos Szeredi to->i_gid = from->i_gid; 27007a2daabSVivek Goyal to->i_mode = from->i_mode; 271d719e8f2SMiklos Szeredi to->i_atime = from->i_atime; 272d719e8f2SMiklos Szeredi to->i_mtime = from->i_mtime; 273d719e8f2SMiklos Szeredi to->i_ctime = from->i_ctime; 274e9be9d5eSMiklos Szeredi } 275e9be9d5eSMiklos Szeredi 276e9be9d5eSMiklos Szeredi /* dir.c */ 277e9be9d5eSMiklos Szeredi extern const struct inode_operations ovl_dir_inode_operations; 2783d27573cSMiklos Szeredi struct dentry *ovl_lookup_temp(struct dentry *workdir); 27932a3d848SAl Viro struct cattr { 28032a3d848SAl Viro dev_t rdev; 28132a3d848SAl Viro umode_t mode; 28232a3d848SAl Viro const char *link; 28332a3d848SAl Viro }; 284e9be9d5eSMiklos Szeredi int ovl_create_real(struct inode *dir, struct dentry *newdentry, 28532a3d848SAl Viro struct cattr *attr, 286e9be9d5eSMiklos Szeredi struct dentry *hardlink, bool debug); 287e9be9d5eSMiklos Szeredi void ovl_cleanup(struct inode *dir, struct dentry *dentry); 288e9be9d5eSMiklos Szeredi 289e9be9d5eSMiklos Szeredi /* copy_up.c */ 290e9be9d5eSMiklos Szeredi int ovl_copy_up(struct dentry *dentry); 2919aba6521SAmir Goldstein int ovl_copy_up_flags(struct dentry *dentry, int flags); 292e9be9d5eSMiklos Szeredi int ovl_copy_xattr(struct dentry *old, struct dentry *new); 293e9be9d5eSMiklos Szeredi int ovl_set_attr(struct dentry *upper, struct kstat *stat); 294