fs/overlayfs/overlayfs.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  *
   4  * Copyright (C) 2011 Novell Inc.
   5  */
   6
   7 #include <linux/kernel.h>
   8 #include <linux/uuid.h>
   9 #include <linux/fs.h>
  10 #include <linux/namei.h>
  11 #include "ovl_entry.h"
  12
  13 #undef pr_fmt
  14 #define pr_fmt(fmt) "overlayfs: " fmt
  15
  16 enum ovl_path_type {
  17         __OVL_PATH_UPPER        = (1 << 0),
  18         __OVL_PATH_MERGE        = (1 << 1),
  19         __OVL_PATH_ORIGIN       = (1 << 2),
  20 };
  21
  22 #define OVL_TYPE_UPPER(type)    ((type) & __OVL_PATH_UPPER)
  23 #define OVL_TYPE_MERGE(type)    ((type) & __OVL_PATH_MERGE)
  24 #define OVL_TYPE_ORIGIN(type)   ((type) & __OVL_PATH_ORIGIN)
  25
  26 #define OVL_XATTR_NAMESPACE "overlay."
  27 #define OVL_XATTR_TRUSTED_PREFIX XATTR_TRUSTED_PREFIX OVL_XATTR_NAMESPACE
  28 #define OVL_XATTR_USER_PREFIX XATTR_USER_PREFIX OVL_XATTR_NAMESPACE
  29
  30 enum ovl_xattr {
  31         OVL_XATTR_OPAQUE,
  32         OVL_XATTR_REDIRECT,
  33         OVL_XATTR_ORIGIN,
  34         OVL_XATTR_IMPURE,
  35         OVL_XATTR_NLINK,
  36         OVL_XATTR_UPPER,
  37         OVL_XATTR_METACOPY,
  38         OVL_XATTR_PROTATTR,
  39 };
  40
  41 enum ovl_inode_flag {
  42         /* Pure upper dir that may contain non pure upper entries */
  43         OVL_IMPURE,
  44         /* Non-merge dir that may contain whiteout entries */
  45         OVL_WHITEOUTS,
  46         OVL_INDEX,
  47         OVL_UPPERDATA,
  48         /* Inode number will remain constant over copy up. */
  49         OVL_CONST_INO,
  50 };
  51
  52 enum ovl_entry_flag {
  53         OVL_E_UPPER_ALIAS,
  54         OVL_E_OPAQUE,
  55         OVL_E_CONNECTED,
  56 };
  57
  58 enum {
  59         OVL_XINO_OFF,
  60         OVL_XINO_AUTO,
  61         OVL_XINO_ON,
  62 };
  63
  64 /*
  65  * The tuple (fh,uuid) is a universal unique identifier for a copy up origin,
  66  * where:
  67  * origin.fh    - exported file handle of the lower file
  68  * origin.uuid  - uuid of the lower filesystem
  69  */
  70 #define OVL_FH_VERSION  0
  71 #define OVL_FH_MAGIC    0xfb
  72
  73 /* CPU byte order required for fid decoding:  */
  74 #define OVL_FH_FLAG_BIG_ENDIAN  (1 << 0)
  75 #define OVL_FH_FLAG_ANY_ENDIAN  (1 << 1)
  76 /* Is the real inode encoded in fid an upper inode? */
  77 #define OVL_FH_FLAG_PATH_UPPER  (1 << 2)
  78
  79 #define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN | \
  80                          OVL_FH_FLAG_PATH_UPPER)
  81
  82 #if defined(__LITTLE_ENDIAN)
  83 #define OVL_FH_FLAG_CPU_ENDIAN 0
  84 #elif defined(__BIG_ENDIAN)
  85 #define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN
  86 #else
  87 #error Endianness not defined
  88 #endif
  89
  90 /* The type used to be returned by overlay exportfs for misaligned fid */
  91 #define OVL_FILEID_V0   0xfb
  92 /* The type returned by overlay exportfs for 32bit aligned fid */
  93 #define OVL_FILEID_V1   0xf8
  94
  95 /* On-disk format for "origin" file handle */
  96 struct ovl_fb {
  97         u8 version;     /* 0 */
  98         u8 magic;       /* 0xfb */
  99         u8 len;         /* size of this header + size of fid */
 100         u8 flags;       /* OVL_FH_FLAG_* */
 101         u8 type;        /* fid_type of fid */
 102         uuid_t uuid;    /* uuid of filesystem */
 103         u32 fid[];      /* file identifier should be 32bit aligned in-memory */
 104 } __packed;
 105
 106 /* In-memory and on-wire format for overlay file handle */
 107 struct ovl_fh {
 108         u8 padding[3];  /* make sure fb.fid is 32bit aligned */
 109         union {
 110                 struct ovl_fb fb;
 111                 u8 buf[0];
 112         };
 113 } __packed;
 114
 115 #define OVL_FH_WIRE_OFFSET      offsetof(struct ovl_fh, fb)
 116 #define OVL_FH_LEN(fh)          (OVL_FH_WIRE_OFFSET + (fh)->fb.len)
 117 #define OVL_FH_FID_OFFSET       (OVL_FH_WIRE_OFFSET + \
 118                                  offsetof(struct ovl_fb, fid))
 119
 120 extern const char *const ovl_xattr_table[][2];
 121 static inline const char *ovl_xattr(struct ovl_fs *ofs, enum ovl_xattr ox)
 122 {
 123         return ovl_xattr_table[ox][ofs->config.userxattr];
 124 }
 125
 126 /*
 127  * When changing ownership of an upper object map the intended ownership
 128  * according to the upper layer's idmapping. When an upper mount idmaps files
 129  * that are stored on-disk as owned by id 1001 to id 1000 this means stat on
 130  * this object will report it as being owned by id 1000 when calling stat via
 131  * the upper mount.
 132  * In order to change ownership of an object so stat reports id 1000 when
 133  * called on an idmapped upper mount the value written to disk - i.e., the
 134  * value stored in ia_*id - must 1001. The mount mapping helper will thus take
 135  * care to map 1000 to 1001.
 136  * The mnt idmapping helpers are nops if the upper layer isn't idmapped.
 137  */
 138 static inline int ovl_do_notify_change(struct ovl_fs *ofs,
 139                                        struct dentry *upperdentry,
 140                                        struct iattr *attr)
 141 {
 142         struct user_namespace *upper_mnt_userns = ovl_upper_mnt_userns(ofs);
 143         struct user_namespace *fs_userns = i_user_ns(d_inode(upperdentry));
 144
 145         if (attr->ia_valid & ATTR_UID)
 146                 attr->ia_uid = mapped_kuid_user(upper_mnt_userns,
 147                                                 fs_userns, attr->ia_uid);
 148         if (attr->ia_valid & ATTR_GID)
 149                 attr->ia_gid = mapped_kgid_user(upper_mnt_userns,
 150                                                 fs_userns, attr->ia_gid);
 151
 152         return notify_change(upper_mnt_userns, upperdentry, attr, NULL);
 153 }
 154
 155 static inline int ovl_do_rmdir(struct ovl_fs *ofs,
 156                                struct inode *dir, struct dentry *dentry)
 157 {
 158         int err = vfs_rmdir(ovl_upper_mnt_userns(ofs), dir, dentry);
 159
 160         pr_debug("rmdir(%pd2) = %i\n", dentry, err);
 161         return err;
 162 }
 163
 164 static inline int ovl_do_unlink(struct ovl_fs *ofs, struct inode *dir,
 165                                 struct dentry *dentry)
 166 {
 167         int err = vfs_unlink(ovl_upper_mnt_userns(ofs), dir, dentry, NULL);
 168
 169         pr_debug("unlink(%pd2) = %i\n", dentry, err);
 170         return err;
 171 }
 172
 173 static inline int ovl_do_link(struct ovl_fs *ofs, struct dentry *old_dentry,
 174                               struct inode *dir, struct dentry *new_dentry)
 175 {
 176         int err = vfs_link(old_dentry, ovl_upper_mnt_userns(ofs), dir, new_dentry, NULL);
 177
 178         pr_debug("link(%pd2, %pd2) = %i\n", old_dentry, new_dentry, err);
 179         return err;
 180 }
 181
 182 static inline int ovl_do_create(struct ovl_fs *ofs,
 183                                 struct inode *dir, struct dentry *dentry,
 184                                 umode_t mode)
 185 {
 186         int err = vfs_create(ovl_upper_mnt_userns(ofs), dir, dentry, mode, true);
 187
 188         pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err);
 189         return err;
 190 }
 191
 192 static inline int ovl_do_mkdir(struct ovl_fs *ofs,
 193                                struct inode *dir, struct dentry *dentry,
 194                                umode_t mode)
 195 {
 196         int err = vfs_mkdir(ovl_upper_mnt_userns(ofs), dir, dentry, mode);
 197         pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err);
 198         return err;
 199 }
 200
 201 static inline int ovl_do_mknod(struct ovl_fs *ofs,
 202                                struct inode *dir, struct dentry *dentry,
 203                                umode_t mode, dev_t dev)
 204 {
 205         int err = vfs_mknod(ovl_upper_mnt_userns(ofs), dir, dentry, mode, dev);
 206
 207         pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", dentry, mode, dev, err);
 208         return err;
 209 }
 210
 211 static inline int ovl_do_symlink(struct ovl_fs *ofs,
 212                                  struct inode *dir, struct dentry *dentry,
 213                                  const char *oldname)
 214 {
 215         int err = vfs_symlink(ovl_upper_mnt_userns(ofs), dir, dentry, oldname);
 216
 217         pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err);
 218         return err;
 219 }
 220
 221 static inline ssize_t ovl_do_getxattr(struct ovl_fs *ofs, struct dentry *dentry,
 222                                       const char *name, void *value,
 223                                       size_t size)
 224 {
 225         int err = vfs_getxattr(&init_user_ns, dentry, name, value, size);
 226         int len = (value && err > 0) ? err : 0;
 227
 228         pr_debug("getxattr(%pd2, \"%s\", \"%*pE\", %zu, 0) = %i\n",
 229                  dentry, name, min(len, 48), value, size, err);
 230         return err;
 231 }
 232
 233 static inline ssize_t ovl_getxattr(struct ovl_fs *ofs, struct dentry *dentry,
 234                                    enum ovl_xattr ox, void *value,
 235                                    size_t size)
 236 {
 237         return ovl_do_getxattr(ofs, dentry, ovl_xattr(ofs, ox), value, size);
 238 }
 239
 240 static inline int ovl_do_setxattr(struct ovl_fs *ofs, struct dentry *dentry,
 241                                   const char *name, const void *value,
 242                                   size_t size, int flags)
 243 {
 244         int err = vfs_setxattr(&init_user_ns, dentry, name, value, size, flags);
 245
 246         pr_debug("setxattr(%pd2, \"%s\", \"%*pE\", %zu, %d) = %i\n",
 247                  dentry, name, min((int)size, 48), value, size, flags, err);
 248         return err;
 249 }
 250
 251 static inline int ovl_setxattr(struct ovl_fs *ofs, struct dentry *dentry,
 252                                enum ovl_xattr ox, const void *value,
 253                                size_t size)
 254 {
 255         return ovl_do_setxattr(ofs, dentry, ovl_xattr(ofs, ox), value, size, 0);
 256 }
 257
 258 static inline int ovl_do_removexattr(struct ovl_fs *ofs, struct dentry *dentry,
 259                                      const char *name)
 260 {
 261         int err = vfs_removexattr(&init_user_ns, dentry, name);
 262         pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err);
 263         return err;
 264 }
 265
 266 static inline int ovl_removexattr(struct ovl_fs *ofs, struct dentry *dentry,
 267                                   enum ovl_xattr ox)
 268 {
 269         return ovl_do_removexattr(ofs, dentry, ovl_xattr(ofs, ox));
 270 }
 271
 272 static inline int ovl_do_rename(struct ovl_fs *ofs, struct inode *olddir,
 273                                 struct dentry *olddentry, struct inode *newdir,
 274                                 struct dentry *newdentry, unsigned int flags)
 275 {
 276         int err;
 277         struct renamedata rd = {
 278                 .old_mnt_userns = ovl_upper_mnt_userns(ofs),
 279                 .old_dir        = olddir,
 280                 .old_dentry     = olddentry,
 281                 .new_mnt_userns = ovl_upper_mnt_userns(ofs),
 282                 .new_dir        = newdir,
 283                 .new_dentry     = newdentry,
 284                 .flags          = flags,
 285         };
 286
 287         pr_debug("rename(%pd2, %pd2, 0x%x)\n", olddentry, newdentry, flags);
 288         err = vfs_rename(&rd);
 289         if (err) {
 290                 pr_debug("...rename(%pd2, %pd2, ...) = %i\n",
 291                          olddentry, newdentry, err);
 292         }
 293         return err;
 294 }
 295
 296 static inline int ovl_do_whiteout(struct ovl_fs *ofs,
 297                                   struct inode *dir, struct dentry *dentry)
 298 {
 299         int err = vfs_whiteout(ovl_upper_mnt_userns(ofs), dir, dentry);
 300         pr_debug("whiteout(%pd2) = %i\n", dentry, err);
 301         return err;
 302 }
 303
 304 static inline struct dentry *ovl_do_tmpfile(struct ovl_fs *ofs,
 305                                             struct dentry *dentry, umode_t mode)
 306 {
 307         struct dentry *ret = vfs_tmpfile(ovl_upper_mnt_userns(ofs), dentry, mode, 0);
 308         int err = PTR_ERR_OR_ZERO(ret);
 309
 310         pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err);
 311         return ret;
 312 }
 313
 314 static inline struct dentry *ovl_lookup_upper(struct ovl_fs *ofs,
 315                                               const char *name,
 316                                               struct dentry *base, int len)
 317 {
 318         return lookup_one(ovl_upper_mnt_userns(ofs), name, base, len);
 319 }
 320
 321 static inline bool ovl_open_flags_need_copy_up(int flags)
 322 {
 323         if (!flags)
 324                 return false;
 325
 326         return ((OPEN_FMODE(flags) & FMODE_WRITE) || (flags & O_TRUNC));
 327 }
 328
 329 static inline bool ovl_allow_offline_changes(struct ovl_fs *ofs)
 330 {
 331         /*
 332          * To avoid regressions in existing setups with overlay lower offline
 333          * changes, we allow lower changes only if none of the new features
 334          * are used.
 335          */
 336         return (!ofs->config.index && !ofs->config.metacopy &&
 337                 !ofs->config.redirect_dir && ofs->config.xino != OVL_XINO_ON);
 338 }
 339
 340
 341 /* util.c */
 342 int ovl_want_write(struct dentry *dentry);
 343 void ovl_drop_write(struct dentry *dentry);
 344 struct dentry *ovl_workdir(struct dentry *dentry);
 345 const struct cred *ovl_override_creds(struct super_block *sb);
 346 int ovl_can_decode_fh(struct super_block *sb);
 347 struct dentry *ovl_indexdir(struct super_block *sb);
 348 bool ovl_index_all(struct super_block *sb);
 349 bool ovl_verify_lower(struct super_block *sb);
 350 struct ovl_entry *ovl_alloc_entry(unsigned int numlower);
 351 bool ovl_dentry_remote(struct dentry *dentry);
 352 void ovl_dentry_update_reval(struct dentry *dentry, struct dentry *upperdentry,
 353                              unsigned int mask);
 354 bool ovl_dentry_weird(struct dentry *dentry);
 355 enum ovl_path_type ovl_path_type(struct dentry *dentry);
 356 void ovl_path_upper(struct dentry *dentry, struct path *path);
 357 void ovl_path_lower(struct dentry *dentry, struct path *path);
 358 void ovl_path_lowerdata(struct dentry *dentry, struct path *path);
 359 enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path);
 360 enum ovl_path_type ovl_path_realdata(struct dentry *dentry, struct path *path);
 361 struct dentry *ovl_dentry_upper(struct dentry *dentry);
 362 struct dentry *ovl_dentry_lower(struct dentry *dentry);
 363 struct dentry *ovl_dentry_lowerdata(struct dentry *dentry);
 364 const struct ovl_layer *ovl_layer_lower(struct dentry *dentry);
 365 struct dentry *ovl_dentry_real(struct dentry *dentry);
 366 struct dentry *ovl_i_dentry_upper(struct inode *inode);
 367 struct inode *ovl_inode_upper(struct inode *inode);
 368 struct inode *ovl_inode_lower(struct inode *inode);
 369 struct inode *ovl_inode_lowerdata(struct inode *inode);
 370 struct inode *ovl_inode_real(struct inode *inode);
 371 struct inode *ovl_inode_realdata(struct inode *inode);
 372 struct ovl_dir_cache *ovl_dir_cache(struct inode *inode);
 373 void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache);
 374 void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry);
 375 void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry);
 376 bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry);
 377 bool ovl_dentry_is_opaque(struct dentry *dentry);
 378 bool ovl_dentry_is_whiteout(struct dentry *dentry);
 379 void ovl_dentry_set_opaque(struct dentry *dentry);
 380 bool ovl_dentry_has_upper_alias(struct dentry *dentry);
 381 void ovl_dentry_set_upper_alias(struct dentry *dentry);
 382 bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags);
 383 bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags);
 384 bool ovl_has_upperdata(struct inode *inode);
 385 void ovl_set_upperdata(struct inode *inode);
 386 bool ovl_redirect_dir(struct super_block *sb);
 387 const char *ovl_dentry_get_redirect(struct dentry *dentry);
 388 void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect);
 389 void ovl_inode_update(struct inode *inode, struct dentry *upperdentry);
 390 void ovl_dir_modified(struct dentry *dentry, bool impurity);
 391 u64 ovl_dentry_version_get(struct dentry *dentry);
 392 bool ovl_is_whiteout(struct dentry *dentry);
 393 struct file *ovl_path_open(struct path *path, int flags);
 394 int ovl_copy_up_start(struct dentry *dentry, int flags);
 395 void ovl_copy_up_end(struct dentry *dentry);
 396 bool ovl_already_copied_up(struct dentry *dentry, int flags);
 397 bool ovl_check_origin_xattr(struct ovl_fs *ofs, struct dentry *dentry);
 398 bool ovl_check_dir_xattr(struct super_block *sb, struct dentry *dentry,
 399                          enum ovl_xattr ox);
 400 int ovl_check_setxattr(struct ovl_fs *ofs, struct dentry *upperdentry,
 401                        enum ovl_xattr ox, const void *value, size_t size,
 402                        int xerr);
 403 int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry);
 404 bool ovl_inuse_trylock(struct dentry *dentry);
 405 void ovl_inuse_unlock(struct dentry *dentry);
 406 bool ovl_is_inuse(struct dentry *dentry);
 407 bool ovl_need_index(struct dentry *dentry);
 408 int ovl_nlink_start(struct dentry *dentry);
 409 void ovl_nlink_end(struct dentry *dentry);
 410 int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir);
 411 int ovl_check_metacopy_xattr(struct ovl_fs *ofs, struct dentry *dentry);
 412 bool ovl_is_metacopy_dentry(struct dentry *dentry);
 413 char *ovl_get_redirect_xattr(struct ovl_fs *ofs, struct dentry *dentry,
 414                              int padding);
 415 int ovl_sync_status(struct ovl_fs *ofs);
 416
 417 static inline void ovl_set_flag(unsigned long flag, struct inode *inode)
 418 {
 419         set_bit(flag, &OVL_I(inode)->flags);
 420 }
 421
 422 static inline void ovl_clear_flag(unsigned long flag, struct inode *inode)
 423 {
 424         clear_bit(flag, &OVL_I(inode)->flags);
 425 }
 426
 427 static inline bool ovl_test_flag(unsigned long flag, struct inode *inode)
 428 {
 429         return test_bit(flag, &OVL_I(inode)->flags);
 430 }
 431
 432 static inline bool ovl_is_impuredir(struct super_block *sb,
 433                                     struct dentry *dentry)
 434 {
 435         return ovl_check_dir_xattr(sb, dentry, OVL_XATTR_IMPURE);
 436 }
 437
 438 /*
 439  * With xino=auto, we do best effort to keep all inodes on same st_dev and
 440  * d_ino consistent with st_ino.
 441  * With xino=on, we do the same effort but we warn if we failed.
 442  */
 443 static inline bool ovl_xino_warn(struct super_block *sb)
 444 {
 445         return OVL_FS(sb)->config.xino == OVL_XINO_ON;
 446 }
 447
 448 /* All layers on same fs? */
 449 static inline bool ovl_same_fs(struct super_block *sb)
 450 {
 451         return OVL_FS(sb)->xino_mode == 0;
 452 }
 453
 454 /* All overlay inodes have same st_dev? */
 455 static inline bool ovl_same_dev(struct super_block *sb)
 456 {
 457         return OVL_FS(sb)->xino_mode >= 0;
 458 }
 459
 460 static inline unsigned int ovl_xino_bits(struct super_block *sb)
 461 {
 462         return ovl_same_dev(sb) ? OVL_FS(sb)->xino_mode : 0;
 463 }
 464
 465 static inline void ovl_inode_lock(struct inode *inode)
 466 {
 467         mutex_lock(&OVL_I(inode)->lock);
 468 }
 469
 470 static inline int ovl_inode_lock_interruptible(struct inode *inode)
 471 {
 472         return mutex_lock_interruptible(&OVL_I(inode)->lock);
 473 }
 474
 475 static inline void ovl_inode_unlock(struct inode *inode)
 476 {
 477         mutex_unlock(&OVL_I(inode)->lock);
 478 }
 479
 480
 481 /* namei.c */
 482 int ovl_check_fb_len(struct ovl_fb *fb, int fb_len);
 483
 484 static inline int ovl_check_fh_len(struct ovl_fh *fh, int fh_len)
 485 {
 486         if (fh_len < sizeof(struct ovl_fh))
 487                 return -EINVAL;
 488
 489         return ovl_check_fb_len(&fh->fb, fh_len - OVL_FH_WIRE_OFFSET);
 490 }
 491
 492 struct dentry *ovl_decode_real_fh(struct ovl_fs *ofs, struct ovl_fh *fh,
 493                                   struct vfsmount *mnt, bool connected);
 494 int ovl_check_origin_fh(struct ovl_fs *ofs, struct ovl_fh *fh, bool connected,
 495                         struct dentry *upperdentry, struct ovl_path **stackp);
 496 int ovl_verify_set_fh(struct ovl_fs *ofs, struct dentry *dentry,
 497                       enum ovl_xattr ox, struct dentry *real, bool is_upper,
 498                       bool set);
 499 struct dentry *ovl_index_upper(struct ovl_fs *ofs, struct dentry *index);
 500 int ovl_verify_index(struct ovl_fs *ofs, struct dentry *index);
 501 int ovl_get_index_name(struct ovl_fs *ofs, struct dentry *origin,
 502                        struct qstr *name);
 503 struct dentry *ovl_get_index_fh(struct ovl_fs *ofs, struct ovl_fh *fh);
 504 struct dentry *ovl_lookup_index(struct ovl_fs *ofs, struct dentry *upper,
 505                                 struct dentry *origin, bool verify);
 506 int ovl_path_next(int idx, struct dentry *dentry, struct path *path);
 507 struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
 508                           unsigned int flags);
 509 bool ovl_lower_positive(struct dentry *dentry);
 510
 511 static inline int ovl_verify_origin(struct ovl_fs *ofs, struct dentry *upper,
 512                                     struct dentry *origin, bool set)
 513 {
 514         return ovl_verify_set_fh(ofs, upper, OVL_XATTR_ORIGIN, origin,
 515                                  false, set);
 516 }
 517
 518 static inline int ovl_verify_upper(struct ovl_fs *ofs, struct dentry *index,
 519                                    struct dentry *upper, bool set)
 520 {
 521         return ovl_verify_set_fh(ofs, index, OVL_XATTR_UPPER, upper, true, set);
 522 }
 523
 524 /* readdir.c */
 525 extern const struct file_operations ovl_dir_operations;
 526 struct file *ovl_dir_real_file(const struct file *file, bool want_upper);
 527 int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list);
 528 void ovl_cleanup_whiteouts(struct ovl_fs *ofs, struct dentry *upper,
 529                            struct list_head *list);
 530 void ovl_cache_free(struct list_head *list);
 531 void ovl_dir_cache_free(struct inode *inode);
 532 int ovl_check_d_type_supported(struct path *realpath);
 533 int ovl_workdir_cleanup(struct ovl_fs *ofs, struct inode *dir,
 534                         struct vfsmount *mnt, struct dentry *dentry, int level);
 535 int ovl_indexdir_cleanup(struct ovl_fs *ofs);
 536
 537 /*
 538  * Can we iterate real dir directly?
 539  *
 540  * Non-merge dir may contain whiteouts from a time it was a merge upper, before
 541  * lower dir was removed under it and possibly before it was rotated from upper
 542  * to lower layer.
 543  */
 544 static inline bool ovl_dir_is_real(struct dentry *dir)
 545 {
 546         return !ovl_test_flag(OVL_WHITEOUTS, d_inode(dir));
 547 }
 548
 549 /* inode.c */
 550 int ovl_set_nlink_upper(struct dentry *dentry);
 551 int ovl_set_nlink_lower(struct dentry *dentry);
 552 unsigned int ovl_get_nlink(struct ovl_fs *ofs, struct dentry *lowerdentry,
 553                            struct dentry *upperdentry,
 554                            unsigned int fallback);
 555 int ovl_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
 556                 struct iattr *attr);
 557 int ovl_getattr(struct user_namespace *mnt_userns, const struct path *path,
 558                 struct kstat *stat, u32 request_mask, unsigned int flags);
 559 int ovl_permission(struct user_namespace *mnt_userns, struct inode *inode,
 560                    int mask);
 561 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
 562                   const void *value, size_t size, int flags);
 563 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
 564                   void *value, size_t size);
 565 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size);
 566 struct posix_acl *ovl_get_acl(struct inode *inode, int type, bool rcu);
 567 int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags);
 568 bool ovl_is_private_xattr(struct super_block *sb, const char *name);
 569
 570 struct ovl_inode_params {
 571         struct inode *newinode;
 572         struct dentry *upperdentry;
 573         struct ovl_path *lowerpath;
 574         bool index;
 575         unsigned int numlower;
 576         char *redirect;
 577         struct dentry *lowerdata;
 578 };
 579 void ovl_inode_init(struct inode *inode, struct ovl_inode_params *oip,
 580                     unsigned long ino, int fsid);
 581 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev);
 582 struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
 583                                bool is_upper);
 584 bool ovl_lookup_trap_inode(struct super_block *sb, struct dentry *dir);
 585 struct inode *ovl_get_trap_inode(struct super_block *sb, struct dentry *dir);
 586 struct inode *ovl_get_inode(struct super_block *sb,
 587                             struct ovl_inode_params *oip);
 588 static inline void ovl_copyattr(struct inode *from, struct inode *to)
 589 {
 590         to->i_uid = from->i_uid;
 591         to->i_gid = from->i_gid;
 592         to->i_mode = from->i_mode;
 593         to->i_atime = from->i_atime;
 594         to->i_mtime = from->i_mtime;
 595         to->i_ctime = from->i_ctime;
 596         i_size_write(to, i_size_read(from));
 597 }
 598
 599 /* vfs inode flags copied from real to ovl inode */
 600 #define OVL_COPY_I_FLAGS_MASK   (S_SYNC | S_NOATIME | S_APPEND | S_IMMUTABLE)
 601 /* vfs inode flags read from overlay.protattr xattr to ovl inode */
 602 #define OVL_PROT_I_FLAGS_MASK   (S_APPEND | S_IMMUTABLE)
 603
 604 /*
 605  * fileattr flags copied from lower to upper inode on copy up.
 606  * We cannot copy up immutable/append-only flags, because that would prevent
 607  * linking temp inode to upper dir, so we store them in xattr instead.
 608  */
 609 #define OVL_COPY_FS_FLAGS_MASK  (FS_SYNC_FL | FS_NOATIME_FL)
 610 #define OVL_COPY_FSX_FLAGS_MASK (FS_XFLAG_SYNC | FS_XFLAG_NOATIME)
 611 #define OVL_PROT_FS_FLAGS_MASK  (FS_APPEND_FL | FS_IMMUTABLE_FL)
 612 #define OVL_PROT_FSX_FLAGS_MASK (FS_XFLAG_APPEND | FS_XFLAG_IMMUTABLE)
 613
 614 void ovl_check_protattr(struct inode *inode, struct dentry *upper);
 615 int ovl_set_protattr(struct inode *inode, struct dentry *upper,
 616                       struct fileattr *fa);
 617
 618 static inline void ovl_copyflags(struct inode *from, struct inode *to)
 619 {
 620         unsigned int mask = OVL_COPY_I_FLAGS_MASK;
 621
 622         inode_set_flags(to, from->i_flags & mask, mask);
 623 }
 624
 625 /* dir.c */
 626 extern const struct inode_operations ovl_dir_inode_operations;
 627 int ovl_cleanup_and_whiteout(struct ovl_fs *ofs, struct inode *dir,
 628                              struct dentry *dentry);
 629 struct ovl_cattr {
 630         dev_t rdev;
 631         umode_t mode;
 632         const char *link;
 633         struct dentry *hardlink;
 634 };
 635
 636 #define OVL_CATTR(m) (&(struct ovl_cattr) { .mode = (m) })
 637
 638 int ovl_mkdir_real(struct ovl_fs *ofs, struct inode *dir,
 639                    struct dentry **newdentry, umode_t mode);
 640 struct dentry *ovl_create_real(struct ovl_fs *ofs,
 641                                struct inode *dir, struct dentry *newdentry,
 642                                struct ovl_cattr *attr);
 643 int ovl_cleanup(struct ovl_fs *ofs, struct inode *dir, struct dentry *dentry);
 644 struct dentry *ovl_lookup_temp(struct ovl_fs *ofs, struct dentry *workdir);
 645 struct dentry *ovl_create_temp(struct ovl_fs *ofs, struct dentry *workdir,
 646                                struct ovl_cattr *attr);
 647
 648 /* file.c */
 649 extern const struct file_operations ovl_file_operations;
 650 int __init ovl_aio_request_cache_init(void);
 651 void ovl_aio_request_cache_destroy(void);
 652 int ovl_real_fileattr_get(struct path *realpath, struct fileattr *fa);
 653 int ovl_real_fileattr_set(struct path *realpath, struct fileattr *fa);
 654 int ovl_fileattr_get(struct dentry *dentry, struct fileattr *fa);
 655 int ovl_fileattr_set(struct user_namespace *mnt_userns,
 656                      struct dentry *dentry, struct fileattr *fa);
 657
 658 /* copy_up.c */
 659 int ovl_copy_up(struct dentry *dentry);
 660 int ovl_copy_up_with_data(struct dentry *dentry);
 661 int ovl_maybe_copy_up(struct dentry *dentry, int flags);
 662 int ovl_copy_xattr(struct super_block *sb, struct dentry *old,
 663                    struct dentry *new);
 664 int ovl_set_attr(struct ovl_fs *ofs, struct dentry *upper, struct kstat *stat);
 665 struct ovl_fh *ovl_encode_real_fh(struct ovl_fs *ofs, struct dentry *real,
 666                                   bool is_upper);
 667 int ovl_set_origin(struct ovl_fs *ofs, struct dentry *lower,
 668                    struct dentry *upper);
 669
 670 /* export.c */
 671 extern const struct export_operations ovl_export_operations;