1 // SPDX-License-Identifier: GPL-2.0
3 * linux/net/sunrpc/xprtsock.c
5 * Client-side transport implementation for sockets.
7 * TCP callback races fixes (C) 1998 Red Hat
8 * TCP send fixes (C) 1998 Red Hat
9 * TCP NFS related read + write fixes
10 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
12 * Rewrite of larges part of the code in order to stabilize TCP stuff.
13 * Fix behaviour when socket buffer is full.
14 * (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no>
16 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
18 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
19 * <gilles.quillard@bull.net>
22 #include <linux/types.h>
23 #include <linux/string.h>
24 #include <linux/slab.h>
25 #include <linux/module.h>
26 #include <linux/capability.h>
27 #include <linux/pagemap.h>
28 #include <linux/errno.h>
29 #include <linux/socket.h>
31 #include <linux/net.h>
34 #include <linux/udp.h>
35 #include <linux/tcp.h>
36 #include <linux/sunrpc/clnt.h>
37 #include <linux/sunrpc/addr.h>
38 #include <linux/sunrpc/sched.h>
39 #include <linux/sunrpc/svcsock.h>
40 #include <linux/sunrpc/xprtsock.h>
41 #include <linux/file.h>
42 #ifdef CONFIG_SUNRPC_BACKCHANNEL
43 #include <linux/sunrpc/bc_xprt.h>
47 #include <net/checksum.h>
50 #include <linux/bvec.h>
51 #include <linux/highmem.h>
52 #include <linux/uio.h>
53 #include <linux/sched/mm.h>
55 #include <trace/events/sunrpc.h>
59 static void xs_close(struct rpc_xprt *xprt);
60 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
66 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
67 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
68 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
70 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
71 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
73 #define XS_TCP_LINGER_TO (15U * HZ)
74 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
77 * We can register our own files under /proc/sys/sunrpc by
78 * calling register_sysctl_table() again. The files in that
79 * directory become the union of all files registered there.
81 * We simply need to make sure that we don't collide with
82 * someone else's file names!
85 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
86 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
87 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
88 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
89 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
91 static struct ctl_table_header *sunrpc_table_header;
94 * FIXME: changing the UDP slot table size should also resize the UDP
95 * socket buffers for existing UDP transports
97 static struct ctl_table xs_tunables_table[] = {
99 .procname = "udp_slot_table_entries",
100 .data = &xprt_udp_slot_table_entries,
101 .maxlen = sizeof(unsigned int),
103 .proc_handler = proc_dointvec_minmax,
104 .extra1 = &min_slot_table_size,
105 .extra2 = &max_slot_table_size
108 .procname = "tcp_slot_table_entries",
109 .data = &xprt_tcp_slot_table_entries,
110 .maxlen = sizeof(unsigned int),
112 .proc_handler = proc_dointvec_minmax,
113 .extra1 = &min_slot_table_size,
114 .extra2 = &max_slot_table_size
117 .procname = "tcp_max_slot_table_entries",
118 .data = &xprt_max_tcp_slot_table_entries,
119 .maxlen = sizeof(unsigned int),
121 .proc_handler = proc_dointvec_minmax,
122 .extra1 = &min_slot_table_size,
123 .extra2 = &max_tcp_slot_table_limit
126 .procname = "min_resvport",
127 .data = &xprt_min_resvport,
128 .maxlen = sizeof(unsigned int),
130 .proc_handler = proc_dointvec_minmax,
131 .extra1 = &xprt_min_resvport_limit,
132 .extra2 = &xprt_max_resvport_limit
135 .procname = "max_resvport",
136 .data = &xprt_max_resvport,
137 .maxlen = sizeof(unsigned int),
139 .proc_handler = proc_dointvec_minmax,
140 .extra1 = &xprt_min_resvport_limit,
141 .extra2 = &xprt_max_resvport_limit
144 .procname = "tcp_fin_timeout",
145 .data = &xs_tcp_fin_timeout,
146 .maxlen = sizeof(xs_tcp_fin_timeout),
148 .proc_handler = proc_dointvec_jiffies,
153 static struct ctl_table sunrpc_table[] = {
155 .procname = "sunrpc",
157 .child = xs_tunables_table
163 * Wait duration for a reply from the RPC portmapper.
165 #define XS_BIND_TO (60U * HZ)
168 * Delay if a UDP socket connect error occurs. This is most likely some
169 * kind of resource problem on the local host.
171 #define XS_UDP_REEST_TO (2U * HZ)
174 * The reestablish timeout allows clients to delay for a bit before attempting
175 * to reconnect to a server that just dropped our connection.
177 * We implement an exponential backoff when trying to reestablish a TCP
178 * transport connection with the server. Some servers like to drop a TCP
179 * connection when they are overworked, so we start with a short timeout and
180 * increase over time if the server is down or not responding.
182 #define XS_TCP_INIT_REEST_TO (3U * HZ)
185 * TCP idle timeout; client drops the transport socket if it is idle
186 * for this long. Note that we also timeout UDP sockets to prevent
187 * holding port numbers when there is no RPC traffic.
189 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
191 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
192 # undef RPC_DEBUG_DATA
193 # define RPCDBG_FACILITY RPCDBG_TRANS
196 #ifdef RPC_DEBUG_DATA
197 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
199 u8 *buf = (u8 *) packet;
202 dprintk("RPC: %s\n", msg);
203 for (j = 0; j < count && j < 128; j += 4) {
207 dprintk("0x%04x ", j);
209 dprintk("%02x%02x%02x%02x ",
210 buf[j], buf[j+1], buf[j+2], buf[j+3]);
215 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
221 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
223 return (struct rpc_xprt *) sk->sk_user_data;
226 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
228 return (struct sockaddr *) &xprt->addr;
231 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
233 return (struct sockaddr_un *) &xprt->addr;
236 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
238 return (struct sockaddr_in *) &xprt->addr;
241 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
243 return (struct sockaddr_in6 *) &xprt->addr;
246 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
248 struct sockaddr *sap = xs_addr(xprt);
249 struct sockaddr_in6 *sin6;
250 struct sockaddr_in *sin;
251 struct sockaddr_un *sun;
254 switch (sap->sa_family) {
256 sun = xs_addr_un(xprt);
257 strlcpy(buf, sun->sun_path, sizeof(buf));
258 xprt->address_strings[RPC_DISPLAY_ADDR] =
259 kstrdup(buf, GFP_KERNEL);
262 (void)rpc_ntop(sap, buf, sizeof(buf));
263 xprt->address_strings[RPC_DISPLAY_ADDR] =
264 kstrdup(buf, GFP_KERNEL);
265 sin = xs_addr_in(xprt);
266 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
269 (void)rpc_ntop(sap, buf, sizeof(buf));
270 xprt->address_strings[RPC_DISPLAY_ADDR] =
271 kstrdup(buf, GFP_KERNEL);
272 sin6 = xs_addr_in6(xprt);
273 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
279 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
282 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
284 struct sockaddr *sap = xs_addr(xprt);
287 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
288 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
290 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
291 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
294 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
295 const char *protocol,
298 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
299 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
300 xs_format_common_peer_addresses(xprt);
301 xs_format_common_peer_ports(xprt);
304 static void xs_update_peer_port(struct rpc_xprt *xprt)
306 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
307 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
309 xs_format_common_peer_ports(xprt);
312 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
316 for (i = 0; i < RPC_DISPLAY_MAX; i++)
318 case RPC_DISPLAY_PROTO:
319 case RPC_DISPLAY_NETID:
322 kfree(xprt->address_strings[i]);
327 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp)
331 if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES))
333 n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT;
334 for (i = 0; i < n; i++) {
337 buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp);
338 if (!buf->pages[i]) {
340 return i > buf->page_base ? i - buf->page_base : 0;
347 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek)
351 iov_iter_advance(&msg->msg_iter, seek);
352 ret = sock_recvmsg(sock, msg, flags);
353 return ret > 0 ? ret + seek : ret;
357 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags,
358 struct kvec *kvec, size_t count, size_t seek)
360 iov_iter_kvec(&msg->msg_iter, READ, kvec, 1, count);
361 return xs_sock_recvmsg(sock, msg, flags, seek);
365 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags,
366 struct bio_vec *bvec, unsigned long nr, size_t count,
369 iov_iter_bvec(&msg->msg_iter, READ, bvec, nr, count);
370 return xs_sock_recvmsg(sock, msg, flags, seek);
374 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags,
377 iov_iter_discard(&msg->msg_iter, READ, count);
378 return sock_recvmsg(sock, msg, flags);
381 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
383 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
385 struct bvec_iter bi = {
390 bvec_iter_advance(bvec, &bi, seek & PAGE_MASK);
391 for_each_bvec(bv, bvec, bi, bi)
392 flush_dcache_page(bv.bv_page);
396 xs_flush_bvec(const struct bio_vec *bvec, size_t count, size_t seek)
402 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags,
403 struct xdr_buf *buf, size_t count, size_t seek, size_t *read)
405 size_t want, seek_init = seek, offset = 0;
408 want = min_t(size_t, count, buf->head[0].iov_len);
410 ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek);
414 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
424 want = xs_alloc_sparse_pages(buf,
425 min_t(size_t, count - offset, buf->page_len),
428 ret = xs_read_bvec(sock, msg, flags, buf->bvec,
429 xdr_buf_pagecount(buf),
430 want + buf->page_base,
431 seek + buf->page_base);
434 xs_flush_bvec(buf->bvec, ret, seek + buf->page_base);
435 offset += ret - buf->page_base;
436 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
446 want = min_t(size_t, count - offset, buf->tail[0].iov_len);
448 ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek);
452 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
460 *read = offset - seek_init;
468 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf)
470 if (!transport->recv.copied) {
471 if (buf->head[0].iov_len >= transport->recv.offset)
472 memcpy(buf->head[0].iov_base,
473 &transport->recv.xid,
474 transport->recv.offset);
475 transport->recv.copied = transport->recv.offset;
480 xs_read_stream_request_done(struct sock_xprt *transport)
482 return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT);
486 xs_read_stream_check_eor(struct sock_xprt *transport,
489 if (xs_read_stream_request_done(transport))
490 msg->msg_flags |= MSG_EOR;
494 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg,
495 int flags, struct rpc_rqst *req)
497 struct xdr_buf *buf = &req->rq_private_buf;
501 xs_read_header(transport, buf);
503 want = transport->recv.len - transport->recv.offset;
505 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
506 transport->recv.copied + want,
507 transport->recv.copied,
509 transport->recv.offset += read;
510 transport->recv.copied += read;
514 if (transport->recv.offset == transport->recv.len) {
515 xs_read_stream_check_eor(transport, msg);
527 msg->msg_flags |= MSG_TRUNC;
532 return ret < 0 ? ret : read;
536 xs_read_stream_headersize(bool isfrag)
539 return sizeof(__be32);
540 return 3 * sizeof(__be32);
544 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
545 int flags, size_t want, size_t seek)
548 .iov_base = &transport->recv.fraghdr,
551 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
554 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
556 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
558 struct rpc_xprt *xprt = &transport->xprt;
559 struct rpc_rqst *req;
562 /* Look up and lock the request corresponding to the given XID */
563 req = xprt_lookup_bc_request(xprt, transport->recv.xid);
565 printk(KERN_WARNING "Callback slot table overflowed\n");
569 ret = xs_read_stream_request(transport, msg, flags, req);
570 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
571 xprt_complete_bc_request(req, transport->recv.copied);
575 #else /* CONFIG_SUNRPC_BACKCHANNEL */
577 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
581 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
584 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
586 struct rpc_xprt *xprt = &transport->xprt;
587 struct rpc_rqst *req;
590 /* Look up and lock the request corresponding to the given XID */
591 spin_lock(&xprt->queue_lock);
592 req = xprt_lookup_rqst(xprt, transport->recv.xid);
594 msg->msg_flags |= MSG_TRUNC;
598 spin_unlock(&xprt->queue_lock);
600 ret = xs_read_stream_request(transport, msg, flags, req);
602 spin_lock(&xprt->queue_lock);
603 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
604 xprt_complete_rqst(req->rq_task, transport->recv.copied);
605 xprt_unpin_rqst(req);
607 spin_unlock(&xprt->queue_lock);
612 xs_read_stream(struct sock_xprt *transport, int flags)
614 struct msghdr msg = { 0 };
615 size_t want, read = 0;
618 if (transport->recv.len == 0) {
619 want = xs_read_stream_headersize(transport->recv.copied != 0);
620 ret = xs_read_stream_header(transport, &msg, flags, want,
621 transport->recv.offset);
624 transport->recv.offset = ret;
625 if (transport->recv.offset != want)
626 return transport->recv.offset;
627 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
628 RPC_FRAGMENT_SIZE_MASK;
629 transport->recv.offset -= sizeof(transport->recv.fraghdr);
633 switch (be32_to_cpu(transport->recv.calldir)) {
635 msg.msg_flags |= MSG_TRUNC;
638 ret = xs_read_stream_call(transport, &msg, flags);
641 ret = xs_read_stream_reply(transport, &msg, flags);
643 if (msg.msg_flags & MSG_TRUNC) {
644 transport->recv.calldir = cpu_to_be32(-1);
645 transport->recv.copied = -1;
650 if (transport->recv.offset < transport->recv.len) {
651 if (!(msg.msg_flags & MSG_TRUNC))
654 ret = xs_read_discard(transport->sock, &msg, flags,
655 transport->recv.len - transport->recv.offset);
658 transport->recv.offset += ret;
660 if (transport->recv.offset != transport->recv.len)
663 if (xs_read_stream_request_done(transport)) {
664 trace_xs_stream_read_request(transport);
665 transport->recv.copied = 0;
667 transport->recv.offset = 0;
668 transport->recv.len = 0;
671 return ret != 0 ? ret : -ESHUTDOWN;
674 static __poll_t xs_poll_socket(struct sock_xprt *transport)
676 return transport->sock->ops->poll(NULL, transport->sock, NULL);
679 static bool xs_poll_socket_readable(struct sock_xprt *transport)
681 __poll_t events = xs_poll_socket(transport);
683 return (events & (EPOLLIN | EPOLLRDNORM)) && !(events & EPOLLRDHUP);
686 static void xs_poll_check_readable(struct sock_xprt *transport)
689 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
690 if (!xs_poll_socket_readable(transport))
692 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
693 queue_work(xprtiod_workqueue, &transport->recv_worker);
696 static void xs_stream_data_receive(struct sock_xprt *transport)
701 mutex_lock(&transport->recv_mutex);
702 if (transport->sock == NULL)
705 ret = xs_read_stream(transport, MSG_DONTWAIT);
711 xs_poll_check_readable(transport);
713 mutex_unlock(&transport->recv_mutex);
714 trace_xs_stream_read_data(&transport->xprt, ret, read);
717 static void xs_stream_data_receive_workfn(struct work_struct *work)
719 struct sock_xprt *transport =
720 container_of(work, struct sock_xprt, recv_worker);
721 unsigned int pflags = memalloc_nofs_save();
723 xs_stream_data_receive(transport);
724 memalloc_nofs_restore(pflags);
728 xs_stream_reset_connect(struct sock_xprt *transport)
730 transport->recv.offset = 0;
731 transport->recv.len = 0;
732 transport->recv.copied = 0;
733 transport->xmit.offset = 0;
737 xs_stream_start_connect(struct sock_xprt *transport)
739 transport->xprt.stat.connect_count++;
740 transport->xprt.stat.connect_start = jiffies;
743 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
745 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
747 struct msghdr msg = {
749 .msg_namelen = addrlen,
750 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
753 .iov_base = vec->iov_base + base,
754 .iov_len = vec->iov_len - base,
757 if (iov.iov_len != 0)
758 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
759 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
762 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more, bool zerocopy, int *sent_p)
764 ssize_t (*do_sendpage)(struct socket *sock, struct page *page,
765 int offset, size_t size, int flags);
767 unsigned int remainder;
770 remainder = xdr->page_len - base;
771 base += xdr->page_base;
772 ppage = xdr->pages + (base >> PAGE_SHIFT);
774 do_sendpage = sock->ops->sendpage;
776 do_sendpage = sock_no_sendpage;
778 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
779 int flags = XS_SENDMSG_FLAGS;
785 flags |= MSG_SENDPAGE_NOTLAST | MSG_MORE;
786 err = do_sendpage(sock, *ppage, base, len, flags);
787 if (remainder == 0 || err != len)
801 * xs_sendpages - write pages directly to a socket
802 * @sock: socket to send on
803 * @addr: UDP only -- address of destination
804 * @addrlen: UDP only -- length of destination address
805 * @xdr: buffer containing this request
806 * @base: starting position in the buffer
807 * @zerocopy: true if it is safe to use sendpage()
808 * @sent_p: return the total number of bytes successfully queued for sending
811 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base, bool zerocopy, int *sent_p)
813 unsigned int remainder = xdr->len - base;
825 if (base < xdr->head[0].iov_len || addr != NULL) {
826 unsigned int len = xdr->head[0].iov_len - base;
828 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
829 if (remainder == 0 || err != len)
834 base -= xdr->head[0].iov_len;
836 if (base < xdr->page_len) {
837 unsigned int len = xdr->page_len - base;
839 err = xs_send_pagedata(sock, xdr, base, remainder != 0, zerocopy, &sent);
841 if (remainder == 0 || sent != len)
845 base -= xdr->page_len;
847 if (base >= xdr->tail[0].iov_len)
849 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
859 * xs_nospace - handle transmit was incomplete
860 * @req: pointer to RPC request
863 static int xs_nospace(struct rpc_rqst *req)
865 struct rpc_xprt *xprt = req->rq_xprt;
866 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
867 struct sock *sk = transport->inet;
870 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
871 req->rq_task->tk_pid,
872 req->rq_slen - transport->xmit.offset,
875 /* Protect against races with write_space */
876 spin_lock_bh(&xprt->transport_lock);
878 /* Don't race with disconnect */
879 if (xprt_connected(xprt)) {
880 /* wait for more buffer space */
881 sk->sk_write_pending++;
882 xprt_wait_for_buffer_space(xprt);
886 spin_unlock_bh(&xprt->transport_lock);
888 /* Race breaker in case memory is freed before above code is called */
889 if (ret == -EAGAIN) {
890 struct socket_wq *wq;
893 wq = rcu_dereference(sk->sk_wq);
894 set_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags);
897 sk->sk_write_space(sk);
903 xs_stream_prepare_request(struct rpc_rqst *req)
905 req->rq_task->tk_status = xdr_alloc_bvec(&req->rq_rcv_buf, GFP_NOIO);
909 * Determine if the previous message in the stream was aborted before it
910 * could complete transmission.
913 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
915 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
919 * Construct a stream transport record marker in @buf.
921 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf)
923 u32 reclen = buf->len - sizeof(rpc_fraghdr);
924 rpc_fraghdr *base = buf->head[0].iov_base;
925 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen);
929 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
930 * @req: pointer to RPC request
933 * 0: The request has been sent
934 * EAGAIN: The socket was blocked, please call again later to
935 * complete the request
936 * ENOTCONN: Caller needs to invoke connect logic then call again
937 * other: Some other error occured, the request was not sent
939 static int xs_local_send_request(struct rpc_rqst *req)
941 struct rpc_xprt *xprt = req->rq_xprt;
942 struct sock_xprt *transport =
943 container_of(xprt, struct sock_xprt, xprt);
944 struct xdr_buf *xdr = &req->rq_snd_buf;
948 /* Close the stream if the previous transmission was incomplete */
949 if (xs_send_request_was_aborted(transport, req)) {
954 xs_encode_stream_record_marker(&req->rq_snd_buf);
956 xs_pktdump("packet data:",
957 req->rq_svec->iov_base, req->rq_svec->iov_len);
959 req->rq_xtime = ktime_get();
960 status = xs_sendpages(transport->sock, NULL, 0, xdr,
961 transport->xmit.offset,
963 dprintk("RPC: %s(%u) = %d\n",
964 __func__, xdr->len - transport->xmit.offset, status);
966 if (status == -EAGAIN && sock_writeable(transport->inet))
969 if (likely(sent > 0) || status == 0) {
970 transport->xmit.offset += sent;
971 req->rq_bytes_sent = transport->xmit.offset;
972 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
973 req->rq_xmit_bytes_sent += transport->xmit.offset;
974 transport->xmit.offset = 0;
984 status = xs_nospace(req);
987 dprintk("RPC: sendmsg returned unrecognized error %d\n",
999 * xs_udp_send_request - write an RPC request to a UDP socket
1000 * @req: pointer to RPC request
1003 * 0: The request has been sent
1004 * EAGAIN: The socket was blocked, please call again later to
1005 * complete the request
1006 * ENOTCONN: Caller needs to invoke connect logic then call again
1007 * other: Some other error occurred, the request was not sent
1009 static int xs_udp_send_request(struct rpc_rqst *req)
1011 struct rpc_xprt *xprt = req->rq_xprt;
1012 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1013 struct xdr_buf *xdr = &req->rq_snd_buf;
1017 xs_pktdump("packet data:",
1018 req->rq_svec->iov_base,
1019 req->rq_svec->iov_len);
1021 if (!xprt_bound(xprt))
1024 if (!xprt_request_get_cong(xprt, req))
1027 req->rq_xtime = ktime_get();
1028 status = xs_sendpages(transport->sock, xs_addr(xprt), xprt->addrlen,
1029 xdr, 0, true, &sent);
1031 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
1034 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
1035 if (status == -EPERM)
1036 goto process_status;
1038 if (status == -EAGAIN && sock_writeable(transport->inet))
1041 if (sent > 0 || status == 0) {
1042 req->rq_xmit_bytes_sent += sent;
1043 if (sent >= req->rq_slen)
1045 /* Still some bytes left; set up for a retry later. */
1053 /* Should we call xs_close() here? */
1056 status = xs_nospace(req);
1063 /* When the server has died, an ICMP port unreachable message
1064 * prompts ECONNREFUSED. */
1067 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1075 * xs_tcp_send_request - write an RPC request to a TCP socket
1076 * @req: pointer to RPC request
1079 * 0: The request has been sent
1080 * EAGAIN: The socket was blocked, please call again later to
1081 * complete the request
1082 * ENOTCONN: Caller needs to invoke connect logic then call again
1083 * other: Some other error occurred, the request was not sent
1085 * XXX: In the case of soft timeouts, should we eventually give up
1086 * if sendmsg is not able to make progress?
1088 static int xs_tcp_send_request(struct rpc_rqst *req)
1090 struct rpc_xprt *xprt = req->rq_xprt;
1091 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1092 struct xdr_buf *xdr = &req->rq_snd_buf;
1093 bool zerocopy = true;
1094 bool vm_wait = false;
1098 /* Close the stream if the previous transmission was incomplete */
1099 if (xs_send_request_was_aborted(transport, req)) {
1100 if (transport->sock != NULL)
1101 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1105 xs_encode_stream_record_marker(&req->rq_snd_buf);
1107 xs_pktdump("packet data:",
1108 req->rq_svec->iov_base,
1109 req->rq_svec->iov_len);
1110 /* Don't use zero copy if this is a resend. If the RPC call
1111 * completes while the socket holds a reference to the pages,
1112 * then we may end up resending corrupted data.
1114 if (req->rq_task->tk_flags & RPC_TASK_SENT)
1117 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1118 xs_tcp_set_socket_timeouts(xprt, transport->sock);
1120 /* Continue transmitting the packet/record. We must be careful
1121 * to cope with writespace callbacks arriving _after_ we have
1122 * called sendmsg(). */
1123 req->rq_xtime = ktime_get();
1126 status = xs_sendpages(transport->sock, NULL, 0, xdr,
1127 transport->xmit.offset,
1130 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
1131 xdr->len - transport->xmit.offset, status);
1133 /* If we've sent the entire packet, immediately
1134 * reset the count of bytes sent. */
1135 transport->xmit.offset += sent;
1136 req->rq_bytes_sent = transport->xmit.offset;
1137 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
1138 req->rq_xmit_bytes_sent += transport->xmit.offset;
1139 transport->xmit.offset = 0;
1143 WARN_ON_ONCE(sent == 0 && status == 0);
1145 if (status == -EAGAIN ) {
1147 * Return EAGAIN if we're sure we're hitting the
1148 * socket send buffer limits.
1150 if (test_bit(SOCK_NOSPACE, &transport->sock->flags))
1153 * Did we hit a memory allocation failure?
1159 /* Retry, knowing now that we're below the
1160 * socket send buffer limit
1174 /* Should we call xs_close() here? */
1177 status = xs_nospace(req);
1187 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1194 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1196 transport->old_data_ready = sk->sk_data_ready;
1197 transport->old_state_change = sk->sk_state_change;
1198 transport->old_write_space = sk->sk_write_space;
1199 transport->old_error_report = sk->sk_error_report;
1202 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1204 sk->sk_data_ready = transport->old_data_ready;
1205 sk->sk_state_change = transport->old_state_change;
1206 sk->sk_write_space = transport->old_write_space;
1207 sk->sk_error_report = transport->old_error_report;
1210 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1212 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1214 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1217 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1219 smp_mb__before_atomic();
1220 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1221 clear_bit(XPRT_CLOSING, &xprt->state);
1222 xs_sock_reset_state_flags(xprt);
1223 smp_mb__after_atomic();
1227 * xs_error_report - callback to handle TCP socket state errors
1230 * Note: we don't call sock_error() since there may be a rpc_task
1231 * using the socket, and so we don't want to clear sk->sk_err.
1233 static void xs_error_report(struct sock *sk)
1235 struct rpc_xprt *xprt;
1238 read_lock_bh(&sk->sk_callback_lock);
1239 if (!(xprt = xprt_from_sock(sk)))
1245 dprintk("RPC: xs_error_report client %p, error=%d...\n",
1247 trace_rpc_socket_error(xprt, sk->sk_socket, err);
1248 xprt_wake_pending_tasks(xprt, err);
1250 read_unlock_bh(&sk->sk_callback_lock);
1253 static void xs_reset_transport(struct sock_xprt *transport)
1255 struct socket *sock = transport->sock;
1256 struct sock *sk = transport->inet;
1257 struct rpc_xprt *xprt = &transport->xprt;
1262 if (atomic_read(&transport->xprt.swapper))
1263 sk_clear_memalloc(sk);
1265 kernel_sock_shutdown(sock, SHUT_RDWR);
1267 mutex_lock(&transport->recv_mutex);
1268 write_lock_bh(&sk->sk_callback_lock);
1269 transport->inet = NULL;
1270 transport->sock = NULL;
1272 sk->sk_user_data = NULL;
1274 xs_restore_old_callbacks(transport, sk);
1275 xprt_clear_connected(xprt);
1276 write_unlock_bh(&sk->sk_callback_lock);
1277 xs_sock_reset_connection_flags(xprt);
1278 /* Reset stream record info */
1279 xs_stream_reset_connect(transport);
1280 mutex_unlock(&transport->recv_mutex);
1282 trace_rpc_socket_close(xprt, sock);
1285 xprt_disconnect_done(xprt);
1289 * xs_close - close a socket
1292 * This is used when all requests are complete; ie, no DRC state remains
1293 * on the server we want to save.
1295 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1296 * xs_reset_transport() zeroing the socket from underneath a writer.
1298 static void xs_close(struct rpc_xprt *xprt)
1300 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1302 dprintk("RPC: xs_close xprt %p\n", xprt);
1304 xs_reset_transport(transport);
1305 xprt->reestablish_timeout = 0;
1308 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1310 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
1312 xprt_disconnect_done(xprt);
1315 static void xs_xprt_free(struct rpc_xprt *xprt)
1317 xs_free_peer_addresses(xprt);
1322 * xs_destroy - prepare to shutdown a transport
1323 * @xprt: doomed transport
1326 static void xs_destroy(struct rpc_xprt *xprt)
1328 struct sock_xprt *transport = container_of(xprt,
1329 struct sock_xprt, xprt);
1330 dprintk("RPC: xs_destroy xprt %p\n", xprt);
1332 cancel_delayed_work_sync(&transport->connect_worker);
1334 cancel_work_sync(&transport->recv_worker);
1336 module_put(THIS_MODULE);
1340 * xs_udp_data_read_skb - receive callback for UDP sockets
1346 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1348 struct sk_buff *skb)
1350 struct rpc_task *task;
1351 struct rpc_rqst *rovr;
1352 int repsize, copied;
1358 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1362 /* Copy the XID from the skb... */
1363 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1367 /* Look up and lock the request corresponding to the given XID */
1368 spin_lock(&xprt->queue_lock);
1369 rovr = xprt_lookup_rqst(xprt, *xp);
1372 xprt_pin_rqst(rovr);
1373 xprt_update_rtt(rovr->rq_task);
1374 spin_unlock(&xprt->queue_lock);
1375 task = rovr->rq_task;
1377 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1380 /* Suck it into the iovec, verify checksum if not done by hw. */
1381 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1382 spin_lock(&xprt->queue_lock);
1383 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1388 spin_lock_bh(&xprt->transport_lock);
1389 xprt_adjust_cwnd(xprt, task, copied);
1390 spin_unlock_bh(&xprt->transport_lock);
1391 spin_lock(&xprt->queue_lock);
1392 xprt_complete_rqst(task, copied);
1393 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1395 xprt_unpin_rqst(rovr);
1397 spin_unlock(&xprt->queue_lock);
1400 static void xs_udp_data_receive(struct sock_xprt *transport)
1402 struct sk_buff *skb;
1406 mutex_lock(&transport->recv_mutex);
1407 sk = transport->inet;
1411 skb = skb_recv_udp(sk, 0, 1, &err);
1414 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1418 xs_poll_check_readable(transport);
1420 mutex_unlock(&transport->recv_mutex);
1423 static void xs_udp_data_receive_workfn(struct work_struct *work)
1425 struct sock_xprt *transport =
1426 container_of(work, struct sock_xprt, recv_worker);
1427 unsigned int pflags = memalloc_nofs_save();
1429 xs_udp_data_receive(transport);
1430 memalloc_nofs_restore(pflags);
1434 * xs_data_ready - "data ready" callback for UDP sockets
1435 * @sk: socket with data to read
1438 static void xs_data_ready(struct sock *sk)
1440 struct rpc_xprt *xprt;
1442 read_lock_bh(&sk->sk_callback_lock);
1443 dprintk("RPC: xs_data_ready...\n");
1444 xprt = xprt_from_sock(sk);
1446 struct sock_xprt *transport = container_of(xprt,
1447 struct sock_xprt, xprt);
1448 transport->old_data_ready(sk);
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);
1457 read_unlock_bh(&sk->sk_callback_lock);
1461 * Helper function to force a TCP close if the server is sending
1462 * junk and/or it has put us in CLOSE_WAIT
1464 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1466 xprt_force_disconnect(xprt);
1469 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1470 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1474 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1477 * xs_tcp_state_change - callback to handle TCP socket state changes
1478 * @sk: socket whose state has changed
1481 static void xs_tcp_state_change(struct sock *sk)
1483 struct rpc_xprt *xprt;
1484 struct sock_xprt *transport;
1486 read_lock_bh(&sk->sk_callback_lock);
1487 if (!(xprt = xprt_from_sock(sk)))
1489 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1490 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1491 sk->sk_state, xprt_connected(xprt),
1492 sock_flag(sk, SOCK_DEAD),
1493 sock_flag(sk, SOCK_ZAPPED),
1496 transport = container_of(xprt, struct sock_xprt, xprt);
1497 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1498 switch (sk->sk_state) {
1499 case TCP_ESTABLISHED:
1500 spin_lock(&xprt->transport_lock);
1501 if (!xprt_test_and_set_connected(xprt)) {
1502 xprt->connect_cookie++;
1503 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1504 xprt_clear_connecting(xprt);
1506 xprt->stat.connect_count++;
1507 xprt->stat.connect_time += (long)jiffies -
1508 xprt->stat.connect_start;
1509 xprt_wake_pending_tasks(xprt, -EAGAIN);
1511 spin_unlock(&xprt->transport_lock);
1514 /* The client initiated a shutdown of the socket */
1515 xprt->connect_cookie++;
1516 xprt->reestablish_timeout = 0;
1517 set_bit(XPRT_CLOSING, &xprt->state);
1518 smp_mb__before_atomic();
1519 clear_bit(XPRT_CONNECTED, &xprt->state);
1520 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1521 smp_mb__after_atomic();
1523 case TCP_CLOSE_WAIT:
1524 /* The server initiated a shutdown of the socket */
1525 xprt->connect_cookie++;
1526 clear_bit(XPRT_CONNECTED, &xprt->state);
1527 xs_tcp_force_close(xprt);
1531 * If the server closed down the connection, make sure that
1532 * we back off before reconnecting
1534 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1535 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1538 set_bit(XPRT_CLOSING, &xprt->state);
1539 smp_mb__before_atomic();
1540 clear_bit(XPRT_CONNECTED, &xprt->state);
1541 smp_mb__after_atomic();
1544 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1545 &transport->sock_state))
1546 xprt_clear_connecting(xprt);
1547 clear_bit(XPRT_CLOSING, &xprt->state);
1548 /* Trigger the socket release */
1549 xs_tcp_force_close(xprt);
1552 read_unlock_bh(&sk->sk_callback_lock);
1555 static void xs_write_space(struct sock *sk)
1557 struct socket_wq *wq;
1558 struct rpc_xprt *xprt;
1562 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1564 if (unlikely(!(xprt = xprt_from_sock(sk))))
1567 wq = rcu_dereference(sk->sk_wq);
1568 if (!wq || test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags) == 0)
1571 if (xprt_write_space(xprt))
1572 sk->sk_write_pending--;
1578 * xs_udp_write_space - callback invoked when socket buffer space
1580 * @sk: socket whose state has changed
1582 * Called when more output buffer space is available for this socket.
1583 * We try not to wake our writers until they can make "significant"
1584 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1585 * with a bunch of small requests.
1587 static void xs_udp_write_space(struct sock *sk)
1589 read_lock_bh(&sk->sk_callback_lock);
1591 /* from net/core/sock.c:sock_def_write_space */
1592 if (sock_writeable(sk))
1595 read_unlock_bh(&sk->sk_callback_lock);
1599 * xs_tcp_write_space - callback invoked when socket buffer space
1601 * @sk: socket whose state has changed
1603 * Called when more output buffer space is available for this socket.
1604 * We try not to wake our writers until they can make "significant"
1605 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1606 * with a bunch of small requests.
1608 static void xs_tcp_write_space(struct sock *sk)
1610 read_lock_bh(&sk->sk_callback_lock);
1612 /* from net/core/stream.c:sk_stream_write_space */
1613 if (sk_stream_is_writeable(sk))
1616 read_unlock_bh(&sk->sk_callback_lock);
1619 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1621 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1622 struct sock *sk = transport->inet;
1624 if (transport->rcvsize) {
1625 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1626 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1628 if (transport->sndsize) {
1629 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1630 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1631 sk->sk_write_space(sk);
1636 * xs_udp_set_buffer_size - set send and receive limits
1637 * @xprt: generic transport
1638 * @sndsize: requested size of send buffer, in bytes
1639 * @rcvsize: requested size of receive buffer, in bytes
1641 * Set socket send and receive buffer size limits.
1643 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1645 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1647 transport->sndsize = 0;
1649 transport->sndsize = sndsize + 1024;
1650 transport->rcvsize = 0;
1652 transport->rcvsize = rcvsize + 1024;
1654 xs_udp_do_set_buffer_size(xprt);
1658 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1659 * @xprt: controlling transport
1660 * @task: task that timed out
1662 * Adjust the congestion window after a retransmit timeout has occurred.
1664 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1666 spin_lock_bh(&xprt->transport_lock);
1667 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1668 spin_unlock_bh(&xprt->transport_lock);
1671 static int xs_get_random_port(void)
1673 unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1674 unsigned short range;
1675 unsigned short rand;
1679 range = max - min + 1;
1680 rand = (unsigned short) prandom_u32() % range;
1685 * xs_set_reuseaddr_port - set the socket's port and address reuse options
1688 * Note that this function has to be called on all sockets that share the
1689 * same port, and it must be called before binding.
1691 static void xs_sock_set_reuseport(struct socket *sock)
1695 kernel_setsockopt(sock, SOL_SOCKET, SO_REUSEPORT,
1696 (char *)&opt, sizeof(opt));
1699 static unsigned short xs_sock_getport(struct socket *sock)
1701 struct sockaddr_storage buf;
1702 unsigned short port = 0;
1704 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1706 switch (buf.ss_family) {
1708 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1711 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1718 * xs_set_port - reset the port number in the remote endpoint address
1719 * @xprt: generic transport
1720 * @port: new port number
1723 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1725 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1727 rpc_set_port(xs_addr(xprt), port);
1728 xs_update_peer_port(xprt);
1731 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1733 if (transport->srcport == 0)
1734 transport->srcport = xs_sock_getport(sock);
1737 static int xs_get_srcport(struct sock_xprt *transport)
1739 int port = transport->srcport;
1741 if (port == 0 && transport->xprt.resvport)
1742 port = xs_get_random_port();
1746 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1748 if (transport->srcport != 0)
1749 transport->srcport = 0;
1750 if (!transport->xprt.resvport)
1752 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1753 return xprt_max_resvport;
1756 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1758 struct sockaddr_storage myaddr;
1760 int port = xs_get_srcport(transport);
1761 unsigned short last;
1764 * If we are asking for any ephemeral port (i.e. port == 0 &&
1765 * transport->xprt.resvport == 0), don't bind. Let the local
1766 * port selection happen implicitly when the socket is used
1767 * (for example at connect time).
1769 * This ensures that we can continue to establish TCP
1770 * connections even when all local ephemeral ports are already
1771 * a part of some TCP connection. This makes no difference
1772 * for UDP sockets, but also doens't harm them.
1774 * If we're asking for any reserved port (i.e. port == 0 &&
1775 * transport->xprt.resvport == 1) xs_get_srcport above will
1776 * ensure that port is non-zero and we will bind as needed.
1781 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1783 rpc_set_port((struct sockaddr *)&myaddr, port);
1784 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1785 transport->xprt.addrlen);
1787 transport->srcport = port;
1791 port = xs_next_srcport(transport, port);
1794 } while (err == -EADDRINUSE && nloop != 2);
1796 if (myaddr.ss_family == AF_INET)
1797 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1798 &((struct sockaddr_in *)&myaddr)->sin_addr,
1799 port, err ? "failed" : "ok", err);
1801 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1802 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1803 port, err ? "failed" : "ok", err);
1808 * We don't support autobind on AF_LOCAL sockets
1810 static void xs_local_rpcbind(struct rpc_task *task)
1812 xprt_set_bound(task->tk_xprt);
1815 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1819 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1820 static struct lock_class_key xs_key[2];
1821 static struct lock_class_key xs_slock_key[2];
1823 static inline void xs_reclassify_socketu(struct socket *sock)
1825 struct sock *sk = sock->sk;
1827 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1828 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1831 static inline void xs_reclassify_socket4(struct socket *sock)
1833 struct sock *sk = sock->sk;
1835 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1836 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1839 static inline void xs_reclassify_socket6(struct socket *sock)
1841 struct sock *sk = sock->sk;
1843 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1844 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1847 static inline void xs_reclassify_socket(int family, struct socket *sock)
1849 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1854 xs_reclassify_socketu(sock);
1857 xs_reclassify_socket4(sock);
1860 xs_reclassify_socket6(sock);
1865 static inline void xs_reclassify_socket(int family, struct socket *sock)
1870 static void xs_dummy_setup_socket(struct work_struct *work)
1874 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1875 struct sock_xprt *transport, int family, int type,
1876 int protocol, bool reuseport)
1878 struct socket *sock;
1881 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1883 dprintk("RPC: can't create %d transport socket (%d).\n",
1887 xs_reclassify_socket(family, sock);
1890 xs_sock_set_reuseport(sock);
1892 err = xs_bind(transport, sock);
1900 return ERR_PTR(err);
1903 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1904 struct socket *sock)
1906 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1909 if (!transport->inet) {
1910 struct sock *sk = sock->sk;
1912 write_lock_bh(&sk->sk_callback_lock);
1914 xs_save_old_callbacks(transport, sk);
1916 sk->sk_user_data = xprt;
1917 sk->sk_data_ready = xs_data_ready;
1918 sk->sk_write_space = xs_udp_write_space;
1919 sock_set_flag(sk, SOCK_FASYNC);
1920 sk->sk_error_report = xs_error_report;
1922 xprt_clear_connected(xprt);
1924 /* Reset to new socket */
1925 transport->sock = sock;
1926 transport->inet = sk;
1928 write_unlock_bh(&sk->sk_callback_lock);
1931 xs_stream_start_connect(transport);
1933 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1937 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1938 * @transport: socket transport to connect
1940 static int xs_local_setup_socket(struct sock_xprt *transport)
1942 struct rpc_xprt *xprt = &transport->xprt;
1943 struct socket *sock;
1946 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1947 SOCK_STREAM, 0, &sock, 1);
1949 dprintk("RPC: can't create AF_LOCAL "
1950 "transport socket (%d).\n", -status);
1953 xs_reclassify_socket(AF_LOCAL, sock);
1955 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1956 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1958 status = xs_local_finish_connecting(xprt, sock);
1959 trace_rpc_socket_connect(xprt, sock, status);
1962 dprintk("RPC: xprt %p connected to %s\n",
1963 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1964 xprt->stat.connect_count++;
1965 xprt->stat.connect_time += (long)jiffies -
1966 xprt->stat.connect_start;
1967 xprt_set_connected(xprt);
1971 dprintk("RPC: xprt %p: socket %s does not exist\n",
1972 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1975 dprintk("RPC: xprt %p: connection refused for %s\n",
1976 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1979 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1981 xprt->address_strings[RPC_DISPLAY_ADDR]);
1985 xprt_clear_connecting(xprt);
1986 xprt_wake_pending_tasks(xprt, status);
1990 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1992 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1995 if (RPC_IS_ASYNC(task)) {
1997 * We want the AF_LOCAL connect to be resolved in the
1998 * filesystem namespace of the process making the rpc
1999 * call. Thus we connect synchronously.
2001 * If we want to support asynchronous AF_LOCAL calls,
2002 * we'll need to figure out how to pass a namespace to
2005 rpc_exit(task, -ENOTCONN);
2008 ret = xs_local_setup_socket(transport);
2009 if (ret && !RPC_IS_SOFTCONN(task))
2010 msleep_interruptible(15000);
2013 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2015 * Note that this should be called with XPRT_LOCKED held (or when we otherwise
2016 * know that we have exclusive access to the socket), to guard against
2017 * races with xs_reset_transport.
2019 static void xs_set_memalloc(struct rpc_xprt *xprt)
2021 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
2025 * If there's no sock, then we have nothing to set. The
2026 * reconnecting process will get it for us.
2028 if (!transport->inet)
2030 if (atomic_read(&xprt->swapper))
2031 sk_set_memalloc(transport->inet);
2035 * xs_enable_swap - Tag this transport as being used for swap.
2036 * @xprt: transport to tag
2038 * Take a reference to this transport on behalf of the rpc_clnt, and
2039 * optionally mark it for swapping if it wasn't already.
2042 xs_enable_swap(struct rpc_xprt *xprt)
2044 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2046 if (atomic_inc_return(&xprt->swapper) != 1)
2048 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2049 return -ERESTARTSYS;
2051 sk_set_memalloc(xs->inet);
2052 xprt_release_xprt(xprt, NULL);
2057 * xs_disable_swap - Untag this transport as being used for swap.
2058 * @xprt: transport to tag
2060 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2061 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2064 xs_disable_swap(struct rpc_xprt *xprt)
2066 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2068 if (!atomic_dec_and_test(&xprt->swapper))
2070 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2073 sk_clear_memalloc(xs->inet);
2074 xprt_release_xprt(xprt, NULL);
2077 static void xs_set_memalloc(struct rpc_xprt *xprt)
2082 xs_enable_swap(struct rpc_xprt *xprt)
2088 xs_disable_swap(struct rpc_xprt *xprt)
2093 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2095 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2097 if (!transport->inet) {
2098 struct sock *sk = sock->sk;
2100 write_lock_bh(&sk->sk_callback_lock);
2102 xs_save_old_callbacks(transport, sk);
2104 sk->sk_user_data = xprt;
2105 sk->sk_data_ready = xs_data_ready;
2106 sk->sk_write_space = xs_udp_write_space;
2107 sock_set_flag(sk, SOCK_FASYNC);
2109 xprt_set_connected(xprt);
2111 /* Reset to new socket */
2112 transport->sock = sock;
2113 transport->inet = sk;
2115 xs_set_memalloc(xprt);
2117 write_unlock_bh(&sk->sk_callback_lock);
2119 xs_udp_do_set_buffer_size(xprt);
2121 xprt->stat.connect_start = jiffies;
2124 static void xs_udp_setup_socket(struct work_struct *work)
2126 struct sock_xprt *transport =
2127 container_of(work, struct sock_xprt, connect_worker.work);
2128 struct rpc_xprt *xprt = &transport->xprt;
2129 struct socket *sock;
2132 sock = xs_create_sock(xprt, transport,
2133 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2134 IPPROTO_UDP, false);
2138 dprintk("RPC: worker connecting xprt %p via %s to "
2139 "%s (port %s)\n", xprt,
2140 xprt->address_strings[RPC_DISPLAY_PROTO],
2141 xprt->address_strings[RPC_DISPLAY_ADDR],
2142 xprt->address_strings[RPC_DISPLAY_PORT]);
2144 xs_udp_finish_connecting(xprt, sock);
2145 trace_rpc_socket_connect(xprt, sock, 0);
2148 xprt_clear_connecting(xprt);
2149 xprt_unlock_connect(xprt, transport);
2150 xprt_wake_pending_tasks(xprt, status);
2154 * xs_tcp_shutdown - gracefully shut down a TCP socket
2157 * Initiates a graceful shutdown of the TCP socket by calling the
2158 * equivalent of shutdown(SHUT_RDWR);
2160 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2162 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2163 struct socket *sock = transport->sock;
2164 int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE;
2170 kernel_sock_shutdown(sock, SHUT_RDWR);
2171 trace_rpc_socket_shutdown(xprt, sock);
2175 xs_reset_transport(transport);
2179 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2180 struct socket *sock)
2182 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2183 unsigned int keepidle;
2184 unsigned int keepcnt;
2185 unsigned int opt_on = 1;
2188 spin_lock_bh(&xprt->transport_lock);
2189 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2190 keepcnt = xprt->timeout->to_retries + 1;
2191 timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2192 (xprt->timeout->to_retries + 1);
2193 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2194 spin_unlock_bh(&xprt->transport_lock);
2196 /* TCP Keepalive options */
2197 kernel_setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE,
2198 (char *)&opt_on, sizeof(opt_on));
2199 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPIDLE,
2200 (char *)&keepidle, sizeof(keepidle));
2201 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPINTVL,
2202 (char *)&keepidle, sizeof(keepidle));
2203 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPCNT,
2204 (char *)&keepcnt, sizeof(keepcnt));
2206 /* TCP user timeout (see RFC5482) */
2207 kernel_setsockopt(sock, SOL_TCP, TCP_USER_TIMEOUT,
2208 (char *)&timeo, sizeof(timeo));
2211 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2212 unsigned long connect_timeout,
2213 unsigned long reconnect_timeout)
2215 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2216 struct rpc_timeout to;
2217 unsigned long initval;
2219 spin_lock_bh(&xprt->transport_lock);
2220 if (reconnect_timeout < xprt->max_reconnect_timeout)
2221 xprt->max_reconnect_timeout = reconnect_timeout;
2222 if (connect_timeout < xprt->connect_timeout) {
2223 memcpy(&to, xprt->timeout, sizeof(to));
2224 initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1);
2225 /* Arbitrary lower limit */
2226 if (initval < XS_TCP_INIT_REEST_TO << 1)
2227 initval = XS_TCP_INIT_REEST_TO << 1;
2228 to.to_initval = initval;
2229 to.to_maxval = initval;
2230 memcpy(&transport->tcp_timeout, &to,
2231 sizeof(transport->tcp_timeout));
2232 xprt->timeout = &transport->tcp_timeout;
2233 xprt->connect_timeout = connect_timeout;
2235 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2236 spin_unlock_bh(&xprt->transport_lock);
2239 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2241 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2242 int ret = -ENOTCONN;
2244 if (!transport->inet) {
2245 struct sock *sk = sock->sk;
2246 unsigned int addr_pref = IPV6_PREFER_SRC_PUBLIC;
2248 /* Avoid temporary address, they are bad for long-lived
2249 * connections such as NFS mounts.
2250 * RFC4941, section 3.6 suggests that:
2251 * Individual applications, which have specific
2252 * knowledge about the normal duration of connections,
2253 * MAY override this as appropriate.
2255 kernel_setsockopt(sock, SOL_IPV6, IPV6_ADDR_PREFERENCES,
2256 (char *)&addr_pref, sizeof(addr_pref));
2258 xs_tcp_set_socket_timeouts(xprt, sock);
2260 write_lock_bh(&sk->sk_callback_lock);
2262 xs_save_old_callbacks(transport, sk);
2264 sk->sk_user_data = xprt;
2265 sk->sk_data_ready = xs_data_ready;
2266 sk->sk_state_change = xs_tcp_state_change;
2267 sk->sk_write_space = xs_tcp_write_space;
2268 sock_set_flag(sk, SOCK_FASYNC);
2269 sk->sk_error_report = xs_error_report;
2271 /* socket options */
2272 sock_reset_flag(sk, SOCK_LINGER);
2273 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2275 xprt_clear_connected(xprt);
2277 /* Reset to new socket */
2278 transport->sock = sock;
2279 transport->inet = sk;
2281 write_unlock_bh(&sk->sk_callback_lock);
2284 if (!xprt_bound(xprt))
2287 xs_set_memalloc(xprt);
2289 xs_stream_start_connect(transport);
2291 /* Tell the socket layer to start connecting... */
2292 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2293 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2296 xs_set_srcport(transport, sock);
2300 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2301 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2303 case -EADDRNOTAVAIL:
2304 /* Source port number is unavailable. Try a new one! */
2305 transport->srcport = 0;
2312 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2313 * @work: queued work item
2315 * Invoked by a work queue tasklet.
2317 static void xs_tcp_setup_socket(struct work_struct *work)
2319 struct sock_xprt *transport =
2320 container_of(work, struct sock_xprt, connect_worker.work);
2321 struct socket *sock = transport->sock;
2322 struct rpc_xprt *xprt = &transport->xprt;
2326 sock = xs_create_sock(xprt, transport,
2327 xs_addr(xprt)->sa_family, SOCK_STREAM,
2330 status = PTR_ERR(sock);
2335 dprintk("RPC: worker connecting xprt %p via %s to "
2336 "%s (port %s)\n", xprt,
2337 xprt->address_strings[RPC_DISPLAY_PROTO],
2338 xprt->address_strings[RPC_DISPLAY_ADDR],
2339 xprt->address_strings[RPC_DISPLAY_PORT]);
2341 status = xs_tcp_finish_connecting(xprt, sock);
2342 trace_rpc_socket_connect(xprt, sock, status);
2343 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2344 xprt, -status, xprt_connected(xprt),
2345 sock->sk->sk_state);
2348 printk("%s: connect returned unhandled error %d\n",
2351 case -EADDRNOTAVAIL:
2352 /* We're probably in TIME_WAIT. Get rid of existing socket,
2355 xs_tcp_force_close(xprt);
2360 xprt_unlock_connect(xprt, transport);
2363 /* Happens, for instance, if the user specified a link
2364 * local IPv6 address without a scope-id.
2374 * xs_tcp_force_close() wakes tasks with -EIO.
2375 * We need to wake them first to ensure the
2376 * correct error code.
2378 xprt_wake_pending_tasks(xprt, status);
2379 xs_tcp_force_close(xprt);
2384 xprt_clear_connecting(xprt);
2385 xprt_unlock_connect(xprt, transport);
2386 xprt_wake_pending_tasks(xprt, status);
2389 static unsigned long xs_reconnect_delay(const struct rpc_xprt *xprt)
2391 unsigned long start, now = jiffies;
2393 start = xprt->stat.connect_start + xprt->reestablish_timeout;
2394 if (time_after(start, now))
2399 static void xs_reconnect_backoff(struct rpc_xprt *xprt)
2401 xprt->reestablish_timeout <<= 1;
2402 if (xprt->reestablish_timeout > xprt->max_reconnect_timeout)
2403 xprt->reestablish_timeout = xprt->max_reconnect_timeout;
2404 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2405 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2409 * xs_connect - connect a socket to a remote endpoint
2410 * @xprt: pointer to transport structure
2411 * @task: address of RPC task that manages state of connect request
2413 * TCP: If the remote end dropped the connection, delay reconnecting.
2415 * UDP socket connects are synchronous, but we use a work queue anyway
2416 * to guarantee that even unprivileged user processes can set up a
2417 * socket on a privileged port.
2419 * If a UDP socket connect fails, the delay behavior here prevents
2420 * retry floods (hard mounts).
2422 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2424 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2425 unsigned long delay = 0;
2427 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2429 if (transport->sock != NULL) {
2430 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2432 xprt, xprt->reestablish_timeout / HZ);
2434 /* Start by resetting any existing state */
2435 xs_reset_transport(transport);
2437 delay = xs_reconnect_delay(xprt);
2438 xs_reconnect_backoff(xprt);
2441 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2443 queue_delayed_work(xprtiod_workqueue,
2444 &transport->connect_worker,
2449 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2450 * @xprt: rpc_xprt struct containing statistics
2454 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2458 if (xprt_connected(xprt))
2459 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2461 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2462 "%llu %llu %lu %llu %llu\n",
2463 xprt->stat.bind_count,
2464 xprt->stat.connect_count,
2465 xprt->stat.connect_time / HZ,
2469 xprt->stat.bad_xids,
2472 xprt->stat.max_slots,
2473 xprt->stat.sending_u,
2474 xprt->stat.pending_u);
2478 * xs_udp_print_stats - display UDP socket-specifc stats
2479 * @xprt: rpc_xprt struct containing statistics
2483 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2485 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2487 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2490 xprt->stat.bind_count,
2493 xprt->stat.bad_xids,
2496 xprt->stat.max_slots,
2497 xprt->stat.sending_u,
2498 xprt->stat.pending_u);
2502 * xs_tcp_print_stats - display TCP socket-specifc stats
2503 * @xprt: rpc_xprt struct containing statistics
2507 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2509 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2512 if (xprt_connected(xprt))
2513 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2515 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2516 "%llu %llu %lu %llu %llu\n",
2518 xprt->stat.bind_count,
2519 xprt->stat.connect_count,
2520 xprt->stat.connect_time / HZ,
2524 xprt->stat.bad_xids,
2527 xprt->stat.max_slots,
2528 xprt->stat.sending_u,
2529 xprt->stat.pending_u);
2533 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2534 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2535 * to use the server side send routines.
2537 static int bc_malloc(struct rpc_task *task)
2539 struct rpc_rqst *rqst = task->tk_rqstp;
2540 size_t size = rqst->rq_callsize;
2542 struct rpc_buffer *buf;
2544 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2545 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2550 page = alloc_page(GFP_KERNEL);
2554 buf = page_address(page);
2555 buf->len = PAGE_SIZE;
2557 rqst->rq_buffer = buf->data;
2558 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2563 * Free the space allocated in the bc_alloc routine
2565 static void bc_free(struct rpc_task *task)
2567 void *buffer = task->tk_rqstp->rq_buffer;
2568 struct rpc_buffer *buf;
2570 buf = container_of(buffer, struct rpc_buffer, data);
2571 free_page((unsigned long)buf);
2575 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2576 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2578 static int bc_sendto(struct rpc_rqst *req)
2581 struct xdr_buf *xbufp = &req->rq_snd_buf;
2582 struct rpc_xprt *xprt = req->rq_xprt;
2583 struct sock_xprt *transport =
2584 container_of(xprt, struct sock_xprt, xprt);
2585 struct socket *sock = transport->sock;
2586 unsigned long headoff;
2587 unsigned long tailoff;
2589 xs_encode_stream_record_marker(xbufp);
2591 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2592 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2593 len = svc_send_common(sock, xbufp,
2594 virt_to_page(xbufp->head[0].iov_base), headoff,
2595 xbufp->tail[0].iov_base, tailoff);
2597 if (len != xbufp->len) {
2598 printk(KERN_NOTICE "Error sending entire callback!\n");
2606 * The send routine. Borrows from svc_send
2608 static int bc_send_request(struct rpc_rqst *req)
2610 struct svc_xprt *xprt;
2613 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2615 * Get the server socket associated with this callback xprt
2617 xprt = req->rq_xprt->bc_xprt;
2620 * Grab the mutex to serialize data as the connection is shared
2621 * with the fore channel
2623 mutex_lock(&xprt->xpt_mutex);
2624 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2627 len = bc_sendto(req);
2628 mutex_unlock(&xprt->xpt_mutex);
2637 * The close routine. Since this is client initiated, we do nothing
2640 static void bc_close(struct rpc_xprt *xprt)
2645 * The xprt destroy routine. Again, because this connection is client
2646 * initiated, we do nothing
2649 static void bc_destroy(struct rpc_xprt *xprt)
2651 dprintk("RPC: bc_destroy xprt %p\n", xprt);
2654 module_put(THIS_MODULE);
2657 static const struct rpc_xprt_ops xs_local_ops = {
2658 .reserve_xprt = xprt_reserve_xprt,
2659 .release_xprt = xprt_release_xprt,
2660 .alloc_slot = xprt_alloc_slot,
2661 .free_slot = xprt_free_slot,
2662 .rpcbind = xs_local_rpcbind,
2663 .set_port = xs_local_set_port,
2664 .connect = xs_local_connect,
2665 .buf_alloc = rpc_malloc,
2666 .buf_free = rpc_free,
2667 .prepare_request = xs_stream_prepare_request,
2668 .send_request = xs_local_send_request,
2669 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2671 .destroy = xs_destroy,
2672 .print_stats = xs_local_print_stats,
2673 .enable_swap = xs_enable_swap,
2674 .disable_swap = xs_disable_swap,
2677 static const struct rpc_xprt_ops xs_udp_ops = {
2678 .set_buffer_size = xs_udp_set_buffer_size,
2679 .reserve_xprt = xprt_reserve_xprt_cong,
2680 .release_xprt = xprt_release_xprt_cong,
2681 .alloc_slot = xprt_alloc_slot,
2682 .free_slot = xprt_free_slot,
2683 .rpcbind = rpcb_getport_async,
2684 .set_port = xs_set_port,
2685 .connect = xs_connect,
2686 .buf_alloc = rpc_malloc,
2687 .buf_free = rpc_free,
2688 .send_request = xs_udp_send_request,
2689 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2690 .timer = xs_udp_timer,
2691 .release_request = xprt_release_rqst_cong,
2693 .destroy = xs_destroy,
2694 .print_stats = xs_udp_print_stats,
2695 .enable_swap = xs_enable_swap,
2696 .disable_swap = xs_disable_swap,
2697 .inject_disconnect = xs_inject_disconnect,
2700 static const struct rpc_xprt_ops xs_tcp_ops = {
2701 .reserve_xprt = xprt_reserve_xprt,
2702 .release_xprt = xprt_release_xprt,
2703 .alloc_slot = xprt_alloc_slot,
2704 .free_slot = xprt_free_slot,
2705 .rpcbind = rpcb_getport_async,
2706 .set_port = xs_set_port,
2707 .connect = xs_connect,
2708 .buf_alloc = rpc_malloc,
2709 .buf_free = rpc_free,
2710 .prepare_request = xs_stream_prepare_request,
2711 .send_request = xs_tcp_send_request,
2712 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2713 .close = xs_tcp_shutdown,
2714 .destroy = xs_destroy,
2715 .set_connect_timeout = xs_tcp_set_connect_timeout,
2716 .print_stats = xs_tcp_print_stats,
2717 .enable_swap = xs_enable_swap,
2718 .disable_swap = xs_disable_swap,
2719 .inject_disconnect = xs_inject_disconnect,
2720 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2721 .bc_setup = xprt_setup_bc,
2722 .bc_maxpayload = xs_tcp_bc_maxpayload,
2723 .bc_free_rqst = xprt_free_bc_rqst,
2724 .bc_destroy = xprt_destroy_bc,
2729 * The rpc_xprt_ops for the server backchannel
2732 static const struct rpc_xprt_ops bc_tcp_ops = {
2733 .reserve_xprt = xprt_reserve_xprt,
2734 .release_xprt = xprt_release_xprt,
2735 .alloc_slot = xprt_alloc_slot,
2736 .free_slot = xprt_free_slot,
2737 .buf_alloc = bc_malloc,
2738 .buf_free = bc_free,
2739 .send_request = bc_send_request,
2740 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2742 .destroy = bc_destroy,
2743 .print_stats = xs_tcp_print_stats,
2744 .enable_swap = xs_enable_swap,
2745 .disable_swap = xs_disable_swap,
2746 .inject_disconnect = xs_inject_disconnect,
2749 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2751 static const struct sockaddr_in sin = {
2752 .sin_family = AF_INET,
2753 .sin_addr.s_addr = htonl(INADDR_ANY),
2755 static const struct sockaddr_in6 sin6 = {
2756 .sin6_family = AF_INET6,
2757 .sin6_addr = IN6ADDR_ANY_INIT,
2764 memcpy(sap, &sin, sizeof(sin));
2767 memcpy(sap, &sin6, sizeof(sin6));
2770 dprintk("RPC: %s: Bad address family\n", __func__);
2771 return -EAFNOSUPPORT;
2776 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2777 unsigned int slot_table_size,
2778 unsigned int max_slot_table_size)
2780 struct rpc_xprt *xprt;
2781 struct sock_xprt *new;
2783 if (args->addrlen > sizeof(xprt->addr)) {
2784 dprintk("RPC: xs_setup_xprt: address too large\n");
2785 return ERR_PTR(-EBADF);
2788 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2789 max_slot_table_size);
2791 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2793 return ERR_PTR(-ENOMEM);
2796 new = container_of(xprt, struct sock_xprt, xprt);
2797 mutex_init(&new->recv_mutex);
2798 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2799 xprt->addrlen = args->addrlen;
2801 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2804 err = xs_init_anyaddr(args->dstaddr->sa_family,
2805 (struct sockaddr *)&new->srcaddr);
2808 return ERR_PTR(err);
2815 static const struct rpc_timeout xs_local_default_timeout = {
2816 .to_initval = 10 * HZ,
2817 .to_maxval = 10 * HZ,
2822 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2823 * @args: rpc transport creation arguments
2825 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2827 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2829 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2830 struct sock_xprt *transport;
2831 struct rpc_xprt *xprt;
2832 struct rpc_xprt *ret;
2834 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2835 xprt_max_tcp_slot_table_entries);
2838 transport = container_of(xprt, struct sock_xprt, xprt);
2841 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2842 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2844 xprt->bind_timeout = XS_BIND_TO;
2845 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2846 xprt->idle_timeout = XS_IDLE_DISC_TO;
2848 xprt->ops = &xs_local_ops;
2849 xprt->timeout = &xs_local_default_timeout;
2851 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2852 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
2854 switch (sun->sun_family) {
2856 if (sun->sun_path[0] != '/') {
2857 dprintk("RPC: bad AF_LOCAL address: %s\n",
2859 ret = ERR_PTR(-EINVAL);
2862 xprt_set_bound(xprt);
2863 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2864 ret = ERR_PTR(xs_local_setup_socket(transport));
2869 ret = ERR_PTR(-EAFNOSUPPORT);
2873 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2874 xprt->address_strings[RPC_DISPLAY_ADDR]);
2876 if (try_module_get(THIS_MODULE))
2878 ret = ERR_PTR(-EINVAL);
2884 static const struct rpc_timeout xs_udp_default_timeout = {
2885 .to_initval = 5 * HZ,
2886 .to_maxval = 30 * HZ,
2887 .to_increment = 5 * HZ,
2892 * xs_setup_udp - Set up transport to use a UDP socket
2893 * @args: rpc transport creation arguments
2896 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2898 struct sockaddr *addr = args->dstaddr;
2899 struct rpc_xprt *xprt;
2900 struct sock_xprt *transport;
2901 struct rpc_xprt *ret;
2903 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2904 xprt_udp_slot_table_entries);
2907 transport = container_of(xprt, struct sock_xprt, xprt);
2909 xprt->prot = IPPROTO_UDP;
2911 /* XXX: header size can vary due to auth type, IPv6, etc. */
2912 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2914 xprt->bind_timeout = XS_BIND_TO;
2915 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2916 xprt->idle_timeout = XS_IDLE_DISC_TO;
2918 xprt->ops = &xs_udp_ops;
2920 xprt->timeout = &xs_udp_default_timeout;
2922 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
2923 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
2925 switch (addr->sa_family) {
2927 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2928 xprt_set_bound(xprt);
2930 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2933 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2934 xprt_set_bound(xprt);
2936 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2939 ret = ERR_PTR(-EAFNOSUPPORT);
2943 if (xprt_bound(xprt))
2944 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2945 xprt->address_strings[RPC_DISPLAY_ADDR],
2946 xprt->address_strings[RPC_DISPLAY_PORT],
2947 xprt->address_strings[RPC_DISPLAY_PROTO]);
2949 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2950 xprt->address_strings[RPC_DISPLAY_ADDR],
2951 xprt->address_strings[RPC_DISPLAY_PROTO]);
2953 if (try_module_get(THIS_MODULE))
2955 ret = ERR_PTR(-EINVAL);
2961 static const struct rpc_timeout xs_tcp_default_timeout = {
2962 .to_initval = 60 * HZ,
2963 .to_maxval = 60 * HZ,
2968 * xs_setup_tcp - Set up transport to use a TCP socket
2969 * @args: rpc transport creation arguments
2972 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2974 struct sockaddr *addr = args->dstaddr;
2975 struct rpc_xprt *xprt;
2976 struct sock_xprt *transport;
2977 struct rpc_xprt *ret;
2978 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
2980 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
2981 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
2983 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2984 max_slot_table_size);
2987 transport = container_of(xprt, struct sock_xprt, xprt);
2989 xprt->prot = IPPROTO_TCP;
2990 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2991 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2993 xprt->bind_timeout = XS_BIND_TO;
2994 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2995 xprt->idle_timeout = XS_IDLE_DISC_TO;
2997 xprt->ops = &xs_tcp_ops;
2998 xprt->timeout = &xs_tcp_default_timeout;
3000 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
3001 xprt->connect_timeout = xprt->timeout->to_initval *
3002 (xprt->timeout->to_retries + 1);
3004 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
3005 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
3007 switch (addr->sa_family) {
3009 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3010 xprt_set_bound(xprt);
3012 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3015 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3016 xprt_set_bound(xprt);
3018 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3021 ret = ERR_PTR(-EAFNOSUPPORT);
3025 if (xprt_bound(xprt))
3026 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3027 xprt->address_strings[RPC_DISPLAY_ADDR],
3028 xprt->address_strings[RPC_DISPLAY_PORT],
3029 xprt->address_strings[RPC_DISPLAY_PROTO]);
3031 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3032 xprt->address_strings[RPC_DISPLAY_ADDR],
3033 xprt->address_strings[RPC_DISPLAY_PROTO]);
3035 if (try_module_get(THIS_MODULE))
3037 ret = ERR_PTR(-EINVAL);
3044 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3045 * @args: rpc transport creation arguments
3048 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
3050 struct sockaddr *addr = args->dstaddr;
3051 struct rpc_xprt *xprt;
3052 struct sock_xprt *transport;
3053 struct svc_sock *bc_sock;
3054 struct rpc_xprt *ret;
3056 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3057 xprt_tcp_slot_table_entries);
3060 transport = container_of(xprt, struct sock_xprt, xprt);
3062 xprt->prot = IPPROTO_TCP;
3063 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
3064 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3065 xprt->timeout = &xs_tcp_default_timeout;
3068 xprt_set_bound(xprt);
3069 xprt->bind_timeout = 0;
3070 xprt->reestablish_timeout = 0;
3071 xprt->idle_timeout = 0;
3073 xprt->ops = &bc_tcp_ops;
3075 switch (addr->sa_family) {
3077 xs_format_peer_addresses(xprt, "tcp",
3081 xs_format_peer_addresses(xprt, "tcp",
3082 RPCBIND_NETID_TCP6);
3085 ret = ERR_PTR(-EAFNOSUPPORT);
3089 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3090 xprt->address_strings[RPC_DISPLAY_ADDR],
3091 xprt->address_strings[RPC_DISPLAY_PORT],
3092 xprt->address_strings[RPC_DISPLAY_PROTO]);
3095 * Once we've associated a backchannel xprt with a connection,
3096 * we want to keep it around as long as the connection lasts,
3097 * in case we need to start using it for a backchannel again;
3098 * this reference won't be dropped until bc_xprt is destroyed.
3101 args->bc_xprt->xpt_bc_xprt = xprt;
3102 xprt->bc_xprt = args->bc_xprt;
3103 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3104 transport->sock = bc_sock->sk_sock;
3105 transport->inet = bc_sock->sk_sk;
3108 * Since we don't want connections for the backchannel, we set
3109 * the xprt status to connected
3111 xprt_set_connected(xprt);
3113 if (try_module_get(THIS_MODULE))
3116 args->bc_xprt->xpt_bc_xprt = NULL;
3117 args->bc_xprt->xpt_bc_xps = NULL;
3119 ret = ERR_PTR(-EINVAL);
3125 static struct xprt_class xs_local_transport = {
3126 .list = LIST_HEAD_INIT(xs_local_transport.list),
3127 .name = "named UNIX socket",
3128 .owner = THIS_MODULE,
3129 .ident = XPRT_TRANSPORT_LOCAL,
3130 .setup = xs_setup_local,
3133 static struct xprt_class xs_udp_transport = {
3134 .list = LIST_HEAD_INIT(xs_udp_transport.list),
3136 .owner = THIS_MODULE,
3137 .ident = XPRT_TRANSPORT_UDP,
3138 .setup = xs_setup_udp,
3141 static struct xprt_class xs_tcp_transport = {
3142 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
3144 .owner = THIS_MODULE,
3145 .ident = XPRT_TRANSPORT_TCP,
3146 .setup = xs_setup_tcp,
3149 static struct xprt_class xs_bc_tcp_transport = {
3150 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3151 .name = "tcp NFSv4.1 backchannel",
3152 .owner = THIS_MODULE,
3153 .ident = XPRT_TRANSPORT_BC_TCP,
3154 .setup = xs_setup_bc_tcp,
3158 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3161 int init_socket_xprt(void)
3163 if (!sunrpc_table_header)
3164 sunrpc_table_header = register_sysctl_table(sunrpc_table);
3166 xprt_register_transport(&xs_local_transport);
3167 xprt_register_transport(&xs_udp_transport);
3168 xprt_register_transport(&xs_tcp_transport);
3169 xprt_register_transport(&xs_bc_tcp_transport);
3175 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3178 void cleanup_socket_xprt(void)
3180 if (sunrpc_table_header) {
3181 unregister_sysctl_table(sunrpc_table_header);
3182 sunrpc_table_header = NULL;
3185 xprt_unregister_transport(&xs_local_transport);
3186 xprt_unregister_transport(&xs_udp_transport);
3187 xprt_unregister_transport(&xs_tcp_transport);
3188 xprt_unregister_transport(&xs_bc_tcp_transport);
3191 static int param_set_uint_minmax(const char *val,
3192 const struct kernel_param *kp,
3193 unsigned int min, unsigned int max)
3200 ret = kstrtouint(val, 0, &num);
3203 if (num < min || num > max)
3205 *((unsigned int *)kp->arg) = num;
3209 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3211 return param_set_uint_minmax(val, kp,
3216 static const struct kernel_param_ops param_ops_portnr = {
3217 .set = param_set_portnr,
3218 .get = param_get_uint,
3221 #define param_check_portnr(name, p) \
3222 __param_check(name, p, unsigned int);
3224 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3225 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3227 static int param_set_slot_table_size(const char *val,
3228 const struct kernel_param *kp)
3230 return param_set_uint_minmax(val, kp,
3232 RPC_MAX_SLOT_TABLE);
3235 static const struct kernel_param_ops param_ops_slot_table_size = {
3236 .set = param_set_slot_table_size,
3237 .get = param_get_uint,
3240 #define param_check_slot_table_size(name, p) \
3241 __param_check(name, p, unsigned int);
3243 static int param_set_max_slot_table_size(const char *val,
3244 const struct kernel_param *kp)
3246 return param_set_uint_minmax(val, kp,
3248 RPC_MAX_SLOT_TABLE_LIMIT);
3251 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3252 .set = param_set_max_slot_table_size,
3253 .get = param_get_uint,
3256 #define param_check_max_slot_table_size(name, p) \
3257 __param_check(name, p, unsigned int);
3259 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3260 slot_table_size, 0644);
3261 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3262 max_slot_table_size, 0644);
3263 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3264 slot_table_size, 0644);