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/uio.h>
53 #include <trace/events/sunrpc.h>
57 static void xs_close(struct rpc_xprt *xprt);
58 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
64 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
65 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
66 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
68 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
69 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
71 #define XS_TCP_LINGER_TO (15U * HZ)
72 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
75 * We can register our own files under /proc/sys/sunrpc by
76 * calling register_sysctl_table() again. The files in that
77 * directory become the union of all files registered there.
79 * We simply need to make sure that we don't collide with
80 * someone else's file names!
83 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
84 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
85 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
86 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
87 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
89 static struct ctl_table_header *sunrpc_table_header;
92 * FIXME: changing the UDP slot table size should also resize the UDP
93 * socket buffers for existing UDP transports
95 static struct ctl_table xs_tunables_table[] = {
97 .procname = "udp_slot_table_entries",
98 .data = &xprt_udp_slot_table_entries,
99 .maxlen = sizeof(unsigned int),
101 .proc_handler = proc_dointvec_minmax,
102 .extra1 = &min_slot_table_size,
103 .extra2 = &max_slot_table_size
106 .procname = "tcp_slot_table_entries",
107 .data = &xprt_tcp_slot_table_entries,
108 .maxlen = sizeof(unsigned int),
110 .proc_handler = proc_dointvec_minmax,
111 .extra1 = &min_slot_table_size,
112 .extra2 = &max_slot_table_size
115 .procname = "tcp_max_slot_table_entries",
116 .data = &xprt_max_tcp_slot_table_entries,
117 .maxlen = sizeof(unsigned int),
119 .proc_handler = proc_dointvec_minmax,
120 .extra1 = &min_slot_table_size,
121 .extra2 = &max_tcp_slot_table_limit
124 .procname = "min_resvport",
125 .data = &xprt_min_resvport,
126 .maxlen = sizeof(unsigned int),
128 .proc_handler = proc_dointvec_minmax,
129 .extra1 = &xprt_min_resvport_limit,
130 .extra2 = &xprt_max_resvport_limit
133 .procname = "max_resvport",
134 .data = &xprt_max_resvport,
135 .maxlen = sizeof(unsigned int),
137 .proc_handler = proc_dointvec_minmax,
138 .extra1 = &xprt_min_resvport_limit,
139 .extra2 = &xprt_max_resvport_limit
142 .procname = "tcp_fin_timeout",
143 .data = &xs_tcp_fin_timeout,
144 .maxlen = sizeof(xs_tcp_fin_timeout),
146 .proc_handler = proc_dointvec_jiffies,
151 static struct ctl_table sunrpc_table[] = {
153 .procname = "sunrpc",
155 .child = xs_tunables_table
161 * Wait duration for a reply from the RPC portmapper.
163 #define XS_BIND_TO (60U * HZ)
166 * Delay if a UDP socket connect error occurs. This is most likely some
167 * kind of resource problem on the local host.
169 #define XS_UDP_REEST_TO (2U * HZ)
172 * The reestablish timeout allows clients to delay for a bit before attempting
173 * to reconnect to a server that just dropped our connection.
175 * We implement an exponential backoff when trying to reestablish a TCP
176 * transport connection with the server. Some servers like to drop a TCP
177 * connection when they are overworked, so we start with a short timeout and
178 * increase over time if the server is down or not responding.
180 #define XS_TCP_INIT_REEST_TO (3U * HZ)
183 * TCP idle timeout; client drops the transport socket if it is idle
184 * for this long. Note that we also timeout UDP sockets to prevent
185 * holding port numbers when there is no RPC traffic.
187 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
189 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
190 # undef RPC_DEBUG_DATA
191 # define RPCDBG_FACILITY RPCDBG_TRANS
194 #ifdef RPC_DEBUG_DATA
195 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
197 u8 *buf = (u8 *) packet;
200 dprintk("RPC: %s\n", msg);
201 for (j = 0; j < count && j < 128; j += 4) {
205 dprintk("0x%04x ", j);
207 dprintk("%02x%02x%02x%02x ",
208 buf[j], buf[j+1], buf[j+2], buf[j+3]);
213 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
219 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
221 return (struct rpc_xprt *) sk->sk_user_data;
224 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
226 return (struct sockaddr *) &xprt->addr;
229 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
231 return (struct sockaddr_un *) &xprt->addr;
234 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
236 return (struct sockaddr_in *) &xprt->addr;
239 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
241 return (struct sockaddr_in6 *) &xprt->addr;
244 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
246 struct sockaddr *sap = xs_addr(xprt);
247 struct sockaddr_in6 *sin6;
248 struct sockaddr_in *sin;
249 struct sockaddr_un *sun;
252 switch (sap->sa_family) {
254 sun = xs_addr_un(xprt);
255 strlcpy(buf, sun->sun_path, sizeof(buf));
256 xprt->address_strings[RPC_DISPLAY_ADDR] =
257 kstrdup(buf, GFP_KERNEL);
260 (void)rpc_ntop(sap, buf, sizeof(buf));
261 xprt->address_strings[RPC_DISPLAY_ADDR] =
262 kstrdup(buf, GFP_KERNEL);
263 sin = xs_addr_in(xprt);
264 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
267 (void)rpc_ntop(sap, buf, sizeof(buf));
268 xprt->address_strings[RPC_DISPLAY_ADDR] =
269 kstrdup(buf, GFP_KERNEL);
270 sin6 = xs_addr_in6(xprt);
271 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
277 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
280 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
282 struct sockaddr *sap = xs_addr(xprt);
285 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
286 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
288 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
289 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
292 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
293 const char *protocol,
296 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
297 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
298 xs_format_common_peer_addresses(xprt);
299 xs_format_common_peer_ports(xprt);
302 static void xs_update_peer_port(struct rpc_xprt *xprt)
304 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
305 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
307 xs_format_common_peer_ports(xprt);
310 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
314 for (i = 0; i < RPC_DISPLAY_MAX; i++)
316 case RPC_DISPLAY_PROTO:
317 case RPC_DISPLAY_NETID:
320 kfree(xprt->address_strings[i]);
325 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp)
329 if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES))
331 n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT;
332 for (i = 0; i < n; i++) {
335 buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp);
336 if (!buf->pages[i]) {
338 return i > buf->page_base ? i - buf->page_base : 0;
345 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek)
349 iov_iter_advance(&msg->msg_iter, seek);
350 ret = sock_recvmsg(sock, msg, flags);
351 return ret > 0 ? ret + seek : ret;
355 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags,
356 struct kvec *kvec, size_t count, size_t seek)
358 iov_iter_kvec(&msg->msg_iter, READ, kvec, 1, count);
359 return xs_sock_recvmsg(sock, msg, flags, seek);
363 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags,
364 struct bio_vec *bvec, unsigned long nr, size_t count,
367 iov_iter_bvec(&msg->msg_iter, READ, bvec, nr, count);
368 return xs_sock_recvmsg(sock, msg, flags, seek);
372 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags,
375 iov_iter_discard(&msg->msg_iter, READ, count);
376 return sock_recvmsg(sock, msg, flags);
380 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags,
381 struct xdr_buf *buf, size_t count, size_t seek, size_t *read)
383 size_t want, seek_init = seek, offset = 0;
386 if (seek < buf->head[0].iov_len) {
387 want = min_t(size_t, count, buf->head[0].iov_len);
388 ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek);
392 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
398 seek -= buf->head[0].iov_len;
399 offset += buf->head[0].iov_len;
402 want = xs_alloc_sparse_pages(buf,
403 min_t(size_t, count - offset, buf->page_len),
406 ret = xs_read_bvec(sock, msg, flags, buf->bvec,
407 xdr_buf_pagecount(buf),
408 want + buf->page_base,
409 seek + buf->page_base);
412 offset += ret - buf->page_base;
413 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
423 if (seek < buf->tail[0].iov_len) {
424 want = min_t(size_t, count - offset, buf->tail[0].iov_len);
425 ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek);
429 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC))
434 offset += buf->tail[0].iov_len;
437 *read = offset - seek_init;
445 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf)
447 if (!transport->recv.copied) {
448 if (buf->head[0].iov_len >= transport->recv.offset)
449 memcpy(buf->head[0].iov_base,
450 &transport->recv.xid,
451 transport->recv.offset);
452 transport->recv.copied = transport->recv.offset;
457 xs_read_stream_request_done(struct sock_xprt *transport)
459 return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT);
463 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg,
464 int flags, struct rpc_rqst *req)
466 struct xdr_buf *buf = &req->rq_private_buf;
470 xs_read_header(transport, buf);
472 want = transport->recv.len - transport->recv.offset;
473 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf,
474 transport->recv.copied + want, transport->recv.copied,
476 transport->recv.offset += read;
477 transport->recv.copied += read;
478 if (transport->recv.offset == transport->recv.len) {
479 if (xs_read_stream_request_done(transport))
480 msg->msg_flags |= MSG_EOR;
489 msg->msg_flags |= MSG_TRUNC;
494 return ret < 0 ? ret : read;
498 xs_read_stream_headersize(bool isfrag)
501 return sizeof(__be32);
502 return 3 * sizeof(__be32);
506 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg,
507 int flags, size_t want, size_t seek)
510 .iov_base = &transport->recv.fraghdr,
513 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek);
516 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
518 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
520 struct rpc_xprt *xprt = &transport->xprt;
521 struct rpc_rqst *req;
524 /* Look up and lock the request corresponding to the given XID */
525 req = xprt_lookup_bc_request(xprt, transport->recv.xid);
527 printk(KERN_WARNING "Callback slot table overflowed\n");
531 ret = xs_read_stream_request(transport, msg, flags, req);
532 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
533 xprt_complete_bc_request(req, transport->recv.copied);
537 #else /* CONFIG_SUNRPC_BACKCHANNEL */
539 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags)
543 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
546 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags)
548 struct rpc_xprt *xprt = &transport->xprt;
549 struct rpc_rqst *req;
552 /* Look up and lock the request corresponding to the given XID */
553 spin_lock(&xprt->queue_lock);
554 req = xprt_lookup_rqst(xprt, transport->recv.xid);
556 msg->msg_flags |= MSG_TRUNC;
560 spin_unlock(&xprt->queue_lock);
562 ret = xs_read_stream_request(transport, msg, flags, req);
564 spin_lock(&xprt->queue_lock);
565 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC))
566 xprt_complete_rqst(req->rq_task, transport->recv.copied);
567 xprt_unpin_rqst(req);
569 spin_unlock(&xprt->queue_lock);
574 xs_read_stream(struct sock_xprt *transport, int flags)
576 struct msghdr msg = { 0 };
577 size_t want, read = 0;
580 if (transport->recv.len == 0) {
581 want = xs_read_stream_headersize(transport->recv.copied != 0);
582 ret = xs_read_stream_header(transport, &msg, flags, want,
583 transport->recv.offset);
586 transport->recv.offset = ret;
587 if (transport->recv.offset != want)
588 return transport->recv.offset;
589 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) &
590 RPC_FRAGMENT_SIZE_MASK;
591 transport->recv.offset -= sizeof(transport->recv.fraghdr);
595 switch (be32_to_cpu(transport->recv.calldir)) {
597 msg.msg_flags |= MSG_TRUNC;
600 ret = xs_read_stream_call(transport, &msg, flags);
603 ret = xs_read_stream_reply(transport, &msg, flags);
605 if (msg.msg_flags & MSG_TRUNC) {
606 transport->recv.calldir = cpu_to_be32(-1);
607 transport->recv.copied = -1;
612 if (transport->recv.offset < transport->recv.len) {
613 if (!(msg.msg_flags & MSG_TRUNC))
616 ret = xs_read_discard(transport->sock, &msg, flags,
617 transport->recv.len - transport->recv.offset);
620 transport->recv.offset += ret;
622 if (transport->recv.offset != transport->recv.len)
625 if (xs_read_stream_request_done(transport)) {
626 trace_xs_stream_read_request(transport);
627 transport->recv.copied = 0;
629 transport->recv.offset = 0;
630 transport->recv.len = 0;
633 return ret != 0 ? ret : -ESHUTDOWN;
636 static void xs_stream_data_receive(struct sock_xprt *transport)
641 mutex_lock(&transport->recv_mutex);
642 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
643 if (transport->sock == NULL)
646 ret = xs_read_stream(transport, MSG_DONTWAIT);
653 mutex_unlock(&transport->recv_mutex);
654 trace_xs_stream_read_data(&transport->xprt, ret, read);
657 static void xs_stream_data_receive_workfn(struct work_struct *work)
659 struct sock_xprt *transport =
660 container_of(work, struct sock_xprt, recv_worker);
661 xs_stream_data_receive(transport);
665 xs_stream_reset_connect(struct sock_xprt *transport)
667 transport->recv.offset = 0;
668 transport->recv.len = 0;
669 transport->recv.copied = 0;
670 transport->xmit.offset = 0;
671 transport->xprt.stat.connect_count++;
672 transport->xprt.stat.connect_start = jiffies;
675 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
677 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
679 struct msghdr msg = {
681 .msg_namelen = addrlen,
682 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
685 .iov_base = vec->iov_base + base,
686 .iov_len = vec->iov_len - base,
689 if (iov.iov_len != 0)
690 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
691 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
694 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more, bool zerocopy, int *sent_p)
696 ssize_t (*do_sendpage)(struct socket *sock, struct page *page,
697 int offset, size_t size, int flags);
699 unsigned int remainder;
702 remainder = xdr->page_len - base;
703 base += xdr->page_base;
704 ppage = xdr->pages + (base >> PAGE_SHIFT);
706 do_sendpage = sock->ops->sendpage;
708 do_sendpage = sock_no_sendpage;
710 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
711 int flags = XS_SENDMSG_FLAGS;
717 flags |= MSG_SENDPAGE_NOTLAST | MSG_MORE;
718 err = do_sendpage(sock, *ppage, base, len, flags);
719 if (remainder == 0 || err != len)
733 * xs_sendpages - write pages directly to a socket
734 * @sock: socket to send on
735 * @addr: UDP only -- address of destination
736 * @addrlen: UDP only -- length of destination address
737 * @xdr: buffer containing this request
738 * @base: starting position in the buffer
739 * @zerocopy: true if it is safe to use sendpage()
740 * @sent_p: return the total number of bytes successfully queued for sending
743 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base, bool zerocopy, int *sent_p)
745 unsigned int remainder = xdr->len - base;
757 if (base < xdr->head[0].iov_len || addr != NULL) {
758 unsigned int len = xdr->head[0].iov_len - base;
760 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
761 if (remainder == 0 || err != len)
766 base -= xdr->head[0].iov_len;
768 if (base < xdr->page_len) {
769 unsigned int len = xdr->page_len - base;
771 err = xs_send_pagedata(sock, xdr, base, remainder != 0, zerocopy, &sent);
773 if (remainder == 0 || sent != len)
777 base -= xdr->page_len;
779 if (base >= xdr->tail[0].iov_len)
781 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
791 * xs_nospace - handle transmit was incomplete
792 * @req: pointer to RPC request
795 static int xs_nospace(struct rpc_rqst *req)
797 struct rpc_xprt *xprt = req->rq_xprt;
798 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
799 struct sock *sk = transport->inet;
802 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
803 req->rq_task->tk_pid,
804 req->rq_slen - transport->xmit.offset,
807 /* Protect against races with write_space */
808 spin_lock_bh(&xprt->transport_lock);
810 /* Don't race with disconnect */
811 if (xprt_connected(xprt)) {
812 /* wait for more buffer space */
813 sk->sk_write_pending++;
814 xprt_wait_for_buffer_space(xprt);
818 spin_unlock_bh(&xprt->transport_lock);
820 /* Race breaker in case memory is freed before above code is called */
821 if (ret == -EAGAIN) {
822 struct socket_wq *wq;
825 wq = rcu_dereference(sk->sk_wq);
826 set_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags);
829 sk->sk_write_space(sk);
835 xs_stream_prepare_request(struct rpc_rqst *req)
837 req->rq_task->tk_status = xdr_alloc_bvec(&req->rq_rcv_buf, GFP_NOIO);
841 * Determine if the previous message in the stream was aborted before it
842 * could complete transmission.
845 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req)
847 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0;
851 * Construct a stream transport record marker in @buf.
853 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf)
855 u32 reclen = buf->len - sizeof(rpc_fraghdr);
856 rpc_fraghdr *base = buf->head[0].iov_base;
857 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen);
861 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
862 * @req: pointer to RPC request
865 * 0: The request has been sent
866 * EAGAIN: The socket was blocked, please call again later to
867 * complete the request
868 * ENOTCONN: Caller needs to invoke connect logic then call again
869 * other: Some other error occured, the request was not sent
871 static int xs_local_send_request(struct rpc_rqst *req)
873 struct rpc_xprt *xprt = req->rq_xprt;
874 struct sock_xprt *transport =
875 container_of(xprt, struct sock_xprt, xprt);
876 struct xdr_buf *xdr = &req->rq_snd_buf;
880 /* Close the stream if the previous transmission was incomplete */
881 if (xs_send_request_was_aborted(transport, req)) {
886 xs_encode_stream_record_marker(&req->rq_snd_buf);
888 xs_pktdump("packet data:",
889 req->rq_svec->iov_base, req->rq_svec->iov_len);
891 req->rq_xtime = ktime_get();
892 status = xs_sendpages(transport->sock, NULL, 0, xdr,
893 transport->xmit.offset,
895 dprintk("RPC: %s(%u) = %d\n",
896 __func__, xdr->len - transport->xmit.offset, status);
898 if (status == -EAGAIN && sock_writeable(transport->inet))
901 if (likely(sent > 0) || status == 0) {
902 transport->xmit.offset += sent;
903 req->rq_bytes_sent = transport->xmit.offset;
904 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
905 req->rq_xmit_bytes_sent += transport->xmit.offset;
906 req->rq_bytes_sent = 0;
907 transport->xmit.offset = 0;
917 status = xs_nospace(req);
920 dprintk("RPC: sendmsg returned unrecognized error %d\n",
932 * xs_udp_send_request - write an RPC request to a UDP socket
933 * @req: pointer to RPC request
936 * 0: The request has been sent
937 * EAGAIN: The socket was blocked, please call again later to
938 * complete the request
939 * ENOTCONN: Caller needs to invoke connect logic then call again
940 * other: Some other error occurred, the request was not sent
942 static int xs_udp_send_request(struct rpc_rqst *req)
944 struct rpc_xprt *xprt = req->rq_xprt;
945 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
946 struct xdr_buf *xdr = &req->rq_snd_buf;
950 xs_pktdump("packet data:",
951 req->rq_svec->iov_base,
952 req->rq_svec->iov_len);
954 if (!xprt_bound(xprt))
957 if (!xprt_request_get_cong(xprt, req))
960 req->rq_xtime = ktime_get();
961 status = xs_sendpages(transport->sock, xs_addr(xprt), xprt->addrlen,
962 xdr, 0, true, &sent);
964 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
967 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
968 if (status == -EPERM)
971 if (status == -EAGAIN && sock_writeable(transport->inet))
974 if (sent > 0 || status == 0) {
975 req->rq_xmit_bytes_sent += sent;
976 if (sent >= req->rq_slen)
978 /* Still some bytes left; set up for a retry later. */
986 /* Should we call xs_close() here? */
989 status = xs_nospace(req);
996 /* When the server has died, an ICMP port unreachable message
997 * prompts ECONNREFUSED. */
1000 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1008 * xs_tcp_send_request - write an RPC request to a TCP socket
1009 * @req: pointer to RPC request
1012 * 0: The request has been sent
1013 * EAGAIN: The socket was blocked, please call again later to
1014 * complete the request
1015 * ENOTCONN: Caller needs to invoke connect logic then call again
1016 * other: Some other error occurred, the request was not sent
1018 * XXX: In the case of soft timeouts, should we eventually give up
1019 * if sendmsg is not able to make progress?
1021 static int xs_tcp_send_request(struct rpc_rqst *req)
1023 struct rpc_xprt *xprt = req->rq_xprt;
1024 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1025 struct xdr_buf *xdr = &req->rq_snd_buf;
1026 bool zerocopy = true;
1027 bool vm_wait = false;
1031 /* Close the stream if the previous transmission was incomplete */
1032 if (xs_send_request_was_aborted(transport, req)) {
1033 if (transport->sock != NULL)
1034 kernel_sock_shutdown(transport->sock, SHUT_RDWR);
1038 xs_encode_stream_record_marker(&req->rq_snd_buf);
1040 xs_pktdump("packet data:",
1041 req->rq_svec->iov_base,
1042 req->rq_svec->iov_len);
1043 /* Don't use zero copy if this is a resend. If the RPC call
1044 * completes while the socket holds a reference to the pages,
1045 * then we may end up resending corrupted data.
1047 if (req->rq_task->tk_flags & RPC_TASK_SENT)
1050 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
1051 xs_tcp_set_socket_timeouts(xprt, transport->sock);
1053 /* Continue transmitting the packet/record. We must be careful
1054 * to cope with writespace callbacks arriving _after_ we have
1055 * called sendmsg(). */
1056 req->rq_xtime = ktime_get();
1059 status = xs_sendpages(transport->sock, NULL, 0, xdr,
1060 transport->xmit.offset,
1063 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
1064 xdr->len - transport->xmit.offset, status);
1066 /* If we've sent the entire packet, immediately
1067 * reset the count of bytes sent. */
1068 transport->xmit.offset += sent;
1069 req->rq_bytes_sent = transport->xmit.offset;
1070 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
1071 req->rq_xmit_bytes_sent += transport->xmit.offset;
1072 req->rq_bytes_sent = 0;
1073 transport->xmit.offset = 0;
1077 WARN_ON_ONCE(sent == 0 && status == 0);
1079 if (status == -EAGAIN ) {
1081 * Return EAGAIN if we're sure we're hitting the
1082 * socket send buffer limits.
1084 if (test_bit(SOCK_NOSPACE, &transport->sock->flags))
1087 * Did we hit a memory allocation failure?
1093 /* Retry, knowing now that we're below the
1094 * socket send buffer limit
1108 /* Should we call xs_close() here? */
1111 status = xs_nospace(req);
1121 dprintk("RPC: sendmsg returned unrecognized error %d\n",
1128 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1130 transport->old_data_ready = sk->sk_data_ready;
1131 transport->old_state_change = sk->sk_state_change;
1132 transport->old_write_space = sk->sk_write_space;
1133 transport->old_error_report = sk->sk_error_report;
1136 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
1138 sk->sk_data_ready = transport->old_data_ready;
1139 sk->sk_state_change = transport->old_state_change;
1140 sk->sk_write_space = transport->old_write_space;
1141 sk->sk_error_report = transport->old_error_report;
1144 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
1146 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1148 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1151 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1153 smp_mb__before_atomic();
1154 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1155 clear_bit(XPRT_CLOSING, &xprt->state);
1156 xs_sock_reset_state_flags(xprt);
1157 smp_mb__after_atomic();
1161 * xs_error_report - callback to handle TCP socket state errors
1164 * Note: we don't call sock_error() since there may be a rpc_task
1165 * using the socket, and so we don't want to clear sk->sk_err.
1167 static void xs_error_report(struct sock *sk)
1169 struct rpc_xprt *xprt;
1172 read_lock_bh(&sk->sk_callback_lock);
1173 if (!(xprt = xprt_from_sock(sk)))
1179 dprintk("RPC: xs_error_report client %p, error=%d...\n",
1181 trace_rpc_socket_error(xprt, sk->sk_socket, err);
1182 xprt_wake_pending_tasks(xprt, err);
1184 read_unlock_bh(&sk->sk_callback_lock);
1187 static void xs_reset_transport(struct sock_xprt *transport)
1189 struct socket *sock = transport->sock;
1190 struct sock *sk = transport->inet;
1191 struct rpc_xprt *xprt = &transport->xprt;
1196 if (atomic_read(&transport->xprt.swapper))
1197 sk_clear_memalloc(sk);
1199 kernel_sock_shutdown(sock, SHUT_RDWR);
1201 mutex_lock(&transport->recv_mutex);
1202 write_lock_bh(&sk->sk_callback_lock);
1203 transport->inet = NULL;
1204 transport->sock = NULL;
1206 sk->sk_user_data = NULL;
1208 xs_restore_old_callbacks(transport, sk);
1209 xprt_clear_connected(xprt);
1210 write_unlock_bh(&sk->sk_callback_lock);
1211 xs_sock_reset_connection_flags(xprt);
1212 mutex_unlock(&transport->recv_mutex);
1214 trace_rpc_socket_close(xprt, sock);
1217 xprt_disconnect_done(xprt);
1221 * xs_close - close a socket
1224 * This is used when all requests are complete; ie, no DRC state remains
1225 * on the server we want to save.
1227 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
1228 * xs_reset_transport() zeroing the socket from underneath a writer.
1230 static void xs_close(struct rpc_xprt *xprt)
1232 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1234 dprintk("RPC: xs_close xprt %p\n", xprt);
1236 xs_reset_transport(transport);
1237 xprt->reestablish_timeout = 0;
1240 static void xs_inject_disconnect(struct rpc_xprt *xprt)
1242 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
1244 xprt_disconnect_done(xprt);
1247 static void xs_xprt_free(struct rpc_xprt *xprt)
1249 xs_free_peer_addresses(xprt);
1254 * xs_destroy - prepare to shutdown a transport
1255 * @xprt: doomed transport
1258 static void xs_destroy(struct rpc_xprt *xprt)
1260 struct sock_xprt *transport = container_of(xprt,
1261 struct sock_xprt, xprt);
1262 dprintk("RPC: xs_destroy xprt %p\n", xprt);
1264 cancel_delayed_work_sync(&transport->connect_worker);
1266 cancel_work_sync(&transport->recv_worker);
1268 module_put(THIS_MODULE);
1272 * xs_udp_data_read_skb - receive callback for UDP sockets
1278 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1280 struct sk_buff *skb)
1282 struct rpc_task *task;
1283 struct rpc_rqst *rovr;
1284 int repsize, copied;
1290 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1294 /* Copy the XID from the skb... */
1295 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1299 /* Look up and lock the request corresponding to the given XID */
1300 spin_lock(&xprt->queue_lock);
1301 rovr = xprt_lookup_rqst(xprt, *xp);
1304 xprt_pin_rqst(rovr);
1305 xprt_update_rtt(rovr->rq_task);
1306 spin_unlock(&xprt->queue_lock);
1307 task = rovr->rq_task;
1309 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1312 /* Suck it into the iovec, verify checksum if not done by hw. */
1313 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1314 spin_lock(&xprt->queue_lock);
1315 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1320 spin_lock_bh(&xprt->transport_lock);
1321 xprt_adjust_cwnd(xprt, task, copied);
1322 spin_unlock_bh(&xprt->transport_lock);
1323 spin_lock(&xprt->queue_lock);
1324 xprt_complete_rqst(task, copied);
1325 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1327 xprt_unpin_rqst(rovr);
1329 spin_unlock(&xprt->queue_lock);
1332 static void xs_udp_data_receive(struct sock_xprt *transport)
1334 struct sk_buff *skb;
1338 mutex_lock(&transport->recv_mutex);
1339 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1340 sk = transport->inet;
1344 skb = skb_recv_udp(sk, 0, 1, &err);
1347 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1352 mutex_unlock(&transport->recv_mutex);
1355 static void xs_udp_data_receive_workfn(struct work_struct *work)
1357 struct sock_xprt *transport =
1358 container_of(work, struct sock_xprt, recv_worker);
1359 xs_udp_data_receive(transport);
1363 * xs_data_ready - "data ready" callback for UDP sockets
1364 * @sk: socket with data to read
1367 static void xs_data_ready(struct sock *sk)
1369 struct rpc_xprt *xprt;
1371 read_lock_bh(&sk->sk_callback_lock);
1372 dprintk("RPC: xs_data_ready...\n");
1373 xprt = xprt_from_sock(sk);
1375 struct sock_xprt *transport = container_of(xprt,
1376 struct sock_xprt, xprt);
1377 transport->old_data_ready(sk);
1378 /* Any data means we had a useful conversation, so
1379 * then we don't need to delay the next reconnect
1381 if (xprt->reestablish_timeout)
1382 xprt->reestablish_timeout = 0;
1383 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1384 queue_work(xprtiod_workqueue, &transport->recv_worker);
1386 read_unlock_bh(&sk->sk_callback_lock);
1390 * Helper function to force a TCP close if the server is sending
1391 * junk and/or it has put us in CLOSE_WAIT
1393 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1395 xprt_force_disconnect(xprt);
1398 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1399 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1403 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1406 * xs_tcp_state_change - callback to handle TCP socket state changes
1407 * @sk: socket whose state has changed
1410 static void xs_tcp_state_change(struct sock *sk)
1412 struct rpc_xprt *xprt;
1413 struct sock_xprt *transport;
1415 read_lock_bh(&sk->sk_callback_lock);
1416 if (!(xprt = xprt_from_sock(sk)))
1418 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1419 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1420 sk->sk_state, xprt_connected(xprt),
1421 sock_flag(sk, SOCK_DEAD),
1422 sock_flag(sk, SOCK_ZAPPED),
1425 transport = container_of(xprt, struct sock_xprt, xprt);
1426 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1427 switch (sk->sk_state) {
1428 case TCP_ESTABLISHED:
1429 spin_lock(&xprt->transport_lock);
1430 if (!xprt_test_and_set_connected(xprt)) {
1431 xprt->connect_cookie++;
1432 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1433 xprt_clear_connecting(xprt);
1435 xprt->stat.connect_count++;
1436 xprt->stat.connect_time += (long)jiffies -
1437 xprt->stat.connect_start;
1438 xprt_wake_pending_tasks(xprt, -EAGAIN);
1440 spin_unlock(&xprt->transport_lock);
1443 /* The client initiated a shutdown of the socket */
1444 xprt->connect_cookie++;
1445 xprt->reestablish_timeout = 0;
1446 set_bit(XPRT_CLOSING, &xprt->state);
1447 smp_mb__before_atomic();
1448 clear_bit(XPRT_CONNECTED, &xprt->state);
1449 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1450 smp_mb__after_atomic();
1452 case TCP_CLOSE_WAIT:
1453 /* The server initiated a shutdown of the socket */
1454 xprt->connect_cookie++;
1455 clear_bit(XPRT_CONNECTED, &xprt->state);
1456 xs_tcp_force_close(xprt);
1460 * If the server closed down the connection, make sure that
1461 * we back off before reconnecting
1463 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1464 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1467 set_bit(XPRT_CLOSING, &xprt->state);
1468 smp_mb__before_atomic();
1469 clear_bit(XPRT_CONNECTED, &xprt->state);
1470 smp_mb__after_atomic();
1473 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1474 &transport->sock_state))
1475 xprt_clear_connecting(xprt);
1476 clear_bit(XPRT_CLOSING, &xprt->state);
1477 /* Trigger the socket release */
1478 xs_tcp_force_close(xprt);
1481 read_unlock_bh(&sk->sk_callback_lock);
1484 static void xs_write_space(struct sock *sk)
1486 struct socket_wq *wq;
1487 struct rpc_xprt *xprt;
1491 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1493 if (unlikely(!(xprt = xprt_from_sock(sk))))
1496 wq = rcu_dereference(sk->sk_wq);
1497 if (!wq || test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags) == 0)
1500 if (xprt_write_space(xprt))
1501 sk->sk_write_pending--;
1507 * xs_udp_write_space - callback invoked when socket buffer space
1509 * @sk: socket whose state has changed
1511 * Called when more output buffer space is available for this socket.
1512 * We try not to wake our writers until they can make "significant"
1513 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1514 * with a bunch of small requests.
1516 static void xs_udp_write_space(struct sock *sk)
1518 read_lock_bh(&sk->sk_callback_lock);
1520 /* from net/core/sock.c:sock_def_write_space */
1521 if (sock_writeable(sk))
1524 read_unlock_bh(&sk->sk_callback_lock);
1528 * xs_tcp_write_space - callback invoked when socket buffer space
1530 * @sk: socket whose state has changed
1532 * Called when more output buffer space is available for this socket.
1533 * We try not to wake our writers until they can make "significant"
1534 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1535 * with a bunch of small requests.
1537 static void xs_tcp_write_space(struct sock *sk)
1539 read_lock_bh(&sk->sk_callback_lock);
1541 /* from net/core/stream.c:sk_stream_write_space */
1542 if (sk_stream_is_writeable(sk))
1545 read_unlock_bh(&sk->sk_callback_lock);
1548 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1550 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1551 struct sock *sk = transport->inet;
1553 if (transport->rcvsize) {
1554 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1555 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1557 if (transport->sndsize) {
1558 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1559 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1560 sk->sk_write_space(sk);
1565 * xs_udp_set_buffer_size - set send and receive limits
1566 * @xprt: generic transport
1567 * @sndsize: requested size of send buffer, in bytes
1568 * @rcvsize: requested size of receive buffer, in bytes
1570 * Set socket send and receive buffer size limits.
1572 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1574 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1576 transport->sndsize = 0;
1578 transport->sndsize = sndsize + 1024;
1579 transport->rcvsize = 0;
1581 transport->rcvsize = rcvsize + 1024;
1583 xs_udp_do_set_buffer_size(xprt);
1587 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1588 * @xprt: controlling transport
1589 * @task: task that timed out
1591 * Adjust the congestion window after a retransmit timeout has occurred.
1593 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1595 spin_lock_bh(&xprt->transport_lock);
1596 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1597 spin_unlock_bh(&xprt->transport_lock);
1600 static int xs_get_random_port(void)
1602 unsigned short min = xprt_min_resvport, max = xprt_max_resvport;
1603 unsigned short range;
1604 unsigned short rand;
1608 range = max - min + 1;
1609 rand = (unsigned short) prandom_u32() % range;
1614 * xs_set_reuseaddr_port - set the socket's port and address reuse options
1617 * Note that this function has to be called on all sockets that share the
1618 * same port, and it must be called before binding.
1620 static void xs_sock_set_reuseport(struct socket *sock)
1624 kernel_setsockopt(sock, SOL_SOCKET, SO_REUSEPORT,
1625 (char *)&opt, sizeof(opt));
1628 static unsigned short xs_sock_getport(struct socket *sock)
1630 struct sockaddr_storage buf;
1631 unsigned short port = 0;
1633 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0)
1635 switch (buf.ss_family) {
1637 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1640 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1647 * xs_set_port - reset the port number in the remote endpoint address
1648 * @xprt: generic transport
1649 * @port: new port number
1652 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1654 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1656 rpc_set_port(xs_addr(xprt), port);
1657 xs_update_peer_port(xprt);
1660 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1662 if (transport->srcport == 0)
1663 transport->srcport = xs_sock_getport(sock);
1666 static int xs_get_srcport(struct sock_xprt *transport)
1668 int port = transport->srcport;
1670 if (port == 0 && transport->xprt.resvport)
1671 port = xs_get_random_port();
1675 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1677 if (transport->srcport != 0)
1678 transport->srcport = 0;
1679 if (!transport->xprt.resvport)
1681 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1682 return xprt_max_resvport;
1685 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1687 struct sockaddr_storage myaddr;
1689 int port = xs_get_srcport(transport);
1690 unsigned short last;
1693 * If we are asking for any ephemeral port (i.e. port == 0 &&
1694 * transport->xprt.resvport == 0), don't bind. Let the local
1695 * port selection happen implicitly when the socket is used
1696 * (for example at connect time).
1698 * This ensures that we can continue to establish TCP
1699 * connections even when all local ephemeral ports are already
1700 * a part of some TCP connection. This makes no difference
1701 * for UDP sockets, but also doens't harm them.
1703 * If we're asking for any reserved port (i.e. port == 0 &&
1704 * transport->xprt.resvport == 1) xs_get_srcport above will
1705 * ensure that port is non-zero and we will bind as needed.
1710 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1712 rpc_set_port((struct sockaddr *)&myaddr, port);
1713 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1714 transport->xprt.addrlen);
1716 transport->srcport = port;
1720 port = xs_next_srcport(transport, port);
1723 } while (err == -EADDRINUSE && nloop != 2);
1725 if (myaddr.ss_family == AF_INET)
1726 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1727 &((struct sockaddr_in *)&myaddr)->sin_addr,
1728 port, err ? "failed" : "ok", err);
1730 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1731 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1732 port, err ? "failed" : "ok", err);
1737 * We don't support autobind on AF_LOCAL sockets
1739 static void xs_local_rpcbind(struct rpc_task *task)
1741 xprt_set_bound(task->tk_xprt);
1744 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1748 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1749 static struct lock_class_key xs_key[2];
1750 static struct lock_class_key xs_slock_key[2];
1752 static inline void xs_reclassify_socketu(struct socket *sock)
1754 struct sock *sk = sock->sk;
1756 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1757 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1760 static inline void xs_reclassify_socket4(struct socket *sock)
1762 struct sock *sk = sock->sk;
1764 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1765 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1768 static inline void xs_reclassify_socket6(struct socket *sock)
1770 struct sock *sk = sock->sk;
1772 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1773 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1776 static inline void xs_reclassify_socket(int family, struct socket *sock)
1778 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1783 xs_reclassify_socketu(sock);
1786 xs_reclassify_socket4(sock);
1789 xs_reclassify_socket6(sock);
1794 static inline void xs_reclassify_socket(int family, struct socket *sock)
1799 static void xs_dummy_setup_socket(struct work_struct *work)
1803 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1804 struct sock_xprt *transport, int family, int type,
1805 int protocol, bool reuseport)
1807 struct socket *sock;
1810 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1812 dprintk("RPC: can't create %d transport socket (%d).\n",
1816 xs_reclassify_socket(family, sock);
1819 xs_sock_set_reuseport(sock);
1821 err = xs_bind(transport, sock);
1829 return ERR_PTR(err);
1832 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1833 struct socket *sock)
1835 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1838 if (!transport->inet) {
1839 struct sock *sk = sock->sk;
1841 write_lock_bh(&sk->sk_callback_lock);
1843 xs_save_old_callbacks(transport, sk);
1845 sk->sk_user_data = xprt;
1846 sk->sk_data_ready = xs_data_ready;
1847 sk->sk_write_space = xs_udp_write_space;
1848 sock_set_flag(sk, SOCK_FASYNC);
1849 sk->sk_error_report = xs_error_report;
1850 sk->sk_allocation = GFP_NOIO;
1852 xprt_clear_connected(xprt);
1854 /* Reset to new socket */
1855 transport->sock = sock;
1856 transport->inet = sk;
1858 write_unlock_bh(&sk->sk_callback_lock);
1861 xs_stream_reset_connect(transport);
1863 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1867 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1868 * @transport: socket transport to connect
1870 static int xs_local_setup_socket(struct sock_xprt *transport)
1872 struct rpc_xprt *xprt = &transport->xprt;
1873 struct socket *sock;
1876 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1877 SOCK_STREAM, 0, &sock, 1);
1879 dprintk("RPC: can't create AF_LOCAL "
1880 "transport socket (%d).\n", -status);
1883 xs_reclassify_socket(AF_LOCAL, sock);
1885 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1886 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1888 status = xs_local_finish_connecting(xprt, sock);
1889 trace_rpc_socket_connect(xprt, sock, status);
1892 dprintk("RPC: xprt %p connected to %s\n",
1893 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1894 xprt->stat.connect_count++;
1895 xprt->stat.connect_time += (long)jiffies -
1896 xprt->stat.connect_start;
1897 xprt_set_connected(xprt);
1901 dprintk("RPC: xprt %p: socket %s does not exist\n",
1902 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1905 dprintk("RPC: xprt %p: connection refused for %s\n",
1906 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1909 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1911 xprt->address_strings[RPC_DISPLAY_ADDR]);
1915 xprt_clear_connecting(xprt);
1916 xprt_wake_pending_tasks(xprt, status);
1920 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1922 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1925 if (RPC_IS_ASYNC(task)) {
1927 * We want the AF_LOCAL connect to be resolved in the
1928 * filesystem namespace of the process making the rpc
1929 * call. Thus we connect synchronously.
1931 * If we want to support asynchronous AF_LOCAL calls,
1932 * we'll need to figure out how to pass a namespace to
1935 rpc_exit(task, -ENOTCONN);
1938 ret = xs_local_setup_socket(transport);
1939 if (ret && !RPC_IS_SOFTCONN(task))
1940 msleep_interruptible(15000);
1943 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
1945 * Note that this should be called with XPRT_LOCKED held (or when we otherwise
1946 * know that we have exclusive access to the socket), to guard against
1947 * races with xs_reset_transport.
1949 static void xs_set_memalloc(struct rpc_xprt *xprt)
1951 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1955 * If there's no sock, then we have nothing to set. The
1956 * reconnecting process will get it for us.
1958 if (!transport->inet)
1960 if (atomic_read(&xprt->swapper))
1961 sk_set_memalloc(transport->inet);
1965 * xs_enable_swap - Tag this transport as being used for swap.
1966 * @xprt: transport to tag
1968 * Take a reference to this transport on behalf of the rpc_clnt, and
1969 * optionally mark it for swapping if it wasn't already.
1972 xs_enable_swap(struct rpc_xprt *xprt)
1974 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
1976 if (atomic_inc_return(&xprt->swapper) != 1)
1978 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
1979 return -ERESTARTSYS;
1981 sk_set_memalloc(xs->inet);
1982 xprt_release_xprt(xprt, NULL);
1987 * xs_disable_swap - Untag this transport as being used for swap.
1988 * @xprt: transport to tag
1990 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
1991 * swapper refcount goes to 0, untag the socket as a memalloc socket.
1994 xs_disable_swap(struct rpc_xprt *xprt)
1996 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
1998 if (!atomic_dec_and_test(&xprt->swapper))
2000 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2003 sk_clear_memalloc(xs->inet);
2004 xprt_release_xprt(xprt, NULL);
2007 static void xs_set_memalloc(struct rpc_xprt *xprt)
2012 xs_enable_swap(struct rpc_xprt *xprt)
2018 xs_disable_swap(struct rpc_xprt *xprt)
2023 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2025 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2027 if (!transport->inet) {
2028 struct sock *sk = sock->sk;
2030 write_lock_bh(&sk->sk_callback_lock);
2032 xs_save_old_callbacks(transport, sk);
2034 sk->sk_user_data = xprt;
2035 sk->sk_data_ready = xs_data_ready;
2036 sk->sk_write_space = xs_udp_write_space;
2037 sock_set_flag(sk, SOCK_FASYNC);
2038 sk->sk_allocation = GFP_NOIO;
2040 xprt_set_connected(xprt);
2042 /* Reset to new socket */
2043 transport->sock = sock;
2044 transport->inet = sk;
2046 xs_set_memalloc(xprt);
2048 write_unlock_bh(&sk->sk_callback_lock);
2050 xs_udp_do_set_buffer_size(xprt);
2052 xprt->stat.connect_start = jiffies;
2055 static void xs_udp_setup_socket(struct work_struct *work)
2057 struct sock_xprt *transport =
2058 container_of(work, struct sock_xprt, connect_worker.work);
2059 struct rpc_xprt *xprt = &transport->xprt;
2060 struct socket *sock;
2063 sock = xs_create_sock(xprt, transport,
2064 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2065 IPPROTO_UDP, false);
2069 dprintk("RPC: worker connecting xprt %p via %s to "
2070 "%s (port %s)\n", xprt,
2071 xprt->address_strings[RPC_DISPLAY_PROTO],
2072 xprt->address_strings[RPC_DISPLAY_ADDR],
2073 xprt->address_strings[RPC_DISPLAY_PORT]);
2075 xs_udp_finish_connecting(xprt, sock);
2076 trace_rpc_socket_connect(xprt, sock, 0);
2079 xprt_clear_connecting(xprt);
2080 xprt_unlock_connect(xprt, transport);
2081 xprt_wake_pending_tasks(xprt, status);
2085 * xs_tcp_shutdown - gracefully shut down a TCP socket
2088 * Initiates a graceful shutdown of the TCP socket by calling the
2089 * equivalent of shutdown(SHUT_RDWR);
2091 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2093 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2094 struct socket *sock = transport->sock;
2095 int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE;
2101 kernel_sock_shutdown(sock, SHUT_RDWR);
2102 trace_rpc_socket_shutdown(xprt, sock);
2106 xs_reset_transport(transport);
2110 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2111 struct socket *sock)
2113 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2114 unsigned int keepidle;
2115 unsigned int keepcnt;
2116 unsigned int opt_on = 1;
2119 spin_lock_bh(&xprt->transport_lock);
2120 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2121 keepcnt = xprt->timeout->to_retries + 1;
2122 timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2123 (xprt->timeout->to_retries + 1);
2124 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2125 spin_unlock_bh(&xprt->transport_lock);
2127 /* TCP Keepalive options */
2128 kernel_setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE,
2129 (char *)&opt_on, sizeof(opt_on));
2130 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPIDLE,
2131 (char *)&keepidle, sizeof(keepidle));
2132 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPINTVL,
2133 (char *)&keepidle, sizeof(keepidle));
2134 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPCNT,
2135 (char *)&keepcnt, sizeof(keepcnt));
2137 /* TCP user timeout (see RFC5482) */
2138 kernel_setsockopt(sock, SOL_TCP, TCP_USER_TIMEOUT,
2139 (char *)&timeo, sizeof(timeo));
2142 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2143 unsigned long connect_timeout,
2144 unsigned long reconnect_timeout)
2146 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2147 struct rpc_timeout to;
2148 unsigned long initval;
2150 spin_lock_bh(&xprt->transport_lock);
2151 if (reconnect_timeout < xprt->max_reconnect_timeout)
2152 xprt->max_reconnect_timeout = reconnect_timeout;
2153 if (connect_timeout < xprt->connect_timeout) {
2154 memcpy(&to, xprt->timeout, sizeof(to));
2155 initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1);
2156 /* Arbitrary lower limit */
2157 if (initval < XS_TCP_INIT_REEST_TO << 1)
2158 initval = XS_TCP_INIT_REEST_TO << 1;
2159 to.to_initval = initval;
2160 to.to_maxval = initval;
2161 memcpy(&transport->tcp_timeout, &to,
2162 sizeof(transport->tcp_timeout));
2163 xprt->timeout = &transport->tcp_timeout;
2164 xprt->connect_timeout = connect_timeout;
2166 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2167 spin_unlock_bh(&xprt->transport_lock);
2170 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2172 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2173 int ret = -ENOTCONN;
2175 if (!transport->inet) {
2176 struct sock *sk = sock->sk;
2177 unsigned int addr_pref = IPV6_PREFER_SRC_PUBLIC;
2179 /* Avoid temporary address, they are bad for long-lived
2180 * connections such as NFS mounts.
2181 * RFC4941, section 3.6 suggests that:
2182 * Individual applications, which have specific
2183 * knowledge about the normal duration of connections,
2184 * MAY override this as appropriate.
2186 kernel_setsockopt(sock, SOL_IPV6, IPV6_ADDR_PREFERENCES,
2187 (char *)&addr_pref, sizeof(addr_pref));
2189 xs_tcp_set_socket_timeouts(xprt, sock);
2191 write_lock_bh(&sk->sk_callback_lock);
2193 xs_save_old_callbacks(transport, sk);
2195 sk->sk_user_data = xprt;
2196 sk->sk_data_ready = xs_data_ready;
2197 sk->sk_state_change = xs_tcp_state_change;
2198 sk->sk_write_space = xs_tcp_write_space;
2199 sock_set_flag(sk, SOCK_FASYNC);
2200 sk->sk_error_report = xs_error_report;
2201 sk->sk_allocation = GFP_NOIO;
2203 /* socket options */
2204 sock_reset_flag(sk, SOCK_LINGER);
2205 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2207 xprt_clear_connected(xprt);
2209 /* Reset to new socket */
2210 transport->sock = sock;
2211 transport->inet = sk;
2213 write_unlock_bh(&sk->sk_callback_lock);
2216 if (!xprt_bound(xprt))
2219 xs_set_memalloc(xprt);
2221 /* Reset TCP record info */
2222 xs_stream_reset_connect(transport);
2224 /* Tell the socket layer to start connecting... */
2225 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2226 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2229 xs_set_srcport(transport, sock);
2233 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2234 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2236 case -EADDRNOTAVAIL:
2237 /* Source port number is unavailable. Try a new one! */
2238 transport->srcport = 0;
2245 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2246 * @work: queued work item
2248 * Invoked by a work queue tasklet.
2250 static void xs_tcp_setup_socket(struct work_struct *work)
2252 struct sock_xprt *transport =
2253 container_of(work, struct sock_xprt, connect_worker.work);
2254 struct socket *sock = transport->sock;
2255 struct rpc_xprt *xprt = &transport->xprt;
2259 sock = xs_create_sock(xprt, transport,
2260 xs_addr(xprt)->sa_family, SOCK_STREAM,
2263 status = PTR_ERR(sock);
2268 dprintk("RPC: worker connecting xprt %p via %s to "
2269 "%s (port %s)\n", xprt,
2270 xprt->address_strings[RPC_DISPLAY_PROTO],
2271 xprt->address_strings[RPC_DISPLAY_ADDR],
2272 xprt->address_strings[RPC_DISPLAY_PORT]);
2274 status = xs_tcp_finish_connecting(xprt, sock);
2275 trace_rpc_socket_connect(xprt, sock, status);
2276 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2277 xprt, -status, xprt_connected(xprt),
2278 sock->sk->sk_state);
2281 printk("%s: connect returned unhandled error %d\n",
2284 case -EADDRNOTAVAIL:
2285 /* We're probably in TIME_WAIT. Get rid of existing socket,
2288 xs_tcp_force_close(xprt);
2293 xprt_unlock_connect(xprt, transport);
2296 /* Happens, for instance, if the user specified a link
2297 * local IPv6 address without a scope-id.
2307 * xs_tcp_force_close() wakes tasks with -EIO.
2308 * We need to wake them first to ensure the
2309 * correct error code.
2311 xprt_wake_pending_tasks(xprt, status);
2312 xs_tcp_force_close(xprt);
2317 xprt_clear_connecting(xprt);
2318 xprt_unlock_connect(xprt, transport);
2319 xprt_wake_pending_tasks(xprt, status);
2322 static unsigned long xs_reconnect_delay(const struct rpc_xprt *xprt)
2324 unsigned long start, now = jiffies;
2326 start = xprt->stat.connect_start + xprt->reestablish_timeout;
2327 if (time_after(start, now))
2332 static void xs_reconnect_backoff(struct rpc_xprt *xprt)
2334 xprt->reestablish_timeout <<= 1;
2335 if (xprt->reestablish_timeout > xprt->max_reconnect_timeout)
2336 xprt->reestablish_timeout = xprt->max_reconnect_timeout;
2337 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2338 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2342 * xs_connect - connect a socket to a remote endpoint
2343 * @xprt: pointer to transport structure
2344 * @task: address of RPC task that manages state of connect request
2346 * TCP: If the remote end dropped the connection, delay reconnecting.
2348 * UDP socket connects are synchronous, but we use a work queue anyway
2349 * to guarantee that even unprivileged user processes can set up a
2350 * socket on a privileged port.
2352 * If a UDP socket connect fails, the delay behavior here prevents
2353 * retry floods (hard mounts).
2355 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2357 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2358 unsigned long delay = 0;
2360 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2362 if (transport->sock != NULL) {
2363 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2365 xprt, xprt->reestablish_timeout / HZ);
2367 /* Start by resetting any existing state */
2368 xs_reset_transport(transport);
2370 delay = xs_reconnect_delay(xprt);
2371 xs_reconnect_backoff(xprt);
2374 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2376 queue_delayed_work(xprtiod_workqueue,
2377 &transport->connect_worker,
2382 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2383 * @xprt: rpc_xprt struct containing statistics
2387 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2391 if (xprt_connected(xprt))
2392 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2394 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2395 "%llu %llu %lu %llu %llu\n",
2396 xprt->stat.bind_count,
2397 xprt->stat.connect_count,
2398 xprt->stat.connect_time / HZ,
2402 xprt->stat.bad_xids,
2405 xprt->stat.max_slots,
2406 xprt->stat.sending_u,
2407 xprt->stat.pending_u);
2411 * xs_udp_print_stats - display UDP socket-specifc stats
2412 * @xprt: rpc_xprt struct containing statistics
2416 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2418 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2420 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2423 xprt->stat.bind_count,
2426 xprt->stat.bad_xids,
2429 xprt->stat.max_slots,
2430 xprt->stat.sending_u,
2431 xprt->stat.pending_u);
2435 * xs_tcp_print_stats - display TCP socket-specifc stats
2436 * @xprt: rpc_xprt struct containing statistics
2440 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2442 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2445 if (xprt_connected(xprt))
2446 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2448 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2449 "%llu %llu %lu %llu %llu\n",
2451 xprt->stat.bind_count,
2452 xprt->stat.connect_count,
2453 xprt->stat.connect_time / HZ,
2457 xprt->stat.bad_xids,
2460 xprt->stat.max_slots,
2461 xprt->stat.sending_u,
2462 xprt->stat.pending_u);
2466 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2467 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2468 * to use the server side send routines.
2470 static int bc_malloc(struct rpc_task *task)
2472 struct rpc_rqst *rqst = task->tk_rqstp;
2473 size_t size = rqst->rq_callsize;
2475 struct rpc_buffer *buf;
2477 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2478 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2483 page = alloc_page(GFP_KERNEL);
2487 buf = page_address(page);
2488 buf->len = PAGE_SIZE;
2490 rqst->rq_buffer = buf->data;
2491 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2496 * Free the space allocated in the bc_alloc routine
2498 static void bc_free(struct rpc_task *task)
2500 void *buffer = task->tk_rqstp->rq_buffer;
2501 struct rpc_buffer *buf;
2503 buf = container_of(buffer, struct rpc_buffer, data);
2504 free_page((unsigned long)buf);
2508 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2509 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2511 static int bc_sendto(struct rpc_rqst *req)
2514 struct xdr_buf *xbufp = &req->rq_snd_buf;
2515 struct rpc_xprt *xprt = req->rq_xprt;
2516 struct sock_xprt *transport =
2517 container_of(xprt, struct sock_xprt, xprt);
2518 struct socket *sock = transport->sock;
2519 unsigned long headoff;
2520 unsigned long tailoff;
2522 xs_encode_stream_record_marker(xbufp);
2524 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2525 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2526 len = svc_send_common(sock, xbufp,
2527 virt_to_page(xbufp->head[0].iov_base), headoff,
2528 xbufp->tail[0].iov_base, tailoff);
2530 if (len != xbufp->len) {
2531 printk(KERN_NOTICE "Error sending entire callback!\n");
2539 * The send routine. Borrows from svc_send
2541 static int bc_send_request(struct rpc_rqst *req)
2543 struct svc_xprt *xprt;
2546 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2548 * Get the server socket associated with this callback xprt
2550 xprt = req->rq_xprt->bc_xprt;
2553 * Grab the mutex to serialize data as the connection is shared
2554 * with the fore channel
2556 mutex_lock(&xprt->xpt_mutex);
2557 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2560 len = bc_sendto(req);
2561 mutex_unlock(&xprt->xpt_mutex);
2570 * The close routine. Since this is client initiated, we do nothing
2573 static void bc_close(struct rpc_xprt *xprt)
2578 * The xprt destroy routine. Again, because this connection is client
2579 * initiated, we do nothing
2582 static void bc_destroy(struct rpc_xprt *xprt)
2584 dprintk("RPC: bc_destroy xprt %p\n", xprt);
2587 module_put(THIS_MODULE);
2590 static const struct rpc_xprt_ops xs_local_ops = {
2591 .reserve_xprt = xprt_reserve_xprt,
2592 .release_xprt = xprt_release_xprt,
2593 .alloc_slot = xprt_alloc_slot,
2594 .free_slot = xprt_free_slot,
2595 .rpcbind = xs_local_rpcbind,
2596 .set_port = xs_local_set_port,
2597 .connect = xs_local_connect,
2598 .buf_alloc = rpc_malloc,
2599 .buf_free = rpc_free,
2600 .prepare_request = xs_stream_prepare_request,
2601 .send_request = xs_local_send_request,
2602 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2604 .destroy = xs_destroy,
2605 .print_stats = xs_local_print_stats,
2606 .enable_swap = xs_enable_swap,
2607 .disable_swap = xs_disable_swap,
2610 static const struct rpc_xprt_ops xs_udp_ops = {
2611 .set_buffer_size = xs_udp_set_buffer_size,
2612 .reserve_xprt = xprt_reserve_xprt_cong,
2613 .release_xprt = xprt_release_xprt_cong,
2614 .alloc_slot = xprt_alloc_slot,
2615 .free_slot = xprt_free_slot,
2616 .rpcbind = rpcb_getport_async,
2617 .set_port = xs_set_port,
2618 .connect = xs_connect,
2619 .buf_alloc = rpc_malloc,
2620 .buf_free = rpc_free,
2621 .send_request = xs_udp_send_request,
2622 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2623 .timer = xs_udp_timer,
2624 .release_request = xprt_release_rqst_cong,
2626 .destroy = xs_destroy,
2627 .print_stats = xs_udp_print_stats,
2628 .enable_swap = xs_enable_swap,
2629 .disable_swap = xs_disable_swap,
2630 .inject_disconnect = xs_inject_disconnect,
2633 static const struct rpc_xprt_ops xs_tcp_ops = {
2634 .reserve_xprt = xprt_reserve_xprt,
2635 .release_xprt = xprt_release_xprt,
2636 .alloc_slot = xprt_alloc_slot,
2637 .free_slot = xprt_free_slot,
2638 .rpcbind = rpcb_getport_async,
2639 .set_port = xs_set_port,
2640 .connect = xs_connect,
2641 .buf_alloc = rpc_malloc,
2642 .buf_free = rpc_free,
2643 .prepare_request = xs_stream_prepare_request,
2644 .send_request = xs_tcp_send_request,
2645 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2646 .close = xs_tcp_shutdown,
2647 .destroy = xs_destroy,
2648 .set_connect_timeout = xs_tcp_set_connect_timeout,
2649 .print_stats = xs_tcp_print_stats,
2650 .enable_swap = xs_enable_swap,
2651 .disable_swap = xs_disable_swap,
2652 .inject_disconnect = xs_inject_disconnect,
2653 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2654 .bc_setup = xprt_setup_bc,
2655 .bc_maxpayload = xs_tcp_bc_maxpayload,
2656 .bc_free_rqst = xprt_free_bc_rqst,
2657 .bc_destroy = xprt_destroy_bc,
2662 * The rpc_xprt_ops for the server backchannel
2665 static const struct rpc_xprt_ops bc_tcp_ops = {
2666 .reserve_xprt = xprt_reserve_xprt,
2667 .release_xprt = xprt_release_xprt,
2668 .alloc_slot = xprt_alloc_slot,
2669 .free_slot = xprt_free_slot,
2670 .buf_alloc = bc_malloc,
2671 .buf_free = bc_free,
2672 .send_request = bc_send_request,
2673 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2675 .destroy = bc_destroy,
2676 .print_stats = xs_tcp_print_stats,
2677 .enable_swap = xs_enable_swap,
2678 .disable_swap = xs_disable_swap,
2679 .inject_disconnect = xs_inject_disconnect,
2682 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2684 static const struct sockaddr_in sin = {
2685 .sin_family = AF_INET,
2686 .sin_addr.s_addr = htonl(INADDR_ANY),
2688 static const struct sockaddr_in6 sin6 = {
2689 .sin6_family = AF_INET6,
2690 .sin6_addr = IN6ADDR_ANY_INIT,
2697 memcpy(sap, &sin, sizeof(sin));
2700 memcpy(sap, &sin6, sizeof(sin6));
2703 dprintk("RPC: %s: Bad address family\n", __func__);
2704 return -EAFNOSUPPORT;
2709 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2710 unsigned int slot_table_size,
2711 unsigned int max_slot_table_size)
2713 struct rpc_xprt *xprt;
2714 struct sock_xprt *new;
2716 if (args->addrlen > sizeof(xprt->addr)) {
2717 dprintk("RPC: xs_setup_xprt: address too large\n");
2718 return ERR_PTR(-EBADF);
2721 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2722 max_slot_table_size);
2724 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2726 return ERR_PTR(-ENOMEM);
2729 new = container_of(xprt, struct sock_xprt, xprt);
2730 mutex_init(&new->recv_mutex);
2731 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2732 xprt->addrlen = args->addrlen;
2734 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2737 err = xs_init_anyaddr(args->dstaddr->sa_family,
2738 (struct sockaddr *)&new->srcaddr);
2741 return ERR_PTR(err);
2748 static const struct rpc_timeout xs_local_default_timeout = {
2749 .to_initval = 10 * HZ,
2750 .to_maxval = 10 * HZ,
2755 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2756 * @args: rpc transport creation arguments
2758 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2760 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2762 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2763 struct sock_xprt *transport;
2764 struct rpc_xprt *xprt;
2765 struct rpc_xprt *ret;
2767 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2768 xprt_max_tcp_slot_table_entries);
2771 transport = container_of(xprt, struct sock_xprt, xprt);
2774 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2775 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2777 xprt->bind_timeout = XS_BIND_TO;
2778 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2779 xprt->idle_timeout = XS_IDLE_DISC_TO;
2781 xprt->ops = &xs_local_ops;
2782 xprt->timeout = &xs_local_default_timeout;
2784 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2785 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket);
2787 switch (sun->sun_family) {
2789 if (sun->sun_path[0] != '/') {
2790 dprintk("RPC: bad AF_LOCAL address: %s\n",
2792 ret = ERR_PTR(-EINVAL);
2795 xprt_set_bound(xprt);
2796 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2797 ret = ERR_PTR(xs_local_setup_socket(transport));
2802 ret = ERR_PTR(-EAFNOSUPPORT);
2806 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2807 xprt->address_strings[RPC_DISPLAY_ADDR]);
2809 if (try_module_get(THIS_MODULE))
2811 ret = ERR_PTR(-EINVAL);
2817 static const struct rpc_timeout xs_udp_default_timeout = {
2818 .to_initval = 5 * HZ,
2819 .to_maxval = 30 * HZ,
2820 .to_increment = 5 * HZ,
2825 * xs_setup_udp - Set up transport to use a UDP socket
2826 * @args: rpc transport creation arguments
2829 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2831 struct sockaddr *addr = args->dstaddr;
2832 struct rpc_xprt *xprt;
2833 struct sock_xprt *transport;
2834 struct rpc_xprt *ret;
2836 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2837 xprt_udp_slot_table_entries);
2840 transport = container_of(xprt, struct sock_xprt, xprt);
2842 xprt->prot = IPPROTO_UDP;
2844 /* XXX: header size can vary due to auth type, IPv6, etc. */
2845 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2847 xprt->bind_timeout = XS_BIND_TO;
2848 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2849 xprt->idle_timeout = XS_IDLE_DISC_TO;
2851 xprt->ops = &xs_udp_ops;
2853 xprt->timeout = &xs_udp_default_timeout;
2855 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
2856 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
2858 switch (addr->sa_family) {
2860 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2861 xprt_set_bound(xprt);
2863 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2866 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2867 xprt_set_bound(xprt);
2869 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2872 ret = ERR_PTR(-EAFNOSUPPORT);
2876 if (xprt_bound(xprt))
2877 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2878 xprt->address_strings[RPC_DISPLAY_ADDR],
2879 xprt->address_strings[RPC_DISPLAY_PORT],
2880 xprt->address_strings[RPC_DISPLAY_PROTO]);
2882 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2883 xprt->address_strings[RPC_DISPLAY_ADDR],
2884 xprt->address_strings[RPC_DISPLAY_PROTO]);
2886 if (try_module_get(THIS_MODULE))
2888 ret = ERR_PTR(-EINVAL);
2894 static const struct rpc_timeout xs_tcp_default_timeout = {
2895 .to_initval = 60 * HZ,
2896 .to_maxval = 60 * HZ,
2901 * xs_setup_tcp - Set up transport to use a TCP socket
2902 * @args: rpc transport creation arguments
2905 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2907 struct sockaddr *addr = args->dstaddr;
2908 struct rpc_xprt *xprt;
2909 struct sock_xprt *transport;
2910 struct rpc_xprt *ret;
2911 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
2913 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
2914 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
2916 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2917 max_slot_table_size);
2920 transport = container_of(xprt, struct sock_xprt, xprt);
2922 xprt->prot = IPPROTO_TCP;
2923 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2924 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2926 xprt->bind_timeout = XS_BIND_TO;
2927 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2928 xprt->idle_timeout = XS_IDLE_DISC_TO;
2930 xprt->ops = &xs_tcp_ops;
2931 xprt->timeout = &xs_tcp_default_timeout;
2933 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
2934 xprt->connect_timeout = xprt->timeout->to_initval *
2935 (xprt->timeout->to_retries + 1);
2937 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn);
2938 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
2940 switch (addr->sa_family) {
2942 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2943 xprt_set_bound(xprt);
2945 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2948 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2949 xprt_set_bound(xprt);
2951 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2954 ret = ERR_PTR(-EAFNOSUPPORT);
2958 if (xprt_bound(xprt))
2959 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2960 xprt->address_strings[RPC_DISPLAY_ADDR],
2961 xprt->address_strings[RPC_DISPLAY_PORT],
2962 xprt->address_strings[RPC_DISPLAY_PROTO]);
2964 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2965 xprt->address_strings[RPC_DISPLAY_ADDR],
2966 xprt->address_strings[RPC_DISPLAY_PROTO]);
2968 if (try_module_get(THIS_MODULE))
2970 ret = ERR_PTR(-EINVAL);
2977 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
2978 * @args: rpc transport creation arguments
2981 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
2983 struct sockaddr *addr = args->dstaddr;
2984 struct rpc_xprt *xprt;
2985 struct sock_xprt *transport;
2986 struct svc_sock *bc_sock;
2987 struct rpc_xprt *ret;
2989 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2990 xprt_tcp_slot_table_entries);
2993 transport = container_of(xprt, struct sock_xprt, xprt);
2995 xprt->prot = IPPROTO_TCP;
2996 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2997 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2998 xprt->timeout = &xs_tcp_default_timeout;
3001 xprt_set_bound(xprt);
3002 xprt->bind_timeout = 0;
3003 xprt->reestablish_timeout = 0;
3004 xprt->idle_timeout = 0;
3006 xprt->ops = &bc_tcp_ops;
3008 switch (addr->sa_family) {
3010 xs_format_peer_addresses(xprt, "tcp",
3014 xs_format_peer_addresses(xprt, "tcp",
3015 RPCBIND_NETID_TCP6);
3018 ret = ERR_PTR(-EAFNOSUPPORT);
3022 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3023 xprt->address_strings[RPC_DISPLAY_ADDR],
3024 xprt->address_strings[RPC_DISPLAY_PORT],
3025 xprt->address_strings[RPC_DISPLAY_PROTO]);
3028 * Once we've associated a backchannel xprt with a connection,
3029 * we want to keep it around as long as the connection lasts,
3030 * in case we need to start using it for a backchannel again;
3031 * this reference won't be dropped until bc_xprt is destroyed.
3034 args->bc_xprt->xpt_bc_xprt = xprt;
3035 xprt->bc_xprt = args->bc_xprt;
3036 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3037 transport->sock = bc_sock->sk_sock;
3038 transport->inet = bc_sock->sk_sk;
3041 * Since we don't want connections for the backchannel, we set
3042 * the xprt status to connected
3044 xprt_set_connected(xprt);
3046 if (try_module_get(THIS_MODULE))
3049 args->bc_xprt->xpt_bc_xprt = NULL;
3050 args->bc_xprt->xpt_bc_xps = NULL;
3052 ret = ERR_PTR(-EINVAL);
3058 static struct xprt_class xs_local_transport = {
3059 .list = LIST_HEAD_INIT(xs_local_transport.list),
3060 .name = "named UNIX socket",
3061 .owner = THIS_MODULE,
3062 .ident = XPRT_TRANSPORT_LOCAL,
3063 .setup = xs_setup_local,
3066 static struct xprt_class xs_udp_transport = {
3067 .list = LIST_HEAD_INIT(xs_udp_transport.list),
3069 .owner = THIS_MODULE,
3070 .ident = XPRT_TRANSPORT_UDP,
3071 .setup = xs_setup_udp,
3074 static struct xprt_class xs_tcp_transport = {
3075 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
3077 .owner = THIS_MODULE,
3078 .ident = XPRT_TRANSPORT_TCP,
3079 .setup = xs_setup_tcp,
3082 static struct xprt_class xs_bc_tcp_transport = {
3083 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3084 .name = "tcp NFSv4.1 backchannel",
3085 .owner = THIS_MODULE,
3086 .ident = XPRT_TRANSPORT_BC_TCP,
3087 .setup = xs_setup_bc_tcp,
3091 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3094 int init_socket_xprt(void)
3096 if (!sunrpc_table_header)
3097 sunrpc_table_header = register_sysctl_table(sunrpc_table);
3099 xprt_register_transport(&xs_local_transport);
3100 xprt_register_transport(&xs_udp_transport);
3101 xprt_register_transport(&xs_tcp_transport);
3102 xprt_register_transport(&xs_bc_tcp_transport);
3108 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3111 void cleanup_socket_xprt(void)
3113 if (sunrpc_table_header) {
3114 unregister_sysctl_table(sunrpc_table_header);
3115 sunrpc_table_header = NULL;
3118 xprt_unregister_transport(&xs_local_transport);
3119 xprt_unregister_transport(&xs_udp_transport);
3120 xprt_unregister_transport(&xs_tcp_transport);
3121 xprt_unregister_transport(&xs_bc_tcp_transport);
3124 static int param_set_uint_minmax(const char *val,
3125 const struct kernel_param *kp,
3126 unsigned int min, unsigned int max)
3133 ret = kstrtouint(val, 0, &num);
3136 if (num < min || num > max)
3138 *((unsigned int *)kp->arg) = num;
3142 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3144 return param_set_uint_minmax(val, kp,
3149 static const struct kernel_param_ops param_ops_portnr = {
3150 .set = param_set_portnr,
3151 .get = param_get_uint,
3154 #define param_check_portnr(name, p) \
3155 __param_check(name, p, unsigned int);
3157 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3158 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3160 static int param_set_slot_table_size(const char *val,
3161 const struct kernel_param *kp)
3163 return param_set_uint_minmax(val, kp,
3165 RPC_MAX_SLOT_TABLE);
3168 static const struct kernel_param_ops param_ops_slot_table_size = {
3169 .set = param_set_slot_table_size,
3170 .get = param_get_uint,
3173 #define param_check_slot_table_size(name, p) \
3174 __param_check(name, p, unsigned int);
3176 static int param_set_max_slot_table_size(const char *val,
3177 const struct kernel_param *kp)
3179 return param_set_uint_minmax(val, kp,
3181 RPC_MAX_SLOT_TABLE_LIMIT);
3184 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3185 .set = param_set_max_slot_table_size,
3186 .get = param_get_uint,
3189 #define param_check_max_slot_table_size(name, p) \
3190 __param_check(name, p, unsigned int);
3192 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3193 slot_table_size, 0644);
3194 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3195 max_slot_table_size, 0644);
3196 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3197 slot_table_size, 0644);