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_READ_CALLDIR (1UL << 4)
274 #define TCP_RCV_COPY_CALLDIR (1UL << 5)
279 #define TCP_RPC_REPLY (1UL << 6)
281 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
283 return (struct sockaddr *) &xprt->addr;
286 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
288 return (struct sockaddr_in *) &xprt->addr;
291 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
293 return (struct sockaddr_in6 *) &xprt->addr;
296 static void xs_format_ipv4_peer_addresses(struct rpc_xprt *xprt,
297 const char *protocol,
300 struct sockaddr_in *addr = xs_addr_in(xprt);
303 buf = kzalloc(20, GFP_KERNEL);
305 snprintf(buf, 20, "%pI4", &addr->sin_addr.s_addr);
307 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
309 buf = kzalloc(8, GFP_KERNEL);
311 snprintf(buf, 8, "%u",
312 ntohs(addr->sin_port));
314 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
316 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
318 buf = kzalloc(48, GFP_KERNEL);
320 snprintf(buf, 48, "addr=%pI4 port=%u proto=%s",
321 &addr->sin_addr.s_addr,
322 ntohs(addr->sin_port),
325 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
327 buf = kzalloc(10, GFP_KERNEL);
329 snprintf(buf, 10, "%02x%02x%02x%02x",
330 NIPQUAD(addr->sin_addr.s_addr));
332 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
334 buf = kzalloc(8, GFP_KERNEL);
336 snprintf(buf, 8, "%4hx",
337 ntohs(addr->sin_port));
339 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
341 buf = kzalloc(30, GFP_KERNEL);
343 snprintf(buf, 30, "%pI4.%u.%u",
344 &addr->sin_addr.s_addr,
345 ntohs(addr->sin_port) >> 8,
346 ntohs(addr->sin_port) & 0xff);
348 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
350 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
353 static void xs_format_ipv6_peer_addresses(struct rpc_xprt *xprt,
354 const char *protocol,
357 struct sockaddr_in6 *addr = xs_addr_in6(xprt);
360 buf = kzalloc(40, GFP_KERNEL);
362 snprintf(buf, 40, "%pI6",&addr->sin6_addr);
364 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
366 buf = kzalloc(8, GFP_KERNEL);
368 snprintf(buf, 8, "%u",
369 ntohs(addr->sin6_port));
371 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
373 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
375 buf = kzalloc(64, GFP_KERNEL);
377 snprintf(buf, 64, "addr=%pI6 port=%u proto=%s",
379 ntohs(addr->sin6_port),
382 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
384 buf = kzalloc(36, GFP_KERNEL);
386 snprintf(buf, 36, "%pi6", &addr->sin6_addr);
388 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = buf;
390 buf = kzalloc(8, GFP_KERNEL);
392 snprintf(buf, 8, "%4hx",
393 ntohs(addr->sin6_port));
395 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = buf;
397 buf = kzalloc(50, GFP_KERNEL);
399 snprintf(buf, 50, "%pI6.%u.%u",
401 ntohs(addr->sin6_port) >> 8,
402 ntohs(addr->sin6_port) & 0xff);
404 xprt->address_strings[RPC_DISPLAY_UNIVERSAL_ADDR] = buf;
406 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
409 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
413 for (i = 0; i < RPC_DISPLAY_MAX; i++)
415 case RPC_DISPLAY_PROTO:
416 case RPC_DISPLAY_NETID:
419 kfree(xprt->address_strings[i]);
423 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
425 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
427 struct msghdr msg = {
429 .msg_namelen = addrlen,
430 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
433 .iov_base = vec->iov_base + base,
434 .iov_len = vec->iov_len - base,
437 if (iov.iov_len != 0)
438 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
439 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
442 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more)
445 unsigned int remainder;
448 remainder = xdr->page_len - base;
449 base += xdr->page_base;
450 ppage = xdr->pages + (base >> PAGE_SHIFT);
453 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
454 int flags = XS_SENDMSG_FLAGS;
457 if (remainder != 0 || more)
459 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
460 if (remainder == 0 || err != len)
474 * xs_sendpages - write pages directly to a socket
475 * @sock: socket to send on
476 * @addr: UDP only -- address of destination
477 * @addrlen: UDP only -- length of destination address
478 * @xdr: buffer containing this request
479 * @base: starting position in the buffer
482 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
484 unsigned int remainder = xdr->len - base;
490 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
496 if (base < xdr->head[0].iov_len || addr != NULL) {
497 unsigned int len = xdr->head[0].iov_len - base;
499 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
500 if (remainder == 0 || err != len)
505 base -= xdr->head[0].iov_len;
507 if (base < xdr->page_len) {
508 unsigned int len = xdr->page_len - base;
510 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
511 if (remainder == 0 || err != len)
516 base -= xdr->page_len;
518 if (base >= xdr->tail[0].iov_len)
520 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
529 static void xs_nospace_callback(struct rpc_task *task)
531 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
533 transport->inet->sk_write_pending--;
534 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
538 * xs_nospace - place task on wait queue if transmit was incomplete
539 * @task: task to put to sleep
542 static int xs_nospace(struct rpc_task *task)
544 struct rpc_rqst *req = task->tk_rqstp;
545 struct rpc_xprt *xprt = req->rq_xprt;
546 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
549 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
550 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
553 /* Protect against races with write_space */
554 spin_lock_bh(&xprt->transport_lock);
556 /* Don't race with disconnect */
557 if (xprt_connected(xprt)) {
558 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
561 * Notify TCP that we're limited by the application
564 set_bit(SOCK_NOSPACE, &transport->sock->flags);
565 transport->inet->sk_write_pending++;
566 /* ...and wait for more buffer space */
567 xprt_wait_for_buffer_space(task, xs_nospace_callback);
570 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
574 spin_unlock_bh(&xprt->transport_lock);
579 * xs_udp_send_request - write an RPC request to a UDP socket
580 * @task: address of RPC task that manages the state of an RPC request
583 * 0: The request has been sent
584 * EAGAIN: The socket was blocked, please call again later to
585 * complete the request
586 * ENOTCONN: Caller needs to invoke connect logic then call again
587 * other: Some other error occured, the request was not sent
589 static int xs_udp_send_request(struct rpc_task *task)
591 struct rpc_rqst *req = task->tk_rqstp;
592 struct rpc_xprt *xprt = req->rq_xprt;
593 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
594 struct xdr_buf *xdr = &req->rq_snd_buf;
597 xs_pktdump("packet data:",
598 req->rq_svec->iov_base,
599 req->rq_svec->iov_len);
601 if (!xprt_bound(xprt))
603 status = xs_sendpages(transport->sock,
608 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
609 xdr->len - req->rq_bytes_sent, status);
612 task->tk_bytes_sent += status;
613 if (status >= req->rq_slen)
615 /* Still some bytes left; set up for a retry later. */
618 if (!transport->sock)
624 /* Should we call xs_close() here? */
627 status = xs_nospace(task);
630 dprintk("RPC: sendmsg returned unrecognized error %d\n",
635 /* When the server has died, an ICMP port unreachable message
636 * prompts ECONNREFUSED. */
637 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
644 * xs_tcp_shutdown - gracefully shut down a TCP socket
647 * Initiates a graceful shutdown of the TCP socket by calling the
648 * equivalent of shutdown(SHUT_WR);
650 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
652 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
653 struct socket *sock = transport->sock;
656 kernel_sock_shutdown(sock, SHUT_WR);
659 static inline void xs_encode_tcp_record_marker(struct xdr_buf *buf)
661 u32 reclen = buf->len - sizeof(rpc_fraghdr);
662 rpc_fraghdr *base = buf->head[0].iov_base;
663 *base = htonl(RPC_LAST_STREAM_FRAGMENT | reclen);
667 * xs_tcp_send_request - write an RPC request to a TCP socket
668 * @task: address of RPC task that manages the state of an RPC request
671 * 0: The request has been sent
672 * EAGAIN: The socket was blocked, please call again later to
673 * complete the request
674 * ENOTCONN: Caller needs to invoke connect logic then call again
675 * other: Some other error occured, the request was not sent
677 * XXX: In the case of soft timeouts, should we eventually give up
678 * if sendmsg is not able to make progress?
680 static int xs_tcp_send_request(struct rpc_task *task)
682 struct rpc_rqst *req = task->tk_rqstp;
683 struct rpc_xprt *xprt = req->rq_xprt;
684 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
685 struct xdr_buf *xdr = &req->rq_snd_buf;
688 xs_encode_tcp_record_marker(&req->rq_snd_buf);
690 xs_pktdump("packet data:",
691 req->rq_svec->iov_base,
692 req->rq_svec->iov_len);
694 /* Continue transmitting the packet/record. We must be careful
695 * to cope with writespace callbacks arriving _after_ we have
696 * called sendmsg(). */
698 status = xs_sendpages(transport->sock,
699 NULL, 0, xdr, req->rq_bytes_sent);
701 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
702 xdr->len - req->rq_bytes_sent, status);
704 if (unlikely(status < 0))
707 /* If we've sent the entire packet, immediately
708 * reset the count of bytes sent. */
709 req->rq_bytes_sent += status;
710 task->tk_bytes_sent += status;
711 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
712 req->rq_bytes_sent = 0;
721 if (!transport->sock)
727 /* Should we call xs_close() here? */
730 status = xs_nospace(task);
733 dprintk("RPC: sendmsg returned unrecognized error %d\n",
737 xs_tcp_shutdown(xprt);
740 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
747 * xs_tcp_release_xprt - clean up after a tcp transmission
751 * This cleans up if an error causes us to abort the transmission of a request.
752 * In this case, the socket may need to be reset in order to avoid confusing
755 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
757 struct rpc_rqst *req;
759 if (task != xprt->snd_task)
763 req = task->tk_rqstp;
764 if (req->rq_bytes_sent == 0)
766 if (req->rq_bytes_sent == req->rq_snd_buf.len)
768 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
770 xprt_release_xprt(xprt, task);
773 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
775 transport->old_data_ready = sk->sk_data_ready;
776 transport->old_state_change = sk->sk_state_change;
777 transport->old_write_space = sk->sk_write_space;
778 transport->old_error_report = sk->sk_error_report;
781 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
783 sk->sk_data_ready = transport->old_data_ready;
784 sk->sk_state_change = transport->old_state_change;
785 sk->sk_write_space = transport->old_write_space;
786 sk->sk_error_report = transport->old_error_report;
789 static void xs_reset_transport(struct sock_xprt *transport)
791 struct socket *sock = transport->sock;
792 struct sock *sk = transport->inet;
797 write_lock_bh(&sk->sk_callback_lock);
798 transport->inet = NULL;
799 transport->sock = NULL;
801 sk->sk_user_data = NULL;
803 xs_restore_old_callbacks(transport, sk);
804 write_unlock_bh(&sk->sk_callback_lock);
812 * xs_close - close a socket
815 * This is used when all requests are complete; ie, no DRC state remains
816 * on the server we want to save.
818 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
819 * xs_reset_transport() zeroing the socket from underneath a writer.
821 static void xs_close(struct rpc_xprt *xprt)
823 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
825 dprintk("RPC: xs_close xprt %p\n", xprt);
827 xs_reset_transport(transport);
829 smp_mb__before_clear_bit();
830 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
831 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
832 clear_bit(XPRT_CLOSING, &xprt->state);
833 smp_mb__after_clear_bit();
834 xprt_disconnect_done(xprt);
837 static void xs_tcp_close(struct rpc_xprt *xprt)
839 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state))
842 xs_tcp_shutdown(xprt);
846 * xs_destroy - prepare to shutdown a transport
847 * @xprt: doomed transport
850 static void xs_destroy(struct rpc_xprt *xprt)
852 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
854 dprintk("RPC: xs_destroy xprt %p\n", xprt);
856 cancel_rearming_delayed_work(&transport->connect_worker);
859 xs_free_peer_addresses(xprt);
862 module_put(THIS_MODULE);
865 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
867 return (struct rpc_xprt *) sk->sk_user_data;
871 * xs_udp_data_ready - "data ready" callback for UDP sockets
872 * @sk: socket with data to read
873 * @len: how much data to read
876 static void xs_udp_data_ready(struct sock *sk, int len)
878 struct rpc_task *task;
879 struct rpc_xprt *xprt;
880 struct rpc_rqst *rovr;
882 int err, repsize, copied;
886 read_lock(&sk->sk_callback_lock);
887 dprintk("RPC: xs_udp_data_ready...\n");
888 if (!(xprt = xprt_from_sock(sk)))
891 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
897 repsize = skb->len - sizeof(struct udphdr);
899 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
903 /* Copy the XID from the skb... */
904 xp = skb_header_pointer(skb, sizeof(struct udphdr),
905 sizeof(_xid), &_xid);
909 /* Look up and lock the request corresponding to the given XID */
910 spin_lock(&xprt->transport_lock);
911 rovr = xprt_lookup_rqst(xprt, *xp);
914 task = rovr->rq_task;
916 if ((copied = rovr->rq_private_buf.buflen) > repsize)
919 /* Suck it into the iovec, verify checksum if not done by hw. */
920 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
921 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
925 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
927 /* Something worked... */
928 dst_confirm(skb->dst);
930 xprt_adjust_cwnd(task, copied);
931 xprt_update_rtt(task);
932 xprt_complete_rqst(task, copied);
935 spin_unlock(&xprt->transport_lock);
937 skb_free_datagram(sk, skb);
939 read_unlock(&sk->sk_callback_lock);
942 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
944 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
948 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
949 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
950 used = xdr_skb_read_bits(desc, p, len);
951 transport->tcp_offset += used;
955 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
956 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
957 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
959 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
960 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
962 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
963 transport->tcp_offset = 0;
965 /* Sanity check of the record length */
966 if (unlikely(transport->tcp_reclen < 8)) {
967 dprintk("RPC: invalid TCP record fragment length\n");
968 xprt_force_disconnect(xprt);
971 dprintk("RPC: reading TCP record fragment of length %d\n",
972 transport->tcp_reclen);
975 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
977 if (transport->tcp_offset == transport->tcp_reclen) {
978 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
979 transport->tcp_offset = 0;
980 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
981 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
982 transport->tcp_flags |= TCP_RCV_COPY_XID;
983 transport->tcp_copied = 0;
988 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
993 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
994 dprintk("RPC: reading XID (%Zu bytes)\n", len);
995 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
996 used = xdr_skb_read_bits(desc, p, len);
997 transport->tcp_offset += used;
1000 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
1001 transport->tcp_flags |= TCP_RCV_READ_CALLDIR;
1002 transport->tcp_copied = 4;
1003 dprintk("RPC: reading %s XID %08x\n",
1004 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
1006 ntohl(transport->tcp_xid));
1007 xs_tcp_check_fraghdr(transport);
1010 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
1011 struct xdr_skb_reader *desc)
1018 * We want transport->tcp_offset to be 8 at the end of this routine
1019 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1020 * When this function is called for the first time,
1021 * transport->tcp_offset is 4 (after having already read the xid).
1023 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
1024 len = sizeof(calldir) - offset;
1025 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len);
1026 used = xdr_skb_read_bits(desc, &calldir, len);
1027 transport->tcp_offset += used;
1030 transport->tcp_flags &= ~TCP_RCV_READ_CALLDIR;
1031 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1032 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1034 * We don't yet have the XDR buffer, so we will write the calldir
1035 * out after we get the buffer from the 'struct rpc_rqst'
1037 if (ntohl(calldir) == RPC_REPLY)
1038 transport->tcp_flags |= TCP_RPC_REPLY;
1040 transport->tcp_flags &= ~TCP_RPC_REPLY;
1041 dprintk("RPC: reading %s CALL/REPLY flag %08x\n",
1042 (transport->tcp_flags & TCP_RPC_REPLY) ?
1043 "reply for" : "request with", calldir);
1044 xs_tcp_check_fraghdr(transport);
1047 static inline void xs_tcp_read_request(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
1049 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1050 struct rpc_rqst *req;
1051 struct xdr_buf *rcvbuf;
1055 /* Find and lock the request corresponding to this xid */
1056 spin_lock(&xprt->transport_lock);
1057 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1059 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1060 dprintk("RPC: XID %08x request not found!\n",
1061 ntohl(transport->tcp_xid));
1062 spin_unlock(&xprt->transport_lock);
1066 rcvbuf = &req->rq_private_buf;
1068 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
1070 * Save the RPC direction in the XDR buffer
1072 __be32 calldir = transport->tcp_flags & TCP_RPC_REPLY ?
1073 htonl(RPC_REPLY) : 0;
1075 memcpy(rcvbuf->head[0].iov_base + transport->tcp_copied,
1076 &calldir, sizeof(calldir));
1077 transport->tcp_copied += sizeof(calldir);
1078 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
1082 if (len > transport->tcp_reclen - transport->tcp_offset) {
1083 struct xdr_skb_reader my_desc;
1085 len = transport->tcp_reclen - transport->tcp_offset;
1086 memcpy(&my_desc, desc, sizeof(my_desc));
1087 my_desc.count = len;
1088 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1089 &my_desc, xdr_skb_read_bits);
1093 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1094 desc, xdr_skb_read_bits);
1097 transport->tcp_copied += r;
1098 transport->tcp_offset += r;
1101 /* Error when copying to the receive buffer,
1102 * usually because we weren't able to allocate
1103 * additional buffer pages. All we can do now
1104 * is turn off TCP_RCV_COPY_DATA, so the request
1105 * will not receive any additional updates,
1107 * Any remaining data from this record will
1110 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1111 dprintk("RPC: XID %08x truncated request\n",
1112 ntohl(transport->tcp_xid));
1113 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1114 "tcp_offset = %u, tcp_reclen = %u\n",
1115 xprt, transport->tcp_copied,
1116 transport->tcp_offset, transport->tcp_reclen);
1120 dprintk("RPC: XID %08x read %Zd bytes\n",
1121 ntohl(transport->tcp_xid), r);
1122 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1123 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1124 transport->tcp_offset, transport->tcp_reclen);
1126 if (transport->tcp_copied == req->rq_private_buf.buflen)
1127 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1128 else if (transport->tcp_offset == transport->tcp_reclen) {
1129 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1130 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1134 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1135 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1136 spin_unlock(&xprt->transport_lock);
1137 xs_tcp_check_fraghdr(transport);
1140 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1144 len = transport->tcp_reclen - transport->tcp_offset;
1145 if (len > desc->count)
1148 desc->offset += len;
1149 transport->tcp_offset += len;
1150 dprintk("RPC: discarded %Zu bytes\n", len);
1151 xs_tcp_check_fraghdr(transport);
1154 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1156 struct rpc_xprt *xprt = rd_desc->arg.data;
1157 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1158 struct xdr_skb_reader desc = {
1164 dprintk("RPC: xs_tcp_data_recv started\n");
1166 /* Read in a new fragment marker if necessary */
1167 /* Can we ever really expect to get completely empty fragments? */
1168 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1169 xs_tcp_read_fraghdr(xprt, &desc);
1172 /* Read in the xid if necessary */
1173 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1174 xs_tcp_read_xid(transport, &desc);
1177 /* Read in the call/reply flag */
1178 if (transport->tcp_flags & TCP_RCV_READ_CALLDIR) {
1179 xs_tcp_read_calldir(transport, &desc);
1182 /* Read in the request data */
1183 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1184 xs_tcp_read_request(xprt, &desc);
1187 /* Skip over any trailing bytes on short reads */
1188 xs_tcp_read_discard(transport, &desc);
1189 } while (desc.count);
1190 dprintk("RPC: xs_tcp_data_recv done\n");
1191 return len - desc.count;
1195 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1196 * @sk: socket with data to read
1197 * @bytes: how much data to read
1200 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1202 struct rpc_xprt *xprt;
1203 read_descriptor_t rd_desc;
1206 dprintk("RPC: xs_tcp_data_ready...\n");
1208 read_lock(&sk->sk_callback_lock);
1209 if (!(xprt = xprt_from_sock(sk)))
1214 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1215 rd_desc.arg.data = xprt;
1217 rd_desc.count = 65536;
1218 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1221 read_unlock(&sk->sk_callback_lock);
1225 * Do the equivalent of linger/linger2 handling for dealing with
1226 * broken servers that don't close the socket in a timely
1229 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt *xprt,
1230 unsigned long timeout)
1232 struct sock_xprt *transport;
1234 if (xprt_test_and_set_connecting(xprt))
1236 set_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1237 transport = container_of(xprt, struct sock_xprt, xprt);
1238 queue_delayed_work(rpciod_workqueue, &transport->connect_worker,
1242 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt *xprt)
1244 struct sock_xprt *transport;
1246 transport = container_of(xprt, struct sock_xprt, xprt);
1248 if (!test_bit(XPRT_CONNECTION_ABORT, &xprt->state) ||
1249 !cancel_delayed_work(&transport->connect_worker))
1251 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1252 xprt_clear_connecting(xprt);
1255 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
1257 smp_mb__before_clear_bit();
1258 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1259 clear_bit(XPRT_CLOSING, &xprt->state);
1260 smp_mb__after_clear_bit();
1261 /* Mark transport as closed and wake up all pending tasks */
1262 xprt_disconnect_done(xprt);
1266 * xs_tcp_state_change - callback to handle TCP socket state changes
1267 * @sk: socket whose state has changed
1270 static void xs_tcp_state_change(struct sock *sk)
1272 struct rpc_xprt *xprt;
1274 read_lock(&sk->sk_callback_lock);
1275 if (!(xprt = xprt_from_sock(sk)))
1277 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1278 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
1279 sk->sk_state, xprt_connected(xprt),
1280 sock_flag(sk, SOCK_DEAD),
1281 sock_flag(sk, SOCK_ZAPPED));
1283 switch (sk->sk_state) {
1284 case TCP_ESTABLISHED:
1285 spin_lock_bh(&xprt->transport_lock);
1286 if (!xprt_test_and_set_connected(xprt)) {
1287 struct sock_xprt *transport = container_of(xprt,
1288 struct sock_xprt, xprt);
1290 /* Reset TCP record info */
1291 transport->tcp_offset = 0;
1292 transport->tcp_reclen = 0;
1293 transport->tcp_copied = 0;
1294 transport->tcp_flags =
1295 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1297 xprt_wake_pending_tasks(xprt, -EAGAIN);
1299 spin_unlock_bh(&xprt->transport_lock);
1302 /* The client initiated a shutdown of the socket */
1303 xprt->connect_cookie++;
1304 xprt->reestablish_timeout = 0;
1305 set_bit(XPRT_CLOSING, &xprt->state);
1306 smp_mb__before_clear_bit();
1307 clear_bit(XPRT_CONNECTED, &xprt->state);
1308 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1309 smp_mb__after_clear_bit();
1310 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1312 case TCP_CLOSE_WAIT:
1313 /* The server initiated a shutdown of the socket */
1314 xprt_force_disconnect(xprt);
1316 xprt->connect_cookie++;
1319 * If the server closed down the connection, make sure that
1320 * we back off before reconnecting
1322 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1323 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1326 set_bit(XPRT_CLOSING, &xprt->state);
1327 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1328 smp_mb__before_clear_bit();
1329 clear_bit(XPRT_CONNECTED, &xprt->state);
1330 smp_mb__after_clear_bit();
1333 xs_tcp_cancel_linger_timeout(xprt);
1334 xs_sock_mark_closed(xprt);
1337 read_unlock(&sk->sk_callback_lock);
1341 * xs_error_report - callback mainly for catching socket errors
1344 static void xs_error_report(struct sock *sk)
1346 struct rpc_xprt *xprt;
1348 read_lock(&sk->sk_callback_lock);
1349 if (!(xprt = xprt_from_sock(sk)))
1351 dprintk("RPC: %s client %p...\n"
1353 __func__, xprt, sk->sk_err);
1354 xprt_wake_pending_tasks(xprt, -EAGAIN);
1356 read_unlock(&sk->sk_callback_lock);
1359 static void xs_write_space(struct sock *sk)
1361 struct socket *sock;
1362 struct rpc_xprt *xprt;
1364 if (unlikely(!(sock = sk->sk_socket)))
1366 clear_bit(SOCK_NOSPACE, &sock->flags);
1368 if (unlikely(!(xprt = xprt_from_sock(sk))))
1370 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1373 xprt_write_space(xprt);
1377 * xs_udp_write_space - callback invoked when socket buffer space
1379 * @sk: socket whose state has changed
1381 * Called when more output buffer space is available for this socket.
1382 * We try not to wake our writers until they can make "significant"
1383 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1384 * with a bunch of small requests.
1386 static void xs_udp_write_space(struct sock *sk)
1388 read_lock(&sk->sk_callback_lock);
1390 /* from net/core/sock.c:sock_def_write_space */
1391 if (sock_writeable(sk))
1394 read_unlock(&sk->sk_callback_lock);
1398 * xs_tcp_write_space - callback invoked when socket buffer space
1400 * @sk: socket whose state has changed
1402 * Called when more output buffer space is available for this socket.
1403 * We try not to wake our writers until they can make "significant"
1404 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1405 * with a bunch of small requests.
1407 static void xs_tcp_write_space(struct sock *sk)
1409 read_lock(&sk->sk_callback_lock);
1411 /* from net/core/stream.c:sk_stream_write_space */
1412 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1415 read_unlock(&sk->sk_callback_lock);
1418 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1420 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1421 struct sock *sk = transport->inet;
1423 if (transport->rcvsize) {
1424 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1425 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1427 if (transport->sndsize) {
1428 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1429 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1430 sk->sk_write_space(sk);
1435 * xs_udp_set_buffer_size - set send and receive limits
1436 * @xprt: generic transport
1437 * @sndsize: requested size of send buffer, in bytes
1438 * @rcvsize: requested size of receive buffer, in bytes
1440 * Set socket send and receive buffer size limits.
1442 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1444 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1446 transport->sndsize = 0;
1448 transport->sndsize = sndsize + 1024;
1449 transport->rcvsize = 0;
1451 transport->rcvsize = rcvsize + 1024;
1453 xs_udp_do_set_buffer_size(xprt);
1457 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1458 * @task: task that timed out
1460 * Adjust the congestion window after a retransmit timeout has occurred.
1462 static void xs_udp_timer(struct rpc_task *task)
1464 xprt_adjust_cwnd(task, -ETIMEDOUT);
1467 static unsigned short xs_get_random_port(void)
1469 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1470 unsigned short rand = (unsigned short) net_random() % range;
1471 return rand + xprt_min_resvport;
1475 * xs_set_port - reset the port number in the remote endpoint address
1476 * @xprt: generic transport
1477 * @port: new port number
1480 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1482 struct sockaddr *addr = xs_addr(xprt);
1484 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1486 switch (addr->sa_family) {
1488 ((struct sockaddr_in *)addr)->sin_port = htons(port);
1491 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
1498 static unsigned short xs_get_srcport(struct sock_xprt *transport, struct socket *sock)
1500 unsigned short port = transport->port;
1502 if (port == 0 && transport->xprt.resvport)
1503 port = xs_get_random_port();
1507 static unsigned short xs_next_srcport(struct sock_xprt *transport, struct socket *sock, unsigned short port)
1509 if (transport->port != 0)
1510 transport->port = 0;
1511 if (!transport->xprt.resvport)
1513 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1514 return xprt_max_resvport;
1518 static int xs_bind4(struct sock_xprt *transport, struct socket *sock)
1520 struct sockaddr_in myaddr = {
1521 .sin_family = AF_INET,
1523 struct sockaddr_in *sa;
1525 unsigned short port = xs_get_srcport(transport, sock);
1526 unsigned short last;
1528 sa = (struct sockaddr_in *)&transport->addr;
1529 myaddr.sin_addr = sa->sin_addr;
1531 myaddr.sin_port = htons(port);
1532 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1537 transport->port = port;
1541 port = xs_next_srcport(transport, sock, port);
1544 } while (err == -EADDRINUSE && nloop != 2);
1545 dprintk("RPC: %s %pI4:%u: %s (%d)\n",
1546 __func__, &myaddr.sin_addr,
1547 port, err ? "failed" : "ok", err);
1551 static int xs_bind6(struct sock_xprt *transport, struct socket *sock)
1553 struct sockaddr_in6 myaddr = {
1554 .sin6_family = AF_INET6,
1556 struct sockaddr_in6 *sa;
1558 unsigned short port = xs_get_srcport(transport, sock);
1559 unsigned short last;
1561 sa = (struct sockaddr_in6 *)&transport->addr;
1562 myaddr.sin6_addr = sa->sin6_addr;
1564 myaddr.sin6_port = htons(port);
1565 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1570 transport->port = port;
1574 port = xs_next_srcport(transport, sock, port);
1577 } while (err == -EADDRINUSE && nloop != 2);
1578 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1579 &myaddr.sin6_addr, port, err ? "failed" : "ok", err);
1583 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1584 static struct lock_class_key xs_key[2];
1585 static struct lock_class_key xs_slock_key[2];
1587 static inline void xs_reclassify_socket4(struct socket *sock)
1589 struct sock *sk = sock->sk;
1591 BUG_ON(sock_owned_by_user(sk));
1592 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1593 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1596 static inline void xs_reclassify_socket6(struct socket *sock)
1598 struct sock *sk = sock->sk;
1600 BUG_ON(sock_owned_by_user(sk));
1601 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1602 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1605 static inline void xs_reclassify_socket4(struct socket *sock)
1609 static inline void xs_reclassify_socket6(struct socket *sock)
1614 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1616 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1618 if (!transport->inet) {
1619 struct sock *sk = sock->sk;
1621 write_lock_bh(&sk->sk_callback_lock);
1623 xs_save_old_callbacks(transport, sk);
1625 sk->sk_user_data = xprt;
1626 sk->sk_data_ready = xs_udp_data_ready;
1627 sk->sk_write_space = xs_udp_write_space;
1628 sk->sk_error_report = xs_error_report;
1629 sk->sk_no_check = UDP_CSUM_NORCV;
1630 sk->sk_allocation = GFP_ATOMIC;
1632 xprt_set_connected(xprt);
1634 /* Reset to new socket */
1635 transport->sock = sock;
1636 transport->inet = sk;
1638 write_unlock_bh(&sk->sk_callback_lock);
1640 xs_udp_do_set_buffer_size(xprt);
1644 * xs_udp_connect_worker4 - set up a UDP socket
1645 * @work: RPC transport to connect
1647 * Invoked by a work queue tasklet.
1649 static void xs_udp_connect_worker4(struct work_struct *work)
1651 struct sock_xprt *transport =
1652 container_of(work, struct sock_xprt, connect_worker.work);
1653 struct rpc_xprt *xprt = &transport->xprt;
1654 struct socket *sock = transport->sock;
1655 int err, status = -EIO;
1660 /* Start by resetting any existing state */
1661 xs_reset_transport(transport);
1663 err = sock_create_kern(PF_INET, SOCK_DGRAM, IPPROTO_UDP, &sock);
1665 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1668 xs_reclassify_socket4(sock);
1670 if (xs_bind4(transport, sock)) {
1675 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1676 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1678 xs_udp_finish_connecting(xprt, sock);
1681 xprt_clear_connecting(xprt);
1682 xprt_wake_pending_tasks(xprt, status);
1686 * xs_udp_connect_worker6 - set up a UDP socket
1687 * @work: RPC transport to connect
1689 * Invoked by a work queue tasklet.
1691 static void xs_udp_connect_worker6(struct work_struct *work)
1693 struct sock_xprt *transport =
1694 container_of(work, struct sock_xprt, connect_worker.work);
1695 struct rpc_xprt *xprt = &transport->xprt;
1696 struct socket *sock = transport->sock;
1697 int err, status = -EIO;
1702 /* Start by resetting any existing state */
1703 xs_reset_transport(transport);
1705 err = sock_create_kern(PF_INET6, SOCK_DGRAM, IPPROTO_UDP, &sock);
1707 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1710 xs_reclassify_socket6(sock);
1712 if (xs_bind6(transport, sock) < 0) {
1717 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1718 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1720 xs_udp_finish_connecting(xprt, sock);
1723 xprt_clear_connecting(xprt);
1724 xprt_wake_pending_tasks(xprt, status);
1728 * We need to preserve the port number so the reply cache on the server can
1729 * find our cached RPC replies when we get around to reconnecting.
1731 static void xs_abort_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1734 struct sockaddr any;
1736 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt);
1739 * Disconnect the transport socket by doing a connect operation
1740 * with AF_UNSPEC. This should return immediately...
1742 memset(&any, 0, sizeof(any));
1743 any.sa_family = AF_UNSPEC;
1744 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
1746 xs_sock_mark_closed(xprt);
1748 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1752 static void xs_tcp_reuse_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1754 unsigned int state = transport->inet->sk_state;
1756 if (state == TCP_CLOSE && transport->sock->state == SS_UNCONNECTED)
1758 if ((1 << state) & (TCPF_ESTABLISHED|TCPF_SYN_SENT))
1760 xs_abort_connection(xprt, transport);
1763 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1765 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1767 if (!transport->inet) {
1768 struct sock *sk = sock->sk;
1770 write_lock_bh(&sk->sk_callback_lock);
1772 xs_save_old_callbacks(transport, sk);
1774 sk->sk_user_data = xprt;
1775 sk->sk_data_ready = xs_tcp_data_ready;
1776 sk->sk_state_change = xs_tcp_state_change;
1777 sk->sk_write_space = xs_tcp_write_space;
1778 sk->sk_error_report = xs_error_report;
1779 sk->sk_allocation = GFP_ATOMIC;
1781 /* socket options */
1782 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
1783 sock_reset_flag(sk, SOCK_LINGER);
1784 tcp_sk(sk)->linger2 = 0;
1785 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
1787 xprt_clear_connected(xprt);
1789 /* Reset to new socket */
1790 transport->sock = sock;
1791 transport->inet = sk;
1793 write_unlock_bh(&sk->sk_callback_lock);
1796 if (!xprt_bound(xprt))
1799 /* Tell the socket layer to start connecting... */
1800 xprt->stat.connect_count++;
1801 xprt->stat.connect_start = jiffies;
1802 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
1806 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
1807 * @xprt: RPC transport to connect
1808 * @transport: socket transport to connect
1809 * @create_sock: function to create a socket of the correct type
1811 * Invoked by a work queue tasklet.
1813 static void xs_tcp_setup_socket(struct rpc_xprt *xprt,
1814 struct sock_xprt *transport,
1815 struct socket *(*create_sock)(struct rpc_xprt *,
1816 struct sock_xprt *))
1818 struct socket *sock = transport->sock;
1825 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1826 sock = create_sock(xprt, transport);
1828 status = PTR_ERR(sock);
1834 abort_and_exit = test_and_clear_bit(XPRT_CONNECTION_ABORT,
1836 /* "close" the socket, preserving the local port */
1837 xs_tcp_reuse_connection(xprt, transport);
1843 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1844 xprt, xprt->address_strings[RPC_DISPLAY_ALL]);
1846 status = xs_tcp_finish_connecting(xprt, sock);
1847 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1848 xprt, -status, xprt_connected(xprt),
1849 sock->sk->sk_state);
1852 printk("%s: connect returned unhandled error %d\n",
1854 case -EADDRNOTAVAIL:
1855 /* We're probably in TIME_WAIT. Get rid of existing socket,
1858 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1859 xprt_force_disconnect(xprt);
1863 /* retry with existing socket, after a delay */
1867 xprt_clear_connecting(xprt);
1873 xprt_clear_connecting(xprt);
1874 xprt_wake_pending_tasks(xprt, status);
1877 static struct socket *xs_create_tcp_sock4(struct rpc_xprt *xprt,
1878 struct sock_xprt *transport)
1880 struct socket *sock;
1883 /* start from scratch */
1884 err = sock_create_kern(PF_INET, SOCK_STREAM, IPPROTO_TCP, &sock);
1886 dprintk("RPC: can't create TCP transport socket (%d).\n",
1890 xs_reclassify_socket4(sock);
1892 if (xs_bind4(transport, sock) < 0) {
1898 return ERR_PTR(-EIO);
1902 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1903 * @work: RPC transport to connect
1905 * Invoked by a work queue tasklet.
1907 static void xs_tcp_connect_worker4(struct work_struct *work)
1909 struct sock_xprt *transport =
1910 container_of(work, struct sock_xprt, connect_worker.work);
1911 struct rpc_xprt *xprt = &transport->xprt;
1913 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock4);
1916 static struct socket *xs_create_tcp_sock6(struct rpc_xprt *xprt,
1917 struct sock_xprt *transport)
1919 struct socket *sock;
1922 /* start from scratch */
1923 err = sock_create_kern(PF_INET6, SOCK_STREAM, IPPROTO_TCP, &sock);
1925 dprintk("RPC: can't create TCP transport socket (%d).\n",
1929 xs_reclassify_socket6(sock);
1931 if (xs_bind6(transport, sock) < 0) {
1937 return ERR_PTR(-EIO);
1941 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
1942 * @work: RPC transport to connect
1944 * Invoked by a work queue tasklet.
1946 static void xs_tcp_connect_worker6(struct work_struct *work)
1948 struct sock_xprt *transport =
1949 container_of(work, struct sock_xprt, connect_worker.work);
1950 struct rpc_xprt *xprt = &transport->xprt;
1952 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock6);
1956 * xs_connect - connect a socket to a remote endpoint
1957 * @task: address of RPC task that manages state of connect request
1959 * TCP: If the remote end dropped the connection, delay reconnecting.
1961 * UDP socket connects are synchronous, but we use a work queue anyway
1962 * to guarantee that even unprivileged user processes can set up a
1963 * socket on a privileged port.
1965 * If a UDP socket connect fails, the delay behavior here prevents
1966 * retry floods (hard mounts).
1968 static void xs_connect(struct rpc_task *task)
1970 struct rpc_xprt *xprt = task->tk_xprt;
1971 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1973 if (xprt_test_and_set_connecting(xprt))
1976 if (transport->sock != NULL) {
1977 dprintk("RPC: xs_connect delayed xprt %p for %lu "
1979 xprt, xprt->reestablish_timeout / HZ);
1980 queue_delayed_work(rpciod_workqueue,
1981 &transport->connect_worker,
1982 xprt->reestablish_timeout);
1983 xprt->reestablish_timeout <<= 1;
1984 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
1985 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
1987 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
1988 queue_delayed_work(rpciod_workqueue,
1989 &transport->connect_worker, 0);
1993 static void xs_tcp_connect(struct rpc_task *task)
1995 struct rpc_xprt *xprt = task->tk_xprt;
1997 /* Exit if we need to wait for socket shutdown to complete */
1998 if (test_bit(XPRT_CLOSING, &xprt->state))
2004 * xs_udp_print_stats - display UDP socket-specifc stats
2005 * @xprt: rpc_xprt struct containing statistics
2009 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2011 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2013 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
2015 xprt->stat.bind_count,
2018 xprt->stat.bad_xids,
2020 xprt->stat.bklog_u);
2024 * xs_tcp_print_stats - display TCP socket-specifc stats
2025 * @xprt: rpc_xprt struct containing statistics
2029 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2031 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2034 if (xprt_connected(xprt))
2035 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2037 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
2039 xprt->stat.bind_count,
2040 xprt->stat.connect_count,
2041 xprt->stat.connect_time,
2045 xprt->stat.bad_xids,
2047 xprt->stat.bklog_u);
2050 static struct rpc_xprt_ops xs_udp_ops = {
2051 .set_buffer_size = xs_udp_set_buffer_size,
2052 .reserve_xprt = xprt_reserve_xprt_cong,
2053 .release_xprt = xprt_release_xprt_cong,
2054 .rpcbind = rpcb_getport_async,
2055 .set_port = xs_set_port,
2056 .connect = xs_connect,
2057 .buf_alloc = rpc_malloc,
2058 .buf_free = rpc_free,
2059 .send_request = xs_udp_send_request,
2060 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2061 .timer = xs_udp_timer,
2062 .release_request = xprt_release_rqst_cong,
2064 .destroy = xs_destroy,
2065 .print_stats = xs_udp_print_stats,
2068 static struct rpc_xprt_ops xs_tcp_ops = {
2069 .reserve_xprt = xprt_reserve_xprt,
2070 .release_xprt = xs_tcp_release_xprt,
2071 .rpcbind = rpcb_getport_async,
2072 .set_port = xs_set_port,
2073 .connect = xs_tcp_connect,
2074 .buf_alloc = rpc_malloc,
2075 .buf_free = rpc_free,
2076 .send_request = xs_tcp_send_request,
2077 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2078 .close = xs_tcp_close,
2079 .destroy = xs_destroy,
2080 .print_stats = xs_tcp_print_stats,
2083 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2084 unsigned int slot_table_size)
2086 struct rpc_xprt *xprt;
2087 struct sock_xprt *new;
2089 if (args->addrlen > sizeof(xprt->addr)) {
2090 dprintk("RPC: xs_setup_xprt: address too large\n");
2091 return ERR_PTR(-EBADF);
2094 new = kzalloc(sizeof(*new), GFP_KERNEL);
2096 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2098 return ERR_PTR(-ENOMEM);
2102 xprt->max_reqs = slot_table_size;
2103 xprt->slot = kcalloc(xprt->max_reqs, sizeof(struct rpc_rqst), GFP_KERNEL);
2104 if (xprt->slot == NULL) {
2106 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
2108 return ERR_PTR(-ENOMEM);
2111 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2112 xprt->addrlen = args->addrlen;
2114 memcpy(&new->addr, args->srcaddr, args->addrlen);
2119 static const struct rpc_timeout xs_udp_default_timeout = {
2120 .to_initval = 5 * HZ,
2121 .to_maxval = 30 * HZ,
2122 .to_increment = 5 * HZ,
2127 * xs_setup_udp - Set up transport to use a UDP socket
2128 * @args: rpc transport creation arguments
2131 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2133 struct sockaddr *addr = args->dstaddr;
2134 struct rpc_xprt *xprt;
2135 struct sock_xprt *transport;
2137 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries);
2140 transport = container_of(xprt, struct sock_xprt, xprt);
2142 xprt->prot = IPPROTO_UDP;
2144 /* XXX: header size can vary due to auth type, IPv6, etc. */
2145 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2147 xprt->bind_timeout = XS_BIND_TO;
2148 xprt->connect_timeout = XS_UDP_CONN_TO;
2149 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2150 xprt->idle_timeout = XS_IDLE_DISC_TO;
2152 xprt->ops = &xs_udp_ops;
2154 xprt->timeout = &xs_udp_default_timeout;
2156 switch (addr->sa_family) {
2158 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2159 xprt_set_bound(xprt);
2161 INIT_DELAYED_WORK(&transport->connect_worker,
2162 xs_udp_connect_worker4);
2163 xs_format_ipv4_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2166 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2167 xprt_set_bound(xprt);
2169 INIT_DELAYED_WORK(&transport->connect_worker,
2170 xs_udp_connect_worker6);
2171 xs_format_ipv6_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2175 return ERR_PTR(-EAFNOSUPPORT);
2178 dprintk("RPC: set up transport to address %s\n",
2179 xprt->address_strings[RPC_DISPLAY_ALL]);
2181 if (try_module_get(THIS_MODULE))
2186 return ERR_PTR(-EINVAL);
2189 static const struct rpc_timeout xs_tcp_default_timeout = {
2190 .to_initval = 60 * HZ,
2191 .to_maxval = 60 * HZ,
2196 * xs_setup_tcp - Set up transport to use a TCP socket
2197 * @args: rpc transport creation arguments
2200 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2202 struct sockaddr *addr = args->dstaddr;
2203 struct rpc_xprt *xprt;
2204 struct sock_xprt *transport;
2206 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries);
2209 transport = container_of(xprt, struct sock_xprt, xprt);
2211 xprt->prot = IPPROTO_TCP;
2212 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2213 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2215 xprt->bind_timeout = XS_BIND_TO;
2216 xprt->connect_timeout = XS_TCP_CONN_TO;
2217 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2218 xprt->idle_timeout = XS_IDLE_DISC_TO;
2220 xprt->ops = &xs_tcp_ops;
2221 xprt->timeout = &xs_tcp_default_timeout;
2223 switch (addr->sa_family) {
2225 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2226 xprt_set_bound(xprt);
2228 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker4);
2229 xs_format_ipv4_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2232 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2233 xprt_set_bound(xprt);
2235 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_connect_worker6);
2236 xs_format_ipv6_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2240 return ERR_PTR(-EAFNOSUPPORT);
2243 dprintk("RPC: set up transport to address %s\n",
2244 xprt->address_strings[RPC_DISPLAY_ALL]);
2246 if (try_module_get(THIS_MODULE))
2251 return ERR_PTR(-EINVAL);
2254 static struct xprt_class xs_udp_transport = {
2255 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2257 .owner = THIS_MODULE,
2258 .ident = IPPROTO_UDP,
2259 .setup = xs_setup_udp,
2262 static struct xprt_class xs_tcp_transport = {
2263 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2265 .owner = THIS_MODULE,
2266 .ident = IPPROTO_TCP,
2267 .setup = xs_setup_tcp,
2271 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2274 int init_socket_xprt(void)
2277 if (!sunrpc_table_header)
2278 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2281 xprt_register_transport(&xs_udp_transport);
2282 xprt_register_transport(&xs_tcp_transport);
2288 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2291 void cleanup_socket_xprt(void)
2294 if (sunrpc_table_header) {
2295 unregister_sysctl_table(sunrpc_table_header);
2296 sunrpc_table_header = NULL;
2300 xprt_unregister_transport(&xs_udp_transport);
2301 xprt_unregister_transport(&xs_tcp_transport);