b195c2e1ef6a9cebc283bcb9acc260bb8420efb6
[linux-2.6.git] / include / linux / fscache.h
1 /* General filesystem caching 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/netfs-api.txt
14  *
15  * for a description of the network filesystem interface declared here.
16  */
17
18 #ifndef _LINUX_FSCACHE_H
19 #define _LINUX_FSCACHE_H
20
21 #include <linux/fs.h>
22 #include <linux/list.h>
23 #include <linux/pagemap.h>
24 #include <linux/pagevec.h>
25
26 #if defined(CONFIG_FSCACHE) || defined(CONFIG_FSCACHE_MODULE)
27 #define fscache_available() (1)
28 #define fscache_cookie_valid(cookie) (cookie)
29 #else
30 #define fscache_available() (0)
31 #define fscache_cookie_valid(cookie) (0)
32 #endif
33
34
35 /*
36  * overload PG_private_2 to give us PG_fscache - this is used to indicate that
37  * a page is currently backed by a local disk cache
38  */
39 #define PageFsCache(page)               PagePrivate2((page))
40 #define SetPageFsCache(page)            SetPagePrivate2((page))
41 #define ClearPageFsCache(page)          ClearPagePrivate2((page))
42 #define TestSetPageFsCache(page)        TestSetPagePrivate2((page))
43 #define TestClearPageFsCache(page)      TestClearPagePrivate2((page))
44
45 /* pattern used to fill dead space in an index entry */
46 #define FSCACHE_INDEX_DEADFILL_PATTERN 0x79
47
48 struct pagevec;
49 struct fscache_cache_tag;
50 struct fscache_cookie;
51 struct fscache_netfs;
52
53 typedef void (*fscache_rw_complete_t)(struct page *page,
54                                       void *context,
55                                       int error);
56
57 /* result of index entry consultation */
58 enum fscache_checkaux {
59         FSCACHE_CHECKAUX_OKAY,          /* entry okay as is */
60         FSCACHE_CHECKAUX_NEEDS_UPDATE,  /* entry requires update */
61         FSCACHE_CHECKAUX_OBSOLETE,      /* entry requires deletion */
62 };
63
64 /*
65  * fscache cookie definition
66  */
67 struct fscache_cookie_def {
68         /* name of cookie type */
69         char name[16];
70
71         /* cookie type */
72         uint8_t type;
73 #define FSCACHE_COOKIE_TYPE_INDEX       0
74 #define FSCACHE_COOKIE_TYPE_DATAFILE    1
75
76         /* select the cache into which to insert an entry in this index
77          * - optional
78          * - should return a cache identifier or NULL to cause the cache to be
79          *   inherited from the parent if possible or the first cache picked
80          *   for a non-index file if not
81          */
82         struct fscache_cache_tag *(*select_cache)(
83                 const void *parent_netfs_data,
84                 const void *cookie_netfs_data);
85
86         /* get an index key
87          * - should store the key data in the buffer
88          * - should return the amount of amount stored
89          * - not permitted to return an error
90          * - the netfs data from the cookie being used as the source is
91          *   presented
92          */
93         uint16_t (*get_key)(const void *cookie_netfs_data,
94                             void *buffer,
95                             uint16_t bufmax);
96
97         /* get certain file attributes from the netfs data
98          * - this function can be absent for an index
99          * - not permitted to return an error
100          * - the netfs data from the cookie being used as the source is
101          *   presented
102          */
103         void (*get_attr)(const void *cookie_netfs_data, uint64_t *size);
104
105         /* get the auxilliary data from netfs data
106          * - this function can be absent if the index carries no state data
107          * - should store the auxilliary data in the buffer
108          * - should return the amount of amount stored
109          * - not permitted to return an error
110          * - the netfs data from the cookie being used as the source is
111          *   presented
112          */
113         uint16_t (*get_aux)(const void *cookie_netfs_data,
114                             void *buffer,
115                             uint16_t bufmax);
116
117         /* consult the netfs about the state of an object
118          * - this function can be absent if the index carries no state data
119          * - the netfs data from the cookie being used as the target is
120          *   presented, as is the auxilliary data
121          */
122         enum fscache_checkaux (*check_aux)(void *cookie_netfs_data,
123                                            const void *data,
124                                            uint16_t datalen);
125
126         /* get an extra reference on a read context
127          * - this function can be absent if the completion function doesn't
128          *   require a context
129          */
130         void (*get_context)(void *cookie_netfs_data, void *context);
131
132         /* release an extra reference on a read context
133          * - this function can be absent if the completion function doesn't
134          *   require a context
135          */
136         void (*put_context)(void *cookie_netfs_data, void *context);
137
138         /* indicate pages that now have cache metadata retained
139          * - this function should mark the specified pages as now being cached
140          * - the pages will have been marked with PG_fscache before this is
141          *   called, so this is optional
142          */
143         void (*mark_pages_cached)(void *cookie_netfs_data,
144                                   struct address_space *mapping,
145                                   struct pagevec *cached_pvec);
146
147         /* indicate the cookie is no longer cached
148          * - this function is called when the backing store currently caching
149          *   a cookie is removed
150          * - the netfs should use this to clean up any markers indicating
151          *   cached pages
152          * - this is mandatory for any object that may have data
153          */
154         void (*now_uncached)(void *cookie_netfs_data);
155 };
156
157 /*
158  * fscache cached network filesystem type
159  * - name, version and ops must be filled in before registration
160  * - all other fields will be set during registration
161  */
162 struct fscache_netfs {
163         uint32_t                        version;        /* indexing version */
164         const char                      *name;          /* filesystem name */
165         struct fscache_cookie           *primary_index;
166         struct list_head                link;           /* internal link */
167 };
168
169 /*
170  * slow-path functions for when there is actually caching available, and the
171  * netfs does actually have a valid token
172  * - these are not to be called directly
173  * - these are undefined symbols when FS-Cache is not configured and the
174  *   optimiser takes care of not using them
175  */
176 extern int __fscache_register_netfs(struct fscache_netfs *);
177 extern void __fscache_unregister_netfs(struct fscache_netfs *);
178 extern struct fscache_cache_tag *__fscache_lookup_cache_tag(const char *);
179 extern void __fscache_release_cache_tag(struct fscache_cache_tag *);
180
181 /**
182  * fscache_register_netfs - Register a filesystem as desiring caching services
183  * @netfs: The description of the filesystem
184  *
185  * Register a filesystem as desiring caching services if they're available.
186  *
187  * See Documentation/filesystems/caching/netfs-api.txt for a complete
188  * description.
189  */
190 static inline
191 int fscache_register_netfs(struct fscache_netfs *netfs)
192 {
193         if (fscache_available())
194                 return __fscache_register_netfs(netfs);
195         else
196                 return 0;
197 }
198
199 /**
200  * fscache_unregister_netfs - Indicate that a filesystem no longer desires
201  * caching services
202  * @netfs: The description of the filesystem
203  *
204  * Indicate that a filesystem no longer desires caching services for the
205  * moment.
206  *
207  * See Documentation/filesystems/caching/netfs-api.txt for a complete
208  * description.
209  */
210 static inline
211 void fscache_unregister_netfs(struct fscache_netfs *netfs)
212 {
213         if (fscache_available())
214                 __fscache_unregister_netfs(netfs);
215 }
216
217 /**
218  * fscache_lookup_cache_tag - Look up a cache tag
219  * @name: The name of the tag to search for
220  *
221  * Acquire a specific cache referral tag that can be used to select a specific
222  * cache in which to cache an index.
223  *
224  * See Documentation/filesystems/caching/netfs-api.txt for a complete
225  * description.
226  */
227 static inline
228 struct fscache_cache_tag *fscache_lookup_cache_tag(const char *name)
229 {
230         if (fscache_available())
231                 return __fscache_lookup_cache_tag(name);
232         else
233                 return NULL;
234 }
235
236 /**
237  * fscache_release_cache_tag - Release a cache tag
238  * @tag: The tag to release
239  *
240  * Release a reference to a cache referral tag previously looked up.
241  *
242  * See Documentation/filesystems/caching/netfs-api.txt for a complete
243  * description.
244  */
245 static inline
246 void fscache_release_cache_tag(struct fscache_cache_tag *tag)
247 {
248         if (fscache_available())
249                 __fscache_release_cache_tag(tag);
250 }
251
252 /**
253  * fscache_acquire_cookie - Acquire a cookie to represent a cache object
254  * @parent: The cookie that's to be the parent of this one
255  * @def: A description of the cache object, including callback operations
256  * @netfs_data: An arbitrary piece of data to be kept in the cookie to
257  * represent the cache object to the netfs
258  *
259  * This function is used to inform FS-Cache about part of an index hierarchy
260  * that can be used to locate files.  This is done by requesting a cookie for
261  * each index in the path to the file.
262  *
263  * See Documentation/filesystems/caching/netfs-api.txt for a complete
264  * description.
265  */
266 static inline
267 struct fscache_cookie *fscache_acquire_cookie(
268         struct fscache_cookie *parent,
269         const struct fscache_cookie_def *def,
270         void *netfs_data)
271 {
272         return NULL;
273 }
274
275 /**
276  * fscache_relinquish_cookie - Return the cookie to the cache, maybe discarding
277  * it
278  * @cookie: The cookie being returned
279  * @retire: True if the cache object the cookie represents is to be discarded
280  *
281  * This function returns a cookie to the cache, forcibly discarding the
282  * associated cache object if retire is set to true.
283  *
284  * See Documentation/filesystems/caching/netfs-api.txt for a complete
285  * description.
286  */
287 static inline
288 void fscache_relinquish_cookie(struct fscache_cookie *cookie, int retire)
289 {
290 }
291
292 /**
293  * fscache_update_cookie - Request that a cache object be updated
294  * @cookie: The cookie representing the cache object
295  *
296  * Request an update of the index data for the cache object associated with the
297  * cookie.
298  *
299  * See Documentation/filesystems/caching/netfs-api.txt for a complete
300  * description.
301  */
302 static inline
303 void fscache_update_cookie(struct fscache_cookie *cookie)
304 {
305 }
306
307 /**
308  * fscache_pin_cookie - Pin a data-storage cache object in its cache
309  * @cookie: The cookie representing the cache object
310  *
311  * Permit data-storage cache objects to be pinned in the cache.
312  *
313  * See Documentation/filesystems/caching/netfs-api.txt for a complete
314  * description.
315  */
316 static inline
317 int fscache_pin_cookie(struct fscache_cookie *cookie)
318 {
319         return -ENOBUFS;
320 }
321
322 /**
323  * fscache_pin_cookie - Unpin a data-storage cache object in its cache
324  * @cookie: The cookie representing the cache object
325  *
326  * Permit data-storage cache objects to be unpinned from the cache.
327  *
328  * See Documentation/filesystems/caching/netfs-api.txt for a complete
329  * description.
330  */
331 static inline
332 void fscache_unpin_cookie(struct fscache_cookie *cookie)
333 {
334 }
335
336 /**
337  * fscache_attr_changed - Notify cache that an object's attributes changed
338  * @cookie: The cookie representing the cache object
339  *
340  * Send a notification to the cache indicating that an object's attributes have
341  * changed.  This includes the data size.  These attributes will be obtained
342  * through the get_attr() cookie definition op.
343  *
344  * See Documentation/filesystems/caching/netfs-api.txt for a complete
345  * description.
346  */
347 static inline
348 int fscache_attr_changed(struct fscache_cookie *cookie)
349 {
350         return -ENOBUFS;
351 }
352
353 /**
354  * fscache_reserve_space - Reserve data space for a cached object
355  * @cookie: The cookie representing the cache object
356  * @i_size: The amount of space to be reserved
357  *
358  * Reserve an amount of space in the cache for the cache object attached to a
359  * cookie so that a write to that object within the space can always be
360  * honoured.
361  *
362  * See Documentation/filesystems/caching/netfs-api.txt for a complete
363  * description.
364  */
365 static inline
366 int fscache_reserve_space(struct fscache_cookie *cookie, loff_t size)
367 {
368         return -ENOBUFS;
369 }
370
371 /**
372  * fscache_read_or_alloc_page - Read a page from the cache or allocate a block
373  * in which to store it
374  * @cookie: The cookie representing the cache object
375  * @page: The netfs page to fill if possible
376  * @end_io_func: The callback to invoke when and if the page is filled
377  * @context: An arbitrary piece of data to pass on to end_io_func()
378  * @gfp: The conditions under which memory allocation should be made
379  *
380  * Read a page from the cache, or if that's not possible make a potential
381  * one-block reservation in the cache into which the page may be stored once
382  * fetched from the server.
383  *
384  * If the page is not backed by the cache object, or if it there's some reason
385  * it can't be, -ENOBUFS will be returned and nothing more will be done for
386  * that page.
387  *
388  * Else, if that page is backed by the cache, a read will be initiated directly
389  * to the netfs's page and 0 will be returned by this function.  The
390  * end_io_func() callback will be invoked when the operation terminates on a
391  * completion or failure.  Note that the callback may be invoked before the
392  * return.
393  *
394  * Else, if the page is unbacked, -ENODATA is returned and a block may have
395  * been allocated in the cache.
396  *
397  * See Documentation/filesystems/caching/netfs-api.txt for a complete
398  * description.
399  */
400 static inline
401 int fscache_read_or_alloc_page(struct fscache_cookie *cookie,
402                                struct page *page,
403                                fscache_rw_complete_t end_io_func,
404                                void *context,
405                                gfp_t gfp)
406 {
407         return -ENOBUFS;
408 }
409
410 /**
411  * fscache_read_or_alloc_pages - Read pages from the cache and/or allocate
412  * blocks in which to store them
413  * @cookie: The cookie representing the cache object
414  * @mapping: The netfs inode mapping to which the pages will be attached
415  * @pages: A list of potential netfs pages to be filled
416  * @end_io_func: The callback to invoke when and if each page is filled
417  * @context: An arbitrary piece of data to pass on to end_io_func()
418  * @gfp: The conditions under which memory allocation should be made
419  *
420  * Read a set of pages from the cache, or if that's not possible, attempt to
421  * make a potential one-block reservation for each page in the cache into which
422  * that page may be stored once fetched from the server.
423  *
424  * If some pages are not backed by the cache object, or if it there's some
425  * reason they can't be, -ENOBUFS will be returned and nothing more will be
426  * done for that pages.
427  *
428  * Else, if some of the pages are backed by the cache, a read will be initiated
429  * directly to the netfs's page and 0 will be returned by this function.  The
430  * end_io_func() callback will be invoked when the operation terminates on a
431  * completion or failure.  Note that the callback may be invoked before the
432  * return.
433  *
434  * Else, if a page is unbacked, -ENODATA is returned and a block may have
435  * been allocated in the cache.
436  *
437  * Because the function may want to return all of -ENOBUFS, -ENODATA and 0 in
438  * regard to different pages, the return values are prioritised in that order.
439  * Any pages submitted for reading are removed from the pages list.
440  *
441  * See Documentation/filesystems/caching/netfs-api.txt for a complete
442  * description.
443  */
444 static inline
445 int fscache_read_or_alloc_pages(struct fscache_cookie *cookie,
446                                 struct address_space *mapping,
447                                 struct list_head *pages,
448                                 unsigned *nr_pages,
449                                 fscache_rw_complete_t end_io_func,
450                                 void *context,
451                                 gfp_t gfp)
452 {
453         return -ENOBUFS;
454 }
455
456 /**
457  * fscache_alloc_page - Allocate a block in which to store a page
458  * @cookie: The cookie representing the cache object
459  * @page: The netfs page to allocate a page for
460  * @gfp: The conditions under which memory allocation should be made
461  *
462  * Request Allocation a block in the cache in which to store a netfs page
463  * without retrieving any contents from the cache.
464  *
465  * If the page is not backed by a file then -ENOBUFS will be returned and
466  * nothing more will be done, and no reservation will be made.
467  *
468  * Else, a block will be allocated if one wasn't already, and 0 will be
469  * returned
470  *
471  * See Documentation/filesystems/caching/netfs-api.txt for a complete
472  * description.
473  */
474 static inline
475 int fscache_alloc_page(struct fscache_cookie *cookie,
476                        struct page *page,
477                        gfp_t gfp)
478 {
479         return -ENOBUFS;
480 }
481
482 /**
483  * fscache_write_page - Request storage of a page in the cache
484  * @cookie: The cookie representing the cache object
485  * @page: The netfs page to store
486  * @gfp: The conditions under which memory allocation should be made
487  *
488  * Request the contents of the netfs page be written into the cache.  This
489  * request may be ignored if no cache block is currently allocated, in which
490  * case it will return -ENOBUFS.
491  *
492  * If a cache block was already allocated, a write will be initiated and 0 will
493  * be returned.  The PG_fscache_write page bit is set immediately and will then
494  * be cleared at the completion of the write to indicate the success or failure
495  * of the operation.  Note that the completion may happen before the return.
496  *
497  * See Documentation/filesystems/caching/netfs-api.txt for a complete
498  * description.
499  */
500 static inline
501 int fscache_write_page(struct fscache_cookie *cookie,
502                        struct page *page,
503                        gfp_t gfp)
504 {
505         return -ENOBUFS;
506 }
507
508 /**
509  * fscache_uncache_page - Indicate that caching is no longer required on a page
510  * @cookie: The cookie representing the cache object
511  * @page: The netfs page that was being cached.
512  *
513  * Tell the cache that we no longer want a page to be cached and that it should
514  * remove any knowledge of the netfs page it may have.
515  *
516  * Note that this cannot cancel any outstanding I/O operations between this
517  * page and the cache.
518  *
519  * See Documentation/filesystems/caching/netfs-api.txt for a complete
520  * description.
521  */
522 static inline
523 void fscache_uncache_page(struct fscache_cookie *cookie,
524                           struct page *page)
525 {
526 }
527
528 /**
529  * fscache_check_page_write - Ask if a page is being writing to the cache
530  * @cookie: The cookie representing the cache object
531  * @page: The netfs page that is being cached.
532  *
533  * Ask the cache if a page is being written to the cache.
534  *
535  * See Documentation/filesystems/caching/netfs-api.txt for a complete
536  * description.
537  */
538 static inline
539 bool fscache_check_page_write(struct fscache_cookie *cookie,
540                               struct page *page)
541 {
542         return false;
543 }
544
545 /**
546  * fscache_wait_on_page_write - Wait for a page to complete writing to the cache
547  * @cookie: The cookie representing the cache object
548  * @page: The netfs page that is being cached.
549  *
550  * Ask the cache to wake us up when a page is no longer being written to the
551  * cache.
552  *
553  * See Documentation/filesystems/caching/netfs-api.txt for a complete
554  * description.
555  */
556 static inline
557 void fscache_wait_on_page_write(struct fscache_cookie *cookie,
558                                 struct page *page)
559 {
560 }
561
562 #endif /* _LINUX_FSCACHE_H */