fs/overlayfs/inode.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *
   4  * Copyright (C) 2011 Novell Inc.
   5  */
   6
   7 #include <linux/fs.h>
   8 #include <linux/slab.h>
   9 #include <linux/cred.h>
  10 #include <linux/xattr.h>
  11 #include <linux/posix_acl.h>
  12 #include <linux/ratelimit.h>
  13 #include <linux/fiemap.h>
  14 #include "overlayfs.h"
  15
  16
  17 int ovl_setattr(struct dentry *dentry, struct iattr *attr)
  18 {
  19         int err;
  20         bool full_copy_up = false;
  21         struct dentry *upperdentry;
  22         const struct cred *old_cred;
  23
  24         err = setattr_prepare(dentry, attr);
  25         if (err)
  26                 return err;
  27
  28         err = ovl_want_write(dentry);
  29         if (err)
  30                 goto out;
  31
  32         if (attr->ia_valid & ATTR_SIZE) {
  33                 struct inode *realinode = d_inode(ovl_dentry_real(dentry));
  34
  35                 err = -ETXTBSY;
  36                 if (atomic_read(&realinode->i_writecount) < 0)
  37                         goto out_drop_write;
  38
  39                 /* Truncate should trigger data copy up as well */
  40                 full_copy_up = true;
  41         }
  42
  43         if (!full_copy_up)
  44                 err = ovl_copy_up(dentry);
  45         else
  46                 err = ovl_copy_up_with_data(dentry);
  47         if (!err) {
  48                 struct inode *winode = NULL;
  49
  50                 upperdentry = ovl_dentry_upper(dentry);
  51
  52                 if (attr->ia_valid & ATTR_SIZE) {
  53                         winode = d_inode(upperdentry);
  54                         err = get_write_access(winode);
  55                         if (err)
  56                                 goto out_drop_write;
  57                 }
  58
  59                 if (attr->ia_valid & (ATTR_KILL_SUID|ATTR_KILL_SGID))
  60                         attr->ia_valid &= ~ATTR_MODE;
  61
  62                 /*
  63                  * We might have to translate ovl file into real file object
  64                  * once use cases emerge.  For now, simply don't let underlying
  65                  * filesystem rely on attr->ia_file
  66                  */
  67                 attr->ia_valid &= ~ATTR_FILE;
  68
  69                 /*
  70                  * If open(O_TRUNC) is done, VFS calls ->setattr with ATTR_OPEN
  71                  * set.  Overlayfs does not pass O_TRUNC flag to underlying
  72                  * filesystem during open -> do not pass ATTR_OPEN.  This
  73                  * disables optimization in fuse which assumes open(O_TRUNC)
  74                  * already set file size to 0.  But we never passed O_TRUNC to
  75                  * fuse.  So by clearing ATTR_OPEN, fuse will be forced to send
  76                  * setattr request to server.
  77                  */
  78                 attr->ia_valid &= ~ATTR_OPEN;
  79
  80                 inode_lock(upperdentry->d_inode);
  81                 old_cred = ovl_override_creds(dentry->d_sb);
  82                 err = notify_change(upperdentry, attr, NULL);
  83                 revert_creds(old_cred);
  84                 if (!err)
  85                         ovl_copyattr(upperdentry->d_inode, dentry->d_inode);
  86                 inode_unlock(upperdentry->d_inode);
  87
  88                 if (winode)
  89                         put_write_access(winode);
  90         }
  91 out_drop_write:
  92         ovl_drop_write(dentry);
  93 out:
  94         return err;
  95 }
  96
  97 static int ovl_map_dev_ino(struct dentry *dentry, struct kstat *stat, int fsid)
  98 {
  99         bool samefs = ovl_same_fs(dentry->d_sb);
 100         unsigned int xinobits = ovl_xino_bits(dentry->d_sb);
 101         unsigned int xinoshift = 64 - xinobits;
 102
 103         if (samefs) {
 104                 /*
 105                  * When all layers are on the same fs, all real inode
 106                  * number are unique, so we use the overlay st_dev,
 107                  * which is friendly to du -x.
 108                  */
 109                 stat->dev = dentry->d_sb->s_dev;
 110                 return 0;
 111         } else if (xinobits) {
 112                 /*
 113                  * All inode numbers of underlying fs should not be using the
 114                  * high xinobits, so we use high xinobits to partition the
 115                  * overlay st_ino address space. The high bits holds the fsid
 116                  * (upper fsid is 0). The lowest xinobit is reserved for mapping
 117                  * the non-peresistent inode numbers range in case of overflow.
 118                  * This way all overlay inode numbers are unique and use the
 119                  * overlay st_dev.
 120                  */
 121                 if (likely(!(stat->ino >> xinoshift))) {
 122                         stat->ino |= ((u64)fsid) << (xinoshift + 1);
 123                         stat->dev = dentry->d_sb->s_dev;
 124                         return 0;
 125                 } else if (ovl_xino_warn(dentry->d_sb)) {
 126                         pr_warn_ratelimited("inode number too big (%pd2, ino=%llu, xinobits=%d)\n",
 127                                             dentry, stat->ino, xinobits);
 128                 }
 129         }
 130
 131         /* The inode could not be mapped to a unified st_ino address space */
 132         if (S_ISDIR(dentry->d_inode->i_mode)) {
 133                 /*
 134                  * Always use the overlay st_dev for directories, so 'find
 135                  * -xdev' will scan the entire overlay mount and won't cross the
 136                  * overlay mount boundaries.
 137                  *
 138                  * If not all layers are on the same fs the pair {real st_ino;
 139                  * overlay st_dev} is not unique, so use the non persistent
 140                  * overlay st_ino for directories.
 141                  */
 142                 stat->dev = dentry->d_sb->s_dev;
 143                 stat->ino = dentry->d_inode->i_ino;
 144         } else {
 145                 /*
 146                  * For non-samefs setup, if we cannot map all layers st_ino
 147                  * to a unified address space, we need to make sure that st_dev
 148                  * is unique per underlying fs, so we use the unique anonymous
 149                  * bdev assigned to the underlying fs.
 150                  */
 151                 stat->dev = OVL_FS(dentry->d_sb)->fs[fsid].pseudo_dev;
 152         }
 153
 154         return 0;
 155 }
 156
 157 int ovl_getattr(const struct path *path, struct kstat *stat,
 158                 u32 request_mask, unsigned int flags)
 159 {
 160         struct dentry *dentry = path->dentry;
 161         enum ovl_path_type type;
 162         struct path realpath;
 163         const struct cred *old_cred;
 164         bool is_dir = S_ISDIR(dentry->d_inode->i_mode);
 165         int fsid = 0;
 166         int err;
 167         bool metacopy_blocks = false;
 168
 169         metacopy_blocks = ovl_is_metacopy_dentry(dentry);
 170
 171         type = ovl_path_real(dentry, &realpath);
 172         old_cred = ovl_override_creds(dentry->d_sb);
 173         err = vfs_getattr(&realpath, stat, request_mask, flags);
 174         if (err)
 175                 goto out;
 176
 177         /*
 178          * For non-dir or same fs, we use st_ino of the copy up origin.
 179          * This guaranties constant st_dev/st_ino across copy up.
 180          * With xino feature and non-samefs, we use st_ino of the copy up
 181          * origin masked with high bits that represent the layer id.
 182          *
 183          * If lower filesystem supports NFS file handles, this also guaranties
 184          * persistent st_ino across mount cycle.
 185          */
 186         if (!is_dir || ovl_same_dev(dentry->d_sb)) {
 187                 if (!OVL_TYPE_UPPER(type)) {
 188                         fsid = ovl_layer_lower(dentry)->fsid;
 189                 } else if (OVL_TYPE_ORIGIN(type)) {
 190                         struct kstat lowerstat;
 191                         u32 lowermask = STATX_INO | STATX_BLOCKS |
 192                                         (!is_dir ? STATX_NLINK : 0);
 193
 194                         ovl_path_lower(dentry, &realpath);
 195                         err = vfs_getattr(&realpath, &lowerstat,
 196                                           lowermask, flags);
 197                         if (err)
 198                                 goto out;
 199
 200                         /*
 201                          * Lower hardlinks may be broken on copy up to different
 202                          * upper files, so we cannot use the lower origin st_ino
 203                          * for those different files, even for the same fs case.
 204                          *
 205                          * Similarly, several redirected dirs can point to the
 206                          * same dir on a lower layer. With the "verify_lower"
 207                          * feature, we do not use the lower origin st_ino, if
 208                          * we haven't verified that this redirect is unique.
 209                          *
 210                          * With inodes index enabled, it is safe to use st_ino
 211                          * of an indexed origin. The index validates that the
 212                          * upper hardlink is not broken and that a redirected
 213                          * dir is the only redirect to that origin.
 214                          */
 215                         if (ovl_test_flag(OVL_INDEX, d_inode(dentry)) ||
 216                             (!ovl_verify_lower(dentry->d_sb) &&
 217                              (is_dir || lowerstat.nlink == 1))) {
 218                                 fsid = ovl_layer_lower(dentry)->fsid;
 219                                 stat->ino = lowerstat.ino;
 220                         }
 221
 222                         /*
 223                          * If we are querying a metacopy dentry and lower
 224                          * dentry is data dentry, then use the blocks we
 225                          * queried just now. We don't have to do additional
 226                          * vfs_getattr(). If lower itself is metacopy, then
 227                          * additional vfs_getattr() is unavoidable.
 228                          */
 229                         if (metacopy_blocks &&
 230                             realpath.dentry == ovl_dentry_lowerdata(dentry)) {
 231                                 stat->blocks = lowerstat.blocks;
 232                                 metacopy_blocks = false;
 233                         }
 234                 }
 235
 236                 if (metacopy_blocks) {
 237                         /*
 238                          * If lower is not same as lowerdata or if there was
 239                          * no origin on upper, we can end up here.
 240                          */
 241                         struct kstat lowerdatastat;
 242                         u32 lowermask = STATX_BLOCKS;
 243
 244                         ovl_path_lowerdata(dentry, &realpath);
 245                         err = vfs_getattr(&realpath, &lowerdatastat,
 246                                           lowermask, flags);
 247                         if (err)
 248                                 goto out;
 249                         stat->blocks = lowerdatastat.blocks;
 250                 }
 251         }
 252
 253         err = ovl_map_dev_ino(dentry, stat, fsid);
 254         if (err)
 255                 goto out;
 256
 257         /*
 258          * It's probably not worth it to count subdirs to get the
 259          * correct link count.  nlink=1 seems to pacify 'find' and
 260          * other utilities.
 261          */
 262         if (is_dir && OVL_TYPE_MERGE(type))
 263                 stat->nlink = 1;
 264
 265         /*
 266          * Return the overlay inode nlinks for indexed upper inodes.
 267          * Overlay inode nlink counts the union of the upper hardlinks
 268          * and non-covered lower hardlinks. It does not include the upper
 269          * index hardlink.
 270          */
 271         if (!is_dir && ovl_test_flag(OVL_INDEX, d_inode(dentry)))
 272                 stat->nlink = dentry->d_inode->i_nlink;
 273
 274 out:
 275         revert_creds(old_cred);
 276
 277         return err;
 278 }
 279
 280 int ovl_permission(struct inode *inode, int mask)
 281 {
 282         struct inode *upperinode = ovl_inode_upper(inode);
 283         struct inode *realinode = upperinode ?: ovl_inode_lower(inode);
 284         const struct cred *old_cred;
 285         int err;
 286
 287         /* Careful in RCU walk mode */
 288         if (!realinode) {
 289                 WARN_ON(!(mask & MAY_NOT_BLOCK));
 290                 return -ECHILD;
 291         }
 292
 293         /*
 294          * Check overlay inode with the creds of task and underlying inode
 295          * with creds of mounter
 296          */
 297         err = generic_permission(inode, mask);
 298         if (err)
 299                 return err;
 300
 301         old_cred = ovl_override_creds(inode->i_sb);
 302         if (!upperinode &&
 303             !special_file(realinode->i_mode) && mask & MAY_WRITE) {
 304                 mask &= ~(MAY_WRITE | MAY_APPEND);
 305                 /* Make sure mounter can read file for copy up later */
 306                 mask |= MAY_READ;
 307         }
 308         err = inode_permission(realinode, mask);
 309         revert_creds(old_cred);
 310
 311         return err;
 312 }
 313
 314 static const char *ovl_get_link(struct dentry *dentry,
 315                                 struct inode *inode,
 316                                 struct delayed_call *done)
 317 {
 318         const struct cred *old_cred;
 319         const char *p;
 320
 321         if (!dentry)
 322                 return ERR_PTR(-ECHILD);
 323
 324         old_cred = ovl_override_creds(dentry->d_sb);
 325         p = vfs_get_link(ovl_dentry_real(dentry), done);
 326         revert_creds(old_cred);
 327         return p;
 328 }
 329
 330 bool ovl_is_private_xattr(struct super_block *sb, const char *name)
 331 {
 332         struct ovl_fs *ofs = sb->s_fs_info;
 333
 334         if (ofs->config.userxattr)
 335                 return strncmp(name, OVL_XATTR_USER_PREFIX,
 336                                sizeof(OVL_XATTR_USER_PREFIX) - 1) == 0;
 337         else
 338                 return strncmp(name, OVL_XATTR_TRUSTED_PREFIX,
 339                                sizeof(OVL_XATTR_TRUSTED_PREFIX) - 1) == 0;
 340 }
 341
 342 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
 343                   const void *value, size_t size, int flags)
 344 {
 345         int err;
 346         struct dentry *upperdentry = ovl_i_dentry_upper(inode);
 347         struct dentry *realdentry = upperdentry ?: ovl_dentry_lower(dentry);
 348         const struct cred *old_cred;
 349
 350         err = ovl_want_write(dentry);
 351         if (err)
 352                 goto out;
 353
 354         if (!value && !upperdentry) {
 355                 old_cred = ovl_override_creds(dentry->d_sb);
 356                 err = vfs_getxattr(realdentry, name, NULL, 0);
 357                 revert_creds(old_cred);
 358                 if (err < 0)
 359                         goto out_drop_write;
 360         }
 361
 362         if (!upperdentry) {
 363                 err = ovl_copy_up(dentry);
 364                 if (err)
 365                         goto out_drop_write;
 366
 367                 realdentry = ovl_dentry_upper(dentry);
 368         }
 369
 370         old_cred = ovl_override_creds(dentry->d_sb);
 371         if (value)
 372                 err = vfs_setxattr(realdentry, name, value, size, flags);
 373         else {
 374                 WARN_ON(flags != XATTR_REPLACE);
 375                 err = vfs_removexattr(realdentry, name);
 376         }
 377         revert_creds(old_cred);
 378
 379         /* copy c/mtime */
 380         ovl_copyattr(d_inode(realdentry), inode);
 381
 382 out_drop_write:
 383         ovl_drop_write(dentry);
 384 out:
 385         return err;
 386 }
 387
 388 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
 389                   void *value, size_t size)
 390 {
 391         ssize_t res;
 392         const struct cred *old_cred;
 393         struct dentry *realdentry =
 394                 ovl_i_dentry_upper(inode) ?: ovl_dentry_lower(dentry);
 395
 396         old_cred = ovl_override_creds(dentry->d_sb);
 397         res = vfs_getxattr(realdentry, name, value, size);
 398         revert_creds(old_cred);
 399         return res;
 400 }
 401
 402 static bool ovl_can_list(struct super_block *sb, const char *s)
 403 {
 404         /* Never list private (.overlay) */
 405         if (ovl_is_private_xattr(sb, s))
 406                 return false;
 407
 408         /* List all non-trusted xatts */
 409         if (strncmp(s, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN) != 0)
 410                 return true;
 411
 412         /* list other trusted for superuser only */
 413         return ns_capable_noaudit(&init_user_ns, CAP_SYS_ADMIN);
 414 }
 415
 416 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size)
 417 {
 418         struct dentry *realdentry = ovl_dentry_real(dentry);
 419         ssize_t res;
 420         size_t len;
 421         char *s;
 422         const struct cred *old_cred;
 423
 424         old_cred = ovl_override_creds(dentry->d_sb);
 425         res = vfs_listxattr(realdentry, list, size);
 426         revert_creds(old_cred);
 427         if (res <= 0 || size == 0)
 428                 return res;
 429
 430         /* filter out private xattrs */
 431         for (s = list, len = res; len;) {
 432                 size_t slen = strnlen(s, len) + 1;
 433
 434                 /* underlying fs providing us with an broken xattr list? */
 435                 if (WARN_ON(slen > len))
 436                         return -EIO;
 437
 438                 len -= slen;
 439                 if (!ovl_can_list(dentry->d_sb, s)) {
 440                         res -= slen;
 441                         memmove(s, s + slen, len);
 442                 } else {
 443                         s += slen;
 444                 }
 445         }
 446
 447         return res;
 448 }
 449
 450 struct posix_acl *ovl_get_acl(struct inode *inode, int type)
 451 {
 452         struct inode *realinode = ovl_inode_real(inode);
 453         const struct cred *old_cred;
 454         struct posix_acl *acl;
 455
 456         if (!IS_ENABLED(CONFIG_FS_POSIX_ACL) || !IS_POSIXACL(realinode))
 457                 return NULL;
 458
 459         old_cred = ovl_override_creds(inode->i_sb);
 460         acl = get_acl(realinode, type);
 461         revert_creds(old_cred);
 462
 463         return acl;
 464 }
 465
 466 int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags)
 467 {
 468         if (flags & S_ATIME) {
 469                 struct ovl_fs *ofs = inode->i_sb->s_fs_info;
 470                 struct path upperpath = {
 471                         .mnt = ovl_upper_mnt(ofs),
 472                         .dentry = ovl_upperdentry_dereference(OVL_I(inode)),
 473                 };
 474
 475                 if (upperpath.dentry) {
 476                         touch_atime(&upperpath);
 477                         inode->i_atime = d_inode(upperpath.dentry)->i_atime;
 478                 }
 479         }
 480         return 0;
 481 }
 482
 483 static int ovl_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
 484                       u64 start, u64 len)
 485 {
 486         int err;
 487         struct inode *realinode = ovl_inode_realdata(inode);
 488         const struct cred *old_cred;
 489
 490         if (!realinode->i_op->fiemap)
 491                 return -EOPNOTSUPP;
 492
 493         old_cred = ovl_override_creds(inode->i_sb);
 494         err = realinode->i_op->fiemap(realinode, fieinfo, start, len);
 495         revert_creds(old_cred);
 496
 497         return err;
 498 }
 499
 500 static const struct inode_operations ovl_file_inode_operations = {
 501         .setattr        = ovl_setattr,
 502         .permission     = ovl_permission,
 503         .getattr        = ovl_getattr,
 504         .listxattr      = ovl_listxattr,
 505         .get_acl        = ovl_get_acl,
 506         .update_time    = ovl_update_time,
 507         .fiemap         = ovl_fiemap,
 508 };
 509
 510 static const struct inode_operations ovl_symlink_inode_operations = {
 511         .setattr        = ovl_setattr,
 512         .get_link       = ovl_get_link,
 513         .getattr        = ovl_getattr,
 514         .listxattr      = ovl_listxattr,
 515         .update_time    = ovl_update_time,
 516 };
 517
 518 static const struct inode_operations ovl_special_inode_operations = {
 519         .setattr        = ovl_setattr,
 520         .permission     = ovl_permission,
 521         .getattr        = ovl_getattr,
 522         .listxattr      = ovl_listxattr,
 523         .get_acl        = ovl_get_acl,
 524         .update_time    = ovl_update_time,
 525 };
 526
 527 static const struct address_space_operations ovl_aops = {
 528         /* For O_DIRECT dentry_open() checks f_mapping->a_ops->direct_IO */
 529         .direct_IO              = noop_direct_IO,
 530 };
 531
 532 /*
 533  * It is possible to stack overlayfs instance on top of another
 534  * overlayfs instance as lower layer. We need to annotate the
 535  * stackable i_mutex locks according to stack level of the super
 536  * block instance. An overlayfs instance can never be in stack
 537  * depth 0 (there is always a real fs below it).  An overlayfs
 538  * inode lock will use the lockdep annotaion ovl_i_mutex_key[depth].
 539  *
 540  * For example, here is a snip from /proc/lockdep_chains after
 541  * dir_iterate of nested overlayfs:
 542  *
 543  * [...] &ovl_i_mutex_dir_key[depth]   (stack_depth=2)
 544  * [...] &ovl_i_mutex_dir_key[depth]#2 (stack_depth=1)
 545  * [...] &type->i_mutex_dir_key        (stack_depth=0)
 546  *
 547  * Locking order w.r.t ovl_want_write() is important for nested overlayfs.
 548  *
 549  * This chain is valid:
 550  * - inode->i_rwsem                     (inode_lock[2])
 551  * - upper_mnt->mnt_sb->s_writers       (ovl_want_write[0])
 552  * - OVL_I(inode)->lock                 (ovl_inode_lock[2])
 553  * - OVL_I(lowerinode)->lock            (ovl_inode_lock[1])
 554  *
 555  * And this chain is valid:
 556  * - inode->i_rwsem                     (inode_lock[2])
 557  * - OVL_I(inode)->lock                 (ovl_inode_lock[2])
 558  * - lowerinode->i_rwsem                (inode_lock[1])
 559  * - OVL_I(lowerinode)->lock            (ovl_inode_lock[1])
 560  *
 561  * But lowerinode->i_rwsem SHOULD NOT be acquired while ovl_want_write() is
 562  * held, because it is in reverse order of the non-nested case using the same
 563  * upper fs:
 564  * - inode->i_rwsem                     (inode_lock[1])
 565  * - upper_mnt->mnt_sb->s_writers       (ovl_want_write[0])
 566  * - OVL_I(inode)->lock                 (ovl_inode_lock[1])
 567  */
 568 #define OVL_MAX_NESTING FILESYSTEM_MAX_STACK_DEPTH
 569
 570 static inline void ovl_lockdep_annotate_inode_mutex_key(struct inode *inode)
 571 {
 572 #ifdef CONFIG_LOCKDEP
 573         static struct lock_class_key ovl_i_mutex_key[OVL_MAX_NESTING];
 574         static struct lock_class_key ovl_i_mutex_dir_key[OVL_MAX_NESTING];
 575         static struct lock_class_key ovl_i_lock_key[OVL_MAX_NESTING];
 576
 577         int depth = inode->i_sb->s_stack_depth - 1;
 578
 579         if (WARN_ON_ONCE(depth < 0 || depth >= OVL_MAX_NESTING))
 580                 depth = 0;
 581
 582         if (S_ISDIR(inode->i_mode))
 583                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_dir_key[depth]);
 584         else
 585                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_key[depth]);
 586
 587         lockdep_set_class(&OVL_I(inode)->lock, &ovl_i_lock_key[depth]);
 588 #endif
 589 }
 590
 591 static void ovl_next_ino(struct inode *inode)
 592 {
 593         struct ovl_fs *ofs = inode->i_sb->s_fs_info;
 594
 595         inode->i_ino = atomic_long_inc_return(&ofs->last_ino);
 596         if (unlikely(!inode->i_ino))
 597                 inode->i_ino = atomic_long_inc_return(&ofs->last_ino);
 598 }
 599
 600 static void ovl_map_ino(struct inode *inode, unsigned long ino, int fsid)
 601 {
 602         int xinobits = ovl_xino_bits(inode->i_sb);
 603         unsigned int xinoshift = 64 - xinobits;
 604
 605         /*
 606          * When d_ino is consistent with st_ino (samefs or i_ino has enough
 607          * bits to encode layer), set the same value used for st_ino to i_ino,
 608          * so inode number exposed via /proc/locks and a like will be
 609          * consistent with d_ino and st_ino values. An i_ino value inconsistent
 610          * with d_ino also causes nfsd readdirplus to fail.
 611          */
 612         inode->i_ino = ino;
 613         if (ovl_same_fs(inode->i_sb)) {
 614                 return;
 615         } else if (xinobits && likely(!(ino >> xinoshift))) {
 616                 inode->i_ino |= (unsigned long)fsid << (xinoshift + 1);
 617                 return;
 618         }
 619
 620         /*
 621          * For directory inodes on non-samefs with xino disabled or xino
 622          * overflow, we allocate a non-persistent inode number, to be used for
 623          * resolving st_ino collisions in ovl_map_dev_ino().
 624          *
 625          * To avoid ino collision with legitimate xino values from upper
 626          * layer (fsid 0), use the lowest xinobit to map the non
 627          * persistent inode numbers to the unified st_ino address space.
 628          */
 629         if (S_ISDIR(inode->i_mode)) {
 630                 ovl_next_ino(inode);
 631                 if (xinobits) {
 632                         inode->i_ino &= ~0UL >> xinobits;
 633                         inode->i_ino |= 1UL << xinoshift;
 634                 }
 635         }
 636 }
 637
 638 void ovl_inode_init(struct inode *inode, struct ovl_inode_params *oip,
 639                     unsigned long ino, int fsid)
 640 {
 641         struct inode *realinode;
 642
 643         if (oip->upperdentry)
 644                 OVL_I(inode)->__upperdentry = oip->upperdentry;
 645         if (oip->lowerpath && oip->lowerpath->dentry)
 646                 OVL_I(inode)->lower = igrab(d_inode(oip->lowerpath->dentry));
 647         if (oip->lowerdata)
 648                 OVL_I(inode)->lowerdata = igrab(d_inode(oip->lowerdata));
 649
 650         realinode = ovl_inode_real(inode);
 651         ovl_copyattr(realinode, inode);
 652         ovl_copyflags(realinode, inode);
 653         ovl_map_ino(inode, ino, fsid);
 654 }
 655
 656 static void ovl_fill_inode(struct inode *inode, umode_t mode, dev_t rdev)
 657 {
 658         inode->i_mode = mode;
 659         inode->i_flags |= S_NOCMTIME;
 660 #ifdef CONFIG_FS_POSIX_ACL
 661         inode->i_acl = inode->i_default_acl = ACL_DONT_CACHE;
 662 #endif
 663
 664         ovl_lockdep_annotate_inode_mutex_key(inode);
 665
 666         switch (mode & S_IFMT) {
 667         case S_IFREG:
 668                 inode->i_op = &ovl_file_inode_operations;
 669                 inode->i_fop = &ovl_file_operations;
 670                 inode->i_mapping->a_ops = &ovl_aops;
 671                 break;
 672
 673         case S_IFDIR:
 674                 inode->i_op = &ovl_dir_inode_operations;
 675                 inode->i_fop = &ovl_dir_operations;
 676                 break;
 677
 678         case S_IFLNK:
 679                 inode->i_op = &ovl_symlink_inode_operations;
 680                 break;
 681
 682         default:
 683                 inode->i_op = &ovl_special_inode_operations;
 684                 init_special_inode(inode, mode, rdev);
 685                 break;
 686         }
 687 }
 688
 689 /*
 690  * With inodes index enabled, an overlay inode nlink counts the union of upper
 691  * hardlinks and non-covered lower hardlinks. During the lifetime of a non-pure
 692  * upper inode, the following nlink modifying operations can happen:
 693  *
 694  * 1. Lower hardlink copy up
 695  * 2. Upper hardlink created, unlinked or renamed over
 696  * 3. Lower hardlink whiteout or renamed over
 697  *
 698  * For the first, copy up case, the union nlink does not change, whether the
 699  * operation succeeds or fails, but the upper inode nlink may change.
 700  * Therefore, before copy up, we store the union nlink value relative to the
 701  * lower inode nlink in the index inode xattr .overlay.nlink.
 702  *
 703  * For the second, upper hardlink case, the union nlink should be incremented
 704  * or decremented IFF the operation succeeds, aligned with nlink change of the
 705  * upper inode. Therefore, before link/unlink/rename, we store the union nlink
 706  * value relative to the upper inode nlink in the index inode.
 707  *
 708  * For the last, lower cover up case, we simplify things by preceding the
 709  * whiteout or cover up with copy up. This makes sure that there is an index
 710  * upper inode where the nlink xattr can be stored before the copied up upper
 711  * entry is unlink.
 712  */
 713 #define OVL_NLINK_ADD_UPPER     (1 << 0)
 714
 715 /*
 716  * On-disk format for indexed nlink:
 717  *
 718  * nlink relative to the upper inode - "U[+-]NUM"
 719  * nlink relative to the lower inode - "L[+-]NUM"
 720  */
 721
 722 static int ovl_set_nlink_common(struct dentry *dentry,
 723                                 struct dentry *realdentry, const char *format)
 724 {
 725         struct inode *inode = d_inode(dentry);
 726         struct inode *realinode = d_inode(realdentry);
 727         char buf[13];
 728         int len;
 729
 730         len = snprintf(buf, sizeof(buf), format,
 731                        (int) (inode->i_nlink - realinode->i_nlink));
 732
 733         if (WARN_ON(len >= sizeof(buf)))
 734                 return -EIO;
 735
 736         return ovl_do_setxattr(OVL_FS(inode->i_sb), ovl_dentry_upper(dentry),
 737                                OVL_XATTR_NLINK, buf, len);
 738 }
 739
 740 int ovl_set_nlink_upper(struct dentry *dentry)
 741 {
 742         return ovl_set_nlink_common(dentry, ovl_dentry_upper(dentry), "U%+i");
 743 }
 744
 745 int ovl_set_nlink_lower(struct dentry *dentry)
 746 {
 747         return ovl_set_nlink_common(dentry, ovl_dentry_lower(dentry), "L%+i");
 748 }
 749
 750 unsigned int ovl_get_nlink(struct ovl_fs *ofs, struct dentry *lowerdentry,
 751                            struct dentry *upperdentry,
 752                            unsigned int fallback)
 753 {
 754         int nlink_diff;
 755         int nlink;
 756         char buf[13];
 757         int err;
 758
 759         if (!lowerdentry || !upperdentry || d_inode(lowerdentry)->i_nlink == 1)
 760                 return fallback;
 761
 762         err = ovl_do_getxattr(ofs, upperdentry, OVL_XATTR_NLINK,
 763                               &buf, sizeof(buf) - 1);
 764         if (err < 0)
 765                 goto fail;
 766
 767         buf[err] = '\0';
 768         if ((buf[0] != 'L' && buf[0] != 'U') ||
 769             (buf[1] != '+' && buf[1] != '-'))
 770                 goto fail;
 771
 772         err = kstrtoint(buf + 1, 10, &nlink_diff);
 773         if (err < 0)
 774                 goto fail;
 775
 776         nlink = d_inode(buf[0] == 'L' ? lowerdentry : upperdentry)->i_nlink;
 777         nlink += nlink_diff;
 778
 779         if (nlink <= 0)
 780                 goto fail;
 781
 782         return nlink;
 783
 784 fail:
 785         pr_warn_ratelimited("failed to get index nlink (%pd2, err=%i)\n",
 786                             upperdentry, err);
 787         return fallback;
 788 }
 789
 790 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev)
 791 {
 792         struct inode *inode;
 793
 794         inode = new_inode(sb);
 795         if (inode)
 796                 ovl_fill_inode(inode, mode, rdev);
 797
 798         return inode;
 799 }
 800
 801 static int ovl_inode_test(struct inode *inode, void *data)
 802 {
 803         return inode->i_private == data;
 804 }
 805
 806 static int ovl_inode_set(struct inode *inode, void *data)
 807 {
 808         inode->i_private = data;
 809         return 0;
 810 }
 811
 812 static bool ovl_verify_inode(struct inode *inode, struct dentry *lowerdentry,
 813                              struct dentry *upperdentry, bool strict)
 814 {
 815         /*
 816          * For directories, @strict verify from lookup path performs consistency
 817          * checks, so NULL lower/upper in dentry must match NULL lower/upper in
 818          * inode. Non @strict verify from NFS handle decode path passes NULL for
 819          * 'unknown' lower/upper.
 820          */
 821         if (S_ISDIR(inode->i_mode) && strict) {
 822                 /* Real lower dir moved to upper layer under us? */
 823                 if (!lowerdentry && ovl_inode_lower(inode))
 824                         return false;
 825
 826                 /* Lookup of an uncovered redirect origin? */
 827                 if (!upperdentry && ovl_inode_upper(inode))
 828                         return false;
 829         }
 830
 831         /*
 832          * Allow non-NULL lower inode in ovl_inode even if lowerdentry is NULL.
 833          * This happens when finding a copied up overlay inode for a renamed
 834          * or hardlinked overlay dentry and lower dentry cannot be followed
 835          * by origin because lower fs does not support file handles.
 836          */
 837         if (lowerdentry && ovl_inode_lower(inode) != d_inode(lowerdentry))
 838                 return false;
 839
 840         /*
 841          * Allow non-NULL __upperdentry in inode even if upperdentry is NULL.
 842          * This happens when finding a lower alias for a copied up hard link.
 843          */
 844         if (upperdentry && ovl_inode_upper(inode) != d_inode(upperdentry))
 845                 return false;
 846
 847         return true;
 848 }
 849
 850 struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
 851                                bool is_upper)
 852 {
 853         struct inode *inode, *key = d_inode(real);
 854
 855         inode = ilookup5(sb, (unsigned long) key, ovl_inode_test, key);
 856         if (!inode)
 857                 return NULL;
 858
 859         if (!ovl_verify_inode(inode, is_upper ? NULL : real,
 860                               is_upper ? real : NULL, false)) {
 861                 iput(inode);
 862                 return ERR_PTR(-ESTALE);
 863         }
 864
 865         return inode;
 866 }
 867
 868 bool ovl_lookup_trap_inode(struct super_block *sb, struct dentry *dir)
 869 {
 870         struct inode *key = d_inode(dir);
 871         struct inode *trap;
 872         bool res;
 873
 874         trap = ilookup5(sb, (unsigned long) key, ovl_inode_test, key);
 875         if (!trap)
 876                 return false;
 877
 878         res = IS_DEADDIR(trap) && !ovl_inode_upper(trap) &&
 879                                   !ovl_inode_lower(trap);
 880
 881         iput(trap);
 882         return res;
 883 }
 884
 885 /*
 886  * Create an inode cache entry for layer root dir, that will intentionally
 887  * fail ovl_verify_inode(), so any lookup that will find some layer root
 888  * will fail.
 889  */
 890 struct inode *ovl_get_trap_inode(struct super_block *sb, struct dentry *dir)
 891 {
 892         struct inode *key = d_inode(dir);
 893         struct inode *trap;
 894
 895         if (!d_is_dir(dir))
 896                 return ERR_PTR(-ENOTDIR);
 897
 898         trap = iget5_locked(sb, (unsigned long) key, ovl_inode_test,
 899                             ovl_inode_set, key);
 900         if (!trap)
 901                 return ERR_PTR(-ENOMEM);
 902
 903         if (!(trap->i_state & I_NEW)) {
 904                 /* Conflicting layer roots? */
 905                 iput(trap);
 906                 return ERR_PTR(-ELOOP);
 907         }
 908
 909         trap->i_mode = S_IFDIR;
 910         trap->i_flags = S_DEAD;
 911         unlock_new_inode(trap);
 912
 913         return trap;
 914 }
 915
 916 /*
 917  * Does overlay inode need to be hashed by lower inode?
 918  */
 919 static bool ovl_hash_bylower(struct super_block *sb, struct dentry *upper,
 920                              struct dentry *lower, bool index)
 921 {
 922         struct ovl_fs *ofs = sb->s_fs_info;
 923
 924         /* No, if pure upper */
 925         if (!lower)
 926                 return false;
 927
 928         /* Yes, if already indexed */
 929         if (index)
 930                 return true;
 931
 932         /* Yes, if won't be copied up */
 933         if (!ovl_upper_mnt(ofs))
 934                 return true;
 935
 936         /* No, if lower hardlink is or will be broken on copy up */
 937         if ((upper || !ovl_indexdir(sb)) &&
 938             !d_is_dir(lower) && d_inode(lower)->i_nlink > 1)
 939                 return false;
 940
 941         /* No, if non-indexed upper with NFS export */
 942         if (sb->s_export_op && upper)
 943                 return false;
 944
 945         /* Otherwise, hash by lower inode for fsnotify */
 946         return true;
 947 }
 948
 949 static struct inode *ovl_iget5(struct super_block *sb, struct inode *newinode,
 950                                struct inode *key)
 951 {
 952         return newinode ? inode_insert5(newinode, (unsigned long) key,
 953                                          ovl_inode_test, ovl_inode_set, key) :
 954                           iget5_locked(sb, (unsigned long) key,
 955                                        ovl_inode_test, ovl_inode_set, key);
 956 }
 957
 958 struct inode *ovl_get_inode(struct super_block *sb,
 959                             struct ovl_inode_params *oip)
 960 {
 961         struct ovl_fs *ofs = OVL_FS(sb);
 962         struct dentry *upperdentry = oip->upperdentry;
 963         struct ovl_path *lowerpath = oip->lowerpath;
 964         struct inode *realinode = upperdentry ? d_inode(upperdentry) : NULL;
 965         struct inode *inode;
 966         struct dentry *lowerdentry = lowerpath ? lowerpath->dentry : NULL;
 967         bool bylower = ovl_hash_bylower(sb, upperdentry, lowerdentry,
 968                                         oip->index);
 969         int fsid = bylower ? lowerpath->layer->fsid : 0;
 970         bool is_dir;
 971         unsigned long ino = 0;
 972         int err = oip->newinode ? -EEXIST : -ENOMEM;
 973
 974         if (!realinode)
 975                 realinode = d_inode(lowerdentry);
 976
 977         /*
 978          * Copy up origin (lower) may exist for non-indexed upper, but we must
 979          * not use lower as hash key if this is a broken hardlink.
 980          */
 981         is_dir = S_ISDIR(realinode->i_mode);
 982         if (upperdentry || bylower) {
 983                 struct inode *key = d_inode(bylower ? lowerdentry :
 984                                                       upperdentry);
 985                 unsigned int nlink = is_dir ? 1 : realinode->i_nlink;
 986
 987                 inode = ovl_iget5(sb, oip->newinode, key);
 988                 if (!inode)
 989                         goto out_err;
 990                 if (!(inode->i_state & I_NEW)) {
 991                         /*
 992                          * Verify that the underlying files stored in the inode
 993                          * match those in the dentry.
 994                          */
 995                         if (!ovl_verify_inode(inode, lowerdentry, upperdentry,
 996                                               true)) {
 997                                 iput(inode);
 998                                 err = -ESTALE;
 999                                 goto out_err;
1000                         }
1001
1002                         dput(upperdentry);
1003                         kfree(oip->redirect);
1004                         goto out;
1005                 }
1006
1007                 /* Recalculate nlink for non-dir due to indexing */
1008                 if (!is_dir)
1009                         nlink = ovl_get_nlink(ofs, lowerdentry, upperdentry,
1010                                               nlink);
1011                 set_nlink(inode, nlink);
1012                 ino = key->i_ino;
1013         } else {
1014                 /* Lower hardlink that will be broken on copy up */
1015                 inode = new_inode(sb);
1016                 if (!inode) {
1017                         err = -ENOMEM;
1018                         goto out_err;
1019                 }
1020                 ino = realinode->i_ino;
1021                 fsid = lowerpath->layer->fsid;
1022         }
1023         ovl_fill_inode(inode, realinode->i_mode, realinode->i_rdev);
1024         ovl_inode_init(inode, oip, ino, fsid);
1025
1026         if (upperdentry && ovl_is_impuredir(sb, upperdentry))
1027                 ovl_set_flag(OVL_IMPURE, inode);
1028
1029         if (oip->index)
1030                 ovl_set_flag(OVL_INDEX, inode);
1031
1032         OVL_I(inode)->redirect = oip->redirect;
1033
1034         if (bylower)
1035                 ovl_set_flag(OVL_CONST_INO, inode);
1036
1037         /* Check for non-merge dir that may have whiteouts */
1038         if (is_dir) {
1039                 if (((upperdentry && lowerdentry) || oip->numlower > 1) ||
1040                     ovl_check_origin_xattr(ofs, upperdentry ?: lowerdentry)) {
1041                         ovl_set_flag(OVL_WHITEOUTS, inode);
1042                 }
1043         }
1044
1045         if (inode->i_state & I_NEW)
1046                 unlock_new_inode(inode);
1047 out:
1048         return inode;
1049
1050 out_err:
1051         pr_warn_ratelimited("failed to get inode (%i)\n", err);
1052         inode = ERR_PTR(err);
1053         goto out;
1054 }