2 * Module for the pnfs nfs4 file layout driver.
3 * Defines all I/O and Policy interface operations, plus code
4 * to register itself with the pNFS client.
7 * The Regents of the University of Michigan
10 * Dean Hildebrand <dhildebz@umich.edu>
12 * Permission is granted to use, copy, create derivative works, and
13 * redistribute this software and such derivative works for any purpose,
14 * so long as the name of the University of Michigan is not used in
15 * any advertising or publicity pertaining to the use or distribution
16 * of this software without specific, written prior authorization. If
17 * the above copyright notice or any other identification of the
18 * University of Michigan is included in any copy of any portion of
19 * this software, then the disclaimer below must also be included.
21 * This software is provided as is, without representation or warranty
22 * of any kind either express or implied, including without limitation
23 * the implied warranties of merchantability, fitness for a particular
24 * purpose, or noninfringement. The Regents of the University of
25 * Michigan shall not be liable for any damages, including special,
26 * indirect, incidental, or consequential damages, with respect to any
27 * claim arising out of or in connection with the use of the software,
28 * even if it has been or is hereafter advised of the possibility of
32 #include <linux/nfs_fs.h>
33 #include <linux/nfs_page.h>
34 #include <linux/module.h>
36 #include <linux/sunrpc/metrics.h>
39 #include "delegation.h"
40 #include "nfs4filelayout.h"
42 #define NFSDBG_FACILITY NFSDBG_PNFS_LD
44 MODULE_LICENSE("GPL");
45 MODULE_AUTHOR("Dean Hildebrand <dhildebz@umich.edu>");
46 MODULE_DESCRIPTION("The NFSv4 file layout driver");
48 #define FILELAYOUT_POLL_RETRY_MAX (15*HZ)
51 filelayout_get_dense_offset(struct nfs4_filelayout_segment
*flseg
,
54 u32 stripe_width
= flseg
->stripe_unit
* flseg
->dsaddr
->stripe_count
;
58 offset
-= flseg
->pattern_offset
;
59 stripe_no
= div_u64(offset
, stripe_width
);
60 div_u64_rem(offset
, flseg
->stripe_unit
, &rem
);
62 return stripe_no
* flseg
->stripe_unit
+ rem
;
65 /* This function is used by the layout driver to calculate the
66 * offset of the file on the dserver based on whether the
67 * layout type is STRIPE_DENSE or STRIPE_SPARSE
70 filelayout_get_dserver_offset(struct pnfs_layout_segment
*lseg
, loff_t offset
)
72 struct nfs4_filelayout_segment
*flseg
= FILELAYOUT_LSEG(lseg
);
74 switch (flseg
->stripe_type
) {
79 return filelayout_get_dense_offset(flseg
, offset
);
85 static void filelayout_reset_write(struct nfs_write_data
*data
)
87 struct nfs_pgio_header
*hdr
= data
->header
;
88 struct rpc_task
*task
= &data
->task
;
90 if (!test_and_set_bit(NFS_IOHDR_REDO
, &hdr
->flags
)) {
91 dprintk("%s Reset task %5u for i/o through MDS "
92 "(req %s/%lld, %u bytes @ offset %llu)\n", __func__
,
94 hdr
->inode
->i_sb
->s_id
,
95 (long long)NFS_FILEID(hdr
->inode
),
97 (unsigned long long)data
->args
.offset
);
99 task
->tk_status
= pnfs_write_done_resend_to_mds(hdr
->inode
,
101 hdr
->completion_ops
);
105 static void filelayout_reset_read(struct nfs_read_data
*data
)
107 struct nfs_pgio_header
*hdr
= data
->header
;
108 struct rpc_task
*task
= &data
->task
;
110 if (!test_and_set_bit(NFS_IOHDR_REDO
, &hdr
->flags
)) {
111 dprintk("%s Reset task %5u for i/o through MDS "
112 "(req %s/%lld, %u bytes @ offset %llu)\n", __func__
,
114 hdr
->inode
->i_sb
->s_id
,
115 (long long)NFS_FILEID(hdr
->inode
),
117 (unsigned long long)data
->args
.offset
);
119 task
->tk_status
= pnfs_read_done_resend_to_mds(hdr
->inode
,
121 hdr
->completion_ops
);
125 static int filelayout_async_handle_error(struct rpc_task
*task
,
126 struct nfs4_state
*state
,
127 struct nfs_client
*clp
,
128 struct pnfs_layout_segment
*lseg
)
130 struct inode
*inode
= lseg
->pls_layout
->plh_inode
;
131 struct nfs_server
*mds_server
= NFS_SERVER(inode
);
132 struct nfs4_deviceid_node
*devid
= FILELAYOUT_DEVID_NODE(lseg
);
133 struct nfs_client
*mds_client
= mds_server
->nfs_client
;
134 struct nfs4_slot_table
*tbl
= &clp
->cl_session
->fc_slot_table
;
136 if (task
->tk_status
>= 0)
139 switch (task
->tk_status
) {
140 /* MDS state errors */
141 case -NFS4ERR_DELEG_REVOKED
:
142 case -NFS4ERR_ADMIN_REVOKED
:
143 case -NFS4ERR_BAD_STATEID
:
146 nfs_remove_bad_delegation(state
->inode
);
147 case -NFS4ERR_OPENMODE
:
150 nfs4_schedule_stateid_recovery(mds_server
, state
);
151 goto wait_on_recovery
;
152 case -NFS4ERR_EXPIRED
:
154 nfs4_schedule_stateid_recovery(mds_server
, state
);
155 nfs4_schedule_lease_recovery(mds_client
);
156 goto wait_on_recovery
;
157 /* DS session errors */
158 case -NFS4ERR_BADSESSION
:
159 case -NFS4ERR_BADSLOT
:
160 case -NFS4ERR_BAD_HIGH_SLOT
:
161 case -NFS4ERR_DEADSESSION
:
162 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION
:
163 case -NFS4ERR_SEQ_FALSE_RETRY
:
164 case -NFS4ERR_SEQ_MISORDERED
:
165 dprintk("%s ERROR %d, Reset session. Exchangeid "
166 "flags 0x%x\n", __func__
, task
->tk_status
,
167 clp
->cl_exchange_flags
);
168 nfs4_schedule_session_recovery(clp
->cl_session
, task
->tk_status
);
173 rpc_delay(task
, FILELAYOUT_POLL_RETRY_MAX
);
175 case -NFS4ERR_RETRY_UNCACHED_REP
:
177 /* Invalidate Layout errors */
178 case -NFS4ERR_PNFS_NO_LAYOUT
:
179 case -ESTALE
: /* mapped NFS4ERR_STALE */
180 case -EBADHANDLE
: /* mapped NFS4ERR_BADHANDLE */
181 case -EISDIR
: /* mapped NFS4ERR_ISDIR */
182 case -NFS4ERR_FHEXPIRED
:
183 case -NFS4ERR_WRONG_TYPE
:
184 dprintk("%s Invalid layout error %d\n", __func__
,
187 * Destroy layout so new i/o will get a new layout.
188 * Layout will not be destroyed until all current lseg
189 * references are put. Mark layout as invalid to resend failed
190 * i/o and all i/o waiting on the slot table to the MDS until
191 * layout is destroyed and a new valid layout is obtained.
193 set_bit(NFS_LAYOUT_INVALID
,
194 &NFS_I(inode
)->layout
->plh_flags
);
195 pnfs_destroy_layout(NFS_I(inode
));
196 rpc_wake_up(&tbl
->slot_tbl_waitq
);
198 /* RPC connection errors */
206 dprintk("%s DS connection error %d\n", __func__
,
208 if (!filelayout_test_devid_invalid(devid
))
209 _pnfs_return_layout(inode
);
210 filelayout_mark_devid_invalid(devid
);
211 rpc_wake_up(&tbl
->slot_tbl_waitq
);
212 nfs4_ds_disconnect(clp
);
216 dprintk("%s Retry through MDS. Error %d\n", __func__
,
218 return -NFS4ERR_RESET_TO_MDS
;
224 rpc_sleep_on(&mds_client
->cl_rpcwaitq
, task
, NULL
);
225 if (test_bit(NFS4CLNT_MANAGER_RUNNING
, &mds_client
->cl_state
) == 0)
226 rpc_wake_up_queued_task(&mds_client
->cl_rpcwaitq
, task
);
230 /* NFS_PROTO call done callback routines */
232 static int filelayout_read_done_cb(struct rpc_task
*task
,
233 struct nfs_read_data
*data
)
235 struct nfs_pgio_header
*hdr
= data
->header
;
238 err
= filelayout_async_handle_error(task
, data
->args
.context
->state
,
239 data
->ds_clp
, hdr
->lseg
);
242 case -NFS4ERR_RESET_TO_MDS
:
243 filelayout_reset_read(data
);
244 return task
->tk_status
;
246 rpc_restart_call_prepare(task
);
254 * We reference the rpc_cred of the first WRITE that triggers the need for
255 * a LAYOUTCOMMIT, and use it to send the layoutcommit compound.
256 * rfc5661 is not clear about which credential should be used.
259 filelayout_set_layoutcommit(struct nfs_write_data
*wdata
)
261 struct nfs_pgio_header
*hdr
= wdata
->header
;
263 if (FILELAYOUT_LSEG(hdr
->lseg
)->commit_through_mds
||
264 wdata
->res
.verf
->committed
== NFS_FILE_SYNC
)
267 pnfs_set_layoutcommit(wdata
);
268 dprintk("%s ionde %lu pls_end_pos %lu\n", __func__
, hdr
->inode
->i_ino
,
269 (unsigned long) NFS_I(hdr
->inode
)->layout
->plh_lwb
);
273 * Call ops for the async read/write cases
274 * In the case of dense layouts, the offset needs to be reset to its
277 static void filelayout_read_prepare(struct rpc_task
*task
, void *data
)
279 struct nfs_read_data
*rdata
= data
;
281 if (filelayout_reset_to_mds(rdata
->header
->lseg
)) {
282 dprintk("%s task %u reset io to MDS\n", __func__
, task
->tk_pid
);
283 filelayout_reset_read(rdata
);
287 rdata
->read_done_cb
= filelayout_read_done_cb
;
289 if (nfs41_setup_sequence(rdata
->ds_clp
->cl_session
,
290 &rdata
->args
.seq_args
, &rdata
->res
.seq_res
,
294 rpc_call_start(task
);
297 static void filelayout_read_call_done(struct rpc_task
*task
, void *data
)
299 struct nfs_read_data
*rdata
= data
;
301 dprintk("--> %s task->tk_status %d\n", __func__
, task
->tk_status
);
303 if (test_bit(NFS_IOHDR_REDO
, &rdata
->header
->flags
) &&
304 task
->tk_status
== 0)
307 /* Note this may cause RPC to be resent */
308 rdata
->header
->mds_ops
->rpc_call_done(task
, data
);
311 static void filelayout_read_count_stats(struct rpc_task
*task
, void *data
)
313 struct nfs_read_data
*rdata
= data
;
315 rpc_count_iostats(task
, NFS_SERVER(rdata
->header
->inode
)->client
->cl_metrics
);
318 static void filelayout_read_release(void *data
)
320 struct nfs_read_data
*rdata
= data
;
322 nfs_put_client(rdata
->ds_clp
);
323 rdata
->header
->mds_ops
->rpc_release(data
);
326 static int filelayout_write_done_cb(struct rpc_task
*task
,
327 struct nfs_write_data
*data
)
329 struct nfs_pgio_header
*hdr
= data
->header
;
332 err
= filelayout_async_handle_error(task
, data
->args
.context
->state
,
333 data
->ds_clp
, hdr
->lseg
);
336 case -NFS4ERR_RESET_TO_MDS
:
337 filelayout_reset_write(data
);
338 return task
->tk_status
;
340 rpc_restart_call_prepare(task
);
344 filelayout_set_layoutcommit(data
);
348 /* Fake up some data that will cause nfs_commit_release to retry the writes. */
349 static void prepare_to_resend_writes(struct nfs_commit_data
*data
)
351 struct nfs_page
*first
= nfs_list_entry(data
->pages
.next
);
353 data
->task
.tk_status
= 0;
354 memcpy(data
->verf
.verifier
, first
->wb_verf
.verifier
,
355 sizeof(first
->wb_verf
.verifier
));
356 data
->verf
.verifier
[0]++; /* ensure verifier mismatch */
359 static int filelayout_commit_done_cb(struct rpc_task
*task
,
360 struct nfs_commit_data
*data
)
364 err
= filelayout_async_handle_error(task
, NULL
, data
->ds_clp
,
368 case -NFS4ERR_RESET_TO_MDS
:
369 prepare_to_resend_writes(data
);
372 rpc_restart_call_prepare(task
);
379 static void filelayout_write_prepare(struct rpc_task
*task
, void *data
)
381 struct nfs_write_data
*wdata
= data
;
383 if (filelayout_reset_to_mds(wdata
->header
->lseg
)) {
384 dprintk("%s task %u reset io to MDS\n", __func__
, task
->tk_pid
);
385 filelayout_reset_write(wdata
);
389 if (nfs41_setup_sequence(wdata
->ds_clp
->cl_session
,
390 &wdata
->args
.seq_args
, &wdata
->res
.seq_res
,
394 rpc_call_start(task
);
397 static void filelayout_write_call_done(struct rpc_task
*task
, void *data
)
399 struct nfs_write_data
*wdata
= data
;
401 if (test_bit(NFS_IOHDR_REDO
, &wdata
->header
->flags
) &&
402 task
->tk_status
== 0)
405 /* Note this may cause RPC to be resent */
406 wdata
->header
->mds_ops
->rpc_call_done(task
, data
);
409 static void filelayout_write_count_stats(struct rpc_task
*task
, void *data
)
411 struct nfs_write_data
*wdata
= data
;
413 rpc_count_iostats(task
, NFS_SERVER(wdata
->header
->inode
)->client
->cl_metrics
);
416 static void filelayout_write_release(void *data
)
418 struct nfs_write_data
*wdata
= data
;
420 nfs_put_client(wdata
->ds_clp
);
421 wdata
->header
->mds_ops
->rpc_release(data
);
424 static void filelayout_commit_prepare(struct rpc_task
*task
, void *data
)
426 struct nfs_commit_data
*wdata
= data
;
428 if (nfs41_setup_sequence(wdata
->ds_clp
->cl_session
,
429 &wdata
->args
.seq_args
, &wdata
->res
.seq_res
,
433 rpc_call_start(task
);
436 static void filelayout_write_commit_done(struct rpc_task
*task
, void *data
)
438 struct nfs_commit_data
*wdata
= data
;
440 /* Note this may cause RPC to be resent */
441 wdata
->mds_ops
->rpc_call_done(task
, data
);
444 static void filelayout_commit_count_stats(struct rpc_task
*task
, void *data
)
446 struct nfs_commit_data
*cdata
= data
;
448 rpc_count_iostats(task
, NFS_SERVER(cdata
->inode
)->client
->cl_metrics
);
451 static void filelayout_commit_release(void *calldata
)
453 struct nfs_commit_data
*data
= calldata
;
455 data
->completion_ops
->completion(data
);
456 put_lseg(data
->lseg
);
457 nfs_put_client(data
->ds_clp
);
458 nfs_commitdata_release(data
);
461 static const struct rpc_call_ops filelayout_read_call_ops
= {
462 .rpc_call_prepare
= filelayout_read_prepare
,
463 .rpc_call_done
= filelayout_read_call_done
,
464 .rpc_count_stats
= filelayout_read_count_stats
,
465 .rpc_release
= filelayout_read_release
,
468 static const struct rpc_call_ops filelayout_write_call_ops
= {
469 .rpc_call_prepare
= filelayout_write_prepare
,
470 .rpc_call_done
= filelayout_write_call_done
,
471 .rpc_count_stats
= filelayout_write_count_stats
,
472 .rpc_release
= filelayout_write_release
,
475 static const struct rpc_call_ops filelayout_commit_call_ops
= {
476 .rpc_call_prepare
= filelayout_commit_prepare
,
477 .rpc_call_done
= filelayout_write_commit_done
,
478 .rpc_count_stats
= filelayout_commit_count_stats
,
479 .rpc_release
= filelayout_commit_release
,
482 static enum pnfs_try_status
483 filelayout_read_pagelist(struct nfs_read_data
*data
)
485 struct nfs_pgio_header
*hdr
= data
->header
;
486 struct pnfs_layout_segment
*lseg
= hdr
->lseg
;
487 struct nfs4_pnfs_ds
*ds
;
488 loff_t offset
= data
->args
.offset
;
493 dprintk("--> %s ino %lu pgbase %u req %Zu@%llu\n",
494 __func__
, hdr
->inode
->i_ino
,
495 data
->args
.pgbase
, (size_t)data
->args
.count
, offset
);
497 /* Retrieve the correct rpc_client for the byte range */
498 j
= nfs4_fl_calc_j_index(lseg
, offset
);
499 idx
= nfs4_fl_calc_ds_index(lseg
, j
);
500 ds
= nfs4_fl_prepare_ds(lseg
, idx
);
502 return PNFS_NOT_ATTEMPTED
;
503 dprintk("%s USE DS: %s cl_count %d\n", __func__
,
504 ds
->ds_remotestr
, atomic_read(&ds
->ds_clp
->cl_count
));
506 /* No multipath support. Use first DS */
507 atomic_inc(&ds
->ds_clp
->cl_count
);
508 data
->ds_clp
= ds
->ds_clp
;
509 fh
= nfs4_fl_select_ds_fh(lseg
, j
);
513 data
->args
.offset
= filelayout_get_dserver_offset(lseg
, offset
);
514 data
->mds_offset
= offset
;
516 /* Perform an asynchronous read to ds */
517 status
= nfs_initiate_read(ds
->ds_clp
->cl_rpcclient
, data
,
518 &filelayout_read_call_ops
, RPC_TASK_SOFTCONN
);
520 return PNFS_ATTEMPTED
;
523 /* Perform async writes. */
524 static enum pnfs_try_status
525 filelayout_write_pagelist(struct nfs_write_data
*data
, int sync
)
527 struct nfs_pgio_header
*hdr
= data
->header
;
528 struct pnfs_layout_segment
*lseg
= hdr
->lseg
;
529 struct nfs4_pnfs_ds
*ds
;
530 loff_t offset
= data
->args
.offset
;
535 /* Retrieve the correct rpc_client for the byte range */
536 j
= nfs4_fl_calc_j_index(lseg
, offset
);
537 idx
= nfs4_fl_calc_ds_index(lseg
, j
);
538 ds
= nfs4_fl_prepare_ds(lseg
, idx
);
540 return PNFS_NOT_ATTEMPTED
;
541 dprintk("%s ino %lu sync %d req %Zu@%llu DS: %s cl_count %d\n",
542 __func__
, hdr
->inode
->i_ino
, sync
, (size_t) data
->args
.count
,
543 offset
, ds
->ds_remotestr
, atomic_read(&ds
->ds_clp
->cl_count
));
545 data
->write_done_cb
= filelayout_write_done_cb
;
546 atomic_inc(&ds
->ds_clp
->cl_count
);
547 data
->ds_clp
= ds
->ds_clp
;
548 fh
= nfs4_fl_select_ds_fh(lseg
, j
);
552 * Get the file offset on the dserver. Set the write offset to
553 * this offset and save the original offset.
555 data
->args
.offset
= filelayout_get_dserver_offset(lseg
, offset
);
557 /* Perform an asynchronous write */
558 status
= nfs_initiate_write(ds
->ds_clp
->cl_rpcclient
, data
,
559 &filelayout_write_call_ops
, sync
,
562 return PNFS_ATTEMPTED
;
566 * filelayout_check_layout()
568 * Make sure layout segment parameters are sane WRT the device.
569 * At this point no generic layer initialization of the lseg has occurred,
570 * and nothing has been added to the layout_hdr cache.
574 filelayout_check_layout(struct pnfs_layout_hdr
*lo
,
575 struct nfs4_filelayout_segment
*fl
,
576 struct nfs4_layoutget_res
*lgr
,
577 struct nfs4_deviceid
*id
,
580 struct nfs4_deviceid_node
*d
;
581 struct nfs4_file_layout_dsaddr
*dsaddr
;
582 int status
= -EINVAL
;
583 struct nfs_server
*nfss
= NFS_SERVER(lo
->plh_inode
);
585 dprintk("--> %s\n", __func__
);
587 /* FIXME: remove this check when layout segment support is added */
588 if (lgr
->range
.offset
!= 0 ||
589 lgr
->range
.length
!= NFS4_MAX_UINT64
) {
590 dprintk("%s Only whole file layouts supported. Use MDS i/o\n",
595 if (fl
->pattern_offset
> lgr
->range
.offset
) {
596 dprintk("%s pattern_offset %lld too large\n",
597 __func__
, fl
->pattern_offset
);
601 if (!fl
->stripe_unit
|| fl
->stripe_unit
% PAGE_SIZE
) {
602 dprintk("%s Invalid stripe unit (%u)\n",
603 __func__
, fl
->stripe_unit
);
607 /* find and reference the deviceid */
608 d
= nfs4_find_get_deviceid(NFS_SERVER(lo
->plh_inode
)->pnfs_curr_ld
,
609 NFS_SERVER(lo
->plh_inode
)->nfs_client
, id
);
611 dsaddr
= get_device_info(lo
->plh_inode
, id
, gfp_flags
);
615 dsaddr
= container_of(d
, struct nfs4_file_layout_dsaddr
, id_node
);
616 /* Found deviceid is being reaped */
617 if (test_bit(NFS_DEVICEID_INVALID
, &dsaddr
->id_node
.flags
))
622 if (fl
->first_stripe_index
>= dsaddr
->stripe_count
) {
623 dprintk("%s Bad first_stripe_index %u\n",
624 __func__
, fl
->first_stripe_index
);
628 if ((fl
->stripe_type
== STRIPE_SPARSE
&&
629 fl
->num_fh
> 1 && fl
->num_fh
!= dsaddr
->ds_num
) ||
630 (fl
->stripe_type
== STRIPE_DENSE
&&
631 fl
->num_fh
!= dsaddr
->stripe_count
)) {
632 dprintk("%s num_fh %u not valid for given packing\n",
633 __func__
, fl
->num_fh
);
637 if (fl
->stripe_unit
% nfss
->rsize
|| fl
->stripe_unit
% nfss
->wsize
) {
638 dprintk("%s Stripe unit (%u) not aligned with rsize %u "
639 "wsize %u\n", __func__
, fl
->stripe_unit
, nfss
->rsize
,
645 dprintk("--> %s returns %d\n", __func__
, status
);
648 nfs4_fl_put_deviceid(dsaddr
);
652 static void filelayout_free_fh_array(struct nfs4_filelayout_segment
*fl
)
656 for (i
= 0; i
< fl
->num_fh
; i
++) {
657 if (!fl
->fh_array
[i
])
659 kfree(fl
->fh_array
[i
]);
666 _filelayout_free_lseg(struct nfs4_filelayout_segment
*fl
)
668 filelayout_free_fh_array(fl
);
673 filelayout_decode_layout(struct pnfs_layout_hdr
*flo
,
674 struct nfs4_filelayout_segment
*fl
,
675 struct nfs4_layoutget_res
*lgr
,
676 struct nfs4_deviceid
*id
,
679 struct xdr_stream stream
;
681 struct page
*scratch
;
686 dprintk("%s: set_layout_map Begin\n", __func__
);
688 scratch
= alloc_page(gfp_flags
);
692 xdr_init_decode_pages(&stream
, &buf
, lgr
->layoutp
->pages
, lgr
->layoutp
->len
);
693 xdr_set_scratch_buffer(&stream
, page_address(scratch
), PAGE_SIZE
);
695 /* 20 = ufl_util (4), first_stripe_index (4), pattern_offset (8),
697 p
= xdr_inline_decode(&stream
, NFS4_DEVICEID4_SIZE
+ 20);
701 memcpy(id
, p
, sizeof(*id
));
702 p
+= XDR_QUADLEN(NFS4_DEVICEID4_SIZE
);
703 nfs4_print_deviceid(id
);
705 nfl_util
= be32_to_cpup(p
++);
706 if (nfl_util
& NFL4_UFLG_COMMIT_THRU_MDS
)
707 fl
->commit_through_mds
= 1;
708 if (nfl_util
& NFL4_UFLG_DENSE
)
709 fl
->stripe_type
= STRIPE_DENSE
;
711 fl
->stripe_type
= STRIPE_SPARSE
;
712 fl
->stripe_unit
= nfl_util
& ~NFL4_UFLG_MASK
;
714 fl
->first_stripe_index
= be32_to_cpup(p
++);
715 p
= xdr_decode_hyper(p
, &fl
->pattern_offset
);
716 fl
->num_fh
= be32_to_cpup(p
++);
718 dprintk("%s: nfl_util 0x%X num_fh %u fsi %u po %llu\n",
719 __func__
, nfl_util
, fl
->num_fh
, fl
->first_stripe_index
,
722 /* Note that a zero value for num_fh is legal for STRIPE_SPARSE.
723 * Futher checking is done in filelayout_check_layout */
725 max(NFS4_PNFS_MAX_STRIPE_CNT
, NFS4_PNFS_MAX_MULTI_CNT
))
728 if (fl
->num_fh
> 0) {
729 fl
->fh_array
= kzalloc(fl
->num_fh
* sizeof(struct nfs_fh
*),
735 for (i
= 0; i
< fl
->num_fh
; i
++) {
736 /* Do we want to use a mempool here? */
737 fl
->fh_array
[i
] = kmalloc(sizeof(struct nfs_fh
), gfp_flags
);
738 if (!fl
->fh_array
[i
])
741 p
= xdr_inline_decode(&stream
, 4);
744 fl
->fh_array
[i
]->size
= be32_to_cpup(p
++);
745 if (sizeof(struct nfs_fh
) < fl
->fh_array
[i
]->size
) {
746 printk(KERN_ERR
"NFS: Too big fh %d received %d\n",
747 i
, fl
->fh_array
[i
]->size
);
751 p
= xdr_inline_decode(&stream
, fl
->fh_array
[i
]->size
);
754 memcpy(fl
->fh_array
[i
]->data
, p
, fl
->fh_array
[i
]->size
);
755 dprintk("DEBUG: %s: fh len %d\n", __func__
,
756 fl
->fh_array
[i
]->size
);
759 __free_page(scratch
);
763 filelayout_free_fh_array(fl
);
765 __free_page(scratch
);
770 filelayout_free_lseg(struct pnfs_layout_segment
*lseg
)
772 struct nfs4_filelayout_segment
*fl
= FILELAYOUT_LSEG(lseg
);
774 dprintk("--> %s\n", __func__
);
775 nfs4_fl_put_deviceid(fl
->dsaddr
);
776 /* This assumes a single RW lseg */
777 if (lseg
->pls_range
.iomode
== IOMODE_RW
) {
778 struct nfs4_filelayout
*flo
;
780 flo
= FILELAYOUT_FROM_HDR(lseg
->pls_layout
);
781 flo
->commit_info
.nbuckets
= 0;
782 kfree(flo
->commit_info
.buckets
);
783 flo
->commit_info
.buckets
= NULL
;
785 _filelayout_free_lseg(fl
);
789 filelayout_alloc_commit_info(struct pnfs_layout_segment
*lseg
,
790 struct nfs_commit_info
*cinfo
,
793 struct nfs4_filelayout_segment
*fl
= FILELAYOUT_LSEG(lseg
);
794 struct pnfs_commit_bucket
*buckets
;
797 if (fl
->commit_through_mds
)
799 if (cinfo
->ds
->nbuckets
!= 0) {
800 /* This assumes there is only one IOMODE_RW lseg. What
801 * we really want to do is have a layout_hdr level
802 * dictionary of <multipath_list4, fh> keys, each
803 * associated with a struct list_head, populated by calls
804 * to filelayout_write_pagelist().
809 size
= (fl
->stripe_type
== STRIPE_SPARSE
) ?
810 fl
->dsaddr
->ds_num
: fl
->dsaddr
->stripe_count
;
812 buckets
= kcalloc(size
, sizeof(struct pnfs_commit_bucket
),
819 spin_lock(cinfo
->lock
);
820 if (cinfo
->ds
->nbuckets
!= 0)
823 cinfo
->ds
->buckets
= buckets
;
824 cinfo
->ds
->nbuckets
= size
;
825 for (i
= 0; i
< size
; i
++) {
826 INIT_LIST_HEAD(&buckets
[i
].written
);
827 INIT_LIST_HEAD(&buckets
[i
].committing
);
830 spin_unlock(cinfo
->lock
);
835 static struct pnfs_layout_segment
*
836 filelayout_alloc_lseg(struct pnfs_layout_hdr
*layoutid
,
837 struct nfs4_layoutget_res
*lgr
,
840 struct nfs4_filelayout_segment
*fl
;
842 struct nfs4_deviceid id
;
844 dprintk("--> %s\n", __func__
);
845 fl
= kzalloc(sizeof(*fl
), gfp_flags
);
849 rc
= filelayout_decode_layout(layoutid
, fl
, lgr
, &id
, gfp_flags
);
850 if (rc
!= 0 || filelayout_check_layout(layoutid
, fl
, lgr
, &id
, gfp_flags
)) {
851 _filelayout_free_lseg(fl
);
854 return &fl
->generic_hdr
;
858 * filelayout_pg_test(). Called by nfs_can_coalesce_requests()
860 * return true : coalesce page
861 * return false : don't coalesce page
864 filelayout_pg_test(struct nfs_pageio_descriptor
*pgio
, struct nfs_page
*prev
,
865 struct nfs_page
*req
)
867 u64 p_stripe
, r_stripe
;
870 if (!pnfs_generic_pg_test(pgio
, prev
, req
) ||
871 !nfs_generic_pg_test(pgio
, prev
, req
))
874 p_stripe
= (u64
)req_offset(prev
);
875 r_stripe
= (u64
)req_offset(req
);
876 stripe_unit
= FILELAYOUT_LSEG(pgio
->pg_lseg
)->stripe_unit
;
878 do_div(p_stripe
, stripe_unit
);
879 do_div(r_stripe
, stripe_unit
);
881 return (p_stripe
== r_stripe
);
885 filelayout_pg_init_read(struct nfs_pageio_descriptor
*pgio
,
886 struct nfs_page
*req
)
888 BUG_ON(pgio
->pg_lseg
!= NULL
);
890 if (req
->wb_offset
!= req
->wb_pgbase
) {
892 * Handling unaligned pages is difficult, because have to
893 * somehow split a req in two in certain cases in the
894 * pg.test code. Avoid this by just not using pnfs
897 nfs_pageio_reset_read_mds(pgio
);
900 pgio
->pg_lseg
= pnfs_update_layout(pgio
->pg_inode
,
906 /* If no lseg, fall back to read through mds */
907 if (pgio
->pg_lseg
== NULL
)
908 nfs_pageio_reset_read_mds(pgio
);
912 filelayout_pg_init_write(struct nfs_pageio_descriptor
*pgio
,
913 struct nfs_page
*req
)
915 struct nfs_commit_info cinfo
;
918 BUG_ON(pgio
->pg_lseg
!= NULL
);
920 if (req
->wb_offset
!= req
->wb_pgbase
)
922 pgio
->pg_lseg
= pnfs_update_layout(pgio
->pg_inode
,
928 /* If no lseg, fall back to write through mds */
929 if (pgio
->pg_lseg
== NULL
)
931 nfs_init_cinfo(&cinfo
, pgio
->pg_inode
, pgio
->pg_dreq
);
932 status
= filelayout_alloc_commit_info(pgio
->pg_lseg
, &cinfo
, GFP_NOFS
);
934 put_lseg(pgio
->pg_lseg
);
935 pgio
->pg_lseg
= NULL
;
940 nfs_pageio_reset_write_mds(pgio
);
943 static const struct nfs_pageio_ops filelayout_pg_read_ops
= {
944 .pg_init
= filelayout_pg_init_read
,
945 .pg_test
= filelayout_pg_test
,
946 .pg_doio
= pnfs_generic_pg_readpages
,
949 static const struct nfs_pageio_ops filelayout_pg_write_ops
= {
950 .pg_init
= filelayout_pg_init_write
,
951 .pg_test
= filelayout_pg_test
,
952 .pg_doio
= pnfs_generic_pg_writepages
,
955 static u32
select_bucket_index(struct nfs4_filelayout_segment
*fl
, u32 j
)
957 if (fl
->stripe_type
== STRIPE_SPARSE
)
958 return nfs4_fl_calc_ds_index(&fl
->generic_hdr
, j
);
963 /* The generic layer is about to remove the req from the commit list.
964 * If this will make the bucket empty, it will need to put the lseg reference.
967 filelayout_clear_request_commit(struct nfs_page
*req
,
968 struct nfs_commit_info
*cinfo
)
970 struct pnfs_layout_segment
*freeme
= NULL
;
972 spin_lock(cinfo
->lock
);
973 if (!test_and_clear_bit(PG_COMMIT_TO_DS
, &req
->wb_flags
))
975 cinfo
->ds
->nwritten
--;
976 if (list_is_singular(&req
->wb_list
)) {
977 struct pnfs_commit_bucket
*bucket
;
979 bucket
= list_first_entry(&req
->wb_list
,
980 struct pnfs_commit_bucket
,
982 freeme
= bucket
->wlseg
;
983 bucket
->wlseg
= NULL
;
986 nfs_request_remove_commit_list(req
, cinfo
);
987 spin_unlock(cinfo
->lock
);
991 static struct list_head
*
992 filelayout_choose_commit_list(struct nfs_page
*req
,
993 struct pnfs_layout_segment
*lseg
,
994 struct nfs_commit_info
*cinfo
)
996 struct nfs4_filelayout_segment
*fl
= FILELAYOUT_LSEG(lseg
);
998 struct list_head
*list
;
999 struct pnfs_commit_bucket
*buckets
;
1001 if (fl
->commit_through_mds
)
1002 return &cinfo
->mds
->list
;
1004 /* Note that we are calling nfs4_fl_calc_j_index on each page
1005 * that ends up being committed to a data server. An attractive
1006 * alternative is to add a field to nfs_write_data and nfs_page
1007 * to store the value calculated in filelayout_write_pagelist
1008 * and just use that here.
1010 j
= nfs4_fl_calc_j_index(lseg
, req_offset(req
));
1011 i
= select_bucket_index(fl
, j
);
1012 buckets
= cinfo
->ds
->buckets
;
1013 list
= &buckets
[i
].written
;
1014 if (list_empty(list
)) {
1015 /* Non-empty buckets hold a reference on the lseg. That ref
1016 * is normally transferred to the COMMIT call and released
1017 * there. It could also be released if the last req is pulled
1018 * off due to a rewrite, in which case it will be done in
1019 * filelayout_clear_request_commit
1021 buckets
[i
].wlseg
= get_lseg(lseg
);
1023 set_bit(PG_COMMIT_TO_DS
, &req
->wb_flags
);
1024 cinfo
->ds
->nwritten
++;
1029 filelayout_mark_request_commit(struct nfs_page
*req
,
1030 struct pnfs_layout_segment
*lseg
,
1031 struct nfs_commit_info
*cinfo
)
1033 struct list_head
*list
;
1035 list
= filelayout_choose_commit_list(req
, lseg
, cinfo
);
1036 nfs_request_add_commit_list(req
, list
, cinfo
);
1039 static u32
calc_ds_index_from_commit(struct pnfs_layout_segment
*lseg
, u32 i
)
1041 struct nfs4_filelayout_segment
*flseg
= FILELAYOUT_LSEG(lseg
);
1043 if (flseg
->stripe_type
== STRIPE_SPARSE
)
1046 return nfs4_fl_calc_ds_index(lseg
, i
);
1049 static struct nfs_fh
*
1050 select_ds_fh_from_commit(struct pnfs_layout_segment
*lseg
, u32 i
)
1052 struct nfs4_filelayout_segment
*flseg
= FILELAYOUT_LSEG(lseg
);
1054 if (flseg
->stripe_type
== STRIPE_SPARSE
) {
1055 if (flseg
->num_fh
== 1)
1057 else if (flseg
->num_fh
== 0)
1058 /* Use the MDS OPEN fh set in nfs_read_rpcsetup */
1061 return flseg
->fh_array
[i
];
1064 static int filelayout_initiate_commit(struct nfs_commit_data
*data
, int how
)
1066 struct pnfs_layout_segment
*lseg
= data
->lseg
;
1067 struct nfs4_pnfs_ds
*ds
;
1071 idx
= calc_ds_index_from_commit(lseg
, data
->ds_commit_index
);
1072 ds
= nfs4_fl_prepare_ds(lseg
, idx
);
1074 prepare_to_resend_writes(data
);
1075 filelayout_commit_release(data
);
1078 dprintk("%s ino %lu, how %d cl_count %d\n", __func__
,
1079 data
->inode
->i_ino
, how
, atomic_read(&ds
->ds_clp
->cl_count
));
1080 data
->commit_done_cb
= filelayout_commit_done_cb
;
1081 atomic_inc(&ds
->ds_clp
->cl_count
);
1082 data
->ds_clp
= ds
->ds_clp
;
1083 fh
= select_ds_fh_from_commit(lseg
, data
->ds_commit_index
);
1086 return nfs_initiate_commit(ds
->ds_clp
->cl_rpcclient
, data
,
1087 &filelayout_commit_call_ops
, how
,
1092 transfer_commit_list(struct list_head
*src
, struct list_head
*dst
,
1093 struct nfs_commit_info
*cinfo
, int max
)
1095 struct nfs_page
*req
, *tmp
;
1098 list_for_each_entry_safe(req
, tmp
, src
, wb_list
) {
1099 if (!nfs_lock_request(req
))
1101 kref_get(&req
->wb_kref
);
1102 if (cond_resched_lock(cinfo
->lock
))
1103 list_safe_reset_next(req
, tmp
, wb_list
);
1104 nfs_request_remove_commit_list(req
, cinfo
);
1105 clear_bit(PG_COMMIT_TO_DS
, &req
->wb_flags
);
1106 nfs_list_add_request(req
, dst
);
1108 if ((ret
== max
) && !cinfo
->dreq
)
1115 filelayout_scan_ds_commit_list(struct pnfs_commit_bucket
*bucket
,
1116 struct nfs_commit_info
*cinfo
,
1119 struct list_head
*src
= &bucket
->written
;
1120 struct list_head
*dst
= &bucket
->committing
;
1123 ret
= transfer_commit_list(src
, dst
, cinfo
, max
);
1125 cinfo
->ds
->nwritten
-= ret
;
1126 cinfo
->ds
->ncommitting
+= ret
;
1127 bucket
->clseg
= bucket
->wlseg
;
1128 if (list_empty(src
))
1129 bucket
->wlseg
= NULL
;
1131 get_lseg(bucket
->clseg
);
1136 /* Move reqs from written to committing lists, returning count of number moved.
1137 * Note called with cinfo->lock held.
1139 static int filelayout_scan_commit_lists(struct nfs_commit_info
*cinfo
,
1144 for (i
= 0; i
< cinfo
->ds
->nbuckets
&& max
!= 0; i
++) {
1145 cnt
= filelayout_scan_ds_commit_list(&cinfo
->ds
->buckets
[i
],
1153 /* Pull everything off the committing lists and dump into @dst */
1154 static void filelayout_recover_commit_reqs(struct list_head
*dst
,
1155 struct nfs_commit_info
*cinfo
)
1157 struct pnfs_commit_bucket
*b
;
1160 /* NOTE cinfo->lock is NOT held, relying on fact that this is
1161 * only called on single thread per dreq.
1162 * Can't take the lock because need to do put_lseg
1164 for (i
= 0, b
= cinfo
->ds
->buckets
; i
< cinfo
->ds
->nbuckets
; i
++, b
++) {
1165 if (transfer_commit_list(&b
->written
, dst
, cinfo
, 0)) {
1166 BUG_ON(!list_empty(&b
->written
));
1171 cinfo
->ds
->nwritten
= 0;
1175 alloc_ds_commits(struct nfs_commit_info
*cinfo
, struct list_head
*list
)
1177 struct pnfs_ds_commit_info
*fl_cinfo
;
1178 struct pnfs_commit_bucket
*bucket
;
1179 struct nfs_commit_data
*data
;
1181 unsigned int nreq
= 0;
1183 fl_cinfo
= cinfo
->ds
;
1184 bucket
= fl_cinfo
->buckets
;
1185 for (i
= 0; i
< fl_cinfo
->nbuckets
; i
++, bucket
++) {
1186 if (list_empty(&bucket
->committing
))
1188 data
= nfs_commitdata_alloc();
1191 data
->ds_commit_index
= i
;
1192 data
->lseg
= bucket
->clseg
;
1193 bucket
->clseg
= NULL
;
1194 list_add(&data
->pages
, list
);
1198 /* Clean up on error */
1199 for (j
= i
; j
< fl_cinfo
->nbuckets
; j
++, bucket
++) {
1200 if (list_empty(&bucket
->committing
))
1202 nfs_retry_commit(&bucket
->committing
, bucket
->clseg
, cinfo
);
1203 put_lseg(bucket
->clseg
);
1204 bucket
->clseg
= NULL
;
1206 /* Caller will clean up entries put on list */
1210 /* This follows nfs_commit_list pretty closely */
1212 filelayout_commit_pagelist(struct inode
*inode
, struct list_head
*mds_pages
,
1213 int how
, struct nfs_commit_info
*cinfo
)
1215 struct nfs_commit_data
*data
, *tmp
;
1217 unsigned int nreq
= 0;
1219 if (!list_empty(mds_pages
)) {
1220 data
= nfs_commitdata_alloc();
1223 list_add(&data
->pages
, &list
);
1226 nfs_retry_commit(mds_pages
, NULL
, cinfo
);
1229 nreq
+= alloc_ds_commits(cinfo
, &list
);
1232 cinfo
->completion_ops
->error_cleanup(NFS_I(inode
));
1236 atomic_add(nreq
, &cinfo
->mds
->rpcs_out
);
1238 list_for_each_entry_safe(data
, tmp
, &list
, pages
) {
1239 list_del_init(&data
->pages
);
1241 nfs_init_commit(data
, mds_pages
, NULL
, cinfo
);
1242 nfs_initiate_commit(NFS_CLIENT(inode
), data
,
1243 data
->mds_ops
, how
, 0);
1245 struct pnfs_commit_bucket
*buckets
;
1247 buckets
= cinfo
->ds
->buckets
;
1248 nfs_init_commit(data
, &buckets
[data
->ds_commit_index
].committing
, data
->lseg
, cinfo
);
1249 filelayout_initiate_commit(data
, how
);
1253 cinfo
->ds
->ncommitting
= 0;
1254 return PNFS_ATTEMPTED
;
1258 filelayout_free_deveiceid_node(struct nfs4_deviceid_node
*d
)
1260 nfs4_fl_free_deviceid(container_of(d
, struct nfs4_file_layout_dsaddr
, id_node
));
1263 static struct pnfs_layout_hdr
*
1264 filelayout_alloc_layout_hdr(struct inode
*inode
, gfp_t gfp_flags
)
1266 struct nfs4_filelayout
*flo
;
1268 flo
= kzalloc(sizeof(*flo
), gfp_flags
);
1269 return &flo
->generic_hdr
;
1273 filelayout_free_layout_hdr(struct pnfs_layout_hdr
*lo
)
1275 kfree(FILELAYOUT_FROM_HDR(lo
));
1278 static struct pnfs_ds_commit_info
*
1279 filelayout_get_ds_info(struct inode
*inode
)
1281 struct pnfs_layout_hdr
*layout
= NFS_I(inode
)->layout
;
1286 return &FILELAYOUT_FROM_HDR(layout
)->commit_info
;
1289 static struct pnfs_layoutdriver_type filelayout_type
= {
1290 .id
= LAYOUT_NFSV4_1_FILES
,
1291 .name
= "LAYOUT_NFSV4_1_FILES",
1292 .owner
= THIS_MODULE
,
1293 .alloc_layout_hdr
= filelayout_alloc_layout_hdr
,
1294 .free_layout_hdr
= filelayout_free_layout_hdr
,
1295 .alloc_lseg
= filelayout_alloc_lseg
,
1296 .free_lseg
= filelayout_free_lseg
,
1297 .pg_read_ops
= &filelayout_pg_read_ops
,
1298 .pg_write_ops
= &filelayout_pg_write_ops
,
1299 .get_ds_info
= &filelayout_get_ds_info
,
1300 .mark_request_commit
= filelayout_mark_request_commit
,
1301 .clear_request_commit
= filelayout_clear_request_commit
,
1302 .scan_commit_lists
= filelayout_scan_commit_lists
,
1303 .recover_commit_reqs
= filelayout_recover_commit_reqs
,
1304 .commit_pagelist
= filelayout_commit_pagelist
,
1305 .read_pagelist
= filelayout_read_pagelist
,
1306 .write_pagelist
= filelayout_write_pagelist
,
1307 .free_deviceid_node
= filelayout_free_deveiceid_node
,
1310 static int __init
nfs4filelayout_init(void)
1312 printk(KERN_INFO
"%s: NFSv4 File Layout Driver Registering...\n",
1314 return pnfs_register_layoutdriver(&filelayout_type
);
1317 static void __exit
nfs4filelayout_exit(void)
1319 printk(KERN_INFO
"%s: NFSv4 File Layout Driver Unregistering...\n",
1321 pnfs_unregister_layoutdriver(&filelayout_type
);
1324 MODULE_ALIAS("nfs-layouttype4-1");
1326 module_init(nfs4filelayout_init
);
1327 module_exit(nfs4filelayout_exit
);