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>
51 #include <net/handshake.h>
53 #include <linux/bvec.h>
54 #include <linux/highmem.h>
55 #include <linux/uio.h>
56 #include <linux/sched/mm.h>
58 #include <trace/events/sock.h>
59 #include <trace/events/sunrpc.h>
64 static void xs_close(struct rpc_xprt *xprt);
65 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock);
66 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
72 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
73 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
74 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
76 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
77 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
79 #define XS_TCP_LINGER_TO (15U * HZ)
80 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
83 * We can register our own files under /proc/sys/sunrpc by
84 * calling register_sysctl() again. The files in that
85 * directory become the union of all files registered there.
87 * We simply need to make sure that we don't collide with
88 * someone else's file names!
91 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
92 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
93 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
94 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
95 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
97 static struct ctl_table_header *sunrpc_table_header;
99 static struct xprt_class xs_local_transport;
100 static struct xprt_class xs_udp_transport;
101 static struct xprt_class xs_tcp_transport;
102 static struct xprt_class xs_tcp_tls_transport;
103 static struct xprt_class xs_bc_tcp_transport;
106 * FIXME: changing the UDP slot table size should also resize the UDP
107 * socket buffers for existing UDP transports
109 static struct ctl_table xs_tunables_table[] = {
111 .procname = "udp_slot_table_entries",
112 .data = &xprt_udp_slot_table_entries,
113 .maxlen = sizeof(unsigned int),
115 .proc_handler = proc_dointvec_minmax,
116 .extra1 = &min_slot_table_size,
117 .extra2 = &max_slot_table_size
120 .procname = "tcp_slot_table_entries",
121 .data = &xprt_tcp_slot_table_entries,
122 .maxlen = sizeof(unsigned int),
124 .proc_handler = proc_dointvec_minmax,
125 .extra1 = &min_slot_table_size,
126 .extra2 = &max_slot_table_size
129 .procname = "tcp_max_slot_table_entries",
130 .data = &xprt_max_tcp_slot_table_entries,
131 .maxlen = sizeof(unsigned int),
133 .proc_handler = proc_dointvec_minmax,
134 .extra1 = &min_slot_table_size,
135 .extra2 = &max_tcp_slot_table_limit
138 .procname = "min_resvport",
139 .data = &xprt_min_resvport,
140 .maxlen = sizeof(unsigned int),
142 .proc_handler = proc_dointvec_minmax,
143 .extra1 = &xprt_min_resvport_limit,
144 .extra2 = &xprt_max_resvport_limit
147 .procname = "max_resvport",
148 .data = &xprt_max_resvport,
149 .maxlen = sizeof(unsigned int),
151 .proc_handler = proc_dointvec_minmax,
152 .extra1 = &xprt_min_resvport_limit,
153 .extra2 = &xprt_max_resvport_limit
156 .procname = "tcp_fin_timeout",
157 .data = &xs_tcp_fin_timeout,
158 .maxlen = sizeof(xs_tcp_fin_timeout),
160 .proc_handler = proc_dointvec_jiffies,
166 * Wait duration for a reply from the RPC portmapper.
168 #define XS_BIND_TO (60U * HZ)
171 * Delay if a UDP socket connect error occurs. This is most likely some
172 * kind of resource problem on the local host.
174 #define XS_UDP_REEST_TO (2U * HZ)
177 * The reestablish timeout allows clients to delay for a bit before attempting
178 * to reconnect to a server that just dropped our connection.
180 * We implement an exponential backoff when trying to reestablish a TCP
181 * transport connection with the server. Some servers like to drop a TCP
182 * connection when they are overworked, so we start with a short timeout and
183 * increase over time if the server is down or not responding.
185 #define XS_TCP_INIT_REEST_TO (3U * HZ)
188 * TCP idle timeout; client drops the transport socket if it is idle
189 * for this long. Note that we also timeout UDP sockets to prevent
190 * holding port numbers when there is no RPC traffic.
192 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
195 * TLS handshake timeout.
197 #define XS_TLS_HANDSHAKE_TO (10U * HZ)
199 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
200 # undef RPC_DEBUG_DATA
201 # define RPCDBG_FACILITY RPCDBG_TRANS
204 #ifdef RPC_DEBUG_DATA
205 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
207 u8 *buf = (u8 *) packet;
210 dprintk("RPC: %s\n", msg);
211 for (j = 0; j < count && j < 128; j += 4) {
215 dprintk("0x%04x ", j);
217 dprintk("%02x%02x%02x%02x ",
218 buf[j], buf[j+1], buf[j+2], buf[j+3]);
223 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
229 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
231 return (struct rpc_xprt *) sk->sk_user_data;
234 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
236 return (struct sockaddr *) &xprt->addr;
239 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
241 return (struct sockaddr_un *) &xprt->addr;
244 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
246 return (struct sockaddr_in *) &xprt->addr;
249 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
251 return (struct sockaddr_in6 *) &xprt->addr;
254 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
256 struct sockaddr *sap = xs_addr(xprt);
257 struct sockaddr_in6 *sin6;
258 struct sockaddr_in *sin;
259 struct sockaddr_un *sun;
262 switch (sap->sa_family) {
264 sun = xs_addr_un(xprt);
265 if (sun->sun_path[0]) {
266 strscpy(buf, sun->sun_path, sizeof(buf));
269 strscpy(buf+1, sun->sun_path+1, sizeof(buf)-1);
271 xprt->address_strings[RPC_DISPLAY_ADDR] =
272 kstrdup(buf, GFP_KERNEL);
275 (void)rpc_ntop(sap, buf, sizeof(buf));
276 xprt->address_strings[RPC_DISPLAY_ADDR] =
277 kstrdup(buf, GFP_KERNEL);
278 sin = xs_addr_in(xprt);
279 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
282 (void)rpc_ntop(sap, buf, sizeof(buf));
283 xprt->address_strings[RPC_DISPLAY_ADDR] =
284 kstrdup(buf, GFP_KERNEL);
285 sin6 = xs_addr_in6(xprt);
286 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
292 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
295 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
297 struct sockaddr *sap = xs_addr(xprt);
300 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
301 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
303 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
304 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
307 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
308 const char *protocol,
311 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
312 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
313 xs_format_common_peer_addresses(xprt);
314 xs_format_common_peer_ports(xprt);
317 static void xs_update_peer_port(struct rpc_xprt *xprt)
319 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
320 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
322 xs_format_common_peer_ports(xprt);
325 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
329 for (i = 0; i < RPC_DISPLAY_MAX; i++)
331 case RPC_DISPLAY_PROTO:
332 case RPC_DISPLAY_NETID:
335 kfree(xprt->address_strings[i]);
340 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp)
344 if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES))
346 n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT;
347 for (i = 0; i < n; i++) {
350 buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp);
351 if (!buf->pages[i]) {
353 return i > buf->page_base ? i - buf->page_base : 0;
360 xs_sock_process_cmsg(struct socket *sock, struct msghdr *msg,
361 struct cmsghdr *cmsg, int ret)
363 if (cmsg->cmsg_level == SOL_TLS &&
364 cmsg->cmsg_type == TLS_GET_RECORD_TYPE) {
365 u8 content_type = *((u8 *)CMSG_DATA(cmsg));
367 switch (content_type) {
368 case TLS_RECORD_TYPE_DATA:
369 /* TLS sets EOR at the end of each application data
370 * record, even though there might be more frames
371 * waiting to be decrypted.
373 msg->msg_flags &= ~MSG_EOR;
375 case TLS_RECORD_TYPE_ALERT:
386 xs_sock_recv_cmsg(struct socket *sock, struct msghdr *msg, int flags)
390 u8 buf[CMSG_SPACE(sizeof(u8))];
394 msg->msg_control = &u;
395 msg->msg_controllen = sizeof(u);
396 ret = sock_recvmsg(sock, msg, flags);
397 if (msg->msg_controllen != sizeof(u))
398 ret = xs_sock_process_cmsg(sock, msg, &u.cmsg, ret);
403 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek)
407 iov_iter_advance(&msg->msg_iter, seek);
408 ret = xs_sock_recv_cmsg(sock, msg, flags);
409 return ret > 0 ? ret + seek : ret;
413 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags,
414 struct kvec *kvec, size_t count, size_t seek)
416 iov_iter_kvec(&msg->msg_iter, ITER_DEST, kvec, 1, count);
417 return xs_sock_recvmsg(sock, msg, flags, seek);
421 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags,
422 struct bio_vec *bvec, unsigned long nr, size_t count,
425 iov_iter_bvec(&msg->msg_iter, ITER_DEST, bvec, nr, count);
426 return xs_sock_recvmsg(sock, msg, flags, seek);
430 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags,
433 iov_iter_discard(&msg->msg_iter, ITER_DEST, count);
434 return xs_sock_recv_cmsg(sock, msg, flags);
437 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
439 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
441 struct bvec_iter bi = {
446 bvec_iter_advance(bvec, &bi, seek & PAGE_MASK);
447 for_each_bvec(bv, bvec, bi, bi)
448 flush_dcache_page(bv.bv_page);
452 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
458 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags,
459 struct xdr_buf *buf, size_t count, size_t seek, size_t *read)
461 size_t want, seek_init = seek, offset = 0;
464 want = min_t(size_t, count, buf->head[0].iov_len);
466 ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek);
470 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
480 want = xs_alloc_sparse_pages(
481 buf, min_t(size_t, count - offset, buf->page_len),
482 GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN);
484 ret = xs_read_bvec(sock, msg, flags, buf->bvec,
485 xdr_buf_pagecount(buf),
486 want + buf->page_base,
487 seek + buf->page_base);
490 xs_flush_bvec(buf->bvec, ret, seek + buf->page_base);
491 ret -= buf->page_base;
493 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
503 want = min_t(size_t, count - offset, buf->tail[0].iov_len);
505 ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek);
509 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
513 } else if (offset < seek_init)
517 *read = offset - seek_init;
525 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf)
527 if (!transport->recv.copied) {
528 if (buf->head[0].iov_len >= transport->recv.offset)
529 memcpy(buf->head[0].iov_base,
530 &transport->recv.xid,
531 transport->recv.offset);
532 transport->recv.copied = transport->recv.offset;
537 xs_read_stream_request_done(struct sock_xprt *transport)
539 return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT);
543 xs_read_stream_check_eor(struct sock_xprt *transport,
546 if (xs_read_stream_request_done(transport))
547 msg->msg_flags |= MSG_EOR;
551 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg,
552 int flags, struct rpc_rqst *req)
554 struct xdr_buf *buf = &req->rq_private_buf;
558 xs_read_header(transport, buf);
560 want = transport->recv.len - transport->recv.offset;
562 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
563 transport->recv.copied + want,
564 transport->recv.copied,
566 transport->recv.offset += read;
567 transport->recv.copied += read;
570 if (transport->recv.offset == transport->recv.len)
571 xs_read_stream_check_eor(transport, msg);
581 msg->msg_flags |= MSG_TRUNC;
586 return ret < 0 ? ret : read;
590 xs_read_stream_headersize(bool isfrag)
593 return sizeof(__be32);
594 return 3 * sizeof(__be32);
598 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
599 int flags, size_t want, size_t seek)
602 .iov_base = &transport->recv.fraghdr,
605 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
608 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
610 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
612 struct rpc_xprt *xprt = &transport->xprt;
613 struct rpc_rqst *req;
616 /* Is this transport associated with the backchannel? */
620 /* Look up and lock the request corresponding to the given XID */
621 req = xprt_lookup_bc_request(xprt, transport->recv.xid);
623 printk(KERN_WARNING "Callback slot table overflowed\n");
626 if (transport->recv.copied && !req->rq_private_buf.len)
629 ret = xs_read_stream_request(transport, msg, flags, req);
630 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
631 xprt_complete_bc_request(req, transport->recv.copied);
633 req->rq_private_buf.len = transport->recv.copied;
637 #else /* CONFIG_SUNRPC_BACKCHANNEL */
639 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
643 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
646 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
648 struct rpc_xprt *xprt = &transport->xprt;
649 struct rpc_rqst *req;
652 /* Look up and lock the request corresponding to the given XID */
653 spin_lock(&xprt->queue_lock);
654 req = xprt_lookup_rqst(xprt, transport->recv.xid);
655 if (!req || (transport->recv.copied && !req->rq_private_buf.len)) {
656 msg->msg_flags |= MSG_TRUNC;
660 spin_unlock(&xprt->queue_lock);
662 ret = xs_read_stream_request(transport, msg, flags, req);
664 spin_lock(&xprt->queue_lock);
665 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
666 xprt_complete_rqst(req->rq_task, transport->recv.copied);
668 req->rq_private_buf.len = transport->recv.copied;
669 xprt_unpin_rqst(req);
671 spin_unlock(&xprt->queue_lock);
676 xs_read_stream(struct sock_xprt *transport, int flags)
678 struct msghdr msg = { 0 };
679 size_t want, read = 0;
682 if (transport->recv.len == 0) {
683 want = xs_read_stream_headersize(transport->recv.copied != 0);
684 ret = xs_read_stream_header(transport, &msg, flags, want,
685 transport->recv.offset);
688 transport->recv.offset = ret;
689 if (transport->recv.offset != want)
690 return transport->recv.offset;
691 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
692 RPC_FRAGMENT_SIZE_MASK;
693 transport->recv.offset -= sizeof(transport->recv.fraghdr);
697 switch (be32_to_cpu(transport->recv.calldir)) {
699 msg.msg_flags |= MSG_TRUNC;
702 ret = xs_read_stream_call(transport, &msg, flags);
705 ret = xs_read_stream_reply(transport, &msg, flags);
707 if (msg.msg_flags & MSG_TRUNC) {
708 transport->recv.calldir = cpu_to_be32(-1);
709 transport->recv.copied = -1;
714 if (transport->recv.offset < transport->recv.len) {
715 if (!(msg.msg_flags & MSG_TRUNC))
718 ret = xs_read_discard(transport->sock, &msg, flags,
719 transport->recv.len - transport->recv.offset);
722 transport->recv.offset += ret;
724 if (transport->recv.offset != transport->recv.len)
727 if (xs_read_stream_request_done(transport)) {
728 trace_xs_stream_read_request(transport);
729 transport->recv.copied = 0;
731 transport->recv.offset = 0;
732 transport->recv.len = 0;
735 return ret != 0 ? ret : -ESHUTDOWN;
738 static __poll_t xs_poll_socket(struct sock_xprt *transport)
740 return transport->sock->ops->poll(transport->file, transport->sock,
744 static bool xs_poll_socket_readable(struct sock_xprt *transport)
746 __poll_t events = xs_poll_socket(transport);
748 return (events & (EPOLLIN | EPOLLRDNORM)) && !(events & EPOLLRDHUP);
751 static void xs_poll_check_readable(struct sock_xprt *transport)
754 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
755 if (test_bit(XPRT_SOCK_IGNORE_RECV, &transport->sock_state))
757 if (!xs_poll_socket_readable(transport))
759 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
760 queue_work(xprtiod_workqueue, &transport->recv_worker);
763 static void xs_stream_data_receive(struct sock_xprt *transport)
768 mutex_lock(&transport->recv_mutex);
769 if (transport->sock == NULL)
772 ret = xs_read_stream(transport, MSG_DONTWAIT);
778 if (ret == -ESHUTDOWN)
779 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
781 xs_poll_check_readable(transport);
783 mutex_unlock(&transport->recv_mutex);
784 trace_xs_stream_read_data(&transport->xprt, ret, read);
787 static void xs_stream_data_receive_workfn(struct work_struct *work)
789 struct sock_xprt *transport =
790 container_of(work, struct sock_xprt, recv_worker);
791 unsigned int pflags = memalloc_nofs_save();
793 xs_stream_data_receive(transport);
794 memalloc_nofs_restore(pflags);
798 xs_stream_reset_connect(struct sock_xprt *transport)
800 transport->recv.offset = 0;
801 transport->recv.len = 0;
802 transport->recv.copied = 0;
803 transport->xmit.offset = 0;
807 xs_stream_start_connect(struct sock_xprt *transport)
809 transport->xprt.stat.connect_count++;
810 transport->xprt.stat.connect_start = jiffies;
813 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
816 * xs_nospace - handle transmit was incomplete
817 * @req: pointer to RPC request
818 * @transport: pointer to struct sock_xprt
821 static int xs_nospace(struct rpc_rqst *req, struct sock_xprt *transport)
823 struct rpc_xprt *xprt = &transport->xprt;
824 struct sock *sk = transport->inet;
827 trace_rpc_socket_nospace(req, transport);
829 /* Protect against races with write_space */
830 spin_lock(&xprt->transport_lock);
832 /* Don't race with disconnect */
833 if (xprt_connected(xprt)) {
834 /* wait for more buffer space */
835 set_bit(XPRT_SOCK_NOSPACE, &transport->sock_state);
836 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
837 sk->sk_write_pending++;
838 xprt_wait_for_buffer_space(xprt);
842 spin_unlock(&xprt->transport_lock);
846 static int xs_sock_nospace(struct rpc_rqst *req)
848 struct sock_xprt *transport =
849 container_of(req->rq_xprt, struct sock_xprt, xprt);
850 struct sock *sk = transport->inet;
854 if (!sock_writeable(sk))
855 ret = xs_nospace(req, transport);
860 static int xs_stream_nospace(struct rpc_rqst *req, bool vm_wait)
862 struct sock_xprt *transport =
863 container_of(req->rq_xprt, struct sock_xprt, xprt);
864 struct sock *sk = transport->inet;
870 if (!sk_stream_memory_free(sk))
871 ret = xs_nospace(req, transport);
876 static int xs_stream_prepare_request(struct rpc_rqst *req, struct xdr_buf *buf)
878 return xdr_alloc_bvec(buf, rpc_task_gfp_mask());
882 * Determine if the previous message in the stream was aborted before it
883 * could complete transmission.
886 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
888 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
892 * Return the stream record marker field for a record of length < 2^31-1
895 xs_stream_record_marker(struct xdr_buf *xdr)
899 return cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | (u32)xdr->len);
903 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
904 * @req: pointer to RPC request
907 * 0: The request has been sent
908 * EAGAIN: The socket was blocked, please call again later to
909 * complete the request
910 * ENOTCONN: Caller needs to invoke connect logic then call again
911 * other: Some other error occurred, the request was not sent
913 static int xs_local_send_request(struct rpc_rqst *req)
915 struct rpc_xprt *xprt = req->rq_xprt;
916 struct sock_xprt *transport =
917 container_of(xprt, struct sock_xprt, xprt);
918 struct xdr_buf *xdr = &req->rq_snd_buf;
919 rpc_fraghdr rm = xs_stream_record_marker(xdr);
920 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
921 struct msghdr msg = {
922 .msg_flags = XS_SENDMSG_FLAGS,
928 /* Close the stream if the previous transmission was incomplete */
929 if (xs_send_request_was_aborted(transport, req)) {
930 xprt_force_disconnect(xprt);
934 xs_pktdump("packet data:",
935 req->rq_svec->iov_base, req->rq_svec->iov_len);
937 vm_wait = sk_stream_is_writeable(transport->inet) ? true : false;
939 req->rq_xtime = ktime_get();
940 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
941 transport->xmit.offset, rm, &sent);
942 dprintk("RPC: %s(%u) = %d\n",
943 __func__, xdr->len - transport->xmit.offset, status);
945 if (likely(sent > 0) || status == 0) {
946 transport->xmit.offset += sent;
947 req->rq_bytes_sent = transport->xmit.offset;
948 if (likely(req->rq_bytes_sent >= msglen)) {
949 req->rq_xmit_bytes_sent += transport->xmit.offset;
950 transport->xmit.offset = 0;
959 status = xs_stream_nospace(req, vm_wait);
962 dprintk("RPC: sendmsg returned unrecognized error %d\n",
966 xprt_force_disconnect(xprt);
974 * xs_udp_send_request - write an RPC request to a UDP socket
975 * @req: pointer to RPC request
978 * 0: The request has been sent
979 * EAGAIN: The socket was blocked, please call again later to
980 * complete the request
981 * ENOTCONN: Caller needs to invoke connect logic then call again
982 * other: Some other error occurred, the request was not sent
984 static int xs_udp_send_request(struct rpc_rqst *req)
986 struct rpc_xprt *xprt = req->rq_xprt;
987 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
988 struct xdr_buf *xdr = &req->rq_snd_buf;
989 struct msghdr msg = {
990 .msg_name = xs_addr(xprt),
991 .msg_namelen = xprt->addrlen,
992 .msg_flags = XS_SENDMSG_FLAGS,
997 xs_pktdump("packet data:",
998 req->rq_svec->iov_base,
999 req->rq_svec->iov_len);
1001 if (!xprt_bound(xprt))
1004 if (!xprt_request_get_cong(xprt, req))
1007 status = xdr_alloc_bvec(xdr, rpc_task_gfp_mask());
1010 req->rq_xtime = ktime_get();
1011 status = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, 0, &sent);
1013 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
1016 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
1017 if (status == -EPERM)
1018 goto process_status;
1020 if (status == -EAGAIN && sock_writeable(transport->inet))
1023 if (sent > 0 || status == 0) {
1024 req->rq_xmit_bytes_sent += sent;
1025 if (sent >= req->rq_slen)
1027 /* Still some bytes left; set up for a retry later. */
1035 /* Should we call xs_close() here? */
1038 status = xs_sock_nospace(req);
1045 /* When the server has died, an ICMP port unreachable message
1046 * prompts ECONNREFUSED. */
1049 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1057 * xs_tcp_send_request - write an RPC request to a TCP socket
1058 * @req: pointer to RPC request
1061 * 0: The request has been sent
1062 * EAGAIN: The socket was blocked, please call again later to
1063 * complete the request
1064 * ENOTCONN: Caller needs to invoke connect logic then call again
1065 * other: Some other error occurred, the request was not sent
1067 * XXX: In the case of soft timeouts, should we eventually give up
1068 * if sendmsg is not able to make progress?
1070 static int xs_tcp_send_request(struct rpc_rqst *req)
1072 struct rpc_xprt *xprt = req->rq_xprt;
1073 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1074 struct xdr_buf *xdr = &req->rq_snd_buf;
1075 rpc_fraghdr rm = xs_stream_record_marker(xdr);
1076 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
1077 struct msghdr msg = {
1078 .msg_flags = XS_SENDMSG_FLAGS,
1084 /* Close the stream if the previous transmission was incomplete */
1085 if (xs_send_request_was_aborted(transport, req)) {
1086 if (transport->sock != NULL)
1087 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1090 if (!transport->inet)
1093 xs_pktdump("packet data:",
1094 req->rq_svec->iov_base,
1095 req->rq_svec->iov_len);
1097 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1098 xs_tcp_set_socket_timeouts(xprt, transport->sock);
1100 xs_set_srcport(transport, transport->sock);
1102 /* Continue transmitting the packet/record. We must be careful
1103 * to cope with writespace callbacks arriving _after_ we have
1104 * called sendmsg(). */
1105 req->rq_xtime = ktime_get();
1106 tcp_sock_set_cork(transport->inet, true);
1108 vm_wait = sk_stream_is_writeable(transport->inet) ? true : false;
1111 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
1112 transport->xmit.offset, rm, &sent);
1114 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
1115 xdr->len - transport->xmit.offset, status);
1117 /* If we've sent the entire packet, immediately
1118 * reset the count of bytes sent. */
1119 transport->xmit.offset += sent;
1120 req->rq_bytes_sent = transport->xmit.offset;
1121 if (likely(req->rq_bytes_sent >= msglen)) {
1122 req->rq_xmit_bytes_sent += transport->xmit.offset;
1123 transport->xmit.offset = 0;
1124 if (atomic_long_read(&xprt->xmit_queuelen) == 1)
1125 tcp_sock_set_cork(transport->inet, false);
1129 WARN_ON_ONCE(sent == 0 && status == 0);
1134 } while (status == 0);
1139 /* Should we call xs_close() here? */
1142 status = xs_stream_nospace(req, vm_wait);
1152 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1159 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1161 transport->old_data_ready = sk->sk_data_ready;
1162 transport->old_state_change = sk->sk_state_change;
1163 transport->old_write_space = sk->sk_write_space;
1164 transport->old_error_report = sk->sk_error_report;
1167 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1169 sk->sk_data_ready = transport->old_data_ready;
1170 sk->sk_state_change = transport->old_state_change;
1171 sk->sk_write_space = transport->old_write_space;
1172 sk->sk_error_report = transport->old_error_report;
1175 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1177 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1179 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1180 clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state);
1181 clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state);
1182 clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state);
1183 clear_bit(XPRT_SOCK_NOSPACE, &transport->sock_state);
1186 static void xs_run_error_worker(struct sock_xprt *transport, unsigned int nr)
1188 set_bit(nr, &transport->sock_state);
1189 queue_work(xprtiod_workqueue, &transport->error_worker);
1192 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1194 xprt->connect_cookie++;
1195 smp_mb__before_atomic();
1196 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1197 clear_bit(XPRT_CLOSING, &xprt->state);
1198 xs_sock_reset_state_flags(xprt);
1199 smp_mb__after_atomic();
1203 * xs_error_report - callback to handle TCP socket state errors
1206 * Note: we don't call sock_error() since there may be a rpc_task
1207 * using the socket, and so we don't want to clear sk->sk_err.
1209 static void xs_error_report(struct sock *sk)
1211 struct sock_xprt *transport;
1212 struct rpc_xprt *xprt;
1214 if (!(xprt = xprt_from_sock(sk)))
1217 transport = container_of(xprt, struct sock_xprt, xprt);
1218 transport->xprt_err = -sk->sk_err;
1219 if (transport->xprt_err == 0)
1221 dprintk("RPC: xs_error_report client %p, error=%d...\n",
1222 xprt, -transport->xprt_err);
1223 trace_rpc_socket_error(xprt, sk->sk_socket, transport->xprt_err);
1225 /* barrier ensures xprt_err is set before XPRT_SOCK_WAKE_ERROR */
1226 smp_mb__before_atomic();
1227 xs_run_error_worker(transport, XPRT_SOCK_WAKE_ERROR);
1230 static void xs_reset_transport(struct sock_xprt *transport)
1232 struct socket *sock = transport->sock;
1233 struct sock *sk = transport->inet;
1234 struct rpc_xprt *xprt = &transport->xprt;
1235 struct file *filp = transport->file;
1240 * Make sure we're calling this in a context from which it is safe
1241 * to call __fput_sync(). In practice that means rpciod and the
1244 if (!(current->flags & PF_WQ_WORKER)) {
1246 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
1250 if (atomic_read(&transport->xprt.swapper))
1251 sk_clear_memalloc(sk);
1253 tls_handshake_cancel(sk);
1255 kernel_sock_shutdown(sock, SHUT_RDWR);
1257 mutex_lock(&transport->recv_mutex);
1259 transport->inet = NULL;
1260 transport->sock = NULL;
1261 transport->file = NULL;
1263 sk->sk_user_data = NULL;
1265 xs_restore_old_callbacks(transport, sk);
1266 xprt_clear_connected(xprt);
1267 xs_sock_reset_connection_flags(xprt);
1268 /* Reset stream record info */
1269 xs_stream_reset_connect(transport);
1271 mutex_unlock(&transport->recv_mutex);
1273 trace_rpc_socket_close(xprt, sock);
1276 xprt_disconnect_done(xprt);
1280 * xs_close - close a socket
1283 * This is used when all requests are complete; ie, no DRC state remains
1284 * on the server we want to save.
1286 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1287 * xs_reset_transport() zeroing the socket from underneath a writer.
1289 static void xs_close(struct rpc_xprt *xprt)
1291 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1293 dprintk("RPC: xs_close xprt %p\n", xprt);
1295 xs_reset_transport(transport);
1296 xprt->reestablish_timeout = 0;
1299 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1301 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
1303 xprt_disconnect_done(xprt);
1306 static void xs_xprt_free(struct rpc_xprt *xprt)
1308 xs_free_peer_addresses(xprt);
1313 * xs_destroy - prepare to shutdown a transport
1314 * @xprt: doomed transport
1317 static void xs_destroy(struct rpc_xprt *xprt)
1319 struct sock_xprt *transport = container_of(xprt,
1320 struct sock_xprt, xprt);
1321 dprintk("RPC: xs_destroy xprt %p\n", xprt);
1323 cancel_delayed_work_sync(&transport->connect_worker);
1325 cancel_work_sync(&transport->recv_worker);
1326 cancel_work_sync(&transport->error_worker);
1328 module_put(THIS_MODULE);
1332 * xs_udp_data_read_skb - receive callback for UDP sockets
1338 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1340 struct sk_buff *skb)
1342 struct rpc_task *task;
1343 struct rpc_rqst *rovr;
1344 int repsize, copied;
1350 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1354 /* Copy the XID from the skb... */
1355 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1359 /* Look up and lock the request corresponding to the given XID */
1360 spin_lock(&xprt->queue_lock);
1361 rovr = xprt_lookup_rqst(xprt, *xp);
1364 xprt_pin_rqst(rovr);
1365 xprt_update_rtt(rovr->rq_task);
1366 spin_unlock(&xprt->queue_lock);
1367 task = rovr->rq_task;
1369 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1372 /* Suck it into the iovec, verify checksum if not done by hw. */
1373 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1374 spin_lock(&xprt->queue_lock);
1375 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1380 spin_lock(&xprt->transport_lock);
1381 xprt_adjust_cwnd(xprt, task, copied);
1382 spin_unlock(&xprt->transport_lock);
1383 spin_lock(&xprt->queue_lock);
1384 xprt_complete_rqst(task, copied);
1385 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1387 xprt_unpin_rqst(rovr);
1389 spin_unlock(&xprt->queue_lock);
1392 static void xs_udp_data_receive(struct sock_xprt *transport)
1394 struct sk_buff *skb;
1398 mutex_lock(&transport->recv_mutex);
1399 sk = transport->inet;
1403 skb = skb_recv_udp(sk, MSG_DONTWAIT, &err);
1406 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1410 xs_poll_check_readable(transport);
1412 mutex_unlock(&transport->recv_mutex);
1415 static void xs_udp_data_receive_workfn(struct work_struct *work)
1417 struct sock_xprt *transport =
1418 container_of(work, struct sock_xprt, recv_worker);
1419 unsigned int pflags = memalloc_nofs_save();
1421 xs_udp_data_receive(transport);
1422 memalloc_nofs_restore(pflags);
1426 * xs_data_ready - "data ready" callback for sockets
1427 * @sk: socket with data to read
1430 static void xs_data_ready(struct sock *sk)
1432 struct rpc_xprt *xprt;
1434 trace_sk_data_ready(sk);
1436 xprt = xprt_from_sock(sk);
1438 struct sock_xprt *transport = container_of(xprt,
1439 struct sock_xprt, xprt);
1441 trace_xs_data_ready(xprt);
1443 transport->old_data_ready(sk);
1445 if (test_bit(XPRT_SOCK_IGNORE_RECV, &transport->sock_state))
1448 /* Any data means we had a useful conversation, so
1449 * then we don't need to delay the next reconnect
1451 if (xprt->reestablish_timeout)
1452 xprt->reestablish_timeout = 0;
1453 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1454 queue_work(xprtiod_workqueue, &transport->recv_worker);
1459 * Helper function to force a TCP close if the server is sending
1460 * junk and/or it has put us in CLOSE_WAIT
1462 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1464 xprt_force_disconnect(xprt);
1467 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1468 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1472 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1475 * xs_local_state_change - callback to handle AF_LOCAL socket state changes
1476 * @sk: socket whose state has changed
1479 static void xs_local_state_change(struct sock *sk)
1481 struct rpc_xprt *xprt;
1482 struct sock_xprt *transport;
1484 if (!(xprt = xprt_from_sock(sk)))
1486 transport = container_of(xprt, struct sock_xprt, xprt);
1487 if (sk->sk_shutdown & SHUTDOWN_MASK) {
1488 clear_bit(XPRT_CONNECTED, &xprt->state);
1489 /* Trigger the socket release */
1490 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1495 * xs_tcp_state_change - callback to handle TCP socket state changes
1496 * @sk: socket whose state has changed
1499 static void xs_tcp_state_change(struct sock *sk)
1501 struct rpc_xprt *xprt;
1502 struct sock_xprt *transport;
1504 if (!(xprt = xprt_from_sock(sk)))
1506 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1507 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1508 sk->sk_state, xprt_connected(xprt),
1509 sock_flag(sk, SOCK_DEAD),
1510 sock_flag(sk, SOCK_ZAPPED),
1513 transport = container_of(xprt, struct sock_xprt, xprt);
1514 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1515 switch (sk->sk_state) {
1516 case TCP_ESTABLISHED:
1517 if (!xprt_test_and_set_connected(xprt)) {
1518 xprt->connect_cookie++;
1519 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1520 xprt_clear_connecting(xprt);
1522 xprt->stat.connect_count++;
1523 xprt->stat.connect_time += (long)jiffies -
1524 xprt->stat.connect_start;
1525 xs_run_error_worker(transport, XPRT_SOCK_WAKE_PENDING);
1529 /* The client initiated a shutdown of the socket */
1530 xprt->connect_cookie++;
1531 xprt->reestablish_timeout = 0;
1532 set_bit(XPRT_CLOSING, &xprt->state);
1533 smp_mb__before_atomic();
1534 clear_bit(XPRT_CONNECTED, &xprt->state);
1535 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1536 smp_mb__after_atomic();
1538 case TCP_CLOSE_WAIT:
1539 /* The server initiated a shutdown of the socket */
1540 xprt->connect_cookie++;
1541 clear_bit(XPRT_CONNECTED, &xprt->state);
1542 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1546 * If the server closed down the connection, make sure that
1547 * we back off before reconnecting
1549 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1550 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1553 set_bit(XPRT_CLOSING, &xprt->state);
1554 smp_mb__before_atomic();
1555 clear_bit(XPRT_CONNECTED, &xprt->state);
1556 smp_mb__after_atomic();
1559 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1560 &transport->sock_state))
1561 xprt_clear_connecting(xprt);
1562 clear_bit(XPRT_CLOSING, &xprt->state);
1563 /* Trigger the socket release */
1564 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1568 static void xs_write_space(struct sock *sk)
1570 struct sock_xprt *transport;
1571 struct rpc_xprt *xprt;
1575 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1577 if (unlikely(!(xprt = xprt_from_sock(sk))))
1579 transport = container_of(xprt, struct sock_xprt, xprt);
1580 if (!test_and_clear_bit(XPRT_SOCK_NOSPACE, &transport->sock_state))
1582 xs_run_error_worker(transport, XPRT_SOCK_WAKE_WRITE);
1583 sk->sk_write_pending--;
1587 * xs_udp_write_space - callback invoked when socket buffer space
1589 * @sk: socket whose state has changed
1591 * Called when more output buffer space is available for this socket.
1592 * We try not to wake our writers until they can make "significant"
1593 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1594 * with a bunch of small requests.
1596 static void xs_udp_write_space(struct sock *sk)
1598 /* from net/core/sock.c:sock_def_write_space */
1599 if (sock_writeable(sk))
1604 * xs_tcp_write_space - callback invoked when socket buffer space
1606 * @sk: socket whose state has changed
1608 * Called when more output buffer space is available for this socket.
1609 * We try not to wake our writers until they can make "significant"
1610 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1611 * with a bunch of small requests.
1613 static void xs_tcp_write_space(struct sock *sk)
1615 /* from net/core/stream.c:sk_stream_write_space */
1616 if (sk_stream_is_writeable(sk))
1620 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1622 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1623 struct sock *sk = transport->inet;
1625 if (transport->rcvsize) {
1626 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1627 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1629 if (transport->sndsize) {
1630 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1631 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1632 sk->sk_write_space(sk);
1637 * xs_udp_set_buffer_size - set send and receive limits
1638 * @xprt: generic transport
1639 * @sndsize: requested size of send buffer, in bytes
1640 * @rcvsize: requested size of receive buffer, in bytes
1642 * Set socket send and receive buffer size limits.
1644 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1646 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1648 transport->sndsize = 0;
1650 transport->sndsize = sndsize + 1024;
1651 transport->rcvsize = 0;
1653 transport->rcvsize = rcvsize + 1024;
1655 xs_udp_do_set_buffer_size(xprt);
1659 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1660 * @xprt: controlling transport
1661 * @task: task that timed out
1663 * Adjust the congestion window after a retransmit timeout has occurred.
1665 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1667 spin_lock(&xprt->transport_lock);
1668 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1669 spin_unlock(&xprt->transport_lock);
1672 static int xs_get_random_port(void)
1674 unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1675 unsigned short range;
1676 unsigned short rand;
1680 range = max - min + 1;
1681 rand = get_random_u32_below(range);
1685 static unsigned short xs_sock_getport(struct socket *sock)
1687 struct sockaddr_storage buf;
1688 unsigned short port = 0;
1690 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1692 switch (buf.ss_family) {
1694 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1697 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1704 * xs_set_port - reset the port number in the remote endpoint address
1705 * @xprt: generic transport
1706 * @port: new port number
1709 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1711 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1713 rpc_set_port(xs_addr(xprt), port);
1714 xs_update_peer_port(xprt);
1717 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1719 if (transport->srcport == 0 && transport->xprt.reuseport)
1720 transport->srcport = xs_sock_getport(sock);
1723 static int xs_get_srcport(struct sock_xprt *transport)
1725 int port = transport->srcport;
1727 if (port == 0 && transport->xprt.resvport)
1728 port = xs_get_random_port();
1732 static unsigned short xs_sock_srcport(struct rpc_xprt *xprt)
1734 struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1735 unsigned short ret = 0;
1736 mutex_lock(&sock->recv_mutex);
1738 ret = xs_sock_getport(sock->sock);
1739 mutex_unlock(&sock->recv_mutex);
1743 static int xs_sock_srcaddr(struct rpc_xprt *xprt, char *buf, size_t buflen)
1745 struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1748 struct sockaddr_storage st;
1750 int ret = -ENOTCONN;
1752 mutex_lock(&sock->recv_mutex);
1754 ret = kernel_getsockname(sock->sock, &saddr.sa);
1756 ret = snprintf(buf, buflen, "%pISc", &saddr.sa);
1758 mutex_unlock(&sock->recv_mutex);
1762 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1764 if (transport->srcport != 0)
1765 transport->srcport = 0;
1766 if (!transport->xprt.resvport)
1768 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1769 return xprt_max_resvport;
1772 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1774 struct sockaddr_storage myaddr;
1776 int port = xs_get_srcport(transport);
1777 unsigned short last;
1780 * If we are asking for any ephemeral port (i.e. port == 0 &&
1781 * transport->xprt.resvport == 0), don't bind. Let the local
1782 * port selection happen implicitly when the socket is used
1783 * (for example at connect time).
1785 * This ensures that we can continue to establish TCP
1786 * connections even when all local ephemeral ports are already
1787 * a part of some TCP connection. This makes no difference
1788 * for UDP sockets, but also doesn't harm them.
1790 * If we're asking for any reserved port (i.e. port == 0 &&
1791 * transport->xprt.resvport == 1) xs_get_srcport above will
1792 * ensure that port is non-zero and we will bind as needed.
1797 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1799 rpc_set_port((struct sockaddr *)&myaddr, port);
1800 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1801 transport->xprt.addrlen);
1803 if (transport->xprt.reuseport)
1804 transport->srcport = port;
1808 port = xs_next_srcport(transport, port);
1811 } while (err == -EADDRINUSE && nloop != 2);
1813 if (myaddr.ss_family == AF_INET)
1814 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1815 &((struct sockaddr_in *)&myaddr)->sin_addr,
1816 port, err ? "failed" : "ok", err);
1818 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1819 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1820 port, err ? "failed" : "ok", err);
1825 * We don't support autobind on AF_LOCAL sockets
1827 static void xs_local_rpcbind(struct rpc_task *task)
1829 xprt_set_bound(task->tk_xprt);
1832 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1836 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1837 static struct lock_class_key xs_key[3];
1838 static struct lock_class_key xs_slock_key[3];
1840 static inline void xs_reclassify_socketu(struct socket *sock)
1842 struct sock *sk = sock->sk;
1844 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1845 &xs_slock_key[0], "sk_lock-AF_LOCAL-RPC", &xs_key[0]);
1848 static inline void xs_reclassify_socket4(struct socket *sock)
1850 struct sock *sk = sock->sk;
1852 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1853 &xs_slock_key[1], "sk_lock-AF_INET-RPC", &xs_key[1]);
1856 static inline void xs_reclassify_socket6(struct socket *sock)
1858 struct sock *sk = sock->sk;
1860 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1861 &xs_slock_key[2], "sk_lock-AF_INET6-RPC", &xs_key[2]);
1864 static inline void xs_reclassify_socket(int family, struct socket *sock)
1866 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1871 xs_reclassify_socketu(sock);
1874 xs_reclassify_socket4(sock);
1877 xs_reclassify_socket6(sock);
1882 static inline void xs_reclassify_socket(int family, struct socket *sock)
1887 static void xs_dummy_setup_socket(struct work_struct *work)
1891 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1892 struct sock_xprt *transport, int family, int type,
1893 int protocol, bool reuseport)
1896 struct socket *sock;
1899 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1901 dprintk("RPC: can't create %d transport socket (%d).\n",
1905 xs_reclassify_socket(family, sock);
1908 sock_set_reuseport(sock->sk);
1910 err = xs_bind(transport, sock);
1916 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1918 return ERR_CAST(filp);
1919 transport->file = filp;
1923 return ERR_PTR(err);
1926 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1927 struct socket *sock)
1929 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1932 if (!transport->inet) {
1933 struct sock *sk = sock->sk;
1937 xs_save_old_callbacks(transport, sk);
1939 sk->sk_user_data = xprt;
1940 sk->sk_data_ready = xs_data_ready;
1941 sk->sk_write_space = xs_udp_write_space;
1942 sk->sk_state_change = xs_local_state_change;
1943 sk->sk_error_report = xs_error_report;
1944 sk->sk_use_task_frag = false;
1946 xprt_clear_connected(xprt);
1948 /* Reset to new socket */
1949 transport->sock = sock;
1950 transport->inet = sk;
1955 xs_stream_start_connect(transport);
1957 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1961 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1962 * @transport: socket transport to connect
1964 static int xs_local_setup_socket(struct sock_xprt *transport)
1966 struct rpc_xprt *xprt = &transport->xprt;
1968 struct socket *sock;
1971 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1972 SOCK_STREAM, 0, &sock, 1);
1974 dprintk("RPC: can't create AF_LOCAL "
1975 "transport socket (%d).\n", -status);
1978 xs_reclassify_socket(AF_LOCAL, sock);
1980 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1982 status = PTR_ERR(filp);
1985 transport->file = filp;
1987 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1988 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1990 status = xs_local_finish_connecting(xprt, sock);
1991 trace_rpc_socket_connect(xprt, sock, status);
1994 dprintk("RPC: xprt %p connected to %s\n",
1995 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1996 xprt->stat.connect_count++;
1997 xprt->stat.connect_time += (long)jiffies -
1998 xprt->stat.connect_start;
1999 xprt_set_connected(xprt);
2004 dprintk("RPC: xprt %p: socket %s does not exist\n",
2005 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2008 dprintk("RPC: xprt %p: connection refused for %s\n",
2009 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2012 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
2014 xprt->address_strings[RPC_DISPLAY_ADDR]);
2018 xprt_clear_connecting(xprt);
2019 xprt_wake_pending_tasks(xprt, status);
2023 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2025 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2028 if (transport->file)
2029 goto force_disconnect;
2031 if (RPC_IS_ASYNC(task)) {
2033 * We want the AF_LOCAL connect to be resolved in the
2034 * filesystem namespace of the process making the rpc
2035 * call. Thus we connect synchronously.
2037 * If we want to support asynchronous AF_LOCAL calls,
2038 * we'll need to figure out how to pass a namespace to
2041 rpc_task_set_rpc_status(task, -ENOTCONN);
2044 ret = xs_local_setup_socket(transport);
2045 if (ret && !RPC_IS_SOFTCONN(task))
2046 msleep_interruptible(15000);
2049 xprt_force_disconnect(xprt);
2051 xprt_clear_connecting(xprt);
2052 xprt_wake_pending_tasks(xprt, -ENOTCONN);
2055 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2057 * Note that this should be called with XPRT_LOCKED held, or recv_mutex
2058 * held, or when we otherwise know that we have exclusive access to the
2059 * socket, to guard against races with xs_reset_transport.
2061 static void xs_set_memalloc(struct rpc_xprt *xprt)
2063 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
2067 * If there's no sock, then we have nothing to set. The
2068 * reconnecting process will get it for us.
2070 if (!transport->inet)
2072 if (atomic_read(&xprt->swapper))
2073 sk_set_memalloc(transport->inet);
2077 * xs_enable_swap - Tag this transport as being used for swap.
2078 * @xprt: transport to tag
2080 * Take a reference to this transport on behalf of the rpc_clnt, and
2081 * optionally mark it for swapping if it wasn't already.
2084 xs_enable_swap(struct rpc_xprt *xprt)
2086 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2088 mutex_lock(&xs->recv_mutex);
2089 if (atomic_inc_return(&xprt->swapper) == 1 &&
2091 sk_set_memalloc(xs->inet);
2092 mutex_unlock(&xs->recv_mutex);
2097 * xs_disable_swap - Untag this transport as being used for swap.
2098 * @xprt: transport to tag
2100 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2101 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2104 xs_disable_swap(struct rpc_xprt *xprt)
2106 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2108 mutex_lock(&xs->recv_mutex);
2109 if (atomic_dec_and_test(&xprt->swapper) &&
2111 sk_clear_memalloc(xs->inet);
2112 mutex_unlock(&xs->recv_mutex);
2115 static void xs_set_memalloc(struct rpc_xprt *xprt)
2120 xs_enable_swap(struct rpc_xprt *xprt)
2126 xs_disable_swap(struct rpc_xprt *xprt)
2131 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2133 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2135 if (!transport->inet) {
2136 struct sock *sk = sock->sk;
2140 xs_save_old_callbacks(transport, sk);
2142 sk->sk_user_data = xprt;
2143 sk->sk_data_ready = xs_data_ready;
2144 sk->sk_write_space = xs_udp_write_space;
2145 sk->sk_use_task_frag = false;
2147 xprt_set_connected(xprt);
2149 /* Reset to new socket */
2150 transport->sock = sock;
2151 transport->inet = sk;
2153 xs_set_memalloc(xprt);
2157 xs_udp_do_set_buffer_size(xprt);
2159 xprt->stat.connect_start = jiffies;
2162 static void xs_udp_setup_socket(struct work_struct *work)
2164 struct sock_xprt *transport =
2165 container_of(work, struct sock_xprt, connect_worker.work);
2166 struct rpc_xprt *xprt = &transport->xprt;
2167 struct socket *sock;
2169 unsigned int pflags = current->flags;
2171 if (atomic_read(&xprt->swapper))
2172 current->flags |= PF_MEMALLOC;
2173 sock = xs_create_sock(xprt, transport,
2174 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2175 IPPROTO_UDP, false);
2179 dprintk("RPC: worker connecting xprt %p via %s to "
2180 "%s (port %s)\n", xprt,
2181 xprt->address_strings[RPC_DISPLAY_PROTO],
2182 xprt->address_strings[RPC_DISPLAY_ADDR],
2183 xprt->address_strings[RPC_DISPLAY_PORT]);
2185 xs_udp_finish_connecting(xprt, sock);
2186 trace_rpc_socket_connect(xprt, sock, 0);
2189 xprt_clear_connecting(xprt);
2190 xprt_unlock_connect(xprt, transport);
2191 xprt_wake_pending_tasks(xprt, status);
2192 current_restore_flags(pflags, PF_MEMALLOC);
2196 * xs_tcp_shutdown - gracefully shut down a TCP socket
2199 * Initiates a graceful shutdown of the TCP socket by calling the
2200 * equivalent of shutdown(SHUT_RDWR);
2202 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2204 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2205 struct socket *sock = transport->sock;
2206 int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE;
2210 if (!xprt->reuseport) {
2219 case TCP_ESTABLISHED:
2220 case TCP_CLOSE_WAIT:
2221 kernel_sock_shutdown(sock, SHUT_RDWR);
2222 trace_rpc_socket_shutdown(xprt, sock);
2225 xs_reset_transport(transport);
2229 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2230 struct socket *sock)
2232 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2233 struct net *net = sock_net(sock->sk);
2234 unsigned long connect_timeout;
2235 unsigned long syn_retries;
2236 unsigned int keepidle;
2237 unsigned int keepcnt;
2241 spin_lock(&xprt->transport_lock);
2242 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2243 keepcnt = xprt->timeout->to_retries + 1;
2244 timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2245 (xprt->timeout->to_retries + 1);
2246 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2247 spin_unlock(&xprt->transport_lock);
2249 /* TCP Keepalive options */
2250 sock_set_keepalive(sock->sk);
2251 tcp_sock_set_keepidle(sock->sk, keepidle);
2252 tcp_sock_set_keepintvl(sock->sk, keepidle);
2253 tcp_sock_set_keepcnt(sock->sk, keepcnt);
2255 /* TCP user timeout (see RFC5482) */
2256 tcp_sock_set_user_timeout(sock->sk, timeo);
2258 /* Connect timeout */
2259 connect_timeout = max_t(unsigned long,
2260 DIV_ROUND_UP(xprt->connect_timeout, HZ), 1);
2261 syn_retries = max_t(unsigned long,
2262 READ_ONCE(net->ipv4.sysctl_tcp_syn_retries), 1);
2263 for (t = 0; t <= syn_retries && (1UL << t) < connect_timeout; t++)
2265 if (t <= syn_retries)
2266 tcp_sock_set_syncnt(sock->sk, t - 1);
2269 static void xs_tcp_do_set_connect_timeout(struct rpc_xprt *xprt,
2270 unsigned long connect_timeout)
2272 struct sock_xprt *transport =
2273 container_of(xprt, struct sock_xprt, xprt);
2274 struct rpc_timeout to;
2275 unsigned long initval;
2277 memcpy(&to, xprt->timeout, sizeof(to));
2278 /* Arbitrary lower limit */
2279 initval = max_t(unsigned long, connect_timeout, XS_TCP_INIT_REEST_TO);
2280 to.to_initval = initval;
2281 to.to_maxval = initval;
2283 memcpy(&transport->tcp_timeout, &to, sizeof(transport->tcp_timeout));
2284 xprt->timeout = &transport->tcp_timeout;
2285 xprt->connect_timeout = connect_timeout;
2288 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2289 unsigned long connect_timeout,
2290 unsigned long reconnect_timeout)
2292 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2294 spin_lock(&xprt->transport_lock);
2295 if (reconnect_timeout < xprt->max_reconnect_timeout)
2296 xprt->max_reconnect_timeout = reconnect_timeout;
2297 if (connect_timeout < xprt->connect_timeout)
2298 xs_tcp_do_set_connect_timeout(xprt, connect_timeout);
2299 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2300 spin_unlock(&xprt->transport_lock);
2303 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2305 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2307 if (!transport->inet) {
2308 struct sock *sk = sock->sk;
2310 /* Avoid temporary address, they are bad for long-lived
2311 * connections such as NFS mounts.
2312 * RFC4941, section 3.6 suggests that:
2313 * Individual applications, which have specific
2314 * knowledge about the normal duration of connections,
2315 * MAY override this as appropriate.
2317 if (xs_addr(xprt)->sa_family == PF_INET6) {
2318 ip6_sock_set_addr_preferences(sk,
2319 IPV6_PREFER_SRC_PUBLIC);
2322 xs_tcp_set_socket_timeouts(xprt, sock);
2323 tcp_sock_set_nodelay(sk);
2327 xs_save_old_callbacks(transport, sk);
2329 sk->sk_user_data = xprt;
2330 sk->sk_data_ready = xs_data_ready;
2331 sk->sk_state_change = xs_tcp_state_change;
2332 sk->sk_write_space = xs_tcp_write_space;
2333 sk->sk_error_report = xs_error_report;
2334 sk->sk_use_task_frag = false;
2336 /* socket options */
2337 sock_reset_flag(sk, SOCK_LINGER);
2339 xprt_clear_connected(xprt);
2341 /* Reset to new socket */
2342 transport->sock = sock;
2343 transport->inet = sk;
2348 if (!xprt_bound(xprt))
2351 xs_set_memalloc(xprt);
2353 xs_stream_start_connect(transport);
2355 /* Tell the socket layer to start connecting... */
2356 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2357 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2361 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2362 * @work: queued work item
2364 * Invoked by a work queue tasklet.
2366 static void xs_tcp_setup_socket(struct work_struct *work)
2368 struct sock_xprt *transport =
2369 container_of(work, struct sock_xprt, connect_worker.work);
2370 struct socket *sock = transport->sock;
2371 struct rpc_xprt *xprt = &transport->xprt;
2373 unsigned int pflags = current->flags;
2375 if (atomic_read(&xprt->swapper))
2376 current->flags |= PF_MEMALLOC;
2378 if (xprt_connected(xprt))
2380 if (test_and_clear_bit(XPRT_SOCK_CONNECT_SENT,
2381 &transport->sock_state) ||
2383 xs_reset_transport(transport);
2384 sock = xs_create_sock(xprt, transport, xs_addr(xprt)->sa_family,
2385 SOCK_STREAM, IPPROTO_TCP, true);
2387 xprt_wake_pending_tasks(xprt, PTR_ERR(sock));
2392 dprintk("RPC: worker connecting xprt %p via %s to "
2393 "%s (port %s)\n", xprt,
2394 xprt->address_strings[RPC_DISPLAY_PROTO],
2395 xprt->address_strings[RPC_DISPLAY_ADDR],
2396 xprt->address_strings[RPC_DISPLAY_PORT]);
2398 status = xs_tcp_finish_connecting(xprt, sock);
2399 trace_rpc_socket_connect(xprt, sock, status);
2400 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2401 xprt, -status, xprt_connected(xprt),
2402 sock->sk->sk_state);
2407 set_bit(XPRT_SOCK_CONNECT_SENT, &transport->sock_state);
2408 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2409 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2413 case -EADDRNOTAVAIL:
2414 /* Source port number is unavailable. Try a new one! */
2415 transport->srcport = 0;
2419 /* Happens, for instance, if the user specified a link
2420 * local IPv6 address without a scope-id.
2431 printk("%s: connect returned unhandled error %d\n",
2436 /* xs_tcp_force_close() wakes tasks with a fixed error code.
2437 * We need to wake them first to ensure the correct error code.
2439 xprt_wake_pending_tasks(xprt, status);
2440 xs_tcp_force_close(xprt);
2442 xprt_clear_connecting(xprt);
2444 xprt_unlock_connect(xprt, transport);
2445 current_restore_flags(pflags, PF_MEMALLOC);
2449 * Transfer the connected socket to @upper_transport, then mark that
2452 static int xs_tcp_tls_finish_connecting(struct rpc_xprt *lower_xprt,
2453 struct sock_xprt *upper_transport)
2455 struct sock_xprt *lower_transport =
2456 container_of(lower_xprt, struct sock_xprt, xprt);
2457 struct rpc_xprt *upper_xprt = &upper_transport->xprt;
2459 if (!upper_transport->inet) {
2460 struct socket *sock = lower_transport->sock;
2461 struct sock *sk = sock->sk;
2463 /* Avoid temporary address, they are bad for long-lived
2464 * connections such as NFS mounts.
2465 * RFC4941, section 3.6 suggests that:
2466 * Individual applications, which have specific
2467 * knowledge about the normal duration of connections,
2468 * MAY override this as appropriate.
2470 if (xs_addr(upper_xprt)->sa_family == PF_INET6)
2471 ip6_sock_set_addr_preferences(sk, IPV6_PREFER_SRC_PUBLIC);
2473 xs_tcp_set_socket_timeouts(upper_xprt, sock);
2474 tcp_sock_set_nodelay(sk);
2478 /* @sk is already connected, so it now has the RPC callbacks.
2479 * Reach into @lower_transport to save the original ones.
2481 upper_transport->old_data_ready = lower_transport->old_data_ready;
2482 upper_transport->old_state_change = lower_transport->old_state_change;
2483 upper_transport->old_write_space = lower_transport->old_write_space;
2484 upper_transport->old_error_report = lower_transport->old_error_report;
2485 sk->sk_user_data = upper_xprt;
2487 /* socket options */
2488 sock_reset_flag(sk, SOCK_LINGER);
2490 xprt_clear_connected(upper_xprt);
2492 upper_transport->sock = sock;
2493 upper_transport->inet = sk;
2494 upper_transport->file = lower_transport->file;
2498 /* Reset lower_transport before shutting down its clnt */
2499 mutex_lock(&lower_transport->recv_mutex);
2500 lower_transport->inet = NULL;
2501 lower_transport->sock = NULL;
2502 lower_transport->file = NULL;
2504 xprt_clear_connected(lower_xprt);
2505 xs_sock_reset_connection_flags(lower_xprt);
2506 xs_stream_reset_connect(lower_transport);
2507 mutex_unlock(&lower_transport->recv_mutex);
2510 if (!xprt_bound(upper_xprt))
2513 xs_set_memalloc(upper_xprt);
2515 if (!xprt_test_and_set_connected(upper_xprt)) {
2516 upper_xprt->connect_cookie++;
2517 clear_bit(XPRT_SOCK_CONNECTING, &upper_transport->sock_state);
2518 xprt_clear_connecting(upper_xprt);
2520 upper_xprt->stat.connect_count++;
2521 upper_xprt->stat.connect_time += (long)jiffies -
2522 upper_xprt->stat.connect_start;
2523 xs_run_error_worker(upper_transport, XPRT_SOCK_WAKE_PENDING);
2529 * xs_tls_handshake_done - TLS handshake completion handler
2530 * @data: address of xprt to wake
2531 * @status: status of handshake
2532 * @peerid: serial number of key containing the remote's identity
2535 static void xs_tls_handshake_done(void *data, int status, key_serial_t peerid)
2537 struct rpc_xprt *lower_xprt = data;
2538 struct sock_xprt *lower_transport =
2539 container_of(lower_xprt, struct sock_xprt, xprt);
2541 lower_transport->xprt_err = status ? -EACCES : 0;
2542 complete(&lower_transport->handshake_done);
2543 xprt_put(lower_xprt);
2546 static int xs_tls_handshake_sync(struct rpc_xprt *lower_xprt, struct xprtsec_parms *xprtsec)
2548 struct sock_xprt *lower_transport =
2549 container_of(lower_xprt, struct sock_xprt, xprt);
2550 struct tls_handshake_args args = {
2551 .ta_sock = lower_transport->sock,
2552 .ta_done = xs_tls_handshake_done,
2553 .ta_data = xprt_get(lower_xprt),
2554 .ta_peername = lower_xprt->servername,
2556 struct sock *sk = lower_transport->inet;
2559 init_completion(&lower_transport->handshake_done);
2560 set_bit(XPRT_SOCK_IGNORE_RECV, &lower_transport->sock_state);
2561 lower_transport->xprt_err = -ETIMEDOUT;
2562 switch (xprtsec->policy) {
2563 case RPC_XPRTSEC_TLS_ANON:
2564 rc = tls_client_hello_anon(&args, GFP_KERNEL);
2568 case RPC_XPRTSEC_TLS_X509:
2569 args.ta_my_cert = xprtsec->cert_serial;
2570 args.ta_my_privkey = xprtsec->privkey_serial;
2571 rc = tls_client_hello_x509(&args, GFP_KERNEL);
2580 rc = wait_for_completion_interruptible_timeout(&lower_transport->handshake_done,
2581 XS_TLS_HANDSHAKE_TO);
2583 if (!tls_handshake_cancel(sk)) {
2590 rc = lower_transport->xprt_err;
2593 xs_stream_reset_connect(lower_transport);
2594 clear_bit(XPRT_SOCK_IGNORE_RECV, &lower_transport->sock_state);
2598 xprt_put(lower_xprt);
2603 * xs_tcp_tls_setup_socket - establish a TLS session on a TCP socket
2604 * @work: queued work item
2606 * Invoked by a work queue tasklet.
2608 * For RPC-with-TLS, there is a two-stage connection process.
2610 * The "upper-layer xprt" is visible to the RPC consumer. Once it has
2611 * been marked connected, the consumer knows that a TCP connection and
2612 * a TLS session have been established.
2614 * A "lower-layer xprt", created in this function, handles the mechanics
2615 * of connecting the TCP socket, performing the RPC_AUTH_TLS probe, and
2616 * then driving the TLS handshake. Once all that is complete, the upper
2617 * layer xprt is marked connected.
2619 static void xs_tcp_tls_setup_socket(struct work_struct *work)
2621 struct sock_xprt *upper_transport =
2622 container_of(work, struct sock_xprt, connect_worker.work);
2623 struct rpc_clnt *upper_clnt = upper_transport->clnt;
2624 struct rpc_xprt *upper_xprt = &upper_transport->xprt;
2625 struct rpc_create_args args = {
2626 .net = upper_xprt->xprt_net,
2627 .protocol = upper_xprt->prot,
2628 .address = (struct sockaddr *)&upper_xprt->addr,
2629 .addrsize = upper_xprt->addrlen,
2630 .timeout = upper_clnt->cl_timeout,
2631 .servername = upper_xprt->servername,
2632 .program = upper_clnt->cl_program,
2633 .prognumber = upper_clnt->cl_prog,
2634 .version = upper_clnt->cl_vers,
2635 .authflavor = RPC_AUTH_TLS,
2636 .cred = upper_clnt->cl_cred,
2638 .policy = RPC_XPRTSEC_NONE,
2641 unsigned int pflags = current->flags;
2642 struct rpc_clnt *lower_clnt;
2643 struct rpc_xprt *lower_xprt;
2646 if (atomic_read(&upper_xprt->swapper))
2647 current->flags |= PF_MEMALLOC;
2649 xs_stream_start_connect(upper_transport);
2651 /* This implicitly sends an RPC_AUTH_TLS probe */
2652 lower_clnt = rpc_create(&args);
2653 if (IS_ERR(lower_clnt)) {
2654 trace_rpc_tls_unavailable(upper_clnt, upper_xprt);
2655 clear_bit(XPRT_SOCK_CONNECTING, &upper_transport->sock_state);
2656 xprt_clear_connecting(upper_xprt);
2657 xprt_wake_pending_tasks(upper_xprt, PTR_ERR(lower_clnt));
2658 xs_run_error_worker(upper_transport, XPRT_SOCK_WAKE_PENDING);
2662 /* RPC_AUTH_TLS probe was successful. Try a TLS handshake on
2666 lower_xprt = rcu_dereference(lower_clnt->cl_xprt);
2668 status = xs_tls_handshake_sync(lower_xprt, &upper_xprt->xprtsec);
2670 trace_rpc_tls_not_started(upper_clnt, upper_xprt);
2674 status = xs_tcp_tls_finish_connecting(lower_xprt, upper_transport);
2678 trace_rpc_socket_connect(upper_xprt, upper_transport->sock, 0);
2679 if (!xprt_test_and_set_connected(upper_xprt)) {
2680 upper_xprt->connect_cookie++;
2681 clear_bit(XPRT_SOCK_CONNECTING, &upper_transport->sock_state);
2682 xprt_clear_connecting(upper_xprt);
2684 upper_xprt->stat.connect_count++;
2685 upper_xprt->stat.connect_time += (long)jiffies -
2686 upper_xprt->stat.connect_start;
2687 xs_run_error_worker(upper_transport, XPRT_SOCK_WAKE_PENDING);
2689 rpc_shutdown_client(lower_clnt);
2692 current_restore_flags(pflags, PF_MEMALLOC);
2693 upper_transport->clnt = NULL;
2694 xprt_unlock_connect(upper_xprt, upper_transport);
2698 rpc_shutdown_client(lower_clnt);
2700 /* xprt_force_disconnect() wakes tasks with a fixed tk_status code.
2701 * Wake them first here to ensure they get our tk_status code.
2703 xprt_wake_pending_tasks(upper_xprt, status);
2704 xs_tcp_force_close(upper_xprt);
2705 xprt_clear_connecting(upper_xprt);
2710 * xs_connect - connect a socket to a remote endpoint
2711 * @xprt: pointer to transport structure
2712 * @task: address of RPC task that manages state of connect request
2714 * TCP: If the remote end dropped the connection, delay reconnecting.
2716 * UDP socket connects are synchronous, but we use a work queue anyway
2717 * to guarantee that even unprivileged user processes can set up a
2718 * socket on a privileged port.
2720 * If a UDP socket connect fails, the delay behavior here prevents
2721 * retry floods (hard mounts).
2723 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2725 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2726 unsigned long delay = 0;
2728 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2730 if (transport->sock != NULL) {
2731 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2732 "seconds\n", xprt, xprt->reestablish_timeout / HZ);
2734 delay = xprt_reconnect_delay(xprt);
2735 xprt_reconnect_backoff(xprt, XS_TCP_INIT_REEST_TO);
2738 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2740 transport->clnt = task->tk_client;
2741 queue_delayed_work(xprtiod_workqueue,
2742 &transport->connect_worker,
2746 static void xs_wake_disconnect(struct sock_xprt *transport)
2748 if (test_and_clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state))
2749 xs_tcp_force_close(&transport->xprt);
2752 static void xs_wake_write(struct sock_xprt *transport)
2754 if (test_and_clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state))
2755 xprt_write_space(&transport->xprt);
2758 static void xs_wake_error(struct sock_xprt *transport)
2762 if (!test_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2764 mutex_lock(&transport->recv_mutex);
2765 if (transport->sock == NULL)
2767 if (!test_and_clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2769 sockerr = xchg(&transport->xprt_err, 0);
2771 xprt_wake_pending_tasks(&transport->xprt, sockerr);
2773 mutex_unlock(&transport->recv_mutex);
2776 static void xs_wake_pending(struct sock_xprt *transport)
2778 if (test_and_clear_bit(XPRT_SOCK_WAKE_PENDING, &transport->sock_state))
2779 xprt_wake_pending_tasks(&transport->xprt, -EAGAIN);
2782 static void xs_error_handle(struct work_struct *work)
2784 struct sock_xprt *transport = container_of(work,
2785 struct sock_xprt, error_worker);
2787 xs_wake_disconnect(transport);
2788 xs_wake_write(transport);
2789 xs_wake_error(transport);
2790 xs_wake_pending(transport);
2794 * xs_local_print_stats - display AF_LOCAL socket-specific stats
2795 * @xprt: rpc_xprt struct containing statistics
2799 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2803 if (xprt_connected(xprt))
2804 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2806 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2807 "%llu %llu %lu %llu %llu\n",
2808 xprt->stat.bind_count,
2809 xprt->stat.connect_count,
2810 xprt->stat.connect_time / HZ,
2814 xprt->stat.bad_xids,
2817 xprt->stat.max_slots,
2818 xprt->stat.sending_u,
2819 xprt->stat.pending_u);
2823 * xs_udp_print_stats - display UDP socket-specific stats
2824 * @xprt: rpc_xprt struct containing statistics
2828 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2830 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2832 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2835 xprt->stat.bind_count,
2838 xprt->stat.bad_xids,
2841 xprt->stat.max_slots,
2842 xprt->stat.sending_u,
2843 xprt->stat.pending_u);
2847 * xs_tcp_print_stats - display TCP socket-specific stats
2848 * @xprt: rpc_xprt struct containing statistics
2852 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2854 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2857 if (xprt_connected(xprt))
2858 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2860 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2861 "%llu %llu %lu %llu %llu\n",
2863 xprt->stat.bind_count,
2864 xprt->stat.connect_count,
2865 xprt->stat.connect_time / HZ,
2869 xprt->stat.bad_xids,
2872 xprt->stat.max_slots,
2873 xprt->stat.sending_u,
2874 xprt->stat.pending_u);
2878 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2879 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2880 * to use the server side send routines.
2882 static int bc_malloc(struct rpc_task *task)
2884 struct rpc_rqst *rqst = task->tk_rqstp;
2885 size_t size = rqst->rq_callsize;
2887 struct rpc_buffer *buf;
2889 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2890 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2895 page = alloc_page(GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN);
2899 buf = page_address(page);
2900 buf->len = PAGE_SIZE;
2902 rqst->rq_buffer = buf->data;
2903 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2908 * Free the space allocated in the bc_alloc routine
2910 static void bc_free(struct rpc_task *task)
2912 void *buffer = task->tk_rqstp->rq_buffer;
2913 struct rpc_buffer *buf;
2915 buf = container_of(buffer, struct rpc_buffer, data);
2916 free_page((unsigned long)buf);
2919 static int bc_sendto(struct rpc_rqst *req)
2921 struct xdr_buf *xdr = &req->rq_snd_buf;
2922 struct sock_xprt *transport =
2923 container_of(req->rq_xprt, struct sock_xprt, xprt);
2924 struct msghdr msg = {
2927 rpc_fraghdr marker = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT |
2929 unsigned int sent = 0;
2932 req->rq_xtime = ktime_get();
2933 err = xdr_alloc_bvec(xdr, rpc_task_gfp_mask());
2936 err = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, marker, &sent);
2938 if (err < 0 || sent != (xdr->len + sizeof(marker)))
2944 * bc_send_request - Send a backchannel Call on a TCP socket
2945 * @req: rpc_rqst containing Call message to be sent
2947 * xpt_mutex ensures @rqstp's whole message is written to the socket
2948 * without interruption.
2951 * %0 if the message was sent successfully
2952 * %ENOTCONN if the message was not sent
2954 static int bc_send_request(struct rpc_rqst *req)
2956 struct svc_xprt *xprt;
2960 * Get the server socket associated with this callback xprt
2962 xprt = req->rq_xprt->bc_xprt;
2965 * Grab the mutex to serialize data as the connection is shared
2966 * with the fore channel
2968 mutex_lock(&xprt->xpt_mutex);
2969 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2972 len = bc_sendto(req);
2973 mutex_unlock(&xprt->xpt_mutex);
2982 * The close routine. Since this is client initiated, we do nothing
2985 static void bc_close(struct rpc_xprt *xprt)
2987 xprt_disconnect_done(xprt);
2991 * The xprt destroy routine. Again, because this connection is client
2992 * initiated, we do nothing
2995 static void bc_destroy(struct rpc_xprt *xprt)
2997 dprintk("RPC: bc_destroy xprt %p\n", xprt);
3000 module_put(THIS_MODULE);
3003 static const struct rpc_xprt_ops xs_local_ops = {
3004 .reserve_xprt = xprt_reserve_xprt,
3005 .release_xprt = xprt_release_xprt,
3006 .alloc_slot = xprt_alloc_slot,
3007 .free_slot = xprt_free_slot,
3008 .rpcbind = xs_local_rpcbind,
3009 .set_port = xs_local_set_port,
3010 .connect = xs_local_connect,
3011 .buf_alloc = rpc_malloc,
3012 .buf_free = rpc_free,
3013 .prepare_request = xs_stream_prepare_request,
3014 .send_request = xs_local_send_request,
3015 .wait_for_reply_request = xprt_wait_for_reply_request_def,
3017 .destroy = xs_destroy,
3018 .print_stats = xs_local_print_stats,
3019 .enable_swap = xs_enable_swap,
3020 .disable_swap = xs_disable_swap,
3023 static const struct rpc_xprt_ops xs_udp_ops = {
3024 .set_buffer_size = xs_udp_set_buffer_size,
3025 .reserve_xprt = xprt_reserve_xprt_cong,
3026 .release_xprt = xprt_release_xprt_cong,
3027 .alloc_slot = xprt_alloc_slot,
3028 .free_slot = xprt_free_slot,
3029 .rpcbind = rpcb_getport_async,
3030 .set_port = xs_set_port,
3031 .connect = xs_connect,
3032 .get_srcaddr = xs_sock_srcaddr,
3033 .get_srcport = xs_sock_srcport,
3034 .buf_alloc = rpc_malloc,
3035 .buf_free = rpc_free,
3036 .send_request = xs_udp_send_request,
3037 .wait_for_reply_request = xprt_wait_for_reply_request_rtt,
3038 .timer = xs_udp_timer,
3039 .release_request = xprt_release_rqst_cong,
3041 .destroy = xs_destroy,
3042 .print_stats = xs_udp_print_stats,
3043 .enable_swap = xs_enable_swap,
3044 .disable_swap = xs_disable_swap,
3045 .inject_disconnect = xs_inject_disconnect,
3048 static const struct rpc_xprt_ops xs_tcp_ops = {
3049 .reserve_xprt = xprt_reserve_xprt,
3050 .release_xprt = xprt_release_xprt,
3051 .alloc_slot = xprt_alloc_slot,
3052 .free_slot = xprt_free_slot,
3053 .rpcbind = rpcb_getport_async,
3054 .set_port = xs_set_port,
3055 .connect = xs_connect,
3056 .get_srcaddr = xs_sock_srcaddr,
3057 .get_srcport = xs_sock_srcport,
3058 .buf_alloc = rpc_malloc,
3059 .buf_free = rpc_free,
3060 .prepare_request = xs_stream_prepare_request,
3061 .send_request = xs_tcp_send_request,
3062 .wait_for_reply_request = xprt_wait_for_reply_request_def,
3063 .close = xs_tcp_shutdown,
3064 .destroy = xs_destroy,
3065 .set_connect_timeout = xs_tcp_set_connect_timeout,
3066 .print_stats = xs_tcp_print_stats,
3067 .enable_swap = xs_enable_swap,
3068 .disable_swap = xs_disable_swap,
3069 .inject_disconnect = xs_inject_disconnect,
3070 #ifdef CONFIG_SUNRPC_BACKCHANNEL
3071 .bc_setup = xprt_setup_bc,
3072 .bc_maxpayload = xs_tcp_bc_maxpayload,
3073 .bc_num_slots = xprt_bc_max_slots,
3074 .bc_free_rqst = xprt_free_bc_rqst,
3075 .bc_destroy = xprt_destroy_bc,
3080 * The rpc_xprt_ops for the server backchannel
3083 static const struct rpc_xprt_ops bc_tcp_ops = {
3084 .reserve_xprt = xprt_reserve_xprt,
3085 .release_xprt = xprt_release_xprt,
3086 .alloc_slot = xprt_alloc_slot,
3087 .free_slot = xprt_free_slot,
3088 .buf_alloc = bc_malloc,
3089 .buf_free = bc_free,
3090 .send_request = bc_send_request,
3091 .wait_for_reply_request = xprt_wait_for_reply_request_def,
3093 .destroy = bc_destroy,
3094 .print_stats = xs_tcp_print_stats,
3095 .enable_swap = xs_enable_swap,
3096 .disable_swap = xs_disable_swap,
3097 .inject_disconnect = xs_inject_disconnect,
3100 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
3102 static const struct sockaddr_in sin = {
3103 .sin_family = AF_INET,
3104 .sin_addr.s_addr = htonl(INADDR_ANY),
3106 static const struct sockaddr_in6 sin6 = {
3107 .sin6_family = AF_INET6,
3108 .sin6_addr = IN6ADDR_ANY_INIT,
3115 memcpy(sap, &sin, sizeof(sin));
3118 memcpy(sap, &sin6, sizeof(sin6));
3121 dprintk("RPC: %s: Bad address family\n", __func__);
3122 return -EAFNOSUPPORT;
3127 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
3128 unsigned int slot_table_size,
3129 unsigned int max_slot_table_size)
3131 struct rpc_xprt *xprt;
3132 struct sock_xprt *new;
3134 if (args->addrlen > sizeof(xprt->addr)) {
3135 dprintk("RPC: xs_setup_xprt: address too large\n");
3136 return ERR_PTR(-EBADF);
3139 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
3140 max_slot_table_size);
3142 dprintk("RPC: xs_setup_xprt: couldn't allocate "
3144 return ERR_PTR(-ENOMEM);
3147 new = container_of(xprt, struct sock_xprt, xprt);
3148 mutex_init(&new->recv_mutex);
3149 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
3150 xprt->addrlen = args->addrlen;
3152 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
3155 err = xs_init_anyaddr(args->dstaddr->sa_family,
3156 (struct sockaddr *)&new->srcaddr);
3159 return ERR_PTR(err);
3166 static const struct rpc_timeout xs_local_default_timeout = {
3167 .to_initval = 10 * HZ,
3168 .to_maxval = 10 * HZ,
3173 * xs_setup_local - Set up transport to use an AF_LOCAL socket
3174 * @args: rpc transport creation arguments
3176 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
3178 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
3180 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
3181 struct sock_xprt *transport;
3182 struct rpc_xprt *xprt;
3183 struct rpc_xprt *ret;
3185 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3186 xprt_max_tcp_slot_table_entries);
3189 transport = container_of(xprt, struct sock_xprt, xprt);
3192 xprt->xprt_class = &xs_local_transport;
3193 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3195 xprt->bind_timeout = XS_BIND_TO;
3196 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
3197 xprt->idle_timeout = XS_IDLE_DISC_TO;
3199 xprt->ops = &xs_local_ops;
3200 xprt->timeout = &xs_local_default_timeout;
3202 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
3203 INIT_WORK(&transport->error_worker, xs_error_handle);
3204 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
3206 switch (sun->sun_family) {
3208 if (sun->sun_path[0] != '/' && sun->sun_path[0] != '\0') {
3209 dprintk("RPC: bad AF_LOCAL address: %s\n",
3211 ret = ERR_PTR(-EINVAL);
3214 xprt_set_bound(xprt);
3215 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
3218 ret = ERR_PTR(-EAFNOSUPPORT);
3222 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
3223 xprt->address_strings[RPC_DISPLAY_ADDR]);
3225 if (try_module_get(THIS_MODULE))
3227 ret = ERR_PTR(-EINVAL);
3233 static const struct rpc_timeout xs_udp_default_timeout = {
3234 .to_initval = 5 * HZ,
3235 .to_maxval = 30 * HZ,
3236 .to_increment = 5 * HZ,
3241 * xs_setup_udp - Set up transport to use a UDP socket
3242 * @args: rpc transport creation arguments
3245 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
3247 struct sockaddr *addr = args->dstaddr;
3248 struct rpc_xprt *xprt;
3249 struct sock_xprt *transport;
3250 struct rpc_xprt *ret;
3252 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
3253 xprt_udp_slot_table_entries);
3256 transport = container_of(xprt, struct sock_xprt, xprt);
3258 xprt->prot = IPPROTO_UDP;
3259 xprt->xprt_class = &xs_udp_transport;
3260 /* XXX: header size can vary due to auth type, IPv6, etc. */
3261 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
3263 xprt->bind_timeout = XS_BIND_TO;
3264 xprt->reestablish_timeout = XS_UDP_REEST_TO;
3265 xprt->idle_timeout = XS_IDLE_DISC_TO;
3267 xprt->ops = &xs_udp_ops;
3269 xprt->timeout = &xs_udp_default_timeout;
3271 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
3272 INIT_WORK(&transport->error_worker, xs_error_handle);
3273 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
3275 switch (addr->sa_family) {
3277 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3278 xprt_set_bound(xprt);
3280 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
3283 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3284 xprt_set_bound(xprt);
3286 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
3289 ret = ERR_PTR(-EAFNOSUPPORT);
3293 if (xprt_bound(xprt))
3294 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3295 xprt->address_strings[RPC_DISPLAY_ADDR],
3296 xprt->address_strings[RPC_DISPLAY_PORT],
3297 xprt->address_strings[RPC_DISPLAY_PROTO]);
3299 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3300 xprt->address_strings[RPC_DISPLAY_ADDR],
3301 xprt->address_strings[RPC_DISPLAY_PROTO]);
3303 if (try_module_get(THIS_MODULE))
3305 ret = ERR_PTR(-EINVAL);
3311 static const struct rpc_timeout xs_tcp_default_timeout = {
3312 .to_initval = 60 * HZ,
3313 .to_maxval = 60 * HZ,
3318 * xs_setup_tcp - Set up transport to use a TCP socket
3319 * @args: rpc transport creation arguments
3322 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
3324 struct sockaddr *addr = args->dstaddr;
3325 struct rpc_xprt *xprt;
3326 struct sock_xprt *transport;
3327 struct rpc_xprt *ret;
3328 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
3330 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
3331 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
3333 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3334 max_slot_table_size);
3337 transport = container_of(xprt, struct sock_xprt, xprt);
3339 xprt->prot = IPPROTO_TCP;
3340 xprt->xprt_class = &xs_tcp_transport;
3341 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3343 xprt->bind_timeout = XS_BIND_TO;
3344 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
3345 xprt->idle_timeout = XS_IDLE_DISC_TO;
3347 xprt->ops = &xs_tcp_ops;
3348 xprt->timeout = &xs_tcp_default_timeout;
3350 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
3351 if (args->reconnect_timeout)
3352 xprt->max_reconnect_timeout = args->reconnect_timeout;
3354 xprt->connect_timeout = xprt->timeout->to_initval *
3355 (xprt->timeout->to_retries + 1);
3356 if (args->connect_timeout)
3357 xs_tcp_do_set_connect_timeout(xprt, args->connect_timeout);
3359 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
3360 INIT_WORK(&transport->error_worker, xs_error_handle);
3361 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
3363 switch (addr->sa_family) {
3365 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3366 xprt_set_bound(xprt);
3368 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3371 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3372 xprt_set_bound(xprt);
3374 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3377 ret = ERR_PTR(-EAFNOSUPPORT);
3381 if (xprt_bound(xprt))
3382 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3383 xprt->address_strings[RPC_DISPLAY_ADDR],
3384 xprt->address_strings[RPC_DISPLAY_PORT],
3385 xprt->address_strings[RPC_DISPLAY_PROTO]);
3387 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3388 xprt->address_strings[RPC_DISPLAY_ADDR],
3389 xprt->address_strings[RPC_DISPLAY_PROTO]);
3391 if (try_module_get(THIS_MODULE))
3393 ret = ERR_PTR(-EINVAL);
3400 * xs_setup_tcp_tls - Set up transport to use a TCP with TLS
3401 * @args: rpc transport creation arguments
3404 static struct rpc_xprt *xs_setup_tcp_tls(struct xprt_create *args)
3406 struct sockaddr *addr = args->dstaddr;
3407 struct rpc_xprt *xprt;
3408 struct sock_xprt *transport;
3409 struct rpc_xprt *ret;
3410 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
3412 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
3413 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
3415 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3416 max_slot_table_size);
3419 transport = container_of(xprt, struct sock_xprt, xprt);
3421 xprt->prot = IPPROTO_TCP;
3422 xprt->xprt_class = &xs_tcp_transport;
3423 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3425 xprt->bind_timeout = XS_BIND_TO;
3426 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
3427 xprt->idle_timeout = XS_IDLE_DISC_TO;
3429 xprt->ops = &xs_tcp_ops;
3430 xprt->timeout = &xs_tcp_default_timeout;
3432 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
3433 xprt->connect_timeout = xprt->timeout->to_initval *
3434 (xprt->timeout->to_retries + 1);
3436 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
3437 INIT_WORK(&transport->error_worker, xs_error_handle);
3439 switch (args->xprtsec.policy) {
3440 case RPC_XPRTSEC_TLS_ANON:
3441 case RPC_XPRTSEC_TLS_X509:
3442 xprt->xprtsec = args->xprtsec;
3443 INIT_DELAYED_WORK(&transport->connect_worker,
3444 xs_tcp_tls_setup_socket);
3447 ret = ERR_PTR(-EACCES);
3451 switch (addr->sa_family) {
3453 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3454 xprt_set_bound(xprt);
3456 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3459 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3460 xprt_set_bound(xprt);
3462 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3465 ret = ERR_PTR(-EAFNOSUPPORT);
3469 if (xprt_bound(xprt))
3470 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3471 xprt->address_strings[RPC_DISPLAY_ADDR],
3472 xprt->address_strings[RPC_DISPLAY_PORT],
3473 xprt->address_strings[RPC_DISPLAY_PROTO]);
3475 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3476 xprt->address_strings[RPC_DISPLAY_ADDR],
3477 xprt->address_strings[RPC_DISPLAY_PROTO]);
3479 if (try_module_get(THIS_MODULE))
3481 ret = ERR_PTR(-EINVAL);
3488 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3489 * @args: rpc transport creation arguments
3492 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
3494 struct sockaddr *addr = args->dstaddr;
3495 struct rpc_xprt *xprt;
3496 struct sock_xprt *transport;
3497 struct svc_sock *bc_sock;
3498 struct rpc_xprt *ret;
3500 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3501 xprt_tcp_slot_table_entries);
3504 transport = container_of(xprt, struct sock_xprt, xprt);
3506 xprt->prot = IPPROTO_TCP;
3507 xprt->xprt_class = &xs_bc_tcp_transport;
3508 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3509 xprt->timeout = &xs_tcp_default_timeout;
3512 xprt_set_bound(xprt);
3513 xprt->bind_timeout = 0;
3514 xprt->reestablish_timeout = 0;
3515 xprt->idle_timeout = 0;
3517 xprt->ops = &bc_tcp_ops;
3519 switch (addr->sa_family) {
3521 xs_format_peer_addresses(xprt, "tcp",
3525 xs_format_peer_addresses(xprt, "tcp",
3526 RPCBIND_NETID_TCP6);
3529 ret = ERR_PTR(-EAFNOSUPPORT);
3533 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3534 xprt->address_strings[RPC_DISPLAY_ADDR],
3535 xprt->address_strings[RPC_DISPLAY_PORT],
3536 xprt->address_strings[RPC_DISPLAY_PROTO]);
3539 * Once we've associated a backchannel xprt with a connection,
3540 * we want to keep it around as long as the connection lasts,
3541 * in case we need to start using it for a backchannel again;
3542 * this reference won't be dropped until bc_xprt is destroyed.
3545 args->bc_xprt->xpt_bc_xprt = xprt;
3546 xprt->bc_xprt = args->bc_xprt;
3547 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3548 transport->sock = bc_sock->sk_sock;
3549 transport->inet = bc_sock->sk_sk;
3552 * Since we don't want connections for the backchannel, we set
3553 * the xprt status to connected
3555 xprt_set_connected(xprt);
3557 if (try_module_get(THIS_MODULE))
3560 args->bc_xprt->xpt_bc_xprt = NULL;
3561 args->bc_xprt->xpt_bc_xps = NULL;
3563 ret = ERR_PTR(-EINVAL);
3569 static struct xprt_class xs_local_transport = {
3570 .list = LIST_HEAD_INIT(xs_local_transport.list),
3571 .name = "named UNIX socket",
3572 .owner = THIS_MODULE,
3573 .ident = XPRT_TRANSPORT_LOCAL,
3574 .setup = xs_setup_local,
3578 static struct xprt_class xs_udp_transport = {
3579 .list = LIST_HEAD_INIT(xs_udp_transport.list),
3581 .owner = THIS_MODULE,
3582 .ident = XPRT_TRANSPORT_UDP,
3583 .setup = xs_setup_udp,
3584 .netid = { "udp", "udp6", "" },
3587 static struct xprt_class xs_tcp_transport = {
3588 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
3590 .owner = THIS_MODULE,
3591 .ident = XPRT_TRANSPORT_TCP,
3592 .setup = xs_setup_tcp,
3593 .netid = { "tcp", "tcp6", "" },
3596 static struct xprt_class xs_tcp_tls_transport = {
3597 .list = LIST_HEAD_INIT(xs_tcp_tls_transport.list),
3598 .name = "tcp-with-tls",
3599 .owner = THIS_MODULE,
3600 .ident = XPRT_TRANSPORT_TCP_TLS,
3601 .setup = xs_setup_tcp_tls,
3602 .netid = { "tcp", "tcp6", "" },
3605 static struct xprt_class xs_bc_tcp_transport = {
3606 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3607 .name = "tcp NFSv4.1 backchannel",
3608 .owner = THIS_MODULE,
3609 .ident = XPRT_TRANSPORT_BC_TCP,
3610 .setup = xs_setup_bc_tcp,
3615 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3618 int init_socket_xprt(void)
3620 if (!sunrpc_table_header)
3621 sunrpc_table_header = register_sysctl("sunrpc", xs_tunables_table);
3623 xprt_register_transport(&xs_local_transport);
3624 xprt_register_transport(&xs_udp_transport);
3625 xprt_register_transport(&xs_tcp_transport);
3626 xprt_register_transport(&xs_tcp_tls_transport);
3627 xprt_register_transport(&xs_bc_tcp_transport);
3633 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3636 void cleanup_socket_xprt(void)
3638 if (sunrpc_table_header) {
3639 unregister_sysctl_table(sunrpc_table_header);
3640 sunrpc_table_header = NULL;
3643 xprt_unregister_transport(&xs_local_transport);
3644 xprt_unregister_transport(&xs_udp_transport);
3645 xprt_unregister_transport(&xs_tcp_transport);
3646 xprt_unregister_transport(&xs_tcp_tls_transport);
3647 xprt_unregister_transport(&xs_bc_tcp_transport);
3650 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3652 return param_set_uint_minmax(val, kp,
3657 static const struct kernel_param_ops param_ops_portnr = {
3658 .set = param_set_portnr,
3659 .get = param_get_uint,
3662 #define param_check_portnr(name, p) \
3663 __param_check(name, p, unsigned int);
3665 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3666 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3668 static int param_set_slot_table_size(const char *val,
3669 const struct kernel_param *kp)
3671 return param_set_uint_minmax(val, kp,
3673 RPC_MAX_SLOT_TABLE);
3676 static const struct kernel_param_ops param_ops_slot_table_size = {
3677 .set = param_set_slot_table_size,
3678 .get = param_get_uint,
3681 #define param_check_slot_table_size(name, p) \
3682 __param_check(name, p, unsigned int);
3684 static int param_set_max_slot_table_size(const char *val,
3685 const struct kernel_param *kp)
3687 return param_set_uint_minmax(val, kp,
3689 RPC_MAX_SLOT_TABLE_LIMIT);
3692 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3693 .set = param_set_max_slot_table_size,
3694 .get = param_get_uint,
3697 #define param_check_max_slot_table_size(name, p) \
3698 __param_check(name, p, unsigned int);
3700 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3701 slot_table_size, 0644);
3702 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3703 max_slot_table_size, 0644);
3704 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3705 slot_table_size, 0644);