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" 273a1e819bSAmir Goldstein 283a1e819bSAmir Goldstein /* 293a1e819bSAmir Goldstein * The tuple (fh,uuid) is a universal unique identifier for a copy up origin, 303a1e819bSAmir Goldstein * where: 313a1e819bSAmir Goldstein * origin.fh - exported file handle of the lower file 323a1e819bSAmir Goldstein * origin.uuid - uuid of the lower filesystem 333a1e819bSAmir Goldstein */ 343a1e819bSAmir Goldstein #define OVL_FH_VERSION 0 353a1e819bSAmir Goldstein #define OVL_FH_MAGIC 0xfb 363a1e819bSAmir Goldstein 373a1e819bSAmir Goldstein /* CPU byte order required for fid decoding: */ 383a1e819bSAmir Goldstein #define OVL_FH_FLAG_BIG_ENDIAN (1 << 0) 393a1e819bSAmir Goldstein #define OVL_FH_FLAG_ANY_ENDIAN (1 << 1) 403a1e819bSAmir Goldstein 413a1e819bSAmir Goldstein #define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN) 423a1e819bSAmir Goldstein 433a1e819bSAmir Goldstein #if defined(__LITTLE_ENDIAN) 443a1e819bSAmir Goldstein #define OVL_FH_FLAG_CPU_ENDIAN 0 453a1e819bSAmir Goldstein #elif defined(__BIG_ENDIAN) 463a1e819bSAmir Goldstein #define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN 473a1e819bSAmir Goldstein #else 483a1e819bSAmir Goldstein #error Endianness not defined 493a1e819bSAmir Goldstein #endif 503a1e819bSAmir Goldstein 513a1e819bSAmir Goldstein /* On-disk and in-memeory format for redirect by file handle */ 523a1e819bSAmir Goldstein struct ovl_fh { 533a1e819bSAmir Goldstein u8 version; /* 0 */ 543a1e819bSAmir Goldstein u8 magic; /* 0xfb */ 553a1e819bSAmir Goldstein u8 len; /* size of this header + size of fid */ 563a1e819bSAmir Goldstein u8 flags; /* OVL_FH_FLAG_* */ 573a1e819bSAmir Goldstein u8 type; /* fid_type of fid */ 583a1e819bSAmir Goldstein uuid_be uuid; /* uuid of filesystem */ 593a1e819bSAmir Goldstein u8 fid[0]; /* file identifier */ 603a1e819bSAmir Goldstein } __packed; 61e9be9d5eSMiklos Szeredi 6239b681f8SMiklos Szeredi #define OVL_ISUPPER_MASK 1UL 6339b681f8SMiklos Szeredi 64e9be9d5eSMiklos Szeredi static inline int ovl_do_rmdir(struct inode *dir, struct dentry *dentry) 65e9be9d5eSMiklos Szeredi { 66e9be9d5eSMiklos Szeredi int err = vfs_rmdir(dir, dentry); 67e9be9d5eSMiklos Szeredi pr_debug("rmdir(%pd2) = %i\n", dentry, err); 68e9be9d5eSMiklos Szeredi return err; 69e9be9d5eSMiklos Szeredi } 70e9be9d5eSMiklos Szeredi 71e9be9d5eSMiklos Szeredi static inline int ovl_do_unlink(struct inode *dir, struct dentry *dentry) 72e9be9d5eSMiklos Szeredi { 73e9be9d5eSMiklos Szeredi int err = vfs_unlink(dir, dentry, NULL); 74e9be9d5eSMiklos Szeredi pr_debug("unlink(%pd2) = %i\n", dentry, err); 75e9be9d5eSMiklos Szeredi return err; 76e9be9d5eSMiklos Szeredi } 77e9be9d5eSMiklos Szeredi 78e9be9d5eSMiklos Szeredi static inline int ovl_do_link(struct dentry *old_dentry, struct inode *dir, 79e9be9d5eSMiklos Szeredi struct dentry *new_dentry, bool debug) 80e9be9d5eSMiklos Szeredi { 81e9be9d5eSMiklos Szeredi int err = vfs_link(old_dentry, dir, new_dentry, NULL); 82e9be9d5eSMiklos Szeredi if (debug) { 83e9be9d5eSMiklos Szeredi pr_debug("link(%pd2, %pd2) = %i\n", 84e9be9d5eSMiklos Szeredi old_dentry, new_dentry, err); 85e9be9d5eSMiklos Szeredi } 86e9be9d5eSMiklos Szeredi return err; 87e9be9d5eSMiklos Szeredi } 88e9be9d5eSMiklos Szeredi 89e9be9d5eSMiklos Szeredi static inline int ovl_do_create(struct inode *dir, struct dentry *dentry, 90e9be9d5eSMiklos Szeredi umode_t mode, bool debug) 91e9be9d5eSMiklos Szeredi { 92e9be9d5eSMiklos Szeredi int err = vfs_create(dir, dentry, mode, true); 93e9be9d5eSMiklos Szeredi if (debug) 94e9be9d5eSMiklos Szeredi pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err); 95e9be9d5eSMiklos Szeredi return err; 96e9be9d5eSMiklos Szeredi } 97e9be9d5eSMiklos Szeredi 98e9be9d5eSMiklos Szeredi static inline int ovl_do_mkdir(struct inode *dir, struct dentry *dentry, 99e9be9d5eSMiklos Szeredi umode_t mode, bool debug) 100e9be9d5eSMiklos Szeredi { 101e9be9d5eSMiklos Szeredi int err = vfs_mkdir(dir, dentry, mode); 102e9be9d5eSMiklos Szeredi if (debug) 103e9be9d5eSMiklos Szeredi pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err); 104e9be9d5eSMiklos Szeredi return err; 105e9be9d5eSMiklos Szeredi } 106e9be9d5eSMiklos Szeredi 107e9be9d5eSMiklos Szeredi static inline int ovl_do_mknod(struct inode *dir, struct dentry *dentry, 108e9be9d5eSMiklos Szeredi umode_t mode, dev_t dev, bool debug) 109e9be9d5eSMiklos Szeredi { 110e9be9d5eSMiklos Szeredi int err = vfs_mknod(dir, dentry, mode, dev); 111e9be9d5eSMiklos Szeredi if (debug) { 112e9be9d5eSMiklos Szeredi pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", 113e9be9d5eSMiklos Szeredi dentry, mode, dev, err); 114e9be9d5eSMiklos Szeredi } 115e9be9d5eSMiklos Szeredi return err; 116e9be9d5eSMiklos Szeredi } 117e9be9d5eSMiklos Szeredi 118e9be9d5eSMiklos Szeredi static inline int ovl_do_symlink(struct inode *dir, struct dentry *dentry, 119e9be9d5eSMiklos Szeredi const char *oldname, bool debug) 120e9be9d5eSMiklos Szeredi { 121e9be9d5eSMiklos Szeredi int err = vfs_symlink(dir, dentry, oldname); 122e9be9d5eSMiklos Szeredi if (debug) 123e9be9d5eSMiklos Szeredi pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err); 124e9be9d5eSMiklos Szeredi return err; 125e9be9d5eSMiklos Szeredi } 126e9be9d5eSMiklos Szeredi 127e9be9d5eSMiklos Szeredi static inline int ovl_do_setxattr(struct dentry *dentry, const char *name, 128e9be9d5eSMiklos Szeredi const void *value, size_t size, int flags) 129e9be9d5eSMiklos Szeredi { 130e9be9d5eSMiklos Szeredi int err = vfs_setxattr(dentry, name, value, size, flags); 131e9be9d5eSMiklos Szeredi pr_debug("setxattr(%pd2, \"%s\", \"%*s\", 0x%x) = %i\n", 132e9be9d5eSMiklos Szeredi dentry, name, (int) size, (char *) value, flags, err); 133e9be9d5eSMiklos Szeredi return err; 134e9be9d5eSMiklos Szeredi } 135e9be9d5eSMiklos Szeredi 136e9be9d5eSMiklos Szeredi static inline int ovl_do_removexattr(struct dentry *dentry, const char *name) 137e9be9d5eSMiklos Szeredi { 138e9be9d5eSMiklos Szeredi int err = vfs_removexattr(dentry, name); 139e9be9d5eSMiklos Szeredi pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err); 140e9be9d5eSMiklos Szeredi return err; 141e9be9d5eSMiklos Szeredi } 142e9be9d5eSMiklos Szeredi 143e9be9d5eSMiklos Szeredi static inline int ovl_do_rename(struct inode *olddir, struct dentry *olddentry, 144e9be9d5eSMiklos Szeredi struct inode *newdir, struct dentry *newdentry, 145e9be9d5eSMiklos Szeredi unsigned int flags) 146e9be9d5eSMiklos Szeredi { 147e9be9d5eSMiklos Szeredi int err; 148e9be9d5eSMiklos Szeredi 1492773bf00SMiklos Szeredi pr_debug("rename(%pd2, %pd2, 0x%x)\n", 150e9be9d5eSMiklos Szeredi olddentry, newdentry, flags); 151e9be9d5eSMiklos Szeredi 152e9be9d5eSMiklos Szeredi err = vfs_rename(olddir, olddentry, newdir, newdentry, NULL, flags); 153e9be9d5eSMiklos Szeredi 154e9be9d5eSMiklos Szeredi if (err) { 1552773bf00SMiklos Szeredi pr_debug("...rename(%pd2, %pd2, ...) = %i\n", 156e9be9d5eSMiklos Szeredi olddentry, newdentry, err); 157e9be9d5eSMiklos Szeredi } 158e9be9d5eSMiklos Szeredi return err; 159e9be9d5eSMiklos Szeredi } 160e9be9d5eSMiklos Szeredi 161e9be9d5eSMiklos Szeredi static inline int ovl_do_whiteout(struct inode *dir, struct dentry *dentry) 162e9be9d5eSMiklos Szeredi { 163e9be9d5eSMiklos Szeredi int err = vfs_whiteout(dir, dentry); 164e9be9d5eSMiklos Szeredi pr_debug("whiteout(%pd2) = %i\n", dentry, err); 165e9be9d5eSMiklos Szeredi return err; 166e9be9d5eSMiklos Szeredi } 167e9be9d5eSMiklos Szeredi 168e7f52429SAmir Goldstein static inline struct dentry *ovl_do_tmpfile(struct dentry *dentry, umode_t mode) 169e7f52429SAmir Goldstein { 170e7f52429SAmir Goldstein struct dentry *ret = vfs_tmpfile(dentry, mode, 0); 171e7f52429SAmir Goldstein int err = IS_ERR(ret) ? PTR_ERR(ret) : 0; 172e7f52429SAmir Goldstein 173e7f52429SAmir Goldstein pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err); 174e7f52429SAmir Goldstein return ret; 175e7f52429SAmir Goldstein } 176e7f52429SAmir Goldstein 17739b681f8SMiklos Szeredi static inline struct inode *ovl_inode_real(struct inode *inode, bool *is_upper) 17839b681f8SMiklos Szeredi { 17939b681f8SMiklos Szeredi unsigned long x = (unsigned long) READ_ONCE(inode->i_private); 18039b681f8SMiklos Szeredi 18139b681f8SMiklos Szeredi if (is_upper) 18239b681f8SMiklos Szeredi *is_upper = x & OVL_ISUPPER_MASK; 18339b681f8SMiklos Szeredi 18439b681f8SMiklos Szeredi return (struct inode *) (x & ~OVL_ISUPPER_MASK); 18539b681f8SMiklos Szeredi } 18639b681f8SMiklos Szeredi 187bbb1e54dSMiklos Szeredi /* util.c */ 188bbb1e54dSMiklos Szeredi int ovl_want_write(struct dentry *dentry); 189bbb1e54dSMiklos Szeredi void ovl_drop_write(struct dentry *dentry); 190bbb1e54dSMiklos Szeredi struct dentry *ovl_workdir(struct dentry *dentry); 191bbb1e54dSMiklos Szeredi const struct cred *ovl_override_creds(struct super_block *sb); 1927bcd74b9SAmir Goldstein struct super_block *ovl_same_sb(struct super_block *sb); 193bbb1e54dSMiklos Szeredi struct ovl_entry *ovl_alloc_entry(unsigned int numlower); 194bbb1e54dSMiklos Szeredi bool ovl_dentry_remote(struct dentry *dentry); 195bbb1e54dSMiklos Szeredi bool ovl_dentry_weird(struct dentry *dentry); 196e9be9d5eSMiklos Szeredi enum ovl_path_type ovl_path_type(struct dentry *dentry); 197e9be9d5eSMiklos Szeredi void ovl_path_upper(struct dentry *dentry, struct path *path); 198e9be9d5eSMiklos Szeredi void ovl_path_lower(struct dentry *dentry, struct path *path); 199e9be9d5eSMiklos Szeredi enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path); 200e9be9d5eSMiklos Szeredi struct dentry *ovl_dentry_upper(struct dentry *dentry); 201e9be9d5eSMiklos Szeredi struct dentry *ovl_dentry_lower(struct dentry *dentry); 202e9be9d5eSMiklos Szeredi struct dentry *ovl_dentry_real(struct dentry *dentry); 203e9be9d5eSMiklos Szeredi struct ovl_dir_cache *ovl_dir_cache(struct dentry *dentry); 204e9be9d5eSMiklos Szeredi void ovl_set_dir_cache(struct dentry *dentry, struct ovl_dir_cache *cache); 205e9be9d5eSMiklos Szeredi bool ovl_dentry_is_opaque(struct dentry *dentry); 206c412ce49SMiklos Szeredi bool ovl_dentry_is_whiteout(struct dentry *dentry); 2075cf5b477SMiklos Szeredi void ovl_dentry_set_opaque(struct dentry *dentry); 208a6c60655SMiklos Szeredi bool ovl_redirect_dir(struct super_block *sb); 209a6c60655SMiklos Szeredi const char *ovl_dentry_get_redirect(struct dentry *dentry); 210a6c60655SMiklos Szeredi void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect); 211e9be9d5eSMiklos Szeredi void ovl_dentry_update(struct dentry *dentry, struct dentry *upperdentry); 212bbb1e54dSMiklos Szeredi void ovl_inode_init(struct inode *inode, struct inode *realinode, 213bbb1e54dSMiklos Szeredi bool is_upper); 21439b681f8SMiklos Szeredi void ovl_inode_update(struct inode *inode, struct inode *upperinode); 215bbb1e54dSMiklos Szeredi void ovl_dentry_version_inc(struct dentry *dentry); 216bbb1e54dSMiklos Szeredi u64 ovl_dentry_version_get(struct dentry *dentry); 217bbb1e54dSMiklos Szeredi bool ovl_is_whiteout(struct dentry *dentry); 218e9be9d5eSMiklos Szeredi struct file *ovl_path_open(struct path *path, int flags); 21939d3d60aSAmir Goldstein int ovl_copy_up_start(struct dentry *dentry); 22039d3d60aSAmir Goldstein void ovl_copy_up_end(struct dentry *dentry); 221e9be9d5eSMiklos Szeredi 222bbb1e54dSMiklos Szeredi /* namei.c */ 223bbb1e54dSMiklos Szeredi int ovl_path_next(int idx, struct dentry *dentry, struct path *path); 224bbb1e54dSMiklos Szeredi struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags); 225bbb1e54dSMiklos Szeredi bool ovl_lower_positive(struct dentry *dentry); 226e9be9d5eSMiklos Szeredi 227e9be9d5eSMiklos Szeredi /* readdir.c */ 228e9be9d5eSMiklos Szeredi extern const struct file_operations ovl_dir_operations; 229e9be9d5eSMiklos Szeredi int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list); 230e9be9d5eSMiklos Szeredi void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list); 231e9be9d5eSMiklos Szeredi void ovl_cache_free(struct list_head *list); 23245aebeafSVivek Goyal int ovl_check_d_type_supported(struct path *realpath); 233eea2fb48SMiklos Szeredi void ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt, 234eea2fb48SMiklos Szeredi struct dentry *dentry, int level); 235e9be9d5eSMiklos Szeredi 236e9be9d5eSMiklos Szeredi /* inode.c */ 237e9be9d5eSMiklos Szeredi int ovl_setattr(struct dentry *dentry, struct iattr *attr); 2385b712091SMiklos Szeredi int ovl_getattr(const struct path *path, struct kstat *stat, 2395b712091SMiklos Szeredi u32 request_mask, unsigned int flags); 240e9be9d5eSMiklos Szeredi int ovl_permission(struct inode *inode, int mask); 2410e585cccSAndreas Gruenbacher int ovl_xattr_set(struct dentry *dentry, const char *name, const void *value, 2423767e255SAl Viro size_t size, int flags); 2430eb45fc3SAndreas Gruenbacher int ovl_xattr_get(struct dentry *dentry, const char *name, 2440eb45fc3SAndreas Gruenbacher void *value, size_t size); 245e9be9d5eSMiklos Szeredi ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size); 24639a25b2bSVivek Goyal struct posix_acl *ovl_get_acl(struct inode *inode, int type); 2472d902671SMiklos Szeredi int ovl_open_maybe_copy_up(struct dentry *dentry, unsigned int file_flags); 248d719e8f2SMiklos Szeredi int ovl_update_time(struct inode *inode, struct timespec *ts, int flags); 2490956254aSMiklos Szeredi bool ovl_is_private_xattr(const char *name); 250e9be9d5eSMiklos Szeredi 251ca4c8a3aSMiklos Szeredi struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev); 25251f7e52dSMiklos Szeredi struct inode *ovl_get_inode(struct super_block *sb, struct inode *realinode); 253e9be9d5eSMiklos Szeredi static inline void ovl_copyattr(struct inode *from, struct inode *to) 254e9be9d5eSMiklos Szeredi { 255e9be9d5eSMiklos Szeredi to->i_uid = from->i_uid; 256e9be9d5eSMiklos Szeredi to->i_gid = from->i_gid; 25707a2daabSVivek Goyal to->i_mode = from->i_mode; 258d719e8f2SMiklos Szeredi to->i_atime = from->i_atime; 259d719e8f2SMiklos Szeredi to->i_mtime = from->i_mtime; 260d719e8f2SMiklos Szeredi to->i_ctime = from->i_ctime; 261e9be9d5eSMiklos Szeredi } 262e9be9d5eSMiklos Szeredi 263e9be9d5eSMiklos Szeredi /* dir.c */ 264e9be9d5eSMiklos Szeredi extern const struct inode_operations ovl_dir_inode_operations; 265*3d27573cSMiklos Szeredi struct dentry *ovl_lookup_temp(struct dentry *workdir); 26632a3d848SAl Viro struct cattr { 26732a3d848SAl Viro dev_t rdev; 26832a3d848SAl Viro umode_t mode; 26932a3d848SAl Viro const char *link; 27032a3d848SAl Viro }; 271e9be9d5eSMiklos Szeredi int ovl_create_real(struct inode *dir, struct dentry *newdentry, 27232a3d848SAl Viro struct cattr *attr, 273e9be9d5eSMiklos Szeredi struct dentry *hardlink, bool debug); 274e9be9d5eSMiklos Szeredi void ovl_cleanup(struct inode *dir, struct dentry *dentry); 275e9be9d5eSMiklos Szeredi 276e9be9d5eSMiklos Szeredi /* copy_up.c */ 277e9be9d5eSMiklos Szeredi int ovl_copy_up(struct dentry *dentry); 2789aba6521SAmir Goldstein int ovl_copy_up_flags(struct dentry *dentry, int flags); 279e9be9d5eSMiklos Szeredi int ovl_copy_xattr(struct dentry *old, struct dentry *new); 280e9be9d5eSMiklos Szeredi int ovl_set_attr(struct dentry *upper, struct kstat *stat); 28182b749b2SAmir Goldstein int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry, 28282b749b2SAmir Goldstein const char *name, const void *value, size_t size, 28382b749b2SAmir Goldstein int xerr); 284