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;
52 #define XS_TCP_LINGER_TO (15U * HZ)
53 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
56 * We can register our own files under /proc/sys/sunrpc by
57 * calling register_sysctl_table() again. The files in that
58 * directory become the union of all files registered there.
60 * We simply need to make sure that we don't collide with
61 * someone else's file names!
66 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
67 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
68 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
69 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
71 static struct ctl_table_header *sunrpc_table_header;
74 * FIXME: changing the UDP slot table size should also resize the UDP
75 * socket buffers for existing UDP transports
77 static ctl_table xs_tunables_table[] = {
79 .ctl_name = CTL_SLOTTABLE_UDP,
80 .procname = "udp_slot_table_entries",
81 .data = &xprt_udp_slot_table_entries,
82 .maxlen = sizeof(unsigned int),
84 .proc_handler = &proc_dointvec_minmax,
85 .strategy = &sysctl_intvec,
86 .extra1 = &min_slot_table_size,
87 .extra2 = &max_slot_table_size
90 .ctl_name = CTL_SLOTTABLE_TCP,
91 .procname = "tcp_slot_table_entries",
92 .data = &xprt_tcp_slot_table_entries,
93 .maxlen = sizeof(unsigned int),
95 .proc_handler = &proc_dointvec_minmax,
96 .strategy = &sysctl_intvec,
97 .extra1 = &min_slot_table_size,
98 .extra2 = &max_slot_table_size
101 .ctl_name = CTL_MIN_RESVPORT,
102 .procname = "min_resvport",
103 .data = &xprt_min_resvport,
104 .maxlen = sizeof(unsigned int),
106 .proc_handler = &proc_dointvec_minmax,
107 .strategy = &sysctl_intvec,
108 .extra1 = &xprt_min_resvport_limit,
109 .extra2 = &xprt_max_resvport_limit
112 .ctl_name = CTL_MAX_RESVPORT,
113 .procname = "max_resvport",
114 .data = &xprt_max_resvport,
115 .maxlen = sizeof(unsigned int),
117 .proc_handler = &proc_dointvec_minmax,
118 .strategy = &sysctl_intvec,
119 .extra1 = &xprt_min_resvport_limit,
120 .extra2 = &xprt_max_resvport_limit
123 .procname = "tcp_fin_timeout",
124 .data = &xs_tcp_fin_timeout,
125 .maxlen = sizeof(xs_tcp_fin_timeout),
127 .proc_handler = &proc_dointvec_jiffies,
128 .strategy = sysctl_jiffies
135 static ctl_table sunrpc_table[] = {
137 .ctl_name = CTL_SUNRPC,
138 .procname = "sunrpc",
140 .child = xs_tunables_table
150 * Time out for an RPC UDP socket connect. UDP socket connects are
151 * synchronous, but we set a timeout anyway in case of resource
152 * exhaustion on the local host.
154 #define XS_UDP_CONN_TO (5U * HZ)
157 * Wait duration for an RPC TCP connection to be established. Solaris
158 * NFS over TCP uses 60 seconds, for example, which is in line with how
159 * long a server takes to reboot.
161 #define XS_TCP_CONN_TO (60U * HZ)
164 * Wait duration for a reply from the RPC portmapper.
166 #define XS_BIND_TO (60U * HZ)
169 * Delay if a UDP socket connect error occurs. This is most likely some
170 * kind of resource problem on the local host.
172 #define XS_UDP_REEST_TO (2U * HZ)
175 * The reestablish timeout allows clients to delay for a bit before attempting
176 * to reconnect to a server that just dropped our connection.
178 * We implement an exponential backoff when trying to reestablish a TCP
179 * transport connection with the server. Some servers like to drop a TCP
180 * connection when they are overworked, so we start with a short timeout and
181 * increase over time if the server is down or not responding.
183 #define XS_TCP_INIT_REEST_TO (3U * HZ)
184 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
187 * TCP idle timeout; client drops the transport socket if it is idle
188 * for this long. Note that we also timeout UDP sockets to prevent
189 * holding port numbers when there is no RPC traffic.
191 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
194 # undef RPC_DEBUG_DATA
195 # define RPCDBG_FACILITY RPCDBG_TRANS
198 #ifdef RPC_DEBUG_DATA
199 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
201 u8 *buf = (u8 *) packet;
204 dprintk("RPC: %s\n", msg);
205 for (j = 0; j < count && j < 128; j += 4) {
209 dprintk("0x%04x ", j);
211 dprintk("%02x%02x%02x%02x ",
212 buf[j], buf[j+1], buf[j+2], buf[j+3]);
217 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
224 struct rpc_xprt xprt;
229 struct socket * sock;
233 * State of TCP reply receive
241 unsigned long tcp_copied,
245 * Connection of transports
247 struct delayed_work connect_worker;
248 struct sockaddr_storage addr;
252 * UDP socket buffer size parameters
258 * Saved socket callback addresses
260 void (*old_data_ready)(struct sock *, int);
261 void (*old_state_change)(struct sock *);
262 void (*old_write_space)(struct sock *);
263 void (*old_error_report)(struct sock *);
267 * TCP receive state flags
269 #define TCP_RCV_LAST_FRAG (1UL << 0)
270 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
271 #define TCP_RCV_COPY_XID (1UL << 2)
272 #define TCP_RCV_COPY_DATA (1UL << 3)
273 #define TCP_RCV_COPY_CALLDIR (1UL << 4)
278 #define TCP_RPC_REPLY (1UL << 5)
280 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
282 return (struct sockaddr *) &xprt->addr;
285 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
287 return (struct sockaddr_in *) &xprt->addr;
290 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
292 return (struct sockaddr_in6 *) &xprt->addr;
295 static void xs_format_ipv4_peer_addresses(struct rpc_xprt *xprt,
296 const char *protocol,
299 struct sockaddr_in *addr = xs_addr_in(xprt);
302 buf = kzalloc(20, GFP_KERNEL);
304 snprintf(buf, 20, "%pI4", &addr->sin_addr.s_addr);
306 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
308 buf = kzalloc(8, GFP_KERNEL);
310 snprintf(buf, 8, "%u",
311 ntohs(addr->sin_port));
313 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
315 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
317 buf = kzalloc(48, GFP_KERNEL);
319 snprintf(buf, 48, "addr=%pI4 port=%u proto=%s",
320 &addr->sin_addr.s_addr,
321 ntohs(addr->sin_port),
324 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
326 buf = kzalloc(10, GFP_KERNEL);
328 snprintf(buf, 10, "%02x%02x%02x%02x",
329 NIPQUAD(addr->sin_addr.s_addr));
331 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
333 buf = kzalloc(8, GFP_KERNEL);
335 snprintf(buf, 8, "%4hx",
336 ntohs(addr->sin_port));
338 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
340 buf = kzalloc(30, GFP_KERNEL);
342 snprintf(buf, 30, "%pI4.%u.%u",
343 &addr->sin_addr.s_addr,
344 ntohs(addr->sin_port) >> 8,
345 ntohs(addr->sin_port) & 0xff);
347 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
349 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
352 static void xs_format_ipv6_peer_addresses(struct rpc_xprt *xprt,
353 const char *protocol,
356 struct sockaddr_in6 *addr = xs_addr_in6(xprt);
359 buf = kzalloc(40, GFP_KERNEL);
361 snprintf(buf, 40, "%pI6",&addr->sin6_addr);
363 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
365 buf = kzalloc(8, GFP_KERNEL);
367 snprintf(buf, 8, "%u",
368 ntohs(addr->sin6_port));
370 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
372 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
374 buf = kzalloc(64, GFP_KERNEL);
376 snprintf(buf, 64, "addr=%pI6 port=%u proto=%s",
378 ntohs(addr->sin6_port),
381 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
383 buf = kzalloc(36, GFP_KERNEL);
385 snprintf(buf, 36, "%pi6", &addr->sin6_addr);
387 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
389 buf = kzalloc(8, GFP_KERNEL);
391 snprintf(buf, 8, "%4hx",
392 ntohs(addr->sin6_port));
394 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
396 buf = kzalloc(50, GFP_KERNEL);
398 snprintf(buf, 50, "%pI6.%u.%u",
400 ntohs(addr->sin6_port) >> 8,
401 ntohs(addr->sin6_port) & 0xff);
403 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
405 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
408 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
412 for (i = 0; i < RPC_DISPLAY_MAX; i++)
414 case RPC_DISPLAY_PROTO:
415 case RPC_DISPLAY_NETID:
418 kfree(xprt->address_strings[i]);
422 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
424 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
426 struct msghdr msg = {
428 .msg_namelen = addrlen,
429 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
432 .iov_base = vec->iov_base + base,
433 .iov_len = vec->iov_len - base,
436 if (iov.iov_len != 0)
437 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
438 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
441 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more)
444 unsigned int remainder;
447 remainder = xdr->page_len - base;
448 base += xdr->page_base;
449 ppage = xdr->pages + (base >> PAGE_SHIFT);
452 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
453 int flags = XS_SENDMSG_FLAGS;
456 if (remainder != 0 || more)
458 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
459 if (remainder == 0 || err != len)
473 * xs_sendpages - write pages directly to a socket
474 * @sock: socket to send on
475 * @addr: UDP only -- address of destination
476 * @addrlen: UDP only -- length of destination address
477 * @xdr: buffer containing this request
478 * @base: starting position in the buffer
481 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
483 unsigned int remainder = xdr->len - base;
489 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
495 if (base < xdr->head[0].iov_len || addr != NULL) {
496 unsigned int len = xdr->head[0].iov_len - base;
498 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
499 if (remainder == 0 || err != len)
504 base -= xdr->head[0].iov_len;
506 if (base < xdr->page_len) {
507 unsigned int len = xdr->page_len - base;
509 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
510 if (remainder == 0 || err != len)
515 base -= xdr->page_len;
517 if (base >= xdr->tail[0].iov_len)
519 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
528 static void xs_nospace_callback(struct rpc_task *task)
530 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
532 transport->inet->sk_write_pending--;
533 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
537 * xs_nospace - place task on wait queue if transmit was incomplete
538 * @task: task to put to sleep
541 static int xs_nospace(struct rpc_task *task)
543 struct rpc_rqst *req = task->tk_rqstp;
544 struct rpc_xprt *xprt = req->rq_xprt;
545 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
548 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
549 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
552 /* Protect against races with write_space */
553 spin_lock_bh(&xprt->transport_lock);
555 /* Don't race with disconnect */
556 if (xprt_connected(xprt)) {
557 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
560 * Notify TCP that we're limited by the application
563 set_bit(SOCK_NOSPACE, &transport->sock->flags);
564 transport->inet->sk_write_pending++;
565 /* ...and wait for more buffer space */
566 xprt_wait_for_buffer_space(task, xs_nospace_callback);
569 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
573 spin_unlock_bh(&xprt->transport_lock);
578 * xs_udp_send_request - write an RPC request to a UDP socket
579 * @task: address of RPC task that manages the state of an RPC request
582 * 0: The request has been sent
583 * EAGAIN: The socket was blocked, please call again later to
584 * complete the request
585 * ENOTCONN: Caller needs to invoke connect logic then call again
586 * other: Some other error occured, the request was not sent
588 static int xs_udp_send_request(struct rpc_task *task)
590 struct rpc_rqst *req = task->tk_rqstp;
591 struct rpc_xprt *xprt = req->rq_xprt;
592 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
593 struct xdr_buf *xdr = &req->rq_snd_buf;
596 xs_pktdump("packet data:",
597 req->rq_svec->iov_base,
598 req->rq_svec->iov_len);
600 if (!xprt_bound(xprt))
602 status = xs_sendpages(transport->sock,
607 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
608 xdr->len - req->rq_bytes_sent, status);
611 task->tk_bytes_sent += status;
612 if (status >= req->rq_slen)
614 /* Still some bytes left; set up for a retry later. */
617 if (!transport->sock)
623 /* Should we call xs_close() here? */
626 status = xs_nospace(task);
629 dprintk("RPC: sendmsg returned unrecognized error %d\n",
634 /* When the server has died, an ICMP port unreachable message
635 * prompts ECONNREFUSED. */
636 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
643 * xs_tcp_shutdown - gracefully shut down a TCP socket
646 * Initiates a graceful shutdown of the TCP socket by calling the
647 * equivalent of shutdown(SHUT_WR);
649 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
651 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
652 struct socket *sock = transport->sock;
655 kernel_sock_shutdown(sock, SHUT_WR);
658 static inline void xs_encode_tcp_record_marker(struct xdr_buf *buf)
660 u32 reclen = buf->len - sizeof(rpc_fraghdr);
661 rpc_fraghdr *base = buf->head[0].iov_base;
662 *base = htonl(RPC_LAST_STREAM_FRAGMENT | reclen);
666 * xs_tcp_send_request - write an RPC request to a TCP socket
667 * @task: address of RPC task that manages the state of an RPC request
670 * 0: The request has been sent
671 * EAGAIN: The socket was blocked, please call again later to
672 * complete the request
673 * ENOTCONN: Caller needs to invoke connect logic then call again
674 * other: Some other error occured, the request was not sent
676 * XXX: In the case of soft timeouts, should we eventually give up
677 * if sendmsg is not able to make progress?
679 static int xs_tcp_send_request(struct rpc_task *task)
681 struct rpc_rqst *req = task->tk_rqstp;
682 struct rpc_xprt *xprt = req->rq_xprt;
683 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
684 struct xdr_buf *xdr = &req->rq_snd_buf;
687 xs_encode_tcp_record_marker(&req->rq_snd_buf);
689 xs_pktdump("packet data:",
690 req->rq_svec->iov_base,
691 req->rq_svec->iov_len);
693 /* Continue transmitting the packet/record. We must be careful
694 * to cope with writespace callbacks arriving _after_ we have
695 * called sendmsg(). */
697 status = xs_sendpages(transport->sock,
698 NULL, 0, xdr, req->rq_bytes_sent);
700 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
701 xdr->len - req->rq_bytes_sent, status);
703 if (unlikely(status < 0))
706 /* If we've sent the entire packet, immediately
707 * reset the count of bytes sent. */
708 req->rq_bytes_sent += status;
709 task->tk_bytes_sent += status;
710 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
711 req->rq_bytes_sent = 0;
720 if (!transport->sock)
726 /* Should we call xs_close() here? */
729 status = xs_nospace(task);
732 dprintk("RPC: sendmsg returned unrecognized error %d\n",
736 xs_tcp_shutdown(xprt);
739 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
746 * xs_tcp_release_xprt - clean up after a tcp transmission
750 * This cleans up if an error causes us to abort the transmission of a request.
751 * In this case, the socket may need to be reset in order to avoid confusing
754 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
756 struct rpc_rqst *req;
758 if (task != xprt->snd_task)
762 req = task->tk_rqstp;
763 if (req->rq_bytes_sent == 0)
765 if (req->rq_bytes_sent == req->rq_snd_buf.len)
767 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
769 xprt_release_xprt(xprt, task);
772 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
774 transport->old_data_ready = sk->sk_data_ready;
775 transport->old_state_change = sk->sk_state_change;
776 transport->old_write_space = sk->sk_write_space;
777 transport->old_error_report = sk->sk_error_report;
780 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
782 sk->sk_data_ready = transport->old_data_ready;
783 sk->sk_state_change = transport->old_state_change;
784 sk->sk_write_space = transport->old_write_space;
785 sk->sk_error_report = transport->old_error_report;
788 static void xs_reset_transport(struct sock_xprt *transport)
790 struct socket *sock = transport->sock;
791 struct sock *sk = transport->inet;
796 write_lock_bh(&sk->sk_callback_lock);
797 transport->inet = NULL;
798 transport->sock = NULL;
800 sk->sk_user_data = NULL;
802 xs_restore_old_callbacks(transport, sk);
803 write_unlock_bh(&sk->sk_callback_lock);
811 * xs_close - close a socket
814 * This is used when all requests are complete; ie, no DRC state remains
815 * on the server we want to save.
817 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
818 * xs_reset_transport() zeroing the socket from underneath a writer.
820 static void xs_close(struct rpc_xprt *xprt)
822 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
824 dprintk("RPC: xs_close xprt %p\n", xprt);
826 xs_reset_transport(transport);
828 smp_mb__before_clear_bit();
829 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
830 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
831 clear_bit(XPRT_CLOSING, &xprt->state);
832 smp_mb__after_clear_bit();
833 xprt_disconnect_done(xprt);
836 static void xs_tcp_close(struct rpc_xprt *xprt)
838 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state))
841 xs_tcp_shutdown(xprt);
845 * xs_destroy - prepare to shutdown a transport
846 * @xprt: doomed transport
849 static void xs_destroy(struct rpc_xprt *xprt)
851 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
853 dprintk("RPC: xs_destroy xprt %p\n", xprt);
855 cancel_rearming_delayed_work(&transport->connect_worker);
858 xs_free_peer_addresses(xprt);
861 module_put(THIS_MODULE);
864 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
866 return (struct rpc_xprt *) sk->sk_user_data;
870 * xs_udp_data_ready - "data ready" callback for UDP sockets
871 * @sk: socket with data to read
872 * @len: how much data to read
875 static void xs_udp_data_ready(struct sock *sk, int len)
877 struct rpc_task *task;
878 struct rpc_xprt *xprt;
879 struct rpc_rqst *rovr;
881 int err, repsize, copied;
885 read_lock(&sk->sk_callback_lock);
886 dprintk("RPC: xs_udp_data_ready...\n");
887 if (!(xprt = xprt_from_sock(sk)))
890 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
896 repsize = skb->len - sizeof(struct udphdr);
898 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
902 /* Copy the XID from the skb... */
903 xp = skb_header_pointer(skb, sizeof(struct udphdr),
904 sizeof(_xid), &_xid);
908 /* Look up and lock the request corresponding to the given XID */
909 spin_lock(&xprt->transport_lock);
910 rovr = xprt_lookup_rqst(xprt, *xp);
913 task = rovr->rq_task;
915 if ((copied = rovr->rq_private_buf.buflen) > repsize)
918 /* Suck it into the iovec, verify checksum if not done by hw. */
919 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
920 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
924 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
926 /* Something worked... */
927 dst_confirm(skb->dst);
929 xprt_adjust_cwnd(task, copied);
930 xprt_update_rtt(task);
931 xprt_complete_rqst(task, copied);
934 spin_unlock(&xprt->transport_lock);
936 skb_free_datagram(sk, skb);
938 read_unlock(&sk->sk_callback_lock);
941 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
943 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
947 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
948 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
949 used = xdr_skb_read_bits(desc, p, len);
950 transport->tcp_offset += used;
954 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
955 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
956 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
958 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
959 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
961 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
962 transport->tcp_offset = 0;
964 /* Sanity check of the record length */
965 if (unlikely(transport->tcp_reclen < 8)) {
966 dprintk("RPC: invalid TCP record fragment length\n");
967 xprt_force_disconnect(xprt);
970 dprintk("RPC: reading TCP record fragment of length %d\n",
971 transport->tcp_reclen);
974 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
976 if (transport->tcp_offset == transport->tcp_reclen) {
977 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
978 transport->tcp_offset = 0;
979 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
980 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
981 transport->tcp_flags |= TCP_RCV_COPY_XID;
982 transport->tcp_copied = 0;
987 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
992 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
993 dprintk("RPC: reading XID (%Zu bytes)\n", len);
994 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
995 used = xdr_skb_read_bits(desc, p, len);
996 transport->tcp_offset += used;
999 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
1000 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1001 transport->tcp_copied = 4;
1002 dprintk("RPC: reading %s XID %08x\n",
1003 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
1005 ntohl(transport->tcp_xid));
1006 xs_tcp_check_fraghdr(transport);
1009 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
1010 struct xdr_skb_reader *desc)
1017 * We want transport->tcp_offset to be 8 at the end of this routine
1018 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1019 * When this function is called for the first time,
1020 * transport->tcp_offset is 4 (after having already read the xid).
1022 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
1023 len = sizeof(calldir) - offset;
1024 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len);
1025 used = xdr_skb_read_bits(desc, &calldir, len);
1026 transport->tcp_offset += used;
1029 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
1030 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1031 transport->tcp_copied += 4;
1032 if (ntohl(calldir) == RPC_REPLY)
1033 transport->tcp_flags |= TCP_RPC_REPLY;
1035 transport->tcp_flags &= ~TCP_RPC_REPLY;
1036 dprintk("RPC: reading %s CALL/REPLY flag %08x\n",
1037 (transport->tcp_flags & TCP_RPC_REPLY) ?
1038 "reply for" : "request with", calldir);
1039 xs_tcp_check_fraghdr(transport);
1042 static inline void xs_tcp_read_request(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
1044 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1045 struct rpc_rqst *req;
1046 struct xdr_buf *rcvbuf;
1050 /* Find and lock the request corresponding to this xid */
1051 spin_lock(&xprt->transport_lock);
1052 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1054 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1055 dprintk("RPC: XID %08x request not found!\n",
1056 ntohl(transport->tcp_xid));
1057 spin_unlock(&xprt->transport_lock);
1061 rcvbuf = &req->rq_private_buf;
1063 if (len > transport->tcp_reclen - transport->tcp_offset) {
1064 struct xdr_skb_reader my_desc;
1066 len = transport->tcp_reclen - transport->tcp_offset;
1067 memcpy(&my_desc, desc, sizeof(my_desc));
1068 my_desc.count = len;
1069 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1070 &my_desc, xdr_skb_read_bits);
1074 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1075 desc, xdr_skb_read_bits);
1078 transport->tcp_copied += r;
1079 transport->tcp_offset += r;
1082 /* Error when copying to the receive buffer,
1083 * usually because we weren't able to allocate
1084 * additional buffer pages. All we can do now
1085 * is turn off TCP_RCV_COPY_DATA, so the request
1086 * will not receive any additional updates,
1088 * Any remaining data from this record will
1091 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1092 dprintk("RPC: XID %08x truncated request\n",
1093 ntohl(transport->tcp_xid));
1094 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1095 "tcp_offset = %u, tcp_reclen = %u\n",
1096 xprt, transport->tcp_copied,
1097 transport->tcp_offset, transport->tcp_reclen);
1101 dprintk("RPC: XID %08x read %Zd bytes\n",
1102 ntohl(transport->tcp_xid), r);
1103 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1104 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1105 transport->tcp_offset, transport->tcp_reclen);
1107 if (transport->tcp_copied == req->rq_private_buf.buflen)
1108 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1109 else if (transport->tcp_offset == transport->tcp_reclen) {
1110 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1111 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1115 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1116 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1117 spin_unlock(&xprt->transport_lock);
1118 xs_tcp_check_fraghdr(transport);
1121 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1125 len = transport->tcp_reclen - transport->tcp_offset;
1126 if (len > desc->count)
1129 desc->offset += len;
1130 transport->tcp_offset += len;
1131 dprintk("RPC: discarded %Zu bytes\n", len);
1132 xs_tcp_check_fraghdr(transport);
1135 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1137 struct rpc_xprt *xprt = rd_desc->arg.data;
1138 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1139 struct xdr_skb_reader desc = {
1145 dprintk("RPC: xs_tcp_data_recv started\n");
1147 /* Read in a new fragment marker if necessary */
1148 /* Can we ever really expect to get completely empty fragments? */
1149 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1150 xs_tcp_read_fraghdr(xprt, &desc);
1153 /* Read in the xid if necessary */
1154 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1155 xs_tcp_read_xid(transport, &desc);
1158 /* Read in the call/reply flag */
1159 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
1160 xs_tcp_read_calldir(transport, &desc);
1163 /* Read in the request data */
1164 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1165 xs_tcp_read_request(xprt, &desc);
1168 /* Skip over any trailing bytes on short reads */
1169 xs_tcp_read_discard(transport, &desc);
1170 } while (desc.count);
1171 dprintk("RPC: xs_tcp_data_recv done\n");
1172 return len - desc.count;
1176 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1177 * @sk: socket with data to read
1178 * @bytes: how much data to read
1181 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1183 struct rpc_xprt *xprt;
1184 read_descriptor_t rd_desc;
1187 dprintk("RPC: xs_tcp_data_ready...\n");
1189 read_lock(&sk->sk_callback_lock);
1190 if (!(xprt = xprt_from_sock(sk)))
1195 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1196 rd_desc.arg.data = xprt;
1198 rd_desc.count = 65536;
1199 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1202 read_unlock(&sk->sk_callback_lock);
1206 * Do the equivalent of linger/linger2 handling for dealing with
1207 * broken servers that don't close the socket in a timely
1210 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt *xprt,
1211 unsigned long timeout)
1213 struct sock_xprt *transport;
1215 if (xprt_test_and_set_connecting(xprt))
1217 set_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1218 transport = container_of(xprt, struct sock_xprt, xprt);
1219 queue_delayed_work(rpciod_workqueue, &transport->connect_worker,
1223 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt *xprt)
1225 struct sock_xprt *transport;
1227 transport = container_of(xprt, struct sock_xprt, xprt);
1229 if (!test_bit(XPRT_CONNECTION_ABORT, &xprt->state) ||
1230 !cancel_delayed_work(&transport->connect_worker))
1232 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1233 xprt_clear_connecting(xprt);
1236 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
1238 smp_mb__before_clear_bit();
1239 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1240 clear_bit(XPRT_CLOSING, &xprt->state);
1241 smp_mb__after_clear_bit();
1242 /* Mark transport as closed and wake up all pending tasks */
1243 xprt_disconnect_done(xprt);
1247 * xs_tcp_state_change - callback to handle TCP socket state changes
1248 * @sk: socket whose state has changed
1251 static void xs_tcp_state_change(struct sock *sk)
1253 struct rpc_xprt *xprt;
1255 read_lock(&sk->sk_callback_lock);
1256 if (!(xprt = xprt_from_sock(sk)))
1258 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1259 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
1260 sk->sk_state, xprt_connected(xprt),
1261 sock_flag(sk, SOCK_DEAD),
1262 sock_flag(sk, SOCK_ZAPPED));
1264 switch (sk->sk_state) {
1265 case TCP_ESTABLISHED:
1266 spin_lock_bh(&xprt->transport_lock);
1267 if (!xprt_test_and_set_connected(xprt)) {
1268 struct sock_xprt *transport = container_of(xprt,
1269 struct sock_xprt, xprt);
1271 /* Reset TCP record info */
1272 transport->tcp_offset = 0;
1273 transport->tcp_reclen = 0;
1274 transport->tcp_copied = 0;
1275 transport->tcp_flags =
1276 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1278 xprt_wake_pending_tasks(xprt, -EAGAIN);
1280 spin_unlock_bh(&xprt->transport_lock);
1283 /* The client initiated a shutdown of the socket */
1284 xprt->connect_cookie++;
1285 xprt->reestablish_timeout = 0;
1286 set_bit(XPRT_CLOSING, &xprt->state);
1287 smp_mb__before_clear_bit();
1288 clear_bit(XPRT_CONNECTED, &xprt->state);
1289 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1290 smp_mb__after_clear_bit();
1291 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1293 case TCP_CLOSE_WAIT:
1294 /* The server initiated a shutdown of the socket */
1295 xprt_force_disconnect(xprt);
1297 xprt->connect_cookie++;
1300 * If the server closed down the connection, make sure that
1301 * we back off before reconnecting
1303 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1304 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1307 set_bit(XPRT_CLOSING, &xprt->state);
1308 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1309 smp_mb__before_clear_bit();
1310 clear_bit(XPRT_CONNECTED, &xprt->state);
1311 smp_mb__after_clear_bit();
1314 xs_tcp_cancel_linger_timeout(xprt);
1315 xs_sock_mark_closed(xprt);
1318 read_unlock(&sk->sk_callback_lock);
1322 * xs_error_report - callback mainly for catching socket errors
1325 static void xs_error_report(struct sock *sk)
1327 struct rpc_xprt *xprt;
1329 read_lock(&sk->sk_callback_lock);
1330 if (!(xprt = xprt_from_sock(sk)))
1332 dprintk("RPC: %s client %p...\n"
1334 __func__, xprt, sk->sk_err);
1335 xprt_wake_pending_tasks(xprt, -EAGAIN);
1337 read_unlock(&sk->sk_callback_lock);
1340 static void xs_write_space(struct sock *sk)
1342 struct socket *sock;
1343 struct rpc_xprt *xprt;
1345 if (unlikely(!(sock = sk->sk_socket)))
1347 clear_bit(SOCK_NOSPACE, &sock->flags);
1349 if (unlikely(!(xprt = xprt_from_sock(sk))))
1351 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1354 xprt_write_space(xprt);
1358 * xs_udp_write_space - callback invoked when socket buffer space
1360 * @sk: socket whose state has changed
1362 * Called when more output buffer space is available for this socket.
1363 * We try not to wake our writers until they can make "significant"
1364 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1365 * with a bunch of small requests.
1367 static void xs_udp_write_space(struct sock *sk)
1369 read_lock(&sk->sk_callback_lock);
1371 /* from net/core/sock.c:sock_def_write_space */
1372 if (sock_writeable(sk))
1375 read_unlock(&sk->sk_callback_lock);
1379 * xs_tcp_write_space - callback invoked when socket buffer space
1381 * @sk: socket whose state has changed
1383 * Called when more output buffer space is available for this socket.
1384 * We try not to wake our writers until they can make "significant"
1385 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1386 * with a bunch of small requests.
1388 static void xs_tcp_write_space(struct sock *sk)
1390 read_lock(&sk->sk_callback_lock);
1392 /* from net/core/stream.c:sk_stream_write_space */
1393 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1396 read_unlock(&sk->sk_callback_lock);
1399 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1401 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1402 struct sock *sk = transport->inet;
1404 if (transport->rcvsize) {
1405 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1406 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1408 if (transport->sndsize) {
1409 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1410 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1411 sk->sk_write_space(sk);
1416 * xs_udp_set_buffer_size - set send and receive limits
1417 * @xprt: generic transport
1418 * @sndsize: requested size of send buffer, in bytes
1419 * @rcvsize: requested size of receive buffer, in bytes
1421 * Set socket send and receive buffer size limits.
1423 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1425 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1427 transport->sndsize = 0;
1429 transport->sndsize = sndsize + 1024;
1430 transport->rcvsize = 0;
1432 transport->rcvsize = rcvsize + 1024;
1434 xs_udp_do_set_buffer_size(xprt);
1438 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1439 * @task: task that timed out
1441 * Adjust the congestion window after a retransmit timeout has occurred.
1443 static void xs_udp_timer(struct rpc_task *task)
1445 xprt_adjust_cwnd(task, -ETIMEDOUT);
1448 static unsigned short xs_get_random_port(void)
1450 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1451 unsigned short rand = (unsigned short) net_random() % range;
1452 return rand + xprt_min_resvport;
1456 * xs_set_port - reset the port number in the remote endpoint address
1457 * @xprt: generic transport
1458 * @port: new port number
1461 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1463 struct sockaddr *addr = xs_addr(xprt);
1465 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1467 switch (addr->sa_family) {
1469 ((struct sockaddr_in *)addr)->sin_port = htons(port);
1472 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
1479 static unsigned short xs_get_srcport(struct sock_xprt *transport, struct socket *sock)
1481 unsigned short port = transport->port;
1483 if (port == 0 && transport->xprt.resvport)
1484 port = xs_get_random_port();
1488 static unsigned short xs_next_srcport(struct sock_xprt *transport, struct socket *sock, unsigned short port)
1490 if (transport->port != 0)
1491 transport->port = 0;
1492 if (!transport->xprt.resvport)
1494 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1495 return xprt_max_resvport;
1499 static int xs_bind4(struct sock_xprt *transport, struct socket *sock)
1501 struct sockaddr_in myaddr = {
1502 .sin_family = AF_INET,
1504 struct sockaddr_in *sa;
1506 unsigned short port = xs_get_srcport(transport, sock);
1507 unsigned short last;
1509 sa = (struct sockaddr_in *)&transport->addr;
1510 myaddr.sin_addr = sa->sin_addr;
1512 myaddr.sin_port = htons(port);
1513 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1518 transport->port = port;
1522 port = xs_next_srcport(transport, sock, port);
1525 } while (err == -EADDRINUSE && nloop != 2);
1526 dprintk("RPC: %s %pI4:%u: %s (%d)\n",
1527 __func__, &myaddr.sin_addr,
1528 port, err ? "failed" : "ok", err);
1532 static int xs_bind6(struct sock_xprt *transport, struct socket *sock)
1534 struct sockaddr_in6 myaddr = {
1535 .sin6_family = AF_INET6,
1537 struct sockaddr_in6 *sa;
1539 unsigned short port = xs_get_srcport(transport, sock);
1540 unsigned short last;
1542 sa = (struct sockaddr_in6 *)&transport->addr;
1543 myaddr.sin6_addr = sa->sin6_addr;
1545 myaddr.sin6_port = htons(port);
1546 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1551 transport->port = port;
1555 port = xs_next_srcport(transport, sock, port);
1558 } while (err == -EADDRINUSE && nloop != 2);
1559 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1560 &myaddr.sin6_addr, port, err ? "failed" : "ok", err);
1564 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1565 static struct lock_class_key xs_key[2];
1566 static struct lock_class_key xs_slock_key[2];
1568 static inline void xs_reclassify_socket4(struct socket *sock)
1570 struct sock *sk = sock->sk;
1572 BUG_ON(sock_owned_by_user(sk));
1573 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1574 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1577 static inline void xs_reclassify_socket6(struct socket *sock)
1579 struct sock *sk = sock->sk;
1581 BUG_ON(sock_owned_by_user(sk));
1582 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1583 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1586 static inline void xs_reclassify_socket4(struct socket *sock)
1590 static inline void xs_reclassify_socket6(struct socket *sock)
1595 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1597 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1599 if (!transport->inet) {
1600 struct sock *sk = sock->sk;
1602 write_lock_bh(&sk->sk_callback_lock);
1604 xs_save_old_callbacks(transport, sk);
1606 sk->sk_user_data = xprt;
1607 sk->sk_data_ready = xs_udp_data_ready;
1608 sk->sk_write_space = xs_udp_write_space;
1609 sk->sk_error_report = xs_error_report;
1610 sk->sk_no_check = UDP_CSUM_NORCV;
1611 sk->sk_allocation = GFP_ATOMIC;
1613 xprt_set_connected(xprt);
1615 /* Reset to new socket */
1616 transport->sock = sock;
1617 transport->inet = sk;
1619 write_unlock_bh(&sk->sk_callback_lock);
1621 xs_udp_do_set_buffer_size(xprt);
1625 * xs_udp_connect_worker4 - set up a UDP socket
1626 * @work: RPC transport to connect
1628 * Invoked by a work queue tasklet.
1630 static void xs_udp_connect_worker4(struct work_struct *work)
1632 struct sock_xprt *transport =
1633 container_of(work, struct sock_xprt, connect_worker.work);
1634 struct rpc_xprt *xprt = &transport->xprt;
1635 struct socket *sock = transport->sock;
1636 int err, status = -EIO;
1641 /* Start by resetting any existing state */
1642 xs_reset_transport(transport);
1644 err = sock_create_kern(PF_INET, SOCK_DGRAM, IPPROTO_UDP, &sock);
1646 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1649 xs_reclassify_socket4(sock);
1651 if (xs_bind4(transport, sock)) {
1656 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1657 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1659 xs_udp_finish_connecting(xprt, sock);
1662 xprt_clear_connecting(xprt);
1663 xprt_wake_pending_tasks(xprt, status);
1667 * xs_udp_connect_worker6 - set up a UDP socket
1668 * @work: RPC transport to connect
1670 * Invoked by a work queue tasklet.
1672 static void xs_udp_connect_worker6(struct work_struct *work)
1674 struct sock_xprt *transport =
1675 container_of(work, struct sock_xprt, connect_worker.work);
1676 struct rpc_xprt *xprt = &transport->xprt;
1677 struct socket *sock = transport->sock;
1678 int err, status = -EIO;
1683 /* Start by resetting any existing state */
1684 xs_reset_transport(transport);
1686 err = sock_create_kern(PF_INET6, SOCK_DGRAM, IPPROTO_UDP, &sock);
1688 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1691 xs_reclassify_socket6(sock);
1693 if (xs_bind6(transport, sock) < 0) {
1698 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1699 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1701 xs_udp_finish_connecting(xprt, sock);
1704 xprt_clear_connecting(xprt);
1705 xprt_wake_pending_tasks(xprt, status);
1709 * We need to preserve the port number so the reply cache on the server can
1710 * find our cached RPC replies when we get around to reconnecting.
1712 static void xs_abort_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1715 struct sockaddr any;
1717 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt);
1720 * Disconnect the transport socket by doing a connect operation
1721 * with AF_UNSPEC. This should return immediately...
1723 memset(&any, 0, sizeof(any));
1724 any.sa_family = AF_UNSPEC;
1725 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
1727 xs_sock_mark_closed(xprt);
1729 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1733 static void xs_tcp_reuse_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1735 unsigned int state = transport->inet->sk_state;
1737 if (state == TCP_CLOSE && transport->sock->state == SS_UNCONNECTED)
1739 if ((1 << state) & (TCPF_ESTABLISHED|TCPF_SYN_SENT))
1741 xs_abort_connection(xprt, transport);
1744 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1746 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1748 if (!transport->inet) {
1749 struct sock *sk = sock->sk;
1751 write_lock_bh(&sk->sk_callback_lock);
1753 xs_save_old_callbacks(transport, sk);
1755 sk->sk_user_data = xprt;
1756 sk->sk_data_ready = xs_tcp_data_ready;
1757 sk->sk_state_change = xs_tcp_state_change;
1758 sk->sk_write_space = xs_tcp_write_space;
1759 sk->sk_error_report = xs_error_report;
1760 sk->sk_allocation = GFP_ATOMIC;
1762 /* socket options */
1763 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
1764 sock_reset_flag(sk, SOCK_LINGER);
1765 tcp_sk(sk)->linger2 = 0;
1766 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
1768 xprt_clear_connected(xprt);
1770 /* Reset to new socket */
1771 transport->sock = sock;
1772 transport->inet = sk;
1774 write_unlock_bh(&sk->sk_callback_lock);
1777 if (!xprt_bound(xprt))
1780 /* Tell the socket layer to start connecting... */
1781 xprt->stat.connect_count++;
1782 xprt->stat.connect_start = jiffies;
1783 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
1787 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
1788 * @xprt: RPC transport to connect
1789 * @transport: socket transport to connect
1790 * @create_sock: function to create a socket of the correct type
1792 * Invoked by a work queue tasklet.
1794 static void xs_tcp_setup_socket(struct rpc_xprt *xprt,
1795 struct sock_xprt *transport,
1796 struct socket *(*create_sock)(struct rpc_xprt *,
1797 struct sock_xprt *))
1799 struct socket *sock = transport->sock;
1806 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1807 sock = create_sock(xprt, transport);
1809 status = PTR_ERR(sock);
1815 abort_and_exit = test_and_clear_bit(XPRT_CONNECTION_ABORT,
1817 /* "close" the socket, preserving the local port */
1818 xs_tcp_reuse_connection(xprt, transport);
1824 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1825 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1827 status = xs_tcp_finish_connecting(xprt, sock);
1828 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1829 xprt, -status, xprt_connected(xprt),
1830 sock->sk->sk_state);
1833 printk("%s: connect returned unhandled error %d\n",
1835 case -EADDRNOTAVAIL:
1836 /* We're probably in TIME_WAIT. Get rid of existing socket,
1839 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1840 xprt_force_disconnect(xprt);
1844 /* retry with existing socket, after a delay */
1848 xprt_clear_connecting(xprt);
1854 xprt_clear_connecting(xprt);
1855 xprt_wake_pending_tasks(xprt, status);
1858 static struct socket *xs_create_tcp_sock4(struct rpc_xprt *xprt,
1859 struct sock_xprt *transport)
1861 struct socket *sock;
1864 /* start from scratch */
1865 err = sock_create_kern(PF_INET, SOCK_STREAM, IPPROTO_TCP, &sock);
1867 dprintk("RPC: can't create TCP transport socket (%d).\n",
1871 xs_reclassify_socket4(sock);
1873 if (xs_bind4(transport, sock) < 0) {
1879 return ERR_PTR(-EIO);
1883 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1884 * @work: RPC transport to connect
1886 * Invoked by a work queue tasklet.
1888 static void xs_tcp_connect_worker4(struct work_struct *work)
1890 struct sock_xprt *transport =
1891 container_of(work, struct sock_xprt, connect_worker.work);
1892 struct rpc_xprt *xprt = &transport->xprt;
1894 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock4);
1897 static struct socket *xs_create_tcp_sock6(struct rpc_xprt *xprt,
1898 struct sock_xprt *transport)
1900 struct socket *sock;
1903 /* start from scratch */
1904 err = sock_create_kern(PF_INET6, SOCK_STREAM, IPPROTO_TCP, &sock);
1906 dprintk("RPC: can't create TCP transport socket (%d).\n",
1910 xs_reclassify_socket6(sock);
1912 if (xs_bind6(transport, sock) < 0) {
1918 return ERR_PTR(-EIO);
1922 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
1923 * @work: RPC transport to connect
1925 * Invoked by a work queue tasklet.
1927 static void xs_tcp_connect_worker6(struct work_struct *work)
1929 struct sock_xprt *transport =
1930 container_of(work, struct sock_xprt, connect_worker.work);
1931 struct rpc_xprt *xprt = &transport->xprt;
1933 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock6);
1937 * xs_connect - connect a socket to a remote endpoint
1938 * @task: address of RPC task that manages state of connect request
1940 * TCP: If the remote end dropped the connection, delay reconnecting.
1942 * UDP socket connects are synchronous, but we use a work queue anyway
1943 * to guarantee that even unprivileged user processes can set up a
1944 * socket on a privileged port.
1946 * If a UDP socket connect fails, the delay behavior here prevents
1947 * retry floods (hard mounts).
1949 static void xs_connect(struct rpc_task *task)
1951 struct rpc_xprt *xprt = task->tk_xprt;
1952 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1954 if (xprt_test_and_set_connecting(xprt))
1957 if (transport->sock != NULL) {
1958 dprintk("RPC: xs_connect delayed xprt %p for %lu "
1960 xprt, xprt->reestablish_timeout / HZ);
1961 queue_delayed_work(rpciod_workqueue,
1962 &transport->connect_worker,
1963 xprt->reestablish_timeout);
1964 xprt->reestablish_timeout <<= 1;
1965 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
1966 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
1968 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
1969 queue_delayed_work(rpciod_workqueue,
1970 &transport->connect_worker, 0);
1974 static void xs_tcp_connect(struct rpc_task *task)
1976 struct rpc_xprt *xprt = task->tk_xprt;
1978 /* Exit if we need to wait for socket shutdown to complete */
1979 if (test_bit(XPRT_CLOSING, &xprt->state))
1985 * xs_udp_print_stats - display UDP socket-specifc stats
1986 * @xprt: rpc_xprt struct containing statistics
1990 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
1992 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1994 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
1996 xprt->stat.bind_count,
1999 xprt->stat.bad_xids,
2001 xprt->stat.bklog_u);
2005 * xs_tcp_print_stats - display TCP socket-specifc stats
2006 * @xprt: rpc_xprt struct containing statistics
2010 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2012 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2015 if (xprt_connected(xprt))
2016 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2018 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
2020 xprt->stat.bind_count,
2021 xprt->stat.connect_count,
2022 xprt->stat.connect_time,
2026 xprt->stat.bad_xids,
2028 xprt->stat.bklog_u);
2031 static struct rpc_xprt_ops xs_udp_ops = {
2032 .set_buffer_size = xs_udp_set_buffer_size,
2033 .reserve_xprt = xprt_reserve_xprt_cong,
2034 .release_xprt = xprt_release_xprt_cong,
2035 .rpcbind = rpcb_getport_async,
2036 .set_port = xs_set_port,
2037 .connect = xs_connect,
2038 .buf_alloc = rpc_malloc,
2039 .buf_free = rpc_free,
2040 .send_request = xs_udp_send_request,
2041 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2042 .timer = xs_udp_timer,
2043 .release_request = xprt_release_rqst_cong,
2045 .destroy = xs_destroy,
2046 .print_stats = xs_udp_print_stats,
2049 static struct rpc_xprt_ops xs_tcp_ops = {
2050 .reserve_xprt = xprt_reserve_xprt,
2051 .release_xprt = xs_tcp_release_xprt,
2052 .rpcbind = rpcb_getport_async,
2053 .set_port = xs_set_port,
2054 .connect = xs_tcp_connect,
2055 .buf_alloc = rpc_malloc,
2056 .buf_free = rpc_free,
2057 .send_request = xs_tcp_send_request,
2058 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2059 .close = xs_tcp_close,
2060 .destroy = xs_destroy,
2061 .print_stats = xs_tcp_print_stats,
2064 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2065 unsigned int slot_table_size)
2067 struct rpc_xprt *xprt;
2068 struct sock_xprt *new;
2070 if (args->addrlen > sizeof(xprt->addr)) {
2071 dprintk("RPC: xs_setup_xprt: address too large\n");
2072 return ERR_PTR(-EBADF);
2075 new = kzalloc(sizeof(*new), GFP_KERNEL);
2077 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2079 return ERR_PTR(-ENOMEM);
2083 xprt->max_reqs = slot_table_size;
2084 xprt->slot = kcalloc(xprt->max_reqs, sizeof(struct rpc_rqst), GFP_KERNEL);
2085 if (xprt->slot == NULL) {
2087 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
2089 return ERR_PTR(-ENOMEM);
2092 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2093 xprt->addrlen = args->addrlen;
2095 memcpy(&new->addr, args->srcaddr, args->addrlen);
2100 static const struct rpc_timeout xs_udp_default_timeout = {
2101 .to_initval = 5 * HZ,
2102 .to_maxval = 30 * HZ,
2103 .to_increment = 5 * HZ,
2108 * xs_setup_udp - Set up transport to use a UDP socket
2109 * @args: rpc transport creation arguments
2112 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2114 struct sockaddr *addr = args->dstaddr;
2115 struct rpc_xprt *xprt;
2116 struct sock_xprt *transport;
2118 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries);
2121 transport = container_of(xprt, struct sock_xprt, xprt);
2123 xprt->prot = IPPROTO_UDP;
2125 /* XXX: header size can vary due to auth type, IPv6, etc. */
2126 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2128 xprt->bind_timeout = XS_BIND_TO;
2129 xprt->connect_timeout = XS_UDP_CONN_TO;
2130 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2131 xprt->idle_timeout = XS_IDLE_DISC_TO;
2133 xprt->ops = &xs_udp_ops;
2135 xprt->timeout = &xs_udp_default_timeout;
2137 switch (addr->sa_family) {
2139 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2140 xprt_set_bound(xprt);
2142 INIT_DELAYED_WORK(&transport->connect_worker,
2143 xs_udp_connect_worker4);
2144 xs_format_ipv4_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2147 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2148 xprt_set_bound(xprt);
2150 INIT_DELAYED_WORK(&transport->connect_worker,
2151 xs_udp_connect_worker6);
2152 xs_format_ipv6_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2156 return ERR_PTR(-EAFNOSUPPORT);
2159 dprintk("RPC: set up transport to address %s\n",
2160 xprt->address_strings[RPC_DISPLAY_ALL]);
2162 if (try_module_get(THIS_MODULE))
2167 return ERR_PTR(-EINVAL);
2170 static const struct rpc_timeout xs_tcp_default_timeout = {
2171 .to_initval = 60 * HZ,
2172 .to_maxval = 60 * HZ,
2177 * xs_setup_tcp - Set up transport to use a TCP socket
2178 * @args: rpc transport creation arguments
2181 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2183 struct sockaddr *addr = args->dstaddr;
2184 struct rpc_xprt *xprt;
2185 struct sock_xprt *transport;
2187 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries);
2190 transport = container_of(xprt, struct sock_xprt, xprt);
2192 xprt->prot = IPPROTO_TCP;
2193 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2194 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2196 xprt->bind_timeout = XS_BIND_TO;
2197 xprt->connect_timeout = XS_TCP_CONN_TO;
2198 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2199 xprt->idle_timeout = XS_IDLE_DISC_TO;
2201 xprt->ops = &xs_tcp_ops;
2202 xprt->timeout = &xs_tcp_default_timeout;
2204 switch (addr->sa_family) {
2206 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2207 xprt_set_bound(xprt);
2209 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker4);
2210 xs_format_ipv4_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2213 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2214 xprt_set_bound(xprt);
2216 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker6);
2217 xs_format_ipv6_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2221 return ERR_PTR(-EAFNOSUPPORT);
2224 dprintk("RPC: set up transport to address %s\n",
2225 xprt->address_strings[RPC_DISPLAY_ALL]);
2227 if (try_module_get(THIS_MODULE))
2232 return ERR_PTR(-EINVAL);
2235 static struct xprt_class xs_udp_transport = {
2236 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2238 .owner = THIS_MODULE,
2239 .ident = IPPROTO_UDP,
2240 .setup = xs_setup_udp,
2243 static struct xprt_class xs_tcp_transport = {
2244 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2246 .owner = THIS_MODULE,
2247 .ident = IPPROTO_TCP,
2248 .setup = xs_setup_tcp,
2252 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2255 int init_socket_xprt(void)
2258 if (!sunrpc_table_header)
2259 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2262 xprt_register_transport(&xs_udp_transport);
2263 xprt_register_transport(&xs_tcp_transport);
2269 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2272 void cleanup_socket_xprt(void)
2275 if (sunrpc_table_header) {
2276 unregister_sysctl_table(sunrpc_table_header);
2277 sunrpc_table_header = NULL;
2281 xprt_unregister_transport(&xs_udp_transport);
2282 xprt_unregister_transport(&xs_tcp_transport);