blob: 12b3442515235374f27c322d90aae7680235d242 [file] [log] [blame]
David Howells2d6fff62009-04-03 16:42:36 +01001 ===============================
2 FS-CACHE NETWORK FILESYSTEM API
3 ===============================
4
5There's an API by which a network filesystem can make use of the FS-Cache
6facilities. This is based around a number of principles:
7
8 (1) Caches can store a number of different object types. There are two main
9 object types: indices and files. The first is a special type used by
10 FS-Cache to make finding objects faster and to make retiring of groups of
11 objects easier.
12
13 (2) Every index, file or other object is represented by a cookie. This cookie
14 may or may not have anything associated with it, but the netfs doesn't
15 need to care.
16
17 (3) Barring the top-level index (one entry per cached netfs), the index
18 hierarchy for each netfs is structured according the whim of the netfs.
19
20This API is declared in <linux/fscache.h>.
21
22This document contains the following sections:
23
24 (1) Network filesystem definition
25 (2) Index definition
26 (3) Object definition
27 (4) Network filesystem (un)registration
28 (5) Cache tag lookup
29 (6) Index registration
30 (7) Data file registration
31 (8) Miscellaneous object registration
32 (9) Setting the data file size
33 (10) Page alloc/read/write
34 (11) Page uncaching
David Howellsda9803b2013-08-21 17:29:38 -040035 (12) Index and data file consistency
David Howells2d6fff62009-04-03 16:42:36 +010036 (13) Miscellaneous cookie operations
37 (14) Cookie unregistration
David Howellsef778e72012-12-20 21:52:36 +000038 (15) Index invalidation
39 (16) Data file invalidation
40 (17) FS-Cache specific page flags.
David Howells2d6fff62009-04-03 16:42:36 +010041
42
43=============================
44NETWORK FILESYSTEM DEFINITION
45=============================
46
47FS-Cache needs a description of the network filesystem. This is specified
48using a record of the following structure:
49
50 struct fscache_netfs {
51 uint32_t version;
52 const char *name;
53 struct fscache_cookie *primary_index;
54 ...
55 };
56
57This first two fields should be filled in before registration, and the third
58will be filled in by the registration function; any other fields should just be
59ignored and are for internal use only.
60
61The fields are:
62
63 (1) The name of the netfs (used as the key in the toplevel index).
64
65 (2) The version of the netfs (if the name matches but the version doesn't, the
66 entire in-cache hierarchy for this netfs will be scrapped and begun
67 afresh).
68
69 (3) The cookie representing the primary index will be allocated according to
70 another parameter passed into the registration function.
71
72For example, kAFS (linux/fs/afs/) uses the following definitions to describe
73itself:
74
75 struct fscache_netfs afs_cache_netfs = {
76 .version = 0,
77 .name = "afs",
78 };
79
80
81================
82INDEX DEFINITION
83================
84
85Indices are used for two purposes:
86
87 (1) To aid the finding of a file based on a series of keys (such as AFS's
88 "cell", "volume ID", "vnode ID").
89
90 (2) To make it easier to discard a subset of all the files cached based around
91 a particular key - for instance to mirror the removal of an AFS volume.
92
93However, since it's unlikely that any two netfs's are going to want to define
94their index hierarchies in quite the same way, FS-Cache tries to impose as few
95restraints as possible on how an index is structured and where it is placed in
96the tree. The netfs can even mix indices and data files at the same level, but
97it's not recommended.
98
Lucas De Marchi25985ed2011-03-30 22:57:33 -030099Each index entry consists of a key of indeterminate length plus some auxiliary
David Howells2d6fff62009-04-03 16:42:36 +0100100data, also of indeterminate length.
101
102There are some limits on indices:
103
104 (1) Any index containing non-index objects should be restricted to a single
105 cache. Any such objects created within an index will be created in the
106 first cache only. The cache in which an index is created can be
107 controlled by cache tags (see below).
108
109 (2) The entry data must be atomically journallable, so it is limited to about
110 400 bytes at present. At least 400 bytes will be available.
111
112 (3) The depth of the index tree should be judged with care as the search
113 function is recursive. Too many layers will run the kernel out of stack.
114
115
116=================
117OBJECT DEFINITION
118=================
119
120To define an object, a structure of the following type should be filled out:
121
122 struct fscache_cookie_def
123 {
124 uint8_t name[16];
125 uint8_t type;
126
127 struct fscache_cache_tag *(*select_cache)(
128 const void *parent_netfs_data,
129 const void *cookie_netfs_data);
130
131 uint16_t (*get_key)(const void *cookie_netfs_data,
132 void *buffer,
133 uint16_t bufmax);
134
135 void (*get_attr)(const void *cookie_netfs_data,
136 uint64_t *size);
137
138 uint16_t (*get_aux)(const void *cookie_netfs_data,
139 void *buffer,
140 uint16_t bufmax);
141
142 enum fscache_checkaux (*check_aux)(void *cookie_netfs_data,
143 const void *data,
144 uint16_t datalen);
145
146 void (*get_context)(void *cookie_netfs_data, void *context);
147
148 void (*put_context)(void *cookie_netfs_data, void *context);
149
150 void (*mark_pages_cached)(void *cookie_netfs_data,
151 struct address_space *mapping,
152 struct pagevec *cached_pvec);
153
154 void (*now_uncached)(void *cookie_netfs_data);
155 };
156
157This has the following fields:
158
159 (1) The type of the object [mandatory].
160
161 This is one of the following values:
162
163 (*) FSCACHE_COOKIE_TYPE_INDEX
164
165 This defines an index, which is a special FS-Cache type.
166
167 (*) FSCACHE_COOKIE_TYPE_DATAFILE
168
169 This defines an ordinary data file.
170
171 (*) Any other value between 2 and 255
172
173 This defines an extraordinary object such as an XATTR.
174
175 (2) The name of the object type (NUL terminated unless all 16 chars are used)
176 [optional].
177
178 (3) A function to select the cache in which to store an index [optional].
179
180 This function is invoked when an index needs to be instantiated in a cache
181 during the instantiation of a non-index object. Only the immediate index
182 parent for the non-index object will be queried. Any indices above that
183 in the hierarchy may be stored in multiple caches. This function does not
184 need to be supplied for any non-index object or any index that will only
185 have index children.
186
187 If this function is not supplied or if it returns NULL then the first
Matt LaPlante19f59462009-04-27 15:06:31 +0200188 cache in the parent's list will be chosen, or failing that, the first
David Howells2d6fff62009-04-03 16:42:36 +0100189 cache in the master list.
190
191 (4) A function to retrieve an object's key from the netfs [mandatory].
192
193 This function will be called with the netfs data that was passed to the
194 cookie acquisition function and the maximum length of key data that it may
195 provide. It should write the required key data into the given buffer and
196 return the quantity it wrote.
197
198 (5) A function to retrieve attribute data from the netfs [optional].
199
200 This function will be called with the netfs data that was passed to the
201 cookie acquisition function. It should return the size of the file if
202 this is a data file. The size may be used to govern how much cache must
203 be reserved for this file in the cache.
204
205 If the function is absent, a file size of 0 is assumed.
206
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300207 (6) A function to retrieve auxiliary data from the netfs [optional].
David Howells2d6fff62009-04-03 16:42:36 +0100208
209 This function will be called with the netfs data that was passed to the
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300210 cookie acquisition function and the maximum length of auxiliary data that
211 it may provide. It should write the auxiliary data into the given buffer
David Howells2d6fff62009-04-03 16:42:36 +0100212 and return the quantity it wrote.
213
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300214 If this function is absent, the auxiliary data length will be set to 0.
David Howells2d6fff62009-04-03 16:42:36 +0100215
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300216 The length of the auxiliary data buffer may be dependent on the key
David Howells2d6fff62009-04-03 16:42:36 +0100217 length. A netfs mustn't rely on being able to provide more than 400 bytes
218 for both.
219
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300220 (7) A function to check the auxiliary data [optional].
David Howells2d6fff62009-04-03 16:42:36 +0100221
222 This function will be called to check that a match found in the cache for
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300223 this object is valid. For instance with AFS it could check the auxiliary
David Howells2d6fff62009-04-03 16:42:36 +0100224 data against the data version number returned by the server to determine
225 whether the index entry in a cache is still valid.
226
227 If this function is absent, it will be assumed that matching objects in a
228 cache are always valid.
229
230 If present, the function should return one of the following values:
231
232 (*) FSCACHE_CHECKAUX_OKAY - the entry is okay as is
233 (*) FSCACHE_CHECKAUX_NEEDS_UPDATE - the entry requires update
234 (*) FSCACHE_CHECKAUX_OBSOLETE - the entry should be deleted
235
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300236 This function can also be used to extract data from the auxiliary data in
David Howells2d6fff62009-04-03 16:42:36 +0100237 the cache and copy it into the netfs's structures.
238
239 (8) A pair of functions to manage contexts for the completion callback
240 [optional].
241
242 The cache read/write functions are passed a context which is then passed
243 to the I/O completion callback function. To ensure this context remains
244 valid until after the I/O completion is called, two functions may be
245 provided: one to get an extra reference on the context, and one to drop a
246 reference to it.
247
248 If the context is not used or is a type of object that won't go out of
249 scope, then these functions are not required. These functions are not
250 required for indices as indices may not contain data. These functions may
251 be called in interrupt context and so may not sleep.
252
253 (9) A function to mark a page as retaining cache metadata [optional].
254
255 This is called by the cache to indicate that it is retaining in-memory
256 information for this page and that the netfs should uncache the page when
257 it has finished. This does not indicate whether there's data on the disk
258 or not. Note that several pages at once may be presented for marking.
259
260 The PG_fscache bit is set on the pages before this function would be
261 called, so the function need not be provided if this is sufficient.
262
263 This function is not required for indices as they're not permitted data.
264
265(10) A function to unmark all the pages retaining cache metadata [mandatory].
266
267 This is called by FS-Cache to indicate that a backing store is being
268 unbound from a cookie and that all the marks on the pages should be
269 cleared to prevent confusion. Note that the cache will have torn down all
270 its tracking information so that the pages don't need to be explicitly
271 uncached.
272
273 This function is not required for indices as they're not permitted data.
274
275
276===================================
277NETWORK FILESYSTEM (UN)REGISTRATION
278===================================
279
280The first step is to declare the network filesystem to the cache. This also
281involves specifying the layout of the primary index (for AFS, this would be the
282"cell" level).
283
284The registration function is:
285
286 int fscache_register_netfs(struct fscache_netfs *netfs);
287
288It just takes a pointer to the netfs definition. It returns 0 or an error as
289appropriate.
290
291For kAFS, registration is done as follows:
292
293 ret = fscache_register_netfs(&afs_cache_netfs);
294
295The last step is, of course, unregistration:
296
297 void fscache_unregister_netfs(struct fscache_netfs *netfs);
298
299
300================
301CACHE TAG LOOKUP
302================
303
304FS-Cache permits the use of more than one cache. To permit particular index
305subtrees to be bound to particular caches, the second step is to look up cache
306representation tags. This step is optional; it can be left entirely up to
307FS-Cache as to which cache should be used. The problem with doing that is that
308FS-Cache will always pick the first cache that was registered.
309
310To get the representation for a named tag:
311
312 struct fscache_cache_tag *fscache_lookup_cache_tag(const char *name);
313
314This takes a text string as the name and returns a representation of a tag. It
315will never return an error. It may return a dummy tag, however, if it runs out
316of memory; this will inhibit caching with this tag.
317
318Any representation so obtained must be released by passing it to this function:
319
320 void fscache_release_cache_tag(struct fscache_cache_tag *tag);
321
322The tag will be retrieved by FS-Cache when it calls the object definition
323operation select_cache().
324
325
326==================
327INDEX REGISTRATION
328==================
329
330The third step is to inform FS-Cache about part of an index hierarchy that can
331be used to locate files. This is done by requesting a cookie for each index in
332the path to the file:
333
334 struct fscache_cookie *
335 fscache_acquire_cookie(struct fscache_cookie *parent,
336 const struct fscache_object_def *def,
337 void *netfs_data);
338
339This function creates an index entry in the index represented by parent,
340filling in the index entry by calling the operations pointed to by def.
341
342Note that this function never returns an error - all errors are handled
343internally. It may, however, return NULL to indicate no cookie. It is quite
344acceptable to pass this token back to this function as the parent to another
345acquisition (or even to the relinquish cookie, read page and write page
346functions - see below).
347
348Note also that no indices are actually created in a cache until a non-index
349object needs to be created somewhere down the hierarchy. Furthermore, an index
350may be created in several different caches independently at different times.
351This is all handled transparently, and the netfs doesn't see any of it.
352
353For example, with AFS, a cell would be added to the primary index. This index
354entry would have a dependent inode containing a volume location index for the
355volume mappings within this cell:
356
357 cell->cache =
358 fscache_acquire_cookie(afs_cache_netfs.primary_index,
359 &afs_cell_cache_index_def,
360 cell);
361
362Then when a volume location was accessed, it would be entered into the cell's
363index and an inode would be allocated that acts as a volume type and hash chain
364combination:
365
366 vlocation->cache =
367 fscache_acquire_cookie(cell->cache,
368 &afs_vlocation_cache_index_def,
369 vlocation);
370
371And then a particular flavour of volume (R/O for example) could be added to
372that index, creating another index for vnodes (AFS inode equivalents):
373
374 volume->cache =
375 fscache_acquire_cookie(vlocation->cache,
376 &afs_volume_cache_index_def,
377 volume);
378
379
380======================
381DATA FILE REGISTRATION
382======================
383
384The fourth step is to request a data file be created in the cache. This is
385identical to index cookie acquisition. The only difference is that the type in
386the object definition should be something other than index type.
387
388 vnode->cache =
389 fscache_acquire_cookie(volume->cache,
390 &afs_vnode_cache_object_def,
391 vnode);
392
393
394=================================
395MISCELLANEOUS OBJECT REGISTRATION
396=================================
397
398An optional step is to request an object of miscellaneous type be created in
399the cache. This is almost identical to index cookie acquisition. The only
400difference is that the type in the object definition should be something other
401than index type. Whilst the parent object could be an index, it's more likely
402it would be some other type of object such as a data file.
403
404 xattr->cache =
405 fscache_acquire_cookie(vnode->cache,
406 &afs_xattr_cache_object_def,
407 xattr);
408
409Miscellaneous objects might be used to store extended attributes or directory
410entries for example.
411
412
413==========================
414SETTING THE DATA FILE SIZE
415==========================
416
417The fifth step is to set the physical attributes of the file, such as its size.
418This doesn't automatically reserve any space in the cache, but permits the
419cache to adjust its metadata for data tracking appropriately:
420
421 int fscache_attr_changed(struct fscache_cookie *cookie);
422
423The cache will return -ENOBUFS if there is no backing cache or if there is no
424space to allocate any extra metadata required in the cache. The attributes
425will be accessed with the get_attr() cookie definition operation.
426
427Note that attempts to read or write data pages in the cache over this size may
428be rebuffed with -ENOBUFS.
429
430This operation schedules an attribute adjustment to happen asynchronously at
431some point in the future, and as such, it may happen after the function returns
432to the caller. The attribute adjustment excludes read and write operations.
433
434
435=====================
436PAGE READ/ALLOC/WRITE
437=====================
438
439And the sixth step is to store and retrieve pages in the cache. There are
440three functions that are used to do this.
441
442Note:
443
444 (1) A page should not be re-read or re-allocated without uncaching it first.
445
446 (2) A read or allocated page must be uncached when the netfs page is released
447 from the pagecache.
448
449 (3) A page should only be written to the cache if previous read or allocated.
450
451This permits the cache to maintain its page tracking in proper order.
452
453
454PAGE READ
455---------
456
457Firstly, the netfs should ask FS-Cache to examine the caches and read the
458contents cached for a particular page of a particular file if present, or else
459allocate space to store the contents if not:
460
461 typedef
462 void (*fscache_rw_complete_t)(struct page *page,
463 void *context,
464 int error);
465
466 int fscache_read_or_alloc_page(struct fscache_cookie *cookie,
467 struct page *page,
468 fscache_rw_complete_t end_io_func,
469 void *context,
470 gfp_t gfp);
471
472The cookie argument must specify a cookie for an object that isn't an index,
473the page specified will have the data loaded into it (and is also used to
474specify the page number), and the gfp argument is used to control how any
475memory allocations made are satisfied.
476
477If the cookie indicates the inode is not cached:
478
479 (1) The function will return -ENOBUFS.
480
481Else if there's a copy of the page resident in the cache:
482
483 (1) The mark_pages_cached() cookie operation will be called on that page.
484
485 (2) The function will submit a request to read the data from the cache's
486 backing device directly into the page specified.
487
488 (3) The function will return 0.
489
490 (4) When the read is complete, end_io_func() will be invoked with:
491
492 (*) The netfs data supplied when the cookie was created.
493
494 (*) The page descriptor.
495
496 (*) The context argument passed to the above function. This will be
497 maintained with the get_context/put_context functions mentioned above.
498
499 (*) An argument that's 0 on success or negative for an error code.
500
501 If an error occurs, it should be assumed that the page contains no usable
502 data.
503
504 end_io_func() will be called in process context if the read is results in
505 an error, but it might be called in interrupt context if the read is
506 successful.
507
508Otherwise, if there's not a copy available in cache, but the cache may be able
509to store the page:
510
511 (1) The mark_pages_cached() cookie operation will be called on that page.
512
513 (2) A block may be reserved in the cache and attached to the object at the
514 appropriate place.
515
516 (3) The function will return -ENODATA.
517
518This function may also return -ENOMEM or -EINTR, in which case it won't have
519read any data from the cache.
520
521
522PAGE ALLOCATE
523-------------
524
525Alternatively, if there's not expected to be any data in the cache for a page
526because the file has been extended, a block can simply be allocated instead:
527
528 int fscache_alloc_page(struct fscache_cookie *cookie,
529 struct page *page,
530 gfp_t gfp);
531
532This is similar to the fscache_read_or_alloc_page() function, except that it
533never reads from the cache. It will return 0 if a block has been allocated,
534rather than -ENODATA as the other would. One or the other must be performed
535before writing to the cache.
536
537The mark_pages_cached() cookie operation will be called on the page if
538successful.
539
540
541PAGE WRITE
542----------
543
544Secondly, if the netfs changes the contents of the page (either due to an
545initial download or if a user performs a write), then the page should be
546written back to the cache:
547
548 int fscache_write_page(struct fscache_cookie *cookie,
549 struct page *page,
550 gfp_t gfp);
551
552The cookie argument must specify a data file cookie, the page specified should
553contain the data to be written (and is also used to specify the page number),
554and the gfp argument is used to control how any memory allocations made are
555satisfied.
556
557The page must have first been read or allocated successfully and must not have
558been uncached before writing is performed.
559
560If the cookie indicates the inode is not cached then:
561
562 (1) The function will return -ENOBUFS.
563
564Else if space can be allocated in the cache to hold this page:
565
566 (1) PG_fscache_write will be set on the page.
567
568 (2) The function will submit a request to write the data to cache's backing
569 device directly from the page specified.
570
571 (3) The function will return 0.
572
573 (4) When the write is complete PG_fscache_write is cleared on the page and
574 anyone waiting for that bit will be woken up.
575
576Else if there's no space available in the cache, -ENOBUFS will be returned. It
577is also possible for the PG_fscache_write bit to be cleared when no write took
578place if unforeseen circumstances arose (such as a disk error).
579
580Writing takes place asynchronously.
581
582
583MULTIPLE PAGE READ
584------------------
585
586A facility is provided to read several pages at once, as requested by the
587readpages() address space operation:
588
589 int fscache_read_or_alloc_pages(struct fscache_cookie *cookie,
590 struct address_space *mapping,
591 struct list_head *pages,
592 int *nr_pages,
593 fscache_rw_complete_t end_io_func,
594 void *context,
595 gfp_t gfp);
596
597This works in a similar way to fscache_read_or_alloc_page(), except:
598
599 (1) Any page it can retrieve data for is removed from pages and nr_pages and
600 dispatched for reading to the disk. Reads of adjacent pages on disk may
601 be merged for greater efficiency.
602
603 (2) The mark_pages_cached() cookie operation will be called on several pages
604 at once if they're being read or allocated.
605
606 (3) If there was an general error, then that error will be returned.
607
608 Else if some pages couldn't be allocated or read, then -ENOBUFS will be
609 returned.
610
611 Else if some pages couldn't be read but were allocated, then -ENODATA will
612 be returned.
613
614 Otherwise, if all pages had reads dispatched, then 0 will be returned, the
615 list will be empty and *nr_pages will be 0.
616
617 (4) end_io_func will be called once for each page being read as the reads
618 complete. It will be called in process context if error != 0, but it may
619 be called in interrupt context if there is no error.
620
621Note that a return of -ENODATA, -ENOBUFS or any other error does not preclude
622some of the pages being read and some being allocated. Those pages will have
623been marked appropriately and will need uncaching.
624
625
626==============
627PAGE UNCACHING
628==============
629
630To uncache a page, this function should be called:
631
632 void fscache_uncache_page(struct fscache_cookie *cookie,
633 struct page *page);
634
635This function permits the cache to release any in-memory representation it
636might be holding for this netfs page. This function must be called once for
637each page on which the read or write page functions above have been called to
638make sure the cache's in-memory tracking information gets torn down.
639
640Note that pages can't be explicitly deleted from the a data file. The whole
641data file must be retired (see the relinquish cookie function below).
642
643Furthermore, note that this does not cancel the asynchronous read or write
644operation started by the read/alloc and write functions, so the page
David Howells201a1542009-11-19 18:11:35 +0000645invalidation functions must use:
David Howells2d6fff62009-04-03 16:42:36 +0100646
647 bool fscache_check_page_write(struct fscache_cookie *cookie,
648 struct page *page);
649
650to see if a page is being written to the cache, and:
651
652 void fscache_wait_on_page_write(struct fscache_cookie *cookie,
653 struct page *page);
654
655to wait for it to finish if it is.
656
657
David Howells201a1542009-11-19 18:11:35 +0000658When releasepage() is being implemented, a special FS-Cache function exists to
659manage the heuristics of coping with vmscan trying to eject pages, which may
660conflict with the cache trying to write pages to the cache (which may itself
661need to allocate memory):
662
663 bool fscache_maybe_release_page(struct fscache_cookie *cookie,
664 struct page *page,
665 gfp_t gfp);
666
667This takes the netfs cookie, and the page and gfp arguments as supplied to
668releasepage(). It will return false if the page cannot be released yet for
669some reason and if it returns true, the page has been uncached and can now be
670released.
671
672To make a page available for release, this function may wait for an outstanding
673storage request to complete, or it may attempt to cancel the storage request -
674in which case the page will not be stored in the cache this time.
675
676
David Howellsc902ce12011-07-07 12:19:48 +0100677BULK INODE PAGE UNCACHE
678-----------------------
679
680A convenience routine is provided to perform an uncache on all the pages
681attached to an inode. This assumes that the pages on the inode correspond on a
6821:1 basis with the pages in the cache.
683
684 void fscache_uncache_all_inode_pages(struct fscache_cookie *cookie,
685 struct inode *inode);
686
687This takes the netfs cookie that the pages were cached with and the inode that
688the pages are attached to. This function will wait for pages to finish being
689written to the cache and for the cache to finish with the page generally. No
690error is returned.
691
692
David Howellsda9803b2013-08-21 17:29:38 -0400693===============================
694INDEX AND DATA FILE CONSISTENCY
695===============================
696
697To find out whether auxiliary data for an object is up to data within the
698cache, the following function can be called:
699
700 int fscache_check_consistency(struct fscache_cookie *cookie)
701
702This will call back to the netfs to check whether the auxiliary data associated
703with a cookie is correct. It returns 0 if it is and -ESTALE if it isn't; it
704may also return -ENOMEM and -ERESTARTSYS.
David Howells2d6fff62009-04-03 16:42:36 +0100705
706To request an update of the index data for an index or other object, the
707following function should be called:
708
709 void fscache_update_cookie(struct fscache_cookie *cookie);
710
711This function will refer back to the netfs_data pointer stored in the cookie by
712the acquisition function to obtain the data to write into each revised index
713entry. The update method in the parent index definition will be called to
714transfer the data.
715
716Note that partial updates may happen automatically at other times, such as when
717data blocks are added to a data file object.
718
719
720===============================
721MISCELLANEOUS COOKIE OPERATIONS
722===============================
723
724There are a number of operations that can be used to control cookies:
725
726 (*) Cookie pinning:
727
728 int fscache_pin_cookie(struct fscache_cookie *cookie);
729 void fscache_unpin_cookie(struct fscache_cookie *cookie);
730
731 These operations permit data cookies to be pinned into the cache and to
732 have the pinning removed. They are not permitted on index cookies.
733
734 The pinning function will return 0 if successful, -ENOBUFS in the cookie
735 isn't backed by a cache, -EOPNOTSUPP if the cache doesn't support pinning,
736 -ENOSPC if there isn't enough space to honour the operation, -ENOMEM or
737 -EIO if there's any other problem.
738
739 (*) Data space reservation:
740
741 int fscache_reserve_space(struct fscache_cookie *cookie, loff_t size);
742
743 This permits a netfs to request cache space be reserved to store up to the
744 given amount of a file. It is permitted to ask for more than the current
745 size of the file to allow for future file expansion.
746
747 If size is given as zero then the reservation will be cancelled.
748
749 The function will return 0 if successful, -ENOBUFS in the cookie isn't
750 backed by a cache, -EOPNOTSUPP if the cache doesn't support reservations,
751 -ENOSPC if there isn't enough space to honour the operation, -ENOMEM or
752 -EIO if there's any other problem.
753
754 Note that this doesn't pin an object in a cache; it can still be culled to
755 make space if it's not in use.
756
757
758=====================
759COOKIE UNREGISTRATION
760=====================
761
762To get rid of a cookie, this function should be called.
763
764 void fscache_relinquish_cookie(struct fscache_cookie *cookie,
765 int retire);
766
767If retire is non-zero, then the object will be marked for recycling, and all
768copies of it will be removed from all active caches in which it is present.
769Not only that but all child objects will also be retired.
770
771If retire is zero, then the object may be available again when next the
772acquisition function is called. Retirement here will overrule the pinning on a
773cookie.
774
775One very important note - relinquish must NOT be called for a cookie unless all
776the cookies for "child" indices, objects and pages have been relinquished
777first.
778
779
David Howellsef778e72012-12-20 21:52:36 +0000780==================
781INDEX INVALIDATION
782==================
David Howells2d6fff62009-04-03 16:42:36 +0100783
David Howellsef778e72012-12-20 21:52:36 +0000784There is no direct way to invalidate an index subtree. To do this, the caller
785should relinquish and retire the cookie they have, and then acquire a new one.
786
787
788======================
789DATA FILE INVALIDATION
790======================
791
792Sometimes it will be necessary to invalidate an object that contains data.
793Typically this will be necessary when the server tells the netfs of a foreign
794change - at which point the netfs has to throw away all the state it had for an
795inode and reload from the server.
796
797To indicate that a cache object should be invalidated, the following function
798can be called:
799
800 void fscache_invalidate(struct fscache_cookie *cookie);
801
802This can be called with spinlocks held as it defers the work to a thread pool.
803All extant storage, retrieval and attribute change ops at this point are
804cancelled and discarded. Some future operations will be rejected until the
805cache has had a chance to insert a barrier in the operations queue. After
806that, operations will be queued again behind the invalidation operation.
807
808The invalidation operation will perform an attribute change operation and an
809auxiliary data update operation as it is very likely these will have changed.
810
811Using the following function, the netfs can wait for the invalidation operation
812to have reached a point at which it can start submitting ordinary operations
813once again:
814
815 void fscache_wait_on_invalidate(struct fscache_cookie *cookie);
David Howells2d6fff62009-04-03 16:42:36 +0100816
817
818===========================
819FS-CACHE SPECIFIC PAGE FLAG
820===========================
821
822FS-Cache makes use of a page flag, PG_private_2, for its own purpose. This is
823given the alternative name PG_fscache.
824
825PG_fscache is used to indicate that the page is known by the cache, and that
826the cache must be informed if the page is going to go away. It's an indication
827to the netfs that the cache has an interest in this page, where an interest may
828be a pointer to it, resources allocated or reserved for it, or I/O in progress
829upon it.
830
831The netfs can use this information in methods such as releasepage() to
832determine whether it needs to uncache a page or update it.
833
834Furthermore, if this bit is set, releasepage() and invalidatepage() operations
835will be called on a page to get rid of it, even if PG_private is not set. This
836allows caching to attempted on a page before read_cache_pages() to be called
837after fscache_read_or_alloc_pages() as the former will try and release pages it
838was given under certain circumstances.
839
840This bit does not overlap with such as PG_private. This means that FS-Cache
841can be used with a filesystem that uses the block buffering code.
842
843There are a number of operations defined on this flag:
844
845 int PageFsCache(struct page *page);
846 void SetPageFsCache(struct page *page)
847 void ClearPageFsCache(struct page *page)
848 int TestSetPageFsCache(struct page *page)
849 int TestClearPageFsCache(struct page *page)
850
851These functions are bit test, bit set, bit clear, bit test and set and bit
852test and clear operations on PG_fscache.