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>
52 static void xs_close(struct rpc_xprt *xprt);
57 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
58 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
59 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
61 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
62 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
64 #define XS_TCP_LINGER_TO (15U * HZ)
65 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
68 * We can register our own files under /proc/sys/sunrpc by
69 * calling register_sysctl_table() again. The files in that
70 * directory become the union of all files registered there.
72 * We simply need to make sure that we don't collide with
73 * someone else's file names!
78 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
79 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
80 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
81 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
82 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
84 static struct ctl_table_header *sunrpc_table_header;
87 * FIXME: changing the UDP slot table size should also resize the UDP
88 * socket buffers for existing UDP transports
90 static ctl_table xs_tunables_table[] = {
92 .procname = "udp_slot_table_entries",
93 .data = &xprt_udp_slot_table_entries,
94 .maxlen = sizeof(unsigned int),
96 .proc_handler = proc_dointvec_minmax,
97 .extra1 = &min_slot_table_size,
98 .extra2 = &max_slot_table_size
101 .procname = "tcp_slot_table_entries",
102 .data = &xprt_tcp_slot_table_entries,
103 .maxlen = sizeof(unsigned int),
105 .proc_handler = proc_dointvec_minmax,
106 .extra1 = &min_slot_table_size,
107 .extra2 = &max_slot_table_size
110 .procname = "tcp_max_slot_table_entries",
111 .data = &xprt_max_tcp_slot_table_entries,
112 .maxlen = sizeof(unsigned int),
114 .proc_handler = proc_dointvec_minmax,
115 .extra1 = &min_slot_table_size,
116 .extra2 = &max_tcp_slot_table_limit
119 .procname = "min_resvport",
120 .data = &xprt_min_resvport,
121 .maxlen = sizeof(unsigned int),
123 .proc_handler = proc_dointvec_minmax,
124 .extra1 = &xprt_min_resvport_limit,
125 .extra2 = &xprt_max_resvport_limit
128 .procname = "max_resvport",
129 .data = &xprt_max_resvport,
130 .maxlen = sizeof(unsigned int),
132 .proc_handler = proc_dointvec_minmax,
133 .extra1 = &xprt_min_resvport_limit,
134 .extra2 = &xprt_max_resvport_limit
137 .procname = "tcp_fin_timeout",
138 .data = &xs_tcp_fin_timeout,
139 .maxlen = sizeof(xs_tcp_fin_timeout),
141 .proc_handler = proc_dointvec_jiffies,
146 static ctl_table sunrpc_table[] = {
148 .procname = "sunrpc",
150 .child = xs_tunables_table
158 * Wait duration for a reply from the RPC portmapper.
160 #define XS_BIND_TO (60U * HZ)
163 * Delay if a UDP socket connect error occurs. This is most likely some
164 * kind of resource problem on the local host.
166 #define XS_UDP_REEST_TO (2U * HZ)
169 * The reestablish timeout allows clients to delay for a bit before attempting
170 * to reconnect to a server that just dropped our connection.
172 * We implement an exponential backoff when trying to reestablish a TCP
173 * transport connection with the server. Some servers like to drop a TCP
174 * connection when they are overworked, so we start with a short timeout and
175 * increase over time if the server is down or not responding.
177 #define XS_TCP_INIT_REEST_TO (3U * HZ)
178 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
181 * TCP idle timeout; client drops the transport socket if it is idle
182 * for this long. Note that we also timeout UDP sockets to prevent
183 * holding port numbers when there is no RPC traffic.
185 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
188 # undef RPC_DEBUG_DATA
189 # define RPCDBG_FACILITY RPCDBG_TRANS
192 #ifdef RPC_DEBUG_DATA
193 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
195 u8 *buf = (u8 *) packet;
198 dprintk("RPC: %s\n", msg);
199 for (j = 0; j < count && j < 128; j += 4) {
203 dprintk("0x%04x ", j);
205 dprintk("%02x%02x%02x%02x ",
206 buf[j], buf[j+1], buf[j+2], buf[j+3]);
211 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
218 struct rpc_xprt xprt;
223 struct socket * sock;
227 * State of TCP reply receive
236 unsigned long tcp_copied,
240 * Connection of transports
242 struct delayed_work connect_worker;
243 struct sockaddr_storage srcaddr;
244 unsigned short srcport;
247 * UDP socket buffer size parameters
253 * Saved socket callback addresses
255 void (*old_data_ready)(struct sock *, int);
256 void (*old_state_change)(struct sock *);
257 void (*old_write_space)(struct sock *);
261 * TCP receive state flags
263 #define TCP_RCV_LAST_FRAG (1UL << 0)
264 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
265 #define TCP_RCV_COPY_XID (1UL << 2)
266 #define TCP_RCV_COPY_DATA (1UL << 3)
267 #define TCP_RCV_READ_CALLDIR (1UL << 4)
268 #define TCP_RCV_COPY_CALLDIR (1UL << 5)
273 #define TCP_RPC_REPLY (1UL << 6)
275 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
277 return (struct sockaddr *) &xprt->addr;
280 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
282 return (struct sockaddr_un *) &xprt->addr;
285 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
287 return (struct sockaddr_in *) &xprt->addr;
290 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
292 return (struct sockaddr_in6 *) &xprt->addr;
295 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
297 struct sockaddr *sap = xs_addr(xprt);
298 struct sockaddr_in6 *sin6;
299 struct sockaddr_in *sin;
300 struct sockaddr_un *sun;
303 switch (sap->sa_family) {
305 sun = xs_addr_un(xprt);
306 strlcpy(buf, sun->sun_path, sizeof(buf));
307 xprt->address_strings[RPC_DISPLAY_ADDR] =
308 kstrdup(buf, GFP_KERNEL);
311 (void)rpc_ntop(sap, buf, sizeof(buf));
312 xprt->address_strings[RPC_DISPLAY_ADDR] =
313 kstrdup(buf, GFP_KERNEL);
314 sin = xs_addr_in(xprt);
315 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
318 (void)rpc_ntop(sap, buf, sizeof(buf));
319 xprt->address_strings[RPC_DISPLAY_ADDR] =
320 kstrdup(buf, GFP_KERNEL);
321 sin6 = xs_addr_in6(xprt);
322 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
328 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
331 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
333 struct sockaddr *sap = xs_addr(xprt);
336 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
337 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
339 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
340 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
343 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
344 const char *protocol,
347 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
348 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
349 xs_format_common_peer_addresses(xprt);
350 xs_format_common_peer_ports(xprt);
353 static void xs_update_peer_port(struct rpc_xprt *xprt)
355 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
356 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
358 xs_format_common_peer_ports(xprt);
361 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
365 for (i = 0; i < RPC_DISPLAY_MAX; i++)
367 case RPC_DISPLAY_PROTO:
368 case RPC_DISPLAY_NETID:
371 kfree(xprt->address_strings[i]);
375 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
377 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
379 struct msghdr msg = {
381 .msg_namelen = addrlen,
382 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
385 .iov_base = vec->iov_base + base,
386 .iov_len = vec->iov_len - base,
389 if (iov.iov_len != 0)
390 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
391 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
394 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more, bool zerocopy)
396 ssize_t (*do_sendpage)(struct socket *sock, struct page *page,
397 int offset, size_t size, int flags);
399 unsigned int remainder;
402 remainder = xdr->page_len - base;
403 base += xdr->page_base;
404 ppage = xdr->pages + (base >> PAGE_SHIFT);
406 do_sendpage = sock->ops->sendpage;
408 do_sendpage = sock_no_sendpage;
410 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
411 int flags = XS_SENDMSG_FLAGS;
414 if (remainder != 0 || more)
416 err = do_sendpage(sock, *ppage, base, len, flags);
417 if (remainder == 0 || err != len)
431 * xs_sendpages - write pages directly to a socket
432 * @sock: socket to send on
433 * @addr: UDP only -- address of destination
434 * @addrlen: UDP only -- length of destination address
435 * @xdr: buffer containing this request
436 * @base: starting position in the buffer
437 * @zerocopy: true if it is safe to use sendpage()
440 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base, bool zerocopy)
442 unsigned int remainder = xdr->len - base;
448 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
454 if (base < xdr->head[0].iov_len || addr != NULL) {
455 unsigned int len = xdr->head[0].iov_len - base;
457 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
458 if (remainder == 0 || err != len)
463 base -= xdr->head[0].iov_len;
465 if (base < xdr->page_len) {
466 unsigned int len = xdr->page_len - base;
468 err = xs_send_pagedata(sock, xdr, base, remainder != 0, zerocopy);
469 if (remainder == 0 || err != len)
474 base -= xdr->page_len;
476 if (base >= xdr->tail[0].iov_len)
478 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
487 static void xs_nospace_callback(struct rpc_task *task)
489 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
491 transport->inet->sk_write_pending--;
492 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
496 * xs_nospace - place task on wait queue if transmit was incomplete
497 * @task: task to put to sleep
500 static int xs_nospace(struct rpc_task *task)
502 struct rpc_rqst *req = task->tk_rqstp;
503 struct rpc_xprt *xprt = req->rq_xprt;
504 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
507 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
508 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
511 /* Protect against races with write_space */
512 spin_lock_bh(&xprt->transport_lock);
514 /* Don't race with disconnect */
515 if (xprt_connected(xprt)) {
516 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
518 * Notify TCP that we're limited by the application
521 set_bit(SOCK_NOSPACE, &transport->sock->flags);
522 transport->inet->sk_write_pending++;
523 /* ...and wait for more buffer space */
524 xprt_wait_for_buffer_space(task, xs_nospace_callback);
527 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
531 spin_unlock_bh(&xprt->transport_lock);
536 * Construct a stream transport record marker in @buf.
538 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf)
540 u32 reclen = buf->len - sizeof(rpc_fraghdr);
541 rpc_fraghdr *base = buf->head[0].iov_base;
542 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen);
546 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
547 * @task: RPC task that manages the state of an RPC request
550 * 0: The request has been sent
551 * EAGAIN: The socket was blocked, please call again later to
552 * complete the request
553 * ENOTCONN: Caller needs to invoke connect logic then call again
554 * other: Some other error occured, the request was not sent
556 static int xs_local_send_request(struct rpc_task *task)
558 struct rpc_rqst *req = task->tk_rqstp;
559 struct rpc_xprt *xprt = req->rq_xprt;
560 struct sock_xprt *transport =
561 container_of(xprt, struct sock_xprt, xprt);
562 struct xdr_buf *xdr = &req->rq_snd_buf;
565 xs_encode_stream_record_marker(&req->rq_snd_buf);
567 xs_pktdump("packet data:",
568 req->rq_svec->iov_base, req->rq_svec->iov_len);
570 status = xs_sendpages(transport->sock, NULL, 0,
571 xdr, req->rq_bytes_sent, true);
572 dprintk("RPC: %s(%u) = %d\n",
573 __func__, xdr->len - req->rq_bytes_sent, status);
574 if (likely(status >= 0)) {
575 req->rq_bytes_sent += status;
576 req->rq_xmit_bytes_sent += status;
577 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
578 req->rq_bytes_sent = 0;
586 status = xs_nospace(task);
589 dprintk("RPC: sendmsg returned unrecognized error %d\n",
600 * xs_udp_send_request - write an RPC request to a UDP socket
601 * @task: address of RPC task that manages the state of an RPC request
604 * 0: The request has been sent
605 * EAGAIN: The socket was blocked, please call again later to
606 * complete the request
607 * ENOTCONN: Caller needs to invoke connect logic then call again
608 * other: Some other error occurred, the request was not sent
610 static int xs_udp_send_request(struct rpc_task *task)
612 struct rpc_rqst *req = task->tk_rqstp;
613 struct rpc_xprt *xprt = req->rq_xprt;
614 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
615 struct xdr_buf *xdr = &req->rq_snd_buf;
618 xs_pktdump("packet data:",
619 req->rq_svec->iov_base,
620 req->rq_svec->iov_len);
622 if (!xprt_bound(xprt))
624 status = xs_sendpages(transport->sock,
627 req->rq_bytes_sent, true);
629 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
630 xdr->len - req->rq_bytes_sent, status);
633 req->rq_xmit_bytes_sent += status;
634 if (status >= req->rq_slen)
636 /* Still some bytes left; set up for a retry later. */
643 /* Should we call xs_close() here? */
646 status = xs_nospace(task);
649 dprintk("RPC: sendmsg returned unrecognized error %d\n",
654 /* When the server has died, an ICMP port unreachable message
655 * prompts ECONNREFUSED. */
656 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
663 * xs_tcp_shutdown - gracefully shut down a TCP socket
666 * Initiates a graceful shutdown of the TCP socket by calling the
667 * equivalent of shutdown(SHUT_WR);
669 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
671 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
672 struct socket *sock = transport->sock;
675 kernel_sock_shutdown(sock, SHUT_WR);
679 * xs_tcp_send_request - write an RPC request to a TCP socket
680 * @task: address of RPC task that manages the state of an RPC request
683 * 0: The request has been sent
684 * EAGAIN: The socket was blocked, please call again later to
685 * complete the request
686 * ENOTCONN: Caller needs to invoke connect logic then call again
687 * other: Some other error occurred, the request was not sent
689 * XXX: In the case of soft timeouts, should we eventually give up
690 * if sendmsg is not able to make progress?
692 static int xs_tcp_send_request(struct rpc_task *task)
694 struct rpc_rqst *req = task->tk_rqstp;
695 struct rpc_xprt *xprt = req->rq_xprt;
696 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
697 struct xdr_buf *xdr = &req->rq_snd_buf;
698 bool zerocopy = true;
701 xs_encode_stream_record_marker(&req->rq_snd_buf);
703 xs_pktdump("packet data:",
704 req->rq_svec->iov_base,
705 req->rq_svec->iov_len);
706 /* Don't use zero copy if this is a resend. If the RPC call
707 * completes while the socket holds a reference to the pages,
708 * then we may end up resending corrupted data.
710 if (task->tk_flags & RPC_TASK_SENT)
713 /* Continue transmitting the packet/record. We must be careful
714 * to cope with writespace callbacks arriving _after_ we have
715 * called sendmsg(). */
717 status = xs_sendpages(transport->sock,
718 NULL, 0, xdr, req->rq_bytes_sent,
721 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
722 xdr->len - req->rq_bytes_sent, status);
724 if (unlikely(status < 0))
727 /* If we've sent the entire packet, immediately
728 * reset the count of bytes sent. */
729 req->rq_bytes_sent += status;
730 req->rq_xmit_bytes_sent += status;
731 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
732 req->rq_bytes_sent = 0;
745 /* Should we call xs_close() here? */
748 status = xs_nospace(task);
751 dprintk("RPC: sendmsg returned unrecognized error %d\n",
754 xs_tcp_shutdown(xprt);
758 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
765 * xs_tcp_release_xprt - clean up after a tcp transmission
769 * This cleans up if an error causes us to abort the transmission of a request.
770 * In this case, the socket may need to be reset in order to avoid confusing
773 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
775 struct rpc_rqst *req;
777 if (task != xprt->snd_task)
781 req = task->tk_rqstp;
784 if (req->rq_bytes_sent == 0)
786 if (req->rq_bytes_sent == req->rq_snd_buf.len)
788 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
790 xprt_release_xprt(xprt, task);
793 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
795 transport->old_data_ready = sk->sk_data_ready;
796 transport->old_state_change = sk->sk_state_change;
797 transport->old_write_space = sk->sk_write_space;
800 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
802 sk->sk_data_ready = transport->old_data_ready;
803 sk->sk_state_change = transport->old_state_change;
804 sk->sk_write_space = transport->old_write_space;
807 static void xs_reset_transport(struct sock_xprt *transport)
809 struct socket *sock = transport->sock;
810 struct sock *sk = transport->inet;
815 transport->srcport = 0;
817 write_lock_bh(&sk->sk_callback_lock);
818 transport->inet = NULL;
819 transport->sock = NULL;
821 sk->sk_user_data = NULL;
823 xs_restore_old_callbacks(transport, sk);
824 write_unlock_bh(&sk->sk_callback_lock);
832 * xs_close - close a socket
835 * This is used when all requests are complete; ie, no DRC state remains
836 * on the server we want to save.
838 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
839 * xs_reset_transport() zeroing the socket from underneath a writer.
841 static void xs_close(struct rpc_xprt *xprt)
843 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
845 dprintk("RPC: xs_close xprt %p\n", xprt);
847 xs_reset_transport(transport);
848 xprt->reestablish_timeout = 0;
850 smp_mb__before_clear_bit();
851 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
852 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
853 clear_bit(XPRT_CLOSING, &xprt->state);
854 smp_mb__after_clear_bit();
855 xprt_disconnect_done(xprt);
858 static void xs_tcp_close(struct rpc_xprt *xprt)
860 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state))
863 xs_tcp_shutdown(xprt);
866 static void xs_local_destroy(struct rpc_xprt *xprt)
869 xs_free_peer_addresses(xprt);
871 module_put(THIS_MODULE);
875 * xs_destroy - prepare to shutdown a transport
876 * @xprt: doomed transport
879 static void xs_destroy(struct rpc_xprt *xprt)
881 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
883 dprintk("RPC: xs_destroy xprt %p\n", xprt);
885 cancel_delayed_work_sync(&transport->connect_worker);
887 xs_local_destroy(xprt);
890 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
892 return (struct rpc_xprt *) sk->sk_user_data;
895 static int xs_local_copy_to_xdr(struct xdr_buf *xdr, struct sk_buff *skb)
897 struct xdr_skb_reader desc = {
899 .offset = sizeof(rpc_fraghdr),
900 .count = skb->len - sizeof(rpc_fraghdr),
903 if (xdr_partial_copy_from_skb(xdr, 0, &desc, xdr_skb_read_bits) < 0)
911 * xs_local_data_ready - "data ready" callback for AF_LOCAL sockets
912 * @sk: socket with data to read
913 * @len: how much data to read
915 * Currently this assumes we can read the whole reply in a single gulp.
917 static void xs_local_data_ready(struct sock *sk, int len)
919 struct rpc_task *task;
920 struct rpc_xprt *xprt;
921 struct rpc_rqst *rovr;
923 int err, repsize, copied;
927 read_lock_bh(&sk->sk_callback_lock);
928 dprintk("RPC: %s...\n", __func__);
929 xprt = xprt_from_sock(sk);
933 skb = skb_recv_datagram(sk, 0, 1, &err);
937 repsize = skb->len - sizeof(rpc_fraghdr);
939 dprintk("RPC: impossible RPC reply size %d\n", repsize);
943 /* Copy the XID from the skb... */
944 xp = skb_header_pointer(skb, sizeof(rpc_fraghdr), sizeof(_xid), &_xid);
948 /* Look up and lock the request corresponding to the given XID */
949 spin_lock(&xprt->transport_lock);
950 rovr = xprt_lookup_rqst(xprt, *xp);
953 task = rovr->rq_task;
955 copied = rovr->rq_private_buf.buflen;
956 if (copied > repsize)
959 if (xs_local_copy_to_xdr(&rovr->rq_private_buf, skb)) {
960 dprintk("RPC: sk_buff copy failed\n");
964 xprt_complete_rqst(task, copied);
967 spin_unlock(&xprt->transport_lock);
969 skb_free_datagram(sk, skb);
971 read_unlock_bh(&sk->sk_callback_lock);
975 * xs_udp_data_ready - "data ready" callback for UDP sockets
976 * @sk: socket with data to read
977 * @len: how much data to read
980 static void xs_udp_data_ready(struct sock *sk, int len)
982 struct rpc_task *task;
983 struct rpc_xprt *xprt;
984 struct rpc_rqst *rovr;
986 int err, repsize, copied;
990 read_lock_bh(&sk->sk_callback_lock);
991 dprintk("RPC: xs_udp_data_ready...\n");
992 if (!(xprt = xprt_from_sock(sk)))
995 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
998 repsize = skb->len - sizeof(struct udphdr);
1000 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
1004 /* Copy the XID from the skb... */
1005 xp = skb_header_pointer(skb, sizeof(struct udphdr),
1006 sizeof(_xid), &_xid);
1010 /* Look up and lock the request corresponding to the given XID */
1011 spin_lock(&xprt->transport_lock);
1012 rovr = xprt_lookup_rqst(xprt, *xp);
1015 task = rovr->rq_task;
1017 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1020 /* Suck it into the iovec, verify checksum if not done by hw. */
1021 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1022 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
1026 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
1028 xprt_adjust_cwnd(xprt, task, copied);
1029 xprt_complete_rqst(task, copied);
1032 spin_unlock(&xprt->transport_lock);
1034 skb_free_datagram(sk, skb);
1036 read_unlock_bh(&sk->sk_callback_lock);
1040 * Helper function to force a TCP close if the server is sending
1041 * junk and/or it has put us in CLOSE_WAIT
1043 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1045 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1046 xprt_force_disconnect(xprt);
1049 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
1051 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1055 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
1056 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
1057 used = xdr_skb_read_bits(desc, p, len);
1058 transport->tcp_offset += used;
1062 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
1063 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
1064 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
1066 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
1067 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
1069 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
1070 transport->tcp_offset = 0;
1072 /* Sanity check of the record length */
1073 if (unlikely(transport->tcp_reclen < 8)) {
1074 dprintk("RPC: invalid TCP record fragment length\n");
1075 xs_tcp_force_close(xprt);
1078 dprintk("RPC: reading TCP record fragment of length %d\n",
1079 transport->tcp_reclen);
1082 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
1084 if (transport->tcp_offset == transport->tcp_reclen) {
1085 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
1086 transport->tcp_offset = 0;
1087 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
1088 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1089 transport->tcp_flags |= TCP_RCV_COPY_XID;
1090 transport->tcp_copied = 0;
1095 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1100 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
1101 dprintk("RPC: reading XID (%Zu bytes)\n", len);
1102 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
1103 used = xdr_skb_read_bits(desc, p, len);
1104 transport->tcp_offset += used;
1107 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
1108 transport->tcp_flags |= TCP_RCV_READ_CALLDIR;
1109 transport->tcp_copied = 4;
1110 dprintk("RPC: reading %s XID %08x\n",
1111 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
1113 ntohl(transport->tcp_xid));
1114 xs_tcp_check_fraghdr(transport);
1117 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
1118 struct xdr_skb_reader *desc)
1125 * We want transport->tcp_offset to be 8 at the end of this routine
1126 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1127 * When this function is called for the first time,
1128 * transport->tcp_offset is 4 (after having already read the xid).
1130 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
1131 len = sizeof(transport->tcp_calldir) - offset;
1132 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len);
1133 p = ((char *) &transport->tcp_calldir) + offset;
1134 used = xdr_skb_read_bits(desc, p, len);
1135 transport->tcp_offset += used;
1138 transport->tcp_flags &= ~TCP_RCV_READ_CALLDIR;
1140 * We don't yet have the XDR buffer, so we will write the calldir
1141 * out after we get the buffer from the 'struct rpc_rqst'
1143 switch (ntohl(transport->tcp_calldir)) {
1145 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1146 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1147 transport->tcp_flags |= TCP_RPC_REPLY;
1150 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1151 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1152 transport->tcp_flags &= ~TCP_RPC_REPLY;
1155 dprintk("RPC: invalid request message type\n");
1156 xs_tcp_force_close(&transport->xprt);
1158 xs_tcp_check_fraghdr(transport);
1161 static inline void xs_tcp_read_common(struct rpc_xprt *xprt,
1162 struct xdr_skb_reader *desc,
1163 struct rpc_rqst *req)
1165 struct sock_xprt *transport =
1166 container_of(xprt, struct sock_xprt, xprt);
1167 struct xdr_buf *rcvbuf;
1171 rcvbuf = &req->rq_private_buf;
1173 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
1175 * Save the RPC direction in the XDR buffer
1177 memcpy(rcvbuf->head[0].iov_base + transport->tcp_copied,
1178 &transport->tcp_calldir,
1179 sizeof(transport->tcp_calldir));
1180 transport->tcp_copied += sizeof(transport->tcp_calldir);
1181 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
1185 if (len > transport->tcp_reclen - transport->tcp_offset) {
1186 struct xdr_skb_reader my_desc;
1188 len = transport->tcp_reclen - transport->tcp_offset;
1189 memcpy(&my_desc, desc, sizeof(my_desc));
1190 my_desc.count = len;
1191 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1192 &my_desc, xdr_skb_read_bits);
1196 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1197 desc, xdr_skb_read_bits);
1200 transport->tcp_copied += r;
1201 transport->tcp_offset += r;
1204 /* Error when copying to the receive buffer,
1205 * usually because we weren't able to allocate
1206 * additional buffer pages. All we can do now
1207 * is turn off TCP_RCV_COPY_DATA, so the request
1208 * will not receive any additional updates,
1210 * Any remaining data from this record will
1213 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1214 dprintk("RPC: XID %08x truncated request\n",
1215 ntohl(transport->tcp_xid));
1216 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1217 "tcp_offset = %u, tcp_reclen = %u\n",
1218 xprt, transport->tcp_copied,
1219 transport->tcp_offset, transport->tcp_reclen);
1223 dprintk("RPC: XID %08x read %Zd bytes\n",
1224 ntohl(transport->tcp_xid), r);
1225 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1226 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1227 transport->tcp_offset, transport->tcp_reclen);
1229 if (transport->tcp_copied == req->rq_private_buf.buflen)
1230 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1231 else if (transport->tcp_offset == transport->tcp_reclen) {
1232 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1233 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1238 * Finds the request corresponding to the RPC xid and invokes the common
1239 * tcp read code to read the data.
1241 static inline int xs_tcp_read_reply(struct rpc_xprt *xprt,
1242 struct xdr_skb_reader *desc)
1244 struct sock_xprt *transport =
1245 container_of(xprt, struct sock_xprt, xprt);
1246 struct rpc_rqst *req;
1248 dprintk("RPC: read reply XID %08x\n", ntohl(transport->tcp_xid));
1250 /* Find and lock the request corresponding to this xid */
1251 spin_lock(&xprt->transport_lock);
1252 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1254 dprintk("RPC: XID %08x request not found!\n",
1255 ntohl(transport->tcp_xid));
1256 spin_unlock(&xprt->transport_lock);
1260 xs_tcp_read_common(xprt, desc, req);
1262 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1263 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1265 spin_unlock(&xprt->transport_lock);
1269 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1271 * Obtains an rpc_rqst previously allocated and invokes the common
1272 * tcp read code to read the data. The result is placed in the callback
1274 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1275 * connection and return -1.
1277 static inline int xs_tcp_read_callback(struct rpc_xprt *xprt,
1278 struct xdr_skb_reader *desc)
1280 struct sock_xprt *transport =
1281 container_of(xprt, struct sock_xprt, xprt);
1282 struct rpc_rqst *req;
1284 req = xprt_alloc_bc_request(xprt);
1286 printk(KERN_WARNING "Callback slot table overflowed\n");
1287 xprt_force_disconnect(xprt);
1291 req->rq_xid = transport->tcp_xid;
1292 dprintk("RPC: read callback XID %08x\n", ntohl(req->rq_xid));
1293 xs_tcp_read_common(xprt, desc, req);
1295 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA)) {
1296 struct svc_serv *bc_serv = xprt->bc_serv;
1299 * Add callback request to callback list. The callback
1300 * service sleeps on the sv_cb_waitq waiting for new
1301 * requests. Wake it up after adding enqueing the
1304 dprintk("RPC: add callback request to list\n");
1305 spin_lock(&bc_serv->sv_cb_lock);
1306 list_add(&req->rq_bc_list, &bc_serv->sv_cb_list);
1307 spin_unlock(&bc_serv->sv_cb_lock);
1308 wake_up(&bc_serv->sv_cb_waitq);
1311 req->rq_private_buf.len = transport->tcp_copied;
1316 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1317 struct xdr_skb_reader *desc)
1319 struct sock_xprt *transport =
1320 container_of(xprt, struct sock_xprt, xprt);
1322 return (transport->tcp_flags & TCP_RPC_REPLY) ?
1323 xs_tcp_read_reply(xprt, desc) :
1324 xs_tcp_read_callback(xprt, desc);
1327 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1328 struct xdr_skb_reader *desc)
1330 return xs_tcp_read_reply(xprt, desc);
1332 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1335 * Read data off the transport. This can be either an RPC_CALL or an
1336 * RPC_REPLY. Relay the processing to helper functions.
1338 static void xs_tcp_read_data(struct rpc_xprt *xprt,
1339 struct xdr_skb_reader *desc)
1341 struct sock_xprt *transport =
1342 container_of(xprt, struct sock_xprt, xprt);
1344 if (_xs_tcp_read_data(xprt, desc) == 0)
1345 xs_tcp_check_fraghdr(transport);
1348 * The transport_lock protects the request handling.
1349 * There's no need to hold it to update the tcp_flags.
1351 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1355 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1359 len = transport->tcp_reclen - transport->tcp_offset;
1360 if (len > desc->count)
1363 desc->offset += len;
1364 transport->tcp_offset += len;
1365 dprintk("RPC: discarded %Zu bytes\n", len);
1366 xs_tcp_check_fraghdr(transport);
1369 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1371 struct rpc_xprt *xprt = rd_desc->arg.data;
1372 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1373 struct xdr_skb_reader desc = {
1379 dprintk("RPC: xs_tcp_data_recv started\n");
1381 /* Read in a new fragment marker if necessary */
1382 /* Can we ever really expect to get completely empty fragments? */
1383 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1384 xs_tcp_read_fraghdr(xprt, &desc);
1387 /* Read in the xid if necessary */
1388 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1389 xs_tcp_read_xid(transport, &desc);
1392 /* Read in the call/reply flag */
1393 if (transport->tcp_flags & TCP_RCV_READ_CALLDIR) {
1394 xs_tcp_read_calldir(transport, &desc);
1397 /* Read in the request data */
1398 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1399 xs_tcp_read_data(xprt, &desc);
1402 /* Skip over any trailing bytes on short reads */
1403 xs_tcp_read_discard(transport, &desc);
1404 } while (desc.count);
1405 dprintk("RPC: xs_tcp_data_recv done\n");
1406 return len - desc.count;
1410 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1411 * @sk: socket with data to read
1412 * @bytes: how much data to read
1415 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1417 struct rpc_xprt *xprt;
1418 read_descriptor_t rd_desc;
1421 dprintk("RPC: xs_tcp_data_ready...\n");
1423 read_lock_bh(&sk->sk_callback_lock);
1424 if (!(xprt = xprt_from_sock(sk)))
1426 /* Any data means we had a useful conversation, so
1427 * the we don't need to delay the next reconnect
1429 if (xprt->reestablish_timeout)
1430 xprt->reestablish_timeout = 0;
1432 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1433 rd_desc.arg.data = xprt;
1435 rd_desc.count = 65536;
1436 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1439 read_unlock_bh(&sk->sk_callback_lock);
1443 * Do the equivalent of linger/linger2 handling for dealing with
1444 * broken servers that don't close the socket in a timely
1447 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt *xprt,
1448 unsigned long timeout)
1450 struct sock_xprt *transport;
1452 if (xprt_test_and_set_connecting(xprt))
1454 set_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1455 transport = container_of(xprt, struct sock_xprt, xprt);
1456 queue_delayed_work(rpciod_workqueue, &transport->connect_worker,
1460 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt *xprt)
1462 struct sock_xprt *transport;
1464 transport = container_of(xprt, struct sock_xprt, xprt);
1466 if (!test_bit(XPRT_CONNECTION_ABORT, &xprt->state) ||
1467 !cancel_delayed_work(&transport->connect_worker))
1469 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1470 xprt_clear_connecting(xprt);
1473 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1475 smp_mb__before_clear_bit();
1476 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1477 clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1478 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1479 clear_bit(XPRT_CLOSING, &xprt->state);
1480 smp_mb__after_clear_bit();
1483 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
1485 xs_sock_reset_connection_flags(xprt);
1486 /* Mark transport as closed and wake up all pending tasks */
1487 xprt_disconnect_done(xprt);
1491 * xs_tcp_state_change - callback to handle TCP socket state changes
1492 * @sk: socket whose state has changed
1495 static void xs_tcp_state_change(struct sock *sk)
1497 struct rpc_xprt *xprt;
1499 read_lock_bh(&sk->sk_callback_lock);
1500 if (!(xprt = xprt_from_sock(sk)))
1502 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1503 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1504 sk->sk_state, xprt_connected(xprt),
1505 sock_flag(sk, SOCK_DEAD),
1506 sock_flag(sk, SOCK_ZAPPED),
1509 switch (sk->sk_state) {
1510 case TCP_ESTABLISHED:
1511 spin_lock(&xprt->transport_lock);
1512 if (!xprt_test_and_set_connected(xprt)) {
1513 struct sock_xprt *transport = container_of(xprt,
1514 struct sock_xprt, xprt);
1516 /* Reset TCP record info */
1517 transport->tcp_offset = 0;
1518 transport->tcp_reclen = 0;
1519 transport->tcp_copied = 0;
1520 transport->tcp_flags =
1521 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1523 xprt_wake_pending_tasks(xprt, -EAGAIN);
1525 spin_unlock(&xprt->transport_lock);
1528 /* The client initiated a shutdown of the socket */
1529 xprt->connect_cookie++;
1530 xprt->reestablish_timeout = 0;
1531 set_bit(XPRT_CLOSING, &xprt->state);
1532 smp_mb__before_clear_bit();
1533 clear_bit(XPRT_CONNECTED, &xprt->state);
1534 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1535 smp_mb__after_clear_bit();
1536 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1538 case TCP_CLOSE_WAIT:
1539 /* The server initiated a shutdown of the socket */
1540 xprt->connect_cookie++;
1541 clear_bit(XPRT_CONNECTED, &xprt->state);
1542 xs_tcp_force_close(xprt);
1545 * If the server closed down the connection, make sure that
1546 * we back off before reconnecting
1548 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1549 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1552 set_bit(XPRT_CLOSING, &xprt->state);
1553 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1554 smp_mb__before_clear_bit();
1555 clear_bit(XPRT_CONNECTED, &xprt->state);
1556 smp_mb__after_clear_bit();
1559 xs_tcp_cancel_linger_timeout(xprt);
1560 xs_sock_mark_closed(xprt);
1563 read_unlock_bh(&sk->sk_callback_lock);
1566 static void xs_write_space(struct sock *sk)
1568 struct socket *sock;
1569 struct rpc_xprt *xprt;
1571 if (unlikely(!(sock = sk->sk_socket)))
1573 clear_bit(SOCK_NOSPACE, &sock->flags);
1575 if (unlikely(!(xprt = xprt_from_sock(sk))))
1577 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1580 xprt_write_space(xprt);
1584 * xs_udp_write_space - callback invoked when socket buffer space
1586 * @sk: socket whose state has changed
1588 * Called when more output buffer space is available for this socket.
1589 * We try not to wake our writers until they can make "significant"
1590 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1591 * with a bunch of small requests.
1593 static void xs_udp_write_space(struct sock *sk)
1595 read_lock_bh(&sk->sk_callback_lock);
1597 /* from net/core/sock.c:sock_def_write_space */
1598 if (sock_writeable(sk))
1601 read_unlock_bh(&sk->sk_callback_lock);
1605 * xs_tcp_write_space - callback invoked when socket buffer space
1607 * @sk: socket whose state has changed
1609 * Called when more output buffer space is available for this socket.
1610 * We try not to wake our writers until they can make "significant"
1611 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1612 * with a bunch of small requests.
1614 static void xs_tcp_write_space(struct sock *sk)
1616 read_lock_bh(&sk->sk_callback_lock);
1618 /* from net/core/stream.c:sk_stream_write_space */
1619 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1622 read_unlock_bh(&sk->sk_callback_lock);
1625 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1627 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1628 struct sock *sk = transport->inet;
1630 if (transport->rcvsize) {
1631 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1632 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1634 if (transport->sndsize) {
1635 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1636 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1637 sk->sk_write_space(sk);
1642 * xs_udp_set_buffer_size - set send and receive limits
1643 * @xprt: generic transport
1644 * @sndsize: requested size of send buffer, in bytes
1645 * @rcvsize: requested size of receive buffer, in bytes
1647 * Set socket send and receive buffer size limits.
1649 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1651 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1653 transport->sndsize = 0;
1655 transport->sndsize = sndsize + 1024;
1656 transport->rcvsize = 0;
1658 transport->rcvsize = rcvsize + 1024;
1660 xs_udp_do_set_buffer_size(xprt);
1664 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1665 * @task: task that timed out
1667 * Adjust the congestion window after a retransmit timeout has occurred.
1669 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1671 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1674 static unsigned short xs_get_random_port(void)
1676 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1677 unsigned short rand = (unsigned short) net_random() % range;
1678 return rand + xprt_min_resvport;
1682 * xs_set_port - reset the port number in the remote endpoint address
1683 * @xprt: generic transport
1684 * @port: new port number
1687 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1689 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1691 rpc_set_port(xs_addr(xprt), port);
1692 xs_update_peer_port(xprt);
1695 static unsigned short xs_get_srcport(struct sock_xprt *transport)
1697 unsigned short port = transport->srcport;
1699 if (port == 0 && transport->xprt.resvport)
1700 port = xs_get_random_port();
1704 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1706 if (transport->srcport != 0)
1707 transport->srcport = 0;
1708 if (!transport->xprt.resvport)
1710 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1711 return xprt_max_resvport;
1714 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1716 struct sockaddr_storage myaddr;
1718 unsigned short port = xs_get_srcport(transport);
1719 unsigned short last;
1721 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1723 rpc_set_port((struct sockaddr *)&myaddr, port);
1724 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1725 transport->xprt.addrlen);
1729 transport->srcport = port;
1733 port = xs_next_srcport(transport, port);
1736 } while (err == -EADDRINUSE && nloop != 2);
1738 if (myaddr.ss_family == AF_INET)
1739 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1740 &((struct sockaddr_in *)&myaddr)->sin_addr,
1741 port, err ? "failed" : "ok", err);
1743 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1744 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1745 port, err ? "failed" : "ok", err);
1750 * We don't support autobind on AF_LOCAL sockets
1752 static void xs_local_rpcbind(struct rpc_task *task)
1755 xprt_set_bound(rcu_dereference(task->tk_client->cl_xprt));
1759 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1763 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1764 static struct lock_class_key xs_key[2];
1765 static struct lock_class_key xs_slock_key[2];
1767 static inline void xs_reclassify_socketu(struct socket *sock)
1769 struct sock *sk = sock->sk;
1771 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1772 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1775 static inline void xs_reclassify_socket4(struct socket *sock)
1777 struct sock *sk = sock->sk;
1779 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1780 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1783 static inline void xs_reclassify_socket6(struct socket *sock)
1785 struct sock *sk = sock->sk;
1787 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1788 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1791 static inline void xs_reclassify_socket(int family, struct socket *sock)
1793 WARN_ON_ONCE(sock_owned_by_user(sock->sk));
1794 if (sock_owned_by_user(sock->sk))
1799 xs_reclassify_socketu(sock);
1802 xs_reclassify_socket4(sock);
1805 xs_reclassify_socket6(sock);
1810 static inline void xs_reclassify_socketu(struct socket *sock)
1814 static inline void xs_reclassify_socket4(struct socket *sock)
1818 static inline void xs_reclassify_socket6(struct socket *sock)
1822 static inline void xs_reclassify_socket(int family, struct socket *sock)
1827 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1828 struct sock_xprt *transport, int family, int type, int protocol)
1830 struct socket *sock;
1833 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1835 dprintk("RPC: can't create %d transport socket (%d).\n",
1839 xs_reclassify_socket(family, sock);
1841 err = xs_bind(transport, sock);
1849 return ERR_PTR(err);
1852 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1853 struct socket *sock)
1855 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1858 if (!transport->inet) {
1859 struct sock *sk = sock->sk;
1861 write_lock_bh(&sk->sk_callback_lock);
1863 xs_save_old_callbacks(transport, sk);
1865 sk->sk_user_data = xprt;
1866 sk->sk_data_ready = xs_local_data_ready;
1867 sk->sk_write_space = xs_udp_write_space;
1868 sk->sk_allocation = GFP_ATOMIC;
1870 xprt_clear_connected(xprt);
1872 /* Reset to new socket */
1873 transport->sock = sock;
1874 transport->inet = sk;
1876 write_unlock_bh(&sk->sk_callback_lock);
1879 /* Tell the socket layer to start connecting... */
1880 xprt->stat.connect_count++;
1881 xprt->stat.connect_start = jiffies;
1882 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1886 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1887 * @xprt: RPC transport to connect
1888 * @transport: socket transport to connect
1889 * @create_sock: function to create a socket of the correct type
1891 static int xs_local_setup_socket(struct sock_xprt *transport)
1893 struct rpc_xprt *xprt = &transport->xprt;
1894 struct socket *sock;
1897 current->flags |= PF_FSTRANS;
1899 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1900 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1901 SOCK_STREAM, 0, &sock, 1);
1903 dprintk("RPC: can't create AF_LOCAL "
1904 "transport socket (%d).\n", -status);
1907 xs_reclassify_socketu(sock);
1909 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1910 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1912 status = xs_local_finish_connecting(xprt, sock);
1915 dprintk("RPC: xprt %p connected to %s\n",
1916 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1917 xprt_set_connected(xprt);
1920 dprintk("RPC: xprt %p: socket %s does not exist\n",
1921 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1924 dprintk("RPC: xprt %p: connection refused for %s\n",
1925 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1928 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1930 xprt->address_strings[RPC_DISPLAY_ADDR]);
1934 xprt_clear_connecting(xprt);
1935 xprt_wake_pending_tasks(xprt, status);
1936 current->flags &= ~PF_FSTRANS;
1940 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1942 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1945 if (RPC_IS_ASYNC(task)) {
1947 * We want the AF_LOCAL connect to be resolved in the
1948 * filesystem namespace of the process making the rpc
1949 * call. Thus we connect synchronously.
1951 * If we want to support asynchronous AF_LOCAL calls,
1952 * we'll need to figure out how to pass a namespace to
1955 rpc_exit(task, -ENOTCONN);
1958 ret = xs_local_setup_socket(transport);
1959 if (ret && !RPC_IS_SOFTCONN(task))
1960 msleep_interruptible(15000);
1963 #ifdef CONFIG_SUNRPC_SWAP
1964 static void xs_set_memalloc(struct rpc_xprt *xprt)
1966 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1970 sk_set_memalloc(transport->inet);
1974 * xs_swapper - Tag this transport as being used for swap.
1975 * @xprt: transport to tag
1976 * @enable: enable/disable
1979 int xs_swapper(struct rpc_xprt *xprt, int enable)
1981 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1987 xs_set_memalloc(xprt);
1988 } else if (xprt->swapper) {
1990 sk_clear_memalloc(transport->inet);
1995 EXPORT_SYMBOL_GPL(xs_swapper);
1997 static void xs_set_memalloc(struct rpc_xprt *xprt)
2002 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2004 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2006 if (!transport->inet) {
2007 struct sock *sk = sock->sk;
2009 write_lock_bh(&sk->sk_callback_lock);
2011 xs_save_old_callbacks(transport, sk);
2013 sk->sk_user_data = xprt;
2014 sk->sk_data_ready = xs_udp_data_ready;
2015 sk->sk_write_space = xs_udp_write_space;
2016 sk->sk_no_check = UDP_CSUM_NORCV;
2017 sk->sk_allocation = GFP_ATOMIC;
2019 xprt_set_connected(xprt);
2021 /* Reset to new socket */
2022 transport->sock = sock;
2023 transport->inet = sk;
2025 xs_set_memalloc(xprt);
2027 write_unlock_bh(&sk->sk_callback_lock);
2029 xs_udp_do_set_buffer_size(xprt);
2032 static void xs_udp_setup_socket(struct work_struct *work)
2034 struct sock_xprt *transport =
2035 container_of(work, struct sock_xprt, connect_worker.work);
2036 struct rpc_xprt *xprt = &transport->xprt;
2037 struct socket *sock = transport->sock;
2040 current->flags |= PF_FSTRANS;
2042 /* Start by resetting any existing state */
2043 xs_reset_transport(transport);
2044 sock = xs_create_sock(xprt, transport,
2045 xs_addr(xprt)->sa_family, SOCK_DGRAM, IPPROTO_UDP);
2049 dprintk("RPC: worker connecting xprt %p via %s to "
2050 "%s (port %s)\n", xprt,
2051 xprt->address_strings[RPC_DISPLAY_PROTO],
2052 xprt->address_strings[RPC_DISPLAY_ADDR],
2053 xprt->address_strings[RPC_DISPLAY_PORT]);
2055 xs_udp_finish_connecting(xprt, sock);
2058 xprt_clear_connecting(xprt);
2059 xprt_wake_pending_tasks(xprt, status);
2060 current->flags &= ~PF_FSTRANS;
2064 * We need to preserve the port number so the reply cache on the server can
2065 * find our cached RPC replies when we get around to reconnecting.
2067 static void xs_abort_connection(struct sock_xprt *transport)
2070 struct sockaddr any;
2072 dprintk("RPC: disconnecting xprt %p to reuse port\n", transport);
2075 * Disconnect the transport socket by doing a connect operation
2076 * with AF_UNSPEC. This should return immediately...
2078 memset(&any, 0, sizeof(any));
2079 any.sa_family = AF_UNSPEC;
2080 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
2082 xs_sock_reset_connection_flags(&transport->xprt);
2083 dprintk("RPC: AF_UNSPEC connect return code %d\n", result);
2086 static void xs_tcp_reuse_connection(struct sock_xprt *transport)
2088 unsigned int state = transport->inet->sk_state;
2090 if (state == TCP_CLOSE && transport->sock->state == SS_UNCONNECTED) {
2091 /* we don't need to abort the connection if the socket
2092 * hasn't undergone a shutdown
2094 if (transport->inet->sk_shutdown == 0)
2096 dprintk("RPC: %s: TCP_CLOSEd and sk_shutdown set to %d\n",
2097 __func__, transport->inet->sk_shutdown);
2099 if ((1 << state) & (TCPF_ESTABLISHED|TCPF_SYN_SENT)) {
2100 /* we don't need to abort the connection if the socket
2101 * hasn't undergone a shutdown
2103 if (transport->inet->sk_shutdown == 0)
2105 dprintk("RPC: %s: ESTABLISHED/SYN_SENT "
2106 "sk_shutdown set to %d\n",
2107 __func__, transport->inet->sk_shutdown);
2109 xs_abort_connection(transport);
2112 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2114 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2115 int ret = -ENOTCONN;
2117 if (!transport->inet) {
2118 struct sock *sk = sock->sk;
2120 write_lock_bh(&sk->sk_callback_lock);
2122 xs_save_old_callbacks(transport, sk);
2124 sk->sk_user_data = xprt;
2125 sk->sk_data_ready = xs_tcp_data_ready;
2126 sk->sk_state_change = xs_tcp_state_change;
2127 sk->sk_write_space = xs_tcp_write_space;
2128 sk->sk_allocation = GFP_ATOMIC;
2130 /* socket options */
2131 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
2132 sock_reset_flag(sk, SOCK_LINGER);
2133 tcp_sk(sk)->linger2 = 0;
2134 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2136 xprt_clear_connected(xprt);
2138 /* Reset to new socket */
2139 transport->sock = sock;
2140 transport->inet = sk;
2142 write_unlock_bh(&sk->sk_callback_lock);
2145 if (!xprt_bound(xprt))
2148 xs_set_memalloc(xprt);
2150 /* Tell the socket layer to start connecting... */
2151 xprt->stat.connect_count++;
2152 xprt->stat.connect_start = jiffies;
2153 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2158 xprt->connect_cookie++;
2159 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2160 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2167 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2168 * @xprt: RPC transport to connect
2169 * @transport: socket transport to connect
2170 * @create_sock: function to create a socket of the correct type
2172 * Invoked by a work queue tasklet.
2174 static void xs_tcp_setup_socket(struct work_struct *work)
2176 struct sock_xprt *transport =
2177 container_of(work, struct sock_xprt, connect_worker.work);
2178 struct socket *sock = transport->sock;
2179 struct rpc_xprt *xprt = &transport->xprt;
2182 current->flags |= PF_FSTRANS;
2185 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
2186 sock = xs_create_sock(xprt, transport,
2187 xs_addr(xprt)->sa_family, SOCK_STREAM, IPPROTO_TCP);
2189 status = PTR_ERR(sock);
2195 abort_and_exit = test_and_clear_bit(XPRT_CONNECTION_ABORT,
2197 /* "close" the socket, preserving the local port */
2198 xs_tcp_reuse_connection(transport);
2204 dprintk("RPC: worker connecting xprt %p via %s to "
2205 "%s (port %s)\n", xprt,
2206 xprt->address_strings[RPC_DISPLAY_PROTO],
2207 xprt->address_strings[RPC_DISPLAY_ADDR],
2208 xprt->address_strings[RPC_DISPLAY_PORT]);
2210 status = xs_tcp_finish_connecting(xprt, sock);
2211 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2212 xprt, -status, xprt_connected(xprt),
2213 sock->sk->sk_state);
2216 printk("%s: connect returned unhandled error %d\n",
2218 case -EADDRNOTAVAIL:
2219 /* We're probably in TIME_WAIT. Get rid of existing socket,
2222 xs_tcp_force_close(xprt);
2227 xprt_clear_connecting(xprt);
2228 current->flags &= ~PF_FSTRANS;
2231 /* Happens, for instance, if the user specified a link
2232 * local IPv6 address without a scope-id.
2237 /* retry with existing socket, after a delay */
2243 xprt_clear_connecting(xprt);
2244 xprt_wake_pending_tasks(xprt, status);
2245 current->flags &= ~PF_FSTRANS;
2249 * xs_connect - connect a socket to a remote endpoint
2250 * @xprt: pointer to transport structure
2251 * @task: address of RPC task that manages state of connect request
2253 * TCP: If the remote end dropped the connection, delay reconnecting.
2255 * UDP socket connects are synchronous, but we use a work queue anyway
2256 * to guarantee that even unprivileged user processes can set up a
2257 * socket on a privileged port.
2259 * If a UDP socket connect fails, the delay behavior here prevents
2260 * retry floods (hard mounts).
2262 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2264 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2266 if (transport->sock != NULL && !RPC_IS_SOFTCONN(task)) {
2267 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2269 xprt, xprt->reestablish_timeout / HZ);
2270 queue_delayed_work(rpciod_workqueue,
2271 &transport->connect_worker,
2272 xprt->reestablish_timeout);
2273 xprt->reestablish_timeout <<= 1;
2274 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2275 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2276 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
2277 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
2279 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2280 queue_delayed_work(rpciod_workqueue,
2281 &transport->connect_worker, 0);
2286 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2287 * @xprt: rpc_xprt struct containing statistics
2291 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2295 if (xprt_connected(xprt))
2296 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2298 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2299 "%llu %llu %lu %llu %llu\n",
2300 xprt->stat.bind_count,
2301 xprt->stat.connect_count,
2302 xprt->stat.connect_time,
2306 xprt->stat.bad_xids,
2309 xprt->stat.max_slots,
2310 xprt->stat.sending_u,
2311 xprt->stat.pending_u);
2315 * xs_udp_print_stats - display UDP socket-specifc stats
2316 * @xprt: rpc_xprt struct containing statistics
2320 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2322 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2324 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2327 xprt->stat.bind_count,
2330 xprt->stat.bad_xids,
2333 xprt->stat.max_slots,
2334 xprt->stat.sending_u,
2335 xprt->stat.pending_u);
2339 * xs_tcp_print_stats - display TCP socket-specifc stats
2340 * @xprt: rpc_xprt struct containing statistics
2344 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2346 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2349 if (xprt_connected(xprt))
2350 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2352 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2353 "%llu %llu %lu %llu %llu\n",
2355 xprt->stat.bind_count,
2356 xprt->stat.connect_count,
2357 xprt->stat.connect_time,
2361 xprt->stat.bad_xids,
2364 xprt->stat.max_slots,
2365 xprt->stat.sending_u,
2366 xprt->stat.pending_u);
2370 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2371 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2372 * to use the server side send routines.
2374 static void *bc_malloc(struct rpc_task *task, size_t size)
2377 struct rpc_buffer *buf;
2379 WARN_ON_ONCE(size > PAGE_SIZE - sizeof(struct rpc_buffer));
2380 if (size > PAGE_SIZE - sizeof(struct rpc_buffer))
2383 page = alloc_page(GFP_KERNEL);
2387 buf = page_address(page);
2388 buf->len = PAGE_SIZE;
2394 * Free the space allocated in the bc_alloc routine
2396 static void bc_free(void *buffer)
2398 struct rpc_buffer *buf;
2403 buf = container_of(buffer, struct rpc_buffer, data);
2404 free_page((unsigned long)buf);
2408 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2409 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2411 static int bc_sendto(struct rpc_rqst *req)
2414 struct xdr_buf *xbufp = &req->rq_snd_buf;
2415 struct rpc_xprt *xprt = req->rq_xprt;
2416 struct sock_xprt *transport =
2417 container_of(xprt, struct sock_xprt, xprt);
2418 struct socket *sock = transport->sock;
2419 unsigned long headoff;
2420 unsigned long tailoff;
2422 xs_encode_stream_record_marker(xbufp);
2424 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2425 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2426 len = svc_send_common(sock, xbufp,
2427 virt_to_page(xbufp->head[0].iov_base), headoff,
2428 xbufp->tail[0].iov_base, tailoff);
2430 if (len != xbufp->len) {
2431 printk(KERN_NOTICE "Error sending entire callback!\n");
2439 * The send routine. Borrows from svc_send
2441 static int bc_send_request(struct rpc_task *task)
2443 struct rpc_rqst *req = task->tk_rqstp;
2444 struct svc_xprt *xprt;
2447 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2449 * Get the server socket associated with this callback xprt
2451 xprt = req->rq_xprt->bc_xprt;
2454 * Grab the mutex to serialize data as the connection is shared
2455 * with the fore channel
2457 if (!mutex_trylock(&xprt->xpt_mutex)) {
2458 rpc_sleep_on(&xprt->xpt_bc_pending, task, NULL);
2459 if (!mutex_trylock(&xprt->xpt_mutex))
2461 rpc_wake_up_queued_task(&xprt->xpt_bc_pending, task);
2463 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2466 len = bc_sendto(req);
2467 mutex_unlock(&xprt->xpt_mutex);
2476 * The close routine. Since this is client initiated, we do nothing
2479 static void bc_close(struct rpc_xprt *xprt)
2484 * The xprt destroy routine. Again, because this connection is client
2485 * initiated, we do nothing
2488 static void bc_destroy(struct rpc_xprt *xprt)
2492 static struct rpc_xprt_ops xs_local_ops = {
2493 .reserve_xprt = xprt_reserve_xprt,
2494 .release_xprt = xs_tcp_release_xprt,
2495 .alloc_slot = xprt_alloc_slot,
2496 .rpcbind = xs_local_rpcbind,
2497 .set_port = xs_local_set_port,
2498 .connect = xs_local_connect,
2499 .buf_alloc = rpc_malloc,
2500 .buf_free = rpc_free,
2501 .send_request = xs_local_send_request,
2502 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2504 .destroy = xs_local_destroy,
2505 .print_stats = xs_local_print_stats,
2508 static struct rpc_xprt_ops xs_udp_ops = {
2509 .set_buffer_size = xs_udp_set_buffer_size,
2510 .reserve_xprt = xprt_reserve_xprt_cong,
2511 .release_xprt = xprt_release_xprt_cong,
2512 .alloc_slot = xprt_alloc_slot,
2513 .rpcbind = rpcb_getport_async,
2514 .set_port = xs_set_port,
2515 .connect = xs_connect,
2516 .buf_alloc = rpc_malloc,
2517 .buf_free = rpc_free,
2518 .send_request = xs_udp_send_request,
2519 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2520 .timer = xs_udp_timer,
2521 .release_request = xprt_release_rqst_cong,
2523 .destroy = xs_destroy,
2524 .print_stats = xs_udp_print_stats,
2527 static struct rpc_xprt_ops xs_tcp_ops = {
2528 .reserve_xprt = xprt_reserve_xprt,
2529 .release_xprt = xs_tcp_release_xprt,
2530 .alloc_slot = xprt_lock_and_alloc_slot,
2531 .rpcbind = rpcb_getport_async,
2532 .set_port = xs_set_port,
2533 .connect = xs_connect,
2534 .buf_alloc = rpc_malloc,
2535 .buf_free = rpc_free,
2536 .send_request = xs_tcp_send_request,
2537 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2538 .close = xs_tcp_close,
2539 .destroy = xs_destroy,
2540 .print_stats = xs_tcp_print_stats,
2544 * The rpc_xprt_ops for the server backchannel
2547 static struct rpc_xprt_ops bc_tcp_ops = {
2548 .reserve_xprt = xprt_reserve_xprt,
2549 .release_xprt = xprt_release_xprt,
2550 .alloc_slot = xprt_alloc_slot,
2551 .rpcbind = xs_local_rpcbind,
2552 .buf_alloc = bc_malloc,
2553 .buf_free = bc_free,
2554 .send_request = bc_send_request,
2555 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2557 .destroy = bc_destroy,
2558 .print_stats = xs_tcp_print_stats,
2561 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2563 static const struct sockaddr_in sin = {
2564 .sin_family = AF_INET,
2565 .sin_addr.s_addr = htonl(INADDR_ANY),
2567 static const struct sockaddr_in6 sin6 = {
2568 .sin6_family = AF_INET6,
2569 .sin6_addr = IN6ADDR_ANY_INIT,
2576 memcpy(sap, &sin, sizeof(sin));
2579 memcpy(sap, &sin6, sizeof(sin6));
2582 dprintk("RPC: %s: Bad address family\n", __func__);
2583 return -EAFNOSUPPORT;
2588 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2589 unsigned int slot_table_size,
2590 unsigned int max_slot_table_size)
2592 struct rpc_xprt *xprt;
2593 struct sock_xprt *new;
2595 if (args->addrlen > sizeof(xprt->addr)) {
2596 dprintk("RPC: xs_setup_xprt: address too large\n");
2597 return ERR_PTR(-EBADF);
2600 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2601 max_slot_table_size);
2603 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2605 return ERR_PTR(-ENOMEM);
2608 new = container_of(xprt, struct sock_xprt, xprt);
2609 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2610 xprt->addrlen = args->addrlen;
2612 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2615 err = xs_init_anyaddr(args->dstaddr->sa_family,
2616 (struct sockaddr *)&new->srcaddr);
2619 return ERR_PTR(err);
2626 static const struct rpc_timeout xs_local_default_timeout = {
2627 .to_initval = 10 * HZ,
2628 .to_maxval = 10 * HZ,
2633 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2634 * @args: rpc transport creation arguments
2636 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2638 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2640 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2641 struct sock_xprt *transport;
2642 struct rpc_xprt *xprt;
2643 struct rpc_xprt *ret;
2645 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2646 xprt_max_tcp_slot_table_entries);
2649 transport = container_of(xprt, struct sock_xprt, xprt);
2652 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2653 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2655 xprt->bind_timeout = XS_BIND_TO;
2656 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2657 xprt->idle_timeout = XS_IDLE_DISC_TO;
2659 xprt->ops = &xs_local_ops;
2660 xprt->timeout = &xs_local_default_timeout;
2662 switch (sun->sun_family) {
2664 if (sun->sun_path[0] != '/') {
2665 dprintk("RPC: bad AF_LOCAL address: %s\n",
2667 ret = ERR_PTR(-EINVAL);
2670 xprt_set_bound(xprt);
2671 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2672 ret = ERR_PTR(xs_local_setup_socket(transport));
2677 ret = ERR_PTR(-EAFNOSUPPORT);
2681 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2682 xprt->address_strings[RPC_DISPLAY_ADDR]);
2684 if (try_module_get(THIS_MODULE))
2686 ret = ERR_PTR(-EINVAL);
2692 static const struct rpc_timeout xs_udp_default_timeout = {
2693 .to_initval = 5 * HZ,
2694 .to_maxval = 30 * HZ,
2695 .to_increment = 5 * HZ,
2700 * xs_setup_udp - Set up transport to use a UDP socket
2701 * @args: rpc transport creation arguments
2704 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2706 struct sockaddr *addr = args->dstaddr;
2707 struct rpc_xprt *xprt;
2708 struct sock_xprt *transport;
2709 struct rpc_xprt *ret;
2711 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2712 xprt_udp_slot_table_entries);
2715 transport = container_of(xprt, struct sock_xprt, xprt);
2717 xprt->prot = IPPROTO_UDP;
2719 /* XXX: header size can vary due to auth type, IPv6, etc. */
2720 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2722 xprt->bind_timeout = XS_BIND_TO;
2723 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2724 xprt->idle_timeout = XS_IDLE_DISC_TO;
2726 xprt->ops = &xs_udp_ops;
2728 xprt->timeout = &xs_udp_default_timeout;
2730 switch (addr->sa_family) {
2732 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2733 xprt_set_bound(xprt);
2735 INIT_DELAYED_WORK(&transport->connect_worker,
2736 xs_udp_setup_socket);
2737 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2740 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2741 xprt_set_bound(xprt);
2743 INIT_DELAYED_WORK(&transport->connect_worker,
2744 xs_udp_setup_socket);
2745 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2748 ret = ERR_PTR(-EAFNOSUPPORT);
2752 if (xprt_bound(xprt))
2753 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2754 xprt->address_strings[RPC_DISPLAY_ADDR],
2755 xprt->address_strings[RPC_DISPLAY_PORT],
2756 xprt->address_strings[RPC_DISPLAY_PROTO]);
2758 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2759 xprt->address_strings[RPC_DISPLAY_ADDR],
2760 xprt->address_strings[RPC_DISPLAY_PROTO]);
2762 if (try_module_get(THIS_MODULE))
2764 ret = ERR_PTR(-EINVAL);
2770 static const struct rpc_timeout xs_tcp_default_timeout = {
2771 .to_initval = 60 * HZ,
2772 .to_maxval = 60 * HZ,
2777 * xs_setup_tcp - Set up transport to use a TCP socket
2778 * @args: rpc transport creation arguments
2781 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2783 struct sockaddr *addr = args->dstaddr;
2784 struct rpc_xprt *xprt;
2785 struct sock_xprt *transport;
2786 struct rpc_xprt *ret;
2787 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries;
2789 if (args->flags & XPRT_CREATE_INFINITE_SLOTS)
2790 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT;
2792 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2793 max_slot_table_size);
2796 transport = container_of(xprt, struct sock_xprt, xprt);
2798 xprt->prot = IPPROTO_TCP;
2799 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2800 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2802 xprt->bind_timeout = XS_BIND_TO;
2803 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2804 xprt->idle_timeout = XS_IDLE_DISC_TO;
2806 xprt->ops = &xs_tcp_ops;
2807 xprt->timeout = &xs_tcp_default_timeout;
2809 switch (addr->sa_family) {
2811 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2812 xprt_set_bound(xprt);
2814 INIT_DELAYED_WORK(&transport->connect_worker,
2815 xs_tcp_setup_socket);
2816 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2819 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2820 xprt_set_bound(xprt);
2822 INIT_DELAYED_WORK(&transport->connect_worker,
2823 xs_tcp_setup_socket);
2824 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2827 ret = ERR_PTR(-EAFNOSUPPORT);
2831 if (xprt_bound(xprt))
2832 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2833 xprt->address_strings[RPC_DISPLAY_ADDR],
2834 xprt->address_strings[RPC_DISPLAY_PORT],
2835 xprt->address_strings[RPC_DISPLAY_PROTO]);
2837 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2838 xprt->address_strings[RPC_DISPLAY_ADDR],
2839 xprt->address_strings[RPC_DISPLAY_PROTO]);
2842 if (try_module_get(THIS_MODULE))
2844 ret = ERR_PTR(-EINVAL);
2851 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
2852 * @args: rpc transport creation arguments
2855 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
2857 struct sockaddr *addr = args->dstaddr;
2858 struct rpc_xprt *xprt;
2859 struct sock_xprt *transport;
2860 struct svc_sock *bc_sock;
2861 struct rpc_xprt *ret;
2863 if (args->bc_xprt->xpt_bc_xprt) {
2865 * This server connection already has a backchannel
2866 * export; we can't create a new one, as we wouldn't be
2867 * able to match replies based on xid any more. So,
2868 * reuse the already-existing one:
2870 return args->bc_xprt->xpt_bc_xprt;
2872 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2873 xprt_tcp_slot_table_entries);
2876 transport = container_of(xprt, struct sock_xprt, xprt);
2878 xprt->prot = IPPROTO_TCP;
2879 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2880 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2881 xprt->timeout = &xs_tcp_default_timeout;
2884 xprt_set_bound(xprt);
2885 xprt->bind_timeout = 0;
2886 xprt->reestablish_timeout = 0;
2887 xprt->idle_timeout = 0;
2889 xprt->ops = &bc_tcp_ops;
2891 switch (addr->sa_family) {
2893 xs_format_peer_addresses(xprt, "tcp",
2897 xs_format_peer_addresses(xprt, "tcp",
2898 RPCBIND_NETID_TCP6);
2901 ret = ERR_PTR(-EAFNOSUPPORT);
2905 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2906 xprt->address_strings[RPC_DISPLAY_ADDR],
2907 xprt->address_strings[RPC_DISPLAY_PORT],
2908 xprt->address_strings[RPC_DISPLAY_PROTO]);
2911 * Once we've associated a backchannel xprt with a connection,
2912 * we want to keep it around as long as long as the connection
2913 * lasts, in case we need to start using it for a backchannel
2914 * again; this reference won't be dropped until bc_xprt is
2918 args->bc_xprt->xpt_bc_xprt = xprt;
2919 xprt->bc_xprt = args->bc_xprt;
2920 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
2921 transport->sock = bc_sock->sk_sock;
2922 transport->inet = bc_sock->sk_sk;
2925 * Since we don't want connections for the backchannel, we set
2926 * the xprt status to connected
2928 xprt_set_connected(xprt);
2931 if (try_module_get(THIS_MODULE))
2934 ret = ERR_PTR(-EINVAL);
2940 static struct xprt_class xs_local_transport = {
2941 .list = LIST_HEAD_INIT(xs_local_transport.list),
2942 .name = "named UNIX socket",
2943 .owner = THIS_MODULE,
2944 .ident = XPRT_TRANSPORT_LOCAL,
2945 .setup = xs_setup_local,
2948 static struct xprt_class xs_udp_transport = {
2949 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2951 .owner = THIS_MODULE,
2952 .ident = XPRT_TRANSPORT_UDP,
2953 .setup = xs_setup_udp,
2956 static struct xprt_class xs_tcp_transport = {
2957 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2959 .owner = THIS_MODULE,
2960 .ident = XPRT_TRANSPORT_TCP,
2961 .setup = xs_setup_tcp,
2964 static struct xprt_class xs_bc_tcp_transport = {
2965 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
2966 .name = "tcp NFSv4.1 backchannel",
2967 .owner = THIS_MODULE,
2968 .ident = XPRT_TRANSPORT_BC_TCP,
2969 .setup = xs_setup_bc_tcp,
2973 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2976 int init_socket_xprt(void)
2979 if (!sunrpc_table_header)
2980 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2983 xprt_register_transport(&xs_local_transport);
2984 xprt_register_transport(&xs_udp_transport);
2985 xprt_register_transport(&xs_tcp_transport);
2986 xprt_register_transport(&xs_bc_tcp_transport);
2992 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2995 void cleanup_socket_xprt(void)
2998 if (sunrpc_table_header) {
2999 unregister_sysctl_table(sunrpc_table_header);
3000 sunrpc_table_header = NULL;
3004 xprt_unregister_transport(&xs_local_transport);
3005 xprt_unregister_transport(&xs_udp_transport);
3006 xprt_unregister_transport(&xs_tcp_transport);
3007 xprt_unregister_transport(&xs_bc_tcp_transport);
3010 static int param_set_uint_minmax(const char *val,
3011 const struct kernel_param *kp,
3012 unsigned int min, unsigned int max)
3019 ret = strict_strtoul(val, 0, &num);
3020 if (ret == -EINVAL || num < min || num > max)
3022 *((unsigned int *)kp->arg) = num;
3026 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3028 return param_set_uint_minmax(val, kp,
3033 static struct kernel_param_ops param_ops_portnr = {
3034 .set = param_set_portnr,
3035 .get = param_get_uint,
3038 #define param_check_portnr(name, p) \
3039 __param_check(name, p, unsigned int);
3041 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3042 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3044 static int param_set_slot_table_size(const char *val,
3045 const struct kernel_param *kp)
3047 return param_set_uint_minmax(val, kp,
3049 RPC_MAX_SLOT_TABLE);
3052 static struct kernel_param_ops param_ops_slot_table_size = {
3053 .set = param_set_slot_table_size,
3054 .get = param_get_uint,
3057 #define param_check_slot_table_size(name, p) \
3058 __param_check(name, p, unsigned int);
3060 static int param_set_max_slot_table_size(const char *val,
3061 const struct kernel_param *kp)
3063 return param_set_uint_minmax(val, kp,
3065 RPC_MAX_SLOT_TABLE_LIMIT);
3068 static struct kernel_param_ops param_ops_max_slot_table_size = {
3069 .set = param_set_max_slot_table_size,
3070 .get = param_get_uint,
3073 #define param_check_max_slot_table_size(name, p) \
3074 __param_check(name, p, unsigned int);
3076 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3077 slot_table_size, 0644);
3078 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3079 max_slot_table_size, 0644);
3080 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3081 slot_table_size, 0644);