fs/cifs/fscache.c

   1 // SPDX-License-Identifier: LGPL-2.1
   2 /*
   3  *   CIFS filesystem cache interface
   4  *
   5  *   Copyright (c) 2010 Novell, Inc.
   6  *   Author(s): Suresh Jayaraman <sjayaraman@suse.de>
   7  *
   8  */
   9 #include "fscache.h"
  10 #include "cifsglob.h"
  11 #include "cifs_debug.h"
  12 #include "cifs_fs_sb.h"
  13 #include "cifsproto.h"
  14
  15 static void cifs_fscache_fill_volume_coherency(
  16         struct cifs_tcon *tcon,
  17         struct cifs_fscache_volume_coherency_data *cd)
  18 {
  19         memset(cd, 0, sizeof(*cd));
  20         cd->resource_id         = cpu_to_le64(tcon->resource_id);
  21         cd->vol_create_time     = tcon->vol_create_time;
  22         cd->vol_serial_number   = cpu_to_le32(tcon->vol_serial_number);
  23 }
  24
  25 int cifs_fscache_get_super_cookie(struct cifs_tcon *tcon)
  26 {
  27         struct cifs_fscache_volume_coherency_data cd;
  28         struct TCP_Server_Info *server = tcon->ses->server;
  29         struct fscache_volume *vcookie;
  30         const struct sockaddr *sa = (struct sockaddr *)&server->dstaddr;
  31         size_t slen, i;
  32         char *sharename;
  33         char *key;
  34         int ret = -ENOMEM;
  35
  36         tcon->fscache = NULL;
  37         switch (sa->sa_family) {
  38         case AF_INET:
  39         case AF_INET6:
  40                 break;
  41         default:
  42                 cifs_dbg(VFS, "Unknown network family '%d'\n", sa->sa_family);
  43                 return -EINVAL;
  44         }
  45
  46         memset(&key, 0, sizeof(key));
  47
  48         sharename = extract_sharename(tcon->treeName);
  49         if (IS_ERR(sharename)) {
  50                 cifs_dbg(FYI, "%s: couldn't extract sharename\n", __func__);
  51                 return -EINVAL;
  52         }
  53
  54         slen = strlen(sharename);
  55         for (i = 0; i < slen; i++)
  56                 if (sharename[i] == '/')
  57                         sharename[i] = ';';
  58
  59         key = kasprintf(GFP_KERNEL, "cifs,%pISpc,%s", sa, sharename);
  60         if (!key)
  61                 goto out;
  62
  63         cifs_fscache_fill_volume_coherency(tcon, &cd);
  64         vcookie = fscache_acquire_volume(key,
  65                                          NULL, /* preferred_cache */
  66                                          &cd, sizeof(cd));
  67         cifs_dbg(FYI, "%s: (%s/0x%p)\n", __func__, key, vcookie);
  68         if (IS_ERR(vcookie)) {
  69                 if (vcookie != ERR_PTR(-EBUSY)) {
  70                         ret = PTR_ERR(vcookie);
  71                         goto out_2;
  72                 }
  73                 pr_err("Cache volume key already in use (%s)\n", key);
  74                 vcookie = NULL;
  75         }
  76
  77         tcon->fscache = vcookie;
  78         ret = 0;
  79 out_2:
  80         kfree(key);
  81 out:
  82         kfree(sharename);
  83         return ret;
  84 }
  85
  86 void cifs_fscache_release_super_cookie(struct cifs_tcon *tcon)
  87 {
  88         struct cifs_fscache_volume_coherency_data cd;
  89
  90         cifs_dbg(FYI, "%s: (0x%p)\n", __func__, tcon->fscache);
  91
  92         cifs_fscache_fill_volume_coherency(tcon, &cd);
  93         fscache_relinquish_volume(tcon->fscache, &cd, false);
  94         tcon->fscache = NULL;
  95 }
  96
  97 void cifs_fscache_get_inode_cookie(struct inode *inode)
  98 {
  99         struct cifs_fscache_inode_coherency_data cd;
 100         struct cifsInodeInfo *cifsi = CIFS_I(inode);
 101         struct cifs_sb_info *cifs_sb = CIFS_SB(inode->i_sb);
 102         struct cifs_tcon *tcon = cifs_sb_master_tcon(cifs_sb);
 103
 104         cifs_fscache_fill_coherency(&cifsi->vfs_inode, &cd);
 105
 106         cifsi->fscache =
 107                 fscache_acquire_cookie(tcon->fscache, 0,
 108                                        &cifsi->uniqueid, sizeof(cifsi->uniqueid),
 109                                        &cd, sizeof(cd),
 110                                        i_size_read(&cifsi->vfs_inode));
 111 }
 112
 113 void cifs_fscache_unuse_inode_cookie(struct inode *inode, bool update)
 114 {
 115         if (update) {
 116                 struct cifs_fscache_inode_coherency_data cd;
 117                 loff_t i_size = i_size_read(inode);
 118
 119                 cifs_fscache_fill_coherency(inode, &cd);
 120                 fscache_unuse_cookie(cifs_inode_cookie(inode), &cd, &i_size);
 121         } else {
 122                 fscache_unuse_cookie(cifs_inode_cookie(inode), NULL, NULL);
 123         }
 124 }
 125
 126 void cifs_fscache_release_inode_cookie(struct inode *inode)
 127 {
 128         struct cifsInodeInfo *cifsi = CIFS_I(inode);
 129
 130         if (cifsi->fscache) {
 131                 cifs_dbg(FYI, "%s: (0x%p)\n", __func__, cifsi->fscache);
 132                 fscache_relinquish_cookie(cifsi->fscache, false);
 133                 cifsi->fscache = NULL;
 134         }
 135 }
 136
 137 static inline void fscache_end_operation(struct netfs_cache_resources *cres)
 138 {
 139         const struct netfs_cache_ops *ops = fscache_operation_valid(cres);
 140
 141         if (ops)
 142                 ops->end_operation(cres);
 143 }
 144
 145 /*
 146  * Fallback page reading interface.
 147  */
 148 static int fscache_fallback_read_page(struct inode *inode, struct page *page)
 149 {
 150         struct netfs_cache_resources cres;
 151         struct fscache_cookie *cookie = cifs_inode_cookie(inode);
 152         struct iov_iter iter;
 153         struct bio_vec bvec[1];
 154         int ret;
 155
 156         memset(&cres, 0, sizeof(cres));
 157         bvec[0].bv_page         = page;
 158         bvec[0].bv_offset       = 0;
 159         bvec[0].bv_len          = PAGE_SIZE;
 160         iov_iter_bvec(&iter, READ, bvec, ARRAY_SIZE(bvec), PAGE_SIZE);
 161
 162         ret = fscache_begin_read_operation(&cres, cookie);
 163         if (ret < 0)
 164                 return ret;
 165
 166         ret = fscache_read(&cres, page_offset(page), &iter, NETFS_READ_HOLE_FAIL,
 167                            NULL, NULL);
 168         fscache_end_operation(&cres);
 169         return ret;
 170 }
 171
 172 /*
 173  * Fallback page writing interface.
 174  */
 175 static int fscache_fallback_write_page(struct inode *inode, struct page *page,
 176                                        bool no_space_allocated_yet)
 177 {
 178         struct netfs_cache_resources cres;
 179         struct fscache_cookie *cookie = cifs_inode_cookie(inode);
 180         struct iov_iter iter;
 181         struct bio_vec bvec[1];
 182         loff_t start = page_offset(page);
 183         size_t len = PAGE_SIZE;
 184         int ret;
 185
 186         memset(&cres, 0, sizeof(cres));
 187         bvec[0].bv_page         = page;
 188         bvec[0].bv_offset       = 0;
 189         bvec[0].bv_len          = PAGE_SIZE;
 190         iov_iter_bvec(&iter, WRITE, bvec, ARRAY_SIZE(bvec), PAGE_SIZE);
 191
 192         ret = fscache_begin_write_operation(&cres, cookie);
 193         if (ret < 0)
 194                 return ret;
 195
 196         ret = cres.ops->prepare_write(&cres, &start, &len, i_size_read(inode),
 197                                       no_space_allocated_yet);
 198         if (ret == 0)
 199                 ret = fscache_write(&cres, page_offset(page), &iter, NULL, NULL);
 200         fscache_end_operation(&cres);
 201         return ret;
 202 }
 203
 204 /*
 205  * Retrieve a page from FS-Cache
 206  */
 207 int __cifs_readpage_from_fscache(struct inode *inode, struct page *page)
 208 {
 209         int ret;
 210
 211         cifs_dbg(FYI, "%s: (fsc:%p, p:%p, i:0x%p\n",
 212                  __func__, cifs_inode_cookie(inode), page, inode);
 213
 214         ret = fscache_fallback_read_page(inode, page);
 215         if (ret < 0)
 216                 return ret;
 217
 218         /* Read completed synchronously */
 219         SetPageUptodate(page);
 220         return 0;
 221 }
 222
 223 void __cifs_readpage_to_fscache(struct inode *inode, struct page *page)
 224 {
 225         cifs_dbg(FYI, "%s: (fsc: %p, p: %p, i: %p)\n",
 226                  __func__, cifs_inode_cookie(inode), page, inode);
 227
 228         fscache_fallback_write_page(inode, page, true);
 229 }
 230
 231 /*
 232  * Query the cache occupancy.
 233  */
 234 int __cifs_fscache_query_occupancy(struct inode *inode,
 235                                    pgoff_t first, unsigned int nr_pages,
 236                                    pgoff_t *_data_first,
 237                                    unsigned int *_data_nr_pages)
 238 {
 239         struct netfs_cache_resources cres;
 240         struct fscache_cookie *cookie = cifs_inode_cookie(inode);
 241         loff_t start, data_start;
 242         size_t len, data_len;
 243         int ret;
 244
 245         ret = fscache_begin_read_operation(&cres, cookie);
 246         if (ret < 0)
 247                 return ret;
 248
 249         start = first * PAGE_SIZE;
 250         len = nr_pages * PAGE_SIZE;
 251         ret = cres.ops->query_occupancy(&cres, start, len, PAGE_SIZE,
 252                                         &data_start, &data_len);
 253         if (ret == 0) {
 254                 *_data_first = data_start / PAGE_SIZE;
 255                 *_data_nr_pages = len / PAGE_SIZE;
 256         }
 257
 258         fscache_end_operation(&cres);
 259         return ret;
 260 }