fs/overlayfs/overlayfs.h

   1 /*
   2  *
   3  * Copyright (C) 2011 Novell Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  */
   9
  10 #include <linux/kernel.h>
  11 #include <linux/uuid.h>
  12
  13 enum ovl_path_type {
  14         __OVL_PATH_UPPER        = (1 << 0),
  15         __OVL_PATH_MERGE        = (1 << 1),
  16 };
  17
  18 #define OVL_TYPE_UPPER(type)    ((type) & __OVL_PATH_UPPER)
  19 #define OVL_TYPE_MERGE(type)    ((type) & __OVL_PATH_MERGE)
  20
  21 #define OVL_XATTR_PREFIX XATTR_TRUSTED_PREFIX "overlay."
  22 #define OVL_XATTR_OPAQUE OVL_XATTR_PREFIX "opaque"
  23 #define OVL_XATTR_REDIRECT OVL_XATTR_PREFIX "redirect"
  24 #define OVL_XATTR_ORIGIN OVL_XATTR_PREFIX "origin"
  25
  26 /*
  27  * The tuple (fh,uuid) is a universal unique identifier for a copy up origin,
  28  * where:
  29  * origin.fh    - exported file handle of the lower file
  30  * origin.uuid  - uuid of the lower filesystem
  31  */
  32 #define OVL_FH_VERSION  0
  33 #define OVL_FH_MAGIC    0xfb
  34
  35 /* CPU byte order required for fid decoding:  */
  36 #define OVL_FH_FLAG_BIG_ENDIAN  (1 << 0)
  37 #define OVL_FH_FLAG_ANY_ENDIAN  (1 << 1)
  38
  39 #define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN)
  40
  41 #if defined(__LITTLE_ENDIAN)
  42 #define OVL_FH_FLAG_CPU_ENDIAN 0
  43 #elif defined(__BIG_ENDIAN)
  44 #define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN
  45 #else
  46 #error Endianness not defined
  47 #endif
  48
  49 /* On-disk and in-memeory format for redirect by file handle */
  50 struct ovl_fh {
  51         u8 version;     /* 0 */
  52         u8 magic;       /* 0xfb */
  53         u8 len;         /* size of this header + size of fid */
  54         u8 flags;       /* OVL_FH_FLAG_* */
  55         u8 type;        /* fid_type of fid */
  56         uuid_be uuid;   /* uuid of filesystem */
  57         u8 fid[0];      /* file identifier */
  58 } __packed;
  59
  60 #define OVL_ISUPPER_MASK 1UL
  61
  62 static inline int ovl_do_rmdir(struct inode *dir, struct dentry *dentry)
  63 {
  64         int err = vfs_rmdir(dir, dentry);
  65         pr_debug("rmdir(%pd2) = %i\n", dentry, err);
  66         return err;
  67 }
  68
  69 static inline int ovl_do_unlink(struct inode *dir, struct dentry *dentry)
  70 {
  71         int err = vfs_unlink(dir, dentry, NULL);
  72         pr_debug("unlink(%pd2) = %i\n", dentry, err);
  73         return err;
  74 }
  75
  76 static inline int ovl_do_link(struct dentry *old_dentry, struct inode *dir,
  77                               struct dentry *new_dentry, bool debug)
  78 {
  79         int err = vfs_link(old_dentry, dir, new_dentry, NULL);
  80         if (debug) {
  81                 pr_debug("link(%pd2, %pd2) = %i\n",
  82                          old_dentry, new_dentry, err);
  83         }
  84         return err;
  85 }
  86
  87 static inline int ovl_do_create(struct inode *dir, struct dentry *dentry,
  88                              umode_t mode, bool debug)
  89 {
  90         int err = vfs_create(dir, dentry, mode, true);
  91         if (debug)
  92                 pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err);
  93         return err;
  94 }
  95
  96 static inline int ovl_do_mkdir(struct inode *dir, struct dentry *dentry,
  97                                umode_t mode, bool debug)
  98 {
  99         int err = vfs_mkdir(dir, dentry, mode);
 100         if (debug)
 101                 pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err);
 102         return err;
 103 }
 104
 105 static inline int ovl_do_mknod(struct inode *dir, struct dentry *dentry,
 106                                umode_t mode, dev_t dev, bool debug)
 107 {
 108         int err = vfs_mknod(dir, dentry, mode, dev);
 109         if (debug) {
 110                 pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n",
 111                          dentry, mode, dev, err);
 112         }
 113         return err;
 114 }
 115
 116 static inline int ovl_do_symlink(struct inode *dir, struct dentry *dentry,
 117                                  const char *oldname, bool debug)
 118 {
 119         int err = vfs_symlink(dir, dentry, oldname);
 120         if (debug)
 121                 pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err);
 122         return err;
 123 }
 124
 125 static inline int ovl_do_setxattr(struct dentry *dentry, const char *name,
 126                                   const void *value, size_t size, int flags)
 127 {
 128         int err = vfs_setxattr(dentry, name, value, size, flags);
 129         pr_debug("setxattr(%pd2, \"%s\", \"%*s\", 0x%x) = %i\n",
 130                  dentry, name, (int) size, (char *) value, flags, err);
 131         return err;
 132 }
 133
 134 static inline int ovl_do_removexattr(struct dentry *dentry, const char *name)
 135 {
 136         int err = vfs_removexattr(dentry, name);
 137         pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err);
 138         return err;
 139 }
 140
 141 static inline int ovl_do_rename(struct inode *olddir, struct dentry *olddentry,
 142                                 struct inode *newdir, struct dentry *newdentry,
 143                                 unsigned int flags)
 144 {
 145         int err;
 146
 147         pr_debug("rename(%pd2, %pd2, 0x%x)\n",
 148                  olddentry, newdentry, flags);
 149
 150         err = vfs_rename(olddir, olddentry, newdir, newdentry, NULL, flags);
 151
 152         if (err) {
 153                 pr_debug("...rename(%pd2, %pd2, ...) = %i\n",
 154                          olddentry, newdentry, err);
 155         }
 156         return err;
 157 }
 158
 159 static inline int ovl_do_whiteout(struct inode *dir, struct dentry *dentry)
 160 {
 161         int err = vfs_whiteout(dir, dentry);
 162         pr_debug("whiteout(%pd2) = %i\n", dentry, err);
 163         return err;
 164 }
 165
 166 static inline struct dentry *ovl_do_tmpfile(struct dentry *dentry, umode_t mode)
 167 {
 168         struct dentry *ret = vfs_tmpfile(dentry, mode, 0);
 169         int err = IS_ERR(ret) ? PTR_ERR(ret) : 0;
 170
 171         pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err);
 172         return ret;
 173 }
 174
 175 static inline struct inode *ovl_inode_real(struct inode *inode, bool *is_upper)
 176 {
 177         unsigned long x = (unsigned long) READ_ONCE(inode->i_private);
 178
 179         if (is_upper)
 180                 *is_upper = x & OVL_ISUPPER_MASK;
 181
 182         return (struct inode *) (x & ~OVL_ISUPPER_MASK);
 183 }
 184
 185 /* util.c */
 186 int ovl_want_write(struct dentry *dentry);
 187 void ovl_drop_write(struct dentry *dentry);
 188 struct dentry *ovl_workdir(struct dentry *dentry);
 189 const struct cred *ovl_override_creds(struct super_block *sb);
 190 struct super_block *ovl_same_sb(struct super_block *sb);
 191 struct ovl_entry *ovl_alloc_entry(unsigned int numlower);
 192 bool ovl_dentry_remote(struct dentry *dentry);
 193 bool ovl_dentry_weird(struct dentry *dentry);
 194 enum ovl_path_type ovl_path_type(struct dentry *dentry);
 195 void ovl_path_upper(struct dentry *dentry, struct path *path);
 196 void ovl_path_lower(struct dentry *dentry, struct path *path);
 197 enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path);
 198 struct dentry *ovl_dentry_upper(struct dentry *dentry);
 199 struct dentry *ovl_dentry_lower(struct dentry *dentry);
 200 struct dentry *ovl_dentry_real(struct dentry *dentry);
 201 struct ovl_dir_cache *ovl_dir_cache(struct dentry *dentry);
 202 void ovl_set_dir_cache(struct dentry *dentry, struct ovl_dir_cache *cache);
 203 bool ovl_dentry_is_opaque(struct dentry *dentry);
 204 bool ovl_dentry_is_whiteout(struct dentry *dentry);
 205 void ovl_dentry_set_opaque(struct dentry *dentry);
 206 bool ovl_redirect_dir(struct super_block *sb);
 207 void ovl_clear_redirect_dir(struct super_block *sb);
 208 const char *ovl_dentry_get_redirect(struct dentry *dentry);
 209 void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect);
 210 void ovl_dentry_update(struct dentry *dentry, struct dentry *upperdentry);
 211 void ovl_inode_init(struct inode *inode, struct inode *realinode,
 212                     bool is_upper);
 213 void ovl_inode_update(struct inode *inode, struct inode *upperinode);
 214 void ovl_dentry_version_inc(struct dentry *dentry);
 215 u64 ovl_dentry_version_get(struct dentry *dentry);
 216 bool ovl_is_whiteout(struct dentry *dentry);
 217 struct file *ovl_path_open(struct path *path, int flags);
 218 int ovl_copy_up_start(struct dentry *dentry);
 219 void ovl_copy_up_end(struct dentry *dentry);
 220
 221 /* namei.c */
 222 int ovl_path_next(int idx, struct dentry *dentry, struct path *path);
 223 struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags);
 224 bool ovl_lower_positive(struct dentry *dentry);
 225
 226 /* readdir.c */
 227 extern const struct file_operations ovl_dir_operations;
 228 int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list);
 229 void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list);
 230 void ovl_cache_free(struct list_head *list);
 231 int ovl_check_d_type_supported(struct path *realpath);
 232 void ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt,
 233                          struct dentry *dentry, int level);
 234
 235 /* inode.c */
 236 int ovl_setattr(struct dentry *dentry, struct iattr *attr);
 237 int ovl_permission(struct inode *inode, int mask);
 238 int ovl_xattr_set(struct dentry *dentry, const char *name, const void *value,
 239                   size_t size, int flags);
 240 int ovl_xattr_get(struct dentry *dentry, const char *name,
 241                   void *value, size_t size);
 242 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size);
 243 struct posix_acl *ovl_get_acl(struct inode *inode, int type);
 244 int ovl_open_maybe_copy_up(struct dentry *dentry, unsigned int file_flags);
 245 int ovl_update_time(struct inode *inode, struct timespec *ts, int flags);
 246 bool ovl_is_private_xattr(const char *name);
 247
 248 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev);
 249 struct inode *ovl_get_inode(struct super_block *sb, struct inode *realinode);
 250 static inline void ovl_copyattr(struct inode *from, struct inode *to)
 251 {
 252         to->i_uid = from->i_uid;
 253         to->i_gid = from->i_gid;
 254         to->i_mode = from->i_mode;
 255         to->i_atime = from->i_atime;
 256         to->i_mtime = from->i_mtime;
 257         to->i_ctime = from->i_ctime;
 258 }
 259
 260 /* dir.c */
 261 extern const struct inode_operations ovl_dir_inode_operations;
 262 struct dentry *ovl_lookup_temp(struct dentry *workdir, struct dentry *dentry);
 263 struct cattr {
 264         dev_t rdev;
 265         umode_t mode;
 266         const char *link;
 267 };
 268 int ovl_create_real(struct inode *dir, struct dentry *newdentry,
 269                     struct cattr *attr,
 270                     struct dentry *hardlink, bool debug);
 271 void ovl_cleanup(struct inode *dir, struct dentry *dentry);
 272
 273 /* copy_up.c */
 274 int ovl_copy_up(struct dentry *dentry);
 275 int ovl_copy_up_flags(struct dentry *dentry, int flags);
 276 int ovl_copy_xattr(struct dentry *old, struct dentry *new);
 277 int ovl_set_attr(struct dentry *upper, struct kstat *stat);