include/linux/fscache-cache.h

   1 /* General filesystem caching backing cache interface
   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  * NOTE!!! See:
  12  *
  13  *      Documentation/filesystems/caching/backend-api.txt
  14  *
  15  * for a description of the cache backend interface declared here.
  16  */
  17
  18 #ifndef _LINUX_FSCACHE_CACHE_H
  19 #define _LINUX_FSCACHE_CACHE_H
  20
  21 #include <linux/fscache.h>
  22 #include <linux/sched.h>
  23 #include <linux/workqueue.h>
  24
  25 #define NR_MAXCACHES BITS_PER_LONG
  26
  27 struct fscache_cache;
  28 struct fscache_cache_ops;
  29 struct fscache_object;
  30 struct fscache_operation;
  31
  32 /*
  33  * cache tag definition
  34  */
  35 struct fscache_cache_tag {
  36         struct list_head        link;
  37         struct fscache_cache    *cache;         /* cache referred to by this tag */
  38         unsigned long           flags;
  39 #define FSCACHE_TAG_RESERVED    0               /* T if tag is reserved for a cache */
  40         atomic_t                usage;
  41         char                    name[0];        /* tag name */
  42 };
  43
  44 /*
  45  * cache definition
  46  */
  47 struct fscache_cache {
  48         const struct fscache_cache_ops *ops;
  49         struct fscache_cache_tag *tag;          /* tag representing this cache */
  50         struct kobject          *kobj;          /* system representation of this cache */
  51         struct list_head        link;           /* link in list of caches */
  52         size_t                  max_index_size; /* maximum size of index data */
  53         char                    identifier[36]; /* cache label */
  54
  55         /* node management */
  56         struct work_struct      op_gc;          /* operation garbage collector */
  57         struct list_head        object_list;    /* list of data/index objects */
  58         struct list_head        op_gc_list;     /* list of ops to be deleted */
  59         spinlock_t              object_list_lock;
  60         spinlock_t              op_gc_list_lock;
  61         atomic_t                object_count;   /* no. of live objects in this cache */
  62         struct fscache_object   *fsdef;         /* object for the fsdef index */
  63         unsigned long           flags;
  64 #define FSCACHE_IOERROR         0       /* cache stopped on I/O error */
  65 #define FSCACHE_CACHE_WITHDRAWN 1       /* cache has been withdrawn */
  66 };
  67
  68 extern wait_queue_head_t fscache_cache_cleared_wq;
  69
  70 /*
  71  * operation to be applied to a cache object
  72  * - retrieval initiation operations are done in the context of the process
  73  *   that issued them, and not in an async thread pool
  74  */
  75 typedef void (*fscache_operation_release_t)(struct fscache_operation *op);
  76 typedef void (*fscache_operation_processor_t)(struct fscache_operation *op);
  77
  78 enum fscache_operation_state {
  79         FSCACHE_OP_ST_BLANK,            /* Op is not yet submitted */
  80         FSCACHE_OP_ST_INITIALISED,      /* Op is initialised */
  81         FSCACHE_OP_ST_PENDING,          /* Op is blocked from running */
  82         FSCACHE_OP_ST_IN_PROGRESS,      /* Op is in progress */
  83         FSCACHE_OP_ST_COMPLETE,         /* Op is complete */
  84         FSCACHE_OP_ST_CANCELLED,        /* Op has been cancelled */
  85         FSCACHE_OP_ST_DEAD              /* Op is now dead */
  86 };
  87
  88 struct fscache_operation {
  89         struct work_struct      work;           /* record for async ops */
  90         struct list_head        pend_link;      /* link in object->pending_ops */
  91         struct fscache_object   *object;        /* object to be operated upon */
  92
  93         unsigned long           flags;
  94 #define FSCACHE_OP_TYPE         0x000f  /* operation type */
  95 #define FSCACHE_OP_ASYNC        0x0001  /* - async op, processor may sleep for disk */
  96 #define FSCACHE_OP_MYTHREAD     0x0002  /* - processing is done be issuing thread, not pool */
  97 #define FSCACHE_OP_WAITING      4       /* cleared when op is woken */
  98 #define FSCACHE_OP_EXCLUSIVE    5       /* exclusive op, other ops must wait */
  99 #define FSCACHE_OP_DEC_READ_CNT 6       /* decrement object->n_reads on destruction */
 100 #define FSCACHE_OP_UNUSE_COOKIE 7       /* call fscache_unuse_cookie() on completion */
 101 #define FSCACHE_OP_KEEP_FLAGS   0x00f0  /* flags to keep when repurposing an op */
 102
 103         enum fscache_operation_state state;
 104         atomic_t                usage;
 105         unsigned                debug_id;       /* debugging ID */
 106
 107         /* operation processor callback
 108          * - can be NULL if FSCACHE_OP_WAITING is going to be used to perform
 109          *   the op in a non-pool thread */
 110         fscache_operation_processor_t processor;
 111
 112         /* operation releaser */
 113         fscache_operation_release_t release;
 114 };
 115
 116 extern atomic_t fscache_op_debug_id;
 117 extern void fscache_op_work_func(struct work_struct *work);
 118
 119 extern void fscache_enqueue_operation(struct fscache_operation *);
 120 extern void fscache_op_complete(struct fscache_operation *, bool);
 121 extern void fscache_put_operation(struct fscache_operation *);
 122 extern void fscache_operation_init(struct fscache_operation *,
 123                                    fscache_operation_processor_t,
 124                                    fscache_operation_release_t);
 125
 126 /*
 127  * data read operation
 128  */
 129 struct fscache_retrieval {
 130         struct fscache_operation op;
 131         struct address_space    *mapping;       /* netfs pages */
 132         fscache_rw_complete_t   end_io_func;    /* function to call on I/O completion */
 133         void                    *context;       /* netfs read context (pinned) */
 134         struct list_head        to_do;          /* list of things to be done by the backend */
 135         unsigned long           start_time;     /* time at which retrieval started */
 136         atomic_t                n_pages;        /* number of pages to be retrieved */
 137 };
 138
 139 typedef int (*fscache_page_retrieval_func_t)(struct fscache_retrieval *op,
 140                                              struct page *page,
 141                                              gfp_t gfp);
 142
 143 typedef int (*fscache_pages_retrieval_func_t)(struct fscache_retrieval *op,
 144                                               struct list_head *pages,
 145                                               unsigned *nr_pages,
 146                                               gfp_t gfp);
 147
 148 /**
 149  * fscache_get_retrieval - Get an extra reference on a retrieval operation
 150  * @op: The retrieval operation to get a reference on
 151  *
 152  * Get an extra reference on a retrieval operation.
 153  */
 154 static inline
 155 struct fscache_retrieval *fscache_get_retrieval(struct fscache_retrieval *op)
 156 {
 157         atomic_inc(&op->op.usage);
 158         return op;
 159 }
 160
 161 /**
 162  * fscache_enqueue_retrieval - Enqueue a retrieval operation for processing
 163  * @op: The retrieval operation affected
 164  *
 165  * Enqueue a retrieval operation for processing by the FS-Cache thread pool.
 166  */
 167 static inline void fscache_enqueue_retrieval(struct fscache_retrieval *op)
 168 {
 169         fscache_enqueue_operation(&op->op);
 170 }
 171
 172 /**
 173  * fscache_retrieval_complete - Record (partial) completion of a retrieval
 174  * @op: The retrieval operation affected
 175  * @n_pages: The number of pages to account for
 176  */
 177 static inline void fscache_retrieval_complete(struct fscache_retrieval *op,
 178                                               int n_pages)
 179 {
 180         atomic_sub(n_pages, &op->n_pages);
 181         if (atomic_read(&op->n_pages) <= 0)
 182                 fscache_op_complete(&op->op, true);
 183 }
 184
 185 /**
 186  * fscache_put_retrieval - Drop a reference to a retrieval operation
 187  * @op: The retrieval operation affected
 188  *
 189  * Drop a reference to a retrieval operation.
 190  */
 191 static inline void fscache_put_retrieval(struct fscache_retrieval *op)
 192 {
 193         fscache_put_operation(&op->op);
 194 }
 195
 196 /*
 197  * cached page storage work item
 198  * - used to do three things:
 199  *   - batch writes to the cache
 200  *   - do cache writes asynchronously
 201  *   - defer writes until cache object lookup completion
 202  */
 203 struct fscache_storage {
 204         struct fscache_operation op;
 205         pgoff_t                 store_limit;    /* don't write more than this */
 206 };
 207
 208 /*
 209  * cache operations
 210  */
 211 struct fscache_cache_ops {
 212         /* name of cache provider */
 213         const char *name;
 214
 215         /* allocate an object record for a cookie */
 216         struct fscache_object *(*alloc_object)(struct fscache_cache *cache,
 217                                                struct fscache_cookie *cookie);
 218
 219         /* look up the object for a cookie
 220          * - return -ETIMEDOUT to be requeued
 221          */
 222         int (*lookup_object)(struct fscache_object *object);
 223
 224         /* finished looking up */
 225         void (*lookup_complete)(struct fscache_object *object);
 226
 227         /* increment the usage count on this object (may fail if unmounting) */
 228         struct fscache_object *(*grab_object)(struct fscache_object *object);
 229
 230         /* pin an object in the cache */
 231         int (*pin_object)(struct fscache_object *object);
 232
 233         /* unpin an object in the cache */
 234         void (*unpin_object)(struct fscache_object *object);
 235
 236         /* check the consistency between the backing cache and the FS-Cache
 237          * cookie */
 238         bool (*check_consistency)(struct fscache_operation *op);
 239
 240         /* store the updated auxiliary data on an object */
 241         void (*update_object)(struct fscache_object *object);
 242
 243         /* Invalidate an object */
 244         void (*invalidate_object)(struct fscache_operation *op);
 245
 246         /* discard the resources pinned by an object and effect retirement if
 247          * necessary */
 248         void (*drop_object)(struct fscache_object *object);
 249
 250         /* dispose of a reference to an object */
 251         void (*put_object)(struct fscache_object *object);
 252
 253         /* sync a cache */
 254         void (*sync_cache)(struct fscache_cache *cache);
 255
 256         /* notification that the attributes of a non-index object (such as
 257          * i_size) have changed */
 258         int (*attr_changed)(struct fscache_object *object);
 259
 260         /* reserve space for an object's data and associated metadata */
 261         int (*reserve_space)(struct fscache_object *object, loff_t i_size);
 262
 263         /* request a backing block for a page be read or allocated in the
 264          * cache */
 265         fscache_page_retrieval_func_t read_or_alloc_page;
 266
 267         /* request backing blocks for a list of pages be read or allocated in
 268          * the cache */
 269         fscache_pages_retrieval_func_t read_or_alloc_pages;
 270
 271         /* request a backing block for a page be allocated in the cache so that
 272          * it can be written directly */
 273         fscache_page_retrieval_func_t allocate_page;
 274
 275         /* request backing blocks for pages be allocated in the cache so that
 276          * they can be written directly */
 277         fscache_pages_retrieval_func_t allocate_pages;
 278
 279         /* write a page to its backing block in the cache */
 280         int (*write_page)(struct fscache_storage *op, struct page *page);
 281
 282         /* detach backing block from a page (optional)
 283          * - must release the cookie lock before returning
 284          * - may sleep
 285          */
 286         void (*uncache_page)(struct fscache_object *object,
 287                              struct page *page);
 288
 289         /* dissociate a cache from all the pages it was backing */
 290         void (*dissociate_pages)(struct fscache_cache *cache);
 291 };
 292
 293 extern struct fscache_cookie fscache_fsdef_index;
 294
 295 /*
 296  * Event list for fscache_object::{event_mask,events}
 297  */
 298 enum {
 299         FSCACHE_OBJECT_EV_NEW_CHILD,    /* T if object has a new child */
 300         FSCACHE_OBJECT_EV_PARENT_READY, /* T if object's parent is ready */
 301         FSCACHE_OBJECT_EV_UPDATE,       /* T if object should be updated */
 302         FSCACHE_OBJECT_EV_INVALIDATE,   /* T if cache requested object invalidation */
 303         FSCACHE_OBJECT_EV_CLEARED,      /* T if accessors all gone */
 304         FSCACHE_OBJECT_EV_ERROR,        /* T if fatal error occurred during processing */
 305         FSCACHE_OBJECT_EV_KILL,         /* T if netfs relinquished or cache withdrew object */
 306         NR_FSCACHE_OBJECT_EVENTS
 307 };
 308
 309 #define FSCACHE_OBJECT_EVENTS_MASK ((1UL << NR_FSCACHE_OBJECT_EVENTS) - 1)
 310
 311 /*
 312  * States for object state machine.
 313  */
 314 struct fscache_transition {
 315         unsigned long events;
 316         const struct fscache_state *transit_to;
 317 };
 318
 319 struct fscache_state {
 320         char name[24];
 321         char short_name[8];
 322         const struct fscache_state *(*work)(struct fscache_object *object,
 323                                             int event);
 324         const struct fscache_transition transitions[];
 325 };
 326
 327 /*
 328  * on-disk cache file or index handle
 329  */
 330 struct fscache_object {
 331         const struct fscache_state *state;      /* Object state machine state */
 332         const struct fscache_transition *oob_table; /* OOB state transition table */
 333         int                     debug_id;       /* debugging ID */
 334         int                     n_children;     /* number of child objects */
 335         int                     n_ops;          /* number of extant ops on object */
 336         int                     n_obj_ops;      /* number of object ops outstanding on object */
 337         int                     n_in_progress;  /* number of ops in progress */
 338         int                     n_exclusive;    /* number of exclusive ops queued or in progress */
 339         atomic_t                n_reads;        /* number of read ops in progress */
 340         spinlock_t              lock;           /* state and operations lock */
 341
 342         unsigned long           lookup_jif;     /* time at which lookup started */
 343         unsigned long           oob_event_mask; /* OOB events this object is interested in */
 344         unsigned long           event_mask;     /* events this object is interested in */
 345         unsigned long           events;         /* events to be processed by this object
 346                                                  * (order is important - using fls) */
 347
 348         unsigned long           flags;
 349 #define FSCACHE_OBJECT_LOCK             0       /* T if object is busy being processed */
 350 #define FSCACHE_OBJECT_PENDING_WRITE    1       /* T if object has pending write */
 351 #define FSCACHE_OBJECT_WAITING          2       /* T if object is waiting on its parent */
 352 #define FSCACHE_OBJECT_IS_LIVE          3       /* T if object is not withdrawn or relinquished */
 353 #define FSCACHE_OBJECT_IS_LOOKED_UP     4       /* T if object has been looked up */
 354 #define FSCACHE_OBJECT_IS_AVAILABLE     5       /* T if object has become active */
 355 #define FSCACHE_OBJECT_RETIRED          6       /* T if object was retired on relinquishment */
 356 #define FSCACHE_OBJECT_KILLED_BY_CACHE  7       /* T if object was killed by the cache */
 357
 358         struct list_head        cache_link;     /* link in cache->object_list */
 359         struct hlist_node       cookie_link;    /* link in cookie->backing_objects */
 360         struct fscache_cache    *cache;         /* cache that supplied this object */
 361         struct fscache_cookie   *cookie;        /* netfs's file/index object */
 362         struct fscache_object   *parent;        /* parent object */
 363         struct work_struct      work;           /* attention scheduling record */
 364         struct list_head        dependents;     /* FIFO of dependent objects */
 365         struct list_head        dep_link;       /* link in parent's dependents list */
 366         struct list_head        pending_ops;    /* unstarted operations on this object */
 367 #ifdef CONFIG_FSCACHE_OBJECT_LIST
 368         struct rb_node          objlist_link;   /* link in global object list */
 369 #endif
 370         pgoff_t                 store_limit;    /* current storage limit */
 371         loff_t                  store_limit_l;  /* current storage limit */
 372 };
 373
 374 extern void fscache_object_init(struct fscache_object *, struct fscache_cookie *,
 375                                 struct fscache_cache *);
 376 extern void fscache_object_destroy(struct fscache_object *);
 377
 378 extern void fscache_object_lookup_negative(struct fscache_object *object);
 379 extern void fscache_obtained_object(struct fscache_object *object);
 380
 381 static inline bool fscache_object_is_live(struct fscache_object *object)
 382 {
 383         return test_bit(FSCACHE_OBJECT_IS_LIVE, &object->flags);
 384 }
 385
 386 static inline bool fscache_object_is_dying(struct fscache_object *object)
 387 {
 388         return !fscache_object_is_live(object);
 389 }
 390
 391 static inline bool fscache_object_is_available(struct fscache_object *object)
 392 {
 393         return test_bit(FSCACHE_OBJECT_IS_AVAILABLE, &object->flags);
 394 }
 395
 396 static inline bool fscache_cache_is_broken(struct fscache_object *object)
 397 {
 398         return test_bit(FSCACHE_IOERROR, &object->cache->flags);
 399 }
 400
 401 static inline bool fscache_object_is_active(struct fscache_object *object)
 402 {
 403         return fscache_object_is_available(object) &&
 404                 fscache_object_is_live(object) &&
 405                 !fscache_cache_is_broken(object);
 406 }
 407
 408 /**
 409  * fscache_object_destroyed - Note destruction of an object in a cache
 410  * @cache: The cache from which the object came
 411  *
 412  * Note the destruction and deallocation of an object record in a cache.
 413  */
 414 static inline void fscache_object_destroyed(struct fscache_cache *cache)
 415 {
 416         if (atomic_dec_and_test(&cache->object_count))
 417                 wake_up_all(&fscache_cache_cleared_wq);
 418 }
 419
 420 /**
 421  * fscache_object_lookup_error - Note an object encountered an error
 422  * @object: The object on which the error was encountered
 423  *
 424  * Note that an object encountered a fatal error (usually an I/O error) and
 425  * that it should be withdrawn as soon as possible.
 426  */
 427 static inline void fscache_object_lookup_error(struct fscache_object *object)
 428 {
 429         set_bit(FSCACHE_OBJECT_EV_ERROR, &object->events);
 430 }
 431
 432 /**
 433  * fscache_set_store_limit - Set the maximum size to be stored in an object
 434  * @object: The object to set the maximum on
 435  * @i_size: The limit to set in bytes
 436  *
 437  * Set the maximum size an object is permitted to reach, implying the highest
 438  * byte that may be written.  Intended to be called by the attr_changed() op.
 439  *
 440  * See Documentation/filesystems/caching/backend-api.txt for a complete
 441  * description.
 442  */
 443 static inline
 444 void fscache_set_store_limit(struct fscache_object *object, loff_t i_size)
 445 {
 446         object->store_limit_l = i_size;
 447         object->store_limit = i_size >> PAGE_SHIFT;
 448         if (i_size & ~PAGE_MASK)
 449                 object->store_limit++;
 450 }
 451
 452 /**
 453  * fscache_end_io - End a retrieval operation on a page
 454  * @op: The FS-Cache operation covering the retrieval
 455  * @page: The page that was to be fetched
 456  * @error: The error code (0 if successful)
 457  *
 458  * Note the end of an operation to retrieve a page, as covered by a particular
 459  * operation record.
 460  */
 461 static inline void fscache_end_io(struct fscache_retrieval *op,
 462                                   struct page *page, int error)
 463 {
 464         op->end_io_func(page, op->context, error);
 465 }
 466
 467 static inline void __fscache_use_cookie(struct fscache_cookie *cookie)
 468 {
 469         atomic_inc(&cookie->n_active);
 470 }
 471
 472 /**
 473  * fscache_use_cookie - Request usage of cookie attached to an object
 474  * @object: Object description
 475  *
 476  * Request usage of the cookie attached to an object.  NULL is returned if the
 477  * relinquishment had reduced the cookie usage count to 0.
 478  */
 479 static inline bool fscache_use_cookie(struct fscache_object *object)
 480 {
 481         struct fscache_cookie *cookie = object->cookie;
 482         return atomic_inc_not_zero(&cookie->n_active) != 0;
 483 }
 484
 485 static inline bool __fscache_unuse_cookie(struct fscache_cookie *cookie)
 486 {
 487         return atomic_dec_and_test(&cookie->n_active);
 488 }
 489
 490 static inline void __fscache_wake_unused_cookie(struct fscache_cookie *cookie)
 491 {
 492         wake_up_atomic_t(&cookie->n_active);
 493 }
 494
 495 /**
 496  * fscache_unuse_cookie - Cease usage of cookie attached to an object
 497  * @object: Object description
 498  *
 499  * Cease usage of the cookie attached to an object.  When the users count
 500  * reaches zero then the cookie relinquishment will be permitted to proceed.
 501  */
 502 static inline void fscache_unuse_cookie(struct fscache_object *object)
 503 {
 504         struct fscache_cookie *cookie = object->cookie;
 505         if (__fscache_unuse_cookie(cookie))
 506                 __fscache_wake_unused_cookie(cookie);
 507 }
 508
 509 /*
 510  * out-of-line cache backend functions
 511  */
 512 extern __printf(3, 4)
 513 void fscache_init_cache(struct fscache_cache *cache,
 514                         const struct fscache_cache_ops *ops,
 515                         const char *idfmt, ...);
 516
 517 extern int fscache_add_cache(struct fscache_cache *cache,
 518                              struct fscache_object *fsdef,
 519                              const char *tagname);
 520 extern void fscache_withdraw_cache(struct fscache_cache *cache);
 521
 522 extern void fscache_io_error(struct fscache_cache *cache);
 523
 524 extern void fscache_mark_page_cached(struct fscache_retrieval *op,
 525                                      struct page *page);
 526
 527 extern void fscache_mark_pages_cached(struct fscache_retrieval *op,
 528                                       struct pagevec *pagevec);
 529
 530 extern bool fscache_object_sleep_till_congested(signed long *timeoutp);
 531
 532 extern enum fscache_checkaux fscache_check_aux(struct fscache_object *object,
 533                                                const void *data,
 534                                                uint16_t datalen);
 535
 536 extern void fscache_object_retrying_stale(struct fscache_object *object);
 537
 538 enum fscache_why_object_killed {
 539         FSCACHE_OBJECT_IS_STALE,
 540         FSCACHE_OBJECT_NO_SPACE,
 541         FSCACHE_OBJECT_WAS_RETIRED,
 542         FSCACHE_OBJECT_WAS_CULLED,
 543 };
 544 extern void fscache_object_mark_killed(struct fscache_object *object,
 545                                        enum fscache_why_object_killed why);
 546
 547 #endif /* _LINUX_FSCACHE_CACHE_H */