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         return strncmp(name, OVL_XATTR_PREFIX,
 333                        sizeof(OVL_XATTR_PREFIX) - 1) == 0;
 334 }
 335
 336 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
 337                   const void *value, size_t size, int flags)
 338 {
 339         int err;
 340         struct dentry *upperdentry = ovl_i_dentry_upper(inode);
 341         struct dentry *realdentry = upperdentry ?: ovl_dentry_lower(dentry);
 342         const struct cred *old_cred;
 343
 344         err = ovl_want_write(dentry);
 345         if (err)
 346                 goto out;
 347
 348         if (!value && !upperdentry) {
 349                 err = vfs_getxattr(realdentry, name, NULL, 0);
 350                 if (err < 0)
 351                         goto out_drop_write;
 352         }
 353
 354         if (!upperdentry) {
 355                 err = ovl_copy_up(dentry);
 356                 if (err)
 357                         goto out_drop_write;
 358
 359                 realdentry = ovl_dentry_upper(dentry);
 360         }
 361
 362         old_cred = ovl_override_creds(dentry->d_sb);
 363         if (value)
 364                 err = vfs_setxattr(realdentry, name, value, size, flags);
 365         else {
 366                 WARN_ON(flags != XATTR_REPLACE);
 367                 err = vfs_removexattr(realdentry, name);
 368         }
 369         revert_creds(old_cred);
 370
 371         /* copy c/mtime */
 372         ovl_copyattr(d_inode(realdentry), inode);
 373
 374 out_drop_write:
 375         ovl_drop_write(dentry);
 376 out:
 377         return err;
 378 }
 379
 380 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
 381                   void *value, size_t size)
 382 {
 383         ssize_t res;
 384         const struct cred *old_cred;
 385         struct dentry *realdentry =
 386                 ovl_i_dentry_upper(inode) ?: ovl_dentry_lower(dentry);
 387
 388         old_cred = ovl_override_creds(dentry->d_sb);
 389         res = vfs_getxattr(realdentry, name, value, size);
 390         revert_creds(old_cred);
 391         return res;
 392 }
 393
 394 static bool ovl_can_list(struct super_block *sb, const char *s)
 395 {
 396         /* Never list private (.overlay) */
 397         if (ovl_is_private_xattr(sb, s))
 398                 return false;
 399
 400         /* List all non-trusted xatts */
 401         if (strncmp(s, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN) != 0)
 402                 return true;
 403
 404         /* list other trusted for superuser only */
 405         return ns_capable_noaudit(&init_user_ns, CAP_SYS_ADMIN);
 406 }
 407
 408 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size)
 409 {
 410         struct dentry *realdentry = ovl_dentry_real(dentry);
 411         ssize_t res;
 412         size_t len;
 413         char *s;
 414         const struct cred *old_cred;
 415
 416         old_cred = ovl_override_creds(dentry->d_sb);
 417         res = vfs_listxattr(realdentry, list, size);
 418         revert_creds(old_cred);
 419         if (res <= 0 || size == 0)
 420                 return res;
 421
 422         /* filter out private xattrs */
 423         for (s = list, len = res; len;) {
 424                 size_t slen = strnlen(s, len) + 1;
 425
 426                 /* underlying fs providing us with an broken xattr list? */
 427                 if (WARN_ON(slen > len))
 428                         return -EIO;
 429
 430                 len -= slen;
 431                 if (!ovl_can_list(dentry->d_sb, s)) {
 432                         res -= slen;
 433                         memmove(s, s + slen, len);
 434                 } else {
 435                         s += slen;
 436                 }
 437         }
 438
 439         return res;
 440 }
 441
 442 struct posix_acl *ovl_get_acl(struct inode *inode, int type)
 443 {
 444         struct inode *realinode = ovl_inode_real(inode);
 445         const struct cred *old_cred;
 446         struct posix_acl *acl;
 447
 448         if (!IS_ENABLED(CONFIG_FS_POSIX_ACL) || !IS_POSIXACL(realinode))
 449                 return NULL;
 450
 451         old_cred = ovl_override_creds(inode->i_sb);
 452         acl = get_acl(realinode, type);
 453         revert_creds(old_cred);
 454
 455         return acl;
 456 }
 457
 458 int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags)
 459 {
 460         if (flags & S_ATIME) {
 461                 struct ovl_fs *ofs = inode->i_sb->s_fs_info;
 462                 struct path upperpath = {
 463                         .mnt = ovl_upper_mnt(ofs),
 464                         .dentry = ovl_upperdentry_dereference(OVL_I(inode)),
 465                 };
 466
 467                 if (upperpath.dentry) {
 468                         touch_atime(&upperpath);
 469                         inode->i_atime = d_inode(upperpath.dentry)->i_atime;
 470                 }
 471         }
 472         return 0;
 473 }
 474
 475 static int ovl_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
 476                       u64 start, u64 len)
 477 {
 478         int err;
 479         struct inode *realinode = ovl_inode_real(inode);
 480         const struct cred *old_cred;
 481
 482         if (!realinode->i_op->fiemap)
 483                 return -EOPNOTSUPP;
 484
 485         old_cred = ovl_override_creds(inode->i_sb);
 486         err = realinode->i_op->fiemap(realinode, fieinfo, start, len);
 487         revert_creds(old_cred);
 488
 489         return err;
 490 }
 491
 492 static const struct inode_operations ovl_file_inode_operations = {
 493         .setattr        = ovl_setattr,
 494         .permission     = ovl_permission,
 495         .getattr        = ovl_getattr,
 496         .listxattr      = ovl_listxattr,
 497         .get_acl        = ovl_get_acl,
 498         .update_time    = ovl_update_time,
 499         .fiemap         = ovl_fiemap,
 500 };
 501
 502 static const struct inode_operations ovl_symlink_inode_operations = {
 503         .setattr        = ovl_setattr,
 504         .get_link       = ovl_get_link,
 505         .getattr        = ovl_getattr,
 506         .listxattr      = ovl_listxattr,
 507         .update_time    = ovl_update_time,
 508 };
 509
 510 static const struct inode_operations ovl_special_inode_operations = {
 511         .setattr        = ovl_setattr,
 512         .permission     = ovl_permission,
 513         .getattr        = ovl_getattr,
 514         .listxattr      = ovl_listxattr,
 515         .get_acl        = ovl_get_acl,
 516         .update_time    = ovl_update_time,
 517 };
 518
 519 static const struct address_space_operations ovl_aops = {
 520         /* For O_DIRECT dentry_open() checks f_mapping->a_ops->direct_IO */
 521         .direct_IO              = noop_direct_IO,
 522 };
 523
 524 /*
 525  * It is possible to stack overlayfs instance on top of another
 526  * overlayfs instance as lower layer. We need to annotate the
 527  * stackable i_mutex locks according to stack level of the super
 528  * block instance. An overlayfs instance can never be in stack
 529  * depth 0 (there is always a real fs below it).  An overlayfs
 530  * inode lock will use the lockdep annotaion ovl_i_mutex_key[depth].
 531  *
 532  * For example, here is a snip from /proc/lockdep_chains after
 533  * dir_iterate of nested overlayfs:
 534  *
 535  * [...] &ovl_i_mutex_dir_key[depth]   (stack_depth=2)
 536  * [...] &ovl_i_mutex_dir_key[depth]#2 (stack_depth=1)
 537  * [...] &type->i_mutex_dir_key        (stack_depth=0)
 538  *
 539  * Locking order w.r.t ovl_want_write() is important for nested overlayfs.
 540  *
 541  * This chain is valid:
 542  * - inode->i_rwsem                     (inode_lock[2])
 543  * - upper_mnt->mnt_sb->s_writers       (ovl_want_write[0])
 544  * - OVL_I(inode)->lock                 (ovl_inode_lock[2])
 545  * - OVL_I(lowerinode)->lock            (ovl_inode_lock[1])
 546  *
 547  * And this chain is valid:
 548  * - inode->i_rwsem                     (inode_lock[2])
 549  * - OVL_I(inode)->lock                 (ovl_inode_lock[2])
 550  * - lowerinode->i_rwsem                (inode_lock[1])
 551  * - OVL_I(lowerinode)->lock            (ovl_inode_lock[1])
 552  *
 553  * But lowerinode->i_rwsem SHOULD NOT be acquired while ovl_want_write() is
 554  * held, because it is in reverse order of the non-nested case using the same
 555  * upper fs:
 556  * - inode->i_rwsem                     (inode_lock[1])
 557  * - upper_mnt->mnt_sb->s_writers       (ovl_want_write[0])
 558  * - OVL_I(inode)->lock                 (ovl_inode_lock[1])
 559  */
 560 #define OVL_MAX_NESTING FILESYSTEM_MAX_STACK_DEPTH
 561
 562 static inline void ovl_lockdep_annotate_inode_mutex_key(struct inode *inode)
 563 {
 564 #ifdef CONFIG_LOCKDEP
 565         static struct lock_class_key ovl_i_mutex_key[OVL_MAX_NESTING];
 566         static struct lock_class_key ovl_i_mutex_dir_key[OVL_MAX_NESTING];
 567         static struct lock_class_key ovl_i_lock_key[OVL_MAX_NESTING];
 568
 569         int depth = inode->i_sb->s_stack_depth - 1;
 570
 571         if (WARN_ON_ONCE(depth < 0 || depth >= OVL_MAX_NESTING))
 572                 depth = 0;
 573
 574         if (S_ISDIR(inode->i_mode))
 575                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_dir_key[depth]);
 576         else
 577                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_key[depth]);
 578
 579         lockdep_set_class(&OVL_I(inode)->lock, &ovl_i_lock_key[depth]);
 580 #endif
 581 }
 582
 583 static void ovl_next_ino(struct inode *inode)
 584 {
 585         struct ovl_fs *ofs = inode->i_sb->s_fs_info;
 586
 587         inode->i_ino = atomic_long_inc_return(&ofs->last_ino);
 588         if (unlikely(!inode->i_ino))
 589                 inode->i_ino = atomic_long_inc_return(&ofs->last_ino);
 590 }
 591
 592 static void ovl_map_ino(struct inode *inode, unsigned long ino, int fsid)
 593 {
 594         int xinobits = ovl_xino_bits(inode->i_sb);
 595         unsigned int xinoshift = 64 - xinobits;
 596
 597         /*
 598          * When d_ino is consistent with st_ino (samefs or i_ino has enough
 599          * bits to encode layer), set the same value used for st_ino to i_ino,
 600          * so inode number exposed via /proc/locks and a like will be
 601          * consistent with d_ino and st_ino values. An i_ino value inconsistent
 602          * with d_ino also causes nfsd readdirplus to fail.
 603          */
 604         inode->i_ino = ino;
 605         if (ovl_same_fs(inode->i_sb)) {
 606                 return;
 607         } else if (xinobits && likely(!(ino >> xinoshift))) {
 608                 inode->i_ino |= (unsigned long)fsid << (xinoshift + 1);
 609                 return;
 610         }
 611
 612         /*
 613          * For directory inodes on non-samefs with xino disabled or xino
 614          * overflow, we allocate a non-persistent inode number, to be used for
 615          * resolving st_ino collisions in ovl_map_dev_ino().
 616          *
 617          * To avoid ino collision with legitimate xino values from upper
 618          * layer (fsid 0), use the lowest xinobit to map the non
 619          * persistent inode numbers to the unified st_ino address space.
 620          */
 621         if (S_ISDIR(inode->i_mode)) {
 622                 ovl_next_ino(inode);
 623                 if (xinobits) {
 624                         inode->i_ino &= ~0UL >> xinobits;
 625                         inode->i_ino |= 1UL << xinoshift;
 626                 }
 627         }
 628 }
 629
 630 void ovl_inode_init(struct inode *inode, struct ovl_inode_params *oip,
 631                     unsigned long ino, int fsid)
 632 {
 633         struct inode *realinode;
 634
 635         if (oip->upperdentry)
 636                 OVL_I(inode)->__upperdentry = oip->upperdentry;
 637         if (oip->lowerpath && oip->lowerpath->dentry)
 638                 OVL_I(inode)->lower = igrab(d_inode(oip->lowerpath->dentry));
 639         if (oip->lowerdata)
 640                 OVL_I(inode)->lowerdata = igrab(d_inode(oip->lowerdata));
 641
 642         realinode = ovl_inode_real(inode);
 643         ovl_copyattr(realinode, inode);
 644         ovl_copyflags(realinode, inode);
 645         ovl_map_ino(inode, ino, fsid);
 646 }
 647
 648 static void ovl_fill_inode(struct inode *inode, umode_t mode, dev_t rdev)
 649 {
 650         inode->i_mode = mode;
 651         inode->i_flags |= S_NOCMTIME;
 652 #ifdef CONFIG_FS_POSIX_ACL
 653         inode->i_acl = inode->i_default_acl = ACL_DONT_CACHE;
 654 #endif
 655
 656         ovl_lockdep_annotate_inode_mutex_key(inode);
 657
 658         switch (mode & S_IFMT) {
 659         case S_IFREG:
 660                 inode->i_op = &ovl_file_inode_operations;
 661                 inode->i_fop = &ovl_file_operations;
 662                 inode->i_mapping->a_ops = &ovl_aops;
 663                 break;
 664
 665         case S_IFDIR:
 666                 inode->i_op = &ovl_dir_inode_operations;
 667                 inode->i_fop = &ovl_dir_operations;
 668                 break;
 669
 670         case S_IFLNK:
 671                 inode->i_op = &ovl_symlink_inode_operations;
 672                 break;
 673
 674         default:
 675                 inode->i_op = &ovl_special_inode_operations;
 676                 init_special_inode(inode, mode, rdev);
 677                 break;
 678         }
 679 }
 680
 681 /*
 682  * With inodes index enabled, an overlay inode nlink counts the union of upper
 683  * hardlinks and non-covered lower hardlinks. During the lifetime of a non-pure
 684  * upper inode, the following nlink modifying operations can happen:
 685  *
 686  * 1. Lower hardlink copy up
 687  * 2. Upper hardlink created, unlinked or renamed over
 688  * 3. Lower hardlink whiteout or renamed over
 689  *
 690  * For the first, copy up case, the union nlink does not change, whether the
 691  * operation succeeds or fails, but the upper inode nlink may change.
 692  * Therefore, before copy up, we store the union nlink value relative to the
 693  * lower inode nlink in the index inode xattr trusted.overlay.nlink.
 694  *
 695  * For the second, upper hardlink case, the union nlink should be incremented
 696  * or decremented IFF the operation succeeds, aligned with nlink change of the
 697  * upper inode. Therefore, before link/unlink/rename, we store the union nlink
 698  * value relative to the upper inode nlink in the index inode.
 699  *
 700  * For the last, lower cover up case, we simplify things by preceding the
 701  * whiteout or cover up with copy up. This makes sure that there is an index
 702  * upper inode where the nlink xattr can be stored before the copied up upper
 703  * entry is unlink.
 704  */
 705 #define OVL_NLINK_ADD_UPPER     (1 << 0)
 706
 707 /*
 708  * On-disk format for indexed nlink:
 709  *
 710  * nlink relative to the upper inode - "U[+-]NUM"
 711  * nlink relative to the lower inode - "L[+-]NUM"
 712  */
 713
 714 static int ovl_set_nlink_common(struct dentry *dentry,
 715                                 struct dentry *realdentry, const char *format)
 716 {
 717         struct inode *inode = d_inode(dentry);
 718         struct inode *realinode = d_inode(realdentry);
 719         char buf[13];
 720         int len;
 721
 722         len = snprintf(buf, sizeof(buf), format,
 723                        (int) (inode->i_nlink - realinode->i_nlink));
 724
 725         if (WARN_ON(len >= sizeof(buf)))
 726                 return -EIO;
 727
 728         return ovl_do_setxattr(OVL_FS(inode->i_sb), ovl_dentry_upper(dentry),
 729                                OVL_XATTR_NLINK, buf, len);
 730 }
 731
 732 int ovl_set_nlink_upper(struct dentry *dentry)
 733 {
 734         return ovl_set_nlink_common(dentry, ovl_dentry_upper(dentry), "U%+i");
 735 }
 736
 737 int ovl_set_nlink_lower(struct dentry *dentry)
 738 {
 739         return ovl_set_nlink_common(dentry, ovl_dentry_lower(dentry), "L%+i");
 740 }
 741
 742 unsigned int ovl_get_nlink(struct ovl_fs *ofs, struct dentry *lowerdentry,
 743                            struct dentry *upperdentry,
 744                            unsigned int fallback)
 745 {
 746         int nlink_diff;
 747         int nlink;
 748         char buf[13];
 749         int err;
 750
 751         if (!lowerdentry || !upperdentry || d_inode(lowerdentry)->i_nlink == 1)
 752                 return fallback;
 753
 754         err = ovl_do_getxattr(ofs, upperdentry, OVL_XATTR_NLINK,
 755                               &buf, sizeof(buf) - 1);
 756         if (err < 0)
 757                 goto fail;
 758
 759         buf[err] = '\0';
 760         if ((buf[0] != 'L' && buf[0] != 'U') ||
 761             (buf[1] != '+' && buf[1] != '-'))
 762                 goto fail;
 763
 764         err = kstrtoint(buf + 1, 10, &nlink_diff);
 765         if (err < 0)
 766                 goto fail;
 767
 768         nlink = d_inode(buf[0] == 'L' ? lowerdentry : upperdentry)->i_nlink;
 769         nlink += nlink_diff;
 770
 771         if (nlink <= 0)
 772                 goto fail;
 773
 774         return nlink;
 775
 776 fail:
 777         pr_warn_ratelimited("failed to get index nlink (%pd2, err=%i)\n",
 778                             upperdentry, err);
 779         return fallback;
 780 }
 781
 782 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev)
 783 {
 784         struct inode *inode;
 785
 786         inode = new_inode(sb);
 787         if (inode)
 788                 ovl_fill_inode(inode, mode, rdev);
 789
 790         return inode;
 791 }
 792
 793 static int ovl_inode_test(struct inode *inode, void *data)
 794 {
 795         return inode->i_private == data;
 796 }
 797
 798 static int ovl_inode_set(struct inode *inode, void *data)
 799 {
 800         inode->i_private = data;
 801         return 0;
 802 }
 803
 804 static bool ovl_verify_inode(struct inode *inode, struct dentry *lowerdentry,
 805                              struct dentry *upperdentry, bool strict)
 806 {
 807         /*
 808          * For directories, @strict verify from lookup path performs consistency
 809          * checks, so NULL lower/upper in dentry must match NULL lower/upper in
 810          * inode. Non @strict verify from NFS handle decode path passes NULL for
 811          * 'unknown' lower/upper.
 812          */
 813         if (S_ISDIR(inode->i_mode) && strict) {
 814                 /* Real lower dir moved to upper layer under us? */
 815                 if (!lowerdentry && ovl_inode_lower(inode))
 816                         return false;
 817
 818                 /* Lookup of an uncovered redirect origin? */
 819                 if (!upperdentry && ovl_inode_upper(inode))
 820                         return false;
 821         }
 822
 823         /*
 824          * Allow non-NULL lower inode in ovl_inode even if lowerdentry is NULL.
 825          * This happens when finding a copied up overlay inode for a renamed
 826          * or hardlinked overlay dentry and lower dentry cannot be followed
 827          * by origin because lower fs does not support file handles.
 828          */
 829         if (lowerdentry && ovl_inode_lower(inode) != d_inode(lowerdentry))
 830                 return false;
 831
 832         /*
 833          * Allow non-NULL __upperdentry in inode even if upperdentry is NULL.
 834          * This happens when finding a lower alias for a copied up hard link.
 835          */
 836         if (upperdentry && ovl_inode_upper(inode) != d_inode(upperdentry))
 837                 return false;
 838
 839         return true;
 840 }
 841
 842 struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
 843                                bool is_upper)
 844 {
 845         struct inode *inode, *key = d_inode(real);
 846
 847         inode = ilookup5(sb, (unsigned long) key, ovl_inode_test, key);
 848         if (!inode)
 849                 return NULL;
 850
 851         if (!ovl_verify_inode(inode, is_upper ? NULL : real,
 852                               is_upper ? real : NULL, false)) {
 853                 iput(inode);
 854                 return ERR_PTR(-ESTALE);
 855         }
 856
 857         return inode;
 858 }
 859
 860 bool ovl_lookup_trap_inode(struct super_block *sb, struct dentry *dir)
 861 {
 862         struct inode *key = d_inode(dir);
 863         struct inode *trap;
 864         bool res;
 865
 866         trap = ilookup5(sb, (unsigned long) key, ovl_inode_test, key);
 867         if (!trap)
 868                 return false;
 869
 870         res = IS_DEADDIR(trap) && !ovl_inode_upper(trap) &&
 871                                   !ovl_inode_lower(trap);
 872
 873         iput(trap);
 874         return res;
 875 }
 876
 877 /*
 878  * Create an inode cache entry for layer root dir, that will intentionally
 879  * fail ovl_verify_inode(), so any lookup that will find some layer root
 880  * will fail.
 881  */
 882 struct inode *ovl_get_trap_inode(struct super_block *sb, struct dentry *dir)
 883 {
 884         struct inode *key = d_inode(dir);
 885         struct inode *trap;
 886
 887         if (!d_is_dir(dir))
 888                 return ERR_PTR(-ENOTDIR);
 889
 890         trap = iget5_locked(sb, (unsigned long) key, ovl_inode_test,
 891                             ovl_inode_set, key);
 892         if (!trap)
 893                 return ERR_PTR(-ENOMEM);
 894
 895         if (!(trap->i_state & I_NEW)) {
 896                 /* Conflicting layer roots? */
 897                 iput(trap);
 898                 return ERR_PTR(-ELOOP);
 899         }
 900
 901         trap->i_mode = S_IFDIR;
 902         trap->i_flags = S_DEAD;
 903         unlock_new_inode(trap);
 904
 905         return trap;
 906 }
 907
 908 /*
 909  * Does overlay inode need to be hashed by lower inode?
 910  */
 911 static bool ovl_hash_bylower(struct super_block *sb, struct dentry *upper,
 912                              struct dentry *lower, bool index)
 913 {
 914         struct ovl_fs *ofs = sb->s_fs_info;
 915
 916         /* No, if pure upper */
 917         if (!lower)
 918                 return false;
 919
 920         /* Yes, if already indexed */
 921         if (index)
 922                 return true;
 923
 924         /* Yes, if won't be copied up */
 925         if (!ovl_upper_mnt(ofs))
 926                 return true;
 927
 928         /* No, if lower hardlink is or will be broken on copy up */
 929         if ((upper || !ovl_indexdir(sb)) &&
 930             !d_is_dir(lower) && d_inode(lower)->i_nlink > 1)
 931                 return false;
 932
 933         /* No, if non-indexed upper with NFS export */
 934         if (sb->s_export_op && upper)
 935                 return false;
 936
 937         /* Otherwise, hash by lower inode for fsnotify */
 938         return true;
 939 }
 940
 941 static struct inode *ovl_iget5(struct super_block *sb, struct inode *newinode,
 942                                struct inode *key)
 943 {
 944         return newinode ? inode_insert5(newinode, (unsigned long) key,
 945                                          ovl_inode_test, ovl_inode_set, key) :
 946                           iget5_locked(sb, (unsigned long) key,
 947                                        ovl_inode_test, ovl_inode_set, key);
 948 }
 949
 950 struct inode *ovl_get_inode(struct super_block *sb,
 951                             struct ovl_inode_params *oip)
 952 {
 953         struct ovl_fs *ofs = OVL_FS(sb);
 954         struct dentry *upperdentry = oip->upperdentry;
 955         struct ovl_path *lowerpath = oip->lowerpath;
 956         struct inode *realinode = upperdentry ? d_inode(upperdentry) : NULL;
 957         struct inode *inode;
 958         struct dentry *lowerdentry = lowerpath ? lowerpath->dentry : NULL;
 959         bool bylower = ovl_hash_bylower(sb, upperdentry, lowerdentry,
 960                                         oip->index);
 961         int fsid = bylower ? lowerpath->layer->fsid : 0;
 962         bool is_dir;
 963         unsigned long ino = 0;
 964         int err = oip->newinode ? -EEXIST : -ENOMEM;
 965
 966         if (!realinode)
 967                 realinode = d_inode(lowerdentry);
 968
 969         /*
 970          * Copy up origin (lower) may exist for non-indexed upper, but we must
 971          * not use lower as hash key if this is a broken hardlink.
 972          */
 973         is_dir = S_ISDIR(realinode->i_mode);
 974         if (upperdentry || bylower) {
 975                 struct inode *key = d_inode(bylower ? lowerdentry :
 976                                                       upperdentry);
 977                 unsigned int nlink = is_dir ? 1 : realinode->i_nlink;
 978
 979                 inode = ovl_iget5(sb, oip->newinode, key);
 980                 if (!inode)
 981                         goto out_err;
 982                 if (!(inode->i_state & I_NEW)) {
 983                         /*
 984                          * Verify that the underlying files stored in the inode
 985                          * match those in the dentry.
 986                          */
 987                         if (!ovl_verify_inode(inode, lowerdentry, upperdentry,
 988                                               true)) {
 989                                 iput(inode);
 990                                 err = -ESTALE;
 991                                 goto out_err;
 992                         }
 993
 994                         dput(upperdentry);
 995                         kfree(oip->redirect);
 996                         goto out;
 997                 }
 998
 999                 /* Recalculate nlink for non-dir due to indexing */
1000                 if (!is_dir)
1001                         nlink = ovl_get_nlink(ofs, lowerdentry, upperdentry,
1002                                               nlink);
1003                 set_nlink(inode, nlink);
1004                 ino = key->i_ino;
1005         } else {
1006                 /* Lower hardlink that will be broken on copy up */
1007                 inode = new_inode(sb);
1008                 if (!inode) {
1009                         err = -ENOMEM;
1010                         goto out_err;
1011                 }
1012                 ino = realinode->i_ino;
1013                 fsid = lowerpath->layer->fsid;
1014         }
1015         ovl_fill_inode(inode, realinode->i_mode, realinode->i_rdev);
1016         ovl_inode_init(inode, oip, ino, fsid);
1017
1018         if (upperdentry && ovl_is_impuredir(sb, upperdentry))
1019                 ovl_set_flag(OVL_IMPURE, inode);
1020
1021         if (oip->index)
1022                 ovl_set_flag(OVL_INDEX, inode);
1023
1024         OVL_I(inode)->redirect = oip->redirect;
1025
1026         if (bylower)
1027                 ovl_set_flag(OVL_CONST_INO, inode);
1028
1029         /* Check for non-merge dir that may have whiteouts */
1030         if (is_dir) {
1031                 if (((upperdentry && lowerdentry) || oip->numlower > 1) ||
1032                     ovl_check_origin_xattr(ofs, upperdentry ?: lowerdentry)) {
1033                         ovl_set_flag(OVL_WHITEOUTS, inode);
1034                 }
1035         }
1036
1037         if (inode->i_state & I_NEW)
1038                 unlock_new_inode(inode);
1039 out:
1040         return inode;
1041
1042 out_err:
1043         pr_warn_ratelimited("failed to get inode (%i)\n", err);
1044         inode = ERR_PTR(err);
1045         goto out;
1046 }