1 // SPDX-License-Identifier: GPL-2.0
3 * linux/net/sunrpc/xprtsock.c
5 * Client-side transport implementation for sockets.
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>
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>
16 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
18 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
19 * <gilles.quillard@bull.net>
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>
31 #include <linux/net.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>
47 #include <net/checksum.h>
50 #include <linux/bvec.h>
51 #include <linux/highmem.h>
52 #include <linux/uio.h>
53 #include <linux/sched/mm.h>
55 #include <trace/events/sunrpc.h>
60 static void xs_close(struct rpc_xprt *xprt);
61 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock);
62 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
68 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
69 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
70 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
72 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
73 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
75 #define XS_TCP_LINGER_TO (15U * HZ)
76 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
79 * We can register our own files under /proc/sys/sunrpc by
80 * calling register_sysctl_table() again. The files in that
81 * directory become the union of all files registered there.
83 * We simply need to make sure that we don't collide with
84 * someone else's file names!
87 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
88 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
89 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
90 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
91 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
93 static struct ctl_table_header *sunrpc_table_header;
95 static struct xprt_class xs_local_transport;
96 static struct xprt_class xs_udp_transport;
97 static struct xprt_class xs_tcp_transport;
98 static struct xprt_class xs_bc_tcp_transport;
101 * FIXME: changing the UDP slot table size should also resize the UDP
102 * socket buffers for existing UDP transports
104 static struct ctl_table xs_tunables_table[] = {
106 .procname = "udp_slot_table_entries",
107 .data = &xprt_udp_slot_table_entries,
108 .maxlen = sizeof(unsigned int),
110 .proc_handler = proc_dointvec_minmax,
111 .extra1 = &min_slot_table_size,
112 .extra2 = &max_slot_table_size
115 .procname = "tcp_slot_table_entries",
116 .data = &xprt_tcp_slot_table_entries,
117 .maxlen = sizeof(unsigned int),
119 .proc_handler = proc_dointvec_minmax,
120 .extra1 = &min_slot_table_size,
121 .extra2 = &max_slot_table_size
124 .procname = "tcp_max_slot_table_entries",
125 .data = &xprt_max_tcp_slot_table_entries,
126 .maxlen = sizeof(unsigned int),
128 .proc_handler = proc_dointvec_minmax,
129 .extra1 = &min_slot_table_size,
130 .extra2 = &max_tcp_slot_table_limit
133 .procname = "min_resvport",
134 .data = &xprt_min_resvport,
135 .maxlen = sizeof(unsigned int),
137 .proc_handler = proc_dointvec_minmax,
138 .extra1 = &xprt_min_resvport_limit,
139 .extra2 = &xprt_max_resvport_limit
142 .procname = "max_resvport",
143 .data = &xprt_max_resvport,
144 .maxlen = sizeof(unsigned int),
146 .proc_handler = proc_dointvec_minmax,
147 .extra1 = &xprt_min_resvport_limit,
148 .extra2 = &xprt_max_resvport_limit
151 .procname = "tcp_fin_timeout",
152 .data = &xs_tcp_fin_timeout,
153 .maxlen = sizeof(xs_tcp_fin_timeout),
155 .proc_handler = proc_dointvec_jiffies,
160 static struct ctl_table sunrpc_table[] = {
162 .procname = "sunrpc",
164 .child = xs_tunables_table
170 * Wait duration for a reply from the RPC portmapper.
172 #define XS_BIND_TO (60U * HZ)
175 * Delay if a UDP socket connect error occurs. This is most likely some
176 * kind of resource problem on the local host.
178 #define XS_UDP_REEST_TO (2U * HZ)
181 * The reestablish timeout allows clients to delay for a bit before attempting
182 * to reconnect to a server that just dropped our connection.
184 * We implement an exponential backoff when trying to reestablish a TCP
185 * transport connection with the server. Some servers like to drop a TCP
186 * connection when they are overworked, so we start with a short timeout and
187 * increase over time if the server is down or not responding.
189 #define XS_TCP_INIT_REEST_TO (3U * HZ)
192 * TCP idle timeout; client drops the transport socket if it is idle
193 * for this long. Note that we also timeout UDP sockets to prevent
194 * holding port numbers when there is no RPC traffic.
196 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
198 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
199 # undef RPC_DEBUG_DATA
200 # define RPCDBG_FACILITY RPCDBG_TRANS
203 #ifdef RPC_DEBUG_DATA
204 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
206 u8 *buf = (u8 *) packet;
209 dprintk("RPC: %s\n", msg);
210 for (j = 0; j < count && j < 128; j += 4) {
214 dprintk("0x%04x ", j);
216 dprintk("%02x%02x%02x%02x ",
217 buf[j], buf[j+1], buf[j+2], buf[j+3]);
222 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
228 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
230 return (struct rpc_xprt *) sk->sk_user_data;
233 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
235 return (struct sockaddr *) &xprt->addr;
238 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
240 return (struct sockaddr_un *) &xprt->addr;
243 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
245 return (struct sockaddr_in *) &xprt->addr;
248 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
250 return (struct sockaddr_in6 *) &xprt->addr;
253 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
255 struct sockaddr *sap = xs_addr(xprt);
256 struct sockaddr_in6 *sin6;
257 struct sockaddr_in *sin;
258 struct sockaddr_un *sun;
261 switch (sap->sa_family) {
263 sun = xs_addr_un(xprt);
264 strlcpy(buf, sun->sun_path, sizeof(buf));
265 xprt->address_strings[RPC_DISPLAY_ADDR] =
266 kstrdup(buf, GFP_KERNEL);
269 (void)rpc_ntop(sap, buf, sizeof(buf));
270 xprt->address_strings[RPC_DISPLAY_ADDR] =
271 kstrdup(buf, GFP_KERNEL);
272 sin = xs_addr_in(xprt);
273 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
276 (void)rpc_ntop(sap, buf, sizeof(buf));
277 xprt->address_strings[RPC_DISPLAY_ADDR] =
278 kstrdup(buf, GFP_KERNEL);
279 sin6 = xs_addr_in6(xprt);
280 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
286 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
289 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
291 struct sockaddr *sap = xs_addr(xprt);
294 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
295 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
297 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
298 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
301 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
302 const char *protocol,
305 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
306 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
307 xs_format_common_peer_addresses(xprt);
308 xs_format_common_peer_ports(xprt);
311 static void xs_update_peer_port(struct rpc_xprt *xprt)
313 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
314 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
316 xs_format_common_peer_ports(xprt);
319 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
323 for (i = 0; i < RPC_DISPLAY_MAX; i++)
325 case RPC_DISPLAY_PROTO:
326 case RPC_DISPLAY_NETID:
329 kfree(xprt->address_strings[i]);
334 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp)
338 if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES))
340 n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT;
341 for (i = 0; i < n; i++) {
344 buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp);
345 if (!buf->pages[i]) {
347 return i > buf->page_base ? i - buf->page_base : 0;
354 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek)
358 iov_iter_advance(&msg->msg_iter, seek);
359 ret = sock_recvmsg(sock, msg, flags);
360 return ret > 0 ? ret + seek : ret;
364 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags,
365 struct kvec *kvec, size_t count, size_t seek)
367 iov_iter_kvec(&msg->msg_iter, READ, kvec, 1, count);
368 return xs_sock_recvmsg(sock, msg, flags, seek);
372 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags,
373 struct bio_vec *bvec, unsigned long nr, size_t count,
376 iov_iter_bvec(&msg->msg_iter, READ, bvec, nr, count);
377 return xs_sock_recvmsg(sock, msg, flags, seek);
381 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags,
384 iov_iter_discard(&msg->msg_iter, READ, count);
385 return sock_recvmsg(sock, msg, flags);
388 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
390 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
392 struct bvec_iter bi = {
397 bvec_iter_advance(bvec, &bi, seek & PAGE_MASK);
398 for_each_bvec(bv, bvec, bi, bi)
399 flush_dcache_page(bv.bv_page);
403 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
409 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags,
410 struct xdr_buf *buf, size_t count, size_t seek, size_t *read)
412 size_t want, seek_init = seek, offset = 0;
415 want = min_t(size_t, count, buf->head[0].iov_len);
417 ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek);
421 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
431 want = xs_alloc_sparse_pages(
432 buf, min_t(size_t, count - offset, buf->page_len),
433 GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN);
435 ret = xs_read_bvec(sock, msg, flags, buf->bvec,
436 xdr_buf_pagecount(buf),
437 want + buf->page_base,
438 seek + buf->page_base);
441 xs_flush_bvec(buf->bvec, ret, seek + buf->page_base);
442 ret -= buf->page_base;
444 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
454 want = min_t(size_t, count - offset, buf->tail[0].iov_len);
456 ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek);
460 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
464 } else if (offset < seek_init)
468 *read = offset - seek_init;
476 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf)
478 if (!transport->recv.copied) {
479 if (buf->head[0].iov_len >= transport->recv.offset)
480 memcpy(buf->head[0].iov_base,
481 &transport->recv.xid,
482 transport->recv.offset);
483 transport->recv.copied = transport->recv.offset;
488 xs_read_stream_request_done(struct sock_xprt *transport)
490 return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT);
494 xs_read_stream_check_eor(struct sock_xprt *transport,
497 if (xs_read_stream_request_done(transport))
498 msg->msg_flags |= MSG_EOR;
502 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg,
503 int flags, struct rpc_rqst *req)
505 struct xdr_buf *buf = &req->rq_private_buf;
509 xs_read_header(transport, buf);
511 want = transport->recv.len - transport->recv.offset;
513 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
514 transport->recv.copied + want,
515 transport->recv.copied,
517 transport->recv.offset += read;
518 transport->recv.copied += read;
521 if (transport->recv.offset == transport->recv.len)
522 xs_read_stream_check_eor(transport, msg);
532 msg->msg_flags |= MSG_TRUNC;
537 return ret < 0 ? ret : read;
541 xs_read_stream_headersize(bool isfrag)
544 return sizeof(__be32);
545 return 3 * sizeof(__be32);
549 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
550 int flags, size_t want, size_t seek)
553 .iov_base = &transport->recv.fraghdr,
556 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
559 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
561 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
563 struct rpc_xprt *xprt = &transport->xprt;
564 struct rpc_rqst *req;
567 /* Is this transport associated with the backchannel? */
571 /* Look up and lock the request corresponding to the given XID */
572 req = xprt_lookup_bc_request(xprt, transport->recv.xid);
574 printk(KERN_WARNING "Callback slot table overflowed\n");
577 if (transport->recv.copied && !req->rq_private_buf.len)
580 ret = xs_read_stream_request(transport, msg, flags, req);
581 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
582 xprt_complete_bc_request(req, transport->recv.copied);
584 req->rq_private_buf.len = transport->recv.copied;
588 #else /* CONFIG_SUNRPC_BACKCHANNEL */
590 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
594 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
597 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
599 struct rpc_xprt *xprt = &transport->xprt;
600 struct rpc_rqst *req;
603 /* Look up and lock the request corresponding to the given XID */
604 spin_lock(&xprt->queue_lock);
605 req = xprt_lookup_rqst(xprt, transport->recv.xid);
606 if (!req || (transport->recv.copied && !req->rq_private_buf.len)) {
607 msg->msg_flags |= MSG_TRUNC;
611 spin_unlock(&xprt->queue_lock);
613 ret = xs_read_stream_request(transport, msg, flags, req);
615 spin_lock(&xprt->queue_lock);
616 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
617 xprt_complete_rqst(req->rq_task, transport->recv.copied);
619 req->rq_private_buf.len = transport->recv.copied;
620 xprt_unpin_rqst(req);
622 spin_unlock(&xprt->queue_lock);
627 xs_read_stream(struct sock_xprt *transport, int flags)
629 struct msghdr msg = { 0 };
630 size_t want, read = 0;
633 if (transport->recv.len == 0) {
634 want = xs_read_stream_headersize(transport->recv.copied != 0);
635 ret = xs_read_stream_header(transport, &msg, flags, want,
636 transport->recv.offset);
639 transport->recv.offset = ret;
640 if (transport->recv.offset != want)
641 return transport->recv.offset;
642 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
643 RPC_FRAGMENT_SIZE_MASK;
644 transport->recv.offset -= sizeof(transport->recv.fraghdr);
648 switch (be32_to_cpu(transport->recv.calldir)) {
650 msg.msg_flags |= MSG_TRUNC;
653 ret = xs_read_stream_call(transport, &msg, flags);
656 ret = xs_read_stream_reply(transport, &msg, flags);
658 if (msg.msg_flags & MSG_TRUNC) {
659 transport->recv.calldir = cpu_to_be32(-1);
660 transport->recv.copied = -1;
665 if (transport->recv.offset < transport->recv.len) {
666 if (!(msg.msg_flags & MSG_TRUNC))
669 ret = xs_read_discard(transport->sock, &msg, flags,
670 transport->recv.len - transport->recv.offset);
673 transport->recv.offset += ret;
675 if (transport->recv.offset != transport->recv.len)
678 if (xs_read_stream_request_done(transport)) {
679 trace_xs_stream_read_request(transport);
680 transport->recv.copied = 0;
682 transport->recv.offset = 0;
683 transport->recv.len = 0;
686 return ret != 0 ? ret : -ESHUTDOWN;
689 static __poll_t xs_poll_socket(struct sock_xprt *transport)
691 return transport->sock->ops->poll(transport->file, transport->sock,
695 static bool xs_poll_socket_readable(struct sock_xprt *transport)
697 __poll_t events = xs_poll_socket(transport);
699 return (events & (EPOLLIN | EPOLLRDNORM)) && !(events & EPOLLRDHUP);
702 static void xs_poll_check_readable(struct sock_xprt *transport)
705 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
706 if (!xs_poll_socket_readable(transport))
708 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
709 queue_work(xprtiod_workqueue, &transport->recv_worker);
712 static void xs_stream_data_receive(struct sock_xprt *transport)
717 mutex_lock(&transport->recv_mutex);
718 if (transport->sock == NULL)
721 ret = xs_read_stream(transport, MSG_DONTWAIT);
727 if (ret == -ESHUTDOWN)
728 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
730 xs_poll_check_readable(transport);
732 mutex_unlock(&transport->recv_mutex);
733 trace_xs_stream_read_data(&transport->xprt, ret, read);
736 static void xs_stream_data_receive_workfn(struct work_struct *work)
738 struct sock_xprt *transport =
739 container_of(work, struct sock_xprt, recv_worker);
740 unsigned int pflags = memalloc_nofs_save();
742 xs_stream_data_receive(transport);
743 memalloc_nofs_restore(pflags);
747 xs_stream_reset_connect(struct sock_xprt *transport)
749 transport->recv.offset = 0;
750 transport->recv.len = 0;
751 transport->recv.copied = 0;
752 transport->xmit.offset = 0;
756 xs_stream_start_connect(struct sock_xprt *transport)
758 transport->xprt.stat.connect_count++;
759 transport->xprt.stat.connect_start = jiffies;
762 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
765 * xs_nospace - handle transmit was incomplete
766 * @req: pointer to RPC request
767 * @transport: pointer to struct sock_xprt
770 static int xs_nospace(struct rpc_rqst *req, struct sock_xprt *transport)
772 struct rpc_xprt *xprt = &transport->xprt;
773 struct sock *sk = transport->inet;
776 trace_rpc_socket_nospace(req, transport);
778 /* Protect against races with write_space */
779 spin_lock(&xprt->transport_lock);
781 /* Don't race with disconnect */
782 if (xprt_connected(xprt)) {
783 /* wait for more buffer space */
784 set_bit(XPRT_SOCK_NOSPACE, &transport->sock_state);
785 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
786 sk->sk_write_pending++;
787 xprt_wait_for_buffer_space(xprt);
791 spin_unlock(&xprt->transport_lock);
795 static int xs_sock_nospace(struct rpc_rqst *req)
797 struct sock_xprt *transport =
798 container_of(req->rq_xprt, struct sock_xprt, xprt);
799 struct sock *sk = transport->inet;
803 if (!sock_writeable(sk))
804 ret = xs_nospace(req, transport);
809 static int xs_stream_nospace(struct rpc_rqst *req, bool vm_wait)
811 struct sock_xprt *transport =
812 container_of(req->rq_xprt, struct sock_xprt, xprt);
813 struct sock *sk = transport->inet;
819 if (!sk_stream_memory_free(sk))
820 ret = xs_nospace(req, transport);
826 xs_stream_prepare_request(struct rpc_rqst *req)
828 gfp_t gfp = rpc_task_gfp_mask();
831 ret = xdr_alloc_bvec(&req->rq_snd_buf, gfp);
834 xdr_free_bvec(&req->rq_rcv_buf);
835 return xdr_alloc_bvec(&req->rq_rcv_buf, gfp);
839 * Determine if the previous message in the stream was aborted before it
840 * could complete transmission.
843 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
845 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
849 * Return the stream record marker field for a record of length < 2^31-1
852 xs_stream_record_marker(struct xdr_buf *xdr)
856 return cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | (u32)xdr->len);
860 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
861 * @req: pointer to RPC request
864 * 0: The request has been sent
865 * EAGAIN: The socket was blocked, please call again later to
866 * complete the request
867 * ENOTCONN: Caller needs to invoke connect logic then call again
868 * other: Some other error occurred, the request was not sent
870 static int xs_local_send_request(struct rpc_rqst *req)
872 struct rpc_xprt *xprt = req->rq_xprt;
873 struct sock_xprt *transport =
874 container_of(xprt, struct sock_xprt, xprt);
875 struct xdr_buf *xdr = &req->rq_snd_buf;
876 rpc_fraghdr rm = xs_stream_record_marker(xdr);
877 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
878 struct msghdr msg = {
879 .msg_flags = XS_SENDMSG_FLAGS,
885 /* Close the stream if the previous transmission was incomplete */
886 if (xs_send_request_was_aborted(transport, req)) {
887 xprt_force_disconnect(xprt);
891 xs_pktdump("packet data:",
892 req->rq_svec->iov_base, req->rq_svec->iov_len);
894 vm_wait = sk_stream_is_writeable(transport->inet) ? true : false;
896 req->rq_xtime = ktime_get();
897 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
898 transport->xmit.offset, rm, &sent);
899 dprintk("RPC: %s(%u) = %d\n",
900 __func__, xdr->len - transport->xmit.offset, status);
902 if (likely(sent > 0) || status == 0) {
903 transport->xmit.offset += sent;
904 req->rq_bytes_sent = transport->xmit.offset;
905 if (likely(req->rq_bytes_sent >= msglen)) {
906 req->rq_xmit_bytes_sent += transport->xmit.offset;
907 transport->xmit.offset = 0;
916 status = xs_stream_nospace(req, vm_wait);
919 dprintk("RPC: sendmsg returned unrecognized error %d\n",
923 xprt_force_disconnect(xprt);
931 * xs_udp_send_request - write an RPC request to a UDP socket
932 * @req: pointer to RPC request
935 * 0: The request has been sent
936 * EAGAIN: The socket was blocked, please call again later to
937 * complete the request
938 * ENOTCONN: Caller needs to invoke connect logic then call again
939 * other: Some other error occurred, the request was not sent
941 static int xs_udp_send_request(struct rpc_rqst *req)
943 struct rpc_xprt *xprt = req->rq_xprt;
944 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
945 struct xdr_buf *xdr = &req->rq_snd_buf;
946 struct msghdr msg = {
947 .msg_name = xs_addr(xprt),
948 .msg_namelen = xprt->addrlen,
949 .msg_flags = XS_SENDMSG_FLAGS,
954 xs_pktdump("packet data:",
955 req->rq_svec->iov_base,
956 req->rq_svec->iov_len);
958 if (!xprt_bound(xprt))
961 if (!xprt_request_get_cong(xprt, req))
964 status = xdr_alloc_bvec(xdr, rpc_task_gfp_mask());
967 req->rq_xtime = ktime_get();
968 status = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, 0, &sent);
970 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
973 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
974 if (status == -EPERM)
977 if (status == -EAGAIN && sock_writeable(transport->inet))
980 if (sent > 0 || status == 0) {
981 req->rq_xmit_bytes_sent += sent;
982 if (sent >= req->rq_slen)
984 /* Still some bytes left; set up for a retry later. */
992 /* Should we call xs_close() here? */
995 status = xs_sock_nospace(req);
1002 /* When the server has died, an ICMP port unreachable message
1003 * prompts ECONNREFUSED. */
1006 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1014 * xs_tcp_send_request - write an RPC request to a TCP socket
1015 * @req: pointer to RPC request
1018 * 0: The request has been sent
1019 * EAGAIN: The socket was blocked, please call again later to
1020 * complete the request
1021 * ENOTCONN: Caller needs to invoke connect logic then call again
1022 * other: Some other error occurred, the request was not sent
1024 * XXX: In the case of soft timeouts, should we eventually give up
1025 * if sendmsg is not able to make progress?
1027 static int xs_tcp_send_request(struct rpc_rqst *req)
1029 struct rpc_xprt *xprt = req->rq_xprt;
1030 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1031 struct xdr_buf *xdr = &req->rq_snd_buf;
1032 rpc_fraghdr rm = xs_stream_record_marker(xdr);
1033 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
1034 struct msghdr msg = {
1035 .msg_flags = XS_SENDMSG_FLAGS,
1041 /* Close the stream if the previous transmission was incomplete */
1042 if (xs_send_request_was_aborted(transport, req)) {
1043 if (transport->sock != NULL)
1044 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1047 if (!transport->inet)
1050 xs_pktdump("packet data:",
1051 req->rq_svec->iov_base,
1052 req->rq_svec->iov_len);
1054 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1055 xs_tcp_set_socket_timeouts(xprt, transport->sock);
1057 xs_set_srcport(transport, transport->sock);
1059 /* Continue transmitting the packet/record. We must be careful
1060 * to cope with writespace callbacks arriving _after_ we have
1061 * called sendmsg(). */
1062 req->rq_xtime = ktime_get();
1063 tcp_sock_set_cork(transport->inet, true);
1065 vm_wait = sk_stream_is_writeable(transport->inet) ? true : false;
1068 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
1069 transport->xmit.offset, rm, &sent);
1071 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
1072 xdr->len - transport->xmit.offset, status);
1074 /* If we've sent the entire packet, immediately
1075 * reset the count of bytes sent. */
1076 transport->xmit.offset += sent;
1077 req->rq_bytes_sent = transport->xmit.offset;
1078 if (likely(req->rq_bytes_sent >= msglen)) {
1079 req->rq_xmit_bytes_sent += transport->xmit.offset;
1080 transport->xmit.offset = 0;
1081 if (atomic_long_read(&xprt->xmit_queuelen) == 1)
1082 tcp_sock_set_cork(transport->inet, false);
1086 WARN_ON_ONCE(sent == 0 && status == 0);
1091 } while (status == 0);
1096 /* Should we call xs_close() here? */
1099 status = xs_stream_nospace(req, vm_wait);
1109 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1116 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1118 transport->old_data_ready = sk->sk_data_ready;
1119 transport->old_state_change = sk->sk_state_change;
1120 transport->old_write_space = sk->sk_write_space;
1121 transport->old_error_report = sk->sk_error_report;
1124 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1126 sk->sk_data_ready = transport->old_data_ready;
1127 sk->sk_state_change = transport->old_state_change;
1128 sk->sk_write_space = transport->old_write_space;
1129 sk->sk_error_report = transport->old_error_report;
1132 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1134 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1136 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1137 clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state);
1138 clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state);
1139 clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state);
1140 clear_bit(XPRT_SOCK_NOSPACE, &transport->sock_state);
1143 static void xs_run_error_worker(struct sock_xprt *transport, unsigned int nr)
1145 set_bit(nr, &transport->sock_state);
1146 queue_work(xprtiod_workqueue, &transport->error_worker);
1149 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1151 xprt->connect_cookie++;
1152 smp_mb__before_atomic();
1153 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1154 clear_bit(XPRT_CLOSING, &xprt->state);
1155 xs_sock_reset_state_flags(xprt);
1156 smp_mb__after_atomic();
1160 * xs_error_report - callback to handle TCP socket state errors
1163 * Note: we don't call sock_error() since there may be a rpc_task
1164 * using the socket, and so we don't want to clear sk->sk_err.
1166 static void xs_error_report(struct sock *sk)
1168 struct sock_xprt *transport;
1169 struct rpc_xprt *xprt;
1171 if (!(xprt = xprt_from_sock(sk)))
1174 transport = container_of(xprt, struct sock_xprt, xprt);
1175 transport->xprt_err = -sk->sk_err;
1176 if (transport->xprt_err == 0)
1178 dprintk("RPC: xs_error_report client %p, error=%d...\n",
1179 xprt, -transport->xprt_err);
1180 trace_rpc_socket_error(xprt, sk->sk_socket, transport->xprt_err);
1182 /* barrier ensures xprt_err is set before XPRT_SOCK_WAKE_ERROR */
1183 smp_mb__before_atomic();
1184 xs_run_error_worker(transport, XPRT_SOCK_WAKE_ERROR);
1187 static void xs_reset_transport(struct sock_xprt *transport)
1189 struct socket *sock = transport->sock;
1190 struct sock *sk = transport->inet;
1191 struct rpc_xprt *xprt = &transport->xprt;
1192 struct file *filp = transport->file;
1197 * Make sure we're calling this in a context from which it is safe
1198 * to call __fput_sync(). In practice that means rpciod and the
1201 if (!(current->flags & PF_WQ_WORKER)) {
1203 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
1207 if (atomic_read(&transport->xprt.swapper))
1208 sk_clear_memalloc(sk);
1210 kernel_sock_shutdown(sock, SHUT_RDWR);
1212 mutex_lock(&transport->recv_mutex);
1214 transport->inet = NULL;
1215 transport->sock = NULL;
1216 transport->file = NULL;
1218 sk->sk_user_data = NULL;
1220 xs_restore_old_callbacks(transport, sk);
1221 xprt_clear_connected(xprt);
1222 xs_sock_reset_connection_flags(xprt);
1223 /* Reset stream record info */
1224 xs_stream_reset_connect(transport);
1226 mutex_unlock(&transport->recv_mutex);
1228 trace_rpc_socket_close(xprt, sock);
1231 xprt_disconnect_done(xprt);
1235 * xs_close - close a socket
1238 * This is used when all requests are complete; ie, no DRC state remains
1239 * on the server we want to save.
1241 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1242 * xs_reset_transport() zeroing the socket from underneath a writer.
1244 static void xs_close(struct rpc_xprt *xprt)
1246 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1248 dprintk("RPC: xs_close xprt %p\n", xprt);
1250 xs_reset_transport(transport);
1251 xprt->reestablish_timeout = 0;
1254 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1256 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
1258 xprt_disconnect_done(xprt);
1261 static void xs_xprt_free(struct rpc_xprt *xprt)
1263 xs_free_peer_addresses(xprt);
1268 * xs_destroy - prepare to shutdown a transport
1269 * @xprt: doomed transport
1272 static void xs_destroy(struct rpc_xprt *xprt)
1274 struct sock_xprt *transport = container_of(xprt,
1275 struct sock_xprt, xprt);
1276 dprintk("RPC: xs_destroy xprt %p\n", xprt);
1278 cancel_delayed_work_sync(&transport->connect_worker);
1280 cancel_work_sync(&transport->recv_worker);
1281 cancel_work_sync(&transport->error_worker);
1283 module_put(THIS_MODULE);
1287 * xs_udp_data_read_skb - receive callback for UDP sockets
1293 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1295 struct sk_buff *skb)
1297 struct rpc_task *task;
1298 struct rpc_rqst *rovr;
1299 int repsize, copied;
1305 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1309 /* Copy the XID from the skb... */
1310 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1314 /* Look up and lock the request corresponding to the given XID */
1315 spin_lock(&xprt->queue_lock);
1316 rovr = xprt_lookup_rqst(xprt, *xp);
1319 xprt_pin_rqst(rovr);
1320 xprt_update_rtt(rovr->rq_task);
1321 spin_unlock(&xprt->queue_lock);
1322 task = rovr->rq_task;
1324 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1327 /* Suck it into the iovec, verify checksum if not done by hw. */
1328 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1329 spin_lock(&xprt->queue_lock);
1330 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1335 spin_lock(&xprt->transport_lock);
1336 xprt_adjust_cwnd(xprt, task, copied);
1337 spin_unlock(&xprt->transport_lock);
1338 spin_lock(&xprt->queue_lock);
1339 xprt_complete_rqst(task, copied);
1340 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1342 xprt_unpin_rqst(rovr);
1344 spin_unlock(&xprt->queue_lock);
1347 static void xs_udp_data_receive(struct sock_xprt *transport)
1349 struct sk_buff *skb;
1353 mutex_lock(&transport->recv_mutex);
1354 sk = transport->inet;
1358 skb = skb_recv_udp(sk, 0, 1, &err);
1361 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1365 xs_poll_check_readable(transport);
1367 mutex_unlock(&transport->recv_mutex);
1370 static void xs_udp_data_receive_workfn(struct work_struct *work)
1372 struct sock_xprt *transport =
1373 container_of(work, struct sock_xprt, recv_worker);
1374 unsigned int pflags = memalloc_nofs_save();
1376 xs_udp_data_receive(transport);
1377 memalloc_nofs_restore(pflags);
1381 * xs_data_ready - "data ready" callback for UDP sockets
1382 * @sk: socket with data to read
1385 static void xs_data_ready(struct sock *sk)
1387 struct rpc_xprt *xprt;
1389 dprintk("RPC: xs_data_ready...\n");
1390 xprt = xprt_from_sock(sk);
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
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);
1406 * Helper function to force a TCP close if the server is sending
1407 * junk and/or it has put us in CLOSE_WAIT
1409 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1411 xprt_force_disconnect(xprt);
1414 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1415 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1419 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1422 * xs_tcp_state_change - callback to handle TCP socket state changes
1423 * @sk: socket whose state has changed
1426 static void xs_tcp_state_change(struct sock *sk)
1428 struct rpc_xprt *xprt;
1429 struct sock_xprt *transport;
1431 if (!(xprt = xprt_from_sock(sk)))
1433 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1434 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1435 sk->sk_state, xprt_connected(xprt),
1436 sock_flag(sk, SOCK_DEAD),
1437 sock_flag(sk, SOCK_ZAPPED),
1440 transport = container_of(xprt, struct sock_xprt, xprt);
1441 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1442 switch (sk->sk_state) {
1443 case TCP_ESTABLISHED:
1444 if (!xprt_test_and_set_connected(xprt)) {
1445 xprt->connect_cookie++;
1446 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1447 xprt_clear_connecting(xprt);
1449 xprt->stat.connect_count++;
1450 xprt->stat.connect_time += (long)jiffies -
1451 xprt->stat.connect_start;
1452 xs_run_error_worker(transport, XPRT_SOCK_WAKE_PENDING);
1456 /* The client initiated a shutdown of the socket */
1457 xprt->connect_cookie++;
1458 xprt->reestablish_timeout = 0;
1459 set_bit(XPRT_CLOSING, &xprt->state);
1460 smp_mb__before_atomic();
1461 clear_bit(XPRT_CONNECTED, &xprt->state);
1462 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1463 smp_mb__after_atomic();
1465 case TCP_CLOSE_WAIT:
1466 /* The server initiated a shutdown of the socket */
1467 xprt->connect_cookie++;
1468 clear_bit(XPRT_CONNECTED, &xprt->state);
1469 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1473 * If the server closed down the connection, make sure that
1474 * we back off before reconnecting
1476 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1477 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1480 set_bit(XPRT_CLOSING, &xprt->state);
1481 smp_mb__before_atomic();
1482 clear_bit(XPRT_CONNECTED, &xprt->state);
1483 smp_mb__after_atomic();
1486 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1487 &transport->sock_state))
1488 xprt_clear_connecting(xprt);
1489 clear_bit(XPRT_CLOSING, &xprt->state);
1490 /* Trigger the socket release */
1491 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1495 static void xs_write_space(struct sock *sk)
1497 struct sock_xprt *transport;
1498 struct rpc_xprt *xprt;
1502 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1504 if (unlikely(!(xprt = xprt_from_sock(sk))))
1506 transport = container_of(xprt, struct sock_xprt, xprt);
1507 if (!test_and_clear_bit(XPRT_SOCK_NOSPACE, &transport->sock_state))
1509 xs_run_error_worker(transport, XPRT_SOCK_WAKE_WRITE);
1510 sk->sk_write_pending--;
1514 * xs_udp_write_space - callback invoked when socket buffer space
1516 * @sk: socket whose state has changed
1518 * Called when more output buffer space is available for this socket.
1519 * We try not to wake our writers until they can make "significant"
1520 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1521 * with a bunch of small requests.
1523 static void xs_udp_write_space(struct sock *sk)
1525 /* from net/core/sock.c:sock_def_write_space */
1526 if (sock_writeable(sk))
1531 * xs_tcp_write_space - callback invoked when socket buffer space
1533 * @sk: socket whose state has changed
1535 * Called when more output buffer space is available for this socket.
1536 * We try not to wake our writers until they can make "significant"
1537 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1538 * with a bunch of small requests.
1540 static void xs_tcp_write_space(struct sock *sk)
1542 /* from net/core/stream.c:sk_stream_write_space */
1543 if (sk_stream_is_writeable(sk))
1547 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1549 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1550 struct sock *sk = transport->inet;
1552 if (transport->rcvsize) {
1553 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1554 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1556 if (transport->sndsize) {
1557 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1558 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1559 sk->sk_write_space(sk);
1564 * xs_udp_set_buffer_size - set send and receive limits
1565 * @xprt: generic transport
1566 * @sndsize: requested size of send buffer, in bytes
1567 * @rcvsize: requested size of receive buffer, in bytes
1569 * Set socket send and receive buffer size limits.
1571 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1573 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1575 transport->sndsize = 0;
1577 transport->sndsize = sndsize + 1024;
1578 transport->rcvsize = 0;
1580 transport->rcvsize = rcvsize + 1024;
1582 xs_udp_do_set_buffer_size(xprt);
1586 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1587 * @xprt: controlling transport
1588 * @task: task that timed out
1590 * Adjust the congestion window after a retransmit timeout has occurred.
1592 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1594 spin_lock(&xprt->transport_lock);
1595 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1596 spin_unlock(&xprt->transport_lock);
1599 static int xs_get_random_port(void)
1601 unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1602 unsigned short range;
1603 unsigned short rand;
1607 range = max - min + 1;
1608 rand = (unsigned short) prandom_u32() % range;
1612 static unsigned short xs_sock_getport(struct socket *sock)
1614 struct sockaddr_storage buf;
1615 unsigned short port = 0;
1617 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1619 switch (buf.ss_family) {
1621 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1624 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1631 * xs_set_port - reset the port number in the remote endpoint address
1632 * @xprt: generic transport
1633 * @port: new port number
1636 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1638 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1640 rpc_set_port(xs_addr(xprt), port);
1641 xs_update_peer_port(xprt);
1644 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1646 if (transport->srcport == 0 && transport->xprt.reuseport)
1647 transport->srcport = xs_sock_getport(sock);
1650 static int xs_get_srcport(struct sock_xprt *transport)
1652 int port = transport->srcport;
1654 if (port == 0 && transport->xprt.resvport)
1655 port = xs_get_random_port();
1659 static unsigned short xs_sock_srcport(struct rpc_xprt *xprt)
1661 struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1662 unsigned short ret = 0;
1663 mutex_lock(&sock->recv_mutex);
1665 ret = xs_sock_getport(sock->sock);
1666 mutex_unlock(&sock->recv_mutex);
1670 static int xs_sock_srcaddr(struct rpc_xprt *xprt, char *buf, size_t buflen)
1672 struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1675 struct sockaddr_storage st;
1677 int ret = -ENOTCONN;
1679 mutex_lock(&sock->recv_mutex);
1681 ret = kernel_getsockname(sock->sock, &saddr.sa);
1683 ret = snprintf(buf, buflen, "%pISc", &saddr.sa);
1685 mutex_unlock(&sock->recv_mutex);
1689 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1691 if (transport->srcport != 0)
1692 transport->srcport = 0;
1693 if (!transport->xprt.resvport)
1695 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1696 return xprt_max_resvport;
1699 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1701 struct sockaddr_storage myaddr;
1703 int port = xs_get_srcport(transport);
1704 unsigned short last;
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).
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 doesn't harm them.
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.
1724 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1726 rpc_set_port((struct sockaddr *)&myaddr, port);
1727 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1728 transport->xprt.addrlen);
1730 if (transport->xprt.reuseport)
1731 transport->srcport = port;
1735 port = xs_next_srcport(transport, port);
1738 } while (err == -EADDRINUSE && nloop != 2);
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);
1745 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1746 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1747 port, err ? "failed" : "ok", err);
1752 * We don't support autobind on AF_LOCAL sockets
1754 static void xs_local_rpcbind(struct rpc_task *task)
1756 xprt_set_bound(task->tk_xprt);
1759 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1763 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1764 static struct lock_class_key xs_key[3];
1765 static struct lock_class_key xs_slock_key[3];
1767 static inline void xs_reclassify_socketu(struct socket *sock)
1769 struct sock *sk = sock->sk;
1771 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1772 &xs_slock_key[0], "sk_lock-AF_LOCAL-RPC", &xs_key[0]);
1775 static inline void xs_reclassify_socket4(struct socket *sock)
1777 struct sock *sk = sock->sk;
1779 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1780 &xs_slock_key[1], "sk_lock-AF_INET-RPC", &xs_key[1]);
1783 static inline void xs_reclassify_socket6(struct socket *sock)
1785 struct sock *sk = sock->sk;
1787 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1788 &xs_slock_key[2], "sk_lock-AF_INET6-RPC", &xs_key[2]);
1791 static inline void xs_reclassify_socket(int family, struct socket *sock)
1793 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1798 xs_reclassify_socketu(sock);
1801 xs_reclassify_socket4(sock);
1804 xs_reclassify_socket6(sock);
1809 static inline void xs_reclassify_socket(int family, struct socket *sock)
1814 static void xs_dummy_setup_socket(struct work_struct *work)
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)
1823 struct socket *sock;
1826 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1828 dprintk("RPC: can't create %d transport socket (%d).\n",
1832 xs_reclassify_socket(family, sock);
1835 sock_set_reuseport(sock->sk);
1837 err = xs_bind(transport, sock);
1843 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1845 return ERR_CAST(filp);
1846 transport->file = filp;
1850 return ERR_PTR(err);
1853 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1854 struct socket *sock)
1856 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1859 if (!transport->inet) {
1860 struct sock *sk = sock->sk;
1864 xs_save_old_callbacks(transport, sk);
1866 sk->sk_user_data = xprt;
1867 sk->sk_data_ready = xs_data_ready;
1868 sk->sk_write_space = xs_udp_write_space;
1869 sk->sk_error_report = xs_error_report;
1871 xprt_clear_connected(xprt);
1873 /* Reset to new socket */
1874 transport->sock = sock;
1875 transport->inet = sk;
1880 xs_stream_start_connect(transport);
1882 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1886 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1887 * @transport: socket transport to connect
1889 static int xs_local_setup_socket(struct sock_xprt *transport)
1891 struct rpc_xprt *xprt = &transport->xprt;
1893 struct socket *sock;
1896 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1897 SOCK_STREAM, 0, &sock, 1);
1899 dprintk("RPC: can't create AF_LOCAL "
1900 "transport socket (%d).\n", -status);
1903 xs_reclassify_socket(AF_LOCAL, sock);
1905 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1907 status = PTR_ERR(filp);
1910 transport->file = filp;
1912 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1913 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1915 status = xs_local_finish_connecting(xprt, sock);
1916 trace_rpc_socket_connect(xprt, sock, status);
1919 dprintk("RPC: xprt %p connected to %s\n",
1920 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1921 xprt->stat.connect_count++;
1922 xprt->stat.connect_time += (long)jiffies -
1923 xprt->stat.connect_start;
1924 xprt_set_connected(xprt);
1929 dprintk("RPC: xprt %p: socket %s does not exist\n",
1930 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1933 dprintk("RPC: xprt %p: connection refused for %s\n",
1934 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1937 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1939 xprt->address_strings[RPC_DISPLAY_ADDR]);
1943 xprt_clear_connecting(xprt);
1944 xprt_wake_pending_tasks(xprt, status);
1948 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1950 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1953 if (RPC_IS_ASYNC(task)) {
1955 * We want the AF_LOCAL connect to be resolved in the
1956 * filesystem namespace of the process making the rpc
1957 * call. Thus we connect synchronously.
1959 * If we want to support asynchronous AF_LOCAL calls,
1960 * we'll need to figure out how to pass a namespace to
1963 task->tk_rpc_status = -ENOTCONN;
1964 rpc_exit(task, -ENOTCONN);
1967 ret = xs_local_setup_socket(transport);
1968 if (ret && !RPC_IS_SOFTCONN(task))
1969 msleep_interruptible(15000);
1972 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
1974 * Note that this should be called with XPRT_LOCKED held, or recv_mutex
1975 * held, or when we otherwise know that we have exclusive access to the
1976 * socket, to guard against races with xs_reset_transport.
1978 static void xs_set_memalloc(struct rpc_xprt *xprt)
1980 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1984 * If there's no sock, then we have nothing to set. The
1985 * reconnecting process will get it for us.
1987 if (!transport->inet)
1989 if (atomic_read(&xprt->swapper))
1990 sk_set_memalloc(transport->inet);
1994 * xs_enable_swap - Tag this transport as being used for swap.
1995 * @xprt: transport to tag
1997 * Take a reference to this transport on behalf of the rpc_clnt, and
1998 * optionally mark it for swapping if it wasn't already.
2001 xs_enable_swap(struct rpc_xprt *xprt)
2003 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2005 mutex_lock(&xs->recv_mutex);
2006 if (atomic_inc_return(&xprt->swapper) == 1 &&
2008 sk_set_memalloc(xs->inet);
2009 mutex_unlock(&xs->recv_mutex);
2014 * xs_disable_swap - Untag this transport as being used for swap.
2015 * @xprt: transport to tag
2017 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2018 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2021 xs_disable_swap(struct rpc_xprt *xprt)
2023 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2025 mutex_lock(&xs->recv_mutex);
2026 if (atomic_dec_and_test(&xprt->swapper) &&
2028 sk_clear_memalloc(xs->inet);
2029 mutex_unlock(&xs->recv_mutex);
2032 static void xs_set_memalloc(struct rpc_xprt *xprt)
2037 xs_enable_swap(struct rpc_xprt *xprt)
2043 xs_disable_swap(struct rpc_xprt *xprt)
2048 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2050 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2052 if (!transport->inet) {
2053 struct sock *sk = sock->sk;
2057 xs_save_old_callbacks(transport, sk);
2059 sk->sk_user_data = xprt;
2060 sk->sk_data_ready = xs_data_ready;
2061 sk->sk_write_space = xs_udp_write_space;
2063 xprt_set_connected(xprt);
2065 /* Reset to new socket */
2066 transport->sock = sock;
2067 transport->inet = sk;
2069 xs_set_memalloc(xprt);
2073 xs_udp_do_set_buffer_size(xprt);
2075 xprt->stat.connect_start = jiffies;
2078 static void xs_udp_setup_socket(struct work_struct *work)
2080 struct sock_xprt *transport =
2081 container_of(work, struct sock_xprt, connect_worker.work);
2082 struct rpc_xprt *xprt = &transport->xprt;
2083 struct socket *sock;
2085 unsigned int pflags = current->flags;
2087 if (atomic_read(&xprt->swapper))
2088 current->flags |= PF_MEMALLOC;
2089 sock = xs_create_sock(xprt, transport,
2090 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2091 IPPROTO_UDP, false);
2095 dprintk("RPC: worker connecting xprt %p via %s to "
2096 "%s (port %s)\n", xprt,
2097 xprt->address_strings[RPC_DISPLAY_PROTO],
2098 xprt->address_strings[RPC_DISPLAY_ADDR],
2099 xprt->address_strings[RPC_DISPLAY_PORT]);
2101 xs_udp_finish_connecting(xprt, sock);
2102 trace_rpc_socket_connect(xprt, sock, 0);
2105 xprt_clear_connecting(xprt);
2106 xprt_unlock_connect(xprt, transport);
2107 xprt_wake_pending_tasks(xprt, status);
2108 current_restore_flags(pflags, PF_MEMALLOC);
2112 * xs_tcp_shutdown - gracefully shut down a TCP socket
2115 * Initiates a graceful shutdown of the TCP socket by calling the
2116 * equivalent of shutdown(SHUT_RDWR);
2118 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2120 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2121 struct socket *sock = transport->sock;
2122 int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE;
2126 if (!xprt->reuseport) {
2134 case TCP_ESTABLISHED:
2135 case TCP_CLOSE_WAIT:
2136 kernel_sock_shutdown(sock, SHUT_RDWR);
2137 trace_rpc_socket_shutdown(xprt, sock);
2140 xs_reset_transport(transport);
2144 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2145 struct socket *sock)
2147 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2148 unsigned int keepidle;
2149 unsigned int keepcnt;
2152 spin_lock(&xprt->transport_lock);
2153 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2154 keepcnt = xprt->timeout->to_retries + 1;
2155 timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2156 (xprt->timeout->to_retries + 1);
2157 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2158 spin_unlock(&xprt->transport_lock);
2160 /* TCP Keepalive options */
2161 sock_set_keepalive(sock->sk);
2162 tcp_sock_set_keepidle(sock->sk, keepidle);
2163 tcp_sock_set_keepintvl(sock->sk, keepidle);
2164 tcp_sock_set_keepcnt(sock->sk, keepcnt);
2166 /* TCP user timeout (see RFC5482) */
2167 tcp_sock_set_user_timeout(sock->sk, timeo);
2170 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2171 unsigned long connect_timeout,
2172 unsigned long reconnect_timeout)
2174 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2175 struct rpc_timeout to;
2176 unsigned long initval;
2178 spin_lock(&xprt->transport_lock);
2179 if (reconnect_timeout < xprt->max_reconnect_timeout)
2180 xprt->max_reconnect_timeout = reconnect_timeout;
2181 if (connect_timeout < xprt->connect_timeout) {
2182 memcpy(&to, xprt->timeout, sizeof(to));
2183 initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1);
2184 /* Arbitrary lower limit */
2185 if (initval < XS_TCP_INIT_REEST_TO << 1)
2186 initval = XS_TCP_INIT_REEST_TO << 1;
2187 to.to_initval = initval;
2188 to.to_maxval = initval;
2189 memcpy(&transport->tcp_timeout, &to,
2190 sizeof(transport->tcp_timeout));
2191 xprt->timeout = &transport->tcp_timeout;
2192 xprt->connect_timeout = connect_timeout;
2194 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2195 spin_unlock(&xprt->transport_lock);
2198 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2200 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2202 if (!transport->inet) {
2203 struct sock *sk = sock->sk;
2205 /* Avoid temporary address, they are bad for long-lived
2206 * connections such as NFS mounts.
2207 * RFC4941, section 3.6 suggests that:
2208 * Individual applications, which have specific
2209 * knowledge about the normal duration of connections,
2210 * MAY override this as appropriate.
2212 if (xs_addr(xprt)->sa_family == PF_INET6) {
2213 ip6_sock_set_addr_preferences(sk,
2214 IPV6_PREFER_SRC_PUBLIC);
2217 xs_tcp_set_socket_timeouts(xprt, sock);
2218 tcp_sock_set_nodelay(sk);
2222 xs_save_old_callbacks(transport, sk);
2224 sk->sk_user_data = xprt;
2225 sk->sk_data_ready = xs_data_ready;
2226 sk->sk_state_change = xs_tcp_state_change;
2227 sk->sk_write_space = xs_tcp_write_space;
2228 sk->sk_error_report = xs_error_report;
2230 /* socket options */
2231 sock_reset_flag(sk, SOCK_LINGER);
2233 xprt_clear_connected(xprt);
2235 /* Reset to new socket */
2236 transport->sock = sock;
2237 transport->inet = sk;
2242 if (!xprt_bound(xprt))
2245 xs_set_memalloc(xprt);
2247 xs_stream_start_connect(transport);
2249 /* Tell the socket layer to start connecting... */
2250 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2251 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2255 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2256 * @work: queued work item
2258 * Invoked by a work queue tasklet.
2260 static void xs_tcp_setup_socket(struct work_struct *work)
2262 struct sock_xprt *transport =
2263 container_of(work, struct sock_xprt, connect_worker.work);
2264 struct socket *sock = transport->sock;
2265 struct rpc_xprt *xprt = &transport->xprt;
2267 unsigned int pflags = current->flags;
2269 if (atomic_read(&xprt->swapper))
2270 current->flags |= PF_MEMALLOC;
2272 if (xprt_connected(xprt))
2274 if (test_and_clear_bit(XPRT_SOCK_CONNECT_SENT,
2275 &transport->sock_state) ||
2277 xs_reset_transport(transport);
2278 sock = xs_create_sock(xprt, transport, xs_addr(xprt)->sa_family,
2279 SOCK_STREAM, IPPROTO_TCP, true);
2281 xprt_wake_pending_tasks(xprt, PTR_ERR(sock));
2286 dprintk("RPC: worker connecting xprt %p via %s to "
2287 "%s (port %s)\n", xprt,
2288 xprt->address_strings[RPC_DISPLAY_PROTO],
2289 xprt->address_strings[RPC_DISPLAY_ADDR],
2290 xprt->address_strings[RPC_DISPLAY_PORT]);
2292 status = xs_tcp_finish_connecting(xprt, sock);
2293 trace_rpc_socket_connect(xprt, sock, status);
2294 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2295 xprt, -status, xprt_connected(xprt),
2296 sock->sk->sk_state);
2301 set_bit(XPRT_SOCK_CONNECT_SENT, &transport->sock_state);
2302 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2303 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2307 case -EADDRNOTAVAIL:
2308 /* Source port number is unavailable. Try a new one! */
2309 transport->srcport = 0;
2313 /* Happens, for instance, if the user specified a link
2314 * local IPv6 address without a scope-id.
2325 printk("%s: connect returned unhandled error %d\n",
2330 /* xs_tcp_force_close() wakes tasks with a fixed error code.
2331 * We need to wake them first to ensure the correct error code.
2333 xprt_wake_pending_tasks(xprt, status);
2334 xs_tcp_force_close(xprt);
2336 xprt_clear_connecting(xprt);
2338 xprt_unlock_connect(xprt, transport);
2339 current_restore_flags(pflags, PF_MEMALLOC);
2343 * xs_connect - connect a socket to a remote endpoint
2344 * @xprt: pointer to transport structure
2345 * @task: address of RPC task that manages state of connect request
2347 * TCP: If the remote end dropped the connection, delay reconnecting.
2349 * UDP socket connects are synchronous, but we use a work queue anyway
2350 * to guarantee that even unprivileged user processes can set up a
2351 * socket on a privileged port.
2353 * If a UDP socket connect fails, the delay behavior here prevents
2354 * retry floods (hard mounts).
2356 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2358 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2359 unsigned long delay = 0;
2361 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2363 if (transport->sock != NULL) {
2364 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2365 "seconds\n", xprt, xprt->reestablish_timeout / HZ);
2367 delay = xprt_reconnect_delay(xprt);
2368 xprt_reconnect_backoff(xprt, XS_TCP_INIT_REEST_TO);
2371 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2373 queue_delayed_work(xprtiod_workqueue,
2374 &transport->connect_worker,
2378 static void xs_wake_disconnect(struct sock_xprt *transport)
2380 if (test_and_clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state))
2381 xs_tcp_force_close(&transport->xprt);
2384 static void xs_wake_write(struct sock_xprt *transport)
2386 if (test_and_clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state))
2387 xprt_write_space(&transport->xprt);
2390 static void xs_wake_error(struct sock_xprt *transport)
2394 if (!test_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2396 mutex_lock(&transport->recv_mutex);
2397 if (transport->sock == NULL)
2399 if (!test_and_clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2401 sockerr = xchg(&transport->xprt_err, 0);
2403 xprt_wake_pending_tasks(&transport->xprt, sockerr);
2405 mutex_unlock(&transport->recv_mutex);
2408 static void xs_wake_pending(struct sock_xprt *transport)
2410 if (test_and_clear_bit(XPRT_SOCK_WAKE_PENDING, &transport->sock_state))
2411 xprt_wake_pending_tasks(&transport->xprt, -EAGAIN);
2414 static void xs_error_handle(struct work_struct *work)
2416 struct sock_xprt *transport = container_of(work,
2417 struct sock_xprt, error_worker);
2419 xs_wake_disconnect(transport);
2420 xs_wake_write(transport);
2421 xs_wake_error(transport);
2422 xs_wake_pending(transport);
2426 * xs_local_print_stats - display AF_LOCAL socket-specific stats
2427 * @xprt: rpc_xprt struct containing statistics
2431 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2435 if (xprt_connected(xprt))
2436 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2438 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2439 "%llu %llu %lu %llu %llu\n",
2440 xprt->stat.bind_count,
2441 xprt->stat.connect_count,
2442 xprt->stat.connect_time / HZ,
2446 xprt->stat.bad_xids,
2449 xprt->stat.max_slots,
2450 xprt->stat.sending_u,
2451 xprt->stat.pending_u);
2455 * xs_udp_print_stats - display UDP socket-specific stats
2456 * @xprt: rpc_xprt struct containing statistics
2460 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2462 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2464 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2467 xprt->stat.bind_count,
2470 xprt->stat.bad_xids,
2473 xprt->stat.max_slots,
2474 xprt->stat.sending_u,
2475 xprt->stat.pending_u);
2479 * xs_tcp_print_stats - display TCP socket-specific stats
2480 * @xprt: rpc_xprt struct containing statistics
2484 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2486 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2489 if (xprt_connected(xprt))
2490 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2492 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2493 "%llu %llu %lu %llu %llu\n",
2495 xprt->stat.bind_count,
2496 xprt->stat.connect_count,
2497 xprt->stat.connect_time / HZ,
2501 xprt->stat.bad_xids,
2504 xprt->stat.max_slots,
2505 xprt->stat.sending_u,
2506 xprt->stat.pending_u);
2510 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2511 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2512 * to use the server side send routines.
2514 static int bc_malloc(struct rpc_task *task)
2516 struct rpc_rqst *rqst = task->tk_rqstp;
2517 size_t size = rqst->rq_callsize;
2519 struct rpc_buffer *buf;
2521 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2522 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2527 page = alloc_page(GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN);
2531 buf = page_address(page);
2532 buf->len = PAGE_SIZE;
2534 rqst->rq_buffer = buf->data;
2535 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2540 * Free the space allocated in the bc_alloc routine
2542 static void bc_free(struct rpc_task *task)
2544 void *buffer = task->tk_rqstp->rq_buffer;
2545 struct rpc_buffer *buf;
2547 buf = container_of(buffer, struct rpc_buffer, data);
2548 free_page((unsigned long)buf);
2551 static int bc_sendto(struct rpc_rqst *req)
2553 struct xdr_buf *xdr = &req->rq_snd_buf;
2554 struct sock_xprt *transport =
2555 container_of(req->rq_xprt, struct sock_xprt, xprt);
2556 struct msghdr msg = {
2559 rpc_fraghdr marker = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT |
2561 unsigned int sent = 0;
2564 req->rq_xtime = ktime_get();
2565 err = xdr_alloc_bvec(xdr, rpc_task_gfp_mask());
2568 err = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, marker, &sent);
2570 if (err < 0 || sent != (xdr->len + sizeof(marker)))
2576 * bc_send_request - Send a backchannel Call on a TCP socket
2577 * @req: rpc_rqst containing Call message to be sent
2579 * xpt_mutex ensures @rqstp's whole message is written to the socket
2580 * without interruption.
2583 * %0 if the message was sent successfully
2584 * %ENOTCONN if the message was not sent
2586 static int bc_send_request(struct rpc_rqst *req)
2588 struct svc_xprt *xprt;
2592 * Get the server socket associated with this callback xprt
2594 xprt = req->rq_xprt->bc_xprt;
2597 * Grab the mutex to serialize data as the connection is shared
2598 * with the fore channel
2600 mutex_lock(&xprt->xpt_mutex);
2601 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2604 len = bc_sendto(req);
2605 mutex_unlock(&xprt->xpt_mutex);
2614 * The close routine. Since this is client initiated, we do nothing
2617 static void bc_close(struct rpc_xprt *xprt)
2619 xprt_disconnect_done(xprt);
2623 * The xprt destroy routine. Again, because this connection is client
2624 * initiated, we do nothing
2627 static void bc_destroy(struct rpc_xprt *xprt)
2629 dprintk("RPC: bc_destroy xprt %p\n", xprt);
2632 module_put(THIS_MODULE);
2635 static const struct rpc_xprt_ops xs_local_ops = {
2636 .reserve_xprt = xprt_reserve_xprt,
2637 .release_xprt = xprt_release_xprt,
2638 .alloc_slot = xprt_alloc_slot,
2639 .free_slot = xprt_free_slot,
2640 .rpcbind = xs_local_rpcbind,
2641 .set_port = xs_local_set_port,
2642 .connect = xs_local_connect,
2643 .buf_alloc = rpc_malloc,
2644 .buf_free = rpc_free,
2645 .prepare_request = xs_stream_prepare_request,
2646 .send_request = xs_local_send_request,
2647 .wait_for_reply_request = xprt_wait_for_reply_request_def,
2649 .destroy = xs_destroy,
2650 .print_stats = xs_local_print_stats,
2651 .enable_swap = xs_enable_swap,
2652 .disable_swap = xs_disable_swap,
2655 static const struct rpc_xprt_ops xs_udp_ops = {
2656 .set_buffer_size = xs_udp_set_buffer_size,
2657 .reserve_xprt = xprt_reserve_xprt_cong,
2658 .release_xprt = xprt_release_xprt_cong,
2659 .alloc_slot = xprt_alloc_slot,
2660 .free_slot = xprt_free_slot,
2661 .rpcbind = rpcb_getport_async,
2662 .set_port = xs_set_port,
2663 .connect = xs_connect,
2664 .get_srcaddr = xs_sock_srcaddr,
2665 .get_srcport = xs_sock_srcport,
2666 .buf_alloc = rpc_malloc,
2667 .buf_free = rpc_free,
2668 .send_request = xs_udp_send_request,
2669 .wait_for_reply_request = xprt_wait_for_reply_request_rtt,
2670 .timer = xs_udp_timer,
2671 .release_request = xprt_release_rqst_cong,
2673 .destroy = xs_destroy,
2674 .print_stats = xs_udp_print_stats,
2675 .enable_swap = xs_enable_swap,
2676 .disable_swap = xs_disable_swap,
2677 .inject_disconnect = xs_inject_disconnect,
2680 static const struct rpc_xprt_ops xs_tcp_ops = {
2681 .reserve_xprt = xprt_reserve_xprt,
2682 .release_xprt = xprt_release_xprt,
2683 .alloc_slot = xprt_alloc_slot,
2684 .free_slot = xprt_free_slot,
2685 .rpcbind = rpcb_getport_async,
2686 .set_port = xs_set_port,
2687 .connect = xs_connect,
2688 .get_srcaddr = xs_sock_srcaddr,
2689 .get_srcport = xs_sock_srcport,
2690 .buf_alloc = rpc_malloc,
2691 .buf_free = rpc_free,
2692 .prepare_request = xs_stream_prepare_request,
2693 .send_request = xs_tcp_send_request,
2694 .wait_for_reply_request = xprt_wait_for_reply_request_def,
2695 .close = xs_tcp_shutdown,
2696 .destroy = xs_destroy,
2697 .set_connect_timeout = xs_tcp_set_connect_timeout,
2698 .print_stats = xs_tcp_print_stats,
2699 .enable_swap = xs_enable_swap,
2700 .disable_swap = xs_disable_swap,
2701 .inject_disconnect = xs_inject_disconnect,
2702 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2703 .bc_setup = xprt_setup_bc,
2704 .bc_maxpayload = xs_tcp_bc_maxpayload,
2705 .bc_num_slots = xprt_bc_max_slots,
2706 .bc_free_rqst = xprt_free_bc_rqst,
2707 .bc_destroy = xprt_destroy_bc,
2712 * The rpc_xprt_ops for the server backchannel
2715 static const struct rpc_xprt_ops bc_tcp_ops = {
2716 .reserve_xprt = xprt_reserve_xprt,
2717 .release_xprt = xprt_release_xprt,
2718 .alloc_slot = xprt_alloc_slot,
2719 .free_slot = xprt_free_slot,
2720 .buf_alloc = bc_malloc,
2721 .buf_free = bc_free,
2722 .send_request = bc_send_request,
2723 .wait_for_reply_request = xprt_wait_for_reply_request_def,
2725 .destroy = bc_destroy,
2726 .print_stats = xs_tcp_print_stats,
2727 .enable_swap = xs_enable_swap,
2728 .disable_swap = xs_disable_swap,
2729 .inject_disconnect = xs_inject_disconnect,
2732 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2734 static const struct sockaddr_in sin = {
2735 .sin_family = AF_INET,
2736 .sin_addr.s_addr = htonl(INADDR_ANY),
2738 static const struct sockaddr_in6 sin6 = {
2739 .sin6_family = AF_INET6,
2740 .sin6_addr = IN6ADDR_ANY_INIT,
2747 memcpy(sap, &sin, sizeof(sin));
2750 memcpy(sap, &sin6, sizeof(sin6));
2753 dprintk("RPC: %s: Bad address family\n", __func__);
2754 return -EAFNOSUPPORT;
2759 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2760 unsigned int slot_table_size,
2761 unsigned int max_slot_table_size)
2763 struct rpc_xprt *xprt;
2764 struct sock_xprt *new;
2766 if (args->addrlen > sizeof(xprt->addr)) {
2767 dprintk("RPC: xs_setup_xprt: address too large\n");
2768 return ERR_PTR(-EBADF);
2771 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2772 max_slot_table_size);
2774 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2776 return ERR_PTR(-ENOMEM);
2779 new = container_of(xprt, struct sock_xprt, xprt);
2780 mutex_init(&new->recv_mutex);
2781 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2782 xprt->addrlen = args->addrlen;
2784 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2787 err = xs_init_anyaddr(args->dstaddr->sa_family,
2788 (struct sockaddr *)&new->srcaddr);
2791 return ERR_PTR(err);
2798 static const struct rpc_timeout xs_local_default_timeout = {
2799 .to_initval = 10 * HZ,
2800 .to_maxval = 10 * HZ,
2805 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2806 * @args: rpc transport creation arguments
2808 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2810 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2812 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2813 struct sock_xprt *transport;
2814 struct rpc_xprt *xprt;
2815 struct rpc_xprt *ret;
2817 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2818 xprt_max_tcp_slot_table_entries);
2821 transport = container_of(xprt, struct sock_xprt, xprt);
2824 xprt->xprt_class = &xs_local_transport;
2825 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2827 xprt->bind_timeout = XS_BIND_TO;
2828 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2829 xprt->idle_timeout = XS_IDLE_DISC_TO;
2831 xprt->ops = &xs_local_ops;
2832 xprt->timeout = &xs_local_default_timeout;
2834 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2835 INIT_WORK(&transport->error_worker, xs_error_handle);
2836 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
2838 switch (sun->sun_family) {
2840 if (sun->sun_path[0] != '/') {
2841 dprintk("RPC: bad AF_LOCAL address: %s\n",
2843 ret = ERR_PTR(-EINVAL);
2846 xprt_set_bound(xprt);
2847 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2848 ret = ERR_PTR(xs_local_setup_socket(transport));
2853 ret = ERR_PTR(-EAFNOSUPPORT);
2857 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2858 xprt->address_strings[RPC_DISPLAY_ADDR]);
2860 if (try_module_get(THIS_MODULE))
2862 ret = ERR_PTR(-EINVAL);
2868 static const struct rpc_timeout xs_udp_default_timeout = {
2869 .to_initval = 5 * HZ,
2870 .to_maxval = 30 * HZ,
2871 .to_increment = 5 * HZ,
2876 * xs_setup_udp - Set up transport to use a UDP socket
2877 * @args: rpc transport creation arguments
2880 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2882 struct sockaddr *addr = args->dstaddr;
2883 struct rpc_xprt *xprt;
2884 struct sock_xprt *transport;
2885 struct rpc_xprt *ret;
2887 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2888 xprt_udp_slot_table_entries);
2891 transport = container_of(xprt, struct sock_xprt, xprt);
2893 xprt->prot = IPPROTO_UDP;
2894 xprt->xprt_class = &xs_udp_transport;
2895 /* XXX: header size can vary due to auth type, IPv6, etc. */
2896 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2898 xprt->bind_timeout = XS_BIND_TO;
2899 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2900 xprt->idle_timeout = XS_IDLE_DISC_TO;
2902 xprt->ops = &xs_udp_ops;
2904 xprt->timeout = &xs_udp_default_timeout;
2906 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
2907 INIT_WORK(&transport->error_worker, xs_error_handle);
2908 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
2910 switch (addr->sa_family) {
2912 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2913 xprt_set_bound(xprt);
2915 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2918 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2919 xprt_set_bound(xprt);
2921 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2924 ret = ERR_PTR(-EAFNOSUPPORT);
2928 if (xprt_bound(xprt))
2929 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2930 xprt->address_strings[RPC_DISPLAY_ADDR],
2931 xprt->address_strings[RPC_DISPLAY_PORT],
2932 xprt->address_strings[RPC_DISPLAY_PROTO]);
2934 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2935 xprt->address_strings[RPC_DISPLAY_ADDR],
2936 xprt->address_strings[RPC_DISPLAY_PROTO]);
2938 if (try_module_get(THIS_MODULE))
2940 ret = ERR_PTR(-EINVAL);
2946 static const struct rpc_timeout xs_tcp_default_timeout = {
2947 .to_initval = 60 * HZ,
2948 .to_maxval = 60 * HZ,
2953 * xs_setup_tcp - Set up transport to use a TCP socket
2954 * @args: rpc transport creation arguments
2957 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2959 struct sockaddr *addr = args->dstaddr;
2960 struct rpc_xprt *xprt;
2961 struct sock_xprt *transport;
2962 struct rpc_xprt *ret;
2963 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
2965 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
2966 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
2968 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2969 max_slot_table_size);
2972 transport = container_of(xprt, struct sock_xprt, xprt);
2974 xprt->prot = IPPROTO_TCP;
2975 xprt->xprt_class = &xs_tcp_transport;
2976 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2978 xprt->bind_timeout = XS_BIND_TO;
2979 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2980 xprt->idle_timeout = XS_IDLE_DISC_TO;
2982 xprt->ops = &xs_tcp_ops;
2983 xprt->timeout = &xs_tcp_default_timeout;
2985 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
2986 xprt->connect_timeout = xprt->timeout->to_initval *
2987 (xprt->timeout->to_retries + 1);
2989 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2990 INIT_WORK(&transport->error_worker, xs_error_handle);
2991 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
2993 switch (addr->sa_family) {
2995 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2996 xprt_set_bound(xprt);
2998 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3001 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3002 xprt_set_bound(xprt);
3004 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3007 ret = ERR_PTR(-EAFNOSUPPORT);
3011 if (xprt_bound(xprt))
3012 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3013 xprt->address_strings[RPC_DISPLAY_ADDR],
3014 xprt->address_strings[RPC_DISPLAY_PORT],
3015 xprt->address_strings[RPC_DISPLAY_PROTO]);
3017 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3018 xprt->address_strings[RPC_DISPLAY_ADDR],
3019 xprt->address_strings[RPC_DISPLAY_PROTO]);
3021 if (try_module_get(THIS_MODULE))
3023 ret = ERR_PTR(-EINVAL);
3030 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3031 * @args: rpc transport creation arguments
3034 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
3036 struct sockaddr *addr = args->dstaddr;
3037 struct rpc_xprt *xprt;
3038 struct sock_xprt *transport;
3039 struct svc_sock *bc_sock;
3040 struct rpc_xprt *ret;
3042 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3043 xprt_tcp_slot_table_entries);
3046 transport = container_of(xprt, struct sock_xprt, xprt);
3048 xprt->prot = IPPROTO_TCP;
3049 xprt->xprt_class = &xs_bc_tcp_transport;
3050 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3051 xprt->timeout = &xs_tcp_default_timeout;
3054 xprt_set_bound(xprt);
3055 xprt->bind_timeout = 0;
3056 xprt->reestablish_timeout = 0;
3057 xprt->idle_timeout = 0;
3059 xprt->ops = &bc_tcp_ops;
3061 switch (addr->sa_family) {
3063 xs_format_peer_addresses(xprt, "tcp",
3067 xs_format_peer_addresses(xprt, "tcp",
3068 RPCBIND_NETID_TCP6);
3071 ret = ERR_PTR(-EAFNOSUPPORT);
3075 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3076 xprt->address_strings[RPC_DISPLAY_ADDR],
3077 xprt->address_strings[RPC_DISPLAY_PORT],
3078 xprt->address_strings[RPC_DISPLAY_PROTO]);
3081 * Once we've associated a backchannel xprt with a connection,
3082 * we want to keep it around as long as the connection lasts,
3083 * in case we need to start using it for a backchannel again;
3084 * this reference won't be dropped until bc_xprt is destroyed.
3087 args->bc_xprt->xpt_bc_xprt = xprt;
3088 xprt->bc_xprt = args->bc_xprt;
3089 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3090 transport->sock = bc_sock->sk_sock;
3091 transport->inet = bc_sock->sk_sk;
3094 * Since we don't want connections for the backchannel, we set
3095 * the xprt status to connected
3097 xprt_set_connected(xprt);
3099 if (try_module_get(THIS_MODULE))
3102 args->bc_xprt->xpt_bc_xprt = NULL;
3103 args->bc_xprt->xpt_bc_xps = NULL;
3105 ret = ERR_PTR(-EINVAL);
3111 static struct xprt_class xs_local_transport = {
3112 .list = LIST_HEAD_INIT(xs_local_transport.list),
3113 .name = "named UNIX socket",
3114 .owner = THIS_MODULE,
3115 .ident = XPRT_TRANSPORT_LOCAL,
3116 .setup = xs_setup_local,
3120 static struct xprt_class xs_udp_transport = {
3121 .list = LIST_HEAD_INIT(xs_udp_transport.list),
3123 .owner = THIS_MODULE,
3124 .ident = XPRT_TRANSPORT_UDP,
3125 .setup = xs_setup_udp,
3126 .netid = { "udp", "udp6", "" },
3129 static struct xprt_class xs_tcp_transport = {
3130 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
3132 .owner = THIS_MODULE,
3133 .ident = XPRT_TRANSPORT_TCP,
3134 .setup = xs_setup_tcp,
3135 .netid = { "tcp", "tcp6", "" },
3138 static struct xprt_class xs_bc_tcp_transport = {
3139 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3140 .name = "tcp NFSv4.1 backchannel",
3141 .owner = THIS_MODULE,
3142 .ident = XPRT_TRANSPORT_BC_TCP,
3143 .setup = xs_setup_bc_tcp,
3148 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3151 int init_socket_xprt(void)
3153 if (!sunrpc_table_header)
3154 sunrpc_table_header = register_sysctl_table(sunrpc_table);
3156 xprt_register_transport(&xs_local_transport);
3157 xprt_register_transport(&xs_udp_transport);
3158 xprt_register_transport(&xs_tcp_transport);
3159 xprt_register_transport(&xs_bc_tcp_transport);
3165 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3168 void cleanup_socket_xprt(void)
3170 if (sunrpc_table_header) {
3171 unregister_sysctl_table(sunrpc_table_header);
3172 sunrpc_table_header = NULL;
3175 xprt_unregister_transport(&xs_local_transport);
3176 xprt_unregister_transport(&xs_udp_transport);
3177 xprt_unregister_transport(&xs_tcp_transport);
3178 xprt_unregister_transport(&xs_bc_tcp_transport);
3181 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3183 return param_set_uint_minmax(val, kp,
3188 static const struct kernel_param_ops param_ops_portnr = {
3189 .set = param_set_portnr,
3190 .get = param_get_uint,
3193 #define param_check_portnr(name, p) \
3194 __param_check(name, p, unsigned int);
3196 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3197 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3199 static int param_set_slot_table_size(const char *val,
3200 const struct kernel_param *kp)
3202 return param_set_uint_minmax(val, kp,
3204 RPC_MAX_SLOT_TABLE);
3207 static const struct kernel_param_ops param_ops_slot_table_size = {
3208 .set = param_set_slot_table_size,
3209 .get = param_get_uint,
3212 #define param_check_slot_table_size(name, p) \
3213 __param_check(name, p, unsigned int);
3215 static int param_set_max_slot_table_size(const char *val,
3216 const struct kernel_param *kp)
3218 return param_set_uint_minmax(val, kp,
3220 RPC_MAX_SLOT_TABLE_LIMIT);
3223 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3224 .set = param_set_max_slot_table_size,
3225 .get = param_get_uint,
3228 #define param_check_max_slot_table_size(name, p) \
3229 __param_check(name, p, unsigned int);
3231 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3232 slot_table_size, 0644);
3233 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3234 max_slot_table_size, 0644);
3235 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3236 slot_table_size, 0644);