SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/fscache/internal.h

   1 /* Internal definitions for FS-Cache
   2  *
   3  * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 /*
  13  * Lock order, in the order in which multiple locks should be obtained:
  14  * - fscache_addremove_sem
  15  * - cookie->lock
  16  * - cookie->parent->lock
  17  * - cache->object_list_lock
  18  * - object->lock
  19  * - object->parent->lock
  20  * - fscache_thread_lock
  21  *
  22  */
  23
  24 #include <linux/fscache-cache.h>
  25 #include <linux/sched.h>
  26
  27 #define FSCACHE_MIN_THREADS     4
  28 #define FSCACHE_MAX_THREADS     32
  29
  30 /*
  31  * fsc-cache.c
  32  */
  33 extern struct list_head fscache_cache_list;
  34 extern struct rw_semaphore fscache_addremove_sem;
  35
  36 extern struct fscache_cache *fscache_select_cache_for_object(
  37         struct fscache_cookie *);
  38
  39 /*
  40  * fsc-fsdef.c
  41  */
  42 extern struct fscache_cookie fscache_fsdef_index;
  43 extern struct fscache_cookie_def fscache_fsdef_netfs_def;
  44
  45 /*
  46  * fsc-histogram.c
  47  */
  48 #ifdef CONFIG_FSCACHE_HISTOGRAM
  49 extern atomic_t fscache_obj_instantiate_histogram[HZ];
  50 extern atomic_t fscache_objs_histogram[HZ];
  51 extern atomic_t fscache_ops_histogram[HZ];
  52 extern atomic_t fscache_retrieval_delay_histogram[HZ];
  53 extern atomic_t fscache_retrieval_histogram[HZ];
  54
  55 static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
  56 {
  57         unsigned long jif = jiffies - start_jif;
  58         if (jif >= HZ)
  59                 jif = HZ - 1;
  60         atomic_inc(&histogram[jif]);
  61 }
  62
  63 extern const struct file_operations fscache_histogram_fops;
  64
  65 #else
  66 #define fscache_hist(hist, start_jif) do {} while (0)
  67 #endif
  68
  69 /*
  70  * fsc-main.c
  71  */
  72 extern unsigned fscache_defer_lookup;
  73 extern unsigned fscache_defer_create;
  74 extern unsigned fscache_debug;
  75 extern struct kobject *fscache_root;
  76
  77 /*
  78  * fsc-proc.c
  79  */
  80 #ifdef CONFIG_PROC_FS
  81 extern int __init fscache_proc_init(void);
  82 extern void fscache_proc_cleanup(void);
  83 #else
  84 #define fscache_proc_init()     (0)
  85 #define fscache_proc_cleanup()  do {} while (0)
  86 #endif
  87
  88 /*
  89  * fsc-stats.c
  90  */
  91 #ifdef CONFIG_FSCACHE_STATS
  92 extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
  93 extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
  94
  95 extern atomic_t fscache_n_op_pend;
  96 extern atomic_t fscache_n_op_run;
  97 extern atomic_t fscache_n_op_enqueue;
  98 extern atomic_t fscache_n_op_deferred_release;
  99 extern atomic_t fscache_n_op_release;
 100 extern atomic_t fscache_n_op_gc;
 101
 102 extern atomic_t fscache_n_attr_changed;
 103 extern atomic_t fscache_n_attr_changed_ok;
 104 extern atomic_t fscache_n_attr_changed_nobufs;
 105 extern atomic_t fscache_n_attr_changed_nomem;
 106 extern atomic_t fscache_n_attr_changed_calls;
 107
 108 extern atomic_t fscache_n_allocs;
 109 extern atomic_t fscache_n_allocs_ok;
 110 extern atomic_t fscache_n_allocs_wait;
 111 extern atomic_t fscache_n_allocs_nobufs;
 112 extern atomic_t fscache_n_alloc_ops;
 113 extern atomic_t fscache_n_alloc_op_waits;
 114
 115 extern atomic_t fscache_n_retrievals;
 116 extern atomic_t fscache_n_retrievals_ok;
 117 extern atomic_t fscache_n_retrievals_wait;
 118 extern atomic_t fscache_n_retrievals_nodata;
 119 extern atomic_t fscache_n_retrievals_nobufs;
 120 extern atomic_t fscache_n_retrievals_intr;
 121 extern atomic_t fscache_n_retrievals_nomem;
 122 extern atomic_t fscache_n_retrieval_ops;
 123 extern atomic_t fscache_n_retrieval_op_waits;
 124
 125 extern atomic_t fscache_n_stores;
 126 extern atomic_t fscache_n_stores_ok;
 127 extern atomic_t fscache_n_stores_again;
 128 extern atomic_t fscache_n_stores_nobufs;
 129 extern atomic_t fscache_n_stores_oom;
 130 extern atomic_t fscache_n_store_ops;
 131 extern atomic_t fscache_n_store_calls;
 132
 133 extern atomic_t fscache_n_marks;
 134 extern atomic_t fscache_n_uncaches;
 135
 136 extern atomic_t fscache_n_acquires;
 137 extern atomic_t fscache_n_acquires_null;
 138 extern atomic_t fscache_n_acquires_no_cache;
 139 extern atomic_t fscache_n_acquires_ok;
 140 extern atomic_t fscache_n_acquires_nobufs;
 141 extern atomic_t fscache_n_acquires_oom;
 142
 143 extern atomic_t fscache_n_updates;
 144 extern atomic_t fscache_n_updates_null;
 145 extern atomic_t fscache_n_updates_run;
 146
 147 extern atomic_t fscache_n_relinquishes;
 148 extern atomic_t fscache_n_relinquishes_null;
 149 extern atomic_t fscache_n_relinquishes_waitcrt;
 150
 151 extern atomic_t fscache_n_cookie_index;
 152 extern atomic_t fscache_n_cookie_data;
 153 extern atomic_t fscache_n_cookie_special;
 154
 155 extern atomic_t fscache_n_object_alloc;
 156 extern atomic_t fscache_n_object_no_alloc;
 157 extern atomic_t fscache_n_object_lookups;
 158 extern atomic_t fscache_n_object_lookups_negative;
 159 extern atomic_t fscache_n_object_lookups_positive;
 160 extern atomic_t fscache_n_object_created;
 161 extern atomic_t fscache_n_object_avail;
 162 extern atomic_t fscache_n_object_dead;
 163
 164 extern atomic_t fscache_n_checkaux_none;
 165 extern atomic_t fscache_n_checkaux_okay;
 166 extern atomic_t fscache_n_checkaux_update;
 167 extern atomic_t fscache_n_checkaux_obsolete;
 168
 169 static inline void fscache_stat(atomic_t *stat)
 170 {
 171         atomic_inc(stat);
 172 }
 173
 174 extern const struct file_operations fscache_stats_fops;
 175 #else
 176
 177 #define fscache_stat(stat) do {} while (0)
 178 #endif
 179
 180 /*
 181  * raise an event on an object
 182  * - if the event is not masked for that object, then the object is
 183  *   queued for attention by the thread pool.
 184  */
 185 static inline void fscache_raise_event(struct fscache_object *object,
 186                                        unsigned event)
 187 {
 188         BUG();  // TODO
 189 }
 190
 191 /*****************************************************************************/
 192 /*
 193  * debug tracing
 194  */
 195 #define dbgprintk(FMT, ...) \
 196         printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
 197
 198 /* make sure we maintain the format strings, even when debugging is disabled */
 199 static inline __attribute__((format(printf, 1, 2)))
 200 void _dbprintk(const char *fmt, ...)
 201 {
 202 }
 203
 204 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
 205 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
 206 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
 207
 208 #define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
 209
 210 #ifdef __KDEBUG
 211 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
 212 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
 213 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
 214
 215 #elif defined(CONFIG_FSCACHE_DEBUG)
 216 #define _enter(FMT, ...)                        \
 217 do {                                            \
 218         if (__do_kdebug(ENTER))                 \
 219                 kenter(FMT, ##__VA_ARGS__);     \
 220 } while (0)
 221
 222 #define _leave(FMT, ...)                        \
 223 do {                                            \
 224         if (__do_kdebug(LEAVE))                 \
 225                 kleave(FMT, ##__VA_ARGS__);     \
 226 } while (0)
 227
 228 #define _debug(FMT, ...)                        \
 229 do {                                            \
 230         if (__do_kdebug(DEBUG))                 \
 231                 kdebug(FMT, ##__VA_ARGS__);     \
 232 } while (0)
 233
 234 #else
 235 #define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
 236 #define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
 237 #define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
 238 #endif
 239
 240 /*
 241  * determine whether a particular optional debugging point should be logged
 242  * - we need to go through three steps to persuade cpp to correctly join the
 243  *   shorthand in FSCACHE_DEBUG_LEVEL with its prefix
 244  */
 245 #define ____do_kdebug(LEVEL, POINT) \
 246         unlikely((fscache_debug & \
 247                   (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
 248 #define ___do_kdebug(LEVEL, POINT) \
 249         ____do_kdebug(LEVEL, POINT)
 250 #define __do_kdebug(POINT) \
 251         ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
 252
 253 #define FSCACHE_DEBUG_CACHE     0
 254 #define FSCACHE_DEBUG_COOKIE    1
 255 #define FSCACHE_DEBUG_PAGE      2
 256 #define FSCACHE_DEBUG_OPERATION 3
 257
 258 #define FSCACHE_POINT_ENTER     1
 259 #define FSCACHE_POINT_LEAVE     2
 260 #define FSCACHE_POINT_DEBUG     4
 261
 262 #ifndef FSCACHE_DEBUG_LEVEL
 263 #define FSCACHE_DEBUG_LEVEL CACHE
 264 #endif
 265
 266 /*
 267  * assertions
 268  */
 269 #if 1 /* defined(__KDEBUGALL) */
 270
 271 #define ASSERT(X)                                                       \
 272 do {                                                                    \
 273         if (unlikely(!(X))) {                                           \
 274                 printk(KERN_ERR "\n");                                  \
 275                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 276                 BUG();                                                  \
 277         }                                                               \
 278 } while (0)
 279
 280 #define ASSERTCMP(X, OP, Y)                                             \
 281 do {                                                                    \
 282         if (unlikely(!((X) OP (Y)))) {                                  \
 283                 printk(KERN_ERR "\n");                                  \
 284                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 285                 printk(KERN_ERR "%lx " #OP " %lx is false\n",           \
 286                        (unsigned long)(X), (unsigned long)(Y));         \
 287                 BUG();                                                  \
 288         }                                                               \
 289 } while (0)
 290
 291 #define ASSERTIF(C, X)                                                  \
 292 do {                                                                    \
 293         if (unlikely((C) && !(X))) {                                    \
 294                 printk(KERN_ERR "\n");                                  \
 295                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 296                 BUG();                                                  \
 297         }                                                               \
 298 } while (0)
 299
 300 #define ASSERTIFCMP(C, X, OP, Y)                                        \
 301 do {                                                                    \
 302         if (unlikely((C) && !((X) OP (Y)))) {                           \
 303                 printk(KERN_ERR "\n");                                  \
 304                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 305                 printk(KERN_ERR "%lx " #OP " %lx is false\n",           \
 306                        (unsigned long)(X), (unsigned long)(Y));         \
 307                 BUG();                                                  \
 308         }                                                               \
 309 } while (0)
 310
 311 #else
 312
 313 #define ASSERT(X)                       do {} while (0)
 314 #define ASSERTCMP(X, OP, Y)             do {} while (0)
 315 #define ASSERTIF(C, X)                  do {} while (0)
 316 #define ASSERTIFCMP(C, X, OP, Y)        do {} while (0)
 317
 318 #endif /* assert or not */