xref: /linux/fs/nfs/localio.c (revision 3af870aedbff10bfed220e280b57a405e972229f)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * NFS client support for local clients to bypass network stack
4  *
5  * Copyright (C) 2014 Weston Andros Adamson <dros@primarydata.com>
6  * Copyright (C) 2019 Trond Myklebust <trond.myklebust@hammerspace.com>
7  * Copyright (C) 2024 Mike Snitzer <snitzer@hammerspace.com>
8  * Copyright (C) 2024 NeilBrown <neilb@suse.de>
9  */
10 
11 #include <linux/module.h>
12 #include <linux/errno.h>
13 #include <linux/vfs.h>
14 #include <linux/file.h>
15 #include <linux/inet.h>
16 #include <linux/sunrpc/addr.h>
17 #include <linux/inetdevice.h>
18 #include <net/addrconf.h>
19 #include <linux/nfs_common.h>
20 #include <linux/nfslocalio.h>
21 #include <linux/bvec.h>
22 
23 #include <linux/nfs.h>
24 #include <linux/nfs_fs.h>
25 #include <linux/nfs_xdr.h>
26 
27 #include "internal.h"
28 #include "pnfs.h"
29 #include "nfstrace.h"
30 
31 #define NFSDBG_FACILITY		NFSDBG_VFS
32 
33 #define NFSLOCAL_MAX_IOS	3
34 
35 struct nfs_local_kiocb {
36 	struct kiocb		kiocb;
37 	struct bio_vec		*bvec;
38 	struct nfs_pgio_header	*hdr;
39 	struct work_struct	work;
40 	void (*aio_complete_work)(struct work_struct *);
41 	struct nfsd_file	*localio;
42 	/* Begin mostly DIO-specific members */
43 	size_t                  end_len;
44 	short int		end_iter_index;
45 	atomic_t		n_iters;
46 	bool			iter_is_dio_aligned[NFSLOCAL_MAX_IOS];
47 	struct iov_iter		iters[NFSLOCAL_MAX_IOS] ____cacheline_aligned;
48 	/* End mostly DIO-specific members */
49 };
50 
51 struct nfs_local_fsync_ctx {
52 	struct nfsd_file	*localio;
53 	struct nfs_commit_data	*data;
54 	struct work_struct	work;
55 	struct completion	*done;
56 };
57 
58 static bool localio_enabled __read_mostly = true;
59 module_param(localio_enabled, bool, 0644);
60 
nfs_client_is_local(const struct nfs_client * clp)61 static inline bool nfs_client_is_local(const struct nfs_client *clp)
62 {
63 	return !!rcu_access_pointer(clp->cl_uuid.net);
64 }
65 
nfs_server_is_local(const struct nfs_client * clp)66 bool nfs_server_is_local(const struct nfs_client *clp)
67 {
68 	return nfs_client_is_local(clp) && localio_enabled;
69 }
70 EXPORT_SYMBOL_GPL(nfs_server_is_local);
71 
72 /*
73  * UUID_IS_LOCAL XDR functions
74  */
75 
localio_xdr_enc_uuidargs(struct rpc_rqst * req,struct xdr_stream * xdr,const void * data)76 static void localio_xdr_enc_uuidargs(struct rpc_rqst *req,
77 				     struct xdr_stream *xdr,
78 				     const void *data)
79 {
80 	const u8 *uuid = data;
81 
82 	encode_opaque_fixed(xdr, uuid, UUID_SIZE);
83 }
84 
localio_xdr_dec_uuidres(struct rpc_rqst * req,struct xdr_stream * xdr,void * result)85 static int localio_xdr_dec_uuidres(struct rpc_rqst *req,
86 				   struct xdr_stream *xdr,
87 				   void *result)
88 {
89 	/* void return */
90 	return 0;
91 }
92 
93 static const struct rpc_procinfo nfs_localio_procedures[] = {
94 	[LOCALIOPROC_UUID_IS_LOCAL] = {
95 		.p_proc = LOCALIOPROC_UUID_IS_LOCAL,
96 		.p_encode = localio_xdr_enc_uuidargs,
97 		.p_decode = localio_xdr_dec_uuidres,
98 		.p_arglen = XDR_QUADLEN(UUID_SIZE),
99 		.p_replen = 0,
100 		.p_statidx = LOCALIOPROC_UUID_IS_LOCAL,
101 		.p_name = "UUID_IS_LOCAL",
102 	},
103 };
104 
105 static unsigned int nfs_localio_counts[ARRAY_SIZE(nfs_localio_procedures)];
106 static const struct rpc_version nfslocalio_version1 = {
107 	.number			= 1,
108 	.nrprocs		= ARRAY_SIZE(nfs_localio_procedures),
109 	.procs			= nfs_localio_procedures,
110 	.counts			= nfs_localio_counts,
111 };
112 
113 static const struct rpc_version *nfslocalio_version[] = {
114        [1]			= &nfslocalio_version1,
115 };
116 
117 extern const struct rpc_program nfslocalio_program;
118 static struct rpc_stat		nfslocalio_rpcstat = { &nfslocalio_program };
119 
120 const struct rpc_program nfslocalio_program = {
121 	.name			= "nfslocalio",
122 	.number			= NFS_LOCALIO_PROGRAM,
123 	.nrvers			= ARRAY_SIZE(nfslocalio_version),
124 	.version		= nfslocalio_version,
125 	.stats			= &nfslocalio_rpcstat,
126 };
127 
128 /*
129  * nfs_init_localioclient - Initialise an NFS localio client connection
130  */
nfs_init_localioclient(struct nfs_client * clp)131 static struct rpc_clnt *nfs_init_localioclient(struct nfs_client *clp)
132 {
133 	struct rpc_clnt *rpcclient_localio;
134 
135 	rpcclient_localio = rpc_bind_new_program(clp->cl_rpcclient,
136 						 &nfslocalio_program, 1);
137 
138 	dprintk_rcu("%s: server (%s) %s NFS LOCALIO.\n",
139 		__func__, rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_ADDR),
140 		(IS_ERR(rpcclient_localio) ? "does not support" : "supports"));
141 
142 	return rpcclient_localio;
143 }
144 
nfs_server_uuid_is_local(struct nfs_client * clp)145 static bool nfs_server_uuid_is_local(struct nfs_client *clp)
146 {
147 	u8 uuid[UUID_SIZE];
148 	struct rpc_message msg = {
149 		.rpc_argp = &uuid,
150 	};
151 	struct rpc_clnt *rpcclient_localio;
152 	int status;
153 
154 	rpcclient_localio = nfs_init_localioclient(clp);
155 	if (IS_ERR(rpcclient_localio))
156 		return false;
157 
158 	export_uuid(uuid, &clp->cl_uuid.uuid);
159 
160 	msg.rpc_proc = &nfs_localio_procedures[LOCALIOPROC_UUID_IS_LOCAL];
161 	status = rpc_call_sync(rpcclient_localio, &msg, 0);
162 	dprintk("%s: NFS reply UUID_IS_LOCAL: status=%d\n",
163 		__func__, status);
164 	rpc_shutdown_client(rpcclient_localio);
165 
166 	/* Server is only local if it initialized required struct members */
167 	if (status || !rcu_access_pointer(clp->cl_uuid.net) || !clp->cl_uuid.dom)
168 		return false;
169 
170 	return true;
171 }
172 
173 /*
174  * nfs_local_probe - probe local i/o support for an nfs_server and nfs_client
175  * - called after alloc_client and init_client (so cl_rpcclient exists)
176  * - this function is idempotent, it can be called for old or new clients
177  */
nfs_local_probe(struct nfs_client * clp)178 static void nfs_local_probe(struct nfs_client *clp)
179 {
180 	/* Disallow localio if disabled via sysfs or AUTH_SYS isn't used */
181 	if (!localio_enabled ||
182 	    clp->cl_rpcclient->cl_auth->au_flavor != RPC_AUTH_UNIX) {
183 		nfs_localio_disable_client(clp);
184 		return;
185 	}
186 
187 	if (nfs_client_is_local(clp))
188 		return;
189 
190 	if (!nfs_uuid_begin(&clp->cl_uuid))
191 		return;
192 	if (nfs_server_uuid_is_local(clp))
193 		nfs_localio_enable_client(clp);
194 	nfs_uuid_end(&clp->cl_uuid);
195 }
196 
nfs_local_probe_async_work(struct work_struct * work)197 void nfs_local_probe_async_work(struct work_struct *work)
198 {
199 	struct nfs_client *clp =
200 		container_of(work, struct nfs_client, cl_local_probe_work);
201 
202 	if (!refcount_inc_not_zero(&clp->cl_count))
203 		return;
204 	nfs_local_probe(clp);
205 	nfs_put_client(clp);
206 }
207 
nfs_local_probe_async(struct nfs_client * clp)208 void nfs_local_probe_async(struct nfs_client *clp)
209 {
210 	queue_work(nfsiod_workqueue, &clp->cl_local_probe_work);
211 }
212 EXPORT_SYMBOL_GPL(nfs_local_probe_async);
213 
nfs_local_file_put(struct nfsd_file * localio)214 static inline void nfs_local_file_put(struct nfsd_file *localio)
215 {
216 	/* nfs_to_nfsd_file_put_local() expects an __rcu pointer
217 	 * but we have a __kernel pointer.  It is always safe
218 	 * to cast a __kernel pointer to an __rcu pointer
219 	 * because the cast only weakens what is known about the pointer.
220 	 */
221 	struct nfsd_file __rcu *nf = (struct nfsd_file __rcu*) localio;
222 
223 	nfs_to_nfsd_file_put_local(&nf);
224 }
225 
226 /*
227  * __nfs_local_open_fh - open a local filehandle in terms of nfsd_file.
228  *
229  * Returns a pointer to a struct nfsd_file or ERR_PTR.
230  * Caller must release returned nfsd_file with nfs_to_nfsd_file_put_local().
231  */
232 static struct nfsd_file *
__nfs_local_open_fh(struct nfs_client * clp,const struct cred * cred,struct nfs_fh * fh,struct nfs_file_localio * nfl,struct nfsd_file __rcu ** pnf,const fmode_t mode)233 __nfs_local_open_fh(struct nfs_client *clp, const struct cred *cred,
234 		    struct nfs_fh *fh, struct nfs_file_localio *nfl,
235 		    struct nfsd_file __rcu **pnf,
236 		    const fmode_t mode)
237 {
238 	int status = 0;
239 	struct nfsd_file *localio;
240 
241 	localio = nfs_open_local_fh(&clp->cl_uuid, clp->cl_rpcclient,
242 				    cred, fh, nfl, pnf, mode);
243 	if (IS_ERR(localio)) {
244 		status = PTR_ERR(localio);
245 		switch (status) {
246 		case -ENOMEM:
247 		case -ENXIO:
248 		case -ENOENT:
249 			/* Revalidate localio */
250 			nfs_localio_disable_client(clp);
251 			nfs_local_probe(clp);
252 		}
253 	}
254 	trace_nfs_local_open_fh(fh, mode, status);
255 	return localio;
256 }
257 
258 /*
259  * nfs_local_open_fh - open a local filehandle in terms of nfsd_file.
260  * First checking if the open nfsd_file is already cached, otherwise
261  * must __nfs_local_open_fh and insert the nfsd_file in nfs_file_localio.
262  *
263  * Returns a pointer to a struct nfsd_file or NULL.
264  */
265 struct nfsd_file *
nfs_local_open_fh(struct nfs_client * clp,const struct cred * cred,struct nfs_fh * fh,struct nfs_file_localio * nfl,const fmode_t mode)266 nfs_local_open_fh(struct nfs_client *clp, const struct cred *cred,
267 		  struct nfs_fh *fh, struct nfs_file_localio *nfl,
268 		  const fmode_t mode)
269 {
270 	struct nfsd_file *nf, __rcu **pnf;
271 
272 	if (!nfs_server_is_local(clp))
273 		return NULL;
274 	if (mode & ~(FMODE_READ | FMODE_WRITE))
275 		return NULL;
276 
277 	if (mode & FMODE_WRITE)
278 		pnf = &nfl->rw_file;
279 	else
280 		pnf = &nfl->ro_file;
281 
282 	nf = __nfs_local_open_fh(clp, cred, fh, nfl, pnf, mode);
283 	if (IS_ERR(nf))
284 		return NULL;
285 	return nf;
286 }
287 EXPORT_SYMBOL_GPL(nfs_local_open_fh);
288 
289 static void
nfs_local_iocb_free(struct nfs_local_kiocb * iocb)290 nfs_local_iocb_free(struct nfs_local_kiocb *iocb)
291 {
292 	kfree(iocb->bvec);
293 	kfree(iocb);
294 }
295 
296 static struct nfs_local_kiocb *
nfs_local_iocb_alloc(struct nfs_pgio_header * hdr,struct file * file,gfp_t flags)297 nfs_local_iocb_alloc(struct nfs_pgio_header *hdr,
298 		     struct file *file, gfp_t flags)
299 {
300 	struct nfs_local_kiocb *iocb;
301 
302 	iocb = kzalloc(sizeof(*iocb), flags);
303 	if (iocb == NULL)
304 		return NULL;
305 
306 	iocb->bvec = kmalloc_array(hdr->page_array.npages,
307 				   sizeof(struct bio_vec), flags);
308 	if (iocb->bvec == NULL) {
309 		kfree(iocb);
310 		return NULL;
311 	}
312 
313 	init_sync_kiocb(&iocb->kiocb, file);
314 
315 	iocb->hdr = hdr;
316 	iocb->kiocb.ki_pos = hdr->args.offset;
317 	iocb->kiocb.ki_flags &= ~IOCB_APPEND;
318 	iocb->kiocb.ki_complete = NULL;
319 	iocb->aio_complete_work = NULL;
320 
321 	iocb->end_iter_index = -1;
322 
323 	return iocb;
324 }
325 
326 static bool
nfs_is_local_dio_possible(struct nfs_local_kiocb * iocb,int rw,size_t len,struct nfs_local_dio * local_dio)327 nfs_is_local_dio_possible(struct nfs_local_kiocb *iocb, int rw,
328 			  size_t len, struct nfs_local_dio *local_dio)
329 {
330 	struct nfs_pgio_header *hdr = iocb->hdr;
331 	loff_t offset = hdr->args.offset;
332 	u32 nf_dio_mem_align, nf_dio_offset_align, nf_dio_read_offset_align;
333 	loff_t start_end, orig_end, middle_end;
334 
335 	nfs_to->nfsd_file_dio_alignment(iocb->localio, &nf_dio_mem_align,
336 			&nf_dio_offset_align, &nf_dio_read_offset_align);
337 	if (rw == ITER_DEST)
338 		nf_dio_offset_align = nf_dio_read_offset_align;
339 
340 	if (unlikely(!nf_dio_mem_align || !nf_dio_offset_align))
341 		return false;
342 	if (unlikely(nf_dio_offset_align > PAGE_SIZE))
343 		return false;
344 	if (unlikely(len < nf_dio_offset_align))
345 		return false;
346 
347 	local_dio->mem_align = nf_dio_mem_align;
348 	local_dio->offset_align = nf_dio_offset_align;
349 
350 	start_end = round_up(offset, nf_dio_offset_align);
351 	orig_end = offset + len;
352 	middle_end = round_down(orig_end, nf_dio_offset_align);
353 
354 	local_dio->middle_offset = start_end;
355 	local_dio->end_offset = middle_end;
356 
357 	local_dio->start_len = start_end - offset;
358 	local_dio->middle_len = middle_end - start_end;
359 	local_dio->end_len = orig_end - middle_end;
360 
361 	if (rw == ITER_DEST)
362 		trace_nfs_local_dio_read(hdr->inode, offset, len, local_dio);
363 	else
364 		trace_nfs_local_dio_write(hdr->inode, offset, len, local_dio);
365 	return true;
366 }
367 
nfs_iov_iter_aligned_bvec(const struct iov_iter * i,unsigned int addr_mask,unsigned int len_mask)368 static bool nfs_iov_iter_aligned_bvec(const struct iov_iter *i,
369 		unsigned int addr_mask, unsigned int len_mask)
370 {
371 	const struct bio_vec *bvec = i->bvec;
372 	size_t skip = i->iov_offset;
373 	size_t size = i->count;
374 
375 	if (size & len_mask)
376 		return false;
377 	do {
378 		size_t len = bvec->bv_len;
379 
380 		if (len > size)
381 			len = size;
382 		if ((unsigned long)(bvec->bv_offset + skip) & addr_mask)
383 			return false;
384 		bvec++;
385 		size -= len;
386 		skip = 0;
387 	} while (size);
388 
389 	return true;
390 }
391 
392 static void
nfs_local_iter_setup(struct iov_iter * iter,int rw,struct bio_vec * bvec,unsigned int nvecs,unsigned long total,size_t start,size_t len)393 nfs_local_iter_setup(struct iov_iter *iter, int rw, struct bio_vec *bvec,
394 		     unsigned int nvecs, unsigned long total,
395 		     size_t start, size_t len)
396 {
397 	iov_iter_bvec(iter, rw, bvec, nvecs, total);
398 	if (start)
399 		iov_iter_advance(iter, start);
400 	iov_iter_truncate(iter, len);
401 }
402 
403 /*
404  * Setup as many as 3 iov_iter based on extents described by @local_dio.
405  * Returns the number of iov_iter that were setup.
406  */
407 static int
nfs_local_iters_setup_dio(struct nfs_local_kiocb * iocb,int rw,unsigned int nvecs,unsigned long total,struct nfs_local_dio * local_dio)408 nfs_local_iters_setup_dio(struct nfs_local_kiocb *iocb, int rw,
409 			  unsigned int nvecs, unsigned long total,
410 			  struct nfs_local_dio *local_dio)
411 {
412 	int n_iters = 0;
413 	struct iov_iter *iters = iocb->iters;
414 
415 	/* Setup misaligned start? */
416 	if (local_dio->start_len) {
417 		nfs_local_iter_setup(&iters[n_iters], rw, iocb->bvec,
418 				     nvecs, total, 0, local_dio->start_len);
419 		++n_iters;
420 	}
421 
422 	/*
423 	 * Setup DIO-aligned middle, if there is no misaligned end (below)
424 	 * then AIO completion is used, see nfs_local_call_{read,write}
425 	 */
426 	nfs_local_iter_setup(&iters[n_iters], rw, iocb->bvec, nvecs,
427 			     total, local_dio->start_len, local_dio->middle_len);
428 
429 	iocb->iter_is_dio_aligned[n_iters] =
430 		nfs_iov_iter_aligned_bvec(&iters[n_iters],
431 			local_dio->mem_align-1, local_dio->offset_align-1);
432 
433 	if (unlikely(!iocb->iter_is_dio_aligned[n_iters])) {
434 		trace_nfs_local_dio_misaligned(iocb->hdr->inode,
435 			local_dio->start_len, local_dio->middle_len, local_dio);
436 		return 0; /* no DIO-aligned IO possible */
437 	}
438 	iocb->end_iter_index = n_iters;
439 	++n_iters;
440 
441 	/* Setup misaligned end? */
442 	if (local_dio->end_len) {
443 		nfs_local_iter_setup(&iters[n_iters], rw, iocb->bvec,
444 				     nvecs, total, local_dio->start_len +
445 				     local_dio->middle_len, local_dio->end_len);
446 		iocb->end_iter_index = n_iters;
447 		++n_iters;
448 	}
449 
450 	atomic_set(&iocb->n_iters, n_iters);
451 	return n_iters;
452 }
453 
454 static noinline_for_stack void
nfs_local_iters_init(struct nfs_local_kiocb * iocb,int rw)455 nfs_local_iters_init(struct nfs_local_kiocb *iocb, int rw)
456 {
457 	struct nfs_pgio_header *hdr = iocb->hdr;
458 	struct page **pagevec = hdr->page_array.pagevec;
459 	unsigned long v, total;
460 	unsigned int base;
461 	size_t len;
462 
463 	v = 0;
464 	total = hdr->args.count;
465 	base = hdr->args.pgbase;
466 	while (total && v < hdr->page_array.npages) {
467 		len = min_t(size_t, total, PAGE_SIZE - base);
468 		bvec_set_page(&iocb->bvec[v], *pagevec, len, base);
469 		total -= len;
470 		++pagevec;
471 		++v;
472 		base = 0;
473 	}
474 	len = hdr->args.count - total;
475 
476 	/*
477 	 * For each iocb, iocb->n_iters is always at least 1 and we always
478 	 * end io after first nfs_local_pgio_done call unless misaligned DIO.
479 	 */
480 	atomic_set(&iocb->n_iters, 1);
481 
482 	if (test_bit(NFS_IOHDR_ODIRECT, &hdr->flags)) {
483 		struct nfs_local_dio local_dio;
484 
485 		if (nfs_is_local_dio_possible(iocb, rw, len, &local_dio) &&
486 		    nfs_local_iters_setup_dio(iocb, rw, v, len, &local_dio) != 0) {
487 			/* Ensure DIO WRITE's IO on stable storage upon completion */
488 			if (rw == ITER_SOURCE)
489 				iocb->kiocb.ki_flags |= IOCB_DSYNC|IOCB_SYNC;
490 			return; /* is DIO-aligned */
491 		}
492 	}
493 
494 	/* Use buffered IO */
495 	iov_iter_bvec(&iocb->iters[0], rw, iocb->bvec, v, len);
496 }
497 
498 static void
nfs_local_hdr_release(struct nfs_pgio_header * hdr,const struct rpc_call_ops * call_ops)499 nfs_local_hdr_release(struct nfs_pgio_header *hdr,
500 		const struct rpc_call_ops *call_ops)
501 {
502 	call_ops->rpc_call_done(&hdr->task, hdr);
503 	call_ops->rpc_release(hdr);
504 }
505 
506 static void
nfs_local_pgio_init(struct nfs_pgio_header * hdr,const struct rpc_call_ops * call_ops)507 nfs_local_pgio_init(struct nfs_pgio_header *hdr,
508 		const struct rpc_call_ops *call_ops)
509 {
510 	hdr->task.tk_ops = call_ops;
511 	if (!hdr->task.tk_start)
512 		hdr->task.tk_start = ktime_get();
513 }
514 
515 static bool
nfs_local_pgio_done(struct nfs_local_kiocb * iocb,long status,bool force)516 nfs_local_pgio_done(struct nfs_local_kiocb *iocb, long status, bool force)
517 {
518 	struct nfs_pgio_header *hdr = iocb->hdr;
519 
520 	/* Must handle partial completions */
521 	if (status >= 0) {
522 		hdr->res.count += status;
523 		/* @hdr was initialized to 0 (zeroed during allocation) */
524 		if (hdr->task.tk_status == 0)
525 			hdr->res.op_status = NFS4_OK;
526 	} else {
527 		hdr->res.op_status = nfs_localio_errno_to_nfs4_stat(status);
528 		hdr->task.tk_status = status;
529 	}
530 
531 	if (force)
532 		return true;
533 
534 	BUG_ON(atomic_read(&iocb->n_iters) <= 0);
535 	return atomic_dec_and_test(&iocb->n_iters);
536 }
537 
538 static void
nfs_local_iocb_release(struct nfs_local_kiocb * iocb)539 nfs_local_iocb_release(struct nfs_local_kiocb *iocb)
540 {
541 	nfs_local_file_put(iocb->localio);
542 	nfs_local_iocb_free(iocb);
543 }
544 
545 static void
nfs_local_pgio_release(struct nfs_local_kiocb * iocb)546 nfs_local_pgio_release(struct nfs_local_kiocb *iocb)
547 {
548 	struct nfs_pgio_header *hdr = iocb->hdr;
549 
550 	nfs_local_iocb_release(iocb);
551 	nfs_local_hdr_release(hdr, hdr->task.tk_ops);
552 }
553 
554 /*
555  * Complete the I/O from iocb->kiocb.ki_complete()
556  *
557  * Note that this function can be called from a bottom half context,
558  * hence we need to queue the rpc_call_done() etc to a workqueue
559  */
nfs_local_pgio_aio_complete(struct nfs_local_kiocb * iocb)560 static inline void nfs_local_pgio_aio_complete(struct nfs_local_kiocb *iocb)
561 {
562 	INIT_WORK(&iocb->work, iocb->aio_complete_work);
563 	queue_work(nfsiod_workqueue, &iocb->work);
564 }
565 
nfs_local_read_done(struct nfs_local_kiocb * iocb)566 static void nfs_local_read_done(struct nfs_local_kiocb *iocb)
567 {
568 	struct nfs_pgio_header *hdr = iocb->hdr;
569 	struct file *filp = iocb->kiocb.ki_filp;
570 	long status = hdr->task.tk_status;
571 
572 	if ((iocb->kiocb.ki_flags & IOCB_DIRECT) && status == -EINVAL) {
573 		/* Underlying FS will return -EINVAL if misaligned DIO is attempted. */
574 		pr_info_ratelimited("nfs: Unexpected direct I/O read alignment failure\n");
575 	}
576 
577 	/*
578 	 * Must clear replen otherwise NFSv3 data corruption will occur
579 	 * if/when switching from LOCALIO back to using normal RPC.
580 	 */
581 	hdr->res.replen = 0;
582 
583 	/* nfs_readpage_result() handles short read */
584 
585 	if (hdr->args.offset + hdr->res.count >= i_size_read(file_inode(filp)))
586 		hdr->res.eof = true;
587 
588 	dprintk("%s: read %ld bytes eof %d.\n", __func__,
589 			status > 0 ? status : 0, hdr->res.eof);
590 }
591 
nfs_local_read_iocb_done(struct nfs_local_kiocb * iocb)592 static inline void nfs_local_read_iocb_done(struct nfs_local_kiocb *iocb)
593 {
594 	nfs_local_read_done(iocb);
595 	nfs_local_pgio_release(iocb);
596 }
597 
nfs_local_read_aio_complete_work(struct work_struct * work)598 static void nfs_local_read_aio_complete_work(struct work_struct *work)
599 {
600 	struct nfs_local_kiocb *iocb =
601 		container_of(work, struct nfs_local_kiocb, work);
602 
603 	nfs_local_read_iocb_done(iocb);
604 }
605 
nfs_local_read_aio_complete(struct kiocb * kiocb,long ret)606 static void nfs_local_read_aio_complete(struct kiocb *kiocb, long ret)
607 {
608 	struct nfs_local_kiocb *iocb =
609 		container_of(kiocb, struct nfs_local_kiocb, kiocb);
610 
611 	/* AIO completion of DIO read should always be last to complete */
612 	if (unlikely(!nfs_local_pgio_done(iocb, ret, false)))
613 		return;
614 
615 	nfs_local_pgio_aio_complete(iocb); /* Calls nfs_local_read_aio_complete_work */
616 }
617 
nfs_local_call_read(struct work_struct * work)618 static void nfs_local_call_read(struct work_struct *work)
619 {
620 	struct nfs_local_kiocb *iocb =
621 		container_of(work, struct nfs_local_kiocb, work);
622 	struct file *filp = iocb->kiocb.ki_filp;
623 	bool force_done = false;
624 	ssize_t status;
625 	int n_iters;
626 
627 	n_iters = atomic_read(&iocb->n_iters);
628 	for (int i = 0; i < n_iters ; i++) {
629 		if (iocb->iter_is_dio_aligned[i]) {
630 			iocb->kiocb.ki_flags |= IOCB_DIRECT;
631 			/* Only use AIO completion if DIO-aligned segment is last */
632 			if (i == iocb->end_iter_index) {
633 				iocb->kiocb.ki_complete = nfs_local_read_aio_complete;
634 				iocb->aio_complete_work = nfs_local_read_aio_complete_work;
635 			}
636 		} else
637 			iocb->kiocb.ki_flags &= ~IOCB_DIRECT;
638 
639 		scoped_with_creds(filp->f_cred)
640 			status = filp->f_op->read_iter(&iocb->kiocb, &iocb->iters[i]);
641 
642 		if (status != -EIOCBQUEUED) {
643 			if (unlikely(status >= 0 && status < iocb->iters[i].count))
644 				force_done = true; /* Partial read */
645 			if (nfs_local_pgio_done(iocb, status, force_done)) {
646 				nfs_local_read_iocb_done(iocb);
647 				break;
648 			}
649 		}
650 	}
651 }
652 
653 static int
nfs_local_do_read(struct nfs_local_kiocb * iocb,const struct rpc_call_ops * call_ops)654 nfs_local_do_read(struct nfs_local_kiocb *iocb,
655 		  const struct rpc_call_ops *call_ops)
656 {
657 	struct nfs_pgio_header *hdr = iocb->hdr;
658 
659 	dprintk("%s: vfs_read count=%u pos=%llu\n",
660 		__func__, hdr->args.count, hdr->args.offset);
661 
662 	nfs_local_pgio_init(hdr, call_ops);
663 	hdr->res.eof = false;
664 
665 	INIT_WORK(&iocb->work, nfs_local_call_read);
666 	queue_work(nfslocaliod_workqueue, &iocb->work);
667 
668 	return 0;
669 }
670 
671 static void
nfs_copy_boot_verifier(struct nfs_write_verifier * verifier,struct inode * inode)672 nfs_copy_boot_verifier(struct nfs_write_verifier *verifier, struct inode *inode)
673 {
674 	struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
675 	u32 *verf = (u32 *)verifier->data;
676 	unsigned int seq;
677 
678 	do {
679 		seq = read_seqbegin(&clp->cl_boot_lock);
680 		verf[0] = (u32)clp->cl_nfssvc_boot.tv_sec;
681 		verf[1] = (u32)clp->cl_nfssvc_boot.tv_nsec;
682 	} while (read_seqretry(&clp->cl_boot_lock, seq));
683 }
684 
685 static void
nfs_reset_boot_verifier(struct inode * inode)686 nfs_reset_boot_verifier(struct inode *inode)
687 {
688 	struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
689 
690 	write_seqlock(&clp->cl_boot_lock);
691 	ktime_get_real_ts64(&clp->cl_nfssvc_boot);
692 	write_sequnlock(&clp->cl_boot_lock);
693 }
694 
695 static void
nfs_set_local_verifier(struct inode * inode,struct nfs_writeverf * verf,enum nfs3_stable_how how)696 nfs_set_local_verifier(struct inode *inode,
697 		struct nfs_writeverf *verf,
698 		enum nfs3_stable_how how)
699 {
700 	nfs_copy_boot_verifier(&verf->verifier, inode);
701 	verf->committed = how;
702 }
703 
704 /* Factored out from fs/nfsd/vfs.h:fh_getattr() */
__vfs_getattr(const struct path * p,struct kstat * stat,int version)705 static int __vfs_getattr(const struct path *p, struct kstat *stat, int version)
706 {
707 	u32 request_mask = STATX_BASIC_STATS;
708 
709 	if (version == 4)
710 		request_mask |= (STATX_BTIME | STATX_CHANGE_COOKIE);
711 	return vfs_getattr(p, stat, request_mask, AT_STATX_SYNC_AS_STAT);
712 }
713 
714 /* Copied from fs/nfsd/nfsfh.c:nfsd4_change_attribute() */
__nfsd4_change_attribute(const struct kstat * stat,const struct inode * inode)715 static u64 __nfsd4_change_attribute(const struct kstat *stat,
716 				    const struct inode *inode)
717 {
718 	u64 chattr;
719 
720 	if (stat->result_mask & STATX_CHANGE_COOKIE) {
721 		chattr = stat->change_cookie;
722 		if (S_ISREG(inode->i_mode) &&
723 		    !(stat->attributes & STATX_ATTR_CHANGE_MONOTONIC)) {
724 			chattr += (u64)stat->ctime.tv_sec << 30;
725 			chattr += stat->ctime.tv_nsec;
726 		}
727 	} else {
728 		chattr = time_to_chattr(&stat->ctime);
729 	}
730 	return chattr;
731 }
732 
nfs_local_vfs_getattr(struct nfs_local_kiocb * iocb)733 static void nfs_local_vfs_getattr(struct nfs_local_kiocb *iocb)
734 {
735 	struct kstat stat;
736 	struct file *filp = iocb->kiocb.ki_filp;
737 	struct nfs_pgio_header *hdr = iocb->hdr;
738 	struct nfs_fattr *fattr = hdr->res.fattr;
739 	int version = NFS_PROTO(hdr->inode)->version;
740 
741 	if (unlikely(!fattr) || __vfs_getattr(&filp->f_path, &stat, version))
742 		return;
743 
744 	fattr->valid = (NFS_ATTR_FATTR_FILEID |
745 			NFS_ATTR_FATTR_CHANGE |
746 			NFS_ATTR_FATTR_SIZE |
747 			NFS_ATTR_FATTR_ATIME |
748 			NFS_ATTR_FATTR_MTIME |
749 			NFS_ATTR_FATTR_CTIME |
750 			NFS_ATTR_FATTR_SPACE_USED);
751 
752 	fattr->fileid = stat.ino;
753 	fattr->size = stat.size;
754 	fattr->atime = stat.atime;
755 	fattr->mtime = stat.mtime;
756 	fattr->ctime = stat.ctime;
757 	if (version == 4) {
758 		fattr->change_attr =
759 			__nfsd4_change_attribute(&stat, file_inode(filp));
760 	} else
761 		fattr->change_attr = nfs_timespec_to_change_attr(&fattr->ctime);
762 	fattr->du.nfs3.used = stat.blocks << 9;
763 }
764 
nfs_local_write_done(struct nfs_local_kiocb * iocb)765 static void nfs_local_write_done(struct nfs_local_kiocb *iocb)
766 {
767 	struct nfs_pgio_header *hdr = iocb->hdr;
768 	long status = hdr->task.tk_status;
769 
770 	dprintk("%s: wrote %ld bytes.\n", __func__, status > 0 ? status : 0);
771 
772 	if ((iocb->kiocb.ki_flags & IOCB_DIRECT) && status == -EINVAL) {
773 		/* Underlying FS will return -EINVAL if misaligned DIO is attempted. */
774 		pr_info_ratelimited("nfs: Unexpected direct I/O write alignment failure\n");
775 	}
776 
777 	/* Handle short writes as if they are ENOSPC */
778 	status = hdr->res.count;
779 	if (status > 0 && status < hdr->args.count) {
780 		hdr->mds_offset += status;
781 		hdr->args.offset += status;
782 		hdr->args.pgbase += status;
783 		hdr->args.count -= status;
784 		nfs_set_pgio_error(hdr, -ENOSPC, hdr->args.offset);
785 		status = -ENOSPC;
786 		/* record -ENOSPC in terms of nfs_local_pgio_done */
787 		(void) nfs_local_pgio_done(iocb, status, true);
788 	}
789 	if (hdr->task.tk_status < 0)
790 		nfs_reset_boot_verifier(hdr->inode);
791 }
792 
nfs_local_write_iocb_done(struct nfs_local_kiocb * iocb)793 static inline void nfs_local_write_iocb_done(struct nfs_local_kiocb *iocb)
794 {
795 	nfs_local_write_done(iocb);
796 	nfs_local_vfs_getattr(iocb);
797 	nfs_local_pgio_release(iocb);
798 }
799 
nfs_local_write_aio_complete_work(struct work_struct * work)800 static void nfs_local_write_aio_complete_work(struct work_struct *work)
801 {
802 	struct nfs_local_kiocb *iocb =
803 		container_of(work, struct nfs_local_kiocb, work);
804 
805 	nfs_local_write_iocb_done(iocb);
806 }
807 
nfs_local_write_aio_complete(struct kiocb * kiocb,long ret)808 static void nfs_local_write_aio_complete(struct kiocb *kiocb, long ret)
809 {
810 	struct nfs_local_kiocb *iocb =
811 		container_of(kiocb, struct nfs_local_kiocb, kiocb);
812 
813 	/* AIO completion of DIO write should always be last to complete */
814 	if (unlikely(!nfs_local_pgio_done(iocb, ret, false)))
815 		return;
816 
817 	nfs_local_pgio_aio_complete(iocb); /* Calls nfs_local_write_aio_complete_work */
818 }
819 
nfs_local_call_write(struct work_struct * work)820 static void nfs_local_call_write(struct work_struct *work)
821 {
822 	struct nfs_local_kiocb *iocb =
823 		container_of(work, struct nfs_local_kiocb, work);
824 	struct file *filp = iocb->kiocb.ki_filp;
825 	unsigned long old_flags = current->flags;
826 	bool force_done = false;
827 	ssize_t status;
828 	int n_iters;
829 
830 	current->flags |= PF_LOCAL_THROTTLE | PF_MEMALLOC_NOIO;
831 
832 	file_start_write(filp);
833 	n_iters = atomic_read(&iocb->n_iters);
834 	for (int i = 0; i < n_iters ; i++) {
835 		if (iocb->iter_is_dio_aligned[i]) {
836 			iocb->kiocb.ki_flags |= IOCB_DIRECT;
837 			/* Only use AIO completion if DIO-aligned segment is last */
838 			if (i == iocb->end_iter_index) {
839 				iocb->kiocb.ki_complete = nfs_local_write_aio_complete;
840 				iocb->aio_complete_work = nfs_local_write_aio_complete_work;
841 			}
842 		} else
843 			iocb->kiocb.ki_flags &= ~IOCB_DIRECT;
844 
845 		scoped_with_creds(filp->f_cred)
846 			status = filp->f_op->write_iter(&iocb->kiocb, &iocb->iters[i]);
847 
848 		if (status != -EIOCBQUEUED) {
849 			if (unlikely(status >= 0 && status < iocb->iters[i].count))
850 				force_done = true; /* Partial write */
851 			if (nfs_local_pgio_done(iocb, status, force_done)) {
852 				nfs_local_write_iocb_done(iocb);
853 				break;
854 			}
855 		}
856 	}
857 	file_end_write(filp);
858 
859 	current->flags = old_flags;
860 }
861 
862 static int
nfs_local_do_write(struct nfs_local_kiocb * iocb,const struct rpc_call_ops * call_ops)863 nfs_local_do_write(struct nfs_local_kiocb *iocb,
864 		   const struct rpc_call_ops *call_ops)
865 {
866 	struct nfs_pgio_header *hdr = iocb->hdr;
867 
868 	dprintk("%s: vfs_write count=%u pos=%llu %s\n",
869 		__func__, hdr->args.count, hdr->args.offset,
870 		(hdr->args.stable == NFS_UNSTABLE) ?  "unstable" : "stable");
871 
872 	switch (hdr->args.stable) {
873 	default:
874 		break;
875 	case NFS_DATA_SYNC:
876 		iocb->kiocb.ki_flags |= IOCB_DSYNC;
877 		break;
878 	case NFS_FILE_SYNC:
879 		iocb->kiocb.ki_flags |= IOCB_DSYNC|IOCB_SYNC;
880 	}
881 
882 	nfs_local_pgio_init(hdr, call_ops);
883 
884 	nfs_set_local_verifier(hdr->inode, hdr->res.verf, hdr->args.stable);
885 
886 	INIT_WORK(&iocb->work, nfs_local_call_write);
887 	queue_work(nfslocaliod_workqueue, &iocb->work);
888 
889 	return 0;
890 }
891 
892 static struct nfs_local_kiocb *
nfs_local_iocb_init(struct nfs_pgio_header * hdr,struct nfsd_file * localio)893 nfs_local_iocb_init(struct nfs_pgio_header *hdr, struct nfsd_file *localio)
894 {
895 	struct file *file = nfs_to->nfsd_file_file(localio);
896 	struct nfs_local_kiocb *iocb;
897 	gfp_t gfp_mask;
898 	int rw;
899 
900 	if (hdr->rw_mode & FMODE_READ) {
901 		if (!file->f_op->read_iter)
902 			return ERR_PTR(-EOPNOTSUPP);
903 		gfp_mask = GFP_KERNEL;
904 		rw = ITER_DEST;
905 	} else {
906 		if (!file->f_op->write_iter)
907 			return ERR_PTR(-EOPNOTSUPP);
908 		gfp_mask = GFP_NOIO;
909 		rw = ITER_SOURCE;
910 	}
911 
912 	iocb = nfs_local_iocb_alloc(hdr, file, gfp_mask);
913 	if (iocb == NULL)
914 		return ERR_PTR(-ENOMEM);
915 	iocb->hdr = hdr;
916 	iocb->localio = localio;
917 
918 	nfs_local_iters_init(iocb, rw);
919 
920 	return iocb;
921 }
922 
nfs_local_doio(struct nfs_client * clp,struct nfsd_file * localio,struct nfs_pgio_header * hdr,const struct rpc_call_ops * call_ops)923 int nfs_local_doio(struct nfs_client *clp, struct nfsd_file *localio,
924 		   struct nfs_pgio_header *hdr,
925 		   const struct rpc_call_ops *call_ops)
926 {
927 	struct nfs_local_kiocb *iocb;
928 	int status = 0;
929 
930 	if (!hdr->args.count)
931 		return 0;
932 
933 	iocb = nfs_local_iocb_init(hdr, localio);
934 	if (IS_ERR(iocb))
935 		return PTR_ERR(iocb);
936 
937 	switch (hdr->rw_mode) {
938 	case FMODE_READ:
939 		status = nfs_local_do_read(iocb, call_ops);
940 		break;
941 	case FMODE_WRITE:
942 		status = nfs_local_do_write(iocb, call_ops);
943 		break;
944 	default:
945 		dprintk("%s: invalid mode: %d\n", __func__,
946 			hdr->rw_mode);
947 		status = -EOPNOTSUPP;
948 	}
949 
950 	if (status != 0) {
951 		if (status == -EAGAIN)
952 			nfs_localio_disable_client(clp);
953 		nfs_local_iocb_release(iocb);
954 		hdr->task.tk_status = status;
955 		nfs_local_hdr_release(hdr, call_ops);
956 	}
957 	return status;
958 }
959 
960 static void
nfs_local_init_commit(struct nfs_commit_data * data,const struct rpc_call_ops * call_ops)961 nfs_local_init_commit(struct nfs_commit_data *data,
962 		const struct rpc_call_ops *call_ops)
963 {
964 	data->task.tk_ops = call_ops;
965 }
966 
967 static int
nfs_local_run_commit(struct file * filp,struct nfs_commit_data * data)968 nfs_local_run_commit(struct file *filp, struct nfs_commit_data *data)
969 {
970 	loff_t start = data->args.offset;
971 	loff_t end = LLONG_MAX;
972 
973 	if (data->args.count > 0) {
974 		end = start + data->args.count - 1;
975 		if (end < start)
976 			end = LLONG_MAX;
977 	}
978 
979 	dprintk("%s: commit %llu - %llu\n", __func__, start, end);
980 	return vfs_fsync_range(filp, start, end, 0);
981 }
982 
983 static void
nfs_local_commit_done(struct nfs_commit_data * data,int status)984 nfs_local_commit_done(struct nfs_commit_data *data, int status)
985 {
986 	if (status >= 0) {
987 		nfs_set_local_verifier(data->inode,
988 				data->res.verf,
989 				NFS_FILE_SYNC);
990 		data->res.op_status = NFS4_OK;
991 		data->task.tk_status = 0;
992 	} else {
993 		nfs_reset_boot_verifier(data->inode);
994 		data->res.op_status = nfs_localio_errno_to_nfs4_stat(status);
995 		data->task.tk_status = status;
996 	}
997 }
998 
999 static void
nfs_local_release_commit_data(struct nfsd_file * localio,struct nfs_commit_data * data,const struct rpc_call_ops * call_ops)1000 nfs_local_release_commit_data(struct nfsd_file *localio,
1001 		struct nfs_commit_data *data,
1002 		const struct rpc_call_ops *call_ops)
1003 {
1004 	nfs_local_file_put(localio);
1005 	call_ops->rpc_call_done(&data->task, data);
1006 	call_ops->rpc_release(data);
1007 }
1008 
1009 static void
nfs_local_fsync_ctx_free(struct nfs_local_fsync_ctx * ctx)1010 nfs_local_fsync_ctx_free(struct nfs_local_fsync_ctx *ctx)
1011 {
1012 	nfs_local_release_commit_data(ctx->localio, ctx->data,
1013 				      ctx->data->task.tk_ops);
1014 	kfree(ctx);
1015 }
1016 
1017 static void
nfs_local_fsync_work(struct work_struct * work)1018 nfs_local_fsync_work(struct work_struct *work)
1019 {
1020 	struct nfs_local_fsync_ctx *ctx;
1021 	int status;
1022 
1023 	ctx = container_of(work, struct nfs_local_fsync_ctx, work);
1024 
1025 	status = nfs_local_run_commit(nfs_to->nfsd_file_file(ctx->localio),
1026 				      ctx->data);
1027 	nfs_local_commit_done(ctx->data, status);
1028 	if (ctx->done != NULL)
1029 		complete(ctx->done);
1030 	nfs_local_fsync_ctx_free(ctx);
1031 }
1032 
1033 static struct nfs_local_fsync_ctx *
nfs_local_fsync_ctx_alloc(struct nfs_commit_data * data,struct nfsd_file * localio,gfp_t flags)1034 nfs_local_fsync_ctx_alloc(struct nfs_commit_data *data,
1035 			  struct nfsd_file *localio, gfp_t flags)
1036 {
1037 	struct nfs_local_fsync_ctx *ctx = kmalloc(sizeof(*ctx), flags);
1038 
1039 	if (ctx != NULL) {
1040 		ctx->localio = localio;
1041 		ctx->data = data;
1042 		INIT_WORK(&ctx->work, nfs_local_fsync_work);
1043 		ctx->done = NULL;
1044 	}
1045 	return ctx;
1046 }
1047 
nfs_local_commit(struct nfsd_file * localio,struct nfs_commit_data * data,const struct rpc_call_ops * call_ops,int how)1048 int nfs_local_commit(struct nfsd_file *localio,
1049 		     struct nfs_commit_data *data,
1050 		     const struct rpc_call_ops *call_ops, int how)
1051 {
1052 	struct nfs_local_fsync_ctx *ctx;
1053 
1054 	ctx = nfs_local_fsync_ctx_alloc(data, localio, GFP_KERNEL);
1055 	if (!ctx) {
1056 		nfs_local_commit_done(data, -ENOMEM);
1057 		nfs_local_release_commit_data(localio, data, call_ops);
1058 		return -ENOMEM;
1059 	}
1060 
1061 	nfs_local_init_commit(data, call_ops);
1062 
1063 	if (how & FLUSH_SYNC) {
1064 		DECLARE_COMPLETION_ONSTACK(done);
1065 		ctx->done = &done;
1066 		queue_work(nfsiod_workqueue, &ctx->work);
1067 		wait_for_completion(&done);
1068 	} else
1069 		queue_work(nfsiod_workqueue, &ctx->work);
1070 
1071 	return 0;
1072 }
1073