NFSv4.1: Always set the layout stateid if this is the first layoutget
[linux-block.git] / fs / nfs / pnfs.c
1 /*
2  *  pNFS functions to call and manage layout drivers.
3  *
4  *  Copyright (c) 2002 [year of first publication]
5  *  The Regents of the University of Michigan
6  *  All Rights Reserved
7  *
8  *  Dean Hildebrand <dhildebz@umich.edu>
9  *
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.
18  *
19  *  This software is provided as is, without representation or warranty
20  *  of any kind either express or implied, including without limitation
21  *  the implied warranties of merchantability, fitness for a particular
22  *  purpose, or noninfringement.  The Regents of the University of
23  *  Michigan shall not be liable for any damages, including special,
24  *  indirect, incidental, or consequential damages, with respect to any
25  *  claim arising out of or in connection with the use of the software,
26  *  even if it has been or is hereafter advised of the possibility of
27  *  such damages.
28  */
29
30 #include <linux/nfs_fs.h>
31 #include <linux/nfs_page.h>
32 #include <linux/module.h>
33 #include "internal.h"
34 #include "pnfs.h"
35 #include "iostat.h"
36
37 #define NFSDBG_FACILITY         NFSDBG_PNFS
38 #define PNFS_LAYOUTGET_RETRY_TIMEOUT (120*HZ)
39
40 /* Locking:
41  *
42  * pnfs_spinlock:
43  *      protects pnfs_modules_tbl.
44  */
45 static DEFINE_SPINLOCK(pnfs_spinlock);
46
47 /*
48  * pnfs_modules_tbl holds all pnfs modules
49  */
50 static LIST_HEAD(pnfs_modules_tbl);
51
52 /* Return the registered pnfs layout driver module matching given id */
53 static struct pnfs_layoutdriver_type *
54 find_pnfs_driver_locked(u32 id)
55 {
56         struct pnfs_layoutdriver_type *local;
57
58         list_for_each_entry(local, &pnfs_modules_tbl, pnfs_tblid)
59                 if (local->id == id)
60                         goto out;
61         local = NULL;
62 out:
63         dprintk("%s: Searching for id %u, found %p\n", __func__, id, local);
64         return local;
65 }
66
67 static struct pnfs_layoutdriver_type *
68 find_pnfs_driver(u32 id)
69 {
70         struct pnfs_layoutdriver_type *local;
71
72         spin_lock(&pnfs_spinlock);
73         local = find_pnfs_driver_locked(id);
74         if (local != NULL && !try_module_get(local->owner)) {
75                 dprintk("%s: Could not grab reference on module\n", __func__);
76                 local = NULL;
77         }
78         spin_unlock(&pnfs_spinlock);
79         return local;
80 }
81
82 void
83 unset_pnfs_layoutdriver(struct nfs_server *nfss)
84 {
85         if (nfss->pnfs_curr_ld) {
86                 if (nfss->pnfs_curr_ld->clear_layoutdriver)
87                         nfss->pnfs_curr_ld->clear_layoutdriver(nfss);
88                 /* Decrement the MDS count. Purge the deviceid cache if zero */
89                 if (atomic_dec_and_test(&nfss->nfs_client->cl_mds_count))
90                         nfs4_deviceid_purge_client(nfss->nfs_client);
91                 module_put(nfss->pnfs_curr_ld->owner);
92         }
93         nfss->pnfs_curr_ld = NULL;
94 }
95
96 /*
97  * Try to set the server's pnfs module to the pnfs layout type specified by id.
98  * Currently only one pNFS layout driver per filesystem is supported.
99  *
100  * @id layout type. Zero (illegal layout type) indicates pNFS not in use.
101  */
102 void
103 set_pnfs_layoutdriver(struct nfs_server *server, const struct nfs_fh *mntfh,
104                       u32 id)
105 {
106         struct pnfs_layoutdriver_type *ld_type = NULL;
107
108         if (id == 0)
109                 goto out_no_driver;
110         if (!(server->nfs_client->cl_exchange_flags &
111                  (EXCHGID4_FLAG_USE_NON_PNFS | EXCHGID4_FLAG_USE_PNFS_MDS))) {
112                 printk(KERN_ERR "NFS: %s: id %u cl_exchange_flags 0x%x\n",
113                         __func__, id, server->nfs_client->cl_exchange_flags);
114                 goto out_no_driver;
115         }
116         ld_type = find_pnfs_driver(id);
117         if (!ld_type) {
118                 request_module("%s-%u", LAYOUT_NFSV4_1_MODULE_PREFIX, id);
119                 ld_type = find_pnfs_driver(id);
120                 if (!ld_type) {
121                         dprintk("%s: No pNFS module found for %u.\n",
122                                 __func__, id);
123                         goto out_no_driver;
124                 }
125         }
126         server->pnfs_curr_ld = ld_type;
127         if (ld_type->set_layoutdriver
128             && ld_type->set_layoutdriver(server, mntfh)) {
129                 printk(KERN_ERR "NFS: %s: Error initializing pNFS layout "
130                         "driver %u.\n", __func__, id);
131                 module_put(ld_type->owner);
132                 goto out_no_driver;
133         }
134         /* Bump the MDS count */
135         atomic_inc(&server->nfs_client->cl_mds_count);
136
137         dprintk("%s: pNFS module for %u set\n", __func__, id);
138         return;
139
140 out_no_driver:
141         dprintk("%s: Using NFSv4 I/O\n", __func__);
142         server->pnfs_curr_ld = NULL;
143 }
144
145 int
146 pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
147 {
148         int status = -EINVAL;
149         struct pnfs_layoutdriver_type *tmp;
150
151         if (ld_type->id == 0) {
152                 printk(KERN_ERR "NFS: %s id 0 is reserved\n", __func__);
153                 return status;
154         }
155         if (!ld_type->alloc_lseg || !ld_type->free_lseg) {
156                 printk(KERN_ERR "NFS: %s Layout driver must provide "
157                        "alloc_lseg and free_lseg.\n", __func__);
158                 return status;
159         }
160
161         spin_lock(&pnfs_spinlock);
162         tmp = find_pnfs_driver_locked(ld_type->id);
163         if (!tmp) {
164                 list_add(&ld_type->pnfs_tblid, &pnfs_modules_tbl);
165                 status = 0;
166                 dprintk("%s Registering id:%u name:%s\n", __func__, ld_type->id,
167                         ld_type->name);
168         } else {
169                 printk(KERN_ERR "NFS: %s Module with id %d already loaded!\n",
170                         __func__, ld_type->id);
171         }
172         spin_unlock(&pnfs_spinlock);
173
174         return status;
175 }
176 EXPORT_SYMBOL_GPL(pnfs_register_layoutdriver);
177
178 void
179 pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
180 {
181         dprintk("%s Deregistering id:%u\n", __func__, ld_type->id);
182         spin_lock(&pnfs_spinlock);
183         list_del(&ld_type->pnfs_tblid);
184         spin_unlock(&pnfs_spinlock);
185 }
186 EXPORT_SYMBOL_GPL(pnfs_unregister_layoutdriver);
187
188 /*
189  * pNFS client layout cache
190  */
191
192 /* Need to hold i_lock if caller does not already hold reference */
193 void
194 pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo)
195 {
196         atomic_inc(&lo->plh_refcount);
197 }
198
199 static struct pnfs_layout_hdr *
200 pnfs_alloc_layout_hdr(struct inode *ino, gfp_t gfp_flags)
201 {
202         struct pnfs_layoutdriver_type *ld = NFS_SERVER(ino)->pnfs_curr_ld;
203         return ld->alloc_layout_hdr(ino, gfp_flags);
204 }
205
206 static void
207 pnfs_free_layout_hdr(struct pnfs_layout_hdr *lo)
208 {
209         struct nfs_server *server = NFS_SERVER(lo->plh_inode);
210         struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
211
212         if (!list_empty(&lo->plh_layouts)) {
213                 struct nfs_client *clp = server->nfs_client;
214
215                 spin_lock(&clp->cl_lock);
216                 list_del_init(&lo->plh_layouts);
217                 spin_unlock(&clp->cl_lock);
218         }
219         put_rpccred(lo->plh_lc_cred);
220         return ld->free_layout_hdr(lo);
221 }
222
223 static void
224 pnfs_detach_layout_hdr(struct pnfs_layout_hdr *lo)
225 {
226         struct nfs_inode *nfsi = NFS_I(lo->plh_inode);
227         dprintk("%s: freeing layout cache %p\n", __func__, lo);
228         nfsi->layout = NULL;
229         /* Reset MDS Threshold I/O counters */
230         nfsi->write_io = 0;
231         nfsi->read_io = 0;
232 }
233
234 void
235 pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo)
236 {
237         struct inode *inode = lo->plh_inode;
238
239         if (atomic_dec_and_lock(&lo->plh_refcount, &inode->i_lock)) {
240                 pnfs_detach_layout_hdr(lo);
241                 spin_unlock(&inode->i_lock);
242                 pnfs_free_layout_hdr(lo);
243         }
244 }
245
246 static int
247 pnfs_iomode_to_fail_bit(u32 iomode)
248 {
249         return iomode == IOMODE_RW ?
250                 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
251 }
252
253 static void
254 pnfs_layout_set_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
255 {
256         lo->plh_retry_timestamp = jiffies;
257         if (test_and_set_bit(fail_bit, &lo->plh_flags))
258                 atomic_inc(&lo->plh_refcount);
259 }
260
261 static void
262 pnfs_layout_clear_fail_bit(struct pnfs_layout_hdr *lo, int fail_bit)
263 {
264         if (test_and_clear_bit(fail_bit, &lo->plh_flags))
265                 atomic_dec(&lo->plh_refcount);
266 }
267
268 static void
269 pnfs_layout_io_set_failed(struct pnfs_layout_hdr *lo, u32 iomode)
270 {
271         struct inode *inode = lo->plh_inode;
272         struct pnfs_layout_range range = {
273                 .iomode = iomode,
274                 .offset = 0,
275                 .length = NFS4_MAX_UINT64,
276         };
277         LIST_HEAD(head);
278
279         spin_lock(&inode->i_lock);
280         pnfs_layout_set_fail_bit(lo, pnfs_iomode_to_fail_bit(iomode));
281         pnfs_mark_matching_lsegs_invalid(lo, &head, &range);
282         spin_unlock(&inode->i_lock);
283         pnfs_free_lseg_list(&head);
284         dprintk("%s Setting layout IOMODE_%s fail bit\n", __func__,
285                         iomode == IOMODE_RW ?  "RW" : "READ");
286 }
287
288 static bool
289 pnfs_layout_io_test_failed(struct pnfs_layout_hdr *lo, u32 iomode)
290 {
291         unsigned long start, end;
292         int fail_bit = pnfs_iomode_to_fail_bit(iomode);
293
294         if (test_bit(fail_bit, &lo->plh_flags) == 0)
295                 return false;
296         end = jiffies;
297         start = end - PNFS_LAYOUTGET_RETRY_TIMEOUT;
298         if (!time_in_range(lo->plh_retry_timestamp, start, end)) {
299                 /* It is time to retry the failed layoutgets */
300                 pnfs_layout_clear_fail_bit(lo, fail_bit);
301                 return false;
302         }
303         return true;
304 }
305
306 static void
307 init_lseg(struct pnfs_layout_hdr *lo, struct pnfs_layout_segment *lseg)
308 {
309         INIT_LIST_HEAD(&lseg->pls_list);
310         INIT_LIST_HEAD(&lseg->pls_lc_list);
311         atomic_set(&lseg->pls_refcount, 1);
312         smp_mb();
313         set_bit(NFS_LSEG_VALID, &lseg->pls_flags);
314         lseg->pls_layout = lo;
315 }
316
317 static void pnfs_free_lseg(struct pnfs_layout_segment *lseg)
318 {
319         struct inode *ino = lseg->pls_layout->plh_inode;
320
321         NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
322 }
323
324 static void
325 pnfs_layout_remove_lseg(struct pnfs_layout_hdr *lo,
326                 struct pnfs_layout_segment *lseg)
327 {
328         struct inode *inode = lo->plh_inode;
329
330         WARN_ON(test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
331         list_del_init(&lseg->pls_list);
332         /* Matched by pnfs_get_layout_hdr in pnfs_layout_insert_lseg */
333         atomic_dec(&lo->plh_refcount);
334         if (list_empty(&lo->plh_segs))
335                 clear_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
336         rpc_wake_up(&NFS_SERVER(inode)->roc_rpcwaitq);
337 }
338
339 void
340 pnfs_put_lseg(struct pnfs_layout_segment *lseg)
341 {
342         struct pnfs_layout_hdr *lo;
343         struct inode *inode;
344
345         if (!lseg)
346                 return;
347
348         dprintk("%s: lseg %p ref %d valid %d\n", __func__, lseg,
349                 atomic_read(&lseg->pls_refcount),
350                 test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
351         lo = lseg->pls_layout;
352         inode = lo->plh_inode;
353         if (atomic_dec_and_lock(&lseg->pls_refcount, &inode->i_lock)) {
354                 pnfs_get_layout_hdr(lo);
355                 pnfs_layout_remove_lseg(lo, lseg);
356                 spin_unlock(&inode->i_lock);
357                 pnfs_free_lseg(lseg);
358                 pnfs_put_layout_hdr(lo);
359         }
360 }
361 EXPORT_SYMBOL_GPL(pnfs_put_lseg);
362
363 static inline u64
364 end_offset(u64 start, u64 len)
365 {
366         u64 end;
367
368         end = start + len;
369         return end >= start ? end : NFS4_MAX_UINT64;
370 }
371
372 /* last octet in a range */
373 static inline u64
374 last_byte_offset(u64 start, u64 len)
375 {
376         u64 end;
377
378         BUG_ON(!len);
379         end = start + len;
380         return end > start ? end - 1 : NFS4_MAX_UINT64;
381 }
382
383 /*
384  * is l2 fully contained in l1?
385  *   start1                             end1
386  *   [----------------------------------)
387  *           start2           end2
388  *           [----------------)
389  */
390 static inline int
391 lo_seg_contained(struct pnfs_layout_range *l1,
392                  struct pnfs_layout_range *l2)
393 {
394         u64 start1 = l1->offset;
395         u64 end1 = end_offset(start1, l1->length);
396         u64 start2 = l2->offset;
397         u64 end2 = end_offset(start2, l2->length);
398
399         return (start1 <= start2) && (end1 >= end2);
400 }
401
402 /*
403  * is l1 and l2 intersecting?
404  *   start1                             end1
405  *   [----------------------------------)
406  *                              start2           end2
407  *                              [----------------)
408  */
409 static inline int
410 lo_seg_intersecting(struct pnfs_layout_range *l1,
411                     struct pnfs_layout_range *l2)
412 {
413         u64 start1 = l1->offset;
414         u64 end1 = end_offset(start1, l1->length);
415         u64 start2 = l2->offset;
416         u64 end2 = end_offset(start2, l2->length);
417
418         return (end1 == NFS4_MAX_UINT64 || end1 > start2) &&
419                (end2 == NFS4_MAX_UINT64 || end2 > start1);
420 }
421
422 static bool
423 should_free_lseg(struct pnfs_layout_range *lseg_range,
424                  struct pnfs_layout_range *recall_range)
425 {
426         return (recall_range->iomode == IOMODE_ANY ||
427                 lseg_range->iomode == recall_range->iomode) &&
428                lo_seg_intersecting(lseg_range, recall_range);
429 }
430
431 /* Returns 1 if lseg is removed from list, 0 otherwise */
432 static int mark_lseg_invalid(struct pnfs_layout_segment *lseg,
433                              struct list_head *tmp_list)
434 {
435         int rv = 0;
436
437         if (test_and_clear_bit(NFS_LSEG_VALID, &lseg->pls_flags)) {
438                 /* Remove the reference keeping the lseg in the
439                  * list.  It will now be removed when all
440                  * outstanding io is finished.
441                  */
442                 dprintk("%s: lseg %p ref %d\n", __func__, lseg,
443                         atomic_read(&lseg->pls_refcount));
444                 if (atomic_dec_and_test(&lseg->pls_refcount)) {
445                         pnfs_layout_remove_lseg(lseg->pls_layout, lseg);
446                         list_add(&lseg->pls_list, tmp_list);
447                         rv = 1;
448                 }
449         }
450         return rv;
451 }
452
453 /* Returns count of number of matching invalid lsegs remaining in list
454  * after call.
455  */
456 int
457 pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
458                             struct list_head *tmp_list,
459                             struct pnfs_layout_range *recall_range)
460 {
461         struct pnfs_layout_segment *lseg, *next;
462         int invalid = 0, removed = 0;
463
464         dprintk("%s:Begin lo %p\n", __func__, lo);
465
466         if (list_empty(&lo->plh_segs))
467                 return 0;
468         list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
469                 if (!recall_range ||
470                     should_free_lseg(&lseg->pls_range, recall_range)) {
471                         dprintk("%s: freeing lseg %p iomode %d "
472                                 "offset %llu length %llu\n", __func__,
473                                 lseg, lseg->pls_range.iomode, lseg->pls_range.offset,
474                                 lseg->pls_range.length);
475                         invalid++;
476                         removed += mark_lseg_invalid(lseg, tmp_list);
477                 }
478         dprintk("%s:Return %i\n", __func__, invalid - removed);
479         return invalid - removed;
480 }
481
482 /* note free_me must contain lsegs from a single layout_hdr */
483 void
484 pnfs_free_lseg_list(struct list_head *free_me)
485 {
486         struct pnfs_layout_segment *lseg, *tmp;
487
488         if (list_empty(free_me))
489                 return;
490
491         list_for_each_entry_safe(lseg, tmp, free_me, pls_list) {
492                 list_del(&lseg->pls_list);
493                 pnfs_free_lseg(lseg);
494         }
495 }
496
497 void
498 pnfs_destroy_layout(struct nfs_inode *nfsi)
499 {
500         struct pnfs_layout_hdr *lo;
501         LIST_HEAD(tmp_list);
502
503         spin_lock(&nfsi->vfs_inode.i_lock);
504         lo = nfsi->layout;
505         if (lo) {
506                 lo->plh_block_lgets++; /* permanently block new LAYOUTGETs */
507                 pnfs_mark_matching_lsegs_invalid(lo, &tmp_list, NULL);
508                 pnfs_get_layout_hdr(lo);
509                 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RO_FAILED);
510                 pnfs_layout_clear_fail_bit(lo, NFS_LAYOUT_RW_FAILED);
511                 spin_unlock(&nfsi->vfs_inode.i_lock);
512                 pnfs_free_lseg_list(&tmp_list);
513                 pnfs_put_layout_hdr(lo);
514         } else
515                 spin_unlock(&nfsi->vfs_inode.i_lock);
516 }
517 EXPORT_SYMBOL_GPL(pnfs_destroy_layout);
518
519 /*
520  * Called by the state manger to remove all layouts established under an
521  * expired lease.
522  */
523 void
524 pnfs_destroy_all_layouts(struct nfs_client *clp)
525 {
526         struct nfs_server *server;
527         struct pnfs_layout_hdr *lo;
528         LIST_HEAD(tmp_list);
529
530         nfs4_deviceid_mark_client_invalid(clp);
531         nfs4_deviceid_purge_client(clp);
532
533         spin_lock(&clp->cl_lock);
534         rcu_read_lock();
535         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
536                 if (!list_empty(&server->layouts))
537                         list_splice_init(&server->layouts, &tmp_list);
538         }
539         rcu_read_unlock();
540         spin_unlock(&clp->cl_lock);
541
542         while (!list_empty(&tmp_list)) {
543                 lo = list_entry(tmp_list.next, struct pnfs_layout_hdr,
544                                 plh_layouts);
545                 dprintk("%s freeing layout for inode %lu\n", __func__,
546                         lo->plh_inode->i_ino);
547                 list_del_init(&lo->plh_layouts);
548                 pnfs_destroy_layout(NFS_I(lo->plh_inode));
549         }
550 }
551
552 /* update lo->plh_stateid with new if is more recent */
553 void
554 pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, const nfs4_stateid *new,
555                         bool update_barrier)
556 {
557         u32 oldseq, newseq;
558
559         oldseq = be32_to_cpu(lo->plh_stateid.seqid);
560         newseq = be32_to_cpu(new->seqid);
561         if (list_empty(&lo->plh_segs) || (int)(newseq - oldseq) > 0) {
562                 nfs4_stateid_copy(&lo->plh_stateid, new);
563                 if (update_barrier) {
564                         u32 new_barrier = be32_to_cpu(new->seqid);
565
566                         if ((int)(new_barrier - lo->plh_barrier))
567                                 lo->plh_barrier = new_barrier;
568                 } else {
569                         /* Because of wraparound, we want to keep the barrier
570                          * "close" to the current seqids.  It needs to be
571                          * within 2**31 to count as "behind", so if it
572                          * gets too near that limit, give us a litle leeway
573                          * and bring it to within 2**30.
574                          * NOTE - and yes, this is all unsigned arithmetic.
575                          */
576                         if (unlikely((newseq - lo->plh_barrier) > (3 << 29)))
577                                 lo->plh_barrier = newseq - (1 << 30);
578                 }
579         }
580 }
581
582 /* lget is set to 1 if called from inside send_layoutget call chain */
583 static bool
584 pnfs_layoutgets_blocked(struct pnfs_layout_hdr *lo, nfs4_stateid *stateid,
585                         int lget)
586 {
587         if ((stateid) &&
588             (int)(lo->plh_barrier - be32_to_cpu(stateid->seqid)) >= 0)
589                 return true;
590         return lo->plh_block_lgets ||
591                 test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags) ||
592                 (list_empty(&lo->plh_segs) &&
593                  (atomic_read(&lo->plh_outstanding) > lget));
594 }
595
596 int
597 pnfs_choose_layoutget_stateid(nfs4_stateid *dst, struct pnfs_layout_hdr *lo,
598                               struct nfs4_state *open_state)
599 {
600         int status = 0;
601
602         dprintk("--> %s\n", __func__);
603         spin_lock(&lo->plh_inode->i_lock);
604         if (pnfs_layoutgets_blocked(lo, NULL, 1)) {
605                 status = -EAGAIN;
606         } else if (list_empty(&lo->plh_segs)) {
607                 int seq;
608
609                 do {
610                         seq = read_seqbegin(&open_state->seqlock);
611                         nfs4_stateid_copy(dst, &open_state->stateid);
612                 } while (read_seqretry(&open_state->seqlock, seq));
613         } else
614                 nfs4_stateid_copy(dst, &lo->plh_stateid);
615         spin_unlock(&lo->plh_inode->i_lock);
616         dprintk("<-- %s\n", __func__);
617         return status;
618 }
619
620 /*
621 * Get layout from server.
622 *    for now, assume that whole file layouts are requested.
623 *    arg->offset: 0
624 *    arg->length: all ones
625 */
626 static struct pnfs_layout_segment *
627 send_layoutget(struct pnfs_layout_hdr *lo,
628            struct nfs_open_context *ctx,
629            struct pnfs_layout_range *range,
630            gfp_t gfp_flags)
631 {
632         struct inode *ino = lo->plh_inode;
633         struct nfs_server *server = NFS_SERVER(ino);
634         struct nfs4_layoutget *lgp;
635         struct pnfs_layout_segment *lseg;
636
637         dprintk("--> %s\n", __func__);
638
639         BUG_ON(ctx == NULL);
640         lgp = kzalloc(sizeof(*lgp), gfp_flags);
641         if (lgp == NULL)
642                 return NULL;
643
644         lgp->args.minlength = PAGE_CACHE_SIZE;
645         if (lgp->args.minlength > range->length)
646                 lgp->args.minlength = range->length;
647         lgp->args.maxcount = PNFS_LAYOUT_MAXSIZE;
648         lgp->args.range = *range;
649         lgp->args.type = server->pnfs_curr_ld->id;
650         lgp->args.inode = ino;
651         lgp->args.ctx = get_nfs_open_context(ctx);
652         lgp->gfp_flags = gfp_flags;
653
654         /* Synchronously retrieve layout information from server and
655          * store in lseg.
656          */
657         lseg = nfs4_proc_layoutget(lgp, gfp_flags);
658         if (IS_ERR(lseg)) {
659                 switch (PTR_ERR(lseg)) {
660                 case -ENOMEM:
661                 case -ERESTARTSYS:
662                         break;
663                 default:
664                         /* remember that LAYOUTGET failed and suspend trying */
665                         pnfs_layout_io_set_failed(lo, range->iomode);
666                 }
667                 return NULL;
668         }
669
670         return lseg;
671 }
672
673 /*
674  * Initiates a LAYOUTRETURN(FILE), and removes the pnfs_layout_hdr
675  * when the layout segment list is empty.
676  *
677  * Note that a pnfs_layout_hdr can exist with an empty layout segment
678  * list when LAYOUTGET has failed, or when LAYOUTGET succeeded, but the
679  * deviceid is marked invalid.
680  */
681 int
682 _pnfs_return_layout(struct inode *ino)
683 {
684         struct pnfs_layout_hdr *lo = NULL;
685         struct nfs_inode *nfsi = NFS_I(ino);
686         LIST_HEAD(tmp_list);
687         struct nfs4_layoutreturn *lrp;
688         nfs4_stateid stateid;
689         int status = 0, empty;
690
691         dprintk("NFS: %s for inode %lu\n", __func__, ino->i_ino);
692
693         spin_lock(&ino->i_lock);
694         lo = nfsi->layout;
695         if (!lo) {
696                 spin_unlock(&ino->i_lock);
697                 dprintk("NFS: %s no layout to return\n", __func__);
698                 goto out;
699         }
700         stateid = nfsi->layout->plh_stateid;
701         /* Reference matched in nfs4_layoutreturn_release */
702         pnfs_get_layout_hdr(lo);
703         empty = list_empty(&lo->plh_segs);
704         pnfs_mark_matching_lsegs_invalid(lo, &tmp_list, NULL);
705         /* Don't send a LAYOUTRETURN if list was initially empty */
706         if (empty) {
707                 spin_unlock(&ino->i_lock);
708                 pnfs_put_layout_hdr(lo);
709                 dprintk("NFS: %s no layout segments to return\n", __func__);
710                 goto out;
711         }
712         lo->plh_block_lgets++;
713         spin_unlock(&ino->i_lock);
714         pnfs_free_lseg_list(&tmp_list);
715
716         WARN_ON(test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags));
717
718         lrp = kzalloc(sizeof(*lrp), GFP_KERNEL);
719         if (unlikely(lrp == NULL)) {
720                 status = -ENOMEM;
721                 spin_lock(&ino->i_lock);
722                 lo->plh_block_lgets--;
723                 spin_unlock(&ino->i_lock);
724                 pnfs_put_layout_hdr(lo);
725                 goto out;
726         }
727
728         lrp->args.stateid = stateid;
729         lrp->args.layout_type = NFS_SERVER(ino)->pnfs_curr_ld->id;
730         lrp->args.inode = ino;
731         lrp->args.layout = lo;
732         lrp->clp = NFS_SERVER(ino)->nfs_client;
733
734         status = nfs4_proc_layoutreturn(lrp);
735 out:
736         dprintk("<-- %s status: %d\n", __func__, status);
737         return status;
738 }
739 EXPORT_SYMBOL_GPL(_pnfs_return_layout);
740
741 bool pnfs_roc(struct inode *ino)
742 {
743         struct pnfs_layout_hdr *lo;
744         struct pnfs_layout_segment *lseg, *tmp;
745         LIST_HEAD(tmp_list);
746         bool found = false;
747
748         spin_lock(&ino->i_lock);
749         lo = NFS_I(ino)->layout;
750         if (!lo || !test_and_clear_bit(NFS_LAYOUT_ROC, &lo->plh_flags) ||
751             test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags))
752                 goto out_nolayout;
753         list_for_each_entry_safe(lseg, tmp, &lo->plh_segs, pls_list)
754                 if (test_bit(NFS_LSEG_ROC, &lseg->pls_flags)) {
755                         mark_lseg_invalid(lseg, &tmp_list);
756                         found = true;
757                 }
758         if (!found)
759                 goto out_nolayout;
760         lo->plh_block_lgets++;
761         pnfs_get_layout_hdr(lo); /* matched in pnfs_roc_release */
762         spin_unlock(&ino->i_lock);
763         pnfs_free_lseg_list(&tmp_list);
764         return true;
765
766 out_nolayout:
767         spin_unlock(&ino->i_lock);
768         return false;
769 }
770
771 void pnfs_roc_release(struct inode *ino)
772 {
773         struct pnfs_layout_hdr *lo;
774
775         spin_lock(&ino->i_lock);
776         lo = NFS_I(ino)->layout;
777         lo->plh_block_lgets--;
778         if (atomic_dec_and_test(&lo->plh_refcount)) {
779                 pnfs_detach_layout_hdr(lo);
780                 spin_unlock(&ino->i_lock);
781                 pnfs_free_layout_hdr(lo);
782         } else
783                 spin_unlock(&ino->i_lock);
784 }
785
786 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
787 {
788         struct pnfs_layout_hdr *lo;
789
790         spin_lock(&ino->i_lock);
791         lo = NFS_I(ino)->layout;
792         if ((int)(barrier - lo->plh_barrier) > 0)
793                 lo->plh_barrier = barrier;
794         spin_unlock(&ino->i_lock);
795 }
796
797 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
798 {
799         struct nfs_inode *nfsi = NFS_I(ino);
800         struct pnfs_layout_hdr *lo;
801         struct pnfs_layout_segment *lseg;
802         u32 current_seqid;
803         bool found = false;
804
805         spin_lock(&ino->i_lock);
806         list_for_each_entry(lseg, &nfsi->layout->plh_segs, pls_list)
807                 if (test_bit(NFS_LSEG_ROC, &lseg->pls_flags)) {
808                         rpc_sleep_on(&NFS_SERVER(ino)->roc_rpcwaitq, task, NULL);
809                         found = true;
810                         goto out;
811                 }
812         lo = nfsi->layout;
813         current_seqid = be32_to_cpu(lo->plh_stateid.seqid);
814
815         /* Since close does not return a layout stateid for use as
816          * a barrier, we choose the worst-case barrier.
817          */
818         *barrier = current_seqid + atomic_read(&lo->plh_outstanding);
819 out:
820         spin_unlock(&ino->i_lock);
821         return found;
822 }
823
824 /*
825  * Compare two layout segments for sorting into layout cache.
826  * We want to preferentially return RW over RO layouts, so ensure those
827  * are seen first.
828  */
829 static s64
830 cmp_layout(struct pnfs_layout_range *l1,
831            struct pnfs_layout_range *l2)
832 {
833         s64 d;
834
835         /* high offset > low offset */
836         d = l1->offset - l2->offset;
837         if (d)
838                 return d;
839
840         /* short length > long length */
841         d = l2->length - l1->length;
842         if (d)
843                 return d;
844
845         /* read > read/write */
846         return (int)(l1->iomode == IOMODE_READ) - (int)(l2->iomode == IOMODE_READ);
847 }
848
849 static void
850 pnfs_layout_insert_lseg(struct pnfs_layout_hdr *lo,
851                    struct pnfs_layout_segment *lseg)
852 {
853         struct pnfs_layout_segment *lp;
854
855         dprintk("%s:Begin\n", __func__);
856
857         list_for_each_entry(lp, &lo->plh_segs, pls_list) {
858                 if (cmp_layout(&lseg->pls_range, &lp->pls_range) > 0)
859                         continue;
860                 list_add_tail(&lseg->pls_list, &lp->pls_list);
861                 dprintk("%s: inserted lseg %p "
862                         "iomode %d offset %llu length %llu before "
863                         "lp %p iomode %d offset %llu length %llu\n",
864                         __func__, lseg, lseg->pls_range.iomode,
865                         lseg->pls_range.offset, lseg->pls_range.length,
866                         lp, lp->pls_range.iomode, lp->pls_range.offset,
867                         lp->pls_range.length);
868                 goto out;
869         }
870         list_add_tail(&lseg->pls_list, &lo->plh_segs);
871         dprintk("%s: inserted lseg %p "
872                 "iomode %d offset %llu length %llu at tail\n",
873                 __func__, lseg, lseg->pls_range.iomode,
874                 lseg->pls_range.offset, lseg->pls_range.length);
875 out:
876         pnfs_get_layout_hdr(lo);
877
878         dprintk("%s:Return\n", __func__);
879 }
880
881 static struct pnfs_layout_hdr *
882 alloc_init_layout_hdr(struct inode *ino,
883                       struct nfs_open_context *ctx,
884                       gfp_t gfp_flags)
885 {
886         struct pnfs_layout_hdr *lo;
887
888         lo = pnfs_alloc_layout_hdr(ino, gfp_flags);
889         if (!lo)
890                 return NULL;
891         atomic_set(&lo->plh_refcount, 1);
892         INIT_LIST_HEAD(&lo->plh_layouts);
893         INIT_LIST_HEAD(&lo->plh_segs);
894         INIT_LIST_HEAD(&lo->plh_bulk_recall);
895         lo->plh_inode = ino;
896         lo->plh_lc_cred = get_rpccred(ctx->state->owner->so_cred);
897         return lo;
898 }
899
900 static struct pnfs_layout_hdr *
901 pnfs_find_alloc_layout(struct inode *ino,
902                        struct nfs_open_context *ctx,
903                        gfp_t gfp_flags)
904 {
905         struct nfs_inode *nfsi = NFS_I(ino);
906         struct pnfs_layout_hdr *new = NULL;
907
908         dprintk("%s Begin ino=%p layout=%p\n", __func__, ino, nfsi->layout);
909
910         if (nfsi->layout != NULL)
911                 goto out_existing;
912         spin_unlock(&ino->i_lock);
913         new = alloc_init_layout_hdr(ino, ctx, gfp_flags);
914         spin_lock(&ino->i_lock);
915
916         if (likely(nfsi->layout == NULL)) {     /* Won the race? */
917                 nfsi->layout = new;
918                 return new;
919         }
920         pnfs_free_layout_hdr(new);
921 out_existing:
922         pnfs_get_layout_hdr(nfsi->layout);
923         return nfsi->layout;
924 }
925
926 /*
927  * iomode matching rules:
928  * iomode       lseg    match
929  * -----        -----   -----
930  * ANY          READ    true
931  * ANY          RW      true
932  * RW           READ    false
933  * RW           RW      true
934  * READ         READ    true
935  * READ         RW      true
936  */
937 static int
938 is_matching_lseg(struct pnfs_layout_range *ls_range,
939                  struct pnfs_layout_range *range)
940 {
941         struct pnfs_layout_range range1;
942
943         if ((range->iomode == IOMODE_RW &&
944              ls_range->iomode != IOMODE_RW) ||
945             !lo_seg_intersecting(ls_range, range))
946                 return 0;
947
948         /* range1 covers only the first byte in the range */
949         range1 = *range;
950         range1.length = 1;
951         return lo_seg_contained(ls_range, &range1);
952 }
953
954 /*
955  * lookup range in layout
956  */
957 static struct pnfs_layout_segment *
958 pnfs_find_lseg(struct pnfs_layout_hdr *lo,
959                 struct pnfs_layout_range *range)
960 {
961         struct pnfs_layout_segment *lseg, *ret = NULL;
962
963         dprintk("%s:Begin\n", __func__);
964
965         list_for_each_entry(lseg, &lo->plh_segs, pls_list) {
966                 if (test_bit(NFS_LSEG_VALID, &lseg->pls_flags) &&
967                     is_matching_lseg(&lseg->pls_range, range)) {
968                         ret = pnfs_get_lseg(lseg);
969                         break;
970                 }
971                 if (lseg->pls_range.offset > range->offset)
972                         break;
973         }
974
975         dprintk("%s:Return lseg %p ref %d\n",
976                 __func__, ret, ret ? atomic_read(&ret->pls_refcount) : 0);
977         return ret;
978 }
979
980 /*
981  * Use mdsthreshold hints set at each OPEN to determine if I/O should go
982  * to the MDS or over pNFS
983  *
984  * The nfs_inode read_io and write_io fields are cumulative counters reset
985  * when there are no layout segments. Note that in pnfs_update_layout iomode
986  * is set to IOMODE_READ for a READ request, and set to IOMODE_RW for a
987  * WRITE request.
988  *
989  * A return of true means use MDS I/O.
990  *
991  * From rfc 5661:
992  * If a file's size is smaller than the file size threshold, data accesses
993  * SHOULD be sent to the metadata server.  If an I/O request has a length that
994  * is below the I/O size threshold, the I/O SHOULD be sent to the metadata
995  * server.  If both file size and I/O size are provided, the client SHOULD
996  * reach or exceed  both thresholds before sending its read or write
997  * requests to the data server.
998  */
999 static bool pnfs_within_mdsthreshold(struct nfs_open_context *ctx,
1000                                      struct inode *ino, int iomode)
1001 {
1002         struct nfs4_threshold *t = ctx->mdsthreshold;
1003         struct nfs_inode *nfsi = NFS_I(ino);
1004         loff_t fsize = i_size_read(ino);
1005         bool size = false, size_set = false, io = false, io_set = false, ret = false;
1006
1007         if (t == NULL)
1008                 return ret;
1009
1010         dprintk("%s bm=0x%x rd_sz=%llu wr_sz=%llu rd_io=%llu wr_io=%llu\n",
1011                 __func__, t->bm, t->rd_sz, t->wr_sz, t->rd_io_sz, t->wr_io_sz);
1012
1013         switch (iomode) {
1014         case IOMODE_READ:
1015                 if (t->bm & THRESHOLD_RD) {
1016                         dprintk("%s fsize %llu\n", __func__, fsize);
1017                         size_set = true;
1018                         if (fsize < t->rd_sz)
1019                                 size = true;
1020                 }
1021                 if (t->bm & THRESHOLD_RD_IO) {
1022                         dprintk("%s nfsi->read_io %llu\n", __func__,
1023                                 nfsi->read_io);
1024                         io_set = true;
1025                         if (nfsi->read_io < t->rd_io_sz)
1026                                 io = true;
1027                 }
1028                 break;
1029         case IOMODE_RW:
1030                 if (t->bm & THRESHOLD_WR) {
1031                         dprintk("%s fsize %llu\n", __func__, fsize);
1032                         size_set = true;
1033                         if (fsize < t->wr_sz)
1034                                 size = true;
1035                 }
1036                 if (t->bm & THRESHOLD_WR_IO) {
1037                         dprintk("%s nfsi->write_io %llu\n", __func__,
1038                                 nfsi->write_io);
1039                         io_set = true;
1040                         if (nfsi->write_io < t->wr_io_sz)
1041                                 io = true;
1042                 }
1043                 break;
1044         }
1045         if (size_set && io_set) {
1046                 if (size && io)
1047                         ret = true;
1048         } else if (size || io)
1049                 ret = true;
1050
1051         dprintk("<-- %s size %d io %d ret %d\n", __func__, size, io, ret);
1052         return ret;
1053 }
1054
1055 /*
1056  * Layout segment is retreived from the server if not cached.
1057  * The appropriate layout segment is referenced and returned to the caller.
1058  */
1059 struct pnfs_layout_segment *
1060 pnfs_update_layout(struct inode *ino,
1061                    struct nfs_open_context *ctx,
1062                    loff_t pos,
1063                    u64 count,
1064                    enum pnfs_iomode iomode,
1065                    gfp_t gfp_flags)
1066 {
1067         struct pnfs_layout_range arg = {
1068                 .iomode = iomode,
1069                 .offset = pos,
1070                 .length = count,
1071         };
1072         unsigned pg_offset;
1073         struct nfs_server *server = NFS_SERVER(ino);
1074         struct nfs_client *clp = server->nfs_client;
1075         struct pnfs_layout_hdr *lo;
1076         struct pnfs_layout_segment *lseg = NULL;
1077         bool first = false;
1078
1079         if (!pnfs_enabled_sb(NFS_SERVER(ino)))
1080                 goto out;
1081
1082         if (pnfs_within_mdsthreshold(ctx, ino, iomode))
1083                 goto out;
1084
1085         spin_lock(&ino->i_lock);
1086         lo = pnfs_find_alloc_layout(ino, ctx, gfp_flags);
1087         if (lo == NULL) {
1088                 spin_unlock(&ino->i_lock);
1089                 goto out;
1090         }
1091
1092         /* Do we even need to bother with this? */
1093         if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
1094                 dprintk("%s matches recall, use MDS\n", __func__);
1095                 goto out_unlock;
1096         }
1097
1098         /* if LAYOUTGET already failed once we don't try again */
1099         if (pnfs_layout_io_test_failed(lo, iomode))
1100                 goto out_unlock;
1101
1102         /* Check to see if the layout for the given range already exists */
1103         lseg = pnfs_find_lseg(lo, &arg);
1104         if (lseg)
1105                 goto out_unlock;
1106
1107         if (pnfs_layoutgets_blocked(lo, NULL, 0))
1108                 goto out_unlock;
1109         atomic_inc(&lo->plh_outstanding);
1110
1111         if (list_empty(&lo->plh_segs))
1112                 first = true;
1113
1114         spin_unlock(&ino->i_lock);
1115         if (first) {
1116                 /* The lo must be on the clp list if there is any
1117                  * chance of a CB_LAYOUTRECALL(FILE) coming in.
1118                  */
1119                 spin_lock(&clp->cl_lock);
1120                 BUG_ON(!list_empty(&lo->plh_layouts));
1121                 list_add_tail(&lo->plh_layouts, &server->layouts);
1122                 spin_unlock(&clp->cl_lock);
1123         }
1124
1125         pg_offset = arg.offset & ~PAGE_CACHE_MASK;
1126         if (pg_offset) {
1127                 arg.offset -= pg_offset;
1128                 arg.length += pg_offset;
1129         }
1130         if (arg.length != NFS4_MAX_UINT64)
1131                 arg.length = PAGE_CACHE_ALIGN(arg.length);
1132
1133         lseg = send_layoutget(lo, ctx, &arg, gfp_flags);
1134         atomic_dec(&lo->plh_outstanding);
1135 out_put_layout_hdr:
1136         pnfs_put_layout_hdr(lo);
1137 out:
1138         dprintk("%s: inode %s/%llu pNFS layout segment %s for "
1139                         "(%s, offset: %llu, length: %llu)\n",
1140                         __func__, ino->i_sb->s_id,
1141                         (unsigned long long)NFS_FILEID(ino),
1142                         lseg == NULL ? "not found" : "found",
1143                         iomode==IOMODE_RW ?  "read/write" : "read-only",
1144                         (unsigned long long)pos,
1145                         (unsigned long long)count);
1146         return lseg;
1147 out_unlock:
1148         spin_unlock(&ino->i_lock);
1149         goto out_put_layout_hdr;
1150 }
1151 EXPORT_SYMBOL_GPL(pnfs_update_layout);
1152
1153 struct pnfs_layout_segment *
1154 pnfs_layout_process(struct nfs4_layoutget *lgp)
1155 {
1156         struct pnfs_layout_hdr *lo = NFS_I(lgp->args.inode)->layout;
1157         struct nfs4_layoutget_res *res = &lgp->res;
1158         struct pnfs_layout_segment *lseg;
1159         struct inode *ino = lo->plh_inode;
1160         int status = 0;
1161
1162         /* Inject layout blob into I/O device driver */
1163         lseg = NFS_SERVER(ino)->pnfs_curr_ld->alloc_lseg(lo, res, lgp->gfp_flags);
1164         if (!lseg || IS_ERR(lseg)) {
1165                 if (!lseg)
1166                         status = -ENOMEM;
1167                 else
1168                         status = PTR_ERR(lseg);
1169                 dprintk("%s: Could not allocate layout: error %d\n",
1170                        __func__, status);
1171                 goto out;
1172         }
1173
1174         spin_lock(&ino->i_lock);
1175         if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
1176                 dprintk("%s forget reply due to recall\n", __func__);
1177                 goto out_forget_reply;
1178         }
1179
1180         if (pnfs_layoutgets_blocked(lo, &res->stateid, 1)) {
1181                 dprintk("%s forget reply due to state\n", __func__);
1182                 goto out_forget_reply;
1183         }
1184
1185         /* Done processing layoutget. Set the layout stateid */
1186         pnfs_set_layout_stateid(lo, &res->stateid, false);
1187
1188         init_lseg(lo, lseg);
1189         lseg->pls_range = res->range;
1190         pnfs_get_lseg(lseg);
1191         pnfs_layout_insert_lseg(lo, lseg);
1192
1193         if (res->return_on_close) {
1194                 set_bit(NFS_LSEG_ROC, &lseg->pls_flags);
1195                 set_bit(NFS_LAYOUT_ROC, &lo->plh_flags);
1196         }
1197
1198         spin_unlock(&ino->i_lock);
1199         return lseg;
1200 out:
1201         return ERR_PTR(status);
1202
1203 out_forget_reply:
1204         spin_unlock(&ino->i_lock);
1205         lseg->pls_layout = lo;
1206         NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
1207         goto out;
1208 }
1209
1210 void
1211 pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
1212 {
1213         BUG_ON(pgio->pg_lseg != NULL);
1214
1215         if (req->wb_offset != req->wb_pgbase) {
1216                 nfs_pageio_reset_read_mds(pgio);
1217                 return;
1218         }
1219         pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
1220                                            req->wb_context,
1221                                            req_offset(req),
1222                                            req->wb_bytes,
1223                                            IOMODE_READ,
1224                                            GFP_KERNEL);
1225         /* If no lseg, fall back to read through mds */
1226         if (pgio->pg_lseg == NULL)
1227                 nfs_pageio_reset_read_mds(pgio);
1228
1229 }
1230 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_read);
1231
1232 void
1233 pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
1234 {
1235         BUG_ON(pgio->pg_lseg != NULL);
1236
1237         if (req->wb_offset != req->wb_pgbase) {
1238                 nfs_pageio_reset_write_mds(pgio);
1239                 return;
1240         }
1241         pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
1242                                            req->wb_context,
1243                                            req_offset(req),
1244                                            req->wb_bytes,
1245                                            IOMODE_RW,
1246                                            GFP_NOFS);
1247         /* If no lseg, fall back to write through mds */
1248         if (pgio->pg_lseg == NULL)
1249                 nfs_pageio_reset_write_mds(pgio);
1250 }
1251 EXPORT_SYMBOL_GPL(pnfs_generic_pg_init_write);
1252
1253 void
1254 pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
1255                       const struct nfs_pgio_completion_ops *compl_ops)
1256 {
1257         struct nfs_server *server = NFS_SERVER(inode);
1258         struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
1259
1260         if (ld == NULL)
1261                 nfs_pageio_init_read(pgio, inode, compl_ops);
1262         else
1263                 nfs_pageio_init(pgio, inode, ld->pg_read_ops, compl_ops, server->rsize, 0);
1264 }
1265
1266 void
1267 pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode,
1268                        int ioflags,
1269                        const struct nfs_pgio_completion_ops *compl_ops)
1270 {
1271         struct nfs_server *server = NFS_SERVER(inode);
1272         struct pnfs_layoutdriver_type *ld = server->pnfs_curr_ld;
1273
1274         if (ld == NULL)
1275                 nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
1276         else
1277                 nfs_pageio_init(pgio, inode, ld->pg_write_ops, compl_ops, server->wsize, ioflags);
1278 }
1279
1280 bool
1281 pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev,
1282                      struct nfs_page *req)
1283 {
1284         if (pgio->pg_lseg == NULL)
1285                 return nfs_generic_pg_test(pgio, prev, req);
1286
1287         /*
1288          * Test if a nfs_page is fully contained in the pnfs_layout_range.
1289          * Note that this test makes several assumptions:
1290          * - that the previous nfs_page in the struct nfs_pageio_descriptor
1291          *   is known to lie within the range.
1292          *   - that the nfs_page being tested is known to be contiguous with the
1293          *   previous nfs_page.
1294          *   - Layout ranges are page aligned, so we only have to test the
1295          *   start offset of the request.
1296          *
1297          * Please also note that 'end_offset' is actually the offset of the
1298          * first byte that lies outside the pnfs_layout_range. FIXME?
1299          *
1300          */
1301         return req_offset(req) < end_offset(pgio->pg_lseg->pls_range.offset,
1302                                          pgio->pg_lseg->pls_range.length);
1303 }
1304 EXPORT_SYMBOL_GPL(pnfs_generic_pg_test);
1305
1306 int pnfs_write_done_resend_to_mds(struct inode *inode,
1307                                 struct list_head *head,
1308                                 const struct nfs_pgio_completion_ops *compl_ops)
1309 {
1310         struct nfs_pageio_descriptor pgio;
1311         LIST_HEAD(failed);
1312
1313         /* Resend all requests through the MDS */
1314         nfs_pageio_init_write(&pgio, inode, FLUSH_STABLE, compl_ops);
1315         while (!list_empty(head)) {
1316                 struct nfs_page *req = nfs_list_entry(head->next);
1317
1318                 nfs_list_remove_request(req);
1319                 if (!nfs_pageio_add_request(&pgio, req))
1320                         nfs_list_add_request(req, &failed);
1321         }
1322         nfs_pageio_complete(&pgio);
1323
1324         if (!list_empty(&failed)) {
1325                 /* For some reason our attempt to resend pages. Mark the
1326                  * overall send request as having failed, and let
1327                  * nfs_writeback_release_full deal with the error.
1328                  */
1329                 list_move(&failed, head);
1330                 return -EIO;
1331         }
1332         return 0;
1333 }
1334 EXPORT_SYMBOL_GPL(pnfs_write_done_resend_to_mds);
1335
1336 static void pnfs_ld_handle_write_error(struct nfs_write_data *data)
1337 {
1338         struct nfs_pgio_header *hdr = data->header;
1339
1340         dprintk("pnfs write error = %d\n", hdr->pnfs_error);
1341         if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
1342             PNFS_LAYOUTRET_ON_ERROR) {
1343                 clear_bit(NFS_INO_LAYOUTCOMMIT, &NFS_I(hdr->inode)->flags);
1344                 pnfs_return_layout(hdr->inode);
1345         }
1346         if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
1347                 data->task.tk_status = pnfs_write_done_resend_to_mds(hdr->inode,
1348                                                         &hdr->pages,
1349                                                         hdr->completion_ops);
1350 }
1351
1352 /*
1353  * Called by non rpc-based layout drivers
1354  */
1355 void pnfs_ld_write_done(struct nfs_write_data *data)
1356 {
1357         struct nfs_pgio_header *hdr = data->header;
1358
1359         if (!hdr->pnfs_error) {
1360                 pnfs_set_layoutcommit(data);
1361                 hdr->mds_ops->rpc_call_done(&data->task, data);
1362         } else
1363                 pnfs_ld_handle_write_error(data);
1364         hdr->mds_ops->rpc_release(data);
1365 }
1366 EXPORT_SYMBOL_GPL(pnfs_ld_write_done);
1367
1368 static void
1369 pnfs_write_through_mds(struct nfs_pageio_descriptor *desc,
1370                 struct nfs_write_data *data)
1371 {
1372         struct nfs_pgio_header *hdr = data->header;
1373
1374         if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
1375                 list_splice_tail_init(&hdr->pages, &desc->pg_list);
1376                 nfs_pageio_reset_write_mds(desc);
1377                 desc->pg_recoalesce = 1;
1378         }
1379         nfs_writedata_release(data);
1380 }
1381
1382 static enum pnfs_try_status
1383 pnfs_try_to_write_data(struct nfs_write_data *wdata,
1384                         const struct rpc_call_ops *call_ops,
1385                         struct pnfs_layout_segment *lseg,
1386                         int how)
1387 {
1388         struct nfs_pgio_header *hdr = wdata->header;
1389         struct inode *inode = hdr->inode;
1390         enum pnfs_try_status trypnfs;
1391         struct nfs_server *nfss = NFS_SERVER(inode);
1392
1393         hdr->mds_ops = call_ops;
1394
1395         dprintk("%s: Writing ino:%lu %u@%llu (how %d)\n", __func__,
1396                 inode->i_ino, wdata->args.count, wdata->args.offset, how);
1397         trypnfs = nfss->pnfs_curr_ld->write_pagelist(wdata, how);
1398         if (trypnfs != PNFS_NOT_ATTEMPTED)
1399                 nfs_inc_stats(inode, NFSIOS_PNFS_WRITE);
1400         dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
1401         return trypnfs;
1402 }
1403
1404 static void
1405 pnfs_do_multiple_writes(struct nfs_pageio_descriptor *desc, struct list_head *head, int how)
1406 {
1407         struct nfs_write_data *data;
1408         const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
1409         struct pnfs_layout_segment *lseg = desc->pg_lseg;
1410
1411         desc->pg_lseg = NULL;
1412         while (!list_empty(head)) {
1413                 enum pnfs_try_status trypnfs;
1414
1415                 data = list_first_entry(head, struct nfs_write_data, list);
1416                 list_del_init(&data->list);
1417
1418                 trypnfs = pnfs_try_to_write_data(data, call_ops, lseg, how);
1419                 if (trypnfs == PNFS_NOT_ATTEMPTED)
1420                         pnfs_write_through_mds(desc, data);
1421         }
1422         pnfs_put_lseg(lseg);
1423 }
1424
1425 static void pnfs_writehdr_free(struct nfs_pgio_header *hdr)
1426 {
1427         pnfs_put_lseg(hdr->lseg);
1428         nfs_writehdr_free(hdr);
1429 }
1430 EXPORT_SYMBOL_GPL(pnfs_writehdr_free);
1431
1432 int
1433 pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc)
1434 {
1435         struct nfs_write_header *whdr;
1436         struct nfs_pgio_header *hdr;
1437         int ret;
1438
1439         whdr = nfs_writehdr_alloc();
1440         if (!whdr) {
1441                 desc->pg_completion_ops->error_cleanup(&desc->pg_list);
1442                 pnfs_put_lseg(desc->pg_lseg);
1443                 desc->pg_lseg = NULL;
1444                 return -ENOMEM;
1445         }
1446         hdr = &whdr->header;
1447         nfs_pgheader_init(desc, hdr, pnfs_writehdr_free);
1448         hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
1449         atomic_inc(&hdr->refcnt);
1450         ret = nfs_generic_flush(desc, hdr);
1451         if (ret != 0) {
1452                 pnfs_put_lseg(desc->pg_lseg);
1453                 desc->pg_lseg = NULL;
1454         } else
1455                 pnfs_do_multiple_writes(desc, &hdr->rpc_list, desc->pg_ioflags);
1456         if (atomic_dec_and_test(&hdr->refcnt))
1457                 hdr->completion_ops->completion(hdr);
1458         return ret;
1459 }
1460 EXPORT_SYMBOL_GPL(pnfs_generic_pg_writepages);
1461
1462 int pnfs_read_done_resend_to_mds(struct inode *inode,
1463                                 struct list_head *head,
1464                                 const struct nfs_pgio_completion_ops *compl_ops)
1465 {
1466         struct nfs_pageio_descriptor pgio;
1467         LIST_HEAD(failed);
1468
1469         /* Resend all requests through the MDS */
1470         nfs_pageio_init_read(&pgio, inode, compl_ops);
1471         while (!list_empty(head)) {
1472                 struct nfs_page *req = nfs_list_entry(head->next);
1473
1474                 nfs_list_remove_request(req);
1475                 if (!nfs_pageio_add_request(&pgio, req))
1476                         nfs_list_add_request(req, &failed);
1477         }
1478         nfs_pageio_complete(&pgio);
1479
1480         if (!list_empty(&failed)) {
1481                 list_move(&failed, head);
1482                 return -EIO;
1483         }
1484         return 0;
1485 }
1486 EXPORT_SYMBOL_GPL(pnfs_read_done_resend_to_mds);
1487
1488 static void pnfs_ld_handle_read_error(struct nfs_read_data *data)
1489 {
1490         struct nfs_pgio_header *hdr = data->header;
1491
1492         dprintk("pnfs read error = %d\n", hdr->pnfs_error);
1493         if (NFS_SERVER(hdr->inode)->pnfs_curr_ld->flags &
1494             PNFS_LAYOUTRET_ON_ERROR) {
1495                 clear_bit(NFS_INO_LAYOUTCOMMIT, &NFS_I(hdr->inode)->flags);
1496                 pnfs_return_layout(hdr->inode);
1497         }
1498         if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags))
1499                 data->task.tk_status = pnfs_read_done_resend_to_mds(hdr->inode,
1500                                                         &hdr->pages,
1501                                                         hdr->completion_ops);
1502 }
1503
1504 /*
1505  * Called by non rpc-based layout drivers
1506  */
1507 void pnfs_ld_read_done(struct nfs_read_data *data)
1508 {
1509         struct nfs_pgio_header *hdr = data->header;
1510
1511         if (likely(!hdr->pnfs_error)) {
1512                 __nfs4_read_done_cb(data);
1513                 hdr->mds_ops->rpc_call_done(&data->task, data);
1514         } else
1515                 pnfs_ld_handle_read_error(data);
1516         hdr->mds_ops->rpc_release(data);
1517 }
1518 EXPORT_SYMBOL_GPL(pnfs_ld_read_done);
1519
1520 static void
1521 pnfs_read_through_mds(struct nfs_pageio_descriptor *desc,
1522                 struct nfs_read_data *data)
1523 {
1524         struct nfs_pgio_header *hdr = data->header;
1525
1526         if (!test_and_set_bit(NFS_IOHDR_REDO, &hdr->flags)) {
1527                 list_splice_tail_init(&hdr->pages, &desc->pg_list);
1528                 nfs_pageio_reset_read_mds(desc);
1529                 desc->pg_recoalesce = 1;
1530         }
1531         nfs_readdata_release(data);
1532 }
1533
1534 /*
1535  * Call the appropriate parallel I/O subsystem read function.
1536  */
1537 static enum pnfs_try_status
1538 pnfs_try_to_read_data(struct nfs_read_data *rdata,
1539                        const struct rpc_call_ops *call_ops,
1540                        struct pnfs_layout_segment *lseg)
1541 {
1542         struct nfs_pgio_header *hdr = rdata->header;
1543         struct inode *inode = hdr->inode;
1544         struct nfs_server *nfss = NFS_SERVER(inode);
1545         enum pnfs_try_status trypnfs;
1546
1547         hdr->mds_ops = call_ops;
1548
1549         dprintk("%s: Reading ino:%lu %u@%llu\n",
1550                 __func__, inode->i_ino, rdata->args.count, rdata->args.offset);
1551
1552         trypnfs = nfss->pnfs_curr_ld->read_pagelist(rdata);
1553         if (trypnfs != PNFS_NOT_ATTEMPTED)
1554                 nfs_inc_stats(inode, NFSIOS_PNFS_READ);
1555         dprintk("%s End (trypnfs:%d)\n", __func__, trypnfs);
1556         return trypnfs;
1557 }
1558
1559 static void
1560 pnfs_do_multiple_reads(struct nfs_pageio_descriptor *desc, struct list_head *head)
1561 {
1562         struct nfs_read_data *data;
1563         const struct rpc_call_ops *call_ops = desc->pg_rpc_callops;
1564         struct pnfs_layout_segment *lseg = desc->pg_lseg;
1565
1566         desc->pg_lseg = NULL;
1567         while (!list_empty(head)) {
1568                 enum pnfs_try_status trypnfs;
1569
1570                 data = list_first_entry(head, struct nfs_read_data, list);
1571                 list_del_init(&data->list);
1572
1573                 trypnfs = pnfs_try_to_read_data(data, call_ops, lseg);
1574                 if (trypnfs == PNFS_NOT_ATTEMPTED)
1575                         pnfs_read_through_mds(desc, data);
1576         }
1577         pnfs_put_lseg(lseg);
1578 }
1579
1580 static void pnfs_readhdr_free(struct nfs_pgio_header *hdr)
1581 {
1582         pnfs_put_lseg(hdr->lseg);
1583         nfs_readhdr_free(hdr);
1584 }
1585 EXPORT_SYMBOL_GPL(pnfs_readhdr_free);
1586
1587 int
1588 pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc)
1589 {
1590         struct nfs_read_header *rhdr;
1591         struct nfs_pgio_header *hdr;
1592         int ret;
1593
1594         rhdr = nfs_readhdr_alloc();
1595         if (!rhdr) {
1596                 desc->pg_completion_ops->error_cleanup(&desc->pg_list);
1597                 ret = -ENOMEM;
1598                 pnfs_put_lseg(desc->pg_lseg);
1599                 desc->pg_lseg = NULL;
1600                 return ret;
1601         }
1602         hdr = &rhdr->header;
1603         nfs_pgheader_init(desc, hdr, pnfs_readhdr_free);
1604         hdr->lseg = pnfs_get_lseg(desc->pg_lseg);
1605         atomic_inc(&hdr->refcnt);
1606         ret = nfs_generic_pagein(desc, hdr);
1607         if (ret != 0) {
1608                 pnfs_put_lseg(desc->pg_lseg);
1609                 desc->pg_lseg = NULL;
1610         } else
1611                 pnfs_do_multiple_reads(desc, &hdr->rpc_list);
1612         if (atomic_dec_and_test(&hdr->refcnt))
1613                 hdr->completion_ops->completion(hdr);
1614         return ret;
1615 }
1616 EXPORT_SYMBOL_GPL(pnfs_generic_pg_readpages);
1617
1618 /*
1619  * There can be multiple RW segments.
1620  */
1621 static void pnfs_list_write_lseg(struct inode *inode, struct list_head *listp)
1622 {
1623         struct pnfs_layout_segment *lseg;
1624
1625         list_for_each_entry(lseg, &NFS_I(inode)->layout->plh_segs, pls_list) {
1626                 if (lseg->pls_range.iomode == IOMODE_RW &&
1627                     test_bit(NFS_LSEG_LAYOUTCOMMIT, &lseg->pls_flags))
1628                         list_add(&lseg->pls_lc_list, listp);
1629         }
1630 }
1631
1632 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg)
1633 {
1634         pnfs_layout_io_set_failed(lseg->pls_layout, lseg->pls_range.iomode);
1635 }
1636 EXPORT_SYMBOL_GPL(pnfs_set_lo_fail);
1637
1638 void
1639 pnfs_set_layoutcommit(struct nfs_write_data *wdata)
1640 {
1641         struct nfs_pgio_header *hdr = wdata->header;
1642         struct inode *inode = hdr->inode;
1643         struct nfs_inode *nfsi = NFS_I(inode);
1644         loff_t end_pos = wdata->mds_offset + wdata->res.count;
1645         bool mark_as_dirty = false;
1646
1647         spin_lock(&inode->i_lock);
1648         if (!test_and_set_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags)) {
1649                 mark_as_dirty = true;
1650                 dprintk("%s: Set layoutcommit for inode %lu ",
1651                         __func__, inode->i_ino);
1652         }
1653         if (!test_and_set_bit(NFS_LSEG_LAYOUTCOMMIT, &hdr->lseg->pls_flags)) {
1654                 /* references matched in nfs4_layoutcommit_release */
1655                 pnfs_get_lseg(hdr->lseg);
1656         }
1657         if (end_pos > nfsi->layout->plh_lwb)
1658                 nfsi->layout->plh_lwb = end_pos;
1659         spin_unlock(&inode->i_lock);
1660         dprintk("%s: lseg %p end_pos %llu\n",
1661                 __func__, hdr->lseg, nfsi->layout->plh_lwb);
1662
1663         /* if pnfs_layoutcommit_inode() runs between inode locks, the next one
1664          * will be a noop because NFS_INO_LAYOUTCOMMIT will not be set */
1665         if (mark_as_dirty)
1666                 mark_inode_dirty_sync(inode);
1667 }
1668 EXPORT_SYMBOL_GPL(pnfs_set_layoutcommit);
1669
1670 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data)
1671 {
1672         struct nfs_server *nfss = NFS_SERVER(data->args.inode);
1673
1674         if (nfss->pnfs_curr_ld->cleanup_layoutcommit)
1675                 nfss->pnfs_curr_ld->cleanup_layoutcommit(data);
1676 }
1677
1678 /*
1679  * For the LAYOUT4_NFSV4_1_FILES layout type, NFS_DATA_SYNC WRITEs and
1680  * NFS_UNSTABLE WRITEs with a COMMIT to data servers must store enough
1681  * data to disk to allow the server to recover the data if it crashes.
1682  * LAYOUTCOMMIT is only needed when the NFL4_UFLG_COMMIT_THRU_MDS flag
1683  * is off, and a COMMIT is sent to a data server, or
1684  * if WRITEs to a data server return NFS_DATA_SYNC.
1685  */
1686 int
1687 pnfs_layoutcommit_inode(struct inode *inode, bool sync)
1688 {
1689         struct nfs4_layoutcommit_data *data;
1690         struct nfs_inode *nfsi = NFS_I(inode);
1691         loff_t end_pos;
1692         int status = 0;
1693
1694         dprintk("--> %s inode %lu\n", __func__, inode->i_ino);
1695
1696         if (!test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
1697                 return 0;
1698
1699         /* Note kzalloc ensures data->res.seq_res.sr_slot == NULL */
1700         data = kzalloc(sizeof(*data), GFP_NOFS);
1701         if (!data) {
1702                 status = -ENOMEM;
1703                 goto out;
1704         }
1705
1706         if (!test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags))
1707                 goto out_free;
1708
1709         if (test_and_set_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags)) {
1710                 if (!sync) {
1711                         status = -EAGAIN;
1712                         goto out_free;
1713                 }
1714                 status = wait_on_bit_lock(&nfsi->flags, NFS_INO_LAYOUTCOMMITTING,
1715                                         nfs_wait_bit_killable, TASK_KILLABLE);
1716                 if (status)
1717                         goto out_free;
1718         }
1719
1720         INIT_LIST_HEAD(&data->lseg_list);
1721         spin_lock(&inode->i_lock);
1722         if (!test_and_clear_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags)) {
1723                 clear_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags);
1724                 spin_unlock(&inode->i_lock);
1725                 wake_up_bit(&nfsi->flags, NFS_INO_LAYOUTCOMMITTING);
1726                 goto out_free;
1727         }
1728
1729         pnfs_list_write_lseg(inode, &data->lseg_list);
1730
1731         end_pos = nfsi->layout->plh_lwb;
1732         nfsi->layout->plh_lwb = 0;
1733
1734         nfs4_stateid_copy(&data->args.stateid, &nfsi->layout->plh_stateid);
1735         spin_unlock(&inode->i_lock);
1736
1737         data->args.inode = inode;
1738         data->cred = get_rpccred(nfsi->layout->plh_lc_cred);
1739         nfs_fattr_init(&data->fattr);
1740         data->args.bitmask = NFS_SERVER(inode)->cache_consistency_bitmask;
1741         data->res.fattr = &data->fattr;
1742         data->args.lastbytewritten = end_pos - 1;
1743         data->res.server = NFS_SERVER(inode);
1744
1745         status = nfs4_proc_layoutcommit(data, sync);
1746 out:
1747         if (status)
1748                 mark_inode_dirty_sync(inode);
1749         dprintk("<-- %s status %d\n", __func__, status);
1750         return status;
1751 out_free:
1752         kfree(data);
1753         goto out;
1754 }
1755
1756 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
1757 {
1758         struct nfs4_threshold *thp;
1759
1760         thp = kzalloc(sizeof(*thp), GFP_NOFS);
1761         if (!thp) {
1762                 dprintk("%s mdsthreshold allocation failed\n", __func__);
1763                 return NULL;
1764         }
1765         return thp;
1766 }