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>
39 #include <net/checksum.h>
46 unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
47 unsigned int xprt_tcp_slot_table_entries = RPC_DEF_SLOT_TABLE;
49 unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
50 unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
53 * We can register our own files under /proc/sys/sunrpc by
54 * calling register_sysctl_table() again. The files in that
55 * directory become the union of all files registered there.
57 * We simply need to make sure that we don't collide with
58 * someone else's file names!
63 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
64 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
65 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
66 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
68 static struct ctl_table_header *sunrpc_table_header;
71 * FIXME: changing the UDP slot table size should also resize the UDP
72 * socket buffers for existing UDP transports
74 static ctl_table xs_tunables_table[] = {
76 .ctl_name = CTL_SLOTTABLE_UDP,
77 .procname = "udp_slot_table_entries",
78 .data = &xprt_udp_slot_table_entries,
79 .maxlen = sizeof(unsigned int),
81 .proc_handler = &proc_dointvec_minmax,
82 .strategy = &sysctl_intvec,
83 .extra1 = &min_slot_table_size,
84 .extra2 = &max_slot_table_size
87 .ctl_name = CTL_SLOTTABLE_TCP,
88 .procname = "tcp_slot_table_entries",
89 .data = &xprt_tcp_slot_table_entries,
90 .maxlen = sizeof(unsigned int),
92 .proc_handler = &proc_dointvec_minmax,
93 .strategy = &sysctl_intvec,
94 .extra1 = &min_slot_table_size,
95 .extra2 = &max_slot_table_size
98 .ctl_name = CTL_MIN_RESVPORT,
99 .procname = "min_resvport",
100 .data = &xprt_min_resvport,
101 .maxlen = sizeof(unsigned int),
103 .proc_handler = &proc_dointvec_minmax,
104 .strategy = &sysctl_intvec,
105 .extra1 = &xprt_min_resvport_limit,
106 .extra2 = &xprt_max_resvport_limit
109 .ctl_name = CTL_MAX_RESVPORT,
110 .procname = "max_resvport",
111 .data = &xprt_max_resvport,
112 .maxlen = sizeof(unsigned int),
114 .proc_handler = &proc_dointvec_minmax,
115 .strategy = &sysctl_intvec,
116 .extra1 = &xprt_min_resvport_limit,
117 .extra2 = &xprt_max_resvport_limit
124 static ctl_table sunrpc_table[] = {
126 .ctl_name = CTL_SUNRPC,
127 .procname = "sunrpc",
129 .child = xs_tunables_table
139 * Time out for an RPC UDP socket connect. UDP socket connects are
140 * synchronous, but we set a timeout anyway in case of resource
141 * exhaustion on the local host.
143 #define XS_UDP_CONN_TO (5U * HZ)
146 * Wait duration for an RPC TCP connection to be established. Solaris
147 * NFS over TCP uses 60 seconds, for example, which is in line with how
148 * long a server takes to reboot.
150 #define XS_TCP_CONN_TO (60U * HZ)
153 * Wait duration for a reply from the RPC portmapper.
155 #define XS_BIND_TO (60U * HZ)
158 * Delay if a UDP socket connect error occurs. This is most likely some
159 * kind of resource problem on the local host.
161 #define XS_UDP_REEST_TO (2U * HZ)
164 * The reestablish timeout allows clients to delay for a bit before attempting
165 * to reconnect to a server that just dropped our connection.
167 * We implement an exponential backoff when trying to reestablish a TCP
168 * transport connection with the server. Some servers like to drop a TCP
169 * connection when they are overworked, so we start with a short timeout and
170 * increase over time if the server is down or not responding.
172 #define XS_TCP_INIT_REEST_TO (3U * HZ)
173 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
176 * TCP idle timeout; client drops the transport socket if it is idle
177 * for this long. Note that we also timeout UDP sockets to prevent
178 * holding port numbers when there is no RPC traffic.
180 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
183 # undef RPC_DEBUG_DATA
184 # define RPCDBG_FACILITY RPCDBG_TRANS
187 #ifdef RPC_DEBUG_DATA
188 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
190 u8 *buf = (u8 *) packet;
193 dprintk("RPC: %s\n", msg);
194 for (j = 0; j < count && j < 128; j += 4) {
198 dprintk("0x%04x ", j);
200 dprintk("%02x%02x%02x%02x ",
201 buf[j], buf[j+1], buf[j+2], buf[j+3]);
206 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
213 struct rpc_xprt xprt;
218 struct socket * sock;
222 * State of TCP reply receive
230 unsigned long tcp_copied,
234 * Connection of transports
236 struct delayed_work connect_worker;
237 struct sockaddr_storage addr;
241 * UDP socket buffer size parameters
247 * Saved socket callback addresses
249 void (*old_data_ready)(struct sock *, int);
250 void (*old_state_change)(struct sock *);
251 void (*old_write_space)(struct sock *);
252 void (*old_error_report)(struct sock *);
256 * TCP receive state flags
258 #define TCP_RCV_LAST_FRAG (1UL << 0)
259 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
260 #define TCP_RCV_COPY_XID (1UL << 2)
261 #define TCP_RCV_COPY_DATA (1UL << 3)
263 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
265 return (struct sockaddr *) &xprt->addr;
268 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
270 return (struct sockaddr_in *) &xprt->addr;
273 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
275 return (struct sockaddr_in6 *) &xprt->addr;
278 static void xs_format_ipv4_peer_addresses(struct rpc_xprt *xprt,
279 const char *protocol,
282 struct sockaddr_in *addr = xs_addr_in(xprt);
285 buf = kzalloc(20, GFP_KERNEL);
287 snprintf(buf, 20, "%pI4", &addr->sin_addr.s_addr);
289 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
291 buf = kzalloc(8, GFP_KERNEL);
293 snprintf(buf, 8, "%u",
294 ntohs(addr->sin_port));
296 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
298 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
300 buf = kzalloc(48, GFP_KERNEL);
302 snprintf(buf, 48, "addr=%pI4 port=%u proto=%s",
303 &addr->sin_addr.s_addr,
304 ntohs(addr->sin_port),
307 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
309 buf = kzalloc(10, GFP_KERNEL);
311 snprintf(buf, 10, "%02x%02x%02x%02x",
312 NIPQUAD(addr->sin_addr.s_addr));
314 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
316 buf = kzalloc(8, GFP_KERNEL);
318 snprintf(buf, 8, "%4hx",
319 ntohs(addr->sin_port));
321 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
323 buf = kzalloc(30, GFP_KERNEL);
325 snprintf(buf, 30, "%pI4.%u.%u",
326 &addr->sin_addr.s_addr,
327 ntohs(addr->sin_port) >> 8,
328 ntohs(addr->sin_port) & 0xff);
330 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
332 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
335 static void xs_format_ipv6_peer_addresses(struct rpc_xprt *xprt,
336 const char *protocol,
339 struct sockaddr_in6 *addr = xs_addr_in6(xprt);
342 buf = kzalloc(40, GFP_KERNEL);
344 snprintf(buf, 40, "%pI6",&addr->sin6_addr);
346 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
348 buf = kzalloc(8, GFP_KERNEL);
350 snprintf(buf, 8, "%u",
351 ntohs(addr->sin6_port));
353 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
355 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
357 buf = kzalloc(64, GFP_KERNEL);
359 snprintf(buf, 64, "addr=%pI6 port=%u proto=%s",
361 ntohs(addr->sin6_port),
364 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
366 buf = kzalloc(36, GFP_KERNEL);
368 snprintf(buf, 36, "%pi6", &addr->sin6_addr);
370 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
372 buf = kzalloc(8, GFP_KERNEL);
374 snprintf(buf, 8, "%4hx",
375 ntohs(addr->sin6_port));
377 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
379 buf = kzalloc(50, GFP_KERNEL);
381 snprintf(buf, 50, "%pI6.%u.%u",
383 ntohs(addr->sin6_port) >> 8,
384 ntohs(addr->sin6_port) & 0xff);
386 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
388 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
391 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
395 for (i = 0; i < RPC_DISPLAY_MAX; i++)
397 case RPC_DISPLAY_PROTO:
398 case RPC_DISPLAY_NETID:
401 kfree(xprt->address_strings[i]);
405 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
407 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
409 struct msghdr msg = {
411 .msg_namelen = addrlen,
412 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
415 .iov_base = vec->iov_base + base,
416 .iov_len = vec->iov_len - base,
419 if (iov.iov_len != 0)
420 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
421 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
424 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more)
427 unsigned int remainder;
430 remainder = xdr->page_len - base;
431 base += xdr->page_base;
432 ppage = xdr->pages + (base >> PAGE_SHIFT);
435 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
436 int flags = XS_SENDMSG_FLAGS;
439 if (remainder != 0 || more)
441 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
442 if (remainder == 0 || err != len)
456 * xs_sendpages - write pages directly to a socket
457 * @sock: socket to send on
458 * @addr: UDP only -- address of destination
459 * @addrlen: UDP only -- length of destination address
460 * @xdr: buffer containing this request
461 * @base: starting position in the buffer
464 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
466 unsigned int remainder = xdr->len - base;
472 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
478 if (base < xdr->head[0].iov_len || addr != NULL) {
479 unsigned int len = xdr->head[0].iov_len - base;
481 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
482 if (remainder == 0 || err != len)
487 base -= xdr->head[0].iov_len;
489 if (base < xdr->page_len) {
490 unsigned int len = xdr->page_len - base;
492 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
493 if (remainder == 0 || err != len)
498 base -= xdr->page_len;
500 if (base >= xdr->tail[0].iov_len)
502 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
511 static void xs_nospace_callback(struct rpc_task *task)
513 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
515 transport->inet->sk_write_pending--;
516 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
520 * xs_nospace - place task on wait queue if transmit was incomplete
521 * @task: task to put to sleep
524 static void xs_nospace(struct rpc_task *task)
526 struct rpc_rqst *req = task->tk_rqstp;
527 struct rpc_xprt *xprt = req->rq_xprt;
528 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
530 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
531 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
534 /* Protect against races with write_space */
535 spin_lock_bh(&xprt->transport_lock);
537 /* Don't race with disconnect */
538 if (xprt_connected(xprt)) {
539 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
541 * Notify TCP that we're limited by the application
544 set_bit(SOCK_NOSPACE, &transport->sock->flags);
545 transport->inet->sk_write_pending++;
546 /* ...and wait for more buffer space */
547 xprt_wait_for_buffer_space(task, xs_nospace_callback);
550 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
551 task->tk_status = -ENOTCONN;
554 spin_unlock_bh(&xprt->transport_lock);
558 * xs_udp_send_request - write an RPC request to a UDP socket
559 * @task: address of RPC task that manages the state of an RPC request
562 * 0: The request has been sent
563 * EAGAIN: The socket was blocked, please call again later to
564 * complete the request
565 * ENOTCONN: Caller needs to invoke connect logic then call again
566 * other: Some other error occured, the request was not sent
568 static int xs_udp_send_request(struct rpc_task *task)
570 struct rpc_rqst *req = task->tk_rqstp;
571 struct rpc_xprt *xprt = req->rq_xprt;
572 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
573 struct xdr_buf *xdr = &req->rq_snd_buf;
576 xs_pktdump("packet data:",
577 req->rq_svec->iov_base,
578 req->rq_svec->iov_len);
580 status = xs_sendpages(transport->sock,
585 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
586 xdr->len - req->rq_bytes_sent, status);
589 task->tk_bytes_sent += status;
590 if (status >= req->rq_slen)
592 /* Still some bytes left; set up for a retry later. */
603 /* When the server has died, an ICMP port unreachable message
604 * prompts ECONNREFUSED. */
605 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
608 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
609 dprintk("RPC: sendmsg returned unrecognized error %d\n",
617 * xs_tcp_shutdown - gracefully shut down a TCP socket
620 * Initiates a graceful shutdown of the TCP socket by calling the
621 * equivalent of shutdown(SHUT_WR);
623 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
625 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
626 struct socket *sock = transport->sock;
629 kernel_sock_shutdown(sock, SHUT_WR);
632 static inline void xs_encode_tcp_record_marker(struct xdr_buf *buf)
634 u32 reclen = buf->len - sizeof(rpc_fraghdr);
635 rpc_fraghdr *base = buf->head[0].iov_base;
636 *base = htonl(RPC_LAST_STREAM_FRAGMENT | reclen);
640 * xs_tcp_send_request - write an RPC request to a TCP socket
641 * @task: address of RPC task that manages the state of an RPC request
644 * 0: The request has been sent
645 * EAGAIN: The socket was blocked, please call again later to
646 * complete the request
647 * ENOTCONN: Caller needs to invoke connect logic then call again
648 * other: Some other error occured, the request was not sent
650 * XXX: In the case of soft timeouts, should we eventually give up
651 * if sendmsg is not able to make progress?
653 static int xs_tcp_send_request(struct rpc_task *task)
655 struct rpc_rqst *req = task->tk_rqstp;
656 struct rpc_xprt *xprt = req->rq_xprt;
657 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
658 struct xdr_buf *xdr = &req->rq_snd_buf;
661 xs_encode_tcp_record_marker(&req->rq_snd_buf);
663 xs_pktdump("packet data:",
664 req->rq_svec->iov_base,
665 req->rq_svec->iov_len);
667 /* Continue transmitting the packet/record. We must be careful
668 * to cope with writespace callbacks arriving _after_ we have
669 * called sendmsg(). */
671 status = xs_sendpages(transport->sock,
672 NULL, 0, xdr, req->rq_bytes_sent);
674 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
675 xdr->len - req->rq_bytes_sent, status);
677 if (unlikely(status < 0))
680 /* If we've sent the entire packet, immediately
681 * reset the count of bytes sent. */
682 req->rq_bytes_sent += status;
683 task->tk_bytes_sent += status;
684 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
685 req->rq_bytes_sent = 0;
700 xs_tcp_shutdown(xprt);
705 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
708 dprintk("RPC: sendmsg returned unrecognized error %d\n",
710 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
711 xs_tcp_shutdown(xprt);
718 * xs_tcp_release_xprt - clean up after a tcp transmission
722 * This cleans up if an error causes us to abort the transmission of a request.
723 * In this case, the socket may need to be reset in order to avoid confusing
726 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
728 struct rpc_rqst *req;
730 if (task != xprt->snd_task)
734 req = task->tk_rqstp;
735 if (req->rq_bytes_sent == 0)
737 if (req->rq_bytes_sent == req->rq_snd_buf.len)
739 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
741 xprt_release_xprt(xprt, task);
744 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
746 transport->old_data_ready = sk->sk_data_ready;
747 transport->old_state_change = sk->sk_state_change;
748 transport->old_write_space = sk->sk_write_space;
749 transport->old_error_report = sk->sk_error_report;
752 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
754 sk->sk_data_ready = transport->old_data_ready;
755 sk->sk_state_change = transport->old_state_change;
756 sk->sk_write_space = transport->old_write_space;
757 sk->sk_error_report = transport->old_error_report;
761 * xs_close - close a socket
764 * This is used when all requests are complete; ie, no DRC state remains
765 * on the server we want to save.
767 static void xs_close(struct rpc_xprt *xprt)
769 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
770 struct socket *sock = transport->sock;
771 struct sock *sk = transport->inet;
774 goto clear_close_wait;
776 dprintk("RPC: xs_close xprt %p\n", xprt);
778 write_lock_bh(&sk->sk_callback_lock);
779 transport->inet = NULL;
780 transport->sock = NULL;
782 sk->sk_user_data = NULL;
784 xs_restore_old_callbacks(transport, sk);
785 write_unlock_bh(&sk->sk_callback_lock);
791 smp_mb__before_clear_bit();
792 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
793 clear_bit(XPRT_CLOSING, &xprt->state);
794 smp_mb__after_clear_bit();
795 xprt_disconnect_done(xprt);
799 * xs_destroy - prepare to shutdown a transport
800 * @xprt: doomed transport
803 static void xs_destroy(struct rpc_xprt *xprt)
805 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
807 dprintk("RPC: xs_destroy xprt %p\n", xprt);
809 cancel_rearming_delayed_work(&transport->connect_worker);
812 xs_free_peer_addresses(xprt);
815 module_put(THIS_MODULE);
818 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
820 return (struct rpc_xprt *) sk->sk_user_data;
824 * xs_udp_data_ready - "data ready" callback for UDP sockets
825 * @sk: socket with data to read
826 * @len: how much data to read
829 static void xs_udp_data_ready(struct sock *sk, int len)
831 struct rpc_task *task;
832 struct rpc_xprt *xprt;
833 struct rpc_rqst *rovr;
835 int err, repsize, copied;
839 read_lock(&sk->sk_callback_lock);
840 dprintk("RPC: xs_udp_data_ready...\n");
841 if (!(xprt = xprt_from_sock(sk)))
844 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
850 repsize = skb->len - sizeof(struct udphdr);
852 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
856 /* Copy the XID from the skb... */
857 xp = skb_header_pointer(skb, sizeof(struct udphdr),
858 sizeof(_xid), &_xid);
862 /* Look up and lock the request corresponding to the given XID */
863 spin_lock(&xprt->transport_lock);
864 rovr = xprt_lookup_rqst(xprt, *xp);
867 task = rovr->rq_task;
869 if ((copied = rovr->rq_private_buf.buflen) > repsize)
872 /* Suck it into the iovec, verify checksum if not done by hw. */
873 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
874 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
878 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
880 /* Something worked... */
881 dst_confirm(skb->dst);
883 xprt_adjust_cwnd(task, copied);
884 xprt_update_rtt(task);
885 xprt_complete_rqst(task, copied);
888 spin_unlock(&xprt->transport_lock);
890 skb_free_datagram(sk, skb);
892 read_unlock(&sk->sk_callback_lock);
895 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
897 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
901 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
902 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
903 used = xdr_skb_read_bits(desc, p, len);
904 transport->tcp_offset += used;
908 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
909 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
910 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
912 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
913 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
915 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
916 transport->tcp_offset = 0;
918 /* Sanity check of the record length */
919 if (unlikely(transport->tcp_reclen < 4)) {
920 dprintk("RPC: invalid TCP record fragment length\n");
921 xprt_force_disconnect(xprt);
924 dprintk("RPC: reading TCP record fragment of length %d\n",
925 transport->tcp_reclen);
928 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
930 if (transport->tcp_offset == transport->tcp_reclen) {
931 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
932 transport->tcp_offset = 0;
933 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
934 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
935 transport->tcp_flags |= TCP_RCV_COPY_XID;
936 transport->tcp_copied = 0;
941 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
946 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
947 dprintk("RPC: reading XID (%Zu bytes)\n", len);
948 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
949 used = xdr_skb_read_bits(desc, p, len);
950 transport->tcp_offset += used;
953 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
954 transport->tcp_flags |= TCP_RCV_COPY_DATA;
955 transport->tcp_copied = 4;
956 dprintk("RPC: reading reply for XID %08x\n",
957 ntohl(transport->tcp_xid));
958 xs_tcp_check_fraghdr(transport);
961 static inline void xs_tcp_read_request(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
963 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
964 struct rpc_rqst *req;
965 struct xdr_buf *rcvbuf;
969 /* Find and lock the request corresponding to this xid */
970 spin_lock(&xprt->transport_lock);
971 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
973 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
974 dprintk("RPC: XID %08x request not found!\n",
975 ntohl(transport->tcp_xid));
976 spin_unlock(&xprt->transport_lock);
980 rcvbuf = &req->rq_private_buf;
982 if (len > transport->tcp_reclen - transport->tcp_offset) {
983 struct xdr_skb_reader my_desc;
985 len = transport->tcp_reclen - transport->tcp_offset;
986 memcpy(&my_desc, desc, sizeof(my_desc));
988 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
989 &my_desc, xdr_skb_read_bits);
993 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
994 desc, xdr_skb_read_bits);
997 transport->tcp_copied += r;
998 transport->tcp_offset += r;
1001 /* Error when copying to the receive buffer,
1002 * usually because we weren't able to allocate
1003 * additional buffer pages. All we can do now
1004 * is turn off TCP_RCV_COPY_DATA, so the request
1005 * will not receive any additional updates,
1007 * Any remaining data from this record will
1010 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1011 dprintk("RPC: XID %08x truncated request\n",
1012 ntohl(transport->tcp_xid));
1013 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1014 "tcp_offset = %u, tcp_reclen = %u\n",
1015 xprt, transport->tcp_copied,
1016 transport->tcp_offset, transport->tcp_reclen);
1020 dprintk("RPC: XID %08x read %Zd bytes\n",
1021 ntohl(transport->tcp_xid), r);
1022 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1023 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1024 transport->tcp_offset, transport->tcp_reclen);
1026 if (transport->tcp_copied == req->rq_private_buf.buflen)
1027 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1028 else if (transport->tcp_offset == transport->tcp_reclen) {
1029 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1030 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1034 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1035 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1036 spin_unlock(&xprt->transport_lock);
1037 xs_tcp_check_fraghdr(transport);
1040 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1044 len = transport->tcp_reclen - transport->tcp_offset;
1045 if (len > desc->count)
1048 desc->offset += len;
1049 transport->tcp_offset += len;
1050 dprintk("RPC: discarded %Zu bytes\n", len);
1051 xs_tcp_check_fraghdr(transport);
1054 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1056 struct rpc_xprt *xprt = rd_desc->arg.data;
1057 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1058 struct xdr_skb_reader desc = {
1064 dprintk("RPC: xs_tcp_data_recv started\n");
1066 /* Read in a new fragment marker if necessary */
1067 /* Can we ever really expect to get completely empty fragments? */
1068 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1069 xs_tcp_read_fraghdr(xprt, &desc);
1072 /* Read in the xid if necessary */
1073 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1074 xs_tcp_read_xid(transport, &desc);
1077 /* Read in the request data */
1078 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1079 xs_tcp_read_request(xprt, &desc);
1082 /* Skip over any trailing bytes on short reads */
1083 xs_tcp_read_discard(transport, &desc);
1084 } while (desc.count);
1085 dprintk("RPC: xs_tcp_data_recv done\n");
1086 return len - desc.count;
1090 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1091 * @sk: socket with data to read
1092 * @bytes: how much data to read
1095 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1097 struct rpc_xprt *xprt;
1098 read_descriptor_t rd_desc;
1101 dprintk("RPC: xs_tcp_data_ready...\n");
1103 read_lock(&sk->sk_callback_lock);
1104 if (!(xprt = xprt_from_sock(sk)))
1109 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1110 rd_desc.arg.data = xprt;
1112 rd_desc.count = 65536;
1113 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1116 read_unlock(&sk->sk_callback_lock);
1120 * xs_tcp_state_change - callback to handle TCP socket state changes
1121 * @sk: socket whose state has changed
1124 static void xs_tcp_state_change(struct sock *sk)
1126 struct rpc_xprt *xprt;
1128 read_lock(&sk->sk_callback_lock);
1129 if (!(xprt = xprt_from_sock(sk)))
1131 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1132 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
1133 sk->sk_state, xprt_connected(xprt),
1134 sock_flag(sk, SOCK_DEAD),
1135 sock_flag(sk, SOCK_ZAPPED));
1137 switch (sk->sk_state) {
1138 case TCP_ESTABLISHED:
1139 spin_lock_bh(&xprt->transport_lock);
1140 if (!xprt_test_and_set_connected(xprt)) {
1141 struct sock_xprt *transport = container_of(xprt,
1142 struct sock_xprt, xprt);
1144 /* Reset TCP record info */
1145 transport->tcp_offset = 0;
1146 transport->tcp_reclen = 0;
1147 transport->tcp_copied = 0;
1148 transport->tcp_flags =
1149 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1151 xprt_wake_pending_tasks(xprt, 0);
1153 spin_unlock_bh(&xprt->transport_lock);
1156 /* The client initiated a shutdown of the socket */
1157 xprt->connect_cookie++;
1158 xprt->reestablish_timeout = 0;
1159 set_bit(XPRT_CLOSING, &xprt->state);
1160 smp_mb__before_clear_bit();
1161 clear_bit(XPRT_CONNECTED, &xprt->state);
1162 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1163 smp_mb__after_clear_bit();
1165 case TCP_CLOSE_WAIT:
1166 /* The server initiated a shutdown of the socket */
1167 set_bit(XPRT_CLOSING, &xprt->state);
1168 xprt_force_disconnect(xprt);
1170 xprt->connect_cookie++;
1173 * If the server closed down the connection, make sure that
1174 * we back off before reconnecting
1176 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1177 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1180 smp_mb__before_clear_bit();
1181 clear_bit(XPRT_CONNECTED, &xprt->state);
1182 smp_mb__after_clear_bit();
1185 smp_mb__before_clear_bit();
1186 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1187 clear_bit(XPRT_CLOSING, &xprt->state);
1188 smp_mb__after_clear_bit();
1189 /* Mark transport as closed and wake up all pending tasks */
1190 xprt_disconnect_done(xprt);
1193 read_unlock(&sk->sk_callback_lock);
1197 * xs_tcp_error_report - callback mainly for catching RST events
1200 static void xs_tcp_error_report(struct sock *sk)
1202 struct rpc_xprt *xprt;
1204 read_lock(&sk->sk_callback_lock);
1205 if (sk->sk_err != ECONNRESET || sk->sk_state != TCP_ESTABLISHED)
1207 if (!(xprt = xprt_from_sock(sk)))
1209 dprintk("RPC: %s client %p...\n"
1211 __func__, xprt, sk->sk_err);
1213 xprt_force_disconnect(xprt);
1215 read_unlock(&sk->sk_callback_lock);
1218 static void xs_write_space(struct sock *sk)
1220 struct socket *sock;
1221 struct rpc_xprt *xprt;
1223 if (unlikely(!(sock = sk->sk_socket)))
1225 clear_bit(SOCK_NOSPACE, &sock->flags);
1227 if (unlikely(!(xprt = xprt_from_sock(sk))))
1229 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1232 xprt_write_space(xprt);
1236 * xs_udp_write_space - callback invoked when socket buffer space
1238 * @sk: socket whose state has changed
1240 * Called when more output buffer space is available for this socket.
1241 * We try not to wake our writers until they can make "significant"
1242 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1243 * with a bunch of small requests.
1245 static void xs_udp_write_space(struct sock *sk)
1247 read_lock(&sk->sk_callback_lock);
1249 /* from net/core/sock.c:sock_def_write_space */
1250 if (sock_writeable(sk))
1253 read_unlock(&sk->sk_callback_lock);
1257 * xs_tcp_write_space - callback invoked when socket buffer space
1259 * @sk: socket whose state has changed
1261 * Called when more output buffer space is available for this socket.
1262 * We try not to wake our writers until they can make "significant"
1263 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1264 * with a bunch of small requests.
1266 static void xs_tcp_write_space(struct sock *sk)
1268 read_lock(&sk->sk_callback_lock);
1270 /* from net/core/stream.c:sk_stream_write_space */
1271 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1274 read_unlock(&sk->sk_callback_lock);
1277 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1279 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1280 struct sock *sk = transport->inet;
1282 if (transport->rcvsize) {
1283 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1284 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1286 if (transport->sndsize) {
1287 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1288 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1289 sk->sk_write_space(sk);
1294 * xs_udp_set_buffer_size - set send and receive limits
1295 * @xprt: generic transport
1296 * @sndsize: requested size of send buffer, in bytes
1297 * @rcvsize: requested size of receive buffer, in bytes
1299 * Set socket send and receive buffer size limits.
1301 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1303 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1305 transport->sndsize = 0;
1307 transport->sndsize = sndsize + 1024;
1308 transport->rcvsize = 0;
1310 transport->rcvsize = rcvsize + 1024;
1312 xs_udp_do_set_buffer_size(xprt);
1316 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1317 * @task: task that timed out
1319 * Adjust the congestion window after a retransmit timeout has occurred.
1321 static void xs_udp_timer(struct rpc_task *task)
1323 xprt_adjust_cwnd(task, -ETIMEDOUT);
1326 static unsigned short xs_get_random_port(void)
1328 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1329 unsigned short rand = (unsigned short) net_random() % range;
1330 return rand + xprt_min_resvport;
1334 * xs_set_port - reset the port number in the remote endpoint address
1335 * @xprt: generic transport
1336 * @port: new port number
1339 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1341 struct sockaddr *addr = xs_addr(xprt);
1343 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1345 switch (addr->sa_family) {
1347 ((struct sockaddr_in *)addr)->sin_port = htons(port);
1350 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
1357 static unsigned short xs_get_srcport(struct sock_xprt *transport, struct socket *sock)
1359 unsigned short port = transport->port;
1361 if (port == 0 && transport->xprt.resvport)
1362 port = xs_get_random_port();
1366 static unsigned short xs_next_srcport(struct sock_xprt *transport, struct socket *sock, unsigned short port)
1368 if (transport->port != 0)
1369 transport->port = 0;
1370 if (!transport->xprt.resvport)
1372 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1373 return xprt_max_resvport;
1377 static int xs_bind4(struct sock_xprt *transport, struct socket *sock)
1379 struct sockaddr_in myaddr = {
1380 .sin_family = AF_INET,
1382 struct sockaddr_in *sa;
1384 unsigned short port = xs_get_srcport(transport, sock);
1385 unsigned short last;
1387 sa = (struct sockaddr_in *)&transport->addr;
1388 myaddr.sin_addr = sa->sin_addr;
1390 myaddr.sin_port = htons(port);
1391 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1396 transport->port = port;
1400 port = xs_next_srcport(transport, sock, port);
1403 } while (err == -EADDRINUSE && nloop != 2);
1404 dprintk("RPC: %s %pI4:%u: %s (%d)\n",
1405 __func__, &myaddr.sin_addr,
1406 port, err ? "failed" : "ok", err);
1410 static int xs_bind6(struct sock_xprt *transport, struct socket *sock)
1412 struct sockaddr_in6 myaddr = {
1413 .sin6_family = AF_INET6,
1415 struct sockaddr_in6 *sa;
1417 unsigned short port = xs_get_srcport(transport, sock);
1418 unsigned short last;
1420 sa = (struct sockaddr_in6 *)&transport->addr;
1421 myaddr.sin6_addr = sa->sin6_addr;
1423 myaddr.sin6_port = htons(port);
1424 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1429 transport->port = port;
1433 port = xs_next_srcport(transport, sock, port);
1436 } while (err == -EADDRINUSE && nloop != 2);
1437 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1438 &myaddr.sin6_addr, port, err ? "failed" : "ok", err);
1442 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1443 static struct lock_class_key xs_key[2];
1444 static struct lock_class_key xs_slock_key[2];
1446 static inline void xs_reclassify_socket4(struct socket *sock)
1448 struct sock *sk = sock->sk;
1450 BUG_ON(sock_owned_by_user(sk));
1451 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1452 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1455 static inline void xs_reclassify_socket6(struct socket *sock)
1457 struct sock *sk = sock->sk;
1459 BUG_ON(sock_owned_by_user(sk));
1460 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1461 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1464 static inline void xs_reclassify_socket4(struct socket *sock)
1468 static inline void xs_reclassify_socket6(struct socket *sock)
1473 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1475 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1477 if (!transport->inet) {
1478 struct sock *sk = sock->sk;
1480 write_lock_bh(&sk->sk_callback_lock);
1482 xs_save_old_callbacks(transport, sk);
1484 sk->sk_user_data = xprt;
1485 sk->sk_data_ready = xs_udp_data_ready;
1486 sk->sk_write_space = xs_udp_write_space;
1487 sk->sk_no_check = UDP_CSUM_NORCV;
1488 sk->sk_allocation = GFP_ATOMIC;
1490 xprt_set_connected(xprt);
1492 /* Reset to new socket */
1493 transport->sock = sock;
1494 transport->inet = sk;
1496 write_unlock_bh(&sk->sk_callback_lock);
1498 xs_udp_do_set_buffer_size(xprt);
1502 * xs_udp_connect_worker4 - set up a UDP socket
1503 * @work: RPC transport to connect
1505 * Invoked by a work queue tasklet.
1507 static void xs_udp_connect_worker4(struct work_struct *work)
1509 struct sock_xprt *transport =
1510 container_of(work, struct sock_xprt, connect_worker.work);
1511 struct rpc_xprt *xprt = &transport->xprt;
1512 struct socket *sock = transport->sock;
1513 int err, status = -EIO;
1515 if (xprt->shutdown || !xprt_bound(xprt))
1518 /* Start by resetting any existing state */
1521 if ((err = sock_create_kern(PF_INET, SOCK_DGRAM, IPPROTO_UDP, &sock)) < 0) {
1522 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1525 xs_reclassify_socket4(sock);
1527 if (xs_bind4(transport, sock)) {
1532 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1533 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1535 xs_udp_finish_connecting(xprt, sock);
1538 xprt_wake_pending_tasks(xprt, status);
1539 xprt_clear_connecting(xprt);
1543 * xs_udp_connect_worker6 - set up a UDP socket
1544 * @work: RPC transport to connect
1546 * Invoked by a work queue tasklet.
1548 static void xs_udp_connect_worker6(struct work_struct *work)
1550 struct sock_xprt *transport =
1551 container_of(work, struct sock_xprt, connect_worker.work);
1552 struct rpc_xprt *xprt = &transport->xprt;
1553 struct socket *sock = transport->sock;
1554 int err, status = -EIO;
1556 if (xprt->shutdown || !xprt_bound(xprt))
1559 /* Start by resetting any existing state */
1562 if ((err = sock_create_kern(PF_INET6, SOCK_DGRAM, IPPROTO_UDP, &sock)) < 0) {
1563 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1566 xs_reclassify_socket6(sock);
1568 if (xs_bind6(transport, sock) < 0) {
1573 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1574 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1576 xs_udp_finish_connecting(xprt, sock);
1579 xprt_wake_pending_tasks(xprt, status);
1580 xprt_clear_connecting(xprt);
1584 * We need to preserve the port number so the reply cache on the server can
1585 * find our cached RPC replies when we get around to reconnecting.
1587 static void xs_tcp_reuse_connection(struct rpc_xprt *xprt)
1590 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1591 struct sockaddr any;
1593 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt);
1596 * Disconnect the transport socket by doing a connect operation
1597 * with AF_UNSPEC. This should return immediately...
1599 memset(&any, 0, sizeof(any));
1600 any.sa_family = AF_UNSPEC;
1601 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
1603 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1607 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1609 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1611 if (!transport->inet) {
1612 struct sock *sk = sock->sk;
1614 write_lock_bh(&sk->sk_callback_lock);
1616 xs_save_old_callbacks(transport, sk);
1618 sk->sk_user_data = xprt;
1619 sk->sk_data_ready = xs_tcp_data_ready;
1620 sk->sk_state_change = xs_tcp_state_change;
1621 sk->sk_write_space = xs_tcp_write_space;
1622 sk->sk_error_report = xs_tcp_error_report;
1623 sk->sk_allocation = GFP_ATOMIC;
1625 /* socket options */
1626 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
1627 sock_reset_flag(sk, SOCK_LINGER);
1628 tcp_sk(sk)->linger2 = 0;
1629 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
1631 xprt_clear_connected(xprt);
1633 /* Reset to new socket */
1634 transport->sock = sock;
1635 transport->inet = sk;
1637 write_unlock_bh(&sk->sk_callback_lock);
1640 /* Tell the socket layer to start connecting... */
1641 xprt->stat.connect_count++;
1642 xprt->stat.connect_start = jiffies;
1643 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
1647 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1648 * @work: RPC transport to connect
1650 * Invoked by a work queue tasklet.
1652 static void xs_tcp_connect_worker4(struct work_struct *work)
1654 struct sock_xprt *transport =
1655 container_of(work, struct sock_xprt, connect_worker.work);
1656 struct rpc_xprt *xprt = &transport->xprt;
1657 struct socket *sock = transport->sock;
1658 int err, status = -EIO;
1660 if (xprt->shutdown || !xprt_bound(xprt))
1664 /* start from scratch */
1665 if ((err = sock_create_kern(PF_INET, SOCK_STREAM, IPPROTO_TCP, &sock)) < 0) {
1666 dprintk("RPC: can't create TCP transport socket (%d).\n", -err);
1669 xs_reclassify_socket4(sock);
1671 if (xs_bind4(transport, sock) < 0) {
1676 /* "close" the socket, preserving the local port */
1677 xs_tcp_reuse_connection(xprt);
1679 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1680 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1682 status = xs_tcp_finish_connecting(xprt, sock);
1683 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1684 xprt, -status, xprt_connected(xprt),
1685 sock->sk->sk_state);
1693 /* retry with existing socket, after a delay */
1696 /* get rid of existing socket, and retry */
1697 xs_tcp_shutdown(xprt);
1701 xprt_wake_pending_tasks(xprt, status);
1703 xprt_clear_connecting(xprt);
1707 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
1708 * @work: RPC transport to connect
1710 * Invoked by a work queue tasklet.
1712 static void xs_tcp_connect_worker6(struct work_struct *work)
1714 struct sock_xprt *transport =
1715 container_of(work, struct sock_xprt, connect_worker.work);
1716 struct rpc_xprt *xprt = &transport->xprt;
1717 struct socket *sock = transport->sock;
1718 int err, status = -EIO;
1720 if (xprt->shutdown || !xprt_bound(xprt))
1724 /* start from scratch */
1725 if ((err = sock_create_kern(PF_INET6, SOCK_STREAM, IPPROTO_TCP, &sock)) < 0) {
1726 dprintk("RPC: can't create TCP transport socket (%d).\n", -err);
1729 xs_reclassify_socket6(sock);
1731 if (xs_bind6(transport, sock) < 0) {
1736 /* "close" the socket, preserving the local port */
1737 xs_tcp_reuse_connection(xprt);
1739 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1740 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1742 status = xs_tcp_finish_connecting(xprt, sock);
1743 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1744 xprt, -status, xprt_connected(xprt), sock->sk->sk_state);
1752 /* retry with existing socket, after a delay */
1755 /* get rid of existing socket, and retry */
1756 xs_tcp_shutdown(xprt);
1760 xprt_wake_pending_tasks(xprt, status);
1762 xprt_clear_connecting(xprt);
1766 * xs_connect - connect a socket to a remote endpoint
1767 * @task: address of RPC task that manages state of connect request
1769 * TCP: If the remote end dropped the connection, delay reconnecting.
1771 * UDP socket connects are synchronous, but we use a work queue anyway
1772 * to guarantee that even unprivileged user processes can set up a
1773 * socket on a privileged port.
1775 * If a UDP socket connect fails, the delay behavior here prevents
1776 * retry floods (hard mounts).
1778 static void xs_connect(struct rpc_task *task)
1780 struct rpc_xprt *xprt = task->tk_xprt;
1781 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1783 if (xprt_test_and_set_connecting(xprt))
1786 if (transport->sock != NULL) {
1787 dprintk("RPC: xs_connect delayed xprt %p for %lu "
1789 xprt, xprt->reestablish_timeout / HZ);
1790 queue_delayed_work(rpciod_workqueue,
1791 &transport->connect_worker,
1792 xprt->reestablish_timeout);
1793 xprt->reestablish_timeout <<= 1;
1794 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
1795 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
1797 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
1798 queue_delayed_work(rpciod_workqueue,
1799 &transport->connect_worker, 0);
1803 static void xs_tcp_connect(struct rpc_task *task)
1805 struct rpc_xprt *xprt = task->tk_xprt;
1807 /* Initiate graceful shutdown of the socket if not already done */
1808 if (test_bit(XPRT_CONNECTED, &xprt->state))
1809 xs_tcp_shutdown(xprt);
1810 /* Exit if we need to wait for socket shutdown to complete */
1811 if (test_bit(XPRT_CLOSING, &xprt->state))
1817 * xs_udp_print_stats - display UDP socket-specifc stats
1818 * @xprt: rpc_xprt struct containing statistics
1822 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
1824 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1826 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
1828 xprt->stat.bind_count,
1831 xprt->stat.bad_xids,
1833 xprt->stat.bklog_u);
1837 * xs_tcp_print_stats - display TCP socket-specifc stats
1838 * @xprt: rpc_xprt struct containing statistics
1842 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
1844 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1847 if (xprt_connected(xprt))
1848 idle_time = (long)(jiffies - xprt->last_used) / HZ;
1850 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
1852 xprt->stat.bind_count,
1853 xprt->stat.connect_count,
1854 xprt->stat.connect_time,
1858 xprt->stat.bad_xids,
1860 xprt->stat.bklog_u);
1863 static struct rpc_xprt_ops xs_udp_ops = {
1864 .set_buffer_size = xs_udp_set_buffer_size,
1865 .reserve_xprt = xprt_reserve_xprt_cong,
1866 .release_xprt = xprt_release_xprt_cong,
1867 .rpcbind = rpcb_getport_async,
1868 .set_port = xs_set_port,
1869 .connect = xs_connect,
1870 .buf_alloc = rpc_malloc,
1871 .buf_free = rpc_free,
1872 .send_request = xs_udp_send_request,
1873 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
1874 .timer = xs_udp_timer,
1875 .release_request = xprt_release_rqst_cong,
1877 .destroy = xs_destroy,
1878 .print_stats = xs_udp_print_stats,
1881 static struct rpc_xprt_ops xs_tcp_ops = {
1882 .reserve_xprt = xprt_reserve_xprt,
1883 .release_xprt = xs_tcp_release_xprt,
1884 .rpcbind = rpcb_getport_async,
1885 .set_port = xs_set_port,
1886 .connect = xs_tcp_connect,
1887 .buf_alloc = rpc_malloc,
1888 .buf_free = rpc_free,
1889 .send_request = xs_tcp_send_request,
1890 .set_retrans_timeout = xprt_set_retrans_timeout_def,
1891 .close = xs_tcp_shutdown,
1892 .destroy = xs_destroy,
1893 .print_stats = xs_tcp_print_stats,
1896 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
1897 unsigned int slot_table_size)
1899 struct rpc_xprt *xprt;
1900 struct sock_xprt *new;
1902 if (args->addrlen > sizeof(xprt->addr)) {
1903 dprintk("RPC: xs_setup_xprt: address too large\n");
1904 return ERR_PTR(-EBADF);
1907 new = kzalloc(sizeof(*new), GFP_KERNEL);
1909 dprintk("RPC: xs_setup_xprt: couldn't allocate "
1911 return ERR_PTR(-ENOMEM);
1915 xprt->max_reqs = slot_table_size;
1916 xprt->slot = kcalloc(xprt->max_reqs, sizeof(struct rpc_rqst), GFP_KERNEL);
1917 if (xprt->slot == NULL) {
1919 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
1921 return ERR_PTR(-ENOMEM);
1924 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
1925 xprt->addrlen = args->addrlen;
1927 memcpy(&new->addr, args->srcaddr, args->addrlen);
1932 static const struct rpc_timeout xs_udp_default_timeout = {
1933 .to_initval = 5 * HZ,
1934 .to_maxval = 30 * HZ,
1935 .to_increment = 5 * HZ,
1940 * xs_setup_udp - Set up transport to use a UDP socket
1941 * @args: rpc transport creation arguments
1944 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
1946 struct sockaddr *addr = args->dstaddr;
1947 struct rpc_xprt *xprt;
1948 struct sock_xprt *transport;
1950 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries);
1953 transport = container_of(xprt, struct sock_xprt, xprt);
1955 xprt->prot = IPPROTO_UDP;
1957 /* XXX: header size can vary due to auth type, IPv6, etc. */
1958 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
1960 xprt->bind_timeout = XS_BIND_TO;
1961 xprt->connect_timeout = XS_UDP_CONN_TO;
1962 xprt->reestablish_timeout = XS_UDP_REEST_TO;
1963 xprt->idle_timeout = XS_IDLE_DISC_TO;
1965 xprt->ops = &xs_udp_ops;
1967 xprt->timeout = &xs_udp_default_timeout;
1969 switch (addr->sa_family) {
1971 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
1972 xprt_set_bound(xprt);
1974 INIT_DELAYED_WORK(&transport->connect_worker,
1975 xs_udp_connect_worker4);
1976 xs_format_ipv4_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
1979 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
1980 xprt_set_bound(xprt);
1982 INIT_DELAYED_WORK(&transport->connect_worker,
1983 xs_udp_connect_worker6);
1984 xs_format_ipv6_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
1988 return ERR_PTR(-EAFNOSUPPORT);
1991 dprintk("RPC: set up transport to address %s\n",
1992 xprt->address_strings[RPC_DISPLAY_ALL]);
1994 if (try_module_get(THIS_MODULE))
1999 return ERR_PTR(-EINVAL);
2002 static const struct rpc_timeout xs_tcp_default_timeout = {
2003 .to_initval = 60 * HZ,
2004 .to_maxval = 60 * HZ,
2009 * xs_setup_tcp - Set up transport to use a TCP socket
2010 * @args: rpc transport creation arguments
2013 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2015 struct sockaddr *addr = args->dstaddr;
2016 struct rpc_xprt *xprt;
2017 struct sock_xprt *transport;
2019 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries);
2022 transport = container_of(xprt, struct sock_xprt, xprt);
2024 xprt->prot = IPPROTO_TCP;
2025 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2026 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2028 xprt->bind_timeout = XS_BIND_TO;
2029 xprt->connect_timeout = XS_TCP_CONN_TO;
2030 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2031 xprt->idle_timeout = XS_IDLE_DISC_TO;
2033 xprt->ops = &xs_tcp_ops;
2034 xprt->timeout = &xs_tcp_default_timeout;
2036 switch (addr->sa_family) {
2038 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2039 xprt_set_bound(xprt);
2041 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker4);
2042 xs_format_ipv4_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2045 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2046 xprt_set_bound(xprt);
2048 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker6);
2049 xs_format_ipv6_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2053 return ERR_PTR(-EAFNOSUPPORT);
2056 dprintk("RPC: set up transport to address %s\n",
2057 xprt->address_strings[RPC_DISPLAY_ALL]);
2059 if (try_module_get(THIS_MODULE))
2064 return ERR_PTR(-EINVAL);
2067 static struct xprt_class xs_udp_transport = {
2068 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2070 .owner = THIS_MODULE,
2071 .ident = IPPROTO_UDP,
2072 .setup = xs_setup_udp,
2075 static struct xprt_class xs_tcp_transport = {
2076 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2078 .owner = THIS_MODULE,
2079 .ident = IPPROTO_TCP,
2080 .setup = xs_setup_tcp,
2084 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2087 int init_socket_xprt(void)
2090 if (!sunrpc_table_header)
2091 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2094 xprt_register_transport(&xs_udp_transport);
2095 xprt_register_transport(&xs_tcp_transport);
2101 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2104 void cleanup_socket_xprt(void)
2107 if (sunrpc_table_header) {
2108 unregister_sysctl_table(sunrpc_table_header);
2109 sunrpc_table_header = NULL;
2113 xprt_unregister_transport(&xs_udp_transport);
2114 xprt_unregister_transport(&xs_tcp_transport);