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/addr.h>
37 #include <linux/sunrpc/sched.h>
38 #include <linux/sunrpc/svcsock.h>
39 #include <linux/sunrpc/xprtsock.h>
40 #include <linux/file.h>
41 #ifdef CONFIG_SUNRPC_BACKCHANNEL
42 #include <linux/sunrpc/bc_xprt.h>
46 #include <net/checksum.h>
50 #include <trace/events/sunrpc.h>
54 static void xs_close(struct rpc_xprt
*xprt
);
59 static unsigned int xprt_udp_slot_table_entries
= RPC_DEF_SLOT_TABLE
;
60 static unsigned int xprt_tcp_slot_table_entries
= RPC_MIN_SLOT_TABLE
;
61 static unsigned int xprt_max_tcp_slot_table_entries
= RPC_MAX_SLOT_TABLE
;
63 static unsigned int xprt_min_resvport
= RPC_DEF_MIN_RESVPORT
;
64 static unsigned int xprt_max_resvport
= RPC_DEF_MAX_RESVPORT
;
66 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
68 #define XS_TCP_LINGER_TO (15U * HZ)
69 static unsigned int xs_tcp_fin_timeout __read_mostly
= XS_TCP_LINGER_TO
;
72 * We can register our own files under /proc/sys/sunrpc by
73 * calling register_sysctl_table() again. The files in that
74 * directory become the union of all files registered there.
76 * We simply need to make sure that we don't collide with
77 * someone else's file names!
80 static unsigned int min_slot_table_size
= RPC_MIN_SLOT_TABLE
;
81 static unsigned int max_slot_table_size
= RPC_MAX_SLOT_TABLE
;
82 static unsigned int max_tcp_slot_table_limit
= RPC_MAX_SLOT_TABLE_LIMIT
;
83 static unsigned int xprt_min_resvport_limit
= RPC_MIN_RESVPORT
;
84 static unsigned int xprt_max_resvport_limit
= RPC_MAX_RESVPORT
;
86 static struct ctl_table_header
*sunrpc_table_header
;
89 * FIXME: changing the UDP slot table size should also resize the UDP
90 * socket buffers for existing UDP transports
92 static struct ctl_table xs_tunables_table
[] = {
94 .procname
= "udp_slot_table_entries",
95 .data
= &xprt_udp_slot_table_entries
,
96 .maxlen
= sizeof(unsigned int),
98 .proc_handler
= proc_dointvec_minmax
,
99 .extra1
= &min_slot_table_size
,
100 .extra2
= &max_slot_table_size
103 .procname
= "tcp_slot_table_entries",
104 .data
= &xprt_tcp_slot_table_entries
,
105 .maxlen
= sizeof(unsigned int),
107 .proc_handler
= proc_dointvec_minmax
,
108 .extra1
= &min_slot_table_size
,
109 .extra2
= &max_slot_table_size
112 .procname
= "tcp_max_slot_table_entries",
113 .data
= &xprt_max_tcp_slot_table_entries
,
114 .maxlen
= sizeof(unsigned int),
116 .proc_handler
= proc_dointvec_minmax
,
117 .extra1
= &min_slot_table_size
,
118 .extra2
= &max_tcp_slot_table_limit
121 .procname
= "min_resvport",
122 .data
= &xprt_min_resvport
,
123 .maxlen
= sizeof(unsigned int),
125 .proc_handler
= proc_dointvec_minmax
,
126 .extra1
= &xprt_min_resvport_limit
,
127 .extra2
= &xprt_max_resvport
130 .procname
= "max_resvport",
131 .data
= &xprt_max_resvport
,
132 .maxlen
= sizeof(unsigned int),
134 .proc_handler
= proc_dointvec_minmax
,
135 .extra1
= &xprt_min_resvport
,
136 .extra2
= &xprt_max_resvport_limit
139 .procname
= "tcp_fin_timeout",
140 .data
= &xs_tcp_fin_timeout
,
141 .maxlen
= sizeof(xs_tcp_fin_timeout
),
143 .proc_handler
= proc_dointvec_jiffies
,
148 static struct ctl_table sunrpc_table
[] = {
150 .procname
= "sunrpc",
152 .child
= xs_tunables_table
160 * Wait duration for a reply from the RPC portmapper.
162 #define XS_BIND_TO (60U * HZ)
165 * Delay if a UDP socket connect error occurs. This is most likely some
166 * kind of resource problem on the local host.
168 #define XS_UDP_REEST_TO (2U * HZ)
171 * The reestablish timeout allows clients to delay for a bit before attempting
172 * to reconnect to a server that just dropped our connection.
174 * We implement an exponential backoff when trying to reestablish a TCP
175 * transport connection with the server. Some servers like to drop a TCP
176 * connection when they are overworked, so we start with a short timeout and
177 * increase over time if the server is down or not responding.
179 #define XS_TCP_INIT_REEST_TO (3U * HZ)
182 * TCP idle timeout; client drops the transport socket if it is idle
183 * for this long. Note that we also timeout UDP sockets to prevent
184 * holding port numbers when there is no RPC traffic.
186 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
188 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
189 # undef RPC_DEBUG_DATA
190 # define RPCDBG_FACILITY RPCDBG_TRANS
193 #ifdef RPC_DEBUG_DATA
194 static void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
196 u8
*buf
= (u8
*) packet
;
199 dprintk("RPC: %s\n", msg
);
200 for (j
= 0; j
< count
&& j
< 128; j
+= 4) {
204 dprintk("0x%04x ", j
);
206 dprintk("%02x%02x%02x%02x ",
207 buf
[j
], buf
[j
+1], buf
[j
+2], buf
[j
+3]);
212 static inline void xs_pktdump(char *msg
, u32
*packet
, unsigned int count
)
218 static inline struct rpc_xprt
*xprt_from_sock(struct sock
*sk
)
220 return (struct rpc_xprt
*) sk
->sk_user_data
;
223 static inline struct sockaddr
*xs_addr(struct rpc_xprt
*xprt
)
225 return (struct sockaddr
*) &xprt
->addr
;
228 static inline struct sockaddr_un
*xs_addr_un(struct rpc_xprt
*xprt
)
230 return (struct sockaddr_un
*) &xprt
->addr
;
233 static inline struct sockaddr_in
*xs_addr_in(struct rpc_xprt
*xprt
)
235 return (struct sockaddr_in
*) &xprt
->addr
;
238 static inline struct sockaddr_in6
*xs_addr_in6(struct rpc_xprt
*xprt
)
240 return (struct sockaddr_in6
*) &xprt
->addr
;
243 static void xs_format_common_peer_addresses(struct rpc_xprt
*xprt
)
245 struct sockaddr
*sap
= xs_addr(xprt
);
246 struct sockaddr_in6
*sin6
;
247 struct sockaddr_in
*sin
;
248 struct sockaddr_un
*sun
;
251 switch (sap
->sa_family
) {
253 sun
= xs_addr_un(xprt
);
254 strlcpy(buf
, sun
->sun_path
, sizeof(buf
));
255 xprt
->address_strings
[RPC_DISPLAY_ADDR
] =
256 kstrdup(buf
, GFP_KERNEL
);
259 (void)rpc_ntop(sap
, buf
, sizeof(buf
));
260 xprt
->address_strings
[RPC_DISPLAY_ADDR
] =
261 kstrdup(buf
, GFP_KERNEL
);
262 sin
= xs_addr_in(xprt
);
263 snprintf(buf
, sizeof(buf
), "%08x", ntohl(sin
->sin_addr
.s_addr
));
266 (void)rpc_ntop(sap
, buf
, sizeof(buf
));
267 xprt
->address_strings
[RPC_DISPLAY_ADDR
] =
268 kstrdup(buf
, GFP_KERNEL
);
269 sin6
= xs_addr_in6(xprt
);
270 snprintf(buf
, sizeof(buf
), "%pi6", &sin6
->sin6_addr
);
276 xprt
->address_strings
[RPC_DISPLAY_HEX_ADDR
] = kstrdup(buf
, GFP_KERNEL
);
279 static void xs_format_common_peer_ports(struct rpc_xprt
*xprt
)
281 struct sockaddr
*sap
= xs_addr(xprt
);
284 snprintf(buf
, sizeof(buf
), "%u", rpc_get_port(sap
));
285 xprt
->address_strings
[RPC_DISPLAY_PORT
] = kstrdup(buf
, GFP_KERNEL
);
287 snprintf(buf
, sizeof(buf
), "%4hx", rpc_get_port(sap
));
288 xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
] = kstrdup(buf
, GFP_KERNEL
);
291 static void xs_format_peer_addresses(struct rpc_xprt
*xprt
,
292 const char *protocol
,
295 xprt
->address_strings
[RPC_DISPLAY_PROTO
] = protocol
;
296 xprt
->address_strings
[RPC_DISPLAY_NETID
] = netid
;
297 xs_format_common_peer_addresses(xprt
);
298 xs_format_common_peer_ports(xprt
);
301 static void xs_update_peer_port(struct rpc_xprt
*xprt
)
303 kfree(xprt
->address_strings
[RPC_DISPLAY_HEX_PORT
]);
304 kfree(xprt
->address_strings
[RPC_DISPLAY_PORT
]);
306 xs_format_common_peer_ports(xprt
);
309 static void xs_free_peer_addresses(struct rpc_xprt
*xprt
)
313 for (i
= 0; i
< RPC_DISPLAY_MAX
; i
++)
315 case RPC_DISPLAY_PROTO
:
316 case RPC_DISPLAY_NETID
:
319 kfree(xprt
->address_strings
[i
]);
323 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
325 static int xs_send_kvec(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct kvec
*vec
, unsigned int base
, int more
)
327 struct msghdr msg
= {
329 .msg_namelen
= addrlen
,
330 .msg_flags
= XS_SENDMSG_FLAGS
| (more
? MSG_MORE
: 0),
333 .iov_base
= vec
->iov_base
+ base
,
334 .iov_len
= vec
->iov_len
- base
,
337 if (iov
.iov_len
!= 0)
338 return kernel_sendmsg(sock
, &msg
, &iov
, 1, iov
.iov_len
);
339 return kernel_sendmsg(sock
, &msg
, NULL
, 0, 0);
342 static int xs_send_pagedata(struct socket
*sock
, struct xdr_buf
*xdr
, unsigned int base
, int more
, bool zerocopy
, int *sent_p
)
344 ssize_t (*do_sendpage
)(struct socket
*sock
, struct page
*page
,
345 int offset
, size_t size
, int flags
);
347 unsigned int remainder
;
350 remainder
= xdr
->page_len
- base
;
351 base
+= xdr
->page_base
;
352 ppage
= xdr
->pages
+ (base
>> PAGE_SHIFT
);
354 do_sendpage
= sock
->ops
->sendpage
;
356 do_sendpage
= sock_no_sendpage
;
358 unsigned int len
= min_t(unsigned int, PAGE_SIZE
- base
, remainder
);
359 int flags
= XS_SENDMSG_FLAGS
;
365 flags
|= MSG_SENDPAGE_NOTLAST
| MSG_MORE
;
366 err
= do_sendpage(sock
, *ppage
, base
, len
, flags
);
367 if (remainder
== 0 || err
!= len
)
381 * xs_sendpages - write pages directly to a socket
382 * @sock: socket to send on
383 * @addr: UDP only -- address of destination
384 * @addrlen: UDP only -- length of destination address
385 * @xdr: buffer containing this request
386 * @base: starting position in the buffer
387 * @zerocopy: true if it is safe to use sendpage()
388 * @sent_p: return the total number of bytes successfully queued for sending
391 static int xs_sendpages(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
, struct xdr_buf
*xdr
, unsigned int base
, bool zerocopy
, int *sent_p
)
393 unsigned int remainder
= xdr
->len
- base
;
405 if (base
< xdr
->head
[0].iov_len
|| addr
!= NULL
) {
406 unsigned int len
= xdr
->head
[0].iov_len
- base
;
408 err
= xs_send_kvec(sock
, addr
, addrlen
, &xdr
->head
[0], base
, remainder
!= 0);
409 if (remainder
== 0 || err
!= len
)
414 base
-= xdr
->head
[0].iov_len
;
416 if (base
< xdr
->page_len
) {
417 unsigned int len
= xdr
->page_len
- base
;
419 err
= xs_send_pagedata(sock
, xdr
, base
, remainder
!= 0, zerocopy
, &sent
);
421 if (remainder
== 0 || sent
!= len
)
425 base
-= xdr
->page_len
;
427 if (base
>= xdr
->tail
[0].iov_len
)
429 err
= xs_send_kvec(sock
, NULL
, 0, &xdr
->tail
[0], base
, 0);
438 static void xs_nospace_callback(struct rpc_task
*task
)
440 struct sock_xprt
*transport
= container_of(task
->tk_rqstp
->rq_xprt
, struct sock_xprt
, xprt
);
442 transport
->inet
->sk_write_pending
--;
446 * xs_nospace - place task on wait queue if transmit was incomplete
447 * @task: task to put to sleep
450 static int xs_nospace(struct rpc_task
*task
)
452 struct rpc_rqst
*req
= task
->tk_rqstp
;
453 struct rpc_xprt
*xprt
= req
->rq_xprt
;
454 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
455 struct sock
*sk
= transport
->inet
;
458 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
459 task
->tk_pid
, req
->rq_slen
- req
->rq_bytes_sent
,
462 /* Protect against races with write_space */
463 spin_lock_bh(&xprt
->transport_lock
);
465 /* Don't race with disconnect */
466 if (xprt_connected(xprt
)) {
467 /* wait for more buffer space */
468 sk
->sk_write_pending
++;
469 xprt_wait_for_buffer_space(task
, xs_nospace_callback
);
473 spin_unlock_bh(&xprt
->transport_lock
);
475 /* Race breaker in case memory is freed before above code is called */
476 if (ret
== -EAGAIN
) {
477 struct socket_wq
*wq
;
480 wq
= rcu_dereference(sk
->sk_wq
);
481 set_bit(SOCKWQ_ASYNC_NOSPACE
, &wq
->flags
);
484 sk
->sk_write_space(sk
);
490 * Construct a stream transport record marker in @buf.
492 static inline void xs_encode_stream_record_marker(struct xdr_buf
*buf
)
494 u32 reclen
= buf
->len
- sizeof(rpc_fraghdr
);
495 rpc_fraghdr
*base
= buf
->head
[0].iov_base
;
496 *base
= cpu_to_be32(RPC_LAST_STREAM_FRAGMENT
| reclen
);
500 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
501 * @task: RPC task that manages the state of an RPC request
504 * 0: The request has been sent
505 * EAGAIN: The socket was blocked, please call again later to
506 * complete the request
507 * ENOTCONN: Caller needs to invoke connect logic then call again
508 * other: Some other error occured, the request was not sent
510 static int xs_local_send_request(struct rpc_task
*task
)
512 struct rpc_rqst
*req
= task
->tk_rqstp
;
513 struct rpc_xprt
*xprt
= req
->rq_xprt
;
514 struct sock_xprt
*transport
=
515 container_of(xprt
, struct sock_xprt
, xprt
);
516 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
520 xs_encode_stream_record_marker(&req
->rq_snd_buf
);
522 xs_pktdump("packet data:",
523 req
->rq_svec
->iov_base
, req
->rq_svec
->iov_len
);
525 status
= xs_sendpages(transport
->sock
, NULL
, 0, xdr
, req
->rq_bytes_sent
,
527 dprintk("RPC: %s(%u) = %d\n",
528 __func__
, xdr
->len
- req
->rq_bytes_sent
, status
);
530 if (status
== -EAGAIN
&& sock_writeable(transport
->inet
))
533 if (likely(sent
> 0) || status
== 0) {
534 req
->rq_bytes_sent
+= sent
;
535 req
->rq_xmit_bytes_sent
+= sent
;
536 if (likely(req
->rq_bytes_sent
>= req
->rq_slen
)) {
537 req
->rq_bytes_sent
= 0;
547 status
= xs_nospace(task
);
550 dprintk("RPC: sendmsg returned unrecognized error %d\n",
561 * xs_udp_send_request - write an RPC request to a UDP socket
562 * @task: address of RPC task that manages the state of an RPC request
565 * 0: The request has been sent
566 * EAGAIN: The socket was blocked, please call again later to
567 * complete the request
568 * ENOTCONN: Caller needs to invoke connect logic then call again
569 * other: Some other error occurred, the request was not sent
571 static int xs_udp_send_request(struct rpc_task
*task
)
573 struct rpc_rqst
*req
= task
->tk_rqstp
;
574 struct rpc_xprt
*xprt
= req
->rq_xprt
;
575 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
576 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
580 xs_pktdump("packet data:",
581 req
->rq_svec
->iov_base
,
582 req
->rq_svec
->iov_len
);
584 if (!xprt_bound(xprt
))
586 status
= xs_sendpages(transport
->sock
, xs_addr(xprt
), xprt
->addrlen
,
587 xdr
, req
->rq_bytes_sent
, true, &sent
);
589 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
590 xdr
->len
- req
->rq_bytes_sent
, status
);
592 /* firewall is blocking us, don't return -EAGAIN or we end up looping */
593 if (status
== -EPERM
)
596 if (status
== -EAGAIN
&& sock_writeable(transport
->inet
))
599 if (sent
> 0 || status
== 0) {
600 req
->rq_xmit_bytes_sent
+= sent
;
601 if (sent
>= req
->rq_slen
)
603 /* Still some bytes left; set up for a retry later. */
611 /* Should we call xs_close() here? */
614 status
= xs_nospace(task
);
621 /* When the server has died, an ICMP port unreachable message
622 * prompts ECONNREFUSED. */
625 dprintk("RPC: sendmsg returned unrecognized error %d\n",
633 * xs_tcp_send_request - write an RPC request to a TCP socket
634 * @task: address of RPC task that manages the state of an RPC request
637 * 0: The request has been sent
638 * EAGAIN: The socket was blocked, please call again later to
639 * complete the request
640 * ENOTCONN: Caller needs to invoke connect logic then call again
641 * other: Some other error occurred, the request was not sent
643 * XXX: In the case of soft timeouts, should we eventually give up
644 * if sendmsg is not able to make progress?
646 static int xs_tcp_send_request(struct rpc_task
*task
)
648 struct rpc_rqst
*req
= task
->tk_rqstp
;
649 struct rpc_xprt
*xprt
= req
->rq_xprt
;
650 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
651 struct xdr_buf
*xdr
= &req
->rq_snd_buf
;
652 bool zerocopy
= true;
653 bool vm_wait
= false;
657 xs_encode_stream_record_marker(&req
->rq_snd_buf
);
659 xs_pktdump("packet data:",
660 req
->rq_svec
->iov_base
,
661 req
->rq_svec
->iov_len
);
662 /* Don't use zero copy if this is a resend. If the RPC call
663 * completes while the socket holds a reference to the pages,
664 * then we may end up resending corrupted data.
666 if (task
->tk_flags
& RPC_TASK_SENT
)
669 /* Continue transmitting the packet/record. We must be careful
670 * to cope with writespace callbacks arriving _after_ we have
671 * called sendmsg(). */
674 status
= xs_sendpages(transport
->sock
, NULL
, 0, xdr
,
675 req
->rq_bytes_sent
, zerocopy
, &sent
);
677 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
678 xdr
->len
- req
->rq_bytes_sent
, status
);
680 /* If we've sent the entire packet, immediately
681 * reset the count of bytes sent. */
682 req
->rq_bytes_sent
+= sent
;
683 req
->rq_xmit_bytes_sent
+= sent
;
684 if (likely(req
->rq_bytes_sent
>= req
->rq_slen
)) {
685 req
->rq_bytes_sent
= 0;
689 WARN_ON_ONCE(sent
== 0 && status
== 0);
691 if (status
== -EAGAIN
) {
693 * Return EAGAIN if we're sure we're hitting the
694 * socket send buffer limits.
696 if (test_bit(SOCK_NOSPACE
, &transport
->sock
->flags
))
699 * Did we hit a memory allocation failure?
705 /* Retry, knowing now that we're below the
706 * socket send buffer limit
720 /* Should we call xs_close() here? */
723 status
= xs_nospace(task
);
733 dprintk("RPC: sendmsg returned unrecognized error %d\n",
741 * xs_tcp_release_xprt - clean up after a tcp transmission
745 * This cleans up if an error causes us to abort the transmission of a request.
746 * In this case, the socket may need to be reset in order to avoid confusing
749 static void xs_tcp_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
751 struct rpc_rqst
*req
;
753 if (task
!= xprt
->snd_task
)
757 req
= task
->tk_rqstp
;
760 if (req
->rq_bytes_sent
== 0)
762 if (req
->rq_bytes_sent
== req
->rq_snd_buf
.len
)
764 set_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
766 xprt_release_xprt(xprt
, task
);
769 static void xs_save_old_callbacks(struct sock_xprt
*transport
, struct sock
*sk
)
771 transport
->old_data_ready
= sk
->sk_data_ready
;
772 transport
->old_state_change
= sk
->sk_state_change
;
773 transport
->old_write_space
= sk
->sk_write_space
;
774 transport
->old_error_report
= sk
->sk_error_report
;
777 static void xs_restore_old_callbacks(struct sock_xprt
*transport
, struct sock
*sk
)
779 sk
->sk_data_ready
= transport
->old_data_ready
;
780 sk
->sk_state_change
= transport
->old_state_change
;
781 sk
->sk_write_space
= transport
->old_write_space
;
782 sk
->sk_error_report
= transport
->old_error_report
;
785 static void xs_sock_reset_state_flags(struct rpc_xprt
*xprt
)
787 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
789 clear_bit(XPRT_SOCK_DATA_READY
, &transport
->sock_state
);
792 static void xs_sock_reset_connection_flags(struct rpc_xprt
*xprt
)
794 smp_mb__before_atomic();
795 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
796 clear_bit(XPRT_CLOSING
, &xprt
->state
);
797 xs_sock_reset_state_flags(xprt
);
798 smp_mb__after_atomic();
801 static void xs_sock_mark_closed(struct rpc_xprt
*xprt
)
803 xs_sock_reset_connection_flags(xprt
);
804 /* Mark transport as closed and wake up all pending tasks */
805 xprt_disconnect_done(xprt
);
809 * xs_error_report - callback to handle TCP socket state errors
812 * Note: we don't call sock_error() since there may be a rpc_task
813 * using the socket, and so we don't want to clear sk->sk_err.
815 static void xs_error_report(struct sock
*sk
)
817 struct rpc_xprt
*xprt
;
820 read_lock_bh(&sk
->sk_callback_lock
);
821 if (!(xprt
= xprt_from_sock(sk
)))
827 /* Is this a reset event? */
828 if (sk
->sk_state
== TCP_CLOSE
)
829 xs_sock_mark_closed(xprt
);
830 dprintk("RPC: xs_error_report client %p, error=%d...\n",
832 trace_rpc_socket_error(xprt
, sk
->sk_socket
, err
);
833 xprt_wake_pending_tasks(xprt
, err
);
835 read_unlock_bh(&sk
->sk_callback_lock
);
838 static void xs_reset_transport(struct sock_xprt
*transport
)
840 struct socket
*sock
= transport
->sock
;
841 struct sock
*sk
= transport
->inet
;
842 struct rpc_xprt
*xprt
= &transport
->xprt
;
847 if (atomic_read(&transport
->xprt
.swapper
))
848 sk_clear_memalloc(sk
);
850 kernel_sock_shutdown(sock
, SHUT_RDWR
);
852 mutex_lock(&transport
->recv_mutex
);
853 write_lock_bh(&sk
->sk_callback_lock
);
854 transport
->inet
= NULL
;
855 transport
->sock
= NULL
;
857 sk
->sk_user_data
= NULL
;
859 xs_restore_old_callbacks(transport
, sk
);
860 xprt_clear_connected(xprt
);
861 write_unlock_bh(&sk
->sk_callback_lock
);
862 xs_sock_reset_connection_flags(xprt
);
863 mutex_unlock(&transport
->recv_mutex
);
865 trace_rpc_socket_close(xprt
, sock
);
870 * xs_close - close a socket
873 * This is used when all requests are complete; ie, no DRC state remains
874 * on the server we want to save.
876 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
877 * xs_reset_transport() zeroing the socket from underneath a writer.
879 static void xs_close(struct rpc_xprt
*xprt
)
881 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
883 dprintk("RPC: xs_close xprt %p\n", xprt
);
885 xs_reset_transport(transport
);
886 xprt
->reestablish_timeout
= 0;
888 xprt_disconnect_done(xprt
);
891 static void xs_inject_disconnect(struct rpc_xprt
*xprt
)
893 dprintk("RPC: injecting transport disconnect on xprt=%p\n",
895 xprt_disconnect_done(xprt
);
898 static void xs_xprt_free(struct rpc_xprt
*xprt
)
900 xs_free_peer_addresses(xprt
);
905 * xs_destroy - prepare to shutdown a transport
906 * @xprt: doomed transport
909 static void xs_destroy(struct rpc_xprt
*xprt
)
911 struct sock_xprt
*transport
= container_of(xprt
,
912 struct sock_xprt
, xprt
);
913 dprintk("RPC: xs_destroy xprt %p\n", xprt
);
915 cancel_delayed_work_sync(&transport
->connect_worker
);
917 cancel_work_sync(&transport
->recv_worker
);
919 module_put(THIS_MODULE
);
922 static int xs_local_copy_to_xdr(struct xdr_buf
*xdr
, struct sk_buff
*skb
)
924 struct xdr_skb_reader desc
= {
926 .offset
= sizeof(rpc_fraghdr
),
927 .count
= skb
->len
- sizeof(rpc_fraghdr
),
930 if (xdr_partial_copy_from_skb(xdr
, 0, &desc
, xdr_skb_read_bits
) < 0)
938 * xs_local_data_read_skb
943 * Currently this assumes we can read the whole reply in a single gulp.
945 static void xs_local_data_read_skb(struct rpc_xprt
*xprt
,
949 struct rpc_task
*task
;
950 struct rpc_rqst
*rovr
;
955 repsize
= skb
->len
- sizeof(rpc_fraghdr
);
957 dprintk("RPC: impossible RPC reply size %d\n", repsize
);
961 /* Copy the XID from the skb... */
962 xp
= skb_header_pointer(skb
, sizeof(rpc_fraghdr
), sizeof(_xid
), &_xid
);
966 /* Look up and lock the request corresponding to the given XID */
967 spin_lock_bh(&xprt
->transport_lock
);
968 rovr
= xprt_lookup_rqst(xprt
, *xp
);
971 task
= rovr
->rq_task
;
973 copied
= rovr
->rq_private_buf
.buflen
;
974 if (copied
> repsize
)
977 if (xs_local_copy_to_xdr(&rovr
->rq_private_buf
, skb
)) {
978 dprintk("RPC: sk_buff copy failed\n");
982 xprt_complete_rqst(task
, copied
);
985 spin_unlock_bh(&xprt
->transport_lock
);
988 static void xs_local_data_receive(struct sock_xprt
*transport
)
994 mutex_lock(&transport
->recv_mutex
);
995 sk
= transport
->inet
;
999 skb
= skb_recv_datagram(sk
, 0, 1, &err
);
1001 xs_local_data_read_skb(&transport
->xprt
, sk
, skb
);
1002 skb_free_datagram(sk
, skb
);
1005 if (!test_and_clear_bit(XPRT_SOCK_DATA_READY
, &transport
->sock_state
))
1009 mutex_unlock(&transport
->recv_mutex
);
1012 static void xs_local_data_receive_workfn(struct work_struct
*work
)
1014 struct sock_xprt
*transport
=
1015 container_of(work
, struct sock_xprt
, recv_worker
);
1016 xs_local_data_receive(transport
);
1020 * xs_udp_data_read_skb - receive callback for UDP sockets
1026 static void xs_udp_data_read_skb(struct rpc_xprt
*xprt
,
1028 struct sk_buff
*skb
)
1030 struct rpc_task
*task
;
1031 struct rpc_rqst
*rovr
;
1032 int repsize
, copied
;
1038 dprintk("RPC: impossible RPC reply size %d!\n", repsize
);
1042 /* Copy the XID from the skb... */
1043 xp
= skb_header_pointer(skb
, 0, sizeof(_xid
), &_xid
);
1047 /* Look up and lock the request corresponding to the given XID */
1048 spin_lock_bh(&xprt
->transport_lock
);
1049 rovr
= xprt_lookup_rqst(xprt
, *xp
);
1052 task
= rovr
->rq_task
;
1054 if ((copied
= rovr
->rq_private_buf
.buflen
) > repsize
)
1057 /* Suck it into the iovec, verify checksum if not done by hw. */
1058 if (csum_partial_copy_to_xdr(&rovr
->rq_private_buf
, skb
)) {
1059 __UDPX_INC_STATS(sk
, UDP_MIB_INERRORS
);
1063 __UDPX_INC_STATS(sk
, UDP_MIB_INDATAGRAMS
);
1065 xprt_adjust_cwnd(xprt
, task
, copied
);
1066 xprt_complete_rqst(task
, copied
);
1069 spin_unlock_bh(&xprt
->transport_lock
);
1072 static void xs_udp_data_receive(struct sock_xprt
*transport
)
1074 struct sk_buff
*skb
;
1078 mutex_lock(&transport
->recv_mutex
);
1079 sk
= transport
->inet
;
1083 skb
= skb_recv_datagram(sk
, 0, 1, &err
);
1085 xs_udp_data_read_skb(&transport
->xprt
, sk
, skb
);
1086 skb_free_datagram_locked(sk
, skb
);
1089 if (!test_and_clear_bit(XPRT_SOCK_DATA_READY
, &transport
->sock_state
))
1093 mutex_unlock(&transport
->recv_mutex
);
1096 static void xs_udp_data_receive_workfn(struct work_struct
*work
)
1098 struct sock_xprt
*transport
=
1099 container_of(work
, struct sock_xprt
, recv_worker
);
1100 xs_udp_data_receive(transport
);
1104 * xs_data_ready - "data ready" callback for UDP sockets
1105 * @sk: socket with data to read
1108 static void xs_data_ready(struct sock
*sk
)
1110 struct rpc_xprt
*xprt
;
1112 read_lock_bh(&sk
->sk_callback_lock
);
1113 dprintk("RPC: xs_data_ready...\n");
1114 xprt
= xprt_from_sock(sk
);
1116 struct sock_xprt
*transport
= container_of(xprt
,
1117 struct sock_xprt
, xprt
);
1118 transport
->old_data_ready(sk
);
1119 /* Any data means we had a useful conversation, so
1120 * then we don't need to delay the next reconnect
1122 if (xprt
->reestablish_timeout
)
1123 xprt
->reestablish_timeout
= 0;
1124 if (!test_and_set_bit(XPRT_SOCK_DATA_READY
, &transport
->sock_state
))
1125 queue_work(xprtiod_workqueue
, &transport
->recv_worker
);
1127 read_unlock_bh(&sk
->sk_callback_lock
);
1131 * Helper function to force a TCP close if the server is sending
1132 * junk and/or it has put us in CLOSE_WAIT
1134 static void xs_tcp_force_close(struct rpc_xprt
*xprt
)
1136 xprt_force_disconnect(xprt
);
1139 static inline void xs_tcp_read_fraghdr(struct rpc_xprt
*xprt
, struct xdr_skb_reader
*desc
)
1141 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1145 p
= ((char *) &transport
->tcp_fraghdr
) + transport
->tcp_offset
;
1146 len
= sizeof(transport
->tcp_fraghdr
) - transport
->tcp_offset
;
1147 used
= xdr_skb_read_bits(desc
, p
, len
);
1148 transport
->tcp_offset
+= used
;
1152 transport
->tcp_reclen
= ntohl(transport
->tcp_fraghdr
);
1153 if (transport
->tcp_reclen
& RPC_LAST_STREAM_FRAGMENT
)
1154 transport
->tcp_flags
|= TCP_RCV_LAST_FRAG
;
1156 transport
->tcp_flags
&= ~TCP_RCV_LAST_FRAG
;
1157 transport
->tcp_reclen
&= RPC_FRAGMENT_SIZE_MASK
;
1159 transport
->tcp_flags
&= ~TCP_RCV_COPY_FRAGHDR
;
1160 transport
->tcp_offset
= 0;
1162 /* Sanity check of the record length */
1163 if (unlikely(transport
->tcp_reclen
< 8)) {
1164 dprintk("RPC: invalid TCP record fragment length\n");
1165 xs_tcp_force_close(xprt
);
1168 dprintk("RPC: reading TCP record fragment of length %d\n",
1169 transport
->tcp_reclen
);
1172 static void xs_tcp_check_fraghdr(struct sock_xprt
*transport
)
1174 if (transport
->tcp_offset
== transport
->tcp_reclen
) {
1175 transport
->tcp_flags
|= TCP_RCV_COPY_FRAGHDR
;
1176 transport
->tcp_offset
= 0;
1177 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
) {
1178 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1179 transport
->tcp_flags
|= TCP_RCV_COPY_XID
;
1180 transport
->tcp_copied
= 0;
1185 static inline void xs_tcp_read_xid(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
1190 len
= sizeof(transport
->tcp_xid
) - transport
->tcp_offset
;
1191 dprintk("RPC: reading XID (%Zu bytes)\n", len
);
1192 p
= ((char *) &transport
->tcp_xid
) + transport
->tcp_offset
;
1193 used
= xdr_skb_read_bits(desc
, p
, len
);
1194 transport
->tcp_offset
+= used
;
1197 transport
->tcp_flags
&= ~TCP_RCV_COPY_XID
;
1198 transport
->tcp_flags
|= TCP_RCV_READ_CALLDIR
;
1199 transport
->tcp_copied
= 4;
1200 dprintk("RPC: reading %s XID %08x\n",
1201 (transport
->tcp_flags
& TCP_RPC_REPLY
) ? "reply for"
1203 ntohl(transport
->tcp_xid
));
1204 xs_tcp_check_fraghdr(transport
);
1207 static inline void xs_tcp_read_calldir(struct sock_xprt
*transport
,
1208 struct xdr_skb_reader
*desc
)
1215 * We want transport->tcp_offset to be 8 at the end of this routine
1216 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1217 * When this function is called for the first time,
1218 * transport->tcp_offset is 4 (after having already read the xid).
1220 offset
= transport
->tcp_offset
- sizeof(transport
->tcp_xid
);
1221 len
= sizeof(transport
->tcp_calldir
) - offset
;
1222 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len
);
1223 p
= ((char *) &transport
->tcp_calldir
) + offset
;
1224 used
= xdr_skb_read_bits(desc
, p
, len
);
1225 transport
->tcp_offset
+= used
;
1228 transport
->tcp_flags
&= ~TCP_RCV_READ_CALLDIR
;
1230 * We don't yet have the XDR buffer, so we will write the calldir
1231 * out after we get the buffer from the 'struct rpc_rqst'
1233 switch (ntohl(transport
->tcp_calldir
)) {
1235 transport
->tcp_flags
|= TCP_RCV_COPY_CALLDIR
;
1236 transport
->tcp_flags
|= TCP_RCV_COPY_DATA
;
1237 transport
->tcp_flags
|= TCP_RPC_REPLY
;
1240 transport
->tcp_flags
|= TCP_RCV_COPY_CALLDIR
;
1241 transport
->tcp_flags
|= TCP_RCV_COPY_DATA
;
1242 transport
->tcp_flags
&= ~TCP_RPC_REPLY
;
1245 dprintk("RPC: invalid request message type\n");
1246 xs_tcp_force_close(&transport
->xprt
);
1248 xs_tcp_check_fraghdr(transport
);
1251 static inline void xs_tcp_read_common(struct rpc_xprt
*xprt
,
1252 struct xdr_skb_reader
*desc
,
1253 struct rpc_rqst
*req
)
1255 struct sock_xprt
*transport
=
1256 container_of(xprt
, struct sock_xprt
, xprt
);
1257 struct xdr_buf
*rcvbuf
;
1261 rcvbuf
= &req
->rq_private_buf
;
1263 if (transport
->tcp_flags
& TCP_RCV_COPY_CALLDIR
) {
1265 * Save the RPC direction in the XDR buffer
1267 memcpy(rcvbuf
->head
[0].iov_base
+ transport
->tcp_copied
,
1268 &transport
->tcp_calldir
,
1269 sizeof(transport
->tcp_calldir
));
1270 transport
->tcp_copied
+= sizeof(transport
->tcp_calldir
);
1271 transport
->tcp_flags
&= ~TCP_RCV_COPY_CALLDIR
;
1275 if (len
> transport
->tcp_reclen
- transport
->tcp_offset
) {
1276 struct xdr_skb_reader my_desc
;
1278 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
1279 memcpy(&my_desc
, desc
, sizeof(my_desc
));
1280 my_desc
.count
= len
;
1281 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
1282 &my_desc
, xdr_skb_read_bits
);
1286 r
= xdr_partial_copy_from_skb(rcvbuf
, transport
->tcp_copied
,
1287 desc
, xdr_skb_read_bits
);
1290 transport
->tcp_copied
+= r
;
1291 transport
->tcp_offset
+= r
;
1294 /* Error when copying to the receive buffer,
1295 * usually because we weren't able to allocate
1296 * additional buffer pages. All we can do now
1297 * is turn off TCP_RCV_COPY_DATA, so the request
1298 * will not receive any additional updates,
1300 * Any remaining data from this record will
1303 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1304 dprintk("RPC: XID %08x truncated request\n",
1305 ntohl(transport
->tcp_xid
));
1306 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1307 "tcp_offset = %u, tcp_reclen = %u\n",
1308 xprt
, transport
->tcp_copied
,
1309 transport
->tcp_offset
, transport
->tcp_reclen
);
1313 dprintk("RPC: XID %08x read %Zd bytes\n",
1314 ntohl(transport
->tcp_xid
), r
);
1315 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1316 "tcp_reclen = %u\n", xprt
, transport
->tcp_copied
,
1317 transport
->tcp_offset
, transport
->tcp_reclen
);
1319 if (transport
->tcp_copied
== req
->rq_private_buf
.buflen
)
1320 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1321 else if (transport
->tcp_offset
== transport
->tcp_reclen
) {
1322 if (transport
->tcp_flags
& TCP_RCV_LAST_FRAG
)
1323 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1328 * Finds the request corresponding to the RPC xid and invokes the common
1329 * tcp read code to read the data.
1331 static inline int xs_tcp_read_reply(struct rpc_xprt
*xprt
,
1332 struct xdr_skb_reader
*desc
)
1334 struct sock_xprt
*transport
=
1335 container_of(xprt
, struct sock_xprt
, xprt
);
1336 struct rpc_rqst
*req
;
1338 dprintk("RPC: read reply XID %08x\n", ntohl(transport
->tcp_xid
));
1340 /* Find and lock the request corresponding to this xid */
1341 spin_lock_bh(&xprt
->transport_lock
);
1342 req
= xprt_lookup_rqst(xprt
, transport
->tcp_xid
);
1344 dprintk("RPC: XID %08x request not found!\n",
1345 ntohl(transport
->tcp_xid
));
1346 spin_unlock_bh(&xprt
->transport_lock
);
1350 xs_tcp_read_common(xprt
, desc
, req
);
1352 if (!(transport
->tcp_flags
& TCP_RCV_COPY_DATA
))
1353 xprt_complete_rqst(req
->rq_task
, transport
->tcp_copied
);
1355 spin_unlock_bh(&xprt
->transport_lock
);
1359 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1361 * Obtains an rpc_rqst previously allocated and invokes the common
1362 * tcp read code to read the data. The result is placed in the callback
1364 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1365 * connection and return -1.
1367 static int xs_tcp_read_callback(struct rpc_xprt
*xprt
,
1368 struct xdr_skb_reader
*desc
)
1370 struct sock_xprt
*transport
=
1371 container_of(xprt
, struct sock_xprt
, xprt
);
1372 struct rpc_rqst
*req
;
1374 /* Look up and lock the request corresponding to the given XID */
1375 spin_lock_bh(&xprt
->transport_lock
);
1376 req
= xprt_lookup_bc_request(xprt
, transport
->tcp_xid
);
1378 spin_unlock_bh(&xprt
->transport_lock
);
1379 printk(KERN_WARNING
"Callback slot table overflowed\n");
1380 xprt_force_disconnect(xprt
);
1384 dprintk("RPC: read callback XID %08x\n", ntohl(req
->rq_xid
));
1385 xs_tcp_read_common(xprt
, desc
, req
);
1387 if (!(transport
->tcp_flags
& TCP_RCV_COPY_DATA
))
1388 xprt_complete_bc_request(req
, transport
->tcp_copied
);
1389 spin_unlock_bh(&xprt
->transport_lock
);
1394 static inline int _xs_tcp_read_data(struct rpc_xprt
*xprt
,
1395 struct xdr_skb_reader
*desc
)
1397 struct sock_xprt
*transport
=
1398 container_of(xprt
, struct sock_xprt
, xprt
);
1400 return (transport
->tcp_flags
& TCP_RPC_REPLY
) ?
1401 xs_tcp_read_reply(xprt
, desc
) :
1402 xs_tcp_read_callback(xprt
, desc
);
1405 static int xs_tcp_bc_up(struct svc_serv
*serv
, struct net
*net
)
1409 ret
= svc_create_xprt(serv
, "tcp-bc", net
, PF_INET
, 0,
1410 SVC_SOCK_ANONYMOUS
);
1416 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt
*xprt
)
1421 static inline int _xs_tcp_read_data(struct rpc_xprt
*xprt
,
1422 struct xdr_skb_reader
*desc
)
1424 return xs_tcp_read_reply(xprt
, desc
);
1426 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1429 * Read data off the transport. This can be either an RPC_CALL or an
1430 * RPC_REPLY. Relay the processing to helper functions.
1432 static void xs_tcp_read_data(struct rpc_xprt
*xprt
,
1433 struct xdr_skb_reader
*desc
)
1435 struct sock_xprt
*transport
=
1436 container_of(xprt
, struct sock_xprt
, xprt
);
1438 if (_xs_tcp_read_data(xprt
, desc
) == 0)
1439 xs_tcp_check_fraghdr(transport
);
1442 * The transport_lock protects the request handling.
1443 * There's no need to hold it to update the tcp_flags.
1445 transport
->tcp_flags
&= ~TCP_RCV_COPY_DATA
;
1449 static inline void xs_tcp_read_discard(struct sock_xprt
*transport
, struct xdr_skb_reader
*desc
)
1453 len
= transport
->tcp_reclen
- transport
->tcp_offset
;
1454 if (len
> desc
->count
)
1457 desc
->offset
+= len
;
1458 transport
->tcp_offset
+= len
;
1459 dprintk("RPC: discarded %Zu bytes\n", len
);
1460 xs_tcp_check_fraghdr(transport
);
1463 static int xs_tcp_data_recv(read_descriptor_t
*rd_desc
, struct sk_buff
*skb
, unsigned int offset
, size_t len
)
1465 struct rpc_xprt
*xprt
= rd_desc
->arg
.data
;
1466 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1467 struct xdr_skb_reader desc
= {
1473 dprintk("RPC: xs_tcp_data_recv started\n");
1475 trace_xs_tcp_data_recv(transport
);
1476 /* Read in a new fragment marker if necessary */
1477 /* Can we ever really expect to get completely empty fragments? */
1478 if (transport
->tcp_flags
& TCP_RCV_COPY_FRAGHDR
) {
1479 xs_tcp_read_fraghdr(xprt
, &desc
);
1482 /* Read in the xid if necessary */
1483 if (transport
->tcp_flags
& TCP_RCV_COPY_XID
) {
1484 xs_tcp_read_xid(transport
, &desc
);
1487 /* Read in the call/reply flag */
1488 if (transport
->tcp_flags
& TCP_RCV_READ_CALLDIR
) {
1489 xs_tcp_read_calldir(transport
, &desc
);
1492 /* Read in the request data */
1493 if (transport
->tcp_flags
& TCP_RCV_COPY_DATA
) {
1494 xs_tcp_read_data(xprt
, &desc
);
1497 /* Skip over any trailing bytes on short reads */
1498 xs_tcp_read_discard(transport
, &desc
);
1499 } while (desc
.count
);
1500 trace_xs_tcp_data_recv(transport
);
1501 dprintk("RPC: xs_tcp_data_recv done\n");
1502 return len
- desc
.count
;
1505 static void xs_tcp_data_receive(struct sock_xprt
*transport
)
1507 struct rpc_xprt
*xprt
= &transport
->xprt
;
1509 read_descriptor_t rd_desc
= {
1510 .count
= 2*1024*1024,
1513 unsigned long total
= 0;
1516 mutex_lock(&transport
->recv_mutex
);
1517 sk
= transport
->inet
;
1521 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1524 read
= tcp_read_sock(sk
, &rd_desc
, xs_tcp_data_recv
);
1526 clear_bit(XPRT_SOCK_DATA_READY
, &transport
->sock_state
);
1528 if (!test_bit(XPRT_SOCK_DATA_READY
, &transport
->sock_state
))
1534 rd_desc
.count
= 65536;
1537 mutex_unlock(&transport
->recv_mutex
);
1538 trace_xs_tcp_data_ready(xprt
, read
, total
);
1541 static void xs_tcp_data_receive_workfn(struct work_struct
*work
)
1543 struct sock_xprt
*transport
=
1544 container_of(work
, struct sock_xprt
, recv_worker
);
1545 xs_tcp_data_receive(transport
);
1549 * xs_tcp_state_change - callback to handle TCP socket state changes
1550 * @sk: socket whose state has changed
1553 static void xs_tcp_state_change(struct sock
*sk
)
1555 struct rpc_xprt
*xprt
;
1556 struct sock_xprt
*transport
;
1558 read_lock_bh(&sk
->sk_callback_lock
);
1559 if (!(xprt
= xprt_from_sock(sk
)))
1561 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt
);
1562 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1563 sk
->sk_state
, xprt_connected(xprt
),
1564 sock_flag(sk
, SOCK_DEAD
),
1565 sock_flag(sk
, SOCK_ZAPPED
),
1568 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1569 trace_rpc_socket_state_change(xprt
, sk
->sk_socket
);
1570 switch (sk
->sk_state
) {
1571 case TCP_ESTABLISHED
:
1572 spin_lock(&xprt
->transport_lock
);
1573 if (!xprt_test_and_set_connected(xprt
)) {
1575 /* Reset TCP record info */
1576 transport
->tcp_offset
= 0;
1577 transport
->tcp_reclen
= 0;
1578 transport
->tcp_copied
= 0;
1579 transport
->tcp_flags
=
1580 TCP_RCV_COPY_FRAGHDR
| TCP_RCV_COPY_XID
;
1581 xprt
->connect_cookie
++;
1582 clear_bit(XPRT_SOCK_CONNECTING
, &transport
->sock_state
);
1583 xprt_clear_connecting(xprt
);
1585 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
1587 spin_unlock(&xprt
->transport_lock
);
1590 /* The client initiated a shutdown of the socket */
1591 xprt
->connect_cookie
++;
1592 xprt
->reestablish_timeout
= 0;
1593 set_bit(XPRT_CLOSING
, &xprt
->state
);
1594 smp_mb__before_atomic();
1595 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1596 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
1597 smp_mb__after_atomic();
1599 case TCP_CLOSE_WAIT
:
1600 /* The server initiated a shutdown of the socket */
1601 xprt
->connect_cookie
++;
1602 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1603 xs_tcp_force_close(xprt
);
1606 * If the server closed down the connection, make sure that
1607 * we back off before reconnecting
1609 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
1610 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
1613 set_bit(XPRT_CLOSING
, &xprt
->state
);
1614 smp_mb__before_atomic();
1615 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
1616 smp_mb__after_atomic();
1619 if (test_and_clear_bit(XPRT_SOCK_CONNECTING
,
1620 &transport
->sock_state
))
1621 xprt_clear_connecting(xprt
);
1622 xs_sock_mark_closed(xprt
);
1625 read_unlock_bh(&sk
->sk_callback_lock
);
1628 static void xs_write_space(struct sock
*sk
)
1630 struct socket_wq
*wq
;
1631 struct rpc_xprt
*xprt
;
1635 clear_bit(SOCK_NOSPACE
, &sk
->sk_socket
->flags
);
1637 if (unlikely(!(xprt
= xprt_from_sock(sk
))))
1640 wq
= rcu_dereference(sk
->sk_wq
);
1641 if (!wq
|| test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE
, &wq
->flags
) == 0)
1644 xprt_write_space(xprt
);
1650 * xs_udp_write_space - callback invoked when socket buffer space
1652 * @sk: socket whose state has changed
1654 * Called when more output buffer space is available for this socket.
1655 * We try not to wake our writers until they can make "significant"
1656 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1657 * with a bunch of small requests.
1659 static void xs_udp_write_space(struct sock
*sk
)
1661 read_lock_bh(&sk
->sk_callback_lock
);
1663 /* from net/core/sock.c:sock_def_write_space */
1664 if (sock_writeable(sk
))
1667 read_unlock_bh(&sk
->sk_callback_lock
);
1671 * xs_tcp_write_space - callback invoked when socket buffer space
1673 * @sk: socket whose state has changed
1675 * Called when more output buffer space is available for this socket.
1676 * We try not to wake our writers until they can make "significant"
1677 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1678 * with a bunch of small requests.
1680 static void xs_tcp_write_space(struct sock
*sk
)
1682 read_lock_bh(&sk
->sk_callback_lock
);
1684 /* from net/core/stream.c:sk_stream_write_space */
1685 if (sk_stream_is_writeable(sk
))
1688 read_unlock_bh(&sk
->sk_callback_lock
);
1691 static void xs_udp_do_set_buffer_size(struct rpc_xprt
*xprt
)
1693 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1694 struct sock
*sk
= transport
->inet
;
1696 if (transport
->rcvsize
) {
1697 sk
->sk_userlocks
|= SOCK_RCVBUF_LOCK
;
1698 sk
->sk_rcvbuf
= transport
->rcvsize
* xprt
->max_reqs
* 2;
1700 if (transport
->sndsize
) {
1701 sk
->sk_userlocks
|= SOCK_SNDBUF_LOCK
;
1702 sk
->sk_sndbuf
= transport
->sndsize
* xprt
->max_reqs
* 2;
1703 sk
->sk_write_space(sk
);
1708 * xs_udp_set_buffer_size - set send and receive limits
1709 * @xprt: generic transport
1710 * @sndsize: requested size of send buffer, in bytes
1711 * @rcvsize: requested size of receive buffer, in bytes
1713 * Set socket send and receive buffer size limits.
1715 static void xs_udp_set_buffer_size(struct rpc_xprt
*xprt
, size_t sndsize
, size_t rcvsize
)
1717 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
1719 transport
->sndsize
= 0;
1721 transport
->sndsize
= sndsize
+ 1024;
1722 transport
->rcvsize
= 0;
1724 transport
->rcvsize
= rcvsize
+ 1024;
1726 xs_udp_do_set_buffer_size(xprt
);
1730 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1731 * @task: task that timed out
1733 * Adjust the congestion window after a retransmit timeout has occurred.
1735 static void xs_udp_timer(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1737 xprt_adjust_cwnd(xprt
, task
, -ETIMEDOUT
);
1740 static unsigned short xs_get_random_port(void)
1742 unsigned short range
= xprt_max_resvport
- xprt_min_resvport
+ 1;
1743 unsigned short rand
= (unsigned short) prandom_u32() % range
;
1744 return rand
+ xprt_min_resvport
;
1748 * xs_set_reuseaddr_port - set the socket's port and address reuse options
1751 * Note that this function has to be called on all sockets that share the
1752 * same port, and it must be called before binding.
1754 static void xs_sock_set_reuseport(struct socket
*sock
)
1758 kernel_setsockopt(sock
, SOL_SOCKET
, SO_REUSEPORT
,
1759 (char *)&opt
, sizeof(opt
));
1762 static unsigned short xs_sock_getport(struct socket
*sock
)
1764 struct sockaddr_storage buf
;
1766 unsigned short port
= 0;
1768 if (kernel_getsockname(sock
, (struct sockaddr
*)&buf
, &buflen
) < 0)
1770 switch (buf
.ss_family
) {
1772 port
= ntohs(((struct sockaddr_in6
*)&buf
)->sin6_port
);
1775 port
= ntohs(((struct sockaddr_in
*)&buf
)->sin_port
);
1782 * xs_set_port - reset the port number in the remote endpoint address
1783 * @xprt: generic transport
1784 * @port: new port number
1787 static void xs_set_port(struct rpc_xprt
*xprt
, unsigned short port
)
1789 dprintk("RPC: setting port for xprt %p to %u\n", xprt
, port
);
1791 rpc_set_port(xs_addr(xprt
), port
);
1792 xs_update_peer_port(xprt
);
1795 static void xs_set_srcport(struct sock_xprt
*transport
, struct socket
*sock
)
1797 if (transport
->srcport
== 0)
1798 transport
->srcport
= xs_sock_getport(sock
);
1801 static unsigned short xs_get_srcport(struct sock_xprt
*transport
)
1803 unsigned short port
= transport
->srcport
;
1805 if (port
== 0 && transport
->xprt
.resvport
)
1806 port
= xs_get_random_port();
1810 static unsigned short xs_next_srcport(struct sock_xprt
*transport
, unsigned short port
)
1812 if (transport
->srcport
!= 0)
1813 transport
->srcport
= 0;
1814 if (!transport
->xprt
.resvport
)
1816 if (port
<= xprt_min_resvport
|| port
> xprt_max_resvport
)
1817 return xprt_max_resvport
;
1820 static int xs_bind(struct sock_xprt
*transport
, struct socket
*sock
)
1822 struct sockaddr_storage myaddr
;
1824 unsigned short port
= xs_get_srcport(transport
);
1825 unsigned short last
;
1828 * If we are asking for any ephemeral port (i.e. port == 0 &&
1829 * transport->xprt.resvport == 0), don't bind. Let the local
1830 * port selection happen implicitly when the socket is used
1831 * (for example at connect time).
1833 * This ensures that we can continue to establish TCP
1834 * connections even when all local ephemeral ports are already
1835 * a part of some TCP connection. This makes no difference
1836 * for UDP sockets, but also doens't harm them.
1838 * If we're asking for any reserved port (i.e. port == 0 &&
1839 * transport->xprt.resvport == 1) xs_get_srcport above will
1840 * ensure that port is non-zero and we will bind as needed.
1845 memcpy(&myaddr
, &transport
->srcaddr
, transport
->xprt
.addrlen
);
1847 rpc_set_port((struct sockaddr
*)&myaddr
, port
);
1848 err
= kernel_bind(sock
, (struct sockaddr
*)&myaddr
,
1849 transport
->xprt
.addrlen
);
1851 transport
->srcport
= port
;
1855 port
= xs_next_srcport(transport
, port
);
1858 } while (err
== -EADDRINUSE
&& nloop
!= 2);
1860 if (myaddr
.ss_family
== AF_INET
)
1861 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__
,
1862 &((struct sockaddr_in
*)&myaddr
)->sin_addr
,
1863 port
, err
? "failed" : "ok", err
);
1865 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__
,
1866 &((struct sockaddr_in6
*)&myaddr
)->sin6_addr
,
1867 port
, err
? "failed" : "ok", err
);
1872 * We don't support autobind on AF_LOCAL sockets
1874 static void xs_local_rpcbind(struct rpc_task
*task
)
1876 xprt_set_bound(task
->tk_xprt
);
1879 static void xs_local_set_port(struct rpc_xprt
*xprt
, unsigned short port
)
1883 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1884 static struct lock_class_key xs_key
[2];
1885 static struct lock_class_key xs_slock_key
[2];
1887 static inline void xs_reclassify_socketu(struct socket
*sock
)
1889 struct sock
*sk
= sock
->sk
;
1891 sock_lock_init_class_and_name(sk
, "slock-AF_LOCAL-RPC",
1892 &xs_slock_key
[1], "sk_lock-AF_LOCAL-RPC", &xs_key
[1]);
1895 static inline void xs_reclassify_socket4(struct socket
*sock
)
1897 struct sock
*sk
= sock
->sk
;
1899 sock_lock_init_class_and_name(sk
, "slock-AF_INET-RPC",
1900 &xs_slock_key
[0], "sk_lock-AF_INET-RPC", &xs_key
[0]);
1903 static inline void xs_reclassify_socket6(struct socket
*sock
)
1905 struct sock
*sk
= sock
->sk
;
1907 sock_lock_init_class_and_name(sk
, "slock-AF_INET6-RPC",
1908 &xs_slock_key
[1], "sk_lock-AF_INET6-RPC", &xs_key
[1]);
1911 static inline void xs_reclassify_socket(int family
, struct socket
*sock
)
1913 if (WARN_ON_ONCE(!sock_allow_reclassification(sock
->sk
)))
1918 xs_reclassify_socketu(sock
);
1921 xs_reclassify_socket4(sock
);
1924 xs_reclassify_socket6(sock
);
1929 static inline void xs_reclassify_socket(int family
, struct socket
*sock
)
1934 static void xs_dummy_setup_socket(struct work_struct
*work
)
1938 static struct socket
*xs_create_sock(struct rpc_xprt
*xprt
,
1939 struct sock_xprt
*transport
, int family
, int type
,
1940 int protocol
, bool reuseport
)
1942 struct socket
*sock
;
1945 err
= __sock_create(xprt
->xprt_net
, family
, type
, protocol
, &sock
, 1);
1947 dprintk("RPC: can't create %d transport socket (%d).\n",
1951 xs_reclassify_socket(family
, sock
);
1954 xs_sock_set_reuseport(sock
);
1956 err
= xs_bind(transport
, sock
);
1964 return ERR_PTR(err
);
1967 static int xs_local_finish_connecting(struct rpc_xprt
*xprt
,
1968 struct socket
*sock
)
1970 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
,
1973 if (!transport
->inet
) {
1974 struct sock
*sk
= sock
->sk
;
1976 write_lock_bh(&sk
->sk_callback_lock
);
1978 xs_save_old_callbacks(transport
, sk
);
1980 sk
->sk_user_data
= xprt
;
1981 sk
->sk_data_ready
= xs_data_ready
;
1982 sk
->sk_write_space
= xs_udp_write_space
;
1983 sock_set_flag(sk
, SOCK_FASYNC
);
1984 sk
->sk_error_report
= xs_error_report
;
1985 sk
->sk_allocation
= GFP_NOIO
;
1987 xprt_clear_connected(xprt
);
1989 /* Reset to new socket */
1990 transport
->sock
= sock
;
1991 transport
->inet
= sk
;
1993 write_unlock_bh(&sk
->sk_callback_lock
);
1996 /* Tell the socket layer to start connecting... */
1997 xprt
->stat
.connect_count
++;
1998 xprt
->stat
.connect_start
= jiffies
;
1999 return kernel_connect(sock
, xs_addr(xprt
), xprt
->addrlen
, 0);
2003 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
2004 * @transport: socket transport to connect
2006 static int xs_local_setup_socket(struct sock_xprt
*transport
)
2008 struct rpc_xprt
*xprt
= &transport
->xprt
;
2009 struct socket
*sock
;
2012 status
= __sock_create(xprt
->xprt_net
, AF_LOCAL
,
2013 SOCK_STREAM
, 0, &sock
, 1);
2015 dprintk("RPC: can't create AF_LOCAL "
2016 "transport socket (%d).\n", -status
);
2019 xs_reclassify_socket(AF_LOCAL
, sock
);
2021 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
2022 xprt
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2024 status
= xs_local_finish_connecting(xprt
, sock
);
2025 trace_rpc_socket_connect(xprt
, sock
, status
);
2028 dprintk("RPC: xprt %p connected to %s\n",
2029 xprt
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2030 xprt_set_connected(xprt
);
2034 dprintk("RPC: xprt %p: socket %s does not exist\n",
2035 xprt
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2038 dprintk("RPC: xprt %p: connection refused for %s\n",
2039 xprt
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2042 printk(KERN_ERR
"%s: unhandled error (%d) connecting to %s\n",
2044 xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2048 xprt_clear_connecting(xprt
);
2049 xprt_wake_pending_tasks(xprt
, status
);
2053 static void xs_local_connect(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
2055 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2058 if (RPC_IS_ASYNC(task
)) {
2060 * We want the AF_LOCAL connect to be resolved in the
2061 * filesystem namespace of the process making the rpc
2062 * call. Thus we connect synchronously.
2064 * If we want to support asynchronous AF_LOCAL calls,
2065 * we'll need to figure out how to pass a namespace to
2068 rpc_exit(task
, -ENOTCONN
);
2071 ret
= xs_local_setup_socket(transport
);
2072 if (ret
&& !RPC_IS_SOFTCONN(task
))
2073 msleep_interruptible(15000);
2076 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2078 * Note that this should be called with XPRT_LOCKED held (or when we otherwise
2079 * know that we have exclusive access to the socket), to guard against
2080 * races with xs_reset_transport.
2082 static void xs_set_memalloc(struct rpc_xprt
*xprt
)
2084 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
,
2088 * If there's no sock, then we have nothing to set. The
2089 * reconnecting process will get it for us.
2091 if (!transport
->inet
)
2093 if (atomic_read(&xprt
->swapper
))
2094 sk_set_memalloc(transport
->inet
);
2098 * xs_enable_swap - Tag this transport as being used for swap.
2099 * @xprt: transport to tag
2101 * Take a reference to this transport on behalf of the rpc_clnt, and
2102 * optionally mark it for swapping if it wasn't already.
2105 xs_enable_swap(struct rpc_xprt
*xprt
)
2107 struct sock_xprt
*xs
= container_of(xprt
, struct sock_xprt
, xprt
);
2109 if (atomic_inc_return(&xprt
->swapper
) != 1)
2111 if (wait_on_bit_lock(&xprt
->state
, XPRT_LOCKED
, TASK_KILLABLE
))
2112 return -ERESTARTSYS
;
2114 sk_set_memalloc(xs
->inet
);
2115 xprt_release_xprt(xprt
, NULL
);
2120 * xs_disable_swap - Untag this transport as being used for swap.
2121 * @xprt: transport to tag
2123 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the
2124 * swapper refcount goes to 0, untag the socket as a memalloc socket.
2127 xs_disable_swap(struct rpc_xprt
*xprt
)
2129 struct sock_xprt
*xs
= container_of(xprt
, struct sock_xprt
, xprt
);
2131 if (!atomic_dec_and_test(&xprt
->swapper
))
2133 if (wait_on_bit_lock(&xprt
->state
, XPRT_LOCKED
, TASK_KILLABLE
))
2136 sk_clear_memalloc(xs
->inet
);
2137 xprt_release_xprt(xprt
, NULL
);
2140 static void xs_set_memalloc(struct rpc_xprt
*xprt
)
2145 xs_enable_swap(struct rpc_xprt
*xprt
)
2151 xs_disable_swap(struct rpc_xprt
*xprt
)
2156 static void xs_udp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
2158 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2160 if (!transport
->inet
) {
2161 struct sock
*sk
= sock
->sk
;
2163 write_lock_bh(&sk
->sk_callback_lock
);
2165 xs_save_old_callbacks(transport
, sk
);
2167 sk
->sk_user_data
= xprt
;
2168 sk
->sk_data_ready
= xs_data_ready
;
2169 sk
->sk_write_space
= xs_udp_write_space
;
2170 sock_set_flag(sk
, SOCK_FASYNC
);
2171 sk
->sk_allocation
= GFP_NOIO
;
2173 xprt_set_connected(xprt
);
2175 /* Reset to new socket */
2176 transport
->sock
= sock
;
2177 transport
->inet
= sk
;
2179 xs_set_memalloc(xprt
);
2181 write_unlock_bh(&sk
->sk_callback_lock
);
2183 xs_udp_do_set_buffer_size(xprt
);
2185 xprt
->stat
.connect_start
= jiffies
;
2188 static void xs_udp_setup_socket(struct work_struct
*work
)
2190 struct sock_xprt
*transport
=
2191 container_of(work
, struct sock_xprt
, connect_worker
.work
);
2192 struct rpc_xprt
*xprt
= &transport
->xprt
;
2193 struct socket
*sock
= transport
->sock
;
2196 sock
= xs_create_sock(xprt
, transport
,
2197 xs_addr(xprt
)->sa_family
, SOCK_DGRAM
,
2198 IPPROTO_UDP
, false);
2202 dprintk("RPC: worker connecting xprt %p via %s to "
2203 "%s (port %s)\n", xprt
,
2204 xprt
->address_strings
[RPC_DISPLAY_PROTO
],
2205 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2206 xprt
->address_strings
[RPC_DISPLAY_PORT
]);
2208 xs_udp_finish_connecting(xprt
, sock
);
2209 trace_rpc_socket_connect(xprt
, sock
, 0);
2212 xprt_unlock_connect(xprt
, transport
);
2213 xprt_clear_connecting(xprt
);
2214 xprt_wake_pending_tasks(xprt
, status
);
2218 * xs_tcp_shutdown - gracefully shut down a TCP socket
2221 * Initiates a graceful shutdown of the TCP socket by calling the
2222 * equivalent of shutdown(SHUT_RDWR);
2224 static void xs_tcp_shutdown(struct rpc_xprt
*xprt
)
2226 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2227 struct socket
*sock
= transport
->sock
;
2231 if (xprt_connected(xprt
)) {
2232 kernel_sock_shutdown(sock
, SHUT_RDWR
);
2233 trace_rpc_socket_shutdown(xprt
, sock
);
2235 xs_reset_transport(transport
);
2238 static int xs_tcp_finish_connecting(struct rpc_xprt
*xprt
, struct socket
*sock
)
2240 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2241 int ret
= -ENOTCONN
;
2243 if (!transport
->inet
) {
2244 struct sock
*sk
= sock
->sk
;
2245 unsigned int keepidle
= xprt
->timeout
->to_initval
/ HZ
;
2246 unsigned int keepcnt
= xprt
->timeout
->to_retries
+ 1;
2247 unsigned int opt_on
= 1;
2249 unsigned int addr_pref
= IPV6_PREFER_SRC_PUBLIC
;
2251 /* TCP Keepalive options */
2252 kernel_setsockopt(sock
, SOL_SOCKET
, SO_KEEPALIVE
,
2253 (char *)&opt_on
, sizeof(opt_on
));
2254 kernel_setsockopt(sock
, SOL_TCP
, TCP_KEEPIDLE
,
2255 (char *)&keepidle
, sizeof(keepidle
));
2256 kernel_setsockopt(sock
, SOL_TCP
, TCP_KEEPINTVL
,
2257 (char *)&keepidle
, sizeof(keepidle
));
2258 kernel_setsockopt(sock
, SOL_TCP
, TCP_KEEPCNT
,
2259 (char *)&keepcnt
, sizeof(keepcnt
));
2261 /* Avoid temporary address, they are bad for long-lived
2262 * connections such as NFS mounts.
2263 * RFC4941, section 3.6 suggests that:
2264 * Individual applications, which have specific
2265 * knowledge about the normal duration of connections,
2266 * MAY override this as appropriate.
2268 kernel_setsockopt(sock
, SOL_IPV6
, IPV6_ADDR_PREFERENCES
,
2269 (char *)&addr_pref
, sizeof(addr_pref
));
2271 /* TCP user timeout (see RFC5482) */
2272 timeo
= jiffies_to_msecs(xprt
->timeout
->to_initval
) *
2273 (xprt
->timeout
->to_retries
+ 1);
2274 kernel_setsockopt(sock
, SOL_TCP
, TCP_USER_TIMEOUT
,
2275 (char *)&timeo
, sizeof(timeo
));
2277 write_lock_bh(&sk
->sk_callback_lock
);
2279 xs_save_old_callbacks(transport
, sk
);
2281 sk
->sk_user_data
= xprt
;
2282 sk
->sk_data_ready
= xs_data_ready
;
2283 sk
->sk_state_change
= xs_tcp_state_change
;
2284 sk
->sk_write_space
= xs_tcp_write_space
;
2285 sock_set_flag(sk
, SOCK_FASYNC
);
2286 sk
->sk_error_report
= xs_error_report
;
2287 sk
->sk_allocation
= GFP_NOIO
;
2289 /* socket options */
2290 sock_reset_flag(sk
, SOCK_LINGER
);
2291 tcp_sk(sk
)->nonagle
|= TCP_NAGLE_OFF
;
2293 xprt_clear_connected(xprt
);
2295 /* Reset to new socket */
2296 transport
->sock
= sock
;
2297 transport
->inet
= sk
;
2299 write_unlock_bh(&sk
->sk_callback_lock
);
2302 if (!xprt_bound(xprt
))
2305 xs_set_memalloc(xprt
);
2307 /* Tell the socket layer to start connecting... */
2308 xprt
->stat
.connect_count
++;
2309 xprt
->stat
.connect_start
= jiffies
;
2310 set_bit(XPRT_SOCK_CONNECTING
, &transport
->sock_state
);
2311 ret
= kernel_connect(sock
, xs_addr(xprt
), xprt
->addrlen
, O_NONBLOCK
);
2314 xs_set_srcport(transport
, sock
);
2317 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
2318 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2320 case -EADDRNOTAVAIL
:
2321 /* Source port number is unavailable. Try a new one! */
2322 transport
->srcport
= 0;
2329 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2331 * Invoked by a work queue tasklet.
2333 static void xs_tcp_setup_socket(struct work_struct
*work
)
2335 struct sock_xprt
*transport
=
2336 container_of(work
, struct sock_xprt
, connect_worker
.work
);
2337 struct socket
*sock
= transport
->sock
;
2338 struct rpc_xprt
*xprt
= &transport
->xprt
;
2342 sock
= xs_create_sock(xprt
, transport
,
2343 xs_addr(xprt
)->sa_family
, SOCK_STREAM
,
2346 status
= PTR_ERR(sock
);
2351 dprintk("RPC: worker connecting xprt %p via %s to "
2352 "%s (port %s)\n", xprt
,
2353 xprt
->address_strings
[RPC_DISPLAY_PROTO
],
2354 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2355 xprt
->address_strings
[RPC_DISPLAY_PORT
]);
2357 status
= xs_tcp_finish_connecting(xprt
, sock
);
2358 trace_rpc_socket_connect(xprt
, sock
, status
);
2359 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2360 xprt
, -status
, xprt_connected(xprt
),
2361 sock
->sk
->sk_state
);
2364 printk("%s: connect returned unhandled error %d\n",
2366 case -EADDRNOTAVAIL
:
2367 /* We're probably in TIME_WAIT. Get rid of existing socket,
2370 xs_tcp_force_close(xprt
);
2375 xprt_unlock_connect(xprt
, transport
);
2378 /* Happens, for instance, if the user specified a link
2379 * local IPv6 address without a scope-id.
2388 * xs_tcp_force_close() wakes tasks with -EIO.
2389 * We need to wake them first to ensure the
2390 * correct error code.
2392 xprt_wake_pending_tasks(xprt
, status
);
2393 xs_tcp_force_close(xprt
);
2398 xprt_unlock_connect(xprt
, transport
);
2399 xprt_clear_connecting(xprt
);
2400 xprt_wake_pending_tasks(xprt
, status
);
2403 static unsigned long xs_reconnect_delay(const struct rpc_xprt
*xprt
)
2405 unsigned long start
, now
= jiffies
;
2407 start
= xprt
->stat
.connect_start
+ xprt
->reestablish_timeout
;
2408 if (time_after(start
, now
))
2413 static void xs_reconnect_backoff(struct rpc_xprt
*xprt
)
2415 xprt
->reestablish_timeout
<<= 1;
2416 if (xprt
->reestablish_timeout
> xprt
->max_reconnect_timeout
)
2417 xprt
->reestablish_timeout
= xprt
->max_reconnect_timeout
;
2418 if (xprt
->reestablish_timeout
< XS_TCP_INIT_REEST_TO
)
2419 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2423 * xs_connect - connect a socket to a remote endpoint
2424 * @xprt: pointer to transport structure
2425 * @task: address of RPC task that manages state of connect request
2427 * TCP: If the remote end dropped the connection, delay reconnecting.
2429 * UDP socket connects are synchronous, but we use a work queue anyway
2430 * to guarantee that even unprivileged user processes can set up a
2431 * socket on a privileged port.
2433 * If a UDP socket connect fails, the delay behavior here prevents
2434 * retry floods (hard mounts).
2436 static void xs_connect(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
2438 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2439 unsigned long delay
= 0;
2441 WARN_ON_ONCE(!xprt_lock_connect(xprt
, task
, transport
));
2443 if (transport
->sock
!= NULL
) {
2444 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2446 xprt
, xprt
->reestablish_timeout
/ HZ
);
2448 /* Start by resetting any existing state */
2449 xs_reset_transport(transport
);
2451 delay
= xs_reconnect_delay(xprt
);
2452 xs_reconnect_backoff(xprt
);
2455 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt
);
2457 queue_delayed_work(xprtiod_workqueue
,
2458 &transport
->connect_worker
,
2463 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2464 * @xprt: rpc_xprt struct containing statistics
2468 static void xs_local_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
2472 if (xprt_connected(xprt
))
2473 idle_time
= (long)(jiffies
- xprt
->last_used
) / HZ
;
2475 seq_printf(seq
, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2476 "%llu %llu %lu %llu %llu\n",
2477 xprt
->stat
.bind_count
,
2478 xprt
->stat
.connect_count
,
2479 xprt
->stat
.connect_time
,
2483 xprt
->stat
.bad_xids
,
2486 xprt
->stat
.max_slots
,
2487 xprt
->stat
.sending_u
,
2488 xprt
->stat
.pending_u
);
2492 * xs_udp_print_stats - display UDP socket-specifc stats
2493 * @xprt: rpc_xprt struct containing statistics
2497 static void xs_udp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
2499 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2501 seq_printf(seq
, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2504 xprt
->stat
.bind_count
,
2507 xprt
->stat
.bad_xids
,
2510 xprt
->stat
.max_slots
,
2511 xprt
->stat
.sending_u
,
2512 xprt
->stat
.pending_u
);
2516 * xs_tcp_print_stats - display TCP socket-specifc stats
2517 * @xprt: rpc_xprt struct containing statistics
2521 static void xs_tcp_print_stats(struct rpc_xprt
*xprt
, struct seq_file
*seq
)
2523 struct sock_xprt
*transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2526 if (xprt_connected(xprt
))
2527 idle_time
= (long)(jiffies
- xprt
->last_used
) / HZ
;
2529 seq_printf(seq
, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2530 "%llu %llu %lu %llu %llu\n",
2532 xprt
->stat
.bind_count
,
2533 xprt
->stat
.connect_count
,
2534 xprt
->stat
.connect_time
,
2538 xprt
->stat
.bad_xids
,
2541 xprt
->stat
.max_slots
,
2542 xprt
->stat
.sending_u
,
2543 xprt
->stat
.pending_u
);
2547 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2548 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2549 * to use the server side send routines.
2551 static int bc_malloc(struct rpc_task
*task
)
2553 struct rpc_rqst
*rqst
= task
->tk_rqstp
;
2554 size_t size
= rqst
->rq_callsize
;
2556 struct rpc_buffer
*buf
;
2558 if (size
> PAGE_SIZE
- sizeof(struct rpc_buffer
)) {
2559 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n",
2564 page
= alloc_page(GFP_KERNEL
);
2568 buf
= page_address(page
);
2569 buf
->len
= PAGE_SIZE
;
2571 rqst
->rq_buffer
= buf
->data
;
2572 rqst
->rq_rbuffer
= (char *)rqst
->rq_buffer
+ rqst
->rq_callsize
;
2577 * Free the space allocated in the bc_alloc routine
2579 static void bc_free(struct rpc_task
*task
)
2581 void *buffer
= task
->tk_rqstp
->rq_buffer
;
2582 struct rpc_buffer
*buf
;
2584 buf
= container_of(buffer
, struct rpc_buffer
, data
);
2585 free_page((unsigned long)buf
);
2589 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2590 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2592 static int bc_sendto(struct rpc_rqst
*req
)
2595 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
2596 struct rpc_xprt
*xprt
= req
->rq_xprt
;
2597 struct sock_xprt
*transport
=
2598 container_of(xprt
, struct sock_xprt
, xprt
);
2599 struct socket
*sock
= transport
->sock
;
2600 unsigned long headoff
;
2601 unsigned long tailoff
;
2603 xs_encode_stream_record_marker(xbufp
);
2605 tailoff
= (unsigned long)xbufp
->tail
[0].iov_base
& ~PAGE_MASK
;
2606 headoff
= (unsigned long)xbufp
->head
[0].iov_base
& ~PAGE_MASK
;
2607 len
= svc_send_common(sock
, xbufp
,
2608 virt_to_page(xbufp
->head
[0].iov_base
), headoff
,
2609 xbufp
->tail
[0].iov_base
, tailoff
);
2611 if (len
!= xbufp
->len
) {
2612 printk(KERN_NOTICE
"Error sending entire callback!\n");
2620 * The send routine. Borrows from svc_send
2622 static int bc_send_request(struct rpc_task
*task
)
2624 struct rpc_rqst
*req
= task
->tk_rqstp
;
2625 struct svc_xprt
*xprt
;
2628 dprintk("sending request with xid: %08x\n", ntohl(req
->rq_xid
));
2630 * Get the server socket associated with this callback xprt
2632 xprt
= req
->rq_xprt
->bc_xprt
;
2635 * Grab the mutex to serialize data as the connection is shared
2636 * with the fore channel
2638 if (!mutex_trylock(&xprt
->xpt_mutex
)) {
2639 rpc_sleep_on(&xprt
->xpt_bc_pending
, task
, NULL
);
2640 if (!mutex_trylock(&xprt
->xpt_mutex
))
2642 rpc_wake_up_queued_task(&xprt
->xpt_bc_pending
, task
);
2644 if (test_bit(XPT_DEAD
, &xprt
->xpt_flags
))
2647 len
= bc_sendto(req
);
2648 mutex_unlock(&xprt
->xpt_mutex
);
2657 * The close routine. Since this is client initiated, we do nothing
2660 static void bc_close(struct rpc_xprt
*xprt
)
2665 * The xprt destroy routine. Again, because this connection is client
2666 * initiated, we do nothing
2669 static void bc_destroy(struct rpc_xprt
*xprt
)
2671 dprintk("RPC: bc_destroy xprt %p\n", xprt
);
2674 module_put(THIS_MODULE
);
2677 static struct rpc_xprt_ops xs_local_ops
= {
2678 .reserve_xprt
= xprt_reserve_xprt
,
2679 .release_xprt
= xs_tcp_release_xprt
,
2680 .alloc_slot
= xprt_alloc_slot
,
2681 .rpcbind
= xs_local_rpcbind
,
2682 .set_port
= xs_local_set_port
,
2683 .connect
= xs_local_connect
,
2684 .buf_alloc
= rpc_malloc
,
2685 .buf_free
= rpc_free
,
2686 .send_request
= xs_local_send_request
,
2687 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
2689 .destroy
= xs_destroy
,
2690 .print_stats
= xs_local_print_stats
,
2691 .enable_swap
= xs_enable_swap
,
2692 .disable_swap
= xs_disable_swap
,
2695 static struct rpc_xprt_ops xs_udp_ops
= {
2696 .set_buffer_size
= xs_udp_set_buffer_size
,
2697 .reserve_xprt
= xprt_reserve_xprt_cong
,
2698 .release_xprt
= xprt_release_xprt_cong
,
2699 .alloc_slot
= xprt_alloc_slot
,
2700 .rpcbind
= rpcb_getport_async
,
2701 .set_port
= xs_set_port
,
2702 .connect
= xs_connect
,
2703 .buf_alloc
= rpc_malloc
,
2704 .buf_free
= rpc_free
,
2705 .send_request
= xs_udp_send_request
,
2706 .set_retrans_timeout
= xprt_set_retrans_timeout_rtt
,
2707 .timer
= xs_udp_timer
,
2708 .release_request
= xprt_release_rqst_cong
,
2710 .destroy
= xs_destroy
,
2711 .print_stats
= xs_udp_print_stats
,
2712 .enable_swap
= xs_enable_swap
,
2713 .disable_swap
= xs_disable_swap
,
2714 .inject_disconnect
= xs_inject_disconnect
,
2717 static struct rpc_xprt_ops xs_tcp_ops
= {
2718 .reserve_xprt
= xprt_reserve_xprt
,
2719 .release_xprt
= xs_tcp_release_xprt
,
2720 .alloc_slot
= xprt_lock_and_alloc_slot
,
2721 .rpcbind
= rpcb_getport_async
,
2722 .set_port
= xs_set_port
,
2723 .connect
= xs_connect
,
2724 .buf_alloc
= rpc_malloc
,
2725 .buf_free
= rpc_free
,
2726 .send_request
= xs_tcp_send_request
,
2727 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
2728 .close
= xs_tcp_shutdown
,
2729 .destroy
= xs_destroy
,
2730 .print_stats
= xs_tcp_print_stats
,
2731 .enable_swap
= xs_enable_swap
,
2732 .disable_swap
= xs_disable_swap
,
2733 .inject_disconnect
= xs_inject_disconnect
,
2734 #ifdef CONFIG_SUNRPC_BACKCHANNEL
2735 .bc_setup
= xprt_setup_bc
,
2736 .bc_up
= xs_tcp_bc_up
,
2737 .bc_maxpayload
= xs_tcp_bc_maxpayload
,
2738 .bc_free_rqst
= xprt_free_bc_rqst
,
2739 .bc_destroy
= xprt_destroy_bc
,
2744 * The rpc_xprt_ops for the server backchannel
2747 static struct rpc_xprt_ops bc_tcp_ops
= {
2748 .reserve_xprt
= xprt_reserve_xprt
,
2749 .release_xprt
= xprt_release_xprt
,
2750 .alloc_slot
= xprt_alloc_slot
,
2751 .buf_alloc
= bc_malloc
,
2752 .buf_free
= bc_free
,
2753 .send_request
= bc_send_request
,
2754 .set_retrans_timeout
= xprt_set_retrans_timeout_def
,
2756 .destroy
= bc_destroy
,
2757 .print_stats
= xs_tcp_print_stats
,
2758 .enable_swap
= xs_enable_swap
,
2759 .disable_swap
= xs_disable_swap
,
2760 .inject_disconnect
= xs_inject_disconnect
,
2763 static int xs_init_anyaddr(const int family
, struct sockaddr
*sap
)
2765 static const struct sockaddr_in sin
= {
2766 .sin_family
= AF_INET
,
2767 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
2769 static const struct sockaddr_in6 sin6
= {
2770 .sin6_family
= AF_INET6
,
2771 .sin6_addr
= IN6ADDR_ANY_INIT
,
2778 memcpy(sap
, &sin
, sizeof(sin
));
2781 memcpy(sap
, &sin6
, sizeof(sin6
));
2784 dprintk("RPC: %s: Bad address family\n", __func__
);
2785 return -EAFNOSUPPORT
;
2790 static struct rpc_xprt
*xs_setup_xprt(struct xprt_create
*args
,
2791 unsigned int slot_table_size
,
2792 unsigned int max_slot_table_size
)
2794 struct rpc_xprt
*xprt
;
2795 struct sock_xprt
*new;
2797 if (args
->addrlen
> sizeof(xprt
->addr
)) {
2798 dprintk("RPC: xs_setup_xprt: address too large\n");
2799 return ERR_PTR(-EBADF
);
2802 xprt
= xprt_alloc(args
->net
, sizeof(*new), slot_table_size
,
2803 max_slot_table_size
);
2805 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2807 return ERR_PTR(-ENOMEM
);
2810 new = container_of(xprt
, struct sock_xprt
, xprt
);
2811 mutex_init(&new->recv_mutex
);
2812 memcpy(&xprt
->addr
, args
->dstaddr
, args
->addrlen
);
2813 xprt
->addrlen
= args
->addrlen
;
2815 memcpy(&new->srcaddr
, args
->srcaddr
, args
->addrlen
);
2818 err
= xs_init_anyaddr(args
->dstaddr
->sa_family
,
2819 (struct sockaddr
*)&new->srcaddr
);
2822 return ERR_PTR(err
);
2829 static const struct rpc_timeout xs_local_default_timeout
= {
2830 .to_initval
= 10 * HZ
,
2831 .to_maxval
= 10 * HZ
,
2836 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2837 * @args: rpc transport creation arguments
2839 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2841 static struct rpc_xprt
*xs_setup_local(struct xprt_create
*args
)
2843 struct sockaddr_un
*sun
= (struct sockaddr_un
*)args
->dstaddr
;
2844 struct sock_xprt
*transport
;
2845 struct rpc_xprt
*xprt
;
2846 struct rpc_xprt
*ret
;
2848 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
,
2849 xprt_max_tcp_slot_table_entries
);
2852 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2855 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
2856 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
2858 xprt
->bind_timeout
= XS_BIND_TO
;
2859 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
2860 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2862 xprt
->ops
= &xs_local_ops
;
2863 xprt
->timeout
= &xs_local_default_timeout
;
2865 INIT_WORK(&transport
->recv_worker
, xs_local_data_receive_workfn
);
2866 INIT_DELAYED_WORK(&transport
->connect_worker
,
2867 xs_dummy_setup_socket
);
2869 switch (sun
->sun_family
) {
2871 if (sun
->sun_path
[0] != '/') {
2872 dprintk("RPC: bad AF_LOCAL address: %s\n",
2874 ret
= ERR_PTR(-EINVAL
);
2877 xprt_set_bound(xprt
);
2878 xs_format_peer_addresses(xprt
, "local", RPCBIND_NETID_LOCAL
);
2879 ret
= ERR_PTR(xs_local_setup_socket(transport
));
2884 ret
= ERR_PTR(-EAFNOSUPPORT
);
2888 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2889 xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2891 if (try_module_get(THIS_MODULE
))
2893 ret
= ERR_PTR(-EINVAL
);
2899 static const struct rpc_timeout xs_udp_default_timeout
= {
2900 .to_initval
= 5 * HZ
,
2901 .to_maxval
= 30 * HZ
,
2902 .to_increment
= 5 * HZ
,
2907 * xs_setup_udp - Set up transport to use a UDP socket
2908 * @args: rpc transport creation arguments
2911 static struct rpc_xprt
*xs_setup_udp(struct xprt_create
*args
)
2913 struct sockaddr
*addr
= args
->dstaddr
;
2914 struct rpc_xprt
*xprt
;
2915 struct sock_xprt
*transport
;
2916 struct rpc_xprt
*ret
;
2918 xprt
= xs_setup_xprt(args
, xprt_udp_slot_table_entries
,
2919 xprt_udp_slot_table_entries
);
2922 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
2924 xprt
->prot
= IPPROTO_UDP
;
2926 /* XXX: header size can vary due to auth type, IPv6, etc. */
2927 xprt
->max_payload
= (1U << 16) - (MAX_HEADER
<< 3);
2929 xprt
->bind_timeout
= XS_BIND_TO
;
2930 xprt
->reestablish_timeout
= XS_UDP_REEST_TO
;
2931 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
2933 xprt
->ops
= &xs_udp_ops
;
2935 xprt
->timeout
= &xs_udp_default_timeout
;
2937 INIT_WORK(&transport
->recv_worker
, xs_udp_data_receive_workfn
);
2938 INIT_DELAYED_WORK(&transport
->connect_worker
, xs_udp_setup_socket
);
2940 switch (addr
->sa_family
) {
2942 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
2943 xprt_set_bound(xprt
);
2945 xs_format_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP
);
2948 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
2949 xprt_set_bound(xprt
);
2951 xs_format_peer_addresses(xprt
, "udp", RPCBIND_NETID_UDP6
);
2954 ret
= ERR_PTR(-EAFNOSUPPORT
);
2958 if (xprt_bound(xprt
))
2959 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2960 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2961 xprt
->address_strings
[RPC_DISPLAY_PORT
],
2962 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
2964 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2965 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
2966 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
2968 if (try_module_get(THIS_MODULE
))
2970 ret
= ERR_PTR(-EINVAL
);
2976 static const struct rpc_timeout xs_tcp_default_timeout
= {
2977 .to_initval
= 60 * HZ
,
2978 .to_maxval
= 60 * HZ
,
2983 * xs_setup_tcp - Set up transport to use a TCP socket
2984 * @args: rpc transport creation arguments
2987 static struct rpc_xprt
*xs_setup_tcp(struct xprt_create
*args
)
2989 struct sockaddr
*addr
= args
->dstaddr
;
2990 struct rpc_xprt
*xprt
;
2991 struct sock_xprt
*transport
;
2992 struct rpc_xprt
*ret
;
2993 unsigned int max_slot_table_size
= xprt_max_tcp_slot_table_entries
;
2995 if (args
->flags
& XPRT_CREATE_INFINITE_SLOTS
)
2996 max_slot_table_size
= RPC_MAX_SLOT_TABLE_LIMIT
;
2998 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
,
2999 max_slot_table_size
);
3002 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
3004 xprt
->prot
= IPPROTO_TCP
;
3005 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
3006 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
3008 xprt
->bind_timeout
= XS_BIND_TO
;
3009 xprt
->reestablish_timeout
= XS_TCP_INIT_REEST_TO
;
3010 xprt
->idle_timeout
= XS_IDLE_DISC_TO
;
3012 xprt
->ops
= &xs_tcp_ops
;
3013 xprt
->timeout
= &xs_tcp_default_timeout
;
3015 xprt
->max_reconnect_timeout
= xprt
->timeout
->to_maxval
;
3017 INIT_WORK(&transport
->recv_worker
, xs_tcp_data_receive_workfn
);
3018 INIT_DELAYED_WORK(&transport
->connect_worker
, xs_tcp_setup_socket
);
3020 switch (addr
->sa_family
) {
3022 if (((struct sockaddr_in
*)addr
)->sin_port
!= htons(0))
3023 xprt_set_bound(xprt
);
3025 xs_format_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP
);
3028 if (((struct sockaddr_in6
*)addr
)->sin6_port
!= htons(0))
3029 xprt_set_bound(xprt
);
3031 xs_format_peer_addresses(xprt
, "tcp", RPCBIND_NETID_TCP6
);
3034 ret
= ERR_PTR(-EAFNOSUPPORT
);
3038 if (xprt_bound(xprt
))
3039 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3040 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
3041 xprt
->address_strings
[RPC_DISPLAY_PORT
],
3042 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
3044 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
3045 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
3046 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
3048 if (try_module_get(THIS_MODULE
))
3050 ret
= ERR_PTR(-EINVAL
);
3057 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
3058 * @args: rpc transport creation arguments
3061 static struct rpc_xprt
*xs_setup_bc_tcp(struct xprt_create
*args
)
3063 struct sockaddr
*addr
= args
->dstaddr
;
3064 struct rpc_xprt
*xprt
;
3065 struct sock_xprt
*transport
;
3066 struct svc_sock
*bc_sock
;
3067 struct rpc_xprt
*ret
;
3069 xprt
= xs_setup_xprt(args
, xprt_tcp_slot_table_entries
,
3070 xprt_tcp_slot_table_entries
);
3073 transport
= container_of(xprt
, struct sock_xprt
, xprt
);
3075 xprt
->prot
= IPPROTO_TCP
;
3076 xprt
->tsh_size
= sizeof(rpc_fraghdr
) / sizeof(u32
);
3077 xprt
->max_payload
= RPC_MAX_FRAGMENT_SIZE
;
3078 xprt
->timeout
= &xs_tcp_default_timeout
;
3081 xprt_set_bound(xprt
);
3082 xprt
->bind_timeout
= 0;
3083 xprt
->reestablish_timeout
= 0;
3084 xprt
->idle_timeout
= 0;
3086 xprt
->ops
= &bc_tcp_ops
;
3088 switch (addr
->sa_family
) {
3090 xs_format_peer_addresses(xprt
, "tcp",
3094 xs_format_peer_addresses(xprt
, "tcp",
3095 RPCBIND_NETID_TCP6
);
3098 ret
= ERR_PTR(-EAFNOSUPPORT
);
3102 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
3103 xprt
->address_strings
[RPC_DISPLAY_ADDR
],
3104 xprt
->address_strings
[RPC_DISPLAY_PORT
],
3105 xprt
->address_strings
[RPC_DISPLAY_PROTO
]);
3108 * Once we've associated a backchannel xprt with a connection,
3109 * we want to keep it around as long as the connection lasts,
3110 * in case we need to start using it for a backchannel again;
3111 * this reference won't be dropped until bc_xprt is destroyed.
3114 args
->bc_xprt
->xpt_bc_xprt
= xprt
;
3115 xprt
->bc_xprt
= args
->bc_xprt
;
3116 bc_sock
= container_of(args
->bc_xprt
, struct svc_sock
, sk_xprt
);
3117 transport
->sock
= bc_sock
->sk_sock
;
3118 transport
->inet
= bc_sock
->sk_sk
;
3121 * Since we don't want connections for the backchannel, we set
3122 * the xprt status to connected
3124 xprt_set_connected(xprt
);
3126 if (try_module_get(THIS_MODULE
))
3129 args
->bc_xprt
->xpt_bc_xprt
= NULL
;
3130 args
->bc_xprt
->xpt_bc_xps
= NULL
;
3132 ret
= ERR_PTR(-EINVAL
);
3138 static struct xprt_class xs_local_transport
= {
3139 .list
= LIST_HEAD_INIT(xs_local_transport
.list
),
3140 .name
= "named UNIX socket",
3141 .owner
= THIS_MODULE
,
3142 .ident
= XPRT_TRANSPORT_LOCAL
,
3143 .setup
= xs_setup_local
,
3146 static struct xprt_class xs_udp_transport
= {
3147 .list
= LIST_HEAD_INIT(xs_udp_transport
.list
),
3149 .owner
= THIS_MODULE
,
3150 .ident
= XPRT_TRANSPORT_UDP
,
3151 .setup
= xs_setup_udp
,
3154 static struct xprt_class xs_tcp_transport
= {
3155 .list
= LIST_HEAD_INIT(xs_tcp_transport
.list
),
3157 .owner
= THIS_MODULE
,
3158 .ident
= XPRT_TRANSPORT_TCP
,
3159 .setup
= xs_setup_tcp
,
3162 static struct xprt_class xs_bc_tcp_transport
= {
3163 .list
= LIST_HEAD_INIT(xs_bc_tcp_transport
.list
),
3164 .name
= "tcp NFSv4.1 backchannel",
3165 .owner
= THIS_MODULE
,
3166 .ident
= XPRT_TRANSPORT_BC_TCP
,
3167 .setup
= xs_setup_bc_tcp
,
3171 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
3174 int init_socket_xprt(void)
3176 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
3177 if (!sunrpc_table_header
)
3178 sunrpc_table_header
= register_sysctl_table(sunrpc_table
);
3181 xprt_register_transport(&xs_local_transport
);
3182 xprt_register_transport(&xs_udp_transport
);
3183 xprt_register_transport(&xs_tcp_transport
);
3184 xprt_register_transport(&xs_bc_tcp_transport
);
3190 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
3193 void cleanup_socket_xprt(void)
3195 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
3196 if (sunrpc_table_header
) {
3197 unregister_sysctl_table(sunrpc_table_header
);
3198 sunrpc_table_header
= NULL
;
3202 xprt_unregister_transport(&xs_local_transport
);
3203 xprt_unregister_transport(&xs_udp_transport
);
3204 xprt_unregister_transport(&xs_tcp_transport
);
3205 xprt_unregister_transport(&xs_bc_tcp_transport
);
3208 static int param_set_uint_minmax(const char *val
,
3209 const struct kernel_param
*kp
,
3210 unsigned int min
, unsigned int max
)
3217 ret
= kstrtouint(val
, 0, &num
);
3218 if (ret
== -EINVAL
|| num
< min
|| num
> max
)
3220 *((unsigned int *)kp
->arg
) = num
;
3224 static int param_set_portnr(const char *val
, const struct kernel_param
*kp
)
3226 if (kp
->arg
== &xprt_min_resvport
)
3227 return param_set_uint_minmax(val
, kp
,
3230 return param_set_uint_minmax(val
, kp
,
3235 static const struct kernel_param_ops param_ops_portnr
= {
3236 .set
= param_set_portnr
,
3237 .get
= param_get_uint
,
3240 #define param_check_portnr(name, p) \
3241 __param_check(name, p, unsigned int);
3243 module_param_named(min_resvport
, xprt_min_resvport
, portnr
, 0644);
3244 module_param_named(max_resvport
, xprt_max_resvport
, portnr
, 0644);
3246 static int param_set_slot_table_size(const char *val
,
3247 const struct kernel_param
*kp
)
3249 return param_set_uint_minmax(val
, kp
,
3251 RPC_MAX_SLOT_TABLE
);
3254 static const struct kernel_param_ops param_ops_slot_table_size
= {
3255 .set
= param_set_slot_table_size
,
3256 .get
= param_get_uint
,
3259 #define param_check_slot_table_size(name, p) \
3260 __param_check(name, p, unsigned int);
3262 static int param_set_max_slot_table_size(const char *val
,
3263 const struct kernel_param
*kp
)
3265 return param_set_uint_minmax(val
, kp
,
3267 RPC_MAX_SLOT_TABLE_LIMIT
);
3270 static const struct kernel_param_ops param_ops_max_slot_table_size
= {
3271 .set
= param_set_max_slot_table_size
,
3272 .get
= param_get_uint
,
3275 #define param_check_max_slot_table_size(name, p) \
3276 __param_check(name, p, unsigned int);
3278 module_param_named(tcp_slot_table_entries
, xprt_tcp_slot_table_entries
,
3279 slot_table_size
, 0644);
3280 module_param_named(tcp_max_slot_table_entries
, xprt_max_tcp_slot_table_entries
,
3281 max_slot_table_size
, 0644);
3282 module_param_named(udp_slot_table_entries
, xprt_udp_slot_table_entries
,
3283 slot_table_size
, 0644);