FS-Cache: Implement the cookie management part of the netfs API
[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 extern struct fscache_cookie *__fscache_acquire_cookie(
182         struct fscache_cookie *,
183         const struct fscache_cookie_def *,
184         void *);
185 extern void __fscache_relinquish_cookie(struct fscache_cookie *, int);
186 extern void __fscache_update_cookie(struct fscache_cookie *);
187
188 /**
189  * fscache_register_netfs - Register a filesystem as desiring caching services
190  * @netfs: The description of the filesystem
191  *
192  * Register a filesystem as desiring caching services if they're available.
193  *
194  * See Documentation/filesystems/caching/netfs-api.txt for a complete
195  * description.
196  */
197 static inline
198 int fscache_register_netfs(struct fscache_netfs *netfs)
199 {
200         if (fscache_available())
201                 return __fscache_register_netfs(netfs);
202         else
203                 return 0;
204 }
205
206 /**
207  * fscache_unregister_netfs - Indicate that a filesystem no longer desires
208  * caching services
209  * @netfs: The description of the filesystem
210  *
211  * Indicate that a filesystem no longer desires caching services for the
212  * moment.
213  *
214  * See Documentation/filesystems/caching/netfs-api.txt for a complete
215  * description.
216  */
217 static inline
218 void fscache_unregister_netfs(struct fscache_netfs *netfs)
219 {
220         if (fscache_available())
221                 __fscache_unregister_netfs(netfs);
222 }
223
224 /**
225  * fscache_lookup_cache_tag - Look up a cache tag
226  * @name: The name of the tag to search for
227  *
228  * Acquire a specific cache referral tag that can be used to select a specific
229  * cache in which to cache an index.
230  *
231  * See Documentation/filesystems/caching/netfs-api.txt for a complete
232  * description.
233  */
234 static inline
235 struct fscache_cache_tag *fscache_lookup_cache_tag(const char *name)
236 {
237         if (fscache_available())
238                 return __fscache_lookup_cache_tag(name);
239         else
240                 return NULL;
241 }
242
243 /**
244  * fscache_release_cache_tag - Release a cache tag
245  * @tag: The tag to release
246  *
247  * Release a reference to a cache referral tag previously looked up.
248  *
249  * See Documentation/filesystems/caching/netfs-api.txt for a complete
250  * description.
251  */
252 static inline
253 void fscache_release_cache_tag(struct fscache_cache_tag *tag)
254 {
255         if (fscache_available())
256                 __fscache_release_cache_tag(tag);
257 }
258
259 /**
260  * fscache_acquire_cookie - Acquire a cookie to represent a cache object
261  * @parent: The cookie that's to be the parent of this one
262  * @def: A description of the cache object, including callback operations
263  * @netfs_data: An arbitrary piece of data to be kept in the cookie to
264  * represent the cache object to the netfs
265  *
266  * This function is used to inform FS-Cache about part of an index hierarchy
267  * that can be used to locate files.  This is done by requesting a cookie for
268  * each index in the path to the file.
269  *
270  * See Documentation/filesystems/caching/netfs-api.txt for a complete
271  * description.
272  */
273 static inline
274 struct fscache_cookie *fscache_acquire_cookie(
275         struct fscache_cookie *parent,
276         const struct fscache_cookie_def *def,
277         void *netfs_data)
278 {
279         if (fscache_cookie_valid(parent))
280                 return __fscache_acquire_cookie(parent, def, netfs_data);
281         else
282                 return NULL;
283 }
284
285 /**
286  * fscache_relinquish_cookie - Return the cookie to the cache, maybe discarding
287  * it
288  * @cookie: The cookie being returned
289  * @retire: True if the cache object the cookie represents is to be discarded
290  *
291  * This function returns a cookie to the cache, forcibly discarding the
292  * associated cache object if retire is set to true.
293  *
294  * See Documentation/filesystems/caching/netfs-api.txt for a complete
295  * description.
296  */
297 static inline
298 void fscache_relinquish_cookie(struct fscache_cookie *cookie, int retire)
299 {
300         if (fscache_cookie_valid(cookie))
301                 __fscache_relinquish_cookie(cookie, retire);
302 }
303
304 /**
305  * fscache_update_cookie - Request that a cache object be updated
306  * @cookie: The cookie representing the cache object
307  *
308  * Request an update of the index data for the cache object associated with the
309  * cookie.
310  *
311  * See Documentation/filesystems/caching/netfs-api.txt for a complete
312  * description.
313  */
314 static inline
315 void fscache_update_cookie(struct fscache_cookie *cookie)
316 {
317         if (fscache_cookie_valid(cookie))
318                 __fscache_update_cookie(cookie);
319 }
320
321 /**
322  * fscache_pin_cookie - Pin a data-storage cache object in its cache
323  * @cookie: The cookie representing the cache object
324  *
325  * Permit data-storage cache objects to be pinned in the cache.
326  *
327  * See Documentation/filesystems/caching/netfs-api.txt for a complete
328  * description.
329  */
330 static inline
331 int fscache_pin_cookie(struct fscache_cookie *cookie)
332 {
333         return -ENOBUFS;
334 }
335
336 /**
337  * fscache_pin_cookie - Unpin a data-storage cache object in its cache
338  * @cookie: The cookie representing the cache object
339  *
340  * Permit data-storage cache objects to be unpinned from the cache.
341  *
342  * See Documentation/filesystems/caching/netfs-api.txt for a complete
343  * description.
344  */
345 static inline
346 void fscache_unpin_cookie(struct fscache_cookie *cookie)
347 {
348 }
349
350 /**
351  * fscache_attr_changed - Notify cache that an object's attributes changed
352  * @cookie: The cookie representing the cache object
353  *
354  * Send a notification to the cache indicating that an object's attributes have
355  * changed.  This includes the data size.  These attributes will be obtained
356  * through the get_attr() cookie definition op.
357  *
358  * See Documentation/filesystems/caching/netfs-api.txt for a complete
359  * description.
360  */
361 static inline
362 int fscache_attr_changed(struct fscache_cookie *cookie)
363 {
364         return -ENOBUFS;
365 }
366
367 /**
368  * fscache_reserve_space - Reserve data space for a cached object
369  * @cookie: The cookie representing the cache object
370  * @i_size: The amount of space to be reserved
371  *
372  * Reserve an amount of space in the cache for the cache object attached to a
373  * cookie so that a write to that object within the space can always be
374  * honoured.
375  *
376  * See Documentation/filesystems/caching/netfs-api.txt for a complete
377  * description.
378  */
379 static inline
380 int fscache_reserve_space(struct fscache_cookie *cookie, loff_t size)
381 {
382         return -ENOBUFS;
383 }
384
385 /**
386  * fscache_read_or_alloc_page - Read a page from the cache or allocate a block
387  * in which to store it
388  * @cookie: The cookie representing the cache object
389  * @page: The netfs page to fill if possible
390  * @end_io_func: The callback to invoke when and if the page is filled
391  * @context: An arbitrary piece of data to pass on to end_io_func()
392  * @gfp: The conditions under which memory allocation should be made
393  *
394  * Read a page from the cache, or if that's not possible make a potential
395  * one-block reservation in the cache into which the page may be stored once
396  * fetched from the server.
397  *
398  * If the page is not backed by the cache object, or if it there's some reason
399  * it can't be, -ENOBUFS will be returned and nothing more will be done for
400  * that page.
401  *
402  * Else, if that page is backed by the cache, a read will be initiated directly
403  * to the netfs's page and 0 will be returned by this function.  The
404  * end_io_func() callback will be invoked when the operation terminates on a
405  * completion or failure.  Note that the callback may be invoked before the
406  * return.
407  *
408  * Else, if the page is unbacked, -ENODATA is returned and a block may have
409  * been allocated in the cache.
410  *
411  * See Documentation/filesystems/caching/netfs-api.txt for a complete
412  * description.
413  */
414 static inline
415 int fscache_read_or_alloc_page(struct fscache_cookie *cookie,
416                                struct page *page,
417                                fscache_rw_complete_t end_io_func,
418                                void *context,
419                                gfp_t gfp)
420 {
421         return -ENOBUFS;
422 }
423
424 /**
425  * fscache_read_or_alloc_pages - Read pages from the cache and/or allocate
426  * blocks in which to store them
427  * @cookie: The cookie representing the cache object
428  * @mapping: The netfs inode mapping to which the pages will be attached
429  * @pages: A list of potential netfs pages to be filled
430  * @end_io_func: The callback to invoke when and if each page is filled
431  * @context: An arbitrary piece of data to pass on to end_io_func()
432  * @gfp: The conditions under which memory allocation should be made
433  *
434  * Read a set of pages from the cache, or if that's not possible, attempt to
435  * make a potential one-block reservation for each page in the cache into which
436  * that page may be stored once fetched from the server.
437  *
438  * If some pages are not backed by the cache object, or if it there's some
439  * reason they can't be, -ENOBUFS will be returned and nothing more will be
440  * done for that pages.
441  *
442  * Else, if some of the pages are backed by the cache, a read will be initiated
443  * directly to the netfs's page and 0 will be returned by this function.  The
444  * end_io_func() callback will be invoked when the operation terminates on a
445  * completion or failure.  Note that the callback may be invoked before the
446  * return.
447  *
448  * Else, if a page is unbacked, -ENODATA is returned and a block may have
449  * been allocated in the cache.
450  *
451  * Because the function may want to return all of -ENOBUFS, -ENODATA and 0 in
452  * regard to different pages, the return values are prioritised in that order.
453  * Any pages submitted for reading are removed from the pages list.
454  *
455  * See Documentation/filesystems/caching/netfs-api.txt for a complete
456  * description.
457  */
458 static inline
459 int fscache_read_or_alloc_pages(struct fscache_cookie *cookie,
460                                 struct address_space *mapping,
461                                 struct list_head *pages,
462                                 unsigned *nr_pages,
463                                 fscache_rw_complete_t end_io_func,
464                                 void *context,
465                                 gfp_t gfp)
466 {
467         return -ENOBUFS;
468 }
469
470 /**
471  * fscache_alloc_page - Allocate a block in which to store a page
472  * @cookie: The cookie representing the cache object
473  * @page: The netfs page to allocate a page for
474  * @gfp: The conditions under which memory allocation should be made
475  *
476  * Request Allocation a block in the cache in which to store a netfs page
477  * without retrieving any contents from the cache.
478  *
479  * If the page is not backed by a file then -ENOBUFS will be returned and
480  * nothing more will be done, and no reservation will be made.
481  *
482  * Else, a block will be allocated if one wasn't already, and 0 will be
483  * returned
484  *
485  * See Documentation/filesystems/caching/netfs-api.txt for a complete
486  * description.
487  */
488 static inline
489 int fscache_alloc_page(struct fscache_cookie *cookie,
490                        struct page *page,
491                        gfp_t gfp)
492 {
493         return -ENOBUFS;
494 }
495
496 /**
497  * fscache_write_page - Request storage of a page in the cache
498  * @cookie: The cookie representing the cache object
499  * @page: The netfs page to store
500  * @gfp: The conditions under which memory allocation should be made
501  *
502  * Request the contents of the netfs page be written into the cache.  This
503  * request may be ignored if no cache block is currently allocated, in which
504  * case it will return -ENOBUFS.
505  *
506  * If a cache block was already allocated, a write will be initiated and 0 will
507  * be returned.  The PG_fscache_write page bit is set immediately and will then
508  * be cleared at the completion of the write to indicate the success or failure
509  * of the operation.  Note that the completion may happen before the return.
510  *
511  * See Documentation/filesystems/caching/netfs-api.txt for a complete
512  * description.
513  */
514 static inline
515 int fscache_write_page(struct fscache_cookie *cookie,
516                        struct page *page,
517                        gfp_t gfp)
518 {
519         return -ENOBUFS;
520 }
521
522 /**
523  * fscache_uncache_page - Indicate that caching is no longer required on a page
524  * @cookie: The cookie representing the cache object
525  * @page: The netfs page that was being cached.
526  *
527  * Tell the cache that we no longer want a page to be cached and that it should
528  * remove any knowledge of the netfs page it may have.
529  *
530  * Note that this cannot cancel any outstanding I/O operations between this
531  * page and the cache.
532  *
533  * See Documentation/filesystems/caching/netfs-api.txt for a complete
534  * description.
535  */
536 static inline
537 void fscache_uncache_page(struct fscache_cookie *cookie,
538                           struct page *page)
539 {
540 }
541
542 /**
543  * fscache_check_page_write - Ask if a page is being writing to the cache
544  * @cookie: The cookie representing the cache object
545  * @page: The netfs page that is being cached.
546  *
547  * Ask the cache if a page is being written to the cache.
548  *
549  * See Documentation/filesystems/caching/netfs-api.txt for a complete
550  * description.
551  */
552 static inline
553 bool fscache_check_page_write(struct fscache_cookie *cookie,
554                               struct page *page)
555 {
556         return false;
557 }
558
559 /**
560  * fscache_wait_on_page_write - Wait for a page to complete writing to the cache
561  * @cookie: The cookie representing the cache object
562  * @page: The netfs page that is being cached.
563  *
564  * Ask the cache to wake us up when a page is no longer being written to the
565  * cache.
566  *
567  * See Documentation/filesystems/caching/netfs-api.txt for a complete
568  * description.
569  */
570 static inline
571 void fscache_wait_on_page_write(struct fscache_cookie *cookie,
572                                 struct page *page)
573 {
574 }
575
576 #endif /* _LINUX_FSCACHE_H */