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
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
30 #include <linux/nfs_fs.h>
31 #include <linux/nfs_page.h>
32 #include <linux/module.h>
36 #include "nfs4trace.h"
38 #define NFSDBG_FACILITY NFSDBG_PNFS
39 #define PNFS_LAYOUTGET_RETRY_TIMEOUT (120*HZ)
44 * protects pnfs_modules_tbl.
46 static DEFINE_SPINLOCK(pnfs_spinlock);
49 * pnfs_modules_tbl holds all pnfs modules
51 static LIST_HEAD(pnfs_modules_tbl);
54 pnfs_send_layoutreturn(struct pnfs_layout_hdr *lo, nfs4_stateid stateid,
55 enum pnfs_iomode iomode);
57 /* Return the registered pnfs layout driver module matching given id */
58 static struct pnfs_layoutdriver_type *
59 find_pnfs_driver_locked(u32 id)
61 struct pnfs_layoutdriver_type *local;
63 list_for_each_entry(local, &pnfs_modules_tbl, pnfs_tblid)
68 dprintk("%s: Searching for id %u, found %p\n", __func__, id, local);
72 static struct pnfs_layoutdriver_type *
73 find_pnfs_driver(u32 id)
75 struct pnfs_layoutdriver_type *local;
77 spin_lock(&pnfs_spinlock);
78 local = find_pnfs_driver_locked(id);
79 if (local != NULL && !try_module_get(local->owner)) {
80 dprintk("%s: Could not grab reference on module\n", __func__);
83 spin_unlock(&pnfs_spinlock);
88 unset_pnfs_layoutdriver(struct nfs_server *nfss)
90 if (nfss->pnfs_curr_ld) {
91 if (nfss->pnfs_curr_ld->clear_layoutdriver)
92 nfss->pnfs_curr_ld->clear_layoutdriver(nfss);
93 /* Decrement the MDS count. Purge the deviceid cache if zero */
94 if (atomic_dec_and_test(&nfss->nfs_client->cl_mds_count))
95 nfs4_deviceid_purge_client(nfss->nfs_client);
96 module_put(nfss->pnfs_curr_ld->owner);
98 nfss->pnfs_curr_ld = NULL;
102 * Try to set the server's pnfs module to the pnfs layout type specified by id.
103 * Currently only one pNFS layout driver per filesystem is supported.
105 * @id layout type. Zero (illegal layout type) indicates pNFS not in use.
108 set_pnfs_layoutdriver(struct nfs_server *server, const struct nfs_fh *mntfh,
111 struct pnfs_layoutdriver_type *ld_type = NULL;
115 if (!(server->nfs_client->cl_exchange_flags &
116 (EXCHGID4_FLAG_USE_NON_PNFS | EXCHGID4_FLAG_USE_PNFS_MDS))) {
117 printk(KERN_ERR "NFS: %s: id %u cl_exchange_flags 0x%x\n",
118 __func__, id, server->nfs_client->cl_exchange_flags);
121 ld_type = find_pnfs_driver(id);
123 request_module("%s-%u", LAYOUT_NFSV4_1_MODULE_PREFIX, id);
124 ld_type = find_pnfs_driver(id);
126 dprintk("%s: No pNFS module found for %u.\n",
131 server->pnfs_curr_ld = ld_type;
132 if (ld_type->set_layoutdriver
133 && ld_type->set_layoutdriver(server, mntfh)) {
134 printk(KERN_ERR "NFS: %s: Error initializing pNFS layout "
135 "driver %u.\n", __func__, id);
136 module_put(ld_type->owner);
139 /* Bump the MDS count */
140 atomic_inc(&server->nfs_client->cl_mds_count);
142 dprintk("%s: pNFS module for %u set\n", __func__, id);
146 dprintk("%s: Using NFSv4 I/O\n", __func__);
147 server->pnfs_curr_ld = NULL;
151 pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
153 int status = -EINVAL;
154 struct pnfs_layoutdriver_type *tmp;
156 if (ld_type->id == 0) {
157 printk(KERN_ERR "NFS: %s id 0 is reserved\n", __func__);
160 if (!ld_type->alloc_lseg || !ld_type->free_lseg) {
161 printk(KERN_ERR "NFS: %s Layout driver must provide "
162 "alloc_lseg and free_lseg.\n", __func__);
166 spin_lock(&pnfs_spinlock);
167 tmp = find_pnfs_driver_locked(ld_type->id);
169 list_add(&ld_type->pnfs_tblid, &pnfs_modules_tbl);
171 dprintk("%s Registering id:%u name:%s\n", __func__, ld_type->id,
174 printk(KERN_ERR "NFS: %s Module with id %d already loaded!\n",
175 __func__, ld_type->id);
177 spin_unlock(&pnfs_spinlock);
181 EXPORT_SYMBOL_GPL(pnfs_register_layoutdriver);
184 pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
186 dprintk("%s Deregistering id:%u\n", __func__, ld_type->id);
187 spin_lock(&pnfs_spinlock);
188 list_del(&ld_type->pnfs_tblid);
189 spin_unlock(&pnfs_spinlock);
191 EXPORT_SYMBOL_GPL(pnfs_unregister_layoutdriver);
194 * pNFS client layout cache
197 /* Need to hold i_lock if caller does not already hold reference */
199 pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo)
201 atomic_inc(&lo->plh_refcount);
204 static struct pnfs_layout_hdr *
205 pnfs_alloc_layout_hdr(struct inode *ino, gfp_t gfp_flags)
207 struct pnfs_layoutdriver_type *ld = NFS_SERVER(ino)->pnfs_curr_ld;
208 return ld->alloc_layout_hdr(ino, gfp_flags);
212 pnfs_free_layout_hdr(struct pnfs_layout_hdr *lo)
214 struct nfs_server *server = NFS_SERVER(lo->plh_inode);
215 struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
217 if (!list_empty(&lo->plh_layouts)) {
218 struct nfs_client *clp = server->nfs_client;
220 spin_lock(&clp->cl_lock);
221 list_del_init(&lo->plh_layouts);
222 spin_unlock(&clp->cl_lock);
224 put_rpccred(lo->plh_lc_cred);
225 return ld->free_layout_hdr(lo);
229 pnfs_detach_layout_hdr(struct pnfs_layout_hdr *lo)
231 struct nfs_inode *nfsi = NFS_I(lo->plh_inode);
232 dprintk("%s: freeing layout cache %p\n", __func__, lo);
234 /* Reset MDS Threshold I/O counters */
240 pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo)
242 struct inode *inode = lo->plh_inode;
244 if (atomic_dec_and_lock(&lo->plh_refcount, &inode->i_lock)) {
245 if (!list_empty(&lo->plh_segs))
246 WARN_ONCE(1, "NFS: BUG unfreed layout segments.\n");
247 pnfs_detach_layout_hdr(lo);
248 spin_unlock(&inode->i_lock);
249 pnfs_free_layout_hdr(lo);
254 pnfs_iomode_to_fail_bit(u32 iomode)
256 return iomode == IOMODE_RW ?
257 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
261 pnfs_layout_set_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
263 lo->plh_retry_timestamp = jiffies;
264 if (!test_and_set_bit(fail_bit, &lo->plh_flags))
265 atomic_inc(&lo->plh_refcount);
269 pnfs_layout_clear_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
271 if (test_and_clear_bit(fail_bit, &lo->plh_flags))
272 atomic_dec(&lo->plh_refcount);
276 pnfs_layout_io_set_failed(struct pnfs_layout_hdr *lo, u32 iomode)
278 struct inode *inode = lo->plh_inode;
279 struct pnfs_layout_range range = {
282 .length = NFS4_MAX_UINT64,
286 spin_lock(&inode->i_lock);
287 pnfs_layout_set_fail_bit(lo, pnfs_iomode_to_fail_bit(iomode));
288 pnfs_mark_matching_lsegs_invalid(lo, &head, &range);
289 spin_unlock(&inode->i_lock);
290 pnfs_free_lseg_list(&head);
291 dprintk("%s Setting layout IOMODE_%s fail bit\n", __func__,
292 iomode == IOMODE_RW ? "RW" : "READ");
296 pnfs_layout_io_test_failed(struct pnfs_layout_hdr *lo, u32 iomode)
298 unsigned long start, end;
299 int fail_bit = pnfs_iomode_to_fail_bit(iomode);
301 if (test_bit(fail_bit, &lo->plh_flags) == 0)
304 start = end - PNFS_LAYOUTGET_RETRY_TIMEOUT;
305 if (!time_in_range(lo->plh_retry_timestamp, start, end)) {
306 /* It is time to retry the failed layoutgets */
307 pnfs_layout_clear_fail_bit(lo, fail_bit);
314 init_lseg(struct pnfs_layout_hdr *lo, struct pnfs_layout_segment *lseg)
316 INIT_LIST_HEAD(&lseg->pls_list);
317 INIT_LIST_HEAD(&lseg->pls_lc_list);
318 atomic_set(&lseg->pls_refcount, 1);
320 set_bit(NFS_LSEG_VALID, &lseg->pls_flags);
321 lseg->pls_layout = lo;
324 static void pnfs_free_lseg(struct pnfs_layout_segment *lseg)
326 struct inode *ino = lseg->pls_layout->plh_inode;
328 NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
332 pnfs_layout_remove_lseg(struct pnfs_layout_hdr *lo,
333 struct pnfs_layout_segment *lseg)
335 struct inode *inode = lo->plh_inode;
337 WARN_ON(test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
338 list_del_init(&lseg->pls_list);
339 /* Matched by pnfs_get_layout_hdr in pnfs_layout_insert_lseg */
340 atomic_dec(&lo->plh_refcount);
341 if (list_empty(&lo->plh_segs))
342 clear_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
343 rpc_wake_up(&NFS_SERVER(inode)->roc_rpcwaitq);
346 /* Return true if layoutreturn is needed */
348 pnfs_layout_need_return(struct pnfs_layout_hdr *lo,
349 struct pnfs_layout_segment *lseg,
350 nfs4_stateid *stateid, enum pnfs_iomode *iomode)
352 struct pnfs_layout_segment *s;
354 if (!test_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags))
357 list_for_each_entry(s, &lo->plh_segs, pls_list)
358 if (test_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags))
361 *stateid = lo->plh_stateid;
362 *iomode = lo->plh_return_iomode;
363 /* decreased in pnfs_send_layoutreturn() */
364 lo->plh_block_lgets++;
365 lo->plh_return_iomode = 0;
370 pnfs_put_lseg(struct pnfs_layout_segment *lseg)
372 struct pnfs_layout_hdr *lo;
378 dprintk("%s: lseg %p ref %d valid %d\n", __func__, lseg,
379 atomic_read(&lseg->pls_refcount),
380 test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
381 lo = lseg->pls_layout;
382 inode = lo->plh_inode;
383 if (atomic_dec_and_lock(&lseg->pls_refcount, &inode->i_lock)) {
385 nfs4_stateid stateid;
386 enum pnfs_iomode iomode;
388 pnfs_get_layout_hdr(lo);
389 pnfs_layout_remove_lseg(lo, lseg);
390 need_return = pnfs_layout_need_return(lo, lseg,
392 spin_unlock(&inode->i_lock);
393 pnfs_free_lseg(lseg);
395 pnfs_send_layoutreturn(lo, stateid, iomode);
397 pnfs_put_layout_hdr(lo);
400 EXPORT_SYMBOL_GPL(pnfs_put_lseg);
402 static void pnfs_free_lseg_async_work(struct work_struct *work)
404 struct pnfs_layout_segment *lseg;
405 struct pnfs_layout_hdr *lo;
407 lseg = container_of(work, struct pnfs_layout_segment, pls_work);
408 lo = lseg->pls_layout;
410 pnfs_free_lseg(lseg);
411 pnfs_put_layout_hdr(lo);
414 static void pnfs_free_lseg_async(struct pnfs_layout_segment *lseg)
416 INIT_WORK(&lseg->pls_work, pnfs_free_lseg_async_work);
417 schedule_work(&lseg->pls_work);
421 pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg)
426 assert_spin_locked(&lseg->pls_layout->plh_inode->i_lock);
428 dprintk("%s: lseg %p ref %d valid %d\n", __func__, lseg,
429 atomic_read(&lseg->pls_refcount),
430 test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
431 if (atomic_dec_and_test(&lseg->pls_refcount)) {
432 struct pnfs_layout_hdr *lo = lseg->pls_layout;
433 pnfs_get_layout_hdr(lo);
434 pnfs_layout_remove_lseg(lo, lseg);
435 pnfs_free_lseg_async(lseg);
438 EXPORT_SYMBOL_GPL(pnfs_put_lseg_locked);
441 end_offset(u64 start, u64 len)
446 return end >= start ? end : NFS4_MAX_UINT64;
450 * is l2 fully contained in l1?
452 * [----------------------------------)
457 pnfs_lseg_range_contained(const struct pnfs_layout_range *l1,
458 const struct pnfs_layout_range *l2)
460 u64 start1 = l1->offset;
461 u64 end1 = end_offset(start1, l1->length);
462 u64 start2 = l2->offset;
463 u64 end2 = end_offset(start2, l2->length);
465 return (start1 <= start2) && (end1 >= end2);
469 * is l1 and l2 intersecting?
471 * [----------------------------------)
476 pnfs_lseg_range_intersecting(const struct pnfs_layout_range *l1,
477 const struct pnfs_layout_range *l2)
479 u64 start1 = l1->offset;
480 u64 end1 = end_offset(start1, l1->length);
481 u64 start2 = l2->offset;
482 u64 end2 = end_offset(start2, l2->length);
484 return (end1 == NFS4_MAX_UINT64 || end1 > start2) &&
485 (end2 == NFS4_MAX_UINT64 || end2 > start1);
489 should_free_lseg(const struct pnfs_layout_range *lseg_range,
490 const struct pnfs_layout_range *recall_range)
492 return (recall_range->iomode == IOMODE_ANY ||
493 lseg_range->iomode == recall_range->iomode) &&
494 pnfs_lseg_range_intersecting(lseg_range, recall_range);
497 static bool pnfs_lseg_dec_and_remove_zero(struct pnfs_layout_segment *lseg,
498 struct list_head *tmp_list)
500 if (!atomic_dec_and_test(&lseg->pls_refcount))
502 pnfs_layout_remove_lseg(lseg->pls_layout, lseg);
503 list_add(&lseg->pls_list, tmp_list);
507 /* Returns 1 if lseg is removed from list, 0 otherwise */
508 static int mark_lseg_invalid(struct pnfs_layout_segment *lseg,
509 struct list_head *tmp_list)
513 if (test_and_clear_bit(NFS_LSEG_VALID, &lseg->pls_flags)) {
514 /* Remove the reference keeping the lseg in the
515 * list. It will now be removed when all
516 * outstanding io is finished.
518 dprintk("%s: lseg %p ref %d\n", __func__, lseg,
519 atomic_read(&lseg->pls_refcount));
520 if (pnfs_lseg_dec_and_remove_zero(lseg, tmp_list))
526 /* Returns count of number of matching invalid lsegs remaining in list
530 pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
531 struct list_head *tmp_list,
532 struct pnfs_layout_range *recall_range)
534 struct pnfs_layout_segment *lseg, *next;
535 int invalid = 0, removed = 0;
537 dprintk("%s:Begin lo %p\n", __func__, lo);
539 if (list_empty(&lo->plh_segs))
541 list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
543 should_free_lseg(&lseg->pls_range, recall_range)) {
544 dprintk("%s: freeing lseg %p iomode %d "
545 "offset %llu length %llu\n", __func__,
546 lseg, lseg->pls_range.iomode, lseg->pls_range.offset,
547 lseg->pls_range.length);
549 removed += mark_lseg_invalid(lseg, tmp_list);
551 dprintk("%s:Return %i\n", __func__, invalid - removed);
552 return invalid - removed;
555 /* note free_me must contain lsegs from a single layout_hdr */
557 pnfs_free_lseg_list(struct list_head *free_me)
559 struct pnfs_layout_segment *lseg, *tmp;
561 if (list_empty(free_me))
564 list_for_each_entry_safe(lseg, tmp, free_me, pls_list) {
565 list_del(&lseg->pls_list);
566 pnfs_free_lseg(lseg);
571 pnfs_destroy_layout(struct nfs_inode *nfsi)
573 struct pnfs_layout_hdr *lo;
576 spin_lock(&nfsi->vfs_inode.i_lock);
579 lo->plh_block_lgets++; /* permanently block new LAYOUTGETs */
580 pnfs_mark_matching_lsegs_invalid(lo, &tmp_list, NULL);
581 pnfs_get_layout_hdr(lo);
582 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RO_FAILED);
583 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RW_FAILED);
584 spin_unlock(&nfsi->vfs_inode.i_lock);
585 pnfs_free_lseg_list(&tmp_list);
586 pnfs_put_layout_hdr(lo);
588 spin_unlock(&nfsi->vfs_inode.i_lock);
590 EXPORT_SYMBOL_GPL(pnfs_destroy_layout);
593 pnfs_layout_add_bulk_destroy_list(struct inode *inode,
594 struct list_head *layout_list)
596 struct pnfs_layout_hdr *lo;
599 spin_lock(&inode->i_lock);
600 lo = NFS_I(inode)->layout;
601 if (lo != NULL && list_empty(&lo->plh_bulk_destroy)) {
602 pnfs_get_layout_hdr(lo);
603 list_add(&lo->plh_bulk_destroy, layout_list);
606 spin_unlock(&inode->i_lock);
610 /* Caller must hold rcu_read_lock and clp->cl_lock */
612 pnfs_layout_bulk_destroy_byserver_locked(struct nfs_client *clp,
613 struct nfs_server *server,
614 struct list_head *layout_list)
616 struct pnfs_layout_hdr *lo, *next;
619 list_for_each_entry_safe(lo, next, &server->layouts, plh_layouts) {
620 inode = igrab(lo->plh_inode);
623 list_del_init(&lo->plh_layouts);
624 if (pnfs_layout_add_bulk_destroy_list(inode, layout_list))
627 spin_unlock(&clp->cl_lock);
629 spin_lock(&clp->cl_lock);
637 pnfs_layout_free_bulk_destroy_list(struct list_head *layout_list,
640 struct pnfs_layout_hdr *lo;
642 struct pnfs_layout_range range = {
643 .iomode = IOMODE_ANY,
645 .length = NFS4_MAX_UINT64,
647 LIST_HEAD(lseg_list);
650 while (!list_empty(layout_list)) {
651 lo = list_entry(layout_list->next, struct pnfs_layout_hdr,
653 dprintk("%s freeing layout for inode %lu\n", __func__,
654 lo->plh_inode->i_ino);
655 inode = lo->plh_inode;
657 pnfs_layoutcommit_inode(inode, false);
659 spin_lock(&inode->i_lock);
660 list_del_init(&lo->plh_bulk_destroy);
661 lo->plh_block_lgets++; /* permanently block new LAYOUTGETs */
663 set_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
664 if (pnfs_mark_matching_lsegs_invalid(lo, &lseg_list, &range))
666 spin_unlock(&inode->i_lock);
667 pnfs_free_lseg_list(&lseg_list);
668 pnfs_put_layout_hdr(lo);
675 pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
676 struct nfs_fsid *fsid,
679 struct nfs_server *server;
680 LIST_HEAD(layout_list);
682 spin_lock(&clp->cl_lock);
685 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
686 if (memcmp(&server->fsid, fsid, sizeof(*fsid)) != 0)
688 if (pnfs_layout_bulk_destroy_byserver_locked(clp,
694 spin_unlock(&clp->cl_lock);
696 if (list_empty(&layout_list))
698 return pnfs_layout_free_bulk_destroy_list(&layout_list, is_recall);
702 pnfs_destroy_layouts_byclid(struct nfs_client *clp,
705 struct nfs_server *server;
706 LIST_HEAD(layout_list);
708 spin_lock(&clp->cl_lock);
711 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
712 if (pnfs_layout_bulk_destroy_byserver_locked(clp,
718 spin_unlock(&clp->cl_lock);
720 if (list_empty(&layout_list))
722 return pnfs_layout_free_bulk_destroy_list(&layout_list, is_recall);
726 * Called by the state manger to remove all layouts established under an
730 pnfs_destroy_all_layouts(struct nfs_client *clp)
732 nfs4_deviceid_mark_client_invalid(clp);
733 nfs4_deviceid_purge_client(clp);
735 pnfs_destroy_layouts_byclid(clp, false);
739 * Compare 2 layout stateid sequence ids, to see which is newer,
740 * taking into account wraparound issues.
742 static bool pnfs_seqid_is_newer(u32 s1, u32 s2)
744 return (s32)(s1 - s2) > 0;
747 /* update lo->plh_stateid with new if is more recent */
749 pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, const nfs4_stateid *new,
752 u32 oldseq, newseq, new_barrier;
753 int empty = list_empty(&lo->plh_segs);
755 oldseq = be32_to_cpu(lo->plh_stateid.seqid);
756 newseq = be32_to_cpu(new->seqid);
757 if (empty || pnfs_seqid_is_newer(newseq, oldseq)) {
758 nfs4_stateid_copy(&lo->plh_stateid, new);
759 if (update_barrier) {
760 new_barrier = be32_to_cpu(new->seqid);
762 /* Because of wraparound, we want to keep the barrier
763 * "close" to the current seqids.
765 new_barrier = newseq - atomic_read(&lo->plh_outstanding);
767 if (empty || pnfs_seqid_is_newer(new_barrier, lo->plh_barrier))
768 lo->plh_barrier = new_barrier;
773 pnfs_layout_stateid_blocked(const struct pnfs_layout_hdr *lo,
774 const nfs4_stateid *stateid)
776 u32 seqid = be32_to_cpu(stateid->seqid);
778 return !pnfs_seqid_is_newer(seqid, lo->plh_barrier);
782 pnfs_layout_returning(const struct pnfs_layout_hdr *lo,
783 struct pnfs_layout_range *range)
785 return test_bit(NFS_LAYOUT_RETURN, &lo->plh_flags) &&
786 (lo->plh_return_iomode == IOMODE_ANY ||
787 lo->plh_return_iomode == range->iomode);
790 /* lget is set to 1 if called from inside send_layoutget call chain */
792 pnfs_layoutgets_blocked(const struct pnfs_layout_hdr *lo,
793 struct pnfs_layout_range *range, int lget)
795 return lo->plh_block_lgets ||
796 test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags) ||
797 (list_empty(&lo->plh_segs) &&
798 (atomic_read(&lo->plh_outstanding) > lget)) ||
799 pnfs_layout_returning(lo, range);
803 pnfs_choose_layoutget_stateid(nfs4_stateid *dst, struct pnfs_layout_hdr *lo,
804 struct pnfs_layout_range *range,
805 struct nfs4_state *open_state)
809 dprintk("--> %s\n", __func__);
810 spin_lock(&lo->plh_inode->i_lock);
811 if (pnfs_layoutgets_blocked(lo, range, 1)) {
813 } else if (!nfs4_valid_open_stateid(open_state)) {
815 } else if (list_empty(&lo->plh_segs) ||
816 test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags)) {
820 seq = read_seqbegin(&open_state->seqlock);
821 nfs4_stateid_copy(dst, &open_state->stateid);
822 } while (read_seqretry(&open_state->seqlock, seq));
824 nfs4_stateid_copy(dst, &lo->plh_stateid);
825 spin_unlock(&lo->plh_inode->i_lock);
826 dprintk("<-- %s\n", __func__);
831 * Get layout from server.
832 * for now, assume that whole file layouts are requested.
834 * arg->length: all ones
836 static struct pnfs_layout_segment *
837 send_layoutget(struct pnfs_layout_hdr *lo,
838 struct nfs_open_context *ctx,
839 struct pnfs_layout_range *range,
842 struct inode *ino = lo->plh_inode;
843 struct nfs_server *server = NFS_SERVER(ino);
844 struct nfs4_layoutget *lgp;
845 struct pnfs_layout_segment *lseg;
847 dprintk("--> %s\n", __func__);
849 lgp = kzalloc(sizeof(*lgp), gfp_flags);
853 lgp->args.minlength = PAGE_CACHE_SIZE;
854 if (lgp->args.minlength > range->length)
855 lgp->args.minlength = range->length;
856 lgp->args.maxcount = PNFS_LAYOUT_MAXSIZE;
857 lgp->args.range = *range;
858 lgp->args.type = server->pnfs_curr_ld->id;
859 lgp->args.inode = ino;
860 lgp->args.ctx = get_nfs_open_context(ctx);
861 lgp->gfp_flags = gfp_flags;
862 lgp->cred = lo->plh_lc_cred;
864 /* Synchronously retrieve layout information from server and
867 lseg = nfs4_proc_layoutget(lgp, gfp_flags);
869 switch (PTR_ERR(lseg)) {
874 /* remember that LAYOUTGET failed and suspend trying */
875 pnfs_layout_io_set_failed(lo, range->iomode);
883 static void pnfs_clear_layoutcommit(struct inode *inode,
884 struct list_head *head)
886 struct nfs_inode *nfsi = NFS_I(inode);
887 struct pnfs_layout_segment *lseg, *tmp;
889 if (!test_and_clear_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
891 list_for_each_entry_safe(lseg, tmp, &nfsi->layout->plh_segs, pls_list) {
892 if (!test_and_clear_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags))
894 pnfs_lseg_dec_and_remove_zero(lseg, head);
899 pnfs_send_layoutreturn(struct pnfs_layout_hdr *lo, nfs4_stateid stateid,
900 enum pnfs_iomode iomode)
902 struct inode *ino = lo->plh_inode;
903 struct nfs4_layoutreturn *lrp;
906 lrp = kzalloc(sizeof(*lrp), GFP_KERNEL);
907 if (unlikely(lrp == NULL)) {
909 spin_lock(&ino->i_lock);
910 lo->plh_block_lgets--;
911 spin_unlock(&ino->i_lock);
912 pnfs_put_layout_hdr(lo);
916 lrp->args.stateid = stateid;
917 lrp->args.layout_type = NFS_SERVER(ino)->pnfs_curr_ld->id;
918 lrp->args.inode = ino;
919 lrp->args.range.iomode = iomode;
920 lrp->args.range.offset = 0;
921 lrp->args.range.length = NFS4_MAX_UINT64;
922 lrp->args.layout = lo;
923 lrp->clp = NFS_SERVER(ino)->nfs_client;
924 lrp->cred = lo->plh_lc_cred;
926 status = nfs4_proc_layoutreturn(lrp);
929 spin_lock(&ino->i_lock);
930 clear_bit(NFS_LAYOUT_RETURN, &lo->plh_flags);
931 spin_unlock(&ino->i_lock);
933 dprintk("<-- %s status: %d\n", __func__, status);
938 * Initiates a LAYOUTRETURN(FILE), and removes the pnfs_layout_hdr
939 * when the layout segment list is empty.
941 * Note that a pnfs_layout_hdr can exist with an empty layout segment
942 * list when LAYOUTGET has failed, or when LAYOUTGET succeeded, but the
943 * deviceid is marked invalid.
946 _pnfs_return_layout(struct inode *ino)
948 struct pnfs_layout_hdr *lo = NULL;
949 struct nfs_inode *nfsi = NFS_I(ino);
951 nfs4_stateid stateid;
952 int status = 0, empty;
954 dprintk("NFS: %s for inode %lu\n", __func__, ino->i_ino);
956 spin_lock(&ino->i_lock);
959 spin_unlock(&ino->i_lock);
960 dprintk("NFS: %s no layout to return\n", __func__);
963 stateid = nfsi->layout->plh_stateid;
964 /* Reference matched in nfs4_layoutreturn_release */
965 pnfs_get_layout_hdr(lo);
966 empty = list_empty(&lo->plh_segs);
967 pnfs_clear_layoutcommit(ino, &tmp_list);
968 pnfs_mark_matching_lsegs_invalid(lo, &tmp_list, NULL);
970 if (NFS_SERVER(ino)->pnfs_curr_ld->return_range) {
971 struct pnfs_layout_range range = {
972 .iomode = IOMODE_ANY,
974 .length = NFS4_MAX_UINT64,
976 NFS_SERVER(ino)->pnfs_curr_ld->return_range(lo, &range);
979 /* Don't send a LAYOUTRETURN if list was initially empty */
981 spin_unlock(&ino->i_lock);
982 pnfs_put_layout_hdr(lo);
983 dprintk("NFS: %s no layout segments to return\n", __func__);
987 set_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags);
988 lo->plh_block_lgets++;
989 spin_unlock(&ino->i_lock);
990 pnfs_free_lseg_list(&tmp_list);
992 status = pnfs_send_layoutreturn(lo, stateid, IOMODE_ANY);
994 dprintk("<-- %s status: %d\n", __func__, status);
997 EXPORT_SYMBOL_GPL(_pnfs_return_layout);
1000 pnfs_commit_and_return_layout(struct inode *inode)
1002 struct pnfs_layout_hdr *lo;
1005 spin_lock(&inode->i_lock);
1006 lo = NFS_I(inode)->layout;
1008 spin_unlock(&inode->i_lock);
1011 pnfs_get_layout_hdr(lo);
1012 /* Block new layoutgets and read/write to ds */
1013 lo->plh_block_lgets++;
1014 spin_unlock(&inode->i_lock);
1015 filemap_fdatawait(inode->i_mapping);
1016 ret = pnfs_layoutcommit_inode(inode, true);
1018 ret = _pnfs_return_layout(inode);
1019 spin_lock(&inode->i_lock);
1020 lo->plh_block_lgets--;
1021 spin_unlock(&inode->i_lock);
1022 pnfs_put_layout_hdr(lo);
1026 bool pnfs_roc(struct inode *ino)
1028 struct pnfs_layout_hdr *lo;
1029 struct pnfs_layout_segment *lseg, *tmp;
1030 LIST_HEAD(tmp_list);
1033 spin_lock(&ino->i_lock);
1034 lo = NFS_I(ino)->layout;
1035 if (!lo || !test_and_clear_bit(NFS_LAYOUT_ROC, &lo->plh_flags) ||
1036 test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags))
1038 list_for_each_entry_safe(lseg, tmp, &lo->plh_segs, pls_list)
1039 if (test_bit(NFS_LSEG_ROC, &lseg->pls_flags)) {
1040 mark_lseg_invalid(lseg, &tmp_list);
1045 lo->plh_block_lgets++;
1046 pnfs_get_layout_hdr(lo); /* matched in pnfs_roc_release */
1047 spin_unlock(&ino->i_lock);
1048 pnfs_free_lseg_list(&tmp_list);
1052 spin_unlock(&ino->i_lock);
1056 void pnfs_roc_release(struct inode *ino)
1058 struct pnfs_layout_hdr *lo;
1060 spin_lock(&ino->i_lock);
1061 lo = NFS_I(ino)->layout;
1062 lo->plh_block_lgets--;
1063 if (atomic_dec_and_test(&lo->plh_refcount)) {
1064 pnfs_detach_layout_hdr(lo);
1065 spin_unlock(&ino->i_lock);
1066 pnfs_free_layout_hdr(lo);
1068 spin_unlock(&ino->i_lock);
1071 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
1073 struct pnfs_layout_hdr *lo;
1075 spin_lock(&ino->i_lock);
1076 lo = NFS_I(ino)->layout;
1077 if (pnfs_seqid_is_newer(barrier, lo->plh_barrier))
1078 lo->plh_barrier = barrier;
1079 spin_unlock(&ino->i_lock);
1082 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
1084 struct nfs_inode *nfsi = NFS_I(ino);
1085 struct pnfs_layout_hdr *lo;
1086 struct pnfs_layout_segment *lseg;
1090 spin_lock(&ino->i_lock);
1091 list_for_each_entry(lseg, &nfsi->layout->plh_segs, pls_list)
1092 if (test_bit(NFS_LSEG_ROC, &lseg->pls_flags)) {
1093 rpc_sleep_on(&NFS_SERVER(ino)->roc_rpcwaitq, task, NULL);
1098 current_seqid = be32_to_cpu(lo->plh_stateid.seqid);
1100 /* Since close does not return a layout stateid for use as
1101 * a barrier, we choose the worst-case barrier.
1103 *barrier = current_seqid + atomic_read(&lo->plh_outstanding);
1105 spin_unlock(&ino->i_lock);
1110 * Compare two layout segments for sorting into layout cache.
1111 * We want to preferentially return RW over RO layouts, so ensure those
1115 pnfs_lseg_range_cmp(const struct pnfs_layout_range *l1,
1116 const struct pnfs_layout_range *l2)
1120 /* high offset > low offset */
1121 d = l1->offset - l2->offset;
1125 /* short length > long length */
1126 d = l2->length - l1->length;
1130 /* read > read/write */
1131 return (int)(l1->iomode == IOMODE_READ) - (int)(l2->iomode == IOMODE_READ);
1135 pnfs_layout_insert_lseg(struct pnfs_layout_hdr *lo,
1136 struct pnfs_layout_segment *lseg)
1138 struct pnfs_layout_segment *lp;
1140 dprintk("%s:Begin\n", __func__);
1142 list_for_each_entry(lp, &lo->plh_segs, pls_list) {
1143 if (pnfs_lseg_range_cmp(&lseg->pls_range, &lp->pls_range) > 0)
1145 list_add_tail(&lseg->pls_list, &lp->pls_list);
1146 dprintk("%s: inserted lseg %p "
1147 "iomode %d offset %llu length %llu before "
1148 "lp %p iomode %d offset %llu length %llu\n",
1149 __func__, lseg, lseg->pls_range.iomode,
1150 lseg->pls_range.offset, lseg->pls_range.length,
1151 lp, lp->pls_range.iomode, lp->pls_range.offset,
1152 lp->pls_range.length);
1155 list_add_tail(&lseg->pls_list, &lo->plh_segs);
1156 dprintk("%s: inserted lseg %p "
1157 "iomode %d offset %llu length %llu at tail\n",
1158 __func__, lseg, lseg->pls_range.iomode,
1159 lseg->pls_range.offset, lseg->pls_range.length);
1161 pnfs_get_layout_hdr(lo);
1163 dprintk("%s:Return\n", __func__);
1166 static struct pnfs_layout_hdr *
1167 alloc_init_layout_hdr(struct inode *ino,
1168 struct nfs_open_context *ctx,
1171 struct pnfs_layout_hdr *lo;
1173 lo = pnfs_alloc_layout_hdr(ino, gfp_flags);
1176 atomic_set(&lo->plh_refcount, 1);
1177 INIT_LIST_HEAD(&lo->plh_layouts);
1178 INIT_LIST_HEAD(&lo->plh_segs);
1179 INIT_LIST_HEAD(&lo->plh_bulk_destroy);
1180 lo->plh_inode = ino;
1181 lo->plh_lc_cred = get_rpccred(ctx->cred);
1185 static struct pnfs_layout_hdr *
1186 pnfs_find_alloc_layout(struct inode *ino,
1187 struct nfs_open_context *ctx,
1190 struct nfs_inode *nfsi = NFS_I(ino);
1191 struct pnfs_layout_hdr *new = NULL;
1193 dprintk("%s Begin ino=%p layout=%p\n", __func__, ino, nfsi->layout);
1195 if (nfsi->layout != NULL)
1197 spin_unlock(&ino->i_lock);
1198 new = alloc_init_layout_hdr(ino, ctx, gfp_flags);
1199 spin_lock(&ino->i_lock);
1201 if (likely(nfsi->layout == NULL)) { /* Won the race? */
1204 } else if (new != NULL)
1205 pnfs_free_layout_hdr(new);
1207 pnfs_get_layout_hdr(nfsi->layout);
1208 return nfsi->layout;
1212 * iomode matching rules:
1223 pnfs_lseg_range_match(const struct pnfs_layout_range *ls_range,
1224 const struct pnfs_layout_range *range)
1226 struct pnfs_layout_range range1;
1228 if ((range->iomode == IOMODE_RW &&
1229 ls_range->iomode != IOMODE_RW) ||
1230 !pnfs_lseg_range_intersecting(ls_range, range))
1233 /* range1 covers only the first byte in the range */
1236 return pnfs_lseg_range_contained(ls_range, &range1);
1240 * lookup range in layout
1242 static struct pnfs_layout_segment *
1243 pnfs_find_lseg(struct pnfs_layout_hdr *lo,
1244 struct pnfs_layout_range *range)
1246 struct pnfs_layout_segment *lseg, *ret = NULL;
1248 dprintk("%s:Begin\n", __func__);
1250 list_for_each_entry(lseg, &lo->plh_segs, pls_list) {
1251 if (test_bit(NFS_LSEG_VALID, &lseg->pls_flags) &&
1252 !test_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags) &&
1253 pnfs_lseg_range_match(&lseg->pls_range, range)) {
1254 ret = pnfs_get_lseg(lseg);
1257 if (lseg->pls_range.offset > range->offset)
1261 dprintk("%s:Return lseg %p ref %d\n",
1262 __func__, ret, ret ? atomic_read(&ret->pls_refcount) : 0);
1267 * Use mdsthreshold hints set at each OPEN to determine if I/O should go
1268 * to the MDS or over pNFS
1270 * The nfs_inode read_io and write_io fields are cumulative counters reset
1271 * when there are no layout segments. Note that in pnfs_update_layout iomode
1272 * is set to IOMODE_READ for a READ request, and set to IOMODE_RW for a
1275 * A return of true means use MDS I/O.
1278 * If a file's size is smaller than the file size threshold, data accesses
1279 * SHOULD be sent to the metadata server. If an I/O request has a length that
1280 * is below the I/O size threshold, the I/O SHOULD be sent to the metadata
1281 * server. If both file size and I/O size are provided, the client SHOULD
1282 * reach or exceed both thresholds before sending its read or write
1283 * requests to the data server.
1285 static bool pnfs_within_mdsthreshold(struct nfs_open_context *ctx,
1286 struct inode *ino, int iomode)
1288 struct nfs4_threshold *t = ctx->mdsthreshold;
1289 struct nfs_inode *nfsi = NFS_I(ino);
1290 loff_t fsize = i_size_read(ino);
1291 bool size = false, size_set = false, io = false, io_set = false, ret = false;
1296 dprintk("%s bm=0x%x rd_sz=%llu wr_sz=%llu rd_io=%llu wr_io=%llu\n",
1297 __func__, t->bm, t->rd_sz, t->wr_sz, t->rd_io_sz, t->wr_io_sz);
1301 if (t->bm & THRESHOLD_RD) {
1302 dprintk("%s fsize %llu\n", __func__, fsize);
1304 if (fsize < t->rd_sz)
1307 if (t->bm & THRESHOLD_RD_IO) {
1308 dprintk("%s nfsi->read_io %llu\n", __func__,
1311 if (nfsi->read_io < t->rd_io_sz)
1316 if (t->bm & THRESHOLD_WR) {
1317 dprintk("%s fsize %llu\n", __func__, fsize);
1319 if (fsize < t->wr_sz)
1322 if (t->bm & THRESHOLD_WR_IO) {
1323 dprintk("%s nfsi->write_io %llu\n", __func__,
1326 if (nfsi->write_io < t->wr_io_sz)
1331 if (size_set && io_set) {
1334 } else if (size || io)
1337 dprintk("<-- %s size %d io %d ret %d\n", __func__, size, io, ret);
1342 * Layout segment is retreived from the server if not cached.
1343 * The appropriate layout segment is referenced and returned to the caller.
1345 struct pnfs_layout_segment *
1346 pnfs_update_layout(struct inode *ino,
1347 struct nfs_open_context *ctx,
1350 enum pnfs_iomode iomode,
1353 struct pnfs_layout_range arg = {
1359 struct nfs_server *server = NFS_SERVER(ino);
1360 struct nfs_client *clp = server->nfs_client;
1361 struct pnfs_layout_hdr *lo;
1362 struct pnfs_layout_segment *lseg = NULL;
1365 if (!pnfs_enabled_sb(NFS_SERVER(ino)))
1368 if (pnfs_within_mdsthreshold(ctx, ino, iomode))
1373 spin_lock(&ino->i_lock);
1374 lo = pnfs_find_alloc_layout(ino, ctx, gfp_flags);
1376 spin_unlock(&ino->i_lock);
1380 /* Do we even need to bother with this? */
1381 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
1382 dprintk("%s matches recall, use MDS\n", __func__);
1386 /* if LAYOUTGET already failed once we don't try again */
1387 if (pnfs_layout_io_test_failed(lo, iomode))
1390 first = list_empty(&lo->plh_segs);
1392 /* The first layoutget for the file. Need to serialize per
1393 * RFC 5661 Errata 3208.
1395 if (test_and_set_bit(NFS_LAYOUT_FIRST_LAYOUTGET,
1397 spin_unlock(&ino->i_lock);
1398 wait_on_bit(&lo->plh_flags, NFS_LAYOUT_FIRST_LAYOUTGET,
1399 TASK_UNINTERRUPTIBLE);
1400 pnfs_put_layout_hdr(lo);
1404 /* Check to see if the layout for the given range
1407 lseg = pnfs_find_lseg(lo, &arg);
1412 if (pnfs_layoutgets_blocked(lo, &arg, 0))
1414 atomic_inc(&lo->plh_outstanding);
1415 spin_unlock(&ino->i_lock);
1417 if (list_empty(&lo->plh_layouts)) {
1418 /* The lo must be on the clp list if there is any
1419 * chance of a CB_LAYOUTRECALL(FILE) coming in.
1421 spin_lock(&clp->cl_lock);
1422 if (list_empty(&lo->plh_layouts))
1423 list_add_tail(&lo->plh_layouts, &server->layouts);
1424 spin_unlock(&clp->cl_lock);
1427 pg_offset = arg.offset & ~PAGE_CACHE_MASK;
1429 arg.offset -= pg_offset;
1430 arg.length += pg_offset;
1432 if (arg.length != NFS4_MAX_UINT64)
1433 arg.length = PAGE_CACHE_ALIGN(arg.length);
1435 lseg = send_layoutget(lo, ctx, &arg, gfp_flags);
1436 atomic_dec(&lo->plh_outstanding);
1439 unsigned long *bitlock = &lo->plh_flags;
1441 clear_bit_unlock(NFS_LAYOUT_FIRST_LAYOUTGET, bitlock);
1442 smp_mb__after_atomic();
1443 wake_up_bit(bitlock, NFS_LAYOUT_FIRST_LAYOUTGET);
1445 pnfs_put_layout_hdr(lo);
1447 dprintk("%s: inode %s/%llu pNFS layout segment %s for "
1448 "(%s, offset: %llu, length: %llu)\n",
1449 __func__, ino->i_sb->s_id,
1450 (unsigned long long)NFS_FILEID(ino),
1451 lseg == NULL ? "not found" : "found",
1452 iomode==IOMODE_RW ? "read/write" : "read-only",
1453 (unsigned long long)pos,
1454 (unsigned long long)count);
1457 spin_unlock(&ino->i_lock);
1458 goto out_put_layout_hdr;
1460 EXPORT_SYMBOL_GPL(pnfs_update_layout);
1462 struct pnfs_layout_segment *
1463 pnfs_layout_process(struct nfs4_layoutget *lgp)
1465 struct pnfs_layout_hdr *lo = NFS_I(lgp->args.inode)->layout;
1466 struct nfs4_layoutget_res *res = &lgp->res;
1467 struct pnfs_layout_segment *lseg;
1468 struct inode *ino = lo->plh_inode;
1472 /* Inject layout blob into I/O device driver */
1473 lseg = NFS_SERVER(ino)->pnfs_curr_ld->alloc_lseg(lo, res, lgp->gfp_flags);
1474 if (!lseg || IS_ERR(lseg)) {
1478 status = PTR_ERR(lseg);
1479 dprintk("%s: Could not allocate layout: error %d\n",
1484 init_lseg(lo, lseg);
1485 lseg->pls_range = res->range;
1487 spin_lock(&ino->i_lock);
1488 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
1489 dprintk("%s forget reply due to recall\n", __func__);
1490 goto out_forget_reply;
1493 if (pnfs_layoutgets_blocked(lo, &lgp->args.range, 1)) {
1494 dprintk("%s forget reply due to state\n", __func__);
1495 goto out_forget_reply;
1498 if (nfs4_stateid_match_other(&lo->plh_stateid, &res->stateid)) {
1499 /* existing state ID, make sure the sequence number matches. */
1500 if (pnfs_layout_stateid_blocked(lo, &res->stateid)) {
1501 dprintk("%s forget reply due to sequence\n", __func__);
1502 goto out_forget_reply;
1504 pnfs_set_layout_stateid(lo, &res->stateid, false);
1507 * We got an entirely new state ID. Mark all segments for the
1508 * inode invalid, and don't bother validating the stateid
1511 pnfs_mark_matching_lsegs_invalid(lo, &free_me, NULL);
1513 nfs4_stateid_copy(&lo->plh_stateid, &res->stateid);
1514 lo->plh_barrier = be32_to_cpu(res->stateid.seqid);
1517 clear_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags);
1519 pnfs_get_lseg(lseg);
1520 pnfs_layout_insert_lseg(lo, lseg);
1522 if (res->return_on_close) {
1523 set_bit(NFS_LSEG_ROC, &lseg->pls_flags);
1524 set_bit(NFS_LAYOUT_ROC, &lo->plh_flags);
1527 spin_unlock(&ino->i_lock);
1528 pnfs_free_lseg_list(&free_me);
1531 return ERR_PTR(status);
1534 spin_unlock(&ino->i_lock);
1535 lseg->pls_layout = lo;
1536 NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
1541 pnfs_mark_matching_lsegs_return(struct pnfs_layout_hdr *lo,
1542 struct list_head *tmp_list,
1543 struct pnfs_layout_range *return_range)
1545 struct pnfs_layout_segment *lseg, *next;
1547 dprintk("%s:Begin lo %p\n", __func__, lo);
1549 if (list_empty(&lo->plh_segs))
1552 list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
1553 if (should_free_lseg(&lseg->pls_range, return_range)) {
1554 dprintk("%s: marking lseg %p iomode %d "
1555 "offset %llu length %llu\n", __func__,
1556 lseg, lseg->pls_range.iomode,
1557 lseg->pls_range.offset,
1558 lseg->pls_range.length);
1559 set_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags);
1560 mark_lseg_invalid(lseg, tmp_list);
1564 void pnfs_error_mark_layout_for_return(struct inode *inode,
1565 struct pnfs_layout_segment *lseg)
1567 struct pnfs_layout_hdr *lo = NFS_I(inode)->layout;
1568 int iomode = pnfs_iomode_to_fail_bit(lseg->pls_range.iomode);
1569 struct pnfs_layout_range range = {
1570 .iomode = lseg->pls_range.iomode,
1572 .length = NFS4_MAX_UINT64,
1576 spin_lock(&inode->i_lock);
1577 /* set failure bit so that pnfs path will be retried later */
1578 pnfs_layout_set_fail_bit(lo, iomode);
1579 set_bit(NFS_LAYOUT_RETURN, &lo->plh_flags);
1580 if (lo->plh_return_iomode == 0)
1581 lo->plh_return_iomode = range.iomode;
1582 else if (lo->plh_return_iomode != range.iomode)
1583 lo->plh_return_iomode = IOMODE_ANY;
1585 * mark all matching lsegs so that we are sure to have no live
1586 * segments at hand when sending layoutreturn. See pnfs_put_lseg()
1589 pnfs_mark_matching_lsegs_return(lo, &free_me, &range);
1590 spin_unlock(&inode->i_lock);
1591 pnfs_free_lseg_list(&free_me);
1593 EXPORT_SYMBOL_GPL(pnfs_error_mark_layout_for_return);
1596 pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
1598 u64 rd_size = req->wb_bytes;
1600 WARN_ON_ONCE(pgio->pg_lseg != NULL);
1602 if (pgio->pg_dreq == NULL)
1603 rd_size = i_size_read(pgio->pg_inode) - req_offset(req);
1605 rd_size = nfs_dreq_bytes_left(pgio->pg_dreq);
1607 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
1613 /* If no lseg, fall back to read through mds */
1614 if (pgio->pg_lseg == NULL)
1615 nfs_pageio_reset_read_mds(pgio);
1618 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_read);
1621 pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
1622 struct nfs_page *req, u64 wb_size)
1624 WARN_ON_ONCE(pgio->pg_lseg != NULL);
1626 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
1632 /* If no lseg, fall back to write through mds */
1633 if (pgio->pg_lseg == NULL)
1634 nfs_pageio_reset_write_mds(pgio);
1636 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_write);
1639 pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *desc)
1641 if (desc->pg_lseg) {
1642 pnfs_put_lseg(desc->pg_lseg);
1643 desc->pg_lseg = NULL;
1646 EXPORT_SYMBOL_GPL(pnfs_generic_pg_cleanup);
1649 * Return 0 if @req cannot be coalesced into @pgio, otherwise return the number
1650 * of bytes (maximum @req->wb_bytes) that can be coalesced.
1653 pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
1654 struct nfs_page *prev, struct nfs_page *req)
1657 u64 seg_end, req_start, seg_left;
1659 size = nfs_generic_pg_test(pgio, prev, req);
1664 * 'size' contains the number of bytes left in the current page (up
1665 * to the original size asked for in @req->wb_bytes).
1667 * Calculate how many bytes are left in the layout segment
1668 * and if there are less bytes than 'size', return that instead.
1670 * Please also note that 'end_offset' is actually the offset of the
1671 * first byte that lies outside the pnfs_layout_range. FIXME?
1674 if (pgio->pg_lseg) {
1675 seg_end = end_offset(pgio->pg_lseg->pls_range.offset,
1676 pgio->pg_lseg->pls_range.length);
1677 req_start = req_offset(req);
1678 WARN_ON_ONCE(req_start > seg_end);
1679 /* start of request is past the last byte of this segment */
1680 if (req_start >= seg_end)
1683 /* adjust 'size' iff there are fewer bytes left in the
1684 * segment than what nfs_generic_pg_test returned */
1685 seg_left = seg_end - req_start;
1686 if (seg_left < size)
1687 size = (unsigned int)seg_left;
1692 EXPORT_SYMBOL_GPL(pnfs_generic_pg_test);
1694 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *hdr)
1696 struct nfs_pageio_descriptor pgio;
1698 /* Resend all requests through the MDS */
1699 nfs_pageio_init_write(&pgio, hdr->inode, FLUSH_STABLE, true,
1700 hdr->completion_ops);
1701 return nfs_pageio_resend(&pgio, hdr);
1703 EXPORT_SYMBOL_GPL(pnfs_write_done_resend_to_mds);
1705 static void pnfs_ld_handle_write_error(struct nfs_pgio_header *hdr)
1708 dprintk("pnfs write error = %d\n", hdr->pnfs_error);
1709 if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
1710 PNFS_LAYOUTRET_ON_ERROR) {
1711 pnfs_return_layout(hdr->inode);
1713 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
1714 hdr->task.tk_status = pnfs_write_done_resend_to_mds(hdr);
1718 * Called by non rpc-based layout drivers
1720 void pnfs_ld_write_done(struct nfs_pgio_header *hdr)
1722 trace_nfs4_pnfs_write(hdr, hdr->pnfs_error);
1723 if (!hdr->pnfs_error) {
1724 pnfs_set_layoutcommit(hdr);
1725 hdr->mds_ops->rpc_call_done(&hdr->task, hdr);
1727 pnfs_ld_handle_write_error(hdr);
1728 hdr->mds_ops->rpc_release(hdr);
1730 EXPORT_SYMBOL_GPL(pnfs_ld_write_done);
1733 pnfs_write_through_mds(struct nfs_pageio_descriptor *desc,
1734 struct nfs_pgio_header *hdr)
1736 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1738 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
1739 list_splice_tail_init(&hdr->pages, &mirror->pg_list);
1740 nfs_pageio_reset_write_mds(desc);
1741 mirror->pg_recoalesce = 1;
1743 nfs_pgio_data_destroy(hdr);
1746 static enum pnfs_try_status
1747 pnfs_try_to_write_data(struct nfs_pgio_header *hdr,
1748 const struct rpc_call_ops *call_ops,
1749 struct pnfs_layout_segment *lseg,
1752 struct inode *inode = hdr->inode;
1753 enum pnfs_try_status trypnfs;
1754 struct nfs_server *nfss = NFS_SERVER(inode);
1756 hdr->mds_ops = call_ops;
1758 dprintk("%s: Writing ino:%lu %u@%llu (how %d)\n", __func__,
1759 inode->i_ino, hdr->args.count, hdr->args.offset, how);
1760 trypnfs = nfss->pnfs_curr_ld->write_pagelist(hdr, how);
1761 if (trypnfs != PNFS_NOT_ATTEMPTED)
1762 nfs_inc_stats(inode, NFSIOS_PNFS_WRITE);
1763 dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
1768 pnfs_do_write(struct nfs_pageio_descriptor *desc,
1769 struct nfs_pgio_header *hdr, int how)
1771 const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
1772 struct pnfs_layout_segment *lseg = desc->pg_lseg;
1773 enum pnfs_try_status trypnfs;
1775 trypnfs = pnfs_try_to_write_data(hdr, call_ops, lseg, how);
1776 if (trypnfs == PNFS_NOT_ATTEMPTED)
1777 pnfs_write_through_mds(desc, hdr);
1780 static void pnfs_writehdr_free(struct nfs_pgio_header *hdr)
1782 pnfs_put_lseg(hdr->lseg);
1783 nfs_pgio_header_free(hdr);
1785 EXPORT_SYMBOL_GPL(pnfs_writehdr_free);
1788 pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc)
1790 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1792 struct nfs_pgio_header *hdr;
1795 hdr = nfs_pgio_header_alloc(desc->pg_rw_ops);
1797 desc->pg_completion_ops->error_cleanup(&mirror->pg_list);
1800 nfs_pgheader_init(desc, hdr, pnfs_writehdr_free);
1802 hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
1803 ret = nfs_generic_pgio(desc, hdr);
1805 pnfs_do_write(desc, hdr, desc->pg_ioflags);
1809 EXPORT_SYMBOL_GPL(pnfs_generic_pg_writepages);
1811 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *hdr)
1813 struct nfs_pageio_descriptor pgio;
1815 /* Resend all requests through the MDS */
1816 nfs_pageio_init_read(&pgio, hdr->inode, true, hdr->completion_ops);
1817 return nfs_pageio_resend(&pgio, hdr);
1819 EXPORT_SYMBOL_GPL(pnfs_read_done_resend_to_mds);
1821 static void pnfs_ld_handle_read_error(struct nfs_pgio_header *hdr)
1823 dprintk("pnfs read error = %d\n", hdr->pnfs_error);
1824 if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
1825 PNFS_LAYOUTRET_ON_ERROR) {
1826 pnfs_return_layout(hdr->inode);
1828 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
1829 hdr->task.tk_status = pnfs_read_done_resend_to_mds(hdr);
1833 * Called by non rpc-based layout drivers
1835 void pnfs_ld_read_done(struct nfs_pgio_header *hdr)
1837 trace_nfs4_pnfs_read(hdr, hdr->pnfs_error);
1838 if (likely(!hdr->pnfs_error)) {
1839 __nfs4_read_done_cb(hdr);
1840 hdr->mds_ops->rpc_call_done(&hdr->task, hdr);
1842 pnfs_ld_handle_read_error(hdr);
1843 hdr->mds_ops->rpc_release(hdr);
1845 EXPORT_SYMBOL_GPL(pnfs_ld_read_done);
1848 pnfs_read_through_mds(struct nfs_pageio_descriptor *desc,
1849 struct nfs_pgio_header *hdr)
1851 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1853 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
1854 list_splice_tail_init(&hdr->pages, &mirror->pg_list);
1855 nfs_pageio_reset_read_mds(desc);
1856 mirror->pg_recoalesce = 1;
1858 nfs_pgio_data_destroy(hdr);
1862 * Call the appropriate parallel I/O subsystem read function.
1864 static enum pnfs_try_status
1865 pnfs_try_to_read_data(struct nfs_pgio_header *hdr,
1866 const struct rpc_call_ops *call_ops,
1867 struct pnfs_layout_segment *lseg)
1869 struct inode *inode = hdr->inode;
1870 struct nfs_server *nfss = NFS_SERVER(inode);
1871 enum pnfs_try_status trypnfs;
1873 hdr->mds_ops = call_ops;
1875 dprintk("%s: Reading ino:%lu %u@%llu\n",
1876 __func__, inode->i_ino, hdr->args.count, hdr->args.offset);
1878 trypnfs = nfss->pnfs_curr_ld->read_pagelist(hdr);
1879 if (trypnfs != PNFS_NOT_ATTEMPTED)
1880 nfs_inc_stats(inode, NFSIOS_PNFS_READ);
1881 dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
1885 /* Resend all requests through pnfs. */
1886 int pnfs_read_resend_pnfs(struct nfs_pgio_header *hdr)
1888 struct nfs_pageio_descriptor pgio;
1890 nfs_pageio_init_read(&pgio, hdr->inode, false, hdr->completion_ops);
1891 return nfs_pageio_resend(&pgio, hdr);
1893 EXPORT_SYMBOL_GPL(pnfs_read_resend_pnfs);
1896 pnfs_do_read(struct nfs_pageio_descriptor *desc, struct nfs_pgio_header *hdr)
1898 const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
1899 struct pnfs_layout_segment *lseg = desc->pg_lseg;
1900 enum pnfs_try_status trypnfs;
1903 trypnfs = pnfs_try_to_read_data(hdr, call_ops, lseg);
1904 if (trypnfs == PNFS_TRY_AGAIN)
1905 err = pnfs_read_resend_pnfs(hdr);
1906 if (trypnfs == PNFS_NOT_ATTEMPTED || err)
1907 pnfs_read_through_mds(desc, hdr);
1910 static void pnfs_readhdr_free(struct nfs_pgio_header *hdr)
1912 pnfs_put_lseg(hdr->lseg);
1913 nfs_pgio_header_free(hdr);
1915 EXPORT_SYMBOL_GPL(pnfs_readhdr_free);
1918 pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc)
1920 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1922 struct nfs_pgio_header *hdr;
1925 hdr = nfs_pgio_header_alloc(desc->pg_rw_ops);
1927 desc->pg_completion_ops->error_cleanup(&mirror->pg_list);
1930 nfs_pgheader_init(desc, hdr, pnfs_readhdr_free);
1931 hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
1932 ret = nfs_generic_pgio(desc, hdr);
1934 pnfs_do_read(desc, hdr);
1937 EXPORT_SYMBOL_GPL(pnfs_generic_pg_readpages);
1939 static void pnfs_clear_layoutcommitting(struct inode *inode)
1941 unsigned long *bitlock = &NFS_I(inode)->flags;
1943 clear_bit_unlock(NFS_INO_LAYOUTCOMMITTING, bitlock);
1944 smp_mb__after_atomic();
1945 wake_up_bit(bitlock, NFS_INO_LAYOUTCOMMITTING);
1949 * There can be multiple RW segments.
1951 static void pnfs_list_write_lseg(struct inode *inode, struct list_head *listp)
1953 struct pnfs_layout_segment *lseg;
1955 list_for_each_entry(lseg, &NFS_I(inode)->layout->plh_segs, pls_list) {
1956 if (lseg->pls_range.iomode == IOMODE_RW &&
1957 test_and_clear_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags))
1958 list_add(&lseg->pls_lc_list, listp);
1962 static void pnfs_list_write_lseg_done(struct inode *inode, struct list_head *listp)
1964 struct pnfs_layout_segment *lseg, *tmp;
1966 /* Matched by references in pnfs_set_layoutcommit */
1967 list_for_each_entry_safe(lseg, tmp, listp, pls_lc_list) {
1968 list_del_init(&lseg->pls_lc_list);
1969 pnfs_put_lseg(lseg);
1972 pnfs_clear_layoutcommitting(inode);
1975 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg)
1977 pnfs_layout_io_set_failed(lseg->pls_layout, lseg->pls_range.iomode);
1979 EXPORT_SYMBOL_GPL(pnfs_set_lo_fail);
1982 pnfs_set_layoutcommit(struct nfs_pgio_header *hdr)
1984 struct inode *inode = hdr->inode;
1985 struct nfs_inode *nfsi = NFS_I(inode);
1986 loff_t end_pos = hdr->mds_offset + hdr->res.count;
1987 bool mark_as_dirty = false;
1989 spin_lock(&inode->i_lock);
1990 if (!test_and_set_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags)) {
1991 mark_as_dirty = true;
1992 dprintk("%s: Set layoutcommit for inode %lu ",
1993 __func__, inode->i_ino);
1995 if (!test_and_set_bit(NFS_LSEG_LAYOUTCOMMIT, &hdr->lseg->pls_flags)) {
1996 /* references matched in nfs4_layoutcommit_release */
1997 pnfs_get_lseg(hdr->lseg);
1999 if (end_pos > nfsi->layout->plh_lwb)
2000 nfsi->layout->plh_lwb = end_pos;
2001 spin_unlock(&inode->i_lock);
2002 dprintk("%s: lseg %p end_pos %llu\n",
2003 __func__, hdr->lseg, nfsi->layout->plh_lwb);
2005 /* if pnfs_layoutcommit_inode() runs between inode locks, the next one
2006 * will be a noop because NFS_INO_LAYOUTCOMMIT will not be set */
2008 mark_inode_dirty_sync(inode);
2010 EXPORT_SYMBOL_GPL(pnfs_set_layoutcommit);
2012 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data)
2014 struct inode *inode = data->inode;
2015 struct nfs_inode *nfsi = NFS_I(inode);
2016 bool mark_as_dirty = false;
2018 spin_lock(&inode->i_lock);
2019 if (!test_and_set_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags)) {
2020 mark_as_dirty = true;
2021 dprintk("%s: Set layoutcommit for inode %lu ",
2022 __func__, inode->i_ino);
2024 if (!test_and_set_bit(NFS_LSEG_LAYOUTCOMMIT, &data->lseg->pls_flags)) {
2025 /* references matched in nfs4_layoutcommit_release */
2026 pnfs_get_lseg(data->lseg);
2028 if (data->lwb > nfsi->layout->plh_lwb)
2029 nfsi->layout->plh_lwb = data->lwb;
2030 spin_unlock(&inode->i_lock);
2031 dprintk("%s: lseg %p end_pos %llu\n",
2032 __func__, data->lseg, nfsi->layout->plh_lwb);
2034 /* if pnfs_layoutcommit_inode() runs between inode locks, the next one
2035 * will be a noop because NFS_INO_LAYOUTCOMMIT will not be set */
2037 mark_inode_dirty_sync(inode);
2039 EXPORT_SYMBOL_GPL(pnfs_commit_set_layoutcommit);
2041 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data)
2043 struct nfs_server *nfss = NFS_SERVER(data->args.inode);
2045 if (nfss->pnfs_curr_ld->cleanup_layoutcommit)
2046 nfss->pnfs_curr_ld->cleanup_layoutcommit(data);
2047 pnfs_list_write_lseg_done(data->args.inode, &data->lseg_list);
2051 * For the LAYOUT4_NFSV4_1_FILES layout type, NFS_DATA_SYNC WRITEs and
2052 * NFS_UNSTABLE WRITEs with a COMMIT to data servers must store enough
2053 * data to disk to allow the server to recover the data if it crashes.
2054 * LAYOUTCOMMIT is only needed when the NFL4_UFLG_COMMIT_THRU_MDS flag
2055 * is off, and a COMMIT is sent to a data server, or
2056 * if WRITEs to a data server return NFS_DATA_SYNC.
2059 pnfs_layoutcommit_inode(struct inode *inode, bool sync)
2061 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
2062 struct nfs4_layoutcommit_data *data;
2063 struct nfs_inode *nfsi = NFS_I(inode);
2067 if (!pnfs_layoutcommit_outstanding(inode))
2070 dprintk("--> %s inode %lu\n", __func__, inode->i_ino);
2073 if (test_and_set_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags)) {
2076 status = wait_on_bit_lock_action(&nfsi->flags,
2077 NFS_INO_LAYOUTCOMMITTING,
2078 nfs_wait_bit_killable,
2085 /* Note kzalloc ensures data->res.seq_res.sr_slot == NULL */
2086 data = kzalloc(sizeof(*data), GFP_NOFS);
2088 goto clear_layoutcommitting;
2091 spin_lock(&inode->i_lock);
2092 if (!test_and_clear_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
2095 INIT_LIST_HEAD(&data->lseg_list);
2096 pnfs_list_write_lseg(inode, &data->lseg_list);
2098 end_pos = nfsi->layout->plh_lwb;
2099 nfsi->layout->plh_lwb = 0;
2101 nfs4_stateid_copy(&data->args.stateid, &nfsi->layout->plh_stateid);
2102 spin_unlock(&inode->i_lock);
2104 data->args.inode = inode;
2105 data->cred = get_rpccred(nfsi->layout->plh_lc_cred);
2106 nfs_fattr_init(&data->fattr);
2107 data->args.bitmask = NFS_SERVER(inode)->cache_consistency_bitmask;
2108 data->res.fattr = &data->fattr;
2109 data->args.lastbytewritten = end_pos - 1;
2110 data->res.server = NFS_SERVER(inode);
2112 if (ld->prepare_layoutcommit) {
2113 status = ld->prepare_layoutcommit(&data->args);
2115 spin_lock(&inode->i_lock);
2116 if (end_pos < nfsi->layout->plh_lwb)
2117 nfsi->layout->plh_lwb = end_pos;
2118 spin_unlock(&inode->i_lock);
2119 put_rpccred(data->cred);
2120 set_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags);
2121 goto clear_layoutcommitting;
2126 status = nfs4_proc_layoutcommit(data, sync);
2129 mark_inode_dirty_sync(inode);
2130 dprintk("<-- %s status %d\n", __func__, status);
2133 spin_unlock(&inode->i_lock);
2135 clear_layoutcommitting:
2136 pnfs_clear_layoutcommitting(inode);
2139 EXPORT_SYMBOL_GPL(pnfs_layoutcommit_inode);
2141 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
2143 struct nfs4_threshold *thp;
2145 thp = kzalloc(sizeof(*thp), GFP_NOFS);
2147 dprintk("%s mdsthreshold allocation failed\n", __func__);