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>
35 #include "nfs4filelayout.h"
37 #define NFSDBG_FACILITY NFSDBG_PNFS_LD
39 MODULE_LICENSE("GPL");
40 MODULE_AUTHOR("Dean Hildebrand <dhildebz@umich.edu>");
41 MODULE_DESCRIPTION("The NFSv4 file layout driver");
44 filelayout_set_layoutdriver(struct nfs_server *nfss)
46 int status = pnfs_alloc_init_deviceid_cache(nfss->nfs_client,
47 nfs4_fl_free_deviceid_callback);
49 printk(KERN_WARNING "%s: deviceid cache could not be "
50 "initialized\n", __func__);
53 dprintk("%s: deviceid cache has been initialized successfully\n",
58 /* Clear out the layout by destroying its device list */
60 filelayout_clear_layoutdriver(struct nfs_server *nfss)
62 dprintk("--> %s\n", __func__);
64 if (nfss->nfs_client->cl_devid_cache)
65 pnfs_put_deviceid_cache(nfss->nfs_client);
70 filelayout_get_dense_offset(struct nfs4_filelayout_segment *flseg,
73 u32 stripe_width = flseg->stripe_unit * flseg->dsaddr->stripe_count;
76 offset -= flseg->pattern_offset;
78 do_div(tmp, stripe_width);
80 return tmp * flseg->stripe_unit + do_div(offset, flseg->stripe_unit);
83 /* This function is used by the layout driver to calculate the
84 * offset of the file on the dserver based on whether the
85 * layout type is STRIPE_DENSE or STRIPE_SPARSE
88 filelayout_get_dserver_offset(struct pnfs_layout_segment *lseg, loff_t offset)
90 struct nfs4_filelayout_segment *flseg = FILELAYOUT_LSEG(lseg);
92 switch (flseg->stripe_type) {
97 return filelayout_get_dense_offset(flseg, offset);
104 * Call ops for the async read/write cases
105 * In the case of dense layouts, the offset needs to be reset to its
108 static void filelayout_read_prepare(struct rpc_task *task, void *data)
110 struct nfs_read_data *rdata = (struct nfs_read_data *)data;
112 if (nfs41_setup_sequence(rdata->ds_clp->cl_session,
113 &rdata->args.seq_args, &rdata->res.seq_res,
117 rpc_call_start(task);
120 static void filelayout_read_call_done(struct rpc_task *task, void *data)
122 struct nfs_read_data *rdata = (struct nfs_read_data *)data;
124 dprintk("--> %s task->tk_status %d\n", __func__, task->tk_status);
126 /* Note this may cause RPC to be resent */
127 rdata->mds_ops->rpc_call_done(task, data);
130 static void filelayout_read_release(void *data)
132 struct nfs_read_data *rdata = (struct nfs_read_data *)data;
134 rdata->mds_ops->rpc_release(data);
137 struct rpc_call_ops filelayout_read_call_ops = {
138 .rpc_call_prepare = filelayout_read_prepare,
139 .rpc_call_done = filelayout_read_call_done,
140 .rpc_release = filelayout_read_release,
143 static enum pnfs_try_status
144 filelayout_read_pagelist(struct nfs_read_data *data)
146 struct pnfs_layout_segment *lseg = data->lseg;
147 struct nfs4_pnfs_ds *ds;
148 loff_t offset = data->args.offset;
153 dprintk("--> %s ino %lu pgbase %u req %Zu@%llu\n",
154 __func__, data->inode->i_ino,
155 data->args.pgbase, (size_t)data->args.count, offset);
157 /* Retrieve the correct rpc_client for the byte range */
158 j = nfs4_fl_calc_j_index(lseg, offset);
159 idx = nfs4_fl_calc_ds_index(lseg, j);
160 ds = nfs4_fl_prepare_ds(lseg, idx);
162 printk(KERN_ERR "%s: prepare_ds failed, use MDS\n", __func__);
163 return PNFS_NOT_ATTEMPTED;
165 dprintk("%s USE DS:ip %x %hu\n", __func__,
166 ntohl(ds->ds_ip_addr), ntohs(ds->ds_port));
168 /* No multipath support. Use first DS */
169 data->ds_clp = ds->ds_clp;
170 fh = nfs4_fl_select_ds_fh(lseg, j);
174 data->args.offset = filelayout_get_dserver_offset(lseg, offset);
175 data->mds_offset = offset;
177 /* Perform an asynchronous read to ds */
178 status = nfs_initiate_read(data, ds->ds_clp->cl_rpcclient,
179 &filelayout_read_call_ops);
181 return PNFS_ATTEMPTED;
185 * filelayout_check_layout()
187 * Make sure layout segment parameters are sane WRT the device.
188 * At this point no generic layer initialization of the lseg has occurred,
189 * and nothing has been added to the layout_hdr cache.
193 filelayout_check_layout(struct pnfs_layout_hdr *lo,
194 struct nfs4_filelayout_segment *fl,
195 struct nfs4_layoutget_res *lgr,
196 struct nfs4_deviceid *id)
198 struct nfs4_file_layout_dsaddr *dsaddr;
199 int status = -EINVAL;
200 struct nfs_server *nfss = NFS_SERVER(lo->plh_inode);
202 dprintk("--> %s\n", __func__);
204 if (fl->pattern_offset > lgr->range.offset) {
205 dprintk("%s pattern_offset %lld to large\n",
206 __func__, fl->pattern_offset);
210 if (fl->stripe_unit % PAGE_SIZE) {
211 dprintk("%s Stripe unit (%u) not page aligned\n",
212 __func__, fl->stripe_unit);
216 /* find and reference the deviceid */
217 dsaddr = nfs4_fl_find_get_deviceid(nfss->nfs_client, id);
218 if (dsaddr == NULL) {
219 dsaddr = get_device_info(lo->plh_inode, id);
225 if (fl->first_stripe_index < 0 ||
226 fl->first_stripe_index >= dsaddr->stripe_count) {
227 dprintk("%s Bad first_stripe_index %d\n",
228 __func__, fl->first_stripe_index);
232 if ((fl->stripe_type == STRIPE_SPARSE &&
233 fl->num_fh > 1 && fl->num_fh != dsaddr->ds_num) ||
234 (fl->stripe_type == STRIPE_DENSE &&
235 fl->num_fh != dsaddr->stripe_count)) {
236 dprintk("%s num_fh %u not valid for given packing\n",
237 __func__, fl->num_fh);
241 if (fl->stripe_unit % nfss->rsize || fl->stripe_unit % nfss->wsize) {
242 dprintk("%s Stripe unit (%u) not aligned with rsize %u "
243 "wsize %u\n", __func__, fl->stripe_unit, nfss->rsize,
249 dprintk("--> %s returns %d\n", __func__, status);
252 pnfs_put_deviceid(nfss->nfs_client->cl_devid_cache, &dsaddr->deviceid);
256 static void filelayout_free_fh_array(struct nfs4_filelayout_segment *fl)
260 for (i = 0; i < fl->num_fh; i++) {
261 if (!fl->fh_array[i])
263 kfree(fl->fh_array[i]);
270 _filelayout_free_lseg(struct nfs4_filelayout_segment *fl)
272 filelayout_free_fh_array(fl);
277 filelayout_decode_layout(struct pnfs_layout_hdr *flo,
278 struct nfs4_filelayout_segment *fl,
279 struct nfs4_layoutget_res *lgr,
280 struct nfs4_deviceid *id)
282 uint32_t *p = (uint32_t *)lgr->layout.buf;
286 dprintk("%s: set_layout_map Begin\n", __func__);
288 memcpy(id, p, sizeof(*id));
289 p += XDR_QUADLEN(NFS4_DEVICEID4_SIZE);
292 nfl_util = be32_to_cpup(p++);
293 if (nfl_util & NFL4_UFLG_COMMIT_THRU_MDS)
294 fl->commit_through_mds = 1;
295 if (nfl_util & NFL4_UFLG_DENSE)
296 fl->stripe_type = STRIPE_DENSE;
298 fl->stripe_type = STRIPE_SPARSE;
299 fl->stripe_unit = nfl_util & ~NFL4_UFLG_MASK;
301 fl->first_stripe_index = be32_to_cpup(p++);
302 p = xdr_decode_hyper(p, &fl->pattern_offset);
303 fl->num_fh = be32_to_cpup(p++);
305 dprintk("%s: nfl_util 0x%X num_fh %u fsi %u po %llu\n",
306 __func__, nfl_util, fl->num_fh, fl->first_stripe_index,
309 fl->fh_array = kzalloc(fl->num_fh * sizeof(struct nfs_fh *),
314 for (i = 0; i < fl->num_fh; i++) {
315 /* Do we want to use a mempool here? */
316 fl->fh_array[i] = kmalloc(sizeof(struct nfs_fh), GFP_KERNEL);
317 if (!fl->fh_array[i]) {
318 filelayout_free_fh_array(fl);
321 fl->fh_array[i]->size = be32_to_cpup(p++);
322 if (sizeof(struct nfs_fh) < fl->fh_array[i]->size) {
323 printk(KERN_ERR "Too big fh %d received %d\n",
324 i, fl->fh_array[i]->size);
325 filelayout_free_fh_array(fl);
328 memcpy(fl->fh_array[i]->data, p, fl->fh_array[i]->size);
329 p += XDR_QUADLEN(fl->fh_array[i]->size);
330 dprintk("DEBUG: %s: fh len %d\n", __func__,
331 fl->fh_array[i]->size);
337 static struct pnfs_layout_segment *
338 filelayout_alloc_lseg(struct pnfs_layout_hdr *layoutid,
339 struct nfs4_layoutget_res *lgr)
341 struct nfs4_filelayout_segment *fl;
343 struct nfs4_deviceid id;
345 dprintk("--> %s\n", __func__);
346 fl = kzalloc(sizeof(*fl), GFP_KERNEL);
350 rc = filelayout_decode_layout(layoutid, fl, lgr, &id);
351 if (rc != 0 || filelayout_check_layout(layoutid, fl, lgr, &id)) {
352 _filelayout_free_lseg(fl);
355 return &fl->generic_hdr;
359 filelayout_free_lseg(struct pnfs_layout_segment *lseg)
361 struct nfs_server *nfss = NFS_SERVER(lseg->pls_layout->plh_inode);
362 struct nfs4_filelayout_segment *fl = FILELAYOUT_LSEG(lseg);
364 dprintk("--> %s\n", __func__);
365 pnfs_put_deviceid(nfss->nfs_client->cl_devid_cache,
366 &fl->dsaddr->deviceid);
367 _filelayout_free_lseg(fl);
371 * filelayout_pg_test(). Called by nfs_can_coalesce_requests()
373 * return 1 : coalesce page
374 * return 0 : don't coalesce page
377 filelayout_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev,
378 struct nfs_page *req)
380 u64 p_stripe, r_stripe;
385 p_stripe = (u64)prev->wb_index << PAGE_CACHE_SHIFT;
386 r_stripe = (u64)req->wb_index << PAGE_CACHE_SHIFT;
387 stripe_unit = FILELAYOUT_LSEG(pgio->pg_lseg)->stripe_unit;
389 do_div(p_stripe, stripe_unit);
390 do_div(r_stripe, stripe_unit);
392 return (p_stripe == r_stripe);
395 static struct pnfs_layoutdriver_type filelayout_type = {
396 .id = LAYOUT_NFSV4_1_FILES,
397 .name = "LAYOUT_NFSV4_1_FILES",
398 .owner = THIS_MODULE,
399 .set_layoutdriver = filelayout_set_layoutdriver,
400 .clear_layoutdriver = filelayout_clear_layoutdriver,
401 .alloc_lseg = filelayout_alloc_lseg,
402 .free_lseg = filelayout_free_lseg,
403 .pg_test = filelayout_pg_test,
404 .read_pagelist = filelayout_read_pagelist,
407 static int __init nfs4filelayout_init(void)
409 printk(KERN_INFO "%s: NFSv4 File Layout Driver Registering...\n",
411 return pnfs_register_layoutdriver(&filelayout_type);
414 static void __exit nfs4filelayout_exit(void)
416 printk(KERN_INFO "%s: NFSv4 File Layout Driver Unregistering...\n",
418 pnfs_unregister_layoutdriver(&filelayout_type);
421 module_init(nfs4filelayout_init);
422 module_exit(nfs4filelayout_exit);