fs/cifs/fscache.h

   1 /*
   2  *   fs/cifs/fscache.h - CIFS filesystem cache interface definitions
   3  *
   4  *   Copyright (c) 2010 Novell, Inc.
   5  *   Authors(s): Suresh Jayaraman (sjayaraman@suse.de>
   6  *
   7  *   This library is free software; you can redistribute it and/or modify
   8  *   it under the terms of the GNU Lesser General Public License as published
   9  *   by the Free Software Foundation; either version 2.1 of the License, or
  10  *   (at your option) any later version.
  11  *
  12  *   This library is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  15  *   the GNU Lesser General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU Lesser General Public License
  18  *   along with this library; if not, write to the Free Software
  19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  */
  21 #ifndef _CIFS_FSCACHE_H
  22 #define _CIFS_FSCACHE_H
  23
  24 #include <linux/fscache.h>
  25
  26 #include "cifsglob.h"
  27
  28 #ifdef CONFIG_CIFS_FSCACHE
  29
  30 /*
  31  * Auxiliary data attached to CIFS inode within the cache
  32  */
  33 struct cifs_fscache_inode_auxdata {
  34         struct timespec last_write_time;
  35         struct timespec last_change_time;
  36         u64             eof;
  37 };
  38
  39 /*
  40  * cache.c
  41  */
  42 extern struct fscache_netfs cifs_fscache_netfs;
  43 extern const struct fscache_cookie_def cifs_fscache_server_index_def;
  44 extern const struct fscache_cookie_def cifs_fscache_super_index_def;
  45 extern const struct fscache_cookie_def cifs_fscache_inode_object_def;
  46
  47 extern int cifs_fscache_register(void);
  48 extern void cifs_fscache_unregister(void);
  49 extern char *extract_sharename(const char *);
  50
  51 /*
  52  * fscache.c
  53  */
  54 extern void cifs_fscache_get_client_cookie(struct TCP_Server_Info *);
  55 extern void cifs_fscache_release_client_cookie(struct TCP_Server_Info *);
  56 extern void cifs_fscache_get_super_cookie(struct cifs_tcon *);
  57 extern void cifs_fscache_release_super_cookie(struct cifs_tcon *);
  58
  59 extern void cifs_fscache_release_inode_cookie(struct inode *);
  60 extern void cifs_fscache_set_inode_cookie(struct inode *, struct file *);
  61 extern void cifs_fscache_reset_inode_cookie(struct inode *);
  62
  63 extern void __cifs_fscache_invalidate_page(struct page *, struct inode *);
  64 extern int cifs_fscache_release_page(struct page *page, gfp_t gfp);
  65 extern int __cifs_readpage_from_fscache(struct inode *, struct page *);
  66 extern int __cifs_readpages_from_fscache(struct inode *,
  67                                          struct address_space *,
  68                                          struct list_head *,
  69                                          unsigned *);
  70 extern void __cifs_fscache_readpages_cancel(struct inode *, struct list_head *);
  71
  72 extern void __cifs_readpage_to_fscache(struct inode *, struct page *);
  73
  74 static inline void cifs_fscache_invalidate_page(struct page *page,
  75                                                struct inode *inode)
  76 {
  77         if (PageFsCache(page))
  78                 __cifs_fscache_invalidate_page(page, inode);
  79 }
  80
  81 static inline int cifs_readpage_from_fscache(struct inode *inode,
  82                                              struct page *page)
  83 {
  84         if (CIFS_I(inode)->fscache)
  85                 return __cifs_readpage_from_fscache(inode, page);
  86
  87         return -ENOBUFS;
  88 }
  89
  90 static inline int cifs_readpages_from_fscache(struct inode *inode,
  91                                               struct address_space *mapping,
  92                                               struct list_head *pages,
  93                                               unsigned *nr_pages)
  94 {
  95         if (CIFS_I(inode)->fscache)
  96                 return __cifs_readpages_from_fscache(inode, mapping, pages,
  97                                                      nr_pages);
  98         return -ENOBUFS;
  99 }
 100
 101 static inline void cifs_readpage_to_fscache(struct inode *inode,
 102                                             struct page *page)
 103 {
 104         if (PageFsCache(page))
 105                 __cifs_readpage_to_fscache(inode, page);
 106 }
 107
 108 static inline void cifs_fscache_readpages_cancel(struct inode *inode,
 109                                                  struct list_head *pages)
 110 {
 111         if (CIFS_I(inode)->fscache)
 112                 return __cifs_fscache_readpages_cancel(inode, pages);
 113 }
 114
 115 #else /* CONFIG_CIFS_FSCACHE */
 116 static inline int cifs_fscache_register(void) { return 0; }
 117 static inline void cifs_fscache_unregister(void) {}
 118
 119 static inline void
 120 cifs_fscache_get_client_cookie(struct TCP_Server_Info *server) {}
 121 static inline void
 122 cifs_fscache_release_client_cookie(struct TCP_Server_Info *server) {}
 123 static inline void cifs_fscache_get_super_cookie(struct cifs_tcon *tcon) {}
 124 static inline void
 125 cifs_fscache_release_super_cookie(struct cifs_tcon *tcon) {}
 126
 127 static inline void cifs_fscache_release_inode_cookie(struct inode *inode) {}
 128 static inline void cifs_fscache_set_inode_cookie(struct inode *inode,
 129                                                  struct file *filp) {}
 130 static inline void cifs_fscache_reset_inode_cookie(struct inode *inode) {}
 131 static inline int cifs_fscache_release_page(struct page *page, gfp_t gfp)
 132 {
 133         return 1; /* May release page */
 134 }
 135
 136 static inline void cifs_fscache_invalidate_page(struct page *page,
 137                         struct inode *inode) {}
 138 static inline int
 139 cifs_readpage_from_fscache(struct inode *inode, struct page *page)
 140 {
 141         return -ENOBUFS;
 142 }
 143
 144 static inline int cifs_readpages_from_fscache(struct inode *inode,
 145                                               struct address_space *mapping,
 146                                               struct list_head *pages,
 147                                               unsigned *nr_pages)
 148 {
 149         return -ENOBUFS;
 150 }
 151
 152 static inline void cifs_readpage_to_fscache(struct inode *inode,
 153                         struct page *page) {}
 154
 155 static inline void cifs_fscache_readpages_cancel(struct inode *inode,
 156                                                  struct list_head *pages)
 157 {
 158 }
 159
 160 #endif /* CONFIG_CIFS_FSCACHE */
 161
 162 #endif /* _CIFS_FSCACHE_H */