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