NFSv4.1: Deal with seqid wraparound in the pNFS return-on-close code
[linux-2.6.git] / fs / nfs / pnfs.c
blob42613bd19f8e77dcfe4d4b7803c0d7969c4f1354
1 /*
2 * pNFS functions to call and manage layout drivers.
4 * Copyright (c) 2002 [year of first publication]
5 * The Regents of the University of Michigan
6 * All Rights Reserved
8 * Dean Hildebrand <dhildebz@umich.edu>
10 * Permission is granted to use, copy, create derivative works, and
11 * redistribute this software and such derivative works for any purpose,
12 * so long as the name of the University of Michigan is not used in
13 * any advertising or publicity pertaining to the use or distribution
14 * of this software without specific, written prior authorization. If
15 * the above copyright notice or any other identification of the
16 * University of Michigan is included in any copy of any portion of
17 * this software, then the disclaimer below must also be included.
19 * This software is provided as is, without representation or warranty
20 * of any kind either express or implied, including without limitation
21 * the implied warranties of merchantability, fitness for a particular
22 * purpose, or noninfringement. The Regents of the University of
23 * Michigan shall not be liable for any damages, including special,
24 * indirect, incidental, or consequential damages, with respect to any
25 * claim arising out of or in connection with the use of the software,
26 * even if it has been or is hereafter advised of the possibility of
27 * such damages.
30 #include <linux/nfs_fs.h>
31 #include <linux/nfs_page.h>
32 #include <linux/module.h>
33 #include "internal.h"
34 #include "pnfs.h"
35 #include "iostat.h"
37 #define NFSDBG_FACILITY NFSDBG_PNFS
38 #define PNFS_LAYOUTGET_RETRY_TIMEOUT (120*HZ)
40 /* Locking:
42 * pnfs_spinlock:
43 * protects pnfs_modules_tbl.
45 static DEFINE_SPINLOCK(pnfs_spinlock);
48 * pnfs_modules_tbl holds all pnfs modules
50 static LIST_HEAD(pnfs_modules_tbl);
52 /* Return the registered pnfs layout driver module matching given id */
53 static struct pnfs_layoutdriver_type *
54 find_pnfs_driver_locked(u32 id)
56 struct pnfs_layoutdriver_type *local;
58 list_for_each_entry(local, &pnfs_modules_tbl, pnfs_tblid)
59 if (local->id == id)
60 goto out;
61 local = NULL;
62 out:
63 dprintk("%s: Searching for id %u, found %p\n", __func__, id, local);
64 return local;
67 static struct pnfs_layoutdriver_type *
68 find_pnfs_driver(u32 id)
70 struct pnfs_layoutdriver_type *local;
72 spin_lock(&pnfs_spinlock);
73 local = find_pnfs_driver_locked(id);
74 if (local != NULL && !try_module_get(local->owner)) {
75 dprintk("%s: Could not grab reference on module\n", __func__);
76 local = NULL;
78 spin_unlock(&pnfs_spinlock);
79 return local;
82 void
83 unset_pnfs_layoutdriver(struct nfs_server *nfss)
85 if (nfss->pnfs_curr_ld) {
86 if (nfss->pnfs_curr_ld->clear_layoutdriver)
87 nfss->pnfs_curr_ld->clear_layoutdriver(nfss);
88 /* Decrement the MDS count. Purge the deviceid cache if zero */
89 if (atomic_dec_and_test(&nfss->nfs_client->cl_mds_count))
90 nfs4_deviceid_purge_client(nfss->nfs_client);
91 module_put(nfss->pnfs_curr_ld->owner);
93 nfss->pnfs_curr_ld = NULL;
97 * Try to set the server's pnfs module to the pnfs layout type specified by id.
98 * Currently only one pNFS layout driver per filesystem is supported.
100 * @id layout type. Zero (illegal layout type) indicates pNFS not in use.
102 void
103 set_pnfs_layoutdriver(struct nfs_server *server, const struct nfs_fh *mntfh,
104 u32 id)
106 struct pnfs_layoutdriver_type *ld_type = NULL;
108 if (id == 0)
109 goto out_no_driver;
110 if (!(server->nfs_client->cl_exchange_flags &
111 (EXCHGID4_FLAG_USE_NON_PNFS | EXCHGID4_FLAG_USE_PNFS_MDS))) {
112 printk(KERN_ERR "NFS: %s: id %u cl_exchange_flags 0x%x\n",
113 __func__, id, server->nfs_client->cl_exchange_flags);
114 goto out_no_driver;
116 ld_type = find_pnfs_driver(id);
117 if (!ld_type) {
118 request_module("%s-%u", LAYOUT_NFSV4_1_MODULE_PREFIX, id);
119 ld_type = find_pnfs_driver(id);
120 if (!ld_type) {
121 dprintk("%s: No pNFS module found for %u.\n",
122 __func__, id);
123 goto out_no_driver;
126 server->pnfs_curr_ld = ld_type;
127 if (ld_type->set_layoutdriver
128 && ld_type->set_layoutdriver(server, mntfh)) {
129 printk(KERN_ERR "NFS: %s: Error initializing pNFS layout "
130 "driver %u.\n", __func__, id);
131 module_put(ld_type->owner);
132 goto out_no_driver;
134 /* Bump the MDS count */
135 atomic_inc(&server->nfs_client->cl_mds_count);
137 dprintk("%s: pNFS module for %u set\n", __func__, id);
138 return;
140 out_no_driver:
141 dprintk("%s: Using NFSv4 I/O\n", __func__);
142 server->pnfs_curr_ld = NULL;
146 pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
148 int status = -EINVAL;
149 struct pnfs_layoutdriver_type *tmp;
151 if (ld_type->id == 0) {
152 printk(KERN_ERR "NFS: %s id 0 is reserved\n", __func__);
153 return status;
155 if (!ld_type->alloc_lseg || !ld_type->free_lseg) {
156 printk(KERN_ERR "NFS: %s Layout driver must provide "
157 "alloc_lseg and free_lseg.\n", __func__);
158 return status;
161 spin_lock(&pnfs_spinlock);
162 tmp = find_pnfs_driver_locked(ld_type->id);
163 if (!tmp) {
164 list_add(&ld_type->pnfs_tblid, &pnfs_modules_tbl);
165 status = 0;
166 dprintk("%s Registering id:%u name:%s\n", __func__, ld_type->id,
167 ld_type->name);
168 } else {
169 printk(KERN_ERR "NFS: %s Module with id %d already loaded!\n",
170 __func__, ld_type->id);
172 spin_unlock(&pnfs_spinlock);
174 return status;
176 EXPORT_SYMBOL_GPL(pnfs_register_layoutdriver);
178 void
179 pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
181 dprintk("%s Deregistering id:%u\n", __func__, ld_type->id);
182 spin_lock(&pnfs_spinlock);
183 list_del(&ld_type->pnfs_tblid);
184 spin_unlock(&pnfs_spinlock);
186 EXPORT_SYMBOL_GPL(pnfs_unregister_layoutdriver);
189 * pNFS client layout cache
192 /* Need to hold i_lock if caller does not already hold reference */
193 void
194 pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo)
196 atomic_inc(&lo->plh_refcount);
199 static struct pnfs_layout_hdr *
200 pnfs_alloc_layout_hdr(struct inode *ino, gfp_t gfp_flags)
202 struct pnfs_layoutdriver_type *ld = NFS_SERVER(ino)->pnfs_curr_ld;
203 return ld->alloc_layout_hdr(ino, gfp_flags);
206 static void
207 pnfs_free_layout_hdr(struct pnfs_layout_hdr *lo)
209 struct nfs_server *server = NFS_SERVER(lo->plh_inode);
210 struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
212 if (!list_empty(&lo->plh_layouts)) {
213 struct nfs_client *clp = server->nfs_client;
215 spin_lock(&clp->cl_lock);
216 list_del_init(&lo->plh_layouts);
217 spin_unlock(&clp->cl_lock);
219 put_rpccred(lo->plh_lc_cred);
220 return ld->free_layout_hdr(lo);
223 static void
224 pnfs_detach_layout_hdr(struct pnfs_layout_hdr *lo)
226 struct nfs_inode *nfsi = NFS_I(lo->plh_inode);
227 dprintk("%s: freeing layout cache %p\n", __func__, lo);
228 nfsi->layout = NULL;
229 /* Reset MDS Threshold I/O counters */
230 nfsi->write_io = 0;
231 nfsi->read_io = 0;
234 void
235 pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo)
237 struct inode *inode = lo->plh_inode;
239 if (atomic_dec_and_lock(&lo->plh_refcount, &inode->i_lock)) {
240 pnfs_detach_layout_hdr(lo);
241 spin_unlock(&inode->i_lock);
242 pnfs_free_layout_hdr(lo);
246 static int
247 pnfs_iomode_to_fail_bit(u32 iomode)
249 return iomode == IOMODE_RW ?
250 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
253 static void
254 pnfs_layout_set_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
256 lo->plh_retry_timestamp = jiffies;
257 if (test_and_set_bit(fail_bit, &lo->plh_flags))
258 atomic_inc(&lo->plh_refcount);
261 static void
262 pnfs_layout_clear_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
264 if (test_and_clear_bit(fail_bit, &lo->plh_flags))
265 atomic_dec(&lo->plh_refcount);
268 static void
269 pnfs_layout_io_set_failed(struct pnfs_layout_hdr *lo, u32 iomode)
271 struct inode *inode = lo->plh_inode;
272 struct pnfs_layout_range range = {
273 .iomode = iomode,
274 .offset = 0,
275 .length = NFS4_MAX_UINT64,
277 LIST_HEAD(head);
279 spin_lock(&inode->i_lock);
280 pnfs_layout_set_fail_bit(lo, pnfs_iomode_to_fail_bit(iomode));
281 pnfs_mark_matching_lsegs_invalid(lo, &head, &range);
282 spin_unlock(&inode->i_lock);
283 pnfs_free_lseg_list(&head);
284 dprintk("%s Setting layout IOMODE_%s fail bit\n", __func__,
285 iomode == IOMODE_RW ? "RW" : "READ");
288 static bool
289 pnfs_layout_io_test_failed(struct pnfs_layout_hdr *lo, u32 iomode)
291 unsigned long start, end;
292 int fail_bit = pnfs_iomode_to_fail_bit(iomode);
294 if (test_bit(fail_bit, &lo->plh_flags) == 0)
295 return false;
296 end = jiffies;
297 start = end - PNFS_LAYOUTGET_RETRY_TIMEOUT;
298 if (!time_in_range(lo->plh_retry_timestamp, start, end)) {
299 /* It is time to retry the failed layoutgets */
300 pnfs_layout_clear_fail_bit(lo, fail_bit);
301 return false;
303 return true;
306 static void
307 init_lseg(struct pnfs_layout_hdr *lo, struct pnfs_layout_segment *lseg)
309 INIT_LIST_HEAD(&lseg->pls_list);
310 INIT_LIST_HEAD(&lseg->pls_lc_list);
311 atomic_set(&lseg->pls_refcount, 1);
312 smp_mb();
313 set_bit(NFS_LSEG_VALID, &lseg->pls_flags);
314 lseg->pls_layout = lo;
317 static void pnfs_free_lseg(struct pnfs_layout_segment *lseg)
319 struct inode *ino = lseg->pls_layout->plh_inode;
321 NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
324 static void
325 pnfs_layout_remove_lseg(struct pnfs_layout_hdr *lo,
326 struct pnfs_layout_segment *lseg)
328 struct inode *inode = lo->plh_inode;
330 WARN_ON(test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
331 list_del_init(&lseg->pls_list);
332 /* Matched by pnfs_get_layout_hdr in pnfs_layout_insert_lseg */
333 atomic_dec(&lo->plh_refcount);
334 if (list_empty(&lo->plh_segs))
335 clear_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
336 rpc_wake_up(&NFS_SERVER(inode)->roc_rpcwaitq);
339 void
340 pnfs_put_lseg(struct pnfs_layout_segment *lseg)
342 struct pnfs_layout_hdr *lo;
343 struct inode *inode;
345 if (!lseg)
346 return;
348 dprintk("%s: lseg %p ref %d valid %d\n", __func__, lseg,
349 atomic_read(&lseg->pls_refcount),
350 test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
351 lo = lseg->pls_layout;
352 inode = lo->plh_inode;
353 if (atomic_dec_and_lock(&lseg->pls_refcount, &inode->i_lock)) {
354 pnfs_get_layout_hdr(lo);
355 pnfs_layout_remove_lseg(lo, lseg);
356 spin_unlock(&inode->i_lock);
357 pnfs_free_lseg(lseg);
358 pnfs_put_layout_hdr(lo);
361 EXPORT_SYMBOL_GPL(pnfs_put_lseg);
363 static inline u64
364 end_offset(u64 start, u64 len)
366 u64 end;
368 end = start + len;
369 return end >= start ? end : NFS4_MAX_UINT64;
372 /* last octet in a range */
373 static inline u64
374 last_byte_offset(u64 start, u64 len)
376 u64 end;
378 BUG_ON(!len);
379 end = start + len;
380 return end > start ? end - 1 : NFS4_MAX_UINT64;
384 * is l2 fully contained in l1?
385 * start1 end1
386 * [----------------------------------)
387 * start2 end2
388 * [----------------)
390 static inline int
391 lo_seg_contained(struct pnfs_layout_range *l1,
392 struct pnfs_layout_range *l2)
394 u64 start1 = l1->offset;
395 u64 end1 = end_offset(start1, l1->length);
396 u64 start2 = l2->offset;
397 u64 end2 = end_offset(start2, l2->length);
399 return (start1 <= start2) && (end1 >= end2);
403 * is l1 and l2 intersecting?
404 * start1 end1
405 * [----------------------------------)
406 * start2 end2
407 * [----------------)
409 static inline int
410 lo_seg_intersecting(struct pnfs_layout_range *l1,
411 struct pnfs_layout_range *l2)
413 u64 start1 = l1->offset;
414 u64 end1 = end_offset(start1, l1->length);
415 u64 start2 = l2->offset;
416 u64 end2 = end_offset(start2, l2->length);
418 return (end1 == NFS4_MAX_UINT64 || end1 > start2) &&
419 (end2 == NFS4_MAX_UINT64 || end2 > start1);
422 static bool
423 should_free_lseg(struct pnfs_layout_range *lseg_range,
424 struct pnfs_layout_range *recall_range)
426 return (recall_range->iomode == IOMODE_ANY ||
427 lseg_range->iomode == recall_range->iomode) &&
428 lo_seg_intersecting(lseg_range, recall_range);
431 /* Returns 1 if lseg is removed from list, 0 otherwise */
432 static int mark_lseg_invalid(struct pnfs_layout_segment *lseg,
433 struct list_head *tmp_list)
435 int rv = 0;
437 if (test_and_clear_bit(NFS_LSEG_VALID, &lseg->pls_flags)) {
438 /* Remove the reference keeping the lseg in the
439 * list. It will now be removed when all
440 * outstanding io is finished.
442 dprintk("%s: lseg %p ref %d\n", __func__, lseg,
443 atomic_read(&lseg->pls_refcount));
444 if (atomic_dec_and_test(&lseg->pls_refcount)) {
445 pnfs_layout_remove_lseg(lseg->pls_layout, lseg);
446 list_add(&lseg->pls_list, tmp_list);
447 rv = 1;
450 return rv;
453 /* Returns count of number of matching invalid lsegs remaining in list
454 * after call.
457 pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
458 struct list_head *tmp_list,
459 struct pnfs_layout_range *recall_range)
461 struct pnfs_layout_segment *lseg, *next;
462 int invalid = 0, removed = 0;
464 dprintk("%s:Begin lo %p\n", __func__, lo);
466 if (list_empty(&lo->plh_segs))
467 return 0;
468 list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
469 if (!recall_range ||
470 should_free_lseg(&lseg->pls_range, recall_range)) {
471 dprintk("%s: freeing lseg %p iomode %d "
472 "offset %llu length %llu\n", __func__,
473 lseg, lseg->pls_range.iomode, lseg->pls_range.offset,
474 lseg->pls_range.length);
475 invalid++;
476 removed += mark_lseg_invalid(lseg, tmp_list);
478 dprintk("%s:Return %i\n", __func__, invalid - removed);
479 return invalid - removed;
482 /* note free_me must contain lsegs from a single layout_hdr */
483 void
484 pnfs_free_lseg_list(struct list_head *free_me)
486 struct pnfs_layout_segment *lseg, *tmp;
488 if (list_empty(free_me))
489 return;
491 list_for_each_entry_safe(lseg, tmp, free_me, pls_list) {
492 list_del(&lseg->pls_list);
493 pnfs_free_lseg(lseg);
497 void
498 pnfs_destroy_layout(struct nfs_inode *nfsi)
500 struct pnfs_layout_hdr *lo;
501 LIST_HEAD(tmp_list);
503 spin_lock(&nfsi->vfs_inode.i_lock);
504 lo = nfsi->layout;
505 if (lo) {
506 lo->plh_block_lgets++; /* permanently block new LAYOUTGETs */
507 pnfs_mark_matching_lsegs_invalid(lo, &tmp_list, NULL);
508 pnfs_get_layout_hdr(lo);
509 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RO_FAILED);
510 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RW_FAILED);
511 spin_unlock(&nfsi->vfs_inode.i_lock);
512 pnfs_free_lseg_list(&tmp_list);
513 pnfs_put_layout_hdr(lo);
514 } else
515 spin_unlock(&nfsi->vfs_inode.i_lock);
517 EXPORT_SYMBOL_GPL(pnfs_destroy_layout);
520 * Called by the state manger to remove all layouts established under an
521 * expired lease.
523 void
524 pnfs_destroy_all_layouts(struct nfs_client *clp)
526 struct nfs_server *server;
527 struct pnfs_layout_hdr *lo;
528 LIST_HEAD(tmp_list);
530 nfs4_deviceid_mark_client_invalid(clp);
531 nfs4_deviceid_purge_client(clp);
533 spin_lock(&clp->cl_lock);
534 rcu_read_lock();
535 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
536 if (!list_empty(&server->layouts))
537 list_splice_init(&server->layouts, &tmp_list);
539 rcu_read_unlock();
540 spin_unlock(&clp->cl_lock);
542 while (!list_empty(&tmp_list)) {
543 lo = list_entry(tmp_list.next, struct pnfs_layout_hdr,
544 plh_layouts);
545 dprintk("%s freeing layout for inode %lu\n", __func__,
546 lo->plh_inode->i_ino);
547 list_del_init(&lo->plh_layouts);
548 pnfs_destroy_layout(NFS_I(lo->plh_inode));
553 * Compare 2 layout stateid sequence ids, to see which is newer,
554 * taking into account wraparound issues.
556 static bool pnfs_seqid_is_newer(u32 s1, u32 s2)
558 return (s32)s1 - (s32)s2 > 0;
561 /* update lo->plh_stateid with new if is more recent */
562 void
563 pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, const nfs4_stateid *new,
564 bool update_barrier)
566 u32 oldseq, newseq;
568 oldseq = be32_to_cpu(lo->plh_stateid.seqid);
569 newseq = be32_to_cpu(new->seqid);
570 if (list_empty(&lo->plh_segs) || pnfs_seqid_is_newer(newseq, oldseq)) {
571 nfs4_stateid_copy(&lo->plh_stateid, new);
572 if (update_barrier) {
573 u32 new_barrier = be32_to_cpu(new->seqid);
575 if (pnfs_seqid_is_newer(new_barrier, lo->plh_barrier))
576 lo->plh_barrier = new_barrier;
577 } else {
578 /* Because of wraparound, we want to keep the barrier
579 * "close" to the current seqids. It needs to be
580 * within 2**31 to count as "behind", so if it
581 * gets too near that limit, give us a litle leeway
582 * and bring it to within 2**30.
583 * NOTE - and yes, this is all unsigned arithmetic.
585 if (unlikely((newseq - lo->plh_barrier) > (3 << 29)))
586 lo->plh_barrier = newseq - (1 << 30);
591 /* lget is set to 1 if called from inside send_layoutget call chain */
592 static bool
593 pnfs_layoutgets_blocked(struct pnfs_layout_hdr *lo, nfs4_stateid *stateid,
594 int lget)
596 if (stateid != NULL) {
597 u32 seqid = be32_to_cpu(stateid->seqid);
599 if (!pnfs_seqid_is_newer(seqid, lo->plh_barrier))
600 return true;
602 return lo->plh_block_lgets ||
603 test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags) ||
604 (list_empty(&lo->plh_segs) &&
605 (atomic_read(&lo->plh_outstanding) > lget));
609 pnfs_choose_layoutget_stateid(nfs4_stateid *dst, struct pnfs_layout_hdr *lo,
610 struct nfs4_state *open_state)
612 int status = 0;
614 dprintk("--> %s\n", __func__);
615 spin_lock(&lo->plh_inode->i_lock);
616 if (pnfs_layoutgets_blocked(lo, NULL, 1)) {
617 status = -EAGAIN;
618 } else if (list_empty(&lo->plh_segs)) {
619 int seq;
621 do {
622 seq = read_seqbegin(&open_state->seqlock);
623 nfs4_stateid_copy(dst, &open_state->stateid);
624 } while (read_seqretry(&open_state->seqlock, seq));
625 } else
626 nfs4_stateid_copy(dst, &lo->plh_stateid);
627 spin_unlock(&lo->plh_inode->i_lock);
628 dprintk("<-- %s\n", __func__);
629 return status;
633 * Get layout from server.
634 * for now, assume that whole file layouts are requested.
635 * arg->offset: 0
636 * arg->length: all ones
638 static struct pnfs_layout_segment *
639 send_layoutget(struct pnfs_layout_hdr *lo,
640 struct nfs_open_context *ctx,
641 struct pnfs_layout_range *range,
642 gfp_t gfp_flags)
644 struct inode *ino = lo->plh_inode;
645 struct nfs_server *server = NFS_SERVER(ino);
646 struct nfs4_layoutget *lgp;
647 struct pnfs_layout_segment *lseg;
649 dprintk("--> %s\n", __func__);
651 BUG_ON(ctx == NULL);
652 lgp = kzalloc(sizeof(*lgp), gfp_flags);
653 if (lgp == NULL)
654 return NULL;
656 lgp->args.minlength = PAGE_CACHE_SIZE;
657 if (lgp->args.minlength > range->length)
658 lgp->args.minlength = range->length;
659 lgp->args.maxcount = PNFS_LAYOUT_MAXSIZE;
660 lgp->args.range = *range;
661 lgp->args.type = server->pnfs_curr_ld->id;
662 lgp->args.inode = ino;
663 lgp->args.ctx = get_nfs_open_context(ctx);
664 lgp->gfp_flags = gfp_flags;
666 /* Synchronously retrieve layout information from server and
667 * store in lseg.
669 lseg = nfs4_proc_layoutget(lgp, gfp_flags);
670 if (IS_ERR(lseg)) {
671 switch (PTR_ERR(lseg)) {
672 case -ENOMEM:
673 case -ERESTARTSYS:
674 break;
675 default:
676 /* remember that LAYOUTGET failed and suspend trying */
677 pnfs_layout_io_set_failed(lo, range->iomode);
679 return NULL;
682 return lseg;
686 * Initiates a LAYOUTRETURN(FILE), and removes the pnfs_layout_hdr
687 * when the layout segment list is empty.
689 * Note that a pnfs_layout_hdr can exist with an empty layout segment
690 * list when LAYOUTGET has failed, or when LAYOUTGET succeeded, but the
691 * deviceid is marked invalid.
694 _pnfs_return_layout(struct inode *ino)
696 struct pnfs_layout_hdr *lo = NULL;
697 struct nfs_inode *nfsi = NFS_I(ino);
698 LIST_HEAD(tmp_list);
699 struct nfs4_layoutreturn *lrp;
700 nfs4_stateid stateid;
701 int status = 0, empty;
703 dprintk("NFS: %s for inode %lu\n", __func__, ino->i_ino);
705 spin_lock(&ino->i_lock);
706 lo = nfsi->layout;
707 if (!lo) {
708 spin_unlock(&ino->i_lock);
709 dprintk("NFS: %s no layout to return\n", __func__);
710 goto out;
712 stateid = nfsi->layout->plh_stateid;
713 /* Reference matched in nfs4_layoutreturn_release */
714 pnfs_get_layout_hdr(lo);
715 empty = list_empty(&lo->plh_segs);
716 pnfs_mark_matching_lsegs_invalid(lo, &tmp_list, NULL);
717 /* Don't send a LAYOUTRETURN if list was initially empty */
718 if (empty) {
719 spin_unlock(&ino->i_lock);
720 pnfs_put_layout_hdr(lo);
721 dprintk("NFS: %s no layout segments to return\n", __func__);
722 goto out;
724 lo->plh_block_lgets++;
725 spin_unlock(&ino->i_lock);
726 pnfs_free_lseg_list(&tmp_list);
728 WARN_ON(test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags));
730 lrp = kzalloc(sizeof(*lrp), GFP_KERNEL);
731 if (unlikely(lrp == NULL)) {
732 status = -ENOMEM;
733 spin_lock(&ino->i_lock);
734 lo->plh_block_lgets--;
735 spin_unlock(&ino->i_lock);
736 pnfs_put_layout_hdr(lo);
737 goto out;
740 lrp->args.stateid = stateid;
741 lrp->args.layout_type = NFS_SERVER(ino)->pnfs_curr_ld->id;
742 lrp->args.inode = ino;
743 lrp->args.layout = lo;
744 lrp->clp = NFS_SERVER(ino)->nfs_client;
746 status = nfs4_proc_layoutreturn(lrp);
747 out:
748 dprintk("<-- %s status: %d\n", __func__, status);
749 return status;
751 EXPORT_SYMBOL_GPL(_pnfs_return_layout);
753 bool pnfs_roc(struct inode *ino)
755 struct pnfs_layout_hdr *lo;
756 struct pnfs_layout_segment *lseg, *tmp;
757 LIST_HEAD(tmp_list);
758 bool found = false;
760 spin_lock(&ino->i_lock);
761 lo = NFS_I(ino)->layout;
762 if (!lo || !test_and_clear_bit(NFS_LAYOUT_ROC, &lo->plh_flags) ||
763 test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags))
764 goto out_nolayout;
765 list_for_each_entry_safe(lseg, tmp, &lo->plh_segs, pls_list)
766 if (test_bit(NFS_LSEG_ROC, &lseg->pls_flags)) {
767 mark_lseg_invalid(lseg, &tmp_list);
768 found = true;
770 if (!found)
771 goto out_nolayout;
772 lo->plh_block_lgets++;
773 pnfs_get_layout_hdr(lo); /* matched in pnfs_roc_release */
774 spin_unlock(&ino->i_lock);
775 pnfs_free_lseg_list(&tmp_list);
776 return true;
778 out_nolayout:
779 spin_unlock(&ino->i_lock);
780 return false;
783 void pnfs_roc_release(struct inode *ino)
785 struct pnfs_layout_hdr *lo;
787 spin_lock(&ino->i_lock);
788 lo = NFS_I(ino)->layout;
789 lo->plh_block_lgets--;
790 if (atomic_dec_and_test(&lo->plh_refcount)) {
791 pnfs_detach_layout_hdr(lo);
792 spin_unlock(&ino->i_lock);
793 pnfs_free_layout_hdr(lo);
794 } else
795 spin_unlock(&ino->i_lock);
798 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
800 struct pnfs_layout_hdr *lo;
802 spin_lock(&ino->i_lock);
803 lo = NFS_I(ino)->layout;
804 if (pnfs_seqid_is_newer(barrier, lo->plh_barrier))
805 lo->plh_barrier = barrier;
806 spin_unlock(&ino->i_lock);
809 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
811 struct nfs_inode *nfsi = NFS_I(ino);
812 struct pnfs_layout_hdr *lo;
813 struct pnfs_layout_segment *lseg;
814 u32 current_seqid;
815 bool found = false;
817 spin_lock(&ino->i_lock);
818 list_for_each_entry(lseg, &nfsi->layout->plh_segs, pls_list)
819 if (test_bit(NFS_LSEG_ROC, &lseg->pls_flags)) {
820 rpc_sleep_on(&NFS_SERVER(ino)->roc_rpcwaitq, task, NULL);
821 found = true;
822 goto out;
824 lo = nfsi->layout;
825 current_seqid = be32_to_cpu(lo->plh_stateid.seqid);
827 /* Since close does not return a layout stateid for use as
828 * a barrier, we choose the worst-case barrier.
830 *barrier = current_seqid + atomic_read(&lo->plh_outstanding);
831 out:
832 spin_unlock(&ino->i_lock);
833 return found;
837 * Compare two layout segments for sorting into layout cache.
838 * We want to preferentially return RW over RO layouts, so ensure those
839 * are seen first.
841 static s64
842 cmp_layout(struct pnfs_layout_range *l1,
843 struct pnfs_layout_range *l2)
845 s64 d;
847 /* high offset > low offset */
848 d = l1->offset - l2->offset;
849 if (d)
850 return d;
852 /* short length > long length */
853 d = l2->length - l1->length;
854 if (d)
855 return d;
857 /* read > read/write */
858 return (int)(l1->iomode == IOMODE_READ) - (int)(l2->iomode == IOMODE_READ);
861 static void
862 pnfs_layout_insert_lseg(struct pnfs_layout_hdr *lo,
863 struct pnfs_layout_segment *lseg)
865 struct pnfs_layout_segment *lp;
867 dprintk("%s:Begin\n", __func__);
869 list_for_each_entry(lp, &lo->plh_segs, pls_list) {
870 if (cmp_layout(&lseg->pls_range, &lp->pls_range) > 0)
871 continue;
872 list_add_tail(&lseg->pls_list, &lp->pls_list);
873 dprintk("%s: inserted lseg %p "
874 "iomode %d offset %llu length %llu before "
875 "lp %p iomode %d offset %llu length %llu\n",
876 __func__, lseg, lseg->pls_range.iomode,
877 lseg->pls_range.offset, lseg->pls_range.length,
878 lp, lp->pls_range.iomode, lp->pls_range.offset,
879 lp->pls_range.length);
880 goto out;
882 list_add_tail(&lseg->pls_list, &lo->plh_segs);
883 dprintk("%s: inserted lseg %p "
884 "iomode %d offset %llu length %llu at tail\n",
885 __func__, lseg, lseg->pls_range.iomode,
886 lseg->pls_range.offset, lseg->pls_range.length);
887 out:
888 pnfs_get_layout_hdr(lo);
890 dprintk("%s:Return\n", __func__);
893 static struct pnfs_layout_hdr *
894 alloc_init_layout_hdr(struct inode *ino,
895 struct nfs_open_context *ctx,
896 gfp_t gfp_flags)
898 struct pnfs_layout_hdr *lo;
900 lo = pnfs_alloc_layout_hdr(ino, gfp_flags);
901 if (!lo)
902 return NULL;
903 atomic_set(&lo->plh_refcount, 1);
904 INIT_LIST_HEAD(&lo->plh_layouts);
905 INIT_LIST_HEAD(&lo->plh_segs);
906 INIT_LIST_HEAD(&lo->plh_bulk_recall);
907 lo->plh_inode = ino;
908 lo->plh_lc_cred = get_rpccred(ctx->state->owner->so_cred);
909 return lo;
912 static struct pnfs_layout_hdr *
913 pnfs_find_alloc_layout(struct inode *ino,
914 struct nfs_open_context *ctx,
915 gfp_t gfp_flags)
917 struct nfs_inode *nfsi = NFS_I(ino);
918 struct pnfs_layout_hdr *new = NULL;
920 dprintk("%s Begin ino=%p layout=%p\n", __func__, ino, nfsi->layout);
922 if (nfsi->layout != NULL)
923 goto out_existing;
924 spin_unlock(&ino->i_lock);
925 new = alloc_init_layout_hdr(ino, ctx, gfp_flags);
926 spin_lock(&ino->i_lock);
928 if (likely(nfsi->layout == NULL)) { /* Won the race? */
929 nfsi->layout = new;
930 return new;
932 pnfs_free_layout_hdr(new);
933 out_existing:
934 pnfs_get_layout_hdr(nfsi->layout);
935 return nfsi->layout;
939 * iomode matching rules:
940 * iomode lseg match
941 * ----- ----- -----
942 * ANY READ true
943 * ANY RW true
944 * RW READ false
945 * RW RW true
946 * READ READ true
947 * READ RW true
949 static int
950 is_matching_lseg(struct pnfs_layout_range *ls_range,
951 struct pnfs_layout_range *range)
953 struct pnfs_layout_range range1;
955 if ((range->iomode == IOMODE_RW &&
956 ls_range->iomode != IOMODE_RW) ||
957 !lo_seg_intersecting(ls_range, range))
958 return 0;
960 /* range1 covers only the first byte in the range */
961 range1 = *range;
962 range1.length = 1;
963 return lo_seg_contained(ls_range, &range1);
967 * lookup range in layout
969 static struct pnfs_layout_segment *
970 pnfs_find_lseg(struct pnfs_layout_hdr *lo,
971 struct pnfs_layout_range *range)
973 struct pnfs_layout_segment *lseg, *ret = NULL;
975 dprintk("%s:Begin\n", __func__);
977 list_for_each_entry(lseg, &lo->plh_segs, pls_list) {
978 if (test_bit(NFS_LSEG_VALID, &lseg->pls_flags) &&
979 is_matching_lseg(&lseg->pls_range, range)) {
980 ret = pnfs_get_lseg(lseg);
981 break;
983 if (lseg->pls_range.offset > range->offset)
984 break;
987 dprintk("%s:Return lseg %p ref %d\n",
988 __func__, ret, ret ? atomic_read(&ret->pls_refcount) : 0);
989 return ret;
993 * Use mdsthreshold hints set at each OPEN to determine if I/O should go
994 * to the MDS or over pNFS
996 * The nfs_inode read_io and write_io fields are cumulative counters reset
997 * when there are no layout segments. Note that in pnfs_update_layout iomode
998 * is set to IOMODE_READ for a READ request, and set to IOMODE_RW for a
999 * WRITE request.
1001 * A return of true means use MDS I/O.
1003 * From rfc 5661:
1004 * If a file's size is smaller than the file size threshold, data accesses
1005 * SHOULD be sent to the metadata server. If an I/O request has a length that
1006 * is below the I/O size threshold, the I/O SHOULD be sent to the metadata
1007 * server. If both file size and I/O size are provided, the client SHOULD
1008 * reach or exceed both thresholds before sending its read or write
1009 * requests to the data server.
1011 static bool pnfs_within_mdsthreshold(struct nfs_open_context *ctx,
1012 struct inode *ino, int iomode)
1014 struct nfs4_threshold *t = ctx->mdsthreshold;
1015 struct nfs_inode *nfsi = NFS_I(ino);
1016 loff_t fsize = i_size_read(ino);
1017 bool size = false, size_set = false, io = false, io_set = false, ret = false;
1019 if (t == NULL)
1020 return ret;
1022 dprintk("%s bm=0x%x rd_sz=%llu wr_sz=%llu rd_io=%llu wr_io=%llu\n",
1023 __func__, t->bm, t->rd_sz, t->wr_sz, t->rd_io_sz, t->wr_io_sz);
1025 switch (iomode) {
1026 case IOMODE_READ:
1027 if (t->bm & THRESHOLD_RD) {
1028 dprintk("%s fsize %llu\n", __func__, fsize);
1029 size_set = true;
1030 if (fsize < t->rd_sz)
1031 size = true;
1033 if (t->bm & THRESHOLD_RD_IO) {
1034 dprintk("%s nfsi->read_io %llu\n", __func__,
1035 nfsi->read_io);
1036 io_set = true;
1037 if (nfsi->read_io < t->rd_io_sz)
1038 io = true;
1040 break;
1041 case IOMODE_RW:
1042 if (t->bm & THRESHOLD_WR) {
1043 dprintk("%s fsize %llu\n", __func__, fsize);
1044 size_set = true;
1045 if (fsize < t->wr_sz)
1046 size = true;
1048 if (t->bm & THRESHOLD_WR_IO) {
1049 dprintk("%s nfsi->write_io %llu\n", __func__,
1050 nfsi->write_io);
1051 io_set = true;
1052 if (nfsi->write_io < t->wr_io_sz)
1053 io = true;
1055 break;
1057 if (size_set && io_set) {
1058 if (size && io)
1059 ret = true;
1060 } else if (size || io)
1061 ret = true;
1063 dprintk("<-- %s size %d io %d ret %d\n", __func__, size, io, ret);
1064 return ret;
1068 * Layout segment is retreived from the server if not cached.
1069 * The appropriate layout segment is referenced and returned to the caller.
1071 struct pnfs_layout_segment *
1072 pnfs_update_layout(struct inode *ino,
1073 struct nfs_open_context *ctx,
1074 loff_t pos,
1075 u64 count,
1076 enum pnfs_iomode iomode,
1077 gfp_t gfp_flags)
1079 struct pnfs_layout_range arg = {
1080 .iomode = iomode,
1081 .offset = pos,
1082 .length = count,
1084 unsigned pg_offset;
1085 struct nfs_server *server = NFS_SERVER(ino);
1086 struct nfs_client *clp = server->nfs_client;
1087 struct pnfs_layout_hdr *lo;
1088 struct pnfs_layout_segment *lseg = NULL;
1089 bool first = false;
1091 if (!pnfs_enabled_sb(NFS_SERVER(ino)))
1092 goto out;
1094 if (pnfs_within_mdsthreshold(ctx, ino, iomode))
1095 goto out;
1097 spin_lock(&ino->i_lock);
1098 lo = pnfs_find_alloc_layout(ino, ctx, gfp_flags);
1099 if (lo == NULL) {
1100 spin_unlock(&ino->i_lock);
1101 goto out;
1104 /* Do we even need to bother with this? */
1105 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
1106 dprintk("%s matches recall, use MDS\n", __func__);
1107 goto out_unlock;
1110 /* if LAYOUTGET already failed once we don't try again */
1111 if (pnfs_layout_io_test_failed(lo, iomode))
1112 goto out_unlock;
1114 /* Check to see if the layout for the given range already exists */
1115 lseg = pnfs_find_lseg(lo, &arg);
1116 if (lseg)
1117 goto out_unlock;
1119 if (pnfs_layoutgets_blocked(lo, NULL, 0))
1120 goto out_unlock;
1121 atomic_inc(&lo->plh_outstanding);
1123 if (list_empty(&lo->plh_segs))
1124 first = true;
1126 spin_unlock(&ino->i_lock);
1127 if (first) {
1128 /* The lo must be on the clp list if there is any
1129 * chance of a CB_LAYOUTRECALL(FILE) coming in.
1131 spin_lock(&clp->cl_lock);
1132 BUG_ON(!list_empty(&lo->plh_layouts));
1133 list_add_tail(&lo->plh_layouts, &server->layouts);
1134 spin_unlock(&clp->cl_lock);
1137 pg_offset = arg.offset & ~PAGE_CACHE_MASK;
1138 if (pg_offset) {
1139 arg.offset -= pg_offset;
1140 arg.length += pg_offset;
1142 if (arg.length != NFS4_MAX_UINT64)
1143 arg.length = PAGE_CACHE_ALIGN(arg.length);
1145 lseg = send_layoutget(lo, ctx, &arg, gfp_flags);
1146 atomic_dec(&lo->plh_outstanding);
1147 out_put_layout_hdr:
1148 pnfs_put_layout_hdr(lo);
1149 out:
1150 dprintk("%s: inode %s/%llu pNFS layout segment %s for "
1151 "(%s, offset: %llu, length: %llu)\n",
1152 __func__, ino->i_sb->s_id,
1153 (unsigned long long)NFS_FILEID(ino),
1154 lseg == NULL ? "not found" : "found",
1155 iomode==IOMODE_RW ? "read/write" : "read-only",
1156 (unsigned long long)pos,
1157 (unsigned long long)count);
1158 return lseg;
1159 out_unlock:
1160 spin_unlock(&ino->i_lock);
1161 goto out_put_layout_hdr;
1163 EXPORT_SYMBOL_GPL(pnfs_update_layout);
1165 struct pnfs_layout_segment *
1166 pnfs_layout_process(struct nfs4_layoutget *lgp)
1168 struct pnfs_layout_hdr *lo = NFS_I(lgp->args.inode)->layout;
1169 struct nfs4_layoutget_res *res = &lgp->res;
1170 struct pnfs_layout_segment *lseg;
1171 struct inode *ino = lo->plh_inode;
1172 int status = 0;
1174 /* Inject layout blob into I/O device driver */
1175 lseg = NFS_SERVER(ino)->pnfs_curr_ld->alloc_lseg(lo, res, lgp->gfp_flags);
1176 if (!lseg || IS_ERR(lseg)) {
1177 if (!lseg)
1178 status = -ENOMEM;
1179 else
1180 status = PTR_ERR(lseg);
1181 dprintk("%s: Could not allocate layout: error %d\n",
1182 __func__, status);
1183 goto out;
1186 spin_lock(&ino->i_lock);
1187 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
1188 dprintk("%s forget reply due to recall\n", __func__);
1189 goto out_forget_reply;
1192 if (pnfs_layoutgets_blocked(lo, &res->stateid, 1)) {
1193 dprintk("%s forget reply due to state\n", __func__);
1194 goto out_forget_reply;
1197 /* Done processing layoutget. Set the layout stateid */
1198 pnfs_set_layout_stateid(lo, &res->stateid, false);
1200 init_lseg(lo, lseg);
1201 lseg->pls_range = res->range;
1202 pnfs_get_lseg(lseg);
1203 pnfs_layout_insert_lseg(lo, lseg);
1205 if (res->return_on_close) {
1206 set_bit(NFS_LSEG_ROC, &lseg->pls_flags);
1207 set_bit(NFS_LAYOUT_ROC, &lo->plh_flags);
1210 spin_unlock(&ino->i_lock);
1211 return lseg;
1212 out:
1213 return ERR_PTR(status);
1215 out_forget_reply:
1216 spin_unlock(&ino->i_lock);
1217 lseg->pls_layout = lo;
1218 NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
1219 goto out;
1222 void
1223 pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
1225 BUG_ON(pgio->pg_lseg != NULL);
1227 if (req->wb_offset != req->wb_pgbase) {
1228 nfs_pageio_reset_read_mds(pgio);
1229 return;
1231 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
1232 req->wb_context,
1233 req_offset(req),
1234 req->wb_bytes,
1235 IOMODE_READ,
1236 GFP_KERNEL);
1237 /* If no lseg, fall back to read through mds */
1238 if (pgio->pg_lseg == NULL)
1239 nfs_pageio_reset_read_mds(pgio);
1242 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_read);
1244 void
1245 pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
1247 BUG_ON(pgio->pg_lseg != NULL);
1249 if (req->wb_offset != req->wb_pgbase) {
1250 nfs_pageio_reset_write_mds(pgio);
1251 return;
1253 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
1254 req->wb_context,
1255 req_offset(req),
1256 req->wb_bytes,
1257 IOMODE_RW,
1258 GFP_NOFS);
1259 /* If no lseg, fall back to write through mds */
1260 if (pgio->pg_lseg == NULL)
1261 nfs_pageio_reset_write_mds(pgio);
1263 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_write);
1265 void
1266 pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
1267 const struct nfs_pgio_completion_ops *compl_ops)
1269 struct nfs_server *server = NFS_SERVER(inode);
1270 struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
1272 if (ld == NULL)
1273 nfs_pageio_init_read(pgio, inode, compl_ops);
1274 else
1275 nfs_pageio_init(pgio, inode, ld->pg_read_ops, compl_ops, server->rsize, 0);
1278 void
1279 pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode,
1280 int ioflags,
1281 const struct nfs_pgio_completion_ops *compl_ops)
1283 struct nfs_server *server = NFS_SERVER(inode);
1284 struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
1286 if (ld == NULL)
1287 nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
1288 else
1289 nfs_pageio_init(pgio, inode, ld->pg_write_ops, compl_ops, server->wsize, ioflags);
1292 bool
1293 pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev,
1294 struct nfs_page *req)
1296 if (pgio->pg_lseg == NULL)
1297 return nfs_generic_pg_test(pgio, prev, req);
1300 * Test if a nfs_page is fully contained in the pnfs_layout_range.
1301 * Note that this test makes several assumptions:
1302 * - that the previous nfs_page in the struct nfs_pageio_descriptor
1303 * is known to lie within the range.
1304 * - that the nfs_page being tested is known to be contiguous with the
1305 * previous nfs_page.
1306 * - Layout ranges are page aligned, so we only have to test the
1307 * start offset of the request.
1309 * Please also note that 'end_offset' is actually the offset of the
1310 * first byte that lies outside the pnfs_layout_range. FIXME?
1313 return req_offset(req) < end_offset(pgio->pg_lseg->pls_range.offset,
1314 pgio->pg_lseg->pls_range.length);
1316 EXPORT_SYMBOL_GPL(pnfs_generic_pg_test);
1318 int pnfs_write_done_resend_to_mds(struct inode *inode,
1319 struct list_head *head,
1320 const struct nfs_pgio_completion_ops *compl_ops)
1322 struct nfs_pageio_descriptor pgio;
1323 LIST_HEAD(failed);
1325 /* Resend all requests through the MDS */
1326 nfs_pageio_init_write(&pgio, inode, FLUSH_STABLE, compl_ops);
1327 while (!list_empty(head)) {
1328 struct nfs_page *req = nfs_list_entry(head->next);
1330 nfs_list_remove_request(req);
1331 if (!nfs_pageio_add_request(&pgio, req))
1332 nfs_list_add_request(req, &failed);
1334 nfs_pageio_complete(&pgio);
1336 if (!list_empty(&failed)) {
1337 /* For some reason our attempt to resend pages. Mark the
1338 * overall send request as having failed, and let
1339 * nfs_writeback_release_full deal with the error.
1341 list_move(&failed, head);
1342 return -EIO;
1344 return 0;
1346 EXPORT_SYMBOL_GPL(pnfs_write_done_resend_to_mds);
1348 static void pnfs_ld_handle_write_error(struct nfs_write_data *data)
1350 struct nfs_pgio_header *hdr = data->header;
1352 dprintk("pnfs write error = %d\n", hdr->pnfs_error);
1353 if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
1354 PNFS_LAYOUTRET_ON_ERROR) {
1355 clear_bit(NFS_INO_LAYOUTCOMMIT, &NFS_I(hdr->inode)->flags);
1356 pnfs_return_layout(hdr->inode);
1358 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
1359 data->task.tk_status = pnfs_write_done_resend_to_mds(hdr->inode,
1360 &hdr->pages,
1361 hdr->completion_ops);
1365 * Called by non rpc-based layout drivers
1367 void pnfs_ld_write_done(struct nfs_write_data *data)
1369 struct nfs_pgio_header *hdr = data->header;
1371 if (!hdr->pnfs_error) {
1372 pnfs_set_layoutcommit(data);
1373 hdr->mds_ops->rpc_call_done(&data->task, data);
1374 } else
1375 pnfs_ld_handle_write_error(data);
1376 hdr->mds_ops->rpc_release(data);
1378 EXPORT_SYMBOL_GPL(pnfs_ld_write_done);
1380 static void
1381 pnfs_write_through_mds(struct nfs_pageio_descriptor *desc,
1382 struct nfs_write_data *data)
1384 struct nfs_pgio_header *hdr = data->header;
1386 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
1387 list_splice_tail_init(&hdr->pages, &desc->pg_list);
1388 nfs_pageio_reset_write_mds(desc);
1389 desc->pg_recoalesce = 1;
1391 nfs_writedata_release(data);
1394 static enum pnfs_try_status
1395 pnfs_try_to_write_data(struct nfs_write_data *wdata,
1396 const struct rpc_call_ops *call_ops,
1397 struct pnfs_layout_segment *lseg,
1398 int how)
1400 struct nfs_pgio_header *hdr = wdata->header;
1401 struct inode *inode = hdr->inode;
1402 enum pnfs_try_status trypnfs;
1403 struct nfs_server *nfss = NFS_SERVER(inode);
1405 hdr->mds_ops = call_ops;
1407 dprintk("%s: Writing ino:%lu %u@%llu (how %d)\n", __func__,
1408 inode->i_ino, wdata->args.count, wdata->args.offset, how);
1409 trypnfs = nfss->pnfs_curr_ld->write_pagelist(wdata, how);
1410 if (trypnfs != PNFS_NOT_ATTEMPTED)
1411 nfs_inc_stats(inode, NFSIOS_PNFS_WRITE);
1412 dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
1413 return trypnfs;
1416 static void
1417 pnfs_do_multiple_writes(struct nfs_pageio_descriptor *desc, struct list_head *head, int how)
1419 struct nfs_write_data *data;
1420 const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
1421 struct pnfs_layout_segment *lseg = desc->pg_lseg;
1423 desc->pg_lseg = NULL;
1424 while (!list_empty(head)) {
1425 enum pnfs_try_status trypnfs;
1427 data = list_first_entry(head, struct nfs_write_data, list);
1428 list_del_init(&data->list);
1430 trypnfs = pnfs_try_to_write_data(data, call_ops, lseg, how);
1431 if (trypnfs == PNFS_NOT_ATTEMPTED)
1432 pnfs_write_through_mds(desc, data);
1434 pnfs_put_lseg(lseg);
1437 static void pnfs_writehdr_free(struct nfs_pgio_header *hdr)
1439 pnfs_put_lseg(hdr->lseg);
1440 nfs_writehdr_free(hdr);
1442 EXPORT_SYMBOL_GPL(pnfs_writehdr_free);
1445 pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc)
1447 struct nfs_write_header *whdr;
1448 struct nfs_pgio_header *hdr;
1449 int ret;
1451 whdr = nfs_writehdr_alloc();
1452 if (!whdr) {
1453 desc->pg_completion_ops->error_cleanup(&desc->pg_list);
1454 pnfs_put_lseg(desc->pg_lseg);
1455 desc->pg_lseg = NULL;
1456 return -ENOMEM;
1458 hdr = &whdr->header;
1459 nfs_pgheader_init(desc, hdr, pnfs_writehdr_free);
1460 hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
1461 atomic_inc(&hdr->refcnt);
1462 ret = nfs_generic_flush(desc, hdr);
1463 if (ret != 0) {
1464 pnfs_put_lseg(desc->pg_lseg);
1465 desc->pg_lseg = NULL;
1466 } else
1467 pnfs_do_multiple_writes(desc, &hdr->rpc_list, desc->pg_ioflags);
1468 if (atomic_dec_and_test(&hdr->refcnt))
1469 hdr->completion_ops->completion(hdr);
1470 return ret;
1472 EXPORT_SYMBOL_GPL(pnfs_generic_pg_writepages);
1474 int pnfs_read_done_resend_to_mds(struct inode *inode,
1475 struct list_head *head,
1476 const struct nfs_pgio_completion_ops *compl_ops)
1478 struct nfs_pageio_descriptor pgio;
1479 LIST_HEAD(failed);
1481 /* Resend all requests through the MDS */
1482 nfs_pageio_init_read(&pgio, inode, compl_ops);
1483 while (!list_empty(head)) {
1484 struct nfs_page *req = nfs_list_entry(head->next);
1486 nfs_list_remove_request(req);
1487 if (!nfs_pageio_add_request(&pgio, req))
1488 nfs_list_add_request(req, &failed);
1490 nfs_pageio_complete(&pgio);
1492 if (!list_empty(&failed)) {
1493 list_move(&failed, head);
1494 return -EIO;
1496 return 0;
1498 EXPORT_SYMBOL_GPL(pnfs_read_done_resend_to_mds);
1500 static void pnfs_ld_handle_read_error(struct nfs_read_data *data)
1502 struct nfs_pgio_header *hdr = data->header;
1504 dprintk("pnfs read error = %d\n", hdr->pnfs_error);
1505 if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
1506 PNFS_LAYOUTRET_ON_ERROR) {
1507 clear_bit(NFS_INO_LAYOUTCOMMIT, &NFS_I(hdr->inode)->flags);
1508 pnfs_return_layout(hdr->inode);
1510 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
1511 data->task.tk_status = pnfs_read_done_resend_to_mds(hdr->inode,
1512 &hdr->pages,
1513 hdr->completion_ops);
1517 * Called by non rpc-based layout drivers
1519 void pnfs_ld_read_done(struct nfs_read_data *data)
1521 struct nfs_pgio_header *hdr = data->header;
1523 if (likely(!hdr->pnfs_error)) {
1524 __nfs4_read_done_cb(data);
1525 hdr->mds_ops->rpc_call_done(&data->task, data);
1526 } else
1527 pnfs_ld_handle_read_error(data);
1528 hdr->mds_ops->rpc_release(data);
1530 EXPORT_SYMBOL_GPL(pnfs_ld_read_done);
1532 static void
1533 pnfs_read_through_mds(struct nfs_pageio_descriptor *desc,
1534 struct nfs_read_data *data)
1536 struct nfs_pgio_header *hdr = data->header;
1538 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
1539 list_splice_tail_init(&hdr->pages, &desc->pg_list);
1540 nfs_pageio_reset_read_mds(desc);
1541 desc->pg_recoalesce = 1;
1543 nfs_readdata_release(data);
1547 * Call the appropriate parallel I/O subsystem read function.
1549 static enum pnfs_try_status
1550 pnfs_try_to_read_data(struct nfs_read_data *rdata,
1551 const struct rpc_call_ops *call_ops,
1552 struct pnfs_layout_segment *lseg)
1554 struct nfs_pgio_header *hdr = rdata->header;
1555 struct inode *inode = hdr->inode;
1556 struct nfs_server *nfss = NFS_SERVER(inode);
1557 enum pnfs_try_status trypnfs;
1559 hdr->mds_ops = call_ops;
1561 dprintk("%s: Reading ino:%lu %u@%llu\n",
1562 __func__, inode->i_ino, rdata->args.count, rdata->args.offset);
1564 trypnfs = nfss->pnfs_curr_ld->read_pagelist(rdata);
1565 if (trypnfs != PNFS_NOT_ATTEMPTED)
1566 nfs_inc_stats(inode, NFSIOS_PNFS_READ);
1567 dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
1568 return trypnfs;
1571 static void
1572 pnfs_do_multiple_reads(struct nfs_pageio_descriptor *desc, struct list_head *head)
1574 struct nfs_read_data *data;
1575 const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
1576 struct pnfs_layout_segment *lseg = desc->pg_lseg;
1578 desc->pg_lseg = NULL;
1579 while (!list_empty(head)) {
1580 enum pnfs_try_status trypnfs;
1582 data = list_first_entry(head, struct nfs_read_data, list);
1583 list_del_init(&data->list);
1585 trypnfs = pnfs_try_to_read_data(data, call_ops, lseg);
1586 if (trypnfs == PNFS_NOT_ATTEMPTED)
1587 pnfs_read_through_mds(desc, data);
1589 pnfs_put_lseg(lseg);
1592 static void pnfs_readhdr_free(struct nfs_pgio_header *hdr)
1594 pnfs_put_lseg(hdr->lseg);
1595 nfs_readhdr_free(hdr);
1597 EXPORT_SYMBOL_GPL(pnfs_readhdr_free);
1600 pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc)
1602 struct nfs_read_header *rhdr;
1603 struct nfs_pgio_header *hdr;
1604 int ret;
1606 rhdr = nfs_readhdr_alloc();
1607 if (!rhdr) {
1608 desc->pg_completion_ops->error_cleanup(&desc->pg_list);
1609 ret = -ENOMEM;
1610 pnfs_put_lseg(desc->pg_lseg);
1611 desc->pg_lseg = NULL;
1612 return ret;
1614 hdr = &rhdr->header;
1615 nfs_pgheader_init(desc, hdr, pnfs_readhdr_free);
1616 hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
1617 atomic_inc(&hdr->refcnt);
1618 ret = nfs_generic_pagein(desc, hdr);
1619 if (ret != 0) {
1620 pnfs_put_lseg(desc->pg_lseg);
1621 desc->pg_lseg = NULL;
1622 } else
1623 pnfs_do_multiple_reads(desc, &hdr->rpc_list);
1624 if (atomic_dec_and_test(&hdr->refcnt))
1625 hdr->completion_ops->completion(hdr);
1626 return ret;
1628 EXPORT_SYMBOL_GPL(pnfs_generic_pg_readpages);
1631 * There can be multiple RW segments.
1633 static void pnfs_list_write_lseg(struct inode *inode, struct list_head *listp)
1635 struct pnfs_layout_segment *lseg;
1637 list_for_each_entry(lseg, &NFS_I(inode)->layout->plh_segs, pls_list) {
1638 if (lseg->pls_range.iomode == IOMODE_RW &&
1639 test_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags))
1640 list_add(&lseg->pls_lc_list, listp);
1644 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg)
1646 pnfs_layout_io_set_failed(lseg->pls_layout, lseg->pls_range.iomode);
1648 EXPORT_SYMBOL_GPL(pnfs_set_lo_fail);
1650 void
1651 pnfs_set_layoutcommit(struct nfs_write_data *wdata)
1653 struct nfs_pgio_header *hdr = wdata->header;
1654 struct inode *inode = hdr->inode;
1655 struct nfs_inode *nfsi = NFS_I(inode);
1656 loff_t end_pos = wdata->mds_offset + wdata->res.count;
1657 bool mark_as_dirty = false;
1659 spin_lock(&inode->i_lock);
1660 if (!test_and_set_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags)) {
1661 mark_as_dirty = true;
1662 dprintk("%s: Set layoutcommit for inode %lu ",
1663 __func__, inode->i_ino);
1665 if (!test_and_set_bit(NFS_LSEG_LAYOUTCOMMIT, &hdr->lseg->pls_flags)) {
1666 /* references matched in nfs4_layoutcommit_release */
1667 pnfs_get_lseg(hdr->lseg);
1669 if (end_pos > nfsi->layout->plh_lwb)
1670 nfsi->layout->plh_lwb = end_pos;
1671 spin_unlock(&inode->i_lock);
1672 dprintk("%s: lseg %p end_pos %llu\n",
1673 __func__, hdr->lseg, nfsi->layout->plh_lwb);
1675 /* if pnfs_layoutcommit_inode() runs between inode locks, the next one
1676 * will be a noop because NFS_INO_LAYOUTCOMMIT will not be set */
1677 if (mark_as_dirty)
1678 mark_inode_dirty_sync(inode);
1680 EXPORT_SYMBOL_GPL(pnfs_set_layoutcommit);
1682 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data)
1684 struct nfs_server *nfss = NFS_SERVER(data->args.inode);
1686 if (nfss->pnfs_curr_ld->cleanup_layoutcommit)
1687 nfss->pnfs_curr_ld->cleanup_layoutcommit(data);
1691 * For the LAYOUT4_NFSV4_1_FILES layout type, NFS_DATA_SYNC WRITEs and
1692 * NFS_UNSTABLE WRITEs with a COMMIT to data servers must store enough
1693 * data to disk to allow the server to recover the data if it crashes.
1694 * LAYOUTCOMMIT is only needed when the NFL4_UFLG_COMMIT_THRU_MDS flag
1695 * is off, and a COMMIT is sent to a data server, or
1696 * if WRITEs to a data server return NFS_DATA_SYNC.
1699 pnfs_layoutcommit_inode(struct inode *inode, bool sync)
1701 struct nfs4_layoutcommit_data *data;
1702 struct nfs_inode *nfsi = NFS_I(inode);
1703 loff_t end_pos;
1704 int status = 0;
1706 dprintk("--> %s inode %lu\n", __func__, inode->i_ino);
1708 if (!test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
1709 return 0;
1711 /* Note kzalloc ensures data->res.seq_res.sr_slot == NULL */
1712 data = kzalloc(sizeof(*data), GFP_NOFS);
1713 if (!data) {
1714 status = -ENOMEM;
1715 goto out;
1718 if (!test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
1719 goto out_free;
1721 if (test_and_set_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags)) {
1722 if (!sync) {
1723 status = -EAGAIN;
1724 goto out_free;
1726 status = wait_on_bit_lock(&nfsi->flags, NFS_INO_LAYOUTCOMMITTING,
1727 nfs_wait_bit_killable, TASK_KILLABLE);
1728 if (status)
1729 goto out_free;
1732 INIT_LIST_HEAD(&data->lseg_list);
1733 spin_lock(&inode->i_lock);
1734 if (!test_and_clear_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags)) {
1735 clear_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags);
1736 spin_unlock(&inode->i_lock);
1737 wake_up_bit(&nfsi->flags, NFS_INO_LAYOUTCOMMITTING);
1738 goto out_free;
1741 pnfs_list_write_lseg(inode, &data->lseg_list);
1743 end_pos = nfsi->layout->plh_lwb;
1744 nfsi->layout->plh_lwb = 0;
1746 nfs4_stateid_copy(&data->args.stateid, &nfsi->layout->plh_stateid);
1747 spin_unlock(&inode->i_lock);
1749 data->args.inode = inode;
1750 data->cred = get_rpccred(nfsi->layout->plh_lc_cred);
1751 nfs_fattr_init(&data->fattr);
1752 data->args.bitmask = NFS_SERVER(inode)->cache_consistency_bitmask;
1753 data->res.fattr = &data->fattr;
1754 data->args.lastbytewritten = end_pos - 1;
1755 data->res.server = NFS_SERVER(inode);
1757 status = nfs4_proc_layoutcommit(data, sync);
1758 out:
1759 if (status)
1760 mark_inode_dirty_sync(inode);
1761 dprintk("<-- %s status %d\n", __func__, status);
1762 return status;
1763 out_free:
1764 kfree(data);
1765 goto out;
1768 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
1770 struct nfs4_threshold *thp;
1772 thp = kzalloc(sizeof(*thp), GFP_NOFS);
1773 if (!thp) {
1774 dprintk("%s mdsthreshold allocation failed\n", __func__);
1775 return NULL;
1777 return thp;