1 /* NFS filesystem cache interface definitions
3 * Copyright (C) 2008 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
12 #ifndef _NFS_FSCACHE_H
13 #define _NFS_FSCACHE_H
15 #include <linux/nfs_fs.h>
16 #include <linux/nfs_mount.h>
17 #include <linux/nfs4_mount.h>
18 #include <linux/fscache.h>
20 #ifdef CONFIG_NFS_FSCACHE
23 * set of NFS FS-Cache objects that form a superblock key
25 struct nfs_fscache_key {
27 struct nfs_client *nfs_client; /* the server */
29 /* the elements of the unique key - as used by nfs_compare_super() and
30 * nfs_compare_mount_options() to distinguish superblocks */
33 unsigned long s_flags; /* various flags
40 unsigned int rsize; /* read size */
41 unsigned int wsize; /* write size */
42 unsigned int acregmin; /* attr cache timeouts */
43 unsigned int acregmax;
44 unsigned int acdirmin;
45 unsigned int acdirmax;
49 rpc_authflavor_t au_flavor;
52 /* uniquifier - can be used if nfs_server.flags includes
53 * NFS_MOUNT_UNSHARED */
62 extern struct fscache_netfs nfs_fscache_netfs;
63 extern const struct fscache_cookie_def nfs_fscache_server_index_def;
64 extern const struct fscache_cookie_def nfs_fscache_super_index_def;
65 extern const struct fscache_cookie_def nfs_fscache_inode_object_def;
67 extern int nfs_fscache_register(void);
68 extern void nfs_fscache_unregister(void);
73 extern void nfs_fscache_get_client_cookie(struct nfs_client *);
74 extern void nfs_fscache_release_client_cookie(struct nfs_client *);
76 extern void nfs_fscache_get_super_cookie(struct super_block *, const char *, int);
77 extern void nfs_fscache_release_super_cookie(struct super_block *);
79 extern void nfs_fscache_init_inode_cookie(struct inode *);
80 extern void nfs_fscache_release_inode_cookie(struct inode *);
81 extern void nfs_fscache_zap_inode_cookie(struct inode *);
82 extern void nfs_fscache_set_inode_cookie(struct inode *, struct file *);
83 extern void nfs_fscache_reset_inode_cookie(struct inode *);
85 extern void __nfs_fscache_invalidate_page(struct page *, struct inode *);
86 extern int nfs_fscache_release_page(struct page *, gfp_t);
88 extern int __nfs_readpage_from_fscache(struct nfs_open_context *,
89 struct inode *, struct page *);
90 extern int __nfs_readpages_from_fscache(struct nfs_open_context *,
91 struct inode *, struct address_space *,
92 struct list_head *, unsigned *);
93 extern void __nfs_readpage_to_fscache(struct inode *, struct page *, int);
96 * wait for a page to complete writing to the cache
98 static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
101 if (PageFsCache(page))
102 fscache_wait_on_page_write(nfsi->fscache, page);
106 * release the caching state associated with a page if undergoing complete page
109 static inline void nfs_fscache_invalidate_page(struct page *page,
112 if (PageFsCache(page))
113 __nfs_fscache_invalidate_page(page, inode);
117 * Retrieve a page from an inode data storage object.
119 static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
123 if (NFS_I(inode)->fscache)
124 return __nfs_readpage_from_fscache(ctx, inode, page);
129 * Retrieve a set of pages from an inode data storage object.
131 static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
133 struct address_space *mapping,
134 struct list_head *pages,
137 if (NFS_I(inode)->fscache)
138 return __nfs_readpages_from_fscache(ctx, inode, mapping, pages,
144 * Store a page newly fetched from the server in an inode data storage object
147 static inline void nfs_readpage_to_fscache(struct inode *inode,
151 if (PageFsCache(page))
152 __nfs_readpage_to_fscache(inode, page, sync);
156 * Invalidate the contents of fscache for this inode. This will not sleep.
158 static inline void nfs_fscache_invalidate(struct inode *inode)
160 fscache_invalidate(NFS_I(inode)->fscache);
164 * Wait for an object to finish being invalidated.
166 static inline void nfs_fscache_wait_on_invalidate(struct inode *inode)
168 fscache_wait_on_invalidate(NFS_I(inode)->fscache);
172 * indicate the client caching state as readable text
174 static inline const char *nfs_server_fscache_state(struct nfs_server *server)
176 if (server->fscache && (server->options & NFS_OPTION_FSCACHE))
181 #else /* CONFIG_NFS_FSCACHE */
182 static inline int nfs_fscache_register(void) { return 0; }
183 static inline void nfs_fscache_unregister(void) {}
185 static inline void nfs_fscache_get_client_cookie(struct nfs_client *clp) {}
186 static inline void nfs_fscache_release_client_cookie(struct nfs_client *clp) {}
188 static inline void nfs_fscache_release_super_cookie(struct super_block *sb) {}
190 static inline void nfs_fscache_init_inode_cookie(struct inode *inode) {}
191 static inline void nfs_fscache_release_inode_cookie(struct inode *inode) {}
192 static inline void nfs_fscache_zap_inode_cookie(struct inode *inode) {}
193 static inline void nfs_fscache_set_inode_cookie(struct inode *inode,
194 struct file *filp) {}
195 static inline void nfs_fscache_reset_inode_cookie(struct inode *inode) {}
197 static inline int nfs_fscache_release_page(struct page *page, gfp_t gfp)
199 return 1; /* True: may release page */
201 static inline void nfs_fscache_invalidate_page(struct page *page,
202 struct inode *inode) {}
203 static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
204 struct page *page) {}
206 static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
212 static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
214 struct address_space *mapping,
215 struct list_head *pages,
220 static inline void nfs_readpage_to_fscache(struct inode *inode,
221 struct page *page, int sync) {}
224 static inline void nfs_fscache_invalidate(struct inode *inode) {}
225 static inline void nfs_fscache_wait_on_invalidate(struct inode *inode) {}
227 static inline const char *nfs_server_fscache_state(struct nfs_server *server)
232 #endif /* CONFIG_NFS_FSCACHE */
233 #endif /* _NFS_FSCACHE_H */