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
11 * Rewrite of larges part of the code in order to stabilize TCP stuff.
12 * Fix behaviour when socket buffer is full.
17 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005.
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)
397 unsigned int remainder;
400 remainder = xdr->page_len - base;
401 base += xdr->page_base;
402 ppage = xdr->pages + (base >> PAGE_SHIFT);
405 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
406 int flags = XS_SENDMSG_FLAGS;
409 if (remainder != 0 || more)
411 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
412 if (remainder == 0 || err != len)
426 * xs_sendpages - write pages directly to a socket
427 * @sock: socket to send on
428 * @addr: UDP only -- address of destination
429 * @addrlen: UDP only -- length of destination address
430 * @xdr: buffer containing this request
431 * @base: starting position in the buffer
434 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
436 unsigned int remainder = xdr->len - base;
442 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
448 if (base < xdr->head[0].iov_len || addr != NULL) {
449 unsigned int len = xdr->head[0].iov_len - base;
451 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
452 if (remainder == 0 || err != len)
457 base -= xdr->head[0].iov_len;
459 if (base < xdr->page_len) {
460 unsigned int len = xdr->page_len - base;
462 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
463 if (remainder == 0 || err != len)
468 base -= xdr->page_len;
470 if (base >= xdr->tail[0].iov_len)
472 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
481 static void xs_nospace_callback(struct rpc_task *task)
483 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
485 transport->inet->sk_write_pending--;
486 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
490 * xs_nospace - place task on wait queue if transmit was incomplete
491 * @task: task to put to sleep
494 static int xs_nospace(struct rpc_task *task)
496 struct rpc_rqst *req = task->tk_rqstp;
497 struct rpc_xprt *xprt = req->rq_xprt;
498 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
501 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
502 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
505 /* Protect against races with write_space */
506 spin_lock_bh(&xprt->transport_lock);
508 /* Don't race with disconnect */
509 if (xprt_connected(xprt)) {
510 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
512 * Notify TCP that we're limited by the application
515 set_bit(SOCK_NOSPACE, &transport->sock->flags);
516 transport->inet->sk_write_pending++;
517 /* ...and wait for more buffer space */
518 xprt_wait_for_buffer_space(task, xs_nospace_callback);
521 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
525 spin_unlock_bh(&xprt->transport_lock);
530 * Construct a stream transport record marker in @buf.
532 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf)
534 u32 reclen = buf->len - sizeof(rpc_fraghdr);
535 rpc_fraghdr *base = buf->head[0].iov_base;
536 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen);
540 * xs_local_send_request - write an RPC request to an AF_LOCAL socket
541 * @task: RPC task that manages the state of an RPC request
544 * 0: The request has been sent
545 * EAGAIN: The socket was blocked, please call again later to
546 * complete the request
547 * ENOTCONN: Caller needs to invoke connect logic then call again
548 * other: Some other error occured, the request was not sent
550 static int xs_local_send_request(struct rpc_task *task)
552 struct rpc_rqst *req = task->tk_rqstp;
553 struct rpc_xprt *xprt = req->rq_xprt;
554 struct sock_xprt *transport =
555 container_of(xprt, struct sock_xprt, xprt);
556 struct xdr_buf *xdr = &req->rq_snd_buf;
559 xs_encode_stream_record_marker(&req->rq_snd_buf);
561 xs_pktdump("packet data:",
562 req->rq_svec->iov_base, req->rq_svec->iov_len);
564 status = xs_sendpages(transport->sock, NULL, 0,
565 xdr, req->rq_bytes_sent);
566 dprintk("RPC: %s(%u) = %d\n",
567 __func__, xdr->len - req->rq_bytes_sent, status);
568 if (likely(status >= 0)) {
569 req->rq_bytes_sent += status;
570 req->rq_xmit_bytes_sent += status;
571 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
572 req->rq_bytes_sent = 0;
580 status = xs_nospace(task);
583 dprintk("RPC: sendmsg returned unrecognized error %d\n",
594 * xs_udp_send_request - write an RPC request to a UDP socket
595 * @task: address of RPC task that manages the state of an RPC request
598 * 0: The request has been sent
599 * EAGAIN: The socket was blocked, please call again later to
600 * complete the request
601 * ENOTCONN: Caller needs to invoke connect logic then call again
602 * other: Some other error occurred, the request was not sent
604 static int xs_udp_send_request(struct rpc_task *task)
606 struct rpc_rqst *req = task->tk_rqstp;
607 struct rpc_xprt *xprt = req->rq_xprt;
608 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
609 struct xdr_buf *xdr = &req->rq_snd_buf;
612 xs_pktdump("packet data:",
613 req->rq_svec->iov_base,
614 req->rq_svec->iov_len);
616 if (!xprt_bound(xprt))
618 status = xs_sendpages(transport->sock,
623 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
624 xdr->len - req->rq_bytes_sent, status);
627 req->rq_xmit_bytes_sent += status;
628 if (status >= req->rq_slen)
630 /* Still some bytes left; set up for a retry later. */
637 /* Should we call xs_close() here? */
640 status = xs_nospace(task);
643 dprintk("RPC: sendmsg returned unrecognized error %d\n",
648 /* When the server has died, an ICMP port unreachable message
649 * prompts ECONNREFUSED. */
650 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
657 * xs_tcp_shutdown - gracefully shut down a TCP socket
660 * Initiates a graceful shutdown of the TCP socket by calling the
661 * equivalent of shutdown(SHUT_WR);
663 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
665 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
666 struct socket *sock = transport->sock;
669 kernel_sock_shutdown(sock, SHUT_WR);
673 * xs_tcp_send_request - write an RPC request to a TCP socket
674 * @task: address of RPC task that manages the state of an RPC request
677 * 0: The request has been sent
678 * EAGAIN: The socket was blocked, please call again later to
679 * complete the request
680 * ENOTCONN: Caller needs to invoke connect logic then call again
681 * other: Some other error occurred, the request was not sent
683 * XXX: In the case of soft timeouts, should we eventually give up
684 * if sendmsg is not able to make progress?
686 static int xs_tcp_send_request(struct rpc_task *task)
688 struct rpc_rqst *req = task->tk_rqstp;
689 struct rpc_xprt *xprt = req->rq_xprt;
690 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
691 struct xdr_buf *xdr = &req->rq_snd_buf;
694 xs_encode_stream_record_marker(&req->rq_snd_buf);
696 xs_pktdump("packet data:",
697 req->rq_svec->iov_base,
698 req->rq_svec->iov_len);
700 /* Continue transmitting the packet/record. We must be careful
701 * to cope with writespace callbacks arriving _after_ we have
702 * called sendmsg(). */
704 status = xs_sendpages(transport->sock,
705 NULL, 0, xdr, req->rq_bytes_sent);
707 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
708 xdr->len - req->rq_bytes_sent, status);
710 if (unlikely(status < 0))
713 /* If we've sent the entire packet, immediately
714 * reset the count of bytes sent. */
715 req->rq_bytes_sent += status;
716 req->rq_xmit_bytes_sent += status;
717 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
718 req->rq_bytes_sent = 0;
731 /* Should we call xs_close() here? */
734 status = xs_nospace(task);
737 dprintk("RPC: sendmsg returned unrecognized error %d\n",
740 xs_tcp_shutdown(xprt);
744 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
751 * xs_tcp_release_xprt - clean up after a tcp transmission
755 * This cleans up if an error causes us to abort the transmission of a request.
756 * In this case, the socket may need to be reset in order to avoid confusing
759 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
761 struct rpc_rqst *req;
763 if (task != xprt->snd_task)
767 req = task->tk_rqstp;
770 if (req->rq_bytes_sent == 0)
772 if (req->rq_bytes_sent == req->rq_snd_buf.len)
774 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
776 xprt_release_xprt(xprt, task);
779 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
781 transport->old_data_ready = sk->sk_data_ready;
782 transport->old_state_change = sk->sk_state_change;
783 transport->old_write_space = sk->sk_write_space;
786 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
788 sk->sk_data_ready = transport->old_data_ready;
789 sk->sk_state_change = transport->old_state_change;
790 sk->sk_write_space = transport->old_write_space;
793 static void xs_reset_transport(struct sock_xprt *transport)
795 struct socket *sock = transport->sock;
796 struct sock *sk = transport->inet;
801 transport->srcport = 0;
803 write_lock_bh(&sk->sk_callback_lock);
804 transport->inet = NULL;
805 transport->sock = NULL;
807 sk->sk_user_data = NULL;
809 xs_restore_old_callbacks(transport, sk);
810 write_unlock_bh(&sk->sk_callback_lock);
818 * xs_close - close a socket
821 * This is used when all requests are complete; ie, no DRC state remains
822 * on the server we want to save.
824 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
825 * xs_reset_transport() zeroing the socket from underneath a writer.
827 static void xs_close(struct rpc_xprt *xprt)
829 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
831 dprintk("RPC: xs_close xprt %p\n", xprt);
833 xs_reset_transport(transport);
834 xprt->reestablish_timeout = 0;
836 smp_mb__before_clear_bit();
837 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
838 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
839 clear_bit(XPRT_CLOSING, &xprt->state);
840 smp_mb__after_clear_bit();
841 xprt_disconnect_done(xprt);
844 static void xs_tcp_close(struct rpc_xprt *xprt)
846 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state))
849 xs_tcp_shutdown(xprt);
853 * xs_destroy - prepare to shutdown a transport
854 * @xprt: doomed transport
857 static void xs_destroy(struct rpc_xprt *xprt)
859 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
861 dprintk("RPC: xs_destroy xprt %p\n", xprt);
863 cancel_delayed_work_sync(&transport->connect_worker);
866 xs_free_peer_addresses(xprt);
868 module_put(THIS_MODULE);
871 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
873 return (struct rpc_xprt *) sk->sk_user_data;
876 static int xs_local_copy_to_xdr(struct xdr_buf *xdr, struct sk_buff *skb)
878 struct xdr_skb_reader desc = {
880 .offset = sizeof(rpc_fraghdr),
881 .count = skb->len - sizeof(rpc_fraghdr),
884 if (xdr_partial_copy_from_skb(xdr, 0, &desc, xdr_skb_read_bits) < 0)
892 * xs_local_data_ready - "data ready" callback for AF_LOCAL sockets
893 * @sk: socket with data to read
894 * @len: how much data to read
896 * Currently this assumes we can read the whole reply in a single gulp.
898 static void xs_local_data_ready(struct sock *sk, int len)
900 struct rpc_task *task;
901 struct rpc_xprt *xprt;
902 struct rpc_rqst *rovr;
904 int err, repsize, copied;
908 read_lock_bh(&sk->sk_callback_lock);
909 dprintk("RPC: %s...\n", __func__);
910 xprt = xprt_from_sock(sk);
914 skb = skb_recv_datagram(sk, 0, 1, &err);
918 repsize = skb->len - sizeof(rpc_fraghdr);
920 dprintk("RPC: impossible RPC reply size %d\n", repsize);
924 /* Copy the XID from the skb... */
925 xp = skb_header_pointer(skb, sizeof(rpc_fraghdr), sizeof(_xid), &_xid);
929 /* Look up and lock the request corresponding to the given XID */
930 spin_lock(&xprt->transport_lock);
931 rovr = xprt_lookup_rqst(xprt, *xp);
934 task = rovr->rq_task;
936 copied = rovr->rq_private_buf.buflen;
937 if (copied > repsize)
940 if (xs_local_copy_to_xdr(&rovr->rq_private_buf, skb)) {
941 dprintk("RPC: sk_buff copy failed\n");
945 xprt_complete_rqst(task, copied);
948 spin_unlock(&xprt->transport_lock);
950 skb_free_datagram(sk, skb);
952 read_unlock_bh(&sk->sk_callback_lock);
956 * xs_udp_data_ready - "data ready" callback for UDP sockets
957 * @sk: socket with data to read
958 * @len: how much data to read
961 static void xs_udp_data_ready(struct sock *sk, int len)
963 struct rpc_task *task;
964 struct rpc_xprt *xprt;
965 struct rpc_rqst *rovr;
967 int err, repsize, copied;
971 read_lock_bh(&sk->sk_callback_lock);
972 dprintk("RPC: xs_udp_data_ready...\n");
973 if (!(xprt = xprt_from_sock(sk)))
976 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
979 repsize = skb->len - sizeof(struct udphdr);
981 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
985 /* Copy the XID from the skb... */
986 xp = skb_header_pointer(skb, sizeof(struct udphdr),
987 sizeof(_xid), &_xid);
991 /* Look up and lock the request corresponding to the given XID */
992 spin_lock(&xprt->transport_lock);
993 rovr = xprt_lookup_rqst(xprt, *xp);
996 task = rovr->rq_task;
998 if ((copied = rovr->rq_private_buf.buflen) > repsize)
1001 /* Suck it into the iovec, verify checksum if not done by hw. */
1002 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
1003 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
1007 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
1009 xprt_adjust_cwnd(xprt, task, copied);
1010 xprt_complete_rqst(task, copied);
1013 spin_unlock(&xprt->transport_lock);
1015 skb_free_datagram(sk, skb);
1017 read_unlock_bh(&sk->sk_callback_lock);
1021 * Helper function to force a TCP close if the server is sending
1022 * junk and/or it has put us in CLOSE_WAIT
1024 static void xs_tcp_force_close(struct rpc_xprt *xprt)
1026 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1027 xprt_force_disconnect(xprt);
1030 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
1032 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1036 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
1037 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
1038 used = xdr_skb_read_bits(desc, p, len);
1039 transport->tcp_offset += used;
1043 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
1044 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
1045 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
1047 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
1048 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
1050 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
1051 transport->tcp_offset = 0;
1053 /* Sanity check of the record length */
1054 if (unlikely(transport->tcp_reclen < 8)) {
1055 dprintk("RPC: invalid TCP record fragment length\n");
1056 xs_tcp_force_close(xprt);
1059 dprintk("RPC: reading TCP record fragment of length %d\n",
1060 transport->tcp_reclen);
1063 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
1065 if (transport->tcp_offset == transport->tcp_reclen) {
1066 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
1067 transport->tcp_offset = 0;
1068 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
1069 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1070 transport->tcp_flags |= TCP_RCV_COPY_XID;
1071 transport->tcp_copied = 0;
1076 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1081 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
1082 dprintk("RPC: reading XID (%Zu bytes)\n", len);
1083 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
1084 used = xdr_skb_read_bits(desc, p, len);
1085 transport->tcp_offset += used;
1088 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
1089 transport->tcp_flags |= TCP_RCV_READ_CALLDIR;
1090 transport->tcp_copied = 4;
1091 dprintk("RPC: reading %s XID %08x\n",
1092 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
1094 ntohl(transport->tcp_xid));
1095 xs_tcp_check_fraghdr(transport);
1098 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
1099 struct xdr_skb_reader *desc)
1106 * We want transport->tcp_offset to be 8 at the end of this routine
1107 * (4 bytes for the xid and 4 bytes for the call/reply flag).
1108 * When this function is called for the first time,
1109 * transport->tcp_offset is 4 (after having already read the xid).
1111 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
1112 len = sizeof(transport->tcp_calldir) - offset;
1113 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len);
1114 p = ((char *) &transport->tcp_calldir) + offset;
1115 used = xdr_skb_read_bits(desc, p, len);
1116 transport->tcp_offset += used;
1119 transport->tcp_flags &= ~TCP_RCV_READ_CALLDIR;
1121 * We don't yet have the XDR buffer, so we will write the calldir
1122 * out after we get the buffer from the 'struct rpc_rqst'
1124 switch (ntohl(transport->tcp_calldir)) {
1126 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1127 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1128 transport->tcp_flags |= TCP_RPC_REPLY;
1131 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
1132 transport->tcp_flags |= TCP_RCV_COPY_DATA;
1133 transport->tcp_flags &= ~TCP_RPC_REPLY;
1136 dprintk("RPC: invalid request message type\n");
1137 xs_tcp_force_close(&transport->xprt);
1139 xs_tcp_check_fraghdr(transport);
1142 static inline void xs_tcp_read_common(struct rpc_xprt *xprt,
1143 struct xdr_skb_reader *desc,
1144 struct rpc_rqst *req)
1146 struct sock_xprt *transport =
1147 container_of(xprt, struct sock_xprt, xprt);
1148 struct xdr_buf *rcvbuf;
1152 rcvbuf = &req->rq_private_buf;
1154 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
1156 * Save the RPC direction in the XDR buffer
1158 memcpy(rcvbuf->head[0].iov_base + transport->tcp_copied,
1159 &transport->tcp_calldir,
1160 sizeof(transport->tcp_calldir));
1161 transport->tcp_copied += sizeof(transport->tcp_calldir);
1162 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
1166 if (len > transport->tcp_reclen - transport->tcp_offset) {
1167 struct xdr_skb_reader my_desc;
1169 len = transport->tcp_reclen - transport->tcp_offset;
1170 memcpy(&my_desc, desc, sizeof(my_desc));
1171 my_desc.count = len;
1172 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1173 &my_desc, xdr_skb_read_bits);
1177 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1178 desc, xdr_skb_read_bits);
1181 transport->tcp_copied += r;
1182 transport->tcp_offset += r;
1185 /* Error when copying to the receive buffer,
1186 * usually because we weren't able to allocate
1187 * additional buffer pages. All we can do now
1188 * is turn off TCP_RCV_COPY_DATA, so the request
1189 * will not receive any additional updates,
1191 * Any remaining data from this record will
1194 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1195 dprintk("RPC: XID %08x truncated request\n",
1196 ntohl(transport->tcp_xid));
1197 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1198 "tcp_offset = %u, tcp_reclen = %u\n",
1199 xprt, transport->tcp_copied,
1200 transport->tcp_offset, transport->tcp_reclen);
1204 dprintk("RPC: XID %08x read %Zd bytes\n",
1205 ntohl(transport->tcp_xid), r);
1206 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1207 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1208 transport->tcp_offset, transport->tcp_reclen);
1210 if (transport->tcp_copied == req->rq_private_buf.buflen)
1211 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1212 else if (transport->tcp_offset == transport->tcp_reclen) {
1213 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1214 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1219 * Finds the request corresponding to the RPC xid and invokes the common
1220 * tcp read code to read the data.
1222 static inline int xs_tcp_read_reply(struct rpc_xprt *xprt,
1223 struct xdr_skb_reader *desc)
1225 struct sock_xprt *transport =
1226 container_of(xprt, struct sock_xprt, xprt);
1227 struct rpc_rqst *req;
1229 dprintk("RPC: read reply XID %08x\n", ntohl(transport->tcp_xid));
1231 /* Find and lock the request corresponding to this xid */
1232 spin_lock(&xprt->transport_lock);
1233 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1235 dprintk("RPC: XID %08x request not found!\n",
1236 ntohl(transport->tcp_xid));
1237 spin_unlock(&xprt->transport_lock);
1241 xs_tcp_read_common(xprt, desc, req);
1243 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1244 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1246 spin_unlock(&xprt->transport_lock);
1250 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1252 * Obtains an rpc_rqst previously allocated and invokes the common
1253 * tcp read code to read the data. The result is placed in the callback
1255 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1256 * connection and return -1.
1258 static inline int xs_tcp_read_callback(struct rpc_xprt *xprt,
1259 struct xdr_skb_reader *desc)
1261 struct sock_xprt *transport =
1262 container_of(xprt, struct sock_xprt, xprt);
1263 struct rpc_rqst *req;
1265 req = xprt_alloc_bc_request(xprt);
1267 printk(KERN_WARNING "Callback slot table overflowed\n");
1268 xprt_force_disconnect(xprt);
1272 req->rq_xid = transport->tcp_xid;
1273 dprintk("RPC: read callback XID %08x\n", ntohl(req->rq_xid));
1274 xs_tcp_read_common(xprt, desc, req);
1276 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA)) {
1277 struct svc_serv *bc_serv = xprt->bc_serv;
1280 * Add callback request to callback list. The callback
1281 * service sleeps on the sv_cb_waitq waiting for new
1282 * requests. Wake it up after adding enqueing the
1285 dprintk("RPC: add callback request to list\n");
1286 spin_lock(&bc_serv->sv_cb_lock);
1287 list_add(&req->rq_bc_list, &bc_serv->sv_cb_list);
1288 spin_unlock(&bc_serv->sv_cb_lock);
1289 wake_up(&bc_serv->sv_cb_waitq);
1292 req->rq_private_buf.len = transport->tcp_copied;
1297 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1298 struct xdr_skb_reader *desc)
1300 struct sock_xprt *transport =
1301 container_of(xprt, struct sock_xprt, xprt);
1303 return (transport->tcp_flags & TCP_RPC_REPLY) ?
1304 xs_tcp_read_reply(xprt, desc) :
1305 xs_tcp_read_callback(xprt, desc);
1308 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1309 struct xdr_skb_reader *desc)
1311 return xs_tcp_read_reply(xprt, desc);
1313 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1316 * Read data off the transport. This can be either an RPC_CALL or an
1317 * RPC_REPLY. Relay the processing to helper functions.
1319 static void 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 if (_xs_tcp_read_data(xprt, desc) == 0)
1326 xs_tcp_check_fraghdr(transport);
1329 * The transport_lock protects the request handling.
1330 * There's no need to hold it to update the tcp_flags.
1332 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1336 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1340 len = transport->tcp_reclen - transport->tcp_offset;
1341 if (len > desc->count)
1344 desc->offset += len;
1345 transport->tcp_offset += len;
1346 dprintk("RPC: discarded %Zu bytes\n", len);
1347 xs_tcp_check_fraghdr(transport);
1350 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1352 struct rpc_xprt *xprt = rd_desc->arg.data;
1353 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1354 struct xdr_skb_reader desc = {
1360 dprintk("RPC: xs_tcp_data_recv started\n");
1362 /* Read in a new fragment marker if necessary */
1363 /* Can we ever really expect to get completely empty fragments? */
1364 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1365 xs_tcp_read_fraghdr(xprt, &desc);
1368 /* Read in the xid if necessary */
1369 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1370 xs_tcp_read_xid(transport, &desc);
1373 /* Read in the call/reply flag */
1374 if (transport->tcp_flags & TCP_RCV_READ_CALLDIR) {
1375 xs_tcp_read_calldir(transport, &desc);
1378 /* Read in the request data */
1379 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1380 xs_tcp_read_data(xprt, &desc);
1383 /* Skip over any trailing bytes on short reads */
1384 xs_tcp_read_discard(transport, &desc);
1385 } while (desc.count);
1386 dprintk("RPC: xs_tcp_data_recv done\n");
1387 return len - desc.count;
1391 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1392 * @sk: socket with data to read
1393 * @bytes: how much data to read
1396 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1398 struct rpc_xprt *xprt;
1399 read_descriptor_t rd_desc;
1402 dprintk("RPC: xs_tcp_data_ready...\n");
1404 read_lock_bh(&sk->sk_callback_lock);
1405 if (!(xprt = xprt_from_sock(sk)))
1407 /* Any data means we had a useful conversation, so
1408 * the we don't need to delay the next reconnect
1410 if (xprt->reestablish_timeout)
1411 xprt->reestablish_timeout = 0;
1413 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1414 rd_desc.arg.data = xprt;
1416 rd_desc.count = 65536;
1417 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1420 read_unlock_bh(&sk->sk_callback_lock);
1424 * Do the equivalent of linger/linger2 handling for dealing with
1425 * broken servers that don't close the socket in a timely
1428 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt *xprt,
1429 unsigned long timeout)
1431 struct sock_xprt *transport;
1433 if (xprt_test_and_set_connecting(xprt))
1435 set_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1436 transport = container_of(xprt, struct sock_xprt, xprt);
1437 queue_delayed_work(rpciod_workqueue, &transport->connect_worker,
1441 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt *xprt)
1443 struct sock_xprt *transport;
1445 transport = container_of(xprt, struct sock_xprt, xprt);
1447 if (!test_bit(XPRT_CONNECTION_ABORT, &xprt->state) ||
1448 !cancel_delayed_work(&transport->connect_worker))
1450 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1451 xprt_clear_connecting(xprt);
1454 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt)
1456 smp_mb__before_clear_bit();
1457 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1458 clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1459 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1460 clear_bit(XPRT_CLOSING, &xprt->state);
1461 smp_mb__after_clear_bit();
1464 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
1466 xs_sock_reset_connection_flags(xprt);
1467 /* Mark transport as closed and wake up all pending tasks */
1468 xprt_disconnect_done(xprt);
1472 * xs_tcp_state_change - callback to handle TCP socket state changes
1473 * @sk: socket whose state has changed
1476 static void xs_tcp_state_change(struct sock *sk)
1478 struct rpc_xprt *xprt;
1480 read_lock_bh(&sk->sk_callback_lock);
1481 if (!(xprt = xprt_from_sock(sk)))
1483 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1484 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1485 sk->sk_state, xprt_connected(xprt),
1486 sock_flag(sk, SOCK_DEAD),
1487 sock_flag(sk, SOCK_ZAPPED),
1490 switch (sk->sk_state) {
1491 case TCP_ESTABLISHED:
1492 spin_lock(&xprt->transport_lock);
1493 if (!xprt_test_and_set_connected(xprt)) {
1494 struct sock_xprt *transport = container_of(xprt,
1495 struct sock_xprt, xprt);
1497 /* Reset TCP record info */
1498 transport->tcp_offset = 0;
1499 transport->tcp_reclen = 0;
1500 transport->tcp_copied = 0;
1501 transport->tcp_flags =
1502 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1504 xprt_wake_pending_tasks(xprt, -EAGAIN);
1506 spin_unlock(&xprt->transport_lock);
1509 /* The client initiated a shutdown of the socket */
1510 xprt->connect_cookie++;
1511 xprt->reestablish_timeout = 0;
1512 set_bit(XPRT_CLOSING, &xprt->state);
1513 smp_mb__before_clear_bit();
1514 clear_bit(XPRT_CONNECTED, &xprt->state);
1515 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1516 smp_mb__after_clear_bit();
1517 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1519 case TCP_CLOSE_WAIT:
1520 /* The server initiated a shutdown of the socket */
1521 xprt->connect_cookie++;
1522 clear_bit(XPRT_CONNECTED, &xprt->state);
1523 xs_tcp_force_close(xprt);
1526 * If the server closed down the connection, make sure that
1527 * we back off before reconnecting
1529 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1530 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1533 set_bit(XPRT_CLOSING, &xprt->state);
1534 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1535 smp_mb__before_clear_bit();
1536 clear_bit(XPRT_CONNECTED, &xprt->state);
1537 smp_mb__after_clear_bit();
1540 xs_tcp_cancel_linger_timeout(xprt);
1541 xs_sock_mark_closed(xprt);
1544 read_unlock_bh(&sk->sk_callback_lock);
1547 static void xs_write_space(struct sock *sk)
1549 struct socket *sock;
1550 struct rpc_xprt *xprt;
1552 if (unlikely(!(sock = sk->sk_socket)))
1554 clear_bit(SOCK_NOSPACE, &sock->flags);
1556 if (unlikely(!(xprt = xprt_from_sock(sk))))
1558 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1561 xprt_write_space(xprt);
1565 * xs_udp_write_space - callback invoked when socket buffer space
1567 * @sk: socket whose state has changed
1569 * Called when more output buffer space is available for this socket.
1570 * We try not to wake our writers until they can make "significant"
1571 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1572 * with a bunch of small requests.
1574 static void xs_udp_write_space(struct sock *sk)
1576 read_lock_bh(&sk->sk_callback_lock);
1578 /* from net/core/sock.c:sock_def_write_space */
1579 if (sock_writeable(sk))
1582 read_unlock_bh(&sk->sk_callback_lock);
1586 * xs_tcp_write_space - callback invoked when socket buffer space
1588 * @sk: socket whose state has changed
1590 * Called when more output buffer space is available for this socket.
1591 * We try not to wake our writers until they can make "significant"
1592 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1593 * with a bunch of small requests.
1595 static void xs_tcp_write_space(struct sock *sk)
1597 read_lock_bh(&sk->sk_callback_lock);
1599 /* from net/core/stream.c:sk_stream_write_space */
1600 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1603 read_unlock_bh(&sk->sk_callback_lock);
1606 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1608 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1609 struct sock *sk = transport->inet;
1611 if (transport->rcvsize) {
1612 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1613 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1615 if (transport->sndsize) {
1616 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1617 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1618 sk->sk_write_space(sk);
1623 * xs_udp_set_buffer_size - set send and receive limits
1624 * @xprt: generic transport
1625 * @sndsize: requested size of send buffer, in bytes
1626 * @rcvsize: requested size of receive buffer, in bytes
1628 * Set socket send and receive buffer size limits.
1630 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1632 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1634 transport->sndsize = 0;
1636 transport->sndsize = sndsize + 1024;
1637 transport->rcvsize = 0;
1639 transport->rcvsize = rcvsize + 1024;
1641 xs_udp_do_set_buffer_size(xprt);
1645 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1646 * @task: task that timed out
1648 * Adjust the congestion window after a retransmit timeout has occurred.
1650 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task)
1652 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT);
1655 static unsigned short xs_get_random_port(void)
1657 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1658 unsigned short rand = (unsigned short) net_random() % range;
1659 return rand + xprt_min_resvport;
1663 * xs_set_port - reset the port number in the remote endpoint address
1664 * @xprt: generic transport
1665 * @port: new port number
1668 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1670 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1672 rpc_set_port(xs_addr(xprt), port);
1673 xs_update_peer_port(xprt);
1676 static unsigned short xs_get_srcport(struct sock_xprt *transport)
1678 unsigned short port = transport->srcport;
1680 if (port == 0 && transport->xprt.resvport)
1681 port = xs_get_random_port();
1685 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port)
1687 if (transport->srcport != 0)
1688 transport->srcport = 0;
1689 if (!transport->xprt.resvport)
1691 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1692 return xprt_max_resvport;
1695 static int xs_bind(struct sock_xprt *transport, struct socket *sock)
1697 struct sockaddr_storage myaddr;
1699 unsigned short port = xs_get_srcport(transport);
1700 unsigned short last;
1702 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen);
1704 rpc_set_port((struct sockaddr *)&myaddr, port);
1705 err = kernel_bind(sock, (struct sockaddr *)&myaddr,
1706 transport->xprt.addrlen);
1710 transport->srcport = port;
1714 port = xs_next_srcport(transport, port);
1717 } while (err == -EADDRINUSE && nloop != 2);
1719 if (myaddr.ss_family == AF_INET)
1720 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__,
1721 &((struct sockaddr_in *)&myaddr)->sin_addr,
1722 port, err ? "failed" : "ok", err);
1724 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__,
1725 &((struct sockaddr_in6 *)&myaddr)->sin6_addr,
1726 port, err ? "failed" : "ok", err);
1731 * We don't support autobind on AF_LOCAL sockets
1733 static void xs_local_rpcbind(struct rpc_task *task)
1736 xprt_set_bound(rcu_dereference(task->tk_client->cl_xprt));
1740 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port)
1744 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1745 static struct lock_class_key xs_key[2];
1746 static struct lock_class_key xs_slock_key[2];
1748 static inline void xs_reclassify_socketu(struct socket *sock)
1750 struct sock *sk = sock->sk;
1752 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC",
1753 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]);
1756 static inline void xs_reclassify_socket4(struct socket *sock)
1758 struct sock *sk = sock->sk;
1760 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1761 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1764 static inline void xs_reclassify_socket6(struct socket *sock)
1766 struct sock *sk = sock->sk;
1768 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1769 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1772 static inline void xs_reclassify_socket(int family, struct socket *sock)
1774 WARN_ON_ONCE(sock_owned_by_user(sock->sk));
1775 if (sock_owned_by_user(sock->sk))
1780 xs_reclassify_socketu(sock);
1783 xs_reclassify_socket4(sock);
1786 xs_reclassify_socket6(sock);
1791 static inline void xs_reclassify_socketu(struct socket *sock)
1795 static inline void xs_reclassify_socket4(struct socket *sock)
1799 static inline void xs_reclassify_socket6(struct socket *sock)
1803 static inline void xs_reclassify_socket(int family, struct socket *sock)
1808 static struct socket *xs_create_sock(struct rpc_xprt *xprt,
1809 struct sock_xprt *transport, int family, int type, int protocol)
1811 struct socket *sock;
1814 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1);
1816 dprintk("RPC: can't create %d transport socket (%d).\n",
1820 xs_reclassify_socket(family, sock);
1822 err = xs_bind(transport, sock);
1830 return ERR_PTR(err);
1833 static int xs_local_finish_connecting(struct rpc_xprt *xprt,
1834 struct socket *sock)
1836 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1839 if (!transport->inet) {
1840 struct sock *sk = sock->sk;
1842 write_lock_bh(&sk->sk_callback_lock);
1844 xs_save_old_callbacks(transport, sk);
1846 sk->sk_user_data = xprt;
1847 sk->sk_data_ready = xs_local_data_ready;
1848 sk->sk_write_space = xs_udp_write_space;
1849 sk->sk_allocation = GFP_ATOMIC;
1851 xprt_clear_connected(xprt);
1853 /* Reset to new socket */
1854 transport->sock = sock;
1855 transport->inet = sk;
1857 write_unlock_bh(&sk->sk_callback_lock);
1860 /* Tell the socket layer to start connecting... */
1861 xprt->stat.connect_count++;
1862 xprt->stat.connect_start = jiffies;
1863 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0);
1867 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint
1868 * @xprt: RPC transport to connect
1869 * @transport: socket transport to connect
1870 * @create_sock: function to create a socket of the correct type
1872 static int xs_local_setup_socket(struct sock_xprt *transport)
1874 struct rpc_xprt *xprt = &transport->xprt;
1875 struct socket *sock;
1878 current->flags |= PF_FSTRANS;
1880 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1881 status = __sock_create(xprt->xprt_net, AF_LOCAL,
1882 SOCK_STREAM, 0, &sock, 1);
1884 dprintk("RPC: can't create AF_LOCAL "
1885 "transport socket (%d).\n", -status);
1888 xs_reclassify_socketu(sock);
1890 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n",
1891 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1893 status = xs_local_finish_connecting(xprt, sock);
1896 dprintk("RPC: xprt %p connected to %s\n",
1897 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1898 xprt_set_connected(xprt);
1901 dprintk("RPC: xprt %p: socket %s does not exist\n",
1902 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1905 dprintk("RPC: xprt %p: connection refused for %s\n",
1906 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]);
1909 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n",
1911 xprt->address_strings[RPC_DISPLAY_ADDR]);
1915 xprt_clear_connecting(xprt);
1916 xprt_wake_pending_tasks(xprt, status);
1917 current->flags &= ~PF_FSTRANS;
1921 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task)
1923 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1926 if (RPC_IS_ASYNC(task)) {
1928 * We want the AF_LOCAL connect to be resolved in the
1929 * filesystem namespace of the process making the rpc
1930 * call. Thus we connect synchronously.
1932 * If we want to support asynchronous AF_LOCAL calls,
1933 * we'll need to figure out how to pass a namespace to
1936 rpc_exit(task, -ENOTCONN);
1939 ret = xs_local_setup_socket(transport);
1940 if (ret && !RPC_IS_SOFTCONN(task))
1941 msleep_interruptible(15000);
1944 #ifdef CONFIG_SUNRPC_SWAP
1945 static void xs_set_memalloc(struct rpc_xprt *xprt)
1947 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1951 sk_set_memalloc(transport->inet);
1955 * xs_swapper - Tag this transport as being used for swap.
1956 * @xprt: transport to tag
1957 * @enable: enable/disable
1960 int xs_swapper(struct rpc_xprt *xprt, int enable)
1962 struct sock_xprt *transport = container_of(xprt, struct sock_xprt,
1968 xs_set_memalloc(xprt);
1969 } else if (xprt->swapper) {
1971 sk_clear_memalloc(transport->inet);
1976 EXPORT_SYMBOL_GPL(xs_swapper);
1978 static void xs_set_memalloc(struct rpc_xprt *xprt)
1983 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1985 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1987 if (!transport->inet) {
1988 struct sock *sk = sock->sk;
1990 write_lock_bh(&sk->sk_callback_lock);
1992 xs_save_old_callbacks(transport, sk);
1994 sk->sk_user_data = xprt;
1995 sk->sk_data_ready = xs_udp_data_ready;
1996 sk->sk_write_space = xs_udp_write_space;
1997 sk->sk_no_check = UDP_CSUM_NORCV;
1998 sk->sk_allocation = GFP_ATOMIC;
2000 xprt_set_connected(xprt);
2002 /* Reset to new socket */
2003 transport->sock = sock;
2004 transport->inet = sk;
2006 xs_set_memalloc(xprt);
2008 write_unlock_bh(&sk->sk_callback_lock);
2010 xs_udp_do_set_buffer_size(xprt);
2013 static void xs_udp_setup_socket(struct work_struct *work)
2015 struct sock_xprt *transport =
2016 container_of(work, struct sock_xprt, connect_worker.work);
2017 struct rpc_xprt *xprt = &transport->xprt;
2018 struct socket *sock = transport->sock;
2021 current->flags |= PF_FSTRANS;
2023 /* Start by resetting any existing state */
2024 xs_reset_transport(transport);
2025 sock = xs_create_sock(xprt, transport,
2026 xs_addr(xprt)->sa_family, SOCK_DGRAM, IPPROTO_UDP);
2030 dprintk("RPC: worker connecting xprt %p via %s to "
2031 "%s (port %s)\n", xprt,
2032 xprt->address_strings[RPC_DISPLAY_PROTO],
2033 xprt->address_strings[RPC_DISPLAY_ADDR],
2034 xprt->address_strings[RPC_DISPLAY_PORT]);
2036 xs_udp_finish_connecting(xprt, sock);
2039 xprt_clear_connecting(xprt);
2040 xprt_wake_pending_tasks(xprt, status);
2041 current->flags &= ~PF_FSTRANS;
2045 * We need to preserve the port number so the reply cache on the server can
2046 * find our cached RPC replies when we get around to reconnecting.
2048 static void xs_abort_connection(struct sock_xprt *transport)
2051 struct sockaddr any;
2053 dprintk("RPC: disconnecting xprt %p to reuse port\n", transport);
2056 * Disconnect the transport socket by doing a connect operation
2057 * with AF_UNSPEC. This should return immediately...
2059 memset(&any, 0, sizeof(any));
2060 any.sa_family = AF_UNSPEC;
2061 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
2063 xs_sock_reset_connection_flags(&transport->xprt);
2064 dprintk("RPC: AF_UNSPEC connect return code %d\n", result);
2067 static void xs_tcp_reuse_connection(struct sock_xprt *transport)
2069 unsigned int state = transport->inet->sk_state;
2071 if (state == TCP_CLOSE && transport->sock->state == SS_UNCONNECTED) {
2072 /* we don't need to abort the connection if the socket
2073 * hasn't undergone a shutdown
2075 if (transport->inet->sk_shutdown == 0)
2077 dprintk("RPC: %s: TCP_CLOSEd and sk_shutdown set to %d\n",
2078 __func__, transport->inet->sk_shutdown);
2080 if ((1 << state) & (TCPF_ESTABLISHED|TCPF_SYN_SENT)) {
2081 /* we don't need to abort the connection if the socket
2082 * hasn't undergone a shutdown
2084 if (transport->inet->sk_shutdown == 0)
2086 dprintk("RPC: %s: ESTABLISHED/SYN_SENT "
2087 "sk_shutdown set to %d\n",
2088 __func__, transport->inet->sk_shutdown);
2090 xs_abort_connection(transport);
2093 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
2095 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2096 int ret = -ENOTCONN;
2098 if (!transport->inet) {
2099 struct sock *sk = sock->sk;
2101 write_lock_bh(&sk->sk_callback_lock);
2103 xs_save_old_callbacks(transport, sk);
2105 sk->sk_user_data = xprt;
2106 sk->sk_data_ready = xs_tcp_data_ready;
2107 sk->sk_state_change = xs_tcp_state_change;
2108 sk->sk_write_space = xs_tcp_write_space;
2109 sk->sk_allocation = GFP_ATOMIC;
2111 /* socket options */
2112 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
2113 sock_reset_flag(sk, SOCK_LINGER);
2114 tcp_sk(sk)->linger2 = 0;
2115 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
2117 xprt_clear_connected(xprt);
2119 /* Reset to new socket */
2120 transport->sock = sock;
2121 transport->inet = sk;
2123 write_unlock_bh(&sk->sk_callback_lock);
2126 if (!xprt_bound(xprt))
2129 xs_set_memalloc(xprt);
2131 /* Tell the socket layer to start connecting... */
2132 xprt->stat.connect_count++;
2133 xprt->stat.connect_start = jiffies;
2134 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
2139 xprt->connect_cookie++;
2140 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2141 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2148 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
2149 * @xprt: RPC transport to connect
2150 * @transport: socket transport to connect
2151 * @create_sock: function to create a socket of the correct type
2153 * Invoked by a work queue tasklet.
2155 static void xs_tcp_setup_socket(struct work_struct *work)
2157 struct sock_xprt *transport =
2158 container_of(work, struct sock_xprt, connect_worker.work);
2159 struct socket *sock = transport->sock;
2160 struct rpc_xprt *xprt = &transport->xprt;
2163 current->flags |= PF_FSTRANS;
2166 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
2167 sock = xs_create_sock(xprt, transport,
2168 xs_addr(xprt)->sa_family, SOCK_STREAM, IPPROTO_TCP);
2170 status = PTR_ERR(sock);
2176 abort_and_exit = test_and_clear_bit(XPRT_CONNECTION_ABORT,
2178 /* "close" the socket, preserving the local port */
2179 xs_tcp_reuse_connection(transport);
2185 dprintk("RPC: worker connecting xprt %p via %s to "
2186 "%s (port %s)\n", xprt,
2187 xprt->address_strings[RPC_DISPLAY_PROTO],
2188 xprt->address_strings[RPC_DISPLAY_ADDR],
2189 xprt->address_strings[RPC_DISPLAY_PORT]);
2191 status = xs_tcp_finish_connecting(xprt, sock);
2192 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
2193 xprt, -status, xprt_connected(xprt),
2194 sock->sk->sk_state);
2197 printk("%s: connect returned unhandled error %d\n",
2199 case -EADDRNOTAVAIL:
2200 /* We're probably in TIME_WAIT. Get rid of existing socket,
2203 xs_tcp_force_close(xprt);
2208 /* retry with existing socket, after a delay */
2212 xprt_clear_connecting(xprt);
2213 current->flags &= ~PF_FSTRANS;
2216 /* Happens, for instance, if the user specified a link
2217 * local IPv6 address without a scope-id.
2224 xprt_clear_connecting(xprt);
2225 xprt_wake_pending_tasks(xprt, status);
2226 current->flags &= ~PF_FSTRANS;
2230 * xs_connect - connect a socket to a remote endpoint
2231 * @xprt: pointer to transport structure
2232 * @task: address of RPC task that manages state of connect request
2234 * TCP: If the remote end dropped the connection, delay reconnecting.
2236 * UDP socket connects are synchronous, but we use a work queue anyway
2237 * to guarantee that even unprivileged user processes can set up a
2238 * socket on a privileged port.
2240 * If a UDP socket connect fails, the delay behavior here prevents
2241 * retry floods (hard mounts).
2243 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task)
2245 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2247 if (transport->sock != NULL && !RPC_IS_SOFTCONN(task)) {
2248 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2250 xprt, xprt->reestablish_timeout / HZ);
2251 queue_delayed_work(rpciod_workqueue,
2252 &transport->connect_worker,
2253 xprt->reestablish_timeout);
2254 xprt->reestablish_timeout <<= 1;
2255 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2256 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2257 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
2258 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
2260 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2261 queue_delayed_work(rpciod_workqueue,
2262 &transport->connect_worker, 0);
2267 * xs_local_print_stats - display AF_LOCAL socket-specifc stats
2268 * @xprt: rpc_xprt struct containing statistics
2272 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2276 if (xprt_connected(xprt))
2277 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2279 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu "
2280 "%llu %llu %lu %llu %llu\n",
2281 xprt->stat.bind_count,
2282 xprt->stat.connect_count,
2283 xprt->stat.connect_time,
2287 xprt->stat.bad_xids,
2290 xprt->stat.max_slots,
2291 xprt->stat.sending_u,
2292 xprt->stat.pending_u);
2296 * xs_udp_print_stats - display UDP socket-specifc stats
2297 * @xprt: rpc_xprt struct containing statistics
2301 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2303 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2305 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu "
2308 xprt->stat.bind_count,
2311 xprt->stat.bad_xids,
2314 xprt->stat.max_slots,
2315 xprt->stat.sending_u,
2316 xprt->stat.pending_u);
2320 * xs_tcp_print_stats - display TCP socket-specifc stats
2321 * @xprt: rpc_xprt struct containing statistics
2325 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2327 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2330 if (xprt_connected(xprt))
2331 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2333 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu "
2334 "%llu %llu %lu %llu %llu\n",
2336 xprt->stat.bind_count,
2337 xprt->stat.connect_count,
2338 xprt->stat.connect_time,
2342 xprt->stat.bad_xids,
2345 xprt->stat.max_slots,
2346 xprt->stat.sending_u,
2347 xprt->stat.pending_u);
2351 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2352 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2353 * to use the server side send routines.
2355 static void *bc_malloc(struct rpc_task *task, size_t size)
2358 struct rpc_buffer *buf;
2360 WARN_ON_ONCE(size > PAGE_SIZE - sizeof(struct rpc_buffer));
2361 if (size > PAGE_SIZE - sizeof(struct rpc_buffer))
2364 page = alloc_page(GFP_KERNEL);
2368 buf = page_address(page);
2369 buf->len = PAGE_SIZE;
2375 * Free the space allocated in the bc_alloc routine
2377 static void bc_free(void *buffer)
2379 struct rpc_buffer *buf;
2384 buf = container_of(buffer, struct rpc_buffer, data);
2385 free_page((unsigned long)buf);
2389 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2390 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2392 static int bc_sendto(struct rpc_rqst *req)
2395 struct xdr_buf *xbufp = &req->rq_snd_buf;
2396 struct rpc_xprt *xprt = req->rq_xprt;
2397 struct sock_xprt *transport =
2398 container_of(xprt, struct sock_xprt, xprt);
2399 struct socket *sock = transport->sock;
2400 unsigned long headoff;
2401 unsigned long tailoff;
2403 xs_encode_stream_record_marker(xbufp);
2405 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2406 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2407 len = svc_send_common(sock, xbufp,
2408 virt_to_page(xbufp->head[0].iov_base), headoff,
2409 xbufp->tail[0].iov_base, tailoff);
2411 if (len != xbufp->len) {
2412 printk(KERN_NOTICE "Error sending entire callback!\n");
2420 * The send routine. Borrows from svc_send
2422 static int bc_send_request(struct rpc_task *task)
2424 struct rpc_rqst *req = task->tk_rqstp;
2425 struct svc_xprt *xprt;
2428 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2430 * Get the server socket associated with this callback xprt
2432 xprt = req->rq_xprt->bc_xprt;
2435 * Grab the mutex to serialize data as the connection is shared
2436 * with the fore channel
2438 if (!mutex_trylock(&xprt->xpt_mutex)) {
2439 rpc_sleep_on(&xprt->xpt_bc_pending, task, NULL);
2440 if (!mutex_trylock(&xprt->xpt_mutex))
2442 rpc_wake_up_queued_task(&xprt->xpt_bc_pending, task);
2444 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2447 len = bc_sendto(req);
2448 mutex_unlock(&xprt->xpt_mutex);
2457 * The close routine. Since this is client initiated, we do nothing
2460 static void bc_close(struct rpc_xprt *xprt)
2465 * The xprt destroy routine. Again, because this connection is client
2466 * initiated, we do nothing
2469 static void bc_destroy(struct rpc_xprt *xprt)
2473 static struct rpc_xprt_ops xs_local_ops = {
2474 .reserve_xprt = xprt_reserve_xprt,
2475 .release_xprt = xs_tcp_release_xprt,
2476 .alloc_slot = xprt_alloc_slot,
2477 .rpcbind = xs_local_rpcbind,
2478 .set_port = xs_local_set_port,
2479 .connect = xs_local_connect,
2480 .buf_alloc = rpc_malloc,
2481 .buf_free = rpc_free,
2482 .send_request = xs_local_send_request,
2483 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2485 .destroy = xs_destroy,
2486 .print_stats = xs_local_print_stats,
2489 static struct rpc_xprt_ops xs_udp_ops = {
2490 .set_buffer_size = xs_udp_set_buffer_size,
2491 .reserve_xprt = xprt_reserve_xprt_cong,
2492 .release_xprt = xprt_release_xprt_cong,
2493 .alloc_slot = xprt_alloc_slot,
2494 .rpcbind = rpcb_getport_async,
2495 .set_port = xs_set_port,
2496 .connect = xs_connect,
2497 .buf_alloc = rpc_malloc,
2498 .buf_free = rpc_free,
2499 .send_request = xs_udp_send_request,
2500 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2501 .timer = xs_udp_timer,
2502 .release_request = xprt_release_rqst_cong,
2504 .destroy = xs_destroy,
2505 .print_stats = xs_udp_print_stats,
2508 static struct rpc_xprt_ops xs_tcp_ops = {
2509 .reserve_xprt = xprt_reserve_xprt,
2510 .release_xprt = xs_tcp_release_xprt,
2511 .alloc_slot = xprt_lock_and_alloc_slot,
2512 .rpcbind = rpcb_getport_async,
2513 .set_port = xs_set_port,
2514 .connect = xs_connect,
2515 .buf_alloc = rpc_malloc,
2516 .buf_free = rpc_free,
2517 .send_request = xs_tcp_send_request,
2518 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2519 .close = xs_tcp_close,
2520 .destroy = xs_destroy,
2521 .print_stats = xs_tcp_print_stats,
2525 * The rpc_xprt_ops for the server backchannel
2528 static struct rpc_xprt_ops bc_tcp_ops = {
2529 .reserve_xprt = xprt_reserve_xprt,
2530 .release_xprt = xprt_release_xprt,
2531 .alloc_slot = xprt_alloc_slot,
2532 .rpcbind = xs_local_rpcbind,
2533 .buf_alloc = bc_malloc,
2534 .buf_free = bc_free,
2535 .send_request = bc_send_request,
2536 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2538 .destroy = bc_destroy,
2539 .print_stats = xs_tcp_print_stats,
2542 static int xs_init_anyaddr(const int family, struct sockaddr *sap)
2544 static const struct sockaddr_in sin = {
2545 .sin_family = AF_INET,
2546 .sin_addr.s_addr = htonl(INADDR_ANY),
2548 static const struct sockaddr_in6 sin6 = {
2549 .sin6_family = AF_INET6,
2550 .sin6_addr = IN6ADDR_ANY_INIT,
2557 memcpy(sap, &sin, sizeof(sin));
2560 memcpy(sap, &sin6, sizeof(sin6));
2563 dprintk("RPC: %s: Bad address family\n", __func__);
2564 return -EAFNOSUPPORT;
2569 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2570 unsigned int slot_table_size,
2571 unsigned int max_slot_table_size)
2573 struct rpc_xprt *xprt;
2574 struct sock_xprt *new;
2576 if (args->addrlen > sizeof(xprt->addr)) {
2577 dprintk("RPC: xs_setup_xprt: address too large\n");
2578 return ERR_PTR(-EBADF);
2581 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size,
2582 max_slot_table_size);
2584 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2586 return ERR_PTR(-ENOMEM);
2589 new = container_of(xprt, struct sock_xprt, xprt);
2590 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2591 xprt->addrlen = args->addrlen;
2593 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2596 err = xs_init_anyaddr(args->dstaddr->sa_family,
2597 (struct sockaddr *)&new->srcaddr);
2600 return ERR_PTR(err);
2607 static const struct rpc_timeout xs_local_default_timeout = {
2608 .to_initval = 10 * HZ,
2609 .to_maxval = 10 * HZ,
2614 * xs_setup_local - Set up transport to use an AF_LOCAL socket
2615 * @args: rpc transport creation arguments
2617 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP
2619 static struct rpc_xprt *xs_setup_local(struct xprt_create *args)
2621 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr;
2622 struct sock_xprt *transport;
2623 struct rpc_xprt *xprt;
2624 struct rpc_xprt *ret;
2626 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2627 xprt_max_tcp_slot_table_entries);
2630 transport = container_of(xprt, struct sock_xprt, xprt);
2633 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2634 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2636 xprt->bind_timeout = XS_BIND_TO;
2637 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2638 xprt->idle_timeout = XS_IDLE_DISC_TO;
2640 xprt->ops = &xs_local_ops;
2641 xprt->timeout = &xs_local_default_timeout;
2643 switch (sun->sun_family) {
2645 if (sun->sun_path[0] != '/') {
2646 dprintk("RPC: bad AF_LOCAL address: %s\n",
2648 ret = ERR_PTR(-EINVAL);
2651 xprt_set_bound(xprt);
2652 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL);
2655 ret = ERR_PTR(-EAFNOSUPPORT);
2659 dprintk("RPC: set up xprt to %s via AF_LOCAL\n",
2660 xprt->address_strings[RPC_DISPLAY_ADDR]);
2662 if (try_module_get(THIS_MODULE))
2664 ret = ERR_PTR(-EINVAL);
2670 static const struct rpc_timeout xs_udp_default_timeout = {
2671 .to_initval = 5 * HZ,
2672 .to_maxval = 30 * HZ,
2673 .to_increment = 5 * HZ,
2678 * xs_setup_udp - Set up transport to use a UDP socket
2679 * @args: rpc transport creation arguments
2682 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2684 struct sockaddr *addr = args->dstaddr;
2685 struct rpc_xprt *xprt;
2686 struct sock_xprt *transport;
2687 struct rpc_xprt *ret;
2689 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries,
2690 xprt_udp_slot_table_entries);
2693 transport = container_of(xprt, struct sock_xprt, xprt);
2695 xprt->prot = IPPROTO_UDP;
2697 /* XXX: header size can vary due to auth type, IPv6, etc. */
2698 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2700 xprt->bind_timeout = XS_BIND_TO;
2701 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2702 xprt->idle_timeout = XS_IDLE_DISC_TO;
2704 xprt->ops = &xs_udp_ops;
2706 xprt->timeout = &xs_udp_default_timeout;
2708 switch (addr->sa_family) {
2710 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2711 xprt_set_bound(xprt);
2713 INIT_DELAYED_WORK(&transport->connect_worker,
2714 xs_udp_setup_socket);
2715 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2718 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2719 xprt_set_bound(xprt);
2721 INIT_DELAYED_WORK(&transport->connect_worker,
2722 xs_udp_setup_socket);
2723 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2726 ret = ERR_PTR(-EAFNOSUPPORT);
2730 if (xprt_bound(xprt))
2731 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2732 xprt->address_strings[RPC_DISPLAY_ADDR],
2733 xprt->address_strings[RPC_DISPLAY_PORT],
2734 xprt->address_strings[RPC_DISPLAY_PROTO]);
2736 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2737 xprt->address_strings[RPC_DISPLAY_ADDR],
2738 xprt->address_strings[RPC_DISPLAY_PROTO]);
2740 if (try_module_get(THIS_MODULE))
2742 ret = ERR_PTR(-EINVAL);
2748 static const struct rpc_timeout xs_tcp_default_timeout = {
2749 .to_initval = 60 * HZ,
2750 .to_maxval = 60 * HZ,
2755 * xs_setup_tcp - Set up transport to use a TCP socket
2756 * @args: rpc transport creation arguments
2759 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2761 struct sockaddr *addr = args->dstaddr;
2762 struct rpc_xprt *xprt;
2763 struct sock_xprt *transport;
2764 struct rpc_xprt *ret;
2766 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2767 xprt_max_tcp_slot_table_entries);
2770 transport = container_of(xprt, struct sock_xprt, xprt);
2772 xprt->prot = IPPROTO_TCP;
2773 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2774 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2776 xprt->bind_timeout = XS_BIND_TO;
2777 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2778 xprt->idle_timeout = XS_IDLE_DISC_TO;
2780 xprt->ops = &xs_tcp_ops;
2781 xprt->timeout = &xs_tcp_default_timeout;
2783 switch (addr->sa_family) {
2785 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2786 xprt_set_bound(xprt);
2788 INIT_DELAYED_WORK(&transport->connect_worker,
2789 xs_tcp_setup_socket);
2790 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2793 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2794 xprt_set_bound(xprt);
2796 INIT_DELAYED_WORK(&transport->connect_worker,
2797 xs_tcp_setup_socket);
2798 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2801 ret = ERR_PTR(-EAFNOSUPPORT);
2805 if (xprt_bound(xprt))
2806 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2807 xprt->address_strings[RPC_DISPLAY_ADDR],
2808 xprt->address_strings[RPC_DISPLAY_PORT],
2809 xprt->address_strings[RPC_DISPLAY_PROTO]);
2811 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2812 xprt->address_strings[RPC_DISPLAY_ADDR],
2813 xprt->address_strings[RPC_DISPLAY_PROTO]);
2816 if (try_module_get(THIS_MODULE))
2818 ret = ERR_PTR(-EINVAL);
2825 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
2826 * @args: rpc transport creation arguments
2829 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
2831 struct sockaddr *addr = args->dstaddr;
2832 struct rpc_xprt *xprt;
2833 struct sock_xprt *transport;
2834 struct svc_sock *bc_sock;
2835 struct rpc_xprt *ret;
2837 if (args->bc_xprt->xpt_bc_xprt) {
2839 * This server connection already has a backchannel
2840 * export; we can't create a new one, as we wouldn't be
2841 * able to match replies based on xid any more. So,
2842 * reuse the already-existing one:
2844 return args->bc_xprt->xpt_bc_xprt;
2846 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries,
2847 xprt_tcp_slot_table_entries);
2850 transport = container_of(xprt, struct sock_xprt, xprt);
2852 xprt->prot = IPPROTO_TCP;
2853 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2854 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2855 xprt->timeout = &xs_tcp_default_timeout;
2858 xprt_set_bound(xprt);
2859 xprt->bind_timeout = 0;
2860 xprt->reestablish_timeout = 0;
2861 xprt->idle_timeout = 0;
2863 xprt->ops = &bc_tcp_ops;
2865 switch (addr->sa_family) {
2867 xs_format_peer_addresses(xprt, "tcp",
2871 xs_format_peer_addresses(xprt, "tcp",
2872 RPCBIND_NETID_TCP6);
2875 ret = ERR_PTR(-EAFNOSUPPORT);
2879 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2880 xprt->address_strings[RPC_DISPLAY_ADDR],
2881 xprt->address_strings[RPC_DISPLAY_PORT],
2882 xprt->address_strings[RPC_DISPLAY_PROTO]);
2885 * Once we've associated a backchannel xprt with a connection,
2886 * we want to keep it around as long as long as the connection
2887 * lasts, in case we need to start using it for a backchannel
2888 * again; this reference won't be dropped until bc_xprt is
2892 args->bc_xprt->xpt_bc_xprt = xprt;
2893 xprt->bc_xprt = args->bc_xprt;
2894 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
2895 transport->sock = bc_sock->sk_sock;
2896 transport->inet = bc_sock->sk_sk;
2899 * Since we don't want connections for the backchannel, we set
2900 * the xprt status to connected
2902 xprt_set_connected(xprt);
2905 if (try_module_get(THIS_MODULE))
2908 ret = ERR_PTR(-EINVAL);
2914 static struct xprt_class xs_local_transport = {
2915 .list = LIST_HEAD_INIT(xs_local_transport.list),
2916 .name = "named UNIX socket",
2917 .owner = THIS_MODULE,
2918 .ident = XPRT_TRANSPORT_LOCAL,
2919 .setup = xs_setup_local,
2922 static struct xprt_class xs_udp_transport = {
2923 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2925 .owner = THIS_MODULE,
2926 .ident = XPRT_TRANSPORT_UDP,
2927 .setup = xs_setup_udp,
2930 static struct xprt_class xs_tcp_transport = {
2931 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2933 .owner = THIS_MODULE,
2934 .ident = XPRT_TRANSPORT_TCP,
2935 .setup = xs_setup_tcp,
2938 static struct xprt_class xs_bc_tcp_transport = {
2939 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
2940 .name = "tcp NFSv4.1 backchannel",
2941 .owner = THIS_MODULE,
2942 .ident = XPRT_TRANSPORT_BC_TCP,
2943 .setup = xs_setup_bc_tcp,
2947 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2950 int init_socket_xprt(void)
2953 if (!sunrpc_table_header)
2954 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2957 xprt_register_transport(&xs_local_transport);
2958 xprt_register_transport(&xs_udp_transport);
2959 xprt_register_transport(&xs_tcp_transport);
2960 xprt_register_transport(&xs_bc_tcp_transport);
2966 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2969 void cleanup_socket_xprt(void)
2972 if (sunrpc_table_header) {
2973 unregister_sysctl_table(sunrpc_table_header);
2974 sunrpc_table_header = NULL;
2978 xprt_unregister_transport(&xs_local_transport);
2979 xprt_unregister_transport(&xs_udp_transport);
2980 xprt_unregister_transport(&xs_tcp_transport);
2981 xprt_unregister_transport(&xs_bc_tcp_transport);
2984 static int param_set_uint_minmax(const char *val,
2985 const struct kernel_param *kp,
2986 unsigned int min, unsigned int max)
2993 ret = strict_strtoul(val, 0, &num);
2994 if (ret == -EINVAL || num < min || num > max)
2996 *((unsigned int *)kp->arg) = num;
3000 static int param_set_portnr(const char *val, const struct kernel_param *kp)
3002 return param_set_uint_minmax(val, kp,
3007 static struct kernel_param_ops param_ops_portnr = {
3008 .set = param_set_portnr,
3009 .get = param_get_uint,
3012 #define param_check_portnr(name, p) \
3013 __param_check(name, p, unsigned int);
3015 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
3016 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
3018 static int param_set_slot_table_size(const char *val,
3019 const struct kernel_param *kp)
3021 return param_set_uint_minmax(val, kp,
3023 RPC_MAX_SLOT_TABLE);
3026 static struct kernel_param_ops param_ops_slot_table_size = {
3027 .set = param_set_slot_table_size,
3028 .get = param_get_uint,
3031 #define param_check_slot_table_size(name, p) \
3032 __param_check(name, p, unsigned int);
3034 static int param_set_max_slot_table_size(const char *val,
3035 const struct kernel_param *kp)
3037 return param_set_uint_minmax(val, kp,
3039 RPC_MAX_SLOT_TABLE_LIMIT);
3042 static struct kernel_param_ops param_ops_max_slot_table_size = {
3043 .set = param_set_max_slot_table_size,
3044 .get = param_get_uint,
3047 #define param_check_max_slot_table_size(name, p) \
3048 __param_check(name, p, unsigned int);
3050 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
3051 slot_table_size, 0644);
3052 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries,
3053 max_slot_table_size, 0644);
3054 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
3055 slot_table_size, 0644);