2 * linux/net/sunrpc/xprtsock.c
4 * Client-side transport implementation for sockets.
6 * TCP callback races fixes (C) 1998 Red Hat
7 * TCP send fixes (C) 1998 Red Hat
8 * TCP NFS related read + write fixes
9 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
11 * Rewrite of larges part of the code in order to stabilize TCP stuff.
12 * Fix behaviour when socket buffer is full.
13 * (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no>
15 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
17 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
18 * <gilles.quillard@bull.net>
21 #include <linux/types.h>
22 #include <linux/slab.h>
23 #include <linux/module.h>
24 #include <linux/capability.h>
25 #include <linux/pagemap.h>
26 #include <linux/errno.h>
27 #include <linux/socket.h>
29 #include <linux/net.h>
31 #include <linux/udp.h>
32 #include <linux/tcp.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/sched.h>
35 #include <linux/sunrpc/xprtsock.h>
36 #include <linux/file.h>
37 #ifdef CONFIG_NFS_V4_1
38 #include <linux/sunrpc/bc_xprt.h>
42 #include <net/checksum.h>
49 unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
50 unsigned int xprt_tcp_slot_table_entries = RPC_DEF_SLOT_TABLE;
52 unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
53 unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
55 #define XS_TCP_LINGER_TO (15U * HZ)
56 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
59 * We can register our own files under /proc/sys/sunrpc by
60 * calling register_sysctl_table() again. The files in that
61 * directory become the union of all files registered there.
63 * We simply need to make sure that we don't collide with
64 * someone else's file names!
69 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
70 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
71 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
72 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
74 static struct ctl_table_header *sunrpc_table_header;
77 * FIXME: changing the UDP slot table size should also resize the UDP
78 * socket buffers for existing UDP transports
80 static ctl_table xs_tunables_table[] = {
82 .ctl_name = CTL_SLOTTABLE_UDP,
83 .procname = "udp_slot_table_entries",
84 .data = &xprt_udp_slot_table_entries,
85 .maxlen = sizeof(unsigned int),
87 .proc_handler = &proc_dointvec_minmax,
88 .strategy = &sysctl_intvec,
89 .extra1 = &min_slot_table_size,
90 .extra2 = &max_slot_table_size
93 .ctl_name = CTL_SLOTTABLE_TCP,
94 .procname = "tcp_slot_table_entries",
95 .data = &xprt_tcp_slot_table_entries,
96 .maxlen = sizeof(unsigned int),
98 .proc_handler = &proc_dointvec_minmax,
99 .strategy = &sysctl_intvec,
100 .extra1 = &min_slot_table_size,
101 .extra2 = &max_slot_table_size
104 .ctl_name = CTL_MIN_RESVPORT,
105 .procname = "min_resvport",
106 .data = &xprt_min_resvport,
107 .maxlen = sizeof(unsigned int),
109 .proc_handler = &proc_dointvec_minmax,
110 .strategy = &sysctl_intvec,
111 .extra1 = &xprt_min_resvport_limit,
112 .extra2 = &xprt_max_resvport_limit
115 .ctl_name = CTL_MAX_RESVPORT,
116 .procname = "max_resvport",
117 .data = &xprt_max_resvport,
118 .maxlen = sizeof(unsigned int),
120 .proc_handler = &proc_dointvec_minmax,
121 .strategy = &sysctl_intvec,
122 .extra1 = &xprt_min_resvport_limit,
123 .extra2 = &xprt_max_resvport_limit
126 .procname = "tcp_fin_timeout",
127 .data = &xs_tcp_fin_timeout,
128 .maxlen = sizeof(xs_tcp_fin_timeout),
130 .proc_handler = &proc_dointvec_jiffies,
131 .strategy = sysctl_jiffies
138 static ctl_table sunrpc_table[] = {
140 .ctl_name = CTL_SUNRPC,
141 .procname = "sunrpc",
143 .child = xs_tunables_table
153 * Time out for an RPC UDP socket connect. UDP socket connects are
154 * synchronous, but we set a timeout anyway in case of resource
155 * exhaustion on the local host.
157 #define XS_UDP_CONN_TO (5U * HZ)
160 * Wait duration for an RPC TCP connection to be established. Solaris
161 * NFS over TCP uses 60 seconds, for example, which is in line with how
162 * long a server takes to reboot.
164 #define XS_TCP_CONN_TO (60U * HZ)
167 * Wait duration for a reply from the RPC portmapper.
169 #define XS_BIND_TO (60U * HZ)
172 * Delay if a UDP socket connect error occurs. This is most likely some
173 * kind of resource problem on the local host.
175 #define XS_UDP_REEST_TO (2U * HZ)
178 * The reestablish timeout allows clients to delay for a bit before attempting
179 * to reconnect to a server that just dropped our connection.
181 * We implement an exponential backoff when trying to reestablish a TCP
182 * transport connection with the server. Some servers like to drop a TCP
183 * connection when they are overworked, so we start with a short timeout and
184 * increase over time if the server is down or not responding.
186 #define XS_TCP_INIT_REEST_TO (3U * HZ)
187 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
190 * TCP idle timeout; client drops the transport socket if it is idle
191 * for this long. Note that we also timeout UDP sockets to prevent
192 * holding port numbers when there is no RPC traffic.
194 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
197 # undef RPC_DEBUG_DATA
198 # define RPCDBG_FACILITY RPCDBG_TRANS
201 #ifdef RPC_DEBUG_DATA
202 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
204 u8 *buf = (u8 *) packet;
207 dprintk("RPC: %s\n", msg);
208 for (j = 0; j < count && j < 128; j += 4) {
212 dprintk("0x%04x ", j);
214 dprintk("%02x%02x%02x%02x ",
215 buf[j], buf[j+1], buf[j+2], buf[j+3]);
220 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
227 struct rpc_xprt xprt;
232 struct socket * sock;
236 * State of TCP reply receive
244 unsigned long tcp_copied,
248 * Connection of transports
250 struct delayed_work connect_worker;
251 struct sockaddr_storage addr;
255 * UDP socket buffer size parameters
261 * Saved socket callback addresses
263 void (*old_data_ready)(struct sock *, int);
264 void (*old_state_change)(struct sock *);
265 void (*old_write_space)(struct sock *);
266 void (*old_error_report)(struct sock *);
270 * TCP receive state flags
272 #define TCP_RCV_LAST_FRAG (1UL << 0)
273 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
274 #define TCP_RCV_COPY_XID (1UL << 2)
275 #define TCP_RCV_COPY_DATA (1UL << 3)
276 #define TCP_RCV_READ_CALLDIR (1UL << 4)
277 #define TCP_RCV_COPY_CALLDIR (1UL << 5)
282 #define TCP_RPC_REPLY (1UL << 6)
284 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
286 return (struct sockaddr *) &xprt->addr;
289 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
291 return (struct sockaddr_in *) &xprt->addr;
294 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
296 return (struct sockaddr_in6 *) &xprt->addr;
299 static void xs_format_ipv4_peer_addresses(struct rpc_xprt *xprt,
300 const char *protocol,
303 struct sockaddr_in *addr = xs_addr_in(xprt);
306 buf = kzalloc(20, GFP_KERNEL);
308 snprintf(buf, 20, "%pI4", &addr->sin_addr.s_addr);
310 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
312 buf = kzalloc(8, GFP_KERNEL);
314 snprintf(buf, 8, "%u",
315 ntohs(addr->sin_port));
317 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
319 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
321 buf = kzalloc(48, GFP_KERNEL);
323 snprintf(buf, 48, "addr=%pI4 port=%u proto=%s",
324 &addr->sin_addr.s_addr,
325 ntohs(addr->sin_port),
328 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
330 buf = kzalloc(10, GFP_KERNEL);
332 snprintf(buf, 10, "%02x%02x%02x%02x",
333 NIPQUAD(addr->sin_addr.s_addr));
335 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
337 buf = kzalloc(8, GFP_KERNEL);
339 snprintf(buf, 8, "%4hx",
340 ntohs(addr->sin_port));
342 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
344 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
347 static void xs_format_ipv6_peer_addresses(struct rpc_xprt *xprt,
348 const char *protocol,
351 struct sockaddr_in6 *addr = xs_addr_in6(xprt);
354 buf = kzalloc(40, GFP_KERNEL);
356 snprintf(buf, 40, "%pI6",&addr->sin6_addr);
358 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
360 buf = kzalloc(8, GFP_KERNEL);
362 snprintf(buf, 8, "%u",
363 ntohs(addr->sin6_port));
365 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
367 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
369 buf = kzalloc(64, GFP_KERNEL);
371 snprintf(buf, 64, "addr=%pI6 port=%u proto=%s",
373 ntohs(addr->sin6_port),
376 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
378 buf = kzalloc(36, GFP_KERNEL);
380 snprintf(buf, 36, "%pi6", &addr->sin6_addr);
382 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
384 buf = kzalloc(8, GFP_KERNEL);
386 snprintf(buf, 8, "%4hx",
387 ntohs(addr->sin6_port));
389 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
391 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
394 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
398 for (i = 0; i < RPC_DISPLAY_MAX; i++)
400 case RPC_DISPLAY_PROTO:
401 case RPC_DISPLAY_NETID:
404 kfree(xprt->address_strings[i]);
408 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
410 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
412 struct msghdr msg = {
414 .msg_namelen = addrlen,
415 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
418 .iov_base = vec->iov_base + base,
419 .iov_len = vec->iov_len - base,
422 if (iov.iov_len != 0)
423 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
424 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
427 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more)
430 unsigned int remainder;
433 remainder = xdr->page_len - base;
434 base += xdr->page_base;
435 ppage = xdr->pages + (base >> PAGE_SHIFT);
438 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
439 int flags = XS_SENDMSG_FLAGS;
442 if (remainder != 0 || more)
444 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
445 if (remainder == 0 || err != len)
459 * xs_sendpages - write pages directly to a socket
460 * @sock: socket to send on
461 * @addr: UDP only -- address of destination
462 * @addrlen: UDP only -- length of destination address
463 * @xdr: buffer containing this request
464 * @base: starting position in the buffer
467 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
469 unsigned int remainder = xdr->len - base;
475 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
481 if (base < xdr->head[0].iov_len || addr != NULL) {
482 unsigned int len = xdr->head[0].iov_len - base;
484 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
485 if (remainder == 0 || err != len)
490 base -= xdr->head[0].iov_len;
492 if (base < xdr->page_len) {
493 unsigned int len = xdr->page_len - base;
495 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
496 if (remainder == 0 || err != len)
501 base -= xdr->page_len;
503 if (base >= xdr->tail[0].iov_len)
505 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
514 static void xs_nospace_callback(struct rpc_task *task)
516 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
518 transport->inet->sk_write_pending--;
519 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
523 * xs_nospace - place task on wait queue if transmit was incomplete
524 * @task: task to put to sleep
527 static int xs_nospace(struct rpc_task *task)
529 struct rpc_rqst *req = task->tk_rqstp;
530 struct rpc_xprt *xprt = req->rq_xprt;
531 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
534 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
535 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
538 /* Protect against races with write_space */
539 spin_lock_bh(&xprt->transport_lock);
541 /* Don't race with disconnect */
542 if (xprt_connected(xprt)) {
543 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
546 * Notify TCP that we're limited by the application
549 set_bit(SOCK_NOSPACE, &transport->sock->flags);
550 transport->inet->sk_write_pending++;
551 /* ...and wait for more buffer space */
552 xprt_wait_for_buffer_space(task, xs_nospace_callback);
555 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
559 spin_unlock_bh(&xprt->transport_lock);
564 * xs_udp_send_request - write an RPC request to a UDP socket
565 * @task: address of RPC task that manages the state of an RPC request
568 * 0: The request has been sent
569 * EAGAIN: The socket was blocked, please call again later to
570 * complete the request
571 * ENOTCONN: Caller needs to invoke connect logic then call again
572 * other: Some other error occured, the request was not sent
574 static int xs_udp_send_request(struct rpc_task *task)
576 struct rpc_rqst *req = task->tk_rqstp;
577 struct rpc_xprt *xprt = req->rq_xprt;
578 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
579 struct xdr_buf *xdr = &req->rq_snd_buf;
582 xs_pktdump("packet data:",
583 req->rq_svec->iov_base,
584 req->rq_svec->iov_len);
586 if (!xprt_bound(xprt))
588 status = xs_sendpages(transport->sock,
593 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
594 xdr->len - req->rq_bytes_sent, status);
597 task->tk_bytes_sent += status;
598 if (status >= req->rq_slen)
600 /* Still some bytes left; set up for a retry later. */
603 if (!transport->sock)
609 /* Should we call xs_close() here? */
612 status = xs_nospace(task);
615 dprintk("RPC: sendmsg returned unrecognized error %d\n",
620 /* When the server has died, an ICMP port unreachable message
621 * prompts ECONNREFUSED. */
622 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
629 * xs_tcp_shutdown - gracefully shut down a TCP socket
632 * Initiates a graceful shutdown of the TCP socket by calling the
633 * equivalent of shutdown(SHUT_WR);
635 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
637 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
638 struct socket *sock = transport->sock;
641 kernel_sock_shutdown(sock, SHUT_WR);
644 static inline void xs_encode_tcp_record_marker(struct xdr_buf *buf)
646 u32 reclen = buf->len - sizeof(rpc_fraghdr);
647 rpc_fraghdr *base = buf->head[0].iov_base;
648 *base = htonl(RPC_LAST_STREAM_FRAGMENT | reclen);
652 * xs_tcp_send_request - write an RPC request to a TCP socket
653 * @task: address of RPC task that manages the state of an RPC request
656 * 0: The request has been sent
657 * EAGAIN: The socket was blocked, please call again later to
658 * complete the request
659 * ENOTCONN: Caller needs to invoke connect logic then call again
660 * other: Some other error occured, the request was not sent
662 * XXX: In the case of soft timeouts, should we eventually give up
663 * if sendmsg is not able to make progress?
665 static int xs_tcp_send_request(struct rpc_task *task)
667 struct rpc_rqst *req = task->tk_rqstp;
668 struct rpc_xprt *xprt = req->rq_xprt;
669 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
670 struct xdr_buf *xdr = &req->rq_snd_buf;
673 xs_encode_tcp_record_marker(&req->rq_snd_buf);
675 xs_pktdump("packet data:",
676 req->rq_svec->iov_base,
677 req->rq_svec->iov_len);
679 /* Continue transmitting the packet/record. We must be careful
680 * to cope with writespace callbacks arriving _after_ we have
681 * called sendmsg(). */
683 status = xs_sendpages(transport->sock,
684 NULL, 0, xdr, req->rq_bytes_sent);
686 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
687 xdr->len - req->rq_bytes_sent, status);
689 if (unlikely(status < 0))
692 /* If we've sent the entire packet, immediately
693 * reset the count of bytes sent. */
694 req->rq_bytes_sent += status;
695 task->tk_bytes_sent += status;
696 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
697 req->rq_bytes_sent = 0;
706 if (!transport->sock)
712 /* Should we call xs_close() here? */
715 status = xs_nospace(task);
718 dprintk("RPC: sendmsg returned unrecognized error %d\n",
722 xs_tcp_shutdown(xprt);
725 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
732 * xs_tcp_release_xprt - clean up after a tcp transmission
736 * This cleans up if an error causes us to abort the transmission of a request.
737 * In this case, the socket may need to be reset in order to avoid confusing
740 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
742 struct rpc_rqst *req;
744 if (task != xprt->snd_task)
748 req = task->tk_rqstp;
749 if (req->rq_bytes_sent == 0)
751 if (req->rq_bytes_sent == req->rq_snd_buf.len)
753 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
755 xprt_release_xprt(xprt, task);
758 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
760 transport->old_data_ready = sk->sk_data_ready;
761 transport->old_state_change = sk->sk_state_change;
762 transport->old_write_space = sk->sk_write_space;
763 transport->old_error_report = sk->sk_error_report;
766 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
768 sk->sk_data_ready = transport->old_data_ready;
769 sk->sk_state_change = transport->old_state_change;
770 sk->sk_write_space = transport->old_write_space;
771 sk->sk_error_report = transport->old_error_report;
774 static void xs_reset_transport(struct sock_xprt *transport)
776 struct socket *sock = transport->sock;
777 struct sock *sk = transport->inet;
782 write_lock_bh(&sk->sk_callback_lock);
783 transport->inet = NULL;
784 transport->sock = NULL;
786 sk->sk_user_data = NULL;
788 xs_restore_old_callbacks(transport, sk);
789 write_unlock_bh(&sk->sk_callback_lock);
797 * xs_close - close a socket
800 * This is used when all requests are complete; ie, no DRC state remains
801 * on the server we want to save.
803 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
804 * xs_reset_transport() zeroing the socket from underneath a writer.
806 static void xs_close(struct rpc_xprt *xprt)
808 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
810 dprintk("RPC: xs_close xprt %p\n", xprt);
812 xs_reset_transport(transport);
814 smp_mb__before_clear_bit();
815 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
816 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
817 clear_bit(XPRT_CLOSING, &xprt->state);
818 smp_mb__after_clear_bit();
819 xprt_disconnect_done(xprt);
822 static void xs_tcp_close(struct rpc_xprt *xprt)
824 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state))
827 xs_tcp_shutdown(xprt);
831 * xs_destroy - prepare to shutdown a transport
832 * @xprt: doomed transport
835 static void xs_destroy(struct rpc_xprt *xprt)
837 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
839 dprintk("RPC: xs_destroy xprt %p\n", xprt);
841 cancel_rearming_delayed_work(&transport->connect_worker);
844 xs_free_peer_addresses(xprt);
847 module_put(THIS_MODULE);
850 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
852 return (struct rpc_xprt *) sk->sk_user_data;
856 * xs_udp_data_ready - "data ready" callback for UDP sockets
857 * @sk: socket with data to read
858 * @len: how much data to read
861 static void xs_udp_data_ready(struct sock *sk, int len)
863 struct rpc_task *task;
864 struct rpc_xprt *xprt;
865 struct rpc_rqst *rovr;
867 int err, repsize, copied;
871 read_lock(&sk->sk_callback_lock);
872 dprintk("RPC: xs_udp_data_ready...\n");
873 if (!(xprt = xprt_from_sock(sk)))
876 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
882 repsize = skb->len - sizeof(struct udphdr);
884 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
888 /* Copy the XID from the skb... */
889 xp = skb_header_pointer(skb, sizeof(struct udphdr),
890 sizeof(_xid), &_xid);
894 /* Look up and lock the request corresponding to the given XID */
895 spin_lock(&xprt->transport_lock);
896 rovr = xprt_lookup_rqst(xprt, *xp);
899 task = rovr->rq_task;
901 if ((copied = rovr->rq_private_buf.buflen) > repsize)
904 /* Suck it into the iovec, verify checksum if not done by hw. */
905 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
906 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
910 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
912 /* Something worked... */
913 dst_confirm(skb_dst(skb));
915 xprt_adjust_cwnd(task, copied);
916 xprt_update_rtt(task);
917 xprt_complete_rqst(task, copied);
920 spin_unlock(&xprt->transport_lock);
922 skb_free_datagram(sk, skb);
924 read_unlock(&sk->sk_callback_lock);
927 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
929 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
933 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
934 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
935 used = xdr_skb_read_bits(desc, p, len);
936 transport->tcp_offset += used;
940 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
941 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
942 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
944 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
945 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
947 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
948 transport->tcp_offset = 0;
950 /* Sanity check of the record length */
951 if (unlikely(transport->tcp_reclen < 8)) {
952 dprintk("RPC: invalid TCP record fragment length\n");
953 xprt_force_disconnect(xprt);
956 dprintk("RPC: reading TCP record fragment of length %d\n",
957 transport->tcp_reclen);
960 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
962 if (transport->tcp_offset == transport->tcp_reclen) {
963 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
964 transport->tcp_offset = 0;
965 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
966 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
967 transport->tcp_flags |= TCP_RCV_COPY_XID;
968 transport->tcp_copied = 0;
973 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
978 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
979 dprintk("RPC: reading XID (%Zu bytes)\n", len);
980 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
981 used = xdr_skb_read_bits(desc, p, len);
982 transport->tcp_offset += used;
985 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
986 transport->tcp_flags |= TCP_RCV_READ_CALLDIR;
987 transport->tcp_copied = 4;
988 dprintk("RPC: reading %s XID %08x\n",
989 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
991 ntohl(transport->tcp_xid));
992 xs_tcp_check_fraghdr(transport);
995 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
996 struct xdr_skb_reader *desc)
1003 * We want transport->tcp_offset to be 8 at the end of this routine
1004 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1005 * When this function is called for the first time,
1006 * transport->tcp_offset is 4 (after having already read the xid).
1008 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
1009 len = sizeof(calldir) - offset;
1010 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len);
1011 used = xdr_skb_read_bits(desc, &calldir, len);
1012 transport->tcp_offset += used;
1015 transport->tcp_flags &= ~TCP_RCV_READ_CALLDIR;
1016 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1017 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1019 * We don't yet have the XDR buffer, so we will write the calldir
1020 * out after we get the buffer from the 'struct rpc_rqst'
1022 if (ntohl(calldir) == RPC_REPLY)
1023 transport->tcp_flags |= TCP_RPC_REPLY;
1025 transport->tcp_flags &= ~TCP_RPC_REPLY;
1026 dprintk("RPC: reading %s CALL/REPLY flag %08x\n",
1027 (transport->tcp_flags & TCP_RPC_REPLY) ?
1028 "reply for" : "request with", calldir);
1029 xs_tcp_check_fraghdr(transport);
1032 static inline void xs_tcp_read_common(struct rpc_xprt *xprt,
1033 struct xdr_skb_reader *desc,
1034 struct rpc_rqst *req)
1036 struct sock_xprt *transport =
1037 container_of(xprt, struct sock_xprt, xprt);
1038 struct xdr_buf *rcvbuf;
1042 rcvbuf = &req->rq_private_buf;
1044 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
1046 * Save the RPC direction in the XDR buffer
1048 __be32 calldir = transport->tcp_flags & TCP_RPC_REPLY ?
1049 htonl(RPC_REPLY) : 0;
1051 memcpy(rcvbuf->head[0].iov_base + transport->tcp_copied,
1052 &calldir, sizeof(calldir));
1053 transport->tcp_copied += sizeof(calldir);
1054 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
1058 if (len > transport->tcp_reclen - transport->tcp_offset) {
1059 struct xdr_skb_reader my_desc;
1061 len = transport->tcp_reclen - transport->tcp_offset;
1062 memcpy(&my_desc, desc, sizeof(my_desc));
1063 my_desc.count = len;
1064 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1065 &my_desc, xdr_skb_read_bits);
1069 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1070 desc, xdr_skb_read_bits);
1073 transport->tcp_copied += r;
1074 transport->tcp_offset += r;
1077 /* Error when copying to the receive buffer,
1078 * usually because we weren't able to allocate
1079 * additional buffer pages. All we can do now
1080 * is turn off TCP_RCV_COPY_DATA, so the request
1081 * will not receive any additional updates,
1083 * Any remaining data from this record will
1086 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1087 dprintk("RPC: XID %08x truncated request\n",
1088 ntohl(transport->tcp_xid));
1089 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1090 "tcp_offset = %u, tcp_reclen = %u\n",
1091 xprt, transport->tcp_copied,
1092 transport->tcp_offset, transport->tcp_reclen);
1096 dprintk("RPC: XID %08x read %Zd bytes\n",
1097 ntohl(transport->tcp_xid), r);
1098 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1099 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1100 transport->tcp_offset, transport->tcp_reclen);
1102 if (transport->tcp_copied == req->rq_private_buf.buflen)
1103 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1104 else if (transport->tcp_offset == transport->tcp_reclen) {
1105 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1106 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1113 * Finds the request corresponding to the RPC xid and invokes the common
1114 * tcp read code to read the data.
1116 static inline int xs_tcp_read_reply(struct rpc_xprt *xprt,
1117 struct xdr_skb_reader *desc)
1119 struct sock_xprt *transport =
1120 container_of(xprt, struct sock_xprt, xprt);
1121 struct rpc_rqst *req;
1123 dprintk("RPC: read reply XID %08x\n", ntohl(transport->tcp_xid));
1125 /* Find and lock the request corresponding to this xid */
1126 spin_lock(&xprt->transport_lock);
1127 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1129 dprintk("RPC: XID %08x request not found!\n",
1130 ntohl(transport->tcp_xid));
1131 spin_unlock(&xprt->transport_lock);
1135 xs_tcp_read_common(xprt, desc, req);
1137 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1138 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1140 spin_unlock(&xprt->transport_lock);
1144 #if defined(CONFIG_NFS_V4_1)
1146 * Obtains an rpc_rqst previously allocated and invokes the common
1147 * tcp read code to read the data. The result is placed in the callback
1149 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1150 * connection and return -1.
1152 static inline int xs_tcp_read_callback(struct rpc_xprt *xprt,
1153 struct xdr_skb_reader *desc)
1155 struct sock_xprt *transport =
1156 container_of(xprt, struct sock_xprt, xprt);
1157 struct rpc_rqst *req;
1159 req = xprt_alloc_bc_request(xprt);
1161 printk(KERN_WARNING "Callback slot table overflowed\n");
1162 xprt_force_disconnect(xprt);
1166 req->rq_xid = transport->tcp_xid;
1167 dprintk("RPC: read callback XID %08x\n", ntohl(req->rq_xid));
1168 xs_tcp_read_common(xprt, desc, req);
1170 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA)) {
1171 struct svc_serv *bc_serv = xprt->bc_serv;
1174 * Add callback request to callback list. The callback
1175 * service sleeps on the sv_cb_waitq waiting for new
1176 * requests. Wake it up after adding enqueing the
1179 dprintk("RPC: add callback request to list\n");
1180 spin_lock(&bc_serv->sv_cb_lock);
1181 list_add(&req->rq_bc_list, &bc_serv->sv_cb_list);
1182 spin_unlock(&bc_serv->sv_cb_lock);
1183 wake_up(&bc_serv->sv_cb_waitq);
1186 req->rq_private_buf.len = transport->tcp_copied;
1191 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1192 struct xdr_skb_reader *desc)
1194 struct sock_xprt *transport =
1195 container_of(xprt, struct sock_xprt, xprt);
1197 return (transport->tcp_flags & TCP_RPC_REPLY) ?
1198 xs_tcp_read_reply(xprt, desc) :
1199 xs_tcp_read_callback(xprt, desc);
1202 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1203 struct xdr_skb_reader *desc)
1205 return xs_tcp_read_reply(xprt, desc);
1207 #endif /* CONFIG_NFS_V4_1 */
1210 * Read data off the transport. This can be either an RPC_CALL or an
1211 * RPC_REPLY. Relay the processing to helper functions.
1213 static void xs_tcp_read_data(struct rpc_xprt *xprt,
1214 struct xdr_skb_reader *desc)
1216 struct sock_xprt *transport =
1217 container_of(xprt, struct sock_xprt, xprt);
1219 if (_xs_tcp_read_data(xprt, desc) == 0)
1220 xs_tcp_check_fraghdr(transport);
1223 * The transport_lock protects the request handling.
1224 * There's no need to hold it to update the tcp_flags.
1226 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1230 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1234 len = transport->tcp_reclen - transport->tcp_offset;
1235 if (len > desc->count)
1238 desc->offset += len;
1239 transport->tcp_offset += len;
1240 dprintk("RPC: discarded %Zu bytes\n", len);
1241 xs_tcp_check_fraghdr(transport);
1244 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1246 struct rpc_xprt *xprt = rd_desc->arg.data;
1247 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1248 struct xdr_skb_reader desc = {
1254 dprintk("RPC: xs_tcp_data_recv started\n");
1256 /* Read in a new fragment marker if necessary */
1257 /* Can we ever really expect to get completely empty fragments? */
1258 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1259 xs_tcp_read_fraghdr(xprt, &desc);
1262 /* Read in the xid if necessary */
1263 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1264 xs_tcp_read_xid(transport, &desc);
1267 /* Read in the call/reply flag */
1268 if (transport->tcp_flags & TCP_RCV_READ_CALLDIR) {
1269 xs_tcp_read_calldir(transport, &desc);
1272 /* Read in the request data */
1273 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1274 xs_tcp_read_data(xprt, &desc);
1277 /* Skip over any trailing bytes on short reads */
1278 xs_tcp_read_discard(transport, &desc);
1279 } while (desc.count);
1280 dprintk("RPC: xs_tcp_data_recv done\n");
1281 return len - desc.count;
1285 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1286 * @sk: socket with data to read
1287 * @bytes: how much data to read
1290 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1292 struct rpc_xprt *xprt;
1293 read_descriptor_t rd_desc;
1296 dprintk("RPC: xs_tcp_data_ready...\n");
1298 read_lock(&sk->sk_callback_lock);
1299 if (!(xprt = xprt_from_sock(sk)))
1304 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1305 rd_desc.arg.data = xprt;
1307 rd_desc.count = 65536;
1308 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1311 read_unlock(&sk->sk_callback_lock);
1315 * Do the equivalent of linger/linger2 handling for dealing with
1316 * broken servers that don't close the socket in a timely
1319 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt *xprt,
1320 unsigned long timeout)
1322 struct sock_xprt *transport;
1324 if (xprt_test_and_set_connecting(xprt))
1326 set_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1327 transport = container_of(xprt, struct sock_xprt, xprt);
1328 queue_delayed_work(rpciod_workqueue, &transport->connect_worker,
1332 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt *xprt)
1334 struct sock_xprt *transport;
1336 transport = container_of(xprt, struct sock_xprt, xprt);
1338 if (!test_bit(XPRT_CONNECTION_ABORT, &xprt->state) ||
1339 !cancel_delayed_work(&transport->connect_worker))
1341 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1342 xprt_clear_connecting(xprt);
1345 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
1347 smp_mb__before_clear_bit();
1348 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1349 clear_bit(XPRT_CLOSING, &xprt->state);
1350 smp_mb__after_clear_bit();
1351 /* Mark transport as closed and wake up all pending tasks */
1352 xprt_disconnect_done(xprt);
1356 * xs_tcp_state_change - callback to handle TCP socket state changes
1357 * @sk: socket whose state has changed
1360 static void xs_tcp_state_change(struct sock *sk)
1362 struct rpc_xprt *xprt;
1364 read_lock(&sk->sk_callback_lock);
1365 if (!(xprt = xprt_from_sock(sk)))
1367 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1368 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
1369 sk->sk_state, xprt_connected(xprt),
1370 sock_flag(sk, SOCK_DEAD),
1371 sock_flag(sk, SOCK_ZAPPED));
1373 switch (sk->sk_state) {
1374 case TCP_ESTABLISHED:
1375 spin_lock_bh(&xprt->transport_lock);
1376 if (!xprt_test_and_set_connected(xprt)) {
1377 struct sock_xprt *transport = container_of(xprt,
1378 struct sock_xprt, xprt);
1380 /* Reset TCP record info */
1381 transport->tcp_offset = 0;
1382 transport->tcp_reclen = 0;
1383 transport->tcp_copied = 0;
1384 transport->tcp_flags =
1385 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1387 xprt_wake_pending_tasks(xprt, -EAGAIN);
1389 spin_unlock_bh(&xprt->transport_lock);
1392 /* The client initiated a shutdown of the socket */
1393 xprt->connect_cookie++;
1394 xprt->reestablish_timeout = 0;
1395 set_bit(XPRT_CLOSING, &xprt->state);
1396 smp_mb__before_clear_bit();
1397 clear_bit(XPRT_CONNECTED, &xprt->state);
1398 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1399 smp_mb__after_clear_bit();
1400 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1402 case TCP_CLOSE_WAIT:
1403 /* The server initiated a shutdown of the socket */
1404 xprt_force_disconnect(xprt);
1406 xprt->connect_cookie++;
1409 * If the server closed down the connection, make sure that
1410 * we back off before reconnecting
1412 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1413 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1416 set_bit(XPRT_CLOSING, &xprt->state);
1417 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1418 smp_mb__before_clear_bit();
1419 clear_bit(XPRT_CONNECTED, &xprt->state);
1420 smp_mb__after_clear_bit();
1423 xs_tcp_cancel_linger_timeout(xprt);
1424 xs_sock_mark_closed(xprt);
1427 read_unlock(&sk->sk_callback_lock);
1431 * xs_error_report - callback mainly for catching socket errors
1434 static void xs_error_report(struct sock *sk)
1436 struct rpc_xprt *xprt;
1438 read_lock(&sk->sk_callback_lock);
1439 if (!(xprt = xprt_from_sock(sk)))
1441 dprintk("RPC: %s client %p...\n"
1443 __func__, xprt, sk->sk_err);
1444 xprt_wake_pending_tasks(xprt, -EAGAIN);
1446 read_unlock(&sk->sk_callback_lock);
1449 static void xs_write_space(struct sock *sk)
1451 struct socket *sock;
1452 struct rpc_xprt *xprt;
1454 if (unlikely(!(sock = sk->sk_socket)))
1456 clear_bit(SOCK_NOSPACE, &sock->flags);
1458 if (unlikely(!(xprt = xprt_from_sock(sk))))
1460 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1463 xprt_write_space(xprt);
1467 * xs_udp_write_space - callback invoked when socket buffer space
1469 * @sk: socket whose state has changed
1471 * Called when more output buffer space is available for this socket.
1472 * We try not to wake our writers until they can make "significant"
1473 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1474 * with a bunch of small requests.
1476 static void xs_udp_write_space(struct sock *sk)
1478 read_lock(&sk->sk_callback_lock);
1480 /* from net/core/sock.c:sock_def_write_space */
1481 if (sock_writeable(sk))
1484 read_unlock(&sk->sk_callback_lock);
1488 * xs_tcp_write_space - callback invoked when socket buffer space
1490 * @sk: socket whose state has changed
1492 * Called when more output buffer space is available for this socket.
1493 * We try not to wake our writers until they can make "significant"
1494 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1495 * with a bunch of small requests.
1497 static void xs_tcp_write_space(struct sock *sk)
1499 read_lock(&sk->sk_callback_lock);
1501 /* from net/core/stream.c:sk_stream_write_space */
1502 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1505 read_unlock(&sk->sk_callback_lock);
1508 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1510 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1511 struct sock *sk = transport->inet;
1513 if (transport->rcvsize) {
1514 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1515 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1517 if (transport->sndsize) {
1518 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1519 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1520 sk->sk_write_space(sk);
1525 * xs_udp_set_buffer_size - set send and receive limits
1526 * @xprt: generic transport
1527 * @sndsize: requested size of send buffer, in bytes
1528 * @rcvsize: requested size of receive buffer, in bytes
1530 * Set socket send and receive buffer size limits.
1532 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1534 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1536 transport->sndsize = 0;
1538 transport->sndsize = sndsize + 1024;
1539 transport->rcvsize = 0;
1541 transport->rcvsize = rcvsize + 1024;
1543 xs_udp_do_set_buffer_size(xprt);
1547 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1548 * @task: task that timed out
1550 * Adjust the congestion window after a retransmit timeout has occurred.
1552 static void xs_udp_timer(struct rpc_task *task)
1554 xprt_adjust_cwnd(task, -ETIMEDOUT);
1557 static unsigned short xs_get_random_port(void)
1559 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1560 unsigned short rand = (unsigned short) net_random() % range;
1561 return rand + xprt_min_resvport;
1565 * xs_set_port - reset the port number in the remote endpoint address
1566 * @xprt: generic transport
1567 * @port: new port number
1570 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1572 struct sockaddr *addr = xs_addr(xprt);
1574 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1576 switch (addr->sa_family) {
1578 ((struct sockaddr_in *)addr)->sin_port = htons(port);
1581 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
1588 static unsigned short xs_get_srcport(struct sock_xprt *transport, struct socket *sock)
1590 unsigned short port = transport->port;
1592 if (port == 0 && transport->xprt.resvport)
1593 port = xs_get_random_port();
1597 static unsigned short xs_next_srcport(struct sock_xprt *transport, struct socket *sock, unsigned short port)
1599 if (transport->port != 0)
1600 transport->port = 0;
1601 if (!transport->xprt.resvport)
1603 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1604 return xprt_max_resvport;
1608 static int xs_bind4(struct sock_xprt *transport, struct socket *sock)
1610 struct sockaddr_in myaddr = {
1611 .sin_family = AF_INET,
1613 struct sockaddr_in *sa;
1615 unsigned short port = xs_get_srcport(transport, sock);
1616 unsigned short last;
1618 sa = (struct sockaddr_in *)&transport->addr;
1619 myaddr.sin_addr = sa->sin_addr;
1621 myaddr.sin_port = htons(port);
1622 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1627 transport->port = port;
1631 port = xs_next_srcport(transport, sock, port);
1634 } while (err == -EADDRINUSE && nloop != 2);
1635 dprintk("RPC: %s %pI4:%u: %s (%d)\n",
1636 __func__, &myaddr.sin_addr,
1637 port, err ? "failed" : "ok", err);
1641 static int xs_bind6(struct sock_xprt *transport, struct socket *sock)
1643 struct sockaddr_in6 myaddr = {
1644 .sin6_family = AF_INET6,
1646 struct sockaddr_in6 *sa;
1648 unsigned short port = xs_get_srcport(transport, sock);
1649 unsigned short last;
1651 sa = (struct sockaddr_in6 *)&transport->addr;
1652 myaddr.sin6_addr = sa->sin6_addr;
1654 myaddr.sin6_port = htons(port);
1655 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1660 transport->port = port;
1664 port = xs_next_srcport(transport, sock, port);
1667 } while (err == -EADDRINUSE && nloop != 2);
1668 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1669 &myaddr.sin6_addr, port, err ? "failed" : "ok", err);
1673 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1674 static struct lock_class_key xs_key[2];
1675 static struct lock_class_key xs_slock_key[2];
1677 static inline void xs_reclassify_socket4(struct socket *sock)
1679 struct sock *sk = sock->sk;
1681 BUG_ON(sock_owned_by_user(sk));
1682 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1683 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1686 static inline void xs_reclassify_socket6(struct socket *sock)
1688 struct sock *sk = sock->sk;
1690 BUG_ON(sock_owned_by_user(sk));
1691 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1692 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1695 static inline void xs_reclassify_socket4(struct socket *sock)
1699 static inline void xs_reclassify_socket6(struct socket *sock)
1704 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1706 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1708 if (!transport->inet) {
1709 struct sock *sk = sock->sk;
1711 write_lock_bh(&sk->sk_callback_lock);
1713 xs_save_old_callbacks(transport, sk);
1715 sk->sk_user_data = xprt;
1716 sk->sk_data_ready = xs_udp_data_ready;
1717 sk->sk_write_space = xs_udp_write_space;
1718 sk->sk_error_report = xs_error_report;
1719 sk->sk_no_check = UDP_CSUM_NORCV;
1720 sk->sk_allocation = GFP_ATOMIC;
1722 xprt_set_connected(xprt);
1724 /* Reset to new socket */
1725 transport->sock = sock;
1726 transport->inet = sk;
1728 write_unlock_bh(&sk->sk_callback_lock);
1730 xs_udp_do_set_buffer_size(xprt);
1734 * xs_udp_connect_worker4 - set up a UDP socket
1735 * @work: RPC transport to connect
1737 * Invoked by a work queue tasklet.
1739 static void xs_udp_connect_worker4(struct work_struct *work)
1741 struct sock_xprt *transport =
1742 container_of(work, struct sock_xprt, connect_worker.work);
1743 struct rpc_xprt *xprt = &transport->xprt;
1744 struct socket *sock = transport->sock;
1745 int err, status = -EIO;
1750 /* Start by resetting any existing state */
1751 xs_reset_transport(transport);
1753 err = sock_create_kern(PF_INET, SOCK_DGRAM, IPPROTO_UDP, &sock);
1755 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1758 xs_reclassify_socket4(sock);
1760 if (xs_bind4(transport, sock)) {
1765 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1766 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1768 xs_udp_finish_connecting(xprt, sock);
1771 xprt_clear_connecting(xprt);
1772 xprt_wake_pending_tasks(xprt, status);
1776 * xs_udp_connect_worker6 - set up a UDP socket
1777 * @work: RPC transport to connect
1779 * Invoked by a work queue tasklet.
1781 static void xs_udp_connect_worker6(struct work_struct *work)
1783 struct sock_xprt *transport =
1784 container_of(work, struct sock_xprt, connect_worker.work);
1785 struct rpc_xprt *xprt = &transport->xprt;
1786 struct socket *sock = transport->sock;
1787 int err, status = -EIO;
1792 /* Start by resetting any existing state */
1793 xs_reset_transport(transport);
1795 err = sock_create_kern(PF_INET6, SOCK_DGRAM, IPPROTO_UDP, &sock);
1797 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1800 xs_reclassify_socket6(sock);
1802 if (xs_bind6(transport, sock) < 0) {
1807 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1808 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1810 xs_udp_finish_connecting(xprt, sock);
1813 xprt_clear_connecting(xprt);
1814 xprt_wake_pending_tasks(xprt, status);
1818 * We need to preserve the port number so the reply cache on the server can
1819 * find our cached RPC replies when we get around to reconnecting.
1821 static void xs_abort_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1824 struct sockaddr any;
1826 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt);
1829 * Disconnect the transport socket by doing a connect operation
1830 * with AF_UNSPEC. This should return immediately...
1832 memset(&any, 0, sizeof(any));
1833 any.sa_family = AF_UNSPEC;
1834 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
1836 xs_sock_mark_closed(xprt);
1838 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1842 static void xs_tcp_reuse_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1844 unsigned int state = transport->inet->sk_state;
1846 if (state == TCP_CLOSE && transport->sock->state == SS_UNCONNECTED)
1848 if ((1 << state) & (TCPF_ESTABLISHED|TCPF_SYN_SENT))
1850 xs_abort_connection(xprt, transport);
1853 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1855 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1857 if (!transport->inet) {
1858 struct sock *sk = sock->sk;
1860 write_lock_bh(&sk->sk_callback_lock);
1862 xs_save_old_callbacks(transport, sk);
1864 sk->sk_user_data = xprt;
1865 sk->sk_data_ready = xs_tcp_data_ready;
1866 sk->sk_state_change = xs_tcp_state_change;
1867 sk->sk_write_space = xs_tcp_write_space;
1868 sk->sk_error_report = xs_error_report;
1869 sk->sk_allocation = GFP_ATOMIC;
1871 /* socket options */
1872 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
1873 sock_reset_flag(sk, SOCK_LINGER);
1874 tcp_sk(sk)->linger2 = 0;
1875 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
1877 xprt_clear_connected(xprt);
1879 /* Reset to new socket */
1880 transport->sock = sock;
1881 transport->inet = sk;
1883 write_unlock_bh(&sk->sk_callback_lock);
1886 if (!xprt_bound(xprt))
1889 /* Tell the socket layer to start connecting... */
1890 xprt->stat.connect_count++;
1891 xprt->stat.connect_start = jiffies;
1892 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
1896 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
1897 * @xprt: RPC transport to connect
1898 * @transport: socket transport to connect
1899 * @create_sock: function to create a socket of the correct type
1901 * Invoked by a work queue tasklet.
1903 static void xs_tcp_setup_socket(struct rpc_xprt *xprt,
1904 struct sock_xprt *transport,
1905 struct socket *(*create_sock)(struct rpc_xprt *,
1906 struct sock_xprt *))
1908 struct socket *sock = transport->sock;
1915 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1916 sock = create_sock(xprt, transport);
1918 status = PTR_ERR(sock);
1924 abort_and_exit = test_and_clear_bit(XPRT_CONNECTION_ABORT,
1926 /* "close" the socket, preserving the local port */
1927 xs_tcp_reuse_connection(xprt, transport);
1933 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1934 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1936 status = xs_tcp_finish_connecting(xprt, sock);
1937 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1938 xprt, -status, xprt_connected(xprt),
1939 sock->sk->sk_state);
1942 printk("%s: connect returned unhandled error %d\n",
1944 case -EADDRNOTAVAIL:
1945 /* We're probably in TIME_WAIT. Get rid of existing socket,
1948 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1949 xprt_force_disconnect(xprt);
1954 /* retry with existing socket, after a delay */
1958 xprt_clear_connecting(xprt);
1964 xprt_clear_connecting(xprt);
1965 xprt_wake_pending_tasks(xprt, status);
1968 static struct socket *xs_create_tcp_sock4(struct rpc_xprt *xprt,
1969 struct sock_xprt *transport)
1971 struct socket *sock;
1974 /* start from scratch */
1975 err = sock_create_kern(PF_INET, SOCK_STREAM, IPPROTO_TCP, &sock);
1977 dprintk("RPC: can't create TCP transport socket (%d).\n",
1981 xs_reclassify_socket4(sock);
1983 if (xs_bind4(transport, sock) < 0) {
1989 return ERR_PTR(-EIO);
1993 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1994 * @work: RPC transport to connect
1996 * Invoked by a work queue tasklet.
1998 static void xs_tcp_connect_worker4(struct work_struct *work)
2000 struct sock_xprt *transport =
2001 container_of(work, struct sock_xprt, connect_worker.work);
2002 struct rpc_xprt *xprt = &transport->xprt;
2004 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock4);
2007 static struct socket *xs_create_tcp_sock6(struct rpc_xprt *xprt,
2008 struct sock_xprt *transport)
2010 struct socket *sock;
2013 /* start from scratch */
2014 err = sock_create_kern(PF_INET6, SOCK_STREAM, IPPROTO_TCP, &sock);
2016 dprintk("RPC: can't create TCP transport socket (%d).\n",
2020 xs_reclassify_socket6(sock);
2022 if (xs_bind6(transport, sock) < 0) {
2028 return ERR_PTR(-EIO);
2032 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
2033 * @work: RPC transport to connect
2035 * Invoked by a work queue tasklet.
2037 static void xs_tcp_connect_worker6(struct work_struct *work)
2039 struct sock_xprt *transport =
2040 container_of(work, struct sock_xprt, connect_worker.work);
2041 struct rpc_xprt *xprt = &transport->xprt;
2043 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock6);
2047 * xs_connect - connect a socket to a remote endpoint
2048 * @task: address of RPC task that manages state of connect request
2050 * TCP: If the remote end dropped the connection, delay reconnecting.
2052 * UDP socket connects are synchronous, but we use a work queue anyway
2053 * to guarantee that even unprivileged user processes can set up a
2054 * socket on a privileged port.
2056 * If a UDP socket connect fails, the delay behavior here prevents
2057 * retry floods (hard mounts).
2059 static void xs_connect(struct rpc_task *task)
2061 struct rpc_xprt *xprt = task->tk_xprt;
2062 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2064 if (xprt_test_and_set_connecting(xprt))
2067 if (transport->sock != NULL) {
2068 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2070 xprt, xprt->reestablish_timeout / HZ);
2071 queue_delayed_work(rpciod_workqueue,
2072 &transport->connect_worker,
2073 xprt->reestablish_timeout);
2074 xprt->reestablish_timeout <<= 1;
2075 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
2076 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
2078 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2079 queue_delayed_work(rpciod_workqueue,
2080 &transport->connect_worker, 0);
2084 static void xs_tcp_connect(struct rpc_task *task)
2086 struct rpc_xprt *xprt = task->tk_xprt;
2088 /* Exit if we need to wait for socket shutdown to complete */
2089 if (test_bit(XPRT_CLOSING, &xprt->state))
2095 * xs_udp_print_stats - display UDP socket-specifc stats
2096 * @xprt: rpc_xprt struct containing statistics
2100 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2102 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2104 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
2106 xprt->stat.bind_count,
2109 xprt->stat.bad_xids,
2111 xprt->stat.bklog_u);
2115 * xs_tcp_print_stats - display TCP socket-specifc stats
2116 * @xprt: rpc_xprt struct containing statistics
2120 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2122 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2125 if (xprt_connected(xprt))
2126 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2128 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
2130 xprt->stat.bind_count,
2131 xprt->stat.connect_count,
2132 xprt->stat.connect_time,
2136 xprt->stat.bad_xids,
2138 xprt->stat.bklog_u);
2141 static struct rpc_xprt_ops xs_udp_ops = {
2142 .set_buffer_size = xs_udp_set_buffer_size,
2143 .reserve_xprt = xprt_reserve_xprt_cong,
2144 .release_xprt = xprt_release_xprt_cong,
2145 .rpcbind = rpcb_getport_async,
2146 .set_port = xs_set_port,
2147 .connect = xs_connect,
2148 .buf_alloc = rpc_malloc,
2149 .buf_free = rpc_free,
2150 .send_request = xs_udp_send_request,
2151 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2152 .timer = xs_udp_timer,
2153 .release_request = xprt_release_rqst_cong,
2155 .destroy = xs_destroy,
2156 .print_stats = xs_udp_print_stats,
2159 static struct rpc_xprt_ops xs_tcp_ops = {
2160 .reserve_xprt = xprt_reserve_xprt,
2161 .release_xprt = xs_tcp_release_xprt,
2162 .rpcbind = rpcb_getport_async,
2163 .set_port = xs_set_port,
2164 .connect = xs_tcp_connect,
2165 .buf_alloc = rpc_malloc,
2166 .buf_free = rpc_free,
2167 .send_request = xs_tcp_send_request,
2168 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2169 #if defined(CONFIG_NFS_V4_1)
2170 .release_request = bc_release_request,
2171 #endif /* CONFIG_NFS_V4_1 */
2172 .close = xs_tcp_close,
2173 .destroy = xs_destroy,
2174 .print_stats = xs_tcp_print_stats,
2177 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2178 unsigned int slot_table_size)
2180 struct rpc_xprt *xprt;
2181 struct sock_xprt *new;
2183 if (args->addrlen > sizeof(xprt->addr)) {
2184 dprintk("RPC: xs_setup_xprt: address too large\n");
2185 return ERR_PTR(-EBADF);
2188 new = kzalloc(sizeof(*new), GFP_KERNEL);
2190 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2192 return ERR_PTR(-ENOMEM);
2196 xprt->max_reqs = slot_table_size;
2197 xprt->slot = kcalloc(xprt->max_reqs, sizeof(struct rpc_rqst), GFP_KERNEL);
2198 if (xprt->slot == NULL) {
2200 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
2202 return ERR_PTR(-ENOMEM);
2205 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2206 xprt->addrlen = args->addrlen;
2208 memcpy(&new->addr, args->srcaddr, args->addrlen);
2213 static const struct rpc_timeout xs_udp_default_timeout = {
2214 .to_initval = 5 * HZ,
2215 .to_maxval = 30 * HZ,
2216 .to_increment = 5 * HZ,
2221 * xs_setup_udp - Set up transport to use a UDP socket
2222 * @args: rpc transport creation arguments
2225 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2227 struct sockaddr *addr = args->dstaddr;
2228 struct rpc_xprt *xprt;
2229 struct sock_xprt *transport;
2231 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries);
2234 transport = container_of(xprt, struct sock_xprt, xprt);
2236 xprt->prot = IPPROTO_UDP;
2238 /* XXX: header size can vary due to auth type, IPv6, etc. */
2239 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2241 xprt->bind_timeout = XS_BIND_TO;
2242 xprt->connect_timeout = XS_UDP_CONN_TO;
2243 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2244 xprt->idle_timeout = XS_IDLE_DISC_TO;
2246 xprt->ops = &xs_udp_ops;
2248 xprt->timeout = &xs_udp_default_timeout;
2250 switch (addr->sa_family) {
2252 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2253 xprt_set_bound(xprt);
2255 INIT_DELAYED_WORK(&transport->connect_worker,
2256 xs_udp_connect_worker4);
2257 xs_format_ipv4_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2260 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2261 xprt_set_bound(xprt);
2263 INIT_DELAYED_WORK(&transport->connect_worker,
2264 xs_udp_connect_worker6);
2265 xs_format_ipv6_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2269 return ERR_PTR(-EAFNOSUPPORT);
2272 dprintk("RPC: set up transport to address %s\n",
2273 xprt->address_strings[RPC_DISPLAY_ALL]);
2275 if (try_module_get(THIS_MODULE))
2280 return ERR_PTR(-EINVAL);
2283 static const struct rpc_timeout xs_tcp_default_timeout = {
2284 .to_initval = 60 * HZ,
2285 .to_maxval = 60 * HZ,
2290 * xs_setup_tcp - Set up transport to use a TCP socket
2291 * @args: rpc transport creation arguments
2294 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2296 struct sockaddr *addr = args->dstaddr;
2297 struct rpc_xprt *xprt;
2298 struct sock_xprt *transport;
2300 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries);
2303 transport = container_of(xprt, struct sock_xprt, xprt);
2305 xprt->prot = IPPROTO_TCP;
2306 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2307 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2309 xprt->bind_timeout = XS_BIND_TO;
2310 xprt->connect_timeout = XS_TCP_CONN_TO;
2311 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2312 xprt->idle_timeout = XS_IDLE_DISC_TO;
2314 xprt->ops = &xs_tcp_ops;
2315 xprt->timeout = &xs_tcp_default_timeout;
2317 switch (addr->sa_family) {
2319 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2320 xprt_set_bound(xprt);
2322 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker4);
2323 xs_format_ipv4_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2326 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2327 xprt_set_bound(xprt);
2329 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker6);
2330 xs_format_ipv6_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2334 return ERR_PTR(-EAFNOSUPPORT);
2337 dprintk("RPC: set up transport to address %s\n",
2338 xprt->address_strings[RPC_DISPLAY_ALL]);
2340 if (try_module_get(THIS_MODULE))
2345 return ERR_PTR(-EINVAL);
2348 static struct xprt_class xs_udp_transport = {
2349 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2351 .owner = THIS_MODULE,
2352 .ident = IPPROTO_UDP,
2353 .setup = xs_setup_udp,
2356 static struct xprt_class xs_tcp_transport = {
2357 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2359 .owner = THIS_MODULE,
2360 .ident = IPPROTO_TCP,
2361 .setup = xs_setup_tcp,
2365 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2368 int init_socket_xprt(void)
2371 if (!sunrpc_table_header)
2372 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2375 xprt_register_transport(&xs_udp_transport);
2376 xprt_register_transport(&xs_tcp_transport);
2382 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2385 void cleanup_socket_xprt(void)
2388 if (sunrpc_table_header) {
2389 unregister_sysctl_table(sunrpc_table_header);
2390 sunrpc_table_header = NULL;
2394 xprt_unregister_transport(&xs_udp_transport);
2395 xprt_unregister_transport(&xs_tcp_transport);