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
)
129 struct rpc_xprt xprt
;
132 static void xs_format_peer_addresses(struct rpc_xprt
*xprt
)
134 struct sockaddr_in
*addr
= (struct sockaddr_in
*) &xprt
->addr
;
137 buf
= kzalloc(20, GFP_KERNEL
);
139 snprintf(buf
, 20, "%u.%u.%u.%u",
140 NIPQUAD(addr
->sin_addr
.s_addr
));
142 xprt
->address_strings
[RPC_DISPLAY_ADDR
] = buf
;
144 buf
= kzalloc(8, GFP_KERNEL
);
146 snprintf(buf
, 8, "%u",
147 ntohs(addr
->sin_port
));
149 xprt
->address_strings
[RPC_DISPLAY_PORT
] = buf
;
151 if (xprt
->prot
== IPPROTO_UDP
)
152 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = "udp";
154 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = "tcp";
156 buf
= kzalloc(48, GFP_KERNEL
);
158 snprintf(buf
, 48, "addr=%u.%u.%u.%u port=%u proto=%s",
159 NIPQUAD(addr
->sin_addr
.s_addr
),
160 ntohs(addr
->sin_port
),
161 xprt
->prot
== IPPROTO_UDP
? "udp" : "tcp");
163 xprt
->address_strings
[RPC_DISPLAY_ALL
] = buf
;
166 static void xs_free_peer_addresses(struct rpc_xprt
*xprt
)
168 kfree(xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
169 kfree(xprt
->address_strings
[RPC_DISPLAY_PORT
]);
170 kfree(xprt
->address_strings
[RPC_DISPLAY_ALL
]);
173 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
175 static int xs_send_kvec(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct kvec
*vec
, unsigned int base
, int more
)
177 struct msghdr msg
= {
179 .msg_namelen
= addrlen
,
180 .msg_flags
= XS_SENDMSG_FLAGS
| (more
? MSG_MORE
: 0),
183 .iov_base
= vec
->iov_base
+ base
,
184 .iov_len
= vec
->iov_len
- base
,
187 if (iov
.iov_len
!= 0)
188 return kernel_sendmsg(sock
, &msg
, &iov
, 1, iov
.iov_len
);
189 return kernel_sendmsg(sock
, &msg
, NULL
, 0, 0);
192 static int xs_send_pagedata(struct socket
*sock
, struct xdr_buf
*xdr
, unsigned int base
, int more
)
195 unsigned int remainder
;
198 remainder
= xdr
->page_len
- base
;
199 base
+= xdr
->page_base
;
200 ppage
= xdr
->pages
+ (base
>> PAGE_SHIFT
);
203 unsigned int len
= min_t(unsigned int, PAGE_SIZE
- base
, remainder
);
204 int flags
= XS_SENDMSG_FLAGS
;
207 if (remainder
!= 0 || more
)
209 err
= sock
->ops
->sendpage(sock
, *ppage
, base
, len
, flags
);
210 if (remainder
== 0 || err
!= len
)
224 * xs_sendpages - write pages directly to a socket
225 * @sock: socket to send on
226 * @addr: UDP only -- address of destination
227 * @addrlen: UDP only -- length of destination address
228 * @xdr: buffer containing this request
229 * @base: starting position in the buffer
232 static int xs_sendpages(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct xdr_buf
*xdr
, unsigned int base
)
234 unsigned int remainder
= xdr
->len
- base
;
240 clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
);
246 if (base
< xdr
->head
[0].iov_len
|| addr
!= NULL
) {
247 unsigned int len
= xdr
->head
[0].iov_len
- base
;
249 err
= xs_send_kvec(sock
, addr
, addrlen
, &xdr
->head
[0], base
, remainder
!= 0);
250 if (remainder
== 0 || err
!= len
)
255 base
-= xdr
->head
[0].iov_len
;
257 if (base
< xdr
->page_len
) {
258 unsigned int len
= xdr
->page_len
- base
;
260 err
= xs_send_pagedata(sock
, xdr
, base
, remainder
!= 0);
261 if (remainder
== 0 || err
!= len
)
266 base
-= xdr
->page_len
;
268 if (base
>= xdr
->tail
[0].iov_len
)
270 err
= xs_send_kvec(sock
, NULL
, 0, &xdr
->tail
[0], base
, 0);
280 * xs_nospace - place task on wait queue if transmit was incomplete
281 * @task: task to put to sleep
284 static void xs_nospace(struct rpc_task
*task
)
286 struct rpc_rqst
*req
= task
->tk_rqstp
;
287 struct rpc_xprt
*xprt
= req
->rq_xprt
;
289 dprintk("RPC: %4d xmit incomplete (%u left of %u)\n",
290 task
->tk_pid
, req
->rq_slen
- req
->rq_bytes_sent
,
293 if (test_bit(SOCK_ASYNC_NOSPACE
, &xprt
->sock
->flags
)) {
294 /* Protect against races with write_space */
295 spin_lock_bh(&xprt
->transport_lock
);
297 /* Don't race with disconnect */
298 if (!xprt_connected(xprt
))
299 task
->tk_status
= -ENOTCONN
;
300 else if (test_bit(SOCK_NOSPACE
, &xprt
->sock
->flags
))
301 xprt_wait_for_buffer_space(task
);
303 spin_unlock_bh(&xprt
->transport_lock
);
305 /* Keep holding the socket if it is blocked */
306 rpc_delay(task
, HZ
>>4);
310 * xs_udp_send_request - write an RPC request to a UDP socket
311 * @task: address of RPC task that manages the state of an RPC request
314 * 0: The request has been sent
315 * EAGAIN: The socket was blocked, please call again later to
316 * complete the request
317 * ENOTCONN: Caller needs to invoke connect logic then call again
318 * other: Some other error occured, the request was not sent
320 static int xs_udp_send_request(struct rpc_task
*task
)
322 struct rpc_rqst
*req
= task
->tk_rqstp
;
323 struct rpc_xprt
*xprt
= req
->rq_xprt
;
324 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
327 xs_pktdump("packet data:",
328 req
->rq_svec
->iov_base
,
329 req
->rq_svec
->iov_len
);
331 req
->rq_xtime
= jiffies
;
332 status
= xs_sendpages(xprt
->sock
, (struct sockaddr
*) &xprt
->addr
,
333 xprt
->addrlen
, xdr
, req
->rq_bytes_sent
);
335 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
336 xdr
->len
- req
->rq_bytes_sent
, status
);
338 if (likely(status
>= (int) req
->rq_slen
))
341 /* Still some bytes left; set up for a retry later. */
349 /* When the server has died, an ICMP port unreachable message
350 * prompts ECONNREFUSED. */
356 dprintk("RPC: sendmsg returned unrecognized error %d\n",
364 static inline void xs_encode_tcp_record_marker(struct xdr_buf
*buf
)
366 u32 reclen
= buf
->len
- sizeof(rpc_fraghdr
);
367 rpc_fraghdr
*base
= buf
->head
[0].iov_base
;
368 *base
= htonl(RPC_LAST_STREAM_FRAGMENT
| reclen
);
372 * xs_tcp_send_request - write an RPC request to a TCP socket
373 * @task: address of RPC task that manages the state of an RPC request
376 * 0: The request has been sent
377 * EAGAIN: The socket was blocked, please call again later to
378 * complete the request
379 * ENOTCONN: Caller needs to invoke connect logic then call again
380 * other: Some other error occured, the request was not sent
382 * XXX: In the case of soft timeouts, should we eventually give up
383 * if sendmsg is not able to make progress?
385 static int xs_tcp_send_request(struct rpc_task
*task
)
387 struct rpc_rqst
*req
= task
->tk_rqstp
;
388 struct rpc_xprt
*xprt
= req
->rq_xprt
;
389 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
390 int status
, retry
= 0;
392 xs_encode_tcp_record_marker(&req
->rq_snd_buf
);
394 xs_pktdump("packet data:",
395 req
->rq_svec
->iov_base
,
396 req
->rq_svec
->iov_len
);
398 /* Continue transmitting the packet/record. We must be careful
399 * to cope with writespace callbacks arriving _after_ we have
400 * called sendmsg(). */
402 req
->rq_xtime
= jiffies
;
403 status
= xs_sendpages(xprt
->sock
, NULL
, 0, xdr
,
406 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
407 xdr
->len
- req
->rq_bytes_sent
, status
);
409 if (unlikely(status
< 0))
412 /* If we've sent the entire packet, immediately
413 * reset the count of bytes sent. */
414 req
->rq_bytes_sent
+= status
;
415 task
->tk_bytes_sent
+= status
;
416 if (likely(req
->rq_bytes_sent
>= req
->rq_slen
)) {
417 req
->rq_bytes_sent
= 0;
422 if (retry
++ > XS_SENDMSG_RETRY
)
437 dprintk("RPC: sendmsg returned unrecognized error %d\n",
439 xprt_disconnect(xprt
);
447 * xs_tcp_release_xprt - clean up after a tcp transmission
451 * This cleans up if an error causes us to abort the transmission of a request.
452 * In this case, the socket may need to be reset in order to avoid confusing
455 static void xs_tcp_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
457 struct rpc_rqst
*req
;
459 if (task
!= xprt
->snd_task
)
463 req
= task
->tk_rqstp
;
464 if (req
->rq_bytes_sent
== 0)
466 if (req
->rq_bytes_sent
== req
->rq_snd_buf
.len
)
468 set_bit(XPRT_CLOSE_WAIT
, &task
->tk_xprt
->state
);
470 xprt_release_xprt(xprt
, task
);
474 * xs_close - close a socket
477 * This is used when all requests are complete; ie, no DRC state remains
478 * on the server we want to save.
480 static void xs_close(struct rpc_xprt
*xprt
)
482 struct socket
*sock
= xprt
->sock
;
483 struct sock
*sk
= xprt
->inet
;
486 goto clear_close_wait
;
488 dprintk("RPC: xs_close xprt %p\n", xprt
);
490 write_lock_bh(&sk
->sk_callback_lock
);
494 sk
->sk_user_data
= NULL
;
495 sk
->sk_data_ready
= xprt
->old_data_ready
;
496 sk
->sk_state_change
= xprt
->old_state_change
;
497 sk
->sk_write_space
= xprt
->old_write_space
;
498 write_unlock_bh(&sk
->sk_callback_lock
);
504 smp_mb__before_clear_bit();
505 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
506 smp_mb__after_clear_bit();
510 * xs_destroy - prepare to shutdown a transport
511 * @xprt: doomed transport
514 static void xs_destroy(struct rpc_xprt
*xprt
)
516 dprintk("RPC: xs_destroy xprt %p\n", xprt
);
518 cancel_delayed_work(&xprt
->connect_worker
);
519 flush_scheduled_work();
521 xprt_disconnect(xprt
);
523 xs_free_peer_addresses(xprt
);
528 static inline struct rpc_xprt
*xprt_from_sock(struct sock
*sk
)
530 return (struct rpc_xprt
*) sk
->sk_user_data
;
534 * xs_udp_data_ready - "data ready" callback for UDP sockets
535 * @sk: socket with data to read
536 * @len: how much data to read
539 static void xs_udp_data_ready(struct sock
*sk
, int len
)
541 struct rpc_task
*task
;
542 struct rpc_xprt
*xprt
;
543 struct rpc_rqst
*rovr
;
545 int err
, repsize
, copied
;
549 read_lock(&sk
->sk_callback_lock
);
550 dprintk("RPC: xs_udp_data_ready...\n");
551 if (!(xprt
= xprt_from_sock(sk
)))
554 if ((skb
= skb_recv_datagram(sk
, 0, 1, &err
)) == NULL
)
560 repsize
= skb
->len
- sizeof(struct udphdr
);
562 dprintk("RPC: impossible RPC reply size %d!\n", repsize
);
566 /* Copy the XID from the skb... */
567 xp
= skb_header_pointer(skb
, sizeof(struct udphdr
),
568 sizeof(_xid
), &_xid
);
572 /* Look up and lock the request corresponding to the given XID */
573 spin_lock(&xprt
->transport_lock
);
574 rovr
= xprt_lookup_rqst(xprt
, *xp
);
577 task
= rovr
->rq_task
;
579 if ((copied
= rovr
->rq_private_buf
.buflen
) > repsize
)
582 /* Suck it into the iovec, verify checksum if not done by hw. */
583 if (csum_partial_copy_to_xdr(&rovr
->rq_private_buf
, skb
))
586 /* Something worked... */
587 dst_confirm(skb
->dst
);
589 xprt_adjust_cwnd(task
, copied
);
590 xprt_update_rtt(task
);
591 xprt_complete_rqst(task
, copied
);
594 spin_unlock(&xprt
->transport_lock
);
596 skb_free_datagram(sk
, skb
);
598 read_unlock(&sk
->sk_callback_lock
);
601 static inline size_t xs_tcp_copy_data(skb_reader_t
*desc
, void *p
, size_t len
)
603 if (len
> desc
->count
)
605 if (skb_copy_bits(desc
->skb
, desc
->offset
, p
, len
)) {
606 dprintk("RPC: failed to copy %zu bytes from skb. %zu bytes remain\n",
612 dprintk("RPC: copied %zu bytes from skb. %zu bytes remain\n",
617 static inline void xs_tcp_read_fraghdr(struct rpc_xprt
*xprt
, skb_reader_t
*desc
)
622 p
= ((char *) &xprt
->tcp_recm
) + xprt
->tcp_offset
;
623 len
= sizeof(xprt
->tcp_recm
) - xprt
->tcp_offset
;
624 used
= xs_tcp_copy_data(desc
, p
, len
);
625 xprt
->tcp_offset
+= used
;
629 xprt
->tcp_reclen
= ntohl(xprt
->tcp_recm
);
630 if (xprt
->tcp_reclen
& RPC_LAST_STREAM_FRAGMENT
)
631 xprt
->tcp_flags
|= XPRT_LAST_FRAG
;
633 xprt
->tcp_flags
&= ~XPRT_LAST_FRAG
;
634 xprt
->tcp_reclen
&= RPC_FRAGMENT_SIZE_MASK
;
636 xprt
->tcp_flags
&= ~XPRT_COPY_RECM
;
637 xprt
->tcp_offset
= 0;
639 /* Sanity check of the record length */
640 if (unlikely(xprt
->tcp_reclen
< 4)) {
641 dprintk("RPC: invalid TCP record fragment length\n");
642 xprt_disconnect(xprt
);
645 dprintk("RPC: reading TCP record fragment of length %d\n",
649 static void xs_tcp_check_recm(struct rpc_xprt
*xprt
)
651 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, tcp_reclen = %u, tcp_flags = %lx\n",
652 xprt
, xprt
->tcp_copied
, xprt
->tcp_offset
, xprt
->tcp_reclen
, xprt
->tcp_flags
);
653 if (xprt
->tcp_offset
== xprt
->tcp_reclen
) {
654 xprt
->tcp_flags
|= XPRT_COPY_RECM
;
655 xprt
->tcp_offset
= 0;
656 if (xprt
->tcp_flags
& XPRT_LAST_FRAG
) {
657 xprt
->tcp_flags
&= ~XPRT_COPY_DATA
;
658 xprt
->tcp_flags
|= XPRT_COPY_XID
;
659 xprt
->tcp_copied
= 0;
664 static inline void xs_tcp_read_xid(struct rpc_xprt
*xprt
, skb_reader_t
*desc
)
669 len
= sizeof(xprt
->tcp_xid
) - xprt
->tcp_offset
;
670 dprintk("RPC: reading XID (%Zu bytes)\n", len
);
671 p
= ((char *) &xprt
->tcp_xid
) + xprt
->tcp_offset
;
672 used
= xs_tcp_copy_data(desc
, p
, len
);
673 xprt
->tcp_offset
+= used
;
676 xprt
->tcp_flags
&= ~XPRT_COPY_XID
;
677 xprt
->tcp_flags
|= XPRT_COPY_DATA
;
678 xprt
->tcp_copied
= 4;
679 dprintk("RPC: reading reply for XID %08x\n",
680 ntohl(xprt
->tcp_xid
));
681 xs_tcp_check_recm(xprt
);
684 static inline void xs_tcp_read_request(struct rpc_xprt
*xprt
, skb_reader_t
*desc
)
686 struct rpc_rqst
*req
;
687 struct xdr_buf
*rcvbuf
;
691 /* Find and lock the request corresponding to this xid */
692 spin_lock(&xprt
->transport_lock
);
693 req
= xprt_lookup_rqst(xprt
, xprt
->tcp_xid
);
695 xprt
->tcp_flags
&= ~XPRT_COPY_DATA
;
696 dprintk("RPC: XID %08x request not found!\n",
697 ntohl(xprt
->tcp_xid
));
698 spin_unlock(&xprt
->transport_lock
);
702 rcvbuf
= &req
->rq_private_buf
;
704 if (len
> xprt
->tcp_reclen
- xprt
->tcp_offset
) {
705 skb_reader_t my_desc
;
707 len
= xprt
->tcp_reclen
- xprt
->tcp_offset
;
708 memcpy(&my_desc
, desc
, sizeof(my_desc
));
710 r
= xdr_partial_copy_from_skb(rcvbuf
, xprt
->tcp_copied
,
711 &my_desc
, xs_tcp_copy_data
);
715 r
= xdr_partial_copy_from_skb(rcvbuf
, xprt
->tcp_copied
,
716 desc
, xs_tcp_copy_data
);
719 xprt
->tcp_copied
+= r
;
720 xprt
->tcp_offset
+= r
;
723 /* Error when copying to the receive buffer,
724 * usually because we weren't able to allocate
725 * additional buffer pages. All we can do now
726 * is turn off XPRT_COPY_DATA, so the request
727 * will not receive any additional updates,
729 * Any remaining data from this record will
732 xprt
->tcp_flags
&= ~XPRT_COPY_DATA
;
733 dprintk("RPC: XID %08x truncated request\n",
734 ntohl(xprt
->tcp_xid
));
735 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, tcp_reclen = %u\n",
736 xprt
, xprt
->tcp_copied
, xprt
->tcp_offset
, xprt
->tcp_reclen
);
740 dprintk("RPC: XID %08x read %Zd bytes\n",
741 ntohl(xprt
->tcp_xid
), r
);
742 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, tcp_reclen = %u\n",
743 xprt
, xprt
->tcp_copied
, xprt
->tcp_offset
, xprt
->tcp_reclen
);
745 if (xprt
->tcp_copied
== req
->rq_private_buf
.buflen
)
746 xprt
->tcp_flags
&= ~XPRT_COPY_DATA
;
747 else if (xprt
->tcp_offset
== xprt
->tcp_reclen
) {
748 if (xprt
->tcp_flags
& XPRT_LAST_FRAG
)
749 xprt
->tcp_flags
&= ~XPRT_COPY_DATA
;
753 if (!(xprt
->tcp_flags
& XPRT_COPY_DATA
))
754 xprt_complete_rqst(req
->rq_task
, xprt
->tcp_copied
);
755 spin_unlock(&xprt
->transport_lock
);
756 xs_tcp_check_recm(xprt
);
759 static inline void xs_tcp_read_discard(struct rpc_xprt
*xprt
, skb_reader_t
*desc
)
763 len
= xprt
->tcp_reclen
- xprt
->tcp_offset
;
764 if (len
> desc
->count
)
768 xprt
->tcp_offset
+= len
;
769 dprintk("RPC: discarded %Zu bytes\n", len
);
770 xs_tcp_check_recm(xprt
);
773 static int xs_tcp_data_recv(read_descriptor_t
*rd_desc
, struct sk_buff
*skb
, unsigned int offset
, size_t len
)
775 struct rpc_xprt
*xprt
= rd_desc
->arg
.data
;
776 skb_reader_t desc
= {
783 dprintk("RPC: xs_tcp_data_recv started\n");
785 /* Read in a new fragment marker if necessary */
786 /* Can we ever really expect to get completely empty fragments? */
787 if (xprt
->tcp_flags
& XPRT_COPY_RECM
) {
788 xs_tcp_read_fraghdr(xprt
, &desc
);
791 /* Read in the xid if necessary */
792 if (xprt
->tcp_flags
& XPRT_COPY_XID
) {
793 xs_tcp_read_xid(xprt
, &desc
);
796 /* Read in the request data */
797 if (xprt
->tcp_flags
& XPRT_COPY_DATA
) {
798 xs_tcp_read_request(xprt
, &desc
);
801 /* Skip over any trailing bytes on short reads */
802 xs_tcp_read_discard(xprt
, &desc
);
803 } while (desc
.count
);
804 dprintk("RPC: xs_tcp_data_recv done\n");
805 return len
- desc
.count
;
809 * xs_tcp_data_ready - "data ready" callback for TCP sockets
810 * @sk: socket with data to read
811 * @bytes: how much data to read
814 static void xs_tcp_data_ready(struct sock
*sk
, int bytes
)
816 struct rpc_xprt
*xprt
;
817 read_descriptor_t rd_desc
;
819 read_lock(&sk
->sk_callback_lock
);
820 dprintk("RPC: xs_tcp_data_ready...\n");
821 if (!(xprt
= xprt_from_sock(sk
)))
826 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
827 rd_desc
.arg
.data
= xprt
;
828 rd_desc
.count
= 65536;
829 tcp_read_sock(sk
, &rd_desc
, xs_tcp_data_recv
);
831 read_unlock(&sk
->sk_callback_lock
);
835 * xs_tcp_state_change - callback to handle TCP socket state changes
836 * @sk: socket whose state has changed
839 static void xs_tcp_state_change(struct sock
*sk
)
841 struct rpc_xprt
*xprt
;
843 read_lock(&sk
->sk_callback_lock
);
844 if (!(xprt
= xprt_from_sock(sk
)))
846 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt
);
847 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
848 sk
->sk_state
, xprt_connected(xprt
),
849 sock_flag(sk
, SOCK_DEAD
),
850 sock_flag(sk
, SOCK_ZAPPED
));
852 switch (sk
->sk_state
) {
853 case TCP_ESTABLISHED
:
854 spin_lock_bh(&xprt
->transport_lock
);
855 if (!xprt_test_and_set_connected(xprt
)) {
856 /* Reset TCP record info */
857 xprt
->tcp_offset
= 0;
858 xprt
->tcp_reclen
= 0;
859 xprt
->tcp_copied
= 0;
860 xprt
->tcp_flags
= XPRT_COPY_RECM
| XPRT_COPY_XID
;
861 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
862 xprt_wake_pending_tasks(xprt
, 0);
864 spin_unlock_bh(&xprt
->transport_lock
);
870 /* Try to schedule an autoclose RPC calls */
871 set_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
872 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
) == 0)
873 schedule_work(&xprt
->task_cleanup
);
875 xprt_disconnect(xprt
);
878 read_unlock(&sk
->sk_callback_lock
);
882 * xs_udp_write_space - callback invoked when socket buffer space
884 * @sk: socket whose state has changed
886 * Called when more output buffer space is available for this socket.
887 * We try not to wake our writers until they can make "significant"
888 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
889 * with a bunch of small requests.
891 static void xs_udp_write_space(struct sock
*sk
)
893 read_lock(&sk
->sk_callback_lock
);
895 /* from net/core/sock.c:sock_def_write_space */
896 if (sock_writeable(sk
)) {
898 struct rpc_xprt
*xprt
;
900 if (unlikely(!(sock
= sk
->sk_socket
)))
902 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
904 if (unlikely(!test_and_clear_bit(SOCK_NOSPACE
, &sock
->flags
)))
907 xprt_write_space(xprt
);
911 read_unlock(&sk
->sk_callback_lock
);
915 * xs_tcp_write_space - callback invoked when socket buffer space
917 * @sk: socket whose state has changed
919 * Called when more output buffer space is available for this socket.
920 * We try not to wake our writers until they can make "significant"
921 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
922 * with a bunch of small requests.
924 static void xs_tcp_write_space(struct sock
*sk
)
926 read_lock(&sk
->sk_callback_lock
);
928 /* from net/core/stream.c:sk_stream_write_space */
929 if (sk_stream_wspace(sk
) >= sk_stream_min_wspace(sk
)) {
931 struct rpc_xprt
*xprt
;
933 if (unlikely(!(sock
= sk
->sk_socket
)))
935 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
937 if (unlikely(!test_and_clear_bit(SOCK_NOSPACE
, &sock
->flags
)))
940 xprt_write_space(xprt
);
944 read_unlock(&sk
->sk_callback_lock
);
947 static void xs_udp_do_set_buffer_size(struct rpc_xprt
*xprt
)
949 struct sock
*sk
= xprt
->inet
;
952 sk
->sk_userlocks
|= SOCK_RCVBUF_LOCK
;
953 sk
->sk_rcvbuf
= xprt
->rcvsize
* xprt
->max_reqs
* 2;
956 sk
->sk_userlocks
|= SOCK_SNDBUF_LOCK
;
957 sk
->sk_sndbuf
= xprt
->sndsize
* xprt
->max_reqs
* 2;
958 sk
->sk_write_space(sk
);
963 * xs_udp_set_buffer_size - set send and receive limits
964 * @xprt: generic transport
965 * @sndsize: requested size of send buffer, in bytes
966 * @rcvsize: requested size of receive buffer, in bytes
968 * Set socket send and receive buffer size limits.
970 static void xs_udp_set_buffer_size(struct rpc_xprt
*xprt
, size_t sndsize
, size_t rcvsize
)
974 xprt
->sndsize
= sndsize
+ 1024;
977 xprt
->rcvsize
= rcvsize
+ 1024;
979 xs_udp_do_set_buffer_size(xprt
);
983 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
984 * @task: task that timed out
986 * Adjust the congestion window after a retransmit timeout has occurred.
988 static void xs_udp_timer(struct rpc_task
*task
)
990 xprt_adjust_cwnd(task
, -ETIMEDOUT
);
993 static unsigned short xs_get_random_port(void)
995 unsigned short range
= xprt_max_resvport
- xprt_min_resvport
;
996 unsigned short rand
= (unsigned short) net_random() % range
;
997 return rand
+ xprt_min_resvport
;
1001 * xs_print_peer_address - format an IPv4 address for printing
1002 * @xprt: generic transport
1003 * @format: flags field indicating which parts of the address to render
1005 static char *xs_print_peer_address(struct rpc_xprt
*xprt
, enum rpc_display_format_t format
)
1007 if (xprt
->address_strings
[format
] != NULL
)
1008 return xprt
->address_strings
[format
];
1010 return "unprintable";
1014 * xs_set_port - reset the port number in the remote endpoint address
1015 * @xprt: generic transport
1016 * @port: new port number
1019 static void xs_set_port(struct rpc_xprt
*xprt
, unsigned short port
)
1021 struct sockaddr_in
*sap
= (struct sockaddr_in
*) &xprt
->addr
;
1023 dprintk("RPC: setting port for xprt %p to %u\n", xprt
, port
);
1025 sap
->sin_port
= htons(port
);
1028 static int xs_bindresvport(struct rpc_xprt
*xprt
, struct socket
*sock
)
1030 struct sockaddr_in myaddr
= {
1031 .sin_family
= AF_INET
,
1034 unsigned short port
= xprt
->port
;
1037 myaddr
.sin_port
= htons(port
);
1038 err
= kernel_bind(sock
, (struct sockaddr
*) &myaddr
,
1042 dprintk("RPC: xs_bindresvport bound to port %u\n",
1046 if (port
<= xprt_min_resvport
)
1047 port
= xprt_max_resvport
;
1050 } while (err
== -EADDRINUSE
&& port
!= xprt
->port
);
1052 dprintk("RPC: can't bind to reserved port (%d).\n", -err
);
1057 * xs_udp_connect_worker - set up a UDP socket
1058 * @args: RPC transport to connect
1060 * Invoked by a work queue tasklet.
1062 static void xs_udp_connect_worker(void *args
)
1064 struct rpc_xprt
*xprt
= (struct rpc_xprt
*) args
;
1065 struct socket
*sock
= xprt
->sock
;
1066 int err
, status
= -EIO
;
1068 if (xprt
->shutdown
|| !xprt_bound(xprt
))
1071 /* Start by resetting any existing state */
1074 if ((err
= sock_create_kern(PF_INET
, SOCK_DGRAM
, IPPROTO_UDP
, &sock
)) < 0) {
1075 dprintk("RPC: can't create UDP transport socket (%d).\n", -err
);
1079 if (xprt
->resvport
&& xs_bindresvport(xprt
, sock
) < 0) {
1084 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1085 xprt
, xs_print_peer_address(xprt
, RPC_DISPLAY_ALL
));
1088 struct sock
*sk
= sock
->sk
;
1090 write_lock_bh(&sk
->sk_callback_lock
);
1092 sk
->sk_user_data
= xprt
;
1093 xprt
->old_data_ready
= sk
->sk_data_ready
;
1094 xprt
->old_state_change
= sk
->sk_state_change
;
1095 xprt
->old_write_space
= sk
->sk_write_space
;
1096 sk
->sk_data_ready
= xs_udp_data_ready
;
1097 sk
->sk_write_space
= xs_udp_write_space
;
1098 sk
->sk_no_check
= UDP_CSUM_NORCV
;
1099 sk
->sk_allocation
= GFP_ATOMIC
;
1101 xprt_set_connected(xprt
);
1103 /* Reset to new socket */
1107 write_unlock_bh(&sk
->sk_callback_lock
);
1109 xs_udp_do_set_buffer_size(xprt
);
1112 xprt_wake_pending_tasks(xprt
, status
);
1113 xprt_clear_connecting(xprt
);
1117 * We need to preserve the port number so the reply cache on the server can
1118 * find our cached RPC replies when we get around to reconnecting.
1120 static void xs_tcp_reuse_connection(struct rpc_xprt
*xprt
)
1123 struct socket
*sock
= xprt
->sock
;
1124 struct sockaddr any
;
1126 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt
);
1129 * Disconnect the transport socket by doing a connect operation
1130 * with AF_UNSPEC. This should return immediately...
1132 memset(&any
, 0, sizeof(any
));
1133 any
.sa_family
= AF_UNSPEC
;
1134 result
= kernel_connect(sock
, &any
, sizeof(any
), 0);
1136 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1141 * xs_tcp_connect_worker - connect a TCP socket to a remote endpoint
1142 * @args: RPC transport to connect
1144 * Invoked by a work queue tasklet.
1146 static void xs_tcp_connect_worker(void *args
)
1148 struct rpc_xprt
*xprt
= (struct rpc_xprt
*)args
;
1149 struct socket
*sock
= xprt
->sock
;
1150 int err
, status
= -EIO
;
1152 if (xprt
->shutdown
|| !xprt_bound(xprt
))
1156 /* start from scratch */
1157 if ((err
= sock_create_kern(PF_INET
, SOCK_STREAM
, IPPROTO_TCP
, &sock
)) < 0) {
1158 dprintk("RPC: can't create TCP transport socket (%d).\n", -err
);
1162 if (xprt
->resvport
&& xs_bindresvport(xprt
, sock
) < 0) {
1167 /* "close" the socket, preserving the local port */
1168 xs_tcp_reuse_connection(xprt
);
1170 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1171 xprt
, xs_print_peer_address(xprt
, RPC_DISPLAY_ALL
));
1174 struct sock
*sk
= sock
->sk
;
1176 write_lock_bh(&sk
->sk_callback_lock
);
1178 sk
->sk_user_data
= xprt
;
1179 xprt
->old_data_ready
= sk
->sk_data_ready
;
1180 xprt
->old_state_change
= sk
->sk_state_change
;
1181 xprt
->old_write_space
= sk
->sk_write_space
;
1182 sk
->sk_data_ready
= xs_tcp_data_ready
;
1183 sk
->sk_state_change
= xs_tcp_state_change
;
1184 sk
->sk_write_space
= xs_tcp_write_space
;
1185 sk
->sk_allocation
= GFP_ATOMIC
;
1187 /* socket options */
1188 sk
->sk_userlocks
|= SOCK_BINDPORT_LOCK
;
1189 sock_reset_flag(sk
, SOCK_LINGER
);
1190 tcp_sk(sk
)->linger2
= 0;
1191 tcp_sk(sk
)->nonagle
|= TCP_NAGLE_OFF
;
1193 xprt_clear_connected(xprt
);
1195 /* Reset to new socket */
1199 write_unlock_bh(&sk
->sk_callback_lock
);
1202 /* Tell the socket layer to start connecting... */
1203 xprt
->stat
.connect_count
++;
1204 xprt
->stat
.connect_start
= jiffies
;
1205 status
= kernel_connect(sock
, (struct sockaddr
*) &xprt
->addr
,
1206 xprt
->addrlen
, O_NONBLOCK
);
1207 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1208 xprt
, -status
, xprt_connected(xprt
), sock
->sk
->sk_state
);
1216 /* retry with existing socket, after a delay */
1219 /* get rid of existing socket, and retry */
1225 xprt_wake_pending_tasks(xprt
, status
);
1227 xprt_clear_connecting(xprt
);
1231 * xs_connect - connect a socket to a remote endpoint
1232 * @task: address of RPC task that manages state of connect request
1234 * TCP: If the remote end dropped the connection, delay reconnecting.
1236 * UDP socket connects are synchronous, but we use a work queue anyway
1237 * to guarantee that even unprivileged user processes can set up a
1238 * socket on a privileged port.
1240 * If a UDP socket connect fails, the delay behavior here prevents
1241 * retry floods (hard mounts).
1243 static void xs_connect(struct rpc_task
*task
)
1245 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1247 if (xprt_test_and_set_connecting(xprt
))
1250 if (xprt
->sock
!= NULL
) {
1251 dprintk("RPC: xs_connect delayed xprt %p for %lu seconds\n",
1252 xprt
, xprt
->reestablish_timeout
/ HZ
);
1253 schedule_delayed_work(&xprt
->connect_worker
,
1254 xprt
->reestablish_timeout
);
1255 xprt
->reestablish_timeout
<<= 1;
1256 if (xprt
->reestablish_timeout
> XS_TCP_MAX_REEST_TO
)
1257 xprt
->reestablish_timeout
= XS_TCP_MAX_REEST_TO
;
1259 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt
);
1260 schedule_work(&xprt
->connect_worker
);
1262 /* flush_scheduled_work can sleep... */
1263 if (!RPC_IS_ASYNC(task
))
1264 flush_scheduled_work();
1269 * xs_udp_print_stats - display UDP socket-specifc stats
1270 * @xprt: rpc_xprt struct containing statistics
1274 static void xs_udp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
1276 seq_printf(seq
, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
1278 xprt
->stat
.bind_count
,
1281 xprt
->stat
.bad_xids
,
1283 xprt
->stat
.bklog_u
);
1287 * xs_tcp_print_stats - display TCP socket-specifc stats
1288 * @xprt: rpc_xprt struct containing statistics
1292 static void xs_tcp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
1296 if (xprt_connected(xprt
))
1297 idle_time
= (long)(jiffies
- xprt
->last_used
) / HZ
;
1299 seq_printf(seq
, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
1301 xprt
->stat
.bind_count
,
1302 xprt
->stat
.connect_count
,
1303 xprt
->stat
.connect_time
,
1307 xprt
->stat
.bad_xids
,
1309 xprt
->stat
.bklog_u
);
1312 static struct rpc_xprt_ops xs_udp_ops
= {
1313 .set_buffer_size
= xs_udp_set_buffer_size
,
1314 .print_addr
= xs_print_peer_address
,
1315 .reserve_xprt
= xprt_reserve_xprt_cong
,
1316 .release_xprt
= xprt_release_xprt_cong
,
1317 .rpcbind
= rpc_getport
,
1318 .set_port
= xs_set_port
,
1319 .connect
= xs_connect
,
1320 .buf_alloc
= rpc_malloc
,
1321 .buf_free
= rpc_free
,
1322 .send_request
= xs_udp_send_request
,
1323 .set_retrans_timeout
= xprt_set_retrans_timeout_rtt
,
1324 .timer
= xs_udp_timer
,
1325 .release_request
= xprt_release_rqst_cong
,
1327 .destroy
= xs_destroy
,
1328 .print_stats
= xs_udp_print_stats
,
1331 static struct rpc_xprt_ops xs_tcp_ops
= {
1332 .print_addr
= xs_print_peer_address
,
1333 .reserve_xprt
= xprt_reserve_xprt
,
1334 .release_xprt
= xs_tcp_release_xprt
,
1335 .rpcbind
= rpc_getport
,
1336 .set_port
= xs_set_port
,
1337 .connect
= xs_connect
,
1338 .buf_alloc
= rpc_malloc
,
1339 .buf_free
= rpc_free
,
1340 .send_request
= xs_tcp_send_request
,
1341 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
1343 .destroy
= xs_destroy
,
1344 .print_stats
= xs_tcp_print_stats
,
1347 static struct rpc_xprt
*xs_setup_xprt(struct sockaddr
*addr
, size_t addrlen
, unsigned int slot_table_size
)
1349 struct rpc_xprt
*xprt
;
1350 struct sock_xprt
*new;
1352 if (addrlen
> sizeof(xprt
->addr
)) {
1353 dprintk("RPC: xs_setup_xprt: address too large\n");
1354 return ERR_PTR(-EBADF
);
1357 new = kzalloc(sizeof(*new), GFP_KERNEL
);
1359 dprintk("RPC: xs_setup_xprt: couldn't allocate rpc_xprt\n");
1360 return ERR_PTR(-ENOMEM
);
1364 xprt
->max_reqs
= slot_table_size
;
1365 xprt
->slot
= kcalloc(xprt
->max_reqs
, sizeof(struct rpc_rqst
), GFP_KERNEL
);
1366 if (xprt
->slot
== NULL
) {
1368 dprintk("RPC: xs_setup_xprt: couldn't allocate slot table\n");
1369 return ERR_PTR(-ENOMEM
);
1372 memcpy(&xprt
->addr
, addr
, addrlen
);
1373 xprt
->addrlen
= addrlen
;
1374 xprt
->port
= xs_get_random_port();
1380 * xs_setup_udp - Set up transport to use a UDP socket
1381 * @addr: address of remote server
1382 * @addrlen: length of address in bytes
1383 * @to: timeout parameters
1386 struct rpc_xprt
*xs_setup_udp(struct sockaddr
*addr
, size_t addrlen
, struct rpc_timeout
*to
)
1388 struct rpc_xprt
*xprt
;
1390 xprt
= xs_setup_xprt(addr
, addrlen
, xprt_udp_slot_table_entries
);
1394 if (ntohs(((struct sockaddr_in
*)addr
)->sin_port
) != 0)
1395 xprt_set_bound(xprt
);
1397 xprt
->prot
= IPPROTO_UDP
;
1399 /* XXX: header size can vary due to auth type, IPv6, etc. */
1400 xprt
->max_payload
= (1U << 16) - (MAX_HEADER
<< 3);
1402 INIT_WORK(&xprt
->connect_worker
, xs_udp_connect_worker
, xprt
);
1403 xprt
->bind_timeout
= XS_BIND_TO
;
1404 xprt
->connect_timeout
= XS_UDP_CONN_TO
;
1405 xprt
->reestablish_timeout
= XS_UDP_REEST_TO
;
1406 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
1408 xprt
->ops
= &xs_udp_ops
;
1411 xprt
->timeout
= *to
;
1413 xprt_set_timeout(&xprt
->timeout
, 5, 5 * HZ
);
1415 xs_format_peer_addresses(xprt
);
1416 dprintk("RPC: set up transport to address %s\n",
1417 xs_print_peer_address(xprt
, RPC_DISPLAY_ALL
));
1423 * xs_setup_tcp - Set up transport to use a TCP socket
1424 * @addr: address of remote server
1425 * @addrlen: length of address in bytes
1426 * @to: timeout parameters
1429 struct rpc_xprt
*xs_setup_tcp(struct sockaddr
*addr
, size_t addrlen
, struct rpc_timeout
*to
)
1431 struct rpc_xprt
*xprt
;
1433 xprt
= xs_setup_xprt(addr
, addrlen
, xprt_tcp_slot_table_entries
);
1437 if (ntohs(((struct sockaddr_in
*)addr
)->sin_port
) != 0)
1438 xprt_set_bound(xprt
);
1440 xprt
->prot
= IPPROTO_TCP
;
1441 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
1442 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
1444 INIT_WORK(&xprt
->connect_worker
, xs_tcp_connect_worker
, xprt
);
1445 xprt
->bind_timeout
= XS_BIND_TO
;
1446 xprt
->connect_timeout
= XS_TCP_CONN_TO
;
1447 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
1448 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
1450 xprt
->ops
= &xs_tcp_ops
;
1453 xprt
->timeout
= *to
;
1455 xprt_set_timeout(&xprt
->timeout
, 2, 60 * HZ
);
1457 xs_format_peer_addresses(xprt
);
1458 dprintk("RPC: set up transport to address %s\n",
1459 xs_print_peer_address(xprt
, RPC_DISPLAY_ALL
));