include/linux/dcache.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __LINUX_DCACHE_H
   3 #define __LINUX_DCACHE_H
   4
   5 #include <linux/atomic.h>
   6 #include <linux/list.h>
   7 #include <linux/math.h>
   8 #include <linux/rculist.h>
   9 #include <linux/rculist_bl.h>
  10 #include <linux/spinlock.h>
  11 #include <linux/seqlock.h>
  12 #include <linux/cache.h>
  13 #include <linux/rcupdate.h>
  14 #include <linux/lockref.h>
  15 #include <linux/stringhash.h>
  16 #include <linux/wait.h>
  17
  18 struct path;
  19 struct vfsmount;
  20
  21 /*
  22  * linux/include/linux/dcache.h
  23  *
  24  * Dirent cache data structures
  25  *
  26  * (C) Copyright 1997 Thomas Schoebel-Theuer,
  27  * with heavy changes by Linus Torvalds
  28  */
  29
  30 #define IS_ROOT(x) ((x) == (x)->d_parent)
  31
  32 /* The hash is always the low bits of hash_len */
  33 #ifdef __LITTLE_ENDIAN
  34  #define HASH_LEN_DECLARE u32 hash; u32 len
  35  #define bytemask_from_count(cnt)       (~(~0ul << (cnt)*8))
  36 #else
  37  #define HASH_LEN_DECLARE u32 len; u32 hash
  38  #define bytemask_from_count(cnt)       (~(~0ul >> (cnt)*8))
  39 #endif
  40
  41 /*
  42  * "quick string" -- eases parameter passing, but more importantly
  43  * saves "metadata" about the string (ie length and the hash).
  44  *
  45  * hash comes first so it snuggles against d_parent in the
  46  * dentry.
  47  */
  48 struct qstr {
  49         union {
  50                 struct {
  51                         HASH_LEN_DECLARE;
  52                 };
  53                 u64 hash_len;
  54         };
  55         const unsigned char *name;
  56 };
  57
  58 #define QSTR_INIT(n,l) { { { .len = l } }, .name = n }
  59
  60 extern const struct qstr empty_name;
  61 extern const struct qstr slash_name;
  62 extern const struct qstr dotdot_name;
  63
  64 /*
  65  * Try to keep struct dentry aligned on 64 byte cachelines (this will
  66  * give reasonable cacheline footprint with larger lines without the
  67  * large memory footprint increase).
  68  */
  69 #ifdef CONFIG_64BIT
  70 # define DNAME_INLINE_LEN 32 /* 192 bytes */
  71 #else
  72 # ifdef CONFIG_SMP
  73 #  define DNAME_INLINE_LEN 36 /* 128 bytes */
  74 # else
  75 #  define DNAME_INLINE_LEN 40 /* 128 bytes */
  76 # endif
  77 #endif
  78
  79 #define d_lock  d_lockref.lock
  80
  81 struct dentry {
  82         /* RCU lookup touched fields */
  83         unsigned int d_flags;           /* protected by d_lock */
  84         seqcount_spinlock_t d_seq;      /* per dentry seqlock */
  85         struct hlist_bl_node d_hash;    /* lookup hash list */
  86         struct dentry *d_parent;        /* parent directory */
  87         struct qstr d_name;
  88         struct inode *d_inode;          /* Where the name belongs to - NULL is
  89                                          * negative */
  90         unsigned char d_iname[DNAME_INLINE_LEN];        /* small names */
  91
  92         /* Ref lookup also touches following */
  93         struct lockref d_lockref;       /* per-dentry lock and refcount */
  94         const struct dentry_operations *d_op;
  95         struct super_block *d_sb;       /* The root of the dentry tree */
  96         unsigned long d_time;           /* used by d_revalidate */
  97         void *d_fsdata;                 /* fs-specific data */
  98
  99         union {
 100                 struct list_head d_lru;         /* LRU list */
 101                 wait_queue_head_t *d_wait;      /* in-lookup ones only */
 102         };
 103         struct list_head d_child;       /* child of parent list */
 104         struct list_head d_subdirs;     /* our children */
 105         /*
 106          * d_alias and d_rcu can share memory
 107          */
 108         union {
 109                 struct hlist_node d_alias;      /* inode alias list */
 110                 struct hlist_bl_node d_in_lookup_hash;  /* only for in-lookup ones */
 111                 struct rcu_head d_rcu;
 112         } d_u;
 113 } __randomize_layout;
 114
 115 /*
 116  * dentry->d_lock spinlock nesting subclasses:
 117  *
 118  * 0: normal
 119  * 1: nested
 120  */
 121 enum dentry_d_lock_class
 122 {
 123         DENTRY_D_LOCK_NORMAL, /* implicitly used by plain spin_lock() APIs. */
 124         DENTRY_D_LOCK_NESTED
 125 };
 126
 127 struct dentry_operations {
 128         int (*d_revalidate)(struct dentry *, unsigned int);
 129         int (*d_weak_revalidate)(struct dentry *, unsigned int);
 130         int (*d_hash)(const struct dentry *, struct qstr *);
 131         int (*d_compare)(const struct dentry *,
 132                         unsigned int, const char *, const struct qstr *);
 133         int (*d_delete)(const struct dentry *);
 134         int (*d_init)(struct dentry *);
 135         void (*d_release)(struct dentry *);
 136         void (*d_prune)(struct dentry *);
 137         void (*d_iput)(struct dentry *, struct inode *);
 138         char *(*d_dname)(struct dentry *, char *, int);
 139         struct vfsmount *(*d_automount)(struct path *);
 140         int (*d_manage)(const struct path *, bool);
 141         struct dentry *(*d_real)(struct dentry *, const struct inode *);
 142 } ____cacheline_aligned;
 143
 144 /*
 145  * Locking rules for dentry_operations callbacks are to be found in
 146  * Documentation/filesystems/locking.rst. Keep it updated!
 147  *
 148  * FUrther descriptions are found in Documentation/filesystems/vfs.rst.
 149  * Keep it updated too!
 150  */
 151
 152 /* d_flags entries */
 153 #define DCACHE_OP_HASH                  0x00000001
 154 #define DCACHE_OP_COMPARE               0x00000002
 155 #define DCACHE_OP_REVALIDATE            0x00000004
 156 #define DCACHE_OP_DELETE                0x00000008
 157 #define DCACHE_OP_PRUNE                 0x00000010
 158
 159 #define DCACHE_DISCONNECTED             0x00000020
 160      /* This dentry is possibly not currently connected to the dcache tree, in
 161       * which case its parent will either be itself, or will have this flag as
 162       * well.  nfsd will not use a dentry with this bit set, but will first
 163       * endeavour to clear the bit either by discovering that it is connected,
 164       * or by performing lookup operations.   Any filesystem which supports
 165       * nfsd_operations MUST have a lookup function which, if it finds a
 166       * directory inode with a DCACHE_DISCONNECTED dentry, will d_move that
 167       * dentry into place and return that dentry rather than the passed one,
 168       * typically using d_splice_alias. */
 169
 170 #define DCACHE_REFERENCED               0x00000040 /* Recently used, don't discard. */
 171
 172 #define DCACHE_DONTCACHE                0x00000080 /* Purge from memory on final dput() */
 173
 174 #define DCACHE_CANT_MOUNT               0x00000100
 175 #define DCACHE_GENOCIDE                 0x00000200
 176 #define DCACHE_SHRINK_LIST              0x00000400
 177
 178 #define DCACHE_OP_WEAK_REVALIDATE       0x00000800
 179
 180 #define DCACHE_NFSFS_RENAMED            0x00001000
 181      /* this dentry has been "silly renamed" and has to be deleted on the last
 182       * dput() */
 183 #define DCACHE_COOKIE                   0x00002000 /* For use by dcookie subsystem */
 184 #define DCACHE_FSNOTIFY_PARENT_WATCHED  0x00004000
 185      /* Parent inode is watched by some fsnotify listener */
 186
 187 #define DCACHE_DENTRY_KILLED            0x00008000
 188
 189 #define DCACHE_MOUNTED                  0x00010000 /* is a mountpoint */
 190 #define DCACHE_NEED_AUTOMOUNT           0x00020000 /* handle automount on this dir */
 191 #define DCACHE_MANAGE_TRANSIT           0x00040000 /* manage transit from this dirent */
 192 #define DCACHE_MANAGED_DENTRY \
 193         (DCACHE_MOUNTED|DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT)
 194
 195 #define DCACHE_LRU_LIST                 0x00080000
 196
 197 #define DCACHE_ENTRY_TYPE               0x00700000
 198 #define DCACHE_MISS_TYPE                0x00000000 /* Negative dentry (maybe fallthru to nowhere) */
 199 #define DCACHE_WHITEOUT_TYPE            0x00100000 /* Whiteout dentry (stop pathwalk) */
 200 #define DCACHE_DIRECTORY_TYPE           0x00200000 /* Normal directory */
 201 #define DCACHE_AUTODIR_TYPE             0x00300000 /* Lookupless directory (presumed automount) */
 202 #define DCACHE_REGULAR_TYPE             0x00400000 /* Regular file type (or fallthru to such) */
 203 #define DCACHE_SPECIAL_TYPE             0x00500000 /* Other file type (or fallthru to such) */
 204 #define DCACHE_SYMLINK_TYPE             0x00600000 /* Symlink (or fallthru to such) */
 205
 206 #define DCACHE_MAY_FREE                 0x00800000
 207 #define DCACHE_FALLTHRU                 0x01000000 /* Fall through to lower layer */
 208 #define DCACHE_NOKEY_NAME               0x02000000 /* Encrypted name encoded without key */
 209 #define DCACHE_OP_REAL                  0x04000000
 210
 211 #define DCACHE_PAR_LOOKUP               0x10000000 /* being looked up (with parent locked shared) */
 212 #define DCACHE_DENTRY_CURSOR            0x20000000
 213 #define DCACHE_NORCU                    0x40000000 /* No RCU delay for freeing */
 214
 215 extern seqlock_t rename_lock;
 216
 217 /*
 218  * These are the low-level FS interfaces to the dcache..
 219  */
 220 extern void d_instantiate(struct dentry *, struct inode *);
 221 extern void d_instantiate_new(struct dentry *, struct inode *);
 222 extern struct dentry * d_instantiate_unique(struct dentry *, struct inode *);
 223 extern struct dentry * d_instantiate_anon(struct dentry *, struct inode *);
 224 extern void __d_drop(struct dentry *dentry);
 225 extern void d_drop(struct dentry *dentry);
 226 extern void d_delete(struct dentry *);
 227 extern void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op);
 228
 229 /* allocate/de-allocate */
 230 extern struct dentry * d_alloc(struct dentry *, const struct qstr *);
 231 extern struct dentry * d_alloc_anon(struct super_block *);
 232 extern struct dentry * d_alloc_parallel(struct dentry *, const struct qstr *,
 233                                         wait_queue_head_t *);
 234 extern struct dentry * d_splice_alias(struct inode *, struct dentry *);
 235 extern struct dentry * d_add_ci(struct dentry *, struct inode *, struct qstr *);
 236 extern struct dentry * d_exact_alias(struct dentry *, struct inode *);
 237 extern struct dentry *d_find_any_alias(struct inode *inode);
 238 extern struct dentry * d_obtain_alias(struct inode *);
 239 extern struct dentry * d_obtain_root(struct inode *);
 240 extern void shrink_dcache_sb(struct super_block *);
 241 extern void shrink_dcache_parent(struct dentry *);
 242 extern void shrink_dcache_for_umount(struct super_block *);
 243 extern void d_invalidate(struct dentry *);
 244
 245 /* only used at mount-time */
 246 extern struct dentry * d_make_root(struct inode *);
 247
 248 /* <clickety>-<click> the ramfs-type tree */
 249 extern void d_genocide(struct dentry *);
 250
 251 extern void d_tmpfile(struct dentry *, struct inode *);
 252
 253 extern struct dentry *d_find_alias(struct inode *);
 254 extern void d_prune_aliases(struct inode *);
 255
 256 extern struct dentry *d_find_alias_rcu(struct inode *);
 257
 258 /* test whether we have any submounts in a subdir tree */
 259 extern int path_has_submounts(const struct path *);
 260
 261 /*
 262  * This adds the entry to the hash queues.
 263  */
 264 extern void d_rehash(struct dentry *);
 265
 266 extern void d_add(struct dentry *, struct inode *);
 267
 268 /* used for rename() and baskets */
 269 extern void d_move(struct dentry *, struct dentry *);
 270 extern void d_exchange(struct dentry *, struct dentry *);
 271 extern struct dentry *d_ancestor(struct dentry *, struct dentry *);
 272
 273 /* appendix may either be NULL or be used for transname suffixes */
 274 extern struct dentry *d_lookup(const struct dentry *, const struct qstr *);
 275 extern struct dentry *d_hash_and_lookup(struct dentry *, struct qstr *);
 276 extern struct dentry *__d_lookup(const struct dentry *, const struct qstr *);
 277 extern struct dentry *__d_lookup_rcu(const struct dentry *parent,
 278                                 const struct qstr *name, unsigned *seq);
 279
 280 static inline unsigned d_count(const struct dentry *dentry)
 281 {
 282         return dentry->d_lockref.count;
 283 }
 284
 285 /*
 286  * helper function for dentry_operations.d_dname() members
 287  */
 288 extern __printf(4, 5)
 289 char *dynamic_dname(struct dentry *, char *, int, const char *, ...);
 290
 291 extern char *__d_path(const struct path *, const struct path *, char *, int);
 292 extern char *d_absolute_path(const struct path *, char *, int);
 293 extern char *d_path(const struct path *, char *, int);
 294 extern char *dentry_path_raw(const struct dentry *, char *, int);
 295 extern char *dentry_path(const struct dentry *, char *, int);
 296
 297 /* Allocation counts.. */
 298
 299 /**
 300  *      dget, dget_dlock -      get a reference to a dentry
 301  *      @dentry: dentry to get a reference to
 302  *
 303  *      Given a dentry or %NULL pointer increment the reference count
 304  *      if appropriate and return the dentry. A dentry will not be
 305  *      destroyed when it has references.
 306  */
 307 static inline struct dentry *dget_dlock(struct dentry *dentry)
 308 {
 309         if (dentry)
 310                 dentry->d_lockref.count++;
 311         return dentry;
 312 }
 313
 314 static inline struct dentry *dget(struct dentry *dentry)
 315 {
 316         if (dentry)
 317                 lockref_get(&dentry->d_lockref);
 318         return dentry;
 319 }
 320
 321 extern struct dentry *dget_parent(struct dentry *dentry);
 322
 323 /**
 324  *      d_unhashed -    is dentry hashed
 325  *      @dentry: entry to check
 326  *
 327  *      Returns true if the dentry passed is not currently hashed.
 328  */
 329
 330 static inline int d_unhashed(const struct dentry *dentry)
 331 {
 332         return hlist_bl_unhashed(&dentry->d_hash);
 333 }
 334
 335 static inline int d_unlinked(const struct dentry *dentry)
 336 {
 337         return d_unhashed(dentry) && !IS_ROOT(dentry);
 338 }
 339
 340 static inline int cant_mount(const struct dentry *dentry)
 341 {
 342         return (dentry->d_flags & DCACHE_CANT_MOUNT);
 343 }
 344
 345 static inline void dont_mount(struct dentry *dentry)
 346 {
 347         spin_lock(&dentry->d_lock);
 348         dentry->d_flags |= DCACHE_CANT_MOUNT;
 349         spin_unlock(&dentry->d_lock);
 350 }
 351
 352 extern void __d_lookup_unhash_wake(struct dentry *dentry);
 353
 354 static inline int d_in_lookup(const struct dentry *dentry)
 355 {
 356         return dentry->d_flags & DCACHE_PAR_LOOKUP;
 357 }
 358
 359 static inline void d_lookup_done(struct dentry *dentry)
 360 {
 361         if (unlikely(d_in_lookup(dentry)))
 362                 __d_lookup_unhash_wake(dentry);
 363 }
 364
 365 extern void dput(struct dentry *);
 366
 367 static inline bool d_managed(const struct dentry *dentry)
 368 {
 369         return dentry->d_flags & DCACHE_MANAGED_DENTRY;
 370 }
 371
 372 static inline bool d_mountpoint(const struct dentry *dentry)
 373 {
 374         return dentry->d_flags & DCACHE_MOUNTED;
 375 }
 376
 377 /*
 378  * Directory cache entry type accessor functions.
 379  */
 380 static inline unsigned __d_entry_type(const struct dentry *dentry)
 381 {
 382         return dentry->d_flags & DCACHE_ENTRY_TYPE;
 383 }
 384
 385 static inline bool d_is_miss(const struct dentry *dentry)
 386 {
 387         return __d_entry_type(dentry) == DCACHE_MISS_TYPE;
 388 }
 389
 390 static inline bool d_is_whiteout(const struct dentry *dentry)
 391 {
 392         return __d_entry_type(dentry) == DCACHE_WHITEOUT_TYPE;
 393 }
 394
 395 static inline bool d_can_lookup(const struct dentry *dentry)
 396 {
 397         return __d_entry_type(dentry) == DCACHE_DIRECTORY_TYPE;
 398 }
 399
 400 static inline bool d_is_autodir(const struct dentry *dentry)
 401 {
 402         return __d_entry_type(dentry) == DCACHE_AUTODIR_TYPE;
 403 }
 404
 405 static inline bool d_is_dir(const struct dentry *dentry)
 406 {
 407         return d_can_lookup(dentry) || d_is_autodir(dentry);
 408 }
 409
 410 static inline bool d_is_symlink(const struct dentry *dentry)
 411 {
 412         return __d_entry_type(dentry) == DCACHE_SYMLINK_TYPE;
 413 }
 414
 415 static inline bool d_is_reg(const struct dentry *dentry)
 416 {
 417         return __d_entry_type(dentry) == DCACHE_REGULAR_TYPE;
 418 }
 419
 420 static inline bool d_is_special(const struct dentry *dentry)
 421 {
 422         return __d_entry_type(dentry) == DCACHE_SPECIAL_TYPE;
 423 }
 424
 425 static inline bool d_is_file(const struct dentry *dentry)
 426 {
 427         return d_is_reg(dentry) || d_is_special(dentry);
 428 }
 429
 430 static inline bool d_is_negative(const struct dentry *dentry)
 431 {
 432         // TODO: check d_is_whiteout(dentry) also.
 433         return d_is_miss(dentry);
 434 }
 435
 436 static inline bool d_flags_negative(unsigned flags)
 437 {
 438         return (flags & DCACHE_ENTRY_TYPE) == DCACHE_MISS_TYPE;
 439 }
 440
 441 static inline bool d_is_positive(const struct dentry *dentry)
 442 {
 443         return !d_is_negative(dentry);
 444 }
 445
 446 /**
 447  * d_really_is_negative - Determine if a dentry is really negative (ignoring fallthroughs)
 448  * @dentry: The dentry in question
 449  *
 450  * Returns true if the dentry represents either an absent name or a name that
 451  * doesn't map to an inode (ie. ->d_inode is NULL).  The dentry could represent
 452  * a true miss, a whiteout that isn't represented by a 0,0 chardev or a
 453  * fallthrough marker in an opaque directory.
 454  *
 455  * Note!  (1) This should be used *only* by a filesystem to examine its own
 456  * dentries.  It should not be used to look at some other filesystem's
 457  * dentries.  (2) It should also be used in combination with d_inode() to get
 458  * the inode.  (3) The dentry may have something attached to ->d_lower and the
 459  * type field of the flags may be set to something other than miss or whiteout.
 460  */
 461 static inline bool d_really_is_negative(const struct dentry *dentry)
 462 {
 463         return dentry->d_inode == NULL;
 464 }
 465
 466 /**
 467  * d_really_is_positive - Determine if a dentry is really positive (ignoring fallthroughs)
 468  * @dentry: The dentry in question
 469  *
 470  * Returns true if the dentry represents a name that maps to an inode
 471  * (ie. ->d_inode is not NULL).  The dentry might still represent a whiteout if
 472  * that is represented on medium as a 0,0 chardev.
 473  *
 474  * Note!  (1) This should be used *only* by a filesystem to examine its own
 475  * dentries.  It should not be used to look at some other filesystem's
 476  * dentries.  (2) It should also be used in combination with d_inode() to get
 477  * the inode.
 478  */
 479 static inline bool d_really_is_positive(const struct dentry *dentry)
 480 {
 481         return dentry->d_inode != NULL;
 482 }
 483
 484 static inline int simple_positive(const struct dentry *dentry)
 485 {
 486         return d_really_is_positive(dentry) && !d_unhashed(dentry);
 487 }
 488
 489 extern void d_set_fallthru(struct dentry *dentry);
 490
 491 static inline bool d_is_fallthru(const struct dentry *dentry)
 492 {
 493         return dentry->d_flags & DCACHE_FALLTHRU;
 494 }
 495
 496
 497 extern int sysctl_vfs_cache_pressure;
 498
 499 static inline unsigned long vfs_pressure_ratio(unsigned long val)
 500 {
 501         return mult_frac(val, sysctl_vfs_cache_pressure, 100);
 502 }
 503
 504 /**
 505  * d_inode - Get the actual inode of this dentry
 506  * @dentry: The dentry to query
 507  *
 508  * This is the helper normal filesystems should use to get at their own inodes
 509  * in their own dentries and ignore the layering superimposed upon them.
 510  */
 511 static inline struct inode *d_inode(const struct dentry *dentry)
 512 {
 513         return dentry->d_inode;
 514 }
 515
 516 /**
 517  * d_inode_rcu - Get the actual inode of this dentry with READ_ONCE()
 518  * @dentry: The dentry to query
 519  *
 520  * This is the helper normal filesystems should use to get at their own inodes
 521  * in their own dentries and ignore the layering superimposed upon them.
 522  */
 523 static inline struct inode *d_inode_rcu(const struct dentry *dentry)
 524 {
 525         return READ_ONCE(dentry->d_inode);
 526 }
 527
 528 /**
 529  * d_backing_inode - Get upper or lower inode we should be using
 530  * @upper: The upper layer
 531  *
 532  * This is the helper that should be used to get at the inode that will be used
 533  * if this dentry were to be opened as a file.  The inode may be on the upper
 534  * dentry or it may be on a lower dentry pinned by the upper.
 535  *
 536  * Normal filesystems should not use this to access their own inodes.
 537  */
 538 static inline struct inode *d_backing_inode(const struct dentry *upper)
 539 {
 540         struct inode *inode = upper->d_inode;
 541
 542         return inode;
 543 }
 544
 545 /**
 546  * d_backing_dentry - Get upper or lower dentry we should be using
 547  * @upper: The upper layer
 548  *
 549  * This is the helper that should be used to get the dentry of the inode that
 550  * will be used if this dentry were opened as a file.  It may be the upper
 551  * dentry or it may be a lower dentry pinned by the upper.
 552  *
 553  * Normal filesystems should not use this to access their own dentries.
 554  */
 555 static inline struct dentry *d_backing_dentry(struct dentry *upper)
 556 {
 557         return upper;
 558 }
 559
 560 /**
 561  * d_real - Return the real dentry
 562  * @dentry: the dentry to query
 563  * @inode: inode to select the dentry from multiple layers (can be NULL)
 564  *
 565  * If dentry is on a union/overlay, then return the underlying, real dentry.
 566  * Otherwise return the dentry itself.
 567  *
 568  * See also: Documentation/filesystems/vfs.rst
 569  */
 570 static inline struct dentry *d_real(struct dentry *dentry,
 571                                     const struct inode *inode)
 572 {
 573         if (unlikely(dentry->d_flags & DCACHE_OP_REAL))
 574                 return dentry->d_op->d_real(dentry, inode);
 575         else
 576                 return dentry;
 577 }
 578
 579 /**
 580  * d_real_inode - Return the real inode
 581  * @dentry: The dentry to query
 582  *
 583  * If dentry is on a union/overlay, then return the underlying, real inode.
 584  * Otherwise return d_inode().
 585  */
 586 static inline struct inode *d_real_inode(const struct dentry *dentry)
 587 {
 588         /* This usage of d_real() results in const dentry */
 589         return d_backing_inode(d_real((struct dentry *) dentry, NULL));
 590 }
 591
 592 struct name_snapshot {
 593         struct qstr name;
 594         unsigned char inline_name[DNAME_INLINE_LEN];
 595 };
 596 void take_dentry_name_snapshot(struct name_snapshot *, struct dentry *);
 597 void release_dentry_name_snapshot(struct name_snapshot *);
 598
 599 #endif  /* __LINUX_DCACHE_H */