1 // SPDX-License-Identifier: GPL-2.0
3 * linux/net/sunrpc/xprtsock.c
5 * Client-side transport implementation for sockets.
7 * TCP callback races fixes (C) 1998 Red Hat
8 * TCP send fixes (C) 1998 Red Hat
9 * TCP NFS related read + write fixes
10 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
12 * Rewrite of larges part of the code in order to stabilize TCP stuff.
13 * Fix behaviour when socket buffer is full.
14 * (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no>
16 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
18 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
19 * <gilles.quillard@bull.net>
22 #include <linux/types.h>
23 #include <linux/string.h>
24 #include <linux/slab.h>
25 #include <linux/module.h>
26 #include <linux/capability.h>
27 #include <linux/pagemap.h>
28 #include <linux/errno.h>
29 #include <linux/socket.h>
31 #include <linux/net.h>
34 #include <linux/udp.h>
35 #include <linux/tcp.h>
36 #include <linux/sunrpc/clnt.h>
37 #include <linux/sunrpc/addr.h>
38 #include <linux/sunrpc/sched.h>
39 #include <linux/sunrpc/svcsock.h>
40 #include <linux/sunrpc/xprtsock.h>
41 #include <linux/file.h>
42 #ifdef CONFIG_SUNRPC_BACKCHANNEL
43 #include <linux/sunrpc/bc_xprt.h>
47 #include <net/checksum.h>
51 #include <trace/events/sunrpc.h>
55 #define RPC_TCP_READ_CHUNK_SZ (3*512*1024)
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 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
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
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,
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
165 * Wait duration for a reply from the RPC portmapper.
167 #define XS_BIND_TO (60U * HZ)
170 * Delay if a UDP socket connect error occurs. This is most likely some
171 * kind of resource problem on the local host.
173 #define XS_UDP_REEST_TO (2U * HZ)
176 * The reestablish timeout allows clients to delay for a bit before attempting
177 * to reconnect to a server that just dropped our connection.
179 * We implement an exponential backoff when trying to reestablish a TCP
180 * transport connection with the server. Some servers like to drop a TCP
181 * connection when they are overworked, so we start with a short timeout and
182 * increase over time if the server is down or not responding.
184 #define XS_TCP_INIT_REEST_TO (3U * HZ)
187 * TCP idle timeout; client drops the transport socket if it is idle
188 * for this long. Note that we also timeout UDP sockets to prevent
189 * holding port numbers when there is no RPC traffic.
191 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
193 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
194 # undef RPC_DEBUG_DATA
195 # define RPCDBG_FACILITY RPCDBG_TRANS
198 #ifdef RPC_DEBUG_DATA
199 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
201 u8 *buf = (u8 *) packet;
204 dprintk("RPC: %s\n", msg);
205 for (j = 0; j < count && j < 128; j += 4) {
209 dprintk("0x%04x ", j);
211 dprintk("%02x%02x%02x%02x ",
212 buf[j], buf[j+1], buf[j+2], buf[j+3]);
217 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
223 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
225 return (struct rpc_xprt *) sk->sk_user_data;
228 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
230 return (struct sockaddr *) &xprt->addr;
233 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
235 return (struct sockaddr_un *) &xprt->addr;
238 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
240 return (struct sockaddr_in *) &xprt->addr;
243 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
245 return (struct sockaddr_in6 *) &xprt->addr;
248 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
250 struct sockaddr *sap = xs_addr(xprt);
251 struct sockaddr_in6 *sin6;
252 struct sockaddr_in *sin;
253 struct sockaddr_un *sun;
256 switch (sap->sa_family) {
258 sun = xs_addr_un(xprt);
259 strlcpy(buf, sun->sun_path, sizeof(buf));
260 xprt->address_strings[RPC_DISPLAY_ADDR] =
261 kstrdup(buf, GFP_KERNEL);
264 (void)rpc_ntop(sap, buf, sizeof(buf));
265 xprt->address_strings[RPC_DISPLAY_ADDR] =
266 kstrdup(buf, GFP_KERNEL);
267 sin = xs_addr_in(xprt);
268 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
271 (void)rpc_ntop(sap, buf, sizeof(buf));
272 xprt->address_strings[RPC_DISPLAY_ADDR] =
273 kstrdup(buf, GFP_KERNEL);
274 sin6 = xs_addr_in6(xprt);
275 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
281 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
284 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
286 struct sockaddr *sap = xs_addr(xprt);
289 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
290 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
292 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
293 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
296 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
297 const char *protocol,
300 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
301 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
302 xs_format_common_peer_addresses(xprt);
303 xs_format_common_peer_ports(xprt);
306 static void xs_update_peer_port(struct rpc_xprt *xprt)
308 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
309 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
311 xs_format_common_peer_ports(xprt);
314 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
318 for (i = 0; i < RPC_DISPLAY_MAX; i++)
320 case RPC_DISPLAY_PROTO:
321 case RPC_DISPLAY_NETID:
324 kfree(xprt->address_strings[i]);
328 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
330 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
332 struct msghdr msg = {
334 .msg_namelen = addrlen,
335 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
338 .iov_base = vec->iov_base + base,
339 .iov_len = vec->iov_len - base,
342 if (iov.iov_len != 0)
343 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
344 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
347 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more, bool zerocopy, int *sent_p)
349 ssize_t (*do_sendpage)(struct socket *sock, struct page *page,
350 int offset, size_t size, int flags);
352 unsigned int remainder;
355 remainder = xdr->page_len - base;
356 base += xdr->page_base;
357 ppage = xdr->pages + (base >> PAGE_SHIFT);
359 do_sendpage = sock->ops->sendpage;
361 do_sendpage = sock_no_sendpage;
363 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
364 int flags = XS_SENDMSG_FLAGS;
370 flags |= MSG_SENDPAGE_NOTLAST | MSG_MORE;
371 err = do_sendpage(sock, *ppage, base, len, flags);
372 if (remainder == 0 || err != len)
386 * xs_sendpages - write pages directly to a socket
387 * @sock: socket to send on
388 * @addr: UDP only -- address of destination
389 * @addrlen: UDP only -- length of destination address
390 * @xdr: buffer containing this request
391 * @base: starting position in the buffer
392 * @zerocopy: true if it is safe to use sendpage()
393 * @sent_p: return the total number of bytes successfully queued for sending
396 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base, bool zerocopy, int *sent_p)
398 unsigned int remainder = xdr->len - base;
410 if (base < xdr->head[0].iov_len || addr != NULL) {
411 unsigned int len = xdr->head[0].iov_len - base;
413 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
414 if (remainder == 0 || err != len)
419 base -= xdr->head[0].iov_len;
421 if (base < xdr->page_len) {
422 unsigned int len = xdr->page_len - base;
424 err = xs_send_pagedata(sock, xdr, base, remainder != 0, zerocopy, &sent);
426 if (remainder == 0 || sent != len)
430 base -= xdr->page_len;
432 if (base >= xdr->tail[0].iov_len)
434 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
443 static void xs_nospace_callback(struct rpc_task *task)
445 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
447 transport->inet->sk_write_pending--;
451 * xs_nospace - place task on wait queue if transmit was incomplete
452 * @task: task to put to sleep
455 static int xs_nospace(struct rpc_task *task)
457 struct rpc_rqst *req = task->tk_rqstp;
458 struct rpc_xprt *xprt = req->rq_xprt;
459 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
460 struct sock *sk = transport->inet;
463 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
464 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
467 /* Protect against races with write_space */
468 spin_lock_bh(&xprt->transport_lock);
470 /* Don't race with disconnect */
471 if (xprt_connected(xprt)) {
472 /* wait for more buffer space */
473 sk->sk_write_pending++;
474 xprt_wait_for_buffer_space(task, xs_nospace_callback);
478 spin_unlock_bh(&xprt->transport_lock);
480 /* Race breaker in case memory is freed before above code is called */
481 if (ret == -EAGAIN) {
482 struct socket_wq *wq;
485 wq = rcu_dereference(sk->sk_wq);
486 set_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags);
489 sk->sk_write_space(sk);
495 * Construct a stream transport record marker in @buf.
497 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf)
499 u32 reclen = buf->len - sizeof(rpc_fraghdr);
500 rpc_fraghdr *base = buf->head[0].iov_base;
501 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen);
505 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
506 * @task: RPC task that manages the state of an RPC request
509 * 0: The request has been sent
510 * EAGAIN: The socket was blocked, please call again later to
511 * complete the request
512 * ENOTCONN: Caller needs to invoke connect logic then call again
513 * other: Some other error occured, the request was not sent
515 static int xs_local_send_request(struct rpc_task *task)
517 struct rpc_rqst *req = task->tk_rqstp;
518 struct rpc_xprt *xprt = req->rq_xprt;
519 struct sock_xprt *transport =
520 container_of(xprt, struct sock_xprt, xprt);
521 struct xdr_buf *xdr = &req->rq_snd_buf;
525 xs_encode_stream_record_marker(&req->rq_snd_buf);
527 xs_pktdump("packet data:",
528 req->rq_svec->iov_base, req->rq_svec->iov_len);
530 status = xs_sendpages(transport->sock, NULL, 0, xdr, req->rq_bytes_sent,
532 dprintk("RPC: %s(%u) = %d\n",
533 __func__, xdr->len - req->rq_bytes_sent, status);
535 if (status == -EAGAIN && sock_writeable(transport->inet))
538 if (likely(sent > 0) || status == 0) {
539 req->rq_bytes_sent += sent;
540 req->rq_xmit_bytes_sent += sent;
541 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
542 req->rq_bytes_sent = 0;
552 status = xs_nospace(task);
555 dprintk("RPC: sendmsg returned unrecognized error %d\n",
567 * xs_udp_send_request - write an RPC request to a UDP socket
568 * @task: address of RPC task that manages the state of an RPC request
571 * 0: The request has been sent
572 * EAGAIN: The socket was blocked, please call again later to
573 * complete the request
574 * ENOTCONN: Caller needs to invoke connect logic then call again
575 * other: Some other error occurred, the request was not sent
577 static int xs_udp_send_request(struct rpc_task *task)
579 struct rpc_rqst *req = task->tk_rqstp;
580 struct rpc_xprt *xprt = req->rq_xprt;
581 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
582 struct xdr_buf *xdr = &req->rq_snd_buf;
586 xs_pktdump("packet data:",
587 req->rq_svec->iov_base,
588 req->rq_svec->iov_len);
590 if (!xprt_bound(xprt))
592 status = xs_sendpages(transport->sock, xs_addr(xprt), xprt->addrlen,
593 xdr, req->rq_bytes_sent, true, &sent);
595 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
596 xdr->len - req->rq_bytes_sent, status);
598 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
599 if (status == -EPERM)
602 if (status == -EAGAIN && sock_writeable(transport->inet))
605 if (sent > 0 || status == 0) {
606 req->rq_xmit_bytes_sent += sent;
607 if (sent >= req->rq_slen)
609 /* Still some bytes left; set up for a retry later. */
617 /* Should we call xs_close() here? */
620 status = xs_nospace(task);
627 /* When the server has died, an ICMP port unreachable message
628 * prompts ECONNREFUSED. */
631 dprintk("RPC: sendmsg returned unrecognized error %d\n",
639 * xs_tcp_send_request - write an RPC request to a TCP socket
640 * @task: address of RPC task that manages the state of an RPC request
643 * 0: The request has been sent
644 * EAGAIN: The socket was blocked, please call again later to
645 * complete the request
646 * ENOTCONN: Caller needs to invoke connect logic then call again
647 * other: Some other error occurred, the request was not sent
649 * XXX: In the case of soft timeouts, should we eventually give up
650 * if sendmsg is not able to make progress?
652 static int xs_tcp_send_request(struct rpc_task *task)
654 struct rpc_rqst *req = task->tk_rqstp;
655 struct rpc_xprt *xprt = req->rq_xprt;
656 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
657 struct xdr_buf *xdr = &req->rq_snd_buf;
658 bool zerocopy = true;
659 bool vm_wait = false;
663 xs_encode_stream_record_marker(&req->rq_snd_buf);
665 xs_pktdump("packet data:",
666 req->rq_svec->iov_base,
667 req->rq_svec->iov_len);
668 /* Don't use zero copy if this is a resend. If the RPC call
669 * completes while the socket holds a reference to the pages,
670 * then we may end up resending corrupted data.
672 if (task->tk_flags & RPC_TASK_SENT)
675 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state))
676 xs_tcp_set_socket_timeouts(xprt, transport->sock);
678 /* Continue transmitting the packet/record. We must be careful
679 * to cope with writespace callbacks arriving _after_ we have
680 * called sendmsg(). */
683 status = xs_sendpages(transport->sock, NULL, 0, xdr,
684 req->rq_bytes_sent, zerocopy, &sent);
686 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
687 xdr->len - req->rq_bytes_sent, status);
689 /* If we've sent the entire packet, immediately
690 * reset the count of bytes sent. */
691 req->rq_bytes_sent += sent;
692 req->rq_xmit_bytes_sent += sent;
693 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
694 req->rq_bytes_sent = 0;
698 WARN_ON_ONCE(sent == 0 && status == 0);
700 if (status == -EAGAIN ) {
702 * Return EAGAIN if we're sure we're hitting the
703 * socket send buffer limits.
705 if (test_bit(SOCK_NOSPACE, &transport->sock->flags))
708 * Did we hit a memory allocation failure?
714 /* Retry, knowing now that we're below the
715 * socket send buffer limit
729 /* Should we call xs_close() here? */
732 status = xs_nospace(task);
742 dprintk("RPC: sendmsg returned unrecognized error %d\n",
750 * xs_tcp_release_xprt - clean up after a tcp transmission
754 * This cleans up if an error causes us to abort the transmission of a request.
755 * In this case, the socket may need to be reset in order to avoid confusing
758 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
760 struct rpc_rqst *req;
762 if (task != xprt->snd_task)
766 req = task->tk_rqstp;
769 if (req->rq_bytes_sent == 0)
771 if (req->rq_bytes_sent == req->rq_snd_buf.len)
773 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
775 xprt_release_xprt(xprt, task);
778 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
780 transport->old_data_ready = sk->sk_data_ready;
781 transport->old_state_change = sk->sk_state_change;
782 transport->old_write_space = sk->sk_write_space;
783 transport->old_error_report = sk->sk_error_report;
786 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
788 sk->sk_data_ready = transport->old_data_ready;
789 sk->sk_state_change = transport->old_state_change;
790 sk->sk_write_space = transport->old_write_space;
791 sk->sk_error_report = transport->old_error_report;
794 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt)
796 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
798 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
801 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
803 smp_mb__before_atomic();
804 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
805 clear_bit(XPRT_CLOSING, &xprt->state);
806 xs_sock_reset_state_flags(xprt);
807 smp_mb__after_atomic();
810 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
812 xs_sock_reset_connection_flags(xprt);
813 /* Mark transport as closed and wake up all pending tasks */
814 xprt_disconnect_done(xprt);
818 * xs_error_report - callback to handle TCP socket state errors
821 * Note: we don't call sock_error() since there may be a rpc_task
822 * using the socket, and so we don't want to clear sk->sk_err.
824 static void xs_error_report(struct sock *sk)
826 struct rpc_xprt *xprt;
829 read_lock_bh(&sk->sk_callback_lock);
830 if (!(xprt = xprt_from_sock(sk)))
836 /* Is this a reset event? */
837 if (sk->sk_state == TCP_CLOSE)
838 xs_sock_mark_closed(xprt);
839 dprintk("RPC: xs_error_report client %p, error=%d...\n",
841 trace_rpc_socket_error(xprt, sk->sk_socket, err);
842 xprt_wake_pending_tasks(xprt, err);
844 read_unlock_bh(&sk->sk_callback_lock);
847 static void xs_reset_transport(struct sock_xprt *transport)
849 struct socket *sock = transport->sock;
850 struct sock *sk = transport->inet;
851 struct rpc_xprt *xprt = &transport->xprt;
856 if (atomic_read(&transport->xprt.swapper))
857 sk_clear_memalloc(sk);
859 kernel_sock_shutdown(sock, SHUT_RDWR);
861 mutex_lock(&transport->recv_mutex);
862 write_lock_bh(&sk->sk_callback_lock);
863 transport->inet = NULL;
864 transport->sock = NULL;
866 sk->sk_user_data = NULL;
868 xs_restore_old_callbacks(transport, sk);
869 xprt_clear_connected(xprt);
870 write_unlock_bh(&sk->sk_callback_lock);
871 xs_sock_reset_connection_flags(xprt);
872 mutex_unlock(&transport->recv_mutex);
874 trace_rpc_socket_close(xprt, sock);
879 * xs_close - close a socket
882 * This is used when all requests are complete; ie, no DRC state remains
883 * on the server we want to save.
885 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
886 * xs_reset_transport() zeroing the socket from underneath a writer.
888 static void xs_close(struct rpc_xprt *xprt)
890 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
892 dprintk("RPC: xs_close xprt %p\n", xprt);
894 xs_reset_transport(transport);
895 xprt->reestablish_timeout = 0;
897 xprt_disconnect_done(xprt);
900 static void xs_inject_disconnect(struct rpc_xprt *xprt)
902 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
904 xprt_disconnect_done(xprt);
907 static void xs_xprt_free(struct rpc_xprt *xprt)
909 xs_free_peer_addresses(xprt);
914 * xs_destroy - prepare to shutdown a transport
915 * @xprt: doomed transport
918 static void xs_destroy(struct rpc_xprt *xprt)
920 struct sock_xprt *transport = container_of(xprt,
921 struct sock_xprt, xprt);
922 dprintk("RPC: xs_destroy xprt %p\n", xprt);
924 cancel_delayed_work_sync(&transport->connect_worker);
926 cancel_work_sync(&transport->recv_worker);
928 module_put(THIS_MODULE);
931 static int xs_local_copy_to_xdr(struct xdr_buf *xdr, struct sk_buff *skb)
933 struct xdr_skb_reader desc = {
935 .offset = sizeof(rpc_fraghdr),
936 .count = skb->len - sizeof(rpc_fraghdr),
939 if (xdr_partial_copy_from_skb(xdr, 0, &desc, xdr_skb_read_bits) < 0)
947 * xs_local_data_read_skb
952 * Currently this assumes we can read the whole reply in a single gulp.
954 static void xs_local_data_read_skb(struct rpc_xprt *xprt,
958 struct rpc_task *task;
959 struct rpc_rqst *rovr;
964 repsize = skb->len - sizeof(rpc_fraghdr);
966 dprintk("RPC: impossible RPC reply size %d\n", repsize);
970 /* Copy the XID from the skb... */
971 xp = skb_header_pointer(skb, sizeof(rpc_fraghdr), sizeof(_xid), &_xid);
975 /* Look up and lock the request corresponding to the given XID */
976 spin_lock(&xprt->recv_lock);
977 rovr = xprt_lookup_rqst(xprt, *xp);
981 spin_unlock(&xprt->recv_lock);
982 task = rovr->rq_task;
984 copied = rovr->rq_private_buf.buflen;
985 if (copied > repsize)
988 if (xs_local_copy_to_xdr(&rovr->rq_private_buf, skb)) {
989 dprintk("RPC: sk_buff copy failed\n");
990 spin_lock(&xprt->recv_lock);
994 spin_lock(&xprt->recv_lock);
995 xprt_complete_rqst(task, copied);
997 xprt_unpin_rqst(rovr);
999 spin_unlock(&xprt->recv_lock);
1002 static void xs_local_data_receive(struct sock_xprt *transport)
1004 struct sk_buff *skb;
1009 mutex_lock(&transport->recv_mutex);
1010 sk = transport->inet;
1014 skb = skb_recv_datagram(sk, 0, 1, &err);
1016 xs_local_data_read_skb(&transport->xprt, sk, skb);
1017 skb_free_datagram(sk, skb);
1020 if (!test_and_clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1022 if (need_resched()) {
1023 mutex_unlock(&transport->recv_mutex);
1029 mutex_unlock(&transport->recv_mutex);
1032 static void xs_local_data_receive_workfn(struct work_struct *work)
1034 struct sock_xprt *transport =
1035 container_of(work, struct sock_xprt, recv_worker);
1036 xs_local_data_receive(transport);
1040 * xs_udp_data_read_skb - receive callback for UDP sockets
1046 static void xs_udp_data_read_skb(struct rpc_xprt *xprt,
1048 struct sk_buff *skb)
1050 struct rpc_task *task;
1051 struct rpc_rqst *rovr;
1052 int repsize, copied;
1058 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1062 /* Copy the XID from the skb... */
1063 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid);
1067 /* Look up and lock the request corresponding to the given XID */
1068 spin_lock(&xprt->recv_lock);
1069 rovr = xprt_lookup_rqst(xprt, *xp);
1072 xprt_pin_rqst(rovr);
1073 spin_unlock(&xprt->recv_lock);
1074 task = rovr->rq_task;
1076 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1079 /* Suck it into the iovec, verify checksum if not done by hw. */
1080 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1081 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS);
1082 spin_lock(&xprt->recv_lock);
1086 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS);
1088 spin_lock_bh(&xprt->transport_lock);
1089 xprt_adjust_cwnd(xprt, task, copied);
1090 spin_unlock_bh(&xprt->transport_lock);
1091 spin_lock(&xprt->recv_lock);
1092 xprt_complete_rqst(task, copied);
1094 xprt_unpin_rqst(rovr);
1096 spin_unlock(&xprt->recv_lock);
1099 static void xs_udp_data_receive(struct sock_xprt *transport)
1101 struct sk_buff *skb;
1106 mutex_lock(&transport->recv_mutex);
1107 sk = transport->inet;
1111 skb = skb_recv_udp(sk, 0, 1, &err);
1113 xs_udp_data_read_skb(&transport->xprt, sk, skb);
1117 if (!test_and_clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1119 if (need_resched()) {
1120 mutex_unlock(&transport->recv_mutex);
1126 mutex_unlock(&transport->recv_mutex);
1129 static void xs_udp_data_receive_workfn(struct work_struct *work)
1131 struct sock_xprt *transport =
1132 container_of(work, struct sock_xprt, recv_worker);
1133 xs_udp_data_receive(transport);
1137 * xs_data_ready - "data ready" callback for UDP sockets
1138 * @sk: socket with data to read
1141 static void xs_data_ready(struct sock *sk)
1143 struct rpc_xprt *xprt;
1145 read_lock_bh(&sk->sk_callback_lock);
1146 dprintk("RPC: xs_data_ready...\n");
1147 xprt = xprt_from_sock(sk);
1149 struct sock_xprt *transport = container_of(xprt,
1150 struct sock_xprt, xprt);
1151 transport->old_data_ready(sk);
1152 /* Any data means we had a useful conversation, so
1153 * then we don't need to delay the next reconnect
1155 if (xprt->reestablish_timeout)
1156 xprt->reestablish_timeout = 0;
1157 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1158 queue_work(xprtiod_workqueue, &transport->recv_worker);
1160 read_unlock_bh(&sk->sk_callback_lock);
1164 * Helper function to force a TCP close if the server is sending
1165 * junk and/or it has put us in CLOSE_WAIT
1167 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1169 xprt_force_disconnect(xprt);
1172 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
1174 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1178 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
1179 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
1180 used = xdr_skb_read_bits(desc, p, len);
1181 transport->tcp_offset += used;
1185 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
1186 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
1187 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
1189 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
1190 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
1192 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
1193 transport->tcp_offset = 0;
1195 /* Sanity check of the record length */
1196 if (unlikely(transport->tcp_reclen < 8)) {
1197 dprintk("RPC: invalid TCP record fragment length\n");
1198 xs_tcp_force_close(xprt);
1201 dprintk("RPC: reading TCP record fragment of length %d\n",
1202 transport->tcp_reclen);
1205 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
1207 if (transport->tcp_offset == transport->tcp_reclen) {
1208 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
1209 transport->tcp_offset = 0;
1210 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
1211 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1212 transport->tcp_flags |= TCP_RCV_COPY_XID;
1213 transport->tcp_copied = 0;
1218 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1223 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
1224 dprintk("RPC: reading XID (%zu bytes)\n", len);
1225 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
1226 used = xdr_skb_read_bits(desc, p, len);
1227 transport->tcp_offset += used;
1230 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
1231 transport->tcp_flags |= TCP_RCV_READ_CALLDIR;
1232 transport->tcp_copied = 4;
1233 dprintk("RPC: reading %s XID %08x\n",
1234 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
1236 ntohl(transport->tcp_xid));
1237 xs_tcp_check_fraghdr(transport);
1240 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
1241 struct xdr_skb_reader *desc)
1248 * We want transport->tcp_offset to be 8 at the end of this routine
1249 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1250 * When this function is called for the first time,
1251 * transport->tcp_offset is 4 (after having already read the xid).
1253 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
1254 len = sizeof(transport->tcp_calldir) - offset;
1255 dprintk("RPC: reading CALL/REPLY flag (%zu bytes)\n", len);
1256 p = ((char *) &transport->tcp_calldir) + offset;
1257 used = xdr_skb_read_bits(desc, p, len);
1258 transport->tcp_offset += used;
1261 transport->tcp_flags &= ~TCP_RCV_READ_CALLDIR;
1263 * We don't yet have the XDR buffer, so we will write the calldir
1264 * out after we get the buffer from the 'struct rpc_rqst'
1266 switch (ntohl(transport->tcp_calldir)) {
1268 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1269 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1270 transport->tcp_flags |= TCP_RPC_REPLY;
1273 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1274 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1275 transport->tcp_flags &= ~TCP_RPC_REPLY;
1278 dprintk("RPC: invalid request message type\n");
1279 xs_tcp_force_close(&transport->xprt);
1281 xs_tcp_check_fraghdr(transport);
1284 static inline void xs_tcp_read_common(struct rpc_xprt *xprt,
1285 struct xdr_skb_reader *desc,
1286 struct rpc_rqst *req)
1288 struct sock_xprt *transport =
1289 container_of(xprt, struct sock_xprt, xprt);
1290 struct xdr_buf *rcvbuf;
1294 rcvbuf = &req->rq_private_buf;
1296 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
1298 * Save the RPC direction in the XDR buffer
1300 memcpy(rcvbuf->head[0].iov_base + transport->tcp_copied,
1301 &transport->tcp_calldir,
1302 sizeof(transport->tcp_calldir));
1303 transport->tcp_copied += sizeof(transport->tcp_calldir);
1304 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
1308 if (len > transport->tcp_reclen - transport->tcp_offset)
1309 desc->count = transport->tcp_reclen - transport->tcp_offset;
1310 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1311 desc, xdr_skb_read_bits);
1314 /* Error when copying to the receive buffer,
1315 * usually because we weren't able to allocate
1316 * additional buffer pages. All we can do now
1317 * is turn off TCP_RCV_COPY_DATA, so the request
1318 * will not receive any additional updates,
1320 * Any remaining data from this record will
1323 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1324 dprintk("RPC: XID %08x truncated request\n",
1325 ntohl(transport->tcp_xid));
1326 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1327 "tcp_offset = %u, tcp_reclen = %u\n",
1328 xprt, transport->tcp_copied,
1329 transport->tcp_offset, transport->tcp_reclen);
1333 transport->tcp_copied += r;
1334 transport->tcp_offset += r;
1335 desc->count = len - r;
1337 dprintk("RPC: XID %08x read %zd bytes\n",
1338 ntohl(transport->tcp_xid), r);
1339 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1340 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1341 transport->tcp_offset, transport->tcp_reclen);
1343 if (transport->tcp_copied == req->rq_private_buf.buflen)
1344 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1345 else if (transport->tcp_offset == transport->tcp_reclen) {
1346 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1347 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1352 * Finds the request corresponding to the RPC xid and invokes the common
1353 * tcp read code to read the data.
1355 static inline int xs_tcp_read_reply(struct rpc_xprt *xprt,
1356 struct xdr_skb_reader *desc)
1358 struct sock_xprt *transport =
1359 container_of(xprt, struct sock_xprt, xprt);
1360 struct rpc_rqst *req;
1362 dprintk("RPC: read reply XID %08x\n", ntohl(transport->tcp_xid));
1364 /* Find and lock the request corresponding to this xid */
1365 spin_lock(&xprt->recv_lock);
1366 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1368 dprintk("RPC: XID %08x request not found!\n",
1369 ntohl(transport->tcp_xid));
1370 spin_unlock(&xprt->recv_lock);
1374 spin_unlock(&xprt->recv_lock);
1376 xs_tcp_read_common(xprt, desc, req);
1378 spin_lock(&xprt->recv_lock);
1379 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1380 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1381 xprt_unpin_rqst(req);
1382 spin_unlock(&xprt->recv_lock);
1386 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1388 * Obtains an rpc_rqst previously allocated and invokes the common
1389 * tcp read code to read the data. The result is placed in the callback
1391 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1392 * connection and return -1.
1394 static int xs_tcp_read_callback(struct rpc_xprt *xprt,
1395 struct xdr_skb_reader *desc)
1397 struct sock_xprt *transport =
1398 container_of(xprt, struct sock_xprt, xprt);
1399 struct rpc_rqst *req;
1401 /* Look up the request corresponding to the given XID */
1402 req = xprt_lookup_bc_request(xprt, transport->tcp_xid);
1404 printk(KERN_WARNING "Callback slot table overflowed\n");
1405 xprt_force_disconnect(xprt);
1409 dprintk("RPC: read callback XID %08x\n", ntohl(req->rq_xid));
1410 xs_tcp_read_common(xprt, desc, req);
1412 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1413 xprt_complete_bc_request(req, transport->tcp_copied);
1418 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1419 struct xdr_skb_reader *desc)
1421 struct sock_xprt *transport =
1422 container_of(xprt, struct sock_xprt, xprt);
1424 return (transport->tcp_flags & TCP_RPC_REPLY) ?
1425 xs_tcp_read_reply(xprt, desc) :
1426 xs_tcp_read_callback(xprt, desc);
1429 static int xs_tcp_bc_up(struct svc_serv *serv, struct net *net)
1433 ret = svc_create_xprt(serv, "tcp-bc", net, PF_INET, 0,
1434 SVC_SOCK_ANONYMOUS);
1440 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt)
1445 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1446 struct xdr_skb_reader *desc)
1448 return xs_tcp_read_reply(xprt, desc);
1450 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1453 * Read data off the transport. This can be either an RPC_CALL or an
1454 * RPC_REPLY. Relay the processing to helper functions.
1456 static void xs_tcp_read_data(struct rpc_xprt *xprt,
1457 struct xdr_skb_reader *desc)
1459 struct sock_xprt *transport =
1460 container_of(xprt, struct sock_xprt, xprt);
1462 if (_xs_tcp_read_data(xprt, desc) == 0)
1463 xs_tcp_check_fraghdr(transport);
1466 * The transport_lock protects the request handling.
1467 * There's no need to hold it to update the tcp_flags.
1469 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1473 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1477 len = transport->tcp_reclen - transport->tcp_offset;
1478 if (len > desc->count)
1481 desc->offset += len;
1482 transport->tcp_offset += len;
1483 dprintk("RPC: discarded %zu bytes\n", len);
1484 xs_tcp_check_fraghdr(transport);
1487 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1489 struct rpc_xprt *xprt = rd_desc->arg.data;
1490 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1491 struct xdr_skb_reader desc = {
1498 dprintk("RPC: xs_tcp_data_recv started\n");
1500 trace_xs_tcp_data_recv(transport);
1501 /* Read in a new fragment marker if necessary */
1502 /* Can we ever really expect to get completely empty fragments? */
1503 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1504 xs_tcp_read_fraghdr(xprt, &desc);
1507 /* Read in the xid if necessary */
1508 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1509 xs_tcp_read_xid(transport, &desc);
1512 /* Read in the call/reply flag */
1513 if (transport->tcp_flags & TCP_RCV_READ_CALLDIR) {
1514 xs_tcp_read_calldir(transport, &desc);
1517 /* Read in the request data */
1518 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1519 xs_tcp_read_data(xprt, &desc);
1522 /* Skip over any trailing bytes on short reads */
1523 xs_tcp_read_discard(transport, &desc);
1524 } while (desc.count);
1525 ret = len - desc.count;
1526 if (ret < rd_desc->count)
1527 rd_desc->count -= ret;
1530 trace_xs_tcp_data_recv(transport);
1531 dprintk("RPC: xs_tcp_data_recv done\n");
1535 static void xs_tcp_data_receive(struct sock_xprt *transport)
1537 struct rpc_xprt *xprt = &transport->xprt;
1539 read_descriptor_t rd_desc = {
1542 unsigned long total = 0;
1546 mutex_lock(&transport->recv_mutex);
1547 sk = transport->inet;
1551 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1553 rd_desc.count = RPC_TCP_READ_CHUNK_SZ;
1555 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1556 if (rd_desc.count != 0 || read < 0) {
1557 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state);
1563 if (need_resched()) {
1564 mutex_unlock(&transport->recv_mutex);
1569 if (test_bit(XPRT_SOCK_DATA_READY, &transport->sock_state))
1570 queue_work(xprtiod_workqueue, &transport->recv_worker);
1572 mutex_unlock(&transport->recv_mutex);
1573 trace_xs_tcp_data_ready(xprt, read, total);
1576 static void xs_tcp_data_receive_workfn(struct work_struct *work)
1578 struct sock_xprt *transport =
1579 container_of(work, struct sock_xprt, recv_worker);
1580 xs_tcp_data_receive(transport);
1584 * xs_tcp_state_change - callback to handle TCP socket state changes
1585 * @sk: socket whose state has changed
1588 static void xs_tcp_state_change(struct sock *sk)
1590 struct rpc_xprt *xprt;
1591 struct sock_xprt *transport;
1593 read_lock_bh(&sk->sk_callback_lock);
1594 if (!(xprt = xprt_from_sock(sk)))
1596 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1597 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1598 sk->sk_state, xprt_connected(xprt),
1599 sock_flag(sk, SOCK_DEAD),
1600 sock_flag(sk, SOCK_ZAPPED),
1603 transport = container_of(xprt, struct sock_xprt, xprt);
1604 trace_rpc_socket_state_change(xprt, sk->sk_socket);
1605 switch (sk->sk_state) {
1606 case TCP_ESTABLISHED:
1607 spin_lock(&xprt->transport_lock);
1608 if (!xprt_test_and_set_connected(xprt)) {
1610 /* Reset TCP record info */
1611 transport->tcp_offset = 0;
1612 transport->tcp_reclen = 0;
1613 transport->tcp_copied = 0;
1614 transport->tcp_flags =
1615 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1616 xprt->connect_cookie++;
1617 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
1618 xprt_clear_connecting(xprt);
1620 xprt_wake_pending_tasks(xprt, -EAGAIN);
1622 spin_unlock(&xprt->transport_lock);
1625 /* The client initiated a shutdown of the socket */
1626 xprt->connect_cookie++;
1627 xprt->reestablish_timeout = 0;
1628 set_bit(XPRT_CLOSING, &xprt->state);
1629 smp_mb__before_atomic();
1630 clear_bit(XPRT_CONNECTED, &xprt->state);
1631 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1632 smp_mb__after_atomic();
1634 case TCP_CLOSE_WAIT:
1635 /* The server initiated a shutdown of the socket */
1636 xprt->connect_cookie++;
1637 clear_bit(XPRT_CONNECTED, &xprt->state);
1638 xs_tcp_force_close(xprt);
1642 * If the server closed down the connection, make sure that
1643 * we back off before reconnecting
1645 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1646 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1649 set_bit(XPRT_CLOSING, &xprt->state);
1650 smp_mb__before_atomic();
1651 clear_bit(XPRT_CONNECTED, &xprt->state);
1652 smp_mb__after_atomic();
1655 if (test_and_clear_bit(XPRT_SOCK_CONNECTING,
1656 &transport->sock_state))
1657 xprt_clear_connecting(xprt);
1659 xprt_wake_pending_tasks(xprt, -sk->sk_err);
1660 xs_sock_mark_closed(xprt);
1663 read_unlock_bh(&sk->sk_callback_lock);
1666 static void xs_write_space(struct sock *sk)
1668 struct socket_wq *wq;
1669 struct rpc_xprt *xprt;
1673 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1675 if (unlikely(!(xprt = xprt_from_sock(sk))))
1678 wq = rcu_dereference(sk->sk_wq);
1679 if (!wq || test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags) == 0)
1682 xprt_write_space(xprt);
1688 * xs_udp_write_space - callback invoked when socket buffer space
1690 * @sk: socket whose state has changed
1692 * Called when more output buffer space is available for this socket.
1693 * We try not to wake our writers until they can make "significant"
1694 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1695 * with a bunch of small requests.
1697 static void xs_udp_write_space(struct sock *sk)
1699 read_lock_bh(&sk->sk_callback_lock);
1701 /* from net/core/sock.c:sock_def_write_space */
1702 if (sock_writeable(sk))
1705 read_unlock_bh(&sk->sk_callback_lock);
1709 * xs_tcp_write_space - callback invoked when socket buffer space
1711 * @sk: socket whose state has changed
1713 * Called when more output buffer space is available for this socket.
1714 * We try not to wake our writers until they can make "significant"
1715 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1716 * with a bunch of small requests.
1718 static void xs_tcp_write_space(struct sock *sk)
1720 read_lock_bh(&sk->sk_callback_lock);
1722 /* from net/core/stream.c:sk_stream_write_space */
1723 if (sk_stream_is_writeable(sk))
1726 read_unlock_bh(&sk->sk_callback_lock);
1729 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1731 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1732 struct sock *sk = transport->inet;
1734 if (transport->rcvsize) {
1735 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1736 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1738 if (transport->sndsize) {
1739 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1740 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1741 sk->sk_write_space(sk);
1746 * xs_udp_set_buffer_size - set send and receive limits
1747 * @xprt: generic transport
1748 * @sndsize: requested size of send buffer, in bytes
1749 * @rcvsize: requested size of receive buffer, in bytes
1751 * Set socket send and receive buffer size limits.
1753 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1755 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1757 transport->sndsize = 0;
1759 transport->sndsize = sndsize + 1024;
1760 transport->rcvsize = 0;
1762 transport->rcvsize = rcvsize + 1024;
1764 xs_udp_do_set_buffer_size(xprt);
1768 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1769 * @task: task that timed out
1771 * Adjust the congestion window after a retransmit timeout has occurred.
1773 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1775 spin_lock_bh(&xprt->transport_lock);
1776 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1777 spin_unlock_bh(&xprt->transport_lock);
1780 static unsigned short xs_get_random_port(void)
1782 unsigned short range = xprt_max_resvport - xprt_min_resvport + 1;
1783 unsigned short rand = (unsigned short) prandom_u32() % range;
1784 return rand + xprt_min_resvport;
1788 * xs_set_reuseaddr_port - set the socket's port and address reuse options
1791 * Note that this function has to be called on all sockets that share the
1792 * same port, and it must be called before binding.
1794 static void xs_sock_set_reuseport(struct socket *sock)
1798 kernel_setsockopt(sock, SOL_SOCKET, SO_REUSEPORT,
1799 (char *)&opt, sizeof(opt));
1802 static unsigned short xs_sock_getport(struct socket *sock)
1804 struct sockaddr_storage buf;
1806 unsigned short port = 0;
1808 if (kernel_getsockname(sock, (struct sockaddr *)&buf, &buflen) < 0)
1810 switch (buf.ss_family) {
1812 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port);
1815 port = ntohs(((struct sockaddr_in *)&buf)->sin_port);
1822 * xs_set_port - reset the port number in the remote endpoint address
1823 * @xprt: generic transport
1824 * @port: new port number
1827 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1829 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1831 rpc_set_port(xs_addr(xprt), port);
1832 xs_update_peer_port(xprt);
1835 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock)
1837 if (transport->srcport == 0)
1838 transport->srcport = xs_sock_getport(sock);
1841 static unsigned short xs_get_srcport(struct sock_xprt *transport)
1843 unsigned short port = transport->srcport;
1845 if (port == 0 && transport->xprt.resvport)
1846 port = xs_get_random_port();
1850 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1852 if (transport->srcport != 0)
1853 transport->srcport = 0;
1854 if (!transport->xprt.resvport)
1856 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1857 return xprt_max_resvport;
1860 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1862 struct sockaddr_storage myaddr;
1864 unsigned short port = xs_get_srcport(transport);
1865 unsigned short last;
1868 * If we are asking for any ephemeral port (i.e. port == 0 &&
1869 * transport->xprt.resvport == 0), don't bind. Let the local
1870 * port selection happen implicitly when the socket is used
1871 * (for example at connect time).
1873 * This ensures that we can continue to establish TCP
1874 * connections even when all local ephemeral ports are already
1875 * a part of some TCP connection. This makes no difference
1876 * for UDP sockets, but also doens't harm them.
1878 * If we're asking for any reserved port (i.e. port == 0 &&
1879 * transport->xprt.resvport == 1) xs_get_srcport above will
1880 * ensure that port is non-zero and we will bind as needed.
1885 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1887 rpc_set_port((struct sockaddr *)&myaddr, port);
1888 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1889 transport->xprt.addrlen);
1891 transport->srcport = port;
1895 port = xs_next_srcport(transport, port);
1898 } while (err == -EADDRINUSE && nloop != 2);
1900 if (myaddr.ss_family == AF_INET)
1901 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1902 &((struct sockaddr_in *)&myaddr)->sin_addr,
1903 port, err ? "failed" : "ok", err);
1905 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1906 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1907 port, err ? "failed" : "ok", err);
1912 * We don't support autobind on AF_LOCAL sockets
1914 static void xs_local_rpcbind(struct rpc_task *task)
1916 xprt_set_bound(task->tk_xprt);
1919 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1923 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1924 static struct lock_class_key xs_key[2];
1925 static struct lock_class_key xs_slock_key[2];
1927 static inline void xs_reclassify_socketu(struct socket *sock)
1929 struct sock *sk = sock->sk;
1931 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1932 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1935 static inline void xs_reclassify_socket4(struct socket *sock)
1937 struct sock *sk = sock->sk;
1939 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1940 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1943 static inline void xs_reclassify_socket6(struct socket *sock)
1945 struct sock *sk = sock->sk;
1947 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1948 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1951 static inline void xs_reclassify_socket(int family, struct socket *sock)
1953 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk)))
1958 xs_reclassify_socketu(sock);
1961 xs_reclassify_socket4(sock);
1964 xs_reclassify_socket6(sock);
1969 static inline void xs_reclassify_socket(int family, struct socket *sock)
1974 static void xs_dummy_setup_socket(struct work_struct *work)
1978 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1979 struct sock_xprt *transport, int family, int type,
1980 int protocol, bool reuseport)
1982 struct socket *sock;
1985 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1987 dprintk("RPC: can't create %d transport socket (%d).\n",
1991 xs_reclassify_socket(family, sock);
1994 xs_sock_set_reuseport(sock);
1996 err = xs_bind(transport, sock);
2004 return ERR_PTR(err);
2007 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
2008 struct socket *sock)
2010 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
2013 if (!transport->inet) {
2014 struct sock *sk = sock->sk;
2016 write_lock_bh(&sk->sk_callback_lock);
2018 xs_save_old_callbacks(transport, sk);
2020 sk->sk_user_data = xprt;
2021 sk->sk_data_ready = xs_data_ready;
2022 sk->sk_write_space = xs_udp_write_space;
2023 sock_set_flag(sk, SOCK_FASYNC);
2024 sk->sk_error_report = xs_error_report;
2025 sk->sk_allocation = GFP_NOIO;
2027 xprt_clear_connected(xprt);
2029 /* Reset to new socket */
2030 transport->sock = sock;
2031 transport->inet = sk;
2033 write_unlock_bh(&sk->sk_callback_lock);
2036 /* Tell the socket layer to start connecting... */
2037 xprt->stat.connect_count++;
2038 xprt->stat.connect_start = jiffies;
2039 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
2043 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
2044 * @transport: socket transport to connect
2046 static int xs_local_setup_socket(struct sock_xprt *transport)
2048 struct rpc_xprt *xprt = &transport->xprt;
2049 struct socket *sock;
2052 status = __sock_create(xprt->xprt_net, AF_LOCAL,
2053 SOCK_STREAM, 0, &sock, 1);
2055 dprintk("RPC: can't create AF_LOCAL "
2056 "transport socket (%d).\n", -status);
2059 xs_reclassify_socket(AF_LOCAL, sock);
2061 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
2062 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2064 status = xs_local_finish_connecting(xprt, sock);
2065 trace_rpc_socket_connect(xprt, sock, status);
2068 dprintk("RPC: xprt %p connected to %s\n",
2069 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2070 xprt_set_connected(xprt);
2074 dprintk("RPC: xprt %p: socket %s does not exist\n",
2075 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2078 dprintk("RPC: xprt %p: connection refused for %s\n",
2079 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
2082 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
2084 xprt->address_strings[RPC_DISPLAY_ADDR]);
2088 xprt_clear_connecting(xprt);
2089 xprt_wake_pending_tasks(xprt, status);
2093 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2095 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2098 if (RPC_IS_ASYNC(task)) {
2100 * We want the AF_LOCAL connect to be resolved in the
2101 * filesystem namespace of the process making the rpc
2102 * call. Thus we connect synchronously.
2104 * If we want to support asynchronous AF_LOCAL calls,
2105 * we'll need to figure out how to pass a namespace to
2108 rpc_exit(task, -ENOTCONN);
2111 ret = xs_local_setup_socket(transport);
2112 if (ret && !RPC_IS_SOFTCONN(task))
2113 msleep_interruptible(15000);
2116 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2118 * Note that this should be called with XPRT_LOCKED held (or when we otherwise
2119 * know that we have exclusive access to the socket), to guard against
2120 * races with xs_reset_transport.
2122 static void xs_set_memalloc(struct rpc_xprt *xprt)
2124 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
2128 * If there's no sock, then we have nothing to set. The
2129 * reconnecting process will get it for us.
2131 if (!transport->inet)
2133 if (atomic_read(&xprt->swapper))
2134 sk_set_memalloc(transport->inet);
2138 * xs_enable_swap - Tag this transport as being used for swap.
2139 * @xprt: transport to tag
2141 * Take a reference to this transport on behalf of the rpc_clnt, and
2142 * optionally mark it for swapping if it wasn't already.
2145 xs_enable_swap(struct rpc_xprt *xprt)
2147 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2149 if (atomic_inc_return(&xprt->swapper) != 1)
2151 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2152 return -ERESTARTSYS;
2154 sk_set_memalloc(xs->inet);
2155 xprt_release_xprt(xprt, NULL);
2160 * xs_disable_swap - Untag this transport as being used for swap.
2161 * @xprt: transport to tag
2163 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2164 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2167 xs_disable_swap(struct rpc_xprt *xprt)
2169 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt);
2171 if (!atomic_dec_and_test(&xprt->swapper))
2173 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE))
2176 sk_clear_memalloc(xs->inet);
2177 xprt_release_xprt(xprt, NULL);
2180 static void xs_set_memalloc(struct rpc_xprt *xprt)
2185 xs_enable_swap(struct rpc_xprt *xprt)
2191 xs_disable_swap(struct rpc_xprt *xprt)
2196 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2198 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2200 if (!transport->inet) {
2201 struct sock *sk = sock->sk;
2203 write_lock_bh(&sk->sk_callback_lock);
2205 xs_save_old_callbacks(transport, sk);
2207 sk->sk_user_data = xprt;
2208 sk->sk_data_ready = xs_data_ready;
2209 sk->sk_write_space = xs_udp_write_space;
2210 sock_set_flag(sk, SOCK_FASYNC);
2211 sk->sk_allocation = GFP_NOIO;
2213 xprt_set_connected(xprt);
2215 /* Reset to new socket */
2216 transport->sock = sock;
2217 transport->inet = sk;
2219 xs_set_memalloc(xprt);
2221 write_unlock_bh(&sk->sk_callback_lock);
2223 xs_udp_do_set_buffer_size(xprt);
2225 xprt->stat.connect_start = jiffies;
2228 static void xs_udp_setup_socket(struct work_struct *work)
2230 struct sock_xprt *transport =
2231 container_of(work, struct sock_xprt, connect_worker.work);
2232 struct rpc_xprt *xprt = &transport->xprt;
2233 struct socket *sock;
2236 sock = xs_create_sock(xprt, transport,
2237 xs_addr(xprt)->sa_family, SOCK_DGRAM,
2238 IPPROTO_UDP, false);
2242 dprintk("RPC: worker connecting xprt %p via %s to "
2243 "%s (port %s)\n", xprt,
2244 xprt->address_strings[RPC_DISPLAY_PROTO],
2245 xprt->address_strings[RPC_DISPLAY_ADDR],
2246 xprt->address_strings[RPC_DISPLAY_PORT]);
2248 xs_udp_finish_connecting(xprt, sock);
2249 trace_rpc_socket_connect(xprt, sock, 0);
2252 xprt_unlock_connect(xprt, transport);
2253 xprt_clear_connecting(xprt);
2254 xprt_wake_pending_tasks(xprt, status);
2258 * xs_tcp_shutdown - gracefully shut down a TCP socket
2261 * Initiates a graceful shutdown of the TCP socket by calling the
2262 * equivalent of shutdown(SHUT_RDWR);
2264 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
2266 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2267 struct socket *sock = transport->sock;
2271 if (xprt_connected(xprt)) {
2272 kernel_sock_shutdown(sock, SHUT_RDWR);
2273 trace_rpc_socket_shutdown(xprt, sock);
2275 xs_reset_transport(transport);
2278 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt,
2279 struct socket *sock)
2281 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2282 unsigned int keepidle;
2283 unsigned int keepcnt;
2284 unsigned int opt_on = 1;
2287 spin_lock_bh(&xprt->transport_lock);
2288 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ);
2289 keepcnt = xprt->timeout->to_retries + 1;
2290 timeo = jiffies_to_msecs(xprt->timeout->to_initval) *
2291 (xprt->timeout->to_retries + 1);
2292 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2293 spin_unlock_bh(&xprt->transport_lock);
2295 /* TCP Keepalive options */
2296 kernel_setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE,
2297 (char *)&opt_on, sizeof(opt_on));
2298 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPIDLE,
2299 (char *)&keepidle, sizeof(keepidle));
2300 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPINTVL,
2301 (char *)&keepidle, sizeof(keepidle));
2302 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPCNT,
2303 (char *)&keepcnt, sizeof(keepcnt));
2305 /* TCP user timeout (see RFC5482) */
2306 kernel_setsockopt(sock, SOL_TCP, TCP_USER_TIMEOUT,
2307 (char *)&timeo, sizeof(timeo));
2310 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt,
2311 unsigned long connect_timeout,
2312 unsigned long reconnect_timeout)
2314 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2315 struct rpc_timeout to;
2316 unsigned long initval;
2318 spin_lock_bh(&xprt->transport_lock);
2319 if (reconnect_timeout < xprt->max_reconnect_timeout)
2320 xprt->max_reconnect_timeout = reconnect_timeout;
2321 if (connect_timeout < xprt->connect_timeout) {
2322 memcpy(&to, xprt->timeout, sizeof(to));
2323 initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1);
2324 /* Arbitrary lower limit */
2325 if (initval < XS_TCP_INIT_REEST_TO << 1)
2326 initval = XS_TCP_INIT_REEST_TO << 1;
2327 to.to_initval = initval;
2328 to.to_maxval = initval;
2329 memcpy(&transport->tcp_timeout, &to,
2330 sizeof(transport->tcp_timeout));
2331 xprt->timeout = &transport->tcp_timeout;
2332 xprt->connect_timeout = connect_timeout;
2334 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state);
2335 spin_unlock_bh(&xprt->transport_lock);
2338 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2340 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2341 int ret = -ENOTCONN;
2343 if (!transport->inet) {
2344 struct sock *sk = sock->sk;
2345 unsigned int addr_pref = IPV6_PREFER_SRC_PUBLIC;
2347 /* Avoid temporary address, they are bad for long-lived
2348 * connections such as NFS mounts.
2349 * RFC4941, section 3.6 suggests that:
2350 * Individual applications, which have specific
2351 * knowledge about the normal duration of connections,
2352 * MAY override this as appropriate.
2354 kernel_setsockopt(sock, SOL_IPV6, IPV6_ADDR_PREFERENCES,
2355 (char *)&addr_pref, sizeof(addr_pref));
2357 xs_tcp_set_socket_timeouts(xprt, sock);
2359 write_lock_bh(&sk->sk_callback_lock);
2361 xs_save_old_callbacks(transport, sk);
2363 sk->sk_user_data = xprt;
2364 sk->sk_data_ready = xs_data_ready;
2365 sk->sk_state_change = xs_tcp_state_change;
2366 sk->sk_write_space = xs_tcp_write_space;
2367 sock_set_flag(sk, SOCK_FASYNC);
2368 sk->sk_error_report = xs_error_report;
2369 sk->sk_allocation = GFP_NOIO;
2371 /* socket options */
2372 sock_reset_flag(sk, SOCK_LINGER);
2373 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2375 xprt_clear_connected(xprt);
2377 /* Reset to new socket */
2378 transport->sock = sock;
2379 transport->inet = sk;
2381 write_unlock_bh(&sk->sk_callback_lock);
2384 if (!xprt_bound(xprt))
2387 xs_set_memalloc(xprt);
2389 /* Tell the socket layer to start connecting... */
2390 xprt->stat.connect_count++;
2391 xprt->stat.connect_start = jiffies;
2392 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state);
2393 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2396 xs_set_srcport(transport, sock);
2400 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2401 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2403 case -EADDRNOTAVAIL:
2404 /* Source port number is unavailable. Try a new one! */
2405 transport->srcport = 0;
2412 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2414 * Invoked by a work queue tasklet.
2416 static void xs_tcp_setup_socket(struct work_struct *work)
2418 struct sock_xprt *transport =
2419 container_of(work, struct sock_xprt, connect_worker.work);
2420 struct socket *sock = transport->sock;
2421 struct rpc_xprt *xprt = &transport->xprt;
2425 sock = xs_create_sock(xprt, transport,
2426 xs_addr(xprt)->sa_family, SOCK_STREAM,
2429 status = PTR_ERR(sock);
2434 dprintk("RPC: worker connecting xprt %p via %s to "
2435 "%s (port %s)\n", xprt,
2436 xprt->address_strings[RPC_DISPLAY_PROTO],
2437 xprt->address_strings[RPC_DISPLAY_ADDR],
2438 xprt->address_strings[RPC_DISPLAY_PORT]);
2440 status = xs_tcp_finish_connecting(xprt, sock);
2441 trace_rpc_socket_connect(xprt, sock, status);
2442 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2443 xprt, -status, xprt_connected(xprt),
2444 sock->sk->sk_state);
2447 printk("%s: connect returned unhandled error %d\n",
2450 case -EADDRNOTAVAIL:
2451 /* We're probably in TIME_WAIT. Get rid of existing socket,
2454 xs_tcp_force_close(xprt);
2459 xprt_unlock_connect(xprt, transport);
2462 /* Happens, for instance, if the user specified a link
2463 * local IPv6 address without a scope-id.
2473 * xs_tcp_force_close() wakes tasks with -EIO.
2474 * We need to wake them first to ensure the
2475 * correct error code.
2477 xprt_wake_pending_tasks(xprt, status);
2478 xs_tcp_force_close(xprt);
2483 xprt_unlock_connect(xprt, transport);
2484 xprt_clear_connecting(xprt);
2485 xprt_wake_pending_tasks(xprt, status);
2488 static unsigned long xs_reconnect_delay(const struct rpc_xprt *xprt)
2490 unsigned long start, now = jiffies;
2492 start = xprt->stat.connect_start + xprt->reestablish_timeout;
2493 if (time_after(start, now))
2498 static void xs_reconnect_backoff(struct rpc_xprt *xprt)
2500 xprt->reestablish_timeout <<= 1;
2501 if (xprt->reestablish_timeout > xprt->max_reconnect_timeout)
2502 xprt->reestablish_timeout = xprt->max_reconnect_timeout;
2503 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2504 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2508 * xs_connect - connect a socket to a remote endpoint
2509 * @xprt: pointer to transport structure
2510 * @task: address of RPC task that manages state of connect request
2512 * TCP: If the remote end dropped the connection, delay reconnecting.
2514 * UDP socket connects are synchronous, but we use a work queue anyway
2515 * to guarantee that even unprivileged user processes can set up a
2516 * socket on a privileged port.
2518 * If a UDP socket connect fails, the delay behavior here prevents
2519 * retry floods (hard mounts).
2521 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2523 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2524 unsigned long delay = 0;
2526 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport));
2528 if (transport->sock != NULL) {
2529 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2531 xprt, xprt->reestablish_timeout / HZ);
2533 /* Start by resetting any existing state */
2534 xs_reset_transport(transport);
2536 delay = xs_reconnect_delay(xprt);
2537 xs_reconnect_backoff(xprt);
2540 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2542 queue_delayed_work(xprtiod_workqueue,
2543 &transport->connect_worker,
2548 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2549 * @xprt: rpc_xprt struct containing statistics
2553 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2557 if (xprt_connected(xprt))
2558 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2560 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2561 "%llu %llu %lu %llu %llu\n",
2562 xprt->stat.bind_count,
2563 xprt->stat.connect_count,
2564 xprt->stat.connect_time,
2568 xprt->stat.bad_xids,
2571 xprt->stat.max_slots,
2572 xprt->stat.sending_u,
2573 xprt->stat.pending_u);
2577 * xs_udp_print_stats - display UDP socket-specifc stats
2578 * @xprt: rpc_xprt struct containing statistics
2582 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2584 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2586 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2589 xprt->stat.bind_count,
2592 xprt->stat.bad_xids,
2595 xprt->stat.max_slots,
2596 xprt->stat.sending_u,
2597 xprt->stat.pending_u);
2601 * xs_tcp_print_stats - display TCP socket-specifc stats
2602 * @xprt: rpc_xprt struct containing statistics
2606 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2608 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2611 if (xprt_connected(xprt))
2612 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2614 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2615 "%llu %llu %lu %llu %llu\n",
2617 xprt->stat.bind_count,
2618 xprt->stat.connect_count,
2619 xprt->stat.connect_time,
2623 xprt->stat.bad_xids,
2626 xprt->stat.max_slots,
2627 xprt->stat.sending_u,
2628 xprt->stat.pending_u);
2632 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2633 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2634 * to use the server side send routines.
2636 static int bc_malloc(struct rpc_task *task)
2638 struct rpc_rqst *rqst = task->tk_rqstp;
2639 size_t size = rqst->rq_callsize;
2641 struct rpc_buffer *buf;
2643 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) {
2644 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2649 page = alloc_page(GFP_KERNEL);
2653 buf = page_address(page);
2654 buf->len = PAGE_SIZE;
2656 rqst->rq_buffer = buf->data;
2657 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
2662 * Free the space allocated in the bc_alloc routine
2664 static void bc_free(struct rpc_task *task)
2666 void *buffer = task->tk_rqstp->rq_buffer;
2667 struct rpc_buffer *buf;
2669 buf = container_of(buffer, struct rpc_buffer, data);
2670 free_page((unsigned long)buf);
2674 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2675 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2677 static int bc_sendto(struct rpc_rqst *req)
2680 struct xdr_buf *xbufp = &req->rq_snd_buf;
2681 struct rpc_xprt *xprt = req->rq_xprt;
2682 struct sock_xprt *transport =
2683 container_of(xprt, struct sock_xprt, xprt);
2684 struct socket *sock = transport->sock;
2685 unsigned long headoff;
2686 unsigned long tailoff;
2688 xs_encode_stream_record_marker(xbufp);
2690 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2691 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2692 len = svc_send_common(sock, xbufp,
2693 virt_to_page(xbufp->head[0].iov_base), headoff,
2694 xbufp->tail[0].iov_base, tailoff);
2696 if (len != xbufp->len) {
2697 printk(KERN_NOTICE "Error sending entire callback!\n");
2705 * The send routine. Borrows from svc_send
2707 static int bc_send_request(struct rpc_task *task)
2709 struct rpc_rqst *req = task->tk_rqstp;
2710 struct svc_xprt *xprt;
2713 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2715 * Get the server socket associated with this callback xprt
2717 xprt = req->rq_xprt->bc_xprt;
2720 * Grab the mutex to serialize data as the connection is shared
2721 * with the fore channel
2723 if (!mutex_trylock(&xprt->xpt_mutex)) {
2724 rpc_sleep_on(&xprt->xpt_bc_pending, task, NULL);
2725 if (!mutex_trylock(&xprt->xpt_mutex))
2727 rpc_wake_up_queued_task(&xprt->xpt_bc_pending, task);
2729 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2732 len = bc_sendto(req);
2733 mutex_unlock(&xprt->xpt_mutex);
2742 * The close routine. Since this is client initiated, we do nothing
2745 static void bc_close(struct rpc_xprt *xprt)
2750 * The xprt destroy routine. Again, because this connection is client
2751 * initiated, we do nothing
2754 static void bc_destroy(struct rpc_xprt *xprt)
2756 dprintk("RPC: bc_destroy xprt %p\n", xprt);
2759 module_put(THIS_MODULE);
2762 static const struct rpc_xprt_ops xs_local_ops = {
2763 .reserve_xprt = xprt_reserve_xprt,
2764 .release_xprt = xs_tcp_release_xprt,
2765 .alloc_slot = xprt_alloc_slot,
2766 .rpcbind = xs_local_rpcbind,
2767 .set_port = xs_local_set_port,
2768 .connect = xs_local_connect,
2769 .buf_alloc = rpc_malloc,
2770 .buf_free = rpc_free,
2771 .send_request = xs_local_send_request,
2772 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2774 .destroy = xs_destroy,
2775 .print_stats = xs_local_print_stats,
2776 .enable_swap = xs_enable_swap,
2777 .disable_swap = xs_disable_swap,
2780 static const struct rpc_xprt_ops xs_udp_ops = {
2781 .set_buffer_size = xs_udp_set_buffer_size,
2782 .reserve_xprt = xprt_reserve_xprt_cong,
2783 .release_xprt = xprt_release_xprt_cong,
2784 .alloc_slot = xprt_alloc_slot,
2785 .rpcbind = rpcb_getport_async,
2786 .set_port = xs_set_port,
2787 .connect = xs_connect,
2788 .buf_alloc = rpc_malloc,
2789 .buf_free = rpc_free,
2790 .send_request = xs_udp_send_request,
2791 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2792 .timer = xs_udp_timer,
2793 .release_request = xprt_release_rqst_cong,
2795 .destroy = xs_destroy,
2796 .print_stats = xs_udp_print_stats,
2797 .enable_swap = xs_enable_swap,
2798 .disable_swap = xs_disable_swap,
2799 .inject_disconnect = xs_inject_disconnect,
2802 static const struct rpc_xprt_ops xs_tcp_ops = {
2803 .reserve_xprt = xprt_reserve_xprt,
2804 .release_xprt = xs_tcp_release_xprt,
2805 .alloc_slot = xprt_lock_and_alloc_slot,
2806 .rpcbind = rpcb_getport_async,
2807 .set_port = xs_set_port,
2808 .connect = xs_connect,
2809 .buf_alloc = rpc_malloc,
2810 .buf_free = rpc_free,
2811 .send_request = xs_tcp_send_request,
2812 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2813 .close = xs_tcp_shutdown,
2814 .destroy = xs_destroy,
2815 .set_connect_timeout = xs_tcp_set_connect_timeout,
2816 .print_stats = xs_tcp_print_stats,
2817 .enable_swap = xs_enable_swap,
2818 .disable_swap = xs_disable_swap,
2819 .inject_disconnect = xs_inject_disconnect,
2820 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2821 .bc_setup = xprt_setup_bc,
2822 .bc_up = xs_tcp_bc_up,
2823 .bc_maxpayload = xs_tcp_bc_maxpayload,
2824 .bc_free_rqst = xprt_free_bc_rqst,
2825 .bc_destroy = xprt_destroy_bc,
2830 * The rpc_xprt_ops for the server backchannel
2833 static const struct rpc_xprt_ops bc_tcp_ops = {
2834 .reserve_xprt = xprt_reserve_xprt,
2835 .release_xprt = xprt_release_xprt,
2836 .alloc_slot = xprt_alloc_slot,
2837 .buf_alloc = bc_malloc,
2838 .buf_free = bc_free,
2839 .send_request = bc_send_request,
2840 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2842 .destroy = bc_destroy,
2843 .print_stats = xs_tcp_print_stats,
2844 .enable_swap = xs_enable_swap,
2845 .disable_swap = xs_disable_swap,
2846 .inject_disconnect = xs_inject_disconnect,
2849 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2851 static const struct sockaddr_in sin = {
2852 .sin_family = AF_INET,
2853 .sin_addr.s_addr = htonl(INADDR_ANY),
2855 static const struct sockaddr_in6 sin6 = {
2856 .sin6_family = AF_INET6,
2857 .sin6_addr = IN6ADDR_ANY_INIT,
2864 memcpy(sap, &sin, sizeof(sin));
2867 memcpy(sap, &sin6, sizeof(sin6));
2870 dprintk("RPC: %s: Bad address family\n", __func__);
2871 return -EAFNOSUPPORT;
2876 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2877 unsigned int slot_table_size,
2878 unsigned int max_slot_table_size)
2880 struct rpc_xprt *xprt;
2881 struct sock_xprt *new;
2883 if (args->addrlen > sizeof(xprt->addr)) {
2884 dprintk("RPC: xs_setup_xprt: address too large\n");
2885 return ERR_PTR(-EBADF);
2888 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2889 max_slot_table_size);
2891 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2893 return ERR_PTR(-ENOMEM);
2896 new = container_of(xprt, struct sock_xprt, xprt);
2897 mutex_init(&new->recv_mutex);
2898 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2899 xprt->addrlen = args->addrlen;
2901 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2904 err = xs_init_anyaddr(args->dstaddr->sa_family,
2905 (struct sockaddr *)&new->srcaddr);
2908 return ERR_PTR(err);
2915 static const struct rpc_timeout xs_local_default_timeout = {
2916 .to_initval = 10 * HZ,
2917 .to_maxval = 10 * HZ,
2922 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2923 * @args: rpc transport creation arguments
2925 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2927 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2929 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2930 struct sock_xprt *transport;
2931 struct rpc_xprt *xprt;
2932 struct rpc_xprt *ret;
2934 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2935 xprt_max_tcp_slot_table_entries);
2938 transport = container_of(xprt, struct sock_xprt, xprt);
2941 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2942 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2944 xprt->bind_timeout = XS_BIND_TO;
2945 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2946 xprt->idle_timeout = XS_IDLE_DISC_TO;
2948 xprt->ops = &xs_local_ops;
2949 xprt->timeout = &xs_local_default_timeout;
2951 INIT_WORK(&transport->recv_worker, xs_local_data_receive_workfn);
2952 INIT_DELAYED_WORK(&transport->connect_worker,
2953 xs_dummy_setup_socket);
2955 switch (sun->sun_family) {
2957 if (sun->sun_path[0] != '/') {
2958 dprintk("RPC: bad AF_LOCAL address: %s\n",
2960 ret = ERR_PTR(-EINVAL);
2963 xprt_set_bound(xprt);
2964 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2965 ret = ERR_PTR(xs_local_setup_socket(transport));
2970 ret = ERR_PTR(-EAFNOSUPPORT);
2974 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2975 xprt->address_strings[RPC_DISPLAY_ADDR]);
2977 if (try_module_get(THIS_MODULE))
2979 ret = ERR_PTR(-EINVAL);
2985 static const struct rpc_timeout xs_udp_default_timeout = {
2986 .to_initval = 5 * HZ,
2987 .to_maxval = 30 * HZ,
2988 .to_increment = 5 * HZ,
2993 * xs_setup_udp - Set up transport to use a UDP socket
2994 * @args: rpc transport creation arguments
2997 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2999 struct sockaddr *addr = args->dstaddr;
3000 struct rpc_xprt *xprt;
3001 struct sock_xprt *transport;
3002 struct rpc_xprt *ret;
3004 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
3005 xprt_udp_slot_table_entries);
3008 transport = container_of(xprt, struct sock_xprt, xprt);
3010 xprt->prot = IPPROTO_UDP;
3012 /* XXX: header size can vary due to auth type, IPv6, etc. */
3013 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
3015 xprt->bind_timeout = XS_BIND_TO;
3016 xprt->reestablish_timeout = XS_UDP_REEST_TO;
3017 xprt->idle_timeout = XS_IDLE_DISC_TO;
3019 xprt->ops = &xs_udp_ops;
3021 xprt->timeout = &xs_udp_default_timeout;
3023 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn);
3024 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket);
3026 switch (addr->sa_family) {
3028 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3029 xprt_set_bound(xprt);
3031 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
3034 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3035 xprt_set_bound(xprt);
3037 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
3040 ret = ERR_PTR(-EAFNOSUPPORT);
3044 if (xprt_bound(xprt))
3045 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3046 xprt->address_strings[RPC_DISPLAY_ADDR],
3047 xprt->address_strings[RPC_DISPLAY_PORT],
3048 xprt->address_strings[RPC_DISPLAY_PROTO]);
3050 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3051 xprt->address_strings[RPC_DISPLAY_ADDR],
3052 xprt->address_strings[RPC_DISPLAY_PROTO]);
3054 if (try_module_get(THIS_MODULE))
3056 ret = ERR_PTR(-EINVAL);
3062 static const struct rpc_timeout xs_tcp_default_timeout = {
3063 .to_initval = 60 * HZ,
3064 .to_maxval = 60 * HZ,
3069 * xs_setup_tcp - Set up transport to use a TCP socket
3070 * @args: rpc transport creation arguments
3073 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
3075 struct sockaddr *addr = args->dstaddr;
3076 struct rpc_xprt *xprt;
3077 struct sock_xprt *transport;
3078 struct rpc_xprt *ret;
3079 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
3081 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
3082 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
3084 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3085 max_slot_table_size);
3088 transport = container_of(xprt, struct sock_xprt, xprt);
3090 xprt->prot = IPPROTO_TCP;
3091 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
3092 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3094 xprt->bind_timeout = XS_BIND_TO;
3095 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
3096 xprt->idle_timeout = XS_IDLE_DISC_TO;
3098 xprt->ops = &xs_tcp_ops;
3099 xprt->timeout = &xs_tcp_default_timeout;
3101 xprt->max_reconnect_timeout = xprt->timeout->to_maxval;
3102 xprt->connect_timeout = xprt->timeout->to_initval *
3103 (xprt->timeout->to_retries + 1);
3105 INIT_WORK(&transport->recv_worker, xs_tcp_data_receive_workfn);
3106 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket);
3108 switch (addr->sa_family) {
3110 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
3111 xprt_set_bound(xprt);
3113 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
3116 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
3117 xprt_set_bound(xprt);
3119 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
3122 ret = ERR_PTR(-EAFNOSUPPORT);
3126 if (xprt_bound(xprt))
3127 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3128 xprt->address_strings[RPC_DISPLAY_ADDR],
3129 xprt->address_strings[RPC_DISPLAY_PORT],
3130 xprt->address_strings[RPC_DISPLAY_PROTO]);
3132 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3133 xprt->address_strings[RPC_DISPLAY_ADDR],
3134 xprt->address_strings[RPC_DISPLAY_PROTO]);
3136 if (try_module_get(THIS_MODULE))
3138 ret = ERR_PTR(-EINVAL);
3145 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3146 * @args: rpc transport creation arguments
3149 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
3151 struct sockaddr *addr = args->dstaddr;
3152 struct rpc_xprt *xprt;
3153 struct sock_xprt *transport;
3154 struct svc_sock *bc_sock;
3155 struct rpc_xprt *ret;
3157 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
3158 xprt_tcp_slot_table_entries);
3161 transport = container_of(xprt, struct sock_xprt, xprt);
3163 xprt->prot = IPPROTO_TCP;
3164 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
3165 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
3166 xprt->timeout = &xs_tcp_default_timeout;
3169 xprt_set_bound(xprt);
3170 xprt->bind_timeout = 0;
3171 xprt->reestablish_timeout = 0;
3172 xprt->idle_timeout = 0;
3174 xprt->ops = &bc_tcp_ops;
3176 switch (addr->sa_family) {
3178 xs_format_peer_addresses(xprt, "tcp",
3182 xs_format_peer_addresses(xprt, "tcp",
3183 RPCBIND_NETID_TCP6);
3186 ret = ERR_PTR(-EAFNOSUPPORT);
3190 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3191 xprt->address_strings[RPC_DISPLAY_ADDR],
3192 xprt->address_strings[RPC_DISPLAY_PORT],
3193 xprt->address_strings[RPC_DISPLAY_PROTO]);
3196 * Once we've associated a backchannel xprt with a connection,
3197 * we want to keep it around as long as the connection lasts,
3198 * in case we need to start using it for a backchannel again;
3199 * this reference won't be dropped until bc_xprt is destroyed.
3202 args->bc_xprt->xpt_bc_xprt = xprt;
3203 xprt->bc_xprt = args->bc_xprt;
3204 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
3205 transport->sock = bc_sock->sk_sock;
3206 transport->inet = bc_sock->sk_sk;
3209 * Since we don't want connections for the backchannel, we set
3210 * the xprt status to connected
3212 xprt_set_connected(xprt);
3214 if (try_module_get(THIS_MODULE))
3217 args->bc_xprt->xpt_bc_xprt = NULL;
3218 args->bc_xprt->xpt_bc_xps = NULL;
3220 ret = ERR_PTR(-EINVAL);
3226 static struct xprt_class xs_local_transport = {
3227 .list = LIST_HEAD_INIT(xs_local_transport.list),
3228 .name = "named UNIX socket",
3229 .owner = THIS_MODULE,
3230 .ident = XPRT_TRANSPORT_LOCAL,
3231 .setup = xs_setup_local,
3234 static struct xprt_class xs_udp_transport = {
3235 .list = LIST_HEAD_INIT(xs_udp_transport.list),
3237 .owner = THIS_MODULE,
3238 .ident = XPRT_TRANSPORT_UDP,
3239 .setup = xs_setup_udp,
3242 static struct xprt_class xs_tcp_transport = {
3243 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
3245 .owner = THIS_MODULE,
3246 .ident = XPRT_TRANSPORT_TCP,
3247 .setup = xs_setup_tcp,
3250 static struct xprt_class xs_bc_tcp_transport = {
3251 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
3252 .name = "tcp NFSv4.1 backchannel",
3253 .owner = THIS_MODULE,
3254 .ident = XPRT_TRANSPORT_BC_TCP,
3255 .setup = xs_setup_bc_tcp,
3259 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3262 int init_socket_xprt(void)
3264 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
3265 if (!sunrpc_table_header)
3266 sunrpc_table_header = register_sysctl_table(sunrpc_table);
3269 xprt_register_transport(&xs_local_transport);
3270 xprt_register_transport(&xs_udp_transport);
3271 xprt_register_transport(&xs_tcp_transport);
3272 xprt_register_transport(&xs_bc_tcp_transport);
3278 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3281 void cleanup_socket_xprt(void)
3283 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
3284 if (sunrpc_table_header) {
3285 unregister_sysctl_table(sunrpc_table_header);
3286 sunrpc_table_header = NULL;
3290 xprt_unregister_transport(&xs_local_transport);
3291 xprt_unregister_transport(&xs_udp_transport);
3292 xprt_unregister_transport(&xs_tcp_transport);
3293 xprt_unregister_transport(&xs_bc_tcp_transport);
3296 static int param_set_uint_minmax(const char *val,
3297 const struct kernel_param *kp,
3298 unsigned int min, unsigned int max)
3305 ret = kstrtouint(val, 0, &num);
3308 if (num < min || num > max)
3310 *((unsigned int *)kp->arg) = num;
3314 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3316 if (kp->arg == &xprt_min_resvport)
3317 return param_set_uint_minmax(val, kp,
3320 return param_set_uint_minmax(val, kp,
3325 static const struct kernel_param_ops param_ops_portnr = {
3326 .set = param_set_portnr,
3327 .get = param_get_uint,
3330 #define param_check_portnr(name, p) \
3331 __param_check(name, p, unsigned int);
3333 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3334 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3336 static int param_set_slot_table_size(const char *val,
3337 const struct kernel_param *kp)
3339 return param_set_uint_minmax(val, kp,
3341 RPC_MAX_SLOT_TABLE);
3344 static const struct kernel_param_ops param_ops_slot_table_size = {
3345 .set = param_set_slot_table_size,
3346 .get = param_get_uint,
3349 #define param_check_slot_table_size(name, p) \
3350 __param_check(name, p, unsigned int);
3352 static int param_set_max_slot_table_size(const char *val,
3353 const struct kernel_param *kp)
3355 return param_set_uint_minmax(val, kp,
3357 RPC_MAX_SLOT_TABLE_LIMIT);
3360 static const struct kernel_param_ops param_ops_max_slot_table_size = {
3361 .set = param_set_max_slot_table_size,
3362 .get = param_get_uint,
3365 #define param_check_max_slot_table_size(name, p) \
3366 __param_check(name, p, unsigned int);
3368 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3369 slot_table_size, 0644);
3370 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3371 max_slot_table_size, 0644);
3372 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3373 slot_table_size, 0644);