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/string.h>
23 #include <linux/slab.h>
24 #include <linux/module.h>
25 #include <linux/capability.h>
26 #include <linux/pagemap.h>
27 #include <linux/errno.h>
28 #include <linux/socket.h>
30 #include <linux/net.h>
33 #include <linux/udp.h>
34 #include <linux/tcp.h>
35 #include <linux/sunrpc/clnt.h>
36 #include <linux/sunrpc/sched.h>
37 #include <linux/sunrpc/svcsock.h>
38 #include <linux/sunrpc/xprtsock.h>
39 #include <linux/file.h>
40 #ifdef CONFIG_NFS_V4_1
41 #include <linux/sunrpc/bc_xprt.h>
45 #include <net/checksum.h>
51 static void xs_close(struct rpc_xprt
*xprt
);
56 unsigned int xprt_udp_slot_table_entries
= RPC_DEF_SLOT_TABLE
;
57 unsigned int xprt_tcp_slot_table_entries
= RPC_DEF_SLOT_TABLE
;
59 unsigned int xprt_min_resvport
= RPC_DEF_MIN_RESVPORT
;
60 unsigned int xprt_max_resvport
= RPC_DEF_MAX_RESVPORT
;
62 #define XS_TCP_LINGER_TO (15U * HZ)
63 static unsigned int xs_tcp_fin_timeout __read_mostly
= XS_TCP_LINGER_TO
;
66 * We can register our own files under /proc/sys/sunrpc by
67 * calling register_sysctl_table() again. The files in that
68 * directory become the union of all files registered there.
70 * We simply need to make sure that we don't collide with
71 * someone else's file names!
76 static unsigned int min_slot_table_size
= RPC_MIN_SLOT_TABLE
;
77 static unsigned int max_slot_table_size
= RPC_MAX_SLOT_TABLE
;
78 static unsigned int xprt_min_resvport_limit
= RPC_MIN_RESVPORT
;
79 static unsigned int xprt_max_resvport_limit
= RPC_MAX_RESVPORT
;
81 static struct ctl_table_header
*sunrpc_table_header
;
84 * FIXME: changing the UDP slot table size should also resize the UDP
85 * socket buffers for existing UDP transports
87 static ctl_table xs_tunables_table
[] = {
89 .procname
= "udp_slot_table_entries",
90 .data
= &xprt_udp_slot_table_entries
,
91 .maxlen
= sizeof(unsigned int),
93 .proc_handler
= proc_dointvec_minmax
,
94 .extra1
= &min_slot_table_size
,
95 .extra2
= &max_slot_table_size
98 .procname
= "tcp_slot_table_entries",
99 .data
= &xprt_tcp_slot_table_entries
,
100 .maxlen
= sizeof(unsigned int),
102 .proc_handler
= proc_dointvec_minmax
,
103 .extra1
= &min_slot_table_size
,
104 .extra2
= &max_slot_table_size
107 .procname
= "min_resvport",
108 .data
= &xprt_min_resvport
,
109 .maxlen
= sizeof(unsigned int),
111 .proc_handler
= proc_dointvec_minmax
,
112 .extra1
= &xprt_min_resvport_limit
,
113 .extra2
= &xprt_max_resvport_limit
116 .procname
= "max_resvport",
117 .data
= &xprt_max_resvport
,
118 .maxlen
= sizeof(unsigned int),
120 .proc_handler
= proc_dointvec_minmax
,
121 .extra1
= &xprt_min_resvport_limit
,
122 .extra2
= &xprt_max_resvport_limit
125 .procname
= "tcp_fin_timeout",
126 .data
= &xs_tcp_fin_timeout
,
127 .maxlen
= sizeof(xs_tcp_fin_timeout
),
129 .proc_handler
= proc_dointvec_jiffies
,
134 static ctl_table sunrpc_table
[] = {
136 .procname
= "sunrpc",
138 .child
= xs_tunables_table
146 * Wait duration for a reply from the RPC portmapper.
148 #define XS_BIND_TO (60U * HZ)
151 * Delay if a UDP socket connect error occurs. This is most likely some
152 * kind of resource problem on the local host.
154 #define XS_UDP_REEST_TO (2U * HZ)
157 * The reestablish timeout allows clients to delay for a bit before attempting
158 * to reconnect to a server that just dropped our connection.
160 * We implement an exponential backoff when trying to reestablish a TCP
161 * transport connection with the server. Some servers like to drop a TCP
162 * connection when they are overworked, so we start with a short timeout and
163 * increase over time if the server is down or not responding.
165 #define XS_TCP_INIT_REEST_TO (3U * HZ)
166 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
169 * TCP idle timeout; client drops the transport socket if it is idle
170 * for this long. Note that we also timeout UDP sockets to prevent
171 * holding port numbers when there is no RPC traffic.
173 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
176 # undef RPC_DEBUG_DATA
177 # define RPCDBG_FACILITY RPCDBG_TRANS
180 #ifdef RPC_DEBUG_DATA
181 static void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
183 u8
*buf
= (u8
*) packet
;
186 dprintk("RPC: %s\n", msg
);
187 for (j
= 0; j
< count
&& j
< 128; j
+= 4) {
191 dprintk("0x%04x ", j
);
193 dprintk("%02x%02x%02x%02x ",
194 buf
[j
], buf
[j
+1], buf
[j
+2], buf
[j
+3]);
199 static inline void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
206 struct rpc_xprt xprt
;
211 struct socket
* sock
;
215 * State of TCP reply receive
224 unsigned long tcp_copied
,
228 * Connection of transports
230 struct delayed_work connect_worker
;
231 struct sockaddr_storage srcaddr
;
232 unsigned short srcport
;
235 * UDP socket buffer size parameters
241 * Saved socket callback addresses
243 void (*old_data_ready
)(struct sock
*, int);
244 void (*old_state_change
)(struct sock
*);
245 void (*old_write_space
)(struct sock
*);
246 void (*old_error_report
)(struct sock
*);
250 * TCP receive state flags
252 #define TCP_RCV_LAST_FRAG (1UL << 0)
253 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
254 #define TCP_RCV_COPY_XID (1UL << 2)
255 #define TCP_RCV_COPY_DATA (1UL << 3)
256 #define TCP_RCV_READ_CALLDIR (1UL << 4)
257 #define TCP_RCV_COPY_CALLDIR (1UL << 5)
262 #define TCP_RPC_REPLY (1UL << 6)
264 static inline struct sockaddr
*xs_addr(struct rpc_xprt
*xprt
)
266 return (struct sockaddr
*) &xprt
->addr
;
269 static inline struct sockaddr_un
*xs_addr_un(struct rpc_xprt
*xprt
)
271 return (struct sockaddr_un
*) &xprt
->addr
;
274 static inline struct sockaddr_in
*xs_addr_in(struct rpc_xprt
*xprt
)
276 return (struct sockaddr_in
*) &xprt
->addr
;
279 static inline struct sockaddr_in6
*xs_addr_in6(struct rpc_xprt
*xprt
)
281 return (struct sockaddr_in6
*) &xprt
->addr
;
284 static void xs_format_common_peer_addresses(struct rpc_xprt
*xprt
)
286 struct sockaddr
*sap
= xs_addr(xprt
);
287 struct sockaddr_in6
*sin6
;
288 struct sockaddr_in
*sin
;
289 struct sockaddr_un
*sun
;
292 switch (sap
->sa_family
) {
294 sun
= xs_addr_un(xprt
);
295 strlcpy(buf
, sun
->sun_path
, sizeof(buf
));
296 xprt
->address_strings
[RPC_DISPLAY_ADDR
] =
297 kstrdup(buf
, GFP_KERNEL
);
300 (void)rpc_ntop(sap
, buf
, sizeof(buf
));
301 xprt
->address_strings
[RPC_DISPLAY_ADDR
] =
302 kstrdup(buf
, GFP_KERNEL
);
303 sin
= xs_addr_in(xprt
);
304 snprintf(buf
, sizeof(buf
), "%08x", ntohl(sin
->sin_addr
.s_addr
));
307 (void)rpc_ntop(sap
, buf
, sizeof(buf
));
308 xprt
->address_strings
[RPC_DISPLAY_ADDR
] =
309 kstrdup(buf
, GFP_KERNEL
);
310 sin6
= xs_addr_in6(xprt
);
311 snprintf(buf
, sizeof(buf
), "%pi6", &sin6
->sin6_addr
);
317 xprt
->address_strings
[RPC_DISPLAY_HEX_ADDR
] = kstrdup(buf
, GFP_KERNEL
);
320 static void xs_format_common_peer_ports(struct rpc_xprt
*xprt
)
322 struct sockaddr
*sap
= xs_addr(xprt
);
325 snprintf(buf
, sizeof(buf
), "%u", rpc_get_port(sap
));
326 xprt
->address_strings
[RPC_DISPLAY_PORT
] = kstrdup(buf
, GFP_KERNEL
);
328 snprintf(buf
, sizeof(buf
), "%4hx", rpc_get_port(sap
));
329 xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
] = kstrdup(buf
, GFP_KERNEL
);
332 static void xs_format_peer_addresses(struct rpc_xprt
*xprt
,
333 const char *protocol
,
336 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = protocol
;
337 xprt
->address_strings
[RPC_DISPLAY_NETID
] = netid
;
338 xs_format_common_peer_addresses(xprt
);
339 xs_format_common_peer_ports(xprt
);
342 static void xs_update_peer_port(struct rpc_xprt
*xprt
)
344 kfree(xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
]);
345 kfree(xprt
->address_strings
[RPC_DISPLAY_PORT
]);
347 xs_format_common_peer_ports(xprt
);
350 static void xs_free_peer_addresses(struct rpc_xprt
*xprt
)
354 for (i
= 0; i
< RPC_DISPLAY_MAX
; i
++)
356 case RPC_DISPLAY_PROTO
:
357 case RPC_DISPLAY_NETID
:
360 kfree(xprt
->address_strings
[i
]);
364 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
366 static int xs_send_kvec(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct kvec
*vec
, unsigned int base
, int more
)
368 struct msghdr msg
= {
370 .msg_namelen
= addrlen
,
371 .msg_flags
= XS_SENDMSG_FLAGS
| (more
? MSG_MORE
: 0),
374 .iov_base
= vec
->iov_base
+ base
,
375 .iov_len
= vec
->iov_len
- base
,
378 if (iov
.iov_len
!= 0)
379 return kernel_sendmsg(sock
, &msg
, &iov
, 1, iov
.iov_len
);
380 return kernel_sendmsg(sock
, &msg
, NULL
, 0, 0);
383 static int xs_send_pagedata(struct socket
*sock
, struct xdr_buf
*xdr
, unsigned int base
, int more
)
386 unsigned int remainder
;
389 remainder
= xdr
->page_len
- base
;
390 base
+= xdr
->page_base
;
391 ppage
= xdr
->pages
+ (base
>> PAGE_SHIFT
);
394 unsigned int len
= min_t(unsigned int, PAGE_SIZE
- base
, remainder
);
395 int flags
= XS_SENDMSG_FLAGS
;
398 if (remainder
!= 0 || more
)
400 err
= sock
->ops
->sendpage(sock
, *ppage
, base
, len
, flags
);
401 if (remainder
== 0 || err
!= len
)
415 * xs_sendpages - write pages directly to a socket
416 * @sock: socket to send on
417 * @addr: UDP only -- address of destination
418 * @addrlen: UDP only -- length of destination address
419 * @xdr: buffer containing this request
420 * @base: starting position in the buffer
423 static int xs_sendpages(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct xdr_buf
*xdr
, unsigned int base
)
425 unsigned int remainder
= xdr
->len
- base
;
431 clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
);
437 if (base
< xdr
->head
[0].iov_len
|| addr
!= NULL
) {
438 unsigned int len
= xdr
->head
[0].iov_len
- base
;
440 err
= xs_send_kvec(sock
, addr
, addrlen
, &xdr
->head
[0], base
, remainder
!= 0);
441 if (remainder
== 0 || err
!= len
)
446 base
-= xdr
->head
[0].iov_len
;
448 if (base
< xdr
->page_len
) {
449 unsigned int len
= xdr
->page_len
- base
;
451 err
= xs_send_pagedata(sock
, xdr
, base
, remainder
!= 0);
452 if (remainder
== 0 || err
!= len
)
457 base
-= xdr
->page_len
;
459 if (base
>= xdr
->tail
[0].iov_len
)
461 err
= xs_send_kvec(sock
, NULL
, 0, &xdr
->tail
[0], base
, 0);
470 static void xs_nospace_callback(struct rpc_task
*task
)
472 struct sock_xprt
*transport
= container_of(task
->tk_rqstp
->rq_xprt
, struct sock_xprt
, xprt
);
474 transport
->inet
->sk_write_pending
--;
475 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
479 * xs_nospace - place task on wait queue if transmit was incomplete
480 * @task: task to put to sleep
483 static int xs_nospace(struct rpc_task
*task
)
485 struct rpc_rqst
*req
= task
->tk_rqstp
;
486 struct rpc_xprt
*xprt
= req
->rq_xprt
;
487 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
490 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
491 task
->tk_pid
, req
->rq_slen
- req
->rq_bytes_sent
,
494 /* Protect against races with write_space */
495 spin_lock_bh(&xprt
->transport_lock
);
497 /* Don't race with disconnect */
498 if (xprt_connected(xprt
)) {
499 if (test_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
)) {
501 * Notify TCP that we're limited by the application
504 set_bit(SOCK_NOSPACE
, &transport
->sock
->flags
);
505 transport
->inet
->sk_write_pending
++;
506 /* ...and wait for more buffer space */
507 xprt_wait_for_buffer_space(task
, xs_nospace_callback
);
510 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
514 spin_unlock_bh(&xprt
->transport_lock
);
519 * Construct a stream transport record marker in @buf.
521 static inline void xs_encode_stream_record_marker(struct xdr_buf
*buf
)
523 u32 reclen
= buf
->len
- sizeof(rpc_fraghdr
);
524 rpc_fraghdr
*base
= buf
->head
[0].iov_base
;
525 *base
= cpu_to_be32(RPC_LAST_STREAM_FRAGMENT
| reclen
);
529 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
530 * @task: RPC task that manages the state of an RPC request
533 * 0: The request has been sent
534 * EAGAIN: The socket was blocked, please call again later to
535 * complete the request
536 * ENOTCONN: Caller needs to invoke connect logic then call again
537 * other: Some other error occured, the request was not sent
539 static int xs_local_send_request(struct rpc_task
*task
)
541 struct rpc_rqst
*req
= task
->tk_rqstp
;
542 struct rpc_xprt
*xprt
= req
->rq_xprt
;
543 struct sock_xprt
*transport
=
544 container_of(xprt
, struct sock_xprt
, xprt
);
545 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
548 xs_encode_stream_record_marker(&req
->rq_snd_buf
);
550 xs_pktdump("packet data:",
551 req
->rq_svec
->iov_base
, req
->rq_svec
->iov_len
);
553 status
= xs_sendpages(transport
->sock
, NULL
, 0,
554 xdr
, req
->rq_bytes_sent
);
555 dprintk("RPC: %s(%u) = %d\n",
556 __func__
, xdr
->len
- req
->rq_bytes_sent
, status
);
557 if (likely(status
>= 0)) {
558 req
->rq_bytes_sent
+= status
;
559 req
->rq_xmit_bytes_sent
+= status
;
560 if (likely(req
->rq_bytes_sent
>= req
->rq_slen
)) {
561 req
->rq_bytes_sent
= 0;
569 status
= xs_nospace(task
);
572 dprintk("RPC: sendmsg returned unrecognized error %d\n",
583 * xs_udp_send_request - write an RPC request to a UDP socket
584 * @task: address of RPC task that manages the state of an RPC request
587 * 0: The request has been sent
588 * EAGAIN: The socket was blocked, please call again later to
589 * complete the request
590 * ENOTCONN: Caller needs to invoke connect logic then call again
591 * other: Some other error occurred, the request was not sent
593 static int xs_udp_send_request(struct rpc_task
*task
)
595 struct rpc_rqst
*req
= task
->tk_rqstp
;
596 struct rpc_xprt
*xprt
= req
->rq_xprt
;
597 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
598 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
601 xs_pktdump("packet data:",
602 req
->rq_svec
->iov_base
,
603 req
->rq_svec
->iov_len
);
605 if (!xprt_bound(xprt
))
607 status
= xs_sendpages(transport
->sock
,
612 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
613 xdr
->len
- req
->rq_bytes_sent
, status
);
616 req
->rq_xmit_bytes_sent
+= status
;
617 if (status
>= req
->rq_slen
)
619 /* Still some bytes left; set up for a retry later. */
626 /* Should we call xs_close() here? */
629 status
= xs_nospace(task
);
632 dprintk("RPC: sendmsg returned unrecognized error %d\n",
637 /* When the server has died, an ICMP port unreachable message
638 * prompts ECONNREFUSED. */
639 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
646 * xs_tcp_shutdown - gracefully shut down a TCP socket
649 * Initiates a graceful shutdown of the TCP socket by calling the
650 * equivalent of shutdown(SHUT_WR);
652 static void xs_tcp_shutdown(struct rpc_xprt
*xprt
)
654 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
655 struct socket
*sock
= transport
->sock
;
658 kernel_sock_shutdown(sock
, SHUT_WR
);
662 * xs_tcp_send_request - write an RPC request to a TCP socket
663 * @task: address of RPC task that manages the state of an RPC request
666 * 0: The request has been sent
667 * EAGAIN: The socket was blocked, please call again later to
668 * complete the request
669 * ENOTCONN: Caller needs to invoke connect logic then call again
670 * other: Some other error occurred, the request was not sent
672 * XXX: In the case of soft timeouts, should we eventually give up
673 * if sendmsg is not able to make progress?
675 static int xs_tcp_send_request(struct rpc_task
*task
)
677 struct rpc_rqst
*req
= task
->tk_rqstp
;
678 struct rpc_xprt
*xprt
= req
->rq_xprt
;
679 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
680 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
683 xs_encode_stream_record_marker(&req
->rq_snd_buf
);
685 xs_pktdump("packet data:",
686 req
->rq_svec
->iov_base
,
687 req
->rq_svec
->iov_len
);
689 /* Continue transmitting the packet/record. We must be careful
690 * to cope with writespace callbacks arriving _after_ we have
691 * called sendmsg(). */
693 status
= xs_sendpages(transport
->sock
,
694 NULL
, 0, xdr
, req
->rq_bytes_sent
);
696 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
697 xdr
->len
- req
->rq_bytes_sent
, status
);
699 if (unlikely(status
< 0))
702 /* If we've sent the entire packet, immediately
703 * reset the count of bytes sent. */
704 req
->rq_bytes_sent
+= status
;
705 req
->rq_xmit_bytes_sent
+= status
;
706 if (likely(req
->rq_bytes_sent
>= req
->rq_slen
)) {
707 req
->rq_bytes_sent
= 0;
720 /* Should we call xs_close() here? */
723 status
= xs_nospace(task
);
726 dprintk("RPC: sendmsg returned unrecognized error %d\n",
730 xs_tcp_shutdown(xprt
);
733 clear_bit(SOCK_ASYNC_NOSPACE
, &transport
->sock
->flags
);
740 * xs_tcp_release_xprt - clean up after a tcp transmission
744 * This cleans up if an error causes us to abort the transmission of a request.
745 * In this case, the socket may need to be reset in order to avoid confusing
748 static void xs_tcp_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
750 struct rpc_rqst
*req
;
752 if (task
!= xprt
->snd_task
)
756 req
= task
->tk_rqstp
;
757 if (req
->rq_bytes_sent
== 0)
759 if (req
->rq_bytes_sent
== req
->rq_snd_buf
.len
)
761 set_bit(XPRT_CLOSE_WAIT
, &task
->tk_xprt
->state
);
763 xprt_release_xprt(xprt
, task
);
766 static void xs_save_old_callbacks(struct sock_xprt
*transport
, struct sock
*sk
)
768 transport
->old_data_ready
= sk
->sk_data_ready
;
769 transport
->old_state_change
= sk
->sk_state_change
;
770 transport
->old_write_space
= sk
->sk_write_space
;
771 transport
->old_error_report
= sk
->sk_error_report
;
774 static void xs_restore_old_callbacks(struct sock_xprt
*transport
, struct sock
*sk
)
776 sk
->sk_data_ready
= transport
->old_data_ready
;
777 sk
->sk_state_change
= transport
->old_state_change
;
778 sk
->sk_write_space
= transport
->old_write_space
;
779 sk
->sk_error_report
= transport
->old_error_report
;
782 static void xs_reset_transport(struct sock_xprt
*transport
)
784 struct socket
*sock
= transport
->sock
;
785 struct sock
*sk
= transport
->inet
;
790 transport
->srcport
= 0;
792 write_lock_bh(&sk
->sk_callback_lock
);
793 transport
->inet
= NULL
;
794 transport
->sock
= NULL
;
796 sk
->sk_user_data
= NULL
;
798 xs_restore_old_callbacks(transport
, sk
);
799 write_unlock_bh(&sk
->sk_callback_lock
);
807 * xs_close - close a socket
810 * This is used when all requests are complete; ie, no DRC state remains
811 * on the server we want to save.
813 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
814 * xs_reset_transport() zeroing the socket from underneath a writer.
816 static void xs_close(struct rpc_xprt
*xprt
)
818 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
820 dprintk("RPC: xs_close xprt %p\n", xprt
);
822 xs_reset_transport(transport
);
823 xprt
->reestablish_timeout
= 0;
825 smp_mb__before_clear_bit();
826 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
827 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
828 clear_bit(XPRT_CLOSING
, &xprt
->state
);
829 smp_mb__after_clear_bit();
830 xprt_disconnect_done(xprt
);
833 static void xs_tcp_close(struct rpc_xprt
*xprt
)
835 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE
, &xprt
->state
))
838 xs_tcp_shutdown(xprt
);
842 * xs_destroy - prepare to shutdown a transport
843 * @xprt: doomed transport
846 static void xs_destroy(struct rpc_xprt
*xprt
)
848 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
850 dprintk("RPC: xs_destroy xprt %p\n", xprt
);
852 cancel_delayed_work_sync(&transport
->connect_worker
);
855 xs_free_peer_addresses(xprt
);
857 module_put(THIS_MODULE
);
860 static inline struct rpc_xprt
*xprt_from_sock(struct sock
*sk
)
862 return (struct rpc_xprt
*) sk
->sk_user_data
;
865 static int xs_local_copy_to_xdr(struct xdr_buf
*xdr
, struct sk_buff
*skb
)
867 struct xdr_skb_reader desc
= {
869 .offset
= sizeof(rpc_fraghdr
),
870 .count
= skb
->len
- sizeof(rpc_fraghdr
),
873 if (xdr_partial_copy_from_skb(xdr
, 0, &desc
, xdr_skb_read_bits
) < 0)
881 * xs_local_data_ready - "data ready" callback for AF_LOCAL sockets
882 * @sk: socket with data to read
883 * @len: how much data to read
885 * Currently this assumes we can read the whole reply in a single gulp.
887 static void xs_local_data_ready(struct sock
*sk
, int len
)
889 struct rpc_task
*task
;
890 struct rpc_xprt
*xprt
;
891 struct rpc_rqst
*rovr
;
893 int err
, repsize
, copied
;
897 read_lock_bh(&sk
->sk_callback_lock
);
898 dprintk("RPC: %s...\n", __func__
);
899 xprt
= xprt_from_sock(sk
);
903 skb
= skb_recv_datagram(sk
, 0, 1, &err
);
910 repsize
= skb
->len
- sizeof(rpc_fraghdr
);
912 dprintk("RPC: impossible RPC reply size %d\n", repsize
);
916 /* Copy the XID from the skb... */
917 xp
= skb_header_pointer(skb
, sizeof(rpc_fraghdr
), sizeof(_xid
), &_xid
);
921 /* Look up and lock the request corresponding to the given XID */
922 spin_lock(&xprt
->transport_lock
);
923 rovr
= xprt_lookup_rqst(xprt
, *xp
);
926 task
= rovr
->rq_task
;
928 copied
= rovr
->rq_private_buf
.buflen
;
929 if (copied
> repsize
)
932 if (xs_local_copy_to_xdr(&rovr
->rq_private_buf
, skb
)) {
933 dprintk("RPC: sk_buff copy failed\n");
937 xprt_complete_rqst(task
, copied
);
940 spin_unlock(&xprt
->transport_lock
);
942 skb_free_datagram(sk
, skb
);
944 read_unlock_bh(&sk
->sk_callback_lock
);
948 * xs_udp_data_ready - "data ready" callback for UDP sockets
949 * @sk: socket with data to read
950 * @len: how much data to read
953 static void xs_udp_data_ready(struct sock
*sk
, int len
)
955 struct rpc_task
*task
;
956 struct rpc_xprt
*xprt
;
957 struct rpc_rqst
*rovr
;
959 int err
, repsize
, copied
;
963 read_lock_bh(&sk
->sk_callback_lock
);
964 dprintk("RPC: xs_udp_data_ready...\n");
965 if (!(xprt
= xprt_from_sock(sk
)))
968 if ((skb
= skb_recv_datagram(sk
, 0, 1, &err
)) == NULL
)
974 repsize
= skb
->len
- sizeof(struct udphdr
);
976 dprintk("RPC: impossible RPC reply size %d!\n", repsize
);
980 /* Copy the XID from the skb... */
981 xp
= skb_header_pointer(skb
, sizeof(struct udphdr
),
982 sizeof(_xid
), &_xid
);
986 /* Look up and lock the request corresponding to the given XID */
987 spin_lock(&xprt
->transport_lock
);
988 rovr
= xprt_lookup_rqst(xprt
, *xp
);
991 task
= rovr
->rq_task
;
993 if ((copied
= rovr
->rq_private_buf
.buflen
) > repsize
)
996 /* Suck it into the iovec, verify checksum if not done by hw. */
997 if (csum_partial_copy_to_xdr(&rovr
->rq_private_buf
, skb
)) {
998 UDPX_INC_STATS_BH(sk
, UDP_MIB_INERRORS
);
1002 UDPX_INC_STATS_BH(sk
, UDP_MIB_INDATAGRAMS
);
1004 /* Something worked... */
1005 dst_confirm(skb_dst(skb
));
1007 xprt_adjust_cwnd(task
, copied
);
1008 xprt_complete_rqst(task
, copied
);
1011 spin_unlock(&xprt
->transport_lock
);
1013 skb_free_datagram(sk
, skb
);
1015 read_unlock_bh(&sk
->sk_callback_lock
);
1018 static inline void xs_tcp_read_fraghdr(struct rpc_xprt
*xprt
, struct xdr_skb_reader
*desc
)
1020 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1024 p
= ((char *) &transport
->tcp_fraghdr
) + transport
->tcp_offset
;
1025 len
= sizeof(transport
->tcp_fraghdr
) - transport
->tcp_offset
;
1026 used
= xdr_skb_read_bits(desc
, p
, len
);
1027 transport
->tcp_offset
+= used
;
1031 transport
->tcp_reclen
= ntohl(transport
->tcp_fraghdr
);
1032 if (transport
->tcp_reclen
& RPC_LAST_STREAM_FRAGMENT
)
1033 transport
->tcp_flags
|= TCP_RCV_LAST_FRAG
;
1035 transport
->tcp_flags
&= ~TCP_RCV_LAST_FRAG
;
1036 transport
->tcp_reclen
&= RPC_FRAGMENT_SIZE_MASK
;
1038 transport
->tcp_flags
&= ~TCP_RCV_COPY_FRAGHDR
;
1039 transport
->tcp_offset
= 0;
1041 /* Sanity check of the record length */
1042 if (unlikely(transport
->tcp_reclen
< 8)) {
1043 dprintk("RPC: invalid TCP record fragment length\n");
1044 xprt_force_disconnect(xprt
);
1047 dprintk("RPC: reading TCP record fragment of length %d\n",
1048 transport
->tcp_reclen
);
1051 static void xs_tcp_check_fraghdr(struct sock_xprt
*transport
)
1053 if (transport
->tcp_offset
== transport
->tcp_reclen
) {
1054 transport
->tcp_flags
|= TCP_RCV_COPY_FRAGHDR
;
1055 transport
->tcp_offset
= 0;
1056 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
) {
1057 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1058 transport
->tcp_flags
|= TCP_RCV_COPY_XID
;
1059 transport
->tcp_copied
= 0;
1064 static inline void xs_tcp_read_xid(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
1069 len
= sizeof(transport
->tcp_xid
) - transport
->tcp_offset
;
1070 dprintk("RPC: reading XID (%Zu bytes)\n", len
);
1071 p
= ((char *) &transport
->tcp_xid
) + transport
->tcp_offset
;
1072 used
= xdr_skb_read_bits(desc
, p
, len
);
1073 transport
->tcp_offset
+= used
;
1076 transport
->tcp_flags
&= ~TCP_RCV_COPY_XID
;
1077 transport
->tcp_flags
|= TCP_RCV_READ_CALLDIR
;
1078 transport
->tcp_copied
= 4;
1079 dprintk("RPC: reading %s XID %08x\n",
1080 (transport
->tcp_flags
& TCP_RPC_REPLY
) ? "reply for"
1082 ntohl(transport
->tcp_xid
));
1083 xs_tcp_check_fraghdr(transport
);
1086 static inline void xs_tcp_read_calldir(struct sock_xprt
*transport
,
1087 struct xdr_skb_reader
*desc
)
1094 * We want transport->tcp_offset to be 8 at the end of this routine
1095 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1096 * When this function is called for the first time,
1097 * transport->tcp_offset is 4 (after having already read the xid).
1099 offset
= transport
->tcp_offset
- sizeof(transport
->tcp_xid
);
1100 len
= sizeof(transport
->tcp_calldir
) - offset
;
1101 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len
);
1102 p
= ((char *) &transport
->tcp_calldir
) + offset
;
1103 used
= xdr_skb_read_bits(desc
, p
, len
);
1104 transport
->tcp_offset
+= used
;
1107 transport
->tcp_flags
&= ~TCP_RCV_READ_CALLDIR
;
1109 * We don't yet have the XDR buffer, so we will write the calldir
1110 * out after we get the buffer from the 'struct rpc_rqst'
1112 switch (ntohl(transport
->tcp_calldir
)) {
1114 transport
->tcp_flags
|= TCP_RCV_COPY_CALLDIR
;
1115 transport
->tcp_flags
|= TCP_RCV_COPY_DATA
;
1116 transport
->tcp_flags
|= TCP_RPC_REPLY
;
1119 transport
->tcp_flags
|= TCP_RCV_COPY_CALLDIR
;
1120 transport
->tcp_flags
|= TCP_RCV_COPY_DATA
;
1121 transport
->tcp_flags
&= ~TCP_RPC_REPLY
;
1124 dprintk("RPC: invalid request message type\n");
1125 xprt_force_disconnect(&transport
->xprt
);
1127 xs_tcp_check_fraghdr(transport
);
1130 static inline void xs_tcp_read_common(struct rpc_xprt
*xprt
,
1131 struct xdr_skb_reader
*desc
,
1132 struct rpc_rqst
*req
)
1134 struct sock_xprt
*transport
=
1135 container_of(xprt
, struct sock_xprt
, xprt
);
1136 struct xdr_buf
*rcvbuf
;
1140 rcvbuf
= &req
->rq_private_buf
;
1142 if (transport
->tcp_flags
& TCP_RCV_COPY_CALLDIR
) {
1144 * Save the RPC direction in the XDR buffer
1146 memcpy(rcvbuf
->head
[0].iov_base
+ transport
->tcp_copied
,
1147 &transport
->tcp_calldir
,
1148 sizeof(transport
->tcp_calldir
));
1149 transport
->tcp_copied
+= sizeof(transport
->tcp_calldir
);
1150 transport
->tcp_flags
&= ~TCP_RCV_COPY_CALLDIR
;
1154 if (len
> transport
->tcp_reclen
- transport
->tcp_offset
) {
1155 struct xdr_skb_reader my_desc
;
1157 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
1158 memcpy(&my_desc
, desc
, sizeof(my_desc
));
1159 my_desc
.count
= len
;
1160 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
1161 &my_desc
, xdr_skb_read_bits
);
1165 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
1166 desc
, xdr_skb_read_bits
);
1169 transport
->tcp_copied
+= r
;
1170 transport
->tcp_offset
+= r
;
1173 /* Error when copying to the receive buffer,
1174 * usually because we weren't able to allocate
1175 * additional buffer pages. All we can do now
1176 * is turn off TCP_RCV_COPY_DATA, so the request
1177 * will not receive any additional updates,
1179 * Any remaining data from this record will
1182 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1183 dprintk("RPC: XID %08x truncated request\n",
1184 ntohl(transport
->tcp_xid
));
1185 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1186 "tcp_offset = %u, tcp_reclen = %u\n",
1187 xprt
, transport
->tcp_copied
,
1188 transport
->tcp_offset
, transport
->tcp_reclen
);
1192 dprintk("RPC: XID %08x read %Zd bytes\n",
1193 ntohl(transport
->tcp_xid
), r
);
1194 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1195 "tcp_reclen = %u\n", xprt
, transport
->tcp_copied
,
1196 transport
->tcp_offset
, transport
->tcp_reclen
);
1198 if (transport
->tcp_copied
== req
->rq_private_buf
.buflen
)
1199 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1200 else if (transport
->tcp_offset
== transport
->tcp_reclen
) {
1201 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
)
1202 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1207 * Finds the request corresponding to the RPC xid and invokes the common
1208 * tcp read code to read the data.
1210 static inline int xs_tcp_read_reply(struct rpc_xprt
*xprt
,
1211 struct xdr_skb_reader
*desc
)
1213 struct sock_xprt
*transport
=
1214 container_of(xprt
, struct sock_xprt
, xprt
);
1215 struct rpc_rqst
*req
;
1217 dprintk("RPC: read reply XID %08x\n", ntohl(transport
->tcp_xid
));
1219 /* Find and lock the request corresponding to this xid */
1220 spin_lock(&xprt
->transport_lock
);
1221 req
= xprt_lookup_rqst(xprt
, transport
->tcp_xid
);
1223 dprintk("RPC: XID %08x request not found!\n",
1224 ntohl(transport
->tcp_xid
));
1225 spin_unlock(&xprt
->transport_lock
);
1229 xs_tcp_read_common(xprt
, desc
, req
);
1231 if (!(transport
->tcp_flags
& TCP_RCV_COPY_DATA
))
1232 xprt_complete_rqst(req
->rq_task
, transport
->tcp_copied
);
1234 spin_unlock(&xprt
->transport_lock
);
1238 #if defined(CONFIG_NFS_V4_1)
1240 * Obtains an rpc_rqst previously allocated and invokes the common
1241 * tcp read code to read the data. The result is placed in the callback
1243 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1244 * connection and return -1.
1246 static inline int xs_tcp_read_callback(struct rpc_xprt
*xprt
,
1247 struct xdr_skb_reader
*desc
)
1249 struct sock_xprt
*transport
=
1250 container_of(xprt
, struct sock_xprt
, xprt
);
1251 struct rpc_rqst
*req
;
1253 req
= xprt_alloc_bc_request(xprt
);
1255 printk(KERN_WARNING
"Callback slot table overflowed\n");
1256 xprt_force_disconnect(xprt
);
1260 req
->rq_xid
= transport
->tcp_xid
;
1261 dprintk("RPC: read callback XID %08x\n", ntohl(req
->rq_xid
));
1262 xs_tcp_read_common(xprt
, desc
, req
);
1264 if (!(transport
->tcp_flags
& TCP_RCV_COPY_DATA
)) {
1265 struct svc_serv
*bc_serv
= xprt
->bc_serv
;
1268 * Add callback request to callback list. The callback
1269 * service sleeps on the sv_cb_waitq waiting for new
1270 * requests. Wake it up after adding enqueing the
1273 dprintk("RPC: add callback request to list\n");
1274 spin_lock(&bc_serv
->sv_cb_lock
);
1275 list_add(&req
->rq_bc_list
, &bc_serv
->sv_cb_list
);
1276 spin_unlock(&bc_serv
->sv_cb_lock
);
1277 wake_up(&bc_serv
->sv_cb_waitq
);
1280 req
->rq_private_buf
.len
= transport
->tcp_copied
;
1285 static inline int _xs_tcp_read_data(struct rpc_xprt
*xprt
,
1286 struct xdr_skb_reader
*desc
)
1288 struct sock_xprt
*transport
=
1289 container_of(xprt
, struct sock_xprt
, xprt
);
1291 return (transport
->tcp_flags
& TCP_RPC_REPLY
) ?
1292 xs_tcp_read_reply(xprt
, desc
) :
1293 xs_tcp_read_callback(xprt
, desc
);
1296 static inline int _xs_tcp_read_data(struct rpc_xprt
*xprt
,
1297 struct xdr_skb_reader
*desc
)
1299 return xs_tcp_read_reply(xprt
, desc
);
1301 #endif /* CONFIG_NFS_V4_1 */
1304 * Read data off the transport. This can be either an RPC_CALL or an
1305 * RPC_REPLY. Relay the processing to helper functions.
1307 static void xs_tcp_read_data(struct rpc_xprt
*xprt
,
1308 struct xdr_skb_reader
*desc
)
1310 struct sock_xprt
*transport
=
1311 container_of(xprt
, struct sock_xprt
, xprt
);
1313 if (_xs_tcp_read_data(xprt
, desc
) == 0)
1314 xs_tcp_check_fraghdr(transport
);
1317 * The transport_lock protects the request handling.
1318 * There's no need to hold it to update the tcp_flags.
1320 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1324 static inline void xs_tcp_read_discard(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
1328 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
1329 if (len
> desc
->count
)
1332 desc
->offset
+= len
;
1333 transport
->tcp_offset
+= len
;
1334 dprintk("RPC: discarded %Zu bytes\n", len
);
1335 xs_tcp_check_fraghdr(transport
);
1338 static int xs_tcp_data_recv(read_descriptor_t
*rd_desc
, struct sk_buff
*skb
, unsigned int offset
, size_t len
)
1340 struct rpc_xprt
*xprt
= rd_desc
->arg
.data
;
1341 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1342 struct xdr_skb_reader desc
= {
1348 dprintk("RPC: xs_tcp_data_recv started\n");
1350 /* Read in a new fragment marker if necessary */
1351 /* Can we ever really expect to get completely empty fragments? */
1352 if (transport
->tcp_flags
& TCP_RCV_COPY_FRAGHDR
) {
1353 xs_tcp_read_fraghdr(xprt
, &desc
);
1356 /* Read in the xid if necessary */
1357 if (transport
->tcp_flags
& TCP_RCV_COPY_XID
) {
1358 xs_tcp_read_xid(transport
, &desc
);
1361 /* Read in the call/reply flag */
1362 if (transport
->tcp_flags
& TCP_RCV_READ_CALLDIR
) {
1363 xs_tcp_read_calldir(transport
, &desc
);
1366 /* Read in the request data */
1367 if (transport
->tcp_flags
& TCP_RCV_COPY_DATA
) {
1368 xs_tcp_read_data(xprt
, &desc
);
1371 /* Skip over any trailing bytes on short reads */
1372 xs_tcp_read_discard(transport
, &desc
);
1373 } while (desc
.count
);
1374 dprintk("RPC: xs_tcp_data_recv done\n");
1375 return len
- desc
.count
;
1379 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1380 * @sk: socket with data to read
1381 * @bytes: how much data to read
1384 static void xs_tcp_data_ready(struct sock
*sk
, int bytes
)
1386 struct rpc_xprt
*xprt
;
1387 read_descriptor_t rd_desc
;
1390 dprintk("RPC: xs_tcp_data_ready...\n");
1392 read_lock_bh(&sk
->sk_callback_lock
);
1393 if (!(xprt
= xprt_from_sock(sk
)))
1398 /* Any data means we had a useful conversation, so
1399 * the we don't need to delay the next reconnect
1401 if (xprt
->reestablish_timeout
)
1402 xprt
->reestablish_timeout
= 0;
1404 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1405 rd_desc
.arg
.data
= xprt
;
1407 rd_desc
.count
= 65536;
1408 read
= tcp_read_sock(sk
, &rd_desc
, xs_tcp_data_recv
);
1411 read_unlock_bh(&sk
->sk_callback_lock
);
1415 * Do the equivalent of linger/linger2 handling for dealing with
1416 * broken servers that don't close the socket in a timely
1419 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt
*xprt
,
1420 unsigned long timeout
)
1422 struct sock_xprt
*transport
;
1424 if (xprt_test_and_set_connecting(xprt
))
1426 set_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
1427 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1428 queue_delayed_work(rpciod_workqueue
, &transport
->connect_worker
,
1432 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt
*xprt
)
1434 struct sock_xprt
*transport
;
1436 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1438 if (!test_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
) ||
1439 !cancel_delayed_work(&transport
->connect_worker
))
1441 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
1442 xprt_clear_connecting(xprt
);
1445 static void xs_sock_mark_closed(struct rpc_xprt
*xprt
)
1447 smp_mb__before_clear_bit();
1448 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
1449 clear_bit(XPRT_CLOSING
, &xprt
->state
);
1450 smp_mb__after_clear_bit();
1451 /* Mark transport as closed and wake up all pending tasks */
1452 xprt_disconnect_done(xprt
);
1456 * xs_tcp_state_change - callback to handle TCP socket state changes
1457 * @sk: socket whose state has changed
1460 static void xs_tcp_state_change(struct sock
*sk
)
1462 struct rpc_xprt
*xprt
;
1464 read_lock_bh(&sk
->sk_callback_lock
);
1465 if (!(xprt
= xprt_from_sock(sk
)))
1467 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt
);
1468 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1469 sk
->sk_state
, xprt_connected(xprt
),
1470 sock_flag(sk
, SOCK_DEAD
),
1471 sock_flag(sk
, SOCK_ZAPPED
),
1474 switch (sk
->sk_state
) {
1475 case TCP_ESTABLISHED
:
1476 spin_lock(&xprt
->transport_lock
);
1477 if (!xprt_test_and_set_connected(xprt
)) {
1478 struct sock_xprt
*transport
= container_of(xprt
,
1479 struct sock_xprt
, xprt
);
1481 /* Reset TCP record info */
1482 transport
->tcp_offset
= 0;
1483 transport
->tcp_reclen
= 0;
1484 transport
->tcp_copied
= 0;
1485 transport
->tcp_flags
=
1486 TCP_RCV_COPY_FRAGHDR
| TCP_RCV_COPY_XID
;
1488 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
1490 spin_unlock(&xprt
->transport_lock
);
1493 /* The client initiated a shutdown of the socket */
1494 xprt
->connect_cookie
++;
1495 xprt
->reestablish_timeout
= 0;
1496 set_bit(XPRT_CLOSING
, &xprt
->state
);
1497 smp_mb__before_clear_bit();
1498 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1499 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
1500 smp_mb__after_clear_bit();
1501 xs_tcp_schedule_linger_timeout(xprt
, xs_tcp_fin_timeout
);
1503 case TCP_CLOSE_WAIT
:
1504 /* The server initiated a shutdown of the socket */
1505 xprt_force_disconnect(xprt
);
1506 xprt
->connect_cookie
++;
1509 * If the server closed down the connection, make sure that
1510 * we back off before reconnecting
1512 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
1513 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
1516 set_bit(XPRT_CLOSING
, &xprt
->state
);
1517 xs_tcp_schedule_linger_timeout(xprt
, xs_tcp_fin_timeout
);
1518 smp_mb__before_clear_bit();
1519 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1520 smp_mb__after_clear_bit();
1523 xs_tcp_cancel_linger_timeout(xprt
);
1524 xs_sock_mark_closed(xprt
);
1527 read_unlock_bh(&sk
->sk_callback_lock
);
1531 * xs_error_report - callback mainly for catching socket errors
1534 static void xs_error_report(struct sock
*sk
)
1536 struct rpc_xprt
*xprt
;
1538 read_lock_bh(&sk
->sk_callback_lock
);
1539 if (!(xprt
= xprt_from_sock(sk
)))
1541 dprintk("RPC: %s client %p...\n"
1543 __func__
, xprt
, sk
->sk_err
);
1544 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
1546 read_unlock_bh(&sk
->sk_callback_lock
);
1549 static void xs_write_space(struct sock
*sk
)
1551 struct socket
*sock
;
1552 struct rpc_xprt
*xprt
;
1554 if (unlikely(!(sock
= sk
->sk_socket
)))
1556 clear_bit(SOCK_NOSPACE
, &sock
->flags
);
1558 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
1560 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE
, &sock
->flags
) == 0)
1563 xprt_write_space(xprt
);
1567 * xs_udp_write_space - callback invoked when socket buffer space
1569 * @sk: socket whose state has changed
1571 * Called when more output buffer space is available for this socket.
1572 * We try not to wake our writers until they can make "significant"
1573 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1574 * with a bunch of small requests.
1576 static void xs_udp_write_space(struct sock
*sk
)
1578 read_lock_bh(&sk
->sk_callback_lock
);
1580 /* from net/core/sock.c:sock_def_write_space */
1581 if (sock_writeable(sk
))
1584 read_unlock_bh(&sk
->sk_callback_lock
);
1588 * xs_tcp_write_space - callback invoked when socket buffer space
1590 * @sk: socket whose state has changed
1592 * Called when more output buffer space is available for this socket.
1593 * We try not to wake our writers until they can make "significant"
1594 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1595 * with a bunch of small requests.
1597 static void xs_tcp_write_space(struct sock
*sk
)
1599 read_lock_bh(&sk
->sk_callback_lock
);
1601 /* from net/core/stream.c:sk_stream_write_space */
1602 if (sk_stream_wspace(sk
) >= sk_stream_min_wspace(sk
))
1605 read_unlock_bh(&sk
->sk_callback_lock
);
1608 static void xs_udp_do_set_buffer_size(struct rpc_xprt
*xprt
)
1610 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1611 struct sock
*sk
= transport
->inet
;
1613 if (transport
->rcvsize
) {
1614 sk
->sk_userlocks
|= SOCK_RCVBUF_LOCK
;
1615 sk
->sk_rcvbuf
= transport
->rcvsize
* xprt
->max_reqs
* 2;
1617 if (transport
->sndsize
) {
1618 sk
->sk_userlocks
|= SOCK_SNDBUF_LOCK
;
1619 sk
->sk_sndbuf
= transport
->sndsize
* xprt
->max_reqs
* 2;
1620 sk
->sk_write_space(sk
);
1625 * xs_udp_set_buffer_size - set send and receive limits
1626 * @xprt: generic transport
1627 * @sndsize: requested size of send buffer, in bytes
1628 * @rcvsize: requested size of receive buffer, in bytes
1630 * Set socket send and receive buffer size limits.
1632 static void xs_udp_set_buffer_size(struct rpc_xprt
*xprt
, size_t sndsize
, size_t rcvsize
)
1634 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1636 transport
->sndsize
= 0;
1638 transport
->sndsize
= sndsize
+ 1024;
1639 transport
->rcvsize
= 0;
1641 transport
->rcvsize
= rcvsize
+ 1024;
1643 xs_udp_do_set_buffer_size(xprt
);
1647 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1648 * @task: task that timed out
1650 * Adjust the congestion window after a retransmit timeout has occurred.
1652 static void xs_udp_timer(struct rpc_task
*task
)
1654 xprt_adjust_cwnd(task
, -ETIMEDOUT
);
1657 static unsigned short xs_get_random_port(void)
1659 unsigned short range
= xprt_max_resvport
- xprt_min_resvport
;
1660 unsigned short rand
= (unsigned short) net_random() % range
;
1661 return rand
+ xprt_min_resvport
;
1665 * xs_set_port - reset the port number in the remote endpoint address
1666 * @xprt: generic transport
1667 * @port: new port number
1670 static void xs_set_port(struct rpc_xprt
*xprt
, unsigned short port
)
1672 dprintk("RPC: setting port for xprt %p to %u\n", xprt
, port
);
1674 rpc_set_port(xs_addr(xprt
), port
);
1675 xs_update_peer_port(xprt
);
1678 static unsigned short xs_get_srcport(struct sock_xprt
*transport
)
1680 unsigned short port
= transport
->srcport
;
1682 if (port
== 0 && transport
->xprt
.resvport
)
1683 port
= xs_get_random_port();
1687 static unsigned short xs_next_srcport(struct sock_xprt
*transport
, unsigned short port
)
1689 if (transport
->srcport
!= 0)
1690 transport
->srcport
= 0;
1691 if (!transport
->xprt
.resvport
)
1693 if (port
<= xprt_min_resvport
|| port
> xprt_max_resvport
)
1694 return xprt_max_resvport
;
1697 static int xs_bind(struct sock_xprt
*transport
, struct socket
*sock
)
1699 struct sockaddr_storage myaddr
;
1701 unsigned short port
= xs_get_srcport(transport
);
1702 unsigned short last
;
1704 memcpy(&myaddr
, &transport
->srcaddr
, transport
->xprt
.addrlen
);
1706 rpc_set_port((struct sockaddr
*)&myaddr
, port
);
1707 err
= kernel_bind(sock
, (struct sockaddr
*)&myaddr
,
1708 transport
->xprt
.addrlen
);
1712 transport
->srcport
= port
;
1716 port
= xs_next_srcport(transport
, port
);
1719 } while (err
== -EADDRINUSE
&& nloop
!= 2);
1721 if (myaddr
.ss_family
== AF_INET
)
1722 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__
,
1723 &((struct sockaddr_in
*)&myaddr
)->sin_addr
,
1724 port
, err
? "failed" : "ok", err
);
1726 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__
,
1727 &((struct sockaddr_in6
*)&myaddr
)->sin6_addr
,
1728 port
, err
? "failed" : "ok", err
);
1733 * We don't support autobind on AF_LOCAL sockets
1735 static void xs_local_rpcbind(struct rpc_task
*task
)
1737 xprt_set_bound(task
->tk_xprt
);
1740 static void xs_local_set_port(struct rpc_xprt
*xprt
, unsigned short port
)
1744 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1745 static struct lock_class_key xs_key
[2];
1746 static struct lock_class_key xs_slock_key
[2];
1748 static inline void xs_reclassify_socketu(struct socket
*sock
)
1750 struct sock
*sk
= sock
->sk
;
1752 BUG_ON(sock_owned_by_user(sk
));
1753 sock_lock_init_class_and_name(sk
, "slock-AF_LOCAL-RPC",
1754 &xs_slock_key
[1], "sk_lock-AF_LOCAL-RPC", &xs_key
[1]);
1757 static inline void xs_reclassify_socket4(struct socket
*sock
)
1759 struct sock
*sk
= sock
->sk
;
1761 BUG_ON(sock_owned_by_user(sk
));
1762 sock_lock_init_class_and_name(sk
, "slock-AF_INET-RPC",
1763 &xs_slock_key
[0], "sk_lock-AF_INET-RPC", &xs_key
[0]);
1766 static inline void xs_reclassify_socket6(struct socket
*sock
)
1768 struct sock
*sk
= sock
->sk
;
1770 BUG_ON(sock_owned_by_user(sk
));
1771 sock_lock_init_class_and_name(sk
, "slock-AF_INET6-RPC",
1772 &xs_slock_key
[1], "sk_lock-AF_INET6-RPC", &xs_key
[1]);
1775 static inline void xs_reclassify_socket(int family
, struct socket
*sock
)
1779 xs_reclassify_socketu(sock
);
1782 xs_reclassify_socket4(sock
);
1785 xs_reclassify_socket6(sock
);
1790 static inline void xs_reclassify_socketu(struct socket
*sock
)
1794 static inline void xs_reclassify_socket4(struct socket
*sock
)
1798 static inline void xs_reclassify_socket6(struct socket
*sock
)
1802 static inline void xs_reclassify_socket(int family
, struct socket
*sock
)
1807 static struct socket
*xs_create_sock(struct rpc_xprt
*xprt
,
1808 struct sock_xprt
*transport
, int family
, int type
, int protocol
)
1810 struct socket
*sock
;
1813 err
= __sock_create(xprt
->xprt_net
, family
, type
, protocol
, &sock
, 1);
1815 dprintk("RPC: can't create %d transport socket (%d).\n",
1819 xs_reclassify_socket(family
, sock
);
1821 err
= xs_bind(transport
, sock
);
1829 return ERR_PTR(err
);
1832 static int xs_local_finish_connecting(struct rpc_xprt
*xprt
,
1833 struct socket
*sock
)
1835 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
,
1838 if (!transport
->inet
) {
1839 struct sock
*sk
= sock
->sk
;
1841 write_lock_bh(&sk
->sk_callback_lock
);
1843 xs_save_old_callbacks(transport
, sk
);
1845 sk
->sk_user_data
= xprt
;
1846 sk
->sk_data_ready
= xs_local_data_ready
;
1847 sk
->sk_write_space
= xs_udp_write_space
;
1848 sk
->sk_error_report
= xs_error_report
;
1849 sk
->sk_allocation
= GFP_ATOMIC
;
1851 xprt_clear_connected(xprt
);
1853 /* Reset to new socket */
1854 transport
->sock
= sock
;
1855 transport
->inet
= sk
;
1857 write_unlock_bh(&sk
->sk_callback_lock
);
1860 /* Tell the socket layer to start connecting... */
1861 xprt
->stat
.connect_count
++;
1862 xprt
->stat
.connect_start
= jiffies
;
1863 return kernel_connect(sock
, xs_addr(xprt
), xprt
->addrlen
, 0);
1867 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1868 * @xprt: RPC transport to connect
1869 * @transport: socket transport to connect
1870 * @create_sock: function to create a socket of the correct type
1872 * Invoked by a work queue tasklet.
1874 static void xs_local_setup_socket(struct work_struct
*work
)
1876 struct sock_xprt
*transport
=
1877 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1878 struct rpc_xprt
*xprt
= &transport
->xprt
;
1879 struct socket
*sock
;
1885 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
1886 status
= __sock_create(xprt
->xprt_net
, AF_LOCAL
,
1887 SOCK_STREAM
, 0, &sock
, 1);
1889 dprintk("RPC: can't create AF_LOCAL "
1890 "transport socket (%d).\n", -status
);
1893 xs_reclassify_socketu(sock
);
1895 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1896 xprt
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
1898 status
= xs_local_finish_connecting(xprt
, sock
);
1901 dprintk("RPC: xprt %p connected to %s\n",
1902 xprt
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
1903 xprt_set_connected(xprt
);
1906 dprintk("RPC: xprt %p: socket %s does not exist\n",
1907 xprt
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
1910 printk(KERN_ERR
"%s: unhandled error (%d) connecting to %s\n",
1912 xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
1916 xprt_clear_connecting(xprt
);
1917 xprt_wake_pending_tasks(xprt
, status
);
1920 static void xs_udp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
1922 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1924 if (!transport
->inet
) {
1925 struct sock
*sk
= sock
->sk
;
1927 write_lock_bh(&sk
->sk_callback_lock
);
1929 xs_save_old_callbacks(transport
, sk
);
1931 sk
->sk_user_data
= xprt
;
1932 sk
->sk_data_ready
= xs_udp_data_ready
;
1933 sk
->sk_write_space
= xs_udp_write_space
;
1934 sk
->sk_error_report
= xs_error_report
;
1935 sk
->sk_no_check
= UDP_CSUM_NORCV
;
1936 sk
->sk_allocation
= GFP_ATOMIC
;
1938 xprt_set_connected(xprt
);
1940 /* Reset to new socket */
1941 transport
->sock
= sock
;
1942 transport
->inet
= sk
;
1944 write_unlock_bh(&sk
->sk_callback_lock
);
1946 xs_udp_do_set_buffer_size(xprt
);
1949 static void xs_udp_setup_socket(struct work_struct
*work
)
1951 struct sock_xprt
*transport
=
1952 container_of(work
, struct sock_xprt
, connect_worker
.work
);
1953 struct rpc_xprt
*xprt
= &transport
->xprt
;
1954 struct socket
*sock
= transport
->sock
;
1960 /* Start by resetting any existing state */
1961 xs_reset_transport(transport
);
1962 sock
= xs_create_sock(xprt
, transport
,
1963 xs_addr(xprt
)->sa_family
, SOCK_DGRAM
, IPPROTO_UDP
);
1967 dprintk("RPC: worker connecting xprt %p via %s to "
1968 "%s (port %s)\n", xprt
,
1969 xprt
->address_strings
[RPC_DISPLAY_PROTO
],
1970 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
1971 xprt
->address_strings
[RPC_DISPLAY_PORT
]);
1973 xs_udp_finish_connecting(xprt
, sock
);
1976 xprt_clear_connecting(xprt
);
1977 xprt_wake_pending_tasks(xprt
, status
);
1981 * We need to preserve the port number so the reply cache on the server can
1982 * find our cached RPC replies when we get around to reconnecting.
1984 static void xs_abort_connection(struct sock_xprt
*transport
)
1987 struct sockaddr any
;
1989 dprintk("RPC: disconnecting xprt %p to reuse port\n", transport
);
1992 * Disconnect the transport socket by doing a connect operation
1993 * with AF_UNSPEC. This should return immediately...
1995 memset(&any
, 0, sizeof(any
));
1996 any
.sa_family
= AF_UNSPEC
;
1997 result
= kernel_connect(transport
->sock
, &any
, sizeof(any
), 0);
1999 xs_sock_mark_closed(&transport
->xprt
);
2001 dprintk("RPC: AF_UNSPEC connect return code %d\n",
2005 static void xs_tcp_reuse_connection(struct sock_xprt
*transport
)
2007 unsigned int state
= transport
->inet
->sk_state
;
2009 if (state
== TCP_CLOSE
&& transport
->sock
->state
== SS_UNCONNECTED
) {
2010 /* we don't need to abort the connection if the socket
2011 * hasn't undergone a shutdown
2013 if (transport
->inet
->sk_shutdown
== 0)
2015 dprintk("RPC: %s: TCP_CLOSEd and sk_shutdown set to %d\n",
2016 __func__
, transport
->inet
->sk_shutdown
);
2018 if ((1 << state
) & (TCPF_ESTABLISHED
|TCPF_SYN_SENT
)) {
2019 /* we don't need to abort the connection if the socket
2020 * hasn't undergone a shutdown
2022 if (transport
->inet
->sk_shutdown
== 0)
2024 dprintk("RPC: %s: ESTABLISHED/SYN_SENT "
2025 "sk_shutdown set to %d\n",
2026 __func__
, transport
->inet
->sk_shutdown
);
2028 xs_abort_connection(transport
);
2031 static int xs_tcp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
2033 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2034 int ret
= -ENOTCONN
;
2036 if (!transport
->inet
) {
2037 struct sock
*sk
= sock
->sk
;
2039 write_lock_bh(&sk
->sk_callback_lock
);
2041 xs_save_old_callbacks(transport
, sk
);
2043 sk
->sk_user_data
= xprt
;
2044 sk
->sk_data_ready
= xs_tcp_data_ready
;
2045 sk
->sk_state_change
= xs_tcp_state_change
;
2046 sk
->sk_write_space
= xs_tcp_write_space
;
2047 sk
->sk_error_report
= xs_error_report
;
2048 sk
->sk_allocation
= GFP_ATOMIC
;
2050 /* socket options */
2051 sk
->sk_userlocks
|= SOCK_BINDPORT_LOCK
;
2052 sock_reset_flag(sk
, SOCK_LINGER
);
2053 tcp_sk(sk
)->linger2
= 0;
2054 tcp_sk(sk
)->nonagle
|= TCP_NAGLE_OFF
;
2056 xprt_clear_connected(xprt
);
2058 /* Reset to new socket */
2059 transport
->sock
= sock
;
2060 transport
->inet
= sk
;
2062 write_unlock_bh(&sk
->sk_callback_lock
);
2065 if (!xprt_bound(xprt
))
2068 /* Tell the socket layer to start connecting... */
2069 xprt
->stat
.connect_count
++;
2070 xprt
->stat
.connect_start
= jiffies
;
2071 ret
= kernel_connect(sock
, xs_addr(xprt
), xprt
->addrlen
, O_NONBLOCK
);
2076 xprt
->connect_cookie
++;
2077 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
2078 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2085 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2086 * @xprt: RPC transport to connect
2087 * @transport: socket transport to connect
2088 * @create_sock: function to create a socket of the correct type
2090 * Invoked by a work queue tasklet.
2092 static void xs_tcp_setup_socket(struct work_struct
*work
)
2094 struct sock_xprt
*transport
=
2095 container_of(work
, struct sock_xprt
, connect_worker
.work
);
2096 struct socket
*sock
= transport
->sock
;
2097 struct rpc_xprt
*xprt
= &transport
->xprt
;
2104 clear_bit(XPRT_CONNECTION_ABORT
, &xprt
->state
);
2105 sock
= xs_create_sock(xprt
, transport
,
2106 xs_addr(xprt
)->sa_family
, SOCK_STREAM
, IPPROTO_TCP
);
2108 status
= PTR_ERR(sock
);
2114 abort_and_exit
= test_and_clear_bit(XPRT_CONNECTION_ABORT
,
2116 /* "close" the socket, preserving the local port */
2117 xs_tcp_reuse_connection(transport
);
2123 dprintk("RPC: worker connecting xprt %p via %s to "
2124 "%s (port %s)\n", xprt
,
2125 xprt
->address_strings
[RPC_DISPLAY_PROTO
],
2126 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2127 xprt
->address_strings
[RPC_DISPLAY_PORT
]);
2129 status
= xs_tcp_finish_connecting(xprt
, sock
);
2130 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2131 xprt
, -status
, xprt_connected(xprt
),
2132 sock
->sk
->sk_state
);
2135 printk("%s: connect returned unhandled error %d\n",
2137 case -EADDRNOTAVAIL
:
2138 /* We're probably in TIME_WAIT. Get rid of existing socket,
2141 set_bit(XPRT_CONNECTION_CLOSE
, &xprt
->state
);
2142 xprt_force_disconnect(xprt
);
2147 /* retry with existing socket, after a delay */
2151 xprt_clear_connecting(xprt
);
2154 /* Happens, for instance, if the user specified a link
2155 * local IPv6 address without a scope-id.
2162 xprt_clear_connecting(xprt
);
2163 xprt_wake_pending_tasks(xprt
, status
);
2167 * xs_connect - connect a socket to a remote endpoint
2168 * @task: address of RPC task that manages state of connect request
2170 * TCP: If the remote end dropped the connection, delay reconnecting.
2172 * UDP socket connects are synchronous, but we use a work queue anyway
2173 * to guarantee that even unprivileged user processes can set up a
2174 * socket on a privileged port.
2176 * If a UDP socket connect fails, the delay behavior here prevents
2177 * retry floods (hard mounts).
2179 static void xs_connect(struct rpc_task
*task
)
2181 struct rpc_xprt
*xprt
= task
->tk_xprt
;
2182 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2184 if (transport
->sock
!= NULL
&& !RPC_IS_SOFTCONN(task
)) {
2185 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2187 xprt
, xprt
->reestablish_timeout
/ HZ
);
2188 queue_delayed_work(rpciod_workqueue
,
2189 &transport
->connect_worker
,
2190 xprt
->reestablish_timeout
);
2191 xprt
->reestablish_timeout
<<= 1;
2192 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
2193 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2194 if (xprt
->reestablish_timeout
> XS_TCP_MAX_REEST_TO
)
2195 xprt
->reestablish_timeout
= XS_TCP_MAX_REEST_TO
;
2197 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt
);
2198 queue_delayed_work(rpciod_workqueue
,
2199 &transport
->connect_worker
, 0);
2204 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2205 * @xprt: rpc_xprt struct containing statistics
2209 static void xs_local_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
2213 if (xprt_connected(xprt
))
2214 idle_time
= (long)(jiffies
- xprt
->last_used
) / HZ
;
2216 seq_printf(seq
, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2218 xprt
->stat
.bind_count
,
2219 xprt
->stat
.connect_count
,
2220 xprt
->stat
.connect_time
,
2224 xprt
->stat
.bad_xids
,
2226 xprt
->stat
.bklog_u
);
2230 * xs_udp_print_stats - display UDP socket-specifc stats
2231 * @xprt: rpc_xprt struct containing statistics
2235 static void xs_udp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
2237 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2239 seq_printf(seq
, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
2241 xprt
->stat
.bind_count
,
2244 xprt
->stat
.bad_xids
,
2246 xprt
->stat
.bklog_u
);
2250 * xs_tcp_print_stats - display TCP socket-specifc stats
2251 * @xprt: rpc_xprt struct containing statistics
2255 static void xs_tcp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
2257 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2260 if (xprt_connected(xprt
))
2261 idle_time
= (long)(jiffies
- xprt
->last_used
) / HZ
;
2263 seq_printf(seq
, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
2265 xprt
->stat
.bind_count
,
2266 xprt
->stat
.connect_count
,
2267 xprt
->stat
.connect_time
,
2271 xprt
->stat
.bad_xids
,
2273 xprt
->stat
.bklog_u
);
2277 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2278 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2279 * to use the server side send routines.
2281 static void *bc_malloc(struct rpc_task
*task
, size_t size
)
2284 struct rpc_buffer
*buf
;
2286 BUG_ON(size
> PAGE_SIZE
- sizeof(struct rpc_buffer
));
2287 page
= alloc_page(GFP_KERNEL
);
2292 buf
= page_address(page
);
2293 buf
->len
= PAGE_SIZE
;
2299 * Free the space allocated in the bc_alloc routine
2301 static void bc_free(void *buffer
)
2303 struct rpc_buffer
*buf
;
2308 buf
= container_of(buffer
, struct rpc_buffer
, data
);
2309 free_page((unsigned long)buf
);
2313 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2314 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2316 static int bc_sendto(struct rpc_rqst
*req
)
2319 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
2320 struct rpc_xprt
*xprt
= req
->rq_xprt
;
2321 struct sock_xprt
*transport
=
2322 container_of(xprt
, struct sock_xprt
, xprt
);
2323 struct socket
*sock
= transport
->sock
;
2324 unsigned long headoff
;
2325 unsigned long tailoff
;
2327 xs_encode_stream_record_marker(xbufp
);
2329 tailoff
= (unsigned long)xbufp
->tail
[0].iov_base
& ~PAGE_MASK
;
2330 headoff
= (unsigned long)xbufp
->head
[0].iov_base
& ~PAGE_MASK
;
2331 len
= svc_send_common(sock
, xbufp
,
2332 virt_to_page(xbufp
->head
[0].iov_base
), headoff
,
2333 xbufp
->tail
[0].iov_base
, tailoff
);
2335 if (len
!= xbufp
->len
) {
2336 printk(KERN_NOTICE
"Error sending entire callback!\n");
2344 * The send routine. Borrows from svc_send
2346 static int bc_send_request(struct rpc_task
*task
)
2348 struct rpc_rqst
*req
= task
->tk_rqstp
;
2349 struct svc_xprt
*xprt
;
2350 struct svc_sock
*svsk
;
2353 dprintk("sending request with xid: %08x\n", ntohl(req
->rq_xid
));
2355 * Get the server socket associated with this callback xprt
2357 xprt
= req
->rq_xprt
->bc_xprt
;
2358 svsk
= container_of(xprt
, struct svc_sock
, sk_xprt
);
2361 * Grab the mutex to serialize data as the connection is shared
2362 * with the fore channel
2364 if (!mutex_trylock(&xprt
->xpt_mutex
)) {
2365 rpc_sleep_on(&xprt
->xpt_bc_pending
, task
, NULL
);
2366 if (!mutex_trylock(&xprt
->xpt_mutex
))
2368 rpc_wake_up_queued_task(&xprt
->xpt_bc_pending
, task
);
2370 if (test_bit(XPT_DEAD
, &xprt
->xpt_flags
))
2373 len
= bc_sendto(req
);
2374 mutex_unlock(&xprt
->xpt_mutex
);
2383 * The close routine. Since this is client initiated, we do nothing
2386 static void bc_close(struct rpc_xprt
*xprt
)
2391 * The xprt destroy routine. Again, because this connection is client
2392 * initiated, we do nothing
2395 static void bc_destroy(struct rpc_xprt
*xprt
)
2399 static struct rpc_xprt_ops xs_local_ops
= {
2400 .reserve_xprt
= xprt_reserve_xprt
,
2401 .release_xprt
= xs_tcp_release_xprt
,
2402 .rpcbind
= xs_local_rpcbind
,
2403 .set_port
= xs_local_set_port
,
2404 .connect
= xs_connect
,
2405 .buf_alloc
= rpc_malloc
,
2406 .buf_free
= rpc_free
,
2407 .send_request
= xs_local_send_request
,
2408 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
2410 .destroy
= xs_destroy
,
2411 .print_stats
= xs_local_print_stats
,
2414 static struct rpc_xprt_ops xs_udp_ops
= {
2415 .set_buffer_size
= xs_udp_set_buffer_size
,
2416 .reserve_xprt
= xprt_reserve_xprt_cong
,
2417 .release_xprt
= xprt_release_xprt_cong
,
2418 .rpcbind
= rpcb_getport_async
,
2419 .set_port
= xs_set_port
,
2420 .connect
= xs_connect
,
2421 .buf_alloc
= rpc_malloc
,
2422 .buf_free
= rpc_free
,
2423 .send_request
= xs_udp_send_request
,
2424 .set_retrans_timeout
= xprt_set_retrans_timeout_rtt
,
2425 .timer
= xs_udp_timer
,
2426 .release_request
= xprt_release_rqst_cong
,
2428 .destroy
= xs_destroy
,
2429 .print_stats
= xs_udp_print_stats
,
2432 static struct rpc_xprt_ops xs_tcp_ops
= {
2433 .reserve_xprt
= xprt_reserve_xprt
,
2434 .release_xprt
= xs_tcp_release_xprt
,
2435 .rpcbind
= rpcb_getport_async
,
2436 .set_port
= xs_set_port
,
2437 .connect
= xs_connect
,
2438 .buf_alloc
= rpc_malloc
,
2439 .buf_free
= rpc_free
,
2440 .send_request
= xs_tcp_send_request
,
2441 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
2442 .close
= xs_tcp_close
,
2443 .destroy
= xs_destroy
,
2444 .print_stats
= xs_tcp_print_stats
,
2448 * The rpc_xprt_ops for the server backchannel
2451 static struct rpc_xprt_ops bc_tcp_ops
= {
2452 .reserve_xprt
= xprt_reserve_xprt
,
2453 .release_xprt
= xprt_release_xprt
,
2454 .buf_alloc
= bc_malloc
,
2455 .buf_free
= bc_free
,
2456 .send_request
= bc_send_request
,
2457 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
2459 .destroy
= bc_destroy
,
2460 .print_stats
= xs_tcp_print_stats
,
2463 static int xs_init_anyaddr(const int family
, struct sockaddr
*sap
)
2465 static const struct sockaddr_in sin
= {
2466 .sin_family
= AF_INET
,
2467 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
2469 static const struct sockaddr_in6 sin6
= {
2470 .sin6_family
= AF_INET6
,
2471 .sin6_addr
= IN6ADDR_ANY_INIT
,
2478 memcpy(sap
, &sin
, sizeof(sin
));
2481 memcpy(sap
, &sin6
, sizeof(sin6
));
2484 dprintk("RPC: %s: Bad address family\n", __func__
);
2485 return -EAFNOSUPPORT
;
2490 static struct rpc_xprt
*xs_setup_xprt(struct xprt_create
*args
,
2491 unsigned int slot_table_size
)
2493 struct rpc_xprt
*xprt
;
2494 struct sock_xprt
*new;
2496 if (args
->addrlen
> sizeof(xprt
->addr
)) {
2497 dprintk("RPC: xs_setup_xprt: address too large\n");
2498 return ERR_PTR(-EBADF
);
2501 xprt
= xprt_alloc(args
->net
, sizeof(*new), slot_table_size
);
2503 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2505 return ERR_PTR(-ENOMEM
);
2508 new = container_of(xprt
, struct sock_xprt
, xprt
);
2509 memcpy(&xprt
->addr
, args
->dstaddr
, args
->addrlen
);
2510 xprt
->addrlen
= args
->addrlen
;
2512 memcpy(&new->srcaddr
, args
->srcaddr
, args
->addrlen
);
2515 err
= xs_init_anyaddr(args
->dstaddr
->sa_family
,
2516 (struct sockaddr
*)&new->srcaddr
);
2518 return ERR_PTR(err
);
2524 static const struct rpc_timeout xs_local_default_timeout
= {
2525 .to_initval
= 10 * HZ
,
2526 .to_maxval
= 10 * HZ
,
2531 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2532 * @args: rpc transport creation arguments
2534 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2536 static struct rpc_xprt
*xs_setup_local(struct xprt_create
*args
)
2538 struct sockaddr_un
*sun
= (struct sockaddr_un
*)args
->dstaddr
;
2539 struct sock_xprt
*transport
;
2540 struct rpc_xprt
*xprt
;
2541 struct rpc_xprt
*ret
;
2543 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
);
2546 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2549 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
2550 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
2552 xprt
->bind_timeout
= XS_BIND_TO
;
2553 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2554 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2556 xprt
->ops
= &xs_local_ops
;
2557 xprt
->timeout
= &xs_local_default_timeout
;
2559 switch (sun
->sun_family
) {
2561 if (sun
->sun_path
[0] != '/') {
2562 dprintk("RPC: bad AF_LOCAL address: %s\n",
2564 ret
= ERR_PTR(-EINVAL
);
2567 xprt_set_bound(xprt
);
2568 INIT_DELAYED_WORK(&transport
->connect_worker
,
2569 xs_local_setup_socket
);
2570 xs_format_peer_addresses(xprt
, "local", RPCBIND_NETID_LOCAL
);
2573 ret
= ERR_PTR(-EAFNOSUPPORT
);
2577 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2578 xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2580 if (try_module_get(THIS_MODULE
))
2582 ret
= ERR_PTR(-EINVAL
);
2588 static const struct rpc_timeout xs_udp_default_timeout
= {
2589 .to_initval
= 5 * HZ
,
2590 .to_maxval
= 30 * HZ
,
2591 .to_increment
= 5 * HZ
,
2596 * xs_setup_udp - Set up transport to use a UDP socket
2597 * @args: rpc transport creation arguments
2600 static struct rpc_xprt
*xs_setup_udp(struct xprt_create
*args
)
2602 struct sockaddr
*addr
= args
->dstaddr
;
2603 struct rpc_xprt
*xprt
;
2604 struct sock_xprt
*transport
;
2605 struct rpc_xprt
*ret
;
2607 xprt
= xs_setup_xprt(args
, xprt_udp_slot_table_entries
);
2610 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2612 xprt
->prot
= IPPROTO_UDP
;
2614 /* XXX: header size can vary due to auth type, IPv6, etc. */
2615 xprt
->max_payload
= (1U << 16) - (MAX_HEADER
<< 3);
2617 xprt
->bind_timeout
= XS_BIND_TO
;
2618 xprt
->reestablish_timeout
= XS_UDP_REEST_TO
;
2619 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2621 xprt
->ops
= &xs_udp_ops
;
2623 xprt
->timeout
= &xs_udp_default_timeout
;
2625 switch (addr
->sa_family
) {
2627 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
2628 xprt_set_bound(xprt
);
2630 INIT_DELAYED_WORK(&transport
->connect_worker
,
2631 xs_udp_setup_socket
);
2632 xs_format_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP
);
2635 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
2636 xprt_set_bound(xprt
);
2638 INIT_DELAYED_WORK(&transport
->connect_worker
,
2639 xs_udp_setup_socket
);
2640 xs_format_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP6
);
2643 ret
= ERR_PTR(-EAFNOSUPPORT
);
2647 if (xprt_bound(xprt
))
2648 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2649 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2650 xprt
->address_strings
[RPC_DISPLAY_PORT
],
2651 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
2653 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2654 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2655 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
2657 if (try_module_get(THIS_MODULE
))
2659 ret
= ERR_PTR(-EINVAL
);
2665 static const struct rpc_timeout xs_tcp_default_timeout
= {
2666 .to_initval
= 60 * HZ
,
2667 .to_maxval
= 60 * HZ
,
2672 * xs_setup_tcp - Set up transport to use a TCP socket
2673 * @args: rpc transport creation arguments
2676 static struct rpc_xprt
*xs_setup_tcp(struct xprt_create
*args
)
2678 struct sockaddr
*addr
= args
->dstaddr
;
2679 struct rpc_xprt
*xprt
;
2680 struct sock_xprt
*transport
;
2681 struct rpc_xprt
*ret
;
2683 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
);
2686 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2688 xprt
->prot
= IPPROTO_TCP
;
2689 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
2690 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
2692 xprt
->bind_timeout
= XS_BIND_TO
;
2693 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2694 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2696 xprt
->ops
= &xs_tcp_ops
;
2697 xprt
->timeout
= &xs_tcp_default_timeout
;
2699 switch (addr
->sa_family
) {
2701 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
2702 xprt_set_bound(xprt
);
2704 INIT_DELAYED_WORK(&transport
->connect_worker
,
2705 xs_tcp_setup_socket
);
2706 xs_format_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP
);
2709 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
2710 xprt_set_bound(xprt
);
2712 INIT_DELAYED_WORK(&transport
->connect_worker
,
2713 xs_tcp_setup_socket
);
2714 xs_format_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP6
);
2717 ret
= ERR_PTR(-EAFNOSUPPORT
);
2721 if (xprt_bound(xprt
))
2722 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2723 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2724 xprt
->address_strings
[RPC_DISPLAY_PORT
],
2725 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
2727 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2728 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2729 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
2732 if (try_module_get(THIS_MODULE
))
2734 ret
= ERR_PTR(-EINVAL
);
2741 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
2742 * @args: rpc transport creation arguments
2745 static struct rpc_xprt
*xs_setup_bc_tcp(struct xprt_create
*args
)
2747 struct sockaddr
*addr
= args
->dstaddr
;
2748 struct rpc_xprt
*xprt
;
2749 struct sock_xprt
*transport
;
2750 struct svc_sock
*bc_sock
;
2751 struct rpc_xprt
*ret
;
2753 if (args
->bc_xprt
->xpt_bc_xprt
) {
2755 * This server connection already has a backchannel
2756 * export; we can't create a new one, as we wouldn't be
2757 * able to match replies based on xid any more. So,
2758 * reuse the already-existing one:
2760 return args
->bc_xprt
->xpt_bc_xprt
;
2762 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
);
2765 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2767 xprt
->prot
= IPPROTO_TCP
;
2768 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
2769 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
2770 xprt
->timeout
= &xs_tcp_default_timeout
;
2773 xprt_set_bound(xprt
);
2774 xprt
->bind_timeout
= 0;
2775 xprt
->reestablish_timeout
= 0;
2776 xprt
->idle_timeout
= 0;
2778 xprt
->ops
= &bc_tcp_ops
;
2780 switch (addr
->sa_family
) {
2782 xs_format_peer_addresses(xprt
, "tcp",
2786 xs_format_peer_addresses(xprt
, "tcp",
2787 RPCBIND_NETID_TCP6
);
2790 ret
= ERR_PTR(-EAFNOSUPPORT
);
2794 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2795 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2796 xprt
->address_strings
[RPC_DISPLAY_PORT
],
2797 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
2800 * Once we've associated a backchannel xprt with a connection,
2801 * we want to keep it around as long as long as the connection
2802 * lasts, in case we need to start using it for a backchannel
2803 * again; this reference won't be dropped until bc_xprt is
2807 args
->bc_xprt
->xpt_bc_xprt
= xprt
;
2808 xprt
->bc_xprt
= args
->bc_xprt
;
2809 bc_sock
= container_of(args
->bc_xprt
, struct svc_sock
, sk_xprt
);
2810 transport
->sock
= bc_sock
->sk_sock
;
2811 transport
->inet
= bc_sock
->sk_sk
;
2814 * Since we don't want connections for the backchannel, we set
2815 * the xprt status to connected
2817 xprt_set_connected(xprt
);
2820 if (try_module_get(THIS_MODULE
))
2823 ret
= ERR_PTR(-EINVAL
);
2829 static struct xprt_class xs_local_transport
= {
2830 .list
= LIST_HEAD_INIT(xs_local_transport
.list
),
2831 .name
= "named UNIX socket",
2832 .owner
= THIS_MODULE
,
2833 .ident
= XPRT_TRANSPORT_LOCAL
,
2834 .setup
= xs_setup_local
,
2837 static struct xprt_class xs_udp_transport
= {
2838 .list
= LIST_HEAD_INIT(xs_udp_transport
.list
),
2840 .owner
= THIS_MODULE
,
2841 .ident
= XPRT_TRANSPORT_UDP
,
2842 .setup
= xs_setup_udp
,
2845 static struct xprt_class xs_tcp_transport
= {
2846 .list
= LIST_HEAD_INIT(xs_tcp_transport
.list
),
2848 .owner
= THIS_MODULE
,
2849 .ident
= XPRT_TRANSPORT_TCP
,
2850 .setup
= xs_setup_tcp
,
2853 static struct xprt_class xs_bc_tcp_transport
= {
2854 .list
= LIST_HEAD_INIT(xs_bc_tcp_transport
.list
),
2855 .name
= "tcp NFSv4.1 backchannel",
2856 .owner
= THIS_MODULE
,
2857 .ident
= XPRT_TRANSPORT_BC_TCP
,
2858 .setup
= xs_setup_bc_tcp
,
2862 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2865 int init_socket_xprt(void)
2868 if (!sunrpc_table_header
)
2869 sunrpc_table_header
= register_sysctl_table(sunrpc_table
);
2872 xprt_register_transport(&xs_local_transport
);
2873 xprt_register_transport(&xs_udp_transport
);
2874 xprt_register_transport(&xs_tcp_transport
);
2875 xprt_register_transport(&xs_bc_tcp_transport
);
2881 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2884 void cleanup_socket_xprt(void)
2887 if (sunrpc_table_header
) {
2888 unregister_sysctl_table(sunrpc_table_header
);
2889 sunrpc_table_header
= NULL
;
2893 xprt_unregister_transport(&xs_local_transport
);
2894 xprt_unregister_transport(&xs_udp_transport
);
2895 xprt_unregister_transport(&xs_tcp_transport
);
2896 xprt_unregister_transport(&xs_bc_tcp_transport
);
2899 static int param_set_uint_minmax(const char *val
,
2900 const struct kernel_param
*kp
,
2901 unsigned int min
, unsigned int max
)
2908 ret
= strict_strtoul(val
, 0, &num
);
2909 if (ret
== -EINVAL
|| num
< min
|| num
> max
)
2911 *((unsigned int *)kp
->arg
) = num
;
2915 static int param_set_portnr(const char *val
, const struct kernel_param
*kp
)
2917 return param_set_uint_minmax(val
, kp
,
2922 static struct kernel_param_ops param_ops_portnr
= {
2923 .set
= param_set_portnr
,
2924 .get
= param_get_uint
,
2927 #define param_check_portnr(name, p) \
2928 __param_check(name, p, unsigned int);
2930 module_param_named(min_resvport
, xprt_min_resvport
, portnr
, 0644);
2931 module_param_named(max_resvport
, xprt_max_resvport
, portnr
, 0644);
2933 static int param_set_slot_table_size(const char *val
,
2934 const struct kernel_param
*kp
)
2936 return param_set_uint_minmax(val
, kp
,
2938 RPC_MAX_SLOT_TABLE
);
2941 static struct kernel_param_ops param_ops_slot_table_size
= {
2942 .set
= param_set_slot_table_size
,
2943 .get
= param_get_uint
,
2946 #define param_check_slot_table_size(name, p) \
2947 __param_check(name, p, unsigned int);
2949 module_param_named(tcp_slot_table_entries
, xprt_tcp_slot_table_entries
,
2950 slot_table_size
, 0644);
2951 module_param_named(udp_slot_table_entries
, xprt_udp_slot_table_entries
,
2952 slot_table_size
, 0644);