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/tls_prot.h>
52 #include <net/handshake.h>
54 #include <linux/bvec.h>
55 #include <linux/highmem.h>
56 #include <linux/uio.h>
57 #include <linux/sched/mm.h>
59 #include <trace/events/sock.h>
60 #include <trace/events/sunrpc.h>
65 static void xs_close(struct rpc_xprt *xprt);
66 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock);
67 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
73 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
74 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
75 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
77 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
78 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
80 #define XS_TCP_LINGER_TO (15U * HZ)
81 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
84 * We can register our own files under /proc/sys/sunrpc by
85 * calling register_sysctl() again. The files in that
86 * directory become the union of all files registered there.
88 * We simply need to make sure that we don't collide with
89 * someone else's file names!
92 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
93 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
94 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
95 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
96 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
98 static struct ctl_table_header *sunrpc_table_header;
100 static struct xprt_class xs_local_transport;
101 static struct xprt_class xs_udp_transport;
102 static struct xprt_class xs_tcp_transport;
103 static struct xprt_class xs_tcp_tls_transport;
104 static struct xprt_class xs_bc_tcp_transport;
107 * FIXME: changing the UDP slot table size should also resize the UDP
108 * socket buffers for existing UDP transports
110 static struct ctl_table xs_tunables_table[] = {
112 .procname = "udp_slot_table_entries",
113 .data = &xprt_udp_slot_table_entries,
114 .maxlen = sizeof(unsigned int),
116 .proc_handler = proc_dointvec_minmax,
117 .extra1 = &min_slot_table_size,
118 .extra2 = &max_slot_table_size
121 .procname = "tcp_slot_table_entries",
122 .data = &xprt_tcp_slot_table_entries,
123 .maxlen = sizeof(unsigned int),
125 .proc_handler = proc_dointvec_minmax,
126 .extra1 = &min_slot_table_size,
127 .extra2 = &max_slot_table_size
130 .procname = "tcp_max_slot_table_entries",
131 .data = &xprt_max_tcp_slot_table_entries,
132 .maxlen = sizeof(unsigned int),
134 .proc_handler = proc_dointvec_minmax,
135 .extra1 = &min_slot_table_size,
136 .extra2 = &max_tcp_slot_table_limit
139 .procname = "min_resvport",
140 .data = &xprt_min_resvport,
141 .maxlen = sizeof(unsigned int),
143 .proc_handler = proc_dointvec_minmax,
144 .extra1 = &xprt_min_resvport_limit,
145 .extra2 = &xprt_max_resvport_limit
148 .procname = "max_resvport",
149 .data = &xprt_max_resvport,
150 .maxlen = sizeof(unsigned int),
152 .proc_handler = proc_dointvec_minmax,
153 .extra1 = &xprt_min_resvport_limit,
154 .extra2 = &xprt_max_resvport_limit
157 .procname = "tcp_fin_timeout",
158 .data = &xs_tcp_fin_timeout,
159 .maxlen = sizeof(xs_tcp_fin_timeout),
161 .proc_handler = proc_dointvec_jiffies,
167 * Wait duration for a reply from the RPC portmapper.
169 #define XS_BIND_TO (60U * HZ)
172 * Delay if a UDP socket connect error occurs. This is most likely some
173 * kind of resource problem on the local host.
175 #define XS_UDP_REEST_TO (2U * HZ)
178 * The reestablish timeout allows clients to delay for a bit before attempting
179 * to reconnect to a server that just dropped our connection.
181 * We implement an exponential backoff when trying to reestablish a TCP
182 * transport connection with the server. Some servers like to drop a TCP
183 * connection when they are overworked, so we start with a short timeout and
184 * increase over time if the server is down or not responding.
186 #define XS_TCP_INIT_REEST_TO (3U * HZ)
189 * TCP idle timeout; client drops the transport socket if it is idle
190 * for this long. Note that we also timeout UDP sockets to prevent
191 * holding port numbers when there is no RPC traffic.
193 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
196 * TLS handshake timeout.
198 #define XS_TLS_HANDSHAKE_TO (10U * HZ)
200 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
201 # undef RPC_DEBUG_DATA
202 # define RPCDBG_FACILITY RPCDBG_TRANS
205 #ifdef RPC_DEBUG_DATA
206 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
208 u8 *buf = (u8 *) packet;
211 dprintk("RPC: %s\n", msg);
212 for (j = 0; j < count && j < 128; j += 4) {
216 dprintk("0x%04x ", j);
218 dprintk("%02x%02x%02x%02x ",
219 buf[j], buf[j+1], buf[j+2], buf[j+3]);
224 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
230 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
232 return (struct rpc_xprt *) sk->sk_user_data;
235 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
237 return (struct sockaddr *) &xprt->addr;
240 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
242 return (struct sockaddr_un *) &xprt->addr;
245 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
247 return (struct sockaddr_in *) &xprt->addr;
250 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
252 return (struct sockaddr_in6 *) &xprt->addr;
255 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
257 struct sockaddr *sap = xs_addr(xprt);
258 struct sockaddr_in6 *sin6;
259 struct sockaddr_in *sin;
260 struct sockaddr_un *sun;
263 switch (sap->sa_family) {
265 sun = xs_addr_un(xprt);
266 if (sun->sun_path[0]) {
267 strscpy(buf, sun->sun_path, sizeof(buf));
270 strscpy(buf+1, sun->sun_path+1, sizeof(buf)-1);
272 xprt->address_strings[RPC_DISPLAY_ADDR] =
273 kstrdup(buf, GFP_KERNEL);
276 (void)rpc_ntop(sap, buf, sizeof(buf));
277 xprt->address_strings[RPC_DISPLAY_ADDR] =
278 kstrdup(buf, GFP_KERNEL);
279 sin = xs_addr_in(xprt);
280 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
283 (void)rpc_ntop(sap, buf, sizeof(buf));
284 xprt->address_strings[RPC_DISPLAY_ADDR] =
285 kstrdup(buf, GFP_KERNEL);
286 sin6 = xs_addr_in6(xprt);
287 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
293 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
296 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
298 struct sockaddr *sap = xs_addr(xprt);
301 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
302 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
304 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
305 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
308 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
309 const char *protocol,
312 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
313 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
314 xs_format_common_peer_addresses(xprt);
315 xs_format_common_peer_ports(xprt);
318 static void xs_update_peer_port(struct rpc_xprt *xprt)
320 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
321 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
323 xs_format_common_peer_ports(xprt);
326 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
330 for (i = 0; i < RPC_DISPLAY_MAX; i++)
332 case RPC_DISPLAY_PROTO:
333 case RPC_DISPLAY_NETID:
336 kfree(xprt->address_strings[i]);
341 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp)
345 if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES))
347 n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT;
348 for (i = 0; i < n; i++) {
351 buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp);
352 if (!buf->pages[i]) {
354 return i > buf->page_base ? i - buf->page_base : 0;
361 xs_sock_process_cmsg(struct socket *sock, struct msghdr *msg,
362 struct cmsghdr *cmsg, int ret)
364 if (cmsg->cmsg_level == SOL_TLS &&
365 cmsg->cmsg_type == TLS_GET_RECORD_TYPE) {
366 u8 content_type = *((u8 *)CMSG_DATA(cmsg));
368 switch (content_type) {
369 case TLS_RECORD_TYPE_DATA:
370 /* TLS sets EOR at the end of each application data
371 * record, even though there might be more frames
372 * waiting to be decrypted.
374 msg->msg_flags &= ~MSG_EOR;
376 case TLS_RECORD_TYPE_ALERT:
387 xs_sock_recv_cmsg(struct socket *sock, struct msghdr *msg, int flags)
391 u8 buf[CMSG_SPACE(sizeof(u8))];
395 msg->msg_control = &u;
396 msg->msg_controllen = sizeof(u);
397 ret = sock_recvmsg(sock, msg, flags);
398 if (msg->msg_controllen != sizeof(u))
399 ret = xs_sock_process_cmsg(sock, msg, &u.cmsg, ret);
404 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek)
408 iov_iter_advance(&msg->msg_iter, seek);
409 ret = xs_sock_recv_cmsg(sock, msg, flags);
410 return ret > 0 ? ret + seek : ret;
414 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags,
415 struct kvec *kvec, size_t count, size_t seek)
417 iov_iter_kvec(&msg->msg_iter, ITER_DEST, kvec, 1, count);
418 return xs_sock_recvmsg(sock, msg, flags, seek);
422 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags,
423 struct bio_vec *bvec, unsigned long nr, size_t count,
426 iov_iter_bvec(&msg->msg_iter, ITER_DEST, bvec, nr, count);
427 return xs_sock_recvmsg(sock, msg, flags, seek);
431 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags,
434 iov_iter_discard(&msg->msg_iter, ITER_DEST, count);
435 return xs_sock_recv_cmsg(sock, msg, flags);
438 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
440 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
442 struct bvec_iter bi = {
447 bvec_iter_advance(bvec, &bi, seek & PAGE_MASK);
448 for_each_bvec(bv, bvec, bi, bi)
449 flush_dcache_page(bv.bv_page);
453 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
459 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags,
460 struct xdr_buf *buf, size_t count, size_t seek, size_t *read)
462 size_t want, seek_init = seek, offset = 0;
465 want = min_t(size_t, count, buf->head[0].iov_len);
467 ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek);
471 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
481 want = xs_alloc_sparse_pages(
482 buf, min_t(size_t, count - offset, buf->page_len),
483 GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN);
485 ret = xs_read_bvec(sock, msg, flags, buf->bvec,
486 xdr_buf_pagecount(buf),
487 want + buf->page_base,
488 seek + buf->page_base);
491 xs_flush_bvec(buf->bvec, ret, seek + buf->page_base);
492 ret -= buf->page_base;
494 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
504 want = min_t(size_t, count - offset, buf->tail[0].iov_len);
506 ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek);
510 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
514 } else if (offset < seek_init)
518 *read = offset - seek_init;
526 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf)
528 if (!transport->recv.copied) {
529 if (buf->head[0].iov_len >= transport->recv.offset)
530 memcpy(buf->head[0].iov_base,
531 &transport->recv.xid,
532 transport->recv.offset);
533 transport->recv.copied = transport->recv.offset;
538 xs_read_stream_request_done(struct sock_xprt *transport)
540 return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT);
544 xs_read_stream_check_eor(struct sock_xprt *transport,
547 if (xs_read_stream_request_done(transport))
548 msg->msg_flags |= MSG_EOR;
552 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg,
553 int flags, struct rpc_rqst *req)
555 struct xdr_buf *buf = &req->rq_private_buf;
559 xs_read_header(transport, buf);
561 want = transport->recv.len - transport->recv.offset;
563 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
564 transport->recv.copied + want,
565 transport->recv.copied,
567 transport->recv.offset += read;
568 transport->recv.copied += read;
571 if (transport->recv.offset == transport->recv.len)
572 xs_read_stream_check_eor(transport, msg);
582 msg->msg_flags |= MSG_TRUNC;
587 return ret < 0 ? ret : read;
591 xs_read_stream_headersize(bool isfrag)
594 return sizeof(__be32);
595 return 3 * sizeof(__be32);
599 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
600 int flags, size_t want, size_t seek)
603 .iov_base = &transport->recv.fraghdr,
606 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
609 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
611 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
613 struct rpc_xprt *xprt = &transport->xprt;
614 struct rpc_rqst *req;
617 /* Is this transport associated with the backchannel? */
621 /* Look up and lock the request corresponding to the given XID */
622 req = xprt_lookup_bc_request(xprt, transport->recv.xid);
624 printk(KERN_WARNING "Callback slot table overflowed\n");
627 if (transport->recv.copied && !req->rq_private_buf.len)
630 ret = xs_read_stream_request(transport, msg, flags, req);
631 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
632 xprt_complete_bc_request(req, transport->recv.copied);
634 req->rq_private_buf.len = transport->recv.copied;
638 #else /* CONFIG_SUNRPC_BACKCHANNEL */
640 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
644 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
647 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
649 struct rpc_xprt *xprt = &transport->xprt;
650 struct rpc_rqst *req;
653 /* Look up and lock the request corresponding to the given XID */
654 spin_lock(&xprt->queue_lock);
655 req = xprt_lookup_rqst(xprt, transport->recv.xid);
656 if (!req || (transport->recv.copied && !req->rq_private_buf.len)) {
657 msg->msg_flags |= MSG_TRUNC;
661 spin_unlock(&xprt->queue_lock);
663 ret = xs_read_stream_request(transport, msg, flags, req);
665 spin_lock(&xprt->queue_lock);
666 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
667 xprt_complete_rqst(req->rq_task, transport->recv.copied);
669 req->rq_private_buf.len = transport->recv.copied;
670 xprt_unpin_rqst(req);
672 spin_unlock(&xprt->queue_lock);
677 xs_read_stream(struct sock_xprt *transport, int flags)
679 struct msghdr msg = { 0 };
680 size_t want, read = 0;
683 if (transport->recv.len == 0) {
684 want = xs_read_stream_headersize(transport->recv.copied != 0);
685 ret = xs_read_stream_header(transport, &msg, flags, want,
686 transport->recv.offset);
689 transport->recv.offset = ret;
690 if (transport->recv.offset != want)
691 return transport->recv.offset;
692 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
693 RPC_FRAGMENT_SIZE_MASK;
694 transport->recv.offset -= sizeof(transport->recv.fraghdr);
698 switch (be32_to_cpu(transport->recv.calldir)) {
700 msg.msg_flags |= MSG_TRUNC;
703 ret = xs_read_stream_call(transport, &msg, flags);
706 ret = xs_read_stream_reply(transport, &msg, flags);
708 if (msg.msg_flags & MSG_TRUNC) {
709 transport->recv.calldir = cpu_to_be32(-1);
710 transport->recv.copied = -1;
715 if (transport->recv.offset < transport->recv.len) {
716 if (!(msg.msg_flags & MSG_TRUNC))
719 ret = xs_read_discard(transport->sock, &msg, flags,
720 transport->recv.len - transport->recv.offset);
723 transport->recv.offset += ret;
725 if (transport->recv.offset != transport->recv.len)
728 if (xs_read_stream_request_done(transport)) {
729 trace_xs_stream_read_request(transport);
730 transport->recv.copied = 0;
732 transport->recv.offset = 0;
733 transport->recv.len = 0;
736 return ret != 0 ? ret : -ESHUTDOWN;
739 static __poll_t xs_poll_socket(struct sock_xprt *transport)
741 return transport->sock->ops->poll(transport->file, transport->sock,
745 static bool xs_poll_socket_readable(struct sock_xprt *transport)
747 __poll_t events = xs_poll_socket(transport);
749 return (events & (EPOLLIN | EPOLLRDNORM)) && !(events & EPOLLRDHUP);
752 static void xs_poll_check_readable(struct sock_xprt *transport)
755 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
756 if (test_bit(XPRT_SOCK_IGNORE_RECV, &transport->sock_state))
758 if (!xs_poll_socket_readable(transport))
760 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
761 queue_work(xprtiod_workqueue, &transport->recv_worker);
764 static void xs_stream_data_receive(struct sock_xprt *transport)
769 mutex_lock(&transport->recv_mutex);
770 if (transport->sock == NULL)
773 ret = xs_read_stream(transport, MSG_DONTWAIT);
779 if (ret == -ESHUTDOWN)
780 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
782 xs_poll_check_readable(transport);
784 mutex_unlock(&transport->recv_mutex);
785 trace_xs_stream_read_data(&transport->xprt, ret, read);
788 static void xs_stream_data_receive_workfn(struct work_struct *work)
790 struct sock_xprt *transport =
791 container_of(work, struct sock_xprt, recv_worker);
792 unsigned int pflags = memalloc_nofs_save();
794 xs_stream_data_receive(transport);
795 memalloc_nofs_restore(pflags);
799 xs_stream_reset_connect(struct sock_xprt *transport)
801 transport->recv.offset = 0;
802 transport->recv.len = 0;
803 transport->recv.copied = 0;
804 transport->xmit.offset = 0;
808 xs_stream_start_connect(struct sock_xprt *transport)
810 transport->xprt.stat.connect_count++;
811 transport->xprt.stat.connect_start = jiffies;
814 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
817 * xs_nospace - handle transmit was incomplete
818 * @req: pointer to RPC request
819 * @transport: pointer to struct sock_xprt
822 static int xs_nospace(struct rpc_rqst *req, struct sock_xprt *transport)
824 struct rpc_xprt *xprt = &transport->xprt;
825 struct sock *sk = transport->inet;
828 trace_rpc_socket_nospace(req, transport);
830 /* Protect against races with write_space */
831 spin_lock(&xprt->transport_lock);
833 /* Don't race with disconnect */
834 if (xprt_connected(xprt)) {
835 /* wait for more buffer space */
836 set_bit(XPRT_SOCK_NOSPACE, &transport->sock_state);
837 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
838 sk->sk_write_pending++;
839 xprt_wait_for_buffer_space(xprt);
843 spin_unlock(&xprt->transport_lock);
847 static int xs_sock_nospace(struct rpc_rqst *req)
849 struct sock_xprt *transport =
850 container_of(req->rq_xprt, struct sock_xprt, xprt);
851 struct sock *sk = transport->inet;
855 if (!sock_writeable(sk))
856 ret = xs_nospace(req, transport);
861 static int xs_stream_nospace(struct rpc_rqst *req, bool vm_wait)
863 struct sock_xprt *transport =
864 container_of(req->rq_xprt, struct sock_xprt, xprt);
865 struct sock *sk = transport->inet;
871 if (!sk_stream_memory_free(sk))
872 ret = xs_nospace(req, transport);
877 static int xs_stream_prepare_request(struct rpc_rqst *req, struct xdr_buf *buf)
879 return xdr_alloc_bvec(buf, rpc_task_gfp_mask());
883 * Determine if the previous message in the stream was aborted before it
884 * could complete transmission.
887 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
889 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
893 * Return the stream record marker field for a record of length < 2^31-1
896 xs_stream_record_marker(struct xdr_buf *xdr)
900 return cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | (u32)xdr->len);
904 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
905 * @req: pointer to RPC request
908 * 0: The request has been sent
909 * EAGAIN: The socket was blocked, please call again later to
910 * complete the request
911 * ENOTCONN: Caller needs to invoke connect logic then call again
912 * other: Some other error occurred, the request was not sent
914 static int xs_local_send_request(struct rpc_rqst *req)
916 struct rpc_xprt *xprt = req->rq_xprt;
917 struct sock_xprt *transport =
918 container_of(xprt, struct sock_xprt, xprt);
919 struct xdr_buf *xdr = &req->rq_snd_buf;
920 rpc_fraghdr rm = xs_stream_record_marker(xdr);
921 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
922 struct msghdr msg = {
923 .msg_flags = XS_SENDMSG_FLAGS,
929 /* Close the stream if the previous transmission was incomplete */
930 if (xs_send_request_was_aborted(transport, req)) {
931 xprt_force_disconnect(xprt);
935 xs_pktdump("packet data:",
936 req->rq_svec->iov_base, req->rq_svec->iov_len);
938 vm_wait = sk_stream_is_writeable(transport->inet) ? true : false;
940 req->rq_xtime = ktime_get();
941 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
942 transport->xmit.offset, rm, &sent);
943 dprintk("RPC: %s(%u) = %d\n",
944 __func__, xdr->len - transport->xmit.offset, status);
946 if (likely(sent > 0) || status == 0) {
947 transport->xmit.offset += sent;
948 req->rq_bytes_sent = transport->xmit.offset;
949 if (likely(req->rq_bytes_sent >= msglen)) {
950 req->rq_xmit_bytes_sent += transport->xmit.offset;
951 transport->xmit.offset = 0;
960 status = xs_stream_nospace(req, vm_wait);
963 dprintk("RPC: sendmsg returned unrecognized error %d\n",
967 xprt_force_disconnect(xprt);
975 * xs_udp_send_request - write an RPC request to a UDP socket
976 * @req: pointer to RPC request
979 * 0: The request has been sent
980 * EAGAIN: The socket was blocked, please call again later to
981 * complete the request
982 * ENOTCONN: Caller needs to invoke connect logic then call again
983 * other: Some other error occurred, the request was not sent
985 static int xs_udp_send_request(struct rpc_rqst *req)
987 struct rpc_xprt *xprt = req->rq_xprt;
988 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
989 struct xdr_buf *xdr = &req->rq_snd_buf;
990 struct msghdr msg = {
991 .msg_name = xs_addr(xprt),
992 .msg_namelen = xprt->addrlen,
993 .msg_flags = XS_SENDMSG_FLAGS,
998 xs_pktdump("packet data:",
999 req->rq_svec->iov_base,
1000 req->rq_svec->iov_len);
1002 if (!xprt_bound(xprt))
1005 if (!xprt_request_get_cong(xprt, req))
1008 status = xdr_alloc_bvec(xdr, rpc_task_gfp_mask());
1011 req->rq_xtime = ktime_get();
1012 status = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, 0, &sent);
1014 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
1017 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
1018 if (status == -EPERM)
1019 goto process_status;
1021 if (status == -EAGAIN && sock_writeable(transport->inet))
1024 if (sent > 0 || status == 0) {
1025 req->rq_xmit_bytes_sent += sent;
1026 if (sent >= req->rq_slen)
1028 /* Still some bytes left; set up for a retry later. */
1036 /* Should we call xs_close() here? */
1039 status = xs_sock_nospace(req);
1046 /* When the server has died, an ICMP port unreachable message
1047 * prompts ECONNREFUSED. */
1050 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1058 * xs_tcp_send_request - write an RPC request to a TCP socket
1059 * @req: pointer to RPC request
1062 * 0: The request has been sent
1063 * EAGAIN: The socket was blocked, please call again later to
1064 * complete the request
1065 * ENOTCONN: Caller needs to invoke connect logic then call again
1066 * other: Some other error occurred, the request was not sent
1068 * XXX: In the case of soft timeouts, should we eventually give up
1069 * if sendmsg is not able to make progress?
1071 static int xs_tcp_send_request(struct rpc_rqst *req)
1073 struct rpc_xprt *xprt = req->rq_xprt;
1074 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1075 struct xdr_buf *xdr = &req->rq_snd_buf;
1076 rpc_fraghdr rm = xs_stream_record_marker(xdr);
1077 unsigned int msglen = rm ? req->rq_slen + sizeof(rm) : req->rq_slen;
1078 struct msghdr msg = {
1079 .msg_flags = XS_SENDMSG_FLAGS,
1085 /* Close the stream if the previous transmission was incomplete */
1086 if (xs_send_request_was_aborted(transport, req)) {
1087 if (transport->sock != NULL)
1088 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1091 if (!transport->inet)
1094 xs_pktdump("packet data:",
1095 req->rq_svec->iov_base,
1096 req->rq_svec->iov_len);
1098 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1099 xs_tcp_set_socket_timeouts(xprt, transport->sock);
1101 xs_set_srcport(transport, transport->sock);
1103 /* Continue transmitting the packet/record. We must be careful
1104 * to cope with writespace callbacks arriving _after_ we have
1105 * called sendmsg(). */
1106 req->rq_xtime = ktime_get();
1107 tcp_sock_set_cork(transport->inet, true);
1109 vm_wait = sk_stream_is_writeable(transport->inet) ? true : false;
1112 status = xprt_sock_sendmsg(transport->sock, &msg, xdr,
1113 transport->xmit.offset, rm, &sent);
1115 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
1116 xdr->len - transport->xmit.offset, status);
1118 /* If we've sent the entire packet, immediately
1119 * reset the count of bytes sent. */
1120 transport->xmit.offset += sent;
1121 req->rq_bytes_sent = transport->xmit.offset;
1122 if (likely(req->rq_bytes_sent >= msglen)) {
1123 req->rq_xmit_bytes_sent += transport->xmit.offset;
1124 transport->xmit.offset = 0;
1125 if (atomic_long_read(&xprt->xmit_queuelen) == 1)
1126 tcp_sock_set_cork(transport->inet, false);
1130 WARN_ON_ONCE(sent == 0 && status == 0);
1135 } while (status == 0);
1140 /* Should we call xs_close() here? */
1143 status = xs_stream_nospace(req, vm_wait);
1153 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1160 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1162 transport->old_data_ready = sk->sk_data_ready;
1163 transport->old_state_change = sk->sk_state_change;
1164 transport->old_write_space = sk->sk_write_space;
1165 transport->old_error_report = sk->sk_error_report;
1168 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1170 sk->sk_data_ready = transport->old_data_ready;
1171 sk->sk_state_change = transport->old_state_change;
1172 sk->sk_write_space = transport->old_write_space;
1173 sk->sk_error_report = transport->old_error_report;
1176 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1178 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1180 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1181 clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state);
1182 clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state);
1183 clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state);
1184 clear_bit(XPRT_SOCK_NOSPACE, &transport->sock_state);
1187 static void xs_run_error_worker(struct sock_xprt *transport, unsigned int nr)
1189 set_bit(nr, &transport->sock_state);
1190 queue_work(xprtiod_workqueue, &transport->error_worker);
1193 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1195 xprt->connect_cookie++;
1196 smp_mb__before_atomic();
1197 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1198 clear_bit(XPRT_CLOSING, &xprt->state);
1199 xs_sock_reset_state_flags(xprt);
1200 smp_mb__after_atomic();
1204 * xs_error_report - callback to handle TCP socket state errors
1207 * Note: we don't call sock_error() since there may be a rpc_task
1208 * using the socket, and so we don't want to clear sk->sk_err.
1210 static void xs_error_report(struct sock *sk)
1212 struct sock_xprt *transport;
1213 struct rpc_xprt *xprt;
1215 if (!(xprt = xprt_from_sock(sk)))
1218 transport = container_of(xprt, struct sock_xprt, xprt);
1219 transport->xprt_err = -sk->sk_err;
1220 if (transport->xprt_err == 0)
1222 dprintk("RPC: xs_error_report client %p, error=%d...\n",
1223 xprt, -transport->xprt_err);
1224 trace_rpc_socket_error(xprt, sk->sk_socket, transport->xprt_err);
1226 /* barrier ensures xprt_err is set before XPRT_SOCK_WAKE_ERROR */
1227 smp_mb__before_atomic();
1228 xs_run_error_worker(transport, XPRT_SOCK_WAKE_ERROR);
1231 static void xs_reset_transport(struct sock_xprt *transport)
1233 struct socket *sock = transport->sock;
1234 struct sock *sk = transport->inet;
1235 struct rpc_xprt *xprt = &transport->xprt;
1236 struct file *filp = transport->file;
1241 * Make sure we're calling this in a context from which it is safe
1242 * to call __fput_sync(). In practice that means rpciod and the
1245 if (!(current->flags & PF_WQ_WORKER)) {
1247 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
1251 if (atomic_read(&transport->xprt.swapper))
1252 sk_clear_memalloc(sk);
1254 tls_handshake_cancel(sk);
1256 kernel_sock_shutdown(sock, SHUT_RDWR);
1258 mutex_lock(&transport->recv_mutex);
1260 transport->inet = NULL;
1261 transport->sock = NULL;
1262 transport->file = NULL;
1264 sk->sk_user_data = NULL;
1266 xs_restore_old_callbacks(transport, sk);
1267 xprt_clear_connected(xprt);
1268 xs_sock_reset_connection_flags(xprt);
1269 /* Reset stream record info */
1270 xs_stream_reset_connect(transport);
1272 mutex_unlock(&transport->recv_mutex);
1274 trace_rpc_socket_close(xprt, sock);
1277 xprt_disconnect_done(xprt);
1281 * xs_close - close a socket
1284 * This is used when all requests are complete; ie, no DRC state remains
1285 * on the server we want to save.
1287 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1288 * xs_reset_transport() zeroing the socket from underneath a writer.
1290 static void xs_close(struct rpc_xprt *xprt)
1292 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1294 dprintk("RPC: xs_close xprt %p\n", xprt);
1296 xs_reset_transport(transport);
1297 xprt->reestablish_timeout = 0;
1300 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1302 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
1304 xprt_disconnect_done(xprt);
1307 static void xs_xprt_free(struct rpc_xprt *xprt)
1309 xs_free_peer_addresses(xprt);
1314 * xs_destroy - prepare to shutdown a transport
1315 * @xprt: doomed transport
1318 static void xs_destroy(struct rpc_xprt *xprt)
1320 struct sock_xprt *transport = container_of(xprt,
1321 struct sock_xprt, xprt);
1322 dprintk("RPC: xs_destroy xprt %p\n", xprt);
1324 cancel_delayed_work_sync(&transport->connect_worker);
1326 cancel_work_sync(&transport->recv_worker);
1327 cancel_work_sync(&transport->error_worker);
1329 module_put(THIS_MODULE);
1333 * xs_udp_data_read_skb - receive callback for UDP sockets
1339 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1341 struct sk_buff *skb)
1343 struct rpc_task *task;
1344 struct rpc_rqst *rovr;
1345 int repsize, copied;
1351 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1355 /* Copy the XID from the skb... */
1356 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1360 /* Look up and lock the request corresponding to the given XID */
1361 spin_lock(&xprt->queue_lock);
1362 rovr = xprt_lookup_rqst(xprt, *xp);
1365 xprt_pin_rqst(rovr);
1366 xprt_update_rtt(rovr->rq_task);
1367 spin_unlock(&xprt->queue_lock);
1368 task = rovr->rq_task;
1370 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1373 /* Suck it into the iovec, verify checksum if not done by hw. */
1374 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1375 spin_lock(&xprt->queue_lock);
1376 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1381 spin_lock(&xprt->transport_lock);
1382 xprt_adjust_cwnd(xprt, task, copied);
1383 spin_unlock(&xprt->transport_lock);
1384 spin_lock(&xprt->queue_lock);
1385 xprt_complete_rqst(task, copied);
1386 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1388 xprt_unpin_rqst(rovr);
1390 spin_unlock(&xprt->queue_lock);
1393 static void xs_udp_data_receive(struct sock_xprt *transport)
1395 struct sk_buff *skb;
1399 mutex_lock(&transport->recv_mutex);
1400 sk = transport->inet;
1404 skb = skb_recv_udp(sk, MSG_DONTWAIT, &err);
1407 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1411 xs_poll_check_readable(transport);
1413 mutex_unlock(&transport->recv_mutex);
1416 static void xs_udp_data_receive_workfn(struct work_struct *work)
1418 struct sock_xprt *transport =
1419 container_of(work, struct sock_xprt, recv_worker);
1420 unsigned int pflags = memalloc_nofs_save();
1422 xs_udp_data_receive(transport);
1423 memalloc_nofs_restore(pflags);
1427 * xs_data_ready - "data ready" callback for sockets
1428 * @sk: socket with data to read
1431 static void xs_data_ready(struct sock *sk)
1433 struct rpc_xprt *xprt;
1435 trace_sk_data_ready(sk);
1437 xprt = xprt_from_sock(sk);
1439 struct sock_xprt *transport = container_of(xprt,
1440 struct sock_xprt, xprt);
1442 trace_xs_data_ready(xprt);
1444 transport->old_data_ready(sk);
1446 if (test_bit(XPRT_SOCK_IGNORE_RECV, &transport->sock_state))
1449 /* Any data means we had a useful conversation, so
1450 * then we don't need to delay the next reconnect
1452 if (xprt->reestablish_timeout)
1453 xprt->reestablish_timeout = 0;
1454 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1455 queue_work(xprtiod_workqueue, &transport->recv_worker);
1460 * Helper function to force a TCP close if the server is sending
1461 * junk and/or it has put us in CLOSE_WAIT
1463 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1465 xprt_force_disconnect(xprt);
1468 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1469 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1473 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1476 * xs_local_state_change - callback to handle AF_LOCAL socket state changes
1477 * @sk: socket whose state has changed
1480 static void xs_local_state_change(struct sock *sk)
1482 struct rpc_xprt *xprt;
1483 struct sock_xprt *transport;
1485 if (!(xprt = xprt_from_sock(sk)))
1487 transport = container_of(xprt, struct sock_xprt, xprt);
1488 if (sk->sk_shutdown & SHUTDOWN_MASK) {
1489 clear_bit(XPRT_CONNECTED, &xprt->state);
1490 /* Trigger the socket release */
1491 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1496 * xs_tcp_state_change - callback to handle TCP socket state changes
1497 * @sk: socket whose state has changed
1500 static void xs_tcp_state_change(struct sock *sk)
1502 struct rpc_xprt *xprt;
1503 struct sock_xprt *transport;
1505 if (!(xprt = xprt_from_sock(sk)))
1507 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1508 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1509 sk->sk_state, xprt_connected(xprt),
1510 sock_flag(sk, SOCK_DEAD),
1511 sock_flag(sk, SOCK_ZAPPED),
1514 transport = container_of(xprt, struct sock_xprt, xprt);
1515 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1516 switch (sk->sk_state) {
1517 case TCP_ESTABLISHED:
1518 if (!xprt_test_and_set_connected(xprt)) {
1519 xprt->connect_cookie++;
1520 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1521 xprt_clear_connecting(xprt);
1523 xprt->stat.connect_count++;
1524 xprt->stat.connect_time += (long)jiffies -
1525 xprt->stat.connect_start;
1526 xs_run_error_worker(transport, XPRT_SOCK_WAKE_PENDING);
1530 /* The client initiated a shutdown of the socket */
1531 xprt->connect_cookie++;
1532 xprt->reestablish_timeout = 0;
1533 set_bit(XPRT_CLOSING, &xprt->state);
1534 smp_mb__before_atomic();
1535 clear_bit(XPRT_CONNECTED, &xprt->state);
1536 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1537 smp_mb__after_atomic();
1539 case TCP_CLOSE_WAIT:
1540 /* The server initiated a shutdown of the socket */
1541 xprt->connect_cookie++;
1542 clear_bit(XPRT_CONNECTED, &xprt->state);
1543 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1547 * If the server closed down the connection, make sure that
1548 * we back off before reconnecting
1550 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1551 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1554 set_bit(XPRT_CLOSING, &xprt->state);
1555 smp_mb__before_atomic();
1556 clear_bit(XPRT_CONNECTED, &xprt->state);
1557 smp_mb__after_atomic();
1560 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1561 &transport->sock_state))
1562 xprt_clear_connecting(xprt);
1563 clear_bit(XPRT_CLOSING, &xprt->state);
1564 /* Trigger the socket release */
1565 xs_run_error_worker(transport, XPRT_SOCK_WAKE_DISCONNECT);
1569 static void xs_write_space(struct sock *sk)
1571 struct sock_xprt *transport;
1572 struct rpc_xprt *xprt;
1576 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1578 if (unlikely(!(xprt = xprt_from_sock(sk))))
1580 transport = container_of(xprt, struct sock_xprt, xprt);
1581 if (!test_and_clear_bit(XPRT_SOCK_NOSPACE, &transport->sock_state))
1583 xs_run_error_worker(transport, XPRT_SOCK_WAKE_WRITE);
1584 sk->sk_write_pending--;
1588 * xs_udp_write_space - callback invoked when socket buffer space
1590 * @sk: socket whose state has changed
1592 * Called when more output buffer space is available for this socket.
1593 * We try not to wake our writers until they can make "significant"
1594 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1595 * with a bunch of small requests.
1597 static void xs_udp_write_space(struct sock *sk)
1599 /* from net/core/sock.c:sock_def_write_space */
1600 if (sock_writeable(sk))
1605 * xs_tcp_write_space - callback invoked when socket buffer space
1607 * @sk: socket whose state has changed
1609 * Called when more output buffer space is available for this socket.
1610 * We try not to wake our writers until they can make "significant"
1611 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1612 * with a bunch of small requests.
1614 static void xs_tcp_write_space(struct sock *sk)
1616 /* from net/core/stream.c:sk_stream_write_space */
1617 if (sk_stream_is_writeable(sk))
1621 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1623 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1624 struct sock *sk = transport->inet;
1626 if (transport->rcvsize) {
1627 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1628 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1630 if (transport->sndsize) {
1631 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1632 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1633 sk->sk_write_space(sk);
1638 * xs_udp_set_buffer_size - set send and receive limits
1639 * @xprt: generic transport
1640 * @sndsize: requested size of send buffer, in bytes
1641 * @rcvsize: requested size of receive buffer, in bytes
1643 * Set socket send and receive buffer size limits.
1645 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1647 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1649 transport->sndsize = 0;
1651 transport->sndsize = sndsize + 1024;
1652 transport->rcvsize = 0;
1654 transport->rcvsize = rcvsize + 1024;
1656 xs_udp_do_set_buffer_size(xprt);
1660 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1661 * @xprt: controlling transport
1662 * @task: task that timed out
1664 * Adjust the congestion window after a retransmit timeout has occurred.
1666 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1668 spin_lock(&xprt->transport_lock);
1669 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1670 spin_unlock(&xprt->transport_lock);
1673 static int xs_get_random_port(void)
1675 unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1676 unsigned short range;
1677 unsigned short rand;
1681 range = max - min + 1;
1682 rand = get_random_u32_below(range);
1686 static unsigned short xs_sock_getport(struct socket *sock)
1688 struct sockaddr_storage buf;
1689 unsigned short port = 0;
1691 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1693 switch (buf.ss_family) {
1695 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1698 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1705 * xs_set_port - reset the port number in the remote endpoint address
1706 * @xprt: generic transport
1707 * @port: new port number
1710 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1712 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1714 rpc_set_port(xs_addr(xprt), port);
1715 xs_update_peer_port(xprt);
1718 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1720 if (transport->srcport == 0 && transport->xprt.reuseport)
1721 transport->srcport = xs_sock_getport(sock);
1724 static int xs_get_srcport(struct sock_xprt *transport)
1726 int port = transport->srcport;
1728 if (port == 0 && transport->xprt.resvport)
1729 port = xs_get_random_port();
1733 static unsigned short xs_sock_srcport(struct rpc_xprt *xprt)
1735 struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1736 unsigned short ret = 0;
1737 mutex_lock(&sock->recv_mutex);
1739 ret = xs_sock_getport(sock->sock);
1740 mutex_unlock(&sock->recv_mutex);
1744 static int xs_sock_srcaddr(struct rpc_xprt *xprt, char *buf, size_t buflen)
1746 struct sock_xprt *sock = container_of(xprt, struct sock_xprt, xprt);
1749 struct sockaddr_storage st;
1751 int ret = -ENOTCONN;
1753 mutex_lock(&sock->recv_mutex);
1755 ret = kernel_getsockname(sock->sock, &saddr.sa);
1757 ret = snprintf(buf, buflen, "%pISc", &saddr.sa);
1759 mutex_unlock(&sock->recv_mutex);
1763 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1765 if (transport->srcport != 0)
1766 transport->srcport = 0;
1767 if (!transport->xprt.resvport)
1769 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1770 return xprt_max_resvport;
1773 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1775 struct sockaddr_storage myaddr;
1777 int port = xs_get_srcport(transport);
1778 unsigned short last;
1781 * If we are asking for any ephemeral port (i.e. port == 0 &&
1782 * transport->xprt.resvport == 0), don't bind. Let the local
1783 * port selection happen implicitly when the socket is used
1784 * (for example at connect time).
1786 * This ensures that we can continue to establish TCP
1787 * connections even when all local ephemeral ports are already
1788 * a part of some TCP connection. This makes no difference
1789 * for UDP sockets, but also doesn't harm them.
1791 * If we're asking for any reserved port (i.e. port == 0 &&
1792 * transport->xprt.resvport == 1) xs_get_srcport above will
1793 * ensure that port is non-zero and we will bind as needed.
1798 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1800 rpc_set_port((struct sockaddr *)&myaddr, port);
1801 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1802 transport->xprt.addrlen);
1804 if (transport->xprt.reuseport)
1805 transport->srcport = port;
1809 port = xs_next_srcport(transport, port);
1812 } while (err == -EADDRINUSE && nloop != 2);
1814 if (myaddr.ss_family == AF_INET)
1815 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1816 &((struct sockaddr_in *)&myaddr)->sin_addr,
1817 port, err ? "failed" : "ok", err);
1819 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1820 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1821 port, err ? "failed" : "ok", err);
1826 * We don't support autobind on AF_LOCAL sockets
1828 static void xs_local_rpcbind(struct rpc_task *task)
1830 xprt_set_bound(task->tk_xprt);
1833 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1837 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1838 static struct lock_class_key xs_key[3];
1839 static struct lock_class_key xs_slock_key[3];
1841 static inline void xs_reclassify_socketu(struct socket *sock)
1843 struct sock *sk = sock->sk;
1845 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1846 &xs_slock_key[0], "sk_lock-AF_LOCAL-RPC", &xs_key[0]);
1849 static inline void xs_reclassify_socket4(struct socket *sock)
1851 struct sock *sk = sock->sk;
1853 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1854 &xs_slock_key[1], "sk_lock-AF_INET-RPC", &xs_key[1]);
1857 static inline void xs_reclassify_socket6(struct socket *sock)
1859 struct sock *sk = sock->sk;
1861 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1862 &xs_slock_key[2], "sk_lock-AF_INET6-RPC", &xs_key[2]);
1865 static inline void xs_reclassify_socket(int family, struct socket *sock)
1867 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1872 xs_reclassify_socketu(sock);
1875 xs_reclassify_socket4(sock);
1878 xs_reclassify_socket6(sock);
1883 static inline void xs_reclassify_socket(int family, struct socket *sock)
1888 static void xs_dummy_setup_socket(struct work_struct *work)
1892 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1893 struct sock_xprt *transport, int family, int type,
1894 int protocol, bool reuseport)
1897 struct socket *sock;
1900 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1902 dprintk("RPC: can't create %d transport socket (%d).\n",
1906 xs_reclassify_socket(family, sock);
1909 sock_set_reuseport(sock->sk);
1911 err = xs_bind(transport, sock);
1917 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1919 return ERR_CAST(filp);
1920 transport->file = filp;
1924 return ERR_PTR(err);
1927 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1928 struct socket *sock)
1930 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1933 if (!transport->inet) {
1934 struct sock *sk = sock->sk;
1938 xs_save_old_callbacks(transport, sk);
1940 sk->sk_user_data = xprt;
1941 sk->sk_data_ready = xs_data_ready;
1942 sk->sk_write_space = xs_udp_write_space;
1943 sk->sk_state_change = xs_local_state_change;
1944 sk->sk_error_report = xs_error_report;
1945 sk->sk_use_task_frag = false;
1947 xprt_clear_connected(xprt);
1949 /* Reset to new socket */
1950 transport->sock = sock;
1951 transport->inet = sk;
1956 xs_stream_start_connect(transport);
1958 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1962 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1963 * @transport: socket transport to connect
1965 static int xs_local_setup_socket(struct sock_xprt *transport)
1967 struct rpc_xprt *xprt = &transport->xprt;
1969 struct socket *sock;
1972 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1973 SOCK_STREAM, 0, &sock, 1);
1975 dprintk("RPC: can't create AF_LOCAL "
1976 "transport socket (%d).\n", -status);
1979 xs_reclassify_socket(AF_LOCAL, sock);
1981 filp = sock_alloc_file(sock, O_NONBLOCK, NULL);
1983 status = PTR_ERR(filp);
1986 transport->file = filp;
1988 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1989 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1991 status = xs_local_finish_connecting(xprt, sock);
1992 trace_rpc_socket_connect(xprt, sock, status);
1995 dprintk("RPC: xprt %p connected to %s\n",
1996 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1997 xprt->stat.connect_count++;
1998 xprt->stat.connect_time += (long)jiffies -
1999 xprt->stat.connect_start;
2000 xprt_set_connected(xprt);
2005 dprintk("RPC: xprt %p: socket %s does not exist\n",
2006 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2009 dprintk("RPC: xprt %p: connection refused for %s\n",
2010 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2013 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
2015 xprt->address_strings[RPC_DISPLAY_ADDR]);
2019 xprt_clear_connecting(xprt);
2020 xprt_wake_pending_tasks(xprt, status);
2024 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2026 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2029 if (transport->file)
2030 goto force_disconnect;
2032 if (RPC_IS_ASYNC(task)) {
2034 * We want the AF_LOCAL connect to be resolved in the
2035 * filesystem namespace of the process making the rpc
2036 * call. Thus we connect synchronously.
2038 * If we want to support asynchronous AF_LOCAL calls,
2039 * we'll need to figure out how to pass a namespace to
2042 rpc_task_set_rpc_status(task, -ENOTCONN);
2045 ret = xs_local_setup_socket(transport);
2046 if (ret && !RPC_IS_SOFTCONN(task))
2047 msleep_interruptible(15000);
2050 xprt_force_disconnect(xprt);
2052 xprt_clear_connecting(xprt);
2053 xprt_wake_pending_tasks(xprt, -ENOTCONN);
2056 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2058 * Note that this should be called with XPRT_LOCKED held, or recv_mutex
2059 * held, or when we otherwise know that we have exclusive access to the
2060 * socket, to guard against races with xs_reset_transport.
2062 static void xs_set_memalloc(struct rpc_xprt *xprt)
2064 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
2068 * If there's no sock, then we have nothing to set. The
2069 * reconnecting process will get it for us.
2071 if (!transport->inet)
2073 if (atomic_read(&xprt->swapper))
2074 sk_set_memalloc(transport->inet);
2078 * xs_enable_swap - Tag this transport as being used for swap.
2079 * @xprt: transport to tag
2081 * Take a reference to this transport on behalf of the rpc_clnt, and
2082 * optionally mark it for swapping if it wasn't already.
2085 xs_enable_swap(struct rpc_xprt *xprt)
2087 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2089 mutex_lock(&xs->recv_mutex);
2090 if (atomic_inc_return(&xprt->swapper) == 1 &&
2092 sk_set_memalloc(xs->inet);
2093 mutex_unlock(&xs->recv_mutex);
2098 * xs_disable_swap - Untag this transport as being used for swap.
2099 * @xprt: transport to tag
2101 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2102 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2105 xs_disable_swap(struct rpc_xprt *xprt)
2107 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2109 mutex_lock(&xs->recv_mutex);
2110 if (atomic_dec_and_test(&xprt->swapper) &&
2112 sk_clear_memalloc(xs->inet);
2113 mutex_unlock(&xs->recv_mutex);
2116 static void xs_set_memalloc(struct rpc_xprt *xprt)
2121 xs_enable_swap(struct rpc_xprt *xprt)
2127 xs_disable_swap(struct rpc_xprt *xprt)
2132 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2134 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2136 if (!transport->inet) {
2137 struct sock *sk = sock->sk;
2141 xs_save_old_callbacks(transport, sk);
2143 sk->sk_user_data = xprt;
2144 sk->sk_data_ready = xs_data_ready;
2145 sk->sk_write_space = xs_udp_write_space;
2146 sk->sk_use_task_frag = false;
2148 xprt_set_connected(xprt);
2150 /* Reset to new socket */
2151 transport->sock = sock;
2152 transport->inet = sk;
2154 xs_set_memalloc(xprt);
2158 xs_udp_do_set_buffer_size(xprt);
2160 xprt->stat.connect_start = jiffies;
2163 static void xs_udp_setup_socket(struct work_struct *work)
2165 struct sock_xprt *transport =
2166 container_of(work, struct sock_xprt, connect_worker.work);
2167 struct rpc_xprt *xprt = &transport->xprt;
2168 struct socket *sock;
2170 unsigned int pflags = current->flags;
2172 if (atomic_read(&xprt->swapper))
2173 current->flags |= PF_MEMALLOC;
2174 sock = xs_create_sock(xprt, transport,
2175 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2176 IPPROTO_UDP, false);
2180 dprintk("RPC: worker connecting xprt %p via %s to "
2181 "%s (port %s)\n", xprt,
2182 xprt->address_strings[RPC_DISPLAY_PROTO],
2183 xprt->address_strings[RPC_DISPLAY_ADDR],
2184 xprt->address_strings[RPC_DISPLAY_PORT]);
2186 xs_udp_finish_connecting(xprt, sock);
2187 trace_rpc_socket_connect(xprt, sock, 0);
2190 xprt_clear_connecting(xprt);
2191 xprt_unlock_connect(xprt, transport);
2192 xprt_wake_pending_tasks(xprt, status);
2193 current_restore_flags(pflags, PF_MEMALLOC);
2197 * xs_tcp_shutdown - gracefully shut down a TCP socket
2200 * Initiates a graceful shutdown of the TCP socket by calling the
2201 * equivalent of shutdown(SHUT_RDWR);
2203 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2205 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2206 struct socket *sock = transport->sock;
2207 int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE;
2211 if (!xprt->reuseport) {
2220 case TCP_ESTABLISHED:
2221 case TCP_CLOSE_WAIT:
2222 kernel_sock_shutdown(sock, SHUT_RDWR);
2223 trace_rpc_socket_shutdown(xprt, sock);
2226 xs_reset_transport(transport);
2230 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2231 struct socket *sock)
2233 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2234 unsigned int keepidle;
2235 unsigned int keepcnt;
2238 spin_lock(&xprt->transport_lock);
2239 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2240 keepcnt = xprt->timeout->to_retries + 1;
2241 timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2242 (xprt->timeout->to_retries + 1);
2243 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2244 spin_unlock(&xprt->transport_lock);
2246 /* TCP Keepalive options */
2247 sock_set_keepalive(sock->sk);
2248 tcp_sock_set_keepidle(sock->sk, keepidle);
2249 tcp_sock_set_keepintvl(sock->sk, keepidle);
2250 tcp_sock_set_keepcnt(sock->sk, keepcnt);
2252 /* TCP user timeout (see RFC5482) */
2253 tcp_sock_set_user_timeout(sock->sk, timeo);
2256 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2257 unsigned long connect_timeout,
2258 unsigned long reconnect_timeout)
2260 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2261 struct rpc_timeout to;
2262 unsigned long initval;
2264 spin_lock(&xprt->transport_lock);
2265 if (reconnect_timeout < xprt->max_reconnect_timeout)
2266 xprt->max_reconnect_timeout = reconnect_timeout;
2267 if (connect_timeout < xprt->connect_timeout) {
2268 memcpy(&to, xprt->timeout, sizeof(to));
2269 initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1);
2270 /* Arbitrary lower limit */
2271 if (initval < XS_TCP_INIT_REEST_TO << 1)
2272 initval = XS_TCP_INIT_REEST_TO << 1;
2273 to.to_initval = initval;
2274 to.to_maxval = initval;
2275 memcpy(&transport->tcp_timeout, &to,
2276 sizeof(transport->tcp_timeout));
2277 xprt->timeout = &transport->tcp_timeout;
2278 xprt->connect_timeout = connect_timeout;
2280 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2281 spin_unlock(&xprt->transport_lock);
2284 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2286 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2288 if (!transport->inet) {
2289 struct sock *sk = sock->sk;
2291 /* Avoid temporary address, they are bad for long-lived
2292 * connections such as NFS mounts.
2293 * RFC4941, section 3.6 suggests that:
2294 * Individual applications, which have specific
2295 * knowledge about the normal duration of connections,
2296 * MAY override this as appropriate.
2298 if (xs_addr(xprt)->sa_family == PF_INET6) {
2299 ip6_sock_set_addr_preferences(sk,
2300 IPV6_PREFER_SRC_PUBLIC);
2303 xs_tcp_set_socket_timeouts(xprt, sock);
2304 tcp_sock_set_nodelay(sk);
2308 xs_save_old_callbacks(transport, sk);
2310 sk->sk_user_data = xprt;
2311 sk->sk_data_ready = xs_data_ready;
2312 sk->sk_state_change = xs_tcp_state_change;
2313 sk->sk_write_space = xs_tcp_write_space;
2314 sk->sk_error_report = xs_error_report;
2315 sk->sk_use_task_frag = false;
2317 /* socket options */
2318 sock_reset_flag(sk, SOCK_LINGER);
2320 xprt_clear_connected(xprt);
2322 /* Reset to new socket */
2323 transport->sock = sock;
2324 transport->inet = sk;
2329 if (!xprt_bound(xprt))
2332 xs_set_memalloc(xprt);
2334 xs_stream_start_connect(transport);
2336 /* Tell the socket layer to start connecting... */
2337 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2338 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2342 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2343 * @work: queued work item
2345 * Invoked by a work queue tasklet.
2347 static void xs_tcp_setup_socket(struct work_struct *work)
2349 struct sock_xprt *transport =
2350 container_of(work, struct sock_xprt, connect_worker.work);
2351 struct socket *sock = transport->sock;
2352 struct rpc_xprt *xprt = &transport->xprt;
2354 unsigned int pflags = current->flags;
2356 if (atomic_read(&xprt->swapper))
2357 current->flags |= PF_MEMALLOC;
2359 if (xprt_connected(xprt))
2361 if (test_and_clear_bit(XPRT_SOCK_CONNECT_SENT,
2362 &transport->sock_state) ||
2364 xs_reset_transport(transport);
2365 sock = xs_create_sock(xprt, transport, xs_addr(xprt)->sa_family,
2366 SOCK_STREAM, IPPROTO_TCP, true);
2368 xprt_wake_pending_tasks(xprt, PTR_ERR(sock));
2373 dprintk("RPC: worker connecting xprt %p via %s to "
2374 "%s (port %s)\n", xprt,
2375 xprt->address_strings[RPC_DISPLAY_PROTO],
2376 xprt->address_strings[RPC_DISPLAY_ADDR],
2377 xprt->address_strings[RPC_DISPLAY_PORT]);
2379 status = xs_tcp_finish_connecting(xprt, sock);
2380 trace_rpc_socket_connect(xprt, sock, status);
2381 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2382 xprt, -status, xprt_connected(xprt),
2383 sock->sk->sk_state);
2388 set_bit(XPRT_SOCK_CONNECT_SENT, &transport->sock_state);
2389 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2390 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2394 case -EADDRNOTAVAIL:
2395 /* Source port number is unavailable. Try a new one! */
2396 transport->srcport = 0;
2400 /* Happens, for instance, if the user specified a link
2401 * local IPv6 address without a scope-id.
2412 printk("%s: connect returned unhandled error %d\n",
2417 /* xs_tcp_force_close() wakes tasks with a fixed error code.
2418 * We need to wake them first to ensure the correct error code.
2420 xprt_wake_pending_tasks(xprt, status);
2421 xs_tcp_force_close(xprt);
2423 xprt_clear_connecting(xprt);
2425 xprt_unlock_connect(xprt, transport);
2426 current_restore_flags(pflags, PF_MEMALLOC);
2430 * Transfer the connected socket to @upper_transport, then mark that
2433 static int xs_tcp_tls_finish_connecting(struct rpc_xprt *lower_xprt,
2434 struct sock_xprt *upper_transport)
2436 struct sock_xprt *lower_transport =
2437 container_of(lower_xprt, struct sock_xprt, xprt);
2438 struct rpc_xprt *upper_xprt = &upper_transport->xprt;
2440 if (!upper_transport->inet) {
2441 struct socket *sock = lower_transport->sock;
2442 struct sock *sk = sock->sk;
2444 /* Avoid temporary address, they are bad for long-lived
2445 * connections such as NFS mounts.
2446 * RFC4941, section 3.6 suggests that:
2447 * Individual applications, which have specific
2448 * knowledge about the normal duration of connections,
2449 * MAY override this as appropriate.
2451 if (xs_addr(upper_xprt)->sa_family == PF_INET6)
2452 ip6_sock_set_addr_preferences(sk, IPV6_PREFER_SRC_PUBLIC);
2454 xs_tcp_set_socket_timeouts(upper_xprt, sock);
2455 tcp_sock_set_nodelay(sk);
2459 /* @sk is already connected, so it now has the RPC callbacks.
2460 * Reach into @lower_transport to save the original ones.
2462 upper_transport->old_data_ready = lower_transport->old_data_ready;
2463 upper_transport->old_state_change = lower_transport->old_state_change;
2464 upper_transport->old_write_space = lower_transport->old_write_space;
2465 upper_transport->old_error_report = lower_transport->old_error_report;
2466 sk->sk_user_data = upper_xprt;
2468 /* socket options */
2469 sock_reset_flag(sk, SOCK_LINGER);
2471 xprt_clear_connected(upper_xprt);
2473 upper_transport->sock = sock;
2474 upper_transport->inet = sk;
2475 upper_transport->file = lower_transport->file;
2479 /* Reset lower_transport before shutting down its clnt */
2480 mutex_lock(&lower_transport->recv_mutex);
2481 lower_transport->inet = NULL;
2482 lower_transport->sock = NULL;
2483 lower_transport->file = NULL;
2485 xprt_clear_connected(lower_xprt);
2486 xs_sock_reset_connection_flags(lower_xprt);
2487 xs_stream_reset_connect(lower_transport);
2488 mutex_unlock(&lower_transport->recv_mutex);
2491 if (!xprt_bound(upper_xprt))
2494 xs_set_memalloc(upper_xprt);
2496 if (!xprt_test_and_set_connected(upper_xprt)) {
2497 upper_xprt->connect_cookie++;
2498 clear_bit(XPRT_SOCK_CONNECTING, &upper_transport->sock_state);
2499 xprt_clear_connecting(upper_xprt);
2501 upper_xprt->stat.connect_count++;
2502 upper_xprt->stat.connect_time += (long)jiffies -
2503 upper_xprt->stat.connect_start;
2504 xs_run_error_worker(upper_transport, XPRT_SOCK_WAKE_PENDING);
2510 * xs_tls_handshake_done - TLS handshake completion handler
2511 * @data: address of xprt to wake
2512 * @status: status of handshake
2513 * @peerid: serial number of key containing the remote's identity
2516 static void xs_tls_handshake_done(void *data, int status, key_serial_t peerid)
2518 struct rpc_xprt *lower_xprt = data;
2519 struct sock_xprt *lower_transport =
2520 container_of(lower_xprt, struct sock_xprt, xprt);
2522 lower_transport->xprt_err = status ? -EACCES : 0;
2523 complete(&lower_transport->handshake_done);
2524 xprt_put(lower_xprt);
2527 static int xs_tls_handshake_sync(struct rpc_xprt *lower_xprt, struct xprtsec_parms *xprtsec)
2529 struct sock_xprt *lower_transport =
2530 container_of(lower_xprt, struct sock_xprt, xprt);
2531 struct tls_handshake_args args = {
2532 .ta_sock = lower_transport->sock,
2533 .ta_done = xs_tls_handshake_done,
2534 .ta_data = xprt_get(lower_xprt),
2535 .ta_peername = lower_xprt->servername,
2537 struct sock *sk = lower_transport->inet;
2540 init_completion(&lower_transport->handshake_done);
2541 set_bit(XPRT_SOCK_IGNORE_RECV, &lower_transport->sock_state);
2542 lower_transport->xprt_err = -ETIMEDOUT;
2543 switch (xprtsec->policy) {
2544 case RPC_XPRTSEC_TLS_ANON:
2545 rc = tls_client_hello_anon(&args, GFP_KERNEL);
2549 case RPC_XPRTSEC_TLS_X509:
2550 args.ta_my_cert = xprtsec->cert_serial;
2551 args.ta_my_privkey = xprtsec->privkey_serial;
2552 rc = tls_client_hello_x509(&args, GFP_KERNEL);
2561 rc = wait_for_completion_interruptible_timeout(&lower_transport->handshake_done,
2562 XS_TLS_HANDSHAKE_TO);
2564 if (!tls_handshake_cancel(sk)) {
2571 rc = lower_transport->xprt_err;
2574 xs_stream_reset_connect(lower_transport);
2575 clear_bit(XPRT_SOCK_IGNORE_RECV, &lower_transport->sock_state);
2579 xprt_put(lower_xprt);
2584 * xs_tcp_tls_setup_socket - establish a TLS session on a TCP socket
2585 * @work: queued work item
2587 * Invoked by a work queue tasklet.
2589 * For RPC-with-TLS, there is a two-stage connection process.
2591 * The "upper-layer xprt" is visible to the RPC consumer. Once it has
2592 * been marked connected, the consumer knows that a TCP connection and
2593 * a TLS session have been established.
2595 * A "lower-layer xprt", created in this function, handles the mechanics
2596 * of connecting the TCP socket, performing the RPC_AUTH_TLS probe, and
2597 * then driving the TLS handshake. Once all that is complete, the upper
2598 * layer xprt is marked connected.
2600 static void xs_tcp_tls_setup_socket(struct work_struct *work)
2602 struct sock_xprt *upper_transport =
2603 container_of(work, struct sock_xprt, connect_worker.work);
2604 struct rpc_clnt *upper_clnt = upper_transport->clnt;
2605 struct rpc_xprt *upper_xprt = &upper_transport->xprt;
2606 struct rpc_create_args args = {
2607 .net = upper_xprt->xprt_net,
2608 .protocol = upper_xprt->prot,
2609 .address = (struct sockaddr *)&upper_xprt->addr,
2610 .addrsize = upper_xprt->addrlen,
2611 .timeout = upper_clnt->cl_timeout,
2612 .servername = upper_xprt->servername,
2613 .program = upper_clnt->cl_program,
2614 .prognumber = upper_clnt->cl_prog,
2615 .version = upper_clnt->cl_vers,
2616 .authflavor = RPC_AUTH_TLS,
2617 .cred = upper_clnt->cl_cred,
2619 .policy = RPC_XPRTSEC_NONE,
2622 unsigned int pflags = current->flags;
2623 struct rpc_clnt *lower_clnt;
2624 struct rpc_xprt *lower_xprt;
2627 if (atomic_read(&upper_xprt->swapper))
2628 current->flags |= PF_MEMALLOC;
2630 xs_stream_start_connect(upper_transport);
2632 /* This implicitly sends an RPC_AUTH_TLS probe */
2633 lower_clnt = rpc_create(&args);
2634 if (IS_ERR(lower_clnt)) {
2635 trace_rpc_tls_unavailable(upper_clnt, upper_xprt);
2636 clear_bit(XPRT_SOCK_CONNECTING, &upper_transport->sock_state);
2637 xprt_clear_connecting(upper_xprt);
2638 xprt_wake_pending_tasks(upper_xprt, PTR_ERR(lower_clnt));
2639 xs_run_error_worker(upper_transport, XPRT_SOCK_WAKE_PENDING);
2643 /* RPC_AUTH_TLS probe was successful. Try a TLS handshake on
2647 lower_xprt = rcu_dereference(lower_clnt->cl_xprt);
2649 status = xs_tls_handshake_sync(lower_xprt, &upper_xprt->xprtsec);
2651 trace_rpc_tls_not_started(upper_clnt, upper_xprt);
2655 status = xs_tcp_tls_finish_connecting(lower_xprt, upper_transport);
2659 trace_rpc_socket_connect(upper_xprt, upper_transport->sock, 0);
2660 if (!xprt_test_and_set_connected(upper_xprt)) {
2661 upper_xprt->connect_cookie++;
2662 clear_bit(XPRT_SOCK_CONNECTING, &upper_transport->sock_state);
2663 xprt_clear_connecting(upper_xprt);
2665 upper_xprt->stat.connect_count++;
2666 upper_xprt->stat.connect_time += (long)jiffies -
2667 upper_xprt->stat.connect_start;
2668 xs_run_error_worker(upper_transport, XPRT_SOCK_WAKE_PENDING);
2670 rpc_shutdown_client(lower_clnt);
2673 current_restore_flags(pflags, PF_MEMALLOC);
2674 upper_transport->clnt = NULL;
2675 xprt_unlock_connect(upper_xprt, upper_transport);
2679 rpc_shutdown_client(lower_clnt);
2681 /* xprt_force_disconnect() wakes tasks with a fixed tk_status code.
2682 * Wake them first here to ensure they get our tk_status code.
2684 xprt_wake_pending_tasks(upper_xprt, status);
2685 xs_tcp_force_close(upper_xprt);
2686 xprt_clear_connecting(upper_xprt);
2691 * xs_connect - connect a socket to a remote endpoint
2692 * @xprt: pointer to transport structure
2693 * @task: address of RPC task that manages state of connect request
2695 * TCP: If the remote end dropped the connection, delay reconnecting.
2697 * UDP socket connects are synchronous, but we use a work queue anyway
2698 * to guarantee that even unprivileged user processes can set up a
2699 * socket on a privileged port.
2701 * If a UDP socket connect fails, the delay behavior here prevents
2702 * retry floods (hard mounts).
2704 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2706 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2707 unsigned long delay = 0;
2709 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2711 if (transport->sock != NULL) {
2712 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2713 "seconds\n", xprt, xprt->reestablish_timeout / HZ);
2715 delay = xprt_reconnect_delay(xprt);
2716 xprt_reconnect_backoff(xprt, XS_TCP_INIT_REEST_TO);
2719 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2721 transport->clnt = task->tk_client;
2722 queue_delayed_work(xprtiod_workqueue,
2723 &transport->connect_worker,
2727 static void xs_wake_disconnect(struct sock_xprt *transport)
2729 if (test_and_clear_bit(XPRT_SOCK_WAKE_DISCONNECT, &transport->sock_state))
2730 xs_tcp_force_close(&transport->xprt);
2733 static void xs_wake_write(struct sock_xprt *transport)
2735 if (test_and_clear_bit(XPRT_SOCK_WAKE_WRITE, &transport->sock_state))
2736 xprt_write_space(&transport->xprt);
2739 static void xs_wake_error(struct sock_xprt *transport)
2743 if (!test_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2745 mutex_lock(&transport->recv_mutex);
2746 if (transport->sock == NULL)
2748 if (!test_and_clear_bit(XPRT_SOCK_WAKE_ERROR, &transport->sock_state))
2750 sockerr = xchg(&transport->xprt_err, 0);
2752 xprt_wake_pending_tasks(&transport->xprt, sockerr);
2754 mutex_unlock(&transport->recv_mutex);
2757 static void xs_wake_pending(struct sock_xprt *transport)
2759 if (test_and_clear_bit(XPRT_SOCK_WAKE_PENDING, &transport->sock_state))
2760 xprt_wake_pending_tasks(&transport->xprt, -EAGAIN);
2763 static void xs_error_handle(struct work_struct *work)
2765 struct sock_xprt *transport = container_of(work,
2766 struct sock_xprt, error_worker);
2768 xs_wake_disconnect(transport);
2769 xs_wake_write(transport);
2770 xs_wake_error(transport);
2771 xs_wake_pending(transport);
2775 * xs_local_print_stats - display AF_LOCAL socket-specific stats
2776 * @xprt: rpc_xprt struct containing statistics
2780 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2784 if (xprt_connected(xprt))
2785 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2787 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2788 "%llu %llu %lu %llu %llu\n",
2789 xprt->stat.bind_count,
2790 xprt->stat.connect_count,
2791 xprt->stat.connect_time / HZ,
2795 xprt->stat.bad_xids,
2798 xprt->stat.max_slots,
2799 xprt->stat.sending_u,
2800 xprt->stat.pending_u);
2804 * xs_udp_print_stats - display UDP socket-specific stats
2805 * @xprt: rpc_xprt struct containing statistics
2809 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2811 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2813 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2816 xprt->stat.bind_count,
2819 xprt->stat.bad_xids,
2822 xprt->stat.max_slots,
2823 xprt->stat.sending_u,
2824 xprt->stat.pending_u);
2828 * xs_tcp_print_stats - display TCP socket-specific stats
2829 * @xprt: rpc_xprt struct containing statistics
2833 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2835 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2838 if (xprt_connected(xprt))
2839 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2841 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2842 "%llu %llu %lu %llu %llu\n",
2844 xprt->stat.bind_count,
2845 xprt->stat.connect_count,
2846 xprt->stat.connect_time / HZ,
2850 xprt->stat.bad_xids,
2853 xprt->stat.max_slots,
2854 xprt->stat.sending_u,
2855 xprt->stat.pending_u);
2859 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2860 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2861 * to use the server side send routines.
2863 static int bc_malloc(struct rpc_task *task)
2865 struct rpc_rqst *rqst = task->tk_rqstp;
2866 size_t size = rqst->rq_callsize;
2868 struct rpc_buffer *buf;
2870 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2871 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2876 page = alloc_page(GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN);
2880 buf = page_address(page);
2881 buf->len = PAGE_SIZE;
2883 rqst->rq_buffer = buf->data;
2884 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2889 * Free the space allocated in the bc_alloc routine
2891 static void bc_free(struct rpc_task *task)
2893 void *buffer = task->tk_rqstp->rq_buffer;
2894 struct rpc_buffer *buf;
2896 buf = container_of(buffer, struct rpc_buffer, data);
2897 free_page((unsigned long)buf);
2900 static int bc_sendto(struct rpc_rqst *req)
2902 struct xdr_buf *xdr = &req->rq_snd_buf;
2903 struct sock_xprt *transport =
2904 container_of(req->rq_xprt, struct sock_xprt, xprt);
2905 struct msghdr msg = {
2908 rpc_fraghdr marker = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT |
2910 unsigned int sent = 0;
2913 req->rq_xtime = ktime_get();
2914 err = xdr_alloc_bvec(xdr, rpc_task_gfp_mask());
2917 err = xprt_sock_sendmsg(transport->sock, &msg, xdr, 0, marker, &sent);
2919 if (err < 0 || sent != (xdr->len + sizeof(marker)))
2925 * bc_send_request - Send a backchannel Call on a TCP socket
2926 * @req: rpc_rqst containing Call message to be sent
2928 * xpt_mutex ensures @rqstp's whole message is written to the socket
2929 * without interruption.
2932 * %0 if the message was sent successfully
2933 * %ENOTCONN if the message was not sent
2935 static int bc_send_request(struct rpc_rqst *req)
2937 struct svc_xprt *xprt;
2941 * Get the server socket associated with this callback xprt
2943 xprt = req->rq_xprt->bc_xprt;
2946 * Grab the mutex to serialize data as the connection is shared
2947 * with the fore channel
2949 mutex_lock(&xprt->xpt_mutex);
2950 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2953 len = bc_sendto(req);
2954 mutex_unlock(&xprt->xpt_mutex);
2963 * The close routine. Since this is client initiated, we do nothing
2966 static void bc_close(struct rpc_xprt *xprt)
2968 xprt_disconnect_done(xprt);
2972 * The xprt destroy routine. Again, because this connection is client
2973 * initiated, we do nothing
2976 static void bc_destroy(struct rpc_xprt *xprt)
2978 dprintk("RPC: bc_destroy xprt %p\n", xprt);
2981 module_put(THIS_MODULE);
2984 static const struct rpc_xprt_ops xs_local_ops = {
2985 .reserve_xprt = xprt_reserve_xprt,
2986 .release_xprt = xprt_release_xprt,
2987 .alloc_slot = xprt_alloc_slot,
2988 .free_slot = xprt_free_slot,
2989 .rpcbind = xs_local_rpcbind,
2990 .set_port = xs_local_set_port,
2991 .connect = xs_local_connect,
2992 .buf_alloc = rpc_malloc,
2993 .buf_free = rpc_free,
2994 .prepare_request = xs_stream_prepare_request,
2995 .send_request = xs_local_send_request,
2996 .wait_for_reply_request = xprt_wait_for_reply_request_def,
2998 .destroy = xs_destroy,
2999 .print_stats = xs_local_print_stats,
3000 .enable_swap = xs_enable_swap,
3001 .disable_swap = xs_disable_swap,
3004 static const struct rpc_xprt_ops xs_udp_ops = {
3005 .set_buffer_size = xs_udp_set_buffer_size,
3006 .reserve_xprt = xprt_reserve_xprt_cong,
3007 .release_xprt = xprt_release_xprt_cong,
3008 .alloc_slot = xprt_alloc_slot,
3009 .free_slot = xprt_free_slot,
3010 .rpcbind = rpcb_getport_async,
3011 .set_port = xs_set_port,
3012 .connect = xs_connect,
3013 .get_srcaddr = xs_sock_srcaddr,
3014 .get_srcport = xs_sock_srcport,
3015 .buf_alloc = rpc_malloc,
3016 .buf_free = rpc_free,
3017 .send_request = xs_udp_send_request,
3018 .wait_for_reply_request = xprt_wait_for_reply_request_rtt,
3019 .timer = xs_udp_timer,
3020 .release_request = xprt_release_rqst_cong,
3022 .destroy = xs_destroy,
3023 .print_stats = xs_udp_print_stats,
3024 .enable_swap = xs_enable_swap,
3025 .disable_swap = xs_disable_swap,
3026 .inject_disconnect = xs_inject_disconnect,
3029 static const struct rpc_xprt_ops xs_tcp_ops = {
3030 .reserve_xprt = xprt_reserve_xprt,
3031 .release_xprt = xprt_release_xprt,
3032 .alloc_slot = xprt_alloc_slot,
3033 .free_slot = xprt_free_slot,
3034 .rpcbind = rpcb_getport_async,
3035 .set_port = xs_set_port,
3036 .connect = xs_connect,
3037 .get_srcaddr = xs_sock_srcaddr,
3038 .get_srcport = xs_sock_srcport,
3039 .buf_alloc = rpc_malloc,
3040 .buf_free = rpc_free,
3041 .prepare_request = xs_stream_prepare_request,
3042 .send_request = xs_tcp_send_request,
3043 .wait_for_reply_request = xprt_wait_for_reply_request_def,
3044 .close = xs_tcp_shutdown,
3045 .destroy = xs_destroy,
3046 .set_connect_timeout = xs_tcp_set_connect_timeout,
3047 .print_stats = xs_tcp_print_stats,
3048 .enable_swap = xs_enable_swap,
3049 .disable_swap = xs_disable_swap,
3050 .inject_disconnect = xs_inject_disconnect,
3051 #ifdef CONFIG_SUNRPC_BACKCHANNEL
3052 .bc_setup = xprt_setup_bc,
3053 .bc_maxpayload = xs_tcp_bc_maxpayload,
3054 .bc_num_slots = xprt_bc_max_slots,
3055 .bc_free_rqst = xprt_free_bc_rqst,
3056 .bc_destroy = xprt_destroy_bc,
3061 * The rpc_xprt_ops for the server backchannel
3064 static const struct rpc_xprt_ops bc_tcp_ops = {
3065 .reserve_xprt = xprt_reserve_xprt,
3066 .release_xprt = xprt_release_xprt,
3067 .alloc_slot = xprt_alloc_slot,
3068 .free_slot = xprt_free_slot,
3069 .buf_alloc = bc_malloc,
3070 .buf_free = bc_free,
3071 .send_request = bc_send_request,
3072 .wait_for_reply_request = xprt_wait_for_reply_request_def,
3074 .destroy = bc_destroy,
3075 .print_stats = xs_tcp_print_stats,
3076 .enable_swap = xs_enable_swap,
3077 .disable_swap = xs_disable_swap,
3078 .inject_disconnect = xs_inject_disconnect,
3081 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
3083 static const struct sockaddr_in sin = {
3084 .sin_family = AF_INET,
3085 .sin_addr.s_addr = htonl(INADDR_ANY),
3087 static const struct sockaddr_in6 sin6 = {
3088 .sin6_family = AF_INET6,
3089 .sin6_addr = IN6ADDR_ANY_INIT,
3096 memcpy(sap, &sin, sizeof(sin));
3099 memcpy(sap, &sin6, sizeof(sin6));
3102 dprintk("RPC: %s: Bad address family\n", __func__);
3103 return -EAFNOSUPPORT;
3108 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
3109 unsigned int slot_table_size,
3110 unsigned int max_slot_table_size)
3112 struct rpc_xprt *xprt;
3113 struct sock_xprt *new;
3115 if (args->addrlen > sizeof(xprt->addr)) {
3116 dprintk("RPC: xs_setup_xprt: address too large\n");
3117 return ERR_PTR(-EBADF);
3120 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
3121 max_slot_table_size);
3123 dprintk("RPC: xs_setup_xprt: couldn't allocate "
3125 return ERR_PTR(-ENOMEM);
3128 new = container_of(xprt, struct sock_xprt, xprt);
3129 mutex_init(&new->recv_mutex);
3130 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
3131 xprt->addrlen = args->addrlen;
3133 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
3136 err = xs_init_anyaddr(args->dstaddr->sa_family,
3137 (struct sockaddr *)&new->srcaddr);
3140 return ERR_PTR(err);
3147 static const struct rpc_timeout xs_local_default_timeout = {
3148 .to_initval = 10 * HZ,
3149 .to_maxval = 10 * HZ,
3154 * xs_setup_local - Set up transport to use an AF_LOCAL socket
3155 * @args: rpc transport creation arguments
3157 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
3159 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
3161 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
3162 struct sock_xprt *transport;
3163 struct rpc_xprt *xprt;
3164 struct rpc_xprt *ret;
3166 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3167 xprt_max_tcp_slot_table_entries);
3170 transport = container_of(xprt, struct sock_xprt, xprt);
3173 xprt->xprt_class = &xs_local_transport;
3174 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3176 xprt->bind_timeout = XS_BIND_TO;
3177 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
3178 xprt->idle_timeout = XS_IDLE_DISC_TO;
3180 xprt->ops = &xs_local_ops;
3181 xprt->timeout = &xs_local_default_timeout;
3183 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
3184 INIT_WORK(&transport->error_worker, xs_error_handle);
3185 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
3187 switch (sun->sun_family) {
3189 if (sun->sun_path[0] != '/' && sun->sun_path[0] != '\0') {
3190 dprintk("RPC: bad AF_LOCAL address: %s\n",
3192 ret = ERR_PTR(-EINVAL);
3195 xprt_set_bound(xprt);
3196 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
3199 ret = ERR_PTR(-EAFNOSUPPORT);
3203 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
3204 xprt->address_strings[RPC_DISPLAY_ADDR]);
3206 if (try_module_get(THIS_MODULE))
3208 ret = ERR_PTR(-EINVAL);
3214 static const struct rpc_timeout xs_udp_default_timeout = {
3215 .to_initval = 5 * HZ,
3216 .to_maxval = 30 * HZ,
3217 .to_increment = 5 * HZ,
3222 * xs_setup_udp - Set up transport to use a UDP socket
3223 * @args: rpc transport creation arguments
3226 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
3228 struct sockaddr *addr = args->dstaddr;
3229 struct rpc_xprt *xprt;
3230 struct sock_xprt *transport;
3231 struct rpc_xprt *ret;
3233 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
3234 xprt_udp_slot_table_entries);
3237 transport = container_of(xprt, struct sock_xprt, xprt);
3239 xprt->prot = IPPROTO_UDP;
3240 xprt->xprt_class = &xs_udp_transport;
3241 /* XXX: header size can vary due to auth type, IPv6, etc. */
3242 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
3244 xprt->bind_timeout = XS_BIND_TO;
3245 xprt->reestablish_timeout = XS_UDP_REEST_TO;
3246 xprt->idle_timeout = XS_IDLE_DISC_TO;
3248 xprt->ops = &xs_udp_ops;
3250 xprt->timeout = &xs_udp_default_timeout;
3252 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
3253 INIT_WORK(&transport->error_worker, xs_error_handle);
3254 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
3256 switch (addr->sa_family) {
3258 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3259 xprt_set_bound(xprt);
3261 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
3264 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3265 xprt_set_bound(xprt);
3267 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
3270 ret = ERR_PTR(-EAFNOSUPPORT);
3274 if (xprt_bound(xprt))
3275 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3276 xprt->address_strings[RPC_DISPLAY_ADDR],
3277 xprt->address_strings[RPC_DISPLAY_PORT],
3278 xprt->address_strings[RPC_DISPLAY_PROTO]);
3280 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3281 xprt->address_strings[RPC_DISPLAY_ADDR],
3282 xprt->address_strings[RPC_DISPLAY_PROTO]);
3284 if (try_module_get(THIS_MODULE))
3286 ret = ERR_PTR(-EINVAL);
3292 static const struct rpc_timeout xs_tcp_default_timeout = {
3293 .to_initval = 60 * HZ,
3294 .to_maxval = 60 * HZ,
3299 * xs_setup_tcp - Set up transport to use a TCP socket
3300 * @args: rpc transport creation arguments
3303 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
3305 struct sockaddr *addr = args->dstaddr;
3306 struct rpc_xprt *xprt;
3307 struct sock_xprt *transport;
3308 struct rpc_xprt *ret;
3309 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
3311 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
3312 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
3314 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3315 max_slot_table_size);
3318 transport = container_of(xprt, struct sock_xprt, xprt);
3320 xprt->prot = IPPROTO_TCP;
3321 xprt->xprt_class = &xs_tcp_transport;
3322 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3324 xprt->bind_timeout = XS_BIND_TO;
3325 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
3326 xprt->idle_timeout = XS_IDLE_DISC_TO;
3328 xprt->ops = &xs_tcp_ops;
3329 xprt->timeout = &xs_tcp_default_timeout;
3331 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
3332 xprt->connect_timeout = xprt->timeout->to_initval *
3333 (xprt->timeout->to_retries + 1);
3335 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
3336 INIT_WORK(&transport->error_worker, xs_error_handle);
3337 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
3339 switch (addr->sa_family) {
3341 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3342 xprt_set_bound(xprt);
3344 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3347 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3348 xprt_set_bound(xprt);
3350 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3353 ret = ERR_PTR(-EAFNOSUPPORT);
3357 if (xprt_bound(xprt))
3358 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3359 xprt->address_strings[RPC_DISPLAY_ADDR],
3360 xprt->address_strings[RPC_DISPLAY_PORT],
3361 xprt->address_strings[RPC_DISPLAY_PROTO]);
3363 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3364 xprt->address_strings[RPC_DISPLAY_ADDR],
3365 xprt->address_strings[RPC_DISPLAY_PROTO]);
3367 if (try_module_get(THIS_MODULE))
3369 ret = ERR_PTR(-EINVAL);
3376 * xs_setup_tcp_tls - Set up transport to use a TCP with TLS
3377 * @args: rpc transport creation arguments
3380 static struct rpc_xprt *xs_setup_tcp_tls(struct xprt_create *args)
3382 struct sockaddr *addr = args->dstaddr;
3383 struct rpc_xprt *xprt;
3384 struct sock_xprt *transport;
3385 struct rpc_xprt *ret;
3386 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
3388 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
3389 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
3391 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3392 max_slot_table_size);
3395 transport = container_of(xprt, struct sock_xprt, xprt);
3397 xprt->prot = IPPROTO_TCP;
3398 xprt->xprt_class = &xs_tcp_transport;
3399 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3401 xprt->bind_timeout = XS_BIND_TO;
3402 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
3403 xprt->idle_timeout = XS_IDLE_DISC_TO;
3405 xprt->ops = &xs_tcp_ops;
3406 xprt->timeout = &xs_tcp_default_timeout;
3408 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
3409 xprt->connect_timeout = xprt->timeout->to_initval *
3410 (xprt->timeout->to_retries + 1);
3412 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
3413 INIT_WORK(&transport->error_worker, xs_error_handle);
3415 switch (args->xprtsec.policy) {
3416 case RPC_XPRTSEC_TLS_ANON:
3417 case RPC_XPRTSEC_TLS_X509:
3418 xprt->xprtsec = args->xprtsec;
3419 INIT_DELAYED_WORK(&transport->connect_worker,
3420 xs_tcp_tls_setup_socket);
3423 ret = ERR_PTR(-EACCES);
3427 switch (addr->sa_family) {
3429 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3430 xprt_set_bound(xprt);
3432 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3435 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3436 xprt_set_bound(xprt);
3438 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3441 ret = ERR_PTR(-EAFNOSUPPORT);
3445 if (xprt_bound(xprt))
3446 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3447 xprt->address_strings[RPC_DISPLAY_ADDR],
3448 xprt->address_strings[RPC_DISPLAY_PORT],
3449 xprt->address_strings[RPC_DISPLAY_PROTO]);
3451 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3452 xprt->address_strings[RPC_DISPLAY_ADDR],
3453 xprt->address_strings[RPC_DISPLAY_PROTO]);
3455 if (try_module_get(THIS_MODULE))
3457 ret = ERR_PTR(-EINVAL);
3464 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3465 * @args: rpc transport creation arguments
3468 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
3470 struct sockaddr *addr = args->dstaddr;
3471 struct rpc_xprt *xprt;
3472 struct sock_xprt *transport;
3473 struct svc_sock *bc_sock;
3474 struct rpc_xprt *ret;
3476 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3477 xprt_tcp_slot_table_entries);
3480 transport = container_of(xprt, struct sock_xprt, xprt);
3482 xprt->prot = IPPROTO_TCP;
3483 xprt->xprt_class = &xs_bc_tcp_transport;
3484 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3485 xprt->timeout = &xs_tcp_default_timeout;
3488 xprt_set_bound(xprt);
3489 xprt->bind_timeout = 0;
3490 xprt->reestablish_timeout = 0;
3491 xprt->idle_timeout = 0;
3493 xprt->ops = &bc_tcp_ops;
3495 switch (addr->sa_family) {
3497 xs_format_peer_addresses(xprt, "tcp",
3501 xs_format_peer_addresses(xprt, "tcp",
3502 RPCBIND_NETID_TCP6);
3505 ret = ERR_PTR(-EAFNOSUPPORT);
3509 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3510 xprt->address_strings[RPC_DISPLAY_ADDR],
3511 xprt->address_strings[RPC_DISPLAY_PORT],
3512 xprt->address_strings[RPC_DISPLAY_PROTO]);
3515 * Once we've associated a backchannel xprt with a connection,
3516 * we want to keep it around as long as the connection lasts,
3517 * in case we need to start using it for a backchannel again;
3518 * this reference won't be dropped until bc_xprt is destroyed.
3521 args->bc_xprt->xpt_bc_xprt = xprt;
3522 xprt->bc_xprt = args->bc_xprt;
3523 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3524 transport->sock = bc_sock->sk_sock;
3525 transport->inet = bc_sock->sk_sk;
3528 * Since we don't want connections for the backchannel, we set
3529 * the xprt status to connected
3531 xprt_set_connected(xprt);
3533 if (try_module_get(THIS_MODULE))
3536 args->bc_xprt->xpt_bc_xprt = NULL;
3537 args->bc_xprt->xpt_bc_xps = NULL;
3539 ret = ERR_PTR(-EINVAL);
3545 static struct xprt_class xs_local_transport = {
3546 .list = LIST_HEAD_INIT(xs_local_transport.list),
3547 .name = "named UNIX socket",
3548 .owner = THIS_MODULE,
3549 .ident = XPRT_TRANSPORT_LOCAL,
3550 .setup = xs_setup_local,
3554 static struct xprt_class xs_udp_transport = {
3555 .list = LIST_HEAD_INIT(xs_udp_transport.list),
3557 .owner = THIS_MODULE,
3558 .ident = XPRT_TRANSPORT_UDP,
3559 .setup = xs_setup_udp,
3560 .netid = { "udp", "udp6", "" },
3563 static struct xprt_class xs_tcp_transport = {
3564 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
3566 .owner = THIS_MODULE,
3567 .ident = XPRT_TRANSPORT_TCP,
3568 .setup = xs_setup_tcp,
3569 .netid = { "tcp", "tcp6", "" },
3572 static struct xprt_class xs_tcp_tls_transport = {
3573 .list = LIST_HEAD_INIT(xs_tcp_tls_transport.list),
3574 .name = "tcp-with-tls",
3575 .owner = THIS_MODULE,
3576 .ident = XPRT_TRANSPORT_TCP_TLS,
3577 .setup = xs_setup_tcp_tls,
3578 .netid = { "tcp", "tcp6", "" },
3581 static struct xprt_class xs_bc_tcp_transport = {
3582 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3583 .name = "tcp NFSv4.1 backchannel",
3584 .owner = THIS_MODULE,
3585 .ident = XPRT_TRANSPORT_BC_TCP,
3586 .setup = xs_setup_bc_tcp,
3591 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3594 int init_socket_xprt(void)
3596 if (!sunrpc_table_header)
3597 sunrpc_table_header = register_sysctl("sunrpc", xs_tunables_table);
3599 xprt_register_transport(&xs_local_transport);
3600 xprt_register_transport(&xs_udp_transport);
3601 xprt_register_transport(&xs_tcp_transport);
3602 xprt_register_transport(&xs_tcp_tls_transport);
3603 xprt_register_transport(&xs_bc_tcp_transport);
3609 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3612 void cleanup_socket_xprt(void)
3614 if (sunrpc_table_header) {
3615 unregister_sysctl_table(sunrpc_table_header);
3616 sunrpc_table_header = NULL;
3619 xprt_unregister_transport(&xs_local_transport);
3620 xprt_unregister_transport(&xs_udp_transport);
3621 xprt_unregister_transport(&xs_tcp_transport);
3622 xprt_unregister_transport(&xs_tcp_tls_transport);
3623 xprt_unregister_transport(&xs_bc_tcp_transport);
3626 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3628 return param_set_uint_minmax(val, kp,
3633 static const struct kernel_param_ops param_ops_portnr = {
3634 .set = param_set_portnr,
3635 .get = param_get_uint,
3638 #define param_check_portnr(name, p) \
3639 __param_check(name, p, unsigned int);
3641 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3642 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3644 static int param_set_slot_table_size(const char *val,
3645 const struct kernel_param *kp)
3647 return param_set_uint_minmax(val, kp,
3649 RPC_MAX_SLOT_TABLE);
3652 static const struct kernel_param_ops param_ops_slot_table_size = {
3653 .set = param_set_slot_table_size,
3654 .get = param_get_uint,
3657 #define param_check_slot_table_size(name, p) \
3658 __param_check(name, p, unsigned int);
3660 static int param_set_max_slot_table_size(const char *val,
3661 const struct kernel_param *kp)
3663 return param_set_uint_minmax(val, kp,
3665 RPC_MAX_SLOT_TABLE_LIMIT);
3668 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3669 .set = param_set_max_slot_table_size,
3670 .get = param_get_uint,
3673 #define param_check_max_slot_table_size(name, p) \
3674 __param_check(name, p, unsigned int);
3676 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3677 slot_table_size, 0644);
3678 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3679 max_slot_table_size, 0644);
3680 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3681 slot_table_size, 0644);