fs/fscache/internal.h

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