2 * linux/net/sunrpc/xprtsock.c
4 * Client-side transport implementation for sockets.
6 * TCP callback races fixes (C) 1998 Red Hat
7 * TCP send fixes (C) 1998 Red Hat
8 * TCP NFS related read + write fixes
9 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
11 * Rewrite of larges part of the code in order to stabilize TCP stuff.
12 * Fix behaviour when socket buffer is full.
13 * (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no>
15 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com>
17 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
18 * <gilles.quillard@bull.net>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/slab.h>
24 #include <linux/module.h>
25 #include <linux/capability.h>
26 #include <linux/pagemap.h>
27 #include <linux/errno.h>
28 #include <linux/socket.h>
30 #include <linux/net.h>
33 #include <linux/udp.h>
34 #include <linux/tcp.h>
35 #include <linux/sunrpc/clnt.h>
36 #include <linux/sunrpc/sched.h>
37 #include <linux/sunrpc/svcsock.h>
38 #include <linux/sunrpc/xprtsock.h>
39 #include <linux/file.h>
40 #ifdef CONFIG_SUNRPC_BACKCHANNEL
41 #include <linux/sunrpc/bc_xprt.h>
45 #include <net/checksum.h>
51 static void xs_close(struct rpc_xprt *xprt);
56 unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
57 unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE;
58 unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE;
60 unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
61 unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
63 #define XS_TCP_LINGER_TO (15U * HZ)
64 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
67 * We can register our own files under /proc/sys/sunrpc by
68 * calling register_sysctl_table() again. The files in that
69 * directory become the union of all files registered there.
71 * We simply need to make sure that we don't collide with
72 * someone else's file names!
77 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
78 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
79 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT;
80 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
81 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
83 static struct ctl_table_header *sunrpc_table_header;
86 * FIXME: changing the UDP slot table size should also resize the UDP
87 * socket buffers for existing UDP transports
89 static ctl_table xs_tunables_table[] = {
91 .procname = "udp_slot_table_entries",
92 .data = &xprt_udp_slot_table_entries,
93 .maxlen = sizeof(unsigned int),
95 .proc_handler = proc_dointvec_minmax,
96 .extra1 = &min_slot_table_size,
97 .extra2 = &max_slot_table_size
100 .procname = "tcp_slot_table_entries",
101 .data = &xprt_tcp_slot_table_entries,
102 .maxlen = sizeof(unsigned int),
104 .proc_handler = proc_dointvec_minmax,
105 .extra1 = &min_slot_table_size,
106 .extra2 = &max_slot_table_size
109 .procname = "tcp_max_slot_table_entries",
110 .data = &xprt_max_tcp_slot_table_entries,
111 .maxlen = sizeof(unsigned int),
113 .proc_handler = proc_dointvec_minmax,
114 .extra1 = &min_slot_table_size,
115 .extra2 = &max_tcp_slot_table_limit
118 .procname = "min_resvport",
119 .data = &xprt_min_resvport,
120 .maxlen = sizeof(unsigned int),
122 .proc_handler = proc_dointvec_minmax,
123 .extra1 = &xprt_min_resvport_limit,
124 .extra2 = &xprt_max_resvport_limit
127 .procname = "max_resvport",
128 .data = &xprt_max_resvport,
129 .maxlen = sizeof(unsigned int),
131 .proc_handler = proc_dointvec_minmax,
132 .extra1 = &xprt_min_resvport_limit,
133 .extra2 = &xprt_max_resvport_limit
136 .procname = "tcp_fin_timeout",
137 .data = &xs_tcp_fin_timeout,
138 .maxlen = sizeof(xs_tcp_fin_timeout),
140 .proc_handler = proc_dointvec_jiffies,
145 static ctl_table sunrpc_table[] = {
147 .procname = "sunrpc",
149 .child = xs_tunables_table
157 * Wait duration for a reply from the RPC portmapper.
159 #define XS_BIND_TO (60U * HZ)
162 * Delay if a UDP socket connect error occurs. This is most likely some
163 * kind of resource problem on the local host.
165 #define XS_UDP_REEST_TO (2U * HZ)
168 * The reestablish timeout allows clients to delay for a bit before attempting
169 * to reconnect to a server that just dropped our connection.
171 * We implement an exponential backoff when trying to reestablish a TCP
172 * transport connection with the server. Some servers like to drop a TCP
173 * connection when they are overworked, so we start with a short timeout and
174 * increase over time if the server is down or not responding.
176 #define XS_TCP_INIT_REEST_TO (3U * HZ)
177 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
180 * TCP idle timeout; client drops the transport socket if it is idle
181 * for this long. Note that we also timeout UDP sockets to prevent
182 * holding port numbers when there is no RPC traffic.
184 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
187 # undef RPC_DEBUG_DATA
188 # define RPCDBG_FACILITY RPCDBG_TRANS
191 #ifdef RPC_DEBUG_DATA
192 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
194 u8 *buf = (u8 *) packet;
197 dprintk("RPC: %s\n", msg);
198 for (j = 0; j < count && j < 128; j += 4) {
202 dprintk("0x%04x ", j);
204 dprintk("%02x%02x%02x%02x ",
205 buf[j], buf[j+1], buf[j+2], buf[j+3]);
210 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
217 struct rpc_xprt xprt;
222 struct socket * sock;
226 * State of TCP reply receive
235 unsigned long tcp_copied,
239 * Connection of transports
241 struct delayed_work connect_worker;
242 struct sockaddr_storage srcaddr;
243 unsigned short srcport;
246 * UDP socket buffer size parameters
252 * Saved socket callback addresses
254 void (*old_data_ready)(struct sock *, int);
255 void (*old_state_change)(struct sock *);
256 void (*old_write_space)(struct sock *);
260 * TCP receive state flags
262 #define TCP_RCV_LAST_FRAG (1UL << 0)
263 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
264 #define TCP_RCV_COPY_XID (1UL << 2)
265 #define TCP_RCV_COPY_DATA (1UL << 3)
266 #define TCP_RCV_READ_CALLDIR (1UL << 4)
267 #define TCP_RCV_COPY_CALLDIR (1UL << 5)
272 #define TCP_RPC_REPLY (1UL << 6)
274 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
276 return (struct sockaddr *) &xprt->addr;
279 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt)
281 return (struct sockaddr_un *) &xprt->addr;
284 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
286 return (struct sockaddr_in *) &xprt->addr;
289 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
291 return (struct sockaddr_in6 *) &xprt->addr;
294 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
296 struct sockaddr *sap = xs_addr(xprt);
297 struct sockaddr_in6 *sin6;
298 struct sockaddr_in *sin;
299 struct sockaddr_un *sun;
302 switch (sap->sa_family) {
304 sun = xs_addr_un(xprt);
305 strlcpy(buf, sun->sun_path, sizeof(buf));
306 xprt->address_strings[RPC_DISPLAY_ADDR] =
307 kstrdup(buf, GFP_KERNEL);
310 (void)rpc_ntop(sap, buf, sizeof(buf));
311 xprt->address_strings[RPC_DISPLAY_ADDR] =
312 kstrdup(buf, GFP_KERNEL);
313 sin = xs_addr_in(xprt);
314 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
317 (void)rpc_ntop(sap, buf, sizeof(buf));
318 xprt->address_strings[RPC_DISPLAY_ADDR] =
319 kstrdup(buf, GFP_KERNEL);
320 sin6 = xs_addr_in6(xprt);
321 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
327 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
330 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
332 struct sockaddr *sap = xs_addr(xprt);
335 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
336 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
338 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
339 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
342 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
343 const char *protocol,
346 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
347 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
348 xs_format_common_peer_addresses(xprt);
349 xs_format_common_peer_ports(xprt);
352 static void xs_update_peer_port(struct rpc_xprt *xprt)
354 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
355 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
357 xs_format_common_peer_ports(xprt);
360 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
364 for (i = 0; i < RPC_DISPLAY_MAX; i++)
366 case RPC_DISPLAY_PROTO:
367 case RPC_DISPLAY_NETID:
370 kfree(xprt->address_strings[i]);
374 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
376 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
378 struct msghdr msg = {
380 .msg_namelen = addrlen,
381 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
384 .iov_base = vec->iov_base + base,
385 .iov_len = vec->iov_len - base,
388 if (iov.iov_len != 0)
389 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
390 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
393 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more, bool zerocopy)
395 ssize_t (*do_sendpage)(struct socket *sock, struct page *page,
396 int offset, size_t size, int flags);
398 unsigned int remainder;
401 remainder = xdr->page_len - base;
402 base += xdr->page_base;
403 ppage = xdr->pages + (base >> PAGE_SHIFT);
405 do_sendpage = sock->ops->sendpage;
407 do_sendpage = sock_no_sendpage;
409 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
410 int flags = XS_SENDMSG_FLAGS;
413 if (remainder != 0 || more)
415 err = do_sendpage(sock, *ppage, base, len, flags);
416 if (remainder == 0 || err != len)
430 * xs_sendpages - write pages directly to a socket
431 * @sock: socket to send on
432 * @addr: UDP only -- address of destination
433 * @addrlen: UDP only -- length of destination address
434 * @xdr: buffer containing this request
435 * @base: starting position in the buffer
436 * @zerocopy: true if it is safe to use sendpage()
439 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base, bool zerocopy)
441 unsigned int remainder = xdr->len - base;
447 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
453 if (base < xdr->head[0].iov_len || addr != NULL) {
454 unsigned int len = xdr->head[0].iov_len - base;
456 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
457 if (remainder == 0 || err != len)
462 base -= xdr->head[0].iov_len;
464 if (base < xdr->page_len) {
465 unsigned int len = xdr->page_len - base;
467 err = xs_send_pagedata(sock, xdr, base, remainder != 0, zerocopy);
468 if (remainder == 0 || err != len)
473 base -= xdr->page_len;
475 if (base >= xdr->tail[0].iov_len)
477 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
486 static void xs_nospace_callback(struct rpc_task *task)
488 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
490 transport->inet->sk_write_pending--;
491 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
495 * xs_nospace - place task on wait queue if transmit was incomplete
496 * @task: task to put to sleep
499 static int xs_nospace(struct rpc_task *task)
501 struct rpc_rqst *req = task->tk_rqstp;
502 struct rpc_xprt *xprt = req->rq_xprt;
503 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
506 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
507 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
510 /* Protect against races with write_space */
511 spin_lock_bh(&xprt->transport_lock);
513 /* Don't race with disconnect */
514 if (xprt_connected(xprt)) {
515 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
517 * Notify TCP that we're limited by the application
520 set_bit(SOCK_NOSPACE, &transport->sock->flags);
521 transport->inet->sk_write_pending++;
522 /* ...and wait for more buffer space */
523 xprt_wait_for_buffer_space(task, xs_nospace_callback);
526 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
530 spin_unlock_bh(&xprt->transport_lock);
535 * Construct a stream transport record marker in @buf.
537 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf)
539 u32 reclen = buf->len - sizeof(rpc_fraghdr);
540 rpc_fraghdr *base = buf->head[0].iov_base;
541 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen);
545 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
546 * @task: RPC task that manages the state of an RPC request
549 * 0: The request has been sent
550 * EAGAIN: The socket was blocked, please call again later to
551 * complete the request
552 * ENOTCONN: Caller needs to invoke connect logic then call again
553 * other: Some other error occured, the request was not sent
555 static int xs_local_send_request(struct rpc_task *task)
557 struct rpc_rqst *req = task->tk_rqstp;
558 struct rpc_xprt *xprt = req->rq_xprt;
559 struct sock_xprt *transport =
560 container_of(xprt, struct sock_xprt, xprt);
561 struct xdr_buf *xdr = &req->rq_snd_buf;
564 xs_encode_stream_record_marker(&req->rq_snd_buf);
566 xs_pktdump("packet data:",
567 req->rq_svec->iov_base, req->rq_svec->iov_len);
569 status = xs_sendpages(transport->sock, NULL, 0,
570 xdr, req->rq_bytes_sent, true);
571 dprintk("RPC: %s(%u) = %d\n",
572 __func__, xdr->len - req->rq_bytes_sent, status);
573 if (likely(status >= 0)) {
574 req->rq_bytes_sent += status;
575 req->rq_xmit_bytes_sent += status;
576 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
577 req->rq_bytes_sent = 0;
585 status = xs_nospace(task);
588 dprintk("RPC: sendmsg returned unrecognized error %d\n",
599 * xs_udp_send_request - write an RPC request to a UDP socket
600 * @task: address of RPC task that manages the state of an RPC request
603 * 0: The request has been sent
604 * EAGAIN: The socket was blocked, please call again later to
605 * complete the request
606 * ENOTCONN: Caller needs to invoke connect logic then call again
607 * other: Some other error occurred, the request was not sent
609 static int xs_udp_send_request(struct rpc_task *task)
611 struct rpc_rqst *req = task->tk_rqstp;
612 struct rpc_xprt *xprt = req->rq_xprt;
613 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
614 struct xdr_buf *xdr = &req->rq_snd_buf;
617 xs_pktdump("packet data:",
618 req->rq_svec->iov_base,
619 req->rq_svec->iov_len);
621 if (!xprt_bound(xprt))
623 status = xs_sendpages(transport->sock,
626 req->rq_bytes_sent, true);
628 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
629 xdr->len - req->rq_bytes_sent, status);
632 req->rq_xmit_bytes_sent += status;
633 if (status >= req->rq_slen)
635 /* Still some bytes left; set up for a retry later. */
642 /* Should we call xs_close() here? */
645 status = xs_nospace(task);
648 dprintk("RPC: sendmsg returned unrecognized error %d\n",
653 /* When the server has died, an ICMP port unreachable message
654 * prompts ECONNREFUSED. */
655 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
662 * xs_tcp_shutdown - gracefully shut down a TCP socket
665 * Initiates a graceful shutdown of the TCP socket by calling the
666 * equivalent of shutdown(SHUT_WR);
668 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
670 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
671 struct socket *sock = transport->sock;
674 kernel_sock_shutdown(sock, SHUT_WR);
678 * xs_tcp_send_request - write an RPC request to a TCP socket
679 * @task: address of RPC task that manages the state of an RPC request
682 * 0: The request has been sent
683 * EAGAIN: The socket was blocked, please call again later to
684 * complete the request
685 * ENOTCONN: Caller needs to invoke connect logic then call again
686 * other: Some other error occurred, the request was not sent
688 * XXX: In the case of soft timeouts, should we eventually give up
689 * if sendmsg is not able to make progress?
691 static int xs_tcp_send_request(struct rpc_task *task)
693 struct rpc_rqst *req = task->tk_rqstp;
694 struct rpc_xprt *xprt = req->rq_xprt;
695 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
696 struct xdr_buf *xdr = &req->rq_snd_buf;
697 bool zerocopy = true;
700 xs_encode_stream_record_marker(&req->rq_snd_buf);
702 xs_pktdump("packet data:",
703 req->rq_svec->iov_base,
704 req->rq_svec->iov_len);
705 /* Don't use zero copy if this is a resend. If the RPC call
706 * completes while the socket holds a reference to the pages,
707 * then we may end up resending corrupted data.
709 if (task->tk_flags & RPC_TASK_SENT)
712 /* Continue transmitting the packet/record. We must be careful
713 * to cope with writespace callbacks arriving _after_ we have
714 * called sendmsg(). */
716 status = xs_sendpages(transport->sock,
717 NULL, 0, xdr, req->rq_bytes_sent,
720 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
721 xdr->len - req->rq_bytes_sent, status);
723 if (unlikely(status < 0))
726 /* If we've sent the entire packet, immediately
727 * reset the count of bytes sent. */
728 req->rq_bytes_sent += status;
729 req->rq_xmit_bytes_sent += status;
730 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
731 req->rq_bytes_sent = 0;
744 /* Should we call xs_close() here? */
747 status = xs_nospace(task);
750 dprintk("RPC: sendmsg returned unrecognized error %d\n",
753 xs_tcp_shutdown(xprt);
757 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
764 * xs_tcp_release_xprt - clean up after a tcp transmission
768 * This cleans up if an error causes us to abort the transmission of a request.
769 * In this case, the socket may need to be reset in order to avoid confusing
772 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
774 struct rpc_rqst *req;
776 if (task != xprt->snd_task)
780 req = task->tk_rqstp;
783 if (req->rq_bytes_sent == 0)
785 if (req->rq_bytes_sent == req->rq_snd_buf.len)
787 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
789 xprt_release_xprt(xprt, task);
792 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
794 transport->old_data_ready = sk->sk_data_ready;
795 transport->old_state_change = sk->sk_state_change;
796 transport->old_write_space = sk->sk_write_space;
799 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
801 sk->sk_data_ready = transport->old_data_ready;
802 sk->sk_state_change = transport->old_state_change;
803 sk->sk_write_space = transport->old_write_space;
806 static void xs_reset_transport(struct sock_xprt *transport)
808 struct socket *sock = transport->sock;
809 struct sock *sk = transport->inet;
814 transport->srcport = 0;
816 write_lock_bh(&sk->sk_callback_lock);
817 transport->inet = NULL;
818 transport->sock = NULL;
820 sk->sk_user_data = NULL;
822 xs_restore_old_callbacks(transport, sk);
823 write_unlock_bh(&sk->sk_callback_lock);
831 * xs_close - close a socket
834 * This is used when all requests are complete; ie, no DRC state remains
835 * on the server we want to save.
837 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
838 * xs_reset_transport() zeroing the socket from underneath a writer.
840 static void xs_close(struct rpc_xprt *xprt)
842 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
844 dprintk("RPC: xs_close xprt %p\n", xprt);
846 xs_reset_transport(transport);
847 xprt->reestablish_timeout = 0;
849 smp_mb__before_clear_bit();
850 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
851 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
852 clear_bit(XPRT_CLOSING, &xprt->state);
853 smp_mb__after_clear_bit();
854 xprt_disconnect_done(xprt);
857 static void xs_tcp_close(struct rpc_xprt *xprt)
859 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state))
862 xs_tcp_shutdown(xprt);
866 * xs_destroy - prepare to shutdown a transport
867 * @xprt: doomed transport
870 static void xs_destroy(struct rpc_xprt *xprt)
872 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
874 dprintk("RPC: xs_destroy xprt %p\n", xprt);
876 cancel_delayed_work_sync(&transport->connect_worker);
879 xs_free_peer_addresses(xprt);
881 module_put(THIS_MODULE);
884 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
886 return (struct rpc_xprt *) sk->sk_user_data;
889 static int xs_local_copy_to_xdr(struct xdr_buf *xdr, struct sk_buff *skb)
891 struct xdr_skb_reader desc = {
893 .offset = sizeof(rpc_fraghdr),
894 .count = skb->len - sizeof(rpc_fraghdr),
897 if (xdr_partial_copy_from_skb(xdr, 0, &desc, xdr_skb_read_bits) < 0)
905 * xs_local_data_ready - "data ready" callback for AF_LOCAL sockets
906 * @sk: socket with data to read
907 * @len: how much data to read
909 * Currently this assumes we can read the whole reply in a single gulp.
911 static void xs_local_data_ready(struct sock *sk, int len)
913 struct rpc_task *task;
914 struct rpc_xprt *xprt;
915 struct rpc_rqst *rovr;
917 int err, repsize, copied;
921 read_lock_bh(&sk->sk_callback_lock);
922 dprintk("RPC: %s...\n", __func__);
923 xprt = xprt_from_sock(sk);
927 skb = skb_recv_datagram(sk, 0, 1, &err);
934 repsize = skb->len - sizeof(rpc_fraghdr);
936 dprintk("RPC: impossible RPC reply size %d\n", repsize);
940 /* Copy the XID from the skb... */
941 xp = skb_header_pointer(skb, sizeof(rpc_fraghdr), sizeof(_xid), &_xid);
945 /* Look up and lock the request corresponding to the given XID */
946 spin_lock(&xprt->transport_lock);
947 rovr = xprt_lookup_rqst(xprt, *xp);
950 task = rovr->rq_task;
952 copied = rovr->rq_private_buf.buflen;
953 if (copied > repsize)
956 if (xs_local_copy_to_xdr(&rovr->rq_private_buf, skb)) {
957 dprintk("RPC: sk_buff copy failed\n");
961 xprt_complete_rqst(task, copied);
964 spin_unlock(&xprt->transport_lock);
966 skb_free_datagram(sk, skb);
968 read_unlock_bh(&sk->sk_callback_lock);
972 * xs_udp_data_ready - "data ready" callback for UDP sockets
973 * @sk: socket with data to read
974 * @len: how much data to read
977 static void xs_udp_data_ready(struct sock *sk, int len)
979 struct rpc_task *task;
980 struct rpc_xprt *xprt;
981 struct rpc_rqst *rovr;
983 int err, repsize, copied;
987 read_lock_bh(&sk->sk_callback_lock);
988 dprintk("RPC: xs_udp_data_ready...\n");
989 if (!(xprt = xprt_from_sock(sk)))
992 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 /* Something worked... */
1029 dst_confirm(skb_dst(skb));
1031 xprt_adjust_cwnd(task, copied);
1032 xprt_complete_rqst(task, copied);
1035 spin_unlock(&xprt->transport_lock);
1037 skb_free_datagram(sk, skb);
1039 read_unlock_bh(&sk->sk_callback_lock);
1043 * Helper function to force a TCP close if the server is sending
1044 * junk and/or it has put us in CLOSE_WAIT
1046 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1048 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1049 xprt_force_disconnect(xprt);
1052 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
1054 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1058 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
1059 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
1060 used = xdr_skb_read_bits(desc, p, len);
1061 transport->tcp_offset += used;
1065 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
1066 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
1067 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
1069 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
1070 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
1072 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
1073 transport->tcp_offset = 0;
1075 /* Sanity check of the record length */
1076 if (unlikely(transport->tcp_reclen < 8)) {
1077 dprintk("RPC: invalid TCP record fragment length\n");
1078 xs_tcp_force_close(xprt);
1081 dprintk("RPC: reading TCP record fragment of length %d\n",
1082 transport->tcp_reclen);
1085 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
1087 if (transport->tcp_offset == transport->tcp_reclen) {
1088 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
1089 transport->tcp_offset = 0;
1090 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
1091 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1092 transport->tcp_flags |= TCP_RCV_COPY_XID;
1093 transport->tcp_copied = 0;
1098 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1103 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
1104 dprintk("RPC: reading XID (%Zu bytes)\n", len);
1105 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
1106 used = xdr_skb_read_bits(desc, p, len);
1107 transport->tcp_offset += used;
1110 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
1111 transport->tcp_flags |= TCP_RCV_READ_CALLDIR;
1112 transport->tcp_copied = 4;
1113 dprintk("RPC: reading %s XID %08x\n",
1114 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
1116 ntohl(transport->tcp_xid));
1117 xs_tcp_check_fraghdr(transport);
1120 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
1121 struct xdr_skb_reader *desc)
1128 * We want transport->tcp_offset to be 8 at the end of this routine
1129 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1130 * When this function is called for the first time,
1131 * transport->tcp_offset is 4 (after having already read the xid).
1133 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
1134 len = sizeof(transport->tcp_calldir) - offset;
1135 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len);
1136 p = ((char *) &transport->tcp_calldir) + offset;
1137 used = xdr_skb_read_bits(desc, p, len);
1138 transport->tcp_offset += used;
1141 transport->tcp_flags &= ~TCP_RCV_READ_CALLDIR;
1143 * We don't yet have the XDR buffer, so we will write the calldir
1144 * out after we get the buffer from the 'struct rpc_rqst'
1146 switch (ntohl(transport->tcp_calldir)) {
1148 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1149 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1150 transport->tcp_flags |= TCP_RPC_REPLY;
1153 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1154 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1155 transport->tcp_flags &= ~TCP_RPC_REPLY;
1158 dprintk("RPC: invalid request message type\n");
1159 xs_tcp_force_close(&transport->xprt);
1161 xs_tcp_check_fraghdr(transport);
1164 static inline void xs_tcp_read_common(struct rpc_xprt *xprt,
1165 struct xdr_skb_reader *desc,
1166 struct rpc_rqst *req)
1168 struct sock_xprt *transport =
1169 container_of(xprt, struct sock_xprt, xprt);
1170 struct xdr_buf *rcvbuf;
1174 rcvbuf = &req->rq_private_buf;
1176 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
1178 * Save the RPC direction in the XDR buffer
1180 memcpy(rcvbuf->head[0].iov_base + transport->tcp_copied,
1181 &transport->tcp_calldir,
1182 sizeof(transport->tcp_calldir));
1183 transport->tcp_copied += sizeof(transport->tcp_calldir);
1184 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
1188 if (len > transport->tcp_reclen - transport->tcp_offset) {
1189 struct xdr_skb_reader my_desc;
1191 len = transport->tcp_reclen - transport->tcp_offset;
1192 memcpy(&my_desc, desc, sizeof(my_desc));
1193 my_desc.count = len;
1194 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1195 &my_desc, xdr_skb_read_bits);
1199 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1200 desc, xdr_skb_read_bits);
1203 transport->tcp_copied += r;
1204 transport->tcp_offset += r;
1207 /* Error when copying to the receive buffer,
1208 * usually because we weren't able to allocate
1209 * additional buffer pages. All we can do now
1210 * is turn off TCP_RCV_COPY_DATA, so the request
1211 * will not receive any additional updates,
1213 * Any remaining data from this record will
1216 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1217 dprintk("RPC: XID %08x truncated request\n",
1218 ntohl(transport->tcp_xid));
1219 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1220 "tcp_offset = %u, tcp_reclen = %u\n",
1221 xprt, transport->tcp_copied,
1222 transport->tcp_offset, transport->tcp_reclen);
1226 dprintk("RPC: XID %08x read %Zd bytes\n",
1227 ntohl(transport->tcp_xid), r);
1228 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1229 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1230 transport->tcp_offset, transport->tcp_reclen);
1232 if (transport->tcp_copied == req->rq_private_buf.buflen)
1233 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1234 else if (transport->tcp_offset == transport->tcp_reclen) {
1235 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1236 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1241 * Finds the request corresponding to the RPC xid and invokes the common
1242 * tcp read code to read the data.
1244 static inline int xs_tcp_read_reply(struct rpc_xprt *xprt,
1245 struct xdr_skb_reader *desc)
1247 struct sock_xprt *transport =
1248 container_of(xprt, struct sock_xprt, xprt);
1249 struct rpc_rqst *req;
1251 dprintk("RPC: read reply XID %08x\n", ntohl(transport->tcp_xid));
1253 /* Find and lock the request corresponding to this xid */
1254 spin_lock(&xprt->transport_lock);
1255 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1257 dprintk("RPC: XID %08x request not found!\n",
1258 ntohl(transport->tcp_xid));
1259 spin_unlock(&xprt->transport_lock);
1263 xs_tcp_read_common(xprt, desc, req);
1265 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1266 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1268 spin_unlock(&xprt->transport_lock);
1272 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1274 * Obtains an rpc_rqst previously allocated and invokes the common
1275 * tcp read code to read the data. The result is placed in the callback
1277 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1278 * connection and return -1.
1280 static inline int xs_tcp_read_callback(struct rpc_xprt *xprt,
1281 struct xdr_skb_reader *desc)
1283 struct sock_xprt *transport =
1284 container_of(xprt, struct sock_xprt, xprt);
1285 struct rpc_rqst *req;
1287 req = xprt_alloc_bc_request(xprt);
1289 printk(KERN_WARNING "Callback slot table overflowed\n");
1290 xprt_force_disconnect(xprt);
1294 req->rq_xid = transport->tcp_xid;
1295 dprintk("RPC: read callback XID %08x\n", ntohl(req->rq_xid));
1296 xs_tcp_read_common(xprt, desc, req);
1298 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA)) {
1299 struct svc_serv *bc_serv = xprt->bc_serv;
1302 * Add callback request to callback list. The callback
1303 * service sleeps on the sv_cb_waitq waiting for new
1304 * requests. Wake it up after adding enqueing the
1307 dprintk("RPC: add callback request to list\n");
1308 spin_lock(&bc_serv->sv_cb_lock);
1309 list_add(&req->rq_bc_list, &bc_serv->sv_cb_list);
1310 spin_unlock(&bc_serv->sv_cb_lock);
1311 wake_up(&bc_serv->sv_cb_waitq);
1314 req->rq_private_buf.len = transport->tcp_copied;
1319 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1320 struct xdr_skb_reader *desc)
1322 struct sock_xprt *transport =
1323 container_of(xprt, struct sock_xprt, xprt);
1325 return (transport->tcp_flags & TCP_RPC_REPLY) ?
1326 xs_tcp_read_reply(xprt, desc) :
1327 xs_tcp_read_callback(xprt, desc);
1330 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1331 struct xdr_skb_reader *desc)
1333 return xs_tcp_read_reply(xprt, desc);
1335 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1338 * Read data off the transport. This can be either an RPC_CALL or an
1339 * RPC_REPLY. Relay the processing to helper functions.
1341 static void xs_tcp_read_data(struct rpc_xprt *xprt,
1342 struct xdr_skb_reader *desc)
1344 struct sock_xprt *transport =
1345 container_of(xprt, struct sock_xprt, xprt);
1347 if (_xs_tcp_read_data(xprt, desc) == 0)
1348 xs_tcp_check_fraghdr(transport);
1351 * The transport_lock protects the request handling.
1352 * There's no need to hold it to update the tcp_flags.
1354 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1358 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1362 len = transport->tcp_reclen - transport->tcp_offset;
1363 if (len > desc->count)
1366 desc->offset += len;
1367 transport->tcp_offset += len;
1368 dprintk("RPC: discarded %Zu bytes\n", len);
1369 xs_tcp_check_fraghdr(transport);
1372 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1374 struct rpc_xprt *xprt = rd_desc->arg.data;
1375 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1376 struct xdr_skb_reader desc = {
1382 dprintk("RPC: xs_tcp_data_recv started\n");
1384 /* Read in a new fragment marker if necessary */
1385 /* Can we ever really expect to get completely empty fragments? */
1386 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1387 xs_tcp_read_fraghdr(xprt, &desc);
1390 /* Read in the xid if necessary */
1391 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1392 xs_tcp_read_xid(transport, &desc);
1395 /* Read in the call/reply flag */
1396 if (transport->tcp_flags & TCP_RCV_READ_CALLDIR) {
1397 xs_tcp_read_calldir(transport, &desc);
1400 /* Read in the request data */
1401 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1402 xs_tcp_read_data(xprt, &desc);
1405 /* Skip over any trailing bytes on short reads */
1406 xs_tcp_read_discard(transport, &desc);
1407 } while (desc.count);
1408 dprintk("RPC: xs_tcp_data_recv done\n");
1409 return len - desc.count;
1413 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1414 * @sk: socket with data to read
1415 * @bytes: how much data to read
1418 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1420 struct rpc_xprt *xprt;
1421 read_descriptor_t rd_desc;
1424 dprintk("RPC: xs_tcp_data_ready...\n");
1426 read_lock_bh(&sk->sk_callback_lock);
1427 if (!(xprt = xprt_from_sock(sk)))
1432 /* Any data means we had a useful conversation, so
1433 * the we don't need to delay the next reconnect
1435 if (xprt->reestablish_timeout)
1436 xprt->reestablish_timeout = 0;
1438 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1439 rd_desc.arg.data = xprt;
1441 rd_desc.count = 65536;
1442 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1445 read_unlock_bh(&sk->sk_callback_lock);
1449 * Do the equivalent of linger/linger2 handling for dealing with
1450 * broken servers that don't close the socket in a timely
1453 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt *xprt,
1454 unsigned long timeout)
1456 struct sock_xprt *transport;
1458 if (xprt_test_and_set_connecting(xprt))
1460 set_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1461 transport = container_of(xprt, struct sock_xprt, xprt);
1462 queue_delayed_work(rpciod_workqueue, &transport->connect_worker,
1466 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt *xprt)
1468 struct sock_xprt *transport;
1470 transport = container_of(xprt, struct sock_xprt, xprt);
1472 if (!test_bit(XPRT_CONNECTION_ABORT, &xprt->state) ||
1473 !cancel_delayed_work(&transport->connect_worker))
1475 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1476 xprt_clear_connecting(xprt);
1479 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1481 smp_mb__before_clear_bit();
1482 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1483 clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1484 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1485 clear_bit(XPRT_CLOSING, &xprt->state);
1486 smp_mb__after_clear_bit();
1489 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
1491 xs_sock_reset_connection_flags(xprt);
1492 /* Mark transport as closed and wake up all pending tasks */
1493 xprt_disconnect_done(xprt);
1497 * xs_tcp_state_change - callback to handle TCP socket state changes
1498 * @sk: socket whose state has changed
1501 static void xs_tcp_state_change(struct sock *sk)
1503 struct rpc_xprt *xprt;
1505 read_lock_bh(&sk->sk_callback_lock);
1506 if (!(xprt = xprt_from_sock(sk)))
1508 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1509 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1510 sk->sk_state, xprt_connected(xprt),
1511 sock_flag(sk, SOCK_DEAD),
1512 sock_flag(sk, SOCK_ZAPPED),
1515 switch (sk->sk_state) {
1516 case TCP_ESTABLISHED:
1517 spin_lock(&xprt->transport_lock);
1518 if (!xprt_test_and_set_connected(xprt)) {
1519 struct sock_xprt *transport = container_of(xprt,
1520 struct sock_xprt, xprt);
1522 /* Reset TCP record info */
1523 transport->tcp_offset = 0;
1524 transport->tcp_reclen = 0;
1525 transport->tcp_copied = 0;
1526 transport->tcp_flags =
1527 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1529 xprt_wake_pending_tasks(xprt, -EAGAIN);
1531 spin_unlock(&xprt->transport_lock);
1534 /* The client initiated a shutdown of the socket */
1535 xprt->connect_cookie++;
1536 xprt->reestablish_timeout = 0;
1537 set_bit(XPRT_CLOSING, &xprt->state);
1538 smp_mb__before_clear_bit();
1539 clear_bit(XPRT_CONNECTED, &xprt->state);
1540 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1541 smp_mb__after_clear_bit();
1542 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1544 case TCP_CLOSE_WAIT:
1545 /* The server initiated a shutdown of the socket */
1546 xprt->connect_cookie++;
1547 clear_bit(XPRT_CONNECTED, &xprt->state);
1548 xs_tcp_force_close(xprt);
1551 * If the server closed down the connection, make sure that
1552 * we back off before reconnecting
1554 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1555 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1558 set_bit(XPRT_CLOSING, &xprt->state);
1559 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1560 smp_mb__before_clear_bit();
1561 clear_bit(XPRT_CONNECTED, &xprt->state);
1562 smp_mb__after_clear_bit();
1565 xs_tcp_cancel_linger_timeout(xprt);
1566 xs_sock_mark_closed(xprt);
1569 read_unlock_bh(&sk->sk_callback_lock);
1572 static void xs_write_space(struct sock *sk)
1574 struct socket *sock;
1575 struct rpc_xprt *xprt;
1577 if (unlikely(!(sock = sk->sk_socket)))
1579 clear_bit(SOCK_NOSPACE, &sock->flags);
1581 if (unlikely(!(xprt = xprt_from_sock(sk))))
1583 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1586 xprt_write_space(xprt);
1590 * xs_udp_write_space - callback invoked when socket buffer space
1592 * @sk: socket whose state has changed
1594 * Called when more output buffer space is available for this socket.
1595 * We try not to wake our writers until they can make "significant"
1596 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1597 * with a bunch of small requests.
1599 static void xs_udp_write_space(struct sock *sk)
1601 read_lock_bh(&sk->sk_callback_lock);
1603 /* from net/core/sock.c:sock_def_write_space */
1604 if (sock_writeable(sk))
1607 read_unlock_bh(&sk->sk_callback_lock);
1611 * xs_tcp_write_space - callback invoked when socket buffer space
1613 * @sk: socket whose state has changed
1615 * Called when more output buffer space is available for this socket.
1616 * We try not to wake our writers until they can make "significant"
1617 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1618 * with a bunch of small requests.
1620 static void xs_tcp_write_space(struct sock *sk)
1622 read_lock_bh(&sk->sk_callback_lock);
1624 /* from net/core/stream.c:sk_stream_write_space */
1625 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1628 read_unlock_bh(&sk->sk_callback_lock);
1631 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1633 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1634 struct sock *sk = transport->inet;
1636 if (transport->rcvsize) {
1637 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1638 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1640 if (transport->sndsize) {
1641 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1642 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1643 sk->sk_write_space(sk);
1648 * xs_udp_set_buffer_size - set send and receive limits
1649 * @xprt: generic transport
1650 * @sndsize: requested size of send buffer, in bytes
1651 * @rcvsize: requested size of receive buffer, in bytes
1653 * Set socket send and receive buffer size limits.
1655 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1657 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1659 transport->sndsize = 0;
1661 transport->sndsize = sndsize + 1024;
1662 transport->rcvsize = 0;
1664 transport->rcvsize = rcvsize + 1024;
1666 xs_udp_do_set_buffer_size(xprt);
1670 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1671 * @task: task that timed out
1673 * Adjust the congestion window after a retransmit timeout has occurred.
1675 static void xs_udp_timer(struct rpc_task *task)
1677 xprt_adjust_cwnd(task, -ETIMEDOUT);
1680 static unsigned short xs_get_random_port(void)
1682 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1683 unsigned short rand = (unsigned short) net_random() % range;
1684 return rand + xprt_min_resvport;
1688 * xs_set_port - reset the port number in the remote endpoint address
1689 * @xprt: generic transport
1690 * @port: new port number
1693 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1695 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1697 rpc_set_port(xs_addr(xprt), port);
1698 xs_update_peer_port(xprt);
1701 static unsigned short xs_get_srcport(struct sock_xprt *transport)
1703 unsigned short port = transport->srcport;
1705 if (port == 0 && transport->xprt.resvport)
1706 port = xs_get_random_port();
1710 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1712 if (transport->srcport != 0)
1713 transport->srcport = 0;
1714 if (!transport->xprt.resvport)
1716 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1717 return xprt_max_resvport;
1720 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1722 struct sockaddr_storage myaddr;
1724 unsigned short port = xs_get_srcport(transport);
1725 unsigned short last;
1727 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1729 rpc_set_port((struct sockaddr *)&myaddr, port);
1730 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1731 transport->xprt.addrlen);
1735 transport->srcport = port;
1739 port = xs_next_srcport(transport, port);
1742 } while (err == -EADDRINUSE && nloop != 2);
1744 if (myaddr.ss_family == AF_INET)
1745 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1746 &((struct sockaddr_in *)&myaddr)->sin_addr,
1747 port, err ? "failed" : "ok", err);
1749 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1750 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1751 port, err ? "failed" : "ok", err);
1756 * We don't support autobind on AF_LOCAL sockets
1758 static void xs_local_rpcbind(struct rpc_task *task)
1760 xprt_set_bound(task->tk_xprt);
1763 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1767 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1768 static struct lock_class_key xs_key[2];
1769 static struct lock_class_key xs_slock_key[2];
1771 static inline void xs_reclassify_socketu(struct socket *sock)
1773 struct sock *sk = sock->sk;
1775 BUG_ON(sock_owned_by_user(sk));
1776 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1777 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1780 static inline void xs_reclassify_socket4(struct socket *sock)
1782 struct sock *sk = sock->sk;
1784 BUG_ON(sock_owned_by_user(sk));
1785 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1786 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1789 static inline void xs_reclassify_socket6(struct socket *sock)
1791 struct sock *sk = sock->sk;
1793 BUG_ON(sock_owned_by_user(sk));
1794 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1795 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1798 static inline void xs_reclassify_socket(int family, struct socket *sock)
1802 xs_reclassify_socketu(sock);
1805 xs_reclassify_socket4(sock);
1808 xs_reclassify_socket6(sock);
1813 static inline void xs_reclassify_socketu(struct socket *sock)
1817 static inline void xs_reclassify_socket4(struct socket *sock)
1821 static inline void xs_reclassify_socket6(struct socket *sock)
1825 static inline void xs_reclassify_socket(int family, struct socket *sock)
1830 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1831 struct sock_xprt *transport, int family, int type, int protocol)
1833 struct socket *sock;
1836 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1838 dprintk("RPC: can't create %d transport socket (%d).\n",
1842 xs_reclassify_socket(family, sock);
1844 err = xs_bind(transport, sock);
1852 return ERR_PTR(err);
1855 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1856 struct socket *sock)
1858 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1861 if (!transport->inet) {
1862 struct sock *sk = sock->sk;
1864 write_lock_bh(&sk->sk_callback_lock);
1866 xs_save_old_callbacks(transport, sk);
1868 sk->sk_user_data = xprt;
1869 sk->sk_data_ready = xs_local_data_ready;
1870 sk->sk_write_space = xs_udp_write_space;
1871 sk->sk_allocation = GFP_ATOMIC;
1873 xprt_clear_connected(xprt);
1875 /* Reset to new socket */
1876 transport->sock = sock;
1877 transport->inet = sk;
1879 write_unlock_bh(&sk->sk_callback_lock);
1882 /* Tell the socket layer to start connecting... */
1883 xprt->stat.connect_count++;
1884 xprt->stat.connect_start = jiffies;
1885 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1889 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1890 * @xprt: RPC transport to connect
1891 * @transport: socket transport to connect
1892 * @create_sock: function to create a socket of the correct type
1894 * Invoked by a work queue tasklet.
1896 static void xs_local_setup_socket(struct work_struct *work)
1898 struct sock_xprt *transport =
1899 container_of(work, struct sock_xprt, connect_worker.work);
1900 struct rpc_xprt *xprt = &transport->xprt;
1901 struct socket *sock;
1907 current->flags |= PF_FSTRANS;
1909 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1910 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1911 SOCK_STREAM, 0, &sock, 1);
1913 dprintk("RPC: can't create AF_LOCAL "
1914 "transport socket (%d).\n", -status);
1917 xs_reclassify_socketu(sock);
1919 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1920 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1922 status = xs_local_finish_connecting(xprt, sock);
1925 dprintk("RPC: xprt %p connected to %s\n",
1926 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1927 xprt_set_connected(xprt);
1930 dprintk("RPC: xprt %p: socket %s does not exist\n",
1931 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1934 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1936 xprt->address_strings[RPC_DISPLAY_ADDR]);
1940 xprt_clear_connecting(xprt);
1941 xprt_wake_pending_tasks(xprt, status);
1942 current->flags &= ~PF_FSTRANS;
1945 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1947 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1949 if (!transport->inet) {
1950 struct sock *sk = sock->sk;
1952 write_lock_bh(&sk->sk_callback_lock);
1954 xs_save_old_callbacks(transport, sk);
1956 sk->sk_user_data = xprt;
1957 sk->sk_data_ready = xs_udp_data_ready;
1958 sk->sk_write_space = xs_udp_write_space;
1959 sk->sk_no_check = UDP_CSUM_NORCV;
1960 sk->sk_allocation = GFP_ATOMIC;
1962 xprt_set_connected(xprt);
1964 /* Reset to new socket */
1965 transport->sock = sock;
1966 transport->inet = sk;
1968 write_unlock_bh(&sk->sk_callback_lock);
1970 xs_udp_do_set_buffer_size(xprt);
1973 static void xs_udp_setup_socket(struct work_struct *work)
1975 struct sock_xprt *transport =
1976 container_of(work, struct sock_xprt, connect_worker.work);
1977 struct rpc_xprt *xprt = &transport->xprt;
1978 struct socket *sock = transport->sock;
1984 current->flags |= PF_FSTRANS;
1986 /* Start by resetting any existing state */
1987 xs_reset_transport(transport);
1988 sock = xs_create_sock(xprt, transport,
1989 xs_addr(xprt)->sa_family, SOCK_DGRAM, IPPROTO_UDP);
1993 dprintk("RPC: worker connecting xprt %p via %s to "
1994 "%s (port %s)\n", xprt,
1995 xprt->address_strings[RPC_DISPLAY_PROTO],
1996 xprt->address_strings[RPC_DISPLAY_ADDR],
1997 xprt->address_strings[RPC_DISPLAY_PORT]);
1999 xs_udp_finish_connecting(xprt, sock);
2002 xprt_clear_connecting(xprt);
2003 xprt_wake_pending_tasks(xprt, status);
2004 current->flags &= ~PF_FSTRANS;
2008 * We need to preserve the port number so the reply cache on the server can
2009 * find our cached RPC replies when we get around to reconnecting.
2011 static void xs_abort_connection(struct sock_xprt *transport)
2014 struct sockaddr any;
2016 dprintk("RPC: disconnecting xprt %p to reuse port\n", transport);
2019 * Disconnect the transport socket by doing a connect operation
2020 * with AF_UNSPEC. This should return immediately...
2022 memset(&any, 0, sizeof(any));
2023 any.sa_family = AF_UNSPEC;
2024 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
2026 xs_sock_reset_connection_flags(&transport->xprt);
2027 dprintk("RPC: AF_UNSPEC connect return code %d\n", result);
2030 static void xs_tcp_reuse_connection(struct sock_xprt *transport)
2032 unsigned int state = transport->inet->sk_state;
2034 if (state == TCP_CLOSE && transport->sock->state == SS_UNCONNECTED) {
2035 /* we don't need to abort the connection if the socket
2036 * hasn't undergone a shutdown
2038 if (transport->inet->sk_shutdown == 0)
2040 dprintk("RPC: %s: TCP_CLOSEd and sk_shutdown set to %d\n",
2041 __func__, transport->inet->sk_shutdown);
2043 if ((1 << state) & (TCPF_ESTABLISHED|TCPF_SYN_SENT)) {
2044 /* we don't need to abort the connection if the socket
2045 * hasn't undergone a shutdown
2047 if (transport->inet->sk_shutdown == 0)
2049 dprintk("RPC: %s: ESTABLISHED/SYN_SENT "
2050 "sk_shutdown set to %d\n",
2051 __func__, transport->inet->sk_shutdown);
2053 xs_abort_connection(transport);
2056 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2058 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2059 int ret = -ENOTCONN;
2061 if (!transport->inet) {
2062 struct sock *sk = sock->sk;
2064 write_lock_bh(&sk->sk_callback_lock);
2066 xs_save_old_callbacks(transport, sk);
2068 sk->sk_user_data = xprt;
2069 sk->sk_data_ready = xs_tcp_data_ready;
2070 sk->sk_state_change = xs_tcp_state_change;
2071 sk->sk_write_space = xs_tcp_write_space;
2072 sk->sk_allocation = GFP_ATOMIC;
2074 /* socket options */
2075 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
2076 sock_reset_flag(sk, SOCK_LINGER);
2077 tcp_sk(sk)->linger2 = 0;
2078 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2080 xprt_clear_connected(xprt);
2082 /* Reset to new socket */
2083 transport->sock = sock;
2084 transport->inet = sk;
2086 write_unlock_bh(&sk->sk_callback_lock);
2089 if (!xprt_bound(xprt))
2092 /* Tell the socket layer to start connecting... */
2093 xprt->stat.connect_count++;
2094 xprt->stat.connect_start = jiffies;
2095 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2100 xprt->connect_cookie++;
2101 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2102 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2109 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2110 * @xprt: RPC transport to connect
2111 * @transport: socket transport to connect
2112 * @create_sock: function to create a socket of the correct type
2114 * Invoked by a work queue tasklet.
2116 static void xs_tcp_setup_socket(struct work_struct *work)
2118 struct sock_xprt *transport =
2119 container_of(work, struct sock_xprt, connect_worker.work);
2120 struct socket *sock = transport->sock;
2121 struct rpc_xprt *xprt = &transport->xprt;
2127 current->flags |= PF_FSTRANS;
2130 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
2131 sock = xs_create_sock(xprt, transport,
2132 xs_addr(xprt)->sa_family, SOCK_STREAM, IPPROTO_TCP);
2134 status = PTR_ERR(sock);
2140 abort_and_exit = test_and_clear_bit(XPRT_CONNECTION_ABORT,
2142 /* "close" the socket, preserving the local port */
2143 xs_tcp_reuse_connection(transport);
2149 dprintk("RPC: worker connecting xprt %p via %s to "
2150 "%s (port %s)\n", xprt,
2151 xprt->address_strings[RPC_DISPLAY_PROTO],
2152 xprt->address_strings[RPC_DISPLAY_ADDR],
2153 xprt->address_strings[RPC_DISPLAY_PORT]);
2155 status = xs_tcp_finish_connecting(xprt, sock);
2156 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2157 xprt, -status, xprt_connected(xprt),
2158 sock->sk->sk_state);
2161 printk("%s: connect returned unhandled error %d\n",
2163 case -EADDRNOTAVAIL:
2164 /* We're probably in TIME_WAIT. Get rid of existing socket,
2167 xs_tcp_force_close(xprt);
2172 /* retry with existing socket, after a delay */
2176 xprt_clear_connecting(xprt);
2177 current->flags &= ~PF_FSTRANS;
2180 /* Happens, for instance, if the user specified a link
2181 * local IPv6 address without a scope-id.
2188 xprt_clear_connecting(xprt);
2189 xprt_wake_pending_tasks(xprt, status);
2190 current->flags &= ~PF_FSTRANS;
2194 * xs_connect - connect a socket to a remote endpoint
2195 * @task: address of RPC task that manages state of connect request
2197 * TCP: If the remote end dropped the connection, delay reconnecting.
2199 * UDP socket connects are synchronous, but we use a work queue anyway
2200 * to guarantee that even unprivileged user processes can set up a
2201 * socket on a privileged port.
2203 * If a UDP socket connect fails, the delay behavior here prevents
2204 * retry floods (hard mounts).
2206 static void xs_connect(struct rpc_task *task)
2208 struct rpc_xprt *xprt = task->tk_xprt;
2209 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2211 if (transport->sock != NULL && !RPC_IS_SOFTCONN(task)) {
2212 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2214 xprt, xprt->reestablish_timeout / HZ);
2215 queue_delayed_work(rpciod_workqueue,
2216 &transport->connect_worker,
2217 xprt->reestablish_timeout);
2218 xprt->reestablish_timeout <<= 1;
2219 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2220 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2221 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
2222 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
2224 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2225 queue_delayed_work(rpciod_workqueue,
2226 &transport->connect_worker, 0);
2231 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2232 * @xprt: rpc_xprt struct containing statistics
2236 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2240 if (xprt_connected(xprt))
2241 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2243 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2245 xprt->stat.bind_count,
2246 xprt->stat.connect_count,
2247 xprt->stat.connect_time,
2251 xprt->stat.bad_xids,
2253 xprt->stat.bklog_u);
2257 * xs_udp_print_stats - display UDP socket-specifc stats
2258 * @xprt: rpc_xprt struct containing statistics
2262 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2264 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2266 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
2268 xprt->stat.bind_count,
2271 xprt->stat.bad_xids,
2273 xprt->stat.bklog_u);
2277 * xs_tcp_print_stats - display TCP socket-specifc stats
2278 * @xprt: rpc_xprt struct containing statistics
2282 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2284 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2287 if (xprt_connected(xprt))
2288 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2290 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
2292 xprt->stat.bind_count,
2293 xprt->stat.connect_count,
2294 xprt->stat.connect_time,
2298 xprt->stat.bad_xids,
2300 xprt->stat.bklog_u);
2304 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2305 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2306 * to use the server side send routines.
2308 static void *bc_malloc(struct rpc_task *task, size_t size)
2311 struct rpc_buffer *buf;
2313 BUG_ON(size > PAGE_SIZE - sizeof(struct rpc_buffer));
2314 page = alloc_page(GFP_KERNEL);
2319 buf = page_address(page);
2320 buf->len = PAGE_SIZE;
2326 * Free the space allocated in the bc_alloc routine
2328 static void bc_free(void *buffer)
2330 struct rpc_buffer *buf;
2335 buf = container_of(buffer, struct rpc_buffer, data);
2336 free_page((unsigned long)buf);
2340 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2341 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2343 static int bc_sendto(struct rpc_rqst *req)
2346 struct xdr_buf *xbufp = &req->rq_snd_buf;
2347 struct rpc_xprt *xprt = req->rq_xprt;
2348 struct sock_xprt *transport =
2349 container_of(xprt, struct sock_xprt, xprt);
2350 struct socket *sock = transport->sock;
2351 unsigned long headoff;
2352 unsigned long tailoff;
2354 xs_encode_stream_record_marker(xbufp);
2356 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2357 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2358 len = svc_send_common(sock, xbufp,
2359 virt_to_page(xbufp->head[0].iov_base), headoff,
2360 xbufp->tail[0].iov_base, tailoff);
2362 if (len != xbufp->len) {
2363 printk(KERN_NOTICE "Error sending entire callback!\n");
2371 * The send routine. Borrows from svc_send
2373 static int bc_send_request(struct rpc_task *task)
2375 struct rpc_rqst *req = task->tk_rqstp;
2376 struct svc_xprt *xprt;
2377 struct svc_sock *svsk;
2380 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2382 * Get the server socket associated with this callback xprt
2384 xprt = req->rq_xprt->bc_xprt;
2385 svsk = container_of(xprt, struct svc_sock, sk_xprt);
2388 * Grab the mutex to serialize data as the connection is shared
2389 * with the fore channel
2391 if (!mutex_trylock(&xprt->xpt_mutex)) {
2392 rpc_sleep_on(&xprt->xpt_bc_pending, task, NULL);
2393 if (!mutex_trylock(&xprt->xpt_mutex))
2395 rpc_wake_up_queued_task(&xprt->xpt_bc_pending, task);
2397 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2400 len = bc_sendto(req);
2401 mutex_unlock(&xprt->xpt_mutex);
2410 * The close routine. Since this is client initiated, we do nothing
2413 static void bc_close(struct rpc_xprt *xprt)
2418 * The xprt destroy routine. Again, because this connection is client
2419 * initiated, we do nothing
2422 static void bc_destroy(struct rpc_xprt *xprt)
2426 static struct rpc_xprt_ops xs_local_ops = {
2427 .reserve_xprt = xprt_reserve_xprt,
2428 .release_xprt = xs_tcp_release_xprt,
2429 .alloc_slot = xprt_alloc_slot,
2430 .rpcbind = xs_local_rpcbind,
2431 .set_port = xs_local_set_port,
2432 .connect = xs_connect,
2433 .buf_alloc = rpc_malloc,
2434 .buf_free = rpc_free,
2435 .send_request = xs_local_send_request,
2436 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2438 .destroy = xs_destroy,
2439 .print_stats = xs_local_print_stats,
2442 static struct rpc_xprt_ops xs_udp_ops = {
2443 .set_buffer_size = xs_udp_set_buffer_size,
2444 .reserve_xprt = xprt_reserve_xprt_cong,
2445 .release_xprt = xprt_release_xprt_cong,
2446 .alloc_slot = xprt_alloc_slot,
2447 .rpcbind = rpcb_getport_async,
2448 .set_port = xs_set_port,
2449 .connect = xs_connect,
2450 .buf_alloc = rpc_malloc,
2451 .buf_free = rpc_free,
2452 .send_request = xs_udp_send_request,
2453 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2454 .timer = xs_udp_timer,
2455 .release_request = xprt_release_rqst_cong,
2457 .destroy = xs_destroy,
2458 .print_stats = xs_udp_print_stats,
2461 static struct rpc_xprt_ops xs_tcp_ops = {
2462 .reserve_xprt = xprt_reserve_xprt,
2463 .release_xprt = xs_tcp_release_xprt,
2464 .alloc_slot = xprt_lock_and_alloc_slot,
2465 .rpcbind = rpcb_getport_async,
2466 .set_port = xs_set_port,
2467 .connect = xs_connect,
2468 .buf_alloc = rpc_malloc,
2469 .buf_free = rpc_free,
2470 .send_request = xs_tcp_send_request,
2471 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2472 .close = xs_tcp_close,
2473 .destroy = xs_destroy,
2474 .print_stats = xs_tcp_print_stats,
2478 * The rpc_xprt_ops for the server backchannel
2481 static struct rpc_xprt_ops bc_tcp_ops = {
2482 .reserve_xprt = xprt_reserve_xprt,
2483 .release_xprt = xprt_release_xprt,
2484 .alloc_slot = xprt_alloc_slot,
2485 .buf_alloc = bc_malloc,
2486 .buf_free = bc_free,
2487 .send_request = bc_send_request,
2488 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2490 .destroy = bc_destroy,
2491 .print_stats = xs_tcp_print_stats,
2494 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2496 static const struct sockaddr_in sin = {
2497 .sin_family = AF_INET,
2498 .sin_addr.s_addr = htonl(INADDR_ANY),
2500 static const struct sockaddr_in6 sin6 = {
2501 .sin6_family = AF_INET6,
2502 .sin6_addr = IN6ADDR_ANY_INIT,
2509 memcpy(sap, &sin, sizeof(sin));
2512 memcpy(sap, &sin6, sizeof(sin6));
2515 dprintk("RPC: %s: Bad address family\n", __func__);
2516 return -EAFNOSUPPORT;
2521 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2522 unsigned int slot_table_size,
2523 unsigned int max_slot_table_size)
2525 struct rpc_xprt *xprt;
2526 struct sock_xprt *new;
2528 if (args->addrlen > sizeof(xprt->addr)) {
2529 dprintk("RPC: xs_setup_xprt: address too large\n");
2530 return ERR_PTR(-EBADF);
2533 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2534 max_slot_table_size);
2536 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2538 return ERR_PTR(-ENOMEM);
2541 new = container_of(xprt, struct sock_xprt, xprt);
2542 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2543 xprt->addrlen = args->addrlen;
2545 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2548 err = xs_init_anyaddr(args->dstaddr->sa_family,
2549 (struct sockaddr *)&new->srcaddr);
2552 return ERR_PTR(err);
2559 static const struct rpc_timeout xs_local_default_timeout = {
2560 .to_initval = 10 * HZ,
2561 .to_maxval = 10 * HZ,
2566 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2567 * @args: rpc transport creation arguments
2569 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2571 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2573 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2574 struct sock_xprt *transport;
2575 struct rpc_xprt *xprt;
2576 struct rpc_xprt *ret;
2578 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2579 xprt_max_tcp_slot_table_entries);
2582 transport = container_of(xprt, struct sock_xprt, xprt);
2585 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2586 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2588 xprt->bind_timeout = XS_BIND_TO;
2589 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2590 xprt->idle_timeout = XS_IDLE_DISC_TO;
2592 xprt->ops = &xs_local_ops;
2593 xprt->timeout = &xs_local_default_timeout;
2595 switch (sun->sun_family) {
2597 if (sun->sun_path[0] != '/') {
2598 dprintk("RPC: bad AF_LOCAL address: %s\n",
2600 ret = ERR_PTR(-EINVAL);
2603 xprt_set_bound(xprt);
2604 INIT_DELAYED_WORK(&transport->connect_worker,
2605 xs_local_setup_socket);
2606 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2609 ret = ERR_PTR(-EAFNOSUPPORT);
2613 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2614 xprt->address_strings[RPC_DISPLAY_ADDR]);
2616 if (try_module_get(THIS_MODULE))
2618 ret = ERR_PTR(-EINVAL);
2624 static const struct rpc_timeout xs_udp_default_timeout = {
2625 .to_initval = 5 * HZ,
2626 .to_maxval = 30 * HZ,
2627 .to_increment = 5 * HZ,
2632 * xs_setup_udp - Set up transport to use a UDP socket
2633 * @args: rpc transport creation arguments
2636 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2638 struct sockaddr *addr = args->dstaddr;
2639 struct rpc_xprt *xprt;
2640 struct sock_xprt *transport;
2641 struct rpc_xprt *ret;
2643 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2644 xprt_udp_slot_table_entries);
2647 transport = container_of(xprt, struct sock_xprt, xprt);
2649 xprt->prot = IPPROTO_UDP;
2651 /* XXX: header size can vary due to auth type, IPv6, etc. */
2652 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2654 xprt->bind_timeout = XS_BIND_TO;
2655 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2656 xprt->idle_timeout = XS_IDLE_DISC_TO;
2658 xprt->ops = &xs_udp_ops;
2660 xprt->timeout = &xs_udp_default_timeout;
2662 switch (addr->sa_family) {
2664 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2665 xprt_set_bound(xprt);
2667 INIT_DELAYED_WORK(&transport->connect_worker,
2668 xs_udp_setup_socket);
2669 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2672 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2673 xprt_set_bound(xprt);
2675 INIT_DELAYED_WORK(&transport->connect_worker,
2676 xs_udp_setup_socket);
2677 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2680 ret = ERR_PTR(-EAFNOSUPPORT);
2684 if (xprt_bound(xprt))
2685 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2686 xprt->address_strings[RPC_DISPLAY_ADDR],
2687 xprt->address_strings[RPC_DISPLAY_PORT],
2688 xprt->address_strings[RPC_DISPLAY_PROTO]);
2690 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2691 xprt->address_strings[RPC_DISPLAY_ADDR],
2692 xprt->address_strings[RPC_DISPLAY_PROTO]);
2694 if (try_module_get(THIS_MODULE))
2696 ret = ERR_PTR(-EINVAL);
2702 static const struct rpc_timeout xs_tcp_default_timeout = {
2703 .to_initval = 60 * HZ,
2704 .to_maxval = 60 * HZ,
2709 * xs_setup_tcp - Set up transport to use a TCP socket
2710 * @args: rpc transport creation arguments
2713 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2715 struct sockaddr *addr = args->dstaddr;
2716 struct rpc_xprt *xprt;
2717 struct sock_xprt *transport;
2718 struct rpc_xprt *ret;
2720 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2721 xprt_max_tcp_slot_table_entries);
2724 transport = container_of(xprt, struct sock_xprt, xprt);
2726 xprt->prot = IPPROTO_TCP;
2727 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2728 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2730 xprt->bind_timeout = XS_BIND_TO;
2731 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2732 xprt->idle_timeout = XS_IDLE_DISC_TO;
2734 xprt->ops = &xs_tcp_ops;
2735 xprt->timeout = &xs_tcp_default_timeout;
2737 switch (addr->sa_family) {
2739 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2740 xprt_set_bound(xprt);
2742 INIT_DELAYED_WORK(&transport->connect_worker,
2743 xs_tcp_setup_socket);
2744 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2747 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2748 xprt_set_bound(xprt);
2750 INIT_DELAYED_WORK(&transport->connect_worker,
2751 xs_tcp_setup_socket);
2752 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2755 ret = ERR_PTR(-EAFNOSUPPORT);
2759 if (xprt_bound(xprt))
2760 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2761 xprt->address_strings[RPC_DISPLAY_ADDR],
2762 xprt->address_strings[RPC_DISPLAY_PORT],
2763 xprt->address_strings[RPC_DISPLAY_PROTO]);
2765 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2766 xprt->address_strings[RPC_DISPLAY_ADDR],
2767 xprt->address_strings[RPC_DISPLAY_PROTO]);
2770 if (try_module_get(THIS_MODULE))
2772 ret = ERR_PTR(-EINVAL);
2779 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
2780 * @args: rpc transport creation arguments
2783 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
2785 struct sockaddr *addr = args->dstaddr;
2786 struct rpc_xprt *xprt;
2787 struct sock_xprt *transport;
2788 struct svc_sock *bc_sock;
2789 struct rpc_xprt *ret;
2791 if (args->bc_xprt->xpt_bc_xprt) {
2793 * This server connection already has a backchannel
2794 * export; we can't create a new one, as we wouldn't be
2795 * able to match replies based on xid any more. So,
2796 * reuse the already-existing one:
2798 return args->bc_xprt->xpt_bc_xprt;
2800 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2801 xprt_tcp_slot_table_entries);
2804 transport = container_of(xprt, struct sock_xprt, xprt);
2806 xprt->prot = IPPROTO_TCP;
2807 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2808 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2809 xprt->timeout = &xs_tcp_default_timeout;
2812 xprt_set_bound(xprt);
2813 xprt->bind_timeout = 0;
2814 xprt->reestablish_timeout = 0;
2815 xprt->idle_timeout = 0;
2817 xprt->ops = &bc_tcp_ops;
2819 switch (addr->sa_family) {
2821 xs_format_peer_addresses(xprt, "tcp",
2825 xs_format_peer_addresses(xprt, "tcp",
2826 RPCBIND_NETID_TCP6);
2829 ret = ERR_PTR(-EAFNOSUPPORT);
2833 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2834 xprt->address_strings[RPC_DISPLAY_ADDR],
2835 xprt->address_strings[RPC_DISPLAY_PORT],
2836 xprt->address_strings[RPC_DISPLAY_PROTO]);
2839 * Once we've associated a backchannel xprt with a connection,
2840 * we want to keep it around as long as long as the connection
2841 * lasts, in case we need to start using it for a backchannel
2842 * again; this reference won't be dropped until bc_xprt is
2846 args->bc_xprt->xpt_bc_xprt = xprt;
2847 xprt->bc_xprt = args->bc_xprt;
2848 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
2849 transport->sock = bc_sock->sk_sock;
2850 transport->inet = bc_sock->sk_sk;
2853 * Since we don't want connections for the backchannel, we set
2854 * the xprt status to connected
2856 xprt_set_connected(xprt);
2859 if (try_module_get(THIS_MODULE))
2862 ret = ERR_PTR(-EINVAL);
2868 static struct xprt_class xs_local_transport = {
2869 .list = LIST_HEAD_INIT(xs_local_transport.list),
2870 .name = "named UNIX socket",
2871 .owner = THIS_MODULE,
2872 .ident = XPRT_TRANSPORT_LOCAL,
2873 .setup = xs_setup_local,
2876 static struct xprt_class xs_udp_transport = {
2877 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2879 .owner = THIS_MODULE,
2880 .ident = XPRT_TRANSPORT_UDP,
2881 .setup = xs_setup_udp,
2884 static struct xprt_class xs_tcp_transport = {
2885 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2887 .owner = THIS_MODULE,
2888 .ident = XPRT_TRANSPORT_TCP,
2889 .setup = xs_setup_tcp,
2892 static struct xprt_class xs_bc_tcp_transport = {
2893 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
2894 .name = "tcp NFSv4.1 backchannel",
2895 .owner = THIS_MODULE,
2896 .ident = XPRT_TRANSPORT_BC_TCP,
2897 .setup = xs_setup_bc_tcp,
2901 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2904 int init_socket_xprt(void)
2907 if (!sunrpc_table_header)
2908 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2911 xprt_register_transport(&xs_local_transport);
2912 xprt_register_transport(&xs_udp_transport);
2913 xprt_register_transport(&xs_tcp_transport);
2914 xprt_register_transport(&xs_bc_tcp_transport);
2920 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2923 void cleanup_socket_xprt(void)
2926 if (sunrpc_table_header) {
2927 unregister_sysctl_table(sunrpc_table_header);
2928 sunrpc_table_header = NULL;
2932 xprt_unregister_transport(&xs_local_transport);
2933 xprt_unregister_transport(&xs_udp_transport);
2934 xprt_unregister_transport(&xs_tcp_transport);
2935 xprt_unregister_transport(&xs_bc_tcp_transport);
2938 static int param_set_uint_minmax(const char *val,
2939 const struct kernel_param *kp,
2940 unsigned int min, unsigned int max)
2947 ret = strict_strtoul(val, 0, &num);
2948 if (ret == -EINVAL || num < min || num > max)
2950 *((unsigned int *)kp->arg) = num;
2954 static int param_set_portnr(const char *val, const struct kernel_param *kp)
2956 return param_set_uint_minmax(val, kp,
2961 static struct kernel_param_ops param_ops_portnr = {
2962 .set = param_set_portnr,
2963 .get = param_get_uint,
2966 #define param_check_portnr(name, p) \
2967 __param_check(name, p, unsigned int);
2969 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
2970 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
2972 static int param_set_slot_table_size(const char *val,
2973 const struct kernel_param *kp)
2975 return param_set_uint_minmax(val, kp,
2977 RPC_MAX_SLOT_TABLE);
2980 static struct kernel_param_ops param_ops_slot_table_size = {
2981 .set = param_set_slot_table_size,
2982 .get = param_get_uint,
2985 #define param_check_slot_table_size(name, p) \
2986 __param_check(name, p, unsigned int);
2988 static int param_set_max_slot_table_size(const char *val,
2989 const struct kernel_param *kp)
2991 return param_set_uint_minmax(val, kp,
2993 RPC_MAX_SLOT_TABLE_LIMIT);
2996 static struct kernel_param_ops param_ops_max_slot_table_size = {
2997 .set = param_set_max_slot_table_size,
2998 .get = param_get_uint,
3001 #define param_check_max_slot_table_size(name, p) \
3002 __param_check(name, p, unsigned int);
3004 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3005 slot_table_size, 0644);
3006 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3007 max_slot_table_size, 0644);
3008 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3009 slot_table_size, 0644);