2 * linux/net/sunrpc/xprtsock.c
4 * Client-side transport implementation for sockets.
6 * TCP callback races fixes (C) 1998 Red Hat
7 * TCP send fixes (C) 1998 Red Hat
8 * TCP NFS related read + write fixes
9 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
11 * Rewrite of larges part of the code in order to stabilize TCP stuff.
12 * Fix behaviour when socket buffer is full.
13 * (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no>
15 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
17 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
18 * <gilles.quillard@bull.net>
21 #include <linux/types.h>
22 #include <linux/slab.h>
23 #include <linux/module.h>
24 #include <linux/capability.h>
25 #include <linux/pagemap.h>
26 #include <linux/errno.h>
27 #include <linux/socket.h>
29 #include <linux/net.h>
31 #include <linux/udp.h>
32 #include <linux/tcp.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/sched.h>
35 #include <linux/sunrpc/xprtsock.h>
36 #include <linux/file.h>
39 #include <net/checksum.h>
46 unsigned int xprt_udp_slot_table_entries
= RPC_DEF_SLOT_TABLE
;
47 unsigned int xprt_tcp_slot_table_entries
= RPC_DEF_SLOT_TABLE
;
49 unsigned int xprt_min_resvport
= RPC_DEF_MIN_RESVPORT
;
50 unsigned int xprt_max_resvport
= RPC_DEF_MAX_RESVPORT
;
53 * We can register our own files under /proc/sys/sunrpc by
54 * calling register_sysctl_table() again. The files in that
55 * directory become the union of all files registered there.
57 * We simply need to make sure that we don't collide with
58 * someone else's file names!
63 static unsigned int min_slot_table_size
= RPC_MIN_SLOT_TABLE
;
64 static unsigned int max_slot_table_size
= RPC_MAX_SLOT_TABLE
;
65 static unsigned int xprt_min_resvport_limit
= RPC_MIN_RESVPORT
;
66 static unsigned int xprt_max_resvport_limit
= RPC_MAX_RESVPORT
;
68 static struct ctl_table_header
*sunrpc_table_header
;
71 * FIXME: changing the UDP slot table size should also resize the UDP
72 * socket buffers for existing UDP transports
74 static ctl_table xs_tunables_table
[] = {
76 .ctl_name
= CTL_SLOTTABLE_UDP
,
77 .procname
= "udp_slot_table_entries",
78 .data
= &xprt_udp_slot_table_entries
,
79 .maxlen
= sizeof(unsigned int),
81 .proc_handler
= &proc_dointvec_minmax
,
82 .strategy
= &sysctl_intvec
,
83 .extra1
= &min_slot_table_size
,
84 .extra2
= &max_slot_table_size
87 .ctl_name
= CTL_SLOTTABLE_TCP
,
88 .procname
= "tcp_slot_table_entries",
89 .data
= &xprt_tcp_slot_table_entries
,
90 .maxlen
= sizeof(unsigned int),
92 .proc_handler
= &proc_dointvec_minmax
,
93 .strategy
= &sysctl_intvec
,
94 .extra1
= &min_slot_table_size
,
95 .extra2
= &max_slot_table_size
98 .ctl_name
= CTL_MIN_RESVPORT
,
99 .procname
= "min_resvport",
100 .data
= &xprt_min_resvport
,
101 .maxlen
= sizeof(unsigned int),
103 .proc_handler
= &proc_dointvec_minmax
,
104 .strategy
= &sysctl_intvec
,
105 .extra1
= &xprt_min_resvport_limit
,
106 .extra2
= &xprt_max_resvport_limit
109 .ctl_name
= CTL_MAX_RESVPORT
,
110 .procname
= "max_resvport",
111 .data
= &xprt_max_resvport
,
112 .maxlen
= sizeof(unsigned int),
114 .proc_handler
= &proc_dointvec_minmax
,
115 .strategy
= &sysctl_intvec
,
116 .extra1
= &xprt_min_resvport_limit
,
117 .extra2
= &xprt_max_resvport_limit
124 static ctl_table sunrpc_table
[] = {
126 .ctl_name
= CTL_SUNRPC
,
127 .procname
= "sunrpc",
129 .child
= xs_tunables_table
139 * Time out for an RPC UDP socket connect. UDP socket connects are
140 * synchronous, but we set a timeout anyway in case of resource
141 * exhaustion on the local host.
143 #define XS_UDP_CONN_TO (5U * HZ)
146 * Wait duration for an RPC TCP connection to be established. Solaris
147 * NFS over TCP uses 60 seconds, for example, which is in line with how
148 * long a server takes to reboot.
150 #define XS_TCP_CONN_TO (60U * HZ)
153 * Wait duration for a reply from the RPC portmapper.
155 #define XS_BIND_TO (60U * HZ)
158 * Delay if a UDP socket connect error occurs. This is most likely some
159 * kind of resource problem on the local host.
161 #define XS_UDP_REEST_TO (2U * HZ)
164 * The reestablish timeout allows clients to delay for a bit before attempting
165 * to reconnect to a server that just dropped our connection.
167 * We implement an exponential backoff when trying to reestablish a TCP
168 * transport connection with the server. Some servers like to drop a TCP
169 * connection when they are overworked, so we start with a short timeout and
170 * increase over time if the server is down or not responding.
172 #define XS_TCP_INIT_REEST_TO (3U * HZ)
173 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
176 * TCP idle timeout; client drops the transport socket if it is idle
177 * for this long. Note that we also timeout UDP sockets to prevent
178 * holding port numbers when there is no RPC traffic.
180 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
183 # undef RPC_DEBUG_DATA
184 # define RPCDBG_FACILITY RPCDBG_TRANS
187 #ifdef RPC_DEBUG_DATA
188 static void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
190 u8
*buf
= (u8
*) packet
;
193 dprintk("RPC: %s\n", msg
);
194 for (j
= 0; j
< count
&& j
< 128; j
+= 4) {
198 dprintk("0x%04x ", j
);
200 dprintk("%02x%02x%02x%02x ",
201 buf
[j
], buf
[j
+1], buf
[j
+2], buf
[j
+3]);
206 static inline void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
213 struct rpc_xprt xprt
;
218 struct socket
* sock
;
222 * State of TCP reply receive
230 unsigned long tcp_copied
,
234 * Connection of transports
236 struct delayed_work connect_worker
;
237 struct sockaddr_storage addr
;
241 * UDP socket buffer size parameters
247 * Saved socket callback addresses
249 void (*old_data_ready
)(struct sock
*, int);
250 void (*old_state_change
)(struct sock
*);
251 void (*old_write_space
)(struct sock
*);
255 * TCP receive state flags
257 #define TCP_RCV_LAST_FRAG (1UL << 0)
258 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
259 #define TCP_RCV_COPY_XID (1UL << 2)
260 #define TCP_RCV_COPY_DATA (1UL << 3)
262 static inline struct sockaddr
*xs_addr(struct rpc_xprt
*xprt
)
264 return (struct sockaddr
*) &xprt
->addr
;
267 static inline struct sockaddr_in
*xs_addr_in(struct rpc_xprt
*xprt
)
269 return (struct sockaddr_in
*) &xprt
->addr
;
272 static inline struct sockaddr_in6
*xs_addr_in6(struct rpc_xprt
*xprt
)
274 return (struct sockaddr_in6
*) &xprt
->addr
;
277 static void xs_format_ipv4_peer_addresses(struct rpc_xprt
*xprt
,
278 const char *protocol
,
281 struct sockaddr_in
*addr
= xs_addr_in(xprt
);
284 buf
= kzalloc(20, GFP_KERNEL
);
286 snprintf(buf
, 20, NIPQUAD_FMT
,
287 NIPQUAD(addr
->sin_addr
.s_addr
));
289 xprt
->address_strings
[RPC_DISPLAY_ADDR
] = buf
;
291 buf
= kzalloc(8, GFP_KERNEL
);
293 snprintf(buf
, 8, "%u",
294 ntohs(addr
->sin_port
));
296 xprt
->address_strings
[RPC_DISPLAY_PORT
] = buf
;
298 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = protocol
;
300 buf
= kzalloc(48, GFP_KERNEL
);
302 snprintf(buf
, 48, "addr="NIPQUAD_FMT
" port=%u proto=%s",
303 NIPQUAD(addr
->sin_addr
.s_addr
),
304 ntohs(addr
->sin_port
),
307 xprt
->address_strings
[RPC_DISPLAY_ALL
] = buf
;
309 buf
= kzalloc(10, GFP_KERNEL
);
311 snprintf(buf
, 10, "%02x%02x%02x%02x",
312 NIPQUAD(addr
->sin_addr
.s_addr
));
314 xprt
->address_strings
[RPC_DISPLAY_HEX_ADDR
] = buf
;
316 buf
= kzalloc(8, GFP_KERNEL
);
318 snprintf(buf
, 8, "%4hx",
319 ntohs(addr
->sin_port
));
321 xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
] = buf
;
323 buf
= kzalloc(30, GFP_KERNEL
);
325 snprintf(buf
, 30, NIPQUAD_FMT
".%u.%u",
326 NIPQUAD(addr
->sin_addr
.s_addr
),
327 ntohs(addr
->sin_port
) >> 8,
328 ntohs(addr
->sin_port
) & 0xff);
330 xprt
->address_strings
[RPC_DISPLAY_UNIVERSAL_ADDR
] = buf
;
332 xprt
->address_strings
[RPC_DISPLAY_NETID
] = netid
;
335 static void xs_format_ipv6_peer_addresses(struct rpc_xprt
*xprt
,
336 const char *protocol
,
339 struct sockaddr_in6
*addr
= xs_addr_in6(xprt
);
342 buf
= kzalloc(40, GFP_KERNEL
);
344 snprintf(buf
, 40, "%pI6",&addr
->sin6_addr
);
346 xprt
->address_strings
[RPC_DISPLAY_ADDR
] = buf
;
348 buf
= kzalloc(8, GFP_KERNEL
);
350 snprintf(buf
, 8, "%u",
351 ntohs(addr
->sin6_port
));
353 xprt
->address_strings
[RPC_DISPLAY_PORT
] = buf
;
355 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = protocol
;
357 buf
= kzalloc(64, GFP_KERNEL
);
359 snprintf(buf
, 64, "addr=%pI6 port=%u proto=%s",
361 ntohs(addr
->sin6_port
),
364 xprt
->address_strings
[RPC_DISPLAY_ALL
] = buf
;
366 buf
= kzalloc(36, GFP_KERNEL
);
368 snprintf(buf
, 36, "%pi6", &addr
->sin6_addr
);
370 xprt
->address_strings
[RPC_DISPLAY_HEX_ADDR
] = buf
;
372 buf
= kzalloc(8, GFP_KERNEL
);
374 snprintf(buf
, 8, "%4hx",
375 ntohs(addr
->sin6_port
));
377 xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
] = buf
;
379 buf
= kzalloc(50, GFP_KERNEL
);
381 snprintf(buf
, 50, "%pI6.%u.%u",
383 ntohs(addr
->sin6_port
) >> 8,
384 ntohs(addr
->sin6_port
) & 0xff);
386 xprt
->address_strings
[RPC_DISPLAY_UNIVERSAL_ADDR
] = buf
;
388 xprt
->address_strings
[RPC_DISPLAY_NETID
] = netid
;
391 static void xs_free_peer_addresses(struct rpc_xprt
*xprt
)
395 for (i
= 0; i
< RPC_DISPLAY_MAX
; i
++)
397 case RPC_DISPLAY_PROTO
:
398 case RPC_DISPLAY_NETID
:
401 kfree(xprt
->address_strings
[i
]);
405 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
407 static int xs_send_kvec(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct kvec
*vec
, unsigned int base
, int more
)
409 struct msghdr msg
= {
411 .msg_namelen
= addrlen
,
412 .msg_flags
= XS_SENDMSG_FLAGS
| (more
? MSG_MORE
: 0),
415 .iov_base
= vec
->iov_base
+ base
,
416 .iov_len
= vec
->iov_len
- base
,
419 if (iov
.iov_len
!= 0)
420 return kernel_sendmsg(sock
, &msg
, &iov
, 1, iov
.iov_len
);
421 return kernel_sendmsg(sock
, &msg
, NULL
, 0, 0);
424 static int xs_send_pagedata(struct socket
*sock
, struct xdr_buf
*xdr
, unsigned int base
, int more
)
427 unsigned int remainder
;
430 remainder
= xdr
->page_len
- base
;
431 base
+= xdr
->page_base
;
432 ppage
= xdr
->pages
+ (base
>> PAGE_SHIFT
);
435 unsigned int len
= min_t(unsigned int, PAGE_SIZE
- base
, remainder
);
436 int flags
= XS_SENDMSG_FLAGS
;
439 if (remainder
!= 0 || more
)
441 err
= sock
->ops
->sendpage(sock
, *ppage
, base
, len
, flags
);
442 if (remainder
== 0 || err
!= len
)
456 * xs_sendpages - write pages directly to a socket
457 * @sock: socket to send on
458 * @addr: UDP only -- address of destination
459 * @addrlen: UDP only -- length of destination address
460 * @xdr: buffer containing this request
461 * @base: starting position in the buffer
464 static int xs_sendpages(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct xdr_buf
*xdr
, unsigned int base
)
466 unsigned int remainder
= xdr
->len
- base
;
472 clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
);
478 if (base
< xdr
->head
[0].iov_len
|| addr
!= NULL
) {
479 unsigned int len
= xdr
->head
[0].iov_len
- base
;
481 err
= xs_send_kvec(sock
, addr
, addrlen
, &xdr
->head
[0], base
, remainder
!= 0);
482 if (remainder
== 0 || err
!= len
)
487 base
-= xdr
->head
[0].iov_len
;
489 if (base
< xdr
->page_len
) {
490 unsigned int len
= xdr
->page_len
- base
;
492 err
= xs_send_pagedata(sock
, xdr
, base
, remainder
!= 0);
493 if (remainder
== 0 || err
!= len
)
498 base
-= xdr
->page_len
;
500 if (base
>= xdr
->tail
[0].iov_len
)
502 err
= xs_send_kvec(sock
, NULL
, 0, &xdr
->tail
[0], base
, 0);
511 static void xs_nospace_callback(struct rpc_task
*task
)
513 struct sock_xprt
*transport
= container_of(task
->tk_rqstp
->rq_xprt
, struct sock_xprt
, xprt
);
515 transport
->inet
->sk_write_pending
--;
516 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
520 * xs_nospace - place task on wait queue if transmit was incomplete
521 * @task: task to put to sleep
524 static void xs_nospace(struct rpc_task
*task
)
526 struct rpc_rqst
*req
= task
->tk_rqstp
;
527 struct rpc_xprt
*xprt
= req
->rq_xprt
;
528 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
530 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
531 task
->tk_pid
, req
->rq_slen
- req
->rq_bytes_sent
,
534 /* Protect against races with write_space */
535 spin_lock_bh(&xprt
->transport_lock
);
537 /* Don't race with disconnect */
538 if (xprt_connected(xprt
)) {
539 if (test_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
)) {
541 * Notify TCP that we're limited by the application
544 set_bit(SOCK_NOSPACE
, &transport
->sock
->flags
);
545 transport
->inet
->sk_write_pending
++;
546 /* ...and wait for more buffer space */
547 xprt_wait_for_buffer_space(task
, xs_nospace_callback
);
550 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
551 task
->tk_status
= -ENOTCONN
;
554 spin_unlock_bh(&xprt
->transport_lock
);
558 * xs_udp_send_request - write an RPC request to a UDP socket
559 * @task: address of RPC task that manages the state of an RPC request
562 * 0: The request has been sent
563 * EAGAIN: The socket was blocked, please call again later to
564 * complete the request
565 * ENOTCONN: Caller needs to invoke connect logic then call again
566 * other: Some other error occured, the request was not sent
568 static int xs_udp_send_request(struct rpc_task
*task
)
570 struct rpc_rqst
*req
= task
->tk_rqstp
;
571 struct rpc_xprt
*xprt
= req
->rq_xprt
;
572 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
573 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
576 xs_pktdump("packet data:",
577 req
->rq_svec
->iov_base
,
578 req
->rq_svec
->iov_len
);
580 status
= xs_sendpages(transport
->sock
,
585 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
586 xdr
->len
- req
->rq_bytes_sent
, status
);
589 task
->tk_bytes_sent
+= status
;
590 if (status
>= req
->rq_slen
)
592 /* Still some bytes left; set up for a retry later. */
603 /* When the server has died, an ICMP port unreachable message
604 * prompts ECONNREFUSED. */
605 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
608 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
609 dprintk("RPC: sendmsg returned unrecognized error %d\n",
617 * xs_tcp_shutdown - gracefully shut down a TCP socket
620 * Initiates a graceful shutdown of the TCP socket by calling the
621 * equivalent of shutdown(SHUT_WR);
623 static void xs_tcp_shutdown(struct rpc_xprt
*xprt
)
625 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
626 struct socket
*sock
= transport
->sock
;
629 kernel_sock_shutdown(sock
, SHUT_WR
);
632 static inline void xs_encode_tcp_record_marker(struct xdr_buf
*buf
)
634 u32 reclen
= buf
->len
- sizeof(rpc_fraghdr
);
635 rpc_fraghdr
*base
= buf
->head
[0].iov_base
;
636 *base
= htonl(RPC_LAST_STREAM_FRAGMENT
| reclen
);
640 * xs_tcp_send_request - write an RPC request to a TCP socket
641 * @task: address of RPC task that manages the state of an RPC request
644 * 0: The request has been sent
645 * EAGAIN: The socket was blocked, please call again later to
646 * complete the request
647 * ENOTCONN: Caller needs to invoke connect logic then call again
648 * other: Some other error occured, the request was not sent
650 * XXX: In the case of soft timeouts, should we eventually give up
651 * if sendmsg is not able to make progress?
653 static int xs_tcp_send_request(struct rpc_task
*task
)
655 struct rpc_rqst
*req
= task
->tk_rqstp
;
656 struct rpc_xprt
*xprt
= req
->rq_xprt
;
657 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
658 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
661 xs_encode_tcp_record_marker(&req
->rq_snd_buf
);
663 xs_pktdump("packet data:",
664 req
->rq_svec
->iov_base
,
665 req
->rq_svec
->iov_len
);
667 /* Continue transmitting the packet/record. We must be careful
668 * to cope with writespace callbacks arriving _after_ we have
669 * called sendmsg(). */
671 status
= xs_sendpages(transport
->sock
,
672 NULL
, 0, xdr
, req
->rq_bytes_sent
);
674 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
675 xdr
->len
- req
->rq_bytes_sent
, status
);
677 if (unlikely(status
< 0))
680 /* If we've sent the entire packet, immediately
681 * reset the count of bytes sent. */
682 req
->rq_bytes_sent
+= status
;
683 task
->tk_bytes_sent
+= status
;
684 if (likely(req
->rq_bytes_sent
>= req
->rq_slen
)) {
685 req
->rq_bytes_sent
= 0;
704 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
707 dprintk("RPC: sendmsg returned unrecognized error %d\n",
709 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
710 xs_tcp_shutdown(xprt
);
717 * xs_tcp_release_xprt - clean up after a tcp transmission
721 * This cleans up if an error causes us to abort the transmission of a request.
722 * In this case, the socket may need to be reset in order to avoid confusing
725 static void xs_tcp_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
727 struct rpc_rqst
*req
;
729 if (task
!= xprt
->snd_task
)
733 req
= task
->tk_rqstp
;
734 if (req
->rq_bytes_sent
== 0)
736 if (req
->rq_bytes_sent
== req
->rq_snd_buf
.len
)
738 set_bit(XPRT_CLOSE_WAIT
, &task
->tk_xprt
->state
);
740 xprt_release_xprt(xprt
, task
);
744 * xs_close - close a socket
747 * This is used when all requests are complete; ie, no DRC state remains
748 * on the server we want to save.
750 static void xs_close(struct rpc_xprt
*xprt
)
752 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
753 struct socket
*sock
= transport
->sock
;
754 struct sock
*sk
= transport
->inet
;
757 goto clear_close_wait
;
759 dprintk("RPC: xs_close xprt %p\n", xprt
);
761 write_lock_bh(&sk
->sk_callback_lock
);
762 transport
->inet
= NULL
;
763 transport
->sock
= NULL
;
765 sk
->sk_user_data
= NULL
;
766 sk
->sk_data_ready
= transport
->old_data_ready
;
767 sk
->sk_state_change
= transport
->old_state_change
;
768 sk
->sk_write_space
= transport
->old_write_space
;
769 write_unlock_bh(&sk
->sk_callback_lock
);
775 smp_mb__before_clear_bit();
776 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
777 clear_bit(XPRT_CLOSING
, &xprt
->state
);
778 smp_mb__after_clear_bit();
779 xprt_disconnect_done(xprt
);
783 * xs_destroy - prepare to shutdown a transport
784 * @xprt: doomed transport
787 static void xs_destroy(struct rpc_xprt
*xprt
)
789 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
791 dprintk("RPC: xs_destroy xprt %p\n", xprt
);
793 cancel_rearming_delayed_work(&transport
->connect_worker
);
796 xs_free_peer_addresses(xprt
);
799 module_put(THIS_MODULE
);
802 static inline struct rpc_xprt
*xprt_from_sock(struct sock
*sk
)
804 return (struct rpc_xprt
*) sk
->sk_user_data
;
808 * xs_udp_data_ready - "data ready" callback for UDP sockets
809 * @sk: socket with data to read
810 * @len: how much data to read
813 static void xs_udp_data_ready(struct sock
*sk
, int len
)
815 struct rpc_task
*task
;
816 struct rpc_xprt
*xprt
;
817 struct rpc_rqst
*rovr
;
819 int err
, repsize
, copied
;
823 read_lock(&sk
->sk_callback_lock
);
824 dprintk("RPC: xs_udp_data_ready...\n");
825 if (!(xprt
= xprt_from_sock(sk
)))
828 if ((skb
= skb_recv_datagram(sk
, 0, 1, &err
)) == NULL
)
834 repsize
= skb
->len
- sizeof(struct udphdr
);
836 dprintk("RPC: impossible RPC reply size %d!\n", repsize
);
840 /* Copy the XID from the skb... */
841 xp
= skb_header_pointer(skb
, sizeof(struct udphdr
),
842 sizeof(_xid
), &_xid
);
846 /* Look up and lock the request corresponding to the given XID */
847 spin_lock(&xprt
->transport_lock
);
848 rovr
= xprt_lookup_rqst(xprt
, *xp
);
851 task
= rovr
->rq_task
;
853 if ((copied
= rovr
->rq_private_buf
.buflen
) > repsize
)
856 /* Suck it into the iovec, verify checksum if not done by hw. */
857 if (csum_partial_copy_to_xdr(&rovr
->rq_private_buf
, skb
)) {
858 UDPX_INC_STATS_BH(sk
, UDP_MIB_INERRORS
);
862 UDPX_INC_STATS_BH(sk
, UDP_MIB_INDATAGRAMS
);
864 /* Something worked... */
865 dst_confirm(skb
->dst
);
867 xprt_adjust_cwnd(task
, copied
);
868 xprt_update_rtt(task
);
869 xprt_complete_rqst(task
, copied
);
872 spin_unlock(&xprt
->transport_lock
);
874 skb_free_datagram(sk
, skb
);
876 read_unlock(&sk
->sk_callback_lock
);
879 static inline void xs_tcp_read_fraghdr(struct rpc_xprt
*xprt
, struct xdr_skb_reader
*desc
)
881 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
885 p
= ((char *) &transport
->tcp_fraghdr
) + transport
->tcp_offset
;
886 len
= sizeof(transport
->tcp_fraghdr
) - transport
->tcp_offset
;
887 used
= xdr_skb_read_bits(desc
, p
, len
);
888 transport
->tcp_offset
+= used
;
892 transport
->tcp_reclen
= ntohl(transport
->tcp_fraghdr
);
893 if (transport
->tcp_reclen
& RPC_LAST_STREAM_FRAGMENT
)
894 transport
->tcp_flags
|= TCP_RCV_LAST_FRAG
;
896 transport
->tcp_flags
&= ~TCP_RCV_LAST_FRAG
;
897 transport
->tcp_reclen
&= RPC_FRAGMENT_SIZE_MASK
;
899 transport
->tcp_flags
&= ~TCP_RCV_COPY_FRAGHDR
;
900 transport
->tcp_offset
= 0;
902 /* Sanity check of the record length */
903 if (unlikely(transport
->tcp_reclen
< 4)) {
904 dprintk("RPC: invalid TCP record fragment length\n");
905 xprt_force_disconnect(xprt
);
908 dprintk("RPC: reading TCP record fragment of length %d\n",
909 transport
->tcp_reclen
);
912 static void xs_tcp_check_fraghdr(struct sock_xprt
*transport
)
914 if (transport
->tcp_offset
== transport
->tcp_reclen
) {
915 transport
->tcp_flags
|= TCP_RCV_COPY_FRAGHDR
;
916 transport
->tcp_offset
= 0;
917 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
) {
918 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
919 transport
->tcp_flags
|= TCP_RCV_COPY_XID
;
920 transport
->tcp_copied
= 0;
925 static inline void xs_tcp_read_xid(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
930 len
= sizeof(transport
->tcp_xid
) - transport
->tcp_offset
;
931 dprintk("RPC: reading XID (%Zu bytes)\n", len
);
932 p
= ((char *) &transport
->tcp_xid
) + transport
->tcp_offset
;
933 used
= xdr_skb_read_bits(desc
, p
, len
);
934 transport
->tcp_offset
+= used
;
937 transport
->tcp_flags
&= ~TCP_RCV_COPY_XID
;
938 transport
->tcp_flags
|= TCP_RCV_COPY_DATA
;
939 transport
->tcp_copied
= 4;
940 dprintk("RPC: reading reply for XID %08x\n",
941 ntohl(transport
->tcp_xid
));
942 xs_tcp_check_fraghdr(transport
);
945 static inline void xs_tcp_read_request(struct rpc_xprt
*xprt
, struct xdr_skb_reader
*desc
)
947 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
948 struct rpc_rqst
*req
;
949 struct xdr_buf
*rcvbuf
;
953 /* Find and lock the request corresponding to this xid */
954 spin_lock(&xprt
->transport_lock
);
955 req
= xprt_lookup_rqst(xprt
, transport
->tcp_xid
);
957 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
958 dprintk("RPC: XID %08x request not found!\n",
959 ntohl(transport
->tcp_xid
));
960 spin_unlock(&xprt
->transport_lock
);
964 rcvbuf
= &req
->rq_private_buf
;
966 if (len
> transport
->tcp_reclen
- transport
->tcp_offset
) {
967 struct xdr_skb_reader my_desc
;
969 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
970 memcpy(&my_desc
, desc
, sizeof(my_desc
));
972 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
973 &my_desc
, xdr_skb_read_bits
);
977 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
978 desc
, xdr_skb_read_bits
);
981 transport
->tcp_copied
+= r
;
982 transport
->tcp_offset
+= r
;
985 /* Error when copying to the receive buffer,
986 * usually because we weren't able to allocate
987 * additional buffer pages. All we can do now
988 * is turn off TCP_RCV_COPY_DATA, so the request
989 * will not receive any additional updates,
991 * Any remaining data from this record will
994 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
995 dprintk("RPC: XID %08x truncated request\n",
996 ntohl(transport
->tcp_xid
));
997 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
998 "tcp_offset = %u, tcp_reclen = %u\n",
999 xprt
, transport
->tcp_copied
,
1000 transport
->tcp_offset
, transport
->tcp_reclen
);
1004 dprintk("RPC: XID %08x read %Zd bytes\n",
1005 ntohl(transport
->tcp_xid
), r
);
1006 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1007 "tcp_reclen = %u\n", xprt
, transport
->tcp_copied
,
1008 transport
->tcp_offset
, transport
->tcp_reclen
);
1010 if (transport
->tcp_copied
== req
->rq_private_buf
.buflen
)
1011 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1012 else if (transport
->tcp_offset
== transport
->tcp_reclen
) {
1013 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
)
1014 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1018 if (!(transport
->tcp_flags
& TCP_RCV_COPY_DATA
))
1019 xprt_complete_rqst(req
->rq_task
, transport
->tcp_copied
);
1020 spin_unlock(&xprt
->transport_lock
);
1021 xs_tcp_check_fraghdr(transport
);
1024 static inline void xs_tcp_read_discard(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
1028 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
1029 if (len
> desc
->count
)
1032 desc
->offset
+= len
;
1033 transport
->tcp_offset
+= len
;
1034 dprintk("RPC: discarded %Zu bytes\n", len
);
1035 xs_tcp_check_fraghdr(transport
);
1038 static int xs_tcp_data_recv(read_descriptor_t
*rd_desc
, struct sk_buff
*skb
, unsigned int offset
, size_t len
)
1040 struct rpc_xprt
*xprt
= rd_desc
->arg
.data
;
1041 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1042 struct xdr_skb_reader desc
= {
1048 dprintk("RPC: xs_tcp_data_recv started\n");
1050 /* Read in a new fragment marker if necessary */
1051 /* Can we ever really expect to get completely empty fragments? */
1052 if (transport
->tcp_flags
& TCP_RCV_COPY_FRAGHDR
) {
1053 xs_tcp_read_fraghdr(xprt
, &desc
);
1056 /* Read in the xid if necessary */
1057 if (transport
->tcp_flags
& TCP_RCV_COPY_XID
) {
1058 xs_tcp_read_xid(transport
, &desc
);
1061 /* Read in the request data */
1062 if (transport
->tcp_flags
& TCP_RCV_COPY_DATA
) {
1063 xs_tcp_read_request(xprt
, &desc
);
1066 /* Skip over any trailing bytes on short reads */
1067 xs_tcp_read_discard(transport
, &desc
);
1068 } while (desc
.count
);
1069 dprintk("RPC: xs_tcp_data_recv done\n");
1070 return len
- desc
.count
;
1074 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1075 * @sk: socket with data to read
1076 * @bytes: how much data to read
1079 static void xs_tcp_data_ready(struct sock
*sk
, int bytes
)
1081 struct rpc_xprt
*xprt
;
1082 read_descriptor_t rd_desc
;
1085 dprintk("RPC: xs_tcp_data_ready...\n");
1087 read_lock(&sk
->sk_callback_lock
);
1088 if (!(xprt
= xprt_from_sock(sk
)))
1093 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1094 rd_desc
.arg
.data
= xprt
;
1096 rd_desc
.count
= 65536;
1097 read
= tcp_read_sock(sk
, &rd_desc
, xs_tcp_data_recv
);
1100 read_unlock(&sk
->sk_callback_lock
);
1104 * xs_tcp_state_change - callback to handle TCP socket state changes
1105 * @sk: socket whose state has changed
1108 static void xs_tcp_state_change(struct sock
*sk
)
1110 struct rpc_xprt
*xprt
;
1112 read_lock(&sk
->sk_callback_lock
);
1113 if (!(xprt
= xprt_from_sock(sk
)))
1115 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt
);
1116 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
1117 sk
->sk_state
, xprt_connected(xprt
),
1118 sock_flag(sk
, SOCK_DEAD
),
1119 sock_flag(sk
, SOCK_ZAPPED
));
1121 switch (sk
->sk_state
) {
1122 case TCP_ESTABLISHED
:
1123 spin_lock_bh(&xprt
->transport_lock
);
1124 if (!xprt_test_and_set_connected(xprt
)) {
1125 struct sock_xprt
*transport
= container_of(xprt
,
1126 struct sock_xprt
, xprt
);
1128 /* Reset TCP record info */
1129 transport
->tcp_offset
= 0;
1130 transport
->tcp_reclen
= 0;
1131 transport
->tcp_copied
= 0;
1132 transport
->tcp_flags
=
1133 TCP_RCV_COPY_FRAGHDR
| TCP_RCV_COPY_XID
;
1135 xprt_wake_pending_tasks(xprt
, 0);
1137 spin_unlock_bh(&xprt
->transport_lock
);
1140 /* The client initiated a shutdown of the socket */
1141 xprt
->connect_cookie
++;
1142 xprt
->reestablish_timeout
= 0;
1143 set_bit(XPRT_CLOSING
, &xprt
->state
);
1144 smp_mb__before_clear_bit();
1145 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1146 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
1147 smp_mb__after_clear_bit();
1149 case TCP_CLOSE_WAIT
:
1150 /* The server initiated a shutdown of the socket */
1151 set_bit(XPRT_CLOSING
, &xprt
->state
);
1152 xprt_force_disconnect(xprt
);
1154 xprt
->connect_cookie
++;
1157 * If the server closed down the connection, make sure that
1158 * we back off before reconnecting
1160 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
1161 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
1164 smp_mb__before_clear_bit();
1165 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1166 smp_mb__after_clear_bit();
1169 smp_mb__before_clear_bit();
1170 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
1171 clear_bit(XPRT_CLOSING
, &xprt
->state
);
1172 smp_mb__after_clear_bit();
1173 /* Mark transport as closed and wake up all pending tasks */
1174 xprt_disconnect_done(xprt
);
1177 read_unlock(&sk
->sk_callback_lock
);
1181 * xs_udp_write_space - callback invoked when socket buffer space
1183 * @sk: socket whose state has changed
1185 * Called when more output buffer space is available for this socket.
1186 * We try not to wake our writers until they can make "significant"
1187 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1188 * with a bunch of small requests.
1190 static void xs_udp_write_space(struct sock
*sk
)
1192 read_lock(&sk
->sk_callback_lock
);
1194 /* from net/core/sock.c:sock_def_write_space */
1195 if (sock_writeable(sk
)) {
1196 struct socket
*sock
;
1197 struct rpc_xprt
*xprt
;
1199 if (unlikely(!(sock
= sk
->sk_socket
)))
1201 clear_bit(SOCK_NOSPACE
, &sock
->flags
);
1203 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
1205 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
) == 0)
1208 xprt_write_space(xprt
);
1212 read_unlock(&sk
->sk_callback_lock
);
1216 * xs_tcp_write_space - callback invoked when socket buffer space
1218 * @sk: socket whose state has changed
1220 * Called when more output buffer space is available for this socket.
1221 * We try not to wake our writers until they can make "significant"
1222 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1223 * with a bunch of small requests.
1225 static void xs_tcp_write_space(struct sock
*sk
)
1227 read_lock(&sk
->sk_callback_lock
);
1229 /* from net/core/stream.c:sk_stream_write_space */
1230 if (sk_stream_wspace(sk
) >= sk_stream_min_wspace(sk
)) {
1231 struct socket
*sock
;
1232 struct rpc_xprt
*xprt
;
1234 if (unlikely(!(sock
= sk
->sk_socket
)))
1236 clear_bit(SOCK_NOSPACE
, &sock
->flags
);
1238 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
1240 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
) == 0)
1243 xprt_write_space(xprt
);
1247 read_unlock(&sk
->sk_callback_lock
);
1250 static void xs_udp_do_set_buffer_size(struct rpc_xprt
*xprt
)
1252 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1253 struct sock
*sk
= transport
->inet
;
1255 if (transport
->rcvsize
) {
1256 sk
->sk_userlocks
|= SOCK_RCVBUF_LOCK
;
1257 sk
->sk_rcvbuf
= transport
->rcvsize
* xprt
->max_reqs
* 2;
1259 if (transport
->sndsize
) {
1260 sk
->sk_userlocks
|= SOCK_SNDBUF_LOCK
;
1261 sk
->sk_sndbuf
= transport
->sndsize
* xprt
->max_reqs
* 2;
1262 sk
->sk_write_space(sk
);
1267 * xs_udp_set_buffer_size - set send and receive limits
1268 * @xprt: generic transport
1269 * @sndsize: requested size of send buffer, in bytes
1270 * @rcvsize: requested size of receive buffer, in bytes
1272 * Set socket send and receive buffer size limits.
1274 static void xs_udp_set_buffer_size(struct rpc_xprt
*xprt
, size_t sndsize
, size_t rcvsize
)
1276 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1278 transport
->sndsize
= 0;
1280 transport
->sndsize
= sndsize
+ 1024;
1281 transport
->rcvsize
= 0;
1283 transport
->rcvsize
= rcvsize
+ 1024;
1285 xs_udp_do_set_buffer_size(xprt
);
1289 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1290 * @task: task that timed out
1292 * Adjust the congestion window after a retransmit timeout has occurred.
1294 static void xs_udp_timer(struct rpc_task
*task
)
1296 xprt_adjust_cwnd(task
, -ETIMEDOUT
);
1299 static unsigned short xs_get_random_port(void)
1301 unsigned short range
= xprt_max_resvport
- xprt_min_resvport
;
1302 unsigned short rand
= (unsigned short) net_random() % range
;
1303 return rand
+ xprt_min_resvport
;
1307 * xs_set_port - reset the port number in the remote endpoint address
1308 * @xprt: generic transport
1309 * @port: new port number
1312 static void xs_set_port(struct rpc_xprt
*xprt
, unsigned short port
)
1314 struct sockaddr
*addr
= xs_addr(xprt
);
1316 dprintk("RPC: setting port for xprt %p to %u\n", xprt
, port
);
1318 switch (addr
->sa_family
) {
1320 ((struct sockaddr_in
*)addr
)->sin_port
= htons(port
);
1323 ((struct sockaddr_in6
*)addr
)->sin6_port
= htons(port
);
1330 static unsigned short xs_get_srcport(struct sock_xprt
*transport
, struct socket
*sock
)
1332 unsigned short port
= transport
->port
;
1334 if (port
== 0 && transport
->xprt
.resvport
)
1335 port
= xs_get_random_port();
1339 static unsigned short xs_next_srcport(struct sock_xprt
*transport
, struct socket
*sock
, unsigned short port
)
1341 if (transport
->port
!= 0)
1342 transport
->port
= 0;
1343 if (!transport
->xprt
.resvport
)
1345 if (port
<= xprt_min_resvport
|| port
> xprt_max_resvport
)
1346 return xprt_max_resvport
;
1350 static int xs_bind4(struct sock_xprt
*transport
, struct socket
*sock
)
1352 struct sockaddr_in myaddr
= {
1353 .sin_family
= AF_INET
,
1355 struct sockaddr_in
*sa
;
1357 unsigned short port
= xs_get_srcport(transport
, sock
);
1358 unsigned short last
;
1360 sa
= (struct sockaddr_in
*)&transport
->addr
;
1361 myaddr
.sin_addr
= sa
->sin_addr
;
1363 myaddr
.sin_port
= htons(port
);
1364 err
= kernel_bind(sock
, (struct sockaddr
*) &myaddr
,
1369 transport
->port
= port
;
1373 port
= xs_next_srcport(transport
, sock
, port
);
1376 } while (err
== -EADDRINUSE
&& nloop
!= 2);
1377 dprintk("RPC: %s "NIPQUAD_FMT
":%u: %s (%d)\n",
1378 __func__
, NIPQUAD(myaddr
.sin_addr
),
1379 port
, err
? "failed" : "ok", err
);
1383 static int xs_bind6(struct sock_xprt
*transport
, struct socket
*sock
)
1385 struct sockaddr_in6 myaddr
= {
1386 .sin6_family
= AF_INET6
,
1388 struct sockaddr_in6
*sa
;
1390 unsigned short port
= xs_get_srcport(transport
, sock
);
1391 unsigned short last
;
1393 sa
= (struct sockaddr_in6
*)&transport
->addr
;
1394 myaddr
.sin6_addr
= sa
->sin6_addr
;
1396 myaddr
.sin6_port
= htons(port
);
1397 err
= kernel_bind(sock
, (struct sockaddr
*) &myaddr
,
1402 transport
->port
= port
;
1406 port
= xs_next_srcport(transport
, sock
, port
);
1409 } while (err
== -EADDRINUSE
&& nloop
!= 2);
1410 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1411 &myaddr
.sin6_addr
, port
, err
? "failed" : "ok", err
);
1415 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1416 static struct lock_class_key xs_key
[2];
1417 static struct lock_class_key xs_slock_key
[2];
1419 static inline void xs_reclassify_socket4(struct socket
*sock
)
1421 struct sock
*sk
= sock
->sk
;
1423 BUG_ON(sock_owned_by_user(sk
));
1424 sock_lock_init_class_and_name(sk
, "slock-AF_INET-RPC",
1425 &xs_slock_key
[0], "sk_lock-AF_INET-RPC", &xs_key
[0]);
1428 static inline void xs_reclassify_socket6(struct socket
*sock
)
1430 struct sock
*sk
= sock
->sk
;
1432 BUG_ON(sock_owned_by_user(sk
));
1433 sock_lock_init_class_and_name(sk
, "slock-AF_INET6-RPC",
1434 &xs_slock_key
[1], "sk_lock-AF_INET6-RPC", &xs_key
[1]);
1437 static inline void xs_reclassify_socket4(struct socket
*sock
)
1441 static inline void xs_reclassify_socket6(struct socket
*sock
)
1446 static void xs_udp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
1448 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1450 if (!transport
->inet
) {
1451 struct sock
*sk
= sock
->sk
;
1453 write_lock_bh(&sk
->sk_callback_lock
);
1455 sk
->sk_user_data
= xprt
;
1456 transport
->old_data_ready
= sk
->sk_data_ready
;
1457 transport
->old_state_change
= sk
->sk_state_change
;
1458 transport
->old_write_space
= sk
->sk_write_space
;
1459 sk
->sk_data_ready
= xs_udp_data_ready
;
1460 sk
->sk_write_space
= xs_udp_write_space
;
1461 sk
->sk_no_check
= UDP_CSUM_NORCV
;
1462 sk
->sk_allocation
= GFP_ATOMIC
;
1464 xprt_set_connected(xprt
);
1466 /* Reset to new socket */
1467 transport
->sock
= sock
;
1468 transport
->inet
= sk
;
1470 write_unlock_bh(&sk
->sk_callback_lock
);
1472 xs_udp_do_set_buffer_size(xprt
);
1476 * xs_udp_connect_worker4 - set up a UDP socket
1477 * @work: RPC transport to connect
1479 * Invoked by a work queue tasklet.
1481 static void xs_udp_connect_worker4(struct work_struct
*work
)
1483 struct sock_xprt
*transport
=
1484 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1485 struct rpc_xprt
*xprt
= &transport
->xprt
;
1486 struct socket
*sock
= transport
->sock
;
1487 int err
, status
= -EIO
;
1489 if (xprt
->shutdown
|| !xprt_bound(xprt
))
1492 /* Start by resetting any existing state */
1495 if ((err
= sock_create_kern(PF_INET
, SOCK_DGRAM
, IPPROTO_UDP
, &sock
)) < 0) {
1496 dprintk("RPC: can't create UDP transport socket (%d).\n", -err
);
1499 xs_reclassify_socket4(sock
);
1501 if (xs_bind4(transport
, sock
)) {
1506 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1507 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1509 xs_udp_finish_connecting(xprt
, sock
);
1512 xprt_wake_pending_tasks(xprt
, status
);
1513 xprt_clear_connecting(xprt
);
1517 * xs_udp_connect_worker6 - set up a UDP socket
1518 * @work: RPC transport to connect
1520 * Invoked by a work queue tasklet.
1522 static void xs_udp_connect_worker6(struct work_struct
*work
)
1524 struct sock_xprt
*transport
=
1525 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1526 struct rpc_xprt
*xprt
= &transport
->xprt
;
1527 struct socket
*sock
= transport
->sock
;
1528 int err
, status
= -EIO
;
1530 if (xprt
->shutdown
|| !xprt_bound(xprt
))
1533 /* Start by resetting any existing state */
1536 if ((err
= sock_create_kern(PF_INET6
, SOCK_DGRAM
, IPPROTO_UDP
, &sock
)) < 0) {
1537 dprintk("RPC: can't create UDP transport socket (%d).\n", -err
);
1540 xs_reclassify_socket6(sock
);
1542 if (xs_bind6(transport
, sock
) < 0) {
1547 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1548 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1550 xs_udp_finish_connecting(xprt
, sock
);
1553 xprt_wake_pending_tasks(xprt
, status
);
1554 xprt_clear_connecting(xprt
);
1558 * We need to preserve the port number so the reply cache on the server can
1559 * find our cached RPC replies when we get around to reconnecting.
1561 static void xs_tcp_reuse_connection(struct rpc_xprt
*xprt
)
1564 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1565 struct sockaddr any
;
1567 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt
);
1570 * Disconnect the transport socket by doing a connect operation
1571 * with AF_UNSPEC. This should return immediately...
1573 memset(&any
, 0, sizeof(any
));
1574 any
.sa_family
= AF_UNSPEC
;
1575 result
= kernel_connect(transport
->sock
, &any
, sizeof(any
), 0);
1577 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1581 static int xs_tcp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
1583 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1585 if (!transport
->inet
) {
1586 struct sock
*sk
= sock
->sk
;
1588 write_lock_bh(&sk
->sk_callback_lock
);
1590 sk
->sk_user_data
= xprt
;
1591 transport
->old_data_ready
= sk
->sk_data_ready
;
1592 transport
->old_state_change
= sk
->sk_state_change
;
1593 transport
->old_write_space
= sk
->sk_write_space
;
1594 sk
->sk_data_ready
= xs_tcp_data_ready
;
1595 sk
->sk_state_change
= xs_tcp_state_change
;
1596 sk
->sk_write_space
= xs_tcp_write_space
;
1597 sk
->sk_allocation
= GFP_ATOMIC
;
1599 /* socket options */
1600 sk
->sk_userlocks
|= SOCK_BINDPORT_LOCK
;
1601 sock_reset_flag(sk
, SOCK_LINGER
);
1602 tcp_sk(sk
)->linger2
= 0;
1603 tcp_sk(sk
)->nonagle
|= TCP_NAGLE_OFF
;
1605 xprt_clear_connected(xprt
);
1607 /* Reset to new socket */
1608 transport
->sock
= sock
;
1609 transport
->inet
= sk
;
1611 write_unlock_bh(&sk
->sk_callback_lock
);
1614 /* Tell the socket layer to start connecting... */
1615 xprt
->stat
.connect_count
++;
1616 xprt
->stat
.connect_start
= jiffies
;
1617 return kernel_connect(sock
, xs_addr(xprt
), xprt
->addrlen
, O_NONBLOCK
);
1621 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1622 * @work: RPC transport to connect
1624 * Invoked by a work queue tasklet.
1626 static void xs_tcp_connect_worker4(struct work_struct
*work
)
1628 struct sock_xprt
*transport
=
1629 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1630 struct rpc_xprt
*xprt
= &transport
->xprt
;
1631 struct socket
*sock
= transport
->sock
;
1632 int err
, status
= -EIO
;
1634 if (xprt
->shutdown
|| !xprt_bound(xprt
))
1638 /* start from scratch */
1639 if ((err
= sock_create_kern(PF_INET
, SOCK_STREAM
, IPPROTO_TCP
, &sock
)) < 0) {
1640 dprintk("RPC: can't create TCP transport socket (%d).\n", -err
);
1643 xs_reclassify_socket4(sock
);
1645 if (xs_bind4(transport
, sock
) < 0) {
1650 /* "close" the socket, preserving the local port */
1651 xs_tcp_reuse_connection(xprt
);
1653 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1654 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1656 status
= xs_tcp_finish_connecting(xprt
, sock
);
1657 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1658 xprt
, -status
, xprt_connected(xprt
),
1659 sock
->sk
->sk_state
);
1667 /* retry with existing socket, after a delay */
1670 /* get rid of existing socket, and retry */
1671 xs_tcp_shutdown(xprt
);
1675 xprt_wake_pending_tasks(xprt
, status
);
1677 xprt_clear_connecting(xprt
);
1681 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
1682 * @work: RPC transport to connect
1684 * Invoked by a work queue tasklet.
1686 static void xs_tcp_connect_worker6(struct work_struct
*work
)
1688 struct sock_xprt
*transport
=
1689 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1690 struct rpc_xprt
*xprt
= &transport
->xprt
;
1691 struct socket
*sock
= transport
->sock
;
1692 int err
, status
= -EIO
;
1694 if (xprt
->shutdown
|| !xprt_bound(xprt
))
1698 /* start from scratch */
1699 if ((err
= sock_create_kern(PF_INET6
, SOCK_STREAM
, IPPROTO_TCP
, &sock
)) < 0) {
1700 dprintk("RPC: can't create TCP transport socket (%d).\n", -err
);
1703 xs_reclassify_socket6(sock
);
1705 if (xs_bind6(transport
, sock
) < 0) {
1710 /* "close" the socket, preserving the local port */
1711 xs_tcp_reuse_connection(xprt
);
1713 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1714 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1716 status
= xs_tcp_finish_connecting(xprt
, sock
);
1717 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1718 xprt
, -status
, xprt_connected(xprt
), sock
->sk
->sk_state
);
1726 /* retry with existing socket, after a delay */
1729 /* get rid of existing socket, and retry */
1730 xs_tcp_shutdown(xprt
);
1734 xprt_wake_pending_tasks(xprt
, status
);
1736 xprt_clear_connecting(xprt
);
1740 * xs_connect - connect a socket to a remote endpoint
1741 * @task: address of RPC task that manages state of connect request
1743 * TCP: If the remote end dropped the connection, delay reconnecting.
1745 * UDP socket connects are synchronous, but we use a work queue anyway
1746 * to guarantee that even unprivileged user processes can set up a
1747 * socket on a privileged port.
1749 * If a UDP socket connect fails, the delay behavior here prevents
1750 * retry floods (hard mounts).
1752 static void xs_connect(struct rpc_task
*task
)
1754 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1755 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1757 if (xprt_test_and_set_connecting(xprt
))
1760 if (transport
->sock
!= NULL
) {
1761 dprintk("RPC: xs_connect delayed xprt %p for %lu "
1763 xprt
, xprt
->reestablish_timeout
/ HZ
);
1764 queue_delayed_work(rpciod_workqueue
,
1765 &transport
->connect_worker
,
1766 xprt
->reestablish_timeout
);
1767 xprt
->reestablish_timeout
<<= 1;
1768 if (xprt
->reestablish_timeout
> XS_TCP_MAX_REEST_TO
)
1769 xprt
->reestablish_timeout
= XS_TCP_MAX_REEST_TO
;
1771 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt
);
1772 queue_delayed_work(rpciod_workqueue
,
1773 &transport
->connect_worker
, 0);
1777 static void xs_tcp_connect(struct rpc_task
*task
)
1779 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1781 /* Initiate graceful shutdown of the socket if not already done */
1782 if (test_bit(XPRT_CONNECTED
, &xprt
->state
))
1783 xs_tcp_shutdown(xprt
);
1784 /* Exit if we need to wait for socket shutdown to complete */
1785 if (test_bit(XPRT_CLOSING
, &xprt
->state
))
1791 * xs_udp_print_stats - display UDP socket-specifc stats
1792 * @xprt: rpc_xprt struct containing statistics
1796 static void xs_udp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
1798 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1800 seq_printf(seq
, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
1802 xprt
->stat
.bind_count
,
1805 xprt
->stat
.bad_xids
,
1807 xprt
->stat
.bklog_u
);
1811 * xs_tcp_print_stats - display TCP socket-specifc stats
1812 * @xprt: rpc_xprt struct containing statistics
1816 static void xs_tcp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
1818 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1821 if (xprt_connected(xprt
))
1822 idle_time
= (long)(jiffies
- xprt
->last_used
) / HZ
;
1824 seq_printf(seq
, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
1826 xprt
->stat
.bind_count
,
1827 xprt
->stat
.connect_count
,
1828 xprt
->stat
.connect_time
,
1832 xprt
->stat
.bad_xids
,
1834 xprt
->stat
.bklog_u
);
1837 static struct rpc_xprt_ops xs_udp_ops
= {
1838 .set_buffer_size
= xs_udp_set_buffer_size
,
1839 .reserve_xprt
= xprt_reserve_xprt_cong
,
1840 .release_xprt
= xprt_release_xprt_cong
,
1841 .rpcbind
= rpcb_getport_async
,
1842 .set_port
= xs_set_port
,
1843 .connect
= xs_connect
,
1844 .buf_alloc
= rpc_malloc
,
1845 .buf_free
= rpc_free
,
1846 .send_request
= xs_udp_send_request
,
1847 .set_retrans_timeout
= xprt_set_retrans_timeout_rtt
,
1848 .timer
= xs_udp_timer
,
1849 .release_request
= xprt_release_rqst_cong
,
1851 .destroy
= xs_destroy
,
1852 .print_stats
= xs_udp_print_stats
,
1855 static struct rpc_xprt_ops xs_tcp_ops
= {
1856 .reserve_xprt
= xprt_reserve_xprt
,
1857 .release_xprt
= xs_tcp_release_xprt
,
1858 .rpcbind
= rpcb_getport_async
,
1859 .set_port
= xs_set_port
,
1860 .connect
= xs_tcp_connect
,
1861 .buf_alloc
= rpc_malloc
,
1862 .buf_free
= rpc_free
,
1863 .send_request
= xs_tcp_send_request
,
1864 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
1865 .close
= xs_tcp_shutdown
,
1866 .destroy
= xs_destroy
,
1867 .print_stats
= xs_tcp_print_stats
,
1870 static struct rpc_xprt
*xs_setup_xprt(struct xprt_create
*args
,
1871 unsigned int slot_table_size
)
1873 struct rpc_xprt
*xprt
;
1874 struct sock_xprt
*new;
1876 if (args
->addrlen
> sizeof(xprt
->addr
)) {
1877 dprintk("RPC: xs_setup_xprt: address too large\n");
1878 return ERR_PTR(-EBADF
);
1881 new = kzalloc(sizeof(*new), GFP_KERNEL
);
1883 dprintk("RPC: xs_setup_xprt: couldn't allocate "
1885 return ERR_PTR(-ENOMEM
);
1889 xprt
->max_reqs
= slot_table_size
;
1890 xprt
->slot
= kcalloc(xprt
->max_reqs
, sizeof(struct rpc_rqst
), GFP_KERNEL
);
1891 if (xprt
->slot
== NULL
) {
1893 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
1895 return ERR_PTR(-ENOMEM
);
1898 memcpy(&xprt
->addr
, args
->dstaddr
, args
->addrlen
);
1899 xprt
->addrlen
= args
->addrlen
;
1901 memcpy(&new->addr
, args
->srcaddr
, args
->addrlen
);
1906 static const struct rpc_timeout xs_udp_default_timeout
= {
1907 .to_initval
= 5 * HZ
,
1908 .to_maxval
= 30 * HZ
,
1909 .to_increment
= 5 * HZ
,
1914 * xs_setup_udp - Set up transport to use a UDP socket
1915 * @args: rpc transport creation arguments
1918 static struct rpc_xprt
*xs_setup_udp(struct xprt_create
*args
)
1920 struct sockaddr
*addr
= args
->dstaddr
;
1921 struct rpc_xprt
*xprt
;
1922 struct sock_xprt
*transport
;
1924 xprt
= xs_setup_xprt(args
, xprt_udp_slot_table_entries
);
1927 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1929 xprt
->prot
= IPPROTO_UDP
;
1931 /* XXX: header size can vary due to auth type, IPv6, etc. */
1932 xprt
->max_payload
= (1U << 16) - (MAX_HEADER
<< 3);
1934 xprt
->bind_timeout
= XS_BIND_TO
;
1935 xprt
->connect_timeout
= XS_UDP_CONN_TO
;
1936 xprt
->reestablish_timeout
= XS_UDP_REEST_TO
;
1937 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
1939 xprt
->ops
= &xs_udp_ops
;
1941 xprt
->timeout
= &xs_udp_default_timeout
;
1943 switch (addr
->sa_family
) {
1945 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
1946 xprt_set_bound(xprt
);
1948 INIT_DELAYED_WORK(&transport
->connect_worker
,
1949 xs_udp_connect_worker4
);
1950 xs_format_ipv4_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP
);
1953 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
1954 xprt_set_bound(xprt
);
1956 INIT_DELAYED_WORK(&transport
->connect_worker
,
1957 xs_udp_connect_worker6
);
1958 xs_format_ipv6_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP6
);
1962 return ERR_PTR(-EAFNOSUPPORT
);
1965 dprintk("RPC: set up transport to address %s\n",
1966 xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1968 if (try_module_get(THIS_MODULE
))
1973 return ERR_PTR(-EINVAL
);
1976 static const struct rpc_timeout xs_tcp_default_timeout
= {
1977 .to_initval
= 60 * HZ
,
1978 .to_maxval
= 60 * HZ
,
1983 * xs_setup_tcp - Set up transport to use a TCP socket
1984 * @args: rpc transport creation arguments
1987 static struct rpc_xprt
*xs_setup_tcp(struct xprt_create
*args
)
1989 struct sockaddr
*addr
= args
->dstaddr
;
1990 struct rpc_xprt
*xprt
;
1991 struct sock_xprt
*transport
;
1993 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
);
1996 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1998 xprt
->prot
= IPPROTO_TCP
;
1999 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
2000 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
2002 xprt
->bind_timeout
= XS_BIND_TO
;
2003 xprt
->connect_timeout
= XS_TCP_CONN_TO
;
2004 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2005 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2007 xprt
->ops
= &xs_tcp_ops
;
2008 xprt
->timeout
= &xs_tcp_default_timeout
;
2010 switch (addr
->sa_family
) {
2012 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
2013 xprt_set_bound(xprt
);
2015 INIT_DELAYED_WORK(&transport
->connect_worker
, xs_tcp_connect_worker4
);
2016 xs_format_ipv4_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP
);
2019 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
2020 xprt_set_bound(xprt
);
2022 INIT_DELAYED_WORK(&transport
->connect_worker
, xs_tcp_connect_worker6
);
2023 xs_format_ipv6_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP6
);
2027 return ERR_PTR(-EAFNOSUPPORT
);
2030 dprintk("RPC: set up transport to address %s\n",
2031 xprt
->address_strings
[RPC_DISPLAY_ALL
]);
2033 if (try_module_get(THIS_MODULE
))
2038 return ERR_PTR(-EINVAL
);
2041 static struct xprt_class xs_udp_transport
= {
2042 .list
= LIST_HEAD_INIT(xs_udp_transport
.list
),
2044 .owner
= THIS_MODULE
,
2045 .ident
= IPPROTO_UDP
,
2046 .setup
= xs_setup_udp
,
2049 static struct xprt_class xs_tcp_transport
= {
2050 .list
= LIST_HEAD_INIT(xs_tcp_transport
.list
),
2052 .owner
= THIS_MODULE
,
2053 .ident
= IPPROTO_TCP
,
2054 .setup
= xs_setup_tcp
,
2058 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2061 int init_socket_xprt(void)
2064 if (!sunrpc_table_header
)
2065 sunrpc_table_header
= register_sysctl_table(sunrpc_table
);
2068 xprt_register_transport(&xs_udp_transport
);
2069 xprt_register_transport(&xs_tcp_transport
);
2075 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2078 void cleanup_socket_xprt(void)
2081 if (sunrpc_table_header
) {
2082 unregister_sysctl_table(sunrpc_table_header
);
2083 sunrpc_table_header
= NULL
;
2087 xprt_unregister_transport(&xs_udp_transport
);
2088 xprt_unregister_transport(&xs_tcp_transport
);