xref: /linux/fs/nfs/blocklayout/blocklayout.c (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
1 /*
2  *  linux/fs/nfs/blocklayout/blocklayout.c
3  *
4  *  Module for the NFSv4.1 pNFS block layout driver.
5  *
6  *  Copyright (c) 2006 The Regents of the University of Michigan.
7  *  All rights reserved.
8  *
9  *  Andy Adamson <andros@citi.umich.edu>
10  *  Fred Isaman <iisaman@umich.edu>
11  *
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.
20  *
21  * this software is provided as is, without representation from the
22  * university of michigan as to its fitness for any purpose, and without
23  * warranty by the university of michigan of any kind, either express
24  * or implied, including without limitation the implied warranties of
25  * merchantability and fitness for a particular purpose.  the regents
26  * of the university of michigan shall not be liable for any damages,
27  * including special, indirect, incidental, or consequential damages,
28  * with respect to any claim arising out or in connection with the use
29  * of the software, even if it has been or is hereafter advised of the
30  * possibility of such damages.
31  */
32 
33 #include <linux/module.h>
34 #include <linux/init.h>
35 #include <linux/mount.h>
36 #include <linux/namei.h>
37 #include <linux/bio.h>		/* struct bio */
38 #include <linux/prefetch.h>
39 #include <linux/pagevec.h>
40 
41 #include "../pnfs.h"
42 #include "../nfs4session.h"
43 #include "../internal.h"
44 #include "blocklayout.h"
45 
46 #define NFSDBG_FACILITY	NFSDBG_PNFS_LD
47 
48 MODULE_LICENSE("GPL");
49 MODULE_AUTHOR("Andy Adamson <andros@citi.umich.edu>");
50 MODULE_DESCRIPTION("The NFSv4.1 pNFS Block layout driver");
51 
52 static bool is_hole(struct pnfs_block_extent *be)
53 {
54 	switch (be->be_state) {
55 	case PNFS_BLOCK_NONE_DATA:
56 		return true;
57 	case PNFS_BLOCK_INVALID_DATA:
58 		return be->be_tag ? false : true;
59 	default:
60 		return false;
61 	}
62 }
63 
64 /* The data we are handed might be spread across several bios.  We need
65  * to track when the last one is finished.
66  */
67 struct parallel_io {
68 	struct kref refcnt;
69 	void (*pnfs_callback) (void *data);
70 	void *data;
71 };
72 
73 static inline struct parallel_io *alloc_parallel(void *data)
74 {
75 	struct parallel_io *rv;
76 
77 	rv  = kmalloc(sizeof(*rv), GFP_NOFS);
78 	if (rv) {
79 		rv->data = data;
80 		kref_init(&rv->refcnt);
81 	}
82 	return rv;
83 }
84 
85 static inline void get_parallel(struct parallel_io *p)
86 {
87 	kref_get(&p->refcnt);
88 }
89 
90 static void destroy_parallel(struct kref *kref)
91 {
92 	struct parallel_io *p = container_of(kref, struct parallel_io, refcnt);
93 
94 	dprintk("%s enter\n", __func__);
95 	p->pnfs_callback(p->data);
96 	kfree(p);
97 }
98 
99 static inline void put_parallel(struct parallel_io *p)
100 {
101 	kref_put(&p->refcnt, destroy_parallel);
102 }
103 
104 static struct bio *
105 bl_submit_bio(int rw, struct bio *bio)
106 {
107 	if (bio) {
108 		get_parallel(bio->bi_private);
109 		dprintk("%s submitting %s bio %u@%llu\n", __func__,
110 			rw == READ ? "read" : "write", bio->bi_iter.bi_size,
111 			(unsigned long long)bio->bi_iter.bi_sector);
112 		submit_bio(rw, bio);
113 	}
114 	return NULL;
115 }
116 
117 static struct bio *
118 bl_alloc_init_bio(int npg, struct block_device *bdev, sector_t disk_sector,
119 		bio_end_io_t end_io, struct parallel_io *par)
120 {
121 	struct bio *bio;
122 
123 	npg = min(npg, BIO_MAX_PAGES);
124 	bio = bio_alloc(GFP_NOIO, npg);
125 	if (!bio && (current->flags & PF_MEMALLOC)) {
126 		while (!bio && (npg /= 2))
127 			bio = bio_alloc(GFP_NOIO, npg);
128 	}
129 
130 	if (bio) {
131 		bio->bi_iter.bi_sector = disk_sector;
132 		bio->bi_bdev = bdev;
133 		bio->bi_end_io = end_io;
134 		bio->bi_private = par;
135 	}
136 	return bio;
137 }
138 
139 static struct bio *
140 do_add_page_to_bio(struct bio *bio, int npg, int rw, sector_t isect,
141 		struct page *page, struct pnfs_block_dev_map *map,
142 		struct pnfs_block_extent *be, bio_end_io_t end_io,
143 		struct parallel_io *par, unsigned int offset, int *len)
144 {
145 	struct pnfs_block_dev *dev =
146 		container_of(be->be_device, struct pnfs_block_dev, node);
147 	u64 disk_addr, end;
148 
149 	dprintk("%s: npg %d rw %d isect %llu offset %u len %d\n", __func__,
150 		npg, rw, (unsigned long long)isect, offset, *len);
151 
152 	/* translate to device offset */
153 	isect += be->be_v_offset;
154 	isect -= be->be_f_offset;
155 
156 	/* translate to physical disk offset */
157 	disk_addr = (u64)isect << SECTOR_SHIFT;
158 	if (disk_addr < map->start || disk_addr >= map->start + map->len) {
159 		if (!dev->map(dev, disk_addr, map))
160 			return ERR_PTR(-EIO);
161 		bio = bl_submit_bio(rw, bio);
162 	}
163 	disk_addr += map->disk_offset;
164 	disk_addr -= map->start;
165 
166 	/* limit length to what the device mapping allows */
167 	end = disk_addr + *len;
168 	if (end >= map->start + map->len)
169 		*len = map->start + map->len - disk_addr;
170 
171 retry:
172 	if (!bio) {
173 		bio = bl_alloc_init_bio(npg, map->bdev,
174 				disk_addr >> SECTOR_SHIFT, end_io, par);
175 		if (!bio)
176 			return ERR_PTR(-ENOMEM);
177 	}
178 	if (bio_add_page(bio, page, *len, offset) < *len) {
179 		bio = bl_submit_bio(rw, bio);
180 		goto retry;
181 	}
182 	return bio;
183 }
184 
185 static void bl_end_io_read(struct bio *bio)
186 {
187 	struct parallel_io *par = bio->bi_private;
188 
189 	if (bio->bi_error) {
190 		struct nfs_pgio_header *header = par->data;
191 
192 		if (!header->pnfs_error)
193 			header->pnfs_error = -EIO;
194 		pnfs_set_lo_fail(header->lseg);
195 	}
196 
197 	bio_put(bio);
198 	put_parallel(par);
199 }
200 
201 static void bl_read_cleanup(struct work_struct *work)
202 {
203 	struct rpc_task *task;
204 	struct nfs_pgio_header *hdr;
205 	dprintk("%s enter\n", __func__);
206 	task = container_of(work, struct rpc_task, u.tk_work);
207 	hdr = container_of(task, struct nfs_pgio_header, task);
208 	pnfs_ld_read_done(hdr);
209 }
210 
211 static void
212 bl_end_par_io_read(void *data)
213 {
214 	struct nfs_pgio_header *hdr = data;
215 
216 	hdr->task.tk_status = hdr->pnfs_error;
217 	INIT_WORK(&hdr->task.u.tk_work, bl_read_cleanup);
218 	schedule_work(&hdr->task.u.tk_work);
219 }
220 
221 static enum pnfs_try_status
222 bl_read_pagelist(struct nfs_pgio_header *header)
223 {
224 	struct pnfs_block_layout *bl = BLK_LSEG2EXT(header->lseg);
225 	struct pnfs_block_dev_map map = { .start = NFS4_MAX_UINT64 };
226 	struct bio *bio = NULL;
227 	struct pnfs_block_extent be;
228 	sector_t isect, extent_length = 0;
229 	struct parallel_io *par;
230 	loff_t f_offset = header->args.offset;
231 	size_t bytes_left = header->args.count;
232 	unsigned int pg_offset, pg_len;
233 	struct page **pages = header->args.pages;
234 	int pg_index = header->args.pgbase >> PAGE_CACHE_SHIFT;
235 	const bool is_dio = (header->dreq != NULL);
236 	struct blk_plug plug;
237 	int i;
238 
239 	dprintk("%s enter nr_pages %u offset %lld count %u\n", __func__,
240 		header->page_array.npages, f_offset,
241 		(unsigned int)header->args.count);
242 
243 	par = alloc_parallel(header);
244 	if (!par)
245 		return PNFS_NOT_ATTEMPTED;
246 	par->pnfs_callback = bl_end_par_io_read;
247 
248 	blk_start_plug(&plug);
249 
250 	isect = (sector_t) (f_offset >> SECTOR_SHIFT);
251 	/* Code assumes extents are page-aligned */
252 	for (i = pg_index; i < header->page_array.npages; i++) {
253 		if (extent_length <= 0) {
254 			/* We've used up the previous extent */
255 			bio = bl_submit_bio(READ, bio);
256 
257 			/* Get the next one */
258 			if (!ext_tree_lookup(bl, isect, &be, false)) {
259 				header->pnfs_error = -EIO;
260 				goto out;
261 			}
262 			extent_length = be.be_length - (isect - be.be_f_offset);
263 		}
264 
265 		pg_offset = f_offset & ~PAGE_CACHE_MASK;
266 		if (is_dio) {
267 			if (pg_offset + bytes_left > PAGE_CACHE_SIZE)
268 				pg_len = PAGE_CACHE_SIZE - pg_offset;
269 			else
270 				pg_len = bytes_left;
271 		} else {
272 			BUG_ON(pg_offset != 0);
273 			pg_len = PAGE_CACHE_SIZE;
274 		}
275 
276 		isect += (pg_offset >> SECTOR_SHIFT);
277 		extent_length -= (pg_offset >> SECTOR_SHIFT);
278 
279 		if (is_hole(&be)) {
280 			bio = bl_submit_bio(READ, bio);
281 			/* Fill hole w/ zeroes w/o accessing device */
282 			dprintk("%s Zeroing page for hole\n", __func__);
283 			zero_user_segment(pages[i], pg_offset, pg_len);
284 
285 			/* invalidate map */
286 			map.start = NFS4_MAX_UINT64;
287 		} else {
288 			bio = do_add_page_to_bio(bio,
289 						 header->page_array.npages - i,
290 						 READ,
291 						 isect, pages[i], &map, &be,
292 						 bl_end_io_read, par,
293 						 pg_offset, &pg_len);
294 			if (IS_ERR(bio)) {
295 				header->pnfs_error = PTR_ERR(bio);
296 				bio = NULL;
297 				goto out;
298 			}
299 		}
300 		isect += (pg_len >> SECTOR_SHIFT);
301 		extent_length -= (pg_len >> SECTOR_SHIFT);
302 		f_offset += pg_len;
303 		bytes_left -= pg_len;
304 	}
305 	if ((isect << SECTOR_SHIFT) >= header->inode->i_size) {
306 		header->res.eof = 1;
307 		header->res.count = header->inode->i_size - header->args.offset;
308 	} else {
309 		header->res.count = (isect << SECTOR_SHIFT) - header->args.offset;
310 	}
311 out:
312 	bl_submit_bio(READ, bio);
313 	blk_finish_plug(&plug);
314 	put_parallel(par);
315 	return PNFS_ATTEMPTED;
316 }
317 
318 static void bl_end_io_write(struct bio *bio)
319 {
320 	struct parallel_io *par = bio->bi_private;
321 	struct nfs_pgio_header *header = par->data;
322 
323 	if (bio->bi_error) {
324 		if (!header->pnfs_error)
325 			header->pnfs_error = -EIO;
326 		pnfs_set_lo_fail(header->lseg);
327 	}
328 	bio_put(bio);
329 	put_parallel(par);
330 }
331 
332 /* Function scheduled for call during bl_end_par_io_write,
333  * it marks sectors as written and extends the commitlist.
334  */
335 static void bl_write_cleanup(struct work_struct *work)
336 {
337 	struct rpc_task *task = container_of(work, struct rpc_task, u.tk_work);
338 	struct nfs_pgio_header *hdr =
339 			container_of(task, struct nfs_pgio_header, task);
340 
341 	dprintk("%s enter\n", __func__);
342 
343 	if (likely(!hdr->pnfs_error)) {
344 		struct pnfs_block_layout *bl = BLK_LSEG2EXT(hdr->lseg);
345 		u64 start = hdr->args.offset & (loff_t)PAGE_CACHE_MASK;
346 		u64 end = (hdr->args.offset + hdr->args.count +
347 			PAGE_CACHE_SIZE - 1) & (loff_t)PAGE_CACHE_MASK;
348 
349 		ext_tree_mark_written(bl, start >> SECTOR_SHIFT,
350 					(end - start) >> SECTOR_SHIFT);
351 	}
352 
353 	pnfs_ld_write_done(hdr);
354 }
355 
356 /* Called when last of bios associated with a bl_write_pagelist call finishes */
357 static void bl_end_par_io_write(void *data)
358 {
359 	struct nfs_pgio_header *hdr = data;
360 
361 	hdr->task.tk_status = hdr->pnfs_error;
362 	hdr->verf.committed = NFS_FILE_SYNC;
363 	INIT_WORK(&hdr->task.u.tk_work, bl_write_cleanup);
364 	schedule_work(&hdr->task.u.tk_work);
365 }
366 
367 static enum pnfs_try_status
368 bl_write_pagelist(struct nfs_pgio_header *header, int sync)
369 {
370 	struct pnfs_block_layout *bl = BLK_LSEG2EXT(header->lseg);
371 	struct pnfs_block_dev_map map = { .start = NFS4_MAX_UINT64 };
372 	struct bio *bio = NULL;
373 	struct pnfs_block_extent be;
374 	sector_t isect, extent_length = 0;
375 	struct parallel_io *par = NULL;
376 	loff_t offset = header->args.offset;
377 	size_t count = header->args.count;
378 	struct page **pages = header->args.pages;
379 	int pg_index = header->args.pgbase >> PAGE_CACHE_SHIFT;
380 	unsigned int pg_len;
381 	struct blk_plug plug;
382 	int i;
383 
384 	dprintk("%s enter, %Zu@%lld\n", __func__, count, offset);
385 
386 	/* At this point, header->page_aray is a (sequential) list of nfs_pages.
387 	 * We want to write each, and if there is an error set pnfs_error
388 	 * to have it redone using nfs.
389 	 */
390 	par = alloc_parallel(header);
391 	if (!par)
392 		return PNFS_NOT_ATTEMPTED;
393 	par->pnfs_callback = bl_end_par_io_write;
394 
395 	blk_start_plug(&plug);
396 
397 	/* we always write out the whole page */
398 	offset = offset & (loff_t)PAGE_CACHE_MASK;
399 	isect = offset >> SECTOR_SHIFT;
400 
401 	for (i = pg_index; i < header->page_array.npages; i++) {
402 		if (extent_length <= 0) {
403 			/* We've used up the previous extent */
404 			bio = bl_submit_bio(WRITE, bio);
405 			/* Get the next one */
406 			if (!ext_tree_lookup(bl, isect, &be, true)) {
407 				header->pnfs_error = -EINVAL;
408 				goto out;
409 			}
410 
411 			extent_length = be.be_length - (isect - be.be_f_offset);
412 		}
413 
414 		pg_len = PAGE_CACHE_SIZE;
415 		bio = do_add_page_to_bio(bio, header->page_array.npages - i,
416 					 WRITE, isect, pages[i], &map, &be,
417 					 bl_end_io_write, par,
418 					 0, &pg_len);
419 		if (IS_ERR(bio)) {
420 			header->pnfs_error = PTR_ERR(bio);
421 			bio = NULL;
422 			goto out;
423 		}
424 
425 		offset += pg_len;
426 		count -= pg_len;
427 		isect += (pg_len >> SECTOR_SHIFT);
428 		extent_length -= (pg_len >> SECTOR_SHIFT);
429 	}
430 
431 	header->res.count = header->args.count;
432 out:
433 	bl_submit_bio(WRITE, bio);
434 	blk_finish_plug(&plug);
435 	put_parallel(par);
436 	return PNFS_ATTEMPTED;
437 }
438 
439 static void bl_free_layout_hdr(struct pnfs_layout_hdr *lo)
440 {
441 	struct pnfs_block_layout *bl = BLK_LO2EXT(lo);
442 	int err;
443 
444 	dprintk("%s enter\n", __func__);
445 
446 	err = ext_tree_remove(bl, true, 0, LLONG_MAX);
447 	WARN_ON(err);
448 
449 	kfree(bl);
450 }
451 
452 static struct pnfs_layout_hdr *bl_alloc_layout_hdr(struct inode *inode,
453 						   gfp_t gfp_flags)
454 {
455 	struct pnfs_block_layout *bl;
456 
457 	dprintk("%s enter\n", __func__);
458 	bl = kzalloc(sizeof(*bl), gfp_flags);
459 	if (!bl)
460 		return NULL;
461 
462 	bl->bl_ext_rw = RB_ROOT;
463 	bl->bl_ext_ro = RB_ROOT;
464 	spin_lock_init(&bl->bl_ext_lock);
465 
466 	return &bl->bl_layout;
467 }
468 
469 static void bl_free_lseg(struct pnfs_layout_segment *lseg)
470 {
471 	dprintk("%s enter\n", __func__);
472 	kfree(lseg);
473 }
474 
475 /* Tracks info needed to ensure extents in layout obey constraints of spec */
476 struct layout_verification {
477 	u32 mode;	/* R or RW */
478 	u64 start;	/* Expected start of next non-COW extent */
479 	u64 inval;	/* Start of INVAL coverage */
480 	u64 cowread;	/* End of COW read coverage */
481 };
482 
483 /* Verify the extent meets the layout requirements of the pnfs-block draft,
484  * section 2.3.1.
485  */
486 static int verify_extent(struct pnfs_block_extent *be,
487 			 struct layout_verification *lv)
488 {
489 	if (lv->mode == IOMODE_READ) {
490 		if (be->be_state == PNFS_BLOCK_READWRITE_DATA ||
491 		    be->be_state == PNFS_BLOCK_INVALID_DATA)
492 			return -EIO;
493 		if (be->be_f_offset != lv->start)
494 			return -EIO;
495 		lv->start += be->be_length;
496 		return 0;
497 	}
498 	/* lv->mode == IOMODE_RW */
499 	if (be->be_state == PNFS_BLOCK_READWRITE_DATA) {
500 		if (be->be_f_offset != lv->start)
501 			return -EIO;
502 		if (lv->cowread > lv->start)
503 			return -EIO;
504 		lv->start += be->be_length;
505 		lv->inval = lv->start;
506 		return 0;
507 	} else if (be->be_state == PNFS_BLOCK_INVALID_DATA) {
508 		if (be->be_f_offset != lv->start)
509 			return -EIO;
510 		lv->start += be->be_length;
511 		return 0;
512 	} else if (be->be_state == PNFS_BLOCK_READ_DATA) {
513 		if (be->be_f_offset > lv->start)
514 			return -EIO;
515 		if (be->be_f_offset < lv->inval)
516 			return -EIO;
517 		if (be->be_f_offset < lv->cowread)
518 			return -EIO;
519 		/* It looks like you might want to min this with lv->start,
520 		 * but you really don't.
521 		 */
522 		lv->inval = lv->inval + be->be_length;
523 		lv->cowread = be->be_f_offset + be->be_length;
524 		return 0;
525 	} else
526 		return -EIO;
527 }
528 
529 static int decode_sector_number(__be32 **rp, sector_t *sp)
530 {
531 	uint64_t s;
532 
533 	*rp = xdr_decode_hyper(*rp, &s);
534 	if (s & 0x1ff) {
535 		printk(KERN_WARNING "NFS: %s: sector not aligned\n", __func__);
536 		return -1;
537 	}
538 	*sp = s >> SECTOR_SHIFT;
539 	return 0;
540 }
541 
542 static int
543 bl_alloc_extent(struct xdr_stream *xdr, struct pnfs_layout_hdr *lo,
544 		struct layout_verification *lv, struct list_head *extents,
545 		gfp_t gfp_mask)
546 {
547 	struct pnfs_block_extent *be;
548 	struct nfs4_deviceid id;
549 	int error;
550 	__be32 *p;
551 
552 	p = xdr_inline_decode(xdr, 28 + NFS4_DEVICEID4_SIZE);
553 	if (!p)
554 		return -EIO;
555 
556 	be = kzalloc(sizeof(*be), GFP_NOFS);
557 	if (!be)
558 		return -ENOMEM;
559 
560 	memcpy(&id, p, NFS4_DEVICEID4_SIZE);
561 	p += XDR_QUADLEN(NFS4_DEVICEID4_SIZE);
562 
563 	error = -EIO;
564 	be->be_device = nfs4_find_get_deviceid(NFS_SERVER(lo->plh_inode), &id,
565 						lo->plh_lc_cred, gfp_mask);
566 	if (!be->be_device)
567 		goto out_free_be;
568 
569 	/*
570 	 * The next three values are read in as bytes, but stored in the
571 	 * extent structure in 512-byte granularity.
572 	 */
573 	if (decode_sector_number(&p, &be->be_f_offset) < 0)
574 		goto out_put_deviceid;
575 	if (decode_sector_number(&p, &be->be_length) < 0)
576 		goto out_put_deviceid;
577 	if (decode_sector_number(&p, &be->be_v_offset) < 0)
578 		goto out_put_deviceid;
579 	be->be_state = be32_to_cpup(p++);
580 
581 	error = verify_extent(be, lv);
582 	if (error) {
583 		dprintk("%s: extent verification failed\n", __func__);
584 		goto out_put_deviceid;
585 	}
586 
587 	list_add_tail(&be->be_list, extents);
588 	return 0;
589 
590 out_put_deviceid:
591 	nfs4_put_deviceid_node(be->be_device);
592 out_free_be:
593 	kfree(be);
594 	return error;
595 }
596 
597 static struct pnfs_layout_segment *
598 bl_alloc_lseg(struct pnfs_layout_hdr *lo, struct nfs4_layoutget_res *lgr,
599 		gfp_t gfp_mask)
600 {
601 	struct layout_verification lv = {
602 		.mode = lgr->range.iomode,
603 		.start = lgr->range.offset >> SECTOR_SHIFT,
604 		.inval = lgr->range.offset >> SECTOR_SHIFT,
605 		.cowread = lgr->range.offset >> SECTOR_SHIFT,
606 	};
607 	struct pnfs_block_layout *bl = BLK_LO2EXT(lo);
608 	struct pnfs_layout_segment *lseg;
609 	struct xdr_buf buf;
610 	struct xdr_stream xdr;
611 	struct page *scratch;
612 	int status, i;
613 	uint32_t count;
614 	__be32 *p;
615 	LIST_HEAD(extents);
616 
617 	dprintk("---> %s\n", __func__);
618 
619 	lseg = kzalloc(sizeof(*lseg), gfp_mask);
620 	if (!lseg)
621 		return ERR_PTR(-ENOMEM);
622 
623 	status = -ENOMEM;
624 	scratch = alloc_page(gfp_mask);
625 	if (!scratch)
626 		goto out;
627 
628 	xdr_init_decode_pages(&xdr, &buf,
629 			lgr->layoutp->pages, lgr->layoutp->len);
630 	xdr_set_scratch_buffer(&xdr, page_address(scratch), PAGE_SIZE);
631 
632 	status = -EIO;
633 	p = xdr_inline_decode(&xdr, 4);
634 	if (unlikely(!p))
635 		goto out_free_scratch;
636 
637 	count = be32_to_cpup(p++);
638 	dprintk("%s: number of extents %d\n", __func__, count);
639 
640 	/*
641 	 * Decode individual extents, putting them in temporary staging area
642 	 * until whole layout is decoded to make error recovery easier.
643 	 */
644 	for (i = 0; i < count; i++) {
645 		status = bl_alloc_extent(&xdr, lo, &lv, &extents, gfp_mask);
646 		if (status)
647 			goto process_extents;
648 	}
649 
650 	if (lgr->range.offset + lgr->range.length !=
651 			lv.start << SECTOR_SHIFT) {
652 		dprintk("%s Final length mismatch\n", __func__);
653 		status = -EIO;
654 		goto process_extents;
655 	}
656 
657 	if (lv.start < lv.cowread) {
658 		dprintk("%s Final uncovered COW extent\n", __func__);
659 		status = -EIO;
660 	}
661 
662 process_extents:
663 	while (!list_empty(&extents)) {
664 		struct pnfs_block_extent *be =
665 			list_first_entry(&extents, struct pnfs_block_extent,
666 					 be_list);
667 		list_del(&be->be_list);
668 
669 		if (!status)
670 			status = ext_tree_insert(bl, be);
671 
672 		if (status) {
673 			nfs4_put_deviceid_node(be->be_device);
674 			kfree(be);
675 		}
676 	}
677 
678 out_free_scratch:
679 	__free_page(scratch);
680 out:
681 	dprintk("%s returns %d\n", __func__, status);
682 	if (status) {
683 		kfree(lseg);
684 		return ERR_PTR(status);
685 	}
686 	return lseg;
687 }
688 
689 static void
690 bl_return_range(struct pnfs_layout_hdr *lo,
691 		struct pnfs_layout_range *range)
692 {
693 	struct pnfs_block_layout *bl = BLK_LO2EXT(lo);
694 	sector_t offset = range->offset >> SECTOR_SHIFT, end;
695 
696 	if (range->offset % 8) {
697 		dprintk("%s: offset %lld not block size aligned\n",
698 			__func__, range->offset);
699 		return;
700 	}
701 
702 	if (range->length != NFS4_MAX_UINT64) {
703 		if (range->length % 8) {
704 			dprintk("%s: length %lld not block size aligned\n",
705 				__func__, range->length);
706 			return;
707 		}
708 
709 		end = offset + (range->length >> SECTOR_SHIFT);
710 	} else {
711 		end = round_down(NFS4_MAX_UINT64, PAGE_SIZE);
712 	}
713 
714 	ext_tree_remove(bl, range->iomode & IOMODE_RW, offset, end);
715 }
716 
717 static int
718 bl_prepare_layoutcommit(struct nfs4_layoutcommit_args *arg)
719 {
720 	return ext_tree_prepare_commit(arg);
721 }
722 
723 static void
724 bl_cleanup_layoutcommit(struct nfs4_layoutcommit_data *lcdata)
725 {
726 	ext_tree_mark_committed(&lcdata->args, lcdata->res.status);
727 }
728 
729 static int
730 bl_set_layoutdriver(struct nfs_server *server, const struct nfs_fh *fh)
731 {
732 	dprintk("%s enter\n", __func__);
733 
734 	if (server->pnfs_blksize == 0) {
735 		dprintk("%s Server did not return blksize\n", __func__);
736 		return -EINVAL;
737 	}
738 	if (server->pnfs_blksize > PAGE_SIZE) {
739 		printk(KERN_ERR "%s: pNFS blksize %d not supported.\n",
740 			__func__, server->pnfs_blksize);
741 		return -EINVAL;
742 	}
743 
744 	return 0;
745 }
746 
747 static bool
748 is_aligned_req(struct nfs_pageio_descriptor *pgio,
749 		struct nfs_page *req, unsigned int alignment)
750 {
751 	/*
752 	 * Always accept buffered writes, higher layers take care of the
753 	 * right alignment.
754 	 */
755 	if (pgio->pg_dreq == NULL)
756 		return true;
757 
758 	if (!IS_ALIGNED(req->wb_offset, alignment))
759 		return false;
760 
761 	if (IS_ALIGNED(req->wb_bytes, alignment))
762 		return true;
763 
764 	if (req_offset(req) + req->wb_bytes == i_size_read(pgio->pg_inode)) {
765 		/*
766 		 * If the write goes up to the inode size, just write
767 		 * the full page.  Data past the inode size is
768 		 * guaranteed to be zeroed by the higher level client
769 		 * code, and this behaviour is mandated by RFC 5663
770 		 * section 2.3.2.
771 		 */
772 		return true;
773 	}
774 
775 	return false;
776 }
777 
778 static void
779 bl_pg_init_read(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
780 {
781 	if (!is_aligned_req(pgio, req, SECTOR_SIZE)) {
782 		nfs_pageio_reset_read_mds(pgio);
783 		return;
784 	}
785 
786 	pnfs_generic_pg_init_read(pgio, req);
787 }
788 
789 /*
790  * Return 0 if @req cannot be coalesced into @pgio, otherwise return the number
791  * of bytes (maximum @req->wb_bytes) that can be coalesced.
792  */
793 static size_t
794 bl_pg_test_read(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev,
795 		struct nfs_page *req)
796 {
797 	if (!is_aligned_req(pgio, req, SECTOR_SIZE))
798 		return 0;
799 	return pnfs_generic_pg_test(pgio, prev, req);
800 }
801 
802 /*
803  * Return the number of contiguous bytes for a given inode
804  * starting at page frame idx.
805  */
806 static u64 pnfs_num_cont_bytes(struct inode *inode, pgoff_t idx)
807 {
808 	struct address_space *mapping = inode->i_mapping;
809 	pgoff_t end;
810 
811 	/* Optimize common case that writes from 0 to end of file */
812 	end = DIV_ROUND_UP(i_size_read(inode), PAGE_CACHE_SIZE);
813 	if (end != inode->i_mapping->nrpages) {
814 		rcu_read_lock();
815 		end = page_cache_next_hole(mapping, idx + 1, ULONG_MAX);
816 		rcu_read_unlock();
817 	}
818 
819 	if (!end)
820 		return i_size_read(inode) - (idx << PAGE_CACHE_SHIFT);
821 	else
822 		return (end - idx) << PAGE_CACHE_SHIFT;
823 }
824 
825 static void
826 bl_pg_init_write(struct nfs_pageio_descriptor *pgio, struct nfs_page *req)
827 {
828 	u64 wb_size;
829 
830 	if (!is_aligned_req(pgio, req, PAGE_SIZE)) {
831 		nfs_pageio_reset_write_mds(pgio);
832 		return;
833 	}
834 
835 	if (pgio->pg_dreq == NULL)
836 		wb_size = pnfs_num_cont_bytes(pgio->pg_inode,
837 					      req->wb_index);
838 	else
839 		wb_size = nfs_dreq_bytes_left(pgio->pg_dreq);
840 
841 	pnfs_generic_pg_init_write(pgio, req, wb_size);
842 }
843 
844 /*
845  * Return 0 if @req cannot be coalesced into @pgio, otherwise return the number
846  * of bytes (maximum @req->wb_bytes) that can be coalesced.
847  */
848 static size_t
849 bl_pg_test_write(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev,
850 		 struct nfs_page *req)
851 {
852 	if (!is_aligned_req(pgio, req, PAGE_SIZE))
853 		return 0;
854 	return pnfs_generic_pg_test(pgio, prev, req);
855 }
856 
857 static const struct nfs_pageio_ops bl_pg_read_ops = {
858 	.pg_init = bl_pg_init_read,
859 	.pg_test = bl_pg_test_read,
860 	.pg_doio = pnfs_generic_pg_readpages,
861 	.pg_cleanup = pnfs_generic_pg_cleanup,
862 };
863 
864 static const struct nfs_pageio_ops bl_pg_write_ops = {
865 	.pg_init = bl_pg_init_write,
866 	.pg_test = bl_pg_test_write,
867 	.pg_doio = pnfs_generic_pg_writepages,
868 	.pg_cleanup = pnfs_generic_pg_cleanup,
869 };
870 
871 static struct pnfs_layoutdriver_type blocklayout_type = {
872 	.id				= LAYOUT_BLOCK_VOLUME,
873 	.name				= "LAYOUT_BLOCK_VOLUME",
874 	.owner				= THIS_MODULE,
875 	.flags				= PNFS_LAYOUTRET_ON_SETATTR |
876 					  PNFS_READ_WHOLE_PAGE,
877 	.read_pagelist			= bl_read_pagelist,
878 	.write_pagelist			= bl_write_pagelist,
879 	.alloc_layout_hdr		= bl_alloc_layout_hdr,
880 	.free_layout_hdr		= bl_free_layout_hdr,
881 	.alloc_lseg			= bl_alloc_lseg,
882 	.free_lseg			= bl_free_lseg,
883 	.return_range			= bl_return_range,
884 	.prepare_layoutcommit		= bl_prepare_layoutcommit,
885 	.cleanup_layoutcommit		= bl_cleanup_layoutcommit,
886 	.set_layoutdriver		= bl_set_layoutdriver,
887 	.alloc_deviceid_node		= bl_alloc_deviceid_node,
888 	.free_deviceid_node		= bl_free_deviceid_node,
889 	.pg_read_ops			= &bl_pg_read_ops,
890 	.pg_write_ops			= &bl_pg_write_ops,
891 	.sync				= pnfs_generic_sync,
892 };
893 
894 static int __init nfs4blocklayout_init(void)
895 {
896 	int ret;
897 
898 	dprintk("%s: NFSv4 Block Layout Driver Registering...\n", __func__);
899 
900 	ret = pnfs_register_layoutdriver(&blocklayout_type);
901 	if (ret)
902 		goto out;
903 	ret = bl_init_pipefs();
904 	if (ret)
905 		goto out_unregister;
906 	return 0;
907 
908 out_unregister:
909 	pnfs_unregister_layoutdriver(&blocklayout_type);
910 out:
911 	return ret;
912 }
913 
914 static void __exit nfs4blocklayout_exit(void)
915 {
916 	dprintk("%s: NFSv4 Block Layout Driver Unregistering...\n",
917 	       __func__);
918 
919 	bl_cleanup_pipefs();
920 	pnfs_unregister_layoutdriver(&blocklayout_type);
921 }
922 
923 MODULE_ALIAS("nfs-layouttype4-3");
924 
925 module_init(nfs4blocklayout_init);
926 module_exit(nfs4blocklayout_exit);
927