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 if (seek < buf->head[0].iov_len) {
409 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))
420 seek -= buf->head[0].iov_len;
421 offset += buf->head[0].iov_len;
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 if (seek < buf->tail[0].iov_len) {
447 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))
457 offset += buf->tail[0].iov_len;
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_request(struct sock_xprt *transport, struct msghdr *msg,
487 int flags, struct rpc_rqst *req)
489 struct xdr_buf *buf = &req->rq_private_buf;
493 xs_read_header(transport, buf);
495 want = transport->recv.len - transport->recv.offset;
496 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
497 transport->recv.copied + want, transport->recv.copied,
499 transport->recv.offset += read;
500 transport->recv.copied += read;
501 if (transport->recv.offset == transport->recv.len) {
502 if (xs_read_stream_request_done(transport))
503 msg->msg_flags |= MSG_EOR;
512 msg->msg_flags |= MSG_TRUNC;
517 return ret < 0 ? ret : read;
521 xs_read_stream_headersize(bool isfrag)
524 return sizeof(__be32);
525 return 3 * sizeof(__be32);
529 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
530 int flags, size_t want, size_t seek)
533 .iov_base = &transport->recv.fraghdr,
536 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
539 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
541 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
543 struct rpc_xprt *xprt = &transport->xprt;
544 struct rpc_rqst *req;
547 /* Look up and lock the request corresponding to the given XID */
548 req = xprt_lookup_bc_request(xprt, transport->recv.xid);
550 printk(KERN_WARNING "Callback slot table overflowed\n");
554 ret = xs_read_stream_request(transport, msg, flags, req);
555 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
556 xprt_complete_bc_request(req, transport->recv.copied);
560 #else /* CONFIG_SUNRPC_BACKCHANNEL */
562 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
566 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
569 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
571 struct rpc_xprt *xprt = &transport->xprt;
572 struct rpc_rqst *req;
575 /* Look up and lock the request corresponding to the given XID */
576 spin_lock(&xprt->queue_lock);
577 req = xprt_lookup_rqst(xprt, transport->recv.xid);
579 msg->msg_flags |= MSG_TRUNC;
583 spin_unlock(&xprt->queue_lock);
585 ret = xs_read_stream_request(transport, msg, flags, req);
587 spin_lock(&xprt->queue_lock);
588 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
589 xprt_complete_rqst(req->rq_task, transport->recv.copied);
590 xprt_unpin_rqst(req);
592 spin_unlock(&xprt->queue_lock);
597 xs_read_stream(struct sock_xprt *transport, int flags)
599 struct msghdr msg = { 0 };
600 size_t want, read = 0;
603 if (transport->recv.len == 0) {
604 want = xs_read_stream_headersize(transport->recv.copied != 0);
605 ret = xs_read_stream_header(transport, &msg, flags, want,
606 transport->recv.offset);
609 transport->recv.offset = ret;
610 if (transport->recv.offset != want)
611 return transport->recv.offset;
612 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
613 RPC_FRAGMENT_SIZE_MASK;
614 transport->recv.offset -= sizeof(transport->recv.fraghdr);
618 switch (be32_to_cpu(transport->recv.calldir)) {
620 msg.msg_flags |= MSG_TRUNC;
623 ret = xs_read_stream_call(transport, &msg, flags);
626 ret = xs_read_stream_reply(transport, &msg, flags);
628 if (msg.msg_flags & MSG_TRUNC) {
629 transport->recv.calldir = cpu_to_be32(-1);
630 transport->recv.copied = -1;
635 if (transport->recv.offset < transport->recv.len) {
636 if (!(msg.msg_flags & MSG_TRUNC))
639 ret = xs_read_discard(transport->sock, &msg, flags,
640 transport->recv.len - transport->recv.offset);
643 transport->recv.offset += ret;
645 if (transport->recv.offset != transport->recv.len)
648 if (xs_read_stream_request_done(transport)) {
649 trace_xs_stream_read_request(transport);
650 transport->recv.copied = 0;
652 transport->recv.offset = 0;
653 transport->recv.len = 0;
656 return ret != 0 ? ret : -ESHUTDOWN;
659 static __poll_t xs_poll_socket(struct sock_xprt *transport)
661 return transport->sock->ops->poll(NULL, transport->sock, NULL);
664 static bool xs_poll_socket_readable(struct sock_xprt *transport)
666 __poll_t events = xs_poll_socket(transport);
668 return (events & (EPOLLIN | EPOLLRDNORM)) && !(events & EPOLLRDHUP);
671 static void xs_poll_check_readable(struct sock_xprt *transport)
674 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
675 if (!xs_poll_socket_readable(transport))
677 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
678 queue_work(xprtiod_workqueue, &transport->recv_worker);
681 static void xs_stream_data_receive(struct sock_xprt *transport)
686 mutex_lock(&transport->recv_mutex);
687 if (transport->sock == NULL)
690 ret = xs_read_stream(transport, MSG_DONTWAIT);
696 xs_poll_check_readable(transport);
698 mutex_unlock(&transport->recv_mutex);
699 trace_xs_stream_read_data(&transport->xprt, ret, read);
702 static void xs_stream_data_receive_workfn(struct work_struct *work)
704 struct sock_xprt *transport =
705 container_of(work, struct sock_xprt, recv_worker);
706 unsigned int pflags = memalloc_nofs_save();
708 xs_stream_data_receive(transport);
709 memalloc_nofs_restore(pflags);
713 xs_stream_reset_connect(struct sock_xprt *transport)
715 transport->recv.offset = 0;
716 transport->recv.len = 0;
717 transport->recv.copied = 0;
718 transport->xmit.offset = 0;
719 transport->xprt.stat.connect_count++;
720 transport->xprt.stat.connect_start = jiffies;
723 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
725 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
727 struct msghdr msg = {
729 .msg_namelen = addrlen,
730 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
733 .iov_base = vec->iov_base + base,
734 .iov_len = vec->iov_len - base,
737 if (iov.iov_len != 0)
738 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
739 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
742 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more, bool zerocopy, int *sent_p)
744 ssize_t (*do_sendpage)(struct socket *sock, struct page *page,
745 int offset, size_t size, int flags);
747 unsigned int remainder;
750 remainder = xdr->page_len - base;
751 base += xdr->page_base;
752 ppage = xdr->pages + (base >> PAGE_SHIFT);
754 do_sendpage = sock->ops->sendpage;
756 do_sendpage = sock_no_sendpage;
758 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
759 int flags = XS_SENDMSG_FLAGS;
765 flags |= MSG_SENDPAGE_NOTLAST | MSG_MORE;
766 err = do_sendpage(sock, *ppage, base, len, flags);
767 if (remainder == 0 || err != len)
781 * xs_sendpages - write pages directly to a socket
782 * @sock: socket to send on
783 * @addr: UDP only -- address of destination
784 * @addrlen: UDP only -- length of destination address
785 * @xdr: buffer containing this request
786 * @base: starting position in the buffer
787 * @zerocopy: true if it is safe to use sendpage()
788 * @sent_p: return the total number of bytes successfully queued for sending
791 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base, bool zerocopy, int *sent_p)
793 unsigned int remainder = xdr->len - base;
805 if (base < xdr->head[0].iov_len || addr != NULL) {
806 unsigned int len = xdr->head[0].iov_len - base;
808 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
809 if (remainder == 0 || err != len)
814 base -= xdr->head[0].iov_len;
816 if (base < xdr->page_len) {
817 unsigned int len = xdr->page_len - base;
819 err = xs_send_pagedata(sock, xdr, base, remainder != 0, zerocopy, &sent);
821 if (remainder == 0 || sent != len)
825 base -= xdr->page_len;
827 if (base >= xdr->tail[0].iov_len)
829 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
839 * xs_nospace - handle transmit was incomplete
840 * @req: pointer to RPC request
843 static int xs_nospace(struct rpc_rqst *req)
845 struct rpc_xprt *xprt = req->rq_xprt;
846 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
847 struct sock *sk = transport->inet;
850 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
851 req->rq_task->tk_pid,
852 req->rq_slen - transport->xmit.offset,
855 /* Protect against races with write_space */
856 spin_lock_bh(&xprt->transport_lock);
858 /* Don't race with disconnect */
859 if (xprt_connected(xprt)) {
860 /* wait for more buffer space */
861 sk->sk_write_pending++;
862 xprt_wait_for_buffer_space(xprt);
866 spin_unlock_bh(&xprt->transport_lock);
868 /* Race breaker in case memory is freed before above code is called */
869 if (ret == -EAGAIN) {
870 struct socket_wq *wq;
873 wq = rcu_dereference(sk->sk_wq);
874 set_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags);
877 sk->sk_write_space(sk);
883 xs_stream_prepare_request(struct rpc_rqst *req)
885 req->rq_task->tk_status = xdr_alloc_bvec(&req->rq_rcv_buf, GFP_NOIO);
889 * Determine if the previous message in the stream was aborted before it
890 * could complete transmission.
893 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
895 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
899 * Construct a stream transport record marker in @buf.
901 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf)
903 u32 reclen = buf->len - sizeof(rpc_fraghdr);
904 rpc_fraghdr *base = buf->head[0].iov_base;
905 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen);
909 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
910 * @req: pointer to RPC request
913 * 0: The request has been sent
914 * EAGAIN: The socket was blocked, please call again later to
915 * complete the request
916 * ENOTCONN: Caller needs to invoke connect logic then call again
917 * other: Some other error occured, the request was not sent
919 static int xs_local_send_request(struct rpc_rqst *req)
921 struct rpc_xprt *xprt = req->rq_xprt;
922 struct sock_xprt *transport =
923 container_of(xprt, struct sock_xprt, xprt);
924 struct xdr_buf *xdr = &req->rq_snd_buf;
928 /* Close the stream if the previous transmission was incomplete */
929 if (xs_send_request_was_aborted(transport, req)) {
934 xs_encode_stream_record_marker(&req->rq_snd_buf);
936 xs_pktdump("packet data:",
937 req->rq_svec->iov_base, req->rq_svec->iov_len);
939 req->rq_xtime = ktime_get();
940 status = xs_sendpages(transport->sock, NULL, 0, xdr,
941 transport->xmit.offset,
943 dprintk("RPC: %s(%u) = %d\n",
944 __func__, xdr->len - transport->xmit.offset, status);
946 if (status == -EAGAIN && sock_writeable(transport->inet))
949 if (likely(sent > 0) || status == 0) {
950 transport->xmit.offset += sent;
951 req->rq_bytes_sent = transport->xmit.offset;
952 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
953 req->rq_xmit_bytes_sent += transport->xmit.offset;
954 transport->xmit.offset = 0;
964 status = xs_nospace(req);
967 dprintk("RPC: sendmsg returned unrecognized error %d\n",
979 * xs_udp_send_request - write an RPC request to a UDP socket
980 * @req: pointer to RPC request
983 * 0: The request has been sent
984 * EAGAIN: The socket was blocked, please call again later to
985 * complete the request
986 * ENOTCONN: Caller needs to invoke connect logic then call again
987 * other: Some other error occurred, the request was not sent
989 static int xs_udp_send_request(struct rpc_rqst *req)
991 struct rpc_xprt *xprt = req->rq_xprt;
992 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
993 struct xdr_buf *xdr = &req->rq_snd_buf;
997 xs_pktdump("packet data:",
998 req->rq_svec->iov_base,
999 req->rq_svec->iov_len);
1001 if (!xprt_bound(xprt))
1004 if (!xprt_request_get_cong(xprt, req))
1007 req->rq_xtime = ktime_get();
1008 status = xs_sendpages(transport->sock, xs_addr(xprt), xprt->addrlen,
1009 xdr, 0, true, &sent);
1011 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
1014 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
1015 if (status == -EPERM)
1016 goto process_status;
1018 if (status == -EAGAIN && sock_writeable(transport->inet))
1021 if (sent > 0 || status == 0) {
1022 req->rq_xmit_bytes_sent += sent;
1023 if (sent >= req->rq_slen)
1025 /* Still some bytes left; set up for a retry later. */
1033 /* Should we call xs_close() here? */
1036 status = xs_nospace(req);
1043 /* When the server has died, an ICMP port unreachable message
1044 * prompts ECONNREFUSED. */
1047 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1055 * xs_tcp_send_request - write an RPC request to a TCP socket
1056 * @req: pointer to RPC request
1059 * 0: The request has been sent
1060 * EAGAIN: The socket was blocked, please call again later to
1061 * complete the request
1062 * ENOTCONN: Caller needs to invoke connect logic then call again
1063 * other: Some other error occurred, the request was not sent
1065 * XXX: In the case of soft timeouts, should we eventually give up
1066 * if sendmsg is not able to make progress?
1068 static int xs_tcp_send_request(struct rpc_rqst *req)
1070 struct rpc_xprt *xprt = req->rq_xprt;
1071 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1072 struct xdr_buf *xdr = &req->rq_snd_buf;
1073 bool zerocopy = true;
1074 bool vm_wait = false;
1078 /* Close the stream if the previous transmission was incomplete */
1079 if (xs_send_request_was_aborted(transport, req)) {
1080 if (transport->sock != NULL)
1081 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1085 xs_encode_stream_record_marker(&req->rq_snd_buf);
1087 xs_pktdump("packet data:",
1088 req->rq_svec->iov_base,
1089 req->rq_svec->iov_len);
1090 /* Don't use zero copy if this is a resend. If the RPC call
1091 * completes while the socket holds a reference to the pages,
1092 * then we may end up resending corrupted data.
1094 if (req->rq_task->tk_flags & RPC_TASK_SENT)
1097 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1098 xs_tcp_set_socket_timeouts(xprt, transport->sock);
1100 /* Continue transmitting the packet/record. We must be careful
1101 * to cope with writespace callbacks arriving _after_ we have
1102 * called sendmsg(). */
1103 req->rq_xtime = ktime_get();
1106 status = xs_sendpages(transport->sock, NULL, 0, xdr,
1107 transport->xmit.offset,
1110 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
1111 xdr->len - transport->xmit.offset, status);
1113 /* If we've sent the entire packet, immediately
1114 * reset the count of bytes sent. */
1115 transport->xmit.offset += sent;
1116 req->rq_bytes_sent = transport->xmit.offset;
1117 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
1118 req->rq_xmit_bytes_sent += transport->xmit.offset;
1119 transport->xmit.offset = 0;
1123 WARN_ON_ONCE(sent == 0 && status == 0);
1125 if (status == -EAGAIN ) {
1127 * Return EAGAIN if we're sure we're hitting the
1128 * socket send buffer limits.
1130 if (test_bit(SOCK_NOSPACE, &transport->sock->flags))
1133 * Did we hit a memory allocation failure?
1139 /* Retry, knowing now that we're below the
1140 * socket send buffer limit
1154 /* Should we call xs_close() here? */
1157 status = xs_nospace(req);
1167 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1174 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1176 transport->old_data_ready = sk->sk_data_ready;
1177 transport->old_state_change = sk->sk_state_change;
1178 transport->old_write_space = sk->sk_write_space;
1179 transport->old_error_report = sk->sk_error_report;
1182 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1184 sk->sk_data_ready = transport->old_data_ready;
1185 sk->sk_state_change = transport->old_state_change;
1186 sk->sk_write_space = transport->old_write_space;
1187 sk->sk_error_report = transport->old_error_report;
1190 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1192 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1194 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1197 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1199 smp_mb__before_atomic();
1200 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1201 clear_bit(XPRT_CLOSING, &xprt->state);
1202 xs_sock_reset_state_flags(xprt);
1203 smp_mb__after_atomic();
1207 * xs_error_report - callback to handle TCP socket state errors
1210 * Note: we don't call sock_error() since there may be a rpc_task
1211 * using the socket, and so we don't want to clear sk->sk_err.
1213 static void xs_error_report(struct sock *sk)
1215 struct rpc_xprt *xprt;
1218 read_lock_bh(&sk->sk_callback_lock);
1219 if (!(xprt = xprt_from_sock(sk)))
1225 dprintk("RPC: xs_error_report client %p, error=%d...\n",
1227 trace_rpc_socket_error(xprt, sk->sk_socket, err);
1228 xprt_wake_pending_tasks(xprt, err);
1230 read_unlock_bh(&sk->sk_callback_lock);
1233 static void xs_reset_transport(struct sock_xprt *transport)
1235 struct socket *sock = transport->sock;
1236 struct sock *sk = transport->inet;
1237 struct rpc_xprt *xprt = &transport->xprt;
1242 if (atomic_read(&transport->xprt.swapper))
1243 sk_clear_memalloc(sk);
1245 kernel_sock_shutdown(sock, SHUT_RDWR);
1247 mutex_lock(&transport->recv_mutex);
1248 write_lock_bh(&sk->sk_callback_lock);
1249 transport->inet = NULL;
1250 transport->sock = NULL;
1252 sk->sk_user_data = NULL;
1254 xs_restore_old_callbacks(transport, sk);
1255 xprt_clear_connected(xprt);
1256 write_unlock_bh(&sk->sk_callback_lock);
1257 xs_sock_reset_connection_flags(xprt);
1258 mutex_unlock(&transport->recv_mutex);
1260 trace_rpc_socket_close(xprt, sock);
1263 xprt_disconnect_done(xprt);
1267 * xs_close - close a socket
1270 * This is used when all requests are complete; ie, no DRC state remains
1271 * on the server we want to save.
1273 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1274 * xs_reset_transport() zeroing the socket from underneath a writer.
1276 static void xs_close(struct rpc_xprt *xprt)
1278 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1280 dprintk("RPC: xs_close xprt %p\n", xprt);
1282 xs_reset_transport(transport);
1283 xprt->reestablish_timeout = 0;
1286 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1288 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
1290 xprt_disconnect_done(xprt);
1293 static void xs_xprt_free(struct rpc_xprt *xprt)
1295 xs_free_peer_addresses(xprt);
1300 * xs_destroy - prepare to shutdown a transport
1301 * @xprt: doomed transport
1304 static void xs_destroy(struct rpc_xprt *xprt)
1306 struct sock_xprt *transport = container_of(xprt,
1307 struct sock_xprt, xprt);
1308 dprintk("RPC: xs_destroy xprt %p\n", xprt);
1310 cancel_delayed_work_sync(&transport->connect_worker);
1312 cancel_work_sync(&transport->recv_worker);
1314 module_put(THIS_MODULE);
1318 * xs_udp_data_read_skb - receive callback for UDP sockets
1324 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1326 struct sk_buff *skb)
1328 struct rpc_task *task;
1329 struct rpc_rqst *rovr;
1330 int repsize, copied;
1336 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1340 /* Copy the XID from the skb... */
1341 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1345 /* Look up and lock the request corresponding to the given XID */
1346 spin_lock(&xprt->queue_lock);
1347 rovr = xprt_lookup_rqst(xprt, *xp);
1350 xprt_pin_rqst(rovr);
1351 xprt_update_rtt(rovr->rq_task);
1352 spin_unlock(&xprt->queue_lock);
1353 task = rovr->rq_task;
1355 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1358 /* Suck it into the iovec, verify checksum if not done by hw. */
1359 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1360 spin_lock(&xprt->queue_lock);
1361 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1366 spin_lock_bh(&xprt->transport_lock);
1367 xprt_adjust_cwnd(xprt, task, copied);
1368 spin_unlock_bh(&xprt->transport_lock);
1369 spin_lock(&xprt->queue_lock);
1370 xprt_complete_rqst(task, copied);
1371 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1373 xprt_unpin_rqst(rovr);
1375 spin_unlock(&xprt->queue_lock);
1378 static void xs_udp_data_receive(struct sock_xprt *transport)
1380 struct sk_buff *skb;
1384 mutex_lock(&transport->recv_mutex);
1385 sk = transport->inet;
1389 skb = skb_recv_udp(sk, 0, 1, &err);
1392 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1396 xs_poll_check_readable(transport);
1398 mutex_unlock(&transport->recv_mutex);
1401 static void xs_udp_data_receive_workfn(struct work_struct *work)
1403 struct sock_xprt *transport =
1404 container_of(work, struct sock_xprt, recv_worker);
1405 unsigned int pflags = memalloc_nofs_save();
1407 xs_udp_data_receive(transport);
1408 memalloc_nofs_restore(pflags);
1412 * xs_data_ready - "data ready" callback for UDP sockets
1413 * @sk: socket with data to read
1416 static void xs_data_ready(struct sock *sk)
1418 struct rpc_xprt *xprt;
1420 read_lock_bh(&sk->sk_callback_lock);
1421 dprintk("RPC: xs_data_ready...\n");
1422 xprt = xprt_from_sock(sk);
1424 struct sock_xprt *transport = container_of(xprt,
1425 struct sock_xprt, xprt);
1426 transport->old_data_ready(sk);
1427 /* Any data means we had a useful conversation, so
1428 * then we don't need to delay the next reconnect
1430 if (xprt->reestablish_timeout)
1431 xprt->reestablish_timeout = 0;
1432 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1433 queue_work(xprtiod_workqueue, &transport->recv_worker);
1435 read_unlock_bh(&sk->sk_callback_lock);
1439 * Helper function to force a TCP close if the server is sending
1440 * junk and/or it has put us in CLOSE_WAIT
1442 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1444 xprt_force_disconnect(xprt);
1447 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1448 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1452 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1455 * xs_tcp_state_change - callback to handle TCP socket state changes
1456 * @sk: socket whose state has changed
1459 static void xs_tcp_state_change(struct sock *sk)
1461 struct rpc_xprt *xprt;
1462 struct sock_xprt *transport;
1464 read_lock_bh(&sk->sk_callback_lock);
1465 if (!(xprt = xprt_from_sock(sk)))
1467 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1468 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1469 sk->sk_state, xprt_connected(xprt),
1470 sock_flag(sk, SOCK_DEAD),
1471 sock_flag(sk, SOCK_ZAPPED),
1474 transport = container_of(xprt, struct sock_xprt, xprt);
1475 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1476 switch (sk->sk_state) {
1477 case TCP_ESTABLISHED:
1478 spin_lock(&xprt->transport_lock);
1479 if (!xprt_test_and_set_connected(xprt)) {
1480 xprt->connect_cookie++;
1481 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1482 xprt_clear_connecting(xprt);
1484 xprt->stat.connect_count++;
1485 xprt->stat.connect_time += (long)jiffies -
1486 xprt->stat.connect_start;
1487 xprt_wake_pending_tasks(xprt, -EAGAIN);
1489 spin_unlock(&xprt->transport_lock);
1492 /* The client initiated a shutdown of the socket */
1493 xprt->connect_cookie++;
1494 xprt->reestablish_timeout = 0;
1495 set_bit(XPRT_CLOSING, &xprt->state);
1496 smp_mb__before_atomic();
1497 clear_bit(XPRT_CONNECTED, &xprt->state);
1498 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1499 smp_mb__after_atomic();
1501 case TCP_CLOSE_WAIT:
1502 /* The server initiated a shutdown of the socket */
1503 xprt->connect_cookie++;
1504 clear_bit(XPRT_CONNECTED, &xprt->state);
1505 xs_tcp_force_close(xprt);
1509 * If the server closed down the connection, make sure that
1510 * we back off before reconnecting
1512 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1513 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1516 set_bit(XPRT_CLOSING, &xprt->state);
1517 smp_mb__before_atomic();
1518 clear_bit(XPRT_CONNECTED, &xprt->state);
1519 smp_mb__after_atomic();
1522 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1523 &transport->sock_state))
1524 xprt_clear_connecting(xprt);
1525 clear_bit(XPRT_CLOSING, &xprt->state);
1526 /* Trigger the socket release */
1527 xs_tcp_force_close(xprt);
1530 read_unlock_bh(&sk->sk_callback_lock);
1533 static void xs_write_space(struct sock *sk)
1535 struct socket_wq *wq;
1536 struct rpc_xprt *xprt;
1540 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1542 if (unlikely(!(xprt = xprt_from_sock(sk))))
1545 wq = rcu_dereference(sk->sk_wq);
1546 if (!wq || test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags) == 0)
1549 if (xprt_write_space(xprt))
1550 sk->sk_write_pending--;
1556 * xs_udp_write_space - callback invoked when socket buffer space
1558 * @sk: socket whose state has changed
1560 * Called when more output buffer space is available for this socket.
1561 * We try not to wake our writers until they can make "significant"
1562 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1563 * with a bunch of small requests.
1565 static void xs_udp_write_space(struct sock *sk)
1567 read_lock_bh(&sk->sk_callback_lock);
1569 /* from net/core/sock.c:sock_def_write_space */
1570 if (sock_writeable(sk))
1573 read_unlock_bh(&sk->sk_callback_lock);
1577 * xs_tcp_write_space - callback invoked when socket buffer space
1579 * @sk: socket whose state has changed
1581 * Called when more output buffer space is available for this socket.
1582 * We try not to wake our writers until they can make "significant"
1583 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1584 * with a bunch of small requests.
1586 static void xs_tcp_write_space(struct sock *sk)
1588 read_lock_bh(&sk->sk_callback_lock);
1590 /* from net/core/stream.c:sk_stream_write_space */
1591 if (sk_stream_is_writeable(sk))
1594 read_unlock_bh(&sk->sk_callback_lock);
1597 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1599 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1600 struct sock *sk = transport->inet;
1602 if (transport->rcvsize) {
1603 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1604 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1606 if (transport->sndsize) {
1607 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1608 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1609 sk->sk_write_space(sk);
1614 * xs_udp_set_buffer_size - set send and receive limits
1615 * @xprt: generic transport
1616 * @sndsize: requested size of send buffer, in bytes
1617 * @rcvsize: requested size of receive buffer, in bytes
1619 * Set socket send and receive buffer size limits.
1621 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1623 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1625 transport->sndsize = 0;
1627 transport->sndsize = sndsize + 1024;
1628 transport->rcvsize = 0;
1630 transport->rcvsize = rcvsize + 1024;
1632 xs_udp_do_set_buffer_size(xprt);
1636 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1637 * @xprt: controlling transport
1638 * @task: task that timed out
1640 * Adjust the congestion window after a retransmit timeout has occurred.
1642 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1644 spin_lock_bh(&xprt->transport_lock);
1645 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1646 spin_unlock_bh(&xprt->transport_lock);
1649 static int xs_get_random_port(void)
1651 unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1652 unsigned short range;
1653 unsigned short rand;
1657 range = max - min + 1;
1658 rand = (unsigned short) prandom_u32() % range;
1663 * xs_set_reuseaddr_port - set the socket's port and address reuse options
1666 * Note that this function has to be called on all sockets that share the
1667 * same port, and it must be called before binding.
1669 static void xs_sock_set_reuseport(struct socket *sock)
1673 kernel_setsockopt(sock, SOL_SOCKET, SO_REUSEPORT,
1674 (char *)&opt, sizeof(opt));
1677 static unsigned short xs_sock_getport(struct socket *sock)
1679 struct sockaddr_storage buf;
1680 unsigned short port = 0;
1682 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1684 switch (buf.ss_family) {
1686 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1689 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1696 * xs_set_port - reset the port number in the remote endpoint address
1697 * @xprt: generic transport
1698 * @port: new port number
1701 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1703 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1705 rpc_set_port(xs_addr(xprt), port);
1706 xs_update_peer_port(xprt);
1709 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1711 if (transport->srcport == 0)
1712 transport->srcport = xs_sock_getport(sock);
1715 static int xs_get_srcport(struct sock_xprt *transport)
1717 int port = transport->srcport;
1719 if (port == 0 && transport->xprt.resvport)
1720 port = xs_get_random_port();
1724 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1726 if (transport->srcport != 0)
1727 transport->srcport = 0;
1728 if (!transport->xprt.resvport)
1730 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1731 return xprt_max_resvport;
1734 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1736 struct sockaddr_storage myaddr;
1738 int port = xs_get_srcport(transport);
1739 unsigned short last;
1742 * If we are asking for any ephemeral port (i.e. port == 0 &&
1743 * transport->xprt.resvport == 0), don't bind. Let the local
1744 * port selection happen implicitly when the socket is used
1745 * (for example at connect time).
1747 * This ensures that we can continue to establish TCP
1748 * connections even when all local ephemeral ports are already
1749 * a part of some TCP connection. This makes no difference
1750 * for UDP sockets, but also doens't harm them.
1752 * If we're asking for any reserved port (i.e. port == 0 &&
1753 * transport->xprt.resvport == 1) xs_get_srcport above will
1754 * ensure that port is non-zero and we will bind as needed.
1759 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1761 rpc_set_port((struct sockaddr *)&myaddr, port);
1762 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1763 transport->xprt.addrlen);
1765 transport->srcport = port;
1769 port = xs_next_srcport(transport, port);
1772 } while (err == -EADDRINUSE && nloop != 2);
1774 if (myaddr.ss_family == AF_INET)
1775 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1776 &((struct sockaddr_in *)&myaddr)->sin_addr,
1777 port, err ? "failed" : "ok", err);
1779 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1780 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1781 port, err ? "failed" : "ok", err);
1786 * We don't support autobind on AF_LOCAL sockets
1788 static void xs_local_rpcbind(struct rpc_task *task)
1790 xprt_set_bound(task->tk_xprt);
1793 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1797 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1798 static struct lock_class_key xs_key[2];
1799 static struct lock_class_key xs_slock_key[2];
1801 static inline void xs_reclassify_socketu(struct socket *sock)
1803 struct sock *sk = sock->sk;
1805 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1806 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1809 static inline void xs_reclassify_socket4(struct socket *sock)
1811 struct sock *sk = sock->sk;
1813 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1814 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1817 static inline void xs_reclassify_socket6(struct socket *sock)
1819 struct sock *sk = sock->sk;
1821 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1822 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1825 static inline void xs_reclassify_socket(int family, struct socket *sock)
1827 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1832 xs_reclassify_socketu(sock);
1835 xs_reclassify_socket4(sock);
1838 xs_reclassify_socket6(sock);
1843 static inline void xs_reclassify_socket(int family, struct socket *sock)
1848 static void xs_dummy_setup_socket(struct work_struct *work)
1852 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1853 struct sock_xprt *transport, int family, int type,
1854 int protocol, bool reuseport)
1856 struct socket *sock;
1859 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1861 dprintk("RPC: can't create %d transport socket (%d).\n",
1865 xs_reclassify_socket(family, sock);
1868 xs_sock_set_reuseport(sock);
1870 err = xs_bind(transport, sock);
1878 return ERR_PTR(err);
1881 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1882 struct socket *sock)
1884 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1887 if (!transport->inet) {
1888 struct sock *sk = sock->sk;
1890 write_lock_bh(&sk->sk_callback_lock);
1892 xs_save_old_callbacks(transport, sk);
1894 sk->sk_user_data = xprt;
1895 sk->sk_data_ready = xs_data_ready;
1896 sk->sk_write_space = xs_udp_write_space;
1897 sock_set_flag(sk, SOCK_FASYNC);
1898 sk->sk_error_report = xs_error_report;
1900 xprt_clear_connected(xprt);
1902 /* Reset to new socket */
1903 transport->sock = sock;
1904 transport->inet = sk;
1906 write_unlock_bh(&sk->sk_callback_lock);
1909 xs_stream_reset_connect(transport);
1911 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1915 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1916 * @transport: socket transport to connect
1918 static int xs_local_setup_socket(struct sock_xprt *transport)
1920 struct rpc_xprt *xprt = &transport->xprt;
1921 struct socket *sock;
1924 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1925 SOCK_STREAM, 0, &sock, 1);
1927 dprintk("RPC: can't create AF_LOCAL "
1928 "transport socket (%d).\n", -status);
1931 xs_reclassify_socket(AF_LOCAL, sock);
1933 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1934 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1936 status = xs_local_finish_connecting(xprt, sock);
1937 trace_rpc_socket_connect(xprt, sock, status);
1940 dprintk("RPC: xprt %p connected to %s\n",
1941 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1942 xprt->stat.connect_count++;
1943 xprt->stat.connect_time += (long)jiffies -
1944 xprt->stat.connect_start;
1945 xprt_set_connected(xprt);
1949 dprintk("RPC: xprt %p: socket %s does not exist\n",
1950 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1953 dprintk("RPC: xprt %p: connection refused for %s\n",
1954 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1957 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1959 xprt->address_strings[RPC_DISPLAY_ADDR]);
1963 xprt_clear_connecting(xprt);
1964 xprt_wake_pending_tasks(xprt, status);
1968 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1970 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1973 if (RPC_IS_ASYNC(task)) {
1975 * We want the AF_LOCAL connect to be resolved in the
1976 * filesystem namespace of the process making the rpc
1977 * call. Thus we connect synchronously.
1979 * If we want to support asynchronous AF_LOCAL calls,
1980 * we'll need to figure out how to pass a namespace to
1983 rpc_exit(task, -ENOTCONN);
1986 ret = xs_local_setup_socket(transport);
1987 if (ret && !RPC_IS_SOFTCONN(task))
1988 msleep_interruptible(15000);
1991 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
1993 * Note that this should be called with XPRT_LOCKED held (or when we otherwise
1994 * know that we have exclusive access to the socket), to guard against
1995 * races with xs_reset_transport.
1997 static void xs_set_memalloc(struct rpc_xprt *xprt)
1999 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
2003 * If there's no sock, then we have nothing to set. The
2004 * reconnecting process will get it for us.
2006 if (!transport->inet)
2008 if (atomic_read(&xprt->swapper))
2009 sk_set_memalloc(transport->inet);
2013 * xs_enable_swap - Tag this transport as being used for swap.
2014 * @xprt: transport to tag
2016 * Take a reference to this transport on behalf of the rpc_clnt, and
2017 * optionally mark it for swapping if it wasn't already.
2020 xs_enable_swap(struct rpc_xprt *xprt)
2022 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2024 if (atomic_inc_return(&xprt->swapper) != 1)
2026 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2027 return -ERESTARTSYS;
2029 sk_set_memalloc(xs->inet);
2030 xprt_release_xprt(xprt, NULL);
2035 * xs_disable_swap - Untag this transport as being used for swap.
2036 * @xprt: transport to tag
2038 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2039 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2042 xs_disable_swap(struct rpc_xprt *xprt)
2044 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2046 if (!atomic_dec_and_test(&xprt->swapper))
2048 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2051 sk_clear_memalloc(xs->inet);
2052 xprt_release_xprt(xprt, NULL);
2055 static void xs_set_memalloc(struct rpc_xprt *xprt)
2060 xs_enable_swap(struct rpc_xprt *xprt)
2066 xs_disable_swap(struct rpc_xprt *xprt)
2071 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2073 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2075 if (!transport->inet) {
2076 struct sock *sk = sock->sk;
2078 write_lock_bh(&sk->sk_callback_lock);
2080 xs_save_old_callbacks(transport, sk);
2082 sk->sk_user_data = xprt;
2083 sk->sk_data_ready = xs_data_ready;
2084 sk->sk_write_space = xs_udp_write_space;
2085 sock_set_flag(sk, SOCK_FASYNC);
2087 xprt_set_connected(xprt);
2089 /* Reset to new socket */
2090 transport->sock = sock;
2091 transport->inet = sk;
2093 xs_set_memalloc(xprt);
2095 write_unlock_bh(&sk->sk_callback_lock);
2097 xs_udp_do_set_buffer_size(xprt);
2099 xprt->stat.connect_start = jiffies;
2102 static void xs_udp_setup_socket(struct work_struct *work)
2104 struct sock_xprt *transport =
2105 container_of(work, struct sock_xprt, connect_worker.work);
2106 struct rpc_xprt *xprt = &transport->xprt;
2107 struct socket *sock;
2110 sock = xs_create_sock(xprt, transport,
2111 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2112 IPPROTO_UDP, false);
2116 dprintk("RPC: worker connecting xprt %p via %s to "
2117 "%s (port %s)\n", xprt,
2118 xprt->address_strings[RPC_DISPLAY_PROTO],
2119 xprt->address_strings[RPC_DISPLAY_ADDR],
2120 xprt->address_strings[RPC_DISPLAY_PORT]);
2122 xs_udp_finish_connecting(xprt, sock);
2123 trace_rpc_socket_connect(xprt, sock, 0);
2126 xprt_clear_connecting(xprt);
2127 xprt_unlock_connect(xprt, transport);
2128 xprt_wake_pending_tasks(xprt, status);
2132 * xs_tcp_shutdown - gracefully shut down a TCP socket
2135 * Initiates a graceful shutdown of the TCP socket by calling the
2136 * equivalent of shutdown(SHUT_RDWR);
2138 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2140 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2141 struct socket *sock = transport->sock;
2142 int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE;
2148 kernel_sock_shutdown(sock, SHUT_RDWR);
2149 trace_rpc_socket_shutdown(xprt, sock);
2153 xs_reset_transport(transport);
2157 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2158 struct socket *sock)
2160 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2161 unsigned int keepidle;
2162 unsigned int keepcnt;
2163 unsigned int opt_on = 1;
2166 spin_lock_bh(&xprt->transport_lock);
2167 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2168 keepcnt = xprt->timeout->to_retries + 1;
2169 timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2170 (xprt->timeout->to_retries + 1);
2171 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2172 spin_unlock_bh(&xprt->transport_lock);
2174 /* TCP Keepalive options */
2175 kernel_setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE,
2176 (char *)&opt_on, sizeof(opt_on));
2177 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPIDLE,
2178 (char *)&keepidle, sizeof(keepidle));
2179 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPINTVL,
2180 (char *)&keepidle, sizeof(keepidle));
2181 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPCNT,
2182 (char *)&keepcnt, sizeof(keepcnt));
2184 /* TCP user timeout (see RFC5482) */
2185 kernel_setsockopt(sock, SOL_TCP, TCP_USER_TIMEOUT,
2186 (char *)&timeo, sizeof(timeo));
2189 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2190 unsigned long connect_timeout,
2191 unsigned long reconnect_timeout)
2193 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2194 struct rpc_timeout to;
2195 unsigned long initval;
2197 spin_lock_bh(&xprt->transport_lock);
2198 if (reconnect_timeout < xprt->max_reconnect_timeout)
2199 xprt->max_reconnect_timeout = reconnect_timeout;
2200 if (connect_timeout < xprt->connect_timeout) {
2201 memcpy(&to, xprt->timeout, sizeof(to));
2202 initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1);
2203 /* Arbitrary lower limit */
2204 if (initval < XS_TCP_INIT_REEST_TO << 1)
2205 initval = XS_TCP_INIT_REEST_TO << 1;
2206 to.to_initval = initval;
2207 to.to_maxval = initval;
2208 memcpy(&transport->tcp_timeout, &to,
2209 sizeof(transport->tcp_timeout));
2210 xprt->timeout = &transport->tcp_timeout;
2211 xprt->connect_timeout = connect_timeout;
2213 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2214 spin_unlock_bh(&xprt->transport_lock);
2217 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2219 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2220 int ret = -ENOTCONN;
2222 if (!transport->inet) {
2223 struct sock *sk = sock->sk;
2224 unsigned int addr_pref = IPV6_PREFER_SRC_PUBLIC;
2226 /* Avoid temporary address, they are bad for long-lived
2227 * connections such as NFS mounts.
2228 * RFC4941, section 3.6 suggests that:
2229 * Individual applications, which have specific
2230 * knowledge about the normal duration of connections,
2231 * MAY override this as appropriate.
2233 kernel_setsockopt(sock, SOL_IPV6, IPV6_ADDR_PREFERENCES,
2234 (char *)&addr_pref, sizeof(addr_pref));
2236 xs_tcp_set_socket_timeouts(xprt, sock);
2238 write_lock_bh(&sk->sk_callback_lock);
2240 xs_save_old_callbacks(transport, sk);
2242 sk->sk_user_data = xprt;
2243 sk->sk_data_ready = xs_data_ready;
2244 sk->sk_state_change = xs_tcp_state_change;
2245 sk->sk_write_space = xs_tcp_write_space;
2246 sock_set_flag(sk, SOCK_FASYNC);
2247 sk->sk_error_report = xs_error_report;
2249 /* socket options */
2250 sock_reset_flag(sk, SOCK_LINGER);
2251 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2253 xprt_clear_connected(xprt);
2255 /* Reset to new socket */
2256 transport->sock = sock;
2257 transport->inet = sk;
2259 write_unlock_bh(&sk->sk_callback_lock);
2262 if (!xprt_bound(xprt))
2265 xs_set_memalloc(xprt);
2267 /* Reset TCP record info */
2268 xs_stream_reset_connect(transport);
2270 /* Tell the socket layer to start connecting... */
2271 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2272 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2275 xs_set_srcport(transport, sock);
2279 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2280 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2282 case -EADDRNOTAVAIL:
2283 /* Source port number is unavailable. Try a new one! */
2284 transport->srcport = 0;
2291 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2292 * @work: queued work item
2294 * Invoked by a work queue tasklet.
2296 static void xs_tcp_setup_socket(struct work_struct *work)
2298 struct sock_xprt *transport =
2299 container_of(work, struct sock_xprt, connect_worker.work);
2300 struct socket *sock = transport->sock;
2301 struct rpc_xprt *xprt = &transport->xprt;
2305 sock = xs_create_sock(xprt, transport,
2306 xs_addr(xprt)->sa_family, SOCK_STREAM,
2309 status = PTR_ERR(sock);
2314 dprintk("RPC: worker connecting xprt %p via %s to "
2315 "%s (port %s)\n", xprt,
2316 xprt->address_strings[RPC_DISPLAY_PROTO],
2317 xprt->address_strings[RPC_DISPLAY_ADDR],
2318 xprt->address_strings[RPC_DISPLAY_PORT]);
2320 status = xs_tcp_finish_connecting(xprt, sock);
2321 trace_rpc_socket_connect(xprt, sock, status);
2322 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2323 xprt, -status, xprt_connected(xprt),
2324 sock->sk->sk_state);
2327 printk("%s: connect returned unhandled error %d\n",
2330 case -EADDRNOTAVAIL:
2331 /* We're probably in TIME_WAIT. Get rid of existing socket,
2334 xs_tcp_force_close(xprt);
2339 xprt_unlock_connect(xprt, transport);
2342 /* Happens, for instance, if the user specified a link
2343 * local IPv6 address without a scope-id.
2353 * xs_tcp_force_close() wakes tasks with -EIO.
2354 * We need to wake them first to ensure the
2355 * correct error code.
2357 xprt_wake_pending_tasks(xprt, status);
2358 xs_tcp_force_close(xprt);
2363 xprt_clear_connecting(xprt);
2364 xprt_unlock_connect(xprt, transport);
2365 xprt_wake_pending_tasks(xprt, status);
2368 static unsigned long xs_reconnect_delay(const struct rpc_xprt *xprt)
2370 unsigned long start, now = jiffies;
2372 start = xprt->stat.connect_start + xprt->reestablish_timeout;
2373 if (time_after(start, now))
2378 static void xs_reconnect_backoff(struct rpc_xprt *xprt)
2380 xprt->reestablish_timeout <<= 1;
2381 if (xprt->reestablish_timeout > xprt->max_reconnect_timeout)
2382 xprt->reestablish_timeout = xprt->max_reconnect_timeout;
2383 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2384 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2388 * xs_connect - connect a socket to a remote endpoint
2389 * @xprt: pointer to transport structure
2390 * @task: address of RPC task that manages state of connect request
2392 * TCP: If the remote end dropped the connection, delay reconnecting.
2394 * UDP socket connects are synchronous, but we use a work queue anyway
2395 * to guarantee that even unprivileged user processes can set up a
2396 * socket on a privileged port.
2398 * If a UDP socket connect fails, the delay behavior here prevents
2399 * retry floods (hard mounts).
2401 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2403 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2404 unsigned long delay = 0;
2406 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2408 if (transport->sock != NULL) {
2409 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2411 xprt, xprt->reestablish_timeout / HZ);
2413 /* Start by resetting any existing state */
2414 xs_reset_transport(transport);
2416 delay = xs_reconnect_delay(xprt);
2417 xs_reconnect_backoff(xprt);
2420 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2422 queue_delayed_work(xprtiod_workqueue,
2423 &transport->connect_worker,
2428 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2429 * @xprt: rpc_xprt struct containing statistics
2433 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2437 if (xprt_connected(xprt))
2438 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2440 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2441 "%llu %llu %lu %llu %llu\n",
2442 xprt->stat.bind_count,
2443 xprt->stat.connect_count,
2444 xprt->stat.connect_time / HZ,
2448 xprt->stat.bad_xids,
2451 xprt->stat.max_slots,
2452 xprt->stat.sending_u,
2453 xprt->stat.pending_u);
2457 * xs_udp_print_stats - display UDP socket-specifc stats
2458 * @xprt: rpc_xprt struct containing statistics
2462 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2464 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2466 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2469 xprt->stat.bind_count,
2472 xprt->stat.bad_xids,
2475 xprt->stat.max_slots,
2476 xprt->stat.sending_u,
2477 xprt->stat.pending_u);
2481 * xs_tcp_print_stats - display TCP socket-specifc stats
2482 * @xprt: rpc_xprt struct containing statistics
2486 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2488 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2491 if (xprt_connected(xprt))
2492 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2494 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2495 "%llu %llu %lu %llu %llu\n",
2497 xprt->stat.bind_count,
2498 xprt->stat.connect_count,
2499 xprt->stat.connect_time / HZ,
2503 xprt->stat.bad_xids,
2506 xprt->stat.max_slots,
2507 xprt->stat.sending_u,
2508 xprt->stat.pending_u);
2512 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2513 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2514 * to use the server side send routines.
2516 static int bc_malloc(struct rpc_task *task)
2518 struct rpc_rqst *rqst = task->tk_rqstp;
2519 size_t size = rqst->rq_callsize;
2521 struct rpc_buffer *buf;
2523 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2524 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2529 page = alloc_page(GFP_KERNEL);
2533 buf = page_address(page);
2534 buf->len = PAGE_SIZE;
2536 rqst->rq_buffer = buf->data;
2537 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2542 * Free the space allocated in the bc_alloc routine
2544 static void bc_free(struct rpc_task *task)
2546 void *buffer = task->tk_rqstp->rq_buffer;
2547 struct rpc_buffer *buf;
2549 buf = container_of(buffer, struct rpc_buffer, data);
2550 free_page((unsigned long)buf);
2554 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2555 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2557 static int bc_sendto(struct rpc_rqst *req)
2560 struct xdr_buf *xbufp = &req->rq_snd_buf;
2561 struct rpc_xprt *xprt = req->rq_xprt;
2562 struct sock_xprt *transport =
2563 container_of(xprt, struct sock_xprt, xprt);
2564 struct socket *sock = transport->sock;
2565 unsigned long headoff;
2566 unsigned long tailoff;
2568 xs_encode_stream_record_marker(xbufp);
2570 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2571 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2572 len = svc_send_common(sock, xbufp,
2573 virt_to_page(xbufp->head[0].iov_base), headoff,
2574 xbufp->tail[0].iov_base, tailoff);
2576 if (len != xbufp->len) {
2577 printk(KERN_NOTICE "Error sending entire callback!\n");
2585 * The send routine. Borrows from svc_send
2587 static int bc_send_request(struct rpc_rqst *req)
2589 struct svc_xprt *xprt;
2592 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2594 * Get the server socket associated with this callback xprt
2596 xprt = req->rq_xprt->bc_xprt;
2599 * Grab the mutex to serialize data as the connection is shared
2600 * with the fore channel
2602 mutex_lock(&xprt->xpt_mutex);
2603 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2606 len = bc_sendto(req);
2607 mutex_unlock(&xprt->xpt_mutex);
2616 * The close routine. Since this is client initiated, we do nothing
2619 static void bc_close(struct rpc_xprt *xprt)
2624 * The xprt destroy routine. Again, because this connection is client
2625 * initiated, we do nothing
2628 static void bc_destroy(struct rpc_xprt *xprt)
2630 dprintk("RPC: bc_destroy xprt %p\n", xprt);
2633 module_put(THIS_MODULE);
2636 static const struct rpc_xprt_ops xs_local_ops = {
2637 .reserve_xprt = xprt_reserve_xprt,
2638 .release_xprt = xprt_release_xprt,
2639 .alloc_slot = xprt_alloc_slot,
2640 .free_slot = xprt_free_slot,
2641 .rpcbind = xs_local_rpcbind,
2642 .set_port = xs_local_set_port,
2643 .connect = xs_local_connect,
2644 .buf_alloc = rpc_malloc,
2645 .buf_free = rpc_free,
2646 .prepare_request = xs_stream_prepare_request,
2647 .send_request = xs_local_send_request,
2648 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2650 .destroy = xs_destroy,
2651 .print_stats = xs_local_print_stats,
2652 .enable_swap = xs_enable_swap,
2653 .disable_swap = xs_disable_swap,
2656 static const struct rpc_xprt_ops xs_udp_ops = {
2657 .set_buffer_size = xs_udp_set_buffer_size,
2658 .reserve_xprt = xprt_reserve_xprt_cong,
2659 .release_xprt = xprt_release_xprt_cong,
2660 .alloc_slot = xprt_alloc_slot,
2661 .free_slot = xprt_free_slot,
2662 .rpcbind = rpcb_getport_async,
2663 .set_port = xs_set_port,
2664 .connect = xs_connect,
2665 .buf_alloc = rpc_malloc,
2666 .buf_free = rpc_free,
2667 .send_request = xs_udp_send_request,
2668 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2669 .timer = xs_udp_timer,
2670 .release_request = xprt_release_rqst_cong,
2672 .destroy = xs_destroy,
2673 .print_stats = xs_udp_print_stats,
2674 .enable_swap = xs_enable_swap,
2675 .disable_swap = xs_disable_swap,
2676 .inject_disconnect = xs_inject_disconnect,
2679 static const struct rpc_xprt_ops xs_tcp_ops = {
2680 .reserve_xprt = xprt_reserve_xprt,
2681 .release_xprt = xprt_release_xprt,
2682 .alloc_slot = xprt_alloc_slot,
2683 .free_slot = xprt_free_slot,
2684 .rpcbind = rpcb_getport_async,
2685 .set_port = xs_set_port,
2686 .connect = xs_connect,
2687 .buf_alloc = rpc_malloc,
2688 .buf_free = rpc_free,
2689 .prepare_request = xs_stream_prepare_request,
2690 .send_request = xs_tcp_send_request,
2691 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2692 .close = xs_tcp_shutdown,
2693 .destroy = xs_destroy,
2694 .set_connect_timeout = xs_tcp_set_connect_timeout,
2695 .print_stats = xs_tcp_print_stats,
2696 .enable_swap = xs_enable_swap,
2697 .disable_swap = xs_disable_swap,
2698 .inject_disconnect = xs_inject_disconnect,
2699 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2700 .bc_setup = xprt_setup_bc,
2701 .bc_maxpayload = xs_tcp_bc_maxpayload,
2702 .bc_free_rqst = xprt_free_bc_rqst,
2703 .bc_destroy = xprt_destroy_bc,
2708 * The rpc_xprt_ops for the server backchannel
2711 static const struct rpc_xprt_ops bc_tcp_ops = {
2712 .reserve_xprt = xprt_reserve_xprt,
2713 .release_xprt = xprt_release_xprt,
2714 .alloc_slot = xprt_alloc_slot,
2715 .free_slot = xprt_free_slot,
2716 .buf_alloc = bc_malloc,
2717 .buf_free = bc_free,
2718 .send_request = bc_send_request,
2719 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2721 .destroy = bc_destroy,
2722 .print_stats = xs_tcp_print_stats,
2723 .enable_swap = xs_enable_swap,
2724 .disable_swap = xs_disable_swap,
2725 .inject_disconnect = xs_inject_disconnect,
2728 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2730 static const struct sockaddr_in sin = {
2731 .sin_family = AF_INET,
2732 .sin_addr.s_addr = htonl(INADDR_ANY),
2734 static const struct sockaddr_in6 sin6 = {
2735 .sin6_family = AF_INET6,
2736 .sin6_addr = IN6ADDR_ANY_INIT,
2743 memcpy(sap, &sin, sizeof(sin));
2746 memcpy(sap, &sin6, sizeof(sin6));
2749 dprintk("RPC: %s: Bad address family\n", __func__);
2750 return -EAFNOSUPPORT;
2755 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2756 unsigned int slot_table_size,
2757 unsigned int max_slot_table_size)
2759 struct rpc_xprt *xprt;
2760 struct sock_xprt *new;
2762 if (args->addrlen > sizeof(xprt->addr)) {
2763 dprintk("RPC: xs_setup_xprt: address too large\n");
2764 return ERR_PTR(-EBADF);
2767 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2768 max_slot_table_size);
2770 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2772 return ERR_PTR(-ENOMEM);
2775 new = container_of(xprt, struct sock_xprt, xprt);
2776 mutex_init(&new->recv_mutex);
2777 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2778 xprt->addrlen = args->addrlen;
2780 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2783 err = xs_init_anyaddr(args->dstaddr->sa_family,
2784 (struct sockaddr *)&new->srcaddr);
2787 return ERR_PTR(err);
2794 static const struct rpc_timeout xs_local_default_timeout = {
2795 .to_initval = 10 * HZ,
2796 .to_maxval = 10 * HZ,
2801 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2802 * @args: rpc transport creation arguments
2804 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2806 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2808 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2809 struct sock_xprt *transport;
2810 struct rpc_xprt *xprt;
2811 struct rpc_xprt *ret;
2813 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2814 xprt_max_tcp_slot_table_entries);
2817 transport = container_of(xprt, struct sock_xprt, xprt);
2820 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2821 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2823 xprt->bind_timeout = XS_BIND_TO;
2824 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2825 xprt->idle_timeout = XS_IDLE_DISC_TO;
2827 xprt->ops = &xs_local_ops;
2828 xprt->timeout = &xs_local_default_timeout;
2830 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2831 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
2833 switch (sun->sun_family) {
2835 if (sun->sun_path[0] != '/') {
2836 dprintk("RPC: bad AF_LOCAL address: %s\n",
2838 ret = ERR_PTR(-EINVAL);
2841 xprt_set_bound(xprt);
2842 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2843 ret = ERR_PTR(xs_local_setup_socket(transport));
2848 ret = ERR_PTR(-EAFNOSUPPORT);
2852 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2853 xprt->address_strings[RPC_DISPLAY_ADDR]);
2855 if (try_module_get(THIS_MODULE))
2857 ret = ERR_PTR(-EINVAL);
2863 static const struct rpc_timeout xs_udp_default_timeout = {
2864 .to_initval = 5 * HZ,
2865 .to_maxval = 30 * HZ,
2866 .to_increment = 5 * HZ,
2871 * xs_setup_udp - Set up transport to use a UDP socket
2872 * @args: rpc transport creation arguments
2875 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2877 struct sockaddr *addr = args->dstaddr;
2878 struct rpc_xprt *xprt;
2879 struct sock_xprt *transport;
2880 struct rpc_xprt *ret;
2882 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2883 xprt_udp_slot_table_entries);
2886 transport = container_of(xprt, struct sock_xprt, xprt);
2888 xprt->prot = IPPROTO_UDP;
2890 /* XXX: header size can vary due to auth type, IPv6, etc. */
2891 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2893 xprt->bind_timeout = XS_BIND_TO;
2894 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2895 xprt->idle_timeout = XS_IDLE_DISC_TO;
2897 xprt->ops = &xs_udp_ops;
2899 xprt->timeout = &xs_udp_default_timeout;
2901 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
2902 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
2904 switch (addr->sa_family) {
2906 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2907 xprt_set_bound(xprt);
2909 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2912 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2913 xprt_set_bound(xprt);
2915 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2918 ret = ERR_PTR(-EAFNOSUPPORT);
2922 if (xprt_bound(xprt))
2923 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2924 xprt->address_strings[RPC_DISPLAY_ADDR],
2925 xprt->address_strings[RPC_DISPLAY_PORT],
2926 xprt->address_strings[RPC_DISPLAY_PROTO]);
2928 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2929 xprt->address_strings[RPC_DISPLAY_ADDR],
2930 xprt->address_strings[RPC_DISPLAY_PROTO]);
2932 if (try_module_get(THIS_MODULE))
2934 ret = ERR_PTR(-EINVAL);
2940 static const struct rpc_timeout xs_tcp_default_timeout = {
2941 .to_initval = 60 * HZ,
2942 .to_maxval = 60 * HZ,
2947 * xs_setup_tcp - Set up transport to use a TCP socket
2948 * @args: rpc transport creation arguments
2951 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2953 struct sockaddr *addr = args->dstaddr;
2954 struct rpc_xprt *xprt;
2955 struct sock_xprt *transport;
2956 struct rpc_xprt *ret;
2957 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
2959 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
2960 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
2962 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2963 max_slot_table_size);
2966 transport = container_of(xprt, struct sock_xprt, xprt);
2968 xprt->prot = IPPROTO_TCP;
2969 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2970 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2972 xprt->bind_timeout = XS_BIND_TO;
2973 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2974 xprt->idle_timeout = XS_IDLE_DISC_TO;
2976 xprt->ops = &xs_tcp_ops;
2977 xprt->timeout = &xs_tcp_default_timeout;
2979 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
2980 xprt->connect_timeout = xprt->timeout->to_initval *
2981 (xprt->timeout->to_retries + 1);
2983 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2984 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
2986 switch (addr->sa_family) {
2988 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2989 xprt_set_bound(xprt);
2991 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2994 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2995 xprt_set_bound(xprt);
2997 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3000 ret = ERR_PTR(-EAFNOSUPPORT);
3004 if (xprt_bound(xprt))
3005 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3006 xprt->address_strings[RPC_DISPLAY_ADDR],
3007 xprt->address_strings[RPC_DISPLAY_PORT],
3008 xprt->address_strings[RPC_DISPLAY_PROTO]);
3010 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3011 xprt->address_strings[RPC_DISPLAY_ADDR],
3012 xprt->address_strings[RPC_DISPLAY_PROTO]);
3014 if (try_module_get(THIS_MODULE))
3016 ret = ERR_PTR(-EINVAL);
3023 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3024 * @args: rpc transport creation arguments
3027 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
3029 struct sockaddr *addr = args->dstaddr;
3030 struct rpc_xprt *xprt;
3031 struct sock_xprt *transport;
3032 struct svc_sock *bc_sock;
3033 struct rpc_xprt *ret;
3035 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3036 xprt_tcp_slot_table_entries);
3039 transport = container_of(xprt, struct sock_xprt, xprt);
3041 xprt->prot = IPPROTO_TCP;
3042 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
3043 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3044 xprt->timeout = &xs_tcp_default_timeout;
3047 xprt_set_bound(xprt);
3048 xprt->bind_timeout = 0;
3049 xprt->reestablish_timeout = 0;
3050 xprt->idle_timeout = 0;
3052 xprt->ops = &bc_tcp_ops;
3054 switch (addr->sa_family) {
3056 xs_format_peer_addresses(xprt, "tcp",
3060 xs_format_peer_addresses(xprt, "tcp",
3061 RPCBIND_NETID_TCP6);
3064 ret = ERR_PTR(-EAFNOSUPPORT);
3068 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3069 xprt->address_strings[RPC_DISPLAY_ADDR],
3070 xprt->address_strings[RPC_DISPLAY_PORT],
3071 xprt->address_strings[RPC_DISPLAY_PROTO]);
3074 * Once we've associated a backchannel xprt with a connection,
3075 * we want to keep it around as long as the connection lasts,
3076 * in case we need to start using it for a backchannel again;
3077 * this reference won't be dropped until bc_xprt is destroyed.
3080 args->bc_xprt->xpt_bc_xprt = xprt;
3081 xprt->bc_xprt = args->bc_xprt;
3082 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3083 transport->sock = bc_sock->sk_sock;
3084 transport->inet = bc_sock->sk_sk;
3087 * Since we don't want connections for the backchannel, we set
3088 * the xprt status to connected
3090 xprt_set_connected(xprt);
3092 if (try_module_get(THIS_MODULE))
3095 args->bc_xprt->xpt_bc_xprt = NULL;
3096 args->bc_xprt->xpt_bc_xps = NULL;
3098 ret = ERR_PTR(-EINVAL);
3104 static struct xprt_class xs_local_transport = {
3105 .list = LIST_HEAD_INIT(xs_local_transport.list),
3106 .name = "named UNIX socket",
3107 .owner = THIS_MODULE,
3108 .ident = XPRT_TRANSPORT_LOCAL,
3109 .setup = xs_setup_local,
3112 static struct xprt_class xs_udp_transport = {
3113 .list = LIST_HEAD_INIT(xs_udp_transport.list),
3115 .owner = THIS_MODULE,
3116 .ident = XPRT_TRANSPORT_UDP,
3117 .setup = xs_setup_udp,
3120 static struct xprt_class xs_tcp_transport = {
3121 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
3123 .owner = THIS_MODULE,
3124 .ident = XPRT_TRANSPORT_TCP,
3125 .setup = xs_setup_tcp,
3128 static struct xprt_class xs_bc_tcp_transport = {
3129 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3130 .name = "tcp NFSv4.1 backchannel",
3131 .owner = THIS_MODULE,
3132 .ident = XPRT_TRANSPORT_BC_TCP,
3133 .setup = xs_setup_bc_tcp,
3137 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3140 int init_socket_xprt(void)
3142 if (!sunrpc_table_header)
3143 sunrpc_table_header = register_sysctl_table(sunrpc_table);
3145 xprt_register_transport(&xs_local_transport);
3146 xprt_register_transport(&xs_udp_transport);
3147 xprt_register_transport(&xs_tcp_transport);
3148 xprt_register_transport(&xs_bc_tcp_transport);
3154 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3157 void cleanup_socket_xprt(void)
3159 if (sunrpc_table_header) {
3160 unregister_sysctl_table(sunrpc_table_header);
3161 sunrpc_table_header = NULL;
3164 xprt_unregister_transport(&xs_local_transport);
3165 xprt_unregister_transport(&xs_udp_transport);
3166 xprt_unregister_transport(&xs_tcp_transport);
3167 xprt_unregister_transport(&xs_bc_tcp_transport);
3170 static int param_set_uint_minmax(const char *val,
3171 const struct kernel_param *kp,
3172 unsigned int min, unsigned int max)
3179 ret = kstrtouint(val, 0, &num);
3182 if (num < min || num > max)
3184 *((unsigned int *)kp->arg) = num;
3188 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3190 return param_set_uint_minmax(val, kp,
3195 static const struct kernel_param_ops param_ops_portnr = {
3196 .set = param_set_portnr,
3197 .get = param_get_uint,
3200 #define param_check_portnr(name, p) \
3201 __param_check(name, p, unsigned int);
3203 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3204 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3206 static int param_set_slot_table_size(const char *val,
3207 const struct kernel_param *kp)
3209 return param_set_uint_minmax(val, kp,
3211 RPC_MAX_SLOT_TABLE);
3214 static const struct kernel_param_ops param_ops_slot_table_size = {
3215 .set = param_set_slot_table_size,
3216 .get = param_get_uint,
3219 #define param_check_slot_table_size(name, p) \
3220 __param_check(name, p, unsigned int);
3222 static int param_set_max_slot_table_size(const char *val,
3223 const struct kernel_param *kp)
3225 return param_set_uint_minmax(val, kp,
3227 RPC_MAX_SLOT_TABLE_LIMIT);
3230 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3231 .set = param_set_max_slot_table_size,
3232 .get = param_get_uint,
3235 #define param_check_max_slot_table_size(name, p) \
3236 __param_check(name, p, unsigned int);
3238 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3239 slot_table_size, 0644);
3240 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3241 max_slot_table_size, 0644);
3242 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3243 slot_table_size, 0644);