linux/fs/fscache
David Howells ccc4fc3d11 FS-Cache: Implement the cookie management part of the netfs API
Implement the cookie management part of the FS-Cache netfs client API.  The
documentation and API header file were added in a previous patch.

This patch implements the following three functions:

 (1) fscache_acquire_cookie().

     Acquire a cookie to represent an object to the netfs.  If the object in
     question is a non-index object, then that object and its parent indices
     will be created on disk at this point if they don't already exist.  Index
     creation is deferred because an index may reside in multiple caches.

 (2) fscache_relinquish_cookie().

     Retire or release a cookie previously acquired.  At this point, the
     object on disk may be destroyed.

 (3) fscache_update_cookie().

     Update the in-cache representation of a cookie.  This is used to update
     the auxiliary data for coherency management purposes.

With this patch it is possible to have a netfs instruct a cache backend to
look up, validate and create metadata on disk and to destroy it again.
The ability to actually store and retrieve data in the objects so created is
added in later patches.

Note that these functions will never return an error.  _All_ errors are
handled internally to FS-Cache.

The worst that can happen is that fscache_acquire_cookie() may return a NULL
pointer - which is considered a negative cookie pointer and can be passed back
to any function that takes a cookie without harm.  A negative cookie pointer
merely suppresses caching at that level.

The stub in linux/fscache.h will detect inline the negative cookie pointer and
abort the operation as fast as possible.  This means that the compiler doesn't
have to set up for a call in that case.

See the documentation in Documentation/filesystems/caching/netfs-api.txt for
more information.

Signed-off-by: David Howells <dhowells@redhat.com>
Acked-by: Steve Dickson <steved@redhat.com>
Acked-by: Trond Myklebust <Trond.Myklebust@netapp.com>
Acked-by: Al Viro <viro@zeniv.linux.org.uk>
Tested-by: Daire Byrne <Daire.Byrne@framestore.com>
2009-04-03 16:42:38 +01:00
..
cache.c FS-Cache: Add cache management 2009-04-03 16:42:37 +01:00
cookie.c FS-Cache: Implement the cookie management part of the netfs API 2009-04-03 16:42:38 +01:00
fsdef.c FS-Cache: Root index definition 2009-04-03 16:42:37 +01:00
histogram.c FS-Cache: Add use of /proc and presentation of statistics 2009-04-03 16:42:37 +01:00
internal.h FS-Cache: Object management state machine 2009-04-03 16:42:38 +01:00
Kconfig FS-Cache: Add use of /proc and presentation of statistics 2009-04-03 16:42:37 +01:00
main.c FS-Cache: Bit waiting helpers 2009-04-03 16:42:38 +01:00
Makefile FS-Cache: Object management state machine 2009-04-03 16:42:38 +01:00
netfs.c FS-Cache: Add netfs registration 2009-04-03 16:42:38 +01:00
object.c FS-Cache: Object management state machine 2009-04-03 16:42:38 +01:00
proc.c FS-Cache: Add use of /proc and presentation of statistics 2009-04-03 16:42:37 +01:00
stats.c FS-Cache: Add use of /proc and presentation of statistics 2009-04-03 16:42:37 +01:00