fs/cifs/fscache.h

   1 /* SPDX-License-Identifier: LGPL-2.1 */
   2 /*
   3  *   fs/cifs/fscache.h - CIFS filesystem cache interface definitions
   4  *
   5  *   Copyright (c) 2010 Novell, Inc.
   6  *   Authors(s): Suresh Jayaraman (sjayaraman@suse.de>
   7  *
   8  */
   9 #ifndef _CIFS_FSCACHE_H
  10 #define _CIFS_FSCACHE_H
  11
  12 #include <linux/fscache.h>
  13
  14 #include "cifsglob.h"
  15
  16 #ifdef CONFIG_CIFS_FSCACHE
  17
  18 /*
  19  * Auxiliary data attached to CIFS superblock within the cache
  20  */
  21 struct cifs_fscache_super_auxdata {
  22         u64     resource_id;            /* unique server resource id */
  23         __le64  vol_create_time;
  24         u32     vol_serial_number;
  25 } __packed;
  26
  27 /*
  28  * Auxiliary data attached to CIFS inode within the cache
  29  */
  30 struct cifs_fscache_inode_auxdata {
  31         u64 last_write_time_sec;
  32         u64 last_change_time_sec;
  33         u32 last_write_time_nsec;
  34         u32 last_change_time_nsec;
  35         u64 eof;
  36 };
  37
  38 /*
  39  * cache.c
  40  */
  41 extern struct fscache_netfs cifs_fscache_netfs;
  42 extern const struct fscache_cookie_def cifs_fscache_server_index_def;
  43 extern const struct fscache_cookie_def cifs_fscache_super_index_def;
  44 extern const struct fscache_cookie_def cifs_fscache_inode_object_def;
  45
  46 extern int cifs_fscache_register(void);
  47 extern void cifs_fscache_unregister(void);
  48
  49 /*
  50  * fscache.c
  51  */
  52 extern void cifs_fscache_get_client_cookie(struct TCP_Server_Info *);
  53 extern void cifs_fscache_release_client_cookie(struct TCP_Server_Info *);
  54 extern void cifs_fscache_get_super_cookie(struct cifs_tcon *);
  55 extern void cifs_fscache_release_super_cookie(struct cifs_tcon *);
  56
  57 extern void cifs_fscache_release_inode_cookie(struct inode *);
  58 extern void cifs_fscache_set_inode_cookie(struct inode *, struct file *);
  59 extern void cifs_fscache_reset_inode_cookie(struct inode *);
  60
  61 extern void __cifs_fscache_invalidate_page(struct page *, struct inode *);
  62 extern int cifs_fscache_release_page(struct page *page, gfp_t gfp);
  63 extern int __cifs_readpage_from_fscache(struct inode *, struct page *);
  64 extern int __cifs_readpages_from_fscache(struct inode *,
  65                                          struct address_space *,
  66                                          struct list_head *,
  67                                          unsigned *);
  68 extern void __cifs_fscache_readpages_cancel(struct inode *, struct list_head *);
  69
  70 extern void __cifs_readpage_to_fscache(struct inode *, struct page *);
  71
  72 static inline void cifs_fscache_invalidate_page(struct page *page,
  73                                                struct inode *inode)
  74 {
  75         if (PageFsCache(page))
  76                 __cifs_fscache_invalidate_page(page, inode);
  77 }
  78
  79 static inline int cifs_readpage_from_fscache(struct inode *inode,
  80                                              struct page *page)
  81 {
  82         if (CIFS_I(inode)->fscache)
  83                 return __cifs_readpage_from_fscache(inode, page);
  84
  85         return -ENOBUFS;
  86 }
  87
  88 static inline int cifs_readpages_from_fscache(struct inode *inode,
  89                                               struct address_space *mapping,
  90                                               struct list_head *pages,
  91                                               unsigned *nr_pages)
  92 {
  93         if (CIFS_I(inode)->fscache)
  94                 return __cifs_readpages_from_fscache(inode, mapping, pages,
  95                                                      nr_pages);
  96         return -ENOBUFS;
  97 }
  98
  99 static inline void cifs_readpage_to_fscache(struct inode *inode,
 100                                             struct page *page)
 101 {
 102         if (PageFsCache(page))
 103                 __cifs_readpage_to_fscache(inode, page);
 104 }
 105
 106 static inline void cifs_fscache_readpages_cancel(struct inode *inode,
 107                                                  struct list_head *pages)
 108 {
 109         if (CIFS_I(inode)->fscache)
 110                 return __cifs_fscache_readpages_cancel(inode, pages);
 111 }
 112
 113 #else /* CONFIG_CIFS_FSCACHE */
 114 static inline int cifs_fscache_register(void) { return 0; }
 115 static inline void cifs_fscache_unregister(void) {}
 116
 117 static inline void
 118 cifs_fscache_get_client_cookie(struct TCP_Server_Info *server) {}
 119 static inline void
 120 cifs_fscache_release_client_cookie(struct TCP_Server_Info *server) {}
 121 static inline void cifs_fscache_get_super_cookie(struct cifs_tcon *tcon) {}
 122 static inline void
 123 cifs_fscache_release_super_cookie(struct cifs_tcon *tcon) {}
 124
 125 static inline void cifs_fscache_release_inode_cookie(struct inode *inode) {}
 126 static inline void cifs_fscache_set_inode_cookie(struct inode *inode,
 127                                                  struct file *filp) {}
 128 static inline void cifs_fscache_reset_inode_cookie(struct inode *inode) {}
 129 static inline int cifs_fscache_release_page(struct page *page, gfp_t gfp)
 130 {
 131         return 1; /* May release page */
 132 }
 133
 134 static inline void cifs_fscache_invalidate_page(struct page *page,
 135                         struct inode *inode) {}
 136 static inline int
 137 cifs_readpage_from_fscache(struct inode *inode, struct page *page)
 138 {
 139         return -ENOBUFS;
 140 }
 141
 142 static inline int cifs_readpages_from_fscache(struct inode *inode,
 143                                               struct address_space *mapping,
 144                                               struct list_head *pages,
 145                                               unsigned *nr_pages)
 146 {
 147         return -ENOBUFS;
 148 }
 149
 150 static inline void cifs_readpage_to_fscache(struct inode *inode,
 151                         struct page *page) {}
 152
 153 static inline void cifs_fscache_readpages_cancel(struct inode *inode,
 154                                                  struct list_head *pages)
 155 {
 156 }
 157
 158 #endif /* CONFIG_CIFS_FSCACHE */
 159
 160 #endif /* _CIFS_FSCACHE_H */