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-fsdef.c
  32  */
  33 extern struct fscache_cookie fscache_fsdef_index;
  34 extern struct fscache_cookie_def fscache_fsdef_netfs_def;
  35
  36 /*
  37  * fsc-histogram.c
  38  */
  39 #ifdef CONFIG_FSCACHE_HISTOGRAM
  40 extern atomic_t fscache_obj_instantiate_histogram[HZ];
  41 extern atomic_t fscache_objs_histogram[HZ];
  42 extern atomic_t fscache_ops_histogram[HZ];
  43 extern atomic_t fscache_retrieval_delay_histogram[HZ];
  44 extern atomic_t fscache_retrieval_histogram[HZ];
  45
  46 static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
  47 {
  48         unsigned long jif = jiffies - start_jif;
  49         if (jif >= HZ)
  50                 jif = HZ - 1;
  51         atomic_inc(&histogram[jif]);
  52 }
  53
  54 extern const struct file_operations fscache_histogram_fops;
  55
  56 #else
  57 #define fscache_hist(hist, start_jif) do {} while (0)
  58 #endif
  59
  60 /*
  61  * fsc-main.c
  62  */
  63 extern unsigned fscache_defer_lookup;
  64 extern unsigned fscache_defer_create;
  65 extern unsigned fscache_debug;
  66 extern struct kobject *fscache_root;
  67
  68 /*
  69  * fsc-proc.c
  70  */
  71 #ifdef CONFIG_PROC_FS
  72 extern int __init fscache_proc_init(void);
  73 extern void fscache_proc_cleanup(void);
  74 #else
  75 #define fscache_proc_init()     (0)
  76 #define fscache_proc_cleanup()  do {} while (0)
  77 #endif
  78
  79 /*
  80  * fsc-stats.c
  81  */
  82 #ifdef CONFIG_FSCACHE_STATS
  83 extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
  84 extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
  85
  86 extern atomic_t fscache_n_op_pend;
  87 extern atomic_t fscache_n_op_run;
  88 extern atomic_t fscache_n_op_enqueue;
  89 extern atomic_t fscache_n_op_deferred_release;
  90 extern atomic_t fscache_n_op_release;
  91 extern atomic_t fscache_n_op_gc;
  92
  93 extern atomic_t fscache_n_attr_changed;
  94 extern atomic_t fscache_n_attr_changed_ok;
  95 extern atomic_t fscache_n_attr_changed_nobufs;
  96 extern atomic_t fscache_n_attr_changed_nomem;
  97 extern atomic_t fscache_n_attr_changed_calls;
  98
  99 extern atomic_t fscache_n_allocs;
 100 extern atomic_t fscache_n_allocs_ok;
 101 extern atomic_t fscache_n_allocs_wait;
 102 extern atomic_t fscache_n_allocs_nobufs;
 103 extern atomic_t fscache_n_alloc_ops;
 104 extern atomic_t fscache_n_alloc_op_waits;
 105
 106 extern atomic_t fscache_n_retrievals;
 107 extern atomic_t fscache_n_retrievals_ok;
 108 extern atomic_t fscache_n_retrievals_wait;
 109 extern atomic_t fscache_n_retrievals_nodata;
 110 extern atomic_t fscache_n_retrievals_nobufs;
 111 extern atomic_t fscache_n_retrievals_intr;
 112 extern atomic_t fscache_n_retrievals_nomem;
 113 extern atomic_t fscache_n_retrieval_ops;
 114 extern atomic_t fscache_n_retrieval_op_waits;
 115
 116 extern atomic_t fscache_n_stores;
 117 extern atomic_t fscache_n_stores_ok;
 118 extern atomic_t fscache_n_stores_again;
 119 extern atomic_t fscache_n_stores_nobufs;
 120 extern atomic_t fscache_n_stores_oom;
 121 extern atomic_t fscache_n_store_ops;
 122 extern atomic_t fscache_n_store_calls;
 123
 124 extern atomic_t fscache_n_marks;
 125 extern atomic_t fscache_n_uncaches;
 126
 127 extern atomic_t fscache_n_acquires;
 128 extern atomic_t fscache_n_acquires_null;
 129 extern atomic_t fscache_n_acquires_no_cache;
 130 extern atomic_t fscache_n_acquires_ok;
 131 extern atomic_t fscache_n_acquires_nobufs;
 132 extern atomic_t fscache_n_acquires_oom;
 133
 134 extern atomic_t fscache_n_updates;
 135 extern atomic_t fscache_n_updates_null;
 136 extern atomic_t fscache_n_updates_run;
 137
 138 extern atomic_t fscache_n_relinquishes;
 139 extern atomic_t fscache_n_relinquishes_null;
 140 extern atomic_t fscache_n_relinquishes_waitcrt;
 141
 142 extern atomic_t fscache_n_cookie_index;
 143 extern atomic_t fscache_n_cookie_data;
 144 extern atomic_t fscache_n_cookie_special;
 145
 146 extern atomic_t fscache_n_object_alloc;
 147 extern atomic_t fscache_n_object_no_alloc;
 148 extern atomic_t fscache_n_object_lookups;
 149 extern atomic_t fscache_n_object_lookups_negative;
 150 extern atomic_t fscache_n_object_lookups_positive;
 151 extern atomic_t fscache_n_object_created;
 152 extern atomic_t fscache_n_object_avail;
 153 extern atomic_t fscache_n_object_dead;
 154
 155 extern atomic_t fscache_n_checkaux_none;
 156 extern atomic_t fscache_n_checkaux_okay;
 157 extern atomic_t fscache_n_checkaux_update;
 158 extern atomic_t fscache_n_checkaux_obsolete;
 159
 160 static inline void fscache_stat(atomic_t *stat)
 161 {
 162         atomic_inc(stat);
 163 }
 164
 165 extern const struct file_operations fscache_stats_fops;
 166 #else
 167
 168 #define fscache_stat(stat) do {} while (0)
 169 #endif
 170
 171 /*****************************************************************************/
 172 /*
 173  * debug tracing
 174  */
 175 #define dbgprintk(FMT, ...) \
 176         printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
 177
 178 /* make sure we maintain the format strings, even when debugging is disabled */
 179 static inline __attribute__((format(printf, 1, 2)))
 180 void _dbprintk(const char *fmt, ...)
 181 {
 182 }
 183
 184 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
 185 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
 186 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
 187
 188 #define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
 189
 190 #ifdef __KDEBUG
 191 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
 192 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
 193 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
 194
 195 #elif defined(CONFIG_FSCACHE_DEBUG)
 196 #define _enter(FMT, ...)                        \
 197 do {                                            \
 198         if (__do_kdebug(ENTER))                 \
 199                 kenter(FMT, ##__VA_ARGS__);     \
 200 } while (0)
 201
 202 #define _leave(FMT, ...)                        \
 203 do {                                            \
 204         if (__do_kdebug(LEAVE))                 \
 205                 kleave(FMT, ##__VA_ARGS__);     \
 206 } while (0)
 207
 208 #define _debug(FMT, ...)                        \
 209 do {                                            \
 210         if (__do_kdebug(DEBUG))                 \
 211                 kdebug(FMT, ##__VA_ARGS__);     \
 212 } while (0)
 213
 214 #else
 215 #define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
 216 #define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
 217 #define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
 218 #endif
 219
 220 /*
 221  * determine whether a particular optional debugging point should be logged
 222  * - we need to go through three steps to persuade cpp to correctly join the
 223  *   shorthand in FSCACHE_DEBUG_LEVEL with its prefix
 224  */
 225 #define ____do_kdebug(LEVEL, POINT) \
 226         unlikely((fscache_debug & \
 227                   (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
 228 #define ___do_kdebug(LEVEL, POINT) \
 229         ____do_kdebug(LEVEL, POINT)
 230 #define __do_kdebug(POINT) \
 231         ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
 232
 233 #define FSCACHE_DEBUG_CACHE     0
 234 #define FSCACHE_DEBUG_COOKIE    1
 235 #define FSCACHE_DEBUG_PAGE      2
 236 #define FSCACHE_DEBUG_OPERATION 3
 237
 238 #define FSCACHE_POINT_ENTER     1
 239 #define FSCACHE_POINT_LEAVE     2
 240 #define FSCACHE_POINT_DEBUG     4
 241
 242 #ifndef FSCACHE_DEBUG_LEVEL
 243 #define FSCACHE_DEBUG_LEVEL CACHE
 244 #endif
 245
 246 /*
 247  * assertions
 248  */
 249 #if 1 /* defined(__KDEBUGALL) */
 250
 251 #define ASSERT(X)                                                       \
 252 do {                                                                    \
 253         if (unlikely(!(X))) {                                           \
 254                 printk(KERN_ERR "\n");                                  \
 255                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 256                 BUG();                                                  \
 257         }                                                               \
 258 } while (0)
 259
 260 #define ASSERTCMP(X, OP, Y)                                             \
 261 do {                                                                    \
 262         if (unlikely(!((X) OP (Y)))) {                                  \
 263                 printk(KERN_ERR "\n");                                  \
 264                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 265                 printk(KERN_ERR "%lx " #OP " %lx is false\n",           \
 266                        (unsigned long)(X), (unsigned long)(Y));         \
 267                 BUG();                                                  \
 268         }                                                               \
 269 } while (0)
 270
 271 #define ASSERTIF(C, X)                                                  \
 272 do {                                                                    \
 273         if (unlikely((C) && !(X))) {                                    \
 274                 printk(KERN_ERR "\n");                                  \
 275                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 276                 BUG();                                                  \
 277         }                                                               \
 278 } while (0)
 279
 280 #define ASSERTIFCMP(C, X, OP, Y)                                        \
 281 do {                                                                    \
 282         if (unlikely((C) && !((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 #else
 292
 293 #define ASSERT(X)                       do {} while (0)
 294 #define ASSERTCMP(X, OP, Y)             do {} while (0)
 295 #define ASSERTIF(C, X)                  do {} while (0)
 296 #define ASSERTIFCMP(C, X, OP, Y)        do {} while (0)
 297
 298 #endif /* assert or not */