2 * linux/fs/nfs/direct.c
4 * Copyright (C) 2003 by Chuck Lever <cel@netapp.com>
6 * High-performance uncached I/O for the Linux NFS client
8 * There are important applications whose performance or correctness
9 * depends on uncached access to file data. Database clusters
10 * (multiple copies of the same instance running on separate hosts)
11 * implement their own cache coherency protocol that subsumes file
12 * system cache protocols. Applications that process datasets
13 * considerably larger than the client's memory do not always benefit
14 * from a local cache. A streaming video server, for instance, has no
15 * need to cache the contents of a file.
17 * When an application requests uncached I/O, all read and write requests
18 * are made directly to the server; data stored or fetched via these
19 * requests is not cached in the Linux page cache. The client does not
20 * correct unaligned requests from applications. All requested bytes are
21 * held on permanent storage before a direct write system call returns to
24 * Solaris implements an uncached I/O facility called directio() that
25 * is used for backups and sequential I/O to very large files. Solaris
26 * also supports uncaching whole NFS partitions with "-o forcedirectio,"
27 * an undocumented mount option.
29 * Designed by Jeff Kimmel, Chuck Lever, and Trond Myklebust, with
30 * help from Andrew Morton.
32 * 18 Dec 2001 Initial implementation for 2.4 --cel
33 * 08 Jul 2002 Version for 2.4.19, with bug fixes --trondmy
34 * 08 Jun 2003 Port to 2.5 APIs --cel
35 * 31 Mar 2004 Handle direct I/O without VFS support --cel
36 * 15 Sep 2004 Parallel async reads --cel
40 #include <linux/config.h>
41 #include <linux/errno.h>
42 #include <linux/sched.h>
43 #include <linux/kernel.h>
44 #include <linux/smp_lock.h>
45 #include <linux/file.h>
46 #include <linux/pagemap.h>
47 #include <linux/kref.h>
49 #include <linux/nfs_fs.h>
50 #include <linux/nfs_page.h>
51 #include <linux/sunrpc/clnt.h>
53 #include <asm/system.h>
54 #include <asm/uaccess.h>
55 #include <asm/atomic.h>
59 #define NFSDBG_FACILITY NFSDBG_VFS
60 #define MAX_DIRECTIO_SIZE (4096UL << PAGE_SHIFT)
62 static void nfs_free_user_pages(struct page **pages, int npages, int do_dirty);
63 static kmem_cache_t *nfs_direct_cachep;
66 * This represents a set of asynchronous requests that we're waiting on
68 struct nfs_direct_req {
69 struct kref kref; /* release manager */
70 struct list_head list; /* nfs_read_data structs */
71 struct file * filp; /* file descriptor */
72 struct kiocb * iocb; /* controlling i/o request */
73 wait_queue_head_t wait; /* wait for i/o completion */
74 struct inode * inode; /* target file of I/O */
75 struct page ** pages; /* pages in our buffer */
76 unsigned int npages; /* count of pages */
77 atomic_t complete, /* i/os we're waiting for */
78 count, /* bytes actually processed */
79 error; /* any reported error */
84 * nfs_direct_IO - NFS address space operation for direct I/O
85 * @rw: direction (read or write)
86 * @iocb: target I/O control block
87 * @iov: array of vectors that define I/O buffer
88 * @pos: offset in file to begin the operation
89 * @nr_segs: size of iovec array
91 * The presence of this routine in the address space ops vector means
92 * the NFS client supports direct I/O. However, we shunt off direct
93 * read and write requests before the VFS gets them, so this method
94 * should never be called.
96 ssize_t nfs_direct_IO(int rw, struct kiocb *iocb, const struct iovec *iov, loff_t pos, unsigned long nr_segs)
98 struct dentry *dentry = iocb->ki_filp->f_dentry;
100 dprintk("NFS: nfs_direct_IO (%s) off/no(%Ld/%lu) EINVAL\n",
101 dentry->d_name.name, (long long) pos, nr_segs);
106 static inline int nfs_get_user_pages(int rw, unsigned long user_addr, size_t size, struct page ***pages)
108 int result = -ENOMEM;
109 unsigned long page_count;
112 /* set an arbitrary limit to prevent type overflow */
113 /* XXX: this can probably be as large as INT_MAX */
114 if (size > MAX_DIRECTIO_SIZE) {
119 page_count = (user_addr + size + PAGE_SIZE - 1) >> PAGE_SHIFT;
120 page_count -= user_addr >> PAGE_SHIFT;
122 array_size = (page_count * sizeof(struct page *));
123 *pages = kmalloc(array_size, GFP_KERNEL);
125 down_read(¤t->mm->mmap_sem);
126 result = get_user_pages(current, current->mm, user_addr,
127 page_count, (rw == READ), 0,
129 up_read(¤t->mm->mmap_sem);
131 * If we got fewer pages than expected from get_user_pages(),
132 * the user buffer runs off the end of a mapping; return EFAULT.
134 if (result >= 0 && result < page_count) {
135 nfs_free_user_pages(*pages, result, 0);
143 static void nfs_free_user_pages(struct page **pages, int npages, int do_dirty)
146 for (i = 0; i < npages; i++) {
147 struct page *page = pages[i];
148 if (do_dirty && !PageCompound(page))
149 set_page_dirty_lock(page);
150 page_cache_release(page);
155 static inline struct nfs_direct_req *nfs_direct_req_alloc(void)
157 struct nfs_direct_req *dreq;
159 dreq = kmem_cache_alloc(nfs_direct_cachep, SLAB_KERNEL);
163 kref_init(&dreq->kref);
164 init_waitqueue_head(&dreq->wait);
165 INIT_LIST_HEAD(&dreq->list);
167 atomic_set(&dreq->count, 0);
168 atomic_set(&dreq->error, 0);
173 static void nfs_direct_req_release(struct kref *kref)
175 struct nfs_direct_req *dreq = container_of(kref, struct nfs_direct_req, kref);
176 kmem_cache_free(nfs_direct_cachep, dreq);
180 * Collects and returns the final error value/byte-count.
182 static ssize_t nfs_direct_wait(struct nfs_direct_req *dreq)
184 int result = -EIOCBQUEUED;
186 /* Async requests don't wait here */
190 result = wait_event_interruptible(dreq->wait,
191 (atomic_read(&dreq->complete) == 0));
194 result = atomic_read(&dreq->error);
196 result = atomic_read(&dreq->count);
199 kref_put(&dreq->kref, nfs_direct_req_release);
200 return (ssize_t) result;
204 * Note we also set the number of requests we have in the dreq when we are
205 * done. This prevents races with I/O completion so we will always wait
206 * until all requests have been dispatched and completed.
208 static struct nfs_direct_req *nfs_direct_read_alloc(size_t nbytes, size_t rsize)
210 struct list_head *list;
211 struct nfs_direct_req *dreq;
212 unsigned int reads = 0;
213 unsigned int rpages = (rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
215 dreq = nfs_direct_req_alloc();
221 struct nfs_read_data *data = nfs_readdata_alloc(rpages);
223 if (unlikely(!data)) {
224 while (!list_empty(list)) {
225 data = list_entry(list->next,
226 struct nfs_read_data, pages);
227 list_del(&data->pages);
228 nfs_readdata_free(data);
230 kref_put(&dreq->kref, nfs_direct_req_release);
234 INIT_LIST_HEAD(&data->pages);
235 list_add(&data->pages, list);
237 data->req = (struct nfs_page *) dreq;
243 kref_get(&dreq->kref);
244 atomic_set(&dreq->complete, reads);
249 * We must hold a reference to all the pages in this direct read request
250 * until the RPCs complete. This could be long *after* we are woken up in
251 * nfs_direct_wait (for instance, if someone hits ^C on a slow server).
253 * In addition, synchronous I/O uses a stack-allocated iocb. Thus we
254 * can't trust the iocb is still valid here if this is a synchronous
255 * request. If the waiter is woken prematurely, the iocb is long gone.
257 static void nfs_direct_read_result(struct rpc_task *task, void *calldata)
259 struct nfs_read_data *data = calldata;
260 struct nfs_direct_req *dreq = (struct nfs_direct_req *) data->req;
262 if (nfs_readpage_result(task, data) != 0)
264 if (likely(task->tk_status >= 0))
265 atomic_add(data->res.count, &dreq->count);
267 atomic_set(&dreq->error, task->tk_status);
269 if (unlikely(atomic_dec_and_test(&dreq->complete))) {
270 nfs_free_user_pages(dreq->pages, dreq->npages, 1);
272 long res = atomic_read(&dreq->error);
274 res = atomic_read(&dreq->count);
275 aio_complete(dreq->iocb, res, 0);
277 wake_up(&dreq->wait);
278 kref_put(&dreq->kref, nfs_direct_req_release);
282 static const struct rpc_call_ops nfs_read_direct_ops = {
283 .rpc_call_done = nfs_direct_read_result,
284 .rpc_release = nfs_readdata_release,
288 * For each nfs_read_data struct that was allocated on the list, dispatch
289 * an NFS READ operation
291 static void nfs_direct_read_schedule(struct nfs_direct_req *dreq, unsigned long user_addr, size_t count, loff_t file_offset)
293 struct file *file = dreq->filp;
294 struct inode *inode = file->f_mapping->host;
295 struct nfs_open_context *ctx = (struct nfs_open_context *)
297 struct list_head *list = &dreq->list;
298 struct page **pages = dreq->pages;
299 size_t rsize = NFS_SERVER(inode)->rsize;
300 unsigned int curpage, pgbase;
303 pgbase = user_addr & ~PAGE_MASK;
305 struct nfs_read_data *data;
312 data = list_entry(list->next, struct nfs_read_data, pages);
313 list_del_init(&data->pages);
316 data->cred = ctx->cred;
317 data->args.fh = NFS_FH(inode);
318 data->args.context = ctx;
319 data->args.offset = file_offset;
320 data->args.pgbase = pgbase;
321 data->args.pages = &pages[curpage];
322 data->args.count = bytes;
323 data->res.fattr = &data->fattr;
325 data->res.count = bytes;
327 rpc_init_task(&data->task, NFS_CLIENT(inode), RPC_TASK_ASYNC,
328 &nfs_read_direct_ops, data);
329 NFS_PROTO(inode)->read_setup(data);
331 data->task.tk_cookie = (unsigned long) inode;
334 rpc_execute(&data->task);
337 dfprintk(VFS, "NFS: %4d initiated direct read call (req %s/%Ld, %u bytes @ offset %Lu)\n",
340 (long long)NFS_FILEID(inode),
342 (unsigned long long)data->args.offset);
344 file_offset += bytes;
346 curpage += pgbase >> PAGE_SHIFT;
347 pgbase &= ~PAGE_MASK;
350 } while (count != 0);
353 static ssize_t nfs_direct_read(struct kiocb *iocb, unsigned long user_addr, size_t count, loff_t file_offset, struct page **pages, unsigned int nr_pages)
357 struct inode *inode = iocb->ki_filp->f_mapping->host;
358 struct rpc_clnt *clnt = NFS_CLIENT(inode);
359 struct nfs_direct_req *dreq;
361 dreq = nfs_direct_read_alloc(count, NFS_SERVER(inode)->rsize);
366 dreq->npages = nr_pages;
368 dreq->filp = iocb->ki_filp;
369 if (!is_sync_kiocb(iocb))
372 nfs_add_stats(inode, NFSIOS_DIRECTREADBYTES, count);
373 rpc_clnt_sigmask(clnt, &oldset);
374 nfs_direct_read_schedule(dreq, user_addr, count, file_offset);
375 result = nfs_direct_wait(dreq);
376 rpc_clnt_sigunmask(clnt, &oldset);
381 static ssize_t nfs_direct_write_seg(struct inode *inode, struct nfs_open_context *ctx, unsigned long user_addr, size_t count, loff_t file_offset, struct page **pages, int nr_pages)
383 const unsigned int wsize = NFS_SERVER(inode)->wsize;
385 int curpage, need_commit;
386 ssize_t result, tot_bytes;
387 struct nfs_writeverf first_verf;
388 struct nfs_write_data *wdata;
390 wdata = nfs_writedata_alloc(NFS_SERVER(inode)->wpages);
394 wdata->inode = inode;
395 wdata->cred = ctx->cred;
396 wdata->args.fh = NFS_FH(inode);
397 wdata->args.context = ctx;
398 wdata->args.stable = NFS_UNSTABLE;
399 if (IS_SYNC(inode) || NFS_PROTO(inode)->version == 2 || count <= wsize)
400 wdata->args.stable = NFS_FILE_SYNC;
401 wdata->res.fattr = &wdata->fattr;
402 wdata->res.verf = &wdata->verf;
404 nfs_begin_data_update(inode);
410 wdata->args.pgbase = user_addr & ~PAGE_MASK;
411 wdata->args.offset = file_offset;
413 wdata->args.count = request;
414 if (wdata->args.count > wsize)
415 wdata->args.count = wsize;
416 wdata->args.pages = &pages[curpage];
418 dprintk("NFS: direct write: c=%u o=%Ld ua=%lu, pb=%u, cp=%u\n",
419 wdata->args.count, (long long) wdata->args.offset,
420 user_addr + tot_bytes, wdata->args.pgbase, curpage);
423 result = NFS_PROTO(inode)->write(wdata);
433 memcpy(&first_verf.verifier, &wdata->verf.verifier,
434 sizeof(first_verf.verifier));
435 if (wdata->verf.committed != NFS_FILE_SYNC) {
437 if (memcmp(&first_verf.verifier, &wdata->verf.verifier,
438 sizeof(first_verf.verifier)))
444 /* in case of a short write: stop now, let the app recover */
445 if (result < wdata->args.count)
448 wdata->args.offset += result;
449 wdata->args.pgbase += result;
450 curpage += wdata->args.pgbase >> PAGE_SHIFT;
451 wdata->args.pgbase &= ~PAGE_MASK;
453 } while (request != 0);
456 * Commit data written so far, even in the event of an error
459 wdata->args.count = tot_bytes;
460 wdata->args.offset = file_offset;
463 result = NFS_PROTO(inode)->commit(wdata);
466 if (result < 0 || memcmp(&first_verf.verifier,
467 &wdata->verf.verifier,
468 sizeof(first_verf.verifier)) != 0)
474 nfs_end_data_update(inode);
475 nfs_writedata_free(wdata);
479 wdata->args.stable = NFS_FILE_SYNC;
484 * Upon return, generic_file_direct_IO invalidates any cached pages
485 * that non-direct readers might access, so they will pick up these
486 * writes immediately.
488 static ssize_t nfs_direct_write(struct inode *inode, struct nfs_open_context *ctx, const struct iovec *iov, loff_t file_offset, unsigned long nr_segs)
490 ssize_t tot_bytes = 0;
491 unsigned long seg = 0;
493 while ((seg < nr_segs) && (tot_bytes >= 0)) {
497 const struct iovec *vec = &iov[seg++];
498 unsigned long user_addr = (unsigned long) vec->iov_base;
499 size_t size = vec->iov_len;
501 page_count = nfs_get_user_pages(WRITE, user_addr, size, &pages);
502 if (page_count < 0) {
503 nfs_free_user_pages(pages, 0, 0);
509 nfs_add_stats(inode, NFSIOS_DIRECTWRITTENBYTES, size);
510 result = nfs_direct_write_seg(inode, ctx, user_addr, size,
511 file_offset, pages, page_count);
512 nfs_free_user_pages(pages, page_count, 0);
519 nfs_add_stats(inode, NFSIOS_SERVERWRITTENBYTES, result);
521 file_offset += result;
529 * nfs_file_direct_read - file direct read operation for NFS files
530 * @iocb: target I/O control block
531 * @buf: user's buffer into which to read data
532 * count: number of bytes to read
533 * pos: byte offset in file where reading starts
535 * We use this function for direct reads instead of calling
536 * generic_file_aio_read() in order to avoid gfar's check to see if
537 * the request starts before the end of the file. For that check
538 * to work, we must generate a GETATTR before each direct read, and
539 * even then there is a window between the GETATTR and the subsequent
540 * READ where the file size could change. So our preference is simply
541 * to do all reads the application wants, and the server will take
542 * care of managing the end of file boundary.
544 * This function also eliminates unnecessarily updating the file's
545 * atime locally, as the NFS server sets the file's atime, and this
546 * client must read the updated atime from the server back into its
549 ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf, size_t count, loff_t pos)
551 ssize_t retval = -EINVAL;
554 struct file *file = iocb->ki_filp;
555 struct address_space *mapping = file->f_mapping;
557 dprintk("nfs: direct read(%s/%s, %lu@%Ld)\n",
558 file->f_dentry->d_parent->d_name.name,
559 file->f_dentry->d_name.name,
560 (unsigned long) count, (long long) pos);
565 if (!access_ok(VERIFY_WRITE, buf, count))
571 retval = nfs_sync_mapping(mapping);
575 page_count = nfs_get_user_pages(READ, (unsigned long) buf,
577 if (page_count < 0) {
578 nfs_free_user_pages(pages, 0, 0);
583 retval = nfs_direct_read(iocb, (unsigned long) buf, count, pos,
586 iocb->ki_pos = pos + retval;
593 * nfs_file_direct_write - file direct write operation for NFS files
594 * @iocb: target I/O control block
595 * @buf: user's buffer from which to write data
596 * count: number of bytes to write
597 * pos: byte offset in file where writing starts
599 * We use this function for direct writes instead of calling
600 * generic_file_aio_write() in order to avoid taking the inode
601 * semaphore and updating the i_size. The NFS server will set
602 * the new i_size and this client must read the updated size
603 * back into its cache. We let the server do generic write
604 * parameter checking and report problems.
606 * We also avoid an unnecessary invocation of generic_osync_inode(),
607 * as it is fairly meaningless to sync the metadata of an NFS file.
609 * We eliminate local atime updates, see direct read above.
611 * We avoid unnecessary page cache invalidations for normal cached
612 * readers of this file.
614 * Note that O_APPEND is not supported for NFS direct writes, as there
615 * is no atomic O_APPEND write facility in the NFS protocol.
617 ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf, size_t count, loff_t pos)
620 struct file *file = iocb->ki_filp;
621 struct nfs_open_context *ctx =
622 (struct nfs_open_context *) file->private_data;
623 struct address_space *mapping = file->f_mapping;
624 struct inode *inode = mapping->host;
626 .iov_base = (char __user *)buf,
629 dfprintk(VFS, "nfs: direct write(%s/%s, %lu@%Ld)\n",
630 file->f_dentry->d_parent->d_name.name,
631 file->f_dentry->d_name.name,
632 (unsigned long) count, (long long) pos);
635 if (!is_sync_kiocb(iocb))
638 retval = generic_write_checks(file, &pos, &count, 0);
643 if ((ssize_t) count < 0)
651 if (!access_ok(VERIFY_READ, iov.iov_base, iov.iov_len))
654 retval = nfs_sync_mapping(mapping);
658 retval = nfs_direct_write(inode, ctx, &iov, pos, 1);
659 if (mapping->nrpages)
660 invalidate_inode_pages2(mapping);
662 iocb->ki_pos = pos + retval;
668 int nfs_init_directcache(void)
670 nfs_direct_cachep = kmem_cache_create("nfs_direct_cache",
671 sizeof(struct nfs_direct_req),
672 0, SLAB_RECLAIM_ACCOUNT,
674 if (nfs_direct_cachep == NULL)
680 void nfs_destroy_directcache(void)
682 if (kmem_cache_destroy(nfs_direct_cachep))
683 printk(KERN_INFO "nfs_direct_cache: not all structures were freed\n");