include/linux/dcache.h

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