Pileus Git - ~andy/linux/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  * - cookie->stores_lock
  21  * - fscache_thread_lock
  22  *
  23  */
  24
  25 #include <linux/fscache-cache.h>
  26 #include <linux/sched.h>
  27
  28 #define FSCACHE_MIN_THREADS     4
  29 #define FSCACHE_MAX_THREADS     32
  30
  31 /*
  32  * cache.c
  33  */
  34 extern struct list_head fscache_cache_list;
  35 extern struct rw_semaphore fscache_addremove_sem;
  36
  37 extern struct fscache_cache *fscache_select_cache_for_object(
  38         struct fscache_cookie *);
  39
  40 /*
  41  * cookie.c
  42  */
  43 extern struct kmem_cache *fscache_cookie_jar;
  44
  45 extern void fscache_cookie_init_once(void *);
  46 extern void __fscache_cookie_put(struct fscache_cookie *);
  47
  48 /*
  49  * fsdef.c
  50  */
  51 extern struct fscache_cookie fscache_fsdef_index;
  52 extern struct fscache_cookie_def fscache_fsdef_netfs_def;
  53
  54 /*
  55  * histogram.c
  56  */
  57 #ifdef CONFIG_FSCACHE_HISTOGRAM
  58 extern atomic_t fscache_obj_instantiate_histogram[HZ];
  59 extern atomic_t fscache_objs_histogram[HZ];
  60 extern atomic_t fscache_ops_histogram[HZ];
  61 extern atomic_t fscache_retrieval_delay_histogram[HZ];
  62 extern atomic_t fscache_retrieval_histogram[HZ];
  63
  64 static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
  65 {
  66         unsigned long jif = jiffies - start_jif;
  67         if (jif >= HZ)
  68                 jif = HZ - 1;
  69         atomic_inc(&histogram[jif]);
  70 }
  71
  72 extern const struct file_operations fscache_histogram_fops;
  73
  74 #else
  75 #define fscache_hist(hist, start_jif) do {} while (0)
  76 #endif
  77
  78 /*
  79  * main.c
  80  */
  81 extern unsigned fscache_defer_lookup;
  82 extern unsigned fscache_defer_create;
  83 extern unsigned fscache_debug;
  84 extern struct kobject *fscache_root;
  85 extern struct workqueue_struct *fscache_object_wq;
  86 DECLARE_PER_CPU(wait_queue_head_t, fscache_object_cong_wait);
  87
  88 static inline bool fscache_object_congested(void)
  89 {
  90         return workqueue_congested(WORK_CPU_UNBOUND, fscache_object_wq);
  91 }
  92
  93 extern int fscache_wait_bit(void *);
  94 extern int fscache_wait_bit_interruptible(void *);
  95
  96 /*
  97  * object.c
  98  */
  99 extern const char fscache_object_states_short[FSCACHE_OBJECT__NSTATES][5];
 100
 101 extern void fscache_withdrawing_object(struct fscache_cache *,
 102                                        struct fscache_object *);
 103 extern void fscache_enqueue_object(struct fscache_object *);
 104
 105 /*
 106  * object-list.c
 107  */
 108 #ifdef CONFIG_FSCACHE_OBJECT_LIST
 109 extern const struct file_operations fscache_objlist_fops;
 110
 111 extern void fscache_objlist_add(struct fscache_object *);
 112 #else
 113 #define fscache_objlist_add(object) do {} while(0)
 114 #endif
 115
 116 /*
 117  * operation.c
 118  */
 119 extern int fscache_submit_exclusive_op(struct fscache_object *,
 120                                        struct fscache_operation *);
 121 extern int fscache_submit_op(struct fscache_object *,
 122                              struct fscache_operation *);
 123 extern int fscache_cancel_op(struct fscache_operation *);
 124 extern void fscache_abort_object(struct fscache_object *);
 125 extern void fscache_start_operations(struct fscache_object *);
 126 extern void fscache_operation_gc(struct work_struct *);
 127
 128 /*
 129  * proc.c
 130  */
 131 #ifdef CONFIG_PROC_FS
 132 extern int __init fscache_proc_init(void);
 133 extern void fscache_proc_cleanup(void);
 134 #else
 135 #define fscache_proc_init()     (0)
 136 #define fscache_proc_cleanup()  do {} while (0)
 137 #endif
 138
 139 /*
 140  * stats.c
 141  */
 142 #ifdef CONFIG_FSCACHE_STATS
 143 extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
 144 extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
 145
 146 extern atomic_t fscache_n_op_pend;
 147 extern atomic_t fscache_n_op_run;
 148 extern atomic_t fscache_n_op_enqueue;
 149 extern atomic_t fscache_n_op_deferred_release;
 150 extern atomic_t fscache_n_op_release;
 151 extern atomic_t fscache_n_op_gc;
 152 extern atomic_t fscache_n_op_cancelled;
 153 extern atomic_t fscache_n_op_rejected;
 154
 155 extern atomic_t fscache_n_attr_changed;
 156 extern atomic_t fscache_n_attr_changed_ok;
 157 extern atomic_t fscache_n_attr_changed_nobufs;
 158 extern atomic_t fscache_n_attr_changed_nomem;
 159 extern atomic_t fscache_n_attr_changed_calls;
 160
 161 extern atomic_t fscache_n_allocs;
 162 extern atomic_t fscache_n_allocs_ok;
 163 extern atomic_t fscache_n_allocs_wait;
 164 extern atomic_t fscache_n_allocs_nobufs;
 165 extern atomic_t fscache_n_allocs_intr;
 166 extern atomic_t fscache_n_allocs_object_dead;
 167 extern atomic_t fscache_n_alloc_ops;
 168 extern atomic_t fscache_n_alloc_op_waits;
 169
 170 extern atomic_t fscache_n_retrievals;
 171 extern atomic_t fscache_n_retrievals_ok;
 172 extern atomic_t fscache_n_retrievals_wait;
 173 extern atomic_t fscache_n_retrievals_nodata;
 174 extern atomic_t fscache_n_retrievals_nobufs;
 175 extern atomic_t fscache_n_retrievals_intr;
 176 extern atomic_t fscache_n_retrievals_nomem;
 177 extern atomic_t fscache_n_retrievals_object_dead;
 178 extern atomic_t fscache_n_retrieval_ops;
 179 extern atomic_t fscache_n_retrieval_op_waits;
 180
 181 extern atomic_t fscache_n_stores;
 182 extern atomic_t fscache_n_stores_ok;
 183 extern atomic_t fscache_n_stores_again;
 184 extern atomic_t fscache_n_stores_nobufs;
 185 extern atomic_t fscache_n_stores_oom;
 186 extern atomic_t fscache_n_store_ops;
 187 extern atomic_t fscache_n_store_calls;
 188 extern atomic_t fscache_n_store_pages;
 189 extern atomic_t fscache_n_store_radix_deletes;
 190 extern atomic_t fscache_n_store_pages_over_limit;
 191
 192 extern atomic_t fscache_n_store_vmscan_not_storing;
 193 extern atomic_t fscache_n_store_vmscan_gone;
 194 extern atomic_t fscache_n_store_vmscan_busy;
 195 extern atomic_t fscache_n_store_vmscan_cancelled;
 196
 197 extern atomic_t fscache_n_marks;
 198 extern atomic_t fscache_n_uncaches;
 199
 200 extern atomic_t fscache_n_acquires;
 201 extern atomic_t fscache_n_acquires_null;
 202 extern atomic_t fscache_n_acquires_no_cache;
 203 extern atomic_t fscache_n_acquires_ok;
 204 extern atomic_t fscache_n_acquires_nobufs;
 205 extern atomic_t fscache_n_acquires_oom;
 206
 207 extern atomic_t fscache_n_updates;
 208 extern atomic_t fscache_n_updates_null;
 209 extern atomic_t fscache_n_updates_run;
 210
 211 extern atomic_t fscache_n_relinquishes;
 212 extern atomic_t fscache_n_relinquishes_null;
 213 extern atomic_t fscache_n_relinquishes_waitcrt;
 214 extern atomic_t fscache_n_relinquishes_retire;
 215
 216 extern atomic_t fscache_n_cookie_index;
 217 extern atomic_t fscache_n_cookie_data;
 218 extern atomic_t fscache_n_cookie_special;
 219
 220 extern atomic_t fscache_n_object_alloc;
 221 extern atomic_t fscache_n_object_no_alloc;
 222 extern atomic_t fscache_n_object_lookups;
 223 extern atomic_t fscache_n_object_lookups_negative;
 224 extern atomic_t fscache_n_object_lookups_positive;
 225 extern atomic_t fscache_n_object_lookups_timed_out;
 226 extern atomic_t fscache_n_object_created;
 227 extern atomic_t fscache_n_object_avail;
 228 extern atomic_t fscache_n_object_dead;
 229
 230 extern atomic_t fscache_n_checkaux_none;
 231 extern atomic_t fscache_n_checkaux_okay;
 232 extern atomic_t fscache_n_checkaux_update;
 233 extern atomic_t fscache_n_checkaux_obsolete;
 234
 235 extern atomic_t fscache_n_cop_alloc_object;
 236 extern atomic_t fscache_n_cop_lookup_object;
 237 extern atomic_t fscache_n_cop_lookup_complete;
 238 extern atomic_t fscache_n_cop_grab_object;
 239 extern atomic_t fscache_n_cop_update_object;
 240 extern atomic_t fscache_n_cop_drop_object;
 241 extern atomic_t fscache_n_cop_put_object;
 242 extern atomic_t fscache_n_cop_sync_cache;
 243 extern atomic_t fscache_n_cop_attr_changed;
 244 extern atomic_t fscache_n_cop_read_or_alloc_page;
 245 extern atomic_t fscache_n_cop_read_or_alloc_pages;
 246 extern atomic_t fscache_n_cop_allocate_page;
 247 extern atomic_t fscache_n_cop_allocate_pages;
 248 extern atomic_t fscache_n_cop_write_page;
 249 extern atomic_t fscache_n_cop_uncache_page;
 250 extern atomic_t fscache_n_cop_dissociate_pages;
 251
 252 static inline void fscache_stat(atomic_t *stat)
 253 {
 254         atomic_inc(stat);
 255 }
 256
 257 static inline void fscache_stat_d(atomic_t *stat)
 258 {
 259         atomic_dec(stat);
 260 }
 261
 262 #define __fscache_stat(stat) (stat)
 263
 264 extern const struct file_operations fscache_stats_fops;
 265 #else
 266
 267 #define __fscache_stat(stat) (NULL)
 268 #define fscache_stat(stat) do {} while (0)
 269 #define fscache_stat_d(stat) do {} while (0)
 270 #endif
 271
 272 /*
 273  * raise an event on an object
 274  * - if the event is not masked for that object, then the object is
 275  *   queued for attention by the thread pool.
 276  */
 277 static inline void fscache_raise_event(struct fscache_object *object,
 278                                        unsigned event)
 279 {
 280         if (!test_and_set_bit(event, &object->events) &&
 281             test_bit(event, &object->event_mask))
 282                 fscache_enqueue_object(object);
 283 }
 284
 285 /*
 286  * drop a reference to a cookie
 287  */
 288 static inline void fscache_cookie_put(struct fscache_cookie *cookie)
 289 {
 290         BUG_ON(atomic_read(&cookie->usage) <= 0);
 291         if (atomic_dec_and_test(&cookie->usage))
 292                 __fscache_cookie_put(cookie);
 293 }
 294
 295 /*
 296  * get an extra reference to a netfs retrieval context
 297  */
 298 static inline
 299 void *fscache_get_context(struct fscache_cookie *cookie, void *context)
 300 {
 301         if (cookie->def->get_context)
 302                 cookie->def->get_context(cookie->netfs_data, context);
 303         return context;
 304 }
 305
 306 /*
 307  * release a reference to a netfs retrieval context
 308  */
 309 static inline
 310 void fscache_put_context(struct fscache_cookie *cookie, void *context)
 311 {
 312         if (cookie->def->put_context)
 313                 cookie->def->put_context(cookie->netfs_data, context);
 314 }
 315
 316 /*****************************************************************************/
 317 /*
 318  * debug tracing
 319  */
 320 #define dbgprintk(FMT, ...) \
 321         printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
 322
 323 /* make sure we maintain the format strings, even when debugging is disabled */
 324 static inline __attribute__((format(printf, 1, 2)))
 325 void _dbprintk(const char *fmt, ...)
 326 {
 327 }
 328
 329 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
 330 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
 331 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
 332
 333 #define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
 334
 335 #ifdef __KDEBUG
 336 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
 337 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
 338 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
 339
 340 #elif defined(CONFIG_FSCACHE_DEBUG)
 341 #define _enter(FMT, ...)                        \
 342 do {                                            \
 343         if (__do_kdebug(ENTER))                 \
 344                 kenter(FMT, ##__VA_ARGS__);     \
 345 } while (0)
 346
 347 #define _leave(FMT, ...)                        \
 348 do {                                            \
 349         if (__do_kdebug(LEAVE))                 \
 350                 kleave(FMT, ##__VA_ARGS__);     \
 351 } while (0)
 352
 353 #define _debug(FMT, ...)                        \
 354 do {                                            \
 355         if (__do_kdebug(DEBUG))                 \
 356                 kdebug(FMT, ##__VA_ARGS__);     \
 357 } while (0)
 358
 359 #else
 360 #define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
 361 #define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
 362 #define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
 363 #endif
 364
 365 /*
 366  * determine whether a particular optional debugging point should be logged
 367  * - we need to go through three steps to persuade cpp to correctly join the
 368  *   shorthand in FSCACHE_DEBUG_LEVEL with its prefix
 369  */
 370 #define ____do_kdebug(LEVEL, POINT) \
 371         unlikely((fscache_debug & \
 372                   (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
 373 #define ___do_kdebug(LEVEL, POINT) \
 374         ____do_kdebug(LEVEL, POINT)
 375 #define __do_kdebug(POINT) \
 376         ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
 377
 378 #define FSCACHE_DEBUG_CACHE     0
 379 #define FSCACHE_DEBUG_COOKIE    1
 380 #define FSCACHE_DEBUG_PAGE      2
 381 #define FSCACHE_DEBUG_OPERATION 3
 382
 383 #define FSCACHE_POINT_ENTER     1
 384 #define FSCACHE_POINT_LEAVE     2
 385 #define FSCACHE_POINT_DEBUG     4
 386
 387 #ifndef FSCACHE_DEBUG_LEVEL
 388 #define FSCACHE_DEBUG_LEVEL CACHE
 389 #endif
 390
 391 /*
 392  * assertions
 393  */
 394 #if 1 /* defined(__KDEBUGALL) */
 395
 396 #define ASSERT(X)                                                       \
 397 do {                                                                    \
 398         if (unlikely(!(X))) {                                           \
 399                 printk(KERN_ERR "\n");                                  \
 400                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 401                 BUG();                                                  \
 402         }                                                               \
 403 } while (0)
 404
 405 #define ASSERTCMP(X, OP, Y)                                             \
 406 do {                                                                    \
 407         if (unlikely(!((X) OP (Y)))) {                                  \
 408                 printk(KERN_ERR "\n");                                  \
 409                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 410                 printk(KERN_ERR "%lx " #OP " %lx is false\n",           \
 411                        (unsigned long)(X), (unsigned long)(Y));         \
 412                 BUG();                                                  \
 413         }                                                               \
 414 } while (0)
 415
 416 #define ASSERTIF(C, X)                                                  \
 417 do {                                                                    \
 418         if (unlikely((C) && !(X))) {                                    \
 419                 printk(KERN_ERR "\n");                                  \
 420                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 421                 BUG();                                                  \
 422         }                                                               \
 423 } while (0)
 424
 425 #define ASSERTIFCMP(C, X, OP, Y)                                        \
 426 do {                                                                    \
 427         if (unlikely((C) && !((X) OP (Y)))) {                           \
 428                 printk(KERN_ERR "\n");                                  \
 429                 printk(KERN_ERR "FS-Cache: Assertion failed\n");        \
 430                 printk(KERN_ERR "%lx " #OP " %lx is false\n",           \
 431                        (unsigned long)(X), (unsigned long)(Y));         \
 432                 BUG();                                                  \
 433         }                                                               \
 434 } while (0)
 435
 436 #else
 437
 438 #define ASSERT(X)                       do {} while (0)
 439 #define ASSERTCMP(X, OP, Y)             do {} while (0)
 440 #define ASSERTIF(C, X)                  do {} while (0)
 441 #define ASSERTIFCMP(C, X, OP, Y)        do {} while (0)
 442
 443 #endif /* assert or not */