include/linux/dcache.h

   1 #ifndef __LINUX_DCACHE_H
   2 #define __LINUX_DCACHE_H
   3
   4 #ifdef __KERNEL__
   5
   6 #include <asm/atomic.h>
   7 #include <linux/list.h>
   8 #include <linux/spinlock.h>
   9 #include <linux/cache.h>
  10 #include <linux/rcupdate.h>
  11 #include <asm/bug.h>
  12
  13 struct nameidata;
  14 struct vfsmount;
  15
  16 /*
  17  * linux/include/linux/dcache.h
  18  *
  19  * Dirent cache data structures
  20  *
  21  * (C) Copyright 1997 Thomas Schoebel-Theuer,
  22  * with heavy changes by Linus Torvalds
  23  */
  24
  25 #define IS_ROOT(x) ((x) == (x)->d_parent)
  26
  27 /*
  28  * "quick string" -- eases parameter passing, but more importantly
  29  * saves "metadata" about the string (ie length and the hash).
  30  *
  31  * hash comes first so it snuggles against d_parent and d_bucket in the
  32  * dentry.
  33  */
  34 struct qstr {
  35         unsigned int hash;
  36         const unsigned char *name;
  37         unsigned int len;
  38 };
  39
  40 struct dentry_stat_t {
  41         int nr_dentry;
  42         int nr_unused;
  43         int age_limit;          /* age in seconds */
  44         int want_pages;         /* pages requested by system */
  45         int dummy[2];
  46 };
  47 extern struct dentry_stat_t dentry_stat;
  48
  49 /* Name hashing routines. Initial hash value */
  50 /* Hash courtesy of the R5 hash in reiserfs modulo sign bits */
  51 #define init_name_hash()                0
  52
  53 /* partial hash update function. Assume roughly 4 bits per character */
  54 static inline unsigned long
  55 partial_name_hash(unsigned long c, unsigned long prevhash)
  56 {
  57         return (prevhash + (c << 4) + (c >> 4)) * 11;
  58 }
  59
  60 /*
  61  * Finally: cut down the number of bits to a int value (and try to avoid
  62  * losing bits)
  63  */
  64 static inline unsigned long end_name_hash(unsigned long hash)
  65 {
  66         return (unsigned int) hash;
  67 }
  68
  69 /* Compute the hash for a name string. */
  70 static inline unsigned int
  71 full_name_hash(const unsigned char *name, unsigned int len)
  72 {
  73         unsigned long hash = init_name_hash();
  74         while (len--)
  75                 hash = partial_name_hash(*name++, hash);
  76         return end_name_hash(hash);
  77 }
  78
  79 struct dcookie_struct;
  80
  81 #define DNAME_INLINE_LEN_MIN 36
  82
  83 struct dentry {
  84         atomic_t d_count;
  85         unsigned int d_flags;           /* protected by d_lock */
  86         spinlock_t d_lock;              /* per dentry lock */
  87         struct inode *d_inode;          /* Where the name belongs to - NULL is
  88                                          * negative */
  89         /*
  90          * The next three fields are touched by __d_lookup.  Place them here
  91          * so they all fit in a 16-byte range, with 16-byte alignment.
  92          */
  93         struct dentry *d_parent;        /* parent directory */
  94         struct hlist_head *d_bucket;    /* lookup hash bucket */
  95         struct qstr d_name;
  96
  97         struct list_head d_lru;         /* LRU list */
  98         struct list_head d_child;       /* child of parent list */
  99         struct list_head d_subdirs;     /* our children */
 100         struct list_head d_alias;       /* inode alias list */
 101         unsigned long d_time;           /* used by d_revalidate */
 102         struct dentry_operations *d_op;
 103         struct super_block *d_sb;       /* The root of the dentry tree */
 104         int d_mounted;
 105         void *d_fsdata;                 /* fs-specific data */
 106         void * d_extra_attributes;      /* TUX-specific data */
 107         struct rcu_head d_rcu;
 108         struct dcookie_struct *d_cookie; /* cookie, if any */
 109         struct hlist_node d_hash;       /* lookup hash list */
 110         unsigned char d_iname[DNAME_INLINE_LEN_MIN];    /* small names */
 111 };
 112
 113 struct dentry_operations {
 114         int (*d_revalidate)(struct dentry *, struct nameidata *);
 115         int (*d_hash) (struct dentry *, struct qstr *);
 116         int (*d_compare) (struct dentry *, struct qstr *, struct qstr *);
 117         int (*d_delete)(struct dentry *);
 118         void (*d_release)(struct dentry *);
 119         void (*d_iput)(struct dentry *, struct inode *);
 120 };
 121
 122 /* the dentry parameter passed to d_hash and d_compare is the parent
 123  * directory of the entries to be compared. It is used in case these
 124  * functions need any directory specific information for determining
 125  * equivalency classes.  Using the dentry itself might not work, as it
 126  * might be a negative dentry which has no information associated with
 127  * it */
 128
 129 /*
 130 locking rules:
 131                 big lock        dcache_lock     d_lock   may block
 132 d_revalidate:   no              no              no       yes
 133 d_hash          no              no              no       yes
 134 d_compare:      no              yes             yes      no
 135 d_delete:       no              yes             no       no
 136 d_release:      no              no              no       yes
 137 d_iput:         no              no              no       yes
 138  */
 139
 140 /* d_flags entries */
 141 #define DCACHE_AUTOFS_PENDING 0x0001    /* autofs: "under construction" */
 142 #define DCACHE_NFSFS_RENAMED  0x0002    /* this dentry has been "silly
 143                                          * renamed" and has to be
 144                                          * deleted on the last dput()
 145                                          */
 146 #define DCACHE_DISCONNECTED 0x0004
 147      /* This dentry is possibly not currently connected to the dcache tree,
 148       * in which case its parent will either be itself, or will have this
 149       * flag as well.  nfsd will not use a dentry with this bit set, but will
 150       * first endeavour to clear the bit either by discovering that it is
 151       * connected, or by performing lookup operations.   Any filesystem which
 152       * supports nfsd_operations MUST have a lookup function which, if it finds
 153       * a directory inode with a DCACHE_DISCONNECTED dentry, will d_move
 154       * that dentry into place and return that dentry rather than the passed one,
 155       * typically using d_splice_alias.
 156       */
 157
 158 #define DCACHE_REFERENCED       0x0008  /* Recently used, don't discard. */
 159 #define DCACHE_UNHASHED         0x0010
 160
 161 extern spinlock_t dcache_lock;
 162
 163 /**
 164  * d_drop - drop a dentry
 165  * @dentry: dentry to drop
 166  *
 167  * d_drop() unhashes the entry from the parent
 168  * dentry hashes, so that it won't be found through
 169  * a VFS lookup any more. Note that this is different
 170  * from deleting the dentry - d_delete will try to
 171  * mark the dentry negative if possible, giving a
 172  * successful _negative_ lookup, while d_drop will
 173  * just make the cache lookup fail.
 174  *
 175  * d_drop() is used mainly for stuff that wants
 176  * to invalidate a dentry for some reason (NFS
 177  * timeouts or autofs deletes).
 178  */
 179
 180 static inline void __d_drop(struct dentry *dentry)
 181 {
 182         if (!(dentry->d_flags & DCACHE_UNHASHED)) {
 183                 dentry->d_flags |= DCACHE_UNHASHED;
 184                 hlist_del_rcu(&dentry->d_hash);
 185         }
 186 }
 187
 188 static inline void d_drop(struct dentry *dentry)
 189 {
 190         spin_lock(&dcache_lock);
 191         __d_drop(dentry);
 192         spin_unlock(&dcache_lock);
 193 }
 194
 195 static inline int dname_external(struct dentry *dentry)
 196 {
 197         return dentry->d_name.name != dentry->d_iname;
 198 }
 199
 200 /*
 201  * These are the low-level FS interfaces to the dcache..
 202  */
 203 extern void d_instantiate(struct dentry *, struct inode *);
 204 extern void d_delete(struct dentry *);
 205
 206 /* allocate/de-allocate */
 207 extern struct dentry * d_alloc(struct dentry *, const struct qstr *);
 208 extern struct dentry * d_alloc_anon(struct inode *);
 209 extern struct dentry * d_splice_alias(struct inode *, struct dentry *);
 210 extern void shrink_dcache_sb(struct super_block *);
 211 extern void shrink_dcache_parent(struct dentry *);
 212 extern void shrink_dcache_anon(struct hlist_head *);
 213 extern int d_invalidate(struct dentry *);
 214 extern void flush_dentry_attributes(void);
 215
 216 /* only used at mount-time */
 217 extern struct dentry * d_alloc_root(struct inode *);
 218
 219 /* <clickety>-<click> the ramfs-type tree */
 220 extern void d_genocide(struct dentry *);
 221
 222 extern struct dentry *d_find_alias(struct inode *);
 223 extern void d_prune_aliases(struct inode *);
 224
 225 /* test whether we have any submounts in a subdir tree */
 226 extern int have_submounts(struct dentry *);
 227
 228 /*
 229  * This adds the entry to the hash queues.
 230  */
 231 extern void d_rehash(struct dentry *);
 232
 233 /**
 234  * d_add - add dentry to hash queues
 235  * @entry: dentry to add
 236  * @inode: The inode to attach to this dentry
 237  *
 238  * This adds the entry to the hash queues and initializes @inode.
 239  * The entry was actually filled in earlier during d_alloc().
 240  */
 241
 242 static inline void d_add(struct dentry *entry, struct inode *inode)
 243 {
 244         d_instantiate(entry, inode);
 245         d_rehash(entry);
 246 }
 247
 248 /* used for rename() and baskets */
 249 extern void d_move(struct dentry *, struct dentry *);
 250
 251 /* appendix may either be NULL or be used for transname suffixes */
 252 extern struct dentry * d_lookup(struct dentry *, struct qstr *);
 253 extern struct dentry * __d_lookup(struct dentry *, struct qstr *);
 254
 255 /* validate "insecure" dentry pointer */
 256 extern int d_validate(struct dentry *, struct dentry *);
 257
 258 char * __d_path( struct dentry *dentry, struct vfsmount *vfsmnt,
 259                  struct dentry *root, struct vfsmount *rootmnt,
 260                  char *buffer, int buflen);
 261
 262 extern char * d_path(struct dentry *, struct vfsmount *, char *, int);
 263
 264 /* Allocation counts.. */
 265
 266 /**
 267  *      dget, dget_locked       -       get a reference to a dentry
 268  *      @dentry: dentry to get a reference to
 269  *
 270  *      Given a dentry or %NULL pointer increment the reference count
 271  *      if appropriate and return the dentry. A dentry will not be
 272  *      destroyed when it has references. dget() should never be
 273  *      called for dentries with zero reference counter. For these cases
 274  *      (preferably none, functions in dcache.c are sufficient for normal
 275  *      needs and they take necessary precautions) you should hold dcache_lock
 276  *      and call dget_locked() instead of dget().
 277  */
 278
 279 static inline struct dentry *dget(struct dentry *dentry)
 280 {
 281         if (dentry) {
 282                 BUG_ON(!atomic_read(&dentry->d_count));
 283                 atomic_inc(&dentry->d_count);
 284         }
 285         return dentry;
 286 }
 287
 288 extern struct dentry * dget_locked(struct dentry *);
 289
 290 /**
 291  *      d_unhashed -    is dentry hashed
 292  *      @dentry: entry to check
 293  *
 294  *      Returns true if the dentry passed is not currently hashed.
 295  */
 296
 297 static inline int d_unhashed(struct dentry *dentry)
 298 {
 299         return (dentry->d_flags & DCACHE_UNHASHED);
 300 }
 301
 302 static inline struct dentry *dget_parent(struct dentry *dentry)
 303 {
 304         struct dentry *ret;
 305
 306         spin_lock(&dentry->d_lock);
 307         ret = dget(dentry->d_parent);
 308         spin_unlock(&dentry->d_lock);
 309         return ret;
 310 }
 311
 312 extern void dput(struct dentry *);
 313
 314 static inline int d_mountpoint(struct dentry *dentry)
 315 {
 316         return dentry->d_mounted;
 317 }
 318
 319 extern struct vfsmount *lookup_mnt(struct vfsmount *, struct dentry *);
 320 extern struct dentry *lookup_create(struct nameidata *nd, int is_dir);
 321
 322 #endif /* __KERNEL__ */
 323
 324 #endif  /* __LINUX_DCACHE_H */