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_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
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;
71 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
72 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
74 #define XS_TCP_LINGER_TO (15U * HZ)
75 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
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.
82 * We simply need to make sure that we don't collide with
83 * someone else's file names!
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;
92 static struct ctl_table_header *sunrpc_table_header;
94 static struct xprt_class xs_local_transport;
95 static struct xprt_class xs_udp_transport;
96 static struct xprt_class xs_tcp_transport;
97 static struct xprt_class xs_bc_tcp_transport;
100 * FIXME: changing the UDP slot table size should also resize the UDP
101 * socket buffers for existing UDP transports
103 static struct ctl_table xs_tunables_table[] = {
105 .procname = "udp_slot_table_entries",
106 .data = &xprt_udp_slot_table_entries,
107 .maxlen = sizeof(unsigned int),
109 .proc_handler = proc_dointvec_minmax,
110 .extra1 = &min_slot_table_size,
111 .extra2 = &max_slot_table_size
114 .procname = "tcp_slot_table_entries",
115 .data = &xprt_tcp_slot_table_entries,
116 .maxlen = sizeof(unsigned int),
118 .proc_handler = proc_dointvec_minmax,
119 .extra1 = &min_slot_table_size,
120 .extra2 = &max_slot_table_size
123 .procname = "tcp_max_slot_table_entries",
124 .data = &xprt_max_tcp_slot_table_entries,
125 .maxlen = sizeof(unsigned int),
127 .proc_handler = proc_dointvec_minmax,
128 .extra1 = &min_slot_table_size,
129 .extra2 = &max_tcp_slot_table_limit
132 .procname = "min_resvport",
133 .data = &xprt_min_resvport,
134 .maxlen = sizeof(unsigned int),
136 .proc_handler = proc_dointvec_minmax,
137 .extra1 = &xprt_min_resvport_limit,
138 .extra2 = &xprt_max_resvport_limit
141 .procname = "max_resvport",
142 .data = &xprt_max_resvport,
143 .maxlen = sizeof(unsigned int),
145 .proc_handler = proc_dointvec_minmax,
146 .extra1 = &xprt_min_resvport_limit,
147 .extra2 = &xprt_max_resvport_limit
150 .procname = "tcp_fin_timeout",
151 .data = &xs_tcp_fin_timeout,
152 .maxlen = sizeof(xs_tcp_fin_timeout),
154 .proc_handler = proc_dointvec_jiffies,
159 static struct ctl_table sunrpc_table[] = {
161 .procname = "sunrpc",
163 .child = xs_tunables_table
169 * Wait duration for a reply from the RPC portmapper.
171 #define XS_BIND_TO (60U * HZ)
174 * Delay if a UDP socket connect error occurs. This is most likely some
175 * kind of resource problem on the local host.
177 #define XS_UDP_REEST_TO (2U * HZ)
180 * The reestablish timeout allows clients to delay for a bit before attempting
181 * to reconnect to a server that just dropped our connection.
183 * We implement an exponential backoff when trying to reestablish a TCP
184 * transport connection with the server. Some servers like to drop a TCP
185 * connection when they are overworked, so we start with a short timeout and
186 * increase over time if the server is down or not responding.
188 #define XS_TCP_INIT_REEST_TO (3U * HZ)
191 * TCP idle timeout; client drops the transport socket if it is idle
192 * for this long. Note that we also timeout UDP sockets to prevent
193 * holding port numbers when there is no RPC traffic.
195 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
197 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
198 # undef RPC_DEBUG_DATA
199 # define RPCDBG_FACILITY RPCDBG_TRANS
202 #ifdef RPC_DEBUG_DATA
203 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
205 u8 *buf = (u8 *) packet;
208 dprintk("RPC: %s\n", msg);
209 for (j = 0; j < count && j < 128; j += 4) {
213 dprintk("0x%04x ", j);
215 dprintk("%02x%02x%02x%02x ",
216 buf[j], buf[j+1], buf[j+2], buf[j+3]);
221 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
227 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
229 return (struct rpc_xprt *) sk->sk_user_data;
232 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
234 return (struct sockaddr *) &xprt->addr;
237 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
239 return (struct sockaddr_un *) &xprt->addr;
242 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
244 return (struct sockaddr_in *) &xprt->addr;
247 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
249 return (struct sockaddr_in6 *) &xprt->addr;
252 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
254 struct sockaddr *sap = xs_addr(xprt);
255 struct sockaddr_in6 *sin6;
256 struct sockaddr_in *sin;
257 struct sockaddr_un *sun;
260 switch (sap->sa_family) {
262 sun = xs_addr_un(xprt);
263 strlcpy(buf, sun->sun_path, sizeof(buf));
264 xprt->address_strings[RPC_DISPLAY_ADDR] =
265 kstrdup(buf, GFP_KERNEL);
268 (void)rpc_ntop(sap, buf, sizeof(buf));
269 xprt->address_strings[RPC_DISPLAY_ADDR] =
270 kstrdup(buf, GFP_KERNEL);
271 sin = xs_addr_in(xprt);
272 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
275 (void)rpc_ntop(sap, buf, sizeof(buf));
276 xprt->address_strings[RPC_DISPLAY_ADDR] =
277 kstrdup(buf, GFP_KERNEL);
278 sin6 = xs_addr_in6(xprt);
279 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
285 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
288 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
290 struct sockaddr *sap = xs_addr(xprt);
293 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
294 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
296 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
297 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
300 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
301 const char *protocol,
304 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
305 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
306 xs_format_common_peer_addresses(xprt);
307 xs_format_common_peer_ports(xprt);
310 static void xs_update_peer_port(struct rpc_xprt *xprt)
312 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
313 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
315 xs_format_common_peer_ports(xprt);
318 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
322 for (i = 0; i < RPC_DISPLAY_MAX; i++)
324 case RPC_DISPLAY_PROTO:
325 case RPC_DISPLAY_NETID:
328 kfree(xprt->address_strings[i]);
333 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp)
337 if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES))
339 n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT;
340 for (i = 0; i < n; i++) {
343 buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp);
344 if (!buf->pages[i]) {
346 return i > buf->page_base ? i - buf->page_base : 0;
353 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek)
357 iov_iter_advance(&msg->msg_iter, seek);
358 ret = sock_recvmsg(sock, msg, flags);
359 return ret > 0 ? ret + seek : ret;
363 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags,
364 struct kvec *kvec, size_t count, size_t seek)
366 iov_iter_kvec(&msg->msg_iter, READ, kvec, 1, count);
367 return xs_sock_recvmsg(sock, msg, flags, seek);
371 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags,
372 struct bio_vec *bvec, unsigned long nr, size_t count,
375 iov_iter_bvec(&msg->msg_iter, READ, bvec, nr, count);
376 return xs_sock_recvmsg(sock, msg, flags, seek);
380 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags,
383 iov_iter_discard(&msg->msg_iter, READ, count);
384 return sock_recvmsg(sock, msg, flags);
387 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
389 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
391 struct bvec_iter bi = {
396 bvec_iter_advance(bvec, &bi, seek & PAGE_MASK);
397 for_each_bvec(bv, bvec, bi, bi)
398 flush_dcache_page(bv.bv_page);
402 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
408 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags,
409 struct xdr_buf *buf, size_t count, size_t seek, size_t *read)
411 size_t want, seek_init = seek, offset = 0;
414 want = min_t(size_t, count, buf->head[0].iov_len);
416 ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek);
420 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
430 want = xs_alloc_sparse_pages(buf,
431 min_t(size_t, count - offset, buf->page_len),
434 ret = xs_read_bvec(sock, msg, flags, buf->bvec,
435 xdr_buf_pagecount(buf),
436 want + buf->page_base,
437 seek + buf->page_base);
440 xs_flush_bvec(buf->bvec, ret, seek + buf->page_base);
441 ret -= buf->page_base;
443 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
453 want = min_t(size_t, count - offset, buf->tail[0].iov_len);
455 ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek);
459 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
463 } else if (offset < seek_init)
467 *read = offset - seek_init;
475 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf)
477 if (!transport->recv.copied) {
478 if (buf->head[0].iov_len >= transport->recv.offset)
479 memcpy(buf->head[0].iov_base,
480 &transport->recv.xid,
481 transport->recv.offset);
482 transport->recv.copied = transport->recv.offset;
487 xs_read_stream_request_done(struct sock_xprt *transport)
489 return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT);
493 xs_read_stream_check_eor(struct sock_xprt *transport,
496 if (xs_read_stream_request_done(transport))
497 msg->msg_flags |= MSG_EOR;
501 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg,
502 int flags, struct rpc_rqst *req)
504 struct xdr_buf *buf = &req->rq_private_buf;
508 xs_read_header(transport, buf);
510 want = transport->recv.len - transport->recv.offset;
512 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
513 transport->recv.copied + want,
514 transport->recv.copied,
516 transport->recv.offset += read;
517 transport->recv.copied += read;
520 if (transport->recv.offset == transport->recv.len)
521 xs_read_stream_check_eor(transport, msg);
531 msg->msg_flags |= MSG_TRUNC;
536 return ret < 0 ? ret : read;
540 xs_read_stream_headersize(bool isfrag)
543 return sizeof(__be32);
544 return 3 * sizeof(__be32);
548 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
549 int flags, size_t want, size_t seek)
552 .iov_base = &transport->recv.fraghdr,
555 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
558 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
560 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
562 struct rpc_xprt *xprt = &transport->xprt;
563 struct rpc_rqst *req;
566 /* Is this transport associated with the backchannel? */
570 /* Look up and lock the request corresponding to the given XID */
571 req = xprt_lookup_bc_request(xprt, transport->recv.xid);
573 printk(KERN_WARNING "Callback slot table overflowed\n");
576 if (transport->recv.copied && !req->rq_private_buf.len)
579 ret = xs_read_stream_request(transport, msg, flags, req);
580 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
581 xprt_complete_bc_request(req, transport->recv.copied);
583 req->rq_private_buf.len = transport->recv.copied;
587 #else /* CONFIG_SUNRPC_BACKCHANNEL */
589 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
593 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
596 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
598 struct rpc_xprt *xprt = &transport->xprt;
599 struct rpc_rqst *req;
602 /* Look up and lock the request corresponding to the given XID */
603 spin_lock(&xprt->queue_lock);
604 req = xprt_lookup_rqst(xprt, transport->recv.xid);
605 if (!req || (transport->recv.copied && !req->rq_private_buf.len)) {
606 msg->msg_flags |= MSG_TRUNC;
610 spin_unlock(&xprt->queue_lock);
612 ret = xs_read_stream_request(transport, msg, flags, req);
614 spin_lock(&xprt->queue_lock);
615 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
616 xprt_complete_rqst(req->rq_task, transport->recv.copied);
618 req->rq_private_buf.len = transport->recv.copied;
619 xprt_unpin_rqst(req);
621 spin_unlock(&xprt->queue_lock);
626 xs_read_stream(struct sock_xprt *transport, int flags)
628 struct msghdr msg = { 0 };
629 size_t want, read = 0;
632 if (transport->recv.len == 0) {
633 want = xs_read_stream_headersize(transport->recv.copied != 0);
634 ret = xs_read_stream_header(transport, &msg, flags, want,
635 transport->recv.offset);
638 transport->recv.offset = ret;
639 if (transport->recv.offset != want)
640 return transport->recv.offset;
641 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
642 RPC_FRAGMENT_SIZE_MASK;
643 transport->recv.offset -= sizeof(transport->recv.fraghdr);
647 switch (be32_to_cpu(transport->recv.calldir)) {
649 msg.msg_flags |= MSG_TRUNC;
652 ret = xs_read_stream_call(transport, &msg, flags);
655 ret = xs_read_stream_reply(transport, &msg, flags);
657 if (msg.msg_flags & MSG_TRUNC) {
658 transport->recv.calldir = cpu_to_be32(-1);
659 transport->recv.copied = -1;
664 if (transport->recv.offset < transport->recv.len) {
665 if (!(msg.msg_flags & MSG_TRUNC))
668 ret = xs_read_discard(transport->sock, &msg, flags,
669 transport->recv.len - transport->recv.offset);
672 transport->recv.offset += ret;
674 if (transport->recv.offset != transport->recv.len)
677 if (xs_read_stream_request_done(transport)) {
678 trace_xs_stream_read_request(transport);
679 transport->recv.copied = 0;
681 transport->recv.offset = 0;
682 transport->recv.len = 0;
685 return ret != 0 ? ret : -ESHUTDOWN;
688 static __poll_t xs_poll_socket(struct sock_xprt *transport)
690 return transport->sock->ops->poll(transport->file, transport->sock,
694 static bool xs_poll_socket_readable(struct sock_xprt *transport)
696 __poll_t events = xs_poll_socket(transport);
698 return (events & (EPOLLIN | EPOLLRDNORM)) && !(events & EPOLLRDHUP);
701 static void xs_poll_check_readable(struct sock_xprt *transport)
704 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
705 if (!xs_poll_socket_readable(transport))
707 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
708 queue_work(xprtiod_workqueue, &transport->recv_worker);
711 static void xs_stream_data_receive(struct sock_xprt *transport)
716 mutex_lock(&transport->recv_mutex);
717 if (transport->sock == NULL)
720 ret = xs_read_stream(transport, MSG_DONTWAIT);
726 if (ret == -ESHUTDOWN)
727 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
729 xs_poll_check_readable(transport);
731 mutex_unlock(&transport->recv_mutex);
732 trace_xs_stream_read_data(&transport->xprt, ret, read);
735 static void xs_stream_data_receive_workfn(struct work_struct *work)
737 struct sock_xprt *transport =
738 container_of(work, struct sock_xprt, recv_worker);
739 unsigned int pflags = memalloc_nofs_save();
741 xs_stream_data_receive(transport);
742 memalloc_nofs_restore(pflags);
746 xs_stream_reset_connect(struct sock_xprt *transport)
748 transport->recv.offset = 0;
749 transport->recv.len = 0;
750 transport->recv.copied = 0;
751 transport->xmit.offset = 0;
755 xs_stream_start_connect(struct sock_xprt *transport)
757 transport->xprt.stat.connect_count++;
758 transport->xprt.stat.connect_start = jiffies;
761 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
764 * xs_nospace - handle transmit was incomplete
765 * @req: pointer to RPC request
766 * @transport: pointer to struct sock_xprt
769 static int xs_nospace(struct rpc_rqst *req, struct sock_xprt *transport)
771 struct rpc_xprt *xprt = &transport->xprt;
772 struct sock *sk = transport->inet;
775 trace_rpc_socket_nospace(req, transport);
777 /* Protect against races with write_space */
778 spin_lock(&xprt->transport_lock);
780 /* Don't race with disconnect */
781 if (xprt_connected(xprt)) {
782 struct socket_wq *wq;
785 wq = rcu_dereference(sk->sk_wq);
786 set_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags);
789 /* wait for more buffer space */
790 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
791 sk->sk_write_pending++;
792 xprt_wait_for_buffer_space(xprt);
796 spin_unlock(&xprt->transport_lock);
800 static int xs_sock_nospace(struct rpc_rqst *req)
802 struct sock_xprt *transport =
803 container_of(req->rq_xprt, struct sock_xprt, xprt);
804 struct sock *sk = transport->inet;
808 if (!sock_writeable(sk))
809 ret = xs_nospace(req, transport);
814 static int xs_stream_nospace(struct rpc_rqst *req)
816 struct sock_xprt *transport =
817 container_of(req->rq_xprt, struct sock_xprt, xprt);
818 struct sock *sk = transport->inet;
822 if (!sk_stream_memory_free(sk))
823 ret = xs_nospace(req, transport);
829 xs_stream_prepare_request(struct rpc_rqst *req)
831 xdr_free_bvec(&req->rq_rcv_buf);
832 req->rq_task->tk_status = xdr_alloc_bvec(&req->rq_rcv_buf, GFP_KERNEL);
836 * Determine if the previous message in the stream was aborted before it
837 * could complete transmission.
840 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
842 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
846 * Return the stream record marker field for a record of length < 2^31-1
849 xs_stream_record_marker(struct xdr_buf *xdr)
853 return cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | (u32)xdr->len);
857 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
858 * @req: pointer to RPC request
861 * 0: The request has been sent
862 * EAGAIN: The socket was blocked, please call again later to
863 * complete the request
864 * ENOTCONN: Caller needs to invoke connect logic then call again
865 * other: Some other error occurred, the request was not sent
867 static int xs_local_send_request(struct rpc_rqst *req)
869 struct rpc_xprt *xprt = req->rq_xprt;
870 struct sock_xprt *transport =
871 container_of(xprt, struct sock_xprt, xprt);
872 struct xdr_buf *xdr = &req->rq_snd_buf;
873 rpc_fraghdr rm = xs_stream_record_marker(xdr);
874 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
875 struct msghdr msg = {
876 .msg_flags = XS_SENDMSG_FLAGS,
881 /* Close the stream if the previous transmission was incomplete */
882 if (xs_send_request_was_aborted(transport, req)) {
887 xs_pktdump("packet data:",
888 req->rq_svec->iov_base, req->rq_svec->iov_len);
890 req->rq_xtime = ktime_get();
891 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
892 transport->xmit.offset, rm, &sent);
893 dprintk("RPC: %s(%u) = %d\n",
894 __func__, xdr->len - transport->xmit.offset, status);
896 if (status == -EAGAIN && sock_writeable(transport->inet))
899 if (likely(sent > 0) || status == 0) {
900 transport->xmit.offset += sent;
901 req->rq_bytes_sent = transport->xmit.offset;
902 if (likely(req->rq_bytes_sent >= msglen)) {
903 req->rq_xmit_bytes_sent += transport->xmit.offset;
904 transport->xmit.offset = 0;
914 status = xs_stream_nospace(req);
917 dprintk("RPC: sendmsg returned unrecognized error %d\n",
929 * xs_udp_send_request - write an RPC request to a UDP socket
930 * @req: pointer to RPC request
933 * 0: The request has been sent
934 * EAGAIN: The socket was blocked, please call again later to
935 * complete the request
936 * ENOTCONN: Caller needs to invoke connect logic then call again
937 * other: Some other error occurred, the request was not sent
939 static int xs_udp_send_request(struct rpc_rqst *req)
941 struct rpc_xprt *xprt = req->rq_xprt;
942 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
943 struct xdr_buf *xdr = &req->rq_snd_buf;
944 struct msghdr msg = {
945 .msg_name = xs_addr(xprt),
946 .msg_namelen = xprt->addrlen,
947 .msg_flags = XS_SENDMSG_FLAGS,
952 xs_pktdump("packet data:",
953 req->rq_svec->iov_base,
954 req->rq_svec->iov_len);
956 if (!xprt_bound(xprt))
959 if (!xprt_request_get_cong(xprt, req))
962 req->rq_xtime = ktime_get();
963 status = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, 0, &sent);
965 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
968 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
969 if (status == -EPERM)
972 if (status == -EAGAIN && sock_writeable(transport->inet))
975 if (sent > 0 || status == 0) {
976 req->rq_xmit_bytes_sent += sent;
977 if (sent >= req->rq_slen)
979 /* Still some bytes left; set up for a retry later. */
987 /* Should we call xs_close() here? */
990 status = xs_sock_nospace(req);
997 /* When the server has died, an ICMP port unreachable message
998 * prompts ECONNREFUSED. */
1001 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1009 * xs_tcp_send_request - write an RPC request to a TCP socket
1010 * @req: pointer to RPC request
1013 * 0: The request has been sent
1014 * EAGAIN: The socket was blocked, please call again later to
1015 * complete the request
1016 * ENOTCONN: Caller needs to invoke connect logic then call again
1017 * other: Some other error occurred, the request was not sent
1019 * XXX: In the case of soft timeouts, should we eventually give up
1020 * if sendmsg is not able to make progress?
1022 static int xs_tcp_send_request(struct rpc_rqst *req)
1024 struct rpc_xprt *xprt = req->rq_xprt;
1025 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1026 struct xdr_buf *xdr = &req->rq_snd_buf;
1027 rpc_fraghdr rm = xs_stream_record_marker(xdr);
1028 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
1029 struct msghdr msg = {
1030 .msg_flags = XS_SENDMSG_FLAGS,
1032 bool vm_wait = false;
1036 /* Close the stream if the previous transmission was incomplete */
1037 if (xs_send_request_was_aborted(transport, req)) {
1038 if (transport->sock != NULL)
1039 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1042 if (!transport->inet)
1045 xs_pktdump("packet data:",
1046 req->rq_svec->iov_base,
1047 req->rq_svec->iov_len);
1049 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1050 xs_tcp_set_socket_timeouts(xprt, transport->sock);
1052 /* Continue transmitting the packet/record. We must be careful
1053 * to cope with writespace callbacks arriving _after_ we have
1054 * called sendmsg(). */
1055 req->rq_xtime = ktime_get();
1056 tcp_sock_set_cork(transport->inet, true);
1058 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
1059 transport->xmit.offset, rm, &sent);
1061 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
1062 xdr->len - transport->xmit.offset, status);
1064 /* If we've sent the entire packet, immediately
1065 * reset the count of bytes sent. */
1066 transport->xmit.offset += sent;
1067 req->rq_bytes_sent = transport->xmit.offset;
1068 if (likely(req->rq_bytes_sent >= msglen)) {
1069 req->rq_xmit_bytes_sent += transport->xmit.offset;
1070 transport->xmit.offset = 0;
1071 if (atomic_long_read(&xprt->xmit_queuelen) == 1)
1072 tcp_sock_set_cork(transport->inet, false);
1076 WARN_ON_ONCE(sent == 0 && status == 0);
1078 if (status == -EAGAIN ) {
1080 * Return EAGAIN if we're sure we're hitting the
1081 * socket send buffer limits.
1083 if (test_bit(SOCK_NOSPACE, &transport->sock->flags))
1086 * Did we hit a memory allocation failure?
1092 /* Retry, knowing now that we're below the
1093 * socket send buffer limit
1107 /* Should we call xs_close() here? */
1110 status = xs_stream_nospace(req);
1120 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1127 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1129 transport->old_data_ready = sk->sk_data_ready;
1130 transport->old_state_change = sk->sk_state_change;
1131 transport->old_write_space = sk->sk_write_space;
1132 transport->old_error_report = sk->sk_error_report;
1135 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1137 sk->sk_data_ready = transport->old_data_ready;
1138 sk->sk_state_change = transport->old_state_change;
1139 sk->sk_write_space = transport->old_write_space;
1140 sk->sk_error_report = transport->old_error_report;
1143 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1145 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1147 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1148 clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state);
1149 clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state);
1150 clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state);
1153 static void xs_run_error_worker(struct sock_xprt *transport, unsigned int nr)
1155 set_bit(nr, &transport->sock_state);
1156 queue_work(xprtiod_workqueue, &transport->error_worker);
1159 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1161 smp_mb__before_atomic();
1162 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1163 clear_bit(XPRT_CLOSING, &xprt->state);
1164 xs_sock_reset_state_flags(xprt);
1165 smp_mb__after_atomic();
1169 * xs_error_report - callback to handle TCP socket state errors
1172 * Note: we don't call sock_error() since there may be a rpc_task
1173 * using the socket, and so we don't want to clear sk->sk_err.
1175 static void xs_error_report(struct sock *sk)
1177 struct sock_xprt *transport;
1178 struct rpc_xprt *xprt;
1180 read_lock_bh(&sk->sk_callback_lock);
1181 if (!(xprt = xprt_from_sock(sk)))
1184 transport = container_of(xprt, struct sock_xprt, xprt);
1185 transport->xprt_err = -sk->sk_err;
1186 if (transport->xprt_err == 0)
1188 dprintk("RPC: xs_error_report client %p, error=%d...\n",
1189 xprt, -transport->xprt_err);
1190 trace_rpc_socket_error(xprt, sk->sk_socket, transport->xprt_err);
1192 /* barrier ensures xprt_err is set before XPRT_SOCK_WAKE_ERROR */
1193 smp_mb__before_atomic();
1194 xs_run_error_worker(transport, XPRT_SOCK_WAKE_ERROR);
1196 read_unlock_bh(&sk->sk_callback_lock);
1199 static void xs_reset_transport(struct sock_xprt *transport)
1201 struct socket *sock = transport->sock;
1202 struct sock *sk = transport->inet;
1203 struct rpc_xprt *xprt = &transport->xprt;
1204 struct file *filp = transport->file;
1209 if (atomic_read(&transport->xprt.swapper))
1210 sk_clear_memalloc(sk);
1212 kernel_sock_shutdown(sock, SHUT_RDWR);
1214 mutex_lock(&transport->recv_mutex);
1215 write_lock_bh(&sk->sk_callback_lock);
1216 transport->inet = NULL;
1217 transport->sock = NULL;
1218 transport->file = NULL;
1220 sk->sk_user_data = NULL;
1222 xs_restore_old_callbacks(transport, sk);
1223 xprt_clear_connected(xprt);
1224 write_unlock_bh(&sk->sk_callback_lock);
1225 xs_sock_reset_connection_flags(xprt);
1226 /* Reset stream record info */
1227 xs_stream_reset_connect(transport);
1228 mutex_unlock(&transport->recv_mutex);
1230 trace_rpc_socket_close(xprt, sock);
1233 xprt_disconnect_done(xprt);
1237 * xs_close - close a socket
1240 * This is used when all requests are complete; ie, no DRC state remains
1241 * on the server we want to save.
1243 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1244 * xs_reset_transport() zeroing the socket from underneath a writer.
1246 static void xs_close(struct rpc_xprt *xprt)
1248 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1250 dprintk("RPC: xs_close xprt %p\n", xprt);
1252 xs_reset_transport(transport);
1253 xprt->reestablish_timeout = 0;
1256 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1258 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
1260 xprt_disconnect_done(xprt);
1263 static void xs_xprt_free(struct rpc_xprt *xprt)
1265 xs_free_peer_addresses(xprt);
1270 * xs_destroy - prepare to shutdown a transport
1271 * @xprt: doomed transport
1274 static void xs_destroy(struct rpc_xprt *xprt)
1276 struct sock_xprt *transport = container_of(xprt,
1277 struct sock_xprt, xprt);
1278 dprintk("RPC: xs_destroy xprt %p\n", xprt);
1280 cancel_delayed_work_sync(&transport->connect_worker);
1282 cancel_work_sync(&transport->recv_worker);
1283 cancel_work_sync(&transport->error_worker);
1285 module_put(THIS_MODULE);
1289 * xs_udp_data_read_skb - receive callback for UDP sockets
1295 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1297 struct sk_buff *skb)
1299 struct rpc_task *task;
1300 struct rpc_rqst *rovr;
1301 int repsize, copied;
1307 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1311 /* Copy the XID from the skb... */
1312 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1316 /* Look up and lock the request corresponding to the given XID */
1317 spin_lock(&xprt->queue_lock);
1318 rovr = xprt_lookup_rqst(xprt, *xp);
1321 xprt_pin_rqst(rovr);
1322 xprt_update_rtt(rovr->rq_task);
1323 spin_unlock(&xprt->queue_lock);
1324 task = rovr->rq_task;
1326 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1329 /* Suck it into the iovec, verify checksum if not done by hw. */
1330 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1331 spin_lock(&xprt->queue_lock);
1332 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1337 spin_lock(&xprt->transport_lock);
1338 xprt_adjust_cwnd(xprt, task, copied);
1339 spin_unlock(&xprt->transport_lock);
1340 spin_lock(&xprt->queue_lock);
1341 xprt_complete_rqst(task, copied);
1342 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1344 xprt_unpin_rqst(rovr);
1346 spin_unlock(&xprt->queue_lock);
1349 static void xs_udp_data_receive(struct sock_xprt *transport)
1351 struct sk_buff *skb;
1355 mutex_lock(&transport->recv_mutex);
1356 sk = transport->inet;
1360 skb = skb_recv_udp(sk, 0, 1, &err);
1363 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1367 xs_poll_check_readable(transport);
1369 mutex_unlock(&transport->recv_mutex);
1372 static void xs_udp_data_receive_workfn(struct work_struct *work)
1374 struct sock_xprt *transport =
1375 container_of(work, struct sock_xprt, recv_worker);
1376 unsigned int pflags = memalloc_nofs_save();
1378 xs_udp_data_receive(transport);
1379 memalloc_nofs_restore(pflags);
1383 * xs_data_ready - "data ready" callback for UDP sockets
1384 * @sk: socket with data to read
1387 static void xs_data_ready(struct sock *sk)
1389 struct rpc_xprt *xprt;
1391 read_lock_bh(&sk->sk_callback_lock);
1392 dprintk("RPC: xs_data_ready...\n");
1393 xprt = xprt_from_sock(sk);
1395 struct sock_xprt *transport = container_of(xprt,
1396 struct sock_xprt, xprt);
1397 transport->old_data_ready(sk);
1398 /* Any data means we had a useful conversation, so
1399 * then we don't need to delay the next reconnect
1401 if (xprt->reestablish_timeout)
1402 xprt->reestablish_timeout = 0;
1403 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1404 queue_work(xprtiod_workqueue, &transport->recv_worker);
1406 read_unlock_bh(&sk->sk_callback_lock);
1410 * Helper function to force a TCP close if the server is sending
1411 * junk and/or it has put us in CLOSE_WAIT
1413 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1415 xprt_force_disconnect(xprt);
1418 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1419 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1423 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1426 * xs_tcp_state_change - callback to handle TCP socket state changes
1427 * @sk: socket whose state has changed
1430 static void xs_tcp_state_change(struct sock *sk)
1432 struct rpc_xprt *xprt;
1433 struct sock_xprt *transport;
1435 read_lock_bh(&sk->sk_callback_lock);
1436 if (!(xprt = xprt_from_sock(sk)))
1438 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1439 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1440 sk->sk_state, xprt_connected(xprt),
1441 sock_flag(sk, SOCK_DEAD),
1442 sock_flag(sk, SOCK_ZAPPED),
1445 transport = container_of(xprt, struct sock_xprt, xprt);
1446 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1447 switch (sk->sk_state) {
1448 case TCP_ESTABLISHED:
1449 if (!xprt_test_and_set_connected(xprt)) {
1450 xprt->connect_cookie++;
1451 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1452 xprt_clear_connecting(xprt);
1454 xprt->stat.connect_count++;
1455 xprt->stat.connect_time += (long)jiffies -
1456 xprt->stat.connect_start;
1457 xs_run_error_worker(transport, XPRT_SOCK_WAKE_PENDING);
1461 /* The client initiated a shutdown of the socket */
1462 xprt->connect_cookie++;
1463 xprt->reestablish_timeout = 0;
1464 set_bit(XPRT_CLOSING, &xprt->state);
1465 smp_mb__before_atomic();
1466 clear_bit(XPRT_CONNECTED, &xprt->state);
1467 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1468 smp_mb__after_atomic();
1470 case TCP_CLOSE_WAIT:
1471 /* The server initiated a shutdown of the socket */
1472 xprt->connect_cookie++;
1473 clear_bit(XPRT_CONNECTED, &xprt->state);
1474 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1478 * If the server closed down the connection, make sure that
1479 * we back off before reconnecting
1481 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1482 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1485 set_bit(XPRT_CLOSING, &xprt->state);
1486 smp_mb__before_atomic();
1487 clear_bit(XPRT_CONNECTED, &xprt->state);
1488 smp_mb__after_atomic();
1491 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1492 &transport->sock_state))
1493 xprt_clear_connecting(xprt);
1494 clear_bit(XPRT_CLOSING, &xprt->state);
1495 /* Trigger the socket release */
1496 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1499 read_unlock_bh(&sk->sk_callback_lock);
1502 static void xs_write_space(struct sock *sk)
1504 struct socket_wq *wq;
1505 struct sock_xprt *transport;
1506 struct rpc_xprt *xprt;
1510 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1512 if (unlikely(!(xprt = xprt_from_sock(sk))))
1514 transport = container_of(xprt, struct sock_xprt, xprt);
1516 wq = rcu_dereference(sk->sk_wq);
1517 if (!wq || test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags) == 0)
1520 xs_run_error_worker(transport, XPRT_SOCK_WAKE_WRITE);
1521 sk->sk_write_pending--;
1527 * xs_udp_write_space - callback invoked when socket buffer space
1529 * @sk: socket whose state has changed
1531 * Called when more output buffer space is available for this socket.
1532 * We try not to wake our writers until they can make "significant"
1533 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1534 * with a bunch of small requests.
1536 static void xs_udp_write_space(struct sock *sk)
1538 read_lock_bh(&sk->sk_callback_lock);
1540 /* from net/core/sock.c:sock_def_write_space */
1541 if (sock_writeable(sk))
1544 read_unlock_bh(&sk->sk_callback_lock);
1548 * xs_tcp_write_space - callback invoked when socket buffer space
1550 * @sk: socket whose state has changed
1552 * Called when more output buffer space is available for this socket.
1553 * We try not to wake our writers until they can make "significant"
1554 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1555 * with a bunch of small requests.
1557 static void xs_tcp_write_space(struct sock *sk)
1559 read_lock_bh(&sk->sk_callback_lock);
1561 /* from net/core/stream.c:sk_stream_write_space */
1562 if (sk_stream_is_writeable(sk))
1565 read_unlock_bh(&sk->sk_callback_lock);
1568 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1570 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1571 struct sock *sk = transport->inet;
1573 if (transport->rcvsize) {
1574 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1575 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1577 if (transport->sndsize) {
1578 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1579 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1580 sk->sk_write_space(sk);
1585 * xs_udp_set_buffer_size - set send and receive limits
1586 * @xprt: generic transport
1587 * @sndsize: requested size of send buffer, in bytes
1588 * @rcvsize: requested size of receive buffer, in bytes
1590 * Set socket send and receive buffer size limits.
1592 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1594 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1596 transport->sndsize = 0;
1598 transport->sndsize = sndsize + 1024;
1599 transport->rcvsize = 0;
1601 transport->rcvsize = rcvsize + 1024;
1603 xs_udp_do_set_buffer_size(xprt);
1607 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1608 * @xprt: controlling transport
1609 * @task: task that timed out
1611 * Adjust the congestion window after a retransmit timeout has occurred.
1613 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1615 spin_lock(&xprt->transport_lock);
1616 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1617 spin_unlock(&xprt->transport_lock);
1620 static int xs_get_random_port(void)
1622 unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1623 unsigned short range;
1624 unsigned short rand;
1628 range = max - min + 1;
1629 rand = (unsigned short) prandom_u32() % range;
1633 static unsigned short xs_sock_getport(struct socket *sock)
1635 struct sockaddr_storage buf;
1636 unsigned short port = 0;
1638 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1640 switch (buf.ss_family) {
1642 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1645 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1652 * xs_set_port - reset the port number in the remote endpoint address
1653 * @xprt: generic transport
1654 * @port: new port number
1657 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1659 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1661 rpc_set_port(xs_addr(xprt), port);
1662 xs_update_peer_port(xprt);
1665 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1667 if (transport->srcport == 0 && transport->xprt.reuseport)
1668 transport->srcport = xs_sock_getport(sock);
1671 static int xs_get_srcport(struct sock_xprt *transport)
1673 int port = transport->srcport;
1675 if (port == 0 && transport->xprt.resvport)
1676 port = xs_get_random_port();
1680 unsigned short get_srcport(struct rpc_xprt *xprt)
1682 struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1683 return xs_sock_getport(sock->sock);
1685 EXPORT_SYMBOL(get_srcport);
1687 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1689 if (transport->srcport != 0)
1690 transport->srcport = 0;
1691 if (!transport->xprt.resvport)
1693 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1694 return xprt_max_resvport;
1697 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1699 struct sockaddr_storage myaddr;
1701 int port = xs_get_srcport(transport);
1702 unsigned short last;
1705 * If we are asking for any ephemeral port (i.e. port == 0 &&
1706 * transport->xprt.resvport == 0), don't bind. Let the local
1707 * port selection happen implicitly when the socket is used
1708 * (for example at connect time).
1710 * This ensures that we can continue to establish TCP
1711 * connections even when all local ephemeral ports are already
1712 * a part of some TCP connection. This makes no difference
1713 * for UDP sockets, but also doesn't harm them.
1715 * If we're asking for any reserved port (i.e. port == 0 &&
1716 * transport->xprt.resvport == 1) xs_get_srcport above will
1717 * ensure that port is non-zero and we will bind as needed.
1722 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1724 rpc_set_port((struct sockaddr *)&myaddr, port);
1725 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1726 transport->xprt.addrlen);
1728 if (transport->xprt.reuseport)
1729 transport->srcport = port;
1733 port = xs_next_srcport(transport, port);
1736 } while (err == -EADDRINUSE && nloop != 2);
1738 if (myaddr.ss_family == AF_INET)
1739 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1740 &((struct sockaddr_in *)&myaddr)->sin_addr,
1741 port, err ? "failed" : "ok", err);
1743 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1744 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1745 port, err ? "failed" : "ok", err);
1750 * We don't support autobind on AF_LOCAL sockets
1752 static void xs_local_rpcbind(struct rpc_task *task)
1754 xprt_set_bound(task->tk_xprt);
1757 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1761 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1762 static struct lock_class_key xs_key[2];
1763 static struct lock_class_key xs_slock_key[2];
1765 static inline void xs_reclassify_socketu(struct socket *sock)
1767 struct sock *sk = sock->sk;
1769 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1770 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1773 static inline void xs_reclassify_socket4(struct socket *sock)
1775 struct sock *sk = sock->sk;
1777 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1778 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1781 static inline void xs_reclassify_socket6(struct socket *sock)
1783 struct sock *sk = sock->sk;
1785 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1786 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1789 static inline void xs_reclassify_socket(int family, struct socket *sock)
1791 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1796 xs_reclassify_socketu(sock);
1799 xs_reclassify_socket4(sock);
1802 xs_reclassify_socket6(sock);
1807 static inline void xs_reclassify_socket(int family, struct socket *sock)
1812 static void xs_dummy_setup_socket(struct work_struct *work)
1816 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1817 struct sock_xprt *transport, int family, int type,
1818 int protocol, bool reuseport)
1821 struct socket *sock;
1824 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1826 dprintk("RPC: can't create %d transport socket (%d).\n",
1830 xs_reclassify_socket(family, sock);
1833 sock_set_reuseport(sock->sk);
1835 err = xs_bind(transport, sock);
1841 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1843 return ERR_CAST(filp);
1844 transport->file = filp;
1848 return ERR_PTR(err);
1851 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1852 struct socket *sock)
1854 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1857 if (!transport->inet) {
1858 struct sock *sk = sock->sk;
1860 write_lock_bh(&sk->sk_callback_lock);
1862 xs_save_old_callbacks(transport, sk);
1864 sk->sk_user_data = xprt;
1865 sk->sk_data_ready = xs_data_ready;
1866 sk->sk_write_space = xs_udp_write_space;
1867 sock_set_flag(sk, SOCK_FASYNC);
1868 sk->sk_error_report = xs_error_report;
1870 xprt_clear_connected(xprt);
1872 /* Reset to new socket */
1873 transport->sock = sock;
1874 transport->inet = sk;
1876 write_unlock_bh(&sk->sk_callback_lock);
1879 xs_stream_start_connect(transport);
1881 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1885 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1886 * @transport: socket transport to connect
1888 static int xs_local_setup_socket(struct sock_xprt *transport)
1890 struct rpc_xprt *xprt = &transport->xprt;
1892 struct socket *sock;
1895 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1896 SOCK_STREAM, 0, &sock, 1);
1898 dprintk("RPC: can't create AF_LOCAL "
1899 "transport socket (%d).\n", -status);
1902 xs_reclassify_socket(AF_LOCAL, sock);
1904 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1906 status = PTR_ERR(filp);
1909 transport->file = filp;
1911 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1912 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1914 status = xs_local_finish_connecting(xprt, sock);
1915 trace_rpc_socket_connect(xprt, sock, status);
1918 dprintk("RPC: xprt %p connected to %s\n",
1919 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1920 xprt->stat.connect_count++;
1921 xprt->stat.connect_time += (long)jiffies -
1922 xprt->stat.connect_start;
1923 xprt_set_connected(xprt);
1928 dprintk("RPC: xprt %p: socket %s does not exist\n",
1929 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1932 dprintk("RPC: xprt %p: connection refused for %s\n",
1933 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1936 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1938 xprt->address_strings[RPC_DISPLAY_ADDR]);
1942 xprt_clear_connecting(xprt);
1943 xprt_wake_pending_tasks(xprt, status);
1947 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1949 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1952 if (RPC_IS_ASYNC(task)) {
1954 * We want the AF_LOCAL connect to be resolved in the
1955 * filesystem namespace of the process making the rpc
1956 * call. Thus we connect synchronously.
1958 * If we want to support asynchronous AF_LOCAL calls,
1959 * we'll need to figure out how to pass a namespace to
1962 task->tk_rpc_status = -ENOTCONN;
1963 rpc_exit(task, -ENOTCONN);
1966 ret = xs_local_setup_socket(transport);
1967 if (ret && !RPC_IS_SOFTCONN(task))
1968 msleep_interruptible(15000);
1971 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
1973 * Note that this should be called with XPRT_LOCKED held (or when we otherwise
1974 * know that we have exclusive access to the socket), to guard against
1975 * races with xs_reset_transport.
1977 static void xs_set_memalloc(struct rpc_xprt *xprt)
1979 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1983 * If there's no sock, then we have nothing to set. The
1984 * reconnecting process will get it for us.
1986 if (!transport->inet)
1988 if (atomic_read(&xprt->swapper))
1989 sk_set_memalloc(transport->inet);
1993 * xs_enable_swap - Tag this transport as being used for swap.
1994 * @xprt: transport to tag
1996 * Take a reference to this transport on behalf of the rpc_clnt, and
1997 * optionally mark it for swapping if it wasn't already.
2000 xs_enable_swap(struct rpc_xprt *xprt)
2002 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2004 if (atomic_inc_return(&xprt->swapper) != 1)
2006 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2007 return -ERESTARTSYS;
2009 sk_set_memalloc(xs->inet);
2010 xprt_release_xprt(xprt, NULL);
2015 * xs_disable_swap - Untag this transport as being used for swap.
2016 * @xprt: transport to tag
2018 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2019 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2022 xs_disable_swap(struct rpc_xprt *xprt)
2024 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2026 if (!atomic_dec_and_test(&xprt->swapper))
2028 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2031 sk_clear_memalloc(xs->inet);
2032 xprt_release_xprt(xprt, NULL);
2035 static void xs_set_memalloc(struct rpc_xprt *xprt)
2040 xs_enable_swap(struct rpc_xprt *xprt)
2046 xs_disable_swap(struct rpc_xprt *xprt)
2051 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2053 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2055 if (!transport->inet) {
2056 struct sock *sk = sock->sk;
2058 write_lock_bh(&sk->sk_callback_lock);
2060 xs_save_old_callbacks(transport, sk);
2062 sk->sk_user_data = xprt;
2063 sk->sk_data_ready = xs_data_ready;
2064 sk->sk_write_space = xs_udp_write_space;
2065 sock_set_flag(sk, SOCK_FASYNC);
2067 xprt_set_connected(xprt);
2069 /* Reset to new socket */
2070 transport->sock = sock;
2071 transport->inet = sk;
2073 xs_set_memalloc(xprt);
2075 write_unlock_bh(&sk->sk_callback_lock);
2077 xs_udp_do_set_buffer_size(xprt);
2079 xprt->stat.connect_start = jiffies;
2082 static void xs_udp_setup_socket(struct work_struct *work)
2084 struct sock_xprt *transport =
2085 container_of(work, struct sock_xprt, connect_worker.work);
2086 struct rpc_xprt *xprt = &transport->xprt;
2087 struct socket *sock;
2090 sock = xs_create_sock(xprt, transport,
2091 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2092 IPPROTO_UDP, false);
2096 dprintk("RPC: worker connecting xprt %p via %s to "
2097 "%s (port %s)\n", xprt,
2098 xprt->address_strings[RPC_DISPLAY_PROTO],
2099 xprt->address_strings[RPC_DISPLAY_ADDR],
2100 xprt->address_strings[RPC_DISPLAY_PORT]);
2102 xs_udp_finish_connecting(xprt, sock);
2103 trace_rpc_socket_connect(xprt, sock, 0);
2106 xprt_clear_connecting(xprt);
2107 xprt_unlock_connect(xprt, transport);
2108 xprt_wake_pending_tasks(xprt, status);
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);
2201 int ret = -ENOTCONN;
2203 if (!transport->inet) {
2204 struct sock *sk = sock->sk;
2206 /* Avoid temporary address, they are bad for long-lived
2207 * connections such as NFS mounts.
2208 * RFC4941, section 3.6 suggests that:
2209 * Individual applications, which have specific
2210 * knowledge about the normal duration of connections,
2211 * MAY override this as appropriate.
2213 if (xs_addr(xprt)->sa_family == PF_INET6) {
2214 ip6_sock_set_addr_preferences(sk,
2215 IPV6_PREFER_SRC_PUBLIC);
2218 xs_tcp_set_socket_timeouts(xprt, sock);
2219 tcp_sock_set_nodelay(sk);
2221 write_lock_bh(&sk->sk_callback_lock);
2223 xs_save_old_callbacks(transport, sk);
2225 sk->sk_user_data = xprt;
2226 sk->sk_data_ready = xs_data_ready;
2227 sk->sk_state_change = xs_tcp_state_change;
2228 sk->sk_write_space = xs_tcp_write_space;
2229 sock_set_flag(sk, SOCK_FASYNC);
2230 sk->sk_error_report = xs_error_report;
2232 /* socket options */
2233 sock_reset_flag(sk, SOCK_LINGER);
2235 xprt_clear_connected(xprt);
2237 /* Reset to new socket */
2238 transport->sock = sock;
2239 transport->inet = sk;
2241 write_unlock_bh(&sk->sk_callback_lock);
2244 if (!xprt_bound(xprt))
2247 xs_set_memalloc(xprt);
2249 xs_stream_start_connect(transport);
2251 /* Tell the socket layer to start connecting... */
2252 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2253 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2256 xs_set_srcport(transport, sock);
2260 set_bit(XPRT_SOCK_CONNECT_SENT, &transport->sock_state);
2261 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2262 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2264 case -EADDRNOTAVAIL:
2265 /* Source port number is unavailable. Try a new one! */
2266 transport->srcport = 0;
2273 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2274 * @work: queued work item
2276 * Invoked by a work queue tasklet.
2278 static void xs_tcp_setup_socket(struct work_struct *work)
2280 struct sock_xprt *transport =
2281 container_of(work, struct sock_xprt, connect_worker.work);
2282 struct socket *sock = transport->sock;
2283 struct rpc_xprt *xprt = &transport->xprt;
2286 if (xprt_connected(xprt))
2288 if (test_and_clear_bit(XPRT_SOCK_CONNECT_SENT,
2289 &transport->sock_state) ||
2291 xs_reset_transport(transport);
2292 sock = xs_create_sock(xprt, transport, xs_addr(xprt)->sa_family,
2293 SOCK_STREAM, IPPROTO_TCP, true);
2295 status = PTR_ERR(sock);
2300 dprintk("RPC: worker connecting xprt %p via %s to "
2301 "%s (port %s)\n", xprt,
2302 xprt->address_strings[RPC_DISPLAY_PROTO],
2303 xprt->address_strings[RPC_DISPLAY_ADDR],
2304 xprt->address_strings[RPC_DISPLAY_PORT]);
2306 status = xs_tcp_finish_connecting(xprt, sock);
2307 trace_rpc_socket_connect(xprt, sock, status);
2308 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2309 xprt, -status, xprt_connected(xprt),
2310 sock->sk->sk_state);
2313 printk("%s: connect returned unhandled error %d\n",
2316 case -EADDRNOTAVAIL:
2317 /* We're probably in TIME_WAIT. Get rid of existing socket,
2320 xs_tcp_force_close(xprt);
2325 xprt_unlock_connect(xprt, transport);
2328 /* Happens, for instance, if the user specified a link
2329 * local IPv6 address without a scope-id.
2338 /* xs_tcp_force_close() wakes tasks with a fixed error code.
2339 * We need to wake them first to ensure the correct error code.
2341 xprt_wake_pending_tasks(xprt, status);
2342 xs_tcp_force_close(xprt);
2347 xprt_clear_connecting(xprt);
2348 xprt_unlock_connect(xprt, transport);
2349 xprt_wake_pending_tasks(xprt, status);
2353 * xs_connect - connect a socket to a remote endpoint
2354 * @xprt: pointer to transport structure
2355 * @task: address of RPC task that manages state of connect request
2357 * TCP: If the remote end dropped the connection, delay reconnecting.
2359 * UDP socket connects are synchronous, but we use a work queue anyway
2360 * to guarantee that even unprivileged user processes can set up a
2361 * socket on a privileged port.
2363 * If a UDP socket connect fails, the delay behavior here prevents
2364 * retry floods (hard mounts).
2366 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2368 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2369 unsigned long delay = 0;
2371 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2373 if (transport->sock != NULL) {
2374 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2375 "seconds\n", xprt, xprt->reestablish_timeout / HZ);
2377 delay = xprt_reconnect_delay(xprt);
2378 xprt_reconnect_backoff(xprt, XS_TCP_INIT_REEST_TO);
2381 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2383 queue_delayed_work(xprtiod_workqueue,
2384 &transport->connect_worker,
2388 static void xs_wake_disconnect(struct sock_xprt *transport)
2390 if (test_and_clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state))
2391 xs_tcp_force_close(&transport->xprt);
2394 static void xs_wake_write(struct sock_xprt *transport)
2396 if (test_and_clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state))
2397 xprt_write_space(&transport->xprt);
2400 static void xs_wake_error(struct sock_xprt *transport)
2404 if (!test_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2406 mutex_lock(&transport->recv_mutex);
2407 if (transport->sock == NULL)
2409 if (!test_and_clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2411 sockerr = xchg(&transport->xprt_err, 0);
2413 xprt_wake_pending_tasks(&transport->xprt, sockerr);
2415 mutex_unlock(&transport->recv_mutex);
2418 static void xs_wake_pending(struct sock_xprt *transport)
2420 if (test_and_clear_bit(XPRT_SOCK_WAKE_PENDING, &transport->sock_state))
2421 xprt_wake_pending_tasks(&transport->xprt, -EAGAIN);
2424 static void xs_error_handle(struct work_struct *work)
2426 struct sock_xprt *transport = container_of(work,
2427 struct sock_xprt, error_worker);
2429 xs_wake_disconnect(transport);
2430 xs_wake_write(transport);
2431 xs_wake_error(transport);
2432 xs_wake_pending(transport);
2436 * xs_local_print_stats - display AF_LOCAL socket-specific stats
2437 * @xprt: rpc_xprt struct containing statistics
2441 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2445 if (xprt_connected(xprt))
2446 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2448 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2449 "%llu %llu %lu %llu %llu\n",
2450 xprt->stat.bind_count,
2451 xprt->stat.connect_count,
2452 xprt->stat.connect_time / HZ,
2456 xprt->stat.bad_xids,
2459 xprt->stat.max_slots,
2460 xprt->stat.sending_u,
2461 xprt->stat.pending_u);
2465 * xs_udp_print_stats - display UDP socket-specific stats
2466 * @xprt: rpc_xprt struct containing statistics
2470 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2472 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2474 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2477 xprt->stat.bind_count,
2480 xprt->stat.bad_xids,
2483 xprt->stat.max_slots,
2484 xprt->stat.sending_u,
2485 xprt->stat.pending_u);
2489 * xs_tcp_print_stats - display TCP socket-specific stats
2490 * @xprt: rpc_xprt struct containing statistics
2494 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2496 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2499 if (xprt_connected(xprt))
2500 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2502 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2503 "%llu %llu %lu %llu %llu\n",
2505 xprt->stat.bind_count,
2506 xprt->stat.connect_count,
2507 xprt->stat.connect_time / HZ,
2511 xprt->stat.bad_xids,
2514 xprt->stat.max_slots,
2515 xprt->stat.sending_u,
2516 xprt->stat.pending_u);
2520 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2521 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2522 * to use the server side send routines.
2524 static int bc_malloc(struct rpc_task *task)
2526 struct rpc_rqst *rqst = task->tk_rqstp;
2527 size_t size = rqst->rq_callsize;
2529 struct rpc_buffer *buf;
2531 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2532 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2537 page = alloc_page(GFP_KERNEL);
2541 buf = page_address(page);
2542 buf->len = PAGE_SIZE;
2544 rqst->rq_buffer = buf->data;
2545 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2550 * Free the space allocated in the bc_alloc routine
2552 static void bc_free(struct rpc_task *task)
2554 void *buffer = task->tk_rqstp->rq_buffer;
2555 struct rpc_buffer *buf;
2557 buf = container_of(buffer, struct rpc_buffer, data);
2558 free_page((unsigned long)buf);
2561 static int bc_sendto(struct rpc_rqst *req)
2563 struct xdr_buf *xdr = &req->rq_snd_buf;
2564 struct sock_xprt *transport =
2565 container_of(req->rq_xprt, struct sock_xprt, xprt);
2566 struct msghdr msg = {
2569 rpc_fraghdr marker = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT |
2571 unsigned int sent = 0;
2574 req->rq_xtime = ktime_get();
2575 err = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, marker, &sent);
2577 if (err < 0 || sent != (xdr->len + sizeof(marker)))
2583 * bc_send_request - Send a backchannel Call on a TCP socket
2584 * @req: rpc_rqst containing Call message to be sent
2586 * xpt_mutex ensures @rqstp's whole message is written to the socket
2587 * without interruption.
2590 * %0 if the message was sent successfully
2591 * %ENOTCONN if the message was not sent
2593 static int bc_send_request(struct rpc_rqst *req)
2595 struct svc_xprt *xprt;
2599 * Get the server socket associated with this callback xprt
2601 xprt = req->rq_xprt->bc_xprt;
2604 * Grab the mutex to serialize data as the connection is shared
2605 * with the fore channel
2607 mutex_lock(&xprt->xpt_mutex);
2608 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2611 len = bc_sendto(req);
2612 mutex_unlock(&xprt->xpt_mutex);
2621 * The close routine. Since this is client initiated, we do nothing
2624 static void bc_close(struct rpc_xprt *xprt)
2626 xprt_disconnect_done(xprt);
2630 * The xprt destroy routine. Again, because this connection is client
2631 * initiated, we do nothing
2634 static void bc_destroy(struct rpc_xprt *xprt)
2636 dprintk("RPC: bc_destroy xprt %p\n", xprt);
2639 module_put(THIS_MODULE);
2642 static const struct rpc_xprt_ops xs_local_ops = {
2643 .reserve_xprt = xprt_reserve_xprt,
2644 .release_xprt = xprt_release_xprt,
2645 .alloc_slot = xprt_alloc_slot,
2646 .free_slot = xprt_free_slot,
2647 .rpcbind = xs_local_rpcbind,
2648 .set_port = xs_local_set_port,
2649 .connect = xs_local_connect,
2650 .buf_alloc = rpc_malloc,
2651 .buf_free = rpc_free,
2652 .prepare_request = xs_stream_prepare_request,
2653 .send_request = xs_local_send_request,
2654 .wait_for_reply_request = xprt_wait_for_reply_request_def,
2656 .destroy = xs_destroy,
2657 .print_stats = xs_local_print_stats,
2658 .enable_swap = xs_enable_swap,
2659 .disable_swap = xs_disable_swap,
2662 static const struct rpc_xprt_ops xs_udp_ops = {
2663 .set_buffer_size = xs_udp_set_buffer_size,
2664 .reserve_xprt = xprt_reserve_xprt_cong,
2665 .release_xprt = xprt_release_xprt_cong,
2666 .alloc_slot = xprt_alloc_slot,
2667 .free_slot = xprt_free_slot,
2668 .rpcbind = rpcb_getport_async,
2669 .set_port = xs_set_port,
2670 .connect = xs_connect,
2671 .buf_alloc = rpc_malloc,
2672 .buf_free = rpc_free,
2673 .send_request = xs_udp_send_request,
2674 .wait_for_reply_request = xprt_wait_for_reply_request_rtt,
2675 .timer = xs_udp_timer,
2676 .release_request = xprt_release_rqst_cong,
2678 .destroy = xs_destroy,
2679 .print_stats = xs_udp_print_stats,
2680 .enable_swap = xs_enable_swap,
2681 .disable_swap = xs_disable_swap,
2682 .inject_disconnect = xs_inject_disconnect,
2685 static const struct rpc_xprt_ops xs_tcp_ops = {
2686 .reserve_xprt = xprt_reserve_xprt,
2687 .release_xprt = xprt_release_xprt,
2688 .alloc_slot = xprt_alloc_slot,
2689 .free_slot = xprt_free_slot,
2690 .rpcbind = rpcb_getport_async,
2691 .set_port = xs_set_port,
2692 .connect = xs_connect,
2693 .buf_alloc = rpc_malloc,
2694 .buf_free = rpc_free,
2695 .prepare_request = xs_stream_prepare_request,
2696 .send_request = xs_tcp_send_request,
2697 .wait_for_reply_request = xprt_wait_for_reply_request_def,
2698 .close = xs_tcp_shutdown,
2699 .destroy = xs_destroy,
2700 .set_connect_timeout = xs_tcp_set_connect_timeout,
2701 .print_stats = xs_tcp_print_stats,
2702 .enable_swap = xs_enable_swap,
2703 .disable_swap = xs_disable_swap,
2704 .inject_disconnect = xs_inject_disconnect,
2705 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2706 .bc_setup = xprt_setup_bc,
2707 .bc_maxpayload = xs_tcp_bc_maxpayload,
2708 .bc_num_slots = xprt_bc_max_slots,
2709 .bc_free_rqst = xprt_free_bc_rqst,
2710 .bc_destroy = xprt_destroy_bc,
2715 * The rpc_xprt_ops for the server backchannel
2718 static const struct rpc_xprt_ops bc_tcp_ops = {
2719 .reserve_xprt = xprt_reserve_xprt,
2720 .release_xprt = xprt_release_xprt,
2721 .alloc_slot = xprt_alloc_slot,
2722 .free_slot = xprt_free_slot,
2723 .buf_alloc = bc_malloc,
2724 .buf_free = bc_free,
2725 .send_request = bc_send_request,
2726 .wait_for_reply_request = xprt_wait_for_reply_request_def,
2728 .destroy = bc_destroy,
2729 .print_stats = xs_tcp_print_stats,
2730 .enable_swap = xs_enable_swap,
2731 .disable_swap = xs_disable_swap,
2732 .inject_disconnect = xs_inject_disconnect,
2735 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2737 static const struct sockaddr_in sin = {
2738 .sin_family = AF_INET,
2739 .sin_addr.s_addr = htonl(INADDR_ANY),
2741 static const struct sockaddr_in6 sin6 = {
2742 .sin6_family = AF_INET6,
2743 .sin6_addr = IN6ADDR_ANY_INIT,
2750 memcpy(sap, &sin, sizeof(sin));
2753 memcpy(sap, &sin6, sizeof(sin6));
2756 dprintk("RPC: %s: Bad address family\n", __func__);
2757 return -EAFNOSUPPORT;
2762 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2763 unsigned int slot_table_size,
2764 unsigned int max_slot_table_size)
2766 struct rpc_xprt *xprt;
2767 struct sock_xprt *new;
2769 if (args->addrlen > sizeof(xprt->addr)) {
2770 dprintk("RPC: xs_setup_xprt: address too large\n");
2771 return ERR_PTR(-EBADF);
2774 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2775 max_slot_table_size);
2777 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2779 return ERR_PTR(-ENOMEM);
2782 new = container_of(xprt, struct sock_xprt, xprt);
2783 mutex_init(&new->recv_mutex);
2784 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2785 xprt->addrlen = args->addrlen;
2787 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2790 err = xs_init_anyaddr(args->dstaddr->sa_family,
2791 (struct sockaddr *)&new->srcaddr);
2794 return ERR_PTR(err);
2801 static const struct rpc_timeout xs_local_default_timeout = {
2802 .to_initval = 10 * HZ,
2803 .to_maxval = 10 * HZ,
2808 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2809 * @args: rpc transport creation arguments
2811 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2813 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2815 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2816 struct sock_xprt *transport;
2817 struct rpc_xprt *xprt;
2818 struct rpc_xprt *ret;
2820 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2821 xprt_max_tcp_slot_table_entries);
2824 transport = container_of(xprt, struct sock_xprt, xprt);
2827 xprt->xprt_class = &xs_local_transport;
2828 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2830 xprt->bind_timeout = XS_BIND_TO;
2831 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2832 xprt->idle_timeout = XS_IDLE_DISC_TO;
2834 xprt->ops = &xs_local_ops;
2835 xprt->timeout = &xs_local_default_timeout;
2837 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2838 INIT_WORK(&transport->error_worker, xs_error_handle);
2839 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
2841 switch (sun->sun_family) {
2843 if (sun->sun_path[0] != '/') {
2844 dprintk("RPC: bad AF_LOCAL address: %s\n",
2846 ret = ERR_PTR(-EINVAL);
2849 xprt_set_bound(xprt);
2850 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
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);