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>
33 #include <linux/sort.h>
37 #include "nfs4trace.h"
38 #include "delegation.h"
41 #define NFSDBG_FACILITY NFSDBG_PNFS
42 #define PNFS_LAYOUTGET_RETRY_TIMEOUT (120*HZ)
47 * protects pnfs_modules_tbl.
49 static DEFINE_SPINLOCK(pnfs_spinlock);
52 * pnfs_modules_tbl holds all pnfs modules
54 static LIST_HEAD(pnfs_modules_tbl);
56 static void pnfs_layoutreturn_before_put_layout_hdr(struct pnfs_layout_hdr *lo);
57 static void pnfs_free_returned_lsegs(struct pnfs_layout_hdr *lo,
58 struct list_head *free_me,
59 const struct pnfs_layout_range *range,
61 static bool pnfs_lseg_dec_and_remove_zero(struct pnfs_layout_segment *lseg,
62 struct list_head *tmp_list);
64 /* Return the registered pnfs layout driver module matching given id */
65 static struct pnfs_layoutdriver_type *
66 find_pnfs_driver_locked(u32 id)
68 struct pnfs_layoutdriver_type *local;
70 list_for_each_entry(local, &pnfs_modules_tbl, pnfs_tblid)
75 dprintk("%s: Searching for id %u, found %p\n", __func__, id, local);
79 static struct pnfs_layoutdriver_type *
80 find_pnfs_driver(u32 id)
82 struct pnfs_layoutdriver_type *local;
84 spin_lock(&pnfs_spinlock);
85 local = find_pnfs_driver_locked(id);
86 if (local != NULL && !try_module_get(local->owner)) {
87 dprintk("%s: Could not grab reference on module\n", __func__);
90 spin_unlock(&pnfs_spinlock);
95 unset_pnfs_layoutdriver(struct nfs_server *nfss)
97 if (nfss->pnfs_curr_ld) {
98 if (nfss->pnfs_curr_ld->clear_layoutdriver)
99 nfss->pnfs_curr_ld->clear_layoutdriver(nfss);
100 /* Decrement the MDS count. Purge the deviceid cache if zero */
101 if (atomic_dec_and_test(&nfss->nfs_client->cl_mds_count))
102 nfs4_deviceid_purge_client(nfss->nfs_client);
103 module_put(nfss->pnfs_curr_ld->owner);
105 nfss->pnfs_curr_ld = NULL;
109 * When the server sends a list of layout types, we choose one in the order
110 * given in the list below.
112 * FIXME: should this list be configurable in some fashion? module param?
113 * mount option? something else?
115 static const u32 ld_prefs[] = {
120 LAYOUT_NFSV4_1_FILES,
125 ld_cmp(const void *e1, const void *e2)
127 u32 ld1 = *((u32 *)e1);
128 u32 ld2 = *((u32 *)e2);
131 for (i = 0; ld_prefs[i] != 0; i++) {
132 if (ld1 == ld_prefs[i])
135 if (ld2 == ld_prefs[i])
142 * Try to set the server's pnfs module to the pnfs layout type specified by id.
143 * Currently only one pNFS layout driver per filesystem is supported.
145 * @ids array of layout types supported by MDS.
148 set_pnfs_layoutdriver(struct nfs_server *server, const struct nfs_fh *mntfh,
149 struct nfs_fsinfo *fsinfo)
151 struct pnfs_layoutdriver_type *ld_type = NULL;
155 if (fsinfo->nlayouttypes == 0)
157 if (!(server->nfs_client->cl_exchange_flags &
158 (EXCHGID4_FLAG_USE_NON_PNFS | EXCHGID4_FLAG_USE_PNFS_MDS))) {
159 printk(KERN_ERR "NFS: %s: cl_exchange_flags 0x%x\n",
160 __func__, server->nfs_client->cl_exchange_flags);
164 sort(fsinfo->layouttype, fsinfo->nlayouttypes,
165 sizeof(*fsinfo->layouttype), ld_cmp, NULL);
167 for (i = 0; i < fsinfo->nlayouttypes; i++) {
168 id = fsinfo->layouttype[i];
169 ld_type = find_pnfs_driver(id);
171 request_module("%s-%u", LAYOUT_NFSV4_1_MODULE_PREFIX,
173 ld_type = find_pnfs_driver(id);
180 dprintk("%s: No pNFS module found!\n", __func__);
184 server->pnfs_curr_ld = ld_type;
185 if (ld_type->set_layoutdriver
186 && ld_type->set_layoutdriver(server, mntfh)) {
187 printk(KERN_ERR "NFS: %s: Error initializing pNFS layout "
188 "driver %u.\n", __func__, id);
189 module_put(ld_type->owner);
192 /* Bump the MDS count */
193 atomic_inc(&server->nfs_client->cl_mds_count);
195 dprintk("%s: pNFS module for %u set\n", __func__, id);
199 dprintk("%s: Using NFSv4 I/O\n", __func__);
200 server->pnfs_curr_ld = NULL;
204 pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
206 int status = -EINVAL;
207 struct pnfs_layoutdriver_type *tmp;
209 if (ld_type->id == 0) {
210 printk(KERN_ERR "NFS: %s id 0 is reserved\n", __func__);
213 if (!ld_type->alloc_lseg || !ld_type->free_lseg) {
214 printk(KERN_ERR "NFS: %s Layout driver must provide "
215 "alloc_lseg and free_lseg.\n", __func__);
219 spin_lock(&pnfs_spinlock);
220 tmp = find_pnfs_driver_locked(ld_type->id);
222 list_add(&ld_type->pnfs_tblid, &pnfs_modules_tbl);
224 dprintk("%s Registering id:%u name:%s\n", __func__, ld_type->id,
227 printk(KERN_ERR "NFS: %s Module with id %d already loaded!\n",
228 __func__, ld_type->id);
230 spin_unlock(&pnfs_spinlock);
234 EXPORT_SYMBOL_GPL(pnfs_register_layoutdriver);
237 pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
239 dprintk("%s Deregistering id:%u\n", __func__, ld_type->id);
240 spin_lock(&pnfs_spinlock);
241 list_del(&ld_type->pnfs_tblid);
242 spin_unlock(&pnfs_spinlock);
244 EXPORT_SYMBOL_GPL(pnfs_unregister_layoutdriver);
247 * pNFS client layout cache
250 /* Need to hold i_lock if caller does not already hold reference */
252 pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo)
254 atomic_inc(&lo->plh_refcount);
257 static struct pnfs_layout_hdr *
258 pnfs_alloc_layout_hdr(struct inode *ino, gfp_t gfp_flags)
260 struct pnfs_layoutdriver_type *ld = NFS_SERVER(ino)->pnfs_curr_ld;
261 return ld->alloc_layout_hdr(ino, gfp_flags);
265 pnfs_free_layout_hdr(struct pnfs_layout_hdr *lo)
267 struct nfs_server *server = NFS_SERVER(lo->plh_inode);
268 struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
270 if (!list_empty(&lo->plh_layouts)) {
271 struct nfs_client *clp = server->nfs_client;
273 spin_lock(&clp->cl_lock);
274 list_del_init(&lo->plh_layouts);
275 spin_unlock(&clp->cl_lock);
277 put_rpccred(lo->plh_lc_cred);
278 return ld->free_layout_hdr(lo);
282 pnfs_detach_layout_hdr(struct pnfs_layout_hdr *lo)
284 struct nfs_inode *nfsi = NFS_I(lo->plh_inode);
285 dprintk("%s: freeing layout cache %p\n", __func__, lo);
287 /* Reset MDS Threshold I/O counters */
293 pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo)
295 struct inode *inode = lo->plh_inode;
297 pnfs_layoutreturn_before_put_layout_hdr(lo);
299 if (atomic_dec_and_lock(&lo->plh_refcount, &inode->i_lock)) {
300 if (!list_empty(&lo->plh_segs))
301 WARN_ONCE(1, "NFS: BUG unfreed layout segments.\n");
302 pnfs_detach_layout_hdr(lo);
303 spin_unlock(&inode->i_lock);
304 pnfs_free_layout_hdr(lo);
309 pnfs_set_plh_return_info(struct pnfs_layout_hdr *lo, enum pnfs_iomode iomode,
312 if (lo->plh_return_iomode != 0 && lo->plh_return_iomode != iomode)
314 lo->plh_return_iomode = iomode;
315 set_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags);
317 WARN_ON_ONCE(lo->plh_return_seq != 0 && lo->plh_return_seq != seq);
318 lo->plh_return_seq = seq;
323 pnfs_clear_layoutreturn_info(struct pnfs_layout_hdr *lo)
325 struct pnfs_layout_segment *lseg;
326 lo->plh_return_iomode = 0;
327 lo->plh_return_seq = 0;
328 clear_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags);
329 list_for_each_entry(lseg, &lo->plh_segs, pls_list) {
330 if (!test_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags))
332 pnfs_set_plh_return_info(lo, lseg->pls_range.iomode, 0);
336 static void pnfs_clear_layoutreturn_waitbit(struct pnfs_layout_hdr *lo)
338 clear_bit_unlock(NFS_LAYOUT_RETURN, &lo->plh_flags);
339 clear_bit(NFS_LAYOUT_RETURN_LOCK, &lo->plh_flags);
340 smp_mb__after_atomic();
341 wake_up_bit(&lo->plh_flags, NFS_LAYOUT_RETURN);
342 rpc_wake_up(&NFS_SERVER(lo->plh_inode)->roc_rpcwaitq);
346 pnfs_clear_lseg_state(struct pnfs_layout_segment *lseg,
347 struct list_head *free_me)
349 clear_bit(NFS_LSEG_ROC, &lseg->pls_flags);
350 clear_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags);
351 if (test_and_clear_bit(NFS_LSEG_VALID, &lseg->pls_flags))
352 pnfs_lseg_dec_and_remove_zero(lseg, free_me);
353 if (test_and_clear_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags))
354 pnfs_lseg_dec_and_remove_zero(lseg, free_me);
358 * Mark a pnfs_layout_hdr and all associated layout segments as invalid
360 * In order to continue using the pnfs_layout_hdr, a full recovery
362 * Note that caller must hold inode->i_lock.
365 pnfs_mark_layout_stateid_invalid(struct pnfs_layout_hdr *lo,
366 struct list_head *lseg_list)
368 struct pnfs_layout_range range = {
369 .iomode = IOMODE_ANY,
371 .length = NFS4_MAX_UINT64,
373 struct pnfs_layout_segment *lseg, *next;
375 set_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags);
376 list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
377 pnfs_clear_lseg_state(lseg, lseg_list);
378 pnfs_clear_layoutreturn_info(lo);
379 pnfs_free_returned_lsegs(lo, lseg_list, &range, 0);
380 if (test_bit(NFS_LAYOUT_RETURN, &lo->plh_flags) &&
381 !test_and_set_bit(NFS_LAYOUT_RETURN_LOCK, &lo->plh_flags))
382 pnfs_clear_layoutreturn_waitbit(lo);
383 return !list_empty(&lo->plh_segs);
387 pnfs_iomode_to_fail_bit(u32 iomode)
389 return iomode == IOMODE_RW ?
390 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
394 pnfs_layout_set_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
396 lo->plh_retry_timestamp = jiffies;
397 if (!test_and_set_bit(fail_bit, &lo->plh_flags))
398 atomic_inc(&lo->plh_refcount);
402 pnfs_layout_clear_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
404 if (test_and_clear_bit(fail_bit, &lo->plh_flags))
405 atomic_dec(&lo->plh_refcount);
409 pnfs_layout_io_set_failed(struct pnfs_layout_hdr *lo, u32 iomode)
411 struct inode *inode = lo->plh_inode;
412 struct pnfs_layout_range range = {
415 .length = NFS4_MAX_UINT64,
419 spin_lock(&inode->i_lock);
420 pnfs_layout_set_fail_bit(lo, pnfs_iomode_to_fail_bit(iomode));
421 pnfs_mark_matching_lsegs_invalid(lo, &head, &range, 0);
422 spin_unlock(&inode->i_lock);
423 pnfs_free_lseg_list(&head);
424 dprintk("%s Setting layout IOMODE_%s fail bit\n", __func__,
425 iomode == IOMODE_RW ? "RW" : "READ");
429 pnfs_layout_io_test_failed(struct pnfs_layout_hdr *lo, u32 iomode)
431 unsigned long start, end;
432 int fail_bit = pnfs_iomode_to_fail_bit(iomode);
434 if (test_bit(fail_bit, &lo->plh_flags) == 0)
437 start = end - PNFS_LAYOUTGET_RETRY_TIMEOUT;
438 if (!time_in_range(lo->plh_retry_timestamp, start, end)) {
439 /* It is time to retry the failed layoutgets */
440 pnfs_layout_clear_fail_bit(lo, fail_bit);
447 pnfs_init_lseg(struct pnfs_layout_hdr *lo, struct pnfs_layout_segment *lseg,
448 const struct pnfs_layout_range *range,
449 const nfs4_stateid *stateid)
451 INIT_LIST_HEAD(&lseg->pls_list);
452 INIT_LIST_HEAD(&lseg->pls_lc_list);
453 atomic_set(&lseg->pls_refcount, 1);
454 set_bit(NFS_LSEG_VALID, &lseg->pls_flags);
455 lseg->pls_layout = lo;
456 lseg->pls_range = *range;
457 lseg->pls_seq = be32_to_cpu(stateid->seqid);
460 static void pnfs_free_lseg(struct pnfs_layout_segment *lseg)
463 struct inode *inode = lseg->pls_layout->plh_inode;
464 NFS_SERVER(inode)->pnfs_curr_ld->free_lseg(lseg);
469 pnfs_layout_remove_lseg(struct pnfs_layout_hdr *lo,
470 struct pnfs_layout_segment *lseg)
472 WARN_ON(test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
473 list_del_init(&lseg->pls_list);
474 /* Matched by pnfs_get_layout_hdr in pnfs_layout_insert_lseg */
475 atomic_dec(&lo->plh_refcount);
476 if (test_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags))
478 if (list_empty(&lo->plh_segs) &&
479 !test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags) &&
480 !test_bit(NFS_LAYOUT_RETURN, &lo->plh_flags)) {
481 if (atomic_read(&lo->plh_outstanding) == 0)
482 set_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags);
483 clear_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
488 pnfs_cache_lseg_for_layoutreturn(struct pnfs_layout_hdr *lo,
489 struct pnfs_layout_segment *lseg)
491 if (test_and_clear_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags) &&
492 pnfs_layout_is_valid(lo)) {
493 pnfs_set_plh_return_info(lo, lseg->pls_range.iomode, 0);
494 list_move_tail(&lseg->pls_list, &lo->plh_return_segs);
501 pnfs_put_lseg(struct pnfs_layout_segment *lseg)
503 struct pnfs_layout_hdr *lo;
509 dprintk("%s: lseg %p ref %d valid %d\n", __func__, lseg,
510 atomic_read(&lseg->pls_refcount),
511 test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
513 lo = lseg->pls_layout;
514 inode = lo->plh_inode;
516 if (atomic_dec_and_lock(&lseg->pls_refcount, &inode->i_lock)) {
517 if (test_bit(NFS_LSEG_VALID, &lseg->pls_flags)) {
518 spin_unlock(&inode->i_lock);
521 pnfs_get_layout_hdr(lo);
522 pnfs_layout_remove_lseg(lo, lseg);
523 if (pnfs_cache_lseg_for_layoutreturn(lo, lseg))
525 spin_unlock(&inode->i_lock);
526 pnfs_free_lseg(lseg);
527 pnfs_put_layout_hdr(lo);
530 EXPORT_SYMBOL_GPL(pnfs_put_lseg);
532 static void pnfs_free_lseg_async_work(struct work_struct *work)
534 struct pnfs_layout_segment *lseg;
535 struct pnfs_layout_hdr *lo;
537 lseg = container_of(work, struct pnfs_layout_segment, pls_work);
538 lo = lseg->pls_layout;
540 pnfs_free_lseg(lseg);
541 pnfs_put_layout_hdr(lo);
544 static void pnfs_free_lseg_async(struct pnfs_layout_segment *lseg)
546 INIT_WORK(&lseg->pls_work, pnfs_free_lseg_async_work);
547 schedule_work(&lseg->pls_work);
551 pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg)
556 assert_spin_locked(&lseg->pls_layout->plh_inode->i_lock);
558 dprintk("%s: lseg %p ref %d valid %d\n", __func__, lseg,
559 atomic_read(&lseg->pls_refcount),
560 test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
561 if (atomic_dec_and_test(&lseg->pls_refcount)) {
562 struct pnfs_layout_hdr *lo = lseg->pls_layout;
563 if (test_bit(NFS_LSEG_VALID, &lseg->pls_flags))
565 pnfs_layout_remove_lseg(lo, lseg);
566 if (!pnfs_cache_lseg_for_layoutreturn(lo, lseg)) {
567 pnfs_get_layout_hdr(lo);
568 pnfs_free_lseg_async(lseg);
574 * is l2 fully contained in l1?
576 * [----------------------------------)
581 pnfs_lseg_range_contained(const struct pnfs_layout_range *l1,
582 const struct pnfs_layout_range *l2)
584 u64 start1 = l1->offset;
585 u64 end1 = pnfs_end_offset(start1, l1->length);
586 u64 start2 = l2->offset;
587 u64 end2 = pnfs_end_offset(start2, l2->length);
589 return (start1 <= start2) && (end1 >= end2);
592 static bool pnfs_lseg_dec_and_remove_zero(struct pnfs_layout_segment *lseg,
593 struct list_head *tmp_list)
595 if (!atomic_dec_and_test(&lseg->pls_refcount))
597 pnfs_layout_remove_lseg(lseg->pls_layout, lseg);
598 list_add(&lseg->pls_list, tmp_list);
602 /* Returns 1 if lseg is removed from list, 0 otherwise */
603 static int mark_lseg_invalid(struct pnfs_layout_segment *lseg,
604 struct list_head *tmp_list)
608 if (test_and_clear_bit(NFS_LSEG_VALID, &lseg->pls_flags)) {
609 /* Remove the reference keeping the lseg in the
610 * list. It will now be removed when all
611 * outstanding io is finished.
613 dprintk("%s: lseg %p ref %d\n", __func__, lseg,
614 atomic_read(&lseg->pls_refcount));
615 if (pnfs_lseg_dec_and_remove_zero(lseg, tmp_list))
622 * Compare 2 layout stateid sequence ids, to see which is newer,
623 * taking into account wraparound issues.
625 static bool pnfs_seqid_is_newer(u32 s1, u32 s2)
627 return (s32)(s1 - s2) > 0;
631 pnfs_should_free_range(const struct pnfs_layout_range *lseg_range,
632 const struct pnfs_layout_range *recall_range)
634 return (recall_range->iomode == IOMODE_ANY ||
635 lseg_range->iomode == recall_range->iomode) &&
636 pnfs_lseg_range_intersecting(lseg_range, recall_range);
640 pnfs_match_lseg_recall(const struct pnfs_layout_segment *lseg,
641 const struct pnfs_layout_range *recall_range,
644 if (seq != 0 && pnfs_seqid_is_newer(lseg->pls_seq, seq))
646 if (recall_range == NULL)
648 return pnfs_should_free_range(&lseg->pls_range, recall_range);
652 * pnfs_mark_matching_lsegs_invalid - tear down lsegs or mark them for later
653 * @lo: layout header containing the lsegs
654 * @tmp_list: list head where doomed lsegs should go
655 * @recall_range: optional recall range argument to match (may be NULL)
656 * @seq: only invalidate lsegs obtained prior to this sequence (may be 0)
658 * Walk the list of lsegs in the layout header, and tear down any that should
659 * be destroyed. If "recall_range" is specified then the segment must match
660 * that range. If "seq" is non-zero, then only match segments that were handed
661 * out at or before that sequence.
663 * Returns number of matching invalid lsegs remaining in list after scanning
664 * it and purging them.
667 pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
668 struct list_head *tmp_list,
669 const struct pnfs_layout_range *recall_range,
672 struct pnfs_layout_segment *lseg, *next;
675 dprintk("%s:Begin lo %p\n", __func__, lo);
677 if (list_empty(&lo->plh_segs))
679 list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
680 if (pnfs_match_lseg_recall(lseg, recall_range, seq)) {
681 dprintk("%s: freeing lseg %p iomode %d seq %u"
682 "offset %llu length %llu\n", __func__,
683 lseg, lseg->pls_range.iomode, lseg->pls_seq,
684 lseg->pls_range.offset, lseg->pls_range.length);
685 if (!mark_lseg_invalid(lseg, tmp_list))
688 dprintk("%s:Return %i\n", __func__, remaining);
693 pnfs_free_returned_lsegs(struct pnfs_layout_hdr *lo,
694 struct list_head *free_me,
695 const struct pnfs_layout_range *range,
698 struct pnfs_layout_segment *lseg, *next;
700 list_for_each_entry_safe(lseg, next, &lo->plh_return_segs, pls_list) {
701 if (pnfs_match_lseg_recall(lseg, range, seq))
702 list_move_tail(&lseg->pls_list, free_me);
706 /* note free_me must contain lsegs from a single layout_hdr */
708 pnfs_free_lseg_list(struct list_head *free_me)
710 struct pnfs_layout_segment *lseg, *tmp;
712 if (list_empty(free_me))
715 list_for_each_entry_safe(lseg, tmp, free_me, pls_list) {
716 list_del(&lseg->pls_list);
717 pnfs_free_lseg(lseg);
722 pnfs_destroy_layout(struct nfs_inode *nfsi)
724 struct pnfs_layout_hdr *lo;
727 spin_lock(&nfsi->vfs_inode.i_lock);
730 pnfs_get_layout_hdr(lo);
731 pnfs_mark_layout_stateid_invalid(lo, &tmp_list);
732 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RO_FAILED);
733 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RW_FAILED);
734 spin_unlock(&nfsi->vfs_inode.i_lock);
735 pnfs_free_lseg_list(&tmp_list);
736 nfs_commit_inode(&nfsi->vfs_inode, 0);
737 pnfs_put_layout_hdr(lo);
739 spin_unlock(&nfsi->vfs_inode.i_lock);
741 EXPORT_SYMBOL_GPL(pnfs_destroy_layout);
744 pnfs_layout_add_bulk_destroy_list(struct inode *inode,
745 struct list_head *layout_list)
747 struct pnfs_layout_hdr *lo;
750 spin_lock(&inode->i_lock);
751 lo = NFS_I(inode)->layout;
752 if (lo != NULL && list_empty(&lo->plh_bulk_destroy)) {
753 pnfs_get_layout_hdr(lo);
754 list_add(&lo->plh_bulk_destroy, layout_list);
757 spin_unlock(&inode->i_lock);
761 /* Caller must hold rcu_read_lock and clp->cl_lock */
763 pnfs_layout_bulk_destroy_byserver_locked(struct nfs_client *clp,
764 struct nfs_server *server,
765 struct list_head *layout_list)
767 struct pnfs_layout_hdr *lo, *next;
770 list_for_each_entry_safe(lo, next, &server->layouts, plh_layouts) {
771 if (test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags))
773 inode = igrab(lo->plh_inode);
776 list_del_init(&lo->plh_layouts);
777 if (pnfs_layout_add_bulk_destroy_list(inode, layout_list))
780 spin_unlock(&clp->cl_lock);
782 spin_lock(&clp->cl_lock);
790 pnfs_layout_free_bulk_destroy_list(struct list_head *layout_list,
793 struct pnfs_layout_hdr *lo;
795 LIST_HEAD(lseg_list);
798 while (!list_empty(layout_list)) {
799 lo = list_entry(layout_list->next, struct pnfs_layout_hdr,
801 dprintk("%s freeing layout for inode %lu\n", __func__,
802 lo->plh_inode->i_ino);
803 inode = lo->plh_inode;
805 pnfs_layoutcommit_inode(inode, false);
807 spin_lock(&inode->i_lock);
808 list_del_init(&lo->plh_bulk_destroy);
809 if (pnfs_mark_layout_stateid_invalid(lo, &lseg_list)) {
811 set_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
814 spin_unlock(&inode->i_lock);
815 pnfs_free_lseg_list(&lseg_list);
816 /* Free all lsegs that are attached to commit buckets */
817 nfs_commit_inode(inode, 0);
818 pnfs_put_layout_hdr(lo);
825 pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
826 struct nfs_fsid *fsid,
829 struct nfs_server *server;
830 LIST_HEAD(layout_list);
832 spin_lock(&clp->cl_lock);
835 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
836 if (memcmp(&server->fsid, fsid, sizeof(*fsid)) != 0)
838 if (pnfs_layout_bulk_destroy_byserver_locked(clp,
844 spin_unlock(&clp->cl_lock);
846 if (list_empty(&layout_list))
848 return pnfs_layout_free_bulk_destroy_list(&layout_list, is_recall);
852 pnfs_destroy_layouts_byclid(struct nfs_client *clp,
855 struct nfs_server *server;
856 LIST_HEAD(layout_list);
858 spin_lock(&clp->cl_lock);
861 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
862 if (pnfs_layout_bulk_destroy_byserver_locked(clp,
868 spin_unlock(&clp->cl_lock);
870 if (list_empty(&layout_list))
872 return pnfs_layout_free_bulk_destroy_list(&layout_list, is_recall);
876 * Called by the state manger to remove all layouts established under an
880 pnfs_destroy_all_layouts(struct nfs_client *clp)
882 nfs4_deviceid_mark_client_invalid(clp);
883 nfs4_deviceid_purge_client(clp);
885 pnfs_destroy_layouts_byclid(clp, false);
888 /* update lo->plh_stateid with new if is more recent */
890 pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, const nfs4_stateid *new,
893 u32 oldseq, newseq, new_barrier = 0;
895 oldseq = be32_to_cpu(lo->plh_stateid.seqid);
896 newseq = be32_to_cpu(new->seqid);
898 if (!pnfs_layout_is_valid(lo)) {
899 nfs4_stateid_copy(&lo->plh_stateid, new);
900 lo->plh_barrier = newseq;
901 pnfs_clear_layoutreturn_info(lo);
902 clear_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags);
905 if (pnfs_seqid_is_newer(newseq, oldseq)) {
906 nfs4_stateid_copy(&lo->plh_stateid, new);
908 * Because of wraparound, we want to keep the barrier
909 * "close" to the current seqids.
911 new_barrier = newseq - atomic_read(&lo->plh_outstanding);
914 new_barrier = be32_to_cpu(new->seqid);
915 else if (new_barrier == 0)
917 if (pnfs_seqid_is_newer(new_barrier, lo->plh_barrier))
918 lo->plh_barrier = new_barrier;
922 pnfs_layout_stateid_blocked(const struct pnfs_layout_hdr *lo,
923 const nfs4_stateid *stateid)
925 u32 seqid = be32_to_cpu(stateid->seqid);
927 return !pnfs_seqid_is_newer(seqid, lo->plh_barrier);
930 /* lget is set to 1 if called from inside send_layoutget call chain */
932 pnfs_layoutgets_blocked(const struct pnfs_layout_hdr *lo)
934 return lo->plh_block_lgets ||
935 test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
939 * Get layout from server.
940 * for now, assume that whole file layouts are requested.
942 * arg->length: all ones
944 static struct pnfs_layout_segment *
945 send_layoutget(struct pnfs_layout_hdr *lo,
946 struct nfs_open_context *ctx,
947 nfs4_stateid *stateid,
948 const struct pnfs_layout_range *range,
949 long *timeout, gfp_t gfp_flags)
951 struct inode *ino = lo->plh_inode;
952 struct nfs_server *server = NFS_SERVER(ino);
953 struct nfs4_layoutget *lgp;
956 dprintk("--> %s\n", __func__);
959 * Synchronously retrieve layout information from server and
960 * store in lseg. If we race with a concurrent seqid morphing
961 * op, then re-send the LAYOUTGET.
963 lgp = kzalloc(sizeof(*lgp), gfp_flags);
965 return ERR_PTR(-ENOMEM);
967 i_size = i_size_read(ino);
969 lgp->args.minlength = PAGE_SIZE;
970 if (lgp->args.minlength > range->length)
971 lgp->args.minlength = range->length;
972 if (range->iomode == IOMODE_READ) {
973 if (range->offset >= i_size)
974 lgp->args.minlength = 0;
975 else if (i_size - range->offset < lgp->args.minlength)
976 lgp->args.minlength = i_size - range->offset;
978 lgp->args.maxcount = PNFS_LAYOUT_MAXSIZE;
979 pnfs_copy_range(&lgp->args.range, range);
980 lgp->args.type = server->pnfs_curr_ld->id;
981 lgp->args.inode = ino;
982 lgp->args.ctx = get_nfs_open_context(ctx);
983 nfs4_stateid_copy(&lgp->args.stateid, stateid);
984 lgp->gfp_flags = gfp_flags;
985 lgp->cred = lo->plh_lc_cred;
987 return nfs4_proc_layoutget(lgp, timeout, gfp_flags);
990 static void pnfs_clear_layoutcommit(struct inode *inode,
991 struct list_head *head)
993 struct nfs_inode *nfsi = NFS_I(inode);
994 struct pnfs_layout_segment *lseg, *tmp;
996 if (!test_and_clear_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
998 list_for_each_entry_safe(lseg, tmp, &nfsi->layout->plh_segs, pls_list) {
999 if (!test_and_clear_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags))
1001 pnfs_lseg_dec_and_remove_zero(lseg, head);
1005 void pnfs_layoutreturn_free_lsegs(struct pnfs_layout_hdr *lo,
1006 const nfs4_stateid *arg_stateid,
1007 const struct pnfs_layout_range *range,
1008 const nfs4_stateid *stateid)
1010 struct inode *inode = lo->plh_inode;
1013 spin_lock(&inode->i_lock);
1014 if (!pnfs_layout_is_valid(lo) || !arg_stateid ||
1015 !nfs4_stateid_match_other(&lo->plh_stateid, arg_stateid))
1018 u32 seq = be32_to_cpu(arg_stateid->seqid);
1020 pnfs_mark_matching_lsegs_invalid(lo, &freeme, range, seq);
1021 pnfs_free_returned_lsegs(lo, &freeme, range, seq);
1022 pnfs_set_layout_stateid(lo, stateid, true);
1024 pnfs_mark_layout_stateid_invalid(lo, &freeme);
1026 pnfs_clear_layoutreturn_waitbit(lo);
1027 spin_unlock(&inode->i_lock);
1028 pnfs_free_lseg_list(&freeme);
1033 pnfs_prepare_layoutreturn(struct pnfs_layout_hdr *lo,
1034 nfs4_stateid *stateid,
1035 enum pnfs_iomode *iomode)
1037 /* Serialise LAYOUTGET/LAYOUTRETURN */
1038 if (atomic_read(&lo->plh_outstanding) != 0)
1040 if (test_and_set_bit(NFS_LAYOUT_RETURN_LOCK, &lo->plh_flags))
1042 set_bit(NFS_LAYOUT_RETURN, &lo->plh_flags);
1043 pnfs_get_layout_hdr(lo);
1044 if (test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags)) {
1045 if (stateid != NULL) {
1046 nfs4_stateid_copy(stateid, &lo->plh_stateid);
1047 if (lo->plh_return_seq != 0)
1048 stateid->seqid = cpu_to_be32(lo->plh_return_seq);
1051 *iomode = lo->plh_return_iomode;
1052 pnfs_clear_layoutreturn_info(lo);
1055 if (stateid != NULL)
1056 nfs4_stateid_copy(stateid, &lo->plh_stateid);
1058 *iomode = IOMODE_ANY;
1063 pnfs_init_layoutreturn_args(struct nfs4_layoutreturn_args *args,
1064 struct pnfs_layout_hdr *lo,
1065 const nfs4_stateid *stateid,
1066 enum pnfs_iomode iomode)
1068 struct inode *inode = lo->plh_inode;
1070 args->layout_type = NFS_SERVER(inode)->pnfs_curr_ld->id;
1071 args->inode = inode;
1072 args->range.iomode = iomode;
1073 args->range.offset = 0;
1074 args->range.length = NFS4_MAX_UINT64;
1076 nfs4_stateid_copy(&args->stateid, stateid);
1080 pnfs_send_layoutreturn(struct pnfs_layout_hdr *lo, const nfs4_stateid *stateid,
1081 enum pnfs_iomode iomode, bool sync)
1083 struct inode *ino = lo->plh_inode;
1084 struct pnfs_layoutdriver_type *ld = NFS_SERVER(ino)->pnfs_curr_ld;
1085 struct nfs4_layoutreturn *lrp;
1088 lrp = kzalloc(sizeof(*lrp), GFP_NOFS);
1089 if (unlikely(lrp == NULL)) {
1091 spin_lock(&ino->i_lock);
1092 pnfs_clear_layoutreturn_waitbit(lo);
1093 spin_unlock(&ino->i_lock);
1094 pnfs_put_layout_hdr(lo);
1098 pnfs_init_layoutreturn_args(&lrp->args, lo, stateid, iomode);
1099 lrp->args.ld_private = &lrp->ld_private;
1100 lrp->clp = NFS_SERVER(ino)->nfs_client;
1101 lrp->cred = lo->plh_lc_cred;
1102 if (ld->prepare_layoutreturn)
1103 ld->prepare_layoutreturn(&lrp->args);
1105 status = nfs4_proc_layoutreturn(lrp, sync);
1107 dprintk("<-- %s status: %d\n", __func__, status);
1111 /* Return true if layoutreturn is needed */
1113 pnfs_layout_need_return(struct pnfs_layout_hdr *lo)
1115 struct pnfs_layout_segment *s;
1117 if (!test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags))
1120 /* Defer layoutreturn until all lsegs are done */
1121 list_for_each_entry(s, &lo->plh_segs, pls_list) {
1122 if (test_bit(NFS_LSEG_LAYOUTRETURN, &s->pls_flags))
1129 static void pnfs_layoutreturn_before_put_layout_hdr(struct pnfs_layout_hdr *lo)
1131 struct inode *inode= lo->plh_inode;
1133 if (!test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags))
1135 spin_lock(&inode->i_lock);
1136 if (pnfs_layout_need_return(lo)) {
1137 nfs4_stateid stateid;
1138 enum pnfs_iomode iomode;
1141 send = pnfs_prepare_layoutreturn(lo, &stateid, &iomode);
1142 spin_unlock(&inode->i_lock);
1144 /* Send an async layoutreturn so we dont deadlock */
1145 pnfs_send_layoutreturn(lo, &stateid, iomode, false);
1148 spin_unlock(&inode->i_lock);
1152 * Initiates a LAYOUTRETURN(FILE), and removes the pnfs_layout_hdr
1153 * when the layout segment list is empty.
1155 * Note that a pnfs_layout_hdr can exist with an empty layout segment
1156 * list when LAYOUTGET has failed, or when LAYOUTGET succeeded, but the
1157 * deviceid is marked invalid.
1160 _pnfs_return_layout(struct inode *ino)
1162 struct pnfs_layout_hdr *lo = NULL;
1163 struct nfs_inode *nfsi = NFS_I(ino);
1164 LIST_HEAD(tmp_list);
1165 nfs4_stateid stateid;
1169 dprintk("NFS: %s for inode %lu\n", __func__, ino->i_ino);
1171 spin_lock(&ino->i_lock);
1174 spin_unlock(&ino->i_lock);
1175 dprintk("NFS: %s no layout to return\n", __func__);
1178 /* Reference matched in nfs4_layoutreturn_release */
1179 pnfs_get_layout_hdr(lo);
1180 /* Is there an outstanding layoutreturn ? */
1181 if (test_bit(NFS_LAYOUT_RETURN_LOCK, &lo->plh_flags)) {
1182 spin_unlock(&ino->i_lock);
1183 if (wait_on_bit(&lo->plh_flags, NFS_LAYOUT_RETURN,
1184 TASK_UNINTERRUPTIBLE))
1185 goto out_put_layout_hdr;
1186 spin_lock(&ino->i_lock);
1188 pnfs_clear_layoutcommit(ino, &tmp_list);
1189 pnfs_mark_matching_lsegs_invalid(lo, &tmp_list, NULL, 0);
1191 if (NFS_SERVER(ino)->pnfs_curr_ld->return_range) {
1192 struct pnfs_layout_range range = {
1193 .iomode = IOMODE_ANY,
1195 .length = NFS4_MAX_UINT64,
1197 NFS_SERVER(ino)->pnfs_curr_ld->return_range(lo, &range);
1200 /* Don't send a LAYOUTRETURN if list was initially empty */
1201 if (!test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags)) {
1202 spin_unlock(&ino->i_lock);
1203 dprintk("NFS: %s no layout segments to return\n", __func__);
1204 goto out_put_layout_hdr;
1207 send = pnfs_prepare_layoutreturn(lo, &stateid, NULL);
1208 spin_unlock(&ino->i_lock);
1210 status = pnfs_send_layoutreturn(lo, &stateid, IOMODE_ANY, true);
1212 pnfs_free_lseg_list(&tmp_list);
1213 pnfs_put_layout_hdr(lo);
1215 dprintk("<-- %s status: %d\n", __func__, status);
1220 pnfs_commit_and_return_layout(struct inode *inode)
1222 struct pnfs_layout_hdr *lo;
1225 spin_lock(&inode->i_lock);
1226 lo = NFS_I(inode)->layout;
1228 spin_unlock(&inode->i_lock);
1231 pnfs_get_layout_hdr(lo);
1232 /* Block new layoutgets and read/write to ds */
1233 lo->plh_block_lgets++;
1234 spin_unlock(&inode->i_lock);
1235 filemap_fdatawait(inode->i_mapping);
1236 ret = pnfs_layoutcommit_inode(inode, true);
1238 ret = _pnfs_return_layout(inode);
1239 spin_lock(&inode->i_lock);
1240 lo->plh_block_lgets--;
1241 spin_unlock(&inode->i_lock);
1242 pnfs_put_layout_hdr(lo);
1246 bool pnfs_roc(struct inode *ino,
1247 struct nfs4_layoutreturn_args *args,
1248 struct nfs4_layoutreturn_res *res,
1249 const struct rpc_cred *cred)
1251 struct nfs_inode *nfsi = NFS_I(ino);
1252 struct nfs_open_context *ctx;
1253 struct nfs4_state *state;
1254 struct pnfs_layout_hdr *lo;
1255 struct pnfs_layout_segment *lseg, *next;
1256 nfs4_stateid stateid;
1257 enum pnfs_iomode iomode = 0;
1258 bool layoutreturn = false, roc = false;
1259 bool skip_read = false;
1261 if (!nfs_have_layout(ino))
1264 spin_lock(&ino->i_lock);
1266 if (!lo || !pnfs_layout_is_valid(lo) ||
1267 test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags))
1269 if (test_bit(NFS_LAYOUT_RETURN_LOCK, &lo->plh_flags)) {
1270 pnfs_get_layout_hdr(lo);
1271 spin_unlock(&ino->i_lock);
1272 wait_on_bit(&lo->plh_flags, NFS_LAYOUT_RETURN,
1273 TASK_UNINTERRUPTIBLE);
1274 pnfs_put_layout_hdr(lo);
1278 /* no roc if we hold a delegation */
1279 if (nfs4_check_delegation(ino, FMODE_READ)) {
1280 if (nfs4_check_delegation(ino, FMODE_WRITE))
1285 list_for_each_entry(ctx, &nfsi->open_files, list) {
1289 /* Don't return layout if there is open file state */
1290 if (state->state & FMODE_WRITE)
1292 if (state->state & FMODE_READ)
1297 list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list) {
1298 if (skip_read && lseg->pls_range.iomode == IOMODE_READ)
1300 /* If we are sending layoutreturn, invalidate all valid lsegs */
1301 if (!test_and_clear_bit(NFS_LSEG_ROC, &lseg->pls_flags))
1304 * Note: mark lseg for return so pnfs_layout_remove_lseg
1305 * doesn't invalidate the layout for us.
1307 set_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags);
1308 if (!mark_lseg_invalid(lseg, &lo->plh_return_segs))
1310 pnfs_set_plh_return_info(lo, lseg->pls_range.iomode, 0);
1313 if (!test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags))
1316 /* ROC in two conditions:
1317 * 1. there are ROC lsegs
1318 * 2. we don't send layoutreturn
1320 /* lo ref dropped in pnfs_roc_release() */
1321 layoutreturn = pnfs_prepare_layoutreturn(lo, &stateid, &iomode);
1322 /* If the creds don't match, we can't compound the layoutreturn */
1323 if (!layoutreturn || cred != lo->plh_lc_cred)
1327 pnfs_init_layoutreturn_args(args, lo, &stateid, iomode);
1328 res->lrs_present = 0;
1329 layoutreturn = false;
1332 spin_unlock(&ino->i_lock);
1333 pnfs_layoutcommit_inode(ino, true);
1335 struct pnfs_layoutdriver_type *ld = NFS_SERVER(ino)->pnfs_curr_ld;
1336 if (ld->prepare_layoutreturn)
1337 ld->prepare_layoutreturn(args);
1341 pnfs_send_layoutreturn(lo, &stateid, iomode, true);
1345 void pnfs_roc_release(struct nfs4_layoutreturn_args *args,
1346 struct nfs4_layoutreturn_res *res,
1349 struct pnfs_layout_hdr *lo = args->layout;
1350 const nfs4_stateid *arg_stateid = NULL;
1351 const nfs4_stateid *res_stateid = NULL;
1352 struct nfs4_xdr_opaque_data *ld_private = args->ld_private;
1355 arg_stateid = &args->stateid;
1356 if (res->lrs_present)
1357 res_stateid = &res->stateid;
1359 pnfs_layoutreturn_free_lsegs(lo, arg_stateid, &args->range,
1361 if (ld_private && ld_private->ops && ld_private->ops->free)
1362 ld_private->ops->free(ld_private);
1363 pnfs_put_layout_hdr(lo);
1364 trace_nfs4_layoutreturn_on_close(args->inode, 0);
1367 bool pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task)
1369 struct nfs_inode *nfsi = NFS_I(ino);
1370 struct pnfs_layout_hdr *lo;
1373 /* we might not have grabbed lo reference. so need to check under
1375 spin_lock(&ino->i_lock);
1377 if (lo && test_bit(NFS_LAYOUT_RETURN, &lo->plh_flags)) {
1378 rpc_sleep_on(&NFS_SERVER(ino)->roc_rpcwaitq, task, NULL);
1381 spin_unlock(&ino->i_lock);
1386 * Compare two layout segments for sorting into layout cache.
1387 * We want to preferentially return RW over RO layouts, so ensure those
1391 pnfs_lseg_range_cmp(const struct pnfs_layout_range *l1,
1392 const struct pnfs_layout_range *l2)
1396 /* high offset > low offset */
1397 d = l1->offset - l2->offset;
1401 /* short length > long length */
1402 d = l2->length - l1->length;
1406 /* read > read/write */
1407 return (int)(l1->iomode == IOMODE_READ) - (int)(l2->iomode == IOMODE_READ);
1411 pnfs_lseg_range_is_after(const struct pnfs_layout_range *l1,
1412 const struct pnfs_layout_range *l2)
1414 return pnfs_lseg_range_cmp(l1, l2) > 0;
1418 pnfs_lseg_no_merge(struct pnfs_layout_segment *lseg,
1419 struct pnfs_layout_segment *old)
1425 pnfs_generic_layout_insert_lseg(struct pnfs_layout_hdr *lo,
1426 struct pnfs_layout_segment *lseg,
1427 bool (*is_after)(const struct pnfs_layout_range *,
1428 const struct pnfs_layout_range *),
1429 bool (*do_merge)(struct pnfs_layout_segment *,
1430 struct pnfs_layout_segment *),
1431 struct list_head *free_me)
1433 struct pnfs_layout_segment *lp, *tmp;
1435 dprintk("%s:Begin\n", __func__);
1437 list_for_each_entry_safe(lp, tmp, &lo->plh_segs, pls_list) {
1438 if (test_bit(NFS_LSEG_VALID, &lp->pls_flags) == 0)
1440 if (do_merge(lseg, lp)) {
1441 mark_lseg_invalid(lp, free_me);
1444 if (is_after(&lseg->pls_range, &lp->pls_range))
1446 list_add_tail(&lseg->pls_list, &lp->pls_list);
1447 dprintk("%s: inserted lseg %p "
1448 "iomode %d offset %llu length %llu before "
1449 "lp %p iomode %d offset %llu length %llu\n",
1450 __func__, lseg, lseg->pls_range.iomode,
1451 lseg->pls_range.offset, lseg->pls_range.length,
1452 lp, lp->pls_range.iomode, lp->pls_range.offset,
1453 lp->pls_range.length);
1456 list_add_tail(&lseg->pls_list, &lo->plh_segs);
1457 dprintk("%s: inserted lseg %p "
1458 "iomode %d offset %llu length %llu at tail\n",
1459 __func__, lseg, lseg->pls_range.iomode,
1460 lseg->pls_range.offset, lseg->pls_range.length);
1462 pnfs_get_layout_hdr(lo);
1464 dprintk("%s:Return\n", __func__);
1466 EXPORT_SYMBOL_GPL(pnfs_generic_layout_insert_lseg);
1469 pnfs_layout_insert_lseg(struct pnfs_layout_hdr *lo,
1470 struct pnfs_layout_segment *lseg,
1471 struct list_head *free_me)
1473 struct inode *inode = lo->plh_inode;
1474 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
1476 if (ld->add_lseg != NULL)
1477 ld->add_lseg(lo, lseg, free_me);
1479 pnfs_generic_layout_insert_lseg(lo, lseg,
1480 pnfs_lseg_range_is_after,
1485 static struct pnfs_layout_hdr *
1486 alloc_init_layout_hdr(struct inode *ino,
1487 struct nfs_open_context *ctx,
1490 struct pnfs_layout_hdr *lo;
1492 lo = pnfs_alloc_layout_hdr(ino, gfp_flags);
1495 atomic_set(&lo->plh_refcount, 1);
1496 INIT_LIST_HEAD(&lo->plh_layouts);
1497 INIT_LIST_HEAD(&lo->plh_segs);
1498 INIT_LIST_HEAD(&lo->plh_return_segs);
1499 INIT_LIST_HEAD(&lo->plh_bulk_destroy);
1500 lo->plh_inode = ino;
1501 lo->plh_lc_cred = get_rpccred(ctx->cred);
1502 lo->plh_flags |= 1 << NFS_LAYOUT_INVALID_STID;
1506 static struct pnfs_layout_hdr *
1507 pnfs_find_alloc_layout(struct inode *ino,
1508 struct nfs_open_context *ctx,
1510 __releases(&ino->i_lock)
1511 __acquires(&ino->i_lock)
1513 struct nfs_inode *nfsi = NFS_I(ino);
1514 struct pnfs_layout_hdr *new = NULL;
1516 dprintk("%s Begin ino=%p layout=%p\n", __func__, ino, nfsi->layout);
1518 if (nfsi->layout != NULL)
1520 spin_unlock(&ino->i_lock);
1521 new = alloc_init_layout_hdr(ino, ctx, gfp_flags);
1522 spin_lock(&ino->i_lock);
1524 if (likely(nfsi->layout == NULL)) { /* Won the race? */
1527 } else if (new != NULL)
1528 pnfs_free_layout_hdr(new);
1530 pnfs_get_layout_hdr(nfsi->layout);
1531 return nfsi->layout;
1535 * iomode matching rules:
1536 * iomode lseg strict match
1538 * ----- ----- ------ -----
1543 * READ READ N/A true
1544 * READ RW true false
1545 * READ RW false true
1548 pnfs_lseg_range_match(const struct pnfs_layout_range *ls_range,
1549 const struct pnfs_layout_range *range,
1552 struct pnfs_layout_range range1;
1554 if ((range->iomode == IOMODE_RW &&
1555 ls_range->iomode != IOMODE_RW) ||
1556 (range->iomode != ls_range->iomode &&
1557 strict_iomode == true) ||
1558 !pnfs_lseg_range_intersecting(ls_range, range))
1561 /* range1 covers only the first byte in the range */
1564 return pnfs_lseg_range_contained(ls_range, &range1);
1568 * lookup range in layout
1570 static struct pnfs_layout_segment *
1571 pnfs_find_lseg(struct pnfs_layout_hdr *lo,
1572 struct pnfs_layout_range *range,
1575 struct pnfs_layout_segment *lseg, *ret = NULL;
1577 dprintk("%s:Begin\n", __func__);
1579 list_for_each_entry(lseg, &lo->plh_segs, pls_list) {
1580 if (test_bit(NFS_LSEG_VALID, &lseg->pls_flags) &&
1581 !test_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags) &&
1582 pnfs_lseg_range_match(&lseg->pls_range, range,
1584 ret = pnfs_get_lseg(lseg);
1589 dprintk("%s:Return lseg %p ref %d\n",
1590 __func__, ret, ret ? atomic_read(&ret->pls_refcount) : 0);
1595 * Use mdsthreshold hints set at each OPEN to determine if I/O should go
1596 * to the MDS or over pNFS
1598 * The nfs_inode read_io and write_io fields are cumulative counters reset
1599 * when there are no layout segments. Note that in pnfs_update_layout iomode
1600 * is set to IOMODE_READ for a READ request, and set to IOMODE_RW for a
1603 * A return of true means use MDS I/O.
1606 * If a file's size is smaller than the file size threshold, data accesses
1607 * SHOULD be sent to the metadata server. If an I/O request has a length that
1608 * is below the I/O size threshold, the I/O SHOULD be sent to the metadata
1609 * server. If both file size and I/O size are provided, the client SHOULD
1610 * reach or exceed both thresholds before sending its read or write
1611 * requests to the data server.
1613 static bool pnfs_within_mdsthreshold(struct nfs_open_context *ctx,
1614 struct inode *ino, int iomode)
1616 struct nfs4_threshold *t = ctx->mdsthreshold;
1617 struct nfs_inode *nfsi = NFS_I(ino);
1618 loff_t fsize = i_size_read(ino);
1619 bool size = false, size_set = false, io = false, io_set = false, ret = false;
1624 dprintk("%s bm=0x%x rd_sz=%llu wr_sz=%llu rd_io=%llu wr_io=%llu\n",
1625 __func__, t->bm, t->rd_sz, t->wr_sz, t->rd_io_sz, t->wr_io_sz);
1629 if (t->bm & THRESHOLD_RD) {
1630 dprintk("%s fsize %llu\n", __func__, fsize);
1632 if (fsize < t->rd_sz)
1635 if (t->bm & THRESHOLD_RD_IO) {
1636 dprintk("%s nfsi->read_io %llu\n", __func__,
1639 if (nfsi->read_io < t->rd_io_sz)
1644 if (t->bm & THRESHOLD_WR) {
1645 dprintk("%s fsize %llu\n", __func__, fsize);
1647 if (fsize < t->wr_sz)
1650 if (t->bm & THRESHOLD_WR_IO) {
1651 dprintk("%s nfsi->write_io %llu\n", __func__,
1654 if (nfsi->write_io < t->wr_io_sz)
1659 if (size_set && io_set) {
1662 } else if (size || io)
1665 dprintk("<-- %s size %d io %d ret %d\n", __func__, size, io, ret);
1669 static bool pnfs_prepare_to_retry_layoutget(struct pnfs_layout_hdr *lo)
1672 * send layoutcommit as it can hold up layoutreturn due to lseg
1675 pnfs_layoutcommit_inode(lo->plh_inode, false);
1676 return !wait_on_bit_action(&lo->plh_flags, NFS_LAYOUT_RETURN,
1677 nfs_wait_bit_killable,
1678 TASK_UNINTERRUPTIBLE);
1681 static void pnfs_clear_first_layoutget(struct pnfs_layout_hdr *lo)
1683 unsigned long *bitlock = &lo->plh_flags;
1685 clear_bit_unlock(NFS_LAYOUT_FIRST_LAYOUTGET, bitlock);
1686 smp_mb__after_atomic();
1687 wake_up_bit(bitlock, NFS_LAYOUT_FIRST_LAYOUTGET);
1691 * Layout segment is retreived from the server if not cached.
1692 * The appropriate layout segment is referenced and returned to the caller.
1694 struct pnfs_layout_segment *
1695 pnfs_update_layout(struct inode *ino,
1696 struct nfs_open_context *ctx,
1699 enum pnfs_iomode iomode,
1703 struct pnfs_layout_range arg = {
1708 unsigned pg_offset, seq;
1709 struct nfs_server *server = NFS_SERVER(ino);
1710 struct nfs_client *clp = server->nfs_client;
1711 struct pnfs_layout_hdr *lo = NULL;
1712 struct pnfs_layout_segment *lseg = NULL;
1713 nfs4_stateid stateid;
1715 unsigned long giveup = jiffies + (clp->cl_lease_time << 1);
1718 if (!pnfs_enabled_sb(NFS_SERVER(ino))) {
1719 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1720 PNFS_UPDATE_LAYOUT_NO_PNFS);
1724 if (iomode == IOMODE_READ && i_size_read(ino) == 0) {
1725 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1726 PNFS_UPDATE_LAYOUT_RD_ZEROLEN);
1730 if (pnfs_within_mdsthreshold(ctx, ino, iomode)) {
1731 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1732 PNFS_UPDATE_LAYOUT_MDSTHRESH);
1737 nfs4_client_recover_expired_lease(clp);
1739 spin_lock(&ino->i_lock);
1740 lo = pnfs_find_alloc_layout(ino, ctx, gfp_flags);
1742 spin_unlock(&ino->i_lock);
1743 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1744 PNFS_UPDATE_LAYOUT_NOMEM);
1748 /* Do we even need to bother with this? */
1749 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
1750 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1751 PNFS_UPDATE_LAYOUT_BULK_RECALL);
1752 dprintk("%s matches recall, use MDS\n", __func__);
1756 /* if LAYOUTGET already failed once we don't try again */
1757 if (pnfs_layout_io_test_failed(lo, iomode)) {
1758 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1759 PNFS_UPDATE_LAYOUT_IO_TEST_FAIL);
1763 lseg = pnfs_find_lseg(lo, &arg, strict_iomode);
1765 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1766 PNFS_UPDATE_LAYOUT_FOUND_CACHED);
1770 if (!nfs4_valid_open_stateid(ctx->state)) {
1771 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1772 PNFS_UPDATE_LAYOUT_INVALID_OPEN);
1777 * Choose a stateid for the LAYOUTGET. If we don't have a layout
1778 * stateid, or it has been invalidated, then we must use the open
1781 if (test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags)) {
1784 * The first layoutget for the file. Need to serialize per
1785 * RFC 5661 Errata 3208.
1787 if (test_and_set_bit(NFS_LAYOUT_FIRST_LAYOUTGET,
1789 spin_unlock(&ino->i_lock);
1790 wait_on_bit(&lo->plh_flags, NFS_LAYOUT_FIRST_LAYOUTGET,
1791 TASK_UNINTERRUPTIBLE);
1792 pnfs_put_layout_hdr(lo);
1793 dprintk("%s retrying\n", __func__);
1799 seq = read_seqbegin(&ctx->state->seqlock);
1800 nfs4_stateid_copy(&stateid, &ctx->state->stateid);
1801 } while (read_seqretry(&ctx->state->seqlock, seq));
1803 nfs4_stateid_copy(&stateid, &lo->plh_stateid);
1807 * Because we free lsegs before sending LAYOUTRETURN, we need to wait
1808 * for LAYOUTRETURN even if first is true.
1810 if (test_bit(NFS_LAYOUT_RETURN, &lo->plh_flags)) {
1811 spin_unlock(&ino->i_lock);
1812 dprintk("%s wait for layoutreturn\n", __func__);
1813 if (pnfs_prepare_to_retry_layoutget(lo)) {
1815 pnfs_clear_first_layoutget(lo);
1816 pnfs_put_layout_hdr(lo);
1817 dprintk("%s retrying\n", __func__);
1818 trace_pnfs_update_layout(ino, pos, count, iomode, lo,
1819 lseg, PNFS_UPDATE_LAYOUT_RETRY);
1822 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1823 PNFS_UPDATE_LAYOUT_RETURN);
1824 goto out_put_layout_hdr;
1827 if (pnfs_layoutgets_blocked(lo)) {
1828 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1829 PNFS_UPDATE_LAYOUT_BLOCKED);
1832 atomic_inc(&lo->plh_outstanding);
1833 spin_unlock(&ino->i_lock);
1835 if (list_empty(&lo->plh_layouts)) {
1836 /* The lo must be on the clp list if there is any
1837 * chance of a CB_LAYOUTRECALL(FILE) coming in.
1839 spin_lock(&clp->cl_lock);
1840 if (list_empty(&lo->plh_layouts))
1841 list_add_tail(&lo->plh_layouts, &server->layouts);
1842 spin_unlock(&clp->cl_lock);
1845 pg_offset = arg.offset & ~PAGE_MASK;
1847 arg.offset -= pg_offset;
1848 arg.length += pg_offset;
1850 if (arg.length != NFS4_MAX_UINT64)
1851 arg.length = PAGE_ALIGN(arg.length);
1853 lseg = send_layoutget(lo, ctx, &stateid, &arg, &timeout, gfp_flags);
1854 trace_pnfs_update_layout(ino, pos, count, iomode, lo, lseg,
1855 PNFS_UPDATE_LAYOUT_SEND_LAYOUTGET);
1856 atomic_dec(&lo->plh_outstanding);
1858 switch(PTR_ERR(lseg)) {
1860 if (time_after(jiffies, giveup))
1863 case -ERECALLCONFLICT:
1864 /* Huh? We hold no layouts, how is there a recall? */
1869 /* Destroy the existing layout and start over */
1870 if (time_after(jiffies, giveup))
1871 pnfs_destroy_layout(NFS_I(ino));
1876 if (!nfs_error_is_fatal(PTR_ERR(lseg))) {
1877 pnfs_layout_clear_fail_bit(lo, pnfs_iomode_to_fail_bit(iomode));
1880 goto out_put_layout_hdr;
1884 pnfs_clear_first_layoutget(lo);
1885 trace_pnfs_update_layout(ino, pos, count,
1886 iomode, lo, lseg, PNFS_UPDATE_LAYOUT_RETRY);
1887 pnfs_put_layout_hdr(lo);
1891 pnfs_layout_clear_fail_bit(lo, pnfs_iomode_to_fail_bit(iomode));
1896 pnfs_clear_first_layoutget(lo);
1897 pnfs_put_layout_hdr(lo);
1899 dprintk("%s: inode %s/%llu pNFS layout segment %s for "
1900 "(%s, offset: %llu, length: %llu)\n",
1901 __func__, ino->i_sb->s_id,
1902 (unsigned long long)NFS_FILEID(ino),
1903 IS_ERR_OR_NULL(lseg) ? "not found" : "found",
1904 iomode==IOMODE_RW ? "read/write" : "read-only",
1905 (unsigned long long)pos,
1906 (unsigned long long)count);
1909 spin_unlock(&ino->i_lock);
1910 goto out_put_layout_hdr;
1912 EXPORT_SYMBOL_GPL(pnfs_update_layout);
1915 pnfs_sanity_check_layout_range(struct pnfs_layout_range *range)
1917 switch (range->iomode) {
1924 if (range->offset == NFS4_MAX_UINT64)
1926 if (range->length == 0)
1928 if (range->length != NFS4_MAX_UINT64 &&
1929 range->length > NFS4_MAX_UINT64 - range->offset)
1934 struct pnfs_layout_segment *
1935 pnfs_layout_process(struct nfs4_layoutget *lgp)
1937 struct pnfs_layout_hdr *lo = NFS_I(lgp->args.inode)->layout;
1938 struct nfs4_layoutget_res *res = &lgp->res;
1939 struct pnfs_layout_segment *lseg;
1940 struct inode *ino = lo->plh_inode;
1943 if (!pnfs_sanity_check_layout_range(&res->range))
1944 return ERR_PTR(-EINVAL);
1946 /* Inject layout blob into I/O device driver */
1947 lseg = NFS_SERVER(ino)->pnfs_curr_ld->alloc_lseg(lo, res, lgp->gfp_flags);
1948 if (IS_ERR_OR_NULL(lseg)) {
1950 lseg = ERR_PTR(-ENOMEM);
1952 dprintk("%s: Could not allocate layout: error %ld\n",
1953 __func__, PTR_ERR(lseg));
1957 pnfs_init_lseg(lo, lseg, &res->range, &res->stateid);
1959 spin_lock(&ino->i_lock);
1960 if (pnfs_layoutgets_blocked(lo)) {
1961 dprintk("%s forget reply due to state\n", __func__);
1965 if (!pnfs_layout_is_valid(lo)) {
1966 /* We have a completely new layout */
1967 pnfs_set_layout_stateid(lo, &res->stateid, true);
1968 } else if (nfs4_stateid_match_other(&lo->plh_stateid, &res->stateid)) {
1969 /* existing state ID, make sure the sequence number matches. */
1970 if (pnfs_layout_stateid_blocked(lo, &res->stateid)) {
1971 dprintk("%s forget reply due to sequence\n", __func__);
1974 pnfs_set_layout_stateid(lo, &res->stateid, false);
1977 * We got an entirely new state ID. Mark all segments for the
1978 * inode invalid, and retry the layoutget
1980 pnfs_mark_layout_stateid_invalid(lo, &free_me);
1984 pnfs_get_lseg(lseg);
1985 pnfs_layout_insert_lseg(lo, lseg, &free_me);
1988 if (res->return_on_close)
1989 set_bit(NFS_LSEG_ROC, &lseg->pls_flags);
1991 spin_unlock(&ino->i_lock);
1992 pnfs_free_lseg_list(&free_me);
1996 spin_unlock(&ino->i_lock);
1997 lseg->pls_layout = lo;
1998 NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
1999 if (!pnfs_layout_is_valid(lo))
2000 nfs_commit_inode(ino, 0);
2001 return ERR_PTR(-EAGAIN);
2005 * pnfs_mark_matching_lsegs_return - Free or return matching layout segments
2006 * @lo: pointer to layout header
2007 * @tmp_list: list header to be used with pnfs_free_lseg_list()
2008 * @return_range: describe layout segment ranges to be returned
2010 * This function is mainly intended for use by layoutrecall. It attempts
2011 * to free the layout segment immediately, or else to mark it for return
2012 * as soon as its reference count drops to zero.
2015 pnfs_mark_matching_lsegs_return(struct pnfs_layout_hdr *lo,
2016 struct list_head *tmp_list,
2017 const struct pnfs_layout_range *return_range,
2020 struct pnfs_layout_segment *lseg, *next;
2023 dprintk("%s:Begin lo %p\n", __func__, lo);
2025 if (list_empty(&lo->plh_segs))
2028 assert_spin_locked(&lo->plh_inode->i_lock);
2030 list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
2031 if (pnfs_match_lseg_recall(lseg, return_range, seq)) {
2032 dprintk("%s: marking lseg %p iomode %d "
2033 "offset %llu length %llu\n", __func__,
2034 lseg, lseg->pls_range.iomode,
2035 lseg->pls_range.offset,
2036 lseg->pls_range.length);
2037 if (mark_lseg_invalid(lseg, tmp_list))
2040 set_bit(NFS_LSEG_LAYOUTRETURN, &lseg->pls_flags);
2044 pnfs_set_plh_return_info(lo, return_range->iomode, seq);
2049 void pnfs_error_mark_layout_for_return(struct inode *inode,
2050 struct pnfs_layout_segment *lseg)
2052 struct pnfs_layout_hdr *lo = NFS_I(inode)->layout;
2053 struct pnfs_layout_range range = {
2054 .iomode = lseg->pls_range.iomode,
2056 .length = NFS4_MAX_UINT64,
2058 bool return_now = false;
2060 spin_lock(&inode->i_lock);
2061 if (!pnfs_layout_is_valid(lo)) {
2062 spin_unlock(&inode->i_lock);
2065 pnfs_set_plh_return_info(lo, range.iomode, 0);
2067 * mark all matching lsegs so that we are sure to have no live
2068 * segments at hand when sending layoutreturn. See pnfs_put_lseg()
2071 if (!pnfs_mark_matching_lsegs_return(lo, &lo->plh_return_segs, &range, 0)) {
2072 nfs4_stateid stateid;
2073 enum pnfs_iomode iomode;
2075 return_now = pnfs_prepare_layoutreturn(lo, &stateid, &iomode);
2076 spin_unlock(&inode->i_lock);
2078 pnfs_send_layoutreturn(lo, &stateid, iomode, false);
2080 spin_unlock(&inode->i_lock);
2081 nfs_commit_inode(inode, 0);
2084 EXPORT_SYMBOL_GPL(pnfs_error_mark_layout_for_return);
2087 pnfs_generic_pg_check_layout(struct nfs_pageio_descriptor *pgio)
2089 if (pgio->pg_lseg == NULL ||
2090 test_bit(NFS_LSEG_VALID, &pgio->pg_lseg->pls_flags))
2092 pnfs_put_lseg(pgio->pg_lseg);
2093 pgio->pg_lseg = NULL;
2095 EXPORT_SYMBOL_GPL(pnfs_generic_pg_check_layout);
2098 pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
2100 u64 rd_size = req->wb_bytes;
2102 pnfs_generic_pg_check_layout(pgio);
2103 if (pgio->pg_lseg == NULL) {
2104 if (pgio->pg_dreq == NULL)
2105 rd_size = i_size_read(pgio->pg_inode) - req_offset(req);
2107 rd_size = nfs_dreq_bytes_left(pgio->pg_dreq);
2109 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
2116 if (IS_ERR(pgio->pg_lseg)) {
2117 pgio->pg_error = PTR_ERR(pgio->pg_lseg);
2118 pgio->pg_lseg = NULL;
2122 /* If no lseg, fall back to read through mds */
2123 if (pgio->pg_lseg == NULL)
2124 nfs_pageio_reset_read_mds(pgio);
2127 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_read);
2130 pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
2131 struct nfs_page *req, u64 wb_size)
2133 pnfs_generic_pg_check_layout(pgio);
2134 if (pgio->pg_lseg == NULL) {
2135 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
2142 if (IS_ERR(pgio->pg_lseg)) {
2143 pgio->pg_error = PTR_ERR(pgio->pg_lseg);
2144 pgio->pg_lseg = NULL;
2148 /* If no lseg, fall back to write through mds */
2149 if (pgio->pg_lseg == NULL)
2150 nfs_pageio_reset_write_mds(pgio);
2152 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_write);
2155 pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *desc)
2157 if (desc->pg_lseg) {
2158 pnfs_put_lseg(desc->pg_lseg);
2159 desc->pg_lseg = NULL;
2162 EXPORT_SYMBOL_GPL(pnfs_generic_pg_cleanup);
2165 * Return 0 if @req cannot be coalesced into @pgio, otherwise return the number
2166 * of bytes (maximum @req->wb_bytes) that can be coalesced.
2169 pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
2170 struct nfs_page *prev, struct nfs_page *req)
2173 u64 seg_end, req_start, seg_left;
2175 size = nfs_generic_pg_test(pgio, prev, req);
2180 * 'size' contains the number of bytes left in the current page (up
2181 * to the original size asked for in @req->wb_bytes).
2183 * Calculate how many bytes are left in the layout segment
2184 * and if there are less bytes than 'size', return that instead.
2186 * Please also note that 'end_offset' is actually the offset of the
2187 * first byte that lies outside the pnfs_layout_range. FIXME?
2190 if (pgio->pg_lseg) {
2191 seg_end = pnfs_end_offset(pgio->pg_lseg->pls_range.offset,
2192 pgio->pg_lseg->pls_range.length);
2193 req_start = req_offset(req);
2194 WARN_ON_ONCE(req_start >= seg_end);
2195 /* start of request is past the last byte of this segment */
2196 if (req_start >= seg_end) {
2197 /* reference the new lseg */
2198 if (pgio->pg_ops->pg_cleanup)
2199 pgio->pg_ops->pg_cleanup(pgio);
2200 if (pgio->pg_ops->pg_init)
2201 pgio->pg_ops->pg_init(pgio, req);
2205 /* adjust 'size' iff there are fewer bytes left in the
2206 * segment than what nfs_generic_pg_test returned */
2207 seg_left = seg_end - req_start;
2208 if (seg_left < size)
2209 size = (unsigned int)seg_left;
2214 EXPORT_SYMBOL_GPL(pnfs_generic_pg_test);
2216 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *hdr)
2218 struct nfs_pageio_descriptor pgio;
2220 /* Resend all requests through the MDS */
2221 nfs_pageio_init_write(&pgio, hdr->inode, FLUSH_STABLE, true,
2222 hdr->completion_ops);
2223 set_bit(NFS_CONTEXT_RESEND_WRITES, &hdr->args.context->flags);
2224 return nfs_pageio_resend(&pgio, hdr);
2226 EXPORT_SYMBOL_GPL(pnfs_write_done_resend_to_mds);
2228 static void pnfs_ld_handle_write_error(struct nfs_pgio_header *hdr)
2231 dprintk("pnfs write error = %d\n", hdr->pnfs_error);
2232 if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
2233 PNFS_LAYOUTRET_ON_ERROR) {
2234 pnfs_return_layout(hdr->inode);
2236 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
2237 hdr->task.tk_status = pnfs_write_done_resend_to_mds(hdr);
2241 * Called by non rpc-based layout drivers
2243 void pnfs_ld_write_done(struct nfs_pgio_header *hdr)
2245 if (likely(!hdr->pnfs_error)) {
2246 pnfs_set_layoutcommit(hdr->inode, hdr->lseg,
2247 hdr->mds_offset + hdr->res.count);
2248 hdr->mds_ops->rpc_call_done(&hdr->task, hdr);
2250 trace_nfs4_pnfs_write(hdr, hdr->pnfs_error);
2251 if (unlikely(hdr->pnfs_error))
2252 pnfs_ld_handle_write_error(hdr);
2253 hdr->mds_ops->rpc_release(hdr);
2255 EXPORT_SYMBOL_GPL(pnfs_ld_write_done);
2258 pnfs_write_through_mds(struct nfs_pageio_descriptor *desc,
2259 struct nfs_pgio_header *hdr)
2261 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
2263 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
2264 list_splice_tail_init(&hdr->pages, &mirror->pg_list);
2265 nfs_pageio_reset_write_mds(desc);
2266 mirror->pg_recoalesce = 1;
2268 nfs_pgio_data_destroy(hdr);
2272 static enum pnfs_try_status
2273 pnfs_try_to_write_data(struct nfs_pgio_header *hdr,
2274 const struct rpc_call_ops *call_ops,
2275 struct pnfs_layout_segment *lseg,
2278 struct inode *inode = hdr->inode;
2279 enum pnfs_try_status trypnfs;
2280 struct nfs_server *nfss = NFS_SERVER(inode);
2282 hdr->mds_ops = call_ops;
2284 dprintk("%s: Writing ino:%lu %u@%llu (how %d)\n", __func__,
2285 inode->i_ino, hdr->args.count, hdr->args.offset, how);
2286 trypnfs = nfss->pnfs_curr_ld->write_pagelist(hdr, how);
2287 if (trypnfs != PNFS_NOT_ATTEMPTED)
2288 nfs_inc_stats(inode, NFSIOS_PNFS_WRITE);
2289 dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
2294 pnfs_do_write(struct nfs_pageio_descriptor *desc,
2295 struct nfs_pgio_header *hdr, int how)
2297 const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
2298 struct pnfs_layout_segment *lseg = desc->pg_lseg;
2299 enum pnfs_try_status trypnfs;
2301 trypnfs = pnfs_try_to_write_data(hdr, call_ops, lseg, how);
2303 case PNFS_NOT_ATTEMPTED:
2304 pnfs_write_through_mds(desc, hdr);
2305 case PNFS_ATTEMPTED:
2307 case PNFS_TRY_AGAIN:
2308 /* cleanup hdr and prepare to redo pnfs */
2309 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
2310 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
2311 list_splice_init(&hdr->pages, &mirror->pg_list);
2312 mirror->pg_recoalesce = 1;
2314 hdr->mds_ops->rpc_release(hdr);
2318 static void pnfs_writehdr_free(struct nfs_pgio_header *hdr)
2320 pnfs_put_lseg(hdr->lseg);
2321 nfs_pgio_header_free(hdr);
2325 pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc)
2327 struct nfs_pgio_header *hdr;
2330 hdr = nfs_pgio_header_alloc(desc->pg_rw_ops);
2332 desc->pg_error = -ENOMEM;
2333 return desc->pg_error;
2335 nfs_pgheader_init(desc, hdr, pnfs_writehdr_free);
2337 hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
2338 ret = nfs_generic_pgio(desc, hdr);
2340 pnfs_do_write(desc, hdr, desc->pg_ioflags);
2344 EXPORT_SYMBOL_GPL(pnfs_generic_pg_writepages);
2346 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *hdr)
2348 struct nfs_pageio_descriptor pgio;
2350 /* Resend all requests through the MDS */
2351 nfs_pageio_init_read(&pgio, hdr->inode, true, hdr->completion_ops);
2352 return nfs_pageio_resend(&pgio, hdr);
2354 EXPORT_SYMBOL_GPL(pnfs_read_done_resend_to_mds);
2356 static void pnfs_ld_handle_read_error(struct nfs_pgio_header *hdr)
2358 dprintk("pnfs read error = %d\n", hdr->pnfs_error);
2359 if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
2360 PNFS_LAYOUTRET_ON_ERROR) {
2361 pnfs_return_layout(hdr->inode);
2363 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
2364 hdr->task.tk_status = pnfs_read_done_resend_to_mds(hdr);
2368 * Called by non rpc-based layout drivers
2370 void pnfs_ld_read_done(struct nfs_pgio_header *hdr)
2372 if (likely(!hdr->pnfs_error))
2373 hdr->mds_ops->rpc_call_done(&hdr->task, hdr);
2374 trace_nfs4_pnfs_read(hdr, hdr->pnfs_error);
2375 if (unlikely(hdr->pnfs_error))
2376 pnfs_ld_handle_read_error(hdr);
2377 hdr->mds_ops->rpc_release(hdr);
2379 EXPORT_SYMBOL_GPL(pnfs_ld_read_done);
2382 pnfs_read_through_mds(struct nfs_pageio_descriptor *desc,
2383 struct nfs_pgio_header *hdr)
2385 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
2387 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
2388 list_splice_tail_init(&hdr->pages, &mirror->pg_list);
2389 nfs_pageio_reset_read_mds(desc);
2390 mirror->pg_recoalesce = 1;
2392 nfs_pgio_data_destroy(hdr);
2397 * Call the appropriate parallel I/O subsystem read function.
2399 static enum pnfs_try_status
2400 pnfs_try_to_read_data(struct nfs_pgio_header *hdr,
2401 const struct rpc_call_ops *call_ops,
2402 struct pnfs_layout_segment *lseg)
2404 struct inode *inode = hdr->inode;
2405 struct nfs_server *nfss = NFS_SERVER(inode);
2406 enum pnfs_try_status trypnfs;
2408 hdr->mds_ops = call_ops;
2410 dprintk("%s: Reading ino:%lu %u@%llu\n",
2411 __func__, inode->i_ino, hdr->args.count, hdr->args.offset);
2413 trypnfs = nfss->pnfs_curr_ld->read_pagelist(hdr);
2414 if (trypnfs != PNFS_NOT_ATTEMPTED)
2415 nfs_inc_stats(inode, NFSIOS_PNFS_READ);
2416 dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
2420 /* Resend all requests through pnfs. */
2421 void pnfs_read_resend_pnfs(struct nfs_pgio_header *hdr)
2423 struct nfs_pageio_descriptor pgio;
2425 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
2426 /* Prevent deadlocks with layoutreturn! */
2427 pnfs_put_lseg(hdr->lseg);
2430 nfs_pageio_init_read(&pgio, hdr->inode, false,
2431 hdr->completion_ops);
2432 hdr->task.tk_status = nfs_pageio_resend(&pgio, hdr);
2435 EXPORT_SYMBOL_GPL(pnfs_read_resend_pnfs);
2438 pnfs_do_read(struct nfs_pageio_descriptor *desc, struct nfs_pgio_header *hdr)
2440 const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
2441 struct pnfs_layout_segment *lseg = desc->pg_lseg;
2442 enum pnfs_try_status trypnfs;
2444 trypnfs = pnfs_try_to_read_data(hdr, call_ops, lseg);
2446 case PNFS_NOT_ATTEMPTED:
2447 pnfs_read_through_mds(desc, hdr);
2448 case PNFS_ATTEMPTED:
2450 case PNFS_TRY_AGAIN:
2451 /* cleanup hdr and prepare to redo pnfs */
2452 if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
2453 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
2454 list_splice_init(&hdr->pages, &mirror->pg_list);
2455 mirror->pg_recoalesce = 1;
2457 hdr->mds_ops->rpc_release(hdr);
2461 static void pnfs_readhdr_free(struct nfs_pgio_header *hdr)
2463 pnfs_put_lseg(hdr->lseg);
2464 nfs_pgio_header_free(hdr);
2468 pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc)
2470 struct nfs_pgio_header *hdr;
2473 hdr = nfs_pgio_header_alloc(desc->pg_rw_ops);
2475 desc->pg_error = -ENOMEM;
2476 return desc->pg_error;
2478 nfs_pgheader_init(desc, hdr, pnfs_readhdr_free);
2479 hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
2480 ret = nfs_generic_pgio(desc, hdr);
2482 pnfs_do_read(desc, hdr);
2485 EXPORT_SYMBOL_GPL(pnfs_generic_pg_readpages);
2487 static void pnfs_clear_layoutcommitting(struct inode *inode)
2489 unsigned long *bitlock = &NFS_I(inode)->flags;
2491 clear_bit_unlock(NFS_INO_LAYOUTCOMMITTING, bitlock);
2492 smp_mb__after_atomic();
2493 wake_up_bit(bitlock, NFS_INO_LAYOUTCOMMITTING);
2497 * There can be multiple RW segments.
2499 static void pnfs_list_write_lseg(struct inode *inode, struct list_head *listp)
2501 struct pnfs_layout_segment *lseg;
2503 list_for_each_entry(lseg, &NFS_I(inode)->layout->plh_segs, pls_list) {
2504 if (lseg->pls_range.iomode == IOMODE_RW &&
2505 test_and_clear_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags))
2506 list_add(&lseg->pls_lc_list, listp);
2510 static void pnfs_list_write_lseg_done(struct inode *inode, struct list_head *listp)
2512 struct pnfs_layout_segment *lseg, *tmp;
2514 /* Matched by references in pnfs_set_layoutcommit */
2515 list_for_each_entry_safe(lseg, tmp, listp, pls_lc_list) {
2516 list_del_init(&lseg->pls_lc_list);
2517 pnfs_put_lseg(lseg);
2520 pnfs_clear_layoutcommitting(inode);
2523 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg)
2525 pnfs_layout_io_set_failed(lseg->pls_layout, lseg->pls_range.iomode);
2527 EXPORT_SYMBOL_GPL(pnfs_set_lo_fail);
2530 pnfs_set_layoutcommit(struct inode *inode, struct pnfs_layout_segment *lseg,
2533 struct nfs_inode *nfsi = NFS_I(inode);
2534 bool mark_as_dirty = false;
2536 spin_lock(&inode->i_lock);
2537 if (!test_and_set_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags)) {
2538 nfsi->layout->plh_lwb = end_pos;
2539 mark_as_dirty = true;
2540 dprintk("%s: Set layoutcommit for inode %lu ",
2541 __func__, inode->i_ino);
2542 } else if (end_pos > nfsi->layout->plh_lwb)
2543 nfsi->layout->plh_lwb = end_pos;
2544 if (!test_and_set_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags)) {
2545 /* references matched in nfs4_layoutcommit_release */
2546 pnfs_get_lseg(lseg);
2548 spin_unlock(&inode->i_lock);
2549 dprintk("%s: lseg %p end_pos %llu\n",
2550 __func__, lseg, nfsi->layout->plh_lwb);
2552 /* if pnfs_layoutcommit_inode() runs between inode locks, the next one
2553 * will be a noop because NFS_INO_LAYOUTCOMMIT will not be set */
2555 mark_inode_dirty_sync(inode);
2557 EXPORT_SYMBOL_GPL(pnfs_set_layoutcommit);
2559 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data)
2561 struct nfs_server *nfss = NFS_SERVER(data->args.inode);
2563 if (nfss->pnfs_curr_ld->cleanup_layoutcommit)
2564 nfss->pnfs_curr_ld->cleanup_layoutcommit(data);
2565 pnfs_list_write_lseg_done(data->args.inode, &data->lseg_list);
2569 * For the LAYOUT4_NFSV4_1_FILES layout type, NFS_DATA_SYNC WRITEs and
2570 * NFS_UNSTABLE WRITEs with a COMMIT to data servers must store enough
2571 * data to disk to allow the server to recover the data if it crashes.
2572 * LAYOUTCOMMIT is only needed when the NFL4_UFLG_COMMIT_THRU_MDS flag
2573 * is off, and a COMMIT is sent to a data server, or
2574 * if WRITEs to a data server return NFS_DATA_SYNC.
2577 pnfs_layoutcommit_inode(struct inode *inode, bool sync)
2579 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
2580 struct nfs4_layoutcommit_data *data;
2581 struct nfs_inode *nfsi = NFS_I(inode);
2585 if (!pnfs_layoutcommit_outstanding(inode))
2588 dprintk("--> %s inode %lu\n", __func__, inode->i_ino);
2591 if (test_and_set_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags)) {
2594 status = wait_on_bit_lock_action(&nfsi->flags,
2595 NFS_INO_LAYOUTCOMMITTING,
2596 nfs_wait_bit_killable,
2603 /* Note kzalloc ensures data->res.seq_res.sr_slot == NULL */
2604 data = kzalloc(sizeof(*data), GFP_NOFS);
2606 goto clear_layoutcommitting;
2609 spin_lock(&inode->i_lock);
2610 if (!test_and_clear_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
2613 INIT_LIST_HEAD(&data->lseg_list);
2614 pnfs_list_write_lseg(inode, &data->lseg_list);
2616 end_pos = nfsi->layout->plh_lwb;
2618 nfs4_stateid_copy(&data->args.stateid, &nfsi->layout->plh_stateid);
2619 spin_unlock(&inode->i_lock);
2621 data->args.inode = inode;
2622 data->cred = get_rpccred(nfsi->layout->plh_lc_cred);
2623 nfs_fattr_init(&data->fattr);
2624 data->args.bitmask = NFS_SERVER(inode)->cache_consistency_bitmask;
2625 data->res.fattr = &data->fattr;
2627 data->args.lastbytewritten = end_pos - 1;
2629 data->args.lastbytewritten = U64_MAX;
2630 data->res.server = NFS_SERVER(inode);
2632 if (ld->prepare_layoutcommit) {
2633 status = ld->prepare_layoutcommit(&data->args);
2635 put_rpccred(data->cred);
2636 spin_lock(&inode->i_lock);
2637 set_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags);
2638 if (end_pos > nfsi->layout->plh_lwb)
2639 nfsi->layout->plh_lwb = end_pos;
2645 status = nfs4_proc_layoutcommit(data, sync);
2648 mark_inode_dirty_sync(inode);
2649 dprintk("<-- %s status %d\n", __func__, status);
2652 spin_unlock(&inode->i_lock);
2654 clear_layoutcommitting:
2655 pnfs_clear_layoutcommitting(inode);
2658 EXPORT_SYMBOL_GPL(pnfs_layoutcommit_inode);
2661 pnfs_generic_sync(struct inode *inode, bool datasync)
2663 return pnfs_layoutcommit_inode(inode, true);
2665 EXPORT_SYMBOL_GPL(pnfs_generic_sync);
2667 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
2669 struct nfs4_threshold *thp;
2671 thp = kzalloc(sizeof(*thp), GFP_NOFS);
2673 dprintk("%s mdsthreshold allocation failed\n", __func__);
2679 #if IS_ENABLED(CONFIG_NFS_V4_2)
2681 pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags)
2683 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
2684 struct nfs_server *server = NFS_SERVER(inode);
2685 struct nfs_inode *nfsi = NFS_I(inode);
2686 struct nfs42_layoutstat_data *data;
2687 struct pnfs_layout_hdr *hdr;
2690 if (!pnfs_enabled_sb(server) || !ld->prepare_layoutstats)
2693 if (!nfs_server_capable(inode, NFS_CAP_LAYOUTSTATS))
2696 if (test_and_set_bit(NFS_INO_LAYOUTSTATS, &nfsi->flags))
2699 spin_lock(&inode->i_lock);
2700 if (!NFS_I(inode)->layout) {
2701 spin_unlock(&inode->i_lock);
2702 goto out_clear_layoutstats;
2704 hdr = NFS_I(inode)->layout;
2705 pnfs_get_layout_hdr(hdr);
2706 spin_unlock(&inode->i_lock);
2708 data = kzalloc(sizeof(*data), gfp_flags);
2714 data->args.fh = NFS_FH(inode);
2715 data->args.inode = inode;
2716 status = ld->prepare_layoutstats(&data->args);
2720 status = nfs42_proc_layoutstats_generic(NFS_SERVER(inode), data);
2723 dprintk("%s returns %d\n", __func__, status);
2729 pnfs_put_layout_hdr(hdr);
2730 out_clear_layoutstats:
2731 smp_mb__before_atomic();
2732 clear_bit(NFS_INO_LAYOUTSTATS, &nfsi->flags);
2733 smp_mb__after_atomic();
2736 EXPORT_SYMBOL_GPL(pnfs_report_layoutstat);
2739 unsigned int layoutstats_timer;
2740 module_param(layoutstats_timer, uint, 0644);
2741 EXPORT_SYMBOL_GPL(layoutstats_timer);