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 #include <linux/fs.h>
  13 #include "ovl_entry.h"
  14
  15 enum ovl_path_type {
  16         __OVL_PATH_UPPER        = (1 << 0),
  17         __OVL_PATH_MERGE        = (1 << 1),
  18         __OVL_PATH_ORIGIN       = (1 << 2),
  19 };
  20
  21 #define OVL_TYPE_UPPER(type)    ((type) & __OVL_PATH_UPPER)
  22 #define OVL_TYPE_MERGE(type)    ((type) & __OVL_PATH_MERGE)
  23 #define OVL_TYPE_ORIGIN(type)   ((type) & __OVL_PATH_ORIGIN)
  24
  25 #define OVL_XATTR_PREFIX XATTR_TRUSTED_PREFIX "overlay."
  26 #define OVL_XATTR_OPAQUE OVL_XATTR_PREFIX "opaque"
  27 #define OVL_XATTR_REDIRECT OVL_XATTR_PREFIX "redirect"
  28 #define OVL_XATTR_ORIGIN OVL_XATTR_PREFIX "origin"
  29 #define OVL_XATTR_IMPURE OVL_XATTR_PREFIX "impure"
  30 #define OVL_XATTR_NLINK OVL_XATTR_PREFIX "nlink"
  31 #define OVL_XATTR_UPPER OVL_XATTR_PREFIX "upper"
  32
  33 enum ovl_inode_flag {
  34         /* Pure upper dir that may contain non pure upper entries */
  35         OVL_IMPURE,
  36         /* Non-merge dir that may contain whiteout entries */
  37         OVL_WHITEOUTS,
  38         OVL_INDEX,
  39 };
  40
  41 enum ovl_entry_flag {
  42         OVL_E_UPPER_ALIAS,
  43         OVL_E_OPAQUE,
  44         OVL_E_CONNECTED,
  45 };
  46
  47 /*
  48  * The tuple (fh,uuid) is a universal unique identifier for a copy up origin,
  49  * where:
  50  * origin.fh    - exported file handle of the lower file
  51  * origin.uuid  - uuid of the lower filesystem
  52  */
  53 #define OVL_FH_VERSION  0
  54 #define OVL_FH_MAGIC    0xfb
  55
  56 /* CPU byte order required for fid decoding:  */
  57 #define OVL_FH_FLAG_BIG_ENDIAN  (1 << 0)
  58 #define OVL_FH_FLAG_ANY_ENDIAN  (1 << 1)
  59 /* Is the real inode encoded in fid an upper inode? */
  60 #define OVL_FH_FLAG_PATH_UPPER  (1 << 2)
  61
  62 #define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN | \
  63                          OVL_FH_FLAG_PATH_UPPER)
  64
  65 #if defined(__LITTLE_ENDIAN)
  66 #define OVL_FH_FLAG_CPU_ENDIAN 0
  67 #elif defined(__BIG_ENDIAN)
  68 #define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN
  69 #else
  70 #error Endianness not defined
  71 #endif
  72
  73 /* The type returned by overlay exportfs ops when encoding an ovl_fh handle */
  74 #define OVL_FILEID      0xfb
  75
  76 /* On-disk and in-memeory format for redirect by file handle */
  77 struct ovl_fh {
  78         u8 version;     /* 0 */
  79         u8 magic;       /* 0xfb */
  80         u8 len;         /* size of this header + size of fid */
  81         u8 flags;       /* OVL_FH_FLAG_* */
  82         u8 type;        /* fid_type of fid */
  83         uuid_t uuid;    /* uuid of filesystem */
  84         u8 fid[0];      /* file identifier */
  85 } __packed;
  86
  87 static inline int ovl_do_rmdir(struct inode *dir, struct dentry *dentry)
  88 {
  89         int err = vfs_rmdir(dir, dentry);
  90
  91         pr_debug("rmdir(%pd2) = %i\n", dentry, err);
  92         return err;
  93 }
  94
  95 static inline int ovl_do_unlink(struct inode *dir, struct dentry *dentry)
  96 {
  97         int err = vfs_unlink(dir, dentry, NULL);
  98
  99         pr_debug("unlink(%pd2) = %i\n", dentry, err);
 100         return err;
 101 }
 102
 103 static inline int ovl_do_link(struct dentry *old_dentry, struct inode *dir,
 104                               struct dentry *new_dentry)
 105 {
 106         int err = vfs_link(old_dentry, dir, new_dentry, NULL);
 107
 108         pr_debug("link(%pd2, %pd2) = %i\n", old_dentry, new_dentry, err);
 109         return err;
 110 }
 111
 112 static inline int ovl_do_create(struct inode *dir, struct dentry *dentry,
 113                                 umode_t mode)
 114 {
 115         int err = vfs_create(dir, dentry, mode, true);
 116
 117         pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err);
 118         return err;
 119 }
 120
 121 static inline int ovl_do_mkdir(struct inode *dir, struct dentry *dentry,
 122                                umode_t mode)
 123 {
 124         int err = vfs_mkdir(dir, dentry, mode);
 125         pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err);
 126         return err;
 127 }
 128
 129 static inline int ovl_do_mknod(struct inode *dir, struct dentry *dentry,
 130                                umode_t mode, dev_t dev)
 131 {
 132         int err = vfs_mknod(dir, dentry, mode, dev);
 133
 134         pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", dentry, mode, dev, err);
 135         return err;
 136 }
 137
 138 static inline int ovl_do_symlink(struct inode *dir, struct dentry *dentry,
 139                                  const char *oldname)
 140 {
 141         int err = vfs_symlink(dir, dentry, oldname);
 142
 143         pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err);
 144         return err;
 145 }
 146
 147 static inline int ovl_do_setxattr(struct dentry *dentry, const char *name,
 148                                   const void *value, size_t size, int flags)
 149 {
 150         int err = vfs_setxattr(dentry, name, value, size, flags);
 151         pr_debug("setxattr(%pd2, \"%s\", \"%*s\", 0x%x) = %i\n",
 152                  dentry, name, (int) size, (char *) value, flags, err);
 153         return err;
 154 }
 155
 156 static inline int ovl_do_removexattr(struct dentry *dentry, const char *name)
 157 {
 158         int err = vfs_removexattr(dentry, name);
 159         pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err);
 160         return err;
 161 }
 162
 163 static inline int ovl_do_rename(struct inode *olddir, struct dentry *olddentry,
 164                                 struct inode *newdir, struct dentry *newdentry,
 165                                 unsigned int flags)
 166 {
 167         int err;
 168
 169         pr_debug("rename(%pd2, %pd2, 0x%x)\n", olddentry, newdentry, flags);
 170         err = vfs_rename(olddir, olddentry, newdir, newdentry, NULL, flags);
 171         if (err) {
 172                 pr_debug("...rename(%pd2, %pd2, ...) = %i\n",
 173                          olddentry, newdentry, err);
 174         }
 175         return err;
 176 }
 177
 178 static inline int ovl_do_whiteout(struct inode *dir, struct dentry *dentry)
 179 {
 180         int err = vfs_whiteout(dir, dentry);
 181         pr_debug("whiteout(%pd2) = %i\n", dentry, err);
 182         return err;
 183 }
 184
 185 static inline struct dentry *ovl_do_tmpfile(struct dentry *dentry, umode_t mode)
 186 {
 187         struct dentry *ret = vfs_tmpfile(dentry, mode, 0);
 188         int err = PTR_ERR_OR_ZERO(ret);
 189
 190         pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err);
 191         return ret;
 192 }
 193
 194 /* util.c */
 195 int ovl_want_write(struct dentry *dentry);
 196 void ovl_drop_write(struct dentry *dentry);
 197 struct dentry *ovl_workdir(struct dentry *dentry);
 198 const struct cred *ovl_override_creds(struct super_block *sb);
 199 struct super_block *ovl_same_sb(struct super_block *sb);
 200 int ovl_can_decode_fh(struct super_block *sb);
 201 struct dentry *ovl_indexdir(struct super_block *sb);
 202 bool ovl_index_all(struct super_block *sb);
 203 bool ovl_verify_lower(struct super_block *sb);
 204 struct ovl_entry *ovl_alloc_entry(unsigned int numlower);
 205 bool ovl_dentry_remote(struct dentry *dentry);
 206 bool ovl_dentry_weird(struct dentry *dentry);
 207 enum ovl_path_type ovl_path_type(struct dentry *dentry);
 208 void ovl_path_upper(struct dentry *dentry, struct path *path);
 209 void ovl_path_lower(struct dentry *dentry, struct path *path);
 210 enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path);
 211 struct dentry *ovl_dentry_upper(struct dentry *dentry);
 212 struct dentry *ovl_dentry_lower(struct dentry *dentry);
 213 struct ovl_layer *ovl_layer_lower(struct dentry *dentry);
 214 struct dentry *ovl_dentry_real(struct dentry *dentry);
 215 struct dentry *ovl_i_dentry_upper(struct inode *inode);
 216 struct inode *ovl_inode_upper(struct inode *inode);
 217 struct inode *ovl_inode_lower(struct inode *inode);
 218 struct inode *ovl_inode_real(struct inode *inode);
 219 struct ovl_dir_cache *ovl_dir_cache(struct inode *inode);
 220 void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache);
 221 void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry);
 222 void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry);
 223 bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry);
 224 bool ovl_dentry_is_opaque(struct dentry *dentry);
 225 bool ovl_dentry_is_whiteout(struct dentry *dentry);
 226 void ovl_dentry_set_opaque(struct dentry *dentry);
 227 bool ovl_dentry_has_upper_alias(struct dentry *dentry);
 228 void ovl_dentry_set_upper_alias(struct dentry *dentry);
 229 bool ovl_redirect_dir(struct super_block *sb);
 230 const char *ovl_dentry_get_redirect(struct dentry *dentry);
 231 void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect);
 232 void ovl_inode_init(struct inode *inode, struct dentry *upperdentry,
 233                     struct dentry *lowerdentry);
 234 void ovl_inode_update(struct inode *inode, struct dentry *upperdentry);
 235 void ovl_dir_modified(struct dentry *dentry, bool impurity);
 236 u64 ovl_dentry_version_get(struct dentry *dentry);
 237 bool ovl_is_whiteout(struct dentry *dentry);
 238 struct file *ovl_path_open(struct path *path, int flags);
 239 int ovl_copy_up_start(struct dentry *dentry);
 240 void ovl_copy_up_end(struct dentry *dentry);
 241 bool ovl_already_copied_up(struct dentry *dentry);
 242 bool ovl_check_origin_xattr(struct dentry *dentry);
 243 bool ovl_check_dir_xattr(struct dentry *dentry, const char *name);
 244 int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry,
 245                        const char *name, const void *value, size_t size,
 246                        int xerr);
 247 int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry);
 248 void ovl_set_flag(unsigned long flag, struct inode *inode);
 249 void ovl_clear_flag(unsigned long flag, struct inode *inode);
 250 bool ovl_test_flag(unsigned long flag, struct inode *inode);
 251 bool ovl_inuse_trylock(struct dentry *dentry);
 252 void ovl_inuse_unlock(struct dentry *dentry);
 253 bool ovl_need_index(struct dentry *dentry);
 254 int ovl_nlink_start(struct dentry *dentry, bool *locked);
 255 void ovl_nlink_end(struct dentry *dentry, bool locked);
 256 int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir);
 257
 258 static inline bool ovl_is_impuredir(struct dentry *dentry)
 259 {
 260         return ovl_check_dir_xattr(dentry, OVL_XATTR_IMPURE);
 261 }
 262
 263 static inline unsigned int ovl_xino_bits(struct super_block *sb)
 264 {
 265         struct ovl_fs *ofs = sb->s_fs_info;
 266
 267         return ofs->xino_bits;
 268 }
 269
 270
 271 /* namei.c */
 272 int ovl_check_fh_len(struct ovl_fh *fh, int fh_len);
 273 struct dentry *ovl_decode_real_fh(struct ovl_fh *fh, struct vfsmount *mnt,
 274                                   bool connected);
 275 int ovl_check_origin_fh(struct ovl_fs *ofs, struct ovl_fh *fh, bool connected,
 276                         struct dentry *upperdentry, struct ovl_path **stackp);
 277 int ovl_verify_set_fh(struct dentry *dentry, const char *name,
 278                       struct dentry *real, bool is_upper, bool set);
 279 struct dentry *ovl_index_upper(struct ovl_fs *ofs, struct dentry *index);
 280 int ovl_verify_index(struct ovl_fs *ofs, struct dentry *index);
 281 int ovl_get_index_name(struct dentry *origin, struct qstr *name);
 282 struct dentry *ovl_get_index_fh(struct ovl_fs *ofs, struct ovl_fh *fh);
 283 struct dentry *ovl_lookup_index(struct ovl_fs *ofs, struct dentry *upper,
 284                                 struct dentry *origin, bool verify);
 285 int ovl_path_next(int idx, struct dentry *dentry, struct path *path);
 286 struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
 287                           unsigned int flags);
 288 bool ovl_lower_positive(struct dentry *dentry);
 289
 290 static inline int ovl_verify_origin(struct dentry *upper,
 291                                     struct dentry *origin, bool set)
 292 {
 293         return ovl_verify_set_fh(upper, OVL_XATTR_ORIGIN, origin, false, set);
 294 }
 295
 296 static inline int ovl_verify_upper(struct dentry *index,
 297                                     struct dentry *upper, bool set)
 298 {
 299         return ovl_verify_set_fh(index, OVL_XATTR_UPPER, upper, true, set);
 300 }
 301
 302 /* readdir.c */
 303 extern const struct file_operations ovl_dir_operations;
 304 int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list);
 305 void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list);
 306 void ovl_cache_free(struct list_head *list);
 307 void ovl_dir_cache_free(struct inode *inode);
 308 int ovl_check_d_type_supported(struct path *realpath);
 309 void ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt,
 310                          struct dentry *dentry, int level);
 311 int ovl_indexdir_cleanup(struct ovl_fs *ofs);
 312
 313 /* inode.c */
 314 int ovl_set_nlink_upper(struct dentry *dentry);
 315 int ovl_set_nlink_lower(struct dentry *dentry);
 316 unsigned int ovl_get_nlink(struct dentry *lowerdentry,
 317                            struct dentry *upperdentry,
 318                            unsigned int fallback);
 319 int ovl_setattr(struct dentry *dentry, struct iattr *attr);
 320 int ovl_getattr(const struct path *path, struct kstat *stat,
 321                 u32 request_mask, unsigned int flags);
 322 int ovl_permission(struct inode *inode, int mask);
 323 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
 324                   const void *value, size_t size, int flags);
 325 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
 326                   void *value, size_t size);
 327 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size);
 328 struct posix_acl *ovl_get_acl(struct inode *inode, int type);
 329 int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags);
 330 bool ovl_is_private_xattr(const char *name);
 331
 332 struct ovl_inode_params {
 333         struct inode *newinode;
 334         struct dentry *upperdentry;
 335         struct ovl_path *lowerpath;
 336         struct dentry *index;
 337         unsigned int numlower;
 338         char *redirect;
 339 };
 340 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev);
 341 struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
 342                                bool is_upper);
 343 struct inode *ovl_get_inode(struct super_block *sb,
 344                             struct ovl_inode_params *oip);
 345 static inline void ovl_copyattr(struct inode *from, struct inode *to)
 346 {
 347         to->i_uid = from->i_uid;
 348         to->i_gid = from->i_gid;
 349         to->i_mode = from->i_mode;
 350         to->i_atime = from->i_atime;
 351         to->i_mtime = from->i_mtime;
 352         to->i_ctime = from->i_ctime;
 353         i_size_write(to, i_size_read(from));
 354 }
 355
 356 static inline void ovl_copyflags(struct inode *from, struct inode *to)
 357 {
 358         unsigned int mask = S_SYNC | S_IMMUTABLE | S_APPEND | S_NOATIME;
 359
 360         inode_set_flags(to, from->i_flags & mask, mask);
 361 }
 362
 363 /* dir.c */
 364 extern const struct inode_operations ovl_dir_inode_operations;
 365 int ovl_cleanup_and_whiteout(struct dentry *workdir, struct inode *dir,
 366                              struct dentry *dentry);
 367 struct ovl_cattr {
 368         dev_t rdev;
 369         umode_t mode;
 370         const char *link;
 371         struct dentry *hardlink;
 372 };
 373
 374 #define OVL_CATTR(m) (&(struct ovl_cattr) { .mode = (m) })
 375
 376 struct dentry *ovl_create_real(struct inode *dir, struct dentry *newdentry,
 377                                struct ovl_cattr *attr);
 378 int ovl_cleanup(struct inode *dir, struct dentry *dentry);
 379 struct dentry *ovl_create_temp(struct dentry *workdir, struct ovl_cattr *attr);
 380
 381 /* file.c */
 382 extern const struct file_operations ovl_file_operations;
 383
 384 /* copy_up.c */
 385 int ovl_copy_up(struct dentry *dentry);
 386 int ovl_copy_up_flags(struct dentry *dentry, int flags);
 387 int ovl_open_maybe_copy_up(struct dentry *dentry, unsigned int file_flags);
 388 int ovl_copy_xattr(struct dentry *old, struct dentry *new);
 389 int ovl_set_attr(struct dentry *upper, struct kstat *stat);
 390 struct ovl_fh *ovl_encode_real_fh(struct dentry *real, bool is_upper);
 391 int ovl_set_origin(struct dentry *dentry, struct dentry *lower,
 392                    struct dentry *upper);
 393
 394 /* export.c */
 395 extern const struct export_operations ovl_export_operations;