root/fs/overlayfs/readdir.c

DEFINITIONS

1. ovl_cache_entry_from_node
2. ovl_cache_entry_find_link
3. ovl_cache_entry_find
4. ovl_calc_d_ino
5. ovl_cache_entry_new
6. ovl_cache_entry_add_rb
7. ovl_fill_lowest
8. ovl_cache_free
9. ovl_dir_cache_free
10. ovl_cache_put
11. ovl_fill_merge
12. ovl_check_whiteouts
13. ovl_dir_read
14. ovl_dir_is_real
15. ovl_dir_reset
16. ovl_dir_read_merged
17. ovl_seek_cursor
18. ovl_cache_get
19. ovl_remap_lower_ino
20. ovl_cache_update_ino
21. ovl_fill_plain
22. ovl_dir_read_impure
23. ovl_cache_get_impure
24. ovl_fill_real
25. ovl_is_impure_dir
26. ovl_iterate_real
27. ovl_iterate
28. ovl_dir_llseek
29. ovl_dir_fsync
30. ovl_dir_release
31. ovl_dir_open
32. ovl_check_empty_dir
33. ovl_cleanup_whiteouts
34. ovl_check_d_type
35. ovl_check_d_type_supported
36. ovl_workdir_cleanup_recurse
37. ovl_workdir_cleanup
38. ovl_indexdir_cleanup

   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/namei.h>
  10 #include <linux/file.h>
  11 #include <linux/xattr.h>
  12 #include <linux/rbtree.h>
  13 #include <linux/security.h>
  14 #include <linux/cred.h>
  15 #include <linux/ratelimit.h>
  16 #include "overlayfs.h"
  17 
  18 struct ovl_cache_entry {
  19         unsigned int len;
  20         unsigned int type;
  21         u64 real_ino;
  22         u64 ino;
  23         struct list_head l_node;
  24         struct rb_node node;
  25         struct ovl_cache_entry *next_maybe_whiteout;
  26         bool is_upper;
  27         bool is_whiteout;
  28         char name[];
  29 };
  30 
  31 struct ovl_dir_cache {
  32         long refcount;
  33         u64 version;
  34         struct list_head entries;
  35         struct rb_root root;
  36 };
  37 
  38 struct ovl_readdir_data {
  39         struct dir_context ctx;
  40         struct dentry *dentry;
  41         bool is_lowest;
  42         struct rb_root *root;
  43         struct list_head *list;
  44         struct list_head middle;
  45         struct ovl_cache_entry *first_maybe_whiteout;
  46         int count;
  47         int err;
  48         bool is_upper;
  49         bool d_type_supported;
  50 };
  51 
  52 struct ovl_dir_file {
  53         bool is_real;
  54         bool is_upper;
  55         struct ovl_dir_cache *cache;
  56         struct list_head *cursor;
  57         struct file *realfile;
  58         struct file *upperfile;
  59 };
  60 
  61 static struct ovl_cache_entry *ovl_cache_entry_from_node(struct rb_node *n)
  62 {
  63         return rb_entry(n, struct ovl_cache_entry, node);
  64 }
  65 
  66 static bool ovl_cache_entry_find_link(const char *name, int len,
  67                                       struct rb_node ***link,
  68                                       struct rb_node **parent)
  69 {
  70         bool found = false;
  71         struct rb_node **newp = *link;
  72 
  73         while (!found && *newp) {
  74                 int cmp;
  75                 struct ovl_cache_entry *tmp;
  76 
  77                 *parent = *newp;
  78                 tmp = ovl_cache_entry_from_node(*newp);
  79                 cmp = strncmp(name, tmp->name, len);
  80                 if (cmp > 0)
  81                         newp = &tmp->node.rb_right;
  82                 else if (cmp < 0 || len < tmp->len)
  83                         newp = &tmp->node.rb_left;
  84                 else
  85                         found = true;
  86         }
  87         *link = newp;
  88 
  89         return found;
  90 }
  91 
  92 static struct ovl_cache_entry *ovl_cache_entry_find(struct rb_root *root,
  93                                                     const char *name, int len)
  94 {
  95         struct rb_node *node = root->rb_node;
  96         int cmp;
  97 
  98         while (node) {
  99                 struct ovl_cache_entry *p = ovl_cache_entry_from_node(node);
 100 
 101                 cmp = strncmp(name, p->name, len);
 102                 if (cmp > 0)
 103                         node = p->node.rb_right;
 104                 else if (cmp < 0 || len < p->len)
 105                         node = p->node.rb_left;
 106                 else
 107                         return p;
 108         }
 109 
 110         return NULL;
 111 }
 112 
 113 static bool ovl_calc_d_ino(struct ovl_readdir_data *rdd,
 114                            struct ovl_cache_entry *p)
 115 {
 116         /* Don't care if not doing ovl_iter() */
 117         if (!rdd->dentry)
 118                 return false;
 119 
 120         /* Always recalc d_ino when remapping lower inode numbers */
 121         if (ovl_xino_bits(rdd->dentry->d_sb))
 122                 return true;
 123 
 124         /* Always recalc d_ino for parent */
 125         if (strcmp(p->name, "..") == 0)
 126                 return true;
 127 
 128         /* If this is lower, then native d_ino will do */
 129         if (!rdd->is_upper)
 130                 return false;
 131 
 132         /*
 133          * Recalc d_ino for '.' and for all entries if dir is impure (contains
 134          * copied up entries)
 135          */
 136         if ((p->name[0] == '.' && p->len == 1) ||
 137             ovl_test_flag(OVL_IMPURE, d_inode(rdd->dentry)))
 138                 return true;
 139 
 140         return false;
 141 }
 142 
 143 static struct ovl_cache_entry *ovl_cache_entry_new(struct ovl_readdir_data *rdd,
 144                                                    const char *name, int len,
 145                                                    u64 ino, unsigned int d_type)
 146 {
 147         struct ovl_cache_entry *p;
 148         size_t size = offsetof(struct ovl_cache_entry, name[len + 1]);
 149 
 150         p = kmalloc(size, GFP_KERNEL);
 151         if (!p)
 152                 return NULL;
 153 
 154         memcpy(p->name, name, len);
 155         p->name[len] = '\0';
 156         p->len = len;
 157         p->type = d_type;
 158         p->real_ino = ino;
 159         p->ino = ino;
 160         /* Defer setting d_ino for upper entry to ovl_iterate() */
 161         if (ovl_calc_d_ino(rdd, p))
 162                 p->ino = 0;
 163         p->is_upper = rdd->is_upper;
 164         p->is_whiteout = false;
 165 
 166         if (d_type == DT_CHR) {
 167                 p->next_maybe_whiteout = rdd->first_maybe_whiteout;
 168                 rdd->first_maybe_whiteout = p;
 169         }
 170         return p;
 171 }
 172 
 173 static int ovl_cache_entry_add_rb(struct ovl_readdir_data *rdd,
 174                                   const char *name, int len, u64 ino,
 175                                   unsigned int d_type)
 176 {
 177         struct rb_node **newp = &rdd->root->rb_node;
 178         struct rb_node *parent = NULL;
 179         struct ovl_cache_entry *p;
 180 
 181         if (ovl_cache_entry_find_link(name, len, &newp, &parent))
 182                 return 0;
 183 
 184         p = ovl_cache_entry_new(rdd, name, len, ino, d_type);
 185         if (p == NULL) {
 186                 rdd->err = -ENOMEM;
 187                 return -ENOMEM;
 188         }
 189 
 190         list_add_tail(&p->l_node, rdd->list);
 191         rb_link_node(&p->node, parent, newp);
 192         rb_insert_color(&p->node, rdd->root);
 193 
 194         return 0;
 195 }
 196 
 197 static int ovl_fill_lowest(struct ovl_readdir_data *rdd,
 198                            const char *name, int namelen,
 199                            loff_t offset, u64 ino, unsigned int d_type)
 200 {
 201         struct ovl_cache_entry *p;
 202 
 203         p = ovl_cache_entry_find(rdd->root, name, namelen);
 204         if (p) {
 205                 list_move_tail(&p->l_node, &rdd->middle);
 206         } else {
 207                 p = ovl_cache_entry_new(rdd, name, namelen, ino, d_type);
 208                 if (p == NULL)
 209                         rdd->err = -ENOMEM;
 210                 else
 211                         list_add_tail(&p->l_node, &rdd->middle);
 212         }
 213 
 214         return rdd->err;
 215 }
 216 
 217 void ovl_cache_free(struct list_head *list)
 218 {
 219         struct ovl_cache_entry *p;
 220         struct ovl_cache_entry *n;
 221 
 222         list_for_each_entry_safe(p, n, list, l_node)
 223                 kfree(p);
 224 
 225         INIT_LIST_HEAD(list);
 226 }
 227 
 228 void ovl_dir_cache_free(struct inode *inode)
 229 {
 230         struct ovl_dir_cache *cache = ovl_dir_cache(inode);
 231 
 232         if (cache) {
 233                 ovl_cache_free(&cache->entries);
 234                 kfree(cache);
 235         }
 236 }
 237 
 238 static void ovl_cache_put(struct ovl_dir_file *od, struct dentry *dentry)
 239 {
 240         struct ovl_dir_cache *cache = od->cache;
 241 
 242         WARN_ON(cache->refcount <= 0);
 243         cache->refcount--;
 244         if (!cache->refcount) {
 245                 if (ovl_dir_cache(d_inode(dentry)) == cache)
 246                         ovl_set_dir_cache(d_inode(dentry), NULL);
 247 
 248                 ovl_cache_free(&cache->entries);
 249                 kfree(cache);
 250         }
 251 }
 252 
 253 static int ovl_fill_merge(struct dir_context *ctx, const char *name,
 254                           int namelen, loff_t offset, u64 ino,
 255                           unsigned int d_type)
 256 {
 257         struct ovl_readdir_data *rdd =
 258                 container_of(ctx, struct ovl_readdir_data, ctx);
 259 
 260         rdd->count++;
 261         if (!rdd->is_lowest)
 262                 return ovl_cache_entry_add_rb(rdd, name, namelen, ino, d_type);
 263         else
 264                 return ovl_fill_lowest(rdd, name, namelen, offset, ino, d_type);
 265 }
 266 
 267 static int ovl_check_whiteouts(struct dentry *dir, struct ovl_readdir_data *rdd)
 268 {
 269         int err;
 270         struct ovl_cache_entry *p;
 271         struct dentry *dentry;
 272         const struct cred *old_cred;
 273 
 274         old_cred = ovl_override_creds(rdd->dentry->d_sb);
 275 
 276         err = down_write_killable(&dir->d_inode->i_rwsem);
 277         if (!err) {
 278                 while (rdd->first_maybe_whiteout) {
 279                         p = rdd->first_maybe_whiteout;
 280                         rdd->first_maybe_whiteout = p->next_maybe_whiteout;
 281                         dentry = lookup_one_len(p->name, dir, p->len);
 282                         if (!IS_ERR(dentry)) {
 283                                 p->is_whiteout = ovl_is_whiteout(dentry);
 284                                 dput(dentry);
 285                         }
 286                 }
 287                 inode_unlock(dir->d_inode);
 288         }
 289         revert_creds(old_cred);
 290 
 291         return err;
 292 }
 293 
 294 static inline int ovl_dir_read(struct path *realpath,
 295                                struct ovl_readdir_data *rdd)
 296 {
 297         struct file *realfile;
 298         int err;
 299 
 300         realfile = ovl_path_open(realpath, O_RDONLY | O_DIRECTORY);
 301         if (IS_ERR(realfile))
 302                 return PTR_ERR(realfile);
 303 
 304         rdd->first_maybe_whiteout = NULL;
 305         rdd->ctx.pos = 0;
 306         do {
 307                 rdd->count = 0;
 308                 rdd->err = 0;
 309                 err = iterate_dir(realfile, &rdd->ctx);
 310                 if (err >= 0)
 311                         err = rdd->err;
 312         } while (!err && rdd->count);
 313 
 314         if (!err && rdd->first_maybe_whiteout && rdd->dentry)
 315                 err = ovl_check_whiteouts(realpath->dentry, rdd);
 316 
 317         fput(realfile);
 318 
 319         return err;
 320 }
 321 
 322 /*
 323  * Can we iterate real dir directly?
 324  *
 325  * Non-merge dir may contain whiteouts from a time it was a merge upper, before
 326  * lower dir was removed under it and possibly before it was rotated from upper
 327  * to lower layer.
 328  */
 329 static bool ovl_dir_is_real(struct dentry *dir)
 330 {
 331         return !ovl_test_flag(OVL_WHITEOUTS, d_inode(dir));
 332 }
 333 
 334 static void ovl_dir_reset(struct file *file)
 335 {
 336         struct ovl_dir_file *od = file->private_data;
 337         struct ovl_dir_cache *cache = od->cache;
 338         struct dentry *dentry = file->f_path.dentry;
 339         bool is_real;
 340 
 341         if (cache && ovl_dentry_version_get(dentry) != cache->version) {
 342                 ovl_cache_put(od, dentry);
 343                 od->cache = NULL;
 344                 od->cursor = NULL;
 345         }
 346         is_real = ovl_dir_is_real(dentry);
 347         if (od->is_real != is_real) {
 348                 /* is_real can only become false when dir is copied up */
 349                 if (WARN_ON(is_real))
 350                         return;
 351                 od->is_real = false;
 352         }
 353 }
 354 
 355 static int ovl_dir_read_merged(struct dentry *dentry, struct list_head *list,
 356         struct rb_root *root)
 357 {
 358         int err;
 359         struct path realpath;
 360         struct ovl_readdir_data rdd = {
 361                 .ctx.actor = ovl_fill_merge,
 362                 .dentry = dentry,
 363                 .list = list,
 364                 .root = root,
 365                 .is_lowest = false,
 366         };
 367         int idx, next;
 368 
 369         for (idx = 0; idx != -1; idx = next) {
 370                 next = ovl_path_next(idx, dentry, &realpath);
 371                 rdd.is_upper = ovl_dentry_upper(dentry) == realpath.dentry;
 372 
 373                 if (next != -1) {
 374                         err = ovl_dir_read(&realpath, &rdd);
 375                         if (err)
 376                                 break;
 377                 } else {
 378                         /*
 379                          * Insert lowest layer entries before upper ones, this
 380                          * allows offsets to be reasonably constant
 381                          */
 382                         list_add(&rdd.middle, rdd.list);
 383                         rdd.is_lowest = true;
 384                         err = ovl_dir_read(&realpath, &rdd);
 385                         list_del(&rdd.middle);
 386                 }
 387         }
 388         return err;
 389 }
 390 
 391 static void ovl_seek_cursor(struct ovl_dir_file *od, loff_t pos)
 392 {
 393         struct list_head *p;
 394         loff_t off = 0;
 395 
 396         list_for_each(p, &od->cache->entries) {
 397                 if (off >= pos)
 398                         break;
 399                 off++;
 400         }
 401         /* Cursor is safe since the cache is stable */
 402         od->cursor = p;
 403 }
 404 
 405 static struct ovl_dir_cache *ovl_cache_get(struct dentry *dentry)
 406 {
 407         int res;
 408         struct ovl_dir_cache *cache;
 409 
 410         cache = ovl_dir_cache(d_inode(dentry));
 411         if (cache && ovl_dentry_version_get(dentry) == cache->version) {
 412                 WARN_ON(!cache->refcount);
 413                 cache->refcount++;
 414                 return cache;
 415         }
 416         ovl_set_dir_cache(d_inode(dentry), NULL);
 417 
 418         cache = kzalloc(sizeof(struct ovl_dir_cache), GFP_KERNEL);
 419         if (!cache)
 420                 return ERR_PTR(-ENOMEM);
 421 
 422         cache->refcount = 1;
 423         INIT_LIST_HEAD(&cache->entries);
 424         cache->root = RB_ROOT;
 425 
 426         res = ovl_dir_read_merged(dentry, &cache->entries, &cache->root);
 427         if (res) {
 428                 ovl_cache_free(&cache->entries);
 429                 kfree(cache);
 430                 return ERR_PTR(res);
 431         }
 432 
 433         cache->version = ovl_dentry_version_get(dentry);
 434         ovl_set_dir_cache(d_inode(dentry), cache);
 435 
 436         return cache;
 437 }
 438 
 439 /* Map inode number to lower fs unique range */
 440 static u64 ovl_remap_lower_ino(u64 ino, int xinobits, int fsid,
 441                                const char *name, int namelen)
 442 {
 443         if (ino >> (64 - xinobits)) {
 444                 pr_warn_ratelimited("overlayfs: d_ino too big (%.*s, ino=%llu, xinobits=%d)\n",
 445                                     namelen, name, ino, xinobits);
 446                 return ino;
 447         }
 448 
 449         return ino | ((u64)fsid) << (64 - xinobits);
 450 }
 451 
 452 /*
 453  * Set d_ino for upper entries. Non-upper entries should always report
 454  * the uppermost real inode ino and should not call this function.
 455  *
 456  * When not all layer are on same fs, report real ino also for upper.
 457  *
 458  * When all layers are on the same fs, and upper has a reference to
 459  * copy up origin, call vfs_getattr() on the overlay entry to make
 460  * sure that d_ino will be consistent with st_ino from stat(2).
 461  */
 462 static int ovl_cache_update_ino(struct path *path, struct ovl_cache_entry *p)
 463 
 464 {
 465         struct dentry *dir = path->dentry;
 466         struct dentry *this = NULL;
 467         enum ovl_path_type type;
 468         u64 ino = p->real_ino;
 469         int xinobits = ovl_xino_bits(dir->d_sb);
 470         int err = 0;
 471 
 472         if (!ovl_same_sb(dir->d_sb) && !xinobits)
 473                 goto out;
 474 
 475         if (p->name[0] == '.') {
 476                 if (p->len == 1) {
 477                         this = dget(dir);
 478                         goto get;
 479                 }
 480                 if (p->len == 2 && p->name[1] == '.') {
 481                         /* we shall not be moved */
 482                         this = dget(dir->d_parent);
 483                         goto get;
 484                 }
 485         }
 486         this = lookup_one_len(p->name, dir, p->len);
 487         if (IS_ERR_OR_NULL(this) || !this->d_inode) {
 488                 if (IS_ERR(this)) {
 489                         err = PTR_ERR(this);
 490                         this = NULL;
 491                         goto fail;
 492                 }
 493                 goto out;
 494         }
 495 
 496 get:
 497         type = ovl_path_type(this);
 498         if (OVL_TYPE_ORIGIN(type)) {
 499                 struct kstat stat;
 500                 struct path statpath = *path;
 501 
 502                 statpath.dentry = this;
 503                 err = vfs_getattr(&statpath, &stat, STATX_INO, 0);
 504                 if (err)
 505                         goto fail;
 506 
 507                 /*
 508                  * Directory inode is always on overlay st_dev.
 509                  * Non-dir with ovl_same_dev() could be on pseudo st_dev in case
 510                  * of xino bits overflow.
 511                  */
 512                 WARN_ON_ONCE(S_ISDIR(stat.mode) &&
 513                              dir->d_sb->s_dev != stat.dev);
 514                 ino = stat.ino;
 515         } else if (xinobits && !OVL_TYPE_UPPER(type)) {
 516                 ino = ovl_remap_lower_ino(ino, xinobits,
 517                                           ovl_layer_lower(this)->fsid,
 518                                           p->name, p->len);
 519         }
 520 
 521 out:
 522         p->ino = ino;
 523         dput(this);
 524         return err;
 525 
 526 fail:
 527         pr_warn_ratelimited("overlayfs: failed to look up (%s) for ino (%i)\n",
 528                             p->name, err);
 529         goto out;
 530 }
 531 
 532 static int ovl_fill_plain(struct dir_context *ctx, const char *name,
 533                           int namelen, loff_t offset, u64 ino,
 534                           unsigned int d_type)
 535 {
 536         struct ovl_cache_entry *p;
 537         struct ovl_readdir_data *rdd =
 538                 container_of(ctx, struct ovl_readdir_data, ctx);
 539 
 540         rdd->count++;
 541         p = ovl_cache_entry_new(rdd, name, namelen, ino, d_type);
 542         if (p == NULL) {
 543                 rdd->err = -ENOMEM;
 544                 return -ENOMEM;
 545         }
 546         list_add_tail(&p->l_node, rdd->list);
 547 
 548         return 0;
 549 }
 550 
 551 static int ovl_dir_read_impure(struct path *path,  struct list_head *list,
 552                                struct rb_root *root)
 553 {
 554         int err;
 555         struct path realpath;
 556         struct ovl_cache_entry *p, *n;
 557         struct ovl_readdir_data rdd = {
 558                 .ctx.actor = ovl_fill_plain,
 559                 .list = list,
 560                 .root = root,
 561         };
 562 
 563         INIT_LIST_HEAD(list);
 564         *root = RB_ROOT;
 565         ovl_path_upper(path->dentry, &realpath);
 566 
 567         err = ovl_dir_read(&realpath, &rdd);
 568         if (err)
 569                 return err;
 570 
 571         list_for_each_entry_safe(p, n, list, l_node) {
 572                 if (strcmp(p->name, ".") != 0 &&
 573                     strcmp(p->name, "..") != 0) {
 574                         err = ovl_cache_update_ino(path, p);
 575                         if (err)
 576                                 return err;
 577                 }
 578                 if (p->ino == p->real_ino) {
 579                         list_del(&p->l_node);
 580                         kfree(p);
 581                 } else {
 582                         struct rb_node **newp = &root->rb_node;
 583                         struct rb_node *parent = NULL;
 584 
 585                         if (WARN_ON(ovl_cache_entry_find_link(p->name, p->len,
 586                                                               &newp, &parent)))
 587                                 return -EIO;
 588 
 589                         rb_link_node(&p->node, parent, newp);
 590                         rb_insert_color(&p->node, root);
 591                 }
 592         }
 593         return 0;
 594 }
 595 
 596 static struct ovl_dir_cache *ovl_cache_get_impure(struct path *path)
 597 {
 598         int res;
 599         struct dentry *dentry = path->dentry;
 600         struct ovl_dir_cache *cache;
 601 
 602         cache = ovl_dir_cache(d_inode(dentry));
 603         if (cache && ovl_dentry_version_get(dentry) == cache->version)
 604                 return cache;
 605 
 606         /* Impure cache is not refcounted, free it here */
 607         ovl_dir_cache_free(d_inode(dentry));
 608         ovl_set_dir_cache(d_inode(dentry), NULL);
 609 
 610         cache = kzalloc(sizeof(struct ovl_dir_cache), GFP_KERNEL);
 611         if (!cache)
 612                 return ERR_PTR(-ENOMEM);
 613 
 614         res = ovl_dir_read_impure(path, &cache->entries, &cache->root);
 615         if (res) {
 616                 ovl_cache_free(&cache->entries);
 617                 kfree(cache);
 618                 return ERR_PTR(res);
 619         }
 620         if (list_empty(&cache->entries)) {
 621                 /*
 622                  * A good opportunity to get rid of an unneeded "impure" flag.
 623                  * Removing the "impure" xattr is best effort.
 624                  */
 625                 if (!ovl_want_write(dentry)) {
 626                         ovl_do_removexattr(ovl_dentry_upper(dentry),
 627                                            OVL_XATTR_IMPURE);
 628                         ovl_drop_write(dentry);
 629                 }
 630                 ovl_clear_flag(OVL_IMPURE, d_inode(dentry));
 631                 kfree(cache);
 632                 return NULL;
 633         }
 634 
 635         cache->version = ovl_dentry_version_get(dentry);
 636         ovl_set_dir_cache(d_inode(dentry), cache);
 637 
 638         return cache;
 639 }
 640 
 641 struct ovl_readdir_translate {
 642         struct dir_context *orig_ctx;
 643         struct ovl_dir_cache *cache;
 644         struct dir_context ctx;
 645         u64 parent_ino;
 646         int fsid;
 647         int xinobits;
 648 };
 649 
 650 static int ovl_fill_real(struct dir_context *ctx, const char *name,
 651                            int namelen, loff_t offset, u64 ino,
 652                            unsigned int d_type)
 653 {
 654         struct ovl_readdir_translate *rdt =
 655                 container_of(ctx, struct ovl_readdir_translate, ctx);
 656         struct dir_context *orig_ctx = rdt->orig_ctx;
 657 
 658         if (rdt->parent_ino && strcmp(name, "..") == 0) {
 659                 ino = rdt->parent_ino;
 660         } else if (rdt->cache) {
 661                 struct ovl_cache_entry *p;
 662 
 663                 p = ovl_cache_entry_find(&rdt->cache->root, name, namelen);
 664                 if (p)
 665                         ino = p->ino;
 666         } else if (rdt->xinobits) {
 667                 ino = ovl_remap_lower_ino(ino, rdt->xinobits, rdt->fsid,
 668                                           name, namelen);
 669         }
 670 
 671         return orig_ctx->actor(orig_ctx, name, namelen, offset, ino, d_type);
 672 }
 673 
 674 static bool ovl_is_impure_dir(struct file *file)
 675 {
 676         struct ovl_dir_file *od = file->private_data;
 677         struct inode *dir = d_inode(file->f_path.dentry);
 678 
 679         /*
 680          * Only upper dir can be impure, but if we are in the middle of
 681          * iterating a lower real dir, dir could be copied up and marked
 682          * impure. We only want the impure cache if we started iterating
 683          * a real upper dir to begin with.
 684          */
 685         return od->is_upper && ovl_test_flag(OVL_IMPURE, dir);
 686 
 687 }
 688 
 689 static int ovl_iterate_real(struct file *file, struct dir_context *ctx)
 690 {
 691         int err;
 692         struct ovl_dir_file *od = file->private_data;
 693         struct dentry *dir = file->f_path.dentry;
 694         struct ovl_layer *lower_layer = ovl_layer_lower(dir);
 695         struct ovl_readdir_translate rdt = {
 696                 .ctx.actor = ovl_fill_real,
 697                 .orig_ctx = ctx,
 698                 .xinobits = ovl_xino_bits(dir->d_sb),
 699         };
 700 
 701         if (rdt.xinobits && lower_layer)
 702                 rdt.fsid = lower_layer->fsid;
 703 
 704         if (OVL_TYPE_MERGE(ovl_path_type(dir->d_parent))) {
 705                 struct kstat stat;
 706                 struct path statpath = file->f_path;
 707 
 708                 statpath.dentry = dir->d_parent;
 709                 err = vfs_getattr(&statpath, &stat, STATX_INO, 0);
 710                 if (err)
 711                         return err;
 712 
 713                 WARN_ON_ONCE(dir->d_sb->s_dev != stat.dev);
 714                 rdt.parent_ino = stat.ino;
 715         }
 716 
 717         if (ovl_is_impure_dir(file)) {
 718                 rdt.cache = ovl_cache_get_impure(&file->f_path);
 719                 if (IS_ERR(rdt.cache))
 720                         return PTR_ERR(rdt.cache);
 721         }
 722 
 723         err = iterate_dir(od->realfile, &rdt.ctx);
 724         ctx->pos = rdt.ctx.pos;
 725 
 726         return err;
 727 }
 728 
 729 
 730 static int ovl_iterate(struct file *file, struct dir_context *ctx)
 731 {
 732         struct ovl_dir_file *od = file->private_data;
 733         struct dentry *dentry = file->f_path.dentry;
 734         struct ovl_cache_entry *p;
 735         int err;
 736 
 737         if (!ctx->pos)
 738                 ovl_dir_reset(file);
 739 
 740         if (od->is_real) {
 741                 /*
 742                  * If parent is merge, then need to adjust d_ino for '..', if
 743                  * dir is impure then need to adjust d_ino for copied up
 744                  * entries.
 745                  */
 746                 if (ovl_xino_bits(dentry->d_sb) ||
 747                     (ovl_same_sb(dentry->d_sb) &&
 748                      (ovl_is_impure_dir(file) ||
 749                       OVL_TYPE_MERGE(ovl_path_type(dentry->d_parent))))) {
 750                         return ovl_iterate_real(file, ctx);
 751                 }
 752                 return iterate_dir(od->realfile, ctx);
 753         }
 754 
 755         if (!od->cache) {
 756                 struct ovl_dir_cache *cache;
 757 
 758                 cache = ovl_cache_get(dentry);
 759                 if (IS_ERR(cache))
 760                         return PTR_ERR(cache);
 761 
 762                 od->cache = cache;
 763                 ovl_seek_cursor(od, ctx->pos);
 764         }
 765 
 766         while (od->cursor != &od->cache->entries) {
 767                 p = list_entry(od->cursor, struct ovl_cache_entry, l_node);
 768                 if (!p->is_whiteout) {
 769                         if (!p->ino) {
 770                                 err = ovl_cache_update_ino(&file->f_path, p);
 771                                 if (err)
 772                                         return err;
 773                         }
 774                         if (!dir_emit(ctx, p->name, p->len, p->ino, p->type))
 775                                 break;
 776                 }
 777                 od->cursor = p->l_node.next;
 778                 ctx->pos++;
 779         }
 780         return 0;
 781 }
 782 
 783 static loff_t ovl_dir_llseek(struct file *file, loff_t offset, int origin)
 784 {
 785         loff_t res;
 786         struct ovl_dir_file *od = file->private_data;
 787 
 788         inode_lock(file_inode(file));
 789         if (!file->f_pos)
 790                 ovl_dir_reset(file);
 791 
 792         if (od->is_real) {
 793                 res = vfs_llseek(od->realfile, offset, origin);
 794                 file->f_pos = od->realfile->f_pos;
 795         } else {
 796                 res = -EINVAL;
 797 
 798                 switch (origin) {
 799                 case SEEK_CUR:
 800                         offset += file->f_pos;
 801                         break;
 802                 case SEEK_SET:
 803                         break;
 804                 default:
 805                         goto out_unlock;
 806                 }
 807                 if (offset < 0)
 808                         goto out_unlock;
 809 
 810                 if (offset != file->f_pos) {
 811                         file->f_pos = offset;
 812                         if (od->cache)
 813                                 ovl_seek_cursor(od, offset);
 814                 }
 815                 res = offset;
 816         }
 817 out_unlock:
 818         inode_unlock(file_inode(file));
 819 
 820         return res;
 821 }
 822 
 823 static int ovl_dir_fsync(struct file *file, loff_t start, loff_t end,
 824                          int datasync)
 825 {
 826         struct ovl_dir_file *od = file->private_data;
 827         struct dentry *dentry = file->f_path.dentry;
 828         struct file *realfile = od->realfile;
 829 
 830         /* Nothing to sync for lower */
 831         if (!OVL_TYPE_UPPER(ovl_path_type(dentry)))
 832                 return 0;
 833 
 834         /*
 835          * Need to check if we started out being a lower dir, but got copied up
 836          */
 837         if (!od->is_upper) {
 838                 struct inode *inode = file_inode(file);
 839 
 840                 realfile = READ_ONCE(od->upperfile);
 841                 if (!realfile) {
 842                         struct path upperpath;
 843 
 844                         ovl_path_upper(dentry, &upperpath);
 845                         realfile = ovl_path_open(&upperpath, O_RDONLY);
 846 
 847                         inode_lock(inode);
 848                         if (!od->upperfile) {
 849                                 if (IS_ERR(realfile)) {
 850                                         inode_unlock(inode);
 851                                         return PTR_ERR(realfile);
 852                                 }
 853                                 smp_store_release(&od->upperfile, realfile);
 854                         } else {
 855                                 /* somebody has beaten us to it */
 856                                 if (!IS_ERR(realfile))
 857                                         fput(realfile);
 858                                 realfile = od->upperfile;
 859                         }
 860                         inode_unlock(inode);
 861                 }
 862         }
 863 
 864         return vfs_fsync_range(realfile, start, end, datasync);
 865 }
 866 
 867 static int ovl_dir_release(struct inode *inode, struct file *file)
 868 {
 869         struct ovl_dir_file *od = file->private_data;
 870 
 871         if (od->cache) {
 872                 inode_lock(inode);
 873                 ovl_cache_put(od, file->f_path.dentry);
 874                 inode_unlock(inode);
 875         }
 876         fput(od->realfile);
 877         if (od->upperfile)
 878                 fput(od->upperfile);
 879         kfree(od);
 880 
 881         return 0;
 882 }
 883 
 884 static int ovl_dir_open(struct inode *inode, struct file *file)
 885 {
 886         struct path realpath;
 887         struct file *realfile;
 888         struct ovl_dir_file *od;
 889         enum ovl_path_type type;
 890 
 891         od = kzalloc(sizeof(struct ovl_dir_file), GFP_KERNEL);
 892         if (!od)
 893                 return -ENOMEM;
 894 
 895         type = ovl_path_real(file->f_path.dentry, &realpath);
 896         realfile = ovl_path_open(&realpath, file->f_flags);
 897         if (IS_ERR(realfile)) {
 898                 kfree(od);
 899                 return PTR_ERR(realfile);
 900         }
 901         od->realfile = realfile;
 902         od->is_real = ovl_dir_is_real(file->f_path.dentry);
 903         od->is_upper = OVL_TYPE_UPPER(type);
 904         file->private_data = od;
 905 
 906         return 0;
 907 }
 908 
 909 const struct file_operations ovl_dir_operations = {
 910         .read           = generic_read_dir,
 911         .open           = ovl_dir_open,
 912         .iterate        = ovl_iterate,
 913         .llseek         = ovl_dir_llseek,
 914         .fsync          = ovl_dir_fsync,
 915         .release        = ovl_dir_release,
 916 };
 917 
 918 int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list)
 919 {
 920         int err;
 921         struct ovl_cache_entry *p, *n;
 922         struct rb_root root = RB_ROOT;
 923         const struct cred *old_cred;
 924 
 925         old_cred = ovl_override_creds(dentry->d_sb);
 926         err = ovl_dir_read_merged(dentry, list, &root);
 927         revert_creds(old_cred);
 928         if (err)
 929                 return err;
 930 
 931         err = 0;
 932 
 933         list_for_each_entry_safe(p, n, list, l_node) {
 934                 /*
 935                  * Select whiteouts in upperdir, they should
 936                  * be cleared when deleting this directory.
 937                  */
 938                 if (p->is_whiteout) {
 939                         if (p->is_upper)
 940                                 continue;
 941                         goto del_entry;
 942                 }
 943 
 944                 if (p->name[0] == '.') {
 945                         if (p->len == 1)
 946                                 goto del_entry;
 947                         if (p->len == 2 && p->name[1] == '.')
 948                                 goto del_entry;
 949                 }
 950                 err = -ENOTEMPTY;
 951                 break;
 952 
 953 del_entry:
 954                 list_del(&p->l_node);
 955                 kfree(p);
 956         }
 957 
 958         return err;
 959 }
 960 
 961 void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list)
 962 {
 963         struct ovl_cache_entry *p;
 964 
 965         inode_lock_nested(upper->d_inode, I_MUTEX_CHILD);
 966         list_for_each_entry(p, list, l_node) {
 967                 struct dentry *dentry;
 968 
 969                 if (WARN_ON(!p->is_whiteout || !p->is_upper))
 970                         continue;
 971 
 972                 dentry = lookup_one_len(p->name, upper, p->len);
 973                 if (IS_ERR(dentry)) {
 974                         pr_err("overlayfs: lookup '%s/%.*s' failed (%i)\n",
 975                                upper->d_name.name, p->len, p->name,
 976                                (int) PTR_ERR(dentry));
 977                         continue;
 978                 }
 979                 if (dentry->d_inode)
 980                         ovl_cleanup(upper->d_inode, dentry);
 981                 dput(dentry);
 982         }
 983         inode_unlock(upper->d_inode);
 984 }
 985 
 986 static int ovl_check_d_type(struct dir_context *ctx, const char *name,
 987                           int namelen, loff_t offset, u64 ino,
 988                           unsigned int d_type)
 989 {
 990         struct ovl_readdir_data *rdd =
 991                 container_of(ctx, struct ovl_readdir_data, ctx);
 992 
 993         /* Even if d_type is not supported, DT_DIR is returned for . and .. */
 994         if (!strncmp(name, ".", namelen) || !strncmp(name, "..", namelen))
 995                 return 0;
 996 
 997         if (d_type != DT_UNKNOWN)
 998                 rdd->d_type_supported = true;
 999 
1000         return 0;
1001 }
1002 
1003 /*
1004  * Returns 1 if d_type is supported, 0 not supported/unknown. Negative values
1005  * if error is encountered.
1006  */
1007 int ovl_check_d_type_supported(struct path *realpath)
1008 {
1009         int err;
1010         struct ovl_readdir_data rdd = {
1011                 .ctx.actor = ovl_check_d_type,
1012                 .d_type_supported = false,
1013         };
1014 
1015         err = ovl_dir_read(realpath, &rdd);
1016         if (err)
1017                 return err;
1018 
1019         return rdd.d_type_supported;
1020 }
1021 
1022 static void ovl_workdir_cleanup_recurse(struct path *path, int level)
1023 {
1024         int err;
1025         struct inode *dir = path->dentry->d_inode;
1026         LIST_HEAD(list);
1027         struct rb_root root = RB_ROOT;
1028         struct ovl_cache_entry *p;
1029         struct ovl_readdir_data rdd = {
1030                 .ctx.actor = ovl_fill_merge,
1031                 .dentry = NULL,
1032                 .list = &list,
1033                 .root = &root,
1034                 .is_lowest = false,
1035         };
1036 
1037         err = ovl_dir_read(path, &rdd);
1038         if (err)
1039                 goto out;
1040 
1041         inode_lock_nested(dir, I_MUTEX_PARENT);
1042         list_for_each_entry(p, &list, l_node) {
1043                 struct dentry *dentry;
1044 
1045                 if (p->name[0] == '.') {
1046                         if (p->len == 1)
1047                                 continue;
1048                         if (p->len == 2 && p->name[1] == '.')
1049                                 continue;
1050                 }
1051                 dentry = lookup_one_len(p->name, path->dentry, p->len);
1052                 if (IS_ERR(dentry))
1053                         continue;
1054                 if (dentry->d_inode)
1055                         ovl_workdir_cleanup(dir, path->mnt, dentry, level);
1056                 dput(dentry);
1057         }
1058         inode_unlock(dir);
1059 out:
1060         ovl_cache_free(&list);
1061 }
1062 
1063 void ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt,
1064                          struct dentry *dentry, int level)
1065 {
1066         int err;
1067 
1068         if (!d_is_dir(dentry) || level > 1) {
1069                 ovl_cleanup(dir, dentry);
1070                 return;
1071         }
1072 
1073         err = ovl_do_rmdir(dir, dentry);
1074         if (err) {
1075                 struct path path = { .mnt = mnt, .dentry = dentry };
1076 
1077                 inode_unlock(dir);
1078                 ovl_workdir_cleanup_recurse(&path, level + 1);
1079                 inode_lock_nested(dir, I_MUTEX_PARENT);
1080                 ovl_cleanup(dir, dentry);
1081         }
1082 }
1083 
1084 int ovl_indexdir_cleanup(struct ovl_fs *ofs)
1085 {
1086         int err;
1087         struct dentry *indexdir = ofs->indexdir;
1088         struct dentry *index = NULL;
1089         struct inode *dir = indexdir->d_inode;
1090         struct path path = { .mnt = ofs->upper_mnt, .dentry = indexdir };
1091         LIST_HEAD(list);
1092         struct rb_root root = RB_ROOT;
1093         struct ovl_cache_entry *p;
1094         struct ovl_readdir_data rdd = {
1095                 .ctx.actor = ovl_fill_merge,
1096                 .dentry = NULL,
1097                 .list = &list,
1098                 .root = &root,
1099                 .is_lowest = false,
1100         };
1101 
1102         err = ovl_dir_read(&path, &rdd);
1103         if (err)
1104                 goto out;
1105 
1106         inode_lock_nested(dir, I_MUTEX_PARENT);
1107         list_for_each_entry(p, &list, l_node) {
1108                 if (p->name[0] == '.') {
1109                         if (p->len == 1)
1110                                 continue;
1111                         if (p->len == 2 && p->name[1] == '.')
1112                                 continue;
1113                 }
1114                 index = lookup_one_len(p->name, indexdir, p->len);
1115                 if (IS_ERR(index)) {
1116                         err = PTR_ERR(index);
1117                         index = NULL;
1118                         break;
1119                 }
1120                 err = ovl_verify_index(ofs, index);
1121                 if (!err) {
1122                         goto next;
1123                 } else if (err == -ESTALE) {
1124                         /* Cleanup stale index entries */
1125                         err = ovl_cleanup(dir, index);
1126                 } else if (err != -ENOENT) {
1127                         /*
1128                          * Abort mount to avoid corrupting the index if
1129                          * an incompatible index entry was found or on out
1130                          * of memory.
1131                          */
1132                         break;
1133                 } else if (ofs->config.nfs_export) {
1134                         /*
1135                          * Whiteout orphan index to block future open by
1136                          * handle after overlay nlink dropped to zero.
1137                          */
1138                         err = ovl_cleanup_and_whiteout(indexdir, dir, index);
1139                 } else {
1140                         /* Cleanup orphan index entries */
1141                         err = ovl_cleanup(dir, index);
1142                 }
1143 
1144                 if (err)
1145                         break;
1146 
1147 next:
1148                 dput(index);
1149                 index = NULL;
1150         }
1151         dput(index);
1152         inode_unlock(dir);
1153 out:
1154         ovl_cache_free(&list);
1155         if (err)
1156                 pr_err("overlayfs: failed index dir cleanup (%i)\n", err);
1157         return err;
1158 }