fs/overlayfs/inode.c

   1 /*
   2  *
   3  * Copyright (C) 2011 Novell Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  */
   9
  10 #include <linux/fs.h>
  11 #include <linux/slab.h>
  12 #include <linux/cred.h>
  13 #include <linux/xattr.h>
  14 #include <linux/posix_acl.h>
  15 #include <linux/ratelimit.h>
  16 #include "overlayfs.h"
  17
  18
  19 int ovl_setattr(struct dentry *dentry, struct iattr *attr)
  20 {
  21         int err;
  22         struct dentry *upperdentry;
  23         const struct cred *old_cred;
  24
  25         err = setattr_prepare(dentry, attr);
  26         if (err)
  27                 return err;
  28
  29         err = ovl_want_write(dentry);
  30         if (err)
  31                 goto out;
  32
  33         if (attr->ia_valid & ATTR_SIZE) {
  34                 struct inode *realinode = d_inode(ovl_dentry_real(dentry));
  35
  36                 err = -ETXTBSY;
  37                 if (atomic_read(&realinode->i_writecount) < 0)
  38                         goto out_drop_write;
  39         }
  40
  41         err = ovl_copy_up(dentry);
  42         if (!err) {
  43                 struct inode *winode = NULL;
  44
  45                 upperdentry = ovl_dentry_upper(dentry);
  46
  47                 if (attr->ia_valid & ATTR_SIZE) {
  48                         winode = d_inode(upperdentry);
  49                         err = get_write_access(winode);
  50                         if (err)
  51                                 goto out_drop_write;
  52                 }
  53
  54                 if (attr->ia_valid & (ATTR_KILL_SUID|ATTR_KILL_SGID))
  55                         attr->ia_valid &= ~ATTR_MODE;
  56
  57                 inode_lock(upperdentry->d_inode);
  58                 old_cred = ovl_override_creds(dentry->d_sb);
  59                 err = notify_change(upperdentry, attr, NULL);
  60                 revert_creds(old_cred);
  61                 if (!err)
  62                         ovl_copyattr(upperdentry->d_inode, dentry->d_inode);
  63                 inode_unlock(upperdentry->d_inode);
  64
  65                 if (winode)
  66                         put_write_access(winode);
  67         }
  68 out_drop_write:
  69         ovl_drop_write(dentry);
  70 out:
  71         return err;
  72 }
  73
  74 static int ovl_map_dev_ino(struct dentry *dentry, struct kstat *stat,
  75                            struct ovl_layer *lower_layer)
  76 {
  77         bool samefs = ovl_same_sb(dentry->d_sb);
  78         unsigned int xinobits = ovl_xino_bits(dentry->d_sb);
  79
  80         if (samefs) {
  81                 /*
  82                  * When all layers are on the same fs, all real inode
  83                  * number are unique, so we use the overlay st_dev,
  84                  * which is friendly to du -x.
  85                  */
  86                 stat->dev = dentry->d_sb->s_dev;
  87                 return 0;
  88         } else if (xinobits) {
  89                 unsigned int shift = 64 - xinobits;
  90                 /*
  91                  * All inode numbers of underlying fs should not be using the
  92                  * high xinobits, so we use high xinobits to partition the
  93                  * overlay st_ino address space. The high bits holds the fsid
  94                  * (upper fsid is 0). This way overlay inode numbers are unique
  95                  * and all inodes use overlay st_dev. Inode numbers are also
  96                  * persistent for a given layer configuration.
  97                  */
  98                 if (stat->ino >> shift) {
  99                         pr_warn_ratelimited("overlayfs: inode number too big (%pd2, ino=%llu, xinobits=%d)\n",
 100                                             dentry, stat->ino, xinobits);
 101                 } else {
 102                         if (lower_layer)
 103                                 stat->ino |= ((u64)lower_layer->fsid) << shift;
 104
 105                         stat->dev = dentry->d_sb->s_dev;
 106                         return 0;
 107                 }
 108         }
 109
 110         /* The inode could not be mapped to a unified st_ino address space */
 111         if (S_ISDIR(dentry->d_inode->i_mode)) {
 112                 /*
 113                  * Always use the overlay st_dev for directories, so 'find
 114                  * -xdev' will scan the entire overlay mount and won't cross the
 115                  * overlay mount boundaries.
 116                  *
 117                  * If not all layers are on the same fs the pair {real st_ino;
 118                  * overlay st_dev} is not unique, so use the non persistent
 119                  * overlay st_ino for directories.
 120                  */
 121                 stat->dev = dentry->d_sb->s_dev;
 122                 stat->ino = dentry->d_inode->i_ino;
 123         } else if (lower_layer && lower_layer->fsid) {
 124                 /*
 125                  * For non-samefs setup, if we cannot map all layers st_ino
 126                  * to a unified address space, we need to make sure that st_dev
 127                  * is unique per lower fs. Upper layer uses real st_dev and
 128                  * lower layers use the unique anonymous bdev assigned to the
 129                  * lower fs.
 130                  */
 131                 stat->dev = lower_layer->fs->pseudo_dev;
 132         }
 133
 134         return 0;
 135 }
 136
 137 int ovl_getattr(const struct path *path, struct kstat *stat,
 138                 u32 request_mask, unsigned int flags)
 139 {
 140         struct dentry *dentry = path->dentry;
 141         enum ovl_path_type type;
 142         struct path realpath;
 143         const struct cred *old_cred;
 144         bool is_dir = S_ISDIR(dentry->d_inode->i_mode);
 145         bool samefs = ovl_same_sb(dentry->d_sb);
 146         struct ovl_layer *lower_layer = NULL;
 147         int err;
 148
 149         type = ovl_path_real(dentry, &realpath);
 150         old_cred = ovl_override_creds(dentry->d_sb);
 151         err = vfs_getattr(&realpath, stat, request_mask, flags);
 152         if (err)
 153                 goto out;
 154
 155         /*
 156          * For non-dir or same fs, we use st_ino of the copy up origin.
 157          * This guaranties constant st_dev/st_ino across copy up.
 158          * With xino feature and non-samefs, we use st_ino of the copy up
 159          * origin masked with high bits that represent the layer id.
 160          *
 161          * If lower filesystem supports NFS file handles, this also guaranties
 162          * persistent st_ino across mount cycle.
 163          */
 164         if (!is_dir || samefs || ovl_xino_bits(dentry->d_sb)) {
 165                 if (!OVL_TYPE_UPPER(type)) {
 166                         lower_layer = ovl_layer_lower(dentry);
 167                 } else if (OVL_TYPE_ORIGIN(type)) {
 168                         struct kstat lowerstat;
 169                         u32 lowermask = STATX_INO | (!is_dir ? STATX_NLINK : 0);
 170
 171                         ovl_path_lower(dentry, &realpath);
 172                         err = vfs_getattr(&realpath, &lowerstat,
 173                                           lowermask, flags);
 174                         if (err)
 175                                 goto out;
 176
 177                         /*
 178                          * Lower hardlinks may be broken on copy up to different
 179                          * upper files, so we cannot use the lower origin st_ino
 180                          * for those different files, even for the same fs case.
 181                          *
 182                          * Similarly, several redirected dirs can point to the
 183                          * same dir on a lower layer. With the "verify_lower"
 184                          * feature, we do not use the lower origin st_ino, if
 185                          * we haven't verified that this redirect is unique.
 186                          *
 187                          * With inodes index enabled, it is safe to use st_ino
 188                          * of an indexed origin. The index validates that the
 189                          * upper hardlink is not broken and that a redirected
 190                          * dir is the only redirect to that origin.
 191                          */
 192                         if (ovl_test_flag(OVL_INDEX, d_inode(dentry)) ||
 193                             (!ovl_verify_lower(dentry->d_sb) &&
 194                              (is_dir || lowerstat.nlink == 1))) {
 195                                 stat->ino = lowerstat.ino;
 196                                 lower_layer = ovl_layer_lower(dentry);
 197                         }
 198                 }
 199         }
 200
 201         err = ovl_map_dev_ino(dentry, stat, lower_layer);
 202         if (err)
 203                 goto out;
 204
 205         /*
 206          * It's probably not worth it to count subdirs to get the
 207          * correct link count.  nlink=1 seems to pacify 'find' and
 208          * other utilities.
 209          */
 210         if (is_dir && OVL_TYPE_MERGE(type))
 211                 stat->nlink = 1;
 212
 213         /*
 214          * Return the overlay inode nlinks for indexed upper inodes.
 215          * Overlay inode nlink counts the union of the upper hardlinks
 216          * and non-covered lower hardlinks. It does not include the upper
 217          * index hardlink.
 218          */
 219         if (!is_dir && ovl_test_flag(OVL_INDEX, d_inode(dentry)))
 220                 stat->nlink = dentry->d_inode->i_nlink;
 221
 222 out:
 223         revert_creds(old_cred);
 224
 225         return err;
 226 }
 227
 228 int ovl_permission(struct inode *inode, int mask)
 229 {
 230         struct inode *upperinode = ovl_inode_upper(inode);
 231         struct inode *realinode = upperinode ?: ovl_inode_lower(inode);
 232         const struct cred *old_cred;
 233         int err;
 234
 235         /* Careful in RCU walk mode */
 236         if (!realinode) {
 237                 WARN_ON(!(mask & MAY_NOT_BLOCK));
 238                 return -ECHILD;
 239         }
 240
 241         /*
 242          * Check overlay inode with the creds of task and underlying inode
 243          * with creds of mounter
 244          */
 245         err = generic_permission(inode, mask);
 246         if (err)
 247                 return err;
 248
 249         old_cred = ovl_override_creds(inode->i_sb);
 250         if (!upperinode &&
 251             !special_file(realinode->i_mode) && mask & MAY_WRITE) {
 252                 mask &= ~(MAY_WRITE | MAY_APPEND);
 253                 /* Make sure mounter can read file for copy up later */
 254                 mask |= MAY_READ;
 255         }
 256         err = inode_permission(realinode, mask);
 257         revert_creds(old_cred);
 258
 259         return err;
 260 }
 261
 262 static const char *ovl_get_link(struct dentry *dentry,
 263                                 struct inode *inode,
 264                                 struct delayed_call *done)
 265 {
 266         const struct cred *old_cred;
 267         const char *p;
 268
 269         if (!dentry)
 270                 return ERR_PTR(-ECHILD);
 271
 272         old_cred = ovl_override_creds(dentry->d_sb);
 273         p = vfs_get_link(ovl_dentry_real(dentry), done);
 274         revert_creds(old_cred);
 275         return p;
 276 }
 277
 278 bool ovl_is_private_xattr(const char *name)
 279 {
 280         return strncmp(name, OVL_XATTR_PREFIX,
 281                        sizeof(OVL_XATTR_PREFIX) - 1) == 0;
 282 }
 283
 284 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
 285                   const void *value, size_t size, int flags)
 286 {
 287         int err;
 288         struct dentry *upperdentry = ovl_i_dentry_upper(inode);
 289         struct dentry *realdentry = upperdentry ?: ovl_dentry_lower(dentry);
 290         const struct cred *old_cred;
 291
 292         err = ovl_want_write(dentry);
 293         if (err)
 294                 goto out;
 295
 296         if (!value && !upperdentry) {
 297                 err = vfs_getxattr(realdentry, name, NULL, 0);
 298                 if (err < 0)
 299                         goto out_drop_write;
 300         }
 301
 302         if (!upperdentry) {
 303                 err = ovl_copy_up(dentry);
 304                 if (err)
 305                         goto out_drop_write;
 306
 307                 realdentry = ovl_dentry_upper(dentry);
 308         }
 309
 310         old_cred = ovl_override_creds(dentry->d_sb);
 311         if (value)
 312                 err = vfs_setxattr(realdentry, name, value, size, flags);
 313         else {
 314                 WARN_ON(flags != XATTR_REPLACE);
 315                 err = vfs_removexattr(realdentry, name);
 316         }
 317         revert_creds(old_cred);
 318
 319         /* copy c/mtime */
 320         ovl_copyattr(d_inode(realdentry), inode);
 321
 322 out_drop_write:
 323         ovl_drop_write(dentry);
 324 out:
 325         return err;
 326 }
 327
 328 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
 329                   void *value, size_t size)
 330 {
 331         ssize_t res;
 332         const struct cred *old_cred;
 333         struct dentry *realdentry =
 334                 ovl_i_dentry_upper(inode) ?: ovl_dentry_lower(dentry);
 335
 336         old_cred = ovl_override_creds(dentry->d_sb);
 337         res = vfs_getxattr(realdentry, name, value, size);
 338         revert_creds(old_cred);
 339         return res;
 340 }
 341
 342 static bool ovl_can_list(const char *s)
 343 {
 344         /* List all non-trusted xatts */
 345         if (strncmp(s, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN) != 0)
 346                 return true;
 347
 348         /* Never list trusted.overlay, list other trusted for superuser only */
 349         return !ovl_is_private_xattr(s) && capable(CAP_SYS_ADMIN);
 350 }
 351
 352 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size)
 353 {
 354         struct dentry *realdentry = ovl_dentry_real(dentry);
 355         ssize_t res;
 356         size_t len;
 357         char *s;
 358         const struct cred *old_cred;
 359
 360         old_cred = ovl_override_creds(dentry->d_sb);
 361         res = vfs_listxattr(realdentry, list, size);
 362         revert_creds(old_cred);
 363         if (res <= 0 || size == 0)
 364                 return res;
 365
 366         /* filter out private xattrs */
 367         for (s = list, len = res; len;) {
 368                 size_t slen = strnlen(s, len) + 1;
 369
 370                 /* underlying fs providing us with an broken xattr list? */
 371                 if (WARN_ON(slen > len))
 372                         return -EIO;
 373
 374                 len -= slen;
 375                 if (!ovl_can_list(s)) {
 376                         res -= slen;
 377                         memmove(s, s + slen, len);
 378                 } else {
 379                         s += slen;
 380                 }
 381         }
 382
 383         return res;
 384 }
 385
 386 struct posix_acl *ovl_get_acl(struct inode *inode, int type)
 387 {
 388         struct inode *realinode = ovl_inode_real(inode);
 389         const struct cred *old_cred;
 390         struct posix_acl *acl;
 391
 392         if (!IS_ENABLED(CONFIG_FS_POSIX_ACL) || !IS_POSIXACL(realinode))
 393                 return NULL;
 394
 395         old_cred = ovl_override_creds(inode->i_sb);
 396         acl = get_acl(realinode, type);
 397         revert_creds(old_cred);
 398
 399         return acl;
 400 }
 401
 402 static bool ovl_open_need_copy_up(struct dentry *dentry, int flags)
 403 {
 404         /* Copy up of disconnected dentry does not set upper alias */
 405         if (ovl_dentry_upper(dentry) &&
 406             (ovl_dentry_has_upper_alias(dentry) ||
 407              (dentry->d_flags & DCACHE_DISCONNECTED)))
 408                 return false;
 409
 410         if (special_file(d_inode(dentry)->i_mode))
 411                 return false;
 412
 413         if (!(OPEN_FMODE(flags) & FMODE_WRITE) && !(flags & O_TRUNC))
 414                 return false;
 415
 416         return true;
 417 }
 418
 419 int ovl_open_maybe_copy_up(struct dentry *dentry, unsigned int file_flags)
 420 {
 421         int err = 0;
 422
 423         if (ovl_open_need_copy_up(dentry, file_flags)) {
 424                 err = ovl_want_write(dentry);
 425                 if (!err) {
 426                         err = ovl_copy_up_flags(dentry, file_flags);
 427                         ovl_drop_write(dentry);
 428                 }
 429         }
 430
 431         return err;
 432 }
 433
 434 int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags)
 435 {
 436         if (flags & S_ATIME) {
 437                 struct ovl_fs *ofs = inode->i_sb->s_fs_info;
 438                 struct path upperpath = {
 439                         .mnt = ofs->upper_mnt,
 440                         .dentry = ovl_upperdentry_dereference(OVL_I(inode)),
 441                 };
 442
 443                 if (upperpath.dentry) {
 444                         touch_atime(&upperpath);
 445                         inode->i_atime = d_inode(upperpath.dentry)->i_atime;
 446                 }
 447         }
 448         return 0;
 449 }
 450
 451 static const struct inode_operations ovl_file_inode_operations = {
 452         .setattr        = ovl_setattr,
 453         .permission     = ovl_permission,
 454         .getattr        = ovl_getattr,
 455         .listxattr      = ovl_listxattr,
 456         .get_acl        = ovl_get_acl,
 457         .update_time    = ovl_update_time,
 458 };
 459
 460 static const struct inode_operations ovl_symlink_inode_operations = {
 461         .setattr        = ovl_setattr,
 462         .get_link       = ovl_get_link,
 463         .getattr        = ovl_getattr,
 464         .listxattr      = ovl_listxattr,
 465         .update_time    = ovl_update_time,
 466 };
 467
 468 /*
 469  * It is possible to stack overlayfs instance on top of another
 470  * overlayfs instance as lower layer. We need to annonate the
 471  * stackable i_mutex locks according to stack level of the super
 472  * block instance. An overlayfs instance can never be in stack
 473  * depth 0 (there is always a real fs below it).  An overlayfs
 474  * inode lock will use the lockdep annotaion ovl_i_mutex_key[depth].
 475  *
 476  * For example, here is a snip from /proc/lockdep_chains after
 477  * dir_iterate of nested overlayfs:
 478  *
 479  * [...] &ovl_i_mutex_dir_key[depth]   (stack_depth=2)
 480  * [...] &ovl_i_mutex_dir_key[depth]#2 (stack_depth=1)
 481  * [...] &type->i_mutex_dir_key        (stack_depth=0)
 482  */
 483 #define OVL_MAX_NESTING FILESYSTEM_MAX_STACK_DEPTH
 484
 485 static inline void ovl_lockdep_annotate_inode_mutex_key(struct inode *inode)
 486 {
 487 #ifdef CONFIG_LOCKDEP
 488         static struct lock_class_key ovl_i_mutex_key[OVL_MAX_NESTING];
 489         static struct lock_class_key ovl_i_mutex_dir_key[OVL_MAX_NESTING];
 490         static struct lock_class_key ovl_i_lock_key[OVL_MAX_NESTING];
 491
 492         int depth = inode->i_sb->s_stack_depth - 1;
 493
 494         if (WARN_ON_ONCE(depth < 0 || depth >= OVL_MAX_NESTING))
 495                 depth = 0;
 496
 497         if (S_ISDIR(inode->i_mode))
 498                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_dir_key[depth]);
 499         else
 500                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_key[depth]);
 501
 502         lockdep_set_class(&OVL_I(inode)->lock, &ovl_i_lock_key[depth]);
 503 #endif
 504 }
 505
 506 static void ovl_fill_inode(struct inode *inode, umode_t mode, dev_t rdev,
 507                            unsigned long ino, int fsid)
 508 {
 509         int xinobits = ovl_xino_bits(inode->i_sb);
 510
 511         /*
 512          * When NFS export is enabled and d_ino is consistent with st_ino
 513          * (samefs or i_ino has enough bits to encode layer), set the same
 514          * value used for d_ino to i_ino, because nfsd readdirplus compares
 515          * d_ino values to i_ino values of child entries. When called from
 516          * ovl_new_inode(), ino arg is 0, so i_ino will be updated to real
 517          * upper inode i_ino on ovl_inode_init() or ovl_inode_update().
 518          */
 519         if (inode->i_sb->s_export_op &&
 520             (ovl_same_sb(inode->i_sb) || xinobits)) {
 521                 inode->i_ino = ino;
 522                 if (xinobits && fsid && !(ino >> (64 - xinobits)))
 523                         inode->i_ino |= (unsigned long)fsid << (64 - xinobits);
 524         } else {
 525                 inode->i_ino = get_next_ino();
 526         }
 527         inode->i_mode = mode;
 528         inode->i_flags |= S_NOCMTIME;
 529 #ifdef CONFIG_FS_POSIX_ACL
 530         inode->i_acl = inode->i_default_acl = ACL_DONT_CACHE;
 531 #endif
 532
 533         ovl_lockdep_annotate_inode_mutex_key(inode);
 534
 535         switch (mode & S_IFMT) {
 536         case S_IFREG:
 537                 inode->i_op = &ovl_file_inode_operations;
 538                 inode->i_fop = &ovl_file_operations;
 539                 break;
 540
 541         case S_IFDIR:
 542                 inode->i_op = &ovl_dir_inode_operations;
 543                 inode->i_fop = &ovl_dir_operations;
 544                 break;
 545
 546         case S_IFLNK:
 547                 inode->i_op = &ovl_symlink_inode_operations;
 548                 break;
 549
 550         default:
 551                 inode->i_op = &ovl_file_inode_operations;
 552                 init_special_inode(inode, mode, rdev);
 553                 break;
 554         }
 555 }
 556
 557 /*
 558  * With inodes index enabled, an overlay inode nlink counts the union of upper
 559  * hardlinks and non-covered lower hardlinks. During the lifetime of a non-pure
 560  * upper inode, the following nlink modifying operations can happen:
 561  *
 562  * 1. Lower hardlink copy up
 563  * 2. Upper hardlink created, unlinked or renamed over
 564  * 3. Lower hardlink whiteout or renamed over
 565  *
 566  * For the first, copy up case, the union nlink does not change, whether the
 567  * operation succeeds or fails, but the upper inode nlink may change.
 568  * Therefore, before copy up, we store the union nlink value relative to the
 569  * lower inode nlink in the index inode xattr trusted.overlay.nlink.
 570  *
 571  * For the second, upper hardlink case, the union nlink should be incremented
 572  * or decremented IFF the operation succeeds, aligned with nlink change of the
 573  * upper inode. Therefore, before link/unlink/rename, we store the union nlink
 574  * value relative to the upper inode nlink in the index inode.
 575  *
 576  * For the last, lower cover up case, we simplify things by preceding the
 577  * whiteout or cover up with copy up. This makes sure that there is an index
 578  * upper inode where the nlink xattr can be stored before the copied up upper
 579  * entry is unlink.
 580  */
 581 #define OVL_NLINK_ADD_UPPER     (1 << 0)
 582
 583 /*
 584  * On-disk format for indexed nlink:
 585  *
 586  * nlink relative to the upper inode - "U[+-]NUM"
 587  * nlink relative to the lower inode - "L[+-]NUM"
 588  */
 589
 590 static int ovl_set_nlink_common(struct dentry *dentry,
 591                                 struct dentry *realdentry, const char *format)
 592 {
 593         struct inode *inode = d_inode(dentry);
 594         struct inode *realinode = d_inode(realdentry);
 595         char buf[13];
 596         int len;
 597
 598         len = snprintf(buf, sizeof(buf), format,
 599                        (int) (inode->i_nlink - realinode->i_nlink));
 600
 601         if (WARN_ON(len >= sizeof(buf)))
 602                 return -EIO;
 603
 604         return ovl_do_setxattr(ovl_dentry_upper(dentry),
 605                                OVL_XATTR_NLINK, buf, len, 0);
 606 }
 607
 608 int ovl_set_nlink_upper(struct dentry *dentry)
 609 {
 610         return ovl_set_nlink_common(dentry, ovl_dentry_upper(dentry), "U%+i");
 611 }
 612
 613 int ovl_set_nlink_lower(struct dentry *dentry)
 614 {
 615         return ovl_set_nlink_common(dentry, ovl_dentry_lower(dentry), "L%+i");
 616 }
 617
 618 unsigned int ovl_get_nlink(struct dentry *lowerdentry,
 619                            struct dentry *upperdentry,
 620                            unsigned int fallback)
 621 {
 622         int nlink_diff;
 623         int nlink;
 624         char buf[13];
 625         int err;
 626
 627         if (!lowerdentry || !upperdentry || d_inode(lowerdentry)->i_nlink == 1)
 628                 return fallback;
 629
 630         err = vfs_getxattr(upperdentry, OVL_XATTR_NLINK, &buf, sizeof(buf) - 1);
 631         if (err < 0)
 632                 goto fail;
 633
 634         buf[err] = '\0';
 635         if ((buf[0] != 'L' && buf[0] != 'U') ||
 636             (buf[1] != '+' && buf[1] != '-'))
 637                 goto fail;
 638
 639         err = kstrtoint(buf + 1, 10, &nlink_diff);
 640         if (err < 0)
 641                 goto fail;
 642
 643         nlink = d_inode(buf[0] == 'L' ? lowerdentry : upperdentry)->i_nlink;
 644         nlink += nlink_diff;
 645
 646         if (nlink <= 0)
 647                 goto fail;
 648
 649         return nlink;
 650
 651 fail:
 652         pr_warn_ratelimited("overlayfs: failed to get index nlink (%pd2, err=%i)\n",
 653                             upperdentry, err);
 654         return fallback;
 655 }
 656
 657 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev)
 658 {
 659         struct inode *inode;
 660
 661         inode = new_inode(sb);
 662         if (inode)
 663                 ovl_fill_inode(inode, mode, rdev, 0, 0);
 664
 665         return inode;
 666 }
 667
 668 static int ovl_inode_test(struct inode *inode, void *data)
 669 {
 670         return inode->i_private == data;
 671 }
 672
 673 static int ovl_inode_set(struct inode *inode, void *data)
 674 {
 675         inode->i_private = data;
 676         return 0;
 677 }
 678
 679 static bool ovl_verify_inode(struct inode *inode, struct dentry *lowerdentry,
 680                              struct dentry *upperdentry, bool strict)
 681 {
 682         /*
 683          * For directories, @strict verify from lookup path performs consistency
 684          * checks, so NULL lower/upper in dentry must match NULL lower/upper in
 685          * inode. Non @strict verify from NFS handle decode path passes NULL for
 686          * 'unknown' lower/upper.
 687          */
 688         if (S_ISDIR(inode->i_mode) && strict) {
 689                 /* Real lower dir moved to upper layer under us? */
 690                 if (!lowerdentry && ovl_inode_lower(inode))
 691                         return false;
 692
 693                 /* Lookup of an uncovered redirect origin? */
 694                 if (!upperdentry && ovl_inode_upper(inode))
 695                         return false;
 696         }
 697
 698         /*
 699          * Allow non-NULL lower inode in ovl_inode even if lowerdentry is NULL.
 700          * This happens when finding a copied up overlay inode for a renamed
 701          * or hardlinked overlay dentry and lower dentry cannot be followed
 702          * by origin because lower fs does not support file handles.
 703          */
 704         if (lowerdentry && ovl_inode_lower(inode) != d_inode(lowerdentry))
 705                 return false;
 706
 707         /*
 708          * Allow non-NULL __upperdentry in inode even if upperdentry is NULL.
 709          * This happens when finding a lower alias for a copied up hard link.
 710          */
 711         if (upperdentry && ovl_inode_upper(inode) != d_inode(upperdentry))
 712                 return false;
 713
 714         return true;
 715 }
 716
 717 struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
 718                                bool is_upper)
 719 {
 720         struct inode *inode, *key = d_inode(real);
 721
 722         inode = ilookup5(sb, (unsigned long) key, ovl_inode_test, key);
 723         if (!inode)
 724                 return NULL;
 725
 726         if (!ovl_verify_inode(inode, is_upper ? NULL : real,
 727                               is_upper ? real : NULL, false)) {
 728                 iput(inode);
 729                 return ERR_PTR(-ESTALE);
 730         }
 731
 732         return inode;
 733 }
 734
 735 /*
 736  * Does overlay inode need to be hashed by lower inode?
 737  */
 738 static bool ovl_hash_bylower(struct super_block *sb, struct dentry *upper,
 739                              struct dentry *lower, struct dentry *index)
 740 {
 741         struct ovl_fs *ofs = sb->s_fs_info;
 742
 743         /* No, if pure upper */
 744         if (!lower)
 745                 return false;
 746
 747         /* Yes, if already indexed */
 748         if (index)
 749                 return true;
 750
 751         /* Yes, if won't be copied up */
 752         if (!ofs->upper_mnt)
 753                 return true;
 754
 755         /* No, if lower hardlink is or will be broken on copy up */
 756         if ((upper || !ovl_indexdir(sb)) &&
 757             !d_is_dir(lower) && d_inode(lower)->i_nlink > 1)
 758                 return false;
 759
 760         /* No, if non-indexed upper with NFS export */
 761         if (sb->s_export_op && upper)
 762                 return false;
 763
 764         /* Otherwise, hash by lower inode for fsnotify */
 765         return true;
 766 }
 767
 768 static struct inode *ovl_iget5(struct super_block *sb, struct inode *newinode,
 769                                struct inode *key)
 770 {
 771         return newinode ? inode_insert5(newinode, (unsigned long) key,
 772                                          ovl_inode_test, ovl_inode_set, key) :
 773                           iget5_locked(sb, (unsigned long) key,
 774                                        ovl_inode_test, ovl_inode_set, key);
 775 }
 776
 777 struct inode *ovl_get_inode(struct super_block *sb,
 778                             struct ovl_inode_params *oip)
 779 {
 780         struct dentry *upperdentry = oip->upperdentry;
 781         struct ovl_path *lowerpath = oip->lowerpath;
 782         struct inode *realinode = upperdentry ? d_inode(upperdentry) : NULL;
 783         struct inode *inode;
 784         struct dentry *lowerdentry = lowerpath ? lowerpath->dentry : NULL;
 785         bool bylower = ovl_hash_bylower(sb, upperdentry, lowerdentry,
 786                                         oip->index);
 787         int fsid = bylower ? oip->lowerpath->layer->fsid : 0;
 788         bool is_dir;
 789         unsigned long ino = 0;
 790
 791         if (!realinode)
 792                 realinode = d_inode(lowerdentry);
 793
 794         /*
 795          * Copy up origin (lower) may exist for non-indexed upper, but we must
 796          * not use lower as hash key if this is a broken hardlink.
 797          */
 798         is_dir = S_ISDIR(realinode->i_mode);
 799         if (upperdentry || bylower) {
 800                 struct inode *key = d_inode(bylower ? lowerdentry :
 801                                                       upperdentry);
 802                 unsigned int nlink = is_dir ? 1 : realinode->i_nlink;
 803
 804                 inode = ovl_iget5(sb, oip->newinode, key);
 805                 if (!inode)
 806                         goto out_nomem;
 807                 if (!(inode->i_state & I_NEW)) {
 808                         /*
 809                          * Verify that the underlying files stored in the inode
 810                          * match those in the dentry.
 811                          */
 812                         if (!ovl_verify_inode(inode, lowerdentry, upperdentry,
 813                                               true)) {
 814                                 iput(inode);
 815                                 inode = ERR_PTR(-ESTALE);
 816                                 goto out;
 817                         }
 818
 819                         dput(upperdentry);
 820                         goto out;
 821                 }
 822
 823                 /* Recalculate nlink for non-dir due to indexing */
 824                 if (!is_dir)
 825                         nlink = ovl_get_nlink(lowerdentry, upperdentry, nlink);
 826                 set_nlink(inode, nlink);
 827                 ino = key->i_ino;
 828         } else {
 829                 /* Lower hardlink that will be broken on copy up */
 830                 inode = new_inode(sb);
 831                 if (!inode)
 832                         goto out_nomem;
 833         }
 834         ovl_fill_inode(inode, realinode->i_mode, realinode->i_rdev, ino, fsid);
 835         ovl_inode_init(inode, upperdentry, lowerdentry);
 836
 837         if (upperdentry && ovl_is_impuredir(upperdentry))
 838                 ovl_set_flag(OVL_IMPURE, inode);
 839
 840         if (oip->index)
 841                 ovl_set_flag(OVL_INDEX, inode);
 842
 843         /* Check for non-merge dir that may have whiteouts */
 844         if (is_dir) {
 845                 if (((upperdentry && lowerdentry) || oip->numlower > 1) ||
 846                     ovl_check_origin_xattr(upperdentry ?: lowerdentry)) {
 847                         ovl_set_flag(OVL_WHITEOUTS, inode);
 848                 }
 849         }
 850
 851         if (inode->i_state & I_NEW)
 852                 unlock_new_inode(inode);
 853 out:
 854         return inode;
 855
 856 out_nomem:
 857         inode = ERR_PTR(-ENOMEM);
 858         goto out;
 859 }