fs/9p/vfs_addr.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * This file contians vfs address (mmap) ops for 9P2000.
   4  *
   5  *  Copyright (C) 2005 by Eric Van Hensbergen <ericvh@gmail.com>
   6  *  Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
   7  */
   8
   9 #include <linux/module.h>
  10 #include <linux/errno.h>
  11 #include <linux/fs.h>
  12 #include <linux/file.h>
  13 #include <linux/stat.h>
  14 #include <linux/string.h>
  15 #include <linux/inet.h>
  16 #include <linux/pagemap.h>
  17 #include <linux/sched.h>
  18 #include <linux/swap.h>
  19 #include <linux/uio.h>
  20 #include <linux/netfs.h>
  21 #include <net/9p/9p.h>
  22 #include <net/9p/client.h>
  23
  24 #include "v9fs.h"
  25 #include "v9fs_vfs.h"
  26 #include "cache.h"
  27 #include "fid.h"
  28
  29 /**
  30  * v9fs_issue_read - Issue a read from 9P
  31  * @subreq: The read to make
  32  */
  33 static void v9fs_issue_read(struct netfs_io_subrequest *subreq)
  34 {
  35         struct netfs_io_request *rreq = subreq->rreq;
  36         struct p9_fid *fid = rreq->netfs_priv;
  37         struct iov_iter to;
  38         loff_t pos = subreq->start + subreq->transferred;
  39         size_t len = subreq->len   - subreq->transferred;
  40         int total, err;
  41
  42         iov_iter_xarray(&to, ITER_DEST, &rreq->mapping->i_pages, pos, len);
  43
  44         total = p9_client_read(fid, pos, &to, &err);
  45
  46         /* if we just extended the file size, any portion not in
  47          * cache won't be on server and is zeroes */
  48         __set_bit(NETFS_SREQ_CLEAR_TAIL, &subreq->flags);
  49
  50         netfs_subreq_terminated(subreq, err ?: total, false);
  51 }
  52
  53 /**
  54  * v9fs_init_request - Initialise a read request
  55  * @rreq: The read request
  56  * @file: The file being read from
  57  */
  58 static int v9fs_init_request(struct netfs_io_request *rreq, struct file *file)
  59 {
  60         struct p9_fid *fid = file->private_data;
  61
  62         BUG_ON(!fid);
  63
  64         /* we might need to read from a fid that was opened write-only
  65          * for read-modify-write of page cache, use the writeback fid
  66          * for that */
  67         WARN_ON(rreq->origin == NETFS_READ_FOR_WRITE &&
  68                         !(fid->mode & P9_ORDWR));
  69
  70         p9_fid_get(fid);
  71         rreq->netfs_priv = fid;
  72         return 0;
  73 }
  74
  75 /**
  76  * v9fs_free_request - Cleanup request initialized by v9fs_init_rreq
  77  * @rreq: The I/O request to clean up
  78  */
  79 static void v9fs_free_request(struct netfs_io_request *rreq)
  80 {
  81         struct p9_fid *fid = rreq->netfs_priv;
  82
  83         p9_fid_put(fid);
  84 }
  85
  86 /**
  87  * v9fs_begin_cache_operation - Begin a cache operation for a read
  88  * @rreq: The read request
  89  */
  90 static int v9fs_begin_cache_operation(struct netfs_io_request *rreq)
  91 {
  92 #ifdef CONFIG_9P_FSCACHE
  93         struct fscache_cookie *cookie = v9fs_inode_cookie(V9FS_I(rreq->inode));
  94
  95         return fscache_begin_read_operation(&rreq->cache_resources, cookie);
  96 #else
  97         return -ENOBUFS;
  98 #endif
  99 }
 100
 101 const struct netfs_request_ops v9fs_req_ops = {
 102         .init_request           = v9fs_init_request,
 103         .free_request           = v9fs_free_request,
 104         .begin_cache_operation  = v9fs_begin_cache_operation,
 105         .issue_read             = v9fs_issue_read,
 106 };
 107
 108 /**
 109  * v9fs_release_folio - release the private state associated with a folio
 110  * @folio: The folio to be released
 111  * @gfp: The caller's allocation restrictions
 112  *
 113  * Returns true if the page can be released, false otherwise.
 114  */
 115
 116 static bool v9fs_release_folio(struct folio *folio, gfp_t gfp)
 117 {
 118         if (folio_test_private(folio))
 119                 return false;
 120 #ifdef CONFIG_9P_FSCACHE
 121         if (folio_test_fscache(folio)) {
 122                 if (current_is_kswapd() || !(gfp & __GFP_FS))
 123                         return false;
 124                 folio_wait_fscache(folio);
 125         }
 126         fscache_note_page_release(v9fs_inode_cookie(V9FS_I(folio_inode(folio))));
 127 #endif
 128         return true;
 129 }
 130
 131 static void v9fs_invalidate_folio(struct folio *folio, size_t offset,
 132                                  size_t length)
 133 {
 134         folio_wait_fscache(folio);
 135 }
 136
 137 #ifdef CONFIG_9P_FSCACHE
 138 static void v9fs_write_to_cache_done(void *priv, ssize_t transferred_or_error,
 139                                      bool was_async)
 140 {
 141         struct v9fs_inode *v9inode = priv;
 142         __le32 version;
 143
 144         if (IS_ERR_VALUE(transferred_or_error) &&
 145             transferred_or_error != -ENOBUFS) {
 146                 version = cpu_to_le32(v9inode->qid.version);
 147                 fscache_invalidate(v9fs_inode_cookie(v9inode), &version,
 148                                    i_size_read(&v9inode->netfs.inode), 0);
 149         }
 150 }
 151 #endif
 152
 153 static int v9fs_vfs_write_folio_locked(struct folio *folio)
 154 {
 155         struct inode *inode = folio_inode(folio);
 156         loff_t start = folio_pos(folio);
 157         loff_t i_size = i_size_read(inode);
 158         struct iov_iter from;
 159         size_t len = folio_size(folio);
 160         struct p9_fid *writeback_fid;
 161         int err;
 162         struct v9fs_inode __maybe_unused *v9inode = V9FS_I(inode);
 163         struct fscache_cookie __maybe_unused *cookie = v9fs_inode_cookie(v9inode);
 164
 165         if (start >= i_size)
 166                 return 0; /* Simultaneous truncation occurred */
 167
 168         len = min_t(loff_t, i_size - start, len);
 169
 170         iov_iter_xarray(&from, ITER_SOURCE, &folio_mapping(folio)->i_pages, start, len);
 171
 172         writeback_fid = v9fs_fid_find_inode(inode, true, INVALID_UID, true);
 173         if (!writeback_fid) {
 174                 WARN_ONCE(1, "folio expected an open fid inode->i_private=%p\n",
 175                         inode->i_private);
 176                 return -EINVAL;
 177         }
 178
 179         folio_wait_fscache(folio);
 180         folio_start_writeback(folio);
 181
 182         p9_client_write(writeback_fid, start, &from, &err);
 183
 184 #ifdef CONFIG_9P_FSCACHE
 185         if (err == 0 &&
 186                 fscache_cookie_enabled(cookie) &&
 187                 test_bit(FSCACHE_COOKIE_IS_CACHING, &cookie->flags)) {
 188                 folio_start_fscache(folio);
 189                 fscache_write_to_cache(v9fs_inode_cookie(v9inode),
 190                                         folio_mapping(folio), start, len, i_size,
 191                                         v9fs_write_to_cache_done, v9inode,
 192                                         true);
 193         }
 194 #endif
 195
 196         folio_end_writeback(folio);
 197         p9_fid_put(writeback_fid);
 198
 199         return err;
 200 }
 201
 202 static int v9fs_vfs_writepage(struct page *page, struct writeback_control *wbc)
 203 {
 204         struct folio *folio = page_folio(page);
 205         int retval;
 206
 207         p9_debug(P9_DEBUG_VFS, "folio %p\n", folio);
 208
 209         retval = v9fs_vfs_write_folio_locked(folio);
 210         if (retval < 0) {
 211                 if (retval == -EAGAIN) {
 212                         folio_redirty_for_writepage(wbc, folio);
 213                         retval = 0;
 214                 } else {
 215                         mapping_set_error(folio_mapping(folio), retval);
 216                 }
 217         } else
 218                 retval = 0;
 219
 220         folio_unlock(folio);
 221         return retval;
 222 }
 223
 224 static int v9fs_launder_folio(struct folio *folio)
 225 {
 226         int retval;
 227
 228         if (folio_clear_dirty_for_io(folio)) {
 229                 retval = v9fs_vfs_write_folio_locked(folio);
 230                 if (retval)
 231                         return retval;
 232         }
 233         folio_wait_fscache(folio);
 234         return 0;
 235 }
 236
 237 /**
 238  * v9fs_direct_IO - 9P address space operation for direct I/O
 239  * @iocb: target I/O control block
 240  * @iter: The data/buffer to use
 241  *
 242  * The presence of v9fs_direct_IO() in the address space ops vector
 243  * allowes open() O_DIRECT flags which would have failed otherwise.
 244  *
 245  * In the non-cached mode, we shunt off direct read and write requests before
 246  * the VFS gets them, so this method should never be called.
 247  *
 248  * Direct IO is not 'yet' supported in the cached mode. Hence when
 249  * this routine is called through generic_file_aio_read(), the read/write fails
 250  * with an error.
 251  *
 252  */
 253 static ssize_t
 254 v9fs_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
 255 {
 256         struct file *file = iocb->ki_filp;
 257         loff_t pos = iocb->ki_pos;
 258         ssize_t n;
 259         int err = 0;
 260
 261         if (iov_iter_rw(iter) == WRITE) {
 262                 n = p9_client_write(file->private_data, pos, iter, &err);
 263                 if (n) {
 264                         struct inode *inode = file_inode(file);
 265                         loff_t i_size = i_size_read(inode);
 266
 267                         if (pos + n > i_size)
 268                                 inode_add_bytes(inode, pos + n - i_size);
 269                 }
 270         } else {
 271                 n = p9_client_read(file->private_data, pos, iter, &err);
 272         }
 273         return n ? n : err;
 274 }
 275
 276 static int v9fs_write_begin(struct file *filp, struct address_space *mapping,
 277                             loff_t pos, unsigned int len,
 278                             struct page **subpagep, void **fsdata)
 279 {
 280         int retval;
 281         struct folio *folio;
 282         struct v9fs_inode *v9inode = V9FS_I(mapping->host);
 283
 284         p9_debug(P9_DEBUG_VFS, "filp %p, mapping %p\n", filp, mapping);
 285
 286         /* Prefetch area to be written into the cache if we're caching this
 287          * file.  We need to do this before we get a lock on the page in case
 288          * there's more than one writer competing for the same cache block.
 289          */
 290         retval = netfs_write_begin(&v9inode->netfs, filp, mapping, pos, len, &folio, fsdata);
 291         if (retval < 0)
 292                 return retval;
 293
 294         *subpagep = &folio->page;
 295         return retval;
 296 }
 297
 298 static int v9fs_write_end(struct file *filp, struct address_space *mapping,
 299                           loff_t pos, unsigned int len, unsigned int copied,
 300                           struct page *subpage, void *fsdata)
 301 {
 302         loff_t last_pos = pos + copied;
 303         struct folio *folio = page_folio(subpage);
 304         struct inode *inode = mapping->host;
 305
 306         p9_debug(P9_DEBUG_VFS, "filp %p, mapping %p\n", filp, mapping);
 307
 308         if (!folio_test_uptodate(folio)) {
 309                 if (unlikely(copied < len)) {
 310                         copied = 0;
 311                         goto out;
 312                 }
 313
 314                 folio_mark_uptodate(folio);
 315         }
 316
 317         /*
 318          * No need to use i_size_read() here, the i_size
 319          * cannot change under us because we hold the i_mutex.
 320          */
 321         if (last_pos > inode->i_size) {
 322                 inode_add_bytes(inode, last_pos - inode->i_size);
 323                 i_size_write(inode, last_pos);
 324 #ifdef CONFIG_9P_FSCACHE
 325                 fscache_update_cookie(v9fs_inode_cookie(V9FS_I(inode)), NULL,
 326                         &last_pos);
 327 #endif
 328         }
 329         folio_mark_dirty(folio);
 330 out:
 331         folio_unlock(folio);
 332         folio_put(folio);
 333
 334         return copied;
 335 }
 336
 337 #ifdef CONFIG_9P_FSCACHE
 338 /*
 339  * Mark a page as having been made dirty and thus needing writeback.  We also
 340  * need to pin the cache object to write back to.
 341  */
 342 static bool v9fs_dirty_folio(struct address_space *mapping, struct folio *folio)
 343 {
 344         struct v9fs_inode *v9inode = V9FS_I(mapping->host);
 345
 346         return fscache_dirty_folio(mapping, folio, v9fs_inode_cookie(v9inode));
 347 }
 348 #else
 349 #define v9fs_dirty_folio filemap_dirty_folio
 350 #endif
 351
 352 const struct address_space_operations v9fs_addr_operations = {
 353         .read_folio = netfs_read_folio,
 354         .readahead = netfs_readahead,
 355         .dirty_folio = v9fs_dirty_folio,
 356         .writepage = v9fs_vfs_writepage,
 357         .write_begin = v9fs_write_begin,
 358         .write_end = v9fs_write_end,
 359         .release_folio = v9fs_release_folio,
 360         .invalidate_folio = v9fs_invalidate_folio,
 361         .launder_folio = v9fs_launder_folio,
 362         .direct_IO = v9fs_direct_IO,
 363 };