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, NIPQUAD_FMT,
288 NIPQUAD(addr->sin_addr.s_addr));
290 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
292 buf = kzalloc(8, GFP_KERNEL);
294 snprintf(buf, 8, "%u",
295 ntohs(addr->sin_port));
297 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
299 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
301 buf = kzalloc(48, GFP_KERNEL);
303 snprintf(buf, 48, "addr="NIPQUAD_FMT" port=%u proto=%s",
304 NIPQUAD(addr->sin_addr.s_addr),
305 ntohs(addr->sin_port),
308 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
310 buf = kzalloc(10, GFP_KERNEL);
312 snprintf(buf, 10, "%02x%02x%02x%02x",
313 NIPQUAD(addr->sin_addr.s_addr));
315 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
317 buf = kzalloc(8, GFP_KERNEL);
319 snprintf(buf, 8, "%4hx",
320 ntohs(addr->sin_port));
322 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
324 buf = kzalloc(30, GFP_KERNEL);
326 snprintf(buf, 30, NIPQUAD_FMT".%u.%u",
327 NIPQUAD(addr->sin_addr.s_addr),
328 ntohs(addr->sin_port) >> 8,
329 ntohs(addr->sin_port) & 0xff);
331 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
333 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
336 static void xs_format_ipv6_peer_addresses(struct rpc_xprt *xprt,
337 const char *protocol,
340 struct sockaddr_in6 *addr = xs_addr_in6(xprt);
343 buf = kzalloc(40, GFP_KERNEL);
345 snprintf(buf, 40, "%pI6",&addr->sin6_addr);
347 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
349 buf = kzalloc(8, GFP_KERNEL);
351 snprintf(buf, 8, "%u",
352 ntohs(addr->sin6_port));
354 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
356 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
358 buf = kzalloc(64, GFP_KERNEL);
360 snprintf(buf, 64, "addr=%pI6 port=%u proto=%s",
362 ntohs(addr->sin6_port),
365 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
367 buf = kzalloc(36, GFP_KERNEL);
369 snprintf(buf, 36, "%pi6", &addr->sin6_addr);
371 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
373 buf = kzalloc(8, GFP_KERNEL);
375 snprintf(buf, 8, "%4hx",
376 ntohs(addr->sin6_port));
378 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
380 buf = kzalloc(50, GFP_KERNEL);
382 snprintf(buf, 50, "%pI6.%u.%u",
384 ntohs(addr->sin6_port) >> 8,
385 ntohs(addr->sin6_port) & 0xff);
387 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
389 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
392 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
396 for (i = 0; i < RPC_DISPLAY_MAX; i++)
398 case RPC_DISPLAY_PROTO:
399 case RPC_DISPLAY_NETID:
402 kfree(xprt->address_strings[i]);
406 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
408 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
410 struct msghdr msg = {
412 .msg_namelen = addrlen,
413 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
416 .iov_base = vec->iov_base + base,
417 .iov_len = vec->iov_len - base,
420 if (iov.iov_len != 0)
421 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
422 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
425 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more)
428 unsigned int remainder;
431 remainder = xdr->page_len - base;
432 base += xdr->page_base;
433 ppage = xdr->pages + (base >> PAGE_SHIFT);
436 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
437 int flags = XS_SENDMSG_FLAGS;
440 if (remainder != 0 || more)
442 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
443 if (remainder == 0 || err != len)
457 * xs_sendpages - write pages directly to a socket
458 * @sock: socket to send on
459 * @addr: UDP only -- address of destination
460 * @addrlen: UDP only -- length of destination address
461 * @xdr: buffer containing this request
462 * @base: starting position in the buffer
465 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
467 unsigned int remainder = xdr->len - base;
473 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
479 if (base < xdr->head[0].iov_len || addr != NULL) {
480 unsigned int len = xdr->head[0].iov_len - base;
482 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
483 if (remainder == 0 || err != len)
488 base -= xdr->head[0].iov_len;
490 if (base < xdr->page_len) {
491 unsigned int len = xdr->page_len - base;
493 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
494 if (remainder == 0 || err != len)
499 base -= xdr->page_len;
501 if (base >= xdr->tail[0].iov_len)
503 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
512 static void xs_nospace_callback(struct rpc_task *task)
514 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
516 transport->inet->sk_write_pending--;
517 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
521 * xs_nospace - place task on wait queue if transmit was incomplete
522 * @task: task to put to sleep
525 static void xs_nospace(struct rpc_task *task)
527 struct rpc_rqst *req = task->tk_rqstp;
528 struct rpc_xprt *xprt = req->rq_xprt;
529 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
531 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
532 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
535 /* Protect against races with write_space */
536 spin_lock_bh(&xprt->transport_lock);
538 /* Don't race with disconnect */
539 if (xprt_connected(xprt)) {
540 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
542 * Notify TCP that we're limited by the application
545 set_bit(SOCK_NOSPACE, &transport->sock->flags);
546 transport->inet->sk_write_pending++;
547 /* ...and wait for more buffer space */
548 xprt_wait_for_buffer_space(task, xs_nospace_callback);
551 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
552 task->tk_status = -ENOTCONN;
555 spin_unlock_bh(&xprt->transport_lock);
559 * xs_udp_send_request - write an RPC request to a UDP socket
560 * @task: address of RPC task that manages the state of an RPC request
563 * 0: The request has been sent
564 * EAGAIN: The socket was blocked, please call again later to
565 * complete the request
566 * ENOTCONN: Caller needs to invoke connect logic then call again
567 * other: Some other error occured, the request was not sent
569 static int xs_udp_send_request(struct rpc_task *task)
571 struct rpc_rqst *req = task->tk_rqstp;
572 struct rpc_xprt *xprt = req->rq_xprt;
573 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
574 struct xdr_buf *xdr = &req->rq_snd_buf;
577 xs_pktdump("packet data:",
578 req->rq_svec->iov_base,
579 req->rq_svec->iov_len);
581 status = xs_sendpages(transport->sock,
586 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
587 xdr->len - req->rq_bytes_sent, status);
590 task->tk_bytes_sent += status;
591 if (status >= req->rq_slen)
593 /* Still some bytes left; set up for a retry later. */
604 /* When the server has died, an ICMP port unreachable message
605 * prompts ECONNREFUSED. */
606 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
609 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
610 dprintk("RPC: sendmsg returned unrecognized error %d\n",
618 * xs_tcp_shutdown - gracefully shut down a TCP socket
621 * Initiates a graceful shutdown of the TCP socket by calling the
622 * equivalent of shutdown(SHUT_WR);
624 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
626 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
627 struct socket *sock = transport->sock;
630 kernel_sock_shutdown(sock, SHUT_WR);
633 static inline void xs_encode_tcp_record_marker(struct xdr_buf *buf)
635 u32 reclen = buf->len - sizeof(rpc_fraghdr);
636 rpc_fraghdr *base = buf->head[0].iov_base;
637 *base = htonl(RPC_LAST_STREAM_FRAGMENT | reclen);
641 * xs_tcp_send_request - write an RPC request to a TCP socket
642 * @task: address of RPC task that manages the state of an RPC request
645 * 0: The request has been sent
646 * EAGAIN: The socket was blocked, please call again later to
647 * complete the request
648 * ENOTCONN: Caller needs to invoke connect logic then call again
649 * other: Some other error occured, the request was not sent
651 * XXX: In the case of soft timeouts, should we eventually give up
652 * if sendmsg is not able to make progress?
654 static int xs_tcp_send_request(struct rpc_task *task)
656 struct rpc_rqst *req = task->tk_rqstp;
657 struct rpc_xprt *xprt = req->rq_xprt;
658 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
659 struct xdr_buf *xdr = &req->rq_snd_buf;
662 xs_encode_tcp_record_marker(&req->rq_snd_buf);
664 xs_pktdump("packet data:",
665 req->rq_svec->iov_base,
666 req->rq_svec->iov_len);
668 /* Continue transmitting the packet/record. We must be careful
669 * to cope with writespace callbacks arriving _after_ we have
670 * called sendmsg(). */
672 status = xs_sendpages(transport->sock,
673 NULL, 0, xdr, req->rq_bytes_sent);
675 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
676 xdr->len - req->rq_bytes_sent, status);
678 if (unlikely(status < 0))
681 /* If we've sent the entire packet, immediately
682 * reset the count of bytes sent. */
683 req->rq_bytes_sent += status;
684 task->tk_bytes_sent += status;
685 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
686 req->rq_bytes_sent = 0;
701 xs_tcp_shutdown(xprt);
706 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
709 dprintk("RPC: sendmsg returned unrecognized error %d\n",
711 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
712 xs_tcp_shutdown(xprt);
719 * xs_tcp_release_xprt - clean up after a tcp transmission
723 * This cleans up if an error causes us to abort the transmission of a request.
724 * In this case, the socket may need to be reset in order to avoid confusing
727 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
729 struct rpc_rqst *req;
731 if (task != xprt->snd_task)
735 req = task->tk_rqstp;
736 if (req->rq_bytes_sent == 0)
738 if (req->rq_bytes_sent == req->rq_snd_buf.len)
740 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
742 xprt_release_xprt(xprt, task);
745 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
747 transport->old_data_ready = sk->sk_data_ready;
748 transport->old_state_change = sk->sk_state_change;
749 transport->old_write_space = sk->sk_write_space;
750 transport->old_error_report = sk->sk_error_report;
753 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
755 sk->sk_data_ready = transport->old_data_ready;
756 sk->sk_state_change = transport->old_state_change;
757 sk->sk_write_space = transport->old_write_space;
758 sk->sk_error_report = transport->old_error_report;
762 * xs_close - close a socket
765 * This is used when all requests are complete; ie, no DRC state remains
766 * on the server we want to save.
768 static void xs_close(struct rpc_xprt *xprt)
770 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
771 struct socket *sock = transport->sock;
772 struct sock *sk = transport->inet;
775 goto clear_close_wait;
777 dprintk("RPC: xs_close xprt %p\n", xprt);
779 write_lock_bh(&sk->sk_callback_lock);
780 transport->inet = NULL;
781 transport->sock = NULL;
783 sk->sk_user_data = NULL;
785 xs_restore_old_callbacks(transport, sk);
786 write_unlock_bh(&sk->sk_callback_lock);
792 smp_mb__before_clear_bit();
793 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
794 clear_bit(XPRT_CLOSING, &xprt->state);
795 smp_mb__after_clear_bit();
796 xprt_disconnect_done(xprt);
800 * xs_destroy - prepare to shutdown a transport
801 * @xprt: doomed transport
804 static void xs_destroy(struct rpc_xprt *xprt)
806 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
808 dprintk("RPC: xs_destroy xprt %p\n", xprt);
810 cancel_rearming_delayed_work(&transport->connect_worker);
813 xs_free_peer_addresses(xprt);
816 module_put(THIS_MODULE);
819 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
821 return (struct rpc_xprt *) sk->sk_user_data;
825 * xs_udp_data_ready - "data ready" callback for UDP sockets
826 * @sk: socket with data to read
827 * @len: how much data to read
830 static void xs_udp_data_ready(struct sock *sk, int len)
832 struct rpc_task *task;
833 struct rpc_xprt *xprt;
834 struct rpc_rqst *rovr;
836 int err, repsize, copied;
840 read_lock(&sk->sk_callback_lock);
841 dprintk("RPC: xs_udp_data_ready...\n");
842 if (!(xprt = xprt_from_sock(sk)))
845 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
851 repsize = skb->len - sizeof(struct udphdr);
853 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
857 /* Copy the XID from the skb... */
858 xp = skb_header_pointer(skb, sizeof(struct udphdr),
859 sizeof(_xid), &_xid);
863 /* Look up and lock the request corresponding to the given XID */
864 spin_lock(&xprt->transport_lock);
865 rovr = xprt_lookup_rqst(xprt, *xp);
868 task = rovr->rq_task;
870 if ((copied = rovr->rq_private_buf.buflen) > repsize)
873 /* Suck it into the iovec, verify checksum if not done by hw. */
874 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
875 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
879 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
881 /* Something worked... */
882 dst_confirm(skb->dst);
884 xprt_adjust_cwnd(task, copied);
885 xprt_update_rtt(task);
886 xprt_complete_rqst(task, copied);
889 spin_unlock(&xprt->transport_lock);
891 skb_free_datagram(sk, skb);
893 read_unlock(&sk->sk_callback_lock);
896 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
898 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
902 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
903 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
904 used = xdr_skb_read_bits(desc, p, len);
905 transport->tcp_offset += used;
909 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
910 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
911 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
913 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
914 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
916 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
917 transport->tcp_offset = 0;
919 /* Sanity check of the record length */
920 if (unlikely(transport->tcp_reclen < 4)) {
921 dprintk("RPC: invalid TCP record fragment length\n");
922 xprt_force_disconnect(xprt);
925 dprintk("RPC: reading TCP record fragment of length %d\n",
926 transport->tcp_reclen);
929 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
931 if (transport->tcp_offset == transport->tcp_reclen) {
932 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
933 transport->tcp_offset = 0;
934 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
935 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
936 transport->tcp_flags |= TCP_RCV_COPY_XID;
937 transport->tcp_copied = 0;
942 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
947 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
948 dprintk("RPC: reading XID (%Zu bytes)\n", len);
949 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
950 used = xdr_skb_read_bits(desc, p, len);
951 transport->tcp_offset += used;
954 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
955 transport->tcp_flags |= TCP_RCV_COPY_DATA;
956 transport->tcp_copied = 4;
957 dprintk("RPC: reading reply for XID %08x\n",
958 ntohl(transport->tcp_xid));
959 xs_tcp_check_fraghdr(transport);
962 static inline void xs_tcp_read_request(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
964 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
965 struct rpc_rqst *req;
966 struct xdr_buf *rcvbuf;
970 /* Find and lock the request corresponding to this xid */
971 spin_lock(&xprt->transport_lock);
972 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
974 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
975 dprintk("RPC: XID %08x request not found!\n",
976 ntohl(transport->tcp_xid));
977 spin_unlock(&xprt->transport_lock);
981 rcvbuf = &req->rq_private_buf;
983 if (len > transport->tcp_reclen - transport->tcp_offset) {
984 struct xdr_skb_reader my_desc;
986 len = transport->tcp_reclen - transport->tcp_offset;
987 memcpy(&my_desc, desc, sizeof(my_desc));
989 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
990 &my_desc, xdr_skb_read_bits);
994 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
995 desc, xdr_skb_read_bits);
998 transport->tcp_copied += r;
999 transport->tcp_offset += r;
1002 /* Error when copying to the receive buffer,
1003 * usually because we weren't able to allocate
1004 * additional buffer pages. All we can do now
1005 * is turn off TCP_RCV_COPY_DATA, so the request
1006 * will not receive any additional updates,
1008 * Any remaining data from this record will
1011 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1012 dprintk("RPC: XID %08x truncated request\n",
1013 ntohl(transport->tcp_xid));
1014 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1015 "tcp_offset = %u, tcp_reclen = %u\n",
1016 xprt, transport->tcp_copied,
1017 transport->tcp_offset, transport->tcp_reclen);
1021 dprintk("RPC: XID %08x read %Zd bytes\n",
1022 ntohl(transport->tcp_xid), r);
1023 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1024 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1025 transport->tcp_offset, transport->tcp_reclen);
1027 if (transport->tcp_copied == req->rq_private_buf.buflen)
1028 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1029 else if (transport->tcp_offset == transport->tcp_reclen) {
1030 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1031 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1035 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1036 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1037 spin_unlock(&xprt->transport_lock);
1038 xs_tcp_check_fraghdr(transport);
1041 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1045 len = transport->tcp_reclen - transport->tcp_offset;
1046 if (len > desc->count)
1049 desc->offset += len;
1050 transport->tcp_offset += len;
1051 dprintk("RPC: discarded %Zu bytes\n", len);
1052 xs_tcp_check_fraghdr(transport);
1055 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1057 struct rpc_xprt *xprt = rd_desc->arg.data;
1058 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1059 struct xdr_skb_reader desc = {
1065 dprintk("RPC: xs_tcp_data_recv started\n");
1067 /* Read in a new fragment marker if necessary */
1068 /* Can we ever really expect to get completely empty fragments? */
1069 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1070 xs_tcp_read_fraghdr(xprt, &desc);
1073 /* Read in the xid if necessary */
1074 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1075 xs_tcp_read_xid(transport, &desc);
1078 /* Read in the request data */
1079 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1080 xs_tcp_read_request(xprt, &desc);
1083 /* Skip over any trailing bytes on short reads */
1084 xs_tcp_read_discard(transport, &desc);
1085 } while (desc.count);
1086 dprintk("RPC: xs_tcp_data_recv done\n");
1087 return len - desc.count;
1091 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1092 * @sk: socket with data to read
1093 * @bytes: how much data to read
1096 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1098 struct rpc_xprt *xprt;
1099 read_descriptor_t rd_desc;
1102 dprintk("RPC: xs_tcp_data_ready...\n");
1104 read_lock(&sk->sk_callback_lock);
1105 if (!(xprt = xprt_from_sock(sk)))
1110 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1111 rd_desc.arg.data = xprt;
1113 rd_desc.count = 65536;
1114 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1117 read_unlock(&sk->sk_callback_lock);
1121 * xs_tcp_state_change - callback to handle TCP socket state changes
1122 * @sk: socket whose state has changed
1125 static void xs_tcp_state_change(struct sock *sk)
1127 struct rpc_xprt *xprt;
1129 read_lock(&sk->sk_callback_lock);
1130 if (!(xprt = xprt_from_sock(sk)))
1132 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1133 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
1134 sk->sk_state, xprt_connected(xprt),
1135 sock_flag(sk, SOCK_DEAD),
1136 sock_flag(sk, SOCK_ZAPPED));
1138 switch (sk->sk_state) {
1139 case TCP_ESTABLISHED:
1140 spin_lock_bh(&xprt->transport_lock);
1141 if (!xprt_test_and_set_connected(xprt)) {
1142 struct sock_xprt *transport = container_of(xprt,
1143 struct sock_xprt, xprt);
1145 /* Reset TCP record info */
1146 transport->tcp_offset = 0;
1147 transport->tcp_reclen = 0;
1148 transport->tcp_copied = 0;
1149 transport->tcp_flags =
1150 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1152 xprt_wake_pending_tasks(xprt, 0);
1154 spin_unlock_bh(&xprt->transport_lock);
1157 /* The client initiated a shutdown of the socket */
1158 xprt->connect_cookie++;
1159 xprt->reestablish_timeout = 0;
1160 set_bit(XPRT_CLOSING, &xprt->state);
1161 smp_mb__before_clear_bit();
1162 clear_bit(XPRT_CONNECTED, &xprt->state);
1163 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1164 smp_mb__after_clear_bit();
1166 case TCP_CLOSE_WAIT:
1167 /* The server initiated a shutdown of the socket */
1168 set_bit(XPRT_CLOSING, &xprt->state);
1169 xprt_force_disconnect(xprt);
1171 xprt->connect_cookie++;
1174 * If the server closed down the connection, make sure that
1175 * we back off before reconnecting
1177 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1178 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1181 smp_mb__before_clear_bit();
1182 clear_bit(XPRT_CONNECTED, &xprt->state);
1183 smp_mb__after_clear_bit();
1186 smp_mb__before_clear_bit();
1187 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1188 clear_bit(XPRT_CLOSING, &xprt->state);
1189 smp_mb__after_clear_bit();
1190 /* Mark transport as closed and wake up all pending tasks */
1191 xprt_disconnect_done(xprt);
1194 read_unlock(&sk->sk_callback_lock);
1198 * xs_tcp_error_report - callback mainly for catching RST events
1201 static void xs_tcp_error_report(struct sock *sk)
1203 struct rpc_xprt *xprt;
1205 read_lock(&sk->sk_callback_lock);
1206 if (sk->sk_err != ECONNRESET || sk->sk_state != TCP_ESTABLISHED)
1208 if (!(xprt = xprt_from_sock(sk)))
1210 dprintk("RPC: %s client %p...\n"
1212 __func__, xprt, sk->sk_err);
1214 xprt_force_disconnect(xprt);
1216 read_unlock(&sk->sk_callback_lock);
1220 * xs_udp_write_space - callback invoked when socket buffer space
1222 * @sk: socket whose state has changed
1224 * Called when more output buffer space is available for this socket.
1225 * We try not to wake our writers until they can make "significant"
1226 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1227 * with a bunch of small requests.
1229 static void xs_udp_write_space(struct sock *sk)
1231 read_lock(&sk->sk_callback_lock);
1233 /* from net/core/sock.c:sock_def_write_space */
1234 if (sock_writeable(sk)) {
1235 struct socket *sock;
1236 struct rpc_xprt *xprt;
1238 if (unlikely(!(sock = sk->sk_socket)))
1240 clear_bit(SOCK_NOSPACE, &sock->flags);
1242 if (unlikely(!(xprt = xprt_from_sock(sk))))
1244 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1247 xprt_write_space(xprt);
1251 read_unlock(&sk->sk_callback_lock);
1255 * xs_tcp_write_space - callback invoked when socket buffer space
1257 * @sk: socket whose state has changed
1259 * Called when more output buffer space is available for this socket.
1260 * We try not to wake our writers until they can make "significant"
1261 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1262 * with a bunch of small requests.
1264 static void xs_tcp_write_space(struct sock *sk)
1266 read_lock(&sk->sk_callback_lock);
1268 /* from net/core/stream.c:sk_stream_write_space */
1269 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk)) {
1270 struct socket *sock;
1271 struct rpc_xprt *xprt;
1273 if (unlikely(!(sock = sk->sk_socket)))
1275 clear_bit(SOCK_NOSPACE, &sock->flags);
1277 if (unlikely(!(xprt = xprt_from_sock(sk))))
1279 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1282 xprt_write_space(xprt);
1286 read_unlock(&sk->sk_callback_lock);
1289 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1291 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1292 struct sock *sk = transport->inet;
1294 if (transport->rcvsize) {
1295 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1296 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1298 if (transport->sndsize) {
1299 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1300 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1301 sk->sk_write_space(sk);
1306 * xs_udp_set_buffer_size - set send and receive limits
1307 * @xprt: generic transport
1308 * @sndsize: requested size of send buffer, in bytes
1309 * @rcvsize: requested size of receive buffer, in bytes
1311 * Set socket send and receive buffer size limits.
1313 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1315 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1317 transport->sndsize = 0;
1319 transport->sndsize = sndsize + 1024;
1320 transport->rcvsize = 0;
1322 transport->rcvsize = rcvsize + 1024;
1324 xs_udp_do_set_buffer_size(xprt);
1328 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1329 * @task: task that timed out
1331 * Adjust the congestion window after a retransmit timeout has occurred.
1333 static void xs_udp_timer(struct rpc_task *task)
1335 xprt_adjust_cwnd(task, -ETIMEDOUT);
1338 static unsigned short xs_get_random_port(void)
1340 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1341 unsigned short rand = (unsigned short) net_random() % range;
1342 return rand + xprt_min_resvport;
1346 * xs_set_port - reset the port number in the remote endpoint address
1347 * @xprt: generic transport
1348 * @port: new port number
1351 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1353 struct sockaddr *addr = xs_addr(xprt);
1355 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1357 switch (addr->sa_family) {
1359 ((struct sockaddr_in *)addr)->sin_port = htons(port);
1362 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
1369 static unsigned short xs_get_srcport(struct sock_xprt *transport, struct socket *sock)
1371 unsigned short port = transport->port;
1373 if (port == 0 && transport->xprt.resvport)
1374 port = xs_get_random_port();
1378 static unsigned short xs_next_srcport(struct sock_xprt *transport, struct socket *sock, unsigned short port)
1380 if (transport->port != 0)
1381 transport->port = 0;
1382 if (!transport->xprt.resvport)
1384 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1385 return xprt_max_resvport;
1389 static int xs_bind4(struct sock_xprt *transport, struct socket *sock)
1391 struct sockaddr_in myaddr = {
1392 .sin_family = AF_INET,
1394 struct sockaddr_in *sa;
1396 unsigned short port = xs_get_srcport(transport, sock);
1397 unsigned short last;
1399 sa = (struct sockaddr_in *)&transport->addr;
1400 myaddr.sin_addr = sa->sin_addr;
1402 myaddr.sin_port = htons(port);
1403 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1408 transport->port = port;
1412 port = xs_next_srcport(transport, sock, port);
1415 } while (err == -EADDRINUSE && nloop != 2);
1416 dprintk("RPC: %s "NIPQUAD_FMT":%u: %s (%d)\n",
1417 __func__, NIPQUAD(myaddr.sin_addr),
1418 port, err ? "failed" : "ok", err);
1422 static int xs_bind6(struct sock_xprt *transport, struct socket *sock)
1424 struct sockaddr_in6 myaddr = {
1425 .sin6_family = AF_INET6,
1427 struct sockaddr_in6 *sa;
1429 unsigned short port = xs_get_srcport(transport, sock);
1430 unsigned short last;
1432 sa = (struct sockaddr_in6 *)&transport->addr;
1433 myaddr.sin6_addr = sa->sin6_addr;
1435 myaddr.sin6_port = htons(port);
1436 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1441 transport->port = port;
1445 port = xs_next_srcport(transport, sock, port);
1448 } while (err == -EADDRINUSE && nloop != 2);
1449 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1450 &myaddr.sin6_addr, port, err ? "failed" : "ok", err);
1454 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1455 static struct lock_class_key xs_key[2];
1456 static struct lock_class_key xs_slock_key[2];
1458 static inline void xs_reclassify_socket4(struct socket *sock)
1460 struct sock *sk = sock->sk;
1462 BUG_ON(sock_owned_by_user(sk));
1463 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1464 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1467 static inline void xs_reclassify_socket6(struct socket *sock)
1469 struct sock *sk = sock->sk;
1471 BUG_ON(sock_owned_by_user(sk));
1472 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1473 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1476 static inline void xs_reclassify_socket4(struct socket *sock)
1480 static inline void xs_reclassify_socket6(struct socket *sock)
1485 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1487 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1489 if (!transport->inet) {
1490 struct sock *sk = sock->sk;
1492 write_lock_bh(&sk->sk_callback_lock);
1494 xs_save_old_callbacks(transport, sk);
1496 sk->sk_user_data = xprt;
1497 sk->sk_data_ready = xs_udp_data_ready;
1498 sk->sk_write_space = xs_udp_write_space;
1499 sk->sk_no_check = UDP_CSUM_NORCV;
1500 sk->sk_allocation = GFP_ATOMIC;
1502 xprt_set_connected(xprt);
1504 /* Reset to new socket */
1505 transport->sock = sock;
1506 transport->inet = sk;
1508 write_unlock_bh(&sk->sk_callback_lock);
1510 xs_udp_do_set_buffer_size(xprt);
1514 * xs_udp_connect_worker4 - set up a UDP socket
1515 * @work: RPC transport to connect
1517 * Invoked by a work queue tasklet.
1519 static void xs_udp_connect_worker4(struct work_struct *work)
1521 struct sock_xprt *transport =
1522 container_of(work, struct sock_xprt, connect_worker.work);
1523 struct rpc_xprt *xprt = &transport->xprt;
1524 struct socket *sock = transport->sock;
1525 int err, status = -EIO;
1527 if (xprt->shutdown || !xprt_bound(xprt))
1530 /* Start by resetting any existing state */
1533 if ((err = sock_create_kern(PF_INET, SOCK_DGRAM, IPPROTO_UDP, &sock)) < 0) {
1534 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1537 xs_reclassify_socket4(sock);
1539 if (xs_bind4(transport, sock)) {
1544 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1545 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1547 xs_udp_finish_connecting(xprt, sock);
1550 xprt_wake_pending_tasks(xprt, status);
1551 xprt_clear_connecting(xprt);
1555 * xs_udp_connect_worker6 - set up a UDP socket
1556 * @work: RPC transport to connect
1558 * Invoked by a work queue tasklet.
1560 static void xs_udp_connect_worker6(struct work_struct *work)
1562 struct sock_xprt *transport =
1563 container_of(work, struct sock_xprt, connect_worker.work);
1564 struct rpc_xprt *xprt = &transport->xprt;
1565 struct socket *sock = transport->sock;
1566 int err, status = -EIO;
1568 if (xprt->shutdown || !xprt_bound(xprt))
1571 /* Start by resetting any existing state */
1574 if ((err = sock_create_kern(PF_INET6, SOCK_DGRAM, IPPROTO_UDP, &sock)) < 0) {
1575 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1578 xs_reclassify_socket6(sock);
1580 if (xs_bind6(transport, sock) < 0) {
1585 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1586 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1588 xs_udp_finish_connecting(xprt, sock);
1591 xprt_wake_pending_tasks(xprt, status);
1592 xprt_clear_connecting(xprt);
1596 * We need to preserve the port number so the reply cache on the server can
1597 * find our cached RPC replies when we get around to reconnecting.
1599 static void xs_tcp_reuse_connection(struct rpc_xprt *xprt)
1602 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1603 struct sockaddr any;
1605 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt);
1608 * Disconnect the transport socket by doing a connect operation
1609 * with AF_UNSPEC. This should return immediately...
1611 memset(&any, 0, sizeof(any));
1612 any.sa_family = AF_UNSPEC;
1613 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
1615 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1619 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1621 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1623 if (!transport->inet) {
1624 struct sock *sk = sock->sk;
1626 write_lock_bh(&sk->sk_callback_lock);
1628 xs_save_old_callbacks(transport, sk);
1630 sk->sk_user_data = xprt;
1631 sk->sk_data_ready = xs_tcp_data_ready;
1632 sk->sk_state_change = xs_tcp_state_change;
1633 sk->sk_write_space = xs_tcp_write_space;
1634 sk->sk_error_report = xs_tcp_error_report;
1635 sk->sk_allocation = GFP_ATOMIC;
1637 /* socket options */
1638 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
1639 sock_reset_flag(sk, SOCK_LINGER);
1640 tcp_sk(sk)->linger2 = 0;
1641 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
1643 xprt_clear_connected(xprt);
1645 /* Reset to new socket */
1646 transport->sock = sock;
1647 transport->inet = sk;
1649 write_unlock_bh(&sk->sk_callback_lock);
1652 /* Tell the socket layer to start connecting... */
1653 xprt->stat.connect_count++;
1654 xprt->stat.connect_start = jiffies;
1655 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
1659 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1660 * @work: RPC transport to connect
1662 * Invoked by a work queue tasklet.
1664 static void xs_tcp_connect_worker4(struct work_struct *work)
1666 struct sock_xprt *transport =
1667 container_of(work, struct sock_xprt, connect_worker.work);
1668 struct rpc_xprt *xprt = &transport->xprt;
1669 struct socket *sock = transport->sock;
1670 int err, status = -EIO;
1672 if (xprt->shutdown || !xprt_bound(xprt))
1676 /* start from scratch */
1677 if ((err = sock_create_kern(PF_INET, SOCK_STREAM, IPPROTO_TCP, &sock)) < 0) {
1678 dprintk("RPC: can't create TCP transport socket (%d).\n", -err);
1681 xs_reclassify_socket4(sock);
1683 if (xs_bind4(transport, sock) < 0) {
1688 /* "close" the socket, preserving the local port */
1689 xs_tcp_reuse_connection(xprt);
1691 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1692 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1694 status = xs_tcp_finish_connecting(xprt, sock);
1695 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1696 xprt, -status, xprt_connected(xprt),
1697 sock->sk->sk_state);
1705 /* retry with existing socket, after a delay */
1708 /* get rid of existing socket, and retry */
1709 xs_tcp_shutdown(xprt);
1713 xprt_wake_pending_tasks(xprt, status);
1715 xprt_clear_connecting(xprt);
1719 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
1720 * @work: RPC transport to connect
1722 * Invoked by a work queue tasklet.
1724 static void xs_tcp_connect_worker6(struct work_struct *work)
1726 struct sock_xprt *transport =
1727 container_of(work, struct sock_xprt, connect_worker.work);
1728 struct rpc_xprt *xprt = &transport->xprt;
1729 struct socket *sock = transport->sock;
1730 int err, status = -EIO;
1732 if (xprt->shutdown || !xprt_bound(xprt))
1736 /* start from scratch */
1737 if ((err = sock_create_kern(PF_INET6, SOCK_STREAM, IPPROTO_TCP, &sock)) < 0) {
1738 dprintk("RPC: can't create TCP transport socket (%d).\n", -err);
1741 xs_reclassify_socket6(sock);
1743 if (xs_bind6(transport, sock) < 0) {
1748 /* "close" the socket, preserving the local port */
1749 xs_tcp_reuse_connection(xprt);
1751 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1752 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1754 status = xs_tcp_finish_connecting(xprt, sock);
1755 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1756 xprt, -status, xprt_connected(xprt), sock->sk->sk_state);
1764 /* retry with existing socket, after a delay */
1767 /* get rid of existing socket, and retry */
1768 xs_tcp_shutdown(xprt);
1772 xprt_wake_pending_tasks(xprt, status);
1774 xprt_clear_connecting(xprt);
1778 * xs_connect - connect a socket to a remote endpoint
1779 * @task: address of RPC task that manages state of connect request
1781 * TCP: If the remote end dropped the connection, delay reconnecting.
1783 * UDP socket connects are synchronous, but we use a work queue anyway
1784 * to guarantee that even unprivileged user processes can set up a
1785 * socket on a privileged port.
1787 * If a UDP socket connect fails, the delay behavior here prevents
1788 * retry floods (hard mounts).
1790 static void xs_connect(struct rpc_task *task)
1792 struct rpc_xprt *xprt = task->tk_xprt;
1793 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1795 if (xprt_test_and_set_connecting(xprt))
1798 if (transport->sock != NULL) {
1799 dprintk("RPC: xs_connect delayed xprt %p for %lu "
1801 xprt, xprt->reestablish_timeout / HZ);
1802 queue_delayed_work(rpciod_workqueue,
1803 &transport->connect_worker,
1804 xprt->reestablish_timeout);
1805 xprt->reestablish_timeout <<= 1;
1806 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
1807 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
1809 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
1810 queue_delayed_work(rpciod_workqueue,
1811 &transport->connect_worker, 0);
1815 static void xs_tcp_connect(struct rpc_task *task)
1817 struct rpc_xprt *xprt = task->tk_xprt;
1819 /* Initiate graceful shutdown of the socket if not already done */
1820 if (test_bit(XPRT_CONNECTED, &xprt->state))
1821 xs_tcp_shutdown(xprt);
1822 /* Exit if we need to wait for socket shutdown to complete */
1823 if (test_bit(XPRT_CLOSING, &xprt->state))
1829 * xs_udp_print_stats - display UDP socket-specifc stats
1830 * @xprt: rpc_xprt struct containing statistics
1834 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
1836 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1838 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
1840 xprt->stat.bind_count,
1843 xprt->stat.bad_xids,
1845 xprt->stat.bklog_u);
1849 * xs_tcp_print_stats - display TCP socket-specifc stats
1850 * @xprt: rpc_xprt struct containing statistics
1854 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
1856 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1859 if (xprt_connected(xprt))
1860 idle_time = (long)(jiffies - xprt->last_used) / HZ;
1862 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
1864 xprt->stat.bind_count,
1865 xprt->stat.connect_count,
1866 xprt->stat.connect_time,
1870 xprt->stat.bad_xids,
1872 xprt->stat.bklog_u);
1875 static struct rpc_xprt_ops xs_udp_ops = {
1876 .set_buffer_size = xs_udp_set_buffer_size,
1877 .reserve_xprt = xprt_reserve_xprt_cong,
1878 .release_xprt = xprt_release_xprt_cong,
1879 .rpcbind = rpcb_getport_async,
1880 .set_port = xs_set_port,
1881 .connect = xs_connect,
1882 .buf_alloc = rpc_malloc,
1883 .buf_free = rpc_free,
1884 .send_request = xs_udp_send_request,
1885 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
1886 .timer = xs_udp_timer,
1887 .release_request = xprt_release_rqst_cong,
1889 .destroy = xs_destroy,
1890 .print_stats = xs_udp_print_stats,
1893 static struct rpc_xprt_ops xs_tcp_ops = {
1894 .reserve_xprt = xprt_reserve_xprt,
1895 .release_xprt = xs_tcp_release_xprt,
1896 .rpcbind = rpcb_getport_async,
1897 .set_port = xs_set_port,
1898 .connect = xs_tcp_connect,
1899 .buf_alloc = rpc_malloc,
1900 .buf_free = rpc_free,
1901 .send_request = xs_tcp_send_request,
1902 .set_retrans_timeout = xprt_set_retrans_timeout_def,
1903 .close = xs_tcp_shutdown,
1904 .destroy = xs_destroy,
1905 .print_stats = xs_tcp_print_stats,
1908 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
1909 unsigned int slot_table_size)
1911 struct rpc_xprt *xprt;
1912 struct sock_xprt *new;
1914 if (args->addrlen > sizeof(xprt->addr)) {
1915 dprintk("RPC: xs_setup_xprt: address too large\n");
1916 return ERR_PTR(-EBADF);
1919 new = kzalloc(sizeof(*new), GFP_KERNEL);
1921 dprintk("RPC: xs_setup_xprt: couldn't allocate "
1923 return ERR_PTR(-ENOMEM);
1927 xprt->max_reqs = slot_table_size;
1928 xprt->slot = kcalloc(xprt->max_reqs, sizeof(struct rpc_rqst), GFP_KERNEL);
1929 if (xprt->slot == NULL) {
1931 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
1933 return ERR_PTR(-ENOMEM);
1936 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
1937 xprt->addrlen = args->addrlen;
1939 memcpy(&new->addr, args->srcaddr, args->addrlen);
1944 static const struct rpc_timeout xs_udp_default_timeout = {
1945 .to_initval = 5 * HZ,
1946 .to_maxval = 30 * HZ,
1947 .to_increment = 5 * HZ,
1952 * xs_setup_udp - Set up transport to use a UDP socket
1953 * @args: rpc transport creation arguments
1956 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
1958 struct sockaddr *addr = args->dstaddr;
1959 struct rpc_xprt *xprt;
1960 struct sock_xprt *transport;
1962 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries);
1965 transport = container_of(xprt, struct sock_xprt, xprt);
1967 xprt->prot = IPPROTO_UDP;
1969 /* XXX: header size can vary due to auth type, IPv6, etc. */
1970 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
1972 xprt->bind_timeout = XS_BIND_TO;
1973 xprt->connect_timeout = XS_UDP_CONN_TO;
1974 xprt->reestablish_timeout = XS_UDP_REEST_TO;
1975 xprt->idle_timeout = XS_IDLE_DISC_TO;
1977 xprt->ops = &xs_udp_ops;
1979 xprt->timeout = &xs_udp_default_timeout;
1981 switch (addr->sa_family) {
1983 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
1984 xprt_set_bound(xprt);
1986 INIT_DELAYED_WORK(&transport->connect_worker,
1987 xs_udp_connect_worker4);
1988 xs_format_ipv4_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
1991 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
1992 xprt_set_bound(xprt);
1994 INIT_DELAYED_WORK(&transport->connect_worker,
1995 xs_udp_connect_worker6);
1996 xs_format_ipv6_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2000 return ERR_PTR(-EAFNOSUPPORT);
2003 dprintk("RPC: set up transport to address %s\n",
2004 xprt->address_strings[RPC_DISPLAY_ALL]);
2006 if (try_module_get(THIS_MODULE))
2011 return ERR_PTR(-EINVAL);
2014 static const struct rpc_timeout xs_tcp_default_timeout = {
2015 .to_initval = 60 * HZ,
2016 .to_maxval = 60 * HZ,
2021 * xs_setup_tcp - Set up transport to use a TCP socket
2022 * @args: rpc transport creation arguments
2025 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2027 struct sockaddr *addr = args->dstaddr;
2028 struct rpc_xprt *xprt;
2029 struct sock_xprt *transport;
2031 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries);
2034 transport = container_of(xprt, struct sock_xprt, xprt);
2036 xprt->prot = IPPROTO_TCP;
2037 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2038 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2040 xprt->bind_timeout = XS_BIND_TO;
2041 xprt->connect_timeout = XS_TCP_CONN_TO;
2042 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2043 xprt->idle_timeout = XS_IDLE_DISC_TO;
2045 xprt->ops = &xs_tcp_ops;
2046 xprt->timeout = &xs_tcp_default_timeout;
2048 switch (addr->sa_family) {
2050 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2051 xprt_set_bound(xprt);
2053 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker4);
2054 xs_format_ipv4_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2057 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2058 xprt_set_bound(xprt);
2060 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker6);
2061 xs_format_ipv6_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2065 return ERR_PTR(-EAFNOSUPPORT);
2068 dprintk("RPC: set up transport to address %s\n",
2069 xprt->address_strings[RPC_DISPLAY_ALL]);
2071 if (try_module_get(THIS_MODULE))
2076 return ERR_PTR(-EINVAL);
2079 static struct xprt_class xs_udp_transport = {
2080 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2082 .owner = THIS_MODULE,
2083 .ident = IPPROTO_UDP,
2084 .setup = xs_setup_udp,
2087 static struct xprt_class xs_tcp_transport = {
2088 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2090 .owner = THIS_MODULE,
2091 .ident = IPPROTO_TCP,
2092 .setup = xs_setup_tcp,
2096 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2099 int init_socket_xprt(void)
2102 if (!sunrpc_table_header)
2103 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2106 xprt_register_transport(&xs_udp_transport);
2107 xprt_register_transport(&xs_tcp_transport);
2113 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2116 void cleanup_socket_xprt(void)
2119 if (sunrpc_table_header) {
2120 unregister_sysctl_table(sunrpc_table_header);
2121 sunrpc_table_header = NULL;
2125 xprt_unregister_transport(&xs_udp_transport);
2126 xprt_unregister_transport(&xs_tcp_transport);