18ec442aeSDavid Howells /* NFS filesystem cache interface definitions 28ec442aeSDavid Howells * 38ec442aeSDavid Howells * Copyright (C) 2008 Red Hat, Inc. All Rights Reserved. 48ec442aeSDavid Howells * Written by David Howells (dhowells@redhat.com) 58ec442aeSDavid Howells * 68ec442aeSDavid Howells * This program is free software; you can redistribute it and/or 78ec442aeSDavid Howells * modify it under the terms of the GNU General Public Licence 88ec442aeSDavid Howells * as published by the Free Software Foundation; either version 98ec442aeSDavid Howells * 2 of the Licence, or (at your option) any later version. 108ec442aeSDavid Howells */ 118ec442aeSDavid Howells 128ec442aeSDavid Howells #ifndef _NFS_FSCACHE_H 138ec442aeSDavid Howells #define _NFS_FSCACHE_H 148ec442aeSDavid Howells 158ec442aeSDavid Howells #include <linux/nfs_fs.h> 168ec442aeSDavid Howells #include <linux/nfs_mount.h> 178ec442aeSDavid Howells #include <linux/nfs4_mount.h> 188ec442aeSDavid Howells #include <linux/fscache.h> 198ec442aeSDavid Howells 208ec442aeSDavid Howells #ifdef CONFIG_NFS_FSCACHE 218ec442aeSDavid Howells 228ec442aeSDavid Howells /* 2308734048SDavid Howells * set of NFS FS-Cache objects that form a superblock key 2408734048SDavid Howells */ 2508734048SDavid Howells struct nfs_fscache_key { 2608734048SDavid Howells struct rb_node node; 2708734048SDavid Howells struct nfs_client *nfs_client; /* the server */ 2808734048SDavid Howells 2908734048SDavid Howells /* the elements of the unique key - as used by nfs_compare_super() and 3008734048SDavid Howells * nfs_compare_mount_options() to distinguish superblocks */ 3108734048SDavid Howells struct { 3208734048SDavid Howells struct { 3308734048SDavid Howells unsigned long s_flags; /* various flags 3408734048SDavid Howells * (& NFS_MS_MASK) */ 3508734048SDavid Howells } super; 3608734048SDavid Howells 3708734048SDavid Howells struct { 3808734048SDavid Howells struct nfs_fsid fsid; 3908734048SDavid Howells int flags; 4008734048SDavid Howells unsigned int rsize; /* read size */ 4108734048SDavid Howells unsigned int wsize; /* write size */ 4208734048SDavid Howells unsigned int acregmin; /* attr cache timeouts */ 4308734048SDavid Howells unsigned int acregmax; 4408734048SDavid Howells unsigned int acdirmin; 4508734048SDavid Howells unsigned int acdirmax; 4608734048SDavid Howells } nfs_server; 4708734048SDavid Howells 4808734048SDavid Howells struct { 4908734048SDavid Howells rpc_authflavor_t au_flavor; 5008734048SDavid Howells } rpc_auth; 5108734048SDavid Howells 5208734048SDavid Howells /* uniquifier - can be used if nfs_server.flags includes 5308734048SDavid Howells * NFS_MOUNT_UNSHARED */ 5408734048SDavid Howells u8 uniq_len; 5508734048SDavid Howells char uniquifier[0]; 5608734048SDavid Howells } key; 5708734048SDavid Howells }; 5808734048SDavid Howells 5908734048SDavid Howells /* 60402cb8ddSDavid Howells * Definition of the auxiliary data attached to NFS inode storage objects 61402cb8ddSDavid Howells * within the cache. 62402cb8ddSDavid Howells * 63402cb8ddSDavid Howells * The contents of this struct are recorded in the on-disk local cache in the 64402cb8ddSDavid Howells * auxiliary data attached to the data storage object backing an inode. This 65402cb8ddSDavid Howells * permits coherency to be managed when a new inode binds to an already extant 66402cb8ddSDavid Howells * cache object. 67402cb8ddSDavid Howells */ 68402cb8ddSDavid Howells struct nfs_fscache_inode_auxdata { 69402cb8ddSDavid Howells struct timespec mtime; 70402cb8ddSDavid Howells struct timespec ctime; 71402cb8ddSDavid Howells loff_t size; 72402cb8ddSDavid Howells u64 change_attr; 73402cb8ddSDavid Howells }; 74402cb8ddSDavid Howells 75402cb8ddSDavid Howells /* 768ec442aeSDavid Howells * fscache-index.c 778ec442aeSDavid Howells */ 788ec442aeSDavid Howells extern struct fscache_netfs nfs_fscache_netfs; 7914727281SDavid Howells extern const struct fscache_cookie_def nfs_fscache_server_index_def; 8008734048SDavid Howells extern const struct fscache_cookie_def nfs_fscache_super_index_def; 8110329a5dSDavid Howells extern const struct fscache_cookie_def nfs_fscache_inode_object_def; 828ec442aeSDavid Howells 838ec442aeSDavid Howells extern int nfs_fscache_register(void); 848ec442aeSDavid Howells extern void nfs_fscache_unregister(void); 858ec442aeSDavid Howells 8614727281SDavid Howells /* 8714727281SDavid Howells * fscache.c 8814727281SDavid Howells */ 8914727281SDavid Howells extern void nfs_fscache_get_client_cookie(struct nfs_client *); 9014727281SDavid Howells extern void nfs_fscache_release_client_cookie(struct nfs_client *); 9114727281SDavid Howells 922311b943SBryan Schumaker extern void nfs_fscache_get_super_cookie(struct super_block *, const char *, int); 9308734048SDavid Howells extern void nfs_fscache_release_super_cookie(struct super_block *); 9408734048SDavid Howells 95f1fe29b4SDavid Howells extern void nfs_fscache_init_inode(struct inode *); 96f1fe29b4SDavid Howells extern void nfs_fscache_clear_inode(struct inode *); 97f1fe29b4SDavid Howells extern void nfs_fscache_open_file(struct inode *, struct file *); 98ef79c097SDavid Howells 99545db45fSDavid Howells extern void __nfs_fscache_invalidate_page(struct page *, struct inode *); 100545db45fSDavid Howells extern int nfs_fscache_release_page(struct page *, gfp_t); 101545db45fSDavid Howells 1029a9fc1c0SDavid Howells extern int __nfs_readpage_from_fscache(struct nfs_open_context *, 1039a9fc1c0SDavid Howells struct inode *, struct page *); 1049a9fc1c0SDavid Howells extern int __nfs_readpages_from_fscache(struct nfs_open_context *, 1059a9fc1c0SDavid Howells struct inode *, struct address_space *, 1069a9fc1c0SDavid Howells struct list_head *, unsigned *); 1077f8e05f6SDavid Howells extern void __nfs_readpage_to_fscache(struct inode *, struct page *, int); 1089a9fc1c0SDavid Howells 109545db45fSDavid Howells /* 110545db45fSDavid Howells * wait for a page to complete writing to the cache 111545db45fSDavid Howells */ 112545db45fSDavid Howells static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi, 113545db45fSDavid Howells struct page *page) 114545db45fSDavid Howells { 115545db45fSDavid Howells if (PageFsCache(page)) 116545db45fSDavid Howells fscache_wait_on_page_write(nfsi->fscache, page); 117545db45fSDavid Howells } 118545db45fSDavid Howells 119545db45fSDavid Howells /* 120545db45fSDavid Howells * release the caching state associated with a page if undergoing complete page 121545db45fSDavid Howells * invalidation 122545db45fSDavid Howells */ 123545db45fSDavid Howells static inline void nfs_fscache_invalidate_page(struct page *page, 124545db45fSDavid Howells struct inode *inode) 125545db45fSDavid Howells { 126545db45fSDavid Howells if (PageFsCache(page)) 127545db45fSDavid Howells __nfs_fscache_invalidate_page(page, inode); 128545db45fSDavid Howells } 129545db45fSDavid Howells 1309a9fc1c0SDavid Howells /* 1319a9fc1c0SDavid Howells * Retrieve a page from an inode data storage object. 1329a9fc1c0SDavid Howells */ 1339a9fc1c0SDavid Howells static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx, 1349a9fc1c0SDavid Howells struct inode *inode, 1359a9fc1c0SDavid Howells struct page *page) 1369a9fc1c0SDavid Howells { 1379a9fc1c0SDavid Howells if (NFS_I(inode)->fscache) 1389a9fc1c0SDavid Howells return __nfs_readpage_from_fscache(ctx, inode, page); 1399a9fc1c0SDavid Howells return -ENOBUFS; 1409a9fc1c0SDavid Howells } 1419a9fc1c0SDavid Howells 1429a9fc1c0SDavid Howells /* 1439a9fc1c0SDavid Howells * Retrieve a set of pages from an inode data storage object. 1449a9fc1c0SDavid Howells */ 1459a9fc1c0SDavid Howells static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx, 1469a9fc1c0SDavid Howells struct inode *inode, 1479a9fc1c0SDavid Howells struct address_space *mapping, 1489a9fc1c0SDavid Howells struct list_head *pages, 1499a9fc1c0SDavid Howells unsigned *nr_pages) 1509a9fc1c0SDavid Howells { 1519a9fc1c0SDavid Howells if (NFS_I(inode)->fscache) 1529a9fc1c0SDavid Howells return __nfs_readpages_from_fscache(ctx, inode, mapping, pages, 1539a9fc1c0SDavid Howells nr_pages); 1549a9fc1c0SDavid Howells return -ENOBUFS; 1559a9fc1c0SDavid Howells } 156545db45fSDavid Howells 1577f8e05f6SDavid Howells /* 1587f8e05f6SDavid Howells * Store a page newly fetched from the server in an inode data storage object 1597f8e05f6SDavid Howells * in the cache. 1607f8e05f6SDavid Howells */ 1617f8e05f6SDavid Howells static inline void nfs_readpage_to_fscache(struct inode *inode, 1627f8e05f6SDavid Howells struct page *page, 1637f8e05f6SDavid Howells int sync) 1647f8e05f6SDavid Howells { 1657f8e05f6SDavid Howells if (PageFsCache(page)) 1667f8e05f6SDavid Howells __nfs_readpage_to_fscache(inode, page, sync); 1677f8e05f6SDavid Howells } 1687f8e05f6SDavid Howells 1695d1acff1SDavid Howells /* 170de242c0bSDavid Howells * Invalidate the contents of fscache for this inode. This will not sleep. 171de242c0bSDavid Howells */ 172de242c0bSDavid Howells static inline void nfs_fscache_invalidate(struct inode *inode) 173de242c0bSDavid Howells { 174de242c0bSDavid Howells fscache_invalidate(NFS_I(inode)->fscache); 175de242c0bSDavid Howells } 176de242c0bSDavid Howells 177de242c0bSDavid Howells /* 178de242c0bSDavid Howells * Wait for an object to finish being invalidated. 179de242c0bSDavid Howells */ 180de242c0bSDavid Howells static inline void nfs_fscache_wait_on_invalidate(struct inode *inode) 181de242c0bSDavid Howells { 182de242c0bSDavid Howells fscache_wait_on_invalidate(NFS_I(inode)->fscache); 183de242c0bSDavid Howells } 184de242c0bSDavid Howells 185de242c0bSDavid Howells /* 1865d1acff1SDavid Howells * indicate the client caching state as readable text 1875d1acff1SDavid Howells */ 1885d1acff1SDavid Howells static inline const char *nfs_server_fscache_state(struct nfs_server *server) 1895d1acff1SDavid Howells { 1905d1acff1SDavid Howells if (server->fscache && (server->options & NFS_OPTION_FSCACHE)) 1915d1acff1SDavid Howells return "yes"; 1925d1acff1SDavid Howells return "no "; 1935d1acff1SDavid Howells } 1945d1acff1SDavid Howells 1958ec442aeSDavid Howells #else /* CONFIG_NFS_FSCACHE */ 1968ec442aeSDavid Howells static inline int nfs_fscache_register(void) { return 0; } 1978ec442aeSDavid Howells static inline void nfs_fscache_unregister(void) {} 1988ec442aeSDavid Howells 19914727281SDavid Howells static inline void nfs_fscache_get_client_cookie(struct nfs_client *clp) {} 20014727281SDavid Howells static inline void nfs_fscache_release_client_cookie(struct nfs_client *clp) {} 20114727281SDavid Howells 20208734048SDavid Howells static inline void nfs_fscache_release_super_cookie(struct super_block *sb) {} 20308734048SDavid Howells 204f1fe29b4SDavid Howells static inline void nfs_fscache_init_inode(struct inode *inode) {} 205f1fe29b4SDavid Howells static inline void nfs_fscache_clear_inode(struct inode *inode) {} 206f1fe29b4SDavid Howells static inline void nfs_fscache_open_file(struct inode *inode, 207ef79c097SDavid Howells struct file *filp) {} 208ef79c097SDavid Howells 209545db45fSDavid Howells static inline int nfs_fscache_release_page(struct page *page, gfp_t gfp) 210545db45fSDavid Howells { 211545db45fSDavid Howells return 1; /* True: may release page */ 212545db45fSDavid Howells } 213545db45fSDavid Howells static inline void nfs_fscache_invalidate_page(struct page *page, 214545db45fSDavid Howells struct inode *inode) {} 215545db45fSDavid Howells static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi, 216545db45fSDavid Howells struct page *page) {} 217545db45fSDavid Howells 2189a9fc1c0SDavid Howells static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx, 2199a9fc1c0SDavid Howells struct inode *inode, 2209a9fc1c0SDavid Howells struct page *page) 2219a9fc1c0SDavid Howells { 2229a9fc1c0SDavid Howells return -ENOBUFS; 2239a9fc1c0SDavid Howells } 2249a9fc1c0SDavid Howells static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx, 2259a9fc1c0SDavid Howells struct inode *inode, 2269a9fc1c0SDavid Howells struct address_space *mapping, 2279a9fc1c0SDavid Howells struct list_head *pages, 2289a9fc1c0SDavid Howells unsigned *nr_pages) 2299a9fc1c0SDavid Howells { 2309a9fc1c0SDavid Howells return -ENOBUFS; 2319a9fc1c0SDavid Howells } 2327f8e05f6SDavid Howells static inline void nfs_readpage_to_fscache(struct inode *inode, 2337f8e05f6SDavid Howells struct page *page, int sync) {} 2349a9fc1c0SDavid Howells 235de242c0bSDavid Howells 236de242c0bSDavid Howells static inline void nfs_fscache_invalidate(struct inode *inode) {} 237c129c293SDavid Howells static inline void nfs_fscache_wait_on_invalidate(struct inode *inode) {} 238de242c0bSDavid Howells 2395d1acff1SDavid Howells static inline const char *nfs_server_fscache_state(struct nfs_server *server) 2405d1acff1SDavid Howells { 2415d1acff1SDavid Howells return "no "; 2425d1acff1SDavid Howells } 2435d1acff1SDavid Howells 2448ec442aeSDavid Howells #endif /* CONFIG_NFS_FSCACHE */ 2458ec442aeSDavid Howells #endif /* _NFS_FSCACHE_H */ 246