• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * linux/net/sunrpc/xprtsock.c
4  *
5  * Client-side transport implementation for sockets.
6  *
7  * TCP callback races fixes (C) 1998 Red Hat
8  * TCP send fixes (C) 1998 Red Hat
9  * TCP NFS related read + write fixes
10  *  (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
11  *
12  * Rewrite of larges part of the code in order to stabilize TCP stuff.
13  * Fix behaviour when socket buffer is full.
14  *  (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no>
15  *
16  * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
17  *
18  * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
19  *   <gilles.quillard@bull.net>
20  */
21 
22 #include <linux/types.h>
23 #include <linux/string.h>
24 #include <linux/slab.h>
25 #include <linux/module.h>
26 #include <linux/capability.h>
27 #include <linux/pagemap.h>
28 #include <linux/errno.h>
29 #include <linux/socket.h>
30 #include <linux/in.h>
31 #include <linux/net.h>
32 #include <linux/mm.h>
33 #include <linux/un.h>
34 #include <linux/udp.h>
35 #include <linux/tcp.h>
36 #include <linux/sunrpc/clnt.h>
37 #include <linux/sunrpc/addr.h>
38 #include <linux/sunrpc/sched.h>
39 #include <linux/sunrpc/svcsock.h>
40 #include <linux/sunrpc/xprtsock.h>
41 #include <linux/file.h>
42 #ifdef CONFIG_SUNRPC_BACKCHANNEL
43 #include <linux/sunrpc/bc_xprt.h>
44 #endif
45 
46 #include <net/sock.h>
47 #include <net/checksum.h>
48 #include <net/udp.h>
49 #include <net/tcp.h>
50 #include <linux/bvec.h>
51 #include <linux/highmem.h>
52 #include <linux/uio.h>
53 #include <linux/sched/mm.h>
54 
55 #include <trace/events/sunrpc.h>
56 
57 #include "socklib.h"
58 #include "sunrpc.h"
59 
60 static void xs_close(struct rpc_xprt *xprt);
61 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
62 		struct socket *sock);
63 
64 /*
65  * xprtsock tunables
66  */
67 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
68 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
69 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
70 
71 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
72 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
73 
74 #define XS_TCP_LINGER_TO	(15U * HZ)
75 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
76 
77 /*
78  * We can register our own files under /proc/sys/sunrpc by
79  * calling register_sysctl_table() again.  The files in that
80  * directory become the union of all files registered there.
81  *
82  * We simply need to make sure that we don't collide with
83  * someone else's file names!
84  */
85 
86 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
87 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
88 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
89 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
90 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
91 
92 static struct ctl_table_header *sunrpc_table_header;
93 
94 /*
95  * FIXME: changing the UDP slot table size should also resize the UDP
96  *        socket buffers for existing UDP transports
97  */
98 static struct ctl_table xs_tunables_table[] = {
99 	{
100 		.procname	= "udp_slot_table_entries",
101 		.data		= &xprt_udp_slot_table_entries,
102 		.maxlen		= sizeof(unsigned int),
103 		.mode		= 0644,
104 		.proc_handler	= proc_dointvec_minmax,
105 		.extra1		= &min_slot_table_size,
106 		.extra2		= &max_slot_table_size
107 	},
108 	{
109 		.procname	= "tcp_slot_table_entries",
110 		.data		= &xprt_tcp_slot_table_entries,
111 		.maxlen		= sizeof(unsigned int),
112 		.mode		= 0644,
113 		.proc_handler	= proc_dointvec_minmax,
114 		.extra1		= &min_slot_table_size,
115 		.extra2		= &max_slot_table_size
116 	},
117 	{
118 		.procname	= "tcp_max_slot_table_entries",
119 		.data		= &xprt_max_tcp_slot_table_entries,
120 		.maxlen		= sizeof(unsigned int),
121 		.mode		= 0644,
122 		.proc_handler	= proc_dointvec_minmax,
123 		.extra1		= &min_slot_table_size,
124 		.extra2		= &max_tcp_slot_table_limit
125 	},
126 	{
127 		.procname	= "min_resvport",
128 		.data		= &xprt_min_resvport,
129 		.maxlen		= sizeof(unsigned int),
130 		.mode		= 0644,
131 		.proc_handler	= proc_dointvec_minmax,
132 		.extra1		= &xprt_min_resvport_limit,
133 		.extra2		= &xprt_max_resvport_limit
134 	},
135 	{
136 		.procname	= "max_resvport",
137 		.data		= &xprt_max_resvport,
138 		.maxlen		= sizeof(unsigned int),
139 		.mode		= 0644,
140 		.proc_handler	= proc_dointvec_minmax,
141 		.extra1		= &xprt_min_resvport_limit,
142 		.extra2		= &xprt_max_resvport_limit
143 	},
144 	{
145 		.procname	= "tcp_fin_timeout",
146 		.data		= &xs_tcp_fin_timeout,
147 		.maxlen		= sizeof(xs_tcp_fin_timeout),
148 		.mode		= 0644,
149 		.proc_handler	= proc_dointvec_jiffies,
150 	},
151 	{ },
152 };
153 
154 static struct ctl_table sunrpc_table[] = {
155 	{
156 		.procname	= "sunrpc",
157 		.mode		= 0555,
158 		.child		= xs_tunables_table
159 	},
160 	{ },
161 };
162 
163 /*
164  * Wait duration for a reply from the RPC portmapper.
165  */
166 #define XS_BIND_TO		(60U * HZ)
167 
168 /*
169  * Delay if a UDP socket connect error occurs.  This is most likely some
170  * kind of resource problem on the local host.
171  */
172 #define XS_UDP_REEST_TO		(2U * HZ)
173 
174 /*
175  * The reestablish timeout allows clients to delay for a bit before attempting
176  * to reconnect to a server that just dropped our connection.
177  *
178  * We implement an exponential backoff when trying to reestablish a TCP
179  * transport connection with the server.  Some servers like to drop a TCP
180  * connection when they are overworked, so we start with a short timeout and
181  * increase over time if the server is down or not responding.
182  */
183 #define XS_TCP_INIT_REEST_TO	(3U * HZ)
184 
185 /*
186  * TCP idle timeout; client drops the transport socket if it is idle
187  * for this long.  Note that we also timeout UDP sockets to prevent
188  * holding port numbers when there is no RPC traffic.
189  */
190 #define XS_IDLE_DISC_TO		(5U * 60 * HZ)
191 
192 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
193 # undef  RPC_DEBUG_DATA
194 # define RPCDBG_FACILITY	RPCDBG_TRANS
195 #endif
196 
197 #ifdef RPC_DEBUG_DATA
xs_pktdump(char * msg,u32 * packet,unsigned int count)198 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
199 {
200 	u8 *buf = (u8 *) packet;
201 	int j;
202 
203 	dprintk("RPC:       %s\n", msg);
204 	for (j = 0; j < count && j < 128; j += 4) {
205 		if (!(j & 31)) {
206 			if (j)
207 				dprintk("\n");
208 			dprintk("0x%04x ", j);
209 		}
210 		dprintk("%02x%02x%02x%02x ",
211 			buf[j], buf[j+1], buf[j+2], buf[j+3]);
212 	}
213 	dprintk("\n");
214 }
215 #else
xs_pktdump(char * msg,u32 * packet,unsigned int count)216 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
217 {
218 	/* NOP */
219 }
220 #endif
221 
xprt_from_sock(struct sock * sk)222 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
223 {
224 	return (struct rpc_xprt *) sk->sk_user_data;
225 }
226 
xs_addr(struct rpc_xprt * xprt)227 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
228 {
229 	return (struct sockaddr *) &xprt->addr;
230 }
231 
xs_addr_un(struct rpc_xprt * xprt)232 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
233 {
234 	return (struct sockaddr_un *) &xprt->addr;
235 }
236 
xs_addr_in(struct rpc_xprt * xprt)237 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
238 {
239 	return (struct sockaddr_in *) &xprt->addr;
240 }
241 
xs_addr_in6(struct rpc_xprt * xprt)242 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
243 {
244 	return (struct sockaddr_in6 *) &xprt->addr;
245 }
246 
xs_format_common_peer_addresses(struct rpc_xprt * xprt)247 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
248 {
249 	struct sockaddr *sap = xs_addr(xprt);
250 	struct sockaddr_in6 *sin6;
251 	struct sockaddr_in *sin;
252 	struct sockaddr_un *sun;
253 	char buf[128];
254 
255 	switch (sap->sa_family) {
256 	case AF_LOCAL:
257 		sun = xs_addr_un(xprt);
258 		strlcpy(buf, sun->sun_path, sizeof(buf));
259 		xprt->address_strings[RPC_DISPLAY_ADDR] =
260 						kstrdup(buf, GFP_KERNEL);
261 		break;
262 	case AF_INET:
263 		(void)rpc_ntop(sap, buf, sizeof(buf));
264 		xprt->address_strings[RPC_DISPLAY_ADDR] =
265 						kstrdup(buf, GFP_KERNEL);
266 		sin = xs_addr_in(xprt);
267 		snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
268 		break;
269 	case AF_INET6:
270 		(void)rpc_ntop(sap, buf, sizeof(buf));
271 		xprt->address_strings[RPC_DISPLAY_ADDR] =
272 						kstrdup(buf, GFP_KERNEL);
273 		sin6 = xs_addr_in6(xprt);
274 		snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
275 		break;
276 	default:
277 		BUG();
278 	}
279 
280 	xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
281 }
282 
xs_format_common_peer_ports(struct rpc_xprt * xprt)283 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
284 {
285 	struct sockaddr *sap = xs_addr(xprt);
286 	char buf[128];
287 
288 	snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
289 	xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
290 
291 	snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
292 	xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
293 }
294 
xs_format_peer_addresses(struct rpc_xprt * xprt,const char * protocol,const char * netid)295 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
296 				     const char *protocol,
297 				     const char *netid)
298 {
299 	xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
300 	xprt->address_strings[RPC_DISPLAY_NETID] = netid;
301 	xs_format_common_peer_addresses(xprt);
302 	xs_format_common_peer_ports(xprt);
303 }
304 
xs_update_peer_port(struct rpc_xprt * xprt)305 static void xs_update_peer_port(struct rpc_xprt *xprt)
306 {
307 	kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
308 	kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
309 
310 	xs_format_common_peer_ports(xprt);
311 }
312 
xs_free_peer_addresses(struct rpc_xprt * xprt)313 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
314 {
315 	unsigned int i;
316 
317 	for (i = 0; i < RPC_DISPLAY_MAX; i++)
318 		switch (i) {
319 		case RPC_DISPLAY_PROTO:
320 		case RPC_DISPLAY_NETID:
321 			continue;
322 		default:
323 			kfree(xprt->address_strings[i]);
324 		}
325 }
326 
327 static size_t
xs_alloc_sparse_pages(struct xdr_buf * buf,size_t want,gfp_t gfp)328 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp)
329 {
330 	size_t i,n;
331 
332 	if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES))
333 		return want;
334 	n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT;
335 	for (i = 0; i < n; i++) {
336 		if (buf->pages[i])
337 			continue;
338 		buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp);
339 		if (!buf->pages[i]) {
340 			i *= PAGE_SIZE;
341 			return i > buf->page_base ? i - buf->page_base : 0;
342 		}
343 	}
344 	return want;
345 }
346 
347 static ssize_t
xs_sock_recvmsg(struct socket * sock,struct msghdr * msg,int flags,size_t seek)348 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek)
349 {
350 	ssize_t ret;
351 	if (seek != 0)
352 		iov_iter_advance(&msg->msg_iter, seek);
353 	ret = sock_recvmsg(sock, msg, flags);
354 	return ret > 0 ? ret + seek : ret;
355 }
356 
357 static ssize_t
xs_read_kvec(struct socket * sock,struct msghdr * msg,int flags,struct kvec * kvec,size_t count,size_t seek)358 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags,
359 		struct kvec *kvec, size_t count, size_t seek)
360 {
361 	iov_iter_kvec(&msg->msg_iter, READ, kvec, 1, count);
362 	return xs_sock_recvmsg(sock, msg, flags, seek);
363 }
364 
365 static ssize_t
xs_read_bvec(struct socket * sock,struct msghdr * msg,int flags,struct bio_vec * bvec,unsigned long nr,size_t count,size_t seek)366 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags,
367 		struct bio_vec *bvec, unsigned long nr, size_t count,
368 		size_t seek)
369 {
370 	iov_iter_bvec(&msg->msg_iter, READ, bvec, nr, count);
371 	return xs_sock_recvmsg(sock, msg, flags, seek);
372 }
373 
374 static ssize_t
xs_read_discard(struct socket * sock,struct msghdr * msg,int flags,size_t count)375 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags,
376 		size_t count)
377 {
378 	iov_iter_discard(&msg->msg_iter, READ, count);
379 	return sock_recvmsg(sock, msg, flags);
380 }
381 
382 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
383 static void
xs_flush_bvec(const struct bio_vec * bvec,size_t count,size_t seek)384 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
385 {
386 	struct bvec_iter bi = {
387 		.bi_size = count,
388 	};
389 	struct bio_vec bv;
390 
391 	bvec_iter_advance(bvec, &bi, seek & PAGE_MASK);
392 	for_each_bvec(bv, bvec, bi, bi)
393 		flush_dcache_page(bv.bv_page);
394 }
395 #else
396 static inline void
xs_flush_bvec(const struct bio_vec * bvec,size_t count,size_t seek)397 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
398 {
399 }
400 #endif
401 
402 static ssize_t
xs_read_xdr_buf(struct socket * sock,struct msghdr * msg,int flags,struct xdr_buf * buf,size_t count,size_t seek,size_t * read)403 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags,
404 		struct xdr_buf *buf, size_t count, size_t seek, size_t *read)
405 {
406 	size_t want, seek_init = seek, offset = 0;
407 	ssize_t ret;
408 
409 	want = min_t(size_t, count, buf->head[0].iov_len);
410 	if (seek < want) {
411 		ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek);
412 		if (ret <= 0)
413 			goto sock_err;
414 		offset += ret;
415 		if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
416 			goto out;
417 		if (ret != want)
418 			goto out;
419 		seek = 0;
420 	} else {
421 		seek -= want;
422 		offset += want;
423 	}
424 
425 	want = xs_alloc_sparse_pages(buf,
426 			min_t(size_t, count - offset, buf->page_len),
427 			GFP_KERNEL);
428 	if (seek < want) {
429 		ret = xs_read_bvec(sock, msg, flags, buf->bvec,
430 				xdr_buf_pagecount(buf),
431 				want + buf->page_base,
432 				seek + buf->page_base);
433 		if (ret <= 0)
434 			goto sock_err;
435 		xs_flush_bvec(buf->bvec, ret, seek + buf->page_base);
436 		ret -= buf->page_base;
437 		offset += ret;
438 		if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
439 			goto out;
440 		if (ret != want)
441 			goto out;
442 		seek = 0;
443 	} else {
444 		seek -= want;
445 		offset += want;
446 	}
447 
448 	want = min_t(size_t, count - offset, buf->tail[0].iov_len);
449 	if (seek < want) {
450 		ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek);
451 		if (ret <= 0)
452 			goto sock_err;
453 		offset += ret;
454 		if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
455 			goto out;
456 		if (ret != want)
457 			goto out;
458 	} else if (offset < seek_init)
459 		offset = seek_init;
460 	ret = -EMSGSIZE;
461 out:
462 	*read = offset - seek_init;
463 	return ret;
464 sock_err:
465 	offset += seek;
466 	goto out;
467 }
468 
469 static void
xs_read_header(struct sock_xprt * transport,struct xdr_buf * buf)470 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf)
471 {
472 	if (!transport->recv.copied) {
473 		if (buf->head[0].iov_len >= transport->recv.offset)
474 			memcpy(buf->head[0].iov_base,
475 					&transport->recv.xid,
476 					transport->recv.offset);
477 		transport->recv.copied = transport->recv.offset;
478 	}
479 }
480 
481 static bool
xs_read_stream_request_done(struct sock_xprt * transport)482 xs_read_stream_request_done(struct sock_xprt *transport)
483 {
484 	return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT);
485 }
486 
487 static void
xs_read_stream_check_eor(struct sock_xprt * transport,struct msghdr * msg)488 xs_read_stream_check_eor(struct sock_xprt *transport,
489 		struct msghdr *msg)
490 {
491 	if (xs_read_stream_request_done(transport))
492 		msg->msg_flags |= MSG_EOR;
493 }
494 
495 static ssize_t
xs_read_stream_request(struct sock_xprt * transport,struct msghdr * msg,int flags,struct rpc_rqst * req)496 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg,
497 		int flags, struct rpc_rqst *req)
498 {
499 	struct xdr_buf *buf = &req->rq_private_buf;
500 	size_t want, read;
501 	ssize_t ret;
502 
503 	xs_read_header(transport, buf);
504 
505 	want = transport->recv.len - transport->recv.offset;
506 	if (want != 0) {
507 		ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
508 				transport->recv.copied + want,
509 				transport->recv.copied,
510 				&read);
511 		transport->recv.offset += read;
512 		transport->recv.copied += read;
513 	}
514 
515 	if (transport->recv.offset == transport->recv.len)
516 		xs_read_stream_check_eor(transport, msg);
517 
518 	if (want == 0)
519 		return 0;
520 
521 	switch (ret) {
522 	default:
523 		break;
524 	case -EFAULT:
525 	case -EMSGSIZE:
526 		msg->msg_flags |= MSG_TRUNC;
527 		return read;
528 	case 0:
529 		return -ESHUTDOWN;
530 	}
531 	return ret < 0 ? ret : read;
532 }
533 
534 static size_t
xs_read_stream_headersize(bool isfrag)535 xs_read_stream_headersize(bool isfrag)
536 {
537 	if (isfrag)
538 		return sizeof(__be32);
539 	return 3 * sizeof(__be32);
540 }
541 
542 static ssize_t
xs_read_stream_header(struct sock_xprt * transport,struct msghdr * msg,int flags,size_t want,size_t seek)543 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
544 		int flags, size_t want, size_t seek)
545 {
546 	struct kvec kvec = {
547 		.iov_base = &transport->recv.fraghdr,
548 		.iov_len = want,
549 	};
550 	return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
551 }
552 
553 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
554 static ssize_t
xs_read_stream_call(struct sock_xprt * transport,struct msghdr * msg,int flags)555 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
556 {
557 	struct rpc_xprt *xprt = &transport->xprt;
558 	struct rpc_rqst *req;
559 	ssize_t ret;
560 
561 	/* Look up and lock the request corresponding to the given XID */
562 	req = xprt_lookup_bc_request(xprt, transport->recv.xid);
563 	if (!req) {
564 		printk(KERN_WARNING "Callback slot table overflowed\n");
565 		return -ESHUTDOWN;
566 	}
567 	if (transport->recv.copied && !req->rq_private_buf.len)
568 		return -ESHUTDOWN;
569 
570 	ret = xs_read_stream_request(transport, msg, flags, req);
571 	if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
572 		xprt_complete_bc_request(req, transport->recv.copied);
573 	else
574 		req->rq_private_buf.len = transport->recv.copied;
575 
576 	return ret;
577 }
578 #else /* CONFIG_SUNRPC_BACKCHANNEL */
579 static ssize_t
xs_read_stream_call(struct sock_xprt * transport,struct msghdr * msg,int flags)580 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
581 {
582 	return -ESHUTDOWN;
583 }
584 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
585 
586 static ssize_t
xs_read_stream_reply(struct sock_xprt * transport,struct msghdr * msg,int flags)587 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
588 {
589 	struct rpc_xprt *xprt = &transport->xprt;
590 	struct rpc_rqst *req;
591 	ssize_t ret = 0;
592 
593 	/* Look up and lock the request corresponding to the given XID */
594 	spin_lock(&xprt->queue_lock);
595 	req = xprt_lookup_rqst(xprt, transport->recv.xid);
596 	if (!req || (transport->recv.copied && !req->rq_private_buf.len)) {
597 		msg->msg_flags |= MSG_TRUNC;
598 		goto out;
599 	}
600 	xprt_pin_rqst(req);
601 	spin_unlock(&xprt->queue_lock);
602 
603 	ret = xs_read_stream_request(transport, msg, flags, req);
604 
605 	spin_lock(&xprt->queue_lock);
606 	if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
607 		xprt_complete_rqst(req->rq_task, transport->recv.copied);
608 	else
609 		req->rq_private_buf.len = transport->recv.copied;
610 	xprt_unpin_rqst(req);
611 out:
612 	spin_unlock(&xprt->queue_lock);
613 	return ret;
614 }
615 
616 static ssize_t
xs_read_stream(struct sock_xprt * transport,int flags)617 xs_read_stream(struct sock_xprt *transport, int flags)
618 {
619 	struct msghdr msg = { 0 };
620 	size_t want, read = 0;
621 	ssize_t ret = 0;
622 
623 	if (transport->recv.len == 0) {
624 		want = xs_read_stream_headersize(transport->recv.copied != 0);
625 		ret = xs_read_stream_header(transport, &msg, flags, want,
626 				transport->recv.offset);
627 		if (ret <= 0)
628 			goto out_err;
629 		transport->recv.offset = ret;
630 		if (transport->recv.offset != want)
631 			return transport->recv.offset;
632 		transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
633 			RPC_FRAGMENT_SIZE_MASK;
634 		transport->recv.offset -= sizeof(transport->recv.fraghdr);
635 		read = ret;
636 	}
637 
638 	switch (be32_to_cpu(transport->recv.calldir)) {
639 	default:
640 		msg.msg_flags |= MSG_TRUNC;
641 		break;
642 	case RPC_CALL:
643 		ret = xs_read_stream_call(transport, &msg, flags);
644 		break;
645 	case RPC_REPLY:
646 		ret = xs_read_stream_reply(transport, &msg, flags);
647 	}
648 	if (msg.msg_flags & MSG_TRUNC) {
649 		transport->recv.calldir = cpu_to_be32(-1);
650 		transport->recv.copied = -1;
651 	}
652 	if (ret < 0)
653 		goto out_err;
654 	read += ret;
655 	if (transport->recv.offset < transport->recv.len) {
656 		if (!(msg.msg_flags & MSG_TRUNC))
657 			return read;
658 		msg.msg_flags = 0;
659 		ret = xs_read_discard(transport->sock, &msg, flags,
660 				transport->recv.len - transport->recv.offset);
661 		if (ret <= 0)
662 			goto out_err;
663 		transport->recv.offset += ret;
664 		read += ret;
665 		if (transport->recv.offset != transport->recv.len)
666 			return read;
667 	}
668 	if (xs_read_stream_request_done(transport)) {
669 		trace_xs_stream_read_request(transport);
670 		transport->recv.copied = 0;
671 	}
672 	transport->recv.offset = 0;
673 	transport->recv.len = 0;
674 	return read;
675 out_err:
676 	return ret != 0 ? ret : -ESHUTDOWN;
677 }
678 
xs_poll_socket(struct sock_xprt * transport)679 static __poll_t xs_poll_socket(struct sock_xprt *transport)
680 {
681 	return transport->sock->ops->poll(transport->file, transport->sock,
682 			NULL);
683 }
684 
xs_poll_socket_readable(struct sock_xprt * transport)685 static bool xs_poll_socket_readable(struct sock_xprt *transport)
686 {
687 	__poll_t events = xs_poll_socket(transport);
688 
689 	return (events & (EPOLLIN | EPOLLRDNORM)) && !(events & EPOLLRDHUP);
690 }
691 
xs_poll_check_readable(struct sock_xprt * transport)692 static void xs_poll_check_readable(struct sock_xprt *transport)
693 {
694 
695 	clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
696 	if (!xs_poll_socket_readable(transport))
697 		return;
698 	if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
699 		queue_work(xprtiod_workqueue, &transport->recv_worker);
700 }
701 
xs_stream_data_receive(struct sock_xprt * transport)702 static void xs_stream_data_receive(struct sock_xprt *transport)
703 {
704 	size_t read = 0;
705 	ssize_t ret = 0;
706 
707 	mutex_lock(&transport->recv_mutex);
708 	if (transport->sock == NULL)
709 		goto out;
710 	for (;;) {
711 		ret = xs_read_stream(transport, MSG_DONTWAIT);
712 		if (ret < 0)
713 			break;
714 		read += ret;
715 		cond_resched();
716 	}
717 	if (ret == -ESHUTDOWN)
718 		kernel_sock_shutdown(transport->sock, SHUT_RDWR);
719 	else
720 		xs_poll_check_readable(transport);
721 out:
722 	mutex_unlock(&transport->recv_mutex);
723 	trace_xs_stream_read_data(&transport->xprt, ret, read);
724 }
725 
xs_stream_data_receive_workfn(struct work_struct * work)726 static void xs_stream_data_receive_workfn(struct work_struct *work)
727 {
728 	struct sock_xprt *transport =
729 		container_of(work, struct sock_xprt, recv_worker);
730 	unsigned int pflags = memalloc_nofs_save();
731 
732 	xs_stream_data_receive(transport);
733 	memalloc_nofs_restore(pflags);
734 }
735 
736 static void
xs_stream_reset_connect(struct sock_xprt * transport)737 xs_stream_reset_connect(struct sock_xprt *transport)
738 {
739 	transport->recv.offset = 0;
740 	transport->recv.len = 0;
741 	transport->recv.copied = 0;
742 	transport->xmit.offset = 0;
743 }
744 
745 static void
xs_stream_start_connect(struct sock_xprt * transport)746 xs_stream_start_connect(struct sock_xprt *transport)
747 {
748 	transport->xprt.stat.connect_count++;
749 	transport->xprt.stat.connect_start = jiffies;
750 }
751 
752 #define XS_SENDMSG_FLAGS	(MSG_DONTWAIT | MSG_NOSIGNAL)
753 
754 /**
755  * xs_nospace - handle transmit was incomplete
756  * @req: pointer to RPC request
757  * @transport: pointer to struct sock_xprt
758  *
759  */
xs_nospace(struct rpc_rqst * req,struct sock_xprt * transport)760 static int xs_nospace(struct rpc_rqst *req, struct sock_xprt *transport)
761 {
762 	struct rpc_xprt *xprt = &transport->xprt;
763 	struct sock *sk = transport->inet;
764 	int ret = -EAGAIN;
765 
766 	trace_rpc_socket_nospace(req, transport);
767 
768 	/* Protect against races with write_space */
769 	spin_lock(&xprt->transport_lock);
770 
771 	/* Don't race with disconnect */
772 	if (xprt_connected(xprt)) {
773 		struct socket_wq *wq;
774 
775 		rcu_read_lock();
776 		wq = rcu_dereference(sk->sk_wq);
777 		set_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags);
778 		rcu_read_unlock();
779 
780 		/* wait for more buffer space */
781 		set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
782 		sk->sk_write_pending++;
783 		xprt_wait_for_buffer_space(xprt);
784 	} else
785 		ret = -ENOTCONN;
786 
787 	spin_unlock(&xprt->transport_lock);
788 	return ret;
789 }
790 
xs_sock_nospace(struct rpc_rqst * req)791 static int xs_sock_nospace(struct rpc_rqst *req)
792 {
793 	struct sock_xprt *transport =
794 		container_of(req->rq_xprt, struct sock_xprt, xprt);
795 	struct sock *sk = transport->inet;
796 	int ret = -EAGAIN;
797 
798 	lock_sock(sk);
799 	if (!sock_writeable(sk))
800 		ret = xs_nospace(req, transport);
801 	release_sock(sk);
802 	return ret;
803 }
804 
xs_stream_nospace(struct rpc_rqst * req)805 static int xs_stream_nospace(struct rpc_rqst *req)
806 {
807 	struct sock_xprt *transport =
808 		container_of(req->rq_xprt, struct sock_xprt, xprt);
809 	struct sock *sk = transport->inet;
810 	int ret = -EAGAIN;
811 
812 	lock_sock(sk);
813 	if (!sk_stream_memory_free(sk))
814 		ret = xs_nospace(req, transport);
815 	release_sock(sk);
816 	return ret;
817 }
818 
819 static void
xs_stream_prepare_request(struct rpc_rqst * req)820 xs_stream_prepare_request(struct rpc_rqst *req)
821 {
822 	xdr_free_bvec(&req->rq_rcv_buf);
823 	req->rq_task->tk_status = xdr_alloc_bvec(&req->rq_rcv_buf, GFP_KERNEL);
824 }
825 
826 /*
827  * Determine if the previous message in the stream was aborted before it
828  * could complete transmission.
829  */
830 static bool
xs_send_request_was_aborted(struct sock_xprt * transport,struct rpc_rqst * req)831 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
832 {
833 	return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
834 }
835 
836 /*
837  * Return the stream record marker field for a record of length < 2^31-1
838  */
839 static rpc_fraghdr
xs_stream_record_marker(struct xdr_buf * xdr)840 xs_stream_record_marker(struct xdr_buf *xdr)
841 {
842 	if (!xdr->len)
843 		return 0;
844 	return cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | (u32)xdr->len);
845 }
846 
847 /**
848  * xs_local_send_request - write an RPC request to an AF_LOCAL socket
849  * @req: pointer to RPC request
850  *
851  * Return values:
852  *        0:	The request has been sent
853  *   EAGAIN:	The socket was blocked, please call again later to
854  *		complete the request
855  * ENOTCONN:	Caller needs to invoke connect logic then call again
856  *    other:	Some other error occured, the request was not sent
857  */
xs_local_send_request(struct rpc_rqst * req)858 static int xs_local_send_request(struct rpc_rqst *req)
859 {
860 	struct rpc_xprt *xprt = req->rq_xprt;
861 	struct sock_xprt *transport =
862 				container_of(xprt, struct sock_xprt, xprt);
863 	struct xdr_buf *xdr = &req->rq_snd_buf;
864 	rpc_fraghdr rm = xs_stream_record_marker(xdr);
865 	unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
866 	struct msghdr msg = {
867 		.msg_flags	= XS_SENDMSG_FLAGS,
868 	};
869 	unsigned int sent;
870 	int status;
871 
872 	/* Close the stream if the previous transmission was incomplete */
873 	if (xs_send_request_was_aborted(transport, req)) {
874 		xprt_force_disconnect(xprt);
875 		return -ENOTCONN;
876 	}
877 
878 	xs_pktdump("packet data:",
879 			req->rq_svec->iov_base, req->rq_svec->iov_len);
880 
881 	req->rq_xtime = ktime_get();
882 	status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
883 				   transport->xmit.offset, rm, &sent);
884 	dprintk("RPC:       %s(%u) = %d\n",
885 			__func__, xdr->len - transport->xmit.offset, status);
886 
887 	if (status == -EAGAIN && sock_writeable(transport->inet))
888 		status = -ENOBUFS;
889 
890 	if (likely(sent > 0) || status == 0) {
891 		transport->xmit.offset += sent;
892 		req->rq_bytes_sent = transport->xmit.offset;
893 		if (likely(req->rq_bytes_sent >= msglen)) {
894 			req->rq_xmit_bytes_sent += transport->xmit.offset;
895 			transport->xmit.offset = 0;
896 			return 0;
897 		}
898 		status = -EAGAIN;
899 	}
900 
901 	switch (status) {
902 	case -ENOBUFS:
903 		break;
904 	case -EAGAIN:
905 		status = xs_stream_nospace(req);
906 		break;
907 	default:
908 		dprintk("RPC:       sendmsg returned unrecognized error %d\n",
909 			-status);
910 		fallthrough;
911 	case -EPIPE:
912 		xprt_force_disconnect(xprt);
913 		status = -ENOTCONN;
914 	}
915 
916 	return status;
917 }
918 
919 /**
920  * xs_udp_send_request - write an RPC request to a UDP socket
921  * @req: pointer to RPC request
922  *
923  * Return values:
924  *        0:	The request has been sent
925  *   EAGAIN:	The socket was blocked, please call again later to
926  *		complete the request
927  * ENOTCONN:	Caller needs to invoke connect logic then call again
928  *    other:	Some other error occurred, the request was not sent
929  */
xs_udp_send_request(struct rpc_rqst * req)930 static int xs_udp_send_request(struct rpc_rqst *req)
931 {
932 	struct rpc_xprt *xprt = req->rq_xprt;
933 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
934 	struct xdr_buf *xdr = &req->rq_snd_buf;
935 	struct msghdr msg = {
936 		.msg_name	= xs_addr(xprt),
937 		.msg_namelen	= xprt->addrlen,
938 		.msg_flags	= XS_SENDMSG_FLAGS,
939 	};
940 	unsigned int sent;
941 	int status;
942 
943 	xs_pktdump("packet data:",
944 				req->rq_svec->iov_base,
945 				req->rq_svec->iov_len);
946 
947 	if (!xprt_bound(xprt))
948 		return -ENOTCONN;
949 
950 	if (!xprt_request_get_cong(xprt, req))
951 		return -EBADSLT;
952 
953 	req->rq_xtime = ktime_get();
954 	status = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, 0, &sent);
955 
956 	dprintk("RPC:       xs_udp_send_request(%u) = %d\n",
957 			xdr->len, status);
958 
959 	/* firewall is blocking us, don't return -EAGAIN or we end up looping */
960 	if (status == -EPERM)
961 		goto process_status;
962 
963 	if (status == -EAGAIN && sock_writeable(transport->inet))
964 		status = -ENOBUFS;
965 
966 	if (sent > 0 || status == 0) {
967 		req->rq_xmit_bytes_sent += sent;
968 		if (sent >= req->rq_slen)
969 			return 0;
970 		/* Still some bytes left; set up for a retry later. */
971 		status = -EAGAIN;
972 	}
973 
974 process_status:
975 	switch (status) {
976 	case -ENOTSOCK:
977 		status = -ENOTCONN;
978 		/* Should we call xs_close() here? */
979 		break;
980 	case -EAGAIN:
981 		status = xs_sock_nospace(req);
982 		break;
983 	case -ENETUNREACH:
984 	case -ENOBUFS:
985 	case -EPIPE:
986 	case -ECONNREFUSED:
987 	case -EPERM:
988 		/* When the server has died, an ICMP port unreachable message
989 		 * prompts ECONNREFUSED. */
990 		break;
991 	default:
992 		dprintk("RPC:       sendmsg returned unrecognized error %d\n",
993 			-status);
994 	}
995 
996 	return status;
997 }
998 
999 /**
1000  * xs_tcp_send_request - write an RPC request to a TCP socket
1001  * @req: pointer to RPC request
1002  *
1003  * Return values:
1004  *        0:	The request has been sent
1005  *   EAGAIN:	The socket was blocked, please call again later to
1006  *		complete the request
1007  * ENOTCONN:	Caller needs to invoke connect logic then call again
1008  *    other:	Some other error occurred, the request was not sent
1009  *
1010  * XXX: In the case of soft timeouts, should we eventually give up
1011  *	if sendmsg is not able to make progress?
1012  */
xs_tcp_send_request(struct rpc_rqst * req)1013 static int xs_tcp_send_request(struct rpc_rqst *req)
1014 {
1015 	struct rpc_xprt *xprt = req->rq_xprt;
1016 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1017 	struct xdr_buf *xdr = &req->rq_snd_buf;
1018 	rpc_fraghdr rm = xs_stream_record_marker(xdr);
1019 	unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
1020 	struct msghdr msg = {
1021 		.msg_flags	= XS_SENDMSG_FLAGS,
1022 	};
1023 	bool vm_wait = false;
1024 	unsigned int sent;
1025 	int status;
1026 
1027 	/* Close the stream if the previous transmission was incomplete */
1028 	if (xs_send_request_was_aborted(transport, req)) {
1029 		if (transport->sock != NULL)
1030 			kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1031 		return -ENOTCONN;
1032 	}
1033 
1034 	xs_pktdump("packet data:",
1035 				req->rq_svec->iov_base,
1036 				req->rq_svec->iov_len);
1037 
1038 	if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1039 		xs_tcp_set_socket_timeouts(xprt, transport->sock);
1040 
1041 	/* Continue transmitting the packet/record. We must be careful
1042 	 * to cope with writespace callbacks arriving _after_ we have
1043 	 * called sendmsg(). */
1044 	req->rq_xtime = ktime_get();
1045 	while (1) {
1046 		status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
1047 					   transport->xmit.offset, rm, &sent);
1048 
1049 		dprintk("RPC:       xs_tcp_send_request(%u) = %d\n",
1050 				xdr->len - transport->xmit.offset, status);
1051 
1052 		/* If we've sent the entire packet, immediately
1053 		 * reset the count of bytes sent. */
1054 		transport->xmit.offset += sent;
1055 		req->rq_bytes_sent = transport->xmit.offset;
1056 		if (likely(req->rq_bytes_sent >= msglen)) {
1057 			req->rq_xmit_bytes_sent += transport->xmit.offset;
1058 			transport->xmit.offset = 0;
1059 			return 0;
1060 		}
1061 
1062 		WARN_ON_ONCE(sent == 0 && status == 0);
1063 
1064 		if (status == -EAGAIN ) {
1065 			/*
1066 			 * Return EAGAIN if we're sure we're hitting the
1067 			 * socket send buffer limits.
1068 			 */
1069 			if (test_bit(SOCK_NOSPACE, &transport->sock->flags))
1070 				break;
1071 			/*
1072 			 * Did we hit a memory allocation failure?
1073 			 */
1074 			if (sent == 0) {
1075 				status = -ENOBUFS;
1076 				if (vm_wait)
1077 					break;
1078 				/* Retry, knowing now that we're below the
1079 				 * socket send buffer limit
1080 				 */
1081 				vm_wait = true;
1082 			}
1083 			continue;
1084 		}
1085 		if (status < 0)
1086 			break;
1087 		vm_wait = false;
1088 	}
1089 
1090 	switch (status) {
1091 	case -ENOTSOCK:
1092 		status = -ENOTCONN;
1093 		/* Should we call xs_close() here? */
1094 		break;
1095 	case -EAGAIN:
1096 		status = xs_stream_nospace(req);
1097 		break;
1098 	case -ECONNRESET:
1099 	case -ECONNREFUSED:
1100 	case -ENOTCONN:
1101 	case -EADDRINUSE:
1102 	case -ENOBUFS:
1103 	case -EPIPE:
1104 		break;
1105 	default:
1106 		dprintk("RPC:       sendmsg returned unrecognized error %d\n",
1107 			-status);
1108 	}
1109 
1110 	return status;
1111 }
1112 
xs_save_old_callbacks(struct sock_xprt * transport,struct sock * sk)1113 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1114 {
1115 	transport->old_data_ready = sk->sk_data_ready;
1116 	transport->old_state_change = sk->sk_state_change;
1117 	transport->old_write_space = sk->sk_write_space;
1118 	transport->old_error_report = sk->sk_error_report;
1119 }
1120 
xs_restore_old_callbacks(struct sock_xprt * transport,struct sock * sk)1121 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1122 {
1123 	sk->sk_data_ready = transport->old_data_ready;
1124 	sk->sk_state_change = transport->old_state_change;
1125 	sk->sk_write_space = transport->old_write_space;
1126 	sk->sk_error_report = transport->old_error_report;
1127 }
1128 
xs_sock_reset_state_flags(struct rpc_xprt * xprt)1129 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1130 {
1131 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1132 
1133 	clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1134 	clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state);
1135 	clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state);
1136 	clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state);
1137 	clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
1138 }
1139 
xs_run_error_worker(struct sock_xprt * transport,unsigned int nr)1140 static void xs_run_error_worker(struct sock_xprt *transport, unsigned int nr)
1141 {
1142 	set_bit(nr, &transport->sock_state);
1143 	queue_work(xprtiod_workqueue, &transport->error_worker);
1144 }
1145 
xs_sock_reset_connection_flags(struct rpc_xprt * xprt)1146 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1147 {
1148 	smp_mb__before_atomic();
1149 	clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1150 	clear_bit(XPRT_CLOSING, &xprt->state);
1151 	xs_sock_reset_state_flags(xprt);
1152 	smp_mb__after_atomic();
1153 }
1154 
1155 /**
1156  * xs_error_report - callback to handle TCP socket state errors
1157  * @sk: socket
1158  *
1159  * Note: we don't call sock_error() since there may be a rpc_task
1160  * using the socket, and so we don't want to clear sk->sk_err.
1161  */
xs_error_report(struct sock * sk)1162 static void xs_error_report(struct sock *sk)
1163 {
1164 	struct sock_xprt *transport;
1165 	struct rpc_xprt *xprt;
1166 
1167 	read_lock_bh(&sk->sk_callback_lock);
1168 	if (!(xprt = xprt_from_sock(sk)))
1169 		goto out;
1170 
1171 	transport = container_of(xprt, struct sock_xprt, xprt);
1172 	transport->xprt_err = -sk->sk_err;
1173 	if (transport->xprt_err == 0)
1174 		goto out;
1175 	dprintk("RPC:       xs_error_report client %p, error=%d...\n",
1176 			xprt, -transport->xprt_err);
1177 	trace_rpc_socket_error(xprt, sk->sk_socket, transport->xprt_err);
1178 
1179 	/* barrier ensures xprt_err is set before XPRT_SOCK_WAKE_ERROR */
1180 	smp_mb__before_atomic();
1181 	xs_run_error_worker(transport, XPRT_SOCK_WAKE_ERROR);
1182  out:
1183 	read_unlock_bh(&sk->sk_callback_lock);
1184 }
1185 
xs_reset_transport(struct sock_xprt * transport)1186 static void xs_reset_transport(struct sock_xprt *transport)
1187 {
1188 	struct socket *sock = transport->sock;
1189 	struct sock *sk = transport->inet;
1190 	struct rpc_xprt *xprt = &transport->xprt;
1191 	struct file *filp = transport->file;
1192 
1193 	if (sk == NULL)
1194 		return;
1195 	/*
1196 	 * Make sure we're calling this in a context from which it is safe
1197 	 * to call __fput_sync(). In practice that means rpciod and the
1198 	 * system workqueue.
1199 	 */
1200 	if (!(current->flags & PF_WQ_WORKER)) {
1201 		WARN_ON_ONCE(1);
1202 		set_bit(XPRT_CLOSE_WAIT, &xprt->state);
1203 		return;
1204 	}
1205 
1206 	if (atomic_read(&transport->xprt.swapper))
1207 		sk_clear_memalloc(sk);
1208 
1209 	kernel_sock_shutdown(sock, SHUT_RDWR);
1210 
1211 	mutex_lock(&transport->recv_mutex);
1212 	write_lock_bh(&sk->sk_callback_lock);
1213 	transport->inet = NULL;
1214 	transport->sock = NULL;
1215 	transport->file = NULL;
1216 
1217 	sk->sk_user_data = NULL;
1218 
1219 	xs_restore_old_callbacks(transport, sk);
1220 	xprt_clear_connected(xprt);
1221 	write_unlock_bh(&sk->sk_callback_lock);
1222 	xs_sock_reset_connection_flags(xprt);
1223 	/* Reset stream record info */
1224 	xs_stream_reset_connect(transport);
1225 	mutex_unlock(&transport->recv_mutex);
1226 
1227 	trace_rpc_socket_close(xprt, sock);
1228 	__fput_sync(filp);
1229 
1230 	xprt_disconnect_done(xprt);
1231 }
1232 
1233 /**
1234  * xs_close - close a socket
1235  * @xprt: transport
1236  *
1237  * This is used when all requests are complete; ie, no DRC state remains
1238  * on the server we want to save.
1239  *
1240  * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1241  * xs_reset_transport() zeroing the socket from underneath a writer.
1242  */
xs_close(struct rpc_xprt * xprt)1243 static void xs_close(struct rpc_xprt *xprt)
1244 {
1245 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1246 
1247 	dprintk("RPC:       xs_close xprt %p\n", xprt);
1248 
1249 	xs_reset_transport(transport);
1250 	xprt->reestablish_timeout = 0;
1251 }
1252 
xs_inject_disconnect(struct rpc_xprt * xprt)1253 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1254 {
1255 	dprintk("RPC:       injecting transport disconnect on xprt=%p\n",
1256 		xprt);
1257 	xprt_disconnect_done(xprt);
1258 }
1259 
xs_xprt_free(struct rpc_xprt * xprt)1260 static void xs_xprt_free(struct rpc_xprt *xprt)
1261 {
1262 	xs_free_peer_addresses(xprt);
1263 	xprt_free(xprt);
1264 }
1265 
1266 /**
1267  * xs_destroy - prepare to shutdown a transport
1268  * @xprt: doomed transport
1269  *
1270  */
xs_destroy(struct rpc_xprt * xprt)1271 static void xs_destroy(struct rpc_xprt *xprt)
1272 {
1273 	struct sock_xprt *transport = container_of(xprt,
1274 			struct sock_xprt, xprt);
1275 	dprintk("RPC:       xs_destroy xprt %p\n", xprt);
1276 
1277 	cancel_delayed_work_sync(&transport->connect_worker);
1278 	xs_close(xprt);
1279 	cancel_work_sync(&transport->recv_worker);
1280 	cancel_work_sync(&transport->error_worker);
1281 	xs_xprt_free(xprt);
1282 	module_put(THIS_MODULE);
1283 }
1284 
1285 /**
1286  * xs_udp_data_read_skb - receive callback for UDP sockets
1287  * @xprt: transport
1288  * @sk: socket
1289  * @skb: skbuff
1290  *
1291  */
xs_udp_data_read_skb(struct rpc_xprt * xprt,struct sock * sk,struct sk_buff * skb)1292 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1293 		struct sock *sk,
1294 		struct sk_buff *skb)
1295 {
1296 	struct rpc_task *task;
1297 	struct rpc_rqst *rovr;
1298 	int repsize, copied;
1299 	u32 _xid;
1300 	__be32 *xp;
1301 
1302 	repsize = skb->len;
1303 	if (repsize < 4) {
1304 		dprintk("RPC:       impossible RPC reply size %d!\n", repsize);
1305 		return;
1306 	}
1307 
1308 	/* Copy the XID from the skb... */
1309 	xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1310 	if (xp == NULL)
1311 		return;
1312 
1313 	/* Look up and lock the request corresponding to the given XID */
1314 	spin_lock(&xprt->queue_lock);
1315 	rovr = xprt_lookup_rqst(xprt, *xp);
1316 	if (!rovr)
1317 		goto out_unlock;
1318 	xprt_pin_rqst(rovr);
1319 	xprt_update_rtt(rovr->rq_task);
1320 	spin_unlock(&xprt->queue_lock);
1321 	task = rovr->rq_task;
1322 
1323 	if ((copied = rovr->rq_private_buf.buflen) > repsize)
1324 		copied = repsize;
1325 
1326 	/* Suck it into the iovec, verify checksum if not done by hw. */
1327 	if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1328 		spin_lock(&xprt->queue_lock);
1329 		__UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1330 		goto out_unpin;
1331 	}
1332 
1333 
1334 	spin_lock(&xprt->transport_lock);
1335 	xprt_adjust_cwnd(xprt, task, copied);
1336 	spin_unlock(&xprt->transport_lock);
1337 	spin_lock(&xprt->queue_lock);
1338 	xprt_complete_rqst(task, copied);
1339 	__UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1340 out_unpin:
1341 	xprt_unpin_rqst(rovr);
1342  out_unlock:
1343 	spin_unlock(&xprt->queue_lock);
1344 }
1345 
xs_udp_data_receive(struct sock_xprt * transport)1346 static void xs_udp_data_receive(struct sock_xprt *transport)
1347 {
1348 	struct sk_buff *skb;
1349 	struct sock *sk;
1350 	int err;
1351 
1352 	mutex_lock(&transport->recv_mutex);
1353 	sk = transport->inet;
1354 	if (sk == NULL)
1355 		goto out;
1356 	for (;;) {
1357 		skb = skb_recv_udp(sk, 0, 1, &err);
1358 		if (skb == NULL)
1359 			break;
1360 		xs_udp_data_read_skb(&transport->xprt, sk, skb);
1361 		consume_skb(skb);
1362 		cond_resched();
1363 	}
1364 	xs_poll_check_readable(transport);
1365 out:
1366 	mutex_unlock(&transport->recv_mutex);
1367 }
1368 
xs_udp_data_receive_workfn(struct work_struct * work)1369 static void xs_udp_data_receive_workfn(struct work_struct *work)
1370 {
1371 	struct sock_xprt *transport =
1372 		container_of(work, struct sock_xprt, recv_worker);
1373 	unsigned int pflags = memalloc_nofs_save();
1374 
1375 	xs_udp_data_receive(transport);
1376 	memalloc_nofs_restore(pflags);
1377 }
1378 
1379 /**
1380  * xs_data_ready - "data ready" callback for UDP sockets
1381  * @sk: socket with data to read
1382  *
1383  */
xs_data_ready(struct sock * sk)1384 static void xs_data_ready(struct sock *sk)
1385 {
1386 	struct rpc_xprt *xprt;
1387 
1388 	read_lock_bh(&sk->sk_callback_lock);
1389 	dprintk("RPC:       xs_data_ready...\n");
1390 	xprt = xprt_from_sock(sk);
1391 	if (xprt != NULL) {
1392 		struct sock_xprt *transport = container_of(xprt,
1393 				struct sock_xprt, xprt);
1394 		transport->old_data_ready(sk);
1395 		/* Any data means we had a useful conversation, so
1396 		 * then we don't need to delay the next reconnect
1397 		 */
1398 		if (xprt->reestablish_timeout)
1399 			xprt->reestablish_timeout = 0;
1400 		if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1401 			queue_work(xprtiod_workqueue, &transport->recv_worker);
1402 	}
1403 	read_unlock_bh(&sk->sk_callback_lock);
1404 }
1405 
1406 /*
1407  * Helper function to force a TCP close if the server is sending
1408  * junk and/or it has put us in CLOSE_WAIT
1409  */
xs_tcp_force_close(struct rpc_xprt * xprt)1410 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1411 {
1412 	xprt_force_disconnect(xprt);
1413 }
1414 
1415 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
xs_tcp_bc_maxpayload(struct rpc_xprt * xprt)1416 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1417 {
1418 	return PAGE_SIZE;
1419 }
1420 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1421 
1422 /**
1423  * xs_tcp_state_change - callback to handle TCP socket state changes
1424  * @sk: socket whose state has changed
1425  *
1426  */
xs_tcp_state_change(struct sock * sk)1427 static void xs_tcp_state_change(struct sock *sk)
1428 {
1429 	struct rpc_xprt *xprt;
1430 	struct sock_xprt *transport;
1431 
1432 	read_lock_bh(&sk->sk_callback_lock);
1433 	if (!(xprt = xprt_from_sock(sk)))
1434 		goto out;
1435 	dprintk("RPC:       xs_tcp_state_change client %p...\n", xprt);
1436 	dprintk("RPC:       state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1437 			sk->sk_state, xprt_connected(xprt),
1438 			sock_flag(sk, SOCK_DEAD),
1439 			sock_flag(sk, SOCK_ZAPPED),
1440 			sk->sk_shutdown);
1441 
1442 	transport = container_of(xprt, struct sock_xprt, xprt);
1443 	trace_rpc_socket_state_change(xprt, sk->sk_socket);
1444 	switch (sk->sk_state) {
1445 	case TCP_ESTABLISHED:
1446 		if (!xprt_test_and_set_connected(xprt)) {
1447 			xprt->connect_cookie++;
1448 			clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1449 			xprt_clear_connecting(xprt);
1450 
1451 			xprt->stat.connect_count++;
1452 			xprt->stat.connect_time += (long)jiffies -
1453 						   xprt->stat.connect_start;
1454 			xs_run_error_worker(transport, XPRT_SOCK_WAKE_PENDING);
1455 		}
1456 		break;
1457 	case TCP_FIN_WAIT1:
1458 		/* The client initiated a shutdown of the socket */
1459 		xprt->connect_cookie++;
1460 		xprt->reestablish_timeout = 0;
1461 		set_bit(XPRT_CLOSING, &xprt->state);
1462 		smp_mb__before_atomic();
1463 		clear_bit(XPRT_CONNECTED, &xprt->state);
1464 		clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1465 		smp_mb__after_atomic();
1466 		break;
1467 	case TCP_CLOSE_WAIT:
1468 		/* The server initiated a shutdown of the socket */
1469 		xprt->connect_cookie++;
1470 		clear_bit(XPRT_CONNECTED, &xprt->state);
1471 		xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1472 		fallthrough;
1473 	case TCP_CLOSING:
1474 		/*
1475 		 * If the server closed down the connection, make sure that
1476 		 * we back off before reconnecting
1477 		 */
1478 		if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1479 			xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1480 		break;
1481 	case TCP_LAST_ACK:
1482 		set_bit(XPRT_CLOSING, &xprt->state);
1483 		smp_mb__before_atomic();
1484 		clear_bit(XPRT_CONNECTED, &xprt->state);
1485 		smp_mb__after_atomic();
1486 		break;
1487 	case TCP_CLOSE:
1488 		if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1489 					&transport->sock_state))
1490 			xprt_clear_connecting(xprt);
1491 		clear_bit(XPRT_CLOSING, &xprt->state);
1492 		/* Trigger the socket release */
1493 		xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1494 	}
1495  out:
1496 	read_unlock_bh(&sk->sk_callback_lock);
1497 }
1498 
xs_write_space(struct sock * sk)1499 static void xs_write_space(struct sock *sk)
1500 {
1501 	struct socket_wq *wq;
1502 	struct sock_xprt *transport;
1503 	struct rpc_xprt *xprt;
1504 
1505 	if (!sk->sk_socket)
1506 		return;
1507 	clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1508 
1509 	if (unlikely(!(xprt = xprt_from_sock(sk))))
1510 		return;
1511 	transport = container_of(xprt, struct sock_xprt, xprt);
1512 	rcu_read_lock();
1513 	wq = rcu_dereference(sk->sk_wq);
1514 	if (!wq || test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags) == 0)
1515 		goto out;
1516 
1517 	xs_run_error_worker(transport, XPRT_SOCK_WAKE_WRITE);
1518 	sk->sk_write_pending--;
1519 out:
1520 	rcu_read_unlock();
1521 }
1522 
1523 /**
1524  * xs_udp_write_space - callback invoked when socket buffer space
1525  *                             becomes available
1526  * @sk: socket whose state has changed
1527  *
1528  * Called when more output buffer space is available for this socket.
1529  * We try not to wake our writers until they can make "significant"
1530  * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1531  * with a bunch of small requests.
1532  */
xs_udp_write_space(struct sock * sk)1533 static void xs_udp_write_space(struct sock *sk)
1534 {
1535 	read_lock_bh(&sk->sk_callback_lock);
1536 
1537 	/* from net/core/sock.c:sock_def_write_space */
1538 	if (sock_writeable(sk))
1539 		xs_write_space(sk);
1540 
1541 	read_unlock_bh(&sk->sk_callback_lock);
1542 }
1543 
1544 /**
1545  * xs_tcp_write_space - callback invoked when socket buffer space
1546  *                             becomes available
1547  * @sk: socket whose state has changed
1548  *
1549  * Called when more output buffer space is available for this socket.
1550  * We try not to wake our writers until they can make "significant"
1551  * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1552  * with a bunch of small requests.
1553  */
xs_tcp_write_space(struct sock * sk)1554 static void xs_tcp_write_space(struct sock *sk)
1555 {
1556 	read_lock_bh(&sk->sk_callback_lock);
1557 
1558 	/* from net/core/stream.c:sk_stream_write_space */
1559 	if (sk_stream_is_writeable(sk))
1560 		xs_write_space(sk);
1561 
1562 	read_unlock_bh(&sk->sk_callback_lock);
1563 }
1564 
xs_udp_do_set_buffer_size(struct rpc_xprt * xprt)1565 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1566 {
1567 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1568 	struct sock *sk = transport->inet;
1569 
1570 	if (transport->rcvsize) {
1571 		sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1572 		sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1573 	}
1574 	if (transport->sndsize) {
1575 		sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1576 		sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1577 		sk->sk_write_space(sk);
1578 	}
1579 }
1580 
1581 /**
1582  * xs_udp_set_buffer_size - set send and receive limits
1583  * @xprt: generic transport
1584  * @sndsize: requested size of send buffer, in bytes
1585  * @rcvsize: requested size of receive buffer, in bytes
1586  *
1587  * Set socket send and receive buffer size limits.
1588  */
xs_udp_set_buffer_size(struct rpc_xprt * xprt,size_t sndsize,size_t rcvsize)1589 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1590 {
1591 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1592 
1593 	transport->sndsize = 0;
1594 	if (sndsize)
1595 		transport->sndsize = sndsize + 1024;
1596 	transport->rcvsize = 0;
1597 	if (rcvsize)
1598 		transport->rcvsize = rcvsize + 1024;
1599 
1600 	xs_udp_do_set_buffer_size(xprt);
1601 }
1602 
1603 /**
1604  * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1605  * @xprt: controlling transport
1606  * @task: task that timed out
1607  *
1608  * Adjust the congestion window after a retransmit timeout has occurred.
1609  */
xs_udp_timer(struct rpc_xprt * xprt,struct rpc_task * task)1610 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1611 {
1612 	spin_lock(&xprt->transport_lock);
1613 	xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1614 	spin_unlock(&xprt->transport_lock);
1615 }
1616 
xs_get_random_port(void)1617 static int xs_get_random_port(void)
1618 {
1619 	unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1620 	unsigned short range;
1621 	unsigned short rand;
1622 
1623 	if (max < min)
1624 		return -EADDRINUSE;
1625 	range = max - min + 1;
1626 	rand = (unsigned short) prandom_u32() % range;
1627 	return rand + min;
1628 }
1629 
xs_sock_getport(struct socket * sock)1630 static unsigned short xs_sock_getport(struct socket *sock)
1631 {
1632 	struct sockaddr_storage buf;
1633 	unsigned short port = 0;
1634 
1635 	if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1636 		goto out;
1637 	switch (buf.ss_family) {
1638 	case AF_INET6:
1639 		port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1640 		break;
1641 	case AF_INET:
1642 		port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1643 	}
1644 out:
1645 	return port;
1646 }
1647 
1648 /**
1649  * xs_set_port - reset the port number in the remote endpoint address
1650  * @xprt: generic transport
1651  * @port: new port number
1652  *
1653  */
xs_set_port(struct rpc_xprt * xprt,unsigned short port)1654 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1655 {
1656 	dprintk("RPC:       setting port for xprt %p to %u\n", xprt, port);
1657 
1658 	rpc_set_port(xs_addr(xprt), port);
1659 	xs_update_peer_port(xprt);
1660 }
1661 
xs_set_srcport(struct sock_xprt * transport,struct socket * sock)1662 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1663 {
1664 	if (transport->srcport == 0 && transport->xprt.reuseport)
1665 		transport->srcport = xs_sock_getport(sock);
1666 }
1667 
xs_get_srcport(struct sock_xprt * transport)1668 static int xs_get_srcport(struct sock_xprt *transport)
1669 {
1670 	int port = transport->srcport;
1671 
1672 	if (port == 0 && transport->xprt.resvport)
1673 		port = xs_get_random_port();
1674 	return port;
1675 }
1676 
get_srcport(struct rpc_xprt * xprt)1677 unsigned short get_srcport(struct rpc_xprt *xprt)
1678 {
1679 	struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1680 	unsigned short ret = 0;
1681 	mutex_lock(&sock->recv_mutex);
1682 	if (sock->sock)
1683 		ret = xs_sock_getport(sock->sock);
1684 	mutex_unlock(&sock->recv_mutex);
1685 	return ret;
1686 }
1687 EXPORT_SYMBOL(get_srcport);
1688 
xs_next_srcport(struct sock_xprt * transport,unsigned short port)1689 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1690 {
1691 	if (transport->srcport != 0)
1692 		transport->srcport = 0;
1693 	if (!transport->xprt.resvport)
1694 		return 0;
1695 	if (port <= xprt_min_resvport || port > xprt_max_resvport)
1696 		return xprt_max_resvport;
1697 	return --port;
1698 }
xs_bind(struct sock_xprt * transport,struct socket * sock)1699 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1700 {
1701 	struct sockaddr_storage myaddr;
1702 	int err, nloop = 0;
1703 	int port = xs_get_srcport(transport);
1704 	unsigned short last;
1705 
1706 	/*
1707 	 * If we are asking for any ephemeral port (i.e. port == 0 &&
1708 	 * transport->xprt.resvport == 0), don't bind.  Let the local
1709 	 * port selection happen implicitly when the socket is used
1710 	 * (for example at connect time).
1711 	 *
1712 	 * This ensures that we can continue to establish TCP
1713 	 * connections even when all local ephemeral ports are already
1714 	 * a part of some TCP connection.  This makes no difference
1715 	 * for UDP sockets, but also doens't harm them.
1716 	 *
1717 	 * If we're asking for any reserved port (i.e. port == 0 &&
1718 	 * transport->xprt.resvport == 1) xs_get_srcport above will
1719 	 * ensure that port is non-zero and we will bind as needed.
1720 	 */
1721 	if (port <= 0)
1722 		return port;
1723 
1724 	memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1725 	do {
1726 		rpc_set_port((struct sockaddr *)&myaddr, port);
1727 		err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1728 				transport->xprt.addrlen);
1729 		if (err == 0) {
1730 			if (transport->xprt.reuseport)
1731 				transport->srcport = port;
1732 			break;
1733 		}
1734 		last = port;
1735 		port = xs_next_srcport(transport, port);
1736 		if (port > last)
1737 			nloop++;
1738 	} while (err == -EADDRINUSE && nloop != 2);
1739 
1740 	if (myaddr.ss_family == AF_INET)
1741 		dprintk("RPC:       %s %pI4:%u: %s (%d)\n", __func__,
1742 				&((struct sockaddr_in *)&myaddr)->sin_addr,
1743 				port, err ? "failed" : "ok", err);
1744 	else
1745 		dprintk("RPC:       %s %pI6:%u: %s (%d)\n", __func__,
1746 				&((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1747 				port, err ? "failed" : "ok", err);
1748 	return err;
1749 }
1750 
1751 /*
1752  * We don't support autobind on AF_LOCAL sockets
1753  */
xs_local_rpcbind(struct rpc_task * task)1754 static void xs_local_rpcbind(struct rpc_task *task)
1755 {
1756 	xprt_set_bound(task->tk_xprt);
1757 }
1758 
xs_local_set_port(struct rpc_xprt * xprt,unsigned short port)1759 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1760 {
1761 }
1762 
1763 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1764 static struct lock_class_key xs_key[2];
1765 static struct lock_class_key xs_slock_key[2];
1766 
xs_reclassify_socketu(struct socket * sock)1767 static inline void xs_reclassify_socketu(struct socket *sock)
1768 {
1769 	struct sock *sk = sock->sk;
1770 
1771 	sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1772 		&xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1773 }
1774 
xs_reclassify_socket4(struct socket * sock)1775 static inline void xs_reclassify_socket4(struct socket *sock)
1776 {
1777 	struct sock *sk = sock->sk;
1778 
1779 	sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1780 		&xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1781 }
1782 
xs_reclassify_socket6(struct socket * sock)1783 static inline void xs_reclassify_socket6(struct socket *sock)
1784 {
1785 	struct sock *sk = sock->sk;
1786 
1787 	sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1788 		&xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1789 }
1790 
xs_reclassify_socket(int family,struct socket * sock)1791 static inline void xs_reclassify_socket(int family, struct socket *sock)
1792 {
1793 	if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1794 		return;
1795 
1796 	switch (family) {
1797 	case AF_LOCAL:
1798 		xs_reclassify_socketu(sock);
1799 		break;
1800 	case AF_INET:
1801 		xs_reclassify_socket4(sock);
1802 		break;
1803 	case AF_INET6:
1804 		xs_reclassify_socket6(sock);
1805 		break;
1806 	}
1807 }
1808 #else
xs_reclassify_socket(int family,struct socket * sock)1809 static inline void xs_reclassify_socket(int family, struct socket *sock)
1810 {
1811 }
1812 #endif
1813 
xs_dummy_setup_socket(struct work_struct * work)1814 static void xs_dummy_setup_socket(struct work_struct *work)
1815 {
1816 }
1817 
xs_create_sock(struct rpc_xprt * xprt,struct sock_xprt * transport,int family,int type,int protocol,bool reuseport)1818 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1819 		struct sock_xprt *transport, int family, int type,
1820 		int protocol, bool reuseport)
1821 {
1822 	struct file *filp;
1823 	struct socket *sock;
1824 	int err;
1825 
1826 	err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1827 	if (err < 0) {
1828 		dprintk("RPC:       can't create %d transport socket (%d).\n",
1829 				protocol, -err);
1830 		goto out;
1831 	}
1832 	xs_reclassify_socket(family, sock);
1833 
1834 	if (reuseport)
1835 		sock_set_reuseport(sock->sk);
1836 
1837 	err = xs_bind(transport, sock);
1838 	if (err) {
1839 		sock_release(sock);
1840 		goto out;
1841 	}
1842 
1843 	if (protocol == IPPROTO_TCP) {
1844 		sock->sk->sk_net_refcnt = 1;
1845 		get_net(xprt->xprt_net);
1846 #ifdef CONFIG_PROC_FS
1847 		this_cpu_add(*xprt->xprt_net->core.sock_inuse, 1);
1848 #endif
1849 	}
1850 
1851 	filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1852 	if (IS_ERR(filp))
1853 		return ERR_CAST(filp);
1854 	transport->file = filp;
1855 
1856 	return sock;
1857 out:
1858 	return ERR_PTR(err);
1859 }
1860 
xs_local_finish_connecting(struct rpc_xprt * xprt,struct socket * sock)1861 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1862 				      struct socket *sock)
1863 {
1864 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1865 									xprt);
1866 
1867 	if (!transport->inet) {
1868 		struct sock *sk = sock->sk;
1869 
1870 		write_lock_bh(&sk->sk_callback_lock);
1871 
1872 		xs_save_old_callbacks(transport, sk);
1873 
1874 		sk->sk_user_data = xprt;
1875 		sk->sk_data_ready = xs_data_ready;
1876 		sk->sk_write_space = xs_udp_write_space;
1877 		sock_set_flag(sk, SOCK_FASYNC);
1878 		sk->sk_error_report = xs_error_report;
1879 
1880 		xprt_clear_connected(xprt);
1881 
1882 		/* Reset to new socket */
1883 		transport->sock = sock;
1884 		transport->inet = sk;
1885 
1886 		write_unlock_bh(&sk->sk_callback_lock);
1887 	}
1888 
1889 	xs_stream_start_connect(transport);
1890 
1891 	return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1892 }
1893 
1894 /**
1895  * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1896  * @transport: socket transport to connect
1897  */
xs_local_setup_socket(struct sock_xprt * transport)1898 static int xs_local_setup_socket(struct sock_xprt *transport)
1899 {
1900 	struct rpc_xprt *xprt = &transport->xprt;
1901 	struct file *filp;
1902 	struct socket *sock;
1903 	int status;
1904 
1905 	status = __sock_create(xprt->xprt_net, AF_LOCAL,
1906 					SOCK_STREAM, 0, &sock, 1);
1907 	if (status < 0) {
1908 		dprintk("RPC:       can't create AF_LOCAL "
1909 			"transport socket (%d).\n", -status);
1910 		goto out;
1911 	}
1912 	xs_reclassify_socket(AF_LOCAL, sock);
1913 
1914 	filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1915 	if (IS_ERR(filp)) {
1916 		status = PTR_ERR(filp);
1917 		goto out;
1918 	}
1919 	transport->file = filp;
1920 
1921 	dprintk("RPC:       worker connecting xprt %p via AF_LOCAL to %s\n",
1922 			xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1923 
1924 	status = xs_local_finish_connecting(xprt, sock);
1925 	trace_rpc_socket_connect(xprt, sock, status);
1926 	switch (status) {
1927 	case 0:
1928 		dprintk("RPC:       xprt %p connected to %s\n",
1929 				xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1930 		xprt->stat.connect_count++;
1931 		xprt->stat.connect_time += (long)jiffies -
1932 					   xprt->stat.connect_start;
1933 		xprt_set_connected(xprt);
1934 		break;
1935 	case -ENOBUFS:
1936 		break;
1937 	case -ENOENT:
1938 		dprintk("RPC:       xprt %p: socket %s does not exist\n",
1939 				xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1940 		break;
1941 	case -ECONNREFUSED:
1942 		dprintk("RPC:       xprt %p: connection refused for %s\n",
1943 				xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1944 		break;
1945 	default:
1946 		printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1947 				__func__, -status,
1948 				xprt->address_strings[RPC_DISPLAY_ADDR]);
1949 	}
1950 
1951 out:
1952 	xprt_clear_connecting(xprt);
1953 	xprt_wake_pending_tasks(xprt, status);
1954 	return status;
1955 }
1956 
xs_local_connect(struct rpc_xprt * xprt,struct rpc_task * task)1957 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1958 {
1959 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1960 	int ret;
1961 
1962 	 if (RPC_IS_ASYNC(task)) {
1963 		/*
1964 		 * We want the AF_LOCAL connect to be resolved in the
1965 		 * filesystem namespace of the process making the rpc
1966 		 * call.  Thus we connect synchronously.
1967 		 *
1968 		 * If we want to support asynchronous AF_LOCAL calls,
1969 		 * we'll need to figure out how to pass a namespace to
1970 		 * connect.
1971 		 */
1972 		task->tk_rpc_status = -ENOTCONN;
1973 		rpc_exit(task, -ENOTCONN);
1974 		return;
1975 	}
1976 	ret = xs_local_setup_socket(transport);
1977 	if (ret && !RPC_IS_SOFTCONN(task))
1978 		msleep_interruptible(15000);
1979 }
1980 
1981 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
1982 /*
1983  * Note that this should be called with XPRT_LOCKED held (or when we otherwise
1984  * know that we have exclusive access to the socket), to guard against
1985  * races with xs_reset_transport.
1986  */
xs_set_memalloc(struct rpc_xprt * xprt)1987 static void xs_set_memalloc(struct rpc_xprt *xprt)
1988 {
1989 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1990 			xprt);
1991 
1992 	/*
1993 	 * If there's no sock, then we have nothing to set. The
1994 	 * reconnecting process will get it for us.
1995 	 */
1996 	if (!transport->inet)
1997 		return;
1998 	if (atomic_read(&xprt->swapper))
1999 		sk_set_memalloc(transport->inet);
2000 }
2001 
2002 /**
2003  * xs_enable_swap - Tag this transport as being used for swap.
2004  * @xprt: transport to tag
2005  *
2006  * Take a reference to this transport on behalf of the rpc_clnt, and
2007  * optionally mark it for swapping if it wasn't already.
2008  */
2009 static int
xs_enable_swap(struct rpc_xprt * xprt)2010 xs_enable_swap(struct rpc_xprt *xprt)
2011 {
2012 	struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2013 
2014 	if (atomic_inc_return(&xprt->swapper) != 1)
2015 		return 0;
2016 	if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2017 		return -ERESTARTSYS;
2018 	if (xs->inet)
2019 		sk_set_memalloc(xs->inet);
2020 	xprt_release_xprt(xprt, NULL);
2021 	return 0;
2022 }
2023 
2024 /**
2025  * xs_disable_swap - Untag this transport as being used for swap.
2026  * @xprt: transport to tag
2027  *
2028  * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2029  * swapper refcount goes to 0, untag the socket as a memalloc socket.
2030  */
2031 static void
xs_disable_swap(struct rpc_xprt * xprt)2032 xs_disable_swap(struct rpc_xprt *xprt)
2033 {
2034 	struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2035 
2036 	if (!atomic_dec_and_test(&xprt->swapper))
2037 		return;
2038 	if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2039 		return;
2040 	if (xs->inet)
2041 		sk_clear_memalloc(xs->inet);
2042 	xprt_release_xprt(xprt, NULL);
2043 }
2044 #else
xs_set_memalloc(struct rpc_xprt * xprt)2045 static void xs_set_memalloc(struct rpc_xprt *xprt)
2046 {
2047 }
2048 
2049 static int
xs_enable_swap(struct rpc_xprt * xprt)2050 xs_enable_swap(struct rpc_xprt *xprt)
2051 {
2052 	return -EINVAL;
2053 }
2054 
2055 static void
xs_disable_swap(struct rpc_xprt * xprt)2056 xs_disable_swap(struct rpc_xprt *xprt)
2057 {
2058 }
2059 #endif
2060 
xs_udp_finish_connecting(struct rpc_xprt * xprt,struct socket * sock)2061 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2062 {
2063 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2064 
2065 	if (!transport->inet) {
2066 		struct sock *sk = sock->sk;
2067 
2068 		write_lock_bh(&sk->sk_callback_lock);
2069 
2070 		xs_save_old_callbacks(transport, sk);
2071 
2072 		sk->sk_user_data = xprt;
2073 		sk->sk_data_ready = xs_data_ready;
2074 		sk->sk_write_space = xs_udp_write_space;
2075 		sock_set_flag(sk, SOCK_FASYNC);
2076 
2077 		xprt_set_connected(xprt);
2078 
2079 		/* Reset to new socket */
2080 		transport->sock = sock;
2081 		transport->inet = sk;
2082 
2083 		xs_set_memalloc(xprt);
2084 
2085 		write_unlock_bh(&sk->sk_callback_lock);
2086 	}
2087 	xs_udp_do_set_buffer_size(xprt);
2088 
2089 	xprt->stat.connect_start = jiffies;
2090 }
2091 
xs_udp_setup_socket(struct work_struct * work)2092 static void xs_udp_setup_socket(struct work_struct *work)
2093 {
2094 	struct sock_xprt *transport =
2095 		container_of(work, struct sock_xprt, connect_worker.work);
2096 	struct rpc_xprt *xprt = &transport->xprt;
2097 	struct socket *sock;
2098 	int status = -EIO;
2099 
2100 	sock = xs_create_sock(xprt, transport,
2101 			xs_addr(xprt)->sa_family, SOCK_DGRAM,
2102 			IPPROTO_UDP, false);
2103 	if (IS_ERR(sock))
2104 		goto out;
2105 
2106 	dprintk("RPC:       worker connecting xprt %p via %s to "
2107 				"%s (port %s)\n", xprt,
2108 			xprt->address_strings[RPC_DISPLAY_PROTO],
2109 			xprt->address_strings[RPC_DISPLAY_ADDR],
2110 			xprt->address_strings[RPC_DISPLAY_PORT]);
2111 
2112 	xs_udp_finish_connecting(xprt, sock);
2113 	trace_rpc_socket_connect(xprt, sock, 0);
2114 	status = 0;
2115 out:
2116 	xprt_clear_connecting(xprt);
2117 	xprt_unlock_connect(xprt, transport);
2118 	xprt_wake_pending_tasks(xprt, status);
2119 }
2120 
2121 /**
2122  * xs_tcp_shutdown - gracefully shut down a TCP socket
2123  * @xprt: transport
2124  *
2125  * Initiates a graceful shutdown of the TCP socket by calling the
2126  * equivalent of shutdown(SHUT_RDWR);
2127  */
xs_tcp_shutdown(struct rpc_xprt * xprt)2128 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2129 {
2130 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2131 	struct socket *sock = transport->sock;
2132 	int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE;
2133 
2134 	if (sock == NULL)
2135 		return;
2136 	switch (skst) {
2137 	default:
2138 		kernel_sock_shutdown(sock, SHUT_RDWR);
2139 		trace_rpc_socket_shutdown(xprt, sock);
2140 		break;
2141 	case TCP_CLOSE:
2142 	case TCP_TIME_WAIT:
2143 		xs_reset_transport(transport);
2144 	}
2145 }
2146 
xs_tcp_set_socket_timeouts(struct rpc_xprt * xprt,struct socket * sock)2147 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2148 		struct socket *sock)
2149 {
2150 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2151 	unsigned int keepidle;
2152 	unsigned int keepcnt;
2153 	unsigned int timeo;
2154 
2155 	spin_lock(&xprt->transport_lock);
2156 	keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2157 	keepcnt = xprt->timeout->to_retries + 1;
2158 	timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2159 		(xprt->timeout->to_retries + 1);
2160 	clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2161 	spin_unlock(&xprt->transport_lock);
2162 
2163 	/* TCP Keepalive options */
2164 	sock_set_keepalive(sock->sk);
2165 	tcp_sock_set_keepidle(sock->sk, keepidle);
2166 	tcp_sock_set_keepintvl(sock->sk, keepidle);
2167 	tcp_sock_set_keepcnt(sock->sk, keepcnt);
2168 
2169 	/* TCP user timeout (see RFC5482) */
2170 	tcp_sock_set_user_timeout(sock->sk, timeo);
2171 }
2172 
xs_tcp_set_connect_timeout(struct rpc_xprt * xprt,unsigned long connect_timeout,unsigned long reconnect_timeout)2173 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2174 		unsigned long connect_timeout,
2175 		unsigned long reconnect_timeout)
2176 {
2177 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2178 	struct rpc_timeout to;
2179 	unsigned long initval;
2180 
2181 	spin_lock(&xprt->transport_lock);
2182 	if (reconnect_timeout < xprt->max_reconnect_timeout)
2183 		xprt->max_reconnect_timeout = reconnect_timeout;
2184 	if (connect_timeout < xprt->connect_timeout) {
2185 		memcpy(&to, xprt->timeout, sizeof(to));
2186 		initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1);
2187 		/* Arbitrary lower limit */
2188 		if (initval <  XS_TCP_INIT_REEST_TO << 1)
2189 			initval = XS_TCP_INIT_REEST_TO << 1;
2190 		to.to_initval = initval;
2191 		to.to_maxval = initval;
2192 		memcpy(&transport->tcp_timeout, &to,
2193 				sizeof(transport->tcp_timeout));
2194 		xprt->timeout = &transport->tcp_timeout;
2195 		xprt->connect_timeout = connect_timeout;
2196 	}
2197 	set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2198 	spin_unlock(&xprt->transport_lock);
2199 }
2200 
xs_tcp_finish_connecting(struct rpc_xprt * xprt,struct socket * sock)2201 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2202 {
2203 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2204 	int ret = -ENOTCONN;
2205 
2206 	if (!transport->inet) {
2207 		struct sock *sk = sock->sk;
2208 
2209 		/* Avoid temporary address, they are bad for long-lived
2210 		 * connections such as NFS mounts.
2211 		 * RFC4941, section 3.6 suggests that:
2212 		 *    Individual applications, which have specific
2213 		 *    knowledge about the normal duration of connections,
2214 		 *    MAY override this as appropriate.
2215 		 */
2216 		if (xs_addr(xprt)->sa_family == PF_INET6) {
2217 			ip6_sock_set_addr_preferences(sk,
2218 				IPV6_PREFER_SRC_PUBLIC);
2219 		}
2220 
2221 		xs_tcp_set_socket_timeouts(xprt, sock);
2222 
2223 		write_lock_bh(&sk->sk_callback_lock);
2224 
2225 		xs_save_old_callbacks(transport, sk);
2226 
2227 		sk->sk_user_data = xprt;
2228 		sk->sk_data_ready = xs_data_ready;
2229 		sk->sk_state_change = xs_tcp_state_change;
2230 		sk->sk_write_space = xs_tcp_write_space;
2231 		sock_set_flag(sk, SOCK_FASYNC);
2232 		sk->sk_error_report = xs_error_report;
2233 
2234 		/* socket options */
2235 		sock_reset_flag(sk, SOCK_LINGER);
2236 		tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2237 
2238 		xprt_clear_connected(xprt);
2239 
2240 		/* Reset to new socket */
2241 		transport->sock = sock;
2242 		transport->inet = sk;
2243 
2244 		write_unlock_bh(&sk->sk_callback_lock);
2245 	}
2246 
2247 	if (!xprt_bound(xprt))
2248 		goto out;
2249 
2250 	xs_set_memalloc(xprt);
2251 
2252 	xs_stream_start_connect(transport);
2253 
2254 	/* Tell the socket layer to start connecting... */
2255 	set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2256 	ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2257 	switch (ret) {
2258 	case 0:
2259 		xs_set_srcport(transport, sock);
2260 		fallthrough;
2261 	case -EINPROGRESS:
2262 		/* SYN_SENT! */
2263 		if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2264 			xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2265 		break;
2266 	case -EADDRNOTAVAIL:
2267 		/* Source port number is unavailable. Try a new one! */
2268 		transport->srcport = 0;
2269 	}
2270 out:
2271 	return ret;
2272 }
2273 
2274 /**
2275  * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2276  * @work: queued work item
2277  *
2278  * Invoked by a work queue tasklet.
2279  */
xs_tcp_setup_socket(struct work_struct * work)2280 static void xs_tcp_setup_socket(struct work_struct *work)
2281 {
2282 	struct sock_xprt *transport =
2283 		container_of(work, struct sock_xprt, connect_worker.work);
2284 	struct socket *sock = transport->sock;
2285 	struct rpc_xprt *xprt = &transport->xprt;
2286 	int status = -EIO;
2287 
2288 	if (xprt_connected(xprt))
2289 		goto out;
2290 	if (test_and_clear_bit(XPRT_SOCK_CONNECT_SENT,
2291 			       &transport->sock_state) ||
2292 	    !sock) {
2293 		xs_reset_transport(transport);
2294 		sock = xs_create_sock(xprt, transport, xs_addr(xprt)->sa_family,
2295 				      SOCK_STREAM, IPPROTO_TCP, true);
2296 		if (IS_ERR(sock)) {
2297 			status = PTR_ERR(sock);
2298 			goto out;
2299 		}
2300 	}
2301 
2302 	dprintk("RPC:       worker connecting xprt %p via %s to "
2303 				"%s (port %s)\n", xprt,
2304 			xprt->address_strings[RPC_DISPLAY_PROTO],
2305 			xprt->address_strings[RPC_DISPLAY_ADDR],
2306 			xprt->address_strings[RPC_DISPLAY_PORT]);
2307 
2308 	status = xs_tcp_finish_connecting(xprt, sock);
2309 	trace_rpc_socket_connect(xprt, sock, status);
2310 	dprintk("RPC:       %p connect status %d connected %d sock state %d\n",
2311 			xprt, -status, xprt_connected(xprt),
2312 			sock->sk->sk_state);
2313 	switch (status) {
2314 	default:
2315 		printk("%s: connect returned unhandled error %d\n",
2316 			__func__, status);
2317 		fallthrough;
2318 	case -EADDRNOTAVAIL:
2319 		/* We're probably in TIME_WAIT. Get rid of existing socket,
2320 		 * and retry
2321 		 */
2322 		xs_tcp_force_close(xprt);
2323 		break;
2324 	case 0:
2325 	case -EINPROGRESS:
2326 		set_bit(XPRT_SOCK_CONNECT_SENT, &transport->sock_state);
2327 		fallthrough;
2328 	case -EALREADY:
2329 		xprt_unlock_connect(xprt, transport);
2330 		return;
2331 	case -EINVAL:
2332 		/* Happens, for instance, if the user specified a link
2333 		 * local IPv6 address without a scope-id.
2334 		 */
2335 	case -ECONNREFUSED:
2336 	case -ECONNRESET:
2337 	case -ENETDOWN:
2338 	case -ENETUNREACH:
2339 	case -EHOSTUNREACH:
2340 	case -EADDRINUSE:
2341 	case -ENOBUFS:
2342 		/*
2343 		 * xs_tcp_force_close() wakes tasks with -EIO.
2344 		 * We need to wake them first to ensure the
2345 		 * correct error code.
2346 		 */
2347 		xprt_wake_pending_tasks(xprt, status);
2348 		xs_tcp_force_close(xprt);
2349 		goto out;
2350 	}
2351 	status = -EAGAIN;
2352 out:
2353 	xprt_clear_connecting(xprt);
2354 	xprt_unlock_connect(xprt, transport);
2355 	xprt_wake_pending_tasks(xprt, status);
2356 }
2357 
2358 /**
2359  * xs_connect - connect a socket to a remote endpoint
2360  * @xprt: pointer to transport structure
2361  * @task: address of RPC task that manages state of connect request
2362  *
2363  * TCP: If the remote end dropped the connection, delay reconnecting.
2364  *
2365  * UDP socket connects are synchronous, but we use a work queue anyway
2366  * to guarantee that even unprivileged user processes can set up a
2367  * socket on a privileged port.
2368  *
2369  * If a UDP socket connect fails, the delay behavior here prevents
2370  * retry floods (hard mounts).
2371  */
xs_connect(struct rpc_xprt * xprt,struct rpc_task * task)2372 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2373 {
2374 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2375 	unsigned long delay = 0;
2376 
2377 	WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2378 
2379 	if (transport->sock != NULL) {
2380 		dprintk("RPC:       xs_connect delayed xprt %p for %lu "
2381 			"seconds\n", xprt, xprt->reestablish_timeout / HZ);
2382 
2383 		delay = xprt_reconnect_delay(xprt);
2384 		xprt_reconnect_backoff(xprt, XS_TCP_INIT_REEST_TO);
2385 
2386 	} else
2387 		dprintk("RPC:       xs_connect scheduled xprt %p\n", xprt);
2388 
2389 	queue_delayed_work(xprtiod_workqueue,
2390 			&transport->connect_worker,
2391 			delay);
2392 }
2393 
xs_wake_disconnect(struct sock_xprt * transport)2394 static void xs_wake_disconnect(struct sock_xprt *transport)
2395 {
2396 	if (test_and_clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state))
2397 		xs_tcp_force_close(&transport->xprt);
2398 }
2399 
xs_wake_write(struct sock_xprt * transport)2400 static void xs_wake_write(struct sock_xprt *transport)
2401 {
2402 	if (test_and_clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state))
2403 		xprt_write_space(&transport->xprt);
2404 }
2405 
xs_wake_error(struct sock_xprt * transport)2406 static void xs_wake_error(struct sock_xprt *transport)
2407 {
2408 	int sockerr;
2409 
2410 	if (!test_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2411 		return;
2412 	mutex_lock(&transport->recv_mutex);
2413 	if (transport->sock == NULL)
2414 		goto out;
2415 	if (!test_and_clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2416 		goto out;
2417 	sockerr = xchg(&transport->xprt_err, 0);
2418 	if (sockerr < 0)
2419 		xprt_wake_pending_tasks(&transport->xprt, sockerr);
2420 out:
2421 	mutex_unlock(&transport->recv_mutex);
2422 }
2423 
xs_wake_pending(struct sock_xprt * transport)2424 static void xs_wake_pending(struct sock_xprt *transport)
2425 {
2426 	if (test_and_clear_bit(XPRT_SOCK_WAKE_PENDING, &transport->sock_state))
2427 		xprt_wake_pending_tasks(&transport->xprt, -EAGAIN);
2428 }
2429 
xs_error_handle(struct work_struct * work)2430 static void xs_error_handle(struct work_struct *work)
2431 {
2432 	struct sock_xprt *transport = container_of(work,
2433 			struct sock_xprt, error_worker);
2434 
2435 	xs_wake_disconnect(transport);
2436 	xs_wake_write(transport);
2437 	xs_wake_error(transport);
2438 	xs_wake_pending(transport);
2439 }
2440 
2441 /**
2442  * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2443  * @xprt: rpc_xprt struct containing statistics
2444  * @seq: output file
2445  *
2446  */
xs_local_print_stats(struct rpc_xprt * xprt,struct seq_file * seq)2447 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2448 {
2449 	long idle_time = 0;
2450 
2451 	if (xprt_connected(xprt))
2452 		idle_time = (long)(jiffies - xprt->last_used) / HZ;
2453 
2454 	seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2455 			"%llu %llu %lu %llu %llu\n",
2456 			xprt->stat.bind_count,
2457 			xprt->stat.connect_count,
2458 			xprt->stat.connect_time / HZ,
2459 			idle_time,
2460 			xprt->stat.sends,
2461 			xprt->stat.recvs,
2462 			xprt->stat.bad_xids,
2463 			xprt->stat.req_u,
2464 			xprt->stat.bklog_u,
2465 			xprt->stat.max_slots,
2466 			xprt->stat.sending_u,
2467 			xprt->stat.pending_u);
2468 }
2469 
2470 /**
2471  * xs_udp_print_stats - display UDP socket-specifc stats
2472  * @xprt: rpc_xprt struct containing statistics
2473  * @seq: output file
2474  *
2475  */
xs_udp_print_stats(struct rpc_xprt * xprt,struct seq_file * seq)2476 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2477 {
2478 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2479 
2480 	seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2481 			"%lu %llu %llu\n",
2482 			transport->srcport,
2483 			xprt->stat.bind_count,
2484 			xprt->stat.sends,
2485 			xprt->stat.recvs,
2486 			xprt->stat.bad_xids,
2487 			xprt->stat.req_u,
2488 			xprt->stat.bklog_u,
2489 			xprt->stat.max_slots,
2490 			xprt->stat.sending_u,
2491 			xprt->stat.pending_u);
2492 }
2493 
2494 /**
2495  * xs_tcp_print_stats - display TCP socket-specifc stats
2496  * @xprt: rpc_xprt struct containing statistics
2497  * @seq: output file
2498  *
2499  */
xs_tcp_print_stats(struct rpc_xprt * xprt,struct seq_file * seq)2500 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2501 {
2502 	struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2503 	long idle_time = 0;
2504 
2505 	if (xprt_connected(xprt))
2506 		idle_time = (long)(jiffies - xprt->last_used) / HZ;
2507 
2508 	seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2509 			"%llu %llu %lu %llu %llu\n",
2510 			transport->srcport,
2511 			xprt->stat.bind_count,
2512 			xprt->stat.connect_count,
2513 			xprt->stat.connect_time / HZ,
2514 			idle_time,
2515 			xprt->stat.sends,
2516 			xprt->stat.recvs,
2517 			xprt->stat.bad_xids,
2518 			xprt->stat.req_u,
2519 			xprt->stat.bklog_u,
2520 			xprt->stat.max_slots,
2521 			xprt->stat.sending_u,
2522 			xprt->stat.pending_u);
2523 }
2524 
2525 /*
2526  * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2527  * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2528  * to use the server side send routines.
2529  */
bc_malloc(struct rpc_task * task)2530 static int bc_malloc(struct rpc_task *task)
2531 {
2532 	struct rpc_rqst *rqst = task->tk_rqstp;
2533 	size_t size = rqst->rq_callsize;
2534 	struct page *page;
2535 	struct rpc_buffer *buf;
2536 
2537 	if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2538 		WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2539 			  size);
2540 		return -EINVAL;
2541 	}
2542 
2543 	page = alloc_page(GFP_KERNEL);
2544 	if (!page)
2545 		return -ENOMEM;
2546 
2547 	buf = page_address(page);
2548 	buf->len = PAGE_SIZE;
2549 
2550 	rqst->rq_buffer = buf->data;
2551 	rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2552 	return 0;
2553 }
2554 
2555 /*
2556  * Free the space allocated in the bc_alloc routine
2557  */
bc_free(struct rpc_task * task)2558 static void bc_free(struct rpc_task *task)
2559 {
2560 	void *buffer = task->tk_rqstp->rq_buffer;
2561 	struct rpc_buffer *buf;
2562 
2563 	buf = container_of(buffer, struct rpc_buffer, data);
2564 	free_page((unsigned long)buf);
2565 }
2566 
bc_sendto(struct rpc_rqst * req)2567 static int bc_sendto(struct rpc_rqst *req)
2568 {
2569 	struct xdr_buf *xdr = &req->rq_snd_buf;
2570 	struct sock_xprt *transport =
2571 			container_of(req->rq_xprt, struct sock_xprt, xprt);
2572 	struct msghdr msg = {
2573 		.msg_flags	= 0,
2574 	};
2575 	rpc_fraghdr marker = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT |
2576 					 (u32)xdr->len);
2577 	unsigned int sent = 0;
2578 	int err;
2579 
2580 	req->rq_xtime = ktime_get();
2581 	err = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, marker, &sent);
2582 	xdr_free_bvec(xdr);
2583 	if (err < 0 || sent != (xdr->len + sizeof(marker)))
2584 		return -EAGAIN;
2585 	return sent;
2586 }
2587 
2588 /**
2589  * bc_send_request - Send a backchannel Call on a TCP socket
2590  * @req: rpc_rqst containing Call message to be sent
2591  *
2592  * xpt_mutex ensures @rqstp's whole message is written to the socket
2593  * without interruption.
2594  *
2595  * Return values:
2596  *   %0 if the message was sent successfully
2597  *   %ENOTCONN if the message was not sent
2598  */
bc_send_request(struct rpc_rqst * req)2599 static int bc_send_request(struct rpc_rqst *req)
2600 {
2601 	struct svc_xprt	*xprt;
2602 	int len;
2603 
2604 	/*
2605 	 * Get the server socket associated with this callback xprt
2606 	 */
2607 	xprt = req->rq_xprt->bc_xprt;
2608 
2609 	/*
2610 	 * Grab the mutex to serialize data as the connection is shared
2611 	 * with the fore channel
2612 	 */
2613 	mutex_lock(&xprt->xpt_mutex);
2614 	if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2615 		len = -ENOTCONN;
2616 	else
2617 		len = bc_sendto(req);
2618 	mutex_unlock(&xprt->xpt_mutex);
2619 
2620 	if (len > 0)
2621 		len = 0;
2622 
2623 	return len;
2624 }
2625 
2626 /*
2627  * The close routine. Since this is client initiated, we do nothing
2628  */
2629 
bc_close(struct rpc_xprt * xprt)2630 static void bc_close(struct rpc_xprt *xprt)
2631 {
2632 	xprt_disconnect_done(xprt);
2633 }
2634 
2635 /*
2636  * The xprt destroy routine. Again, because this connection is client
2637  * initiated, we do nothing
2638  */
2639 
bc_destroy(struct rpc_xprt * xprt)2640 static void bc_destroy(struct rpc_xprt *xprt)
2641 {
2642 	dprintk("RPC:       bc_destroy xprt %p\n", xprt);
2643 
2644 	xs_xprt_free(xprt);
2645 	module_put(THIS_MODULE);
2646 }
2647 
2648 static const struct rpc_xprt_ops xs_local_ops = {
2649 	.reserve_xprt		= xprt_reserve_xprt,
2650 	.release_xprt		= xprt_release_xprt,
2651 	.alloc_slot		= xprt_alloc_slot,
2652 	.free_slot		= xprt_free_slot,
2653 	.rpcbind		= xs_local_rpcbind,
2654 	.set_port		= xs_local_set_port,
2655 	.connect		= xs_local_connect,
2656 	.buf_alloc		= rpc_malloc,
2657 	.buf_free		= rpc_free,
2658 	.prepare_request	= xs_stream_prepare_request,
2659 	.send_request		= xs_local_send_request,
2660 	.wait_for_reply_request	= xprt_wait_for_reply_request_def,
2661 	.close			= xs_close,
2662 	.destroy		= xs_destroy,
2663 	.print_stats		= xs_local_print_stats,
2664 	.enable_swap		= xs_enable_swap,
2665 	.disable_swap		= xs_disable_swap,
2666 };
2667 
2668 static const struct rpc_xprt_ops xs_udp_ops = {
2669 	.set_buffer_size	= xs_udp_set_buffer_size,
2670 	.reserve_xprt		= xprt_reserve_xprt_cong,
2671 	.release_xprt		= xprt_release_xprt_cong,
2672 	.alloc_slot		= xprt_alloc_slot,
2673 	.free_slot		= xprt_free_slot,
2674 	.rpcbind		= rpcb_getport_async,
2675 	.set_port		= xs_set_port,
2676 	.connect		= xs_connect,
2677 	.buf_alloc		= rpc_malloc,
2678 	.buf_free		= rpc_free,
2679 	.send_request		= xs_udp_send_request,
2680 	.wait_for_reply_request	= xprt_wait_for_reply_request_rtt,
2681 	.timer			= xs_udp_timer,
2682 	.release_request	= xprt_release_rqst_cong,
2683 	.close			= xs_close,
2684 	.destroy		= xs_destroy,
2685 	.print_stats		= xs_udp_print_stats,
2686 	.enable_swap		= xs_enable_swap,
2687 	.disable_swap		= xs_disable_swap,
2688 	.inject_disconnect	= xs_inject_disconnect,
2689 };
2690 
2691 static const struct rpc_xprt_ops xs_tcp_ops = {
2692 	.reserve_xprt		= xprt_reserve_xprt,
2693 	.release_xprt		= xprt_release_xprt,
2694 	.alloc_slot		= xprt_alloc_slot,
2695 	.free_slot		= xprt_free_slot,
2696 	.rpcbind		= rpcb_getport_async,
2697 	.set_port		= xs_set_port,
2698 	.connect		= xs_connect,
2699 	.buf_alloc		= rpc_malloc,
2700 	.buf_free		= rpc_free,
2701 	.prepare_request	= xs_stream_prepare_request,
2702 	.send_request		= xs_tcp_send_request,
2703 	.wait_for_reply_request	= xprt_wait_for_reply_request_def,
2704 	.close			= xs_tcp_shutdown,
2705 	.destroy		= xs_destroy,
2706 	.set_connect_timeout	= xs_tcp_set_connect_timeout,
2707 	.print_stats		= xs_tcp_print_stats,
2708 	.enable_swap		= xs_enable_swap,
2709 	.disable_swap		= xs_disable_swap,
2710 	.inject_disconnect	= xs_inject_disconnect,
2711 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2712 	.bc_setup		= xprt_setup_bc,
2713 	.bc_maxpayload		= xs_tcp_bc_maxpayload,
2714 	.bc_num_slots		= xprt_bc_max_slots,
2715 	.bc_free_rqst		= xprt_free_bc_rqst,
2716 	.bc_destroy		= xprt_destroy_bc,
2717 #endif
2718 };
2719 
2720 /*
2721  * The rpc_xprt_ops for the server backchannel
2722  */
2723 
2724 static const struct rpc_xprt_ops bc_tcp_ops = {
2725 	.reserve_xprt		= xprt_reserve_xprt,
2726 	.release_xprt		= xprt_release_xprt,
2727 	.alloc_slot		= xprt_alloc_slot,
2728 	.free_slot		= xprt_free_slot,
2729 	.buf_alloc		= bc_malloc,
2730 	.buf_free		= bc_free,
2731 	.send_request		= bc_send_request,
2732 	.wait_for_reply_request	= xprt_wait_for_reply_request_def,
2733 	.close			= bc_close,
2734 	.destroy		= bc_destroy,
2735 	.print_stats		= xs_tcp_print_stats,
2736 	.enable_swap		= xs_enable_swap,
2737 	.disable_swap		= xs_disable_swap,
2738 	.inject_disconnect	= xs_inject_disconnect,
2739 };
2740 
xs_init_anyaddr(const int family,struct sockaddr * sap)2741 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2742 {
2743 	static const struct sockaddr_in sin = {
2744 		.sin_family		= AF_INET,
2745 		.sin_addr.s_addr	= htonl(INADDR_ANY),
2746 	};
2747 	static const struct sockaddr_in6 sin6 = {
2748 		.sin6_family		= AF_INET6,
2749 		.sin6_addr		= IN6ADDR_ANY_INIT,
2750 	};
2751 
2752 	switch (family) {
2753 	case AF_LOCAL:
2754 		break;
2755 	case AF_INET:
2756 		memcpy(sap, &sin, sizeof(sin));
2757 		break;
2758 	case AF_INET6:
2759 		memcpy(sap, &sin6, sizeof(sin6));
2760 		break;
2761 	default:
2762 		dprintk("RPC:       %s: Bad address family\n", __func__);
2763 		return -EAFNOSUPPORT;
2764 	}
2765 	return 0;
2766 }
2767 
xs_setup_xprt(struct xprt_create * args,unsigned int slot_table_size,unsigned int max_slot_table_size)2768 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2769 				      unsigned int slot_table_size,
2770 				      unsigned int max_slot_table_size)
2771 {
2772 	struct rpc_xprt *xprt;
2773 	struct sock_xprt *new;
2774 
2775 	if (args->addrlen > sizeof(xprt->addr)) {
2776 		dprintk("RPC:       xs_setup_xprt: address too large\n");
2777 		return ERR_PTR(-EBADF);
2778 	}
2779 
2780 	xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2781 			max_slot_table_size);
2782 	if (xprt == NULL) {
2783 		dprintk("RPC:       xs_setup_xprt: couldn't allocate "
2784 				"rpc_xprt\n");
2785 		return ERR_PTR(-ENOMEM);
2786 	}
2787 
2788 	new = container_of(xprt, struct sock_xprt, xprt);
2789 	mutex_init(&new->recv_mutex);
2790 	memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2791 	xprt->addrlen = args->addrlen;
2792 	if (args->srcaddr)
2793 		memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2794 	else {
2795 		int err;
2796 		err = xs_init_anyaddr(args->dstaddr->sa_family,
2797 					(struct sockaddr *)&new->srcaddr);
2798 		if (err != 0) {
2799 			xprt_free(xprt);
2800 			return ERR_PTR(err);
2801 		}
2802 	}
2803 
2804 	return xprt;
2805 }
2806 
2807 static const struct rpc_timeout xs_local_default_timeout = {
2808 	.to_initval = 10 * HZ,
2809 	.to_maxval = 10 * HZ,
2810 	.to_retries = 2,
2811 };
2812 
2813 /**
2814  * xs_setup_local - Set up transport to use an AF_LOCAL socket
2815  * @args: rpc transport creation arguments
2816  *
2817  * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2818  */
xs_setup_local(struct xprt_create * args)2819 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2820 {
2821 	struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2822 	struct sock_xprt *transport;
2823 	struct rpc_xprt *xprt;
2824 	struct rpc_xprt *ret;
2825 
2826 	xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2827 			xprt_max_tcp_slot_table_entries);
2828 	if (IS_ERR(xprt))
2829 		return xprt;
2830 	transport = container_of(xprt, struct sock_xprt, xprt);
2831 
2832 	xprt->prot = 0;
2833 	xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2834 
2835 	xprt->bind_timeout = XS_BIND_TO;
2836 	xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2837 	xprt->idle_timeout = XS_IDLE_DISC_TO;
2838 
2839 	xprt->ops = &xs_local_ops;
2840 	xprt->timeout = &xs_local_default_timeout;
2841 
2842 	INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2843 	INIT_WORK(&transport->error_worker, xs_error_handle);
2844 	INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
2845 
2846 	switch (sun->sun_family) {
2847 	case AF_LOCAL:
2848 		if (sun->sun_path[0] != '/') {
2849 			dprintk("RPC:       bad AF_LOCAL address: %s\n",
2850 					sun->sun_path);
2851 			ret = ERR_PTR(-EINVAL);
2852 			goto out_err;
2853 		}
2854 		xprt_set_bound(xprt);
2855 		xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2856 		break;
2857 	default:
2858 		ret = ERR_PTR(-EAFNOSUPPORT);
2859 		goto out_err;
2860 	}
2861 
2862 	dprintk("RPC:       set up xprt to %s via AF_LOCAL\n",
2863 			xprt->address_strings[RPC_DISPLAY_ADDR]);
2864 
2865 	if (try_module_get(THIS_MODULE))
2866 		return xprt;
2867 	ret = ERR_PTR(-EINVAL);
2868 out_err:
2869 	xs_xprt_free(xprt);
2870 	return ret;
2871 }
2872 
2873 static const struct rpc_timeout xs_udp_default_timeout = {
2874 	.to_initval = 5 * HZ,
2875 	.to_maxval = 30 * HZ,
2876 	.to_increment = 5 * HZ,
2877 	.to_retries = 5,
2878 };
2879 
2880 /**
2881  * xs_setup_udp - Set up transport to use a UDP socket
2882  * @args: rpc transport creation arguments
2883  *
2884  */
xs_setup_udp(struct xprt_create * args)2885 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2886 {
2887 	struct sockaddr *addr = args->dstaddr;
2888 	struct rpc_xprt *xprt;
2889 	struct sock_xprt *transport;
2890 	struct rpc_xprt *ret;
2891 
2892 	xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2893 			xprt_udp_slot_table_entries);
2894 	if (IS_ERR(xprt))
2895 		return xprt;
2896 	transport = container_of(xprt, struct sock_xprt, xprt);
2897 
2898 	xprt->prot = IPPROTO_UDP;
2899 	/* XXX: header size can vary due to auth type, IPv6, etc. */
2900 	xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2901 
2902 	xprt->bind_timeout = XS_BIND_TO;
2903 	xprt->reestablish_timeout = XS_UDP_REEST_TO;
2904 	xprt->idle_timeout = XS_IDLE_DISC_TO;
2905 
2906 	xprt->ops = &xs_udp_ops;
2907 
2908 	xprt->timeout = &xs_udp_default_timeout;
2909 
2910 	INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
2911 	INIT_WORK(&transport->error_worker, xs_error_handle);
2912 	INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
2913 
2914 	switch (addr->sa_family) {
2915 	case AF_INET:
2916 		if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2917 			xprt_set_bound(xprt);
2918 
2919 		xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2920 		break;
2921 	case AF_INET6:
2922 		if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2923 			xprt_set_bound(xprt);
2924 
2925 		xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2926 		break;
2927 	default:
2928 		ret = ERR_PTR(-EAFNOSUPPORT);
2929 		goto out_err;
2930 	}
2931 
2932 	if (xprt_bound(xprt))
2933 		dprintk("RPC:       set up xprt to %s (port %s) via %s\n",
2934 				xprt->address_strings[RPC_DISPLAY_ADDR],
2935 				xprt->address_strings[RPC_DISPLAY_PORT],
2936 				xprt->address_strings[RPC_DISPLAY_PROTO]);
2937 	else
2938 		dprintk("RPC:       set up xprt to %s (autobind) via %s\n",
2939 				xprt->address_strings[RPC_DISPLAY_ADDR],
2940 				xprt->address_strings[RPC_DISPLAY_PROTO]);
2941 
2942 	if (try_module_get(THIS_MODULE))
2943 		return xprt;
2944 	ret = ERR_PTR(-EINVAL);
2945 out_err:
2946 	xs_xprt_free(xprt);
2947 	return ret;
2948 }
2949 
2950 static const struct rpc_timeout xs_tcp_default_timeout = {
2951 	.to_initval = 60 * HZ,
2952 	.to_maxval = 60 * HZ,
2953 	.to_retries = 2,
2954 };
2955 
2956 /**
2957  * xs_setup_tcp - Set up transport to use a TCP socket
2958  * @args: rpc transport creation arguments
2959  *
2960  */
xs_setup_tcp(struct xprt_create * args)2961 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2962 {
2963 	struct sockaddr *addr = args->dstaddr;
2964 	struct rpc_xprt *xprt;
2965 	struct sock_xprt *transport;
2966 	struct rpc_xprt *ret;
2967 	unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
2968 
2969 	if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
2970 		max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
2971 
2972 	xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2973 			max_slot_table_size);
2974 	if (IS_ERR(xprt))
2975 		return xprt;
2976 	transport = container_of(xprt, struct sock_xprt, xprt);
2977 
2978 	xprt->prot = IPPROTO_TCP;
2979 	xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2980 
2981 	xprt->bind_timeout = XS_BIND_TO;
2982 	xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2983 	xprt->idle_timeout = XS_IDLE_DISC_TO;
2984 
2985 	xprt->ops = &xs_tcp_ops;
2986 	xprt->timeout = &xs_tcp_default_timeout;
2987 
2988 	xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
2989 	xprt->connect_timeout = xprt->timeout->to_initval *
2990 		(xprt->timeout->to_retries + 1);
2991 
2992 	INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2993 	INIT_WORK(&transport->error_worker, xs_error_handle);
2994 	INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
2995 
2996 	switch (addr->sa_family) {
2997 	case AF_INET:
2998 		if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2999 			xprt_set_bound(xprt);
3000 
3001 		xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3002 		break;
3003 	case AF_INET6:
3004 		if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3005 			xprt_set_bound(xprt);
3006 
3007 		xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3008 		break;
3009 	default:
3010 		ret = ERR_PTR(-EAFNOSUPPORT);
3011 		goto out_err;
3012 	}
3013 
3014 	if (xprt_bound(xprt))
3015 		dprintk("RPC:       set up xprt to %s (port %s) via %s\n",
3016 				xprt->address_strings[RPC_DISPLAY_ADDR],
3017 				xprt->address_strings[RPC_DISPLAY_PORT],
3018 				xprt->address_strings[RPC_DISPLAY_PROTO]);
3019 	else
3020 		dprintk("RPC:       set up xprt to %s (autobind) via %s\n",
3021 				xprt->address_strings[RPC_DISPLAY_ADDR],
3022 				xprt->address_strings[RPC_DISPLAY_PROTO]);
3023 
3024 	if (try_module_get(THIS_MODULE))
3025 		return xprt;
3026 	ret = ERR_PTR(-EINVAL);
3027 out_err:
3028 	xs_xprt_free(xprt);
3029 	return ret;
3030 }
3031 
3032 /**
3033  * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3034  * @args: rpc transport creation arguments
3035  *
3036  */
xs_setup_bc_tcp(struct xprt_create * args)3037 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
3038 {
3039 	struct sockaddr *addr = args->dstaddr;
3040 	struct rpc_xprt *xprt;
3041 	struct sock_xprt *transport;
3042 	struct svc_sock *bc_sock;
3043 	struct rpc_xprt *ret;
3044 
3045 	xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3046 			xprt_tcp_slot_table_entries);
3047 	if (IS_ERR(xprt))
3048 		return xprt;
3049 	transport = container_of(xprt, struct sock_xprt, xprt);
3050 
3051 	xprt->prot = IPPROTO_TCP;
3052 	xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3053 	xprt->timeout = &xs_tcp_default_timeout;
3054 
3055 	/* backchannel */
3056 	xprt_set_bound(xprt);
3057 	xprt->bind_timeout = 0;
3058 	xprt->reestablish_timeout = 0;
3059 	xprt->idle_timeout = 0;
3060 
3061 	xprt->ops = &bc_tcp_ops;
3062 
3063 	switch (addr->sa_family) {
3064 	case AF_INET:
3065 		xs_format_peer_addresses(xprt, "tcp",
3066 					 RPCBIND_NETID_TCP);
3067 		break;
3068 	case AF_INET6:
3069 		xs_format_peer_addresses(xprt, "tcp",
3070 				   RPCBIND_NETID_TCP6);
3071 		break;
3072 	default:
3073 		ret = ERR_PTR(-EAFNOSUPPORT);
3074 		goto out_err;
3075 	}
3076 
3077 	dprintk("RPC:       set up xprt to %s (port %s) via %s\n",
3078 			xprt->address_strings[RPC_DISPLAY_ADDR],
3079 			xprt->address_strings[RPC_DISPLAY_PORT],
3080 			xprt->address_strings[RPC_DISPLAY_PROTO]);
3081 
3082 	/*
3083 	 * Once we've associated a backchannel xprt with a connection,
3084 	 * we want to keep it around as long as the connection lasts,
3085 	 * in case we need to start using it for a backchannel again;
3086 	 * this reference won't be dropped until bc_xprt is destroyed.
3087 	 */
3088 	xprt_get(xprt);
3089 	args->bc_xprt->xpt_bc_xprt = xprt;
3090 	xprt->bc_xprt = args->bc_xprt;
3091 	bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3092 	transport->sock = bc_sock->sk_sock;
3093 	transport->inet = bc_sock->sk_sk;
3094 
3095 	/*
3096 	 * Since we don't want connections for the backchannel, we set
3097 	 * the xprt status to connected
3098 	 */
3099 	xprt_set_connected(xprt);
3100 
3101 	if (try_module_get(THIS_MODULE))
3102 		return xprt;
3103 
3104 	args->bc_xprt->xpt_bc_xprt = NULL;
3105 	args->bc_xprt->xpt_bc_xps = NULL;
3106 	xprt_put(xprt);
3107 	ret = ERR_PTR(-EINVAL);
3108 out_err:
3109 	xs_xprt_free(xprt);
3110 	return ret;
3111 }
3112 
3113 static struct xprt_class	xs_local_transport = {
3114 	.list		= LIST_HEAD_INIT(xs_local_transport.list),
3115 	.name		= "named UNIX socket",
3116 	.owner		= THIS_MODULE,
3117 	.ident		= XPRT_TRANSPORT_LOCAL,
3118 	.setup		= xs_setup_local,
3119 	.netid		= { "" },
3120 };
3121 
3122 static struct xprt_class	xs_udp_transport = {
3123 	.list		= LIST_HEAD_INIT(xs_udp_transport.list),
3124 	.name		= "udp",
3125 	.owner		= THIS_MODULE,
3126 	.ident		= XPRT_TRANSPORT_UDP,
3127 	.setup		= xs_setup_udp,
3128 	.netid		= { "udp", "udp6", "" },
3129 };
3130 
3131 static struct xprt_class	xs_tcp_transport = {
3132 	.list		= LIST_HEAD_INIT(xs_tcp_transport.list),
3133 	.name		= "tcp",
3134 	.owner		= THIS_MODULE,
3135 	.ident		= XPRT_TRANSPORT_TCP,
3136 	.setup		= xs_setup_tcp,
3137 	.netid		= { "tcp", "tcp6", "" },
3138 };
3139 
3140 static struct xprt_class	xs_bc_tcp_transport = {
3141 	.list		= LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3142 	.name		= "tcp NFSv4.1 backchannel",
3143 	.owner		= THIS_MODULE,
3144 	.ident		= XPRT_TRANSPORT_BC_TCP,
3145 	.setup		= xs_setup_bc_tcp,
3146 	.netid		= { "" },
3147 };
3148 
3149 /**
3150  * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3151  *
3152  */
init_socket_xprt(void)3153 int init_socket_xprt(void)
3154 {
3155 	if (!sunrpc_table_header)
3156 		sunrpc_table_header = register_sysctl_table(sunrpc_table);
3157 
3158 	xprt_register_transport(&xs_local_transport);
3159 	xprt_register_transport(&xs_udp_transport);
3160 	xprt_register_transport(&xs_tcp_transport);
3161 	xprt_register_transport(&xs_bc_tcp_transport);
3162 
3163 	return 0;
3164 }
3165 
3166 /**
3167  * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3168  *
3169  */
cleanup_socket_xprt(void)3170 void cleanup_socket_xprt(void)
3171 {
3172 	if (sunrpc_table_header) {
3173 		unregister_sysctl_table(sunrpc_table_header);
3174 		sunrpc_table_header = NULL;
3175 	}
3176 
3177 	xprt_unregister_transport(&xs_local_transport);
3178 	xprt_unregister_transport(&xs_udp_transport);
3179 	xprt_unregister_transport(&xs_tcp_transport);
3180 	xprt_unregister_transport(&xs_bc_tcp_transport);
3181 }
3182 
param_set_uint_minmax(const char * val,const struct kernel_param * kp,unsigned int min,unsigned int max)3183 static int param_set_uint_minmax(const char *val,
3184 		const struct kernel_param *kp,
3185 		unsigned int min, unsigned int max)
3186 {
3187 	unsigned int num;
3188 	int ret;
3189 
3190 	if (!val)
3191 		return -EINVAL;
3192 	ret = kstrtouint(val, 0, &num);
3193 	if (ret)
3194 		return ret;
3195 	if (num < min || num > max)
3196 		return -EINVAL;
3197 	*((unsigned int *)kp->arg) = num;
3198 	return 0;
3199 }
3200 
param_set_portnr(const char * val,const struct kernel_param * kp)3201 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3202 {
3203 	return param_set_uint_minmax(val, kp,
3204 			RPC_MIN_RESVPORT,
3205 			RPC_MAX_RESVPORT);
3206 }
3207 
3208 static const struct kernel_param_ops param_ops_portnr = {
3209 	.set = param_set_portnr,
3210 	.get = param_get_uint,
3211 };
3212 
3213 #define param_check_portnr(name, p) \
3214 	__param_check(name, p, unsigned int);
3215 
3216 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3217 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3218 
param_set_slot_table_size(const char * val,const struct kernel_param * kp)3219 static int param_set_slot_table_size(const char *val,
3220 				     const struct kernel_param *kp)
3221 {
3222 	return param_set_uint_minmax(val, kp,
3223 			RPC_MIN_SLOT_TABLE,
3224 			RPC_MAX_SLOT_TABLE);
3225 }
3226 
3227 static const struct kernel_param_ops param_ops_slot_table_size = {
3228 	.set = param_set_slot_table_size,
3229 	.get = param_get_uint,
3230 };
3231 
3232 #define param_check_slot_table_size(name, p) \
3233 	__param_check(name, p, unsigned int);
3234 
param_set_max_slot_table_size(const char * val,const struct kernel_param * kp)3235 static int param_set_max_slot_table_size(const char *val,
3236 				     const struct kernel_param *kp)
3237 {
3238 	return param_set_uint_minmax(val, kp,
3239 			RPC_MIN_SLOT_TABLE,
3240 			RPC_MAX_SLOT_TABLE_LIMIT);
3241 }
3242 
3243 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3244 	.set = param_set_max_slot_table_size,
3245 	.get = param_get_uint,
3246 };
3247 
3248 #define param_check_max_slot_table_size(name, p) \
3249 	__param_check(name, p, unsigned int);
3250 
3251 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3252 		   slot_table_size, 0644);
3253 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3254 		   max_slot_table_size, 0644);
3255 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3256 		   slot_table_size, 0644);
3257