2 * linux/net/sunrpc/xprtsock.c
4 * Client-side transport implementation for sockets.
6 * TCP callback races fixes (C) 1998 Red Hat Software <alan@redhat.com>
7 * TCP send fixes (C) 1998 Red Hat Software <alan@redhat.com>
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>
18 #include <linux/types.h>
19 #include <linux/slab.h>
20 #include <linux/capability.h>
21 #include <linux/sched.h>
22 #include <linux/pagemap.h>
23 #include <linux/errno.h>
24 #include <linux/socket.h>
26 #include <linux/net.h>
28 #include <linux/udp.h>
29 #include <linux/tcp.h>
30 #include <linux/sunrpc/clnt.h>
31 #include <linux/sunrpc/sched.h>
32 #include <linux/file.h>
35 #include <net/checksum.h>
42 unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
43 unsigned int xprt_tcp_slot_table_entries = RPC_DEF_SLOT_TABLE;
45 unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
46 unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
49 * How many times to try sending a request on a socket before waiting
50 * for the socket buffer to clear.
52 #define XS_SENDMSG_RETRY (10U)
55 * Time out for an RPC UDP socket connect. UDP socket connects are
56 * synchronous, but we set a timeout anyway in case of resource
57 * exhaustion on the local host.
59 #define XS_UDP_CONN_TO (5U * HZ)
62 * Wait duration for an RPC TCP connection to be established. Solaris
63 * NFS over TCP uses 60 seconds, for example, which is in line with how
64 * long a server takes to reboot.
66 #define XS_TCP_CONN_TO (60U * HZ)
69 * Wait duration for a reply from the RPC portmapper.
71 #define XS_BIND_TO (60U * HZ)
74 * Delay if a UDP socket connect error occurs. This is most likely some
75 * kind of resource problem on the local host.
77 #define XS_UDP_REEST_TO (2U * HZ)
80 * The reestablish timeout allows clients to delay for a bit before attempting
81 * to reconnect to a server that just dropped our connection.
83 * We implement an exponential backoff when trying to reestablish a TCP
84 * transport connection with the server. Some servers like to drop a TCP
85 * connection when they are overworked, so we start with a short timeout and
86 * increase over time if the server is down or not responding.
88 #define XS_TCP_INIT_REEST_TO (3U * HZ)
89 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
92 * TCP idle timeout; client drops the transport socket if it is idle
93 * for this long. Note that we also timeout UDP sockets to prevent
94 * holding port numbers when there is no RPC traffic.
96 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
99 # undef RPC_DEBUG_DATA
100 # define RPCDBG_FACILITY RPCDBG_TRANS
103 #ifdef RPC_DEBUG_DATA
104 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
106 u8 *buf = (u8 *) packet;
109 dprintk("RPC: %s\n", msg);
110 for (j = 0; j < count && j < 128; j += 4) {
114 dprintk("0x%04x ", j);
116 dprintk("%02x%02x%02x%02x ",
117 buf[j], buf[j+1], buf[j+2], buf[j+3]);
122 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
128 static void xs_format_peer_addresses(struct rpc_xprt *xprt)
130 struct sockaddr_in *addr = (struct sockaddr_in *) &xprt->addr;
133 buf = kzalloc(20, GFP_KERNEL);
135 snprintf(buf, 20, "%u.%u.%u.%u",
136 NIPQUAD(addr->sin_addr.s_addr));
138 xprt->address_strings[RPC_DISPLAY_ADDR] = buf;
140 buf = kzalloc(8, GFP_KERNEL);
142 snprintf(buf, 8, "%u",
143 ntohs(addr->sin_port));
145 xprt->address_strings[RPC_DISPLAY_PORT] = buf;
147 if (xprt->prot == IPPROTO_UDP)
148 xprt->address_strings[RPC_DISPLAY_PROTO] = "udp";
150 xprt->address_strings[RPC_DISPLAY_PROTO] = "tcp";
152 buf = kzalloc(48, GFP_KERNEL);
154 snprintf(buf, 48, "addr=%u.%u.%u.%u port=%u proto=%s",
155 NIPQUAD(addr->sin_addr.s_addr),
156 ntohs(addr->sin_port),
157 xprt->prot == IPPROTO_UDP ? "udp" : "tcp");
159 xprt->address_strings[RPC_DISPLAY_ALL] = buf;
162 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
164 kfree(xprt->address_strings[RPC_DISPLAY_ADDR]);
165 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
166 kfree(xprt->address_strings[RPC_DISPLAY_ALL]);
169 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
171 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
173 struct msghdr msg = {
175 .msg_namelen = addrlen,
176 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
179 .iov_base = vec->iov_base + base,
180 .iov_len = vec->iov_len - base,
183 if (iov.iov_len != 0)
184 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
185 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
188 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more)
191 unsigned int remainder;
194 remainder = xdr->page_len - base;
195 base += xdr->page_base;
196 ppage = xdr->pages + (base >> PAGE_SHIFT);
199 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
200 int flags = XS_SENDMSG_FLAGS;
203 if (remainder != 0 || more)
205 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
206 if (remainder == 0 || err != len)
220 * xs_sendpages - write pages directly to a socket
221 * @sock: socket to send on
222 * @addr: UDP only -- address of destination
223 * @addrlen: UDP only -- length of destination address
224 * @xdr: buffer containing this request
225 * @base: starting position in the buffer
228 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
230 unsigned int remainder = xdr->len - base;
236 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
242 if (base < xdr->head[0].iov_len || addr != NULL) {
243 unsigned int len = xdr->head[0].iov_len - base;
245 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
246 if (remainder == 0 || err != len)
251 base -= xdr->head[0].iov_len;
253 if (base < xdr->page_len) {
254 unsigned int len = xdr->page_len - base;
256 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
257 if (remainder == 0 || err != len)
262 base -= xdr->page_len;
264 if (base >= xdr->tail[0].iov_len)
266 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
276 * xs_nospace - place task on wait queue if transmit was incomplete
277 * @task: task to put to sleep
280 static void xs_nospace(struct rpc_task *task)
282 struct rpc_rqst *req = task->tk_rqstp;
283 struct rpc_xprt *xprt = req->rq_xprt;
285 dprintk("RPC: %4d xmit incomplete (%u left of %u)\n",
286 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
289 if (test_bit(SOCK_ASYNC_NOSPACE, &xprt->sock->flags)) {
290 /* Protect against races with write_space */
291 spin_lock_bh(&xprt->transport_lock);
293 /* Don't race with disconnect */
294 if (!xprt_connected(xprt))
295 task->tk_status = -ENOTCONN;
296 else if (test_bit(SOCK_NOSPACE, &xprt->sock->flags))
297 xprt_wait_for_buffer_space(task);
299 spin_unlock_bh(&xprt->transport_lock);
301 /* Keep holding the socket if it is blocked */
302 rpc_delay(task, HZ>>4);
306 * xs_udp_send_request - write an RPC request to a UDP socket
307 * @task: address of RPC task that manages the state of an RPC request
310 * 0: The request has been sent
311 * EAGAIN: The socket was blocked, please call again later to
312 * complete the request
313 * ENOTCONN: Caller needs to invoke connect logic then call again
314 * other: Some other error occured, the request was not sent
316 static int xs_udp_send_request(struct rpc_task *task)
318 struct rpc_rqst *req = task->tk_rqstp;
319 struct rpc_xprt *xprt = req->rq_xprt;
320 struct xdr_buf *xdr = &req->rq_snd_buf;
323 xs_pktdump("packet data:",
324 req->rq_svec->iov_base,
325 req->rq_svec->iov_len);
327 req->rq_xtime = jiffies;
328 status = xs_sendpages(xprt->sock, (struct sockaddr *) &xprt->addr,
329 xprt->addrlen, xdr, req->rq_bytes_sent);
331 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
332 xdr->len - req->rq_bytes_sent, status);
334 if (likely(status >= (int) req->rq_slen))
337 /* Still some bytes left; set up for a retry later. */
345 /* When the server has died, an ICMP port unreachable message
346 * prompts ECONNREFUSED. */
352 dprintk("RPC: sendmsg returned unrecognized error %d\n",
360 static inline void xs_encode_tcp_record_marker(struct xdr_buf *buf)
362 u32 reclen = buf->len - sizeof(rpc_fraghdr);
363 rpc_fraghdr *base = buf->head[0].iov_base;
364 *base = htonl(RPC_LAST_STREAM_FRAGMENT | reclen);
368 * xs_tcp_send_request - write an RPC request to a TCP socket
369 * @task: address of RPC task that manages the state of an RPC request
372 * 0: The request has been sent
373 * EAGAIN: The socket was blocked, please call again later to
374 * complete the request
375 * ENOTCONN: Caller needs to invoke connect logic then call again
376 * other: Some other error occured, the request was not sent
378 * XXX: In the case of soft timeouts, should we eventually give up
379 * if sendmsg is not able to make progress?
381 static int xs_tcp_send_request(struct rpc_task *task)
383 struct rpc_rqst *req = task->tk_rqstp;
384 struct rpc_xprt *xprt = req->rq_xprt;
385 struct xdr_buf *xdr = &req->rq_snd_buf;
386 int status, retry = 0;
388 xs_encode_tcp_record_marker(&req->rq_snd_buf);
390 xs_pktdump("packet data:",
391 req->rq_svec->iov_base,
392 req->rq_svec->iov_len);
394 /* Continue transmitting the packet/record. We must be careful
395 * to cope with writespace callbacks arriving _after_ we have
396 * called sendmsg(). */
398 req->rq_xtime = jiffies;
399 status = xs_sendpages(xprt->sock, NULL, 0, xdr,
402 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
403 xdr->len - req->rq_bytes_sent, status);
405 if (unlikely(status < 0))
408 /* If we've sent the entire packet, immediately
409 * reset the count of bytes sent. */
410 req->rq_bytes_sent += status;
411 task->tk_bytes_sent += status;
412 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
413 req->rq_bytes_sent = 0;
418 if (retry++ > XS_SENDMSG_RETRY)
433 dprintk("RPC: sendmsg returned unrecognized error %d\n",
435 xprt_disconnect(xprt);
443 * xs_tcp_release_xprt - clean up after a tcp transmission
447 * This cleans up if an error causes us to abort the transmission of a request.
448 * In this case, the socket may need to be reset in order to avoid confusing
451 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
453 struct rpc_rqst *req;
455 if (task != xprt->snd_task)
459 req = task->tk_rqstp;
460 if (req->rq_bytes_sent == 0)
462 if (req->rq_bytes_sent == req->rq_snd_buf.len)
464 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
466 xprt_release_xprt(xprt, task);
470 * xs_close - close a socket
473 * This is used when all requests are complete; ie, no DRC state remains
474 * on the server we want to save.
476 static void xs_close(struct rpc_xprt *xprt)
478 struct socket *sock = xprt->sock;
479 struct sock *sk = xprt->inet;
482 goto clear_close_wait;
484 dprintk("RPC: xs_close xprt %p\n", xprt);
486 write_lock_bh(&sk->sk_callback_lock);
490 sk->sk_user_data = NULL;
491 sk->sk_data_ready = xprt->old_data_ready;
492 sk->sk_state_change = xprt->old_state_change;
493 sk->sk_write_space = xprt->old_write_space;
494 write_unlock_bh(&sk->sk_callback_lock);
500 smp_mb__before_clear_bit();
501 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
502 smp_mb__after_clear_bit();
506 * xs_destroy - prepare to shutdown a transport
507 * @xprt: doomed transport
510 static void xs_destroy(struct rpc_xprt *xprt)
512 dprintk("RPC: xs_destroy xprt %p\n", xprt);
514 cancel_delayed_work(&xprt->connect_worker);
515 flush_scheduled_work();
517 xprt_disconnect(xprt);
519 xs_free_peer_addresses(xprt);
523 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
525 return (struct rpc_xprt *) sk->sk_user_data;
529 * xs_udp_data_ready - "data ready" callback for UDP sockets
530 * @sk: socket with data to read
531 * @len: how much data to read
534 static void xs_udp_data_ready(struct sock *sk, int len)
536 struct rpc_task *task;
537 struct rpc_xprt *xprt;
538 struct rpc_rqst *rovr;
540 int err, repsize, copied;
544 read_lock(&sk->sk_callback_lock);
545 dprintk("RPC: xs_udp_data_ready...\n");
546 if (!(xprt = xprt_from_sock(sk)))
549 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
555 repsize = skb->len - sizeof(struct udphdr);
557 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
561 /* Copy the XID from the skb... */
562 xp = skb_header_pointer(skb, sizeof(struct udphdr),
563 sizeof(_xid), &_xid);
567 /* Look up and lock the request corresponding to the given XID */
568 spin_lock(&xprt->transport_lock);
569 rovr = xprt_lookup_rqst(xprt, *xp);
572 task = rovr->rq_task;
574 if ((copied = rovr->rq_private_buf.buflen) > repsize)
577 /* Suck it into the iovec, verify checksum if not done by hw. */
578 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb))
581 /* Something worked... */
582 dst_confirm(skb->dst);
584 xprt_adjust_cwnd(task, copied);
585 xprt_update_rtt(task);
586 xprt_complete_rqst(task, copied);
589 spin_unlock(&xprt->transport_lock);
591 skb_free_datagram(sk, skb);
593 read_unlock(&sk->sk_callback_lock);
596 static inline size_t xs_tcp_copy_data(skb_reader_t *desc, void *p, size_t len)
598 if (len > desc->count)
600 if (skb_copy_bits(desc->skb, desc->offset, p, len)) {
601 dprintk("RPC: failed to copy %zu bytes from skb. %zu bytes remain\n",
607 dprintk("RPC: copied %zu bytes from skb. %zu bytes remain\n",
612 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, skb_reader_t *desc)
617 p = ((char *) &xprt->tcp_recm) + xprt->tcp_offset;
618 len = sizeof(xprt->tcp_recm) - xprt->tcp_offset;
619 used = xs_tcp_copy_data(desc, p, len);
620 xprt->tcp_offset += used;
624 xprt->tcp_reclen = ntohl(xprt->tcp_recm);
625 if (xprt->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
626 xprt->tcp_flags |= XPRT_LAST_FRAG;
628 xprt->tcp_flags &= ~XPRT_LAST_FRAG;
629 xprt->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
631 xprt->tcp_flags &= ~XPRT_COPY_RECM;
632 xprt->tcp_offset = 0;
634 /* Sanity check of the record length */
635 if (unlikely(xprt->tcp_reclen < 4)) {
636 dprintk("RPC: invalid TCP record fragment length\n");
637 xprt_disconnect(xprt);
640 dprintk("RPC: reading TCP record fragment of length %d\n",
644 static void xs_tcp_check_recm(struct rpc_xprt *xprt)
646 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, tcp_reclen = %u, tcp_flags = %lx\n",
647 xprt, xprt->tcp_copied, xprt->tcp_offset, xprt->tcp_reclen, xprt->tcp_flags);
648 if (xprt->tcp_offset == xprt->tcp_reclen) {
649 xprt->tcp_flags |= XPRT_COPY_RECM;
650 xprt->tcp_offset = 0;
651 if (xprt->tcp_flags & XPRT_LAST_FRAG) {
652 xprt->tcp_flags &= ~XPRT_COPY_DATA;
653 xprt->tcp_flags |= XPRT_COPY_XID;
654 xprt->tcp_copied = 0;
659 static inline void xs_tcp_read_xid(struct rpc_xprt *xprt, skb_reader_t *desc)
664 len = sizeof(xprt->tcp_xid) - xprt->tcp_offset;
665 dprintk("RPC: reading XID (%Zu bytes)\n", len);
666 p = ((char *) &xprt->tcp_xid) + xprt->tcp_offset;
667 used = xs_tcp_copy_data(desc, p, len);
668 xprt->tcp_offset += used;
671 xprt->tcp_flags &= ~XPRT_COPY_XID;
672 xprt->tcp_flags |= XPRT_COPY_DATA;
673 xprt->tcp_copied = 4;
674 dprintk("RPC: reading reply for XID %08x\n",
675 ntohl(xprt->tcp_xid));
676 xs_tcp_check_recm(xprt);
679 static inline void xs_tcp_read_request(struct rpc_xprt *xprt, skb_reader_t *desc)
681 struct rpc_rqst *req;
682 struct xdr_buf *rcvbuf;
686 /* Find and lock the request corresponding to this xid */
687 spin_lock(&xprt->transport_lock);
688 req = xprt_lookup_rqst(xprt, xprt->tcp_xid);
690 xprt->tcp_flags &= ~XPRT_COPY_DATA;
691 dprintk("RPC: XID %08x request not found!\n",
692 ntohl(xprt->tcp_xid));
693 spin_unlock(&xprt->transport_lock);
697 rcvbuf = &req->rq_private_buf;
699 if (len > xprt->tcp_reclen - xprt->tcp_offset) {
700 skb_reader_t my_desc;
702 len = xprt->tcp_reclen - xprt->tcp_offset;
703 memcpy(&my_desc, desc, sizeof(my_desc));
705 r = xdr_partial_copy_from_skb(rcvbuf, xprt->tcp_copied,
706 &my_desc, xs_tcp_copy_data);
710 r = xdr_partial_copy_from_skb(rcvbuf, xprt->tcp_copied,
711 desc, xs_tcp_copy_data);
714 xprt->tcp_copied += r;
715 xprt->tcp_offset += r;
718 /* Error when copying to the receive buffer,
719 * usually because we weren't able to allocate
720 * additional buffer pages. All we can do now
721 * is turn off XPRT_COPY_DATA, so the request
722 * will not receive any additional updates,
724 * Any remaining data from this record will
727 xprt->tcp_flags &= ~XPRT_COPY_DATA;
728 dprintk("RPC: XID %08x truncated request\n",
729 ntohl(xprt->tcp_xid));
730 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, tcp_reclen = %u\n",
731 xprt, xprt->tcp_copied, xprt->tcp_offset, xprt->tcp_reclen);
735 dprintk("RPC: XID %08x read %Zd bytes\n",
736 ntohl(xprt->tcp_xid), r);
737 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, tcp_reclen = %u\n",
738 xprt, xprt->tcp_copied, xprt->tcp_offset, xprt->tcp_reclen);
740 if (xprt->tcp_copied == req->rq_private_buf.buflen)
741 xprt->tcp_flags &= ~XPRT_COPY_DATA;
742 else if (xprt->tcp_offset == xprt->tcp_reclen) {
743 if (xprt->tcp_flags & XPRT_LAST_FRAG)
744 xprt->tcp_flags &= ~XPRT_COPY_DATA;
748 if (!(xprt->tcp_flags & XPRT_COPY_DATA))
749 xprt_complete_rqst(req->rq_task, xprt->tcp_copied);
750 spin_unlock(&xprt->transport_lock);
751 xs_tcp_check_recm(xprt);
754 static inline void xs_tcp_read_discard(struct rpc_xprt *xprt, skb_reader_t *desc)
758 len = xprt->tcp_reclen - xprt->tcp_offset;
759 if (len > desc->count)
763 xprt->tcp_offset += len;
764 dprintk("RPC: discarded %Zu bytes\n", len);
765 xs_tcp_check_recm(xprt);
768 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
770 struct rpc_xprt *xprt = rd_desc->arg.data;
771 skb_reader_t desc = {
778 dprintk("RPC: xs_tcp_data_recv started\n");
780 /* Read in a new fragment marker if necessary */
781 /* Can we ever really expect to get completely empty fragments? */
782 if (xprt->tcp_flags & XPRT_COPY_RECM) {
783 xs_tcp_read_fraghdr(xprt, &desc);
786 /* Read in the xid if necessary */
787 if (xprt->tcp_flags & XPRT_COPY_XID) {
788 xs_tcp_read_xid(xprt, &desc);
791 /* Read in the request data */
792 if (xprt->tcp_flags & XPRT_COPY_DATA) {
793 xs_tcp_read_request(xprt, &desc);
796 /* Skip over any trailing bytes on short reads */
797 xs_tcp_read_discard(xprt, &desc);
798 } while (desc.count);
799 dprintk("RPC: xs_tcp_data_recv done\n");
800 return len - desc.count;
804 * xs_tcp_data_ready - "data ready" callback for TCP sockets
805 * @sk: socket with data to read
806 * @bytes: how much data to read
809 static void xs_tcp_data_ready(struct sock *sk, int bytes)
811 struct rpc_xprt *xprt;
812 read_descriptor_t rd_desc;
814 read_lock(&sk->sk_callback_lock);
815 dprintk("RPC: xs_tcp_data_ready...\n");
816 if (!(xprt = xprt_from_sock(sk)))
821 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
822 rd_desc.arg.data = xprt;
823 rd_desc.count = 65536;
824 tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
826 read_unlock(&sk->sk_callback_lock);
830 * xs_tcp_state_change - callback to handle TCP socket state changes
831 * @sk: socket whose state has changed
834 static void xs_tcp_state_change(struct sock *sk)
836 struct rpc_xprt *xprt;
838 read_lock(&sk->sk_callback_lock);
839 if (!(xprt = xprt_from_sock(sk)))
841 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
842 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
843 sk->sk_state, xprt_connected(xprt),
844 sock_flag(sk, SOCK_DEAD),
845 sock_flag(sk, SOCK_ZAPPED));
847 switch (sk->sk_state) {
848 case TCP_ESTABLISHED:
849 spin_lock_bh(&xprt->transport_lock);
850 if (!xprt_test_and_set_connected(xprt)) {
851 /* Reset TCP record info */
852 xprt->tcp_offset = 0;
853 xprt->tcp_reclen = 0;
854 xprt->tcp_copied = 0;
855 xprt->tcp_flags = XPRT_COPY_RECM | XPRT_COPY_XID;
856 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
857 xprt_wake_pending_tasks(xprt, 0);
859 spin_unlock_bh(&xprt->transport_lock);
865 /* Try to schedule an autoclose RPC calls */
866 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
867 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
868 schedule_work(&xprt->task_cleanup);
870 xprt_disconnect(xprt);
873 read_unlock(&sk->sk_callback_lock);
877 * xs_udp_write_space - callback invoked when socket buffer space
879 * @sk: socket whose state has changed
881 * Called when more output buffer space is available for this socket.
882 * We try not to wake our writers until they can make "significant"
883 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
884 * with a bunch of small requests.
886 static void xs_udp_write_space(struct sock *sk)
888 read_lock(&sk->sk_callback_lock);
890 /* from net/core/sock.c:sock_def_write_space */
891 if (sock_writeable(sk)) {
893 struct rpc_xprt *xprt;
895 if (unlikely(!(sock = sk->sk_socket)))
897 if (unlikely(!(xprt = xprt_from_sock(sk))))
899 if (unlikely(!test_and_clear_bit(SOCK_NOSPACE, &sock->flags)))
902 xprt_write_space(xprt);
906 read_unlock(&sk->sk_callback_lock);
910 * xs_tcp_write_space - callback invoked when socket buffer space
912 * @sk: socket whose state has changed
914 * Called when more output buffer space is available for this socket.
915 * We try not to wake our writers until they can make "significant"
916 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
917 * with a bunch of small requests.
919 static void xs_tcp_write_space(struct sock *sk)
921 read_lock(&sk->sk_callback_lock);
923 /* from net/core/stream.c:sk_stream_write_space */
924 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk)) {
926 struct rpc_xprt *xprt;
928 if (unlikely(!(sock = sk->sk_socket)))
930 if (unlikely(!(xprt = xprt_from_sock(sk))))
932 if (unlikely(!test_and_clear_bit(SOCK_NOSPACE, &sock->flags)))
935 xprt_write_space(xprt);
939 read_unlock(&sk->sk_callback_lock);
942 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
944 struct sock *sk = xprt->inet;
947 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
948 sk->sk_rcvbuf = xprt->rcvsize * xprt->max_reqs * 2;
951 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
952 sk->sk_sndbuf = xprt->sndsize * xprt->max_reqs * 2;
953 sk->sk_write_space(sk);
958 * xs_udp_set_buffer_size - set send and receive limits
959 * @xprt: generic transport
960 * @sndsize: requested size of send buffer, in bytes
961 * @rcvsize: requested size of receive buffer, in bytes
963 * Set socket send and receive buffer size limits.
965 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
969 xprt->sndsize = sndsize + 1024;
972 xprt->rcvsize = rcvsize + 1024;
974 xs_udp_do_set_buffer_size(xprt);
978 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
979 * @task: task that timed out
981 * Adjust the congestion window after a retransmit timeout has occurred.
983 static void xs_udp_timer(struct rpc_task *task)
985 xprt_adjust_cwnd(task, -ETIMEDOUT);
988 static unsigned short xs_get_random_port(void)
990 unsigned short range = xprt_max_resvport - xprt_min_resvport;
991 unsigned short rand = (unsigned short) net_random() % range;
992 return rand + xprt_min_resvport;
996 * xs_print_peer_address - format an IPv4 address for printing
997 * @xprt: generic transport
998 * @format: flags field indicating which parts of the address to render
1000 static char *xs_print_peer_address(struct rpc_xprt *xprt, enum rpc_display_format_t format)
1002 if (xprt->address_strings[format] != NULL)
1003 return xprt->address_strings[format];
1005 return "unprintable";
1009 * xs_set_port - reset the port number in the remote endpoint address
1010 * @xprt: generic transport
1011 * @port: new port number
1014 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1016 struct sockaddr_in *sap = (struct sockaddr_in *) &xprt->addr;
1018 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1020 sap->sin_port = htons(port);
1023 static int xs_bindresvport(struct rpc_xprt *xprt, struct socket *sock)
1025 struct sockaddr_in myaddr = {
1026 .sin_family = AF_INET,
1029 unsigned short port = xprt->port;
1032 myaddr.sin_port = htons(port);
1033 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1037 dprintk("RPC: xs_bindresvport bound to port %u\n",
1041 if (port <= xprt_min_resvport)
1042 port = xprt_max_resvport;
1045 } while (err == -EADDRINUSE && port != xprt->port);
1047 dprintk("RPC: can't bind to reserved port (%d).\n", -err);
1052 * xs_udp_connect_worker - set up a UDP socket
1053 * @args: RPC transport to connect
1055 * Invoked by a work queue tasklet.
1057 static void xs_udp_connect_worker(void *args)
1059 struct rpc_xprt *xprt = (struct rpc_xprt *) args;
1060 struct socket *sock = xprt->sock;
1061 int err, status = -EIO;
1063 if (xprt->shutdown || !xprt_bound(xprt))
1066 /* Start by resetting any existing state */
1069 if ((err = sock_create_kern(PF_INET, SOCK_DGRAM, IPPROTO_UDP, &sock)) < 0) {
1070 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1074 if (xprt->resvport && xs_bindresvport(xprt, sock) < 0) {
1079 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1080 xprt, xs_print_peer_address(xprt, RPC_DISPLAY_ALL));
1083 struct sock *sk = sock->sk;
1085 write_lock_bh(&sk->sk_callback_lock);
1087 sk->sk_user_data = xprt;
1088 xprt->old_data_ready = sk->sk_data_ready;
1089 xprt->old_state_change = sk->sk_state_change;
1090 xprt->old_write_space = sk->sk_write_space;
1091 sk->sk_data_ready = xs_udp_data_ready;
1092 sk->sk_write_space = xs_udp_write_space;
1093 sk->sk_no_check = UDP_CSUM_NORCV;
1094 sk->sk_allocation = GFP_ATOMIC;
1096 xprt_set_connected(xprt);
1098 /* Reset to new socket */
1102 write_unlock_bh(&sk->sk_callback_lock);
1104 xs_udp_do_set_buffer_size(xprt);
1107 xprt_wake_pending_tasks(xprt, status);
1108 xprt_clear_connecting(xprt);
1112 * We need to preserve the port number so the reply cache on the server can
1113 * find our cached RPC replies when we get around to reconnecting.
1115 static void xs_tcp_reuse_connection(struct rpc_xprt *xprt)
1118 struct socket *sock = xprt->sock;
1119 struct sockaddr any;
1121 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt);
1124 * Disconnect the transport socket by doing a connect operation
1125 * with AF_UNSPEC. This should return immediately...
1127 memset(&any, 0, sizeof(any));
1128 any.sa_family = AF_UNSPEC;
1129 result = kernel_connect(sock, &any, sizeof(any), 0);
1131 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1136 * xs_tcp_connect_worker - connect a TCP socket to a remote endpoint
1137 * @args: RPC transport to connect
1139 * Invoked by a work queue tasklet.
1141 static void xs_tcp_connect_worker(void *args)
1143 struct rpc_xprt *xprt = (struct rpc_xprt *)args;
1144 struct socket *sock = xprt->sock;
1145 int err, status = -EIO;
1147 if (xprt->shutdown || !xprt_bound(xprt))
1151 /* start from scratch */
1152 if ((err = sock_create_kern(PF_INET, SOCK_STREAM, IPPROTO_TCP, &sock)) < 0) {
1153 dprintk("RPC: can't create TCP transport socket (%d).\n", -err);
1157 if (xprt->resvport && xs_bindresvport(xprt, sock) < 0) {
1162 /* "close" the socket, preserving the local port */
1163 xs_tcp_reuse_connection(xprt);
1165 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1166 xprt, xs_print_peer_address(xprt, RPC_DISPLAY_ALL));
1169 struct sock *sk = sock->sk;
1171 write_lock_bh(&sk->sk_callback_lock);
1173 sk->sk_user_data = xprt;
1174 xprt->old_data_ready = sk->sk_data_ready;
1175 xprt->old_state_change = sk->sk_state_change;
1176 xprt->old_write_space = sk->sk_write_space;
1177 sk->sk_data_ready = xs_tcp_data_ready;
1178 sk->sk_state_change = xs_tcp_state_change;
1179 sk->sk_write_space = xs_tcp_write_space;
1180 sk->sk_allocation = GFP_ATOMIC;
1182 /* socket options */
1183 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
1184 sock_reset_flag(sk, SOCK_LINGER);
1185 tcp_sk(sk)->linger2 = 0;
1186 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
1188 xprt_clear_connected(xprt);
1190 /* Reset to new socket */
1194 write_unlock_bh(&sk->sk_callback_lock);
1197 /* Tell the socket layer to start connecting... */
1198 xprt->stat.connect_count++;
1199 xprt->stat.connect_start = jiffies;
1200 status = kernel_connect(sock, (struct sockaddr *) &xprt->addr,
1201 xprt->addrlen, O_NONBLOCK);
1202 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1203 xprt, -status, xprt_connected(xprt), sock->sk->sk_state);
1211 /* retry with existing socket, after a delay */
1214 /* get rid of existing socket, and retry */
1220 xprt_wake_pending_tasks(xprt, status);
1222 xprt_clear_connecting(xprt);
1226 * xs_connect - connect a socket to a remote endpoint
1227 * @task: address of RPC task that manages state of connect request
1229 * TCP: If the remote end dropped the connection, delay reconnecting.
1231 * UDP socket connects are synchronous, but we use a work queue anyway
1232 * to guarantee that even unprivileged user processes can set up a
1233 * socket on a privileged port.
1235 * If a UDP socket connect fails, the delay behavior here prevents
1236 * retry floods (hard mounts).
1238 static void xs_connect(struct rpc_task *task)
1240 struct rpc_xprt *xprt = task->tk_xprt;
1242 if (xprt_test_and_set_connecting(xprt))
1245 if (xprt->sock != NULL) {
1246 dprintk("RPC: xs_connect delayed xprt %p for %lu seconds\n",
1247 xprt, xprt->reestablish_timeout / HZ);
1248 schedule_delayed_work(&xprt->connect_worker,
1249 xprt->reestablish_timeout);
1250 xprt->reestablish_timeout <<= 1;
1251 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
1252 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
1254 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
1255 schedule_work(&xprt->connect_worker);
1257 /* flush_scheduled_work can sleep... */
1258 if (!RPC_IS_ASYNC(task))
1259 flush_scheduled_work();
1264 * xs_udp_print_stats - display UDP socket-specifc stats
1265 * @xprt: rpc_xprt struct containing statistics
1269 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
1271 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
1273 xprt->stat.bind_count,
1276 xprt->stat.bad_xids,
1278 xprt->stat.bklog_u);
1282 * xs_tcp_print_stats - display TCP socket-specifc stats
1283 * @xprt: rpc_xprt struct containing statistics
1287 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
1291 if (xprt_connected(xprt))
1292 idle_time = (long)(jiffies - xprt->last_used) / HZ;
1294 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
1296 xprt->stat.bind_count,
1297 xprt->stat.connect_count,
1298 xprt->stat.connect_time,
1302 xprt->stat.bad_xids,
1304 xprt->stat.bklog_u);
1307 static struct rpc_xprt_ops xs_udp_ops = {
1308 .set_buffer_size = xs_udp_set_buffer_size,
1309 .print_addr = xs_print_peer_address,
1310 .reserve_xprt = xprt_reserve_xprt_cong,
1311 .release_xprt = xprt_release_xprt_cong,
1312 .rpcbind = rpc_getport,
1313 .set_port = xs_set_port,
1314 .connect = xs_connect,
1315 .buf_alloc = rpc_malloc,
1316 .buf_free = rpc_free,
1317 .send_request = xs_udp_send_request,
1318 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
1319 .timer = xs_udp_timer,
1320 .release_request = xprt_release_rqst_cong,
1322 .destroy = xs_destroy,
1323 .print_stats = xs_udp_print_stats,
1326 static struct rpc_xprt_ops xs_tcp_ops = {
1327 .print_addr = xs_print_peer_address,
1328 .reserve_xprt = xprt_reserve_xprt,
1329 .release_xprt = xs_tcp_release_xprt,
1330 .rpcbind = rpc_getport,
1331 .set_port = xs_set_port,
1332 .connect = xs_connect,
1333 .buf_alloc = rpc_malloc,
1334 .buf_free = rpc_free,
1335 .send_request = xs_tcp_send_request,
1336 .set_retrans_timeout = xprt_set_retrans_timeout_def,
1338 .destroy = xs_destroy,
1339 .print_stats = xs_tcp_print_stats,
1343 * xs_setup_udp - Set up transport to use a UDP socket
1344 * @xprt: transport to set up
1345 * @to: timeout parameters
1348 int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to)
1350 size_t slot_table_size;
1351 struct sockaddr_in *addr = (struct sockaddr_in *) &xprt->addr;
1353 xprt->max_reqs = xprt_udp_slot_table_entries;
1354 slot_table_size = xprt->max_reqs * sizeof(xprt->slot[0]);
1355 xprt->slot = kzalloc(slot_table_size, GFP_KERNEL);
1356 if (xprt->slot == NULL)
1359 if (ntohs(addr->sin_port) != 0)
1360 xprt_set_bound(xprt);
1361 xprt->port = xs_get_random_port();
1363 xprt->prot = IPPROTO_UDP;
1365 /* XXX: header size can vary due to auth type, IPv6, etc. */
1366 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
1368 INIT_WORK(&xprt->connect_worker, xs_udp_connect_worker, xprt);
1369 xprt->bind_timeout = XS_BIND_TO;
1370 xprt->connect_timeout = XS_UDP_CONN_TO;
1371 xprt->reestablish_timeout = XS_UDP_REEST_TO;
1372 xprt->idle_timeout = XS_IDLE_DISC_TO;
1374 xprt->ops = &xs_udp_ops;
1377 xprt->timeout = *to;
1379 xprt_set_timeout(&xprt->timeout, 5, 5 * HZ);
1381 xs_format_peer_addresses(xprt);
1382 dprintk("RPC: set up transport to address %s\n",
1383 xs_print_peer_address(xprt, RPC_DISPLAY_ALL));
1389 * xs_setup_tcp - Set up transport to use a TCP socket
1390 * @xprt: transport to set up
1391 * @to: timeout parameters
1394 int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to)
1396 size_t slot_table_size;
1397 struct sockaddr_in *addr = (struct sockaddr_in *) &xprt->addr;
1399 xprt->max_reqs = xprt_tcp_slot_table_entries;
1400 slot_table_size = xprt->max_reqs * sizeof(xprt->slot[0]);
1401 xprt->slot = kzalloc(slot_table_size, GFP_KERNEL);
1402 if (xprt->slot == NULL)
1405 if (ntohs(addr->sin_port) != 0)
1406 xprt_set_bound(xprt);
1407 xprt->port = xs_get_random_port();
1409 xprt->prot = IPPROTO_TCP;
1410 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
1411 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
1413 INIT_WORK(&xprt->connect_worker, xs_tcp_connect_worker, xprt);
1414 xprt->bind_timeout = XS_BIND_TO;
1415 xprt->connect_timeout = XS_TCP_CONN_TO;
1416 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1417 xprt->idle_timeout = XS_IDLE_DISC_TO;
1419 xprt->ops = &xs_tcp_ops;
1422 xprt->timeout = *to;
1424 xprt_set_timeout(&xprt->timeout, 2, 60 * HZ);
1426 xs_format_peer_addresses(xprt);
1427 dprintk("RPC: set up transport to address %s\n",
1428 xs_print_peer_address(xprt, RPC_DISPLAY_ALL));