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 pnfs_destroy_layout(NFS_I(inode));
194 rpc_wake_up(&tbl->slot_tbl_waitq);
196 /* RPC connection errors */
204 dprintk("%s DS connection error %d\n", __func__,
206 nfs4_mark_deviceid_unavailable(devid);
207 clear_bit(NFS_INO_LAYOUTCOMMIT, &NFS_I(inode)->flags);
208 _pnfs_return_layout(inode);
209 rpc_wake_up(&tbl->slot_tbl_waitq);
210 nfs4_ds_disconnect(clp);
214 dprintk("%s Retry through MDS. Error %d\n", __func__,
216 return -NFS4ERR_RESET_TO_MDS;
222 rpc_sleep_on(&mds_client->cl_rpcwaitq, task, NULL);
223 if (test_bit(NFS4CLNT_MANAGER_RUNNING, &mds_client->cl_state) == 0)
224 rpc_wake_up_queued_task(&mds_client->cl_rpcwaitq, task);
228 /* NFS_PROTO call done callback routines */
230 static int filelayout_read_done_cb(struct rpc_task *task,
231 struct nfs_read_data *data)
233 struct nfs_pgio_header *hdr = data->header;
236 err = filelayout_async_handle_error(task, data->args.context->state,
237 data->ds_clp, hdr->lseg);
240 case -NFS4ERR_RESET_TO_MDS:
241 filelayout_reset_read(data);
242 return task->tk_status;
244 rpc_restart_call_prepare(task);
252 * We reference the rpc_cred of the first WRITE that triggers the need for
253 * a LAYOUTCOMMIT, and use it to send the layoutcommit compound.
254 * rfc5661 is not clear about which credential should be used.
257 filelayout_set_layoutcommit(struct nfs_write_data *wdata)
259 struct nfs_pgio_header *hdr = wdata->header;
261 if (FILELAYOUT_LSEG(hdr->lseg)->commit_through_mds ||
262 wdata->res.verf->committed == NFS_FILE_SYNC)
265 pnfs_set_layoutcommit(wdata);
266 dprintk("%s ionde %lu pls_end_pos %lu\n", __func__, hdr->inode->i_ino,
267 (unsigned long) NFS_I(hdr->inode)->layout->plh_lwb);
271 filelayout_test_devid_unavailable(struct nfs4_deviceid_node *node)
273 return filelayout_test_devid_invalid(node) ||
274 nfs4_test_deviceid_unavailable(node);
278 filelayout_reset_to_mds(struct pnfs_layout_segment *lseg)
280 struct nfs4_deviceid_node *node = FILELAYOUT_DEVID_NODE(lseg);
282 return filelayout_test_devid_unavailable(node);
286 * Call ops for the async read/write cases
287 * In the case of dense layouts, the offset needs to be reset to its
290 static void filelayout_read_prepare(struct rpc_task *task, void *data)
292 struct nfs_read_data *rdata = data;
294 if (filelayout_reset_to_mds(rdata->header->lseg)) {
295 dprintk("%s task %u reset io to MDS\n", __func__, task->tk_pid);
296 filelayout_reset_read(rdata);
300 rdata->read_done_cb = filelayout_read_done_cb;
302 if (nfs41_setup_sequence(rdata->ds_clp->cl_session,
303 &rdata->args.seq_args, &rdata->res.seq_res,
307 rpc_call_start(task);
310 static void filelayout_read_call_done(struct rpc_task *task, void *data)
312 struct nfs_read_data *rdata = data;
314 dprintk("--> %s task->tk_status %d\n", __func__, task->tk_status);
316 if (test_bit(NFS_IOHDR_REDO, &rdata->header->flags) &&
317 task->tk_status == 0)
320 /* Note this may cause RPC to be resent */
321 rdata->header->mds_ops->rpc_call_done(task, data);
324 static void filelayout_read_count_stats(struct rpc_task *task, void *data)
326 struct nfs_read_data *rdata = data;
328 rpc_count_iostats(task, NFS_SERVER(rdata->header->inode)->client->cl_metrics);
331 static void filelayout_read_release(void *data)
333 struct nfs_read_data *rdata = data;
335 nfs_put_client(rdata->ds_clp);
336 rdata->header->mds_ops->rpc_release(data);
339 static int filelayout_write_done_cb(struct rpc_task *task,
340 struct nfs_write_data *data)
342 struct nfs_pgio_header *hdr = data->header;
345 err = filelayout_async_handle_error(task, data->args.context->state,
346 data->ds_clp, hdr->lseg);
349 case -NFS4ERR_RESET_TO_MDS:
350 filelayout_reset_write(data);
351 return task->tk_status;
353 rpc_restart_call_prepare(task);
357 filelayout_set_layoutcommit(data);
361 /* Fake up some data that will cause nfs_commit_release to retry the writes. */
362 static void prepare_to_resend_writes(struct nfs_commit_data *data)
364 struct nfs_page *first = nfs_list_entry(data->pages.next);
366 data->task.tk_status = 0;
367 memcpy(&data->verf.verifier, &first->wb_verf,
368 sizeof(data->verf.verifier));
369 data->verf.verifier.data[0]++; /* ensure verifier mismatch */
372 static int filelayout_commit_done_cb(struct rpc_task *task,
373 struct nfs_commit_data *data)
377 err = filelayout_async_handle_error(task, NULL, data->ds_clp,
381 case -NFS4ERR_RESET_TO_MDS:
382 prepare_to_resend_writes(data);
385 rpc_restart_call_prepare(task);
392 static void filelayout_write_prepare(struct rpc_task *task, void *data)
394 struct nfs_write_data *wdata = data;
396 if (filelayout_reset_to_mds(wdata->header->lseg)) {
397 dprintk("%s task %u reset io to MDS\n", __func__, task->tk_pid);
398 filelayout_reset_write(wdata);
402 if (nfs41_setup_sequence(wdata->ds_clp->cl_session,
403 &wdata->args.seq_args, &wdata->res.seq_res,
407 rpc_call_start(task);
410 static void filelayout_write_call_done(struct rpc_task *task, void *data)
412 struct nfs_write_data *wdata = data;
414 if (test_bit(NFS_IOHDR_REDO, &wdata->header->flags) &&
415 task->tk_status == 0)
418 /* Note this may cause RPC to be resent */
419 wdata->header->mds_ops->rpc_call_done(task, data);
422 static void filelayout_write_count_stats(struct rpc_task *task, void *data)
424 struct nfs_write_data *wdata = data;
426 rpc_count_iostats(task, NFS_SERVER(wdata->header->inode)->client->cl_metrics);
429 static void filelayout_write_release(void *data)
431 struct nfs_write_data *wdata = data;
433 nfs_put_client(wdata->ds_clp);
434 wdata->header->mds_ops->rpc_release(data);
437 static void filelayout_commit_prepare(struct rpc_task *task, void *data)
439 struct nfs_commit_data *wdata = data;
441 if (nfs41_setup_sequence(wdata->ds_clp->cl_session,
442 &wdata->args.seq_args, &wdata->res.seq_res,
446 rpc_call_start(task);
449 static void filelayout_write_commit_done(struct rpc_task *task, void *data)
451 struct nfs_commit_data *wdata = data;
453 /* Note this may cause RPC to be resent */
454 wdata->mds_ops->rpc_call_done(task, data);
457 static void filelayout_commit_count_stats(struct rpc_task *task, void *data)
459 struct nfs_commit_data *cdata = data;
461 rpc_count_iostats(task, NFS_SERVER(cdata->inode)->client->cl_metrics);
464 static void filelayout_commit_release(void *calldata)
466 struct nfs_commit_data *data = calldata;
468 data->completion_ops->completion(data);
469 pnfs_put_lseg(data->lseg);
470 nfs_put_client(data->ds_clp);
471 nfs_commitdata_release(data);
474 static const struct rpc_call_ops filelayout_read_call_ops = {
475 .rpc_call_prepare = filelayout_read_prepare,
476 .rpc_call_done = filelayout_read_call_done,
477 .rpc_count_stats = filelayout_read_count_stats,
478 .rpc_release = filelayout_read_release,
481 static const struct rpc_call_ops filelayout_write_call_ops = {
482 .rpc_call_prepare = filelayout_write_prepare,
483 .rpc_call_done = filelayout_write_call_done,
484 .rpc_count_stats = filelayout_write_count_stats,
485 .rpc_release = filelayout_write_release,
488 static const struct rpc_call_ops filelayout_commit_call_ops = {
489 .rpc_call_prepare = filelayout_commit_prepare,
490 .rpc_call_done = filelayout_write_commit_done,
491 .rpc_count_stats = filelayout_commit_count_stats,
492 .rpc_release = filelayout_commit_release,
495 static enum pnfs_try_status
496 filelayout_read_pagelist(struct nfs_read_data *data)
498 struct nfs_pgio_header *hdr = data->header;
499 struct pnfs_layout_segment *lseg = hdr->lseg;
500 struct nfs4_pnfs_ds *ds;
501 loff_t offset = data->args.offset;
506 dprintk("--> %s ino %lu pgbase %u req %Zu@%llu\n",
507 __func__, hdr->inode->i_ino,
508 data->args.pgbase, (size_t)data->args.count, offset);
510 /* Retrieve the correct rpc_client for the byte range */
511 j = nfs4_fl_calc_j_index(lseg, offset);
512 idx = nfs4_fl_calc_ds_index(lseg, j);
513 ds = nfs4_fl_prepare_ds(lseg, idx);
515 return PNFS_NOT_ATTEMPTED;
516 dprintk("%s USE DS: %s cl_count %d\n", __func__,
517 ds->ds_remotestr, atomic_read(&ds->ds_clp->cl_count));
519 /* No multipath support. Use first DS */
520 atomic_inc(&ds->ds_clp->cl_count);
521 data->ds_clp = ds->ds_clp;
522 fh = nfs4_fl_select_ds_fh(lseg, j);
526 data->args.offset = filelayout_get_dserver_offset(lseg, offset);
527 data->mds_offset = offset;
529 /* Perform an asynchronous read to ds */
530 status = nfs_initiate_read(ds->ds_clp->cl_rpcclient, data,
531 &filelayout_read_call_ops, RPC_TASK_SOFTCONN);
533 return PNFS_ATTEMPTED;
536 /* Perform async writes. */
537 static enum pnfs_try_status
538 filelayout_write_pagelist(struct nfs_write_data *data, int sync)
540 struct nfs_pgio_header *hdr = data->header;
541 struct pnfs_layout_segment *lseg = hdr->lseg;
542 struct nfs4_pnfs_ds *ds;
543 loff_t offset = data->args.offset;
548 /* Retrieve the correct rpc_client for the byte range */
549 j = nfs4_fl_calc_j_index(lseg, offset);
550 idx = nfs4_fl_calc_ds_index(lseg, j);
551 ds = nfs4_fl_prepare_ds(lseg, idx);
553 return PNFS_NOT_ATTEMPTED;
554 dprintk("%s ino %lu sync %d req %Zu@%llu DS: %s cl_count %d\n",
555 __func__, hdr->inode->i_ino, sync, (size_t) data->args.count,
556 offset, ds->ds_remotestr, atomic_read(&ds->ds_clp->cl_count));
558 data->write_done_cb = filelayout_write_done_cb;
559 atomic_inc(&ds->ds_clp->cl_count);
560 data->ds_clp = ds->ds_clp;
561 fh = nfs4_fl_select_ds_fh(lseg, j);
565 * Get the file offset on the dserver. Set the write offset to
566 * this offset and save the original offset.
568 data->args.offset = filelayout_get_dserver_offset(lseg, offset);
570 /* Perform an asynchronous write */
571 status = nfs_initiate_write(ds->ds_clp->cl_rpcclient, data,
572 &filelayout_write_call_ops, sync,
575 return PNFS_ATTEMPTED;
579 * filelayout_check_layout()
581 * Make sure layout segment parameters are sane WRT the device.
582 * At this point no generic layer initialization of the lseg has occurred,
583 * and nothing has been added to the layout_hdr cache.
587 filelayout_check_layout(struct pnfs_layout_hdr *lo,
588 struct nfs4_filelayout_segment *fl,
589 struct nfs4_layoutget_res *lgr,
590 struct nfs4_deviceid *id,
593 struct nfs4_deviceid_node *d;
594 struct nfs4_file_layout_dsaddr *dsaddr;
595 int status = -EINVAL;
596 struct nfs_server *nfss = NFS_SERVER(lo->plh_inode);
598 dprintk("--> %s\n", __func__);
600 /* FIXME: remove this check when layout segment support is added */
601 if (lgr->range.offset != 0 ||
602 lgr->range.length != NFS4_MAX_UINT64) {
603 dprintk("%s Only whole file layouts supported. Use MDS i/o\n",
608 if (fl->pattern_offset > lgr->range.offset) {
609 dprintk("%s pattern_offset %lld too large\n",
610 __func__, fl->pattern_offset);
614 if (!fl->stripe_unit || fl->stripe_unit % PAGE_SIZE) {
615 dprintk("%s Invalid stripe unit (%u)\n",
616 __func__, fl->stripe_unit);
620 /* find and reference the deviceid */
621 d = nfs4_find_get_deviceid(NFS_SERVER(lo->plh_inode)->pnfs_curr_ld,
622 NFS_SERVER(lo->plh_inode)->nfs_client, id);
624 dsaddr = filelayout_get_device_info(lo->plh_inode, id, gfp_flags);
628 dsaddr = container_of(d, struct nfs4_file_layout_dsaddr, id_node);
629 /* Found deviceid is unavailable */
630 if (filelayout_test_devid_unavailable(&dsaddr->id_node))
635 if (fl->first_stripe_index >= dsaddr->stripe_count) {
636 dprintk("%s Bad first_stripe_index %u\n",
637 __func__, fl->first_stripe_index);
641 if ((fl->stripe_type == STRIPE_SPARSE &&
642 fl->num_fh > 1 && fl->num_fh != dsaddr->ds_num) ||
643 (fl->stripe_type == STRIPE_DENSE &&
644 fl->num_fh != dsaddr->stripe_count)) {
645 dprintk("%s num_fh %u not valid for given packing\n",
646 __func__, fl->num_fh);
650 if (fl->stripe_unit % nfss->rsize || fl->stripe_unit % nfss->wsize) {
651 dprintk("%s Stripe unit (%u) not aligned with rsize %u "
652 "wsize %u\n", __func__, fl->stripe_unit, nfss->rsize,
658 dprintk("--> %s returns %d\n", __func__, status);
661 nfs4_fl_put_deviceid(dsaddr);
665 static void filelayout_free_fh_array(struct nfs4_filelayout_segment *fl)
669 for (i = 0; i < fl->num_fh; i++) {
670 if (!fl->fh_array[i])
672 kfree(fl->fh_array[i]);
679 _filelayout_free_lseg(struct nfs4_filelayout_segment *fl)
681 filelayout_free_fh_array(fl);
686 filelayout_decode_layout(struct pnfs_layout_hdr *flo,
687 struct nfs4_filelayout_segment *fl,
688 struct nfs4_layoutget_res *lgr,
689 struct nfs4_deviceid *id,
692 struct xdr_stream stream;
694 struct page *scratch;
699 dprintk("%s: set_layout_map Begin\n", __func__);
701 scratch = alloc_page(gfp_flags);
705 xdr_init_decode_pages(&stream, &buf, lgr->layoutp->pages, lgr->layoutp->len);
706 xdr_set_scratch_buffer(&stream, page_address(scratch), PAGE_SIZE);
708 /* 20 = ufl_util (4), first_stripe_index (4), pattern_offset (8),
710 p = xdr_inline_decode(&stream, NFS4_DEVICEID4_SIZE + 20);
714 memcpy(id, p, sizeof(*id));
715 p += XDR_QUADLEN(NFS4_DEVICEID4_SIZE);
716 nfs4_print_deviceid(id);
718 nfl_util = be32_to_cpup(p++);
719 if (nfl_util & NFL4_UFLG_COMMIT_THRU_MDS)
720 fl->commit_through_mds = 1;
721 if (nfl_util & NFL4_UFLG_DENSE)
722 fl->stripe_type = STRIPE_DENSE;
724 fl->stripe_type = STRIPE_SPARSE;
725 fl->stripe_unit = nfl_util & ~NFL4_UFLG_MASK;
727 fl->first_stripe_index = be32_to_cpup(p++);
728 p = xdr_decode_hyper(p, &fl->pattern_offset);
729 fl->num_fh = be32_to_cpup(p++);
731 dprintk("%s: nfl_util 0x%X num_fh %u fsi %u po %llu\n",
732 __func__, nfl_util, fl->num_fh, fl->first_stripe_index,
735 /* Note that a zero value for num_fh is legal for STRIPE_SPARSE.
736 * Futher checking is done in filelayout_check_layout */
738 max(NFS4_PNFS_MAX_STRIPE_CNT, NFS4_PNFS_MAX_MULTI_CNT))
741 if (fl->num_fh > 0) {
742 fl->fh_array = kzalloc(fl->num_fh * sizeof(struct nfs_fh *),
748 for (i = 0; i < fl->num_fh; i++) {
749 /* Do we want to use a mempool here? */
750 fl->fh_array[i] = kmalloc(sizeof(struct nfs_fh), gfp_flags);
751 if (!fl->fh_array[i])
754 p = xdr_inline_decode(&stream, 4);
757 fl->fh_array[i]->size = be32_to_cpup(p++);
758 if (sizeof(struct nfs_fh) < fl->fh_array[i]->size) {
759 printk(KERN_ERR "NFS: Too big fh %d received %d\n",
760 i, fl->fh_array[i]->size);
764 p = xdr_inline_decode(&stream, fl->fh_array[i]->size);
767 memcpy(fl->fh_array[i]->data, p, fl->fh_array[i]->size);
768 dprintk("DEBUG: %s: fh len %d\n", __func__,
769 fl->fh_array[i]->size);
772 __free_page(scratch);
776 filelayout_free_fh_array(fl);
778 __free_page(scratch);
783 filelayout_free_lseg(struct pnfs_layout_segment *lseg)
785 struct nfs4_filelayout_segment *fl = FILELAYOUT_LSEG(lseg);
787 dprintk("--> %s\n", __func__);
788 nfs4_fl_put_deviceid(fl->dsaddr);
789 /* This assumes a single RW lseg */
790 if (lseg->pls_range.iomode == IOMODE_RW) {
791 struct nfs4_filelayout *flo;
793 flo = FILELAYOUT_FROM_HDR(lseg->pls_layout);
794 flo->commit_info.nbuckets = 0;
795 kfree(flo->commit_info.buckets);
796 flo->commit_info.buckets = NULL;
798 _filelayout_free_lseg(fl);
802 filelayout_alloc_commit_info(struct pnfs_layout_segment *lseg,
803 struct nfs_commit_info *cinfo,
806 struct nfs4_filelayout_segment *fl = FILELAYOUT_LSEG(lseg);
807 struct pnfs_commit_bucket *buckets;
810 if (fl->commit_through_mds)
812 if (cinfo->ds->nbuckets != 0) {
813 /* This assumes there is only one IOMODE_RW lseg. What
814 * we really want to do is have a layout_hdr level
815 * dictionary of <multipath_list4, fh> keys, each
816 * associated with a struct list_head, populated by calls
817 * to filelayout_write_pagelist().
822 size = (fl->stripe_type == STRIPE_SPARSE) ?
823 fl->dsaddr->ds_num : fl->dsaddr->stripe_count;
825 buckets = kcalloc(size, sizeof(struct pnfs_commit_bucket),
832 spin_lock(cinfo->lock);
833 if (cinfo->ds->nbuckets != 0)
836 cinfo->ds->buckets = buckets;
837 cinfo->ds->nbuckets = size;
838 for (i = 0; i < size; i++) {
839 INIT_LIST_HEAD(&buckets[i].written);
840 INIT_LIST_HEAD(&buckets[i].committing);
843 spin_unlock(cinfo->lock);
848 static struct pnfs_layout_segment *
849 filelayout_alloc_lseg(struct pnfs_layout_hdr *layoutid,
850 struct nfs4_layoutget_res *lgr,
853 struct nfs4_filelayout_segment *fl;
855 struct nfs4_deviceid id;
857 dprintk("--> %s\n", __func__);
858 fl = kzalloc(sizeof(*fl), gfp_flags);
862 rc = filelayout_decode_layout(layoutid, fl, lgr, &id, gfp_flags);
863 if (rc != 0 || filelayout_check_layout(layoutid, fl, lgr, &id, gfp_flags)) {
864 _filelayout_free_lseg(fl);
867 return &fl->generic_hdr;
871 * filelayout_pg_test(). Called by nfs_can_coalesce_requests()
873 * return true : coalesce page
874 * return false : don't coalesce page
877 filelayout_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev,
878 struct nfs_page *req)
880 u64 p_stripe, r_stripe;
883 if (!pnfs_generic_pg_test(pgio, prev, req) ||
884 !nfs_generic_pg_test(pgio, prev, req))
887 p_stripe = (u64)req_offset(prev);
888 r_stripe = (u64)req_offset(req);
889 stripe_unit = FILELAYOUT_LSEG(pgio->pg_lseg)->stripe_unit;
891 do_div(p_stripe, stripe_unit);
892 do_div(r_stripe, stripe_unit);
894 return (p_stripe == r_stripe);
898 filelayout_pg_init_read(struct nfs_pageio_descriptor *pgio,
899 struct nfs_page *req)
901 BUG_ON(pgio->pg_lseg != NULL);
903 if (req->wb_offset != req->wb_pgbase) {
905 * Handling unaligned pages is difficult, because have to
906 * somehow split a req in two in certain cases in the
907 * pg.test code. Avoid this by just not using pnfs
910 nfs_pageio_reset_read_mds(pgio);
913 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
919 /* If no lseg, fall back to read through mds */
920 if (pgio->pg_lseg == NULL)
921 nfs_pageio_reset_read_mds(pgio);
925 filelayout_pg_init_write(struct nfs_pageio_descriptor *pgio,
926 struct nfs_page *req)
928 struct nfs_commit_info cinfo;
931 BUG_ON(pgio->pg_lseg != NULL);
933 if (req->wb_offset != req->wb_pgbase)
935 pgio->pg_lseg = pnfs_update_layout(pgio->pg_inode,
941 /* If no lseg, fall back to write through mds */
942 if (pgio->pg_lseg == NULL)
944 nfs_init_cinfo(&cinfo, pgio->pg_inode, pgio->pg_dreq);
945 status = filelayout_alloc_commit_info(pgio->pg_lseg, &cinfo, GFP_NOFS);
947 pnfs_put_lseg(pgio->pg_lseg);
948 pgio->pg_lseg = NULL;
953 nfs_pageio_reset_write_mds(pgio);
956 static const struct nfs_pageio_ops filelayout_pg_read_ops = {
957 .pg_init = filelayout_pg_init_read,
958 .pg_test = filelayout_pg_test,
959 .pg_doio = pnfs_generic_pg_readpages,
962 static const struct nfs_pageio_ops filelayout_pg_write_ops = {
963 .pg_init = filelayout_pg_init_write,
964 .pg_test = filelayout_pg_test,
965 .pg_doio = pnfs_generic_pg_writepages,
968 static u32 select_bucket_index(struct nfs4_filelayout_segment *fl, u32 j)
970 if (fl->stripe_type == STRIPE_SPARSE)
971 return nfs4_fl_calc_ds_index(&fl->generic_hdr, j);
976 /* The generic layer is about to remove the req from the commit list.
977 * If this will make the bucket empty, it will need to put the lseg reference.
980 filelayout_clear_request_commit(struct nfs_page *req,
981 struct nfs_commit_info *cinfo)
983 struct pnfs_layout_segment *freeme = NULL;
985 spin_lock(cinfo->lock);
986 if (!test_and_clear_bit(PG_COMMIT_TO_DS, &req->wb_flags))
988 cinfo->ds->nwritten--;
989 if (list_is_singular(&req->wb_list)) {
990 struct pnfs_commit_bucket *bucket;
992 bucket = list_first_entry(&req->wb_list,
993 struct pnfs_commit_bucket,
995 freeme = bucket->wlseg;
996 bucket->wlseg = NULL;
999 nfs_request_remove_commit_list(req, cinfo);
1000 spin_unlock(cinfo->lock);
1001 pnfs_put_lseg(freeme);
1004 static struct list_head *
1005 filelayout_choose_commit_list(struct nfs_page *req,
1006 struct pnfs_layout_segment *lseg,
1007 struct nfs_commit_info *cinfo)
1009 struct nfs4_filelayout_segment *fl = FILELAYOUT_LSEG(lseg);
1011 struct list_head *list;
1012 struct pnfs_commit_bucket *buckets;
1014 if (fl->commit_through_mds)
1015 return &cinfo->mds->list;
1017 /* Note that we are calling nfs4_fl_calc_j_index on each page
1018 * that ends up being committed to a data server. An attractive
1019 * alternative is to add a field to nfs_write_data and nfs_page
1020 * to store the value calculated in filelayout_write_pagelist
1021 * and just use that here.
1023 j = nfs4_fl_calc_j_index(lseg, req_offset(req));
1024 i = select_bucket_index(fl, j);
1025 buckets = cinfo->ds->buckets;
1026 list = &buckets[i].written;
1027 if (list_empty(list)) {
1028 /* Non-empty buckets hold a reference on the lseg. That ref
1029 * is normally transferred to the COMMIT call and released
1030 * there. It could also be released if the last req is pulled
1031 * off due to a rewrite, in which case it will be done in
1032 * filelayout_clear_request_commit
1034 buckets[i].wlseg = pnfs_get_lseg(lseg);
1036 set_bit(PG_COMMIT_TO_DS, &req->wb_flags);
1037 cinfo->ds->nwritten++;
1042 filelayout_mark_request_commit(struct nfs_page *req,
1043 struct pnfs_layout_segment *lseg,
1044 struct nfs_commit_info *cinfo)
1046 struct list_head *list;
1048 list = filelayout_choose_commit_list(req, lseg, cinfo);
1049 nfs_request_add_commit_list(req, list, cinfo);
1052 static u32 calc_ds_index_from_commit(struct pnfs_layout_segment *lseg, u32 i)
1054 struct nfs4_filelayout_segment *flseg = FILELAYOUT_LSEG(lseg);
1056 if (flseg->stripe_type == STRIPE_SPARSE)
1059 return nfs4_fl_calc_ds_index(lseg, i);
1062 static struct nfs_fh *
1063 select_ds_fh_from_commit(struct pnfs_layout_segment *lseg, u32 i)
1065 struct nfs4_filelayout_segment *flseg = FILELAYOUT_LSEG(lseg);
1067 if (flseg->stripe_type == STRIPE_SPARSE) {
1068 if (flseg->num_fh == 1)
1070 else if (flseg->num_fh == 0)
1071 /* Use the MDS OPEN fh set in nfs_read_rpcsetup */
1074 return flseg->fh_array[i];
1077 static int filelayout_initiate_commit(struct nfs_commit_data *data, int how)
1079 struct pnfs_layout_segment *lseg = data->lseg;
1080 struct nfs4_pnfs_ds *ds;
1084 idx = calc_ds_index_from_commit(lseg, data->ds_commit_index);
1085 ds = nfs4_fl_prepare_ds(lseg, idx);
1087 prepare_to_resend_writes(data);
1088 filelayout_commit_release(data);
1091 dprintk("%s ino %lu, how %d cl_count %d\n", __func__,
1092 data->inode->i_ino, how, atomic_read(&ds->ds_clp->cl_count));
1093 data->commit_done_cb = filelayout_commit_done_cb;
1094 atomic_inc(&ds->ds_clp->cl_count);
1095 data->ds_clp = ds->ds_clp;
1096 fh = select_ds_fh_from_commit(lseg, data->ds_commit_index);
1099 return nfs_initiate_commit(ds->ds_clp->cl_rpcclient, data,
1100 &filelayout_commit_call_ops, how,
1105 transfer_commit_list(struct list_head *src, struct list_head *dst,
1106 struct nfs_commit_info *cinfo, int max)
1108 struct nfs_page *req, *tmp;
1111 list_for_each_entry_safe(req, tmp, src, wb_list) {
1112 if (!nfs_lock_request(req))
1114 kref_get(&req->wb_kref);
1115 if (cond_resched_lock(cinfo->lock))
1116 list_safe_reset_next(req, tmp, wb_list);
1117 nfs_request_remove_commit_list(req, cinfo);
1118 clear_bit(PG_COMMIT_TO_DS, &req->wb_flags);
1119 nfs_list_add_request(req, dst);
1121 if ((ret == max) && !cinfo->dreq)
1128 filelayout_scan_ds_commit_list(struct pnfs_commit_bucket *bucket,
1129 struct nfs_commit_info *cinfo,
1132 struct list_head *src = &bucket->written;
1133 struct list_head *dst = &bucket->committing;
1136 ret = transfer_commit_list(src, dst, cinfo, max);
1138 cinfo->ds->nwritten -= ret;
1139 cinfo->ds->ncommitting += ret;
1140 bucket->clseg = bucket->wlseg;
1141 if (list_empty(src))
1142 bucket->wlseg = NULL;
1144 pnfs_get_lseg(bucket->clseg);
1149 /* Move reqs from written to committing lists, returning count of number moved.
1150 * Note called with cinfo->lock held.
1152 static int filelayout_scan_commit_lists(struct nfs_commit_info *cinfo,
1157 for (i = 0; i < cinfo->ds->nbuckets && max != 0; i++) {
1158 cnt = filelayout_scan_ds_commit_list(&cinfo->ds->buckets[i],
1166 /* Pull everything off the committing lists and dump into @dst */
1167 static void filelayout_recover_commit_reqs(struct list_head *dst,
1168 struct nfs_commit_info *cinfo)
1170 struct pnfs_commit_bucket *b;
1173 /* NOTE cinfo->lock is NOT held, relying on fact that this is
1174 * only called on single thread per dreq.
1175 * Can't take the lock because need to do pnfs_put_lseg
1177 for (i = 0, b = cinfo->ds->buckets; i < cinfo->ds->nbuckets; i++, b++) {
1178 if (transfer_commit_list(&b->written, dst, cinfo, 0)) {
1179 BUG_ON(!list_empty(&b->written));
1180 pnfs_put_lseg(b->wlseg);
1184 cinfo->ds->nwritten = 0;
1188 alloc_ds_commits(struct nfs_commit_info *cinfo, struct list_head *list)
1190 struct pnfs_ds_commit_info *fl_cinfo;
1191 struct pnfs_commit_bucket *bucket;
1192 struct nfs_commit_data *data;
1194 unsigned int nreq = 0;
1196 fl_cinfo = cinfo->ds;
1197 bucket = fl_cinfo->buckets;
1198 for (i = 0; i < fl_cinfo->nbuckets; i++, bucket++) {
1199 if (list_empty(&bucket->committing))
1201 data = nfs_commitdata_alloc();
1204 data->ds_commit_index = i;
1205 data->lseg = bucket->clseg;
1206 bucket->clseg = NULL;
1207 list_add(&data->pages, list);
1211 /* Clean up on error */
1212 for (j = i; j < fl_cinfo->nbuckets; j++, bucket++) {
1213 if (list_empty(&bucket->committing))
1215 nfs_retry_commit(&bucket->committing, bucket->clseg, cinfo);
1216 pnfs_put_lseg(bucket->clseg);
1217 bucket->clseg = NULL;
1219 /* Caller will clean up entries put on list */
1223 /* This follows nfs_commit_list pretty closely */
1225 filelayout_commit_pagelist(struct inode *inode, struct list_head *mds_pages,
1226 int how, struct nfs_commit_info *cinfo)
1228 struct nfs_commit_data *data, *tmp;
1230 unsigned int nreq = 0;
1232 if (!list_empty(mds_pages)) {
1233 data = nfs_commitdata_alloc();
1236 list_add(&data->pages, &list);
1239 nfs_retry_commit(mds_pages, NULL, cinfo);
1242 nreq += alloc_ds_commits(cinfo, &list);
1245 cinfo->completion_ops->error_cleanup(NFS_I(inode));
1249 atomic_add(nreq, &cinfo->mds->rpcs_out);
1251 list_for_each_entry_safe(data, tmp, &list, pages) {
1252 list_del_init(&data->pages);
1254 nfs_init_commit(data, mds_pages, NULL, cinfo);
1255 nfs_initiate_commit(NFS_CLIENT(inode), data,
1256 data->mds_ops, how, 0);
1258 struct pnfs_commit_bucket *buckets;
1260 buckets = cinfo->ds->buckets;
1261 nfs_init_commit(data, &buckets[data->ds_commit_index].committing, data->lseg, cinfo);
1262 filelayout_initiate_commit(data, how);
1266 cinfo->ds->ncommitting = 0;
1267 return PNFS_ATTEMPTED;
1271 filelayout_free_deveiceid_node(struct nfs4_deviceid_node *d)
1273 nfs4_fl_free_deviceid(container_of(d, struct nfs4_file_layout_dsaddr, id_node));
1276 static struct pnfs_layout_hdr *
1277 filelayout_alloc_layout_hdr(struct inode *inode, gfp_t gfp_flags)
1279 struct nfs4_filelayout *flo;
1281 flo = kzalloc(sizeof(*flo), gfp_flags);
1282 return &flo->generic_hdr;
1286 filelayout_free_layout_hdr(struct pnfs_layout_hdr *lo)
1288 kfree(FILELAYOUT_FROM_HDR(lo));
1291 static struct pnfs_ds_commit_info *
1292 filelayout_get_ds_info(struct inode *inode)
1294 struct pnfs_layout_hdr *layout = NFS_I(inode)->layout;
1299 return &FILELAYOUT_FROM_HDR(layout)->commit_info;
1302 static struct pnfs_layoutdriver_type filelayout_type = {
1303 .id = LAYOUT_NFSV4_1_FILES,
1304 .name = "LAYOUT_NFSV4_1_FILES",
1305 .owner = THIS_MODULE,
1306 .alloc_layout_hdr = filelayout_alloc_layout_hdr,
1307 .free_layout_hdr = filelayout_free_layout_hdr,
1308 .alloc_lseg = filelayout_alloc_lseg,
1309 .free_lseg = filelayout_free_lseg,
1310 .pg_read_ops = &filelayout_pg_read_ops,
1311 .pg_write_ops = &filelayout_pg_write_ops,
1312 .get_ds_info = &filelayout_get_ds_info,
1313 .mark_request_commit = filelayout_mark_request_commit,
1314 .clear_request_commit = filelayout_clear_request_commit,
1315 .scan_commit_lists = filelayout_scan_commit_lists,
1316 .recover_commit_reqs = filelayout_recover_commit_reqs,
1317 .commit_pagelist = filelayout_commit_pagelist,
1318 .read_pagelist = filelayout_read_pagelist,
1319 .write_pagelist = filelayout_write_pagelist,
1320 .free_deviceid_node = filelayout_free_deveiceid_node,
1323 static int __init nfs4filelayout_init(void)
1325 printk(KERN_INFO "%s: NFSv4 File Layout Driver Registering...\n",
1327 return pnfs_register_layoutdriver(&filelayout_type);
1330 static void __exit nfs4filelayout_exit(void)
1332 printk(KERN_INFO "%s: NFSv4 File Layout Driver Unregistering...\n",
1334 pnfs_unregister_layoutdriver(&filelayout_type);
1337 MODULE_ALIAS("nfs-layouttype4-1");
1339 module_init(nfs4filelayout_init);
1340 module_exit(nfs4filelayout_exit);