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