fs/nfs/fscache.h

   1 /* NFS filesystem cache interface definitions
   2  *
   3  * Copyright (C) 2008 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 Licence
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the Licence, or (at your option) any later version.
  10  */
  11
  12 #ifndef _NFS_FSCACHE_H
  13 #define _NFS_FSCACHE_H
  14
  15 #include <linux/nfs_fs.h>
  16 #include <linux/nfs_mount.h>
  17 #include <linux/nfs4_mount.h>
  18 #include <linux/fscache.h>
  19
  20 #ifdef CONFIG_NFS_FSCACHE
  21
  22 /*
  23  * set of NFS FS-Cache objects that form a superblock key
  24  */
  25 struct nfs_fscache_key {
  26         struct rb_node          node;
  27         struct nfs_client       *nfs_client;    /* the server */
  28
  29         /* the elements of the unique key - as used by nfs_compare_super() and
  30          * nfs_compare_mount_options() to distinguish superblocks */
  31         struct {
  32                 struct {
  33                         unsigned long   s_flags;        /* various flags
  34                                                          * (& NFS_MS_MASK) */
  35                 } super;
  36
  37                 struct {
  38                         struct nfs_fsid fsid;
  39                         int             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;
  46                 } nfs_server;
  47
  48                 struct {
  49                         rpc_authflavor_t au_flavor;
  50                 } rpc_auth;
  51
  52                 /* uniquifier - can be used if nfs_server.flags includes
  53                  * NFS_MOUNT_UNSHARED  */
  54                 u8 uniq_len;
  55                 char uniquifier[0];
  56         } key;
  57 };
  58
  59 /*
  60  * Definition of the auxiliary data attached to NFS inode storage objects
  61  * within the cache.
  62  *
  63  * The contents of this struct are recorded in the on-disk local cache in the
  64  * auxiliary data attached to the data storage object backing an inode.  This
  65  * permits coherency to be managed when a new inode binds to an already extant
  66  * cache object.
  67  */
  68 struct nfs_fscache_inode_auxdata {
  69         struct timespec mtime;
  70         struct timespec ctime;
  71         loff_t          size;
  72         u64             change_attr;
  73 };
  74
  75 /*
  76  * fscache-index.c
  77  */
  78 extern struct fscache_netfs nfs_fscache_netfs;
  79 extern const struct fscache_cookie_def nfs_fscache_server_index_def;
  80 extern const struct fscache_cookie_def nfs_fscache_super_index_def;
  81 extern const struct fscache_cookie_def nfs_fscache_inode_object_def;
  82
  83 extern int nfs_fscache_register(void);
  84 extern void nfs_fscache_unregister(void);
  85
  86 /*
  87  * fscache.c
  88  */
  89 extern void nfs_fscache_get_client_cookie(struct nfs_client *);
  90 extern void nfs_fscache_release_client_cookie(struct nfs_client *);
  91
  92 extern void nfs_fscache_get_super_cookie(struct super_block *, const char *, int);
  93 extern void nfs_fscache_release_super_cookie(struct super_block *);
  94
  95 extern void nfs_fscache_init_inode(struct inode *);
  96 extern void nfs_fscache_clear_inode(struct inode *);
  97 extern void nfs_fscache_open_file(struct inode *, struct file *);
  98
  99 extern void __nfs_fscache_invalidate_page(struct page *, struct inode *);
 100 extern int nfs_fscache_release_page(struct page *, gfp_t);
 101
 102 extern int __nfs_readpage_from_fscache(struct nfs_open_context *,
 103                                        struct inode *, struct page *);
 104 extern int __nfs_readpages_from_fscache(struct nfs_open_context *,
 105                                         struct inode *, struct address_space *,
 106                                         struct list_head *, unsigned *);
 107 extern void __nfs_readpage_to_fscache(struct inode *, struct page *, int);
 108
 109 /*
 110  * wait for a page to complete writing to the cache
 111  */
 112 static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
 113                                                   struct page *page)
 114 {
 115         if (PageFsCache(page))
 116                 fscache_wait_on_page_write(nfsi->fscache, page);
 117 }
 118
 119 /*
 120  * release the caching state associated with a page if undergoing complete page
 121  * invalidation
 122  */
 123 static inline void nfs_fscache_invalidate_page(struct page *page,
 124                                                struct inode *inode)
 125 {
 126         if (PageFsCache(page))
 127                 __nfs_fscache_invalidate_page(page, inode);
 128 }
 129
 130 /*
 131  * Retrieve a page from an inode data storage object.
 132  */
 133 static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
 134                                             struct inode *inode,
 135                                             struct page *page)
 136 {
 137         if (NFS_I(inode)->fscache)
 138                 return __nfs_readpage_from_fscache(ctx, inode, page);
 139         return -ENOBUFS;
 140 }
 141
 142 /*
 143  * Retrieve a set of pages from an inode data storage object.
 144  */
 145 static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
 146                                              struct inode *inode,
 147                                              struct address_space *mapping,
 148                                              struct list_head *pages,
 149                                              unsigned *nr_pages)
 150 {
 151         if (NFS_I(inode)->fscache)
 152                 return __nfs_readpages_from_fscache(ctx, inode, mapping, pages,
 153                                                     nr_pages);
 154         return -ENOBUFS;
 155 }
 156
 157 /*
 158  * Store a page newly fetched from the server in an inode data storage object
 159  * in the cache.
 160  */
 161 static inline void nfs_readpage_to_fscache(struct inode *inode,
 162                                            struct page *page,
 163                                            int sync)
 164 {
 165         if (PageFsCache(page))
 166                 __nfs_readpage_to_fscache(inode, page, sync);
 167 }
 168
 169 /*
 170  * Invalidate the contents of fscache for this inode.  This will not sleep.
 171  */
 172 static inline void nfs_fscache_invalidate(struct inode *inode)
 173 {
 174         fscache_invalidate(NFS_I(inode)->fscache);
 175 }
 176
 177 /*
 178  * Wait for an object to finish being invalidated.
 179  */
 180 static inline void nfs_fscache_wait_on_invalidate(struct inode *inode)
 181 {
 182         fscache_wait_on_invalidate(NFS_I(inode)->fscache);
 183 }
 184
 185 /*
 186  * indicate the client caching state as readable text
 187  */
 188 static inline const char *nfs_server_fscache_state(struct nfs_server *server)
 189 {
 190         if (server->fscache && (server->options & NFS_OPTION_FSCACHE))
 191                 return "yes";
 192         return "no ";
 193 }
 194
 195 #else /* CONFIG_NFS_FSCACHE */
 196 static inline int nfs_fscache_register(void) { return 0; }
 197 static inline void nfs_fscache_unregister(void) {}
 198
 199 static inline void nfs_fscache_get_client_cookie(struct nfs_client *clp) {}
 200 static inline void nfs_fscache_release_client_cookie(struct nfs_client *clp) {}
 201
 202 static inline void nfs_fscache_release_super_cookie(struct super_block *sb) {}
 203
 204 static inline void nfs_fscache_init_inode(struct inode *inode) {}
 205 static inline void nfs_fscache_clear_inode(struct inode *inode) {}
 206 static inline void nfs_fscache_open_file(struct inode *inode,
 207                                          struct file *filp) {}
 208
 209 static inline int nfs_fscache_release_page(struct page *page, gfp_t gfp)
 210 {
 211         return 1; /* True: may release page */
 212 }
 213 static inline void nfs_fscache_invalidate_page(struct page *page,
 214                                                struct inode *inode) {}
 215 static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
 216                                                   struct page *page) {}
 217
 218 static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
 219                                             struct inode *inode,
 220                                             struct page *page)
 221 {
 222         return -ENOBUFS;
 223 }
 224 static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
 225                                              struct inode *inode,
 226                                              struct address_space *mapping,
 227                                              struct list_head *pages,
 228                                              unsigned *nr_pages)
 229 {
 230         return -ENOBUFS;
 231 }
 232 static inline void nfs_readpage_to_fscache(struct inode *inode,
 233                                            struct page *page, int sync) {}
 234
 235
 236 static inline void nfs_fscache_invalidate(struct inode *inode) {}
 237 static inline void nfs_fscache_wait_on_invalidate(struct inode *inode) {}
 238
 239 static inline const char *nfs_server_fscache_state(struct nfs_server *server)
 240 {
 241         return "no ";
 242 }
 243
 244 #endif /* CONFIG_NFS_FSCACHE */
 245 #endif /* _NFS_FSCACHE_H */