2 * linux/net/sunrpc/xprtsock.c
4 * Client-side transport implementation for sockets.
6 * TCP callback races fixes (C) 1998 Red Hat
7 * TCP send fixes (C) 1998 Red Hat
8 * TCP NFS related read + write fixes
9 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
11 * Rewrite of larges part of the code in order to stabilize TCP stuff.
12 * Fix behaviour when socket buffer is full.
13 * (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no>
15 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
17 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
18 * <gilles.quillard@bull.net>
21 #include <linux/types.h>
22 #include <linux/slab.h>
23 #include <linux/module.h>
24 #include <linux/capability.h>
25 #include <linux/pagemap.h>
26 #include <linux/errno.h>
27 #include <linux/socket.h>
29 #include <linux/net.h>
31 #include <linux/udp.h>
32 #include <linux/tcp.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/sched.h>
35 #include <linux/sunrpc/xprtsock.h>
36 #include <linux/file.h>
39 #include <net/checksum.h>
46 unsigned int xprt_udp_slot_table_entries
= RPC_DEF_SLOT_TABLE
;
47 unsigned int xprt_tcp_slot_table_entries
= RPC_DEF_SLOT_TABLE
;
49 unsigned int xprt_min_resvport
= RPC_DEF_MIN_RESVPORT
;
50 unsigned int xprt_max_resvport
= RPC_DEF_MAX_RESVPORT
;
52 #define XS_TCP_LINGER_TO (15U * HZ)
55 * We can register our own files under /proc/sys/sunrpc by
56 * calling register_sysctl_table() again. The files in that
57 * directory become the union of all files registered there.
59 * We simply need to make sure that we don't collide with
60 * someone else's file names!
65 static unsigned int min_slot_table_size
= RPC_MIN_SLOT_TABLE
;
66 static unsigned int max_slot_table_size
= RPC_MAX_SLOT_TABLE
;
67 static unsigned int xprt_min_resvport_limit
= RPC_MIN_RESVPORT
;
68 static unsigned int xprt_max_resvport_limit
= RPC_MAX_RESVPORT
;
70 static struct ctl_table_header
*sunrpc_table_header
;
73 * FIXME: changing the UDP slot table size should also resize the UDP
74 * socket buffers for existing UDP transports
76 static ctl_table xs_tunables_table
[] = {
78 .ctl_name
= CTL_SLOTTABLE_UDP
,
79 .procname
= "udp_slot_table_entries",
80 .data
= &xprt_udp_slot_table_entries
,
81 .maxlen
= sizeof(unsigned int),
83 .proc_handler
= &proc_dointvec_minmax
,
84 .strategy
= &sysctl_intvec
,
85 .extra1
= &min_slot_table_size
,
86 .extra2
= &max_slot_table_size
89 .ctl_name
= CTL_SLOTTABLE_TCP
,
90 .procname
= "tcp_slot_table_entries",
91 .data
= &xprt_tcp_slot_table_entries
,
92 .maxlen
= sizeof(unsigned int),
94 .proc_handler
= &proc_dointvec_minmax
,
95 .strategy
= &sysctl_intvec
,
96 .extra1
= &min_slot_table_size
,
97 .extra2
= &max_slot_table_size
100 .ctl_name
= CTL_MIN_RESVPORT
,
101 .procname
= "min_resvport",
102 .data
= &xprt_min_resvport
,
103 .maxlen
= sizeof(unsigned int),
105 .proc_handler
= &proc_dointvec_minmax
,
106 .strategy
= &sysctl_intvec
,
107 .extra1
= &xprt_min_resvport_limit
,
108 .extra2
= &xprt_max_resvport_limit
111 .ctl_name
= CTL_MAX_RESVPORT
,
112 .procname
= "max_resvport",
113 .data
= &xprt_max_resvport
,
114 .maxlen
= sizeof(unsigned int),
116 .proc_handler
= &proc_dointvec_minmax
,
117 .strategy
= &sysctl_intvec
,
118 .extra1
= &xprt_min_resvport_limit
,
119 .extra2
= &xprt_max_resvport_limit
126 static ctl_table sunrpc_table
[] = {
128 .ctl_name
= CTL_SUNRPC
,
129 .procname
= "sunrpc",
131 .child
= xs_tunables_table
141 * Time out for an RPC UDP socket connect. UDP socket connects are
142 * synchronous, but we set a timeout anyway in case of resource
143 * exhaustion on the local host.
145 #define XS_UDP_CONN_TO (5U * HZ)
148 * Wait duration for an RPC TCP connection to be established. Solaris
149 * NFS over TCP uses 60 seconds, for example, which is in line with how
150 * long a server takes to reboot.
152 #define XS_TCP_CONN_TO (60U * HZ)
155 * Wait duration for a reply from the RPC portmapper.
157 #define XS_BIND_TO (60U * HZ)
160 * Delay if a UDP socket connect error occurs. This is most likely some
161 * kind of resource problem on the local host.
163 #define XS_UDP_REEST_TO (2U * HZ)
166 * The reestablish timeout allows clients to delay for a bit before attempting
167 * to reconnect to a server that just dropped our connection.
169 * We implement an exponential backoff when trying to reestablish a TCP
170 * transport connection with the server. Some servers like to drop a TCP
171 * connection when they are overworked, so we start with a short timeout and
172 * increase over time if the server is down or not responding.
174 #define XS_TCP_INIT_REEST_TO (3U * HZ)
175 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
178 * TCP idle timeout; client drops the transport socket if it is idle
179 * for this long. Note that we also timeout UDP sockets to prevent
180 * holding port numbers when there is no RPC traffic.
182 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
185 # undef RPC_DEBUG_DATA
186 # define RPCDBG_FACILITY RPCDBG_TRANS
189 #ifdef RPC_DEBUG_DATA
190 static void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
192 u8
*buf
= (u8
*) packet
;
195 dprintk("RPC: %s\n", msg
);
196 for (j
= 0; j
< count
&& j
< 128; j
+= 4) {
200 dprintk("0x%04x ", j
);
202 dprintk("%02x%02x%02x%02x ",
203 buf
[j
], buf
[j
+1], buf
[j
+2], buf
[j
+3]);
208 static inline void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
215 struct rpc_xprt xprt
;
220 struct socket
* sock
;
224 * State of TCP reply receive
232 unsigned long tcp_copied
,
236 * Connection of transports
238 struct delayed_work connect_worker
;
239 struct sockaddr_storage addr
;
243 * UDP socket buffer size parameters
249 * Saved socket callback addresses
251 void (*old_data_ready
)(struct sock
*, int);
252 void (*old_state_change
)(struct sock
*);
253 void (*old_write_space
)(struct sock
*);
254 void (*old_error_report
)(struct sock
*);
258 * TCP receive state flags
260 #define TCP_RCV_LAST_FRAG (1UL << 0)
261 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
262 #define TCP_RCV_COPY_XID (1UL << 2)
263 #define TCP_RCV_COPY_DATA (1UL << 3)
265 static inline struct sockaddr
*xs_addr(struct rpc_xprt
*xprt
)
267 return (struct sockaddr
*) &xprt
->addr
;
270 static inline struct sockaddr_in
*xs_addr_in(struct rpc_xprt
*xprt
)
272 return (struct sockaddr_in
*) &xprt
->addr
;
275 static inline struct sockaddr_in6
*xs_addr_in6(struct rpc_xprt
*xprt
)
277 return (struct sockaddr_in6
*) &xprt
->addr
;
280 static void xs_format_ipv4_peer_addresses(struct rpc_xprt
*xprt
,
281 const char *protocol
,
284 struct sockaddr_in
*addr
= xs_addr_in(xprt
);
287 buf
= kzalloc(20, GFP_KERNEL
);
289 snprintf(buf
, 20, "%pI4", &addr
->sin_addr
.s_addr
);
291 xprt
->address_strings
[RPC_DISPLAY_ADDR
] = buf
;
293 buf
= kzalloc(8, GFP_KERNEL
);
295 snprintf(buf
, 8, "%u",
296 ntohs(addr
->sin_port
));
298 xprt
->address_strings
[RPC_DISPLAY_PORT
] = buf
;
300 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = protocol
;
302 buf
= kzalloc(48, GFP_KERNEL
);
304 snprintf(buf
, 48, "addr=%pI4 port=%u proto=%s",
305 &addr
->sin_addr
.s_addr
,
306 ntohs(addr
->sin_port
),
309 xprt
->address_strings
[RPC_DISPLAY_ALL
] = buf
;
311 buf
= kzalloc(10, GFP_KERNEL
);
313 snprintf(buf
, 10, "%02x%02x%02x%02x",
314 NIPQUAD(addr
->sin_addr
.s_addr
));
316 xprt
->address_strings
[RPC_DISPLAY_HEX_ADDR
] = buf
;
318 buf
= kzalloc(8, GFP_KERNEL
);
320 snprintf(buf
, 8, "%4hx",
321 ntohs(addr
->sin_port
));
323 xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
] = buf
;
325 buf
= kzalloc(30, GFP_KERNEL
);
327 snprintf(buf
, 30, "%pI4.%u.%u",
328 &addr
->sin_addr
.s_addr
,
329 ntohs(addr
->sin_port
) >> 8,
330 ntohs(addr
->sin_port
) & 0xff);
332 xprt
->address_strings
[RPC_DISPLAY_UNIVERSAL_ADDR
] = buf
;
334 xprt
->address_strings
[RPC_DISPLAY_NETID
] = netid
;
337 static void xs_format_ipv6_peer_addresses(struct rpc_xprt
*xprt
,
338 const char *protocol
,
341 struct sockaddr_in6
*addr
= xs_addr_in6(xprt
);
344 buf
= kzalloc(40, GFP_KERNEL
);
346 snprintf(buf
, 40, "%pI6",&addr
->sin6_addr
);
348 xprt
->address_strings
[RPC_DISPLAY_ADDR
] = buf
;
350 buf
= kzalloc(8, GFP_KERNEL
);
352 snprintf(buf
, 8, "%u",
353 ntohs(addr
->sin6_port
));
355 xprt
->address_strings
[RPC_DISPLAY_PORT
] = buf
;
357 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = protocol
;
359 buf
= kzalloc(64, GFP_KERNEL
);
361 snprintf(buf
, 64, "addr=%pI6 port=%u proto=%s",
363 ntohs(addr
->sin6_port
),
366 xprt
->address_strings
[RPC_DISPLAY_ALL
] = buf
;
368 buf
= kzalloc(36, GFP_KERNEL
);
370 snprintf(buf
, 36, "%pi6", &addr
->sin6_addr
);
372 xprt
->address_strings
[RPC_DISPLAY_HEX_ADDR
] = buf
;
374 buf
= kzalloc(8, GFP_KERNEL
);
376 snprintf(buf
, 8, "%4hx",
377 ntohs(addr
->sin6_port
));
379 xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
] = buf
;
381 buf
= kzalloc(50, GFP_KERNEL
);
383 snprintf(buf
, 50, "%pI6.%u.%u",
385 ntohs(addr
->sin6_port
) >> 8,
386 ntohs(addr
->sin6_port
) & 0xff);
388 xprt
->address_strings
[RPC_DISPLAY_UNIVERSAL_ADDR
] = buf
;
390 xprt
->address_strings
[RPC_DISPLAY_NETID
] = netid
;
393 static void xs_free_peer_addresses(struct rpc_xprt
*xprt
)
397 for (i
= 0; i
< RPC_DISPLAY_MAX
; i
++)
399 case RPC_DISPLAY_PROTO
:
400 case RPC_DISPLAY_NETID
:
403 kfree(xprt
->address_strings
[i
]);
407 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
409 static int xs_send_kvec(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct kvec
*vec
, unsigned int base
, int more
)
411 struct msghdr msg
= {
413 .msg_namelen
= addrlen
,
414 .msg_flags
= XS_SENDMSG_FLAGS
| (more
? MSG_MORE
: 0),
417 .iov_base
= vec
->iov_base
+ base
,
418 .iov_len
= vec
->iov_len
- base
,
421 if (iov
.iov_len
!= 0)
422 return kernel_sendmsg(sock
, &msg
, &iov
, 1, iov
.iov_len
);
423 return kernel_sendmsg(sock
, &msg
, NULL
, 0, 0);
426 static int xs_send_pagedata(struct socket
*sock
, struct xdr_buf
*xdr
, unsigned int base
, int more
)
429 unsigned int remainder
;
432 remainder
= xdr
->page_len
- base
;
433 base
+= xdr
->page_base
;
434 ppage
= xdr
->pages
+ (base
>> PAGE_SHIFT
);
437 unsigned int len
= min_t(unsigned int, PAGE_SIZE
- base
, remainder
);
438 int flags
= XS_SENDMSG_FLAGS
;
441 if (remainder
!= 0 || more
)
443 err
= sock
->ops
->sendpage(sock
, *ppage
, base
, len
, flags
);
444 if (remainder
== 0 || err
!= len
)
458 * xs_sendpages - write pages directly to a socket
459 * @sock: socket to send on
460 * @addr: UDP only -- address of destination
461 * @addrlen: UDP only -- length of destination address
462 * @xdr: buffer containing this request
463 * @base: starting position in the buffer
466 static int xs_sendpages(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct xdr_buf
*xdr
, unsigned int base
)
468 unsigned int remainder
= xdr
->len
- base
;
474 clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
);
480 if (base
< xdr
->head
[0].iov_len
|| addr
!= NULL
) {
481 unsigned int len
= xdr
->head
[0].iov_len
- base
;
483 err
= xs_send_kvec(sock
, addr
, addrlen
, &xdr
->head
[0], base
, remainder
!= 0);
484 if (remainder
== 0 || err
!= len
)
489 base
-= xdr
->head
[0].iov_len
;
491 if (base
< xdr
->page_len
) {
492 unsigned int len
= xdr
->page_len
- base
;
494 err
= xs_send_pagedata(sock
, xdr
, base
, remainder
!= 0);
495 if (remainder
== 0 || err
!= len
)
500 base
-= xdr
->page_len
;
502 if (base
>= xdr
->tail
[0].iov_len
)
504 err
= xs_send_kvec(sock
, NULL
, 0, &xdr
->tail
[0], base
, 0);
513 static void xs_nospace_callback(struct rpc_task
*task
)
515 struct sock_xprt
*transport
= container_of(task
->tk_rqstp
->rq_xprt
, struct sock_xprt
, xprt
);
517 transport
->inet
->sk_write_pending
--;
518 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
522 * xs_nospace - place task on wait queue if transmit was incomplete
523 * @task: task to put to sleep
526 static int xs_nospace(struct rpc_task
*task
)
528 struct rpc_rqst
*req
= task
->tk_rqstp
;
529 struct rpc_xprt
*xprt
= req
->rq_xprt
;
530 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
533 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
534 task
->tk_pid
, req
->rq_slen
- req
->rq_bytes_sent
,
537 /* Protect against races with write_space */
538 spin_lock_bh(&xprt
->transport_lock
);
540 /* Don't race with disconnect */
541 if (xprt_connected(xprt
)) {
542 if (test_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
)) {
545 * Notify TCP that we're limited by the application
548 set_bit(SOCK_NOSPACE
, &transport
->sock
->flags
);
549 transport
->inet
->sk_write_pending
++;
550 /* ...and wait for more buffer space */
551 xprt_wait_for_buffer_space(task
, xs_nospace_callback
);
554 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
558 spin_unlock_bh(&xprt
->transport_lock
);
563 * xs_udp_send_request - write an RPC request to a UDP socket
564 * @task: address of RPC task that manages the state of an RPC request
567 * 0: The request has been sent
568 * EAGAIN: The socket was blocked, please call again later to
569 * complete the request
570 * ENOTCONN: Caller needs to invoke connect logic then call again
571 * other: Some other error occured, the request was not sent
573 static int xs_udp_send_request(struct rpc_task
*task
)
575 struct rpc_rqst
*req
= task
->tk_rqstp
;
576 struct rpc_xprt
*xprt
= req
->rq_xprt
;
577 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
578 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
581 xs_pktdump("packet data:",
582 req
->rq_svec
->iov_base
,
583 req
->rq_svec
->iov_len
);
585 if (!xprt_bound(xprt
))
587 status
= xs_sendpages(transport
->sock
,
592 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
593 xdr
->len
- req
->rq_bytes_sent
, status
);
596 task
->tk_bytes_sent
+= status
;
597 if (status
>= req
->rq_slen
)
599 /* Still some bytes left; set up for a retry later. */
602 if (!transport
->sock
)
608 /* Should we call xs_close() here? */
611 status
= xs_nospace(task
);
614 dprintk("RPC: sendmsg returned unrecognized error %d\n",
619 /* When the server has died, an ICMP port unreachable message
620 * prompts ECONNREFUSED. */
621 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
628 * xs_tcp_shutdown - gracefully shut down a TCP socket
631 * Initiates a graceful shutdown of the TCP socket by calling the
632 * equivalent of shutdown(SHUT_WR);
634 static void xs_tcp_shutdown(struct rpc_xprt
*xprt
)
636 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
637 struct socket
*sock
= transport
->sock
;
640 kernel_sock_shutdown(sock
, SHUT_WR
);
643 static inline void xs_encode_tcp_record_marker(struct xdr_buf
*buf
)
645 u32 reclen
= buf
->len
- sizeof(rpc_fraghdr
);
646 rpc_fraghdr
*base
= buf
->head
[0].iov_base
;
647 *base
= htonl(RPC_LAST_STREAM_FRAGMENT
| reclen
);
651 * xs_tcp_send_request - write an RPC request to a TCP socket
652 * @task: address of RPC task that manages the state of an RPC request
655 * 0: The request has been sent
656 * EAGAIN: The socket was blocked, please call again later to
657 * complete the request
658 * ENOTCONN: Caller needs to invoke connect logic then call again
659 * other: Some other error occured, the request was not sent
661 * XXX: In the case of soft timeouts, should we eventually give up
662 * if sendmsg is not able to make progress?
664 static int xs_tcp_send_request(struct rpc_task
*task
)
666 struct rpc_rqst
*req
= task
->tk_rqstp
;
667 struct rpc_xprt
*xprt
= req
->rq_xprt
;
668 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
669 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
672 xs_encode_tcp_record_marker(&req
->rq_snd_buf
);
674 xs_pktdump("packet data:",
675 req
->rq_svec
->iov_base
,
676 req
->rq_svec
->iov_len
);
678 /* Continue transmitting the packet/record. We must be careful
679 * to cope with writespace callbacks arriving _after_ we have
680 * called sendmsg(). */
682 status
= xs_sendpages(transport
->sock
,
683 NULL
, 0, xdr
, req
->rq_bytes_sent
);
685 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
686 xdr
->len
- req
->rq_bytes_sent
, status
);
688 if (unlikely(status
< 0))
691 /* If we've sent the entire packet, immediately
692 * reset the count of bytes sent. */
693 req
->rq_bytes_sent
+= status
;
694 task
->tk_bytes_sent
+= status
;
695 if (likely(req
->rq_bytes_sent
>= req
->rq_slen
)) {
696 req
->rq_bytes_sent
= 0;
705 if (!transport
->sock
)
711 /* Should we call xs_close() here? */
714 status
= xs_nospace(task
);
717 dprintk("RPC: sendmsg returned unrecognized error %d\n",
720 xs_tcp_shutdown(xprt
);
724 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
731 * xs_tcp_release_xprt - clean up after a tcp transmission
735 * This cleans up if an error causes us to abort the transmission of a request.
736 * In this case, the socket may need to be reset in order to avoid confusing
739 static void xs_tcp_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
741 struct rpc_rqst
*req
;
743 if (task
!= xprt
->snd_task
)
747 req
= task
->tk_rqstp
;
748 if (req
->rq_bytes_sent
== 0)
750 if (req
->rq_bytes_sent
== req
->rq_snd_buf
.len
)
752 set_bit(XPRT_CLOSE_WAIT
, &task
->tk_xprt
->state
);
754 xprt_release_xprt(xprt
, task
);
757 static void xs_save_old_callbacks(struct sock_xprt
*transport
, struct sock
*sk
)
759 transport
->old_data_ready
= sk
->sk_data_ready
;
760 transport
->old_state_change
= sk
->sk_state_change
;
761 transport
->old_write_space
= sk
->sk_write_space
;
762 transport
->old_error_report
= sk
->sk_error_report
;
765 static void xs_restore_old_callbacks(struct sock_xprt
*transport
, struct sock
*sk
)
767 sk
->sk_data_ready
= transport
->old_data_ready
;
768 sk
->sk_state_change
= transport
->old_state_change
;
769 sk
->sk_write_space
= transport
->old_write_space
;
770 sk
->sk_error_report
= transport
->old_error_report
;
773 static void xs_reset_transport(struct sock_xprt
*transport
)
775 struct socket
*sock
= transport
->sock
;
776 struct sock
*sk
= transport
->inet
;
781 write_lock_bh(&sk
->sk_callback_lock
);
782 transport
->inet
= NULL
;
783 transport
->sock
= NULL
;
785 sk
->sk_user_data
= NULL
;
787 xs_restore_old_callbacks(transport
, sk
);
788 write_unlock_bh(&sk
->sk_callback_lock
);
796 * xs_close - close a socket
799 * This is used when all requests are complete; ie, no DRC state remains
800 * on the server we want to save.
802 static void xs_close(struct rpc_xprt
*xprt
)
804 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
806 dprintk("RPC: xs_close xprt %p\n", xprt
);
808 xs_reset_transport(transport
);
810 smp_mb__before_clear_bit();
811 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
812 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
813 clear_bit(XPRT_CLOSING
, &xprt
->state
);
814 smp_mb__after_clear_bit();
815 xprt_disconnect_done(xprt
);
819 * xs_destroy - prepare to shutdown a transport
820 * @xprt: doomed transport
823 static void xs_destroy(struct rpc_xprt
*xprt
)
825 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
827 dprintk("RPC: xs_destroy xprt %p\n", xprt
);
829 cancel_rearming_delayed_work(&transport
->connect_worker
);
832 xs_free_peer_addresses(xprt
);
835 module_put(THIS_MODULE
);
838 static inline struct rpc_xprt
*xprt_from_sock(struct sock
*sk
)
840 return (struct rpc_xprt
*) sk
->sk_user_data
;
844 * xs_udp_data_ready - "data ready" callback for UDP sockets
845 * @sk: socket with data to read
846 * @len: how much data to read
849 static void xs_udp_data_ready(struct sock
*sk
, int len
)
851 struct rpc_task
*task
;
852 struct rpc_xprt
*xprt
;
853 struct rpc_rqst
*rovr
;
855 int err
, repsize
, copied
;
859 read_lock(&sk
->sk_callback_lock
);
860 dprintk("RPC: xs_udp_data_ready...\n");
861 if (!(xprt
= xprt_from_sock(sk
)))
864 if ((skb
= skb_recv_datagram(sk
, 0, 1, &err
)) == NULL
)
870 repsize
= skb
->len
- sizeof(struct udphdr
);
872 dprintk("RPC: impossible RPC reply size %d!\n", repsize
);
876 /* Copy the XID from the skb... */
877 xp
= skb_header_pointer(skb
, sizeof(struct udphdr
),
878 sizeof(_xid
), &_xid
);
882 /* Look up and lock the request corresponding to the given XID */
883 spin_lock(&xprt
->transport_lock
);
884 rovr
= xprt_lookup_rqst(xprt
, *xp
);
887 task
= rovr
->rq_task
;
889 if ((copied
= rovr
->rq_private_buf
.buflen
) > repsize
)
892 /* Suck it into the iovec, verify checksum if not done by hw. */
893 if (csum_partial_copy_to_xdr(&rovr
->rq_private_buf
, skb
)) {
894 UDPX_INC_STATS_BH(sk
, UDP_MIB_INERRORS
);
898 UDPX_INC_STATS_BH(sk
, UDP_MIB_INDATAGRAMS
);
900 /* Something worked... */
901 dst_confirm(skb
->dst
);
903 xprt_adjust_cwnd(task
, copied
);
904 xprt_update_rtt(task
);
905 xprt_complete_rqst(task
, copied
);
908 spin_unlock(&xprt
->transport_lock
);
910 skb_free_datagram(sk
, skb
);
912 read_unlock(&sk
->sk_callback_lock
);
915 static inline void xs_tcp_read_fraghdr(struct rpc_xprt
*xprt
, struct xdr_skb_reader
*desc
)
917 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
921 p
= ((char *) &transport
->tcp_fraghdr
) + transport
->tcp_offset
;
922 len
= sizeof(transport
->tcp_fraghdr
) - transport
->tcp_offset
;
923 used
= xdr_skb_read_bits(desc
, p
, len
);
924 transport
->tcp_offset
+= used
;
928 transport
->tcp_reclen
= ntohl(transport
->tcp_fraghdr
);
929 if (transport
->tcp_reclen
& RPC_LAST_STREAM_FRAGMENT
)
930 transport
->tcp_flags
|= TCP_RCV_LAST_FRAG
;
932 transport
->tcp_flags
&= ~TCP_RCV_LAST_FRAG
;
933 transport
->tcp_reclen
&= RPC_FRAGMENT_SIZE_MASK
;
935 transport
->tcp_flags
&= ~TCP_RCV_COPY_FRAGHDR
;
936 transport
->tcp_offset
= 0;
938 /* Sanity check of the record length */
939 if (unlikely(transport
->tcp_reclen
< 4)) {
940 dprintk("RPC: invalid TCP record fragment length\n");
941 xprt_force_disconnect(xprt
);
944 dprintk("RPC: reading TCP record fragment of length %d\n",
945 transport
->tcp_reclen
);
948 static void xs_tcp_check_fraghdr(struct sock_xprt
*transport
)
950 if (transport
->tcp_offset
== transport
->tcp_reclen
) {
951 transport
->tcp_flags
|= TCP_RCV_COPY_FRAGHDR
;
952 transport
->tcp_offset
= 0;
953 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
) {
954 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
955 transport
->tcp_flags
|= TCP_RCV_COPY_XID
;
956 transport
->tcp_copied
= 0;
961 static inline void xs_tcp_read_xid(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
966 len
= sizeof(transport
->tcp_xid
) - transport
->tcp_offset
;
967 dprintk("RPC: reading XID (%Zu bytes)\n", len
);
968 p
= ((char *) &transport
->tcp_xid
) + transport
->tcp_offset
;
969 used
= xdr_skb_read_bits(desc
, p
, len
);
970 transport
->tcp_offset
+= used
;
973 transport
->tcp_flags
&= ~TCP_RCV_COPY_XID
;
974 transport
->tcp_flags
|= TCP_RCV_COPY_DATA
;
975 transport
->tcp_copied
= 4;
976 dprintk("RPC: reading reply for XID %08x\n",
977 ntohl(transport
->tcp_xid
));
978 xs_tcp_check_fraghdr(transport
);
981 static inline void xs_tcp_read_request(struct rpc_xprt
*xprt
, struct xdr_skb_reader
*desc
)
983 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
984 struct rpc_rqst
*req
;
985 struct xdr_buf
*rcvbuf
;
989 /* Find and lock the request corresponding to this xid */
990 spin_lock(&xprt
->transport_lock
);
991 req
= xprt_lookup_rqst(xprt
, transport
->tcp_xid
);
993 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
994 dprintk("RPC: XID %08x request not found!\n",
995 ntohl(transport
->tcp_xid
));
996 spin_unlock(&xprt
->transport_lock
);
1000 rcvbuf
= &req
->rq_private_buf
;
1002 if (len
> transport
->tcp_reclen
- transport
->tcp_offset
) {
1003 struct xdr_skb_reader my_desc
;
1005 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
1006 memcpy(&my_desc
, desc
, sizeof(my_desc
));
1007 my_desc
.count
= len
;
1008 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
1009 &my_desc
, xdr_skb_read_bits
);
1013 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
1014 desc
, xdr_skb_read_bits
);
1017 transport
->tcp_copied
+= r
;
1018 transport
->tcp_offset
+= r
;
1021 /* Error when copying to the receive buffer,
1022 * usually because we weren't able to allocate
1023 * additional buffer pages. All we can do now
1024 * is turn off TCP_RCV_COPY_DATA, so the request
1025 * will not receive any additional updates,
1027 * Any remaining data from this record will
1030 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1031 dprintk("RPC: XID %08x truncated request\n",
1032 ntohl(transport
->tcp_xid
));
1033 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1034 "tcp_offset = %u, tcp_reclen = %u\n",
1035 xprt
, transport
->tcp_copied
,
1036 transport
->tcp_offset
, transport
->tcp_reclen
);
1040 dprintk("RPC: XID %08x read %Zd bytes\n",
1041 ntohl(transport
->tcp_xid
), r
);
1042 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1043 "tcp_reclen = %u\n", xprt
, transport
->tcp_copied
,
1044 transport
->tcp_offset
, transport
->tcp_reclen
);
1046 if (transport
->tcp_copied
== req
->rq_private_buf
.buflen
)
1047 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1048 else if (transport
->tcp_offset
== transport
->tcp_reclen
) {
1049 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
)
1050 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1054 if (!(transport
->tcp_flags
& TCP_RCV_COPY_DATA
))
1055 xprt_complete_rqst(req
->rq_task
, transport
->tcp_copied
);
1056 spin_unlock(&xprt
->transport_lock
);
1057 xs_tcp_check_fraghdr(transport
);
1060 static inline void xs_tcp_read_discard(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
1064 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
1065 if (len
> desc
->count
)
1068 desc
->offset
+= len
;
1069 transport
->tcp_offset
+= len
;
1070 dprintk("RPC: discarded %Zu bytes\n", len
);
1071 xs_tcp_check_fraghdr(transport
);
1074 static int xs_tcp_data_recv(read_descriptor_t
*rd_desc
, struct sk_buff
*skb
, unsigned int offset
, size_t len
)
1076 struct rpc_xprt
*xprt
= rd_desc
->arg
.data
;
1077 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1078 struct xdr_skb_reader desc
= {
1084 dprintk("RPC: xs_tcp_data_recv started\n");
1086 /* Read in a new fragment marker if necessary */
1087 /* Can we ever really expect to get completely empty fragments? */
1088 if (transport
->tcp_flags
& TCP_RCV_COPY_FRAGHDR
) {
1089 xs_tcp_read_fraghdr(xprt
, &desc
);
1092 /* Read in the xid if necessary */
1093 if (transport
->tcp_flags
& TCP_RCV_COPY_XID
) {
1094 xs_tcp_read_xid(transport
, &desc
);
1097 /* Read in the request data */
1098 if (transport
->tcp_flags
& TCP_RCV_COPY_DATA
) {
1099 xs_tcp_read_request(xprt
, &desc
);
1102 /* Skip over any trailing bytes on short reads */
1103 xs_tcp_read_discard(transport
, &desc
);
1104 } while (desc
.count
);
1105 dprintk("RPC: xs_tcp_data_recv done\n");
1106 return len
- desc
.count
;
1110 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1111 * @sk: socket with data to read
1112 * @bytes: how much data to read
1115 static void xs_tcp_data_ready(struct sock
*sk
, int bytes
)
1117 struct rpc_xprt
*xprt
;
1118 read_descriptor_t rd_desc
;
1121 dprintk("RPC: xs_tcp_data_ready...\n");
1123 read_lock(&sk
->sk_callback_lock
);
1124 if (!(xprt
= xprt_from_sock(sk
)))
1129 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1130 rd_desc
.arg
.data
= xprt
;
1132 rd_desc
.count
= 65536;
1133 read
= tcp_read_sock(sk
, &rd_desc
, xs_tcp_data_recv
);
1136 read_unlock(&sk
->sk_callback_lock
);
1140 * Do the equivalent of linger/linger2 handling for dealing with
1141 * broken servers that don't close the socket in a timely
1144 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt
*xprt
,
1145 unsigned long timeout
)
1147 struct sock_xprt
*transport
;
1149 if (xprt_test_and_set_connecting(xprt
))
1151 set_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
1152 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1153 queue_delayed_work(rpciod_workqueue
, &transport
->connect_worker
,
1157 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt
*xprt
)
1159 struct sock_xprt
*transport
;
1161 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1163 if (!test_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
) ||
1164 !cancel_delayed_work(&transport
->connect_worker
))
1166 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
1167 xprt_clear_connecting(xprt
);
1170 static void xs_sock_mark_closed(struct rpc_xprt
*xprt
)
1172 smp_mb__before_clear_bit();
1173 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
1174 clear_bit(XPRT_CLOSING
, &xprt
->state
);
1175 smp_mb__after_clear_bit();
1176 /* Mark transport as closed and wake up all pending tasks */
1177 xprt_disconnect_done(xprt
);
1181 * xs_tcp_state_change - callback to handle TCP socket state changes
1182 * @sk: socket whose state has changed
1185 static void xs_tcp_state_change(struct sock
*sk
)
1187 struct rpc_xprt
*xprt
;
1189 read_lock(&sk
->sk_callback_lock
);
1190 if (!(xprt
= xprt_from_sock(sk
)))
1192 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt
);
1193 dprintk("RPC: state %x conn %d dead %d zapped %d\n",
1194 sk
->sk_state
, xprt_connected(xprt
),
1195 sock_flag(sk
, SOCK_DEAD
),
1196 sock_flag(sk
, SOCK_ZAPPED
));
1198 switch (sk
->sk_state
) {
1199 case TCP_ESTABLISHED
:
1200 spin_lock_bh(&xprt
->transport_lock
);
1201 if (!xprt_test_and_set_connected(xprt
)) {
1202 struct sock_xprt
*transport
= container_of(xprt
,
1203 struct sock_xprt
, xprt
);
1205 /* Reset TCP record info */
1206 transport
->tcp_offset
= 0;
1207 transport
->tcp_reclen
= 0;
1208 transport
->tcp_copied
= 0;
1209 transport
->tcp_flags
=
1210 TCP_RCV_COPY_FRAGHDR
| TCP_RCV_COPY_XID
;
1212 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
1214 spin_unlock_bh(&xprt
->transport_lock
);
1217 /* The client initiated a shutdown of the socket */
1218 xprt
->connect_cookie
++;
1219 xprt
->reestablish_timeout
= 0;
1220 set_bit(XPRT_CLOSING
, &xprt
->state
);
1221 smp_mb__before_clear_bit();
1222 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1223 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
1224 smp_mb__after_clear_bit();
1225 xs_tcp_schedule_linger_timeout(xprt
, XS_TCP_LINGER_TO
);
1227 case TCP_CLOSE_WAIT
:
1228 /* The server initiated a shutdown of the socket */
1229 xprt_force_disconnect(xprt
);
1231 xprt
->connect_cookie
++;
1234 * If the server closed down the connection, make sure that
1235 * we back off before reconnecting
1237 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
1238 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
1241 set_bit(XPRT_CLOSING
, &xprt
->state
);
1242 xs_tcp_schedule_linger_timeout(xprt
, XS_TCP_LINGER_TO
);
1243 smp_mb__before_clear_bit();
1244 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1245 smp_mb__after_clear_bit();
1248 xs_tcp_cancel_linger_timeout(xprt
);
1249 xs_sock_mark_closed(xprt
);
1252 read_unlock(&sk
->sk_callback_lock
);
1256 * xs_error_report - callback mainly for catching socket errors
1259 static void xs_error_report(struct sock
*sk
)
1261 struct rpc_xprt
*xprt
;
1263 read_lock(&sk
->sk_callback_lock
);
1264 if (!(xprt
= xprt_from_sock(sk
)))
1266 dprintk("RPC: %s client %p...\n"
1268 __func__
, xprt
, sk
->sk_err
);
1269 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
1271 read_unlock(&sk
->sk_callback_lock
);
1275 * xs_udp_write_space - callback invoked when socket buffer space
1277 * @sk: socket whose state has changed
1279 * Called when more output buffer space is available for this socket.
1280 * We try not to wake our writers until they can make "significant"
1281 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1282 * with a bunch of small requests.
1284 static void xs_udp_write_space(struct sock
*sk
)
1286 read_lock(&sk
->sk_callback_lock
);
1288 /* from net/core/sock.c:sock_def_write_space */
1289 if (sock_writeable(sk
)) {
1290 struct socket
*sock
;
1291 struct rpc_xprt
*xprt
;
1293 if (unlikely(!(sock
= sk
->sk_socket
)))
1295 clear_bit(SOCK_NOSPACE
, &sock
->flags
);
1297 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
1299 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
) == 0)
1302 xprt_write_space(xprt
);
1306 read_unlock(&sk
->sk_callback_lock
);
1310 * xs_tcp_write_space - callback invoked when socket buffer space
1312 * @sk: socket whose state has changed
1314 * Called when more output buffer space is available for this socket.
1315 * We try not to wake our writers until they can make "significant"
1316 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1317 * with a bunch of small requests.
1319 static void xs_tcp_write_space(struct sock
*sk
)
1321 read_lock(&sk
->sk_callback_lock
);
1323 /* from net/core/stream.c:sk_stream_write_space */
1324 if (sk_stream_wspace(sk
) >= sk_stream_min_wspace(sk
)) {
1325 struct socket
*sock
;
1326 struct rpc_xprt
*xprt
;
1328 if (unlikely(!(sock
= sk
->sk_socket
)))
1330 clear_bit(SOCK_NOSPACE
, &sock
->flags
);
1332 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
1334 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
) == 0)
1337 xprt_write_space(xprt
);
1341 read_unlock(&sk
->sk_callback_lock
);
1344 static void xs_udp_do_set_buffer_size(struct rpc_xprt
*xprt
)
1346 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1347 struct sock
*sk
= transport
->inet
;
1349 if (transport
->rcvsize
) {
1350 sk
->sk_userlocks
|= SOCK_RCVBUF_LOCK
;
1351 sk
->sk_rcvbuf
= transport
->rcvsize
* xprt
->max_reqs
* 2;
1353 if (transport
->sndsize
) {
1354 sk
->sk_userlocks
|= SOCK_SNDBUF_LOCK
;
1355 sk
->sk_sndbuf
= transport
->sndsize
* xprt
->max_reqs
* 2;
1356 sk
->sk_write_space(sk
);
1361 * xs_udp_set_buffer_size - set send and receive limits
1362 * @xprt: generic transport
1363 * @sndsize: requested size of send buffer, in bytes
1364 * @rcvsize: requested size of receive buffer, in bytes
1366 * Set socket send and receive buffer size limits.
1368 static void xs_udp_set_buffer_size(struct rpc_xprt
*xprt
, size_t sndsize
, size_t rcvsize
)
1370 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1372 transport
->sndsize
= 0;
1374 transport
->sndsize
= sndsize
+ 1024;
1375 transport
->rcvsize
= 0;
1377 transport
->rcvsize
= rcvsize
+ 1024;
1379 xs_udp_do_set_buffer_size(xprt
);
1383 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1384 * @task: task that timed out
1386 * Adjust the congestion window after a retransmit timeout has occurred.
1388 static void xs_udp_timer(struct rpc_task
*task
)
1390 xprt_adjust_cwnd(task
, -ETIMEDOUT
);
1393 static unsigned short xs_get_random_port(void)
1395 unsigned short range
= xprt_max_resvport
- xprt_min_resvport
;
1396 unsigned short rand
= (unsigned short) net_random() % range
;
1397 return rand
+ xprt_min_resvport
;
1401 * xs_set_port - reset the port number in the remote endpoint address
1402 * @xprt: generic transport
1403 * @port: new port number
1406 static void xs_set_port(struct rpc_xprt
*xprt
, unsigned short port
)
1408 struct sockaddr
*addr
= xs_addr(xprt
);
1410 dprintk("RPC: setting port for xprt %p to %u\n", xprt
, port
);
1412 switch (addr
->sa_family
) {
1414 ((struct sockaddr_in
*)addr
)->sin_port
= htons(port
);
1417 ((struct sockaddr_in6
*)addr
)->sin6_port
= htons(port
);
1424 static unsigned short xs_get_srcport(struct sock_xprt
*transport
, struct socket
*sock
)
1426 unsigned short port
= transport
->port
;
1428 if (port
== 0 && transport
->xprt
.resvport
)
1429 port
= xs_get_random_port();
1433 static unsigned short xs_next_srcport(struct sock_xprt
*transport
, struct socket
*sock
, unsigned short port
)
1435 if (transport
->port
!= 0)
1436 transport
->port
= 0;
1437 if (!transport
->xprt
.resvport
)
1439 if (port
<= xprt_min_resvport
|| port
> xprt_max_resvport
)
1440 return xprt_max_resvport
;
1444 static int xs_bind4(struct sock_xprt
*transport
, struct socket
*sock
)
1446 struct sockaddr_in myaddr
= {
1447 .sin_family
= AF_INET
,
1449 struct sockaddr_in
*sa
;
1451 unsigned short port
= xs_get_srcport(transport
, sock
);
1452 unsigned short last
;
1454 sa
= (struct sockaddr_in
*)&transport
->addr
;
1455 myaddr
.sin_addr
= sa
->sin_addr
;
1457 myaddr
.sin_port
= htons(port
);
1458 err
= kernel_bind(sock
, (struct sockaddr
*) &myaddr
,
1463 transport
->port
= port
;
1467 port
= xs_next_srcport(transport
, sock
, port
);
1470 } while (err
== -EADDRINUSE
&& nloop
!= 2);
1471 dprintk("RPC: %s %pI4:%u: %s (%d)\n",
1472 __func__
, &myaddr
.sin_addr
,
1473 port
, err
? "failed" : "ok", err
);
1477 static int xs_bind6(struct sock_xprt
*transport
, struct socket
*sock
)
1479 struct sockaddr_in6 myaddr
= {
1480 .sin6_family
= AF_INET6
,
1482 struct sockaddr_in6
*sa
;
1484 unsigned short port
= xs_get_srcport(transport
, sock
);
1485 unsigned short last
;
1487 sa
= (struct sockaddr_in6
*)&transport
->addr
;
1488 myaddr
.sin6_addr
= sa
->sin6_addr
;
1490 myaddr
.sin6_port
= htons(port
);
1491 err
= kernel_bind(sock
, (struct sockaddr
*) &myaddr
,
1496 transport
->port
= port
;
1500 port
= xs_next_srcport(transport
, sock
, port
);
1503 } while (err
== -EADDRINUSE
&& nloop
!= 2);
1504 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1505 &myaddr
.sin6_addr
, port
, err
? "failed" : "ok", err
);
1509 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1510 static struct lock_class_key xs_key
[2];
1511 static struct lock_class_key xs_slock_key
[2];
1513 static inline void xs_reclassify_socket4(struct socket
*sock
)
1515 struct sock
*sk
= sock
->sk
;
1517 BUG_ON(sock_owned_by_user(sk
));
1518 sock_lock_init_class_and_name(sk
, "slock-AF_INET-RPC",
1519 &xs_slock_key
[0], "sk_lock-AF_INET-RPC", &xs_key
[0]);
1522 static inline void xs_reclassify_socket6(struct socket
*sock
)
1524 struct sock
*sk
= sock
->sk
;
1526 BUG_ON(sock_owned_by_user(sk
));
1527 sock_lock_init_class_and_name(sk
, "slock-AF_INET6-RPC",
1528 &xs_slock_key
[1], "sk_lock-AF_INET6-RPC", &xs_key
[1]);
1531 static inline void xs_reclassify_socket4(struct socket
*sock
)
1535 static inline void xs_reclassify_socket6(struct socket
*sock
)
1540 static void xs_udp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
1542 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1544 if (!transport
->inet
) {
1545 struct sock
*sk
= sock
->sk
;
1547 write_lock_bh(&sk
->sk_callback_lock
);
1549 xs_save_old_callbacks(transport
, sk
);
1551 sk
->sk_user_data
= xprt
;
1552 sk
->sk_data_ready
= xs_udp_data_ready
;
1553 sk
->sk_write_space
= xs_udp_write_space
;
1554 sk
->sk_error_report
= xs_error_report
;
1555 sk
->sk_no_check
= UDP_CSUM_NORCV
;
1556 sk
->sk_allocation
= GFP_ATOMIC
;
1558 xprt_set_connected(xprt
);
1560 /* Reset to new socket */
1561 transport
->sock
= sock
;
1562 transport
->inet
= sk
;
1564 write_unlock_bh(&sk
->sk_callback_lock
);
1566 xs_udp_do_set_buffer_size(xprt
);
1570 * xs_udp_connect_worker4 - set up a UDP socket
1571 * @work: RPC transport to connect
1573 * Invoked by a work queue tasklet.
1575 static void xs_udp_connect_worker4(struct work_struct
*work
)
1577 struct sock_xprt
*transport
=
1578 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1579 struct rpc_xprt
*xprt
= &transport
->xprt
;
1580 struct socket
*sock
= transport
->sock
;
1581 int err
, status
= -EIO
;
1586 /* Start by resetting any existing state */
1587 xs_reset_transport(transport
);
1589 err
= sock_create_kern(PF_INET
, SOCK_DGRAM
, IPPROTO_UDP
, &sock
);
1591 dprintk("RPC: can't create UDP transport socket (%d).\n", -err
);
1594 xs_reclassify_socket4(sock
);
1596 if (xs_bind4(transport
, sock
)) {
1601 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1602 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1604 xs_udp_finish_connecting(xprt
, sock
);
1607 xprt_clear_connecting(xprt
);
1608 xprt_wake_pending_tasks(xprt
, status
);
1612 * xs_udp_connect_worker6 - set up a UDP socket
1613 * @work: RPC transport to connect
1615 * Invoked by a work queue tasklet.
1617 static void xs_udp_connect_worker6(struct work_struct
*work
)
1619 struct sock_xprt
*transport
=
1620 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1621 struct rpc_xprt
*xprt
= &transport
->xprt
;
1622 struct socket
*sock
= transport
->sock
;
1623 int err
, status
= -EIO
;
1628 /* Start by resetting any existing state */
1629 xs_reset_transport(transport
);
1631 err
= sock_create_kern(PF_INET6
, SOCK_DGRAM
, IPPROTO_UDP
, &sock
);
1633 dprintk("RPC: can't create UDP transport socket (%d).\n", -err
);
1636 xs_reclassify_socket6(sock
);
1638 if (xs_bind6(transport
, sock
) < 0) {
1643 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1644 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1646 xs_udp_finish_connecting(xprt
, sock
);
1649 xprt_clear_connecting(xprt
);
1650 xprt_wake_pending_tasks(xprt
, status
);
1654 * We need to preserve the port number so the reply cache on the server can
1655 * find our cached RPC replies when we get around to reconnecting.
1657 static void xs_abort_connection(struct rpc_xprt
*xprt
, struct sock_xprt
*transport
)
1660 struct sockaddr any
;
1662 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt
);
1665 * Disconnect the transport socket by doing a connect operation
1666 * with AF_UNSPEC. This should return immediately...
1668 memset(&any
, 0, sizeof(any
));
1669 any
.sa_family
= AF_UNSPEC
;
1670 result
= kernel_connect(transport
->sock
, &any
, sizeof(any
), 0);
1672 xs_sock_mark_closed(xprt
);
1674 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1678 static void xs_tcp_reuse_connection(struct rpc_xprt
*xprt
, struct sock_xprt
*transport
)
1680 unsigned int state
= transport
->inet
->sk_state
;
1682 if (state
== TCP_CLOSE
&& transport
->sock
->state
== SS_UNCONNECTED
)
1684 if ((1 << state
) & (TCPF_ESTABLISHED
|TCPF_SYN_SENT
))
1686 xs_abort_connection(xprt
, transport
);
1689 static int xs_tcp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
1691 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1693 if (!transport
->inet
) {
1694 struct sock
*sk
= sock
->sk
;
1696 write_lock_bh(&sk
->sk_callback_lock
);
1698 xs_save_old_callbacks(transport
, sk
);
1700 sk
->sk_user_data
= xprt
;
1701 sk
->sk_data_ready
= xs_tcp_data_ready
;
1702 sk
->sk_state_change
= xs_tcp_state_change
;
1703 sk
->sk_write_space
= xs_tcp_write_space
;
1704 sk
->sk_error_report
= xs_error_report
;
1705 sk
->sk_allocation
= GFP_ATOMIC
;
1707 /* socket options */
1708 sk
->sk_userlocks
|= SOCK_BINDPORT_LOCK
;
1709 sock_reset_flag(sk
, SOCK_LINGER
);
1710 tcp_sk(sk
)->linger2
= 0;
1711 tcp_sk(sk
)->nonagle
|= TCP_NAGLE_OFF
;
1713 xprt_clear_connected(xprt
);
1715 /* Reset to new socket */
1716 transport
->sock
= sock
;
1717 transport
->inet
= sk
;
1719 write_unlock_bh(&sk
->sk_callback_lock
);
1722 if (!xprt_bound(xprt
))
1725 /* Tell the socket layer to start connecting... */
1726 xprt
->stat
.connect_count
++;
1727 xprt
->stat
.connect_start
= jiffies
;
1728 return kernel_connect(sock
, xs_addr(xprt
), xprt
->addrlen
, O_NONBLOCK
);
1732 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1733 * @work: RPC transport to connect
1735 * Invoked by a work queue tasklet.
1737 static void xs_tcp_connect_worker4(struct work_struct
*work
)
1739 struct sock_xprt
*transport
=
1740 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1741 struct rpc_xprt
*xprt
= &transport
->xprt
;
1742 struct socket
*sock
= transport
->sock
;
1743 int err
, status
= -EIO
;
1749 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
1750 /* start from scratch */
1751 if ((err
= sock_create_kern(PF_INET
, SOCK_STREAM
, IPPROTO_TCP
, &sock
)) < 0) {
1752 dprintk("RPC: can't create TCP transport socket (%d).\n", -err
);
1755 xs_reclassify_socket4(sock
);
1757 if (xs_bind4(transport
, sock
) < 0) {
1764 abort_and_exit
= test_and_clear_bit(XPRT_CONNECTION_ABORT
,
1766 /* "close" the socket, preserving the local port */
1767 xs_tcp_reuse_connection(xprt
, transport
);
1773 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1774 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1776 status
= xs_tcp_finish_connecting(xprt
, sock
);
1777 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1778 xprt
, -status
, xprt_connected(xprt
),
1779 sock
->sk
->sk_state
);
1784 /* retry with existing socket, after a delay */
1788 xprt_clear_connecting(xprt
);
1791 /* get rid of existing socket, and retry */
1792 xs_tcp_shutdown(xprt
);
1793 printk("%s: connect returned unhandled error %d\n",
1798 xprt_clear_connecting(xprt
);
1799 xprt_wake_pending_tasks(xprt
, status
);
1803 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
1804 * @work: RPC transport to connect
1806 * Invoked by a work queue tasklet.
1808 static void xs_tcp_connect_worker6(struct work_struct
*work
)
1810 struct sock_xprt
*transport
=
1811 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1812 struct rpc_xprt
*xprt
= &transport
->xprt
;
1813 struct socket
*sock
= transport
->sock
;
1814 int err
, status
= -EIO
;
1820 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
1821 /* start from scratch */
1822 if ((err
= sock_create_kern(PF_INET6
, SOCK_STREAM
, IPPROTO_TCP
, &sock
)) < 0) {
1823 dprintk("RPC: can't create TCP transport socket (%d).\n", -err
);
1826 xs_reclassify_socket6(sock
);
1828 if (xs_bind6(transport
, sock
) < 0) {
1835 abort_and_exit
= test_and_clear_bit(XPRT_CONNECTION_ABORT
,
1837 /* "close" the socket, preserving the local port */
1838 xs_tcp_reuse_connection(xprt
, transport
);
1844 dprintk("RPC: worker connecting xprt %p to address: %s\n",
1845 xprt
, xprt
->address_strings
[RPC_DISPLAY_ALL
]);
1847 status
= xs_tcp_finish_connecting(xprt
, sock
);
1848 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1849 xprt
, -status
, xprt_connected(xprt
), sock
->sk
->sk_state
);
1854 /* retry with existing socket, after a delay */
1858 xprt_clear_connecting(xprt
);
1861 /* get rid of existing socket, and retry */
1862 xs_tcp_shutdown(xprt
);
1863 printk("%s: connect returned unhandled error %d\n",
1868 xprt_clear_connecting(xprt
);
1869 xprt_wake_pending_tasks(xprt
, status
);
1873 * xs_connect - connect a socket to a remote endpoint
1874 * @task: address of RPC task that manages state of connect request
1876 * TCP: If the remote end dropped the connection, delay reconnecting.
1878 * UDP socket connects are synchronous, but we use a work queue anyway
1879 * to guarantee that even unprivileged user processes can set up a
1880 * socket on a privileged port.
1882 * If a UDP socket connect fails, the delay behavior here prevents
1883 * retry floods (hard mounts).
1885 static void xs_connect(struct rpc_task
*task
)
1887 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1888 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1890 if (xprt_test_and_set_connecting(xprt
))
1893 if (transport
->sock
!= NULL
) {
1894 dprintk("RPC: xs_connect delayed xprt %p for %lu "
1896 xprt
, xprt
->reestablish_timeout
/ HZ
);
1897 queue_delayed_work(rpciod_workqueue
,
1898 &transport
->connect_worker
,
1899 xprt
->reestablish_timeout
);
1900 xprt
->reestablish_timeout
<<= 1;
1901 if (xprt
->reestablish_timeout
> XS_TCP_MAX_REEST_TO
)
1902 xprt
->reestablish_timeout
= XS_TCP_MAX_REEST_TO
;
1904 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt
);
1905 queue_delayed_work(rpciod_workqueue
,
1906 &transport
->connect_worker
, 0);
1910 static void xs_tcp_connect(struct rpc_task
*task
)
1912 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1914 /* Exit if we need to wait for socket shutdown to complete */
1915 if (test_bit(XPRT_CLOSING
, &xprt
->state
))
1921 * xs_udp_print_stats - display UDP socket-specifc stats
1922 * @xprt: rpc_xprt struct containing statistics
1926 static void xs_udp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
1928 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1930 seq_printf(seq
, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
1932 xprt
->stat
.bind_count
,
1935 xprt
->stat
.bad_xids
,
1937 xprt
->stat
.bklog_u
);
1941 * xs_tcp_print_stats - display TCP socket-specifc stats
1942 * @xprt: rpc_xprt struct containing statistics
1946 static void xs_tcp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
1948 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1951 if (xprt_connected(xprt
))
1952 idle_time
= (long)(jiffies
- xprt
->last_used
) / HZ
;
1954 seq_printf(seq
, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
1956 xprt
->stat
.bind_count
,
1957 xprt
->stat
.connect_count
,
1958 xprt
->stat
.connect_time
,
1962 xprt
->stat
.bad_xids
,
1964 xprt
->stat
.bklog_u
);
1967 static struct rpc_xprt_ops xs_udp_ops
= {
1968 .set_buffer_size
= xs_udp_set_buffer_size
,
1969 .reserve_xprt
= xprt_reserve_xprt_cong
,
1970 .release_xprt
= xprt_release_xprt_cong
,
1971 .rpcbind
= rpcb_getport_async
,
1972 .set_port
= xs_set_port
,
1973 .connect
= xs_connect
,
1974 .buf_alloc
= rpc_malloc
,
1975 .buf_free
= rpc_free
,
1976 .send_request
= xs_udp_send_request
,
1977 .set_retrans_timeout
= xprt_set_retrans_timeout_rtt
,
1978 .timer
= xs_udp_timer
,
1979 .release_request
= xprt_release_rqst_cong
,
1981 .destroy
= xs_destroy
,
1982 .print_stats
= xs_udp_print_stats
,
1985 static struct rpc_xprt_ops xs_tcp_ops
= {
1986 .reserve_xprt
= xprt_reserve_xprt
,
1987 .release_xprt
= xs_tcp_release_xprt
,
1988 .rpcbind
= rpcb_getport_async
,
1989 .set_port
= xs_set_port
,
1990 .connect
= xs_tcp_connect
,
1991 .buf_alloc
= rpc_malloc
,
1992 .buf_free
= rpc_free
,
1993 .send_request
= xs_tcp_send_request
,
1994 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
1995 .close
= xs_tcp_shutdown
,
1996 .destroy
= xs_destroy
,
1997 .print_stats
= xs_tcp_print_stats
,
2000 static struct rpc_xprt
*xs_setup_xprt(struct xprt_create
*args
,
2001 unsigned int slot_table_size
)
2003 struct rpc_xprt
*xprt
;
2004 struct sock_xprt
*new;
2006 if (args
->addrlen
> sizeof(xprt
->addr
)) {
2007 dprintk("RPC: xs_setup_xprt: address too large\n");
2008 return ERR_PTR(-EBADF
);
2011 new = kzalloc(sizeof(*new), GFP_KERNEL
);
2013 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2015 return ERR_PTR(-ENOMEM
);
2019 xprt
->max_reqs
= slot_table_size
;
2020 xprt
->slot
= kcalloc(xprt
->max_reqs
, sizeof(struct rpc_rqst
), GFP_KERNEL
);
2021 if (xprt
->slot
== NULL
) {
2023 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
2025 return ERR_PTR(-ENOMEM
);
2028 memcpy(&xprt
->addr
, args
->dstaddr
, args
->addrlen
);
2029 xprt
->addrlen
= args
->addrlen
;
2031 memcpy(&new->addr
, args
->srcaddr
, args
->addrlen
);
2036 static const struct rpc_timeout xs_udp_default_timeout
= {
2037 .to_initval
= 5 * HZ
,
2038 .to_maxval
= 30 * HZ
,
2039 .to_increment
= 5 * HZ
,
2044 * xs_setup_udp - Set up transport to use a UDP socket
2045 * @args: rpc transport creation arguments
2048 static struct rpc_xprt
*xs_setup_udp(struct xprt_create
*args
)
2050 struct sockaddr
*addr
= args
->dstaddr
;
2051 struct rpc_xprt
*xprt
;
2052 struct sock_xprt
*transport
;
2054 xprt
= xs_setup_xprt(args
, xprt_udp_slot_table_entries
);
2057 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2059 xprt
->prot
= IPPROTO_UDP
;
2061 /* XXX: header size can vary due to auth type, IPv6, etc. */
2062 xprt
->max_payload
= (1U << 16) - (MAX_HEADER
<< 3);
2064 xprt
->bind_timeout
= XS_BIND_TO
;
2065 xprt
->connect_timeout
= XS_UDP_CONN_TO
;
2066 xprt
->reestablish_timeout
= XS_UDP_REEST_TO
;
2067 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2069 xprt
->ops
= &xs_udp_ops
;
2071 xprt
->timeout
= &xs_udp_default_timeout
;
2073 switch (addr
->sa_family
) {
2075 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
2076 xprt_set_bound(xprt
);
2078 INIT_DELAYED_WORK(&transport
->connect_worker
,
2079 xs_udp_connect_worker4
);
2080 xs_format_ipv4_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP
);
2083 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
2084 xprt_set_bound(xprt
);
2086 INIT_DELAYED_WORK(&transport
->connect_worker
,
2087 xs_udp_connect_worker6
);
2088 xs_format_ipv6_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP6
);
2092 return ERR_PTR(-EAFNOSUPPORT
);
2095 dprintk("RPC: set up transport to address %s\n",
2096 xprt
->address_strings
[RPC_DISPLAY_ALL
]);
2098 if (try_module_get(THIS_MODULE
))
2103 return ERR_PTR(-EINVAL
);
2106 static const struct rpc_timeout xs_tcp_default_timeout
= {
2107 .to_initval
= 60 * HZ
,
2108 .to_maxval
= 60 * HZ
,
2113 * xs_setup_tcp - Set up transport to use a TCP socket
2114 * @args: rpc transport creation arguments
2117 static struct rpc_xprt
*xs_setup_tcp(struct xprt_create
*args
)
2119 struct sockaddr
*addr
= args
->dstaddr
;
2120 struct rpc_xprt
*xprt
;
2121 struct sock_xprt
*transport
;
2123 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
);
2126 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2128 xprt
->prot
= IPPROTO_TCP
;
2129 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
2130 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
2132 xprt
->bind_timeout
= XS_BIND_TO
;
2133 xprt
->connect_timeout
= XS_TCP_CONN_TO
;
2134 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2135 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2137 xprt
->ops
= &xs_tcp_ops
;
2138 xprt
->timeout
= &xs_tcp_default_timeout
;
2140 switch (addr
->sa_family
) {
2142 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
2143 xprt_set_bound(xprt
);
2145 INIT_DELAYED_WORK(&transport
->connect_worker
, xs_tcp_connect_worker4
);
2146 xs_format_ipv4_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP
);
2149 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
2150 xprt_set_bound(xprt
);
2152 INIT_DELAYED_WORK(&transport
->connect_worker
, xs_tcp_connect_worker6
);
2153 xs_format_ipv6_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP6
);
2157 return ERR_PTR(-EAFNOSUPPORT
);
2160 dprintk("RPC: set up transport to address %s\n",
2161 xprt
->address_strings
[RPC_DISPLAY_ALL
]);
2163 if (try_module_get(THIS_MODULE
))
2168 return ERR_PTR(-EINVAL
);
2171 static struct xprt_class xs_udp_transport
= {
2172 .list
= LIST_HEAD_INIT(xs_udp_transport
.list
),
2174 .owner
= THIS_MODULE
,
2175 .ident
= IPPROTO_UDP
,
2176 .setup
= xs_setup_udp
,
2179 static struct xprt_class xs_tcp_transport
= {
2180 .list
= LIST_HEAD_INIT(xs_tcp_transport
.list
),
2182 .owner
= THIS_MODULE
,
2183 .ident
= IPPROTO_TCP
,
2184 .setup
= xs_setup_tcp
,
2188 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2191 int init_socket_xprt(void)
2194 if (!sunrpc_table_header
)
2195 sunrpc_table_header
= register_sysctl_table(sunrpc_table
);
2198 xprt_register_transport(&xs_udp_transport
);
2199 xprt_register_transport(&xs_tcp_transport
);
2205 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2208 void cleanup_socket_xprt(void)
2211 if (sunrpc_table_header
) {
2212 unregister_sysctl_table(sunrpc_table_header
);
2213 sunrpc_table_header
= NULL
;
2217 xprt_unregister_transport(&xs_udp_transport
);
2218 xprt_unregister_transport(&xs_tcp_transport
);